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 / F277681_handler.xml < prev    next >
Extensible Markup Language  |  2004-04-17  |  6KB  |  163 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.3.2.6 $ -->
  5.  
  6. <!--
  7.  Copyright 2002-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="handler.xml.meta">
  23.  
  24.   <title>Apache's Handler Use</title>
  25.  
  26.   <summary>
  27.     <p>This document describes the use of Apache's Handlers.</p>
  28.   </summary>
  29.  
  30.   <section id="definition">
  31.     <title>What is a Handler</title>
  32.     <related>
  33.       <modulelist>
  34.         <module>mod_actions</module>
  35.         <module>mod_asis</module>
  36.         <module>mod_cgi</module>
  37.         <module>mod_imap</module>
  38.         <module>mod_info</module>
  39.         <module>mod_mime</module>
  40.         <module>mod_negotiation</module>
  41.         <module>mod_status</module>
  42.      </modulelist>
  43.       <directivelist>
  44.         <directive module="mod_actions">Action</directive>
  45.         <directive module="mod_mime">AddHandler</directive>
  46.         <directive module="mod_mime">RemoveHandler</directive>
  47.         <directive module="core">SetHandler</directive>
  48.       </directivelist>
  49.     </related>
  50.  
  51.  
  52.     <p>A "handler" is an internal Apache representation of the
  53.     action to be performed when a file is called. Generally, files
  54.     have implicit handlers, based on the file type. Normally, all
  55.     files are simply served by the server, but certain file types
  56.     are "handled" separately.</p>
  57.  
  58.     <p>Apache 1.1 adds the ability to use handlers explicitly.
  59.     Based on either filename extensions or on location, handlers
  60.     can be specified without relation to file type. This is
  61.     advantageous both because it is a more elegant solution, and
  62.     because it also allows for both a type <strong>and</strong> a
  63.     handler to be associated with a file. (See also <a
  64.     href="mod/mod_mime.html#multipleext">Files with Multiple
  65.     Extensions</a>.)</p>
  66.  
  67.     <p>Handlers can either be built into the server or included in
  68.     a module, or they can be added with the <directive 
  69.     module="mod_actions">Action</directive> directive. The
  70.     built-in handlers in the standard distribution are as
  71.     follows:</p>
  72.  
  73.     <ul>
  74.       <li><strong>default-handler</strong>: Send the file using the
  75.       <code>default_handler()</code>, which is the handler used by
  76.       default to handle static content. (core)</li>
  77.  
  78.       <li><strong>send-as-is</strong>: Send file with HTTP headers
  79.       as is. (<module>mod_asis</module>)</li>
  80.  
  81.       <li><strong>cgi-script</strong>: Treat the file as a CGI
  82.       script. (<module>mod_cgi</module>)</li>
  83.  
  84.       <li><strong>imap-file</strong>: Parse as an imagemap rule
  85.       file. (<module>mod_imap</module>)</li>
  86.  
  87.       <li><strong>server-info</strong>: Get the server's
  88.       configuration information. (<module>mod_info</module>)</li>
  89.  
  90.       <li><strong>server-status</strong>: Get the server's status
  91.       report. (<module>mod_status</module>)</li>
  92.  
  93.       <li><strong>type-map</strong>: Parse as a type map file for
  94.       content negotiation. (<module>mod_negotiation</module>)</li>
  95.     </ul>
  96.   </section>
  97.   <section id="examples">
  98.     <title>Examples</title>
  99.  
  100.     <section id="example1">
  101.       <title>Modifying static content using a CGI script</title>
  102.  
  103.       <p>The following directives will cause requests for files with
  104.       the <code>html</code> extension to trigger the launch of the
  105.       <code>footer.pl</code> CGI script.</p>
  106.  
  107.       <example>
  108.         Action add-footer /cgi-bin/footer.pl<br/>
  109.         AddHandler add-footer .html
  110.       </example>
  111.  
  112.       <p>Then the CGI script is responsible for sending the
  113.       originally requested document (pointed to by the
  114.       <code>PATH_TRANSLATED</code> environment variable) and making
  115.       whatever modifications or additions are desired.</p>
  116.  
  117.     </section>
  118.     <section id="example2">
  119.       <title>Files with HTTP headers</title>
  120.  
  121.       <p>The following directives will enable the
  122.       <code>send-as-is</code> handler, which is used for files which
  123.       contain their own HTTP headers. All files in the
  124.       <code>/web/htdocs/asis/</code> directory will be processed by
  125.       the <code>send-as-is</code> handler, regardless of their
  126.       filename extensions.</p>
  127.  
  128.       <example>
  129.         <Directory /web/htdocs/asis><br/>
  130.         SetHandler send-as-is<br/>
  131.         </Directory>
  132.       </example>
  133.  
  134.     </section>
  135.   </section>
  136.   <section id="programmer">
  137.     <title>Programmer's Note</title>
  138.  
  139.     <p>In order to implement the handler features, an addition has
  140.     been made to the <a href="developer/API.html">Apache API</a> that
  141.     you may wish to make use of. Specifically, a new record has
  142.     been added to the <code>request_rec</code> structure:</p>
  143.  
  144.     <example>
  145.       char *handler
  146.     </example>
  147.  
  148.     <p>If you wish to have your module engage a handler, you need
  149.     only to set <code>r->handler</code> to the name of the
  150.     handler at any time prior to the <code>invoke_handler</code>
  151.     stage of the request. Handlers are implemented as they were
  152.     before, albeit using the handler name instead of a content
  153.     type. While it is not necessary, the naming convention for
  154.     handlers is to use a dash-separated word, with no slashes, so
  155.     as to not invade the media type name-space.</p>
  156.   </section>
  157. </manualpage>
  158.  
  159.  
  160.  
  161.  
  162.  
  163.