Ebola-Chan/kd_discord_bot
1
0
Fork 0
forked from sh-edraft.de/sh_discord_bot
Code Issues Pull Requests Projects Releases Wiki Activity

Added custom logging support #45

Browse Source
This commit is contained in:
Sven Heidemann
2022-10-02 12:14:44 +02:00
parent 6e5e5d4550
commit 12cd5c9045
20 changed files with 286 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
src/bot/application.py
View File

@@ -1,4 +1,4 @@
from typing import Optional, Type
from typing import Optional, Type, Callable
from cpl_core.configuration import ConfigurationABC, ConfigurationModelABC
from cpl_core.console import Console
@@ -9,8 +9,11 @@ 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 bot_core.logging.command_logger import CommandLogger
from bot_core.logging.event_logger import EventLogger
from modules.base.configuration.base_server_settings import BaseServerSettings
from modules.base.configuration.base_settings import BaseSettings
from modules.boot_log.configuration.boot_log_server_settings import BootLogServerSettings
@@ -24,6 +27,10 @@ class Application(DiscordBotApplicationABC):
def __init__(self, config: ConfigurationABC, services: ServiceProviderABC):
DiscordBotApplicationABC.__init__(self, config, services)
self._services = services
self._cmd_logger: Optional[LoggerABC] = None
self._event_logger: Optional[LoggerABC] = None
# cpl-core
self._logger: LoggerABC = services.get_service(LoggerABC)
# cpl-discord
@@ -33,27 +40,32 @@ 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):
def _configure_settings_with_sub_settings(self, settings: Type, list_atr: Callable, atr: Callable):
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)
for sub_settings in list_atr(settings):
self._logger.trace(__name__, f'Saved config: {type(sub_settings).__name__}_{atr(sub_settings)}')
self._configuration.add_configuration(f'{type(sub_settings).__name__}_{atr(sub_settings)}', sub_settings)
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)
self._configure_settings_with_sub_settings(BotSettings, lambda x: x.servers, lambda x: x.id)
self._configure_settings_with_sub_settings(BaseSettings, lambda x: x.servers, lambda x: x.id)
self._configure_settings_with_sub_settings(BootLogSettings, lambda x: x.servers, lambda x: x.id)
self._configure_settings_with_sub_settings(PermissionSettings, lambda x: x.servers, lambda x: x.id)
self._configure_settings_with_sub_settings(BotLoggingSettings, lambda x: x.files, lambda x: x.key)
# custom loggers need to be loaded AFTER config is loaded correctly
self._cmd_logger: LoggerABC = self._services.get_service(CommandLogger)
self._event_logger: LoggerABC = self._services.get_service(EventLogger)
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)

16
src/bot/config/appsettings.edrafts-pc-ubuntu.json
View File

@@ -1,10 +1,24 @@
{
"LoggingSettings": {
"Path": "logs/",
"Filename": "log_dev.log",
"Filename": "dev.log",
"ConsoleLogLevel": "DEBUG",
"FileLogLevel": "TRACE"
},
"BotLoggingSettings": {
"Command": {
"Path": "logs/",
"Filename": "commands.log",
"ConsoleLogLevel": "DEBUG",
"FileLogLevel": "TRACE"
},
"Event": {
"Path": "logs/",
"Filename": "event.log",
"ConsoleLogLevel": "DEBUG",
"FileLogLevel": "TRACE"
}
},
"DatabaseSettings": {
"Host": "localhost",
"User": "kd_kdb",

29
src/bot/startup.py
View File

@@ -1,3 +1,5 @@
import os
from datetime import datetime
from typing import Optional
from cpl_core.application import StartupABC
@@ -5,10 +7,13 @@ 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.message_service_abc import MessageServiceABC
from bot_core.configuration.feature_flags_settings import FeatureFlagsSettings
from bot_core.logging.command_logger import CommandLogger
from bot_core.logging.event_logger import EventLogger
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
@@ -35,23 +40,36 @@ class Startup(StartupABC):
def __init__(self):
StartupABC.__init__(self)
self._start_time = datetime.now()
self._config: Optional[ConfigurationABC] = None
self._feature_flags: Optional[FeatureFlagsSettings] = 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
self._feature_flags = configuration.get_configuration(FeatureFlagsSettings)
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, EventLogger)
services.add_translation()
services.add_db_context(DBContext, self._config.get_configuration(DatabaseSettings))
# general services
if self._feature_flags.base_module:
services.add_transient(BaseHelperABC, BaseHelperService)
services.add_transient(BaseHelperABC, BaseHelperService)
services.add_transient(MessageServiceABC, MessageService)
services.add_transient(ClientUtilsServiceABC, ClientUtilsService)
@@ -59,8 +77,7 @@ class Startup(StartupABC):
services.add_transient(DateTimeOffsetPipe)
# module services
if self._feature_flags.permission_module:
services.add_singleton(PermissionServiceABC, PermissionService)
services.add_singleton(PermissionServiceABC, PermissionService)
# data services
services.add_transient(ServerRepositoryABC, ServerRepositoryService)

47
src/bot/startup_discord_extension.py
View File

@@ -15,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
@@ -38,44 +39,46 @@ class StartupDiscordExtension(StartupExtensionABC):
def configure_services(self, services: ServiceCollectionABC, env: ApplicationEnvironmentABC):
services.add_discord()
dc = get_discord_collection(services)
""" commands """
# admin
"""modules"""
if self._feature_flags.admin_module:
""" commands """
dc.add_command(RestartCommand)
dc.add_command(ShutdownCommand)
# moderator
if self._feature_flags.moderator_module:
dc.add_command(PurgeCommand)
# simple
""" 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 """
# on_command_error
if self._feature_flags.base_module:
""" events """
dc.add_event(DiscordEventTypesEnum.on_command.value, BaseOnCommandEvent)
dc.add_event(DiscordEventTypesEnum.on_command_error.value, BaseOnCommandErrorEvent)
# on_member_join
if self._feature_flags.base_module:
dc.add_event(DiscordEventTypesEnum.on_member_join.value, BaseOnMemberJoinEvent)
# on_member_remove
if self._feature_flags.base_module:
dc.add_event(DiscordEventTypesEnum.on_member_join.value, BaseOnMemberRemoveEvent)
# on_member_update
if self._feature_flags.permission_module:
dc.add_event(DiscordEventTypesEnum.on_member_update.value, PermissionOnMemberUpdateEvent)
# on_message
if self._feature_flags.base_module:
dc.add_event(DiscordEventTypesEnum.on_message.value, BaseOnMessageEvent)
# on_voice_state_update
if self._feature_flags.base_module:
dc.add_event(DiscordEventTypesEnum.on_voice_state_update.value, BaseOnVoiceStateUpdateEvent)
# on_ready
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:
dc.add_event(DiscordEventTypesEnum.on_ready.value, BootLogOnReadyEvent) # has to be last
""" commands """
""" events """
dc.add_event(DiscordEventTypesEnum.on_ready.value, BootLogOnReadyEvent)