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