Apache HTTP Server 中的運算式

以巴科斯諾爾範式表示的語法

白科斯-諾爾範式 (BNF) 是一種針對無上下文語法的表示技術，通常用於界定在運算中所使用語言的語法。在絕大多數情況下，會使用表達式來表示布林值。因此，BNF 中的起點是 expr。不過，有一些指令（例如 LogMessage）會呼叫評估為字串值的表達式。對於這類指令而言，BNF 中的起點是 string。

expr        ::= "true" | "false"
              | "!" expr
              | expr "&&" expr
              | expr "||" expr
              | "(" expr ")"
              | comp

comp        ::= stringcomp
              | integercomp
              | unaryop word
              | word binaryop word
              | word "in" "{" wordlist "}"
              | word "in" listfunction
              | word "=~" regex
              | word "!~" regex


stringcomp  ::= word "==" word
              | word "!=" word
              | word "<"  word
              | word "<=" word
              | word ">"  word
              | word ">=" word

integercomp ::= word "-eq" word | word "eq" word
              | word "-ne" word | word "ne" word
              | word "-lt" word | word "lt" word
              | word "-le" word | word "le" word
              | word "-gt" word | word "gt" word
              | word "-ge" word | word "ge" word

wordlist    ::= word
              | wordlist "," word

word        ::= word "." word
              | digit
              | "'" string "'"
              | """ string """
              | variable
              | rebackref
              | function

string      ::= stringpart
              | string stringpart

stringpart  ::= cstring
              | variable
              | rebackref

cstring     ::= ...
digit       ::= [0-9]+

variable    ::= "%{" varname "}"
              | "%{" funcname ":" funcargs "}"

rebackref   ::= "$" [0-9]

function     ::= funcname "(" word ")"

listfunction ::= listfuncname "(" word ")"

變數

表達式解析程式提供了許多 %{HTTP_HOST} 格式的變數。請注意，變數的值可能取決於評估此值時對應的請求處理階段。舉例來說，使用在 <If > 指令中的表達式會在驗證程序之前評估。因此，%{REMOTE_USER} 在此情況下將不會設定。

下列變數會提供已命名的 HTTP 請求標頭值。其他標頭的值可以使用 req 函數 取得。請注意，使用這些變數可能會造成標頭名稱新增至對應 HTTP 回應的 Vary 標頭中，但針對呼叫表達式的指令所做的說明除外。您可以使用 req_novary 函數 規避此行為。

其他與請求相關的變數

其他變數

有些模組會註冊其他變數，例如：mod_ssl。

二元運算子

除了內建的比較運算子，二元運算子的形式為「-[a-zA-Z][a-zA-Z0-9_]+」，也就是減號加上至少兩個字元。名稱不分大小寫。模組可以註冊其他二元運算子。

比較運算子

其他二元運算式

單元運算式

單元運算式接受一個參數，格式為「-[a-zA-Z]」，亦即減號加上一個字元。名稱會區分大小寫。模組可能會註冊其他單元運算式。

標示為「受限」的運算式在一些模組中無法使用，例如 mod_include。

函式

常規字串值函式接受字串作為參數，並傳回字串。函式名稱不區分大小寫。模組可能會註冊其他函式。

最後一欄中標記為「restricted」的功能在一些模組中不可用，例如 mod_include。

最後一欄中標記為「ordering」的功能需要考慮伺服器不同元件的排序，特別是在 <If> 指令中使用該功能時，因為該指令的評估相對較早。

當使用 req 或 http 函數時，標頭名稱將自動新增到 HTTP 回應的 Vary 標頭中，但在其接受表示式的指令中另有註解時除外。可以使用 req_novary 函數來防止名稱新增到 Vary 標頭中。

除了字串值函數之外，還有清單值函數，它會將一個字串作為引數並傳回一個文字清單，即字串清單。文字清單可用於特殊 -in 運算子。函數名稱不區分大小寫。模組可以註冊其他函數。

沒有內建的清單值函數。mod_ssl 提供 PeerExtList。詳情請參閱 SSLRequire 的說明 (但 PeerExtList 也可以在 SSLRequire 外使用)。

範例表示式

以下範例顯示如何使用表示式來評估要求

# Compare the host name to example.com and redirect to www.example.com if it matches
<If "%{HTTP_HOST} == 'example.com'">
    Redirect permanent "/" "http://www.example.com/"
</If>

# Force text/plain if requesting a file with the query string contains 'forcetext'
<If "%{QUERY_STRING} =~ /forcetext/">
    ForceType text/plain
</If>

# Only allow access to this content during business hours
<Directory "/foo/bar/business">
    Require expr %{TIME_HOUR} -gt 9 && %{TIME_HOUR} -lt 17
</Directory>

# Check a HTTP header for a list of values
<If "%{HTTP:X-example-header} in { 'foo', 'bar', 'baz' }">
    Header set matched true
</If>

# Check an environment variable for a regular expression, negated.
<If "! reqenv('REDIRECT_FOO') =~ /bar/">
    Header set matched true
</If>

# Check result of URI mapping by running in Directory context with -f
<Directory "/var/www">
    AddEncoding x-gzip gz
<If "-f '%{REQUEST_FILENAME}.unzipme' && ! %{HTTP:Accept-Encoding} =~ /gzip/">
      SetOutputFilter INFLATE
</If>
</Directory>

# Check against the client IP
<If "-R '192.168.1.0/24'">
    Header set matched true
</If>

# Function example in boolean context
<If "md5('foo') == 'acbd18db4cc2f85cedef654fccc4a4d8'">
  Header set checksum-matched true
</If>

# Function example in string context
Header set foo-checksum "expr=%{md5:foo}"

# This delays the evaluation of the condition clause compared to <If>
Header always set CustomHeader my-value "expr=%{REQUEST_URI} =~ m#^/special_path\.php$#"

# Conditional logging
CustomLog logs/access-errors.log common "expr=%{REQUEST_STATUS} >= 400"
CustomLog logs/access-errors-specific.log common "expr=%{REQUEST_STATUS} -in {'405','410'}"

其他

正規表示式反向參考

字串 $0 ... $9 允許參考先前執行且配對成功的正規表示式中的擷取群組。它們通常只能用在與配對正規表示式相同的表示式中，但有些模組允許特殊用途。

與 SSLRequire 比較

ap_expr 語法大部分是已棄用的指令 SSLRequire 語法的上集。相異處在 SSLRequire 的文件中進行說明。

版本記錄

req_novary 函數 可用於 2.4.4 以上的版本。