mirror of
https://github.com/VCMP-SqMod/SqMod.git
synced 2024-11-08 00:37:15 +01:00
375 lines
10 KiB
C++
375 lines
10 KiB
C++
/************************************************************************************
|
|
*
|
|
* D++, A Lightweight C++ library for Discord
|
|
*
|
|
* Copyright 2021 Craig Edwards and D++ contributors
|
|
* (https://github.com/brainboxdotcc/DPP/graphs/contributors)
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*
|
|
************************************************************************************/
|
|
|
|
#pragma once
|
|
#include <dpp/export.h>
|
|
#include <dpp/snowflake.h>
|
|
#include <dpp/managed.h>
|
|
#include <dpp/utility.h>
|
|
#include <dpp/json_fwd.h>
|
|
#include <dpp/json_interface.h>
|
|
|
|
namespace dpp {
|
|
|
|
/**
|
|
* @brief Possible types of preset filter lists
|
|
*/
|
|
enum automod_preset_type : uint8_t {
|
|
/**
|
|
* @brief Strong swearing
|
|
*/
|
|
amod_preset_profanity = 1,
|
|
/**
|
|
* @brief Sexual phrases and words
|
|
*/
|
|
amod_preset_sexual_content = 2,
|
|
/**
|
|
* @brief Racial and other slurs, hate speech
|
|
*/
|
|
amod_preset_slurs = 3,
|
|
};
|
|
|
|
/**
|
|
* @brief Action types to perform on filtering
|
|
*/
|
|
enum automod_action_type : uint8_t {
|
|
/**
|
|
* @brief Blocks the message and prevents it from being posted.
|
|
* A custom explanation can be specified and shown to members whenever their message is blocked
|
|
*/
|
|
amod_action_block_message = 1,
|
|
/**
|
|
* @brief Send an alert to a given channel
|
|
*/
|
|
amod_action_send_alert = 2,
|
|
/**
|
|
* @brief timeout the user
|
|
* @note Can only be set up for rules with trigger types of dpp::amod_type_keyword and dpp::amod_type_mention_spam
|
|
*/
|
|
amod_action_timeout = 3,
|
|
};
|
|
|
|
/**
|
|
* @brief Event types, only message send is currently supported
|
|
*/
|
|
enum automod_event_type : uint8_t {
|
|
/**
|
|
* @brief Trigger on message send or edit
|
|
*/
|
|
amod_message_send = 1,
|
|
};
|
|
|
|
/**
|
|
* @brief Types of moderation to trigger
|
|
*/
|
|
enum automod_trigger_type : uint8_t {
|
|
/**
|
|
* @brief Check if content contains words from a user defined list of keywords (max 6 of this type per guild)
|
|
*/
|
|
amod_type_keyword = 1,
|
|
/**
|
|
* @brief Harmful/malware links
|
|
* @deprecated Removed by Discord
|
|
*/
|
|
amod_type_harmful_link = 2,
|
|
/**
|
|
* @brief Check if content represents generic spam (max 1 of this type per guild)
|
|
*/
|
|
amod_type_spam = 3,
|
|
/**
|
|
* @brief Check if content contains words from discord pre-defined wordsets (max 1 of this type per guild)
|
|
*/
|
|
amod_type_keyword_preset = 4,
|
|
/**
|
|
* @brief Check if content contains more mentions than allowed (max 1 of this type per guild)
|
|
*/
|
|
amod_type_mention_spam = 5,
|
|
};
|
|
|
|
/**
|
|
* @brief Metadata associated with an automod action. Different fields are relevant based on the value of dpp::automod_rule::trigger_type.
|
|
*/
|
|
struct DPP_EXPORT automod_metadata : public json_interface<automod_metadata> {
|
|
/**
|
|
* @brief @brief Substrings which will be searched for in content (Maximum of 1000).
|
|
*
|
|
* Each keyword can be a phrase which contains multiple words.
|
|
* All keywords are case insensitive and can be up to 60 characters.
|
|
*
|
|
* Wildcard symbols (`*`) can be used to customize how each keyword will be matched.
|
|
*
|
|
* **Examples for the `*` wildcard symbol:**
|
|
*
|
|
* Prefix - word must start with the keyword
|
|
*
|
|
* | keyword | matches |
|
|
* |----------|-------------------------------------|
|
|
* | cat* | <u><b>cat</b></u>ch, <u><b>Cat</b></u>apult, <u><b>CAt</b></u>tLE |
|
|
* | the mat* | <u><b>the mat</b></u>rix |
|
|
*
|
|
* Suffix - word must end with the keyword
|
|
*
|
|
* | keyword | matches |
|
|
* |----------|--------------------------|
|
|
* | *cat | wild<u><b>cat</b></u>, copy<u><b>Cat</b></u> |
|
|
* | *the mat | brea<u><b>the mat</b></u> |
|
|
*
|
|
* Anywhere - keyword can appear anywhere in the content
|
|
*
|
|
* | keyword | matches |
|
|
* |-----------|-----------------------------|
|
|
* | \*cat* | lo<u><b>cat</b></u>ion, edu<u><b>Cat</b></u>ion |
|
|
* | \*the mat* | brea<u><b>the mat</b></u>ter |
|
|
*
|
|
* Whole Word - keyword is a full word or phrase and must be surrounded by whitespace at the beginning and end
|
|
*
|
|
* | keyword | matches |
|
|
* |---------|-------------|
|
|
* | cat | <u><b>Cat</b></u> |
|
|
* | the mat | <u><b>the mat</b></u> |
|
|
*
|
|
*/
|
|
std::vector<std::string> keywords;
|
|
|
|
/**
|
|
* @brief Regular expression patterns which will be matched against content (Maximum of 10).
|
|
*
|
|
* Only Rust flavored regex is currently supported, which can be tested in online editors such as [Rustexp](https://rustexp.lpil.uk/).
|
|
* Each regex pattern can be up to 260 characters.
|
|
*/
|
|
std::vector<std::string> regex_patterns;
|
|
|
|
/**
|
|
* @brief Preset keyword list types to moderate
|
|
* @see automod_preset_type
|
|
*/
|
|
std::vector<automod_preset_type> presets;
|
|
|
|
/**
|
|
* @brief Substrings which should not trigger the rule (Maximum of 100 for the trigger type dpp::amod_type_keyword, Maximum of 1000 for the trigger type dpp::amod_type_keyword_preset).
|
|
*
|
|
* Each keyword can be a phrase which contains multiple words.
|
|
* All keywords are case insensitive and can be up to 60 characters.
|
|
*
|
|
* Wildcard symbols (`*`) can be used to customize how each keyword will be matched.
|
|
*
|
|
* **Examples for the `*` wildcard symbol:**
|
|
*
|
|
* Prefix - word must start with the keyword
|
|
*
|
|
* | keyword | matches |
|
|
* |----------|-------------------------------------|
|
|
* | cat* | <u><b>cat</b></u>ch, <u><b>Cat</b></u>apult, <u><b>CAt</b></u>tLE |
|
|
* | the mat* | <u><b>the mat</b></u>rix |
|
|
*
|
|
* Suffix - word must end with the keyword
|
|
*
|
|
* | keyword | matches |
|
|
* |----------|--------------------------|
|
|
* | *cat | wild<u><b>cat</b></u>, copy<u><b>Cat</b></u> |
|
|
* | *the mat | brea<u><b>the mat</b></u> |
|
|
*
|
|
* Anywhere - keyword can appear anywhere in the content
|
|
*
|
|
* | keyword | matches |
|
|
* |-----------|-----------------------------|
|
|
* | \*cat* | lo<u><b>cat</b></u>ion, edu<u><b>Cat</b></u>ion |
|
|
* | \*the mat* | brea<u><b>the mat</b></u>ter |
|
|
*
|
|
* Whole Word - keyword is a full word or phrase and must be surrounded by whitespace at the beginning and end
|
|
*
|
|
* | keyword | matches |
|
|
* |---------|-------------|
|
|
* | cat | <u><b>Cat</b></u> |
|
|
* | the mat | <u><b>the mat</b></u> |
|
|
*
|
|
*/
|
|
std::vector<std::string> allow_list;
|
|
|
|
/**
|
|
* @brief Total number of unique role and user mentions allowed per message (Maximum of 50)
|
|
*/
|
|
uint8_t mention_total_limit;
|
|
|
|
/**
|
|
* @brief Whether to automatically detect mention raids
|
|
*/
|
|
bool mention_raid_protection_enabled;
|
|
|
|
/**
|
|
* @brief Construct a new automod metadata object
|
|
*/
|
|
automod_metadata();
|
|
|
|
/**
|
|
* @brief Destroy the automod metadata object
|
|
*/
|
|
virtual ~automod_metadata();
|
|
|
|
/**
|
|
* @brief Fill object properties from JSON
|
|
*
|
|
* @param j JSON to fill from
|
|
* @return automod_metadata& Reference to self
|
|
*/
|
|
automod_metadata& fill_from_json(nlohmann::json* j);
|
|
|
|
/**
|
|
* @brief Build a json string for this object
|
|
*
|
|
* @return std::string JSON string
|
|
*/
|
|
virtual std::string build_json(bool with_id = false) const;
|
|
|
|
};
|
|
|
|
/**
|
|
* @brief Represents an automod action
|
|
*/
|
|
struct DPP_EXPORT automod_action : public json_interface<automod_action> {
|
|
/**
|
|
* @brief Type of action to take
|
|
*/
|
|
automod_action_type type;
|
|
|
|
/**
|
|
* @brief Channel ID to which user content should be logged, for type dpp::amod_action_send_alert
|
|
*/
|
|
snowflake channel_id;
|
|
|
|
/**
|
|
* @brief Additional explanation that will be shown to members whenever their message is blocked. For type dpp::amod_action_block_message
|
|
*/
|
|
std::string custom_message;
|
|
|
|
/**
|
|
* @brief Timeout duration in seconds (Maximum of 2419200), for dpp::amod_action_timeout
|
|
*/
|
|
uint32_t duration_seconds;
|
|
|
|
/**
|
|
* @brief Construct a new automod action object
|
|
*/
|
|
automod_action();
|
|
|
|
/**
|
|
* @brief Destroy the automod action object
|
|
*/
|
|
virtual ~automod_action();
|
|
|
|
/**
|
|
* @brief Fill object properties from JSON
|
|
*
|
|
* @param j JSON to fill from
|
|
* @return automod_action& Reference to self
|
|
*/
|
|
automod_action& fill_from_json(nlohmann::json* j);
|
|
|
|
/**
|
|
* @brief Build a json string for this object
|
|
*
|
|
* @return std::string JSON string
|
|
*/
|
|
virtual std::string build_json(bool with_id = false) const;
|
|
};
|
|
|
|
/**
|
|
* @brief Represents an automod rule
|
|
*/
|
|
class DPP_EXPORT automod_rule : public managed, public json_interface<automod_rule> {
|
|
public:
|
|
/**
|
|
* @brief the id of this rule
|
|
*/
|
|
snowflake id;
|
|
/**
|
|
* @brief the guild which this rule belongs to
|
|
*/
|
|
snowflake guild_id;
|
|
/**
|
|
* @brief the rule name
|
|
*/
|
|
std::string name;
|
|
/**
|
|
* @brief The user which first created this rule
|
|
*/
|
|
snowflake creator_id;
|
|
/**
|
|
* @brief The rule event type
|
|
*/
|
|
automod_event_type event_type;
|
|
/**
|
|
* @brief The rule trigger type
|
|
*/
|
|
automod_trigger_type trigger_type;
|
|
/**
|
|
* @brief The rule trigger metadata
|
|
*/
|
|
automod_metadata trigger_metadata;
|
|
/**
|
|
* @brief the actions which will execute when the rule is triggered
|
|
*/
|
|
std::vector<automod_action> actions;
|
|
/**
|
|
* @brief Whether the rule is enabled
|
|
*/
|
|
bool enabled;
|
|
/**
|
|
* @brief the role ids that should not be affected by the rule (Maximum of 20)
|
|
*/
|
|
std::vector<snowflake> exempt_roles;
|
|
/**
|
|
* @brief the channel ids that should not be affected by the rule (Maximum of 50)
|
|
*/
|
|
std::vector<snowflake> exempt_channels;
|
|
|
|
/**
|
|
* @brief Construct a new automod rule object
|
|
*/
|
|
automod_rule();
|
|
|
|
/**
|
|
* @brief Destroy the automod rule object
|
|
*/
|
|
virtual ~automod_rule();
|
|
|
|
/**
|
|
* @brief Fill object properties from JSON
|
|
*
|
|
* @param j JSON to fill from
|
|
* @return automod_rule& Reference to self
|
|
*/
|
|
automod_rule& fill_from_json(nlohmann::json* j);
|
|
|
|
/**
|
|
* @brief Build a json string for this object
|
|
*
|
|
* @return std::string JSON string
|
|
*/
|
|
virtual std::string build_json(bool with_id = false) const;
|
|
};
|
|
|
|
/** A group of automod rules.
|
|
*/
|
|
typedef std::unordered_map<snowflake, automod_rule> automod_rule_map;
|
|
|
|
};
|