b07b82e44c32825d6226ee801d2ed91555e593d1rbowen<?xml version="1.0"?>

fb51a6b789d85113d0976148685b0063c294220drbowen<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">

b07b82e44c32825d6226ee801d2ed91555e593d1rbowen<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>

b07b82e44c32825d6226ee801d2ed91555e593d1rbowen

b07b82e44c32825d6226ee801d2ed91555e593d1rbowen

b07b82e44c32825d6226ee801d2ed91555e593d1rbowen<modulesynopsis metafile="mod_lua.xml.meta">

fb51a6b789d85113d0976148685b0063c294220drbowen

fb51a6b789d85113d0976148685b0063c294220drbowen<name>mod_lua</name>

fb51a6b789d85113d0976148685b0063c294220drbowen

4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowen<description>Provides Lua hooks into various portions of the httpd

4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowenrequest processing</description>

b75b4bfd9e8ec9fbf28a95174dc0e4d420f744a8sf<status>Experimental</status>

fb51a6b789d85113d0976148685b0063c294220drbowen<sourcefile>mod_lua.c</sourcefile>

fb51a6b789d85113d0976148685b0063c294220drbowen<identifier>lua_module</identifier>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier<compatibility>2.3 and later</compatibility>

fb51a6b789d85113d0976148685b0063c294220drbowen

fb51a6b789d85113d0976148685b0063c294220drbowen<summary>

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>

889dc1728817c1c56d0c8d894c768614e346d86ecovener

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>

fb51a6b789d85113d0976148685b0063c294220drbowen

8548ace6aa09b4d3e463254b53865fb38fbbbc78poirier<note><code>mod_lua</code> is still in experimental state.

8548ace6aa09b4d3e463254b53865fb38fbbbc78poirierUntil it is declared stable, usage and behavior may change

8ad875ad9725307fd052e36abc2938f89f56902csfat any time, even between stable releases of the 2.4.x series.

8ad875ad9725307fd052e36abc2938f89f56902csfBe sure to check the CHANGES file before upgrading.</note>

8548ace6aa09b4d3e463254b53865fb38fbbbc78poirier

fb51a6b789d85113d0976148685b0063c294220drbowen<note type="warning"><title>Warning</title>

fb51a6b789d85113d0976148685b0063c294220drbowen<p>This module holds a great deal of power over httpd, which is both a

4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowenstrength and a potential security risk. It is <strong>not</strong> recommended

fb51a6b789d85113d0976148685b0063c294220drbowenthat you use this module on a server that is shared with users you do not

3e30fa5f420fe7302a4cdcd79cb001958fd54a13rbowentrust, as it can be abused to change the internal workings of httpd.</p>

fb51a6b789d85113d0976148685b0063c294220drbowen</note>

6265962c731aed3af3aa7242b35852f3f181d437humbedooh

2219c51bf0756c2f6f7deb88a13baf30f141c12epoirier</summary>

6265962c731aed3af3aa7242b35852f3f181d437humbedooh

fb51a6b789d85113d0976148685b0063c294220drbowen<section id="basicconf"><title>Basic Configuration</title>

4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowen

4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowen<p>The basic module loading directive is</p>

4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowen

fb51a6b789d85113d0976148685b0063c294220drbowen<highlight language="config">

6265962c731aed3af3aa7242b35852f3f181d437humbedooh LoadModule lua_module modules/mod_lua.so

4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowen</highlight>

6265962c731aed3af3aa7242b35852f3f181d437humbedooh

fb51a6b789d85113d0976148685b0063c294220drbowen<p>

4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowen<code>mod_lua</code> provides a handler named <code>lua-script</code>,

249cc9b3d83d3c60666269b90ecb9f1390d32165poirierwhich can be used with an <code>AddHandler</code> directive:</p>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier<highlight language="config">

4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowenAddHandler lua-script .lua

92e5d4326ae44f79da5cb049470daba604506846poirier</highlight>

92e5d4326ae44f79da5cb049470daba604506846poirier

92e5d4326ae44f79da5cb049470daba604506846poirier<p>

92e5d4326ae44f79da5cb049470daba604506846poirierThis will cause <code>mod_lua</code> to handle requests for files

fb51a6b789d85113d0976148685b0063c294220drbowenending in <code>.lua</code> by invoking that file's

fb51a6b789d85113d0976148685b0063c294220drbowen<code>handle</code> function.

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen</p>

889dc1728817c1c56d0c8d894c768614e346d86ecovener

860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim<p>For more flexibility, see <directive>LuaMapHandler</directive>.

860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim</p>

889dc1728817c1c56d0c8d894c768614e346d86ecovener

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen</section>

889dc1728817c1c56d0c8d894c768614e346d86ecovener

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<section id="writinghandlers"><title>Writing Handlers</title>

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<p> In the Apache HTTP Server API, the handler is a specific kind of hook

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenresponsible for generating the response. Examples of modules that include a

880f77d700bc15c83bb541a053cd56e89cbfb8bchumbedoohhandler are <module>mod_proxy</module>, <module>mod_cgi</module>,

880f77d700bc15c83bb541a053cd56e89cbfb8bchumbedoohand <module>mod_status</module>.</p>

880f77d700bc15c83bb541a053cd56e89cbfb8bchumbedooh

92e5d4326ae44f79da5cb049470daba604506846poirier<p><code>mod_lua</code> always looks to invoke a Lua function for the handler, rather than

92e5d4326ae44f79da5cb049470daba604506846poirierjust evaluating a script body CGI style. A handler function looks

92e5d4326ae44f79da5cb049470daba604506846poiriersomething like this:</p>

92e5d4326ae44f79da5cb049470daba604506846poirier

860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim

860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim<highlight language="lua">

860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim<strong>example.lua</strong><br/>

cf7d90693f7579700c4f7e663adb83196f903df1covener-- example handler

cf7d90693f7579700c4f7e663adb83196f903df1covener

cf7d90693f7579700c4f7e663adb83196f903df1covenerrequire "string"

92e5d4326ae44f79da5cb049470daba604506846poirier

92e5d4326ae44f79da5cb049470daba604506846poirier--[[

92e5d4326ae44f79da5cb049470daba604506846poirier This is the default method name for Lua handlers, see the optional

92e5d4326ae44f79da5cb049470daba604506846poirier function-name in the LuaMapHandler directive to choose a different

92e5d4326ae44f79da5cb049470daba604506846poirier entry point.

a51fa5c4960c597687688fd4a87856d5db51435fhumbedooh--]]

92e5d4326ae44f79da5cb049470daba604506846poirierfunction handle(r)

92e5d4326ae44f79da5cb049470daba604506846poirier r.content_type = "text/plain"

92e5d4326ae44f79da5cb049470daba604506846poirier r:puts("Hello Lua World!\n")

a51fa5c4960c597687688fd4a87856d5db51435fhumbedooh

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) )

860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim end

92e5d4326ae44f79da5cb049470daba604506846poirier elseif r.method == 'POST' then

880f77d700bc15c83bb541a053cd56e89cbfb8bchumbedooh for k, v in pairs( r:parsebody() ) do

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:puts( string.format("%s: %s\n", k, v) )

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen end

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen else

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:puts("Unsupported HTTP method " .. r.method)

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen end

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenend

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen</highlight>

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<p>

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenThis handler function just prints out the uri or form encoded

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenarguments to a plaintext page.

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen</p>

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen

92e5d4326ae44f79da5cb049470daba604506846poirier<p>

92e5d4326ae44f79da5cb049470daba604506846poirierThis means (and in fact encourages) that you can have multiple

889dc1728817c1c56d0c8d894c768614e346d86ecovenerhandlers (or hooks, or filters) in the same script.

860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim</p>

860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim

889dc1728817c1c56d0c8d894c768614e346d86ecovener</section>

889dc1728817c1c56d0c8d894c768614e346d86ecovener

889dc1728817c1c56d0c8d894c768614e346d86ecovener<section id="writingauthzproviders">

92e5d4326ae44f79da5cb049470daba604506846poirier<title>Writing Authorization Providers</title>

92e5d4326ae44f79da5cb049470daba604506846poirier

92e5d4326ae44f79da5cb049470daba604506846poirier<p><module>mod_authz_core</module> provides a high-level interface to

92e5d4326ae44f79da5cb049470daba604506846poirierauthorization 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

880f77d700bc15c83bb541a053cd56e89cbfb8bchumbedoohthe name of the responsible authorization provider. For any

880f77d700bc15c83bb541a053cd56e89cbfb8bchumbedooh<directive module="mod_authz_core">Require</directive> line,

