path: root/src/discord/permissions.hpp

#pragma once
#include <cstdint>
#include "json.hpp"
#include "misc/bitwise.hpp"
#include "snowflake.hpp"

constexpr static uint64_t PERMISSION_MAX_BIT = 36;
enum class Permission : uint64_t {
    NONE = 0,
    CREATE_INSTANT_INVITE = (1ULL << 0),                // Allows creation of instant invites
    KICK_MEMBERS = (1ULL << 1),                         // Allows kicking members
    BAN_MEMBERS = (1ULL << 2),                          // Allows banning members
    ADMINISTRATOR = (1ULL << 3),                        // Allows all permissions and bypasses channel permission overwrites
    MANAGE_CHANNELS = (1ULL << 4),                      // Allows management and editing of channels
    MANAGE_GUILD = (1ULL << 5),                         // Allows management and editing of the guild
    ADD_REACTIONS = (1ULL << 6),                        // Allows for the addition of reactions to messages
    VIEW_AUDIT_LOG = (1ULL << 7),                       // Allows for viewing of audit logs
    PRIORITY_SPEAKER = (1ULL << 8),                     // Allows for using priority speaker in a voice channel
    STREAM = (1ULL << 9),                               // Allows the user to go live
    VIEW_CHANNEL = (1ULL << 10),                        // Allows guild members to view a channel, which includes reading messages in text channels
    SEND_MESSAGES = (1ULL << 11),                       // Allows for sending messages in a channel
    SEND_TTS_MESSAGES = (1ULL << 12),                   // Allows for sending of /tts messages
    MANAGE_MESSAGES = (1ULL << 13),                     // Allows for deletion of other users messages
    EMBED_LINKS = (1ULL << 14),                         // Links sent by users with this permission will be auto-embedded
    ATTACH_FILES = (1ULL << 15),                        // Allows for uploading images and files
    READ_MESSAGE_HISTORY = (1ULL << 16),                // Allows for reading of message history
    MENTION_EVERYONE = (1ULL << 17),                    // Allows for using the @everyone tag to notify all users in a channel, and the @here tag to notify all online users in a channel
    USE_EXTERNAL_EMOJIS = (1ULL << 18),                 // Allows the usage of custom emojis from other servers
    VIEW_GUILD_INSIGHTS = (1ULL << 19),                 // Allows for viewing guild insights
    CONNECT = (1ULL << 20),                             // Allows for joining of a voice channel
    SPEAK = (1ULL << 21),                               // Allows for speaking in a voice channel
    MUTE_MEMBERS = (1ULL << 22),                        // Allows for muting members in a voice channel
    DEAFEN_MEMBERS = (1ULL << 23),                      // Allows for deafening of members in a voice channel
    MOVE_MEMBERS = (1ULL << 24),                        // Allows for moving of members between voice channels
    USE_VAD = (1ULL << 25),                             // Allows for using voice-activity-detection in a voice channel
    CHANGE_NICKNAME = (1ULL << 26),                     // Allows for modification of own nickname
    MANAGE_NICKNAMES = (1ULL << 27),                    // Allows for modification of other users nicknames
    MANAGE_ROLES = (1ULL << 28),                        // Allows management and editing of roles
    MANAGE_WEBHOOKS = (1ULL << 29),                     // Allows management and editing of webhooks
    MANAGE_GUILD_EXPRESSIONS = (1ULL << 30),            // Allows management and editing of emojis, stickers, and soundboard sounds
    USE_APPLICATION_COMMANDS = (1ULL << 31),            // Allows members to use application commands, including slash commands and context menu commands
    REQUEST_TO_SPEAK = (1ULL << 32),                    // Allows for requesting to speak in stage channels
    MANAGE_EVENTS = (1ULL << 33),                       // Allows for creating, editing, and deleting scheduled events
    MANAGE_THREADS = (1ULL << 34),                      // Allows for deleting and archiving threads, and viewing all private threads
    CREATE_PUBLIC_THREADS = (1ULL << 35),               // Allows for creating public and announcement threads
    CREATE_PRIVATE_THREADS = (1ULL << 36),              // Allows for creating private threads
    USE_EXTERNAL_STICKERS = (1ULL << 37),               // Allows the usage of custom stickers from other servers
    SEND_MESSAGES_IN_THREADS = (1ULL << 38),            // Allows for sending messages in threads
    USE_EMBEDDED_ACTIVITIES = (1ULL << 39),             // Allows for using Activities (applications with the EMBEDDED flag) in a voice channel
    MODERATE_MEMBERS = (1ULL << 40),                    // Allows for timing out users to prevent them from sending or reacting to messages in chat and threads, and from speaking in voice and stage channels
    VIEW_CREATOR_MONETIZATION_ANALYTICS = (1ULL << 41), // Allows for viewing role subscription insights
    USE_SOUNDBOARD = (1ULL << 42),                      // Allows for using soundboard in a voice channel
    CREATE_GUILD_EXPRESSIONS = (1ULL << 43),            // undocumented. Present in client
    CREATE_EVENTS = (1ULL << 44),                       // undocumented. Present in client
    USE_EXTERNAL_SOUNDS = (1ULL << 45),                 // Allows the usage of custom soundboard sounds from other servers
    SEND_VOICE_MESSAGES = (1ULL << 46),                 // Allows sending voice messages
    USE_CLYDE_AI = (1ULL << 47),                        // undocumented
    SET_VOICE_CHANNEL_STATUS = (1ULL << 48),            // undocumented. Present in Client

