Merge branch '0.2' into #42

src/bot/application.py

@@ -1,6 +1,6 @@
-from typing import Optional, Type
+from typing import Optional, Type, Callable
 
-from cpl_core.configuration import ConfigurationABC, ConfigurationModelABC
+from cpl_core.configuration import ConfigurationABC
 from cpl_core.console import Console
 from cpl_core.dependency_injection import ServiceProviderABC
 from cpl_core.logging import LoggerABC
@@ -9,13 +9,12 @@ from cpl_discord.configuration import DiscordBotSettings
 from cpl_discord.service import DiscordBotServiceABC, DiscordBotService
 from cpl_translation import TranslatePipe, TranslationServiceABC, TranslationSettings
 
+from bot_core.configuration.bot_logging_settings import BotLoggingSettings
 from bot_core.configuration.bot_settings import BotSettings
-from bot_core.configuration.server_settings import ServerSettings
-from modules.base.configuration.base_server_settings import BaseServerSettings
+from bot_core.logging.command_logger import CommandLogger
+from bot_core.logging.database_logger import DatabaseLogger
 from modules.base.configuration.base_settings import BaseSettings
-from modules.boot_log.configuration.boot_log_server_settings import BootLogServerSettings
 from modules.boot_log.configuration.boot_log_settings import BootLogSettings
-from modules.permission.configuration.permission_server_settings import PermissionServerSettings
 from modules.permission.configuration.permission_settings import PermissionSettings
 
 
@@ -24,6 +23,8 @@ class Application(DiscordBotApplicationABC):
     def __init__(self, config: ConfigurationABC, services: ServiceProviderABC):
         DiscordBotApplicationABC.__init__(self, config, services)
 
+        self._services = services
+
         # cpl-core
         self._logger: LoggerABC = services.get_service(LoggerABC)
         # cpl-discord
@@ -33,31 +34,25 @@ class Application(DiscordBotApplicationABC):
         self._translation: TranslationServiceABC = services.get_service(TranslationServiceABC)
         self._translate: TranslatePipe = services.get_service(TranslatePipe)
 
-    def _configure_settings_with_servers(self, settings: Type, server_settings: Type):
-        settings: Optional[settings] = self._configuration.get_configuration(settings)
-        if settings is None:
-            return
-
-        for server in settings.servers:
-            self._logger.trace(__name__, f'Saved config: {type(server).__name__}_{server.id}')
-            self._configuration.add_configuration(f'{type(server).__name__}_{server.id}', server)
+        self._is_stopping = False
 
     async def configure(self):
         self._translation.load_by_settings(self._configuration.get_configuration(TranslationSettings))
-        self._configure_settings_with_servers(BotSettings, ServerSettings)
-        self._configure_settings_with_servers(BaseSettings, BaseServerSettings)
-        self._configure_settings_with_servers(BootLogSettings, BootLogServerSettings)
-        self._configure_settings_with_servers(PermissionSettings, PermissionServerSettings)
 
     async def main(self):
         try:
             self._logger.debug(__name__, f'Starting...\n')
             self._logger.trace(__name__, f'Try to start {DiscordBotService.__name__}')
             await self._bot.start_async()
+            await self._bot.stop_async()
         except Exception as e:
             self._logger.error(__name__, 'Start failed', e)
 
     async def stop_async(self):
+        if self._is_stopping:
+            return
+
+        self._is_stopping = True
         try:
             self._logger.trace(__name__, f'Try to stop {DiscordBotService.__name__}')
             await self._bot.close()

src/bot/config/appsettings.development.json

@@ -7,16 +7,44 @@
   },
   "LoggingSettings": {
     "Path": "logs/",
-    "Filename": "log_dev.log",
+    "Filename": "bot.log",
     "ConsoleLogLevel": "DEBUG",
     "FileLogLevel": "DEBUG"
   },
