You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by hu...@apache.org on 2012/08/04 11:15:59 UTC
svn commit: r1369293 [2/2] - in /httpd/httpd/trunk/docs/manual/developer:
lua.html lua.html.en lua.xml lua.xml.meta
Added: httpd/httpd/trunk/docs/manual/developer/lua.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/developer/lua.xml?rev=1369293&view=auto
==============================================================================
--- httpd/httpd/trunk/docs/manual/developer/lua.xml (added)
+++ httpd/httpd/trunk/docs/manual/developer/lua.xml Sat Aug 4 09:15:58 2012
@@ -0,0 +1,2684 @@
+<?xml version='1.0' encoding='UTF-8' ?>
+<!DOCTYPE manualpage SYSTEM "../style/manualpage.dtd">
+<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
+
+<!-- $LastChangedRevision: 1353955 $ -->
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<manualpage metafile="lua.xml.meta">
+<parentdocument href="./">Developer</parentdocument>
+
+ <title>Creating hooks and scripts with mod_lua</title>
+
+<summary>
+<p>This document expands on the <module>mod_lua</module> documentation and explores
+ additional ways of using mod_lua for writing hooks and scripts.</p>
+</summary>
+
+<seealso><a href="../mod/mod_lua.html">mod_lua</a></seealso>
+<seealso><a href="modguide.html">Developing modules for Apache 2.4</a></seealso>
+<seealso><a href="request.html">Request Processing in Apache 2.4</a></seealso>
+<seealso><a href="hooks.html">Apache 2.x Hook Functions</a></seealso>
+
+<section id="introduction"><title>Introduction</title>
+<section id="what"><title>What is mod_lua</title>
+<p>
+Stuff about what <module>mod_lua</module> is goes here.
+</p>
+</section>
+<section id="contents"><title>What we will be discussing in this document</title>
+<p>
+This document will discuss how you can bla bla bla.
+In the first chapter, we will bla bla
+</p>
+
+<p>
+In the second part of this document, we will be looking at bla bla bla
+</p>
+</section>
+
+<section id="prerequisites"><title>Prerequisites</title>
+<p>
+First and foremost, you are expected to have a basic knowledge of how the Lua
+programming language works. In most cases, we will try to be as pedagogical
+as possible and link to documents describing the functions used in the
+examples, but there are also many cases where it is necessary to either
+just assume that "it works" or do some digging yourself into what the hows
+and whys of various function calls.
+</p>
+
+
+</section>
+<section id="enabling"><title>Enabling mod_lua</title>
+
+<highlight language="config">
+LoadModule lua_module modules/mod_lua.so
+</highlight>
+
+</section>
+
+</section>
+
+<section id="basic_remap"><title>Example 1: A basic remapping module</title>
+<p>
+
+</p>
+
+<highlight language="config">
+LuaHookTranslateName /path/too/foo.lua remap
+</highlight>
+
+
+<!-- BEGIN EXAMPLE CODE -->
+<highlight language="lua">
+--[[
+ Simple remap example.
+ This example will rewrite /foo/test.bar to the physical file
+ /internal/test, somewhat like how mod_alias works.
+]]--
+require 'apache2'
+require 'string'
+
+function remap(r)
+ -- Test if the URI matches our criteria
+ local barFile = r.uri:match("/foo/([a-zA-Z0-9]+%.bar)")
+ if barFile then
+ r.filename = "/internal/" .. barFile
+ end
+ return apache2.OK
+end
+</highlight>
+<!-- END EXAMPLE CODE -->
+
+
+<!-- BEGIN EXAMPLE CODE -->
+<highlight language="lua">
+--[[
+ Advanced remap example.
+ This example will evaluate some conditions, and based on that,
+ remap a file to one of two destinations, using a rewrite map.
+
+]]--
+require 'apache2'
+require 'string'
+
+local map = {
+ photos = {
+ source = [[^/photos/(.+)\.png$]],
+ destination = [[/uploads/www/$1.png]],
+ proxy = false
+ },
+ externals = {
+ source = [[^/ext/(.*)$]],
+ destination = [[http://www.example.com/$1]],
+ proxy = true
+ }
+}
+
+function interpolateString(s,v)
+ return s:gsub("%$(%d+)", function(a) return v[tonumber(a)] end)
+end
+
+function remap(r)
+ -- browse through the rewrite map
+ for key, entry in pairs(map) do
+ -- Match source regex against URI
+ local match = apache2.regex(r, entry.source, r.uri) then
+ if match and match[0] then
+ r.filename = interpolateString(entry.destination, match)
+ -- Is this a proxied remap?
+ if entry.proxy then
+ r.handler = "proxy-server" -- tell mod_proxy to handle this
+ r.proxyreq = apache2.PROXYREQ_REVERSE -- We'll want to do a reverse proxy
+ r.filename = "proxy:" .. r.filename -- Add the proxy scheme to the destination
+ end
+ return apache2.OK
+ end
+ end
+ return apache2.DECLINED
+end
+</highlight>
+<!-- END EXAMPLE CODE -->
+
+<p>
+bla bla
+</p>
+</section>
+
+
+
+
+<section id="mass_vhost"><title>Example 2: Mass virtual hosting</title>
+<p>
+
+</p>
+
+<highlight language="config">
+LuaHookTranslateName /path/too/foo.lua mass_vhost
+</highlight>
+
+
+<!-- BEGIN EXAMPLE CODE -->
+<highlight language="lua">
+--[[
+ Simple mass vhost script
+ This example will check a map for a virtual host and rewrite filename and
+ document root accordingly.
+]]--
+require 'apache2'
+require 'string'
+
+local vhosts = {
+ { domain = "example.com", home = "/www/example.com" },
+ { domain = "example.org", home = "/nfs/ext1/example.org" }
+}
+
+function mass_vhost(r)
+ -- Match against our hostname
+ for key, entry in pairs(vhosts) do
+ -- match against either host or *.host:
+ if apache2.strcmp_match(r.hostname, entry.domain) or
+ apache2.strcmp_match(r.hostname, "*." .. entry.domain) then
+ -- If it matches, rewrite filename and set document root
+ local filename = r.filename:sub(r.document_root:len()+1)
+ r.filename = entry.home .. filename
+ apahce2.set_document_root(entry.home)
+ return apache2.OK
+ end
+ end
+ return apache2.DECLINED
+end
+</highlight>
+<!-- END EXAMPLE CODE -->
+
+
+<!-- BEGIN EXAMPLE CODE -->
+<highlight language="lua">
+--[[
+ Advanced mass virtual hosting
+ This example will query a database for vhost entries and save them for
+ 60 seconds before checking for updates. For best performance, such scripts
+ should generally be run with LuaScope set to 'thread' or 'server'
+]]--
+require 'apache2'
+require 'string'
+
+local cached_vhosts = {}
+local timeout = 60
+
+-- Function for querying the database for saved vhost entries
+function query_vhosts(host)
+ if not cached_vhosts[host] or (cached_vhosts[host] and cached_vhosts[host].updated < os.time() - timeout) then
+ local db = apache2.dbopen("mod_dbd")
+ local _host = db:escape(_host)
+ local res, err = db:query( ("SELECT `destination` FROM `vhosts` WHERE `hostname` = '%s' LIMIT 1"):format(_host) )
+ if res and #res == 1 then
+ cached_vhosts[host] = { updated = os.time(), destination = res[1][1] }
+ else
+ cached_vhosts[host] = nil
+ end
+ db:close()
+ end
+ if cached_vhosts[host] then
+ return cached_vhosts[host].destination
+ else
+ return nil
+ end
+end
+
+function mass_vhost(r)
+ -- Check whether the hostname is in our database
+ local destination = query_vhosts(r.hostname)
+ if destination then
+ -- If found, rewrite and change document root
+ local filename = r.filename:sub(r.document_root:len()+1)
+ r.filename = destination .. filename
+ apahce2.set_document_root(destination)
+ return apache2.OK
+ end
+ return apache2.DECLINED
+end
+</highlight>
+<!-- END EXAMPLE CODE -->
+
+<p>
+bla bla
+</p>
+</section>
+
+
+
+
+<section id="basic_auth"><title>Example 3: A basic authorization hook</title>
+
+<highlight language="config">
+LuaHookAuthChecker /path/too/foo.lua check_auth
+</highlight>
+
+<!-- BEGIN EXAMPLE CODE -->
+<highlight language="lua">
+require 'apache2'
+require 'string'
+
+local accounts = {
+ bob = 'somePassword',
+ jane = 'Iloveponies'
+}
+
+-- Function for parsing the Authorization header into a username and a password
+function parse_auth(str)
+ local user,pass = nil, nil
+ if str and str:len() > 0 then
+ str = apache2.base64_decode(auth):sub(7));
+ user, pass = auth:match("([^:]+)%:([^:]+)")
+ end
+ return user, pass
+end
+
+-- The authentication hook
+function check_auth(r)
+ local user, pass = parse_auth(r.headers_in['Authorization'])
+ local authenticated = false
+ if user and pass then
+ if accounts[user] and accounts[user] == pass then
+ authenticated = true
+ r.user = user
+ end
+ end
+ r.headers_out["WWW-Authenticate"] = 'Basic realm="Super secret zone"'
+ if not authenticated then
+ return 401
+ else
+ return apache2.OK
+ end
+end
+</highlight>
+<!-- END EXAMPLE CODE -->
+
+
+<!-- BEGIN EXAMPLE CODE -->
+<highlight language="lua">
+-- An advanced authentication checker with a database backend,
+-- caching account entries for 1 minute
+require 'apache2'
+require 'string'
+
+local timeout = 60 -- Set account info to be refreshed every minute
+local accounts = {}
+
+-- Function for parsing the Authorization header into a username and a password
+function parse_auth(str)
+ local user,pass = nil, nil
+ if str and str:len() > 0 then
+ str = apache2.base64_decode(auth):sub(7));
+ user, pass = auth:match("([^:]+)%:([^:]+)")
+ end
+ return user, pass
+end
+
+-- Function for querying the database for the account's password (stored as a salted SHA-1 hash)
+function fetch_password(user)
+ if not accounts[user] or (accounts[user] and accounts[user].updated < os.time() - timeout) then
+ local db = apache2.dbopen("mod_dbd")
+ local usr = db:escape(user)
+ local res, err = db:query( ("SELECT `password` FROM `accounts` WHERE `user` = '%s' LIMIT 1"):format(usr) )
+ if res and #res == 1 then
+ accounts[user] = { updated = os.time(), password = res[1][1] }
+ else
+ accounts[user] = nil
+ end
+ db:close()
+ end
+ if accounts[user] then
+ return accounts[user].password
+ else
+ return nil
+ end
+end
+
+-- The authentication hook
+function check_auth(r)
+ local user, pass = parse_auth(r.headers_in['Authorization'])
+ local authenticated = false
+ if user and pass then
+ pass = apache2.sha1("addSomeSalt" .. pass)
+ local stored_pass = fetch_password(user)
+ if stored_pass and pass == stored_pass then
+ authenticated = true
+ r.user = user
+ end
+ end
+ r.headers_out["WWW-Authenticate"] = 'Basic realm="Super secret zone"'
+ if not authenticated then
+ return 401
+ else
+ return apache2.OK
+ end
+end
+</highlight>
+<!-- END EXAMPLE CODE -->
+
+
+</section>
+
+<section id="map_handler"><title>Example 4: Authorization using LuaAuthzProvider</title>
+
+<highlight language="config">
+LuaAuthzProvider rights /path/to/lua/script.lua rights_handler
+<Directory /www/private>
+ Require rights member
+</Directory>
+<Directory /www/admin>
+ Require rights admin
+</Directory>
+</highlight>
+
+<highlight language="lua">
+local members = { "rbowen", "humbedooh", "igalic", "covener" }
+local admins = { "humbedooh" }
+
+function rights_handler(r, what)
+ if r.user == nil then
+ return apache2.AUTHZ_AUTHZ_DENIED_NO_USER
+ end
+ if what == "member" then
+ for k, v in pairs(members) do
+ if r.user == v then
+ return apache2.AUTHZ_GRANTED
+ end
+ end
+ elseif what == "admin" then
+ for k, v in pairs(admins) do
+ if r.user == v then
+ return apache2.AUTHZ_GRANTED
+ end
+ end
+ end
+ return apache2.AUTHZ_DENIED
+end
+</highlight>
+</section>
+
+<section id="map_handler"><title>Example 5: Overlays using LuaMapHandler</title>
+
+<highlight language="config">
+LuaMaphandler ^/portal/([a-z]+)/ /path/to/lua/script.lua handle_$1
+</highlight>
+</section>
+
+<section id="mod_status_lua"><title>Example 6: Basic Lua scripts</title>
+</section>
+
+
+
+
+
+
+
+<section id="String_manipulation">
+<title>HTTPd bindings: String manipulation</title>
+<a href="#apache2.base64_encode">apache2.base64_encode</a>
+<br/>
+<a href="#apache2.base64_decode">apache2.base64_decode</a>
+<br/>
+<a href="#apache2.escape">apache2.escape</a>
+<br/>
+<a href="#apache2.unescape">apache2.unescape</a>
+<br/>
+<a href="#apache2.escapehtml">apache2.escapehtml</a>
+<br/>
+<a href="#apache2.md5">apache2.md5</a>
+<br/>
+<a href="#apache2.sha1">apache2.sha1</a>
+<br/>
+<a href="#apache2.os_escape_path">apache2.os_escape_path</a>
+<br/>
+<a href="#apache2.escape_logitem">apache2.escape_logitem</a>
+<br/>
+<section id="apache2.base64_decode">
+<title>apache2.base64_decode(
+ request_rec<em>Â r</em>, Â string<em>Â string</em>
+ )
+ </title>
+<p>
+Decodes a base64-encoded string
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+<tr>
+<td>string</td>
+<td>The string to decode</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+The base64-decoded string.
+ </p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+local str = "This is a test"
+local encoded = apache2.base64_encode(str)
+local decoded = apache2.base64_decode(encoded)
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+<section id="apache2.base64_encode">
+<title>apache2.base64_encode(
+ request_rec<em>Â r</em>, Â string<em>Â string</em>
+ )
+ </title>
+<p>
+Encodes a string using the base64 encoding scheme.
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+<tr>
+<td>string</td>
+<td>The string to encode</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+local str = "This is a test"
+local encoded = apache2.base64_encode(str)
+local decoded = apache2.base64_decode(encoded)
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+<section id="apache2.escape">
+<title>apache2.escape(
+ request_rec<em>Â r</em>, Â string<em>Â string</em>
+ )
+ </title>
+<p>
+url-escapes a string
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+<tr>
+<td>string</td>
+<td>The string to escape</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+The URL-escaped string.
+ </p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+local str = "This is a test"
+local escaped = apache2.escape(str)
+print(escaped) -- prints "This+is+a+test"
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+<section id="apache2.escape_logitem">
+<title>apache2.escape_logitem(
+ request_rec<em>Â r</em>, Â string<em>Â path</em>
+ )
+ </title>
+<p>
+Escape a string for logging
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+<tr>
+<td>path</td>
+<td>The string to escape</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+The converted string
+ </p>
+<br/>
+<br/>
+</section>
+<section id="apache2.escapehtml">
+<title>apache2.escapehtml(
+ request_rec<em>Â r</em>, Â string<em>Â html</em>, Â boolean<em>Â toasc</em>
+ )
+ </title>
+<p>
+Escapes HTML entities.
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+<tr>
+<td>html</td>
+<td>The HTML code to escape</td>
+</tr>
+<tr>
+<td>toasc</td>
+<td>Whether to escape all non-ASCI characters as &#nnn;</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+The escaped HTML code.
+ </p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+local html = "<b>Testing!</b>"
+local escaped = apache2.escapehtml(html)
+r:puts(escaped) -- prints "&lt;b&gt;Testing!&lt;/b&gt;"
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+<section id="apache2.md5">
+<title>apache2.md5(
+ request_rec<em>Â r</em>, Â string<em>Â string</em>
+ )
+ </title>
+<p>
+Computes an MD5 digest sum based on a string (binary safe)
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+<tr>
+<td>string</td>
+<td>The (binary) string to digest</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+The MD5 digest sum of the data provided
+ </p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+local text = "The quick brown fox jumps over the lazy dog"
+local md5 = apache2.md51(text)
+r:puts(md5) -- prints out "9e107d9d372bb6826bd81d3542a419d6"
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+<section id="apache2.os_escape_path">
+<title>apache2.os_escape_path(
+ request_rec<em>Â r</em>, Â string<em>Â path</em>, Â boolean<em>Â partial</em>
+ )
+ </title>
+<p>
+convert an OS path to a URL in an OS dependant way.
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+<tr>
+<td>path</td>
+<td>The path to convert</td>
+</tr>
+<tr>
+<td>partial</td>
+<td>partial if set, assume that the path will be appended to something with a '/' in it (and thus does not prefix "./")</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+The converted URL
+ </p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+local path = ap_os_escape_path("C:/foo/bar.txt")
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+<section id="apache2.sha1">
+<title>apache2.sha1(
+ request_rec<em>Â r</em>, Â string<em>Â string</em>
+ )
+ </title>
+<p>
+Computes an SHA-1 digest sum based on a string (binary safe)
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+<tr>
+<td>string</td>
+<td>The (binary) string to digest</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+The SHA-1 digest sum of the data provided
+ </p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+local text = "The quick brown fox jumps over the lazy dog"
+local sha1 = apache2.sha1(text)
+r:puts(sha1) -- prints out "2fd4e1c67a2d28fced849ee1bb76e7391b93eb12"
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+<section id="apache2.unescape">
+<title>apache2.unescape(
+ request_rec<em>Â r</em>, Â string<em>Â string</em>
+ )
+ </title>
+<p>
+unescapes an URL-escaped string
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+<tr>
+<td>string</td>
+<td>The string to unescape</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+The URL-unescaped string
+ </p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+local str = "This+is+a+test"
+local unescaped = apache2.unescape(str)
+print(unescaped) -- prints "This is a test"
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+</section>
+
+<section id="Request_handling">
+<title>HTTPd bindings: Request handling</title>
+<a href="#apache2.sendfile">apache2.sendfile</a>
+<br/>
+<a href="#apache2.port">apache2.port</a>
+<br/>
+<a href="#apache2.getenv">apache2.getenv</a>
+<br/>
+<a href="#apache2.setenv">apache2.setenv</a>
+<br/>
+<a href="#apache2.options">apache2.options</a>
+<br/>
+<a href="#apache2.allowoverrides">apache2.allowoverrides</a>
+<br/>
+<a href="#apache2.requestbody">apache2.requestbody</a>
+<br/>
+<a href="#apache2.add_input_filter">apache2.add_input_filter</a>
+<br/>
+<a href="#apache2.add_output_filter">apache2.add_output_filter</a>
+<br/>
+<a href="#apache2.get_basic_auth_pw">apache2.get_basic_auth_pw</a>
+<br/>
+<a href="#apache2.get_limit_req_body">apache2.get_limit_req_body</a>
+<br/>
+<a href="#apache2.request_has_body">apache2.request_has_body</a>
+<br/>
+<a href="#apache2.set_document_root">apache2.set_document_root</a>
+<br/>
+<a href="#apache2.some_auth_required">apache2.some_auth_required</a>
+<br/>
+<a href="#apache2.context_document_root">apache2.context_document_root</a>
+<br/>
+<a href="#apache2.context_prefix">apache2.context_prefix</a>
+<br/>
+<a href="#apache2.set_context_prefix">apache2.set_context_prefix</a>
+<br/>
+<a href="#apache2.set_keepalive">apache2.set_keepalive</a>
+<br/>
+<a href="#apache2.make_etag">apache2.make_etag</a>
+<br/>
+<a href="#apache2.flush">apache2.flush</a>
+<br/>
+<a href="#apache2.send_interim_response">apache2.send_interim_response</a>
+<br/>
+<a href="#apache2.get_server_name">apache2.get_server_name</a>
+<br/>
+<a href="#apache2.auth_type">apache2.auth_type</a>
+<br/>
+<a href="#apache2.auth_name">apache2.auth_name</a>
+<br/>
+<a href="#apache2.satisfies">apache2.satisfies</a>
+<br/>
+<section id="apache2.add_input_filter">
+<title>apache2.add_input_filter(
+ request_rec<em>Â r</em>, Â string<em>Â filter</em>
+ )
+ </title>
+<p>
+Adds an input filter to the request
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+<tr>
+<td>filter</td>
+<td>The name of the filter handler to add</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+apache2.add_input_filter(r, "SPAM_FILTER") -- Check input for spam..?
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+<section id="apache2.add_output_filter">
+<title>apache2.add_output_filter(
+ request_rec<em>Â r</em>, Â string<em>Â filter</em>
+ )
+ </title>
+<p>
+Adds an output filter to the request
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+<tr>
+<td>filter</td>
+<td>The name of the filter handler to add</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+apache2.add_input_filter(r, "INCLUDES") -- Turn out output into an SSI-enabled document.
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+<section id="apache2.allowoverrides">
+<title>apache2.allowoverrides(
+ request_rec<em>Â r</em>
+ )
+ </title>
+<p>
+Returns the currently allowed overrides for this context (AuthCfg, Options etc)
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+The currently allowed overrides for this context (AuthCfg, Options etc)
+ </p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+local ctx = apache2.allowoverrides(r)
+if ctx:match("AuthCfg") then
+ r:puts("You are allowed to override AuthCfg stuff in your .htaccess")
+end
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+<section id="apache2.auth_name">
+<title>apache2.auth_name(
+ request_rec<em>Â r</em>
+ )
+ </title>
+<p>
+Returns the current Authorization realm
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+The current authorization realm
+ </p>
+<br/>
+<br/>
+</section>
+<section id="apache2.auth_type">
+<title>apache2.auth_type(
+ request_rec<em>Â r</em>
+ )
+ </title>
+<p>
+Returns the current authentication type used in the request
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+The current Authorization type used in the request
+ </p>
+<br/>
+<br/>
+</section>
+<section id="apache2.context_document_root">
+<title>apache2.context_document_root(
+ request_rec<em>Â r</em>
+ )
+ </title>
+<p>
+Get the context_document_root for a request. This is a generalization of the document root, which is too limited in the presence of mappers like mod_userdir and mod_alias. The context_document_root is the directory on disk that maps to the context_prefix URI prefix.
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+</table>
+</p>
+<br/>
+<br/>
+</section>
+<section id="apache2.context_prefix">
+<title>apache2.context_prefix(
+ request_rec<em>Â r</em>
+ )
+ </title>
+<p>
+Get the context_prefix for a request. The context_prefix URI prefix maps to the context_document_root on disk.
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+</table>
+</p>
+<br/>
+<br/>
+</section>
+<section id="apache2.flush">
+<title>apache2.flush(
+ request_rec<em>Â r</em>
+ )
+ </title>
+<p>
+Flushes the content buffer, writing everything to the client immediately.
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+r:puts("This is buffered")
+apache2.flush(r) -- now it's written to the client.
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+<section id="apache2.get_basic_auth_pw">
+<title>apache2.get_basic_auth_pw(
+ request_rec<em>Â r</em>
+ )
+ </title>
+<p>
+Returns the password from a basic authorization request or nil if none was supplied
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+The password from a basic authorization request or nil if none was supplied
+ </p>
+<br/>
+<br/>
+</section>
+<section id="apache2.get_limit_req_body">
+<title>apache2.get_limit_req_body(
+ request_rec<em>Â r</em>
+ )
+ </title>
+<p>
+Returns the current request body size limit
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+The current request body size limit
+ </p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+local limit = apache2.get_limit_req_body(r)
+r:puts("You can't upload files bigger than ", limit, " bytes!")
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+<section id="apache2.get_server_name">
+<title>apache2.get_server_name(
+
+ )
+ </title>
+<p>
+Returns the current server name from the request
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+ None<br/>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+The server name
+ </p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+local name = apache2.get_server_name(r)
+r:puts("The ServerName is set to: ", name)
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+<section id="apache2.getenv">
+<title>apache2.getenv(
+ request_rec<em>Â r</em>, Â string<em>Â key</em>
+ )
+ </title>
+<p>
+Returns the value of an environment variable
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+<tr>
+<td>key</td>
+<td>key</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+The queried value
+ </p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+local env = apache2.getenv("HTTP_HOST")
+if env and env:len() > 0 then
+ r:puts("HTTP_HOST equals ", env)
+end
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+<section id="apache2.make_etag">
+<title>apache2.make_etag(
+ request_rec<em>Â r</em>, Â boolean<em>Â force_weak</em>
+ )
+ </title>
+<p>
+Constructs an entity tag from the resource information. If it's a real file, build in some of the file characteristics.
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+<tr>
+<td>force_weak</td>
+<td>force_weak Force the entity tag to be weak - it could be modified again in as short an interval.</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+The entity tag
+ </p>
+<br/>
+<br/>
+</section>
+<section id="apache2.options">
+<title>apache2.options(
+ request_rec<em>Â r</em>
+ )
+ </title>
+<p>
+Returns the currently allowed options for this context (Indexes, MultiViews etc)
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+The currently allowed options for this context.
+ </p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+local ctx = apache2.options(r)
+if ctx:match("MultiViews") then
+ r:puts("MultiViews is enabled!")
+end
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+<section id="apache2.port">
+<title>apache2.port(
+ request_rec<em>Â r</em>
+ )
+ </title>
+<p>
+Returns the port currently being used by the request
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+The current port used by the request
+ </p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+local port = apache2.port(r)
+r:puts("We are listening on port ", port)
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+<section id="apache2.request_has_body">
+<title>apache2.request_has_body(
+ request_rec<em>Â r</em>
+ )
+ </title>
+<p>
+Returns true if the request has a body(POST/PUT), false otherwise
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+True if the request has a body(POST/PUT), false otherwise
+ </p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+if apache2.request_has_body(r) then
+ -- do stuff with the req body
+end
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+<section id="apache2.requestbody">
+<title>apache2.requestbody(
+ request_rec<em>Â r</em>, Â string<em>Â filename</em>
+ )
+ </title>
+<p>
+Reads the request body. If a filename is specified, the request body will be written to that file and the number of bytes written returned, otherwise, the full request body will be returned as a string.
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+<tr>
+<td>filename</td>
+<td>filename</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+The number of bytes written if a filename was specified, otherwise it returns the entire request body as a string.
+ </p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+if tonumber(r.headers_in['Content-Length'] or 0) < 10000 then
+ local smallfile = apache2.requestbody(r) -- fetch a small file into memory
+ r:puts("I saved the uploaded file in memory")
+else
+ local read = apache2.requestbody(r, "/path/to/tmp")
+ r:puts("I saved the uploaded file in a temp directory. Total bytes written was: ", read)
+end
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+<section id="apache2.satisfies">
+<title>apache2.satisfies(
+ request_rec<em>Â r</em>
+ )
+ </title>
+<p>
+Returns how the requires lines must be met.
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+How the requirements must be met (SATISFY_ANY, SATISFY_ALL, SATISFY_NOSPEC).
+ </p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+local how = apache2.satisfies(r)
+if how == "SATISFY_ANY" then
+ -- ...
+end
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+<section id="apache2.send_interim_response">
+<title>apache2.send_interim_response(
+ request_rec<em>Â r</em>, Â boolean<em>Â send_headers</em>
+ )
+ </title>
+<p>
+Sends an interim (HTTP 1xx) response immediately.
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+<tr>
+<td>send_headers</td>
+<td>send_headers Whether to send&clear headers in r->headers_out</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+apache2.send_interim_response(r, false)
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+<section id="apache2.sendfile">
+<title>apache2.sendfile(
+ request_rec<em>Â r</em>, Â string<em>Â filename</em>
+ )
+ </title>
+<p>
+Sends a file to the client via sendfile() if possible.
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+<tr>
+<td>filename</td>
+<td>The file to send</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+apache2.sendfile(r, "/foo/bar/test.png") -- sends /foo/bar/test.png via sendfile
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+<section id="apache2.set_context_prefix">
+<title>apache2.set_context_prefix(
+ request_rec<em>Â r</em>, Â string<em>Â prefix</em>, Â string<em>Â document</em>
+ )
+ </title>
+<p>
+Set context_prefix and context_document_root for a request.
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+<tr>
+<td>prefix</td>
+<td>The URI prefix, without trailing slash</td>
+</tr>
+<tr>
+<td>document</td>
+<td>The corresponding directory on disk, without trailing slash</td>
+</tr>
+</table>
+</p>
+<br/>
+<br/>
+</section>
+<section id="apache2.set_document_root">
+<title>apache2.set_document_root(
+ request_rec<em>Â r</em>, Â string<em>Â root</em>
+ )
+ </title>
+<p>
+Sets the document root of the request.
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+<tr>
+<td>root</td>
+<td>root</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+-- Suppose our real document root is /var/bar, then...
+if r.hostname == "www.foo.com" then
+ apache2.set_document_root(r, "/www/foo") -- change document root on the fly
+end
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+<section id="apache2.set_keepalive">
+<title>apache2.set_keepalive(
+ request_rec<em>Â r</em>
+ )
+ </title>
+<p>
+Sets the keepalive status for this request
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+True if keepalive can be set, false otherwise
+ </p>
+<br/>
+<br/>
+</section>
+<section id="apache2.setenv">
+<title>apache2.setenv(
+ request_rec<em>Â r</em>, Â string<em>Â key</em>, Â string<em>Â val</em>
+ )
+ </title>
+<p>
+Sets the value of an environment variable
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+<tr>
+<td>key</td>
+<td>key</td>
+</tr>
+<tr>
+<td>val</td>
+<td>val</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+apache2.setenv("FOO_VAL", "bar and stuff")
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+<section id="apache2.some_auth_required">
+<title>apache2.some_auth_required(
+ request_rec<em>Â r</em>
+ )
+ </title>
+<p>
+Returns true if authorization is required for this request
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+True if auth is required, false if not.
+ </p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+if apache2.some_auth_required(r) then
+ print("debug: auth is required for this request\n")
+end
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+</section>
+
+<section id="Parser_functions">
+<title>HTTPd bindings: Parser functions</title>
+<a href="#apache2.expr">apache2.expr</a>
+<br/>
+<a href="#apache2.regex">apache2.regex</a>
+<br/>
+<a href="#apache2.strcmp_match">apache2.strcmp_match</a>
+<br/>
+<section id="apache2.expr">
+<title>apache2.expr(
+ request_rec<em>Â r</em>, Â string<em>Â expression</em>
+ )
+ </title>
+<p>
+Evaluates an ap_expr (think <If ...>) expression and returns true if the expression is true, false otherwise. A second value containing an error string is returned if the expression is invalid.
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+<tr>
+<td>expression</td>
+<td>expression</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+True if the expression evaluates as true, false if the expression doesn't evaluate as true or if an error occurred. If an error occurred during parsing, a second value will be returned, containng the error string.
+ </p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+if apache2.expr("%{REQUEST_URI} =~ /force-gzip") then
+ apache2.add_output_filter(r, "DEFLATE")
+end
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+<section id="apache2.regex">
+<title>apache2.regex(
+ request_rec<em>Â r</em>, Â string<em>Â expression</em>, Â string<em>Â source</em>
+ )
+ </title>
+<p>
+Evaluates a regular expression and, if it matches the source string, captures the variables and returns the matches as a table. On error, it returns nil.
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+<tr>
+<td>expression</td>
+<td>expression to match for</td>
+</tr>
+<tr>
+<td>source</td>
+<td>the source string to capture from</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+True if the expression evaluates as true, false if the expression doesn't evaluate as true or if an error occurred. If an error occurred during parsing, a second value will be returned, containng the error string.
+ </p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+local matches = apache2.regex(r, [[(\S+) kitty]], "Hello kitty")
+if matches and matches[1] then
+ r:puts("You said ", matches[1], " to kitty")
+end
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+<section id="apache2.strcmp_match">
+<title>apache2.strcmp_match(
+ string<em>Â str</em>, Â string<em>Â expexted</em>, Â boolean<em>Â ignoreCase</em>
+ )
+ </title>
+<p>
+Determines if a string matches a pattern containing the wildcards '?' or '*'
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>str</td>
+<td>The string to check</td>
+</tr>
+<tr>
+<td>expexted</td>
+<td>The pattern to match against</td>
+</tr>
+<tr>
+<td>ignoreCase</td>
+<td>Whether to ignore case when matching</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+True if the two strings match, false otherwise.
+ </p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+if apache2.strcmp_match("foo.bar", "foo.*") then
+ r:puts("It matches!")
+end
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+</section>
+
+<section id="Server_settings">
+<title>HTTPd bindings: Server settings</title>
+<a href="#apache2.add_version_component">apache2.add_version_component</a>
+<br/>
+<a href="#apache2.banner">apache2.banner</a>
+<br/>
+<a href="#apache2.mpm_query">apache2.mpm_query</a>
+<br/>
+<a href="#apache2.terminate">apache2.terminate</a>
+<br/>
+<a href="#apache2.scoreboard_process">apache2.scoreboard_process</a>
+<br/>
+<a href="#apache2.scoreboard_worker">apache2.scoreboard_worker</a>
+<br/>
+<a href="#apache2.started">apache2.started</a>
+<br/>
+<a href="#apache2.module_info">apache2.module_info</a>
+<br/>
+<a href="#apache2.get_server_built">apache2.get_server_built</a>
+<br/>
+<a href="#apache2.is_initial_req">apache2.is_initial_req</a>
+<br/>
+<a href="#apache2.loaded_modules">apache2.loaded_modules</a>
+<br/>
+<a href="#apache2.runtime_dir_relative">apache2.runtime_dir_relative</a>
+<br/>
+<a href="#apache2.server_info">apache2.server_info</a>
+<br/>
+<a href="#apache2.state_query">apache2.state_query</a>
+<br/>
+<a href="#apache2.custom_response">apache2.custom_response</a>
+<br/>
+<a href="#apache2.exists_config_define">apache2.exists_config_define</a>
+<br/>
+<section id="apache2.add_version_component">
+<title>apache2.add_version_component(
+ request_rec<em>Â r</em>, Â string<em>Â component</em>
+ )
+ </title>
+<p>
+Adds a component to the server description and banner strings
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+<tr>
+<td>component</td>
+<td>The component to add</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+if not apache2.banner():match("FooModule") then -- Make sure we haven't added it already
+ apache2.add_version_component(r, "FooModule/1.0")
+end
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+<section id="apache2.banner">
+<title>apache2.banner(
+
+ )
+ </title>
+<p>
+Returns the server banner
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+ None<br/>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+The server banner
+ </p>
+<br/>
+<br/>
+</section>
+<section id="apache2.custom_response">
+<title>apache2.custom_response(
+ request_rec<em>Â r</em>, Â number<em>Â status</em>, Â string<em>Â string</em>
+ )
+ </title>
+<p>
+Install a custom response handler for a given status
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+<tr>
+<td>status</td>
+<td>The status for which the custom response should be used</td>
+</tr>
+<tr>
+<td>string</td>
+<td>The custom response. This can be a static string, a file or a URL</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+apache2.custom_response(r, 404, "Not found!!")
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+<section id="apache2.exists_config_define">
+<title>apache2.exists_config_define(
+ string<em>Â name</em>
+ )
+ </title>
+<p>
+Checks for a definition from the server command line
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>name</td>
+<td>The define to check for</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+if apache2.exists_config_define("FOO") then
+ r:puts("This server was started with -DFOO")
+end
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+<section id="apache2.get_server_built">
+<title>apache2.get_server_built(
+
+ )
+ </title>
+<p>
+Returns the date the server was built
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+ None<br/>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+The date the server was built
+ </p>
+<br/>
+<br/>
+</section>
+<section id="apache2.is_initial_req">
+<title>apache2.is_initial_req(
+ request_rec<em>Â r</em>
+ )
+ </title>
+<p>
+Returns true if this is the main request, false if it is a sub-request
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+True if this is the main request, false if it is a sub-request
+ </p>
+<br/>
+<br/>
+</section>
+<section id="apache2.loaded_modules">
+<title>apache2.loaded_modules(
+
+ )
+ </title>
+<p>
+Returns a table containing the name (c filename) of all loaded modules
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+ None<br/>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+A table containing the name (c filename) of all loaded modules
+ </p>
+<br/>
+<br/>
+</section>
+<section id="apache2.module_info">
+<title>apache2.module_info(
+ string<em>Â c</em>, Â string<em>Â file</em>
+ )
+ </title>
+<p>
+Returns information about a specific module (if loaded)
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>c</td>
+<td>c</td>
+</tr>
+<tr>
+<td>file</td>
+<td>file</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+The various commands available to this module as a table, or nil if the module wasn't found.
+ </p>
+<br/>
+<br/>
+</section>
+<section id="apache2.mpm_query">
+<title>apache2.mpm_query(
+ number<em>Â i</em>
+ )
+ </title>
+<p>
+Queries the MPM for a specific value
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>i</td>
+<td>i</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+The queried value
+ </p>
+<br/>
+<br/>
+</section>
+<section id="apache2.runtime_dir_relative">
+<title>apache2.runtime_dir_relative(
+ request_rec<em>Â r</em>, Â string<em>Â file</em>
+ )
+ </title>
+<p>
+Returns the path of a file relative to the default runtime directory
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+<tr>
+<td>file</td>
+<td>file</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+The path of a file relative to the default runtime directory
+ </p>
+<br/>
+<br/>
+</section>
+<section id="apache2.scoreboard_process">
+<title>apache2.scoreboard_process(
+ request_rec<em>Â r</em>, Â number<em>Â child</em>
+ )
+ </title>
+<p>
+Returns the scoreboard for a server daemon as a table
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+<tr>
+<td>child</td>
+<td>The server child to query</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+The scoreboard for a server daemon as a table
+ </p>
+<br/>
+<br/>
+</section>
+<section id="apache2.scoreboard_worker">
+<title>apache2.scoreboard_worker(
+ request_rec<em>Â r</em>, Â number<em>Â child</em>, Â number<em>Â thread</em>
+ )
+ </title>
+<p>
+Returns the scoreboard for a single thread as a table
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+<tr>
+<td>child</td>
+<td>The server child to query</td>
+</tr>
+<tr>
+<td>thread</td>
+<td>The thread to query</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+The scoreboard for a single thread as a table
+ </p>
+<br/>
+<br/>
+</section>
+<section id="apache2.server_info">
+<title>apache2.server_info(
+
+ )
+ </title>
+<p>
+Returns a table with information about the server program
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+ None<br/>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+A table with information about the server program
+ </p>
+<br/>
+<br/>
+</section>
+<section id="apache2.started">
+<title>apache2.started(
+ request_rec<em>Â r</em>
+ )
+ </title>
+<p>
+Returns the time when the server was (re)started
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+The time when the server was (re)started
+ </p>
+<br/>
+<br/>
+</section>
+<section id="apache2.state_query">
+<title>apache2.state_query(
+ number<em>Â field</em>
+ )
+ </title>
+<p>
+Query the server for some state information
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>field</td>
+<td>Which information is requested</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+local gen = apache2.state_query(2)
+r:puts("This is generation no. " .. gen .. " of the top-level parent")
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+<section id="apache2.terminate">
+<title>apache2.terminate(
+
+ )
+ </title>
+<p>
+Kills off a server process. This has no other use than to show how dangerous mod_lua can be ;)
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+ None<br/>
+</p>
+<br/>
+<br/>
+</section>
+</section>
+<section id="Database_connectivity">
+<title>HTTPd bindings: Database connectivity</title>
+<a href="#apache2.dbopen">apache2.dbopen</a>
+<br/>
+<a href="#db:query">db:query</a>
+<br/>
+<a href="#db:do">db:do</a>
+<br/>
+<a href="#db:close">db:close</a>
+<br/>
+<section id="apache2.dbopen">
+<title>apache2.dbopen(
+ request_rec<em>Â r</em>, Â string<em>Â dbtype</em>, Â string<em>Â conn_string</em>
+ )
+ </title>
+<p>
+Opens up a new database connection. See the DB functions for mod_pLua for more info on this.
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+<tr>
+<td>dbtype</td>
+<td>dbtype</td>
+</tr>
+<tr>
+<td>conn_string</td>
+<td>connection string</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+The database connection as a table with functions, or nil if the connection failed. If a connection failed, a second argument (string) with the error code is returned.
+ </p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+local db, error = apache2.dbopen(r, "mod_dbd")
+if error then
+ r:puts("DB error: ", error)
+else
+ -- DB stuff here
+end
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+<section id="db:close">
+<title>db:close(
+ request_rec<em>Â r</em>
+ )
+ </title>
+<p>
+Closes a database connection
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+local db = apache2.dbopen(r, "mod_dbd") -- open a db connection
+db:close() -- close it down
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+<section id="db:do">
+<title>db:do(
+ request_rec<em>Â r</em>, Â string<em>Â query</em>
+ )
+ </title>
+<p>
+Executes a statement that doesn't return a result set
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+<tr>
+<td>query</td>
+<td>The SQL statement to execute</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+If the statement is valid, a table of results are returned. If an error occurred, the first return value is false and the second return value is a string containing an error message.
+ </p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+local db = apache2.dbopen(r, "mod_dbd")
+local affected = db:do("DELETE FROM `table` WHERE 1")
+if affected then
+ r:puts("Affected ", affected, " rows")
+end
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+<section id="db:query">
+<title>db:query(
+ request_rec<em>Â r</em>, Â string<em>Â query</em>
+ )
+ </title>
+<p>
+Queries the database for information using the specified statement.
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>r</td>
+<td>The mod_lua request handle</td>
+</tr>
+<tr>
+<td>query</td>
+<td>The SQL statement to execute</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+If the statement is valid, a table of results are returned. If an error occurred, the first return value is false and the second return value is a string containing an error message.
+ </p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+local db = apache2.dbopen(r, "mod_dbd")
+local result, error = db:query("SELECT * FROM `table` WHERE 1")
+if result then
+ for key, value in pairs(result)
+ r:puts( ("row %s: %s\n"):format(key, table.concat(value, ", ")) )
+ end
+end
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+</section>
+<section id="Miscellaneous">
+<title>HTTPd bindings: Miscellaneous</title>
+<a href="#apache2.clock">apache2.clock</a>
+<br/>
+<a href="#apache2.sleep">apache2.sleep</a>
+<br/>
+<section id="apache2.clock">
+<title>apache2.clock(
+
+ )
+ </title>
+<p>
+Returns the current time in microseconds.
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+ None<br/>
+</p>
+<p>
+<em>Return value(s):</em>
+<br/>
+The current time in microseconds.
+ </p>
+<br/>
+<br/>
+</section>
+<section id="apache2.sleep">
+<title>apache2.sleep(
+ number<em>Â seconds</em>
+ )
+ </title>
+<p>
+Sleeps for a while. Floating point values can be used to sleep for less than a second.
+ </p>
+<p>
+<em>Arguments:</em>
+<br/>
+<table border="1">
+<tr>
+<th>Argument</th>
+<th>Description</th>
+</tr>
+<tr>
+<td>seconds</td>
+<td>The number of seconds to sleep.</td>
+</tr>
+</table>
+</p>
+<p>
+<em>Example:</em>
+<br/>
+<highlight language="lua">
+r:puts("this is ")
+apache2.flush(r)
+apache2.sleep(0.25) -- sleep for a quarter second.
+r:puts("delayed")
+ </highlight>
+</p>
+<br/>
+<br/>
+</section>
+</section>
+
+</manualpage>
Added: httpd/httpd/trunk/docs/manual/developer/lua.xml.meta
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/developer/lua.xml.meta?rev=1369293&view=auto
==============================================================================
--- httpd/httpd/trunk/docs/manual/developer/lua.xml.meta (added)
+++ httpd/httpd/trunk/docs/manual/developer/lua.xml.meta Sat Aug 4 09:15:58 2012
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!-- GENERATED FROM XML: DO NOT EDIT -->
+
+<metafile reference="lua.xml">
+ <basename>lua</basename>
+ <path>/developer/</path>
+ <relpath>..</relpath>
+
+ <variants>
+ <variant>en</variant>
+ </variants>
+</metafile>