From: André Malo Date: Wed, 13 Nov 2002 00:13:24 +0000 (+0000) Subject: - -> X-Git-Tag: 2.0.44~72 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=a171a5e55be6cd734d35b8839506bc4c184a7b20;p=apache - -> - reformatted examples (no content changes, except for a ytop) - move the reference to mod_deflate on /top/ of the gzip example - general markup improvement - add short descriptions for the directives git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@97501 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/manual/mod/mod_ext_filter.xml b/docs/manual/mod/mod_ext_filter.xml index 9cc557f25a..7ed3e1eff0 100644 --- a/docs/manual/mod/mod_ext_filter.xml +++ b/docs/manual/mod/mod_ext_filter.xml @@ -4,9 +4,8 @@ mod_ext_filter -Pass the response body - through an external program before delivery to the - client +Pass the response body through an external program before +delivery to the client Experimental mod_ext_filter.c ext_filter_module @@ -42,132 +41,164 @@ for production use, mod_ext_filter can be used as a prototype environment for filters.

- -
Examples - -
Generating HTML from some other type of response -
-# mod_ext_filter directive to define a filter to HTML-ize text/c files 
-# using the external program /usr/bin/enscript, with the type of the 
-# result set to text/html
-ExtFilterDefine c-to-html mode=output intype=text/c outtype=text/html \
-                cmd="/usr/bin/enscript --color -W html -Ec -o - -"
-
-<Directory "/export/home/trawick/apacheinst/htdocs/c">
-
-# core directive to cause the new filter to be run on output
-SetOutputFilter c-to-html
-
-# mod_mime directive to set the type of .c files to text/c
-AddType text/c .c
-
-# mod_ext_filter directive to set the debug level just high 
-# enough to see a log message per request showing the configuration
-# in force
-ExtFilterOptions DebugLevel=1
-
-</Directory>
-
 -
- -
Implementing a content encoding filter -
-# mod_ext_filter directive to define the external filter
-ExtFilterDefine gzip mode=output cmd=/bin/gzip
-
-<Location /gzipped>
-
-# core directive to cause the gzip filter to be run on output
-SetOutputFilter gzip
-
-# mod_header directive to add "Content-Encoding: gzip" header field
-Header set Content-Encoding gzip
-
-</Location>
-
 - -

Note: this gzip example is just for the purposes of illustration. - Please refer to mod_deflate for a practical - implementation.

-
- -
Slowing down the server -
-# mod_ext_filter directive to define a filter which runs everything 
-# through cat; cat doesn't modify anything; it just introduces extra
-# pathlength and consumes more resources
-ExtFilterDefine slowdown mode=output cmd=/bin/cat preservescontentlength
-
-<Location />
-
-# core directive to cause the slowdown filter to be run several times on 
-# output
-SetOutputFilter slowdown slowdown slowdown
-
-</Location>
-
 -
- -
Using sed to replace text in the response -
-# mod_ext_filter directive to define a filter which replaces text in
-# the response
-ExtFilterDefine fixtext mode=output cmd="/bin/sed s/verdana/arial/g" intype=text/html
-
-<Location />
-
-# core directive to cause the fixtext filter to be run on output
-# output
-SetOutputFilter fixtext
-
-</Location>
-
 -
- -
Tracing another filter -
-# Trace the data read and written by mod_deflate for a particular
-# client (IP 192.168.1.31) experiencing compression problems.
-# This filter will trace what goes into mod_deflate.
-ExtFilterDefine tracebefore cmd="/bin/tracefilter.pl /tmp/tracebefore" \
-  EnableEnv=trace_this_client
-# This filter will trace what goes after mod_deflate.  Note that without
-# the ftype parameter, the default filter type of AP_FTYPE_RESOURCE would
-# cause the filter to be placed *before* mod_deflate in the filter 
-# chain.  Giving it a numeric value slightly higher than 
-# AP_FTYPE_CONTENT_SET will ensure that it is placed after mod_deflate.
-ExtFilterDefine traceafter  cmd="/bin/tracefilter.pl /tmp/traceafter" \
-  EnableEnv=trace_this_client ftype=21
-
-<Directory /usr/local/docs>
-  SetEnvIf Remote_Addr 192.168.1.31 trace_this_client
-  SetOutputFilter tracebefore;deflate;traceafter
-</Directory>
-
 - -Here is the filter which traces the data: -
