s3:vfs_aixacl2: make use of vfs_aixacl_util.h
[Samba/gebeck_regimport.git] / source4 / web_server / wsgi.c
blob00c9535cac4388f85eb740e170d9d50fe93fd968
1 /*
2 Unix SMB/CIFS implementation.
3 Samba utility functions
4 Copyright © Jelmer Vernooij <jelmer@samba.org> 2008
6 Implementation of the WSGI interface described in PEP0333
7 (http://www.python.org/dev/peps/pep-0333)
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>.
23 #include <Python.h>
24 #include "includes.h"
25 #include "web_server/web_server.h"
26 #include "../lib/util/dlinklist.h"
27 #include "lib/tls/tls.h"
28 #include "lib/tsocket/tsocket.h"
29 #include "scripting/python/modules.h"
31 /* There's no Py_ssize_t in 2.4, apparently */
32 #if PY_MAJOR_VERSION == 2 && PY_MINOR_VERSION < 5
33 typedef int Py_ssize_t;
34 typedef inquiry lenfunc;
35 typedef intargfunc ssizeargfunc;
36 #endif
38 typedef struct {
39 PyObject_HEAD
40 struct websrv_context *web;
41 } web_request_Object;
43 static PyObject *start_response(PyObject *self, PyObject *args, PyObject *kwargs)
45 PyObject *response_header, *exc_info = NULL;
46 char *status;
47 Py_ssize_t i;
48 const char *kwnames[] = {
49 "status", "response_header", "exc_info", NULL
51 web_request_Object *py_web = (web_request_Object *)self;
52 struct websrv_context *web = py_web->web;
53 struct http_header *headers = NULL;
55 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "sO|O:start_response", discard_const_p(char *, kwnames), &status, &response_header, &exc_info)) {
56 return NULL;
59 /* FIXME: exc_info */
61 if (!PyList_Check(response_header)) {
62 PyErr_SetString(PyExc_TypeError, "response_header should be list");
63 return NULL;
66 for (i = 0; i < PyList_Size(response_header); i++) {
67 struct http_header *hdr = talloc_zero(web, struct http_header);
68 PyObject *item = PyList_GetItem(response_header, i);
69 PyObject *py_name, *py_value;
71 if (!PyTuple_Check(item)) {
72 PyErr_SetString(PyExc_TypeError, "Expected tuple");
73 return NULL;
76 if (PyTuple_Size(item) != 2) {
77 PyErr_SetString(PyExc_TypeError, "header tuple has invalid size, expected 2");
78 return NULL;
81 py_name = PyTuple_GetItem(item, 0);
83 if (!PyString_Check(py_name)) {
84 PyErr_SetString(PyExc_TypeError, "header name should be string");
85 return NULL;
88 py_value = PyTuple_GetItem(item, 1);
89 if (!PyString_Check(py_value)) {
90 PyErr_SetString(PyExc_TypeError, "header value should be string");
91 return NULL;
94 hdr->name = talloc_strdup(hdr, PyString_AsString(py_name));
95 hdr->value = talloc_strdup(hdr, PyString_AsString(py_value));
96 DLIST_ADD(headers, hdr);
99 websrv_output_headers(web, status, headers);
101 Py_RETURN_NONE;
104 static PyMethodDef web_request_methods[] = {
105 { "start_response", (PyCFunction)start_response, METH_VARARGS|METH_KEYWORDS, NULL },
106 { NULL }
110 PyTypeObject web_request_Type = {
111 PyObject_HEAD_INIT(NULL) 0,
112 .tp_name = "wsgi.Request",
113 .tp_methods = web_request_methods,
114 .tp_basicsize = sizeof(web_request_Object),
115 .tp_flags = Py_TPFLAGS_DEFAULT,
118 typedef struct {
119 PyObject_HEAD
120 } error_Stream_Object;
122 static PyObject *py_error_flush(PyObject *self, PyObject *args, PyObject *kwargs)
124 /* Nothing to do here */
125 Py_RETURN_NONE;
128 static PyObject *py_error_write(PyObject *self, PyObject *args, PyObject *kwargs)
130 const char *kwnames[] = { "str", NULL };
131 char *str = NULL;
133 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "s:write", discard_const_p(char *, kwnames), &str)) {
134 return NULL;
137 DEBUG(0, ("WSGI App: %s", str));
139 Py_RETURN_NONE;
142 static PyObject *py_error_writelines(PyObject *self, PyObject *args, PyObject *kwargs)
144 const char *kwnames[] = { "seq", NULL };
145 PyObject *seq = NULL, *item;
147 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O:writelines", discard_const_p(char *, kwnames), &seq)) {
148 return NULL;
151 while ((item = PyIter_Next(seq))) {
152 char *str = PyString_AsString(item);
154 DEBUG(0, ("WSGI App: %s", str));
157 Py_RETURN_NONE;
160 static PyMethodDef error_Stream_methods[] = {
161 { "flush", (PyCFunction)py_error_flush, METH_VARARGS|METH_KEYWORDS, NULL },
162 { "write", (PyCFunction)py_error_write, METH_VARARGS|METH_KEYWORDS, NULL },
163 { "writelines", (PyCFunction)py_error_writelines, METH_VARARGS|METH_KEYWORDS, NULL },
164 { NULL, NULL, 0, NULL }
167 PyTypeObject error_Stream_Type = {
168 PyObject_HEAD_INIT(NULL) 0,
169 .tp_name = "wsgi.ErrorStream",
170 .tp_basicsize = sizeof(error_Stream_Object),
171 .tp_methods = error_Stream_methods,
172 .tp_flags = Py_TPFLAGS_DEFAULT,
175 typedef struct {
176 PyObject_HEAD
177 struct websrv_context *web;
178 size_t offset;
179 } input_Stream_Object;
181 static PyObject *py_input_read(PyObject *_self, PyObject *args, PyObject *kwargs)
183 const char *kwnames[] = { "size", NULL };
184 PyObject *ret;
185 input_Stream_Object *self = (input_Stream_Object *)_self;
186 int size = -1;
188 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|i", discard_const_p(char *, kwnames), &size))
189 return NULL;
191 /* Don't read beyond buffer boundaries */
192 if (size == -1)
193 size = self->web->input.partial.length-self->offset;
194 else
195 size = MIN(size, self->web->input.partial.length-self->offset);
197 ret = PyString_FromStringAndSize((char *)self->web->input.partial.data+self->offset, size);
198 self->offset += size;
200 return ret;
203 static PyObject *py_input_readline(PyObject *_self)
205 /* FIXME */
206 PyErr_SetString(PyExc_NotImplementedError,
207 "readline() not yet implemented");
208 return NULL;
211 static PyObject *py_input_readlines(PyObject *_self, PyObject *args, PyObject *kwargs)
213 const char *kwnames[] = { "hint", NULL };
214 int hint;
216 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|i", discard_const_p(char *, kwnames), &hint))
217 return NULL;
219 /* FIXME */
220 PyErr_SetString(PyExc_NotImplementedError,
221 "readlines() not yet implemented");
222 return NULL;
225 static PyObject *py_input___iter__(PyObject *_self)
227 /* FIXME */
228 PyErr_SetString(PyExc_NotImplementedError,
229 "__iter__() not yet implemented");
230 return NULL;
233 static PyMethodDef input_Stream_methods[] = {
234 { "read", (PyCFunction)py_input_read, METH_VARARGS|METH_KEYWORDS, NULL },
235 { "readline", (PyCFunction)py_input_readline, METH_NOARGS, NULL },
236 { "readlines", (PyCFunction)py_input_readlines, METH_VARARGS|METH_KEYWORDS, NULL },
237 { "__iter__", (PyCFunction)py_input___iter__, METH_NOARGS, NULL },
238 { NULL, NULL, 0, NULL }
241 PyTypeObject input_Stream_Type = {
242 PyObject_HEAD_INIT(NULL) 0,
243 .tp_name = "wsgi.InputStream",
244 .tp_basicsize = sizeof(input_Stream_Object),
245 .tp_methods = input_Stream_methods,
246 .tp_flags = Py_TPFLAGS_DEFAULT,
249 static PyObject *Py_InputHttpStream(struct websrv_context *web)
251 input_Stream_Object *ret = PyObject_New(input_Stream_Object, &input_Stream_Type);
252 ret->web = web;
253 ret->offset = 0;
254 return (PyObject *)ret;
257 static PyObject *Py_ErrorHttpStream(void)
259 error_Stream_Object *ret = PyObject_New(error_Stream_Object, &error_Stream_Type);
260 return (PyObject *)ret;
263 static PyObject *create_environ(bool tls, int content_length, struct http_header *headers, const char *request_method, const char *servername, int serverport, PyObject *inputstream, const char *request_string)
265 PyObject *env;
266 PyObject *py_scheme;
267 PyObject *py_val;
268 struct http_header *hdr;
269 char *questionmark;
271 env = PyDict_New();
272 if (env == NULL) {
273 return NULL;
276 PyDict_SetItemString(env, "wsgi.input", inputstream);
278 py_val = Py_ErrorHttpStream();
279 if (py_val == NULL) goto error;
280 PyDict_SetItemString(env, "wsgi.errors", py_val);
281 Py_DECREF(py_val);
283 py_val = Py_BuildValue("(i,i)", 1, 0);
284 if (py_val == NULL) goto error;
285 PyDict_SetItemString(env, "wsgi.version", py_val);
286 Py_DECREF(py_val);
287 PyDict_SetItemString(env, "wsgi.multithread", Py_False);
288 PyDict_SetItemString(env, "wsgi.multiprocess", Py_False);
289 PyDict_SetItemString(env, "wsgi.run_once", Py_False);
290 py_val = PyString_FromString("HTTP/1.0");
291 if (py_val == NULL) goto error;
292 PyDict_SetItemString(env, "SERVER_PROTOCOL", py_val);
293 Py_DECREF(py_val);
294 if (content_length > 0) {
295 py_val = PyLong_FromLong(content_length);
296 if (py_val == NULL) goto error;
297 PyDict_SetItemString(env, "CONTENT_LENGTH", py_val);
298 Py_DECREF(py_val);
300 py_val = PyString_FromString(request_method);
301 if (py_val == NULL) goto error;
302 PyDict_SetItemString(env, "REQUEST_METHOD", py_val);
303 Py_DECREF(py_val);
305 /* There is always a single wsgi app to which all requests are redirected,
306 * so SCRIPT_NAME will be / */
307 py_val = PyString_FromString("/");
308 if (py_val == NULL) goto error;
309 PyDict_SetItemString(env, "SCRIPT_NAME", py_val);
310 Py_DECREF(py_val);
311 questionmark = strchr(request_string, '?');
312 if (questionmark == NULL) {
313 py_val = PyString_FromString(request_string);
314 if (py_val == NULL) goto error;
315 PyDict_SetItemString(env, "PATH_INFO", py_val);
316 Py_DECREF(py_val);
317 } else {
318 py_val = PyString_FromString(questionmark+1);
319 if (py_val == NULL) goto error;
320 PyDict_SetItemString(env, "QUERY_STRING", py_val);
321 Py_DECREF(py_val);
322 py_val = PyString_FromStringAndSize(request_string, questionmark-request_string);
323 if (py_val == NULL) goto error;
324 PyDict_SetItemString(env, "PATH_INFO", py_val);
325 Py_DECREF(py_val);
328 py_val = PyString_FromString(servername);
329 if (py_val == NULL) goto error;
330 PyDict_SetItemString(env, "SERVER_NAME", py_val);
331 Py_DECREF(py_val);
332 py_val = PyString_FromFormat("%d", serverport);
333 if (py_val == NULL) goto error;
334 PyDict_SetItemString(env, "SERVER_PORT", py_val);
335 Py_DECREF(py_val);
337 for (hdr = headers; hdr; hdr = hdr->next) {
338 char *name;
339 if (!strcasecmp(hdr->name, "Content-Type")) {
340 py_val = PyString_FromString(hdr->value);
341 PyDict_SetItemString(env, "CONTENT_TYPE", py_val);
342 Py_DECREF(py_val);
343 } else {
344 if (asprintf(&name, "HTTP_%s", hdr->name) < 0) {
345 PyErr_NoMemory();
346 goto error;
348 py_val = PyString_FromString(hdr->value);
349 PyDict_SetItemString(env, name, py_val);
350 Py_DECREF(py_val);
351 free(name);
355 if (tls) {
356 py_scheme = PyString_FromString("https");
357 } else {
358 py_scheme = PyString_FromString("http");
360 if (py_scheme == NULL) goto error;
361 PyDict_SetItemString(env, "wsgi.url_scheme", py_scheme);
362 Py_DECREF(py_scheme);
364 return env;
365 error:
366 Py_DECREF(env);
367 return NULL;
370 static void wsgi_process_http_input(struct web_server_data *wdata,
371 struct websrv_context *web)
373 PyObject *py_environ, *result, *item, *iter;
374 PyObject *request_handler = (PyObject *)wdata->private_data;
375 struct tsocket_address *my_address = web->conn->local_address;
376 const char *addr = "0.0.0.0";
377 uint16_t port = 0;
378 web_request_Object *py_web;
379 PyObject *py_input_stream;
381 py_web = PyObject_New(web_request_Object, &web_request_Type);
382 if (py_web == NULL) {
383 DEBUG(0, ("Unable to allocate web request"));
384 return;
386 py_web->web = web;
388 if (tsocket_address_is_inet(my_address, "ip")) {
389 addr = tsocket_address_inet_addr_string(my_address, wdata);
390 port = tsocket_address_inet_port(my_address);
393 py_input_stream = Py_InputHttpStream(web);
394 if (py_input_stream == NULL) {
395 DEBUG(0, ("unable to create python input stream"));
396 return;
399 py_environ = create_environ(tls_enabled(web->conn->socket),
400 web->input.content_length,
401 web->input.headers,
402 web->input.post_request?"POST":"GET",
403 addr,
404 port,
405 py_input_stream,
406 web->input.url
409 Py_DECREF(py_input_stream);
411 if (py_environ == NULL) {
412 DEBUG(0, ("Unable to create WSGI environment object\n"));
413 return;
416 result = PyObject_CallMethod(request_handler, discard_const_p(char, "__call__"), discard_const_p(char, "OO"),
417 py_environ, PyObject_GetAttrString((PyObject *)py_web, "start_response"));
419 if (result == NULL) {
420 DEBUG(0, ("error while running WSGI code\n"));
421 return;
424 iter = PyObject_GetIter(result);
425 Py_DECREF(result);
427 if (iter == NULL) {
428 DEBUG(0, ("wsgi application did not return iterable\n"));
429 return;
432 /* Now, iter over all the data returned */
434 while ((item = PyIter_Next(iter))) {
435 websrv_output(web, PyString_AsString(item), PyString_Size(item));
436 Py_DECREF(item);
439 Py_DECREF(iter);
442 bool wsgi_initialize(struct web_server_data *wdata)
444 PyObject *py_web_server;
446 Py_Initialize();
448 py_update_path(); /* Ensure that we have the Samba paths at
449 * the start of the sys.path() */
451 if (PyType_Ready(&web_request_Type) < 0)
452 return false;
454 if (PyType_Ready(&input_Stream_Type) < 0)
455 return false;
457 if (PyType_Ready(&error_Stream_Type) < 0)
458 return false;
460 wdata->http_process_input = wsgi_process_http_input;
461 py_web_server = PyImport_ImportModule("samba.web_server");
462 if (py_web_server == NULL) {
463 DEBUG(0, ("Unable to find web server\n"));
464 return false;
466 wdata->private_data = py_web_server;
467 return true;