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