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
use chrono::{DateTime, FixedOffset}; use model::prelude::*; #[cfg(all(feature = "cache", feature = "model"))] use CACHE; #[cfg(feature = "model")] use builder::{ CreateInvite, CreateMessage, EditChannel, EditMessage, GetMessages }; #[cfg(feature = "model")] use http::{self, AttachmentType}; #[cfg(all(feature = "cache", feature = "model"))] use internal::prelude::*; #[cfg(feature = "model")] use std::fmt::{ Display, Formatter, Result as FmtResult }; #[cfg(feature = "model")] use std::mem; #[cfg(all(feature = "model", feature = "utils"))] use utils::{self as serenity_utils, VecMap}; /// Represents a guild's text or voice channel. Some methods are available only /// for voice channels and some are only available for text channels. #[derive(Clone, Debug, Deserialize, Serialize)] pub struct GuildChannel { /// The unique Id of the channel. /// /// The default channel Id shares the Id of the guild and the default role. pub id: ChannelId, /// The bitrate of the channel. /// /// **Note**: This is only available for voice channels. pub bitrate: Option<u64>, /// Whether this guild channel belongs in a category. #[serde(rename = "parent_id")] pub category_id: Option<ChannelId>, /// The Id of the guild the channel is located in. /// /// If this matches with the [`id`], then this is the default text channel. /// /// The original voice channel has an Id equal to the guild's Id, /// incremented by one. pub guild_id: GuildId, /// The type of the channel. #[serde(rename = "type")] pub kind: ChannelType, /// The Id of the last message sent in the channel. /// /// **Note**: This is only available for text channels. pub last_message_id: Option<MessageId>, /// The timestamp of the time a pin was most recently made. /// /// **Note**: This is only available for text channels. pub last_pin_timestamp: Option<DateTime<FixedOffset>>, /// The name of the channel. pub name: String, /// Permission overwrites for [`Member`]s and for [`Role`]s. /// /// [`Member`]: struct.Member.html /// [`Role`]: struct.Role.html pub permission_overwrites: Vec<PermissionOverwrite>, /// The position of the channel. /// /// The default text channel will _almost always_ have a position of `-1` or /// `0`. pub position: i64, /// The topic of the channel. /// /// **Note**: This is only available for text channels. pub topic: Option<String>, /// The maximum number of members allowed in the channel. /// /// **Note**: This is only available for voice channels. pub user_limit: Option<u64>, /// Used to tell if the channel is not safe for work. /// Note however, it's recommended to use [`is_nsfw`] as it's gonna be more accurate. /// /// [`is_nsfw`]: struct.GuildChannel.html#method.is_nsfw // This field can or can not be present sometimes, but if it isn't // default to `false`. #[serde(default)] pub nsfw: bool, } #[cfg(feature = "model")] impl GuildChannel { /// Broadcasts to the channel that the current user is typing. /// /// For bots, this is a good indicator for long-running commands. /// /// **Note**: Requires the [Send Messages] permission. /// /// # Errors /// /// Returns a [`ModelError::InvalidPermissions`] if the current user does /// not have the required permissions. /// /// [`ModelError::InvalidPermissions`]: enum.ModelError.html#variant.InvalidPermissions /// [Send Messages]: permissions/constant.SEND_MESSAGES.html pub fn broadcast_typing(&self) -> Result<()> { self.id.broadcast_typing() } /// Creates an invite leading to the given channel. /// /// # Examples /// /// Create an invite that can only be used 5 times: /// /// ```rust,ignore /// let invite = channel.create_invite(|i| i.max_uses(5)); /// ``` #[cfg(feature = "utils")] pub fn create_invite<F>(&self, f: F) -> Result<RichInvite> where F: FnOnce(CreateInvite) -> CreateInvite { #[cfg(feature = "cache")] { let req = Permissions::CREATE_INVITE; if !utils::user_has_perms(self.id, req)? { return Err(Error::Model(ModelError::InvalidPermissions(req))); } } let map = serenity_utils::vecmap_to_json_map(f(CreateInvite::default()).0); http::create_invite(self.id.0, &map) } /// Creates a [permission overwrite][`PermissionOverwrite`] for either a /// single [`Member`] or [`Role`] within a [`Channel`]. /// /// Refer to the documentation for [`PermissionOverwrite`]s for more /// information. /// /// Requires the [Manage Channels] permission. /// /// # Examples /// /// Creating a permission overwrite for a member by specifying the /// [`PermissionOverwrite::Member`] variant, allowing it the [Send Messages] /// permission, but denying the [Send TTS Messages] and [Attach Files] /// permissions: /// /// ```rust,no_run /// # use serenity::model::id::{ChannelId, UserId}; /// # use std::error::Error; /// # /// # fn try_main() -> Result<(), Box<Error>> { /// # let (channel_id, user_id) = (ChannelId(0), UserId(0)); /// # /// use serenity::model::channel::{ /// PermissionOverwrite, /// PermissionOverwriteType, /// }; /// use serenity::model::{ModelError, Permissions}; /// use serenity::CACHE; /// /// let allow = Permissions::SEND_MESSAGES; /// let deny = Permissions::SEND_TTS_MESSAGES | Permissions::ATTACH_FILES; /// let overwrite = PermissionOverwrite { /// allow: allow, /// deny: deny, /// kind: PermissionOverwriteType::Member(user_id), /// }; /// /// let cache = CACHE.read(); /// let channel = cache /// .guild_channel(channel_id) /// .ok_or(ModelError::ItemMissing)?; /// /// channel.read().create_permission(&overwrite)?; /// # Ok(()) /// # } /// # /// # fn main() { /// # try_main().unwrap(); /// # } /// ``` /// /// Creating a permission overwrite for a role by specifying the /// [`PermissionOverwrite::Role`] variant, allowing it the [Manage Webhooks] /// permission, but denying the [Send TTS Messages] and [Attach Files] /// permissions: /// /// ```rust,no_run /// # use serenity::model::id::{ChannelId, UserId}; /// # use std::error::Error; /// # /// # fn try_main() -> Result<(), Box<Error>> { /// # let (channel_id, user_id) = (ChannelId(0), UserId(0)); /// # /// use serenity::model::channel::{ /// PermissionOverwrite, /// PermissionOverwriteType, /// }; /// use serenity::model::{ModelError, Permissions}; /// use serenity::CACHE; /// /// let allow = Permissions::SEND_MESSAGES; /// let deny = Permissions::SEND_TTS_MESSAGES | Permissions::ATTACH_FILES; /// let overwrite = PermissionOverwrite { /// allow: allow, /// deny: deny, /// kind: PermissionOverwriteType::Member(user_id), /// }; /// /// let cache = CACHE.read(); /// let channel = cache /// .guild_channel(channel_id) /// .ok_or(ModelError::ItemMissing)?; /// /// channel.read().create_permission(&overwrite)?; /// # Ok(()) /// # } /// # /// # fn main() { /// # try_main().unwrap(); /// # } /// ``` /// /// [`Channel`]: enum.Channel.html /// [`Member`]: struct.Member.html /// [`PermissionOverwrite`]: struct.PermissionOverwrite.html /// [`PermissionOverwrite::Member`]: struct.PermissionOverwrite.html#variant.Member /// [`PermissionOverwrite::Role`]: struct.PermissionOverwrite.html#variant.Role /// [`Role`]: struct.Role.html /// [Attach Files]: permissions/constant.ATTACH_FILES.html /// [Manage Channels]: permissions/constant.MANAGE_CHANNELS.html /// [Manage Webhooks]: permissions/constant.MANAGE_WEBHOOKS.html /// [Send Messages]: permissions/constant.SEND_MESSAGES.html /// [Send TTS Messages]: permissions/constant.SEND_TTS_MESSAGES.html #[inline] pub fn create_permission(&self, target: &PermissionOverwrite) -> Result<()> { self.id.create_permission(target) } /// Deletes this channel, returning the channel on a successful deletion. pub fn delete(&self) -> Result<Channel> { #[cfg(feature = "cache")] { let req = Permissions::MANAGE_CHANNELS; if !utils::user_has_perms(self.id, req)? { return Err(Error::Model(ModelError::InvalidPermissions(req))); } } self.id.delete() } /// Deletes all messages by Ids from the given vector in the channel. /// /// Refer to [`Channel::delete_messages`] for more information. /// /// Requires the [Manage Messages] permission. /// /// **Note**: Messages that are older than 2 weeks can't be deleted using /// this method. /// /// # Errors /// /// Returns [`ModelError::BulkDeleteAmount`] if an attempt was made to /// delete either 0 or more than 100 messages. /// /// [`Channel::delete_messages`]: enum.Channel.html#method.delete_messages /// [`ModelError::BulkDeleteAmount`]: ../enum.ModelError.html#variant.BulkDeleteAmount /// [Manage Messages]: permissions/constant.MANAGE_MESSAGES.html #[inline] pub fn delete_messages<T: AsRef<MessageId>, It: IntoIterator<Item=T>>(&self, message_ids: It) -> Result<()> { self.id.delete_messages(message_ids) } /// Deletes all permission overrides in the channel from a member /// or role. /// /// **Note**: Requires the [Manage Channel] permission. /// /// [Manage Channel]: permissions/constant.MANAGE_CHANNELS.html #[inline] pub fn delete_permission(&self, permission_type: PermissionOverwriteType) -> Result<()> { self.id.delete_permission(permission_type) } /// Deletes the given [`Reaction`] from the channel. /// /// **Note**: Requires the [Manage Messages] permission, _if_ the current /// user did not perform the reaction. /// /// [`Reaction`]: struct.Reaction.html /// [Manage Messages]: permissions/constant.MANAGE_MESSAGES.html #[inline] pub fn delete_reaction<M, R>(&self, message_id: M, user_id: Option<UserId>, reaction_type: R) -> Result<()> where M: Into<MessageId>, R: Into<ReactionType> { self.id.delete_reaction(message_id, user_id, reaction_type) } /// Modifies a channel's settings, such as its position or name. /// /// Refer to `EditChannel`s documentation for a full list of methods. /// /// # Examples /// /// Change a voice channels name and bitrate: /// /// ```rust,ignore /// channel.edit(|c| c.name("test").bitrate(86400)); /// ``` #[cfg(feature = "utils")] pub fn edit<F>(&mut self, f: F) -> Result<()> where F: FnOnce(EditChannel) -> EditChannel { #[cfg(feature = "cache")] { let req = Permissions::MANAGE_CHANNELS; if !utils::user_has_perms(self.id, req)? { return Err(Error::Model(ModelError::InvalidPermissions(req))); } } let mut map = VecMap::new(); map.insert("name", Value::String(self.name.clone())); map.insert("position", Value::Number(Number::from(self.position))); map.insert("type", Value::String(self.kind.name().to_string())); let edited = serenity_utils::vecmap_to_json_map(f(EditChannel(map)).0); match http::edit_channel(self.id.0, &edited) { Ok(channel) => { mem::replace(self, channel); Ok(()) }, Err(why) => Err(why), } } /// Edits a [`Message`] in the channel given its Id. /// /// Message editing preserves all unchanged message data. /// /// Refer to the documentation for [`EditMessage`] for more information /// regarding message restrictions and requirements. /// /// **Note**: Requires that the current user be the author of the message. /// /// # Errors /// /// Returns a [`ModelError::MessageTooLong`] if the content of the message /// is over the [`the limit`], containing the number of unicode code points /// over the limit. /// /// [`ModelError::MessageTooLong`]: enum.ModelError.html#variant.MessageTooLong /// [`EditMessage`]: ../builder/struct.EditMessage.html /// [`Message`]: struct.Message.html /// [`the limit`]: ../builder/struct.EditMessage.html#method.content #[inline] pub fn edit_message<F, M>(&self, message_id: M, f: F) -> Result<Message> where F: FnOnce(EditMessage) -> EditMessage, M: Into<MessageId> { self.id.edit_message(message_id, f) } /// Attempts to find this channel's guild in the Cache. /// /// **Note**: Right now this performs a clone of the guild. This will be /// optimized in the future. #[cfg(feature = "cache")] pub fn guild(&self) -> Option<Arc<RwLock<Guild>>> { CACHE.read().guild(self.guild_id) } /// Gets all of the channel's invites. /// /// Requires the [Manage Channels] permission. /// [Manage Channels]: permissions/constant.MANAGE_CHANNELS.html #[inline] pub fn invites(&self) -> Result<Vec<RichInvite>> { self.id.invites() } /// Determines if the channel is NSFW. /// /// Refer to [`utils::is_nsfw`] for more details. /// /// Only [text channels][`ChannelType::Text`] are taken into consideration /// as being NSFW. [voice channels][`ChannelType::Voice`] are never NSFW. /// /// [`ChannelType::Text`]: enum.ChannelType.html#variant.Text /// [`ChannelType::Voice`]: enum.ChannelType.html#variant.Voice /// [`utils::is_nsfw`]: ../../utils/fn.is_nsfw.html #[cfg(feature = "utils")] #[inline] pub fn is_nsfw(&self) -> bool { self.kind == ChannelType::Text && (self.nsfw || serenity_utils::is_nsfw(&self.name)) } /// Gets a message from the channel. /// /// Requires the [Read Message History] permission. /// /// [Read Message History]: permissions/constant.READ_MESSAGE_HISTORY.html #[inline] pub fn message<M: Into<MessageId>>(&self, message_id: M) -> Result<Message> { self.id.message(message_id) } /// Gets messages from the channel. /// /// Refer to [`Channel::messages`] for more information. /// /// Requires the [Read Message History] permission. /// /// [`Channel::messages`]: enum.Channel.html#method.messages /// [Read Message History]: permissions/constant.READ_MESSAGE_HISTORY.html #[inline] pub fn messages<F>(&self, f: F) -> Result<Vec<Message>> where F: FnOnce(GetMessages) -> GetMessages { self.id.messages(f) } /// Returns the name of the guild channel. pub fn name(&self) -> &str { &self.name } /// Calculates the permissions of a member. /// /// The Id of the argument must be a [`Member`] of the [`Guild`] that the /// channel is in. /// /// # Examples /// /// Calculate the permissions of a [`User`] who posted a [`Message`] in a /// channel: /// /// ```rust,no_run /// use serenity::prelude::*; /// use serenity::model::prelude::*; /// struct Handler; /// /// use serenity::CACHE; /// /// impl EventHandler for Handler { /// fn message(&self, _: Context, msg: Message) { /// let channel = match CACHE.read().guild_channel(msg.channel_id) { /// Some(channel) => channel, /// None => return, /// }; /// /// let permissions = channel.read().permissions_for(&msg.author).unwrap(); /// /// println!("The user's permissions: {:?}", permissions); /// } /// } /// let mut client = Client::new("token", Handler).unwrap(); /// /// client.start().unwrap(); /// ``` /// /// Check if the current user has the [Attach Files] and [Send Messages] /// permissions (note: serenity will automatically check this for; this is /// for demonstrative purposes): /// /// ```rust,no_run /// use serenity::CACHE; /// use serenity::prelude::*; /// use serenity::model::prelude::*; /// use std::fs::File; /// /// struct Handler; /// /// impl EventHandler for Handler { /// fn message(&self, _: Context, msg: Message) { /// let channel = match CACHE.read().guild_channel(msg.channel_id) { /// Some(channel) => channel, /// None => return, /// }; /// /// let current_user_id = CACHE.read().user.id; /// let permissions = /// channel.read().permissions_for(current_user_id).unwrap(); /// /// if !permissions.contains(Permissions::ATTACH_FILES | Permissions::SEND_MESSAGES) { /// return; /// } /// /// let file = match File::open("./cat.png") { /// Ok(file) => file, /// Err(why) => { /// println!("Err opening file: {:?}", why); /// /// return; /// }, /// }; /// /// let _ = msg.channel_id.send_files(vec![(&file, "cat.png")], |m| /// m.content("here's a cat")); /// } /// } /// /// let mut client = Client::new("token", Handler).unwrap(); /// /// client.start().unwrap(); /// ``` /// /// # Errors /// /// Returns a [`ModelError::GuildNotFound`] if the channel's guild could /// not be found in the [`Cache`]. /// /// [`Cache`]: ../cache/struct.Cache.html /// [`ModelError::GuildNotFound`]: enum.ModelError.html#variant.GuildNotFound /// [`Guild`]: struct.Guild.html /// [`Member`]: struct.Member.html /// [`Message`]: struct.Message.html /// [`User`]: struct.User.html /// [Attach Files]: permissions/constant.ATTACH_FILES.html /// [Send Messages]: permissions/constant.SEND_MESSAGES.html #[cfg(feature = "cache")] #[inline] pub fn permissions_for<U: Into<UserId>>(&self, user_id: U) -> Result<Permissions> { self._permissions_for(user_id.into()) } fn _permissions_for(&self, user_id: UserId) -> Result<Permissions> { self.guild() .ok_or_else(|| Error::Model(ModelError::GuildNotFound)) .map(|g| g.read().permissions_in(self.id, user_id)) } /// Pins a [`Message`] to the channel. #[inline] pub fn pin<M: Into<MessageId>>(&self, message_id: M) -> Result<()> { self.id.pin(message_id) } /// Gets all channel's pins. #[inline] pub fn pins(&self) -> Result<Vec<Message>> { self.id.pins() } /// Gets the list of [`User`]s who have reacted to a [`Message`] with a /// certain [`Emoji`]. /// /// Refer to [`Channel::reaction_users`] for more information. /// /// **Note**: Requires the [Read Message History] permission. /// /// [`Channel::reaction_users`]: enum.Channel.html#method.reaction_users /// [`Emoji`]: struct.Emoji.html /// [`Message`]: struct.Message.html /// [`User`]: struct.User.html /// [Read Message History]: permissions/constant.READ_MESSAGE_HISTORY.html pub fn reaction_users<M, R, U>( &self, message_id: M, reaction_type: R, limit: Option<u8>, after: U, ) -> Result<Vec<User>> where M: Into<MessageId>, R: Into<ReactionType>, U: Into<Option<UserId>> { self.id.reaction_users(message_id, reaction_type, limit, after) } /// Sends a message with just the given message content in the channel. /// /// # Errors /// /// Returns a [`ModelError::MessageTooLong`] if the content of the message /// is over the above limit, containing the number of unicode code points /// over the limit. /// /// [`ChannelId`]: struct.ChannelId.html /// [`ModelError::MessageTooLong`]: enum.ModelError.html#variant.MessageTooLong #[inline] pub fn say(&self, content: &str) -> Result<Message> { self.id.say(content) } /// Sends (a) file(s) along with optional message contents. /// /// Refer to [`ChannelId::send_files`] for examples and more information. /// /// The [Attach Files] and [Send Messages] permissions are required. /// /// **Note**: Message contents must be under 2000 unicode code points. /// /// # Errors /// /// If the content of the message is over the above limit, then a /// [`ClientError::MessageTooLong`] will be returned, containing the number /// of unicode code points over the limit. /// /// [`ChannelId::send_files`]: struct.ChannelId.html#method.send_files /// [`ClientError::MessageTooLong`]: ../client/enum.ClientError.html#variant.MessageTooLong /// [Attach Files]: permissions/constant.ATTACH_FILES.html /// [Send Messages]: permissions/constant.SEND_MESSAGES.html #[inline] pub fn send_files<'a, F, T, It: IntoIterator<Item=T>>(&self, files: It, f: F) -> Result<Message> where F: FnOnce(CreateMessage) -> CreateMessage, T: Into<AttachmentType<'a>> { self.id.send_files(files, f) } /// Sends a message to the channel with the given content. /// /// **Note**: This will only work when a [`Message`] is received. /// /// **Note**: Requires the [Send Messages] permission. /// /// # Errors /// /// Returns a [`ModelError::MessageTooLong`] if the content of the message /// is over the above limit, containing the number of unicode code points /// over the limit. /// /// Returns a [`ModelError::InvalidPermissions`] if the current user does /// not have the required permissions. /// /// [`ModelError::InvalidPermissions`]: enum.ModelError.html#variant.InvalidPermissions /// [`ModelError::MessageTooLong`]: enum.ModelError.html#variant.MessageTooLong /// [`Message`]: struct.Message.html /// [Send Messages]: permissions/constant.SEND_MESSAGES.html pub fn send_message<F: FnOnce(CreateMessage) -> CreateMessage>(&self, f: F) -> Result<Message> { #[cfg(feature = "cache")] { let req = Permissions::SEND_MESSAGES; if !utils::user_has_perms(self.id, req)? { return Err(Error::Model(ModelError::InvalidPermissions(req))); } } self.id.send_message(f) } /// Unpins a [`Message`] in the channel given by its Id. /// /// Requires the [Manage Messages] permission. /// /// [`Message`]: struct.Message.html /// [Manage Messages]: permissions/constant.MANAGE_MESSAGES.html #[inline] pub fn unpin<M: Into<MessageId>>(&self, message_id: M) -> Result<()> { self.id.unpin(message_id) } /// Retrieves the channel's webhooks. /// /// **Note**: Requires the [Manage Webhooks] permission. /// /// [Manage Webhooks]: permissions/constant.MANAGE_WEBHOOKS.html #[inline] pub fn webhooks(&self) -> Result<Vec<Webhook>> { self.id.webhooks() } } #[cfg(feature = "model")] impl Display for GuildChannel { /// Formats the channel, creating a mention of it. fn fmt(&self, f: &mut Formatter) -> FmtResult { Display::fmt(&self.id.mention(), f) } }