Apache 模組 mod_rewrite

RewriteBase 指示

RewriteBase 指示指定 URL 前置字首，將用於每個目錄 (htaccess) RewriteRule 指示，以替換相對路徑。

在每個目錄 (htaccess) 內容中於替換中使用相對路徑時，如果下列任一條件為真，這個指示必需使用

• 原始要求及其替換位於 DocumentRoot (而非透過其他方式存取，例如 Alias) 底下。
• 包含 RewriteRule 目錄的檔案系統路徑，後面加上相對替換，也是伺服器上的有效 URL 路徑 (這很罕見)。
• 在 Apache HTTP Server 2.4.16 及更新版本中，當要求透過 Alias 或 mod_userdir 映射時，可以省略此指示。

在下列範例中，RewriteBase 是必要的，以避免改寫成 http://example.com/opt/myapp-1.2.3/welcome.html，因為資源並非相對於文件根目錄。系統會將此錯誤組態視為在文件根目錄底下尋找「opt」目錄。

DocumentRoot "/var/www/example.com"
AliasMatch "^/myapp" "/opt/myapp-1.2.3"
<Directory "/opt/myapp-1.2.3">
    RewriteEngine On
    RewriteBase "/myapp/"
    RewriteRule "^index\.html$"  "welcome.html"
</Directory>

RewriteCond 指示

RewriteCond 指令定義規則條件。可以在 RewriteRule 指令之前，輸入一個或多個 RewriteCond。只有當目前 URI 的狀態符合其 wzor樣時才會使用下列規則，且同時符合這些條件時。

TestString 是可以包含下列展開建構的字串，除了純文字之外

• RewriteRule 回引：這些回引是 $N（0 <= N <= 9）形式的回引。$1 到 $9 可取得 vzor樣中群組部份（括號中）的存取權限，來自受目前一組 RewriteCond 條件約束的 RewriteRule。$0 可以存取那個 vzor樣所配對到的整個字串。
• RewriteCond 回引：這些回引是 %N（0 <= N <= 9）形式的回引。%1 到 %9 可取得 wzor樣中群組部份（同樣地在括號中）的存取權限，來自目前一組條件中最後一個配對到的 RewriteCond。%0 可以存取那個 vzor樣所配對到的整個字串。
• RewriteMap 擴充：這些是 ${mapname:key|default} 形式的擴充。請參閱 RewriteMap 的文件 以取得更多資訊
• 伺服器變數：這些是 %{ 變數名稱 } 形式的變數，其中 變數名稱 可以是下列清單中的字串

  HTTP 標頭	連線 & 要求
  HTTP_ACCEPT HTTP_COOKIE HTTP_FORWARDED HTTP_HOST HTTP_PROXY_CONNECTION HTTP_REFERER HTTP_USER_AGENT	AUTH_TYPE CONN_REMOTE_ADDR CONTEXT_PREFIX CONTEXT_DOCUMENT_ROOT IPV6 PATH_INFO QUERY_STRING REMOTE_ADDR REMOTE_HOST REMOTE_IDENT REMOTE_PORT REMOTE_USER REQUEST_METHOD SCRIPT_FILENAME
  伺服器內部	日期與時間	特殊事項
  DOCUMENT_ROOT SCRIPT_GROUP SCRIPT_USER SERVER_ADDR SERVER_ADMIN SERVER_NAME SERVER_PORT SERVER_PROTOCOL SERVER_SOFTWARE	TIME_YEAR TIME_MON TIME_DAY TIME_HOUR TIME_MIN TIME_SEC TIME_WDAY TIME	API_VERSION CONN_REMOTE_ADDR HTTPS IS_SUBREQ REMOTE_ADDR REQUEST_FILENAME REQUEST_SCHEME REQUEST_URI THE_REQUEST

  這些變數都和名稱相似的 HTTP MIME 標頭、Apache HTTP Server 的 C 變數或 Unix 系統的 struct tm 欄位相符。大多數在 這裡 或文件或 CGI 規格中的其他地方有記錄。

  SERVER_NAME 和 SERVER_PORT 分別視 UseCanonicalName 和 UseCanonicalPhysicalPort 的值而定。

  下列是 mod_rewrite 的特別變數。

  API_VERSION

  這是目前的 httpd 建置中 Apache httpd 模組 API 的版本（伺服器與模組之間的內部介面），如在 include/ap_mmn.h 中所定義。模組 API 版本會對應到正在使用的 Apache httpd 版本（例如 Apache httpd 1.3.14 的公開版本中是 19990320:10），但主要是讓模組作者感興趣。

  CONN_REMOTE_ADDR

  自 2.4.8 起：連線的點對點 IP 位址（請參閱 mod_remoteip 模組）。

  HTTPS

  如果連線使用 SSL/TLS，會包含文字「開啟」；否則為「關閉」。（即使沒有載入 mod_ssl，也能安全地使用此變數）。

  IS_SUBREQ

  如果目前正在處理的請求是子請求，會包含文字「真」；否則為「假」。子請求可能是由需要解析其他檔案或 URI 以完成任務的模組所產生。

  REMOTE_ADDR

  遠端主機的 IP 位址（請參閱 mod_remoteip 模組）。

  REQUEST_FILENAME

  如果伺服器在參照 REQUEST_FILENAME 時已確定檔案或指令碼與請求相符，則為其完整的本機檔案系統路徑。否則，例如在虛擬主機中使用時，其值與 REQUEST_URI 相同。根據 AcceptPathInfo 的值，伺服器可能僅使用 REQUEST_URI 的部分開頭元件將請求映射到檔案。

  REQUEST_SCHEME

  會包含該請求的架構（通常是「http」或「https」）。此值會受到 ServerName 的影響。

  REQUEST_URI

  請求的 URI 的路徑元件，例如「/index.html」。此處特別不包含查詢字串，查詢字串可用作其自己的變數，名稱為 QUERY_STRING。為 REQUEST_URI 傳回的值已進行 %-解碼，若要重新編碼，請讓它傳遞「escape」對應函數。

  THE_REQUEST

  瀏覽器傳送給伺服器的完整 HTTP 請求列（例如，「GET /index.html HTTP/1.1」）。此處不包含瀏覽器傳送的任何其他標頭。與下方大多數其他變數不同，此值未取消跳脫（解碼）。

