mod_lua.xml revision 457256c49209d6e56bfe63b411688ad9cb2a8429
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>
fb51a6b789d85113d0976148685b0063c294220drbowen<p>This module allows the server to be extended with scripts written in the
fb51a6b789d85113d0976148685b0063c294220drbowenLua programming language. The extension points (hooks) available with
fb51a6b789d85113d0976148685b0063c294220drbowen<module>mod_lua</module> include many of the hooks available to
fb51a6b789d85113d0976148685b0063c294220drbowennatively compiled Apache HTTP Server modules, such as mapping requests to
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowenfiles, generating dynamic responses, access control, authentication, and
fb51a6b789d85113d0976148685b0063c294220drbowenauthorization</p>
fb51a6b789d85113d0976148685b0063c294220drbowen<p>More information on the Lua programming language can be found at the
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowen<a href="http://www.lua.org/">the Lua website</a>.</p>
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowen<note><code>mod_lua</code> is still in experimental state.
fb51a6b789d85113d0976148685b0063c294220drbowenUntil it is declared stable, usage and behavior may change
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowenat any time.</note>
4b2d52ed83bf31730c8b6bbe7c06d806dc3a0c4erbowen<section id="basicconf"><title>Basic Configuration</title>
fb51a6b789d85113d0976148685b0063c294220drbowen<code>mod_lua</code> provides a handler named <code>lua-script</code>,
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenwhich can be used with an <code>AddHandler</code> directive:</p>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenAddHandler lua-script .lua
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenThis will cause <code>mod_lua</code> to handle requests for files
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<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
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenhandler are <module>mod_proxy</module>, <module>mod_cgi</module>,
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<p><code>mod_lua</code> always looks to invoke a Lua function for the handler, rather than
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenjust evaluating a script body CGI style. A handler function looks
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowensomething like this:</p>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen-- example handler
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenrequire "string"
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen This is the default method name for Lua handlers, see the optional
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen function-name in the LuaMapHandler directive to choose a different
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen entry point.
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenfunction handle(r)
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:puts("Hello Lua World!\n")
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen if r.method == 'GET' then
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen for k, v in pairs( r:parseargs() ) do
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:puts( string.format("%s: %s", k, v) )
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen elseif r.method == 'POST' then
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen for k, v in pairs( r:parsebody() ) do
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:puts( string.format("%s: %s", k, v) )
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen r:puts("unknown HTTP method " .. r.method)
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenThis handler function just prints out the uri or form encoded
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenarguments to a plaintext page.
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenThis means (and in fact encourages) that you can have multiple
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenhandlers (or hooks, or filters) in the same script.
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<section id="writinghooks"><title>Writing Hooks</title>
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowen<p>Hook functions are how modules (and Lua scripts) participate in the
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenprocessing of requests. Each type of hook exposed by the server exists for
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowena specific purposes such as mapping requests to the filesystem,
e27eee5caa6c1bf3853c11253ae82303cff0e40brbowenperforming access control, or setting mimetypes. General purpose hooks
fb51a6b789d85113d0976148685b0063c294220drbowenthat simply run at handy times in the request lifecycle exist as well.</p>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<p>Hook functions are passed the request object as their only argument.
fb51a6b789d85113d0976148685b0063c294220drbowenThey can return any value, depending on the hook, but most commonly
99e316bc4b9b2b5754165939ac14b6d16132cce1igalicthey'll return OK, DONE, or DECLINED, which you can write in lua as
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<code>apache2.OK</code>, <code>apache2.DONE</code>, or
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<code>apache2.DECLINED</code>, or else an HTTP status code.</p>
fb51a6b789d85113d0976148685b0063c294220drbowen-- example hook that rewrites the URI to a filesystem path.
2219c51bf0756c2f6f7deb88a13baf30f141c12epoirierrequire 'apache2'
fb51a6b789d85113d0976148685b0063c294220drbowenfunction translate_name(r)
fb51a6b789d85113d0976148685b0063c294220drbowen if r.uri == "/translate-name" then
fb51a6b789d85113d0976148685b0063c294220drbowen -- we don't care about this URL, give another module a chance
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic--[[ example hook that rewrites one URI to another URI. It returns a
fb51a6b789d85113d0976148685b0063c294220drbowen apache2.DECLINED to give other URL mappers a chance to work on the
fb51a6b789d85113d0976148685b0063c294220drbowen substitution, including the core translate_name hook which maps based
fb51a6b789d85113d0976148685b0063c294220drbowen on the DocumentRoot.
c994f52ac80f9664d2940e5ccd9e77466572013frbowen Note: It is currently undefined as to whether this runs before or after
c994f52ac80f9664d2940e5ccd9e77466572013frbowenrequire 'apache2'
c994f52ac80f9664d2940e5ccd9e77466572013frbowenfunction translate_name(r)
fb51a6b789d85113d0976148685b0063c294220drbowen if r.uri == "/translate-name" then
c994f52ac80f9664d2940e5ccd9e77466572013frbowen<section id="datastructures"><title>Data Structures</title>
fb51a6b789d85113d0976148685b0063c294220drbowen <p>The request_rec is mapped in as a userdata. It has a metatable
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen which lets you do useful things with it. For the most part it
fb51a6b789d85113d0976148685b0063c294220drbowen has the same fields as the request_rec struct (see httpd.h
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic until we get better docs here) many of which are writeable as
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic well as readable. (The table fields' content can be changed, but the
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic fields themselves cannot be set to different tables.)</p>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <p>The request_rec has (at least) the following methods:</p>
3e30fa5f420fe7302a4cdcd79cb001958fd54a13rbowen r:addoutputfilter(name|function) -- add an output filter
3e30fa5f420fe7302a4cdcd79cb001958fd54a13rbowen r:parseargs() -- returns a lua table containing the request's
fb51a6b789d85113d0976148685b0063c294220drbowen query string arguments
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen r:parsebody() -- parse the request body as a POST and return
fb51a6b789d85113d0976148685b0063c294220drbowen a lua table
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic r:puts("hello", " world", "!") -- print to response body
fb51a6b789d85113d0976148685b0063c294220drbowen r:write("a single string") -- print to response body
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<section id="logging"><title>Logging Functions</title>
fb51a6b789d85113d0976148685b0063c294220drbowen -- examples of logging messages<br />
fb51a6b789d85113d0976148685b0063c294220drbowen 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 />
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen r:info("This is an info log message")<br />
fb51a6b789d85113d0976148685b0063c294220drbowen r:notice("This is an notice log message")<br />
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic r:warn("This is an warn log message")<br />
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic r:err("This is an err log message")<br />
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic r:alert("This is an alert log message")<br />
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic r:crit("This is an crit log message")<br />
fb51a6b789d85113d0976148685b0063c294220drbowen r:emerg("This is an emerg log message")<br />
fb51a6b789d85113d0976148685b0063c294220drbowen<p>A package named <code>apache2</code> is available with (at least) the following contents.</p>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <dd>internal constant OK. Handlers should return this if they've
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic handled the request.</dd>
fb51a6b789d85113d0976148685b0063c294220drbowen <dd>internal constant DECLINED. Handlers should return this if
fb51a6b789d85113d0976148685b0063c294220drbowen they are not going to handle the request.</dd>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <dt>apache2.PROXYREQ_NONE, apache2.PROXYREQ_PROXY, apache2.PROXYREQ_REVERSE, apache2.PROXYREQ_RESPONSE</dt>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic <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>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<contextlist><context>server config</context><context>virtual host</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<context>directory</context><context>.htaccess</context>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</contextlist>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen <p>Specify the base path which will be used to evaluate all
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen relative paths within mod_lua. If not specified they
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen will be resolved relative to the current working directory,
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen which may not always work well for a server.</p>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic</directivesynopsis>
99e316bc4b9b2b5754165939ac14b6d16132cce1igalic<directivesynopsis>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<description>One of once, request, conn, server -- default is once</description>
6b4cd1f143d5d7244d2476d1e28456212faddb72rbowen<syntax>LuaScope once|request|conn|server [max|min max]</syntax>
fb51a6b789d85113d0976148685b0063c294220drbowen<contextlist><context>server config</context><context>virtual host</context>
LuaMapHandler /(\w+)/(/w+) /scripts/$1.lua handle_$2
conventions as lua. This just munges the package.path in the
conventions as lua. This just munges the package.cpath in the
until one of them returns apache2.OK. If your hook doesn't
apache2.DECLINED. If the request should stop processing, then
if r.uri == "/" then
return apache2.OK
return apache2.DECLINED
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