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.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="#luahookmaptostorage">LuaHookMapToStorage</a></li>
  71 <li><img alt="" src="../images/down.gif" /> <a href="#luahooktranslatename">LuaHookTranslateName</a></li>
  72 <li><img alt="" src="../images/down.gif" /> <a href="#luahooktypechecker">LuaHookTypeChecker</a></li>
  73 <li><img alt="" src="../images/down.gif" /> <a href="#luainherit">LuaInherit</a></li>
  74 <li><img alt="" src="../images/down.gif" /> <a href="#luainputfilter">LuaInputFilter</a></li>
  75 <li><img alt="" src="../images/down.gif" /> <a href="#luamaphandler">LuaMapHandler</a></li>
  76 <li><img alt="" src="../images/down.gif" /> <a href="#luaoutputfilter">LuaOutputFilter</a></li>
  77 <li><img alt="" src="../images/down.gif" /> <a href="#luapackagecpath">LuaPackageCPath</a></li>
  78 <li><img alt="" src="../images/down.gif" /> <a href="#luapackagepath">LuaPackagePath</a></li>
  79 <li><img alt="" src="../images/down.gif" /> <a href="#luaquickhandler">LuaQuickHandler</a></li>
  80 <li><img alt="" src="../images/down.gif" /> <a href="#luaroot">LuaRoot</a></li>
  81 <li><img alt="" src="../images/down.gif" /> <a href="#luascope">LuaScope</a></li>
  82 </ul>
  83 <h3>Topics</h3>
  84 <ul id="topics">
  85 <li><img alt="" src="../images/down.gif" /> <a href="#basicconf">Basic Configuration</a></li>
  86 <li><img alt="" src="../images/down.gif" /> <a href="#writinghandlers">Writing Handlers</a></li>
  87 <li><img alt="" src="../images/down.gif" /> <a href="#writingauthzproviders">Writing Authorization Providers</a></li>
  88 <li><img alt="" src="../images/down.gif" /> <a href="#writinghooks">Writing Hooks</a></li>
  89 <li><img alt="" src="../images/down.gif" /> <a href="#datastructures">Data Structures</a></li>
  90 <li><img alt="" src="../images/down.gif" /> <a href="#functions">Built in functions</a></li>
  91 <li><img alt="" src="../images/down.gif" /> <a href="#logging">Logging Functions</a></li>
  92 <li><img alt="" src="../images/down.gif" /> <a href="#apache2">apache2 Package</a></li>
  93 <li><img alt="" src="../images/down.gif" /> <a href="#modifying_buckets">Modifying contents with Lua filters</a></li>
  94 <li><img alt="" src="../images/down.gif" /> <a href="#databases">Database connectivity</a></li>
  95 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
  96 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  97 <div class="section">
  98 <h2><a name="basicconf" id="basicconf">Basic Configuration</a></h2>
  99
 100 <p>The basic module loading directive is</p>
 101
 102 <pre class="prettyprint lang-config">
 103     LoadModule lua_module modules/mod_lua.so
 104 </pre>
 105
 106
 107 <p>
 108 <code>mod_lua</code> provides a handler named <code>lua-script</code>,
 109 which can be used with an <code>AddHandler</code> directive:</p>
 110
 111 <pre class="prettyprint lang-config">
 112 AddHandler lua-script .lua
 113 </pre>
 114
 115
 116 <p>
 117 This will cause <code>mod_lua</code> to handle requests for files
 118 ending in <code>.lua</code> by invoking that file's
 119 <code>handle</code> function.
 120 </p>
 121
 122 <p>For more flexibility, see <code class="directive">LuaMapHandler</code>.
 123 </p>
 124
 125 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 126 <div class="section">
 127 <h2><a name="writinghandlers" id="writinghandlers">Writing Handlers</a></h2>
 128 <p> In the Apache HTTP Server API, the handler is a specific kind of hook
 129 responsible for generating the response.  Examples of modules that include a
 130 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>,
 131 and <code class="module"><a href="../mod/mod_status.html">mod_status</a></code>.</p>
 132
 133 <p><code>mod_lua</code> always looks to invoke a Lua function for the handler, rather than
 134 just evaluating a script body CGI style. A handler function looks
 135 something like this:</p>
 136
 137
 138 <pre class="prettyprint lang-lua">
 139 <strong>example.lua</strong><br />
 140 -- example handler
 141
 142 require "string"
 143
 144 --[[
 145      This is the default method name for Lua handlers, see the optional
 146      function-name in the LuaMapHandler directive to choose a different
 147      entry point.
 148 --]]
 149 function handle(r)
 150     r.content_type = "text/plain"
 151     r:puts("Hello Lua World!\n")
 152
 153     if r.method == 'GET' then
 154         for k, v in pairs( r:parseargs() ) do
 155             r:puts( string.format("%s: %s\n", k, v) )
 156         end
 157     elseif r.method == 'POST' then
 158         for k, v in pairs( r:parsebody() ) do
 159             r:puts( string.format("%s: %s\n", k, v) )
 160         end
 161     else
 162         r:puts("Unsupported HTTP method " .. r.method)
 163     end
 164 end
 165 </pre>
 166
 167
 168 <p>
 169 This handler function just prints out the uri or form encoded
 170 arguments to a plaintext page.
 171 </p>
 172
 173 <p>
 174 This means (and in fact encourages) that you can have multiple
 175 handlers (or hooks, or filters) in the same script.
 176 </p>
 177
 178 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 179 <div class="section">
 180 <h2><a name="writingauthzproviders" id="writingauthzproviders">Writing Authorization Providers</a></h2>
 181
 182
 183 <p><code class="module"><a href="../mod/mod_authz_core.html">mod_authz_core</a></code> provides a high-level interface to
 184 authorization that is much easier to use than using into the relevant
 185 hooks directly. The first argument to the
 186 <code class="directive"><a href="../mod/mod_authz_core.html#require">Require</a></code> directive gives
 187 the name of the responsible authorization provider. For any
 188 <code class="directive"><a href="../mod/mod_authz_core.html#require">Require</a></code> line,
 189 <code class="module"><a href="../mod/mod_authz_core.html">mod_authz_core</a></code> will call the authorization provider
 190 of the given name, passing the rest of the line as parameters. The
 191 provider will then check authorization and pass the result as return
 192 value.</p>
 193
 194 <p>The authz provider is normally called before authentication. If it needs to
 195 know the authenticated user name (or if the user will be authenticated at
 196 all), the provider must return <code>apache2.AUTHZ_DENIED_NO_USER</code>.
 197 This will cause authentication to proceed and the authz provider to be
 198 called a second time.</p>
 199
 200 <p>The following authz provider function takes two arguments, one ip
 201 address and one user name. It will allow access from the given ip address
 202 without authentication, or if the authenticated user matches the second
 203 argument:</p>
 204
 205 <pre class="prettyprint lang-lua">
 206 <strong>authz_provider.lua</strong><br />
 207
 208 require 'apache2'
 209
 210 function authz_check_foo(r, ip, user)
 211     if r.useragent_ip == ip then
 212         return apache2.AUTHZ_GRANTED
 213     elseif r.user == nil then
 214         return apache2.AUTHZ_DENIED_NO_USER
 215     elseif r.user == user then
 216         return apache2.AUTHZ_GRANTED
 217     else
 218         return apache2.AUTHZ_DENIED
 219     end
 220 end
 221 </pre>
 222
 223
 224 <p>The following configuration registers this function as provider
 225 <code>foo</code> and configures it for URL <code>/</code>:</p>
 226 <pre class="prettyprint lang-config">
 227 LuaAuthzProvider foo authz_provider.lua authz_check_foo
 228 &lt;Location /&gt;
 229   Require foo 10.1.2.3 john_doe
 230 &lt;/Location&gt;
 231 </pre>
 232
 233
 234 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 235 <div class="section">
 236 <h2><a name="writinghooks" id="writinghooks">Writing Hooks</a></h2>
 237
 238 <p>Hook functions are how modules (and Lua scripts) participate in the
 239 processing of requests. Each type of hook exposed by the server exists for
 240 a specific purpose, such as mapping requests to the filesystem,
 241 performing access control, or setting mimetypes:</p>
 242
 243 <table class="bordered"><tr class="header">
 244         <th>Hook phase</th>
 245         <th>mod_lua directive</th>
 246         <th>Description</th>
 247     </tr>
 248 <tr>
 249         <td>Quick handler</td>
 250         <td><code class="directive"><a href="#luaquickhandler">LuaQuickHandler</a></code></td>
 251         <td>This is the first hook that will be called after a request has
 252             been mapped to a host or virtual host</td>
 253     </tr>
 254 <tr class="odd">
 255         <td>Translate name</td>
 256         <td><code class="directive"><a href="#luahooktranslatename">LuaHookTranslateName</a></code></td>
 257         <td>This phase translates the requested URI into a filename on the
 258             system. Modules such as <code class="module"><a href="../mod/mod_alias.html">mod_alias</a></code> and
 259             <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> operate in this phase.</td>
 260     </tr>
 261 <tr>
 262         <td>Map to storage</td>
 263         <td><code class="directive"><a href="#luahookmaptostorage">LuaHookMapToStorage</a></code></td>
 264         <td>This phase maps files to their physical, cached or external/proxied storage.
 265             It can be used by proxy or caching modules</td>
 266     </tr>
 267 <tr class="odd">
 268         <td>Check Access</td>
 269         <td><code class="directive"><a href="#luahookaccesschecker">LuaHookAccessChecker</a></code></td>
 270         <td>This phase checks whether a client has access to a resource. This
 271             phase is run before the user is authenticated, so beware.
 272         </td>
 273     </tr>
 274 <tr>
 275         <td>Check User ID</td>
 276         <td><code class="directive"><a href="#luahookcheckuserid">LuaHookCheckUserID</a></code></td>
 277         <td>This phase it used to check the negotiated user ID</td>
 278     </tr>
 279 <tr class="odd">
 280         <td>Check Authorization</td>
 281         <td><code class="directive"><a href="#luahookauthchecker">LuaHookAuthChecker</a></code> or
 282             <code class="directive"><a href="#luaauthzprovider">LuaAuthzProvider</a></code></td>
 283         <td>This phase authorizes a user based on the negotiated credentials, such as
 284             user ID, client certificate etc.
 285         </td>
 286     </tr>
 287 <tr>
 288         <td>Check Type</td>
 289         <td><code class="directive"><a href="#luahooktypechecker">LuaHookTypeChecker</a></code></td>
 290         <td>This phase checks the requested file and assigns a content type and
 291             a handler to it</td>
 292     </tr>
 293 <tr class="odd">
 294         <td>Fixups</td>
 295         <td><code class="directive"><a href="#luahookfixups">LuaHookFixups</a></code></td>
 296         <td>This is the final "fix anything" phase before the content handlers
 297             are run. Any last-minute changes to the request should be made here.</td>
 298     </tr>
 299 <tr>
 300         <td>Content handler</td>
 301         <td>fx. <code>.lua</code> files or through <code class="directive"><a href="#luamaphandler">LuaMapHandler</a></code></td>
 302         <td>This is where the content is handled. Files are read, parsed, some are run,
 303             and the result is sent to the client</td>
 304     </tr>
 305 <tr class="odd">
 306         <td>Logging</td>
 307         <td>(none)</td>
 308         <td>Once a request has been handled, it enters several logging phases,
 309             which logs the request in either the error or access log</td>
 310     </tr>
 311 </table>
 312
 313 <p>Hook functions are passed the request object as their only argument
 314 (except for LuaAuthzProvider, which also gets passed the arguments from
 315 the Require directive).
 316 They can return any value, depending on the hook, but most commonly
 317 they'll return OK, DONE, or DECLINED, which you can write in lua as
 318 <code>apache2.OK</code>, <code>apache2.DONE</code>, or
 319 <code>apache2.DECLINED</code>, or else an HTTP status code.</p>
 320
 321
 322 <pre class="prettyprint lang-lua">
 323 <strong>translate_name.lua</strong><br />
 324 -- example hook that rewrites the URI to a filesystem path.
 325
 326 require 'apache2'
 327
 328 function translate_name(r)
 329     if r.uri == "/translate-name" then
 330         r.filename = r.document_root .. "/find_me.txt"
 331         return apache2.OK
 332     end
 333     -- we don't care about this URL, give another module a chance
 334     return apache2.DECLINED
 335 end
 336 </pre>
 337
 338
 339
 340 <pre class="prettyprint lang-lua">
 341 <strong>translate_name2.lua</strong><br />
 342 --[[ example hook that rewrites one URI to another URI. It returns a
 343      apache2.DECLINED to give other URL mappers a chance to work on the
 344      substitution, including the core translate_name hook which maps based
 345      on the DocumentRoot.
 346
 347      Note: Use the early/late flags in the directive to make it run before
 348            or after mod_alias.
 349 --]]
 350
 351 require 'apache2'
 352
 353 function translate_name(r)
 354     if r.uri == "/translate-name" then
 355         r.uri = "/find_me.txt"
 356         return apache2.DECLINED
 357     end
 358     return apache2.DECLINED
 359 end
 360 </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 writeable 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">
 663 r:flush() -- flushes the output buffer:
 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:sleep(0.5) -- fake processing time and repeat
 669 end
 670 </pre>
 671
 672
 673 <pre class="prettyprint lang-lua">
 674 r:addoutputfilter(name|function) -- add an output filter:
 675
 676 r:addoutputfilter("fooFilter") -- add the fooFilter to the output stream
 677 </pre>
 678
 679
 680 <pre class="prettyprint lang-lua">
 681 r:sendfile(filename) -- sends an entire file to the client, using sendfile if supported by the current platform:
 682
 683 if use_sendfile_thing then
 684     r:sendfile("/var/www/large_file.img")
 685 end
 686 </pre>
 687
 688
 689 <pre class="prettyprint lang-lua">
 690 r:parseargs() -- returns a Lua table containing the request's query string arguments:
 691
 692 local GET = r:parseargs()
 693 r:puts("Your name is: " .. GET['name'] or "Unknown")
 694 </pre>
 695
 696
 697 <pre class="prettyprint lang-lua">
 698 r:parsebody([sizeLimit]) -- parse the request body as a POST and return a lua table.
 699                  -- An optional number may be passed to specify the maximum number
 700                  -- of bytes to parse. Default is 8192 bytes:
 701
 702 local POST = r:parsebody(1024*1024)
 703 r:puts("Your name is: " .. POST['name'] or "Unknown")
 704 </pre>
 705
 706
 707 <pre class="prettyprint lang-lua">
 708 r:puts("hello", " world", "!") -- print to response body, self explanatory
 709 </pre>
 710
 711
 712 <pre class="prettyprint lang-lua">
 713 r:write("a single string") -- print to response body, self explanatory
 714 </pre>
 715
 716
 717 <pre class="prettyprint lang-lua">
 718 r:escape_html("&lt;html&gt;test&lt;/html&gt;") -- Escapes HTML code and returns the escaped result
 719 </pre>
 720
 721
 722 <pre class="prettyprint lang-lua">
 723 r:base64_encode(string) -- Encodes a string using the Base64 encoding standard:
 724
 725 local encoded = r:base64_encode("This is a test") -- returns VGhpcyBpcyBhIHRlc3Q=
 726 </pre>
 727
 728
 729 <pre class="prettyprint lang-lua">
 730 r:base64_decode(string) -- Decodes a Base64-encoded string:
 731
 732 local decoded = r:base64_decode("VGhpcyBpcyBhIHRlc3Q=") -- returns 'This is a test'
 733 </pre>
 734
 735
 736 <pre class="prettyprint lang-lua">
 737 r:md5(string) -- Calculates and returns the MD5 digest of a string (binary safe):
 738
 739 local hash = r:md5("This is a test") -- returns ce114e4501d2f4e2dcea3e17b546f339
 740 </pre>
 741
 742
 743 <pre class="prettyprint lang-lua">
 744 r:sha1(string) -- Calculates and returns the SHA1 digest of a string (binary safe):
 745
 746 local hash = r:sha1("This is a test") -- returns a54d88e06612d820bc3be72877c74f257b561b19
 747 </pre>
 748
 749
 750 <pre class="prettyprint lang-lua">
 751 r:escape(string) -- URL-Escapes a string:
 752
 753 local url = "http://foo.bar/1 2 3 &amp; 4 + 5"
 754 local escaped = r:escape(url) -- returns 'http%3a%2f%2ffoo.bar%2f1+2+3+%26+4+%2b+5'
 755 </pre>
 756
 757
 758 <pre class="prettyprint lang-lua">
 759 r:unescape(string) -- Unescapes an URL-escaped string:
 760
 761 local url = "http%3a%2f%2ffoo.bar%2f1+2+3+%26+4+%2b+5"
 762 local unescaped = r:escape(url) -- returns 'http://foo.bar/1 2 3 &amp; 4 + 5'
 763 </pre>
 764
 765
 766 <pre class="prettyprint lang-lua">
 767 r:mpm_query(number) -- Queries the server for MPM information using ap_mpm_query:
 768
 769 local mpm = r.mpm_query(14)
 770 if mpm == 1 then
 771     r:puts("This server uses the Event MPM")
 772 end
 773 </pre>
 774
 775
 776 <pre class="prettyprint lang-lua">
 777 r:expr(string) -- Evaluates an <a href="../expr.html">expr</a> string.
 778
 779 if r:expr("%{HTTP_HOST} =~ /^www/") then
 780     r:puts("This host name starts with www")
 781 end
 782 </pre>
 783
 784
 785 <pre class="prettyprint lang-lua">
 786 r:scoreboard_process(a) -- Queries the server for information about the process at position <code>a</code>:
 787
 788 local process = r:scoreboard_process(1)
 789 r:puts("Server 1 has PID " .. process.pid)
 790 </pre>
 791
 792
 793 <pre class="prettyprint lang-lua">
 794 r:scoreboard_worker(a, b) -- Queries for information about the worker thread, <code>b</code>, in process <code>a</code>:
 795
 796 local thread = r:scoreboard_worker(1, 1)
 797 r:puts("Server 1's thread 1 has thread ID " .. thread.tid .. " and is in " .. thread.status .. " status")
 798 </pre>
 799
 800
 801 <pre class="prettyprint lang-lua">
 802 r:started() -- Returns the time of the last server (re)start
 803 </pre>
 804
 805
 806 <pre class="prettyprint lang-lua">
 807 r:clock() -- Returns the current time with microsecond precision
 808 </pre>
 809
 810
 811 <pre class="prettyprint lang-lua">
 812 r:requestbody(filename) -- Reads and returns the request body of a request.
 813                 -- If 'filename' is specified, it instead saves the
 814                 -- contents to that file:
 815
 816 local input = r:requestbody()
 817 r:puts("You sent the following request body to me:\n")
 818 r:puts(input)
 819 </pre>
 820
 821
 822 <pre class="prettyprint lang-lua">
 823 r:add_input_filter(filter_name) -- Adds 'filter_name' as an input filter
 824 </pre>
 825
 826
 827 <pre class="prettyprint lang-lua">
 828 r.module_info(module_name) -- Queries the server for information about a module
 829
 830 local mod = r.module_info("mod_lua.c")
 831 if mod then
 832     for k, v in pairs(mod.commands) do
 833        r:puts( ("%s: %s\n"):format(k,v)) -- print out all directives accepted by this module
 834     end
 835 end
 836 </pre>
 837
 838
 839 <pre class="prettyprint lang-lua">
 840 r:loaded_modules() -- Returns a list of modules loaded by httpd:
 841
 842 for k, module in pairs(r:loaded_modules()) do
 843     r:puts("I have loaded module " .. module .. "\n")
 844 end
 845 </pre>
 846
 847
 848 <pre class="prettyprint lang-lua">
 849 r:runtime_dir_relative(filename) -- Compute the name of a run-time file (e.g., shared memory "file")
 850                          -- relative to the appropriate run-time directory.
 851 </pre>
 852
 853
 854 <pre class="prettyprint lang-lua">
 855 r:server_info() -- Returns a table containing server information, such as
 856                 -- the name of the httpd executable file, mpm used etc.
 857 </pre>
 858
 859
 860 <pre class="prettyprint lang-lua">
 861 r:set_document_root(file_path) -- Sets the document root for the request to file_path
 862 </pre>
 863
 864
 865
 866
 867 <pre class="prettyprint lang-lua">
 868 r:set_context_info(prefix, docroot) -- Sets the context prefix and context document root for a request
 869 </pre>
 870
 871
 872 <pre class="prettyprint lang-lua">
 873 r:os_escape_path(file_path) -- Converts an OS path to a URL in an OS dependant way
 874 </pre>
 875
 876
 877 <pre class="prettyprint lang-lua">
 878 r:escape_logitem(string) -- Escapes a string for logging
 879 </pre>
 880
 881
 882 <pre class="prettyprint lang-lua">
 883 r:strcmp_match(string, pattern) -- Checks if 'string' matches 'pattern' using strcmp_match (globs).
 884                         -- fx. whether 'www.example.com' matches '*.example.com':
 885
 886 local match = r:strcmp_match("foobar.com", "foo*.com")
 887 if match then
 888     r:puts("foobar.com matches foo*.com")
 889 end
 890 </pre>
 891
 892
 893 <pre class="prettyprint lang-lua">
 894 r:set_keepalive() -- Sets the keepalive status for a request. Returns true if possible, false otherwise.
 895 </pre>
 896
 897
 898 <pre class="prettyprint lang-lua">
 899 r:make_etag() -- Constructs and returns the etag for the current request.
 900 </pre>
 901
 902
 903 <pre class="prettyprint lang-lua">
 904 r:send_interim_response(clear) -- Sends an interim (1xx) response to the client.
 905                        -- if 'clear' is true, available headers will be sent and cleared.
 906 </pre>
 907
 908
 909 <pre class="prettyprint lang-lua">
 910 r:custom_response(status_code, string) -- Construct and set a custom response for a given status code.
 911                                -- This works much like the ErrorDocument directive:
 912
 913 r:custom_response(404, "Baleted!")
 914 </pre>
 915
 916
 917 <pre class="prettyprint lang-lua">
 918 r:exists_config_define(string) -- Checks whether a configuration definition exists or not:
 919
 920 if r:exists_config_define("FOO") then
 921     r:puts("httpd was probably run with -DFOO, or it was defined in the configuration")
 922 end
 923 </pre>
 924
 925
 926 <pre class="prettyprint lang-lua">
 927 r:state_query(string) -- Queries the server for state information
 928 </pre>
 929
 930
 931 <pre class="prettyprint lang-lua">
 932 r:stat(filename) -- Runs stat() on a file, and returns a table with file information:
 933
 934 local info = r:stat("/var/www/foo.txt")
 935 if info then
 936     r:puts("This file exists and was last modified at: " .. info.modified)
 937 end
 938 </pre>
 939
 940
 941 <pre class="prettyprint lang-lua">
 942 r:regex(string, pattern, [flags]) -- Runs a regular expression match on a string, returning captures if matched:
 943
 944 local matches = r:regex("foo bar baz", [[foo (\w+) (\S*)]])
 945 if matches then
 946     r:puts("The regex matched, and the last word captured ($2) was: " .. matches[2])
 947 end
 948
 949 -- Example ignoring case sensitivity:
 950 local matches = r:regex("FOO bar BAz", [[(foo) bar]], 1)
 951
 952 -- Flags can be a bitwise combination of:
 953 -- 0x01: Ignore case
 954 -- 0x02: Multiline search
 955 </pre>
 956
 957
 958 <pre class="prettyprint lang-lua">
 959 r:sleep(number_of_seconds) -- Puts the script to sleep for a given number of seconds.
 960                    -- This can be a floating point number like 1.25 for extra accuracy.
 961 </pre>
 962
 963
 964 <pre class="prettyprint lang-lua">
 965 r:dbacquire(dbType[, dbParams]) -- Acquires a connection to a database and returns a database class.
 966                         -- See '<a href="#databases">Database connectivity</a>' for details.
 967 </pre>
 968
 969
 970
 971 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 972 <div class="section">
 973 <h2><a name="logging" id="logging">Logging Functions</a></h2>
 974
 975 <pre class="prettyprint lang-lua">
 976         -- examples of logging messages<br />
 977         r:trace1("This is a trace log message") -- trace1 through trace8 can be used <br />
 978         r:debug("This is a debug log message")<br />
 979         r:info("This is an info log message")<br />
 980         r:notice("This is a notice log message")<br />
 981         r:warn("This is a warn log message")<br />
 982         r:err("This is an err log message")<br />
 983         r:alert("This is an alert log message")<br />
 984         r:crit("This is a crit log message")<br />
 985         r:emerg("This is an emerg log message")<br />
 986 </pre>
 987
 988
 989 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 990 <div class="section">
 991 <h2><a name="apache2" id="apache2">apache2 Package</a></h2>
 992 <p>A package named <code>apache2</code> is available with (at least) the following contents.</p>
 993 <dl>
 994   <dt>apache2.OK</dt>
 995   <dd>internal constant OK.  Handlers should return this if they've
 996   handled the request.</dd>
 997   <dt>apache2.DECLINED</dt>
 998   <dd>internal constant DECLINED.  Handlers should return this if
 999   they are not going to handle the request.</dd>
