Apache 模块 mod_filter

智能过滤

在传统的过滤模型中，过滤器使用 AddOutputFilter 及其系列无条件地插入。然后，每个过滤器都需要确定是否运行，并且服务器管理员几乎没有灵活性来允许动态配置链。

mod_filter 相反，它为服务器管理员提供了极大的灵活性来配置过滤器链。实际上，过滤器可以基于复杂的布尔 表达式 插入，这概括了 AddOutputFilterByType 提供的有限灵活性。

过滤器声明、提供程序和链

图 1: 传统的过滤器模型

在传统模型中，输出过滤器是从内容生成器（处理程序）到客户端的简单链。只要可以正确配置过滤器链，这就可以很好地工作，但在过滤器需要根据处理程序的结果动态配置时会遇到问题。

图 2: mod_filter 模型

mod_filter 通过在过滤器链中引入间接寻址来实现。我们不是将过滤器插入链中，而是插入一个过滤器处理程序，该处理程序反过来根据条件分派到过滤器提供程序。任何内容过滤器都可以用作 mod_filter 的提供程序；不需要对现有过滤器模块进行任何更改（尽管可能可以简化它们）。一个过滤器可以有多个提供程序，但对于任何单个请求，最多只有一个提供程序会运行。

过滤器链包含任意数量的过滤器处理程序实例，每个实例可以具有任意数量的提供程序。一个特例是只有一个提供程序且分派无条件：这等效于将提供程序过滤器直接插入链中。

配置链

使用 mod_filter 配置过滤器链有三个阶段。有关指令的详细信息，请参见下文。

声明过滤器

FilterDeclare 指令声明一个过滤器，为其分配一个名称和过滤器类型。仅当过滤器不是默认类型 AP_FTYPE_RESOURCE 时才需要。

注册提供程序

FilterProvider 指令将提供程序注册到过滤器。过滤器可能已使用 FilterDeclare 声明；如果没有，FilterProvider 将隐式地使用默认类型 AP_FTYPE_RESOURCE 声明它。提供程序必须已使用 ap_register_output_filter 由某个模块注册。FilterProvider 的最后一个参数是一个表达式：当且仅当表达式计算结果为真时，提供程序才会被选中以针对请求运行。表达式可以计算 HTTP 请求或响应标头、环境变量或此请求使用的处理程序。与早期版本不同，mod_filter 现在支持包含使用 AND / OR 逻辑（&& / ||）和括号的多个条件的复杂表达式。表达式语法的详细信息在 ap_expr 文档 中描述。

配置链

上面的指令构建了智能过滤器链的组件，但没有配置它运行。 FilterChain 指令从声明的智能过滤器构建过滤器链，提供在链的开头或结尾插入过滤器、删除过滤器或清除链的灵活性。

过滤和响应状态

mod_filter 通常只对 HTTP 状态为 200（OK）的响应运行过滤器。如果你想过滤具有其他响应状态的文档，你可以设置 filter-errordocs 环境变量，它将对所有响应（无论状态如何）起作用。为了进一步细化这一点，你可以使用 FilterProvider 的表达式条件。

从 Apache HTTP 服务器 2.2 配置升级

FilterProvider 指令已从 httpd 2.2 中更改：match 和 dispatch 参数被单个但更通用的 expression 替换。通常，你可以将匹配/分派对转换为表达式的两侧，使用类似于以下内容：

请求标头、响应标头和环境变量现在分别从语法 %{req:foo}、%{resp:foo} 和 %{env:foo} 中解释。变量 %{HANDLER} 和 %{CONTENT_TYPE} 也受支持。

请注意，匹配不再支持子字符串匹配。它们可以用正则表达式匹配替换。

示例

服务器端包含 (SSI)

替换 AddOutputFilterByType 的一个简单案例

FilterDeclare SSI
FilterProvider SSI INCLUDES "%{CONTENT_TYPE} =~ m|^text/html|"
FilterChain SSI

服务器端包含 (SSI)

与上面相同，但根据处理程序分派（经典 SSI 行为；.shtml 文件被处理）。

FilterProvider SSI INCLUDES "%{HANDLER} = 'server-parsed'"
FilterChain SSI

使用 mod_deflate 模拟 mod_gzip

仅当 "gzip" 不在 Accept-Encoding 标头中时才插入 INFLATE 过滤器。此过滤器使用 ftype CONTENT_SET 运行。

FilterDeclare gzip CONTENT_SET
FilterProvider gzip inflate "%{req:Accept-Encoding} !~ /gzip/"
FilterChain gzip

图像降采样

假设我们想对所有网页图像进行降采样，并为 GIF、JPEG 和 PNG 提供过滤器。

FilterProvider unpack jpeg_unpack "%{CONTENT_TYPE} = 'image/jpeg'"
FilterProvider unpack gif_unpack  "%{CONTENT_TYPE} = 'image/gif'"
FilterProvider unpack png_unpack  "%{CONTENT_TYPE} = 'image/png'"

FilterProvider downsample downsample_filter "%{CONTENT_TYPE} = m|^image/(jpeg|gif|png)|"
FilterProtocol downsample "change=yes"

FilterProvider repack jpeg_pack "%{CONTENT_TYPE} = 'image/jpeg'"
FilterProvider repack gif_pack  "%{CONTENT_TYPE} = 'image/gif'"
FilterProvider repack png_pack  "%{CONTENT_TYPE} = 'image/png'"
<Location "/image-filter">
    FilterChain unpack downsample repack
</Location>

协议处理

从历史上看，每个过滤器都负责确保它所做的任何更改都正确地反映在 HTTP 响应标头中，并且它不会在进行非法更改时运行。这给过滤器作者带来了负担，要求他们在每个过滤器中重新实现一些常见的功能

• 许多过滤器会更改内容，使现有的内容标签、校验和、哈希和长度失效。
• 需要完整、不间断的响应作为输入的过滤器需要确保它们不会从后端获取字节范围。
• 在过滤器中转换输出的过滤器需要确保它们不会违反来自后端的 Cache-Control: no-transform 标头。
• 过滤器可能会使响应不可缓存。

mod_filter 旨在为这些过滤器实现细节提供通用处理，从而降低内容过滤器模块所需的复杂性。这正在进行中；FilterProtocol 为与 Apache 2.0 模块的向后兼容性实现了一些此功能。对于 httpd 2.1 及更高版本，ap_register_output_filter_protocol 和 ap_filter_protocol API 使过滤器模块能够声明自己的行为。

同时，mod_filter 不应干扰想要处理所有协议方面的过滤器。默认情况下（即在没有任何 FilterProtocol 指令的情况下），mod_filter 将保持标头不变。

在撰写本文时，此功能在很大程度上未经测试，因为常用模块被设计为与 2.0 一起使用。使用它的模块应该仔细测试它。