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 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
   5 <!--
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7               This file is generated from xml source: DO NOT EDIT
   8         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   9       -->
  10 <title>Apache's Handler Use - Apache HTTP Server Version 2.5</title>
  11 <link href="./style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  12 <link href="./style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  13 <link href="./style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="./style/css/prettify.css" />
  14 <script src="./style/scripts/prettify.min.js" type="text/javascript">
  15 </script>
  16
  17 <link href="./images/favicon.ico" rel="shortcut icon" /></head>
  18 <body id="manual-page"><div id="page-header">
  19 <p class="menu"><a href="./mod/">Modules</a> | <a href="./mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="./glossary.html">Glossary</a> | <a href="./sitemap.html">Sitemap</a></p>
  20 <p class="apache">Apache HTTP Server Version 2.5</p>
  21 <img alt="" src="./images/feather.png" /></div>
  22 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="./images/left.gif" /></a></div>
  23 <div id="path">
  24 <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.5</a></div><div id="page-content"><div id="preamble"><h1>Apache's Handler Use</h1>
  25 <div class="toplang">
  26 <p><span>Available Languages: </span><a href="./en/handler.html" title="English">&nbsp;en&nbsp;</a> |
  27 <a href="./es/handler.html" hreflang="es" rel="alternate" title="Español">&nbsp;es&nbsp;</a> |
  28 <a href="./fr/handler.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
  29 <a href="./ja/handler.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
  30 <a href="./ko/handler.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
  31 <a href="./tr/handler.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a> |
  32 <a href="./zh-cn/handler.html" hreflang="zh-cn" rel="alternate" title="Simplified Chinese">&nbsp;zh-cn&nbsp;</a></p>
  33 </div>
  34
  35     <p>This document describes the use of Apache's Handlers.</p>
  36   </div>
  37 <div id="quickview"><ul id="toc"><li><img alt="" src="./images/down.gif" /> <a href="#definition">What is a Handler</a></li>
  38 <li><img alt="" src="./images/down.gif" /> <a href="#examples">Examples</a></li>
  39 <li><img alt="" src="./images/down.gif" /> <a href="#programmer">Programmer's Note</a></li>
  40 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
  41 <div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
  42 <div class="section">
  43 <h2><a name="definition" id="definition">What is a Handler</a></h2>
  44
  45     <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>
  46
  47
  48     <p>A "handler" is an internal Apache representation of the
  49     action to be performed when a file is called. Generally, files
  50     have implicit handlers, based on the file type. Normally, all
  51     files are simply served by the server, but certain file types
  52     are "handled" separately.</p>
  53
  54     <p>Handlers may also be configured explicitly,
  55     based on either filename extensions or on location,
  56     without relation to file type. This is
  57     advantageous both because it is a more elegant solution, and
  58     because it also allows for both a type <strong>and</strong> a
  59     handler to be associated with a file. (See also <a href="mod/mod_mime.html#multipleext">Files with Multiple
  60     Extensions</a>.)</p>
  61
  62     <p>Handlers can either be built into the server or included in
  63     a module, or they can be added with the <code class="directive"><a href="./mod/mod_actions.html#action">Action</a></code> directive. The
  64     built-in handlers in the standard distribution are as
  65     follows:</p>
  66
  67     <ul>
  68       <li><strong>default-handler</strong>: Send the file using the
  69       <code>default_handler()</code>, which is the handler used by
  70       default to handle static content. (core)</li>
  71
  72       <li><strong>send-as-is</strong>: Send file with HTTP headers
  73       as is. (<code class="module"><a href="./mod/mod_asis.html">mod_asis</a></code>)</li>
  74
  75       <li><strong>cgi-script</strong>: Treat the file as a CGI
  76       script. (<code class="module"><a href="./mod/mod_cgi.html">mod_cgi</a></code>)</li>
  77
  78       <li><strong>imap-file</strong>: Parse as an imagemap rule
  79       file. (<code class="module"><a href="./mod/mod_imagemap.html">mod_imagemap</a></code>)</li>
  80
  81       <li><strong>server-info</strong>: Get the server's
  82       configuration information. (<code class="module"><a href="./mod/mod_info.html">mod_info</a></code>)</li>
  83
  84       <li><strong>server-status</strong>: Get the server's status
  85       report. (<code class="module"><a href="./mod/mod_status.html">mod_status</a></code>)</li>
  86
  87       <li><strong>type-map</strong>: Parse as a type map file for
  88       content negotiation. (<code class="module"><a href="./mod/mod_negotiation.html">mod_negotiation</a></code>)</li>
  89     </ul>
  90   </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
  91 <div class="section">
  92 <h2><a name="examples" id="examples">Examples</a></h2>
  93
  94
  95     <h3><a name="example1" id="example1">Modifying static content using a CGI script</a></h3>
  96
  97
  98       <p>The following directives will cause requests for files with
  99       the <code>html</code> extension to trigger the launch of the
 100       <code>footer.pl</code> CGI script.</p>
 101
 102       <pre class="prettyprint lang-config">Action add-footer /cgi-bin/footer.pl
 103 AddHandler add-footer .html</pre>
 104
 105
 106       <p>Then the CGI script is responsible for sending the
 107       originally requested document (pointed to by the
 108       <code>PATH_TRANSLATED</code> environment variable) and making
 109       whatever modifications or additions are desired.</p>
 110
 111
 112     <h3><a name="example2" id="example2">Files with HTTP headers</a></h3>
 113
 114
 115       <p>The following directives will enable the
 116       <code>send-as-is</code> handler, which is used for files which
 117       contain their own HTTP headers. All files in the
 118       <code>/web/htdocs/asis/</code> directory will be processed by
 119       the <code>send-as-is</code> handler, regardless of their
 120       filename extensions.</p>
 121
 122       <pre class="prettyprint lang-config">&lt;Directory "/web/htdocs/asis"&gt;
 123     SetHandler send-as-is
 124 &lt;/Directory&gt;</pre>
 125
 126
 127
 128   </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
 129 <div class="section">
 130 <h2><a name="programmer" id="programmer">Programmer's Note</a></h2>
 131
 132
 133     <p>In order to implement the handler features, an addition has
 134     been made to the <a href="developer/API.html">Apache API</a> that
 135     you may wish to make use of. Specifically, a new record has
 136     been added to the <code>request_rec</code> structure:</p>
 137
 138     <pre class="prettyprint lang-c">char *handler</pre>
 139
 140
 141     <p>If you wish to have your module engage a handler, you need
 142     only to set <code>r-&gt;handler</code> to the name of the
 143     handler at any time prior to the <code>invoke_handler</code>
 144     stage of the request. Handlers are implemented as they were
 145     before, albeit using the handler name instead of a content
 146     type. While it is not necessary, the naming convention for
 147     handlers is to use a dash-separated word, with no slashes, so
 148     as to not invade the media type name-space.</p>
 149   </div></div>
 150 <div class="bottomlang">
 151 <p><span>Available Languages: </span><a href="./en/handler.html" title="English">&nbsp;en&nbsp;</a> |
 152 <a href="./es/handler.html" hreflang="es" rel="alternate" title="Español">&nbsp;es&nbsp;</a> |
 153 <a href="./fr/handler.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
 154 <a href="./ja/handler.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 155 <a href="./ko/handler.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
 156 <a href="./tr/handler.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a> |
 157 <a href="./zh-cn/handler.html" hreflang="zh-cn" rel="alternate" title="Simplified Chinese">&nbsp;zh-cn&nbsp;</a></p>
 158 </div><div class="top"><a href="#page-header"><img src="./images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&amp;A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
 159 <script type="text/javascript"><!--//--><![CDATA[//><!--
 160 var comments_shortname = 'httpd';
 161 var comments_identifier = 'http://httpd.apache.org/docs/trunk/handler.html';
 162 (function(w, d) {
 163     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 164         d.write('<div id="comments_thread"><\/div>');
 165         var s = d.createElement('script');
 166         s.type = 'text/javascript';
 167         s.async = true;
 168         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 169         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 170     }
 171     else {
 172         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 173     }
 174 })(window, document);
 175 //--><!]]></script></div><div id="footer">
 176 <p class="apache">Copyright 2016 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>
 177 <p class="menu"><a href="./mod/">Modules</a> | <a href="./mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="./glossary.html">Glossary</a> | <a href="./sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
 178 if (typeof(prettyPrint) !== 'undefined') {
 179     prettyPrint();
 180 }
 181 //--><!]]></script>
 182 </body></html>