Apache::CmdParms - Perl API for Apache command parameters object
use Apache::CmdParms (); use Apache::Module (); use Apache::Const -compile => qw(NOT_IN_LOCATION); my @directives = ( { name => 'MyDirective', cmd_data => 'some extra data', }, ); Apache::Module::add(__PACKAGE__, \@directives); sub MyDirective { my($self, $parms, $args) = @_; # push config $parms->add_config(['ServerTokens off']); # this command's command object $cmd = $parms->cmd; # check the current command's context $error = $parms->check_cmd_context(Apache::NOT_IN_LOCATION); # this command's context $context = $parms->context; # this command's directive object $directive = $parms->directive; # the extra information passed thru cmd_data to # Apache::Module::add() $info = $parms->info; # which methods are <Limit>ed ? $is_limited = $parms->method_is_limited('GET'); # which allow-override bits are set $override = $parms->override; # the path this command is being invoked in $path = $parms->path; # this command's pool $p = $parms->pool; # this command's configuration time pool $p = $parms->temp_pool; }
Apache::CmdParms provides the Perl API for Apache command parameters object.
Apache::CmdParms
Apache::CmdParms provides the following functions and/or methods:
add_config
Dynamically add Apache configuration at request processing runtime:
$parms->add_config($lines);
$parms
Apache::CmdParms object
$lines
An ARRAY reference containing configuration lines per element, without the new line terminators.
See also: $s->add_config, $r->add_config
$s->add_config
$r->add_config
check_cmd_context
Check the current command against a context bitmask of forbidden contexts.
$error = $parms->check_cmd_context($check);
$check
Apache::Const :context constant
the context to check against.
$error
If the context is forbidden, this method returns a textual description of why it was forbidden. If the context is permitted, this method returns undef.
undef
For example here is how to check whether a command is allowed in the <Location> container:
<Location>
use Apache::Const -compile qw(NOT_IN_LOCATION); if (my $error = $parms->check_cmd_context(Apache::NOT_IN_LOCATION)) { die "directive ... not allowed in <Location> context" }
cmd
This module's command information
$cmd = $parms->cmd();
$cmd
Apache::Command object
directive
This command's directive object in the configuration tree
$directive = $parms->directive;
$directive
Apache::Directive object
The current directive node in the configuration tree
info
The extra information passed through cmd_data in Apache::Module::add().
cmd_data
Apache::Module::add()
$info = $parms->info;
$info
The string passed in cmd_data
For example here is how to pass arbitrary information to a directive subroutine:
my @directives = ( { name => 'MyDirective1', func => \&MyDirective, cmd_data => 'One', }, { name => 'MyDirective2', func => \&MyDirective, cmd_data => 'Two', }, ); Apache::Module::add(__PACKAGE__, \@directives); sub MyDirective { my($self, $parms, $args) = @_; my $info = $parms->info; }
In this example $info will either be 'One' or 'Two' depending on whether the directive was called as MyDirective1 or MyDirective2.
'One'
'Two'
method_is_limited
Discover if a method is <Limit>ed in the current scope
$is_limited = $parms->method_is_limited($method);
$method
The name of the method to check for
$is_limited
For example, to check if the GET method is being <Limit>ed in the current scope, do:
GET
<Limit>
if ($parms->method_is_limited('GET') { die "..."; }
override
Which allow-override bits are set (AllowOverride directive)
AllowOverride
$override = $parms->override;
$override
the allow-override bits bitmask, which can be tested against Apache::Const :override constants.
Apache::Const :override constants
For example to check that the AllowOverride's AuthConfig and FileInfo options are enabled for this command, do:
AuthConfig
FileInfo
use Apache::Const -compile qw(:override); $wanted = Apache::OR_AUTHCFG | Apache::OR_FILEINFO; $masked = $parms->override & $wanted; unless ($wanted == $masked) { die "..."; }
path
The current pathname/location/match of the block this command is in
$path = $parms->path;
$path
If configuring for a block like <Location>, <LocationMatch>, <Directory>, etc., the pathname part of that directive. Otherwise, undef is returned.
For example for a container block:
<Location /foo> ... </Location>
'/foo' will be returned.
pool
Pool associated with this command
$p = $parms->pool;
$p
APR::Pool object
server
The (vhost) server this command was defined in httpd.conf
$s = $parms->server;
$s
Apache::Server object
temp_pool
Pool for scratch memory; persists during configuration, but destroyed before the first request is served.
$temp_pool = $parms->temp_pool;
$temp_pool
Most likely you shouldn't use this pool object, unless you know what you are doing. Use $parms->pool instead.
$parms->pool
Apache::CmdParms 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.
context
Get context containing pointers to modules' per-dir config structures.
$context = $parms->context;
$newval
Apache::ConfVector object
Returns the commands' per-dir config structures
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.