Changeset 9d6c0f2

Timestamp:

2016-05-15T16:16:37Z (9 years ago)

Author:

jgeboski <jgeboski@…>

Parents:

4fe91a1

Message:

Implemented ABI checking for external plugins

As of now, bitlbee will load any plugin regardless of the ABI it was
built against. This is really problematic when structures or symbols
are changed within bitlbee. This often leads to the plugin not loading
or the plugin acting in an undefined way. Typically a simple rebuild of
the plugin will resolve such issues, but many users have no idea that
this is required after they have updated bitlbee.

Each plugin must now have an init_plugin_abi() function along with its
init_plugin() function. This new function is called very early in the
plugin loading process to ensure the plugin actually matches the ABI of
bitlbee. The constant value of BITLBEE_ABI_VERSION_CODE is returned by
the function, which embeds the constant value into the plugin. This
value is then read by bitlbee upon every plugin load to ensure that the
proper ABI is use. If not, bitlbee will refuse to load the plugin.

The boiler-plate implementation of init_plugin_abi():

guint init_plugin_abi(void)
{

return BITLBEE_ABI_VERSION_CODE;

}

Third party plugins may also want to provide backwards compatibility
with older bitlbee versions by defining the missing version macro:

#ifndef BITLBEE_ABI_VERSION_CODE
#define BITLBEE_ABI_VERSION_CODE 0
#endif

Files:

• bitlbee.h (modified) (1 diff)
• otr.c (modified) (1 diff)
• protocols/nogaim.c (modified) (2 diffs)
• protocols/skype/skype.c (modified) (1 diff)

bitlbee.h

@@ -40 +40 @@
 #define BITLBEE_VER(a, b, c) (((a) << 16) + ((b) << 8) + (c))
 #define BITLBEE_VERSION_CODE BITLBEE_VER(3, 4, 2)
+#define BITLBEE_ABI_VERSION_CODE 1
 
 #define MAX_STRING 511

otr.c

@@ -267 +267 @@
         register_irc_plugin(&otr_plugin);
 }
+
+#ifndef OTR_BI
+guint init_plugin_abi(void)
+{
+        return BITLBEE_ABI_VERSION_CODE;
+}
+#endif
 
 gboolean otr_irc_new(irc_t *irc)

protocols/nogaim.c

@@ -42 +42 @@
 gboolean load_plugin(char *path)
 {
+        guint abi;
+        guint (*abi_function) (void);
         void (*init_function) (void);
 
@@ -51 +53 @@
         }
 
+        if (!g_module_symbol(mod, "init_plugin_abi", (gpointer *) &abi_function)) {
+                log_message(LOGLVL_WARNING, "Can't find function `init_plugin_abi' in `%s'\n", path);
+                g_module_close(mod);
+                return FALSE;
+        }
+
+        abi = abi_function();
+
+        if (abi != BITLBEE_ABI_VERSION_CODE) {
+                log_message(LOGLVL_WARNING,
+                            "`%s' uses ABI %u but %u is required\n",
+                            path, abi, BITLBEE_ABI_VERSION_CODE);
+                g_module_close(mod);
+                return FALSE;
+        }
+
         if (!g_module_symbol(mod, "init_plugin", (gpointer *) &init_function)) {
                 log_message(LOGLVL_WARNING, "Can't find function `init_plugin' in `%s'\n", path);
+                g_module_close(mod);
                 return FALSE;
         }

protocols/skype/skype.c

@@ -1763 +1763 @@
         register_protocol(ret);
 }
+
+guint init_plugin_abi(void)
+{
+        return BITLBEE_ABI_VERSION_CODE;
+}