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
use crate::{
client::Client,
error::Error as HttpError,
request::{self, AuditLogReason, Request, TryIntoRequest},
response::ResponseFuture,
routing::Route,
};
use serde::Serialize;
use twilight_model::{
guild::auto_moderation::{
AutoModerationActionType, AutoModerationEventType, AutoModerationKeywordPresetType,
AutoModerationRule, AutoModerationTriggerType,
},
id::{
marker::{ChannelMarker, GuildMarker, RoleMarker},
Id,
},
};
use twilight_validate::request::{
audit_reason as validate_audit_reason,
auto_moderation_block_action_custom_message_limit as validate_auto_moderation_block_action_custom_message_limit,
auto_moderation_metadata_mention_total_limit as validate_auto_moderation_metadata_mention_total_limit,
ValidationError,
};
#[derive(Serialize)]
struct CreateAutoModerationRuleFieldsAction {
/// Type of action.
#[serde(rename = "type")]
pub kind: AutoModerationActionType,
/// Additional metadata needed during execution for this specific action
/// type.
pub metadata: CreateAutoModerationRuleFieldsActionMetadata,
}
#[derive(Default, Serialize)]
struct CreateAutoModerationRuleFieldsActionMetadata {
/// Channel to which user content should be logged.
pub channel_id: Option<Id<ChannelMarker>>,
/// Additional explanation that will be shown to members whenever their message is blocked.
///
/// Maximum value length is 150 characters.
pub custom_message: Option<String>,
/// Timeout duration in seconds.
///
/// Maximum value is 2419200 seconds, or 4 weeks.
pub duration_seconds: Option<u32>,
}
#[derive(Serialize)]
struct CreateAutoModerationRuleFieldsTriggerMetadata<'a> {
#[serde(skip_serializing_if = "Option::is_none")]
allow_list: Option<&'a [&'a str]>,
#[serde(skip_serializing_if = "Option::is_none")]
keyword_filter: Option<&'a [&'a str]>,
#[serde(skip_serializing_if = "Option::is_none")]
presets: Option<&'a [AutoModerationKeywordPresetType]>,
#[serde(skip_serializing_if = "Option::is_none")]
mention_total_limit: Option<u8>,
}
#[derive(Serialize)]
struct CreateAutoModerationRuleFields<'a> {
actions: Option<Vec<CreateAutoModerationRuleFieldsAction>>,
enabled: Option<bool>,
event_type: AutoModerationEventType,
exempt_channels: Option<&'a [Id<ChannelMarker>]>,
exempt_roles: Option<&'a [Id<RoleMarker>]>,
name: &'a str,
trigger_metadata: Option<CreateAutoModerationRuleFieldsTriggerMetadata<'a>>,
trigger_type: Option<AutoModerationTriggerType>,
}
/// Create an auto moderation rule within a guild.
///
/// Requires the [`MANAGE_GUILD`] permission.
///
/// # Examples
///
/// Create a rule that deletes messages that contain the word "darn":
///
/// ```no_run
/// # #[tokio::main] async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// use twilight_http::Client;
/// use twilight_model::{guild::auto_moderation::AutoModerationEventType, id::Id};
///
/// let client = Client::new("my token".to_owned());
///
/// let guild_id = Id::new(1);
/// client
/// .create_auto_moderation_rule(guild_id, "no darns", AutoModerationEventType::MessageSend)
/// .action_block_message()
/// .enabled(true)
/// .with_keyword(&["darn"])
/// .await?;
/// # Ok(()) }
/// ```
///
/// [`MANAGE_GUILD`]: twilight_model::guild::Permissions::MANAGE_GUILD
#[must_use = "requests must be configured and executed"]
pub struct CreateAutoModerationRule<'a> {
fields: CreateAutoModerationRuleFields<'a>,
guild_id: Id<GuildMarker>,
http: &'a Client,
reason: Option<&'a str>,
}
impl<'a> CreateAutoModerationRule<'a> {
pub(crate) const fn new(
http: &'a Client,
guild_id: Id<GuildMarker>,
name: &'a str,
event_type: AutoModerationEventType,
) -> Self {
Self {
fields: CreateAutoModerationRuleFields {
actions: None,
enabled: None,
event_type,
exempt_channels: None,
exempt_roles: None,
name,
trigger_metadata: None,
trigger_type: None,
},
guild_id,
http,
reason: None,
}
}
/// Append an action of type [`BlockMessage`].
///
/// [`BlockMessage`]: AutoModerationActionType::BlockMessage
pub fn action_block_message(mut self) -> Self {
self.fields.actions.get_or_insert_with(Vec::new).push(
CreateAutoModerationRuleFieldsAction {
kind: AutoModerationActionType::BlockMessage,
metadata: CreateAutoModerationRuleFieldsActionMetadata::default(),
},
);
self
}
/// Append an action of type [`BlockMessage`] with an explanation for blocking messages.
///
/// # Errors
///
/// Returns a [`AutoModerationBlockActionCustomMessageLimit`] if the custom message length
/// is invalid.
///
/// [`AutoModerationBlockActionCustomMessageLimit`]: twilight_validate::request::ValidationErrorType::AutoModerationBlockActionCustomMessageLimit
/// [`BlockMessage`]: AutoModerationActionType::BlockMessage
pub fn action_block_message_with_explanation(
mut self,
custom_message: &'a str,
) -> Result<Self, ValidationError> {
validate_auto_moderation_block_action_custom_message_limit(custom_message)?;
self.fields.actions.get_or_insert_with(Vec::new).push(
CreateAutoModerationRuleFieldsAction {
kind: AutoModerationActionType::BlockMessage,
metadata: CreateAutoModerationRuleFieldsActionMetadata {
custom_message: Some(String::from(custom_message)),
..Default::default()
},
},
);
Ok(self)
}
/// Append an action of type [`SendAlertMessage`].
///
/// [`SendAlertMessage`]: AutoModerationActionType::SendAlertMessage
pub fn action_send_alert_message(mut self, channel_id: Id<ChannelMarker>) -> Self {
self.fields.actions.get_or_insert_with(Vec::new).push(
CreateAutoModerationRuleFieldsAction {
kind: AutoModerationActionType::SendAlertMessage,
metadata: CreateAutoModerationRuleFieldsActionMetadata {
channel_id: Some(channel_id),
..Default::default()
},
},
);
self
}
/// Append an action of type [`Timeout`].
///
/// [`Timeout`]: AutoModerationActionType::Timeout
pub fn action_timeout(mut self, duration_seconds: u32) -> Self {
self.fields.actions.get_or_insert_with(Vec::new).push(
CreateAutoModerationRuleFieldsAction {
kind: AutoModerationActionType::Timeout,
metadata: CreateAutoModerationRuleFieldsActionMetadata {
duration_seconds: Some(duration_seconds),
..Default::default()
},
},
);
self
}
/// Set whether the rule is enabled.
pub const fn enabled(mut self, enabled: bool) -> Self {
self.fields.enabled = Some(enabled);
self
}
/// Set the channels where the rule does not apply.
pub const fn exempt_channels(mut self, exempt_channels: &'a [Id<ChannelMarker>]) -> Self {
self.fields.exempt_channels = Some(exempt_channels);
self
}
/// Set the roles to which the rule does not apply.
pub const fn exempt_roles(mut self, exempt_roles: &'a [Id<RoleMarker>]) -> Self {
self.fields.exempt_roles = Some(exempt_roles);
self
}
/// Create the request with the trigger type [`Keyword`], then execute it.
///
/// Rules of this type require the `keyword_filter` field specified, and
/// this method ensures this. See [Discord Docs/Keyword Matching Strategies]
/// and [Discord Docs/Trigger Metadata].
///
/// [`Keyword`]: AutoModerationTriggerType::Keyword
/// [Discord Docs/Keyword Matching Strategies]: https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-keyword-matching-strategies
/// [Discord Docs/Trigger Metadata]: https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-trigger-metadata
pub fn with_keyword(
mut self,
keyword_filter: &'a [&'a str],
) -> ResponseFuture<AutoModerationRule> {
self.fields.trigger_metadata = Some(CreateAutoModerationRuleFieldsTriggerMetadata {
allow_list: None,
keyword_filter: Some(keyword_filter),
presets: None,
mention_total_limit: None,
});
self.fields.trigger_type = Some(AutoModerationTriggerType::Keyword);
self.exec()
}
/// Create the request with the trigger type [`Spam`], then execute it.
///
/// [`Spam`]: AutoModerationTriggerType::Spam
pub fn with_spam(mut self) -> ResponseFuture<AutoModerationRule> {
self.fields.trigger_type = Some(AutoModerationTriggerType::Spam);
self.exec()
}
/// Create the request with the trigger type [`KeywordPreset`], then execute
/// it.
///
/// Rules of this type require the `presets` and `allow_list` fields
/// specified, and this method ensures this. See [Discord Docs/Trigger
/// Metadata].
///
/// [`KeywordPreset`]: AutoModerationTriggerType::KeywordPreset
/// [Discord Docs/Trigger Metadata]: https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-trigger-metadata
pub fn with_keyword_preset(
mut self,
presets: &'a [AutoModerationKeywordPresetType],
allow_list: &'a [&'a str],
) -> ResponseFuture<AutoModerationRule> {
self.fields.trigger_metadata = Some(CreateAutoModerationRuleFieldsTriggerMetadata {
allow_list: Some(allow_list),
keyword_filter: None,
presets: Some(presets),
mention_total_limit: None,
});
self.fields.trigger_type = Some(AutoModerationTriggerType::KeywordPreset);
self.exec()
}
/// Create the request with the trigger type [`MentionSpam`], then execute
/// it.
///
/// Rules of this type requires the `mention_total_limit` field specified,
/// and this method ensures this. See [Discord Docs/Trigger Metadata].
///
/// # Errors
///
/// Returns an error of type [`AutoModerationMetadataMentionTotalLimit`] if
/// the limit is invalid.
///
/// [`AutoModerationMetadataMentionTotalLimit`]: twilight_validate::request::ValidationErrorType::AutoModerationMetadataMentionTotalLimit
/// [`MentionSpam`]: AutoModerationTriggerType::MentionSpam
/// [Discord Docs/Trigger Metadata]: https://discord.com/developers/docs/resources/auto-moderation#auto-moderation-rule-object-trigger-metadata
pub fn with_mention_spam(
mut self,
mention_total_limit: u8,
) -> Result<ResponseFuture<AutoModerationRule>, ValidationError> {
#[allow(clippy::question_mark)]
if let Err(source) =
validate_auto_moderation_metadata_mention_total_limit(mention_total_limit)
{
return Err(source);
}
self.fields.trigger_metadata = Some(CreateAutoModerationRuleFieldsTriggerMetadata {
allow_list: None,
keyword_filter: None,
presets: None,
mention_total_limit: Some(mention_total_limit),
});
self.fields.trigger_type = Some(AutoModerationTriggerType::MentionSpam);
Ok(self.exec())
}
/// Execute the request, returning a future resolving to a [`Response`].
///
/// [`Response`]: crate::response::Response
fn exec(self) -> ResponseFuture<AutoModerationRule> {
let http = self.http;
match self.try_into_request() {
Ok(request) => http.request(request),
Err(source) => ResponseFuture::error(source),
}
}
}
impl<'a> AuditLogReason<'a> for CreateAutoModerationRule<'a> {
fn reason(mut self, reason: &'a str) -> Result<Self, ValidationError> {
validate_audit_reason(reason)?;
self.reason.replace(reason);
Ok(self)
}
}
impl TryIntoRequest for CreateAutoModerationRule<'_> {
fn try_into_request(self) -> Result<Request, HttpError> {
let mut request = Request::builder(&Route::CreateAutoModerationRule {
guild_id: self.guild_id.get(),
})
.json(&self.fields)?;
if let Some(reason) = self.reason {
let header = request::audit_header(reason)?;
request = request.headers(header);
}
Ok(request.build())
}
}