bb57315f942d09c744543fe41e453bd0181fd93ecovener<module>mod_authz_core</module> will call the authorization provider

bb57315f942d09c744543fe41e453bd0181fd93ecovenerof the given name, passing the rest of the line as parameters. The

bb57315f942d09c744543fe41e453bd0181fd93ecovenerprovider will then check authorization and pass the result as return

bb57315f942d09c744543fe41e453bd0181fd93ecovenervalue.</p>

bb57315f942d09c744543fe41e453bd0181fd93ecovener

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

bb57315f942d09c744543fe41e453bd0181fd93ecovener<p>The following authz provider function takes two arguments, one ip

880f77d700bc15c83bb541a053cd56e89cbfb8bchumbedoohaddress and one user name. It will allow access from the given ip address

bb57315f942d09c744543fe41e453bd0181fd93ecovenerwithout authentication, or if the authenticated user matches the second

880f77d700bc15c83bb541a053cd56e89cbfb8bchumbedoohargument:</p>

880f77d700bc15c83bb541a053cd56e89cbfb8bchumbedooh

bb57315f942d09c744543fe41e453bd0181fd93ecovener<highlight language="lua">

bb57315f942d09c744543fe41e453bd0181fd93ecovener<strong>authz_provider.lua</strong><br/>

bb57315f942d09c744543fe41e453bd0181fd93ecovener

860b4efe27e7c1c9a2bf5c872b29c90f76849b51jimrequire 'apache2'

bb57315f942d09c744543fe41e453bd0181fd93ecovener

bb57315f942d09c744543fe41e453bd0181fd93ecovenerfunction authz_check_foo(r, ip, user)

8e9a311b466b8a3d2782af71a432a6a7ee2cd2f0covener if r.useragent_ip == ip then

bb57315f942d09c744543fe41e453bd0181fd93ecovener return apache2.AUTHZ_GRANTED

92e5d4326ae44f79da5cb049470daba604506846poirier elseif r.user == nil then

92e5d4326ae44f79da5cb049470daba604506846poirier return apache2.AUTHZ_DENIED_NO_USER

92e5d4326ae44f79da5cb049470daba604506846poirier elseif r.user == user then

92e5d4326ae44f79da5cb049470daba604506846poirier return apache2.AUTHZ_GRANTED

92e5d4326ae44f79da5cb049470daba604506846poirier else

92e5d4326ae44f79da5cb049470daba604506846poirier return apache2.AUTHZ_DENIED

92e5d4326ae44f79da5cb049470daba604506846poirier end

92e5d4326ae44f79da5cb049470daba604506846poirierend

92e5d4326ae44f79da5cb049470daba604506846poirier</highlight>

92e5d4326ae44f79da5cb049470daba604506846poirier

880f77d700bc15c83bb541a053cd56e89cbfb8bchumbedooh<p>The following configuration registers this function as provider

92e5d4326ae44f79da5cb049470daba604506846poirier<code>foo</code> and configures it for URL <code>/</code>:</p>

92e5d4326ae44f79da5cb049470daba604506846poirier<highlight language="config">

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenLuaAuthzProvider foo authz_provider.lua authz_check_foo

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen&lt;Location /&gt;

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen Require foo 10.1.2.3 john_doe

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen&lt;/Location&gt;

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen</highlight>

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen</section>

860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<section id="writinghooks"><title>Writing Hooks</title>

92e5d4326ae44f79da5cb049470daba604506846poirier

92e5d4326ae44f79da5cb049470daba604506846poirier<p>Hook functions are how modules (and Lua scripts) participate in the

249cc9b3d83d3c60666269b90ecb9f1390d32165poirierprocessing of requests. Each type of hook exposed by the server exists for

249cc9b3d83d3c60666269b90ecb9f1390d32165poiriera specific purpose, such as mapping requests to the filesystem,

249cc9b3d83d3c60666269b90ecb9f1390d32165poirierperforming access control, or setting mimetypes:</p>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier<table border="1" style="zebra">

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <th>Hook phase</th>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <th>mod_lua directive</th>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <th>Description</th>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>Quick handler</td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td><directive module="mod_lua">LuaQuickHandler</directive></td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>This is the first hook that will be called after a request has

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier been mapped to a host or virtual host</td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>

fc57cc74ee4e73618f74a7a62ea6ac77546666dacovener <tr>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>Translate name</td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td><directive module="mod_lua">LuaHookTranslateName</directive></td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>This phase translates the requested URI into a filename on the

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier system. Modules such as <module>mod_alias</module> and

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <module>mod_rewrite</module> operate in this phase.</td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>Map to storage</td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td><directive module="mod_lua">LuaHookMapToStorage</directive></td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>This phase maps files to their physical, cached or external/proxied storage.

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier It can be used by proxy or caching modules</td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>Check Access</td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td><directive module="mod_lua">LuaHookAccessChecker</directive></td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>This phase checks whether a client has access to a resource. This

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier phase is run before the user is authenticated, so beware.

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>Check User ID</td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td><directive module="mod_lua">LuaHookCheckUserID</directive></td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>This phase it used to check the negotiated user ID</td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>Check Authorization</td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td><directive module="mod_lua">LuaHookAuthChecker</directive> or

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <directive module="mod_lua">LuaAuthzProvider</directive></td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>This phase authorizes a user based on the negotiated credentials, such as

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier user ID, client certificate etc.

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>Check Type</td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td><directive module="mod_lua">LuaHookTypeChecker</directive></td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>This phase checks the requested file and assigns a content type and

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier a handler to it</td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>

7152f5d04e3782c5e93016ae2ccd960f8538b83bcovener <tr>

7152f5d04e3782c5e93016ae2ccd960f8538b83bcovener <td>Fixups</td>

7152f5d04e3782c5e93016ae2ccd960f8538b83bcovener <td><directive module="mod_lua">LuaHookFixups</directive></td>

7152f5d04e3782c5e93016ae2ccd960f8538b83bcovener <td>This is the final "fix anything" phase before the content handlers

7152f5d04e3782c5e93016ae2ccd960f8538b83bcovener are run. Any last-minute changes to the request should be made here.</td>

7152f5d04e3782c5e93016ae2ccd960f8538b83bcovener </tr>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>Content handler</td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>fx. <code>.lua</code> files or through <directive module="mod_lua">LuaMapHandler</directive></td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>This is where the content is handled. Files are read, parsed, some are run,

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier and the result is sent to the client</td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>Logging</td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>(none)</td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>Once a request has been handled, it enters several logging phases,

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier which logs the request in either the error or access log</td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier</table>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier<p>Hook functions are passed the request object as their only argument

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier(except for LuaAuthzProvider, which also gets passed the arguments from

249cc9b3d83d3c60666269b90ecb9f1390d32165poirierthe Require directive).

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

92e5d4326ae44f79da5cb049470daba604506846poirier

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier<highlight language="lua">

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier<strong>translate_name.lua</strong><br/>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier-- example hook that rewrites the URI to a filesystem path.

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier

249cc9b3d83d3c60666269b90ecb9f1390d32165poirierrequire 'apache2'

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier

249cc9b3d83d3c60666269b90ecb9f1390d32165poirierfunction translate_name(r)

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier if r.uri == "/translate-name" then

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier r.filename = r.document_root .. "/find_me.txt"

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier return apache2.OK

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier end

7152f5d04e3782c5e93016ae2ccd960f8538b83bcovener -- we don't care about this URL, give another module a chance

7152f5d04e3782c5e93016ae2ccd960f8538b83bcovener return apache2.DECLINED

7152f5d04e3782c5e93016ae2ccd960f8538b83bcovenerend

7152f5d04e3782c5e93016ae2ccd960f8538b83bcovener</highlight>

7152f5d04e3782c5e93016ae2ccd960f8538b83bcovener

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier<highlight language="lua">

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier<strong>translate_name2.lua</strong><br/>

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

8230057b2a5c382433ec1d7a9d1e3f1bb1daa87acovener substitution, including the core translate_name hook which maps based

8230057b2a5c382433ec1d7a9d1e3f1bb1daa87acovener on the DocumentRoot.

8230057b2a5c382433ec1d7a9d1e3f1bb1daa87acovener

8230057b2a5c382433ec1d7a9d1e3f1bb1daa87acovener Note: Use the early/late flags in the directive to make it run before

8230057b2a5c382433ec1d7a9d1e3f1bb1daa87acovener or after mod_alias.

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier--]]

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier

249cc9b3d83d3c60666269b90ecb9f1390d32165poirierrequire 'apache2'

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier

