Implement hook actino and regex_hook priority

Author: linuxdaemon

cloudbot/bot.py

@@ -5,6 +5,8 @@
 import re
 import os
 import gc
+from operator import not_, attrgetter, itemgetter
+
 from sqlalchemy import create_engine
 
 from sqlalchemy.orm import scoped_session, sessionmaker
@@ -14,6 +16,7 @@
 import cloudbot
 from cloudbot.client import Client
 from cloudbot.config import Config
+from cloudbot.hook import Action
 from cloudbot.reloader import PluginReloader
 from cloudbot.plugin import PluginManager
 from cloudbot.event import Event, CommandEvent, RegexEvent, EventType
@@ -221,23 +224,46 @@ def process(self, event):
         run_before_tasks = []
         tasks = []
         command_prefix = event.conn.config.get('command_prefix', '.')
+        halted = False
+
+        def add_hook(hook, _event, _run_before=False):
+            nonlocal halted
+            if halted:
+                return False
+
+            coro = self.plugin_manager.launch(hook, _event)
+            if _run_before:
+                run_before_tasks.append(coro)
+            else:
+                tasks.append(coro)
+
+            if hook.action is Action.HALTALL:
+                halted = True
+                return False
+            elif hook.action is Action.HALTTYPE:
+                return False
+            return True
 
         # Raw IRC hook
         for raw_hook in self.plugin_manager.catch_all_triggers:
             # run catch-all coroutine hooks before all others - TODO: Make this a plugin argument
-            if not raw_hook.threaded:
-                run_before_tasks.append(
-                    self.plugin_manager.launch(raw_hook, Event(hook=raw_hook, base_event=event)))
-            else:
-                tasks.append(self.plugin_manager.launch(raw_hook, Event(hook=raw_hook, base_event=event)))
+            run_before = not raw_hook.threaded
+            if not add_hook(raw_hook, Event(hook=raw_hook, base_event=event), _run_before=run_before):
+                # The hook has an action of Action.HALT* so stop adding new tasks
+                break
+
         if event.irc_command in self.plugin_manager.raw_triggers:
             for raw_hook in self.plugin_manager.raw_triggers[event.irc_command]:
-                tasks.append(self.plugin_manager.launch(raw_hook, Event(hook=raw_hook, base_event=event)))
+                if not add_hook(raw_hook, Event(hook=raw_hook, base_event=event)):
+                    # The hook has an action of Action.HALT* so stop adding new tasks
+                    break
 
         # Event hooks
         if event.type in self.plugin_manager.event_type_hooks:
             for event_hook in self.plugin_manager.event_type_hooks[event.type]:
-                tasks.append(self.plugin_manager.launch(event_hook, Event(hook=event_hook, base_event=event)))
+                if not add_hook(event_hook, Event(hook=event_hook, base_event=event)):
+                    # The hook has an action of Action.HALT* so stop adding new tasks
+                    break
 
         if event.type is EventType.message:
             # Commands
@@ -258,7 +284,7 @@ def process(self, event):
                     command_hook = self.plugin_manager.commands[command]
                     command_event = CommandEvent(hook=command_hook, text=text,
                                                  triggered_command=command, base_event=event)
-                    tasks.append(self.plugin_manager.launch(command_hook, command_event))
+                    add_hook(command_hook, command_event)
                 else:
                     potential_matches = []
                     for potential_match, plugin in self.plugin_manager.commands.items():
@@ -269,20 +295,25 @@ def process(self, event):
                             command_hook = potential_matches[0][1]
                             command_event = CommandEvent(hook=command_hook, text=text,
                                                          triggered_command=command, base_event=event)
-                            tasks.append(self.plugin_manager.launch(command_hook, command_event))
+                            add_hook(command_hook, command_event)
                         else:
                             event.notice("Possible matches: {}".format(
                                 formatting.get_text_list([command for command, plugin in potential_matches])))
 
             # Regex hooks
-            for regex, regex_hook in self.plugin_manager.regex_hooks:
+            def regex_priority(t):
+                return t[1].priority
+
+            for regex, regex_hook in sorted(self.plugin_manager.regex_hooks, key=regex_priority, reverse=True):
                 if not regex_hook.run_on_cmd and cmd_match:
-                    pass
-                else:
-                    regex_match = regex.search(event.content)
-                    if regex_match:
-                        regex_event = RegexEvent(hook=regex_hook, match=regex_match, base_event=event)
-                        tasks.append(self.plugin_manager.launch(regex_hook, regex_event))
+                    continue
+
+                regex_match = regex.search(event.content)
+                if regex_match:
+                    regex_event = RegexEvent(hook=regex_hook, match=regex_match, base_event=event)
+                    if not add_hook(regex_hook, regex_event):
+                        # The hook has an action of Action.HALT* so stop adding new tasks
+                        break
 
         # Run the tasks
         yield from asyncio.gather(*run_before_tasks, loop=self.loop)

cloudbot/plugin.py

@@ -9,6 +9,7 @@
 import sqlalchemy
 
 from cloudbot.event import Event
+from cloudbot.hook import Priority, Action
 from cloudbot.util import database
 
 logger = logging.getLogger("cloudbot")
@@ -594,6 +595,7 @@ def __init__(self, _type, plugin, func_hook):
 
         self.permissions = func_hook.kwargs.pop("permissions", [])
         self.single_thread = func_hook.kwargs.pop("singlethread", False)
+        self.action = func_hook.kwargs.pop("action", Action.CONTINUE)
 
         if func_hook.kwargs:
             # we should have popped all the args, so warn if there are any left
@@ -650,6 +652,7 @@ def __init__(self, plugin, regex_hook):
         :type regex_hook: cloudbot.util.hook._RegexHook
         """
         self.run_on_cmd = regex_hook.kwargs.pop("run_on_cmd", False)
+        self.priority = regex_hook.kwargs.pop("priority", Priority.NORMAL)
 
         self.regexes = regex_hook.regexes