|
|
add_configas_stringchild_terminatedefault_typedir_configdocument_rootget_handlersget_limit_req_bodyget_server_nameget_server_portget_status_lineis_initial_reqis_perl_option_enabledlocationlocation_mergenewno_cachepnotespsignaturerequestpush_handlersset_basic_credentialsset_handlersslurp_filename
Apache2::RequestUtil - Perl API for Apache request record utils
use Apache2::RequestUtil ();
# add httpd config dynamically
$r->add_config(['require valid-user']);
# dump the request object as a string
print $r->as_string();
# default content_type
$content_type = $r->default_type();
# get PerlSetVar/PerlAddVar values
@values = $r->dir_config->get($key);
# get server docroot
$docroot = $r->document_root();
# set server docroot
$r->document_root($new_root);
# what are the registered perl handlers for a given phase
my @handlers = @{ $r->get_handlers('PerlResponseHandler') || [] };
# push a new handler for a given phase
$r->push_handlers(PerlCleanupHandler => \&handler);
# set handlers for a given phase (resetting previous values)
$r->set_handlers(PerlCleanupHandler => []);
# what's the request body limit
$limit = $r->get_limit_req_body();
# server and port names
$server = $r->get_server_name();
$port = $r->get_server_port();
# what string Apache is going to send for a given status code
$status_line = Apache2::RequestUtil::get_status_line(404);
# are we in the main request?
$is_initial = $r->is_initial_req();
# directory level PerlOptions flags lookup
$r->subprocess_env unless $r->is_perl_option_enabled('SetupEnv');
# current <Location> value
$location = $r->location();
# merge a <Location> container in a request object
$r->location_merge($location);
# create a new Apache2::RequestRec object
$r = Apache2::RequestRec->new($c);
# tell the client not to cache the response
$r->no_cache($boolean);
# share perl objects like $r->notes
$r->pnotes($key => [$obj1, $obj2]);
# get HTML signature
$sig = $r->psignature($prefix);
# get the global request object (requires PerlOptions +GlobalRequest)
$r = Apache2::RequestUtil->request;
# insert auth credentials into the request as if the client did that
$r->set_basic_credentials($username, $password);
# slurp the contents of $r->filename
my $content = ${ $r->slurp_filename() };
# terminate the current child after this request
$r->child_terminate();
Apache2::RequestUtil provides the Apache request object utilities API.
add_configDynamically add Apache configuration at request processing runtime:
$r->add_config($lines); $r->add_config($lines, $override); $r->add_config($lines, $override, $path); $r->add_config($lines, $override, $path, $override_opts);
Configuration directives are processed as if given in a <Location>
block.
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
$lines (ARRAY ref)
An ARRAY reference containing configuration lines per element, without the new line terminators.
$override ( Apache2::Const override
constant|docs::2.0::api::Apache2::Const> )
Which allow-override bits are set
Default value is:
Apache2::Const::OR_AUTHCFG|docs::2.0::api::Apache2::Const/C_Apache2__Const__OR_AUTHCFG_
$path ( string )
Set the Apache2::CmdParms object|docs::2.0::api::Apache2::CmdParms path component.
This is the path of the <Location> block. Some directives need this,
for example ProxyPassReverse.
If an empty string is passed a NULL pointer is passed further at C-level.
This is necessary to make something like this work:
$r->add_config( [
'<Directory />',
'AllowOverride Options AuthConfig',
'</Directory>',
], ~0, '' );
Note: AllowOverride is valid only in directory context.
Caution: Some directives need a non-empty path otherwise they cause segfaults. Thus, use the empty path with caution.
Default value is: /
$override_opts ( Apache2::Const options
constant|docs::2.0::api::Apache2::Const> )
Apache limits the applicable directives in certain situations with
AllowOverride. With Apache 2.2 comes the possibility to enable or
disable single options, for example
AllowOverride AuthConfig Options=ExecCGI,Indexes
Internally, this directive is parsed into 2 bit fields that are represented
by the $override and $override_opts parameters to add_config.
The above example is parsed into an $override with 2 bits set, one for
AuthConfig the other for Options and an $override_opts with
2 bits set for ExecCGI and Indexes.
When applying other directives, for example AuthType or Options the
appropriate bits in $override must be set. For the Options directive
additionally $override_opts bits must be set.
The $override and $override_opts parameters to add_config are
valid while applying $lines.
$override_opts is new in Apache 2.2. The mod_perl implementation for
Apache 2.0 lets you pass the parameter but ignores it.
Default for $override_opts is:
Apache2::Const::OPT_UNSET|docs::2.0::api::Apache2::Const/C_Apache2__Const__OPT_UNSET_ |
Apache2::Const::OPT_ALL|docs::2.0::api::Apache2::Const/C_Apache2__Const__OPT_ALL_ |
Apache2::Const::OPT_INCNOEXEC|docs::2.0::api::Apache2::Const/C_Apache2__Const__OPT_INCNOEXEC_ |
Apache2::Const::OPT_SYM_OWNER|docs::2.0::api::Apache2::Const/C_Apache2__Const__OPT_SYM_OWNER_ |
Apache2::Const::OPT_MULTI|docs::2.0::api::Apache2::Const/C_Apache2__Const__OPT_MULTI_
That means, all options are allowed.
$path and $override_opts since 2.0.3
See also:
$s->add_config|docs::2.0::api::Apache2::ServerUtil/C_add_config_
For example:
use Apache2::RequestUtil (); use Apache2::Access ();
$r->add_config(['require valid-user']);
# this regards the current AllowOverride setting
$r->add_config(['AuthName secret',
'AuthType Basic',
'Options ExecCGI'],
$r->allow_override, $path, $r->allow_override_opts);
as_stringDump the request object as a string
$dump = $r->as_string();
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
$dump ( string )
Dumps various request and response headers (mainly useful for debugging)
child_terminateTerminate the current worker process as soon as the current request is over
$r->child_terminate();
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
This method is not supported in threaded MPMs
default_typeRetrieve the value of the DefaultType directive for the current
request. If not set text/plain is returned.
$content_type = $r->default_type();
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
The current request
$content_type ( string )
The default type
dir_config$r->dir_config() provides an interface for the per-directory
variable specified by the PerlSetVar and PerlAddVar directives,
and also can be manipulated via the
APR::Table|docs::2.0::api::APR::Table methods.
$table = $r->dir_config(); $value = $r->dir_config($key); @values = $r->dir_config->get($key); $r->dir_config($key, $val);
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
$key ( string )
Key string
$val ( string )
Value string
Depends on the passed arguments, see further discussion
The keys are case-insensitive.
$apr_table = $r->dir_config();
dir_config() called in a scalar context without the $key argument
returns a HASH reference blessed into the
APR::Table|docs::2.0::api::APR::Table class. This object can be
manipulated via the APR::Table|docs::2.0::api::APR::Table
methods. For available methods see
the APR::Table|docs::2.0::api::APR::Table manpage.
$value = $r->dir_config($key);
If the $key argument is passed in the scalar context only a single
value will be returned. Since the table preserves the insertion order,
if there is more than one value for the same key, the oldest value
assosiated with the desired key is returned. Calling in the scalar
context is also much faster, as it'll stop searching the table as soon
as the first match happens.
@values = $r->dir_config->get($key);
To receive a list of values you must use get() method from the
APR::Table|docs::2.0::api::APR::Table class.
$r->dir_config($key => $val);
If the $key and the $val arguments are used, the set() operation
will happen: all existing values associated with the key $key (and
the key itself) will be deleted and $value will be placed instead.
$r->dir_config($key => undef);
If $val is undef the unset() operation will happen: all existing
values associated with the key $key (and the key itself) will be
deleted.
document_rootRetrieve the document root for this server
$docroot = $r->document_root(); $docroot = $r->document_root($new_root);
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
The current request
$new_root
Sets the document root to a new value only for the duration of the current request.
$docroot ( string )
The document root
get_handlersReturns a reference to a list of handlers enabled for a given phase.
$handlers_list = $r->get_handlers($hook_name);
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
$hook_name ( string )
a string representing the phase to handle (e.g. PerlLogHandler)
$handlers_list (ref to an ARRAY of CODE refs)
a list of handler subroutines CODE references
See also:
$s->add_config|docs::2.0::api::Apache2::ServerUtil/C_get_handlers_
For example:
A list of handlers configured to run at the response phase:
my @handlers = @{ $r->get_handlers('PerlResponseHandler') || [] };
get_limit_req_bodyReturn the limit on bytes in request msg body
$limit = $r->get_limit_req_body();
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
The current request
$limit (integer)
the maximum number of bytes in the request msg body
get_server_nameGet the current request's server name
$server = $r->get_server_name();
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
The current request
$server ( string )
the server name
For example, consruct a hostport string:
use Apache2::RequestUtil (); my $hostport = join ':', $r->get_server_name, $r->get_server_port;
get_server_portGet the current server port
$port = $r->get_server_port();
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
The current request
$port ( integer )
The server's port number
For example, consruct a hostport string:
use Apache2::RequestUtil (); my $hostport = join ':', $r->get_server_name, $r->get_server_port;
get_status_lineReturn the Status-Line for a given status code (excluding the
HTTP-Version field).
$status_line = Apache2::RequestUtil::get_status_line($status);
$status (integer)
The HTTP status code
$status_line ( string )
The Status-Line
If an invalid or unknown status code is passed, "500 Internal Server
Error" will be returned.
For example:
use Apache2::RequestUtil (); print Apache2::RequestUtil::get_status_line(400);
will print:
400 Bad Request
is_initial_reqDetermine whether the current request is the main request or a sub-request
$is_initial = $r->is_initial_req();
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
A request or a sub-request object
$is_initial ( boolean )
If true -- it's the main request, otherwise it's a sub-request
is_perl_option_enabledcheck whether a directory level PerlOptions flag is enabled or not.
$result = $r->is_perl_option_enabled($flag);
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
$flag ( string )
$result ( boolean )
For example to check whether the SetupEnv option is enabled for the
current request (which can be disabled with PerlOptions -SetupEnv)
and populate the environment variables table if disabled:
$r->subprocess_env unless $r->is_perl_option_enabled('SetupEnv');
See also: PerlOptions and the equivalent function for server level PerlOptions flags.
locationGet the path of the <Location> section from which the current
Perl*Handler is being called.
$location = $r->location();
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
$location ( string )
location_mergeMerge a given <Location> container into the current request
object:
$ret = $r->location_merge($location);
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
$location ( string )
The argument in a <Location> section. For example to merge
a container:
<Location /foo>
...
</Location>
that argument will be /foo
$ret ( boolean )
a true value if the merge was successful (i.e. the request
$location match was found), otherwise false.
Useful for insertion of a configuration section into a custom
Apache2::RequestRec object, created via the
Apache2::RequestRec->new() method. See for example the Command Server protocol example.
newCreate a new Apache2::RequestRec object.
$r = Apache2::RequestRec->new($c); $r = Apache2::RequestRec->new($c, $pool);
Apache2::RequestRec
( Apache2::RequestRec class name|docs::2.0::api::Apache2::RequestRec )
$c
(Apache2::Connection object|docs::2.0::api::Apache2::Connection)
$pool
If no $pool argument is passed, $c->pool is used. That means
that the created Apache2::RequestRec object will be valid as long as
the connection object is valid.
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
It's possible to reuse the HTTP framework features outside the
familiar HTTP request cycle. It's possible to write your own full or
partial HTTP implementation without needing a running Apache
server. You will need the Apache2::RequestRec object in order to be
able to reuse the rich functionality supplied via this object.
See for example the Command Server protocol example which reuses HTTP AAA model under non-HTTP protocol.
no_cacheAdd/remove cache control headers:
$prev_no_cache = $r->no_cache($boolean);
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
$boolean ( boolean )
A true value sets the no_cache request record member to a true
value and inserts:
Pragma: no-cache Cache-control: no-cache
into the response headers, indicating that the data being returned is volatile and the client should not cache it.
A false value unsets the no_cache request record member and the
mentioned headers if they were previously set.
$prev_no_cache ( boolean )
Should you care, the no_cache request record member value prior to
the change is returned.
This method should be invoked before any response data has been sent out.
pnotesShare Perl variables between Perl HTTP handlers
$old_val = $r->pnotes($key => $val); $val = $r->pnotes($key); $hash_ref = $r->pnotes();
Note: sharing variables really means it. The variable is not copied. Only its reference count is incremented. If it is changed after being put in pnotes that change also affects the stored value. The following example illustrates the effect:
my $v=1; my $v=1;
$r->pnotes( 'v'=>$v ); $r->pnotes->{v}=$v;
$v++; $v++;
my $x=$r->pnotes('v'); my $x=$r->pnotes->{v};
In both cases $x is 2 not 1. See also Apache2::SafePnotes on
CPAN.
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
$key ( string )
A key value
$val ( SCALAR )
Any scalar value (e.g. a reference to an array)
if both, $key and $val are passed the previous value for $key
is returned if such existed, otherwise undef is returned.
if only $key is passed, the current value for the given key is
returned.
if no arguments are passed, a hash reference is returned, which can
then be directly accessed without going through the pnotes()
interface.
This method provides functionality similar to
(Apache2::RequestRec::notes|docs::2.0::api::Apache2::RequestRec/C_notes_),
but values can be any Perl variables. That also means that it can be
used only between Perl modules.
The values get reset automatically at the end of each HTTP request.
Examples:
Set a key/value pair:
$r->pnotes(foo => [1..5]);
Get the value:
$val = $r->pnotes("foo");
$val now contains an array ref containing 5 elements (1..5).
Now change the existing value:
$old_val = $r->pnotes(foo => ['a'..'c']);
$val = $r->pnotes("foo");
$old_val now contains an array ref with 5 elements (1..5) and
$val contains an array ref with 3 elements 'a', 'b', 'c'.
Alternatively you can access the hash reference with all pnotes values:
$pnotes = $r->pnotes;
Now we can read what's in there for the key foo:
$val = $pnotes->{foo};
and as before $val still gives us an array ref with 3 elements
'a', 'b', 'c'.
Now we can add elements to it:
push @{ $pnotes{foo} }, 'd'..'f';
and we can try to retrieve them using the hash and non-hash API:
$val1 = $pnotes{foo};
$val2 = $r->pnotes("foo");
Both $val1 and $val2 contain an array ref with 6 elements
(letters 'a' to 'f').
Finally to reset an entry you could just assign undef as a value:
$r->pnotes(foo => undef);
but the entry for the key foo still remains with the value
undef. If you really want to completely remove it, use the hash
interface:
delete $r->pnotes->{foo};
psignatureGet HTML describing the address and (optionally) admin of the server.
$sig = $r->psignature($prefix);
$r
( Apache2::RequestRec|docs::2.0::api::Apache2::RequestRec )
$prefix ( string )
Text which is prepended to the return value
$sig ( string )
HTML text describing the server. Note that depending on the value of
the ServerSignature directive, the function may return the address,
including the admin information or nothing at all.
requestGet/set the ( Apache2::RequestRec
object|docs::2.0::api::Apache2::RequestRec> ) object for the current
request.
$r = Apache2::RequestUtil->request;
Apache2::RequestUtil->request($new_r);
Apache2 (class name)
The Apache class name
$new_r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
The get-able part of this method is only available if PerlOptions
+GlobalRequest|docs::2.0::user::config::config/C_GlobalRequest_> is
in effect or if Apache2->request($new_r) was called earlier. So
instead of setting PerlOptions
+GlobalRequest|docs::2.0::user::config::config/C_GlobalRequest_>, one
can set the global request from within the handler.
push_handlersAdd one or more handlers to a list of handlers to be called for a given phase.
$ok = $r->push_handlers($hook_name => \&handler); $ok = $r->push_handlers($hook_name => ['Foo::Bar::handler', \&handler2]);
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
$hook_name ( string )
the phase to add the handlers to
$handlers ( CODE ref or SUB name or an ARRAY ref )
a single handler CODE reference or just a name of the subroutine (fully qualified unless defined in the current package).
if more than one passed, use a reference to an array of CODE refs and/or subroutine names.
$ok ( boolean )
returns a true value on success, otherwise a false value
See also:
$s->add_config|docs::2.0::api::Apache2::ServerUtil/C_push_handlers_
Note that to push input/output filters you have to use
Apache2::Filter|docs::2.0::api::Apache2::Filter methods:
add_input_filter|docs::2.0::api::Apache2::Filter/C_add_input_filter_
and
add_output_filter|docs::2.0::api::Apache2::Filter/C_add_output_filter_.
Examples:
A single handler:
$r->push_handlers(PerlResponseHandler => \&handler);
Multiple handlers:
$r->push_handlers(PerlFixupHandler => ['Foo::Bar::handler', \&handler2]);
Anonymous functions:
$r->push_handlers(PerlLogHandler => sub { return Apache2::Const::OK });
set_basic_credentialsPopulate the incoming request headers table (headers_in) with
authentication headers for Basic Authorization as if the client has
submitted those in first place:
$r->set_basic_credentials($username, $password);
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
$username ( string )
$password ( string )
See for example the Command Server protocol example which reuses HTTP AAA model under non-HTTP protocol.
set_handlersSet a list of handlers to be called for a given phase. Any previously set handlers are forgotten.
$ok = $r->set_handlers($hook_name => \&handler); $ok = $r->set_handlers($hook_name => ['Foo::Bar::handler', \&handler2]); $ok = $r->set_handlers($hook_name => []); $ok = $r->set_handlers($hook_name => undef);
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
$hook_name ( string )
the phase to set the handlers in
$handlers (CODE ref or SUB name or an ARRAY ref)
a reference to a single handler CODE reference or just a name of the subroutine (fully qualified unless defined in the current package).
if more than one passed, use a reference to an array of CODE refs and/or subroutine names.
if the argument is undef or [] the list of handlers is reset to
zero.
$ok ( boolean )
returns a true value on success, otherwise a false value
See also:
$s->add_config|docs::2.0::api::Apache2::ServerUtil/C_set_handlers_
Examples:
A single handler:
$r->set_handlers(PerlResponseHandler => \&handler);
Multiple handlers:
$r->set_handlers(PerlFixupHandler => ['Foo::Bar::handler', \&handler2]);
Anonymous functions:
$r->set_handlers(PerlLogHandler => sub { return Apache2::Const::OK });
Reset any previously set handlers:
$r->set_handlers(PerlCleanupHandler => []);
or
$r->set_handlers(PerlCleanupHandler => undef);
slurp_filenameSlurp the contents of $r->filename:
$content_ref = $r->slurp_filename($tainted);
$r
( Apache2::RequestRec object|docs::2.0::api::Apache2::RequestRec )
$tainted (number)
If the server is run under the tainting mode (-T) which we hope you
do, by default the returned data is tainted. If an optional
$tainted flag is set to zero, the data will be marked as
non-tainted.
Do not set this flag to zero unless you know what you are doing, you may create a security hole in your program if you do. For more information see the perlsec manpage.
If you wonder why this option is available, it is used internally by
the ModPerl::Registry|docs::2.0::api::ModPerl::Registry handler
and friends, because the CGI scripts that it reads are considered safe
(you could just as well require() them).
$content_ref ( SCALAR ref )
A reference to a string with the contents
APR::Error|docs::2.0::api::APR::Error
Possible error codes could be:
APR::Const::EACCES|docs::2.0::api::APR::Const/C_APR__Const__EACCES_
(permission problems),
APR::Const::ENOENT|docs::2.0::api::APR::Const/C_APR__Const__ENOENT_
(file not found), and others. For checking such error codes, see the
documentation for, for example,
APR::Status::is_EACCES|docs::2.0::api::APR::Status/C_is_EACCES_
and
APR::Status::is_ENOENT|docs::2.0::api::APR::Status/C_is_ENOENT_.
Note that if you assign to $r->filename you need to update its stat record.
mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 2.0.