rt/lib/RT/Base.pm

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