source4/lib/messaging/pymessaging.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Copyright © Jelmer Vernooij <jelmer@samba.org> 2008
   4
   5    Based on the equivalent for EJS:
   6    Copyright © Andrew Tridgell <tridge@samba.org> 2005
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20 */
  21
  22 #include <Python.h>
  23 #include "includes.h"
  24 #include "scripting/python/modules.h"
  25 #include "libcli/util/pyerrors.h"
  26 #include "librpc/rpc/pyrpc_util.h"
  27 #include "librpc/ndr/libndr.h"
  28 #include "lib/messaging/messaging.h"
  29 #include "lib/messaging/irpc.h"
  30 #include "lib/events/events.h"
  31 #include "cluster/cluster.h"
  32 #include "param/param.h"
  33 #include "param/pyparam.h"
  34 #include "librpc/rpc/dcerpc.h"
  35 #include "librpc/gen_ndr/server_id.h"
  36 #include <pytalloc.h>
  37
  38 void initmessaging(void);
  39
  40 extern PyTypeObject imessaging_Type;
  41
  42 static bool server_id_from_py(PyObject *object, struct server_id *server_id)
  43 {
  44         if (!PyTuple_Check(object)) {
  45                 if (!py_check_dcerpc_type(object, "server_id", "server_id")) {
  46
  47                         PyErr_SetString(PyExc_ValueError, "Expected tuple or server_id");
  48                         return false;
  49                 }
  50                 *server_id = *pytalloc_get_type(object, struct server_id);
  51                 return true;
  52         }
  53         if (PyTuple_Size(object) == 3) {
  54                 return PyArg_ParseTuple(object, "KII", &server_id->pid, &server_id->task_id, &server_id->vnn);
  55         } else {
  56                 int pid, task_id;
  57                 if (!PyArg_ParseTuple(object, "KI", &pid, &task_id))
  58                         return false;
  59                 *server_id = cluster_id(pid, task_id);
  60                 return true;
  61         }
  62 }
  63
  64 typedef struct {
  65         PyObject_HEAD
  66         TALLOC_CTX *mem_ctx;
  67         struct imessaging_context *msg_ctx;
  68 } imessaging_Object;
  69
  70 static PyObject *py_imessaging_connect(PyTypeObject *self, PyObject *args, PyObject *kwargs)
  71 {
  72         struct tevent_context *ev;
  73         const char *kwnames[] = { "own_id", "lp_ctx", NULL };
  74         PyObject *own_id = Py_None;
  75         PyObject *py_lp_ctx = Py_None;
  76         imessaging_Object *ret;
  77         struct loadparm_context *lp_ctx;
  78
  79         if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|OO:connect",
  80                 discard_const_p(char *, kwnames), &own_id, &py_lp_ctx)) {
  81                 return NULL;
  82         }
  83
  84         ret = PyObject_New(imessaging_Object, &imessaging_Type);
  85         if (ret == NULL)
  86                 return NULL;
  87
  88         ret->mem_ctx = talloc_new(NULL);
  89
  90         lp_ctx = lpcfg_from_py_object(ret->mem_ctx, py_lp_ctx);
  91         if (lp_ctx == NULL) {
  92                 PyErr_SetString(PyExc_RuntimeError, "imessaging_connect unable to interpret loadparm_context");
  93                 talloc_free(ret->mem_ctx);
  94                 return NULL;
  95         }
  96
  97         ev = s4_event_context_init(ret->mem_ctx);
  98
  99         if (own_id != Py_None) {
 100                 struct server_id server_id;
 101
 102                 if (!server_id_from_py(own_id, &server_id))
 103                         return NULL;
 104
 105                 ret->msg_ctx = imessaging_init(ret->mem_ctx,
 106                                                lp_ctx,
 107                                                server_id,
 108                                                ev, true);
 109         } else {
 110                 ret->msg_ctx = imessaging_client_init(ret->mem_ctx,
 111                                                       lp_ctx,
 112                                                       ev);
 113         }
 114
 115         if (ret->msg_ctx == NULL) {
 116                 PyErr_SetString(PyExc_RuntimeError, "imessaging_connect unable to create a messaging context");
 117                 talloc_free(ret->mem_ctx);
 118                 return NULL;
 119         }
 120
 121         return (PyObject *)ret;
 122 }
 123
 124 static void py_imessaging_dealloc(PyObject *self)
 125 {
 126         imessaging_Object *iface = (imessaging_Object *)self;
 127         talloc_free(iface->msg_ctx);
 128         self->ob_type->tp_free(self);
 129 }
 130
 131 static PyObject *py_imessaging_send(PyObject *self, PyObject *args, PyObject *kwargs)
 132 {
 133         imessaging_Object *iface = (imessaging_Object *)self;
 134         uint32_t msg_type;
 135         DATA_BLOB data;
 136         PyObject *target;
 137         NTSTATUS status;
 138         struct server_id server;
 139         const char *kwnames[] = { "target", "msg_type", "data", NULL };
 140         int length;
 141
 142         if (!PyArg_ParseTupleAndKeywords(args, kwargs, "Ois#:send",
 143                 discard_const_p(char *, kwnames), &target, &msg_type, &data.data, &length)) {
 144
 145                 return NULL;
 146         }
 147
 148         data.length = length;
 149
 150         if (!server_id_from_py(target, &server))
 151                 return NULL;
 152
 153         status = imessaging_send(iface->msg_ctx, server, msg_type, &data);
 154         if (NT_STATUS_IS_ERR(status)) {
 155                 PyErr_SetNTSTATUS(status);
 156                 return NULL;
 157         }
 158
 159         Py_RETURN_NONE;
 160 }
 161
 162 static void py_msg_callback_wrapper(struct imessaging_context *msg, void *private_data,
 163                                uint32_t msg_type,
 164                                struct server_id server_id, DATA_BLOB *data)
 165 {
 166         PyObject *callback = (PyObject *)private_data;
 167
 168         PyObject_CallFunction(callback, discard_const_p(char, "i(KII)s#"), msg_type,
 169                               server_id.pid, server_id.task_id, server_id.vnn,
 170                               data->data, data->length);
 171 }
 172
 173 static PyObject *py_imessaging_register(PyObject *self, PyObject *args, PyObject *kwargs)
 174 {
 175         imessaging_Object *iface = (imessaging_Object *)self;
 176         int msg_type = -1;
 177         PyObject *callback;
 178         NTSTATUS status;
 179         const char *kwnames[] = { "callback", "msg_type", NULL };
 180
 181         if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O|i:register",
 182                 discard_const_p(char *, kwnames), &callback, &msg_type)) {
 183                 return NULL;
 184         }
 185
 186         Py_INCREF(callback);
 187
 188         if (msg_type == -1) {
 189                 uint32_t msg_type32 = msg_type;
 190                 status = imessaging_register_tmp(iface->msg_ctx, callback,
 191                                                 py_msg_callback_wrapper, &msg_type32);
 192                 msg_type = msg_type32;
 193         } else {
 194                 status = imessaging_register(iface->msg_ctx, callback,
 195                                     msg_type, py_msg_callback_wrapper);
 196         }
 197         if (NT_STATUS_IS_ERR(status)) {
 198                 PyErr_SetNTSTATUS(status);
 199                 return NULL;
 200         }
 201
 202         return PyLong_FromLong(msg_type);
 203 }
 204
 205 static PyObject *py_imessaging_deregister(PyObject *self, PyObject *args, PyObject *kwargs)
 206 {
 207         imessaging_Object *iface = (imessaging_Object *)self;
 208         int msg_type = -1;
 209         PyObject *callback;
 210         const char *kwnames[] = { "callback", "msg_type", NULL };
 211
 212         if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O|i:deregister",
 213                 discard_const_p(char *, kwnames), &callback, &msg_type)) {
 214                 return NULL;
 215         }
 216
 217         imessaging_deregister(iface->msg_ctx, msg_type, callback);
 218
 219         Py_DECREF(callback);
 220
 221         Py_RETURN_NONE;
 222 }
 223
 224 static PyObject *py_irpc_servers_byname(PyObject *self, PyObject *args, PyObject *kwargs)
 225 {
 226         imessaging_Object *iface = (imessaging_Object *)self;
 227         char *server_name;
 228         struct server_id *ids;
 229         PyObject *pylist;
 230         int i;
 231         TALLOC_CTX *mem_ctx = talloc_new(NULL);
 232         if (!mem_ctx) {
 233                 PyErr_NoMemory();
 234                 return NULL;
 235         }
 236
 237         if (!PyArg_ParseTuple(args, "s", &server_name)) {
 238                 TALLOC_FREE(mem_ctx);
 239                 return NULL;
 240         }
 241
 242         ids = irpc_servers_byname(iface->msg_ctx, mem_ctx, server_name);
 243
 244         if (ids == NULL) {
 245                 TALLOC_FREE(mem_ctx);
 246                 PyErr_SetString(PyExc_KeyError, "No such name");
 247                 return NULL;
 248         }
 249
 250         for (i = 0; !server_id_is_disconnected(&ids[i]); i++) {
 251                 /* Do nothing */
 252         }
 253
 254         pylist = PyList_New(i);
 255         if (pylist == NULL) {
 256                 TALLOC_FREE(mem_ctx);
 257                 PyErr_NoMemory();
 258                 return NULL;
 259         }
 260         for (i = 0; !server_id_is_disconnected(&ids[i]); i++) {
 261                 PyObject *py_server_id;
 262                 struct server_id *p_server_id = talloc(NULL, struct server_id);
 263                 if (!p_server_id) {
 264                         PyErr_NoMemory();
 265                         return NULL;
 266                 }
 267                 *p_server_id = ids[i];
 268
 269                 py_server_id = py_return_ndr_struct("samba.dcerpc.server_id", "server_id", p_server_id, p_server_id);
 270                 if (!py_server_id) {
 271                         return NULL;
 272                 }
 273                 PyList_SetItem(pylist, i, py_server_id);
 274                 talloc_unlink(NULL, p_server_id);
 275         }
 276         TALLOC_FREE(mem_ctx);
 277         return pylist;
 278 }
 279
 280 static PyObject *py_irpc_all_servers(PyObject *self, PyObject *args, PyObject *kwargs)
 281 {
 282         imessaging_Object *iface = (imessaging_Object *)self;
 283         PyObject *pylist;
 284         int i;
 285         struct irpc_name_records *records;
 286         TALLOC_CTX *mem_ctx = talloc_new(NULL);
 287         if (!mem_ctx) {
 288                 PyErr_NoMemory();
 289                 return NULL;
 290         }
 291
 292         records = irpc_all_servers(iface->msg_ctx, mem_ctx);
 293         if (records == NULL) {
 294                 return NULL;
 295         }
 296
 297         pylist = PyList_New(records->num_records);
 298         if (pylist == NULL) {
 299                 TALLOC_FREE(mem_ctx);
 300                 PyErr_NoMemory();
 301                 return NULL;
 302         }
 303         for (i = 0; i < records->num_records; i++) {
 304                 PyObject *py_name_record
 305                         = py_return_ndr_struct("samba.dcerpc.irpc",
 306                                                "name_record",
 307                                                records->names[i],
 308                                                records->names[i]);
 309                 if (!py_name_record) {
 310                         return NULL;
 311                 }
 312                 PyList_SetItem(pylist, i,
 313                                py_name_record);
 314         }
 315         TALLOC_FREE(mem_ctx);
 316         return pylist;
 317 }
 318
 319 static PyMethodDef py_imessaging_methods[] = {
 320         { "send", (PyCFunction)py_imessaging_send, METH_VARARGS|METH_KEYWORDS,
 321                 "S.send(target, msg_type, data) -> None\nSend a message" },
 322         { "register", (PyCFunction)py_imessaging_register, METH_VARARGS|METH_KEYWORDS,
 323                 "S.register(callback, msg_type=None) -> msg_type\nRegister a message handler" },
 324         { "deregister", (PyCFunction)py_imessaging_deregister, METH_VARARGS|METH_KEYWORDS,
 325                 "S.deregister(callback, msg_type) -> None\nDeregister a message handler" },
 326         { "irpc_servers_byname", (PyCFunction)py_irpc_servers_byname, METH_VARARGS,
 327                 "S.irpc_servers_byname(name) -> list\nGet list of server_id values that are registered for a particular name" },
 328         { "irpc_all_servers", (PyCFunction)py_irpc_all_servers, METH_NOARGS,
 329                 "S.irpc_servers_byname() -> list\nGet list of all registered names and the associated server_id values" },
 330         { NULL, NULL, 0, NULL }
 331 };
 332
 333 static PyObject *py_imessaging_server_id(PyObject *obj, void *closure)
 334 {
 335         imessaging_Object *iface = (imessaging_Object *)obj;
 336         PyObject *py_server_id;
 337         struct server_id server_id = imessaging_get_server_id(iface->msg_ctx);
 338         struct server_id *p_server_id = talloc(NULL, struct server_id);
 339         if (!p_server_id) {
 340                 PyErr_NoMemory();
 341                 return NULL;
 342         }
 343         *p_server_id = server_id;
 344
 345         py_server_id = py_return_ndr_struct("samba.dcerpc.server_id", "server_id", p_server_id, p_server_id);
 346         talloc_unlink(NULL, p_server_id);
 347
 348         return py_server_id;
 349 }
 350
 351 static PyGetSetDef py_imessaging_getset[] = {
 352         { discard_const_p(char, "server_id"), py_imessaging_server_id, NULL,
 353           discard_const_p(char, "local server id") },
 354         { NULL },
 355 };
 356
 357
 358 PyTypeObject imessaging_Type = {
 359         PyObject_HEAD_INIT(NULL) 0,
 360         .tp_name = "messaging.Messaging",
 361         .tp_basicsize = sizeof(imessaging_Object),
 362         .tp_flags = Py_TPFLAGS_DEFAULT|Py_TPFLAGS_BASETYPE,
 363         .tp_new = py_imessaging_connect,
 364         .tp_dealloc = py_imessaging_dealloc,
 365         .tp_methods = py_imessaging_methods,
 366         .tp_getset = py_imessaging_getset,
 367         .tp_doc = "Messaging(own_id=None)\n" \
 368                   "Create a new object that can be used to communicate with the peers in the specified messaging path.\n"
 369 };
 370
 371 void initmessaging(void)
 372 {
 373         PyObject *mod;
 374
 375         if (PyType_Ready(&imessaging_Type) < 0)
 376                 return;
 377
 378         mod = Py_InitModule3("messaging", NULL, "Internal RPC");
 379         if (mod == NULL)
 380                 return;
 381
 382         Py_INCREF((PyObject *)&imessaging_Type);
 383         PyModule_AddObject(mod, "Messaging", (PyObject *)&imessaging_Type);
 384 }