|
|
Apache2::Directive - Perl API for manipulating the Apache configuration tree
use Apache2::Directive ();
my $tree = Apache2::Directive::conftree();
my $documentroot = $tree->lookup('DocumentRoot');
my $vhost = $tree->lookup('VirtualHost', 'localhost:8000');
my $servername = $vhost->{'ServerName'};
use Data::Dumper;
print Dumper $tree->as_hash;
my $node = $tree;
while ($node) {
print $node->as_string;
#do something with $node
my $directive = $node->directive;
my $args = $node->args;
my $filename = $node->filename;
my $line_num = $node->line_num;
if (my $kid = $node->first_child) {
$node = $kid;
}
elsif (my $next = $node->next) {
$node = $next;
}
else {
if (my $parent = $node->parent) {
$node = $parent->next;
}
else {
$node = undef;
}
}
}
Apache2::Directive provides the Perl API for manipulating the Apache
configuration tree
Apache2::Directive provides the following functions and/or methods:
argsGet the arguments for the current directive:
$args = $node->args();
$node
( Apache2::Directive object|docs::2.0::api::Apache2::Directive )
$args ( string )
Arguments are separated by a whitespace in the string.
For example, in httpd.conf:
PerlSwitches -M/opt/lib -M/usr/local/lib -wT
And later:
my $tree = Apache2::Directive::conftree();
my $node = $tree->lookup('PerlSwitches');
my $args = $node->args;
$args now contains the string ``-M/opt/lib -M/usr/local/lib -wT''
as_hashGet a hash representation of the configuration tree, in a format suitable for inclusion in <Perl> sections.
$config_hash = $conftree->as_hash();
$conftree
( Apache2::Directive object|docs::2.0::api::Apache2::Directive )
The config tree to stringify
$config_hash ( HASH reference )
For example: in httpd.conf:
<Location /test>
SetHandler perl-script
PerlHandler Test::Module
</Location>
And later:
my $tree = Apache2::Directive::conftree();
my $node = $tree->lookup('Location', '/test/');
my $hash = $node->as_hash;
$hash now is:
{
'SetHandler' => 'perl-script',
'PerlHandler' => 'Test::Module',
}
as_stringGet a string representation of the configuration node, in httpd.conf format.
$string = $node->as_string();
$node
( Apache2::Directive object|docs::2.0::api::Apache2::Directive )
The config tree to stringify
$string ( string )
For example: in httpd.conf:
<Location /test>
SetHandler perl-script
PerlHandler Test::Module
</Location>
And later:
my $tree = Apache2::Directive::conftree();
my $node = $tree->lookup('Location', '/test/');
my $string = $node->as_string;
$string is now:
SetHandler perl-script PerlHandler Test::Module
conftreeGet the root of the configuration tree:
$conftree = Apache2::Directive::conftree();
Apache2::Directive ( class name )
$conftree
( Apache2::Directive object|docs::2.0::api::Apache2::Directive )
directiveGet the name of the directive in $node:
$name = $node->directive();
$node
( Apache2::Directive object|docs::2.0::api::Apache2::Directive )
$name ( string )
filenameGet the filename the configuration node was created from:
$filename = $node->filename();
$node
( Apache2::Directive object|docs::2.0::api::Apache2::Directive )
$filename ( string )
For example:
my $tree = Apache2::Directive::conftree();
my $node = $tree->lookup('VirtualHost', 'example.com');
my $filename = $node->filename;
$filename is now the full path to the httpd.conf that
VirtualHost was defined in.
If the directive was added with
add_config()|docs::2.0::api::Apache2::ServerUtil/C_add_config_,
the filename will be the path to the httpd.conf that trigerred
that Perl code.
first_childGet the first child node of this directive:
$child_node = $node->first_child;
$node
( Apache2::Directive object|docs::2.0::api::Apache2::Directive )
$child_node
( Apache2::Directive object|docs::2.0::api::Apache2::Directive )
Returns the first child node of $node, undef if there is none
line_numGet the line number in a filename this node was created at:
$lineno = $node->line_num();
$node
( Apache2::Directive object|docs::2.0::api::Apache2::Directive )
$lineno (integer)
lookupGet the node(s) matching a certain value.
$node = $conftree->lookup($directive, $args); @nodes = $conftree->lookup($directive, $args);
$conftree
( Apache2::Directive object|docs::2.0::api::Apache2::Directive )
The config tree to stringify
$directive ( string )
The name of the directive to search for
args ( string )
Optional args to the directive to filter for
$string ( string / ARRAY of HASH refs )
In LIST context, it returns all matching nodes.
In SCALAR context, it returns only the first matching node.
If called with only $directive value, this method returns all nodes
from that directive. For example:
@Alias = $conftree->lookup('Alias');
returns all nodes for Alias directives.
If called with an extra $args argument, it returns only nodes where
both the directive and the args matched. For example:
$VHost = $tree->lookup('VirtualHost', '_default_:8000');
nextGet the next directive node in the tree:
$next_node = $node->next();
$node
( Apache2::Directive object|docs::2.0::api::Apache2::Directive )
$next_node
( Apache2::Directive object|docs::2.0::api::Apache2::Directive )
Returns the next sibling of $node, undef if there is none
parentGet the parent node of this directive:
$parent_node = $node->parent();
$node
( Apache2::Directive object|docs::2.0::api::Apache2::Directive )
parent_node
( Apache2::Directive object|docs::2.0::api::Apache2::Directive )
Returns the parent of $node, undef if this node is the root node
mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 2.0.