-#!/usr/local/bin/perl -w
-
-use strict;
-
-open(SAVE, ">$ARGV[0]") or die "can't open $ARGV[0]: $?";
-
-while (<STDIN>)
-{
-  print SAVE $_;
-  print $_;
-}
-
-close(SAVE);
-
 -
- -
+The filter documentation + +
Examples + +
Generating HTML from some other type of response + + # mod_ext_filter directive to define a filter
+ # to HTML-ize text/c files using the external
+ # program /usr/bin/enscript, with the type of
+ # the result set to text/html
+ ExtFilterDefine c-to-html mode=output \
+ + intype=text/c outtype=text/html \
+ cmd="/usr/bin/enscript --color -W html -Ec -o - -"
+ +
+ <Directory "/export/home/trawick/apacheinst/htdocs/c">
+ + # core directive to cause the new filter to
+ # be run on output
+ SetOutputFilter c-to-html
+
+ # mod_mime directive to set the type of .c
+ # files to text/c
+ AddType text/c .c
+
+ # mod_ext_filter directive to set the debug
+ # level just high enough to see a log message
+ # per request showing the configuration in force
+ ExtFilterOptions DebugLevel=1
+ + </Directory> + +
+ +
Implementing a content encoding filter +

Note: this gzip example is just for the purposes of illustration. + Please refer to mod_deflate for a practical + implementation.

+ + + # mod_ext_filter directive to define the external filter
+ ExtFilterDefine gzip mode=output cmd=/bin/gzip
+
+ <Location /gzipped>
+ + # core directive to cause the gzip filter to be
+ # run on output
+ SetOutputFilter gzip
+
+ # mod_header directive to add
+ # "Content-Encoding: gzip" header field
+ Header set Content-Encoding gzip
+ + </Location> + +
+ +
Slowing down the server + + # mod_ext_filter directive to define a filter
+ # which runs everything through cat; cat doesn't
+ # modify anything; it just introduces extra pathlength
+ # and consumes more resources
+ ExtFilterDefine slowdown mode=output cmd=/bin/cat \
+ + preservescontentlength
+ +
+ <Location />
+ + # core directive to cause the slowdown filter to
+ # be run several times on output
+ #
+ SetOutputFilter slowdown;slowdown;slowdown
+ + </Location> + +
+ +
Using sed to replace text in the response + + # mod_ext_filter directive to define a filter which
+ # replaces text in the response
+ #
+ ExtFilterDefine fixtext mode=output intype=text/html \
+ + cmd="/bin/sed s/verdana/arial/g"
+ +
+ <Location />
+ + # core directive to cause the fixtext filter to
+ # be run on output
+ SetOutputFilter fixtext
+ + </Location> + +
+ +
Tracing another filter + + # Trace the data read and written by mod_deflate
+ # for a particular client (IP 192.168.1.31)
+ # experiencing compression problems.
+ # This filter will trace what goes into mod_deflate.
+ ExtFilterDefine tracebefore \
+ + cmd="/bin/tracefilter.pl /tmp/tracebefore" \
+ EnableEnv=trace_this_client
+ +
+ # This filter will trace what goes after mod_deflate.
+ # Note that without the ftype parameter, the default
+ # filter type of AP_FTYPE_RESOURCE would cause the
+ # filter to be placed *before* mod_deflate in the filter
+ # chain. Giving it a numeric value slightly higher than
+ # AP_FTYPE_CONTENT_SET will ensure that it is placed
+ # after mod_deflate.
+ ExtFilterDefine traceafter \
+ + cmd="/bin/tracefilter.pl /tmp/traceafter" \
+ EnableEnv=trace_this_client ftype=21
+ +
+ <Directory /usr/local/docs>
+ + SetEnvIf Remote_Addr 192.168.1.31 trace_this_client
+ SetOutputFilter tracebefore;deflate;traceafter
+ + </Directory> + + + Here is the filter which traces the data: + #!/usr/local/bin/perl -w
+ use strict;
+
+ open(SAVE, ">$ARGV[0]")
+ + or die "can't open $ARGV[0]: $?";
+ +
+ while (<STDIN>) {
+ + print SAVE $_;
+ print $_;
+ + }
+
+ close(SAVE); + +
+
ExtFilterDefine -ExtFilterDefine filtername parameters +Define an external filter +ExtFilterDefine filtername parameters server config @@ -175,7 +206,7 @@ close(SAVE); characteristics of an external filter, including the program to run and its arguments.

