blazegram 0.4.2

Telegram bot framework: clean chats, zero garbage, declarative screens, pure Rust MTProto.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
use serde::{Deserialize, Serialize};
use std::hash::{Hash, Hasher};
use std::path::PathBuf;

use super::new_fixed_hasher;

// ─── Content Types ───

/// The kind of content a Telegram message carries.
///
/// The differ uses this to decide whether a transition can be done with
/// `editMessageText` / `editMessageMedia` or requires delete + send.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub enum ContentType {
    /// Plain or HTML/Markdown text message.
    Text,
    /// Photo (compressed image).
    Photo,
    /// Video file.
    Video,
    /// GIF / MPEG-4 animation.
    Animation,
    /// Generic file attachment.
    Document,
    /// Sticker (WebP / TGS / WebM).
    Sticker,
    /// Voice message (OGG Opus).
    Voice,
    /// Round video note.
    VideoNote,
    /// Audio file with ID3 metadata.
    Audio,
    /// GPS location point.
    Location,
    /// Venue with address and optional Foursquare ID.
    Venue,
    /// Shared contact card.
    Contact,
    /// Native Telegram poll.
    Poll,
    /// Animated dice / darts / basketball emoji.
    Dice,
}

impl ContentType {
    /// Can we edit from self → target without delete+send?
    #[must_use]
    pub fn can_edit_to(&self, target: &ContentType) -> bool {
        use ContentType::{Animation, Document, Photo, Text, Video};
        match (self, target) {
            (Text, Text) => true,
            // Media ↔ Media via editMessageMedia
            (Photo | Video | Animation | Document, Photo | Video | Animation | Document) => true,
            _ => false,
        }
    }
}

/// Text formatting mode for message bodies and captions.
///
/// Defaults to [`Html`](Self::Html) which supports `<b>`, `<i>`, `<code>`,
/// `<a href="...">`, etc.  See the
/// [Telegram formatting docs](https://core.telegram.org/bots/api#formatting-options).
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize, Default)]
pub enum ParseMode {
    /// HTML tags (`<b>`, `<i>`, `<code>`, `<a>`, …).
    #[default]
    Html,
    /// MarkdownV2 syntax (`*bold*`, `_italic_`, `` `code` ``, …).
    MarkdownV2,
    /// No parsing — text is sent as-is.
    None,
}

/// Controls whether URL previews (link thumbnails) are shown in text messages.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize, Default)]
pub enum LinkPreview {
    /// Show URL preview / link thumbnail.
    Enabled,
    /// Suppress URL preview (default).
    #[default]
    Disabled,
}

/// Where a file comes from when sending media.
///
/// Telegram accepts four sources.  A bare string is auto-detected via
/// [`From<&str>`]: URLs become [`Url`](Self::Url), paths with `/` or `\`
/// become [`LocalPath`](Self::LocalPath), everything else is treated as a
/// [`FileId`](Self::FileId).
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum FileSource {
    /// Reuse an already-uploaded file by its Telegram `file_id`.
    FileId(String),
    /// Download from an HTTP(S) URL (Telegram fetches it server-side).
    Url(String),
    /// Upload from a local filesystem path.
    LocalPath(PathBuf),
    /// Upload raw bytes with a filename.
    Bytes {
        /// File content.
        data: Vec<u8>,
        /// Filename shown to the user.
        filename: String,
    },
}

impl PartialEq for FileSource {
    fn eq(&self, other: &Self) -> bool {
        match (self, other) {
            (Self::FileId(a), Self::FileId(b)) => a == b,
            (Self::Url(a), Self::Url(b)) => a == b,
            (Self::LocalPath(a), Self::LocalPath(b)) => a == b,
            (
                Self::Bytes {
                    data: d1,
                    filename: f1,
                },
                Self::Bytes {
                    data: d2,
                    filename: f2,
                },
            ) => d1 == d2 && f1 == f2,
            _ => false,
        }
    }
}

impl Eq for FileSource {}

impl Hash for FileSource {
    fn hash<H: Hasher>(&self, state: &mut H) {
        match self {
            Self::FileId(id) => {
                0u8.hash(state);
                id.hash(state);
            }
            Self::Url(url) => {
                1u8.hash(state);
                url.hash(state);
            }
            Self::LocalPath(p) => {
                2u8.hash(state);
                p.hash(state);
            }
            Self::Bytes { data, filename } => {
                3u8.hash(state);
                data.hash(state);
                filename.hash(state);
            }
        }
    }
}

