Commit f0393ad0 authored by Jim Jagielski's avatar Jim Jagielski
Browse files

Add in the UseCanonicalPhysicalPort directive, which 

basically allows Apache to configurably ( :) )
use the physical port when constructing the
canonical port. Also add the exact ordering to
the docs, so people can easily see how it works.
We now have compatibility with both 2.0 and 1.3.


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@344369 13f79535-47bb-0310-9956-ffa450edef68
parent b6ce6eb4

CHANGES

+4 −0
Original line number Diff line number Diff line
@@ -2,6 +2,10 @@ 
Changes with Apache 2.3.0

  [Remove entries to the current 2.0 and 2.2 section below, when backported]













  *) Add in new UseCanonicalPhysicalPort directive, which controls













     whether or not Apache will ever use the actual physical port













     when constructing the canonical port number. [Jim Jagielski]



























  *) Asynchronous write completion for the Event MPM.  [Brian Pane]





























  *) Added an End-Of-Request bucket type.  The logging of a request and

































docs/manual/mod/core.html.en



+56
−2






























Original line number
Diff line number
Diff line








@@ -93,6 +93,7 @@ available</td></tr>













<li><img alt="" src="../images/down.gif" /> <a href="#timeout">TimeOut</a></li>















<li><img alt="" src="../images/down.gif" /> <a href="#traceenable">TraceEnable</a></li>















<li><img alt="" src="../images/down.gif" /> <a href="#usecanonicalname">UseCanonicalName</a></li>













<li><img alt="" src="../images/down.gif" /> <a href="#usecanonicalphysicalport">UseCanonicalPhysicalPort</a></li>















<li><img alt="" src="../images/down.gif" /> <a href="#virtualhost">&lt;VirtualHost&gt;</a></li>















</ul>















</div>










@@ -2762,7 +2763,8 @@ itself</td></tr>













    <code>Host:</code> header to match this virtual host.</p>































    <p>See the description of the













    <code class="directive"><a href="#usecanonicalname">UseCanonicalName</a></code> directive for













    <code class="directive"><a href="#usecanonicalname">UseCanonicalName</a></code> and













    <code class="directive"><a href="#usecanonicalphysicalport">UseCanonicalPhysicalPort</a></code>directives for















    settings which determine whether self-referential URL's (e.g., by the















    <code class="module"><a href="../mod/mod_dir.html">mod_dir</a></code> module) will refer to the















    specified port, or to the port number given in the client's request.









@@ -2775,6 +2777,7 @@ itself</td></tr>













<li><a href="../vhosts/">Apache virtual host















    documentation</a></li>















<li><code class="directive"><a href="#usecanonicalname">UseCanonicalName</a></code></li>













<li><code class="directive"><a href="#usecanonicalphysicalport">UseCanonicalPhysicalPort</a></code></li>















<li><code class="directive"><a href="#namevirtualhost">NameVirtualHost</a></code></li>















<li><code class="directive"><a href="#serveralias">ServerAlias</a></code></li>















</ul>










@@ -3106,7 +3109,7 @@ requests</td></tr>













<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures how the server determines its own name and















port</td></tr>















<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>UseCanonicalName On|Off|DNS</code></td></tr>













<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>UseCanonicalName Off</code></td></tr>













<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>UseCanonicalName On</code></td></tr>















<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>















<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>















<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>










@@ -3159,6 +3162,57 @@ port</td></tr>





























<h3>See also</h3>















<ul>













<li><code class="directive"><a href="#usecanonicalphysicalport">UseCanonicalPhysicalPort</a></code></li>













<li><code class="directive"><a href="#servername">ServerName</a></code></li>













<li><code class="directive"><a href="../mod/mpm_common.html#listen">Listen</a></code></li>













</ul>













</div>













<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>













<div class="directive-section"><h2><a name="UseCanonicalPhysicalPort" id="UseCanonicalPhysicalPort">UseCanonicalPhysicalPort</a> <a name="usecanonicalphysicalport" id="usecanonicalphysicalport">Directive</a></h2>













<table class="directive">













<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures how the server determines its own name and













port</td></tr>













<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>UseCanonicalPhysicalPort On|Off</code></td></tr>