249cc9b3d83d3c60666269b90ecb9f1390d32165poirierfunction translate_name(r)

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier if r.uri == "/translate-name" then

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier r.uri = "/find_me.txt"

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier return apache2.DECLINED

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier end

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier return apache2.DECLINED

249cc9b3d83d3c60666269b90ecb9f1390d32165poirierend

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier</highlight>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier</section>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier<section id="datastructures"><title>Data Structures</title>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier<dl>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier<dt>request_rec</dt>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <dd>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <p>The request_rec is mapped in as a userdata. It has a metatable

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier which lets you do useful things with it. For the most part it

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier has the same fields as the request_rec struct, many of which are writeable as

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier well as readable. (The table fields' content can be changed, but the

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier fields themselves cannot be set to different tables.)</p>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <table border="1" style="zebra">

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <th><strong>Name</strong></th>

2537429a9c5d4388773bb77437e04e5f779bb176humbedooh <th><strong>Lua type</strong></th>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <th><strong>Writable</strong></th>

2537429a9c5d4388773bb77437e04e5f779bb176humbedooh <th><strong>Description</strong></th>

860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim </tr>

2537429a9c5d4388773bb77437e04e5f779bb176humbedooh <tr>

2537429a9c5d4388773bb77437e04e5f779bb176humbedooh <td><code>allowoverrides</code></td>

2537429a9c5d4388773bb77437e04e5f779bb176humbedooh <td>string</td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>no</td>

2537429a9c5d4388773bb77437e04e5f779bb176humbedooh <td>The AllowOverride options applied to the current request.</td>

2537429a9c5d4388773bb77437e04e5f779bb176humbedooh </tr>

2537429a9c5d4388773bb77437e04e5f779bb176humbedooh <tr>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td><code>ap_auth_type</code></td>

2537429a9c5d4388773bb77437e04e5f779bb176humbedooh <td>string</td>

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen <td>no</td>

2537429a9c5d4388773bb77437e04e5f779bb176humbedooh <td>If an authentication check was made, this is set to the type

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier of authentication (f.x. <code>basic</code>)</td>

2537429a9c5d4388773bb77437e04e5f779bb176humbedooh </tr>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>

2537429a9c5d4388773bb77437e04e5f779bb176humbedooh <td><code>args</code></td>

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen <td>string</td>

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen <td>yes</td>

860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim <td>The query string arguments extracted from the request

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen (f.x. <code>foo=bar&amp;name=johnsmith</code>)</td>

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen </tr>

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen <tr>

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen <td><code>assbackwards</code></td>

880f77d700bc15c83bb541a053cd56e89cbfb8bchumbedooh <td>boolean</td>

92e5d4326ae44f79da5cb049470daba604506846poirier <td>no</td>

b60ba9fb00026d3dbca744c6c19afe63cba3a3d1covener <td>Set to true if this is an HTTP/0.9 style request

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen (e.g. <code>GET /foo</code> (with no headers) )</td>

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen </tr>

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen <tr>

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen <td><code>auth_name</code></td>

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen <td>string</td>

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen <td>no</td>

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen <td>The realm name used for authorization (if applicable).</td>

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen </tr>

880f77d700bc15c83bb541a053cd56e89cbfb8bchumbedooh <tr>

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen <td><code>banner</code></td>

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen <td>string</td>

e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen <td>no</td>

92e5d4326ae44f79da5cb049470daba604506846poirier <td>The server banner, f.x. <code>Apache HTTP Server/2.4.3 openssl/0.9.8c</code></td>

92e5d4326ae44f79da5cb049470daba604506846poirier </tr>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td><code>basic_auth_pw</code></td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>string</td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>no</td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>The basic auth password sent with this request, if any</td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td><code>canonical_filename</code></td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>string</td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>no</td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>The canonical filename of the request</td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>

7152f5d04e3782c5e93016ae2ccd960f8538b83bcovener <td><code>content_encoding</code></td>

7152f5d04e3782c5e93016ae2ccd960f8538b83bcovener <td>string</td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>no</td>

92e5d4326ae44f79da5cb049470daba604506846poirier <td>The content encoding of the current request</td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier </tr>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <tr>

fb51a6b789d85113d0976148685b0063c294220drbowen <td><code>content_type</code></td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>string</td>

6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen <td>yes</td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>The content type of the current request, as determined in the

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic type_check phase (f.x. <code>image/gif</code> or <code>text/html</code>)</td>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic </tr>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <tr>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <td><code>context_prefix</code></td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>string</td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>no</td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td></td>

2219c51bf0756c2f6f7deb88a13baf30f141c12epoirier </tr>

fb51a6b789d85113d0976148685b0063c294220drbowen <tr>

fb51a6b789d85113d0976148685b0063c294220drbowen <td><code>context_document_root</code></td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>string</td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>no</td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td></td>

fb51a6b789d85113d0976148685b0063c294220drbowen </tr>

fb51a6b789d85113d0976148685b0063c294220drbowen

6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen <tr>

fb51a6b789d85113d0976148685b0063c294220drbowen <td><code>document_root</code></td>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td>string</td>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <td>no</td>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <td>The document root of the host</td>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic </tr>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <tr>

fb51a6b789d85113d0976148685b0063c294220drbowen <td><code>err_headers_out</code></td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>table</td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>no</td>

c994f52ac80f9664d2940e5ccd9e77466572013frbowen <td>MIME header environment for the response, printed even on errors and

860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim persist across internal redirects</td>

c994f52ac80f9664d2940e5ccd9e77466572013frbowen </tr>

c994f52ac80f9664d2940e5ccd9e77466572013frbowen <tr>

860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim <td><code>filename</code></td>

860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim <td>string</td>

860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim <td>yes</td>

c994f52ac80f9664d2940e5ccd9e77466572013frbowen <td>The file name that the request maps to, f.x. /www/example.com/foo.txt. This can be

860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim changed in the translate-name or map-to-storage phases of a request to allow the

c994f52ac80f9664d2940e5ccd9e77466572013frbowen default handler (or script handlers) to serve a different file than what was requested.</td>

860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim </tr>

c994f52ac80f9664d2940e5ccd9e77466572013frbowen <tr>

fb51a6b789d85113d0976148685b0063c294220drbowen <td><code>handler</code></td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>string</td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>yes</td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>The name of the <a href="/handler.html">handler</a> that should serve this request, f.x.

c994f52ac80f9664d2940e5ccd9e77466572013frbowen <code>lua-script</code> if it is to be served by mod_lua. This is typically set by the

c994f52ac80f9664d2940e5ccd9e77466572013frbowen <directive module="mod_mime">AddHandler</directive> or <directive module="core">SetHandler</directive>

c994f52ac80f9664d2940e5ccd9e77466572013frbowen directives, but could also be set via mod_lua to allow another handler to serve up a specific request

fb51a6b789d85113d0976148685b0063c294220drbowen that would otherwise not be served by it.

fb51a6b789d85113d0976148685b0063c294220drbowen </td>

fb51a6b789d85113d0976148685b0063c294220drbowen </tr>

fb51a6b789d85113d0976148685b0063c294220drbowen

6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen <tr>

fb51a6b789d85113d0976148685b0063c294220drbowen <td><code>headers_in</code></td>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <td>table</td>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <td>yes</td>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <td>MIME header environment from the request. This contains headers such as <code>Host,

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic User-Agent, Referer</code> and so on.</td>

fb51a6b789d85113d0976148685b0063c294220drbowen </tr>

fb51a6b789d85113d0976148685b0063c294220drbowen <tr>

fb51a6b789d85113d0976148685b0063c294220drbowen <td><code>headers_out</code></td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>table</td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>yes</td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>MIME header environment for the response.</td>

fb51a6b789d85113d0976148685b0063c294220drbowen </tr>

c994f52ac80f9664d2940e5ccd9e77466572013frbowen <tr>

6265962c731aed3af3aa7242b35852f3f181d437humbedooh <td><code>hostname</code></td>

fb926c8c319705c9fe42d55a6ad13d9b0972cb72humbedooh <td>string</td>

6265962c731aed3af3aa7242b35852f3f181d437humbedooh <td>no</td>

c994f52ac80f9664d2940e5ccd9e77466572013frbowen <td>The host name, as set by the <code>Host:</code> header or by a full URI.</td>

fb51a6b789d85113d0976148685b0063c294220drbowen </tr>

fb51a6b789d85113d0976148685b0063c294220drbowen <tr>

fb51a6b789d85113d0976148685b0063c294220drbowen <td><code>is_https</code></td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>boolean</td>

860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim <td>no</td>

6265962c731aed3af3aa7242b35852f3f181d437humbedooh <td>Whether or not this request is done via HTTPS</td>

