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);

  # current perl's address (0x92ac760 or 0x0 under non-threaded perl)
  ModPerl::Util::current_perl_id();

CWModPerl::Util provides mod_perl utilities API.

CWModPerl::Util provides the following functions and/or methods: Returns the currently running callback name, e.g. CW'PerlResponseHandler'.

  $callback = ModPerl::Util::current_callback();

since: 2.0.00

Return the memory address of the perl interpreter

  $perl_id = ModPerl::Util::current_perl_id();

since: 2.0.00

Mainly useful for debugging applications running under threaded-perl. Terminate the request, but not the current process (or not the current Perl interpreter with threaded mpms).

  ModPerl::Util::exit($status);

ret: no return value

since: 2.0.00

Normally you will use the plain CWexit() in your code. You don't need to use CWModPerl::Util::exit explicitly, since mod_perl overrides CWexit() by setting CWCORE::GLOBAL::exit to CWModPerl::Util::exit. Only if you redefine CWCORE::GLOBAL::exit once mod_perl is running, you may want to use this function.

The original CWexit() is still available via CWCORE::exit().

CWModPerl::Util::exit is implemented as a special CWdie() call, therefore if you call it inside CWeval BLOCK or CWeval "STRING", while an exception is being thrown, it is caught by CWeval. For example:

  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 CWexit and call CWexit() again:

  use ModPerl::Const -compile => 'EXIT';
  eval {
     exit;
  }
  exit if $@ && ref $@ eq 'APR::Error' && $@ == ModPerl::EXIT;
  print "Still running";

or use CWCORE::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. Unloads a stash from the current Perl interpreter in the safest way possible.

  ModPerl::Util::unload_package($stash);

ret: no return value

since: 2.0.00

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 CWuse() a new version of the module that loads the wiped package.

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 CW$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 CW%INC, it will be removed from there.

CWunload_package() takes care to leave sub-stashes intact while deleting the requested stash. So for example if CWCGI and CWCGI::Carp are loaded, calling CWunload_package('CGI') won't affect CWCGI::Carp. Untaint the variable, by turning its tainted SV flag off (used internally).

  ModPerl::Util::untaint($tainted_var);

ret: no return value

CW$tainted_var is untainted.

since: 2.0.00

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.