Apache2::Response - Perl API for Apache HTTP request response methods
use Apache2::Response (); $r->custom_response(Apache2::Const::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();
Apache2::Response provides the Apache request
object utilities API for dealing
with HTTP response generation process.
Apache2::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
( Apache2::RequestRec object )
$status ( Apache2::Const
constant )
Apache2::Const::AUTH_REQUIRED)
$string (string)
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:
package MyApache2::MyShop;
use Apache2::Response ();
use Apache2::Const -compile => qw(FORBIDDEN OK);
sub access {
my $r = shift;
if (MyApache2::MyShop::tired_squirrels()) {
$r->custom_response(Apache2::Const::FORBIDDEN,
"It's siesta time, please try later");
return Apache2::Const::FORBIDDEN;
}
return Apache2::Const::OK;
}
...
# httpd.conf
PerlModule MyApache2::MyShop
<Location /TestAPI__custom_response>
AuthName dummy
AuthType none
PerlAccessHandler MyApache2::MyShop::access
PerlResponseHandler MyApache2::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);
$r
( Apache2::RequestRec object )
$force_weak (number)
$etag (string)
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.
$status = $r->meets_conditions();
$r
( Apache2::RequestRec object )
$status ( Apache2::Const
status constant )
Apache2::Const::OK if the response fulfills the condition GET
rules. Otherwise some other status code (which should be returned to
Apache).
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);
$r
( Apache2::RequestRec object )
$mtime ( time in seconds )
$mtime_rat ( time in seconds )
send_cgi_header
Parse the header
$r->send_cgi_header($buffer);
$r
( Apache2::RequestRec object )
$buffer (string)
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()).
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);
$r
( Apache2::RequestRec object )
$length (integer)
set_etag
Set the E-tag outgoing header
$r->set_etag();
$r
( Apache2::RequestRec object )
set_keepalive
Set the keepalive status for this request
$ret = $r->set_keepalive();
$r
( Apache2::RequestRec object )
$ret ( boolean )
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.
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.
$r->set_last_modified($mtime);
$r
( Apache2::RequestRec object )
$mtime ( time in seconds )
$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->update_mtime($mtime);
$r
( Apache2::RequestRec object )
$mtime ( time in seconds )
See also: $r->set_last_modified.
Apache2::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);
$r
( Apache2::RequestRec object )
$recursive_error ( boolean )
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.
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);
$r
( Apache2::RequestRec object )
$mm (APR::Mmap)
$offset (number)
$length (integer)
$ret (integer)
META: requires a working APR::Mmap, which is not supported at the moment.
mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 2.0.