mod_lua.xml revision 7550c8d681354ab6eb74439605d6a9c3b51d1c5f
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>
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowen<p>This module holds a great deal of power over httpd, which is both a
fb51a6b789d85113d0976148685b0063c294220drbowenstrength and a potential security risk. It is <strong>not</strong> recommended
3e30fa5f420fe7302a4cdcd79cb001958fd54a13rbowenthat you use this module on a server that is shared with users you do not
fb51a6b789d85113d0976148685b0063c294220drbowentrust, as it can be abused to change the internal workings of httpd.</p>
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowen<section id="basicconf"><title>Basic Configuration</title>
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowen</highlight>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier<code>mod_lua</code> provides a handler named <code>lua-script</code>,
249cc9b3d83d3c60666269b90ecb9f1390d32165poirierwhich can be used with an <code>AddHandler</code> directive:</p>
92e5d4326ae44f79da5cb049470daba604506846poirierAddHandler lua-script .lua
92e5d4326ae44f79da5cb049470daba604506846poirier</highlight>
fb51a6b789d85113d0976148685b0063c294220drbowenThis will cause <code>mod_lua</code> to handle requests for files
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim<p>For more flexibility, see <directive>LuaMapHandler</directive>.
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
92e5d4326ae44f79da5cb049470daba604506846poirierhandler are <module>mod_proxy</module>, <module>mod_cgi</module>,
92e5d4326ae44f79da5cb049470daba604506846poirier<p><code>mod_lua</code> always looks to invoke a Lua function for the handler, rather than
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jimjust evaluating a script body CGI style. A handler function looks
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jimsomething like this:</p>
92e5d4326ae44f79da5cb049470daba604506846poirier-- example handler
92e5d4326ae44f79da5cb049470daba604506846poirierrequire "string"
92e5d4326ae44f79da5cb049470daba604506846poirier This is the default method name for Lua handlers, see the optional
92e5d4326ae44f79da5cb049470daba604506846poirier function-name in the LuaMapHandler directive to choose a different
92e5d4326ae44f79da5cb049470daba604506846poirier entry point.
92e5d4326ae44f79da5cb049470daba604506846poirierfunction handle(r)
92e5d4326ae44f79da5cb049470daba604506846poirier r:puts("Hello Lua World!\n")
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim if r.method == 'GET' then
92e5d4326ae44f79da5cb049470daba604506846poirier for k, v in pairs( r:parseargs() ) do
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:puts( string.format("%s: %s\n", k, v) )
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen elseif r.method == 'POST' then
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen for k, v in pairs( r:parsebody() ) do
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen 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
92e5d4326ae44f79da5cb049470daba604506846poirierarguments to a plaintext page.
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jimThis means (and in fact encourages) that you can have multiple
889dc1728817c1c56d0c8d894c768614e346d86ecovenerhandlers (or hooks, or filters) in the same script.
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
bb57315f942d09c744543fe41e453bd0181fd93ecovenerhooks directly. The first argument to the
bb57315f942d09c744543fe41e453bd0181fd93ecovener<directive module="mod_authz_core">Require</directive> directive gives
bb57315f942d09c744543fe41e453bd0181fd93ecovenerthe name of the responsible authorization provider. For any
bb57315f942d09c744543fe41e453bd0181fd93ecovener<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
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
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jimargument:</p>
92e5d4326ae44f79da5cb049470daba604506846poirierrequire 'apache2'
92e5d4326ae44f79da5cb049470daba604506846poirierfunction authz_check_foo(r, ip, user)
92e5d4326ae44f79da5cb049470daba604506846poirier elseif r.user == nil then
92e5d4326ae44f79da5cb049470daba604506846poirier elseif r.user == user then
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen</highlight>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<p>The following configuration registers this function as provider
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<code>foo</code> and configures it for URL <code>/</code>:</p>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenLuaAuthzProvider foo authz_provider.lua authz_check_foo
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<Location />
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim Require foo 10.1.2.3 john_doe
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen</Location>
92e5d4326ae44f79da5cb049470daba604506846poirier</highlight>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier<section id="writinghooks"><title>Writing Hooks</title>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier<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 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'
249cc9b3d83d3c60666269b90ecb9f1390d32165poirierfunction 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>
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 (see httpd.h
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier until we get better docs here) 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>
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim <p>The request_rec has (at least) the following methods:</p>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen r:addoutputfilter(name|function) -- add an output filter
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim </highlight>
fb51a6b789d85113d0976148685b0063c294220drbowen r:parseargs() -- returns a Lua table containing the request's query string arguments
fb51a6b789d85113d0976148685b0063c294220drbowen </highlight>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen r:parsebody() -- parse any POST data in the request and return it as a Lua table
c994f52ac80f9664d2940e5ccd9e77466572013frbowen </highlight>
fb51a6b789d85113d0976148685b0063c294220drbowen r:puts("hello", " world", "!") -- print to response body
fb51a6b789d85113d0976148685b0063c294220drbowen </highlight>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic r:write("a single string") -- print to response body
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic </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 />
fb51a6b789d85113d0976148685b0063c294220drbowen 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 />
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim r:crit("This is an crit log message")<br />
fb51a6b789d85113d0976148685b0063c294220drbowen r:emerg("This is an emerg log message")<br />
fb51a6b789d85113d0976148685b0063c294220drbowen</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>
fb51a6b789d85113d0976148685b0063c294220drbowen <dd>internal constant DECLINED. Handlers should return this if
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic they are not going to handle the request.</dd>
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim <dt>apache2.PROXYREQ_NONE, apache2.PROXYREQ_PROXY, apache2.PROXYREQ_REVERSE, apache2.PROXYREQ_RESPONSE</dt>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen <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>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<contextlist><context>server config</context><context>virtual host</context>
fb51a6b789d85113d0976148685b0063c294220drbowen<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
fb51a6b789d85113d0976148685b0063c294220drbowen <p>Specify the base path which will be used to evaluate all
fb51a6b789d85113d0976148685b0063c294220drbowen relative paths within mod_lua. If not specified they
fb51a6b789d85113d0976148685b0063c294220drbowen will be resolved relative to the current working directory,
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim which may not always work well for a server.</p>
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<description>One of once, request, conn -- default is once</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<contextlist><context>server config</context><context>virtual host</context>
249cc9b3d83d3c60666269b90ecb9f1390d32165poirier<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
fb51a6b789d85113d0976148685b0063c294220drbowen <p>Specify the lifecycle scope of the Lua interpreter which will
fb51a6b789d85113d0976148685b0063c294220drbowen 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>
fb51a6b789d85113d0976148685b0063c294220drbowen <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>
92e5d4326ae44f79da5cb049470daba604506846poirier <dt>conn:</dt> <dd>Same as request but attached to the connection_rec</dd>
3a602d0ba8536a79a780655bb92133b571e38378poirier <dt>thread:</dt> <dd>Use the interpreter for the lifetime of the thread
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim handling the request (only available with threaded MPMs).</dd>
c994f52ac80f9664d2940e5ccd9e77466572013frbowen<!-- not implemented
c994f52ac80f9664d2940e5ccd9e77466572013frbowen <dt>server:</dt> <dd>This one is different than others because the
c994f52ac80f9664d2940e5ccd9e77466572013frbowen server scope is quite long lived, and multiple threads
c994f52ac80f9664d2940e5ccd9e77466572013frbowen will have the same server_rec. To accommodate this
c994f52ac80f9664d2940e5ccd9e77466572013frbowen server scoped interpreter are stored in an apr
c994f52ac80f9664d2940e5ccd9e77466572013frbowen resource list. The min and max arguments are intended
c994f52ac80f9664d2940e5ccd9e77466572013frbowen to specify the pool size, but are unused at this time.</dd>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<description>Map a path to a lua handler</description>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<syntax>LuaMapHandler uri-pattern /path/to/lua/script.lua [function-name]</syntax>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
fb51a6b789d85113d0976148685b0063c294220drbowen<context>directory</context><context>.htaccess</context>
fb51a6b789d85113d0976148685b0063c294220drbowen</contextlist>
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim <p>This directive matches a uri pattern to invoke a specific
fb51a6b789d85113d0976148685b0063c294220drbowen handler function in a specific file. It uses PCRE regular
fb51a6b789d85113d0976148685b0063c294220drbowen expressions to match the uri, and supports interpolating
fb51a6b789d85113d0976148685b0063c294220drbowen match groups into both the file path and the function name
fb51a6b789d85113d0976148685b0063c294220drbowen be careful writing your regular expressions to avoid security
fb51a6b789d85113d0976148685b0063c294220drbowen issues.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen LuaMapHandler /(\w+)/(\w+) /scripts/$1.lua handle_$2
fb51a6b789d85113d0976148685b0063c294220drbowen </highlight>
92e5d4326ae44f79da5cb049470daba604506846poirier handler function handle_show on the lua vm after
92e5d4326ae44f79da5cb049470daba604506846poirier loading that file.</p>
92e5d4326ae44f79da5cb049470daba604506846poirier</highlight>
92e5d4326ae44f79da5cb049470daba604506846poirier <p>This would invoke the "handle" function, which
92e5d4326ae44f79da5cb049470daba604506846poirier is the default if no specific function name is
76c23dcc502f814f6b988038d600719db07d28becovener provided.</p>
92e5d4326ae44f79da5cb049470daba604506846poirier</directivesynopsis>
92e5d4326ae44f79da5cb049470daba604506846poirier<directivesynopsis>
92e5d4326ae44f79da5cb049470daba604506846poirier<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>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen <usage><p>Add a path to lua's module search path. Follows the same
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen conventions as lua. This just munges the package.path in the
fb51a6b789d85113d0976148685b0063c294220drbowen lua vms.</p>
3e30fa5f420fe7302a4cdcd79cb001958fd54a13rbowen </highlight>
3e30fa5f420fe7302a4cdcd79cb001958fd54a13rbowen</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<description>Add a directory to lua's package.cpath</description>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<syntax>LuaPackageCPath /path/to/include/?.soa</syntax>
fb51a6b789d85113d0976148685b0063c294220drbowen<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
fb51a6b789d85113d0976148685b0063c294220drbowen <p>Add a path to lua's shared library search path. Follows the same
fb51a6b789d85113d0976148685b0063c294220drbowen conventions as lua. This just munges the package.cpath in the
fb51a6b789d85113d0976148685b0063c294220drbowen lua vms.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<directivesynopsis>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<description>Configure the compiled code cache.</description>
fb51a6b789d85113d0976148685b0063c294220drbowen<contextlist>
fb51a6b789d85113d0976148685b0063c294220drbowen<context>server config</context><context>virtual host</context>
fb51a6b789d85113d0976148685b0063c294220drbowen<context>directory</context><context>.htaccess</context>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen</contextlist>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic Specify the behavior of the in-memory code cache. The default
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic is stat, which stats the top level script (not any included
fb51a6b789d85113d0976148685b0063c294220drbowen ones) each time that file is needed, and reloads it if the
fb51a6b789d85113d0976148685b0063c294220drbowen modified time indicates it is newer than the one it has
fb51a6b789d85113d0976148685b0063c294220drbowen already loaded. The other values cause it to keep the file
fb51a6b789d85113d0976148685b0063c294220drbowen cached forever (don't stat and replace) or to never cache the
fb51a6b789d85113d0976148685b0063c294220drbowen <p>In general stat or forever is good for production, and stat or never
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic for development.</p>
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirierLuaCodeCache stat
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirierLuaCodeCache forever
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirierLuaCodeCache never
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier </highlight>
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier</directivesynopsis>
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier<directivesynopsis>
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier<description>Provide a hook for the translate name phase of request processing</description>
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier<syntax>LuaHookTranslateName /path/to/lua/script.lua hook_function_name [early|late]</syntax>
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier<contextlist><context>server config</context><context>virtual host</context>
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier</contextlist>
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier<compatibility>The optional third argument is supported in 2.3.15 and later</compatibility>
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier Add a hook (at APR_HOOK_MIDDLE) to the translate name phase of
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier request processing. The hook function receives a single
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier argument, the request_rec, and should return a status code,
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier which is either an HTTP error code, or the constants defined
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier in the apache2 module: apache2.OK, apache2.DECLINED, or
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier <p>For those new to hooks, basically each hook will be invoked
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier until one of them returns apache2.OK. If your hook doesn't
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier want to do the translation it should just return
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier apache2.DECLINED. If the request should stop processing, then
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirierLuaHookTranslateName /scripts/conf/hooks.lua silly_mapper
768c8bcc0d91d1c3c04b0f80c309d31c6182fbf8poirier</highlight>
fb51a6b789d85113d0976148685b0063c294220drbowenrequire "apache2"
9cd56c73a0fd508522ba2f6bc6c9839c478c61c3rbowenfunction silly_mapper(r)
fb51a6b789d85113d0976148685b0063c294220drbowen if r.uri == "/" then
92e5d4326ae44f79da5cb049470daba604506846poirier</highlight>
fb51a6b789d85113d0976148685b0063c294220drbowen <note><title>Context</title><p>This directive is not valid in <directive
fb51a6b789d85113d0976148685b0063c294220drbowen type="section" module="core">Directory</directive>, <directive
fb51a6b789d85113d0976148685b0063c294220drbowen type="section" module="core">Files</directive>, or htaccess
fb51a6b789d85113d0976148685b0063c294220drbowen <note><title>Ordering</title><p>The optional arguments "early" or "late"
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic control when this script runs relative to other modules.</p></note>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</directivesynopsis>
fb51a6b789d85113d0976148685b0063c294220drbowen<directivesynopsis>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>Provide a hook for the fixups phase of a request
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowenprocessing</description>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<syntax>LuaHookFixups /path/to/lua/script.lua hook_function_name</syntax>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen Just like LuaHookTranslateName, but executed at the fixups phase
fb51a6b789d85113d0976148685b0063c294220drbowen</directivesynopsis>
local input = io.open(filename, "r")
if r.filename:match("%.png$") then -- Only match PNG files
local file = cached_files[r.filename] -- Check cache entries
file = read_file(r.filename) -- Read file into cache
r.status = 200
r:info(("Sent %s to client from cache"):format(r.filename))
return apache2.DONE -- skip default handler for PNG files
return apache2.DECLINED -- If we had nothing to do, let others serve this.
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
return apache2.AUTHZ_GRANTED