<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>UseCanonicalPhysicalPort Off</code></td></tr>













<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>













<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Core</td></tr>













<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>core</td></tr>













</table>













    <p>In many situations Apache must construct a <em>self-referential</em>













    URL -- that is, a URL that refers back to the same server. With













    <code>UseCanonicalPhysicalPort On</code> Apache will, when













    constructing the canonical port for the server to honor













    the <code class="directive"><a href="#usecanonicalname">UseCanonicalName</a></code> directive,













    provide the actual physical port number being used by this request













    as a potential port. With <code>UseCanonicalPhysicalPort Off</code>













    Apache will not ever use the actual physical port number, instead













    relying on all configured information to construct a valid port number.</p>



























    <div class="note"><h3>Note</h3>













    <p>The ordering of when the physical port is used is as follows:<br /><br />













     <code>UseCanonicalName On</code>













     <ul>













      <li>Port provided in <code>Servername</code></li>













      <li>Physical port</li>













      <li>Default port</li>













     </ul>













     <code>UseCanonicalName Off | DNS</code>













     <ul>













      <li>Parsed port from <code>Host:</code> header</li>













      <li>Physical port</li>













      <li>Port provided in <code>Servername</code></li>













      <li>Default port</li>













     </ul>













    </p>













    













    <p>With <code>UseCanonicalPhysicalPort Off</code>, the













    physical ports are removed from the ordering.</p>













    </div>









































<h3>See also</h3>













<ul>













<li><code class="directive"><a href="#usecanonicalname">UseCanonicalName</a></code></li>















<li><code class="directive"><a href="#servername">ServerName</a></code></li>















<li><code class="directive"><a href="../mod/mpm_common.html#listen">Listen</a></code></li>















</ul>

































docs/manual/mod/core.xml



+52
−2






























Original line number
Diff line number
Diff line








@@ -2748,7 +2748,8 @@ itself</description>













    <code>Host:</code> header to match this virtual host.</p>































    <p>See the description of the













    <directive module="core">UseCanonicalName</directive> directive for













    <directive module="core">UseCanonicalName</directive> and













    <directive module="core">UseCanonicalPhysicalPort</directive>directives for















    settings which determine whether self-referential URL's (e.g., by the















    <module>mod_dir</module> module) will refer to the















    specified port, or to the port number given in the client's request.









@@ -2760,6 +2761,7 @@ itself</description>













<seealso><a href="../vhosts/">Apache virtual host















    documentation</a></seealso>















<seealso><directive module="core">UseCanonicalName</directive></seealso>













<seealso><directive module="core">UseCanonicalPhysicalPort</directive></seealso>















<seealso><directive module="core">NameVirtualHost</directive></seealso>















<seealso><directive module="core">ServerAlias</directive></seealso>















</directivesynopsis>










@@ -3077,7 +3079,7 @@ requests</description>













<description>Configures how the server determines its own name and















port</description>















<syntax>UseCanonicalName On|Off|DNS</syntax>













<default>UseCanonicalName Off</default>













<default>UseCanonicalName On</default>















<contextlist><context>server config</context><context>virtual host</context>















<context>directory</context></contextlist>


























@@ -3130,6 +3132,54 @@ port</description>













    then it should be just fine.</p>















    </note>















</usage>













<seealso><directive module="core">UseCanonicalPhysicalPort</directive></seealso>













<seealso><directive module="core">ServerName</directive></seealso>













<seealso><directive module="mpm_common">Listen</directive></seealso>













</directivesynopsis>



























<directivesynopsis>













<name>UseCanonicalPhysicalPort</name>













<description>Configures how the server determines its own name and













port</description>













<syntax>UseCanonicalPhysicalPort On|Off</syntax>













<default>UseCanonicalPhysicalPort Off</default>













<contextlist><context>server config</context><context>virtual host</context>













<context>directory</context></contextlist>



























