filter hooks by connection and context in core

(cherry picked from commit 9126ce9202)

docs/plugin-api-additions/filters.md

@@ -0,0 +1,24 @@
+# Core-filtered hooks
+
+Python: `hook_server_filtered(name, callback, userdata=None, priority=PRI_NORM,
+connection_id=None, channel=None)` and `hook_print_filtered(...)`.
+Callbacks match the existing attrs variants: `(word, word_eol, userdata, attrs)`.
+The connection ID distinguishes duplicate names; None/-1 means any connection
+(including connection ID zero). A channel restriction uses that connection's
+IRC comparator. None means any context; an empty string is an exact restriction.
+
+C: the corresponding zoitechat_hook_*_filtered functions accept
+`(ph, name, pri, flags, connection_id, channel, callback, userdata)`;
+flags=0, ID=-1 for any and NULL channel for any. Check
+`get_info("api_context_filters")` for "1" before accessing the new Windows slots.
+
+Filtering takes place before Python/interpreter entry. Existing unrestricted
+hooks, priority, EAT semantics and unload/unhook handling are unchanged.
+Filters refer to the core-selected context, not an IRC target parsed from the
+line: unknown queries/channels can still have a server-tab context, and QUIT
+has its usual single server-hook context. Connection IDs last only this process.
+
+```python
+zoitechat.hook_print_filtered('Channel Message', callback,
+                             connection_id=zoitechat.get_prefs('id'), channel='#zoitechat')
+```

docs/plugin-api-additions/post.md

@@ -1,21 +0,0 @@
-# Post-display print observers
-
-Python: `hook_print_after(name, callback, userdata=None, priority=PRI_NORM)`.
-The callback is `(word, word_eol, userdata, attrs)`, matching hook_print_attrs().
-It runs after display_event() has handled the text, so prnt() follows the original
-text. Return values are ignored. Events eaten by a pre-hook or hidden by client
-preferences do not invoke these observers. This is post-display notification,
-not a notification that the entire incoming IRC command has finished updating state.
-
-C: `zoitechat_hook_print_after(ph, name, priority, flags, callback, userdata)`;
-flags must be zero. Check `get_info("api_hook_print_after")` for "1" before
-accessing the appended Windows function-table slot. Existing pre-hook timing is
-unchanged. Unhook/unload use existing lifecycle functions. Recursive emission
-skips an already-running observer to prevent it immediately invoking itself.
-
-```python
-def after(word, word_eol, userdata, attrs):
-    zoitechat.prnt('This follows the original channel message')
-
-zoitechat.hook_print_after('Channel Message', after)
-```

plugins/python/_zoitechat_filters.py

@@ -0,0 +1,36 @@
+"""Context restrictions evaluated by core before entering Python."""
+import operator
+import _zoitechat as api
+from _zoitechat_embedded import ffi, lib
+
+__all__ = ['hook_server_filtered', 'hook_print_filtered']
+
+
+def _register(name, callback, userdata, priority, connection_id, channel, server):
+    if not callable(callback):
+        raise TypeError('callback must be callable')
+    connection_id = -1 if connection_id is None else operator.index(connection_id)
+    if connection_id < -1 or connection_id > 2147483647:
+        raise ValueError('connection_id must fit the C API; -1 means any')
+    plugin = api.__get_current_plugin()
+    hook = plugin.add_hook(callback, userdata)
+    register = lib.zoitechat_hook_server_filtered if server else lib.zoitechat_hook_print_filtered
+    dispatch = lib._on_server_attrs_hook if server else lib._on_print_attrs_hook
+    handle = register(lib.ph, name.encode(), priority, 0, connection_id,
+                      ffi.NULL if channel is None else channel.encode(), dispatch, hook.handle)
+    if handle == ffi.NULL:
+        hook.is_unload = True
+        plugin.remove_hook(id(hook))
+        raise RuntimeError('unable to install filtered hook')
+    hook.zoitechat_hook = handle
+    return id(hook)
+
+
+def hook_server_filtered(name, callback, userdata=None, priority=api.PRI_NORM,
+                         connection_id=None, channel=None):
+    return _register(name, callback, userdata, priority, connection_id, channel, True)
+
+
+def hook_print_filtered(name, callback, userdata=None, priority=api.PRI_NORM,
+                        connection_id=None, channel=None):
+    return _register(name, callback, userdata, priority, connection_id, channel, False)

