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
#![allow(clippy::large_enum_variant)]
use serde::{de::MapAccess, Deserialize, Serialize, Serializer};
use serde_json::Value;
use crate::types::{
CallbackQuery, Chat, ChatJoinRequest, ChatMemberUpdated, ChosenInlineResult, InlineQuery,
Message, Poll, PollAnswer, PreCheckoutQuery, ShippingQuery, User,
};
/// This [object] represents an incoming update.
///
/// [The official docs](https://core.telegram.org/bots/api#update).
///
/// [object]: https://core.telegram.org/bots/api#available-types
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
pub struct Update {
/// The update‘s unique identifier. Update identifiers start from a certain
/// positive number and increase sequentially. This ID becomes especially
/// handy if you’re using webhooks, since it allows you to ignore
/// repeated updates or to restore the correct update sequence, should
/// they get out of order. If there are no new updates for at least a
/// week, then identifier of the next update will be chosen randomly
/// instead of sequentially.
#[serde(rename = "update_id")]
pub id: i32,
#[serde(flatten)]
pub kind: UpdateKind,
}
impl Update {
// FIXME: add mentioned_users -> impl Iterator<&User>
/// Returns the user that performed the action that caused this update, if
/// known.
///
/// This is generally the `from` field (except for `PollAnswer` where it's
/// `user` and `Poll` with `Error` which don't have such field at all).
#[must_use]
pub fn from(&self) -> Option<&User> {
use UpdateKind::*;
let from = match &self.kind {
Message(m) | EditedMessage(m) | ChannelPost(m) | EditedChannelPost(m) => m.from()?,
CallbackQuery(query) => &query.from,
ChosenInlineResult(chosen) => &chosen.from,
InlineQuery(query) => &query.from,
ShippingQuery(query) => &query.from,
PreCheckoutQuery(query) => &query.from,
PollAnswer(answer) => &answer.user,
MyChatMember(m) | ChatMember(m) => &m.from,
ChatJoinRequest(r) => &r.from,
Poll(_) | Error(_) => return None,
};
Some(from)
}
/// Returns all users that are "contained" in this `Update` structure.
///
/// This might be useful to track information about users.
///
/// Note that this function may return quite a few users as it scans
/// replies, pinned messages, message entities, "via bot" fields and more.
/// Also note that this function can return duplicate users.
pub fn mentioned_users(&self) -> impl Iterator<Item = &User> {
use either::Either::{Left, Right};
use std::iter::{empty, once};
let i0 = Left;
let i1 = |x| Right(Left(x));
let i2 = |x| Right(Right(Left(x)));
let i3 = |x| Right(Right(Right(Left(x))));
let i4 = |x| Right(Right(Right(Right(Left(x)))));
let i5 = |x| Right(Right(Right(Right(Right(Left(x))))));
let i6 = |x| Right(Right(Right(Right(Right(Right(x))))));
match &self.kind {
UpdateKind::Message(message)
| UpdateKind::EditedMessage(message)
| UpdateKind::ChannelPost(message)
| UpdateKind::EditedChannelPost(message) => i0(message.mentioned_users()),
UpdateKind::InlineQuery(query) => i1(once(&query.from)),
UpdateKind::ChosenInlineResult(query) => i1(once(&query.from)),
UpdateKind::CallbackQuery(query) => i2(query.mentioned_users()),
UpdateKind::ShippingQuery(query) => i1(once(&query.from)),
UpdateKind::PreCheckoutQuery(query) => i1(once(&query.from)),
UpdateKind::Poll(poll) => i3(poll.mentioned_users()),
UpdateKind::PollAnswer(answer) => i1(once(&answer.user)),
UpdateKind::MyChatMember(member) | UpdateKind::ChatMember(member) => {
i4(member.mentioned_users())
}
UpdateKind::ChatJoinRequest(request) => i5(request.mentioned_users()),
UpdateKind::Error(_) => i6(empty()),
}
}
/// Returns the chat in which is update has happened, if any.
#[must_use]
pub fn chat(&self) -> Option<&Chat> {
use UpdateKind::*;
let chat = match &self.kind {
Message(m) | EditedMessage(m) | ChannelPost(m) | EditedChannelPost(m) => &m.chat,
CallbackQuery(q) => &q.message.as_ref()?.chat,
ChatMember(m) => &m.chat,
MyChatMember(m) => &m.chat,
ChatJoinRequest(c) => &c.chat,
InlineQuery(_)
| ChosenInlineResult(_)
| ShippingQuery(_)
| PreCheckoutQuery(_)
| Poll(_)
| PollAnswer(_)
| Error(_) => return None,
};
Some(chat)
}
#[deprecated(note = "renamed to `from`", since = "0.10.0")]
pub fn user(&self) -> Option<&User> {
self.from()
}
}
#[derive(Clone, Debug, PartialEq)]
pub enum UpdateKind {
// NB: When adding new variants, don't forget to update
// - `AllowedUpdate`
// - `Update::user`
// - `Update::chat`
// - `DpHandlerDescription::full_set`
// - `dispatching/filter_ext.rs`
/// New incoming message of any kind — text, photo, sticker, etc.
Message(Message),
/// New version of a message that is known to the bot and was edited.
EditedMessage(Message),
/// New incoming channel post of any kind — text, photo, sticker, etc.
ChannelPost(Message),
/// New version of a channel post that is known to the bot and was edited.
EditedChannelPost(Message),
/// New incoming [inline] query.
///
/// [inline]: https://core.telegram.org/bots/api#inline-mode
InlineQuery(InlineQuery),
/// The result of an [inline] query that was chosen by a user and sent to
/// their chat partner. Please see our documentation on the [feedback
/// collecting] for details on how to enable these updates for your bot.
///
/// [inline]: https://core.telegram.org/bots/api#inline-mode
/// [feedback collecting]: https://core.telegram.org/bots/inline#collecting-feedback
ChosenInlineResult(ChosenInlineResult),
/// New incoming callback query.
CallbackQuery(CallbackQuery),
/// New incoming shipping query. Only for invoices with flexible price.
ShippingQuery(ShippingQuery),
/// New incoming pre-checkout query. Contains full information about
/// checkout.
PreCheckoutQuery(PreCheckoutQuery),
/// New poll state. Bots receive only updates about stopped polls and
/// polls, which are sent by the bot.
Poll(Poll),
/// A user changed their answer in a non-anonymous poll. Bots receive new
/// votes only in polls that were sent by the bot itself.
PollAnswer(PollAnswer),
/// The bot's chat member status was updated in a chat. For private chats,
/// this update is received only when the bot is blocked or unblocked by the
/// user.
MyChatMember(ChatMemberUpdated),
/// A chat member's status was updated in a chat. The bot must be an
/// administrator in the chat and must explicitly specify
/// [`AllowedUpdate::ChatMember`] in the list of `allowed_updates` to
/// receive these updates.
///
/// [`AllowedUpdate::ChatMember`]: crate::types::AllowedUpdate::ChatMember
ChatMember(ChatMemberUpdated),
/// A request to join the chat has been sent. The bot must have the
/// can_invite_users administrator right in the chat to receive these
/// updates.
ChatJoinRequest(ChatJoinRequest),
/// An error that happened during deserialization.
///
/// This allows `teloxide` to continue working even if telegram adds a new
/// kinds of updates.
///
/// **Note that deserialize implementation always returns an empty value**,
/// teloxide fills in the data when doing deserialization.
Error(Value),
}
impl<'de> Deserialize<'de> for UpdateKind {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: serde::Deserializer<'de>,
{
struct Visitor;
impl<'de> serde::de::Visitor<'de> for Visitor {
type Value = UpdateKind;
fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
formatter.write_str("a map")
}
fn visit_map<A>(self, mut map: A) -> Result<Self::Value, A::Error>
where
A: MapAccess<'de>,
{
let mut tmp = None;
// Try to deserialize a borrowed-str key, or else try deserializing an owned
// string key
let key = map.next_key::<&str>().or_else(|_| {
map.next_key::<String>().map(|k| {
tmp = k;
tmp.as_deref()
})
});
let this = key
.ok()
.flatten()
.and_then(|key| match key {
"message" => map.next_value::<Message>().ok().map(UpdateKind::Message),
"edited_message" => map
.next_value::<Message>()
.ok()
.map(UpdateKind::EditedMessage),
"channel_post" => map
.next_value::<Message>()
.ok()
.map(UpdateKind::ChannelPost),
"edited_channel_post" => map
.next_value::<Message>()
.ok()
.map(UpdateKind::EditedChannelPost),
"inline_query" => map
.next_value::<InlineQuery>()
.ok()
.map(UpdateKind::InlineQuery),
"chosen_inline_result" => map
.next_value::<ChosenInlineResult>()
.ok()
.map(UpdateKind::ChosenInlineResult),
"callback_query" => map
.next_value::<CallbackQuery>()
.ok()
.map(UpdateKind::CallbackQuery),
"shipping_query" => map
.next_value::<ShippingQuery>()
.ok()
.map(UpdateKind::ShippingQuery),
"pre_checkout_query" => map
.next_value::<PreCheckoutQuery>()
.ok()
.map(UpdateKind::PreCheckoutQuery),
"poll" => map.next_value::<Poll>().ok().map(UpdateKind::Poll),
"poll_answer" => map
.next_value::<PollAnswer>()
.ok()
.map(UpdateKind::PollAnswer),
"my_chat_member" => map
.next_value::<ChatMemberUpdated>()
.ok()
.map(UpdateKind::MyChatMember),
"chat_member" => map
.next_value::<ChatMemberUpdated>()
.ok()
.map(UpdateKind::ChatMember),
"chat_join_request" => map
.next_value::<ChatJoinRequest>()
.ok()
.map(UpdateKind::ChatJoinRequest),
_ => Some(empty_error()),
})
.unwrap_or_else(empty_error);
Ok(this)
}
}
deserializer.deserialize_any(Visitor)
}
}
impl Serialize for UpdateKind {
fn serialize<S>(&self, s: S) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
let name = "UpdateKind";
match self {
UpdateKind::Message(v) => s.serialize_newtype_variant(name, 0, "message", v),
UpdateKind::EditedMessage(v) => {
s.serialize_newtype_variant(name, 1, "edited_message", v)
}
UpdateKind::ChannelPost(v) => s.serialize_newtype_variant(name, 2, "channel_post", v),
UpdateKind::EditedChannelPost(v) => {
s.serialize_newtype_variant(name, 3, "edited_channel_post", v)
}
UpdateKind::InlineQuery(v) => s.serialize_newtype_variant(name, 4, "inline_query", v),
UpdateKind::ChosenInlineResult(v) => {
s.serialize_newtype_variant(name, 5, "chosen_inline_result", v)
}
UpdateKind::CallbackQuery(v) => {
s.serialize_newtype_variant(name, 6, "callback_query", v)
}
UpdateKind::ShippingQuery(v) => {
s.serialize_newtype_variant(name, 7, "shipping_query", v)
}
UpdateKind::PreCheckoutQuery(v) => {
s.serialize_newtype_variant(name, 8, "pre_checkout_query", v)
}
UpdateKind::Poll(v) => s.serialize_newtype_variant(name, 9, "poll", v),
UpdateKind::PollAnswer(v) => s.serialize_newtype_variant(name, 10, "poll_answer", v),
UpdateKind::MyChatMember(v) => {
s.serialize_newtype_variant(name, 11, "my_chat_member", v)
}
UpdateKind::ChatMember(v) => s.serialize_newtype_variant(name, 12, "chat_member", v),
UpdateKind::ChatJoinRequest(v) => {
s.serialize_newtype_variant(name, 13, "chat_join_request", v)
}
UpdateKind::Error(v) => v.serialize(s),
}
}
}
fn empty_error() -> UpdateKind {
UpdateKind::Error(Value::Object(<_>::default()))
}
#[cfg(test)]
mod test {
use crate::types::{
Chat, ChatId, ChatKind, ChatPrivate, MediaKind, MediaText, Message, MessageCommon,
MessageId, MessageKind, Update, UpdateKind, User, UserId,
};
use chrono::{DateTime, NaiveDateTime, Utc};
// TODO: more tests for deserialization
#[test]
fn message() {
let timestamp = 1_569_518_342;
let date = DateTime::from_utc(
NaiveDateTime::from_timestamp_opt(timestamp, 0).unwrap(),
Utc,
);
let json = r#"{
"update_id":892252934,
"message":{
"message_id":6557,
"from":{
"id":218485655,
"is_bot": false,
"first_name":"Waffle",
"username":"WaffleLapkin",
"language_code":"en"
},
"chat":{
"id":218485655,
"first_name":"Waffle",
"username":"WaffleLapkin",
"type":"private"
},
"date":1569518342,
"text":"hello there"
}
}"#;
let expected = Update {
id: 892_252_934,
kind: UpdateKind::Message(Message {
via_bot: None,
id: MessageId(6557),
thread_id: None,
date,
chat: Chat {
id: ChatId(218_485_655),
kind: ChatKind::Private(ChatPrivate {
username: Some(String::from("WaffleLapkin")),
first_name: Some(String::from("Waffle")),
last_name: None,
bio: None,
has_private_forwards: None,
has_restricted_voice_and_video_messages: None,
emoji_status_custom_emoji_id: None,
}),
photo: None,
pinned_message: None,
message_auto_delete_time: None,
has_hidden_members: false,
has_aggressive_anti_spam_enabled: false,
},
kind: MessageKind::Common(MessageCommon {
from: Some(User {
id: UserId(218_485_655),
is_bot: false,
first_name: String::from("Waffle"),
last_name: None,
username: Some(String::from("WaffleLapkin")),
language_code: Some(String::from("en")),
is_premium: false,
added_to_attachment_menu: false,
}),
reply_to_message: None,
forward: None,
edit_date: None,
media_kind: MediaKind::Text(MediaText {
text: String::from("hello there"),
entities: vec![],
}),
reply_markup: None,
sender_chat: None,
author_signature: None,
is_topic_message: false,
is_automatic_forward: false,
has_protected_content: false,
}),
}),
};
let actual = serde_json::from_str::<Update>(json).unwrap();
assert_eq!(expected, actual);
}
#[test]
fn de_private_chat_text_message() {
let text = r#"
{
"message": {
"chat": {
"first_name": "Hirrolot",
"id": 408258968,
"type": "private",
"username": "hirrolot"
},
"date": 1581448857,
"from": {
"first_name": "Hirrolot",
"id": 408258968,
"is_bot": false,
"language_code": "en",
"username": "hirrolot"
},
"message_id": 154,
"text": "4"
},
"update_id": 306197398
}
"#;
let Update { kind, .. } = serde_json::from_str::<Update>(text).unwrap();
match kind {
UpdateKind::Message(_) => {}
_ => panic!("Expected `Message`"),
}
}
#[test]
fn pinned_message_works() {
let json = r#"{
"message": {
"chat": {
"id": -1001276785818,
"title": "teloxide dev",
"type": "supergroup",
"username": "teloxide_dev"
},
"date": 1582134655,
"from": {
"first_name": "Hirrolot",
"id": 408258968,
"is_bot": false,
"username": "hirrolot"
},
"message_id": 20225,
"pinned_message": {
"chat": {
"id": -1001276785818,
"title": "teloxide dev",
"type": "supergroup",
"username": "teloxide_dev"
},
"date": 1582134643,
"from": {
"first_name": "Hirrolot",
"id": 408258968,
"is_bot": false,
"username": "hirrolot"
},
"message_id": 20224,
"text": "Faster than a bullet"
}
},
"update_id": 845402291
}"#;
let Update { kind, .. } = serde_json::from_str(json).unwrap();
match kind {
UpdateKind::Message(_) => {}
_ => panic!("Expected `Message`"),
}
}
#[test]
fn dice_works() {
let json = r#"
{
"message": {
"chat": {
"id": -1001276785818,
"title": "bla bla bla chat",
"type": "supergroup",
"username": "teloxide_dev"
},
"date": 1596014550,
"dice": {
"emoji": "🎲",
"value": 2
},
"from": {
"first_name": "Hirrolot",
"id": 408258968,
"is_bot": false,
"language_code": "en",
"username": "hirrolot"
},
"message_id": 35410
},
"update_id": 573255266
}
"#;
let Update { kind, .. } = serde_json::from_str(json).unwrap();
match kind {
UpdateKind::Message(_) => {}
_ => panic!("Expected `Message`"),
}
}
#[test]
fn new_update_kind_error() {
let json = r#"{
"new_update_kind": {"some_field_idk": 1},
"update_id": 1
}"#;
let Update { kind, .. } = serde_json::from_str(json).unwrap();
match kind {
// Deserialization failed successfully
UpdateKind::Error(_) => {}
_ => panic!("Expected error"),
}
}
#[test]
fn issue_523() {
let json = r#"{
"update_id":0,
"my_chat_member": {
"chat":{"id":0,"first_name":"FN","last_name":"LN","username":"UN","type":"private"},
"from":{"id":0,"is_bot":false,"first_name":"FN","last_name":"LN","username":"UN"},
"date":1644677726,
"old_chat_member":{"user":{"id":1,"is_bot":true,"first_name":"bot","username":"unBot"},"status":"member"},
"new_chat_member":{"user":{"id":1,"is_bot":true,"first_name":"bot","username":"unBot"},"status":"kicked","until_date":0}
}
}"#;
let Update { kind, .. } = serde_json::from_str(json).unwrap();
match kind {
UpdateKind::MyChatMember(_) => {}
_ => panic!("Expected `MyChatMember`"),
}
}
}