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 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
// 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.
//! Methods related to sending messages.
use crate::types::{IterBuffer, Message};
use crate::utils::{generate_random_id, generate_random_ids};
use crate::{types, ChatMap, Client};
use chrono::{DateTime, FixedOffset};
pub use grammers_mtsender::{AuthorizationError, InvocationError};
use grammers_session::PackedChat;
use grammers_tl_types as tl;
use grammers_tl_types::enums::InputPeer;
use std::collections::HashMap;
fn get_message_id(message: &tl::enums::Message) -> i32 {
match message {
tl::enums::Message::Empty(m) => m.id,
tl::enums::Message::Message(m) => m.id,
tl::enums::Message::Service(m) => m.id,
}
}
fn map_random_ids_to_messages(
client: &Client,
random_ids: &[i64],
updates: tl::enums::Updates,
) -> Vec<Option<Message>> {
match updates {
tl::enums::Updates::Updates(tl::types::Updates {
updates,
users,
chats,
date: _,
seq: _,
}) => {
let chats = ChatMap::new(users, chats);
let rnd_to_id = updates
.iter()
.filter_map(|update| match update {
tl::enums::Update::MessageId(u) => Some((u.random_id, u.id)),
_ => None,
})
.collect::<HashMap<_, _>>();
// TODO ideally this would use the same UpdateIter mechanism to make sure we don't
// accidentally miss variants
let mut id_to_msg = updates
.into_iter()
.filter_map(|update| match update {
tl::enums::Update::NewMessage(tl::types::UpdateNewMessage {
message, ..
}) => Some(message),
tl::enums::Update::NewChannelMessage(tl::types::UpdateNewChannelMessage {
message,
..
}) => Some(message),
tl::enums::Update::NewScheduledMessage(
tl::types::UpdateNewScheduledMessage { message, .. },
) => Some(message),
_ => None,
})
.filter_map(|message| Message::new(client, message, &chats))
.map(|message| (message.msg.id, message))
.collect::<HashMap<_, _>>();
random_ids
.iter()
.map(|rnd| rnd_to_id.get(rnd).and_then(|id| id_to_msg.remove(id)))
.collect()
}
_ => panic!("API returned something other than Updates so messages can't be mapped"),
}
}
pub(crate) fn parse_mention_entities(
client: &Client,
mut entities: Vec<tl::enums::MessageEntity>,
) -> Option<Vec<tl::enums::MessageEntity>> {
if entities.is_empty() {
return None;
}
if entities
.iter()
.any(|e| matches!(e, tl::enums::MessageEntity::MentionName(_)))
{
let state = client.0.state.read().unwrap();
for entity in entities.iter_mut() {
if let tl::enums::MessageEntity::MentionName(mention_name) = entity {
if let Some(packed_user) = state.chat_hashes.get(mention_name.user_id) {
*entity = tl::types::InputMessageEntityMentionName {
offset: mention_name.offset,
length: mention_name.length,
user_id: packed_user.to_input_user_lossy(),
}
.into()
}
}
}
}
Some(entities)
}
const MAX_LIMIT: usize = 100;
impl<R: tl::RemoteCall<Return = tl::enums::messages::Messages>> IterBuffer<R, Message> {
/// Fetches the total unless cached.
///
/// The `request.limit` should be set to the right value before calling this method.
async fn get_total(&mut self) -> Result<usize, InvocationError> {
if let Some(total) = self.total {
return Ok(total);
}
use tl::enums::messages::Messages;
let total = match self.client.invoke(&self.request).await? {
Messages::Messages(messages) => messages.messages.len(),
Messages::Slice(messages) => messages.count as usize,
Messages::ChannelMessages(messages) => messages.count as usize,
Messages::NotModified(messages) => messages.count as usize,
};
self.total = Some(total);
Ok(total)
}
/// Performs the network call, fills the buffer, and returns the `offset_rate` if any.
///
/// The `request.limit` should be set to the right value before calling this method.
async fn fill_buffer(&mut self, limit: i32) -> Result<Option<i32>, InvocationError> {
use tl::enums::messages::Messages;
let (messages, users, chats, rate) = match self.client.invoke(&self.request).await? {
Messages::Messages(m) => {
self.last_chunk = true;
self.total = Some(m.messages.len());
(m.messages, m.users, m.chats, None)
}
Messages::Slice(m) => {
// Can't rely on `count(messages) < limit` as the stop condition.
// See https://github.com/LonamiWebs/Telethon/issues/3949 for more.
//
// If the highest fetched message ID is lower than or equal to the limit,
// there can't be more messages after (highest ID - limit), because the
// absolute lowest message ID is 1.
self.last_chunk = m.messages.is_empty() || get_message_id(&m.messages[0]) <= limit;
self.total = Some(m.count as usize);
(m.messages, m.users, m.chats, m.next_rate)
}
Messages::ChannelMessages(m) => {
self.last_chunk = m.messages.is_empty() || get_message_id(&m.messages[0]) <= limit;
self.total = Some(m.count as usize);
(m.messages, m.users, m.chats, None)
}
Messages::NotModified(_) => {
panic!("API returned Messages::NotModified even though hash = 0")
}
};
{
let mut state = self.client.0.state.write().unwrap();
// Telegram can return peers without hash (e.g. Users with 'min: true')
let _ = state.chat_hashes.extend(&users, &chats);
}
let chats = ChatMap::new(users, chats);
let client = self.client.clone();
self.buffer.extend(
messages
.into_iter()
.flat_map(|message| Message::new(&client, message, &chats)),
);
Ok(rate)
}
}
pub type MessageIter = IterBuffer<tl::functions::messages::GetHistory, Message>;
impl MessageIter {
fn new(client: &Client, peer: PackedChat) -> Self {
Self::from_request(
client,
MAX_LIMIT,
tl::functions::messages::GetHistory {
peer: peer.to_input_peer(),
offset_id: 0,
offset_date: 0,
add_offset: 0,
limit: 0,
max_id: 0,
min_id: 0,
hash: 0,
},
)
}
pub fn offset_id(mut self, offset: i32) -> Self {
self.request.offset_id = offset;
self
}
pub fn max_date(mut self, offset: i32) -> Self {
self.request.offset_date = offset;
self
}
/// Determines how many messages there are in total.
///
/// This only performs a network call if `next` has not been called before.
pub async fn total(&mut self) -> Result<usize, InvocationError> {
self.request.limit = 1;
self.get_total().await
}
/// Return the next `Message` from the internal buffer, filling the buffer previously if it's
/// empty.
///
/// Returns `None` if the `limit` is reached or there are no messages left.
pub async fn next(&mut self) -> Result<Option<Message>, InvocationError> {
if let Some(result) = self.next_raw() {
return result;
}
self.request.limit = self.determine_limit(MAX_LIMIT);
self.fill_buffer(self.request.limit).await?;
// Don't bother updating offsets if this is the last time stuff has to be fetched.
if !self.last_chunk && !self.buffer.is_empty() {
let last = &self.buffer[self.buffer.len() - 1];
self.request.offset_id = last.msg.id;
self.request.offset_date = last.msg.date;
}
Ok(self.pop_item())
}
}
pub type SearchIter = IterBuffer<tl::functions::messages::Search, Message>;
impl SearchIter {
fn new(client: &Client, peer: PackedChat) -> Self {
// TODO let users tweak all the options from the request
Self::from_request(
client,
MAX_LIMIT,
tl::functions::messages::Search {
peer: peer.to_input_peer(),
q: String::new(),
from_id: None,
saved_peer_id: None,
saved_reaction: None,
top_msg_id: None,
filter: tl::enums::MessagesFilter::InputMessagesFilterEmpty,
min_date: 0,
max_date: 0,
offset_id: 0,
add_offset: 0,
limit: 0,
max_id: 0,
min_id: 0,
hash: 0,
},
)
}
pub fn offset_id(mut self, offset: i32) -> Self {
self.request.offset_id = offset;
self
}
/// Changes the query of the search. Telegram servers perform a somewhat fuzzy search over
/// this query (so a word in singular may also return messages with the word in plural, for
/// example).
pub fn query(mut self, query: &str) -> Self {
self.request.q = query.to_string();
self
}
/// Restricts results to messages sent by the logged-in user
pub fn sent_by_self(mut self) -> Self {
self.request.from_id = Some(InputPeer::PeerSelf);
self
}
/// Returns only messages with date bigger than date_time.
///
/// ```
/// use chrono::DateTime;
///
/// # async fn f(chat: grammers_client::types::Chat, client: grammers_client::Client) -> Result<(), Box<dyn std::error::Error>> {
/// // Search messages sent after Jan 1st, 2021
/// let min_date = DateTime::parse_from_rfc3339("2021-01-01T00:00:00-00:00").unwrap();
///
/// let mut messages = client.search_messages(&chat).min_date(&min_date);
///
/// # Ok(())
/// # }
/// ```
pub fn min_date(mut self, date_time: &DateTime<FixedOffset>) -> Self {
self.request.min_date = date_time.timestamp() as i32;
self
}
/// Returns only messages with date smaller than date_time
///
/// ```
/// use chrono::DateTime;
///
/// # async fn f(chat: grammers_client::types::Chat, client: grammers_client::Client) -> Result<(), Box<dyn std::error::Error>> {
/// // Search messages sent before Dec, 25th 2022
/// let max_date = DateTime::parse_from_rfc3339("2022-12-25T00:00:00-00:00").unwrap();
///
/// let mut messages = client.search_messages(&chat).max_date(&max_date);
///
/// # Ok(())
/// # }
/// ```
pub fn max_date(mut self, date_time: &DateTime<FixedOffset>) -> Self {
self.request.max_date = date_time.timestamp() as i32;
self
}
/// Changes the media filter. Only messages with this type of media will be fetched.
pub fn filter(mut self, filter: tl::enums::MessagesFilter) -> Self {
self.request.filter = filter;
self
}
/// Determines how many messages there are in total.
///
/// This only performs a network call if `next` has not been called before.
pub async fn total(&mut self) -> Result<usize, InvocationError> {
// Unlike most requests, a limit of 0 actually returns 0 and not a default amount
// (as of layer 120).
self.request.limit = 0;
self.get_total().await
}
/// Return the next `Message` from the internal buffer, filling the buffer previously if it's
/// empty.
///
/// Returns `None` if the `limit` is reached or there are no messages left.
pub async fn next(&mut self) -> Result<Option<Message>, InvocationError> {
if let Some(result) = self.next_raw() {
return result;
}
self.request.limit = self.determine_limit(MAX_LIMIT);
self.fill_buffer(self.request.limit).await?;
// Don't bother updating offsets if this is the last time stuff has to be fetched.
if !self.last_chunk && !self.buffer.is_empty() {
let last = &self.buffer[self.buffer.len() - 1];
self.request.offset_id = last.msg.id;
self.request.max_date = last.msg.date;
}
Ok(self.pop_item())
}
}
pub type GlobalSearchIter = IterBuffer<tl::functions::messages::SearchGlobal, Message>;
impl GlobalSearchIter {
fn new(client: &Client) -> Self {
// TODO let users tweak all the options from the request
Self::from_request(
client,
MAX_LIMIT,
tl::functions::messages::SearchGlobal {
folder_id: None,
q: String::new(),
filter: tl::enums::MessagesFilter::InputMessagesFilterEmpty,
min_date: 0,
max_date: 0,
offset_rate: 0,
offset_peer: tl::enums::InputPeer::Empty,
offset_id: 0,
limit: 0,
broadcasts_only: false,
},
)
}
pub fn offset_id(mut self, offset: i32) -> Self {
self.request.offset_id = offset;
self
}
/// Changes the query of the search. Telegram servers perform a somewhat fuzzy search over
/// this query (so a word in singular may also return messages with the word in plural, for
/// example).
pub fn query(mut self, query: &str) -> Self {
self.request.q = query.to_string();
self
}
/// Changes the media filter. Only messages with this type of media will be fetched.
pub fn filter(mut self, filter: tl::enums::MessagesFilter) -> Self {
self.request.filter = filter;
self
}
/// Determines how many messages there are in total.
///
/// This only performs a network call if `next` has not been called before.
pub async fn total(&mut self) -> Result<usize, InvocationError> {
self.request.limit = 1;
self.get_total().await
}
/// Return the next `Message` from the internal buffer, filling the buffer previously if it's
/// empty.
///
/// Returns `None` if the `limit` is reached or there are no messages left.
pub async fn next(&mut self) -> Result<Option<Message>, InvocationError> {
if let Some(result) = self.next_raw() {
return result;
}
self.request.limit = self.determine_limit(MAX_LIMIT);
let offset_rate = self.fill_buffer(self.request.limit).await?;
// Don't bother updating offsets if this is the last time stuff has to be fetched.
if !self.last_chunk && !self.buffer.is_empty() {
let last = &self.buffer[self.buffer.len() - 1];
self.request.offset_rate = offset_rate.unwrap_or(0);
self.request.offset_peer = last.chat().pack().to_input_peer();
self.request.offset_id = last.msg.id;
}
Ok(self.pop_item())
}
}
/// Method implementations related to sending, modifying or getting messages.
impl Client {
/// Sends a message to the desired chat.
///
/// This method can also be used to send media such as photos, videos, documents, polls, etc.
///
/// If you want to send a local file as media, you will need to use
/// [`Client::upload_file`] first.
///
/// Refer to [`InputMessage`] to learn more formatting options, such as using markdown or
/// adding buttons under your message (if you're logged in as a bot).
///
/// See also: [`Message::respond`], [`Message::reply`].
///
/// # Examples
///
/// ```
/// # async fn f(chat: grammers_client::types::Chat, client: grammers_client::Client) -> Result<(), Box<dyn std::error::Error>> {
/// client.send_message(&chat, "Boring text message :-(").await?;
///
/// use grammers_client::InputMessage;
///
/// client.send_message(&chat, InputMessage::text("Sneaky message").silent(true)).await?;
/// # Ok(())
/// # }
/// ```
///
/// [`InputMessage`]: crate::InputMessage
pub async fn send_message<C: Into<PackedChat>, M: Into<types::InputMessage>>(
&self,
chat: C,
message: M,
) -> Result<Message, InvocationError> {
let chat = chat.into();
let message = message.into();
let random_id = generate_random_id();
let entities = parse_mention_entities(self, message.entities.clone());
let updates = if let Some(media) = message.media.clone() {
self.invoke(&tl::functions::messages::SendMedia {
silent: message.silent,
background: message.background,
clear_draft: message.clear_draft,
peer: chat.to_input_peer(),
reply_to: message.reply_to.map(|reply_to_msg_id| {
tl::types::InputReplyToMessage {
reply_to_msg_id,
top_msg_id: None,
reply_to_peer_id: None,
quote_text: None,
quote_entities: None,
quote_offset: None,
}
.into()
}),
media,
message: message.text.clone(),
random_id,
reply_markup: message.reply_markup.clone(),
entities,
schedule_date: message.schedule_date,
send_as: None,
noforwards: false,
update_stickersets_order: false,
invert_media: false,
quick_reply_shortcut: None,
})
.await
} else {
self.invoke(&tl::functions::messages::SendMessage {
no_webpage: !message.link_preview,
silent: message.silent,
background: message.background,
clear_draft: message.clear_draft,
peer: chat.to_input_peer(),
reply_to: message.reply_to.map(|reply_to_msg_id| {
tl::types::InputReplyToMessage {
reply_to_msg_id,
top_msg_id: None,
reply_to_peer_id: None,
quote_text: None,
quote_entities: None,
quote_offset: None,
}
.into()
}),
message: message.text.clone(),
random_id,
reply_markup: message.reply_markup.clone(),
entities,
schedule_date: message.schedule_date,
send_as: None,
noforwards: false,
update_stickersets_order: false,
invert_media: false,
quick_reply_shortcut: None,
})
.await
}?;
Ok(match updates {
tl::enums::Updates::UpdateShortSentMessage(updates) => {
Message::from_short_updates(self, updates, message, chat)
}
updates => map_random_ids_to_messages(self, &[random_id], updates)
.pop()
.unwrap()
.unwrap(),
})
}
/// Edits an existing message.
///
/// Similar to [`Client::send_message`], advanced formatting can be achieved with the
/// options offered by [`InputMessage`].
///
/// See also: [`Message::edit`].
///
/// # Examples
///
/// ```
/// # async fn f(chat: grammers_client::types::Chat, client: grammers_client::Client) -> Result<(), Box<dyn std::error::Error>> {
/// let old_message_id = 123;
/// client.edit_message(&chat, old_message_id, "New text message").await?;
/// # Ok(())
/// # }
/// ```
///
/// [`InputMessage`]: crate::InputMessage
// TODO don't require nasty InputPeer
pub async fn edit_message<C: Into<PackedChat>, M: Into<types::InputMessage>>(
&self,
chat: C,
message_id: i32,
new_message: M,
) -> Result<(), InvocationError> {
let new_message = new_message.into();
let entities = parse_mention_entities(self, new_message.entities);
self.invoke(&tl::functions::messages::EditMessage {
no_webpage: !new_message.link_preview,
invert_media: false,
peer: chat.into().to_input_peer(),
id: message_id,
message: Some(new_message.text),
media: new_message.media,
reply_markup: new_message.reply_markup,
entities,
schedule_date: new_message.schedule_date,
quick_reply_shortcut_id: None,
})
.await?;
Ok(())
}
/// Deletes up to 100 messages in a chat.
///
/// <div class="stab unstable">
///
/// **Warning**: when deleting messages from small group chats or private conversations, this
/// method cannot validate that the provided message IDs actually belong to the input chat due
/// to the way Telegram's API works. Make sure to pass correct [`Message::id`]'s.
///
/// </div>
///
/// The messages are deleted for both ends.
///
/// The amount of deleted messages is returned (it might be less than the amount of input
/// message IDs if some of them were already missing). It is not possible to find out which
/// messages were actually deleted, but if the request succeeds, none of the specified message
/// IDs will appear in the message history from that point on.
///
/// See also: [`Message::delete`].
///
/// # Examples
///
/// ```
/// # async fn f(chat: grammers_client::types::Chat, client: grammers_client::Client) -> Result<(), Box<dyn std::error::Error>> {
/// let message_ids = [123, 456, 789];
///
/// // Careful, these messages will be gone after the method succeeds!
/// client.delete_messages(&chat, &message_ids).await?;
/// # Ok(())
/// # }
/// ```
pub async fn delete_messages<C: Into<PackedChat>>(
&self,
chat: C,
message_ids: &[i32],
) -> Result<usize, InvocationError> {
let tl::enums::messages::AffectedMessages::Messages(affected) =
if let Some(channel) = chat.into().try_to_input_channel() {
self.invoke(&tl::functions::channels::DeleteMessages {
channel,
id: message_ids.to_vec(),
})
.await
} else {
self.invoke(&tl::functions::messages::DeleteMessages {
revoke: true,
id: message_ids.to_vec(),
})
.await
}?;
Ok(affected.pts_count as usize)
}
/// Forwards up to 100 messages from `source` into `destination`.
///
/// For consistency with other methods, the chat upon which this request acts comes first
/// (destination), and then the source chat.
///
/// Returns the new forwarded messages in a list. Those messages that could not be forwarded
/// will be `None`. The length of the resulting list is the same as the length of the input
/// message IDs, and the indices from the list of IDs map to the indices in the result so
/// you can find which messages were forwarded and which message they became.
///
/// See also: [`Message::forward_to`].
///
/// # Examples
///
/// ```
/// # async fn f(destination: grammers_client::types::Chat, source: grammers_client::types::Chat, client: grammers_client::Client) -> Result<(), Box<dyn std::error::Error>> {
/// let message_ids = [123, 456, 789];
///
/// let messages = client.forward_messages(&destination, &message_ids, &source).await?;
/// let fwd_count = messages.into_iter().filter(Option::is_some).count();
/// println!("Forwarded {} out of {} messages!", fwd_count, message_ids.len());
/// # Ok(())
/// # }
/// ```
pub async fn forward_messages<C: Into<PackedChat>, S: Into<PackedChat>>(
&self,
destination: C,
message_ids: &[i32],
source: S,
) -> Result<Vec<Option<Message>>, InvocationError> {
// TODO let user customize more options
let request = tl::functions::messages::ForwardMessages {
silent: false,
background: false,
with_my_score: false,
drop_author: false,
drop_media_captions: false,
from_peer: source.into().to_input_peer(),
id: message_ids.to_vec(),
random_id: generate_random_ids(message_ids.len()),
to_peer: destination.into().to_input_peer(),
top_msg_id: None,
schedule_date: None,
send_as: None,
noforwards: false,
quick_reply_shortcut: None,
};
let result = self.invoke(&request).await?;
Ok(map_random_ids_to_messages(self, &request.random_id, result))
}
/// Gets the [`Message`] to which the input message is replying to.
///
/// See also: [`Message::get_reply`].
///
/// # Examples
///
/// ```
/// # async fn f(message: grammers_client::types::Message, client: grammers_client::Client) -> Result<(), Box<dyn std::error::Error>> {
/// if let Some(reply) = client.get_reply_to_message(&message).await? {
/// println!("The reply said: {}", reply.text());
/// }
/// # Ok(())
/// # }
/// ```
pub async fn get_reply_to_message(
&self,
message: &Message,
) -> Result<Option<Message>, InvocationError> {
/// Helper method to fetch a single message by its input message.
async fn get_message(
client: &Client,
chat: PackedChat,
id: tl::enums::InputMessage,
) -> Result<(tl::enums::messages::Messages, bool), InvocationError> {
if let Some(channel) = chat.try_to_input_channel() {
client
.invoke(&tl::functions::channels::GetMessages {
id: vec![id],
channel,
})
.await
.map(|res| (res, false))
} else {
client
.invoke(&tl::functions::messages::GetMessages { id: vec![id] })
.await
.map(|res| (res, true))
}
}
// TODO shouldn't this method take in a message id anyway?
let chat = message.chat().pack();
let reply_to_message_id = match message.reply_to_message_id() {
Some(id) => id,
None => return Ok(None),
};
let input_id =
tl::enums::InputMessage::ReplyTo(tl::types::InputMessageReplyTo { id: message.msg.id });
let (res, filter_req) = match get_message(self, chat, input_id).await {
Ok(tup) => tup,
Err(_) => {
let input_id = tl::enums::InputMessage::Id(tl::types::InputMessageId {
id: reply_to_message_id,
});
get_message(self, chat, input_id).await?
}
};
use tl::enums::messages::Messages;
let (messages, users, chats) = match res {
Messages::Messages(m) => (m.messages, m.users, m.chats),
Messages::Slice(m) => (m.messages, m.users, m.chats),
Messages::ChannelMessages(m) => (m.messages, m.users, m.chats),
Messages::NotModified(_) => {
panic!("API returned Messages::NotModified even though GetMessages was used")
}
};
let chats = ChatMap::new(users, chats);
Ok(messages
.into_iter()
.flat_map(|m| Message::new(self, m, &chats))
.next()
.filter(|m| !filter_req || m.msg.peer_id == message.msg.peer_id))
}
/// Iterate over the message history of a chat, from most recent to oldest.
///
/// # Examples
///
/// ```
/// # async fn f(chat: grammers_client::types::Chat, client: grammers_client::Client) -> Result<(), Box<dyn std::error::Error>> {
/// // Note we're setting a reasonable limit, or we'd print out ALL the messages in chat!
/// let mut messages = client.iter_messages(&chat).limit(100);
///
/// while let Some(message) = messages.next().await? {
/// println!("{}", message.text());
/// }
/// # Ok(())
/// # }
/// ```
pub fn iter_messages<C: Into<PackedChat>>(&self, chat: C) -> MessageIter {
MessageIter::new(self, chat.into())
}
/// Iterate over the messages that match certain search criteria.
///
/// This allows you to search by text within a chat or filter by media among other things.
///
/// # Examples
///
/// ```
/// # async fn f(chat: grammers_client::types::Chat, client: grammers_client::Client) -> Result<(), Box<dyn std::error::Error>> {
/// // Let's print all the people who think grammers is cool.
/// let mut messages = client.search_messages(&chat).query("grammers is cool");
///
/// while let Some(message) = messages.next().await? {
/// println!("{}", message.sender().unwrap().name());
/// }
/// # Ok(())
/// # }
/// ```
pub fn search_messages<C: Into<PackedChat>>(&self, chat: C) -> SearchIter {
SearchIter::new(self, chat.into())
}
/// Iterate over the messages that match certain search criteria, without being restricted to
/// searching in a specific chat. The downside is that this global search supports less filters.
///
/// This allows you to search by text within a chat or filter by media among other things.
///
/// # Examples
///
/// ```
/// # async fn f(client: grammers_client::Client) -> Result<(), Box<dyn std::error::Error>> {
/// // Let's print all the chats were people think grammers is cool.
/// let mut messages = client.search_all_messages().query("grammers is cool");
///
/// while let Some(message) = messages.next().await? {
/// println!("{}", message.chat().name());
/// }
/// # Ok(())
/// # }
/// ```
pub fn search_all_messages(&self) -> GlobalSearchIter {
GlobalSearchIter::new(self)
}
/// Get up to 100 messages using their ID.
///
/// Returns the new retrieved messages in a list. Those messages that could not be retrieved
/// or do not belong to the input chat will be `None`. The length of the resulting list is the
/// same as the length of the input message IDs, and the indices from the list of IDs map to
/// the indices in the result so you can map them into the new list.
///
/// # Examples
///
/// ```
/// # async fn f(chat: grammers_client::types::Chat, client: grammers_client::Client) -> Result<(), Box<dyn std::error::Error>> {
/// let message_ids = [123, 456, 789];
///
/// let messages = client.get_messages_by_id(&chat, &message_ids).await?;
/// let count = messages.into_iter().filter(Option::is_some).count();
/// println!("{} out of {} messages were deleted!", message_ids.len() - count, message_ids.len());
/// # Ok(())
/// # }
/// ```
pub async fn get_messages_by_id<C: Into<PackedChat>>(
&self,
chat: C,
message_ids: &[i32],
) -> Result<Vec<Option<Message>>, InvocationError> {
let chat = chat.into();
let id = message_ids
.iter()
.map(|&id| tl::enums::InputMessage::Id(tl::types::InputMessageId { id }))
.collect();
let result = if let Some(channel) = chat.try_to_input_channel() {
self.invoke(&tl::functions::channels::GetMessages { channel, id })
.await
} else {
self.invoke(&tl::functions::messages::GetMessages { id })
.await
}?;
let (messages, users, chats) = match result {
tl::enums::messages::Messages::Messages(m) => (m.messages, m.users, m.chats),
tl::enums::messages::Messages::Slice(m) => (m.messages, m.users, m.chats),
tl::enums::messages::Messages::ChannelMessages(m) => (m.messages, m.users, m.chats),
tl::enums::messages::Messages::NotModified(_) => {
panic!("API returned Messages::NotModified even though GetMessages was used")
}
};
let chats = ChatMap::new(users, chats);
let mut map = messages
.into_iter()
.flat_map(|m| Message::new(self, m, &chats))
.filter(|m| m.chat().pack() == chat)
.map(|m| (m.msg.id, m))
.collect::<HashMap<_, _>>();
Ok(message_ids.iter().map(|id| map.remove(id)).collect())
}
/// Get the latest pin from a chat.
///
/// # Examples
///
/// ```
/// # async fn f(chat: grammers_client::types::Chat, client: grammers_client::Client) -> Result<(), Box<dyn std::error::Error>> {
/// if let Some(message) = client.get_pinned_message(&chat).await? {
/// println!("There is a message pinned in {}: {}", chat.name(), message.text());
/// } else {
/// println!("There are no messages pinned in {}", chat.name());
/// }
/// # Ok(())
/// # }
/// ```
pub async fn get_pinned_message<C: Into<PackedChat>>(
&self,
chat: C,
) -> Result<Option<Message>, InvocationError> {
let chat = chat.into();
// TODO return types::Message and print its text in the example
let id = vec![tl::enums::InputMessage::Pinned];
let result = if let Some(channel) = chat.try_to_input_channel() {
self.invoke(&tl::functions::channels::GetMessages { channel, id })
.await
} else {
self.invoke(&tl::functions::messages::GetMessages { id })
.await
}?;
let (messages, users, chats) = match result {
tl::enums::messages::Messages::Messages(m) => (m.messages, m.users, m.chats),
tl::enums::messages::Messages::Slice(m) => (m.messages, m.users, m.chats),
tl::enums::messages::Messages::ChannelMessages(m) => (m.messages, m.users, m.chats),
tl::enums::messages::Messages::NotModified(_) => {
panic!("API returned Messages::NotModified even though GetMessages was used")
}
};
let chats = ChatMap::new(users, chats);
Ok(messages
.into_iter()
.flat_map(|m| Message::new(self, m, &chats))
.find(|m| m.chat().pack() == chat))
}
/// Pin a message in the chat. This will not notify any users.
///
/// # Examples
///
/// ```
/// # async fn f(chat: grammers_client::types::Chat, client: grammers_client::Client) -> Result<(), Box<dyn std::error::Error>> {
/// let message_id = 123;
/// client.pin_message(&chat, message_id).await?;
/// # Ok(())
/// # }
/// ```
// TODO return produced Option<service message>
pub async fn pin_message<C: Into<PackedChat>>(
&self,
chat: C,
message_id: i32,
) -> Result<(), InvocationError> {
self.update_pinned(chat.into(), message_id, true).await
}
/// Unpin a message from the chat.
///
/// # Examples
///
/// ```
/// # async fn f(chat: grammers_client::types::Chat, client: grammers_client::Client) -> Result<(), Box<dyn std::error::Error>> {
/// let message_id = 123;
/// client.unpin_message(&chat, message_id).await?;
/// # Ok(())
/// # }
/// ```
pub async fn unpin_message<C: Into<PackedChat>>(
&self,
chat: C,
message_id: i32,
) -> Result<(), InvocationError> {
self.update_pinned(chat.into(), message_id, false).await
}
async fn update_pinned(
&self,
chat: PackedChat,
id: i32,
pin: bool,
) -> Result<(), InvocationError> {
self.invoke(&tl::functions::messages::UpdatePinnedMessage {
silent: true,
unpin: !pin,
pm_oneside: false,
peer: chat.to_input_peer(),
id,
})
.await
.map(drop)
}
/// Unpin all currently-pinned messages from the chat.
///
/// # Examples
///
/// ```
/// # async fn f(chat: grammers_client::types::Chat, client: grammers_client::Client) -> Result<(), Box<dyn std::error::Error>> {
/// client.unpin_all_messages(&chat).await?;
/// # Ok(())
/// # }
/// ```
pub async fn unpin_all_messages<C: Into<PackedChat>>(
&self,
chat: C,
) -> Result<(), InvocationError> {
self.invoke(&tl::functions::messages::UnpinAllMessages {
peer: chat.into().to_input_peer(),
top_msg_id: None,
})
.await?;
Ok(())
}
}