Bump version

[sid.git] / sid / plugin.py

diff --git a/sid/plugin.py b/sid/plugin.py
index 6db1d5984f07875af599dd694393ba0aeb8f69c2..f314aca9e0bedaa58dae645bdd28346c9ff7c860 100644 (file)
--- a/sid/plugin.py
+++ b/sid/plugin.py
@@ -1,22 +1,14 @@
 # -*- coding: utf-8 -*-
+# SPDX-FileCopyrightText: 2010, 2011 Anaël Verrier <elghinn@free.fr>
+# SPDX-FileCopyrightText: 2014, 2020, 2023 kaliko <kaliko@azylum.org>
 
-# Copyright (C) 2010, 2011 Anaël Verrier <elghinn@free.fr>
-# Copyright (C) 2014, 2020 kaliko <kaliko@azylum.org>
+import logging
 
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, version 3 only.
-
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+from slixmpp.exceptions import XMPPError
 
 from .sid import botcmd
 
+
 class Plugin:
     """
     Simple Plugin object to derive from:
@@ -26,10 +18,28 @@ class Plugin:
 
     :param sid.sid.MUCBot bot: bot the plugin is load from
     """
+    #: Overriding bot log level for the plugin
+    log_level = None
 
     def __init__(self, bot):
         self.bot = bot
         self.log = bot.log.getChild(self.__class__.__name__)
+        #: :py:obj:`list` : List of tuples (event, handler)
+        self.handlers = []
+        if self.log_level:
+            self.log.setLevel(self.log_level)
+
+    def add_handlers(self):
+        """Add handlers declared in self.hanlders"""
+        for event, handler in self.handlers:
+            self.log.debug(f'Add {event} > {self.__class__.__name__}().{handler.__name__}')
+            self.bot.add_event_handler(event, handler)
+
+    def rm_handlers(self):
+        """Remove handlers declared in self.hanlders"""
+        for event, handler in self.handlers:
+            self.log.debug(f'Remove {event} > {self.__class__.__name__}().{handler.__name__}')
+            self.bot.del_event_handler(event, handler)
 
     def send(self, dest, msg, mtype='chat'):
         """Send msg to dest
@@ -65,5 +75,19 @@ class Plugin:
             to = rcv['mucroom']
         self.send(to, msg, mtype=rcv['type'])
 
+    async def ban(self, jid, reason):
+        """Coroutine to ban a jid from the room
+
+        :param str jid: JID to ban
+        :param str reason: Reason
+        """
+        room = self.bot.room
+        try:
+            await self.bot['xep_0045'].set_affiliation(room,
+                    jid=jid, affiliation='outcast', reason=reason)
+        except XMPPError as error:
+            self.log.error(error)
+
     def shutdown(self):
+        """Empty method to override. Called on bot shutdown"""
         pass