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