rt/lib/RT/Base.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2007 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/copyleft/gpl.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 package RT::Base;
  49 use Carp;
  50 use Scalar::Util;
  51
  52 use strict;
  53 use vars qw(@EXPORT);
  54
  55 @EXPORT=qw(loc CurrentUser);
  56
  57 =head1 NAME
  58
  59 RT::Base
  60
  61
  62 =head1 SYNOPSIS
  63
  64 =head1 DESCRIPTION
  65
  66 =head1 FUNCTIONS
  67
  68 =cut
  69
  70 # {{{ sub CurrentUser
  71
  72 =head2 CurrentUser
  73
  74 If called with an argument, sets the current user to that user object.
  75 This will affect ACL decisions, etc. The argument can be either
  76 L<RT::CurrentUser> or L<RT::User> object.
  77
  78 Returns the current user object of L<RT::CurrentUser> class.
  79
  80 =cut
  81
  82 sub CurrentUser {
  83     my $self = shift;
  84
  85     if (@_) {
  86         $self->{'original_user'} = $self->{'user'};
  87         my $current_user = $_[0];
  88         if ( ref $current_user eq 'RT::User' ) {
  89             $self->{'user'} = new RT::CurrentUser;
  90             $self->{'user'}->Load( $current_user->id );
  91         } else {
  92             $self->{'user'} = $current_user;
  93         }
  94         # We need to weaken the CurrentUser ($self->{'user'}) reference
  95         # if the object in question is the currentuser object.
  96         # This avoids memory leaks.
  97         Scalar::Util::weaken($self->{'user'})
  98             if ref $self->{'user'} && $self->{'user'} == $self;
  99     }
 100
 101     unless ( ref $self->{'user'} && $self->{'user'}->isa('RT::CurrentUser') ) {
 102         my $msg = "$self was created without a CurrentUser."
 103             ." Any RT object which is subclass of RT::Base must be created"
 104             ." with a RT::CurrentUser or a RT::User obejct as the first argument.";
 105         $msg .= "\n". Carp::cluck() if @_;
 106
 107         $RT::Logger->err( $msg );
 108         return $self->{'user'} = undef;
 109     }
 110
 111     return ( $self->{'user'} );
 112 }
 113
 114 # }}}
 115
 116 sub OriginalUser {
 117     my $self = shift;
 118
 119     if (@_) {
 120         $self->{'original_user'} = shift;
 121         Scalar::Util::weaken($self->{'original_user'})
 122             if (ref($self->{'original_user'}) && $self->{'original_user'} == $self );
 123     }
 124     return ( $self->{'original_user'} || $self->{'user'} );
 125 }
 126
 127
 128 =head2 loc LOC_STRING
 129
 130 l is a method which takes a loc string
 131 to this object's CurrentUser->LanguageHandle for localization.
 132
 133 you call it like this:
 134
 135     $self->loc("I have [quant,_1,concrete mixer].", 6);
 136
 137 In english, this would return:
 138     I have 6 concrete mixers.
 139
 140
 141 =cut
 142
 143 sub loc {
 144     my $self = shift;
 145     if (my $user = $self->OriginalUser) {
 146         return $user->loc(@_);
 147     }
 148     else {
 149         use Carp;
 150         Carp::confess("No currentuser");
 151         return ("Critical error:$self has no CurrentUser", $self);
 152     }
 153 }
 154
 155 sub loc_fuzzy {
 156     my $self = shift;
 157     if (my $user = $self->OriginalUser) {
 158         return $user->loc_fuzzy(@_);
 159     }
 160     else {
 161         use Carp;
 162         Carp::confess("No currentuser");
 163         return ("Critical error:$self has no CurrentUser", $self);
 164     }
 165 }
 166
 167 eval "require RT::Base_Vendor";
 168 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Base_Vendor.pm});
 169 eval "require RT::Base_Local";
 170 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Base_Local.pm});
 171
 172
 173 1;