rt/lib/RT/Interface/Web/Handler.pm

   1 # {{{ BEGIN BPS TAGGED BLOCK
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2004 Best Practical Solutions, LLC
   6 #                                          <jesse@bestpractical.com>
   7 #
   8 # (Except where explicitly superseded by other copyright notices)
   9 #
  10 #
  11 # LICENSE:
  12 #
  13 # This work is made available to you under the terms of Version 2 of
  14 # the GNU General Public License. A copy of that license should have
  15 # been provided with this software, but in any event can be snarfed
  16 # from www.gnu.org.
  17 #
  18 # This work is distributed in the hope that it will be useful, but
  19 # WITHOUT ANY WARRANTY; without even the implied warranty of
  20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21 # General Public License for more details.
  22 #
  23 # You should have received a copy of the GNU General Public License
  24 # along with this program; if not, write to the Free Software
  25 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  26 #
  27 #
  28 # CONTRIBUTION SUBMISSION POLICY:
  29 #
  30 # (The following paragraph is not intended to limit the rights granted
  31 # to you to modify and distribute this software under the terms of
  32 # the GNU General Public License and is only of importance to you if
  33 # you choose to contribute your changes and enhancements to the
  34 # community by submitting them to Best Practical Solutions, LLC.)
  35 #
  36 # By intentionally submitting any modifications, corrections or
  37 # derivatives to this work, or any other work intended for use with
  38 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
  39 # you are the copyright holder for those contributions and you grant
  40 # Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
  41 # royalty-free, perpetual, license to use, copy, create derivative
  42 # works based on those contributions, and sublicense and distribute
  43 # those contributions and any derivatives thereof.
  44 #
  45 # }}} END BPS TAGGED BLOCK
  46 package RT::Interface::Web::Handler;
  47
  48 sub DefaultHandlerArgs  { (
  49     comp_root => [
  50         [ local    => $RT::MasonLocalComponentRoot ],
  51         [ standard => $RT::MasonComponentRoot ]
  52     ],
  53     default_escape_flags => 'h',
  54     data_dir             => "$RT::MasonDataDir",
  55     allow_globals        => [qw(%session)],
  56     autoflush            => 1
  57 ) };
  58
  59 # {{{ sub new
  60
  61 =head2 new
  62
  63   Constructs a web handler of the appropriate class.
  64   Takes options to pass to the constructor.
  65
  66 =cut
  67
  68 sub new {
  69     my $class = shift;
  70     $class->InitSessionDir;
  71
  72     if ($MasonX::Apache2Handler::VERSION) {
  73         goto &NewApache2Handler;
  74     }
  75     elsif ($mod_perl::VERSION and $mod_perl::VERSION >= 1.9908) {
  76         require Apache::RequestUtil;
  77         no warnings 'redefine';
  78         my $sub = *Apache::request{CODE};
  79         *Apache::request = sub {
  80             my $r;
  81             eval { $r = $sub->('Apache'); };
  82             # warn $@ if $@;
  83             return $r;
  84         };
  85         goto &NewApacheHandler;
  86     }
  87     elsif ($CGI::MOD_PERL) {
  88         goto &NewApacheHandler;
  89     }
  90     else {
  91         goto &NewCGIHandler;
  92     }
  93 }
  94
  95 sub InitSessionDir {
  96     # Activate the following if running httpd as root (the normal case).
  97     # Resets ownership of all files created by Mason at startup.
  98     # Note that mysql uses DB for sessions, so there's no need to do this.
  99     unless ( $RT::DatabaseType =~ /(mysql|Pg)/ ) {
 100
 101         # Clean up our umask to protect session files
 102         umask(0077);
 103
 104         if ($CGI::MOD_PERL) {
 105             chown( Apache->server->uid, Apache->server->gid,
 106                 [$RT::MasonSessionDir] )
 107             if Apache->server->can('uid');
 108         }
 109
 110         # Die if WebSessionDir doesn't exist or we can't write to it
 111         stat($RT::MasonSessionDir);
 112         die "Can't read and write $RT::MasonSessionDir"
 113         unless ( ( -d _ ) and ( -r _ ) and ( -w _ ) );
 114     }
 115
 116 }
 117
 118 # }}}
 119
 120 # {{{ sub NewApacheHandler
 121
 122 =head2 NewApacheHandler
 123
 124   Takes extra options to pass to HTML::Mason::ApacheHandler->new
 125   Returns a new Mason::ApacheHandler object
 126
 127 =cut
 128
 129 sub NewApacheHandler {
 130     require HTML::Mason::ApacheHandler;
 131     return NewHandler('HTML::Mason::ApacheHandler', args_method => "CGI", @_);
 132 }
 133
 134 # }}}
 135
 136 # {{{ sub NewApache2Handler
 137
 138 =head2 NewApache2Handler
 139
 140   Takes extra options to pass to MasonX::Apache2Handler->new
 141   Returns a new MasonX::Apache2Handler object
 142
 143 =cut
 144
 145 sub NewApache2Handler {
 146     require MasonX::Apache2Handler;
 147     return NewHandler('MasonX::Apache2Handler', args_method => "CGI", @_);
 148 }
 149
 150 # }}}
 151
 152 # {{{ sub NewCGIHandler
 153
 154 =head2 NewCGIHandler
 155
 156   Returns a new Mason::CGIHandler object
 157
 158 =cut
 159
 160 sub NewCGIHandler {
 161     require HTML::Mason::CGIHandler;
 162     return NewHandler('HTML::Mason::CGIHandler', @_);
 163 }
 164
 165 sub NewHandler {
 166     my $class = shift;
 167     my $handler = $class->new(
 168         DefaultHandlerArgs(),
 169         @_
 170     );
 171
 172     $handler->interp->set_escape( h => \&RT::Interface::Web::EscapeUTF8 );
 173     return($handler);
 174 }
 175
 176 # }}}
 177
 178 1;