impl From<&str> for FileSource {
    fn from(s: &str) -> Self {
        if s.starts_with("http://") || s.starts_with("https://") {
            Self::Url(s.to_string())
        } else if s.contains('/') || s.contains('\\') {
            Self::LocalPath(PathBuf::from(s))
        } else {
            Self::FileId(s.to_string())
        }
    }
}

impl From<String> for FileSource {
    fn from(s: String) -> Self {
        Self::from(s.as_str())
    }
}

// ─── Message Content ───

/// The full content of a single bot message, ready to be sent or diffed.
///
/// Each variant maps to a specific Telegram `send*` / `edit*` API call.
/// The differ compares [`content_hash`](Self::content_hash) values of old
/// and new content to decide which API calls are actually needed.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum MessageContent {
    /// Plain or formatted text message (no media).
    Text {
        /// Message body (may contain HTML / MarkdownV2 tags).
        text: String,
        /// How Telegram should parse formatting tags in `text`.
        parse_mode: ParseMode,
        /// Optional inline keyboard attached below the message.
        keyboard: Option<crate::keyboard::InlineKeyboard>,
        /// Whether to show a URL preview card.
        link_preview: LinkPreview,
    },
    /// Compressed image with optional caption.
    Photo {
        /// Image source (file ID, URL, local path, or raw bytes).
        source: FileSource,
        /// Optional caption shown below the photo.
        caption: Option<String>,
        /// Formatting mode for the caption.
        parse_mode: ParseMode,
        /// Optional inline keyboard.
        keyboard: Option<crate::keyboard::InlineKeyboard>,
        /// Send the photo under a click-to-reveal spoiler.
        spoiler: bool,
    },
    /// Video file with optional caption.
    Video {
        /// Video source.
        source: FileSource,
        /// Optional caption.
        caption: Option<String>,
        /// Formatting mode for the caption.
        parse_mode: ParseMode,
        /// Optional inline keyboard.
        keyboard: Option<crate::keyboard::InlineKeyboard>,
        /// Send under a spoiler overlay.
        spoiler: bool,
    },
    /// GIF / MPEG-4 animation with optional caption.
    Animation {
        /// Animation source.
        source: FileSource,
        /// Optional caption.
        caption: Option<String>,
        /// Formatting mode for the caption.
        parse_mode: ParseMode,
        /// Optional inline keyboard.
        keyboard: Option<crate::keyboard::InlineKeyboard>,
        /// Send under a spoiler overlay.
        spoiler: bool,
    },
    /// Generic document / file attachment.
    Document {
        /// Document source.
        source: FileSource,
        /// Optional caption.
        caption: Option<String>,
        /// Formatting mode for the caption.
        parse_mode: ParseMode,
        /// Optional inline keyboard.
        keyboard: Option<crate::keyboard::InlineKeyboard>,
        /// Override the filename shown in the Telegram client.
        filename: Option<String>,
    },
    /// Sticker message (WebP / TGS / WebM).
    Sticker {
        /// Sticker source.
        source: FileSource,
    },
    /// GPS location pin.
    Location {
        /// Latitude in degrees.
        latitude: f64,
        /// Longitude in degrees.
        longitude: f64,
        /// Optional inline keyboard.
        keyboard: Option<crate::keyboard::InlineKeyboard>,
    },
}

impl MessageContent {
    /// Returns the [`ContentType`] discriminant for this content.
    pub fn content_type(&self) -> ContentType {
        match self {
            Self::Text { .. } => ContentType::Text,
            Self::Photo { .. } => ContentType::Photo,
            Self::Video { .. } => ContentType::Video,
            Self::Animation { .. } => ContentType::Animation,
            Self::Document { .. } => ContentType::Document,
            Self::Sticker { .. } => ContentType::Sticker,
            Self::Location { .. } => ContentType::Location,
        }
    }

