granicus.if.org Git - apache/blob - docs/manual/mod/mod_lua.html.en

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
   4         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   5               This file is generated from xml source: DO NOT EDIT
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7       -->
   8 <title>mod_lua - Apache HTTP Server</title>
   9 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
  12 <script src="../style/scripts/prettify.min.js" type="text/javascript">
  13 </script>
  14
  15 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  16 <body>
  17 <div id="page-header">
  18 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  19 <p class="apache">Apache HTTP Server Version 2.5</p>
  20 <img alt="" src="../images/feather.gif" /></div>
  21 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  22 <div id="path">
  23 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.5</a> &gt; <a href="./">Modules</a></div>
  24 <div id="page-content">
  25 <div id="preamble"><h1>Apache Module mod_lua</h1>
  26 <div class="toplang">
  27 <p><span>Available Languages: </span><a href="../en/mod/mod_lua.html" title="English">&nbsp;en&nbsp;</a> |
  28 <a href="../fr/mod/mod_lua.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a></p>
  29 </div>
  30 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Provides Lua hooks into various portions of the httpd
  31 request processing</td></tr>
  32 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
  33 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>lua_module</td></tr>
  34 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_lua.c</td></tr>
  35 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>2.3 and later</td></tr></table>
  36 <h3>Summary</h3>
  37
  38 <p>This module allows the server to be extended with scripts written in the
  39 Lua programming language.  The extension points (hooks) available with
  40 <code class="module"><a href="../mod/mod_lua.html">mod_lua</a></code> include many of the hooks available to
  41 natively compiled Apache HTTP Server modules, such as mapping requests to
  42 files, generating dynamic responses, access control, authentication, and
  43 authorization</p>
  44
  45 <p>More information on the Lua programming language can be found at the
  46 <a href="http://www.lua.org/">the Lua website</a>.</p>
  47
  48 <div class="note"><code>mod_lua</code> is still in experimental state.
  49 Until it is declared stable, usage and behavior may change
  50 at any time, even between stable releases of the 2.4.x series.
  51 Be sure to check the CHANGES file before upgrading.</div>
  52
  53 <div class="warning"><h3>Warning</h3>
  54 <p>This module holds a great deal of power over httpd, which is both a
  55 strength and a potential security risk. It is <strong>not</strong> recommended
  56 that you use this module on a server that is shared with users you do not
  57 trust, as it can be abused to change the internal workings of httpd.</p>
  58 </div>
  59
  60 </div>
  61 <div id="quickview"><h3 class="directives">Directives</h3>
  62 <ul id="toc">
  63 <li><img alt="" src="../images/down.gif" /> <a href="#luaauthzprovider">LuaAuthzProvider</a></li>
  64 <li><img alt="" src="../images/down.gif" /> <a href="#luacodecache">LuaCodeCache</a></li>
  65 <li><img alt="" src="../images/down.gif" /> <a href="#luahookaccesschecker">LuaHookAccessChecker</a></li>
  66 <li><img alt="" src="../images/down.gif" /> <a href="#luahookauthchecker">LuaHookAuthChecker</a></li>
  67 <li><img alt="" src="../images/down.gif" /> <a href="#luahookcheckuserid">LuaHookCheckUserID</a></li>
  68 <li><img alt="" src="../images/down.gif" /> <a href="#luahookfixups">LuaHookFixups</a></li>
  69 <li><img alt="" src="../images/down.gif" /> <a href="#luahookinsertfilter">LuaHookInsertFilter</a></li>
  70 <li><img alt="" src="../images/down.gif" /> <a href="#luahooklog">LuaHookLog</a></li>
  71 <li><img alt="" src="../images/down.gif" /> <a href="#luahookmaptostorage">LuaHookMapToStorage</a></li>
  72 <li><img alt="" src="../images/down.gif" /> <a href="#luahooktranslatename">LuaHookTranslateName</a></li>
  73 <li><img alt="" src="../images/down.gif" /> <a href="#luahooktypechecker">LuaHookTypeChecker</a></li>
  74 <li><img alt="" src="../images/down.gif" /> <a href="#luainherit">LuaInherit</a></li>
  75 <li><img alt="" src="../images/down.gif" /> <a href="#luainputfilter">LuaInputFilter</a></li>
  76 <li><img alt="" src="../images/down.gif" /> <a href="#luamaphandler">LuaMapHandler</a></li>
  77 <li><img alt="" src="../images/down.gif" /> <a href="#luaoutputfilter">LuaOutputFilter</a></li>
  78 <li><img alt="" src="../images/down.gif" /> <a href="#luapackagecpath">LuaPackageCPath</a></li>
  79 <li><img alt="" src="../images/down.gif" /> <a href="#luapackagepath">LuaPackagePath</a></li>
  80 <li><img alt="" src="../images/down.gif" /> <a href="#luaquickhandler">LuaQuickHandler</a></li>
  81 <li><img alt="" src="../images/down.gif" /> <a href="#luaroot">LuaRoot</a></li>
  82 <li><img alt="" src="../images/down.gif" /> <a href="#luascope">LuaScope</a></li>
  83 </ul>
  84 <h3>Topics</h3>
  85 <ul id="topics">
  86 <li><img alt="" src="../images/down.gif" /> <a href="#basicconf">Basic Configuration</a></li>
  87 <li><img alt="" src="../images/down.gif" /> <a href="#writinghandlers">Writing Handlers</a></li>
  88 <li><img alt="" src="../images/down.gif" /> <a href="#writingauthzproviders">Writing Authorization Providers</a></li>
  89 <li><img alt="" src="../images/down.gif" /> <a href="#writinghooks">Writing Hooks</a></li>
  90 <li><img alt="" src="../images/down.gif" /> <a href="#datastructures">Data Structures</a></li>
  91 <li><img alt="" src="../images/down.gif" /> <a href="#functions">Built in functions</a></li>
  92 <li><img alt="" src="../images/down.gif" /> <a href="#logging">Logging Functions</a></li>
  93 <li><img alt="" src="../images/down.gif" /> <a href="#apache2">apache2 Package</a></li>
  94 <li><img alt="" src="../images/down.gif" /> <a href="#modifying_buckets">Modifying contents with Lua filters</a></li>
  95 <li><img alt="" src="../images/down.gif" /> <a href="#databases">Database connectivity</a></li>
  96 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
  97 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  98 <div class="section">
  99 <h2><a name="basicconf" id="basicconf">Basic Configuration</a></h2>
 100
 101 <p>The basic module loading directive is</p>
 102
 103 <pre class="prettyprint lang-config">LoadModule lua_module modules/mod_lua.so</pre>
 104
 105
 106 <p>
 107 <code>mod_lua</code> provides a handler named <code>lua-script</code>,
 108 which can be used with an <code>AddHandler</code> directive:</p>
 109
 110 <pre class="prettyprint lang-config">AddHandler lua-script .lua</pre>
 111
 112
 113 <p>
 114 This will cause <code>mod_lua</code> to handle requests for files
 115 ending in <code>.lua</code> by invoking that file's
 116 <code>handle</code> function.
 117 </p>
 118
 119 <p>For more flexibility, see <code class="directive">LuaMapHandler</code>.
 120 </p>
 121
 122 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 123 <div class="section">
 124 <h2><a name="writinghandlers" id="writinghandlers">Writing Handlers</a></h2>
 125 <p> In the Apache HTTP Server API, the handler is a specific kind of hook
 126 responsible for generating the response.  Examples of modules that include a
 127 handler are <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>, <code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code>,
 128 and <code class="module"><a href="../mod/mod_status.html">mod_status</a></code>.</p>
 129
 130 <p><code>mod_lua</code> always looks to invoke a Lua function for the handler, rather than
 131 just evaluating a script body CGI style. A handler function looks
 132 something like this:</p>
 133
 134
 135 <pre class="prettyprint lang-lua">
 136 <strong>example.lua</strong><br />
 137 -- example handler
 138
 139 require "string"
 140
 141 --[[
 142      This is the default method name for Lua handlers, see the optional
 143      function-name in the LuaMapHandler directive to choose a different
 144      entry point.
 145 --]]
 146 function handle(r)
 147     r.content_type = "text/plain"
 148
 149     if r.method == 'GET' then
 150         r:puts("Hello Lua World!\n")
 151         for k, v in pairs( r:parseargs() ) do
 152             r:puts( string.format("%s: %s\n", k, v) )
 153         end
 154     elseif r.method == 'POST' then
 155         r:puts("Hello Lua World!\n")
 156         for k, v in pairs( r:parsebody() ) do
 157             r:puts( string.format("%s: %s\n", k, v) )
 158         end
 159     elseif r.method == 'PUT' then
 160 -- use our own Error contents
 161         r:puts("Unsupported HTTP method " .. r.method)
 162         r.status = 405
 163         return apache2.ok
 164     else
 165 -- use the ErrorDocument
 166         return 501
 167     end
 168     return apache2.OK
 169 end</pre>
 170
 171
 172 <p>
 173 This handler function just prints out the uri or form encoded
 174 arguments to a plaintext page.
 175 </p>
 176
 177 <p>
 178 This means (and in fact encourages) that you can have multiple
 179 handlers (or hooks, or filters) in the same script.
 180 </p>
 181
 182 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 183 <div class="section">
 184 <h2><a name="writingauthzproviders" id="writingauthzproviders">Writing Authorization Providers</a></h2>
 185
 186
 187 <p><code class="module"><a href="../mod/mod_authz_core.html">mod_authz_core</a></code> provides a high-level interface to
 188 authorization that is much easier to use than using into the relevant
 189 hooks directly. The first argument to the
 190 <code class="directive"><a href="../mod/mod_authz_core.html#require">Require</a></code> directive gives
 191 the name of the responsible authorization provider. For any
 192 <code class="directive"><a href="../mod/mod_authz_core.html#require">Require</a></code> line,
 193 <code class="module"><a href="../mod/mod_authz_core.html">mod_authz_core</a></code> will call the authorization provider
 194 of the given name, passing the rest of the line as parameters. The
 195 provider will then check authorization and pass the result as return
 196 value.</p>
 197
 198 <p>The authz provider is normally called before authentication. If it needs to
 199 know the authenticated user name (or if the user will be authenticated at
 200 all), the provider must return <code>apache2.AUTHZ_DENIED_NO_USER</code>.
 201 This will cause authentication to proceed and the authz provider to be
 202 called a second time.</p>
 203
 204 <p>The following authz provider function takes two arguments, one ip
 205 address and one user name. It will allow access from the given ip address
 206 without authentication, or if the authenticated user matches the second
 207 argument:</p>
 208
 209 <pre class="prettyprint lang-lua">
 210 <strong>authz_provider.lua</strong><br />
 211
 212 require 'apache2'
 213
 214 function authz_check_foo(r, ip, user)
 215     if r.useragent_ip == ip then
 216         return apache2.AUTHZ_GRANTED
 217     elseif r.user == nil then
 218         return apache2.AUTHZ_DENIED_NO_USER
 219     elseif r.user == user then
 220         return apache2.AUTHZ_GRANTED
 221     else
 222         return apache2.AUTHZ_DENIED
 223     end
 224 end</pre>
 225
 226
 227 <p>The following configuration registers this function as provider
 228 <code>foo</code> and configures it for URL <code>/</code>:</p>
 229 <pre class="prettyprint lang-config">LuaAuthzProvider foo authz_provider.lua authz_check_foo
 230 &lt;Location /&gt;
 231   Require foo 10.1.2.3 john_doe
 232 &lt;/Location&gt;</pre>
 233
 234
 235 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 236 <div class="section">
 237 <h2><a name="writinghooks" id="writinghooks">Writing Hooks</a></h2>
 238
 239 <p>Hook functions are how modules (and Lua scripts) participate in the
 240 processing of requests. Each type of hook exposed by the server exists for
 241 a specific purpose, such as mapping requests to the file system,
 242 performing access control, or setting mime types:</p>
 243
 244 <table class="bordered"><tr class="header">
 245         <th>Hook phase</th>
 246         <th>mod_lua directive</th>
 247         <th>Description</th>
 248     </tr>
 249 <tr>
 250         <td>Quick handler</td>
 251         <td><code class="directive"><a href="#luaquickhandler">LuaQuickHandler</a></code></td>
 252         <td>This is the first hook that will be called after a request has
 253             been mapped to a host or virtual host</td>
 254     </tr>
 255 <tr class="odd">
 256         <td>Translate name</td>
 257         <td><code class="directive"><a href="#luahooktranslatename">LuaHookTranslateName</a></code></td>
 258         <td>This phase translates the requested URI into a filename on the
 259             system. Modules such as <code class="module"><a href="../mod/mod_alias.html">mod_alias</a></code> and
 260             <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> operate in this phase.</td>
 261     </tr>
 262 <tr>
 263         <td>Map to storage</td>
 264         <td><code class="directive"><a href="#luahookmaptostorage">LuaHookMapToStorage</a></code></td>
 265         <td>This phase maps files to their physical, cached or external/proxied storage.
 266             It can be used by proxy or caching modules</td>
 267     </tr>
 268 <tr class="odd">
 269         <td>Check Access</td>
 270         <td><code class="directive"><a href="#luahookaccesschecker">LuaHookAccessChecker</a></code></td>
 271         <td>This phase checks whether a client has access to a resource. This
 272             phase is run before the user is authenticated, so beware.
 273         </td>
 274     </tr>
 275 <tr>
 276         <td>Check User ID</td>
 277         <td><code class="directive"><a href="#luahookcheckuserid">LuaHookCheckUserID</a></code></td>
 278         <td>This phase it used to check the negotiated user ID</td>
 279     </tr>
 280 <tr class="odd">
 281         <td>Check Authorization</td>
 282         <td><code class="directive"><a href="#luahookauthchecker">LuaHookAuthChecker</a></code> or
 283             <code class="directive"><a href="#luaauthzprovider">LuaAuthzProvider</a></code></td>
 284         <td>This phase authorizes a user based on the negotiated credentials, such as
 285             user ID, client certificate etc.
 286         </td>
 287     </tr>
 288 <tr>
 289         <td>Check Type</td>
 290         <td><code class="directive"><a href="#luahooktypechecker">LuaHookTypeChecker</a></code></td>
 291         <td>This phase checks the requested file and assigns a content type and
 292             a handler to it</td>
 293     </tr>
 294 <tr class="odd">
 295         <td>Fixups</td>
 296         <td><code class="directive"><a href="#luahookfixups">LuaHookFixups</a></code></td>
 297         <td>This is the final "fix anything" phase before the content handlers
 298             are run. Any last-minute changes to the request should be made here.</td>
 299     </tr>
 300 <tr>
 301         <td>Content handler</td>
 302         <td>fx. <code>.lua</code> files or through <code class="directive"><a href="#luamaphandler">LuaMapHandler</a></code></td>
 303         <td>This is where the content is handled. Files are read, parsed, some are run,
 304             and the result is sent to the client</td>
 305     </tr>
 306 <tr class="odd">
 307         <td>Logging</td>
 308         <td><code class="directive"><a href="#luahooklog">LuaHookLog</a></code></td>
 309         <td>Once a request has been handled, it enters several logging phases,
 310             which logs the request in either the error or access log. Mod_lua
 311             is able to hook into the start of this and control logging output.</td>
 312     </tr>
 313 </table>
 314
 315 <p>Hook functions are passed the request object as their only argument
 316 (except for LuaAuthzProvider, which also gets passed the arguments from
 317 the Require directive).
 318 They can return any value, depending on the hook, but most commonly
 319 they'll return OK, DONE, or DECLINED, which you can write in Lua as
 320 <code>apache2.OK</code>, <code>apache2.DONE</code>, or
 321 <code>apache2.DECLINED</code>, or else an HTTP status code.</p>
 322
 323
 324 <pre class="prettyprint lang-lua">
 325 <strong>translate_name.lua</strong><br />
 326 -- example hook that rewrites the URI to a filesystem path.
 327
 328 require 'apache2'
 329
 330 function translate_name(r)
 331     if r.uri == "/translate-name" then
 332         r.filename = r.document_root .. "/find_me.txt"
 333         return apache2.OK
 334     end
 335     -- we don't care about this URL, give another module a chance
 336     return apache2.DECLINED
 337 end</pre>
 338
 339
 340
 341 <pre class="prettyprint lang-lua">
 342 <strong>translate_name2.lua</strong><br />
 343 --[[ example hook that rewrites one URI to another URI. It returns a
 344      apache2.DECLINED to give other URL mappers a chance to work on the
 345      substitution, including the core translate_name hook which maps based
 346      on the DocumentRoot.
 347
 348      Note: Use the early/late flags in the directive to make it run before
 349            or after mod_alias.
 350 --]]
 351
 352 require 'apache2'
 353
 354 function translate_name(r)
 355     if r.uri == "/translate-name" then
 356         r.uri = "/find_me.txt"
 357         return apache2.DECLINED
 358     end
 359     return apache2.DECLINED
 360 end</pre>
 361
 362 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 363 <div class="section">
 364 <h2><a name="datastructures" id="datastructures">Data Structures</a></h2>
 365
 366 <dl>
 367 <dt>request_rec</dt>
 368         <dd>
 369         <p>The request_rec is mapped in as a userdata. It has a metatable
 370         which lets you do useful things with it. For the most part it
 371         has the same fields as the request_rec struct, many of which are writable as
 372         well as readable.  (The table fields' content can be changed, but the
 373         fields themselves cannot be set to different tables.)</p>
 374
 375         <table class="bordered"><tr class="header">
 376           <th><strong>Name</strong></th>
 377           <th><strong>Lua type</strong></th>
 378           <th><strong>Writable</strong></th>
 379           <th><strong>Description</strong></th>
 380         </tr>
 381 <tr>
 382           <td><code>allowoverrides</code></td>
 383           <td>string</td>
 384           <td>no</td>
 385           <td>The AllowOverride options applied to the current request.</td>
 386         </tr>
 387 <tr class="odd">
 388           <td><code>ap_auth_type</code></td>
 389           <td>string</td>
 390           <td>no</td>
 391           <td>If an authentication check was made, this is set to the type
 392           of authentication (f.x. <code>basic</code>)</td>
 393         </tr>
 394 <tr>
 395           <td><code>args</code></td>
 396           <td>string</td>
 397           <td>yes</td>
 398           <td>The query string arguments extracted from the request
 399             (f.x. <code>foo=bar&amp;name=johnsmith</code>)</td>
 400         </tr>
 401 <tr class="odd">
 402           <td><code>assbackwards</code></td>
 403           <td>boolean</td>
 404           <td>no</td>
 405           <td>Set to true if this is an HTTP/0.9 style request
 406             (e.g. <code>GET /foo</code> (with no headers) )</td>
 407         </tr>
 408 <tr>
 409           <td><code>auth_name</code></td>
 410           <td>string</td>
 411           <td>no</td>
 412           <td>The realm name used for authorization (if applicable).</td>
 413         </tr>
 414 <tr class="odd">
 415           <td><code>banner</code></td>
 416           <td>string</td>
 417           <td>no</td>
 418           <td>The server banner, f.x. <code>Apache HTTP Server/2.4.3 openssl/0.9.8c</code></td>
 419         </tr>
 420 <tr>
 421           <td><code>basic_auth_pw</code></td>
 422           <td>string</td>
 423           <td>no</td>
 424           <td>The basic auth password sent with this request, if any</td>
 425         </tr>
 426 <tr class="odd">
 427           <td><code>canonical_filename</code></td>
 428           <td>string</td>
 429           <td>no</td>
 430           <td>The canonical filename of the request</td>
 431         </tr>
 432 <tr>
 433           <td><code>content_encoding</code></td>
 434           <td>string</td>
 435           <td>no</td>
 436           <td>The content encoding of the current request</td>
 437         </tr>
 438 <tr class="odd">
 439           <td><code>content_type</code></td>
 440           <td>string</td>
 441           <td>yes</td>
 442           <td>The content type of the current request, as determined in the
 443             type_check phase (f.x. <code>image/gif</code> or <code>text/html</code>)</td>
 444         </tr>
 445 <tr>
 446           <td><code>context_prefix</code></td>
 447           <td>string</td>
 448           <td>no</td>
 449           <td />
 450         </tr>
 451 <tr class="odd">
 452           <td><code>context_document_root</code></td>
 453           <td>string</td>
 454           <td>no</td>
 455           <td />
 456         </tr>
 457 <tr>
 458           <td><code>document_root</code></td>
 459           <td>string</td>
 460           <td>no</td>
 461           <td>The document root of the host</td>
 462         </tr>
 463 <tr class="odd">
 464           <td><code>err_headers_out</code></td>
 465           <td>table</td>
 466           <td>no</td>
 467           <td>MIME header environment for the response, printed even on errors and
 468             persist across internal redirects</td>
 469         </tr>
 470 <tr>
 471           <td><code>filename</code></td>
 472           <td>string</td>
 473           <td>yes</td>
 474           <td>The file name that the request maps to, f.x. /www/example.com/foo.txt. This can be
 475             changed in the translate-name or map-to-storage phases of a request to allow the
 476             default handler (or script handlers) to serve a different file than what was requested.</td>
 477         </tr>
 478 <tr class="odd">
 479           <td><code>handler</code></td>
 480           <td>string</td>
 481           <td>yes</td>
 482           <td>The name of the <a href="../handler.html">handler</a> that should serve this request, f.x.
 483             <code>lua-script</code> if it is to be served by mod_lua. This is typically set by the
 484             <code class="directive"><a href="../mod/mod_mime.html#addhandler">AddHandler</a></code> or <code class="directive"><a href="../mod/core.html#sethandler">SetHandler</a></code>
 485             directives, but could also be set via mod_lua to allow another handler to serve up a specific request
 486             that would otherwise not be served by it.
 487             </td>
 488         </tr>
 489 <tr>
 490           <td><code>headers_in</code></td>
 491           <td>table</td>
 492           <td>yes</td>
 493           <td>MIME header environment from the request. This contains headers such as <code>Host,
 494             User-Agent, Referer</code> and so on.</td>
 495         </tr>
 496 <tr class="odd">
 497           <td><code>headers_out</code></td>
 498           <td>table</td>
 499           <td>yes</td>
 500           <td>MIME header environment for the response.</td>
 501         </tr>
 502 <tr>
 503           <td><code>hostname</code></td>
 504           <td>string</td>
 505           <td>no</td>
 506           <td>The host name, as set by the <code>Host:</code> header or by a full URI.</td>
 507         </tr>
 508 <tr class="odd">
 509           <td><code>is_https</code></td>
 510           <td>boolean</td>
 511           <td>no</td>
 512           <td>Whether or not this request is done via HTTPS</td>
 513         </tr>
 514 <tr>
 515           <td><code>is_initial_req</code></td>
 516           <td>boolean</td>
 517           <td>no</td>
 518           <td>Whether this request is the initial request or a sub-request</td>
 519         </tr>
 520 <tr class="odd">
 521           <td><code>limit_req_body</code></td>
 522           <td>number</td>
 523           <td>no</td>
 524           <td>The size limit of the request body for this request, or 0 if no limit.</td>
 525         </tr>
 526 <tr>
 527           <td><code>log_id</code></td>
 528           <td>string</td>
 529           <td>no</td>
 530           <td>The ID to identify request in access and error log.</td>
 531         </tr>
 532 <tr class="odd">
 533           <td><code>method</code></td>
 534           <td>string</td>
 535           <td>no</td>
 536           <td>The request method, f.x. <code>GET</code> or <code>POST</code>.</td>
 537         </tr>
 538 <tr>
 539           <td><code>notes</code></td>
 540           <td>table</td>
 541           <td>yes</td>
 542           <td>A list of notes that can be passed on from one module to another.</td>
 543         </tr>
 544 <tr class="odd">
 545           <td><code>options</code></td>
 546           <td>string</td>
 547           <td>no</td>
 548           <td>The Options directive applied to the current request.</td>
 549         </tr>
 550 <tr>
 551           <td><code>path_info</code></td>
 552           <td>string</td>
 553           <td>no</td>
 554           <td>The PATH_INFO extracted from this request.</td>
 555         </tr>
 556 <tr class="odd">
 557           <td><code>port</code></td>
 558           <td>number</td>
 559           <td>no</td>
 560           <td>The server port used by the request.</td>
 561         </tr>
 562 <tr>
 563           <td><code>protocol</code></td>
 564           <td>string</td>
 565           <td>no</td>
 566           <td>The protocol used, f.x. <code>HTTP/1.1</code></td>
 567         </tr>
 568 <tr class="odd">
 569           <td><code>proxyreq</code></td>
 570           <td>string</td>
 571           <td>yes</td>
 572           <td>Denotes whether this is a proxy request or not. This value is generally set in
 573             the post_read_request/translate_name phase of a request.</td>
 574         </tr>
 575 <tr>
 576           <td><code>range</code></td>
 577           <td>string</td>
 578           <td>no</td>
 579           <td>The contents of the <code>Range:</code> header.</td>
 580         </tr>
 581 <tr class="odd">
 582           <td><code>remaining</code></td>
 583           <td>number</td>
 584           <td>no</td>
 585           <td>The number of bytes remaining to be read from the request body.</td>
 586         </tr>
 587 <tr>
 588           <td><code>server_built</code></td>
 589           <td>string</td>
 590           <td>no</td>
 591           <td>The time the server executable was built.</td>
 592         </tr>
 593 <tr class="odd">
 594           <td><code>server_name</code></td>
 595           <td>string</td>
 596           <td>no</td>
 597           <td>The server name for this request.</td>
 598         </tr>
 599 <tr>
 600           <td><code>some_auth_required</code></td>
 601           <td>boolean</td>
 602           <td>no</td>
 603           <td>Whether some authorization is/was required for this request.</td>
 604         </tr>
 605 <tr class="odd">
 606           <td><code>subprocess_env</code></td>
 607           <td>table</td>
 608           <td>yes</td>
 609           <td>The environment variables set for this request.</td>
 610         </tr>
 611 <tr>
 612           <td><code>started</code></td>
 613           <td>number</td>
 614           <td>no</td>
 615           <td>The time the server was (re)started, in seconds since the epoch (Jan 1st, 1970)</td>
 616         </tr>
 617 <tr class="odd">
 618           <td><code>status</code></td>
 619           <td>number</td>
 620           <td>yes</td>
 621           <td>The (current) HTTP return code for this request, f.x. <code>200</code> or <code>404</code>.</td>
 622         </tr>
 623 <tr>
 624           <td><code>the_request</code></td>
 625           <td>string</td>
 626           <td>no</td>
 627           <td>The request string as sent by the client, f.x. <code>GET /foo/bar HTTP/1.1</code>.</td>
 628         </tr>
 629 <tr class="odd">
 630           <td><code>unparsed_uri</code></td>
 631           <td>string</td>
 632           <td>no</td>
 633           <td>The unparsed URI of the request</td>
 634         </tr>
 635 <tr>
 636           <td><code>uri</code></td>
 637           <td>string</td>
 638           <td>yes</td>
 639           <td>The URI after it has been parsed by httpd</td>
 640         </tr>
 641 <tr class="odd">
 642           <td><code>user</code></td>
 643           <td>string</td>
 644           <td>yes</td>
 645           <td>If an authentication check has been made, this is set to the name of the authenticated user.</td>
 646         </tr>
 647 <tr>
 648           <td><code>useragent_ip</code></td>
 649           <td>string</td>
 650           <td>no</td>
 651           <td>The IP of the user agent making the request</td>
 652         </tr>
 653 </table>
 654            </dd>
 655     </dl>
 656 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 657 <div class="section">
 658 <h2><a name="functions" id="functions">Built in functions</a></h2>
 659
 660 <p>The request_rec object has (at least) the following methods:</p>
 661
 662 <pre class="prettyprint lang-lua">r:flush()   -- flushes the output buffer.
 663             -- Returns true if the flush was successful, false otherwise.
 664
 665 while we_have_stuff_to_send do
 666     r:puts("Bla bla bla\n") -- print something to client
 667     r:flush() -- flush the buffer (send to client)
 668     r.usleep(500000) -- fake processing time for 0.5 sec. and repeat
 669 end</pre>
 670
 671
 672 <pre class="prettyprint lang-lua">r:addoutputfilter(name|function) -- add an output filter:
 673
 674 r:addoutputfilter("fooFilter") -- add the fooFilter to the output stream</pre>
 675
 676
 677 <pre class="prettyprint lang-lua">r:sendfile(filename) -- sends an entire file to the client, using sendfile if supported by the current platform:
 678
 679 if use_sendfile_thing then
 680     r:sendfile("/var/www/large_file.img")
 681 end</pre>
 682
 683
 684 <pre class="prettyprint lang-lua">r:parseargs() -- returns two tables; one standard key/value table for regular GET data,
 685               -- and one for multi-value data (fx. foo=1&amp;foo=2&amp;foo=3):
 686
 687 local GET, GETMULTI = r:parseargs()
 688 r:puts("Your name is: " .. GET['name'] or "Unknown")</pre>
 689
 690
 691 <pre class="prettyprint lang-lua">r:parsebody([sizeLimit]) -- parse the request body as a POST and return two lua tables,
 692                          -- just like r:parseargs().
 693                          -- An optional number may be passed to specify the maximum number
 694                          -- of bytes to parse. Default is 8192 bytes:
 695
 696 local POST, POSTMULTI = r:parsebody(1024*1024)
 697 r:puts("Your name is: " .. POST['name'] or "Unknown")</pre>
 698
 699
 700 <pre class="prettyprint lang-lua">r:puts("hello", " world", "!") -- print to response body, self explanatory</pre>
 701
 702
 703 <pre class="prettyprint lang-lua">r:write("a single string") -- print to response body, self explanatory</pre>
 704
 705
 706 <pre class="prettyprint lang-lua">r:escape_html("&lt;html&gt;test&lt;/html&gt;") -- Escapes HTML code and returns the escaped result</pre>
 707
 708
 709 <pre class="prettyprint lang-lua">r:base64_encode(string) -- Encodes a string using the Base64 encoding standard:
 710
 711 local encoded = r:base64_encode("This is a test") -- returns VGhpcyBpcyBhIHRlc3Q=</pre>
 712
 713
 714 <pre class="prettyprint lang-lua">r:base64_decode(string) -- Decodes a Base64-encoded string:
 715
 716 local decoded = r:base64_decode("VGhpcyBpcyBhIHRlc3Q=") -- returns 'This is a test'</pre>
 717
 718
 719 <pre class="prettyprint lang-lua">r:md5(string) -- Calculates and returns the MD5 digest of a string (binary safe):
 720
 721 local hash = r:md5("This is a test") -- returns ce114e4501d2f4e2dcea3e17b546f339</pre>
 722
 723
 724 <pre class="prettyprint lang-lua">r:sha1(string) -- Calculates and returns the SHA1 digest of a string (binary safe):
 725
 726 local hash = r:sha1("This is a test") -- returns a54d88e06612d820bc3be72877c74f257b561b19</pre>
 727
 728
 729 <pre class="prettyprint lang-lua">r:escape(string) -- URL-Escapes a string:
 730
 731 local url = "http://foo.bar/1 2 3 &amp; 4 + 5"
 732 local escaped = r:escape(url) -- returns 'http%3a%2f%2ffoo.bar%2f1+2+3+%26+4+%2b+5'</pre>
 733
 734
 735 <pre class="prettyprint lang-lua">r:unescape(string) -- Unescapes an URL-escaped string:
 736
 737 local url = "http%3a%2f%2ffoo.bar%2f1+2+3+%26+4+%2b+5"
 738 local unescaped = r:unescape(url) -- returns 'http://foo.bar/1 2 3 &amp; 4 + 5'</pre>
 739
 740
 741 <pre class="prettyprint lang-lua">r:construct_url(string) -- Constructs an URL from an URI
 742
 743 local url = r:construct_url(r.uri)</pre>
 744
 745
 746 <pre class="prettyprint lang-lua">r.mpm_query(number) -- Queries the server for MPM information using ap_mpm_query:
 747
 748 local mpm = r.mpm_query(14)
 749 if mpm == 1 then
 750     r:puts("This server uses the Event MPM")
 751 end</pre>
 752
 753
 754 <pre class="prettyprint lang-lua">r:expr(string) -- Evaluates an <a href="../expr.html">expr</a> string.
 755
 756 if r:expr("%{HTTP_HOST} =~ /^www/") then
 757     r:puts("This host name starts with www")
 758 end</pre>
 759
 760
 761 <pre class="prettyprint lang-lua">r:scoreboard_process(a) -- Queries the server for information about the process at position <code>a</code>:
 762
 763 local process = r:scoreboard_process(1)
 764 r:puts("Server 1 has PID " .. process.pid)</pre>
 765
 766
 767 <pre class="prettyprint lang-lua">r:scoreboard_worker(a, b) -- Queries for information about the worker thread, <code>b</code>, in process <code>a</code>:
 768
 769 local thread = r:scoreboard_worker(1, 1)
 770 r:puts("Server 1's thread 1 has thread ID " .. thread.tid .. " and is in " .. thread.status .. " status")</pre>
 771
 772
 773
 774 <pre class="prettyprint lang-lua">r:clock() -- Returns the current time with microsecond precision</pre>
 775
 776
 777 <pre class="prettyprint lang-lua">r:requestbody(filename) -- Reads and returns the request body of a request.
 778                 -- If 'filename' is specified, it instead saves the
 779                 -- contents to that file:
 780
 781 local input = r:requestbody()
 782 r:puts("You sent the following request body to me:\n")
 783 r:puts(input)</pre>
 784
 785
 786 <pre class="prettyprint lang-lua">r:add_input_filter(filter_name) -- Adds 'filter_name' as an input filter</pre>
 787
 788
 789 <pre class="prettyprint lang-lua">r.module_info(module_name) -- Queries the server for information about a module
 790
 791 local mod = r.module_info("mod_lua.c")
 792 if mod then
 793     for k, v in pairs(mod.commands) do
 794        r:puts( ("%s: %s\n"):format(k,v)) -- print out all directives accepted by this module
 795     end
 796 end</pre>
 797
 798
 799 <pre class="prettyprint lang-lua">r:loaded_modules() -- Returns a list of modules loaded by httpd:
 800
 801 for k, module in pairs(r:loaded_modules()) do
 802     r:puts("I have loaded module " .. module .. "\n")
 803 end</pre>
 804
 805
 806 <pre class="prettyprint lang-lua">r:runtime_dir_relative(filename) -- Compute the name of a run-time file (e.g., shared memory "file")
 807                          -- relative to the appropriate run-time directory.</pre>
 808
 809
 810 <pre class="prettyprint lang-lua">r:server_info() -- Returns a table containing server information, such as
 811                 -- the name of the httpd executable file, mpm used etc.</pre>
 812
 813
 814 <pre class="prettyprint lang-lua">r:set_document_root(file_path) -- Sets the document root for the request to file_path</pre>
 815
 816
 817
 818
 819 <pre class="prettyprint lang-lua">r:set_context_info(prefix, docroot) -- Sets the context prefix and context document root for a request</pre>
 820
 821
 822 <pre class="prettyprint lang-lua">r:os_escape_path(file_path) -- Converts an OS path to a URL in an OS dependent way</pre>
 823
 824
 825 <pre class="prettyprint lang-lua">r:escape_logitem(string) -- Escapes a string for logging</pre>
 826
 827
 828 <pre class="prettyprint lang-lua">r.strcmp_match(string, pattern) -- Checks if 'string' matches 'pattern' using strcmp_match (globs).
 829                         -- fx. whether 'www.example.com' matches '*.example.com':
 830
 831 local match = r.strcmp_match("foobar.com", "foo*.com")
 832 if match then
 833     r:puts("foobar.com matches foo*.com")
 834 end</pre>
 835
 836
 837 <pre class="prettyprint lang-lua">r:set_keepalive() -- Sets the keepalive status for a request. Returns true if possible, false otherwise.</pre>
 838
 839
 840 <pre class="prettyprint lang-lua">r:make_etag() -- Constructs and returns the etag for the current request.</pre>
 841
 842
 843 <pre class="prettyprint lang-lua">r:send_interim_response(clear) -- Sends an interim (1xx) response to the client.
 844                        -- if 'clear' is true, available headers will be sent and cleared.</pre>
 845
 846
 847 <pre class="prettyprint lang-lua">r:custom_response(status_code, string) -- Construct and set a custom response for a given status code.
 848                                -- This works much like the ErrorDocument directive:
 849
 850 r:custom_response(404, "Baleted!")</pre>
 851
 852
 853 <pre class="prettyprint lang-lua">r.exists_config_define(string) -- Checks whether a configuration definition exists or not:
 854
 855 if r.exists_config_define("FOO") then
 856     r:puts("httpd was probably run with -DFOO, or it was defined in the configuration")
 857 end</pre>
 858
 859
 860 <pre class="prettyprint lang-lua">r:state_query(string) -- Queries the server for state information</pre>
 861
 862
 863 <pre class="prettyprint lang-lua">r:stat(filename [,wanted]) -- Runs stat() on a file, and returns a table with file information:
 864
 865 local info = r:stat("/var/www/foo.txt")
 866 if info then
 867     r:puts("This file exists and was last modified at: " .. info.modified)
 868 end</pre>
 869
 870
 871 <pre class="prettyprint lang-lua">r:regex(string, pattern [,flags]) -- Runs a regular expression match on a string, returning captures if matched:
 872
 873 local matches = r:regex("foo bar baz", [[foo (\w+) (\S*)]])
 874 if matches then
 875     r:puts("The regex matched, and the last word captured ($2) was: " .. matches[2])
 876 end
 877
 878 -- Example ignoring case sensitivity:
 879 local matches = r:regex("FOO bar BAz", [[(foo) bar]], 1)
 880
 881 -- Flags can be a bitwise combination of:
 882 -- 0x01: Ignore case
 883 -- 0x02: Multiline search</pre>
 884
 885
 886 <pre class="prettyprint lang-lua">r.usleep(number_of_microseconds) -- Puts the script to sleep for a given number of microseconds.</pre>
 887
 888
 889 <pre class="prettyprint lang-lua">r:dbacquire(dbType[, dbParams]) -- Acquires a connection to a database and returns a database class.
 890                         -- See '<a href="#databases">Database connectivity</a>' for details.</pre>
 891
 892
 893 <pre class="prettyprint lang-lua">r:ivm_set("key", value) -- Set an Inter-VM variable to hold a specific value.
 894                         -- These values persist even though the VM is gone or not being used,
 895                         -- and so should only be used if MaxConnectionsPerChild is &gt; 0
 896                         -- Values can be numbers, strings and booleans, and are stored on a
 897                         -- per process basis (so they won't do much good with a prefork mpm)
 898
 899 r:ivm_get("key")        -- Fetches a variable set by ivm_set. Returns the contents of the variable
 900                         -- if it exists or nil if no such variable exists.
 901
 902 -- An example getter/setter that saves a global variable outside the VM:
 903 function handle(r)
 904     -- First VM to call this will get no value, and will have to create it
 905     local foo = r:ivm_get("cached_data")
 906     if not foo then
 907         foo = do_some_calcs() -- fake some return value
 908         r:ivm_set("cached_data", foo) -- set it globally
 909     end
 910     r:puts("Cached data is: ", foo)
 911 end</pre>
 912
 913
 914 <pre class="prettyprint lang-lua">r:htpassword(string [,algorithm [,cost]]) -- Creates a password hash from a string.
 915                                           -- algorithm: 0 = APMD5 (default), 1 = SHA, 2 = BCRYPT, 3 = CRYPT.
 916                                           -- cost: only valid with BCRYPT algorithm (default = 5).</pre>
 917
 918
 919 <pre class="prettyprint lang-lua">r:mkdir(dir [,mode]) -- Creates a directory and sets mode to optional mode paramter.</pre>
 920
 921
 922 <pre class="prettyprint lang-lua">r:mkrdir(dir [,mode]) -- Creates directories recursive and sets mode to optional mode paramter.</pre>
 923
 924
 925 <pre class="prettyprint lang-lua">r:rmdir(dir) -- Removes a directory.</pre>
 926
 927
 928 <pre class="prettyprint lang-lua">r:touch(file [,mtime]) -- Sets the file modification time to current time or to optional mtime msec value.</pre>
 929
 930
 931 <pre class="prettyprint lang-lua">r:get_direntries(dir) -- Returns a table with all directory entries.
 932
 933 function handle(r)
 934   local dir = r.context_document_root
 935   for _, f in ipairs(r:get_direntries(dir)) do
 936     local info = r:stat(dir .. "/" .. f)
 937     if info then
 938       local mtime = os.date(fmt, info.mtime / 1000000)
 939       local ftype = (info.filetype == 2) and "[dir] " or "[file]"
 940       r:puts( ("%s %s %10i %s\n"):format(ftype, mtime, info.size, f) )
 941     end
 942   end
 943 end</pre>
 944
 945
 946 <pre class="prettyprint lang-lua">r.date_parse_rfc(string) -- Parses a date/time string and returns seconds since epoche.</pre>
 947
 948
 949 <pre class="prettyprint lang-lua">r:getcookie(key) -- Gets a HTTP cookie</pre>
 950
 951
 952 <pre class="prettyprint lang-lua">r:setcookie(key, value, secure, expires) -- Sets a HTTP cookie, for instance:
 953 r:setcookie("foo", "bar and stuff", false, os.time() + 86400)</pre>
 954
 955
 956 <pre class="prettyprint lang-lua">r:wsupgrade() -- Upgrades a connection to WebSockets if possible (and requested):
 957 if r:wsupgrade() then -- if we can upgrade:
 958     r:wswrite("Welcome to websockets!") -- write something to the client
 959     r:wsclose()  -- goodbye!
 960 end</pre>
 961
 962
 963 <pre class="prettyprint lang-lua">r:wsread() -- Reads a WebSocket frame from a WebSocket upgraded connection (see above):
 964
 965 local line, isFinal = r:wsread() -- isFinal denotes whether this is the final frame.
 966                                  -- If it isn't, then more frames can be read
 967 r:wswrite("You wrote: " .. line)</pre>
 968
 969
 970 <pre class="prettyprint lang-lua">r:wswrite(line) -- Writes a frame to a WebSocket client:
 971 r:wswrite("Hello, world!")</pre>
 972
 973
 974 <pre class="prettyprint lang-lua">r:wsclose() -- Closes a WebSocket request and terminates it for httpd:
 975
 976 if r:wsupgrade() then
 977     r:wswrite("Write something: ")
 978     local line = r:wsread() or "nothing"
 979     r:wswrite("You wrote: " .. line);
 980     r:wswrite("Goodbye!")
 981     r:wsclose()
 982 end</pre>
 983
 984
 985 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 986 <div class="section">
 987 <h2><a name="logging" id="logging">Logging Functions</a></h2>
 988
 989 <pre class="prettyprint lang-lua">        -- examples of logging messages<br />
 990         r:trace1("This is a trace log message") -- trace1 through trace8 can be used <br />
 991         r:debug("This is a debug log message")<br />
 992         r:info("This is an info log message")<br />
 993         r:notice("This is a notice log message")<br />
 994         r:warn("This is a warn log message")<br />
 995         r:err("This is an err log message")<br />
 996         r:alert("This is an alert log message")<br />
 997         r:crit("This is a crit log message")<br />
 998         r:emerg("This is an emerg log message")<br />
 999 </pre>
1000
1001
1002 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1003 <div class="section">
1004 <h2><a name="apache2" id="apache2">apache2 Package</a></h2>
1005 <p>A package named <code>apache2</code> is available with (at least) the following contents.</p>
1006 <dl>
1007   <dt>apache2.OK</dt>
1008   <dd>internal constant OK.  Handlers should return this if they've
1009   handled the request.</dd>
1010   <dt>apache2.DECLINED</dt>
1011   <dd>internal constant DECLINED.  Handlers should return this if
1012   they are not going to handle the request.</dd>
1013   <dt>apache2.DONE</dt>
1014   <dd>internal constant DONE.</dd>
1015   <dt>apache2.version</dt>
1016   <dd>Apache HTTP server version string</dd>
1017   <dt>apache2.HTTP_MOVED_TEMPORARILY</dt>
1018   <dd>HTTP status code</dd>
1019   <dt>apache2.PROXYREQ_NONE, apache2.PROXYREQ_PROXY, apache2.PROXYREQ_REVERSE, apache2.PROXYREQ_RESPONSE</dt>
1020   <dd>internal constants used by <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code></dd>
1021   <dt>apache2.AUTHZ_DENIED, apache2.AUTHZ_GRANTED, apache2.AUTHZ_NEUTRAL, apache2.AUTHZ_GENERAL_ERROR, apache2.AUTHZ_DENIED_NO_USER</dt>
1022   <dd>internal constants used by <code class="module"><a href="../mod/mod_authz_core.html">mod_authz_core</a></code></dd>
1023
1024 </dl>
1025 <p>(Other HTTP status codes are not yet implemented.)</p>
1026 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1027 <div class="section">
1028 <h2><a name="modifying_buckets" id="modifying_buckets">Modifying contents with Lua filters</a></h2>
1029
1030     <p>
1031     Filter functions implemented via <code class="directive"><a href="#luainputfilter">LuaInputFilter</a></code>
1032     or <code class="directive"><a href="#luaoutputfilter">LuaOutputFilter</a></code> are designed as
1033     three-stage non-blocking functions using coroutines to suspend and resume a
1034     function as buckets are sent down the filter chain. The core structure of
1035     such a function is:
1036     </p>
1037     <pre class="prettyprint lang-lua">function filter(r)
1038     -- Our first yield is to signal that we are ready to receive buckets.
1039     -- Before this yield, we can set up our environment, check for conditions,
1040     -- and, if we deem it necessary, decline filtering a request alltogether:
1041     if something_bad then
1042         return -- This would skip this filter.
1043     end
1044     -- Regardless of whether we have data to prepend, a yield MUST be called here.
1045     -- Note that only output filters can prepend data. Input filters must use the
1046     -- final stage to append data to the content.
1047     coroutine.yield([optional header to be prepended to the content])
1048
1049     -- After we have yielded, buckets will be sent to us, one by one, and we can
1050     -- do whatever we want with them and then pass on the result.
1051     -- Buckets are stored in the global variable 'bucket', so we create a loop
1052     -- that checks if 'bucket' is not nil:
1053     while bucket ~= nil do
1054         local output = mangle(bucket) -- Do some stuff to the content
1055         coroutine.yield(output) -- Return our new content to the filter chain
1056     end
1057
1058     -- Once the buckets are gone, 'bucket' is set to nil, which will exit the
1059     -- loop and land us here. Anything extra we want to append to the content
1060     -- can be done by doing a final yield here. Both input and output filters
1061     -- can append data to the content in this phase.
1062     coroutine.yield([optional footer to be appended to the content])
1063 end</pre>
1064
1065 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1066 <div class="section">
1067 <h2><a name="databases" id="databases">Database connectivity</a></h2>
1068
1069     <p>
1070     Mod_lua implements a simple database feature for querying and running commands
1071     on the most popular database engines (mySQL, PostgreSQL, FreeTDS, ODBC, SQLite, Oracle)
1072     as well as mod_dbd.
1073     </p>
1074     <p>The example below shows how to acquire a database handle and return information from a table:</p>
1075     <pre class="prettyprint lang-lua">function handle(r)
1076     -- Acquire a database handle
1077     local database, err = r:dbacquire("mysql", "server=localhost,user=someuser,pass=somepass,dbname=mydb")
1078     if not err then
1079         -- Select some information from it
1080         local results, err = database:select(r, "SELECT `name`, `age` FROM `people` WHERE 1")
1081         if not err then
1082             local rows = results(0) -- fetch all rows synchronously
1083             for k, row in pairs(rows) do
1084                 r:puts( string.format("Name: %s, Age: %s&lt;br/&gt;", row[1], row[2]) )
1085             end
1086         else
1087             r:puts("Database query error: " .. err)
1088         end
1089         database:close()
1090     else
1091         r:puts("Could not connect to the database: " .. err)
1092     end
1093 end</pre>
1094
1095     <p>
1096     To utilize <code class="module"><a href="../mod/mod_dbd.html">mod_dbd</a></code>, specify <code>mod_dbd</code>
1097     as the database type, or leave the field blank:
1098     </p>
1099     <pre class="prettyprint lang-lua">local database = r:dbacquire("mod_dbd")</pre>
1100
1101     <h3><a name="database_object" id="database_object">Database object and contained functions</a></h3>
1102
1103         <p>The database object returned by <code>dbacquire</code> has the following methods:</p>
1104         <p><strong>Normal select and query from a database:</strong></p>
1105     <pre class="prettyprint lang-lua">-- Run a statement and return the number of rows affected:
1106 local affected, errmsg = database:query(r, "DELETE FROM `tbl` WHERE 1")
1107
1108 -- Run a statement and return a result set that can be used synchronously or async:
1109 local result, errmsg = database:select(r, "SELECT * FROM `people` WHERE 1")</pre>
1110
1111         <p><strong>Using prepared statements (recommended):</strong></p>
1112     <pre class="prettyprint lang-lua">-- Create and run a prepared statement:
1113 local statement, errmsg = database:prepare(r, "DELETE FROM `tbl` WHERE `age` &gt; %u")
1114 if not errmsg then
1115     local result, errmsg = statement:query(20) -- run the statement with age &gt; 20
1116 end
1117
1118 -- Fetch a prepared statement from a DBDPrepareSQL directive:
1119 local statement, errmsg = database:prepared(r, "someTag")
1120 if not errmsg then
1121     local result, errmsg = statement:select("John Doe", 123) -- inject the values "John Doe" and 123 into the statement
1122 end</pre>
1123
1124         <p><strong>Escaping values, closing databases etc:</strong></p>
1125     <pre class="prettyprint lang-lua">-- Escape a value for use in a statement:
1126 local escaped = database:escape(r, [["'|blabla]])
1127
1128 -- Close a database connection and free up handles:
1129 database:close()
1130
1131 -- Check whether a database connection is up and running:
1132 local connected = database:active()</pre>
1133
1134
1135     <h3><a name="result_sets" id="result_sets">Working with result sets</a></h3>
1136
1137     <p>The result set returned by <code>db:select</code> or by the prepared statement functions
1138     created through <code>db:prepare</code> can be used to
1139     fetch rows synchronously or asynchronously, depending on the row number specified:<br />
1140     <code>result(0)</code> fetches all rows in a synchronous manner, returning a table of rows.<br />
1141     <code>result(-1)</code> fetches the next available row in the set, asynchronously.<br />
1142     <code>result(N)</code> fetches row number <code>N</code>, asynchronously:
1143     </p>
1144     <pre class="prettyprint lang-lua">-- fetch a result set using a regular query:
1145 local result, err = db:select(r, "SELECT * FROM `tbl` WHERE 1")
1146
1147 local rows = result(0) -- Fetch ALL rows synchronously
1148 local row = result(-1) -- Fetch the next available row, asynchronously
1149 local row = result(1234) -- Fetch row number 1234, asynchronously</pre>
1150
1151     <p>One can construct a function that returns an iterative function to iterate over all rows
1152     in a synchronous or asynchronous way, depending on the async argument:
1153     </p>
1154     <pre class="prettyprint lang-lua">function rows(resultset, async)
1155     local a = 0
1156     local function getnext()
1157         a = a + 1
1158         local row = resultset(-1)
1159         return row and a or nil, row
1160     end
1161     if not async then
1162         return pairs(resultset(0))
1163     else
1164         return getnext, self
1165     end
1166 end
1167
1168 local statement, err = db:prepare(r, "SELECT * FROM `tbl` WHERE `age` &gt; %u")
1169 if not err then
1170      -- fetch rows asynchronously:
1171     local result, err = statement:select(20)
1172     if not err then
1173         for index, row in rows(result, true) do
1174             ....
1175         end
1176     end
1177
1178      -- fetch rows synchronously:
1179     local result, err = statement:select(20)
1180     if not err then
1181         for index, row in rows(result, false) do
1182             ....
1183         end
1184     end
1185 end</pre>
1186
1187
1188     <h3><a name="closing_databases" id="closing_databases">Closing a database connection</a></h3>
1189
1190
1191     <p>Database handles should be closed using <code>database:close()</code> when they are no longer
1192     needed. If you do not close them manually, they will eventually be garbage collected and
1193     closed by mod_lua, but you may end up having too many unused connections to the database
1194     if you leave the closing up to mod_lua. Essentially, the following two measures are
1195     the same:
1196     </p>
1197     <pre class="prettyprint lang-lua">-- Method 1: Manually close a handle
1198 local database = r:dbacquire("mod_dbd")
1199 database:close() -- All done
1200
1201 -- Method 2: Letting the garbage collector close it
1202 local database = r:dbacquire("mod_dbd")
1203 database = nil -- throw away the reference
1204 collectgarbage() -- close the handle via GC</pre>
1205
1206
1207     <h3><a name="database_caveat" id="database_caveat">Precautions when working with databases</a></h3>
1208
1209     <p>Although the standard <code>query</code> and <code>run</code> functions are freely
1210     available, it is recommended that you use prepared statements whenever possible, to
1211     both optimize performance (if your db handle lives on for a long time) and to minimize
1212     the risk of SQL injection attacks. <code>run</code> and <code>query</code> should only
1213     be used when there are no variables inserted into a statement (a static statement).
1214     When using dynamic statements, use <code>db:prepare</code> or <code>db:prepared</code>.
1215     </p>
1216
1217
1218 </div>
1219 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1220 <div class="directive-section"><h2><a name="LuaAuthzProvider" id="LuaAuthzProvider">LuaAuthzProvider</a> <a name="luaauthzprovider" id="luaauthzprovider">Directive</a></h2>
1221 <table class="directive">
1222 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Plug an authorization provider function into <code class="module"><a href="../mod/mod_authz_core.html">mod_authz_core</a></code>
1223 </td></tr>
1224 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaAuthzProvider provider_name /path/to/lua/script.lua function_name</code></td></tr>
1225 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
1226 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1227 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1228 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>2.4.3 and later</td></tr>
1229 </table>
1230 <p>After a lua function has been registered as authorization provider, it can be used
1231 with the <code class="directive"><a href="../mod/mod_authz_core.html#require">Require</a></code> directive:</p>
1232
1233 <pre class="prettyprint lang-config">LuaRoot /usr/local/apache2/lua
1234 LuaAuthzProvider foo authz.lua authz_check_foo
1235 &lt;Location /&gt;
1236   Require foo johndoe
1237 &lt;/Location&gt;</pre>
1238
1239 <pre class="prettyprint lang-lua">require "apache2"
1240 function authz_check_foo(r, who)
1241     if r.user ~= who then return apache2.AUTHZ_DENIED
1242     return apache2.AUTHZ_GRANTED
1243 end</pre>
1244
1245
1246
1247
1248 </div>
1249 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1250 <div class="directive-section"><h2><a name="LuaCodeCache" id="LuaCodeCache">LuaCodeCache</a> <a name="luacodecache" id="luacodecache">Directive</a></h2>
1251 <table class="directive">
1252 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configure the compiled code cache.</td></tr>
1253 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaCodeCache stat|forever|never</code></td></tr>
1254 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LuaCodeCache stat</code></td></tr>
1255 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1256 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1257 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1258 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1259 </table><p>
1260     Specify the behavior of the in-memory code cache. The default
1261     is stat, which stats the top level script (not any included
1262     ones) each time that file is needed, and reloads it if the
1263     modified time indicates it is newer than the one it has
1264     already loaded. The other values cause it to keep the file
1265     cached forever (don't stat and replace) or to never cache the
1266     file.</p>
1267
1268     <p>In general stat or forever is good for production, and stat or never
1269     for development.</p>
1270
1271     <div class="example"><h3>Examples:</h3><pre class="prettyprint lang-config">LuaCodeCache stat
1272 LuaCodeCache forever
1273 LuaCodeCache never</pre>
1274 </div>
1275
1276
1277 </div>
1278 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1279 <div class="directive-section"><h2><a name="LuaHookAccessChecker" id="LuaHookAccessChecker">LuaHookAccessChecker</a> <a name="luahookaccesschecker" id="luahookaccesschecker">Directive</a></h2>
1280 <table class="directive">
1281 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Provide a hook for the access_checker phase of request processing</td></tr>
1282 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaHookAccessChecker  /path/to/lua/script.lua  hook_function_name [early|late]</code></td></tr>
1283 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1284 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1285 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1286 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1287 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>The optional third argument is supported in 2.3.15 and later</td></tr>
1288 </table>
1289 <p>Add your hook to the access_checker phase.  An access checker
1290 hook function usually returns OK, DECLINED, or HTTP_FORBIDDEN.</p>
1291    <div class="note"><h3>Ordering</h3><p>The optional arguments "early" or "late"
1292    control when this script runs relative to other modules.</p></div>
1293
1294 </div>
1295 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1296 <div class="directive-section"><h2><a name="LuaHookAuthChecker" id="LuaHookAuthChecker">LuaHookAuthChecker</a> <a name="luahookauthchecker" id="luahookauthchecker">Directive</a></h2>
1297 <table class="directive">
1298 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Provide a hook for the auth_checker phase of request processing</td></tr>
1299 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaHookAuthChecker  /path/to/lua/script.lua hook_function_name [early|late]</code></td></tr>
1300 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1301 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1302 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1303 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1304 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>The optional third argument is supported in 2.3.15 and later</td></tr>
1305 </table>
1306 <p>Invoke a lua function in the auth_checker phase of processing
1307 a request.  This can be used to implement arbitrary authentication
1308 and authorization checking.  A very simple example:
1309 </p>
1310 <pre class="prettyprint lang-lua">require 'apache2'
1311
1312 -- fake authcheck hook
1313 -- If request has no auth info, set the response header and
1314 -- return a 401 to ask the browser for basic auth info.
1315 -- If request has auth info, don't actually look at it, just
1316 -- pretend we got userid 'foo' and validated it.
1317 -- Then check if the userid is 'foo' and accept the request.
1318 function authcheck_hook(r)
1319
1320    -- look for auth info
1321    auth = r.headers_in['Authorization']
1322    if auth ~= nil then
1323      -- fake the user
1324      r.user = 'foo'
1325    end
1326
1327    if r.user == nil then
1328       r:debug("authcheck: user is nil, returning 401")
1329       r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
1330       return 401
1331    elseif r.user == "foo" then
1332       r:debug('user foo: OK')
1333    else
1334       r:debug("authcheck: user='" .. r.user .. "'")
1335       r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
1336       return 401
1337    end
1338    return apache2.OK
1339 end</pre>
1340
1341    <div class="note"><h3>Ordering</h3><p>The optional arguments "early" or "late"
1342    control when this script runs relative to other modules.</p></div>
1343
1344 </div>
1345 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1346 <div class="directive-section"><h2><a name="LuaHookCheckUserID" id="LuaHookCheckUserID">LuaHookCheckUserID</a> <a name="luahookcheckuserid" id="luahookcheckuserid">Directive</a></h2>
1347 <table class="directive">
1348 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Provide a hook for the check_user_id phase of request processing</td></tr>
1349 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaHookCheckUserID  /path/to/lua/script.lua hook_function_name [early|late]</code></td></tr>
1350 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1351 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1352 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1353 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1354 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>The optional third argument is supported in 2.3.15 and later</td></tr>
1355 </table><p>...</p>
1356    <div class="note"><h3>Ordering</h3><p>The optional arguments "early" or "late"
1357    control when this script runs relative to other modules.</p></div>
1358
1359 </div>
1360 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1361 <div class="directive-section"><h2><a name="LuaHookFixups" id="LuaHookFixups">LuaHookFixups</a> <a name="luahookfixups" id="luahookfixups">Directive</a></h2>
1362 <table class="directive">
1363 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Provide a hook for the fixups phase of a request
1364 processing</td></tr>
1365 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaHookFixups  /path/to/lua/script.lua hook_function_name</code></td></tr>
1366 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1367 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1368 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1369 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1370 </table>
1371 <p>
1372     Just like LuaHookTranslateName, but executed at the fixups phase
1373 </p>
1374
1375 </div>
1376 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1377 <div class="directive-section"><h2><a name="LuaHookInsertFilter" id="LuaHookInsertFilter">LuaHookInsertFilter</a> <a name="luahookinsertfilter" id="luahookinsertfilter">Directive</a></h2>
1378 <table class="directive">
1379 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Provide a hook for the insert_filter phase of request processing</td></tr>
1380 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaHookInsertFilter  /path/to/lua/script.lua hook_function_name</code></td></tr>
1381 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1382 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1383 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1384 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1385 </table><p>Not Yet Implemented</p>
1386 </div>
1387 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1388 <div class="directive-section"><h2><a name="LuaHookLog" id="LuaHookLog">LuaHookLog</a> <a name="luahooklog" id="luahooklog">Directive</a></h2>
1389 <table class="directive">
1390 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Provide a hook for the access log phase of a request
1391 processing</td></tr>
1392 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaHookLog  /path/to/lua/script.lua log_function_name</code></td></tr>
1393 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1394 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1395 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1396 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1397 </table>
1398 <p>
1399     This simple logging hook allows you to run a function when httpd enters the
1400     logging phase of a request. With it, you can append data to your own logs,
1401     manipulate data before the regular log is written, or prevent a log entry
1402     from being created. To prevent the usual logging from happening, simply return
1403     <code>apache2.DONE</code> in your logging handler, otherwise return
1404     <code>apache2.OK</code> to tell httpd to log as normal.
1405 </p>
1406 <p>Example:</p>
1407 <pre class="prettyprint lang-config">LuaHookLog /path/to/script.lua logger</pre>
1408
1409 <pre class="prettyprint lang-lua">-- /path/to/script.lua --
1410 function logger(r)
1411     -- flip a coin:
1412     -- If 1, then we write to our own Lua log and tell httpd not to log
1413     -- in the main log.
1414     -- If 2, then we just sanitize the output a bit and tell httpd to
1415     -- log the sanitized bits.
1416
1417     if math.random(1,2) == 1 then
1418         -- Log stuff ourselves and don't log in the regular log
1419         local f = io.open("/foo/secret.log", "a")
1420         if f then
1421             f:write("Something secret happened at " .. r.uri .. "\n")
1422             f:close()
1423         end
1424         return apache2.DONE -- Tell httpd not to use the regular logging functions
1425     else
1426         r.uri = r.uri:gsub("somesecretstuff", "") -- sanitize the URI
1427         return apache2.OK -- tell httpd to log it.
1428     end
1429 end</pre>
1430
1431
1432 </div>
1433 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1434 <div class="directive-section"><h2><a name="LuaHookMapToStorage" id="LuaHookMapToStorage">LuaHookMapToStorage</a> <a name="luahookmaptostorage" id="luahookmaptostorage">Directive</a></h2>
1435 <table class="directive">
1436 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Provide a hook for the map_to_storage phase of request processing</td></tr>
1437 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaHookMapToStorage  /path/to/lua/script.lua hook_function_name</code></td></tr>
1438 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1439 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1440 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1441 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1442 </table>
1443     <p>Like <code class="directive">LuaHookTranslateName</code> but executed at the
1444     map-to-storage phase of a request. Modules like mod_cache run at this phase,
1445     which makes for an interesting example on what to do here:</p>
1446     <pre class="prettyprint lang-config">LuaHookMapToStorage /path/to/lua/script.lua check_cache</pre>
1447
1448     <pre class="prettyprint lang-lua">require"apache2"
1449 cached_files = {}
1450
1451 function read_file(filename)
1452     local input = io.open(filename, "r")
1453     if input then
1454         local data = input:read("*a")
1455         cached_files[filename] = data
1456         file = cached_files[filename]
1457         input:close()
1458     end
1459     return cached_files[filename]
1460 end
1461
1462 function check_cache(r)
1463     if r.filename:match("%.png$") then -- Only match PNG files
1464         local file = cached_files[r.filename] -- Check cache entries
1465         if not file then
1466             file = read_file(r.filename)  -- Read file into cache
1467         end
1468         if file then -- If file exists, write it out
1469             r.status = 200
1470             r:write(file)
1471             r:info(("Sent %s to client from cache"):format(r.filename))
1472             return apache2.DONE -- skip default handler for PNG files
1473         end
1474     end
1475     return apache2.DECLINED -- If we had nothing to do, let others serve this.
1476 end</pre>
1477
1478
1479
1480 </div>
1481 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1482 <div class="directive-section"><h2><a name="LuaHookTranslateName" id="LuaHookTranslateName">LuaHookTranslateName</a> <a name="luahooktranslatename" id="luahooktranslatename">Directive</a></h2>
1483 <table class="directive">
1484 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Provide a hook for the translate name phase of request processing</td></tr>
1485 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaHookTranslateName  /path/to/lua/script.lua  hook_function_name [early|late]</code></td></tr>
1486 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1487 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1488 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1489 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1490 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>The optional third argument is supported in 2.3.15 and later</td></tr>
1491 </table><p>
1492     Add a hook (at APR_HOOK_MIDDLE) to the translate name phase of
1493     request processing. The hook function receives a single
1494     argument, the request_rec, and should return a status code,
1495     which is either an HTTP error code, or the constants defined
1496     in the apache2 module: apache2.OK, apache2.DECLINED, or
1497     apache2.DONE. </p>
1498
1499     <p>For those new to hooks, basically each hook will be invoked
1500     until one of them returns apache2.OK. If your hook doesn't
1501     want to do the translation it should just return
1502     apache2.DECLINED. If the request should stop processing, then
1503     return apache2.DONE.</p>
1504
1505     <p>Example:</p>
1506
1507 <pre class="prettyprint lang-config"># httpd.conf
1508 LuaHookTranslateName /scripts/conf/hooks.lua silly_mapper</pre>
1509
1510
1511 <pre class="prettyprint lang-lua">-- /scripts/conf/hooks.lua --
1512 require "apache2"
1513 function silly_mapper(r)
1514     if r.uri == "/" then
1515         r.filename = "/var/www/home.lua"
1516         return apache2.OK
1517     else
1518         return apache2.DECLINED
1519     end
1520 end</pre>
1521
1522
1523    <div class="note"><h3>Context</h3><p>This directive is not valid in <code class="directive"><a href="../mod/core.html#directory">&lt;Directory&gt;</a></code>, <code class="directive"><a href="../mod/core.html#files">&lt;Files&gt;</a></code>, or htaccess
1524    context.</p></div>
1525
1526    <div class="note"><h3>Ordering</h3><p>The optional arguments "early" or "late"
1527    control when this script runs relative to other modules.</p></div>
1528
1529
1530 </div>
1531 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1532 <div class="directive-section"><h2><a name="LuaHookTypeChecker" id="LuaHookTypeChecker">LuaHookTypeChecker</a> <a name="luahooktypechecker" id="luahooktypechecker">Directive</a></h2>
1533 <table class="directive">
1534 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Provide a hook for the type_checker phase of request processing</td></tr>
1535 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaHookTypeChecker  /path/to/lua/script.lua hook_function_name</code></td></tr>
1536 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1537 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1538 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1539 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1540 </table><p>
1541     This directive provides a hook for the type_checker phase of the request processing.
1542     This phase is where requests are assigned a content type and a handler, and thus can
1543     be used to modify the type and handler based on input:
1544     </p>
1545     <pre class="prettyprint lang-config">LuaHookTypeChecker /path/to/lua/script.lua type_checker</pre>
1546
1547     <pre class="prettyprint lang-lua">    function type_checker(r)
1548         if r.uri:match("%.to_gif$") then -- match foo.png.to_gif
1549             r.content_type = "image/gif" -- assign it the image/gif type
1550             r.handler = "gifWizard"      -- tell the gifWizard module to handle this
1551             r.filename = r.uri:gsub("%.to_gif$", "") -- fix the filename requested
1552             return apache2.OK
1553         end
1554
1555         return apache2.DECLINED
1556     end</pre>
1557
1558
1559 </div>
1560 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1561 <div class="directive-section"><h2><a name="LuaInherit" id="LuaInherit">LuaInherit</a> <a name="luainherit" id="luainherit">Directive</a></h2>
1562 <table class="directive">
1563 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Controls how parent configuration sections are merged into children</td></tr>
1564 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaInherit none|parent-first|parent-last</code></td></tr>
1565 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LuaInherit parent-first</code></td></tr>
1566 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1567 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1568 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1569 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1570 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>2.4.0 and later</td></tr>
1571 </table><p>By default, if LuaHook* directives are used in overlapping
1572     Directory or Location configuration sections, the scripts defined in the
1573     more specific section are run <em>after</em> those defined in the more
1574     generic section (LuaInherit parent-first).  You can reverse this order, or
1575     make the parent context not apply at all.</p>
1576
1577     <p> In previous 2.3.x releases, the default was effectively to ignore LuaHook*
1578     directives from parent configuration sections.</p>
1579 </div>
1580 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1581 <div class="directive-section"><h2><a name="LuaInputFilter" id="LuaInputFilter">LuaInputFilter</a> <a name="luainputfilter" id="luainputfilter">Directive</a></h2>
1582 <table class="directive">
1583 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Provide a Lua function for content input filtering</td></tr>
1584 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaInputFilter filter_name /path/to/lua/script.lua function_name</code></td></tr>
1585 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
1586 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1587 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1588 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>2.5.0 and later</td></tr>
1589 </table>
1590 <p>Provides a means of adding a Lua function as an input filter.
1591 As with output filters, input filters work as coroutines,
1592 first yielding before buffers are sent, then yielding whenever
1593 a bucket needs to be passed down the chain, and finally (optionally)
1594 yielding anything that needs to be appended to the input data. The
1595 global variable <code>bucket</code> holds the buckets as they are passed
1596 onto the Lua script:
1597 </p>
1598
1599 <pre class="prettyprint lang-config">LuaInputFilter myInputFilter /www/filter.lua input_filter
1600 &lt;FilesMatch "\.lua&gt;
1601   SetInputFilter myInputFilter
1602 &lt;/FilesMatch&gt;</pre>
1603
1604 <pre class="prettyprint lang-lua">--[[
1605     Example input filter that converts all POST data to uppercase.
1606 ]]--
1607 function input_filter(r)
1608     print("luaInputFilter called") -- debug print
1609     coroutine.yield() -- Yield and wait for buckets
1610     while bucket do -- For each bucket, do...
1611         local output = string.upper(bucket) -- Convert all POST data to uppercase
1612         coroutine.yield(output) -- Send converted data down the chain
1613     end
1614     -- No more buckets available.
1615     coroutine.yield("&amp;filterSignature=1234") -- Append signature at the end
1616 end</pre>
1617
1618 <p>
1619 The input filter supports denying/skipping a filter if it is deemed unwanted:
1620 </p>
1621 <pre class="prettyprint lang-lua">function input_filter(r)
1622     if not good then
1623         return -- Simply deny filtering, passing on the original content instead
1624     end
1625     coroutine.yield() -- wait for buckets
1626     ... -- insert filter stuff here
1627 end</pre>
1628
1629 <p>
1630 See "<a href="#modifying_buckets">Modifying contents with Lua
1631 filters</a>" for more information.
1632 </p>
1633
1634 </div>
1635 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1636 <div class="directive-section"><h2><a name="LuaMapHandler" id="LuaMapHandler">LuaMapHandler</a> <a name="luamaphandler" id="luamaphandler">Directive</a></h2>
1637 <table class="directive">
1638 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Map a path to a lua handler</td></tr>
1639 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaMapHandler uri-pattern /path/to/lua/script.lua [function-name]</code></td></tr>
1640 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1641 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1642 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1643 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1644 </table>
1645     <p>This directive matches a uri pattern to invoke a specific
1646     handler function in a specific file. It uses PCRE regular
1647     expressions to match the uri, and supports interpolating
1648     match groups into both the file path and the function name.
1649     Be careful writing your regular expressions to avoid security
1650     issues.</p>
1651    <div class="example"><h3>Examples:</h3><pre class="prettyprint lang-config">LuaMapHandler /(\w+)/(\w+) /scripts/$1.lua handle_$2</pre>
1652 </div>
1653         <p>This would match uri's such as /photos/show?id=9
1654         to the file /scripts/photos.lua and invoke the
1655         handler function handle_show on the lua vm after
1656         loading that file.</p>
1657
1658 <pre class="prettyprint lang-config">LuaMapHandler /bingo /scripts/wombat.lua</pre>
1659
1660         <p>This would invoke the "handle" function, which
1661         is the default if no specific function name is
1662         provided.</p>
1663
1664 </div>
1665 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1666 <div class="directive-section"><h2><a name="LuaOutputFilter" id="LuaOutputFilter">LuaOutputFilter</a> <a name="luaoutputfilter" id="luaoutputfilter">Directive</a></h2>
1667 <table class="directive">
1668 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Provide a Lua function for content output filtering</td></tr>
1669 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaOutputFilter filter_name /path/to/lua/script.lua function_name</code></td></tr>
1670 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
1671 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1672 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1673 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>2.5.0 and later</td></tr>
1674 </table>
1675 <p>Provides a means of adding a Lua function as an output filter.
1676 As with input filters, output filters work as coroutines,
1677 first yielding before buffers are sent, then yielding whenever
1678 a bucket needs to be passed down the chain, and finally (optionally)
1679 yielding anything that needs to be appended to the input data. The
1680 global variable <code>bucket</code> holds the buckets as they are passed
1681 onto the Lua script:
1682 </p>
1683
1684 <pre class="prettyprint lang-config">LuaOutputFilter myOutputFilter /www/filter.lua output_filter
1685 &lt;FilesMatch "\.lua&gt;
1686   SetOutputFilter myOutputFilter
1687 &lt;/FilesMatch&gt;</pre>
1688
1689 <pre class="prettyprint lang-lua">--[[
1690     Example output filter that escapes all HTML entities in the output
1691 ]]--
1692 function output_filter(r)
1693     coroutine.yield("(Handled by myOutputFilter)&lt;br/&gt;\n") -- Prepend some data to the output,
1694                                                           -- yield and wait for buckets.
1695     while bucket do -- For each bucket, do...
1696         local output = r:escape_html(bucket) -- Escape all output
1697         coroutine.yield(output) -- Send converted data down the chain
1698     end
1699     -- No more buckets available.
1700 end</pre>
1701
1702 <p>
1703 As with the input filter, the output filter supports denying/skipping a filter
1704 if it is deemed unwanted:
1705 </p>
1706 <pre class="prettyprint lang-lua">function output_filter(r)
1707     if not r.content_type:match("text/html") then
1708         return -- Simply deny filtering, passing on the original content instead
1709     end
1710     coroutine.yield() -- wait for buckets
1711     ... -- insert filter stuff here
1712 end</pre>
1713
1714 <div class="note"><h3>Lua filters with <code class="module"><a href="../mod/mod_filter.html">mod_filter</a></code></h3>
1715 <p> When a Lua filter is used as the underlying provider via the
1716 <code class="directive"><a href="../mod/mod_filter.html#filterprovider">FilterProvider</a></code> directive, filtering
1717 will only work when the <var>filter-name</var> is identical to the <var>provider-name</var>.
1718 </p> </div>
1719
1720 <p>
1721 See "<a href="#modifying_buckets">Modifying contents with Lua filters</a>" for more
1722 information.
1723 </p>
1724
1725
1726 </div>
1727 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1728 <div class="directive-section"><h2><a name="LuaPackageCPath" id="LuaPackageCPath">LuaPackageCPath</a> <a name="luapackagecpath" id="luapackagecpath">Directive</a></h2>
1729 <table class="directive">
1730 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Add a directory to lua's package.cpath</td></tr>
1731 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaPackageCPath /path/to/include/?.soa</code></td></tr>
1732 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1733 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1734 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1735 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1736 </table>
1737     <p>Add a path to lua's shared library search path. Follows the same
1738     conventions as lua. This just munges the package.cpath in the
1739     lua vms.</p>
1740
1741
1742 </div>
1743 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1744 <div class="directive-section"><h2><a name="LuaPackagePath" id="LuaPackagePath">LuaPackagePath</a> <a name="luapackagepath" id="luapackagepath">Directive</a></h2>
1745 <table class="directive">
1746 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Add a directory to lua's package.path</td></tr>
1747 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaPackagePath /path/to/include/?.lua</code></td></tr>
1748 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1749 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1750 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1751 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1752 </table><p>Add a path to lua's module search path. Follows the same
1753     conventions as lua. This just munges the package.path in the
1754     lua vms.</p>
1755
1756     <div class="example"><h3>Examples:</h3><pre class="prettyprint lang-config">LuaPackagePath /scripts/lib/?.lua
1757 LuaPackagePath /scripts/lib/?/init.lua</pre>
1758 </div>
1759
1760 </div>
1761 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1762 <div class="directive-section"><h2><a name="LuaQuickHandler" id="LuaQuickHandler">LuaQuickHandler</a> <a name="luaquickhandler" id="luaquickhandler">Directive</a></h2>
1763 <table class="directive">
1764 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Provide a hook for the quick handler of request processing</td></tr>
1765 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaQuickHandler /path/to/script.lua hook_function_name</code></td></tr>
1766 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1767 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1768 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1769 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1770 </table>
1771     <p>
1772     This phase is run immediately after the request has been mapped to a virtal host,
1773     and can be used to either do some request processing before the other phases kick
1774     in, or to serve a request without the need to translate, map to storage et cetera.
1775     As this phase is run before anything else, directives such as <code class="directive"><a href="../mod/core.html#location">&lt;Location&gt;</a></code> or <code class="directive"><a href="../mod/core.html#directory">&lt;Directory&gt;</a></code> are void in this phase, just as
1776     URIs have not been properly parsed yet.
1777     </p>
1778    <div class="note"><h3>Context</h3><p>This directive is not valid in <code class="directive"><a href="../mod/core.html#directory">&lt;Directory&gt;</a></code>, <code class="directive"><a href="../mod/core.html#files">&lt;Files&gt;</a></code>, or htaccess
1779    context.</p></div>
1780
1781 </div>
1782 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1783 <div class="directive-section"><h2><a name="LuaRoot" id="LuaRoot">LuaRoot</a> <a name="luaroot" id="luaroot">Directive</a></h2>
1784 <table class="directive">
1785 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Specify the base path for resolving relative paths for mod_lua directives</td></tr>
1786 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaRoot /path/to/a/directory</code></td></tr>
1787 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1788 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1789 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1790 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1791 </table>
1792     <p>Specify the base path which will be used to evaluate all
1793     relative paths within mod_lua. If not specified they
1794     will be resolved relative to the current working directory,
1795     which may not always work well for a server.</p>
1796
1797 </div>
1798 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1799 <div class="directive-section"><h2><a name="LuaScope" id="LuaScope">LuaScope</a> <a name="luascope" id="luascope">Directive</a></h2>
1800 <table class="directive">
1801 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>One of once, request, conn, thread -- default is once</td></tr>
1802 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaScope once|request|conn|thread|server [min] [max]</code></td></tr>
1803 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LuaScope once</code></td></tr>
1804 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1805 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1806 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1807 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1808 </table>
1809     <p>Specify the life cycle scope of the Lua interpreter which will
1810     be used by handlers in this "Directory." The default is "once"</p>
1811
1812    <dl>
1813     <dt>once:</dt> <dd>use the interpreter once and throw it away.</dd>
1814
1815     <dt>request:</dt> <dd>use the interpreter to handle anything based on
1816              the same file within this request, which is also
1817              request scoped.</dd>
1818
1819     <dt>conn:</dt> <dd>Same as request but attached to the connection_rec</dd>
1820
1821     <dt>thread:</dt> <dd>Use the interpreter for the lifetime of the thread
1822             handling the request (only available with threaded MPMs).</dd>
1823
1824     <dt>server:</dt>  <dd>This one is different than others because the
1825             server scope is quite long lived, and multiple threads
1826             will have the same server_rec. To accommodate this,
1827             server scoped Lua states are stored in an apr
1828             resource list. The <code>min</code> and <code>max</code> arguments
1829             specify the minimum and maximum number of Lua states to keep in the
1830             pool.</dd>
1831    </dl>
1832     <p>
1833     Generally speaking, the <code>thread</code> and <code>server</code> scopes
1834     execute roughly 2-3 times faster than the rest, because they don't have to
1835     spawn new Lua states on every request (especially with the event MPM, as
1836     even keepalive requests will use a new thread for each request). If you are
1837     satisfied that your scripts will not have problems reusing a state, then
1838     the <code>thread</code> or <code>server</code> scopes should be used for
1839     maximum performance. While the <code>thread</code> scope will provide the
1840     fastest responses, the <code>server</code> scope will use less memory, as
1841     states are pooled, allowing f.x. 1000 threads to share only 100 Lua states,
1842     thus using only 10% of the memory required by the <code>thread</code> scope.
1843     </p>
1844
1845 </div>
1846 </div>
1847 <div class="bottomlang">
1848 <p><span>Available Languages: </span><a href="../en/mod/mod_lua.html" title="English">&nbsp;en&nbsp;</a> |
1849 <a href="../fr/mod/mod_lua.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a></p>
1850 </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&amp;A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
1851 <script type="text/javascript"><!--//--><![CDATA[//><!--
1852 var comments_shortname = 'httpd';
1853 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_lua.html';
1854 (function(w, d) {
1855     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
1856         d.write('<div id="comments_thread"><\/div>');
1857         var s = d.createElement('script');
1858         s.type = 'text/javascript';
1859         s.async = true;
1860         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
1861         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
1862     }
1863     else {
1864         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
1865     }
1866 })(window, document);
1867 //--><!]]></script></div><div id="footer">
1868 <p class="apache">Copyright 2014 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
1869 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
1870 if (typeof(prettyPrint) !== 'undefined') {
1871     prettyPrint();
1872 }
1873 //--><!]]></script>
1874 </body></html>