+  "BotLoggingSettings": {
+    "Command": {
+      "Path": "logs/",
+      "Filename": "commands.log",
+      "ConsoleLogLevel": "DEBUG",
+      "FileLogLevel": "DEBUG"
+    },
+    "Database": {
+      "Path": "logs/",
+      "Filename": "database.log",
+      "ConsoleLogLevel": "DEBUG",
+      "FileLogLevel": "DEBUG"
+    },
+    "Message": {
+      "Path": "logs/",
+      "Filename": "message.log",
+      "ConsoleLogLevel": "DEBUG",
+      "FileLogLevel": "DEBUG"
+    }
+  },
   "Translation": {
     "DefaultLanguage": "de",
     "Languages": [
       "de"
     ]
   },
+  "FeatureFlags": {
+    "AdminModule": true,
+    "BaseModule": true,
+    "BootLogModule": true,
+    "DatabaseModule": true,
+    "ModeratorModule": true,
+    "PermissionModule": true
+  },
   "DiscordBot": {
     "Token": "OTk4MTU5NjczODkzMDYwNzM4.GN3QyA.yvWO6L7Eu36gXQ7ARDs0Jg2J1VqIDnHLou5lT4",
     "Prefix": "!kd "

src/bot/config/appsettings.edrafts-pc-ubuntu.json

@@ -1,10 +1,30 @@
 {
   "LoggingSettings": {
     "Path": "logs/",
-    "Filename": "log_dev.log",
+    "Filename": "bot.log",
     "ConsoleLogLevel": "DEBUG",
     "FileLogLevel": "TRACE"
   },
+  "BotLoggingSettings": {
+    "Command": {
+      "Path": "logs/",
+      "Filename": "commands.log",
+      "ConsoleLogLevel": "DEBUG",
+      "FileLogLevel": "TRACE"
+    },
+    "Database": {
+      "Path": "logs/",
+      "Filename": "database.log",
+      "ConsoleLogLevel": "DEBUG",
+      "FileLogLevel": "TRACE"
+    },
+    "Message": {
+      "Path": "logs/",
+      "Filename": "message.log",
+      "ConsoleLogLevel": "DEBUG",
+      "FileLogLevel": "TRACE"
+    }
+  },
   "DatabaseSettings": {
     "Host": "localhost",
     "User": "kd_kdb",
@@ -19,6 +39,14 @@
     "Token": "OTk4MTYwNDI3Njg5MTgxMjM3.GI7h67.BqD6Lu1Tz0MuG8iktYrcLnHi1pNozyMiWFGTKI",
     "Prefix": "!ke "
   },
+  "FeatureFlags": {
+    "AdminModule": true,
+    "BaseModule": true,
+    "BootLogModule": true,
+    "DatabaseModule": true,
+    "ModeratorModule": true,
+    "PermissionModule": true
+  },
   "Bot": {
     "910199451145076828": {
       "MessageDeleteTimer": 2

src/bot/config/appsettings.json

@@ -6,9 +6,29 @@
     "DateTimeLogFormat": "%Y-%m-%d_%H-%M-%S"
   },
   "LoggingSettings": {
-    "Path": "logs/",
-    "Filename": "log_$start_time.log",
+    "Path": "logs/$date_now/",
+    "Filename": "bot.log",
     "ConsoleLogLevel": "ERROR",
     "FileLogLevel": "WARN"
+  },
+  "BotLoggingSettings": {
+    "Command": {
+      "Path": "logs/$date_now/",
+      "Filename": "commands.log",
+      "ConsoleLogLevel": "ERROR",
+      "FileLogLevel": "WARN"
+    },
+    "Database": {
+      "Path": "logs/$date_now/",
+      "Filename": "database.log",
+      "ConsoleLogLevel": "ERROR",
+      "FileLogLevel": "WARN"
+    },
+    "Message": {
+      "Path": "logs/$date_now/",
+      "Filename": "message.log",
+      "ConsoleLogLevel": "ERROR",
+      "FileLogLevel": "WARN"
+    }
   }
 }

src/bot/config/appsettings.production.json

@@ -6,11 +6,31 @@
     "DateTimeLogFormat": "%Y-%m-%d_%H-%M-%S"
   },
   "LoggingSettings": {
-    "Path": "logs/",
-    "Filename": "log_$start_time.log",
+    "Path": "logs/$date_now/",
+    "Filename": "bot.log",
     "ConsoleLogLevel": "ERROR",
     "FileLogLevel": "INFO"
   },
+  "BotLoggingSettings": {
+    "Command": {
+      "Path": "logs/$date_now/",
+      "Filename": "commands.log",
+      "ConsoleLogLevel": "ERROR",
+      "FileLogLevel": "INFO"
+    },
+    "Database": {
+      "Path": "logs/$date_now/",
+      "Filename": "database.log",
+      "ConsoleLogLevel": "ERROR",
+      "FileLogLevel": "INFO"
+    },
+    "Message": {
+      "Path": "logs/$date_now/",
+      "Filename": "message.log",
+      "ConsoleLogLevel": "ERROR",
+      "FileLogLevel": "INFO"
+    }
+  },
   "Translation": {
     "DefaultLanguage": "de",
     "Languages": [
@@ -18,7 +38,7 @@
     ]
   },
   "DatabaseSettings": {
-    "Host": "192.168.0.40",
+    "Host": "localhost",
     "User": "kd_kdb",
     "Password": "a2Rfa2Ri",
     "Database": "kd_kdb",
@@ -28,6 +48,14 @@
     "Buffered": "true",
     "AuthPlugin": "mysql_native_password"
   },
+  "FeatureFlags": {
+    "AdminModule": true,
+    "BaseModule": true,
+    "BootLogModule": true,
+    "DatabaseModule": true,
+    "ModeratorModule": true,
+    "PermissionModule": true
+  },
   "Bot": {
     "650366049023295514": {
       "MessageDeleteTimer": 2

src/bot/config/appsettings.staging.json

@@ -6,17 +6,56 @@
     "DateTimeLogFormat": "%Y-%m-%d_%H-%M-%S"
   },
   "LoggingSettings": {
-    "Path": "logs/",
-    "Filename": "log_staging_$start_time.log",
+    "Path": "logs/$date_now/",
+    "Filename": "bot.log",
     "ConsoleLogLevel": "INFO",
     "FileLogLevel": "DEBUG"
   },
+  "BotLoggingSettings": {
+    "Command": {
+      "Path": "logs/$date_now/",
+      "Filename": "commands.log",
+      "ConsoleLogLevel": "INFO",
+      "FileLogLevel": "DEBUG"
+    },
+    "Database": {
+      "Path": "logs/$date_now/",
+      "Filename": "database.log",
+      "ConsoleLogLevel": "INFO",
+      "FileLogLevel": "DEBUG"
+    },
+    "Message": {
+      "Path": "logs/$date_now/",
+      "Filename": "message.log",
+      "ConsoleLogLevel": "INFO",
+      "FileLogLevel": "DEBUG"
+    }
+  },
   "Translation": {
     "DefaultLanguage": "de",
     "Languages": [
       "de"
     ]
   },
+  "DatabaseSettings": {
+    "Host": "localhost",
+    "User": "kd_kdb",
+    "Password": "a2Rfa2Ri",
+    "Database": "kd_kdb",
+    "Port": "3308",
+    "Charset": "utf8mb4",
+    "UseUnicode": "true",
+    "Buffered": "true",
+    "AuthPlugin": "mysql_native_password"
+  },
+  "FeatureFlags": {
+    "AdminModule": true,
+    "BaseModule": true,
+    "BootLogModule": true,
+    "DatabaseModule": true,
+    "ModeratorModule": true,
+    "PermissionModule": true
+  },
   "Bot": {
     "910199451145076828": {
       "MessageDeleteTimer": 4

src/bot/main.py

@@ -8,6 +8,7 @@ from bot.application import Application
 from bot.startup import Startup
 from bot.startup_discord_extension import StartupDiscordExtension
 from bot.startup_migration_extension import StartupMigrationExtension
+from bot.startup_settings_extension import StartupSettingsExtension
 from modules.boot_log.boot_log_extension import BootLogExtension
 from modules.database.database_extension import DatabaseExtension
 
@@ -18,12 +19,13 @@ class Program:
         self.app: Optional[Application] = None
 
     async def start(self):
-        app_builder = ApplicationBuilder(Application)
-        app_builder.use_extension(StartupDiscordExtension)
-        app_builder.use_extension(StartupMigrationExtension)
-        app_builder.use_extension(BootLogExtension)
-        app_builder.use_extension(DatabaseExtension)
-        app_builder.use_startup(Startup)
+        app_builder = ApplicationBuilder(Application) \
+            .use_extension(StartupSettingsExtension) \
+            .use_extension(StartupDiscordExtension) \
+            .use_extension(StartupMigrationExtension) \
+            .use_extension(BootLogExtension) \
+            .use_extension(DatabaseExtension) \
+            .use_startup(Startup)
         self.app: Application = await app_builder.build_async()
         await self.app.run_async()
 

src/bot/startup.py

@@ -7,9 +7,14 @@ from cpl_core.configuration import ConfigurationABC
 from cpl_core.database import DatabaseSettings
 from cpl_core.dependency_injection import ServiceProviderABC, ServiceCollectionABC
 from cpl_core.environment import ApplicationEnvironment
+from cpl_core.logging import LoggerABC
 
 from bot_core.abc.client_utils_service_abc import ClientUtilsServiceABC
+from bot_core.abc.custom_file_logger_abc import CustomFileLoggerABC
 from bot_core.abc.message_service_abc import MessageServiceABC
+from bot_core.logging.command_logger import CommandLogger
+from bot_core.logging.database_logger import DatabaseLogger
+from bot_core.logging.message_logger import MessageLogger
 from bot_core.pipes.date_time_offset_pipe import DateTimeOffsetPipe
 from bot_core.service.client_utils_service import ClientUtilsService
 from bot_core.service.message_service import MessageService
@@ -41,21 +46,16 @@ class Startup(StartupABC):
         self._config: Optional[ConfigurationABC] = None
 
     def configure_configuration(self, configuration: ConfigurationABC, environment: ApplicationEnvironment) -> ConfigurationABC:
-        environment.set_working_directory(os.path.dirname(os.path.realpath(__file__)))
-        configuration.add_environment_variables('KDB_')
-        configuration.add_environment_variables('DISCORD_')
-
-        configuration.add_json_file(f'config/appsettings.json', optional=False)
-        configuration.add_json_file(f'config/appsettings.{environment.environment_name}.json', optional=True)
-        configuration.add_json_file(f'config/appsettings.{environment.host_name}.json', optional=True)
-
-        configuration.add_configuration('Startup_StartTime', str(self._start_time))
-
         self._config = configuration
         return configuration
 
     def configure_services(self, services: ServiceCollectionABC, environment: ApplicationEnvironment) -> ServiceProviderABC:
         services.add_logging()
+        # custom logging
+        services.add_singleton(LoggerABC, CommandLogger)
+        services.add_singleton(LoggerABC, DatabaseLogger)
+        services.add_singleton(LoggerABC, MessageLogger)
+
         services.add_translation()
 
         services.add_db_context(DBContext, self._config.get_configuration(DatabaseSettings))
@@ -79,4 +79,9 @@ class Startup(StartupABC):
         services.add_transient(UserJoinedServerRepositoryABC, UserJoinedServerRepositoryService)
         services.add_transient(UserJoinedVoiceChannelRepositoryABC, UserJoinedVoiceChannelRepositoryService)
 
-        return services.build_service_provider()
+        provider = services.build_service_provider()
+        # instantiate custom logger
+        for c in CustomFileLoggerABC.__subclasses__():
+            i: LoggerABC = provider.get_service(c)
+
+        return provider

src/bot/startup_discord_extension.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from cpl_core.application import StartupExtensionABC
 from cpl_core.configuration import ConfigurationABC
 from cpl_core.dependency_injection import ServiceCollectionABC
@@ -5,6 +7,7 @@ from cpl_core.environment import ApplicationEnvironmentABC
 from cpl_discord import get_discord_collection
 from cpl_discord.discord_event_types_enum import DiscordEventTypesEnum
 
+from bot_core.configuration.feature_flags_settings import FeatureFlagsSettings
 from modules.admin.command.restart_command import RestartCommand
 from modules.admin.command.shutdown_command import ShutdownCommand
 from modules.base.command.afk_command import AFKCommand
@@ -12,6 +15,7 @@ from modules.base.command.help_command import HelpCommand
 from modules.base.command.info_command import InfoCommand
 from modules.base.command.ping_command import PingCommand
 from modules.base.events.base_on_command_error_event import BaseOnCommandErrorEvent
+from modules.base.events.base_on_command_event import BaseOnCommandEvent
 from modules.moderator.command.purge_command import PurgeCommand
 from modules.base.command.user_info_command import UserInfoCommand
 from modules.base.events.base_on_member_join_event import BaseOnMemberJoinEvent
@@ -27,40 +31,54 @@ from modules.permission.events.permission_on_ready_event import PermissionOnRead
 class StartupDiscordExtension(StartupExtensionABC):
 
     def __init__(self):
-        pass
+        self._feature_flags: Optional[FeatureFlagsSettings] = None
 
     def configure_configuration(self, config: ConfigurationABC, env: ApplicationEnvironmentABC):
-        pass
+        self._feature_flags = config.get_configuration(FeatureFlagsSettings)
 
     def configure_services(self, services: ServiceCollectionABC, env: ApplicationEnvironmentABC):
         services.add_discord()
         dc = get_discord_collection(services)
-        """ commands """
-        # admin
-        dc.add_command(RestartCommand)
-        dc.add_command(ShutdownCommand)
-        # moderator
-        dc.add_command(PurgeCommand)
-        # simple
-        dc.add_command(AFKCommand)
-        dc.add_command(HelpCommand)
-        dc.add_command(InfoCommand)
-        dc.add_command(PingCommand)
-        dc.add_command(UserInfoCommand)
-        """ events """
-        # on_command_error
-        dc.add_event(DiscordEventTypesEnum.on_command_error.value, BaseOnCommandErrorEvent)
-        # on_member_join
-        dc.add_event(DiscordEventTypesEnum.on_member_join.value, BaseOnMemberJoinEvent)
-        # on_member_remove
-        dc.add_event(DiscordEventTypesEnum.on_member_join.value, BaseOnMemberRemoveEvent)
-        # on_member_update
-        dc.add_event(DiscordEventTypesEnum.on_member_update.value, PermissionOnMemberUpdateEvent)
-        # on_message
-        dc.add_event(DiscordEventTypesEnum.on_message.value, BaseOnMessageEvent)
-        # on_voice_state_update
-        dc.add_event(DiscordEventTypesEnum.on_voice_state_update.value, BaseOnVoiceStateUpdateEvent)
-        # on_ready
-        dc.add_event(DiscordEventTypesEnum.on_ready.value, DatabaseOnReadyEvent)
-        dc.add_event(DiscordEventTypesEnum.on_ready.value, PermissionOnReadyEvent)
-        dc.add_event(DiscordEventTypesEnum.on_ready.value, BootLogOnReadyEvent)  # has to be last
+        """modules"""
+        if self._feature_flags.admin_module:
+            """ commands """
+            dc.add_command(RestartCommand)
+            dc.add_command(ShutdownCommand)
+            """ events """
+
+        if self._feature_flags.base_module:
+            """ commands """
+            dc.add_command(AFKCommand)
+            dc.add_command(HelpCommand)
+            dc.add_command(InfoCommand)
+            dc.add_command(PingCommand)
+            dc.add_command(UserInfoCommand)
+            """ events """
+            dc.add_event(DiscordEventTypesEnum.on_command.value, BaseOnCommandEvent)
+            dc.add_event(DiscordEventTypesEnum.on_command_error.value, BaseOnCommandErrorEvent)
+            dc.add_event(DiscordEventTypesEnum.on_member_join.value, BaseOnMemberJoinEvent)
+            dc.add_event(DiscordEventTypesEnum.on_member_join.value, BaseOnMemberRemoveEvent)
+            dc.add_event(DiscordEventTypesEnum.on_message.value, BaseOnMessageEvent)
+            dc.add_event(DiscordEventTypesEnum.on_voice_state_update.value, BaseOnVoiceStateUpdateEvent)
+
+        if self._feature_flags.database_module:
+            """ commands """
+            """ events """
+            dc.add_event(DiscordEventTypesEnum.on_ready.value, DatabaseOnReadyEvent)
+
+        if self._feature_flags.moderator_module:
+            """ commands """
+            dc.add_command(PurgeCommand)
+            """ events """
+
+        if self._feature_flags.permission_module:
+            """ commands """
+            """ events """
+            dc.add_event(DiscordEventTypesEnum.on_ready.value, PermissionOnReadyEvent)
+            dc.add_event(DiscordEventTypesEnum.on_member_update.value, PermissionOnMemberUpdateEvent)
+
+        # has to be last!
+        if self._feature_flags.boot_log_module:
+            """ commands """
+            """ events """
+            dc.add_event(DiscordEventTypesEnum.on_ready.value, BootLogOnReadyEvent)

src/bot/startup_settings_extension.py

@@ -0,0 +1,52 @@
+import os
+from datetime import datetime
+from typing import Callable, Type, Optional
+
+from cpl_core.application import StartupExtensionABC
+from cpl_core.configuration import ConfigurationABC
+from cpl_core.dependency_injection import ServiceCollectionABC
+from cpl_core.environment import ApplicationEnvironmentABC
+from cpl_core.logging import LoggerABC
+
+from bot_core.configuration.bot_logging_settings import BotLoggingSettings
+from bot_core.configuration.bot_settings import BotSettings
+from bot_core.logging.command_logger import CommandLogger
+from bot_core.logging.database_logger import DatabaseLogger
+from modules.base.configuration.base_settings import BaseSettings
+from modules.boot_log.configuration.boot_log_settings import BootLogSettings
+from modules.permission.configuration.permission_settings import PermissionSettings
+
+
+class StartupSettingsExtension(StartupExtensionABC):
+
+    def __init__(self):
+        self._start_time = datetime.now()
+
+    def configure_configuration(self, configuration: ConfigurationABC, environment: ApplicationEnvironmentABC):
+        # this shit has to be done here because we need settings in subsequent startup extensions
+        environment.set_working_directory(os.path.dirname(os.path.realpath(__file__)))
+        configuration.add_environment_variables('KDB_')
+        configuration.add_environment_variables('DISCORD_')
+
+        configuration.add_json_file(f'config/appsettings.json', optional=False)
+        configuration.add_json_file(f'config/appsettings.{environment.environment_name}.json', optional=True)
+        configuration.add_json_file(f'config/appsettings.{environment.host_name}.json', optional=True)
+
+        configuration.add_configuration('Startup_StartTime', str(self._start_time))
+        self._configure_settings_with_sub_settings(configuration, BotSettings, lambda x: x.servers, lambda x: x.id)
+        self._configure_settings_with_sub_settings(configuration, BaseSettings, lambda x: x.servers, lambda x: x.id)
+        self._configure_settings_with_sub_settings(configuration, BootLogSettings, lambda x: x.servers, lambda x: x.id)
+        self._configure_settings_with_sub_settings(configuration, PermissionSettings, lambda x: x.servers, lambda x: x.id)
+        self._configure_settings_with_sub_settings(configuration, BotLoggingSettings, lambda x: x.files, lambda x: x.key)
+
+    def configure_services(self, services: ServiceCollectionABC, env: ApplicationEnvironmentABC):
+        pass
+
+    @staticmethod
+    def _configure_settings_with_sub_settings(config: ConfigurationABC, settings: Type, list_atr: Callable, atr: Callable):
+        settings: Optional[settings] = config.get_configuration(settings)
+        if settings is None:
+            return
+
+        for sub_settings in list_atr(settings):
+            config.add_configuration(f'{type(sub_settings).__name__}_{atr(sub_settings)}', sub_settings)