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