Apache mod_rewrite各模塊詳細介紹
關(guān)鍵詞: Apache ?? mod_rewrite ?? ??????????????????????????????????????mod_rewrite模塊
mod_rewrite模塊可以操作URL的所有部分(包括路徑信息部分), 在服務器級的(httpd.conf)和目錄級的(.htaccess)配置都有效,還可以生成最終請求串。此重寫操作的結(jié)果可以是內(nèi)部子處理,也可以是外部請求的轉(zhuǎn)向, 甚至還可以是內(nèi)部代理處理。
? ? 但是,所有這些功能和靈活性帶來一個問題,那就是復雜性, 因此,不要指望一天之內(nèi)就能看懂整個模塊。
內(nèi)部處理?
??? mod_rewrite模塊的內(nèi)部處理極為復雜,但是,為了使一般用戶避免犯低級錯誤, 也讓管理員能充分利用其功能,在此仍然做一下說明。
API程序段
首先,你必須了解,Apache是通過若干程序段來處理HTTP請求的。 Apache API 對每個程序段提供了一個hook程序。 Mod_rewrite使用兩個hook程序: 其一是,URL到文件名的轉(zhuǎn)譯hook,用在讀取HTTP請求之后,而在授權(quán)開始之前;其二是,修正hook,用在授權(quán)程序段和讀取目錄級配置文件(.htaccess)之后, 而在內(nèi)容處理器激活之前。
所以,Apache收到一個請求并且確定了響應主機(或者是虛擬主機)之后,重寫引擎即開始執(zhí)行URL到文件名程序段,以處理服務器級的配置中所有的mod_rewrite指令。在最終數(shù)據(jù)目錄確定以后,進入修正程序段并觸發(fā)目錄級配置中的mod_rewrite指令。這兩個程序段并不是涇渭分明的,但都實施把URL重寫成新的URL或者文件名。 雖然API最初不是為此設(shè)計的,但它已經(jīng)成為API的一種用途,而在Apache 1.x 中這是mod_rewrite唯一的實現(xiàn)方法。 記住以下兩點,會有助于更好地理解:
雖然mod_rewrite可以重寫URL為URL,重寫URL為文件名,甚至重寫文件名為文件名,但是目前API只提供一個URL到文件名的hook。 在Apache 2.0 中,增加了兩個丟失hook以使處理過程更清晰。 但是,這樣做并沒有給用戶帶來麻煩,只需記住這樣一個事實: Apache借助URL到文件名的hook而比API設(shè)計的目標功能更強大。??
難以置信的是,mod_rewrite提供了目錄級的URL操作,即,.htaccess文件,而這些文件必須在URL轉(zhuǎn)換成文件名以后的較多步驟完成之后才會被處理。這也是必須的,因為.htaccess文件存在于文件系統(tǒng)中,所以處理已經(jīng)到達這個層面。換句話說,根據(jù)API程序段,這時再處理任何URL操作已經(jīng)太晚了。 為了解決這個雞和蛋的問題,mod_rewrite使用了一個技巧:在進行一個目錄級的URL/文件名的操作時,mod_rewrite先把文件名重寫回相應的URL (通常這個操作是不可行的,但是參考下面的RewriteBase指令就明白它是怎么實現(xiàn)的),然后,對這個新的URL建立一個新的內(nèi)部的子請求,以此重新開始API程序段的執(zhí)行。??
另外,mod_rewrite盡力使這些復雜的操作對用戶全透明,但仍須記住:服務器級的URL操作速度快而且效率高,而目錄級的操作由于這個雞和蛋的問題速度慢效率也低。但從另一個側(cè)面看,這卻是mod_rewrite得以為一般用戶提供(局部限制的)URL操作的唯一方法。
牢記這兩點!
規(guī)則集的處理
當mod_rewrite在這兩個程序段中開始執(zhí)行時,它會讀取配置結(jié)構(gòu)中的配置好的 (或者是在服務啟動時建立的服務器級的,或者是Apache核心在遍歷目錄采集到的目錄級的)規(guī)則集,隨后,啟動URL重寫引擎來處理(帶有一個或多個條件)的規(guī)則集。無論是服務器級的還是目錄級的規(guī)則集,都是由同一個URL重寫引擎處理,只是處理結(jié)果不同而已。
規(guī)則集中規(guī)則的順序是很重要的,因為重寫引擎是按一種特殊的(非常規(guī)的)順序處理的, 其原則是:逐個遍歷每個規(guī)則(RewriteRule directives), 如果出現(xiàn)一個匹配條件的規(guī)則,則可能回頭遍歷已有的規(guī)則條件(RewriteConddirectives)。由于歷史的原因,條件規(guī)則是置前的,所以控制流程略顯冗長,細節(jié)見Figure 1。
Figure 1:The control flow through the rewriting ruleset??
可見,URL首先與每個規(guī)則的Pattern匹配, 如果匹配不成功,mod_rewrite立即終止此規(guī)則的處理,繼而處理下一個規(guī)則。如果匹配成功,mod_rewrite尋找響應的規(guī)則條件,如果一個條件都沒有,則簡單地用Substitution構(gòu)造的新的值來替換URL,然后繼續(xù)處理其他規(guī)則。 如果條件存在,則開始一個內(nèi)部循環(huán)按其列出的順序逐個處理。對規(guī)則的條件的處理有所不同:URL并不與pattern匹配,而是,首先通過擴展變量、反向引用、查找映射表等步驟建立一個TestString的字符串,隨后,用它來與CondPattern匹配。如果匹配不成功,則整個條件集和對應的規(guī)則失敗; 如果匹配成功,則執(zhí)行下一個規(guī)則直到所有條件執(zhí)行完畢。如果所有條件得以匹配,則以Substitution替換URL,并且繼續(xù)處理。
特殊字符的引用
在Apache 1.3.20, TestString and Substitution 字符串中的特殊字符可以用前綴的斜杠來實現(xiàn)轉(zhuǎn)義(即,忽略其特殊含義而視之為普通字符)。比如,Substitution可以用'$'來包含一個美元符號, 以避免mod_rewrite把它視為反向引用。
正則表達式的反向引用能力
這是很重要的一點:一旦在Pattern或者CondPattern使用了圓括號, 就會建立內(nèi)部的反向引用,可以使用$N和%N來調(diào)用(見下述),并且,在Substitution和TestString中都有效。 Figure 2 說明了反向引用被轉(zhuǎn)換擴展的位置。
Figure 2: The back-reference flow through a rule.??
雖然mod_rewrite內(nèi)部處理的這個過程是比較雜亂的, 但是了解這些可以幫助你閱讀下文中指令的講述。
環(huán)境變量
mod_rewrite 模塊會跟蹤兩個額外的(
注意: 這些變量保持的是其最初被請求時的URI/URL, 即, 在任何重寫操作之前的。 其重要性在于他們是重寫操作重寫URL到物理路徑名的原始依據(jù)。
舉例
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 Rewriting Guide, 列舉了許多基于URL的問題的實用方案,其中你可以找到真實有用的規(guī)則集和mod_rewrite的更多信息。
RewriteBase 指令
RewriteBase指令顯式地設(shè)置了目錄級重寫的
在對一個新的URL進行替換時,[b:7064b9ad95]mod_rewrite模塊 [/color:7064b9ad95][/b:7064b9ad95]必須把這個URL重新注入到服務器處理中。為此,它必須知道其對應的URL前綴或者說URL基準。通常,此前綴就是對應的文件路徑。但是,大多數(shù)網(wǎng)站URL不是直接對應于其物理文件路徑的,因而一般不能做這樣的假定! 所以在這種情況下,就必須用RewriteBase指令來指定正確的URL前綴。
如果你的網(wǎng)站服務器URL不是與物理文件路徑直接對應的, 而又需要使用RewriteRule指令, 則必須在每個對應的.htaccess文件中指定RewriteBase。??
舉例,目錄級配置文件內(nèi)容如下:
#
#??/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 e.g.
#
??
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
以下列出了內(nèi)部處理的詳細步驟:
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
??
雖然這個過程看來很繁復,但是由于目錄級重寫的到來時機已經(jīng)太晚了,它不得不把這個(重寫)請求重新注入到Apache核心中,所以Apache內(nèi)部確實是這樣處理的。但是:它的開銷并不象看起來的那樣大,因為重新注入完全在Apache服務器內(nèi)部進行, 而且這樣的過程在Apache內(nèi)部也為其他許多操作所使用。所以,你可以充分信任其設(shè)計和實現(xiàn)是正確的。
RewriteCond 指令
RewriteCond指令定義了一個規(guī)則的條件,即,在一個RewriteRule指令之前有一個或多個RewriteCond指令。 條件之后的重寫規(guī)則僅在當前URI與pattern匹配并且符合這些條件的時候才會起作用。
TestString是一個純文本的字符串,但是還可以包含下列可擴展的成分:
RewriteRule反向引用: 引用方法是??
$N??
(0 <= N <= 9) 引用當前(帶有若干RewriteCond指令的)RewriteRule中的 與pattern匹配的分組成分(圓括號!)。??
RewriteCond反向引用: 引用方法是??
%N??
(1 <= N <= 9) 引用當前若干RewriteCond條件中最后符合的條件中的分組成分(圓括號!)。??
RewriteMap 擴展: 引用方法是??
${mapname:key|default}??
細節(jié)請參見the documentation for RewriteMap。??
服務器變量: 引用方法是??
%{ 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系統(tǒng)中的 struct tm字段,大多數(shù)都在其他的手冊或者CGI規(guī)范中有所講述。 而其中為mod_rewrite所特有的變量有:
IS_SUBREQ??
如果正在處理的請求是一個子請求,它包含字符串"true",否則就是"false"。 模塊為了解析URI中的附加文件,有可能會產(chǎn)生子請求。??
API_VERSION??
這是正在使用的httpd中(服務器和模塊之間內(nèi)部接口)的Apache模塊API的版本, 其定義位于include/ap_mmn.h中。mod_rewrite模塊版本對應于正在使用的Apache的版本 (比如,在Apache 1.3.14的發(fā)行版中,這個值是19990320:10)。 通常,對它感興趣的是模塊的作者。??
THE_REQUEST??
這是由瀏覽器發(fā)送給服務器的完整的HTTP請求行。(比如, "GET /index.html HTTP/1.1"). 它不包含任何瀏覽器發(fā)送的附加頭信息。??
REQUEST_URI??
這是在HTTP請求行中所請求的資源。(比如上述例子中的"/index.html".)??
REQUEST_FILENAME??
這是與請求相匹配的完整的本地文件系統(tǒng)的文件路徑名或描述.??
特別注意事項:
SCRIPT_FILENAME和REQUEST_FILENAME包含的值是相同的,即, Apache服務器的內(nèi)部request_rec結(jié)構(gòu)中的filename字段。 第一個其實就是大家都知道的CGI變量名,而第二個則是( 包含了request_rec結(jié)構(gòu)中的uri字段的)REQUEST_URI的一個副本,??
特殊形式: %{ENV:variable} 其中的variable可以是任何環(huán)境變量。 它是通過查找Apache內(nèi)部結(jié)構(gòu)得到的, 或者(如果沒找到的話)是由Apache服務器進程通過getenv()得到的。??
特殊形式: %{HTTP:header} 其中的header可以是任何HTTP MIME頭的名稱。 它是通過查找HTTP請求得到的。比如: %{HTTProxy-Connection}就是HTTP頭 ``Proxy-Connection:''的值.??
特殊形式 %{LA-U:variable} 它是一個預設(shè)的值, variable的最終值在執(zhí)行一個內(nèi)部的(基于URL的)子請求后決定。在重寫需要使用一個尚未有效的但是會在之后的API程序段中設(shè)置的變量的時候,就會使用這個方法。比如,需要在服務器級配置(httpd.conf文件)中重寫REMOTE_USER變量,則,必須使用%{LA-U:REMOTE_USER},因為此變量是由認證程序段設(shè)置的,而這個程序段是在mod_rewrite所在的URL轉(zhuǎn)譯程序段之后才執(zhí)行的。但是,因為mod_rewrite是通過API修正程序段來實現(xiàn)目錄級(.htaccess file)配置的,而這個程序段在認證程序段之前就執(zhí)行了,所以用%{REMOTE_USER}就可以了。??
特殊形式: %{LA-F:variable} 它是一個預設(shè)的值, variable的最終值在執(zhí)行一個內(nèi)部的(基于文件名的)子請求后決定。 大多數(shù)情況下和上述的LA-U是相同的.??
CondPattern是條件pattern, 即, 一個應用于當前實例TestString的正則表達式, 即, TestString將會被計算然后與CondPattern匹配.
謹記: CondPattern是一個兼容perl的正則表達式, 但是還有若干增補:
可以在pattern串中使用'!' 字符(驚嘆號)來實現(xiàn)匹配的反轉(zhuǎn)。??
CondPatterns有若干特殊的變種。除了正則表達式的標準用法,還有下列用法:??
'<CondPattern' (詞典順序的小于)
將CondPattern視為純字符串,與TestString以詞典順序相比較. 如果按詞典順序,TestString小于CondPattern,則為真.??
'>CondPattern' (詞典順序的大于)
將CondPattern視為純字符串,與TestString以詞典順序相比較. 如果按詞典順序,TestString大于CondPattern,則為真.??
'=CondPattern' (詞典順序的等于)
將CondPattern視為純字符串,與TestString以詞典順序相比較. 如果按詞典順序,TestString等于CondPattern,則為真,即,兩個字符串(逐個字符地)完全相等。如果CondPattern只是""(兩個引號), 則TestString將與空串相比較.??
'-d' (是一個目錄[directory])
將TestString視為一個路徑名并測試它是否存在而且是一個目錄.??
'-f' (是一個常規(guī)的文件[file])
將TestString視為一個路徑名并測試它是否存在而且是一個常規(guī)的文件.??
'-s' (是一個非空的常規(guī)文件[size])
將TestString視為一個路徑名并測試它是否存在而且是一個尺寸大于0的常規(guī)的文件.??
'-l' (是一個符號連接[link])
將TestString視為一個路徑名并測試它是否存在而且是一個符號連接.??
'-F' (對子請求有效的業(yè)已存在的文件)
測試TestString是否一個有效的文件, 而且可以被服務器當前已經(jīng)配置的所有存取控制所存取。 它用一個內(nèi)部子請求來做判斷,由于會降低服務器的性能,請小心使用!??
'-U' (對子請求有效的業(yè)已存在的URL)
測試TestString是否一個有效的URL, 而且可以被服務器當前已經(jīng)配置的所有存取控制所存取。 它用一個內(nèi)部子請求來做判斷,由于會降低服務器的性能,請小心使用!??
注意
所有這些測試都可以用驚嘆號作前綴('!')以實現(xiàn)條件的反轉(zhuǎn).??
另外,還可以為CondPattern追加特殊的標記
[flags]??
作為RewriteCond指令的第三個參數(shù)。 Flags是一個以逗號分隔的以下標記的列表:
'nocase|NC' (no case)
它使測試忽略大小寫, 即, 擴展后的TestString和CondPattern中, 'A-Z' 和'a-z'是沒有區(qū)別的。此標記僅作用于TestString和CondPattern的比較, 而對文件系統(tǒng)和子請求的測試不起作用。??
'ornext|OR' (or next condition)
它以O(shè)R方式組合若干規(guī)則的條件,而不是隱含的AND。典型的例子如下:??
RewriteCond %{REMOTE_HOST}??^host1.*??[OR]
RewriteCond %{REMOTE_HOST}??^host2.*??[OR]
RewriteCond %{REMOTE_HOST}??^host3.*
RewriteRule ...some special stuff for any of these hosts...
??
如果不用這個標記,則必須使用三個 條件/規(guī)則。??
舉例:
如果要按請求頭中的``User-Agent:'重寫一個站點的主頁,可以這樣寫:
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]
??
含義: 如果你使用的瀏覽器是Netscape Navigator(其識別標志是'Mozilla'), 則你將得到內(nèi)容最大化的主頁,包括Frames等等;如果你使用的是(基于終端的)Lynx,則你得到的是內(nèi)容最小化的主頁,不包含tables等等;如果你使用的是其他的瀏覽器,則你得到的是一個標準的主頁。
RewriteEngine 指令
RewriteEngine指令打開或關(guān)閉運行時刻的重寫引擎。 如果設(shè)置為off,則[b:7064b9ad95]mod_rewrite模塊[/color:7064b9ad95][/b:7064b9ad95]不執(zhí)行任何運行時刻的重寫操作, 甚至也不更新SCRIPT_URx環(huán)境變量。
使用該指令可以使[b:7064b9ad95]mod_rewrite模塊[/color:7064b9ad95][/b:7064b9ad95]無效,而無須注釋所有的RewriteRule指令!
注意:默認情況下,重寫配置是不可繼承的, 即,必須在每個需要的虛擬主機中設(shè)置一個RewriteEngine on指令。
RewriteLock 指令
此指令設(shè)置mod_rewrite為了和RewriteMap 程序通訊而使用的一個同步加鎖文件的名稱。 在需要使用重寫映射表程序時,它必須是一個本地路徑(而不能是一個NFS掛接設(shè)備); 對其他類型的重寫映射表,則無此要求。
RewriteLog 指令
RewriteLog指令設(shè)置用于記錄所有重寫操作的文件的名稱。 如果此文件名不是以斜杠('/')開頭,則它是相對于Server Root的。 此指令應該僅僅出現(xiàn)在服務器級配置中。
如果要關(guān)閉對重寫操作的記錄,不推薦把Filename設(shè)置為/dev/null,因為,雖然重寫引擎不能輸出記錄了,但仍會內(nèi)部地建立這個日志文件, 它會使服務器速度降低,而且對管理員毫無益處! 要關(guān)閉日志,可以刪除或注解RewriteLog指令, 或者使用RewriteLogLevel 0!??
安全
參見Apache Security Tips,其中講述了, 為什么如果存放日志的目錄對除了啟動服務器以外的用戶是可寫的會帶來安全隱患。??
舉例
RewriteLog "/usr/local/var/apache/logs/rewrite.log"??
RewriteLogLevel 指令?
RewriteLogLevel指令設(shè)置重寫引擎日志的詳細程度的級別。 默認級別0意味著不記錄,而9或更大的值意味著記錄所有的操作。
要關(guān)閉重寫引擎日志,可以簡單地設(shè)此值為0,關(guān)閉所有的重寫操作記錄。
使用較高的Level值會使Apache服務器速度急劇下降! 重寫日志使用大于2的Level值只用于調(diào)試!??
舉例
RewriteLogLevel 3??
RewriteMap 指令
RewriteMap定義一個映射表, 由映射函數(shù)用于查找關(guān)鍵詞來插入/替換字段。此查找操作的源可以是多種類型。
MapName是映射表的名稱, 指定了一個映射函數(shù),用于重寫規(guī)則的字符串替換,它可以是下列形式之一:
${ MapName : LookupKey }
${ MapName : LookupKey | DefaultValue }??
如果使用了這樣的形式,則會在MapName中查找關(guān)鍵詞LookupKey。 如果找到了,則被替換成SubstValue; 如果沒有找到,則被替換成DefaultValue, 如果沒有指定DefaultValue,則被替換成空字符串。
可以使用下列MapType和MapSource的組合:
標準純文本
MapType: txt, MapSource: 有效的Unix文件系統(tǒng)文件名??
這是重寫映射表的標準形式,即, MapSource是一個純文本文件,包含空行、注釋行(以字符'#'打頭), 以及每行一個的替換對,如下。
MatchingKey SubstValue??
Example
##
##??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??
隨機純文本
MapType: rnd, MapSource: 有效的Unix文件系統(tǒng)文件名??
這個與上述的標準純文本很相似,但它有一個特殊的后處理特性: 查找完畢后,會解析其中包含的含義為``or''和``|''符號。也就是說,會隨機地選擇其中之一作為實際的返回值。 雖然這看似毫無意義,但它的設(shè)計意圖是,在一個查找值是服務器名稱的反向代理環(huán)境中,實現(xiàn)負載平衡。如:
##
##??map.txt -- rewriting map
##
??
static? ?www1|www2|www3|www4
dynamic??www5|www6
??
RewriteMap servers rnd:/path/to/file/map.txt??
散列文件
MapType: dbm[=type], MapSource: 有效的Unix文件系統(tǒng)文件名??
這里的源是一個二進制格式的DBM文件,包含了與純文本相同的內(nèi)容, 但是因為它有優(yōu)化的特殊表現(xiàn)形式,使它的查找速度明顯快得多。此類型可以是sdbm, gdbm, ndbm或db,由compile-time settings所決定。如果省略type,則使用編譯時選擇的缺省設(shè)置。你可以使用任何DBM工具或者下列Perl腳本來建立這個文件,但必須保證DBM的類型正確。 建立NDBM文件的例子:
#!/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??
內(nèi)部函數(shù)
MapType: int, MapSource: 內(nèi)部的Apache函數(shù)??
這里的源是一個內(nèi)部的Apache函數(shù)。 目前,還不能由你自己建立,只能使用下列已經(jīng)存在的函數(shù):
[!--empirenews.page--]Apache mod_rewrite各模塊詳細介紹(2)[/!--empirenews.page--]
toupper:
轉(zhuǎn)換查找關(guān)鍵詞為大寫.??
tolower:
轉(zhuǎn)換查找關(guān)鍵詞為小寫.??
escape:
轉(zhuǎn)換查找關(guān)鍵詞中的特殊字符為十六進制編碼.??
unescape:
轉(zhuǎn)換查找關(guān)鍵詞中的十六進制編碼為特殊字符.??
外部的重寫程序
MapType: prg, MapSource: 有效的Unix文件系統(tǒng)文件名??
這里的源是一個程序,而不是一個映射表文件。 程序的編制語言可以隨意選擇,但最終結(jié)果必須是可執(zhí)行的 (即, 或者是目標代碼,或者是首行為'#!/path/to/interpreter'的腳本).
此程序僅在Apache服務器啟動時啟動一次, 隨后通過stdin和stdout文件句柄與重寫引擎交互。對每個映射函數(shù)的查找操作,它從stdin接收以回車結(jié)束的查找關(guān)鍵詞, 然后把查找結(jié)果以回車結(jié)束反饋到stdout,如果查找失敗,則返回四個字符的``NULL'' (即, 對給定的關(guān)鍵詞沒有對應的值)。 此程序的最簡單形式是一個1:1的映射(即,key == value),如:
#!/usr/bin/perl
$| = 1;
while (<STDIN>) {
? ???# ...put here any transformations or lookups...
? ???print $_;
}
??
但是必須注意:
``即使它看來簡單而愚蠢,只要正確,就保持原樣(Keep it simple, stupid)'' (KISS), 因為,在規(guī)則起作用時,此程序的崩潰會直接導致Apache服務器的崩潰。??
避免犯一個常見的錯誤: 絕不要對stdout做緩沖I/O! 它會導致死循環(huán)! 所以上述例子中才會有``$|=1''...??
使用RewriteLock指令定義一個加鎖文件, 用于同步mod_rewrite和此程序之間的通訊。缺省時是沒有同步操作的。??
RewriteMap指令允許多次出現(xiàn)。 對每個映射函數(shù)都可以使用一個RewriteMap指令來定義其重寫映射表。 雖然不能在目錄的上下文中定義映射表, 但是,完全可以在其中使用映射表。
注意
對于純文本和DBM格式的文件,已經(jīng)查找過的關(guān)鍵詞會被緩存在內(nèi)核中, 直到映射表的mtime改變了或者服務器重啟了。 這樣,你可以把每個請求都會用到的映射函數(shù)放在規(guī)則中,這是沒有問題的,因為外部查找只進行一次!??
RewriteOptions 指令
RewriteOptions指令為當前服務器級和目錄級的配置設(shè)置一些選項。 Option可以是下列值之一:
inherit??
此值強制當前配置可以繼承其父配置。 在虛擬主機級配置中,它意味著主服務器的映射表、條件和規(guī)則可以被繼承。 在目錄級配置中,它意味著其父目錄的.htaccess中的條件和規(guī)則可以被繼承。??
MaxRedirects=number??
為了避免目錄級RewriteRule的無休止的內(nèi)部重定向, 在此類重定向和500內(nèi)部服務器錯誤次數(shù)達到一個最大值的時候, mod_rewrite會停止對此請求的處理。 如果你確實需要對每個請求允許大于10次的內(nèi)部重定向,可以增大這個值。??
RewriteRule 指令
RewriteRule指令是重寫引擎的根本。此指令可以多次使用。 每個指令定義一個簡單的重寫規(guī)則。這些規(guī)則的定義順序尤為重要, 因為,在運行時刻,規(guī)則是按這個順序逐一生效的.
Pattern是一個作用于當前URL的兼容perl的正則表達式. 這里的``當前''是指該規(guī)則生效時的URL的值。 它可能與被請求的URL不同,因為其他規(guī)則可能在此之前已經(jīng)發(fā)生匹配并對它做了改動。
正則表達式的一些用法:
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 Nth 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.)
??
更多有關(guān)正則表達式的資料請參見perl正則表達式手冊頁("perldoc perlre"). 如果你對正則表達式的更詳細的資料及其變種(POSIX regex 等.)感興趣, 請參見以下專著:
Mastering Regular Expressions
Jeffrey E.F. Friedl
Nutshell Handbook Series
O'Reilly & Associates, Inc. 1997
ISBN 1-56592-257-3
另外,在mod_rewrite中,還可以使用否字符('!')的pattern
注意
使用否字符以反轉(zhuǎn)pattern時,pattern中不能使用分組的通配成分。 由于pattern不匹配而使分組的內(nèi)容是空的,所以它是不可能實現(xiàn)的。 因此,如果使用了否pattern,那么后繼的
重寫規(guī)則中的Substitution是, 當原始URL與Pattern相匹配時,用以替代(或替換)的字符串。 除了純文本,還可以使用
$N 反向引用RewriteRule的pattern??
%N 反向引用最后匹配的RewriteCond pattern??
規(guī)則條件測試字符串中(%{VARNAME})的服務器
映射函數(shù)調(diào)用(${mapname:key|default})??
反向引用的$N (N=0..9) 是指用Pattern所匹配的第N組的內(nèi)容去替換URL。服務器變量與RewriteCond指令的TestString相同。 映射函數(shù)由RewriteMap指令所決定,其說明也參見該指令。這三種類型變量按上面列表中的順序被擴展。
如上所述,所有的重寫規(guī)則都是(按配置文件中的定義順序)作用于Substitution的。 URL被Substitution完全地替換,并繼續(xù)處理直到所有規(guī)則處理完畢, 除非用L標記顯式地終結(jié) - 見下文。
'-'是一個特殊的替換串,意思是不要替換! 似乎很愚蠢吧? 不, 它可以用于僅僅匹配某些URL而無須替換的情況下,即, 在發(fā)生替換前,允許以C (chain)標記連接的多個pattern同時起作用。
還有,你甚至可以在替換字符串中新建包含請求串的URL。 在替換串中使用問號,以標明其后繼的成分應該被重新注入到QUERY_STRING中。 要刪除一個已有的請求串,可以用問號來終結(jié)替換字符串。
注意
一個特殊功能: 在用http://thishost[:thisport]作為替換字段的前綴時, mod_rewrite會把它自動剝離出去。 在配合生成主機名的映射函數(shù)使用的時候, 這個對隱含的外部重定向URL的精簡化操作是有用的而且是重要的。 下面例子一節(jié)中的第一個例子有助于理解這點。??
謹記
由于此功能的存在,以http://thishost為前綴的無條件外部重定向在你自己的服務器上是無效的。 要做這樣一個自身的重定向,必須使用R標記 (見下文).??
此外,Substitution還可以追加特殊標記
[flags]??
作為RewriteRule指令的第三個參數(shù)。 Flags是一個包含以逗號分隔的下列標記的列表:??
'redirect|R [=code]' (強制重定向 redirect)
以http://thishost[: thisport]/(使新的URL成為一個URI) 為前綴的Substitution可以強制性執(zhí)行一個外部重定向。如果code沒有指定,則產(chǎn)生一個HTTP響應代碼302(臨時性移動)。如果需要使用在300-400范圍內(nèi)的其他響應代碼,只需在此指定這個數(shù)值即可, 另外,還可以使用下列符號名稱之一: temp (默認的), permanent, seeother. 用它可以把規(guī)范化的URL反饋給客戶端,如, 重寫``/~''為 ``/u/'',或?qū)?u/user加上斜杠,等等。
注意: 在使用這個標記時,必須確保該替換字段是一個有效的URL! 否則,它會指向一個無效的位置! 并且要記住,此標記本身只是對URL加上 http://thishost[:thisport]/的前綴,重寫操作仍然會繼續(xù)。 通常,你會希望停止重寫操作而立即重定向,則還需要使用'L'標記.
'forbidden|F' (強制URL為被禁止的 forbidden)
強制當前URL為被禁止的,即,立即反饋一個HTTP響應代碼403(被禁止的)。 使用這個標記,可以鏈接若干RewriteConds以有條件地阻塞某些URL。??
'gone|G' (強制URL為已廢棄的 gone)
強制當前URL為已廢棄的,即,立即反饋一個HTTP響應代碼410(已廢棄的)。 使用這個標記,可以標明頁面已經(jīng)被廢棄而不存在了.??
'proxy|P' (強制為代理 proxy)
此標記使替換成分被內(nèi)部地強制為代理請求,并立即(即, 重寫規(guī)則處理立即中斷)把處理移交給代理模塊。 你必須確保此替換串是一個有效的(比如常見的以 http://hostname開頭的)能夠為Apache代理模塊所處理的URI。 使用這個標記,可以把某些遠程成分映射到本地服務器名稱空間, 從而增強了ProxyPass指令的功能。??
注意: 要使用這個功能,代理模塊必須編譯在Apache服務器中。 如果你不能確定,可以檢查``httpd -l''的輸出中是否有mod_proxy.c。 如果有,則mod_rewrite可以使用這個功能;如果沒有,則必須啟用mod_proxy并重新編譯``httpd''程序。
'last|L' (最后一個規(guī)則 last)
立即停止重寫操作,并不再應用其他重寫規(guī)則。 它對應于Perl中的last命令或C語言中的break命令。這個標記可以阻止當前已被重寫的URL為其后繼的規(guī)則所重寫。 舉例,使用它可以重寫根
'next|N' (重新執(zhí)行 next round)
重新執(zhí)行重寫操作(從第一個規(guī)則重新開始). 這時再次進行處理的URL已經(jīng)不是原始的URL了,而是經(jīng)最后一個重寫規(guī)則處理的URL。 它對應于Perl中的next命令或C語言中的continue命令。 此標記可以重新開始重寫操作,即, 立即回到循環(huán)的頭部。
但是要小心,不要制造死循環(huán)!??
'chain|C' (與下一個規(guī)則相鏈接 chained)
此標記使當前規(guī)則與下一個(其本身又可以與其后繼規(guī)則相鏈接的, 并可以如此反復的)規(guī)則相鏈接。 它產(chǎn)生這樣一個效果: 如果一個規(guī)則被匹配,通常會繼續(xù)處理其后繼規(guī)則, 即,這個標記不起作用;如果規(guī)則不能被匹配,則其后繼的鏈接的規(guī)則會被忽略。比如,在執(zhí)行一個外部重定向時, 對一個目錄級規(guī)則集,你可能需要刪除``.www'' (此處不應該出現(xiàn)``.www''的)。??
'type|T=MIME-type' (強制MIME類型 type)
強制目標文件的MIME類型為MIME-type。 比如,它可以用于模擬mod_alias中的ScriptAlias指令, 以內(nèi)部地強制被映射目錄中的所有文件的MIME類型為``application/x-httpd-cgi''.??
'nosubreq|NS' (僅用于不對內(nèi)部子請求進行處理 no internal sub-request)
在當前請求是一個內(nèi)部子請求時,此標記強制重寫引擎跳過該重寫規(guī)則。比如,在mod_include試圖搜索可能的目錄默認文件(index.xxx)時, Apache會內(nèi)部地產(chǎn)生子請求。對子請求,它不一定有用的,而且如果整個規(guī)則集都起作用,它甚至可能會引發(fā)錯誤。所以,可以用這個標記來排除某些規(guī)則。
根據(jù)你的需要遵循以下原則: 如果你使用了有CGI腳本的URL前綴,以強制它們由CGI腳本處理, 而對子請求處理的出錯率(或者開銷)很高,在這種情況下,可以使用這個標記。
'nocase|NC' (忽略大小寫 no case)
它使Pattern忽略大小寫,即, 在Pattern與當前URL匹配時,'A-Z' 和'a-z'沒有區(qū)別。??
'qsappend|QSA' (追加請求串 query string append)
此標記強制重寫引擎在已有的替換串中追加一個請求串,而不是簡單的替換。 如果需要通過重寫規(guī)則在請求串中增加信息,就可以使用這個標記。??
'noescape|NE' (在輸出中不對URI作轉(zhuǎn)義 no URI escaping)
此標記阻止mod_rewrite對重寫結(jié)果應用常規(guī)的URI轉(zhuǎn)義規(guī)則。 一般情況下,特殊字符(如'%', '$', ';'等)會被轉(zhuǎn)義為等值的十六進制編碼。 此標記可以阻止這樣的轉(zhuǎn)義,以允許百分號等符號出現(xiàn)在輸出中,如:??
RewriteRule /foo/(.*) /bar?arg=P1%3d$1 [R,NE]??
可以使'/foo/zed'轉(zhuǎn)向到一個安全的請求'/bar?arg=P1=zed'.??
'passthrough|PT' (移交給下一個處理器 pass through)
此標記強制重寫引擎將內(nèi)部結(jié)構(gòu)request_rec中的uri字段設(shè)置為 filename字段的值,它只是一個小修改,使之能對來自其他URI到文件名翻譯器的 Alias,ScriptAlias, Redirect 等指令的輸出進行后續(xù)處理。舉一個能說明其含義的例子: 如果要通過mod_rewrite的重寫引擎重寫/abc為/def,然后通過mod_alias使/def轉(zhuǎn)變?yōu)?ghi,可以這樣:??
RewriteRule ^/abc(.*) /def$1 [PT]
Alias /def /ghi??
如果省略了PT標記,雖然mod_rewrite運作正常, 即, 作為一個使用API的URI到文件名翻譯器,它可以重寫uri=/abc/...為filename=/def/...,但是,后續(xù)的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' (跳過后繼的規(guī)則 skip)
此標記強制重寫引擎跳過當前匹配規(guī)則后繼的num個規(guī)則。 它可以實現(xiàn)一個偽if-then-else的構(gòu)造: 最后一個規(guī)則是then從句,而被跳過的skip=N個規(guī)則是else從句. (它和'chain|C'標記是不同的!)??
'env|E=VAR:VAL' (設(shè)置環(huán)境變量 environment variable)
此標記使環(huán)境變量VAR的值為VAL, VAL可以包含可擴展的反向引用的正則表達式$N和%N。 此標記可以多次使用以設(shè)置多個變量。這些變量可以在其后許多情況下被間接引用,但通常是在XSSI (via <!--#echo var="VAR"-->) or CGI (如 $ENV{'VAR'})中, 也可以在后繼的RewriteCond指令的pattern中通過%{ENV:VAR}作引用。使用它可以從URL中剝離并記住一些信息。??
'cookie|CO=NAME:VAL:domain[:lifetime[:path]]' (設(shè)置cookie)
它在客戶端瀏覽器上設(shè)置一個cookie。 cookie的名稱是NAME,其值是VAL。 domain字段是該cookie的域,比如'.apache.org', 可選的lifetime是cookie生命期的分鐘數(shù), 可選的path是cookie的路徑。??
注意
絕不要忘記,在服務器級配置文件中,Pattern是作用于整個URL的。 但是在目錄級配置文件中, (一般總是和特定目錄名稱相同的)目錄前綴會在pattern匹配時被自動刪除, 而又在替換完畢后自動被加上。此特性對很多種重寫是必須的,因為,如果沒有這個剝離前綴的動作,就必須與其父目錄去匹配,而這并不總是可行的。??
但是有一個例外: 如果替換串以``http://''開頭, 則不會附加目錄前綴, 而是強制產(chǎn)生一個外部重定向,或者(如果使用了P標記)是一個代理操作!
注意
為了對目錄級配置啟用重寫引擎,你必須在這些文件中設(shè)置``RewriteEngine On'', 并且打開``Options FollowSymLinks'。 如果管理員對用戶目錄禁用了FollowSymLinks, 則無法使用重寫引擎。這個限制是為了安全而設(shè)置的。??
以下是所有可能的替換組合及其含義:
在服務器級配置中(httpd.conf)
,對這樣一個請求 ``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
??
在/somepath的目錄級配置中
(即, 目錄/physical/path/to/somepath的.htaccess文件中包含 RewriteBase /somepath)
對這樣一個請求``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
??
舉例:
要重寫這種形式的URL
/ Language /~ Realname /.../ File??
為
/u/ Username /.../ File . Language??
可以把這樣的對應關(guān)系保存在/path/to/file/map.txt映射文件中, 此后,只要在Apache服務器配置文件中增加下列行,即可:
RewriteLog? ?/path/to/file/rewrite.log
RewriteMap? ?real-to-user? ?? ?? ?? ?? ?txt:/path/to/file/map.txt
RewriteRule??^/([^/]+)/~([^/]+)/(.*)$? ?/u/${real-to-user2|nobody}/$3.$1