import rt 3.4.6
[freeside.git] / rt / lib / RT / Base.pm
index 3b2dcfd..f329221 100644 (file)
@@ -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-2005 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
 # 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., 675 Mass Ave, Cambridge, MA 02139, USA.
+# 
+# 
+# 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;
 
 use strict;
 use vars qw(@EXPORT);
 
 @EXPORT=qw(loc CurrentUser);
 
-=head1 FUNCTIONS
+=head1 NAME
+
+RT::Base
 
 
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+=head1 FUNCTIONS
+
+=cut
 
 # {{{ sub CurrentUser 
 
@@ -47,23 +79,37 @@ sub CurrentUser {
     my $self = shift;
 
     if (@_) {
+        $self->{'original_user'} = $self->{'user'};
         $self->{'user'} = shift;
+        # 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 ( $self->{'user'} ) {
-        $RT::Logger->err(
-                  "$self was created without a CurrentUser\n" . Carp::cluck() );
+    unless ( ref( $self->{'user'}) ) {
+        $RT::Logger->err( "$self was created without a CurrentUser\n" . Carp::cluck() );
         return (0);
-        die;
     }
     return ( $self->{'user'} );
 }
 
 # }}}
 
+sub OriginalUser {
+    my $self = shift;
+
+    if (@_) {
+        $self->{'original_user'} = shift;
+        Scalar::Util::weaken($self->{'original_user'})
+            if (ref($self->{'original_user'}) && $self->{'original_user'} == $self );
+    }
+    return ( $self->{'original_user'} || $self->{'user'} );
+}
 
 
-=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. 
@@ -80,12 +126,26 @@ In english, this would return:
 
 sub loc {
     my $self = shift;
-    unless ($self->CurrentUser) {
+    if (my $user = $self->OriginalUser) {
+        return $user->loc(@_);
+    }
+    else {
+        use Carp;
+        Carp::confess("No currentuser");
+        return ("Critical error:$self has no CurrentUser", $self);
+    }
+}
+
+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);
     }
-    return($self->CurrentUser->loc(@_));
 }
 
 eval "require RT::Base_Vendor";