Apache Module mod_filter

Smart Filtering

In the traditional filtering model, filters are inserted unconditionally using AddOutputFilter and family. Each filter then needs to determine whether to run, and there is little flexibility available for server admins to allow the chain to be configured dynamically.

mod_filter by contrast gives server administrators a great deal of flexibility in configuring the filter chain. In fact, filters can be inserted based on any Request Header, Response Header or Environment Variable. This generalises the limited flexibility offered by AddOutputFilterByType, and fixes it to work correctly with dynamic content, regardless of the content generator. The ability to dispatch based on Environment Variables offers the full flexibility of configuration with mod_rewrite to anyone who needs it.

Filter Declarations, Providers and Chains

Figure 1: The traditional filter model

In the traditional model, output filters are a simple chain from the content generator (handler) to the client. This works well provided the filter chain can be correctly configured, but presents problems when the filters need to be configured dynamically based on the outcome of the handler.

Figure 2: The mod_filter model

mod_filter works by introducing indirection into the filter chain. Instead of inserting filters in the chain, we insert a filter harness which in turn dispatches conditionally to a filter provider. Any content filter may be used as a provider to mod_filter; no change to existing filter modules is required (although it may be possible to simplify them). There can be multiple providers for one filter, but no more than one provider will run for any single request.

A filter chain comprises any number of instances of the filter harness, each of which may have any number of providers. A special case is that of a single provider with unconditional dispatch: this is equivalent to inserting the provider filter directly into the chain.

Configuring the Chain

There are three stages to configuring a filter chain with mod_filter. For details of the directives, see below.

Declare Filters

The FilterDeclare directive declares a filter, assigning it a name and filter type. Required only if the filter is not the default type AP_FTYPE_RESOURCE.

FilterDeclare ディレクティブはフィルタを宣言し、名前とフィルタ・タイプを割り当てます。 フィルタが標準タイプの AP_FTYPE_RESOURCE でない場合のみ必須です。

Register Providers

The FilterProvider directive registers a provider with a filter. The filter may have been declared with FilterDeclare; if not, FilterProvider will implicitly declare it with the default type AP_FTYPE_RESOURCE. The provider must have been registered with ap_register_output_filter by some module. The remaining arguments to FilterProvider are a dispatch criterion and a match string. The former may be an HTTP request or response header, an environment variable, or the Handler used by this request. The latter is matched to it for each request, to determine whether this provider will be used to implement the filter for this request.

FilterProvider ディレクティブはフィルタにプロバイダを登録します。 フィルタは FilterDeclare によって宣言されているかもしれません; もしそうでないなら、FilterProvider は標準タイプの AP_FTYPE_RESOURCE として宣言します。 プロバイダはいくつかのモジュールによって ap_register_output_filter で登録されていなければなりません。 FilterProvider の残りの引数はディスパッチの基準とマッチ文字列です。 前者は HTTP リクエストかレスポンスヘッダ、もしくは環境変数、またはこのリクエストによって使われるハンドラです。 後者は、各リクエストについて、マッチするかどうかで、そのリクエストに対してフィルタを実行するために、このプロバイダが使われるかどうかを判断します。

Configure the Chain

The above directives build components of a smart filter chain, but do not configure it to run. The FilterChain directive builds a filter chain from smart filters declared, offering the flexibility to insert filters at the beginning or end of the chain, remove a filter, or clear the chain.

前述のディレクティブ達はスマート・フィルタ・チェインのコンポーネントを組み立てますが、それを実行するための設定ではありません。 FilterChain ディレクティブは宣言されたスマート・フィルタからフィルタ・チェインを組み立て、チェインの最初か最後にフィルタ達を差し込むんだり、削除したり、チェインを消し去ったりするための柔軟性を提供します。

Examples

Server side Includes (SSI)

A simple case of using mod_filter in place of AddOutputFilterByType

AddOutputFilterByType の代わりに mod_filter を利用する単純なケース。

FilterDeclare SSI
FilterProvider SSI INCLUDES resp=Content-Type $text/html
FilterChain SSI

Server side Includes (SSI)

The same as the above but dispatching on handler (classic SSI behaviour; .shtml files get processed).

上記と同じながら、ハンドラによるディスパッチです(伝統的な SSI の振る舞い; .shtml ファイルが処理されます)

FilterProvider SSI INCLUDES Handler server-parsed
FilterChain SSI

Emulating mod_gzip with mod_deflate

Insert INFLATE filter only if "gzip" is NOT in the Accept-Encoding header. This filter runs with ftype CONTENT_SET.

Accept-Encoding に "gzip" が含まれない場合のみ INFLATE フィルタを差し込みます。

FilterDeclare gzip CONTENT_SET
FilterProvider gzip inflate req=Accept-Encoding !$gzip
FilterChain gzip

Image Downsampling

Suppose we want to downsample all web images, and have filters for GIF, JPEG and 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 $image
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>

Protocol Handling

Historically, each filter is responsible for ensuring that whatever changes it makes are correctly represented in the HTTP response headers, and that it does not run when it would make an illegal change. This imposes a burden on filter authors to re-implement some common functionality in every filter:

• Many filters will change the content, invalidating existing content tags, checksums, hashes, and lengths.
  多くのフィルタは、タグを削ったり、チェックサムやハッシュや長さを変えるような変更をします。
• Filters that require an entire, unbroken response in input need to ensure they don't get byteranges from a backend.
  フィルタは入力に対する壊れていないレスポンスについて、バックエンドからバイト範囲を得てはなりません。
• Filters that transform output in a filter need to ensure they don't violate a Cache-Control: no-transform header from the backend.
  フィルタはバックエンドからの Cache-Control: no-transform ヘッダに違反してはなりません。
• Filters may make responses uncacheable.
  フィルタはキャッシュできないレスポンスを作るかもしれません。

mod_filter aims to offer generic handling of these details of filter implementation, reducing the complexity required of content filter modules. This is work-in-progress; the FilterProtocol implements some of this functionality for back-compatibility with Apache 2.0 modules. For httpd 2.1 and later, the ap_register_output_filter_protocol and ap_filter_protocol API enables filter modules to declare their own behaviour.

At the same time, mod_filter should not interfere with a filter that wants to handle all aspects of the protocol. By default (i.e. in the absence of any FilterProtocol directives), mod_filter will leave the headers untouched.

At the time of writing, this feature is largely untested, as modules in common use are designed to work with 2.0. Modules using it should test it carefully.