NAME

Hub::Apache2::Render - Apache2 mod_perl response handler for HTML pages

SYNOPSIS

  <LocationMatch "/sample.*\.(html?|css|js)$">
    <IfModule mod_perl.c>
      Options +ExecCGI
      SetHandler perl-script
      PerlOptions +ParseHeaders
      PerlResponseHandler Hub::Apache2::Render
      PerlSetEnv WORKING_DIR "/var/www/html"
  #   PerlSetEnv DEBUG "1"
  #   PerlSetEnv CONF_FILE "custom.conf"
    </IfModule>
  </LocationMatch>

DESCRIPTION

The working directory of the web site must be set. We will change to and run in this directory. This is also the reflected directory which limits the request's scope.

=pod:Environment variables

WORKING_DIR

The working directory is just that. Since multiple threads (hence multiple sites) share this interpreter, a change to this directy is issued on each request.

      PerlSetEnv WORKING_DIR "/var/www/html"

CONF_FILE

By default configuration is read from a file named .conf in your working directory. To use a different one, specify it here. It must reside beneath your working directory, and this path is relative to the working directory. For example:

      PerlSetEnv CONF_FILE "/conf/custom.conf"

would resolve to:

      $WORKING_DIR/conf/custom.conf

DEBUG

To generate debug messages (written to stderr), set this to a true value.

      PerlSetEnv DEBUG "1"

Notes

  'Accept',               # Lists acceptable media types for the server to 
                          # present in response
  'Accept-Charset',       # Lists character sets the client will accept
  'Accept-Encoding',      # Lists encodings the client will accept
  'Accept-Language',      # Lists languages the client is most interested in
  'Authorization',        # A series of authorization fields
  'Cache-Control',        # Behavior intended to prevent caches from adversely 
                          # interfering with the request or response
  'Cookie',               # Decribes a client cookie
  'Host',                 # Name of the requested host server
  'If-Match',             # The entity tag of the client's cached version of 
                          # the requested resource
  'If-Modified-Since',    # An HTTP-formatted date for the server to use in 
                          # resource comparisons
  'If-None-Match',        # A list of entity tags representing the client's 
                          # possible cached resources
  'If-Unmodified-Since',  # An HTTP-formatted date for the server to use in 
                          # resource comparisons
  'Referer',              # An absolute or partial URI of the resource from 
                          # which the current request was obtained
  'User-Agent',           # A string identifying the client software

PUBLIC METHODS

handler

Apache2 mode_perl invocation method

process_request

Apache2 mod_perl processor

render

Worker method

mimic

For invoking this handler from the command-line

 Usage: mimic $script, $cgi_parameters
 Usage: mimic $script
For debugging, you may mimic a web request by:


  cd $WORKING_DIR
  perl -MHub -e "Hub::Apache2::Render::mimic()" index.html

AUTHOR

Ryan Gies (ryangies@livesite.net)

COPYRIGHT

Copyright (C) 2006-2007 by Livesite Networks, LLC. All rights reserved.

Copyright (C) 2000-2005 by Ryan Gies. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

* The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.

* Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.

* The name of the author may not be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

To the best of our knowledge, no patented algorithms have been used. However, we do not have the resources to carry out a patent search, and therefore cannot give any guarantee of the above statement.

UPDATED

08/02/2007

cpanm Hub

perl -MCPAN -e shell
install Hub