Moved bot to kdb-bot #70

kdb-bot/src/modules/permission/__init__.py

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+
+"""
+bot Keksdose bot
+~~~~~~~~~~~~~~~~~~~
+
+Discord bot  for the Keksdose discord Server
+
+:copyright: (c) 2022 sh-edraft.de
+:license: MIT, see LICENSE for more details.
+
+"""
+
+__title__ = 'modules.permission'
+__author__ = 'Sven Heidemann'
+__license__ = 'MIT'
+__copyright__ = 'Copyright (c) 2022 sh-edraft.de'
+__version__ = '0.2.3'
+
+from collections import namedtuple
+
+
+# imports: 
+
+VersionInfo = namedtuple('VersionInfo', 'major minor micro')
+version_info = VersionInfo(major='0', minor='2', micro='3')

kdb-bot/src/modules/permission/abc/__init__.py

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+
+"""
+bot Keksdose bot
+~~~~~~~~~~~~~~~~~~~
+
+Discord bot  for the Keksdose discord Server
+
+:copyright: (c) 2022 sh-edraft.de
+:license: MIT, see LICENSE for more details.
+
+"""
+
+__title__ = 'modules.permission.abc'
+__author__ = 'Sven Heidemann'
+__license__ = 'MIT'
+__copyright__ = 'Copyright (c) 2022 sh-edraft.de'
+__version__ = '0.2.3'
+
+from collections import namedtuple
+
+
+# imports
+
+VersionInfo = namedtuple('VersionInfo', 'major minor micro')
+version_info = VersionInfo(major='0', minor='2', micro='3')

kdb-bot/src/modules/permission/abc/permission_service_abc.py

@@ -0,0 +1,45 @@
+from abc import ABC, abstractmethod
+
+import discord
+
+
+class PermissionServiceABC(ABC):
+
+    @abstractmethod
+    def __init__(self): pass
+
+    @abstractmethod
+    def on_ready(self): pass
+
+    @abstractmethod
+    def on_member_update(self, before: discord.Member, after: discord.Member): pass
+
+    @abstractmethod
+    def get_admin_role_ids(self, g_id: int) -> list[int]: pass
+
+    @abstractmethod
+    def get_admin_roles(self, g_id: int) -> list[discord.Role]: pass
+
+    @abstractmethod
+    def get_admins(self, g_id: int) -> list[discord.Member]: pass
+
+    @abstractmethod
+    def get_moderator_role_ids(self, g_id: int) -> list[int]: pass
+
+    @abstractmethod
+    def get_moderator_roles(self, g_id: int) -> list[discord.Role]: pass
+
+    @abstractmethod
+    def get_moderators(self, g_id: int) -> list[discord.Member]: pass
+
+    @abstractmethod
+    def get_technicians(self) -> list[discord.Member]: pass
+
+    @abstractmethod
+    def is_member_admin(self, member: discord.Member) -> bool: pass
+
+    @abstractmethod
+    def is_member_moderator(self, member: discord.Member) -> bool: pass
+
+    @abstractmethod
+    def is_member_technician(self, member: discord.Member) -> bool: pass

kdb-bot/src/modules/permission/configuration/__init__.py

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+
+"""
+bot Keksdose bot
+~~~~~~~~~~~~~~~~~~~
+
+Discord bot  for the Keksdose discord Server
+
+:copyright: (c) 2022 sh-edraft.de
+:license: MIT, see LICENSE for more details.
+
+"""
+
+__title__ = 'modules.permission.configuration'
+__author__ = 'Sven Heidemann'
+__license__ = 'MIT'
+__copyright__ = 'Copyright (c) 2022 sh-edraft.de'
+__version__ = '0.2.3'
+
+from collections import namedtuple
+
+
+# imports
+
+VersionInfo = namedtuple('VersionInfo', 'major minor micro')
+version_info = VersionInfo(major='0', minor='2', micro='3')

kdb-bot/src/modules/permission/configuration/permission_server_settings.py

