home *** CD-ROM | disk | FTP | other *** search
/ PC World 2004 May / PCWorld_2004-05_cd.bin / komunikace / apache / apache_2.0.48-win32-x86-no_ssl.msi / Data.Cab / F252396_rewriteguide.html.en < prev    next >
Extensible Markup Language  |  2003-07-10  |  74KB  |  2,099 lines
  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>URL Rewriting Guide - 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" />
  12. <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13. <body id="manual-page"><div id="page-header">
  14. <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  15. <p class="apache">Apache HTTP Server Version 2.0</p>
  16. <img alt="" src="../images/feather.gif" /></div>
  17. <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
  18. <div id="path">
  19. <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs-project/">Documentation</a> > <a href="../">Version 2.0</a> > <a href="./">Miscellaneous Documentation</a></div><div id="page-content"><div id="preamble"><h1>URL Rewriting Guide</h1>
  20. <div class="toplang">
  21. <p><span>Available Languages: </span><a href="../en/misc/rewriteguide.html" title="English"> en </a></p>
  22. </div>
  23.  
  24.     <div class="note">
  25.       <p>Originally written by<br />
  26.       <cite>Ralf S. Engelschall <rse@apache.org></cite><br />
  27.       December 1997</p>
  28.     </div>
  29.  
  30.     <p>This document supplements the <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>
  31.     <a href="../mod/mod_rewrite.html">reference documentation</a>.
  32.     It describes how one can use Apache's <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>
  33.     to solve typical URL-based problems webmasters are usually confronted
  34.     with in practice. I give detailed descriptions on how to
  35.     solve each problem by configuring URL rewriting rulesets.</p>
  36.  
  37.   </div>
  38. <div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#ToC1">Introduction to <code>mod_rewrite</code></a></li>
  39. <li><img alt="" src="../images/down.gif" /> <a href="#ToC2">Practical Solutions</a></li>
  40. <li><img alt="" src="../images/down.gif" /> <a href="#url">URL Layout</a></li>
  41. <li><img alt="" src="../images/down.gif" /> <a href="#content">Content Handling</a></li>
  42. <li><img alt="" src="../images/down.gif" /> <a href="#access">Access Restriction</a></li>
  43. <li><img alt="" src="../images/down.gif" /> <a href="#other">Other</a></li>
  44. </ul></div>
  45. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  46. <div class="section">
  47. <h2><a name="ToC1" id="ToC1">Introduction to <code>mod_rewrite</code></a></h2>
  48.  
  49.     
  50.  
  51.     <p>The Apache module <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> is a killer
  52.     one, i.e. it is a really sophisticated module which provides
  53.     a powerful way to do URL manipulations. With it you can nearly
  54.     do all types of URL manipulations you ever dreamed about.
  55.     The price you have to pay is to accept complexity, because
  56.     <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>'s major drawback is that it is
  57.     not easy to understand and use for the beginner. And even
  58.     Apache experts sometimes discover new aspects where
  59.     <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> can help.</p>
  60.  
  61.     <p>In other words: With <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> you either
  62.     shoot yourself in the foot the first time and never use it again
  63.     or love it for the rest of your life because of its power.
  64.     This paper tries to give you a few initial success events to
  65.     avoid the first case by presenting already invented solutions
  66.     to you.</p>
  67.  
  68.   </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  69. <div class="section">
  70. <h2><a name="ToC2" id="ToC2">Practical Solutions</a></h2>
  71.  
  72.     
  73.  
  74.     <p>Here come a lot of practical solutions I've either invented
  75.     myself or collected from other peoples solutions in the past.
  76.     Feel free to learn the black magic of URL rewriting from
  77.     these examples.</p>
  78.  
  79.     <div class="warning">ATTENTION: Depending on your server-configuration
  80.     it can be necessary to slightly change the examples for your
  81.     situation, e.g. adding the <code>[PT]</code> flag when
  82.     additionally using <code class="module"><a href="../mod/mod_alias.html">mod_alias</a></code> and
  83.     <code class="module"><a href="../mod/mod_userdir.html">mod_userdir</a></code>, etc. Or rewriting a ruleset
  84.     to fit in <code>.htaccess</code> context instead
  85.     of per-server context. Always try to understand what a
  86.     particular ruleset really does before you use it. It
  87.     avoid problems.</div>
  88.  
  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="url" id="url">URL Layout</a></h2>
  92.  
  93.     
  94.  
  95.     <h3>Canonical URLs</h3>
  96.  
  97.       
  98.  
  99.       <dl>
  100.         <dt>Description:</dt>
  101.  
  102.         <dd>
  103.           <p>On some webservers there are more than one URL for a
  104.           resource. Usually there are canonical URLs (which should be
  105.           actually used and distributed) and those which are just
  106.           shortcuts, internal ones, etc. Independent of which URL the
  107.           user supplied with the request he should finally see the
  108.           canonical one only.</p>
  109.         </dd>
  110.  
  111.         <dt>Solution:</dt>
  112.  
  113.         <dd>
  114.           <p>We do an external HTTP redirect for all non-canonical
  115.           URLs to fix them in the location view of the Browser and
  116.           for all subsequent requests. In the example ruleset below
  117.           we replace <code>/~user</code> by the canonical
  118.           <code>/u/user</code> and fix a missing trailing slash for
  119.           <code>/u/user</code>.</p>
  120.  
  121. <div class="example"><pre>
  122. RewriteRule   ^/<strong>~</strong>([^/]+)/?(.*)    /<strong>u</strong>/$1/$2  [<strong>R</strong>]
  123. RewriteRule   ^/([uge])/(<strong>[^/]+</strong>)$  /$1/$2<strong>/</strong>   [<strong>R</strong>]
  124. </pre></div>
  125.         </dd>
  126.       </dl>
  127.  
  128.     
  129.  
  130.     <h3>Canonical Hostnames</h3>
  131.  
  132.       
  133.  
  134.       <dl>
  135.         <dt>Description:</dt>
  136.  
  137.         <dd>...</dd>
  138.  
  139.         <dt>Solution:</dt>
  140.  
  141.         <dd>
  142. <div class="example"><pre>
  143. RewriteCond %{HTTP_HOST}   !^fully\.qualified\.domain\.name [NC]
  144. RewriteCond %{HTTP_HOST}   !^$
  145. RewriteCond %{SERVER_PORT} !^80$
  146. RewriteRule ^/(.*)         http://fully.qualified.domain.name:%{SERVER_PORT}/$1 [L,R]
  147. RewriteCond %{HTTP_HOST}   !^fully\.qualified\.domain\.name [NC]
  148. RewriteCond %{HTTP_HOST}   !^$
  149. RewriteRule ^/(.*)         http://fully.qualified.domain.name/$1 [L,R]
  150. </pre></div>
  151.         </dd>
  152.       </dl>
  153.  
  154.     
  155.  
  156.     <h3>Moved <code>DocumentRoot</code></h3>
  157.  
  158.       
  159.  
  160.       <dl>
  161.         <dt>Description:</dt>
  162.  
  163.         <dd>
  164.           <p>Usually the <code class="directive"><a href="../mod/core.html#documentroot">DocumentRoot</a></code>
  165.           of the webserver directly relates to the URL "<code>/</code>".
  166.           But often this data is not really of top-level priority, it is
  167.           perhaps just one entity of a lot of data pools. For instance at
  168.           our Intranet sites there are <code>/e/www/</code>
  169.           (the homepage for WWW), <code>/e/sww/</code> (the homepage for
  170.           the Intranet) etc. Now because the data of the <code class="directive"><a href="../mod/core.html#documentroot">DocumentRoot</a></code> stays at <code>/e/www/</code> we had
  171.           to make sure that all inlined images and other stuff inside this
  172.           data pool work for subsequent requests.</p>
  173.         </dd>
  174.  
  175.         <dt>Solution:</dt>
  176.  
  177.         <dd>
  178.           <p>We just redirect the URL <code>/</code> to
  179.           <code>/e/www/</code>. While is seems trivial it is
  180.           actually trivial with <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>, only.
  181.           Because the typical old mechanisms of URL <em>Aliases</em>
  182.           (as provides by <code class="module"><a href="../mod/mod_alias.html">mod_alias</a></code> and friends)
  183.           only used <em>prefix</em> matching. With this you cannot
  184.           do such a redirection because the <code class="directive"><a href="../mod/core.html#documentroot">DocumentRoot</a></code> is a prefix of all URLs. With
  185.           <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> it is really trivial:</p>
  186.  
  187. <div class="example"><pre>
  188. RewriteEngine on
  189. RewriteRule   <strong>^/$</strong>  /e/www/  [<strong>R</strong>]
  190. </pre></div>
  191.         </dd>
  192.       </dl>
  193.  
  194.     
  195.  
  196.     <h3>Trailing Slash Problem</h3>
  197.  
  198.       
  199.  
  200.       <dl>
  201.         <dt>Description:</dt>
  202.  
  203.         <dd>
  204.           <p>Every webmaster can sing a song about the problem of
  205.           the trailing slash on URLs referencing directories. If they
  206.           are missing, the server dumps an error, because if you say
  207.           <code>/~quux/foo</code> instead of <code>/~quux/foo/</code>
  208.           then the server searches for a <em>file</em> named
  209.           <code>foo</code>. And because this file is a directory it
  210.           complains. Actually it tries to fix it itself in most of
  211.           the cases, but sometimes this mechanism need to be emulated
  212.           by you. For instance after you have done a lot of
  213.           complicated URL rewritings to CGI scripts etc.</p>
  214.         </dd>
  215.  
  216.         <dt>Solution:</dt>
  217.  
  218.         <dd>
  219.           <p>The solution to this subtle problem is to let the server
  220.           add the trailing slash automatically. To do this
  221.           correctly we have to use an external redirect, so the
  222.           browser correctly requests subsequent images etc. If we
  223.           only did a internal rewrite, this would only work for the
  224.           directory page, but would go wrong when any images are
  225.           included into this page with relative URLs, because the
  226.           browser would request an in-lined object. For instance, a
  227.           request for <code>image.gif</code> in
  228.           <code>/~quux/foo/index.html</code> would become
  229.           <code>/~quux/image.gif</code> without the external
  230.           redirect!</p>
  231.  
  232.           <p>So, to do this trick we write:</p>
  233.  
  234. <div class="example"><pre>
  235. RewriteEngine  on
  236. RewriteBase    /~quux/
  237. RewriteRule    ^foo<strong>$</strong>  foo<strong>/</strong>  [<strong>R</strong>]
  238. </pre></div>
  239.  
  240.           <p>The crazy and lazy can even do the following in the
  241.           top-level <code>.htaccess</code> file of their homedir.
  242.           But notice that this creates some processing
  243.           overhead.</p>
  244.  
  245. <div class="example"><pre>
  246. RewriteEngine  on
  247. RewriteBase    /~quux/
  248. RewriteCond    %{REQUEST_FILENAME}  <strong>-d</strong>
  249. RewriteRule    ^(.+<strong>[^/]</strong>)$           $1<strong>/</strong>  [R]
  250. </pre></div>
  251.         </dd>
  252.       </dl>
  253.  
  254.     
  255.  
  256.     <h3>Webcluster through Homogeneous URL Layout</h3>
  257.  
  258.       
  259.  
  260.       <dl>
  261.         <dt>Description:</dt>
  262.  
  263.         <dd>
  264.           <p>We want to create a homogeneous and consistent URL
  265.           layout over all WWW servers on a Intranet webcluster, i.e.
  266.           all URLs (per definition server local and thus server
  267.           dependent!) become actually server <em>independent</em>!
  268.           What we want is to give the WWW namespace a consistent
  269.           server-independent layout: no URL should have to include
  270.           any physically correct target server. The cluster itself
  271.           should drive us automatically to the physical target
  272.           host.</p>
  273.         </dd>
  274.  
  275.         <dt>Solution:</dt>
  276.  
  277.         <dd>
  278.           <p>First, the knowledge of the target servers come from
  279.           (distributed) external maps which contain information
  280.           where our users, groups and entities stay. The have the
  281.           form</p>
  282.  
  283. <div class="example"><pre>
  284. user1  server_of_user1
  285. user2  server_of_user2
  286. :      :
  287. </pre></div>
  288.  
  289.           <p>We put them into files <code>map.xxx-to-host</code>.
  290.           Second we need to instruct all servers to redirect URLs
  291.           of the forms</p>
  292.  
  293. <div class="example"><pre>
  294. /u/user/anypath
  295. /g/group/anypath
  296. /e/entity/anypath
  297. </pre></div>
  298.  
  299.           <p>to</p>
  300.  
  301. <div class="example"><pre>
  302. http://physical-host/u/user/anypath
  303. http://physical-host/g/group/anypath
  304. http://physical-host/e/entity/anypath
  305. </pre></div>
  306.  
  307.           <p>when the URL is not locally valid to a server. The
  308.           following ruleset does this for us by the help of the map
  309.           files (assuming that server0 is a default server which
  310.           will be used if a user has no entry in the map):</p>
  311.  
  312. <div class="example"><pre>
  313. RewriteEngine on
  314.  
  315. RewriteMap      user-to-host   txt:/path/to/map.user-to-host
  316. RewriteMap     group-to-host   txt:/path/to/map.group-to-host
  317. RewriteMap    entity-to-host   txt:/path/to/map.entity-to-host
  318.  
  319. RewriteRule   ^/u/<strong>([^/]+)</strong>/?(.*)   http://<strong>${user-to-host:$1|server0}</strong>/u/$1/$2
  320. RewriteRule   ^/g/<strong>([^/]+)</strong>/?(.*)  http://<strong>${group-to-host:$1|server0}</strong>/g/$1/$2
  321. RewriteRule   ^/e/<strong>([^/]+)</strong>/?(.*) http://<strong>${entity-to-host:$1|server0}</strong>/e/$1/$2
  322.  
  323. RewriteRule   ^/([uge])/([^/]+)/?$          /$1/$2/.www/
  324. RewriteRule   ^/([uge])/([^/]+)/([^.]+.+)   /$1/$2/.www/$3\
  325. </pre></div>
  326.         </dd>
  327.       </dl>
  328.  
  329.     
  330.  
  331.     <h3>Move Homedirs to Different Webserver</h3>
  332.  
  333.       
  334.  
  335.       <dl>
  336.         <dt>Description:</dt>
  337.  
  338.         <dd>
  339.           <p>Many webmasters have asked for a solution to the
  340.           following situation: They wanted to redirect just all
  341.           homedirs on a webserver to another webserver. They usually
  342.           need such things when establishing a newer webserver which
  343.           will replace the old one over time.</p>
  344.         </dd>
  345.  
  346.         <dt>Solution:</dt>
  347.  
  348.         <dd>
  349.           <p>The solution is trivial with <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>.
  350.           On the old webserver we just redirect all
  351.           <code>/~user/anypath</code> URLs to
  352.           <code>http://newserver/~user/anypath</code>.</p>
  353.  
  354. <div class="example"><pre>
  355. RewriteEngine on
  356. RewriteRule   ^/~(.+)  http://<strong>newserver</strong>/~$1  [R,L]
  357. </pre></div>
  358.         </dd>
  359.       </dl>
  360.  
  361.     
  362.  
  363.     <h3>Structured Homedirs</h3>
  364.  
  365.       
  366.  
  367.       <dl>
  368.         <dt>Description:</dt>
  369.  
  370.         <dd>
  371.           <p>Some sites with thousands of users usually use a
  372.           structured homedir layout, i.e. each homedir is in a
  373.           subdirectory which begins for instance with the first
  374.           character of the username. So, <code>/~foo/anypath</code>
  375.           is <code>/home/<strong>f</strong>/foo/.www/anypath</code>
  376.           while <code>/~bar/anypath</code> is
  377.           <code>/home/<strong>b</strong>/bar/.www/anypath</code>.</p>
  378.         </dd>
  379.  
  380.         <dt>Solution:</dt>
  381.  
  382.         <dd>
  383.           <p>We use the following ruleset to expand the tilde URLs
  384.           into exactly the above layout.</p>
  385.  
  386. <div class="example"><pre>
  387. RewriteEngine on
  388. RewriteRule   ^/~(<strong>([a-z])</strong>[a-z0-9]+)(.*)  /home/<strong>$2</strong>/$1/.www$3
  389. </pre></div>
  390.         </dd>
  391.       </dl>
  392.  
  393.     
  394.  
  395.     <h3>Filesystem Reorganization</h3>
  396.  
  397.       
  398.  
  399.       <dl>
  400.         <dt>Description:</dt>
  401.  
  402.         <dd>
  403.           <p>This really is a hardcore example: a killer application
  404.           which heavily uses per-directory
  405.           <code>RewriteRules</code> to get a smooth look and feel
  406.           on the Web while its data structure is never touched or
  407.           adjusted. Background: <strong><em>net.sw</em></strong> is
  408.           my archive of freely available Unix software packages,
  409.           which I started to collect in 1992. It is both my hobby
  410.           and job to to this, because while I'm studying computer
  411.           science I have also worked for many years as a system and
  412.           network administrator in my spare time. Every week I need
  413.           some sort of software so I created a deep hierarchy of
  414.           directories where I stored the packages:</p>
  415.  
  416. <div class="example"><pre>
  417. drwxrwxr-x   2 netsw  users    512 Aug  3 18:39 Audio/
  418. drwxrwxr-x   2 netsw  users    512 Jul  9 14:37 Benchmark/
  419. drwxrwxr-x  12 netsw  users    512 Jul  9 00:34 Crypto/
  420. drwxrwxr-x   5 netsw  users    512 Jul  9 00:41 Database/
  421. drwxrwxr-x   4 netsw  users    512 Jul 30 19:25 Dicts/
  422. drwxrwxr-x  10 netsw  users    512 Jul  9 01:54 Graphic/
  423. drwxrwxr-x   5 netsw  users    512 Jul  9 01:58 Hackers/
  424. drwxrwxr-x   8 netsw  users    512 Jul  9 03:19 InfoSys/
  425. drwxrwxr-x   3 netsw  users    512 Jul  9 03:21 Math/
  426. drwxrwxr-x   3 netsw  users    512 Jul  9 03:24 Misc/
  427. drwxrwxr-x   9 netsw  users    512 Aug  1 16:33 Network/
  428. drwxrwxr-x   2 netsw  users    512 Jul  9 05:53 Office/
  429. drwxrwxr-x   7 netsw  users    512 Jul  9 09:24 SoftEng/
  430. drwxrwxr-x   7 netsw  users    512 Jul  9 12:17 System/
  431. drwxrwxr-x  12 netsw  users    512 Aug  3 20:15 Typesetting/
  432. drwxrwxr-x  10 netsw  users    512 Jul  9 14:08 X11/
  433. </pre></div>
  434.  
  435.           <p>In July 1996 I decided to make this archive public to
  436.           the world via a nice Web interface. "Nice" means that I
  437.           wanted to offer an interface where you can browse
  438.           directly through the archive hierarchy. And "nice" means
  439.           that I didn't wanted to change anything inside this
  440.           hierarchy - not even by putting some CGI scripts at the
  441.           top of it. Why? Because the above structure should be
  442.           later accessible via FTP as well, and I didn't want any
  443.           Web or CGI stuff to be there.</p>
  444.         </dd>
  445.  
  446.         <dt>Solution:</dt>
  447.  
  448.         <dd>
  449.           <p>The solution has two parts: The first is a set of CGI
  450.           scripts which create all the pages at all directory
  451.           levels on-the-fly. I put them under
  452.           <code>/e/netsw/.www/</code> as follows:</p>
  453.  
  454. <div class="example"><pre>
  455. -rw-r--r--   1 netsw  users    1318 Aug  1 18:10 .wwwacl
  456. drwxr-xr-x  18 netsw  users     512 Aug  5 15:51 DATA/
  457. -rw-rw-rw-   1 netsw  users  372982 Aug  5 16:35 LOGFILE
  458. -rw-r--r--   1 netsw  users     659 Aug  4 09:27 TODO
  459. -rw-r--r--   1 netsw  users    5697 Aug  1 18:01 netsw-about.html
  460. -rwxr-xr-x   1 netsw  users     579 Aug  2 10:33 netsw-access.pl
  461. -rwxr-xr-x   1 netsw  users    1532 Aug  1 17:35 netsw-changes.cgi
  462. -rwxr-xr-x   1 netsw  users    2866 Aug  5 14:49 netsw-home.cgi
  463. drwxr-xr-x   2 netsw  users     512 Jul  8 23:47 netsw-img/
  464. -rwxr-xr-x   1 netsw  users   24050 Aug  5 15:49 netsw-lsdir.cgi
  465. -rwxr-xr-x   1 netsw  users    1589 Aug  3 18:43 netsw-search.cgi
  466. -rwxr-xr-x   1 netsw  users    1885 Aug  1 17:41 netsw-tree.cgi
  467. -rw-r--r--   1 netsw  users     234 Jul 30 16:35 netsw-unlimit.lst
  468. </pre></div>
  469.  
  470.           <p>The <code>DATA/</code> subdirectory holds the above
  471.           directory structure, i.e. the real
  472.           <strong><em>net.sw</em></strong> stuff and gets
  473.           automatically updated via <code>rdist</code> from time to
  474.           time. The second part of the problem remains: how to link
  475.           these two structures together into one smooth-looking URL
  476.           tree? We want to hide the <code>DATA/</code> directory
  477.           from the user while running the appropriate CGI scripts
  478.           for the various URLs. Here is the solution: first I put
  479.           the following into the per-directory configuration file
  480.           in the <code class="directive"><a href="../mod/core.html#documentroot">DocumentRoot</a></code>
  481.           of the server to rewrite the announced URL
  482.           <code>/net.sw/</code> to the internal path
  483.           <code>/e/netsw</code>:</p>
  484.  
  485. <div class="example"><pre>
  486. RewriteRule  ^net.sw$       net.sw/        [R]
  487. RewriteRule  ^net.sw/(.*)$  e/netsw/$1
  488. </pre></div>
  489.  
  490.           <p>The first rule is for requests which miss the trailing
  491.           slash! The second rule does the real thing. And then
  492.           comes the killer configuration which stays in the
  493.           per-directory config file
  494.           <code>/e/netsw/.www/.wwwacl</code>:</p>
  495.  
  496. <div class="example"><pre>
  497. Options       ExecCGI FollowSymLinks Includes MultiViews
  498.  
  499. RewriteEngine on
  500.  
  501. #  we are reached via /net.sw/ prefix
  502. RewriteBase   /net.sw/
  503.  
  504. #  first we rewrite the root dir to
  505. #  the handling cgi script
  506. RewriteRule   ^$                       netsw-home.cgi     [L]
  507. RewriteRule   ^index\.html$            netsw-home.cgi     [L]
  508.  
  509. #  strip out the subdirs when
  510. #  the browser requests us from perdir pages
  511. RewriteRule   ^.+/(netsw-[^/]+/.+)$    $1                 [L]
  512.  
  513. #  and now break the rewriting for local files
  514. RewriteRule   ^netsw-home\.cgi.*       -                  [L]
  515. RewriteRule   ^netsw-changes\.cgi.*    -                  [L]
  516. RewriteRule   ^netsw-search\.cgi.*     -                  [L]
  517. RewriteRule   ^netsw-tree\.cgi$        -                  [L]
  518. RewriteRule   ^netsw-about\.html$      -                  [L]
  519. RewriteRule   ^netsw-img/.*$           -                  [L]
  520.  
  521. #  anything else is a subdir which gets handled
  522. #  by another cgi script
  523. RewriteRule   !^netsw-lsdir\.cgi.*     -                  [C]
  524. RewriteRule   (.*)                     netsw-lsdir.cgi/$1
  525. </pre></div>
  526.  
  527.           <p>Some hints for interpretation:</p>
  528.  
  529.           <ol>
  530.             <li>Notice the <code>L</code> (last) flag and no
  531.             substitution field ('<code>-</code>') in the forth part</li>
  532.  
  533.             <li>Notice the <code>!</code> (not) character and
  534.             the <code>C</code> (chain) flag at the first rule
  535.             in the last part</li>
  536.  
  537.             <li>Notice the catch-all pattern in the last rule</li>
  538.           </ol>
  539.         </dd>
  540.       </dl>
  541.  
  542.     
  543.  
  544.     <h3>NCSA imagemap to Apache <code>mod_imap</code></h3>
  545.  
  546.       
  547.  
  548.       <dl>
  549.         <dt>Description:</dt>
  550.  
  551.         <dd>
  552.           <p>When switching from the NCSA webserver to the more
  553.           modern Apache webserver a lot of people want a smooth
  554.           transition. So they want pages which use their old NCSA
  555.           <code>imagemap</code> program to work under Apache with the
  556.           modern <code class="module"><a href="../mod/mod_imap.html">mod_imap</a></code>. The problem is that there
  557.           are a lot of hyperlinks around which reference the
  558.           <code>imagemap</code> program via
  559.           <code>/cgi-bin/imagemap/path/to/page.map</code>. Under
  560.           Apache this has to read just
  561.           <code>/path/to/page.map</code>.</p>
  562.         </dd>
  563.  
  564.         <dt>Solution:</dt>
  565.  
  566.         <dd>
  567.           <p>We use a global rule to remove the prefix on-the-fly for
  568.           all requests:</p>
  569.  
  570. <div class="example"><pre>
  571. RewriteEngine  on
  572. RewriteRule    ^/cgi-bin/imagemap(.*)  $1  [PT]
  573. </pre></div>
  574.         </dd>
  575.       </dl>
  576.  
  577.     
  578.  
  579.     <h3>Search pages in more than one directory</h3>
  580.  
  581.       
  582.  
  583.       <dl>
  584.         <dt>Description:</dt>
  585.  
  586.         <dd>
  587.           <p>Sometimes it is necessary to let the webserver search
  588.           for pages in more than one directory. Here MultiViews or
  589.           other techniques cannot help.</p>
  590.         </dd>
  591.  
  592.         <dt>Solution:</dt>
  593.  
  594.         <dd>
  595.           <p>We program a explicit ruleset which searches for the
  596.           files in the directories.</p>
  597.  
  598. <div class="example"><pre>
  599. RewriteEngine on
  600.  
  601. #   first try to find it in custom/...
  602. #   ...and if found stop and be happy:
  603. RewriteCond         /your/docroot/<strong>dir1</strong>/%{REQUEST_FILENAME}  -f
  604. RewriteRule  ^(.+)  /your/docroot/<strong>dir1</strong>/$1  [L]
  605.  
  606. #   second try to find it in pub/...
  607. #   ...and if found stop and be happy:
  608. RewriteCond         /your/docroot/<strong>dir2</strong>/%{REQUEST_FILENAME}  -f
  609. RewriteRule  ^(.+)  /your/docroot/<strong>dir2</strong>/$1  [L]
  610.  
  611. #   else go on for other Alias or ScriptAlias directives,
  612. #   etc.
  613. RewriteRule   ^(.+)  -  [PT]
  614. </pre></div>
  615.         </dd>
  616.       </dl>
  617.  
  618.     
  619.  
  620.     <h3>Set Environment Variables According To URL Parts</h3>
  621.  
  622.       
  623.  
  624.       <dl>
  625.         <dt>Description:</dt>
  626.  
  627.         <dd>
  628.           <p>Perhaps you want to keep status information between
  629.           requests and use the URL to encode it. But you don't want
  630.           to use a CGI wrapper for all pages just to strip out this
  631.           information.</p>
  632.         </dd>
  633.  
  634.         <dt>Solution:</dt>
  635.  
  636.         <dd>
  637.           <p>We use a rewrite rule to strip out the status information
  638.           and remember it via an environment variable which can be
  639.           later dereferenced from within XSSI or CGI. This way a
  640.           URL <code>/foo/S=java/bar/</code> gets translated to
  641.           <code>/foo/bar/</code> and the environment variable named
  642.           <code>STATUS</code> is set to the value "java".</p>
  643.  
  644. <div class="example"><pre>
  645. RewriteEngine on
  646. RewriteRule   ^(.*)/<strong>S=([^/]+)</strong>/(.*)    $1/$3 [E=<strong>STATUS:$2</strong>]
  647. </pre></div>
  648.         </dd>
  649.       </dl>
  650.  
  651.     
  652.  
  653.     <h3>Virtual User Hosts</h3>
  654.  
  655.       
  656.  
  657.       <dl>
  658.         <dt>Description:</dt>
  659.  
  660.         <dd>
  661.           <p>Assume that you want to provide
  662.           <code>www.<strong>username</strong>.host.domain.com</code>
  663.           for the homepage of username via just DNS A records to the
  664.           same machine and without any virtualhosts on this
  665.           machine.</p>
  666.         </dd>
  667.  
  668.         <dt>Solution:</dt>
  669.  
  670.         <dd>
  671.           <p>For HTTP/1.0 requests there is no solution, but for
  672.           HTTP/1.1 requests which contain a Host: HTTP header we
  673.           can use the following ruleset to rewrite
  674.           <code>http://www.username.host.com/anypath</code>
  675.           internally to <code>/home/username/anypath</code>:</p>
  676.  
  677. <div class="example"><pre>
  678. RewriteEngine on
  679. RewriteCond   %{<strong>HTTP_HOST</strong>}                 ^www\.<strong>[^.]+</strong>\.host\.com$
  680. RewriteRule   ^(.+)                        %{HTTP_HOST}$1          [C]
  681. RewriteRule   ^www\.<strong>([^.]+)</strong>\.host\.com(.*) /home/<strong>$1</strong>$2
  682. </pre></div>
  683.         </dd>
  684.       </dl>
  685.  
  686.     
  687.  
  688.     <h3>Redirect Homedirs For Foreigners</h3>
  689.  
  690.       
  691.  
  692.       <dl>
  693.         <dt>Description:</dt>
  694.  
  695.         <dd>
  696.           <p>We want to redirect homedir URLs to another webserver
  697.           <code>www.somewhere.com</code> when the requesting user
  698.           does not stay in the local domain
  699.           <code>ourdomain.com</code>. This is sometimes used in
  700.           virtual host contexts.</p>
  701.         </dd>
  702.  
  703.         <dt>Solution:</dt>
  704.  
  705.         <dd>
  706.           <p>Just a rewrite condition:</p>
  707.  
  708. <div class="example"><pre>
  709. RewriteEngine on
  710. RewriteCond   %{REMOTE_HOST}  <strong>!^.+\.ourdomain\.com$</strong>
  711. RewriteRule   ^(/~.+)         http://www.somewhere.com/$1 [R,L]
  712. </pre></div>
  713.         </dd>
  714.       </dl>
  715.  
  716.     
  717.  
  718.     <h3>Redirect Failing URLs To Other Webserver</h3>
  719.  
  720.       
  721.  
  722.       <dl>
  723.         <dt>Description:</dt>
  724.  
  725.         <dd>
  726.           <p>A typical FAQ about URL rewriting is how to redirect
  727.           failing requests on webserver A to webserver B. Usually
  728.           this is done via <code class="directive"><a href="../mod/core.html#errordocument">ErrorDocument</a></code> CGI-scripts in Perl, but
  729.           there is also a <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> solution.
  730.           But notice that this performs more poorly than using an
  731.           <code class="directive"><a href="../mod/core.html#errordocument">ErrorDocument</a></code>
  732.           CGI-script!</p>
  733.         </dd>
  734.  
  735.         <dt>Solution:</dt>
  736.  
  737.         <dd>
  738.           <p>The first solution has the best performance but less
  739.           flexibility, and is less error safe:</p>
  740.  
  741. <div class="example"><pre>
  742. RewriteEngine on
  743. RewriteCond   /your/docroot/%{REQUEST_FILENAME} <strong>!-f</strong>
  744. RewriteRule   ^(.+)                             http://<strong>webserverB</strong>.dom/$1
  745. </pre></div>
  746.  
  747.           <p>The problem here is that this will only work for pages
  748.           inside the <code class="directive"><a href="../mod/core.html#documentroot">DocumentRoot</a></code>. While you can add more
  749.           Conditions (for instance to also handle homedirs, etc.)
  750.           there is better variant:</p>
  751.  
  752. <div class="example"><pre>
  753. RewriteEngine on
  754. RewriteCond   %{REQUEST_URI} <strong>!-U</strong>
  755. RewriteRule   ^(.+)          http://<strong>webserverB</strong>.dom/$1
  756. </pre></div>
  757.  
  758.           <p>This uses the URL look-ahead feature of <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>.
  759.           The result is that this will work for all types of URLs
  760.           and is a safe way. But it does a performance impact on
  761.           the webserver, because for every request there is one
  762.           more internal subrequest. So, if your webserver runs on a
  763.           powerful CPU, use this one. If it is a slow machine, use
  764.           the first approach or better a <code class="directive"><a href="../mod/core.html#errordocument">ErrorDocument</a></code> CGI-script.</p>
  765.         </dd>
  766.       </dl>
  767.  
  768.     
  769.  
  770.     <h3>Extended Redirection</h3>
  771.  
  772.       
  773.  
  774.       <dl>
  775.         <dt>Description:</dt>
  776.  
  777.         <dd>
  778.           <p>Sometimes we need more control (concerning the
  779.           character escaping mechanism) of URLs on redirects.
  780.           Usually the Apache kernels URL escape function also
  781.           escapes anchors, i.e. URLs like "<code>url#anchor</code>".
  782.           You cannot use this directly on redirects with
  783.           <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> because the
  784.           <code>uri_escape()</code> function of Apache
  785.           would also escape the hash character.
  786.           How can we redirect to such a URL?</p>
  787.         </dd>
  788.  
  789.         <dt>Solution:</dt>
  790.  
  791.         <dd>
  792.           <p>We have to use a kludge by the use of a NPH-CGI script
  793.           which does the redirect itself. Because here no escaping
  794.           is done (NPH=non-parseable headers). First we introduce a
  795.           new URL scheme <code>xredirect:</code> by the following
  796.           per-server config-line (should be one of the last rewrite
  797.           rules):</p>
  798.  
  799. <div class="example"><pre>
  800. RewriteRule ^xredirect:(.+) /path/to/nph-xredirect.cgi/$1 \
  801.             [T=application/x-httpd-cgi,L]
  802. </pre></div>
  803.  
  804.           <p>This forces all URLs prefixed with
  805.           <code>xredirect:</code> to be piped through the
  806.           <code>nph-xredirect.cgi</code> program. And this program
  807.           just looks like:</p>
  808.  
  809. <div class="example"><pre>
  810. #!/path/to/perl
  811. ##
  812. ##  nph-xredirect.cgi -- NPH/CGI script for extended redirects
  813. ##  Copyright (c) 1997 Ralf S. Engelschall, All Rights Reserved.
  814. ##
  815.  
  816. $| = 1;
  817. $url = $ENV{'PATH_INFO'};
  818.  
  819. print "HTTP/1.0 302 Moved Temporarily\n";
  820. print "Server: $ENV{'SERVER_SOFTWARE'}\n";
  821. print "Location: $url\n";
  822. print "Content-type: text/html\n";
  823. print "\n";
  824. print "<html>\n";
  825. print "<head>\n";
  826. print "<title>302 Moved Temporarily (EXTENDED)</title>\n";
  827. print "</head>\n";
  828. print "<body>\n";
  829. print "<h1>Moved Temporarily (EXTENDED)</h1>\n";
  830. print "The document has moved <a HREF=\"$url\">here</a>.<p>\n";
  831. print "</body>\n";
  832. print "</html>\n";
  833.  
  834. ##EOF##
  835. </pre></div>
  836.  
  837.           <p>This provides you with the functionality to do
  838.           redirects to all URL schemes, i.e. including the one
  839.           which are not directly accepted by <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>.
  840.           For instance you can now also redirect to
  841.           <code>news:newsgroup</code> via</p>
  842.  
  843. <div class="example"><pre>
  844. RewriteRule ^anyurl  xredirect:news:newsgroup
  845. </pre></div>
  846.  
  847.           <div class="note">Notice: You have not to put <code>[R]</code> or
  848.           <code>[R,L]</code> to the above rule because the
  849.           <code>xredirect:</code> need to be expanded later
  850.           by our special "pipe through" rule above.</div>
  851.         </dd>
  852.       </dl>
  853.  
  854.     
  855.  
  856.     <h3>Archive Access Multiplexer</h3>
  857.  
  858.       
  859.  
  860.       <dl>
  861.         <dt>Description:</dt>
  862.  
  863.         <dd>
  864.           <p>Do you know the great CPAN (Comprehensive Perl Archive
  865.           Network) under <a href="http://www.perl.com/CPAN">http://www.perl.com/CPAN</a>?
  866.           This does a redirect to one of several FTP servers around
  867.           the world which carry a CPAN mirror and is approximately
  868.           near the location of the requesting client. Actually this
  869.           can be called an FTP access multiplexing service. While
  870.           CPAN runs via CGI scripts, how can a similar approach
  871.           implemented via <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>?</p>
  872.         </dd>
  873.  
  874.         <dt>Solution:</dt>
  875.  
  876.         <dd>
  877.           <p>First we notice that from version 3.0.0
  878.           <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> can
  879.           also use the "<code>ftp:</code>" scheme on redirects.
  880.           And second, the location approximation can be done by a
  881.           <code class="directive"><a href="../mod/mod_rewrite.html#rewritemap">RewriteMap</a></code>
  882.           over the top-level domain of the client.
  883.           With a tricky chained ruleset we can use this top-level
  884.           domain as a key to our multiplexing map.</p>
  885.  
  886. <div class="example"><pre>
  887. RewriteEngine on
  888. RewriteMap    multiplex                txt:/path/to/map.cxan
  889. RewriteRule   ^/CxAN/(.*)              %{REMOTE_HOST}::$1                 [C]
  890. RewriteRule   ^.+\.<strong>([a-zA-Z]+)</strong>::(.*)$  ${multiplex:<strong>$1</strong>|ftp.default.dom}$2  [R,L]
  891. </pre></div>
  892.  
  893. <div class="example"><pre>
  894. ##
  895. ##  map.cxan -- Multiplexing Map for CxAN
  896. ##
  897.  
  898. de        ftp://ftp.cxan.de/CxAN/
  899. uk        ftp://ftp.cxan.uk/CxAN/
  900. com       ftp://ftp.cxan.com/CxAN/
  901.  :
  902. ##EOF##
  903. </pre></div>
  904.         </dd>
  905.       </dl>
  906.  
  907.     
  908.  
  909.     <h3>Time-Dependent Rewriting</h3>
  910.  
  911.       
  912.  
  913.       <dl>
  914.         <dt>Description:</dt>
  915.  
  916.         <dd>
  917.           <p>When tricks like time-dependent content should happen a
  918.           lot of webmasters still use CGI scripts which do for
  919.           instance redirects to specialized pages. How can it be done
  920.           via <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>?</p>
  921.         </dd>
  922.  
  923.         <dt>Solution:</dt>
  924.  
  925.         <dd>
  926.           <p>There are a lot of variables named <code>TIME_xxx</code>
  927.           for rewrite conditions. In conjunction with the special
  928.           lexicographic comparison patterns <code><STRING</code>,
  929.           <code>>STRING</code> and <code>=STRING</code> we can
  930.           do time-dependent redirects:</p>
  931.  
  932. <div class="example"><pre>
  933. RewriteEngine on
  934. RewriteCond   %{TIME_HOUR}%{TIME_MIN} >0700
  935. RewriteCond   %{TIME_HOUR}%{TIME_MIN} <1900
  936. RewriteRule   ^foo\.html$             foo.day.html
  937. RewriteRule   ^foo\.html$             foo.night.html
  938. </pre></div>
  939.  
  940.           <p>This provides the content of <code>foo.day.html</code>
  941.           under the URL <code>foo.html</code> from
  942.           <code>07:00-19:00</code> and at the remaining time the
  943.           contents of <code>foo.night.html</code>. Just a nice
  944.           feature for a homepage...</p>
  945.         </dd>
  946.       </dl>
  947.  
  948.     
  949.  
  950.     <h3>Backward Compatibility for YYYY to XXXX migration</h3>
  951.  
  952.       
  953.  
  954.       <dl>
  955.         <dt>Description:</dt>
  956.  
  957.         <dd>
  958.           <p>How can we make URLs backward compatible (still
  959.           existing virtually) after migrating <code>document.YYYY</code>
  960.           to <code>document.XXXX</code>, e.g. after translating a
  961.           bunch of <code>.html</code> files to <code>.phtml</code>?</p>
  962.         </dd>
  963.  
  964.         <dt>Solution:</dt>
  965.  
  966.         <dd>
  967.           <p>We just rewrite the name to its basename and test for
  968.           existence of the new extension. If it exists, we take
  969.           that name, else we rewrite the URL to its original state.</p>
  970.  
  971.  
  972. <div class="example"><pre>
  973. #   backward compatibility ruleset for
  974. #   rewriting document.html to document.phtml
  975. #   when and only when document.phtml exists
  976. #   but no longer document.html
  977. RewriteEngine on
  978. RewriteBase   /~quux/
  979. #   parse out basename, but remember the fact
  980. RewriteRule   ^(.*)\.html$              $1      [C,E=WasHTML:yes]
  981. #   rewrite to document.phtml if exists
  982. RewriteCond   %{REQUEST_FILENAME}.phtml -f
  983. RewriteRule   ^(.*)$ $1.phtml                   [S=1]
  984. #   else reverse the previous basename cutout
  985. RewriteCond   %{ENV:WasHTML}            ^yes$
  986. RewriteRule   ^(.*)$ $1.html
  987. </pre></div>
  988.         </dd>
  989.       </dl>
  990.  
  991.     
  992.  
  993.   </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  994. <div class="section">
  995. <h2><a name="content" id="content">Content Handling</a></h2>
  996.  
  997.     
  998.  
  999.     <h3>From Old to New (intern)</h3>
  1000.  
  1001.       
  1002.  
  1003.       <dl>
  1004.         <dt>Description:</dt>
  1005.  
  1006.         <dd>
  1007.           <p>Assume we have recently renamed the page
  1008.           <code>foo.html</code> to <code>bar.html</code> and now want
  1009.           to provide the old URL for backward compatibility. Actually
  1010.           we want that users of the old URL even not recognize that
  1011.           the pages was renamed.</p>
  1012.         </dd>
  1013.  
  1014.         <dt>Solution:</dt>
  1015.  
  1016.         <dd>
  1017.           <p>We rewrite the old URL to the new one internally via the
  1018.           following rule:</p>
  1019.  
  1020. <div class="example"><pre>
  1021. RewriteEngine  on
  1022. RewriteBase    /~quux/
  1023. RewriteRule    ^<strong>foo</strong>\.html$  <strong>bar</strong>.html
  1024. </pre></div>
  1025.         </dd>
  1026.       </dl>
  1027.  
  1028.     
  1029.  
  1030.     <h3>From Old to New (extern)</h3>
  1031.  
  1032.       
  1033.  
  1034.       <dl>
  1035.         <dt>Description:</dt>
  1036.  
  1037.         <dd>
  1038.           <p>Assume again that we have recently renamed the page
  1039.           <code>foo.html</code> to <code>bar.html</code> and now want
  1040.           to provide the old URL for backward compatibility. But this
  1041.           time we want that the users of the old URL get hinted to
  1042.           the new one, i.e. their browsers Location field should
  1043.           change, too.</p>
  1044.         </dd>
  1045.  
  1046.         <dt>Solution:</dt>
  1047.  
  1048.         <dd>
  1049.           <p>We force a HTTP redirect to the new URL which leads to a
  1050.           change of the browsers and thus the users view:</p>
  1051.  
  1052. <div class="example"><pre>
  1053. RewriteEngine  on
  1054. RewriteBase    /~quux/
  1055. RewriteRule    ^<strong>foo</strong>\.html$  <strong>bar</strong>.html  [<strong>R</strong>]
  1056. </pre></div>
  1057.         </dd>
  1058.       </dl>
  1059.  
  1060.     
  1061.  
  1062.     <h3>Browser Dependent Content</h3>
  1063.  
  1064.       
  1065.  
  1066.       <dl>
  1067.         <dt>Description:</dt>
  1068.  
  1069.         <dd>
  1070.           <p>At least for important top-level pages it is sometimes
  1071.           necessary to provide the optimum of browser dependent
  1072.           content, i.e. one has to provide a maximum version for the
  1073.           latest Netscape variants, a minimum version for the Lynx
  1074.           browsers and a average feature version for all others.</p>
  1075.         </dd>
  1076.  
  1077.         <dt>Solution:</dt>
  1078.  
  1079.         <dd>
  1080.           <p>We cannot use content negotiation because the browsers do
  1081.           not provide their type in that form. Instead we have to
  1082.           act on the HTTP header "User-Agent". The following condig
  1083.           does the following: If the HTTP header "User-Agent"
  1084.           begins with "Mozilla/3", the page <code>foo.html</code>
  1085.           is rewritten to <code>foo.NS.html</code> and and the
  1086.           rewriting stops. If the browser is "Lynx" or "Mozilla" of
  1087.           version 1 or 2 the URL becomes <code>foo.20.html</code>.
  1088.           All other browsers receive page <code>foo.32.html</code>.
  1089.           This is done by the following ruleset:</p>
  1090.  
  1091. <div class="example"><pre>
  1092. RewriteCond %{HTTP_USER_AGENT}  ^<strong>Mozilla/3</strong>.*
  1093. RewriteRule ^foo\.html$         foo.<strong>NS</strong>.html          [<strong>L</strong>]
  1094.  
  1095. RewriteCond %{HTTP_USER_AGENT}  ^<strong>Lynx/</strong>.*         [OR]
  1096. RewriteCond %{HTTP_USER_AGENT}  ^<strong>Mozilla/[12]</strong>.*
  1097. RewriteRule ^foo\.html$         foo.<strong>20</strong>.html          [<strong>L</strong>]
  1098.  
  1099. RewriteRule ^foo\.html$         foo.<strong>32</strong>.html          [<strong>L</strong>]
  1100. </pre></div>
  1101.         </dd>
  1102.       </dl>
  1103.  
  1104.     
  1105.  
  1106.     <h3>Dynamic Mirror</h3>
  1107.  
  1108.       
  1109.  
  1110.       <dl>
  1111.         <dt>Description:</dt>
  1112.  
  1113.         <dd>
  1114.           <p>Assume there are nice webpages on remote hosts we want
  1115.           to bring into our namespace. For FTP servers we would use
  1116.           the <code>mirror</code> program which actually maintains an
  1117.           explicit up-to-date copy of the remote data on the local
  1118.           machine. For a webserver we could use the program
  1119.           <code>webcopy</code> which acts similar via HTTP. But both
  1120.           techniques have one major drawback: The local copy is
  1121.           always just as up-to-date as often we run the program. It
  1122.           would be much better if the mirror is not a static one we
  1123.           have to establish explicitly. Instead we want a dynamic
  1124.           mirror with data which gets updated automatically when
  1125.           there is need (updated data on the remote host).</p>
  1126.         </dd>
  1127.  
  1128.         <dt>Solution:</dt>
  1129.  
  1130.         <dd>
  1131.           <p>To provide this feature we map the remote webpage or even
  1132.           the complete remote webarea to our namespace by the use
  1133.           of the <dfn>Proxy Throughput</dfn> feature
  1134.           (flag <code>[P]</code>):</p>
  1135.  
  1136. <div class="example"><pre>
  1137. RewriteEngine  on
  1138. RewriteBase    /~quux/
  1139. RewriteRule    ^<strong>hotsheet/</strong>(.*)$  <strong>http://www.tstimpreso.com/hotsheet/</strong>$1  [<strong>P</strong>]
  1140. </pre></div>
  1141.  
  1142. <div class="example"><pre>
  1143. RewriteEngine  on
  1144. RewriteBase    /~quux/
  1145. RewriteRule    ^<strong>usa-news\.html</strong>$   <strong>http://www.quux-corp.com/news/index.html</strong>  [<strong>P</strong>]
  1146. </pre></div>
  1147.         </dd>
  1148.       </dl>
  1149.  
  1150.     
  1151.  
  1152.     <h3>Reverse Dynamic Mirror</h3>
  1153.  
  1154.       
  1155.  
  1156.       <dl>
  1157.         <dt>Description:</dt>
  1158.  
  1159.         <dd>...</dd>
  1160.  
  1161.         <dt>Solution:</dt>
  1162.  
  1163.         <dd>
  1164. <div class="example"><pre>
  1165. RewriteEngine on
  1166. RewriteCond   /mirror/of/remotesite/$1           -U
  1167. RewriteRule   ^http://www\.remotesite\.com/(.*)$ /mirror/of/remotesite/$1
  1168. </pre></div>
  1169.         </dd>
  1170.       </dl>
  1171.  
  1172.     
  1173.  
  1174.     <h3>Retrieve Missing Data from Intranet</h3>
  1175.  
  1176.       
  1177.  
  1178.       <dl>
  1179.         <dt>Description:</dt>
  1180.  
  1181.         <dd>
  1182.           <p>This is a tricky way of virtually running a corporate
  1183.           (external) Internet webserver
  1184.           (<code>www.quux-corp.dom</code>), while actually keeping
  1185.           and maintaining its data on a (internal) Intranet webserver
  1186.           (<code>www2.quux-corp.dom</code>) which is protected by a
  1187.           firewall. The trick is that on the external webserver we
  1188.           retrieve the requested data on-the-fly from the internal
  1189.           one.</p>
  1190.         </dd>
  1191.  
  1192.         <dt>Solution:</dt>
  1193.  
  1194.         <dd>
  1195.           <p>First, we have to make sure that our firewall still
  1196.           protects the internal webserver and that only the
  1197.           external webserver is allowed to retrieve data from it.
  1198.           For a packet-filtering firewall we could for instance
  1199.           configure a firewall ruleset like the following:</p>
  1200.  
  1201. <div class="example"><pre>
  1202. <strong>ALLOW</strong> Host www.quux-corp.dom Port >1024 --> Host www2.quux-corp.dom Port <strong>80</strong>
  1203. <strong>DENY</strong>  Host *                 Port *     --> Host www2.quux-corp.dom Port <strong>80</strong>
  1204. </pre></div>
  1205.  
  1206.           <p>Just adjust it to your actual configuration syntax.
  1207.           Now we can establish the <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>
  1208.           rules which request the missing data in the background
  1209.           through the proxy throughput feature:</p>
  1210.  
  1211. <div class="example"><pre>
  1212. RewriteRule ^/~([^/]+)/?(.*)          /home/$1/.www/$2
  1213. RewriteCond %{REQUEST_FILENAME}       <strong>!-f</strong>
  1214. RewriteCond %{REQUEST_FILENAME}       <strong>!-d</strong>
  1215. RewriteRule ^/home/([^/]+)/.www/?(.*) http://<strong>www2</strong>.quux-corp.dom/~$1/pub/$2 [<strong>P</strong>]
  1216. </pre></div>
  1217.         </dd>
  1218.       </dl>
  1219.  
  1220.     
  1221.  
  1222.     <h3>Load Balancing</h3>
  1223.  
  1224.       
  1225.  
  1226.       <dl>
  1227.         <dt>Description:</dt>
  1228.  
  1229.         <dd>
  1230.           <p>Suppose we want to load balance the traffic to
  1231.           <code>www.foo.com</code> over <code>www[0-5].foo.com</code>
  1232.           (a total of 6 servers). How can this be done?</p>
  1233.         </dd>
  1234.  
  1235.         <dt>Solution:</dt>
  1236.  
  1237.         <dd>
  1238.           <p>There are a lot of possible solutions for this problem.
  1239.           We will discuss first a commonly known DNS-based variant
  1240.           and then the special one with <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>:</p>
  1241.  
  1242.           <ol>
  1243.             <li>
  1244.               <strong>DNS Round-Robin</strong>
  1245.  
  1246.               <p>The simplest method for load-balancing is to use
  1247.               the DNS round-robin feature of <code>BIND</code>.
  1248.               Here you just configure <code>www[0-9].foo.com</code>
  1249.               as usual in your DNS with A(address) records, e.g.</p>
  1250.  
  1251. <div class="example"><pre>
  1252. www0   IN  A       1.2.3.1
  1253. www1   IN  A       1.2.3.2
  1254. www2   IN  A       1.2.3.3
  1255. www3   IN  A       1.2.3.4
  1256. www4   IN  A       1.2.3.5
  1257. www5   IN  A       1.2.3.6
  1258. </pre></div>
  1259.  
  1260.               <p>Then you additionally add the following entry:</p>
  1261.  
  1262. <div class="example"><pre>
  1263. www    IN  CNAME   www0.foo.com.
  1264.        IN  CNAME   www1.foo.com.
  1265.        IN  CNAME   www2.foo.com.
  1266.        IN  CNAME   www3.foo.com.
  1267.        IN  CNAME   www4.foo.com.
  1268.        IN  CNAME   www5.foo.com.
  1269.        IN  CNAME   www6.foo.com.
  1270. </pre></div>
  1271.  
  1272.               <p>Notice that this seems wrong, but is actually an
  1273.               intended feature of <code>BIND</code> and can be used
  1274.               in this way. However, now when <code>www.foo.com</code> gets
  1275.               resolved, <code>BIND</code> gives out <code>www0-www6</code>
  1276.               - but in a slightly permutated/rotated order every time.
  1277.               This way the clients are spread over the various
  1278.               servers. But notice that this not a perfect load
  1279.               balancing scheme, because DNS resolve information
  1280.               gets cached by the other nameservers on the net, so
  1281.               once a client has resolved <code>www.foo.com</code>
  1282.               to a particular <code>wwwN.foo.com</code>, all
  1283.               subsequent requests also go to this particular name
  1284.               <code>wwwN.foo.com</code>. But the final result is
  1285.               ok, because the total sum of the requests are really
  1286.               spread over the various webservers.</p>
  1287.             </li>
  1288.  
  1289.             <li>
  1290.               <strong>DNS Load-Balancing</strong>
  1291.  
  1292.               <p>A sophisticated DNS-based method for
  1293.               load-balancing is to use the program
  1294.               <code>lbnamed</code> which can be found at <a href="http://www.stanford.edu/~schemers/docs/lbnamed/lbnamed.html">
  1295.               http://www.stanford.edu/~schemers/docs/lbnamed/lbnamed.html</a>.
  1296.               It is a Perl 5 program in conjunction with auxilliary
  1297.               tools which provides a real load-balancing for
  1298.               DNS.</p>
  1299.             </li>
  1300.  
  1301.             <li>
  1302.               <strong>Proxy Throughput Round-Robin</strong>
  1303.  
  1304.               <p>In this variant we use <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>
  1305.               and its proxy throughput feature. First we dedicate
  1306.               <code>www0.foo.com</code> to be actually
  1307.               <code>www.foo.com</code> by using a single</p>
  1308.  
  1309. <div class="example"><pre>
  1310. www    IN  CNAME   www0.foo.com.
  1311. </pre></div>
  1312.  
  1313.               <p>entry in the DNS. Then we convert
  1314.               <code>www0.foo.com</code> to a proxy-only server,
  1315.               i.e. we configure this machine so all arriving URLs
  1316.               are just pushed through the internal proxy to one of
  1317.               the 5 other servers (<code>www1-www5</code>). To
  1318.               accomplish this we first establish a ruleset which
  1319.               contacts a load balancing script <code>lb.pl</code>
  1320.               for all URLs.</p>
  1321.  
  1322. <div class="example"><pre>
  1323. RewriteEngine on
  1324. RewriteMap    lb      prg:/path/to/lb.pl
  1325. RewriteRule   ^/(.+)$ ${lb:$1}           [P,L]
  1326. </pre></div>
  1327.  
  1328.               <p>Then we write <code>lb.pl</code>:</p>
  1329.  
  1330. <div class="example"><pre>
  1331. #!/path/to/perl
  1332. ##
  1333. ##  lb.pl -- load balancing script
  1334. ##
  1335.  
  1336. $| = 1;
  1337.  
  1338. $name   = "www";     # the hostname base
  1339. $first  = 1;         # the first server (not 0 here, because 0 is myself)
  1340. $last   = 5;         # the last server in the round-robin
  1341. $domain = "foo.dom"; # the domainname
  1342.  
  1343. $cnt = 0;
  1344. while (<STDIN>) {
  1345.     $cnt = (($cnt+1) % ($last+1-$first));
  1346.     $server = sprintf("%s%d.%s", $name, $cnt+$first, $domain);
  1347.     print "http://$server/$_";
  1348. }
  1349.  
  1350. ##EOF##
  1351. </pre></div>
  1352.  
  1353.               <div class="note">A last notice: Why is this useful? Seems like
  1354.               <code>www0.foo.com</code> still is overloaded? The
  1355.               answer is yes, it is overloaded, but with plain proxy
  1356.               throughput requests, only! All SSI, CGI, ePerl, etc.
  1357.               processing is completely done on the other machines.
  1358.               This is the essential point.</div>
  1359.             </li>
  1360.  
  1361.             <li>
  1362.               <strong>Hardware/TCP Round-Robin</strong>
  1363.  
  1364.               <p>There is a hardware solution available, too. Cisco
  1365.               has a beast called LocalDirector which does a load
  1366.               balancing at the TCP/IP level. Actually this is some
  1367.               sort of a circuit level gateway in front of a
  1368.               webcluster. If you have enough money and really need
  1369.               a solution with high performance, use this one.</p>
  1370.             </li>
  1371.           </ol>
  1372.         </dd>
  1373.       </dl>
  1374.  
  1375.     
  1376.  
  1377.     <h3>New MIME-type, New Service</h3>
  1378.  
  1379.       
  1380.  
  1381.       <dl>
  1382.         <dt>Description:</dt>
  1383.  
  1384.         <dd>
  1385.           <p>On the net there are a lot of nifty CGI programs. But
  1386.           their usage is usually boring, so a lot of webmaster
  1387.           don't use them. Even Apache's Action handler feature for
  1388.           MIME-types is only appropriate when the CGI programs
  1389.           don't need special URLs (actually <code>PATH_INFO</code>
  1390.           and <code>QUERY_STRINGS</code>) as their input. First,
  1391.           let us configure a new file type with extension
  1392.           <code>.scgi</code> (for secure CGI) which will be processed
  1393.           by the popular <code>cgiwrap</code> program. The problem
  1394.           here is that for instance we use a Homogeneous URL Layout
  1395.           (see above) a file inside the user homedirs has the URL
  1396.           <code>/u/user/foo/bar.scgi</code>. But
  1397.           <code>cgiwrap</code> needs the URL in the form
  1398.           <code>/~user/foo/bar.scgi/</code>. The following rule
  1399.           solves the problem:</p>
  1400.  
  1401. <div class="example"><pre>
  1402. RewriteRule ^/[uge]/<strong>([^/]+)</strong>/\.www/(.+)\.scgi(.*) ...
  1403. ... /internal/cgi/user/cgiwrap/~<strong>$1</strong>/$2.scgi$3  [NS,<strong>T=application/x-http-cgi</strong>]
  1404. </pre></div>
  1405.  
  1406.           <p>Or assume we have some more nifty programs:
  1407.           <code>wwwlog</code> (which displays the
  1408.           <code>access.log</code> for a URL subtree and
  1409.           <code>wwwidx</code> (which runs Glimpse on a URL
  1410.           subtree). We have to provide the URL area to these
  1411.           programs so they know on which area they have to act on.
  1412.           But usually this ugly, because they are all the times
  1413.           still requested from that areas, i.e. typically we would
  1414.           run the <code>swwidx</code> program from within
  1415.           <code>/u/user/foo/</code> via hyperlink to</p>
  1416.  
  1417. <div class="example"><pre>
  1418. /internal/cgi/user/swwidx?i=/u/user/foo/
  1419. </pre></div>
  1420.  
  1421.           <p>which is ugly. Because we have to hard-code
  1422.           <strong>both</strong> the location of the area
  1423.           <strong>and</strong> the location of the CGI inside the
  1424.           hyperlink. When we have to reorganize the area, we spend a
  1425.           lot of time changing the various hyperlinks.</p>
  1426.         </dd>
  1427.  
  1428.         <dt>Solution:</dt>
  1429.  
  1430.         <dd>
  1431.           <p>The solution here is to provide a special new URL format
  1432.           which automatically leads to the proper CGI invocation.
  1433.           We configure the following:</p>
  1434.  
  1435. <div class="example"><pre>
  1436. RewriteRule   ^/([uge])/([^/]+)(/?.*)/\*  /internal/cgi/user/wwwidx?i=/$1/$2$3/
  1437. RewriteRule   ^/([uge])/([^/]+)(/?.*):log /internal/cgi/user/wwwlog?f=/$1/$2$3
  1438. </pre></div>
  1439.  
  1440.           <p>Now the hyperlink to search at
  1441.           <code>/u/user/foo/</code> reads only</p>
  1442.  
  1443. <div class="example"><pre>
  1444. HREF="*"
  1445. </pre></div>
  1446.  
  1447.           <p>which internally gets automatically transformed to</p>
  1448.  
  1449. <div class="example"><pre>
  1450. /internal/cgi/user/wwwidx?i=/u/user/foo/
  1451. </pre></div>
  1452.  
  1453.           <p>The same approach leads to an invocation for the
  1454.           access log CGI program when the hyperlink
  1455.           <code>:log</code> gets used.</p>
  1456.         </dd>
  1457.       </dl>
  1458.  
  1459.     
  1460.  
  1461.     <h3>From Static to Dynamic</h3>
  1462.  
  1463.       
  1464.  
  1465.       <dl>
  1466.         <dt>Description:</dt>
  1467.  
  1468.         <dd>
  1469.           <p>How can we transform a static page
  1470.           <code>foo.html</code> into a dynamic variant
  1471.           <code>foo.cgi</code> in a seamless way, i.e. without notice
  1472.           by the browser/user.</p>
  1473.         </dd>
  1474.  
  1475.         <dt>Solution:</dt>
  1476.  
  1477.         <dd>
  1478.           <p>We just rewrite the URL to the CGI-script and force the
  1479.           correct MIME-type so it gets really run as a CGI-script.
  1480.           This way a request to <code>/~quux/foo.html</code>
  1481.           internally leads to the invocation of
  1482.           <code>/~quux/foo.cgi</code>.</p>
  1483.  
  1484. <div class="example"><pre>
  1485. RewriteEngine  on
  1486. RewriteBase    /~quux/
  1487. RewriteRule    ^foo\.<strong>html</strong>$  foo.<strong>cgi</strong>  [T=<strong>application/x-httpd-cgi</strong>]
  1488. </pre></div>
  1489.         </dd>
  1490.       </dl>
  1491.  
  1492.     
  1493.  
  1494.     <h3>On-the-fly Content-Regeneration</h3>
  1495.  
  1496.       
  1497.  
  1498.       <dl>
  1499.         <dt>Description:</dt>
  1500.  
  1501.         <dd>
  1502.           <p>Here comes a really esoteric feature: Dynamically
  1503.           generated but statically served pages, i.e. pages should be
  1504.           delivered as pure static pages (read from the filesystem
  1505.           and just passed through), but they have to be generated
  1506.           dynamically by the webserver if missing. This way you can
  1507.           have CGI-generated pages which are statically served unless
  1508.           one (or a cronjob) removes the static contents. Then the
  1509.           contents gets refreshed.</p>
  1510.         </dd>
  1511.  
  1512.         <dt>Solution:</dt>
  1513.  
  1514.         <dd>
  1515.           This is done via the following ruleset:
  1516.  
  1517. <div class="example"><pre>
  1518. RewriteCond %{REQUEST_FILENAME}   <strong>!-s</strong>
  1519. RewriteRule ^page\.<strong>html</strong>$          page.<strong>cgi</strong>   [T=application/x-httpd-cgi,L]
  1520. </pre></div>
  1521.  
  1522.           <p>Here a request to <code>page.html</code> leads to a
  1523.           internal run of a corresponding <code>page.cgi</code> if
  1524.           <code>page.html</code> is still missing or has filesize
  1525.           null. The trick here is that <code>page.cgi</code> is a
  1526.           usual CGI script which (additionally to its <code>STDOUT</code>)
  1527.           writes its output to the file <code>page.html</code>.
  1528.           Once it was run, the server sends out the data of
  1529.           <code>page.html</code>. When the webmaster wants to force
  1530.           a refresh the contents, he just removes
  1531.           <code>page.html</code> (usually done by a cronjob).</p>
  1532.         </dd>
  1533.       </dl>
  1534.  
  1535.     
  1536.  
  1537.     <h3>Document With Autorefresh</h3>
  1538.  
  1539.       
  1540.  
  1541.       <dl>
  1542.         <dt>Description:</dt>
  1543.  
  1544.         <dd>
  1545.           <p>Wouldn't it be nice while creating a complex webpage if
  1546.           the webbrowser would automatically refresh the page every
  1547.           time we write a new version from within our editor?
  1548.           Impossible?</p>
  1549.         </dd>
  1550.  
  1551.         <dt>Solution:</dt>
  1552.  
  1553.         <dd>
  1554.           <p>No! We just combine the MIME multipart feature, the
  1555.           webserver NPH feature and the URL manipulation power of
  1556.           <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>. First, we establish a new
  1557.           URL feature: Adding just <code>:refresh</code> to any
  1558.           URL causes this to be refreshed every time it gets
  1559.           updated on the filesystem.</p>
  1560.  
  1561. <div class="example"><pre>
  1562. RewriteRule   ^(/[uge]/[^/]+/?.*):refresh  /internal/cgi/apache/nph-refresh?f=$1
  1563. </pre></div>
  1564.  
  1565.           <p>Now when we reference the URL</p>
  1566.  
  1567. <div class="example"><pre>
  1568. /u/foo/bar/page.html:refresh
  1569. </pre></div>
  1570.  
  1571.           <p>this leads to the internal invocation of the URL</p>
  1572.  
  1573. <div class="example"><pre>
  1574. /internal/cgi/apache/nph-refresh?f=/u/foo/bar/page.html
  1575. </pre></div>
  1576.  
  1577.           <p>The only missing part is the NPH-CGI script. Although
  1578.           one would usually say "left as an exercise to the reader"
  1579.           ;-) I will provide this, too.</p>
  1580.  
  1581. <div class="example"><pre>
  1582. #!/sw/bin/perl
  1583. ##
  1584. ##  nph-refresh -- NPH/CGI script for auto refreshing pages
  1585. ##  Copyright (c) 1997 Ralf S. Engelschall, All Rights Reserved.
  1586. ##
  1587. $| = 1;
  1588.  
  1589. #   split the QUERY_STRING variable
  1590. @pairs = split(/&/, $ENV{'QUERY_STRING'});
  1591. foreach $pair (@pairs) {
  1592.     ($name, $value) = split(/=/, $pair);
  1593.     $name =~ tr/A-Z/a-z/;
  1594.     $name = 'QS_' . $name;
  1595.     $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C", hex($1))/eg;
  1596.     eval "\$$name = \"$value\"";
  1597. }
  1598. $QS_s = 1 if ($QS_s eq '');
  1599. $QS_n = 3600 if ($QS_n eq '');
  1600. if ($QS_f eq '') {
  1601.     print "HTTP/1.0 200 OK\n";
  1602.     print "Content-type: text/html\n\n";
  1603.     print "&lt;b&gt;ERROR&lt;/b&gt;: No file given\n";
  1604.     exit(0);
  1605. }
  1606. if (! -f $QS_f) {
  1607.     print "HTTP/1.0 200 OK\n";
  1608.     print "Content-type: text/html\n\n";
  1609.     print "&lt;b&gt;ERROR&lt;/b&gt;: File $QS_f not found\n";
  1610.     exit(0);
  1611. }
  1612.  
  1613. sub print_http_headers_multipart_begin {
  1614.     print "HTTP/1.0 200 OK\n";
  1615.     $bound = "ThisRandomString12345";
  1616.     print "Content-type: multipart/x-mixed-replace;boundary=$bound\n";
  1617.     &print_http_headers_multipart_next;
  1618. }
  1619.  
  1620. sub print_http_headers_multipart_next {
  1621.     print "\n--$bound\n";
  1622. }
  1623.  
  1624. sub print_http_headers_multipart_end {
  1625.     print "\n--$bound--\n";
  1626. }
  1627.  
  1628. sub displayhtml {
  1629.     local($buffer) = @_;
  1630.     $len = length($buffer);
  1631.     print "Content-type: text/html\n";
  1632.     print "Content-length: $len\n\n";
  1633.     print $buffer;
  1634. }
  1635.  
  1636. sub readfile {
  1637.     local($file) = @_;
  1638.     local(*FP, $size, $buffer, $bytes);
  1639.     ($x, $x, $x, $x, $x, $x, $x, $size) = stat($file);
  1640.     $size = sprintf("%d", $size);
  1641.     open(FP, "&lt;$file");
  1642.     $bytes = sysread(FP, $buffer, $size);
  1643.     close(FP);
  1644.     return $buffer;
  1645. }
  1646.  
  1647. $buffer = &readfile($QS_f);
  1648. &print_http_headers_multipart_begin;
  1649. &displayhtml($buffer);
  1650.  
  1651. sub mystat {
  1652.     local($file) = $_[0];
  1653.     local($time);
  1654.  
  1655.     ($x, $x, $x, $x, $x, $x, $x, $x, $x, $mtime) = stat($file);
  1656.     return $mtime;
  1657. }
  1658.  
  1659. $mtimeL = &mystat($QS_f);
  1660. $mtime = $mtime;
  1661. for ($n = 0; $n &lt; $QS_n; $n++) {
  1662.     while (1) {
  1663.         $mtime = &mystat($QS_f);
  1664.         if ($mtime ne $mtimeL) {
  1665.             $mtimeL = $mtime;
  1666.             sleep(2);
  1667.             $buffer = &readfile($QS_f);
  1668.             &print_http_headers_multipart_next;
  1669.             &displayhtml($buffer);
  1670.             sleep(5);
  1671.             $mtimeL = &mystat($QS_f);
  1672.             last;
  1673.         }
  1674.         sleep($QS_s);
  1675.     }
  1676. }
  1677.  
  1678. &print_http_headers_multipart_end;
  1679.  
  1680. exit(0);
  1681.  
  1682. ##EOF##
  1683. </pre></div>
  1684.         </dd>
  1685.       </dl>
  1686.  
  1687.     
  1688.  
  1689.     <h3>Mass Virtual Hosting</h3>
  1690.  
  1691.       
  1692.  
  1693.       <dl>
  1694.         <dt>Description:</dt>
  1695.  
  1696.         <dd>
  1697.           <p>The <code class="directive"><a href="../mod/core.html#virtualhost"><VirtualHost></a></code> feature of Apache is nice
  1698.           and works great when you just have a few dozens
  1699.           virtual hosts. But when you are an ISP and have hundreds of
  1700.           virtual hosts to provide this feature is not the best
  1701.           choice.</p>
  1702.         </dd>
  1703.  
  1704.         <dt>Solution:</dt>
  1705.  
  1706.         <dd>
  1707.           <p>To provide this feature we map the remote webpage or even
  1708.           the complete remote webarea to our namespace by the use
  1709.           of the <dfn>Proxy Throughput</dfn> feature (flag <code>[P]</code>):</p>
  1710.  
  1711. <div class="example"><pre>
  1712. ##
  1713. ##  vhost.map
  1714. ##
  1715. www.vhost1.dom:80  /path/to/docroot/vhost1
  1716. www.vhost2.dom:80  /path/to/docroot/vhost2
  1717.      :
  1718. www.vhostN.dom:80  /path/to/docroot/vhostN
  1719. </pre></div>
  1720.  
  1721. <div class="example"><pre>
  1722. ##
  1723. ##  httpd.conf
  1724. ##
  1725.     :
  1726. #   use the canonical hostname on redirects, etc.
  1727. UseCanonicalName on
  1728.  
  1729.     :
  1730. #   add the virtual host in front of the CLF-format
  1731. CustomLog  /path/to/access_log  "%{VHOST}e %h %l %u %t \"%r\" %>s %b"
  1732.     :
  1733.  
  1734. #   enable the rewriting engine in the main server
  1735. RewriteEngine on
  1736.  
  1737. #   define two maps: one for fixing the URL and one which defines
  1738. #   the available virtual hosts with their corresponding
  1739. #   DocumentRoot.
  1740. RewriteMap    lowercase    int:tolower
  1741. RewriteMap    vhost        txt:/path/to/vhost.map
  1742.  
  1743. #   Now do the actual virtual host mapping
  1744. #   via a huge and complicated single rule:
  1745. #
  1746. #   1. make sure we don't map for common locations
  1747. RewriteCond   %{REQUEST_URL}  !^/commonurl1/.*
  1748. RewriteCond   %{REQUEST_URL}  !^/commonurl2/.*
  1749.     :
  1750. RewriteCond   %{REQUEST_URL}  !^/commonurlN/.*
  1751. #
  1752. #   2. make sure we have a Host header, because
  1753. #      currently our approach only supports
  1754. #      virtual hosting through this header
  1755. RewriteCond   %{HTTP_HOST}  !^$
  1756. #
  1757. #   3. lowercase the hostname
  1758. RewriteCond   ${lowercase:%{HTTP_HOST}|NONE}  ^(.+)$
  1759. #
  1760. #   4. lookup this hostname in vhost.map and
  1761. #      remember it only when it is a path
  1762. #      (and not "NONE" from above)
  1763. RewriteCond   ${vhost:%1}  ^(/.*)$
  1764. #
  1765. #   5. finally we can map the URL to its docroot location
  1766. #      and remember the virtual host for logging puposes
  1767. RewriteRule   ^/(.*)$   %1/$1  [E=VHOST:${lowercase:%{HTTP_HOST}}]
  1768.     :
  1769. </pre></div>
  1770.         </dd>
  1771.       </dl>
  1772.  
  1773.     
  1774.  
  1775.   </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  1776. <div class="section">
  1777. <h2><a name="access" id="access">Access Restriction</a></h2>
  1778.  
  1779.     
  1780.  
  1781.     <h3>Blocking of Robots</h3>
  1782.  
  1783.       
  1784.  
  1785.       <dl>
  1786.         <dt>Description:</dt>
  1787.  
  1788.         <dd>
  1789.           <p>How can we block a really annoying robot from
  1790.           retrieving pages of a specific webarea? A
  1791.           <code>/robots.txt</code> file containing entries of the
  1792.           "Robot Exclusion Protocol" is typically not enough to get
  1793.           rid of such a robot.</p>
  1794.         </dd>
  1795.  
  1796.         <dt>Solution:</dt>
  1797.  
  1798.         <dd>
  1799.           <p>We use a ruleset which forbids the URLs of the webarea
  1800.           <code>/~quux/foo/arc/</code> (perhaps a very deep
  1801.           directory indexed area where the robot traversal would
  1802.           create big server load). We have to make sure that we
  1803.           forbid access only to the particular robot, i.e. just
  1804.           forbidding the host where the robot runs is not enough.
  1805.           This would block users from this host, too. We accomplish
  1806.           this by also matching the User-Agent HTTP header
  1807.           information.</p>
  1808.  
  1809. <div class="example"><pre>
  1810. RewriteCond %{HTTP_USER_AGENT}   ^<strong>NameOfBadRobot</strong>.*
  1811. RewriteCond %{REMOTE_ADDR}       ^<strong>123\.45\.67\.[8-9]</strong>$
  1812. RewriteRule ^<strong>/~quux/foo/arc/</strong>.+   -   [<strong>F</strong>]
  1813. </pre></div>
  1814.         </dd>
  1815.       </dl>
  1816.  
  1817.     
  1818.  
  1819.     <h3>Blocked Inline-Images</h3>
  1820.  
  1821.       
  1822.  
  1823.       <dl>
  1824.         <dt>Description:</dt>
  1825.  
  1826.         <dd>
  1827.           <p>Assume we have under <code>http://www.quux-corp.de/~quux/</code>
  1828.           some pages with inlined GIF graphics. These graphics are
  1829.           nice, so others directly incorporate them via hyperlinks to
  1830.           their pages. We don't like this practice because it adds
  1831.           useless traffic to our server.</p>
  1832.         </dd>
  1833.  
  1834.         <dt>Solution:</dt>
  1835.  
  1836.         <dd>
  1837.           <p>While we cannot 100% protect the images from inclusion,
  1838.           we can at least restrict the cases where the browser
  1839.           sends a HTTP Referer header.</p>
  1840.  
  1841. <div class="example"><pre>
  1842. RewriteCond %{HTTP_REFERER} <strong>!^$</strong>
  1843. RewriteCond %{HTTP_REFERER} !^http://www.quux-corp.de/~quux/.*$ [NC]
  1844. RewriteRule <strong>.*\.gif$</strong>        -                                    [F]
  1845. </pre></div>
  1846.  
  1847. <div class="example"><pre>
  1848. RewriteCond %{HTTP_REFERER}         !^$
  1849. RewriteCond %{HTTP_REFERER}         !.*/foo-with-gif\.html$
  1850. RewriteRule <strong>^inlined-in-foo\.gif$</strong>   -                        [F]
  1851. </pre></div>
  1852.         </dd>
  1853.       </dl>
  1854.  
  1855.     
  1856.  
  1857.     <h3>Host Deny</h3>
  1858.  
  1859.       
  1860.  
  1861.       <dl>
  1862.         <dt>Description:</dt>
  1863.  
  1864.         <dd>
  1865.           <p>How can we forbid a list of externally configured hosts
  1866.           from using our server?</p>
  1867.         </dd>
  1868.  
  1869.         <dt>Solution:</dt>
  1870.  
  1871.         <dd>
  1872.           <p>For Apache >= 1.3b6:</p>
  1873.  
  1874. <div class="example"><pre>
  1875. RewriteEngine on
  1876. RewriteMap    hosts-deny  txt:/path/to/hosts.deny
  1877. RewriteCond   ${hosts-deny:%{REMOTE_HOST}|NOT-FOUND} !=NOT-FOUND [OR]
  1878. RewriteCond   ${hosts-deny:%{REMOTE_ADDR}|NOT-FOUND} !=NOT-FOUND
  1879. RewriteRule   ^/.*  -  [F]
  1880. </pre></div>
  1881.  
  1882.           <p>For Apache <= 1.3b6:</p>
  1883.  
  1884. <div class="example"><pre>
  1885. RewriteEngine on
  1886. RewriteMap    hosts-deny  txt:/path/to/hosts.deny
  1887. RewriteRule   ^/(.*)$ ${hosts-deny:%{REMOTE_HOST}|NOT-FOUND}/$1
  1888. RewriteRule   !^NOT-FOUND/.* - [F]
  1889. RewriteRule   ^NOT-FOUND/(.*)$ ${hosts-deny:%{REMOTE_ADDR}|NOT-FOUND}/$1
  1890. RewriteRule   !^NOT-FOUND/.* - [F]
  1891. RewriteRule   ^NOT-FOUND/(.*)$ /$1
  1892. </pre></div>
  1893.  
  1894. <div class="example"><pre>
  1895. ##
  1896. ##  hosts.deny
  1897. ##
  1898. ##  ATTENTION! This is a map, not a list, even when we treat it as such.
  1899. ##             mod_rewrite parses it for key/value pairs, so at least a
  1900. ##             dummy value "-" must be present for each entry.
  1901. ##
  1902.  
  1903. 193.102.180.41 -
  1904. bsdti1.sdm.de  -
  1905. 192.76.162.40  -
  1906. </pre></div>
  1907.         </dd>
  1908.       </dl>
  1909.  
  1910.     
  1911.  
  1912.     <h3>Proxy Deny</h3>
  1913.  
  1914.       
  1915.  
  1916.       <dl>
  1917.         <dt>Description:</dt>
  1918.  
  1919.         <dd>
  1920.           <p>How can we forbid a certain host or even a user of a
  1921.           special host from using the Apache proxy?</p>
  1922.         </dd>
  1923.  
  1924.         <dt>Solution:</dt>
  1925.  
  1926.         <dd>
  1927.           <p>We first have to make sure <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>
  1928.           is below(!) <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> in the Configuration
  1929.           file when compiling the Apache webserver. This way it gets
  1930.           called <em>before</em> <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>. Then we
  1931.           configure the following for a host-dependent deny...</p>
  1932.  
  1933. <div class="example"><pre>
  1934. RewriteCond %{REMOTE_HOST} <strong>^badhost\.mydomain\.com$</strong>
  1935. RewriteRule !^http://[^/.]\.mydomain.com.*  - [F]
  1936. </pre></div>
  1937.  
  1938.           <p>...and this one for a user@host-dependent deny:</p>
  1939.  
  1940. <div class="example"><pre>
  1941. RewriteCond %{REMOTE_IDENT}@%{REMOTE_HOST}  <strong>^badguy@badhost\.mydomain\.com$</strong>
  1942. RewriteRule !^http://[^/.]\.mydomain.com.*  - [F]
  1943. </pre></div>
  1944.         </dd>
  1945.       </dl>
  1946.  
  1947.     
  1948.  
  1949.     <h3>Special Authentication Variant</h3>
  1950.  
  1951.       
  1952.  
  1953.       <dl>
  1954.         <dt>Description:</dt>
  1955.  
  1956.         <dd>
  1957.           <p>Sometimes a very special authentication is needed, for
  1958.           instance a authentication which checks for a set of
  1959.           explicitly configured users. Only these should receive
  1960.           access and without explicit prompting (which would occur
  1961.           when using the Basic Auth via <code class="module"><a href="../mod/mod_auth.html">mod_auth</a></code>).</p>
  1962.         </dd>
  1963.  
  1964.         <dt>Solution:</dt>
  1965.  
  1966.         <dd>
  1967.           <p>We use a list of rewrite conditions to exclude all except
  1968.           our friends:</p>
  1969.  
  1970. <div class="example"><pre>
  1971. RewriteCond %{REMOTE_IDENT}@%{REMOTE_HOST} <strong>!^friend1@client1.quux-corp\.com$</strong>
  1972. RewriteCond %{REMOTE_IDENT}@%{REMOTE_HOST} <strong>!^friend2</strong>@client2.quux-corp\.com$
  1973. RewriteCond %{REMOTE_IDENT}@%{REMOTE_HOST} <strong>!^friend3</strong>@client3.quux-corp\.com$
  1974. RewriteRule ^/~quux/only-for-friends/      -                                 [F]
  1975. </pre></div>
  1976.         </dd>
  1977.       </dl>
  1978.  
  1979.     
  1980.  
  1981.     <h3>Referer-based Deflector</h3>
  1982.  
  1983.       
  1984.  
  1985.       <dl>
  1986.         <dt>Description:</dt>
  1987.  
  1988.         <dd>
  1989.           <p>How can we program a flexible URL Deflector which acts
  1990.           on the "Referer" HTTP header and can be configured with as
  1991.           many referring pages as we like?</p>
  1992.         </dd>
  1993.  
  1994.         <dt>Solution:</dt>
  1995.  
  1996.         <dd>
  1997.           <p>Use the following really tricky ruleset...</p>
  1998.  
  1999. <div class="example"><pre>
  2000. RewriteMap  deflector txt:/path/to/deflector.map
  2001.  
  2002. RewriteCond %{HTTP_REFERER} !=""
  2003. RewriteCond ${deflector:%{HTTP_REFERER}} ^-$
  2004. RewriteRule ^.* %{HTTP_REFERER} [R,L]
  2005.  
  2006. RewriteCond %{HTTP_REFERER} !=""
  2007. RewriteCond ${deflector:%{HTTP_REFERER}|NOT-FOUND} !=NOT-FOUND
  2008. RewriteRule ^.* ${deflector:%{HTTP_REFERER}} [R,L]
  2009. </pre></div>
  2010.  
  2011.           <p>... in conjunction with a corresponding rewrite
  2012.           map:</p>
  2013.  
  2014. <div class="example"><pre>
  2015. ##
  2016. ##  deflector.map
  2017. ##
  2018.  
  2019. http://www.badguys.com/bad/index.html    -
  2020. http://www.badguys.com/bad/index2.html   -
  2021. http://www.badguys.com/bad/index3.html   http://somewhere.com/
  2022. </pre></div>
  2023.  
  2024.           <p>This automatically redirects the request back to the
  2025.           referring page (when "<code>-</code>" is used as the value
  2026.           in the map) or to a specific URL (when an URL is specified
  2027.           in the map as the second argument).</p>
  2028.         </dd>
  2029.       </dl>
  2030.  
  2031.     
  2032.  
  2033.   </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  2034. <div class="section">
  2035. <h2><a name="other" id="other">Other</a></h2>
  2036.  
  2037.     
  2038.  
  2039.     <h3>External Rewriting Engine</h3>
  2040.  
  2041.       
  2042.  
  2043.       <dl>
  2044.         <dt>Description:</dt>
  2045.  
  2046.         <dd>
  2047.           <p>A FAQ: How can we solve the FOO/BAR/QUUX/etc.
  2048.           problem? There seems no solution by the use of
  2049.           <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code>...</p>
  2050.         </dd>
  2051.  
  2052.         <dt>Solution:</dt>
  2053.  
  2054.         <dd>
  2055.           <p>Use an external <code class="directive"><a href="../mod/mod_rewrite.html#rewritemap">RewriteMap</a></code>, i.e. a program which acts
  2056.           like a <code class="directive"><a href="../mod/mod_rewrite.html#rewritemap">RewriteMap</a></code>. It is run once on startup of Apache
  2057.           receives the requested URLs on <code>STDIN</code> and has
  2058.           to put the resulting (usually rewritten) URL on
  2059.           <code>STDOUT</code> (same order!).</p>
  2060.  
  2061. <div class="example"><pre>
  2062. RewriteEngine on
  2063. RewriteMap    quux-map       <strong>prg:</strong>/path/to/map.quux.pl
  2064. RewriteRule   ^/~quux/(.*)$  /~quux/<strong>${quux-map:$1}</strong>
  2065. </pre></div>
  2066.  
  2067. <div class="example"><pre>
  2068. #!/path/to/perl
  2069.  
  2070. #   disable buffered I/O which would lead
  2071. #   to deadloops for the Apache server
  2072. $| = 1;
  2073.  
  2074. #   read URLs one per line from stdin and
  2075. #   generate substitution URL on stdout
  2076. while (<>) {
  2077.     s|^foo/|bar/|;
  2078.     print $_;
  2079. }
  2080. </pre></div>
  2081.  
  2082.           <p>This is a demonstration-only example and just rewrites
  2083.           all URLs <code>/~quux/foo/...</code> to
  2084.           <code>/~quux/bar/...</code>. Actually you can program
  2085.           whatever you like. But notice that while such maps can be
  2086.           <strong>used</strong> also by an average user, only the
  2087.           system administrator can <strong>define</strong> it.</p>
  2088.         </dd>
  2089.       </dl>
  2090.  
  2091.     
  2092.  
  2093.   </div></div>
  2094. <div class="bottomlang">
  2095. <p><span>Available Languages: </span><a href="../en/misc/rewriteguide.html" title="English"> en </a></p>
  2096. </div><div id="footer">
  2097. <p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p>
  2098. <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
  2099. </body></html>