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
use std::collections::HashSet; use std::default::Default; use super::command::PrefixCheck; use client::Context; use http; use model::{GuildId, Message, UserId}; /// The configuration to use for a [`Framework`] associated with a [`Client`] /// instance. /// /// This allows setting configurations like the depth to search for commands, /// whether to treat mentions like a command prefix, etc. /// /// # Examples /// /// Responding to mentions and setting a command prefix of `"~"`: /// /// ```rust,no_run /// # use serenity::prelude::EventHandler; /// struct Handler; /// /// impl EventHandler for Handler {} /// use serenity::Client; /// use std::env; /// use serenity::framework::StandardFramework; /// /// let mut client = Client::new(&env::var("DISCORD_BOT_TOKEN").unwrap(), Handler); /// /// client.with_framework(StandardFramework::new() /// .configure(|c| c.on_mention(true).prefix("~"))); /// ``` /// /// [`Client`]: ../../client/struct.Client.html /// [`Framework`]: struct.Framework.html pub struct Configuration { #[doc(hidden)] pub allow_dm: bool, #[doc(hidden)] pub allow_whitespace: bool, #[doc(hidden)] pub blocked_guilds: HashSet<GuildId>, #[doc(hidden)] pub blocked_users: HashSet<UserId>, #[doc(hidden)] pub depth: usize, #[doc(hidden)] pub disabled_commands: HashSet<String>, #[doc(hidden)] pub dynamic_prefix: Option<Box<PrefixCheck>>, #[doc(hidden)] pub ignore_bots: bool, #[doc(hidden)] pub ignore_webhooks: bool, #[doc(hidden)] pub on_mention: Option<Vec<String>>, #[doc(hidden)] pub owners: HashSet<UserId>, #[doc(hidden)] pub prefixes: Vec<String>, #[doc(hidden)] pub delimiters: Vec<String>, #[doc(hidden)] pub case_insensitive: bool, } impl Configuration { /// If set to false, bot will ignore any private messages. pub fn allow_dm(mut self, allow_dm: bool) -> Self { self.allow_dm = allow_dm; self } /// Whether to allow whitespace being optional between a mention/prefix and /// a command. /// /// **Note**: Defaults to `false`. /// /// # Examples /// /// Setting this to `false` will _only_ allow this scenario to occur: /// /// ```ignore /// <@245571012924538880> about /// !about /// /// // bot processes and executes the "about" command if it exists /// ``` /// /// while setting this to `true` will _also_ allow this scenario to occur: /// /// ```ignore /// <@245571012924538880>about /// ! about /// /// // bot processes and executes the "about" command if it exists /// ``` pub fn allow_whitespace(mut self, allow_whitespace: bool) -> Self { self.allow_whitespace = allow_whitespace; self } /// HashSet of guild Ids where commands will be ignored. /// /// # Examples /// /// Create a HashSet in-place: /// /// ```rust /// # use serenity::prelude::*; /// # struct Handler; /// # /// # impl EventHandler for Handler {} /// # let mut client = Client::new("token", Handler); /// use serenity::model::GuildId; /// use serenity::framework::StandardFramework; /// /// client.with_framework(StandardFramework::new().configure(|c| c /// .blocked_guilds(vec![GuildId(7), GuildId(77)].into_iter().collect()))); /// ``` pub fn blocked_guilds(mut self, guilds: HashSet<GuildId>) -> Self { self.blocked_guilds = guilds; self } /// HashSet of user Ids whose commands will be ignored. /// Guilds owned by user Ids will also be ignored. /// /// # Examples /// /// Create a HashSet in-place: /// /// ```rust /// # use serenity::prelude::*; /// # struct Handler; /// # /// # impl EventHandler for Handler {} /// # let mut client = Client::new("token", Handler); /// use serenity::model::UserId; /// use serenity::framework::StandardFramework; /// /// client.with_framework(StandardFramework::new().configure(|c| c /// .blocked_users(vec![UserId(7), UserId(77)].into_iter().collect()))); /// ``` pub fn blocked_users(mut self, users: HashSet<UserId>) -> Self { self.blocked_users = users; self } /// The default depth of the message to check for commands. Defaults to 5. /// This determines how "far" into a message to check for a valid command. /// /// # Examples /// /// If you set a depth of `1`, and make a command of `"music play"`, but /// not a `"music"` command, then the former command will never be /// triggered, as its "depth" is `2`. pub fn depth(mut self, depth: u8) -> Self { self.depth = depth as usize; self } /// HashSet of command names that won't be run. /// /// # Examples /// /// Ignore a set of commands, assuming they exist: /// /// ```rust /// # use serenity::prelude::*; /// # struct Handler; /// # /// # impl EventHandler for Handler {} /// # let mut client = Client::new("token", Handler); /// use serenity::framework::StandardFramework; /// /// let disabled = vec!["ping"].into_iter().map(|x| x.to_owned()).collect(); /// /// client.with_framework(StandardFramework::new() /// .command("ping", |c| c.exec_str("pong!")) /// .configure(|c| c.disabled_commands(disabled))); /// ``` pub fn disabled_commands(mut self, commands: HashSet<String>) -> Self { self.disabled_commands = commands; self } /// Sets the prefix to respond to dynamically based on conditions. /// /// Return `None` to not have a special prefix for the dispatch, and to /// instead use the inherited prefix. /// /// # Examples /// /// If the Id of the channel is divisible by 5, return a prefix of `"!"`, /// otherwise return a prefix of `"~"`. /// /// ```rust,no_run /// # use serenity::prelude::*; /// # struct Handler; /// # /// # impl EventHandler for Handler {} /// # let mut client = Client::new("token", Handler); /// use serenity::framework::StandardFramework; /// /// client.with_framework(StandardFramework::new() /// .command("ping", |c| c.exec_str("Pong!")) /// .configure(|c| c.dynamic_prefix(|_, msg| { /// Some(if msg.channel_id.0 % 5 == 0 { /// "!" /// } else { /// "~" /// }.to_owned()) /// }))); /// ``` pub fn dynamic_prefix<F>(mut self, dynamic_prefix: F) -> Self where F: Fn(&mut Context, &Message) -> Option<String> + Send + Sync + 'static { self.dynamic_prefix = Some(Box::new(dynamic_prefix)); self } /// Whether the bot should respond to other bots. /// /// For example, if this is set to false, then the bot will respond to any /// other bots including itself. pub fn ignore_bots(mut self, ignore_bots: bool) -> Self { self.ignore_bots = ignore_bots; self } /// If set to true, bot will ignore all commands called by webhooks. /// True by default. pub fn ignore_webhooks(mut self, ignore_webhooks: bool) -> Self { self.ignore_webhooks = ignore_webhooks; self } /// Whether or not to respond to commands initiated with a mention. Note /// that this can be used in conjunction with [`prefix`]. /// /// By default this is set to `false`. /// /// # Examples /// /// Setting this to `true` will allow the following types of mentions to be /// responded to: /// /// ```ignore /// <@245571012924538880> about /// <@!245571012924538880> about /// ``` /// /// The former is a direct mention, while the latter is a nickname mention, /// which aids mobile devices in determining whether to display a user's /// nickname. It has no real meaning for your bot, and the library /// encourages you to ignore differentiating between the two. /// /// [`prefix`]: #method.prefix pub fn on_mention(mut self, on_mention: bool) -> Self { if !on_mention { return self; } if let Ok(current_user) = http::get_current_user() { self.on_mention = Some(vec![ format!("<@{}>", current_user.id), // Regular mention format!("<@!{}>", current_user.id), // Nickname mention ]); } self } /// A `HashSet` of user Ids checks won't apply to. /// /// # Examples /// /// Create a HashSet in-place: /// /// ```rust /// # use serenity::prelude::*; /// # struct Handler; /// # /// # impl EventHandler for Handler {} /// # let mut client = Client::new("token", Handler); /// use serenity::model::UserId; /// use serenity::framework::StandardFramework; /// /// client.with_framework(StandardFramework::new().configure(|c| c /// .owners(vec![UserId(7), UserId(77)].into_iter().collect()))); /// ``` /// /// Create a HashSet beforehand: /// /// ```rust /// # use serenity::prelude::*; /// # struct Handler; /// # /// # impl EventHandler for Handler {} /// # let mut client = Client::new("token", Handler); /// use serenity::model::UserId; /// use std::collections::HashSet; /// use serenity::framework::StandardFramework; /// /// let mut set = HashSet::new(); /// set.insert(UserId(7)); /// set.insert(UserId(77)); /// /// client.with_framework(StandardFramework::new().configure(|c| c.owners(set))); /// ``` pub fn owners(mut self, user_ids: HashSet<UserId>) -> Self { self.owners = user_ids; self } /// Sets the prefix to respond to. A prefix can be a string slice of any /// non-zero length. /// /// # Examples /// /// Assign a basic prefix: /// /// ```rust /// # use serenity::prelude::*; /// # struct Handler; /// # /// # impl EventHandler for Handler {} /// # let mut client = Client::new("token", Handler); /// # /// use serenity::framework::StandardFramework; /// /// client.with_framework(StandardFramework::new().configure(|c| c /// .prefix("!"))); /// ``` pub fn prefix(mut self, prefix: &str) -> Self { self.prefixes = vec![prefix.to_owned()]; self } /// Sets the prefixes to respond to. Each can be a string slice of any /// non-zero length. /// /// # Examples /// /// Assign a set of prefixes the bot can respond to: /// /// ```rust /// # use serenity::prelude::*; /// # struct Handler; /// # /// # impl EventHandler for Handler {} /// # let mut client = Client::new("token", Handler); /// # /// use serenity::framework::StandardFramework; /// /// client.with_framework(StandardFramework::new().configure(|c| c /// .prefixes(vec!["!", ">", "+"]))); /// ``` pub fn prefixes(mut self, prefixes: Vec<&str>) -> Self { self.prefixes = prefixes.iter().map(|x| x.to_string()).collect(); self } /// Sets a delimiter to be used when splitting the content after a command. /// /// # Examples /// /// Have the args be seperated by a comma and a space: /// /// ```rust /// # use serenity::prelude::*; /// # struct Handler; /// # /// # impl EventHandler for Handler {} /// # let mut client = Client::new("token", Handler); /// # /// use serenity::framework::StandardFramework; /// /// client.with_framework(StandardFramework::new().configure(|c| c /// .delimiter(", "))); /// ``` pub fn delimiter(mut self, delimiter: &str) -> Self { self.delimiters.push(delimiter.to_string()); self } /// Sets multiple delimiters to be used when splitting the content after a command. /// Additionally cleans the default delimiter from the vector. /// /// # Examples /// /// Have the args be seperated by a comma and a space; and a regular space: /// /// ```rust /// # use serenity::prelude::*; /// # struct Handler; /// # /// # impl EventHandler for Handler {} /// # let mut client = Client::new("token", Handler); /// # /// use serenity::framework::StandardFramework; /// /// client.with_framework(StandardFramework::new().configure(|c| c /// .delimiters(vec![", ", " "]))); /// ``` pub fn delimiters(mut self, delimiters: Vec<&str>) -> Self { self.delimiters.clear(); self.delimiters .extend(delimiters.into_iter().map(|s| s.to_string())); self } /// Whether the framework shouldn't care about the user's input if it's: `~command`, /// `~Command`, `~COMMAND`. /// Setting this to `true` will result in *all* command names to be case insensitive. pub fn case_insensitivity(mut self, cs: bool) -> Self { self.case_insensitive = cs; self } } impl Default for Configuration { /// Builds a default framework configuration, setting the following: /// /// - **allow_whitespace** to `false` /// - **depth** to `5` /// - **on_mention** to `false` (basically) /// - **prefix** to `None` /// - **delimiters** to vec![" "] /// - **case_insensitive** to `false` fn default() -> Configuration { Configuration { depth: 5, on_mention: None, dynamic_prefix: None, allow_whitespace: false, prefixes: vec![], ignore_bots: true, owners: HashSet::default(), blocked_users: HashSet::default(), blocked_guilds: HashSet::default(), disabled_commands: HashSet::default(), allow_dm: true, ignore_webhooks: true, case_insensitive: false, delimiters: vec![" ".to_string()], } } }