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
//! Reaction-based menu functionality.
//!
//! It provides three default menu control functions that:
//! - move to previous page
//! - move to next page
//! - close menu
//!
//! These functions are exposed publicly to allow customisation.
//! Custom control functions can also be used with a menu.
//! For more information, see [`Menu`].
//!
//! **Note:** This functionality has been ported from [`Red-DiscordBot`]'s
//! [`menu`] function.
//!
//! [`Red-DiscordBot`]: https://github.com/Cog-Creators/Red-DiscordBot/
//! [`menu`]: https://github.com/Cog-Creators/Red-DiscordBot/blob/46eb9ce7a0bcded991af02665fec39fcb542c76d/redbot/core/utils/menus.py#L17
use std::future::Future;
use std::pin::Pin;
use std::sync::Arc;
use std::time::Duration;
use serenity::builder::CreateMessage;
use serenity::collector::ReactionAction;
use serenity::futures::StreamExt;
use serenity::model::prelude::{Message, Reaction, ReactionType};
use serenity::prelude::Context;
use crate::misc::add_reactions;
use crate::Error;
/// Result variant for menu methods.
pub type MenuResult = Result<(), Error>;
/// A fully functioning reaction-based menu.
///
/// A reaction menu is a paginated message where the user can use reactions to
/// change the page/content of the message.
///
/// ## Example
///
/// ```
/// # use serenity::{
/// # builder::CreateMessage,
/// # model::prelude::Message,
/// # prelude::Context,
/// # };
/// use serenity_utils::menu::{Menu, MenuOptions};
/// use serenity_utils::Error;
///
/// async fn use_menu(ctx: &Context, msg: &Message) -> Result<(), Error> {
/// let mut message_one = CreateMessage::default();
/// message_one.content("Page number one!").embed(|e| {
/// e.description("The first page!");
///
/// e
/// });
///
/// let mut message_two = CreateMessage::default();
/// message_two.content("Page number two!").embed(|e| {
/// e.description("The second page!");
///
/// e
/// });
///
/// let pages = [message_one, message_two];
///
/// // Creates a new menu.
/// let menu = Menu::new(ctx, msg, &pages, MenuOptions::default());
///
/// // Runs the menu and returns optional `Message` used to display the menu.
/// let opt_message = menu.run().await?;
///
/// Ok(())
/// }
/// ```
///
/// A reaction menu can be configured by changing its options. See
/// [`MenuOptions`] for more details.
pub struct Menu<'a> {
/// The Discord/serenity context.
pub ctx: &'a Context,
/// The invocation message.
pub msg: &'a Message,
/// The pages of the menu.
pub pages: &'a [CreateMessage<'a>],
/// The menu options.
pub options: MenuOptions,
}
impl<'a> Menu<'a> {
/// Creates a new [`Menu`] object.
pub fn new(
ctx: &'a Context,
msg: &'a Message,
pages: &'a [CreateMessage<'a>],
options: MenuOptions,
) -> Self {
Self {
ctx,
msg,
pages,
options,
}
}
/// Runs the reaction menu.
///
/// It returns the message used to display the reaction menu after running.
///
/// ## Errors
///
/// Returns [`Error::SerenityError`] if
/// - current user/bot doesn't have the permissions to add reactions
/// - `msg` is specified in [`MenuOptions`] but the current user/bot isn't
/// the author of the message
/// - the message content lengths are over Discord's limit
/// - current user/bot doesn't have the permissions to send an message/embed
///
/// Returns [`Error::InvalidChoice`] if the user selects an invalid choice, ie, reacts to an
/// emoji that does not correspond to any [`control`].
///
/// Returns [`Error::Other`] if
/// - `pages` is empty
/// - the page number specified in [`MenuOptions`] is out of bounds
///
/// [`Error::SerenityError`]: crate::error::Error::SerenityError
/// [`Error::InvalidChoice`]: crate::error::Error::InvalidChoice
/// [`Error::Other`]: crate::error::Error::Other
/// [`control`]: Control
pub async fn run(mut self) -> Result<Option<Message>, Error> {
loop {
match self.work().await {
Ok((index, reaction)) => match self.options.controls.get(index) {
Some(control) => {
Arc::clone(&control.function)(&mut self, reaction).await;
},
None => {
// We don't have to return an error for this as bot won't
// have permission to remove reactions in all cases. This
// is simply an inconvenience for the user.
let _ = self.clean_reactions().await;
break;
},
},
Err(e) => {
let _ = self.clean_reactions().await;
// Timeout error isn't a valid error for the reaction menu.
if let Error::TimeoutError = e {
break;
} else {
return Err(e);
}
},
}
}
Ok(self.options.message)
}
async fn work(&mut self) -> Result<(usize, Reaction), Error> {
if self.pages.is_empty() {
return Err(Error::from("`pages` is empty."));
}
if self.options.page > self.pages.len() - 1 {
return Err(Error::from("`page` is out of bounds."));
}
let page = &self.pages[self.options.page];
match &mut self.options.message {
Some(m) => {
m.edit(&self.ctx.http, |m| {
m.0.clone_from(&page.0);
m
})
.await?;
},
None => {
let msg = self
.msg
.channel_id
.send_message(&self.ctx.http, |m| {
m.clone_from(page);
m
})
.await?;
self.add_reactions(&msg).await?;
self.options.message = Some(msg);
},
}
let message = self.options.message.as_ref().unwrap();
let mut reaction_collector = message
.await_reactions(&self.ctx)
.timeout(Duration::from_secs_f64(self.options.timeout))
.author_id(self.msg.author.id)
.build();
let (choice, reaction) = {
let mut choice = None;
let mut reaction = None;
let mut found_one = false;
while let Some(item) = reaction_collector.next().await {
if let ReactionAction::Added(r) = item.as_ref() {
if !found_one {
found_one = true;
}
let r = r.as_ref().clone();
if let Some(i) = self.process_reaction(&r) {
choice = Some(i);
reaction = Some(r);
break;
}
}
}
if !found_one {
return Err(Error::TimeoutError);
}
(choice, reaction)
};
match choice {
Some(c) => Ok((c, reaction.unwrap())),
None => Err(Error::InvalidChoice),
}
}
async fn add_reactions(&self, msg: &Message) -> MenuResult {
if self.options.non_blocking {
let emojis = self.options.controls.iter().map(|c| c.emoji.clone()).collect::<Vec<_>>();
add_reactions(self.ctx, msg, emojis).await?;
} else {
// Using `add_reactions_blocking` requires extra iteration so we do
// it directly here.
for control in &self.options.controls {
self.ctx.http.create_reaction(msg.channel_id.0, msg.id.0, &control.emoji).await?;
}
}
Ok(())
}
fn process_reaction(&self, reaction: &Reaction) -> Option<usize> {
let emoji = &reaction.emoji;
for (idx, control) in self.options.controls.iter().enumerate() {
if &control.emoji == emoji {
return Some(idx);
}
}
None
}
async fn clean_reactions(&self) -> MenuResult {
if let Some(msg) = &self.options.message {
msg.delete_reactions(&self.ctx.http).await?;
}
Ok(())
}
}
/// Options to tweak a menu.
///
/// See [`Control`] for details to implement your own controls.
pub struct MenuOptions {
/// The 0-indexed page number to start at.
///
/// Defaults to `0`.
pub page: usize,
/// Number of seconds to keep the menu active.
///
/// Defaults to `30.0`.
pub timeout: f64,
/// Optional message to edit.
///
/// If supplied, this message is edited instead of the bot creating a new
/// message to display the menu. This message must be sent by the bot.
///
/// Defaults to `None`.
pub message: Option<Message>,
/// The controls for the menu.
///
/// Defaults to the following:
/// - ◀️ -> [`prev_page`]
/// - ❌ -> [`close_menu`]
/// - ▶️ -> [`next_page`]
///
/// [`prev_page`]: prev_page()
/// [`close_menu`]: close_menu()
/// [`next_page`]: next_page()
pub controls: Vec<Control>,
/// Whether to add emojis in a separate task non-blocking task or not.
///
/// If set to `true`, addition of emojis doesn't stop the menu from working.
/// That is, if a reaction is added to the menu message and the user reacts
/// to it before other reactions are added, the bot will consider that
/// reaction and act appropriately.
///
/// If set to `false`, no user reactions will be considered until the bot
/// adds all reactions.
///
/// Non-blocking addition is very slightly less efficient than blocking.
///
/// Defaults to `true`.
pub non_blocking: bool,
}
impl MenuOptions {
/// Creates a new [`MenuOptions`] object.
pub fn new(
page: usize,
timeout: f64,
message: Option<Message>,
controls: Vec<Control>,
non_blocking: bool,
) -> Self {
Self {
page,
timeout,
message,
controls,
non_blocking,
}
}
}
impl Default for MenuOptions {
fn default() -> Self {
let controls = vec![
Control::new('◀'.into(), Arc::new(|m, r| Box::pin(prev_page(m, r)))),
Control::new('❌'.into(), Arc::new(|m, r| Box::pin(close_menu(m, r)))),
Control::new('▶'.into(), Arc::new(|m, r| Box::pin(next_page(m, r)))),
];
Self {
page: 0,
timeout: 30.0,
message: None,
controls,
non_blocking: true,
}
}
}
/// A struct representing a control for reaction menus.
///
/// Each control must have a unique emoji and a function to control it's
/// behaviour. See [`ControlFunction`]'s documentation to learn more about how
/// they are implemented.
pub struct Control {
/// The emoji for the control.
pub emoji: ReactionType,
/// The [`ControlFunction`] to control the behaviour.
pub function: ControlFunction,
}
impl Control {
/// Creates a new [`Control`] object.
pub fn new(emoji: ReactionType, function: ControlFunction) -> Self {
Self {
emoji,
function,
}
}
}
/// A function used to control the behaviour of a reaction menu's reaction.
///
/// An example implementation is provided here:
///
/// ```
/// use serenity::model::channel::Reaction;
/// use serenity_utils::menu::Menu;
///
/// async fn first_page<'a>(menu: &mut Menu<'a>, reaction: Reaction) {
/// // Remove the reaction used to change the menu.
/// let _ = &reaction.delete(&menu.ctx.http).await;
///
/// // Set page number to `0`.
/// menu.options.page = 0;
/// }
/// ```
///
/// Please note that the above function is not a [`ControlFunction`]. To make it
/// a control function, you need to pin it and then create an `Arc` of it.
///
/// ```
/// # use serenity::model::channel::Reaction;
/// # use serenity_utils::menu::Menu;
/// #
/// # async fn first_page<'a>(menu: &mut Menu<'a>, reaction: Reaction) {}
/// #
/// use std::sync::Arc;
///
/// let control_function = Arc::new(|m, r| Box::pin(first_page(m, r)));
/// ```
///
/// Now, `control_function` can be used to control a menu.
pub type ControlFunction = Arc<
dyn for<'b> Fn(&'b mut Menu<'_>, Reaction) -> Pin<Box<dyn Future<Output = ()> + 'b + Send>>
+ Sync
+ Send,
>;
/// Moves a reaction menu forward.
///
/// **Note:** This function is not a [`ControlFunction`]. To turn it into a
/// control function, you must pin it and then create an `Arc` of it.
///
/// ```
/// # use serenity_utils::menu::next_page;
/// # use std::sync::Arc;
/// #
/// let next_page_cfn = Arc::new(|m, r| Box::pin(next_page(m, r)));
/// ```
///
/// `next_page_cfn` is a [`ControlFunction`] and can be used to control a menu.
pub async fn next_page(menu: &mut Menu<'_>, reaction: Reaction) {
let _ = reaction.delete(&menu.ctx.http).await;
if menu.options.page == menu.pages.len() - 1 {
menu.options.page = 0;
} else {
menu.options.page += 1;
}
}
/// Moves a reaction menu backward.
///
/// **Note:** This function is not a [`ControlFunction`]. To turn it into a
/// control function, you must pin it and then create an `Arc` of it.
///
/// ```
/// # use serenity_utils::menu::prev_page;
/// # use std::sync::Arc;
/// #
/// let prev_page_cfn = Arc::new(|m, r| Box::pin(prev_page(m, r)));
/// ```
///
/// `prev_page_cfn` is a [`ControlFunction`] and can be used to control a menu.
pub async fn prev_page(menu: &mut Menu<'_>, reaction: Reaction) {
let _ = reaction.delete(&menu.ctx.http).await;
if menu.options.page == 0 {
menu.options.page = menu.pages.len() - 1;
} else {
menu.options.page -= 1;
}
}
/// Closes a reaction menu by deleting the menu's message.
///
/// **Note:** This function is not a [`ControlFunction`]. To turn it into a
/// control function, you must pin it and then create an `Arc` of it.
///
/// ```
/// # use serenity_utils::menu::close_menu;
/// # use std::sync::Arc;
/// #
/// let close_menu_cfn = Arc::new(|m, r| Box::pin(close_menu(m, r)));
/// ```
///
/// `close_menu_cfn` is a [`ControlFunction`] and can be used to control a menu.
pub async fn close_menu(menu: &mut Menu<'_>, _reaction: Reaction) {
let _ = menu.options.message.as_ref().unwrap().delete(&menu.ctx.http).await;
}