From 890d2c47a498417985c5b223f651580c005b109c Mon Sep 17 00:00:00 2001 From: Lukas Date: Thu, 7 Oct 2021 14:39:05 +0200 Subject: [PATCH 1/5] start outsourcing commands --- myTS3.py | 74 +++------------------------------- src/commands.py | 104 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 109 insertions(+), 69 deletions(-) create mode 100644 src/commands.py diff --git a/myTS3.py b/myTS3.py index 843ec6b..a37a7cd 100644 --- a/myTS3.py +++ b/myTS3.py @@ -18,7 +18,7 @@ import os.path import ts3 # Self -from src import util, gecko +from src import util, gecko, commands class TSbot: @@ -214,23 +214,6 @@ class TSbot: self.pipeOut(msg) self.running = False - def notifyAdmin(self): - """ - Ping every available admin. - """ - - clients = self.bot.clientlist() - clients = [client for client in clients if client["client_type"] != "1"] - for client in clients: - cldbid = client["client_database_id"] - clid = client["clid"] - if self.isadmin(cldbid): - msg = "" - self.bot.sendtextmessage(targetmode=1, target=clid, msg=msg) - - if not self.whitelisted: - time.sleep(1) - def kickall(self, msg): """ TODO @@ -312,32 +295,6 @@ class TSbot: except Exception as e: self.pipeOut(e, lvl="error") - def list(self, what, invkr_id): - """ - Message the invoker of the function either a list of channels or a list of clients. - """ - - mydict = {} - if what == "channel": - channels = self.bot.channellist() - for channel in channels: - order = channel["channel_order"] - mydict[order] = [channel["channel_name"], channel["cid"]] - - mydict = dict(sorted(mydict.items())) - msg = json.dumps(mydict) - - elif what == "clients": - clients = self.bot.clientlist() - for client in clients: - mydict[client["client_nickname"]] = {"clid": client["clid"], "cldbid": client["client_database_id"]} - mydict = dict(sorted(mydict.items())) - msg = json.dumps(mydict) - else: - msg = None - - self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=msg) - def isqueryclient(self, clid): """ Check if the given client-uid is a query client. @@ -406,7 +363,7 @@ class TSbot: self.pipeOut(f"command: {command} | parameter: {parameter} | invkr_id: {invkr_id}") if command == ".admin": - self.notifyAdmin() + commands.notifyAdmin(self) elif command == ".annoy": try: @@ -435,38 +392,17 @@ class TSbot: pass elif command == ".follow": - if not parameter[0]: - err = "Please use the command like this: .follow TARGET" - self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=err) - return - - target = parameter[0] - try: - clients = self.bot.clientfind(pattern=target) - clids = [client["clid"] for client in clients] - if len(clids) == 1: - cid = self.bot.clientinfo(clids[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 + commands.follow(self, invkr_id, parameter) elif command == ".info": - # TODO implement more then just the runtime - msg = f"Runtime: {util.getRuntime(self.started)}" - self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=msg) + commands.info(self, invkr_id) elif command == ".kickall": self.kickall("test") # TODO elif command == ".list": try: - self.list(parameter[0], invkr_id) + commands.msglist(self, invkr_id, parameter) except IndexError: err = "Please use the command like this: .list channel/clients" self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=err) diff --git a/src/commands.py b/src/commands.py new file mode 100644 index 0000000..7b64f65 --- /dev/null +++ b/src/commands.py @@ -0,0 +1,104 @@ +""" +TBD +""" + +__author__ = "Lukas Mahler" +__version__ = "0.0.0" +__date__ = "07.10.2021" +__email__ = "m@hler.eu" +__status__ = "Development" + + +# Default +import json +import time + +# Custom +import ts3 + +# Self +import util + + +def follow(self, invkr_id, parameter): + """ + + """ + + if not parameter[0]: + err = "Please use the command like this: .follow TARGET" + self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=err) + return + + target = parameter[0] + try: + clients = self.bot.clientfind(pattern=target) + clids = [client["clid"] for client in clients] + if len(clids) == 1: + cid = self.bot.clientinfo(clids[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 info(self, invkr_id): + # TODO implement more then just the runtime + msg = f"Runtime: {util.getRuntime(self.started)}" + self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=msg) + + +def msglist(self, invkr_id, parameter): + """ + Message the invoker of the function either a list of channels or a list of clients. + """ + + what = parameter[0] + mydict = {} + + if what == "channel": + channels = self.bot.channellist() + for channel in channels: + order = channel["channel_order"] + mydict[order] = [channel["channel_name"], channel["cid"]] + + mydict = dict(sorted(mydict.items())) + msg = json.dumps(mydict) + + elif what == "clients": + clients = self.bot.clientlist() + for client in clients: + mydict[client["client_nickname"]] = {"clid": client["clid"], "cldbid": client["client_database_id"]} + mydict = dict(sorted(mydict.items())) + msg = json.dumps(mydict) + else: + msg = None + + self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=msg) + + +def notifyAdmin(self): + """ + Ping every available admin. + """ + + clients = self.bot.clientlist() + clients = [client for client in clients if client["client_type"] != "1"] + for client in clients: + cldbid = client["client_database_id"] + clid = client["clid"] + if self.isadmin(cldbid): + msg = "" + self.bot.sendtextmessage(targetmode=1, target=clid, msg=msg) + + if not self.whitelisted: + time.sleep(1) + + +if __name__ == "__main__": + exit() From c53d0ce4ed7313496ba703ab7f47d442d237d73b Mon Sep 17 00:00:00 2001 From: Lukas Date: Wed, 13 Oct 2021 21:56:25 +0200 Subject: [PATCH 2/5] add .help command --- myTS3.py | 11 +++++++---- src/commands.py | 23 +++++++++++++++++++---- src/util.py | 4 ++-- 3 files changed, 28 insertions(+), 10 deletions(-) diff --git a/myTS3.py b/myTS3.py index a37a7cd..e80a9b8 100644 --- a/myTS3.py +++ b/myTS3.py @@ -4,14 +4,13 @@ TBD __author__ = "Lukas Mahler" __version__ = "0.0.0" -__date__ = "07.10.2021" +__date__ = "13.10.2021" __email__ = "m@hler.eu" __status__ = "Development" # Default import sys import time -import json import os.path # Custom @@ -107,7 +106,7 @@ class TSbot: time.sleep(5) # Notify connected admins - self.notifyAdmin() + commands.notifyAdmin(self) # ----------- LOOP HERE ------------- while self.running: @@ -176,7 +175,7 @@ class TSbot: # New text message elif event_type == "notifytextmessage": - msg = event[0]["msg"] + msg = event[0]["msg"].replace("\n", " ") invkr = event[0]["invokername"] invkr_id = event[0]["invokerid"] self.pipeOut(f'Message | From: "{invkr}" | Content: "{msg}"') @@ -347,6 +346,7 @@ class TSbot: .btc / .eth .dot / .ada .follow target + .help / .h .info clid .kickall message .list channel/clients @@ -394,6 +394,9 @@ class TSbot: elif command == ".follow": commands.follow(self, invkr_id, parameter) + elif command == ".help" or command == ".h": + commands.help(self, invkr_id) + elif command == ".info": commands.info(self, invkr_id) diff --git a/src/commands.py b/src/commands.py index 7b64f65..d89ee06 100644 --- a/src/commands.py +++ b/src/commands.py @@ -4,20 +4,22 @@ TBD __author__ = "Lukas Mahler" __version__ = "0.0.0" -__date__ = "07.10.2021" +__date__ = "13.10.2021" __email__ = "m@hler.eu" __status__ = "Development" # Default +import sys import json import time +import inspect # Custom import ts3 # Self -import util +from src import util def follow(self, invkr_id, parameter): @@ -25,7 +27,7 @@ def follow(self, invkr_id, parameter): """ - if not parameter[0]: + if not parameter: err = "Please use the command like this: .follow TARGET" self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=err) return @@ -35,7 +37,7 @@ def follow(self, invkr_id, parameter): clients = self.bot.clientfind(pattern=target) clids = [client["clid"] for client in clients] if len(clids) == 1: - cid = self.bot.clientinfo(clids[0])["cid"] + 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}") @@ -47,7 +49,20 @@ def follow(self, invkr_id, parameter): return +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)}" + self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=msg) + + def info(self, invkr_id): + """ + + """ # TODO implement more then just the runtime msg = f"Runtime: {util.getRuntime(self.started)}" self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=msg) diff --git a/src/util.py b/src/util.py index 4d89e15..83d118d 100644 --- a/src/util.py +++ b/src/util.py @@ -4,7 +4,7 @@ TBD __author__ = "Lukas Mahler" __version__ = "0.0.0" -__date__ = "30.09.2021" +__date__ = "13.10.2021" __email__ = "m@hler.eu" __status__ = "Development" @@ -64,7 +64,7 @@ def getRuntime(started): """ elapsed = time.time() - started - runtime = str(timedelta(seconds=elapsed)) + runtime = str(timedelta(seconds=elapsed)).split(".")[0] # ignore Microseconds return runtime From 712faa876cfb6ee880935f6195a26580b1503ebf Mon Sep 17 00:00:00 2001 From: Lukas Date: Sun, 24 Oct 2021 00:56:40 +0200 Subject: [PATCH 3/5] mute/unmute commands, structual rewrite and ordering --- myTS3.py | 89 ++++++++++++++++++++++++++++++----------------- src/commands.py | 75 ++++++++++++++++++++++++++++++--------- src/template.toml | 5 +-- 3 files changed, 119 insertions(+), 50 deletions(-) diff --git a/myTS3.py b/myTS3.py index e80a9b8..4c1b942 100644 --- a/myTS3.py +++ b/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}") - # ---------------------------------------------------------------------------------------------------------------------- diff --git a/src/commands.py b/src/commands.py index d89ee06..c66d48a 100644 --- a/src/commands.py +++ b/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: - clients = self.bot.clientfind(pattern=target) - clids = [client["clid"] for client in clients] - 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 + clid = self.identifytarget(target) + cid = self.bot.clientinfo(clid=int(clid))[0]["cid"] + self.bot.clientmove(clid=self.myid, cid=cid) 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() diff --git a/src/template.toml b/src/template.toml index 9abc392..4dd2d54 100644 --- a/src/template.toml +++ b/src/template.toml @@ -7,8 +7,9 @@ sid = 1 user = "exampleuser" pwd = "password" -[Allowed] -sgids = ["1"] +[Groups] +admins = ["1"] +mute = "0" [Misc] nickname = "myTS3-Bot" From ee3e081c3c3f28da0b7f1bdbdef02319f795be6e Mon Sep 17 00:00:00 2001 From: Lukas Date: Mon, 25 Oct 2021 18:52:50 +0200 Subject: [PATCH 4/5] fix for the rare occassion that the client has no client_type --- myTS3.py | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/myTS3.py b/myTS3.py index 4c1b942..e59b736 100644 --- a/myTS3.py +++ b/myTS3.py @@ -307,13 +307,16 @@ class TSbot: except ts3.query.TS3QueryError as e: self.pipeOut(f"given clid {clid} returned error:\n{e}", lvl="ERROR") return True - - if client[0]["client_type"] == "1": - self.pipeOut(f"[{clid}] ISQUERY: True") - return True - else: - self.pipeOut(f"[{clid}] ISQUERY: False") - return False + try: + if client[0]["client_type"] == "1": + self.pipeOut(f"[{clid}] ISQUERY: True") + return True + else: + self.pipeOut(f"[{clid}] ISQUERY: False") + return False + except KeyError as e: + self.pipeOut(f"Error [{e}] on client [{client.__dict__}] ") + return True # Da wahrscheinlich ein Query Client def isadmin(self, cldbid): """ From dfca0593f51967ff932f67d04489c1da89664691 Mon Sep 17 00:00:00 2001 From: Lukas Date: Sat, 30 Oct 2021 18:51:35 +0200 Subject: [PATCH 5/5] migrate every command --- myTS3.py | 77 +++++++++++----------------------- src/commands.py | 102 ++++++++++++++++++++++++++++++++++++++++++---- src/template.toml | 3 +- 3 files changed, 121 insertions(+), 61 deletions(-) diff --git a/myTS3.py b/myTS3.py index e59b736..637116f 100644 --- a/myTS3.py +++ b/myTS3.py @@ -4,7 +4,7 @@ TBD __author__ = "Lukas Mahler" __version__ = "0.0.0" -__date__ = "24.10.2021" +__date__ = "30.10.2021" __email__ = "m@hler.eu" __status__ = "Development" @@ -36,16 +36,17 @@ class TSbot: self.pwd = conf["Authentication"]["pwd"] self.sgid_admin = conf["Groups"]["admins"] self.sgid_mute = conf["Groups"]["mute"] + self.crypto = conf["Misc"]["crypto"] self.nickname = conf["Misc"]["nickname"] self.whitelisted = conf["Misc"]["whitelisted"] # Initialize self - self.gecko = gecko.GeckoAPI() self.log = log self.myid = None self.running = True self.version = __version__ self.started = time.time() + self.gecko = gecko.GeckoAPI() self.crypto_update = self.started - 1800 self.pipeOut(f"Trying to connect to: {self.host}:{self.port}") @@ -117,11 +118,12 @@ class TSbot: self.bot.version() # Auto-update crypto price channels every 30 minutes - if self.crypto_update + 1800 < time.time(): - self.crypto_update = time.time() + if self.crypto: + if self.crypto_update + 1800 < time.time(): + self.crypto_update = time.time() + + commands.ticker(self, "") - self.lookupcommand(".btc", self.myid) - self.lookupcommand(".dot", self.myid) else: pass @@ -228,7 +230,7 @@ class TSbot: self.bot.clientpoke(msg=msg, clid=clid) # TODO - def poke(self, msg=None, n=10, delay=0.2, usr='all'): + def poke(self, msg=None, n=1, delay=0.2, usr='all'): """ ping a single or multiple users for n times including a msg. """ @@ -386,24 +388,24 @@ class TSbot: """ Every message starting with '.' gets passed and evaluated in this function. Commands in this function are sorted alphabetically. + Parameters in brackets are optional. Command Parameter 1 Parameter 2 --------------------------------------------------------- - .admin + .admin / .notifyAdmin .annoy target message - .btc / .eth - .dot / .ada .follow target .help / .h .info clid .kickall message - .list channel/clients/groups + .list channel/clients/commands/groups .mute target .pingall message .rename nickname .roll .stop / .quit / .q .test + .ticker (symbol) .unmute target """ @@ -412,33 +414,13 @@ class TSbot: parameter = commandstring[1:] self.pipeOut(f"command: {command} | parameter: {parameter} | invkr_id: {invkr_id}") - if command == ".admin": + # ??? passable = {"self": self, "invkr_id": invkr_id, "parameter": parameter} + + if command == ".admin" or command == ".notifyAdmin": commands.notifyAdmin(self) elif command == ".annoy": - try: - target = parameter[0] - msg = parameter[1] - self.poke(msg=msg, usr=target) - except IndexError: - err = "Please use the command like this: .annoy TARGET MESSAGE" - self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=err) - - elif command == ".btc" or command == ".eth": - channelname = f"[cspacerC1]BTC: {self.gecko.getSymbol('Bitcoin', decimal=0)} | " \ - f"ETH: {self.gecko.getSymbol('ethereum', decimal=0)}" - try: - self.editChannelname(200, channelname) - except ts3.query.TS3QueryError: - pass - - elif command == ".dot" or command == ".ada": - channelname = f"[cspacerC2]DOT: {self.gecko.getSymbol('polkadot', decimal=2)} | " \ - f"ADA: {self.gecko.getSymbol('cardano', decimal=2)}" - try: - self.editChannelname(201, channelname) - except ts3.query.TS3QueryError: - pass + commands.annoy(self, invkr_id, parameter) elif command == ".follow": commands.follow(self, invkr_id, parameter) @@ -453,41 +435,30 @@ class TSbot: self.kickall("test") # TODO elif command == ".list": - try: - commands.msglist(self, invkr_id, parameter) - except IndexError: - err = "Please use the command like this: .list channel/clients/groups" - self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=err) + commands.list(self, invkr_id, parameter) elif command == ".mute": commands.mute(self, invkr_id, parameter) elif command == ".pingall": - try: - msg = parameter[0] - self.poke(msg=msg) - except IndexError: - err = "Please use the command like this: .pingall MESSAGE" - self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=err) + commands.pingall(self, invkr_id, parameter) elif command == ".rename": - try: - self.nickname = parameter[0] - self.bot.clientupdate(client_nickname=self.nickname) - except IndexError: - err = "Please use the command like this: .rename NAME" - self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=err) + commands.rename(self, invkr_id, parameter) elif command == ".roll": pass # TODO needs permission for everyone + targemode implementation elif command == ".stop" or command == ".quit" or command == ".q": - self.stop(invkr_id) + commands.quit(self, invkr_id) elif command == ".test": cid = self.createChannel("Test") self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=cid) + elif command == ".ticker": + commands.ticker(self, parameter) + elif command == ".unmute": commands.unmute(self, invkr_id, parameter) diff --git a/src/commands.py b/src/commands.py index c66d48a..f5fbbc3 100644 --- a/src/commands.py +++ b/src/commands.py @@ -4,7 +4,7 @@ TBD __author__ = "Lukas Mahler" __version__ = "0.0.0" -__date__ = "24.10.2021" +__date__ = "30.10.2021" __email__ = "m@hler.eu" __status__ = "Development" @@ -22,11 +22,26 @@ import ts3 from src import util -def follow(self, invkr_id, parameter): +def annoy(self, invkr_id, parameter): """ """ + if not parameter: + err = "Please use the command like this: .annoy TARGET MESSAGE" + self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=err) + return + + target = parameter[0] + msg = parameter[1] + self.poke(n=10, msg=msg, usr=target) + + +def follow(self, invkr_id, parameter): + """ + TODO sticky folgen + """ + if not parameter: err = "Please use the command like this: .follow TARGET" self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=err) @@ -42,6 +57,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"\n\nList of commands:\n---------------------\n.{f'{chr(10)}.'.join(cmds)}" @@ -52,17 +68,22 @@ def info(self, invkr_id): """ """ - # TODO implement more then just the runtime + msg = f"\n\nRuntime: {util.getRuntime(self.started)}\n" \ f"Version: {self.version}" self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=msg) -def msglist(self, invkr_id, parameter): +def list(self, invkr_id, parameter): """ - Message the invoker of the function either a list of channels or a list of clients. + Message the invoker of the function either a list of channels, clients, commands or server groups. """ + if not parameter: + err = "Please use the command like this: .list channel/clients/commands/groups/" + self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=err) + return + what = parameter[0] mydict = {} @@ -82,6 +103,10 @@ def msglist(self, invkr_id, parameter): mydict = dict(sorted(mydict.items())) msg = json.dumps(mydict) + elif what == "commands": + help(self, invkr_id) + return + elif what == "groups": groups = self.bot.servergrouplist() for group in groups: @@ -89,7 +114,7 @@ def msglist(self, invkr_id, parameter): msg = json.dumps(mydict) else: - msg = None + msg = f"The parameter [{what}] is not supported." self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=msg) @@ -116,9 +141,23 @@ def mute(self, invkr_id, parameter): return +def pingall(self, invkr_id, parameter): + """ + + """ + + if not parameter: + err = "Please use the command like this: .pingall MESSAGE" + self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=err) + return + + msg = parameter[0] + self.poke(msg=msg) + + def notifyAdmin(self): """ - Ping every available admin. + Message every available admin. """ clients = self.bot.clientlist() @@ -134,6 +173,55 @@ def notifyAdmin(self): time.sleep(1) +def quit(self, invkr_id): + """ + + """ + self.stop(invkr_id) + + +def rename(self, invkr_id, parameter): + """ + Rename the Bot to the given Nickname + """ + + if not parameter: + err = "Please use the command like this: .rename NICKNAME" + self.bot.sendtextmessage(targetmode=1, target=invkr_id, msg=err) + return + + self.nickname = parameter[0] + self.bot.clientupdate(client_nickname=self.nickname) + + +def ticker(self, parameter): + """ + Refresh the Crypto Ticker channels, + this is very specific to my use, you can disable this in the config. + """ + + if parameter: + symbol = parameter[0].lower() + else: + symbol = "all" + + if symbol in ["btc", "bitcoin", "eth", "ethereum", "all"]: + channelname = f"[cspacerC1]BTC: {self.gecko.getSymbol('bitcoin', decimal=0)} | " \ + f"ETH: {self.gecko.getSymbol('ethereum', decimal=0)}" + try: + self.editChannelname(200, channelname) + except ts3.query.TS3QueryError: + pass + + if symbol in ["dot", "polkadot", "ada", "cardano", "all"]: + channelname = f"[cspacerC2]DOT: {self.gecko.getSymbol('polkadot', decimal=2)} | " \ + f"ADA: {self.gecko.getSymbol('cardano', decimal=2)}" + try: + self.editChannelname(201, channelname) + except ts3.query.TS3QueryError: + pass + + def unmute(self, invkr_id, parameter): """ Remove the mute group to a user. diff --git a/src/template.toml b/src/template.toml index 4dd2d54..2200916 100644 --- a/src/template.toml +++ b/src/template.toml @@ -13,4 +13,5 @@ mute = "0" [Misc] nickname = "myTS3-Bot" -whitelisted = false \ No newline at end of file +whitelisted = false +crypto = false \ No newline at end of file