    /// Deterministic hash of the entire content (type + text/caption + media + keyboard + formatting options).
    ///
    /// If two messages have the same `content_hash`, the differ skips the
    /// transition entirely — zero API calls.
    pub fn content_hash(&self) -> u64 {
        let mut hasher = new_fixed_hasher();
        self.content_type().hash(&mut hasher);
        match self {
            Self::Text {
                text,
                parse_mode,
                keyboard,
                link_preview,
            } => {
                text.hash(&mut hasher);
                parse_mode.hash(&mut hasher);
                if let Some(kb) = keyboard {
                    kb.hash(&mut hasher);
                }
                link_preview.hash(&mut hasher);
            }
            Self::Photo {
                source,
                caption,
                keyboard,
                spoiler,
                parse_mode,
            } => {
                source.hash(&mut hasher);
                caption.hash(&mut hasher);
                if let Some(kb) = keyboard {
                    kb.hash(&mut hasher);
                }
                spoiler.hash(&mut hasher);
                parse_mode.hash(&mut hasher);
            }
            Self::Video {
                source,
                caption,
                keyboard,
                spoiler,
                parse_mode,
            } => {
                source.hash(&mut hasher);
                caption.hash(&mut hasher);
                if let Some(kb) = keyboard {
                    kb.hash(&mut hasher);
                }
                spoiler.hash(&mut hasher);
                parse_mode.hash(&mut hasher);
            }
            Self::Animation {
                source,
                caption,
                keyboard,
                spoiler,
                parse_mode,
            } => {
                source.hash(&mut hasher);
                caption.hash(&mut hasher);
                if let Some(kb) = keyboard {
                    kb.hash(&mut hasher);
                }
                spoiler.hash(&mut hasher);
                parse_mode.hash(&mut hasher);
            }
            Self::Document {
                source,
                caption,
                keyboard,
                filename,
                parse_mode,
            } => {
                source.hash(&mut hasher);
                caption.hash(&mut hasher);
                if let Some(kb) = keyboard {
                    kb.hash(&mut hasher);
                }
                filename.hash(&mut hasher);
                parse_mode.hash(&mut hasher);
            }
            Self::Sticker { source } => {
                source.hash(&mut hasher);
            }
            Self::Location {
                latitude,
                longitude,
                keyboard,
            } => {
                latitude.to_bits().hash(&mut hasher);
                longitude.to_bits().hash(&mut hasher);
                if let Some(kb) = keyboard {
                    kb.hash(&mut hasher);
                }
            }
        }
        hasher.finish()
    }

    /// Hash of the text body and parse mode (for [`Text`](Self::Text) variants).
    ///
    /// Non-text variants all hash to the same constant, so comparing
    /// `text_hash` alone is only meaningful for text messages.
    pub fn text_hash(&self) -> u64 {
        let mut hasher = new_fixed_hasher();
        match self {
            Self::Text {
                text, parse_mode, ..
            } => {
                1u8.hash(&mut hasher); // discriminant: has text
                text.hash(&mut hasher);
                parse_mode.hash(&mut hasher);
            }
            _ => {
                0u8.hash(&mut hasher); // discriminant: no text
            }
        }
        hasher.finish()
    }

    /// Returns the caption for media variants, or `None` for text/sticker/location.
    pub fn caption(&self) -> Option<String> {
        match self {
            Self::Photo { caption, .. }
            | Self::Video { caption, .. }
            | Self::Animation { caption, .. }
            | Self::Document { caption, .. } => caption.clone(),
            _ => None,
        }
    }

    /// Returns the inline keyboard, if any.
    pub fn keyboard(&self) -> Option<crate::keyboard::InlineKeyboard> {
        match self {
            Self::Text { keyboard, .. }
            | Self::Photo { keyboard, .. }
            | Self::Video { keyboard, .. }
            | Self::Animation { keyboard, .. }
            | Self::Document { keyboard, .. }
            | Self::Location { keyboard, .. } => keyboard.clone(),
            _ => None,
        }
    }

    /// Deterministic hash of the inline keyboard alone.
    pub fn keyboard_hash(&self) -> u64 {
        let mut hasher = new_fixed_hasher();
        match self.keyboard() {
            Some(kb) => {
                1u8.hash(&mut hasher);
                kb.hash(&mut hasher);
            }
            None => {
                0u8.hash(&mut hasher);
            }
        }
        hasher.finish()
    }