fb51a6b789d85113d0976148685b0063c294220drbowen </tr>

6265962c731aed3af3aa7242b35852f3f181d437humbedooh <tr>

fb51a6b789d85113d0976148685b0063c294220drbowen <td><code>is_initial_req</code></td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>boolean</td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>no</td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>Whether this request is the initial request or a sub-request</td>

fb51a6b789d85113d0976148685b0063c294220drbowen </tr>

fb51a6b789d85113d0976148685b0063c294220drbowen <tr>

fb51a6b789d85113d0976148685b0063c294220drbowen <td><code>limit_req_body</code></td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>number</td>

6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen <td>no</td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>The size limit of the request body for this request, or 0 if no limit.</td>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic </tr>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <tr>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <td><code>log_id</code></td>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <td>string</td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>no</td>

860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim <td>The ID to identify request in access and error log.</td>

c994f52ac80f9664d2940e5ccd9e77466572013frbowen </tr>

860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim <tr>

c994f52ac80f9664d2940e5ccd9e77466572013frbowen <td><code>method</code></td>

6265962c731aed3af3aa7242b35852f3f181d437humbedooh <td>string</td>

6265962c731aed3af3aa7242b35852f3f181d437humbedooh <td>no</td>

6265962c731aed3af3aa7242b35852f3f181d437humbedooh <td>The request method, f.x. <code>GET</code> or <code>POST</code>.</td>

6265962c731aed3af3aa7242b35852f3f181d437humbedooh </tr>

c994f52ac80f9664d2940e5ccd9e77466572013frbowen <tr>

c994f52ac80f9664d2940e5ccd9e77466572013frbowen <td><code>notes</code></td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>table</td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>yes</td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>A list of notes that can be passed on from one module to another.</td>

fb51a6b789d85113d0976148685b0063c294220drbowen </tr>

6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen <tr>

fb51a6b789d85113d0976148685b0063c294220drbowen <td><code>options</code></td>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <td>string</td>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <td>no</td>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <td>The Options directive applied to the current request.</td>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic </tr>

fb51a6b789d85113d0976148685b0063c294220drbowen <tr>

fb51a6b789d85113d0976148685b0063c294220drbowen <td><code>path_info</code></td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>string</td>

860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim <td>no</td>

c994f52ac80f9664d2940e5ccd9e77466572013frbowen <td>The PATH_INFO extracted from this request.</td>

860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim </tr>

c994f52ac80f9664d2940e5ccd9e77466572013frbowen <tr>

fb51a6b789d85113d0976148685b0063c294220drbowen <td><code>port</code></td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>number</td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>no</td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>The server port used by the request.</td>

6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen </tr>

fb51a6b789d85113d0976148685b0063c294220drbowen <tr>

249cc9b3d83d3c60666269b90ecb9f1390d32165poirier <td><code>protocol</code></td>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <td>string</td>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <td>no</td>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <td>The protocol used, f.x. <code>HTTP/1.1</code></td>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic </tr>

fb51a6b789d85113d0976148685b0063c294220drbowen <tr>

fb51a6b789d85113d0976148685b0063c294220drbowen <td><code>proxyreq</code></td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>string</td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>yes</td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>Denotes whether this is a proxy request or not. This value is generally set in

fb51a6b789d85113d0976148685b0063c294220drbowen the post_read_request/translate_name phase of a request.</td>

fb51a6b789d85113d0976148685b0063c294220drbowen </tr>

860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim <tr>

c994f52ac80f9664d2940e5ccd9e77466572013frbowen <td><code>range</code></td>

860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim <td>string</td>

92e5d4326ae44f79da5cb049470daba604506846poirier <td>no</td>

3a602d0ba8536a79a780655bb92133b571e38378poirier <td>The contents of the <code>Range:</code> header.</td>

860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim </tr>

c994f52ac80f9664d2940e5ccd9e77466572013frbowen <tr>

6265962c731aed3af3aa7242b35852f3f181d437humbedooh <td><code>remaining</code></td>

6265962c731aed3af3aa7242b35852f3f181d437humbedooh <td>number</td>

6265962c731aed3af3aa7242b35852f3f181d437humbedooh <td>no</td>

6265962c731aed3af3aa7242b35852f3f181d437humbedooh <td>The number of bytes remaining to be read from the request body.</td>

6265962c731aed3af3aa7242b35852f3f181d437humbedooh </tr>

c994f52ac80f9664d2940e5ccd9e77466572013frbowen <tr>

c994f52ac80f9664d2940e5ccd9e77466572013frbowen <td><code>server_built</code></td>

c994f52ac80f9664d2940e5ccd9e77466572013frbowen <td>string</td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>no</td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>The time the server executable was built.</td>

fb51a6b789d85113d0976148685b0063c294220drbowen </tr>

fb51a6b789d85113d0976148685b0063c294220drbowen <tr>

6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen <td><code>server_name</code></td>

457256c49209d6e56bfe63b411688ad9cb2a8429covener <td>string</td>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <td>no</td>

457256c49209d6e56bfe63b411688ad9cb2a8429covener <td>The server name for this request.</td>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic </tr>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <tr>

247c1db2eb82d5c836df7bafc7380887890e11a2rjung <td><code>some_auth_required</code></td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>boolean</td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>no</td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>Whether some authorization is/was required for this request.</td>

fb51a6b789d85113d0976148685b0063c294220drbowen </tr>

860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim <tr>

fb51a6b789d85113d0976148685b0063c294220drbowen <td><code>subprocess_env</code></td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>table</td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>yes</td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>The environment variables set for this request.</td>

fb51a6b789d85113d0976148685b0063c294220drbowen </tr>

fb51a6b789d85113d0976148685b0063c294220drbowen <tr>

fb51a6b789d85113d0976148685b0063c294220drbowen <td><code>started</code></td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>number</td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>no</td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>The time the server was (re)started, in seconds since the epoch (Jan 1st, 1970)</td>

fb51a6b789d85113d0976148685b0063c294220drbowen </tr>

fb51a6b789d85113d0976148685b0063c294220drbowen <tr>

6265962c731aed3af3aa7242b35852f3f181d437humbedooh <td><code>status</code></td>

92e5d4326ae44f79da5cb049470daba604506846poirier <td>number</td>

92e5d4326ae44f79da5cb049470daba604506846poirier <td>yes</td>

6265962c731aed3af3aa7242b35852f3f181d437humbedooh <td>The (current) HTTP return code for this request, f.x. <code>200</code> or <code>404</code>.</td>

92e5d4326ae44f79da5cb049470daba604506846poirier </tr>

880f77d700bc15c83bb541a053cd56e89cbfb8bchumbedooh <tr>

92e5d4326ae44f79da5cb049470daba604506846poirier <td><code>the_request</code></td>

92e5d4326ae44f79da5cb049470daba604506846poirier <td>string</td>

92e5d4326ae44f79da5cb049470daba604506846poirier <td>no</td>

92e5d4326ae44f79da5cb049470daba604506846poirier <td>The request string as sent by the client, f.x. <code>GET /foo/bar HTTP/1.1</code>.</td>

76c23dcc502f814f6b988038d600719db07d28becovener </tr>

92e5d4326ae44f79da5cb049470daba604506846poirier <tr>

92e5d4326ae44f79da5cb049470daba604506846poirier <td><code>unparsed_uri</code></td>

92e5d4326ae44f79da5cb049470daba604506846poirier <td>string</td>

92e5d4326ae44f79da5cb049470daba604506846poirier <td>no</td>

92e5d4326ae44f79da5cb049470daba604506846poirier <td>The unparsed URI of the request</td>

880f77d700bc15c83bb541a053cd56e89cbfb8bchumbedooh </tr>

457256c49209d6e56bfe63b411688ad9cb2a8429covener <tr>

457256c49209d6e56bfe63b411688ad9cb2a8429covener <td><code>uri</code></td>

457256c49209d6e56bfe63b411688ad9cb2a8429covener <td>string</td>

457256c49209d6e56bfe63b411688ad9cb2a8429covener <td>yes</td>

457256c49209d6e56bfe63b411688ad9cb2a8429covener <td>The URI after it has been parsed by httpd</td>

457256c49209d6e56bfe63b411688ad9cb2a8429covener </tr>

457256c49209d6e56bfe63b411688ad9cb2a8429covener <tr>

457256c49209d6e56bfe63b411688ad9cb2a8429covener <td><code>user</code></td>

457256c49209d6e56bfe63b411688ad9cb2a8429covener <td>string</td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>yes</td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>If an authentication check has been made, this is set to the name of the authenticated user.</td>

