mute/unmute commands, structual rewrite and ordering

myTS3.py

@@ -4,7 +4,7 @@ TBD
 
 __author__ = "Lukas Mahler"
 __version__ = "0.0.0"
-__date__ = "13.10.2021"
+__date__ = "24.10.2021"
 __email__ = "m@hler.eu"
 __status__ = "Development"
 
@@ -34,7 +34,8 @@ class TSbot:
         self.sid = conf["Connection"]["sid"]
         self.user = conf["Authentication"]["user"]
         self.pwd = conf["Authentication"]["pwd"]
-        self.allowed_sgids = conf["Allowed"]["sgids"]
+        self.sgid_admin = conf["Groups"]["admins"]
+        self.sgid_mute = conf["Groups"]["mute"]
         self.nickname = conf["Misc"]["nickname"]
         self.whitelisted = conf["Misc"]["whitelisted"]
 
@@ -43,6 +44,7 @@ class TSbot:
         self.log = log
         self.myid = None
         self.running = True
+        self.version = __version__
         self.started = time.time()
         self.crypto_update = self.started - 1800
 
@@ -186,6 +188,8 @@ class TSbot:
                 else:
                     self.pipeOut(f"Unknown Event: {event.__dict__}", lvl="warning")
 
+# Class Utility --------------------------------------------------------------------------------------------------------
+
     def pipeOut(self, msg, lvl="INFO", reprint=True):
         """
         All output pipes through this function.
@@ -327,13 +331,54 @@ class TSbot:
         self.pipeOut(str(groups.__dict__), lvl="DEBUG")  # DEBUG
 
         for group in groups:
-            if any(sgid == group['sgid'] for sgid in self.allowed_sgids):
+            if any(sgid == group['sgid'] for sgid in self.sgid_admin):
                 self.pipeOut(f"[{cldbid}] ISADMIN: True")
                 return True
 
         self.pipeOut(f"[{cldbid}] ISADMIN: False")
         return False
 
+    def printable_clientinfo(self, clid):
+        """
+        Generate printable clientinfo from clid.
+        """
+
+        info = self.bot.clientinfo(clid=clid)
+        usrd = info.__dict__
+
+        return usrd
+
+    def clid2cldbid(self, clid):
+        """
+        Convert a given clid to a cldbid.
+        """
+
+        cluid = self.bot.clientgetuidfromclid(clid=clid)[0]["cluid"]
+        cldbid = self.bot.clientgetdbidfromuid(cluid=cluid)[0]["cldbid"]
+
+        return cldbid
+
+    def identifytarget(self, target):
+        """
+        Try to find clid from nickname.
+        """
+
+        try:
+            clients = self.bot.clientfind(pattern=target)
+            clids = [client["clid"] for client in clients]
+            if len(clids) == 1:
+                return clids[0]
+            else:
+                self.pipeOut(f"Found multiple matching clients using pattern {target}:{clids}")
+                return
+
+        except ts3.query.TS3QueryError as e:
+            self.pipeOut(f"No client found using pattern [{target}], "
+                         f"returned error:\n{e}", lvl="ERROR")
+            return
+
+# Commands -------------------------------------------------------------------------------------------------------------
+
     def lookupcommand(self, msg, invkr_id):
         """
         Every message starting with '.' gets passed and evaluated in this function.
@@ -349,12 +394,14 @@ class TSbot:
         .help / .h
         .info                   clid
         .kickall                message
-        .list                   channel/clients
+        .list                   channel/clients/groups
+        .mute                   target
         .pingall                message
         .rename                 nickname
         .roll
         .stop / .quit / .q
         .test
