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
// 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.
use crate::types::Role;
use crate::Client;
use grammers_mtproto::mtp::RpcError;
use grammers_mtsender::InvocationError;
use grammers_session::PackedChat;
use grammers_tl_types as tl;
use pin_project_lite::pin_project;
use std::{
future::Future,
marker::PhantomPinned,
mem::drop,
pin::Pin,
task::{Context, Poll},
time::{Duration, SystemTime, UNIX_EPOCH},
};
type BuilderRes = Result<(), InvocationError>;
type AdminFutGen<F> = fn(AdminRightsBuilderInner) -> F;
pub(crate) struct AdminRightsBuilderInner {
client: Client,
chat: PackedChat,
peer: tl::enums::InputPeer,
user: tl::enums::InputUser, // TODO redundant with `peer` (but less annoying to use)
rights: tl::types::ChatAdminRights,
rank: String,
}
impl AdminRightsBuilderInner {
// Perform the call.
pub(crate) async fn invoke(self) -> Result<(), InvocationError> {
if let Some(chan) = self.chat.try_to_input_channel() {
self.client
.invoke(&tl::functions::channels::EditAdmin {
channel: chan,
user_id: self.user.clone(),
admin_rights: tl::enums::ChatAdminRights::Rights(self.rights.clone()),
rank: self.rank.clone(),
})
.await
.map(drop)
} else if let Some(id) = self.chat.try_to_chat_id() {
let promote = self.rights.anonymous
|| self.rights.change_info
|| self.rights.post_messages
|| self.rights.edit_messages
|| self.rights.delete_messages
|| self.rights.ban_users
|| self.rights.invite_users
|| self.rights.pin_messages
|| self.rights.add_admins
|| self.rights.manage_call;
self.client
.invoke(&tl::functions::messages::EditChatAdmin {
chat_id: id,
user_id: self.user.clone(),
is_admin: promote,
})
.await
.map(drop)
} else {
Err(InvocationError::Rpc(RpcError {
code: 400,
name: "PEER_ID_INVALID".to_string(),
value: None,
caused_by: None,
}))
}
}
}
pin_project! {
/// Builder for editing the administrator rights of a user in a specific chat.
///
/// Use [`Client::set_admin_rights`] to retrieve an instance of this type.
#[must_use = "futures do nothing unless you `.await` or poll them"]
pub struct AdminRightsBuilder<F: Future<Output = BuilderRes>> {
inner: Option<AdminRightsBuilderInner>,
gen: AdminFutGen<F>,
#[pin]
fut: Option<F>,
_phantom: PhantomPinned
}
}
impl<F: Future<Output = BuilderRes>> Future for AdminRightsBuilder<F> {
type Output = BuilderRes;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<BuilderRes> {
let mut s = self.project();
if s.fut.is_none() {
// unwrap safety: s.inner is None only when s.fut is some
// or s.fut is resolved
s.fut.set(Some((s.gen)(s.inner.take().unwrap())))
}
s.fut.as_pin_mut().unwrap().poll(cx)
}
}
impl<F: Future<Output = BuilderRes>> AdminRightsBuilder<F> {
pub(crate) fn new(
client: Client,
chat: PackedChat,
user: PackedChat,
gen: AdminFutGen<F>,
) -> Self {
Self {
inner: Some(AdminRightsBuilderInner {
client,
chat,
peer: user.to_input_peer(),
user: user.to_input_user_lossy(),
rank: "".into(),
rights: tl::types::ChatAdminRights {
anonymous: false,
change_info: false,
post_messages: false,
edit_messages: false,
delete_messages: false,
ban_users: false,
invite_users: false,
pin_messages: false,
add_admins: false,
manage_call: false,
other: false,
manage_topics: false,
post_stories: false,
edit_stories: false,
delete_stories: false,
},
}),
gen,
fut: None,
_phantom: PhantomPinned,
}
}
fn inner_mut(&mut self) -> &mut AdminRightsBuilderInner {
// Unwrap safety: AdminRightsBuilderInner should never be None unless polled after being
// resolved
self.inner.as_mut().unwrap()
}
/// Load the current rights of the user. This lets you trivially grant or take away specific
/// permissions without changing any of the previous ones.
pub async fn load_current(mut self) -> Result<Self, InvocationError> {
let s = self.inner_mut();
if let Some(chan) = s.chat.try_to_input_channel() {
let tl::enums::channels::ChannelParticipant::Participant(user) = s
.client
.invoke(&tl::functions::channels::GetParticipant {
channel: chan,
participant: s.peer.clone(),
})
.await?;
match user.participant {
tl::enums::ChannelParticipant::Creator(c) => {
s.rights = c.admin_rights.into();
s.rank = c.rank.unwrap_or_default();
}
tl::enums::ChannelParticipant::Admin(a) => {
s.rights = a.admin_rights.into();
s.rank = a.rank.unwrap_or_default();
}
_ => (),
}
} else if s.chat.try_to_chat_id().is_some() {
let uid = match &s.user {
tl::enums::InputUser::User(u) => u.user_id,
tl::enums::InputUser::FromMessage(u) => u.user_id,
_ => {
return Err(InvocationError::Rpc(RpcError {
code: 400,
name: "PEER_ID_INVALID".to_string(),
value: None,
caused_by: None,
}))
}
};
let mut participants = s.client.iter_participants(s.chat);
while let Some(participant) = participants.next().await? {
if matches!(participant.role, Role::Creator(_) | Role::Admin(_))
&& participant.user.id() == uid
{
s.rights = tl::types::ChatAdminRights {
change_info: true,
post_messages: true,
edit_messages: false,
delete_messages: true,
ban_users: true,
invite_users: true,
pin_messages: true,
add_admins: true,
anonymous: false,
manage_call: true,
other: true,
manage_topics: true,
post_stories: true,
edit_stories: true,
delete_stories: true,
};
break;
}
}
}
Ok(self)
}
/// Whether the user will remain anonymous when sending messages.
///
/// The sender of the anonymous messages becomes the group itself.
///
/// Note that other people in the channel may be able to identify the anonymous admin by its
/// custom rank, so additional care is needed when using both anonymous and custom ranks.
///
/// For example, if multiple anonymous admins share the same title, users won't be able to
/// distinguish them.
pub fn anonymous(mut self, val: bool) -> Self {
self.inner_mut().rights.anonymous = val;
self
}
/// Whether the user is able to manage calls in the group.
pub fn manage_call(mut self, val: bool) -> Self {
self.inner_mut().rights.manage_call = val;
self
}
/// Whether the user is able to change information about the chat such as group description or
/// not.
pub fn change_info(mut self, val: bool) -> Self {
self.inner_mut().rights.change_info = val;
self
}
/// Whether the user will be able to post in the channel. This will only work in broadcast
/// channels, not groups.
pub fn post_messages(mut self, val: bool) -> Self {
self.inner_mut().rights.post_messages = val;
self
}
/// Whether the user will be able to edit messages in the channel. This will only work in
/// broadcast channels, not groups.
pub fn edit_messages(mut self, val: bool) -> Self {
self.inner_mut().rights.edit_messages = val;
self
}
/// Whether the user will be able to delete messages. This includes messages from others.
pub fn delete_messages(mut self, val: bool) -> Self {
self.inner_mut().rights.delete_messages = val;
self
}
/// Whether the user will be able to edit the restrictions of other users. This effectively
/// lets the administrator ban (or kick) people.
pub fn ban_users(mut self, val: bool) -> Self {
self.inner_mut().rights.ban_users = val;
self
}
/// Whether the user will be able to invite other users.
pub fn invite_users(mut self, val: bool) -> Self {
self.inner_mut().rights.invite_users = val;
self
}
/// Whether the user will be able to pin messages.
pub fn pin_messages(mut self, val: bool) -> Self {
self.inner_mut().rights.pin_messages = val;
self
}
/// Whether the user will be able to add other administrators with the same or less
/// permissions than the user itself.
pub fn add_admins(mut self, val: bool) -> Self {
self.inner_mut().rights.add_admins = val;
self
}
/// The custom rank (also known as "admin title" or "badge") to show for this administrator.
///
/// This text will be shown instead of the "admin" badge.
///
/// When left unspecified or empty, the default localized "admin" badge will be shown.
pub fn rank<S: Into<String>>(mut self, val: S) -> Self {
self.inner_mut().rank = val.into();
self
}
}
type BannedFutGen<F> = fn(BannedRightsBuilderInner) -> F;
pub(crate) struct BannedRightsBuilderInner {
client: Client,
chat: PackedChat,
peer: tl::enums::InputPeer,
user: tl::enums::InputUser,
rights: tl::types::ChatBannedRights,
}
impl BannedRightsBuilderInner {
// Perform the call.
pub(crate) async fn invoke(self) -> Result<(), InvocationError> {
if let Some(chan) = self.chat.try_to_input_channel() {
self.client
.invoke(&tl::functions::channels::EditBanned {
channel: chan,
participant: self.peer.clone(),
banned_rights: tl::enums::ChatBannedRights::Rights(self.rights.clone()),
})
.await
.map(drop)
} else if let Some(id) = self.chat.try_to_chat_id() {
if self.rights.view_messages {
self.client
.invoke(&tl::functions::messages::DeleteChatUser {
chat_id: id,
user_id: self.user.clone(),
revoke_history: false,
})
.await
.map(drop)
} else {
Err(InvocationError::Rpc(RpcError {
code: 400,
name: "CHAT_INVALID".to_string(),
value: None,
caused_by: None,
}))
}
} else {
Err(InvocationError::Rpc(RpcError {
code: 400,
name: "PEER_ID_INVALID".to_string(),
value: None,
caused_by: None,
}))
}
}
}
pin_project! {
/// Builder for editing the rights of a non-admin user in a specific chat.
///
/// Certain groups (small group chats) only allow banning (disallow `view_messages`). Trying to
/// disallow other permissions in these groups will fail.
///
/// Use [`Client::set_banned_rights`] to retrieve an instance of this type.
#[must_use = "futures do nothing unless you `.await` or poll them"]
pub struct BannedRightsBuilder<F: Future<Output = BuilderRes>> {
inner: Option<BannedRightsBuilderInner>,
gen: BannedFutGen<F>,
#[pin]
fut: Option<F>,
_phantom: PhantomPinned
}
}
impl<F: Future<Output = BuilderRes>> Future for BannedRightsBuilder<F> {
type Output = BuilderRes;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<BuilderRes> {
let mut s = self.project();
if s.fut.is_none() {
// unwrap safety: s.inner is None only when s.fut is some
// or s.fut is resolved
s.fut.set(Some((s.gen)(s.inner.take().unwrap())))
}
s.fut.as_pin_mut().unwrap().poll(cx)
}
}
impl<F: Future<Output = BuilderRes>> BannedRightsBuilder<F> {
pub(crate) fn new(
client: Client,
chat: PackedChat,
user: PackedChat,
gen: BannedFutGen<F>,
) -> Self {
Self {
inner: Some(BannedRightsBuilderInner {
client,
chat,
peer: user.to_input_peer(),
user: user.to_input_user_lossy(),
rights: tl::types::ChatBannedRights {
view_messages: false,
send_messages: false,
send_media: false,
send_stickers: false,
send_gifs: false,
send_games: false,
send_inline: false,
embed_links: false,
send_polls: false,
change_info: false,
invite_users: false,
pin_messages: false,
manage_topics: false,
send_photos: false,
send_videos: false,
send_roundvideos: false,
send_audios: false,
send_voices: false,
send_docs: false,
send_plain: false,
until_date: 0,
},
}),
gen,
fut: None,
_phantom: PhantomPinned,
}
}
fn inner_mut(&mut self) -> &mut BannedRightsBuilderInner {
// Unwrap safety: AdminRightsBuilderInner should never be None unless polled after being
// resolved
self.inner.as_mut().unwrap()
}
/// Load the current rights of the user. This lets you trivially grant or take away specific
/// permissions without changing any of the previous ones.
pub async fn load_current(mut self) -> Result<Self, InvocationError> {
let s = self.inner_mut();
if let Some(chan) = s.chat.try_to_input_channel() {
let tl::enums::channels::ChannelParticipant::Participant(user) = s
.client
.invoke(&tl::functions::channels::GetParticipant {
channel: chan,
participant: s.peer.clone(),
})
.await?;
if let tl::enums::ChannelParticipant::Banned(u) = user.participant {
s.rights = u.banned_rights.into();
}
}
Ok(self)
}
/// Whether the user is able to view messages or not. Forbidding someone from viewing messages
/// effectively bans (kicks) them.
pub fn view_messages(mut self, val: bool) -> Self {
// `true` indicates "take away", but in the builder it makes more sense that `false` means
// "they won't have this permission". All methods perform this negation for that reason.
self.inner_mut().rights.view_messages = !val;
self
}
/// Whether the user is able to send messages or not. The user will remain in the chat, and
/// can still read the conversation.
pub fn send_messages(mut self, val: bool) -> Self {
self.inner_mut().rights.send_messages = !val;
self
}
/// Whether the user is able to send any form of media or not, such as photos or voice notes.
pub fn send_media(mut self, val: bool) -> Self {
self.inner_mut().rights.send_media = !val;
self
}
/// Whether the user is able to send stickers or not.
pub fn send_stickers(mut self, val: bool) -> Self {
self.inner_mut().rights.send_stickers = !val;
self
}
/// Whether the user is able to send animated gifs or not.
pub fn send_gifs(mut self, val: bool) -> Self {
self.inner_mut().rights.send_gifs = !val;
self
}
/// Whether the user is able to send games or not.
pub fn send_games(mut self, val: bool) -> Self {
self.inner_mut().rights.send_games = !val;
self
}
/// Whether the user is able to use inline bots or not.
pub fn send_inline(mut self, val: bool) -> Self {
self.inner_mut().rights.send_inline = !val;
self
}
/// Whether the user is able to enable the link preview in the messages they send.
///
/// Note that the user will still be able to send messages with links if this permission is
/// taken away from the user, but these links won't display a link preview.
pub fn embed_link_previews(mut self, val: bool) -> Self {
self.inner_mut().rights.embed_links = !val;
self
}
/// Whether the user is able to send polls or not.
pub fn send_polls(mut self, val: bool) -> Self {
self.inner_mut().rights.send_polls = !val;
self
}
/// Whether the user is able to change information about the chat such as group description or
/// not.
pub fn change_info(mut self, val: bool) -> Self {
self.inner_mut().rights.change_info = !val;
self
}
/// Whether the user is able to invite other users or not.
pub fn invite_users(mut self, val: bool) -> Self {
self.inner_mut().rights.invite_users = !val;
self
}
/// Whether the user is able to pin messages or not.
pub fn pin_messages(mut self, val: bool) -> Self {
self.inner_mut().rights.pin_messages = !val;
self
}
/// Apply the restrictions until the given epoch time.
///
/// Note that this is absolute time (i.e current time is not added).
///
/// By default, the restriction is permanent.
pub fn until(mut self, val: i32) -> Self {
// TODO this should take a date, not int
self.inner_mut().rights.until_date = val;
self
}
/// Apply the restriction for a given duration.
pub fn duration(mut self, val: Duration) -> Self {
// TODO this should account for the server time instead (via sender's offset)
self.inner_mut().rights.until_date = SystemTime::now()
.duration_since(UNIX_EPOCH)
.expect("system time is before epoch")
.as_secs() as i32
+ val.as_secs() as i32;
self
}
}