diff options
| -rw-r--r-- | Makefile.am | 3 | ||||
| -rw-r--r-- | src/command/cmd_defs.c | 11 | ||||
| -rw-r--r-- | src/command/cmd_funcs.c | 93 | ||||
| -rw-r--r-- | src/common.c | 4 | ||||
| -rw-r--r-- | src/common.h | 1 | ||||
| -rw-r--r-- | src/tools/http_common.c | 6 | ||||
| -rw-r--r-- | src/tools/http_download.c | 16 | ||||
| -rw-r--r-- | src/tools/http_download.h | 1 | ||||
| -rw-r--r-- | src/tools/plugin_download.c | 96 | ||||
| -rw-r--r-- | src/tools/plugin_download.h | 55 | ||||
| -rw-r--r-- | src/ui/window.c | 7 | ||||
| -rw-r--r-- | tests/unittests/tools/stub_http_download.c | 2 | ||||
| -rw-r--r-- | tests/unittests/tools/stub_plugin_download.c | 19 |
13 files changed, 279 insertions, 35 deletions
diff --git a/Makefile.am b/Makefile.am index 76b16d57..f9c89d64 100644 --- a/Makefile.am +++ b/Makefile.am @@ -50,6 +50,8 @@ core_sources = \ src/tools/http_upload.h \ src/tools/http_download.c \ src/tools/http_download.h \ + src/tools/plugin_download.c \ + src/tools/plugin_download.h \ src/tools/bookmark_ignore.c \ src/tools/bookmark_ignore.h \ src/tools/autocomplete.c src/tools/autocomplete.h \ @@ -137,6 +139,7 @@ unittest_sources = \ tests/unittests/tools/stub_http_upload.c \ tests/unittests/tools/stub_http_download.c \ tests/unittests/tools/stub_aesgcm_download.c \ + tests/unittests/tools/stub_plugin_download.c \ tests/unittests/helpers.c tests/unittests/helpers.h \ tests/unittests/test_form.c tests/unittests/test_form.h \ tests/unittests/test_common.c tests/unittests/test_common.h \ diff --git a/src/command/cmd_defs.c b/src/command/cmd_defs.c index c6e886a5..3b9fccfd 100644 --- a/src/command/cmd_defs.c +++ b/src/command/cmd_defs.c @@ -2158,9 +2158,9 @@ static const struct cmd_t command_defs[] = { CMD_MAINFUNC(cmd_plugins) CMD_SYN( "/plugins", - "/plugins install [<path>]", + "/plugins install [<path or URL>]", + "/plugins update [<path or URL>]", "/plugins uninstall [<plugin>]", - "/plugins update [<path>]", "/plugins unload [<plugin>]", "/plugins load [<plugin>]", "/plugins reload [<plugin>]", @@ -2168,17 +2168,18 @@ static const struct cmd_t command_defs[] = { CMD_DESC( "Manage plugins. Passing no arguments lists installed plugins and global plugins which are available for local installation. Global directory for Python plugins is " GLOBAL_PYTHON_PLUGINS_PATH " and for C Plugins is " GLOBAL_C_PLUGINS_PATH ".") CMD_ARGS( - { "install [<path>]", "Install a plugin, or all plugins found in a directory (recursive). And loads it/them." }, + { "install [<path or URL>]", "Install a plugin, or all plugins found in a directory (recursive), or download and install plugin (plugin name is based on basename). And loads it/them." }, + { "update [<path or URL>]", "Uninstall and then install the plugin. Plugin name to update is basename." }, { "uninstall [<plugin>]", "Uninstall a plugin." }, - { "update [<path>]", "Updates an installed plugin" }, { "load [<plugin>]", "Load a plugin that already exists in the plugin directory, passing no argument loads all found plugins. It will be loaded upon next start too unless unloaded." }, { "unload [<plugin>]", "Unload a loaded plugin, passing no argument will unload all plugins." }, { "reload [<plugin>]", "Reload a plugin, passing no argument will reload all plugins." }, { "python_version", "Show the Python interpreter version." }) CMD_EXAMPLES( - "/plugins install", "/plugins install /home/steveharris/Downloads/metal.py", + "/plugins install https://raw.githubusercontent.com/profanity-im/profanity-plugins/master/stable/sounds.py", "/plugins update /home/steveharris/Downloads/metal.py", + "/plugins update https://raw.githubusercontent.com/profanity-im/profanity-plugins/master/stable/sounds.py", "/plugins uninstall browser.py", "/plugins load browser.py", "/plugins unload say.py", diff --git a/src/command/cmd_funcs.c b/src/command/cmd_funcs.c index 9ba75498..70546a0b 100644 --- a/src/command/cmd_funcs.c +++ b/src/command/cmd_funcs.c @@ -77,6 +77,7 @@ #include "tools/http_download.h" #include "tools/autocomplete.h" #include "tools/parser.h" +#include "tools/plugin_download.h" #include "tools/bookmark_ignore.h" #include "tools/editor.h" #include "plugins/plugins.h" @@ -130,6 +131,8 @@ static gboolean _cmd_execute_default(ProfWin* window, const char* inp); static gboolean _cmd_execute_alias(ProfWin* window, const char* const inp, gboolean* ran); static gboolean _string_matches_one_of(const char* what, const char* is, bool is_can_be_null, const char* first, ...) __attribute__((sentinel)); +static gboolean +_download_install_plugin(ProfWin* window, gchar* url, gchar* path); static gboolean _string_matches_one_of(const char* what, const char* is, bool is_can_be_null, const char* first, ...) @@ -7033,17 +7036,38 @@ cmd_receipts(ProfWin* window, const char* const command, gchar** args) return TRUE; } +static gboolean +_is_correct_plugin_extension(gchar* plugin) +{ + return g_str_has_suffix(plugin, ".py") || g_str_has_suffix(plugin, ".so"); +} + +static gboolean +_http_based_uri_scheme(const char* scheme) +{ + return scheme != NULL && (g_strcmp0(scheme, "http") == 0 || g_strcmp0(scheme, "https") == 0); +} + gboolean cmd_plugins_install(ProfWin* window, const char* const command, gchar** args) { - char* path = NULL; + auto_gchar gchar* path = NULL; if (args[1] == NULL) { cons_bad_cmd_usage(command); return TRUE; } - // take whole path or build it in case it's just the plugin name + auto_gchar gchar* scheme = g_uri_parse_scheme(args[1]); + if (_http_based_uri_scheme(scheme)) { + if (!_is_correct_plugin_extension(args[1])) { + cons_show("Please, use url ending with correct file name. Plugins must have one of the following extensions: \".py\" or \".so\"."); + return TRUE; + } + _download_install_plugin(window, args[1], NULL); + return TRUE; + } + if (strchr(args[1], '/')) { path = get_expanded_path(args[1]); } else { @@ -7052,52 +7076,47 @@ cmd_plugins_install(ProfWin* window, const char* const command, gchar** args) } else if (g_str_has_suffix(args[1], ".so")) { path = g_strdup_printf("%s/%s", GLOBAL_C_PLUGINS_PATH, args[1]); } else { - cons_show("Plugins must have one of the following extensions: '.py' '.so'"); + cons_show("Plugins must have one of the following extensions: \".py\" or \".so\"."); return TRUE; } } if (access(path, R_OK) != 0) { cons_show("Cannot access: %s", path); - free(path); return TRUE; } if (is_regular_file(path)) { - if (!g_str_has_suffix(path, ".py") && !g_str_has_suffix(path, ".so")) { - cons_show("Plugins must have one of the following extensions: '.py' '.so'"); - free(path); + if (!_is_correct_plugin_extension(args[1])) { + cons_show("Plugins must have one of the following extensions: \".py\" or \".so\"."); return TRUE; } - GString* error_message = g_string_new(NULL); - gchar* plugin_name = g_path_get_basename(path); + auto_gchar gchar* plugin_name = g_path_get_basename(path); gboolean result = plugins_install(plugin_name, path, error_message); if (result) { cons_show("Plugin installed and loaded: %s", plugin_name); } else { cons_show("Failed to install plugin: %s. %s", plugin_name, error_message->str); } - g_free(plugin_name); g_string_free(error_message, TRUE); - free(path); return TRUE; } else if (is_dir(path)) { PluginsInstallResult* result = plugins_install_all(path); if (result->installed || result->failed) { if (result->installed) { - cons_show(""); - cons_show("Installed and loaded plugins:"); GSList* curr = result->installed; + cons_show(""); + cons_show("Installed and loaded plugins (%u):", g_slist_length(curr)); while (curr) { cons_show(" %s", curr->data); curr = g_slist_next(curr); } } if (result->failed) { - cons_show(""); - cons_show("Failed installs:"); GSList* curr = result->failed; + cons_show(""); + cons_show("Failed installs (%u):", g_slist_length(curr)); while (curr) { cons_show(" %s", curr->data); curr = g_slist_next(curr); @@ -7106,14 +7125,12 @@ cmd_plugins_install(ProfWin* window, const char* const command, gchar** args) } else { cons_show("No plugins found in: %s", path); } - free(path); plugins_free_install_result(result); return TRUE; } else { cons_show("Argument must be a file or directory."); } - free(path); return TRUE; } @@ -7125,6 +7142,23 @@ cmd_plugins_update(ProfWin* window, const char* const command, gchar** args) return TRUE; } + auto_gchar gchar* scheme = g_uri_parse_scheme(args[1]); + if (_http_based_uri_scheme(scheme)) { + auto_char char* plugin_name = basename_from_url(args[1]); + if (!_is_correct_plugin_extension(plugin_name)) { + cons_show("Please, use url ending with correct file name. Plugins must have one of the following extensions: \".py\" or \".so\"."); + return TRUE; + } + + if (!plugins_uninstall(plugin_name)) { + cons_show("Failed to uninstall plugin: %s.", plugin_name); + return TRUE; + } + + _download_install_plugin(window, args[1], NULL); + return TRUE; + } + auto_gchar gchar* path = get_expanded_path(args[1]); if (access(path, R_OK) != 0) { @@ -9472,12 +9506,30 @@ _url_aesgcm_method(ProfWin* window, const char* cmd_template, gchar* url, gchar* } #endif -void +static gboolean +_download_install_plugin(ProfWin* window, gchar* url, gchar* path) +{ + auto_gchar gchar* filename = _prepare_filename(url, path); + if (!filename) + return FALSE; + HTTPDownload* download = malloc(sizeof(HTTPDownload)); + download->window = window; + download->url = strdup(url); + download->filename = strdup(filename); + download->id = get_random_string(4); + download->cmd_template = NULL; + + pthread_create(&(download->worker), NULL, &plugin_download_install, download); + plugin_download_add_download(download); + return TRUE; +} + +static gchar* _url_http_method(ProfWin* window, const char* cmd_template, gchar* url, gchar* path) { auto_gchar gchar* filename = _prepare_filename(url, path); if (!filename) - return; + return NULL; auto_char char* id = get_random_string(4); HTTPDownload* download = malloc(sizeof(HTTPDownload)); download->window = window; @@ -9488,6 +9540,7 @@ _url_http_method(ProfWin* window, const char* cmd_template, gchar* url, gchar* p pthread_create(&(download->worker), NULL, &http_file_get, download); http_download_add_download(download); + return g_strdup(filename); } void @@ -9574,7 +9627,7 @@ cmd_url_save(ProfWin* window, const char* const command, gchar** args) auto_gchar gchar* cmd_template = prefs_get_string(PREF_URL_SAVE_CMD); if (cmd_template == NULL && (g_strcmp0(scheme, "http") == 0 || g_strcmp0(scheme, "https") == 0)) { - _url_http_method(window, cmd_template, url, path); + g_free(_url_http_method(window, cmd_template, url, path)); #ifdef HAVE_OMEMO } else if (g_strcmp0(scheme, "aesgcm") == 0) { _url_aesgcm_method(window, cmd_template, url, path); diff --git a/src/common.c b/src/common.c index 29fd62cb..1ba27a63 100644 --- a/src/common.c +++ b/src/common.c @@ -546,7 +546,7 @@ _has_directory_suffix(const char* path) } char* -_basename_from_url(const char* url) +basename_from_url(const char* url) { const char* default_name = "index"; @@ -595,7 +595,7 @@ unique_filename_from_url(const char* url, const char* path) if (_has_directory_suffix(realpath) || g_file_test(realpath, G_FILE_TEST_IS_DIR)) { // The target should be used as a directory. Assume that the basename // should be derived from the URL. - char* basename = _basename_from_url(url); + char* basename = basename_from_url(url); filename = g_build_filename(g_file_peek_path(target), basename, NULL); g_free(basename); } else { diff --git a/src/common.h b/src/common.h index dee4a092..e9a3d0cd 100644 --- a/src/common.h +++ b/src/common.h @@ -125,5 +125,6 @@ gchar* unique_filename_from_url(const char* url, const char* path); gchar* get_expanded_path(const char* path); void glib_hash_table_free(GHashTable* hash_table); +char* basename_from_url(const char* url); #endif diff --git a/src/tools/http_common.c b/src/tools/http_common.c index 4192a6ca..02391e63 100644 --- a/src/tools/http_common.c +++ b/src/tools/http_common.c @@ -54,7 +54,11 @@ http_print_transfer_update(ProfWin* window, char* id, const char* fmt, ...) g_string_vprintf(msg, fmt, args); va_end(args); - win_update_entry_message(window, id, msg->str); + if (window->type != WIN_CONSOLE) { + win_update_entry_message(window, id, msg->str); + } else { + cons_show("%s", msg->str); + } g_string_free(msg, TRUE); } diff --git a/src/tools/http_download.c b/src/tools/http_download.c index 71c9a1e1..bd34a4ed 100644 --- a/src/tools/http_download.c +++ b/src/tools/http_download.c @@ -4,6 +4,7 @@ * * Copyright (C) 2012 - 2019 James Booth <boothj5@gmail.com> * Copyright (C) 2020 William Wennerström <william@wstrm.dev> + * Copyright (C) 2019 - 2023 Michael Vetter <jubalh@iodoru.org> * * This file is part of Profanity. * @@ -57,6 +58,7 @@ #include "common.h" GSList* download_processes = NULL; +gboolean silent = FALSE; static int _xferinfo(void* userdata, curl_off_t dltotal, curl_off_t dlnow, curl_off_t ultotal, curl_off_t ulnow) @@ -82,8 +84,9 @@ _xferinfo(void* userdata, curl_off_t dltotal, curl_off_t dlnow, curl_off_t ultot dlperc = (100 * dlnow) / dltotal; } - http_print_transfer_update(download->window, download->url, - "Downloading '%s': %d%%", download->url, dlperc); + if (!silent) + http_print_transfer_update(download->window, download->url, + "Downloading '%s': %d%%", download->url, dlperc); pthread_mutex_unlock(&lock); @@ -107,13 +110,16 @@ http_file_get(void* userdata) CURL* curl; CURLcode res; + silent = download->silent; download->cancel = 0; download->bytes_received = 0; pthread_mutex_lock(&lock); - http_print_transfer(download->window, download->id, - "Downloading '%s': 0%%", download->url); + if (!silent) { + http_print_transfer(download->window, download->id, + "Downloading '%s': 0%%", download->url); + } FILE* outfh = fopen(download->filename, "wb"); if (outfh == NULL) { @@ -188,7 +194,7 @@ http_file_get(void* userdata) } free(err); } else { - if (!download->cancel) { + if (!download->cancel && !silent) { http_print_transfer_update(download->window, download->id, "Downloading '%s': done\nSaved to '%s'", download->url, download->filename); diff --git a/src/tools/http_download.h b/src/tools/http_download.h index 2c8d8a3d..f75ba4d7 100644 --- a/src/tools/http_download.h +++ b/src/tools/http_download.h @@ -57,6 +57,7 @@ typedef struct http_download_t ProfWin* window; pthread_t worker; int cancel; + gboolean silent; } HTTPDownload; void* http_file_get(void* userdata); diff --git a/src/tools/plugin_download.c b/src/tools/plugin_download.c new file mode 100644 index 00000000..60fa5806 --- /dev/null +++ b/src/tools/plugin_download.c @@ -0,0 +1,96 @@ +/* + * plugin_download.c + * vim: expandtab:ts=4:sts=4:sw=4 + * + * Copyright (C) 2012 - 2019 James Booth <boothj5@gmail.com> + * Copyright (C) 2019 - 2023 Michael Vetter <jubalh@iodoru.org> + * + * 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 "config.h" + +#include <stdlib.h> +#include <stdio.h> +#include <string.h> +#include <sys/stat.h> +#include <sys/types.h> +#include <curl/curl.h> +#include <gio/gio.h> +#include <pthread.h> +#include <assert.h> +#include <errno.h> + +#include "profanity.h" +#include "event/client_events.h" +#include "tools/http_common.h" +#include "tools/plugin_download.h" +#include "config/preferences.h" +#include "plugins/plugins.h" +#include "ui/ui.h" +#include "ui/window.h" +#include "common.h" + +#define FALLBACK_MSG "" + +void* +plugin_download_install(void* userdata) +{ + HTTPDownload* plugin_dl = (HTTPDownload*)userdata; + + auto_char char* path = strdup(plugin_dl->filename); + auto_char char* https_url = strdup(plugin_dl->url); + plugin_dl->silent = TRUE; + + http_file_get(plugin_dl); + + if (is_regular_file(path)) { + GString* error_message = g_string_new(NULL); + auto_char char* plugin_name = basename_from_url(https_url); + gboolean result = plugins_install(plugin_name, path, error_message); + if (result) { + cons_show("Plugin installed and loaded: %s", plugin_name); + } else { + cons_show("Failed to install plugin: %s. %s", plugin_name, error_message->str); + } + g_string_free(error_message, TRUE); + } else { + cons_show_error("Downloaded file is not a file (?)"); + } + + remove(path); + + return NULL; +} + +void +plugin_download_add_download(HTTPDownload* plugin_dl) +{ + http_download_add_download(plugin_dl); +} diff --git a/src/tools/plugin_download.h b/src/tools/plugin_download.h new file mode 100644 index 00000000..70150e37 --- /dev/null +++ b/src/tools/plugin_download.h @@ -0,0 +1,55 @@ +/* + * plugin_download.h + * vim: expandtab:ts=4:sts=4:sw=4 + * + * Copyright (C) 2012 - 2019 James Booth <boothj5@gmail.com> + * Copyright (C) 2019 - 2023 Michael Vetter <jubalh@iodoru.org> + * + * 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. + * + */ + +#ifndef TOOLS_PLUGIN_DOWNLOAD_H +#define TOOLS_PLUGIN_DOWNLOAD_H + +#ifdef PLATFORM_CYGWIN +#define SOCKET int +#endif + +#include <sys/select.h> +#include <curl/curl.h> +#include "tools/http_common.h" +#include "tools/http_download.h" + +#include "ui/win_types.h" + +void* plugin_download_install(void* userdata); + +void plugin_download_add_download(HTTPDownload* download); + +#endif diff --git a/src/ui/window.c b/src/ui/window.c index e5b90f7b..49f22ca7 100644 --- a/src/ui/window.c +++ b/src/ui/window.c @@ -1727,6 +1727,8 @@ win_print_outgoing_with_receipt(ProfWin* window, const char* show_char, const ch void win_mark_received(ProfWin* window, const char* const id) { + if (window->type == WIN_CONSOLE) + return; gboolean received = buffer_mark_received(window->layout->buffer, id); if (received) { win_redraw(window); @@ -1736,6 +1738,8 @@ win_mark_received(ProfWin* window, const char* const id) void win_update_entry_message(ProfWin* window, const char* const id, const char* const message) { + if (window->type == WIN_CONSOLE) + return; ProfBuffEntry* entry = buffer_get_entry_by_id(window->layout->buffer, id); if (entry) { free(entry->message); @@ -2289,8 +2293,7 @@ win_handle_command_exec_result_note(ProfWin* window, const char* const type, con void win_insert_last_read_position_marker(ProfWin* window, char* id) { - int size; - size = buffer_size(window->layout->buffer); + int size = buffer_size(window->layout->buffer); // TODO: this is somewhat costly. We should improve this later. // check if we already have a separator present diff --git a/tests/unittests/tools/stub_http_download.c b/tests/unittests/tools/stub_http_download.c index f530b384..aff47200 100644 --- a/tests/unittests/tools/stub_http_download.c +++ b/tests/unittests/tools/stub_http_download.c @@ -3,6 +3,7 @@ #include <curl/curl.h> #include <pthread.h> +#include "common.h" typedef struct prof_win_t ProfWin; @@ -17,6 +18,7 @@ typedef struct http_download_t ProfWin* window; pthread_t worker; int cancel; + gboolean silent; } HTTPDownload; void* diff --git a/tests/unittests/tools/stub_plugin_download.c b/tests/unittests/tools/stub_plugin_download.c new file mode 100644 index 00000000..c54f60d2 --- /dev/null +++ b/tests/unittests/tools/stub_plugin_download.c @@ -0,0 +1,19 @@ +#ifndef TOOLS_PLUGIN_DOWNLOAD_H +#define TOOLS_PLUGIN_DOWNLOAD_H + +#include <stdlib.h> +typedef struct prof_win_t ProfWin; +typedef struct http_download_t HTTPDownload; + +void* +plugin_download_install(void* userdata) +{ + return NULL; +} + +void +plugin_download_add_download(HTTPDownload* download) +{ +} + +#endif |