/* * plugins.c * vim: expandtab:ts=4:sts=4:sw=4 * * Copyright (C) 2012 - 2019 James Booth * * SPDX-License-Identifier: GPL-3.0-or-later WITH OpenSSL-exception */ #include #include #include #include "log.h" #include "config.h" #include "common.h" #include "config/files.h" #include "config/preferences.h" #include "event/client_events.h" #include "plugins/callbacks.h" #include "plugins/autocompleters.h" #include "plugins/api.h" #include "plugins/plugins.h" #include "plugins/themes.h" #include "plugins/settings.h" #include "plugins/disco.h" #include "ui/ui.h" #include "xmpp/xmpp.h" #ifdef HAVE_PYTHON #include "plugins/python_plugins.h" #include "plugins/python_api.h" #endif #ifdef HAVE_C #include "plugins/c_plugins.h" #include "plugins/c_api.h" #endif static GHashTable* plugins; static void _plugins_shutdown(void) { GList* values = g_hash_table_get_values(plugins); GList *curr = values, *next; while (curr) { next = g_list_next(curr); #ifdef HAVE_PYTHON if (curr && ((ProfPlugin*)curr->data)->lang == LANG_PYTHON) { python_plugin_destroy(curr->data); curr = NULL; } #endif #ifdef HAVE_C if (curr && ((ProfPlugin*)curr->data)->lang == LANG_C) { c_plugin_destroy(curr->data); curr = NULL; } #endif curr = next; } g_list_free(values); #ifdef HAVE_PYTHON python_shutdown(); #endif #ifdef HAVE_C c_shutdown(); #endif plugin_settings_close(); plugin_themes_close(); autocompleters_destroy(); callbacks_close(); disco_close(); g_hash_table_destroy(plugins); plugins = NULL; } void plugins_init(void) { prof_add_shutdown_routine(_plugins_shutdown); plugins = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, NULL); callbacks_init(); autocompleters_init(); plugin_themes_init(); plugin_settings_init(); #ifdef HAVE_PYTHON python_env_init(); #endif #ifdef HAVE_C c_env_init(); #endif // load plugins auto_gcharv gchar** plugins_pref = prefs_get_plugins(); if (!plugins_pref) { return; } for (guint i = 0; i < g_strv_length(plugins_pref); i++) { gboolean loaded = FALSE; gchar* filename = plugins_pref[i]; #ifdef HAVE_PYTHON if (g_str_has_suffix(filename, ".py")) { ProfPlugin* plugin = python_plugin_create(filename); if (plugin) { g_hash_table_insert(plugins, g_strdup(filename), plugin); loaded = TRUE; } } #endif #ifdef HAVE_C if (g_str_has_suffix(filename, ".so")) { ProfPlugin* plugin = c_plugin_create(filename); if (plugin) { g_hash_table_insert(plugins, g_strdup(filename), plugin); loaded = TRUE; } } #endif if (loaded) { log_info("Loaded plugin: %s", filename); } else { log_info("Failed to load plugin: %s", filename); } } // initialise plugins GList* values = g_hash_table_get_values(plugins); GList* curr = values; while (curr) { ProfPlugin* plugin = curr->data; plugin->init_func(plugin, PACKAGE_VERSION, PACKAGE_STATUS, NULL, NULL); curr = g_list_next(curr); } g_list_free(values); } void plugins_free_install_result(PluginsInstallResult* result) { if (!result) { return; } g_slist_free_full(result->installed, g_free); g_slist_free_full(result->failed, g_free); } PluginsInstallResult* plugins_install_all(const char* const path) { PluginsInstallResult* result = g_new0(PluginsInstallResult, 1); result->installed = NULL; result->failed = NULL; GSList* contents = NULL; get_file_paths_recursive(path, &contents); GSList* curr = contents; GString* error_message = NULL; while (curr) { error_message = g_string_new(NULL); if (g_str_has_suffix(curr->data, ".py") || g_str_has_suffix(curr->data, ".so")) { gchar* plugin_name = g_path_get_basename(curr->data); if (plugins_install(plugin_name, curr->data, error_message)) { result->installed = g_slist_append(result->installed, g_strdup(curr->data)); } else { result->failed = g_slist_append(result->failed, g_strdup(curr->data)); } } curr = g_slist_next(curr); g_string_free(error_message, TRUE); } g_slist_free_full(contents, g_free); return result; } gboolean plugins_uninstall(const char* const plugin_name) { plugins_unload(plugin_name); auto_gchar gchar* plugins_dir = files_get_data_path(DIR_PLUGINS); GString* target_path = g_string_new(plugins_dir); g_string_append(target_path, "/"); g_string_append(target_path, plugin_name); GFile* file = g_file_new_for_path(target_path->str); gboolean result = g_file_delete(file, NULL, NULL); g_object_unref(file); g_string_free(target_path, TRUE); return result; } gboolean plugins_install(const char* const plugin_name, const char* const filename, GString* error_message) { auto_gchar gchar* plugins_dir = files_get_data_path(DIR_PLUGINS); GString* target_path = g_string_new(plugins_dir); g_string_append(target_path, "/"); g_string_append(target_path, plugin_name); if (g_file_test(target_path->str, G_FILE_TEST_EXISTS)) { log_info("Failed to install plugin: %s, file exists", plugin_name); g_string_assign(error_message, "File exists"); return FALSE; } gboolean result = copy_file(filename, target_path->str, false); g_string_free(target_path, TRUE); if (result) { result = plugins_load(plugin_name, error_message); } return result; } GSList* plugins_load_all(void) { GSList* plugins = plugins_unloaded_list(); GSList* loaded = NULL; GSList* curr = plugins; GString* error_message = NULL; while (curr) { error_message = g_string_new(NULL); if (plugins_load(curr->data, error_message)) { loaded = g_slist_append(loaded, g_strdup(curr->data)); } curr = g_slist_next(curr); g_string_free(error_message, TRUE); } g_slist_free_full(plugins, g_free); return loaded; } gboolean plugins_load(const char* const name, GString* error_message) { ProfPlugin* plugin = g_hash_table_lookup(plugins, name); if (plugin) { log_info("Failed to load plugin: %s, plugin already loaded", name); return FALSE; } if (g_str_has_suffix(name, ".py")) { #ifdef HAVE_PYTHON plugin = python_plugin_create(name); #else g_string_assign(error_message, "Python plugins support is disabled."); #endif } if (g_str_has_suffix(name, ".so")) { #ifdef HAVE_C plugin = c_plugin_create(name); #else g_string_assign(error_message, "C plugins support is disabled."); #endif } if (plugin) { g_hash_table_insert(plugins, g_strdup(name), plugin); if (connection_get_status() == JABBER_CONNECTED) { plugin->init_func(plugin, PACKAGE_VERSION, PACKAGE_STATUS, session_get_account_name(), connection_get_fulljid()); } else { plugin->init_func(plugin, PACKAGE_VERSION, PACKAGE_STATUS, NULL, NULL); } log_info("Loaded plugin: %s", name); prefs_add_plugin(name); return TRUE; } else { log_info("Failed to load plugin: %s", name); return FALSE; } } gboolean plugins_unload_all(void) { gboolean result = TRUE; GList* plugin_names = g_hash_table_get_keys(plugins); GList* plugin_names_dup = NULL; GList* curr = plugin_names; while (curr) { plugin_names_dup = g_list_append(plugin_names_dup, g_strdup(curr->data)); curr = g_list_next(curr); } g_list_free(plugin_names); curr = plugin_names_dup; while (curr) { if (!plugins_unload(curr->data)) { result = FALSE; } curr = g_list_next(curr); } g_list_free_full(plugin_names_dup, g_free); return result; } gboolean plugins_unload(const char* const name) { ProfPlugin* plugin = g_hash_table_lookup(plugins, name); if (plugin) { plugin->on_unload_func(plugin); #ifdef HAVE_PYTHON if (plugin->lang == LANG_PYTHON) { python_plugin_destroy(plugin); } #endif #ifdef HAVE_C if (plugin->lang == LANG_C) { c_plugin_destroy(plugin); } #endif prefs_remove_plugin(name); g_hash_table_remove(plugins, name); caps_reset_ver(); // resend presence to update server's disco info data for this client if (connection_get_status() == JABBER_CONNECTED) { resource_presence_t last_presence = accounts_get_last_presence(session_get_account_name()); cl_ev_presence_send(last_presence, 0); } return TRUE; } return FALSE; } void plugins_reload_all(void) { GList* plugin_names = g_hash_table_get_keys(plugins); GList* plugin_names_dup = NULL; GList* curr = plugin_names; while (curr) { plugin_names_dup = g_list_append(plugin_names_dup, g_strdup(curr->data)); curr = g_list_next(curr); } g_list_free(plugin_names); GString* error_message = NULL; curr = plugin_names_dup; while (curr) { error_message = g_string_new(NULL); plugins_reload(curr->data, error_message); g_string_free(error_message, TRUE); curr = g_list_next(curr); } g_list_free_full(plugin_names_dup, g_free); } gboolean plugins_reload(const char* const name, GString* error_message) { gboolean res = plugins_unload(name); if (res) { res = plugins_load(name, error_message); } else { log_info("Failed to reload plugin: %s, not loaded", name); g_string_assign(error_message, "cannot unload"); } return res; } static void _plugins_unloaded_list_dir(const gchar* const dir, GSList** result) { GDir* plugins_dir = g_dir_open(dir, 0, NULL); if (plugins_dir == NULL) { return; } const gchar* plugin = g_dir_read_name(plugins_dir); while (plugin) { ProfPlugin* found = g_hash_table_lookup(plugins, plugin); if ((g_str_has_suffix(plugin, ".so") || g_str_has_suffix(plugin, ".py")) && !found) { *result = g_slist_append(*result, g_strdup(plugin)); } plugin = g_dir_read_name(plugins_dir); } g_dir_close(plugins_dir); } GSList* plugins_unloaded_list(void) { GSList* result = NULL; auto_gchar gchar* plugins_dir = files_get_data_path(DIR_PLUGINS); _plugins_unloaded_list_dir(plugins_dir, &result); return result; } GList* plugins_loaded_list(void) { return g_hash_table_get_keys(plugins); } char* plugins_autocomplete(const char* const input, gboolean previous) { return autocompleters_complete(input, previous); } void plugins_reset_autocomplete(void) { autocompleters_reset(); } void plugins_win_process_line(char* win, const char* const line) { PluginWindowCallback* window = callbacks_get_window_handler(win); if (window) { window->callback_exec(window, win, line); } } void plugins_close_win(const char* const plugin_name, const char* const tag) { callbacks_remove_win(plugin_name, tag); } static void _plugins_on_shutdown(void) { GList* values = g_hash_table_get_values(plugins); GList* curr = values; while (curr) { ProfPlugin* plugin = curr->data; plugin->on_shutdown_func(plugin); curr = g_list_next(curr); } g_list_free(values); } void plugins_on_start(void) { prof_add_shutdown_routine(_plugins_on_shutdown); GList* values = g_hash_table_get_values(plugins); GList* curr = values; while (curr) { ProfPlugin* plugin = curr->data; plugin->on_start_func(plugin); curr = g_list_next(curr); } g_list_free(values); } void plugins_on_connect(const char* const account_name, const char* const fulljid) { GList* values = g_hash_table_get_values(plugins); GList* curr = values; while (curr) { ProfPlugin* plugin = curr->data; plugin->on_connect_func(plugin, account_name, fulljid); curr = g_list_next(curr); } g_list_free(values); } void plugins_on_disconnect(const char* const account_name, const char* const fulljid) { GList* values = g_hash_table_get_values(plugins); GList* curr = values; while (curr) { ProfPlugin* plugin = curr->data; plugin->on_disconnect_func(plugin, account_name, fulljid); curr = g_list_next(curr); } g_list_free(values); } char* plugins_pre_chat_message_display(const char* const barejid, const char* const resource, const char* message) { GList* values = g_hash_table_get_values(plugins); if (!values) { return NULL; } gchar* new_message = NULL; gchar* curr_message = g_strdup(message); GList* curr = values; while (curr) { ProfPlugin* plugin = curr->data; new_message = plugin->pre_chat_message_display(plugin, barejid, resource, curr_message); if (new_message) { g_free(curr_message); curr_message = new_message; } curr = g_list_next(curr); } g_list_free(values); return curr_message; } void plugins_post_chat_message_display(const char* const barejid, const char* const resource, const char* message) { GList* values = g_hash_table_get_values(plugins); GList* curr = values; while (curr) { ProfPlugin* plugin = curr->data; plugin->post_chat_message_display(plugin, barejid, resource, message); curr = g_list_next(curr); } g_list_free(values); } char* plugins_pre_chat_message_send(const char* const barejid, const char* message) { GList* values = g_hash_table_get_values(plugins); if (!values) { return NULL; } gchar* new_message = NULL; gchar* curr_message = g_strdup(message); GList* curr = values; while (curr) { ProfPlugin* plugin = curr->data; if (plugin->contains_hook(plugin, "prof_pre_chat_message_send")) { new_message = plugin->pre_chat_message_send(plugin, barejid, curr_message); g_free(curr_message); if (new_message) { curr_message = new_message; } else { g_list_free(values); return NULL; } } curr = g_list_next(curr); } g_list_free(values); return curr_message; } void plugins_post_chat_message_send(const char* const barejid, const char* message) { GList* values = g_hash_table_get_values(plugins); GList* curr = values; while (curr) { ProfPlugin* plugin = curr->data; plugin->post_chat_message_send(plugin, barejid, message); curr = g_list_next(curr); } g_list_free(values); } char* plugins_pre_room_message_display(const char* const barejid, const char* const nick, const char* message) { GList* values = g_hash_table_get_values(plugins); if (!values) { return NULL; } gchar* new_message = NULL; gchar* curr_message = g_strdup(message); GList* curr = values; while (curr) { ProfPlugin* plugin = curr->data; new_message = plugin->pre_room_message_display(plugin, barejid, nick, curr_message); if (new_message) { g_free(curr_message); curr_message = new_message; } curr = g_list_next(curr); } g_list_free(values); return curr_message; } void plugins_post_room_message_display(const char* const barejid, const char* const nick, const char* message) { GList* values = g_hash_table_get_values(plugins); GList* curr = values; while (curr) { ProfPlugin* plugin = curr->data; plugin->post_room_message_display(plugin, barejid, nick, message); curr = g_list_next(curr); } g_list_free(values); } char* plugins_pre_room_message_send(const char* const barejid, const char* message) { GList* values = g_hash_table_get_values(plugins); if (!values) { return NULL; } gchar* new_message = NULL; gchar* curr_message = g_strdup(message); GList* curr = values; while (curr) { ProfPlugin* plugin = curr->data; if (plugin->contains_hook(plugin, "prof_pre_room_message_send")) { new_message = plugin->pre_room_message_send(plugin, barejid, curr_message); g_free(curr_message); if (new_message) { curr_message = new_message; } else { g_list_free(values); return NULL; } } curr = g_list_next(curr); } g_list_free(values); return curr_message; } void plugins_post_room_message_send(const char* const barejid, const char* message) { GList* values = g_hash_table_get_values(plugins); GList* curr = values; while (curr) { ProfPlugin* plugin = curr->data; plugin->post_room_message_send(plugin, barejid, message); curr = g_list_next(curr); } g_list_free(values); } void plugins_on_room_history_message(const char* const barejid, const char* const nick, const char* const message, GDateTime* timestamp) { char* timestamp_str = NULL; GTimeVal timestamp_tv; gboolean res = g_date_time_to_timeval(timestamp, ×tamp_tv); if (res) { timestamp_str = g_time_val_to_iso8601(×tamp_tv); } GList* values = g_hash_table_get_values(plugins); GList* curr = values; while (curr) { ProfPlugin* plugin = curr->data; plugin->on_room_history_message(plugin, barejid, nick, message, timestamp_str); curr = g_list_next(curr); } g_list_free(values); g_free(timestamp_str); } char* plugins_pre_priv_message_display(const char* const fulljid, const char* message) { GList* values = g_hash_table_get_values(plugins); if (!values) { return NULL; } auto_jid Jid* jidp = jid_create(fulljid); gchar* new_message = NULL; gchar* curr_message = g_strdup(message); GList* curr = values; while (curr) { ProfPlugin* plugin = curr->data; new_message = plugin->pre_priv_message_display(plugin, jidp->barejid, jidp->resourcepart, curr_message); if (new_message) { g_free(curr_message); curr_message = new_message; } curr = g_list_next(curr); } g_list_free(values); return curr_message; } void plugins_post_priv_message_display(const char* const fulljid, const char* message) { auto_jid Jid* jidp = jid_create(fulljid); GList* values = g_hash_table_get_values(plugins); GList* curr = values; while (curr) { ProfPlugin* plugin = curr->data; plugin->post_priv_message_display(plugin, jidp->barejid, jidp->resourcepart, message); curr = g_list_next(curr); } g_list_free(values); } char* plugins_pre_priv_message_send(const char* const fulljid, const char* const message) { GList* values = g_hash_table_get_values(plugins); if (!values) { return NULL; } auto_jid Jid* jidp = jid_create(fulljid); gchar* new_message = NULL; gchar* curr_message = g_strdup(message); GList* curr = values; while (curr) { ProfPlugin* plugin = curr->data; if (plugin->contains_hook(plugin, "prof_pre_priv_message_send")) { new_message = plugin->pre_priv_message_send(plugin, jidp->barejid, jidp->resourcepart, curr_message); g_free(curr_message); if (new_message) { curr_message = new_message; } else { g_list_free(values); return NULL; } } curr = g_list_next(curr); } g_list_free(values); return curr_message; } void plugins_post_priv_message_send(const char* const fulljid, const char* const message) { auto_jid Jid* jidp = jid_create(fulljid); GList* values = g_hash_table_get_values(plugins); GList* curr = values; while (curr) { ProfPlugin* plugin = curr->data; plugin->post_priv_message_send(plugin, jidp->barejid, jidp->resourcepart, message); curr = g_list_next(curr); } g_list_free(values); } char* plugins_on_message_stanza_send(const char* const text) { GList* values = g_hash_table_get_values(plugins); if (!values) { return NULL; } gchar* new_stanza = NULL; gchar* curr_stanza = g_strdup(text); GList* curr = values; while (curr) { ProfPlugin* plugin = curr->data; new_stanza = plugin->on_message_stanza_send(plugin, curr_stanza); if (new_stanza) { g_free(curr_stanza); curr_stanza = new_stanza; } curr = g_list_next(curr); } g_list_free(values); return curr_stanza; } gboolean plugins_on_message_stanza_receive(const char* const text) { gboolean cont = TRUE; GList* values = g_hash_table_get_values(plugins); GList* curr = values; while (curr) { ProfPlugin* plugin = curr->data; gboolean res = plugin->on_message_stanza_receive(plugin, text); if (res == FALSE) { cont = FALSE; } curr = g_list_next(curr); } g_list_free(values); return cont; } char* plugins_on_presence_stanza_send(const char* const text) { GList* values = g_hash_table_get_values(plugins); if (!values) { return NULL; } gchar* new_stanza = NULL; gchar* curr_stanza = g_strdup(text); GList* curr = values; while (curr) { ProfPlugin* plugin = curr->data; new_stanza = plugin->on_presence_stanza_send(plugin, curr_stanza); if (new_stanza) { g_free(curr_stanza); curr_stanza = new_stanza; } curr = g_list_next(curr); } g_list_free(values); return curr_stanza; } gboolean plugins_on_presence_stanza_receive(const char* const text) { gboolean cont = TRUE; GList* values = g_hash_table_get_values(plugins); GList* curr = values; while (curr) { ProfPlugin* plugin = curr->data; gboolean res = plugin->on_presence_stanza_receive(plugin, text); if (res == FALSE) { cont = FALSE; } curr = g_list_next(curr); } g_list_free(values); return cont; } char* plugins_on_iq_stanza_send(const char* const text) { GList* values = g_hash_table_get_values(plugins); if (!values) { return NULL; } char* new_stanza = NULL; char* curr_stanza = g_strdup(text); GList* curr = values; while (curr) { ProfPlugin* plugin = curr->data; new_stanza = plugin->on_iq_stanza_send(plugin, curr_stanza); if (new_stanza) { g_free(curr_stanza); curr_stanza = new_stanza; } curr = g_list_next(curr); } g_list_free(values); return curr_stanza; } gboolean plugins_on_iq_stanza_receive(const char* const text) { gboolean cont = TRUE; GList* values = g_hash_table_get_values(plugins); GList* curr = values; while (curr) { ProfPlugin* plugin = curr->data; gboolean res = plugin->on_iq_stanza_receive(plugin, text); if (res == FALSE) { cont = FALSE; } curr = g_list_next(curr); } g_list_free(values); return cont; } void plugins_on_contact_offline(const char* const barejid, const char* const resource, const char* const status) { GList* values = g_hash_table_get_values(plugins); GList* curr = values; while (curr) { ProfPlugin* plugin = curr->data; plugin->on_contact_offline(plugin, barejid, resource, status); curr = g_list_next(curr); } g_list_free(values); } void plugins_on_contact_presence(const char* const barejid, const char* const resource, const char* const presence, const char* const status, const int priority) { GList* values = g_hash_table_get_values(plugins); GList* curr = values; while (curr) { ProfPlugin* plugin = curr->data; plugin->on_contact_presence(plugin, barejid, resource, presence, status, priority); curr = g_list_next(curr); } g_list_free(values); } void plugins_on_chat_win_focus(const char* const barejid) { GList* values = g_hash_table_get_values(plugins); GList* curr = values; while (curr) { ProfPlugin* plugin = curr->data; plugin->on_chat_win_focus(plugin, barejid); curr = g_list_next(curr); } g_list_free(values); } void plugins_on_room_win_focus(const char* const barejid) { GList* values = g_hash_table_get_values(plugins); GList* curr = values; while (curr) { ProfPlugin* plugin = curr->data; plugin->on_room_win_focus(plugin, barejid); curr = g_list_next(curr); } g_list_free(values); } GList* plugins_get_disco_features(void) { return disco_get_features(); }