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 }}}
49 package RT::Interface::Web::Request;
54 our $VERSION = '0.30';
55 use base qw(HTML::Mason::Request);
60 my $new_class = $HTML::Mason::ApacheHandler::VERSION ?
61 'HTML::Mason::Request::ApacheHandler' :
62 $HTML::Mason::CGIHandler::VERSION ?
63 'HTML::Mason::Request::CGI' :
64 'HTML::Mason::Request';
66 $class->alter_superclass( $new_class );
67 $class->valid_params( %{ $new_class->valid_params } );
68 return $class->SUPER::new(@_);
71 # XXX TODO: This alter_superclass replaces teh funcitonality in Mason 1.39
72 # with code which doesn't trigger a bug in Perl 5.10.
73 # (Perl 5.10.0 does NOT take kindly to having its @INC entries changed)
74 # http://rt.perl.org/rt3/Public/Bug/Display.html?id=54566
76 # This routine can be removed when either:
77 # * RT depends on a version of mason which contains this fix
78 # * Perl 5.10.0 is not supported for running RT
79 sub alter_superclass {
81 my $new_super = shift;
83 { no strict 'refs'; my @entries = @{$class."::ISA"}; $isa_ref = \@entries; }
85 # handles multiple inheritance properly and preserve
87 for ( my $x = 0; $x <= $#{$isa_ref} ; $x++ ) {
88 if ( $isa_ref->[$x]->isa('HTML::Mason::Request') ) {
89 my $old_super = $isa_ref->[$x];
90 $isa_ref->[$x] = $new_super
91 if ( $old_super ne $new_super );
96 { no strict 'refs'; @{$class."::ISA"} = @$isa_ref; }
97 $class->valid_params( %{ $class->valid_params } );
103 Method replaces deprecated component C<Element/Callback>.
105 Takes hash with optional C<CallbackPage>, C<CallbackName>
106 and C<CallbackOnce> arguments, other arguments are passed
107 throught to callback components.
113 Page path relative to the root, leading slash is mandatory.
114 By default is equal to path of the caller component.
118 Name of the callback. C<Default> is used unless specified.
122 By default is false, otherwise runs callbacks only once per
123 process of the server. Such callbacks can be used to fill
128 Searches for callback components in
129 F<< /Callbacks/<any dir>/CallbackPage/CallbackName >>, for
130 example F</Callbacks/MyExtension/autohandler/Default> would
131 be called as default callback for F</autohandler>.
139 my ($self, %args) = @_;
141 my $name = delete $args{'CallbackName'} || 'Default';
142 my $page = delete $args{'CallbackPage'} || $self->callers(0)->path;
144 $RT::Logger->error("Couldn't get a page name for callbacks");
148 my $CacheKey = "$page--$name";
149 return 1 if delete $args{'CallbackOnce'} && $called{ $CacheKey };
150 $called{ $CacheKey } = 1;
152 my $callbacks = $cache{ $CacheKey };
153 unless ( $callbacks ) {
155 my $path = "/Callbacks/*$page/$name";
156 my @roots = map $_->[1],
157 $HTML::Mason::VERSION <= 1.28
158 ? $self->interp->resolver->comp_root_array
159 : $self->interp->comp_root_array;
163 grep defined && length,
164 # Skip backup files, files without a leading package name,
165 # and files we've already seen
166 grep !$seen{$_}++ && !m{/\.} && !m{~$} && m{^/Callbacks/[^/]+\Q$page/$name\E$},
167 map { sort $self->interp->resolver->glob_path($path, $_) }
170 foreach my $comp (keys %seen) {
171 next unless $seen{$comp} > 1;
172 $RT::Logger->error("Found more than one occurrence of the $comp callback. This may cause only one of the callbacks to run. Look for the duplicate Callback in your @roots");
175 $cache{ $CacheKey } = $callbacks unless RT->Config->Get('DevelMode');
179 foreach my $cb ( @$callbacks ) {
180 push @rv, scalar $self->comp( $cb, %args );
188 Returns path of the request.
190 Very close to C<< $m->request_comp->path >>, but if called in a dhandler returns
191 path of the request without dhandler name, but with dhandler arguments instead.
198 my $path = $self->request_comp->path;
199 # disabled dhandlers, not RT case, but anyway
200 return $path unless my $dh_name = $self->dhandler_name;
202 return $path unless substr($path, -length("/$dh_name")) eq "/$dh_name";
203 substr($path, -length $dh_name) = $self->dhandler_arg;