2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
22 #include <apr_thread_mutex.h>
23 #include <apr_pools.h>
25 #include "lua_config.h"
26 #include "apr_optional.h"
29 #include "util_mutex.h"
32 #ifdef APR_HAS_THREADS
33 #include "apr_thread_proc.h"
37 #if APR_HAVE_SYS_TYPES_H
38 #include <sys/types.h>
44 /* getpid for Windows */
45 #if APR_HAVE_PROCESS_H
49 APR_IMPLEMENT_OPTIONAL_HOOK_RUN_ALL(ap_lua, AP_LUA, int, lua_open,
50 (lua_State *L, apr_pool_t *p),
53 APR_IMPLEMENT_OPTIONAL_HOOK_RUN_ALL(ap_lua, AP_LUA, int, lua_request,
54 (lua_State *L, request_rec *r),
56 static APR_OPTIONAL_FN_TYPE(ssl_var_lookup) *lua_ssl_val = NULL;
57 static APR_OPTIONAL_FN_TYPE(ssl_is_https) *lua_ssl_is_https = NULL;
59 module AP_MODULE_DECLARE_DATA lua_module;
61 #define AP_LUA_HOOK_FIRST (APR_HOOK_FIRST - 1)
62 #define AP_LUA_HOOK_LAST (APR_HOOK_LAST + 1)
66 const char *file_name;
67 const char *function_name;
69 } lua_authz_provider_spec;
72 lua_authz_provider_spec *spec;
73 apr_array_header_t *args;
74 } lua_authz_provider_func;
76 apr_hash_t *lua_authz_providers;
80 apr_bucket_brigade *tmpBucket;
86 apr_global_mutex_t *lua_ivm_mutex;
87 apr_shm_t *lua_ivm_shm;
88 char *lua_ivm_shmfile;
90 static apr_status_t shm_cleanup_wrapper(void *unused) {
92 return apr_shm_destroy(lua_ivm_shm);
98 * error reporting if lua has an error.
99 * Extracts the error from lua stack and prints
101 static void report_lua_error(lua_State *L, request_rec *r)
103 const char *lua_response;
104 r->status = HTTP_INTERNAL_SERVER_ERROR;
105 r->content_type = "text/html";
106 ap_rputs("<h3>Error!</h3>\n", r);
107 ap_rputs("<pre>", r);
108 lua_response = lua_tostring(L, -1);
109 ap_rputs(ap_escape_html(r->pool, lua_response), r);
110 ap_rputs("</pre>\n", r);
112 ap_log_perror(APLOG_MARK, APLOG_WARNING, 0, r->pool, APLOGNO(01471) "Lua error: %s",
116 static void lua_open_callback(lua_State *L, apr_pool_t *p, void *ctx)
119 ap_lua_load_apache2_lmodule(L);
120 ap_lua_load_request_lmodule(L, p);
121 ap_lua_load_config_lmodule(L);
124 static int lua_open_hook(lua_State *L, apr_pool_t *p)
126 lua_open_callback(L, p, NULL);
130 static const char *scope_to_string(unsigned int scope)
133 case AP_LUA_SCOPE_ONCE:
134 case AP_LUA_SCOPE_UNSET:
136 case AP_LUA_SCOPE_REQUEST:
138 case AP_LUA_SCOPE_CONN:
141 case AP_LUA_SCOPE_THREAD:
143 case AP_LUA_SCOPE_SERVER:
152 static void ap_lua_release_state(lua_State* L, ap_lua_vm_spec* spec, request_rec* r) {
154 apr_reslist_t* reslist = NULL;
155 if (spec->scope == AP_LUA_SCOPE_SERVER) {
156 ap_lua_server_spec* sspec = NULL;
158 lua_getfield(L, LUA_REGISTRYINDEX, "Apache2.Lua.server_spec");
159 sspec = (ap_lua_server_spec*) lua_touserdata(L, 1);
160 hash = apr_psprintf(r->pool, "reslist:%s", spec->file);
161 if (apr_pool_userdata_get((void **)&reslist, hash,
162 r->server->process->pool) == APR_SUCCESS) {
163 AP_DEBUG_ASSERT(sspec != NULL);
164 if (reslist != NULL) {
165 apr_reslist_release(reslist, sspec);
171 static ap_lua_vm_spec *create_vm_spec(apr_pool_t **lifecycle_pool,
173 const ap_lua_dir_cfg *cfg,
174 const ap_lua_server_cfg *server_cfg,
175 const char *filename,
176 const char *bytecode,
177 apr_size_t bytecode_len,
178 const char *function,
182 ap_lua_vm_spec *spec = apr_pcalloc(r->pool, sizeof(ap_lua_vm_spec));
184 spec->scope = cfg->vm_scope;
185 spec->pool = r->pool;
186 spec->package_paths = cfg->package_paths;
187 spec->package_cpaths = cfg->package_cpaths;
188 spec->cb = &lua_open_callback;
190 spec->bytecode = bytecode;
191 spec->bytecode_len = bytecode_len;
192 spec->codecache = (cfg->codecache == AP_LUA_CACHE_UNSET) ? AP_LUA_CACHE_STAT : cfg->codecache;
193 spec->vm_min = cfg->vm_min ? cfg->vm_min : 1;
194 spec->vm_max = cfg->vm_max ? cfg->vm_max : 1;
198 apr_filepath_merge(&file, server_cfg->root_path,
199 filename, APR_FILEPATH_NOTRELATIVE, r->pool);
203 spec->file = r->filename;
205 ap_log_rerror(APLOG_MARK, APLOG_TRACE2, 0, r, APLOGNO(02313)
206 "%s details: scope: %s, file: %s, func: %s",
207 what, scope_to_string(spec->scope), spec->file,
208 function ? function : "-");
210 switch (spec->scope) {
211 case AP_LUA_SCOPE_ONCE:
212 case AP_LUA_SCOPE_UNSET:
213 apr_pool_create(&pool, r->pool);
215 case AP_LUA_SCOPE_REQUEST:
218 case AP_LUA_SCOPE_CONN:
219 pool = r->connection->pool;
222 case AP_LUA_SCOPE_THREAD:
223 pool = apr_thread_pool_get(r->connection->current_thread);
225 case AP_LUA_SCOPE_SERVER:
226 pool = r->server->process->pool;
233 *lifecycle_pool = pool;
237 static const char* ap_lua_interpolate_string(apr_pool_t* pool, const char* string, const char** values)
242 srclen = strlen(string);
245 for (x=0; x < srclen; x++) {
246 if (string[x] == '$' && x != srclen-1 && string[x+1] >= '0' && string[x+1] <= '9') {
247 int v = *(string+x+1) - '0';
249 stringBetween = apr_pstrndup(pool, string+y, x-y);
254 ret = apr_pstrcat(pool, ret, stringBetween, values[v], NULL);
259 if (x-y > 0 && y > 0) {
260 stringBetween = apr_pstrndup(pool, string+y, x-y);
261 ret = apr_pstrcat(pool, ret, stringBetween, NULL);
263 /* If no replacement was made, just return the original string */
275 static int lua_handler(request_rec *r)
278 if (strcmp(r->handler, "lua-script")) {
281 /* Decline the request if the script does not exist (or is a directory),
282 * rather than just returning internal server error */
284 (r->finfo.filetype == APR_NOFILE)
285 || (r->finfo.filetype & APR_DIR)
289 ap_log_rerror(APLOG_MARK, APLOG_TRACE1, 0, r, APLOGNO(01472)
290 "handling [%s] in mod_lua", r->filename);
292 /* XXX: This seems wrong because it may generate wrong headers for HEAD requests */
293 if (!r->header_only) {
296 const ap_lua_dir_cfg *cfg = ap_get_module_config(r->per_dir_config,
298 ap_lua_vm_spec *spec = create_vm_spec(&pool, r, cfg, NULL, NULL, NULL,
299 0, "handle", "request handler");
301 L = ap_lua_get_lua_state(pool, spec, r);
303 /* TODO annotate spec with failure reason */
304 r->status = HTTP_INTERNAL_SERVER_ERROR;
305 ap_rputs("Unable to compile VM, see logs", r);
306 ap_lua_release_state(L, spec, r);
307 return HTTP_INTERNAL_SERVER_ERROR;
309 ap_log_rerror(APLOG_MARK, APLOG_TRACE3, 0, r, APLOGNO(01474) "got a vm!");
310 lua_getglobal(L, "handle");
311 if (!lua_isfunction(L, -1)) {
312 ap_log_rerror(APLOG_MARK, APLOG_CRIT, 0, r, APLOGNO(01475)
313 "lua: Unable to find entry function '%s' in %s (not a valid function)",
316 ap_lua_release_state(L, spec, r);
317 return HTTP_INTERNAL_SERVER_ERROR;
319 ap_lua_run_lua_request(L, r);
320 if (lua_pcall(L, 1, 1, 0)) {
321 report_lua_error(L, r);
323 if (lua_isnumber(L, -1)) {
324 rc = lua_tointeger(L, -1);
326 ap_lua_release_state(L, spec, r);
332 /* ------------------- Input/output content filters ------------------- */
335 static apr_status_t lua_setup_filter_ctx(ap_filter_t* f, request_rec* r, lua_filter_ctx** c) {
337 ap_lua_vm_spec *spec;
341 ap_lua_server_cfg *server_cfg = ap_get_module_config(r->server->module_config,
343 const ap_lua_dir_cfg *cfg = ap_get_module_config(r->per_dir_config,
346 ctx = apr_pcalloc(r->pool, sizeof(lua_filter_ctx));
349 /* Find the filter that was called.
350 * XXX: If we were wired with mod_filter, the filter (mod_filters name)
351 * and the provider (our underlying filters name) need to have matched.
353 for (n = 0; n < cfg->mapped_filters->nelts; n++) {
354 ap_lua_filter_handler_spec *hook_spec =
355 ((ap_lua_filter_handler_spec **) cfg->mapped_filters->elts)[n];
357 if (hook_spec == NULL) {
360 if (!strcasecmp(hook_spec->filter_name, f->frec->name)) {
361 spec = create_vm_spec(&pool, r, cfg, server_cfg,
362 hook_spec->file_name,
365 hook_spec->function_name,
367 L = ap_lua_get_lua_state(pool, spec, r);
369 L = lua_newthread(L);
373 ap_log_rerror(APLOG_MARK, APLOG_CRIT, 0, r, APLOGNO(02328)
374 "lua: Failed to obtain lua interpreter for %s %s",
375 hook_spec->function_name, hook_spec->file_name);
376 ap_lua_release_state(L, spec, r);
379 if (hook_spec->function_name != NULL) {
380 lua_getglobal(L, hook_spec->function_name);
381 if (!lua_isfunction(L, -1)) {
382 ap_log_rerror(APLOG_MARK, APLOG_CRIT, 0, r, APLOGNO(02329)
383 "lua: Unable to find entry function '%s' in %s (not a valid function)",
384 hook_spec->function_name,
385 hook_spec->file_name);
386 ap_lua_release_state(L, spec, r);
390 ap_lua_run_lua_request(L, r);
394 ap_lua_run_lua_request(L, r);
397 lua_setglobal(L, "r");
403 /* If a Lua filter is interested in filtering a request, it must first do a yield,
404 * otherwise we'll assume that it's not interested and pretend we didn't find it.
406 rc = lua_resume(L, 1);
407 if (rc == LUA_YIELD) {
408 if (f->frec->providers == NULL) {
409 /* Not wired by mod_filter */
410 apr_table_unset(r->headers_out, "Content-Length");
411 apr_table_unset(r->headers_out, "Content-MD5");
412 apr_table_unset(r->headers_out, "ETAG");
417 ap_lua_release_state(L, spec, r);
425 static apr_status_t lua_output_filter_handle(ap_filter_t *f, apr_bucket_brigade *pbbIn) {
426 request_rec *r = f->r;
430 conn_rec *c = r->connection;
434 /* Set up the initial filter context and acquire the function.
435 * The corresponding Lua function should yield here.
438 rc = lua_setup_filter_ctx(f,r,&ctx);
439 if (rc == APR_EGENERAL) {
440 return HTTP_INTERNAL_SERVER_ERROR;
442 if (rc == APR_ENOENT) {
443 /* No filter entry found (or the script declined to filter), just pass on the buckets */
444 ap_remove_output_filter(f);
445 return ap_pass_brigade(f->next,pbbIn);
448 /* We've got a willing lua filter, setup and check for a prefix */
451 const char* output = lua_tolstring(ctx->L, 1, &olen);
454 ctx->tmpBucket = apr_brigade_create(r->pool, c->bucket_alloc);
457 pbktOut = apr_bucket_heap_create(output, olen, NULL, c->bucket_alloc);
458 APR_BRIGADE_INSERT_TAIL(ctx->tmpBucket, pbktOut);
459 rv = ap_pass_brigade(f->next, ctx->tmpBucket);
460 apr_brigade_cleanup(ctx->tmpBucket);
461 if (rv != APR_SUCCESS) {
467 ctx = (lua_filter_ctx*) f->ctx;
469 /* While the Lua function is still yielding, pass in buckets to the coroutine */
471 for (pbktIn = APR_BRIGADE_FIRST(pbbIn);
472 pbktIn != APR_BRIGADE_SENTINEL(pbbIn);
473 pbktIn = APR_BUCKET_NEXT(pbktIn))
479 /* read the bucket */
480 apr_bucket_read(pbktIn,&data,&len,APR_BLOCK_READ);
482 /* Push the bucket onto the Lua stack as a global var */
483 lua_pushlstring(L, data, len);
484 lua_setglobal(L, "bucket");
486 /* If Lua yielded, it means we have something to pass on */
487 if (lua_resume(L, 0) == LUA_YIELD) {
489 const char* output = lua_tolstring(L, 1, &olen);
491 pbktOut = apr_bucket_heap_create(output, olen, NULL,
493 APR_BRIGADE_INSERT_TAIL(ctx->tmpBucket, pbktOut);
494 rv = ap_pass_brigade(f->next, ctx->tmpBucket);
495 apr_brigade_cleanup(ctx->tmpBucket);
496 if (rv != APR_SUCCESS) {
503 ap_lua_release_state(L, ctx->spec, r);
504 ap_remove_output_filter(f);
505 apr_brigade_cleanup(pbbIn);
506 apr_brigade_cleanup(ctx->tmpBucket);
507 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(02663)
508 "lua: Error while executing filter: %s",
509 lua_tostring(L, -1));
510 return HTTP_INTERNAL_SERVER_ERROR;
513 /* If we've safely reached the end, do a final call to Lua to allow for any
514 finishing moves by the script, such as appending a tail. */
515 if (APR_BUCKET_IS_EOS(APR_BRIGADE_LAST(pbbIn))) {
518 lua_setglobal(L, "bucket");
519 if (lua_resume(L, 0) == LUA_YIELD) {
522 const char* output = lua_tolstring(L, 1, &olen);
524 pbktOut = apr_bucket_heap_create(output, olen, NULL,
526 APR_BRIGADE_INSERT_TAIL(ctx->tmpBucket, pbktOut);
529 pbktEOS = apr_bucket_eos_create(c->bucket_alloc);
530 APR_BRIGADE_INSERT_TAIL(ctx->tmpBucket, pbktEOS);
531 ap_lua_release_state(L, ctx->spec, r);
532 rv = ap_pass_brigade(f->next, ctx->tmpBucket);
533 apr_brigade_cleanup(ctx->tmpBucket);
534 if (rv != APR_SUCCESS) {
540 apr_brigade_cleanup(pbbIn);
546 static apr_status_t lua_input_filter_handle(ap_filter_t *f,
547 apr_bucket_brigade *pbbOut,
548 ap_input_mode_t eMode,
549 apr_read_type_e eBlock,
552 request_rec *r = f->r;
553 int rc, lastCall = 0;
556 conn_rec *c = r->connection;
559 /* Set up the initial filter context and acquire the function.
560 * The corresponding Lua function should yield here.
563 rc = lua_setup_filter_ctx(f,r,&ctx);
565 if (rc == APR_EGENERAL) {
567 ap_remove_input_filter(f);
568 return HTTP_INTERNAL_SERVER_ERROR;
570 if (rc == APR_ENOENT ) {
571 ap_remove_input_filter(f);
574 if (rc == APR_SUCCESS) {
575 ctx->tmpBucket = apr_brigade_create(r->pool, c->bucket_alloc);
578 ctx = (lua_filter_ctx*) f->ctx;
580 /* If the Lua script broke or denied serving the request, just pass the buckets through */
582 return ap_get_brigade(f->next, pbbOut, eMode, eBlock, nBytes);
585 if (APR_BRIGADE_EMPTY(ctx->tmpBucket)) {
586 ret = ap_get_brigade(f->next, ctx->tmpBucket, eMode, eBlock, nBytes);
587 if (eMode == AP_MODE_EATCRLF || ret != APR_SUCCESS)
591 /* While the Lua function is still yielding, pass buckets to the coroutine */
594 while(!APR_BRIGADE_EMPTY(ctx->tmpBucket)) {
595 apr_bucket *pbktIn = APR_BRIGADE_FIRST(ctx->tmpBucket);
600 if (APR_BUCKET_IS_EOS(pbktIn)) {
601 APR_BUCKET_REMOVE(pbktIn);
605 /* read the bucket */
606 ret = apr_bucket_read(pbktIn, &data, &len, eBlock);
607 if (ret != APR_SUCCESS)
610 /* Push the bucket onto the Lua stack as a global var */
612 lua_pushlstring(L, data, len);
613 lua_setglobal(L, "bucket");
615 /* If Lua yielded, it means we have something to pass on */
616 if (lua_resume(L, 0) == LUA_YIELD) {
618 const char* output = lua_tolstring(L, 1, &olen);
619 pbktOut = apr_bucket_heap_create(output, olen, 0, c->bucket_alloc);
620 APR_BRIGADE_INSERT_TAIL(pbbOut, pbktOut);
621 apr_bucket_delete(pbktIn);
626 ap_lua_release_state(L, ctx->spec, r);
627 ap_remove_input_filter(f);
628 apr_bucket_delete(pbktIn);
629 return HTTP_INTERNAL_SERVER_ERROR;
632 /* If we've safely reached the end, do a final call to Lua to allow for any
633 finishing moves by the script, such as appending a tail. */
635 apr_bucket *pbktEOS = apr_bucket_eos_create(c->bucket_alloc);
637 lua_setglobal(L, "bucket");
638 if (lua_resume(L, 0) == LUA_YIELD) {
641 const char* output = lua_tolstring(L, 1, &olen);
642 pbktOut = apr_bucket_heap_create(output, olen, 0, c->bucket_alloc);
643 APR_BRIGADE_INSERT_TAIL(pbbOut, pbktOut);
645 APR_BRIGADE_INSERT_TAIL(pbbOut,pbktEOS);
646 ap_lua_release_state(L, ctx->spec, r);
653 /* ---------------- Configury stuff --------------- */
655 /** harnesses for magic hooks **/
657 static int lua_request_rec_hook_harness(request_rec *r, const char *name, int apr_hook_when)
662 ap_lua_vm_spec *spec;
663 ap_lua_server_cfg *server_cfg = ap_get_module_config(r->server->module_config,
665 const ap_lua_dir_cfg *cfg = ap_get_module_config(r->per_dir_config,
667 const char *key = apr_psprintf(r->pool, "%s_%d", name, apr_hook_when);
668 apr_array_header_t *hook_specs = apr_hash_get(cfg->hooks, key,
669 APR_HASH_KEY_STRING);
672 for (i = 0; i < hook_specs->nelts; i++) {
673 ap_lua_mapped_handler_spec *hook_spec =
674 ((ap_lua_mapped_handler_spec **) hook_specs->elts)[i];
676 if (hook_spec == NULL) {
679 spec = create_vm_spec(&pool, r, cfg, server_cfg,
680 hook_spec->file_name,
682 hook_spec->bytecode_len,
683 hook_spec->function_name,
686 L = ap_lua_get_lua_state(pool, spec, r);
689 ap_log_rerror(APLOG_MARK, APLOG_CRIT, 0, r, APLOGNO(01477)
690 "lua: Failed to obtain lua interpreter for entry function '%s' in %s",
691 hook_spec->function_name, hook_spec->file_name);
692 return HTTP_INTERNAL_SERVER_ERROR;
695 if (hook_spec->function_name != NULL) {
696 lua_getglobal(L, hook_spec->function_name);
697 if (!lua_isfunction(L, -1)) {
698 ap_log_rerror(APLOG_MARK, APLOG_CRIT, 0, r, APLOGNO(01478)
699 "lua: Unable to find entry function '%s' in %s (not a valid function)",
700 hook_spec->function_name,
701 hook_spec->file_name);
702 ap_lua_release_state(L, spec, r);
703 return HTTP_INTERNAL_SERVER_ERROR;
706 ap_lua_run_lua_request(L, r);
710 ap_lua_run_lua_request(L, r);
713 lua_setglobal(L, "r");
717 if (lua_pcall(L, 1, 1, 0)) {
718 report_lua_error(L, r);
719 ap_lua_release_state(L, spec, r);
720 return HTTP_INTERNAL_SERVER_ERROR;
723 if (lua_isnumber(L, -1)) {
724 rc = lua_tointeger(L, -1);
725 ap_log_rerror(APLOG_MARK, APLOG_TRACE4, 0, r, "Lua hook %s:%s for phase %s returned %d",
726 hook_spec->file_name, hook_spec->function_name, name, rc);
729 ap_log_rerror(APLOG_MARK, APLOG_CRIT, 0, r, "Lua hook %s:%s for phase %s did not return a numeric value",
730 hook_spec->file_name, hook_spec->function_name, name);
731 return HTTP_INTERNAL_SERVER_ERROR;
733 if (rc != DECLINED) {
734 ap_lua_release_state(L, spec, r);
737 ap_lua_release_state(L, spec, r);
744 /* Fix for making sure that LuaMapHandler works when FallbackResource is set */
745 static int lua_map_handler_fixups(request_rec *r)
747 /* If there is no handler set yet, this might be a LuaMapHandler request */
748 if (r->handler == NULL) {
750 ap_regmatch_t match[10];
751 const ap_lua_dir_cfg *cfg = ap_get_module_config(r->per_dir_config,
753 for (n = 0; n < cfg->mapped_handlers->nelts; n++) {
754 ap_lua_mapped_handler_spec *hook_spec =
755 ((ap_lua_mapped_handler_spec **) cfg->mapped_handlers->elts)[n];
757 if (hook_spec == NULL) {
760 if (!ap_regexec(hook_spec->uri_pattern, r->uri, 10, match, 0)) {
761 r->handler = apr_pstrdup(r->pool, "lua-map-handler");
770 static int lua_map_handler(request_rec *r)
775 const char *filename, *function_name;
776 const char *values[10];
777 ap_lua_vm_spec *spec;
778 ap_regmatch_t match[10];
779 ap_lua_server_cfg *server_cfg = ap_get_module_config(r->server->module_config,
781 const ap_lua_dir_cfg *cfg = ap_get_module_config(r->per_dir_config,
783 for (n = 0; n < cfg->mapped_handlers->nelts; n++) {
784 ap_lua_mapped_handler_spec *hook_spec =
785 ((ap_lua_mapped_handler_spec **) cfg->mapped_handlers->elts)[n];
787 if (hook_spec == NULL) {
790 if (!ap_regexec(hook_spec->uri_pattern, r->uri, 10, match, 0)) {
792 for (i=0 ; i < 10; i++) {
793 if (match[i].rm_eo >= 0) {
794 values[i] = apr_pstrndup(r->pool, r->uri+match[i].rm_so, match[i].rm_eo - match[i].rm_so);
798 filename = ap_lua_interpolate_string(r->pool, hook_spec->file_name, values);
799 function_name = ap_lua_interpolate_string(r->pool, hook_spec->function_name, values);
800 spec = create_vm_spec(&pool, r, cfg, server_cfg,
803 hook_spec->bytecode_len,
806 L = ap_lua_get_lua_state(pool, spec, r);
809 ap_log_rerror(APLOG_MARK, APLOG_CRIT, 0, r, APLOGNO(02330)
810 "lua: Failed to obtain Lua interpreter for entry function '%s' in %s",
811 function_name, filename);
812 ap_lua_release_state(L, spec, r);
813 return HTTP_INTERNAL_SERVER_ERROR;
816 if (function_name != NULL) {
817 lua_getglobal(L, function_name);
818 if (!lua_isfunction(L, -1)) {
819 ap_log_rerror(APLOG_MARK, APLOG_CRIT, 0, r, APLOGNO(02331)
820 "lua: Unable to find entry function '%s' in %s (not a valid function)",
823 ap_lua_release_state(L, spec, r);
824 return HTTP_INTERNAL_SERVER_ERROR;
827 ap_lua_run_lua_request(L, r);
831 ap_lua_run_lua_request(L, r);
834 lua_setglobal(L, "r");
838 if (lua_pcall(L, 1, 1, 0)) {
839 report_lua_error(L, r);
840 ap_lua_release_state(L, spec, r);
841 return HTTP_INTERNAL_SERVER_ERROR;
844 if (lua_isnumber(L, -1)) {
845 rc = lua_tointeger(L, -1);
848 ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r, APLOGNO(02483)
849 "lua: Lua handler %s in %s did not return a value, assuming apache2.OK",
854 ap_lua_release_state(L, spec, r);
855 if (rc != DECLINED) {
864 static apr_size_t config_getstr(ap_configfile_t *cfg, char *buf,
870 apr_status_t rc = (cfg->getstr) (buf, bufsiz, cfg->param);
871 if (rc == APR_SUCCESS) {
873 if (i && buf[i - 1] == '\n')
884 apr_status_t rc = (cfg->getch) (&ch, cfg->param);
885 if (rc != APR_SUCCESS)
897 typedef struct cr_ctx
900 ap_configfile_t *cfp;
903 char buf[HUGE_STRING_LEN];
907 /* Okay, this deserves a little explaination -- in order for the errors that lua
908 * generates to be 'accuarate', including line numbers, we basically inject
909 * N line number new lines into the 'top' of the chunk reader.....
911 * be happy. this is cool.
914 static const char *lf =
915 "\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n";
918 static const char *direct_chunkreader(lua_State *lvm, void *udata,
922 struct cr_ctx *ctx = udata;
924 if (ctx->startline) {
925 *plen = ctx->startline > N_LF ? N_LF : ctx->startline;
926 ctx->startline -= *plen;
929 *plen = config_getstr(ctx->cfp, ctx->buf, HUGE_STRING_LEN);
931 for (p = ctx->buf; isspace(*p); ++p);
932 if (p[0] == '<' && p[1] == '/') {
934 while (i < strlen(ctx->endstr)) {
935 if (tolower(p[i + 2]) != ctx->endstr[i])
942 /*fprintf(stderr, "buf read: %s\n", ctx->buf); */
946 static int ldump_writer(lua_State *L, const void *b, size_t size, void *B)
949 luaL_addlstring((luaL_Buffer *) B, (const char *) b, size);
953 typedef struct hack_section_baton
956 ap_lua_mapped_handler_spec *spec;
958 } hack_section_baton;
960 /* You can be unhappy now.
964 * When you create a <Section handler in httpd, the only 'easy' way to create
965 * a directory context is to parse the section, and convert it into a 'normal'
966 * Configureation option, and then collapse the entire section, in memory,
967 * back into the parent section -- from which you can then get the new directive
968 * invoked.... anyways. evil. Rici taught me how to do this hack :-)
970 static const char *hack_section_handler(cmd_parms *cmd, void *_cfg,
973 ap_lua_dir_cfg *cfg = (ap_lua_dir_cfg *) _cfg;
974 ap_directive_t *directive = cmd->directive;
975 hack_section_baton *baton = directive->data;
976 const char *key = apr_psprintf(cmd->pool, "%s_%d", baton->name, baton->apr_hook_when);
978 apr_array_header_t *hook_specs = apr_hash_get(cfg->hooks, key,
979 APR_HASH_KEY_STRING);
981 hook_specs = apr_array_make(cmd->pool, 2,
982 sizeof(ap_lua_mapped_handler_spec *));
983 apr_hash_set(cfg->hooks, key,
984 APR_HASH_KEY_STRING, hook_specs);
987 baton->spec->scope = cfg->vm_scope;
989 *(ap_lua_mapped_handler_spec **) apr_array_push(hook_specs) = baton->spec;
994 static const char *register_named_block_function_hook(const char *name,
999 const char *function = NULL;
1000 ap_lua_mapped_handler_spec *spec;
1001 int when = APR_HOOK_MIDDLE;
1002 const char *endp = ap_strrchr_c(line, '>');
1005 return apr_pstrcat(cmd->pool, cmd->cmd->name,
1006 "> directive missing closing '>'", NULL);
1009 line = apr_pstrndup(cmd->temp_pool, line, endp - line);
1013 word = ap_getword_conf(cmd->temp_pool, &line);
1015 function = apr_pstrdup(cmd->pool, word);
1017 word = ap_getword_conf(cmd->temp_pool, &line);
1019 if (!strcasecmp("early", word)) {
1020 when = AP_LUA_HOOK_FIRST;
1022 else if (!strcasecmp("late", word)) {
1023 when = AP_LUA_HOOK_LAST;
1026 return apr_pstrcat(cmd->pool, cmd->cmd->name,
1027 "> 2nd argument must be 'early' or 'late'", NULL);
1032 spec = apr_pcalloc(cmd->pool, sizeof(ap_lua_mapped_handler_spec));
1039 ap_directive_t **current;
1040 hack_section_baton *baton;
1042 spec->file_name = apr_psprintf(cmd->pool, "%s:%u",
1043 cmd->config_file->name,
1044 cmd->config_file->line_number);
1046 spec->function_name = (char *) function;
1053 tmp = apr_pstrdup(cmd->pool, cmd->err_directive->directive + 1);
1054 ap_str_tolower(tmp);
1056 ctx.cfp = cmd->config_file;
1057 ctx.startline = cmd->config_file->line_number;
1059 /* This lua State is used only to compile the input strings -> bytecode, so we don't need anything extra. */
1060 lvm = luaL_newstate();
1064 rv = lua_load(lvm, direct_chunkreader, &ctx, spec->file_name);
1067 const char *errstr = apr_pstrcat(cmd->pool, "Lua Error:",
1068 lua_tostring(lvm, -1), NULL);
1074 luaL_buffinit(lvm, &b);
1075 #if LUA_VERSION_NUM >= 503
1076 lua_dump(lvm, ldump_writer, &b, 0);
1078 lua_dump(lvm, ldump_writer, &b);
1080 luaL_pushresult(&b);
1081 spec->bytecode_len = lua_strlen(lvm, -1);
1082 spec->bytecode = apr_pstrmemdup(cmd->pool, lua_tostring(lvm, -1),
1083 spec->bytecode_len);
1089 /* Here, we have to replace our current config node for the next pass */
1091 *current = apr_pcalloc(cmd->pool, sizeof(**current));
1094 baton = apr_pcalloc(cmd->pool, sizeof(hack_section_baton));
1097 baton->apr_hook_when = when;
1099 (*current)->filename = cmd->config_file->name;
1100 (*current)->line_num = cmd->config_file->line_number;
1101 (*current)->directive = apr_pstrdup(cmd->pool, "Lua_____ByteCodeHack");
1102 (*current)->args = NULL;
1103 (*current)->data = baton;
1109 static const char *register_named_file_function_hook(const char *name,
1113 const char *function,
1116 ap_lua_mapped_handler_spec *spec;
1117 ap_lua_dir_cfg *cfg = (ap_lua_dir_cfg *) _cfg;
1118 const char *key = apr_psprintf(cmd->pool, "%s_%d", name, apr_hook_when);
1119 apr_array_header_t *hook_specs = apr_hash_get(cfg->hooks, key,
1120 APR_HASH_KEY_STRING);
1123 hook_specs = apr_array_make(cmd->pool, 2,
1124 sizeof(ap_lua_mapped_handler_spec *));
1125 apr_hash_set(cfg->hooks, key, APR_HASH_KEY_STRING, hook_specs);
1128 spec = apr_pcalloc(cmd->pool, sizeof(ap_lua_mapped_handler_spec));
1129 spec->file_name = apr_pstrdup(cmd->pool, file);
1130 spec->function_name = apr_pstrdup(cmd->pool, function);
1131 spec->scope = cfg->vm_scope;
1133 *(ap_lua_mapped_handler_spec **) apr_array_push(hook_specs) = spec;
1136 static const char *register_mapped_file_function_hook(const char *pattern,
1140 const char *function)
1142 ap_lua_mapped_handler_spec *spec;
1143 ap_lua_dir_cfg *cfg = (ap_lua_dir_cfg *) _cfg;
1144 ap_regex_t *regex = apr_pcalloc(cmd->pool, sizeof(ap_regex_t));
1145 if (ap_regcomp(regex, pattern,0)) {
1146 return "Invalid regex pattern!";
1149 spec = apr_pcalloc(cmd->pool, sizeof(ap_lua_mapped_handler_spec));
1150 spec->file_name = apr_pstrdup(cmd->pool, file);
1151 spec->function_name = apr_pstrdup(cmd->pool, function);
1152 spec->scope = cfg->vm_scope;
1153 spec->uri_pattern = regex;
1155 *(ap_lua_mapped_handler_spec **) apr_array_push(cfg->mapped_handlers) = spec;
1158 static const char *register_filter_function_hook(const char *filter,
1162 const char *function,
1165 ap_lua_filter_handler_spec *spec;
1166 ap_lua_dir_cfg *cfg = (ap_lua_dir_cfg *) _cfg;
1168 spec = apr_pcalloc(cmd->pool, sizeof(ap_lua_filter_handler_spec));
1169 spec->file_name = apr_pstrdup(cmd->pool, file);
1170 spec->function_name = apr_pstrdup(cmd->pool, function);
1171 spec->filter_name = filter;
1173 *(ap_lua_filter_handler_spec **) apr_array_push(cfg->mapped_filters) = spec;
1174 /* TODO: Make it work on other types than just AP_FTYPE_RESOURCE? */
1175 if (direction == AP_LUA_FILTER_OUTPUT) {
1176 spec->direction = AP_LUA_FILTER_OUTPUT;
1177 ap_register_output_filter_protocol(filter, lua_output_filter_handle, NULL, AP_FTYPE_RESOURCE,
1178 AP_FILTER_PROTO_CHANGE|AP_FILTER_PROTO_CHANGE_LENGTH);
1181 spec->direction = AP_LUA_FILTER_INPUT;
1182 ap_register_input_filter(filter, lua_input_filter_handle, NULL, AP_FTYPE_RESOURCE);
1186 /* disabled (see reference below)
1187 static int lua_check_user_id_harness_first(request_rec *r)
1189 return lua_request_rec_hook_harness(r, "check_user_id", AP_LUA_HOOK_FIRST);
1192 static int lua_check_user_id_harness(request_rec *r)
1194 return lua_request_rec_hook_harness(r, "check_user_id", APR_HOOK_MIDDLE);
1196 /* disabled (see reference below)
1197 static int lua_check_user_id_harness_last(request_rec *r)
1199 return lua_request_rec_hook_harness(r, "check_user_id", AP_LUA_HOOK_LAST);
1203 static int lua_translate_name_harness_first(request_rec *r)
1205 return lua_request_rec_hook_harness(r, "translate_name", AP_LUA_HOOK_FIRST);
1207 static int lua_translate_name_harness(request_rec *r)
1209 return lua_request_rec_hook_harness(r, "translate_name", APR_HOOK_MIDDLE);
1211 static int lua_translate_name_harness_last(request_rec *r)
1213 return lua_request_rec_hook_harness(r, "translate_name", AP_LUA_HOOK_LAST);
1216 static int lua_fixup_harness(request_rec *r)
1218 return lua_request_rec_hook_harness(r, "fixups", APR_HOOK_MIDDLE);
1221 static int lua_map_to_storage_harness(request_rec *r)
1223 return lua_request_rec_hook_harness(r, "map_to_storage", APR_HOOK_MIDDLE);
1226 static int lua_type_checker_harness(request_rec *r)
1228 return lua_request_rec_hook_harness(r, "type_checker", APR_HOOK_MIDDLE);
1231 static int lua_access_checker_harness_first(request_rec *r)
1233 return lua_request_rec_hook_harness(r, "access_checker", AP_LUA_HOOK_FIRST);
1235 static int lua_access_checker_harness(request_rec *r)
1237 return lua_request_rec_hook_harness(r, "access_checker", APR_HOOK_MIDDLE);
1239 static int lua_access_checker_harness_last(request_rec *r)
1241 return lua_request_rec_hook_harness(r, "access_checker", AP_LUA_HOOK_LAST);
1244 static int lua_auth_checker_harness_first(request_rec *r)
1246 return lua_request_rec_hook_harness(r, "auth_checker", AP_LUA_HOOK_FIRST);
1248 static int lua_auth_checker_harness(request_rec *r)
1250 return lua_request_rec_hook_harness(r, "auth_checker", APR_HOOK_MIDDLE);
1252 static int lua_auth_checker_harness_last(request_rec *r)
1254 return lua_request_rec_hook_harness(r, "auth_checker", AP_LUA_HOOK_LAST);
1256 static void lua_insert_filter_harness(request_rec *r)
1258 /* ap_log_rerror(APLOG_MARK, APLOG_WARNING, 0, r, "LuaHookInsertFilter not yet implemented"); */
1261 static int lua_log_transaction_harness(request_rec *r)
1263 return lua_request_rec_hook_harness(r, "log_transaction", APR_HOOK_FIRST);
1266 static int lua_quick_harness(request_rec *r, int lookup)
1271 return lua_request_rec_hook_harness(r, "quick", APR_HOOK_MIDDLE);
1274 static const char *register_translate_name_hook(cmd_parms *cmd, void *_cfg,
1276 const char *function,
1279 const char *err = ap_check_cmd_context(cmd, NOT_IN_DIRECTORY|NOT_IN_FILES|
1281 int apr_hook_when = APR_HOOK_MIDDLE;
1287 if (!strcasecmp(when, "early")) {
1288 apr_hook_when = AP_LUA_HOOK_FIRST;
1290 else if (!strcasecmp(when, "late")) {
1291 apr_hook_when = AP_LUA_HOOK_LAST;
1294 return "Third argument must be 'early' or 'late'";
1298 return register_named_file_function_hook("translate_name", cmd, _cfg,
1299 file, function, apr_hook_when);
1302 static const char *register_translate_name_block(cmd_parms *cmd, void *_cfg,
1305 return register_named_block_function_hook("translate_name", cmd, _cfg,
1310 static const char *register_fixups_hook(cmd_parms *cmd, void *_cfg,
1312 const char *function)
1314 return register_named_file_function_hook("fixups", cmd, _cfg, file,
1315 function, APR_HOOK_MIDDLE);
1317 static const char *register_fixups_block(cmd_parms *cmd, void *_cfg,
1320 return register_named_block_function_hook("fixups", cmd, _cfg, line);
1323 static const char *register_map_to_storage_hook(cmd_parms *cmd, void *_cfg,
1325 const char *function)
1327 return register_named_file_function_hook("map_to_storage", cmd, _cfg,
1328 file, function, APR_HOOK_MIDDLE);
1331 static const char *register_log_transaction_hook(cmd_parms *cmd, void *_cfg,
1333 const char *function)
1335 return register_named_file_function_hook("log_transaction", cmd, _cfg,
1336 file, function, APR_HOOK_FIRST);
1339 static const char *register_map_to_storage_block(cmd_parms *cmd, void *_cfg,
1342 return register_named_block_function_hook("map_to_storage", cmd, _cfg,
1347 static const char *register_check_user_id_hook(cmd_parms *cmd, void *_cfg,
1349 const char *function,
1352 int apr_hook_when = APR_HOOK_MIDDLE;
1353 /* XXX: This does not currently work!!
1355 if (!strcasecmp(when, "early")) {
1356 apr_hook_when = AP_LUA_HOOK_FIRST;
1358 else if (!strcasecmp(when, "late")) {
1359 apr_hook_when = AP_LUA_HOOK_LAST;
1362 return "Third argument must be 'early' or 'late'";
1366 return register_named_file_function_hook("check_user_id", cmd, _cfg, file,
1367 function, apr_hook_when);
1369 static const char *register_check_user_id_block(cmd_parms *cmd, void *_cfg,
1372 return register_named_block_function_hook("check_user_id", cmd, _cfg,
1376 static const char *register_type_checker_hook(cmd_parms *cmd, void *_cfg,
1378 const char *function)
1380 return register_named_file_function_hook("type_checker", cmd, _cfg, file,
1381 function, APR_HOOK_MIDDLE);
1383 static const char *register_type_checker_block(cmd_parms *cmd, void *_cfg,
1386 return register_named_block_function_hook("type_checker", cmd, _cfg,
1390 static const char *register_access_checker_hook(cmd_parms *cmd, void *_cfg,
1392 const char *function,
1395 int apr_hook_when = APR_HOOK_MIDDLE;
1398 if (!strcasecmp(when, "early")) {
1399 apr_hook_when = AP_LUA_HOOK_FIRST;
1401 else if (!strcasecmp(when, "late")) {
1402 apr_hook_when = AP_LUA_HOOK_LAST;
1405 return "Third argument must be 'early' or 'late'";
1409 return register_named_file_function_hook("access_checker", cmd, _cfg,
1410 file, function, apr_hook_when);
1412 static const char *register_access_checker_block(cmd_parms *cmd, void *_cfg,
1416 return register_named_block_function_hook("access_checker", cmd, _cfg,
1420 static const char *register_auth_checker_hook(cmd_parms *cmd, void *_cfg,
1422 const char *function,
1425 int apr_hook_when = APR_HOOK_MIDDLE;
1428 if (!strcasecmp(when, "early")) {
1429 apr_hook_when = AP_LUA_HOOK_FIRST;
1431 else if (!strcasecmp(when, "late")) {
1432 apr_hook_when = AP_LUA_HOOK_LAST;
1435 return "Third argument must be 'early' or 'late'";
1439 return register_named_file_function_hook("auth_checker", cmd, _cfg, file,
1440 function, apr_hook_when);
1442 static const char *register_auth_checker_block(cmd_parms *cmd, void *_cfg,
1445 return register_named_block_function_hook("auth_checker", cmd, _cfg,
1449 static const char *register_insert_filter_hook(cmd_parms *cmd, void *_cfg,
1451 const char *function)
1453 return "LuaHookInsertFilter not yet implemented";
1456 static const char *register_quick_hook(cmd_parms *cmd, void *_cfg,
1457 const char *file, const char *function)
1459 const char *err = ap_check_cmd_context(cmd, NOT_IN_DIRECTORY|NOT_IN_FILES|
1464 return register_named_file_function_hook("quick", cmd, _cfg, file,
1465 function, APR_HOOK_MIDDLE);
1467 static const char *register_map_handler(cmd_parms *cmd, void *_cfg,
1468 const char* match, const char *file, const char *function)
1470 const char *err = ap_check_cmd_context(cmd, NOT_IN_DIRECTORY|NOT_IN_FILES|
1475 if (!function) function = "handle";
1476 return register_mapped_file_function_hook(match, cmd, _cfg, file,
1479 static const char *register_output_filter(cmd_parms *cmd, void *_cfg,
1480 const char* filter, const char *file, const char *function)
1482 const char *err = ap_check_cmd_context(cmd, NOT_IN_DIRECTORY|NOT_IN_FILES|
1487 if (!function) function = "handle";
1488 return register_filter_function_hook(filter, cmd, _cfg, file,
1489 function, AP_LUA_FILTER_OUTPUT);
1491 static const char *register_input_filter(cmd_parms *cmd, void *_cfg,
1492 const char* filter, const char *file, const char *function)
1494 const char *err = ap_check_cmd_context(cmd, NOT_IN_DIRECTORY|NOT_IN_FILES|
1499 if (!function) function = "handle";
1500 return register_filter_function_hook(filter, cmd, _cfg, file,
1501 function, AP_LUA_FILTER_INPUT);
1503 static const char *register_quick_block(cmd_parms *cmd, void *_cfg,
1506 return register_named_block_function_hook("quick", cmd, _cfg,
1512 static const char *register_package_helper(cmd_parms *cmd,
1514 apr_array_header_t *dir_array)
1518 ap_lua_server_cfg *server_cfg =
1519 ap_get_module_config(cmd->server->module_config, &lua_module);
1521 char *fixed_filename;
1522 rv = apr_filepath_merge(&fixed_filename,
1523 server_cfg->root_path,
1525 APR_FILEPATH_NOTRELATIVE,
1528 if (rv != APR_SUCCESS) {
1529 return apr_psprintf(cmd->pool,
1530 "Unable to build full path to file, %s", arg);
1533 *(const char **) apr_array_push(dir_array) = fixed_filename;
1539 * Called for config directive which looks like
1540 * LuaPackagePath /lua/package/path/mapped/thing/like/this/?.lua
1542 static const char *register_package_dir(cmd_parms *cmd, void *_cfg,
1545 ap_lua_dir_cfg *cfg = (ap_lua_dir_cfg *) _cfg;
1547 return register_package_helper(cmd, arg, cfg->package_paths);
1551 * Called for config directive which looks like
1552 * LuaPackageCPath /lua/package/path/mapped/thing/like/this/?.so
1554 static const char *register_package_cdir(cmd_parms *cmd,
1558 ap_lua_dir_cfg *cfg = (ap_lua_dir_cfg *) _cfg;
1560 return register_package_helper(cmd, arg, cfg->package_cpaths);
1563 static const char *register_lua_inherit(cmd_parms *cmd,
1567 ap_lua_dir_cfg *cfg = (ap_lua_dir_cfg *) _cfg;
1569 if (strcasecmp("none", arg) == 0) {
1570 cfg->inherit = AP_LUA_INHERIT_NONE;
1572 else if (strcasecmp("parent-first", arg) == 0) {
1573 cfg->inherit = AP_LUA_INHERIT_PARENT_FIRST;
1575 else if (strcasecmp("parent-last", arg) == 0) {
1576 cfg->inherit = AP_LUA_INHERIT_PARENT_LAST;
1579 return apr_psprintf(cmd->pool,
1580 "LuaInherit type of '%s' not recognized, valid "
1581 "options are 'none', 'parent-first', and 'parent-last'",
1586 static const char *register_lua_codecache(cmd_parms *cmd,
1590 ap_lua_dir_cfg *cfg = (ap_lua_dir_cfg *) _cfg;
1592 if (strcasecmp("never", arg) == 0) {
1593 cfg->codecache = AP_LUA_CACHE_NEVER;
1595 else if (strcasecmp("stat", arg) == 0) {
1596 cfg->codecache = AP_LUA_CACHE_STAT;
1598 else if (strcasecmp("forever", arg) == 0) {
1599 cfg->codecache = AP_LUA_CACHE_FOREVER;
1602 return apr_psprintf(cmd->pool,
1603 "LuaCodeCache type of '%s' not recognized, valid "
1604 "options are 'never', 'stat', and 'forever'",
1609 static const char *register_lua_scope(cmd_parms *cmd,
1615 ap_lua_dir_cfg *cfg = (ap_lua_dir_cfg *) _cfg;
1616 if (strcmp("once", scope) == 0) {
1617 cfg->vm_scope = AP_LUA_SCOPE_ONCE;
1619 else if (strcmp("request", scope) == 0) {
1620 cfg->vm_scope = AP_LUA_SCOPE_REQUEST;
1622 else if (strcmp("conn", scope) == 0) {
1623 cfg->vm_scope = AP_LUA_SCOPE_CONN;
1625 else if (strcmp("thread", scope) == 0) {
1626 #if !APR_HAS_THREADS
1627 return apr_psprintf(cmd->pool,
1628 "Scope type of '%s' cannot be used because this "
1629 "server does not have threading support "
1633 cfg->vm_scope = AP_LUA_SCOPE_THREAD;
1635 else if (strcmp("server", scope) == 0) {
1636 unsigned int vmin, vmax;
1637 #if !APR_HAS_THREADS
1638 return apr_psprintf(cmd->pool,
1639 "Scope type of '%s' cannot be used because this "
1640 "server does not have threading support "
1644 cfg->vm_scope = AP_LUA_SCOPE_SERVER;
1645 vmin = min ? atoi(min) : 1;
1646 vmax = max ? atoi(max) : 1;
1657 return apr_psprintf(cmd->pool,
1658 "Invalid value for LuaScope, '%s', acceptable "
1659 "values are: 'once', 'request', 'conn'"
1661 ", 'thread', 'server'"
1671 static const char *register_lua_root(cmd_parms *cmd, void *_cfg,
1674 /* ap_lua_dir_cfg* cfg = (ap_lua_dir_cfg*)_cfg; */
1675 ap_lua_server_cfg *cfg = ap_get_module_config(cmd->server->module_config,
1678 cfg->root_path = root;
1682 const char *ap_lua_ssl_val(apr_pool_t *p, server_rec *s, conn_rec *c,
1683 request_rec *r, const char *var)
1686 return (const char *)lua_ssl_val(p, s, c, r, (char *)var);
1691 int ap_lua_ssl_is_https(conn_rec *c)
1693 return lua_ssl_is_https ? lua_ssl_is_https(c) : 0;
1696 /*******************************/
1698 static const char *lua_authz_parse(cmd_parms *cmd, const char *require_line,
1699 const void **parsed_require_line)
1701 const char *provider_name;
1702 lua_authz_provider_spec *spec;
1703 lua_authz_provider_func *func = apr_pcalloc(cmd->pool, sizeof(lua_authz_provider_func));
1705 apr_pool_userdata_get((void**)&provider_name, AUTHZ_PROVIDER_NAME_NOTE,
1707 ap_assert(provider_name != NULL);
1709 spec = apr_hash_get(lua_authz_providers, provider_name, APR_HASH_KEY_STRING);
1710 ap_assert(spec != NULL);
1713 if (require_line && *require_line) {
1715 func->args = apr_array_make(cmd->pool, 2, sizeof(const char *));
1716 while ((arg = ap_getword_conf(cmd->pool, &require_line)) && *arg) {
1717 APR_ARRAY_PUSH(func->args, const char *) = arg;
1721 *parsed_require_line = func;
1725 static authz_status lua_authz_check(request_rec *r, const char *require_line,
1726 const void *parsed_require_line)
1729 ap_lua_vm_spec *spec;
1731 ap_lua_server_cfg *server_cfg = ap_get_module_config(r->server->module_config,
1733 const ap_lua_dir_cfg *cfg = ap_get_module_config(r->per_dir_config,
1735 const lua_authz_provider_func *prov_func = parsed_require_line;
1736 const lua_authz_provider_spec *prov_spec = prov_func->spec;
1740 spec = create_vm_spec(&pool, r, cfg, server_cfg, prov_spec->file_name,
1741 NULL, 0, prov_spec->function_name, "authz provider");
1743 L = ap_lua_get_lua_state(pool, spec, r);
1745 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(02314)
1746 "Unable to compile VM for authz provider %s", prov_spec->name);
1747 return AUTHZ_GENERAL_ERROR;
1749 lua_getglobal(L, prov_spec->function_name);
1750 if (!lua_isfunction(L, -1)) {
1751 ap_log_rerror(APLOG_MARK, APLOG_CRIT, 0, r, APLOGNO(02319)
1752 "Unable to find entry function '%s' in %s (not a valid function)",
1753 prov_spec->function_name, prov_spec->file_name);
1754 ap_lua_release_state(L, spec, r);
1755 return AUTHZ_GENERAL_ERROR;
1757 ap_lua_run_lua_request(L, r);
1758 if (prov_func->args) {
1760 if (!lua_checkstack(L, prov_func->args->nelts)) {
1761 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(02315)
1762 "Error: authz provider %s: too many arguments", prov_spec->name);
1763 ap_lua_release_state(L, spec, r);
1764 return AUTHZ_GENERAL_ERROR;
1766 for (i = 0; i < prov_func->args->nelts; i++) {
1767 const char *arg = APR_ARRAY_IDX(prov_func->args, i, const char *);
1768 lua_pushstring(L, arg);
1770 nargs = prov_func->args->nelts;
1772 if (lua_pcall(L, 1 + nargs, 1, 0)) {
1773 const char *err = lua_tostring(L, -1);
1774 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(02316)
1775 "Error executing authz provider %s: %s", prov_spec->name, err);
1776 ap_lua_release_state(L, spec, r);
1777 return AUTHZ_GENERAL_ERROR;
1779 if (!lua_isnumber(L, -1)) {
1780 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(02317)
1781 "Error: authz provider %s did not return integer", prov_spec->name);
1782 ap_lua_release_state(L, spec, r);
1783 return AUTHZ_GENERAL_ERROR;
1785 result = lua_tointeger(L, -1);
1786 ap_lua_release_state(L, spec, r);
1791 case AUTHZ_GENERAL_ERROR:
1792 case AUTHZ_DENIED_NO_USER:
1795 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, APLOGNO(02318)
1796 "Error: authz provider %s: invalid return value %d",
1797 prov_spec->name, result);
1799 return AUTHZ_GENERAL_ERROR;
1802 static const authz_provider lua_authz_provider =
1808 static const char *register_authz_provider(cmd_parms *cmd, void *_cfg,
1809 const char *name, const char *file,
1810 const char *function)
1812 lua_authz_provider_spec *spec;
1813 const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
1817 spec = apr_pcalloc(cmd->pool, sizeof(*spec));
1819 spec->file_name = file;
1820 spec->function_name = function;
1822 apr_hash_set(lua_authz_providers, name, APR_HASH_KEY_STRING, spec);
1823 ap_register_auth_provider(cmd->pool, AUTHZ_PROVIDER_GROUP, name,
1824 AUTHZ_PROVIDER_VERSION,
1825 &lua_authz_provider,
1826 AP_AUTH_INTERNAL_PER_CONF);
1831 command_rec lua_commands[] = {
1833 AP_INIT_TAKE1("LuaRoot", register_lua_root, NULL, OR_ALL,
1834 "Specify the base path for resolving relative paths for mod_lua directives"),
1836 AP_INIT_TAKE1("LuaPackagePath", register_package_dir, NULL, OR_ALL,
1837 "Add a directory to lua's package.path"),
1839 AP_INIT_TAKE1("LuaPackageCPath", register_package_cdir, NULL, OR_ALL,
1840 "Add a directory to lua's package.cpath"),
1842 AP_INIT_TAKE3("LuaAuthzProvider", register_authz_provider, NULL, RSRC_CONF|EXEC_ON_READ,
1843 "Provide an authorization provider"),
1845 AP_INIT_TAKE23("LuaHookTranslateName", register_translate_name_hook, NULL,
1847 "Provide a hook for the translate name phase of request processing"),
1849 AP_INIT_RAW_ARGS("<LuaHookTranslateName", register_translate_name_block,
1851 EXEC_ON_READ | OR_ALL,
1852 "Provide a hook for the translate name phase of request processing"),
1854 AP_INIT_TAKE2("LuaHookFixups", register_fixups_hook, NULL, OR_ALL,
1855 "Provide a hook for the fixups phase of request processing"),
1856 AP_INIT_RAW_ARGS("<LuaHookFixups", register_fixups_block, NULL,
1857 EXEC_ON_READ | OR_ALL,
1858 "Provide a inline hook for the fixups phase of request processing"),
1861 AP_INIT_TAKE2("LuaHookMapToStorage", register_map_to_storage_hook, NULL,
1863 "Provide a hook for the map_to_storage phase of request processing"),
1864 AP_INIT_RAW_ARGS("<LuaHookMapToStorage", register_map_to_storage_block,
1866 EXEC_ON_READ | OR_ALL,
1867 "Provide a hook for the map_to_storage phase of request processing"),
1870 AP_INIT_TAKE23("LuaHookCheckUserID", register_check_user_id_hook, NULL,
1872 "Provide a hook for the check_user_id phase of request processing"),
1873 AP_INIT_RAW_ARGS("<LuaHookCheckUserID", register_check_user_id_block,
1875 EXEC_ON_READ | OR_ALL,
1876 "Provide a hook for the check_user_id phase of request processing"),
1879 AP_INIT_TAKE2("LuaHookTypeChecker", register_type_checker_hook, NULL,
1881 "Provide a hook for the type_checker phase of request processing"),
1882 AP_INIT_RAW_ARGS("<LuaHookTypeChecker", register_type_checker_block, NULL,
1883 EXEC_ON_READ | OR_ALL,
1884 "Provide a hook for the type_checker phase of request processing"),
1887 AP_INIT_TAKE23("LuaHookAccessChecker", register_access_checker_hook, NULL,
1889 "Provide a hook for the access_checker phase of request processing"),
1890 AP_INIT_RAW_ARGS("<LuaHookAccessChecker", register_access_checker_block,
1892 EXEC_ON_READ | OR_ALL,
1893 "Provide a hook for the access_checker phase of request processing"),
1896 AP_INIT_TAKE23("LuaHookAuthChecker", register_auth_checker_hook, NULL,
1898 "Provide a hook for the auth_checker phase of request processing"),
1899 AP_INIT_RAW_ARGS("<LuaHookAuthChecker", register_auth_checker_block, NULL,
1900 EXEC_ON_READ | OR_ALL,
1901 "Provide a hook for the auth_checker phase of request processing"),
1904 AP_INIT_TAKE2("LuaHookInsertFilter", register_insert_filter_hook, NULL,
1906 "Provide a hook for the insert_filter phase of request processing"),
1908 AP_INIT_TAKE2("LuaHookLog", register_log_transaction_hook, NULL,
1910 "Provide a hook for the logging phase of request processing"),
1912 AP_INIT_TAKE123("LuaScope", register_lua_scope, NULL, OR_ALL,
1913 "One of once, request, conn, server -- default is once"),
1915 AP_INIT_TAKE1("LuaInherit", register_lua_inherit, NULL, OR_ALL,
1916 "Controls how Lua scripts in parent contexts are merged with the current "
1917 " context: none|parent-last|parent-first (default: parent-first) "),
1919 AP_INIT_TAKE1("LuaCodeCache", register_lua_codecache, NULL, OR_ALL,
1920 "Controls the behavior of the in-memory code cache "
1921 " context: stat|forever|never (default: stat) "),
1923 AP_INIT_TAKE2("LuaQuickHandler", register_quick_hook, NULL, OR_ALL,
1924 "Provide a hook for the quick handler of request processing"),
1925 AP_INIT_RAW_ARGS("<LuaQuickHandler", register_quick_block, NULL,
1926 EXEC_ON_READ | OR_ALL,
1927 "Provide a hook for the quick handler of request processing"),
1928 AP_INIT_RAW_ARGS("Lua_____ByteCodeHack", hack_section_handler, NULL,
1930 "(internal) Byte code handler"),
1931 AP_INIT_TAKE23("LuaMapHandler", register_map_handler, NULL, OR_ALL,
1932 "Maps a path to a lua handler"),
1933 AP_INIT_TAKE3("LuaOutputFilter", register_output_filter, NULL, OR_ALL,
1934 "Registers a Lua function as an output filter"),
1935 AP_INIT_TAKE3("LuaInputFilter", register_input_filter, NULL, OR_ALL,
1936 "Registers a Lua function as an input filter"),
1941 static void *create_dir_config(apr_pool_t *p, char *dir)
1943 ap_lua_dir_cfg *cfg = apr_pcalloc(p, sizeof(ap_lua_dir_cfg));
1944 cfg->package_paths = apr_array_make(p, 2, sizeof(char *));
1945 cfg->package_cpaths = apr_array_make(p, 2, sizeof(char *));
1946 cfg->mapped_handlers =
1947 apr_array_make(p, 1, sizeof(ap_lua_mapped_handler_spec *));
1948 cfg->mapped_filters =
1949 apr_array_make(p, 1, sizeof(ap_lua_filter_handler_spec *));
1951 cfg->hooks = apr_hash_make(p);
1952 cfg->dir = apr_pstrdup(p, dir);
1953 cfg->vm_scope = AP_LUA_SCOPE_UNSET;
1954 cfg->codecache = AP_LUA_CACHE_UNSET;
1961 static int create_request_config(request_rec *r)
1963 ap_lua_request_cfg *cfg = apr_palloc(r->pool, sizeof(ap_lua_request_cfg));
1964 cfg->mapped_request_details = NULL;
1965 cfg->request_scoped_vms = apr_hash_make(r->pool);
1966 ap_set_module_config(r->request_config, &lua_module, cfg);
1970 static void *create_server_config(apr_pool_t *p, server_rec *s)
1973 ap_lua_server_cfg *cfg = apr_pcalloc(p, sizeof(ap_lua_server_cfg));
1974 cfg->root_path = NULL;
1979 static int lua_request_hook(lua_State *L, request_rec *r)
1981 ap_lua_push_request(L, r);
1985 static int lua_pre_config(apr_pool_t *pconf, apr_pool_t *plog,
1988 ap_mutex_register(pconf, "lua-ivm-shm", NULL, APR_LOCK_DEFAULT, 0);
1992 static int lua_post_config(apr_pool_t *pconf, apr_pool_t *plog,
1993 apr_pool_t *ptemp, server_rec *s)
1996 const char *tempdir;
1999 lua_ssl_val = APR_RETRIEVE_OPTIONAL_FN(ssl_var_lookup);
2000 lua_ssl_is_https = APR_RETRIEVE_OPTIONAL_FN(ssl_is_https);
2002 if (ap_state_query(AP_SQ_MAIN_STATE) == AP_SQ_MS_CREATE_PRE_CONFIG)
2005 /* Create ivm mutex */
2006 rs = ap_global_mutex_create(&lua_ivm_mutex, NULL, "lua-ivm-shm", NULL,
2008 if (APR_SUCCESS != rs) {
2009 return HTTP_INTERNAL_SERVER_ERROR;
2012 /* Create shared memory space */
2013 rs = apr_temp_dir_get(&tempdir, pconf);
2014 if (rs != APR_SUCCESS) {
2015 ap_log_error(APLOG_MARK, APLOG_ERR, rs, s, APLOGNO(02664)
2016 "mod_lua IVM: Failed to find temporary directory");
2017 return HTTP_INTERNAL_SERVER_ERROR;
2019 lua_ivm_shmfile = apr_psprintf(pconf, "%s/httpd_lua_shm.%ld", tempdir,
2020 (long int)getpid());
2021 rs = apr_shm_create(&lua_ivm_shm, sizeof(apr_pool_t**),
2022 (const char *) lua_ivm_shmfile, pconf);
2023 if (rs != APR_SUCCESS) {
2024 ap_log_error(APLOG_MARK, APLOG_ERR, rs, s, APLOGNO(02665)
2025 "mod_lua: Failed to create shared memory segment on file %s",
2027 return HTTP_INTERNAL_SERVER_ERROR;
2029 pool = (apr_pool_t **)apr_shm_baseaddr_get(lua_ivm_shm);
2030 apr_pool_create(pool, pconf);
2031 apr_pool_cleanup_register(pconf, NULL, shm_cleanup_wrapper,
2032 apr_pool_cleanup_null);
2035 static void *overlay_hook_specs(apr_pool_t *p,
2038 const void *overlay_val,
2039 const void *base_val,
2042 const apr_array_header_t *overlay_info = (const apr_array_header_t*)overlay_val;
2043 const apr_array_header_t *base_info = (const apr_array_header_t*)base_val;
2044 return apr_array_append(p, base_info, overlay_info);
2047 static void *merge_dir_config(apr_pool_t *p, void *basev, void *overridesv)
2049 ap_lua_dir_cfg *a, *base, *overrides;
2051 a = (ap_lua_dir_cfg *)apr_pcalloc(p, sizeof(ap_lua_dir_cfg));
2052 base = (ap_lua_dir_cfg*)basev;
2053 overrides = (ap_lua_dir_cfg*)overridesv;
2055 a->pool = overrides->pool;
2056 a->dir = apr_pstrdup(p, overrides->dir);
2058 a->vm_scope = (overrides->vm_scope == AP_LUA_SCOPE_UNSET) ? base->vm_scope: overrides->vm_scope;
2059 a->inherit = (overrides->inherit == AP_LUA_INHERIT_UNSET) ? base->inherit : overrides->inherit;
2060 a->codecache = (overrides->codecache == AP_LUA_CACHE_UNSET) ? base->codecache : overrides->codecache;
2062 a->vm_min = (overrides->vm_min == 0) ? base->vm_min : overrides->vm_min;
2063 a->vm_max = (overrides->vm_max == 0) ? base->vm_max : overrides->vm_max;
2065 if (a->inherit == AP_LUA_INHERIT_UNSET || a->inherit == AP_LUA_INHERIT_PARENT_FIRST) {
2066 a->package_paths = apr_array_append(p, base->package_paths, overrides->package_paths);
2067 a->package_cpaths = apr_array_append(p, base->package_cpaths, overrides->package_cpaths);
2068 a->mapped_handlers = apr_array_append(p, base->mapped_handlers, overrides->mapped_handlers);
2069 a->mapped_filters = apr_array_append(p, base->mapped_filters, overrides->mapped_filters);
2070 a->hooks = apr_hash_merge(p, overrides->hooks, base->hooks, overlay_hook_specs, NULL);
2072 else if (a->inherit == AP_LUA_INHERIT_PARENT_LAST) {
2073 a->package_paths = apr_array_append(p, overrides->package_paths, base->package_paths);
2074 a->package_cpaths = apr_array_append(p, overrides->package_cpaths, base->package_cpaths);
2075 a->mapped_handlers = apr_array_append(p, overrides->mapped_handlers, base->mapped_handlers);
2076 a->mapped_filters = apr_array_append(p, overrides->mapped_filters, base->mapped_filters);
2077 a->hooks = apr_hash_merge(p, base->hooks, overrides->hooks, overlay_hook_specs, NULL);
2080 a->package_paths = overrides->package_paths;
2081 a->package_cpaths = overrides->package_cpaths;
2082 a->mapped_handlers= overrides->mapped_handlers;
2083 a->mapped_filters= overrides->mapped_filters;
2084 a->hooks= overrides->hooks;
2090 static void lua_register_hooks(apr_pool_t *p)
2092 /* ap_register_output_filter("luahood", luahood, NULL, AP_FTYPE_RESOURCE); */
2093 ap_hook_handler(lua_handler, NULL, NULL, APR_HOOK_MIDDLE);
2094 ap_hook_create_request(create_request_config, NULL, NULL,
2097 /* http_request.h hooks */
2098 ap_hook_translate_name(lua_translate_name_harness_first, NULL, NULL,
2100 ap_hook_translate_name(lua_translate_name_harness, NULL, NULL,
2102 ap_hook_translate_name(lua_translate_name_harness_last, NULL, NULL,
2105 ap_hook_fixups(lua_fixup_harness, NULL, NULL, APR_HOOK_MIDDLE);
2106 ap_hook_map_to_storage(lua_map_to_storage_harness, NULL, NULL,
2109 /* XXX: Does not work :(
2110 * ap_hook_check_user_id(lua_check_user_id_harness_first, NULL, NULL,
2113 ap_hook_check_user_id(lua_check_user_id_harness, NULL, NULL,
2115 /* XXX: Does not work :(
2116 * ap_hook_check_user_id(lua_check_user_id_harness_last, NULL, NULL,
2119 ap_hook_type_checker(lua_type_checker_harness, NULL, NULL,
2122 ap_hook_access_checker(lua_access_checker_harness_first, NULL, NULL,
2124 ap_hook_access_checker(lua_access_checker_harness, NULL, NULL,
2126 ap_hook_access_checker(lua_access_checker_harness_last, NULL, NULL,
2128 ap_hook_auth_checker(lua_auth_checker_harness_first, NULL, NULL,
2130 ap_hook_auth_checker(lua_auth_checker_harness, NULL, NULL,
2132 ap_hook_auth_checker(lua_auth_checker_harness_last, NULL, NULL,
2135 ap_hook_insert_filter(lua_insert_filter_harness, NULL, NULL,
2137 ap_hook_quick_handler(lua_quick_harness, NULL, NULL, APR_HOOK_FIRST);
2139 ap_hook_post_config(lua_post_config, NULL, NULL, APR_HOOK_MIDDLE);
2140 ap_hook_pre_config(lua_pre_config, NULL, NULL, APR_HOOK_MIDDLE);
2142 APR_OPTIONAL_HOOK(ap_lua, lua_open, lua_open_hook, NULL, NULL,
2143 APR_HOOK_REALLY_FIRST);
2145 APR_OPTIONAL_HOOK(ap_lua, lua_request, lua_request_hook, NULL, NULL,
2146 APR_HOOK_REALLY_FIRST);
2147 ap_hook_handler(lua_map_handler, NULL, NULL, AP_LUA_HOOK_FIRST);
2149 /* Hook this right before FallbackResource kicks in */
2150 ap_hook_fixups(lua_map_handler_fixups, NULL, NULL, AP_LUA_HOOK_LAST-2);
2152 ap_hook_child_init(ap_lua_init_mutex, NULL, NULL, APR_HOOK_MIDDLE);
2155 lua_authz_providers = apr_hash_make(p);
2157 /* Logging catcher */
2158 ap_hook_log_transaction(lua_log_transaction_harness,NULL,NULL,
2162 AP_DECLARE_MODULE(lua) = {
2163 STANDARD20_MODULE_STUFF,
2164 create_dir_config, /* create per-dir config structures */
2165 merge_dir_config, /* merge per-dir config structures */
2166 create_server_config, /* create per-server config structures */
2167 NULL, /* merge per-server config structures */
2168 lua_commands, /* table of config file commands */
2169 lua_register_hooks /* register hooks */