.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "docs::api::ModPerl::Util 3pm"
.TH docs::api::ModPerl::Util 3pm 2024-01-10 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
ModPerl::Util \- Helper mod_perl Functions
.SH Synopsis
.IX Header "Synopsis"
.Vb 1
\&  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);
\&  
\&  # current perl\*(Aqs address (0x92ac760 or 0x0 under non\-threaded perl)
\&  ModPerl::Util::current_perl_id();
.Ve
.SH Description
.IX Header "Description"
\&\f(CW\*(C`ModPerl::Util\*(C'\fR provides mod_perl utilities API.
.SH API
.IX Header "API"
\&\f(CW\*(C`ModPerl::Util\*(C'\fR provides the following functions and/or methods:
.ie n .SS """current_callback"""
.el .SS \f(CWcurrent_callback\fP
.IX Subsection "current_callback"
Returns the currently running callback name,
e.g. \f(CW\*(AqPerlResponseHandler\*(Aq\fR.
.PP
.Vb 1
\&  $callback = ModPerl::Util::current_callback();
.Ve
.ie n .IP "ret: $callback ( string )" 4
.el .IP "ret: \f(CW$callback\fR ( string )" 4
.IX Item "ret: $callback ( string )"
.PD 0
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.PD
.ie n .SS """current_perl_id"""
.el .SS \f(CWcurrent_perl_id\fP
.IX Subsection "current_perl_id"
Return the memory address of the perl interpreter
.PP
.Vb 1
\&  $perl_id = ModPerl::Util::current_perl_id();
.Ve
.ie n .IP "ret: $perl_id ( string )" 4
.el .IP "ret: \f(CW$perl_id\fR ( string )" 4
.IX Item "ret: $perl_id ( string )"
Under threaded perl returns something like: \f(CW0x92ac760\fR
.Sp
Under non-thread perl returns \f(CW0x0\fR
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.PP
Mainly useful for debugging applications running under threaded-perl.
.ie n .SS """exit"""
.el .SS \f(CWexit\fP
.IX Subsection "exit"
Terminate the request, but not the current process (or not the current
Perl interpreter with threaded mpms).
.PP
.Vb 1
\&  ModPerl::Util::exit($status);
.Ve
.ie n .IP "opt arg1: $status ( integer )" 4
.el .IP "opt arg1: \f(CW$status\fR ( integer )" 4
.IX Item "opt arg1: $status ( integer )"
The exit status, which as of this writing is ignored. (it's accepted
to be compatible with the core \f(CW\*(C`exit\*(C'\fR function.)
.IP "ret: no return value" 4
.IX Item "ret: no return value"
.PD 0
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.PD
.PP
Normally you will use the plain \f(CWexit()\fR in your code. You don't need
to use \f(CW\*(C`ModPerl::Util::exit\*(C'\fR explicitly, since mod_perl overrides
\&\f(CWexit()\fR by setting \f(CW\*(C`CORE::GLOBAL::exit\*(C'\fR to
\&\f(CW\*(C`ModPerl::Util::exit\*(C'\fR. Only if you redefine \f(CW\*(C`CORE::GLOBAL::exit\*(C'\fR
once mod_perl is running, you may want to use this function.
.PP
The original \f(CWexit()\fR is still available via \f(CWCORE::exit()\fR.
.PP
\&\f(CW\*(C`ModPerl::Util::exit\*(C'\fR is implemented as a special \f(CWdie()\fR call,
therefore if you call it inside \f(CW\*(C`eval BLOCK\*(C'\fR or \f(CW\*(C`eval "STRING"\*(C'\fR,
while an exception is being thrown, it is caught by \f(CW\*(C`eval\*(C'\fR. For
example:
.PP
.Vb 2
\&  exit;
\&  print "Still running";
.Ve
.PP
will not print anything. But:
.PP
.Vb 4
\&  eval {
\&     exit;
\&  }
\&  print "Still running";
.Ve
.PP
will print \fIStill running\fR. So you either need to check whether the
exception is specific to \f(CW\*(C`exit\*(C'\fR and call
\&\f(CWexit()\fR again:
.PP
.Vb 6
\&  use ModPerl::Const \-compile => \*(AqEXIT\*(Aq;
\&  eval {
\&     exit;
\&  }
\&  exit if $@ && ref $@ eq \*(AqAPR::Error\*(Aq && $@ == ModPerl::EXIT;
\&  print "Still running";
.Ve
.PP
or use \f(CWCORE::exit()\fR:
.PP
.Vb 4
\&  eval {
\&     CORE::exit;
\&  }
\&  print "Still running";
.Ve
.PP
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.
.ie n .SS """unload_package"""
.el .SS \f(CWunload_package\fP
.IX Subsection "unload_package"
Unloads a stash from the current Perl interpreter in the safest way
possible.
.PP
.Vb 1
\&  ModPerl::Util::unload_package($stash);
.Ve
.ie n .IP "arg1: $stash ( string )" 4
.el .IP "arg1: \f(CW$stash\fR ( string )" 4
.IX Item "arg1: $stash ( string )"
The Perl stash to unload. e.g. \f(CW\*(C`MyApache2::MyData\*(C'\fR.
.IP "ret: no return value" 4
.IX Item "ret: no return value"
.PD 0
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.PD
.PP
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 \f(CWuse()\fR a new version of the module
that loads the wiped package.
.PP
References to stash elements (functions, variables, etc.) taken from
outside the unloaded package will still be valid.
.PP
This function may wipe off things loaded by other modules, if the
latter have inserted things into the \f(CW$stash\fR it was told to unload.
.PP
If a stash had a corresponding XS shared object (.so) loaded it will
be unloaded as well.
.PP
If the stash had a corresponding entry in \f(CW%INC\fR, it will be removed
from there.
.PP
\&\f(CWunload_package()\fR takes care to leave sub-stashes intact while
deleting the requested stash. So for example if \f(CW\*(C`CGI\*(C'\fR and
\&\f(CW\*(C`CGI::Carp\*(C'\fR are loaded, calling \f(CWunload_package(\*(AqCGI\*(Aq)\fR won't affect
\&\f(CW\*(C`CGI::Carp\*(C'\fR.
.ie n .SS """untaint"""
.el .SS \f(CWuntaint\fP
.IX Subsection "untaint"
Untaint the variable, by turning its tainted SV flag off (used
internally).
.PP
.Vb 1
\&  ModPerl::Util::untaint($tainted_var);
.Ve
.ie n .IP "arg1: $tainted_var (scalar)" 4
.el .IP "arg1: \f(CW$tainted_var\fR (scalar)" 4
.IX Item "arg1: $tainted_var (scalar)"
.PD 0
.IP "ret: no return value" 4
.IX Item "ret: no return value"
.PD
\&\f(CW$tainted_var\fR is untainted.
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.PP
Do not use this function unless you know what you are doing. To learn
how to properly untaint variables refer to the \fIperlsec\fR manpage.
.SH "See Also"
.IX Header "See Also"
mod_perl 2.0 documentation.
.SH Copyright
.IX Header "Copyright"
mod_perl 2.0 and its core modules are copyrighted under
The Apache Software License, Version 2.0.
.SH Authors
.IX Header "Authors"
The mod_perl development team and numerous
contributors.