1000   <dt>apache2.DONE</dt>
1001   <dd>internal constant DONE.</dd>
1002   <dt>apache2.version</dt>
1003   <dd>Apache HTTP server version string</dd>
1004   <dt>apache2.HTTP_MOVED_TEMPORARILY</dt>
1005   <dd>HTTP status code</dd>
1006   <dt>apache2.PROXYREQ_NONE, apache2.PROXYREQ_PROXY, apache2.PROXYREQ_REVERSE, apache2.PROXYREQ_RESPONSE</dt>
1007   <dd>internal constants used by <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code></dd>
1008   <dt>apache2.AUTHZ_DENIED, apache2.AUTHZ_GRANTED, apache2.AUTHZ_NEUTRAL, apache2.AUTHZ_GENERAL_ERROR, apache2.AUTHZ_DENIED_NO_USER</dt>
1009   <dd>internal constants used by <code class="module"><a href="../mod/mod_authz_core.html">mod_authz_core</a></code></dd>
1010
1011 </dl>
1012 <p>(Other HTTP status codes are not yet implemented.)</p>
1013 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1014 <div class="section">
1015 <h2><a name="modifying_buckets" id="modifying_buckets">Modifying contents with Lua filters</a></h2>
1016
1017     <p>
1018     Filter functions implemented via <code class="directive"><a href="#luainputfilter">LuaInputFilter</a></code>
1019     or <code class="directive"><a href="#luaoutputfilter">LuaOutputFilter</a></code> are designed as
1020     three-stage non-blocking functions using coroutines to suspend and resume a
1021     function as buckets are sent down the filter chain. The core structure of
1022     such a function is:
1023     </p>
1024     <pre class="prettyprint lang-lua">
1025 function filter(r)
1026     -- Our first yield is to signal that we are ready to receive buckets.
1027     -- Before this yield, we can set up our environment, check for conditions,
1028     -- and, if we deem it necessary, decline filtering a request alltogether:
1029     if something_bad then
1030         return -- This would skip this filter.
1031     end
1032     -- Regardless of whether we have data to prepend, a yield MUST be called here.
1033     -- Note that only output filters can prepend data. Input filters must use the
1034     -- final stage to append data to the content.
1035     coroutine.yield([optional header to be prepended to the content])
1036
1037     -- After we have yielded, buckets will be sent to us, one by one, and we can
1038     -- do whatever we want with them and then pass on the result.
1039     -- Buckets are stored in the global variable 'bucket', so we create a loop
1040     -- that checks if 'bucket' is not nil:
1041     while bucket ~= nil do
1042         local output = mangle(bucket) -- Do some stuff to the content
1043         coroutine.yield(output) -- Return our new content to the filter chain
1044     end
1045
1046     -- Once the buckets are gone, 'bucket' is set to nil, which will exit the
1047     -- loop and land us here. Anything extra we want to append to the content
1048     -- can be done by doing a final yield here. Both input and output filters
1049     -- can append data to the content in this phase.
1050     coroutine.yield([optional footer to be appended to the content])
1051 end
1052     </pre>
1053
1054 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1055 <div class="section">
1056 <h2><a name="databases" id="databases">Database connectivity</a></h2>
1057
1058     <p>
1059     Mod_lua implements a simple database feature for querying and running commands
1060     on the most popular database engines (mySQL, PostgreSQL, FreeTDS, ODBC, SQLite, Oracle)
1061     as well as mod_dbd.
1062     </p>
1063     <p>The example below shows how to acquire a database handle and return information from a table:</p>
1064     <pre class="prettyprint lang-lua">
1065 function handle(r)
1066     -- Acquire a database handle
1067     local database, err = r:dbacquire("mysql", "server=localhost,user=root,dbname=mydb")
1068     if not err then
1069         -- Select some information from it
1070         local results, err = database:select(r, "SELECT `name`, `age` FROM `people` WHERE 1")
1071         if not err then
1072             local rows = results(0) -- fetch all rows synchronously
1073             for k, row in pairs(rows) do
1074                 r:puts( string.format("Name: %s, Age: %s&lt;br/&gt;", row[1], row[2]) )
1075             end
1076         else
1077             r:puts("Database query error: " .. err)
1078         end
1079         database:close()
1080     else
1081         r:puts("Could not connect to the database: " .. err)
1082     end
1083 end
1084     </pre>
1085
1086     <p>
1087     To utilize <code class="module"><a href="../mod/mod_dbd.html">mod_dbd</a></code>, specify <code>mod_dbd</code>
1088     as the database type, or leave the field blank:
1089     </p>
1090     <pre class="prettyprint lang-lua">
1091     local database = r:dbacquire("mod_dbd")
1092     </pre>
1093
1094     <h3><a name="database_object" id="database_object">Database object and contained functions</a></h3>
1095
1096         <p>The database object returned by <code>dbacquire</code> has the following methods:</p>
1097         <p><strong>Normal select and query from a database:</strong></p>
1098     <pre class="prettyprint lang-lua">
1099 -- Run a statement and return the number of rows affected:
1100 local affected, errmsg = database:query(r, "DELETE FROM `tbl` WHERE 1")
1101
1102 -- Run a statement and return a result set that can be used synchronously or async:
1103 local result, errmsg = database:select(r, "SELECT * FROM `people` WHERE 1")
1104     </pre>
1105
1106         <p><strong>Using prepared statements (recommended):</strong></p>
1107     <pre class="prettyprint lang-lua">
1108 -- Create and run a prepared statement:
1109 local statement, errmsg = database:prepare(r, "DELETE FROM `tbl` WHERE `age` &gt; %u")
1110 if not errmsg then
1111     local result, errmsg = statement:query(20) -- run the statement with age &gt; 20
1112 end
1113
1114 -- Fetch a prepared statement from a DBDPrepareSQL directive:
1115 local statement, errmsg = database:prepared(r, "someTag")
1116 if not errmsg then
1117     local result, errmsg = statement:select("John Doe", 123) -- inject the values "John Doe" and 123 into the statement
1118 end
1119
1120 </pre>
1121
1122         <p><strong>Escaping values, closing databases etc:</strong></p>
1123     <pre class="prettyprint lang-lua">
1124 -- Escape a value for use in a statement:
1125 local escaped = database:escape(r, [["'|blabla]])
1126
1127 -- Close a database connection and free up handles:
1128 database:close()
1129
1130 -- Check whether a database connection is up and running:
1131 local connected = database:active()
1132     </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">
1145 -- fetch a result set using a regular query:
1146 local result, err = db:select(r, "SELECT * FROM `tbl` WHERE 1")
1147
1148 local rows = result(0) -- Fetch ALL rows synchronously
1149 local row = result(-1) -- Fetch the next available row, asynchronously
1150 local row = result(1234) -- Fetch row number 1234, asynchronously
1151     </pre>
1152
1153     <p>One can construct a function that returns an iterative function to iterate over all rows
1154     in a synchronous or asynchronous way, depending on the async argument:
1155     </p>
1156     <pre class="prettyprint lang-lua">
1157 function rows(resultset, async)
1158     local a = 0
1159     local function getnext()
1160         a = a + 1
1161         local row = resultset(-1)
1162         return row and a or nil, row
1163     end
1164     if not async then
1165         return pairs(resultset(0))
1166     else
1167         return getnext, self
1168     end
1169 end
1170
1171 local statement, err = db:prepare(r, "SELECT * FROM `tbl` WHERE `age` &gt; %u")
1172 if not err then
1173      -- fetch rows asynchronously:
1174     local result, err = statement:select(20)
1175     if not err then
1176         for index, row in rows(result, true) do
1177             ....
1178         end
1179     end
1180
1181      -- fetch rows synchronously:
1182     local result, err = statement:select(20)
1183     if not err then
1184         for index, row in rows(result, false) do
1185             ....
1186         end
1187     end
1188 end
1189     </pre>
1190
1191
1192     <h3><a name="closing_databases" id="closing_databases">Closing a database connection</a></h3>
1193
1194
1195     <p>Database handles should be closed using <code>database:close()</code> when they are no longer
1196     needed. If you do not close them manually, they will eventually be garbage collected and
1197     closed by mod_lua, but you may end up having too many unused connections to the database
1198     if you leave the closing up to mod_lua. Essentially, the following two measures are
1199     the same:
1200     </p>
1201     <pre class="prettyprint lang-lua">
1202 -- Method 1: Manually close a handle
1203 local database = r:dbacquire("mod_dbd")
1204 database:close() -- All done
1205
1206 -- Method 2: Letting the garbage collector close it
1207 local database = r:dbacquire("mod_dbd")
1208 database = nil -- throw away the reference
1209 collectgarbage() -- close the handle via GC
1210 </pre>
1211
1212
1213     <h3><a name="database_caveat" id="database_caveat">Precautions when working with databases</a></h3>
1214
1215     <p>Although the standard <code>query</code> and <code>run</code> functions are freely
1216     available, it is recommended that you use prepared statements whenever possible, to
1217     both optimize performance (if your db handle lives on for a long time) and to minimize
1218     the risk of SQL injection attacks. <code>run</code> and <code>query</code> should only
1219     be used when there are no variables inserted into a statement (a static statement).
1220     When using dynamic statements, use <code>db:prepare</code> or <code>db:prepared</code>.
1221     </p>
1222
1223
1224 </div>
1225 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1226 <div class="directive-section"><h2><a name="LuaAuthzProvider" id="LuaAuthzProvider">LuaAuthzProvider</a> <a name="luaauthzprovider" id="luaauthzprovider">Directive</a></h2>
1227 <table class="directive">
1228 <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>
1229 </td></tr>
1230 <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>
1231 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
1232 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1233 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1234 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>2.4.3 and later</td></tr>
1235 </table>
1236 <p>After a lua function has been registered as authorization provider, it can be used
1237 with the <code class="directive"><a href="../mod/mod_authz_core.html#require">Require</a></code> directive:</p>
1238
1239 <pre class="prettyprint lang-config">
1240 LuaRoot /usr/local/apache2/lua
1241 LuaAuthzProvider foo authz.lua authz_check_foo
1242 &lt;Location /&gt;
1243   Require foo johndoe
1244 &lt;/Location&gt;
1245 </pre>
1246
1247 <pre class="prettyprint lang-lua">
1248 require "apache2"
1249 function authz_check_foo(r, who)
1250     if r.user ~= who then return apache2.AUTHZ_DENIED
1251     return apache2.AUTHZ_GRANTED
1252 end
1253 </pre>
1254
1255
1256
1257
1258 </div>
1259 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1260 <div class="directive-section"><h2><a name="LuaCodeCache" id="LuaCodeCache">LuaCodeCache</a> <a name="luacodecache" id="luacodecache">Directive</a></h2>
1261 <table class="directive">
1262 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configure the compiled code cache.</td></tr>
1263 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaCodeCache stat|forever|never</code></td></tr>
1264 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LuaCodeCache stat</code></td></tr>
1265 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1266 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1267 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1268 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1269 </table><p>
1270     Specify the behavior of the in-memory code cache. The default
1271     is stat, which stats the top level script (not any included
1272     ones) each time that file is needed, and reloads it if the
1273     modified time indicates it is newer than the one it has
1274     already loaded. The other values cause it to keep the file
1275     cached forever (don't stat and replace) or to never cache the
1276     file.</p>
1277
1278     <p>In general stat or forever is good for production, and stat or never
1279     for development.</p>
1280
1281     <div class="example"><h3>Examples:</h3><pre class="prettyprint lang-config">
1282 LuaCodeCache stat
1283 LuaCodeCache forever
1284 LuaCodeCache never
1285     </pre>
1286 </div>
1287
1288
1289 </div>
1290 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1291 <div class="directive-section"><h2><a name="LuaHookAccessChecker" id="LuaHookAccessChecker">LuaHookAccessChecker</a> <a name="luahookaccesschecker" id="luahookaccesschecker">Directive</a></h2>
1292 <table class="directive">
1293 <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>
1294 <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>
1295 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1296 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1297 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1298 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1299 <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>
1300 </table>
1301 <p>Add your hook to the access_checker phase.  An access checker
1302 hook function usually returns OK, DECLINED, or HTTP_FORBIDDEN.</p>
1303    <div class="note"><h3>Ordering</h3><p>The optional arguments "early" or "late"
1304    control when this script runs relative to other modules.</p></div>
1305
1306 </div>
1307 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1308 <div class="directive-section"><h2><a name="LuaHookAuthChecker" id="LuaHookAuthChecker">LuaHookAuthChecker</a> <a name="luahookauthchecker" id="luahookauthchecker">Directive</a></h2>
1309 <table class="directive">
1310 <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>
1311 <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>
1312 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1313 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1314 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1315 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1316 <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>
1317 </table>
1318 <p>Invoke a lua function in the auth_checker phase of processing
1319 a request.  This can be used to implement arbitrary authentication
1320 and authorization checking.  A very simple example:
1321 </p>
1322 <pre class="prettyprint lang-lua">
1323 require 'apache2'
1324
1325 -- fake authcheck hook
1326 -- If request has no auth info, set the response header and
1327 -- return a 401 to ask the browser for basic auth info.
1328 -- If request has auth info, don't actually look at it, just
1329 -- pretend we got userid 'foo' and validated it.
1330 -- Then check if the userid is 'foo' and accept the request.
1331 function authcheck_hook(r)
1332
1333    -- look for auth info
1334    auth = r.headers_in['Authorization']
1335    if auth ~= nil then
1336      -- fake the user
1337      r.user = 'foo'
1338    end
1339
1340    if r.user == nil then
1341       r:debug("authcheck: user is nil, returning 401")
1342       r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
1343       return 401
1344    elseif r.user == "foo" then
1345       r:debug('user foo: OK')
1346    else
1347       r:debug("authcheck: user='" .. r.user .. "'")
1348       r.err_headers_out['WWW-Authenticate'] = 'Basic realm="WallyWorld"'
1349       return 401
1350    end
1351    return apache2.OK
1352 end
1353 </pre>
1354
1355    <div class="note"><h3>Ordering</h3><p>The optional arguments "early" or "late"
1356    control when this script runs relative to other modules.</p></div>
1357
1358 </div>
1359 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1360 <div class="directive-section"><h2><a name="LuaHookCheckUserID" id="LuaHookCheckUserID">LuaHookCheckUserID</a> <a name="luahookcheckuserid" id="luahookcheckuserid">Directive</a></h2>
1361 <table class="directive">
1362 <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>
1363 <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>
1364 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1365 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1366 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1367 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1368 <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>
1369 </table><p>...</p>
1370    <div class="note"><h3>Ordering</h3><p>The optional arguments "early" or "late"
1371    control when this script runs relative to other modules.</p></div>
1372
1373 </div>
1374 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1375 <div class="directive-section"><h2><a name="LuaHookFixups" id="LuaHookFixups">LuaHookFixups</a> <a name="luahookfixups" id="luahookfixups">Directive</a></h2>
1376 <table class="directive">
1377 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Provide a hook for the fixups phase of a request
1378 processing</td></tr>
1379 <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>
1380 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1381 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1382 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1383 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1384 </table>
1385 <p>
1386     Just like LuaHookTranslateName, but executed at the fixups phase
1387 </p>
1388
1389 </div>
1390 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1391 <div class="directive-section"><h2><a name="LuaHookInsertFilter" id="LuaHookInsertFilter">LuaHookInsertFilter</a> <a name="luahookinsertfilter" id="luahookinsertfilter">Directive</a></h2>
1392 <table class="directive">
1393 <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>
1394 <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>
1395 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1396 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1397 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1398 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1399 </table><p>Not Yet Implemented</p>
1400 </div>
1401 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1402 <div class="directive-section"><h2><a name="LuaHookMapToStorage" id="LuaHookMapToStorage">LuaHookMapToStorage</a> <a name="luahookmaptostorage" id="luahookmaptostorage">Directive</a></h2>
1403 <table class="directive">
1404 <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>
1405 <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>
1406 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1407 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1408 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1409 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1410 </table>
1411     <p>Like <code class="directive">LuaHookTranslateName</code> but executed at the
1412     map-to-storage phase of a request. Modules like mod_cache run at this phase,
1413     which makes for an interesting example on what to do here:</p>
1414     <pre class="prettyprint lang-config">
1415     LuaHookMapToStorage /path/to/lua/script.lua check_cache
1416     </pre>
1417
1418     <pre class="prettyprint lang-lua">
1419 require"apache2"
1420 cached_files = {}
1421
1422 function read_file(filename)
1423     local input = io.open(filename, "r")
1424     if input then
1425         local data = input:read("*a")
1426         cached_files[filename] = data
1427         file = cached_files[filename]
1428         input:close()
1429     end
1430     return cached_files[filename]
1431 end
1432
1433 function check_cache(r)
1434     if r.filename:match("%.png$") then -- Only match PNG files
1435         local file = cached_files[r.filename] -- Check cache entries
1436         if not file then
1437             file = read_file(r.filename)  -- Read file into cache
1438         end
1439         if file then -- If file exists, write it out
1440             r.status = 200
1441             r:write(file)
1442             r:info(("Sent %s to client from cache"):format(r.filename))
1443             return apache2.DONE -- skip default handler for PNG files
1444         end
1445     end
1446     return apache2.DECLINED -- If we had nothing to do, let others serve this.
1447 end
1448     </pre>
1449
1450
1451
1452 </div>
1453 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1454 <div class="directive-section"><h2><a name="LuaHookTranslateName" id="LuaHookTranslateName">LuaHookTranslateName</a> <a name="luahooktranslatename" id="luahooktranslatename">Directive</a></h2>
1455 <table class="directive">
1456 <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>
1457 <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>
1458 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1459 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1460 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1461 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1462 <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>
1463 </table><p>
1464     Add a hook (at APR_HOOK_MIDDLE) to the translate name phase of
1465     request processing. The hook function receives a single
1466     argument, the request_rec, and should return a status code,
1467     which is either an HTTP error code, or the constants defined
1468     in the apache2 module: apache2.OK, apache2.DECLINED, or
1469     apache2.DONE. </p>
1470
1471     <p>For those new to hooks, basically each hook will be invoked
1472     until one of them returns apache2.OK. If your hook doesn't
1473     want to do the translation it should just return
1474     apache2.DECLINED. If the request should stop processing, then
1475     return apache2.DONE.</p>
1476
1477     <p>Example:</p>
1478
1479 <pre class="prettyprint lang-config">
1480 # httpd.conf
1481 LuaHookTranslateName /scripts/conf/hooks.lua silly_mapper
1482 </pre>
1483
1484
1485 <pre class="prettyprint lang-lua">
1486 -- /scripts/conf/hooks.lua --
1487 require "apache2"
1488 function silly_mapper(r)
1489     if r.uri == "/" then
1490         r.filename = "/var/www/home.lua"
1491         return apache2.OK
1492     else
1493         return apache2.DECLINED
1494     end
1495 end
1496 </pre>
1497
1498
1499    <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
1500    context.</p></div>
1501
1502    <div class="note"><h3>Ordering</h3><p>The optional arguments "early" or "late"
1503    control when this script runs relative to other modules.</p></div>
1504
1505
1506 </div>
1507 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1508 <div class="directive-section"><h2><a name="LuaHookTypeChecker" id="LuaHookTypeChecker">LuaHookTypeChecker</a> <a name="luahooktypechecker" id="luahooktypechecker">Directive</a></h2>
1509 <table class="directive">
1510 <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>
1511 <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>
1512 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1513 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1514 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1515 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1516 </table><p>
1517     This directive provides a hook for the type_checker phase of the request processing.
1518     This phase is where requests are assigned a content type and a handler, and thus can
1519     be used to modify the type and handler based on input:
1520     </p>
1521     <pre class="prettyprint lang-config">
1522     LuaHookTypeChecker /path/to/lua/script.lua type_checker
1523     </pre>
1524
1525     <pre class="prettyprint lang-lua">
1526     function type_checker(r)
1527         if r.uri:match("%.to_gif$") then -- match foo.png.to_gif
1528             r.content_type = "image/gif" -- assign it the image/gif type
1529             r.handler = "gifWizard"      -- tell the gifWizard module to handle this
1530             r.filename = r.uri:gsub("%.to_gif$", "") -- fix the filename requested
1531             return apache2.OK
1532         end
1533
1534         return apache2.DECLINED
1535     end
1536     </pre>
1537
1538
1539 </div>
1540 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1541 <div class="directive-section"><h2><a name="LuaInherit" id="LuaInherit">LuaInherit</a> <a name="luainherit" id="luainherit">Directive</a></h2>
1542 <table class="directive">
1543 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Controls how parent configuration sections are merged into children</td></tr>
1544 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaInherit none|parent-first|parent-last</code></td></tr>
1545 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LuaInherit parent-first</code></td></tr>
1546 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1547 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1548 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1549 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1550 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>2.4.0 and later</td></tr>
1551 </table><p>By default, if LuaHook* directives are used in overlapping
1552     Directory or Location configuration sections, the scripts defined in the
1553     more specific section are run <em>after</em> those defined in the more
1554     generic section (LuaInherit parent-first).  You can reverse this order, or
1555     make the parent context not apply at all.</p>
1556
1557     <p> In previous 2.3.x releases, the default was effectively to ignore LuaHook*
1558     directives from parent configuration sections.</p>
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="LuaInputFilter" id="LuaInputFilter">LuaInputFilter</a> <a name="luainputfilter" id="luainputfilter">Directive</a></h2>
1562 <table class="directive">
1563 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Provide a Lua function for content input filtering</td></tr>
1564 <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>
1565 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
1566 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1567 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1568 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>2.5.0 and later</td></tr>
1569 </table>
1570 <p>Provides a means of adding a Lua function as an input filter.
1571 As with output filters, input filters work as coroutines,
1572 first yielding before buffers are sent, then yielding whenever
1573 a bucket needs to be passed down the chain, and finally (optionally)
1574 yielding anything that needs to be appended to the input data. The
1575 global variable <code>bucket</code> holds the buckets as they are passed
1576 onto the Lua script:
1577 </p>
1578
1579 <pre class="prettyprint lang-config">
1580 LuaInputFilter myInputFilter /www/filter.lua input_filter
1581 &lt;FilesMatch "\.lua&gt;
1582   SetInputFilter myInputFilter
1583 &lt;/FilesMatch&gt;
1584 </pre>
1585
1586 <pre class="prettyprint lang-lua">
1587 --[[
1588     Example input filter that converts all POST data to uppercase.
1589 ]]--
1590 function input_filter(r)
1591     print("luaInputFilter called") -- debug print
1592     coroutine.yield() -- Yield and wait for buckets
1593     while bucket do -- For each bucket, do...
1594         local output = string.upper(bucket) -- Convert all POST data to uppercase
1595         coroutine.yield(output) -- Send converted data down the chain
1596     end
1597     -- No more buckets available.
1598     coroutine.yield("&amp;filterSignature=1234") -- Append signature at the end
1599 end
1600 </pre>
1601
1602 <p>
1603 The input filter supports denying/skipping a filter if it is deemed unwanted:
1604 </p>
1605 <pre class="prettyprint lang-lua">
1606 function input_filter(r)
1607     if not good then
1608         return -- Simply deny filtering, passing on the original content instead
1609     end
1610     coroutine.yield() -- wait for buckets
1611     ... -- insert filter stuff here
1612 end
1613 </pre>
1614
1615 <p>
1616 See "<a href="#modifying_buckets">Modifying contents with Lua
1617 filters</a>" for more information.
1618 </p>
1619
1620 </div>
1621 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1622 <div class="directive-section"><h2><a name="LuaMapHandler" id="LuaMapHandler">LuaMapHandler</a> <a name="luamaphandler" id="luamaphandler">Directive</a></h2>
1623 <table class="directive">
1624 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Map a path to a lua handler</td></tr>
1625 <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>
1626 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1627 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1628 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1629 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1630 </table>
1631     <p>This directive matches a uri pattern to invoke a specific
1632     handler function in a specific file. It uses PCRE regular
1633     expressions to match the uri, and supports interpolating
1634     match groups into both the file path and the function name.
1635     Be careful writing your regular expressions to avoid security
1636     issues.</p>
1637    <div class="example"><h3>Examples:</h3><pre class="prettyprint lang-config">
1638     LuaMapHandler /(\w+)/(\w+) /scripts/$1.lua handle_$2
1639     </pre>
1640 </div>
1641         <p>This would match uri's such as /photos/show?id=9
1642         to the file /scripts/photos.lua and invoke the
1643         handler function handle_show on the lua vm after
1644         loading that file.</p>
1645
1646 <pre class="prettyprint lang-config">
1647     LuaMapHandler /bingo /scripts/wombat.lua
1648 </pre>
1649
1650         <p>This would invoke the "handle" function, which
1651         is the default if no specific function name is
1652         provided.</p>
1653
1654 </div>
1655 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1656 <div class="directive-section"><h2><a name="LuaOutputFilter" id="LuaOutputFilter">LuaOutputFilter</a> <a name="luaoutputfilter" id="luaoutputfilter">Directive</a></h2>
1657 <table class="directive">
1658 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Provide a Lua function for content output filtering</td></tr>
1659 <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>
1660 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
1661 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1662 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1663 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>2.5.0 and later</td></tr>
1664 </table>
1665 <p>Provides a means of adding a Lua function as an output filter.
1666 As with input filters, output filters work as coroutines,
1667 first yielding before buffers are sent, then yielding whenever
1668 a bucket needs to be passed down the chain, and finally (optionally)
1669 yielding anything that needs to be appended to the input data. The
1670 global variable <code>bucket</code> holds the buckets as they are passed
1671 onto the Lua script:
1672 </p>
1673
1674 <pre class="prettyprint lang-config">
1675 LuaOutputFilter myOutputFilter /www/filter.lua output_filter
1676 &lt;FilesMatch "\.lua&gt;
1677   SetOutputFilter myOutputFilter
1678 &lt;/FilesMatch&gt;
1679 </pre>
1680
1681 <pre class="prettyprint lang-lua">
1682 --[[
1683     Example output filter that escapes all HTML entities in the output
1684 ]]--
1685 function output_filter(r)
1686     coroutine.yield("(Handled by myOutputFilter)&lt;br/&gt;\n") -- Prepend some data to the output,
1687                                                           -- yield and wait for buckets.
1688     while bucket do -- For each bucket, do...
1689         local output = r:escape_html(bucket) -- Escape all output
1690         coroutine.yield(output) -- Send converted data down the chain
1691     end
1692     -- No more buckets available.
1693 end
1694 </pre>
1695
1696 <p>
1697 As with the input filter, the output filter supports denying/skipping a filter
1698 if it is deemed unwanted:
1699 </p>
1700 <pre class="prettyprint lang-lua">
1701 function output_filter(r)
1702     if not r.content_type:match("text/html") then
1703         return -- Simply deny filtering, passing on the original content instead
1704     end
1705     coroutine.yield() -- wait for buckets
1706     ... -- insert filter stuff here
1707 end
1708 </pre>
1709
1710 <p>
1711 See "<a href="#modifying_buckets">Modifying contents with Lua filters</a>" for more
1712 information.
1713 </p>
1714
1715 </div>
1716 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1717 <div class="directive-section"><h2><a name="LuaPackageCPath" id="LuaPackageCPath">LuaPackageCPath</a> <a name="luapackagecpath" id="luapackagecpath">Directive</a></h2>
1718 <table class="directive">
1719 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Add a directory to lua's package.cpath</td></tr>
1720 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaPackageCPath /path/to/include/?.soa</code></td></tr>
1721 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1722 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1723 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1724 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1725 </table>
1726     <p>Add a path to lua's shared library search path. Follows the same
1727     conventions as lua. This just munges the package.cpath in the
1728     lua vms.</p>
1729
1730
1731 </div>
1732 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1733 <div class="directive-section"><h2><a name="LuaPackagePath" id="LuaPackagePath">LuaPackagePath</a> <a name="luapackagepath" id="luapackagepath">Directive</a></h2>
1734 <table class="directive">
1735 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Add a directory to lua's package.path</td></tr>
1736 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaPackagePath /path/to/include/?.lua</code></td></tr>
1737 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1738 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1739 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1740 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1741 </table><p>Add a path to lua's module search path. Follows the same
1742     conventions as lua. This just munges the package.path in the
1743     lua vms.</p>
1744
1745     <div class="example"><h3>Examples:</h3><pre class="prettyprint lang-config">
1746 LuaPackagePath /scripts/lib/?.lua
1747 LuaPackagePath /scripts/lib/?/init.lua
1748     </pre>
1749 </div>
1750
1751 </div>
1752 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1753 <div class="directive-section"><h2><a name="LuaQuickHandler" id="LuaQuickHandler">LuaQuickHandler</a> <a name="luaquickhandler" id="luaquickhandler">Directive</a></h2>
1754 <table class="directive">
1755 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Provide a hook for the quick handler of request processing</td></tr>
1756 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaQuickHandler /path/to/script.lua hook_function_name</code></td></tr>
1757 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
1758 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1759 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1760 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1761 </table>
1762     <p>
1763     This phase is run immediately after the request has been mapped to a virtal host,
1764     and can be used to either do some request processing before the other phases kick
1765     in, or to serve a request without the need to translate, map to storage et cetera.
1766     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
1767     URIs have not been properly parsed yet.
1768     </p>
1769    <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
1770    context.</p></div>
1771
1772 </div>
1773 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1774 <div class="directive-section"><h2><a name="LuaRoot" id="LuaRoot">LuaRoot</a> <a name="luaroot" id="luaroot">Directive</a></h2>
1775 <table class="directive">
1776 <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>
1777 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaRoot /path/to/a/directory</code></td></tr>
1778 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1779 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1780 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1781 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1782 </table>
1783     <p>Specify the base path which will be used to evaluate all
1784     relative paths within mod_lua. If not specified they
1785     will be resolved relative to the current working directory,
1786     which may not always work well for a server.</p>
1787
1788 </div>
1789 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1790 <div class="directive-section"><h2><a name="LuaScope" id="LuaScope">LuaScope</a> <a name="luascope" id="luascope">Directive</a></h2>
1791 <table class="directive">
1792 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>One of once, request, conn, thread -- default is once</td></tr>
1793 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LuaScope once|request|conn|thread|server [min] [max]</code></td></tr>
1794 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>LuaScope once</code></td></tr>
1795 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1796 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>All</td></tr>
1797 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
1798 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_lua</td></tr>
1799 </table>
1800     <p>Specify the lifecycle scope of the Lua interpreter which will
1801     be used by handlers in this "Directory." The default is "once"</p>
1802
1803    <dl>
1804     <dt>once:</dt> <dd>use the interpreter once and throw it away.</dd>
1805
1806     <dt>request:</dt> <dd>use the interpreter to handle anything based on
1807              the same file within this request, which is also
1808              request scoped.</dd>
1809
1810     <dt>conn:</dt> <dd>Same as request but attached to the connection_rec</dd>
1811
1812     <dt>thread:</dt> <dd>Use the interpreter for the lifetime of the thread
1813             handling the request (only available with threaded MPMs).</dd>
1814
1815     <dt>server:</dt>  <dd>This one is different than others because the
1816             server scope is quite long lived, and multiple threads
1817             will have the same server_rec. To accommodate this,
1818             server scoped Lua states are stored in an apr
1819             resource list. The <code>min</code> and <code>max</code> arguments
1820             specify the minimum and maximum number of Lua states to keep in the
1821             pool.</dd>
1822    </dl>
1823     <p>
1824     Generally speaking, the <code>thread</code> and <code>server</code> scopes
1825     execute roughly 2-3 times faster than the rest, because they don't have to
1826     spawn new Lua states on every request (especially with the event MPM, as
1827     even keepalive requests will use a new thread for each request). If you are
1828     satisfied that your scripts will not have problems reusing a state, then
1829     the <code>thread</code> or <code>server</code> scopes should be used for
1830     maximum performance. While the <code>thread</code> scope will provide the
1831     fastest responses, the <code>server</code> scope will use less memory, as
1832     states are pooled, allowing f.x. 1000 threads to share only 100 Lua states,
1833     thus using only 10% of the memory required by the <code>thread</code> scope.
1834     </p>
1835
1836 </div>
1837 </div>
1838 <div class="bottomlang">
1839 <p><span>Available Languages: </span><a href="../en/mod/mod_lua.html" title="English">&nbsp;en&nbsp;</a> |
1840 <a href="../fr/mod/mod_lua.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a></p>
1841 </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>
1842 <script type="text/javascript"><!--//--><![CDATA[//><!--
1843 var comments_shortname = 'httpd';
1844 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_lua.html';
1845 (function(w, d) {
1846     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
1847         d.write('<div id="comments_thread"><\/div>');
1848         var s = d.createElement('script');
1849         s.type = 'text/javascript';
1850         s.async = true;
1851         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
1852         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
1853     }
1854     else {
1855         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
1856     }
1857 })(window, document);
1858 //--><!]]></script></div><div id="footer">
1859 <p class="apache">Copyright 2013 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>
1860 <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[//><!--
1861 if (typeof(prettyPrint) !== 'undefined') {
1862     prettyPrint();
1863 }
1864 //--><!]]></script>
1865 </body></html>