-

filtername specifies the name of the filter being +

filtername specifies the name of the filter being defined. This name can then be used in SetOutputFilter directives. It must be unique among all registered filters. At the present time, no error is reported by the @@ -184,48 +215,48 @@ close(SAVE);

Subsequent parameters can appear in any order and define the external command to run and certain other characteristics. The - only required parameter is cmd=. These parameters + only required parameter is cmd=. These parameters are:

-
cmd=cmdline
+
cmd=cmdline
The cmd= keyword allows you to specify the external command to run. If there are arguments after the program name, the command line should be surrounded in - quotation marks (e.g., cmd="/bin/mypgm arg1 arg2". - Normal shell quoting is not necessary since the program is - run directly, bypassing the shell. Program arguments are - blank-delimited. A backslash can be used to escape blanks - which should be part of a program argument. Any backslashes - which are part of the argument must be escaped with backslash - themselves. In addition to the standard CGI environment + quotation marks (e.g., cmd="/bin/mypgm + arg1 arg2". Normal shell quoting is + not necessary since the program is run directly, bypassing the shell. + Program arguments are blank-delimited. A backslash can be used to + escape blanks which should be part of a program argument. Any + backslashes which are part of the argument must be escaped with + backslash themselves. In addition to the standard CGI environment variables, DOCUMENT_URI, DOCUMENT_PATH_INFO, and QUERY_STRING_UNESCAPED will also be set for the program.
-
mode=mode
+
mode=mode
-
mode should be output for now (the - default). In the future, mode=input will be used to +
mode should be output for now (the + default). In the future, mode=input will be used to specify a filter for request bodies.
-
intype=imt
+
intype=imt
-
This parameter specifies the internet media type (i.e., +
This parameter specifies the internet media type (i.e., MIME type) of documents which should be filtered. By default, all documents are filtered. If intype= is specified, the filter will be disabled for documents of other types.
-
outtype=imt
+
outtype=imt
-
This parameter specifies the internet media type (i.e., +
This parameter specifies the internet media type (i.e., MIME type) of filtered documents. It is useful when the filter changes the internet media type as part of the filtering operation. By default, the internet media type is unchanged.
-
PreservesContentLength
+
PreservesContentLength
The PreservesContentLength keyword specifies that the filter preserves the content length. This is not the @@ -233,7 +264,7 @@ close(SAVE); event that the filter doesn't modify the length, this keyword should be specified.
-
ftype=filtertype
+
ftype=filtertype
This parameter specifies the numeric value for filter type that the filter should be registered as. The default value, @@ -243,39 +274,38 @@ close(SAVE); the AP_FTYPE_foo definitions in util_filter.h for appropriate values.
-
disableenv=env
+
disableenv=env
This parameter specifies the name of an environment variable which, if set, will disable the filter.
-
enableenv=env
+
enableenv=env
This parameter specifies the name of an environment variable which must be set, or the filter will be disabled.
-
ExtFilterOptions -ExtFilterOptions - option [option] ... +Configure mod_ext_filter options +ExtFilterOptions option [option] ... ExtFilterOptions DebugLevel=0 NoLogStderr directory

The ExtFilterOptions directive specifies - special processing options for mod_ext_filter. - Option can be one of

+ special processing options for mod_ext_filter. + Option can be one of

-
DebugLevel=n
+
DebugLevel=n
The DebugLevel keyword allows you to specify the level of debug messages generated by - mod_ext_filter. By default, no debug messages + mod_ext_filter. By default, no debug messages are generated. This is equivalent to DebugLevel=0. With higher numbers, more debug messages are generated, and server performance will be @@ -283,12 +313,12 @@ close(SAVE); described with the definitions of the DBGLVL_ constants near the beginning of mod_ext_filter.c. -

Note: The core directive LogLevel should be used to - cause debug messages to be stored in the Apache error - log.

+

Note: The core directive LogLevel should be used to cause debug messages to + be stored in the Apache error log.

-
LogStderr | NoLogStderr
+
LogStderr | NoLogStderr
The LogStderr keyword specifies that messages written to standard error by the external filter @@ -296,9 +326,9 @@ close(SAVE); NoLogStderr disables this feature.
-Example - ExtFilterOptions LogStderr DebugLevel=0 - + Example + ExtFilterOptions LogStderr DebugLevel=0 +

Messages written to the filter's standard error will be stored in the Apache error log. No debug messages will be generated by