#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 <Python.h>
#include "chanserv.h"
#include "conf.h"
#include "modcmd.h"
#include "nickserv.h"
#include "opserv.h"
#include "saxdb.h"
-#include "sendmail.h"
+#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.
+ * - Create a (python side) command registry that plugins register into
+ * - In modcmd.c check that list first, before the usual (c based) command search
+ * - If python version returns 0, go on with the built-in search, otherwise just quit (allows plugins to override)
+ * - OR
+ * - Mechanism for python plugins to register themselves like x3 plugins? (*module.____) ??
+ * - Then, same problem as other x3 modules, pain to set up commands 1st time etc, maybe solve that for all modules?
+ * - An interface to reading/writing data to x3.db. Maybe generic, or attached to account or channel reg records?
+
+ * basic startup for now:
+ * configure --enable-modules=python
+ * Make install will copy modpython.py and plugins/ directory to start out with hangman example/test
+ *
+ * x3.conf: in the "moduleS" section add:
+ * "python" {
+ * "scripts_dir" "/home/you/x3rundirectory";
+ * "main_module" "modpython";
+ * };
+
+ * /msg o3 bind o3 py\ run *python.run
+ * /msg o3 bind o3 py\ reload *python.reload
+ * /msg o3 bind o3 py\ command *python.command
+
+ * example script bindings (for now)
+ * /msg o3 bind x3 hangman *modcmd.joiner
+ * /msg o3 bind x3 hangman\ start *python.command hangman start
+ * /msg o3 bind x3 hangman\ end *python.command hangman end
+ * /msg o3 bind x3 hangman\ guess *python.command hangman guess $1
*/
static const struct message_entry msgtab[] = {
{ "PYMSG_RELOAD_SUCCESS", "Reloaded Python scripts successfully." },
{ "PYMSG_RELOAD_FAILED", "Error reloading Python scripts." },
- { NULL, NULL } /* sentenal */
+ { "PYMSG_RUN_UNKNOWN_EXCEPTION", "Error running python: unknown exception." },
+ { "PYMSG_RUN_EXCEPTION", "Error running python: %s: %s." },
+ { NULL, NULL } /* sentinel */
};
+#define MODPYTHON_CONF_NAME "modules/python"
+
+static
+struct {
+ char const* scripts_dir;
+ char const* main_module;
+} modpython_conf;
+
static struct log_type *PY_LOG;
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 */
-/* ---------------------------------------------------------------------- *
- Some hooks you can call from modpython.py to interact with the
- service, and IRC. These emb_* functions are available as svc.*
- in python.
- */
+extern struct userNode *global, *chanserv, *opserv, *nickserv, *spamserv;
+
+/*
+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 void pyobj_release_tuple(PyObject* tuple, size_t n) {
+ size_t i;
+
+ if (tuple == NULL)
+ return;
+
+ for (i = 0; i < n; ++i)
+ Py_XDECREF(PyTuple_GET_ITEM(tuple, i));
+
+ Py_XDECREF(tuple);
+}
+
+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;
+
+ 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;
+}
+
+static PyObject*
+pyobj_from_dict_t(dict_t d) {
+ PyObject* retval;
+ size_t n = 0;
+ struct _tuple_dict_extra extra;
+
+ if ((retval = PyTuple_New(dict_size(d))) == NULL)
+ return NULL;
+
+ extra.extra = &n;
+ extra.data = retval;
+
+ if (dict_foreach(d, _dict_iter_fill_tuple, (void*)&extra) != NULL) {
+ pyobj_release_tuple(retval, n);
+ return NULL;
+ }
+
+ return retval;
+}
+
+PyDoc_STRVAR(emb_get_users__doc__,
+ "get_users() -> tuple with user nicks");
static PyObject*
-emb_dump(PyObject *self, PyObject *args)
+emb_get_users(UNUSED_ARG(PyObject *self), PyObject *args) {
+ if (!PyArg_ParseTuple(args, ""))
+ return NULL;
+
+ return pyobj_from_dict_t(clients);
+}
+
+PyDoc_STRVAR(emb_get_channels__doc__,
+ "get_channels() -> tuple with channel names");
+
+static PyObject*
+emb_get_channels(UNUSED_ARG(PyObject* self), PyObject* args) {
+ if (!PyArg_ParseTuple(args, ""))
+ return NULL;
+
+ return pyobj_from_dict_t(channels);
+}
+
+PyDoc_STRVAR(emb_get_servers__doc__,
+ "get_servers() -> tuple with server names");
+
+static PyObject*
+emb_get_servers(UNUSED_ARG(PyObject* self), PyObject* args) {
+ if (!PyArg_ParseTuple(args, ""))
+ return NULL;
+
+ return pyobj_from_dict_t(servers);
+}
+
+PyDoc_STRVAR(emb_get_accounts__doc__,
+ "get_accounts() -> tuple with all nickserv account names");
+
+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);
+}
+
+PyDoc_STRVAR(emb_dump__doc__,
+ "dump(dump) -> an integer detailing success\n\n"
+ "Dumps a string to the server socket for propagation to other servers.\n\n"
+ "Return value is 1 on success and 0 on failure.\n");
+
+static PyObject*
+emb_dump(UNUSED_ARG(PyObject *self), PyObject *args)
{
/* Dump a raw string into the socket
- usage: svc.dump(<P10 string>)
+ usage: _svc.dump(<P10 string>)
*/
char *buf;
int ret = 0;
char linedup[MAXLEN];
+
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);
+}
+
+PyDoc_STRVAR(emb_send_target_privmsg__doc__,
+ "send_target_privmsg(servicenick, target, message) -> amount of message sent");
+
+static PyObject*
+emb_send_target_privmsg(UNUSED_ARG(PyObject *self), PyObject *args)
+{
+ /* Send a privmsg
+ usage: _svc.send_target_privmsg(<servicenick_from>, <nick_to>, <message>)
+ */
+ int ret = 0;
+ char *servicenick;
+ char *channel;
+ char *buf;
+
+ struct service *service;
+
+
+ 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))) {
+ PyErr_SetString(PyExc_Exception, "no such service nick");
+ return NULL;
+ }
+
+ ret = send_target_message(5, channel, service->bot, "%s", buf);
+ return Py_BuildValue("i", ret);
+}
+
+PyDoc_STRVAR(emb_send_target_notice__doc__,
+ "send_target_notice(servicenick, target, message) -> amount of message sent");
+
+static PyObject*
+emb_send_target_notice(UNUSED_ARG(PyObject *self), PyObject *args)
+{
+ /* send a notice
+ usage: _svc.send_target_notice(<servicenick_from>, <nick_to>, <message>)
+ */
+ int ret = 0;
+ char *servicenick;
+ char *target;
+ char *buf;
+
+ 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))) {
+ PyErr_SetString(PyExc_Exception, "no such service nick");
+ return NULL;
+ }
+
+ 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* 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];
+ if (PyTuple_SetItem(pChanList, n, Py_BuildValue("s", mn->channel->name)))
+ goto cleanup;
+ }
+
+ retval = 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);
+
+ if (retval == NULL)
+ goto cleanup;
+
+ return retval;
+
+cleanup:
+ Py_XDECREF(retval);
+ pyobj_release_tuple(pChanList, n);
+
+ return NULL;
+}
+
+PyDoc_STRVAR(emb_get_user__doc__,
+ "get_user(nick) -> dict with user information\n\n"
+ "Updating the returned dictionary will not be reflected in the user's\n"
+ "information.");
+
+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 const* nick;
+ struct userNode *user;
+
+ if(!PyArg_ParseTuple(args, "s", &nick))
+ return NULL;
+
+ if(!(user = GetUserH(nick))) {
+ PyErr_SetString(PyExc_Exception, "no such user");
+ return NULL;
+ }
+
+ 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;
+}
+
+PyDoc_STRVAR(emb_get_server__doc__,
+ "get_server(name) -> dict with information\n\n"
+ "Changes made to the returned dictionary will not reflect in the server's\n"
+ "information.");
+
+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*
+pyobj_from_channode(struct chanNode* channel) {
+ PyObject *pChannelMembers = NULL;
+ PyObject *pChannelBans = NULL;
+ PyObject *pChannelExempts = NULL;
+ PyObject *retval = NULL;
+
+ /* build tuple of nicks in channel */
+ pChannelMembers = pyobj_from_modelist(&channel->members);
+ if (pChannelMembers == NULL)
+ goto cleanup;
+
+ /* build tuple of bans */
+ pChannelBans = pyobj_from_banlist(&channel->banlist);
+ if (pChannelBans == NULL)
+ goto cleanup;
+
+ /* build tuple of exempts */
+ pChannelExempts = pyobj_from_exemptlist(&channel->exemptlist);
+ if (pChannelExempts == NULL)
+ goto cleanup;
+
+ retval = Py_BuildValue("{s:s,s:s,s:s,s:i"
+ ",s:i,s:i,s:O,s:O,s:O}",
+
+ "name", channel->name,
+ "topic", channel->topic,
+ "topic_nick", channel->topic_nick,
+ "topic_time", channel->topic_time,
+
+ "timestamp", channel->timestamp,
+ "modes", channel->modes,
+ "members", pChannelMembers,
+ "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;
+}
+
+PyDoc_STRVAR(emb_get_channel__doc__,
+ "get_channel(channel) -> dict with channel information\n\n"
+ "Updates made to the returned dictionary does not reflect in the channel\n"
+ "information.");
+
+static PyObject*
+emb_get_channel(UNUSED_ARG(PyObject *self), PyObject *args)
+{
+ /* Returns a python dict object with all sorts of info about a channel.
+ usage: _svc.get_channel(<name>)
+ */
+ char *name;
+ struct chanNode *channel;
+
+ if(!PyArg_ParseTuple(args, "s", &name))
+ return NULL;
+
+ if(!(channel = GetChannel(name))) {
+ PyErr_SetString(PyExc_Exception, "unknown channel");
+ return NULL;
+ }
+
+ return pyobj_from_channode(channel);
+}
+
+PyDoc_STRVAR(emb_get_account__doc__,
+ "get_account(account) -> dict with account information\n\n"
+ "Changes made to the returned dictionary will not be reflected in the\n"
+ "account's information.");
+
+static PyObject*
+emb_get_account(UNUSED_ARG(PyObject *self), PyObject *args)
+{
+ /* Returns a python dict object with all sorts of info about an account.
+ usage: _svc.get_account(<account name>)
+ */
+ char *name;
+ struct handle_info *hi;
+
+
+ if(!PyArg_ParseTuple(args, "s", &name))
+ 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}",
+
+ "account", hi->handle,
+ "registered", hi->registered,
+ "last_seen", hi->lastseen,
+ "infoline", hi->infoline ? hi->infoline : "",
+ "email", hi->email_addr ? hi->email_addr : "",
+
+ "fakehost", hi->fakehost ? hi->fakehost : "",
+ "last_quit_host", hi->last_quit_host
+
+ /* TODO: */
+ /* users online authed to this account */
+ /* cookies */
+ /* nicks (nickserv nets only?) */
+ /* masks */
+ /* ignores */
+ /* channels */
+ );
+}
+
+PyDoc_STRVAR(emb_get_info__doc__,
+ "get_info() -> dict with general service setup information\n\n"
+ "The dictionary contains the nicks of the different services.");
+
+static PyObject*
+emb_get_info(UNUSED_ARG(PyObject *self), UNUSED_ARG(PyObject *args))
+{
+ /* return some info about the general setup
+ * of X3, such as what the chanserv's nickname
+ * is.
+ */
+
+
+ return Py_BuildValue("{s:s,s:s,s:s,s:s,s:s}",
+ "chanserv", chanserv? chanserv->nick : "ChanServ",
+ "nickserv", nickserv?nickserv->nick : "NickServ",
+ "opserv", opserv?opserv->nick : "OpServ",
+ "global", global?global->nick : "Global",
+ "spamserv", spamserv?spamserv->nick : "SpamServ");
+}
+
+PyDoc_STRVAR(emb_log_module__doc__,
+ "log_module(level, message)\n\n"
+ "Logs a message in the PY_LOG subsystem given a severity level and a message.");
+
+static PyObject*
+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.
+ *
+ * for now, all logs go to the PY_LOG log. In the future this will change.
+ */
+ char *message;
+ int level;
+
+ if(!PyArg_ParseTuple(args, "is", &level, &message))
+ return NULL;
+
+ log_module(PY_LOG, level, "%s", message);
+
+ Py_INCREF(Py_None);
+ return Py_None;
+}
+
+PyDoc_STRVAR(emb_kill__doc__,
+ "kill(servicenick, target, message)\n\n"
+ "Kills a given user.");
+
+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);
+
+ Py_INCREF(Py_None);
+ 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);
+}
+
+PyDoc_STRVAR(emb_timeq_add__doc__,
+ "timeq_add(when, function, args)\n\n"
+ "Adds a callback to the service timer system.\n\n"
+ "The specific function must be callable, and the specified arguments must be\n"
+ "a tuple with the arguments that the function expects.");
+
+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);
+
+ Py_INCREF(Py_None);
+ return Py_None;
+}
+
+PyDoc_STRVAR(emb_timeq_del__doc__,
+ "timeq_del(when)\n\n"
+ "This function deletes all python-added callbacks registered to run at the\n"
+ "given time, regardless of their data. This is due to the unnecessary extra\n"
+ "burden it would require to get the same data for multiple runs.");
+
+static PyObject*
+emb_timeq_del(UNUSED_ARG(PyObject* self), PyObject* args) {
+ time_t when;
+
+ if (!PyArg_ParseTuple(args, "l", &when))
+ return NULL;
+
+ timeq_del(when, py_timeq_callback, NULL, TIMEQ_IGNORE_DATA);
+
+ Py_INCREF(Py_None);
+ 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:
+ Py_INCREF(Py_None);
+ value = Py_None;
+ }
+
+ if (value == NULL)
+ return 1;
+
+ if (PyDict_SetItemString(dict, key, value))
+ return 1;
+
+ return 0;
+}
+
+PyDoc_STRVAR(emb_get_config__doc__,
+ "get_config() -> dict with config elements and values\n\n"
+ "Updates to the returned dictionary will not reflect in the service's\n"
+ "configuration.");
+
+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;
+}
+
+PyDoc_STRVAR(emb_kick__doc__,
+ "kick(who, target, message)\n\n"
+ "Kicks a given target as if the who user kicked them using the given message.");
+
+static PyObject* emb_kick(UNUSED_ARG(PyObject* self), PyObject* args) {
+ struct userNode* who, *target;
+ struct chanNode* channel;
+ char const* msg;
+
+ char const* who_s, *target_s, *channel_s;
+
+ if (!PyArg_ParseTuple(args, "ssss", &who_s, &target_s, &channel_s, &msg))
+ return NULL;
+
+ if ((who = GetUserH(who_s)) == NULL) {
+ PyErr_SetString(PyExc_Exception, "no such user");
+ return NULL;
+ }
+
+ if ((target = GetUserH(target_s)) == NULL) {
+ PyErr_SetString(PyExc_Exception, "no such target");
+ return NULL;
+ }
+
+ if ((channel = GetChannel(channel_s)) == NULL) {
+ PyErr_SetString(PyExc_Exception, "no such channel");
+ return NULL;
+ }
+
+ irc_kick(who, target, channel, msg);
+
+ Py_INCREF(Py_None);
+ return Py_None;
+}
+
+PyDoc_STRVAR(emb_channel_mode__doc__,
+ "channel_mode(who, channel, modes)\n\n"
+ "Lets a current server's user set a specified channel's modes as specified.");
+
+static PyObject* emb_channel_mode(UNUSED_ARG(PyObject* self_), PyObject* args) {
+ struct userNode* who;
+ struct chanNode* channel;
+ char const* modes;
+
+ char const* who_s, *channel_s;
+
+ if (!PyArg_ParseTuple(args, "sss", &who_s, &channel_s, &modes))
+ return NULL;
+
+ if ((who = GetUserH(who_s)) == NULL) {
+ PyErr_SetString(PyExc_Exception, "unknown user");
+ return NULL;
+ }
+
+ if (who->uplink != self) {
+ PyErr_SetString(PyExc_Exception, "user not on current server");
+ return NULL;
+ }
+
+ if ((channel = GetChannel(channel_s)) == NULL) {
+ PyErr_SetString(PyExc_Exception, "unknown channel");
+ return NULL;
+ }
+
+ irc_mode(who, channel, modes);
+
+ Py_INCREF(Py_None);
+ return Py_None;
+}
+
+PyDoc_STRVAR(emb_user_mode__doc__,
+ "user_mode(target, modes)\n\n"
+ "Sets target's modes as specified. The modes are in normal +f-n syntax.");
+
+static PyObject* emb_user_mode(UNUSED_ARG(PyObject* self), PyObject* args) {
+ struct userNode* target;
+ char const* modes;
+
+ char const* target_s;
+
+ if (!PyArg_ParseTuple(args, "ss", &target_s, &modes))
+ return NULL;
+
+ if ((target = GetUserH(target_s)) == NULL) {
+ PyErr_SetString(PyExc_Exception, "unknown user");
+ return NULL;
+ }
+
+ irc_umode(target, modes);
+
+ Py_INCREF(Py_None);
+ return Py_None;
+}
+
+PyDoc_STRVAR(emb_fakehost__doc__,
+ "fakehost(target, host)\n\n"
+ "Sets the fakehost of a given user to the specified host.");
+
+static PyObject* emb_fakehost(UNUSED_ARG(PyObject* self), PyObject* args) {
+ struct userNode* target;
+ char const* host;
+
+ char const* target_s;
+
+ if (!PyArg_ParseTuple(args, "ss", &target_s, &host))
+ return NULL;
+
+ if ((target = GetUserH(target_s)) == NULL) {
+ PyErr_SetString(PyExc_Exception, "unknown user");
+ return NULL;
+ }
+
+ irc_fakehost(target, host);
+
+ Py_INCREF(Py_None);
+ return Py_None;
+}
+
+PyDoc_STRVAR(emb_svsnick__doc__,
+ "svsnick(from, target, newnick)\n\n"
+ "The from nick must be on the service server.");
+
+static PyObject*
+emb_svsnick(UNUSED_ARG(PyObject* self_), PyObject* args) {
+ struct userNode* from, *target;
+ const char* newnick;
+
+ const char* from_s, *target_s;
+
+ if (!PyArg_ParseTuple(args, "sss", &from_s, &target_s, &newnick))
+ return NULL;
+
+ if ((from = GetUserH(from_s)) == NULL) {
+ PyErr_SetString(PyExc_Exception, "unknown from user");
+ return NULL;
+ }
+
+ if ((target = GetUserH(target_s)) == NULL) {
+ PyErr_SetString(PyExc_Exception, "unknown target user");
+ return NULL;
}
- return Py_BuildValue("i", ret);
+
+ if (from->uplink != self) {
+ PyErr_SetString(PyExc_Exception, "from user is not on service server");
+ return NULL;
+ }
+
+ irc_svsnick(from, target, newnick);
+
+ Py_INCREF(Py_None);
+ return Py_None;
}
+PyDoc_STRVAR(emb_svsquit__doc__,
+ "svsquit(from, target, reason)\n\n"
+ "The from user must be on the service server.");
+
static PyObject*
-emb_send_target_privmsg(PyObject *self, PyObject *args)
-{
- /* Send a privmsg
- usage: svc.send_target_privmsg(<servicenick_from>, <nick_to>, <message>)
- */
- int ret = 0;
- char *servicenick;
- char *channel;
- char *buf;
+emb_svsquit(UNUSED_ARG(PyObject* self_), PyObject* args) {
+ struct userNode* from, *target;
+ char const* reason;
- struct service *service;
+ char const* from_s, *target_s;
- if(!PyArg_ParseTuple(args, "sss:reply", &servicenick, &channel, &buf ))
+ if (!PyArg_ParseTuple(args, "sss", &from_s, &target_s, &reason))
return NULL;
- if(!(service = service_find(servicenick))) {
- /* TODO: generate python exception here */
+
+ if ((from = GetUserH(from_s)) == NULL) {
+ PyErr_SetString(PyExc_Exception, "unknown from user");
return NULL;
}
- send_target_message(5, channel, service->bot, "%s", buf);
- return Py_BuildValue("i", ret);
+
+ if (from->uplink != self) {
+ PyErr_SetString(PyExc_Exception, "from user is not on service server");
+ return NULL;
+ }
+
+ if ((target = GetUserH(target_s)) == NULL) {
+ PyErr_SetString(PyExc_Exception, "unknown target user");
+ return NULL;
+ }
+
+ irc_svsquit(from, target, reason);
+
+ Py_INCREF(Py_None);
+ return Py_None;
}
+PyDoc_STRVAR(emb_svsjoin__doc__,
+ "svsjoin(from, target, to)\n\n"
+ "From user from must a user on the service server.\n"
+ "To must be an existing channel name.");
+
static PyObject*
-emb_send_target_notice(PyObject *self, PyObject *args)
-{
- /* send a notice
- usage: svc.send_target_notice(<servicenick_from>, <nick_to>, <message>)
- */
- int ret = 0;
- char *servicenick;
- char *target;
- char *buf;
+emb_svsjoin(UNUSED_ARG(PyObject* self_), PyObject* args) {
+ struct userNode* from, *target;
+ struct chanNode* to;
- struct service *service;
+ const char* from_s, *target_s, *to_s;
- if(!PyArg_ParseTuple(args, "sss:reply", &servicenick, &target, &buf ))
+ if (!PyArg_ParseTuple(args, "sss", &from_s, &target_s, &to_s))
return NULL;
- if(!(service = service_find(servicenick))) {
- /* TODO: generate python exception here */
+
+ if ((from = GetUserH(from_s)) == NULL) {
+ PyErr_SetString(PyExc_Exception, "unknown from user");
return NULL;
}
- send_target_message(4, target, service->bot, "%s", buf);
- return Py_BuildValue("i", ret);
-}
-static PyObject*
-emb_get_user(PyObject *self, PyObject *args)
-{
- /* Get a python object containing everything x3 knows about a user, by nick.
- usage: svc.get_user(<nick>)
- */
- char *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 */
+ if (from->uplink != self) {
+ PyErr_SetString(PyExc_Exception, "from user is not on service server");
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));
+
+ if ((target = GetUserH(target_s)) == NULL) {
+ PyErr_SetString(PyExc_Exception, "unknown target user");
+ return NULL;
}
- 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),
+ if ((to = GetChannel(to_s)) == NULL)
+ to = AddChannel(to_s, now, NULL, NULL, NULL);
- "fakehost", user->fakehost,
- "sethost", user->sethost,
- "crypthost", user->crypthost,
- "cryptip", user->cryptip,
- "numeric", user->numeric, /* TODO: only ifdef WITH_PROTOCOL_P10 */
+ irc_svsjoin(from, target, to);
- "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);
+ Py_INCREF(Py_None);
+ return Py_None;
}
+PyDoc_STRVAR(emb_adduser__doc__,
+ "adduser(nick, ident, hostname, description, modes) -> dict with user information\n\n"
+ "Adds a new local user with the given information.");
+
static PyObject*
-emb_get_channel(PyObject *self, PyObject *args)
-{
- /* Returns a python dict object with all sorts of info about a channel.
- usage: svc.get_channel(<name>)
- */
- char *name;
- struct chanNode *channel;
- unsigned int n;
- PyObject *pChannelMembers;
- PyObject *pChannelBans;
- PyObject *pChannelExempts;
+emb_adduser(UNUSED_ARG(PyObject* self_), PyObject* args) {
+ char const* nick, *ident, *hostname, *desc, *modes;
+ struct userNode* user;
+ PyObject* retval;
- if(!PyArg_ParseTuple(args, "s", &name))
+ if (!PyArg_ParseTuple(args, "sssss", &nick, &ident, &hostname, &desc, &modes))
return NULL;
- if(!(channel = GetChannel(name))) {
- /* TODO: generate py exception here */
+
+ user = AddLocalUser(nick, ident, hostname, desc, modes);
+
+ retval = pyobj_from_usernode(user);
+
+ return retval;
+}
+
+/* TODO: Add the rest of the service members to the dict */
+static PyObject*
+pyobj_from_service(struct service* serv) {
+ PyObject* bot, *retval;
+
+ bot = pyobj_from_usernode(serv->bot);
+ if (bot == NULL)
+ goto cleanup;
+
+ retval = Py_BuildValue("{s:O,s:c,s:I}",
+ "bot", bot,
+ "trigger", serv->trigger,
+ "privileged", serv->privileged);
+ if (retval == NULL)
+ goto cleanup;
+
+ return retval;
+
+cleanup:
+ Py_XDECREF(bot);
+ return NULL;
+}
+
+PyDoc_STRVAR(emb_service_register__doc__,
+ "service_register(nick)\n\n"
+ "Registers nick as a service. The specified nick must be on the local server.");
+
+static PyObject*
+emb_service_register(UNUSED_ARG(PyObject* self_), PyObject* args) {
+ struct userNode* user;
+ char const* user_s;
+
+ if (!PyArg_ParseTuple(args, "s", &user_s))
return NULL;
- }
- /* 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));
+ if ((user = GetUserH(user_s)) == NULL) {
+ PyErr_SetString(PyExc_Exception, "unknown user");
+ return NULL;
}
- /* 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)
- );
+ if (user->uplink != self) {
+ PyErr_SetString(PyExc_Exception, "user is not on service server");
+ return NULL;
}
- /* 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)
- );
- }
-
- return Py_BuildValue("{s:s,s:s,s:s,s:i"
- ",s:i,s:i,s:O,s:O,s:O}",
+ return pyobj_from_service(service_register(user));
+}
- "name", channel->name,
- "topic", channel->topic,
- "topic_nick", channel->topic_nick,
- "topic_time", channel->topic_time,
+size_t logs_size = 0;
+static struct log_type **logs_list = NULL;
- "timestamp", channel->timestamp,
- "modes", channel->modes,
- "members", pChannelMembers,
- "bans", pChannelBans,
- "exempts", pChannelExempts
- );
-}
+PyDoc_STRVAR(emb_log_register_type__doc__,
+ "registers a log source to write event data to.");
+static PyObject* emb_log_register_type(UNUSED_ARG(PyObject *self), PyObject* args) {
+ const char* logName;
+ const char* defaultLog;
+ struct log_type* log;
+ struct log_type** newlogs;
-static PyObject*
-emb_get_account(PyObject *self, PyObject *args)
-{
- /* Returns a python dict object with all sorts of info about an account.
- usage: svc.get_account(<account name>)
- */
- char *name;
- struct handle_info *hi;
+ if (!PyArg_ParseTuple(args, "ss", &logName, &defaultLog))
+ return NULL;
- if(!PyArg_ParseTuple(args, "s", &name))
+ newlogs = realloc(logs_list, (logs_size+1)*sizeof(struct log_type*));
+ if (newlogs == NULL) {
+ PyErr_SetString(PyExc_Exception, "unable to allocate memory for log structures. aborting.");
return NULL;
+ }
+ logs_list = newlogs;
- hi = get_handle_info(name);
- if(!hi) {
+ log = log_register_type(logName, defaultLog);
+ if (log == NULL) {
+ PyErr_SetString(PyExc_Exception, "unable to register log");
return NULL;
}
- return Py_BuildValue("{s:s,s:i,s:s,s:s,s:s"
- ",s:s,s:s}",
-
- "account", hi->handle,
- "registered", hi->registered,
- "last_seen", hi->lastseen,
- "infoline", hi->infoline ? hi->infoline : "",
- "email", hi->email_addr ? hi->email_addr : "",
-
- "fakehost", hi->fakehost ? hi->fakehost : "",
- "last_quit_host", hi->last_quit_host
-
- /* TODO: */
- /* users online authed to this account */
- /* cookies */
- /* nicks (nickserv nets only?) */
- /* masks */
- /* ignores */
- /* channels */
- );
+
+ logs_list[logs_size++] = log;
+
+ return Py_BuildValue("O", PyCObject_FromVoidPtr(log, NULL));
}
-static PyObject*
-emb_log_module(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.
- */
- char *message;
- int ret = 0;
- int level;
+PyDoc_STRVAR(emb_module_register__doc__, "registers a module");
+PyObject* emb_module_register(UNUSED_ARG(PyObject* self), PyObject* args) {
+ PyObject* pylog;
+ char const *name, *helpfile;
+ struct log_type* log;
+ struct module* mod;
- if(!PyArg_ParseTuple(args, "is", &level, &message))
+ if (!PyArg_ParseTuple(args, "sOs", &name, &pylog, &helpfile))
return NULL;
- log_module(PY_LOG, level, "%s", message);
+ log = PyCObject_AsVoidPtr(pylog);
- return Py_BuildValue("i", ret);
+ mod = module_register(name, log, helpfile, NULL);
+
+ if (mod == NULL) {
+ PyErr_SetString(PyExc_Exception, "unable to register module");
+ return NULL;
+ }
+
+ return Py_BuildValue("O", PyCObject_FromVoidPtr(mod, NULL));
}
static PyMethodDef EmbMethods[] = {
/* Communication methods */
- {"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"},
+ {"dump", emb_dump, METH_VARARGS, emb_dump__doc__},
+ {"send_target_privmsg", emb_send_target_privmsg, METH_VARARGS, emb_send_target_privmsg__doc__},
+ {"send_target_notice", emb_send_target_notice, METH_VARARGS, emb_send_target_notice__doc__},
+ {"log_module", emb_log_module, METH_VARARGS, emb_log_module__doc__},
+//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
+ {"kill", emb_kill, METH_VARARGS, emb_kill__doc__},
+ {"fakehost", emb_fakehost, METH_VARARGS, emb_fakehost__doc__},
+ {"svsnick", emb_svsnick, METH_VARARGS, emb_svsnick__doc__},
+ {"svsquit", emb_svsquit, METH_VARARGS, emb_svsquit__doc__},
+ {"svsjoin", emb_svsjoin, METH_VARARGS, emb_svsjoin__doc__},
+ {"adduser", emb_adduser, METH_VARARGS, emb_adduser__doc__},
+ {"service_register", emb_service_register, METH_VARARGS, emb_service_register__doc__},
+//TODO: svsmode, svsident, nick, quit, join, part, ident, vhost
+//TODO: {"shun"
+//TODO: {"unshun"
+//TODO: {"gline", emb_gline, METH_VARARGS, "gline a mask"},
+//TODO: {"ungline", emb_ungline, METH_VARARGS, "remove a gline"},
+ {"kick", emb_kick, METH_VARARGS, emb_kick__doc__},
+ {"channel_mode", emb_channel_mode, METH_VARARGS, emb_channel_mode__doc__},
+ {"user_mode", emb_user_mode, METH_VARARGS, emb_user_mode__doc__},
+//
+ {"get_config", emb_get_config, METH_VARARGS, emb_get_config__doc__},
+//TODO: {"config_set", emb_config_set, METH_VARARGS, "change a config setting 'on-the-fly'."},
+//
+ {"timeq_add", emb_timeq_add, METH_VARARGS, emb_timeq_add__doc__},
+ {"timeq_del", emb_timeq_del, METH_VARARGS, emb_timeq_del__doc__},
+
+ /* module registration methods */
+ {"log_register_type", emb_log_register_type, METH_VARARGS,
+ emb_log_register_type__doc__},
+ {"module_register", emb_module_register, METH_VARARGS,
+ emb_module_register__doc__},
+
/* Information gathering methods */
- {"get_user", emb_get_user, METH_VARARGS, "Get details about a nickname"},
- {"get_channel", emb_get_channel, METH_VARARGS, "Get details about a channel"},
- {"get_account", emb_get_account, METH_VARARGS, "Get details about an account"},
+ {"get_user", emb_get_user, METH_VARARGS, emb_get_user__doc__},
+ {"get_users", emb_get_users, METH_VARARGS, emb_get_users__doc__},
+ {"get_channel", emb_get_channel, METH_VARARGS, emb_get_channel__doc__},
+ {"get_channels", emb_get_channels, METH_VARARGS, emb_get_channels__doc__},
+ {"get_server", emb_get_server, METH_VARARGS, emb_get_server__doc__},
+ {"get_servers", emb_get_servers, METH_VARARGS, emb_get_servers__doc__},
+ {"get_account", emb_get_account, METH_VARARGS, emb_get_account__doc__},
+ {"get_accounts", emb_get_accounts, METH_VARARGS, emb_get_accounts__doc__},
+ {"get_info", emb_get_info, METH_VARARGS, emb_get_info__doc__},
/* 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() {
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
it first? We will start by doing it every time.
*/
static int
-python_handle_join(struct modeNode *mNode)
+python_handle_join(struct modeNode *mNode, UNUSED_ARG(void *extra))
{
/* callback for handle_join events.
*/
}
}
+static int
+python_handle_server_link(struct server *server, UNUSED_ARG(void *extra))
+{
+ PyObject* srv = NULL;
+ PyObject* funcname = NULL;
+ PyObject* retval = NULL;
+ char const* err = NULL;
+ int i = 0;
+
+ if (handler_object == NULL) {
+ err = "No Python handler is allocated. Ignoring python_handle_server_link.";
+ goto cleanup;
+ }
+
+ if (server == NULL) {
+ err = "Python code got server link without server!";
+ goto cleanup;
+ }
+
+ if ((srv = pyobj_from_server(server)) == NULL) {
+ err = "Python code unable to get PyObject with server!";
+ goto cleanup;
+ }
+
+ funcname = PyString_FromString("server_link");
+ if (funcname == NULL) {
+ err = "Unable to allocate memory";
+ goto cleanup;
+ }
+
+ retval = PyObject_CallMethodObjArgs(handler_object, funcname, srv, NULL);
+ if (retval == NULL) {
+ err = "Error calling server_link handler";
+ goto cleanup;
+ }
+
+cleanup:
+ Py_XDECREF(srv);
+ Py_XDECREF(funcname);
+
+ if (retval != NULL && PyInt_Check(retval))
+ i = (int)PyInt_AsLong(retval);
+
+ Py_XDECREF(retval);
+
+ if (err != NULL)
+ log_module(PY_LOG, LOG_WARNING, "%s", err);
+
+ return i;
+}
+
+static int
+python_handle_new_user(struct userNode *user, UNUSED_ARG(void *extra))
+{
+ PyObject* name = NULL;
+ PyObject* usr = NULL;
+ PyObject* retval = NULL;
+ int i = 0;
+ const char* err = NULL;
+
+ if (handler_object == NULL) {
+ err = "No Python handler is allocated. Ignoring python_handle_server_link.";
+ goto cleanup;
+ }
+
+ if(!user) {
+ log_module(PY_LOG, LOG_WARNING, "Python code got new_user without the user");
+ return 0;
+ }
+
+ if ((usr = pyobj_from_usernode(user)) == NULL) {
+ err = "unable to allocate python user information";
+ goto cleanup;
+ }
+
+ name = PyString_FromString("new_user");
+ if (name == NULL) {
+ err = "unable to allocate memory for handler function name";
+ goto cleanup;
+ }
+
+ if ((retval = PyObject_CallMethodObjArgs(handler_object, name, usr, NULL)) == NULL) {
+ err = "error calling new_user handler";
+ goto cleanup;
+ }
+
+cleanup:
+ Py_XDECREF(usr);
+ Py_XDECREF(name);
+
+ if (retval != NULL && PyInt_Check(retval))
+ i = (int)PyInt_AsLong(retval);
+
+ Py_XDECREF(retval);
+
+ if (err != NULL)
+ log_module(PY_LOG, LOG_WARNING, "%s", err);
+
+ return i;
+}
+
+static void
+python_handle_nick_change(struct userNode *user, const char *old_nick, UNUSED_ARG(void *extra))
+{
+ PyObject* usr = NULL;
+ PyObject* name = NULL;
+ PyObject* oldnick = NULL;
+ PyObject* retval = NULL;
+ char const* err = NULL;
+
+ if (handler_object == NULL) {
+ err = "No Python handler is allocated. Ignoring python_handle_server_link.";
+ goto cleanup;
+ }
+
+ if (user == NULL) {
+ err = "Python code got nick_change without the user!";
+ goto cleanup;
+ }
+
+ if ((usr = pyobj_from_usernode(user)) == NULL) {
+ err = "unable to allocate Python usernode";
+ goto cleanup;
+ }
+
+ name = PyString_FromString("nick_change");
+ if (name == NULL) {
+ err = "unable to allocate memory for handler function name";
+ goto cleanup;
+ }
+
+ oldnick = PyString_FromString(old_nick);
+
+ retval = PyObject_CallMethodObjArgs(handler_object, name, usr, oldnick, NULL);
+ if (retval == NULL) {
+ err = "error calling nick_change handler";
+ goto cleanup;
+ }
+
+cleanup:
+ Py_XDECREF(usr);
+ Py_XDECREF(name);
+ Py_XDECREF(oldnick);
+ Py_XDECREF(retval);
+
+ if (err != NULL)
+ log_module(PY_LOG, LOG_WARNING, "%s", err);
+}
+
+void python_handle_del_user(struct userNode *user, struct userNode *killer, const char *why, UNUSED_ARG(void *extra)) {
+ PyObject *usr = NULL, *killr = NULL, *name = NULL;
+ PyObject *reason = NULL, *retval = NULL;
+ char const* err = NULL;
+
+ if (handler_object == NULL) {
+ err = "No Python handler is allocated. Ignoring python_handle_server_link.";
+ goto cleanup;
+ }
+
+ if (user == NULL) {
+ Py_INCREF(Py_None);
+ usr = Py_None;
+ } else {
+ usr = pyobj_from_usernode(user);
+ if (usr == NULL) {
+ err = "unable to allocate usernode for user";
+ goto cleanup;
+ }
+ }
+
+ if (killer == NULL) {
+ Py_INCREF(Py_None);
+ killr = Py_None;
+ } else {
+ killr = pyobj_from_usernode(killer);
+ if (killr == NULL) {
+ err = "unable to allocate usernode for killer";
+ goto cleanup;
+ }
+ }
+
+ if (why == NULL) {
+ Py_INCREF(Py_None);
+ reason = Py_None;
+ } else {
+ reason = PyString_FromString(why);
+ if (reason == NULL) {
+ err = "unable to allocate memory for reason";
+ goto cleanup;
+ }
+ }
+
+ name = PyString_FromString("del_user");
+ if (name == NULL) {
+ err = "unable to allocate memory for handler function name";
+ goto cleanup;
+ }
+
+ retval = PyObject_CallMethodObjArgs(handler_object, name, usr, killr, reason, NULL);
+ if (retval == NULL) {
+ err = "error calling del_user handler";
+ goto cleanup;
+ }
+
+cleanup:
+ Py_XDECREF(usr);
+ Py_XDECREF(killr);
+ Py_XDECREF(name);
+ Py_XDECREF(reason);
+ Py_XDECREF(retval);
+
+ if (err != NULL)
+ log_module(PY_LOG, LOG_WARNING, "%s", err);
+}
+
+int python_handle_topic(struct userNode *who, struct chanNode *chan, const char *old_topic, UNUSED_ARG(void *extra)) {
+ PyObject* pwho = NULL, *pchan = NULL, *oldtopic = NULL;
+ PyObject* name = NULL, *retval = NULL;
+ const char* err = NULL;
+ int i = 0;
+
+ if (who == NULL) {
+ Py_INCREF(Py_None);
+ pwho = Py_None;
+ } else {
+ if ((pwho = pyobj_from_usernode(who)) == NULL) {
+ err = "unable to allocate usernode";
+ goto cleanup;
+ }
+ }
+
+ if ((pchan = pyobj_from_channode(chan)) == NULL) {
+ err = "unable to allocate channode";
+ goto cleanup;
+ }
+
+ if (old_topic == NULL) {
+ Py_INCREF(Py_None);
+ oldtopic = Py_None;
+ } else {
+ oldtopic = PyString_FromString(old_topic);
+ if (oldtopic == NULL) {
+ err = "unable to allocate memory for old topic string";
+ goto cleanup;
+ }
+ }
+
+ name = PyString_FromString("topic");
+ if (name == NULL) {
+ err = "unable to allocate memory for topic handler function name";
+ goto cleanup;
+ }
+
+ retval = PyObject_CallMethodObjArgs(handler_object, name, pwho, pchan, oldtopic, NULL);
+ if (retval == NULL) {
+ err = "error calling topic handler";
+ goto cleanup;
+ }
+
+cleanup:
+ Py_XDECREF(pwho);
+ Py_XDECREF(pchan);
+ Py_XDECREF(oldtopic);
+ Py_XDECREF(name);
+
+ if (retval != NULL && PyInt_Check(retval))
+ i = (int)PyInt_AsLong(retval);
+
+ Py_XDECREF(retval);
+
+ if (err != NULL)
+ log_module(PY_LOG, LOG_WARNING, "%s", err);
+
+ return i;
+}
/* ----------------------------------------------------------------------------- */
This is called during x3 startup, and on a python reload
*/
PyObject *pName;
+ char* buffer;
+ char* env = getenv("PYTHONPATH");
+
+ if (env)
+ env = strdup(env);
+
+ if (!env)
+ setenv("PYTHONPATH", modpython_conf.scripts_dir, 1);
+ else if (!strstr(env, modpython_conf.scripts_dir)) {
+ buffer = (char*)malloc(strlen(env) + strlen(modpython_conf.scripts_dir) + 2);
+ sprintf(buffer, "%s:%s", modpython_conf.scripts_dir, env);
+ setenv("PYTHONPATH", buffer, 1);
+ free(buffer);
+ free(env);
+ }
- setenv("PYTHONPATH", "/home/rubin/afternet/services/x3/x3-run/", 1);
+ log_module(PY_LOG, LOG_DEBUG, "Starting Python Init from python_load");
Py_Initialize();
- Py_InitModule("svc", EmbMethods);
- /* TODO: get "modpython" from x3.conf */
- pName = PyString_FromString("modpython");
+ Py_InitModule("_svc", EmbMethods);
+ 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) {
else {
/* error handler class not found */
log_module(PY_LOG, LOG_WARNING, "Failed to create handler object");
+ exit(1);
return 0;
}
}
//PyErr_Print();
python_log_module();
log_module(PY_LOG, LOG_WARNING, "Failed to load modpython.py");
+ exit(1);
return 0;
}
return 0;
}
static void
-python_cleanup(void) {
+python_cleanup(UNUSED_ARG(void *extra)) {
/* Called on shutdown of the python module (or before reloading)
*/
+
log_module(PY_LOG, LOG_INFO, "python module cleanup");
- Py_Finalize(); /* Shut down python enterpriter */
- return;
+
+ Py_XDECREF(handler_object);
+ handler_object = NULL;
+
+ if (PyErr_Occurred())
+ PyErr_Clear();
+ Py_Finalize(); /* Shut down python enterpreter */
+
+ log_module(PY_LOG, LOG_INFO, "python module cleanup done");
}
/* ---------------------------------------------------------------------------------- *
/* reload the python system completely
*/
log_module(PY_LOG, LOG_INFO, "Shutting python down");
- python_cleanup();
+ python_cleanup(NULL);
log_module(PY_LOG, LOG_INFO, "Loading python stuff");
if(python_load()) {
reply("PYMSG_RELOAD_SUCCESS");
}
static MODCMD_FUNC(cmd_run) {
- /* run an arbitrary python command. This can include shell commands, so should be disabled on
- production, and needs to be handled extremely cautiously as far as access control
- */
- char *msg;
+ /* this method allows running arbitrary python commands.
+ * use with care.
+ */
+ char* msg;
+ PyObject* py_main_module;
+ PyObject* py_globals;
+ PyObject* py_locals;
+ PyObject* py_retval;
+ PyObject* extype, *exvalue, *extraceback;
+ PyObject* exvaluestr = NULL;
+ char* exmsg = NULL, *exmsgptr;
+
+ py_main_module = PyImport_AddModule("__main__");
+ py_globals = py_locals = PyModule_GetDict(py_main_module);
+
msg = unsplit_string(argv + 1, argc - 1, NULL);
- char *args[] = {msg};
- python_call_handler("cmd_run", args, 1, cmd->parent->bot->nick, user?user->nick:"", channel?channel->name:"");
+
+ py_retval = PyRun_String(msg, Py_file_input, py_globals, py_locals);
+ if (py_retval == NULL) {
+ PyErr_Fetch(&extype, &exvalue, &extraceback);
+ if (exvalue != NULL) {
+ exvaluestr = PyObject_Str(exvalue);
+ exmsg = strdup(PyString_AS_STRING(exvaluestr));
+ exmsgptr = exmsg;
+ while (exmsgptr && *exmsgptr) {
+ if (*exmsgptr == '\n' || *exmsgptr == '\r' || *exmsgptr == '\t')
+ *exmsgptr = ' ';
+ exmsgptr++;
+ }
+ }
+ if (extype != NULL && exvalue != NULL && PyType_Check(extype)) {
+ reply("PYMSG_RUN_EXCEPTION", ((PyTypeObject*)extype)->tp_name, exmsg);
+ } else
+ reply("PYMSG_RUN_UNKNOWN_EXCEPTION");
+
+ if (extype != NULL)
+ Py_DECREF(extype);
+ if (exvalue != NULL)
+ Py_DECREF(exvalue);
+ if (extraceback != NULL)
+ Py_DECREF(extraceback);
+ if (exvaluestr != NULL)
+ Py_DECREF(exvaluestr);
+ if (exmsg)
+ free(exmsg);
+ } else {
+ Py_DECREF(py_retval);
+ }
+
return 1;
}
else {
msg = "";
}
- char *args[] = {plugin, command, msg};
+ char *args[] = {strdup(plugin), strdup(command), strdup(msg)};
python_call_handler("cmd_command", args, numstrargs(args), cmd->parent->bot->nick, user?user->nick:"", channel?channel->name:"");
+ free(args[0]);
+ free(args[1]);
+ free(args[2]);
return 1;
}
+static void modpython_conf_read(void) {
+ dict_t conf_node;
+ char const* str;
+
+ if (!(conf_node = conf_get_data(MODPYTHON_CONF_NAME, RECDB_OBJECT))) {
+ log_module(PY_LOG, LOG_ERROR, "config node '%s' is missing or has wrong type", MODPYTHON_CONF_NAME);
+ return;
+ }
+
+ str = database_get_data(conf_node, "scripts_dir", RECDB_QSTRING);
+ modpython_conf.scripts_dir = strdup(str ? str : "./");
+
+ str = database_get_data(conf_node, "main_module", RECDB_QSTRING);
+ modpython_conf.main_module = strdup(str ? str : "modpython");
+}
+
int python_init(void) {
/* X3 calls this function on init of the module during startup. We use it to
do all our setup tasks and bindings
PY_LOG = log_register_type("Python", "file:python.log");
python_module = module_register("python", PY_LOG, "mod-python.help", NULL);
+ conf_register_reload(modpython_conf_read);
+
log_module(PY_LOG, LOG_INFO, "python module init");
message_register_table(msgtab);
*/
modcmd_register(python_module, "reload", cmd_reload, 1, MODCMD_REQUIRE_AUTHED, "flags", "+oper", NULL);
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);
- reg_join_func(python_handle_join);
- reg_exit_func(python_cleanup);
+ modcmd_register(python_module, "command", cmd_command, 3, MODCMD_REQUIRE_AUTHED, "flags", "+oper", NULL);
+
+// 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, NULL);
+ reg_new_user_func(python_handle_new_user, NULL);
+ reg_nick_change_func(python_handle_nick_change, NULL);
+ reg_del_user_func(python_handle_del_user, NULL);
+//TODO: reg_account_func(python_handle_account); /* stamping of account name to the ircd */
+//TODO: reg_handle_rename_func(python_handle_handle_rename); /* handle used to ALSO mean account name */
+//TODO: reg_failpw_func(python_handle_failpw);
+//TODO: reg_allowauth_func(python_handle_allowauth);
+//TODO: reg_handle_merge_func(python_handle_merge);
+//
+//TODO: reg_oper_func(python_handle_oper);
+//TODO: reg_new_channel_func(python_handle_new_channel);
+ reg_join_func(python_handle_join, NULL);
+//TODO: reg_del_channel_func(python_handle_del_channel);
+//TODO: reg_part_func(python_handle_part);
+//TODO: reg_kick_func(python_handle_kick);
+ reg_topic_func(python_handle_topic, NULL);
+//TODO: reg_channel_mode_func(python_handle_channel_mode);
+
+//TODO: reg_privmsg_func(python_handle_privmsg);
+//TODO: reg_notice_func
+//TODO: reg_svccmd_unbind_func(python_handle_svccmd_unbind);
+//TODO: reg_chanmsg_func(python_handle_chanmsg);
+//TODO: reg_allchanmsg_func
+//TODO: reg_user_mode_func
+
+ reg_exit_func(python_cleanup, NULL);
python_load();
return 1;