NAME
ModPerl::RegistryLoader - Compile ModPerl::RegistryCooker scripts at server startup
SYNOPSIS
# in startup.pl
use ModPerl::RegistryLoader ();
# explicit uri => filename mapping
my $rlbb = ModPerl::RegistryLoader->new(
package => 'ModPerl::RegistryBB',
debug => 1, # default 0
);
$rlbb->handler($uri, $filename);
# uri => filename mapping using a helper function
sub trans {
my $uri = shift;
$uri =~ s|^/registry/|cgi-bin/|;
return Apache::server_root_relative($uri);
}
my $rl = ModPerl::RegistryLoader->new(
package => 'ModPerl::Registry',
trans => \&trans,
);
$rl->handler($uri);
DESCRIPTION
This modules allows compilation of scripts, running under packages derived from ModPerl::RegistryCooker
, at server startup. The script's handler routine is compiled by the parent server, of which children get a copy and thus saves some memory by initially sharing the compiled copy with the parent and saving the overhead of script's compilation on the first request in every httpd instance.
METHODS
- new()
-
When creating a new
ModPerl::RegistryLoader
object, one has to specify which of theModPerl::RegistryCooker
derived modules to use. For example if a script is going to run underApache::RegistryBB
the object is initialized as:my $rlbb = ModPerl::RegistryLoader->new( package => 'ModPerl::RegistryBB', );
To turn the debugging on, set the debug attribute to a true value:
my $rlbb = ModPerl::RegistryLoader->new( package => 'ModPerl::RegistryBB', debug => 1, );
Instead of specifying explicitly a filename for each uri passed to handler(), a special attribute trans can be set to a subroutine to perform automatic remapping.
my $rlbb = ModPerl::RegistryLoader->new( package => 'ModPerl::RegistryBB', trans => \&trans, );
See the handler() item for an example of using the trans attribute.
- handler()
-
$rl->handler($uri, [$filename]);
The handler() method takes argument of
uri
and optionally offilename
.URI to filename translation normally doesn't happen until HTTP request time, so we're forced to roll our own translation. If the filename is supplied it's used in translation.
If the filename is omitted and a
trans
subroutine was not set in new(), the loader will try using theuri
relative to theServerRoot
configuration directive. For example:httpd.conf: ----------- ServerRoot /usr/local/apache Alias /registry/ /usr/local/apache/cgi-bin/ startup.pl: ----------- use ModPerl::RegistryLoader (); my $rl = ModPerl::RegistryLoader->new( package => 'ModPerl::Registry', ); # preload /usr/local/apache/cgi-bin/test.pl $rl->handler(/registry/test.pl);
To make the loader smarter about the URI->filename translation, you may provide the
new()
method with atrans()
function to translate the uri to filename.The following example will pre-load all files ending with .pl in the cgi-bin directory relative to
ServerRoot
.httpd.conf: ----------- ServerRoot /usr/local/apache Alias /registry/ /usr/local/apache/cgi-bin/ startup.pl: ----------- { # test the scripts pre-loading by using trans sub use ModPerl::RegistryLoader (); use DirHandle (); use strict; my $dir = Apache::server_root_relative("cgi-bin"); sub trans { my $uri = shift; $uri =~ s|^/registry/|cgi-bin/|; return Apache::server_root_relative($uri); } my $rl = ModPerl::RegistryLoader->new( package => "ModPerl::Registry", trans => \&trans, ); my $dh = DirHandle->new($dir) or die $!; for my $file ($dh->read) { next unless $file =~ /\.pl$/; $rl->handler("/registry/$file"); } }
AUTHORS
Doug MacEachern
Stas Bekman
SEE ALSO
ModPerl::RegistryCooker(3), Apache(3), mod_perl(3)