Apache HTTP 服务器中的表达式

巴科斯-诺尔范式语法

巴科斯-诺尔范式 (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。

函数

普通字符串值函数接受一个字符串作为参数并返回一个字符串。函数名不区分大小写。模块可以注册额外的函数。

在最后一列中标记为“受限”的函数在某些模块中不可用，例如 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 及更高版本中可用。