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" /><link rel="stylesheet" type="text/css" href="/style/css/prettify.css" /> 12<script src="/style/scripts/prettify.js" type="text/javascript"> 13</script> 14 15<link href="/images/favicon.ico" rel="shortcut icon" /></head> 16<body id="manual-page"><div id="page-header"> 17<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.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> 18<p class="apache">Apache HTTP Server Version 2.2</p> 19<img alt="" src="/images/feather.gif" /></div> 20<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div> 21<div id="path"> 22<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="./">Version 2.2</a></div><div id="page-content"><div id="preamble"><h1>Apache's Handler Use</h1> 23<div class="toplang"> 24<p><span>Available Languages: </span><a href="/en/handler.html" title="English"> en </a> | 25<a href="/es/handler.html" hreflang="es" rel="alternate" title="Espa�ol"> es </a> | 26<a href="/fr/handler.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a> | 27<a href="/ja/handler.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> | 28<a href="/ko/handler.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> | 29<a href="/ru/handler.html" hreflang="ru" rel="alternate" title="Russian"> ru </a> | 30<a href="/tr/handler.html" hreflang="tr" rel="alternate" title="T�rk�e"> tr </a> | 31<a href="/zh-cn/handler.html" hreflang="zh-cn" rel="alternate" title="Simplified Chinese"> zh-cn </a></p> 32</div> 33 34 <p>This document describes the use of Apache's Handlers.</p> 35 </div> 36<div id="quickview"><ul id="toc"><li><img alt="" src="/images/down.gif" /> <a href="#definition">What is a Handler</a></li> 37<li><img alt="" src="/images/down.gif" /> <a href="#examples">Examples</a></li> 38<li><img alt="" src="/images/down.gif" /> <a href="#programmer">Programmer's Note</a></li> 39</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> 40<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 41<div class="section"> 42<h2><a name="definition" id="definition">What is a Handler</a></h2> 43 44 <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> 45 46 47 <p>A "handler" is an internal Apache representation of the 48 action to be performed when a file is called. Generally, files 49 have implicit handlers, based on the file type. Normally, all 50 files are simply served by the server, but certain file types 51 are "handled" separately.</p> 52 53 <p>Handlers may also be configured explicitly, 54 based on either filename extensions or on location, 55 without relation to file type. This is 56 advantageous both because it is a more elegant solution, and 57 because it also allows for both a type <strong>and</strong> a 58 handler to be associated with a file. (See also <a href="mod/mod_mime.html#multipleext">Files with Multiple 59 Extensions</a>.)</p> 60 61 <p>Handlers can either be built into the server or included in 62 a module, or they can be added with the <code class="directive"><a href="/mod/mod_actions.html#action">Action</a></code> directive. The 63 built-in handlers in the standard distribution are as 64 follows:</p> 65 66 <ul> 67 <li><strong>default-handler</strong>: Send the file using the 68 <code>default_handler()</code>, which is the handler used by 69 default to handle static content. (core)</li> 70 71 <li><strong>send-as-is</strong>: Send file with HTTP headers 72 as is. (<code class="module"><a href="/mod/mod_asis.html">mod_asis</a></code>)</li> 73 74 <li><strong>cgi-script</strong>: Treat the file as a CGI 75 script. (<code class="module"><a href="/mod/mod_cgi.html">mod_cgi</a></code>)</li> 76 77 <li><strong>imap-file</strong>: Parse as an imagemap rule 78 file. (<code class="module"><a href="/mod/mod_imagemap.html">mod_imagemap</a></code>)</li> 79 80 <li><strong>server-info</strong>: Get the server's 81 configuration information. (<code class="module"><a href="/mod/mod_info.html">mod_info</a></code>)</li> 82 83 <li><strong>server-status</strong>: Get the server's status 84 report. (<code class="module"><a href="/mod/mod_status.html">mod_status</a></code>)</li> 85 86 <li><strong>type-map</strong>: Parse as a type map file for 87 content negotiation. (<code class="module"><a href="/mod/mod_negotiation.html">mod_negotiation</a></code>)</li> 88 </ul> 89 </div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 90<div class="section"> 91<h2><a name="examples" id="examples">Examples</a></h2> 92 93 94 <h3><a name="example1" id="example1">Modifying static content using a CGI script</a></h3> 95 96 97 <p>The following directives will cause requests for files with 98 the <code>html</code> extension to trigger the launch of the 99 <code>footer.pl</code> CGI script.</p> 100 101 <div class="example"><p><code> 102 Action add-footer /cgi-bin/footer.pl<br /> 103 AddHandler add-footer .html 104 </code></p></div> 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 <div class="example"><p><code> 123 <Directory /web/htdocs/asis><br /> 124 SetHandler send-as-is<br /> 125 </Directory> 126 </code></p></div> 127 128 129 </div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 130<div class="section"> 131<h2><a name="programmer" id="programmer">Programmer's Note</a></h2> 132 133 134 <p>In order to implement the handler features, an addition has 135 been made to the <a href="developer/API.html">Apache API</a> that 136 you may wish to make use of. Specifically, a new record has 137 been added to the <code>request_rec</code> structure:</p> 138 139 <div class="example"><p><code> 140 char *handler 141 </code></p></div> 142 143 <p>If you wish to have your module engage a handler, you need 144 only to set <code>r->handler</code> to the name of the 145 handler at any time prior to the <code>invoke_handler</code> 146 stage of the request. Handlers are implemented as they were 147 before, albeit using the handler name instead of a content 148 type. While it is not necessary, the naming convention for 149 handlers is to use a dash-separated word, with no slashes, so 150 as to not invade the media type name-space.</p> 151 </div></div> 152<div class="bottomlang"> 153<p><span>Available Languages: </span><a href="/en/handler.html" title="English"> en </a> | 154<a href="/es/handler.html" hreflang="es" rel="alternate" title="Espa�ol"> es </a> | 155<a href="/fr/handler.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a> | 156<a href="/ja/handler.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> | 157<a href="/ko/handler.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> | 158<a href="/ru/handler.html" hreflang="ru" rel="alternate" title="Russian"> ru </a> | 159<a href="/tr/handler.html" hreflang="tr" rel="alternate" title="T�rk�e"> tr </a> | 160<a href="/zh-cn/handler.html" hreflang="zh-cn" rel="alternate" title="Simplified Chinese"> zh-cn </a></p> 161</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&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> 162<script type="text/javascript"><!--//--><![CDATA[//><!-- 163var comments_shortname = 'httpd'; 164var comments_identifier = 'http://httpd.apache.org/docs/2.2/handler.html'; 165(function(w, d) { 166 if (w.location.hostname.toLowerCase() == "httpd.apache.org") { 167 d.write('<div id="comments_thread"><\/div>'); 168 var s = d.createElement('script'); 169 s.type = 'text/javascript'; 170 s.async = true; 171 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; 172 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); 173 } 174 else { 175 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>'); 176 } 177})(window, document); 178//--><!]]></script></div><div id="footer"> 179<p class="apache">Copyright 2013 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> 180<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.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[//><!-- 181if (typeof(prettyPrint) !== 'undefined') { 182 prettyPrint(); 183} 184//--><!]]></script> 185</body></html>
