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
#[cfg(feature = "http")] use crate::http::CacheHttp; use crate::{model::prelude::*}; use serde::de::{Deserialize, Error as DeError, MapAccess, Visitor}; use serde::ser::{SerializeMap, Serialize, Serializer}; use std::{ error::Error as StdError, fmt::{ Display, Formatter, Result as FmtResult, Write as FmtWrite }, str::FromStr }; use crate::internal::prelude::*; #[cfg(feature = "http")] use crate::http::Http; #[cfg(all(feature = "http", feature = "model"))] use log::warn; /// An emoji reaction to a message. #[derive(Clone, Debug, Deserialize, Serialize)] pub struct Reaction { /// The [`Channel`] of the associated [`Message`]. /// /// [`Channel`]: enum.Channel.html /// [`Message`]: struct.Message.html pub channel_id: ChannelId, /// The reactive emoji used. pub emoji: ReactionType, /// The Id of the [`Message`] that was reacted to. /// /// [`Message`]: struct.Message.html pub message_id: MessageId, /// The Id of the [`User`] that sent the reaction. /// /// [`User`]: ../user/struct.User.html pub user_id: UserId, /// The optional Id of the [`Guild`] where the reaction was sent. /// /// [`Guild`]: ../guild/struct.Guild.html pub guild_id: Option<GuildId>, #[serde(skip)] pub(crate) _nonexhaustive: (), } #[cfg(feature = "model")] impl Reaction { /// Retrieves the associated the reaction was made in. /// /// If the cache is enabled, this will search for the already-cached /// channel. If not - or the channel was not found - this will perform a /// request over the REST API for the channel. /// /// Requires the [Read Message History] permission. /// /// [Read Message History]: ../permissions/struct.Permissions.html#associatedconstant.READ_MESSAGE_HISTORY #[inline] #[cfg(feature = "http")] pub fn channel(&self, cache_http: impl CacheHttp) -> Result<Channel> { self.channel_id.to_channel(cache_http) } /// Deletes the reaction, but only if the current user is the user who made /// the reaction or has permission to. /// /// Requires the [Manage Messages] permission, _if_ the current /// user did not perform the reaction. /// /// # Errors /// /// If the `cache` is enabled, then returns a /// [`ModelError::InvalidPermissions`] if the current user does not have /// the required [permissions]. /// /// [`ModelError::InvalidPermissions`]: ../error/enum.Error.html#variant.InvalidPermissions /// [Manage Messages]: ../permissions/struct.Permissions.html#associatedconstant.MANAGE_MESSAGES /// [permissions]: ../permissions/index.html #[cfg(feature = "http")] pub fn delete(&self, cache_http: impl CacheHttp) -> Result<()> { let mut user_id = Some(self.user_id.0); #[cfg(feature = "cache")] { if let Some(cache) = cache_http.cache() { if self.user_id == cache.read().user.id { user_id = None; } if user_id.is_some() { let req = Permissions::MANAGE_MESSAGES; if !utils::user_has_perms(cache, self.channel_id, None, req).unwrap_or(true) { return Err(Error::Model(ModelError::InvalidPermissions(req))); } } } } cache_http.http().delete_reaction(self.channel_id.0, self.message_id.0, user_id, &self.emoji) } /// Retrieves the [`Message`] associated with this reaction. /// /// Requires the [Read Message History] permission. /// /// **Note**: This will send a request to the REST API. Prefer maintaining /// your own message cache or otherwise having the message available if /// possible. /// /// [Read Message History]: ../permissions/struct.Permissions.html#associatedconstant.READ_MESSAGE_HISTORY /// [`Message`]: struct.Message.html #[cfg(feature = "http")] #[inline] pub fn message(&self, http: impl AsRef<Http>) -> Result<Message> { self.channel_id.message(&http, self.message_id) } /// Retrieves the user that made the reaction. /// /// If the cache is enabled, this will search for the already-cached user. /// If not - or the user was not found - this will perform a request over /// the REST API for the user. #[inline] #[cfg(feature = "http")] pub fn user(&self, cache_http: impl CacheHttp) -> Result<User> { self.user_id.to_user(cache_http) } /// Retrieves the list of [`User`]s who have reacted to a [`Message`] with a /// certain [`Emoji`]. /// /// The default `limit` is `50` - specify otherwise to receive a different /// maximum number of users. The maximum that may be retrieve at a time is /// `100`, if a greater number is provided then it is automatically reduced. /// /// The optional `after` attribute is to retrieve the users after a certain /// user. This is useful for pagination. /// /// Requires the [Read Message History] permission. /// /// **Note**: This will send a request to the REST API. /// /// # Errors /// /// Returns a [`ModelError::InvalidPermissions`] if the current user does /// not have the required [permissions]. /// /// [`ModelError::InvalidPermissions`]: ../error/enum.Error.html#variant.InvalidPermissions /// [`Emoji`]: ../guild/struct.Emoji.html /// [`Message`]: struct.Message.html /// [`User`]: ../user/struct.User.html /// [Read Message History]: ../permissions/struct.Permissions.html#associatedconstant.READ_MESSAGE_HISTORY /// [permissions]: ../permissions/index.html #[cfg(feature = "http")] #[inline] pub fn users<R, U>(&self, http: impl AsRef<Http>, reaction_type: R, limit: Option<u8>, after: Option<U>) -> Result<Vec<User>> where R: Into<ReactionType>, U: Into<UserId> { self._users(&http, &reaction_type.into(), limit, after.map(Into::into)) } #[cfg(feature = "http")] fn _users( &self, http: impl AsRef<Http>, reaction_type: &ReactionType, limit: Option<u8>, after: Option<UserId>, ) -> Result<Vec<User>> { let mut limit = limit.unwrap_or(50); if limit > 100 { limit = 100; warn!("Rection users limit clamped to 100! (API Restriction)"); } http.as_ref().get_reaction_users( self.channel_id.0, self.message_id.0, reaction_type, limit, after.map(|u| u.0), ) } } /// The type of a [`Reaction`] sent. /// /// [`Reaction`]: struct.Reaction.html #[derive(Clone, Debug, Eq, PartialEq, Hash)] pub enum ReactionType { /// A reaction with a [`Guild`]s custom [`Emoji`], which is unique to the /// guild. /// /// [`Emoji`]: ../guild/struct.Emoji.html /// [`Guild`]: ../guild/struct.Guild.html Custom { /// Whether the emoji is animated. animated: bool, /// The Id of the custom [`Emoji`]. /// /// [`Emoji`]: ../guild/struct.Emoji.html id: EmojiId, /// The name of the custom emoji. This is primarily used for decoration /// and distinguishing the emoji client-side. name: Option<String>, }, /// A reaction with a twemoji. Unicode(String), #[doc(hidden)] __Nonexhaustive, } impl<'de> Deserialize<'de> for ReactionType { fn deserialize<D: Deserializer<'de>>(deserializer: D) -> StdResult<Self, D::Error> { #[derive(Deserialize)] #[serde(field_identifier, rename_all = "snake_case")] enum Field { Animated, Id, Name, } struct ReactionTypeVisitor; impl<'de> Visitor<'de> for ReactionTypeVisitor { type Value = ReactionType; fn expecting(&self, formatter: &mut Formatter<'_>) -> FmtResult { formatter.write_str("enum ReactionType") } fn visit_map<V: MapAccess<'de>>(self, mut map: V) -> StdResult<Self::Value, V::Error> { let mut animated = None; let mut id = None; let mut name = None; while let Some(key) = map.next_key()? { match key { Field::Animated => { if animated.is_some() { return Err(DeError::duplicate_field("animated")); } animated = Some(map.next_value()?); }, Field::Id => { if id.is_some() { return Err(DeError::duplicate_field("id")); } if let Ok(emoji_id) = map.next_value::<EmojiId>() { id = Some(emoji_id) } }, Field::Name => { if name.is_some() { return Err(DeError::duplicate_field("name")); } name = Some(map.next_value()?); }, } } let animated = animated.unwrap_or(false); let name = name.ok_or_else(|| DeError::missing_field("name"))?; Ok(if let Some(id) = id { ReactionType::Custom { animated, id, name, } } else { ReactionType::Unicode(name.unwrap()) }) } } deserializer.deserialize_map(ReactionTypeVisitor) } } impl Serialize for ReactionType { fn serialize<S>(&self, serializer: S) -> StdResult<S::Ok, S::Error> where S: Serializer { match *self { ReactionType::Custom { animated, id, ref name } => { let mut map = serializer.serialize_map(Some(3))?; map.serialize_entry("animated", &animated)?; map.serialize_entry("id", &id.0)?; map.serialize_entry("name", &name)?; map.end() }, ReactionType::Unicode(ref name) => { let mut map = serializer.serialize_map(Some(1))?; map.serialize_entry("name", &name)?; map.end() }, ReactionType::__Nonexhaustive => unreachable!(), } } } #[cfg(any(feature = "model", feature = "http"))] impl ReactionType { /// Creates a data-esque display of the type. This is not very useful for /// displaying, as the primary client can not render it, but can be useful /// for debugging. /// /// **Note**: This is mainly for use internally. There is otherwise most /// likely little use for it. pub fn as_data(&self) -> String { match *self { ReactionType::Custom { id, ref name, .. } => format!("{}:{}", name.as_ref().map_or("", |s| s.as_str()), id), ReactionType::Unicode(ref unicode) => unicode.clone(), ReactionType::__Nonexhaustive => unreachable!(), } } } #[cfg(feature = "model")] impl From<char> for ReactionType { /// Creates a `ReactionType` from a `char`. /// /// # Examples /// /// Reacting to a message with an apple: /// /// ```rust,no_run /// # #[cfg(feature = "client")] /// # use serenity::client::Context; /// # #[cfg(feature = "framework")] /// # use serenity::framework::standard::{CommandResult, macros::command}; /// # use serenity::model::id::ChannelId; /// # /// # #[cfg(all(feature = "client", feature = "framework", feature = "http"))] /// # #[command] /// # fn example(ctx: &mut Context) -> CommandResult { /// # let message = ChannelId(0).message(&ctx.http, 0)?; /// # /// message.react(ctx, '🍎')?; /// # Ok(()) /// # } /// # /// # fn main() {} /// ``` fn from(ch: char) -> ReactionType { ReactionType::Unicode(ch.to_string()) } } impl From<Emoji> for ReactionType { fn from(emoji: Emoji) -> ReactionType { ReactionType::Custom { animated: emoji.animated, id: emoji.id, name: Some(emoji.name), } } } impl From<EmojiId> for ReactionType { fn from(emoji_id: EmojiId) -> ReactionType { ReactionType::Custom { animated: false, id: emoji_id, name: None } } } impl From<EmojiIdentifier> for ReactionType { fn from(emoji_id: EmojiIdentifier) -> ReactionType { ReactionType::Custom { animated: false, id: emoji_id.id, name: Some(emoji_id.name) } } } impl From<String> for ReactionType { fn from(unicode: String) -> ReactionType { ReactionType::Unicode(unicode) } } impl<'a> From<&'a str> for ReactionType { /// Creates a `ReactionType` from a string slice. /// /// # Examples /// /// Creating a `ReactionType` from a `🍎`, modeling a similar API as the /// rest of the library: /// /// ```rust /// use serenity::model::channel::ReactionType; /// /// fn foo<R: Into<ReactionType>>(bar: R) { /// println!("{:?}", bar.into()); /// } /// /// foo("🍎"); /// ``` fn from(unicode: &str) -> ReactionType { ReactionType::Unicode(unicode.to_string()) } } // TODO: Change this to `!` once it becomes stable. #[derive(Debug)] pub enum NeverFails {} impl Display for NeverFails { fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult { write!(f, "never fails") } } impl StdError for NeverFails { fn description(&self) -> &str { "never fails" } } impl FromStr for ReactionType { type Err = NeverFails; fn from_str(s: &str) -> ::std::result::Result<Self, Self::Err> { Ok(ReactionType::from(s)) } } impl Display for ReactionType { /// Formats the reaction type, displaying the associated emoji in a /// way that clients can understand. /// /// If the type is a [custom][`ReactionType::Custom`] emoji, then refer to /// the documentation for [emoji's formatter][`Emoji::fmt`] on how this is /// displayed. Otherwise, if the type is a /// [unicode][`ReactionType::Unicode`], then the inner unicode is displayed. /// /// [`Emoji::fmt`]: ../guild/struct.Emoji.html#method.fmt /// [`ReactionType::Custom`]: enum.ReactionType.html#variant.Custom /// [`ReactionType::Unicode`]: enum.ReactionType.html#variant.Unicode fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult { match *self { ReactionType::Custom { id, ref name, .. } => { f.write_char('<')?; f.write_char(':')?; f.write_str(name.as_ref().map_or("", |s| s.as_str()))?; f.write_char(':')?; Display::fmt(&id, f)?; f.write_char('>') }, ReactionType::Unicode(ref unicode) => f.write_str(unicode), ReactionType::__Nonexhaustive => unreachable!(), } } }