From: André Malo Date: Fri, 15 Oct 2004 22:48:45 +0000 (+0000) Subject: update transformation X-Git-Tag: 2.1.1~137 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=5893baf3a7b31b4dd8b5f59a80e5c9f31b37e29b;p=thirdparty%2Fapache%2Fhttpd.git update transformation git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@105473 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/manual/mod/mod_filter.html.en b/docs/manual/mod/mod_filter.html.en index a03b16ae5d9..8eabc5c6385 100644 --- a/docs/manual/mod/mod_filter.html.en +++ b/docs/manual/mod/mod_filter.html.en @@ -27,21 +27,20 @@ Status:Extension Module Identifier:filter_module Source File:mod_filter.c -Compatibility:Apache 2.0 and higher +Compatibility:Version 2.1 and higher

Summary

-

This module enables smart, context-sensitive configuration of -output content filters. For example, apache can be configured to -process different content-types through different filters, even -when the content-type is not known in advance (e.g. in a proxy). -

-

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). -

+

This module enables smart, context-sensitive configuration of + output content filters. For example, apache can be configured to + process different content-types through different filters, even + when the content-type is not known in advance (e.g. in a proxy).

+ +

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).

Directives

top

FilterProtocol Directive

- +
Description:Deal with correct HTTP protocol handling
Syntax:FilterProtocol filter-name [provider-name] "proto-flags"
Syntax:FilterProtocol filter-name [provider-name] + proto-flags
Context:server config, virtual host, directory, .htaccess
Status:Extension
Module:mod_filter
-

This directs mod_filter to deal with ensuring the filter doesn't run -when it shouldn't, and that the HTTP response headers are correctly set -taking into account the effects of the filter.

-

There are two forms of this directive. With three arguments, it -applies specifically to a filter-name and a provider for that filter. -With two arguments it applies to a filter-name whenever the filter runs -any provider.

-

proto-flags is one or more of

-
-
change=yes
-
The filter changes the content, including possibly the content length
-
change=1:1
-
The filter changes the content, but will not change the content length
-
byteranges=no
-
The filter cannot work on byteranges and requires complete input
-
proxy=no
-
The filter should not run in a proxy context
-
proxy=transform
-
The filter transforms the response in a manner incompatible with -the HTTP Cache-Control: no-transform header.
-
cache=no
-
The filter renders the output uncacheable (eg by introducing randomised -content changes)
-
+

This directs mod_filter to deal with ensuring the + filter doesn't run when it shouldn't, and that the HTTP response + headers are correctly set taking into account the effects of the + filter.

+ +

There are two forms of this directive. With three arguments, it + applies specifically to a filter-name and a + provider-name for that filter. + With two arguments it applies to a filter-name whenever the + filter runs any provider.

+ +

proto-flags is one or more of

+ +
+
change=yes
+
The filter changes the content, including possibly the content + length
+ +
change=1:1
+
The filter changes the content, but will not change the content + length
+ +
byteranges=no
+
The filter cannot work on byteranges and requires complete input
+ +
proxy=no
+
The filter should not run in a proxy context
+ +
proxy=transform
+
The filter transforms the response in a manner incompatible with + the HTTP Cache-Control: no-transform header.
+ +
cache=no
+
The filter renders the output uncacheable (eg by introducing randomised + content changes)
+
top

FilterProvider Directive

- +
Description:Register a content filter
Syntax:FilterProvider filter-name provider-name match
Syntax:FilterProvider filter-name provider-name + match
Context:server config, virtual host, directory, .htaccess
Status:Extension
Module:mod_filter
-

This directive registers a provider for the smart filter. -The provider will be called if and only if the match declared -here matches the value of the header or environment variable declared -as dispatch in the FilterDeclare -directive that declared filter-name.

-

filter-name must have been declared with -FilterDeclare. provider-name must have -been registered by loading a module that registers the name with -ap_register_output_filter.

-

