#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 <Python.h>
#include "chanserv.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?
*/
{ "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"
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) {
+ PyObject* tmp;
+ struct _tuple_dict_extra* real_extra = (struct _tuple_dict_extra*)extra;
+
+ if ((tmp = PyString_FromString(key)) == NULL)
+ return 1;
+
+ if (PyTuple_SetItem(real_extra->data, *(int*)real_extra->extra, tmp))
+ return 1;
+
+ *real_extra->extra = *real_extra->extra + 1;
+
+ return 0;
+}
+
+static int _dict_iter_get_channels(char const* key, UNUSED_ARG(void* data), void* extra) {
+ PyObject* tmp;
+ struct _tuple_dict_extra* real_extra = (struct _tuple_dict_extra*)extra;
+
+ if ((tmp = PyString_FromString(key)) == NULL)
+ return 1;
+
+ if (PyTuple_SetItem(real_extra->data, *(int*)real_extra->extra, tmp))
+ return 1;
+
+ *real_extra->extra = *real_extra->extra + 1;
+ return 0;
+}
+
+static int _dict_iter_get_servers(char const* key, UNUSED_ARG(void* data), void* extra) {
+ struct _tuple_dict_extra* real_extra = (struct _tuple_dict_extra*)extra;
+
+ PyTuple_SetItem(real_extra->data, *(int*)real_extra->extra,
+ PyString_FromString(key));
+ *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) {
+ PyObject* retval;
+ PyObject* tmp;
+ size_t num_clients, n = 0, i;
+ struct _tuple_dict_extra extra;
+
+ if (!PyArg_ParseTuple(args, ""))
+ return NULL;
+
+ num_clients = dict_size(clients);
+ retval = PyTuple_New(num_clients);
+ if (retval == NULL)
+ return NULL;
+
+ extra.extra = &n;
+ extra.data = retval;
+
+ if (dict_foreach(clients, _dict_iter_get_users, (void*)&extra) != NULL) {
+ for (i = 0; i < n; ++i) {
+ tmp = PyTuple_GetItem(retval, i);
+ PyTuple_SET_ITEM(retval, i, NULL);
+ Py_DECREF(tmp);
+ }
+ Py_DECREF(retval);
+ return NULL;
+ }
+
+ return retval;
+}
+
+/* get a tuple with all channels in it */
+static PyObject*
+emb_get_channels(UNUSED_ARG(PyObject* self), PyObject* args) {
+ PyObject* retval;
+ PyObject* tmp;
+ size_t num_channels, n = 0, i;
+ struct _tuple_dict_extra extra;
+
+ if (!PyArg_ParseTuple(args, ""))
+ return NULL;
+
+ num_channels = dict_size(channels);
+ retval = PyTuple_New(num_channels);
+ if (retval == NULL)
+ return NULL;
+
+ extra.extra = &n;
+ extra.data = retval;
+
+ if (dict_foreach(channels, _dict_iter_get_channels, (void*)&extra) != NULL) {
+ for (i = 0; i < n; ++i) {
+ tmp = PyTuple_GetItem(retval, i);
+ PyTuple_SET_ITEM(retval, i, NULL);
+ Py_DECREF(tmp);
+ }
+ Py_DECREF(retval);
+ return NULL;
+ }
+
+ return retval;
+}
+
+static PyObject*
+emb_get_servers(UNUSED_ARG(PyObject* self), PyObject* args) {
+ PyObject* retval;
+ size_t n = 0;
+ struct _tuple_dict_extra extra;
+
+ if (!PyArg_ParseTuple(args, ""))
+ return NULL;
+
+ retval = PyTuple_New(dict_size(servers));
+
+ extra.extra = &n;
+ extra.data = retval;
+
+ dict_foreach(servers, _dict_iter_get_servers, (void*)&extra);
+
+ return retval;
+}
static PyObject*
emb_dump(UNUSED_ARG(PyObject *self), PyObject *args)
if(!PyArg_ParseTuple(args, "s:dump", &buf ))
return NULL;
+
safestrncpy(linedup, buf, sizeof(linedup));
+
if(parse_line(linedup, 1)) {
irc_raw(buf);
ret = 1;
+ } else {
+ PyErr_SetString(PyExc_Exception, "invalid protocol message");
+ return NULL;
}
+
return Py_BuildValue("i", ret);
}
if(!PyArg_ParseTuple(args, "sss:reply", &servicenick, &channel, &buf ))
return NULL;
+
+ if (buf == NULL || strlen(buf) == 0) {
+ PyErr_SetString(PyExc_Exception, "invalid empty message");
+ return NULL;
+ }
+
if(!(service = service_find(servicenick))) {
- /* TODO: generate python exception here */
+ PyErr_SetString(PyExc_Exception, "no such service nick");
return NULL;
}
- send_target_message(5, channel, service->bot, "%s", buf);
+
+ ret = send_target_message(5, channel, service->bot, "%s", buf);
return Py_BuildValue("i", ret);
}
struct service *service;
-
if(!PyArg_ParseTuple(args, "sss:reply", &servicenick, &target, &buf ))
return NULL;
+
+ if (buf == NULL || strlen(buf) == 0) {
+ PyErr_SetString(PyExc_Exception, "invalid empty message");
+ return NULL;
+ }
+
if(!(service = service_find(servicenick))) {
- /* TODO: generate python exception here */
+ PyErr_SetString(PyExc_Exception, "no such service nick");
return NULL;
}
- send_target_message(4, target, service->bot, "%s", buf);
+
+ ret = send_target_message(4, target, service->bot, "%s", buf);
+
return Py_BuildValue("i", ret);
}
+static PyObject*
+pyobj_from_usernode(struct userNode* user) {
+ unsigned int n;
+ struct modeNode *mn;
+ PyObject* pChanList = PyTuple_New(user->channels.used);
+
+ for (n=0; n < user->channels.used; n++) {
+ mn = user->channels.list[n];
+ PyTuple_SetItem(pChanList, n, Py_BuildValue("s", mn->channel->name));
+ }
+
+ return Py_BuildValue("{"
+ "s: s, " /* nick */
+ "s: s, " /* ident */
+ "s: s, " /* info */
+ "s: s, " /* hostname */
+ "s: s, " /* ip */
+ "s: s, " /* fakehost */
+ "s: s, " /* sethost */
+ "s: s, " /* crypthost */
+ "s: s, " /* cryptip */
+ "s: s, " /* numeric */
+ "s: i, " /* loc */
+ "s: i, " /* no_notice */
+ "s: s, " /* mark */
+ "s: s, " /* version_reply */
+ "s: s, " /* account */
+ "s: O}", /* channels */
+ "nick", user->nick,
+ "ident", user->ident,
+ "info", user->info,
+ "hostname", user->hostname,
+ "ip", irc_ntoa(&user->ip),
+ "fakehost", user->fakehost,
+ "sethost", user->sethost,
+ "crypthost", user->crypthost,
+ "cryptip", user->cryptip,
+ "numeric", user->numeric,
+ "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);
+}
+
static PyObject*
emb_get_user(UNUSED_ARG(PyObject *self), PyObject *args)
{
/* Get a python object containing everything x3 knows about a user, by nick.
usage: _svc.get_user(<nick>)
*/
- char *nick;
+ char const* nick;
struct userNode *user;
- struct modeNode *mn;
- unsigned int n;
- PyObject* pChanList;
-
if(!PyArg_ParseTuple(args, "s", &nick))
return NULL;
+
if(!(user = GetUserH(nick))) {
- /* TODO: generate python exception here */
+ PyErr_SetString(PyExc_Exception, "no such user");
return NULL;
}
- pChanList = PyTuple_New(user->channels.used);
- for(n=0;n<user->channels.used;n++) {
- mn = user->channels.list[n];
- PyTuple_SetItem(pChanList, n, Py_BuildValue("s", mn->channel->name));
+
+ 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;
}
- return Py_BuildValue("{s:s,s:s,s:s,s:s,s:s" /* format strings. s=string, i=int */
- ",s:s,s:s,s:s,s:s,s:s" /* (format is key:value) O=object */
- ",s:i,s:i,s:s,s:s,s:s" /* blocks of 5 for readability */
- "s:O}",
- "nick", user->nick,
- "ident", user->ident,
- "info", user->info,
- "hostname", user->hostname,
- "ip", irc_ntoa(&user->ip),
+ 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);
+
+ for (n = 0; n < idx; ++n) {
+ tmp = PyTuple_GetItem(users, n);
+ PyTuple_SetItem(users, n, NULL);
+ Py_DECREF(tmp);
+ }
+ Py_DECREF(users);
+
+ 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;
- "fakehost", user->fakehost,
- "sethost", user->sethost,
- "crypthost", user->crypthost,
- "cryptip", user->cryptip,
- "numeric", user->numeric, /* TODO: only ifdef WITH_PROTOCOL_P10 */
+ if (name == NULL || strlen(name) == 0) {
+ PyErr_SetString(PyExc_Exception, "invalid server name");
+ return NULL;
+ }
- "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 ((srv = GetServerH(name)) == NULL) {
+ PyErr_SetString(PyExc_Exception, "unknown server");
+ return NULL;
+ }
+
+ return pyobj_from_server(srv);
}
static PyObject*
if(!PyArg_ParseTuple(args, "s", &name))
return NULL;
+
if(!(channel = GetChannel(name))) {
- /* TODO: generate py exception here */
+ PyErr_SetString(PyExc_Exception, "unknown channel");
return NULL;
}
return NULL;
hi = get_handle_info(name);
+
if(!hi) {
+ PyErr_SetString(PyExc_Exception, "unknown account name");
return NULL;
}
+
return Py_BuildValue("{s:s,s:i,s:s,s:s,s:s"
",s:s,s:s}",
{
/* 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.
*/
//TODO: {"timeq_del", emb_timeq_new, METH_VARARGS, "some kind of interface to the timed 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_info", emb_get_info, METH_VARARGS, "Get various misc info about x3"},
/* null terminator */
};
-/* ------------------------------------------------------------------------------------------------ *
- 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() {
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
pName = PyString_FromString(modpython_conf.main_module);
base_module = PyImport_Import(pName);
Py_DECREF(pName);
+
+ Py_XDECREF(handler_object);
+ handler_object = NULL;
+
if(base_module != NULL) {
handler_object = python_new_handler_object();
if(handler_object) {
log_module(PY_LOG, LOG_INFO, "python module cleanup");
if (PyErr_Occurred())
PyErr_Clear();
- Py_Finalize(); /* Shut down python enterpriter */
- return;
+ Py_Finalize(); /* Shut down python enterpreter */
}
/* ---------------------------------------------------------------------------------- *
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);
projects / irc / evilnet / x3.git / blobdiff