granicus.if.org Git - apache/blob - docs/manual/developer/modguide.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>Developing modules for the Apache HTTP Server 2.4 - 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" />
  12 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13 <body id="manual-page"><div id="page-header">
  14 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  15 <p class="apache">Apache HTTP Server Version 2.5</p>
  16 <img alt="" src="../images/feather.gif" /></div>
  17 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  18 <div id="path">
  19 <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="./">Developer</a></div><div id="page-content"><div id="preamble"><h1>Developing modules for the Apache HTTP Server 2.4</h1>
  20 <div class="toplang">
  21 <p><span>Available Languages: </span><a href="../en/developer/modguide.html" title="English">&nbsp;en&nbsp;</a></p>
  22 </div>
  23
  24 <p>This document explains how you can develop modules for the Apache HTTP Server 2.4</p>
  25 </div>
  26 <div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#introduction">Introduction</a></li>
  27 <li><img alt="" src="../images/down.gif" /> <a href="#basics">Defining a module</a></li>
  28 <li><img alt="" src="../images/down.gif" /> <a href="#hooking">Getting started: Hooking into Apache</a></li>
  29 <li><img alt="" src="../images/down.gif" /> <a href="#handling">Building a handler</a></li>
  30 <li><img alt="" src="../images/down.gif" /> <a href="#configuration">Adding configuration options</a></li>
  31 <li><img alt="" src="../images/down.gif" /> <a href="#context">Context aware configurations</a></li>
  32 <li><img alt="" src="../images/down.gif" /> <a href="#summary">Summing up</a></li>
  33 <li><img alt="" src="../images/down.gif" /> <a href="#snippets">Some useful snippets of code</a></li>
  34 </ul><h3>See also</h3><ul class="seealso"><li><a href="request.html">Request Processing in Apache 2.4</a></li><li><a href="hooks.html">Apache 2.x Hook Functions</a></li></ul></div>
  35 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  36 <div class="section">
  37 <h2><a name="introduction" id="introduction">Introduction</a></h2>
  38 <h3><a name="what" id="what">What we will be discussing in this document</a></h3>
  39 <p>
  40 This document will discuss how you can easily create modules for the Apache HTTP Server 2.4 ("Apache"),
  41 by exploring an example module called <code>mod_example</code>. In the first part of this document, the purpose of this
  42 module will be to calculate and print out various digest values for existing files on your web server, whenever we
  43 access the URL <code>http://hostname/filename.sum</code>. For instance, if we want to know the MD5 digest value of the file
  44 located at <code>http://www.example.com/index.html</code>, we would visit <code>http://www.example.com/index.html.sum</code>.
  45 </p>
  46 <p>
  47 In the second part of this document, which deals with configuration directive and context awareness, we will be looking at
  48 a module that simply write out its own configuration to the client.
  49 </p>
  50
  51 <h3><a name="prerequisites" id="prerequisites">Prerequisites</a></h3>
  52 <p>
  53 First and foremost, you are expected to have a basic knowledge of how the C programming language works. In most cases,
  54 we will try to be as pedagogical as possible and link to documents describing the functions used in the examples,
  55 but there are also many cases where it is necessary to either just assume that "it works" or do some digging youself
  56 into what the hows and whys of various function calls.
  57 </p>
  58 <p>
  59 Lastly, you will need to have a basic understanding of how modules are loaded and configured in Apache, as well as
  60 how to get the headers for Apache if you do not have them already, as these are needed for compiling new modules.
  61 </p>
  62
  63 <h3><a name="compiling" id="compiling">Compiling your module</a></h3>
  64 <p>
  65 To compile the source code we are building in this document, we will be using <a href="../programs/apxs.html">APXS</a>.
  66 Assuming your source file is called mod_example.c, compiling, installing and activating the module is as simple as:
  67 <div class="example"><pre>
  68 apxs -i -a -c mod_example.c
  69 </pre></div>
  70 </p>
  71
  72 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  73 <div class="section">
  74 <h2><a name="basics" id="basics">Defining a module</a></h2>
  75 <img src="../images/build_a_mod_3.png" /><br />
  76 <p>Every module starts with the same declaration, or name tag if you will, that defines a module as <em>a separate entity within Apache</em>:
  77
  78
  79
  80 <pre style="color:#000000;background:#ffffef;border: 1px dashed #333; padding: 0.5em; margin: 1em 2em 1em 1em;">
  81 module AP_MODULE_DECLARE_DATA   example_module <code style="color:#806030; ">=</code>
  82 <code style="color:#806030; ">{</code>
  83     STANDARD20_MODULE_STUFF<code style="color:#806030; ">,</code>
  84     create_dir_conf<code style="color:#806030; ">,</code> <code style="color:#c34e00; ">/* Per-directory configuration handler */</code>
  85     merge_dir_conf<code style="color:#806030; ">,</code>  <code style="color:#c34e00; ">/* Merge handler for per-directory configurations */</code>
  86     create_svr_conf<code style="color:#806030; ">,</code> <code style="color:#c34e00; ">/* Per-server configuration handler */</code>
  87     merge_svr_conf<code style="color:#806030; ">,</code>  <code style="color:#c34e00; ">/* Merge handler for per-server configurations */</code>
  88     directives<code style="color:#806030; ">,</code>      <code style="color:#c34e00; ">/* Any directives we may have for httpd */</code>
  89     register_hooks   <code style="color:#c34e00; ">/* Our hook registering function */</code>
  90 <code style="color:#806030; ">}</code><code style="color:#806030; ">;</code>
  91 </pre>
  92
  93
  94
  95 This bit of code lets Apache know that we have now registered a new module in the system,
  96 and that its name is <code>example_module</code>. The name of the module is used primarilly
  97 for two things:<br />
  98 <ul>
  99 <li>Letting Apache know how to load the module using the LoadModule</li>
 100 <li>Setting up a namespace for the module to use in configurations</li>
 101 </ul>
 102 For now, we're only concerned with the first purpose of the module name,
 103 which comes into play when we need to load the module:<br />
 104 <div class="example"><pre><a href="../mod/mod_so.html#LoadModule">LoadModule</a> example_module modules/mod_example.so</pre></div>
 105 In essence, this tells Apache to open up <code>mod_example.so</code> and look for a module
 106 called <code>example_module</code>.
 107 </p>
 108 <p>
 109 Within this name tag of ours is also a bunch of references to how we would like to handle things:
 110 Which directives do we respond to in a configuration file or .htaccess, how do we operate
 111 within specific contexts, and what handlers are we interested in registering with the Apache
 112 service. We'll return to all these elements later in this document.
 113 </p>
 114 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 115 <div class="section">
 116 <h2><a name="hooking" id="hooking">Getting started: Hooking into Apache</a></h2>
 117 <h3><a name="hook_intro" id="hook_intro">An introduction to hooks</a></h3>
 118 <p>
 119 When handling requests in Apache, the first thing you will need to do is create a hook into
 120 the request handling process. A hook is essentially a message telling Apache that you are
 121 willing to either serve or at least take a glance at certain requests given by clients. All
 122 handlers, whether it's mod_rewrite, mod_authn_*, mod_proxy and so on, are hooked into specific
 123 parts of the request process. As you are probably aware, modules serve different purposes; Some
 124 are authentication/authorization handlers, others are file or script handlers while some third
 125 modules rewrite URIs or proxies content. Furthermore, in the end, it is up to the user of Apache
 126 how and when each module will come into place. Thus, Apache itself does not presume to know
 127 which module is responsible for handling a specific request, and will ask each module whether
 128 they have an interest in a given request or not. It is then up to each module to either gently
 129 decline serving a request, accept serving it or flat out deny the request from being served,
 130 as authentication/authorization modules do: <br />
 131 <img src="../images/build_a_mod_2.png" /><br />
 132 To make it a bit easier for handlers such as our mod_example to know whether the client is
 133 requesting content we should handle or not, Apache has directives for hinting to modules whether
 134 their assistance is needed or not. Two of these are <code class="directive"><a href="../mod/mod_mime.html#addhandler">AddHandler</a></code> and <code class="directive"><a href="../mod/core.html#sethandler">SetHandler</a></code>.
 135 Let's take a look at an example using <code class="directive"><a href="../mod/mod_mime.html#addhandler">AddHandler</a></code>.
 136 In our example case, we want every request ending with .sum to be served by <code>mod_example</code>,
 137 so we'll add a configuration directive that tells Apache to do just that:
 138 <div class="example"><pre>
 139 AddHandler example-handler .sum
 140 </pre></div>
 141 What this tells Apache is the following: <em>Whenever we receive a request for a URI ending in .sum,
 142 we are to let all modules know that we are looking for whoever goes by the name of "example-handler"
 143 </em>. Thus, when a request is being served that ends in .sum, Apache will let all modules know, that
 144 this request should be served by "example-handler". As you will see later, when we start
 145 building mod_example, we will check for this handler tag relayed by <code>AddHandler</code> and
 146 reply to Apache based on the value of this tag.
 147 </p>
 148
 149 <h3><a name="hook_declaration" id="hook_declaration">Hooking into httpd</a></h3>
 150 <p>
 151 To begin with, we only want to create a simple handler, that replies to the client browser
 152 when a specific URL is requested, so we won't bother setting up configuration handlers and
 153 directives just yet. Our initial module definition will look like this:<br />
 154
 155
 156
 157 <pre style="color:#000000;background:#ffffef;border: 1px dashed #333; padding: 0.5em; margin: 1em 2em 1em 1em;">
 158 module AP_MODULE_DECLARE_DATA   example_module =
 159 {
 160     STANDARD20_MODULE_STUFF,
 161     <code style="color:#7f0055; font-weight:bold; ">NULL</code>,
 162     <code style="color:#7f0055; font-weight:bold; ">NULL</code>,
 163     <code style="color:#7f0055; font-weight:bold; ">NULL</code>,
 164     <code style="color:#7f0055; font-weight:bold; ">NULL</code>,
 165     <code style="color:#7f0055; font-weight:bold; ">NULL</code>,
 166     <code style="color:#800040; ">register_hooks</code>   <code style="color:#c34e00; "><code style="color:#c34e00; ">/* Our hook registering function */</code></code>
 167 };
 168 </pre>
 169
 170
 171
 172 This lets Apache know that we are not interesting in anything fancy, we just want to hook onto
 173 the requests and possibly handle some of them.
 174 </p>
 175 <p>
 176 The reference in our example declaration, <code>register_hooks</code> is the name of a function
 177 we will create to manage how we hook onto the request process. In this example module, the function
 178 has just one purpose; To create a simple hook that gets called after all the rewrites, access
 179 control etc has been handled. Thus, we will let Apache know, that we want to hook into its process
 180 as one of the last modules:
 181
 182
 183
 184 <pre style="color:#000000;background:#ffffef;border: 1px dashed #333; padding: 0.5em; margin: 1em 2em 1em 1em;">
 185 <code style="color:#400000; font-weight:bold; ">static</code> <code style="color:#400000; font-weight:bold; ">void</code> register_hooks<code style="color:#806030; ">(</code>apr_pool_t <code style="color:#806030; ">*</code>pool<code style="color:#806030; ">)</code>
 186 <code style="color:#806030; ">{</code>
 187     <code style="color:#c34e00; ">/* Create a hook in the request handler, so we get called when a request arrives */</code>
 188     <code style="color:#800040; ">ap_hook_handler</code><code style="color:#806030; ">(</code>example_handler<code style="color:#806030; ">,</code> <code style="color:#7f0055; font-weight:bold; ">NULL</code><code style="color:#806030; ">,</code> <code style="color:#7f0055; font-weight:bold; ">NULL</code><code style="color:#806030; ">,</code> APR_HOOK_LAST<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 189 <code style="color:#806030; ">}</code>
 190 </pre>
 191
 192
 193
 194 The <code>example_handler</code> reference is the function that will handle the request. We will
 195 discuss how to create a handler in the next chapter.
 196 </p>
 197
 198 <h3><a name="hook_others" id="hook_others">Other useful hooks</a></h3>
 199 <p>
 200 Hooking into the request handling phase is but one of many hooks that you can create. Some other ways of hooking are:
 201 <ul>
 202 <li><code>ap_hook_child_init</code>: Place a hook that executes when a child process is spawned (commonly used for initializing modules after Apache has forked)</li>
 203 <li><code>ap_hook_pre_config</code>: Place a hook that executes before any configuration data has been read (very early hook)</li>
 204 <li><code>ap_hook_post_config</code>: Place a hook that executes after configuration has been parsed, but before Apache has forked</li>
 205 <li><code>ap_hook_translate_name</code>: Place a hook that executes when a URI needs to be translated into a filename on the server (think <code>mod_rewrite</code>)</li>
 206 </ul>
 207 </p>
 208
 209 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 210 <div class="section">
 211 <h2><a name="handling" id="handling">Building a handler</a></h2>
 212 <p>
 213 A handler is essentially a function that receives a callback when a request to Apache is made.
 214 It is passed a record of the current request (how it was made, which headers and requests were
 215 passed along, who's giving the request and so on), and is put in charge of either telling
 216 Apache that it's not interested in the request or handle the request with the tools provided.
 217 </p>
 218 <h3><a name="simple_handler" id="simple_handler">A simple "Hello, world!" handler</a></h3>
 219 Let's start off by making a very simple request handler that does the following: <br />
 220 <ol>
 221 <li>Check that this is a request that should be served by "example-handler"</li>
 222 <li>Set the content type of our output to <code>text/html</code></li>
 223 <li>Write "Hello, world!" back to the client browser</li>
 224 <li>Let Apache know that we took care of this request and everything went fine</li>
 225 </ol>
 226 In C code, our example handler will now look like this:<br />
 227
 228
 229
 230 <pre style="color:#000000;background:#ffffef;border: 1px dashed #333; padding: 0.5em; margin: 1em 2em 1em 1em;">
 231 <code style="color:#400000; font-weight:bold; ">static</code> <code style="color:#400000; font-weight:bold; ">int</code> example_handler<code style="color:#806030; ">(</code>request_rec <code style="color:#806030; ">*</code>r<code style="color:#806030; ">)</code>
 232 <code style="color:#806030; ">{</code>
 233     <code style="color:#c34e00; ">/* First off, we need to check if this is a call for the "example-handler" handler.</code>
 234 <code style="color:#c34e00; ">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* If it is, we accept it and do our things, if not, we simply return DECLINED,</code>
 235 <code style="color:#c34e00; ">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* and Apache will try somewhere else.</code>
 236 <code style="color:#c34e00; ">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*/</code>
 237     <code style="color:#400000; font-weight:bold; ">if</code> <code style="color:#806030; ">(</code><code style="color:#806030; ">!</code>r<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">handler</code> <code style="color:#806030; ">|</code><code style="color:#806030; ">|</code> <code style="color:#800040; ">strcmp</code><code style="color:#806030; ">(</code>r<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">handler</code><code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">example-handler</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">)</code> <code style="color:#400000; font-weight:bold; ">return</code> <code style="color:#806030; ">(</code>DECLINED<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 238
 239     <code style="color:#c34e00; ">/* Now that we are handling this request, we'll write out "Hello, world!" to the client.</code>
 240 <code style="color:#c34e00; ">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* To do so, we must first set the appropriate content type, followed by our output.</code>
 241 <code style="color:#c34e00; ">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*/</code>
 242     <a href="http://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__PROTO.html#gaa2f8412c400197338ec509f4a45e4579">ap_set_content_type</a><code style="color:#806030; ">(</code>r<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">text/html</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 243     <a href="http://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__PROTO.html#ga5e91eb6ca777c9a427b2e82bf1eeb81d">ap_rprintf</a><code style="color:#806030; ">(</code>r<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">Hello, world!</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 244
 245     <code style="color:#c34e00; ">/* Lastly, we must tell Apache that we took care of this request and everything went fine.</code>
 246 <code style="color:#c34e00; ">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* We do so by simply returning the value OK to Apache.</code>
 247 <code style="color:#c34e00; ">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*/</code>
 248     <code style="color:#400000; font-weight:bold; ">return</code> OK<code style="color:#806030; ">;</code>
 249 <code style="color:#806030; ">}</code>
 250 </pre>
 251
 252
 253
 254 Now, we put all we have learned together and end up with a program that looks like <a href="mod_example_1.c">
 255 mod_example_1.c</a>. The functions used in this example will be explained later in the section
 256 <a href="#functions">"Some useful functions you should know"</a>.
 257
 258 <h3><a name="request_rec" id="request_rec">The request_rec structure</a></h3>
 259 <p>The most essential part of any request is the <em>request record</em>. In a call to a handler function, this
 260 is represented by the <code>request_req*</code> structure passed along with every call that is made. This
 261 struct, typically just refered to as <code>r</code> in modules, contains all the information you need for
 262 your module to fully process any HTTP request and respond accordingly.</p>
 263 <p>Some key elements of the <code>request_req</code> structure are:
 264 <ul>
 265 <li><code><code style="color:#008833">r-&gt;handler</code> (char*)</code>: Contains the name of the handler Apache is currently asking to do the handling of this request</li>
 266 <li><code><code style="color:#008833">r-&gt;method</code> (char*)</code>: Contains the HTTP method being used, f.x. GET or POST</li>
 267 <li><code><code style="color:#008833">r-&gt;filename</code> (char*)</code>: Contains the translated filename the client is requesting</li>
 268 <li><code><code style="color:#008833">r-&gt;args</code> (char*)</code>: Contains the query string of the request, if any</li>
 269 <li><code><code style="color:#008833">r-&gt;headers_in</code> (apr_table_t*)</code>: Contains all the headers sent by the client</li>
 270 <li><code><code style="color:#008833">r-&gt;connection</code> (conn_rec*)</code>: A record containing information about the current connection</li>
 271 <li><code><code style="color:#008833">r-&gt;useragent_ip</code> (char*)</code>: The IP address of the client connecting to us</li>
 272 <li><code><code style="color:#008833">r-&gt;pool</code> (apr_pool_t*)</code>: The memory pool of this request. We'll discuss this in the "
 273 <a href="#memory">Memory management</a>" chapter.</li>
 274 </ul>
 275 A complete list of all the values contained with in the <code>request_req</code> structure can be found in
 276 the <a href="http://svn.apache.org/repos/asf/httpd/httpd/trunk/include/httpd.h"><code>httpd.h</code></a> header
 277 file or at <a href="http://ci.apache.org/projects/httpd/trunk/doxygen/structrequest__rec.html">http://ci.apache.org/projects/httpd/trunk/doxygen/structrequest__rec.html</a>.
 278 </p>
 279 <p>
 280 Let's try out some of these variables in another example handler:<br />
 281
 282
 283
 284 <pre style="color:#000000;background:#ffffef;border: 1px dashed #333; padding: 0.5em; margin: 1em 2em 1em 1em;">
 285 <code style="color:#400000; font-weight:bold; ">static</code> <code style="color:#400000; font-weight:bold; ">int</code> example_handler<code style="color:#806030; ">(</code>request_rec <code style="color:#806030; ">*</code>r<code style="color:#806030; ">)</code>
 286 <code style="color:#806030; ">{</code>
 287     <code style="color:#c34e00; ">/* Set the appropriate content type */</code>
 288     <a href="http://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__PROTO.html#gaa2f8412c400197338ec509f4a45e4579">ap_set_content_type</a><code style="color:#806030; ">(</code>r<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">text/html</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 289
 290     <code style="color:#c34e00; ">/* Print out the IP address of the client connecting to us: */</code>
 291     <a href="http://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__PROTO.html#ga5e91eb6ca777c9a427b2e82bf1eeb81d">ap_rprintf</a><code style="color:#806030; ">(</code>r<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">&lt;h2&gt;Hello, </code><code style="color:#0f6900; ">%s</code><code style="color:#e60000; ">!&lt;/h2&gt;</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> r<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">useragent_ip</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 292
 293     <code style="color:#c34e00; ">/* If we were reached through a GET or a POST request, be happy, else sad. */</code>
 294     <code style="color:#400000; font-weight:bold; ">if</code> <code style="color:#806030; ">(</code> <code style="color:#806030; ">!</code><code style="color:#800040; ">strcmp</code><code style="color:#806030; ">(</code>r<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">method</code><code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">POST</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code> <code style="color:#806030; ">|</code><code style="color:#806030; ">|</code> <code style="color:#806030; ">!</code><code style="color:#800040; ">strcmp</code><code style="color:#806030; ">(</code>r<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">method</code><code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">GET</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code> <code style="color:#806030; ">)</code> <code style="color:#806030; ">{</code>
 295         ap_rputs<code style="color:#806030; ">(</code><code style="color:#800000; ">"</code><code style="color:#e60000; ">You used a GET or a POST method, that makes us happy!&lt;br&gt;</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> r<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 296     <code style="color:#806030; ">}</code>
 297     <code style="color:#400000; font-weight:bold; ">else</code> <code style="color:#806030; ">{</code>
 298         ap_rputs<code style="color:#806030; ">(</code><code style="color:#800000; ">"</code><code style="color:#e60000; ">You did not use POST or GET, that makes us sad :(&lt;br&gt;</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> r<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 299     <code style="color:#806030; ">}</code>
 300
 301     <code style="color:#c34e00; ">/* Lastly, if there was a query string, let's print that too! */</code>
 302     <code style="color:#400000; font-weight:bold; ">if</code> <code style="color:#806030; ">(</code>r<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">args</code><code style="color:#806030; ">)</code> <code style="color:#806030; ">{</code>
 303         <a href="http://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__PROTO.html#ga5e91eb6ca777c9a427b2e82bf1eeb81d">ap_rprintf</a><code style="color:#806030; ">(</code>r<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">Your query string was: </code><code style="color:#0f6900; ">%s</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> r<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">args</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 304     <code style="color:#806030; ">}</code>
 305     <code style="color:#400000; font-weight:bold; ">return</code> OK<code style="color:#806030; ">;</code>
 306 <code style="color:#806030; ">}</code>
 307 </pre>
 308
 309
 310
 311 </p>
 312
 313
 314 <h3><a name="return_value" id="return_value">Return values</a></h3>
 315 <p>
 316 Apache relies on return values from handlers to signify whether a request was handled or not,
 317 and if so, whether the request went well or not. If a module is not interested in handling
 318 a specific request, it should always return the value <code>DECLINED</code>. If it is handling
 319 a request, it should either return the generic value <code>OK</code>, or a specific HTTP status
 320 code, for example:
 321
 322
 323
 324 <pre style="color:#000000;background:#ffffef;border: 1px dashed #333; padding: 0.5em; margin: 1em 2em 1em 1em;">
 325 <code style="color:#400000; font-weight:bold; ">static</code> <code style="color:#400000; font-weight:bold; ">int</code> example_handler<code style="color:#806030; ">(</code>request_rec <code style="color:#806030; ">*</code>r<code style="color:#806030; ">)</code>
 326 <code style="color:#806030; ">{</code>
 327     <code style="color:#c34e00; ">/* Return 404: Not found */</code>
 328     <code style="color:#400000; font-weight:bold; ">return</code> HTTP_NOT_FOUND<code style="color:#806030; ">;</code>
 329 <code style="color:#806030; ">}</code>
 330 </pre>
 331
 332
 333
 334 Returning <code>OK</code> or a HTTP status code does not necessarilly mean that the request will end. Apache
 335 may still have other handlers that are interested in this request, for instance the logging modules
 336 which, upon a successful request, will write down a summary of what was requested and how it went.
 337 To do a full stop and prevent any further processing after your module is done, you can return the
 338 value <code>DONE</code> to let Apache know that it should cease all activity on this request and
 339 carry on with the next, without informing other handlers.
 340 <br />
 341 <strong>General response codes:</strong>
 342 <ul>
 343 <li><code>DECLINED</code>: We are not handling this request</li>
 344 <li><code>OK</code>: We handled this request and it went well</li>
 345 <li><code>DONE</code>: We handled this request and Apache should just close this thread without further processing</li>
 346 </ul><br />
 347 <strong>HTTP specific return codes (excerpt):</strong>
 348 <ul>
 349 <li><code>HTTP_OK (200)</code>: Request was okay</li>
 350 <li><code>HTTP_MOVED_PERMANENTLY (301)</code>: The resource has moved to a new URL</li>
 351 <li><code>HTTP_UNAUTHORIZED (401)</code>: Client is not authorized to visit this page</li>
 352 <li><code>HTTP_FORBIDDEN (403)</code>: Permission denied</li>
 353 <li><code>HTTP_NOT_FOUND (404)</code>: File not found</li>
 354 <li><code>HTTP_INTERNAL_SERVER_ERROR (500)</code>: Internal server error (self explanatory)</li>
 355 </ul>
 356 </p>
 357
 358
 359 <h3><a name="functions" id="functions">Some useful functions you should know</a></h3>
 360
 361 <ul>
 362 <li>
 363     <code>ap_rputs(const char *string, request_req *r)</code>: <br />
 364     Sends a string of text to the client. This is a shorthand version of <a href="http://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__PROTO.html#gac827cd0537d2b6213a7c06d7c26cc36e">
 365     ap_rwrite</a>.
 366
 367
 368
 369 <pre style="color:#000000;background:#ffffef;border: 1px dashed #333; padding: 0.5em; margin: 1em 2em 1em 1em;">ap_rputs<code style="color:#806030; ">(</code><code style="color:#800000; ">"</code><code style="color:#e60000; ">Hello, world!</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> r<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code></pre>
 370
 371
 372
 373 </li>
 374 <li>
 375     <code>
 376     <a href="http://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__PROTO.html#ga5e91eb6ca777c9a427b2e82bf1eeb81d">ap_rprintf</a></code>: <br />
 377     This function works just like <code>printf</code>, except it sends the result to the client.
 378
 379
 380
 381 <pre style="color:#000000;background:#ffffef;border: 1px dashed #333; padding: 0.5em; margin: 1em 2em 1em 1em;"><code style="color:#2e8800; "><a href="http://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__PROTO.html#ga5e91eb6ca777c9a427b2e82bf1eeb81d">ap_rprintf</a></code><code style="color:#806030; ">(</code>r<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">Hello, </code><code style="color:#0f6900; ">%s</code><code style="color:#e60000; ">!</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> r<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">useragent_ip</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code></pre>
 382
 383
 384 </li>
 385 <li>
 386     <code>
 387     <a href="http://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__PROTO.html#gaa2f8412c400197338ec509f4a45e4579">ap_set_content_type</a>(request_req *r, const char *type)</code>: <br />
 388     Sets the content type of the output you are sending.
 389
 390
 391
 392 <pre style="color:#000000;background:#ffffef;border: 1px dashed #333; padding: 0.5em; margin: 1em 2em 1em 1em;"><code style="color:#2e8800; "><a href="http://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__PROTO.html#gaa2f8412c400197338ec509f4a45e4579">ap_set_content_type</a></code><code style="color:#806030; ">(</code>r<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">text/plain</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code> <code style="color:#c34e00; ">/* force a raw text output */</code></pre>
 393
 394
 395 </li>
 396
 397
 398 </ul>
 399
 400
 401 <h3><a name="memory" id="memory">Memory management</a></h3>
 402 <p>
 403 Managing your resources in Apache is quite easy, thanks to the memory pool system. In essence,
 404 each server, connection and request have their own memory pool that gets cleaned up when its
 405 scope ends, e.g. when a request is done or when a server process shuts down. All your module
 406 needs to do is latch onto this memory pool, and you won't have to worry about having to clean
 407 up after yourself - pretty neat, huh?</p>
 408
 409 <p>
 410 In our module, we will primarilly be allocating memory for each request, so it's appropriate to
 411 use the <code><code style="color:#008833">r-&gt;pool</code></code> reference when creating new objects. A few of the functions for
 412 allocating memory within a pool are:
 413 <ul>
 414 <li><code>void* <a href="http://apr.apache.org/docs/apr/1.4/group__apr__pools.html#ga85f1e193c31d109affda72f9a92c6915">apr_palloc</a>(
 415 apr_pool_t *p, apr_size_t size)</code>: Allocates <code>size</code> number of bytes in the pool for you</li>
 416 <li><code>void* <a href="http://apr.apache.org/docs/apr/1.4/group__apr__pools.html#gaf61c098ad258069d64cdf8c0a9369f9e">apr_pcalloc</a>(
 417 apr_pool_t *p, apr_size_t size)</code>: Allocates <code>size</code> number of bytes in the pool for you and sets all bytes to 0</li>
 418 <li><code>char* <a href="http://apr.apache.org/docs/apr/1.4/group__apr__strings.html#gabc79e99ff19abbd7cfd18308c5f85d47">apr_pstrdup</a>(
 419 apr_pool_t *p, const char *s)</code>: Creates a duplicate of the string <code>s</code>. This is useful for copying constant values so you can edit them</li>
 420 <li><code>char* <a href="http://apr.apache.org/docs/apr/1.4/group__apr__strings.html#ga3eca76b8d293c5c3f8021e45eda813d8">apr_psprintf</a>(
 421 apr_pool_t *p, const char *fmt, ...)</code>: Similar to <code>sprintf</code>, except Apache supplies you with an appropriately allocated target variable</li>
 422
 423 </ul>
 424 Let's put these functions into an example handler:<br />
 425
 426
 427
 428 <pre style="color:#000000;background:#ffffef;border: 1px dashed #333; padding: 0.5em; margin: 1em 2em 1em 1em;">
 429 <code style="color:#400000; font-weight:bold; ">static</code> <code style="color:#400000; font-weight:bold; ">int</code> example_handler<code style="color:#806030; ">(</code>request_rec <code style="color:#806030; ">*</code>r<code style="color:#806030; ">)</code>
 430 <code style="color:#806030; ">{</code>
 431     <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code><code style="color:#806030; ">*</code> original <code style="color:#806030; ">=</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">You can't edit this!</code><code style="color:#800000; ">"</code><code style="color:#806030; ">;</code>
 432     <code style="color:#c34e00; ">/* Allocate space for 10 integer values and set them all to zero. */</code>
 433     <code style="color:#400000; font-weight:bold; ">int</code><code style="color:#806030; ">*</code> integers <code style="color:#806030; ">=</code> apr_pcalloc<code style="color:#806030; ">(</code>r<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">pool</code><code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">sizeof</code><code style="color:#806030; ">(</code><code style="color:#400000; font-weight:bold; ">int</code><code style="color:#806030; ">)</code><code style="color:#806030; ">*</code><code style="color:#c00000; ">10</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 434
 435     <code style="color:#c34e00; ">/* Create a copy of the 'original' variable that we can edit. */</code>
 436     <code style="color:#400000; font-weight:bold; ">char</code><code style="color:#806030; ">*</code> copy <code style="color:#806030; ">=</code> apr_pstrdup<code style="color:#806030; ">(</code>r<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">pool</code><code style="color:#806030; ">,</code> original<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 437     <code style="color:#400000; font-weight:bold; ">return</code> OK<code style="color:#806030; ">;</code>
 438 <code style="color:#806030; ">}</code>
 439 </pre>
 440
 441
 442 This is all well and good for our module, which won't need any pre-initialized variables or structures.
 443 However, if we wanted to initialize something early on, before the requests come rolling in, we could
 444 simply add a call to a function in our <code>register_hooks</code> function to sort it out:
 445
 446
 447 <pre style="color:#000000;background:#ffffef;border: 1px dashed #333; padding: 0.5em; margin: 1em 2em 1em 1em;">
 448 <code style="color:#400000; font-weight:bold; ">static</code> <code style="color:#400000; font-weight:bold; ">void</code> register_hooks<code style="color:#806030; ">(</code>apr_pool_t <code style="color:#806030; ">*</code>pool<code style="color:#806030; ">)</code>
 449 <code style="color:#806030; ">{</code>
 450     <code style="color:#c34e00; ">/* Call a function that initializes some stuff */</code>
 451     <code style="color:#800040; ">example_init_function</code><code style="color:#806030; ">(</code>pool<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 452     <code style="color:#c34e00; ">/* Create a hook in the request handler, so we get called when a request arrives */</code>
 453     <code style="color:#800040; ">ap_hook_handler</code><code style="color:#806030; ">(</code>example_handler<code style="color:#806030; ">,</code> <code style="color:#7f0055; font-weight:bold; ">NULL</code><code style="color:#806030; ">,</code> <code style="color:#7f0055; font-weight:bold; ">NULL</code><code style="color:#806030; ">,</code> APR_HOOK_LAST<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 454 <code style="color:#806030; ">}</code>
 455 </pre>
 456
 457
 458 In this, pre-request initialization function, we would not be using the same pool as we did when
 459 allocating resources for request-based functions. Instead, we would use the pool given to us by
 460 Apache for allocating memory on a per-process based level.
 461
 462 </p>
 463
 464
 465 <h3><a name="parsing" id="parsing">Parsing request data</a></h3>
 466 <p>
 467 In our example module, we would like to add a feature, that checks which type of digest, MD5 or SHA1
 468 the client would like to see. This could be solved by adding a query string to the request. A query
 469 string is typically comprised of several keys and values put together in a string, for instance
 470 <code>valueA=yes&amp;valueB=no&amp;valueC=maybe</code>. It is up to the module itself to parse these
 471 and get the data it requires. In our example, we'll be looking for a key called <code>digest</code>,
 472 and if set to <code>md5</code>, we'll produce an MD5 digest, otherwise we'll produce a SHA1 digest.
 473 </p>
 474 <p>
 475 Since the introduction of Apache 2.4, parsing request data from GET and POST requests have never
 476 been easier. All we require to parse both GET and POST data is four simple lines:
 477
 478
 479
 480 <pre style="color:#000000;background:#ffffef;border: 1px dashed #333; padding: 0.5em; margin: 1em 2em 1em 1em;">
 481 <a href="http://ci.apache.org/projects/httpd/trunk/doxygen/group__apr__tables.html#gad7ea82d6608a4a633fc3775694ab71e4">apr_table_t</a> *GET;
 482 <a href="http://ci.apache.org/projects/httpd/trunk/doxygen/structapr__array__header__t.html">apr_array_header_t</a> *POST;
 483
 484 <a href="http://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__SCRIPT.html#gaed25877b529623a4d8f99f819ba1b7bd">ap_args_to_table</a>(r, &amp;GET);
 485 <a href="http://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__DAEMON.html#ga9d426b6382b49754d4f87c55f65af202">ap_parse_form_data</a>(r, <code style="color:#7f0055; font-weight:bold; ">NULL</code>, &amp;POST, -1, 8192);
 486 </pre>
 487
 488
 489
 490 In our specific example module, we're looking for the <code>digest</code> value from the query string,
 491 which now resides inside a table called <code>GET</code>. To extract this value, we need only perform
 492 a simple operation:<br />
 493
 494
 495
 496 <pre style="color:#000000;background:#ffffef;border: 1px dashed #333; padding: 0.5em; margin: 1em 2em 1em 1em;">
 497 <code style="color:#c34e00; ">/* Get the "digest" key from the query string, if any. */</code>
 498 <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code><code style="color:#806030; "> *</code>digestType <code style="color:#806030; ">=</code> <a href="http://ci.apache.org/projects/httpd/trunk/doxygen/group__apr__tables.html#ga4db13e3915c6b9a3142b175d4c15d915">apr_table_get</a><code style="color:#806030; ">(</code>GET<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">digest</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 499
 500 <code style="color:#c34e00; ">/* If no key was returned, we will set a default value instead. */</code>
 501 <code style="color:#400000; font-weight:bold; ">if</code> <code style="color:#806030; ">(</code><code style="color:#806030; ">!</code>digestType<code style="color:#806030; ">)</code> digestType <code style="color:#806030; ">=</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">sha1</code><code style="color:#800000; ">"</code><code style="color:#806030; ">;</code>
 502
 503 </pre>
 504
 505
 506
 507 The structures used for the POST and GET data are not exactly the same, so if we were to fetch a value from
 508 POST data instead of the query string, we would have to resort to a few more lines, as outlined in
 509 <a href="#get_post">this example</a> in the last chapter of this document.
 510 </p>
 511
 512
 513 <h3><a name="advanced_handler" id="advanced_handler">Making an advanced handler</a></h3>
 514 Now that we have learned how to parse form data and manage our resources, we can move on to creating an advanced
 515 version of our module, that spits out the MD5 or SHA1 digest of files:<br />
 516
 517
 518
 519 <pre style="color:#000000;background:#ffffef;border: 1px dashed #333; padding: 0.5em; margin: 1em 2em 1em 1em;">
 520 <code style="color:#400000; font-weight:bold; ">static</code> <code style="color:#400000; font-weight:bold; ">int</code> example_handler<code style="color:#806030; ">(</code>request_rec <code style="color:#806030; ">*</code>r<code style="color:#806030; ">)</code>
 521 <code style="color:#806030; ">{</code>
 522     <code style="color:#400000; font-weight:bold; ">int</code> rc<code style="color:#806030; ">,</code> exists<code style="color:#806030; ">;</code>
 523     apr_finfo_t finfo<code style="color:#806030; ">;</code>
 524     apr_file_t<code style="color:#806030; "> *</code>file<code style="color:#806030; ">;</code>
 525     <code style="color:#400000; font-weight:bold; ">char</code> <code style="color:#806030; ">*</code>filename<code style="color:#806030; ">;</code>
 526     <code style="color:#400000; font-weight:bold; ">char</code> buffer<code style="color:#806030; ">[</code><code style="color:#c00000; ">256</code><code style="color:#806030; ">]</code><code style="color:#806030; ">;</code>
 527     apr_size_t readBytes<code style="color:#806030; ">;</code>
 528     <code style="color:#400000; font-weight:bold; ">int</code> n<code style="color:#806030; ">;</code>
 529     apr_table_t<code style="color:#806030; "> *</code>GET<code style="color:#806030; ">;</code>
 530     apr_array_header_t<code style="color:#806030; "> *</code>POST<code style="color:#806030; ">;</code>
 531     <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code><code style="color:#806030; "> *</code>digestType<code style="color:#806030; ">;</code>
 532
 533
 534     <code style="color:#c34e00; ">/* Check that the "example-handler" handler is being called. */</code>
 535     <code style="color:#400000; font-weight:bold; ">if</code> <code style="color:#806030; ">(</code><code style="color:#806030; ">!</code>r<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">handler</code> <code style="color:#806030; ">|</code><code style="color:#806030; ">|</code> <code style="color:#800040; ">strcmp</code><code style="color:#806030; ">(</code>r<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">handler</code><code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">example-handler</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">)</code> <code style="color:#400000; font-weight:bold; ">return</code> <code style="color:#806030; ">(</code>DECLINED<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 536
 537     <code style="color:#c34e00; ">/* Figure out which file is being requested by removing the .sum from it */</code>
 538     filename <code style="color:#806030; ">=</code> apr_pstrdup<code style="color:#806030; ">(</code>r<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">pool</code><code style="color:#806030; ">,</code> r<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">filename</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 539     filename<code style="color:#806030; ">[</code><code style="color:#800040; ">strlen</code><code style="color:#806030; ">(</code>filename<code style="color:#806030; ">)</code><code style="color:#806030; ">-</code><code style="color:#c00000; ">4</code><code style="color:#806030; ">]</code> <code style="color:#806030; ">=</code> <code style="color:#c00000; ">0</code><code style="color:#806030; ">;</code> <code style="color:#c34e00; ">/* Cut off the last 4 characters. */</code>
 540
 541     <code style="color:#c34e00; ">/* Figure out if the file we request a sum on exists and isn't a directory */</code>
 542     rc <code style="color:#806030; ">=</code> apr_stat<code style="color:#806030; ">(</code><code style="color:#806030; ">&amp;</code>finfo<code style="color:#806030; ">,</code> filename<code style="color:#806030; ">,</code> APR_FINFO_MIN<code style="color:#806030; ">,</code> r<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">pool</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 543     <code style="color:#400000; font-weight:bold; ">if</code> <code style="color:#806030; ">(</code>rc <code style="color:#806030; ">=</code><code style="color:#806030; ">=</code> APR_SUCCESS<code style="color:#806030; ">)</code> <code style="color:#806030; ">{</code>
 544         exists <code style="color:#806030; ">=</code>
 545         <code style="color:#806030; ">(</code>
 546             <code style="color:#806030; ">(</code>finfo<code style="color:#806030; ">.</code>filetype <code style="color:#806030; ">!</code><code style="color:#806030; ">=</code> APR_NOFILE<code style="color:#806030; ">)</code>
 547         <code style="color:#806030; ">&amp;</code><code style="color:#806030; ">&amp;</code>  <code style="color:#806030; ">!</code><code style="color:#806030; ">(</code>finfo<code style="color:#806030; ">.</code>filetype <code style="color:#806030; ">&amp;</code> APR_DIR<code style="color:#806030; ">)</code>
 548         <code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 549         <code style="color:#400000; font-weight:bold; ">if</code> <code style="color:#806030; ">(</code><code style="color:#806030; ">!</code>exists<code style="color:#806030; ">)</code> <code style="color:#400000; font-weight:bold; ">return</code> HTTP_NOT_FOUND<code style="color:#806030; ">;</code> <code style="color:#c34e00; ">/* Return a 404 if not found. */</code>
 550     <code style="color:#806030; ">}</code>
 551     <code style="color:#c34e00; ">/* If apr_stat failed, we're probably not allowed to check this file. */</code>
 552     <code style="color:#400000; font-weight:bold; ">else</code> <code style="color:#400000; font-weight:bold; ">return</code> HTTP_FORBIDDEN<code style="color:#806030; ">;</code>
 553
 554     <code style="color:#c34e00; ">/* Parse the GET and, optionally, the POST data sent to us */</code>
 555
 556     ap_args_to_table<code style="color:#806030; ">(</code>r<code style="color:#806030; ">,</code> <code style="color:#806030; ">&amp;</code>GET<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 557     ap_parse_form_data<code style="color:#806030; ">(</code>r<code style="color:#806030; ">,</code> <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">,</code> <code style="color:#806030; ">&amp;</code>POST<code style="color:#806030; ">,</code> <code style="color:#806030; ">-</code><code style="color:#c00000; ">1</code><code style="color:#806030; ">,</code> <code style="color:#c00000; ">8192</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 558
 559     <code style="color:#c34e00; ">/* Set the appropriate content type */</code>
 560     ap_set_content_type<code style="color:#806030; ">(</code>r<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">text/html</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 561
 562     <code style="color:#c34e00; ">/* Print a title and some general information */</code>
 563     ap_rprintf<code style="color:#806030; ">(</code>r<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">&lt;h2&gt;Information on </code><code style="color:#0f6900; ">%s</code><code style="color:#e60000; ">:&lt;/h2&gt;</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> filename<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 564     ap_rprintf<code style="color:#806030; ">(</code>r<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">&lt;b&gt;Size:&lt;/b&gt; </code><code style="color:#0f6900; ">%u</code><code style="color:#e60000; "> bytes&lt;br/&gt;</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> finfo<code style="color:#806030; ">.</code>size<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 565
 566     <code style="color:#c34e00; ">/* Get the digest type the client wants to see */</code>
 567     digestType <code style="color:#806030; ">=</code> apr_table_get<code style="color:#806030; ">(</code>GET<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">digest</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 568     <code style="color:#400000; font-weight:bold; ">if</code> <code style="color:#806030; ">(</code><code style="color:#806030; ">!</code>digestType<code style="color:#806030; ">)</code> digestType <code style="color:#806030; ">=</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">MD5</code><code style="color:#800000; ">"</code><code style="color:#806030; ">;</code>
 569
 570
 571     rc <code style="color:#806030; ">=</code> apr_file_open<code style="color:#806030; ">(</code><code style="color:#806030; ">&amp;</code>file<code style="color:#806030; ">,</code> filename<code style="color:#806030; ">,</code> APR_READ<code style="color:#806030; ">,</code> APR_OS_DEFAULT<code style="color:#806030; ">,</code> r<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">pool</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 572     <code style="color:#400000; font-weight:bold; ">if</code> <code style="color:#806030; ">(</code>rc <code style="color:#806030; ">=</code><code style="color:#806030; ">=</code> APR_SUCCESS<code style="color:#806030; ">)</code> <code style="color:#806030; ">{</code>
 573
 574         <code style="color:#c34e00; ">/* Are we trying to calculate the MD5 or the SHA1 digest? */</code>
 575         <code style="color:#400000; font-weight:bold; ">if</code> <code style="color:#806030; ">(</code><code style="color:#806030; ">!</code>strcasecmp<code style="color:#806030; ">(</code>digestType<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">md5</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">)</code> <code style="color:#806030; ">{</code>
 576             <code style="color:#c34e00; ">/* Calculate the MD5 sum of the file */</code>
 577             <code style="color:#400000; font-weight:bold; ">union</code> <code style="color:#806030; ">{</code>
 578                 <code style="color:#400000; font-weight:bold; ">char</code>      chr<code style="color:#806030; ">[</code><code style="color:#c00000; ">16</code><code style="color:#806030; ">]</code><code style="color:#806030; ">;</code>
 579                 uint32_t  num<code style="color:#806030; ">[</code><code style="color:#c00000; ">4</code><code style="color:#806030; ">]</code><code style="color:#806030; ">;</code>
 580             <code style="color:#806030; ">}</code> digest<code style="color:#806030; ">;</code>
 581             apr_md5_ctx_t md5<code style="color:#806030; ">;</code>
 582             apr_md5_init<code style="color:#806030; ">(</code><code style="color:#806030; ">&amp;</code>md5<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 583             readBytes <code style="color:#806030; ">=</code> <code style="color:#c00000; ">256</code><code style="color:#806030; ">;</code>
 584             <code style="color:#400000; font-weight:bold; ">while</code> <code style="color:#806030; ">(</code> apr_file_read<code style="color:#806030; ">(</code>file<code style="color:#806030; ">,</code> buffer<code style="color:#806030; ">,</code> <code style="color:#806030; ">&amp;</code>readBytes<code style="color:#806030; ">)</code> <code style="color:#806030; ">=</code><code style="color:#806030; ">=</code> APR_SUCCESS <code style="color:#806030; ">)</code> <code style="color:#806030; ">{</code>
 585                 apr_md5_update<code style="color:#806030; ">(</code><code style="color:#806030; ">&amp;</code>md5<code style="color:#806030; ">,</code> buffer<code style="color:#806030; ">,</code> readBytes<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 586             <code style="color:#806030; ">}</code>
 587             apr_md5_final<code style="color:#806030; ">(</code>digest<code style="color:#806030; ">.</code>chr<code style="color:#806030; ">,</code> <code style="color:#806030; ">&amp;</code>md5<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 588
 589             <code style="color:#c34e00; ">/* Print out the MD5 digest */</code>
 590             ap_rputs<code style="color:#806030; ">(</code><code style="color:#800000; ">"</code><code style="color:#e60000; ">&lt;b&gt;MD5: &lt;/b&gt;&lt;code&gt;</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> r<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 591             <code style="color:#400000; font-weight:bold; ">for</code> <code style="color:#806030; ">(</code>n <code style="color:#806030; ">=</code> <code style="color:#c00000; ">0</code><code style="color:#806030; ">;</code> n <code style="color:#806030; ">&lt;</code> APR_MD5_DIGESTSIZE<code style="color:#806030; ">/</code><code style="color:#c00000; ">4</code><code style="color:#806030; ">;</code> n<code style="color:#806030; ">+</code><code style="color:#806030; ">+</code><code style="color:#806030; ">)</code> <code style="color:#806030; ">{</code>
 592                 ap_rprintf<code style="color:#806030; ">(</code>r<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#0f6900; ">%08x</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> digest<code style="color:#806030; ">.</code>num<code style="color:#806030; ">[</code>n<code style="color:#806030; ">]</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 593             <code style="color:#806030; ">}</code>
 594             ap_rputs<code style="color:#806030; ">(</code><code style="color:#800000; ">"</code><code style="color:#e60000; ">&lt;/code&gt;</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> r<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 595             <code style="color:#c34e00; ">/* Print a link to the SHA1 version */</code>
 596             ap_rputs<code style="color:#806030; ">(</code><code style="color:#800000; ">"</code><code style="color:#e60000; ">&lt;br/&gt;&lt;a href='?digest=sha1'&gt;View the SHA1 hash instead&lt;/a&gt;</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> r<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 597         <code style="color:#806030; ">}</code>
 598         <code style="color:#400000; font-weight:bold; ">else</code> <code style="color:#806030; ">{</code>
 599             <code style="color:#c34e00; ">/* Calculate the SHA1 sum of the file */</code>
 600             <code style="color:#400000; font-weight:bold; ">union</code> <code style="color:#806030; ">{</code>
 601                 <code style="color:#400000; font-weight:bold; ">char</code>      chr<code style="color:#806030; ">[</code><code style="color:#c00000; ">20</code><code style="color:#806030; ">]</code><code style="color:#806030; ">;</code>
 602                 uint32_t  num<code style="color:#806030; ">[</code><code style="color:#c00000; ">5</code><code style="color:#806030; ">]</code><code style="color:#806030; ">;</code>
 603             <code style="color:#806030; ">}</code> digest<code style="color:#806030; ">;</code>
 604             apr_sha1_ctx_t sha1<code style="color:#806030; ">;</code>
 605             apr_sha1_init<code style="color:#806030; ">(</code><code style="color:#806030; ">&amp;</code>sha1<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 606             readBytes <code style="color:#806030; ">=</code> <code style="color:#c00000; ">256</code><code style="color:#806030; ">;</code>
 607             <code style="color:#400000; font-weight:bold; ">while</code> <code style="color:#806030; ">(</code> apr_file_read<code style="color:#806030; ">(</code>file<code style="color:#806030; ">,</code> buffer<code style="color:#806030; ">,</code> <code style="color:#806030; ">&amp;</code>readBytes<code style="color:#806030; ">)</code> <code style="color:#806030; ">=</code><code style="color:#806030; ">=</code> APR_SUCCESS <code style="color:#806030; ">)</code> <code style="color:#806030; ">{</code>
 608                 apr_sha1_update<code style="color:#806030; ">(</code><code style="color:#806030; ">&amp;</code>sha1<code style="color:#806030; ">,</code> buffer<code style="color:#806030; ">,</code> readBytes<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 609             <code style="color:#806030; ">}</code>
 610             apr_sha1_final<code style="color:#806030; ">(</code>digest<code style="color:#806030; ">.</code>chr<code style="color:#806030; ">,</code> <code style="color:#806030; ">&amp;</code>sha1<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 611
 612             <code style="color:#c34e00; ">/* Print out the SHA1 digest */</code>
 613             ap_rputs<code style="color:#806030; ">(</code><code style="color:#800000; ">"</code><code style="color:#e60000; ">&lt;b&gt;SHA1: &lt;/b&gt;&lt;code&gt;</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> r<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 614             <code style="color:#400000; font-weight:bold; ">for</code> <code style="color:#806030; ">(</code>n <code style="color:#806030; ">=</code> <code style="color:#c00000; ">0</code><code style="color:#806030; ">;</code> n <code style="color:#806030; ">&lt;</code> APR_SHA1_DIGESTSIZE<code style="color:#806030; ">/</code><code style="color:#c00000; ">4</code><code style="color:#806030; ">;</code> n<code style="color:#806030; ">+</code><code style="color:#806030; ">+</code><code style="color:#806030; ">)</code> <code style="color:#806030; ">{</code>
 615                 ap_rprintf<code style="color:#806030; ">(</code>r<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#0f6900; ">%08x</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> digest<code style="color:#806030; ">.</code>num<code style="color:#806030; ">[</code>n<code style="color:#806030; ">]</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 616             <code style="color:#806030; ">}</code>
 617             ap_rputs<code style="color:#806030; ">(</code><code style="color:#800000; ">"</code><code style="color:#e60000; ">&lt;/code&gt;</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> r<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 618
 619             <code style="color:#c34e00; ">/* Print a link to the MD5 version */</code>
 620             ap_rputs<code style="color:#806030; ">(</code><code style="color:#800000; ">"</code><code style="color:#e60000; ">&lt;br/&gt;&lt;a href='?digest=md5'&gt;View the MD5 hash instead&lt;/a&gt;</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> r<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 621         <code style="color:#806030; ">}</code>
 622         apr_file_close<code style="color:#806030; ">(</code>file<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 623
 624     <code style="color:#806030; ">}</code>
 625
 626
 627
 628     <code style="color:#c34e00; ">/* Let Apache know that we responded to this request. */</code>
 629     <code style="color:#400000; font-weight:bold; ">return</code> OK<code style="color:#806030; ">;</code>
 630 <code style="color:#806030; ">}</code>
 631 </pre>
 632
 633
 634
 635 This version in its entirity can be found here: <a href="mod_example_2.c">mod_example_2.c</a>.
 636
 637
 638 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 639 <div class="section">
 640 <h2><a name="configuration" id="configuration">Adding configuration options</a></h2>
 641 <p>
 642 In this next segment of this document, we will turn our eyes away from the digest module and create a new
 643 example module, whose only function is to write out its own configuration. The purpose of this is to
 644 examine how Apache works with configuration, and what happens when you start writing advanced configurations
 645 for your modules.
 646 </p>
 647 <h3><a name="config_intro" id="config_intro">An introduction to configuration directives</a></h3>
 648 If you are reading this, then you probably already know what a configuration directive is. Simply put,
 649 a directive is a way of telling an individual module (or a set of modules) how to behave, such as these
 650 directives control how <code>mod_rewrite</code> works:
 651 <div class="example"><pre>
 652 RewriteEngine On
 653 RewriteCond %{REQUEST_URI} ^/foo/bar
 654 RewriteRule ^/foo/bar/(.*)$ /foobar?page=$1
 655 </pre></div>
 656 Each of these configuration directives are handled by a separate function, that parses the parameters given
 657 and sets up a configuration accordingly.
 658
 659 <h3><a name="config_simple" id="config_simple">Making an example configuration</a></h3>
 660 To begin with, we'll create a basic configuration in C-space:
 661
 662
 663
 664 <pre style="color:#000000;background:#ffffef;border: 1px dashed #333; padding: 0.5em; margin: 1em 2em 1em 1em;">
 665 <code style="color:#400000; font-weight:bold; ">typedef</code> <code style="color:#400000; font-weight:bold; ">struct</code> <code style="color:#806030; ">{</code>
 666     <code style="color:#400000; font-weight:bold; ">int</code>         enabled<code style="color:#806030; ">;</code>      <code style="color:#c34e00; ">/* Enable or disable our module */</code>
 667     <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code> <code style="color:#806030; ">*</code>path<code style="color:#806030; ">;</code>         <code style="color:#c34e00; ">/* Some path to...something */</code>
 668     <code style="color:#400000; font-weight:bold; ">int</code>         typeOfAction<code style="color:#806030; ">;</code> <code style="color:#c34e00; ">/* 1 means action A, 2 means action B and so on */</code>
 669 <code style="color:#806030; ">}</code> example_config<code style="color:#806030; ">;</code>
 670 </pre>
 671
 672
 673
 674 Now, let's put this into perspective by creating a very small module that just prints out a hard-coded
 675 configuration. You'll notice that we use the <code>register_hooks</code> function for initializing the
 676 configuration values to their defaults:
 677
 678
 679
 680 <pre style="color:#000000;background:#ffffef;border: 1px dashed #333; padding: 0.5em; margin: 1em 2em 1em 1em;">
 681 <code style="color:#400000; font-weight:bold; ">typedef</code> <code style="color:#400000; font-weight:bold; ">struct</code> <code style="color:#806030; ">{</code>
 682     <code style="color:#400000; font-weight:bold; ">int</code>         enabled<code style="color:#806030; ">;</code>      <code style="color:#c34e00; ">/* Enable or disable our module */</code>
 683     <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code> <code style="color:#806030; ">*</code>path<code style="color:#806030; ">;</code>         <code style="color:#c34e00; ">/* Some path to...something */</code>
 684     <code style="color:#400000; font-weight:bold; ">int</code>         typeOfAction<code style="color:#806030; ">;</code> <code style="color:#c34e00; ">/* 1 means action A, 2 means action B and so on */</code>
 685 <code style="color:#806030; ">}</code> example_config<code style="color:#806030; ">;</code>
 686
 687 <code style="color:#400000; font-weight:bold; ">static</code> example_config config<code style="color:#806030; ">;</code>
 688
 689 <code style="color:#400000; font-weight:bold; ">static</code> <code style="color:#400000; font-weight:bold; ">int</code> example_handler<code style="color:#806030; ">(</code>request_rec <code style="color:#806030; ">*</code>r<code style="color:#806030; ">)</code>
 690 <code style="color:#806030; ">{</code>
 691     <code style="color:#400000; font-weight:bold; ">if</code> <code style="color:#806030; ">(</code><code style="color:#806030; ">!</code>r<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">handler</code> <code style="color:#806030; ">|</code><code style="color:#806030; ">|</code> <code style="color:#800040; ">strcmp</code><code style="color:#806030; ">(</code>r<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">handler</code><code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">example-handler</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">)</code> <code style="color:#400000; font-weight:bold; ">return</code><code style="color:#806030; ">(</code>DECLINED<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 692     ap_set_content_type<code style="color:#806030; ">(</code>r<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">text/plain</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 693     ap_rprintf<code style="color:#806030; ">(r, </code><code style="color:#800000; ">"</code><code style="color:#e60000; ">Enabled: </code><code style="color:#0f6900; ">%u</code><code style="color:#0f6900; ">\n</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> config<code style="color:#806030; ">.</code>enabled<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 694     ap_rprintf<code style="color:#806030; ">(r, </code><code style="color:#800000; ">"</code><code style="color:#e60000; ">Path: </code><code style="color:#0f6900; ">%s</code><code style="color:#0f6900; ">\n</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> config<code style="color:#806030; ">.</code>path<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 695     ap_rprintf<code style="color:#806030; ">(r, </code><code style="color:#800000; ">"</code><code style="color:#e60000; ">TypeOfAction: </code><code style="color:#0f6900; ">%x</code><code style="color:#0f6900; ">\n</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> config<code style="color:#806030; ">.</code>typeOfAction<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 696     <code style="color:#400000; font-weight:bold; ">return</code> OK<code style="color:#806030; ">;</code>
 697 <code style="color:#806030; ">}</code>
 698
 699 <code style="color:#400000; font-weight:bold; ">static</code> <code style="color:#400000; font-weight:bold; ">void</code> register_hooks<code style="color:#806030; ">(</code>apr_pool_t <code style="color:#806030; ">*</code>pool<code style="color:#806030; ">)</code>
 700 <code style="color:#806030; ">{</code>
 701     config<code style="color:#806030; ">.</code>enabled <code style="color:#806030; ">=</code> <code style="color:#c00000; ">1</code><code style="color:#806030; ">;</code>
 702     config<code style="color:#806030; ">.</code>path <code style="color:#806030; ">=</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">/foo/bar</code><code style="color:#800000; ">"</code><code style="color:#806030; ">;</code>
 703     config<code style="color:#806030; ">.</code>typeOfAction <code style="color:#806030; ">=</code> <code style="color:#c00000; ">0x00</code><code style="color:#806030; ">;</code>
 704     ap_hook_handler<code style="color:#806030; ">(</code>example_handler<code style="color:#806030; ">,</code> <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">,</code> <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">,</code> APR_HOOK_LAST<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 705 <code style="color:#806030; ">}</code>
 706
 707 <code style="color:#c34e00; ">/* Define our module as an entity and assign a function for registering hooks  */</code>
 708
 709 module AP_MODULE_DECLARE_DATA   example_module <code style="color:#806030; ">=</code>
 710 <code style="color:#806030; ">{</code>
 711     STANDARD20_MODULE_STUFF<code style="color:#806030; ">,</code>
 712     <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">,</code>            <code style="color:#c34e00; ">/* Per-directory configuration handler */</code>
 713     <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">,</code>            <code style="color:#c34e00; ">/* Merge handler for per-directory configurations */</code>
 714     <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">,</code>            <code style="color:#c34e00; ">/* Per-server configuration handler */</code>
 715     <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">,</code>            <code style="color:#c34e00; ">/* Merge handler for per-server configurations */</code>
 716     <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">,</code>            <code style="color:#c34e00; ">/* Any directives we may have for httpd */</code>
 717     register_hooks   <code style="color:#c34e00; ">/* Our hook registering function */</code>
 718 <code style="color:#806030; ">}</code><code style="color:#806030; ">;</code>
 719 </pre>
 720
 721
 722
 723 So far so good. To access our new handler, we could add the following to our configuration:
 724 <div class="example"><pre>
 725 &lt;Location /example&gt;
 726     SetHandler example-handler
 727 &lt;/Location&gt;
 728 </pre></div>
 729 When we visit, we'll see our current configuration being spit out by our module.
 730
 731
 732 <h3><a name="register_directive" id="register_directive">Registering directives with Apache</a></h3>
 733 What if we want to change our configuration, not by hard-coding new values into the module,
 734 but by using either the httpd.conf file or possibly a .htaccess file? It's time to let Apache
 735 know that we want this to be possible. To do so, we must first change our <em>name tag</em>
 736 to include a reference to the configuration directives we want to register with Apache:
 737
 738
 739
 740 <pre style="color:#000000;background:#ffffef;border: 1px dashed #333; padding: 0.5em; margin: 1em 2em 1em 1em;">
 741 module AP_MODULE_DECLARE_DATA   example_module =
 742 {
 743     STANDARD20_MODULE_STUFF,
 744     <code style="color:#7f0055; font-weight:bold; ">NULL</code>,               <code style="color:#c34e00; ">/* Per-directory configuration handler */</code>
 745     <code style="color:#7f0055; font-weight:bold; ">NULL</code>,               <code style="color:#c34e00; ">/* Merge handler for per-directory configurations */</code>
 746     <code style="color:#7f0055; font-weight:bold; ">NULL</code>,               <code style="color:#c34e00; ">/* Per-server configuration handler */</code>
 747     <code style="color:#7f0055; font-weight:bold; ">NULL</code>,               <code style="color:#c34e00; ">/* Merge handler for per-server configurations */</code>
 748     example_directives, <code style="color:#c34e00; ">/* Any directives we may have for httpd */</code>
 749     register_hooks      <code style="color:#c34e00; ">/* Our hook registering function */</code>
 750 };
 751 </pre>
 752
 753
 754
 755 This will tell Apache that we are now accepting directives from the configuration files, and that the
 756 structure called <code>example_directives</code> holds information on what our directives are and how
 757 they work. Since we have three different variables in our module configuration, we will add a structure
 758 with three directives and a NULL at the end:
 759
 760
 761
 762 <pre style="color:#000000;background:#ffffef;border: 1px dashed #333; padding: 0.5em; margin: 1em 2em 1em 1em;">
 763 static const command_rec        example_directives[] =
 764 {
 765     <code style="color:#2e8800; "><a href="http://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__CONFIG.html#ga07c7d22ae17805e61204463326cf9c34">AP_INIT_TAKE1</a></code>("exampleEnabled", example_set_enabled, <code style="color:#7f0055; font-weight:bold; ">NULL</code>, RSRC_CONF, "Enable or disable mod_example"),
 766     <code style="color:#2e8800; "><a href="http://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__CONFIG.html#ga07c7d22ae17805e61204463326cf9c34">AP_INIT_TAKE1</a></code>("examplePath", example_set_path, <code style="color:#7f0055; font-weight:bold; ">NULL</code>, RSRC_CONF, "The path to whatever"),
 767     <code style="color:#2e8800; "><a href="http://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__CONFIG.html#gafaec43534fcf200f37d9fecbf9247c21">AP_INIT_TAKE2</a></code>("exampleAction", example_set_action, <code style="color:#7f0055; font-weight:bold; ">NULL</code>, RSRC_CONF, "Special action value!"),
 768     { <code style="color:#7f0055; font-weight:bold; ">NULL</code> }
 769 };
 770 </pre>
 771
 772
 773
 774 <img src="../images/build_a_mod_4.png" border="1" /><br />
 775 <p>
 776 As you can see, each directive needs at least 5 parameters set:
 777 <ol>
 778 <li><code><a href="http://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__CONFIG.html#ga07c7d22ae17805e61204463326cf9c34">AP_INIT_TAKE1</a></code>: This is a macro that tells Apache that this directive takes one and only one argument.
 779 If we required two arguments, we could use the macro <code><a href="http://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__CONFIG.html#gafaec43534fcf200f37d9fecbf9247c21">AP_INIT_TAKE2</a></code> and so on (refer to httpd_conf.h
 780 for more macros).</li>
 781 <li><code>exampleEnabled</code>: This is the name of our directive. More precisely, it is what the user must put in his/her
 782 configuration in order to invoke a configuration change in our module.</li>
 783 <li><code>example_set_enabled</code>: This is a reference to a C function that parses the directive and sets the configuration
 784 accordingly. We will discuss how to make this in the following paragraph.</li>
 785 <li><code>RSRC_CONF</code>: This tells Apache where the directive is permissable. We'll go into details on this value in the
 786 later chapters, but for now, <code>RSRC_CONF</code> means that Apache will only accept these directives in a server context.</li>
 787 <li><code>"Enable or disable...."</code>: This is simply a brief description of what the directive does.</li>
 788 </ol>
 789 (<em>The "missing" parameter in our definition, which is usually set to <code>NULL</code>, is an optional function that can be
 790 run after the initial function to parse the arguments have been run. This is usually omitted, as the function for verifying
 791 arguments might as well be used to set them.</em>)
 792 </p>
 793
 794 <h3><a name="directive_handler" id="directive_handler">The directive handler function</a></h3>
 795 <p>
 796 Now that we've told Apache to expect some directives for our module, it's time to make a few functions for handling these. What
 797 Apache reads in the configuration file(s) is text, and so naturally, what it passes along to our directive handler is one or
 798 more strings, that we ourselves need to recognize and act upon. You'll notice, that since we set our <code>exampleAction</code>
 799 directive to accept two arguments, its C function also has an additional parameter defined:<br />
 800
 801
 802
 803 <pre style="color:#000000;background:#ffffef;border: 1px dashed #333; padding: 0.5em; margin: 1em 2em 1em 1em;">
 804 <code style="color:#c34e00; ">/* Handler for the "exambleEnabled" directive */</code>
 805 <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code><code style="color:#806030; "> *</code>example_set_enabled<code style="color:#806030; ">(</code>cmd_parms <code style="color:#806030; ">*</code>cmd<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">void</code> <code style="color:#806030; ">*</code>cfg<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code> <code style="color:#806030; ">*</code>arg<code style="color:#806030; ">)</code>
 806 <code style="color:#806030; ">{</code>
 807     <code style="color:#400000; font-weight:bold; ">if</code><code style="color:#806030; ">(</code><code style="color:#806030; ">!</code>strcasecmp<code style="color:#806030; ">(</code>arg<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">on</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">)</code> config<code style="color:#806030; ">.</code>enabled <code style="color:#806030; ">=</code> <code style="color:#c00000; ">1</code><code style="color:#806030; ">;</code>
 808     <code style="color:#400000; font-weight:bold; ">else</code> config<code style="color:#806030; ">.</code>enabled <code style="color:#806030; ">=</code> <code style="color:#c00000; ">0</code><code style="color:#806030; ">;</code>
 809     <code style="color:#400000; font-weight:bold; ">return</code> <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">;</code>
 810 <code style="color:#806030; ">}</code>
 811
 812 <code style="color:#c34e00; ">/* Handler for the "examplePath" directive */</code>
 813 <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code><code style="color:#806030; "> *</code>example_set_path<code style="color:#806030; ">(</code>cmd_parms <code style="color:#806030; ">*</code>cmd<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">void</code> <code style="color:#806030; ">*</code>cfg<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code> <code style="color:#806030; ">*</code>arg<code style="color:#806030; ">)</code>
 814 <code style="color:#806030; ">{</code>
 815     config<code style="color:#806030; ">.</code>path <code style="color:#806030; ">=</code> arg<code style="color:#806030; ">;</code>
 816     <code style="color:#400000; font-weight:bold; ">return</code> <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">;</code>
 817 <code style="color:#806030; ">}</code>
 818
 819 <code style="color:#c34e00; ">/* Handler for the "exampleAction" directive */</code>
 820 <code style="color:#c34e00; ">/* Let's pretend this one takes one argument (file or db), and a second (deny or allow), */</code>
 821 <code style="color:#c34e00; ">/* and we store it in a bit-wise manner. */</code>
 822 <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code><code style="color:#806030; "> *</code>example_set_action<code style="color:#806030; ">(</code>cmd_parms <code style="color:#806030; ">*</code>cmd<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">void</code> <code style="color:#806030; ">*</code>cfg<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code> <code style="color:#806030; ">*</code>arg1<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code><code style="color:#806030; ">*</code> arg2<code style="color:#806030; ">)</code>
 823 <code style="color:#806030; ">{</code>
 824     <code style="color:#400000; font-weight:bold; ">if</code><code style="color:#806030; ">(</code><code style="color:#806030; ">!</code>strcasecmp<code style="color:#806030; ">(</code>arg1<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">file</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">)</code> config<code style="color:#806030; ">.</code>typeOfAction <code style="color:#806030; ">=</code> <code style="color:#c00000; ">0x01</code><code style="color:#806030; ">;</code>
 825     <code style="color:#400000; font-weight:bold; ">else</code> config<code style="color:#806030; ">.</code>typeOfAction <code style="color:#806030; ">=</code> <code style="color:#c00000; ">0x02</code><code style="color:#806030; ">;</code>
 826
 827     <code style="color:#400000; font-weight:bold; ">if</code><code style="color:#806030; ">(</code><code style="color:#806030; ">!</code>strcasecmp<code style="color:#806030; ">(</code>arg2<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">deny</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">)</code> config<code style="color:#806030; ">.</code>typeOfAction <code style="color:#806030; ">+</code><code style="color:#806030; ">=</code> <code style="color:#c00000; ">0x10</code><code style="color:#806030; ">;</code>
 828     <code style="color:#400000; font-weight:bold; ">else</code> config<code style="color:#806030; ">.</code>typeOfAction <code style="color:#806030; ">+</code><code style="color:#806030; ">=</code> <code style="color:#c00000; ">0x20</code><code style="color:#806030; ">;</code>
 829     <code style="color:#400000; font-weight:bold; ">return</code> <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">;</code>
 830 <code style="color:#806030; ">}</code>
 831 </pre>
 832
 833
 834
 835 </p>
 836
 837 <h3><a name="directive_complete" id="directive_complete">Putting it all together</a></h3>
 838 <p>
 839 Now that we have our directives set up, and handlers configured for them, we can assemble our module
 840 into one big file:
 841
 842
 843
 844 <pre style="color:#000000;background:#ffffef;border: 1px dashed #333; padding: 0.5em; margin: 1em 2em 1em 1em;">
 845 <code style="color:#c34e00; ">/* mod_example_config_simple.c: */</code>
 846 <code style="color:#004a43; ">#</code><code style="color:#004a43; ">include </code><code style="color:#800000; ">&lt;</code><code style="color:#40015a; ">stdio.h</code><code style="color:#800000; ">&gt;</code>
 847 <code style="color:#004a43; ">#</code><code style="color:#004a43; ">include </code><code style="color:#800000; ">"</code><code style="color:#40015a; ">apr_hash.h</code><code style="color:#800000; ">"</code>
 848 <code style="color:#004a43; ">#</code><code style="color:#004a43; ">include </code><code style="color:#800000; ">"</code><code style="color:#40015a; ">ap_config.h</code><code style="color:#800000; ">"</code>
 849 <code style="color:#004a43; ">#</code><code style="color:#004a43; ">include </code><code style="color:#800000; ">"</code><code style="color:#40015a; ">ap_provider.h</code><code style="color:#800000; ">"</code>
 850 <code style="color:#004a43; ">#</code><code style="color:#004a43; ">include </code><code style="color:#800000; ">"</code><code style="color:#40015a; ">httpd.h</code><code style="color:#800000; ">"</code>
 851 <code style="color:#004a43; ">#</code><code style="color:#004a43; ">include </code><code style="color:#800000; ">"</code><code style="color:#40015a; ">http_core.h</code><code style="color:#800000; ">"</code>
 852 <code style="color:#004a43; ">#</code><code style="color:#004a43; ">include </code><code style="color:#800000; ">"</code><code style="color:#40015a; ">http_config.h</code><code style="color:#800000; ">"</code>
 853 <code style="color:#004a43; ">#</code><code style="color:#004a43; ">include </code><code style="color:#800000; ">"</code><code style="color:#40015a; ">http_log.h</code><code style="color:#800000; ">"</code>
 854 <code style="color:#004a43; ">#</code><code style="color:#004a43; ">include </code><code style="color:#800000; ">"</code><code style="color:#40015a; ">http_protocol.h</code><code style="color:#800000; ">"</code>
 855 <code style="color:#004a43; ">#</code><code style="color:#004a43; ">include </code><code style="color:#800000; ">"</code><code style="color:#40015a; ">http_request.h</code><code style="color:#800000; ">"</code>
 856
 857 <code style="color:#c34e00; ">/*</code>
 858 <code style="color:#c34e00; ">&nbsp;==============================================================================</code>
 859 <code style="color:#c34e00; ">&nbsp;Our configuration prototype and declaration:</code>
 860 <code style="color:#c34e00; ">&nbsp;==============================================================================</code>
 861 <code style="color:#c34e00; ">&nbsp;*/</code>
 862 <code style="color:#400000; font-weight:bold; ">typedef</code> <code style="color:#400000; font-weight:bold; ">struct</code> <code style="color:#806030; ">{</code>
 863     <code style="color:#400000; font-weight:bold; ">int</code>         enabled<code style="color:#806030; ">;</code>      <code style="color:#c34e00; ">/* Enable or disable our module */</code>
 864     <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code> <code style="color:#806030; ">*</code>path<code style="color:#806030; ">;</code>         <code style="color:#c34e00; ">/* Some path to...something */</code>
 865     <code style="color:#400000; font-weight:bold; ">int</code>         typeOfAction<code style="color:#806030; ">;</code> <code style="color:#c34e00; ">/* 1 means action A, 2 means action B and so on */</code>
 866 <code style="color:#806030; ">}</code> example_config<code style="color:#806030; ">;</code>
 867
 868 <code style="color:#400000; font-weight:bold; ">static</code> example_config config<code style="color:#806030; ">;</code>
 869
 870 <code style="color:#c34e00; ">/*</code>
 871 <code style="color:#c34e00; ">&nbsp;==============================================================================</code>
 872 <code style="color:#c34e00; ">&nbsp;Our directive handlers:</code>
 873 <code style="color:#c34e00; ">&nbsp;==============================================================================</code>
 874 <code style="color:#c34e00; ">&nbsp;*/</code>
 875 <code style="color:#c34e00; ">/* Handler for the "exambleEnabled" directive */</code>
 876 <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code><code style="color:#806030; "> *</code>example_set_enabled<code style="color:#806030; ">(</code>cmd_parms <code style="color:#806030; ">*</code>cmd<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">void</code> <code style="color:#806030; ">*</code>cfg<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code> <code style="color:#806030; ">*</code>arg<code style="color:#806030; ">)</code>
 877 <code style="color:#806030; ">{</code>
 878     <code style="color:#400000; font-weight:bold; ">if</code><code style="color:#806030; ">(</code><code style="color:#806030; ">!</code>strcasecmp<code style="color:#806030; ">(</code>arg<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">on</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">)</code> config<code style="color:#806030; ">.</code>enabled <code style="color:#806030; ">=</code> <code style="color:#c00000; ">1</code><code style="color:#806030; ">;</code>
 879     <code style="color:#400000; font-weight:bold; ">else</code> config<code style="color:#806030; ">.</code>enabled <code style="color:#806030; ">=</code> <code style="color:#c00000; ">0</code><code style="color:#806030; ">;</code>
 880     <code style="color:#400000; font-weight:bold; ">return</code> <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">;</code>
 881 <code style="color:#806030; ">}</code>
 882
 883 <code style="color:#c34e00; ">/* Handler for the "examplePath" directive */</code>
 884 <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code><code style="color:#806030; "> *</code>example_set_path<code style="color:#806030; ">(</code>cmd_parms <code style="color:#806030; ">*</code>cmd<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">void</code> <code style="color:#806030; ">*</code>cfg<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code> <code style="color:#806030; ">*</code>arg<code style="color:#806030; ">)</code>
 885 <code style="color:#806030; ">{</code>
 886     config<code style="color:#806030; ">.</code>path <code style="color:#806030; ">=</code> arg<code style="color:#806030; ">;</code>
 887     <code style="color:#400000; font-weight:bold; ">return</code> <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">;</code>
 888 <code style="color:#806030; ">}</code>
 889
 890 <code style="color:#c34e00; ">/* Handler for the "exampleAction" directive */</code>
 891 <code style="color:#c34e00; ">/* Let's pretend this one takes one argument (file or db), and a second (deny or allow), */</code>
 892 <code style="color:#c34e00; ">/* and we store it in a bit-wise manner. */</code>
 893 <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code><code style="color:#806030; "> *</code>example_set_action<code style="color:#806030; ">(</code>cmd_parms <code style="color:#806030; ">*</code>cmd<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">void</code> <code style="color:#806030; ">*</code>cfg<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code> <code style="color:#806030; ">*</code>arg1<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code><code style="color:#806030; ">*</code> arg2<code style="color:#806030; ">)</code>
 894 <code style="color:#806030; ">{</code>
 895     <code style="color:#400000; font-weight:bold; ">if</code><code style="color:#806030; ">(</code><code style="color:#806030; ">!</code>strcasecmp<code style="color:#806030; ">(</code>arg1<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">file</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">)</code> config<code style="color:#806030; ">.</code>typeOfAction <code style="color:#806030; ">=</code> <code style="color:#c00000; ">0x01</code><code style="color:#806030; ">;</code>
 896     <code style="color:#400000; font-weight:bold; ">else</code> config<code style="color:#806030; ">.</code>typeOfAction <code style="color:#806030; ">=</code> <code style="color:#c00000; ">0x02</code><code style="color:#806030; ">;</code>
 897
 898     <code style="color:#400000; font-weight:bold; ">if</code><code style="color:#806030; ">(</code><code style="color:#806030; ">!</code>strcasecmp<code style="color:#806030; ">(</code>arg2<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">deny</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">)</code> config<code style="color:#806030; ">.</code>typeOfAction <code style="color:#806030; ">+</code><code style="color:#806030; ">=</code> <code style="color:#c00000; ">0x10</code><code style="color:#806030; ">;</code>
 899     <code style="color:#400000; font-weight:bold; ">else</code> config<code style="color:#806030; ">.</code>typeOfAction <code style="color:#806030; ">+</code><code style="color:#806030; ">=</code> <code style="color:#c00000; ">0x20</code><code style="color:#806030; ">;</code>
 900     <code style="color:#400000; font-weight:bold; ">return</code> <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">;</code>
 901 <code style="color:#806030; ">}</code>
 902
 903 <code style="color:#c34e00; ">/*</code>
 904 <code style="color:#c34e00; ">&nbsp;==============================================================================</code>
 905 <code style="color:#c34e00; ">&nbsp;The directive structure for our name tag:</code>
 906 <code style="color:#c34e00; ">&nbsp;==============================================================================</code>
 907 <code style="color:#c34e00; ">&nbsp;*/</code>
 908 <code style="color:#400000; font-weight:bold; ">static</code> <code style="color:#400000; font-weight:bold; ">const</code> command_rec        example_directives<code style="color:#806030; ">[</code><code style="color:#806030; ">]</code> <code style="color:#806030; ">=</code>
 909 <code style="color:#806030; ">{</code>
 910     <a href="http://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__CONFIG.html#ga07c7d22ae17805e61204463326cf9c34">AP_INIT_TAKE1</a><code style="color:#806030; ">(</code><code style="color:#800000; ">"</code><code style="color:#e60000; ">exampleEnabled</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> example_set_enabled<code style="color:#806030; ">,</code> <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">,</code> RSRC_CONF<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">Enable or disable mod_example</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">,</code>
 911     <a href="http://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__CONFIG.html#ga07c7d22ae17805e61204463326cf9c34">AP_INIT_TAKE1</a><code style="color:#806030; ">(</code><code style="color:#800000; ">"</code><code style="color:#e60000; ">examplePath</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> example_set_path<code style="color:#806030; ">,</code> <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">,</code> RSRC_CONF<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">The path to whatever</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">,</code>
 912     <a href="http://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__CONFIG.html#gafaec43534fcf200f37d9fecbf9247c21">AP_INIT_TAKE2</a><code style="color:#806030; ">(</code><code style="color:#800000; ">"</code><code style="color:#e60000; ">exampleAction</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> example_set_action<code style="color:#806030; ">,</code> <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">,</code> RSRC_CONF<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">Special action value!</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">,</code>
 913     <code style="color:#806030; ">{</code> <code style="color:#007d45; ">NULL</code> <code style="color:#806030; ">}</code>
 914 <code style="color:#806030; ">}</code><code style="color:#806030; ">;</code>
 915 <code style="color:#c34e00; ">/*</code>
 916 <code style="color:#c34e00; ">&nbsp;==============================================================================</code>
 917 <code style="color:#c34e00; ">&nbsp;Our module handler:</code>
 918 <code style="color:#c34e00; ">&nbsp;==============================================================================</code>
 919 <code style="color:#c34e00; ">&nbsp;*/</code>
 920 <code style="color:#400000; font-weight:bold; ">static</code> <code style="color:#400000; font-weight:bold; ">int</code> example_handler<code style="color:#806030; ">(</code>request_rec <code style="color:#806030; ">*</code>r<code style="color:#806030; ">)</code>
 921 <code style="color:#806030; ">{</code>
 922     <code style="color:#400000; font-weight:bold; ">if</code><code style="color:#806030; ">(</code><code style="color:#806030; ">!</code>r<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">handler</code> <code style="color:#806030; ">|</code><code style="color:#806030; ">|</code> <code style="color:#800040; ">strcmp</code><code style="color:#806030; ">(</code>r<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">handler</code><code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">example-handler</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">)</code> <code style="color:#400000; font-weight:bold; ">return</code><code style="color:#806030; ">(</code>DECLINED<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 923     ap_set_content_type<code style="color:#806030; ">(</code>r<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">text/plain</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 924     ap_rprintf<code style="color:#806030; ">(</code>r<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">Enabled: </code><code style="color:#0f6900; ">%u</code><code style="color:#0f6900; ">\n</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> config<code style="color:#806030; ">.</code>enabled<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 925     ap_rprintf<code style="color:#806030; ">(</code>r<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">Path: </code><code style="color:#0f6900; ">%s</code><code style="color:#0f6900; ">\n</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> config<code style="color:#806030; ">.</code>path<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 926     ap_rprintf<code style="color:#806030; ">(</code>r<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">TypeOfAction: </code><code style="color:#0f6900; ">%x</code><code style="color:#0f6900; ">\n</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> config<code style="color:#806030; ">.</code>typeOfAction<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 927     <code style="color:#400000; font-weight:bold; ">return</code> OK<code style="color:#806030; ">;</code>
 928 <code style="color:#806030; ">}</code>
 929
 930 <code style="color:#c34e00; ">/*</code>
 931 <code style="color:#c34e00; ">&nbsp;==============================================================================</code>
 932 <code style="color:#c34e00; ">&nbsp;The hook registration function (also initializes the default config values):</code>
 933 <code style="color:#c34e00; ">&nbsp;==============================================================================</code>
 934 <code style="color:#c34e00; ">&nbsp;*/</code>
 935 <code style="color:#400000; font-weight:bold; ">static</code> <code style="color:#400000; font-weight:bold; ">void</code> register_hooks<code style="color:#806030; ">(</code>apr_pool_t <code style="color:#806030; ">*</code>pool<code style="color:#806030; ">)</code>
 936 <code style="color:#806030; ">{</code>
 937     config<code style="color:#806030; ">.</code>enabled <code style="color:#806030; ">=</code> <code style="color:#c00000; ">1</code><code style="color:#806030; ">;</code>
 938     config<code style="color:#806030; ">.</code>path <code style="color:#806030; ">=</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">/foo/bar</code><code style="color:#800000; ">"</code><code style="color:#806030; ">;</code>
 939     config<code style="color:#806030; ">.</code>typeOfAction <code style="color:#806030; ">=</code> <code style="color:#c00000; ">3</code><code style="color:#806030; ">;</code>
 940     ap_hook_handler<code style="color:#806030; ">(</code>example_handler<code style="color:#806030; ">,</code> <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">,</code> <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">,</code> APR_HOOK_LAST<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
 941 <code style="color:#806030; ">}</code>
 942 <code style="color:#c34e00; ">/*</code>
 943 <code style="color:#c34e00; ">&nbsp;==============================================================================</code>
 944 <code style="color:#c34e00; ">&nbsp;Our module name tag:</code>
 945 <code style="color:#c34e00; ">&nbsp;==============================================================================</code>
 946 <code style="color:#c34e00; ">&nbsp;*/</code>
 947 module AP_MODULE_DECLARE_DATA   example_module <code style="color:#806030; ">=</code>
 948 <code style="color:#806030; ">{</code>
 949     STANDARD20_MODULE_STUFF<code style="color:#806030; ">,</code>
 950     <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">,</code>               <code style="color:#c34e00; ">/* Per-directory configuration handler */</code>
 951     <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">,</code>               <code style="color:#c34e00; ">/* Merge handler for per-directory configurations */</code>
 952     <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">,</code>               <code style="color:#c34e00; ">/* Per-server configuration handler */</code>
 953     <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">,</code>               <code style="color:#c34e00; ">/* Merge handler for per-server configurations */</code>
 954     example_directives<code style="color:#806030; ">,</code> <code style="color:#c34e00; ">/* Any directives we may have for httpd */</code>
 955     register_hooks      <code style="color:#c34e00; ">/* Our hook registering function */</code>
 956 <code style="color:#806030; ">}</code><code style="color:#806030; ">;</code>
 957 </pre>
 958
 959
 960
 961 </p>
 962 <p>
 963 In our httpd.conf file, we can now change the hard-coded configuration by adding a few lines:
 964 <div class="example"><pre>
 965 ExampleEnabled On
 966 ExamplePath "/usr/bin/foo"
 967 ExampleAction file allow
 968 </pre></div>
 969 And thus we apply the configuration, visit <code>/example</code> on our web site, and we see the configuration has
 970 adapted to what we wrote in our configuration file.
 971 </p>
 972
 973
 974
 975 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 976 <div class="section">
 977 <h2><a name="context" id="context">Context aware configurations</a></h2>
 978 <h3><a name="context_intro" id="context_intro">Introduction to context aware configurations</a></h3>
 979 <p>
 980 In Apache, different URLs, virtual hosts, directories etc can have very different meanings
 981 to the user of Apache, and thus different contexts within which modules must operate. For example,
 982 let's assume you have this configuration set up for mod_rewrite:
 983 <div class="example"><pre>
 984 &lt;Directory "/var/www"&gt;
 985     RewriteCond %{HTTP_HOST} ^example.com$
 986     RewriteRule (.*) http://www.example.com/$1
 987 &lt;/Directory&gt;
 988 &lt;Directory "/var/www/sub"&gt;
 989     RewriteRule ^foobar$ index.php?foobar=true
 990 &lt;/Directory&gt;
 991 </pre></div>
 992 In this example, you will have set up two different contexts for mod_rewrite:
 993 <ol>
 994 <li>Inside <code>/var/www</code>, all requests for <code>http://example.com</code> must go to <code>http://www.example.com</code></li>
 995 <li>Inside <code>/var/www/sub</code>, all requests for <code>foobar</code> must go to <code>index.php?foobar=true</code></li>
 996 </ol>
 997 If mod_rewrite (or Apache for that matter) wasn't context aware, then these rewrite rules would just apply to every and any request made,
 998 regardless of where and how they were made, but since the module can pull the context specific configuration straight from Apache, it
 999 does not need to know itself, which of the directives are valid in this context, since Apache takes care of this.</p>
1000
1001 <p>
1002 So how does a module get the specific configuration for the server, directory or location in question? It does so by making one simple call:
1003
1004
1005
1006 <pre style="color:#000000;background:#ffffef;border: 1px dashed #333; padding: 0.5em; margin: 1em 2em 1em 1em;">
1007
1008
1009
1010 example_config *config = (example_config*) <a href="http://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__CONFIG.html#ga1093a5908a384eacc929b028c79f2a02">ap_get_module_config</a>(<code style="color:#008833">r-&gt;per_dir_config</code>, &amp;example_module);
1011 </pre>
1012 That's it! Of course, a whole lot goes on behind the scenes, which we will discuss in this chapter, starting with how
1013 Apache came to know what our configuration looks like, and how it came to be set up as it is in the specific context.
1014 </p>
1015
1016
1017 <h3><a name="context_base" id="context_base">Our basic configuration setup</a></h3>
1018 <p>In this chapter, we will be working with a slightly modified version of our previous
1019 context structure. We will set a <code>context</code> variable that we can use to track
1020 which context configuration is being used by Apache in various places:
1021
1022
1023
1024 <pre style="color:#000000;background:#ffffef;border: 1px dashed #333; padding: 0.5em; margin: 1em 2em 1em 1em;">
1025 <code style="color:#400000; font-weight:bold; ">typedef</code> <code style="color:#400000; font-weight:bold; ">struct</code> <code style="color:#806030; ">{</code>
1026     <code style="color:#400000; font-weight:bold; ">char</code>        context<code style="color:#806030; ">[</code><code style="color:#c00000; ">256</code><code style="color:#806030; ">]</code><code style="color:#806030; ">;</code>
1027     <code style="color:#400000; font-weight:bold; ">char</code>        path<code style="color:#806030; ">[</code><code style="color:#c00000; ">256</code><code style="color:#806030; ">]</code><code style="color:#806030; ">;</code>
1028     <code style="color:#400000; font-weight:bold; ">int</code>         typeOfAction<code style="color:#806030; ">;</code>
1029     <code style="color:#400000; font-weight:bold; ">int</code>         enabled<code style="color:#806030; ">;</code>
1030 <code style="color:#806030; ">}</code> example_config<code style="color:#806030; ">;</code>
1031 </pre>
1032
1033
1034
1035 </p>
1036
1037 <p>Our handler for requests will also be modified, yet still very simple:
1038
1039
1040
1041 <pre style="color:#000000;background:#ffffef;border: 1px dashed #333; padding: 0.5em; margin: 1em 2em 1em 1em;">
1042 <code style="color:#400000; font-weight:bold; ">static</code> <code style="color:#400000; font-weight:bold; ">int</code> example_handler<code style="color:#806030; ">(</code>request_rec <code style="color:#806030; ">*</code>r<code style="color:#806030; ">)</code>
1043 <code style="color:#806030; ">{</code>
1044     <code style="color:#400000; font-weight:bold; ">if</code><code style="color:#806030; ">(</code><code style="color:#806030; ">!</code>r<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">handler</code> <code style="color:#806030; ">|</code><code style="color:#806030; ">|</code> <code style="color:#800040; ">strcmp</code><code style="color:#806030; ">(</code>r<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">handler</code><code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">example-handler</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">)</code> <code style="color:#400000; font-weight:bold; ">return</code><code style="color:#806030; ">(</code>DECLINED<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1045     example_config<code style="color:#806030; "> *</code>config <code style="color:#806030; ">=</code> <code style="color:#806030; ">(</code>example_config<code style="color:#806030; ">*</code><code style="color:#806030; ">)</code> ap_get_module_config<code style="color:#806030; ">(</code>r<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">per_dir_config</code><code style="color:#806030; ">,</code> <code style="color:#806030; ">&amp;</code>example_module<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1046     ap_set_content_type<code style="color:#806030; ">(</code>r<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">text/plain</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1047     ap_rprintf<code style="color:#806030; ">(</code><code style="color:#800000; ">"</code><code style="color:#e60000; ">Enabled: </code><code style="color:#0f6900; ">%u</code><code style="color:#0f6900; ">\n</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> config<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">enabled</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1048     ap_rprintf<code style="color:#806030; ">(</code><code style="color:#800000; ">"</code><code style="color:#e60000; ">Path: </code><code style="color:#0f6900; ">%s</code><code style="color:#0f6900; ">\n</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> config<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">path</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1049     ap_rprintf<code style="color:#806030; ">(</code><code style="color:#800000; ">"</code><code style="color:#e60000; ">TypeOfAction: </code><code style="color:#0f6900; ">%x</code><code style="color:#0f6900; ">\n</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> config<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">typeOfAction</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1050     ap_rprintf<code style="color:#806030; ">(</code><code style="color:#800000; ">"</code><code style="color:#e60000; ">Context: </code><code style="color:#0f6900; ">%s</code><code style="color:#0f6900; ">\n</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> config<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">context</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1051     <code style="color:#400000; font-weight:bold; ">return</code> OK<code style="color:#806030; ">;</code>
1052 <code style="color:#806030; ">}</code>
1053 </pre>
1054
1055
1056
1057 </p>
1058
1059
1060
1061 <h3><a name="context_which" id="context_which">Choosing a context</a></h3>
1062 <p>
1063 Before we can start making our module context aware, we must first define, which contexts we will accept.
1064 As we saw in the previous chapter, defining a directive required five elements be set:
1065
1066
1067
1068 <pre style="color:#000000;background:#ffffef;border: 1px dashed #333; padding: 0.5em; margin: 1em 2em 1em 1em;">
1069 <code style="color:#2e8800; "><a href="http://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__CONFIG.html#ga07c7d22ae17805e61204463326cf9c34">AP_INIT_TAKE1</a></code>("exampleEnabled", example_set_enabled, <code style="color:#7f0055; font-weight:bold; ">NULL</code>, RSRC_CONF, "Enable or disable mod_example"),
1070 </pre>
1071
1072
1073
1074 The <code>RSRC_CONF</code> definition told Apache that we would only allow this directive in a global server context, but
1075 since we are now trying out a context aware version of our module, we should set this to something more lenient, namely
1076 the value <code>ACCESS_CONF</code>, which lets us use the directive inside &lt;Directory&gt; and &lt;Location&gt; blocks.
1077 </p>
1078
1079
1080 <h3><a name="context_pool" id="context_pool">Using Apache to allocate configuration slots</a></h3>
1081 <p> A much smarter way to manage your configurations is by letting Apache help you create them.
1082 To do so, we must first start off by chancing our <em>name tag</em> to let Apache know, that
1083 it should assist us in creating and managing our configurations. Since we have chosen the per-directory
1084 (or per-location) context for our module configurations, we'll add a per-directory creator and merger
1085 function reference in our tag:
1086
1087
1088 <pre style="color:#000000;background:#ffffef;border: 1px dashed #333; padding: 0.5em; margin: 1em 2em 1em 1em;">
1089 module AP_MODULE_DECLARE_DATA   example_module <code style="color:#806030; ">=</code>
1090 <code style="color:#806030; ">{</code>
1091     STANDARD20_MODULE_STUFF<code style="color:#806030; ">,</code>
1092     create_dir_conf<code style="color:#806030; ">,</code> <code style="color:#c34e00; ">/* Per-directory configuration handler */</code>
1093     merge_dir_conf<code style="color:#806030; ">,</code>  <code style="color:#c34e00; ">/* Merge handler for per-directory configurations */</code>
1094     <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">,</code>            <code style="color:#c34e00; ">/* Per-server configuration handler */</code>
1095     <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">,</code>            <code style="color:#c34e00; ">/* Merge handler for per-server configurations */</code>
1096     directives<code style="color:#806030; ">,</code>      <code style="color:#c34e00; ">/* Any directives we may have for httpd */</code>
1097     register_hooks   <code style="color:#c34e00; ">/* Our hook registering function */</code>
1098 <code style="color:#806030; ">}</code><code style="color:#806030; ">;</code>
1099 </pre>
1100
1101
1102
1103 </p>
1104
1105
1106
1107
1108
1109 <h3><a name="context_which" id="context_which">Creating new context configurations</a></h3>
1110 <p>
1111 Now that we have told Apache to help us create and manage configurations, our first step is to
1112 make a function for creating new, blank configurations. We do so by creating the function we just
1113 referenced in our name tag as the Per-directory configuration handler:
1114
1115 <pre style="color:#000000;background:#ffffef;border: 1px dashed #333; padding: 0.5em; margin: 1em 2em 1em 1em;">
1116 <code style="color:#400000; font-weight:bold; ">void</code><code style="color:#806030; ">*</code> example_create_dir_conf<code style="color:#806030; ">(</code>apr_pool_t<code style="color:#806030; ">*</code> pool<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">char</code><code style="color:#806030; ">*</code> context<code style="color:#806030; ">)</code> <code style="color:#806030; ">{</code>
1117     context <code style="color:#806030; ">=</code> context <code style="color:#806030; ">?</code> context <code style="color:#806030; ">:</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">(undefined context)</code><code style="color:#800000; ">"</code><code style="color:#806030; ">;</code>
1118     example_config<code style="color:#806030; "> *</code>cfg <code style="color:#806030; ">=</code> apr_pcalloc<code style="color:#806030; ">(</code>pool<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">sizeof</code><code style="color:#806030; ">(</code>example_config<code style="color:#806030; ">)</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1119     <code style="color:#400000; font-weight:bold; ">if</code><code style="color:#806030; ">(</code>cfg<code style="color:#806030; ">)</code> <code style="color:#806030; ">{</code>
1120         <code style="color:#c34e00; ">/* Set some default values */</code>
1121         <code style="color:#800040; ">strcpy</code><code style="color:#806030; ">(</code>cfg<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">context</code><code style="color:#806030; ">,</code> x<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1122         cfg<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">enabled</code> <code style="color:#806030; ">=</code> <code style="color:#c00000; ">0</code><code style="color:#806030; ">;</code>
1123         cfg<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">path</code> <code style="color:#806030; ">=</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">/foo/bar</code><code style="color:#800000; ">"</code><code style="color:#806030; ">;</code>
1124         cfg<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">typeOfAction</code> <code style="color:#806030; ">=</code> <code style="color:#c00000; ">0x11</code><code style="color:#806030; ">;</code>
1125     <code style="color:#806030; ">}</code>
1126     <code style="color:#400000; font-weight:bold; ">return</code> dir<code style="color:#806030; ">;</code>
1127 <code style="color:#806030; ">}</code>
1128 </pre>
1129
1130
1131
1132 </p>
1133
1134
1135 <h3><a name="context_which" id="context_which">Merging configurations</a></h3>
1136 <p>
1137 Our next step in creating a context aware configuration is merging configurations. This part of the process
1138 particularly apply to scenarios where you have a parent configuration and a child, such as the following:
1139 <div class="example"><pre>
1140 &lt;Directory "/var/www"&gt;
1141     ExampleEnable On
1142     ExamplePath /foo/bar
1143     ExampleAction file allow
1144 &lt;/Directory&gt;
1145 &lt;Directory "/var/www/subdir"&gt;
1146     ExampleAction file deny
1147 &lt;/Directory&gt;
1148 </pre></div>
1149 In this example, it is natural to assume that the directory <code>/var/www/subdir</code> should inherit the
1150 value set for the <code>/var/www</code> directory, as we did not specify a <code>ExampleEnable</code> nor an
1151 <code>ExamplePath</code> for this directory. Apache does not presume to know if this is true, but cleverly
1152 does the following:
1153 <ol>
1154 <li>Creates a new configuration for <code>/var/www</code></li>
1155 <li>Sets the configuration values according to the directives given for <code>/var/www</code></li>
1156 <li>Creates a new configuration for <code>/var/www/subdir</code></li>
1157 <li>Sets the configuration values according to the directives given for <code>/var/www/subdir</code></li>
1158 <li><strong>Proposes a merge</strong> of the two configurations into a new configuration for <code>/var/www/subdir</code></li>
1159 </ol>
1160 This proposal is handled by the <code>merge_dir_conf</code> function we referenced in our name tag. The purpose of
1161 this function is to assess the two configurations and decide how they are to be merged:
1162
1163
1164
1165 <pre style="color:#000000;background:#ffffef;border: 1px dashed #333; padding: 0.5em; margin: 1em 2em 1em 1em;">
1166 <code style="color:#400000; font-weight:bold; ">void</code><code style="color:#806030; ">*</code> merge_dir_conf<code style="color:#806030; ">(</code>apr_pool_t<code style="color:#806030; ">*</code> pool<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">void</code><code style="color:#806030; ">*</code> BASE<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">void</code><code style="color:#806030; ">*</code> ADD<code style="color:#806030; ">)</code> <code style="color:#806030; ">{</code>
1167     example_config<code style="color:#806030; ">*</code> base <code style="color:#806030; ">=</code> BASE <code style="color:#806030; ">;</code>
1168     example_config<code style="color:#806030; ">*</code> add <code style="color:#806030; ">=</code> ADD <code style="color:#806030; ">;</code>
1169     example_config<code style="color:#806030; ">*</code> conf <code style="color:#806030; ">=</code> create_dir_conf<code style="color:#806030; ">(</code>pool<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">Merged configuration</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1170
1171     conf<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">enabled</code> <code style="color:#806030; ">=</code> <code style="color:#806030; ">(</code> add<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">enabled</code> <code style="color:#806030; ">=</code><code style="color:#806030; ">=</code> <code style="color:#c00000; ">0</code> <code style="color:#806030; ">)</code> <code style="color:#806030; ">?</code> base<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">enabled</code> <code style="color:#806030; ">:</code> add<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">enabled</code> <code style="color:#806030; ">;</code>
1172     conf<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">typeOfAction</code> <code style="color:#806030; ">=</code> add<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">typeOfAction</code> <code style="color:#806030; ">?</code> add<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">typeOfAction</code> <code style="color:#806030; ">:</code> base<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">typeOfAction</code><code style="color:#806030; ">;</code>
1173     <code style="color:#800040; ">strcpy</code><code style="color:#806030; ">(</code>conf<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">path</code><code style="color:#806030; ">,</code> <code style="color:#800040; ">strlen</code><code style="color:#806030; ">(</code>add<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">path</code><code style="color:#806030; ">)</code> <code style="color:#806030; ">?</code> add<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">path</code> <code style="color:#806030; ">:</code> base<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">path</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1174
1175     <code style="color:#400000; font-weight:bold; ">return</code> conf <code style="color:#806030; ">;</code>
1176 <code style="color:#806030; ">}</code>
1177 </pre>
1178
1179
1180 </p>
1181
1182
1183 <h3><a name="context_which" id="context_which">Trying out our new context aware configurations</a></h3>
1184 <p>
1185 Now, let's try putting it all together to create a new module that it context aware. First off, we'll
1186 create a configuration that lets us test how the module works:
1187 <div class="example"><pre>
1188 &lt;Location "/a"&gt;
1189     SetHandler example-handler
1190     ExampleEnabled on
1191     ExamplePath "/foo/bar"
1192     ExampleAction file allow
1193 &lt;/Location&gt;
1194
1195 &lt;Location "/a/b"&gt;
1196     ExampleAction file deny
1197     ExampleEnabled off
1198 &lt;/Location&gt;
1199
1200 &lt;Location "/a/b/c"&gt;
1201     ExampleAction db deny
1202     ExamplePath "/foo/bar/baz"
1203     ExampleEnabled on
1204 &lt;/Location&gt;
1205 </pre></div>
1206 Then we'll assemble our module code. Note, that since we are now using our name tag as reference when fetching
1207 configurations in our handler, I have added some prototypes to keep the compiler happy:
1208 </p>
1209
1210
1211 <pre style="color:#000000;background:#ffffef;border: 1px dashed #333; padding: 0.5em; margin: 1em 2em 1em 1em;">
1212 <code style="color:#c34e00; ">/*$6</code>
1213 <code style="color:#c34e00; ">&nbsp;+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</code>
1214 <code style="color:#c34e00; ">&nbsp;* mod_example_config.c</code>
1215 <code style="color:#c34e00; ">&nbsp;+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</code>
1216 <code style="color:#c34e00; ">&nbsp;*/</code>
1217
1218
1219 <code style="color:#004a43; ">#</code><code style="color:#004a43; ">include </code><code style="color:#800000; ">&lt;</code><code style="color:#40015a; ">stdio.h</code><code style="color:#800000; ">&gt;</code>
1220 <code style="color:#004a43; ">#</code><code style="color:#004a43; ">include </code><code style="color:#800000; ">"</code><code style="color:#40015a; ">apr_hash.h</code><code style="color:#800000; ">"</code>
1221 <code style="color:#004a43; ">#</code><code style="color:#004a43; ">include </code><code style="color:#800000; ">"</code><code style="color:#40015a; ">ap_config.h</code><code style="color:#800000; ">"</code>
1222 <code style="color:#004a43; ">#</code><code style="color:#004a43; ">include </code><code style="color:#800000; ">"</code><code style="color:#40015a; ">ap_provider.h</code><code style="color:#800000; ">"</code>
1223 <code style="color:#004a43; ">#</code><code style="color:#004a43; ">include </code><code style="color:#800000; ">"</code><code style="color:#40015a; ">httpd.h</code><code style="color:#800000; ">"</code>
1224 <code style="color:#004a43; ">#</code><code style="color:#004a43; ">include </code><code style="color:#800000; ">"</code><code style="color:#40015a; ">http_core.h</code><code style="color:#800000; ">"</code>
1225 <code style="color:#004a43; ">#</code><code style="color:#004a43; ">include </code><code style="color:#800000; ">"</code><code style="color:#40015a; ">http_config.h</code><code style="color:#800000; ">"</code>
1226 <code style="color:#004a43; ">#</code><code style="color:#004a43; ">include </code><code style="color:#800000; ">"</code><code style="color:#40015a; ">http_log.h</code><code style="color:#800000; ">"</code>
1227 <code style="color:#004a43; ">#</code><code style="color:#004a43; ">include </code><code style="color:#800000; ">"</code><code style="color:#40015a; ">http_protocol.h</code><code style="color:#800000; ">"</code>
1228 <code style="color:#004a43; ">#</code><code style="color:#004a43; ">include </code><code style="color:#800000; ">"</code><code style="color:#40015a; ">http_request.h</code><code style="color:#800000; ">"</code>
1229
1230 <code style="color:#c34e00; ">/*$1</code>
1231 <code style="color:#c34e00; ">&nbsp;~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~</code>
1232 <code style="color:#c34e00; ">&nbsp;&nbsp;&nbsp;&nbsp;Configuration structure</code>
1233 <code style="color:#c34e00; ">&nbsp;~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~</code>
1234 <code style="color:#c34e00; ">&nbsp;*/</code>
1235
1236 <code style="color:#400000; font-weight:bold; ">typedef</code> <code style="color:#400000; font-weight:bold; ">struct</code>
1237 <code style="color:#806030; ">{</code>
1238     <code style="color:#400000; font-weight:bold; ">char</code>    context<code style="color:#806030; ">[</code><code style="color:#c00000; ">256</code><code style="color:#806030; ">]</code><code style="color:#806030; ">;</code>
1239     <code style="color:#400000; font-weight:bold; ">char</code>    path<code style="color:#806030; ">[</code><code style="color:#c00000; ">256</code><code style="color:#806030; ">]</code><code style="color:#806030; ">;</code>
1240     <code style="color:#400000; font-weight:bold; ">int</code>     typeOfAction<code style="color:#806030; ">;</code>
1241     <code style="color:#400000; font-weight:bold; ">int</code>     enabled<code style="color:#806030; ">;</code>
1242 <code style="color:#806030; ">}</code> example_config<code style="color:#806030; ">;</code>
1243
1244 <code style="color:#c34e00; ">/*$1</code>
1245 <code style="color:#c34e00; ">&nbsp;~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~</code>
1246 <code style="color:#c34e00; ">&nbsp;&nbsp;&nbsp;&nbsp;Prototypes</code>
1247 <code style="color:#c34e00; ">&nbsp;~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~</code>
1248 <code style="color:#c34e00; ">&nbsp;*/</code>
1249
1250 <code style="color:#400000; font-weight:bold; ">static</code> <code style="color:#400000; font-weight:bold; ">int</code>    example_handler<code style="color:#806030; ">(</code>request_rec <code style="color:#806030; ">*</code>r<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1251 <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code>    <code style="color:#806030; ">*</code>example_set_enabled<code style="color:#806030; ">(</code>cmd_parms <code style="color:#806030; ">*</code>cmd<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">void</code> <code style="color:#806030; ">*</code>cfg<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code> <code style="color:#806030; ">*</code>arg<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1252 <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code>    <code style="color:#806030; ">*</code>example_set_path<code style="color:#806030; ">(</code>cmd_parms <code style="color:#806030; ">*</code>cmd<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">void</code> <code style="color:#806030; ">*</code>cfg<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code> <code style="color:#806030; ">*</code>arg<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1253 <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code>    <code style="color:#806030; ">*</code>example_set_action<code style="color:#806030; ">(</code>cmd_parms <code style="color:#806030; ">*</code>cmd<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">void</code> <code style="color:#806030; ">*</code>cfg<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code> <code style="color:#806030; ">*</code>arg1<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code> <code style="color:#806030; ">*</code>arg2<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1254 <code style="color:#400000; font-weight:bold; ">void</code>          <code style="color:#806030; ">*</code>create_dir_conf<code style="color:#806030; ">(</code>apr_pool_t <code style="color:#806030; ">*</code>pool<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">char</code> <code style="color:#806030; ">*</code>context<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1255 <code style="color:#400000; font-weight:bold; ">void</code>          <code style="color:#806030; ">*</code>merge_dir_conf<code style="color:#806030; ">(</code>apr_pool_t <code style="color:#806030; ">*</code>pool<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">void</code> <code style="color:#806030; ">*</code>BASE<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">void</code> <code style="color:#806030; ">*</code>ADD<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1256 <code style="color:#400000; font-weight:bold; ">static</code> <code style="color:#400000; font-weight:bold; ">void</code>   register_hooks<code style="color:#806030; ">(</code>apr_pool_t <code style="color:#806030; ">*</code>pool<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1257
1258 <code style="color:#c34e00; ">/*$1</code>
1259 <code style="color:#c34e00; ">&nbsp;~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~</code>
1260 <code style="color:#c34e00; ">&nbsp;&nbsp;&nbsp;&nbsp;Configuration directives</code>
1261 <code style="color:#c34e00; ">&nbsp;~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~</code>
1262 <code style="color:#c34e00; ">&nbsp;*/</code>
1263
1264 <code style="color:#400000; font-weight:bold; ">static</code> <code style="color:#400000; font-weight:bold; ">const</code> command_rec    directives<code style="color:#806030; ">[</code><code style="color:#806030; ">]</code> <code style="color:#806030; ">=</code>
1265 <code style="color:#806030; ">{</code>
1266     <a href="http://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__CONFIG.html#ga07c7d22ae17805e61204463326cf9c34">AP_INIT_TAKE1</a><code style="color:#806030; ">(</code><code style="color:#800000; ">"</code><code style="color:#e60000; ">exampleEnabled</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> example_set_enabled<code style="color:#806030; ">,</code> <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">,</code> ACCESS_CONF<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">Enable or disable mod_example</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">,</code>
1267     <a href="http://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__CONFIG.html#ga07c7d22ae17805e61204463326cf9c34">AP_INIT_TAKE1</a><code style="color:#806030; ">(</code><code style="color:#800000; ">"</code><code style="color:#e60000; ">examplePath</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> example_set_path<code style="color:#806030; ">,</code> <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">,</code> ACCESS_CONF<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">The path to whatever</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">,</code>
1268     <a href="http://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__CONFIG.html#gafaec43534fcf200f37d9fecbf9247c21">AP_INIT_TAKE2</a><code style="color:#806030; ">(</code><code style="color:#800000; ">"</code><code style="color:#e60000; ">exampleAction</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> example_set_action<code style="color:#806030; ">,</code> <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">,</code> ACCESS_CONF<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">Special action value!</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">,</code>
1269     <code style="color:#806030; ">{</code> <code style="color:#007d45; ">NULL</code> <code style="color:#806030; ">}</code>
1270 <code style="color:#806030; ">}</code><code style="color:#806030; ">;</code>
1271
1272 <code style="color:#c34e00; ">/*$1</code>
1273 <code style="color:#c34e00; ">&nbsp;~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~</code>
1274 <code style="color:#c34e00; ">&nbsp;&nbsp;&nbsp;&nbsp;Our name tag</code>
1275 <code style="color:#c34e00; ">&nbsp;~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~</code>
1276 <code style="color:#c34e00; ">&nbsp;*/</code>
1277
1278 module AP_MODULE_DECLARE_DATA    example_module <code style="color:#806030; ">=</code>
1279 <code style="color:#806030; ">{</code>
1280     STANDARD20_MODULE_STUFF<code style="color:#806030; ">,</code>
1281     create_dir_conf<code style="color:#806030; ">,</code>    <code style="color:#c34e00; ">/* Per-directory configuration handler */</code>
1282     merge_dir_conf<code style="color:#806030; ">,</code>     <code style="color:#c34e00; ">/* Merge handler for per-directory configurations */</code>
1283     <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">,</code>               <code style="color:#c34e00; ">/* Per-server configuration handler */</code>
1284     <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">,</code>               <code style="color:#c34e00; ">/* Merge handler for per-server configurations */</code>
1285     directives<code style="color:#806030; ">,</code>         <code style="color:#c34e00; ">/* Any directives we may have for httpd */</code>
1286     register_hooks      <code style="color:#c34e00; ">/* Our hook registering function */</code>
1287 <code style="color:#806030; ">}</code><code style="color:#806030; ">;</code>
1288
1289 <code style="color:#c34e00; ">/*</code>
1290 <code style="color:#c34e00; ">&nbsp;=======================================================================================================================</code>
1291 <code style="color:#c34e00; ">&nbsp;&nbsp;&nbsp;&nbsp;Hook registration function</code>
1292 <code style="color:#c34e00; ">&nbsp;=======================================================================================================================</code>
1293 <code style="color:#c34e00; ">&nbsp;*/</code>
1294 <code style="color:#400000; font-weight:bold; ">static</code> <code style="color:#400000; font-weight:bold; ">void</code> register_hooks<code style="color:#806030; ">(</code>apr_pool_t <code style="color:#806030; ">*</code>pool<code style="color:#806030; ">)</code>
1295 <code style="color:#806030; ">{</code>
1296     ap_hook_handler<code style="color:#806030; ">(</code>example_handler<code style="color:#806030; ">,</code> <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">,</code> <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">,</code> APR_HOOK_LAST<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1297 <code style="color:#806030; ">}</code>
1298
1299 <code style="color:#c34e00; ">/*</code>
1300 <code style="color:#c34e00; ">&nbsp;=======================================================================================================================</code>
1301 <code style="color:#c34e00; ">&nbsp;&nbsp;&nbsp;&nbsp;Our example web service handler</code>
1302 <code style="color:#c34e00; ">&nbsp;=======================================================================================================================</code>
1303 <code style="color:#c34e00; ">&nbsp;*/</code>
1304 <code style="color:#400000; font-weight:bold; ">static</code> <code style="color:#400000; font-weight:bold; ">int</code> example_handler<code style="color:#806030; ">(</code>request_rec <code style="color:#806030; ">*</code>r<code style="color:#806030; ">)</code>
1305 <code style="color:#806030; ">{</code>
1306     <code style="color:#400000; font-weight:bold; ">if</code><code style="color:#806030; ">(</code><code style="color:#806030; ">!</code>r<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">handler</code> <code style="color:#806030; ">|</code><code style="color:#806030; ">|</code> <code style="color:#800040; ">strcmp</code><code style="color:#806030; ">(</code>r<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">handler</code><code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">example-handler</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">)</code> <code style="color:#400000; font-weight:bold; ">return</code><code style="color:#806030; ">(</code>DECLINED<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1307
1308     <code style="color:#c34e00; ">/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/</code>
1309     example_config    <code style="color:#806030; ">*</code>config <code style="color:#806030; ">=</code> <code style="color:#806030; ">(</code>example_config <code style="color:#806030; ">*</code><code style="color:#806030; ">)</code> ap_get_module_config<code style="color:#806030; ">(</code>r<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">per_dir_config</code><code style="color:#806030; ">,</code> <code style="color:#806030; ">&amp;</code>example_module<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1310     <code style="color:#c34e00; ">/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/</code>
1311
1312     ap_set_content_type<code style="color:#806030; ">(</code>r<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">text/plain</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1313     ap_rprintf<code style="color:#806030; ">(</code>r<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">Enabled: </code><code style="color:#0f6900; ">%u</code><code style="color:#0f6900; ">\n</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> config<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">enabled</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1314     ap_rprintf<code style="color:#806030; ">(</code>r<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">Path: </code><code style="color:#0f6900; ">%s</code><code style="color:#0f6900; ">\n</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> config<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">path</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1315     ap_rprintf<code style="color:#806030; ">(</code>r<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">TypeOfAction: </code><code style="color:#0f6900; ">%x</code><code style="color:#0f6900; ">\n</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> config<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">typeOfAction</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1316     ap_rprintf<code style="color:#806030; ">(</code>r<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">Context: </code><code style="color:#0f6900; ">%s</code><code style="color:#0f6900; ">\n</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> config<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">context</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1317     <code style="color:#400000; font-weight:bold; ">return</code> OK<code style="color:#806030; ">;</code>
1318 <code style="color:#806030; ">}</code>
1319
1320 <code style="color:#c34e00; ">/*</code>
1321 <code style="color:#c34e00; ">&nbsp;=======================================================================================================================</code>
1322 <code style="color:#c34e00; ">&nbsp;&nbsp;&nbsp;&nbsp;Handler for the "exambleEnabled" directive</code>
1323 <code style="color:#c34e00; ">&nbsp;=======================================================================================================================</code>
1324 <code style="color:#c34e00; ">&nbsp;*/</code>
1325 <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code> <code style="color:#806030; ">*</code>example_set_enabled<code style="color:#806030; ">(</code>cmd_parms <code style="color:#806030; ">*</code>cmd<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">void</code> <code style="color:#806030; ">*</code>cfg<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code> <code style="color:#806030; ">*</code>arg<code style="color:#806030; ">)</code>
1326 <code style="color:#806030; ">{</code>
1327     <code style="color:#c34e00; ">/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/</code>
1328     example_config    <code style="color:#806030; ">*</code>conf <code style="color:#806030; ">=</code> <code style="color:#806030; ">(</code>example_config <code style="color:#806030; ">*</code><code style="color:#806030; ">)</code> cfg<code style="color:#806030; ">;</code>
1329     <code style="color:#c34e00; ">/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/</code>
1330
1331     <code style="color:#400000; font-weight:bold; ">if</code><code style="color:#806030; ">(</code>conf<code style="color:#806030; ">)</code>
1332     <code style="color:#806030; ">{</code>
1333         <code style="color:#400000; font-weight:bold; ">if</code><code style="color:#806030; ">(</code><code style="color:#806030; ">!</code>strcasecmp<code style="color:#806030; ">(</code>arg<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">on</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">)</code>
1334             conf<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">enabled</code> <code style="color:#806030; ">=</code> <code style="color:#c00000; ">1</code><code style="color:#806030; ">;</code>
1335         <code style="color:#400000; font-weight:bold; ">else</code>
1336             conf<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">enabled</code> <code style="color:#806030; ">=</code> <code style="color:#c00000; ">0</code><code style="color:#806030; ">;</code>
1337     <code style="color:#806030; ">}</code>
1338
1339     <code style="color:#400000; font-weight:bold; ">return</code> <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">;</code>
1340 <code style="color:#806030; ">}</code>
1341
1342 <code style="color:#c34e00; ">/*</code>
1343 <code style="color:#c34e00; ">&nbsp;=======================================================================================================================</code>
1344 <code style="color:#c34e00; ">&nbsp;&nbsp;&nbsp;&nbsp;Handler for the "examplePath" directive</code>
1345 <code style="color:#c34e00; ">&nbsp;=======================================================================================================================</code>
1346 <code style="color:#c34e00; ">&nbsp;*/</code>
1347 <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code> <code style="color:#806030; ">*</code>example_set_path<code style="color:#806030; ">(</code>cmd_parms <code style="color:#806030; ">*</code>cmd<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">void</code> <code style="color:#806030; ">*</code>cfg<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code> <code style="color:#806030; ">*</code>arg<code style="color:#806030; ">)</code>
1348 <code style="color:#806030; ">{</code>
1349     <code style="color:#c34e00; ">/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/</code>
1350     example_config    <code style="color:#806030; ">*</code>conf <code style="color:#806030; ">=</code> <code style="color:#806030; ">(</code>example_config <code style="color:#806030; ">*</code><code style="color:#806030; ">)</code> cfg<code style="color:#806030; ">;</code>
1351     <code style="color:#c34e00; ">/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/</code>
1352
1353     <code style="color:#400000; font-weight:bold; ">if</code><code style="color:#806030; ">(</code>conf<code style="color:#806030; ">)</code>
1354     <code style="color:#806030; ">{</code>
1355         <code style="color:#800040; ">strcpy</code><code style="color:#806030; ">(</code>conf<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">path</code><code style="color:#806030; ">,</code> arg<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1356     <code style="color:#806030; ">}</code>
1357
1358     <code style="color:#400000; font-weight:bold; ">return</code> <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">;</code>
1359 <code style="color:#806030; ">}</code>
1360
1361 <code style="color:#c34e00; ">/*</code>
1362 <code style="color:#c34e00; ">&nbsp;=======================================================================================================================</code>
1363 <code style="color:#c34e00; ">&nbsp;&nbsp;&nbsp;&nbsp;Handler for the "exampleAction" directive ;</code>
1364 <code style="color:#c34e00; ">&nbsp;&nbsp;&nbsp;&nbsp;Let's pretend this one takes one argument (file or db), and a second (deny or allow), ;</code>
1365 <code style="color:#c34e00; ">&nbsp;&nbsp;&nbsp;&nbsp;and we store it in a bit-wise manner.</code>
1366 <code style="color:#c34e00; ">&nbsp;=======================================================================================================================</code>
1367 <code style="color:#c34e00; ">&nbsp;*/</code>
1368 <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code> <code style="color:#806030; ">*</code>example_set_action<code style="color:#806030; ">(</code>cmd_parms <code style="color:#806030; ">*</code>cmd<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">void</code> <code style="color:#806030; ">*</code>cfg<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code> <code style="color:#806030; ">*</code>arg1<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code> <code style="color:#806030; ">*</code>arg2<code style="color:#806030; ">)</code>
1369 <code style="color:#806030; ">{</code>
1370     <code style="color:#c34e00; ">/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/</code>
1371     example_config    <code style="color:#806030; ">*</code>conf <code style="color:#806030; ">=</code> <code style="color:#806030; ">(</code>example_config <code style="color:#806030; ">*</code><code style="color:#806030; ">)</code> cfg<code style="color:#806030; ">;</code>
1372     <code style="color:#c34e00; ">/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/</code>
1373
1374     <code style="color:#400000; font-weight:bold; ">if</code><code style="color:#806030; ">(</code>conf<code style="color:#806030; ">)</code>
1375     <code style="color:#806030; ">{</code>
1376         <code style="color:#806030; ">{</code>
1377             <code style="color:#400000; font-weight:bold; ">if</code><code style="color:#806030; ">(</code><code style="color:#806030; ">!</code>strcasecmp<code style="color:#806030; ">(</code>arg1<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">file</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">)</code>
1378                 conf<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">typeOfAction</code> <code style="color:#806030; ">=</code> <code style="color:#c00000; ">0x01</code><code style="color:#806030; ">;</code>
1379             <code style="color:#400000; font-weight:bold; ">else</code>
1380                 conf<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">typeOfAction</code> <code style="color:#806030; ">=</code> <code style="color:#c00000; ">0x02</code><code style="color:#806030; ">;</code>
1381             <code style="color:#400000; font-weight:bold; ">if</code><code style="color:#806030; ">(</code><code style="color:#806030; ">!</code>strcasecmp<code style="color:#806030; ">(</code>arg2<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">deny</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">)</code>
1382                 conf<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">typeOfAction</code> <code style="color:#806030; ">+</code><code style="color:#806030; ">=</code> <code style="color:#c00000; ">0x10</code><code style="color:#806030; ">;</code>
1383             <code style="color:#400000; font-weight:bold; ">else</code>
1384                 conf<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">typeOfAction</code> <code style="color:#806030; ">+</code><code style="color:#806030; ">=</code> <code style="color:#c00000; ">0x20</code><code style="color:#806030; ">;</code>
1385         <code style="color:#806030; ">}</code>
1386     <code style="color:#806030; ">}</code>
1387
1388     <code style="color:#400000; font-weight:bold; ">return</code> <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">;</code>
1389 <code style="color:#806030; ">}</code>
1390
1391 <code style="color:#c34e00; ">/*</code>
1392 <code style="color:#c34e00; ">&nbsp;=======================================================================================================================</code>
1393 <code style="color:#c34e00; ">&nbsp;&nbsp;&nbsp;&nbsp;Function for creating new configurations for per-directory contexts</code>
1394 <code style="color:#c34e00; ">&nbsp;=======================================================================================================================</code>
1395 <code style="color:#c34e00; ">&nbsp;*/</code>
1396 <code style="color:#400000; font-weight:bold; ">void</code> <code style="color:#806030; ">*</code>create_dir_conf<code style="color:#806030; ">(</code>apr_pool_t <code style="color:#806030; ">*</code>pool<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">char</code> <code style="color:#806030; ">*</code>context<code style="color:#806030; ">)</code>
1397 <code style="color:#806030; ">{</code>
1398     context <code style="color:#806030; ">=</code> context <code style="color:#806030; ">?</code> context <code style="color:#806030; ">:</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">Newly created configuration</code><code style="color:#800000; ">"</code><code style="color:#806030; ">;</code>
1399
1400     <code style="color:#c34e00; ">/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/</code>
1401     example_config    <code style="color:#806030; ">*</code>cfg <code style="color:#806030; ">=</code> apr_pcalloc<code style="color:#806030; ">(</code>pool<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">sizeof</code><code style="color:#806030; ">(</code>example_config<code style="color:#806030; ">)</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1402     <code style="color:#c34e00; ">/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/</code>
1403
1404     <code style="color:#400000; font-weight:bold; ">if</code><code style="color:#806030; ">(</code>cfg<code style="color:#806030; ">)</code>
1405     <code style="color:#806030; ">{</code>
1406         <code style="color:#806030; ">{</code>
1407             <code style="color:#c34e00; ">/* Set some default values */</code>
1408             <code style="color:#800040; ">strcpy</code><code style="color:#806030; ">(</code>cfg<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">context</code><code style="color:#806030; ">,</code> context<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1409             cfg<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">enabled</code> <code style="color:#806030; ">=</code> <code style="color:#c00000; ">0</code><code style="color:#806030; ">;</code>
1410             <code style="color:#800040; ">memset</code><code style="color:#806030; ">(</code>cfg<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">path</code><code style="color:#806030; ">,</code> <code style="color:#c00000; ">0</code><code style="color:#806030; ">,</code> <code style="color:#c00000; ">256</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1411             cfg<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">typeOfAction</code> <code style="color:#806030; ">=</code> <code style="color:#c00000; ">0x00</code><code style="color:#806030; ">;</code>
1412         <code style="color:#806030; ">}</code>
1413     <code style="color:#806030; ">}</code>
1414
1415     <code style="color:#400000; font-weight:bold; ">return</code> cfg<code style="color:#806030; ">;</code>
1416 <code style="color:#806030; ">}</code>
1417
1418 <code style="color:#c34e00; ">/*</code>
1419 <code style="color:#c34e00; ">&nbsp;=======================================================================================================================</code>
1420 <code style="color:#c34e00; ">&nbsp;&nbsp;&nbsp;&nbsp;Merging function for configurations</code>
1421 <code style="color:#c34e00; ">&nbsp;=======================================================================================================================</code>
1422 <code style="color:#c34e00; ">&nbsp;*/</code>
1423 <code style="color:#400000; font-weight:bold; ">void</code> <code style="color:#806030; ">*</code>merge_dir_conf<code style="color:#806030; ">(</code>apr_pool_t <code style="color:#806030; ">*</code>pool<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">void</code> <code style="color:#806030; ">*</code>BASE<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">void</code> <code style="color:#806030; ">*</code>ADD<code style="color:#806030; ">)</code>
1424 <code style="color:#806030; ">{</code>
1425     <code style="color:#c34e00; ">/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/</code>
1426     example_config    <code style="color:#806030; ">*</code>base <code style="color:#806030; ">=</code> BASE<code style="color:#806030; ">;</code>
1427     example_config    <code style="color:#806030; ">*</code>add <code style="color:#806030; ">=</code> ADD<code style="color:#806030; ">;</code>
1428     example_config    <code style="color:#806030; ">*</code>conf <code style="color:#806030; ">=</code> create_dir_conf<code style="color:#806030; ">(</code>pool<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">Merged configuration</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1429     <code style="color:#c34e00; ">/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/</code>
1430
1431     conf<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">enabled</code> <code style="color:#806030; ">=</code> <code style="color:#806030; ">(</code>add<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">enabled</code> <code style="color:#806030; ">=</code><code style="color:#806030; ">=</code> <code style="color:#c00000; ">0</code><code style="color:#806030; ">)</code> <code style="color:#806030; ">?</code> base<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">enabled</code> <code style="color:#806030; ">:</code> add<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">enabled</code><code style="color:#806030; ">;</code>
1432     conf<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">typeOfAction</code> <code style="color:#806030; ">=</code> add<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">typeOfAction</code> <code style="color:#806030; ">?</code> add<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">typeOfAction</code> <code style="color:#806030; ">:</code> base<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">typeOfAction</code><code style="color:#806030; ">;</code>
1433     <code style="color:#800040; ">strcpy</code><code style="color:#806030; ">(</code>conf<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">path</code><code style="color:#806030; ">,</code> <code style="color:#800040; ">strlen</code><code style="color:#806030; ">(</code>add<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">path</code><code style="color:#806030; ">)</code> <code style="color:#806030; ">?</code> add<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">path</code> <code style="color:#806030; ">:</code> base<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">path</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1434     <code style="color:#400000; font-weight:bold; ">return</code> conf<code style="color:#806030; ">;</code>
1435 <code style="color:#806030; ">}</code>
1436 </pre>
1437
1438
1439
1440
1441
1442
1443 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1444 <div class="section">
1445 <h2><a name="summary" id="summary">Summing up</a></h2>
1446 <p>
1447 We have now looked at how to create simple modules for Apache and configuring them. What you do next is entirely up
1448 to you, but it is my hope that something valuable has come out of reading this documentation. If you have questions
1449 on how to further develop modules, you are welcome to join our <a href="http://httpd.apache.org/lists.html">mailing lists</a>
1450 or check out the rest of our documentation for further tips.
1451 </p>
1452 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
1453 <div class="section">
1454 <h2><a name="snippets" id="snippets">Some useful snippets of code</a></h2>
1455
1456 <h3><a name="get_post" id="get_post">Retrieve a variable from POST form data</a></h3>
1457
1458
1459
1460 <pre style="color:#000000;background:#ffffef;border: 1px dashed #333; padding: 0.5em; margin: 1em 2em 1em 1em;">
1461 <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code> <code style="color:#806030; ">*</code>read_post_value<code style="color:#806030; ">(</code><code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code> <code style="color:#806030; ">*</code>key<code style="color:#806030; ">)</code>
1462 <code style="color:#806030; ">{</code>
1463     <code style="color:#c34e00; ">/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/</code>
1464     <code style="color:#400000; font-weight:bold; ">const</code> apr_array_header_t    <code style="color:#806030; ">*</code>fields<code style="color:#806030; ">;</code>
1465     <code style="color:#400000; font-weight:bold; ">int</code>                         i<code style="color:#806030; ">;</code>
1466     apr_table_entry_t           <code style="color:#806030; ">*</code>e <code style="color:#806030; ">=</code> <code style="color:#c00000; ">0</code><code style="color:#806030; ">;</code>
1467     <code style="color:#c34e00; ">/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/</code>
1468     e <code style="color:#806030; ">=</code> <code style="color:#806030; ">(</code>apr_table_entry_t <code style="color:#806030; ">*</code><code style="color:#806030; ">)</code> fields<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code>elts<code style="color:#806030; ">;</code>
1469     <code style="color:#400000; font-weight:bold; ">for</code><code style="color:#806030; ">(</code>i <code style="color:#806030; ">=</code> <code style="color:#c00000; ">0</code><code style="color:#806030; ">;</code> i <code style="color:#806030; ">&lt;</code> fields<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code>nelts<code style="color:#806030; ">;</code> i<code style="color:#806030; ">+</code><code style="color:#806030; ">+</code><code style="color:#806030; ">)</code> <code style="color:#806030; ">{</code>
1470         <code style="color:#400000; font-weight:bold; ">if</code><code style="color:#806030; ">(</code><code style="color:#806030; ">!</code><code style="color:#800040; ">strcmp</code><code style="color:#806030; ">(</code>e<code style="color:#806030; ">[</code>i<code style="color:#806030; ">]</code><code style="color:#806030; ">.</code>key<code style="color:#806030; ">,</code> key<code style="color:#806030; ">)</code><code style="color:#806030; ">)</code> <code style="color:#400000; font-weight:bold; ">return</code> e<code style="color:#806030; ">[</code>i<code style="color:#806030; ">]</code><code style="color:#806030; ">.</code>val<code style="color:#806030; ">;</code>
1471     <code style="color:#806030; ">}</code>
1472     <code style="color:#400000; font-weight:bold; ">return</code> <code style="color:#c00000; ">0</code><code style="color:#806030; ">;</code>
1473 <code style="color:#806030; ">}</code>
1474 <code style="color:#400000; font-weight:bold; ">static</code> <code style="color:#400000; font-weight:bold; ">int</code> example_handler<code style="color:#806030; ">(</code>request_req <code style="color:#806030; ">*</code>r<code style="color:#806030; ">)</code>
1475 <code style="color:#806030; ">{</code>
1476     <code style="color:#c34e00; ">/*~~~~~~~~~~~~~~~~~~~~~~*/</code>
1477     apr_array_header_t <code style="color:#806030; ">*</code>POST<code style="color:#806030; ">;</code>
1478     <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code>         <code style="color:#806030; ">*</code>value<code style="color:#806030; ">;</code>
1479     <code style="color:#c34e00; ">/*~~~~~~~~~~~~~~~~~~~~~~*/</code>
1480     ap_parse_form_data<code style="color:#806030; ">(</code>r<code style="color:#806030; ">,</code> <code style="color:#007d45; ">NULL</code><code style="color:#806030; ">,</code> <code style="color:#806030; ">&amp;</code>POST<code style="color:#806030; ">,</code> <code style="color:#806030; ">-</code><code style="color:#c00000; ">1</code><code style="color:#806030; ">,</code> <code style="color:#c00000; ">8192</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1481
1482     value <code style="color:#806030; ">=</code> read_post_value<code style="color:#806030; ">(</code>POST<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">valueA</code><code style="color:#800000; ">"</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1483     <code style="color:#400000; font-weight:bold; ">if</code> <code style="color:#806030; ">(</code><code style="color:#806030; ">!</code>value<code style="color:#806030; ">)</code> value <code style="color:#806030; ">=</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">(undefined)</code><code style="color:#800000; ">"</code><code style="color:#806030; ">;</code>
1484     ap_rprintf<code style="color:#806030; ">(</code>r<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">The value of valueA is: </code><code style="color:#0f6900; ">%s</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> value<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1485     <code style="color:#400000; font-weight:bold; ">return</code> OK<code style="color:#806030; ">;</code>
1486 <code style="color:#806030; ">}</code>
1487     </pre>
1488
1489
1490
1491
1492
1493     <h3><a name="headers_out" id="headers_out">Printing out every HTTP header received</a></h3>
1494
1495
1496
1497 <pre style="color:#000000;background:#ffffef;border: 1px dashed #333; padding: 0.5em; margin: 1em 2em 1em 1em;">
1498 <code style="color:#400000; font-weight:bold; ">static</code> <code style="color:#400000; font-weight:bold; ">int</code> example_handler<code style="color:#806030; ">(</code>request_req <code style="color:#806030; ">*</code>r<code style="color:#806030; ">)</code>
1499 <code style="color:#806030; ">{</code>
1500     <code style="color:#c34e00; ">/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/</code>
1501     <code style="color:#400000; font-weight:bold; ">const</code> apr_array_header_t    <code style="color:#806030; ">*</code>fields<code style="color:#806030; ">;</code>
1502     <code style="color:#400000; font-weight:bold; ">int</code>                         i<code style="color:#806030; ">;</code>
1503     apr_table_entry_t           <code style="color:#806030; ">*</code>e <code style="color:#806030; ">=</code> <code style="color:#c00000; ">0</code><code style="color:#806030; ">;</code>
1504     <code style="color:#c34e00; ">/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/</code>
1505
1506     fields <code style="color:#806030; ">=</code> <a href="http://apr.apache.org/docs/apr/1.4/group__apr__tables.html#gaea3005541cce67481f48ab201b5c0cf3">apr_table_elts</a><code style="color:#806030; ">(</code>r<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code>headers_in<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1507     e <code style="color:#806030; ">=</code> <code style="color:#806030; ">(</code>apr_table_entry_t <code style="color:#806030; ">*</code><code style="color:#806030; ">)</code> fields<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code>elts<code style="color:#806030; ">;</code>
1508     <code style="color:#400000; font-weight:bold; ">for</code><code style="color:#806030; ">(</code>i <code style="color:#806030; ">=</code> <code style="color:#c00000; ">0</code><code style="color:#806030; ">;</code> i <code style="color:#806030; ">&lt;</code> fields<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code>nelts<code style="color:#806030; ">;</code> i<code style="color:#806030; ">+</code><code style="color:#806030; ">+</code><code style="color:#806030; ">)</code> <code style="color:#806030; ">{</code>
1509         ap_rprintf<code style="color:#806030; ">(</code>r<code style="color:#806030; ">,</code> <code style="color:#800000; ">"</code><code style="color:#e60000; ">&lt;b&gt;</code><code style="color:#0f6900; ">%s</code><code style="color:#e60000; ">&lt;/b&gt;: </code><code style="color:#0f6900; ">%s</code><code style="color:#e60000; ">&lt;br/&gt;</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> e<code style="color:#806030; ">[</code>i<code style="color:#806030; ">]</code><code style="color:#806030; ">.</code>key<code style="color:#806030; ">,</code> e<code style="color:#806030; ">[</code>i<code style="color:#806030; ">]</code><code style="color:#806030; ">.</code>val<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1510     <code style="color:#806030; ">}</code>
1511     <code style="color:#400000; font-weight:bold; ">return</code> OK<code style="color:#806030; ">;</code>
1512 <code style="color:#806030; ">}</code>
1513     </pre>
1514
1515
1516
1517
1518
1519     <h3><a name="request_body" id="request_body">Reading the request body into memory</a></h3>
1520
1521
1522
1523 <pre style="color:#000000;background:#ffffef;border: 1px dashed #333; padding: 0.5em; margin: 1em 2em 1em 1em;">
1524 <code style="color:#400000; font-weight:bold; ">static</code> <code style="color:#400000; font-weight:bold; ">int</code> util_read<code style="color:#806030; ">(</code>request_rec <code style="color:#806030; ">*</code>r<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code> <code style="color:#806030; ">*</code><code style="color:#806030; ">*</code>rbuf<code style="color:#806030; ">,</code> apr_off_t <code style="color:#806030; ">*</code>size<code style="color:#806030; ">)</code>
1525 <code style="color:#806030; ">{</code>
1526     <code style="color:#c34e00; ">/*~~~~~~~~*/</code>
1527     <code style="color:#400000; font-weight:bold; ">int</code> rc <code style="color:#806030; ">=</code> OK<code style="color:#806030; ">;</code>
1528     <code style="color:#c34e00; ">/*~~~~~~~~*/</code>
1529
1530     <code style="color:#400000; font-weight:bold; ">if</code><code style="color:#806030; ">(</code><code style="color:#806030; ">(</code>rc <code style="color:#806030; ">=</code> ap_setup_client_block<code style="color:#806030; ">(</code>r<code style="color:#806030; ">,</code> REQUEST_CHUNKED_ERROR<code style="color:#806030; ">)</code><code style="color:#806030; ">)</code><code style="color:#806030; ">)</code> <code style="color:#806030; ">{</code>
1531         <code style="color:#400000; font-weight:bold; ">return</code><code style="color:#806030; ">(</code>rc<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1532     <code style="color:#806030; ">}</code>
1533
1534     <code style="color:#400000; font-weight:bold; ">if</code><code style="color:#806030; ">(</code>ap_should_client_block<code style="color:#806030; ">(</code>r<code style="color:#806030; ">)</code><code style="color:#806030; ">)</code> <code style="color:#806030; ">{</code>
1535
1536         <code style="color:#c34e00; ">/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/</code>
1537         <code style="color:#400000; font-weight:bold; ">char</code>         argsbuffer<code style="color:#806030; ">[</code>HUGE_STRING_LEN<code style="color:#806030; ">]</code><code style="color:#806030; ">;</code>
1538         apr_off_t    rsize<code style="color:#806030; ">,</code> len_read<code style="color:#806030; ">,</code> rpos <code style="color:#806030; ">=</code> <code style="color:#c00000; ">0</code><code style="color:#806030; ">;</code>
1539         apr_off_t length <code style="color:#806030; ">=</code> r<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">remaining</code><code style="color:#806030; ">;</code>
1540         <code style="color:#c34e00; ">/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/</code>
1541
1542         <code style="color:#806030; ">*</code>rbuf <code style="color:#806030; ">=</code> <code style="color:#806030; ">(</code><code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code> <code style="color:#806030; ">*</code><code style="color:#806030; ">)</code> apr_pcalloc<code style="color:#806030; ">(</code>r<code style="color:#806030; ">-</code><code style="color:#806030; ">&gt;</code><code style="color:#008833">pool</code><code style="color:#806030; ">,</code> <code style="color:#806030; ">(</code>apr_size_t<code style="color:#806030; ">)</code> <code style="color:#806030; ">(</code>length <code style="color:#806030; ">+</code> <code style="color:#c00000; ">1</code><code style="color:#806030; ">)</code><code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1543         <code style="color:#806030; ">*</code>size <code style="color:#806030; ">=</code> length<code style="color:#806030; ">;</code>
1544         <code style="color:#400000; font-weight:bold; ">while</code><code style="color:#806030; ">(</code><code style="color:#806030; ">(</code>len_read <code style="color:#806030; ">=</code> ap_get_client_block<code style="color:#806030; ">(</code>r<code style="color:#806030; ">,</code> argsbuffer<code style="color:#806030; ">,</code> <code style="color:#400000; font-weight:bold; ">sizeof</code><code style="color:#806030; ">(</code>argsbuffer<code style="color:#806030; ">)</code><code style="color:#806030; ">)</code><code style="color:#806030; ">)</code> <code style="color:#806030; ">&gt;</code> <code style="color:#c00000; ">0</code><code style="color:#806030; ">)</code> <code style="color:#806030; ">{</code>
1545             <code style="color:#400000; font-weight:bold; ">if</code><code style="color:#806030; ">(</code><code style="color:#806030; ">(</code>rpos <code style="color:#806030; ">+</code> len_read<code style="color:#806030; ">)</code> <code style="color:#806030; ">&gt;</code> length<code style="color:#806030; ">)</code> <code style="color:#806030; ">{</code>
1546                 rsize <code style="color:#806030; ">=</code> length <code style="color:#806030; ">-</code> rpos<code style="color:#806030; ">;</code>
1547             <code style="color:#806030; ">}</code>
1548             <code style="color:#400000; font-weight:bold; ">else</code> <code style="color:#806030; ">{</code>
1549                 rsize <code style="color:#806030; ">=</code> len_read<code style="color:#806030; ">;</code>
1550             <code style="color:#806030; ">}</code>
1551
1552             <code style="color:#800040; ">memcpy</code><code style="color:#806030; ">(</code><code style="color:#806030; ">(</code><code style="color:#400000; font-weight:bold; ">char</code> <code style="color:#806030; ">*</code><code style="color:#806030; ">)</code> <code style="color:#806030; ">*</code>rbuf <code style="color:#806030; ">+</code> rpos<code style="color:#806030; ">,</code> argsbuffer<code style="color:#806030; ">,</code> <code style="color:#806030; ">(</code><code style="color:#800040; ">size_t</code><code style="color:#806030; ">)</code> rsize<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1553             rpos <code style="color:#806030; ">+</code><code style="color:#806030; ">=</code> rsize<code style="color:#806030; ">;</code>
1554         <code style="color:#806030; ">}</code>
1555     <code style="color:#806030; ">}</code>
1556     <code style="color:#400000; font-weight:bold; ">return</code><code style="color:#806030; ">(</code>rc<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1557 <code style="color:#806030; ">}</code>
1558
1559 <code style="color:#400000; font-weight:bold; ">static</code> <code style="color:#400000; font-weight:bold; ">int</code> example_handler<code style="color:#806030; ">(</code>request_req<code style="color:#806030; ">*</code> r<code style="color:#806030; ">)</code>
1560 <code style="color:#806030; ">{</code>
1561     <code style="color:#c34e00; ">/*~~~~~~~~~~~~~~~~*/</code>
1562     apr_off_t   size<code style="color:#806030; ">;</code>
1563     <code style="color:#400000; font-weight:bold; ">const</code> <code style="color:#400000; font-weight:bold; ">char</code>  <code style="color:#806030; ">*</code>buffer<code style="color:#806030; ">;</code>
1564     <code style="color:#c34e00; ">/*~~~~~~~~~~~~~~~~*/</code>
1565
1566     <code style="color:#400000; font-weight:bold; ">if</code><code style="color:#806030; ">(</code>util_read<code style="color:#806030; ">(</code>r<code style="color:#806030; ">,</code> <code style="color:#806030; ">&amp;</code>data<code style="color:#806030; ">,</code> <code style="color:#806030; ">&amp;</code>size<code style="color:#806030; ">)</code> <code style="color:#806030; ">=</code><code style="color:#806030; ">=</code> OK<code style="color:#806030; ">)</code> <code style="color:#806030; ">{</code>
1567         ap_rprintf<code style="color:#806030; ">(</code><code style="color:#800000; ">"</code><code style="color:#e60000; ">We read a request body that was </code><code style="color:#0f6900; ">%u</code><code style="color:#e60000; "> bytes long</code><code style="color:#800000; ">"</code><code style="color:#806030; ">,</code> size<code style="color:#806030; ">)</code><code style="color:#806030; ">;</code>
1568     <code style="color:#806030; ">}</code>
1569     <code style="color:#400000; font-weight:bold; ">return</code> OK<code style="color:#806030; ">;</code>
1570 <code style="color:#806030; ">}</code>
1571     </pre>
1572
1573
1574
1575
1576
1577 </div></div>
1578 <div class="bottomlang">
1579 <p><span>Available Languages: </span><a href="../en/developer/modguide.html" title="English">&nbsp;en&nbsp;</a></p>
1580 </div><div id="footer">
1581 <p class="apache">Copyright 2012 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>
1582 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
1583 </body></html>