home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 November / CMCD1104.ISO / Software / Complet / Apache / apache_2.0.52-win32-x86-no_ssl.msi / Data.Cab / F277793_modules.xml < prev    next >
Extensible Markup Language  |  2004-04-17  |  10KB  |  272 lines
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <!DOCTYPE manualpage SYSTEM "../style/manualpage.dtd">
  3. <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
  4. <!-- $Revision: 1.1.2.7 $ -->
  5.  
  6. <!--
  7.  Copyright 2003-2004 The Apache Software Foundation
  8.  
  9.  Licensed under the Apache License, Version 2.0 (the "License");
  10.  you may not use this file except in compliance with the License.
  11.  You may obtain a copy of the License at
  12.  
  13.      http://www.apache.org/licenses/LICENSE-2.0
  14.  
  15.  Unless required by applicable law or agreed to in writing, software
  16.  distributed under the License is distributed on an "AS IS" BASIS,
  17.  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18.  See the License for the specific language governing permissions and
  19.  limitations under the License.
  20. -->
  21.  
  22. <manualpage metafile="modules.xml.meta">
  23. <parentdocument href="./">Developer Documentation</parentdocument>
  24.  
  25. <title>Converting Modules from Apache 1.3 to Apache 2.0</title>
  26.  
  27. <summary>
  28.     <p>This is a first attempt at writing the lessons I learned
  29.     when trying to convert the <code>mod_mmap_static</code> module to Apache
  30.     2.0. It's by no means definitive and probably won't even be
  31.     correct in some ways, but it's a start.</p>
  32. </summary>
  33.  
  34. <section id="easy"><title>The easier changes ...</title>
  35.  
  36.     <section id="cleanup"><title>Cleanup Routines</title>
  37.       <p>These now need to be of type <code>apr_status_t</code> and return a
  38.       value of that type. Normally the return value will be
  39.       <code>APR_SUCCESS</code> unless there is some need to signal an error in
  40.       the cleanup. Be aware that even though you signal an error not all code
  41.       yet checks and acts upon the error.</p>
  42.     </section>
  43.  
  44.     <section id="init"><title>Initialisation Routines</title>
  45.       <p>These should now be renamed to better signify where they sit
  46.       in the overall process. So the name gets a small change from
  47.       <code>mmap_init</code> to <code>mmap_post_config</code>. The arguments
  48.       passed have undergone a radical change and now look like</p>
  49.  
  50.       <ul>
  51.         <li><code>apr_pool_t *p</code></li>
  52.         <li><code>apr_pool_t *plog</code></li>
  53.         <li><code>apr_pool_t *ptemp</code></li>
  54.         <li><code>server_rec *s</code></li>
  55.       </ul>
  56.     </section>
  57.  
  58.     <section id="datatypes"><title>Data Types</title>
  59.       <p>A lot of the data types have been moved into the <a
  60.       href="http://apr.apache.org/">APR</a>. This means that some have had
  61.       a name change, such as the one shown above. The following is a brief
  62.       list of some of the changes that you are likely to have to make.</p>
  63.  
  64.       <ul>
  65.         <li><code>pool</code> becomes <code>apr_pool_t</code></li>
  66.         <li><code>table</code> becomes <code>apr_table_t</code></li>
  67.       </ul>
  68.     </section>
  69. </section>
  70.  
  71. <section id="messy"><title>The messier changes...</title>
  72.  
  73.     <section id="register-hooks"><title>Register Hooks</title>
  74.       <p>The new architecture uses a series of hooks to provide for
  75.       calling your functions. These you'll need to add to your module
  76.       by way of a new function, <code>static void register_hooks(void)</code>.
  77.       The function is really reasonably straightforward once you
  78.       understand what needs to be done. Each function that needs
  79.       calling at some stage in the processing of a request needs to
  80.       be registered, handlers do not. There are a number of phases
  81.       where functions can be added, and for each you can specify with
  82.       a high degree of control the relative order that the function
  83.       will be called in.</p>
  84.  
  85.       <p>This is the code that was added to <code>mod_mmap_static</code>:</p>
  86.       <example><pre>
  87. static void register_hooks(void)
  88. {
  89.     static const char * const aszPre[]={ "http_core.c",NULL };
  90.     ap_hook_post_config(mmap_post_config,NULL,NULL,HOOK_MIDDLE);
  91.     ap_hook_translate_name(mmap_static_xlat,aszPre,NULL,HOOK_LAST);
  92. };</pre>
  93.       </example>
  94.  
  95.       <p>This registers 2 functions that need to be called, one in
  96.       the <code>post_config</code> stage (virtually every module will need this
  97.       one) and one for the <code>translate_name</code> phase. note that while
  98.       there are different function names the format of each is
  99.       identical. So what is the format?</p>
  100.  
  101.       <example>
  102.         ap_hook_<var>phase_name</var>(<var>function_name</var>,
  103.         <var>predecessors</var>, <var>successors</var>, <var>position</var>);
  104.       </example>
  105.  
  106.       <p>There are 3 hook positions defined...</p>
  107.  
  108.       <ul>
  109.         <li><code>HOOK_FIRST</code></li>
  110.         <li><code>HOOK_MIDDLE</code></li>
  111.         <li><code>HOOK_LAST</code></li>
  112.       </ul>
  113.  
  114.       <p>To define the position you use the position and then modify
  115.       it with the predecessors and successors. Each of the modifiers
  116.       can be a list of functions that should be called, either before
  117.       the function is run (predecessors) or after the function has
  118.       run (successors).</p>
  119.  
  120.       <p>In the <code>mod_mmap_static</code> case I didn't care about the
  121.       <code>post_config</code> stage, but the <code>mmap_static_xlat</code>
  122.       <strong>must</strong> be called after the core module had done it's name
  123.       translation, hence the use of the aszPre to define a modifier to the
  124.       position <code>HOOK_LAST</code>.</p>
  125.     </section>
  126.  
  127.     <section id="moddef"><title>Module Definition</title>
  128.       <p>There are now a lot fewer stages to worry about when
  129.       creating your module definition. The old defintion looked
  130.       like</p>
  131.  
  132.       <example><pre>
  133. module MODULE_VAR_EXPORT <var>module_name</var>_module =
  134. {
  135.     STANDARD_MODULE_STUFF,
  136.     /* initializer */
  137.     /* dir config creater */
  138.     /* dir merger --- default is to override */
  139.     /* server config */
  140.     /* merge server config */
  141.     /* command handlers */
  142.     /* handlers */
  143.     /* filename translation */
  144.     /* check_user_id */
  145.     /* check auth */
  146.     /* check access */
  147.     /* type_checker */
  148.     /* fixups */
  149.     /* logger */
  150.     /* header parser */
  151.     /* child_init */
  152.     /* child_exit */
  153.     /* post read-request */
  154. };</pre>
  155.       </example>
  156.  
  157.       <p>The new structure is a great deal simpler...</p>
  158.       <example><pre>
  159. module MODULE_VAR_EXPORT <var>module_name</var>_module =
  160. {
  161.     STANDARD20_MODULE_STUFF,
  162.     /* create per-directory config structures */
  163.     /* merge per-directory config structures  */
  164.     /* create per-server config structures    */
  165.     /* merge per-server config structures     */
  166.     /* command handlers */
  167.     /* handlers */
  168.     /* register hooks */
  169. };</pre>
  170.       </example>
  171.  
  172.       <p>Some of these read directly across, some don't. I'll try to
  173.       summarise what should be done below.</p>
  174.  
  175.       <p>The stages that read directly across :</p>
  176.  
  177.       <dl>
  178.         <dt><code>/* dir config creater */</code></dt>
  179.         <dd><code>/* create per-directory config structures */</code></dd>
  180.  
  181.         <dt><code>/* server config */</code></dt>
  182.         <dd><code>/* create per-server config structures */</code></dd>
  183.  
  184.         <dt><code>/* dir merger */</code></dt>
  185.         <dd><code>/* merge per-directory config structures */</code></dd>
  186.  
  187.         <dt><code>/* merge server config */</code></dt>
  188.         <dd><code>/* merge per-server config structures */</code></dd>
  189.  
  190.         <dt><code>/* command table */</code></dt>
  191.         <dd><code>/* command apr_table_t */</code></dd>
  192.  
  193.         <dt><code>/* handlers */</code></dt>
  194.         <dd><code>/* handlers */</code></dd>
  195.       </dl>
  196.  
  197.       <p>The remainder of the old functions should be registered as
  198.       hooks. There are the following hook stages defined so
  199.       far...</p>
  200.  
  201.       <dl>
  202.         <dt><code>ap_hook_post_config</code></dt>
  203.         <dd>this is where the old <code>_init</code> routines get
  204.         registered</dd>
  205.  
  206.         <dt><code>ap_hook_http_method</code></dt>
  207.         <dd>retrieve the http method from a request. (legacy)</dd>
  208.  
  209.         <dt><code>ap_hook_open_logs</code></dt>
  210.         <dd>open any specified logs</dd>
  211.  
  212.         <dt><code>ap_hook_auth_checker</code></dt>
  213.         <dd>check if the resource requires authorization</dd>
  214.  
  215.         <dt><code>ap_hook_access_checker</code></dt>
  216.         <dd>check for module-specific restrictions</dd>
  217.  
  218.         <dt><code>ap_hook_check_user_id</code></dt>
  219.         <dd>check the user-id and password</dd>
  220.  
  221.         <dt><code>ap_hook_default_port</code></dt>
  222.         <dd>retrieve the default port for the server</dd>
  223.  
  224.         <dt><code>ap_hook_pre_connection</code></dt>
  225.         <dd>do any setup required just before processing, but after
  226.         accepting</dd>
  227.  
  228.         <dt><code>ap_hook_process_connection</code></dt>
  229.         <dd>run the correct protocol</dd>
  230.  
  231.         <dt><code>ap_hook_child_init</code></dt>
  232.         <dd>call as soon as the child is started</dd>
  233.  
  234.         <dt><code>ap_hook_create_request</code></dt>
  235.         <dd>??</dd>
  236.  
  237.         <dt><code>ap_hook_fixups</code></dt>
  238.         <dd>last chance to modify things before generating content</dd>
  239.  
  240.         <dt><code>ap_hook_handler</code></dt>
  241.         <dd>generate the content</dd>
  242.  
  243.         <dt><code>ap_hook_header_parser</code></dt>
  244.         <dd>lets modules look at the headers, not used by most modules, because
  245.         they use <code>post_read_request</code> for this</dd>
  246.  
  247.         <dt><code>ap_hook_insert_filter</code></dt>
  248.         <dd>to insert filters into the filter chain</dd>
  249.  
  250.         <dt><code>ap_hook_log_transaction</code></dt>
  251.         <dd>log information about the request</dd>
  252.  
  253.         <dt><code>ap_hook_optional_fn_retrieve</code></dt>
  254.         <dd>retrieve any functions registered as optional</dd>
  255.  
  256.         <dt><code>ap_hook_post_read_request</code></dt>
  257.         <dd>called after reading the request, before any other phase</dd>
  258.  
  259.         <dt><code>ap_hook_quick_handler</code></dt>
  260.         <dd>called before any request processing, used by cache modules.</dd>
  261.  
  262.         <dt><code>ap_hook_translate_name</code></dt>
  263.         <dd>translate the URI into a filename</dd>
  264.  
  265.         <dt><code>ap_hook_type_checker</code></dt>
  266.         <dd>determine and/or set the doc type</dd>
  267.       </dl>
  268.     </section>
  269. </section>
  270. </manualpage>
  271.  
  272.