source4/param/pyparam.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Samba utility functions
   4    Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2007-2008
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include <Python.h>
  21 #include "includes.h"
  22 #include "param/param.h"
  23 #include "param/loadparm.h"
  24 #include <pytalloc.h>
  25 #include "dynconfig/dynconfig.h"
  26
  27 void initparam(void);
  28
  29 /* There's no Py_ssize_t in 2.4, apparently */
  30 #if PY_MAJOR_VERSION == 2 && PY_MINOR_VERSION < 5
  31 typedef int Py_ssize_t;
  32 typedef inquiry lenfunc;
  33 #endif
  34
  35 #define PyLoadparmContext_AsLoadparmContext(obj) pytalloc_get_type(obj, struct loadparm_context)
  36 #define PyLoadparmService_AsLoadparmService(obj) pytalloc_get_type(obj, struct loadparm_service)
  37
  38 extern PyTypeObject PyLoadparmContext;
  39 extern PyTypeObject PyLoadparmService;
  40
  41 static PyObject *PyLoadparmService_FromService(struct loadparm_service *service)
  42 {
  43         return pytalloc_reference(&PyLoadparmService, service);
  44 }
  45
  46 static PyObject *py_lp_ctx_get_helper(struct loadparm_context *lp_ctx, const char *service_name, const char *param_name)
  47 {
  48         struct parm_struct *parm = NULL;
  49         void *parm_ptr = NULL;
  50         int i;
  51
  52         if (service_name != NULL && strwicmp(service_name, GLOBAL_NAME) &&
  53                 strwicmp(service_name, GLOBAL_NAME2)) {
  54                 struct loadparm_service *service;
  55                 /* its a share parameter */
  56                 service = lpcfg_service(lp_ctx, service_name);
  57                 if (service == NULL) {
  58                         return NULL;
  59                 }
  60                 if (strchr(param_name, ':')) {
  61                         /* its a parametric option on a share */
  62                         const char *type = talloc_strndup(lp_ctx, param_name,
  63                                                                                           strcspn(param_name, ":"));
  64                         const char *option = strchr(param_name, ':') + 1;
  65                         const char *value;
  66                         if (type == NULL || option == NULL) {
  67                         return NULL;
  68                         }
  69                         value = lpcfg_get_parametric(lp_ctx, service, type, option);
  70                         if (value == NULL) {
  71                         return NULL;
  72                         }
  73                         return PyString_FromString(value);
  74                 }
  75
  76                 parm = lpcfg_parm_struct(lp_ctx, param_name);
  77                 if (parm == NULL || parm->p_class == P_GLOBAL) {
  78                         return NULL;
  79                 }
  80                 parm_ptr = lpcfg_parm_ptr(lp_ctx, service, parm);
  81     } else if (strchr(param_name, ':')) {
  82                 /* its a global parametric option */
  83                 const char *type = talloc_strndup(lp_ctx,
  84                                   param_name, strcspn(param_name, ":"));
  85                 const char *option = strchr(param_name, ':') + 1;
  86                 const char *value;
  87                 if (type == NULL || option == NULL) {
  88                         return NULL;
  89                 }
  90                 value = lpcfg_get_parametric(lp_ctx, NULL, type, option);
  91                 if (value == NULL)
  92                         return NULL;
  93                 return PyString_FromString(value);
  94         } else {
  95                 /* its a global parameter */
  96                 parm = lpcfg_parm_struct(lp_ctx, param_name);
  97                 if (parm == NULL) {
  98                         return NULL;
  99                 }
 100                 parm_ptr = lpcfg_parm_ptr(lp_ctx, NULL, parm);
 101         }
 102
 103         if (parm == NULL || parm_ptr == NULL) {
 104                 return NULL;
 105     }
 106
 107     /* construct and return the right type of python object */
 108     switch (parm->type) {
 109     case P_CHAR:
 110         return PyString_FromFormat("%c", *(char *)parm_ptr);
 111     case P_STRING:
 112     case P_USTRING:
 113         return PyString_FromString(*(char **)parm_ptr);
 114     case P_BOOL:
 115         return PyBool_FromLong(*(bool *)parm_ptr);
 116     case P_BOOLREV:
 117         return PyBool_FromLong(!(*(bool *)parm_ptr));
 118     case P_INTEGER:
 119     case P_OCTAL:
 120     case P_BYTES:
 121         return PyLong_FromLong(*(int *)parm_ptr);
 122     case P_ENUM:
 123         for (i=0; parm->enum_list[i].name; i++) {
 124             if (*(int *)parm_ptr == parm->enum_list[i].value) {
 125                 return PyString_FromString(parm->enum_list[i].name);
 126             }
 127         }
 128         return NULL;
 129     case P_CMDLIST:
 130     case P_LIST:
 131         {
 132             int j;
 133             const char **strlist = *(const char ***)parm_ptr;
 134             PyObject *pylist;
 135
 136                 if(strlist == NULL) {
 137                         return PyList_New(0);
 138                 }
 139
 140                 pylist = PyList_New(str_list_length(strlist));
 141             for (j = 0; strlist[j]; j++)
 142                 PyList_SetItem(pylist, j,
 143                                PyString_FromString(strlist[j]));
 144             return pylist;
 145         }
 146     case P_SEP:
 147         return NULL; /* this stands for a separator, can be ignored */
 148     }
 149     return NULL;
 150
 151 }
 152
 153 static PyObject *py_lp_ctx_load(pytalloc_Object *self, PyObject *args)
 154 {
 155         char *filename;
 156         bool ret;
 157         if (!PyArg_ParseTuple(args, "s", &filename))
 158                 return NULL;
 159
 160         ret = lpcfg_load(PyLoadparmContext_AsLoadparmContext(self), filename);
 161
 162         if (!ret) {
 163                 PyErr_Format(PyExc_RuntimeError, "Unable to load file %s", filename);
 164                 return NULL;
 165         }
 166         Py_RETURN_NONE;
 167 }
 168
 169 static PyObject *py_lp_ctx_load_default(pytalloc_Object *self)
 170 {
 171         bool ret;
 172         ret = lpcfg_load_default(PyLoadparmContext_AsLoadparmContext(self));
 173
 174         if (!ret) {
 175                 PyErr_SetString(PyExc_RuntimeError, "Unable to load default file");
 176                 return NULL;
 177         }
 178         Py_RETURN_NONE;
 179 }
 180
 181 static PyObject *py_lp_ctx_get(pytalloc_Object *self, PyObject *args)
 182 {
 183         char *param_name;
 184         char *section_name = NULL;
 185         PyObject *ret;
 186         if (!PyArg_ParseTuple(args, "s|z", &param_name, &section_name))
 187                 return NULL;
 188
 189         ret = py_lp_ctx_get_helper(PyLoadparmContext_AsLoadparmContext(self), section_name, param_name);
 190         if (ret == NULL)
 191                 Py_RETURN_NONE;
 192         return ret;
 193 }
 194
 195 static PyObject *py_lp_ctx_is_myname(pytalloc_Object *self, PyObject *args)
 196 {
 197         char *name;
 198         if (!PyArg_ParseTuple(args, "s", &name))
 199                 return NULL;
 200
 201         return PyBool_FromLong(lpcfg_is_myname(PyLoadparmContext_AsLoadparmContext(self), name));
 202 }
 203
 204 static PyObject *py_lp_ctx_is_mydomain(pytalloc_Object *self, PyObject *args)
 205 {
 206         char *name;
 207         if (!PyArg_ParseTuple(args, "s", &name))
 208                 return NULL;
 209
 210         return PyBool_FromLong(lpcfg_is_mydomain(PyLoadparmContext_AsLoadparmContext(self), name));
 211 }
 212
 213 static PyObject *py_lp_ctx_set(pytalloc_Object *self, PyObject *args)
 214 {
 215         char *name, *value;
 216         bool ret;
 217         if (!PyArg_ParseTuple(args, "ss", &name, &value))
 218                 return NULL;
 219
 220         ret = lpcfg_set_cmdline(PyLoadparmContext_AsLoadparmContext(self), name, value);
 221         if (!ret) {
 222                 PyErr_SetString(PyExc_RuntimeError, "Unable to set parameter");
 223                 return NULL;
 224         }
 225
 226         Py_RETURN_NONE;
 227 }
 228
 229 static PyObject *py_lp_ctx_private_path(pytalloc_Object *self, PyObject *args)
 230 {
 231         char *name, *path;
 232         PyObject *ret;
 233         if (!PyArg_ParseTuple(args, "s", &name))
 234                 return NULL;
 235
 236         path = lpcfg_private_path(NULL, PyLoadparmContext_AsLoadparmContext(self), name);
 237         ret = PyString_FromString(path);
 238         talloc_free(path);
 239
 240         return ret;
 241 }
 242
 243 static PyObject *py_lp_ctx_services(pytalloc_Object *self)
 244 {
 245         struct loadparm_context *lp_ctx = PyLoadparmContext_AsLoadparmContext(self);
 246         PyObject *ret;
 247         int i;
 248         ret = PyList_New(lpcfg_numservices(lp_ctx));
 249         for (i = 0; i < lpcfg_numservices(lp_ctx); i++) {
 250                 struct loadparm_service *service = lpcfg_servicebynum(lp_ctx, i);
 251                 if (service != NULL) {
 252                         PyList_SetItem(ret, i, PyString_FromString(lpcfg_servicename(service)));
 253                 }
 254         }
 255         return ret;
 256 }
 257
 258 static PyObject *py_lp_ctx_server_role(pytalloc_Object *self)
 259 {
 260         struct loadparm_context *lp_ctx = PyLoadparmContext_AsLoadparmContext(self);
 261         uint32_t role;
 262         const char *role_str;
 263
 264         role = lpcfg_server_role(lp_ctx);
 265         role_str = server_role_str(role);
 266
 267         return PyString_FromString(role_str);
 268 }
 269
 270 static PyObject *py_lp_dump(PyObject *self, PyObject *args)
 271 {
 272         PyObject *py_stream;
 273         bool show_defaults = false;
 274         FILE *f;
 275         struct loadparm_context *lp_ctx = PyLoadparmContext_AsLoadparmContext(self);
 276
 277         if (!PyArg_ParseTuple(args, "O|b", &py_stream, &show_defaults))
 278                 return NULL;
 279
 280         f = PyFile_AsFile(py_stream);
 281         if (f == NULL) {
 282                 PyErr_SetString(PyExc_TypeError, "Not a file stream");
 283                 return NULL;
 284         }
 285
 286         lpcfg_dump(lp_ctx, f, show_defaults, lpcfg_numservices(lp_ctx));
 287
 288         Py_RETURN_NONE;
 289 }
 290
 291 static PyObject *py_samdb_url(PyObject *self)
 292 {
 293         struct loadparm_context *lp_ctx = PyLoadparmContext_AsLoadparmContext(self);
 294         return PyString_FromFormat("tdb://%s/sam.ldb", lpcfg_private_dir(lp_ctx));
 295 }
 296
 297
 298 static PyMethodDef py_lp_ctx_methods[] = {
 299         { "load", (PyCFunction)py_lp_ctx_load, METH_VARARGS,
 300                 "S.load(filename) -> None\n"
 301                 "Load specified file." },
 302         { "load_default", (PyCFunction)py_lp_ctx_load_default, METH_NOARGS,
 303                 "S.load_default() -> None\n"
 304                 "Load default smb.conf file." },
 305         { "is_myname", (PyCFunction)py_lp_ctx_is_myname, METH_VARARGS,
 306                 "S.is_myname(name) -> bool\n"
 307                 "Check whether the specified name matches one of our netbios names." },
 308         { "is_mydomain", (PyCFunction)py_lp_ctx_is_mydomain, METH_VARARGS,
 309                 "S.is_mydomain(name) -> bool\n"
 310                 "Check whether the specified name matches our domain name." },
 311         { "get", (PyCFunction)py_lp_ctx_get, METH_VARARGS,
 312                 "S.get(name, service_name) -> value\n"
 313                 "Find specified parameter." },
 314         { "set", (PyCFunction)py_lp_ctx_set, METH_VARARGS,
 315                 "S.set(name, value) -> bool\n"
 316                 "Change a parameter." },
 317         { "private_path", (PyCFunction)py_lp_ctx_private_path, METH_VARARGS,
 318                 "S.private_path(name) -> path\n" },
 319         { "services", (PyCFunction)py_lp_ctx_services, METH_NOARGS,
 320                 "S.services() -> list" },
 321         { "server_role", (PyCFunction)py_lp_ctx_server_role, METH_NOARGS,
 322                 "S.server_role() -> value\n"
 323                 "Get the server role." },
 324         { "dump", (PyCFunction)py_lp_dump, METH_VARARGS,
 325                 "S.dump(stream, show_defaults=False)" },
 326         { "samdb_url", (PyCFunction)py_samdb_url, METH_NOARGS,
 327                 "S.samdb_url() -> string\n"
 328                 "Returns the current URL for sam.ldb." },
 329         { NULL }
 330 };
 331
 332 static PyObject *py_lp_ctx_default_service(pytalloc_Object *self, void *closure)
 333 {
 334         return PyLoadparmService_FromService(lpcfg_default_service(PyLoadparmContext_AsLoadparmContext(self)));
 335 }
 336
 337 static PyObject *py_lp_ctx_config_file(pytalloc_Object *self, void *closure)
 338 {
 339         const char *configfile = lpcfg_configfile(PyLoadparmContext_AsLoadparmContext(self));
 340         if (configfile == NULL)
 341                 Py_RETURN_NONE;
 342         else
 343                 return PyString_FromString(configfile);
 344 }
 345
 346 static PyGetSetDef py_lp_ctx_getset[] = {
 347         { discard_const_p(char, "default_service"), (getter)py_lp_ctx_default_service, NULL, NULL },
 348         { discard_const_p(char, "configfile"), (getter)py_lp_ctx_config_file, NULL,
 349           discard_const_p(char, "Name of last config file that was loaded.") },
 350         { NULL }
 351 };
 352
 353 static PyObject *py_lp_ctx_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
 354 {
 355         pytalloc_Object *ret = (pytalloc_Object *)type->tp_alloc(type, 0);
 356         if (ret == NULL) {
 357                 PyErr_NoMemory();
 358                 return NULL;
 359         }
 360         ret->talloc_ctx = talloc_new(NULL);
 361         if (ret->talloc_ctx == NULL) {
 362                 PyErr_NoMemory();
 363                 return NULL;
 364         }
 365         ret->ptr = loadparm_init_global(false);
 366         if (ret->ptr == NULL) {
 367                 PyErr_NoMemory();
 368                 return NULL;
 369         }
 370         return (PyObject *)ret;
 371 }
 372
 373 static Py_ssize_t py_lp_ctx_len(pytalloc_Object *self)
 374 {
 375         return lpcfg_numservices(PyLoadparmContext_AsLoadparmContext(self));
 376 }
 377
 378 static PyObject *py_lp_ctx_getitem(pytalloc_Object *self, PyObject *name)
 379 {
 380         struct loadparm_service *service;
 381         if (!PyString_Check(name)) {
 382                 PyErr_SetString(PyExc_TypeError, "Only string subscripts are supported");
 383                 return NULL;
 384         }
 385         service = lpcfg_service(PyLoadparmContext_AsLoadparmContext(self), PyString_AsString(name));
 386         if (service == NULL) {
 387                 PyErr_SetString(PyExc_KeyError, "No such section");
 388                 return NULL;
 389         }
 390         return PyLoadparmService_FromService(service);
 391 }
 392
 393 static PyMappingMethods py_lp_ctx_mapping = {
 394         .mp_length = (lenfunc)py_lp_ctx_len,
 395         .mp_subscript = (binaryfunc)py_lp_ctx_getitem,
 396 };
 397
 398 PyTypeObject PyLoadparmContext = {
 399         .tp_name = "param.LoadParm",
 400         .tp_basicsize = sizeof(pytalloc_Object),
 401         .tp_getset = py_lp_ctx_getset,
 402         .tp_methods = py_lp_ctx_methods,
 403         .tp_new = py_lp_ctx_new,
 404         .tp_as_mapping = &py_lp_ctx_mapping,
 405         .tp_flags = Py_TPFLAGS_DEFAULT,
 406 };
 407
 408 static PyObject *py_lp_service_dump(PyObject *self, PyObject *args)
 409 {
 410         PyObject *py_stream;
 411         bool show_defaults = false;
 412         FILE *f;
 413         struct loadparm_service *service = PyLoadparmService_AsLoadparmService(self);
 414         struct loadparm_service *default_service;
 415         PyObject *py_default_service;
 416
 417         if (!PyArg_ParseTuple(args, "OO|b", &py_stream, &py_default_service,
 418                                                   &show_defaults))
 419                 return NULL;
 420
 421         f = PyFile_AsFile(py_stream);
 422         if (f == NULL) {
 423                 PyErr_SetString(PyExc_TypeError, "Not a file stream");
 424                 return NULL;
 425         }
 426
 427         if (!PyObject_TypeCheck(py_default_service, &PyLoadparmService)) {
 428                 PyErr_SetNone(PyExc_TypeError);
 429                 return NULL;
 430         }
 431
 432         default_service = PyLoadparmService_AsLoadparmService(py_default_service);
 433
 434         lpcfg_dump_one(f, show_defaults, service, default_service);
 435
 436         Py_RETURN_NONE;
 437 }
 438
 439 static PyMethodDef py_lp_service_methods[] = {
 440         { "dump", (PyCFunction)py_lp_service_dump, METH_VARARGS,
 441                 "S.dump(f, default_service, show_defaults=False)" },
 442         { NULL }
 443 };
 444
 445 PyTypeObject PyLoadparmService = {
 446         .tp_name = "param.LoadparmService",
 447         .tp_basicsize = sizeof(pytalloc_Object),
 448         .tp_methods = py_lp_service_methods,
 449         .tp_flags = Py_TPFLAGS_DEFAULT,
 450 };
 451
 452 static PyObject *py_default_path(PyObject *self)
 453 {
 454     return PyString_FromString(lp_default_path());
 455 }
 456
 457 static PyObject *py_setup_dir(PyObject *self)
 458 {
 459     return PyString_FromString(dyn_SETUPDIR);
 460 }
 461
 462 static PyObject *py_modules_dir(PyObject *self)
 463 {
 464     return PyString_FromString(dyn_MODULESDIR);
 465 }
 466
 467 static PyMethodDef pyparam_methods[] = {
 468     { "default_path", (PyCFunction)py_default_path, METH_NOARGS,
 469         "Returns the default smb.conf path." },
 470     { "setup_dir", (PyCFunction)py_setup_dir, METH_NOARGS,
 471         "Returns the compiled in location of provision tempates." },
 472     { "modules_dir", (PyCFunction)py_modules_dir, METH_NOARGS,
 473         "Returns the compiled in location of modules." },
 474     { NULL }
 475 };
 476
 477 void initparam(void)
 478 {
 479         PyObject *m;
 480         PyTypeObject *talloc_type = pytalloc_GetObjectType();
 481         if (talloc_type == NULL)
 482                 return;
 483
 484         PyLoadparmContext.tp_base = talloc_type;
 485         PyLoadparmService.tp_base = talloc_type;
 486
 487         if (PyType_Ready(&PyLoadparmContext) < 0)
 488                 return;
 489
 490         if (PyType_Ready(&PyLoadparmService) < 0)
 491                 return;
 492
 493         m = Py_InitModule3("param", pyparam_methods, "Parsing and writing Samba configuration files.");
 494         if (m == NULL)
 495                 return;
 496
 497         Py_INCREF(&PyLoadparmContext);
 498         PyModule_AddObject(m, "LoadParm", (PyObject *)&PyLoadparmContext);
 499 }