2 Unix SMB/CIFS implementation.
3 Samba utility functions
4 Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2007-2008
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.
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.
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/>.
21 #include "python/py3compat.h"
23 #include "param/param.h"
24 #include "param/loadparm.h"
26 #include "dynconfig/dynconfig.h"
28 #define PyLoadparmContext_AsLoadparmContext(obj) pytalloc_get_type(obj, struct loadparm_context)
29 #define PyLoadparmService_AsLoadparmService(obj) pytalloc_get_type(obj, struct loadparm_service)
31 extern PyTypeObject PyLoadparmContext;
32 extern PyTypeObject PyLoadparmService;
34 static PyObject *PyLoadparmService_FromService(struct loadparm_service *service)
36 return pytalloc_reference(&PyLoadparmService, service);
39 static PyObject *py_lp_ctx_get_helper(struct loadparm_context *lp_ctx, const char *service_name, const char *param_name)
41 struct parm_struct *parm = NULL;
42 void *parm_ptr = NULL;
45 if (service_name != NULL && strwicmp(service_name, GLOBAL_NAME) &&
46 strwicmp(service_name, GLOBAL_NAME2)) {
47 struct loadparm_service *service;
48 /* its a share parameter */
49 service = lpcfg_service(lp_ctx, service_name);
50 if (service == NULL) {
53 if (strchr(param_name, ':')) {
54 /* its a parametric option on a share */
55 const char *type = talloc_strndup(lp_ctx, param_name,
56 strcspn(param_name, ":"));
57 const char *option = strchr(param_name, ':') + 1;
59 if (type == NULL || option == NULL) {
62 value = lpcfg_get_parametric(lp_ctx, service, type, option);
66 return PyStr_FromString(value);
69 parm = lpcfg_parm_struct(lp_ctx, param_name);
70 if (parm == NULL || parm->p_class == P_GLOBAL) {
73 parm_ptr = lpcfg_parm_ptr(lp_ctx, service, parm);
74 } else if (strchr(param_name, ':')) {
75 /* its a global parametric option */
76 const char *type = talloc_strndup(lp_ctx,
77 param_name, strcspn(param_name, ":"));
78 const char *option = strchr(param_name, ':') + 1;
80 if (type == NULL || option == NULL) {
83 value = lpcfg_get_parametric(lp_ctx, NULL, type, option);
86 return PyStr_FromString(value);
88 /* its a global parameter */
89 parm = lpcfg_parm_struct(lp_ctx, param_name);
93 parm_ptr = lpcfg_parm_ptr(lp_ctx, NULL, parm);
96 if (parm == NULL || parm_ptr == NULL) {
100 /* construct and return the right type of python object */
101 switch (parm->type) {
103 return PyStr_FromFormat("%c", *(char *)parm_ptr);
106 return PyStr_FromString(*(char **)parm_ptr);
108 return PyBool_FromLong(*(bool *)parm_ptr);
110 return PyBool_FromLong(!(*(bool *)parm_ptr));
114 return PyLong_FromLong(*(int *)parm_ptr);
116 for (i=0; parm->enum_list[i].name; i++) {
117 if (*(int *)parm_ptr == parm->enum_list[i].value) {
118 return PyStr_FromString(parm->enum_list[i].name);
126 const char **strlist = *(const char ***)parm_ptr;
129 if(strlist == NULL) {
130 return PyList_New(0);
133 pylist = PyList_New(str_list_length(strlist));
134 for (j = 0; strlist[j]; j++)
135 PyList_SetItem(pylist, j,
136 PyStr_FromString(strlist[j]));
144 static PyObject *py_lp_ctx_load(PyObject *self, PyObject *args)
148 if (!PyArg_ParseTuple(args, "s", &filename))
151 ret = lpcfg_load(PyLoadparmContext_AsLoadparmContext(self), filename);
154 PyErr_Format(PyExc_RuntimeError, "Unable to load file %s", filename);
160 static PyObject *py_lp_ctx_load_default(PyObject *self, PyObject *unused)
163 ret = lpcfg_load_default(PyLoadparmContext_AsLoadparmContext(self));
166 PyErr_SetString(PyExc_RuntimeError, "Unable to load default file");
172 static PyObject *py_lp_ctx_get(PyObject *self, PyObject *args)
175 char *section_name = NULL;
177 if (!PyArg_ParseTuple(args, "s|z", ¶m_name, §ion_name))
180 ret = py_lp_ctx_get_helper(PyLoadparmContext_AsLoadparmContext(self), section_name, param_name);
186 static PyObject *py_lp_ctx_is_myname(PyObject *self, PyObject *args)
189 if (!PyArg_ParseTuple(args, "s", &name))
192 return PyBool_FromLong(lpcfg_is_myname(PyLoadparmContext_AsLoadparmContext(self), name));
195 static PyObject *py_lp_ctx_is_mydomain(PyObject *self, PyObject *args)
198 if (!PyArg_ParseTuple(args, "s", &name))
201 return PyBool_FromLong(lpcfg_is_mydomain(PyLoadparmContext_AsLoadparmContext(self), name));
204 static PyObject *py_lp_ctx_set(PyObject *self, PyObject *args)
208 if (!PyArg_ParseTuple(args, "ss", &name, &value))
211 ret = lpcfg_set_cmdline(PyLoadparmContext_AsLoadparmContext(self), name, value);
213 PyErr_SetString(PyExc_RuntimeError, "Unable to set parameter");
220 static PyObject *py_lp_ctx_private_path(PyObject *self, PyObject *args)
224 if (!PyArg_ParseTuple(args, "s", &name))
227 path = lpcfg_private_path(NULL, PyLoadparmContext_AsLoadparmContext(self), name);
228 ret = PyStr_FromString(path);
234 static PyObject *py_lp_ctx_services(PyObject *self, PyObject *unused)
236 struct loadparm_context *lp_ctx = PyLoadparmContext_AsLoadparmContext(self);
239 ret = PyList_New(lpcfg_numservices(lp_ctx));
240 for (i = 0; i < lpcfg_numservices(lp_ctx); i++) {
241 struct loadparm_service *service = lpcfg_servicebynum(lp_ctx, i);
242 if (service != NULL) {
243 PyList_SetItem(ret, i, PyStr_FromString(lpcfg_servicename(service)));
249 static PyObject *py_lp_ctx_server_role(PyObject *self, PyObject *unused)
251 struct loadparm_context *lp_ctx = PyLoadparmContext_AsLoadparmContext(self);
253 const char *role_str;
255 role = lpcfg_server_role(lp_ctx);
256 role_str = server_role_str(role);
258 return PyStr_FromString(role_str);
261 static PyObject *py_lp_dump(PyObject *self, PyObject *args)
263 bool show_defaults = false;
264 const char *file_name = "";
265 const char *mode = "w";
267 struct loadparm_context *lp_ctx = PyLoadparmContext_AsLoadparmContext(self);
269 if (!PyArg_ParseTuple(args, "|bss", &show_defaults, &file_name, &mode))
272 if (file_name[0] == '\0') {
275 f = fopen(file_name, mode);
279 PyErr_SetFromErrno(PyExc_IOError);
283 lpcfg_dump(lp_ctx, f, show_defaults, lpcfg_numservices(lp_ctx));
292 static PyObject *py_lp_dump_a_parameter(PyObject *self, PyObject *args)
295 const char *section_name = NULL;
296 const char *file_name = "";
297 const char *mode = "w";
299 struct loadparm_context *lp_ctx = PyLoadparmContext_AsLoadparmContext(self);
300 struct loadparm_service *service;
303 if (!PyArg_ParseTuple(args, "s|zss", ¶m_name, §ion_name, &file_name, &mode))
306 if (file_name[0] == '\0') {
309 f = fopen(file_name, mode);
316 if (section_name != NULL && strwicmp(section_name, GLOBAL_NAME) &&
317 strwicmp(section_name, GLOBAL_NAME2)) {
318 /* it's a share parameter */
319 service = lpcfg_service(lp_ctx, section_name);
320 if (service == NULL) {
321 PyErr_Format(PyExc_RuntimeError, "Unknown section %s", section_name);
327 section_name = "global";
330 ret = lpcfg_dump_a_parameter(lp_ctx, service, param_name, f);
333 PyErr_Format(PyExc_RuntimeError, "Parameter %s unknown for section %s", param_name, section_name);
345 static PyObject *py_lp_log_level(PyObject *self, PyObject *unused)
347 int ret = DEBUGLEVEL_CLASS[DBGC_CLASS];
348 return PyInt_FromLong(ret);
352 static PyObject *py_samdb_url(PyObject *self, PyObject *unused)
354 struct loadparm_context *lp_ctx = PyLoadparmContext_AsLoadparmContext(self);
355 return PyStr_FromFormat("tdb://%s/sam.ldb", lpcfg_private_dir(lp_ctx));
359 static PyMethodDef py_lp_ctx_methods[] = {
360 { "load", py_lp_ctx_load, METH_VARARGS,
361 "S.load(filename) -> None\n"
362 "Load specified file." },
363 { "load_default", py_lp_ctx_load_default, METH_NOARGS,
364 "S.load_default() -> None\n"
365 "Load default smb.conf file." },
366 { "is_myname", py_lp_ctx_is_myname, METH_VARARGS,
367 "S.is_myname(name) -> bool\n"
368 "Check whether the specified name matches one of our netbios names." },
369 { "is_mydomain", py_lp_ctx_is_mydomain, METH_VARARGS,
370 "S.is_mydomain(name) -> bool\n"
371 "Check whether the specified name matches our domain name." },
372 { "get", py_lp_ctx_get, METH_VARARGS,
373 "S.get(name, service_name) -> value\n"
374 "Find specified parameter." },
375 { "set", py_lp_ctx_set, METH_VARARGS,
376 "S.set(name, value) -> bool\n"
377 "Change a parameter." },
378 { "private_path", py_lp_ctx_private_path, METH_VARARGS,
379 "S.private_path(name) -> path\n" },
380 { "services", py_lp_ctx_services, METH_NOARGS,
381 "S.services() -> list" },
382 { "server_role", py_lp_ctx_server_role, METH_NOARGS,
383 "S.server_role() -> value\n"
384 "Get the server role." },
385 { "dump", py_lp_dump, METH_VARARGS,
386 "S.dump(show_defaults=False, file_name='', mode='w')" },
387 { "dump_a_parameter", py_lp_dump_a_parameter, METH_VARARGS,
388 "S.dump_a_parameter(name, service_name, file_name='', mode='w')" },
389 { "log_level", py_lp_log_level, METH_NOARGS,
390 "S.log_level() -> int\n Get the active log level" },
391 { "samdb_url", py_samdb_url, METH_NOARGS,
392 "S.samdb_url() -> string\n"
393 "Returns the current URL for sam.ldb." },
397 static PyObject *py_lp_ctx_default_service(PyObject *self, void *closure)
399 return PyLoadparmService_FromService(lpcfg_default_service(PyLoadparmContext_AsLoadparmContext(self)));
402 static PyObject *py_lp_ctx_config_file(PyObject *self, void *closure)
404 const char *configfile = lpcfg_configfile(PyLoadparmContext_AsLoadparmContext(self));
405 if (configfile == NULL)
408 return PyStr_FromString(configfile);
411 static PyGetSetDef py_lp_ctx_getset[] = {
412 { discard_const_p(char, "default_service"), (getter)py_lp_ctx_default_service, NULL, NULL },
413 { discard_const_p(char, "configfile"), (getter)py_lp_ctx_config_file, NULL,
414 discard_const_p(char, "Name of last config file that was loaded.") },
418 static PyObject *py_lp_ctx_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
420 return pytalloc_reference(type, loadparm_init_global(false));
423 static Py_ssize_t py_lp_ctx_len(PyObject *self)
425 return lpcfg_numservices(PyLoadparmContext_AsLoadparmContext(self));
428 static PyObject *py_lp_ctx_getitem(PyObject *self, PyObject *name)
430 struct loadparm_service *service;
431 if (!PyStr_Check(name)) {
432 PyErr_SetString(PyExc_TypeError, "Only string subscripts are supported");
435 service = lpcfg_service(PyLoadparmContext_AsLoadparmContext(self), PyStr_AsString(name));
436 if (service == NULL) {
437 PyErr_SetString(PyExc_KeyError, "No such section");
440 return PyLoadparmService_FromService(service);
443 static PyMappingMethods py_lp_ctx_mapping = {
444 .mp_length = (lenfunc)py_lp_ctx_len,
445 .mp_subscript = (binaryfunc)py_lp_ctx_getitem,
448 PyTypeObject PyLoadparmContext = {
449 .tp_name = "param.LoadParm",
450 .tp_getset = py_lp_ctx_getset,
451 .tp_methods = py_lp_ctx_methods,
452 .tp_new = py_lp_ctx_new,
453 .tp_as_mapping = &py_lp_ctx_mapping,
454 .tp_flags = Py_TPFLAGS_DEFAULT,
457 static PyObject *py_lp_service_dump(PyObject *self, PyObject *args)
459 bool show_defaults = false;
461 const char *file_name = "";
462 const char *mode = "w";
463 struct loadparm_service *service = PyLoadparmService_AsLoadparmService(self);
464 struct loadparm_service *default_service;
465 PyObject *py_default_service;
467 if (!PyArg_ParseTuple(args, "O|bss", &py_default_service, &show_defaults, &file_name, &mode))
470 if (file_name[0] == '\0') {
473 f = fopen(file_name, mode);
480 if (!PyObject_TypeCheck(py_default_service, &PyLoadparmService)) {
481 PyErr_SetNone(PyExc_TypeError);
485 default_service = PyLoadparmService_AsLoadparmService(py_default_service);
487 lpcfg_dump_one(f, show_defaults, service, default_service);
496 static PyMethodDef py_lp_service_methods[] = {
497 { "dump", (PyCFunction)py_lp_service_dump, METH_VARARGS,
498 "S.dump(default_service, show_defaults=False, file_name='', mode='w')" },
502 PyTypeObject PyLoadparmService = {
503 .tp_name = "param.LoadparmService",
504 .tp_methods = py_lp_service_methods,
505 .tp_flags = Py_TPFLAGS_DEFAULT,
508 static PyObject *py_default_path(PyObject *self)
510 return PyStr_FromString(lp_default_path());
513 static PyObject *py_setup_dir(PyObject *self)
515 return PyStr_FromString(dyn_SETUPDIR);
518 static PyObject *py_modules_dir(PyObject *self)
520 return PyStr_FromString(dyn_MODULESDIR);
523 static PyObject *py_bin_dir(PyObject *self)
525 return PyStr_FromString(dyn_BINDIR);
528 static PyObject *py_sbin_dir(PyObject *self)
530 return PyStr_FromString(dyn_SBINDIR);
533 static PyMethodDef pyparam_methods[] = {
534 { "default_path", (PyCFunction)py_default_path, METH_NOARGS,
535 "Returns the default smb.conf path." },
536 { "setup_dir", (PyCFunction)py_setup_dir, METH_NOARGS,
537 "Returns the compiled in location of provision tempates." },
538 { "modules_dir", (PyCFunction)py_modules_dir, METH_NOARGS,
539 "Returns the compiled in location of modules." },
540 { "bin_dir", (PyCFunction)py_bin_dir, METH_NOARGS,
541 "Returns the compiled in BINDIR." },
542 { "sbin_dir", (PyCFunction)py_sbin_dir, METH_NOARGS,
543 "Returns the compiled in SBINDIR." },
547 static struct PyModuleDef moduledef = {
548 PyModuleDef_HEAD_INIT,
550 .m_doc = "Parsing and writing Samba configuration files.",
552 .m_methods = pyparam_methods,
555 MODULE_INIT_FUNC(param)
558 PyTypeObject *talloc_type = pytalloc_GetObjectType();
559 if (talloc_type == NULL)
562 if (pytalloc_BaseObject_PyType_Ready(&PyLoadparmContext) < 0)
565 if (pytalloc_BaseObject_PyType_Ready(&PyLoadparmService) < 0)
568 m = PyModule_Create(&moduledef);
572 Py_INCREF(&PyLoadparmContext);
573 PyModule_AddObject(m, "LoadParm", (PyObject *)&PyLoadparmContext);