+        .unmute                 target
         """
 
         commandstring = msg.split(" ")
@@ -373,7 +420,6 @@ class TSbot:
             except IndexError:
                 err = "Please use the command like this: .annoy TARGET MESSAGE"
                 self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=err)
-                pass
 
         elif command == ".btc" or command == ".eth":
             channelname = f"[cspacerC1]BTC: {self.gecko.getSymbol('Bitcoin', decimal=0)} | " \
@@ -407,9 +453,11 @@ class TSbot:
             try:
                 commands.msglist(self, invkr_id, parameter)
             except IndexError:
-                err = "Please use the command like this: .list channel/clients"
+                err = "Please use the command like this: .list channel/clients/groups"
                 self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=err)
-                pass
+
+        elif command == ".mute":
+            commands.mute(self, invkr_id, parameter)
 
         elif command == ".pingall":
             try:
@@ -418,7 +466,6 @@ class TSbot:
             except IndexError:
                 err = "Please use the command like this: .pingall MESSAGE"
                 self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=err)
-                pass
 
         elif command == ".rename":
             try:
@@ -427,7 +474,6 @@ class TSbot:
             except IndexError:
                 err = "Please use the command like this: .rename NAME"
                 self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=err)
-                pass
 
         elif command == ".roll":
             pass  # TODO needs permission for everyone + targemode implementation
@@ -439,32 +485,13 @@ class TSbot:
             cid = self.createChannel("Test")
             self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=cid)
 
+        elif command == ".unmute":
+            commands.unmute(self, invkr_id, parameter)
+
         else:
             err = f"Unknown Command: [{command}]"
             self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=err)
 
-    def printable_clientinfo(self, clid):
-        """
-        Generate printable clientinfo from clid.
-        """
-
-        info = self.bot.clientinfo(clid=clid)
-        usrd = info.__dict__
-
-        return usrd
-
-    def checkgrp(self):
-        """
-        Print all assigned groups for every connected client.
-        """
-
-        # clients = self.bot.clientlist()
-        # clients_cldbid = [client["client_database_id"] for client in clients if client["client_type"] != "1"]
-        clients = self.bot.clientlist(groups=True)
-        clients_groups = [client["client_servergroups"] for client in clients if client["client_type"] != "1"]
-
-        self.pipeOut(f"{clients_groups}")
-
 
 # ----------------------------------------------------------------------------------------------------------------------
 

src/commands.py

@@ -4,7 +4,7 @@ TBD
 
 __author__ = "Lukas Mahler"
 __version__ = "0.0.0"
-__date__ = "13.10.2021"
+__date__ = "24.10.2021"
 __email__ = "m@hler.eu"
 __status__ = "Development"
 
@@ -33,20 +33,9 @@ def follow(self, invkr_id, parameter):
         return
 
     target = parameter[0]
-    try:
+    clid = self.identifytarget(target)
-        clients = self.bot.clientfind(pattern=target)
+    cid = self.bot.clientinfo(clid=int(clid))[0]["cid"]
-        clids = [client["clid"] for client in clients]
+    self.bot.clientmove(clid=self.myid, cid=cid)
-        if len(clids) == 1:
-            cid = self.bot.clientinfo(clid=int(clids[0]))[0]["cid"]
-            self.bot.clientmove(clid=self.myid, cid=cid)
-        else:
-            self.pipeOut(f"Found multiple matching clients using pattern {target}:{clids}")
-            return
-
-    except ts3.query.TS3QueryError as e:
-        self.pipeOut(f"No client found using pattern {target},"
-                     f"returned error:\n{e}", lvl="ERROR")
-        return
 
 
 def help(self, invkr_id):
@@ -55,7 +44,7 @@ def help(self, invkr_id):
     """
     # Find all functions in this submodule
     cmds = [f[0] for f in inspect.getmembers(sys.modules[__name__], inspect.isfunction)]
-    msg = f"List of commands:\n{f'{chr(10)}.'.join(cmds)}"
+    msg = f"\n\nList of commands:\n---------------------\n.{f'{chr(10)}.'.join(cmds)}"
     self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=msg)
 
 
@@ -64,7 +53,8 @@ def info(self, invkr_id):
 
     """
     # TODO implement more then just the runtime
-    msg = f"Runtime: {util.getRuntime(self.started)}"
+    msg = f"\n\nRuntime: {util.getRuntime(self.started)}\n" \
+          f"Version: {self.version}"
     self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=msg)
 
 
@@ -91,12 +81,41 @@ def msglist(self, invkr_id, parameter):
             mydict[client["client_nickname"]] = {"clid": client["clid"], "cldbid": client["client_database_id"]}
         mydict = dict(sorted(mydict.items()))
         msg = json.dumps(mydict)
+
+    elif what == "groups":
+        groups = self.bot.servergrouplist()
+        for group in groups:
+            mydict[group["name"]] = {"sgid": group["sgid"], "sortid": group["sortid"]}
+        msg = json.dumps(mydict)
+
     else:
         msg = None
 
     self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=msg)
 
 
+def mute(self, invkr_id, parameter):
+    """
+    Assign the mute group to a user.
+    """
+
+    if not parameter:
+        err = "Please use the command like this: .mute TARGET"
+        self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=err)
+        return
+
+    target = parameter[0]
+    clid = self.identifytarget(target)
+    cldbid = self.clid2cldbid(clid)
+
+    try:
+        self.bot.servergroupaddclient(sgid=self.sgid_mute, cldbid=cldbid)
+    except ts3.query.TS3QueryError as e:
+        err = f"Failed to add to group: [{e}]"
+        self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=err)
+        return
+
+
 def notifyAdmin(self):
     """
     Ping every available admin.
@@ -115,5 +134,27 @@ def notifyAdmin(self):
             time.sleep(1)
 
 
+def unmute(self, invkr_id, parameter):
+    """
+    Remove the mute group to a user.
+    """
+
+    if not parameter:
+        err = "Please use the command like this: .unmute TARGET"
+        self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=err)
+        return
+
+    target = parameter[0]
+    clid = self.identifytarget(target)
+    cldbid = self.clid2cldbid(clid)
+
+    try:
+        self.bot.servergroupdelclient(sgid=self.sgid_mute, cldbid=cldbid)
+    except ts3.query.TS3QueryError as e:
+        err = f"Failed to remove from group: [{e}]"
+        self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=err)
+        return
+
+
 if __name__ == "__main__":
     exit()

src/template.toml

@@ -7,8 +7,9 @@ sid  = 1
 user = "exampleuser"
 pwd  = "password"
 
-[Allowed]
+[Groups]
-sgids = ["1"]
+admins = ["1"]
+mute = "0"
 
 [Misc]
 nickname = "myTS3-Bot"