Apache2::SubRequest - Perl API for Apache subrequests

  use Apache2::SubRequest ();

  # run internal redirects at once
  $r->internal_redirect($new_uri);
  $r->internal_redirect_handler($new_uri);

  # create internal redirect objects
  $subr = $r->lookup_uri("/foo");
  $subr = $r->lookup_method_uri("GET", "/tmp/bar")
  $subr = $r->lookup_file("/tmp/bar");
  # optionally manipulate the output through main request filters
  $subr = $r->lookup_uri("/foo", $r->output_filters);
  # now run them
  my $rc = $subr->run;

CWApache2::SubRequest contains API for creating and running of Apache sub-requests.

CWApache2::SubRequest is a sub-class of CWApache2::RequestRec object.

CWApache2::SubRequest provides the following functions and/or methods: Free the memory associated with a sub request:

  undef $subr; # but normally don't do that

ret: no return value

since: 2.0.00

CWDESTROY is called automatically when CW$subr goes out of scope.

If you want to free the memory earlier than that (for example if you run several subrequests), you can CWundef the object as:

  undef $subr;

but never call CWDESTROY explicitly, since it'll result in CWap_destroy_sub_req being called more than once, resulting in multiple brain injuries and certain hair loss. Redirect the current request to some other uri internally

  $r->internal_redirect($new_uri);

ret: no return value

since: 2.0.00

In case that you want some other request to be served as the top-level request instead of what the client requested directly, call this method from a handler, and then immediately return CWApache2::Const::OK. The client will be unaware the a different request was served to her behind the scenes. Identical to CWinternal_redirect, plus automatically sets CW$r->content_type is of the sub-request to be the same as of the main request, if CW$r->handler is true.

  $r->internal_redirect_handler($new_uri);

ret: no return value

since: 2.0.00

This function is designed for things like actions or CGI scripts, when using CWAddHandler, and you want to preserve the content type across an internal redirect. Create a subrequest for the given file. This sub request can be inspected to find information about the requested file

  $ret = $r->lookup_file($new_file);
  $ret = $r->lookup_file($new_file, $next_filter);

since: 2.0.00

See CW$r->lookup_uri for further discussion. Create a sub request for the given URI using a specific method. This sub request can be inspected to find information about the requested URI

  $ret = $r->lookup_method_uri($method, $new_uri);
  $ret = $r->lookup_method_uri($method, $new_uri, $next_filter);

since: 2.0.00

See CW$r->lookup_uri for further discussion. Create a sub request from the given URI. This sub request can be inspected to find information about the requested URI.

  $ret = $r->lookup_uri($new_uri);
  $ret = $r->lookup_uri($new_uri, $next_filter);

since: 2.0.00

Here is an example of a simple subrequest which serves uri /new_uri:

  sub handler {
      my $r = shift;

      my $subr = $r->lookup_uri("/new_uri");
      $sub->run;

      return Apache2::Const::OK;
  }

If let's say you have three request output filters registered to run for the main request:

  PerlOutputFilterHandler MyApache2::SubReqExample::filterA
  PerlOutputFilterHandler MyApache2::SubReqExample::filterB
  PerlOutputFilterHandler MyApache2::SubReqExample::filterC

and you wish to run them all, the code needs to become:

      my $subr = $r->lookup_uri("/new_uri", $r->output_filters);

and if you wish to run them all, but the first one (CWfilterA), the code needs to be adjusted to be:

      my $subr = $r->lookup_uri("/new_uri", $r->output_filters->next);

  $rc = $subr->run();

since: 2.0.00

CWApache2::SubRequest also provides auto-generated Perl interface for a few other methods which aren't tested at the moment and therefore their API is a subject to change. These methods will be finalized later as a need arises. If you want to rely on any of the following methods please contact the the mod_perl development mailing list so we can help each other take the steps necessary to shift the method to an officially supported API. META: Autogenerated - needs to be reviewed/completed

Redirect the current request to a sub_req, merging the pools

  $r->internal_fast_redirect($sub_req);

ret: no return value

since: 2.0.00

META: httpd-2.0/modules/http/http_request.c declares this function as:

  /* XXX: Is this function is so bogus and fragile that we deep-6 it? */

do we really want to expose it to mod_perl users? META: Autogenerated - needs to be reviewed/completed

Create a sub request for the given apr_dir_read result. This sub request can be inspected to find information about the requested file

  $lr = $r->lookup_dirent($finfo);
  $lr = $r->lookup_dirent($finfo, $subtype);
  $lr = $r->lookup_dirent($finfo, $subtype, $next_filter);

  Apache2::SUBREQ_NO_ARGS     ignore r->args and r->path_info
  Apache2::SUBREQ_MERGE_ARGS  merge  r->args and r->path_info

since: 2.0.00

META: where do we take the apr_dir_read result from?

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.