ModPerl::Util - Helper mod_perl Functions
use ModPerl::Util; # e.g. PerlResponseHandler $callback = ModPerl::Util::current_callback; # exit w/o killing the interpreter ModPerl::Util::exit(); # untaint a string (do not use it! see the doc) ModPerl::Util::untaint($string); # removes a stash (.so, %INC{$stash}, etc.) as best as it can ModPerl::Util::unload_package($stash);
ModPerl::Util provides mod_perl utilities API.
ModPerl::Util
ModPerl::Util provides the following functions and/or methods:
current_callback
Returns the currently running callback name, e.g. 'PerlResponseHandler'.
'PerlResponseHandler'
$callback = ModPerl::Util::current_callback();
$callback
exit
Terminate the request, but not the current process (or not the current Perl interpreter with threaded mpms).
ModPerl::Util::exit($status);
$status
The exit status, which as of this writing is ignored. (it's accepted to be compatible with the core exit function.)
Normally you will use the plain exit() in your code. You don't need to use ModPerl::Util::exit explicitly, since mod_perl overrides exit() by setting CORE::GLOBAL::exit to ModPerl::Util::exit. Only if you redefine CORE::GLOBAL::exit once mod_perl is running, you may want to use this function.
exit()
ModPerl::Util::exit
CORE::GLOBAL::exit
The original exit() is still available via CORE::exit().
CORE::exit()
ModPerl::Util::exit is implemented as a special die() call, therefore if you call it inside eval BLOCK or eval "STRING", while an exception is being thrown, it is caught by eval. For example:
die()
eval BLOCK
eval "STRING"
eval
exit; print "Still running";
will not print anything. But:
eval { exit; } print "Still running";
will print Still running. So you either need to check whether the exception is specific to exit and call exit() again:
use ModPerl::Const -compile => 'EXIT'; eval { exit; } exit if $@ && ref $@ eq 'APR::Error' && $@ == ModPerl::EXIT; print "Still running";
or use CORE::exit():
eval { CORE::exit; } print "Still running";
and nothing will be printed. The problem with the latter is the current process (or a Perl Interpreter) will be killed; something that you really want to avoid under mod_perl.
unload_package
Unloads a stash from the current Perl interpreter in the safest way possible.
ModPerl::Util::unload_package($stash);
$stash
The Perl stash to unload. e.g. MyApache::MyData.
MyApache::MyData
Unloading a Perl stash (package) is a complicated business. This function tries very hard to do the right thing. After calling this function, it should be safe to use() a new version of the module that loads the wiped package.
use()
References to stash elements (functions, variables, etc.) taken from outside the unloaded package will still be valid.
This function may wipe off things loaded by other modules, if the latter have inserted things into the $stash it was told to unload.
If a stash had a corresponding XS shared object (.so) loaded it will be unloaded as well.
If the stash had a corresponding entry in %INC, it will be removed from there.
%INC
unload_package() takes care to leave sub-stashes intact while deleting the requested stash. So for example if CGI and CGI::Carp are loaded, calling unload_package('CGI') won't affect CGI::Carp.
unload_package()
CGI
CGI::Carp
unload_package('CGI')
untaint
Untaint the variable, by turning its tainted SV flag off (used internally).
ModPerl::Util::untaint($tainted_var);
$tainted_var
$tainted_var is untainted.
Do not use this function unless you know what you are doing. To learn how to properly untaint variables refer to the perlsec manpage.
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.