2 * uhttpd - Tiny single-threaded httpd - Lua handler
4 * Copyright (C) 2010-2012 Jo-Philipp Wich <xm@subsignal.org>
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
20 #include "uhttpd-utils.h"
21 #include "uhttpd-lua.h"
24 static int uh_lua_recv(lua_State *L)
28 char buffer[UH_LIMIT_MSGHEAD];
31 int fd = fileno(stdin);
34 length = luaL_checknumber(L, 1);
36 if ((length > 0) && (length <= sizeof(buffer)))
39 rlen = uh_raw_recv(fd, buffer, length, to);
44 lua_pushnumber(L, rlen);
45 lua_pushlstring(L, buffer, rlen);
56 /* no, timeout and actually no data */
59 lua_pushnumber(L, -1);
65 lua_pushnumber(L, -2);
69 static int uh_lua_send_common(lua_State *L, int chunked)
78 int fd = fileno(stdout);
81 buffer = luaL_checklstring(L, 1, &length);
87 snprintf(chunk, sizeof(chunk), "%X\r\n", length);
89 ensure_out(rv = uh_raw_send(fd, chunk, strlen(chunk), to));
92 ensure_out(rv = uh_raw_send(fd, buffer, length, to));
95 ensure_out(rv = uh_raw_send(fd, "\r\n", 2, to));
100 slen = uh_raw_send(fd, "0\r\n\r\n", 5, to);
105 slen = uh_raw_send(fd, buffer, length, to);
109 lua_pushnumber(L, slen);
113 static int uh_lua_send(lua_State *L)
115 return uh_lua_send_common(L, 0);
118 static int uh_lua_sendc(lua_State *L)
120 return uh_lua_send_common(L, 1);
123 static int uh_lua_str2str(lua_State *L, int (*xlate_func) (char *, int, const char *, int))
128 char outbuf[UH_LIMIT_MSGHEAD];
130 inbuf = luaL_checklstring(L, 1, &inlen);
131 outlen = (* xlate_func)(outbuf, sizeof(outbuf), inbuf, inlen);
133 luaL_error(L, "%s on URL-encode codec",
134 (outlen==-1) ? "buffer overflow" : "malformed string");
136 lua_pushlstring(L, outbuf, outlen);
140 static int uh_lua_urldecode(lua_State *L)
142 return uh_lua_str2str( L, uh_urldecode );
146 static int uh_lua_urlencode(lua_State *L)
148 return uh_lua_str2str( L, uh_urlencode );
152 lua_State * uh_lua_init(const struct config *conf)
154 lua_State *L = lua_open();
155 const char *err_str = NULL;
157 /* Load standard libaries */
160 /* build uhttpd api table */
163 /* register global send and receive functions */
164 lua_pushcfunction(L, uh_lua_recv);
165 lua_setfield(L, -2, "recv");
167 lua_pushcfunction(L, uh_lua_send);
168 lua_setfield(L, -2, "send");
170 lua_pushcfunction(L, uh_lua_sendc);
171 lua_setfield(L, -2, "sendc");
173 lua_pushcfunction(L, uh_lua_urldecode);
174 lua_setfield(L, -2, "urldecode");
176 lua_pushcfunction(L, uh_lua_urlencode);
177 lua_setfield(L, -2, "urlencode");
179 /* Pass the document-root to the Lua handler by placing it in
180 ** uhttpd.docroot. It could alternatively be placed in env.DOCUMENT_ROOT
181 ** which would more closely resemble the CGI protocol; but would mean that
182 ** it is not available at the time when the handler-chunk is loaded but
183 ** rather not until the handler is called, without any code savings. */
184 lua_pushstring(L, conf->docroot);
185 lua_setfield(L, -2, "docroot");
187 /* _G.uhttpd = { ... } */
188 lua_setfield(L, LUA_GLOBALSINDEX, "uhttpd");
191 /* load Lua handler */
192 switch (luaL_loadfile(L, conf->lua_handler))
196 "Lua handler contains syntax errors, unable to continue\n");
201 "Lua handler ran out of memory, unable to continue\n");
206 "Lua cannot open the handler script, unable to continue\n");
210 /* compile Lua handler */
211 switch (lua_pcall(L, 0, 0, 0))
214 err_str = luaL_checkstring(L, -1);
216 "Lua handler had runtime error, "
217 "unable to continue\n"
218 "Error: %s\n", err_str);
222 err_str = luaL_checkstring(L, -1);
224 "Lua handler ran out of memory, "
225 "unable to continue\n"
226 "Error: %s\n", err_str);
230 /* test handler function */
231 lua_getglobal(L, UH_LUA_CALLBACK);
233 if (! lua_isfunction(L, -1))
236 "Lua handler provides no "UH_LUA_CALLBACK"(), "
237 "unable to continue\n");
251 static void uh_lua_shutdown(struct uh_lua_state *state)
258 static bool uh_lua_socket_cb(struct client *cl)
261 char buf[UH_LIMIT_MSGHEAD];
263 struct uh_lua_state *state = (struct uh_lua_state *)cl->priv;
265 /* there is unread post data waiting */
266 while (state->content_length > 0)
268 /* remaining data in http head buffer ... */
269 if (state->cl->httpbuf.len > 0)
271 len = min(state->content_length, state->cl->httpbuf.len);
273 D("Lua: Child(%d) feed %d HTTP buffer bytes\n",
274 state->cl->proc.pid, len);
276 memcpy(buf, state->cl->httpbuf.ptr, len);
278 state->cl->httpbuf.len -= len;
279 state->cl->httpbuf.ptr += len;
282 /* read it from socket ... */
285 len = uh_tcp_recv(state->cl, buf,
286 min(state->content_length, sizeof(buf)));
288 if ((len < 0) && ((errno == EAGAIN) || (errno == EWOULDBLOCK)))
291 D("Lua: Child(%d) feed %d/%d TCP socket bytes\n",
292 state->cl->proc.pid, len,
293 min(state->content_length, sizeof(buf)));
297 state->content_length -= len;
299 state->content_length = 0;
301 /* ... write to Lua process */
302 len = uh_raw_send(state->wfd, buf, len,
303 cl->server->conf->script_timeout);
305 /* explicit EOF notification for the child */
306 if (state->content_length <= 0)
310 /* try to read data from child */
311 while ((len = uh_raw_recv(state->rfd, buf, sizeof(buf), -1)) > 0)
313 /* pass through buffer to socket */
314 D("Lua: Child(%d) relaying %d normal bytes\n", state->cl->proc.pid, len);
315 ensure_out(uh_tcp_send(state->cl, buf, len));
316 state->data_sent = true;
319 /* got EOF or read error from child */
321 ((errno != EAGAIN) && (errno != EWOULDBLOCK) && (len == -1)))
323 D("Lua: Child(%d) presumed dead [%s]\n",
324 state->cl->proc.pid, strerror(errno));
332 if (!state->data_sent)
334 if (state->cl->timeout.pending)
335 uh_http_sendhf(state->cl, 502, "Bad Gateway",
336 "The Lua process did not produce any response\n");
338 uh_http_sendhf(state->cl, 504, "Gateway Timeout",
339 "The Lua process took too long to produce a "
343 uh_lua_shutdown(state);
347 bool uh_lua_request(struct client *cl, lua_State *L)
351 const char *prefix = cl->server->conf->lua_prefix;
352 const char *err_str = NULL;
354 int rfd[2] = { 0, 0 };
355 int wfd[2] = { 0, 0 };
359 struct uh_lua_state *state;
360 struct http_request *req = &cl->request;
362 int content_length = cl->httpbuf.len;
366 if (!(state = malloc(sizeof(*state))))
368 uh_client_error(cl, 500, "Internal Server Error", "Out of memory");
372 /* spawn pipes for me->child, child->me */
373 if ((pipe(rfd) < 0) || (pipe(wfd) < 0))
375 if (rfd[0] > 0) close(rfd[0]);
376 if (rfd[1] > 0) close(rfd[1]);
377 if (wfd[0] > 0) close(wfd[0]);
378 if (wfd[1] > 0) close(wfd[1]);
380 uh_client_error(cl, 500, "Internal Server Error",
381 "Failed to create pipe: %s", strerror(errno));
387 switch ((child = fork()))
390 uh_client_error(cl, 500, "Internal Server Error",
391 "Failed to fork child: %s", strerror(errno));
397 sleep(atoi(getenv("UHTTPD_SLEEP_ON_FORK") ?: "0"));
400 /* do not leak parent epoll descriptor */
403 /* close loose pipe ends */
407 /* patch stdout and stdin to pipes */
411 /* avoid leaking our pipe into child-child processes */
415 /* put handler callback on stack */
416 lua_getglobal(L, UH_LUA_CALLBACK);
418 /* build env table */
424 case UH_HTTP_MSG_GET:
425 lua_pushstring(L, "GET");
428 case UH_HTTP_MSG_HEAD:
429 lua_pushstring(L, "HEAD");
432 case UH_HTTP_MSG_POST:
433 lua_pushstring(L, "POST");
437 lua_setfield(L, -2, "REQUEST_METHOD");
440 lua_pushstring(L, req->url);
441 lua_setfield(L, -2, "REQUEST_URI");
444 lua_pushstring(L, cl->server->conf->lua_prefix);
445 lua_setfield(L, -2, "SCRIPT_NAME");
447 /* query string, path info */
448 if ((query_string = strchr(req->url, '?')) != NULL)
450 lua_pushstring(L, query_string + 1);
451 lua_setfield(L, -2, "QUERY_STRING");
453 if ((int)(query_string - req->url) > strlen(prefix))
456 &req->url[strlen(prefix)],
457 (int)(query_string - req->url) - strlen(prefix)
460 lua_setfield(L, -2, "PATH_INFO");
463 else if (strlen(req->url) > strlen(prefix))
465 lua_pushstring(L, &req->url[strlen(prefix)]);
466 lua_setfield(L, -2, "PATH_INFO");
469 /* http protcol version */
470 lua_pushnumber(L, floor(req->version * 10) / 10);
471 lua_setfield(L, -2, "HTTP_VERSION");
473 if (req->version > 1.0)
474 lua_pushstring(L, "HTTP/1.1");
476 lua_pushstring(L, "HTTP/1.0");
478 lua_setfield(L, -2, "SERVER_PROTOCOL");
481 /* address information */
482 lua_pushstring(L, sa_straddr(&cl->peeraddr));
483 lua_setfield(L, -2, "REMOTE_ADDR");
485 lua_pushinteger(L, sa_port(&cl->peeraddr));
486 lua_setfield(L, -2, "REMOTE_PORT");
488 lua_pushstring(L, sa_straddr(&cl->servaddr));
489 lua_setfield(L, -2, "SERVER_ADDR");
491 lua_pushinteger(L, sa_port(&cl->servaddr));
492 lua_setfield(L, -2, "SERVER_PORT");
494 /* essential env vars */
495 foreach_header(i, req->headers)
497 if (!strcasecmp(req->headers[i], "Content-Length"))
499 content_length = atoi(req->headers[i+1]);
501 else if (!strcasecmp(req->headers[i], "Content-Type"))
503 lua_pushstring(L, req->headers[i+1]);
504 lua_setfield(L, -2, "CONTENT_TYPE");
508 lua_pushnumber(L, content_length);
509 lua_setfield(L, -2, "CONTENT_LENGTH");
514 foreach_header(i, req->headers)
516 if( strcasecmp(req->headers[i], "Content-Length") &&
517 strcasecmp(req->headers[i], "Content-Type"))
519 lua_pushstring(L, req->headers[i+1]);
520 lua_setfield(L, -2, req->headers[i]);
524 lua_setfield(L, -2, "headers");
528 switch (lua_pcall(L, 1, 0, 0))
532 err_str = luaL_checkstring(L, -1);
535 err_str = "Unknown error";
537 printf("HTTP/%.1f 500 Internal Server Error\r\n"
538 "Connection: close\r\n"
539 "Content-Type: text/plain\r\n"
540 "Content-Length: %i\r\n\r\n"
541 "Lua raised a runtime error:\n %s\n",
542 req->version, 31 + strlen(err_str), err_str);
556 /* parent; handle I/O relaying */
558 memset(state, 0, sizeof(*state));
561 state->cl->proc.pid = child;
563 /* close unneeded pipe ends */
567 D("Lua: Child(%d) created: rfd(%d) wfd(%d)\n", child, rfd[0], wfd[1]);
569 state->content_length = cl->httpbuf.len;
571 /* find content length */
572 if (req->method == UH_HTTP_MSG_POST)
574 foreach_header(i, req->headers)
576 if (!strcasecmp(req->headers[i], "Content-Length"))
578 state->content_length = atoi(req->headers[i+1]);
585 fd_nonblock(state->rfd);
588 fd_nonblock(state->wfd);
590 cl->cb = uh_lua_socket_cb;
599 void uh_lua_close(lua_State *L)