import rt 3.6.6

[freeside.git] / rt / lib / RT / Base.pm

diff --git a/rt/lib/RT/Base.pm b/rt/lib/RT/Base.pm
index 47742f8..7910588 100644 (file)
--- a/rt/lib/RT/Base.pm
+++ b/rt/lib/RT/Base.pm
@@ -1,8 +1,14 @@
-# BEGIN LICENSE BLOCK
+# BEGIN BPS TAGGED BLOCK {{{
 # 
-# Copyright (c) 1996-2003 Jesse Vincent <jesse@bestpractical.com>
+# COPYRIGHT:
+#  
+# This software is Copyright (c) 1996-2007 Best Practical Solutions, LLC 
+#                                          <jesse@bestpractical.com>
 # 
-# (Except where explictly superceded by other copyright notices)
+# (Except where explicitly superseded by other copyright notices)
+# 
+# 
+# LICENSE:
 # 
 # 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
@@ -14,13 +20,31 @@
 # 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.
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+# 02110-1301 or visit their web page on the internet at
+# http://www.gnu.org/copyleft/gpl.html.
+# 
+# 
+# CONTRIBUTION SUBMISSION POLICY:
 # 
+# (The following paragraph is not intended to limit the rights granted
+# to you to modify and distribute this software under the terms of
+# the GNU General Public License and is only of importance to you if
+# you choose to contribute your changes and enhancements to the
+# community by submitting them to Best Practical Solutions, LLC.)
 # 
-# END LICENSE BLOCK
+# By intentionally submitting any modifications, corrections or
+# derivatives to this work, or any other work intended for use with
+# Request Tracker, to Best Practical Solutions, LLC, you confirm that
+# you are the copyright holder for those contributions and you grant
+# Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
+# royalty-free, perpetual, license to use, copy, create derivative
+# works based on those contributions, and sublicense and distribute
+# those contributions and any derivatives thereof.
+# 
+# END BPS TAGGED BLOCK }}}
 package RT::Base;
 use Carp;
 use Scalar::Util;
@@ -30,17 +54,28 @@ use vars qw(@EXPORT);
 
 @EXPORT=qw(loc CurrentUser);
 
-=head1 FUNCTIONS
+=head1 NAME
+
+RT::Base
 
 
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+=head1 FUNCTIONS
+
+=cut
 
 # {{{ sub CurrentUser 
 
 =head2 CurrentUser
 
 If called with an argument, sets the current user to that user object.
-This will affect ACL decisions, etc.  
-Returns the current user
+This will affect ACL decisions, etc. The argument can be either
+L<RT::CurrentUser> or L<RT::User> object.
+
+Returns the current user object of L<RT::CurrentUser> class.
 
 =cut
 
@@ -49,16 +84,30 @@ sub CurrentUser {
 
     if (@_) {
         $self->{'original_user'} = $self->{'user'};
-        $self->{'user'} = shift;
-        Scalar::Util::weaken($self->{'user'}) if (ref($self->{'user'}) &&
-                                                    $self->{'user'} == $self );
+        my $current_user = $_[0];
+        if ( ref $current_user eq 'RT::User' ) {
+            $self->{'user'} = new RT::CurrentUser;
+            $self->{'user'}->Load( $current_user->id );
+        } else {
+            $self->{'user'} = $current_user;
+        }
+        # We need to weaken the CurrentUser ($self->{'user'}) reference
+        # if the object in question is the currentuser object.
+        # This avoids memory leaks.
+        Scalar::Util::weaken($self->{'user'})
+            if ref $self->{'user'} && $self->{'user'} == $self;
     }
 
-    unless ( ref( $self->{'user'}) ) {
-        $RT::Logger->err( "$self was created without a CurrentUser\n" . Carp::cluck() );
-        return (0);
-        die;
+    unless ( ref $self->{'user'} && $self->{'user'}->isa('RT::CurrentUser') ) {
+        my $msg = "$self was created without a CurrentUser."
+            ." Any RT object which is subclass of RT::Base must be created"
+            ." with a RT::CurrentUser or a RT::User obejct as the first argument.";
+        $msg .= "\n". Carp::cluck() if @_;
+
+        $RT::Logger->err( $msg );
+        return $self->{'user'} = undef;
     }
+
     return ( $self->{'user'} );
 }
 
@@ -76,7 +125,7 @@ sub OriginalUser {
 }
 
 
-=item loc LOC_STRING
+=head2 loc LOC_STRING
 
 l is a method which takes a loc string
 to this object's CurrentUser->LanguageHandle for localization. 
@@ -103,6 +152,18 @@ sub loc {
     }
 }
 
+sub loc_fuzzy {
+    my $self = shift;
+    if (my $user = $self->OriginalUser) {
+        return $user->loc_fuzzy(@_);
+    }
+    else {
+        use Carp;
+        Carp::confess("No currentuser");
+        return ("Critical error:$self has no CurrentUser", $self);
+    }
+}
+
 eval "require RT::Base_Vendor";
 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Base_Vendor.pm});
 eval "require RT::Base_Local";