fb51a6b789d85113d0976148685b0063c294220drbowen </tr>

fb51a6b789d85113d0976148685b0063c294220drbowen <tr>

6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen <td><code>useragent_ip</code></td>

6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen <td>string</td>

6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen <td>no</td>

fb51a6b789d85113d0976148685b0063c294220drbowen <td>The IP of the user agent making the request</td>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic </tr>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic </table>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <p>The request_rec has (at least) the following methods:</p>

3e30fa5f420fe7302a4cdcd79cb001958fd54a13rbowen

3e30fa5f420fe7302a4cdcd79cb001958fd54a13rbowen <highlight language="lua">

fb51a6b789d85113d0976148685b0063c294220drbowen r:flush() -- flushes the output buffer

3e30fa5f420fe7302a4cdcd79cb001958fd54a13rbowen </highlight>

3e30fa5f420fe7302a4cdcd79cb001958fd54a13rbowen

fb51a6b789d85113d0976148685b0063c294220drbowen <highlight language="lua">

fb51a6b789d85113d0976148685b0063c294220drbowen r:addoutputfilter(name|function) -- add an output filter

fb51a6b789d85113d0976148685b0063c294220drbowen </highlight>

fb51a6b789d85113d0976148685b0063c294220drbowen

6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen <highlight language="lua">

fb51a6b789d85113d0976148685b0063c294220drbowen r:sendfile(filename) -- sends an entire file to the client, using sendfile if supported by the current platform

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic </highlight>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <highlight language="lua">

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic r:parseargs() -- returns a Lua table containing the request's query string arguments

fb51a6b789d85113d0976148685b0063c294220drbowen </highlight>

fb51a6b789d85113d0976148685b0063c294220drbowen

fb51a6b789d85113d0976148685b0063c294220drbowen <highlight language="lua">

fb51a6b789d85113d0976148685b0063c294220drbowen r:parsebody([sizeLimit]) -- parse the request body as a POST and return a lua table.

fb51a6b789d85113d0976148685b0063c294220drbowen -- An optional number may be passed to specify the maximum number

6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen -- of bytes to parse. Default is 8192 bytes.

457256c49209d6e56bfe63b411688ad9cb2a8429covener </highlight>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <highlight language="lua">

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic r:puts("hello", " world", "!") -- print to response body

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic </highlight>

247c1db2eb82d5c836df7bafc7380887890e11a2rjung

457256c49209d6e56bfe63b411688ad9cb2a8429covener <highlight language="lua">

457256c49209d6e56bfe63b411688ad9cb2a8429covener r:write("a single string") -- print to response body

457256c49209d6e56bfe63b411688ad9cb2a8429covener </highlight>

457256c49209d6e56bfe63b411688ad9cb2a8429covener

fb51a6b789d85113d0976148685b0063c294220drbowen <highlight language="lua">

fb51a6b789d85113d0976148685b0063c294220drbowen r:escape_html("&lt;html&gt;test&lt;/html&gt;") -- Escapes HTML code and returns the escaped result

fb51a6b789d85113d0976148685b0063c294220drbowen </highlight>

fb51a6b789d85113d0976148685b0063c294220drbowen

6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen <highlight language="lua">

fb51a6b789d85113d0976148685b0063c294220drbowen r:base64_encode(string) -- Encodes a string using the Base64 encoding standard

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic </highlight>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <highlight language="lua">

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic r:base64_decode(string) -- Decodes a Base64-encoded string

fb51a6b789d85113d0976148685b0063c294220drbowen </highlight>

fb51a6b789d85113d0976148685b0063c294220drbowen

fb51a6b789d85113d0976148685b0063c294220drbowen <highlight language="lua">

fb51a6b789d85113d0976148685b0063c294220drbowen r:md5(string) -- Calculates and returns the MD5 digest of a string (binary safe)

fb51a6b789d85113d0976148685b0063c294220drbowen </highlight>

9cd56c73a0fd508522ba2f6bc6c9839c478c61c3rbowen

457256c49209d6e56bfe63b411688ad9cb2a8429covener <highlight language="lua">

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic r:sha1(string) -- Calculates and returns the SHA1 digest of a string (binary safe)

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic </highlight>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <highlight language="lua">

247c1db2eb82d5c836df7bafc7380887890e11a2rjung r:escape(string) -- URL-Escapes a string

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier </highlight>

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier <highlight language="lua">

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier r:unescape(string) -- Unescapes an URL-escaped string

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier </highlight>

880f77d700bc15c83bb541a053cd56e89cbfb8bchumbedooh

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier <highlight language="lua">

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier r:banner() -- Returns the current server banner

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier </highlight>

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier <highlight language="lua">

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier r:port() -- Returns the current server port used for the request

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier </highlight>

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier <highlight language="lua">

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier r:mpm_query(number) -- Queries the server for MPM information using ap_mpm_query

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier </highlight>

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier <highlight language="lua">

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier r:expr(string) -- Evaluates an <a href="/expr.html">expr</a> string.

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier </highlight>

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier <highlight language="lua">

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier r:scoreboard_process(a) -- Queries the server for information about the process at position <code>a</code>

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier </highlight>

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier <highlight language="lua">

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier r:scoreboard_worker(a, b) -- Queries for information about the worker thread, <code>b</code>, in process <code>a</code>

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier </highlight>

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier <highlight language="lua">

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier r:started() -- Returns the time of the last server (re)start

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier </highlight>

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier <highlight language="lua">

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier r:clock() -- Returns the current time with microsecond precision

880f77d700bc15c83bb541a053cd56e89cbfb8bchumbedooh </highlight>

457256c49209d6e56bfe63b411688ad9cb2a8429covener

457256c49209d6e56bfe63b411688ad9cb2a8429covener <highlight language="lua">

768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirierr:requestbody(filename) -- Reads and returns the request body of a request.

fb51a6b789d85113d0976148685b0063c294220drbowen -- If 'filename' is specified, it instead saves the

fb51a6b789d85113d0976148685b0063c294220drbowen -- contents to that file.

fb51a6b789d85113d0976148685b0063c294220drbowen </highlight>

fb51a6b789d85113d0976148685b0063c294220drbowen

9cd56c73a0fd508522ba2f6bc6c9839c478c61c3rbowen <highlight language="lua">

457256c49209d6e56bfe63b411688ad9cb2a8429covener r:add_input_filter(filter_name) -- Adds 'filter_name' as an input filter

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic </highlight>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <highlight language="lua">

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic r:module_info(module_name) -- Queries the server for information about a module

247c1db2eb82d5c836df7bafc7380887890e11a2rjung </highlight>

92e5d4326ae44f79da5cb049470daba604506846poirier

92e5d4326ae44f79da5cb049470daba604506846poirier <highlight language="lua">

92e5d4326ae44f79da5cb049470daba604506846poirier r:loaded_modules() -- Returns a list of modules loaded by httpd

457256c49209d6e56bfe63b411688ad9cb2a8429covener </highlight>

457256c49209d6e56bfe63b411688ad9cb2a8429covener

92e5d4326ae44f79da5cb049470daba604506846poirier <highlight language="lua">

fb51a6b789d85113d0976148685b0063c294220drbowenr:runtime_dir_relative(filename) -- Compute the name of a run-time file (e.g., shared memory "file")

fb51a6b789d85113d0976148685b0063c294220drbowen -- relative to the appropriate run-time directory.

fb51a6b789d85113d0976148685b0063c294220drbowen </highlight>

fb51a6b789d85113d0976148685b0063c294220drbowen

9cd56c73a0fd508522ba2f6bc6c9839c478c61c3rbowen <highlight language="lua">

fb51a6b789d85113d0976148685b0063c294220drbowen r:server_info() -- Returns a table containing server information, such as

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic -- the name of the httpd executable file, mpm used etc.

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic </highlight>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <highlight language="lua">

fb51a6b789d85113d0976148685b0063c294220drbowen r:set_document_root(file_path) -- Sets the document root for the request to file_path

fb51a6b789d85113d0976148685b0063c294220drbowen </highlight>

fb51a6b789d85113d0976148685b0063c294220drbowen

ae600ca541efc686b34f8b1f21bd3d0741d37674covener <highlight language="lua">

ae600ca541efc686b34f8b1f21bd3d0741d37674covener r:add_version_component(component_string) -- Adds a component to the server banner.

ae600ca541efc686b34f8b1f21bd3d0741d37674covener </highlight>

ae600ca541efc686b34f8b1f21bd3d0741d37674covener

