1 # BEGIN BPS TAGGED BLOCK {{{
5 # This software is Copyright (c) 1996-2009 Best Practical Solutions, LLC
6 # <jesse@bestpractical.com>
8 # (Except where explicitly superseded by other copyright notices)
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
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.
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.
30 # CONTRIBUTION SUBMISSION POLICY:
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.)
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.
47 # END BPS TAGGED BLOCK }}}
56 @EXPORT=qw(loc CurrentUser);
75 If called with an argument, sets the current user to that user object.
76 This will affect ACL decisions, etc. The argument can be either
77 L<RT::CurrentUser> or L<RT::User> object.
79 Returns the current user object of L<RT::CurrentUser> class.
87 $self->{'original_user'} = $self->{'user'};
88 my $current_user = $_[0];
89 if ( ref $current_user eq 'RT::User' ) {
90 $self->{'user'} = new RT::CurrentUser;
91 $self->{'user'}->Load( $current_user->id );
93 $self->{'user'} = $current_user;
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;
102 unless ( ref $self->{'user'} && $self->{'user'}->isa('RT::CurrentUser') ) {
103 my $msg = "$self was created without a CurrentUser."
104 ." Any RT object which is subclass of RT::Base must be created"
105 ." with a RT::CurrentUser or a RT::User object as the first argument.";
106 $msg .= "\n". Carp::longmess() if @_;
108 $RT::Logger->error( $msg );
109 return $self->{'user'} = undef;
112 return ( $self->{'user'} );
121 $self->{'original_user'} = shift;
122 Scalar::Util::weaken($self->{'original_user'})
123 if (ref($self->{'original_user'}) && $self->{'original_user'} == $self );
125 return ( $self->{'original_user'} || $self->{'user'} );
129 =head2 loc LOC_STRING
131 l is a method which takes a loc string
132 to this object's CurrentUser->LanguageHandle for localization.
134 you call it like this:
136 $self->loc("I have [quant,_1,concrete mixer].", 6);
138 In english, this would return:
139 I have 6 concrete mixers.
146 if (my $user = $self->OriginalUser) {
147 return $user->loc(@_);
150 Carp::confess("No currentuser");
151 return ("Critical error:$self has no CurrentUser", $self);
157 if (my $user = $self->OriginalUser) {
158 return $user->loc_fuzzy(@_);
161 Carp::confess("No currentuser");
162 return ("Critical error:$self has no CurrentUser", $self);
166 eval "require RT::Base_Vendor";
167 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Base_Vendor.pm});
168 eval "require RT::Base_Local";
169 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Base_Local.pm});