<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module ranger.gui.widgets.pager</title>
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="ranger.html"><font color="#ffffff">ranger</font></a>.<a href="ranger.gui.html"><font color="#ffffff">gui</font></a>.<a href="ranger.gui.widgets.html"><font color="#ffffff">widgets</font></a>.pager</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=&q/*
* plugins.c
* vim: expandtab:ts=4:sts=4:sw=4
*
* Copyright (C) 2012 - 2019 James Booth <boothj5@gmail.com>
*
* This file is part of Profanity.
*
* Profanity is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Profanity is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Profanity. If not, see <https://www.gnu.org/licenses/>.
*
* In addition, as a special exception, the copyright holders give permission to
* link the code of portions of this program with the OpenSSL library under
* certain conditions as described in each individual source file, and
* distribute linked combinations including the two.
*
* You must obey the GNU General Public License in all respects for all of the
* code used other than OpenSSL. If you modify file(s) with this exception, you
* may extend this exception to your version of the file(s), but you are not
* obligated to do so. If you do not wish to do so, delete this exception
* statement from your version. If you delete this exception statement from all
* source files in the program, then also delete it here.
*
*/
#include <string.h>
#include <stdlib.h>
#include <gio/gio.h>
#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;
void
plugins_init(void)
{
plugins = g_hash_table_new_full(g_str_hash, g_str_equal, 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
gchar **plugins_pref = prefs_get_plugins();
if (plugins_pref) {
int i;
for (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, 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, 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);
}
prefs_free_plugins(plugins_pref);
return;
}
void
plugins_free_install_result(PluginsInstallResult *result)
{
if (!result) {
return;
}
g_slist_free_full(result->installed, free);
g_slist_free_full(result->failed, free);
}
PluginsInstallResult*
plugins_install_all(const char *const path)
{
PluginsInstallResult *result = malloc(sizeof(PluginsInstallResult));
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, strdup(curr->data));
} else {
result->failed = g_slist_append(result->failed, 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);
char *plugins_dir = files_get_data_path(DIR_PLUGINS);
GString *target_path = g_string_new(plugins_dir);
free(plugins_dir);
g_string_append(target_path, "/");
g_string_append(target_path, plugin_name);
GFile *file = g_file_new_for_path(target_path->str);
GError *error = NULL;
gboolean result = g_file_delete(file, NULL, &error);
g_object_unref(file);
g_error_free(error);
g_string_free(target_path, TRUE);
return result;
}
gboolean
plugins_install(const char *const plugin_name, const char *const filename, GString *error_message)
{
char *plugins_dir = files_get_data_path(DIR_PLUGINS);
GString *target_path = g_string_new(plugins_dir);
free(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, 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, strdup(name), plugin);
if (connection_get_status() == JABBER_CONNECTED) {
const char *account_name = session_get_account_name();
const char *fulljid = connection_get_fulljid();
plugin->init_func(plugin, PACKAGE_VERSION, PACKAGE_STATUS, account_name, 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, 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, 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