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
// Copyright 2020 - developers of the `grammers` project.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// https://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
#[cfg(any(feature = "markdown", feature = "html"))]
use crate::parsers;
use crate::types::{Downloadable, InputMessage, Media, Photo};
use crate::utils;
use crate::ChatMap;
use crate::{types, Client};
use grammers_mtsender::InvocationError;
use grammers_session::PackedChat;
use grammers_tl_types as tl;
use std::fmt;
use std::io;
use std::path::Path;
use std::sync::Arc;
use types::Chat;
/// Represents a Telegram message, which includes text messages, messages with media, and service
/// messages.
///
/// This message should be treated as a snapshot in time, that is, if the message is edited while
/// using this object, those changes won't alter this structure.
#[derive(Clone)]
pub struct Message {
// Message services are a trimmed-down version of normal messages, but with `action`.
//
// Using `enum` just for that would clutter all methods with `match`, so instead service
// messages are interpreted as messages and their action stored separatedly.
pub(crate) msg: tl::types::Message,
pub(crate) action: Option<tl::enums::MessageAction>,
pub(crate) client: Client,
// When fetching messages or receiving updates, a set of chats will be present. A single
// server response contains a lot of chats, and some might be related to deep layers of
// a message action for instance. Keeping the entire set like this allows for cheaper clones
// and moves, and saves us from worrying about picking out all the chats we care about.
pub(crate) chats: Arc<types::ChatMap>,
}
impl Message {
pub(crate) fn new(
client: &Client,
message: tl::enums::Message,
chats: &Arc<types::ChatMap>,
) -> Option<Self> {
match message {
// Don't even bother to expose empty messages to the user, even if they have an ID.
tl::enums::Message::Empty(_) => None,
tl::enums::Message::Message(msg) => Some(Message {
msg,
action: None,
client: client.clone(),
chats: Arc::clone(chats),
}),
tl::enums::Message::Service(msg) => Some(Message {
msg: tl::types::Message {
out: msg.out,
mentioned: msg.mentioned,
media_unread: msg.media_unread,
silent: msg.silent,
post: msg.post,
from_scheduled: false,
legacy: msg.legacy,
edit_hide: false,
pinned: false,
noforwards: false,
invert_media: false,
id: msg.id,
from_id: msg.from_id,
peer_id: msg.peer_id,
fwd_from: None,
via_bot_id: None,
reply_to: msg.reply_to,
date: msg.date,
message: String::new(),
media: None,
reply_markup: None,
entities: None,
views: None,
forwards: None,
replies: None,
edit_date: None,
post_author: None,
grouped_id: None,
restriction_reason: None,
ttl_period: msg.ttl_period,
reactions: None,
},
action: Some(msg.action),
client: client.clone(),
chats: Arc::clone(chats),
}),
}
}
pub(crate) fn from_short_updates(
client: &Client,
updates: tl::types::UpdateShortSentMessage,
input: InputMessage,
chat: PackedChat,
) -> Self {
Self {
msg: tl::types::Message {
out: updates.out,
mentioned: false,
media_unread: false,
silent: input.silent,
post: false, // TODO true if sent to broadcast channel
from_scheduled: false,
legacy: false,
edit_hide: false,
pinned: false,
noforwards: false, // TODO true if channel has noforwads?
invert_media: false,
id: updates.id,
from_id: None, // TODO self
peer_id: chat.to_peer(),
fwd_from: None,
via_bot_id: None,
reply_to: input.reply_to.map(|reply_to_msg_id| {
tl::types::MessageReplyHeader {
reply_to_scheduled: false,
forum_topic: false,
quote: false,
reply_to_msg_id: Some(reply_to_msg_id),
reply_to_peer_id: None,
reply_from: None,
reply_media: None,
reply_to_top_id: None,
quote_text: None,
quote_entities: None,
}
.into()
}),
date: updates.date,
message: input.text,
media: updates.media,
reply_markup: input.reply_markup,
entities: updates.entities,
views: None,
forwards: None,
replies: None,
edit_date: None,
post_author: None,
grouped_id: None,
restriction_reason: None,
ttl_period: updates.ttl_period,
reactions: None,
},
action: None,
client: client.clone(),
chats: ChatMap::single(Chat::unpack(chat)),
}
}
/// Whether the message is outgoing (i.e. you sent this message to some other chat) or
/// incoming (i.e. someone else sent it to you or the chat).
pub fn outgoing(&self) -> bool {
self.msg.out
}
/// Whether you were mentioned in this message or not.
///
/// This includes @username mentions, text mentions, and messages replying to one of your
/// previous messages (even if it contains no mention in the message text).
pub fn mentioned(&self) -> bool {
self.msg.mentioned
}
/// Whether you have read the media in this message or not.
///
/// Most commonly, these are voice notes that you have not played yet.
pub fn media_unread(&self) -> bool {
self.msg.media_unread
}
/// Whether the message should notify people with sound or not.
pub fn silent(&self) -> bool {
self.msg.silent
}
/// Whether this message is a post in a broadcast channel or not.
pub fn post(&self) -> bool {
self.msg.post
}
/// Whether this message was originated from a previously-scheduled message or not.
pub fn from_scheduled(&self) -> bool {
self.msg.from_scheduled
}
// `legacy` is not exposed, though it can be if it proves to be useful
/// Whether the edited mark of this message is edited should be hidden (e.g. in GUI clients)
/// or shown.
pub fn edit_hide(&self) -> bool {
self.msg.edit_hide
}
/// Whether this message is currently pinned or not.
pub fn pinned(&self) -> bool {
self.msg.pinned
}
/// The ID of this message.
///
/// Message identifiers are counters that start at 1 and grow by 1 for each message produced.
///
/// Every channel has its own unique message counter. This counter is the same for all users,
/// but unique to each channel.
///
/// Every account has another unique message counter which is used for private conversations
/// and small group chats. This means different accounts will likely have different message
/// identifiers for the same message in a private conversation or small group chat. This also
/// implies that the message identifier alone is enough to uniquely identify the message,
/// without the need to know the chat ID.
///
/// **You cannot use the message ID of User A when running as User B**, unless this message
/// belongs to a megagroup or broadcast channel. Beware of this when using methods like
/// [`Client::delete_messages`], which **cannot** validate the chat where the message
/// should be deleted for those cases.
pub fn id(&self) -> i32 {
self.msg.id
}
/// The sender of this message, if any.
pub fn sender(&self) -> Option<types::Chat> {
self.msg
.from_id
.as_ref()
.or({
// Incoming messages in private conversations don't include `from_id` since
// layer 119, but the sender can only be the chat we're in.
if !self.msg.out && matches!(self.msg.peer_id, tl::enums::Peer::User(_)) {
Some(&self.msg.peer_id)
} else {
None
}
})
.map(|from| utils::always_find_entity(from, &self.chats, &self.client))
}
/// The chat where this message was sent to.
///
/// This might be the user you're talking to for private conversations, or the group or
/// channel where the message was sent.
pub fn chat(&self) -> types::Chat {
utils::always_find_entity(&self.msg.peer_id, &self.chats, &self.client)
}
/// If this message was forwarded from a previous message, return the header with information
/// about that forward.
pub fn forward_header(&self) -> Option<tl::enums::MessageFwdHeader> {
self.msg.fwd_from.clone()
}
/// If this message was sent @via some inline bot, return the bot's user identifier.
pub fn via_bot_id(&self) -> Option<i64> {
self.msg.via_bot_id
}
/// If this message is replying to a previous message, return the header with information
/// about that reply.
pub fn reply_header(&self) -> Option<tl::enums::MessageReplyHeader> {
self.msg.reply_to.clone()
}
/// The date when this message was produced.
pub fn date(&self) -> utils::Date {
utils::date(self.msg.date)
}
/// The message's text.
///
/// For service messages, this will be the empty strings.
///
/// If the message has media, this text is the caption commonly displayed underneath it.
pub fn text(&self) -> &str {
&self.msg.message
}
/// Like [`text`](Self::text), but with the [`fmt_entities`](Self::fmt_entities)
/// applied to produce a markdown string instead.
///
/// Some formatting entities automatically added by Telegram, such as bot commands or
/// clickable emails, are ignored in the generated string, as those do not need to be
/// sent for Telegram to include them in the message.
///
/// Formatting entities which cannot be represented in CommonMark without resorting to HTML,
/// such as underline, are also ignored.
#[cfg(feature = "markdown")]
pub fn markdown_text(&self) -> String {
if let Some(entities) = self.msg.entities.as_ref() {
parsers::generate_markdown_message(&self.msg.message, entities)
} else {
self.msg.message.clone()
}
}
/// Like [`text`](Self::text), but with the [`fmt_entities`](Self::fmt_entities)
/// applied to produce a HTML string instead.
///
/// Some formatting entities automatically added by Telegram, such as bot commands or
/// clickable emails, are ignored in the generated string, as those do not need to be
/// sent for Telegram to include them in the message.
#[cfg(feature = "html")]
pub fn html_text(&self) -> String {
if let Some(entities) = self.msg.entities.as_ref() {
parsers::generate_html_message(&self.msg.message, entities)
} else {
self.msg.message.clone()
}
}
/// The media displayed by this message, if any.
///
/// This not only includes photos or videos, but also contacts, polls, documents, locations
/// and many other types.
pub fn media(&self) -> Option<types::Media> {
self.msg
.media
.clone()
.and_then(|x| Media::from_raw(x, self.client.clone()))
}
/// If the message has a reply markup (which can happen for messages produced by bots),
/// returns said markup.
pub fn reply_markup(&self) -> Option<tl::enums::ReplyMarkup> {
self.msg.reply_markup.clone()
}
/// The formatting entities used to format this message, such as bold, italic, with their
/// offsets and lengths.
pub fn fmt_entities(&self) -> Option<&Vec<tl::enums::MessageEntity>> {
// TODO correct the offsets and lengths to match the byte offsets
self.msg.entities.as_ref()
}
/// How many views does this message have, when applicable.
///
/// The same user account can contribute to increment this counter indefinitedly, however
/// there is a server-side cooldown limitting how fast it can happen (several hours).
pub fn view_count(&self) -> Option<i32> {
self.msg.views
}
/// How many times has this message been forwarded, when applicable.
pub fn forward_count(&self) -> Option<i32> {
self.msg.forwards
}
/// How many replies does this message have, when applicable.
pub fn reply_count(&self) -> Option<i32> {
match &self.msg.replies {
None => None,
Some(replies) => {
let tl::enums::MessageReplies::Replies(replies) = replies;
Some(replies.replies)
}
}
}
/// How many reactions does this message have, when applicable.
pub fn reaction_count(&self) -> Option<i32> {
match &self.msg.reactions {
None => None,
Some(reactions) => {
let tl::enums::MessageReactions::Reactions(reactions) = reactions;
let count = reactions
.results
.iter()
.map(|reaction: &tl::enums::ReactionCount| {
let tl::enums::ReactionCount::Count(reaction) = reaction;
reaction.count
})
.sum();
Some(count)
}
}
}
/// The date when this message was last edited.
pub fn edit_date(&self) -> Option<utils::Date> {
self.msg.edit_date.map(utils::date)
}
/// If this message was sent to a channel, return the name used by the author to post it.
pub fn post_author(&self) -> Option<&str> {
self.msg.post_author.as_ref().map(|author| author.as_ref())
}
/// If this message belongs to a group of messages, return the unique identifier for that
/// group.
///
/// This applies to albums of media, such as multiple photos grouped together.
///
/// Note that there may be messages sent in between the messages forming a group.
pub fn grouped_id(&self) -> Option<i64> {
self.msg.grouped_id
}
/// A list of reasons on why this message is restricted.
///
/// The message is not restricted if the return value is `None`.
pub fn restriction_reason(&self) -> Option<&Vec<tl::enums::RestrictionReason>> {
self.msg.restriction_reason.as_ref()
}
/// If this message is a service message, return the service action that occured.
pub fn action(&self) -> Option<&tl::enums::MessageAction> {
self.action.as_ref()
}
/// If this message is replying to another message, return the replied message ID.
pub fn reply_to_message_id(&self) -> Option<i32> {
if let Some(tl::enums::MessageReplyHeader::Header(m)) = &self.msg.reply_to {
m.reply_to_msg_id
} else {
None
}
}
/// Fetch the message that this message is replying to, or `None` if this message is not a
/// reply to a previous message.
///
/// Shorthand for `Client::get_reply_to_message`.
pub async fn get_reply(&self) -> Result<Option<Self>, InvocationError> {
self.client
.clone() // TODO don't clone
.get_reply_to_message(self)
.await
}
/// Respond to this message by sending a new message in the same chat, but without directly
/// replying to it.
///
/// Shorthand for `Client::send_message`.
pub async fn respond<M: Into<InputMessage>>(
&self,
message: M,
) -> Result<Self, InvocationError> {
self.client.send_message(&self.chat(), message).await
}
/// Directly reply to this message by sending a new message in the same chat that replies to
/// it. This methods overrides the `reply_to` on the `InputMessage` to point to `self`.
///
/// Shorthand for `Client::send_message`.
pub async fn reply<M: Into<InputMessage>>(&self, message: M) -> Result<Self, InvocationError> {
let message = message.into();
self.client
.send_message(&self.chat(), message.reply_to(Some(self.msg.id)))
.await
}
/// Forward this message to another (or the same) chat.
///
/// Shorthand for `Client::forward_messages`. If you need to forward multiple messages
/// at once, consider using that method instead.
pub async fn forward_to<C: Into<PackedChat>>(&self, chat: C) -> Result<Self, InvocationError> {
// TODO return `Message`
// When forwarding a single message, if it fails, Telegram should respond with RPC error.
// If it succeeds we will have the single forwarded message present which we can unwrap.
self.client
.forward_messages(chat, &[self.msg.id], &self.chat())
.await
.map(|mut msgs| msgs.pop().unwrap().unwrap())
}
/// Edit this message to change its text or media.
///
/// Shorthand for `Client::edit_message`.
pub async fn edit<M: Into<InputMessage>>(&self, new_message: M) -> Result<(), InvocationError> {
self.client
.edit_message(&self.chat(), self.msg.id, new_message)
.await
}
/// Delete this message for everyone.
///
/// Shorthand for `Client::delete_messages`. If you need to delete multiple messages
/// at once, consider using that method instead.
pub async fn delete(&self) -> Result<(), InvocationError> {
self.client
.delete_messages(&self.chat(), &[self.msg.id])
.await
.map(drop)
}
/// Mark this message and all messages above it as read.
///
/// Unlike `Client::mark_as_read`, this method only will mark the chat as read up to
/// this message, not the entire chat.
pub async fn mark_as_read(&self) -> Result<(), InvocationError> {
let chat = self.chat().pack();
if let Some(channel) = chat.try_to_input_channel() {
self.client
.invoke(&tl::functions::channels::ReadHistory {
channel,
max_id: self.msg.id,
})
.await
.map(drop)
} else {
self.client
.invoke(&tl::functions::messages::ReadHistory {
peer: chat.to_input_peer(),
max_id: self.msg.id,
})
.await
.map(drop)
}
}
/// Pin this message in the chat.
///
/// Shorthand for `Client::pin_message`.
pub async fn pin(&self) -> Result<(), InvocationError> {
self.client.pin_message(&self.chat(), self.msg.id).await
}
/// Unpin this message from the chat.
///
/// Shorthand for `Client::unpin_message`.
pub async fn unpin(&self) -> Result<(), InvocationError> {
self.client.unpin_message(&self.chat(), self.msg.id).await
}
/// Refetch this message, mutating all of its properties in-place.
///
/// No changes will be made to the message if it fails to be fetched.
///
/// Shorthand for `Client::get_messages_by_id`.
pub async fn refetch(&self) -> Result<(), InvocationError> {
// When fetching a single message, if it fails, Telegram should respond with RPC error.
// If it succeeds we will have the single message present which we can unwrap.
self.client
.get_messages_by_id(&self.chat(), &[self.msg.id])
.await?
.pop()
.unwrap()
.unwrap();
todo!("actually mutate self after get_messages_by_id returns `Message`")
}
/// Download the message media in this message if applicable.
///
/// Returns `true` if there was media to download, or `false` otherwise.
///
/// Shorthand for `Client::download_media`.
pub async fn download_media<P: AsRef<Path>>(&self, path: P) -> Result<bool, io::Error> {
// TODO probably encode failed download in error
if let Some(media) = self.media() {
self.client
.download_media(&Downloadable::Media(media), path)
.await
.map(|_| true)
} else {
Ok(false)
}
}
/// Get photo attached to the message if any.
pub fn photo(&self) -> Option<Photo> {
if let Media::Photo(photo) = self.media()? {
return Some(photo);
}
None
}
}
impl fmt::Debug for Message {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("Message")
.field("id", &self.id())
.field("outgoing", &self.outgoing())
.field("date", &self.date())
.field("text", &self.text())
.field("chat", &self.chat())
.field("sender", &self.sender())
.field("reply_to_message_id", &self.reply_to_message_id())
.field("via_bot_id", &self.via_bot_id())
.field("media", &self.media())
.field("mentioned", &self.mentioned())
.field("media_unread", &self.media_unread())
.field("silent", &self.silent())
.field("post", &self.post())
.field("from_scheduled", &self.from_scheduled())
.field("edit_hide", &self.edit_hide())
.field("pinned", &self.pinned())
.field("forward_header", &self.forward_header())
.field("reply_header", &self.reply_header())
.field("reply_markup", &self.reply_markup())
.field("fmt_entities", &self.fmt_entities())
.field("view_count", &self.view_count())
.field("forward_count", &self.forward_count())
.field("reply_count", &self.reply_count())
.field("edit_date", &self.edit_date())
.field("post_author", &self.post_author())
.field("grouped_id", &self.grouped_id())
.field("restriction_reason", &self.restriction_reason())
.field("action", &self.action())
.finish()
}
}