Merge branch 'gonzobot' of github.com:edwardslabs/CloudBot into gonzobot

Author: edwardslabs

cloudbot/hook.py

@@ -316,7 +316,6 @@ def _periodic_hook(func):
         return lambda func: _periodic_hook(func)
 
 
-
 def on_start(param=None, **kwargs):
     """External on_start decorator. Can be used directly as a decorator, or with args to return a decorator
     :type param: function | None
@@ -339,3 +338,22 @@ def _on_start_hook(func):
 
 # this is temporary, to ease transition
 onload = on_start
+
+
+def on_stop(param=None, **kwargs):
+    """External on_stop decorator. Can be used directly as a decorator, or with args to return a decorator
+    :type param: function | None
+    """
+    def _on_stop_hook(func):
+        hook = _get_hook(func, "on_stop")
+        if hook is None:
+            hook = _Hook(func, "on_stop")
+            _add_hook(func, hook)
+        hook._add_hook(kwargs)
+        return func
+    if callable(param):
+        return _on_stop_hook(param)
+    else:
+        return lambda func: _on_stop_hook(func)
+
+on_unload = on_stop

cloudbot/plugin.py

@@ -18,7 +18,7 @@ def find_hooks(parent, module):
     """
     :type parent: Plugin
     :type module: object
-    :rtype: (list[CommandHook], list[RegexHook], list[RawHook], list[SieveHook], List[EventHook], list[OnStartHook])
+    :rtype: (list[CommandHook], list[RegexHook], list[RawHook], list[SieveHook], List[EventHook], List[PeriodicHook], list[OnStartHook], List[OnStopHook])
     """
     # set the loaded flag
     module._cloudbot_loaded = True
@@ -29,8 +29,9 @@ def find_hooks(parent, module):
     event = []
     periodic = []
     on_start = []
+    on_stop = []
     type_lists = {"command": command, "regex": regex, "irc_raw": raw, "sieve": sieve, "event": event,
-                  "periodic": periodic, "on_start": on_start}
+                  "periodic": periodic, "on_start": on_start, "on_stop": on_stop}
     for name, func in module.__dict__.items():
         if hasattr(func, "_cloudbot_hook"):
             # if it has cloudbot hook
@@ -42,7 +43,7 @@ def find_hooks(parent, module):
             # delete the hook to free memory
             del func._cloudbot_hook
 
-    return command, regex, raw, sieve, event, periodic, on_start
+    return command, regex, raw, sieve, event, periodic, on_start, on_stop
 
 
 def find_tables(code):
@@ -293,6 +294,11 @@ def unload_plugin(self, path):
         for sieve_hook in plugin.sieves:
             self.sieves.remove(sieve_hook)
 
+        # Run on_stop hooks
+        for on_stop_hook in plugin.run_on_stop:
+            event = Event(bot=self.bot, hook=on_stop_hook)
+            yield from self.launch(on_stop_hook, event)
+
         # unregister databases
         plugin.unregister_tables(self.bot)
 
@@ -439,7 +445,7 @@ def launch(self, hook, event):
         :rtype: bool
         """
 
-        if hook.type not in ("on_start", "periodic"):  # we don't need sieves on on_start hooks.
+        if hook.type not in ("on_start", "on_stop", "periodic"):  # we don't need sieves on on_start hooks.
             for sieve in self.bot.plugin_manager.sieves:
                 event = yield from self._sieve(sieve, event, hook)
                 if event is None:
@@ -515,7 +521,7 @@ def __init__(self, filepath, filename, title, code):
         self.file_path = filepath
         self.file_name = filename
         self.title = title
-        self.commands, self.regexes, self.raw_hooks, self.sieves, self.events, self.periodic, self.run_on_start = find_hooks(self, code)
+        self.commands, self.regexes, self.raw_hooks, self.sieves, self.events, self.periodic, self.run_on_start, self.run_on_stop = find_hooks(self, code)
         # we need to find tables for each plugin so that they can be unloaded from the global metadata when the
         # plugin is reloaded
         self.tables = find_tables(code)
@@ -759,12 +765,24 @@ def __str__(self):
         return "on_start {} from {}".format(self.function_name, self.plugin.file_name)
 
 
