1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
|
# BEGIN BPS TAGGED BLOCK {{{
#
# COPYRIGHT:
#
# This software is Copyright (c) 1996-2018 Best Practical Solutions, LLC
# <sales@bestpractical.com>
#
# (Except where explicitly superseded by other copyright notices)
#
#
# LICENSE:
#
# This work is made available to you under the terms of Version 2 of
# the GNU General Public License. A copy of that license should have
# been provided with this software, but in any event can be snarfed
# from www.gnu.org.
#
# This work is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301 or visit their web page on the internet at
# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
#
#
# CONTRIBUTION SUBMISSION POLICY:
#
# (The following paragraph is not intended to limit the rights granted
# to you to modify and distribute this software under the terms of
# the GNU General Public License and is only of importance to you if
# you choose to contribute your changes and enhancements to the
# community by submitting them to Best Practical Solutions, LLC.)
#
# By intentionally submitting any modifications, corrections or
# derivatives to this work, or any other work intended for use with
# Request Tracker, to Best Practical Solutions, LLC, you confirm that
# you are the copyright holder for those contributions and you grant
# Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable,
# royalty-free, perpetual, license to use, copy, create derivative
# works based on those contributions, and sublicense and distribute
# those contributions and any derivatives thereof.
#
# END BPS TAGGED BLOCK }}}
package RT::Base;
use Carp ();
use Scalar::Util ();
use strict;
use warnings;
use vars qw(@EXPORT);
@EXPORT=qw(loc CurrentUser);
=head1 NAME
RT::Base
=head1 SYNOPSIS
=head1 DESCRIPTION
=head1 FUNCTIONS
=cut
=head2 CurrentUser
If called with an argument, sets the current user to that user object.
This will affect ACL decisions, etc. The argument can be either
L<RT::CurrentUser> or L<RT::User> object.
Returns the current user object of L<RT::CurrentUser> class.
=cut
sub CurrentUser {
my $self = shift;
if (@_) {
$self->{'original_user'} = $self->{'user'};
my $current_user = $_[0];
if ( ref $current_user eq 'RT::User' ) {
$self->{'user'} = RT::CurrentUser->new;
$self->{'user'}->Load( $current_user->id );
} else {
$self->{'user'} = $current_user;
}
# We need to weaken the CurrentUser ($self->{'user'}) reference
# if the object in question is the currentuser object.
# This avoids memory leaks.
Scalar::Util::weaken($self->{'user'})
if ref $self->{'user'} && $self->{'user'} == $self;
}
return ( $self->{'user'} );
}
sub OriginalUser {
my $self = shift;
if (@_) {
$self->{'original_user'} = shift;
Scalar::Util::weaken($self->{'original_user'})
if (ref($self->{'original_user'}) && $self->{'original_user'} == $self );
}
return ( $self->{'original_user'} || $self->{'user'} );
}
=head2 loc LOC_STRING
l is a method which takes a loc string
to this object's CurrentUser->LanguageHandle for localization.
you call it like this:
$self->loc("I have [quant,_1,concrete mixer,concrete mixers].", 6);
In english, this would return:
I have 6 concrete mixers.
=cut
sub loc {
my $self = shift;
if (my $user = $self->OriginalUser) {
return $user->loc(@_);
}
else {
Carp::confess("No currentuser");
return ("Critical error:$self has no CurrentUser", $self);
}
}
sub loc_fuzzy {
my $self = shift;
if (my $user = $self->OriginalUser) {
return $user->loc_fuzzy(@_);
}
else {
Carp::confess("No currentuser");
return ("Critical error:$self has no CurrentUser", $self);
}
}
=head2 _ImportOverlays
C<_ImportOverlays> is an internal method used to modify or add functionality
to existing RT code. For more on how to use overlays with RT, please see the
documentation in L<RT::StyleGuide>.
=cut
sub _ImportOverlays {
my $class = shift;
my ($package,undef,undef) = caller();
$package =~ s|::|/|g;
for my $type (qw(Overlay Vendor Local)) {
my $filename = $package."_".$type.".pm";
eval { require $filename };
die $@ if ($@ && $@ !~ m{^Can't locate $filename});
}
}
__PACKAGE__->_ImportOverlays();
1;
|