rt/html/Elements/SetupSessionCookie

   1 %# BEGIN BPS TAGGED BLOCK {{{
   2 %#
   3 %# COPYRIGHT:
   4 %#
   5 %# This software is Copyright (c) 1996-2009 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., 51 Franklin Street, Fifth Floor, Boston, MA
  26 %# 02110-1301 or visit their web page on the internet at
  27 %# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
  28 %#
  29 %#
  30 %# CONTRIBUTION SUBMISSION POLICY:
  31 %#
  32 %# (The following paragraph is not intended to limit the rights granted
  33 %# to you to modify and distribute this software under the terms of
  34 %# the GNU General Public License and is only of importance to you if
  35 %# you choose to contribute your changes and enhancements to the
  36 %# community by submitting them to Best Practical Solutions, LLC.)
  37 %#
  38 %# By intentionally submitting any modifications, corrections or
  39 %# derivatives to this work, or any other work intended for use with
  40 %# Request Tracker, to Best Practical Solutions, LLC, you confirm that
  41 %# you are the copyright holder for those contributions and you grant
  42 %# Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
  43 %# royalty-free, perpetual, license to use, copy, create derivative
  44 %# works based on those contributions, and sublicense and distribute
  45 %# those contributions and any derivatives thereof.
  46 %#
  47 %# END BPS TAGGED BLOCK }}}
  48 <%init>
  49 return if $m->is_subrequest; # avoid reentrancy, as suggested by masonbook
  50
  51 my %cookies    = CGI::Cookie->fetch();
  52 my $cookiename = "RT_SID_" . $RT::rtname . "." . $ENV{'SERVER_PORT'};
  53 $SessionCookie = $cookies{$cookiename} ? $cookies{$cookiename}->value : undef;
  54
  55 my %backends   = (
  56     mysql => 'Apache::Session::MySQL',
  57     Pg    => 'Apache::Session::Postgres',
  58
  59     #    Oracle => 'Apache::Session::Oracle',
  60 );
  61
  62 my $session_class = $RT::WebSessionClass
  63     || $backends{$RT::DatabaseType}
  64     || 'Apache::Session::File';
  65 my $pm = "$session_class.pm";
  66 $pm =~ s|::|/|g;
  67 require $pm;
  68
  69 # morning bug avoidance attempt -- pdh 20030815
  70 unless ( $RT::Handle->dbh && $RT::Handle->dbh->ping ) {
  71     $RT::Handle->Connect();
  72 }
  73
  74 my $session_properties;
  75 if ( $session_class eq 'Apache::Session::File' ) {
  76     $session_properties = {
  77         Directory     => $RT::MasonSessionDir,
  78         LockDirectory => $RT::MasonSessionDir,
  79         Transaction => 1
  80     };
  81 } else {
  82     $session_properties = {
  83         Handle     => $RT::Handle->dbh,
  84         LockHandle => $RT::Handle->dbh,
  85         Transaction => 1
  86     };
  87 }
  88
  89 eval {
  90     tie %session, $session_class, $SessionCookie, $session_properties
  91 };
  92 if ($@) {
  93
  94     # If the session is invalid, create a new session.
  95     eval {
  96         tie %session, $session_class, undef, $session_properties;
  97         undef $cookies{$cookiename};
  98     };
  99 }
 100 elsif ( !($session{'CurrentUser'} && $session{'CurrentUser'}->id) ) {
 101     eval {
 102         undef $cookies{$cookiename};
 103         tied(%session)->delete;
 104         tie %session, $session_class, undef, $session_properties;
 105     }
 106 }
 107
 108 if ($@) {
 109     die loc("RT couldn't store your session.") . "\n"
 110         . loc(
 111         "This may mean that that the directory '[_1]' isn't writable or a database table is missing or corrupt.",
 112         $RT::MasonSessionDir
 113         )
 114         . "\n\n"
 115         . $@;
 116 }
 117
 118 if ( !$cookies{$cookiename} ) {
 119     my $cookie = new CGI::Cookie(
 120         -name  => $cookiename,
 121         -value => $session{_session_id},
 122         -path  => $RT::WebPath,
 123         -secure => ($RT::WebSecureCookies ? 1 :0)
 124     );
 125     $r->headers_out->{'Set-Cookie'} = $cookie->as_string;
 126
 127 }
 128
 129 return ();
 130 </%init>
 131 <%args>
 132 $SessionCookie => undef
 133 </%args>