plugins/python/_zoitechat_post.py

@@ -1,21 +0,0 @@
-"""Opt-in post-display print observers."""
-import _zoitechat as api
-from _zoitechat_embedded import ffi, lib
-
-__all__ = ['hook_print_after']
-
-
-def hook_print_after(name, callback, userdata=None, priority=api.PRI_NORM):
-    """callback(word, word_eol, userdata, attrs); its return value is ignored."""
-    if not callable(callback):
-        raise TypeError('callback must be callable')
-    plugin = api.__get_current_plugin()
-    hook = plugin.add_hook(callback, userdata)
-    handle = lib.zoitechat_hook_print_after(lib.ph, name.encode(), priority, 0,
-                                           lib._on_print_attrs_hook, hook.handle)
-    if handle == ffi.NULL:
-        hook.is_unload = True
-        plugin.remove_hook(id(hook))
-        raise RuntimeError('unable to install post-display hook')
-    hook.zoitechat_hook = handle
-    return id(hook)

src/common/plugin.c

@@ -99,6 +99,9 @@ struct _zoitechat_hook
 	int tag;				/* for timers & FDs only */
 	int type;			/* HOOK_* */
 	int pri;	/* fd */	/* priority / fd for HOOK_FD only */
+	int connection_filter;
+	char *channel_filter;
+	gboolean context_filtered;
 };
 
 struct _zoitechat_list
@@ -143,8 +146,7 @@ enum
 	HOOK_PRINT_ATTRS  = 1 << 4, /* same as above, with attributes */
 	HOOK_TIMER        = 1 << 5, /* timeouts */
 	HOOK_FD           = 1 << 6, /* sockets & fds */
-	HOOK_DELETED      = 1 << 7, /* marked for deletion */
-	HOOK_PRINT_AFTER  = 1 << 8  /* post-display observers */
+	HOOK_DELETED      = 1 << 7  /* marked for deletion */
 };
 
 enum
