1 # BEGIN BPS TAGGED BLOCK {{{
5 # This software is Copyright (c) 1996-2011 Best Practical Solutions, LLC
6 # <sales@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 }}}
57 @EXPORT=qw(loc CurrentUser);
76 If called with an argument, sets the current user to that user object.
77 This will affect ACL decisions, etc. The argument can be either
78 L<RT::CurrentUser> or L<RT::User> object.
80 Returns the current user object of L<RT::CurrentUser> class.
88 $self->{'original_user'} = $self->{'user'};
89 my $current_user = $_[0];
90 if ( ref $current_user eq 'RT::User' ) {
91 $self->{'user'} = RT::CurrentUser->new;
92 $self->{'user'}->Load( $current_user->id );
94 $self->{'user'} = $current_user;
96 # We need to weaken the CurrentUser ($self->{'user'}) reference
97 # if the object in question is the currentuser object.
98 # This avoids memory leaks.
99 Scalar::Util::weaken($self->{'user'})
100 if ref $self->{'user'} && $self->{'user'} == $self;
103 unless ( ref $self->{'user'} && $self->{'user'}->isa('RT::CurrentUser') ) {
104 my $msg = "$self was created without a CurrentUser."
105 ." Any RT object which is subclass of RT::Base must be created"
106 ." with a RT::CurrentUser or a RT::User object as the first argument.";
107 $msg .= "\n". Carp::longmess() if @_;
109 $RT::Logger->error( $msg );
110 return $self->{'user'} = undef;
113 return ( $self->{'user'} );
122 $self->{'original_user'} = shift;
123 Scalar::Util::weaken($self->{'original_user'})
124 if (ref($self->{'original_user'}) && $self->{'original_user'} == $self );
126 return ( $self->{'original_user'} || $self->{'user'} );
130 =head2 loc LOC_STRING
132 l is a method which takes a loc string
133 to this object's CurrentUser->LanguageHandle for localization.
135 you call it like this:
137 $self->loc("I have [quant,_1,concrete mixer].", 6);
139 In english, this would return:
140 I have 6 concrete mixers.
147 if (my $user = $self->OriginalUser) {
148 return $user->loc(@_);
151 Carp::confess("No currentuser");
152 return ("Critical error:$self has no CurrentUser", $self);
158 if (my $user = $self->OriginalUser) {
159 return $user->loc_fuzzy(@_);
162 Carp::confess("No currentuser");
163 return ("Critical error:$self has no CurrentUser", $self);
167 sub _ImportOverlays {
169 my ($package,undef,undef) = caller();
170 $package =~ s|::|/|g;
171 for (qw(Overlay Vendor Local)) {
172 my $filename = $package."_".$_.".pm";
173 eval { require $filename };
174 die $@ if ($@ && $@ !~ qr{^Can't locate $filename});
178 __PACKAGE__->_ImportOverlays();