mod_lua.xml revision ca339981c2391b88c27f5fc850a71e21ed8dfdaf
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.
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowen<description>Provides Lua hooks into various portions of the httpd
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowenrequest processing</description>
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim<p>This module allows the server to be extended with scripts written in the
889dc1728817c1c56d0c8d894c768614e346d86ecovenerLua programming language. The extension points (hooks) available with
889dc1728817c1c56d0c8d894c768614e346d86ecovener<module>mod_lua</module> include many of the hooks available to
889dc1728817c1c56d0c8d894c768614e346d86ecovenernatively compiled Apache HTTP Server modules, such as mapping requests to
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jimfiles, generating dynamic responses, access control, authentication, and
889dc1728817c1c56d0c8d894c768614e346d86ecovenerauthorization</p>
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim<p>More information on the Lua programming language can be found at the
889dc1728817c1c56d0c8d894c768614e346d86ecovener<a href="http://www.lua.org/">the Lua website</a>.</p>
8548ace6aa09b4d3e463254b53865fb38fbbbc78poirier<note><code>mod_lua</code> is still in experimental state.
8548ace6aa09b4d3e463254b53865fb38fbbbc78poirierUntil it is declared stable, usage and behavior may change
8ad875ad9725307fd052e36abc2938f89f56902csfat any time.</note>
fb51a6b789d85113d0976148685b0063c294220drbowen<section id="basicconf"><title>Basic Configuration</title>
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowen<code>mod_lua</code> provides a handler named <code>lua-script</code>,
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowenwhich can be used with an <code>AddHandler</code> directive:</p>
6265962c731aed3af3aa7242b35852f3f181d437humbedoohAddHandler lua-script .lua
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowenThis will cause <code>mod_lua</code> to handle requests for files
92e5d4326ae44f79da5cb049470daba604506846poirier<p>For more flexibility, see <directive>LuaMapHandler</directive>.
fb51a6b789d85113d0976148685b0063c294220drbowen<section id="writinghandlers"><title>Writing Handlers</title>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<p> In the Apache HTTP Server API, the handler is a specific kind of hook
889dc1728817c1c56d0c8d894c768614e346d86ecovenerresponsible for generating the response. Examples of modules that include a
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jimhandler are <module>mod_proxy</module>, <module>mod_cgi</module>,
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<p><code>mod_lua</code> always looks to invoke a Lua function for the handler, rather than
889dc1728817c1c56d0c8d894c768614e346d86ecovenerjust evaluating a script body CGI style. A handler function looks
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowensomething like this:</p>
880f77d700bc15c83bb541a053cd56e89cbfb8bchumbedooh-- example handler
991f8cc9d508110a59a25a84f8c8d8d129c49859humbedoohrequire "string"
92e5d4326ae44f79da5cb049470daba604506846poirier This is the default method name for Lua handlers, see the optional
92e5d4326ae44f79da5cb049470daba604506846poirier function-name in the LuaMapHandler directive to choose a different
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim entry point.
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jimfunction handle(r)
cf7d90693f7579700c4f7e663adb83196f903df1covener r:puts("Hello Lua World!\n")
92e5d4326ae44f79da5cb049470daba604506846poirier if r.method == 'GET' then
92e5d4326ae44f79da5cb049470daba604506846poirier for k, v in pairs( r:parseargs() ) do
92e5d4326ae44f79da5cb049470daba604506846poirier r:puts( string.format("%s: %s", k, v) )
92e5d4326ae44f79da5cb049470daba604506846poirier elseif r.method == 'POST' then
a51fa5c4960c597687688fd4a87856d5db51435fhumbedooh for k, v in pairs( r:parsebody() ) do
8a0b66c25933ca8581954e6600c5b4f1e97dc738humbedooh r:puts( string.format("%s: %s", k, v) )
a51fa5c4960c597687688fd4a87856d5db51435fhumbedooh r:puts("unknown HTTP method " .. r.method)
880f77d700bc15c83bb541a053cd56e89cbfb8bchumbedoohThis handler function just prints out the uri or form encoded
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenarguments to a plaintext page.
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenThis means (and in fact encourages) that you can have multiple
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenhandlers (or hooks, or filters) in the same script.
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<section id="writinghooks"><title>Writing Hooks</title>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<p>Hook functions are how modules (and Lua scripts) participate in the
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfprocessing of requests. Each type of hook exposed by the server exists for
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfa specific purposes such as mapping requests to the filesystem,
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfperforming access control, or setting mimetypes. General purpose hooks
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfthat simply run at handy times in the request lifecycle exist as well.</p>
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf<p>Hook functions are passed the request object as their only argument.
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfThey can return any value, depending on the hook, but most commonly
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfthey'll return OK, DONE, or DECLINED, which you can write in lua as
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf<code>apache2.DECLINED</code>, or else an HTTP status code.</p>
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf-- example hook that rewrites the URI to a filesystem path.
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfrequire 'apache2'
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sffunction translate_name(r)
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf if r.uri == "/translate-name" then
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf -- we don't care about this URL, give another module a chance
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf--[[ example hook that rewrites one URI to another URI. It returns a
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf apache2.DECLINED to give other URL mappers a chance to work on the
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf substitution, including the core translate_name hook which maps based
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf on the DocumentRoot.
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf Note: It is currently undefined as to whether this runs before or after
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf mod_alias.
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sfrequire 'apache2'
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sffunction translate_name(r)
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf if r.uri == "/translate-name" then
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf<section id="datastructures"><title>Data Structures</title>
e20c6ecbd465cd7dabb44acea6afafc7925f3a03sf <p>The request_rec is mapped in as a userdata. It has a metatable
92e5d4326ae44f79da5cb049470daba604506846poirier which lets you do useful things with it. For the most part it
92e5d4326ae44f79da5cb049470daba604506846poirier has the same fields as the request_rec struct (see httpd.h
889dc1728817c1c56d0c8d894c768614e346d86ecovener until we get better docs here) many of which are writeable as
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim well as readable. (The table fields' content can be changed, but the
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim fields themselves cannot be set to different tables.)</p>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <p>The request_rec has (at least) the following methods:</p>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier r:addoutputfilter(name|function) -- add an output filter
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier r:parseargs() -- returns a lua table containing the request's
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier query string arguments
f5b3f41700a107b9df2b3c5a1cc3e5ea775fd8fesf </example>
f5b3f41700a107b9df2b3c5a1cc3e5ea775fd8fesf r:parsebody() -- parse the request body as a POST and return
f5b3f41700a107b9df2b3c5a1cc3e5ea775fd8fesf a lua table
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier r:puts("hello", " world", "!") -- print to response body
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier r:write("a single string") -- print to response body
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier<section id="logging"><title>Logging Functions</title>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier -- examples of logging messages<br />
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier r:trace1("This is a trace log message") -- trace1 through trace8 can be used <br />
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier r:debug("This is a debug log message")<br />
7152f5d04e3782c5e93016ae2ccd960f8538b83bcovener r:info("This is an info log message")<br />
7152f5d04e3782c5e93016ae2ccd960f8538b83bcovener r:notice("This is an notice log message")<br />
7152f5d04e3782c5e93016ae2ccd960f8538b83bcovener r:warn("This is an warn log message")<br />
7152f5d04e3782c5e93016ae2ccd960f8538b83bcovener r:err("This is an err log message")<br />
7152f5d04e3782c5e93016ae2ccd960f8538b83bcovener r:alert("This is an alert log message")<br />
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier r:crit("This is an crit log message")<br />
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier r:emerg("This is an emerg log message")<br />
8230057b2a5c382433ec1d7a9d1e3f1bb1daa87acovener<p>A package named <code>apache2</code> is available with (at least) the following contents.</p>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <dd>internal constant OK. Handlers should return this if they've
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier handled the request.</dd>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <dd>internal constant DECLINED. Handlers should return this if
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier they are not going to handle the request.</dd>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <dt>apache2.PROXYREQ_NONE, apache2.PROXYREQ_PROXY, apache2.PROXYREQ_REVERSE, apache2.PROXYREQ_RESPONSE</dt>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <dd>internal constants used by <module>mod_proxy</module></dd>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier<p>(Other HTTP status codes are not yet implemented.)</p>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier<directivesynopsis>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier<description>Specify the base path for resolving relative paths for mod_lua directives</description>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier<contextlist><context>server config</context><context>virtual host</context>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier<context>directory</context><context>.htaccess</context>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier</contextlist>
f5b3f41700a107b9df2b3c5a1cc3e5ea775fd8fesf <p>Specify the base path which will be used to evaluate all
f5b3f41700a107b9df2b3c5a1cc3e5ea775fd8fesf relative paths within mod_lua. If not specified they
f5b3f41700a107b9df2b3c5a1cc3e5ea775fd8fesf will be resolved relative to the current working directory,
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier which may not always work well for a server.</p>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier</directivesynopsis>
2537429a9c5d4388773bb77437e04e5f779bb176humbedooh<directivesynopsis>
2537429a9c5d4388773bb77437e04e5f779bb176humbedooh<description>One of once, request, conn, server -- default is once</description>
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim<syntax>LuaScope once|request|conn|server [max|min max]</syntax>
65305d236fe992253daa6ee6b3176a8e0e2d87e1humbedooh<contextlist><context>server config</context><context>virtual host</context>
2537429a9c5d4388773bb77437e04e5f779bb176humbedooh<context>directory</context><context>.htaccess</context>
65305d236fe992253daa6ee6b3176a8e0e2d87e1humbedooh</contextlist>
65305d236fe992253daa6ee6b3176a8e0e2d87e1humbedooh <p>Specify the lifecycle scope of the Lua interpreter which will
2537429a9c5d4388773bb77437e04e5f779bb176humbedooh be used by handlers in this "Directory." The default is "once"</p>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <dt>once:</dt> <dd>use the interpreter once and throw it away.</dd>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <dt>request:</dt> <dd>use the interpreter to handle anything based on
2537429a9c5d4388773bb77437e04e5f779bb176humbedooh the same file within this request, which is also
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen request scoped.</dd>
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim <dt>conn:</dt> <dd>Same as request but attached to the connection_rec</dd>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen <dt>server:</dt> <dd>This one is different than others because the
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen server scope is quite long lived, and multiple threads
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen will have the same server_rec. To accommodate this
880f77d700bc15c83bb541a053cd56e89cbfb8bchumbedooh server scoped interpreter are stored in an apr
92e5d4326ae44f79da5cb049470daba604506846poirier resource list. The min and max arguments are intended
b60ba9fb00026d3dbca744c6c19afe63cba3a3d1covener to specify the pool size, but are unused at this time.</dd>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen</directivesynopsis>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<directivesynopsis>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<description>Map a path to a lua handler</description>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<syntax>LuaMapHandler uri-pattern /path/to/lua/script.lua [function-name]</syntax>
880f77d700bc15c83bb541a053cd56e89cbfb8bchumbedooh<contextlist><context>server config</context><context>virtual host</context>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<context>directory</context><context>.htaccess</context>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen</contextlist>
92e5d4326ae44f79da5cb049470daba604506846poirier <p>This directive matches a uri pattern to invoke a specific
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier handler function in a specific file. It uses PCRE regular
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier expressions to match the uri, and supports interpolating
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier match groups into both the file path and the function name
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier be careful writing your regular expressions to avoid security
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier issues.</p>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier LuaMapHandler /(\w+)/(/w+) /scripts/$1.lua handle_$2
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier handler function handle_show on the lua vm after
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier loading that file.</p>
92e5d4326ae44f79da5cb049470daba604506846poirier <p>This would invoke the "handle" function, which
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier is the default if no specific function name is
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier provided.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<description>Add a directory to lua's package.path</description>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<syntax>LuaPackagePath /path/to/include/?.lua</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
fb51a6b789d85113d0976148685b0063c294220drbowen<context>directory</context><context>.htaccess</context>
fb51a6b789d85113d0976148685b0063c294220drbowen</contextlist>
2219c51bf0756c2f6f7deb88a13baf30f141c12epoirier <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
fb51a6b789d85113d0976148685b0063c294220drbowen lua vms.</p>
4c5d2aefce1b8d2f1a391aa4b36c323b0394257ehumbedooh</directivesynopsis>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<directivesynopsis>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<description>Add a directory to lua's package.cpath</description>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<syntax>LuaPackageCPath /path/to/include/?.soa</syntax>
fb51a6b789d85113d0976148685b0063c294220drbowen<contextlist><context>server config</context><context>virtual host</context>
fb51a6b789d85113d0976148685b0063c294220drbowen<context>directory</context><context>.htaccess</context>
fb51a6b789d85113d0976148685b0063c294220drbowen</contextlist>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen <p>Add a path to lua's shared library search path. Follows the same
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim conventions as lua. This just munges the package.cpath in the
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim lua vms.</p>
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim</directivesynopsis>
4c5d2aefce1b8d2f1a391aa4b36c323b0394257ehumbedooh<directivesynopsis>
7b65675e5144193ad34c8ea7fc68e27c51f8ef1bhumbedooh<description>Configure the compiled code cache.</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<contextlist><context>server config</context><context>virtual host</context>
fb51a6b789d85113d0976148685b0063c294220drbowen<context>directory</context><context>.htaccess</context>
fb51a6b789d85113d0976148685b0063c294220drbowen</contextlist>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen 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
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen cached forever (don't stat and replace) or to never cache the
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <p>In general stat or forever is good for production, and stat or never
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic for development.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen LuaCodeCache stat<br />
fb51a6b789d85113d0976148685b0063c294220drbowen LuaCodeCache forever<br />
fb51a6b789d85113d0976148685b0063c294220drbowen LuaCodeCache never<br />
c994f52ac80f9664d2940e5ccd9e77466572013frbowen</directivesynopsis>
fb926c8c319705c9fe42d55a6ad13d9b0972cb72humbedooh<directivesynopsis>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen<description>Provide a hook for the translate name phase of request processing</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaHookTranslateName /path/to/lua/script.lua hook_function_name [early|late]</syntax>
fb51a6b789d85113d0976148685b0063c294220drbowen<contextlist><context>server config</context><context>virtual host</context>
fb51a6b789d85113d0976148685b0063c294220drbowen</contextlist>
6265962c731aed3af3aa7242b35852f3f181d437humbedooh<compatibility>The optional third argument is supported in 2.3.15 and later</compatibility>
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
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen until one of them returns apache2.OK. If your hook doesn't
fb51a6b789d85113d0976148685b0063c294220drbowen want to do the translation it should just return
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic apache2.DECLINED. If the request should stop processing, then
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jimLuaHookTranslateName /scripts/conf/hooks.lua silly_mapper
6265962c731aed3af3aa7242b35852f3f181d437humbedoohrequire "apache2"
6265962c731aed3af3aa7242b35852f3f181d437humbedoohfunction silly_mapper(r)
6265962c731aed3af3aa7242b35852f3f181d437humbedooh if r.uri == "/" then
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <note><title>Context</title><p>This directive is not valid in <directive
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic type="section" module="core">Directory</directive>, <directive
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic type="section" module="core">Files</directive>, or htaccess
fb51a6b789d85113d0976148685b0063c294220drbowen <note><title>Ordering</title><p>The optional arguments "early" or "late"
fb51a6b789d85113d0976148685b0063c294220drbowen control when this script runs relative to other modules.</p></note>
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<description>Provide a hook for the fixups phase of request
fb51a6b789d85113d0976148685b0063c294220drbowenprocessing</description>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<syntax>LuaHookFixups /path/to/lua/script.lua hook_function_name</syntax>
fb51a6b789d85113d0976148685b0063c294220drbowen<contextlist><context>server config</context><context>virtual host</context>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
fb51a6b789d85113d0976148685b0063c294220drbowen Just like LuaHookTranslateName, but executed at the fixups phase
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim<description>Provide a hook for the map_to_storage phase of request processing</description>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen<syntax>LuaHookMapToStorage /path/to/lua/script.lua hook_function_name</syntax>
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim<contextlist><context>server config</context><context>virtual host</context>
92e5d4326ae44f79da5cb049470daba604506846poirier<context>directory</context><context>.htaccess</context>
3a602d0ba8536a79a780655bb92133b571e38378poirier</contextlist>
6265962c731aed3af3aa7242b35852f3f181d437humbedooh</directivesynopsis>
6265962c731aed3af3aa7242b35852f3f181d437humbedooh<directivesynopsis>
6265962c731aed3af3aa7242b35852f3f181d437humbedooh<description>Provide a hook for the check_user_id phase of request processing</description>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen<syntax>LuaHookCheckUserID /path/to/lua/script.lua hook_function_name [early|late]</syntax>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen<contextlist><context>server config</context><context>virtual host</context>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen<context>directory</context><context>.htaccess</context>
fb51a6b789d85113d0976148685b0063c294220drbowen</contextlist>
fb51a6b789d85113d0976148685b0063c294220drbowen<compatibility>The optional third argument is supported in 2.3.15 and later</compatibility>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen <note><title>Ordering</title><p>The optional arguments "early" or "late"
457256c49209d6e56bfe63b411688ad9cb2a8429covener control when this script runs relative to other modules.</p></note>
457256c49209d6e56bfe63b411688ad9cb2a8429covener</directivesynopsis>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<description>Provide a hook for the type_checker phase of request processing</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaHookTypeChecker /path/to/lua/script.lua hook_function_name</syntax>
fb51a6b789d85113d0976148685b0063c294220drbowen<contextlist><context>server config</context><context>virtual host</context>
fb51a6b789d85113d0976148685b0063c294220drbowen<context>directory</context><context>.htaccess</context>
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim</contextlist>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<description>Provide a hook for the auth_checker phase of request processing</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaHookAuthChecker /path/to/lua/script.lua hook_function_name [early|late]</syntax>
fb51a6b789d85113d0976148685b0063c294220drbowen<contextlist><context>server config</context><context>virtual host</context>
fb51a6b789d85113d0976148685b0063c294220drbowen<context>directory</context><context>.htaccess</context>
fb51a6b789d85113d0976148685b0063c294220drbowen</contextlist>
6265962c731aed3af3aa7242b35852f3f181d437humbedooh<compatibility>The optional third argument is supported in 2.3.15 and later</compatibility>
92e5d4326ae44f79da5cb049470daba604506846poirier<p>Invoke a lua function in the auth_checker phase of processing
6265962c731aed3af3aa7242b35852f3f181d437humbedooha request. This can be used to implement arbitrary authentication
92e5d4326ae44f79da5cb049470daba604506846poirierand authorization checking. A very simple example:
92e5d4326ae44f79da5cb049470daba604506846poirierrequire 'apache2'
92e5d4326ae44f79da5cb049470daba604506846poirier-- fake authcheck hook
76c23dcc502f814f6b988038d600719db07d28becovener-- If request has no auth info, set the response header and
92e5d4326ae44f79da5cb049470daba604506846poirier-- return a 401 to ask the browser for basic auth info.
92e5d4326ae44f79da5cb049470daba604506846poirier-- If request has auth info, don't actually look at it, just
92e5d4326ae44f79da5cb049470daba604506846poirier-- pretend we got userid 'foo' and validated it.
92e5d4326ae44f79da5cb049470daba604506846poirier-- Then check if the userid is 'foo' and accept the request.
92e5d4326ae44f79da5cb049470daba604506846poirierfunction authcheck_hook(r)
457256c49209d6e56bfe63b411688ad9cb2a8429covener -- look for auth info
457256c49209d6e56bfe63b411688ad9cb2a8429covener auth = r.headers_in['Authorization']
457256c49209d6e56bfe63b411688ad9cb2a8429covener if auth ~= nil then
457256c49209d6e56bfe63b411688ad9cb2a8429covener -- fake the user
457256c49209d6e56bfe63b411688ad9cb2a8429covener if r.user == nil then
457256c49209d6e56bfe63b411688ad9cb2a8429covener r:debug("authcheck: user is nil, returning 401")
fb51a6b789d85113d0976148685b0063c294220drbowen r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
fb51a6b789d85113d0976148685b0063c294220drbowen elseif r.user == "foo" then
fb51a6b789d85113d0976148685b0063c294220drbowen r:debug('user foo: OK')
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen r:debug("authcheck: user='" .. r.user .. "'")
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
3e30fa5f420fe7302a4cdcd79cb001958fd54a13rbowen <note><title>Ordering</title><p>The optional arguments "early" or "late"
3e30fa5f420fe7302a4cdcd79cb001958fd54a13rbowen control when this script runs relative to other modules.</p></note>
3e30fa5f420fe7302a4cdcd79cb001958fd54a13rbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<description>Provide a hook for the access_checker phase of request processing</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaHookAccessChecker /path/to/lua/script.lua hook_function_name [early|late]</syntax>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<contextlist><context>server config</context><context>virtual host</context>
fb51a6b789d85113d0976148685b0063c294220drbowen<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<compatibility>The optional third argument is supported in 2.3.15 and later</compatibility>
fb51a6b789d85113d0976148685b0063c294220drbowen<p>Add your hook to the access_checker phase. An access checker
fb51a6b789d85113d0976148685b0063c294220drbowenhook function usually returns OK, DECLINED, or HTTP_FORBIDDEN.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen <note><title>Ordering</title><p>The optional arguments "early" or "late"
fb51a6b789d85113d0976148685b0063c294220drbowen control when this script runs relative to other modules.</p></note>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen</directivesynopsis>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<directivesynopsis>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<description>Provide a hook for the insert_filter phase of request processing</description>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<syntax>LuaHookInsertFilter /path/to/lua/script.lua hook_function_name</syntax>
247c1db2eb82d5c836df7bafc7380887890e11a2rjung<contextlist><context>server config</context><context>virtual host</context>
457256c49209d6e56bfe63b411688ad9cb2a8429covener<context>directory</context><context>.htaccess</context>
457256c49209d6e56bfe63b411688ad9cb2a8429covener</contextlist>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>Controls how parent configuration sections are merged into children</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaInherit none|parent-first|parent-last</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
fb51a6b789d85113d0976148685b0063c294220drbowen <usage><p>By default, if LuaHook* directives are used in overlapping
fb51a6b789d85113d0976148685b0063c294220drbowen Directory or Location configuration sections, the scripts defined in the
fb51a6b789d85113d0976148685b0063c294220drbowen more specific section are run <em>after</em> those defined in the more
9cd56c73a0fd508522ba2f6bc6c9839c478c61c3rbowen generic section (LuaInherit parent-first). You can reverse this order, or
457256c49209d6e56bfe63b411688ad9cb2a8429covener make the parent context not apply at all.</p>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <p> In previous 2.3.x releases, the default was effectively to ignore LuaHook*
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic directives from parent configuration sections.</p></usage>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</directivesynopsis>
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier<directivesynopsis>
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier<description>Provide a hook for the quick handler of request processing</description>
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier<contextlist><context>server config</context><context>virtual host</context>
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier</contextlist>
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier <note><title>Context</title><p>This directive is not valid in <directive
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier type="section" module="core">Directory</directive>, <directive
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier type="section" module="core">Files</directive>, or htaccess
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier</directivesynopsis>
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier</modulesynopsis>