X-Git-Url: https://jfr.im/git/irc/evilnet/x3.git/blobdiff_plain/cc0b2b7fedd41f6924e07ee735099163efbad931..2bee6a6e20b793a5a5749c28e7caa00e2a54c75d:/src/mod-python.c diff --git a/src/mod-python.c b/src/mod-python.c index 76f1081..4ffab92 100644 --- a/src/mod-python.c +++ b/src/mod-python.c @@ -22,6 +22,9 @@ #include "config.h" #ifdef WITH_PYTHON /* just disable this file if python doesnt exist */ +#ifndef WITH_PROTOCOL_P10 +#error mod-python is only supported with p10 protocol enabled +#endif /* WITH_PROTOCOL_P10 */ #include #include "chanserv.h" @@ -33,15 +36,16 @@ #include "mail.h" #include "timeq.h" #include "compat.h" +#include "nickserv.h" /* TODO notes * - * - Impliment most of proto-p10 irc_* commands for calling from scripts - * - Impliment functions to look up whois, channel, account, and reg-channel info for scripts - * - Impliment x3.conf settings for python variables like include path, etc. + * - Implement most of proto-p10 irc_* commands for calling from scripts + * - Implement functions to look up whois, channel, account, and reg-channel info for scripts + * - Implement x3.conf settings for python variables like include path, etc. * - modpython.py calls for everything you can reg_ a handler for in x3 * - Some kind of system for getting needed binds bound automagicaly to make it easier - * to run peoples scripts and mod-python in general. + * to run peoples' scripts and mod-python in general. * - An interface to reading/writing data to x3.db. Maybe generic, or attached to account or channel reg records? */ @@ -50,7 +54,7 @@ static const struct message_entry msgtab[] = { { "PYMSG_RELOAD_FAILED", "Error reloading Python scripts." }, { "PYMSG_RUN_UNKNOWN_EXCEPTION", "Error running python: unknown exception." }, { "PYMSG_RUN_EXCEPTION", "Error running python: %s: %s." }, - { NULL, NULL } /* sentenal */ + { NULL, NULL } /* sentinel */ }; #define MODPYTHON_CONF_NAME "modules/python" @@ -66,80 +70,100 @@ const char *python_module_deps[] = { NULL }; static struct module *python_module; PyObject *base_module = NULL; /* Base python handling library */ -PyObject *handler_object = NULL; /* instanciation of handler class */ +PyObject *handler_object = NULL; /* instance of handler class */ extern struct userNode *global, *chanserv, *opserv, *nickserv, *spamserv; -/* ---------------------------------------------------------------------- * - Some hooks you can call from modpython.py to interact with the - service, and IRC. These emb_* functions are available as _svc.* - in python. - */ +/* +Some hooks you can call from modpython.py to interact with the +service. These emb_* functions are available as _svc.* in python. */ struct _tuple_dict_extra { PyObject* data; size_t* extra; }; -static int _dict_iter_get_users(char const* key, UNUSED_ARG(void* data), void* extra) { - struct _tuple_dict_extra* real_extra = (struct _tuple_dict_extra*)extra; +static void pyobj_release_tuple(PyObject* tuple, size_t n) { + size_t i; - PyTuple_SetItem(real_extra->data, *(int*)real_extra->extra, - PyString_FromString(key)); - *real_extra->extra = *real_extra->extra + 1; - return 0; + if (tuple == NULL) + return; + + for (i = 0; i < n; ++i) + Py_XDECREF(PyTuple_GET_ITEM(tuple, i)); + + Py_XDECREF(tuple); } -static int _dict_iter_get_channels(char const* key, UNUSED_ARG(void* data), void* extra) { +static int _dict_iter_fill_tuple(char const* key, UNUSED_ARG(void* data), void* extra) { + PyObject* tmp; struct _tuple_dict_extra* real_extra = (struct _tuple_dict_extra*)extra; - PyTuple_SetItem(real_extra->data, *(int*)real_extra->extra, - PyString_FromString(key)); + if ((tmp = PyString_FromString(key)) == NULL) + return 1; + + if (PyTuple_SetItem(real_extra->data, *(int*)real_extra->extra, tmp)) { + Py_DECREF(tmp); + return 1; + } + *real_extra->extra = *real_extra->extra + 1; return 0; } -/* get a tuple with all users in it */ static PyObject* -emb_get_users(UNUSED_ARG(PyObject *self), PyObject *args) { +pyobj_from_dict_t(dict_t d) { PyObject* retval; - size_t num_clients, n = 0; + size_t n = 0; struct _tuple_dict_extra extra; - if (!PyArg_ParseTuple(args, "")) + if ((retval = PyTuple_New(dict_size(d))) == NULL) return NULL; - num_clients = dict_size(clients); - retval = PyTuple_New(num_clients); - extra.extra = &n; extra.data = retval; - dict_foreach(clients, _dict_iter_get_users, (void*)&extra); + if (dict_foreach(d, _dict_iter_fill_tuple, (void*)&extra) != NULL) { + pyobj_release_tuple(retval, n); + return NULL; + } return retval; } +/* get a tuple with all users in it */ +static PyObject* +emb_get_users(UNUSED_ARG(PyObject *self), PyObject *args) { + if (!PyArg_ParseTuple(args, "")) + return NULL; + + return pyobj_from_dict_t(clients); +} + /* get a tuple with all channels in it */ static PyObject* emb_get_channels(UNUSED_ARG(PyObject* self), PyObject* args) { - PyObject* retval; - size_t num_channels, n = 0; - struct _tuple_dict_extra extra; - if (!PyArg_ParseTuple(args, "")) return NULL; - num_channels = dict_size(channels); - retval = PyTuple_New(num_channels); + return pyobj_from_dict_t(channels); +} - extra.extra = &n; - extra.data = retval; +static PyObject* +emb_get_servers(UNUSED_ARG(PyObject* self), PyObject* args) { + if (!PyArg_ParseTuple(args, "")) + return NULL; - dict_foreach(channels, _dict_iter_get_channels, (void*)&extra); + return pyobj_from_dict_t(servers); +} - return retval; +static PyObject* +emb_get_accounts(UNUSED_ARG(PyObject* self), PyObject* args) { + if (!PyArg_ParseTuple(args, "")) + return NULL; + + return pyobj_from_dict_t(nickserv_handle_dict); } static PyObject* @@ -235,14 +259,19 @@ static PyObject* pyobj_from_usernode(struct userNode* user) { unsigned int n; struct modeNode *mn; + PyObject* retval = NULL; PyObject* pChanList = PyTuple_New(user->channels.used); + if (pChanList == NULL) + return NULL; + for (n=0; n < user->channels.used; n++) { mn = user->channels.list[n]; - PyTuple_SetItem(pChanList, n, Py_BuildValue("s", mn->channel->name)); + if (PyTuple_SetItem(pChanList, n, Py_BuildValue("s", mn->channel->name))) + goto cleanup; } - return Py_BuildValue("{" + retval = Py_BuildValue("{" "s: s, " /* nick */ "s: s, " /* ident */ "s: s, " /* info */ @@ -252,9 +281,7 @@ pyobj_from_usernode(struct userNode* user) { "s: s, " /* sethost */ "s: s, " /* crypthost */ "s: s, " /* cryptip */ -#ifdef WITH_PROTOCOL_P10 "s: s, " /* numeric */ -#endif /* WITH_PROTOCOL_P10 */ "s: i, " /* loc */ "s: i, " /* no_notice */ "s: s, " /* mark */ @@ -270,15 +297,24 @@ pyobj_from_usernode(struct userNode* user) { "sethost", user->sethost, "crypthost", user->crypthost, "cryptip", user->cryptip, -#ifdef WITH_PROTOCOL_P10 "numeric", user->numeric, -#endif /* WITH_PROTOCOL_P10 */ "loc", user->loc, "no_notice", user->no_notice, "mark", user->mark, "version_reply", user->version_reply, "account", user->handle_info ? user->handle_info->handle : NULL, "channels", pChanList); + + if (retval == NULL) + goto cleanup; + + return retval; + +cleanup: + Py_XDECREF(retval); + pyobj_release_tuple(pChanList, n); + + return NULL; } static PyObject* @@ -301,6 +337,169 @@ emb_get_user(UNUSED_ARG(PyObject *self), PyObject *args) return pyobj_from_usernode(user); } +static PyObject* +pyobj_from_server(struct server* srv) { + size_t n, idx; + PyObject* tmp = NULL; + PyObject* retval = NULL; + PyObject* users = PyTuple_New(srv->clients); + + if (users == NULL) + return NULL; + + idx = 0; + for (n = 0; n < srv->num_mask; ++n) { + if (srv->users[n] == NULL) + continue; + + tmp = PyString_FromString(srv->users[n]->nick); + if (tmp == NULL) + goto cleanup; + + if (PyTuple_SetItem(users, idx++, tmp)) + goto cleanup; + } + + retval = Py_BuildValue("{" + "s:s," /* name */ + "s:l," /* boot */ + "s:l," /* link_time */ + "s:s," /* description */ + "s:s," /* numeric */ + "s:I," /* num_mask */ + "s:I," /* hops */ + "s:I," /* clients */ + "s:I," /* max_clients */ + "s:I," /* burst */ + "s:I," /* self_burst */ + "s:s" /* uplink */ + "s:O" /* users */ + /* TODO: Children */ + "}", + "name", srv->name, + "boot", srv->boot, + "link_time", srv->link_time, + "description", srv->description, + "numeric", srv->numeric, + "num_mask", srv->num_mask, + "hops", srv->hops, + "clients", srv->clients, + "max_clients", srv->max_clients, + "burst", srv->burst, + "self_burst", srv->self_burst, + "uplink", srv->uplink ? srv->uplink->name : NULL, + "users", users + ); + + if (retval == NULL) + goto cleanup; + + return retval; + +cleanup: + Py_XDECREF(retval); + pyobj_release_tuple(users, idx); + + return NULL; +} + +static PyObject* +emb_get_server(UNUSED_ARG(PyObject* self), PyObject* args) { + struct server* srv; + char const* name; + + if (!PyArg_ParseTuple(args, "s", &name)) + return NULL; + + if (name == NULL || strlen(name) == 0) { + PyErr_SetString(PyExc_Exception, "invalid server name"); + return NULL; + } + + if ((srv = GetServerH(name)) == NULL) { + PyErr_SetString(PyExc_Exception, "unknown server"); + return NULL; + } + + return pyobj_from_server(srv); +} + +static PyObject* +pyobj_from_modelist(struct modeList* mode) { + size_t n; + PyObject* tmp; + PyObject* retval = PyTuple_New(mode->used); + + if (retval == NULL) + return NULL; + + for (n = 0; n < mode->used; ++n) { + struct modeNode* mn = mode->list[n]; + tmp = PyString_FromString(mn->user->nick); + if (tmp == NULL) { + pyobj_release_tuple(retval, n); + return NULL; + } + + if (PyTuple_SetItem(retval, n, tmp)) { + pyobj_release_tuple(retval, n); + return NULL; + } + } + + return retval; +} + +static PyObject* +pyobj_from_banlist(struct banList* bans) { + size_t n; + struct banNode* bn; + PyObject* tmp; + PyObject* retval = PyTuple_New(bans->used); + + if (retval == NULL) + return NULL; + + for (n = 0; n < bans->used; ++n) { + bn = bans->list[n]; + + tmp = Py_BuildValue("{s:s,s:s,s:l}", + "ban", bn->ban, "who", bn->who, "set", bn->set); + + if (tmp == NULL || PyTuple_SetItem(retval, n, tmp)) { + pyobj_release_tuple(retval, n); + return NULL; + } + } + + return retval; +} + +static PyObject* +pyobj_from_exemptlist(struct exemptList* exmp) { + size_t n; + struct exemptNode* en; + PyObject* tmp; + PyObject* retval = PyTuple_New(exmp->used); + + if (retval == NULL) + return NULL; + + for (n = 0; n < exmp->used; ++n) { + en = exmp->list[n]; + + tmp = Py_BuildValue("{s:s,s:s,s:l}", + "ban", en->exempt, "who", en->who, "set", en->set); + + if (tmp == NULL || PyTuple_SetItem(retval, n, tmp)) { + pyobj_release_tuple(retval, n); + return NULL; + } + } + + return retval; +} + static PyObject* emb_get_channel(UNUSED_ARG(PyObject *self), PyObject *args) { @@ -309,10 +508,10 @@ emb_get_channel(UNUSED_ARG(PyObject *self), PyObject *args) */ char *name; struct chanNode *channel; - unsigned int n; - PyObject *pChannelMembers; - PyObject *pChannelBans; - PyObject *pChannelExempts; + PyObject *pChannelMembers = NULL; + PyObject *pChannelBans = NULL; + PyObject *pChannelExempts = NULL; + PyObject *retval = NULL; if(!PyArg_ParseTuple(args, "s", &name)) @@ -324,37 +523,21 @@ emb_get_channel(UNUSED_ARG(PyObject *self), PyObject *args) } /* build tuple of nicks in channel */ - pChannelMembers = PyTuple_New(channel->members.used); - for(n=0;n < channel->members.used;n++) { - struct modeNode *mn = channel->members.list[n]; - PyTuple_SetItem(pChannelMembers, n, Py_BuildValue("s", mn->user->nick)); - } + pChannelMembers = pyobj_from_modelist(&channel->members); + if (pChannelMembers == NULL) + goto cleanup; /* build tuple of bans */ - pChannelBans = PyTuple_New(channel->banlist.used); - for(n=0; n < channel->banlist.used;n++) { - struct banNode *bn = channel->banlist.list[n]; - PyTuple_SetItem(pChannelBans, n, - Py_BuildValue("{s:s,s:s,s:i}", - "ban", bn->ban, - "who", bn->who, - "set", bn->set) - ); - } + pChannelBans = pyobj_from_banlist(&channel->banlist); + if (pChannelBans == NULL) + goto cleanup; /* build tuple of exempts */ - pChannelExempts = PyTuple_New(channel->exemptlist.used); - for(n=0; n < channel->exemptlist.used;n++) { - struct exemptNode *en = channel->exemptlist.list[n]; - PyTuple_SetItem(pChannelExempts, n, - Py_BuildValue("{s:s,s:s,s:i}", - "ban", en->exempt, - "who", en->who, - "set", en->set) - ); - } + pChannelExempts = pyobj_from_exemptlist(&channel->exemptlist); + if (pChannelExempts == NULL) + goto cleanup; - return Py_BuildValue("{s:s,s:s,s:s,s:i" + retval = Py_BuildValue("{s:s,s:s,s:s,s:i" ",s:i,s:i,s:O,s:O,s:O}", "name", channel->name, @@ -368,6 +551,18 @@ emb_get_channel(UNUSED_ARG(PyObject *self), PyObject *args) "bans", pChannelBans, "exempts", pChannelExempts ); + if (retval == NULL) + goto cleanup; + + return retval; + +cleanup: + Py_XDECREF(retval); + pyobj_release_tuple(pChannelExempts, channel->exemptlist.used); + pyobj_release_tuple(pChannelBans, channel->banlist.used); + pyobj_release_tuple(pChannelMembers, channel->members.used); + + return NULL; } static PyObject* @@ -434,7 +629,6 @@ emb_log_module(UNUSED_ARG(PyObject *self), PyObject *args) { /* a gateway to standard X3 logging subsystem. * level is a value 0 to 9 as defined by the log_severity enum in log.h. - * LOG_INFO is 3, LOG_WARNING is 6, LOG_ERROR is 7. * * for now, all logs go to the PY_LOG log. In the future this will change. */ @@ -451,17 +645,197 @@ emb_log_module(UNUSED_ARG(PyObject *self), PyObject *args) return Py_BuildValue("i", ret); } +static PyObject* +emb_kill(UNUSED_ARG(PyObject* self), PyObject* args) { + char const* from_nick, *target_nick, *message; + struct userNode *target; + struct service *service; + + if (!PyArg_ParseTuple(args, "sss", &from_nick, &target_nick, &message)) + return NULL; + + if(!(service = service_find(from_nick))) { + PyErr_SetString(PyExc_Exception, "unknown service user specified as from user"); + return NULL; + } + + if ((target = GetUserH(target_nick)) == NULL) { + PyErr_SetString(PyExc_Exception, "unknown target user"); + return NULL; + } + + irc_kill(service->bot, target, message); + + return Py_None; +} + +struct py_timeq_extra { + PyObject* func; + PyObject* arg; +}; + +static +void py_timeq_callback(void* data) { + struct py_timeq_extra* extra = (struct py_timeq_extra*)data; + + PyObject* retval = PyObject_Call(extra->func, extra->arg, NULL); + Py_XDECREF(retval); + + Py_DECREF(extra->func); + Py_DECREF(extra->arg); +} + +static PyObject* +emb_timeq_add(UNUSED_ARG(PyObject* self), PyObject* args) { + time_t when; + PyObject* func, *arg; + struct py_timeq_extra* extra; + + if (!PyArg_ParseTuple(args, "lOO", &when, &func, &arg)) + return NULL; + + if (!PyFunction_Check(func)) { + PyErr_SetString(PyExc_Exception, "first argument must be a function"); + return NULL; + } + + if (!PyTuple_Check(arg)) { + PyErr_SetString(PyExc_Exception, "second argument must be a tuple"); + return NULL; + } + + extra = malloc(sizeof(struct py_timeq_extra)); + if (extra == NULL) { + PyErr_SetString(PyExc_Exception, "out of memory"); + return NULL; + } + + Py_INCREF(func); + Py_INCREF(arg); + + extra->func = func; + extra->arg = arg; + + timeq_add(when, py_timeq_callback, (void*)extra); + + return Py_None; +} + +static PyObject* +emb_timeq_del(UNUSED_ARG(PyObject* self), PyObject* args) { + /* NOTE: + * This function will delete all python-added callbacks registered + * to run at the given time, regardless of their data. This is due to + * the unnecessary extra burden it would require to get the same data for + * multiple runs. + */ + time_t when; + + if (!PyArg_ParseTuple(args, "l", &when)) + return NULL; + + timeq_del(when, py_timeq_callback, NULL, TIMEQ_IGNORE_DATA); + + return Py_None; +} + +static int pyobj_config_make_dict(char const* key, void* data_, void* extra) { + struct record_data* data = (struct record_data*)data_; + PyObject* dict = (PyObject*)extra; + PyObject* value = NULL, *tmp; + size_t n, idx; + int success; + + switch (data->type) { + case RECDB_QSTRING: + value = PyString_FromString(data->d.qstring); + break; + + case RECDB_STRING_LIST: + value = PyList_New(data->d.slist->used); + if (value == NULL) + break; + + success = 1; + for (n = 0; n < data->d.slist->used; ++n) { + tmp = PyString_FromString(data->d.slist->list[n]); + if (tmp == NULL) { + success = 0; + break; + } + + if (PyList_SetItem(value, n, tmp)) { + Py_DECREF(tmp); + success = 0; + break; + } + } + if (!success) { + for (idx = 0; idx < n; ++idx) { + tmp = PyList_GET_ITEM(value, idx); + Py_DECREF(tmp); + PyList_SET_ITEM(value, idx, NULL); + } + Py_DECREF(value); + value = NULL; + } + break; + + case RECDB_OBJECT: + value = PyDict_New(); + if (value == NULL) + break; + + if (dict_foreach(data->d.object, pyobj_config_make_dict, (void*)value) != NULL) { + PyDict_Clear(value); + value = NULL; + break; + } + + break; + + default: + value = Py_None; + } + + if (value == NULL) + return 1; + + if (PyDict_SetItemString(dict, key, value)) + return 1; + + return 0; +} + +static PyObject* +emb_get_config(UNUSED_ARG(PyObject* self), PyObject* args) { + PyObject* dict; + + if (!PyArg_ParseTuple(args, "")) + return NULL; + + dict = PyDict_New(); + if (dict == NULL) + return NULL; + + if (conf_enum_root(pyobj_config_make_dict, (void*)dict) != NULL) { + PyDict_Clear(dict); + PyErr_SetString(PyExc_Exception, "unable to iterate config"); + return NULL; + } + + return dict; +} + static PyMethodDef EmbMethods[] = { /* Communication methods */ - {"get_users", emb_get_users, METH_VARARGS, "Get all connected users"}, - {"get_channels", emb_get_channels, METH_VARARGS, "Get all channels"}, {"dump", emb_dump, METH_VARARGS, "Dump raw P10 line to server"}, {"send_target_privmsg", emb_send_target_privmsg, METH_VARARGS, "Send a message to somewhere"}, {"send_target_notice", emb_send_target_notice, METH_VARARGS, "Send a notice to somewhere"}, {"log_module", emb_log_module, METH_VARARGS, "Log something using the X3 log subsystem"}, //TODO: {"exec_cmd", emb_exec_cmd, METH_VARARGS, "execute x3 command provided"}, // This should use environment from "python command" call to pass in, if available -//TODO: {"kill" + {"kill", emb_kill, METH_VARARGS, "Kill someone"}, //TODO: {"shun" //TODO: {"unshun" //TODO: {"gline", emb_gline, METH_VARARGS, "gline a mask"}, @@ -470,24 +844,30 @@ static PyMethodDef EmbMethods[] = { //TODO: {"channel_mode", emb_channel_mode, METH_VARARGS, "set modes on a channel"}, //TODO: {"user_mode", emb_user_mode, METH_VARARGS, "Have x3 set usermodes on one of its own nicks"}, // -//TODO: {"get_config", emb_get_config, METH_VARARGS, "get x3.conf settings into a nested dict"}, + {"get_config", emb_get_config, METH_VARARGS, "get x3.conf settings into a nested dict"}, //TODO: {"config_set", emb_config_set, METH_VARARGS, "change a config setting 'on-the-fly'."}, // -//TODO: {"timeq_add", emb_timeq_new, METH_VARARGS, "some kind of interface to the timed event system."}, -//TODO: {"timeq_del", emb_timeq_new, METH_VARARGS, "some kind of interface to the timed event system."}, + {"timeq_add", emb_timeq_add, METH_VARARGS, "add function to callback to the event system"}, + {"timeq_del", emb_timeq_del, METH_VARARGS, "remove function to callback from the event system"}, + /* Information gathering methods */ {"get_user", emb_get_user, METH_VARARGS, "Get details about a nickname"}, + {"get_users", emb_get_users, METH_VARARGS, "Get all connected users"}, {"get_channel", emb_get_channel, METH_VARARGS, "Get details about a channel"}, + {"get_channels", emb_get_channels, METH_VARARGS, "Get all channels"}, + {"get_server", emb_get_server, METH_VARARGS, "Get details about a server"}, + {"get_servers", emb_get_servers, METH_VARARGS, "Get all server names"}, {"get_account", emb_get_account, METH_VARARGS, "Get details about an account"}, + {"get_accounts", emb_get_accounts, METH_VARARGS, "Get all nickserv accounts"}, {"get_info", emb_get_info, METH_VARARGS, "Get various misc info about x3"}, /* null terminator */ {NULL, NULL, 0, NULL} }; -/* ------------------------------------------------------------------------------------------------ * - Thes functions set up the embedded environment for us to call out to modpython.py class - methods. +/* +These functions set up the embedded environment for us to call out to +modpython.py class methods. */ void python_log_module() { @@ -527,7 +907,7 @@ void python_log_module() { PyObject *python_build_handler_args(size_t argc, char *args[], PyObject *pIrcObj) { /* Sets up a python tuple with passed in arguments, prefixed by the Irc instance - which handlers use to interact with c. + which handlers use to interact with C. argc = number of args args = array of args pIrcObj = instance of the irc class @@ -866,7 +1246,7 @@ python_cleanup(void) { log_module(PY_LOG, LOG_INFO, "python module cleanup"); if (PyErr_Occurred()) PyErr_Clear(); - Py_Finalize(); /* Shut down python enterpriter */ + Py_Finalize(); /* Shut down python enterpreter */ } /* ---------------------------------------------------------------------------------- * @@ -1049,8 +1429,8 @@ int python_init(void) { modcmd_register(python_module, "run", cmd_run, 2, MODCMD_REQUIRE_AUTHED, "flags", "+oper", NULL); modcmd_register(python_module, "command", cmd_command, 3, MODCMD_REQUIRE_STAFF, NULL); -// Please help us by implimenting any of the callbacks listed as TODO below. They already exist -// in x3, they just need handle_ bridges implimented. (see python_handle_join for an example) +// Please help us by implementing any of the callbacks listed as TODO below. They already exist +// in x3, they just need handle_ bridges implemented. (see python_handle_join for an example) reg_server_link_func(python_handle_server_link); reg_new_user_func(python_handle_new_user); reg_nick_change_func(python_handle_nick_change);