mod_lua.xml revision 77a0265761f1bec2aaa0b4116c644f8066e349e3
fb51a6b789d85113d0976148685b0063c294220drbowen<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>
77a0265761f1bec2aaa0b4116c644f8066e349e3rbowen<!-- $LastChangedRevision$ -->
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen Licensed to the Apache Software Foundation (ASF) under one or more
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen contributor license agreements. See the NOTICE file distributed with
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen this work for additional information regarding copyright ownership.
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen The ASF licenses this file to You under the Apache License, Version 2.0
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen (the "License"); you may not use this file except in compliance with
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen the License. You may obtain a copy of the License at
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen Unless required by applicable law or agreed to in writing, software
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen distributed under the License is distributed on an "AS IS" BASIS,
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen See the License for the specific language governing permissions and
b07b82e44c32825d6226ee801d2ed91555e593d1rbowen limitations under the License.
4e918c77f674312af23e2ae7a1ad363d502bc84brbowen<description>Provides Lua hooks to do cool stuff</description>
fb51a6b789d85113d0976148685b0063c294220drbowen# Examples are always helpful.<br />
fb51a6b789d85113d0976148685b0063c294220drbowen<!-- References to other documents or directives -->
fb51a6b789d85113d0976148685b0063c294220drbowen<seealso><directive module="mod_useful">Useful</directive></seealso>
fb51a6b789d85113d0976148685b0063c294220drbowen<!-- Any number of sections may be included below -->
fb51a6b789d85113d0976148685b0063c294220drbowen<section id="moredocs"><title>Additional Documentation</title>
fb51a6b789d85113d0976148685b0063c294220drbowen<p>More detailed information about the module in general (as opposed to
fb51a6b789d85113d0976148685b0063c294220drbowenthe individual directives) can follow in sections containing titles.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen<p>The <code>id</code> attribute will be translated into a hypertext
fb51a6b789d85113d0976148685b0063c294220drbowenanchor target.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen<p>References to directives should use the directive tag: <directive
fb51a6b789d85113d0976148685b0063c294220drbowenmodule="mod_lua">TemplateDirective</directive>. References to
fb51a6b789d85113d0976148685b0063c294220drbowenmodules should use the module tag
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen <p>Specify the base path which will be used to evaluate all
fb51a6b789d85113d0976148685b0063c294220drbowen relative paths within mod_wombat. If not specified they
fb51a6b789d85113d0976148685b0063c294220drbowen will be resolved relative to the current working directory,
fb51a6b789d85113d0976148685b0063c294220drbowen which may not always work well for a server.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaScope once|request|conn|server [max|min max]</syntax>
fb51a6b789d85113d0976148685b0063c294220drbowen <p>Specify the lifecycle scope of the Lua interpreter which will
c994f52ac80f9664d2940e5ccd9e77466572013frbowen be used by handlers in this "Directory." The default is "once"</p>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen <dt>once:</dt> <dd>use the interpreter once and throw it away.</dd>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen <dt>request:</dt> <dd>use the interpreter to handle anything based on
fb51a6b789d85113d0976148685b0063c294220drbowen the same file within this request, which is also
c994f52ac80f9664d2940e5ccd9e77466572013frbowen request scoped.</dd>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen <dt>conn:</dt> <dd>Same as request but attached to the connection_rec</dd>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen <dt>server:</dt> <dd>This one is different than others because the
fb51a6b789d85113d0976148685b0063c294220drbowen server scope is quite long lived, and multiple threads
fb51a6b789d85113d0976148685b0063c294220drbowen will have the same server_rec. To accommodate this
fb51a6b789d85113d0976148685b0063c294220drbowen server scoped interpreter are stored in an apr
fb51a6b789d85113d0976148685b0063c294220drbowen resource list. The min and max arguments are intended
c994f52ac80f9664d2940e5ccd9e77466572013frbowen to specify the pool size, but are unused at this time.</dd>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaMapHandler uri-pattern /path/to/lua/script.lua [function-name]</syntax>
fb51a6b789d85113d0976148685b0063c294220drbowen <p>This directive matches a uri pattern to invoke a specific
fb51a6b789d85113d0976148685b0063c294220drbowen handler function in a specific file. It uses PCRE regular
fb51a6b789d85113d0976148685b0063c294220drbowen expressions to match the uri, and supports interpolating
fb51a6b789d85113d0976148685b0063c294220drbowen match groups into both the file path and the function name
fb51a6b789d85113d0976148685b0063c294220drbowen be careful writing your regular expressions to avoid security
fb51a6b789d85113d0976148685b0063c294220drbowen issues.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen LuaMapHandler /(\w+)/(/w+) /scripts/$1.lua handle_$2
fb51a6b789d85113d0976148685b0063c294220drbowen handler function handle_show on the lua vm after
fb51a6b789d85113d0976148685b0063c294220drbowen loading that file.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen <p>This would invoke the "handle" function, which
fb51a6b789d85113d0976148685b0063c294220drbowen is the default if no specific function name is
fb51a6b789d85113d0976148685b0063c294220drbowen provided.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaPackagePath /path/to/include/?.lua</syntax>
fb51a6b789d85113d0976148685b0063c294220drbowen <usage><p>Add a path to lua's module search path. Follows the same
fb51a6b789d85113d0976148685b0063c294220drbowen conventions as lua. This just munges the package.path in the
c994f52ac80f9664d2940e5ccd9e77466572013frbowen lua vms.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaPackageCPath /path/to/include/?.soa</syntax>
fb51a6b789d85113d0976148685b0063c294220drbowen <p>Add a path to lua's shared library search path. Follows the same
fb51a6b789d85113d0976148685b0063c294220drbowen conventions as lua. This just munges the package.cpath in the
c994f52ac80f9664d2940e5ccd9e77466572013frbowen lua vms.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen Specify the behavior of the in-memory code cache. The default
fb51a6b789d85113d0976148685b0063c294220drbowen is stat, which stats the top level script (not any included
fb51a6b789d85113d0976148685b0063c294220drbowen ones) each time that file is needed, and reloads it if the
fb51a6b789d85113d0976148685b0063c294220drbowen modified time indicates it is newer than the one it has
fb51a6b789d85113d0976148685b0063c294220drbowen already loaded. The other values cause it to keep the file
fb51a6b789d85113d0976148685b0063c294220drbowen cached forever (don't stat and replace) or to never cache the
c994f52ac80f9664d2940e5ccd9e77466572013frbowen <p>In general stat or forever is good production and stat or never
c994f52ac80f9664d2940e5ccd9e77466572013frbowen for deveopment.</p>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen LuaCodeCache stat<br />
c994f52ac80f9664d2940e5ccd9e77466572013frbowen LuaCodeCache forever<br />
c994f52ac80f9664d2940e5ccd9e77466572013frbowen LuaCodeCache never<br />
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaHookTranslateName /path/to/lua/script.lua hook_function_name</syntax>
fb51a6b789d85113d0976148685b0063c294220drbowen Add a hook (at APR_HOOK_MIDDLE) to the translate name phase of
fb51a6b789d85113d0976148685b0063c294220drbowen request processing. The hook function receives a single
fb51a6b789d85113d0976148685b0063c294220drbowen argument, the request_rec, and should return a status code,
fb51a6b789d85113d0976148685b0063c294220drbowen which is either an HTTP error code, or the constants defined
fb51a6b789d85113d0976148685b0063c294220drbowen in the apache2 module: apache2.OK, apache2.DECLINED, or
fb51a6b789d85113d0976148685b0063c294220drbowen <p>For those new to hooks, basically each hook will be invoked
fb51a6b789d85113d0976148685b0063c294220drbowen until one of them returns apache2.OK. If your hook doesn't
fb51a6b789d85113d0976148685b0063c294220drbowen want to do the translation it should just return
fb51a6b789d85113d0976148685b0063c294220drbowen apache2.DECLINED. If the request should stop processing, then
fb51a6b789d85113d0976148685b0063c294220drbowen LuaHookTranslateName /scripts/conf/hooks.lua silly_mapper<br />
fb51a6b789d85113d0976148685b0063c294220drbowen function silly_mapper(r)<br />
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaHookFixups /path/to/lua/script.lua hook_function_name</syntax>
fb51a6b789d85113d0976148685b0063c294220drbowen Just like LuaHookTranslateName, but executed at the fixups phase
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaHookMapToStorage /path/to/lua/script.lua hook_function_name</syntax>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaHookCheckUserID /path/to/lua/script.lua hook_function_name</syntax>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaHookTypeChecker /path/to/lua/script.lua hook_function_name</syntax>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaHookAuthChecker /path/to/lua/script.lua hook_function_name</syntax>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaHookAccessChecker /path/to/lua/script.lua hook_function_name</syntax>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaHookAuthChecker /path/to/lua/script.lua hook_function_name</syntax>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaHookInsertFilter /path/to/lua/script.lua hook_function_name</syntax>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen</modulesynopsis>