python/loadparm: Get shares listing working.
[Samba.git] / source4 / param / pyparam.c
blob37e882e1cc876433aa1e1b89902341f320c6807e
1 /*
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/>.
20 #include <stdint.h>
21 #include <stdbool.h>
23 #include "includes.h"
24 #include "param/param.h"
25 #include "param/loadparm.h"
26 #include <Python.h>
27 #include "pytalloc.h"
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
35 #ifndef Py_RETURN_NONE
36 #define Py_RETURN_NONE return Py_INCREF(Py_None), Py_None
37 #endif
39 #define PyLoadparmContext_AsLoadparmContext(obj) py_talloc_get_type(obj, struct loadparm_context)
41 PyAPI_DATA(PyTypeObject) PyLoadparmContext;
42 PyAPI_DATA(PyTypeObject) PyLoadparmService;
44 PyObject *PyLoadparmService_FromService(struct loadparm_service *service)
46 return py_talloc_reference(&PyLoadparmService, service);
49 static PyObject *py_lp_ctx_get_helper(struct loadparm_context *lp_ctx, const char *service_name, const char *param_name)
51 struct parm_struct *parm = NULL;
52 void *parm_ptr = NULL;
53 int i;
55 if (service_name != NULL) {
56 struct loadparm_service *service;
57 /* its a share parameter */
58 service = lp_service(lp_ctx, service_name);
59 if (service == NULL) {
60 return NULL;
62 if (strchr(param_name, ':')) {
63 /* its a parametric option on a share */
64 const char *type = talloc_strndup(lp_ctx,
65 param_name,
66 strcspn(param_name, ":"));
67 const char *option = strchr(param_name, ':') + 1;
68 const char *value;
69 if (type == NULL || option == NULL) {
70 return NULL;
72 value = lp_get_parametric(lp_ctx, service, type, option);
73 if (value == NULL) {
74 return NULL;
76 return PyString_FromString(value);
79 parm = lp_parm_struct(param_name);
80 if (parm == NULL || parm->pclass == P_GLOBAL) {
81 return NULL;
83 parm_ptr = lp_parm_ptr(lp_ctx, service, parm);
84 } else if (strchr(param_name, ':')) {
85 /* its a global parametric option */
86 const char *type = talloc_strndup(lp_ctx,
87 param_name, strcspn(param_name, ":"));
88 const char *option = strchr(param_name, ':') + 1;
89 const char *value;
90 if (type == NULL || option == NULL) {
91 return NULL;
93 value = lp_get_parametric(lp_ctx, NULL, type, option);
94 if (value == NULL)
95 return NULL;
96 return PyString_FromString(value);
97 } else {
98 /* its a global parameter */
99 parm = lp_parm_struct(param_name);
100 if (parm == NULL) {
101 return NULL;
103 parm_ptr = lp_parm_ptr(lp_ctx, NULL, parm);
106 if (parm == NULL || parm_ptr == NULL) {
107 return NULL;
110 /* construct and return the right type of python object */
111 switch (parm->type) {
112 case P_STRING:
113 case P_USTRING:
114 return PyString_FromString(*(char **)parm_ptr);
115 case P_BOOL:
116 return PyBool_FromLong(*(bool *)parm_ptr);
117 case P_INTEGER:
118 case P_OCTAL:
119 case P_BYTES:
120 return PyLong_FromLong(*(int *)parm_ptr);
121 case P_ENUM:
122 for (i=0; parm->enum_list[i].name; i++) {
123 if (*(int *)parm_ptr == parm->enum_list[i].value) {
124 return PyString_FromString(parm->enum_list[i].name);
127 return NULL;
128 case P_LIST:
130 int j;
131 const char **strlist = *(const char ***)parm_ptr;
132 PyObject *pylist = PyList_New(str_list_length(strlist));
133 for (j = 0; strlist[j]; j++)
134 PyList_SetItem(pylist, j,
135 PyString_FromString(strlist[j]));
136 return pylist;
139 break;
141 return NULL;
145 static PyObject *py_lp_ctx_load(py_talloc_Object *self, PyObject *args)
147 char *filename;
148 bool ret;
149 if (!PyArg_ParseTuple(args, "s", &filename))
150 return NULL;
152 ret = lp_load(PyLoadparmContext_AsLoadparmContext(self), filename);
154 if (!ret) {
155 PyErr_Format(PyExc_RuntimeError, "Unable to load file %s", filename);
156 return NULL;
158 Py_RETURN_NONE;
161 static PyObject *py_lp_ctx_load_default(py_talloc_Object *self)
163 bool ret;
164 ret = lp_load_default(PyLoadparmContext_AsLoadparmContext(self));
166 if (!ret) {
167 PyErr_SetString(PyExc_RuntimeError, "Unable to load default file");
168 return NULL;
170 Py_RETURN_NONE;
173 static PyObject *py_lp_ctx_get(py_talloc_Object *self, PyObject *args)
175 char *param_name;
176 char *section_name = NULL;
177 PyObject *ret;
178 if (!PyArg_ParseTuple(args, "s|s", &param_name, &section_name))
179 return NULL;
181 ret = py_lp_ctx_get_helper(PyLoadparmContext_AsLoadparmContext(self), section_name, param_name);
182 if (ret == NULL)
183 Py_RETURN_NONE;
184 return ret;
187 static PyObject *py_lp_ctx_is_myname(py_talloc_Object *self, PyObject *args)
189 char *name;
190 if (!PyArg_ParseTuple(args, "s", &name))
191 return NULL;
193 return PyBool_FromLong(lp_is_myname(PyLoadparmContext_AsLoadparmContext(self), name));
196 static PyObject *py_lp_ctx_is_mydomain(py_talloc_Object *self, PyObject *args)
198 char *name;
199 if (!PyArg_ParseTuple(args, "s", &name))
200 return NULL;
202 return PyBool_FromLong(lp_is_mydomain(PyLoadparmContext_AsLoadparmContext(self), name));
205 static PyObject *py_lp_ctx_set(py_talloc_Object *self, PyObject *args)
207 char *name, *value;
208 bool ret;
209 if (!PyArg_ParseTuple(args, "ss", &name, &value))
210 return NULL;
212 ret = lp_set_cmdline(PyLoadparmContext_AsLoadparmContext(self), name, value);
213 if (!ret) {
214 PyErr_SetString(PyExc_RuntimeError, "Unable to set parameter");
215 return NULL;
218 Py_RETURN_NONE;
221 static PyObject *py_lp_ctx_private_path(py_talloc_Object *self, PyObject *args)
223 char *name, *path;
224 PyObject *ret;
225 if (!PyArg_ParseTuple(args, "s", &name))
226 return NULL;
228 path = private_path(NULL, PyLoadparmContext_AsLoadparmContext(self), name);
229 ret = PyString_FromString(path);
230 talloc_free(path);
232 return ret;
235 static PyObject *py_lp_ctx_services(py_talloc_Object *self)
237 struct loadparm_context *lp_ctx = PyLoadparmContext_AsLoadparmContext(self);
238 PyObject *ret;
239 int i;
240 ret = PyList_New(lp_numservices(lp_ctx));
241 for (i = 0; i < lp_numservices(lp_ctx); i++) {
242 struct loadparm_service *service = lp_servicebynum(lp_ctx, i);
243 if (service != NULL) {
244 PyList_SetItem(ret, i, PyString_FromString(lp_servicename(service)));
247 return ret;
250 static PyMethodDef py_lp_ctx_methods[] = {
251 { "load", (PyCFunction)py_lp_ctx_load, METH_VARARGS,
252 "S.load(filename) -> None\n"
253 "Load specified file." },
254 { "load_default", (PyCFunction)py_lp_ctx_load_default, METH_NOARGS,
255 "S.load_default() -> None\n"
256 "Load default smb.conf file." },
257 { "is_myname", (PyCFunction)py_lp_ctx_is_myname, METH_VARARGS,
258 "S.is_myname(name) -> bool\n"
259 "Check whether the specified name matches one of our netbios names." },
260 { "is_mydomain", (PyCFunction)py_lp_ctx_is_mydomain, METH_VARARGS,
261 "S.is_mydomain(name) -> bool\n"
262 "Check whether the specified name matches our domain name." },
263 { "get", (PyCFunction)py_lp_ctx_get, METH_VARARGS,
264 "S.get(name, service_name) -> value\n"
265 "Find specified parameter." },
266 { "set", (PyCFunction)py_lp_ctx_set, METH_VARARGS,
267 "S.set(name, value) -> bool\n"
268 "Change a parameter." },
269 { "private_path", (PyCFunction)py_lp_ctx_private_path, METH_VARARGS,
270 "S.private_path(name) -> path\n" },
271 { "services", (PyCFunction)py_lp_ctx_services, METH_NOARGS,
272 "S.services() -> list" },
273 { NULL }
276 static PyObject *py_lp_ctx_default_service(py_talloc_Object *self, void *closure)
278 return PyLoadparmService_FromService(lp_default_service(PyLoadparmContext_AsLoadparmContext(self)));
281 static PyObject *py_lp_ctx_config_file(py_talloc_Object *self, void *closure)
283 const char *configfile = lp_configfile(PyLoadparmContext_AsLoadparmContext(self));
284 if (configfile == NULL)
285 Py_RETURN_NONE;
286 else
287 return PyString_FromString(configfile);
290 static PyGetSetDef py_lp_ctx_getset[] = {
291 { discard_const_p(char, "default_service"), (getter)py_lp_ctx_default_service, NULL, NULL },
292 { discard_const_p(char, "configfile"), (getter)py_lp_ctx_config_file, NULL,
293 discard_const_p(char, "Name of last config file that was loaded.") },
294 { NULL }
297 static PyObject *py_lp_ctx_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
299 py_talloc_Object *ret = (py_talloc_Object *)type->tp_alloc(type, 0);
300 if (ret == NULL) {
301 PyErr_NoMemory();
302 return NULL;
304 ret->talloc_ctx = talloc_new(NULL);
305 if (ret->talloc_ctx == NULL) {
306 PyErr_NoMemory();
307 return NULL;
309 ret->ptr = loadparm_init(ret->talloc_ctx);
310 return (PyObject *)ret;
313 static Py_ssize_t py_lp_ctx_len(py_talloc_Object *self)
315 return lp_numservices(PyLoadparmContext_AsLoadparmContext(self));
318 static PyObject *py_lp_ctx_getitem(py_talloc_Object *self, PyObject *name)
320 struct loadparm_service *service;
321 if (!PyString_Check(name)) {
322 PyErr_SetString(PyExc_TypeError, "Only string subscripts are supported");
323 return NULL;
325 service = lp_service(PyLoadparmContext_AsLoadparmContext(self), PyString_AsString(name));
326 if (service == NULL) {
327 PyErr_SetString(PyExc_KeyError, "No such section");
328 return NULL;
330 return PyLoadparmService_FromService(service);
333 static PyMappingMethods py_lp_ctx_mapping = {
334 .mp_length = (lenfunc)py_lp_ctx_len,
335 .mp_subscript = (binaryfunc)py_lp_ctx_getitem,
338 PyTypeObject PyLoadparmContext = {
339 .tp_name = "LoadParm",
340 .tp_basicsize = sizeof(py_talloc_Object),
341 .tp_dealloc = py_talloc_dealloc,
342 .tp_getset = py_lp_ctx_getset,
343 .tp_methods = py_lp_ctx_methods,
344 .tp_new = py_lp_ctx_new,
345 .tp_as_mapping = &py_lp_ctx_mapping,
346 .tp_flags = Py_TPFLAGS_DEFAULT,
349 PyTypeObject PyLoadparmService = {
350 .tp_name = "LoadparmService",
351 .tp_dealloc = py_talloc_dealloc,
352 .tp_basicsize = sizeof(py_talloc_Object),
353 .tp_flags = Py_TPFLAGS_DEFAULT,
356 static PyObject *py_default_path(PyObject *self)
358 return PyString_FromString(lp_default_path());
361 static PyMethodDef pyparam_methods[] = {
362 { "default_path", (PyCFunction)py_default_path, METH_NOARGS,
363 "Returns the default smb.conf path." },
364 { NULL }
367 void initparam(void)
369 PyObject *m;
371 if (PyType_Ready(&PyLoadparmContext) < 0)
372 return;
374 m = Py_InitModule3("param", pyparam_methods, "Parsing and writing Samba configuration files.");
375 if (m == NULL)
376 return;
378 Py_INCREF(&PyLoadparmContext);
379 PyModule_AddObject(m, "LoadParm", (PyObject *)&PyLoadparmContext);