@@ -352,7 +354,8 @@ plugin_add (session *sess, char *filename, void *handle, void *init_func,
 		pl->zoitechat_emit_print_attrs = zoitechat_emit_print_attrs;
 		pl->zoitechat_event_attrs_create = zoitechat_event_attrs_create;
 		pl->zoitechat_event_attrs_free = zoitechat_event_attrs_free;
-		pl->zoitechat_hook_print_after = zoitechat_hook_print_after;
+		pl->zoitechat_hook_server_filtered = zoitechat_hook_server_filtered;
+		pl->zoitechat_hook_print_filtered = zoitechat_hook_print_filtered;
 
 		/* run zoitechat_plugin_init, if it returns 0, close the plugin */
 		if (((zoitechat_init_func *)init_func) (pl, &pl->name, &pl->desc, &pl->version, arg) == 0)
@@ -623,13 +626,15 @@ plugin_hook_run (session *sess, char *name, char *word[], char *word_eol[],
 
 		hook = list->data;
 		next = list->next;
-		if (type == HOOK_PRINT_AFTER && hook->tag)
+		if (hook->context_filtered &&
+			(!is_session (sess) ||
+			 (hook->connection_filter != -1 && hook->connection_filter != sess->server->id) ||
+			 (hook->channel_filter && sess->server->p_cmp (hook->channel_filter, sess->channel))))
 		{
 			list = next;
-			continue;
+			continue; /* filter in C before entering an interpreter */
 		}
-		if (type == HOOK_PRINT_AFTER)
-			hook->tag = 1;
+
 		hook->pl->context = sess;
 
 		/* run the plugin's callback function */
@@ -638,7 +643,6 @@ plugin_hook_run (session *sess, char *name, char *word[], char *word_eol[],
 		case HOOK_COMMAND:
 			ret = ((zoitechat_cmd_cb *)hook->callback) (word, word_eol, hook->userdata);
 			break;
-		case HOOK_PRINT_AFTER:
 		case HOOK_PRINT_ATTRS:
 			ret = ((zoitechat_print_attrs_cb *)hook->callback) (word, attrs, hook->userdata);
 			break;
@@ -653,15 +657,6 @@ plugin_hook_run (session *sess, char *name, char *word[], char *word_eol[],
 			break;
 		}
 
-		if (type == HOOK_PRINT_AFTER)
-		{
-			hook->tag = 0;
-			if (!is_session (sess))
-				goto xit;
-			list = next;
-			continue;
-		}
-
 		if ((ret & ZOITECHAT_EAT_ZOITECHAT) && (ret & ZOITECHAT_EAT_PLUGIN))
 		{
 			eat = 1;
@@ -744,15 +739,6 @@ plugin_emit_print (session *sess, char *word[], time_t server_time)
 							HOOK_PRINT | HOOK_PRINT_ATTRS);
 }
 
-void
-plugin_emit_print_after (session *sess, char *word[], time_t server_time)
-{
-	zoitechat_event_attrs attrs;
-	attrs.server_time_utc = server_time;
-	if (is_session (sess))
-		plugin_hook_run (sess, word[0], word, NULL, &attrs, HOOK_PRINT_AFTER);
-}
-
 int
 plugin_emit_dummy_print (session *sess, char *name)
 {
@@ -1052,17 +1038,43 @@ zoitechat_unhook (zoitechat_plugin *ph, zoitechat_hook *hook)
 
 	g_free (hook->name);	/* NULL for timers & fds */
 	g_free (hook->help_text);	/* NULL for non-commands */
+	g_free (hook->channel_filter);
+	hook->channel_filter = NULL;
 
 	return hook->userdata;
 }
 
-zoitechat_hook *
-zoitechat_hook_print_after (zoitechat_plugin *ph, const char *name, int pri,
-                          int flags, zoitechat_print_attrs_cb *callback, void *userdata)
+static zoitechat_hook *
+plugin_add_filtered_hook (zoitechat_plugin *ph, const char *name, int pri,
+                         int flags, int connection_id, const char *channel,
+                         int type, void *callback, void *userdata)
 {
-	if (flags != 0 || !name || !callback)
-		return NULL;
-	return plugin_add_hook (ph, HOOK_PRINT_AFTER, pri, name, NULL, callback, 0, userdata);
+    zoitechat_hook *hook;
+    if (flags != 0 || connection_id < -1 || !name || !callback)
+        return NULL;
+    hook = plugin_add_hook (ph, type, pri, name, NULL, callback, 0, userdata);
+    hook->context_filtered = TRUE;
+    hook->connection_filter = connection_id;
+    hook->channel_filter = g_strdup (channel);
+    return hook;
+}
+
+zoitechat_hook *
+zoitechat_hook_server_filtered (zoitechat_plugin *ph, const char *name, int pri,
+                               int flags, int connection_id, const char *channel,
+                               zoitechat_serv_attrs_cb *callback, void *userdata)
+{
+    return plugin_add_filtered_hook (ph, name, pri, flags, connection_id, channel,
+        HOOK_SERVER_ATTRS, callback, userdata);
+}
+
+zoitechat_hook *
+zoitechat_hook_print_filtered (zoitechat_plugin *ph, const char *name, int pri,
+                              int flags, int connection_id, const char *channel,
+                              zoitechat_print_attrs_cb *callback, void *userdata)
+{
+    return plugin_add_filtered_hook (ph, name, pri, flags, connection_id, channel,
+        HOOK_PRINT_ATTRS, callback, userdata);
 }
 
 zoitechat_hook *
@@ -1224,7 +1236,7 @@ zoitechat_get_info (zoitechat_plugin *ph, const char *id)
 		return text_find_format_string (e);
 	}
 
-	if (strcmp (id, "api_hook_print_after") == 0)
+	if (strcmp (id, "api_context_filters") == 0)
 		return "1";
 
 	hash = str_hash (id);

src/common/plugin.h

@@ -183,7 +183,6 @@ int plugin_emit_command (session *sess, char *name, char *word[], char *word_eol
 int plugin_emit_server (session *sess, char *name, char *word[], char *word_eol[],
 						time_t server_time);
 int plugin_emit_print (session *sess, char *word[], time_t server_time);
-void plugin_emit_print_after (session *sess, char *word[], time_t server_time);
 int plugin_emit_dummy_print (session *sess, char *name);
 int plugin_emit_keypress (session *sess, unsigned int state, unsigned int keyval, gunichar key);
 GList* plugin_command_list(GList *tmp_list);

src/common/text.c

@@ -2320,7 +2320,6 @@ text_emit_with_message (int index, session *sess, char *a, char *b, char *c, cha
 	if (!prefs.hex_away_omit_alerts || !sess->server->is_away)
 		sound_play_event (index);
 	display_event (sess, index, word, stripcolor_args, timestamp, message);
-	plugin_emit_print_after (sess, word, timestamp);
 }
 
 char *

src/common/zoitechat-plugin.h

@@ -206,9 +206,15 @@ struct _zoitechat_plugin
 #endif
 
 
-/* api_hook_print_after=1: observer returns are ignored; flags must be zero. */
-zoitechat_hook *zoitechat_hook_print_after (zoitechat_plugin *ph,
-    const char *name, int pri, int flags,
+/* api_context_filters=1: connection_id -1 is any; NULL channel is any. */
+zoitechat_hook *zoitechat_hook_server_filtered (zoitechat_plugin *ph,
+    const char *name, int pri, int flags, int connection_id, const char *channel,
+    int (*callback) (char *word[], char *word_eol[],
+                     zoitechat_event_attrs *attrs, void *userdata),
+    void *userdata);
+
+zoitechat_hook *zoitechat_hook_print_filtered (zoitechat_plugin *ph,
+    const char *name, int pri, int flags, int connection_id, const char *channel,
     int (*callback) (char *word[], zoitechat_event_attrs *attrs, void *userdata),
     void *userdata);
 
@@ -431,7 +437,8 @@ zoitechat_pluginpref_list (zoitechat_plugin *ph,
 #define zoitechat_hook_server ((ZOITECHAT_PLUGIN_HANDLE)->zoitechat_hook_server)
 #define zoitechat_hook_server_attrs ((ZOITECHAT_PLUGIN_HANDLE)->zoitechat_hook_server_attrs)
 #define zoitechat_hook_print ((ZOITECHAT_PLUGIN_HANDLE)->zoitechat_hook_print)
-#define zoitechat_hook_print_after ((ZOITECHAT_PLUGIN_HANDLE)->zoitechat_hook_print_after)
+#define zoitechat_hook_server_filtered ((ZOITECHAT_PLUGIN_HANDLE)->zoitechat_hook_server_filtered)
+#define zoitechat_hook_print_filtered ((ZOITECHAT_PLUGIN_HANDLE)->zoitechat_hook_print_filtered)
 #define zoitechat_hook_print_attrs ((ZOITECHAT_PLUGIN_HANDLE)->zoitechat_hook_print_attrs)
 #define zoitechat_hook_timer ((ZOITECHAT_PLUGIN_HANDLE)->zoitechat_hook_timer)
 #define zoitechat_hook_fd ((ZOITECHAT_PLUGIN_HANDLE)->zoitechat_hook_fd)