    ALL = 0x1FFFFFFFFFFFFULL,
};

template<>
struct Bitwise<Permission> {
    static const bool enable = true;
};

struct PermissionOverwrite {
    enum OverwriteType : uint8_t {
        ROLE = 0,
        MEMBER = 1,
    };

    Snowflake ID;
    OverwriteType Type;
    Permission Allow;
    Permission Deny;

    friend void from_json(const nlohmann::json &j, PermissionOverwrite &m);
};

constexpr const char *GetPermissionString(Permission perm) {
    switch (perm) {
        case Permission::NONE:
            return "None";
        case Permission::CREATE_INSTANT_INVITE:
            return "Create Invite";
        case Permission::KICK_MEMBERS:
            return "Kick Members";
        case Permission::BAN_MEMBERS:
            return "Ban Members";
        case Permission::ADMINISTRATOR:
            return "Administrator";
        case Permission::MANAGE_CHANNELS:
            return "Manage Channels";
        case Permission::MANAGE_GUILD:
            return "Manage Server";
        case Permission::ADD_REACTIONS:
            return "Add Reactions";
        case Permission::VIEW_AUDIT_LOG:
            return "View Audit Log";
        case Permission::PRIORITY_SPEAKER:
            return "Use Priority Speaker";
        case Permission::STREAM:
            return "Video";
        case Permission::VIEW_CHANNEL:
            return "View Channels";
        case Permission::SEND_MESSAGES:
            return "Send Messages";
        case Permission::SEND_TTS_MESSAGES:
            return "Use TTS";
        case Permission::MANAGE_MESSAGES:
            return "Manage Messages";
        case Permission::EMBED_LINKS:
            return "Embed Links";
        case Permission::ATTACH_FILES:
            return "Attach Files";
        case Permission::READ_MESSAGE_HISTORY:
            return "Read Message History";
        case Permission::MENTION_EVERYONE:
            return "Mention @everyone";
        case Permission::USE_EXTERNAL_EMOJIS:
            return "Use External Emojis";
        case Permission::VIEW_GUILD_INSIGHTS:
            return "View Server Insights";
        case Permission::CONNECT:
            return "Connect to Voice";
        case Permission::SPEAK:
            return "Speak in Voice";
        case Permission::MUTE_MEMBERS:
            return "Mute Members";
        case Permission::DEAFEN_MEMBERS:
            return "Deafen Members";
        case Permission::MOVE_MEMBERS:
            return "Move Members";
        case Permission::USE_VAD:
            return "Use Voice Activation";
        case Permission::CHANGE_NICKNAME:
            return "Change Nickname";
        case Permission::MANAGE_NICKNAMES:
            return "Manage Nicknames";
        case Permission::MANAGE_ROLES:
            return "Manage Roles";
        case Permission::MANAGE_WEBHOOKS:
            return "Manage Webhooks";
        case Permission::MANAGE_GUILD_EXPRESSIONS:
            return "Manage Expressions";
        case Permission::USE_APPLICATION_COMMANDS:
            return "Use Application Commands";
        case Permission::MANAGE_EVENTS:
            return "Manage Events";
        case Permission::MANAGE_THREADS:
            return "Manage Threads";
        case Permission::CREATE_PUBLIC_THREADS:
            return "Create Public Threads";
        case Permission::CREATE_PRIVATE_THREADS:
            return "Create Private Threads";
        case Permission::USE_EXTERNAL_STICKERS:
            return "Use External Stickers";
        case Permission::SEND_MESSAGES_IN_THREADS:
            return "Send Messages In Threads";
        case Permission::USE_EMBEDDED_ACTIVITIES:
            return "Use Activities";
        case Permission::MODERATE_MEMBERS:
            return "Timeout Members";
        // case Permission::VIEW_CREATOR_MONETIZATION_ANALYTICS:
        //     return "";
        case Permission::USE_SOUNDBOARD:
            return "Use Soundboard";
        case Permission::CREATE_GUILD_EXPRESSIONS:
            return "Create Expressions";
        case Permission::CREATE_EVENTS:
            return "Create Events";
        case Permission::USE_EXTERNAL_SOUNDS:
            return "Use External Sounds";
        case Permission::SEND_VOICE_MESSAGES:
            return "Send Voice Messages";
        // case Permission::USE_CLYDE_AI:
        //     return "";
        case Permission::SET_VOICE_CHANNEL_STATUS:
            return "Set Voice Channel Status";
        default:
            return "Unknown Permission";
    }
}

