Remove direct references between plugins

Author: linuxdaemon

cloudbot/plugin.py

@@ -11,6 +11,7 @@
 from itertools import chain
 from operator import attrgetter
 from pathlib import Path
+from weakref import WeakValueDictionary
 
 import sqlalchemy
 
@@ -90,6 +91,7 @@ def __init__(self, bot):
         self.bot = bot
 
         self.plugins = {}
+        self._plugin_name_map = WeakValueDictionary()
         self.commands = {}
         self.raw_triggers = {}
         self.catch_all_triggers = []
@@ -103,6 +105,14 @@ def __init__(self, bot):
         self.perm_hooks = defaultdict(list)
         self._hook_waiting_queues = {}
 
+    def find_plugin(self, title):
+        """
+        Finds a loaded plugin and returns its Plugin object
+        :param title: the title of the plugin to find
+        :return: The Plugin object if it exists, otherwise None
+        """
+        return self._plugin_name_map.get(title)
+
     @asyncio.coroutine
     def load_all(self, plugin_dir):
         """
@@ -187,6 +197,7 @@ def load_plugin(self, path):
                 return
 
         self.plugins[plugin.file_path] = plugin
+        self._plugin_name_map[plugin.title] = plugin
 
         for on_cap_available_hook in plugin.hooks["on_cap_available"]:
             for cap in on_cap_available_hook.caps:
@@ -610,6 +621,8 @@ def __init__(self, filepath, filename, title, 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)
+        # Keep a reference to this in case another plugin needs to access it
+        self.code = code
 
     @asyncio.coroutine
     def create_tables(self, bot):

plugins/herald.py

@@ -1,7 +1,6 @@
 import re
 import time
 from cloudbot import hook
-from plugins import grab
 
 import random
 
@@ -62,7 +61,7 @@ def deleteherald(text, chan, db, conn):
         return "{} does not have a herald".format(text.lower())
 
 @hook.irc_raw("JOIN", singlethread=True)
-def welcome(nick, action, message, chan, event, db, conn):
+def welcome(nick, message, event, db, bot):
     # For some reason chan isn't passed correctly. The below hack is sloppy and may need to be adjusted for different networks.
     # If someone knows how to get the channel a better way please fix this.
     # freenode uncomment then next line
@@ -73,6 +72,8 @@ def welcome(nick, action, message, chan, event, db, conn):
     bino_re = re.compile('b+i+n+o+', re.IGNORECASE)
     offensive_re = re.compile('卐')
 
+    grab = bot.plugin_manager.find_plugin("grab")
+
     try:
         chan = event.irc_raw.split(':')[2].lower()
     except:
@@ -97,7 +98,11 @@ def welcome(nick, action, message, chan, event, db, conn):
             if len(greet.split(' ')) >= 2:
                 candidates = greet.lower().split(' ')[1:]
                 text = random.choice(candidates)
-            out = grab.grabrandom(text, chan, message)
+            if grab is not None:
+                out = grab.grabrandom(text, chan, message)
+            else:
+                out = "grab.py not loaded, original herald: {}".format(greet)
+
             message(out, chan)
         elif decoy.search(colors_re.sub("", greet.replace('\u200b', '').replace(' ', '').replace('\u202f','').replace('\x02', ''))):
             message("DECOY DUCK --> {}".format(greet), chan)