<usage>













    <p>In many situations Apache must construct a <em>self-referential</em>













    URL -- that is, a URL that refers back to the same server. With













    <code>UseCanonicalPhysicalPort On</code> Apache will, when













    constructing the canonical port for the server to honor













    the <directive module="core">UseCanonicalName</directive> directive,













    provide the actual physical port number being used by this request













    as a potential port. With <code>UseCanonicalPhysicalPort Off</code>













    Apache will not ever use the actual physical port number, instead













    relying on all configured information to construct a valid port number.</p>



























    <note><title>Note</title>













    <p>The ordering of when the physical port is used is as follows:<br /><br />













     <code>UseCanonicalName On</code>













     <ul>













      <li>Port provided in <code>Servername</code></li>













      <li>Physical port</li>













      <li>Default port</li>













     </ul>













     <code>UseCanonicalName Off | DNS</code>













     <ul>













      <li>Parsed port from <code>Host:</code> header</li>













      <li>Physical port</li>













      <li>Port provided in <code>Servername</code></li>













      <li>Default port</li>













     </ul>













    </p>













    













    <p>With <code>UseCanonicalPhysicalPort Off</code>, the













    physical ports are removed from the ordering.</p>













    </note>



























</usage>













<seealso><directive module="core">UseCanonicalName</directive></seealso>















<seealso><directive module="core">ServerName</directive></seealso>















<seealso><directive module="mpm_common">Listen</directive></seealso>















</directivesynopsis>

































docs/manual/mod/directives.html.en



+1
−0






























Original line number
Diff line number
Diff line








@@ -413,6 +413,7 @@













<li><a href="mod_mime.html#typesconfig">TypesConfig</a></li>















<li><a href="mod_env.html#unsetenv" id="U" name="U">UnsetEnv</a></li>















<li><a href="core.html#usecanonicalname">UseCanonicalName</a></li>













<li><a href="core.html#usecanonicalphysicalport">UseCanonicalPhysicalPort</a></li>















<li><a href="mpm_common.html#user">User</a></li>















<li><a href="mod_userdir.html#userdir">UserDir</a></li>















<li><a href="mod_vhost_alias.html#virtualdocumentroot" id="V" name="V">VirtualDocumentRoot</a></li>

































docs/manual/mod/quickreference.html.en



+13
−11






























Original line number
Diff line number
Diff line








@@ -722,25 +722,27 @@ requests</td></tr>













<tr class="odd"><td><a href="mod_mime.html#typesconfig">TypesConfig <var>file-path</var></a></td><td> conf/mime.types </td><td>s</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">The location of the <code>mime.types</code> file</td></tr>















<tr><td><a href="mod_env.html#unsetenv" id="U" name="U">UnsetEnv <var>env-variable</var> [<var>env-variable</var>]















...</a></td><td></td><td>svdh</td><td>B</td></tr><tr><td class="descr" colspan="4">Removes variables from the environment</td></tr>













<tr class="odd"><td><a href="core.html#usecanonicalname">UseCanonicalName On|Off|DNS</a></td><td> Off </td><td>svd</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Configures how the server determines its own name and













<tr class="odd"><td><a href="core.html#usecanonicalname">UseCanonicalName On|Off|DNS</a></td><td> On </td><td>svd</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Configures how the server determines its own name and















port</td></tr>













<tr><td><a href="mpm_common.html#user">User <var>unix-userid</var></a></td><td> #-1 </td><td>s</td><td>M</td></tr><tr><td class="descr" colspan="4">The userid under which the server will answer













<tr><td><a href="core.html#usecanonicalphysicalport">UseCanonicalPhysicalPort On|Off</a></td><td> Off </td><td>svd</td><td>C</td></tr><tr><td class="descr" colspan="4">Configures how the server determines its own name and













port</td></tr>













<tr class="odd"><td><a href="mpm_common.html#user">User <var>unix-userid</var></a></td><td> #-1 </td><td>s</td><td>M</td></tr><tr class="odd"><td class="descr" colspan="4">The userid under which the server will answer















requests</td></tr>













<tr class="odd"><td><a href="mod_userdir.html#userdir">UserDir <em>directory-filename</em></a></td><td></td><td>sv</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Location of the user-specific directories</td></tr>













<tr><td><a href="mod_vhost_alias.html#virtualdocumentroot" id="V" name="V">VirtualDocumentRoot <em>interpolated-directory</em>|none</a></td><td> none </td><td>sv</td><td>E</td></tr><tr><td class="descr" colspan="4">Dynamically configure the location of the document root













