devs/cproof
1
2
Fork 1
Code Issues 43 Pull Requests 6 Actions Packages Projects 1 Releases Wiki Activity

Add url support (downloading) to /plugins install

Browse Source 
Additional changes include code refactoring.
This commit is contained in:
John Hernandez
2023-04-19 14:19:47 +02:00
parent 9a68aab011
commit 95e06ad169
13 changed files with 279 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
src/command/cmd_defs.c
View File

@@ -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",

93
src/command/cmd_funcs.c
View File

@@ -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);