.htaccess rewrite 规则详细说明
国内的虚拟机一般不提供.htaccess功能(据我所知,discuz的主机好像提供此功能),而在国外主机中,.htaccess功能似乎是标配,笔者的blog架在mt上,支持.htaccess,每次看到一堆别人写好了的.htaccess设置,很多命令都不甚了了,查看、修改起来很不方便,痛定思痛,潜心学习一下,知其所以然嘛~
学习前提:(不会的朋友要学习一下,才能更好的理解下面的文字呢)
linux基础(不会也没事啦,写个.htaccess没必要大费周折啦,推荐:鸟哥私房菜linux基础)
正则表达式(rewrite规则建立在正则的基础之上,推荐:正则表达式30分钟入门教程)
rewrite的语法格式:
rewriteengine on #要想rewrite起作用,必须要写上哦
rewritebase url-path #设定基准目录,例如希望对根目录下的文件rewrtie,就是”/”
rewritecond test-string condpattern #写在rewriterule之前,可以有一或n条,用于测试rewrite的匹配条件,具体怎么写,后面会详细说到。
rewriterule pattern substitution #规则
rewriteengine on|off
rewriteengine 用于开启或停用rewrite功能。
rewrite configurations 不会自动继承,因此你得给每个你想用 rewrite功能的虚拟主机目录中加上这个指令。
rewritebase url-path
rewritebase用于设定重写的基准url。在下文中,你可以看见rewriterule可以用于目录级的配置文件中 (.htaccess)并在局部范围内起作用,即规则实际处理的只是剥离了本地路径前缀的一部分。处理结束后,这个路径会被自动地附着回去。默认值 是”rewritebase physical-directory-path”。
在对一个新的url进行替换时,此模块必须把这个url重新注入到服务器处理中。为此,它必须知道其对应的url前缀或者说url基准。通常,此前缀就是 对应的文件路径。但是,大多数网站url不是直接对应于其物理文件路径的,因而一般不能做这样的假定! 所以在这种情况下,就必须用rewritebase指令来指定正确的url前缀。
如果你的网站服务器url不是与物理文件路径直接对应的,而又需要使用rewritebase指令,则必须在每个对应的.htaccess文件中指定 rewriterule 。
rewritecond teststring condpattern [flags]
rewritecond指令定义了一个规则的条件,即,在一个rewriterule指令之前有一个或多个rewritecond指令。 条件之后的重写规则仅在当前uri与pattern匹配并且符合这些条件的时候才会起作用。
teststring是一个纯文本的字符串,但是还可以包含下列可扩展的成分:
rewriterule反向引用: 引用方法是 $n (0 <= n <= 9) 引用当前(带有若干rewritecond指令的)rewriterule中的 与pattern匹配的分组成分(圆括号!)。
rewritecond反向引用: 引用方法是 %n (1 <= n <= 9) 引用当前若干rewritecond条件中最后符合的条件中的分组成分(圆括号!)。
rewritemap 扩展: 引用方法是 ${mapname:key|default}
服务器变量: 引用方法是 %{ name_of_variable } 这个是我们最常使用到的功能
name_of_variable具体数值见下表:
http headers: | connection & request: | |
---|---|---|
http_user_agent http_referer http_cookie http_forwarded http_host http_proxy_connection http_accept |
remote_addr remote_host remote_user remote_ident request_method script_filename path_info query_string auth_type |
|
server internals: | system stuff: | specials: |
document_root server_admin server_name server_addr server_port server_protocol server_software |
time_year time_mon time_day time_hour time_min time_sec time_wday time |
api_version the_request request_uri request_filename is_subreq |
这些都对应于类似命名的http mime头、apache服务器的c变量以及unix系统中的 struct tm字段,大多数都在其他的手册或者cgi规范中有所讲述。 而其中为mod_rewrite所特有的变量有:
is_subreq
如果正在处理的请求是一个子请求,它包含字符串”true”,否则就是”false”。 模块为了解析uri中的附加文件,有可能会产生子请求。
api_version
这是正在使用的httpd中(服务器和模块之间内部接口)的apache模块api的版本, 其定义位于include/ap_mmn.h中。此模块版本对应于正在使用的apache的版本 (比如,在apache 1.3.14的发行版中,这个值是19990320:10)。 通常,对它感兴趣的是模块的作者。
the_request
这是由浏览器发送给服务器的完整的http请求行。(比如, “get /index.html http/1.1″). 它不包含任何浏览器发送的附加头信息。
request_uri
这是在http请求行中所请求的资源。(比如上述例子中的”/index.html”.)
request_filename
这是与请求相匹配的完整的本地文件系统的文件路径名或描述.
condpattern是条件pattern, 即, 一个应用于当前实例teststring的正则表达式, 即, teststring将会被计算然后与condpattern匹配.
注意:condpattern是一个兼容perl的正则表达式, 但是还有若干补充:
可以在pattern串中使用'!‘ 字符(惊叹号)来实现匹配的反转。
rewriteoptions options
rewriteoptions指令为当前服务器级和目录级的配置设置一些选项。 option可以是下列值之一:
inherit
此值强制当前配置可以继承其父配置。 在虚拟主机级配置中,它意味着主服务器的映射表、条件和规则可以被继承。 在目录级配置中,它意味着其父目录的.htaccess中的条件和规则可以被继承。
maxredirects=number
为了避免目录级rewriterule的无休止的内部重定向, 在此类重定向和500内部服务器错误次数达到一个最大值的时候, mod_rewrite会停止对此请求的处理。 如果你确实需要对每个请求允许大于10次的内部重定向,可以增大这个值。
rewriterule pattern substitution [flags]
rewriterule指令是重写引擎的根本。此指令可以多次使用。 每个指令定义一个简单的重写规则。这些规则的定义顺序尤为重要, 因为,在运行时刻,规则是按这个顺序逐一生效的.
pattern是一个作用于当前url的兼容perl的正则表达式。
此外,还可以使用否字符(‘!‘)的pattern前缀,以实现pattern的反转。但是,需要注意的是使用否字符以反转pattern时,pattern中不能使用分组的通配成分;即$n。
重写规则中的substitution是, 当原始url与pattern相匹配时,用以替代(或替换)的字符串。除了纯文本,还可以使用
$n 反向引用rewriterule的pattern
%n 反向引用最后匹配的rewritecond pattern
规则条件测试字符串中(%{varname})的服务器变量
映射函数调用(${mapname:key|default})
下面给出几个完整的例子供各位参考:
一、防盗链功能
只这四行就实现了防盗链是不是很神奇^_^,编写起来是不是又觉得复杂。
rewriteengine on
rewritecond %{http_referer} !^http://(.+.)?mysite.com/ [nc]
rewritecond %{http_referer} !^$
rewriterule .*.(jpe?g|gif|bmp|png)$ /images/nohotlink.jpg [l]
二、网址规范化
这个是把所有二级域名都重定向到www.yourdomain.com的例子,现在看来是不是很简单了?
options +followsymlinks
rewriteengine on
rewritecond %{http_host} ^yourdomain.com [nc]
rewriterule ^(.*)$ http://www.yourdomain.com/$1 [r=301,l]
三、临时错误页面
当你的网站在升级、修改的时候,你最好让访客转到指定的页面,而不是没做完的页面或者是错误页。
rewriteengine on
rewritecond %{request_uri} !/maintenance.html$
rewritecond %{remote_addr} !^123.123.123.123
rewriterule $ /error.html [r=302,l]
四、重定向rss地址到feedsky
除了可以更改模板里的rss地址外,.htaccess也能实现rss地址的更改,并更加方便。
rewriteengine on
rewritecond %{http_user_agent} !feedsky [nc]
rewritecond %{http_user_agent} !feedvalidator [nc]
rewriterule ^feed/?([_0-9a-z-]+)?/?$ http://feed.feedsky.com/yours
附录:flags
‘redirect|r [=code]‘ (强制重定向 redirect)
以http://thishost[:thisport]/(使新的url成为一个uri) 为前缀的substitution可以强制性执行一个外部重定向。 如果code没有指定,则产生一个http响应代码302(临时性移动)。 如果需要使用在300-400范围内的其他响应代码,只需在此指定这个数值即可, 另外,还可以使用下列符号名称之一: temp (默认的), permanent, seeother. 用它可以把规范化的url反馈给客户端,如, 重写“/~”为 “/u/”,或对/u/user加上斜杠,等等。 注意: 在使用这个标记时,必须确保该替换字段是一个有效的url! 否则,它会指向一个无效的位置! 并且要记住,此标记本身只是对url加上 http://thishost[:thisport]/的前缀,重写操作仍然会继续。 通常,你会希望停止重写操作而立即重定向,则还需要使用'l'标记.
‘forbidden|f' (强制url为被禁止的 forbidden)
强制当前url为被禁止的,即,立即反馈一个http响应代码403(被禁止的)。 使用这个标记,可以链接若干rewriteconds以有条件地阻塞某些url。
‘gone|g' (强制url为已废弃的 gone)
强制当前url为已废弃的,即,立即反馈一个http响应代码410(已废弃的)。 使用这个标记,可以标明页面已经被废弃而不存在了.
‘proxy|p' (强制为代理 proxy)
此标记使替换成分被内部地强制为代理请求,并立即(即, 重写规则处理立即中断)把处理移交给代理模块。 你必须确保此替换串是一个有效的(比如常见的以 http://hostname开头的)能够为apache代理模块所处理的uri。 使用这个标记,可以把某些远程成分映射到本地服务器名称空间, 从而增强了proxypass指令的功能。 注意: 要使用这个功能,代理模块必须编译在apache服务器中。 如果你不能确定,可以检查“httpd -l”的输出中是否有mod_proxy.c。 如果有,则mod_rewrite可以使用这个功能; 如果没有,则必须启用mod_proxy并重新编译“httpd”程序。
‘last|l' (最后一个规则 last)
立即停止重写操作,并不再应用其他重写规则。 它对应于perl中的last命令或c语言中的break命令。 这个标记可以阻止当前已被重写的url为其后继的规则所重写。 举例,使用它可以重写根路径的url(‘/')为实际存在的url, 比如, ‘/e/www/'.
‘next|n' (重新执行 next round)
重新执行重写操作(从第一个规则重新开始). 这时再次进行处理的url已经不是原始的url了,而是经最后一个重写规则处理的url。 它对应于perl中的next命令或c语言中的continue命令。 此标记可以重新开始重写操作,即, 立即回到循环的头部。 但是要小心,不要制造死循环!
‘chain|c' (与下一个规则相链接 chained)
此标记使当前规则与下一个(其本身又可以与其后继规则相链接的, 并可以如此反复的)规则相链接。 它产生这样一个效果: 如果一个规则被匹配,通常会继续处理其后继规则, 即,这个标记不起作用;如果规则不能被匹配, 则其后继的链接的规则会被忽略。比如,在执行一个外部重定向时, 对一个目录级规则集,你可能需要删除“.www” (此处不应该出现“.www”的)。
‘type|t=mime-type' (强制mime类型 type)
强制目标文件的mime类型为mime-type。 比如,它可以用于模拟mod_alias中的scriptalias指令, 以内部地强制被映射目录中的所有文件的mime类型为“application/x-httpd-cgi”.
‘nosubreq|ns' (仅用于不对内部子请求进行处理 no internal sub-request)
在当前请求是一个内部子请求时,此标记强制重写引擎跳过该重写规则。 比如,在mod_include试图搜索可能的目录默认文件(index.xxx)时, apache会内部地产生子请求。对子请求,它不一定有用的,而且如果整个规则集都起作用, 它甚至可能会引发错误。所以,可以用这个标记来排除某些规则。 根据你的需要遵循以下原则: 如果你使用了有cgi脚本的url前缀,以强制它们由cgi脚本处理, 而对子请求处理的出错率(或者开销)很高,在这种情况下,可以使用这个标记。
‘nocase|nc' (忽略大小写 no case)
它使pattern忽略大小写,即, 在pattern与当前url匹配时,'a-z' 和'a-z'没有区别。
‘qsappend|qsa' (追加请求串 query string append)
此标记强制重写引擎在已有的替换串中追加一个请求串,而不是简单的替换。 如果需要通过重写规则在请求串中增加信息,就可以使用这个标记。
‘noescape|ne' (在输出中不对uri作转义 no uri escaping)
此标记阻止mod_rewrite对重写结果应用常规的uri转义规则。 一般情况下,特殊字符(如'%', ‘$', ‘;'等)会被转义为等值的十六进制编码。 此标记可以阻止这样的转义,以允许百分号等符号出现在输出中,如: rewriterule /foo/(.*) /bar?arg=p1\%3d$1 [r,ne]
可以使'/foo/zed'转向到一个安全的请求'/bar?arg=p1=zed'.
‘passthrough|pt' (移交给下一个处理器 pass through)
此标记强制重写引擎将内部结构request_rec中的uri字段设置为 filename字段的值,它只是一个小修改,使之能对来自其他uri到文件名翻译器的 alias,scriptalias, redirect 等指令的输出进行后续处理。举一个能说明其含义的例子: 如果要通过mod_rewrite的重写引擎重写/abc为/def, 然后通过mod_alias使/def转变为/ghi,可以这样: rewriterule ^/abc(.*) /def$1 [pt]
alias /def /ghi
如果省略了pt标记,虽然mod_rewrite运作正常, 即, 作为一个使用api的uri到文件名翻译器, 它可以重写uri=/abc/…为filename=/def/…, 但是,后续的mod_alias在试图作uri到文件名的翻译时,则会失效。
注意: 如果需要混合使用不同的包含uri到文件名翻译器的模块时, 就必须使用这个标记。混合使用mod_alias和mod_rewrite就是个典型的例子。
for apache hackers
如果当前apache api除了uri到文件名hook之外,还有一个文件名到文件名的hook, 就不需要这个标记了! 但是,如果没有这样一个hook,则此标记是唯一的解决方案。 apache group讨论过这个问题,并在apache 2.0 版本中会增加这样一个hook。
'skip|s=num' (跳过后继的规则 skip)
此标记强制重写引擎跳过当前匹配规则后继的num个规则。 它可以实现一个伪if-then-else的构造: 最后一个规则是then从句,而被跳过的skip=n个规则是else从句. (它和'chain|c'标记是不同的!)
‘env|e=var:val' (设置环境变量 environment variable)
此标记使环境变量var的值为val, val可以包含可扩展的反向引用的正则表达式$n和%n。 此标记可以多次使用以设置多个变量。 这些变量可以在其后许多情况下被间接引用,但通常是在xssi (via or cgi (如 $env{‘var'})中, 也可以在后继的rewritecond指令的pattern中通过%{env:var}作引用。 使用它可以从url中剥离并记住一些信息。
‘cookie|co=name:val:domain[:lifetime[:path]]' (设置cookie)
它在客户端浏览器上设置一个cookie。 cookie的名称是name,其值是val。 domain字段是该cookie的域,比如'.apache.org', 可选的lifetime是cookie生命期的分钟数, 可选的path是cookie的路径。
深入阅读:http://oss.org.cn/man/newsoft/apachemanual/mod/mod_rewrite.html