Merge pull request #14 from adator85/dev

adator85 · web-flow · commit 1ccfc4a2f015 · 2024-09-28T14:16:41.000+02:00
Dev
diff --git a/.gitignore b/.gitignore
@@ -7,4 +7,5 @@ docs/*
 setup.py
 test.py
 CallbackObject.py
+unrealircd_rpc_py/Definition.py
 *.zip
diff --git a/README.MD b/README.MD
@@ -167,5 +167,6 @@ This package allows easy interfacing with UnrealIRCd through regular Python3 cod
     Stats = rpc.Stats
     User = rpc.User
     Whowas = rpc.Whowas
+    Log = rpc.Log # This feature requires unrealIRCd 6.1.8 or higher
 
 ```
diff --git a/dist/unrealircd_rpc_py-0.1.6-py3-none-any.whl b/dist/unrealircd_rpc_py-0.1.6-py3-none-any.whl
diff --git a/dist/unrealircd_rpc_py-0.1.6.tar.gz b/dist/unrealircd_rpc_py-0.1.6.tar.gz
diff --git a/dist/unrealircd_rpc_py-0.1.7-py3-none-any.whl b/dist/unrealircd_rpc_py-0.1.7-py3-none-any.whl
diff --git a/dist/unrealircd_rpc_py-0.1.7.tar.gz b/dist/unrealircd_rpc_py-0.1.7.tar.gz
diff --git a/setup.py b/setup.py
@@ -2,7 +2,7 @@
 
 setup(
     name='unrealircd_rpc_py',
-    version='0.1.5',
+    version='0.1.7',
     packages=find_packages(),
     install_requires=[
         "requests>=2.25.1"
diff --git a/unrealircd_rpc_py/Channel.py b/unrealircd_rpc_py/Channel.py
@@ -50,6 +50,7 @@ def list_(self, _object_detail_level: int = 1) -> Union[list[ModelChannel], None
             ModelChannel: List of ModelChannel, None if nothing see the Error property
         """
         try:
+            self.DB_CHANNELS = []
             response = self.Connection.query(method='channel.list', param={'object_detail_level': _object_detail_level})
 
             self.response_raw = response
diff --git a/unrealircd_rpc_py/Connection.py b/unrealircd_rpc_py/Connection.py
@@ -10,6 +10,7 @@ class Connection:
 
     @dataclass
     class ErrorModel:
+        """This model will contain the error if any"""
         code: int
         message: str
 
@@ -19,6 +20,7 @@ def __init__(self, req_method:str, url: str, path_to_socket_file: str, username:
         self.Logs: logging
         self.__init_log_system()
         self.Error = self.ErrorModel(0, '')
+        """This model will contain the error if any"""
 
         self.url = url
         self.path_to_socket_file = path_to_socket_file
diff --git a/unrealircd_rpc_py/Loader.py b/unrealircd_rpc_py/Loader.py
@@ -100,3 +100,7 @@ def __init__(self, req_method: Literal['requests', 'socket', 'unixsocket'], url:
         # Create Whowas Instance
         self.Whowas = Whowas(self.Connection)
         """The Whowas module instance"""
+
+        # Create Log Instance
+        self.Log = Log(self.Connection)
+        """This include mainly send method requires unrealIRCd 6.1.8 or higher"""
diff --git a/unrealircd_rpc_py/Log.py b/unrealircd_rpc_py/Log.py
@@ -1,26 +1,12 @@
 from types import SimpleNamespace
-from typing import Union
-from dataclasses import dataclass
+from typing import Union, Literal
+from time import time
 from unrealircd_rpc_py.Connection import Connection
+# import Definition
 
 class Log:
 
-    @dataclass
-    class ModelLog:
-        type: str
-        type_string: str
-        set_by: str
-        set_at: str
-        expire_at: str
-        set_at_string: str
-        expire_at_string: str
-        duration_string: str
-        set_at_delta: int
-        set_in_config: bool
-        name: str
-        reason: str
-
-    DB_NAME_BANS: list[ModelLog] = []
+    # DB_LOG_CONNECT: list[Definition.LogConnect]
 
     def __init__(self, Connection: Connection) -> None:
 
@@ -68,80 +54,43 @@ def list_(self, sources: list = None) -> Union[SimpleNamespace, None]:
         except Exception as err:
             self.Logs.error(f'General error: {err}')
 
-    def subscribe(self, sources: list) -> bool:
-        """Subscribe to one or more log sources. Any previous subscriptions are overwritten (lost).
+    def send(self, msg: str, level: Literal['debug','info','warn','error','fatal'], subsystem: str, event_id: str, timestamp: float = time()) -> bool:
+        """ Send a log message / server notice.
 
-        Args:
-            sources (list): an array of log sources. See log block sources. 
-            For example ["!debug","all"] would give you all log messages except for debug messages. And ["connect"] would give only client connects/disconnects.
-
-        Returns:
-            bool: True if success
-        """
-        try:
-            response = self.Connection.query(
-                method='log.subscribe', 
-                param={"sources": sources}
-                )
+        Requires UnrealIRCd 6.1.8 or later
 
-            self.response_raw = response
-            self.response_np = self.Connection.json_response_np
-
-            if response is None:
-                return False
-
-            if 'error' in response:
-                self.Connection.set_error(response)
-                return False
-
-            if 'result' in response:
-                if response['result']:
-                    self.Logs.debug(response)
-                    return True
-                else:
-                    self.Logs.debug(response)
-                    return False
-
-            return True
-
-        except KeyError as ke:
-            self.Logs.error(f'KeyError: {ke}')
-        except Exception as err:
-            self.Logs.error(f'General error: {err}')
-
-    def unsubscribe(self) -> bool:
-        """Unsubscribe from all log events.
-        After this UnrealIRCd will stop streaming log events to you.
+        Args:
+            msg (str): The message you want to send to the server
+            level (Literal[&#39;debug&#39;,&#39;info&#39;,&#39;warn&#39;,&#39;error&#39;,&#39;fatal&#39;]): You can pick the level in the list
+            subsystem (str): You can put anything you want as a subsystem
+            event_id (str): You can put anything you want as a event_id
+            timestamp (float, optional): The current timestamp. Defaults to time().
 
         Returns:
-            bool: Always returns true
+            bool: True if is okey, else if there is an error
         """
+        # waiting for the documentation.
         try:
             response = self.Connection.query(
-                method='log.unsubscribe'
-                )
+                    method='log.send',
+                    param={"msg": msg, "level": level, "subsystem": subsystem, "event_id": event_id, "timestamp": timestamp}
+                    )
 
             self.response_raw = response
             self.response_np = self.Connection.json_response_np
 
-            if response is None:
-                return False
-
             if 'error' in response:
+                self.Logs.error(response["error"])
                 self.Connection.set_error(response)
                 return False
 
-            if 'result' in response:
-                if response['result']:
-                    self.Logs.debug(response)
-                    return True
-                else:
-                    self.Logs.debug(response)
-                    return False
+            self.Logs.debug(response)
 
             return True
 
         except KeyError as ke:
             self.Logs.error(f'KeyError: {ke}')
+            return False
         except Exception as err:
             self.Logs.error(f'General error: {err}')
+            return False
diff --git a/unrealircd_rpc_py/Name_ban.py b/unrealircd_rpc_py/Name_ban.py
@@ -43,6 +43,7 @@ def list_(self) -> Union[list[ModelNameBan], None]:
             ModelNameBan: List of ModelNameBan, None if nothing see Error property
         """
         try:
+            self.DB_NAME_BANS = []
             response = self.Connection.query(method='name_ban.list')
 
             self.response_raw = response
diff --git a/unrealircd_rpc_py/Rpc.py b/unrealircd_rpc_py/Rpc.py
@@ -35,6 +35,7 @@ def info(self) -> Union[list[ModelRpcInfo], None]:
             list[ModelRpcInfo]: List of ModelRpcInfo, None if nothing see the Error property
         """
         try:
+            self.DB_RPC_INFO = []
             response = self.Connection.query(method='rpc.info')
 
             self.response_raw = response
diff --git a/unrealircd_rpc_py/Server.py b/unrealircd_rpc_py/Server.py
@@ -80,6 +80,7 @@ def list_(self) -> Union[list[ModelServer], None]:
             list[ModelServer]: List with an object contains all Servers information
         """
         try:
+            self.DB_SERVER = []
             response = self.Connection.query('server.list')
 
             self.response_raw = response
@@ -329,6 +330,7 @@ def module_list(self, _serverorsid: str = None) -> Union[list[ModelModules], Non
             bool: if False means that we have an error
         """
         try:
+            self.DB_MODULES = []
             response = self.Connection.query('server.module_list', {'server': _serverorsid})
 
             self.response_raw = response
diff --git a/unrealircd_rpc_py/Server_ban.py b/unrealircd_rpc_py/Server_ban.py
@@ -43,6 +43,7 @@ def list_(self) -> Union[list[ModelServerBan], None]:
             list[ModelServerBan]: List of ModelServerBan, None if nothing see the Error property
         """
         try:
+            self.DB_SERVERS_BANS = []
             response = self.Connection.query(method='server_ban.list')
 
             self.response_raw = response
diff --git a/unrealircd_rpc_py/Server_ban_exeption.py b/unrealircd_rpc_py/Server_ban_exeption.py
@@ -44,6 +44,7 @@ def list_(self) -> Union[list[ModelServerBanException], None]:
             list[ModelServerBanException]: List of ModelServerBanException, None if nothing see the Error property
         """
         try:
+            self.DB_SERVERS_BANS_EXCEPTION = []
             response = self.Connection.query(method='server_ban_exception.list')
 
             self.response_raw = response
diff --git a/unrealircd_rpc_py/Spamfilter.py b/unrealircd_rpc_py/Spamfilter.py
@@ -50,6 +50,7 @@ def list_(self) -> Union[list[ModelSpamfilter], None]:
             list[ModelSpamfilter]: List of ModelSpamfilter, None if nothing, see Error property if any error
         """
         try:
+            self.DB_SPAMFILTERS = []
             response = self.Connection.query(method='spamfilter.list')
 
             self.response_raw = response
diff --git a/unrealircd_rpc_py/User.py b/unrealircd_rpc_py/User.py
@@ -54,6 +54,7 @@ def list_(self) -> Union[list[ModelUser], None]:
             ModelUser (list[ModelUser]): List with an object contains all Users information
         """
         try:
+            self.DB_USER = []
             response = self.Connection.query('user.list', param={'object_detail_level': 4})
 
             self.response_raw = response
diff --git a/unrealircd_rpc_py/Whowas.py b/unrealircd_rpc_py/Whowas.py
@@ -51,6 +51,7 @@ def get(self, _nick: str = None, _ip: str = None, _object_detail_level:int = 2)
             List[ModelWhowas]: If success it return the object ModelWhowas | None if nothing or error, see Error property
         """
         try:
+            self.DB_WHOWAS = []
             response = self.Connection.query('whowas.get', param={'nick': _nick, 'ip': _ip, 'object_detail_level': _object_detail_level})
 
             self.response_raw = response
diff --git a/version.json b/version.json
@@ -1,3 +1,3 @@
 {
-    "version": "0.1.5"
+    "version": "0.1.7"
 }
