From 6ca24980fd9aef34ace440ec683eed81a22ca6a8 Mon Sep 17 00:00:00 2001 From: makefu Date: Sat, 15 Aug 2020 14:15:10 +0200 Subject: release version --- README.md | 4 ++ default.nix | 8 ++- kalauerbot.py | 172 -------------------------------------------- kalauerbot/bot.py | 184 +++++++++++++++++++++++++++++++++++++++++++++++ nix/matrixbot.patch | 12 ++++ nix/python-matrixbot.nix | 31 ++++++++ nix/translate.patch | 17 +++++ python-matrixbot.nix | 30 -------- 8 files changed, 253 insertions(+), 205 deletions(-) create mode 100644 README.md delete mode 100644 kalauerbot.py create mode 100644 kalauerbot/bot.py create mode 100644 nix/matrixbot.patch create mode 100644 nix/python-matrixbot.nix create mode 100644 nix/translate.patch delete mode 100644 python-matrixbot.nix diff --git a/README.md b/README.md new file mode 100644 index 0000000..54b5c22 --- /dev/null +++ b/README.md @@ -0,0 +1,4 @@ +Kalauerbot +========== + +Manage the list of kalauer königs diff --git a/default.nix b/default.nix index 5702f0a..c4564b6 100644 --- a/default.nix +++ b/default.nix @@ -1,10 +1,12 @@ with import {}; python3.pkgs.buildPythonPackage { - name = "env"; + name = "kalauerbot-env"; src = ./.; propagatedBuildInputs = with python3.pkgs;[ - (callPackage ./python-matrixbot.nix {}) - googletrans + (callPackage ./nix/python-matrixbot.nix {}) + (stdenv.lib.overrideDerivation googletrans (self: { + patches = [ ./nix/translate.patch ]; + })) ]; checkInputs = [ python3.pkgs.black ]; } diff --git a/kalauerbot.py b/kalauerbot.py deleted file mode 100644 index 244456c..0000000 --- a/kalauerbot.py +++ /dev/null @@ -1,172 +0,0 @@ -from matrixbot import MatrixBot -from functools import partial -import random -import json -import logging -from googletrans import LANGUAGES,Translator -logging.basicConfig(level=logging.DEBUG) -log = logging.getLogger("Kalauerbot") -version = "1.0.0" - -class Kalauerbot(MatrixBot): - def __init__(self,host,display_name,token,user_id,dbpath = "kalauerdb.json",whitelist=None): - self.whitelist = whitelist - self.dbpath=dbpath - self.load_db() - super().__init__(host,display_name,token,user_id) - - def load_db(self): - try: - log.info(f"loading entries from {self.dbpath}") - self.db = json.load(open(self.dbpath)) - log.debug(self.db) - except: - log.info(f"Cannot open {self.dbpath}, creating empty db") - self.db = { "__chosen__": None } - self.save_db() - def save_db(self): - json.dump(self.db,open(self.dbpath,"w+")) - log.debug(f"saving db to {self.dbpath}") - - def active_db(self): - return dict(self._get_active()) - - def _get_active(self): - for name,entry in self.db.items(): - if name == "__chosen__": - continue # skip the __chosen__ special object - elif entry['active']: - yield name,entry - else: - log.debug(f"skipping {name} because user is inactive") - continue - def process_event(self, room, event): - # {'content': {'body': 'hello bot', 'msgtype': 'm.text'}, 'event_id': '$1597412611141040kQPEC:thales.citadel.team', 'origin_server_ts': 1597412611511, 'sender': '@frichter:thales.citadel.team', 'type': 'm.room.message', 'unsigned': {'age': 98}, 'room_id': '!eXmPERUmuMagsLVxar:thales.citadel.team'} - if self.user_id == event['sender']: return # don't answer own message - if event['type'] != 'm.room.message': return - msg = event['content']['body'] - if self.whitelist and room.room_id not in self.whitelist: - log.debug("Ignoring message {msg} because {room.room_id} is not in whitelist") - say = partial(self.say,room) - db = self.db - chosen = db['__chosen__'] - if msg == "!help" or msg == "!commands": - say(f""" - Kalauerbot Version {version} - - available commands: - !add - add a new person to the kalauer roster (alias: !activate, !reactivate) - !delete - deactivate the person from the roster (alias: !remove, !deactivate, !freeze) - !deactivate - deactivate person (e.g. because he is in holiday) - !activate - re-activate person - !kill - ultimately remove person from kalauer roster (cannot be reversed) - !choose - choose the next person to be the kalauer könig - !who - find out who was chosen to be todays kalauer könig (alias: !wer) - !ok - confirm the kalauer (alias: !gut !passt !reicht !approved) - !reject - reject the kalauer (alias: !zu-gut !zu-schlecht !französisch !french) - !demand - demand a certain person to be the new kalauer könig - !list - list the current roster and weight,totals - !kalauer - an emergency kalauer -""") - - try: command,args= msg.split(" ",1) - except: command = msg - - if command in ["!add", "!activate", "!reactivate"]: - name = args.strip() - if name in db and db[name]['active']: - say(f"{name} already part of the kalauer roster") - elif name in db and not db[name]['active']: - say(f"Reactivating {name}. Welcome back to the world of fun, {name}!") - db[name]['active'] = True - else: - say(f"{name} has been added to the kalauer roster, starting weight is 1") - db[name] = { "weight": 1, "total":0, "active": True} - self.save_db() - elif command in ["!delete","!remove","!deactivate","!freeze"]: - name = args.strip() - if name not in db: - say(f"Cannot deactiate someone who was never in kalauer db") - elif name in db and db[name]['active']: - say(f"Deactivating {name}, see you soon!") - db[name]['active'] = False - else: - say(f"{name} was already deactivated in the kalauer db") - self.save_db() - elif command == "!choose": - # TODO: refactor this, maybe? - names = [] - weights = [] - for name,entity in self.active_db().items(): - names.append(name) - weights.append(entity['weight']) - log.debug(names) - log.debug(weights) - db["__chosen__"] = chosen = random.choices(names,weights=weights)[0] - say(f"{chosen} was chosen to be the next kalauer könig, congratulations!") - self.save_db() - - elif command in ["!who","!wer"]: - if chosen: - say(f"{chosen} was chosen to be the next kalauer könig") - else: - say(f"Nobody was chosen to be the the kalauer könig, start the process with !choose") - elif command in [ "!ok", "!approved", "!gut", "!passt", "!reicht" ]: - log.info("Increasing weight of all active persons") - for name,entity in self.active_db(): - db[name]['weight'] = db[name]['weight'] +1 - log.info("The kalauer könig gets his weight set to 0") - db[chosen]['weight'] = 0 - say(f"""{chosen}, your kalauer has been approved, your total number of approved kalauers is {c['total']} -{chosen}, please choose a new potential kalauer könig by typing in `!choose` or `!demand ` to force the choice""") - log.debug("Unsetting current chosen") - db["__chose__"] = None - self.save_db() - elif command in [ "!reject", "!zu-gut", "!zu-schlecht", "!französisch", "!french"]: - say(f"{chosen}, your kalauer privilege was revoked, nobody is chosen now. Choose another kalauer könig with !choose") - db["__chose__"] = None - self.save_db() - elif command == "!demand": - name = args.strip() - if name in self.active_db(): - say(f"The previous kalauer könig demands user {name} to be the next kalauer könig. The rules of the Kalauer are divine and shall be respected.") - db["__chose__"] = name - elif name in db: - say(f"{name} is currently not active, cannot be chosen") - else: - say(f"{name} name does not exist in the database, add the user before demanding a kalauer from him") - self.save_db() - pass - elif command == "!list": - txt = "Kalauer list:\n" - for name,entry in db.items(): - txt += "{name} - {entry['weight']} weight - {entry['total']} total{'(active)' if entry['active' else '(inactive)'}\n" - say(txt) - elif command == "!kill": - name = args.strip() - if name in db: - say(f"Ultimately removing {name} from Kalauer König db (weight: {db[name]['weight']},total: {db[name]['total']}), we will miss you!") - del db[name] - else: - say(f"Cannot delete someone who was never in the kalauer db") - self.save_db() - elif command == "!demand": - name = args.strip() - elif command == "!kalauer": - kalauer = "Wie nennt man einen dicken Vegetarier? Biotonne!" - translator = Translator() - ret = translator.translate(kalauer,src='de',dest=random.choice(list(LANGUAGES))) - say(ret.text) - else: - - log.debug(f"Receive message {msg}") - -bot = Kalauerbot( - host = "ext01.citadel.team", - display_name = "Kalauerbot", - token = "", - user_id = "" -) - - -bot.start() diff --git a/kalauerbot/bot.py b/kalauerbot/bot.py new file mode 100644 index 0000000..16dded0 --- /dev/null +++ b/kalauerbot/bot.py @@ -0,0 +1,184 @@ +from matrixbot import MatrixBot +from functools import partial +import random +import json +import logging +from googletrans import LANGUAGES,Translator +logging.basicConfig(level=logging.DEBUG) +log = logging.getLogger("Kalauerbot") +version = "1.0.0" + +class Kalauerbot(MatrixBot): + def __init__(self,host,display_name,token,user_id,dbpath = "kalauerdb.json",allowlist=None): + self.allowlist = allowlist + self.dbpath=dbpath + self.load_db() + super().__init__(host,display_name,token,user_id) + + def load_db(self): + try: + log.info(f"loading entries from {self.dbpath}") + self.db = json.load(open(self.dbpath)) + log.debug(self.db) + except: + log.info(f"Cannot open {self.dbpath}, creating empty db") + self.db = { "__chosen__": None } + self.save_db() + def save_db(self): + json.dump(self.db,open(self.dbpath,"w+")) + log.debug(f"saving db to {self.dbpath}") + + def active_db(self): + return dict(self._get_active()) + + def _get_active(self): + for name,entry in self.db.items(): + if name == "__chosen__": + continue # skip the __chosen__ special object + elif entry['active']: + yield name,entry + else: + log.debug(f"skipping {name} because user is inactive") + continue + def process_event(self, room, event): + # {'content': {'body': 'hello bot', 'msgtype': 'm.text'}, 'event_id': '$1597412611141040kQPEC:thales.citadel.team', 'origin_server_ts': 1597412611511, 'sender': '@frichter:thales.citadel.team', 'type': 'm.room.message', 'unsigned': {'age': 98}, 'room_id': '!eXmPERUmuMagsLVxar:thales.citadel.team'} + if self.user_id == event['sender']: return # don't answer own message + if event['type'] != 'm.room.message': return + msg = event['content']['body'] + if self.allowlist and room.room_id not in self.allowlist: + log.debug("Ignoring message {msg} because {room.room_id} is not in allowlist") + say = partial(self.say,room) + db = self.db + chosen = db['__chosen__'] + if msg == "!help" or msg == "!commands": + say(f""" + Kalauerbot Version {version} + + available commands: + !add - add a new person to the kalauer roster (alias: !activate, !reactivate) + !delete - deactivate the person from the roster (alias: !remove, !deactivate, !freeze) + !deactivate - deactivate person (e.g. because he is in holiday) + !activate - re-activate person + !kill - ultimately remove person from kalauer roster (cannot be reversed) + !choose - choose the next person to be the kalauer könig + !who - find out who was chosen to be todays kalauer könig (alias: !wer) + !ok - confirm the kalauer (alias: !gut !passt !reicht !approved) + !reject - reject the kalauer (alias: !zu-gut !zu-schlecht !französisch !french) + !demand - demand a certain person to be the new kalauer könig + !list - list the current roster and weight,totals + !kalauer - an emergency kalauer +""") + + try: command,args= msg.split(" ",1) + except: command = msg + + if command in ["!add", "!activate", "!reactivate"]: + name = args.strip() + if name in db and db[name]['active']: + say(f"{name} already part of the kalauer roster") + elif name in db and not db[name]['active']: + say(f"Reactivating {name}. Welcome back to the world of fun, {name}!") + db[name]['active'] = True + else: + say(f"{name} has been added to the kalauer roster, starting weight is 1") + db[name] = { "weight": 1, "total":0, "active": True} + self.save_db() + elif command in ["!delete","!remove","!deactivate","!freeze"]: + name = args.strip() + if name not in db: + say(f"Cannot deactiate someone who was never in kalauer db") + elif name in db and db[name]['active']: + say(f"Deactivating {name}, see you soon!") + db[name]['active'] = False + else: + say(f"{name} was already deactivated in the kalauer db") + self.save_db() + elif command == "!choose": + # TODO: refactor this, maybe? + names = [] + weights = [] + for name,entity in self.active_db().items(): + names.append(name) + weights.append(entity['weight']) + log.debug(names) + log.debug(weights) + db["__chosen__"] = chosen = random.choices(names,weights=weights)[0] + say(f"{chosen} was chosen to be the next kalauer könig, congratulations!") + self.save_db() + + elif command in ["!who","!wer"]: + if chosen: + say(f"{chosen} was chosen to be the next kalauer könig") + else: + say(f"Nobody was chosen to be the the kalauer könig, start the process with `!choose`") + elif command in [ "!ok", "!approved", "!gut", "!passt", "!reicht" ]: + if not db['__chosen__']: + say("Nobody is nominated, cannot approve kalauer") + else: + log.info("Increasing weight of all active persons") + for name in self.active_db(): + db[name]['weight'] += 1 + log.info("The kalauer könig gets his weight set to 0") + db[chosen]['weight'] = 0 + db[chosen]['total'] += 1 + say(f"""Your kalauer has been approved, your total number of approved kalauers is {db[chosen]['total']}\n\n{chosen}, please choose a new potential kalauer könig by typing in `!choose` to let the kalauerbot choose or `!demand ` to force your choice""") + log.debug("Unsetting current chosen") + db["__chosen__"] = None + self.save_db() + elif command in [ "!reject", "!zu-gut", "!zu-schlecht", "!französisch", "!french"]: + if not db['__chosen__']: + say("Nobody is nominated, cannot reject kalauer") + else: + say(f"{chosen}, your kalauer privilege was revoked, nobody is chosen now. Choose another kalauer könig with `!choose`") + db["__chosen__"] = None + self.save_db() + elif command == "!demand": + name = args.strip() + if name in self.active_db(): + say(f"The previous kalauer könig demands user {name} to be the next kalauer könig. The rules of the Kalauer are divine and shall be respected.") + db["__choses__"] = name + elif name in db: + say(f"{name} is currently not active, cannot be chosen") + else: + say(f"{name} name does not exist in the database, add the user before demanding a kalauer from him") + self.save_db() + elif command == "!list": + txt = "Kalauer roster:\n\n" + for name,entry in db.items(): + if name == '__chosen__': continue + txt += f"* {name} - {entry['weight']} weight - {entry['total']} total {'(active)' if entry['active'] else '(inactive)'}\n" + say(txt) + elif command == "!kill": + name = args.strip() + if name in db: + say(f"Ultimately removing {name} from Kalauer König db (weight: {db[name]['weight']},total: {db[name]['total']}), we will miss you!") + del db[name] + else: + say(f"Cannot delete someone who was never in the kalauer db") + self.save_db() + elif command == "!kalauer": + kalauer = "Wie nennt man einen dicken Vegetarier? Biotonne!" + #kalauer = "What do you call a fat vegetarian? Compost bin" + translator = Translator() + lang = random.choice(list(LANGUAGES)) + ret = translator.translate(kalauer,src='de',dest=lang) + log.debug(ret) + say(f"Your emergency kalauer in {LANGUAGES[lang]}: {ret.text}" ) #needs a newer googletrans + if ret.pronunciation: + say(f"Pronounced: {ret.pronunciation}") + else: + + log.debug(f"Receive message {msg}") + +def main(): + bot = Kalauerbot( + host = "ext01.citadel.team", + display_name = "Kalauerbot", + token = os.environ['CITADEL_TOKEN'], + user_id = os.environ["CITADEL_ID"], + ) + bot.start() + + +if __name__ == "__main__": + main() diff --git a/nix/matrixbot.patch b/nix/matrixbot.patch new file mode 100644 index 0000000..2b9bbbe --- /dev/null +++ b/nix/matrixbot.patch @@ -0,0 +1,12 @@ +diff --git a/matrixbot/matrixbot.py b/matrixbot/matrixbot.py +index 8e5598c..d8c23d2 100644 +--- a/matrixbot/matrixbot.py ++++ b/matrixbot/matrixbot.py +@@ -51,7 +51,6 @@ class MatrixBot: + self.user = None + if self.token is not None and self.user_id is not None: + self.user = self.client.get_user(self.user_id) +- self.user.set_display_name(self.display_name) + self.init_rooms(self.client.rooms) + self.invite_listener = self.client.add_invite_listener(self.handle_invite) + self.cache = Cache(dbfile=cache_db) diff --git a/nix/python-matrixbot.nix b/nix/python-matrixbot.nix new file mode 100644 index 0000000..7bc5aa7 --- /dev/null +++ b/nix/python-matrixbot.nix @@ -0,0 +1,31 @@ +{ lib +, buildPythonPackage +, fetchPypi +, markdown +, matrix-client +}: + +buildPythonPackage rec { + pname = "python-matrixbot"; + version = "0.0.7"; + CI_COMMIT_TAG = version; + + #src = ./python-matrixbot; + src = fetchPypi { + inherit pname version; + sha256 = "9412981b14ff3ab7ffbb1bfc1691758113ab8d71f731b3093d8808c286b69c71"; + }; + patches = [ ./matrixbot.patch ]; + + propagatedBuildInputs = [ + markdown + matrix-client + ]; + + meta = with lib; { + description = "A basic bot for Matrix"; + homepage = https://gitlab.com/gibberfish/python-matrixbot; + license = licenses.mit; + # maintainers = [ maintainers. ]; + }; +} diff --git a/nix/translate.patch b/nix/translate.patch new file mode 100644 index 0000000..6ff8207 --- /dev/null +++ b/nix/translate.patch @@ -0,0 +1,17 @@ +diff --git a/googletrans/client.py b/googletrans/client.py +index 89c2237..c203b44 100644 +--- a/googletrans/client.py ++++ b/googletrans/client.py +@@ -190,6 +190,13 @@ class Translator(object): + pass + if not PY3 and isinstance(pron, unicode) and isinstance(origin, str): # pragma: nocover + origin = origin.decode('utf-8') ++ ++ if pron is None: ++ try: ++ pron = data[0][2][2] ++ except: # pragma: nocover ++ pass ++ + if dest in EXCLUDES and pron == origin: + pron = translated diff --git a/python-matrixbot.nix b/python-matrixbot.nix deleted file mode 100644 index d134e03..0000000 --- a/python-matrixbot.nix +++ /dev/null @@ -1,30 +0,0 @@ -{ lib -, buildPythonPackage -, fetchPypi -, markdown -, matrix-client -}: - -buildPythonPackage rec { - pname = "python-matrixbot"; - version = "0.0.7"; - CI_COMMIT_TAG = version; - - src = ./python-matrixbot; - #src = fetchPypi { - # inherit pname version; - # sha256 = "9412981b14ff3ab7ffbb1bfc1691758113ab8d71f731b3093d8808c286b69c71"; - #}; - - propagatedBuildInputs = [ - markdown - matrix-client - ]; - - meta = with lib; { - description = "A basic bot for Matrix"; - homepage = https://gitlab.com/gibberfish/python-matrixbot; - license = licenses.mit; - # maintainers = [ maintainers. ]; - }; -} -- cgit v1.2.3