Apache模块 mod_rewrite · Apache 2.2 中文官方文档

# Apache模块 mod_rewrite | [说明](#calibre_link-11) | 一个基于一定规则的实时重写URL请求的引擎 | | --- | --- | | [状态](#calibre_link-12) | 扩展(E) | | [模块名](#calibre_link-13) | rewrite_module | | [源文件](#calibre_link-14) | mod_rewrite.c | | [兼容性](#calibre_link-58) | 仅在 Apache 1.3 及以后的版本中可用 | ### 概述此模块提供了一个基于正则表达式分析器的重写引擎来实时重写URL请求。它支持每个完整规则可以拥有不限数量的子规则以及附加条件规则的灵活而且强大的URL操作机制。此URL操作可以依赖于各种测试，比如服务器变量、环境变量、HTTP头、时间标记，甚至各种格式的用于匹配URL组成部分的查找数据库。此模块可以操作URL的所有部分(包括路径信息部分)，在服务器级的(`httpd.conf`)和目录级的(`.htaccess`)配置都有效，还可以生成最终请求字符串。此重写操作的结果可以是内部子处理，也可以是外部请求的转向，甚至还可以是内部代理处理。但是，所有这些功能和灵活性带来一个问题，那就是复杂性，因此，不要指望一天之内就能看懂整个模块。更多的讨论、细节、示例，请查看详细的[URL重写文档](#calibre_link-332)。 ## 特殊字符的引用在Apache 1.3.20中，_TestString_和_Substitution_中的特殊字符可以用前导斜杠(\)来实现转义(即忽略其特殊含义而视之为普通字符)。比如，_Substitution_可以用"`\$`"来包含一个美元符号，以避免mod_rewrite把它视为反向引用。 ## 环境变量此模块会跟踪两个额外的(非标准)CGI/SSI环境变量，`SCRIPT_URL`和`SCRIPT_URI`。他们包含了当前资源的_逻辑_网络视图，而标准CGI/SSI变量`SCRIPT_NAME`和`SCRIPT_FILENAME`包含的是_物理_系统视图。注意：这些变量保持的是_其最初被请求时的_URI/URL，即在任何重写操作_之前_的URI/URL。其重要性在于他们是重写操作重写URL到物理路径名的原始依据。 ### 示例 ``` SCRIPT_NAME=/sw/lib/w3s/tree/global/u/rse/.www/index.html SCRIPT_FILENAME=/u/rse/.www/index.html SCRIPT_URL=/u/rse/ SCRIPT_URI=http://en1.engelschall.com/u/rse/ ``` ## 实用方案我们提供了[URL重写指南](#calibre_link-483)和[高级URL重写指南](#calibre_link-484)文档，列举了许多基于URL的问题的实用方案，其中你可以找到真实有用的规则集。 ## RewriteBase 指令 | [说明](#calibre_link-18) | 设置目录级重写的基准URL | | --- | --- | | [语法](#calibre_link-19) | `RewriteBase _URL-path_` | | [默认值](#calibre_link-24) | `参见使用方法` | | [作用域](#calibre_link-20) | directory, .htaccess | | [覆盖项](#calibre_link-66) | FileInfo | | [状态](#calibre_link-21) | 扩展(E) | | [模块](#calibre_link-22) | mod_rewrite | `RewriteBase`指令显式地设置了目录级重写的基准URL。在下文中，你可以看见`RewriteRule`可以用于目录级的配置文件中(`.htaccess`)并在局部范围内起作用，即规则实际处理的只是剥离了本地路径前缀的一部分。处理结束后，这个路径会被自动地附着回去。默认值是"`RewriteBase` _physical-directory-path_"。在对一个新的URL进行替换时，此模块必须把这个URL重新注入到服务器处理中。为此，它必须知道其对应的URL前缀或者说URL基准。通常，此前缀就是对应的文件路径。**但是，大多数网站URL不是直接对应于其物理文件路径的，因而一般不能做这样的假定!** 所以在这种情况下，就必须用`RewriteBase`指令来指定正确的URL前缀。如果你的网站服务器URL**不是**与物理文件路径直接对应的，而又需要使用`RewriteBase`指令，则必须在每个对应的`.htaccess`文件中指定`RewriteRule` 。例如，目录级配置文件内容如下： ``` # # /abc/def/.htaccess -- per-dir config file for directory /abc/def # Remember: /abc/def is the physical path of /xyz, _i.e._, the server # has a 'Alias /xyz /abc/def' directive 例如， # RewriteEngine On # let the server know that we were reached via /xyz and not # via the physical path prefix /abc/def RewriteBase /xyz # now the rewriting rules RewriteRule ^oldstuff\.html$ newstuff.html ``` 上述例子中，对`/xyz/oldstuff.html`的请求被正确地重写为物理的文件`/abc/def/newstuff.html` 。 ### For Apache Hackers 以下列出了内部处理的详细步骤： ``` Request: /xyz/oldstuff.html Internal Processing: /xyz/oldstuff.html -> /abc/def/oldstuff.html (per-server Alias) /abc/def/oldstuff.html -> /abc/def/newstuff.html (per-dir RewriteRule) /abc/def/newstuff.html -> /xyz/newstuff.html (per-dir RewriteBase) /xyz/newstuff.html -> /abc/def/newstuff.html (per-server Alias) Result: /abc/def/newstuff.html ``` 虽然这个过程看来很繁复，但是由于目录级重写的到来时机已经太晚了，它不得不把这个(重写)请求重新注入到Apache核心中，所以Apache内部确实是这样处理的。但是：它的开销并不象看起来的那样大，因为重新注入完全在Apache服务器内部进行，而且这样的过程在Apache内部也为其他许多操作所使用。所以，你可以充分信任其设计和实现是正确的。 ## RewriteCond 指令 | [说明](#calibre_link-18) | 定义重写发生的条件 | | --- | --- | | [语法](#calibre_link-19) | `RewriteCond _TestString_ _CondPattern_` | | [作用域](#calibre_link-20) | server config, virtual host, directory, .htaccess | | [覆盖项](#calibre_link-66) | FileInfo | | [状态](#calibre_link-21) | 扩展(E) | | [模块](#calibre_link-22) | mod_rewrite | `RewriteCond`指令定义了一个规则的条件，即在一个`RewriteRule`指令之前有一个或多个`RewriteCond`指令。条件之后的重写规则仅在当前URI与pattern匹配**并且**符合这些条件的时候才会起作用。 _TestString_是一个纯文本的字符串，但是还可以包含下列可扩展的成分： * **RewriteRule反向引用** ，引用方法是： **`$N`** (0 <= N <= 9)引用当前(带有若干`RewriteRule`指令的)`RewriteCond`中的与pattern匹配的分组成分(圆括号!)。 * **RewriteCond反向引用** ，引用方法是： **`%N`** (1 <= N <= 9)引用当前若干`RewriteCond`条件中最后符合的条件中的分组成分(圆括号!)。 * **RewriteMap扩展** ，引用方法是： **`${mapname:key|default}`** 细节请参见[RewriteMap 指令](#calibre_link-485)。 * **服务器变量** ，引用方法是： **`%{` _NAME_OF_VARIABLE_ `}`** _NAME_OF_VARIABLE_可以是下表列出的字符串之一： <table> <thead> <tr> <th>HTTP headers:</th> <th>connection & request:</th> </tr> </thead> <tbody><tr> <td>HTTP_USER_AGENT HTTP_REFERER HTTP_COOKIE HTTP_FORWARDED HTTP_HOST HTTP_PROXY_CONNECTION HTTP_ACCEPT</td> <td>REMOTE_ADDR REMOTE_HOST REMOTE_PORT REMOTE_USER REMOTE_IDENT REQUEST_METHOD SCRIPT_FILENAME PATH_INFO QUERY_STRING AUTH_TYPE</td> </tr> </tbody></table> <table> <thead> <tr> <th>server internals:</th> <th>date and time:</th> <th>specials:</th> </tr> </thead> <tbody><tr> <td>DOCUMENT_ROOT SERVER_ADMIN SERVER_NAME SERVER_ADDR SERVER_PORT SERVER_PROTOCOL SERVER_SOFTWARE</td> <td>TIME_YEAR TIME_MON TIME_DAYTIME_HOUR TIME_MINTIME_SEC TIME_WDAY TIME</td> <td>API_VERSION THE_REQUEST REQUEST_URI REQUEST_FILENAME IS_SUBREQ HTTPS</td> </tr> </tbody></table> These variables all correspond to the similarly named HTTP MIME-headers, C variables of the Apache server or `struct tm` fields of the Unix system. Most are documented elsewhere in the Manual or in the CGI specification. Those that are special to mod_rewrite include: `IS_SUBREQ` Will contain the text "true" if the request currently being processed is a sub-request, "false" otherwise. Sub-requests may be generated by modules that need to resolve additional files or URIs in order to complete their tasks. `API_VERSION` This is the version of the Apache module API (the internal interface between server and module) in the current httpd build, as defined in include/ap_mmn.h. The module API version corresponds to the version of Apache in use (in the release version of Apache 1.3.14, for instance, it is 19990320:10), but is mainly of interest to module authors. `THE_REQUEST` The full HTTP request line sent by the browser to the server (e.g., "`GET /index.html HTTP/1.1`"). This does not include any additional headers sent by the browser. `REQUEST_URI` The resource requested in the HTTP request line. (In the example above, this would be "/index.html".) `REQUEST_FILENAME` The full local filesystem path to the file or script matching the request. `HTTPS` Will contain the text "on" if the connection is using SSL/TLS, or "off" otherwise. (This variable can be safely used regardless of whether `mod_ssl` is loaded). Special Notes: 1. The variables SCRIPT_FILENAME and REQUEST_FILENAME contain the same value, _i.e._, the value of the `filename` field of the internal `request_rec` structure of the Apache server. The first name is just the commonly known CGI variable name while the second is the consistent counterpart to REQUEST_URI (which contains the value of the `uri` field of `request_rec`). 2. There is the special format: `%{ENV:variable}` where _variable_ can be any environment variable. This is looked-up via internal Apache structures and (if not found there) via `getenv()` from the Apache server process. 3. There is the special format: `%{SSL:variable}` where _variable_ is the name of an [SSL environment variable](#calibre_link-486); this can be used whether or not `mod_ssl` is loaded, but will always expand to the empty string if it is not. Example: `%{SSL:SSL_CIPHER_USEKEYSIZE}` may expand to `128`. 4. There is the special format: `%{HTTP:header}` where _header_ can be any HTTP MIME-header name. This is looked-up from the HTTP request. Example: `%{HTTP:Proxy-Connection}` is the value of the HTTP header "`Proxy-Connection:`". 5. There is the special format `%{LA-U:variable}` for look-aheads which perform an internal (URL-based) sub-request to determine the final value of _variable_. Use this when you want to use a variable for rewriting which is actually set later in an API phase and thus is not available at the current stage. For instance when you want to rewrite according to the `REMOTE_USER` variable from within the per-server context (`httpd.conf` file) you have to use `%{LA-U:REMOTE_USER}` because this variable is set by the authorization phases which come _after_ the URL translation phase where mod_rewrite operates. On the other hand, because mod_rewrite implements its per-directory context (`.htaccess` file) via the Fixup phase of the API and because the authorization phases come _before_ this phase, you just can use `%{REMOTE_USER}` there. 6. There is the special format: `%{LA-F:variable}` which performs an internal (filename-based) sub-request to determine the final value of _variable_. Most of the time this is the same as LA-U above. _CondPattern_ is the condition pattern, _i.e._, a regular expression which is applied to the current instance of the _TestString_, _i.e._, _TestString_ is evaluated and then matched against _CondPattern_. **Remember:** _CondPattern_ is a _perl compatible regular expression_ with some additions: 1. You can prefix the pattern string with a '`!`' character (exclamation mark) to specify a **non**-matching pattern. 2. There are some special variants of _CondPatterns_. Instead of real regular expression strings you can also use one of the following: * '**<CondPattern**' (is lexically lower) Treats the _CondPattern_ as a plain string and compares it lexically to _TestString_. True if _TestString_ is lexically lower than _CondPattern_. * '**>CondPattern**' (is lexically greater) Treats the _CondPattern_ as a plain string and compares it lexically to _TestString_. True if _TestString_ is lexically greater than _CondPattern_. * '**=CondPattern**' (is lexically equal) Treats the _CondPattern_ as a plain string and compares it lexically to _TestString_. True if _TestString_ is lexically equal to _CondPattern_, i.e the two strings are exactly equal (character by character). If _CondPattern_ is just `""` (two quotation marks) this compares _TestString_ to the empty string. * '**-d**' (is **d**irectory) Treats the _TestString_ as a pathname and tests if it exists and is a directory. * '**-f**' (is regular **f**ile) Treats the _TestString_ as a pathname and tests if it exists and is a regular file. * '**-s**' (is regular file with **s**ize) Treats the _TestString_ as a pathname and tests if it exists and is a regular file with size greater than zero. * '**-l**' (is symbolic **l**ink) Treats the _TestString_ as a pathname and tests if it exists and is a symbolic link. * '**-x**' (has e**x**ecutable permissions) Treats the _TestString_ as a pathname and tests if it exists and has execution permissions. These permissions are determined depending on the underlying OS. * '**-F**' (is existing file via subrequest) Checks if _TestString_ is a valid file and accessible via all the server's currently-configured access controls for that path. This uses an internal subrequest to determine the check, so use it with care because it decreases your servers performance! * '**-U**' (is existing URL via subrequest) Checks if _TestString_ is a valid URL and accessible via all the server's currently-configured access controls for that path. This uses an internal subrequest to determine the check, so use it with care because it decreases your server's performance! ### Notice All of these tests can also be prefixed by an exclamation mark ('!') to negate their meaning. Additionally you can set special flags for _CondPattern_ by appending **`[`_flags_`]`** as the third argument to the `RewriteCond` directive. _Flags_ is a comma-separated list of the following flags: * '**`nocase|NC`**' (**n**o **c**ase) This makes the test case-insensitive, _i.e._, there is no difference between 'A-Z' and 'a-z' both in the expanded _TestString_ and the _CondPattern_. This flag is effective only for comparisons between _TestString_和_CondPattern_. It has no effect on filesystem and subrequest checks. * '**`ornext|OR`**' (**或** next condition) Use this to combine rule conditions with a local OR instead of the implicit AND. Typical example: ``` RewriteCond %{REMOTE_HOST} ^host1.* [OR] RewriteCond %{REMOTE_HOST} ^host2.* [OR] RewriteCond %{REMOTE_HOST} ^host3.* RewriteRule ...some special stuff for any of these hosts... ``` Without this flag you would have to write the cond/rule three times. **Example:** To rewrite the Homepage of a site according to the "`User-Agent:`" header of the request, you can use the following: ``` RewriteCond %{HTTP_USER_AGENT} ^Mozilla.* RewriteRule ^/$ /homepage.max.html [L] RewriteCond %{HTTP_USER_AGENT} ^Lynx.* RewriteRule ^/$ /homepage.min.html [L] RewriteRule ^/$ /homepage.std.html [L] ``` Interpretation: If you use Netscape Navigator as your browser (which identifies itself as 'Mozilla'), then you get the max homepage, which includes Frames, _etc._ If you use the Lynx browser (which is Terminal-based), then you get the min homepage, which contains no images, no tables, _etc._ If you use any other browser you get the standard homepage. ## RewriteEngine 指令 | [说明](#calibre_link-18) | Enables or disables runtime rewriting engine | | --- | --- | | [语法](#calibre_link-19) | `RewriteEngine on|off` | | [默认值](#calibre_link-24) | `RewriteEngine off` | | [作用域](#calibre_link-20) | server config, virtual host, directory, .htaccess | | [覆盖项](#calibre_link-66) | FileInfo | | [状态](#calibre_link-21) | 扩展(E) | | [模块](#calibre_link-22) | mod_rewrite | `RewriteEngine` directive enables or disables the runtime rewriting engine. If it is set to `off` this module does no runtime processing at all. It does not even update the `SCRIPT_URx` environment variables. Use this directive to disable the module instead of commenting out all the `RewriteRule` directives! Note that, by default, rewrite configurations are not inherited. This means that you need to have a `RewriteEngine on` directive for each virtual host in which you wish to use it. ## RewriteLock 指令 | [说明](#calibre_link-18) | Sets the name of the lock file used for `RewriteMap` synchronization | | --- | --- | | [语法](#calibre_link-19) | `RewriteLock _file-path_` | | [作用域](#calibre_link-20) | server config | | [状态](#calibre_link-21) | 扩展(E) | | [模块](#calibre_link-22) | mod_rewrite | This directive sets the filename for a synchronization lockfile which mod_rewrite needs to communicate with `RewriteMap` _programs_. Set this lockfile to a local path (not on a NFS-mounted device) when you want to use a rewriting map-program. It is not required for other types of rewriting maps. ## RewriteLog 指令 | [说明](#calibre_link-18) | Sets the name of the file used for logging rewrite engine processing | | --- | --- | | [语法](#calibre_link-19) | `RewriteLog _file-path_` | | [作用域](#calibre_link-20) | server config, virtual host | | [状态](#calibre_link-21) | 扩展(E) | | [模块](#calibre_link-22) | mod_rewrite | `RewriteLog` directive sets the name of the file to which the server logs any rewriting actions it performs. If the name does not begin with a slash ('`/`') then it is assumed to be relative to the _Server Root_. The directive should occur only once per server config. To disable the logging of rewriting actions it is not recommended to set _Filename_ to `/dev/null`, because although the rewriting engine does not then output to a logfile it still creates the logfile output internally. **This will slow down the server with no advantage to the administrator!** To disable logging either remove or comment out the `RewriteLog` directive or use `RewriteLogLevel 0`! ### 安全 See the [Apache Security Tips](#calibre_link-263) document for details on why your security could be compromised if the directory where logfiles are stored is writable by anyone other than the user that starts the server. ### 示例 ``` RewriteLog "/usr/local/var/apache/logs/rewrite.log" ``` ## RewriteLogLevel 指令 | [说明](#calibre_link-18) | Sets the verbosity of the log file used by the rewrite engine | | --- | --- | | [语法](#calibre_link-19) | `RewriteLogLevel _Level_` | | [默认值](#calibre_link-24) | `RewriteLogLevel 0` | | [作用域](#calibre_link-20) | server config, virtual host | | [状态](#calibre_link-21) | 扩展(E) | | [模块](#calibre_link-22) | mod_rewrite | `RewriteLogLevel` directive sets the verbosity level of the rewriting logfile. The default level 0 means no logging, while 9 or more means that practically all actions are logged. To disable the logging of rewriting actions simply set _Level_ to 0\. This disables all rewrite action logs. Using a high value for _Level_ will slow down your Apache server dramatically! Use the rewriting logfile at a _Level_ greater than 2 only for debugging! ### 示例 ``` RewriteLogLevel 3 ``` ## RewriteMap 指令 | [说明](#calibre_link-18) | Defines a mapping function for key-lookup | | --- | --- | | [语法](#calibre_link-19) | `RewriteMap _MapName_ _MapType_:_MapSource_` | | [作用域](#calibre_link-20) | server config, virtual host | | [状态](#calibre_link-21) | 扩展(E) | | [模块](#calibre_link-22) | mod_rewrite | | [兼容性](#calibre_link-137) | The choice of different dbm types is available in Apache 2.0.41 及以后的版本中可用 | `RewriteMap` directive defines a _Rewriting Map_ which can be used inside rule substitution strings by the mapping-functions to insert/substitute fields through a key lookup. The source of this lookup can be of various types. _MapName_ is the name of the map and will be used to specify a mapping-function for the substitution strings of a rewriting rule via one of the following constructs: **`${` _MapName_ `:` _LookupKey_ `}` `${` _MapName_ `:` _LookupKey_ `|` _DefaultValue_ `}`** When such a construct occurs the map _MapName_ is consulted and the key _LookupKey_ is looked-up. If the key is found, the map-function construct is substituted by _SubstValue_. If the key is not found then it is substituted by _DefaultValue_ or by the empty string if no _DefaultValue_ was specified. For example, you might define a `RewriteMap` as: ``` RewriteMap examplemap txt:/path/to/file/map.txt ``` You would then be able to use this map in a `RewriteRule` as follows: ``` RewriteRule ^/ex/(.*) ${examplemap:$1} ``` The following combinations for _MapType_和_MapSource_ can be used: * **Standard Plain Text** MapType: `txt`, MapSource: Unix filesystem path to valid regular file This is the standard rewriting map feature where the _MapSource_ is a plain ASCII file containing either blank lines, comment lines (starting with a '#' character) or pairs like the following - one per line. **_MatchingKey_ _SubstValue_** ### 示例 ``` ## ## map.txt -- rewriting map ## Ralf.S.Engelschall rse # Bastard Operator From Hell Mr.Joe.Average joe # Mr. Average ``` ``` RewriteMap real-to-user txt:/path/to/file/map.txt ``` * **Randomized Plain Text** MapType: `rnd`, MapSource: Unix filesystem path to valid regular file This is identical to the Standard Plain Text variant above but with a special post-processing feature: After looking up a value it is parsed according to contained "`|`" characters which have the meaning of "or". In other words they indicate a set of alternatives from which the actual returned value is chosen randomly. For example, you might use the following map file and directives to provide a random load balancing between several back-end server, via a reverse-proxy. Images are sent to one of the servers in the 'static' pool, while everything else is sent to one of the 'dynamic' pool. Example: ### Rewrite map file ``` ## ## map.txt -- rewriting map ## static www1|www2|www3|www4 dynamic www5|www6 ``` ### Configuration directives ``` RewriteMap servers rnd:/path/to/file/map.txt RewriteRule ^/(.*\.(png|gif|jpg)) http://${servers:static}/$1 [NC,P,L] RewriteRule ^/(.*) http://${servers:dynamic}/$1 [P,L] ``` * **Hash File** MapType: `dbm[=_type_]`, MapSource: Unix filesystem path to valid regular file Here the source is a binary format DBM file containing the same contents as a _Plain Text_ format file, but in a special representation which is optimized for really fast lookups. The _type_ can be sdbm, gdbm, ndbm, or db depending on [compile-time settings](#calibre_link-487). If the _type_ is omitted, the compile-time default will be chosen. You can create such a file with any DBM tool or with the following Perl script. Be sure to adjust it to create the appropriate type of DBM. The example creates an NDBM file. ``` #!/path/to/bin/perl ## ## txt2dbm -- convert txt map to dbm format ## use NDBM_File; use Fcntl; ($txtmap, $dbmmap) = @ARGV; open(TXT, "<$txtmap") or die "Couldn't open $txtmap!\n"; tie (%DB, 'NDBM_File', $dbmmap,O_RDWR|O_TRUNC|O_CREAT, 0644) or die "Couldn't create $dbmmap!\n"; while (<TXT>) { next if (/^\s*#/ or /^\s*$/); $DB{$1} = $2 if (/^\s*(\S+)\s+(\S+)/); } untie %DB; close(TXT); ``` ``` $ txt2dbm map.txt map.db ``` * **Internal Function** MapType: `int`, MapSource: Internal Apache function Here the source is an internal Apache function. Currently you cannot create your own, but the following functions already exists: * **toupper**: Converts the looked up key to all upper case. * **tolower**: Converts the looked up key to all lower case. * **escape**: Translates special characters in the looked up key to hex-encodings. * **unescape**: Translates hex-encodings in the looked up key back to special characters. * **External Rewriting Program** MapType: `prg`, MapSource: Unix filesystem path to valid regular file Here the source is a program, not a map file. To create it you can use the language of your choice, but the result has to be a executable (_i.e._, either object-code or a script with the magic cookie trick '`#!/path/to/interpreter`' as the first line). This program is started once at startup of the Apache servers and then communicates with the rewriting engine over its `stdin`和`stdout` file-handles. For each map-function lookup it will receive the key to lookup as a newline-terminated string on `stdin`. It then has to give back the looked-up value as a newline-terminated string on `stdout` or the four-character string "`NULL`" if it fails (_i.e._, there is no corresponding value for the given key). A trivial program which will implement a 1:1 map (_i.e._, key == value) could be: ``` #!/usr/bin/perl $| = 1; while (<STDIN>) { # ...put here any transformations or lookups... print $_; } ``` But be very careful: 1. "_Keep it simple, stupid_" (KISS), because if this program hangs it will hang the Apache server when the rule occurs. 2. Avoid one common mistake: never do buffered I/O on `stdout`! This will cause a deadloop! Hence the "`$|=1`" in the above example... 3. Use the `RewriteLock` directive to define a lockfile mod_rewrite can use to synchronize the communication to the program. By default no such synchronization takes place. `RewriteMap` directive can occur more than once. For each mapping-function use one `RewriteMap` directive to declare its rewriting mapfile. While you cannot **declare** a map in per-directory context it is of course possible to **use** this map in per-directory context. ### 注意 For plain text and DBM format files the looked-up keys are cached in-core until the `mtime` of the mapfile changes or the server does a restart. This way you can have map-functions in rules which are used for **every** request. This is no problem, because the external lookup only happens once! ## RewriteOptions 指令 | [说明](#calibre_link-18) | Sets some special options for the rewrite engine | | --- | --- | | [语法](#calibre_link-19) | `RewriteOptions Options` | | [作用域](#calibre_link-20) | server config, virtual host, directory, .htaccess | | [覆盖项](#calibre_link-66) | FileInfo | | [状态](#calibre_link-21) | 扩展(E) | | [模块](#calibre_link-22) | mod_rewrite | | [兼容性](#calibre_link-137) | `MaxRedirects` is no longer available in version 2.1 及以后的版本中可用 | `RewriteOptions` directive sets some special options for the current per-server or per-directory configuration. The _Option_ string can be currently only one: `inherit` This forces the current configuration to inherit the configuration of the parent. In per-virtual-server context this means that the maps, conditions and rules of the main server are inherited. In per-directory context this means that conditions and rules of the parent directory's `.htaccess` configuration are inherited. ## RewriteRule 指令 | [说明](#calibre_link-18) | Defines rules for the rewriting engine | | --- | --- | | [语法](#calibre_link-19) | `RewriteRule _Pattern_ _Substitution_` | | [作用域](#calibre_link-20) | server config, virtual host, directory, .htaccess | | [覆盖项](#calibre_link-66) | FileInfo | | [状态](#calibre_link-21) | 扩展(E) | | [模块](#calibre_link-22) | mod_rewrite | | [兼容性](#calibre_link-137) | The cookie-flag is available in Apache 2.0.40 及以后的版本中可用 | `RewriteRule` directive is the real rewriting workhorse. The directive can occur more than once. Each directive then defines one single rewriting rule. The **definition order** of these rules is **important**, because this order is used when applying the rules at run-time. _Pattern_ is a perl compatible regular expression which gets applied to the current URL. Here "current" means the value of the URL when this rule gets applied. This may not be the originally requested URL, because any number of rules may already have matched and made alterations to it. Some hints about the syntax of [regular expressions](#calibre_link-67 "see glossary"): ``` **Text:** **`.`** Any single character **`[`**chars**`]`** Character class: One of chars **`[^`**chars**`]`** Character class: None of chars text1**`|`**text2 Alternative: text1 or text2 **Quantifiers:** **`?`** 0 or 1 of the preceding text **`*`** 0 or N of the preceding text (N > 0) **`+`** 1 or N of the preceding text (N > 1) **Grouping:** **`(`**text**`)`** Grouping of text (either to set the borders of an alternative or for making backreferences where the **N**th group can be used on the RHS of a RewriteRule with $**N**) **Anchors:** **`^`** Start of line anchor **`$`** End of line anchor **Escaping:** **`\`**char escape that particular char (for instance to specify the chars ".[]()" _etc._) ``` For more information about regular expressions have a look at the perl regular expression manpage ("[perldoc perlre](http://www.perldoc.com/perl5.6.1/pod/perlre.html)"). If you are interested in more detailed information about regular expressions and their variants (POSIX regex _etc._) have a look at the following dedicated book on this topic: _Mastering Regular Expressions, 2nd Edition_ Jeffrey E.F. Friedl O'Reilly & Associates, Inc. 2002 ISBN 0-596-00289-0 Additionally in mod_rewrite the NOT character ('`!`') is a possible pattern prefix. This gives you the ability to negate a pattern; to say, for instance: "_if the current URL does **NOT** match this pattern_". This can be used for exceptional cases, where it is easier to match the negative pattern, or as a last default rule. ### Notice When using the NOT character to negate a pattern you cannot have grouped wildcard parts in the pattern. This is impossible because when the pattern does NOT match, there are no contents for the groups. In consequence, if negated patterns are used, you cannot use `$N` in the substitution string! _Substitution_ of a rewriting rule is the string which is substituted for (or replaces) the original URL for which _Pattern_ matched. Beside plain text you can use 1. back-references `$N` to the RewriteRule pattern 2. back-references `%N` to the last matched RewriteCond pattern 3. server-variables as in rule condition test-strings (`%{VARNAME}`) 4. [mapping-function](#calibre_link-485) calls (`${mapname:key|default}`) Back-references are `$`**N** (**N**=0..9) identifiers which will be replaced by the contents of the **N**th group of the matched _Pattern_. The server-variables are the same as for the _TestString_ of a `RewriteCond` directive. The mapping-functions come from the `RewriteMap` directive and are explained there. These three types of variables are expanded in the order of the above list. As already mentioned above, all the rewriting rules are applied to the _Substitution_ (in the order of definition in the config file). The URL is **completely replaced** by the _Substitution_ and the rewriting process goes on until there are no more rules unless explicitly terminated by a `**L**` flag - see below. There is a special substitution string named '`-`' which means: **NO substitution**! Sounds silly? No, it is useful to provide rewriting rules which **only** match some URLs but do no substitution, 例如，in conjunction with the **C** (chain) flag to be able to have more than one pattern to be applied before a substitution occurs. ### Query String _Pattern_ will not match against the query string. Instead, you must use a `RewriteCond` with the `%{QUERY_STRING}` variable. You can, however, create URLs in the substitution string containing a query string part. Just use a question mark inside the substitution string to indicate that the following stuff should be re-injected into the query string. When you want to erase an existing query string, end the substitution string with just the question mark. To combine a new query string with an old one, use the `[QSA]` flag (see below). ### Substitution of Absolute URLs There is a special feature: When you prefix a substitution field with `http://`_thishost_[_:thisport_] then **mod_rewrite** automatically strips it out. This auto-reduction on implicit external redirect URLs is a useful and important feature when used in combination with a mapping-function which generates the hostname part. Have a look at the first example in the example section below to understand this. **Remember:** An unconditional external redirect to your own server will not work with the prefix `http://thishost` because of this feature. To achieve such a self-redirect, you have to use the **R**-flag (see below). Additionally you can set special flags for _Substitution_ by appending **`[`_flags_`]`** as the third argument to the `RewriteRule` directive. _Flags_ is a comma-separated list of the following flags: * '**`chain|C`**' (**c**hained with next rule) This flag chains the current rule with the next rule (which itself can be chained with the following rule, _etc._). This has the following effect: if a rule matches, then processing continues as usual, _i.e._, the flag has no effect. If the rule does **not** match, then all following chained rules are skipped. For instance, use it to remove the "`.www`" part inside a per-directory rule set when you let an external redirect happen (where the "`.www`" part should not to occur!). * '**`cookie|CO=`**_NAME_:_VAL_:_domain_[:_lifetime_[:_path_]]' (set **co**okie) This sets a cookie on the client's browser. The cookie's name is specified by _NAME_ and the value is _VAL_. The _domain_ field is the domain of the cookie, such as '.apache.org',the optional _lifetime_ is the lifetime of the cookie in minutes, and the optional _path_ is the path of the cookie * '**`env|E=`**_VAR_:_VAL_' (set **e**nvironment variable) This forces an environment variable named _VAR_ to be set to the value _VAL_, where _VAL_ can contain regexp backreferences `$N`和`%N` which will be expanded. You can use this flag more than once to set more than one variable. The variables can be later dereferenced in many situations, but usually from within XSSI (via ``) or CGI (例如， `$ENV{'VAR'}`). Additionally you can dereference it in a following RewriteCond pattern via `%{ENV:VAR}`. Use this to strip but remember information from URLs. * '**`forbidden|F`**' (force URL to be **f**orbidden) This forces the current URL to be forbidden, _i.e._, it immediately sends back a HTTP response of 403 (FORBIDDEN). Use this flag in conjunction with appropriate RewriteConds to conditionally block some URLs. * '**`gone|G`**' (force URL to be **g**one) This forces the current URL to be gone, _i.e._, it immediately sends back a HTTP response of 410 (GONE). Use this flag to mark pages which no longer exist as gone. * '**`handler|H`**=_Content-handler_' (force Content **h**andler) Force the Content-handler of the target file to be _Content-handler_. For instance, this can be used to simulate the `mod_alias` directive `ScriptAlias` which internally forces all files inside the mapped directory to have a handler of "`cgi-script`". * '**`last|L`**' (**l**ast rule) Stop the rewriting process here and don't apply any more rewriting rules. This corresponds to the Perl `last` command or the `break` command from the C language. Use this flag to prevent the currently rewritten URL from being rewritten further by following rules. For example, use it to rewrite the root-path URL ('`/`') to a real one, 例如，'`/e/www/`'. * '**`next|N`**' (**n**ext round) Re-run the rewriting process (starting again with the first rewriting rule). Here the URL to match is again not the original URL but the URL from the last rewriting rule. This corresponds to the Perl `next` command or the `continue` command from the C language. Use this flag to restart the rewriting process, _i.e._, to immediately go to the top of the loop. **But be careful not to create an infinite loop!** * '**`nocase|NC`**' (**n**o **c**ase) This makes the _Pattern_ case-insensitive, _i.e._, there is no difference between 'A-Z' and 'a-z' when _Pattern_ is matched against the current URL. * '**`noescape|NE`**' (**n**o URI **e**scaping of output) This flag keeps mod_rewrite from applying the usual URI escaping rules to the result of a rewrite. Ordinarily, special characters (such as '%', '$', ';', and so on) will be escaped into their hexcode equivalents ('%25', '%24', and '%3B', respectively); this flag prevents this from being done. This allows percent symbols to appear in the output, as in ``` RewriteRule /foo/(.*) /bar?arg=P1\%3d$1 [R,NE] ``` which would turn '`/foo/zed`' into a safe request for '`/bar?arg=P1=zed`'. * '**`nosubreq|NS`**' (used only if **n**o internal **s**ub-request) This flag forces the rewriting engine to skip a rewriting rule if the current request is an internal sub-request. For instance, sub-requests occur internally in Apache when `mod_include` tries to find out information about possible directory default files (`index.xxx`). On sub-requests it is not always useful and even sometimes causes a failure to if the complete set of rules are applied. Use this flag to exclude some rules. Use the following rule for your decision: whenever you prefix some URLs with CGI-scripts to force them to be processed by the CGI-script, the chance is high that you will run into problems (or even overhead) on sub-requests. In these cases, use this flag. * '**`proxy|P`**' (force **p**roxy) This flag forces the substitution part to be internally forced as a proxy request and immediately (_i.e._, rewriting rule processing stops here) put through the [proxy module](#calibre_link-121). You have to make sure that the substitution string is a valid URI (例如，typically starting with `http://`_hostname_) which can be handled by the Apache proxy module. If not you get an error from the proxy module. Use this flag to achieve a more powerful implementation of the [ProxyPass](#calibre_link-411) directive, to map some remote stuff into the namespace of the local server. 注意：`mod_proxy` must be enabled in order to use this flag. * '**`passthrough|PT`**' (**p**ass **t**hrough to next handler) This flag forces the rewriting engine to set the `uri` field of the internal `request_rec` structure to the value of the `filename` field. This flag is just a hack to be able to post-process the output of `RewriteRule` directives by `Alias`, `ScriptAlias`, `Redirect`, _etc._ directives from other URI-to-filename translators. A trivial example to show the semantics: If you want to rewrite `/abc` to `/def` via the rewriting engine of `mod_rewrite` and then `/def` to `/ghi` with `mod_alias`: ``` RewriteRule ^/abc(.*) /def$1 [PT] Alias /def /ghi ``` If you omit the `PT` flag then `mod_rewrite` will do its job fine, _i.e._, it rewrites `uri=/abc/...` to `filename=/def/...` as a full API-compliant URI-to-filename translator should do. Then `mod_alias` comes and tries to do a URI-to-filename transition which will not work. Note: **You have to use this flag if you want to intermix directives of different modules which contain URL-to-filename translators**. The typical example is the use of `mod_alias`和`mod_rewrite`.. * '**`qsappend|QSA`**' (**q**uery **s**tring **a**ppend) This flag forces the rewriting engine to append a query string part in the substitution string to the existing one instead of replacing it. Use this when you want to add more data to the query string via a rewrite rule. * '**`redirect|R` [=_code_]**' (force **r**edirect) Prefix _Substitution_ with `http://thishost[:thisport]/` (which makes the new URL a URI) to force a external redirection. If no _code_ is given a HTTP response of 302 (MOVED TEMPORARILY) is used. If you want to use other response codes in the range 300-400 just specify them as a number or use one of the following symbolic names: `temp` (default), `permanent`, `seeother`. Use it for rules which should canonicalize the URL and give it back to the client, 例如，translate "`/~`" into "`/u/`" or always append a slash to `/u/`_user_, etc. **Note:** When you use this flag, make sure that the substitution field is a valid URL! If not, you are redirecting to an invalid location! And remember that this flag itself only prefixes the URL with `http://thishost[:thisport]/`, rewriting continues. Usually you also want to stop and do the redirection immediately. To stop the rewriting you also have to provide the 'L' flag. * '**`skip|S`**=_num_' (**s**kip next rule(s)) This flag forces the rewriting engine to skip the next _num_ rules in sequence when the current rule matches. Use this to make pseudo if-then-else constructs: The last rule of the then-clause becomes `skip=N` where N is the number of rules in the else-clause. (This is **not** the same as the 'chain|C' flag!) * '**`type|T`**=_MIME-type_' (force MIME **t**ype) Force the [MIME-type](#calibre_link-223 "see glossary") of the target file to be _MIME-type_. For instance, this can be used to setup the content-type based on some conditions. For example, the following snippet allows `.php` files to be _displayed_ by `mod_php` if they are called with the `.phps` extension: ``` RewriteRule ^(.+\.php)s$ $1 [T=application/x-httpd-php-source] ``` ### 注意 Never forget that _Pattern_ is applied to a complete URL in per-server configuration files. **But in per-directory configuration files, the per-directory prefix (which always is the same for a specific directory!) is automatically _removed_ for the pattern matching and automatically _added_ after the substitution has been done.** This feature is essential for many sorts of rewriting, because without this prefix stripping you have to match the parent directory which is not always possible. There is one exception: If a substitution string starts with "`http://`" then the directory prefix will **not** be added and an external redirect or proxy throughput (if flag **P** is used!) is forced! ### 注意 To enable the rewriting engine for per-directory configuration files you need to set "`RewriteEngine On`" in these files **和** "`Options FollowSymLinks`" must be enabled. If your administrator has disabled override of `FollowSymLinks` for a user's directory, then you cannot use the rewriting engine. This restriction is needed for security reasons. Here are all possible substitution combinations and their meanings: **Inside per-server configuration (`httpd.conf`) for request "`GET /somepath/pathinfo`":** ``` **Given Rule** **Resulting Substitution** ---------------------------------------------- ---------------------------------- ^/somepath(.*) otherpath$1 not supported, because invalid! ^/somepath(.*) otherpath$1 [R] not supported, because invalid! ^/somepath(.*) otherpath$1 [P] not supported, because invalid! ---------------------------------------------- ---------------------------------- ^/somepath(.*) /otherpath$1 /otherpath/pathinfo ^/somepath(.*) /otherpath$1 [R] http://thishost/otherpath/pathinfo via external redirection ^/somepath(.*) /otherpath$1 [P] not supported, because silly! ---------------------------------------------- ---------------------------------- ^/somepath(.*) http://thishost/otherpath$1 /otherpath/pathinfo ^/somepath(.*) http://thishost/otherpath$1 [R] http://thishost/otherpath/pathinfo via external redirection ^/somepath(.*) http://thishost/otherpath$1 [P] not supported, because silly! ---------------------------------------------- ---------------------------------- ^/somepath(.*) http://otherhost/otherpath$1 http://otherhost/otherpath/pathinfo via external redirection ^/somepath(.*) http://otherhost/otherpath$1 [R] http://otherhost/otherpath/pathinfo via external redirection (the [R] flag is redundant) ^/somepath(.*) http://otherhost/otherpath$1 [P] http://otherhost/otherpath/pathinfo via internal proxy ``` **Inside per-directory configuration for `/somepath` (_i.e._, file `.htaccess` in dir `/physical/path/to/somepath` containing `RewriteBase /somepath`) for request "`GET /somepath/localpath/pathinfo`":** ``` **Given Rule** **Resulting Substitution** ---------------------------------------------- ---------------------------------- ^localpath(.*) otherpath$1 /somepath/otherpath/pathinfo ^localpath(.*) otherpath$1 [R] http://thishost/somepath/otherpath/pathinfo via external redirection ^localpath(.*) otherpath$1 [P] not supported, because silly! ---------------------------------------------- ---------------------------------- ^localpath(.*) /otherpath$1 /otherpath/pathinfo ^localpath(.*) /otherpath$1 [R] http://thishost/otherpath/pathinfo via external redirection ^localpath(.*) /otherpath$1 [P] not supported, because silly! ---------------------------------------------- ---------------------------------- ^localpath(.*) http://thishost/otherpath$1 /otherpath/pathinfo ^localpath(.*) http://thishost/otherpath$1 [R] http://thishost/otherpath/pathinfo via external redirection ^localpath(.*) http://thishost/otherpath$1 [P] not supported, because silly! ---------------------------------------------- ---------------------------------- ^localpath(.*) http://otherhost/otherpath$1 http://otherhost/otherpath/pathinfo via external redirection ^localpath(.*) http://otherhost/otherpath$1 [R] http://otherhost/otherpath/pathinfo via external redirection (the [R] flag is redundant) ^localpath(.*) http://otherhost/otherpath$1 [P] http://otherhost/otherpath/pathinfo via internal proxy ``` **Example:** We want to rewrite URLs of the form `/` _Language_ `/~` _Realname_ `/.../` _File_ into `/u/` _Username_ `/.../` _File_ `.` _Language_ We take the rewrite mapfile from above and save it under `/path/to/file/map.txt`. Then we only have to add the following lines to the Apache server configuration file: ``` RewriteLog /path/to/file/rewrite.log RewriteMap real-to-user txt:/path/to/file/map.txt RewriteRule ^/([^/]+)/~([^/]+)/(.*)$ /u/${real-to-user:$2|nobody}/$3.$1 ```