如果 TestString 具有特殊值 expr，則 CondPattern 會視為 ap_expr。如果未提供 novary 旗標，則在指令中參照的 HTTP 標頭將會新增到 Vary 標頭。

您應該了解的其他事項

1. SCRIPT_FILENAME 和 REQUEST_FILENAME 變數包含相同的值，也就是 Apache HTTP Server 內部 request_rec 結構之 filename 欄位的數值。第一個名稱為常見的 CGI 變數名稱，而第二個名稱是 REQUEST_URI 的適當對應名稱（其中包含 request_rec 之 uri 欄位的數值）。

   如果進行取代且重寫繼續進行，這兩個變數的值都將適當地更新。

   如果在伺服器內文函脈絡中使用（例如，在請求被映射到檔案系統之前），SCRIPT_FILENAME 和 REQUEST_FILENAME 不能包含完整的本地檔案系統路徑，因為在處理的這個階段路徑是未知的。但在這種情況下，這兩個變數一開始會包含 REQUEST_URI 的值。要取得在伺服器內文函脈絡中請求的完整本地檔案系統路徑，請使用基於網址的前瞻 `%{LA-U:REQUEST_FILENAME}` 來決定 REQUEST_FILENAME 的最終值。

2. %{ENV:variable}，其中 variable 可以是任何環境變數，也可使用。這是透過內部 Apache httpd 結構查詢的，如果在其中找不到，則會透過 Apache httpd 伺服器程序的 `getenv()` 查詢。
3. %{SSL:variable}，其中 variable 是 SSL 環境變數 的名稱，可以在載入 mod_ssl 時或未載入時使用，但如果未載入時，通常會擴充為空字串。範例：%{SSL:SSL_CIPHER_USEKEYSIZE} 可能會擴充為 128。即使未設定 SSLOptions 指令的 StdEnvVars 選項，也可以使用這些變數。
4. %{HTTP:header}，其中 header 可以是任何 HTTP MIME 標題名稱，可以隨時用來取得在 HTTP 請求中送出的標題值。範例：%{HTTP:Proxy-Connection} 是 HTTP 標題 ``Proxy-Connection:'' 的值。

   如果在條件中使用了 HTTP 標題，在條件針對請求評估為 true 時，此標題會加入回應的 Vary 標題中。如果條件針對請求評估為 false，則不會加入標題。將 HTTP 標題加入回應的 Vary 標題是正確快取所需的。

   必須記住，對 'ornext|OR' 旗標而言，條件會遵循短路邏輯，因此某些條件可能不會被評估。

5. %{LA-U:variable} 可用於前瞻，前瞻會執行內部（基於網址）子請求來決定 variable 的最終值。這可以用於存取改寫變數，該變數在當前階段不可用，但會在稍後階段設定。

   例如，若要根據伺服器內文函脈絡（httpd.conf 檔）中的 REMOTE_USER 變數進行改寫，您必須使用 %{LA-U:REMOTE_USER} ― 此變數由授權階段設定，而授權階段會在網址翻譯階段（mod_rewrite 會在該階段運作）之後執行。

   另一方面，因為 mod_rewrite 透過 API 的 Fixup 階段來實作其伺服器內文函脈絡（.htaccess 檔），而且因為授權階段會在這個階段之前執行，所以您可以在該脈絡中使用 %{REMOTE_USER}。

6. %{LA-F:變數} 可用於執行內部（基於檔案名稱）的子請求，以決定變數的最終值。大多數情況下，這與上述的 LA-U 相同。

RewriteCond  "%{HTTP_USER_AGENT}"  "(iPhone|Blackberry|Android)"
RewriteRule  "^/$"                 "/homepage.mobile.html"  [L]

RewriteRule  "^/$"                 "/homepage.std.html"     [L]