ae600ca541efc686b34f8b1f21bd3d0741d37674covener <highlight language="lua">

ae600ca541efc686b34f8b1f21bd3d0741d37674covener r:set_context_info(prefix, docroot) -- Sets the context prefix and context document root for a request

ae600ca541efc686b34f8b1f21bd3d0741d37674covener </highlight>

ae600ca541efc686b34f8b1f21bd3d0741d37674covener

ae600ca541efc686b34f8b1f21bd3d0741d37674covener <highlight language="lua">

448a4db8228c5b9f6c1d3693e7a6b07b8b2b0c5erjung r:os_escape_path(file_path) -- Converts an OS path to a URL in an OS dependant way

ae600ca541efc686b34f8b1f21bd3d0741d37674covener </highlight>

ae600ca541efc686b34f8b1f21bd3d0741d37674covener

ae600ca541efc686b34f8b1f21bd3d0741d37674covener <highlight language="lua">

ae600ca541efc686b34f8b1f21bd3d0741d37674covener r:escape_logitem(string) -- Escapes a string for logging

ae600ca541efc686b34f8b1f21bd3d0741d37674covener </highlight>

ae600ca541efc686b34f8b1f21bd3d0741d37674covener

ae600ca541efc686b34f8b1f21bd3d0741d37674covener <highlight language="lua">

ae600ca541efc686b34f8b1f21bd3d0741d37674covenerr:strcmp_match(string, pattern) -- Checks if 'string' matches 'pattern' using strcmp_match (GLOBs).

ae600ca541efc686b34f8b1f21bd3d0741d37674covener -- fx. whether 'www.example.com' matches '*.example.com'

ae600ca541efc686b34f8b1f21bd3d0741d37674covener </highlight>

6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen

6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen <highlight language="lua">

6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen r:set_keepalive() -- Sets the keepalive status for a request. Returns true if possible, false otherwise.

6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen </highlight>

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic

448a4db8228c5b9f6c1d3693e7a6b07b8b2b0c5erjung <highlight language="lua">

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic r:make_etag() -- Constructs and returns the etag for the current request.

99e316bc4b9b2b5754165939ac14b6d16132cce1igalic </highlight>

457256c49209d6e56bfe63b411688ad9cb2a8429covener

457256c49209d6e56bfe63b411688ad9cb2a8429covener <highlight language="lua">

457256c49209d6e56bfe63b411688ad9cb2a8429covenerr:send_interim_response(clear) -- Sends an interim (1xx) response to the client.

457256c49209d6e56bfe63b411688ad9cb2a8429covener -- if 'clear' is true, available headers will be sent and cleared.

457256c49209d6e56bfe63b411688ad9cb2a8429covener </highlight>

457256c49209d6e56bfe63b411688ad9cb2a8429covener

6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen <highlight language="lua">

6b4cd1f143d5d7244d2476d1e28456212faddb72rbowenr:custom_response(status_code, string) -- Construct and set a custom response for a given status code.

fb51a6b789d85113d0976148685b0063c294220drbowen -- This works much like the ErrorDocument directive.

</highlight>

<highlight language="lua">

r:exists_config_define(string) -- Checks whether a configuration definition exists or not.

</highlight>

<highlight language="lua">

r:state_query(string) -- Queries the server for state information

</highlight>

<highlight language="lua">

r:stat(filename) -- Runs stat() on a file, and returns a table with file information

</highlight>

<highlight language="lua">

r:regex(string, pattern) -- Runs a regular expression match on a string, returning captures if matched.

</highlight>

<highlight language="lua">

r:sleep(number_of_seconds) -- Puts the script to sleep for a given number of seconds.

</highlight>

<highlight language="lua">

r:dbacquire(dbType[, dbParams]) -- Acquires a connection to a database and returns a database class.

-- See '<a href="#databases">Database connectivity</a>' for details.

</highlight>

</dd>

</dl>

</section>

<section id="logging"><title>Logging Functions</title>

<highlight language="lua">

-- examples of logging messages<br />

r:trace1("This is a trace log message") -- trace1 through trace8 can be used <br />

r:debug("This is a debug log message")<br />

r:info("This is an info log message")<br />

r:notice("This is a notice log message")<br />

r:warn("This is a warn log message")<br />

r:err("This is an err log message")<br />

r:alert("This is an alert log message")<br />

r:crit("This is a crit log message")<br />

r:emerg("This is an emerg log message")<br />

</highlight>

</section>

<section id="apache2"><title>apache2 Package</title>

<p>A package named <code>apache2</code> is available with (at least) the following contents.</p>

<dl>

<dt>apache2.OK</dt>

<dd>internal constant OK. Handlers should return this if they've

handled the request.</dd>

<dt>apache2.DECLINED</dt>

<dd>internal constant DECLINED. Handlers should return this if

they are not going to handle the request.</dd>

<dt>apache2.DONE</dt>

<dd>internal constant DONE.</dd>

<dt>apache2.version</dt>

<dd>Apache HTTP server version string</dd>

<dt>apache2.HTTP_MOVED_TEMPORARILY</dt>

<dd>HTTP status code</dd>

<dt>apache2.PROXYREQ_NONE, apache2.PROXYREQ_PROXY, apache2.PROXYREQ_REVERSE, apache2.PROXYREQ_RESPONSE</dt>

<dd>internal constants used by <module>mod_proxy</module></dd>

<dt>apache2.AUTHZ_DENIED, apache2.AUTHZ_GRANTED, apache2.AUTHZ_NEUTRAL, apache2.AUTHZ_GENERAL_ERROR, apache2.AUTHZ_DENIED_NO_USER</dt>

<dd>internal constants used by <module>mod_authz_core</module></dd>

</dl>

<p>(Other HTTP status codes are not yet implemented.)</p>

</section>

<section id="modifying_buckets">

<title>Modifying contents with Lua filters</title>

<p>

Filter functions implemented via <directive module="mod_lua">LuaInputFilter</directive>

or <directive module="mod_lua">LuaOutputFilter</directive> are designed as

three-stage non-blocking functions using coroutines to suspend and resume a

function as buckets are sent down the filter chain. The core structure of

such a function is:

</p>

<highlight language="lua">

function filter(r)

-- Our first yield is to signal that we are ready to receive buckets.

-- Before this yield, we can set up our environment, check for conditions,

-- and, if we deem it necessary, decline filtering a request alltogether:

if something_bad then

return -- This would skip this filter.

end

-- Regardless of whether we have data to prepend, a yield MUST be called here.

-- Note that only output filters can prepend data. Input filters must use the

-- final stage to append data to the content.

coroutine.yield([optional header to be prepended to the content])

-- After we have yielded, buckets will be sent to us, one by one, and we can

-- do whatever we want with them and then pass on the result.

-- Buckets are stored in the global variable 'bucket', so we create a loop

-- that checks if 'bucket' is not nil:

while bucket ~= nil do

local output = mangle(bucket) -- Do some stuff to the content

coroutine.yield(output) -- Return our new content to the filter chain

end

-- Once the buckets are gone, 'bucket' is set to nil, which will exit the

-- loop and land us here. Anything extra we want to append to the content

-- can be done by doing a final yield here. Both input and output filters

-- can append data to the content in this phase.

coroutine.yield([optional footer to be appended to the content])

end

</highlight>

</section>

<section id="databases">

<title>Database connectivity</title>

<p>

Mod_lua implements a simple database feature for querying and running commands

on the most popular database engines (mySQL, PostgreSQL, FreeTDS, ODBC, SQLite, Oracle)

as well as mod_dbd.

</p>

<p>Connecting and firing off queries is as easy as:</p>

<highlight language="lua">

function handler(r)

local database, err = r:dbacquire("mysql", "server=localhost&amp;user=root&amp;database=mydb")

if not err then

local results, err = database:select(r, "SELECT `name`, `age` FROM `people` WHERE 1")

if not err then

local rows = results(0) -- fetch all rows synchronously

for k, row in pairs(rows) do

r:puts( string.format("Name: %s, Age: %s&lt;br/&gt;", row[1], row[2]) )

end

else

r:puts("Database query error: " .. err)

end

database:close()

else

r:puts("Could not connect to the database: " .. err)

end

end

</highlight>

<p>

To utilize <module name="mod_dbd">mod_dbd</module>, simply specify <code>mod_dbd</code>

as the database type, or leave the field blank:

</p>

<highlight language="lua">

local database = r:dbacquire("mod_dbd")

</highlight>

<section id="database_object">

<title>Database object and contained functions</title>

<p>The database object returned by <code>dbacquire</code> has the following methods:</p>

<p><strong>Normal select and query from a database:</strong></p>

<highlight language="lua">

