import of rt 3.0.4

1 files changed, 304 insertions, 0 deletions

diff --git a/rt/lib/RT.pm.in b/rt/lib/RT.pm.in
new file mode 100644
index 000000000..065734e2f
--- /dev/null
+++ b/rt/lib/RT.pm.in
@@ -0,0 +1,304 @@
+# BEGIN LICENSE BLOCK
+# 
+# Copyright (c) 1996-2002 Jesse Vincent <jesse@bestpractical.com>
+# 
+# (Except where explictly superceded by other copyright notices)
+# 
+# This work is made available to you under the terms of Version 2 of
+# the GNU General Public License. A copy of that license should have
+# been provided with this software, but in any event can be snarfed
+# from www.gnu.org
+# 
+# This work is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+# 
+# 
+# Unless otherwise specified, all modifications, corrections or
+# extensions to this work which alter its source code become the
+# property of Best Practical Solutions, LLC when submitted for
+# inclusion in the work.
+# 
+# 
+# END LICENSE BLOCK
+
+
+package RT;
+use strict;
+use RT::I18N;
+use RT::CurrentUser;
+use RT::System;
+
+use vars qw($VERSION $System $SystemUser $Nobody $Handle $Logger
+        $CORE_CONFIG_FILE
+        $SITE_CONFIG_FILE
+        $VENDOR_CONFIG_FILE
+        $BasePath
+        $EtcPath
+        $VarPath
+        $LocalPath
+        $LocalEtcPath
+        $LocalLexiconPath
+        $LogDir
+        $MasonComponentRoot
+        $MasonLocalComponentRoot
+        $MasonDataDir
+        $MasonSessionDir
+);
+
+$VERSION = '@RT_VERSION_MAJOR@.@RT_VERSION_MINOR@.@RT_VERSION_PATCH@';
+$CORE_CONFIG_FILE = "@CONFIG_FILE_PATH@/RT_Config.pm";
+$SITE_CONFIG_FILE = "@CONFIG_FILE_PATH@/RT_SiteConfig.pm";
+
+$BasePath = '@RT_PATH@';
+
+$EtcPath = '@RT_ETC_PATH@';
+$VarPath = '@RT_VAR_PATH@';
+$LocalPath = '@RT_LOCAL_PATH@';
+$LocalEtcPath = '@LOCAL_ETC_PATH@';
+$LocalLexiconPath = '@LOCAL_LEXICON_PATH@';
+
+# $MasonComponentRoot is where your rt instance keeps its mason html files
+
+$MasonComponentRoot = '@MASON_HTML_PATH@';
+
+# $MasonLocalComponentRoot is where your rt instance keeps its site-local
+# mason html files.
+
+$MasonLocalComponentRoot = '@MASON_LOCAL_HTML_PATH@';
+
+# $MasonDataDir Where mason keeps its datafiles
+
+$MasonDataDir = '@MASON_DATA_PATH@';
+
+# RT needs to put session data (for preserving state between connections
+# via the web interface)
+$MasonSessionDir = '@MASON_SESSION_PATH@';
+
+
+
+=head1 NAME
+
+	RT - Request Tracker
+
+=head1 SYNOPSIS
+
+	A fully featured request tracker package
+
+=head1 DESCRIPTION
+
+
+=cut
+
+=item LoadConfig
+
+Load RT's config file. First, go after the core config file. 
+After that, try to load the vendor config.
+After that, go after the site config.
+
+=cut
+
+sub LoadConfig {
+     local *Set = sub { $_[0] = $_[1] unless defined $_[0] }; 
+    if ( -f "$SITE_CONFIG_FILE" ) {
+        require $SITE_CONFIG_FILE
+          || die ("Couldn't load RT config file  '$SITE_CONFIG_FILE'\n$@");
+    }
+    require $CORE_CONFIG_FILE
+      || die ("Couldn't load RT config file '$CORE_CONFIG_FILE'\n$@");
+    RT::I18N->Init;
+}
+
+=item Init
+
+    Conenct to the database, set up logging.
+    
+=cut
+
+sub Init {
+    require RT::Handle;
+    #Get a database connection
+        unless ($Handle && $Handle->dbh->ping) {
+    $Handle = RT::Handle->new();
+        } 
+    $Handle->Connect();
+    
+    #RT's system user is a genuine database user. its id lives here
+    $SystemUser = new RT::CurrentUser();
+    $SystemUser->LoadByName('RT_System');
+    
+    #RT's "nobody user" is a genuine database user. its ID lives here.
+    $Nobody = new RT::CurrentUser();
+    $Nobody->LoadByName('Nobody');
+  
+    $System = RT::System->new();
+
+   InitLogging(); 
+}
+
+=head2 InitLogging
+
+Create the RT::Logger object. 
+
+=cut
+sub InitLogging {
+
+    # We have to set the record seperator ($, man perlvar)
+    # or Log::Dispatch starts getting
+    # really pissy, as some other module we use unsets it.
+
+    $, = '';
+    use Log::Dispatch 1.6;
+
+    unless ($RT::Logger) {
+
+    $RT::Logger=Log::Dispatch->new();
+    
+    if ($RT::LogToFile) {
+
+    unless (-d $RT::LogDir && -w $RT::LogDir) {
+        # localizing here would be hard when we don't have a current user yet
+        # die $self->loc("Log directory [_1] not found or couldn't be written.\n RT can't run.", $RT::LogDir);
+        die ("Log directory $RT::LogDir not found or couldn't be written.\n RT can't run.");
+    }
+
+	my $filename;
+	if ($RT::LogToFileNamed =~ m![/\\]!) {
+	    # looks like an absolute path.
+	    $filename = $RT::LogToFileNamed;
+	}
+	else {
+	    $filename = "$RT::LogDir/$RT::LogToFileNamed";
+	}
+    require Log::Dispatch::File;
+
+
+	  $RT::Logger->add(Log::Dispatch::File->new
+		       ( name=>'rtlog',
+			 min_level=> $RT::LogToFile,
+			 filename=> $filename,
+			 mode=>'append',
+			 callbacks => sub { my %p = @_;
+                                my ($package, $filename, $line) = caller(5);
+                                return "[".gmtime(time)."] [".$p{level}."]: $p{message} ($filename:$line)\n"}
+             
+             
+             
+		       ));
+    }
+    if ($RT::LogToScreen) {
+	require Log::Dispatch::Screen;
+	$RT::Logger->add(Log::Dispatch::Screen->new
+		     ( name => 'screen',
+		       min_level => $RT::LogToScreen,
+			 callbacks => sub { my %p = @_;
+                                my ($package, $filename, $line) = caller(5);
+                                return "[".gmtime(time)."] [".$p{level}."]: $p{message} ($filename:$line)\n"
+				},
+             
+		       stderr => 1
+		     ));
+    }
+    if ($RT::LogToSyslog) {
+	require Log::Dispatch::Syslog;
+	$RT::Logger->add(Log::Dispatch::Syslog->new
+		     ( name => 'syslog',
+                       ident => 'RT',
+		       min_level => $RT::LogToSyslog,
+			 callbacks => sub { my %p = @_;
+                                my ($package, $filename, $line) = caller(5);
+
+				# syswrite() cannot take utf8; turn it off here.
+				Encode::_utf8_off($p{message});
+
+				if ($p{level} eq 'debug') {
+
+                                return "$p{message}\n" }
+				else {
+                                return "$p{message} ($filename:$line)\n"}
+				},
+             
+		       stderr => 1
+		     ));
+    }
+
+    }
+
+# {{{ Signal handlers
+
+## This is the default handling of warnings and die'ings in the code
+## (including other used modules - maybe except for errors catched by
+## Mason).  It will log all problems through the standard logging
+## mechanism (see above).
+
+$SIG{__WARN__} = sub {$RT::Logger->warning($_[0])};
+
+#When we call die, trap it and log->crit with the value of the die.
+
+$SIG{__DIE__}  = sub {
+    unless ($^S || !defined $^S ) {
+        $RT::Handle->Rollback();
+        $RT::Logger->crit("$_[0]");
+        exit(-1);
+    }
+    else {
+        #Get out of here if we're in an eval
+        die $_[0];
+    }
+};
+
+# }}}
+
+}
+
+# }}}
+
+
+sub SystemUser {
+    return($SystemUser);
+}	
+
+sub Nobody {
+    return ($Nobody);
+}
+
+
+=head2 DropSetGIDPermissions
+
+Drops setgid permissions.
+
+=cut
+
+sub DropSetGIDPermissions {
+    # Now that we got the config read in, we have the database 
+    # password and don't need to be setgid
+    # make the effective group the real group
+    $) = $(;
+}
+
+
+=head1 SYNOPSIS
+
+=head1 BUGS
+
+=head1 SEE ALSO
+
+
+=begin testing
+
+
+ok ($RT::Nobody->Name() eq 'Nobody', "Nobody is nobody");
+ok ($RT::Nobody->Name() ne 'root', "Nobody isn't named root");
+ok ($RT::SystemUser->Name() eq 'RT_System', "The system user is RT_System");
+ok ($RT::SystemUser->Name() ne 'noname', "The system user isn't noname");
+
+
+=end testing
+
+=cut
+
+eval "require RT_Local";
+die $@ if ($@ && $@ !~ qr{^Can't locate RT_Local.pm});
+
+1;