mod_lua.xml revision 4c5d2aefce1b8d2f1a391aa4b36c323b0394257e
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
8548ace6aa09b4d3e463254b53865fb38fbbbc78poirierat any time, even between stable releases of the 2.4.x series.
8548ace6aa09b4d3e463254b53865fb38fbbbc78poirierBe sure to check the CHANGES file before upgrading.</note>
fb51a6b789d85113d0976148685b0063c294220drbowen<section id="basicconf"><title>Basic Configuration</title>
fb51a6b789d85113d0976148685b0063c294220drbowen</highlight>
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowen<code>mod_lua</code> provides a handler named <code>lua-script</code>,
fb51a6b789d85113d0976148685b0063c294220drbowenwhich can be used with an <code>AddHandler</code> directive:</p>
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowenAddHandler lua-script .lua
fb51a6b789d85113d0976148685b0063c294220drbowen</highlight>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirierThis will cause <code>mod_lua</code> to handle requests for files
92e5d4326ae44f79da5cb049470daba604506846poirier<p>For more flexibility, see <directive>LuaMapHandler</directive>.
889dc1728817c1c56d0c8d894c768614e346d86ecovener<section id="writinghandlers"><title>Writing Handlers</title>
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim<p> In the Apache HTTP Server API, the handler is a specific kind of hook
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jimresponsible for generating the response. Examples of modules that include a
889dc1728817c1c56d0c8d894c768614e346d86ecovenerhandler 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
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenjust evaluating a script body CGI style. A handler function looks
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowensomething like this:</p>
92e5d4326ae44f79da5cb049470daba604506846poirier-- example handler
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jimrequire "string"
cf7d90693f7579700c4f7e663adb83196f903df1covener This is the default method name for Lua handlers, see the optional
cf7d90693f7579700c4f7e663adb83196f903df1covener function-name in the LuaMapHandler directive to choose a different
92e5d4326ae44f79da5cb049470daba604506846poirier entry point.
92e5d4326ae44f79da5cb049470daba604506846poirierfunction handle(r)
92e5d4326ae44f79da5cb049470daba604506846poirier 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\n", k, v) )
92e5d4326ae44f79da5cb049470daba604506846poirier elseif r.method == 'POST' then
92e5d4326ae44f79da5cb049470daba604506846poirier for k, v in pairs( r:parsebody() ) do
92e5d4326ae44f79da5cb049470daba604506846poirier r:puts( string.format("%s: %s\n", k, v) )
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:puts("Unsupported HTTP method " .. r.method)
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen</highlight>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenThis 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.
889dc1728817c1c56d0c8d894c768614e346d86ecovener<p><module>mod_authz_core</module> provides a high-level interface to
889dc1728817c1c56d0c8d894c768614e346d86ecovenerauthorization that is much easier to use than using into the relevant
92e5d4326ae44f79da5cb049470daba604506846poirierhooks directly. The first argument to the
92e5d4326ae44f79da5cb049470daba604506846poirier<directive module="mod_authz_core">Require</directive> directive gives
92e5d4326ae44f79da5cb049470daba604506846poirierthe name of the responsible authorization provider. For any
92e5d4326ae44f79da5cb049470daba604506846poirier<directive module="mod_authz_core">Require</directive> line,
92e5d4326ae44f79da5cb049470daba604506846poirier<module>mod_authz_core</module> will call the authorization provider
92e5d4326ae44f79da5cb049470daba604506846poirierof the given name, passing the rest of the line as parameters. The
92e5d4326ae44f79da5cb049470daba604506846poirierprovider will then check authorization and pass the result as return
bb57315f942d09c744543fe41e453bd0181fd93ecovener<p>The authz provider is normally called before authentication. If it needs to
bb57315f942d09c744543fe41e453bd0181fd93ecovenerknow the authenticated user name (or if the user will be authenticated at
bb57315f942d09c744543fe41e453bd0181fd93ecovenerall), the provider must return <code>apache2.AUTHZ_DENIED_NO_USER</code>.
bb57315f942d09c744543fe41e453bd0181fd93ecovenerThis will cause authentication to proceed and the authz provider to be
bb57315f942d09c744543fe41e453bd0181fd93ecovenercalled a second time.</p>
bb57315f942d09c744543fe41e453bd0181fd93ecovener<p>The following authz provider function takes two arguments, one ip
bb57315f942d09c744543fe41e453bd0181fd93ecoveneraddress and one user name. It will allow access from the given ip address
bb57315f942d09c744543fe41e453bd0181fd93ecovenerwithout authentication, or if the authenticated user matches the second
bb57315f942d09c744543fe41e453bd0181fd93ecovenerargument:</p>
bb57315f942d09c744543fe41e453bd0181fd93ecovenerrequire 'apache2'
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jimfunction authz_check_foo(r, ip, user)
8e9a311b466b8a3d2782af71a432a6a7ee2cd2f0covener elseif r.user == nil then
92e5d4326ae44f79da5cb049470daba604506846poirier elseif r.user == user then
92e5d4326ae44f79da5cb049470daba604506846poirier</highlight>
92e5d4326ae44f79da5cb049470daba604506846poirier<p>The following configuration registers this function as provider
92e5d4326ae44f79da5cb049470daba604506846poirier<code>foo</code> and configures it for URL <code>/</code>:</p>
92e5d4326ae44f79da5cb049470daba604506846poirierLuaAuthzProvider foo authz_provider.lua authz_check_foo
92e5d4326ae44f79da5cb049470daba604506846poirier<Location />
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen Require foo 10.1.2.3 john_doe
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen</Location>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen</highlight>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<section id="writinghooks"><title>Writing Hooks</title>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<p>Hook functions are how modules (and Lua scripts) participate in the
92e5d4326ae44f79da5cb049470daba604506846poirierprocessing of requests. Each type of hook exposed by the server exists for
92e5d4326ae44f79da5cb049470daba604506846poiriera specific purposes such as mapping requests to the filesystem,
249cc9b3d83d3c60666269b90ecb9f1390d32165poirierperforming access control, or setting mimetypes. General purpose hooks
249cc9b3d83d3c60666269b90ecb9f1390d32165poirierthat simply run at handy times in the request lifecycle exist as well.</p>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier<p>Hook functions are passed the request object as their only argument.
249cc9b3d83d3c60666269b90ecb9f1390d32165poirierThey can return any value, depending on the hook, but most commonly
249cc9b3d83d3c60666269b90ecb9f1390d32165poirierthey'll return OK, DONE, or DECLINED, which you can write in lua as
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier<code>apache2.OK</code>, <code>apache2.DONE</code>, or
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier<code>apache2.DECLINED</code>, or else an HTTP status code.</p>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier-- example hook that rewrites the URI to a filesystem path.
249cc9b3d83d3c60666269b90ecb9f1390d32165poirierrequire 'apache2'
fc57cc74ee4e73618f74a7a62ea6ac77546666dacovenerfunction translate_name(r)
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier if r.uri == "/translate-name" then
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier -- we don't care about this URL, give another module a chance
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier</highlight>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier--[[ example hook that rewrites one URI to another URI. It returns a
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier apache2.DECLINED to give other URL mappers a chance to work on the
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier substitution, including the core translate_name hook which maps based
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier on the DocumentRoot.
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier Note: It is currently undefined as to whether this runs before or after
249cc9b3d83d3c60666269b90ecb9f1390d32165poirierrequire 'apache2'
249cc9b3d83d3c60666269b90ecb9f1390d32165poirierfunction translate_name(r)
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier if r.uri == "/translate-name" then
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier</highlight>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier<section id="datastructures"><title>Data Structures</title>
7152f5d04e3782c5e93016ae2ccd960f8538b83bcovener <p>The request_rec is mapped in as a userdata. It has a metatable
7152f5d04e3782c5e93016ae2ccd960f8538b83bcovener which lets you do useful things with it. For the most part it
7152f5d04e3782c5e93016ae2ccd960f8538b83bcovener has the same fields as the request_rec struct (see httpd.h
7152f5d04e3782c5e93016ae2ccd960f8538b83bcovener until we get better docs here) many of which are writeable as
7152f5d04e3782c5e93016ae2ccd960f8538b83bcovener well as readable. (The table fields' content can be changed, but the
7152f5d04e3782c5e93016ae2ccd960f8538b83bcovener fields themselves cannot be set to different tables.)</p>
fb51a6b789d85113d0976148685b0063c294220drbowen <p>The request_rec has (at least) the following methods:</p>
fb51a6b789d85113d0976148685b0063c294220drbowen r:addoutputfilter(name|function) -- add an output filter
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen </highlight>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic r:parseargs() -- returns a Lua table containing the request's query string arguments
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic </highlight>
fb51a6b789d85113d0976148685b0063c294220drbowen r:parsebody() -- parse any POST data in the request and return it as a Lua table
fb51a6b789d85113d0976148685b0063c294220drbowen </highlight>
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim r:puts("hello", " world", "!") -- print to response body
c994f52ac80f9664d2940e5ccd9e77466572013frbowen </highlight>
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim r:write("a single string") -- print to response body
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim </highlight>
fb51a6b789d85113d0976148685b0063c294220drbowen<section id="logging"><title>Logging Functions</title>
fb51a6b789d85113d0976148685b0063c294220drbowen -- examples of logging messages<br />
c994f52ac80f9664d2940e5ccd9e77466572013frbowen r:trace1("This is a trace log message") -- trace1 through trace8 can be used <br />
c994f52ac80f9664d2940e5ccd9e77466572013frbowen r:debug("This is a debug log message")<br />
c994f52ac80f9664d2940e5ccd9e77466572013frbowen r:info("This is an info log message")<br />
fb51a6b789d85113d0976148685b0063c294220drbowen r:notice("This is an notice log message")<br />
fb51a6b789d85113d0976148685b0063c294220drbowen r:warn("This is an warn log message")<br />
fb51a6b789d85113d0976148685b0063c294220drbowen r:err("This is an err log message")<br />
fb51a6b789d85113d0976148685b0063c294220drbowen r:alert("This is an alert log message")<br />
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen r:crit("This is an crit log message")<br />
fb51a6b789d85113d0976148685b0063c294220drbowen r:emerg("This is an emerg log message")<br />
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</highlight>
fb51a6b789d85113d0976148685b0063c294220drbowen<p>A package named <code>apache2</code> is available with (at least) the following contents.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen <dd>internal constant OK. Handlers should return this if they've
fb51a6b789d85113d0976148685b0063c294220drbowen handled the request.</dd>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen <dd>internal constant DECLINED. Handlers should return this if
fb51a6b789d85113d0976148685b0063c294220drbowen they are not going to handle the request.</dd>
fb51a6b789d85113d0976148685b0063c294220drbowen <dt>apache2.PROXYREQ_NONE, apache2.PROXYREQ_PROXY, apache2.PROXYREQ_REVERSE, apache2.PROXYREQ_RESPONSE</dt>
fb51a6b789d85113d0976148685b0063c294220drbowen <dd>internal constants used by <module>mod_proxy</module></dd>
fb51a6b789d85113d0976148685b0063c294220drbowen<p>(Other HTTP status codes are not yet implemented.)</p>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<description>Specify the base path for resolving relative paths for mod_lua directives</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<contextlist><context>server config</context><context>virtual host</context>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<context>directory</context><context>.htaccess</context>
fb51a6b789d85113d0976148685b0063c294220drbowen</contextlist>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <p>Specify the base path which will be used to evaluate all
fb51a6b789d85113d0976148685b0063c294220drbowen relative paths within mod_lua. If not specified they
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim will be resolved relative to the current working directory,
c994f52ac80f9664d2940e5ccd9e77466572013frbowen which may not always work well for a server.</p>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen<description>One of once, request, conn -- default is once</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaScope once|request|conn|thread [max|min max]</syntax>
fb51a6b789d85113d0976148685b0063c294220drbowen<contextlist><context>server config</context><context>virtual host</context>
fb51a6b789d85113d0976148685b0063c294220drbowen<context>directory</context><context>.htaccess</context>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen</contextlist>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <p>Specify the lifecycle scope of the Lua interpreter which will
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic be used by handlers in this "Directory." The default is "once"</p>
fb51a6b789d85113d0976148685b0063c294220drbowen <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
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim the same file within this request, which is also
c994f52ac80f9664d2940e5ccd9e77466572013frbowen request scoped.</dd>
fb51a6b789d85113d0976148685b0063c294220drbowen <dt>conn:</dt> <dd>Same as request but attached to the connection_rec</dd>
fb51a6b789d85113d0976148685b0063c294220drbowen <dt>thread:</dt> <dd>Use the interpreter for the lifetime of the thread
fb51a6b789d85113d0976148685b0063c294220drbowen handling the request.</dd>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<!-- not implemented
fb51a6b789d85113d0976148685b0063c294220drbowen <dt>server:</dt> <dd>This one is different than others because the
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier server scope is quite long lived, and multiple threads
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic will have the same server_rec. To accommodate this
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic server scoped interpreter are stored in an apr
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic resource list. The min and max arguments are intended
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic to specify the pool size, but are unused at this time.</dd>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen<syntax>LuaMapHandler uri-pattern /path/to/lua/script.lua [function-name]</syntax>
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim<contextlist><context>server config</context><context>virtual host</context>
92e5d4326ae44f79da5cb049470daba604506846poirier<context>directory</context><context>.htaccess</context>
3a602d0ba8536a79a780655bb92133b571e38378poirier</contextlist>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen <p>This directive matches a uri pattern to invoke a specific
c994f52ac80f9664d2940e5ccd9e77466572013frbowen handler function in a specific file. It uses PCRE regular
c994f52ac80f9664d2940e5ccd9e77466572013frbowen expressions to match the uri, and supports interpolating
c994f52ac80f9664d2940e5ccd9e77466572013frbowen match groups into both the file path and the function name
c994f52ac80f9664d2940e5ccd9e77466572013frbowen be careful writing your regular expressions to avoid security
c994f52ac80f9664d2940e5ccd9e77466572013frbowen issues.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen LuaMapHandler /(\w+)/(\w+) /scripts/$1.lua handle_$2
fb51a6b789d85113d0976148685b0063c294220drbowen </highlight>
457256c49209d6e56bfe63b411688ad9cb2a8429covener handler function handle_show on the lua vm after
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic loading that file.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen</highlight>
fb51a6b789d85113d0976148685b0063c294220drbowen <p>This would invoke the "handle" function, which
fb51a6b789d85113d0976148685b0063c294220drbowen is the default if no specific function name is
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim provided.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<description>Add a directory to lua's package.path</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaPackagePath /path/to/include/?.lua</syntax>
fb51a6b789d85113d0976148685b0063c294220drbowen<contextlist><context>server config</context><context>virtual host</context>
fb51a6b789d85113d0976148685b0063c294220drbowen<context>directory</context><context>.htaccess</context>
fb51a6b789d85113d0976148685b0063c294220drbowen</contextlist>
fb51a6b789d85113d0976148685b0063c294220drbowen <usage><p>Add a path to lua's module search path. Follows the same
92e5d4326ae44f79da5cb049470daba604506846poirier conventions as lua. This just munges the package.path in the
92e5d4326ae44f79da5cb049470daba604506846poirier lua vms.</p>
92e5d4326ae44f79da5cb049470daba604506846poirier </highlight>
92e5d4326ae44f79da5cb049470daba604506846poirier</directivesynopsis>
92e5d4326ae44f79da5cb049470daba604506846poirier<directivesynopsis>
92e5d4326ae44f79da5cb049470daba604506846poirier<description>Add a directory to lua's package.cpath</description>
457256c49209d6e56bfe63b411688ad9cb2a8429covener<syntax>LuaPackageCPath /path/to/include/?.soa</syntax>
457256c49209d6e56bfe63b411688ad9cb2a8429covener<contextlist><context>server config</context><context>virtual host</context>
457256c49209d6e56bfe63b411688ad9cb2a8429covener<context>directory</context><context>.htaccess</context>
457256c49209d6e56bfe63b411688ad9cb2a8429covener</contextlist>
457256c49209d6e56bfe63b411688ad9cb2a8429covener <p>Add a path to lua's shared library search path. Follows the same
457256c49209d6e56bfe63b411688ad9cb2a8429covener conventions as lua. This just munges the package.cpath in the
fb51a6b789d85113d0976148685b0063c294220drbowen lua vms.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<description>Configure the compiled code cache.</description>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
3e30fa5f420fe7302a4cdcd79cb001958fd54a13rbowen</contextlist>
3e30fa5f420fe7302a4cdcd79cb001958fd54a13rbowen 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>
fb51a6b789d85113d0976148685b0063c294220drbowenLuaCodeCache stat
fb51a6b789d85113d0976148685b0063c294220drbowenLuaCodeCache forever
fb51a6b789d85113d0976148685b0063c294220drbowenLuaCodeCache never
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen </highlight>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</directivesynopsis>
247c1db2eb82d5c836df7bafc7380887890e11a2rjung<directivesynopsis>
457256c49209d6e56bfe63b411688ad9cb2a8429covener<description>Provide a hook for the translate name phase of request processing</description>
457256c49209d6e56bfe63b411688ad9cb2a8429covener<syntax>LuaHookTranslateName /path/to/lua/script.lua hook_function_name [early|late]</syntax>
457256c49209d6e56bfe63b411688ad9cb2a8429covener<contextlist><context>server config</context><context>virtual host</context>
fb51a6b789d85113d0976148685b0063c294220drbowen</contextlist>
fb51a6b789d85113d0976148685b0063c294220drbowen<compatibility>The optional third argument is supported in 2.3.15 and later</compatibility>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic Add a hook (at APR_HOOK_MIDDLE) to the translate name phase of
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic request processing. The hook function receives a single
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic argument, the request_rec, and should return a status code,
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic 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
9cd56c73a0fd508522ba2f6bc6c9839c478c61c3rbowen want to do the translation it should just return
457256c49209d6e56bfe63b411688ad9cb2a8429covener apache2.DECLINED. If the request should stop processing, then
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirierLuaHookTranslateName /scripts/conf/hooks.lua silly_mapper
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier</highlight>
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirierrequire "apache2"
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirierfunction silly_mapper(r)
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier if r.uri == "/" then
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier</highlight>
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 <note><title>Ordering</title><p>The optional arguments "early" or "late"
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier control when this script runs relative to other modules.</p></note>
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier</directivesynopsis>
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier<directivesynopsis>
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier<description>Provide a hook for the fixups phase of request
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirierprocessing</description>
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier<syntax>LuaHookFixups /path/to/lua/script.lua hook_function_name</syntax>
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier<contextlist><context>server config</context><context>virtual host</context>
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier<context>directory</context><context>.htaccess</context>
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier</contextlist>
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier Just like LuaHookTranslateName, but executed at the fixups phase
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
9cd56c73a0fd508522ba2f6bc6c9839c478c61c3rbowen<directivesynopsis>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<description>Provide a hook for the map_to_storage phase of request processing</description>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<syntax>LuaHookMapToStorage /path/to/lua/script.lua hook_function_name</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
247c1db2eb82d5c836df7bafc7380887890e11a2rjung</contextlist>
92e5d4326ae44f79da5cb049470daba604506846poirier</directivesynopsis>
457256c49209d6e56bfe63b411688ad9cb2a8429covener<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<description>Provide a hook for the check_user_id phase of request processing</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<syntax>LuaHookCheckUserID /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>
9cd56c73a0fd508522ba2f6bc6c9839c478c61c3rbowen</contextlist>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<compatibility>The optional third argument is supported in 2.3.15 and later</compatibility>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <note><title>Ordering</title><p>The optional arguments "early" or "late"
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic control when this script runs relative to other modules.</p></note>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
ae600ca541efc686b34f8b1f21bd3d0741d37674covener<directivesynopsis>
ae600ca541efc686b34f8b1f21bd3d0741d37674covener<description>Provide a hook for the type_checker phase of request processing</description>
ae600ca541efc686b34f8b1f21bd3d0741d37674covener<syntax>LuaHookTypeChecker /path/to/lua/script.lua hook_function_name</syntax>
ae600ca541efc686b34f8b1f21bd3d0741d37674covener<contextlist><context>server config</context><context>virtual host</context>
ae600ca541efc686b34f8b1f21bd3d0741d37674covener<context>directory</context><context>.htaccess</context>
ae600ca541efc686b34f8b1f21bd3d0741d37674covener</contextlist>
ca339981c2391b88c27f5fc850a71e21ed8dfdafsf</directivesynopsis>
ae600ca541efc686b34f8b1f21bd3d0741d37674covener<directivesynopsis>
ae600ca541efc686b34f8b1f21bd3d0741d37674covener<description>Provide a hook for the auth_checker phase of request processing</description>
ae600ca541efc686b34f8b1f21bd3d0741d37674covener<syntax>LuaHookAuthChecker /path/to/lua/script.lua hook_function_name [early|late]</syntax>
ae600ca541efc686b34f8b1f21bd3d0741d37674covener<contextlist><context>server config</context><context>virtual host</context>
ae600ca541efc686b34f8b1f21bd3d0741d37674covener<context>directory</context><context>.htaccess</context>
ae600ca541efc686b34f8b1f21bd3d0741d37674covener</contextlist>
ae600ca541efc686b34f8b1f21bd3d0741d37674covener<compatibility>The optional third argument is supported in 2.3.15 and later</compatibility>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<p>Invoke a lua function in the auth_checker phase of processing
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowena request. This can be used to implement arbitrary authentication
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowenand authorization checking. A very simple example:
99e316bc4b9b2b5754165939ac14b6d16132cce1igalicrequire 'apache2'
457256c49209d6e56bfe63b411688ad9cb2a8429covener-- fake authcheck hook
457256c49209d6e56bfe63b411688ad9cb2a8429covener-- If request has no auth info, set the response header and
457256c49209d6e56bfe63b411688ad9cb2a8429covener-- return a 401 to ask the browser for basic auth info.
457256c49209d6e56bfe63b411688ad9cb2a8429covener-- If request has auth info, don't actually look at it, just
457256c49209d6e56bfe63b411688ad9cb2a8429covener-- pretend we got userid 'foo' and validated it.
457256c49209d6e56bfe63b411688ad9cb2a8429covener-- Then check if the userid is 'foo' and accept the request.
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowenfunction authcheck_hook(r)
fb51a6b789d85113d0976148685b0063c294220drbowen -- look for auth info
auth = r.headers_in['Authorization']
r.user = 'foo'
if r.user == nil then
r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
elseif r.user == "foo" then
r:debug("authcheck: user='" .. r.user .. "'")
r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
return apache2.OK
LuaAuthzProvider foo authz.lua authz_check_foo