The match argument specifies a match that will be applied to -the filter's dispatch criterion. The match may be a string -match (exact match or substring), a regexp, an integer (greater, lessthan -or equals), or unconditional. The first characters of the match -argument determines this:

-

First, if the first character is an exclamation mark -!, this reverses the rule, so the provider will be used -if and only if the match fails.

-

Second, it interprets the first character excluding -any leading ! as follows:

-
-
default
-
exact match
-
$
-
substring match
-
/
-
regexp match
-
=
-
integer equality
-
<
-
integer less-than
-
>
-
integer greater-than
-
*
-
Unconditional match
-
+

This directive registers a provider for the smart filter. + The provider will be called if and only if the match declared + here matches the value of the header or environment variable declared + as dispatch in the FilterDeclare directive that declared + filter-name.

+ +

filter-name must have been declared with + FilterDeclare. + provider-name must have been registered by loading + a module that registers the name with + ap_register_output_filter.

+ +

The match argument specifies a match that will be applied to + the filter's dispatch criterion. The match may be + a string match (exact match or substring), a regexp, an integer (greater, + lessthan or equals), or unconditional. The first characters of the + match argument determines this:

+ +

First, if the first character is an exclamation mark + (!), this reverses the rule, so the provider will be used + if and only if the match fails.

+ +

Second, it interprets the first character excluding + any leading ! as follows:

+ + + + + + + + + +
CharacterDescription
(none)exact match
$substring match
/regexp match
=integer equality
<integer less-than
>integer greater-than
*Unconditional match
top

FilterTrace Directive

- - + +
Description:Get debug/diagnostic information from mod_filter
Syntax:FilterTrace filter-name level
Description:Get debug/diagnostic information from + mod_filter
Syntax:FilterTrace filter-name level
Context:server config, virtual host, directory, .htaccess
Status:Extension
Module:mod_filter
-

This directive generates debug information from mod_filter. -It is designed to help test and debug providers (filter modules), although -it may also help with mod_filter itself.

-

The debug output depends on the level set:

-
-
0 (default)
-
No debug information is generated.
-
1
-
mod_filter will record buckets and brigades passing through the filter -to the error log, before the provider has processed them. -This is similar to the information generated by -mod_diagnostics. -
-
2 (not yet implemented)
-
Will dump the full data passing through to a tempfile before the provider. -For single-user debug only; this will not -support concurrent hits.
-
+

This directive generates debug information from + mod_filter. + It is designed to help test and debug providers (filter modules), although + it may also help with mod_filter itself.

+ +

The debug output depends on the level set:

