Apache::Response - Perl API for Apache HTTP request response methods
use Apache::Response (); $r->custom_response(Apache::FORBIDDEN, "No Entry today"); $etag = $r->make_etag($force_weak); $r->set_etag(); $status = $r->meets_conditions(); $mtime_rat = $r->rationalize_mtime($mtime); $r->set_last_modified($mtime); $r->update_mtime($mtime); $r->send_cgi_header($buffer); $r->set_content_length($length); $ret = $r->set_keepalive();
Apache::Response provides the Apache request object utilities API for dealing with HTTP response generation process.
Apache::Response
Apache::Response provides the following functions and/or methods:
custom_response
Install a custom response handler for a given status
$r->custom_response($status, $string);
$r
Apache::RequestRec object
The current request
$status
Apache::Const constant
The status for which the custom response should be used (e.g. Apache::AUTH_REQUIRED)
Apache::AUTH_REQUIRED
$string
The custom response to use. This can be a static string, or a URL, full or just the uri path (/foo/bar.txt).
custom_response() doesn't alter the response code, but is used to replace the standard response body. For example, here is how to change the response body for the access handler failure:
custom_response()
package MyApache::MyShop; use Apache::Response (); use Apache::Const -compile => qw(FORBIDDEN OK); sub access { my $r = shift; if (MyApache::MyShop::tired_squirrels()) { $r->custom_response(Apache::FORBIDDEN, "It's siesta time, please try later"); return Apache::FORBIDDEN; } return Apache::OK; } ... # httpd.conf PerlModule MyApache::MyShop <Location /TestAPI__custom_response> AuthName dummy AuthType none PerlAccessHandler MyApache::MyShop::access PerlResponseHandler MyApache::MyShop::response </Location>
When squirrels can't run any more, the handler will return 403, with the custom message:
It's siesta time, please try later
make_etag
Construct an entity tag from the resource information. If it's a real file, build in some of the file characteristics.
$etag = $r->make_etag($force_weak);
$force_weak
Force the entity tag to be weak - it could be modified again in as short an interval.
$etag
The entity tag
meets_conditions
Implements condition GET rules for HTTP/1.1 specification. This function inspects the client headers and determines if the response fulfills the specified requirements.
GET
$status = $r->meets_conditions();
Apache::Const status constant
Apache::OK if the response fulfills the condition GET rules. Otherwise some other status code (which should be returned to Apache).
Apache::OK
Refer to the Generating Correct HTTP Headers document for an indepth discussion of this method.
rationalize_mtime
Return the latest rational time from a request/mtime pair.
$mtime_rat = $r->rationalize_mtime($mtime);
$mtime
The last modified time
$mtime_rat
the latest rational time from a request/mtime pair. Mtime is returned unless it's in the future, in which case we return the current time.
send_cgi_header
Parse the header
$r->send_cgi_header($buffer);
$buffer
headers and optionally a response body
This method is really for back-compatibility with mod_perl 1.0. It's very inefficient to send headers this way, because of the parsing overhead.
If there is a response body following the headers it'll be handled too (as if it was sent via print()).
print()
Notice that if only HTTP headers are included they won't be sent until some body is sent (again the "send" part is retained from the mod_perl 1.0 method).
set_content_length
Set the content length for this request.
$r->set_content_length($length);
$length
The new content length
set_etag
Set the E-tag outgoing header
$r->set_etag();
set_keepalive
Set the keepalive status for this request
$ret = $r->set_keepalive();
$ret
true if keepalive can be set, false otherwise
It's called by ap_http_header_filter(). For the complete complicated logic implemented by this method see httpd-2.0/server/http_protocol.c.
ap_http_header_filter()
set_last_modified
sets the Last-Modified response header field to the value of the mtime field in the request structure -- rationalized to keep it from being in the future.
Last-Modified
$r->set_last_modified($mtime);
if the $mtime argument is passed, $r->update_mtime will be first run with that argument.
update_mtime
Set the $r->mtime field to the specified value if it's later than what's already there.
$r->mtime
$r->update_mtime($mtime);
See also: $r->set_last_modified.
Apache::Response also provides auto-generated Perl interface for a few other methods which aren't tested at the moment and therefore their API is a subject to change. These methods will be finalized later as a need arises. If you want to rely on any of the following methods please contact the the mod_perl development mailing list so we can help each other take the steps necessary to shift the method to an officially supported API.
send_error_response
Send an "error" response back to client. It is used for any response that can be generated by the server from the request record. This includes all 204 (no content), 3xx (redirect), 4xx (client error), and 5xx (server error) messages that have not been redirected to another handler via the ErrorDocument feature.
$r->send_error_response($recursive_error);
$recursive_error
the error status in case we get an error in the process of trying to deal with an ErrorDocument to handle some other error. In that case, we print the default report for the first thing that went wrong, and more briefly report on the problem with the ErrorDocument.
ErrorDocument
META: it's really an internal Apache method, I'm not quite sure how can it be used externally.
send_mmap
META: Autogenerated - needs to be reviewed/completed
Send an MMAP'ed file to the client
$ret = $r->send_mmap($mm, $offset, $length);
$mm
APR::Mmap
The MMAP'ed file to send
$offset
The offset into the MMAP to start sending
The amount of data to send
The number of bytes sent
META: requires a working APR::Mmap, which is not supported at the moment.
mod_perl 2.0 documentation.
mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 2.0.
The mod_perl development team and numerous contributors.
To install mod_perl, copy and paste the appropriate command in to your terminal.
cpanm
cpanm mod_perl
CPAN shell
perl -MCPAN -e shell install mod_perl
For more information on module installation, please visit the detailed CPAN module installation guide.