New version

mods/mod_test.py

@@ -1,53 +1,64 @@
+from dataclasses import dataclass, fields
 from core.irc import Irc
 
-#   Le module crée devra réspecter quelques conditions
-#       1. Importer le module de configuration
-#       2. Le nom de class devra toujours s'appeler comme le module exemple => nom de class Dktmb | nom du module mod_dktmb
-#       3. la fonction __init__ devra toujours avoir les parametres suivant (self, irc:object)
-#           1 . Créer la variable Irc dans le module
-#           2 . Récuperer la configuration dans une variable
-#           3 . Définir et enregistrer les nouvelles commandes
-#       4. une fonction _hcmds(self, user:str, cmd: list) devra toujours etre crée.
-
 class Test():
 
+    @dataclass
+    class ModConfModel:
+        """The Model containing the module parameters
+        """
+        param_exemple1: str
+        param_exemple2: int
+
     def __init__(self, ircInstance:Irc) -> None:
 
-        # Add Irc Object to the module
+        # Module name (Mandatory)
+        self.module_name = 'mod_' + str(self.__class__.__name__).lower()
+
+        # Add Irc Object to the module (Mandatory)
         self.Irc = ircInstance
 
-        # Add Global Configuration to the module
+        # Add Global Configuration to the module (Mandatory)
         self.Config = ircInstance.Config
 
-        # Add Base object to the module
+        # Add Base object to the module (Mandatory)
         self.Base = ircInstance.Base
 
-        # Add logs object to the module
+        # Add logs object to the module (Mandatory)
         self.Logs = ircInstance.Base.logs
 
-        # Add User object to the module
+        # Add User object to the module (Mandatory)
         self.User = ircInstance.User
 
-        # Add Channel object to the module
+        # Add Channel object to the module (Mandatory)
         self.Channel = ircInstance.Channel
 
-        # Créer les nouvelles commandes du module
+        # Create module commands (Mandatory)
         self.commands_level = {
-            0: ['test'],
-            1: ['test_level_1']
+            0: ['test-command'],
+            1: ['test_level_1'],
+            2: ['test_level_2'],
+            3: ['test_level_3']
         }
 
         # Init the module
         self.__init_module()
 
         # Log the module
-        self.Logs.debug(f'Module {self.__class__.__name__} loaded ...')
+        self.Logs.debug(f'Module {self.module_name} loaded ...')
 
     def __init_module(self) -> None:
 
+        # Insert module commands into the core one (Mandatory)
         self.__set_commands(self.commands_level)
+
+        # Create you own tables (Mandatory)
         self.__create_tables()
 
+        # Load module configuration and sync with core one (Mandatory)
+        self.__load_module_configuration()
+        # End of mandatory methods you can start your customization #
+
         return None
 
     def __set_commands(self, commands:dict[int, list[str]]) -> None:
@@ -78,31 +89,67 @@ class Test():
             id INTEGER PRIMARY KEY AUTOINCREMENT,
             datetime TEXT,
             server_msg TEXT
-            ) 
+            )
         '''
 
         self.Base.db_execute_query(table_logs)
         return None
 
+    def __load_module_configuration(self) -> None:
+        """### Load Module Configuration
+        """
+        try:
+            # Build the default configuration model (Mandatory)
+            self.ModConfig = self.ModConfModel(param_exemple1='param value 1', param_exemple2=1)
+
+            # Sync the configuration with core configuration (Mandatory)
+            self.Base.db_sync_core_config(self.module_name, self.ModConfig)
+
+            return None
+
+        except TypeError as te:
+            self.Logs.critical(te)
+
+    def __update_configuration(self, param_key: str, param_value: str):
+        """Update the local and core configuration
+
+        Args:
+            param_key (str): The parameter key
+            param_value (str): The parameter value
+        """
+        self.Base.db_update_core_config(self.module_name, self.ModConfig, param_key, param_value)
+
     def unload(self) -> None:
 
         return None
 
     def cmd(self, data:list) -> None:
+
         return None
 
-    def _hcmds(self, user:str, cmd: list, fullcmd: list = []) -> None:
+    def _hcmds(self, user:str, channel: any, cmd: list, fullcmd: list = []) -> None:
 
         command = str(cmd[0]).lower()
         dnickname = self.Config.SERVICE_NICKNAME
         fromuser = user
+        fromchannel = str(channel) if not channel is None else None
 
         match command:
 
-            case 'test':
+            case 'test-command':
                 try:
-                    
-                    self.Irc.send2socket(f":{dnickname} NOTICE {fromuser} : test command ready ...")
+
+                    self.Irc.send2socket(f":{dnickname} NOTICE {fromuser} : This is a notice to the sender ...")
+                    self.Irc.send2socket(f":{dnickname} PRIVMSG {fromuser} : This is private message to the sender ...")
+
+                    if not fromchannel is None:
+                        self.Irc.send2socket(f":{dnickname} PRIVMSG {fromchannel} : This is channel message to the sender ...")
+
+                    # How to update your module configuration
+                    self.__update_configuration('param_exemple2', 7)
+
+                    # Log if you want the result
                     self.Logs.debug(f"Test logs ready")
-                except KeyError as ke:
-                    self.Logs.error(f"Key Error : {ke}")
+
+                except Exception as err:
+                    self.Logs.error(f"{err}")