rt/lib/RT/Base.pm

   1 # {{{ BEGIN BPS TAGGED BLOCK
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2004 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., 675 Mass Ave, Cambridge, MA 02139, USA.
  26 #
  27 #
  28 # CONTRIBUTION SUBMISSION POLICY:
  29 #
  30 # (The following paragraph is not intended to limit the rights granted
  31 # to you to modify and distribute this software under the terms of
  32 # the GNU General Public License and is only of importance to you if
  33 # you choose to contribute your changes and enhancements to the
  34 # community by submitting them to Best Practical Solutions, LLC.)
  35 #
  36 # By intentionally submitting any modifications, corrections or
  37 # derivatives to this work, or any other work intended for use with
  38 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
  39 # you are the copyright holder for those contributions and you grant
  40 # Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
  41 # royalty-free, perpetual, license to use, copy, create derivative
  42 # works based on those contributions, and sublicense and distribute
  43 # those contributions and any derivatives thereof.
  44 #
  45 # }}} END BPS TAGGED BLOCK
  46 package RT::Base;
  47 use Carp;
  48 use Scalar::Util;
  49
  50 use strict;
  51 use vars qw(@EXPORT);
  52
  53 @EXPORT=qw(loc CurrentUser);
  54
  55 =head1 FUNCTIONS
  56
  57
  58
  59 # {{{ sub CurrentUser
  60
  61 =head2 CurrentUser
  62
  63 If called with an argument, sets the current user to that user object.
  64 This will affect ACL decisions, etc.
  65 Returns the current user
  66
  67 =cut
  68
  69 sub CurrentUser {
  70     my $self = shift;
  71
  72     if (@_) {
  73         $self->{'original_user'} = $self->{'user'};
  74         $self->{'user'} = shift;
  75         Scalar::Util::weaken($self->{'user'}) if (ref($self->{'user'}) &&
  76                                                     $self->{'user'} == $self );
  77     }
  78
  79     unless ( ref( $self->{'user'}) ) {
  80         $RT::Logger->err( "$self was created without a CurrentUser\n" . Carp::cluck() );
  81         return (0);
  82         die;
  83     }
  84     return ( $self->{'user'} );
  85 }
  86
  87 # }}}
  88
  89 sub OriginalUser {
  90     my $self = shift;
  91
  92     if (@_) {
  93         $self->{'original_user'} = shift;
  94         Scalar::Util::weaken($self->{'original_user'})
  95             if (ref($self->{'original_user'}) && $self->{'original_user'} == $self );
  96     }
  97     return ( $self->{'original_user'} || $self->{'user'} );
  98 }
  99
 100
 101 =item loc LOC_STRING
 102
 103 l is a method which takes a loc string
 104 to this object's CurrentUser->LanguageHandle for localization.
 105
 106 you call it like this:
 107
 108     $self->loc("I have [quant,_1,concrete mixer].", 6);
 109
 110 In english, this would return:
 111     I have 6 concrete mixers.
 112
 113
 114 =cut
 115
 116 sub loc {
 117     my $self = shift;
 118     if (my $user = $self->OriginalUser) {
 119         return $user->loc(@_);
 120     }
 121     else {
 122         use Carp;
 123         Carp::confess("No currentuser");
 124         return ("Critical error:$self has no CurrentUser", $self);
 125     }
 126 }
 127
 128 eval "require RT::Base_Vendor";
 129 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Base_Vendor.pm});
 130 eval "require RT::Base_Local";
 131 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Base_Local.pm});
 132
 133
 134 1;