source/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 "includes.h"
  23 #include <Python.h>
  24 #include "libcli/util/pyerrors.h"
  25 #include "librpc/rpc/pyrpc.h"
  26 #include "lib/messaging/irpc.h"
  27 #include "lib/messaging/messaging.h"
  28 #include "lib/events/events.h"
  29 #include "cluster/cluster.h"
  30 #include "param/param.h"
  31 #include "librpc/gen_ndr/py_irpc.h"
  32
  33 PyAPI_DATA(PyTypeObject) messaging_Type;
  34 PyAPI_DATA(PyTypeObject) irpc_ClientConnectionType;
  35
  36 static bool server_id_from_py(PyObject *object, struct server_id *server_id)
  37 {
  38         if (!PyTuple_Check(object)) {
  39                 PyErr_SetString(PyExc_ValueError, "Expected tuple");
  40                 return false;
  41         }
  42
  43         if (PyTuple_Size(object) == 3) {
  44                 return PyArg_ParseTuple(object, "iii", &server_id->id, &server_id->id2, &server_id->node);
  45         } else {
  46                 int id, id2;
  47                 if (!PyArg_ParseTuple(object, "ii", &id, &id2))
  48                         return false;
  49                 *server_id = cluster_id(id, id2);
  50                 return true;
  51         }
  52 }
  53
  54 typedef struct {
  55         PyObject_HEAD
  56         TALLOC_CTX *mem_ctx;
  57         struct messaging_context *msg_ctx;
  58 } messaging_Object;
  59
  60 PyObject *py_messaging_connect(PyTypeObject *self, PyObject *args, PyObject *kwargs)
  61 {
  62         struct event_context *ev;
  63         const char *kwnames[] = { "own_id", "messaging_path", NULL };
  64         PyObject *own_id = Py_None;
  65         const char *messaging_path = NULL;
  66         messaging_Object *ret;
  67
  68         if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|Oz:connect",
  69                 discard_const_p(char *, kwnames), &own_id, &messaging_path)) {
  70                 return NULL;
  71         }
  72
  73         ret = PyObject_New(messaging_Object, &messaging_Type);
  74         if (ret == NULL)
  75                 return NULL;
  76
  77         ret->mem_ctx = talloc_new(NULL);
  78
  79         ev = event_context_init(ret->mem_ctx);
  80
  81         if (messaging_path == NULL) {
  82                 messaging_path = lp_messaging_path(ret, global_loadparm);
  83         } else {
  84                 messaging_path = talloc_strdup(ret->mem_ctx, messaging_path);
  85         }
  86
  87         if (own_id != Py_None) {
  88                 struct server_id server_id;
  89
  90                 if (!server_id_from_py(own_id, &server_id))
  91                         return NULL;
  92
  93                 ret->msg_ctx = messaging_init(ret->mem_ctx,
  94                                             messaging_path,
  95                                             server_id,
  96                                             lp_iconv_convenience(global_loadparm),
  97                                             ev);
  98         } else {
  99                 ret->msg_ctx = messaging_client_init(ret->mem_ctx,
 100                                             messaging_path,
 101                                             lp_iconv_convenience(global_loadparm),
 102                                             ev);
 103         }
 104
 105         if (ret->msg_ctx == NULL) {
 106                 PyErr_SetString(PyExc_RuntimeError, "messaging_connect unable to create a messaging context");
 107                 talloc_free(ret->mem_ctx);
 108                 return NULL;
 109         }
 110
 111         return (PyObject *)ret;
 112 }
 113
 114 static void py_messaging_dealloc(PyObject *self)
 115 {
 116         messaging_Object *iface = (messaging_Object *)self;
 117         talloc_free(iface->msg_ctx);
 118         PyObject_Del(self);
 119 }
 120
 121 static PyObject *py_messaging_send(PyObject *self, PyObject *args, PyObject *kwargs)
 122 {
 123         messaging_Object *iface = (messaging_Object *)self;
 124         uint32_t msg_type;
 125         DATA_BLOB data;
 126         PyObject *target;
 127         NTSTATUS status;
 128         struct server_id server;
 129         const char *kwnames[] = { "target", "msg_type", "data", NULL };
 130         int length;
 131
 132         if (!PyArg_ParseTupleAndKeywords(args, kwargs, "Ois#|:send",
 133                 discard_const_p(char *, kwnames), &target, &msg_type, &data.data, &length)) {
 134                 return NULL;
 135         }
 136
 137         data.length = length;
 138
 139         if (!server_id_from_py(target, &server))
 140                 return NULL;
 141
 142         status = messaging_send(iface->msg_ctx, server, msg_type, &data);
 143         if (NT_STATUS_IS_ERR(status)) {
 144                 PyErr_SetNTSTATUS(status);
 145                 return NULL;
 146         }
 147
 148         return Py_None;
 149 }
 150
 151 static void py_msg_callback_wrapper(struct messaging_context *msg, void *private,
 152                                uint32_t msg_type,
 153                                struct server_id server_id, DATA_BLOB *data)
 154 {
 155         PyObject *callback = (PyObject *)private;
 156
 157         PyObject_CallFunction(callback, discard_const_p(char, "i(iii)s#"), msg_type,
 158                               server_id.id, server_id.id2, server_id.node,
 159                               data->data, data->length);
 160 }
 161
 162 static PyObject *py_messaging_register(PyObject *self, PyObject *args, PyObject *kwargs)
 163 {
 164         messaging_Object *iface = (messaging_Object *)self;
 165         int msg_type = -1;
 166         PyObject *callback;
 167         NTSTATUS status;
 168         const char *kwnames[] = { "callback", "msg_type", NULL };
 169
 170         if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O|i:send",
 171                 discard_const_p(char *, kwnames), &callback, &msg_type)) {
 172                 return NULL;
 173         }
 174
 175         Py_INCREF(callback);
 176
 177         if (msg_type == -1) {
 178                 uint32_t msg_type32 = msg_type;
 179                 status = messaging_register_tmp(iface->msg_ctx, callback,
 180                                                 py_msg_callback_wrapper, &msg_type32);
 181                 msg_type = msg_type32;
 182         } else {
 183                 status = messaging_register(iface->msg_ctx, callback,
 184                                     msg_type, py_msg_callback_wrapper);
 185         }
 186         if (NT_STATUS_IS_ERR(status)) {
 187                 PyErr_SetNTSTATUS(status);
 188                 return NULL;
 189         }
 190
 191         return PyLong_FromLong(msg_type);
 192 }
 193
 194 static PyObject *py_messaging_deregister(PyObject *self, PyObject *args, PyObject *kwargs)
 195 {
 196         messaging_Object *iface = (messaging_Object *)self;
 197         int msg_type = -1;
 198         PyObject *callback;
 199         const char *kwnames[] = { "callback", "msg_type", NULL };
 200
 201         if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O|i:send",
 202                 discard_const_p(char *, kwnames), &callback, &msg_type)) {
 203                 return NULL;
 204         }
 205
 206         messaging_deregister(iface->msg_ctx, msg_type, callback);
 207
 208         Py_DECREF(callback);
 209
 210         return Py_None;
 211 }
 212
 213 static PyObject *py_messaging_add_name(PyObject *self, PyObject *args, PyObject *kwargs)
 214 {
 215         messaging_Object *iface = (messaging_Object *)self;
 216         NTSTATUS status;
 217         char *name;
 218         const char *kwnames[] = { "name", NULL };
 219
 220         if (!PyArg_ParseTupleAndKeywords(args, kwargs, "s|:send",
 221                 discard_const_p(char *, kwnames), &name)) {
 222                 return NULL;
 223         }
 224
 225         status = irpc_add_name(iface->msg_ctx, name);
 226         if (NT_STATUS_IS_ERR(status)) {
 227                 PyErr_SetNTSTATUS(status);
 228                 return NULL;
 229         }
 230
 231         return Py_None;
 232 }
 233
 234
 235 static PyObject *py_messaging_remove_name(PyObject *self, PyObject *args, PyObject *kwargs)
 236 {
 237         messaging_Object *iface = (messaging_Object *)self;
 238         char *name;
 239         const char *kwnames[] = { "name", NULL };
 240
 241         if (!PyArg_ParseTupleAndKeywords(args, kwargs, "s|:send",
 242                 discard_const_p(char *, kwnames), &name)) {
 243                 return NULL;
 244         }
 245
 246         irpc_remove_name(iface->msg_ctx, name);
 247
 248         return Py_None;
 249 }
 250
 251 static PyMethodDef py_messaging_methods[] = {
 252         { "send", (PyCFunction)py_messaging_send, METH_VARARGS|METH_KEYWORDS,
 253                 "S.send(target, msg_type, data) -> None\nSend a message" },
 254         { "register", (PyCFunction)py_messaging_register, METH_VARARGS|METH_KEYWORDS,
 255                 "S.register(callback, msg_type=None) -> msg_type\nRegister a message handler" },
 256         { "deregister", (PyCFunction)py_messaging_deregister, METH_VARARGS|METH_KEYWORDS,
 257                 "S.deregister(callback, msg_type) -> None\nDeregister a message handler" },
 258         { "add_name", (PyCFunction)py_messaging_add_name, METH_VARARGS|METH_KEYWORDS, "S.add_name(name) -> None\nListen on another name" },
 259         { "remove_name", (PyCFunction)py_messaging_remove_name, METH_VARARGS|METH_KEYWORDS, "S.remove_name(name) -> None\nStop listening on a name" },
 260         { NULL, NULL, 0, NULL }
 261 };
 262
 263 static PyObject *py_messaging_server_id(PyObject *obj, void *closure)
 264 {
 265         messaging_Object *iface = (messaging_Object *)obj;
 266         struct server_id server_id = messaging_get_server_id(iface->msg_ctx);
 267
 268         return Py_BuildValue("(iii)", server_id.id, server_id.id2,
 269                              server_id.node);
 270 }
 271
 272 static PyGetSetDef py_messaging_getset[] = {
 273         { discard_const_p(char, "server_id"), py_messaging_server_id, NULL,
 274           discard_const_p(char, "local server id") },
 275         { NULL },
 276 };
 277
 278
 279 PyTypeObject messaging_Type = {
 280         PyObject_HEAD_INIT(NULL) 0,
 281         .tp_name = "irpc.Messaging",
 282         .tp_basicsize = sizeof(messaging_Object),
 283         .tp_flags = Py_TPFLAGS_DEFAULT|Py_TPFLAGS_BASETYPE,
 284         .tp_new = py_messaging_connect,
 285         .tp_dealloc = py_messaging_dealloc,
 286         .tp_methods = py_messaging_methods,
 287         .tp_getset = py_messaging_getset,
 288         .tp_doc = "Messaging(own_id=None, messaging_path=None)\n" \
 289                   "Create a new object that can be used to communicate with the peers in the specified messaging path.\n" \
 290                   "If no path is specified, the default path from smb.conf will be used."
 291 };
 292
 293
 294 /*
 295   state of a irpc 'connection'
 296 */
 297 typedef struct {
 298         PyObject_HEAD
 299         const char *server_name;
 300         struct server_id *dest_ids;
 301         struct messaging_context *msg_ctx;
 302         TALLOC_CTX *mem_ctx;
 303 } irpc_ClientConnectionObject;
 304
 305 /*
 306   setup a context for talking to a irpc server
 307      example:
 308         status = irpc.connect("smb_server");
 309 */
 310
 311 PyObject *py_irpc_connect(PyTypeObject *self, PyObject *args, PyObject *kwargs)
 312 {
 313         struct event_context *ev;
 314         const char *kwnames[] = { "server", "own_id", "messaging_path", NULL };
 315         char *server;
 316         const char *messaging_path = NULL;
 317         PyObject *own_id = Py_None;
 318         irpc_ClientConnectionObject *ret;
 319
 320         if (!PyArg_ParseTupleAndKeywords(args, kwargs, "s|Oz:connect",
 321                 discard_const_p(char *, kwnames), &server, &own_id, &messaging_path)) {
 322                 return NULL;
 323         }
 324
 325         ret = PyObject_New(irpc_ClientConnectionObject, &irpc_ClientConnectionType);
 326         if (ret == NULL)
 327                 return NULL;
 328
 329         ret->mem_ctx = talloc_new(NULL);
 330
 331         ret->server_name = server;
 332
 333         ev = event_context_init(ret->mem_ctx);
 334
 335         if (messaging_path == NULL) {
 336                 messaging_path = lp_messaging_path(ret, global_loadparm);
 337         } else {
 338                 messaging_path = talloc_strdup(ret->mem_ctx, messaging_path);
 339         }
 340
 341         if (own_id != Py_None) {
 342                 struct server_id server_id;
 343
 344                 if (!server_id_from_py(own_id, &server_id))
 345                         return NULL;
 346
 347                 ret->msg_ctx = messaging_init(ret->mem_ctx,
 348                                             messaging_path,
 349                                             server_id,
 350                                             lp_iconv_convenience(global_loadparm),
 351                                             ev);
 352         } else {
 353                 ret->msg_ctx = messaging_client_init(ret->mem_ctx,
 354                                             messaging_path,
 355                                             lp_iconv_convenience(global_loadparm),
 356                                             ev);
 357         }
 358
 359         if (ret->msg_ctx == NULL) {
 360                 PyErr_SetString(PyExc_RuntimeError, "irpc_connect unable to create a messaging context");
 361                 talloc_free(ret->mem_ctx);
 362                 return NULL;
 363         }
 364
 365         ret->dest_ids = irpc_servers_byname(ret->msg_ctx, ret->mem_ctx, ret->server_name);
 366         if (ret->dest_ids == NULL || ret->dest_ids[0].id == 0) {
 367                 talloc_free(ret->mem_ctx);
 368                 PyErr_SetNTSTATUS(NT_STATUS_OBJECT_NAME_NOT_FOUND);
 369                 return NULL;
 370         } else {
 371                 return (PyObject *)ret;
 372         }
 373 }
 374
 375 typedef struct {
 376         PyObject_HEAD
 377         struct irpc_request **reqs;
 378         int count;
 379         int current;
 380         TALLOC_CTX *mem_ctx;
 381         py_data_unpack_fn unpack_fn;
 382 } irpc_ResultObject;
 383
 384
 385 static PyObject *irpc_result_next(irpc_ResultObject *iterator)
 386 {
 387         NTSTATUS status;
 388
 389         if (iterator->current >= iterator->count) {
 390                 PyErr_SetString(PyExc_StopIteration, "No more results");
 391                 return NULL;
 392         }
 393
 394         status = irpc_call_recv(iterator->reqs[iterator->current]);
 395         iterator->current++;
 396         if (!NT_STATUS_IS_OK(status)) {
 397                 PyErr_SetNTSTATUS(status);
 398                 return NULL;
 399         }
 400
 401         return iterator->unpack_fn(iterator->reqs[iterator->current-1]->r);
 402 }
 403
 404 static PyObject *irpc_result_len(irpc_ResultObject *self)
 405 {
 406         return PyLong_FromLong(self->count);
 407 }
 408
 409 static PyMethodDef irpc_result_methods[] = {
 410         { "__len__", (PyCFunction)irpc_result_len, METH_NOARGS,
 411                 "Number of elements returned"},
 412         { NULL }
 413 };
 414
 415 static void irpc_result_dealloc(PyObject *self)
 416 {
 417         talloc_free(((irpc_ResultObject *)self)->mem_ctx);
 418         PyObject_Del(self);
 419 }
 420
 421 PyTypeObject irpc_ResultIteratorType = {
 422         PyObject_HEAD_INIT(NULL) 0,
 423         .tp_name = "irpc.ResultIterator",
 424         .tp_basicsize = sizeof(irpc_ResultObject),
 425         .tp_flags = Py_TPFLAGS_DEFAULT|Py_TPFLAGS_BASETYPE,
 426         .tp_iternext = (iternextfunc)irpc_result_next,
 427         .tp_iter = PyObject_SelfIter,
 428         .tp_methods = irpc_result_methods,
 429         .tp_dealloc = irpc_result_dealloc,
 430 };
 431
 432 static PyObject *py_irpc_call(irpc_ClientConnectionObject *p, struct PyNdrRpcMethodDef *method_def, PyObject *args, PyObject *kwargs)
 433 {
 434         void *ptr;
 435         struct irpc_request **reqs;
 436         int i, count;
 437         NTSTATUS status;
 438         TALLOC_CTX *mem_ctx = talloc_new(NULL);
 439         irpc_ResultObject *ret;
 440
 441         /* allocate the C structure */
 442         ptr = talloc_zero_size(mem_ctx, method_def->table->calls[method_def->opnum].struct_size);
 443         if (ptr == NULL) {
 444                 status = NT_STATUS_NO_MEMORY;
 445                 goto done;
 446         }
 447
 448         /* convert the mpr object into a C structure */
 449         if (!method_def->pack_in_data(args, kwargs, ptr)) {
 450                 talloc_free(mem_ctx);
 451                 return NULL;
 452         }
 453
 454         for (count=0;p->dest_ids[count].id;count++) /* noop */ ;
 455
 456         /* we need to make a call per server */
 457         reqs = talloc_array(mem_ctx, struct irpc_request *, count);
 458         if (reqs == NULL) {
 459                 status = NT_STATUS_NO_MEMORY;
 460                 goto done;
 461         }
 462
 463         /* make the actual calls */
 464         for (i=0;i<count;i++) {
 465                 reqs[i] = irpc_call_send(p->msg_ctx, p->dest_ids[i],
 466                                          method_def->table, method_def->opnum, ptr, ptr);
 467                 if (reqs[i] == NULL) {
 468                         status = NT_STATUS_NO_MEMORY;
 469                         goto done;
 470                 }
 471                 talloc_steal(reqs, reqs[i]);
 472         }
 473
 474         ret = PyObject_New(irpc_ResultObject, &irpc_ResultIteratorType);
 475         ret->mem_ctx = mem_ctx;
 476         ret->reqs = reqs;
 477         ret->count = count;
 478         ret->current = 0;
 479         ret->unpack_fn = method_def->unpack_out_data;
 480
 481         return (PyObject *)ret;
 482 done:
 483         talloc_free(mem_ctx);
 484         PyErr_SetNTSTATUS(status);
 485         return NULL;
 486 }
 487
 488 static PyObject *py_irpc_call_wrapper(PyObject *self, PyObject *args, void *wrapped, PyObject *kwargs)
 489 {
 490         irpc_ClientConnectionObject *iface = (irpc_ClientConnectionObject *)self;
 491         struct PyNdrRpcMethodDef *md = wrapped;
 492
 493         return py_irpc_call(iface, md, args, kwargs);
 494 }
 495
 496 static void py_irpc_dealloc(PyObject *self)
 497 {
 498         irpc_ClientConnectionObject *iface = (irpc_ClientConnectionObject *)self;
 499         talloc_free(iface->mem_ctx);
 500         PyObject_Del(self);
 501 }
 502
 503 PyTypeObject irpc_ClientConnectionType = {
 504         PyObject_HEAD_INIT(NULL) 0,
 505         .tp_name = "irpc.ClientConnection",
 506         .tp_basicsize = sizeof(irpc_ClientConnectionObject),
 507         .tp_flags = Py_TPFLAGS_DEFAULT|Py_TPFLAGS_BASETYPE,
 508         .tp_new = py_irpc_connect,
 509         .tp_dealloc = py_irpc_dealloc,
 510         .tp_doc = "ClientConnection(server, own_id=None, messaging_path=None)\n" \
 511                   "Create a new IRPC client connection to communicate with the servers in the specified path.\n" \
 512                   "If no path is specified, the default path from smb.conf will be used."
 513 };
 514
 515 static bool irpc_AddNdrRpcMethods(PyTypeObject *ifacetype, const struct PyNdrRpcMethodDef *mds)
 516 {
 517         int i;
 518         for (i = 0; mds[i].name; i++) {
 519                 PyObject *ret;
 520                 struct wrapperbase *wb = calloc(sizeof(struct wrapperbase), 1);
 521
 522                 wb->name = discard_const_p(char, mds[i].name);
 523                 wb->flags = PyWrapperFlag_KEYWORDS;
 524                 wb->wrapper = (wrapperfunc)py_irpc_call_wrapper;
 525                 wb->doc = discard_const_p(char, mds[i].doc);
 526
 527                 ret = PyDescr_NewWrapper(ifacetype, wb, discard_const_p(void, &mds[i]));
 528
 529                 PyDict_SetItemString(ifacetype->tp_dict, mds[i].name,
 530                                      (PyObject *)ret);
 531         }
 532
 533         return true;
 534 }
 535
 536 void initmessaging(void)
 537 {
 538         extern void initirpc(void);
 539         PyObject *mod;
 540
 541         if (PyType_Ready(&irpc_ClientConnectionType) < 0)
 542                 return;
 543
 544         if (PyType_Ready(&messaging_Type) < 0)
 545                 return;
 546
 547         if (PyType_Ready(&irpc_ResultIteratorType) < 0)
 548                 return;
 549
 550         if (!irpc_AddNdrRpcMethods(&irpc_ClientConnectionType, py_ndr_irpc_methods))
 551                 return;
 552
 553         mod = Py_InitModule3("messaging", NULL, "Internal RPC");
 554         if (mod == NULL)
 555                 return;
 556
 557         initirpc();
 558
 559         Py_INCREF((PyObject *)&irpc_ClientConnectionType);
 560         PyModule_AddObject(mod, "ClientConnection", (PyObject *)&irpc_ClientConnectionType);
 561
 562         Py_INCREF((PyObject *)&messaging_Type);
 563         PyModule_AddObject(mod, "Messaging", (PyObject *)&messaging_Type);
 564 }