+
+
0 (default)
+
No debug information is generated.
+ +
1
+
mod_filter will record buckets and brigades + passing through the filter to the error log, before the provider has + processed them. This is similar to the information generated by + mod_diagnostics. +
+ +
2 (not yet implemented)
+
Will dump the full data passing through to a tempfile before the + provider. For single-user debug only; this will not + support concurrent hits.
+
diff --git a/docs/manual/mod/quickreference.html.de b/docs/manual/mod/quickreference.html.de index e00c6b11e88..bb8275de416 100644 --- a/docs/manual/mod/quickreference.html.de +++ b/docs/manual/mod/quickreference.html.de @@ -325,13 +325,15 @@ ETag verwendet werden beziehen <FilesMatch regex> ... </FilesMatch>svdhCEnthält Direktiven, die für Dateinamen gelten, die auf einen regulären Ausdruck passen -FilterChain ([+=-@!]filter-name)+svdhEConfigure the filter chain +FilterChain [+=-@!]filter-name ...svdhEConfigure the filter chain FilterDeclare filter-name [req|resp|env]=dispatch -[type] -svdhEDeclare a smart filter -FilterProtocol filter-name [provider-name] "proto-flags"svdhEDeal with correct HTTP protocol handling -FilterProvider filter-name provider-name matchsvdhERegister a content filter -FilterTrace filter-name levelsvdhEGet debug/diagnostic information from mod_filter + [type]svdhEDeclare a smart filter +FilterProtocol filter-name [provider-name] + proto-flagssvdhEDeal with correct HTTP protocol handling +FilterProvider filter-name provider-name + matchsvdhERegister a content filter +FilterTrace filter-name levelsvdhEGet debug/diagnostic information from + mod_filter ForceLanguagePriority None|Prefer|Fallback [Prefer|Fallback] Prefer svdhBAction to take if a single acceptable document is not found ForceType MIME-Type|NonedhCErzwingt die Auslieferung aller passendenden Dateien mit dem diff --git a/docs/manual/mod/quickreference.html.en b/docs/manual/mod/quickreference.html.en index b55c7f2b499..2fcdcd4131e 100644 --- a/docs/manual/mod/quickreference.html.en +++ b/docs/manual/mod/quickreference.html.en @@ -318,13 +318,15 @@ HTTP response header filenames <FilesMatch regex> ... </FilesMatch>svdhCContains directives that apply to regular-expression matched filenames -FilterChain ([+=-@!]filter-name)+svdhEConfigure the filter chain +FilterChain [+=-@!]filter-name ...svdhEConfigure the filter chain FilterDeclare filter-name [req|resp|env]=dispatch -[type] -svdhEDeclare a smart filter -FilterProtocol filter-name [provider-name] "proto-flags"svdhEDeal with correct HTTP protocol handling -FilterProvider filter-name provider-name matchsvdhERegister a content filter -FilterTrace filter-name levelsvdhEGet debug/diagnostic information from mod_filter + [type]svdhEDeclare a smart filter +FilterProtocol filter-name [provider-name] + proto-flagssvdhEDeal with correct HTTP protocol handling +FilterProvider filter-name provider-name + matchsvdhERegister a content filter +FilterTrace filter-name levelsvdhEGet debug/diagnostic information from + mod_filter ForceLanguagePriority None|Prefer|Fallback [Prefer|Fallback] Prefer svdhBAction to take if a single acceptable document is not found ForceType MIME-type|NonedhCForces all matching files to be served with the specified diff --git a/docs/manual/mod/quickreference.html.es b/docs/manual/mod/quickreference.html.es index a2c8ce5fcbd..1424938a3aa 100644 --- a/docs/manual/mod/quickreference.html.es +++ b/docs/manual/mod/quickreference.html.es @@ -321,13 +321,15 @@ HTTP response header filenames <FilesMatch regex> ... </FilesMatch>svdhCContains directives that apply to regular-expression matched filenames -FilterChain ([+=-@!]filter-name)+svdhEConfigure the filter chain +FilterChain [+=-@!]filter-name ...svdhEConfigure the filter chain FilterDeclare filter-name [req|resp|env]=dispatch -[type] -svdhEDeclare a smart filter -FilterProtocol filter-name [provider-name] "proto-flags"svdhEDeal with correct HTTP protocol handling -FilterProvider filter-name provider-name matchsvdhERegister a content filter -FilterTrace filter-name levelsvdhEGet debug/diagnostic information from mod_filter + [type]svdhEDeclare a smart filter +FilterProtocol filter-name [provider-name] + proto-flagssvdhEDeal with correct HTTP protocol handling +FilterProvider filter-name provider-name + matchsvdhERegister a content filter +FilterTrace filter-name levelsvdhEGet debug/diagnostic information from + mod_filter ForceLanguagePriority None|Prefer|Fallback [Prefer|Fallback] Prefer svdhBAction to take if a single acceptable document is not found ForceType MIME-type|NonedhCForces all matching files to be served with the specified diff --git a/docs/manual/mod/quickreference.html.ja.euc-jp b/docs/manual/mod/quickreference.html.ja.euc-jp index 4ae8e5646c2..58d8b30954c 100644 --- a/docs/manual/mod/quickreference.html.ja.euc-jp +++ b/docs/manual/mod/quickreference.html.ja.euc-jp @@ -301,13 +301,15 @@ API <Files filename> ... </Files>svdhC¥Þ¥Ã¥Á¤¹¤ë¥Õ¥¡¥¤¥ë̾¤ËŬÍѤµ¤ì¤ë¥Ç¥£¥ì¥¯¥Æ¥£¥Ö¤ò°Ï¤à <FilesMatch regex> ... </FilesMatch>svdhCÀµµ¬É½¸½¤Ë¥Þ¥Ã¥Á¤¹¤ë¥Õ¥¡¥¤¥ë̾¤ËŬÍѤµ¤ì¤ë ¥Ç¥£¥ì¥¯¥Æ¥£¥Ö¤ò°Ï¤à -FilterChain ([+=-@!]filter-name)+svdhEConfigure the filter chain +FilterChain [+=-@!]filter-name ...svdhEConfigure the filter chain FilterDeclare filter-name [req|resp|env]=dispatch -[type] -svdhEDeclare a smart filter -FilterProtocol filter-name [provider-name] "proto-flags"svdhEDeal with correct HTTP protocol handling -FilterProvider filter-name provider-name matchsvdhERegister a content filter -FilterTrace filter-name levelsvdhEGet debug/diagnostic information from mod_filter + [type]svdhEDeclare a smart filter +FilterProtocol filter-name [provider-name] + proto-flagssvdhEDeal with correct HTTP protocol handling +FilterProvider filter-name provider-name + matchsvdhERegister a content filter +FilterTrace filter-name levelsvdhEGet debug/diagnostic information from + mod_filter ForceLanguagePriority None|Prefer|Fallback [Prefer|Fallback] Prefer svdhBÍ×µá¤Ë¹ç¤¦Ã±ÆȤΥɥ­¥å¥á¥ó¥È¤¬¸«¤Ä¤«¤é¤Ê¤«¤Ã¤¿¤È¤­¤Ë¹Ô¤Ê¤¦¤³¤È¤ò»ØÄê ForceType MIME-type|NonedhC¤¹¤Ù¤Æ¤Î¥Þ¥Ã¥Á¤¹¤ë¥Õ¥¡¥¤¥ë¤¬»ØÄê¤Î MIME ¥³¥ó¥Æ¥ó¥È¥¿¥¤¥×¤Ç diff --git a/docs/manual/mod/quickreference.html.ko.euc-kr b/docs/manual/mod/quickreference.html.ko.euc-kr index 24b7625d684..576d5f83122 100644 --- a/docs/manual/mod/quickreference.html.ko.euc-kr +++ b/docs/manual/mod/quickreference.html.ko.euc-kr @@ -277,13 +277,15 @@ HTTP response header filenames <FilesMatch regex> ... </FilesMatch>svdhCContains directives that apply to regular-expression matched filenames -FilterChain ([+=-@!]filter-name)+svdhEConfigure the filter chain +FilterChain [+=-@!]filter-name ...svdhEConfigure the filter chain FilterDeclare filter-name [req|resp|env]=dispatch -[type] -svdhEDeclare a smart filter -FilterProtocol filter-name [provider-name] "proto-flags"svdhEDeal with correct HTTP protocol handling -FilterProvider filter-name provider-name matchsvdhERegister a content filter -FilterTrace filter-name levelsvdhEGet debug/diagnostic information from mod_filter + [type]svdhEDeclare a smart filter +FilterProtocol filter-name [provider-name] + proto-flagssvdhEDeal with correct HTTP protocol handling +FilterProvider filter-name provider-name + matchsvdhERegister a content filter +FilterTrace filter-name levelsvdhEGet debug/diagnostic information from + mod_filter ForceLanguagePriority None|Prefer|Fallback [Prefer|Fallback] Prefer svdhBAction to take if a single acceptable document is not found ForceType MIME-type|NonedhCForces all matching files to be served with the specified