source4/web_server/wsgi.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Samba utility functions
   4    Copyright © Jelmer Vernooij <jelmer@samba.org> 2008
   5
   6    Implementation of the WSGI interface described in PEP0333
   7    (http://www.python.org/dev/peps/pep-0333)
   8
   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.
  13
  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.
  18
  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/>.
  21 */
  22
  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"
  30
  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
  37
  38 typedef struct {
  39         PyObject_HEAD
  40         struct websrv_context *web;
  41 } web_request_Object;
  42
  43 static PyObject *start_response(PyObject *self, PyObject *args, PyObject *kwargs)
  44 {
  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
  50         };
  51         web_request_Object *py_web = (web_request_Object *)self;
  52         struct websrv_context *web = py_web->web;
  53         struct http_header *headers = NULL;
  54
  55         if (!PyArg_ParseTupleAndKeywords(args, kwargs, "sO|O:start_response", discard_const_p(char *, kwnames), &status, &response_header, &exc_info)) {
  56                 return NULL;
  57         }
  58
  59         /* FIXME: exc_info */
  60
  61         if (!PyList_Check(response_header)) {
  62                 PyErr_SetString(PyExc_TypeError, "response_header should be list");
  63                 return NULL;
  64         }
  65
  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;
  70
  71                 if (!PyTuple_Check(item)) {
  72                         PyErr_SetString(PyExc_TypeError, "Expected tuple");
  73                         return NULL;
  74                 }
  75
  76                 if (PyTuple_Size(item) != 2) {
  77                         PyErr_SetString(PyExc_TypeError, "header tuple has invalid size, expected 2");
  78                         return NULL;
  79                 }
  80
  81                 py_name = PyTuple_GetItem(item, 0);
  82
  83                 if (!PyString_Check(py_name)) {
  84                         PyErr_SetString(PyExc_TypeError, "header name should be string");
  85                         return NULL;
  86                 }
  87
  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;
  92                 }
  93
  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);
  97         }
  98
  99         websrv_output_headers(web, status, headers);
 100
 101         Py_RETURN_NONE;
 102 }
 103
 104 static PyMethodDef web_request_methods[] = {
 105         { "start_response", (PyCFunction)start_response, METH_VARARGS|METH_KEYWORDS, NULL },
 106         { NULL }
 107 };
 108
 109
 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,
 116 };
 117
 118 typedef struct {
 119         PyObject_HEAD
 120 } error_Stream_Object;
 121
 122 static PyObject *py_error_flush(PyObject *self, PyObject *args, PyObject *kwargs)
 123 {
 124         /* Nothing to do here */
 125         Py_RETURN_NONE;
 126 }
 127
 128 static PyObject *py_error_write(PyObject *self, PyObject *args, PyObject *kwargs)
 129 {
 130         const char *kwnames[] = { "str", NULL };
 131         char *str = NULL;
 132
 133         if (!PyArg_ParseTupleAndKeywords(args, kwargs, "s:write", discard_const_p(char *, kwnames), &str)) {
 134                 return NULL;
 135         }
 136
 137         DEBUG(0, ("WSGI App: %s", str));
 138
 139         Py_RETURN_NONE;
 140 }
 141
 142 static PyObject *py_error_writelines(PyObject *self, PyObject *args, PyObject *kwargs)
 143 {
 144         const char *kwnames[] = { "seq", NULL };
 145         PyObject *seq = NULL, *item;
 146
 147         if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O:writelines", discard_const_p(char *, kwnames), &seq)) {
 148                 return NULL;
 149         }
 150
 151         while ((item = PyIter_Next(seq))) {
 152                 char *str = PyString_AsString(item);
 153
 154                 DEBUG(0, ("WSGI App: %s", str));
 155         }
 156
 157         Py_RETURN_NONE;
 158 }
 159
 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 }
 165 };
 166
 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,
 173 };
 174
 175 typedef struct {
 176         PyObject_HEAD
 177         struct websrv_context *web;
 178         size_t offset;
 179 } input_Stream_Object;
 180
 181 static PyObject *py_input_read(PyObject *_self, PyObject *args, PyObject *kwargs)
 182 {
 183         const char *kwnames[] = { "size", NULL };
 184         PyObject *ret;
 185         input_Stream_Object *self = (input_Stream_Object *)_self;
 186         int size = -1;
 187
 188         if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|i", discard_const_p(char *, kwnames), &size))
 189                 return NULL;
 190
 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);
 196
 197         ret = PyString_FromStringAndSize((char *)self->web->input.partial.data+self->offset, size);
 198         self->offset += size;
 199
 200         return ret;
 201 }
 202
 203 static PyObject *py_input_readline(PyObject *_self)
 204 {
 205         /* FIXME */
 206         PyErr_SetString(PyExc_NotImplementedError,
 207                         "readline() not yet implemented");
 208         return NULL;
 209 }
 210
 211 static PyObject *py_input_readlines(PyObject *_self, PyObject *args, PyObject *kwargs)
 212 {
 213         const char *kwnames[] = { "hint", NULL };
 214         int hint;
 215
 216         if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|i", discard_const_p(char *, kwnames), &hint))
 217                 return NULL;
 218
 219         /* FIXME */
 220         PyErr_SetString(PyExc_NotImplementedError,
 221                         "readlines() not yet implemented");
 222         return NULL;
 223 }
 224
 225 static PyObject *py_input___iter__(PyObject *_self)
 226 {
 227         /* FIXME */
 228         PyErr_SetString(PyExc_NotImplementedError,
 229                         "__iter__() not yet implemented");
 230         return NULL;
 231 }
 232
 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 }
 239 };
 240
 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,
 247 };
 248
 249 static PyObject *Py_InputHttpStream(struct websrv_context *web)
 250 {
 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;
 255 }
 256
 257 static PyObject *Py_ErrorHttpStream(void)
 258 {
 259         error_Stream_Object *ret = PyObject_New(error_Stream_Object, &error_Stream_Type);
 260         return (PyObject *)ret;
 261 }
 262
 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)
 264 {
 265         PyObject *env;
 266         PyObject *errorstream;
 267         PyObject *py_scheme;
 268         struct http_header *hdr;
 269         char *questionmark;
 270
 271         env = PyDict_New();
 272         if (env == NULL) {
 273                 return NULL;
 274         }
 275
 276         errorstream = Py_ErrorHttpStream();
 277         if (errorstream == NULL) {
 278                 Py_DECREF(env);
 279                 Py_DECREF(inputstream);
 280                 return NULL;
 281         }
 282
 283         PyDict_SetItemString(env, "wsgi.input", inputstream);
 284         PyDict_SetItemString(env, "wsgi.errors", errorstream);
 285         PyDict_SetItemString(env, "wsgi.version", Py_BuildValue("(i,i)", 1, 0));
 286         PyDict_SetItemString(env, "wsgi.multithread", Py_False);
 287         PyDict_SetItemString(env, "wsgi.multiprocess", Py_True);
 288         PyDict_SetItemString(env, "wsgi.run_once", Py_False);
 289         PyDict_SetItemString(env, "SERVER_PROTOCOL", PyString_FromString("HTTP/1.0"));
 290         if (content_length > 0) {
 291                 PyDict_SetItemString(env, "CONTENT_LENGTH", PyLong_FromLong(content_length));
 292         }
 293         PyDict_SetItemString(env, "REQUEST_METHOD", PyString_FromString(request_method));
 294
 295         questionmark = strchr(request_string, '?');
 296         if (questionmark == NULL) {
 297                 PyDict_SetItemString(env, "SCRIPT_NAME", PyString_FromString(request_string));
 298         } else {
 299                 PyDict_SetItemString(env, "QUERY_STRING", PyString_FromString(questionmark+1));
 300                 PyDict_SetItemString(env, "SCRIPT_NAME", PyString_FromStringAndSize(request_string, questionmark-request_string));
 301         }
 302
 303         PyDict_SetItemString(env, "SERVER_NAME", PyString_FromString(servername));
 304         PyDict_SetItemString(env, "SERVER_PORT", PyInt_FromLong(serverport));
 305         for (hdr = headers; hdr; hdr = hdr->next) {
 306                 char *name;
 307                 if (!strcasecmp(hdr->name, "Content-Type")) {
 308                         PyDict_SetItemString(env, "CONTENT_TYPE", PyString_FromString(hdr->value));
 309                 } else {
 310                         if (asprintf(&name, "HTTP_%s", hdr->name) < 0) {
 311                                 Py_DECREF(env);
 312                                 Py_DECREF(inputstream);
 313                                 PyErr_NoMemory();
 314                                 return NULL;
 315                         }
 316                         PyDict_SetItemString(env, name, PyString_FromString(hdr->value));
 317                         free(name);
 318                 }
 319         }
 320
 321         if (tls) {
 322                 py_scheme = PyString_FromString("https");
 323         } else {
 324                 py_scheme = PyString_FromString("http");
 325         }
 326         PyDict_SetItemString(env, "wsgi.url_scheme", py_scheme);
 327
 328         return env;
 329 }
 330
 331 static void wsgi_process_http_input(struct web_server_data *wdata,
 332                                     struct websrv_context *web)
 333 {
 334         PyObject *py_environ, *result, *item, *iter;
 335         PyObject *request_handler = (PyObject *)wdata->private_data;
 336         struct tsocket_address *my_address = web->conn->local_address;
 337         const char *addr = "0.0.0.0";
 338         uint16_t port = 0;
 339         web_request_Object *py_web = PyObject_New(web_request_Object, &web_request_Type);
 340         py_web->web = web;
 341
 342         if (tsocket_address_is_inet(my_address, "ip")) {
 343                 addr = tsocket_address_inet_addr_string(my_address, wdata);
 344                 port = tsocket_address_inet_port(my_address);
 345         }
 346
 347         py_environ = create_environ(tls_enabled(web->conn->socket),
 348                                     web->input.content_length,
 349                                     web->input.headers,
 350                                     web->input.post_request?"POST":"GET",
 351                                     addr,
 352                                     port,
 353                                     Py_InputHttpStream(web),
 354                                     web->input.url
 355                                     );
 356         if (py_environ == NULL) {
 357                 DEBUG(0, ("Unable to create WSGI environment object\n"));
 358                 return;
 359         }
 360
 361         result = PyObject_CallMethod(request_handler, discard_const_p(char, "__call__"), discard_const_p(char, "OO"),
 362                                        py_environ, PyObject_GetAttrString((PyObject *)py_web, "start_response"));
 363
 364         if (result == NULL) {
 365                 DEBUG(0, ("error while running WSGI code\n"));
 366                 return;
 367         }
 368
 369         iter = PyObject_GetIter(result);
 370         Py_DECREF(result);
 371
 372         /* Now, iter over all the data returned */
 373
 374         while ((item = PyIter_Next(iter))) {
 375                 websrv_output(web, PyString_AsString(item), PyString_Size(item));
 376                 Py_DECREF(item);
 377         }
 378
 379         Py_DECREF(iter);
 380 }
 381
 382 bool wsgi_initialize(struct web_server_data *wdata)
 383 {
 384         PyObject *py_web_server;
 385
 386         Py_Initialize();
 387
 388         py_update_path(); /* Ensure that we have the Samba paths at
 389                            * the start of the sys.path() */
 390
 391         if (PyType_Ready(&web_request_Type) < 0)
 392                 return false;
 393
 394         if (PyType_Ready(&input_Stream_Type) < 0)
 395                 return false;
 396
 397         if (PyType_Ready(&error_Stream_Type) < 0)
 398                 return false;
 399
 400         wdata->http_process_input = wsgi_process_http_input;
 401         py_web_server = PyImport_ImportModule("samba.web_server");
 402         if (py_web_server == NULL) {
 403                 DEBUG(0, ("Unable to find web server\n"));
 404                 return false;
 405         }
 406         wdata->private_data = py_web_server;
 407         return true;
 408 }