240 lines
7.6 KiB
Python
240 lines
7.6 KiB
Python
from dataclasses import dataclass
|
|
from logging import Logger
|
|
from typing import Any, Dict, Optional
|
|
|
|
from bson import ObjectId
|
|
from libbot.cache.classes import Cache
|
|
from pymongo.results import InsertOneResult
|
|
|
|
from classes.errors import GuildNotFoundError
|
|
from modules.database import col_guilds
|
|
from modules.utils import get_logger, restore_from_cache
|
|
|
|
logger: Logger = get_logger(__name__)
|
|
|
|
|
|
@dataclass
|
|
class PycordGuild:
|
|
"""Dataclass of DB entry of a guild"""
|
|
|
|
__slots__ = ("_id", "id", "channel_id", "category_id", "timezone", "language")
|
|
__short_name__ = "guild"
|
|
__collection__ = col_guilds
|
|
|
|
_id: ObjectId
|
|
id: int
|
|
channel_id: int | None
|
|
category_id: int | None
|
|
timezone: str
|
|
language: str | None
|
|
|
|
@classmethod
|
|
async def from_id(
|
|
cls, guild_id: int, allow_creation: bool = True, cache: Optional[Cache] = None
|
|
) -> "PycordGuild":
|
|
"""Find guild in database and create new record if guild does not exist.
|
|
|
|
Args:
|
|
guild_id (int): User's Discord ID
|
|
allow_creation (:obj:`bool`, optional): Create new guild record if none found in the database
|
|
cache (:obj:`Cache`, optional): Cache engine to get the cache from
|
|
|
|
Returns:
|
|
PycordGuild: User object
|
|
|
|
Raises:
|
|
GuildNotFoundError: User was not found and creation was not allowed
|
|
"""
|
|
cached_entry: Dict[str, Any] | None = restore_from_cache(cls.__short_name__, guild_id, cache=cache)
|
|
|
|
if cached_entry is not None:
|
|
return cls(**cached_entry)
|
|
|
|
db_entry = await cls.__collection__.find_one({"id": guild_id})
|
|
|
|
if db_entry is None:
|
|
if not allow_creation:
|
|
raise GuildNotFoundError(guild_id)
|
|
|
|
db_entry = PycordGuild.get_defaults(guild_id)
|
|
|
|
insert_result: InsertOneResult = await cls.__collection__.insert_one(db_entry)
|
|
|
|
db_entry["_id"] = insert_result.inserted_id
|
|
|
|
if cache is not None:
|
|
cache.set_json(f"{cls.__short_name__}_{guild_id}", db_entry)
|
|
|
|
return cls(**db_entry)
|
|
|
|
# TODO Update the docstring
|
|
async def _set(self, cache: Optional[Cache] = None, **kwargs) -> None:
|
|
"""Set attribute data and save it into the database.
|
|
|
|
Args:
|
|
key (str): Attribute to change
|
|
value (Any): Value to set
|
|
cache (:obj:`Cache`, optional): Cache engine to write the update into
|
|
"""
|
|
for key, value in kwargs.items():
|
|
if not hasattr(self, key):
|
|
raise AttributeError()
|
|
|
|
setattr(self, key, value)
|
|
|
|
await self.__collection__.update_one({"_id": self._id}, {"$set": kwargs}, upsert=True)
|
|
|
|
self._update_cache(cache)
|
|
|
|
logger.info("Set attributes of guild %s to %s", self.id, kwargs)
|
|
|
|
# TODO Update the docstring
|
|
async def _remove(self, cache: Optional[Cache] = None, *args: str) -> None:
|
|
"""Remove attribute data and save it into the database.
|
|
|
|
Args:
|
|
key (str): Attribute to remove
|
|
cache (:obj:`Cache`, optional): Cache engine to write the update into
|
|
"""
|
|
attributes: Dict[str, Any] = {}
|
|
|
|
for key in args:
|
|
if not hasattr(self, key):
|
|
raise AttributeError()
|
|
|
|
default_value: Any = self.get_default_value(key)
|
|
|
|
setattr(self, key, default_value)
|
|
|
|
attributes[key] = default_value
|
|
|
|
await self.__collection__.update_one({"_id": self._id}, {"$set": attributes}, upsert=True)
|
|
|
|
self._update_cache(cache)
|
|
|
|
logger.info("Reset attributes %s of guild %s to default values", args, self.id)
|
|
|
|
def _get_cache_key(self) -> str:
|
|
return f"{self.__short_name__}_{self.id}"
|
|
|
|
def _update_cache(self, cache: Optional[Cache] = None) -> None:
|
|
if cache is None:
|
|
return
|
|
|
|
user_dict: Dict[str, Any] = self.to_dict()
|
|
|
|
if user_dict is not None:
|
|
cache.set_json(self._get_cache_key(), user_dict)
|
|
else:
|
|
self._delete_cache(cache)
|
|
|
|
def _delete_cache(self, cache: Optional[Cache] = None) -> None:
|
|
if cache is None:
|
|
return
|
|
|
|
cache.delete(self._get_cache_key())
|
|
|
|
def to_dict(self, json_compatible: bool = False) -> Dict[str, Any]:
|
|
"""Convert PycordGuild object to a JSON representation.
|
|
|
|
Args:
|
|
json_compatible (bool): Whether the JSON-incompatible objects like ObjectId need to be converted
|
|
|
|
Returns:
|
|
Dict[str, Any]: JSON representation of PycordGuild
|
|
"""
|
|
return {
|
|
"_id": self._id if not json_compatible else str(self._id),
|
|
"id": self.id,
|
|
"channel_id": self.channel_id,
|
|
"category_id": self.category_id,
|
|
"timezone": self.timezone,
|
|
"language": self.language,
|
|
}
|
|
|
|
@staticmethod
|
|
def get_defaults(guild_id: Optional[int] = None) -> Dict[str, Any]:
|
|
return {
|
|
"id": guild_id,
|
|
"channel_id": None,
|
|
"category_id": None,
|
|
"timezone": "UTC",
|
|
"language": None,
|
|
}
|
|
|
|
@staticmethod
|
|
def get_default_value(key: str) -> Any:
|
|
if key not in PycordGuild.get_defaults():
|
|
raise KeyError(f"There's no default value for key '{key}' in PycordGuild")
|
|
|
|
return PycordGuild.get_defaults()[key]
|
|
|
|
# TODO Add documentation
|
|
async def update(
|
|
self,
|
|
cache: Optional[Cache] = None,
|
|
**kwargs,
|
|
):
|
|
await self._set(cache=cache, **kwargs)
|
|
|
|
# TODO Add documentation
|
|
async def reset(
|
|
self,
|
|
cache: Optional[Cache] = None,
|
|
*args,
|
|
):
|
|
await self._remove(cache, *args)
|
|
|
|
async def purge(self, cache: Optional[Cache] = None) -> None:
|
|
"""Completely remove guild data from database. Currently only removes the guild record from guilds collection.
|
|
|
|
Args:
|
|
cache (:obj:`Cache`, optional): Cache engine to write the update into
|
|
"""
|
|
await self.__collection__.delete_one({"_id": self._id})
|
|
|
|
self._delete_cache(cache)
|
|
|
|
logger.info("Purged guild %s (%s) from the database", self.id, self._id)
|
|
|
|
# TODO Add documentation
|
|
def is_configured(self) -> bool:
|
|
return (
|
|
(self.id is not None)
|
|
and (self.channel_id is not None)
|
|
and (self.category_id is not None)
|
|
and (self.timezone is not None)
|
|
)
|
|
|
|
# TODO Add documentation
|
|
async def set_channel(self, channel_id: Optional[int] = None, cache: Optional[Cache] = None) -> None:
|
|
await self._set(cache, channel_id=channel_id)
|
|
|
|
# TODO Add documentation
|
|
async def reset_channel(self, cache: Optional[Cache] = None) -> None:
|
|
await self._remove(cache, "channel_id")
|
|
|
|
# TODO Add documentation
|
|
async def set_category(self, category_id: Optional[int] = None, cache: Optional[Cache] = None) -> None:
|
|
await self._set(cache, category_id=category_id)
|
|
|
|
# TODO Add documentation
|
|
async def reset_category(self, cache: Optional[Cache] = None) -> None:
|
|
await self._remove(cache, "category_id")
|
|
|
|
# TODO Add documentation
|
|
async def set_timezone(self, timezone: str, cache: Optional[Cache] = None) -> None:
|
|
await self._set(cache, timezone=timezone)
|
|
|
|
# TODO Add documentation
|
|
async def reset_timezone(self, cache: Optional[Cache] = None) -> None:
|
|
await self._remove(cache, "timezone")
|
|
|
|
# TODO Add documentation
|
|
async def set_language(self, language: str, cache: Optional[Cache] = None) -> None:
|
|
await self._set(cache, language=language)
|
|
|
|
# TODO Add documentation
|
|
async def reset_language(self, cache: Optional[Cache] = None) -> None:
|
|
await self._remove(cache, "language")
|