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.
  76 Returns the current user
  77
  78 =cut
  79
  80 sub CurrentUser {
  81     my $self = shift;
  82
  83     if (@_) {
  84         $self->{'original_user'} = $self->{'user'};
  85         $self->{'user'} = shift;
  86         # We need to weaken the CurrentUser ($self->{'user'}) reference
  87         # if the object in question is the currentuser object.
  88         # This avoids memory leaks.
  89         Scalar::Util::weaken($self->{'user'}) if (ref($self->{'user'}) &&
  90                                                     $self->{'user'} == $self );
  91     }
  92
  93     unless ( ref( $self->{'user'}) ) {
  94         $RT::Logger->err( "$self was created without a CurrentUser\n" . Carp::cluck() );
  95         return (0);
  96     }
  97     return ( $self->{'user'} );
  98 }
  99
 100 # }}}
 101
 102 sub OriginalUser {
 103     my $self = shift;
 104
 105     if (@_) {
 106         $self->{'original_user'} = shift;
 107         Scalar::Util::weaken($self->{'original_user'})
 108             if (ref($self->{'original_user'}) && $self->{'original_user'} == $self );
 109     }
 110     return ( $self->{'original_user'} || $self->{'user'} );
 111 }
 112
 113
 114 =head2 loc LOC_STRING
 115
 116 l is a method which takes a loc string
 117 to this object's CurrentUser->LanguageHandle for localization.
 118
 119 you call it like this:
 120
 121     $self->loc("I have [quant,_1,concrete mixer].", 6);
 122
 123 In english, this would return:
 124     I have 6 concrete mixers.
 125
 126
 127 =cut
 128
 129 sub loc {
 130     my $self = shift;
 131     if (my $user = $self->OriginalUser) {
 132         return $user->loc(@_);
 133     }
 134     else {
 135         use Carp;
 136         Carp::confess("No currentuser");
 137         return ("Critical error:$self has no CurrentUser", $self);
 138     }
 139 }
 140
 141 sub loc_fuzzy {
 142     my $self = shift;
 143     if (my $user = $self->OriginalUser) {
 144         return $user->loc_fuzzy(@_);
 145     }
 146     else {
 147         use Carp;
 148         Carp::confess("No currentuser");
 149         return ("Critical error:$self has no CurrentUser", $self);
 150     }
 151 }
 152
 153 eval "require RT::Base_Vendor";
 154 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Base_Vendor.pm});
 155 eval "require RT::Base_Local";
 156 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Base_Local.pm});
 157
 158
 159 1;