granicus.if.org Git - apache/blob - docs/manual/mod/mod_actions.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>mod_actions - 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>
  17 <div id="page-header">
  18 <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>
  19 <p class="apache">Apache HTTP Server Version 2.4</p>
  20 <img alt="" src="../images/feather.gif" /></div>
  21 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  22 <div id="path">
  23 <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.4</a> &gt; <a href="./">Modules</a></div>
  24 <div id="page-content">
  25 <div id="preamble"><h1>Apache Module mod_actions</h1>
  26 <div class="toplang">
  27 <p><span>Available Languages: </span><a href="../de/mod/mod_actions.html" hreflang="de" rel="alternate" title="Deutsch">&nbsp;de&nbsp;</a> |
  28 <a href="../en/mod/mod_actions.html" title="English">&nbsp;en&nbsp;</a> |
  29 <a href="../fr/mod/mod_actions.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
  30 <a href="../ja/mod/mod_actions.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
  31 <a href="../ko/mod/mod_actions.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
  32 </div>
  33 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>This module provides for executing CGI scripts based on
  34 media type or request method.</td></tr>
  35 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
  36 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>actions_module</td></tr>
  37 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_actions.c</td></tr></table>
  38 <h3>Summary</h3>
  39
  40     <p>This module has two directives. The <code class="directive"><a href="#action">Action</a></code> directive lets you run CGI
  41     scripts whenever a file of a certain <a class="glossarylink" href="../glossary.html#mime-type" title="see glossary">MIME content type</a> is requested. The
  42     <code class="directive"><a href="#script">Script</a></code> directive lets
  43     you run CGI scripts whenever a particular method is used in a
  44     request. This makes it much easier to execute scripts that process
  45     files.</p> </div>
  46 <div id="quickview"><h3 class="directives">Directives</h3>
  47 <ul id="toc">
  48 <li><img alt="" src="../images/down.gif" /> <a href="#action">Action</a></li>
  49 <li><img alt="" src="../images/down.gif" /> <a href="#script">Script</a></li>
  50 </ul>
  51 <h3>See also</h3>
  52 <ul class="seealso">
  53 <li><code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code></li>
  54 <li><a href="../howto/cgi.html">Dynamic Content with CGI</a></li>
  55 <li><a href="../handler.html">Apache httpd's Handler Use</a></li>
  56 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
  57
  58 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  59 <div class="directive-section"><h2><a name="Action" id="Action">Action</a> <a name="action" id="action">Directive</a></h2>
  60 <table class="directive">
  61 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Activates a CGI script for a particular handler or
  62 content-type</td></tr>
  63 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Action <var>action-type</var> <var>cgi-script</var> [virtual]</code></td></tr>
  64 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
  65 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
  66 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
  67 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_actions</td></tr>
  68 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>The <code>virtual</code> modifier and handler passing were
  69 introduced in Apache 2.1</td></tr>
  70 </table>
  71     <p>This directive adds an action, which will activate
  72     <var>cgi-script</var> when <var>action-type</var> is triggered by
  73     the request.  The <var>cgi-script</var> is the URL-path to a
  74     resource that has been designated as a CGI script using <code class="directive"><a href="../mod/mod_alias.html#scriptalias">ScriptAlias</a></code> or <code class="directive"><a href="../mod/mod_mime.html#addhandler">AddHandler</a></code>.  The
  75     <var>action-type</var> can be either a <a href="../handler.html">handler</a> or a <a class="glossarylink" href="../glossary.html#mime-type" title="see glossary">MIME content type</a>. It sends the URL and
  76     file path of the requested document using the standard CGI
  77     <code>PATH_INFO</code> and <code>PATH_TRANSLATED</code>
  78     environment variables. The handler used for the particular request
  79     is passed using the <code>REDIRECT_HANDLER</code> variable.</p>
  80
  81     <div class="example"><h3>Example: MIME type</h3><pre class="prettyprint lang-config">
  82 # Requests for files of a particular MIME content type:
  83 Action image/gif /cgi-bin/images.cgi
  84     </pre>
  85 </div>
  86
  87     <p>In this example, requests for files with a MIME content
  88     type of <code>image/gif</code> will be handled by the
  89     specified cgi script <code>/cgi-bin/images.cgi</code>.</p>
  90
  91     <div class="example"><h3>Example: File extension</h3><pre class="prettyprint lang-config">
  92 # Files of a particular file extension
  93 AddHandler my-file-type .xyz
  94 Action my-file-type /cgi-bin/program.cgi
  95     </pre>
  96 </div>
  97     <p>In this example, requests for files with a file extension of
  98     <code>.xyz</code> are handled by the specified cgi script
  99     <code>/cgi-bin/program.cgi</code>.</p>
 100
 101     <p>The optional <code>virtual</code> modifier turns off the check
 102     whether the requested file really exists. This is useful, for example,
 103     if you want to use the <code class="directive">Action</code> directive in
 104     virtual locations.</p>
 105
 106     <pre class="prettyprint lang-config">
 107 &lt;Location /news&gt;
 108     SetHandler news-handler
 109     Action news-handler /cgi-bin/news.cgi virtual
 110 &lt;/Location&gt;
 111     </pre>
 112
 113
 114 <h3>See also</h3>
 115 <ul>
 116 <li><code class="directive"><a href="../mod/mod_mime.html#addhandler">AddHandler</a></code></li>
 117 </ul>
 118 </div>
 119 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 120 <div class="directive-section"><h2><a name="Script" id="Script">Script</a> <a name="script" id="script">Directive</a></h2>
 121 <table class="directive">
 122 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Activates a CGI script for a particular request
 123 method.</td></tr>
 124 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Script <var>method</var> <var>cgi-script</var></code></td></tr>
 125 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
 126 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 127 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_actions</td></tr>
 128 </table>
 129     <p>This directive adds an action, which will activate
 130     <var>cgi-script</var> when a file is requested using the method of
 131     <var>method</var>. The <var>cgi-script</var> is the URL-path to a
 132     resource that has been designated as a CGI script using <code class="directive"><a href="../mod/mod_alias.html#scriptalias">ScriptAlias</a></code> or <code class="directive"><a href="../mod/mod_mime.html#addhandler">AddHandler</a></code>.  The URL and
 133     file path of the requested document is sent using the standard CGI
 134     <code>PATH_INFO</code> and <code>PATH_TRANSLATED</code> environment
 135     variables.</p>
 136
 137     <div class="note">
 138       Any arbitrary method name may be used. <strong>Method names are
 139       case-sensitive</strong>, so <code>Script PUT</code> and
 140       <code>Script put</code> have two entirely different
 141       effects.
 142     </div>
 143
 144     <p>Note that the <code class="directive">Script</code> command defines default
 145     actions only. If a CGI script is called, or some other resource that is
 146     capable of handling the requested method internally, it will do
 147     so. Also note that <code class="directive">Script</code> with a method of
 148     <code>GET</code> will only be called if there are query arguments present
 149     (<em>e.g.</em>, foo.html?hi). Otherwise, the request will
 150     proceed normally.</p>
 151
 152     <pre class="prettyprint lang-config">
 153 # All GET requests go here
 154 Script GET /cgi-bin/search
 155
 156 # A CGI PUT handler
 157 Script PUT /~bob/put.cgi
 158     </pre>
 159
 160
 161 </div>
 162 </div>
 163 <div class="bottomlang">
 164 <p><span>Available Languages: </span><a href="../de/mod/mod_actions.html" hreflang="de" rel="alternate" title="Deutsch">&nbsp;de&nbsp;</a> |
 165 <a href="../en/mod/mod_actions.html" title="English">&nbsp;en&nbsp;</a> |
 166 <a href="../fr/mod/mod_actions.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
 167 <a href="../ja/mod/mod_actions.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 168 <a href="../ko/mod/mod_actions.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 169 </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>
 170 <script type="text/javascript"><!--//--><![CDATA[//><!--
 171 var comments_shortname = 'httpd';
 172 var comments_identifier = 'http://httpd.apache.org/docs/2.4/mod/mod_actions.html';
 173 (function(w, d) {
 174     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 175         d.write('<div id="comments_thread"><\/div>');
 176         var s = d.createElement('script');
 177         s.type = 'text/javascript';
 178         s.async = true;
 179         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 180         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 181     }
 182     else {
 183         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 184     }
 185 })(window, document);
 186 //--><!]]></script></div><div id="footer">
 187 <p class="apache">Copyright 2012 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>
 188 <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[//><!--
 189 if (typeof(prettyPrint) !== 'undefined') {
 190     prettyPrint();
 191 }
 192 //--><!]]></script>
 193 </body></html>