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