rt/lib/RT/Base.pm

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