<tr><td><a href="mod_userdir.html#userdir">UserDir <em>directory-filename</em></a></td><td></td><td>sv</td><td>B</td></tr><tr><td class="descr" colspan="4">Location of the user-specific directories</td></tr>













<tr class="odd"><td><a href="mod_vhost_alias.html#virtualdocumentroot" id="V" name="V">VirtualDocumentRoot <em>interpolated-directory</em>|none</a></td><td> none </td><td>sv</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Dynamically configure the location of the document root















for a given virtual host</td></tr>













<tr class="odd"><td><a href="mod_vhost_alias.html#virtualdocumentrootip">VirtualDocumentRootIP <em>interpolated-directory</em>|none</a></td><td> none </td><td>sv</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Dynamically configure the location of the document root













<tr><td><a href="mod_vhost_alias.html#virtualdocumentrootip">VirtualDocumentRootIP <em>interpolated-directory</em>|none</a></td><td> none </td><td>sv</td><td>E</td></tr><tr><td class="descr" colspan="4">Dynamically configure the location of the document root















for a given virtual host</td></tr>













<tr><td><a href="core.html#virtualhost">&lt;VirtualHost













<tr class="odd"><td><a href="core.html#virtualhost">&lt;VirtualHost















    <var>addr</var>[:<var>port</var>] [<var>addr</var>[:<var>port</var>]]













    ...&gt; ... &lt;/VirtualHost&gt;</a></td><td></td><td>s</td><td>C</td></tr><tr><td class="descr" colspan="4">Contains directives that apply only to a specific













    ...&gt; ... &lt;/VirtualHost&gt;</a></td><td></td><td>s</td><td>C</td></tr><tr class="odd"><td class="descr" colspan="4">Contains directives that apply only to a specific















hostname or IP address</td></tr>













<tr class="odd"><td><a href="mod_vhost_alias.html#virtualscriptalias">VirtualScriptAlias <em>interpolated-directory</em>|none</a></td><td> none </td><td>sv</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Dynamically configure the location of the CGI directory for













<tr><td><a href="mod_vhost_alias.html#virtualscriptalias">VirtualScriptAlias <em>interpolated-directory</em>|none</a></td><td> none </td><td>sv</td><td>E</td></tr><tr><td class="descr" colspan="4">Dynamically configure the location of the CGI directory for















a given virtual host</td></tr>













<tr><td><a href="mod_vhost_alias.html#virtualscriptaliasip">VirtualScriptAliasIP <em>interpolated-directory</em>|none</a></td><td> none </td><td>sv</td><td>E</td></tr><tr><td class="descr" colspan="4">Dynamically configure the location of the cgi directory for













<tr class="odd"><td><a href="mod_vhost_alias.html#virtualscriptaliasip">VirtualScriptAliasIP <em>interpolated-directory</em>|none</a></td><td> none </td><td>sv</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Dynamically configure the location of the cgi directory for















a given virtual host</td></tr>













<tr class="odd"><td><a href="mpm_winnt.html#win32disableacceptex" id="W" name="W">Win32DisableAcceptEx</a></td><td></td><td>s</td><td>M</td></tr><tr class="odd"><td class="descr" colspan="4">Use accept() rather than AcceptEx() to accept network connections</td></tr>













<tr><td><a href="mod_include.html#xbithack" id="X" name="X">XBitHack on|off|full</a></td><td> off </td><td>svdh</td><td>B</td></tr><tr><td class="descr" colspan="4">Parse SSI directives in files with the execute bit













<tr><td><a href="mpm_winnt.html#win32disableacceptex" id="W" name="W">Win32DisableAcceptEx</a></td><td></td><td>s</td><td>M</td></tr><tr><td class="descr" colspan="4">Use accept() rather than AcceptEx() to accept network connections</td></tr>













<tr class="odd"><td><a href="mod_include.html#xbithack" id="X" name="X">XBitHack on|off|full</a></td><td> off </td><td>svdh</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Parse SSI directives in files with the execute bit















set</td></tr>















</table></div>















<div class="bottomlang">