From 6beeb1b708550be0d4a53b272283e17e5e35fe17 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 7 Apr 2024 17:01:30 +0200 Subject: Adding upstream version 2.4.57. Signed-off-by: Daniel Baumann --- docs/manual/handler.html.en | 182 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 182 insertions(+) create mode 100644 docs/manual/handler.html.en (limited to 'docs/manual/handler.html.en') diff --git a/docs/manual/handler.html.en b/docs/manual/handler.html.en new file mode 100644 index 0000000..231d6fc --- /dev/null +++ b/docs/manual/handler.html.en @@ -0,0 +1,182 @@ + + + + + +Apache's Handler Use - Apache HTTP Server Version 2.4 + + + + + + + +
<-
+

Apache's Handler Use

+
+

Available Languages:  en  | + es  | + fr  | + ja  | + ko  | + tr  | + zh-cn 

+
+ +

This document describes the use of Apache's Handlers.

+
+ +
top
+
+

What is a Handler

+ + + + +

A "handler" is an internal Apache representation of the + action to be performed when a file is called. Generally, files + have implicit handlers, based on the file type. Normally, all + files are simply served by the server, but certain file types + are "handled" separately.

+ +

Handlers may also be configured explicitly, + based on either filename extensions or on location, + without relation to file type. This is + advantageous both because it is a more elegant solution, and + because it also allows for both a type and a + handler to be associated with a file. (See also Files with Multiple + Extensions.)

+ +

Handlers can either be built into the server or included in + a module, or they can be added with the Action directive. The + built-in handlers in the standard distribution are as + follows:

+ +
    +
  • default-handler: Send the file using the + default_handler(), which is the handler used by + default to handle static content. (core)
  • + +
  • send-as-is: Send file with HTTP headers + as is. (mod_asis)
  • + +
  • cgi-script: Treat the file as a CGI + script. (mod_cgi)
  • + +
  • imap-file: Parse as an imagemap rule + file. (mod_imagemap)
  • + +
  • server-info: Get the server's + configuration information. (mod_info)
  • + +
  • server-status: Get the server's status + report. (mod_status)
  • + +
  • type-map: Parse as a type map file for + content negotiation. (mod_negotiation)
  • +
+
top
+
+

Examples

+ + +

Modifying static content using a CGI script

+ + +

The following directives will cause requests for files with + the html extension to trigger the launch of the + footer.pl CGI script.

+ +
Action add-footer /cgi-bin/footer.pl
+AddHandler add-footer .html
+ + +

Then the CGI script is responsible for sending the + originally requested document (pointed to by the + PATH_TRANSLATED environment variable) and making + whatever modifications or additions are desired.

+ + +

Files with HTTP headers

+ + +

The following directives will enable the + send-as-is handler, which is used for files which + contain their own HTTP headers. All files in the + /web/htdocs/asis/ directory will be processed by + the send-as-is handler, regardless of their + filename extensions.

+ +
<Directory "/web/htdocs/asis">
+    SetHandler send-as-is
+</Directory>
+ + + +
top
+
+

Programmer's Note

+ + +

In order to implement the handler features, an addition has + been made to the Apache API that + you may wish to make use of. Specifically, a new record has + been added to the request_rec structure:

+ +
char *handler
+ + +

If you wish to have your module engage a handler, you need + only to set r->handler to the name of the + handler at any time prior to the invoke_handler + stage of the request. Handlers are implemented as they were + before, albeit using the handler name instead of a content + type. While it is not necessary, the naming convention for + handlers is to use a dash-separated word, with no slashes, so + as to not invade the media type name-space.

+
+
+

Available Languages:  en  | + es  | + fr  | + ja  | + ko  | + tr  | + zh-cn 

+
top

Comments

Notice:
This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Libera.chat, or sent to our mailing lists.
+
+ \ No newline at end of file -- cgit v1.2.3