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