@@ -0,0 +1,38 @@
+import traceback
+
+from cpl_core.configuration.configuration_model_abc import ConfigurationModelABC
+from cpl_core.console import Console
+
+
+class PermissionServerSettings(ConfigurationModelABC):
+
+    def __init__(self):
+        ConfigurationModelABC.__init__(self)
+
+        self._id: int = 0
+        self._admin_roles: list[int] = []
+        self._moderator_roles: list[int] = []
+
+    @property
+    def id(self) -> int:
+        return self._id
+
+    @property
+    def admin_roles(self) -> list[int]:
+        return self._admin_roles
+
+    @property
+    def moderator_roles(self) -> list[int]:
+        return self._moderator_roles
+
+    def from_dict(self, settings: dict):
+        try:
+            self._id = int(settings['Id'])
+            for index in settings['AdminRoleIds']:
+                self._admin_roles.append(int(index))
+            
+            for index in settings['ModeratorRoleIds']:
+                self._moderator_roles.append(int(index))
+        except Exception as e:
+            Console.error(f'[ ERROR ] [ {__name__} ]: Reading error in {self.__name__} settings')
+            Console.error(f'[ EXCEPTION ] [ {__name__} ]: {e} -> {traceback.format_exc()}')

kdb-bot/src/modules/permission/configuration/permission_settings.py

@@ -0,0 +1,32 @@
+import traceback
+
+from cpl_core.configuration.configuration_model_abc import ConfigurationModelABC
+from cpl_core.console import Console
+from cpl_query.extension import List
+
+from modules.permission.configuration.permission_server_settings import PermissionServerSettings
+
+
+class PermissionSettings(ConfigurationModelABC):
+
+    def __init__(self):
+        ConfigurationModelABC.__init__(self)
+
+        self._servers: List[PermissionServerSettings] = List()
+
+    @property
+    def servers(self) -> List[PermissionServerSettings]:
+        return self._servers
+
+    def from_dict(self, settings: dict):
+        try:
+            servers = List(PermissionServerSettings)
+            for s in settings:
+                st = PermissionServerSettings()
+                settings[s]['Id'] = s
+                st.from_dict(settings[s])
+                servers.append(st)
+            self._servers = servers
+        except Exception as e:
+            Console.error(f'[ ERROR ] [ {__name__} ]: Reading error in {type(self).__name__} settings')
+            Console.error(f'[ EXCEPTION ] [ {__name__} ]: {e} -> {traceback.format_exc()}')

kdb-bot/src/modules/permission/events/__init__.py

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+
+"""
+bot Keksdose bot
+~~~~~~~~~~~~~~~~~~~
+
+Discord bot  for the Keksdose discord Server
+
+:copyright: (c) 2022 sh-edraft.de
+:license: MIT, see LICENSE for more details.
+
+"""
+
+__title__ = 'modules.permission.events'
+__author__ = 'Sven Heidemann'
+__license__ = 'MIT'
+__copyright__ = 'Copyright (c) 2022 sh-edraft.de'
+__version__ = '0.2.3'
+
+from collections import namedtuple
+
+
+# imports:
+
+VersionInfo = namedtuple('VersionInfo', 'major minor micro')
+version_info = VersionInfo(major='0', minor='2', micro='3')

kdb-bot/src/modules/permission/events/permission_on_member_update_event.py

@@ -0,0 +1,19 @@
+import discord
+from cpl_core.logging import LoggerABC
+from cpl_discord.events import OnMemberUpdateABC
+
+from modules.permission.abc.permission_service_abc import PermissionServiceABC
+
+
+class PermissionOnMemberUpdateEvent(OnMemberUpdateABC):
+
+    def __init__(self, logger: LoggerABC, permission_service: PermissionServiceABC):
+        OnMemberUpdateABC.__init__(self)
+        self._logger = logger
+        self._permission_service = permission_service
+
+    async def on_member_update(self, before: discord.Member, after: discord.Member):
+        self._logger.debug(__name__, f'Module {type(self)} started')
+
+        if before.roles != after.roles:
+            self._permission_service.on_member_update(before, after)

kdb-bot/src/modules/permission/events/permission_on_ready_event.py

@@ -0,0 +1,16 @@
+from cpl_core.logging import LoggerABC
+from cpl_discord.events import OnReadyABC
+
+from modules.permission.abc.permission_service_abc import PermissionServiceABC
+
+
+class PermissionOnReadyEvent(OnReadyABC):
+
+    def __init__(self, logger: LoggerABC, permission_service: PermissionServiceABC):
+        OnReadyABC.__init__(self)
+        self._logger = logger
+        self._permission_service = permission_service
+
+    async def on_ready(self):
+        self._logger.debug(__name__, f'Module {type(self)} started')
+        self._permission_service.on_ready()

kdb-bot/src/modules/permission/permission.json

