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
);
348 static PyObject
*py_lp_log_level(PyObject
*self
, PyObject
*unused
)
350 int ret
= DEBUGLEVEL_CLASS
[DBGC_CLASS
];
351 return PyInt_FromLong(ret
);
355 static PyObject
*py_samdb_url(PyObject
*self
, PyObject
*unused
)
357 struct loadparm_context
*lp_ctx
= PyLoadparmContext_AsLoadparmContext(self
);
358 return PyStr_FromFormat("tdb://%s/sam.ldb", lpcfg_private_dir(lp_ctx
));
362 static PyMethodDef py_lp_ctx_methods
[] = {
363 { "load", py_lp_ctx_load
, METH_VARARGS
,
364 "S.load(filename) -> None\n"
365 "Load specified file." },
366 { "load_default", py_lp_ctx_load_default
, METH_NOARGS
,
367 "S.load_default() -> None\n"
368 "Load default smb.conf file." },
369 { "is_myname", py_lp_ctx_is_myname
, METH_VARARGS
,
370 "S.is_myname(name) -> bool\n"
371 "Check whether the specified name matches one of our netbios names." },
372 { "is_mydomain", py_lp_ctx_is_mydomain
, METH_VARARGS
,
373 "S.is_mydomain(name) -> bool\n"
374 "Check whether the specified name matches our domain name." },
375 { "get", py_lp_ctx_get
, METH_VARARGS
,
376 "S.get(name, service_name) -> value\n"
377 "Find specified parameter." },
378 { "set", py_lp_ctx_set
, METH_VARARGS
,
379 "S.set(name, value) -> bool\n"
380 "Change a parameter." },
381 { "private_path", py_lp_ctx_private_path
, METH_VARARGS
,
382 "S.private_path(name) -> path\n" },
383 { "services", py_lp_ctx_services
, METH_NOARGS
,
384 "S.services() -> list" },
385 { "server_role", py_lp_ctx_server_role
, METH_NOARGS
,
386 "S.server_role() -> value\n"
387 "Get the server role." },
388 { "dump", py_lp_dump
, METH_VARARGS
,
389 "S.dump(show_defaults=False, file_name='', mode='w')" },
390 { "dump_a_parameter", py_lp_dump_a_parameter
, METH_VARARGS
,
391 "S.dump_a_parameter(name, service_name, file_name='', mode='w')" },
392 { "log_level", py_lp_log_level
, METH_NOARGS
,
393 "S.log_level() -> int\n Get the active log level" },
394 { "samdb_url", py_samdb_url
, METH_NOARGS
,
395 "S.samdb_url() -> string\n"
396 "Returns the current URL for sam.ldb." },
400 static PyObject
*py_lp_ctx_default_service(PyObject
*self
, void *closure
)
402 return PyLoadparmService_FromService(lpcfg_default_service(PyLoadparmContext_AsLoadparmContext(self
)));
405 static PyObject
*py_lp_ctx_config_file(PyObject
*self
, void *closure
)
407 const char *configfile
= lpcfg_configfile(PyLoadparmContext_AsLoadparmContext(self
));
408 if (configfile
== NULL
)
411 return PyStr_FromString(configfile
);
414 static PyGetSetDef py_lp_ctx_getset
[] = {
415 { discard_const_p(char, "default_service"), (getter
)py_lp_ctx_default_service
, NULL
, NULL
},
416 { discard_const_p(char, "configfile"), (getter
)py_lp_ctx_config_file
, NULL
,
417 discard_const_p(char, "Name of last config file that was loaded.") },
421 static PyObject
*py_lp_ctx_new(PyTypeObject
*type
, PyObject
*args
, PyObject
*kwargs
)
423 return pytalloc_reference(type
, loadparm_init_global(false));
426 static Py_ssize_t
py_lp_ctx_len(PyObject
*self
)
428 return lpcfg_numservices(PyLoadparmContext_AsLoadparmContext(self
));
431 static PyObject
*py_lp_ctx_getitem(PyObject
*self
, PyObject
*name
)
433 struct loadparm_service
*service
;
434 if (!PyStr_Check(name
)) {
435 PyErr_SetString(PyExc_TypeError
, "Only string subscripts are supported");
438 service
= lpcfg_service(PyLoadparmContext_AsLoadparmContext(self
), PyStr_AsString(name
));
439 if (service
== NULL
) {
440 PyErr_SetString(PyExc_KeyError
, "No such section");
443 return PyLoadparmService_FromService(service
);
446 static PyMappingMethods py_lp_ctx_mapping
= {
447 .mp_length
= (lenfunc
)py_lp_ctx_len
,
448 .mp_subscript
= (binaryfunc
)py_lp_ctx_getitem
,
451 PyTypeObject PyLoadparmContext
= {
452 .tp_name
= "param.LoadParm",
453 .tp_getset
= py_lp_ctx_getset
,
454 .tp_methods
= py_lp_ctx_methods
,
455 .tp_new
= py_lp_ctx_new
,
456 .tp_as_mapping
= &py_lp_ctx_mapping
,
457 .tp_flags
= Py_TPFLAGS_DEFAULT
,
460 static PyObject
*py_lp_service_dump(PyObject
*self
, PyObject
*args
)
462 bool show_defaults
= false;
464 const char *file_name
= "";
465 const char *mode
= "w";
466 struct loadparm_service
*service
= PyLoadparmService_AsLoadparmService(self
);
467 struct loadparm_service
*default_service
;
468 PyObject
*py_default_service
;
470 if (!PyArg_ParseTuple(args
, "O|bss", &py_default_service
, &show_defaults
, &file_name
, &mode
))
473 if (file_name
[0] == '\0') {
476 f
= fopen(file_name
, mode
);
483 if (!PyObject_TypeCheck(py_default_service
, &PyLoadparmService
)) {
484 PyErr_SetNone(PyExc_TypeError
);
491 default_service
= PyLoadparmService_AsLoadparmService(py_default_service
);
493 lpcfg_dump_one(f
, show_defaults
, service
, default_service
);
502 static PyMethodDef py_lp_service_methods
[] = {
503 { "dump", (PyCFunction
)py_lp_service_dump
, METH_VARARGS
,
504 "S.dump(default_service, show_defaults=False, file_name='', mode='w')" },
508 PyTypeObject PyLoadparmService
= {
509 .tp_name
= "param.LoadparmService",
510 .tp_methods
= py_lp_service_methods
,
511 .tp_flags
= Py_TPFLAGS_DEFAULT
,
514 static PyObject
*py_default_path(PyObject
*self
)
516 return PyStr_FromString(lp_default_path());
519 static PyObject
*py_setup_dir(PyObject
*self
)
521 return PyStr_FromString(dyn_SETUPDIR
);
524 static PyObject
*py_modules_dir(PyObject
*self
)
526 return PyStr_FromString(dyn_MODULESDIR
);
529 static PyObject
*py_bin_dir(PyObject
*self
)
531 return PyStr_FromString(dyn_BINDIR
);
534 static PyObject
*py_sbin_dir(PyObject
*self
)
536 return PyStr_FromString(dyn_SBINDIR
);
539 static PyMethodDef pyparam_methods
[] = {
540 { "default_path", (PyCFunction
)py_default_path
, METH_NOARGS
,
541 "Returns the default smb.conf path." },
542 { "setup_dir", (PyCFunction
)py_setup_dir
, METH_NOARGS
,
543 "Returns the compiled in location of provision tempates." },
544 { "modules_dir", (PyCFunction
)py_modules_dir
, METH_NOARGS
,
545 "Returns the compiled in location of modules." },
546 { "bin_dir", (PyCFunction
)py_bin_dir
, METH_NOARGS
,
547 "Returns the compiled in BINDIR." },
548 { "sbin_dir", (PyCFunction
)py_sbin_dir
, METH_NOARGS
,
549 "Returns the compiled in SBINDIR." },
553 static struct PyModuleDef moduledef
= {
554 PyModuleDef_HEAD_INIT
,
556 .m_doc
= "Parsing and writing Samba configuration files.",
558 .m_methods
= pyparam_methods
,
561 MODULE_INIT_FUNC(param
)
564 PyTypeObject
*talloc_type
= pytalloc_GetObjectType();
565 if (talloc_type
== NULL
)
568 if (pytalloc_BaseObject_PyType_Ready(&PyLoadparmContext
) < 0)
571 if (pytalloc_BaseObject_PyType_Ready(&PyLoadparmService
) < 0)
574 m
= PyModule_Create(&moduledef
);
578 Py_INCREF(&PyLoadparmContext
);
579 PyModule_AddObject(m
, "LoadParm", (PyObject
*)&PyLoadparmContext
);