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