constexpr const char *GetPermissionDescription(Permission perm) {
    switch (perm) {
        case Permission::NONE:
            return "";
        case Permission::CREATE_INSTANT_INVITE:
            return "Allows members to invite new people to this server.";
        case Permission::KICK_MEMBERS:
            return "Allows members to remove other members from this server. Kicked members will be able to rejoin if they have another invite.";
        case Permission::BAN_MEMBERS:
            return "Allows members to permanently ban other members from this server.";
        case Permission::ADMINISTRATOR:
            return "Members with this permission will have every permission and will also bypass all channel specific permissions or restrictions (for example, these members would get access to all private channels). This is a dangerous permission to grant.";
        case Permission::MANAGE_CHANNELS:
            return "Allows members to create, edit, or delete channels.";
        case Permission::MANAGE_GUILD:
            return "Allows members to change this server's name, switch regions, and add bots to this server.";
        case Permission::ADD_REACTIONS:
            return "Allows members to add new emoji reactions to a message. If this permission is disabled, members can still react using any existing reactions on a message.";
        case Permission::VIEW_AUDIT_LOG:
            return "Allows members to view a record of who made which changes in this server.";
        case Permission::PRIORITY_SPEAKER:
            return "Allows members to be more easily heard in voice channels. When activated, the volume of others without this permission will be automatically lowered. Priority Speaker is activated by using the Push to Talk (Priority) keybind.";
        case Permission::STREAM:
            return "Allows members to share their video, screen share, or stream a game in this server.";
        case Permission::VIEW_CHANNEL:
            return "Allows members to view channels by default (excluding private channels).";
        case Permission::SEND_MESSAGES:
            return "Allows members to send messages in text channels.";
        case Permission::SEND_TTS_MESSAGES:
            return "Allows members to send text-to-speech messages by starting a message with /tts. These messages can be heard by anyone focused on thsi channel.";
        case Permission::MANAGE_MESSAGES:
            return "Allows members to delete messages by other members or pin any message";
        case Permission::EMBED_LINKS:
            return "Allows links that members share to show embedded content in text channels.";
        case Permission::ATTACH_FILES:
            return "Allows members to upload files or media in text channels.";
        case Permission::READ_MESSAGE_HISTORY:
            return "Allows members to read previous messages sent in channels. If this permission is disabled, members only see messages sent when they are online and focused on that channel.";
        case Permission::MENTION_EVERYONE:
            return "Allows members to use @everyone (everyone in the server) or @here (only online members in that channel). They can also @mention all roles, even if the role's \"Allow anyone to mention this role\" permission is disabled.";
        case Permission::USE_EXTERNAL_EMOJIS:
            return "Allows members to use emoji from other servers, if they're a Discord Nitro member";
        case Permission::VIEW_GUILD_INSIGHTS:
            return "Allows members to view Server Insights, which shows data on community growth, engagement, and more.";
        case Permission::CONNECT:
            return "Allows members to join voice channels and hear others.";
        case Permission::SPEAK:
            return "Allows members to talk in voice channels. If this permission is disabled, members are default muted until somebody with the \"Mute Members\" permission un-mutes them.";
        case Permission::MUTE_MEMBERS:
            return "Allows members to mute other members in voice channels for everyone.";
        case Permission::DEAFEN_MEMBERS:
            return "Allows members to deafen other members in voice channels, which means they won't be able to speak or hear others.";
        case Permission::MOVE_MEMBERS:
            return "Allows members to move other members between voice channels that the member with the permission has access to.";
        case Permission::USE_VAD:
            return "Allows members to speak in voice channels by simply talking. If this permission is disabled, members are required to use Push-to-talk. Good for controlling background noise or noisy members.";
        case Permission::CHANGE_NICKNAME:
            return "Allows members to change their own nickname, a custom name for just this server.";
        case Permission::MANAGE_NICKNAMES:
            return "Allows members to change the nicknames of other members.";
        case Permission::MANAGE_ROLES:
            return "Allows members to create new roles and edit or delete roles lower than their highest role. Also allows members to change permissions of individual channels that they have access to.";
        case Permission::MANAGE_WEBHOOKS:
            return "Allows members to create, edit, or delete webhooks, which can post messages from other apps or sites into this server.";
        case Permission::MANAGE_GUILD_EXPRESSIONS:
            return "Allows members to add or remove custom emoji, stickers, and sounds in this server.";
        case Permission::USE_APPLICATION_COMMANDS:
            return "Allows members to use commands from applications, including slash commands and context menu commands.";
        case Permission::MANAGE_EVENTS:
            return "Allows members to edit and cancel events.";
        case Permission::MANAGE_THREADS:
            return "Allows members to rename, delete, close, and turn on slow mode for threads. They can also view private threads";
        case Permission::CREATE_PUBLIC_THREADS:
            return "Allows members to create threads that everyone in a channel can view.";
        case Permission::CREATE_PRIVATE_THREADS:
            return "Allows members to create invite-only threads.";
        case Permission::USE_EXTERNAL_STICKERS:
            return "Allows members to use stickers from other servers, if they're a Discord Nitro member.";
        case Permission::SEND_MESSAGES_IN_THREADS:
            return "Allows members to send messages in threads.";
        case Permission::USE_EMBEDDED_ACTIVITIES:
            return "Allows members to use Activities in this server.";
        case Permission::MODERATE_MEMBERS:
            return "When you put a user in timeout they will not be able to send messages in chat, reply within threads, react to messages, or speak in voice or Stage channels.";
        // case Permission::VIEW_CREATOR_MONETIZATION_ANALYTICS:
        //     return "";
        case Permission::USE_SOUNDBOARD:
            return "Allows members to send sounds from server soundboard.";
        case Permission::CREATE_GUILD_EXPRESSIONS:
            return "Allows members to add custom emoji, stickers, and sounds in this server.";
        case Permission::CREATE_EVENTS:
            return "Allows members to create events.";
        case Permission::USE_EXTERNAL_SOUNDS:
            return "Allows members to use sounds from other servers, if they're a Discord Nitro member.";
        case Permission::SEND_VOICE_MESSAGES:
            return "Allows members to send voice messages.";
        // case Permission::USE_CLYDE_AI:
        //     return "";
        case Permission::SET_VOICE_CHANNEL_STATUS:
            return "Allows members to create and edit voice channel status.";
        default:
            return "";
    }
}