    /// Return a copy with HTML tags stripped and ParseMode::None.
    /// Used as fallback when Telegram rejects entity boundaries.
    pub fn as_plain_text(&self) -> Self {
        fn strip(html: &str) -> String {
            let mut out = String::with_capacity(html.len());
            let mut inside_tag = false;
            for ch in html.chars() {
                match ch {
                    '<' => inside_tag = true,
                    '>' if inside_tag => inside_tag = false,
                    _ if !inside_tag => out.push(ch),
                    _ => {}
                }
            }
            // Unescape HTML entities
            out.replace("&lt;", "<")
                .replace("&gt;", ">")
                .replace("&amp;", "&")
                .replace("&quot;", "\"")
        }
        match self.clone() {
            Self::Text {
                text,
                keyboard,
                link_preview,
                ..
            } => Self::Text {
                text: strip(&text),
                parse_mode: ParseMode::None,
                keyboard,
                link_preview,
            },
            Self::Photo {
                source,
                caption,
                keyboard,
                spoiler,
                ..
            } => Self::Photo {
                source,
                caption: caption.map(|c| strip(&c)),
                parse_mode: ParseMode::None,
                keyboard,
                spoiler,
            },
            Self::Video {
                source,
                caption,
                keyboard,
                spoiler,
                ..
            } => Self::Video {
                source,
                caption: caption.map(|c| strip(&c)),
                parse_mode: ParseMode::None,
                keyboard,
                spoiler,
            },
            Self::Animation {
                source,
                caption,
                keyboard,
                spoiler,
                ..
            } => Self::Animation {
                source,
                caption: caption.map(|c| strip(&c)),
                parse_mode: ParseMode::None,
                keyboard,
                spoiler,
            },
            Self::Document {
                source,
                caption,
                keyboard,
                filename,
                ..
            } => Self::Document {
                source,
                caption: caption.map(|c| strip(&c)),
                parse_mode: ParseMode::None,
                keyboard,
                filename,
            },
            other => other, // Sticker, Location — no text
        }
    }

    /// Deterministic hash of the caption string alone.
    pub fn caption_hash(&self) -> u64 {
        let mut hasher = new_fixed_hasher();
        match self.caption() {
            Some(cap) => {
                1u8.hash(&mut hasher);
                cap.hash(&mut hasher);
            }
            None => {
                0u8.hash(&mut hasher);
            }
        }
        hasher.finish()
    }

    /// Deterministic hash of the file source alone.
    pub fn file_hash(&self) -> u64 {
        let mut hasher = new_fixed_hasher();
        match self {
            Self::Photo { source, .. }
            | Self::Video { source, .. }
            | Self::Animation { source, .. }
            | Self::Document { source, .. }
            | Self::Sticker { source } => {
                1u8.hash(&mut hasher);
                source.hash(&mut hasher);
            }
            _ => {
                0u8.hash(&mut hasher);
            }
        }
        hasher.finish()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn content_hash_differs_on_parse_mode_photo() {
        let a = MessageContent::Photo {
            source: FileSource::FileId("abc".into()),
            caption: Some("cap".into()),
            parse_mode: ParseMode::Html,
            keyboard: None,
            spoiler: false,
        };
        let b = MessageContent::Photo {
            source: FileSource::FileId("abc".into()),
            caption: Some("cap".into()),
            parse_mode: ParseMode::MarkdownV2,
            keyboard: None,
            spoiler: false,
        };
        assert_ne!(
            a.content_hash(),
            b.content_hash(),
            "different parse_mode must produce different hash"
        );
    }

    #[test]
    fn content_hash_differs_on_parse_mode_video() {
        let a = MessageContent::Video {
            source: FileSource::FileId("v".into()),
            caption: None,
            parse_mode: ParseMode::Html,
            keyboard: None,
            spoiler: false,
        };
        let b = MessageContent::Video {
            source: FileSource::FileId("v".into()),
            caption: None,
            parse_mode: ParseMode::None,
            keyboard: None,
            spoiler: false,
        };
        assert_ne!(a.content_hash(), b.content_hash());
    }

    #[test]
    fn content_hash_differs_on_parse_mode_animation() {
        let a = MessageContent::Animation {
            source: FileSource::FileId("g".into()),
            caption: None,
            parse_mode: ParseMode::Html,
            keyboard: None,
            spoiler: false,
        };
        let b = MessageContent::Animation {
            source: FileSource::FileId("g".into()),
            caption: None,
            parse_mode: ParseMode::MarkdownV2,
            keyboard: None,
            spoiler: false,
        };
        assert_ne!(a.content_hash(), b.content_hash());
    }

    #[test]
    fn content_hash_differs_on_parse_mode_document() {
        let a = MessageContent::Document {
            source: FileSource::FileId("d".into()),
            caption: None,
            parse_mode: ParseMode::Html,
            keyboard: None,
            filename: None,
        };
        let b = MessageContent::Document {
            source: FileSource::FileId("d".into()),
            caption: None,
            parse_mode: ParseMode::None,
            keyboard: None,
            filename: None,
        };
        assert_ne!(a.content_hash(), b.content_hash());
    }
}