-- Run a statement and return the number of rows affected:

local affected, errmsg = database:query(r, "DELETE FROM `tbl` WHERE 1")

-- Run a statement and return a result set that can be used synchronously or async:

local result, errmsg = database:select(r, "SELECT * FROM `people` WHERE 1")

</highlight>

<p><strong>Using prepared statements (recommended):</strong></p>

<highlight language="lua">

-- Create and run a prepared statement:

local statement, errmsg = database:prepare(r, "DELETE FROM `tbl` WHERE `age` > %u")

if not errmsg then

local result, errmsg = statement:query(20) -- run the statement with age >20

end

-- Fetch a prepared statement from a DBDPrepareSQL directive:

local statement, errmsg = database:prepared(r, "someTag")

if not errmsg then

local result, errmsg = statement:select("John Doe", 123) -- inject the values "John Doe" and 123 into the statement

end

</highlight>

<p><strong>Escaping values, closing databases etc:</strong></p>

<highlight language="lua">

-- Escape a value for use in a statement:

local escaped = database:escape(r, [["'|blabla]])

-- Close a database connection and free up handles:

database:close()

-- Check whether a database connection is up and running:

local connected = database:active()

</highlight>

</section>

<section id="result_sets">

<title>Working with result sets</title>

<p>The result set returned by <code>db:select</code> or by the prepared statement functions

created through <code>db:prepare</code> can be used to

fetch rows synchronously or asynchronously, depending on the row number specified:<br/>

<code>result(0)</code> fetches all rows in a synchronous manner, returning a table of rows.<br/>

<code>result(-1)</code> fetches the next available row in the set, asynchronously.<br/>

<code>result(N)</code> fetches row number <code>N</code>, asynchronously:

</p>

<highlight language="lua">

-- fetch a result set using a regular query:

local result, err = db:select(r, "SELECT * FROM `tbl` WHERE 1")

local rows = result(0) -- Fetch ALL rows synchronously

local row = result(-1) -- Fetch the next available row, asynchronously

local row = result(1234) -- Fetch row number 1234, asynchronously

</highlight>

<p>One can construct a function that returns an iterative function to iterate over all rows

in a synchronous or asynchronous way, depending on the async argument:

</p>

<highlight language="lua">

function rows(resultset, async)

local a = 0

local function getnext()

a = a + 1

local row = resultset(-1)

return row and a or nil, row

end

if not async then

return pairs(resultset(0))

else

return getnext, self

end

end

local statement, err = db:prepare(r, "SELECT * FROM `tbl` WHERE `age` > %u")

if not err then

-- fetch rows asynchronously:

local result, err = statement:select(20)

if not err then

for index, row in rows(result, true) do

....

end

end

-- fetch rows synchronously:

local result, err = statement:select(20)

if not err then

for index, row in rows(result, false) do

....

end

end

end

</highlight>

</section>

<section id="closing_databases">

<title>Closing a database connection</title>

<p>Database handles should be closed using <code>database:close()</code> when they are no longer

needed. If you do not close them manually, they will eventually be garbage collected and

closed by mod_lua, but you may end up having too many unused connections to the database

if you leave the closing up to mod_lua. Essentially, the following two measures are

the same:

</p>

<highlight language="lua">

-- Method 1: Manually close a handle

local database = r:dbacquire("mod_dbd")

database:close() -- All done

-- Method 2: Letting the garbage collector close it

local database = r:dbacquire("mod_dbd")

database = nil -- throw away the reference

collectgarbage() -- close the handle via GC

</highlight>

</section>

<section id="database_caveat">

<title>Precautions when working with databases</title>

<p>Although the standard <code>query</code> and <code>run</code> functions are freely

available, it is recommended that you use prepared statements whenever possible, to

both optimize performance (if your db handle lives on for a long time) and to minimize

the risk of SQL injection attacks. <code>run</code> and <code>query</code> should only

be used when there are no variables inserted into a statement (a static statement).

When using dynamic statements, use <code>db:prepare</code> or <code>db:prepared</code>.

</p>

</section>

</section>

<directivesynopsis>

<name>LuaRoot</name>

<description>Specify the base path for resolving relative paths for mod_lua directives</description>

<syntax>LuaRoot /path/to/a/directory</syntax>

<contextlist><context>server config</context><context>virtual host</context>

<context>directory</context><context>.htaccess</context>

</contextlist>

<override>All</override>

<usage>

<p>Specify the base path which will be used to evaluate all

relative paths within mod_lua. If not specified they

will be resolved relative to the current working directory,

which may not always work well for a server.</p>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>LuaScope</name>

<description>One of once, request, conn, thread -- default is once</description>

<syntax>LuaScope once|request|conn|thread|server [min] [max]</syntax>

<default>LuaScope once</default>

<contextlist><context>server config</context><context>virtual host</context>

<context>directory</context><context>.htaccess</context>

</contextlist>

<override>All</override>

<usage>

<p>Specify the lifecycle scope of the Lua interpreter which will

be used by handlers in this "Directory." The default is "once"</p>

<dl>

<dt>once:</dt> <dd>use the interpreter once and throw it away.</dd>

<dt>request:</dt> <dd>use the interpreter to handle anything based on

the same file within this request, which is also

request scoped.</dd>

<dt>conn:</dt> <dd>Same as request but attached to the connection_rec</dd>

<dt>thread:</dt> <dd>Use the interpreter for the lifetime of the thread

handling the request (only available with threaded MPMs).</dd>

<dt>server:</dt> <dd>This one is different than others because the

server scope is quite long lived, and multiple threads

will have the same server_rec. To accommodate this,

server scoped Lua states are stored in an apr

resource list. The <code>min</code> and <code>max</code> arguments

specify the minimum and maximum number of Lua states to keep in the

pool.</dd>

</dl>

<p>

Generally speaking, the <code>thread</code> and <code>server</code> scopes

execute roughly 2-3 times faster than the rest, because they don't have to

spawn new Lua states on every request (especially with the event MPM, as

even keepalive requests will use a new thread for each request). If you are

satisfied that your scripts will not have problems reusing a state, then

the <code>thread</code> or <code>server</code> scopes should be used for

maximum performance. While the <code>thread</code> scope will provide the

fastest responses, the <code>server</code> scope will use less memory, as

states are pooled, allowing f.x. 1000 threads to share only 100 Lua states,

thus using only 10% of the memory required by the <code>thread</code> scope.

</p>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>LuaMapHandler</name>

<description>Map a path to a lua handler</description>

<syntax>LuaMapHandler uri-pattern /path/to/lua/script.lua [function-name]</syntax>

<contextlist><context>server config</context><context>virtual host</context>

<context>directory</context><context>.htaccess</context>

</contextlist>

<override>All</override>

<usage>

<p>This directive matches a uri pattern to invoke a specific

handler function in a specific file. It uses PCRE regular

expressions to match the uri, and supports interpolating

match groups into both the file path and the function name.

Be careful writing your regular expressions to avoid security

issues.</p>

<example><title>Examples:</title>

<highlight language="config">

LuaMapHandler /(\w+)/(\w+) /scripts/$1.lua handle_$2

</highlight>

</example>

<p>This would match uri's such as /photos/show?id=9

to the file /scripts/photos.lua and invoke the

handler function handle_show on the lua vm after

loading that file.</p>

<highlight language="config">

LuaMapHandler /bingo /scripts/wombat.lua

</highlight>

<p>This would invoke the "handle" function, which

is the default if no specific function name is

provided.</p>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>LuaPackagePath</name>

<description>Add a directory to lua's package.path</description>

<syntax>LuaPackagePath /path/to/include/?.lua</syntax>

<contextlist><context>server config</context><context>virtual host</context>

<context>directory</context><context>.htaccess</context>

</contextlist>

<override>All</override>

<usage><p>Add a path to lua's module search path. Follows the same

conventions as lua. This just munges the package.path in the

lua vms.</p>

<example><title>Examples:</title>

<highlight language="config">

LuaPackagePath /scripts/lib/?.lua

LuaPackagePath /scripts/lib/?/init.lua

</highlight>

</example>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>LuaPackageCPath</name>

<description>Add a directory to lua's package.cpath</description>

<syntax>LuaPackageCPath /path/to/include/?.soa</syntax>

<contextlist><context>server config</context><context>virtual host</context>

<context>directory</context><context>.htaccess</context>

</contextlist>

<override>All</override>

<usage>

<p>Add a path to lua's shared library search path. Follows the same

conventions as lua. This just munges the package.cpath in the

lua vms.</p>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>LuaCodeCache</name>

<description>Configure the compiled code cache.</description>

<syntax>LuaCodeCache stat|forever|never</syntax>

<default>LuaCodeCache stat</default>

<contextlist>

<context>server config</context><context>virtual host</context>

<context>directory</context><context>.htaccess</context>

</contextlist>

<override>All</override>

<usage><p>

Specify the behavior of the in-memory code cache. The default

is stat, which stats the top level script (not any included

ones) each time that file is needed, and reloads it if the

modified time indicates it is newer than the one it has

already loaded. The other values cause it to keep the file

cached forever (don't stat and replace) or to never cache the

file.</p>

<p>In general stat or forever is good for production, and stat or never

for development.</p>

<example><title>Examples:</title>

<highlight language="config">

LuaCodeCache stat

LuaCodeCache forever

LuaCodeCache never

</highlight>

</example>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>LuaHookTranslateName</name>

<description>Provide a hook for the translate name phase of request processing</description>

<syntax>LuaHookTranslateName /path/to/lua/script.lua hook_function_name [early|late]</syntax>

<contextlist><context>server config</context><context>virtual host</context>

</contextlist>

<override>All</override>

<compatibility>The optional third argument is supported in 2.3.15 and later</compatibility>

<usage><p>

Add a hook (at APR_HOOK_MIDDLE) to the translate name phase of

request processing. The hook function receives a single

argument, the request_rec, and should return a status code,

which is either an HTTP error code, or the constants defined

in the apache2 module: apache2.OK, apache2.DECLINED, or

apache2.DONE. </p>

<p>For those new to hooks, basically each hook will be invoked

until one of them returns apache2.OK. If your hook doesn't

want to do the translation it should just return

apache2.DECLINED. If the request should stop processing, then

return apache2.DONE.</p>

<p>Example:</p>

<highlight language="config">

# httpd.conf

LuaHookTranslateName /scripts/conf/hooks.lua silly_mapper

</highlight>

<highlight language="lua">

-- /scripts/conf/hooks.lua --

require "apache2"

function silly_mapper(r)

if r.uri == "/" then

r.filename = "/var/www/home.lua"

return apache2.OK

else

return apache2.DECLINED

end

end

</highlight>

<note><title>Context</title><p>This directive is not valid in <directive

type="section" module="core">Directory</directive>, <directive

type="section" module="core">Files</directive>, or htaccess

context.</p></note>

<note><title>Ordering</title><p>The optional arguments "early" or "late"

control when this script runs relative to other modules.</p></note>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>LuaHookFixups</name>

<description>Provide a hook for the fixups phase of a request

processing</description>

<syntax>LuaHookFixups /path/to/lua/script.lua hook_function_name</syntax>

<contextlist><context>server config</context><context>virtual host</context>

<context>directory</context><context>.htaccess</context>

</contextlist>

<override>All</override>

<usage>

<p>

Just like LuaHookTranslateName, but executed at the fixups phase

</p>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>LuaHookMapToStorage</name>

<description>Provide a hook for the map_to_storage phase of request processing</description>

<syntax>LuaHookMapToStorage /path/to/lua/script.lua hook_function_name</syntax>

<contextlist><context>server config</context><context>virtual host</context>

<context>directory</context><context>.htaccess</context>

</contextlist>

<override>All</override>

<usage>

<p>Like <directive>LuaHookTranslateName</directive> but executed at the

map-to-storage phase of a request. Modules like mod_cache run at this phase,

which makes for an interesting example on what to do here:</p>

<highlight language="config">

LuaHookMapToStorage /path/to/lua/script.lua check_cache

</highlight>

<highlight language="lua">

require"apache2"

cached_files = {}

function read_file(filename)

local input = io.open(filename, "r")

if input then

local data = input:read("*a")

cached_files[filename] = data

file = cached_files[filename]

input:close()

end

return cached_files[filename]

end

function check_cache(r)

if r.filename:match("%.png$") then -- Only match PNG files

local file = cached_files[r.filename] -- Check cache entries

if not file then

file = read_file(r.filename) -- Read file into cache

end

if file then -- If file exists, write it out

r.status = 200

r:write(file)

r:info(("Sent %s to client from cache"):format(r.filename))

return apache2.DONE -- skip default handler for PNG files

end

end

return apache2.DECLINED -- If we had nothing to do, let others serve this.

end

</highlight>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>LuaHookCheckUserID</name>

<description>Provide a hook for the check_user_id phase of request processing</description>

<syntax>LuaHookCheckUserID /path/to/lua/script.lua hook_function_name [early|late]</syntax>

<contextlist><context>server config</context><context>virtual host</context>

<context>directory</context><context>.htaccess</context>

</contextlist>

<override>All</override>

<compatibility>The optional third argument is supported in 2.3.15 and later</compatibility>

<usage><p>...</p>

<note><title>Ordering</title><p>The optional arguments "early" or "late"

control when this script runs relative to other modules.</p></note>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>LuaHookTypeChecker</name>

<description>Provide a hook for the type_checker phase of request processing</description>

<syntax>LuaHookTypeChecker /path/to/lua/script.lua hook_function_name</syntax>

<contextlist><context>server config</context><context>virtual host</context>

<context>directory</context><context>.htaccess</context>

</contextlist>

<override>All</override>

<usage><p>

This directive provides a hook for the type_checker phase of the request processing.

This phase is where requests are assigned a content type and a handler, and thus can

be used to modify the type and handler based on input:

</p>

<highlight language="config">

LuaHookTypeChecker /path/to/lua/script.lua type_checker

</highlight>

<highlight language="lua">

function type_checker(r)

if r.uri:match("%.to_gif$") then -- match foo.png.to_gif

r.content_type = "image/gif" -- assign it the image/gif type

r.handler = "gifWizard" -- tell the gifWizard module to handle this

r.filename = r.uri:gsub("%.to_gif$", "") -- fix the filename requested

return apache2.OK

end

return apache2.DECLINED

end

</highlight>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>LuaHookAuthChecker</name>

<description>Provide a hook for the auth_checker phase of request processing</description>

<syntax>LuaHookAuthChecker /path/to/lua/script.lua hook_function_name [early|late]</syntax>

<contextlist><context>server config</context><context>virtual host</context>

<context>directory</context><context>.htaccess</context>

</contextlist>

<override>All</override>

<compatibility>The optional third argument is supported in 2.3.15 and later</compatibility>

<usage>

<p>Invoke a lua function in the auth_checker phase of processing

a request. This can be used to implement arbitrary authentication

and authorization checking. A very simple example:

</p>

<highlight language="lua">

require 'apache2'

-- fake authcheck hook

-- If request has no auth info, set the response header and

-- return a 401 to ask the browser for basic auth info.

-- If request has auth info, don't actually look at it, just

-- pretend we got userid 'foo' and validated it.

-- Then check if the userid is 'foo' and accept the request.

function authcheck_hook(r)

-- look for auth info

auth = r.headers_in['Authorization']

if auth ~= nil then

-- fake the user

r.user = 'foo'

end

if r.user == nil then

r:debug("authcheck: user is nil, returning 401")

r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'

return 401

elseif r.user == "foo" then

r:debug('user foo: OK')

else

r:debug("authcheck: user='" .. r.user .. "'")

r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'

return 401

end

return apache2.OK

end

</highlight>

<note><title>Ordering</title><p>The optional arguments "early" or "late"

control when this script runs relative to other modules.</p></note>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>LuaHookAccessChecker</name>

<description>Provide a hook for the access_checker phase of request processing</description>

<syntax>LuaHookAccessChecker /path/to/lua/script.lua hook_function_name [early|late]</syntax>

<contextlist><context>server config</context><context>virtual host</context>

<context>directory</context><context>.htaccess</context>

</contextlist>

<override>All</override>

<compatibility>The optional third argument is supported in 2.3.15 and later</compatibility>

<usage>

<p>Add your hook to the access_checker phase. An access checker

hook function usually returns OK, DECLINED, or HTTP_FORBIDDEN.</p>

<note><title>Ordering</title><p>The optional arguments "early" or "late"

control when this script runs relative to other modules.</p></note>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>LuaHookInsertFilter</name>

<description>Provide a hook for the insert_filter phase of request processing</description>

<syntax>LuaHookInsertFilter /path/to/lua/script.lua hook_function_name</syntax>

<contextlist><context>server config</context><context>virtual host</context>

<context>directory</context><context>.htaccess</context>

</contextlist>

<override>All</override>

<usage><p>Not Yet Implemented</p></usage>

</directivesynopsis>

<directivesynopsis>

<name>LuaInherit</name>

<description>Controls how parent configuration sections are merged into children</description>

<syntax>LuaInherit none|parent-first|parent-last</syntax>