+class OnStopHook(Hook):
+    def __init__(self, plugin, on_stop_hook):
+        super().__init__("on_stop", plugin, on_stop_hook)
+
+    def __repr__(self):
+        return "On_stop[{}]".format(Hook.__repr__(self))
+
+    def __str__(self):
+        return "on_stop {} from {}".format(self.function_name, self.plugin.file_name)
+
+
 _hook_name_to_plugin = {
     "command": CommandHook,
     "regex": RegexHook,
     "irc_raw": RawHook,
     "sieve": SieveHook,
     "event": EventHook,
     "periodic": PeriodicHook,
-    "on_start": OnStartHook
+    "on_start": OnStartHook,
+    "on_stop": OnStopHook,
 }

plugins/grab.py

@@ -17,23 +17,21 @@
     Column('chan', String)
 )
 
+grab_cache = {}
+
+
 @hook.on_start()
 def load_cache(db):
     """
     :type db: sqlalchemy.orm.Session
     """
-    global grab_cache
-    grab_cache = {}
+    grab_cache.clear()
     for row in db.execute(table.select().order_by(table.c.time)):
         name = row["name"].lower()
         quote = row["quote"]
         chan = row["chan"]
-        if chan not in grab_cache:
-            grab_cache.update({chan:{name:[chan]}})
-        elif name not in grab_cache[chan]:
-            grab_cache[chan].update({name:[quote]})
-        else:
-            grab_cache[chan][name].append(quote)
+        grab_cache.setdefault(chan, {}).setdefault(name, []).append(quote)
+
 
 def two_lines(bigstring, chan):
     """Receives a string with new lines. Groups the string into a list of strings with up to 3 new lines per string element. Returns first string element then stores the remaining list in search_pages."""
@@ -61,7 +59,7 @@ def moregrab(text, chan):
         index = ""
         try:
             index = int(text)
-        except:
+        except ValueError:
             return "Please specify an integer value."
         if abs(int(index)) > len(search_pages[chan]) or index == 0:
             return "please specify a valid page number between 1 and {}.".format(len(search_pages[chan]))
@@ -74,15 +72,17 @@ def moregrab(text, chan):
         else:
             return "All pages have been shown you can specify a page number or do a new search."
 
+
 def check_grabs(name, quote, chan):
     try:
         if quote in grab_cache[chan][name]:
             return True
         else:
             return False
-    except:
+    except KeyError:
         return False
 
+
 def grab_add(nick, time, msg, chan, db, conn):
     # Adds a quote to the grab table
     db.execute(table.insert().values(name=nick, time=time, quote=msg, chan=chan))
@@ -103,15 +103,16 @@ def grab(text, nick, chan, db, conn):
             # check to see if the quote has been added
             if check_grabs(name.lower(), msg, chan):
                 return "I already have that quote from {} in the database".format(text)
-                break
             else:
                 # the quote is new so add it to the db.
                 grab_add(name.lower(),timestamp, msg, chan, db, conn)
                 if check_grabs(name.lower(), msg, chan):
                     return "the operation succeeded."
-                break
+                else:
+                    return "the operation failed"
     return "I couldn't find anything from {} in recent history.".format(text)
 
+
 def format_grab(name, quote):
     # add nonbreaking space to nicks to avoid highlighting people with printed grabs
     name = "{}{}{}".format(name[0], u"\u200B", name[1:])
@@ -123,13 +124,14 @@ def format_grab(name, quote):
         out = "<{}> {}".format(name, quote)
         return out
 
+
 @hook.command("lastgrab", "lgrab")
 def lastgrab(text, chan, message):
     """prints the last grabbed quote from <nick>."""
     lgrab = ""
     try:
         lgrab = grab_cache[chan][text.lower()][-1]
-    except:
+    except (KeyError, IndexError):
         return "<{}> has never been grabbed.".format(text)
     if lgrab:
         quote = lgrab
@@ -150,11 +152,11 @@ def grabrandom(text, chan, message):
     else:
         try:
             name = random.choice(list(grab_cache[chan].keys()))
-        except:
+        except KeyError:
             return "I couldn't find any grabs in {}.".format(chan)
     try:
         grab = random.choice(grab_cache[chan][name.lower()])
-    except:
+    except KeyError:
         return "it appears {} has never been grabbed in {}".format(name, chan)
     if grab:
         message(format_grab(name, grab), chan)
@@ -173,8 +175,8 @@ def grabsearch(text, chan):
         quotes = grab_cache[chan][text.lower()]
         for grab in quotes:
             result.append((text, grab))
-    except:
-       pass
+    except KeyError:
+        pass
     for name in grab_cache[chan]:
         for grab in grab_cache[chan][name]:
             if name != text.lower():