@@ -0,0 +1,46 @@
+{
+  "ProjectSettings": {
+    "Name": "permission",
+    "Version": {
+      "Major": "0",
+      "Minor": "0",
+      "Micro": "0"
+    },
+    "Author": "",
+    "AuthorEmail": "",
+    "Description": "",
+    "LongDescription": "",
+    "URL": "",
+    "CopyrightDate": "",
+    "CopyrightName": "",
+    "LicenseName": "",
+    "LicenseDescription": "",
+    "Dependencies": [
+      "cpl-core>=2022.10.0.post2"
+    ],
+    "DevDependencies": [
+      "cpl-cli==2022.10.0"
+    ],
+    "PythonVersion": ">=3.10.4",
+    "PythonPath": {
+      "linux": ""
+    },
+    "Classifiers": []
+  },
+  "BuildSettings": {
+    "ProjectType": "library",
+    "SourcePath": "",
+    "OutputPath": "../../dist",
+    "Main": "permission.main",
+    "EntryPoint": "permission",
+    "IncludePackageData": false,
+    "Included": [],
+    "Excluded": [
+      "*/__pycache__",
+      "*/logs",
+      "*/tests"
+    ],
+    "PackageData": {},
+    "ProjectReferences": []
+  }
+}

kdb-bot/src/modules/permission/permission_module.py

@@ -0,0 +1,28 @@
+from cpl_core.configuration import ConfigurationABC
+from cpl_core.dependency_injection import ServiceCollectionABC
+from cpl_core.environment import ApplicationEnvironmentABC
+from cpl_discord.discord_event_types_enum import DiscordEventTypesEnum
+from cpl_discord.service.discord_collection_abc import DiscordCollectionABC
+
+from bot_core.abc.module_abc import ModuleABC
+from bot_core.configuration.feature_flags_enum import FeatureFlagsEnum
+from modules.permission.abc.permission_service_abc import PermissionServiceABC
+from modules.permission.events.permission_on_member_update_event import PermissionOnMemberUpdateEvent
+from modules.permission.events.permission_on_ready_event import PermissionOnReadyEvent
+from modules.permission.service.permission_service import PermissionService
+
+
+class PermissionModule(ModuleABC):
+
+    def __init__(self, dc: DiscordCollectionABC):
+        ModuleABC.__init__(self, dc, FeatureFlagsEnum.permission_module)
+
+    def configure_configuration(self, config: ConfigurationABC, env: ApplicationEnvironmentABC):
+        pass
+
+    def configure_services(self, services: ServiceCollectionABC, env: ApplicationEnvironmentABC):
+        services.add_singleton(PermissionServiceABC, PermissionService)
+        # commands
+        # events
+        self._dc.add_event(DiscordEventTypesEnum.on_ready.value, PermissionOnReadyEvent)
+        self._dc.add_event(DiscordEventTypesEnum.on_member_update.value, PermissionOnMemberUpdateEvent)

kdb-bot/src/modules/permission/service/__init__.py

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+
+"""
+bot Keksdose bot
+~~~~~~~~~~~~~~~~~~~
+
+Discord bot  for the Keksdose discord Server
+
+:copyright: (c) 2022 sh-edraft.de
+:license: MIT, see LICENSE for more details.
+
+"""
+
+__title__ = 'modules.permission.service'
+__author__ = 'Sven Heidemann'
+__license__ = 'MIT'
+__copyright__ = 'Copyright (c) 2022 sh-edraft.de'
+__version__ = '0.2.3'
+
+from collections import namedtuple
+
+
+# imports
+
+VersionInfo = namedtuple('VersionInfo', 'major minor micro')
+version_info = VersionInfo(major='0', minor='2', micro='3')

kdb-bot/src/modules/permission/service/permission_service.py

