config.py

import asyncio
import json
import os
import re
import typing
from copy import deepcopy

from dotenv import load_dotenv
import isodate

import discord
from discord.ext.commands import BadArgument

from core._color_data import ALL_COLORS
from core.models import DMDisabled, InvalidConfigError, Default, getLogger
from core.time import UserFriendlyTime
from core.utils import strtobool

logger = getLogger(__name__)
load_dotenv()


class ConfigManager:
    public_keys = {
        # activity
        "twitch_url": "https://www.twitch.tv/discordmodmail/",
        # bot settings
        "main_category_id": None,
        "fallback_category_id": None,
        "prefix": "?",
        "mention": "@here",
        "main_color": str(discord.Color.blurple()),
        "error_color": str(discord.Color.red()),
        "user_typing": False,
        "mod_typing": False,
        "account_age": isodate.Duration(),
        "guild_age": isodate.Duration(),
        "thread_cooldown": isodate.Duration(),
        "log_expiration": isodate.Duration(),
        "reply_without_command": False,
        "anon_reply_without_command": False,
        "plain_reply_without_command": False,
        # logging
        "log_channel_id": None,
        "mention_channel_id": None,
        "update_channel_id": None,
        # updates
        "update_notifications": True,
        # threads
        "sent_emoji": "\N{WHITE HEAVY CHECK MARK}",
        "blocked_emoji": "\N{NO ENTRY SIGN}",
        "close_emoji": None,
        "use_user_id_channel_name": False,
        "use_timestamp_channel_name": False,
        "use_nickname_channel_name": False,
        "use_random_channel_name": False,
        "recipient_thread_close": False,
        "recipient_thread_close_button_label": None,
        "recipient_thread_close_button_style": "red",
        "thread_show_roles": True,
        "thread_show_account_age": True,
        "thread_show_join_age": True,
        "thread_cancelled": "Cancelled",
        "thread_auto_close_silently": False,
        "thread_auto_close": isodate.Duration(),
        "thread_auto_close_response": "This thread has been closed automatically due to inactivity after {timeout}.",
        "thread_creation_response": "The staff team will get back to you as soon as possible.",
        "thread_creation_footer": "Your message has been sent",
        "thread_contact_silently": False,
        "thread_self_closable_creation_footer": "Click the button to close the thread",
        "thread_creation_contact_title": "New Thread",
        "thread_creation_self_contact_response": "You have opened a Modmail thread.",
        "thread_creation_contact_response": "{creator.name} has opened a Modmail thread.",
        "thread_creation_title": "Thread Created",
        "thread_close_footer": "Replying will create a new thread",
        "thread_close_title": "Thread Closed",
        "thread_close_response": "{closer.mention} has closed this Modmail thread.",
        "thread_self_close_response": "You have closed this Modmail thread.",
        "thread_move_title": "Thread Moved",
        "thread_move_notify": False,
        "thread_move_notify_mods": False,
        "thread_move_response": "This thread has been moved.",
        "cooldown_thread_title": "Message not sent!",
        "cooldown_thread_response": "Your cooldown ends {delta}. Try contacting me then.",
        "disabled_new_thread_title": "Not Delivered",
        "disabled_new_thread_response": "We are not accepting new threads.",
        "disabled_new_thread_footer": "Please try again later...",
        "disabled_current_thread_title": "Not Delivered",
        "disabled_current_thread_response": "We are not accepting any messages.",
        "disabled_current_thread_footer": "Please try again later...",
        "transfer_reactions": True,
        "close_on_leave": False,
        "close_on_leave_reason": "The recipient has left the server.",
        "alert_on_mention": False,
        "silent_alert_on_mention": False,
        "show_timestamp": True,
        "anonymous_snippets": False,
        "plain_snippets": False,
        "require_close_reason": False,
        "show_log_url_button": False,
        # group conversations
        "private_added_to_group_title": "New Thread (Group)",
        "private_added_to_group_response": "{moderator.name} has added you to a Modmail thread.",
        "private_added_to_group_description_anon": "A moderator has added you to a Modmail thread.",
        "public_added_to_group_title": "New User",
        "public_added_to_group_response": "{moderator.name} has added {users} to the Modmail thread.",
        "public_added_to_group_description_anon": "A moderator has added {users} to the Modmail thread.",
        "private_removed_from_group_title": "Removed From Thread (Group)",
        "private_removed_from_group_response": "{moderator.name} has removed you from the Modmail thread.",
        "private_removed_from_group_description_anon": "A moderator has removed you from the Modmail thread.",
        "public_removed_from_group_title": "User Removed",
        "public_removed_from_group_response": "{moderator.name} has removed {users} from the Modmail thread.",
        "public_removed_from_group_description_anon": "A moderator has removed {users} from the Modmail thread.",
        # moderation
        "recipient_color": str(discord.Color.gold()),
        "mod_color": str(discord.Color.green()),
        "mod_tag": None,
        # anonymous message
        "anon_username": None,
        "anon_avatar_url": None,
        "anon_tag": "Response",
        # react to contact
        "react_to_contact_message": None,
        "react_to_contact_emoji": "\N{WHITE HEAVY CHECK MARK}",
        # confirm thread creation
        "confirm_thread_creation": False,
        "confirm_thread_creation_title": "Confirm thread creation",
        "confirm_thread_response": "Click the button to confirm thread creation which will directly contact the moderators.",
        "confirm_thread_creation_accept": "\N{WHITE HEAVY CHECK MARK}",
        "confirm_thread_creation_deny": "\N{NO ENTRY SIGN}",
        # regex
        "use_regex_autotrigger": False,
        "use_hoisted_top_role": True,
    }

    private_keys = {
        # bot presence
        "activity_message": "",
        "activity_type": None,
        "status": None,
        "dm_disabled": DMDisabled.NONE,
        "oauth_whitelist": [],
        # moderation
        "blocked": {},
        "blocked_roles": {},
        "blocked_whitelist": [],
        "command_permissions": {},
        "level_permissions": {},
        "override_command_level": {},
        # threads
        "snippets": {},
        "notification_squad": {},
        "subscriptions": {},
        "closures": {},
        # misc
        "plugins": [],
        "aliases": {},
        "auto_triggers": {},
    }

    protected_keys = {
        # Modmail
        "modmail_guild_id": None,
        "guild_id": None,
        "log_url": "https://example.com/",
        "log_url_prefix": "/logs",
        "mongo_uri": None,
        "database_type": "mongodb",
        "connection_uri": None,  # replace mongo uri in the future
        "owners": None,
        "enable_presence_intent": False,
        "registry_plugins_only": False,
        # bot
        "token": None,
        "enable_plugins": True,
        "enable_eval": True,
        # github access token for private repositories
        "github_token": None,
        "disable_autoupdates": False,
        "disable_updates": False,
        # Logging
        "log_level": "INFO",
        "stream_log_format": "plain",
        "file_log_format": "plain",
        "discord_log_level": "INFO",
        # data collection
        "data_collection": True,
    }

    colors = {"mod_color", "recipient_color", "main_color", "error_color"}

    time_deltas = {"account_age", "guild_age", "thread_auto_close", "thread_cooldown", "log_expiration"}

    booleans = {
        "use_user_id_channel_name",
        "use_timestamp_channel_name",
        "use_nickname_channel_name",
        "use_random_channel_name",
        "user_typing",
        "mod_typing",
        "reply_without_command",
        "anon_reply_without_command",
        "plain_reply_without_command",
        "show_log_url_button",
        "recipient_thread_close",
        "thread_auto_close_silently",
        "thread_move_notify",
        "thread_move_notify_mods",
        "transfer_reactions",
        "close_on_leave",
        "alert_on_mention",
        "silent_alert_on_mention",
        "show_timestamp",
        "confirm_thread_creation",
        "use_regex_autotrigger",
        "enable_plugins",
        "data_collection",
        "enable_eval",
        "disable_autoupdates",
        "disable_updates",
        "update_notifications",
        "thread_contact_silently",
        "anonymous_snippets",
        "plain_snippets",
        "require_close_reason",
        "recipient_thread_close",
        "thread_show_roles",
        "thread_show_account_age",
        "thread_show_join_age",
        "use_hoisted_top_role",
        "enable_presence_intent",
        "registry_plugins_only",
    }

    enums = {"dm_disabled": DMDisabled, "status": discord.Status, "activity_type": discord.ActivityType}

    force_str = {"command_permissions", "level_permissions"}

    defaults = {**public_keys, **private_keys, **protected_keys}
    all_keys = set(defaults.keys())

    def __init__(self, bot):
        self.bot = bot
        self._cache = {}
        self.ready_event = asyncio.Event()
        self.config_help = {}

    def __repr__(self):
        return repr(self._cache)

    def populate_cache(self) -> dict:
        data = deepcopy(self.defaults)

        # populate from env var and .env file
        data.update({k.lower(): v for k, v in os.environ.items() if k.lower() in self.all_keys})
        config_json = os.path.join(os.path.dirname(os.path.dirname(os.path.abspath(__file__))), "config.json")
        if os.path.exists(config_json):
            logger.debug("Loading envs from config.json.")
            with open(config_json, "r", encoding="utf-8") as f:
                # Config json should override env vars
                try:
                    data.update({k.lower(): v for k, v in json.load(f).items() if k.lower() in self.all_keys})
                except json.JSONDecodeError:
                    logger.critical("Failed to load config.json env values.", exc_info=True)
        self._cache = data

        config_help_json = os.path.join(os.path.dirname(os.path.abspath(__file__)), "config_help.json")
        with open(config_help_json, "r", encoding="utf-8") as f:
            self.config_help = dict(sorted(json.load(f).items()))

        return self._cache

    async def update(self):
        """Updates the config with data from the cache"""
        await self.bot.api.update_config(self.filter_default(self._cache))

    async def refresh(self) -> dict:
        """Refreshes internal cache with data from database"""
        for k, v in (await self.bot.api.get_config()).items():
            k = k.lower()
            if k in self.all_keys:
                self._cache[k] = v
        if not self.ready_event.is_set():
            self.ready_event.set()
            logger.debug("Successfully fetched configurations from database.")
        return self._cache

    async def wait_until_ready(self) -> None:
        await self.ready_event.wait()

    def __setitem__(self, key: str, item: typing.Any) -> None:
        key = key.lower()
        logger.info("Setting %s.", key)
        if key not in self.all_keys:
            raise InvalidConfigError(f'Configuration "{key}" is invalid.')
        self._cache[key] = item

    def __getitem__(self, key: str) -> typing.Any:
        # make use of the custom methods in func:get:
        return self.get(key)

    def __delitem__(self, key: str) -> None:
        return self.remove(key)

    def get(self, key: str, *, convert: bool = True) -> typing.Any:
        key = key.lower()
        if key not in self.all_keys:
            raise InvalidConfigError(f'Configuration "{key}" is invalid.')
        if key not in self._cache:
            self._cache[key] = deepcopy(self.defaults[key])
        value = self._cache[key]

        if not convert:
            return value

        if key in self.colors:
            try:
                return int(value.lstrip("#"), base=16)
            except ValueError:
                logger.error("Invalid %s provided.", key)
            value = int(self.remove(key).lstrip("#"), base=16)

        elif key in self.time_deltas:
            if not isinstance(value, isodate.Duration):
                try:
                    value = isodate.parse_duration(value)
                except isodate.ISO8601Error:
                    logger.warning(
                        "The {account} age limit needs to be a "
                        'ISO-8601 duration formatted duration, not "%s".',
                        value,
                    )
                    value = self.remove(key)

        elif key in self.booleans:
            try:
                value = strtobool(value)
            except ValueError:
                value = self.remove(key)

        elif key in self.enums:
            if value is None:
                return None
            try:
                value = self.enums[key](value)
            except ValueError:
                logger.warning("Invalid %s %s.", key, value)
                value = self.remove(key)

        elif key in self.force_str:
            # Temporary: as we saved in int previously, leading to int32 overflow,
            #            this is transitioning IDs to strings
            new_value = {}
            changed = False
            for k, v in value.items():
                new_v = v
                if isinstance(v, list):
                    new_v = []
                    for n in v:
                        if n != -1 and not isinstance(n, str):
                            changed = True
                            n = str(n)
                        new_v.append(n)
                new_value[k] = new_v

            if changed:
                # transition the database as well
                self.set(key, new_value)

            value = new_value

        return value

    async def set(self, key: str, item: typing.Any, convert=True) -> None:
        if not convert:
            return self.__setitem__(key, item)

        if key in self.colors:
            try:
                hex_ = str(item)
                if hex_.startswith("#"):
                    hex_ = hex_[1:]
                if len(hex_) == 3:
                    hex_ = "".join(s for s in hex_ for _ in range(2))
                if len(hex_) != 6:
                    raise InvalidConfigError("Invalid color name or hex.")
                try:
                    int(hex_, 16)
                except ValueError:
                    raise InvalidConfigError("Invalid color name or hex.")

            except InvalidConfigError:
                name = str(item).lower()
                name = re.sub(r"[\-+|. ]+", " ", name)
                hex_ = ALL_COLORS.get(name)
                if hex_ is None:
                    name = re.sub(r"[\-+|. ]+", "", name)
                    hex_ = ALL_COLORS.get(name)
                    if hex_ is None:
                        raise
            return self.__setitem__(key, "#" + hex_)

        if key in self.time_deltas:
            try:
                isodate.parse_duration(item)
            except isodate.ISO8601Error:
                try:
                    converter = UserFriendlyTime()
                    time = await converter.convert(None, item, now=discord.utils.utcnow())
                    if time.arg:
                        raise ValueError
                except BadArgument as exc:
                    raise InvalidConfigError(*exc.args)
                except Exception as e:
                    logger.debug(e)
                    raise InvalidConfigError(
                        "Unrecognized time, please use ISO-8601 duration format "
                        'string or a simpler "human readable" time.'
                    )
                now = discord.utils.utcnow()
                item = isodate.duration_isoformat(time.dt - now)
            return self.__setitem__(key, item)

        if key in self.booleans:
            try:
                return self.__setitem__(key, strtobool(item))
            except ValueError:
                raise InvalidConfigError("Must be a yes/no value.")

        elif key in self.enums:
            if isinstance(item, self.enums[key]):
                # value is an enum type
                item = item.value

        return self.__setitem__(key, item)

    def remove(self, key: str) -> typing.Any:
        key = key.lower()
        logger.info("Removing %s.", key)
        if key not in self.all_keys:
            raise InvalidConfigError(f'Configuration "{key}" is invalid.')
        if key in self._cache:
            del self._cache[key]
        self._cache[key] = deepcopy(self.defaults[key])
        return self._cache[key]

    def items(self) -> typing.Iterable:
        return self._cache.items()

    @classmethod
    def filter_valid(cls, data: typing.Dict[str, typing.Any]) -> typing.Dict[str, typing.Any]:
        return {
            k.lower(): v
            for k, v in data.items()
            if k.lower() in cls.public_keys or k.lower() in cls.private_keys
        }

    @classmethod
    def filter_default(cls, data: typing.Dict[str, typing.Any]) -> typing.Dict[str, typing.Any]:
        # TODO: use .get to prevent errors
        filtered = {}
        for k, v in data.items():
            default = cls.defaults.get(k.lower(), Default)
            if default is Default:
                logger.error("Unexpected configuration detected: %s.", k)
                continue
            if v != default:
                filtered[k.lower()] = v
        return filtered