/* * python_api.c * * Copyright (C) 2012 - 2016 James Booth * * 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 . * * 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 #include #include #include "plugins/api.h" #include "plugins/python_api.h" #include "plugins/python_plugins.h" #include "plugins/callbacks.h" #include "plugins/autocompleters.h" #include "log.h" static char* _python_plugin_name(void); static PyObject* python_api_cons_alert(PyObject *self, PyObject *args) { allow_python_threads(); api_cons_alert(); disable_python_threads(); return Py_BuildValue(""); } static PyObject* python_api_cons_show(PyObject *self, PyObject *args) { const char *message = NULL; if (!PyArg_ParseTuple(args, "s", &message)) { return Py_BuildValue(""); } allow_python_threads(); api_cons_show(message); disable_python_threads(); return Py_BuildValue(""); } static PyObject* python_api_cons_show_themed(PyObject *self, PyObject *args) { const char *group = NULL; const char *key = NULL; const char *def = NULL; const char *message = NULL; if (!PyArg_ParseTuple(args, "zzzs", &group, &key, &def, &message)) { return Py_BuildValue(""); } allow_python_threads(); api_cons_show_themed(group, key, def, message); disable_python_threads(); return Py_BuildValue(""); } static PyObject* python_api_cons_bad_cmd_usage(PyObject *self, PyObject *args) { const char *cmd = NULL; if (!PyArg_ParseTuple(args, "s", &cmd)) { return Py_BuildValue(""); } allow_python_threads(); api_cons_bad_cmd_usage(cmd); disable_python_threads(); return Py_BuildValue(""); } static PyObject* python_api_register_command(PyObject *self, PyObject *args) { const char *command_name = NULL; int min_args = 0; int max_args = 0; PyObject *synopsis = NULL; const char *description = NULL; PyObject *arguments = NULL; PyObject *examples = NULL; PyObject *p_callback = NULL; if (!PyArg_ParseTuple(args, "siiOsOOO", &command_name, &min_args, &max_args, &synopsis, &description, &arguments, &examples, &p_callback)) { return Py_BuildValue(""); } char *plugin_name = _python_plugin_name(); log_debug("Register command %s for %s", command_name, plugin_name); if (p_callback && PyCallable_Check(p_callback)) { Py_ssize_t len = PyList_Size(synopsis); const char *c_synopsis[len == 0 ? 0 : len+1]; Py_ssize_t i = 0; for (i = 0; i < len; i++) { PyObject *item = PyList_GetItem(synopsis, i); char *c_item = PyString_AsString(item); c_synopsis[i] = c_item; } c_synopsis[len] = NULL; Py_ssize_t args_len = PyList_Size(arguments); const char *c_arguments[args_len == 0 ? 0 : args_len+1][2]; i = 0; for (i = 0; i < args_len; i++) { PyObject *item = PyList_GetItem(arguments, i); Py_ssize_t len2 = PyList_Size(item); if (len2 != 2) { return Py_BuildValue(""); } PyObject *arg = PyList_GetItem(item, 0); char *c_arg = PyString_AsString(arg); PyObject *desc = PyList_GetItem(item, 1); char *c_desc = PyString_AsString(desc); c_arguments[i][0] = c_arg; c_arguments[i][1] = c_desc; } c_arguments[args_len][0] = NULL; c_arguments[args_len][1] = NULL; len = PyList_Size(examples); const char *c_examples[len == 0 ? 0 : len+1]; i = 0; for (i = 0; i < len; i++) { PyObject *item = PyList_GetItem(examples, i); char *c_item = PyString_AsString(item); c_examples[i] = c_item; } c_examples[len] = NULL; allow_python_threads(); api_register_command(command_name, min_args, max_args, c_synopsis, description, c_arguments, c_examples, p_callback, python_command_callback); disable_python_threads(); } return Py_BuildValue(""); } static PyObject * python_api_register_timed(PyObject *self, PyObject *args) { char *plugin_name = _python_plugin_name(); log_debug("Register timed for %s", plugin_name); PyObject *p_callback = NULL; int interval_seconds = 0; if (!PyArg_ParseTuple(args, "Oi", &p_callback, &interval_seconds)) { return Py_BuildValue(""); } if (p_callback && PyCallable_Check(p_callback)) { allow_python_threads(); api_register_timed(p_callback, interval_seconds, python_timed_callback); disable_python_threads(); } return Py_BuildValue(""); } static PyObject * python_api_completer_add(PyObject *self, PyObject *args) { const char *key = NULL; PyObject *items = NULL; if (!PyArg_ParseTuple(args, "sO", &key, &items)) { return Py_BuildValue(""); } Py_ssize_t len = PyList_Size(items); char *c_items[len]; Py_ssize_t i = 0; for (i = 0; i < len; i++) { PyObject *item = PyList_GetItem(items, i); char *c_item = PyString_AsString(item); c_items[i] = c_item; } c_items[len] = NULL; allow_python_threads(); autocompleters_add(key, c_items); disable_python_threads(); return Py_BuildValue(""); } static PyObject * python_api_completer_remove(PyObject *self, PyObject *args) { const char *key = NULL; PyObject *items = NULL; if (!PyArg_ParseTuple(args, "sO", &key, &items)) { return Py_BuildValue(""); } Py_ssize_t len = PyList_Size(items); char *c_items[len]; Py_ssize_t i = 0; for (i = 0; i < len; i++) { PyObject *item = PyList_GetItem(items, i); char *c_item = PyString_AsString(item); c_items[i] = c_item; } c_items[len] = NULL; allow_python_threads(); autocompleters_remove(key, c_items); disable_python_threads(); return Py_BuildValue(""); } static PyObject * python_api_completer_clear(PyObject *self, PyObject *args) { const char *key = NULL; if (!PyArg_ParseTuple(args, "s", &key)) { return Py_BuildValue(""); } allow_python_threads(); autocompleters_clear(key); disable_python_threads(); return Py_BuildValue(""); } static PyObject* python_api_notify(PyObject *self, PyObject *args) { const char *message = NULL; const char *category = NULL; int timeout_ms = 5000; if (!PyArg_ParseTuple(args, "sis", &message, &timeout_ms, &category)) { return Py_BuildValue(""); } allow_python_threads(); api_notify(message, category, timeout_ms); disable_python_threads(); return Py_BuildValue(""); } static PyObject* python_api_send_line(PyObject *self, PyObject *args) { char *line = NULL; if (!PyArg_ParseTuple(args, "s", &line)) { return Py_BuildValue(""); } allow_python_threads(); api_send_line(line); disable_python_threads(); return Py_BuildValue(""); } static PyObject * python_api_get_current_recipient(PyObject *self, PyObject *args) { allow_python_threads(); char *recipient = api_get_current_recipient(); disable_python_threads(); if (recipient) { return Py_BuildValue("s", recipient); } else { return Py_BuildValue(""); } } static PyObject * python_api_get_current_muc(PyObject *self, PyObject *args) { allow_python_threads(); char *room = api_get_current_muc(); disable_python_threads(); if (room) { return Py_BuildValue("s", room); } else { return Py_BuildValue(""); } } static PyObject * python_api_get_current_nick(PyObject *self, PyObject *args) { allow_python_threads(); char *nick = api_get_current_nick(); disable_python_threads(); if (nick) { return Py_BuildValue("s", nick); } else { return Py_BuildValue(""); } } static PyObject* python_api_get_current_occupants(PyObject *self, PyObject *args) { allow_python_threads(); char **occupants = api_get_current_occupants(); disable_python_threads(); PyObject *result = PyList_New(0); if (occupants) { int len = g_strv_length(occupants); int i = 0; for (i = 0; i < len; i++) { PyList_Append(result, Py_BuildValue("s", occupants[i])); } return result; } else { return result; } } static PyObject* python_api_current_win_is_console(PyObject *self, PyObject *args) { allow_python_threads(); int res = api_current_win_is_console(); disable_python_threads(); if (res) { return Py_BuildValue("O", Py_True); } else { return Py_BuildValue("O", Py_False); } } static PyObject * python_api_log_debug(PyObject *self, PyObject *args) { const char *message = NULL; if (!PyArg_ParseTuple(args, "s", &message)) { return Py_BuildValue(""); } allow_python_threads(); api_log_debug(message); disable_python_threads(); return Py_BuildValue(""); } static PyObject * python_api_log_info(PyObject *self, PyObject *args) { const char *message = NULL; if (!PyArg_ParseTuple(args, "s", &message)) { return Py_BuildValue(""); } allow_python_threads(); api_log_info(message); disable_python_threads(); return Py_BuildValue(""); } static PyObject * python_api_log_warning(PyObject *self, PyObject *args) { const char *message = NULL; if (!PyArg_ParseTuple(args, "s", &message)) { return Py_BuildValue(""); } allow_python_threads(); api_log_warning(message); disable_python_threads(); return Py_BuildValue(""); } static PyObject * python_api_log_error(PyObject *self, PyObject *args) { const char *message = NULL; if (!PyArg_ParseTuple(args, "s", &message)) { return Py_BuildValue(""); } allow_python_threads(); api_log_error(message); disable_python_threads(); return Py_BuildValue(""); } static PyObject * python_api_win_exists(PyObject *self, PyObject *args) { char *tag = NULL; if (!PyArg_ParseTuple(args, "s", &tag)) { return Py_BuildValue(""); } allow_python_threads(); gboolean exists = api_win_exists(tag); disable_python_threads(); if (exists) { return Py_BuildValue("O", Py_True); } else { return Py_BuildValue("O", Py_False); } } static PyObject * python_api_win_create(PyObject *self, PyObject *args) { char *tag = NULL; PyObject *p_callback = NULL; if (!PyArg_ParseTuple(args, "sO", &tag, &p_callback)) { return Py_BuildValue(""); } if (p_callback && PyCallable_Check(p_callback)) { allow_python_threads(); api_win_create(tag, p_callback, NULL, python_window_callback); disable_python_threads(); } return Py_BuildValue(""); } static PyObject * python_api_win_focus(PyObject *self, PyObject *args) { char *tag = NULL; if (!PyArg_ParseTuple(args, "s", &tag)) { return Py_BuildValue(""); } allow_python_threads(); api_win_focus(tag); disable_python_threads(); return Py_BuildValue(""); } static PyObject * python_api_win_show(PyObject *self, PyObject *args) { char *tag = NULL; char *line = NULL; if (!PyArg_ParseTuple(args, "ss", &tag, &line)) { return Py_BuildValue(""); } allow_python_threads(); api_win_show(tag, line); disable_python_threads(); return Py_BuildValue(""); } static PyObject * python_api_win_show_themed(PyObject *self, PyObject *args) { char *tag = NULL; char *group = NULL; char *key = NULL; char *def = NULL; char *line = NULL; if (!PyArg_ParseTuple(args, "szzzs", &tag, &group, &key, &def, &line)) { return Py_BuildValue(""); } allow_python_threads(); api_win_show_themed(tag, group, key, def, line); disable_python_threads(); return Py_BuildValue(""); } static PyObject* python_api_send_stanza(PyObject *self, PyObject *args) { const char *stanza = NULL; if (!PyArg_ParseTuple(args, "s", &stanza)) { return Py_BuildValue("O", Py_False); } allow_python_threads(); int res = api_send_stanza(stanza); disable_python_threads(); if (res) { return Py_BuildValue("O", Py_True); } else { return Py_BuildValue("O", Py_False); } } static PyObject* python_api_settings_get_boolean(PyObject *self, PyObject *args) { char *group = NULL; char *key = NULL; PyObject *defobj = NULL; if (!PyArg_ParseTuple(args, "ssO!", &group, &key, &PyBool_Type, &defobj)) { return Py_BuildValue(""); } int def = PyObject_IsTrue(defobj); allow_python_threads(); int res = api_settings_get_boolean(group, key, def); disable_python_threads(); if (res) { return Py_BuildValue("O", Py_True); } else { return Py_BuildValue("O", Py_False); } } static PyObject* python_api_settings_set_boolean(PyObject *self, PyObject *args) { char *group = NULL; char *key = NULL; PyObject *valobj = NULL; if (!PyArg_ParseTuple(args, "ssO!", &group, &key, &PyBool_Type, &valobj)) { return Py_BuildValue(""); } int val = PyObject_IsTrue(valobj); allow_python_threads(); api_settings_set_boolean(group, key, val); disable_python_threads(); return Py_BuildValue(""); } static PyObject* python_api_settings_get_string(PyObject *self, PyObject *args) { char *group = NULL; char *key = NULL; char *def = NULL; if (!PyArg_ParseTuple(args, "ssz", &group, &key, &def)) { return Py_BuildValue(""); } allow_python_threads(); char *res = api_settings_get_string(group, key, def); disable_python_threads(); if (res) { return Py_BuildValue("s", res); } else { return Py_BuildValue(""); } } static PyObject* python_api_settings_set_string(PyObject *self, PyObject *args) { char *group = NULL; char *key = NULL; char *val = NULL; if (!PyArg_ParseTuple(args, "sss", &group, &key, &val)) { return Py_BuildValue(""); } allow_python_threads(); api_settings_set_string(group, key, val); disable_python_threads(); return Py_BuildValue(""); } static PyObject* python_api_settings_get_int(PyObject *self, PyObject *args) { char *group = NULL; char *key = NULL; int def = 0; if (!PyArg_ParseTuple(args, "ssi", &group, &key, &def)) { return Py_BuildValue(""); } allow_python_threads(); int res = api_settings_get_int(group, key, def); disable_python_threads(); return Py_BuildValue("i", res); } static PyObject* python_api_settings_set_int(PyObject *self, PyObject *args) { char *group = NULL; char *key = NULL; int val = 0; if (!PyArg_ParseTuple(args, "ssi", &group, &key, &val)) { return Py_BuildValue(""); } allow_python_threads(); api_settings_set_int(group, key, val); disable_python_threads(); return Py_BuildValue(""); } static PyObject* python_api_incoming_message(PyObject *self, PyObject *args) { char *barejid = NULL; char *resource = NULL; char *message = NULL; if (!PyArg_ParseTuple(args, "sss", &barejid, &resource, &message)) { return Py_BuildValue(""); } allow_python_threads(); api_incoming_message(barejid, resource, message); disable_python_threads(); return Py_BuildValue(""); } static PyObject* python_api_disco_add_feature(PyObject *self, PyObject *args) { char *feature = NULL; if (!PyArg_ParseTuple(args, "s", &feature)) { return Py_BuildValue(""); } allow_python_threads(); api_disco_add_feature(feature); disable_python_threads(); return Py_BuildValue(""); } void python_command_callback(PluginCommand *command, gchar **args) { disable_python_threads(); PyObject *p_args = NULL; int num_args = g_strv_length(args); if (num_args == 0) { if (command->max_args == 1) { p_args = Py_BuildValue("(O)", Py_BuildValue("")); PyObject_CallObject(command->callback, p_args); Py_XDECREF(p_args); } else { PyObject_CallObject(command->callback, p_args); } } else if (num_args == 1) { p_args = Py_BuildValue("(s)", args[0]); PyObject_CallObject(command->callback, p_args); Py_XDECREF(p_args); } else if (num_args == 2) { p_args = Py_BuildValue("ss", args[0], args[1]); PyObject_CallObject(command->callback, p_args); Py_XDECREF(p_args); } else if (num_args == 3) { p_args = Py_BuildValue("sss", args[0], args[1], args[2]); PyObject_CallObject(command->callback, p_args); Py_XDECREF(p_args); } else if (num_args == 4) { p_args = Py_BuildValue("ssss", args[0], args[1], args[2], args[3]); PyObject_CallObject(command->callback, p_args); Py_XDECREF(p_args); } else if (num_args == 5) { p_args = Py_BuildValue("sssss", args[0], args[1], args[2], args[3], args[4]); PyObject_CallObject(command->callback, p_args); Py_XDECREF(p_args); } if (PyErr_Occurred()) { PyErr_Print(); PyErr_Clear(); } allow_python_threads(); } void python_timed_callback(PluginTimedFunction *timed_function) { disable_python_threads(); PyObject_CallObject(timed_function->callback, NULL); allow_python_threads(); } void python_window_callback(PluginWindowCallback *window_callback, char *tag, char *line) { disable_python_threads(); PyObject *p_args = NULL; p_args = Py_BuildValue("ss", tag, line); PyObject_CallObject(window_callback->callback, p_args); Py_XDECREF(p_args); if (PyErr_Occurred()) { PyErr_Print(); PyErr_Clear(); } allow_python_threads(); } static PyMethodDef apiMethods[] = { { "cons_alert", python_api_cons_alert, METH_NOARGS, "Highlight the console window in the status bar." }, { "cons_show", python_api_cons_show, METH_VARARGS, "Print a line to the console." }, { "cons_show_themed", python_api_cons_show_themed, METH_VARARGS, "Print a themed line to the console" }, { "cons_bad_cmd_usage", python_api_cons_bad_cmd_usage, METH_VARARGS, "Show invalid command message in console" }, { "register_command", python_api_register_command, METH_VARARGS, "Register a command." }, { "register_timed", python_api_register_timed, METH_VARARGS, "Register a timed function." }, { "completer_add", python_api_completer_add, METH_VARARGS, "Add items to an autocompleter." }, { "completer_remove", python_api_completer_remove, METH_VARARGS, "Remove items from an autocompleter." }, { "completer_clear", python_api_completer_clear, METH_VARARGS, "Remove all items from an autocompleter." }, { "send_line", python_api_send_line, METH_VARARGS, "Send a line of input." }, { "notify", python_api_notify, METH_VARARGS, "Send desktop notification." }, { "get_current_recipient", python_api_get_current_recipient, METH_VARARGS, "Return the jid of the recipient of the current window." }, { "get_current_muc", python_api_get_current_muc, METH_VARARGS, "Return the jid of the room of the current window." }, { "get_current_nick", python_api_get_current_nick, METH_VARARGS, "Return nickname in current room." }, { "get_current_occupants", python_api_get_current_occupants, METH_VARARGS, "Return list of occupants in current room." }, { "current_win_is_console", python_api_current_win_is_console, METH_VARARGS, "Returns whether the current window is the console." }, { "log_debug", python_api_log_debug, METH_VARARGS, "Log a debug message" }, { "log_info", python_api_log_info, METH_VARARGS, "Log an info message" }, { "log_warning", python_api_log_warning, METH_VARARGS, "Log a warning message" }, { "log_error", python_api_log_error, METH_VARARGS, "Log an error message" }, { "win_exists", python_api_win_exists, METH_VARARGS, "Determine whether a window exists." }, { "win_create", python_api_win_create, METH_VARARGS, "Create a new window." }, { "win_focus", python_api_win_focus, METH_VARARGS, "Focus a window." }, { "win_show", python_api_win_show, METH_VARARGS, "Show text in the window." }, { "win_show_themed", python_api_win_show_themed, METH_VARARGS, "Show themed text in the window." }, { "send_stanza", python_api_send_stanza, METH_VARARGS, "Send an XMPP stanza." }, { "settings_get_boolean", python_api_settings_get_boolean, METH_VARARGS, "Get a boolean setting." }, { "settings_set_boolean", python_api_settings_set_boolean, METH_VARARGS, "Set a boolean setting." }, { "settings_get_string", python_api_settings_get_string, METH_VARARGS, "Get a string setting." }, { "settings_set_string", python_api_settings_set_string, METH_VARARGS, "Set a string setting." }, { "settings_get_int", python_api_settings_get_int, METH_VARARGS, "Get a integer setting." }, { "settings_set_int", python_api_settings_set_int, METH_VARARGS, "Set a integer setting." }, { "incoming_message", python_api_incoming_message, METH_VARARGS, "Show an incoming message." }, { "disco_add_feature", python_api_disco_add_feature, METH_VARARGS, "Add a feature to disco info response." }, { NULL, NULL, 0, NULL } }; void python_api_init(void) { Py_InitModule("prof", apiMethods); } static char* _python_plugin_name(void) { PyThreadState *ts = PyThreadState_Get(); PyFrameObject *frame = ts->frame; char const* filename = PyString_AsString(frame->f_code->co_filename); gchar **split = g_strsplit(filename, "/", 0); char *plugin_name = strdup(split[g_strv_length(split)-1]); g_strfreev(split); return plugin_name; }