@@ -0,0 +1,135 @@
+import discord
+from cpl_core.logging import LoggerABC
+from cpl_core.configuration import ConfigurationABC
+from cpl_discord.service import DiscordBotServiceABC
+
+from bot_core.configuration.bot_settings import BotSettings
+from modules.permission.abc.permission_service_abc import PermissionServiceABC
+from modules.permission.configuration.permission_server_settings import PermissionServerSettings
+
+
+class PermissionService(PermissionServiceABC):
+
+    def __init__(
+            self,
+            logger: LoggerABC,
+            bot: DiscordBotServiceABC,
+            config: ConfigurationABC,
+            bot_settings: BotSettings
+    ):
+        PermissionServiceABC.__init__(self)
+        self._logger = logger
+        self._bot = bot
+        self._config = config
+
+        self._admin_role_ids: dict[int, list[int]] = {}
+        self._admin_roles: dict[int, list[discord.Role]] = {}
+        self._admins: dict[int, list[discord.Member]] = {}
+
+        self._moderator_role_ids: dict[int, list[int]] = {}
+        self._moderator_roles: dict[int, list[discord.Role]] = {}
+        self._moderators: dict[int, list[discord.Member]] = {}
+
+        self._technician_ids: list[int] = bot_settings.technicians
+        self._technicians: list[discord.Member] = []
+
+    def on_ready(self):
+        for guild in self._bot.guilds:
+            guild: discord.Guild = guild
+            self._logger.debug(__name__, f'Validate permission settings')
+
+            for technician_id in self._technician_ids:
+                technician = guild.get_member(technician_id)
+                if technician is None:
+                    continue
+                self._technicians.append(technician)
+
+            settings: PermissionServerSettings = self._config.get_configuration(f'PermissionServerSettings_{guild.id}')
+            if settings is None:
+                self._logger.error(__name__, 'Permission settings not found')
+                return
+
+            self._admin_role_ids[guild.id] = settings.admin_roles
+            self._moderator_role_ids[guild.id] = settings.moderator_roles
+
+            admin_roles = []
+            admins = []
+
+            mod_roles = []
+            mods = []
+
+            for role in guild.roles:
+                role: discord.Role = role
+
+                if role.id in self._admin_role_ids[guild.id]:
+                    admin_roles.append(role)
+                    self._logger.trace(__name__, f'Added admin role {role}')
+
+                    for member in role.members:
+                        admins.append(member)
+                        self._logger.trace(__name__, f'Added admin {member}')
+
+                if role.id in self._moderator_role_ids[guild.id]:
+                    mod_roles.append(role)
+                    self._logger.trace(__name__, f'Added moderator role {role}')
+
+                    for member in role.members:
+                        mods.append(member)
+                        self._logger.trace(__name__, f'Added moderator {member}')
+
+            self._admin_roles[guild.id] = admin_roles
+            self._admins[guild.id] = admins
+            self._moderator_roles[guild.id] = mod_roles
+            self._moderators[guild.id] = mods
+
+    def on_member_update(self, before: discord.Member, after: discord.Member):
+        g_id = after.guild.id
+
+        for admin_role in self._admin_roles[g_id]:
+            if admin_role in before.roles and admin_role not in after.roles:
+                self._admins[g_id].remove(after)
+                self._logger.trace(__name__, f'Removed {after.id} from admins')
+
+            elif admin_role in after.roles and admin_role not in before.roles:
+                self._admins[g_id].append(after)
+                self._logger.trace(__name__, f'Added {after.id} to admins')
+
+        for moderator_role in self._moderator_roles[g_id]:
+            if moderator_role in before.roles and moderator_role not in after.roles:
+                self._moderators[g_id].remove(after)
+                self._logger.trace(__name__, f'Removed {after.id} from moderators')
+
+            elif moderator_role in after.roles and moderator_role not in before.roles:
+                self._moderators[g_id].append(after)
+                self._logger.trace(__name__, f'Added {after.id} to moderators')
+
+    def get_admin_role_ids(self, g_id: int) -> list[int]:
+        return self._admin_role_ids[g_id]
+
+    def get_admin_roles(self, g_id: int) -> list[discord.Role]:
+        return self._admin_roles[g_id]
+
+    def get_admins(self, g_id: int) -> list[discord.Member]:
+        return self._admins[g_id]
+
+    def get_moderator_role_ids(self, g_id: int) -> list[int]:
+        return self._moderator_role_ids[g_id]
+
+    def get_moderator_roles(self, g_id: int) -> list[discord.Role]:
+        return self._moderator_roles[g_id]
+
+    def get_moderators(self, g_id: int) -> list[discord.Member]:
+        return self._moderators[g_id]
+
+    def get_technicians(self) -> list[discord.Member]:
+        return self._technicians
+
+    def is_member_admin(self, member: discord.Member) -> bool:
+        return member.guild.id in self._admins and member in self._admins[member.guild.id]
+
+    def is_member_moderator(self, member: discord.Member) -> bool:
+        return member.guild.id in self._moderators \
+               and member in self._moderators[member.guild.id] or self.is_member_admin(member)
+
+    def is_member_technician(self, member: discord.Member) -> bool:
+        return member in self._technicians