/usr/share/perl5/CGI/Application/Plugin/Forward.pm is in libcgi-application-plugin-forward-perl 1.06-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 | package CGI::Application::Plugin::Forward;
use warnings;
use strict;
use Carp;
use vars qw(@ISA @EXPORT);
@ISA = ('Exporter');
@EXPORT = ('forward');
=head1 NAME
CGI::Application::Plugin::Forward - Pass control from one run mode to another
=head1 VERSION
Version 1.06
=cut
our $VERSION = '1.06';
use CGI::Application;
if (CGI::Application->can('new_hook')) {
CGI::Application->new_hook('forward_prerun');
}
=head1 SYNOPSIS
use base 'CGI::Application';
use CGI::Application::Plugin::Forward;
sub setup {
my $self = shift;
$self->run_modes([qw(
start
second_runmode
)]);
}
sub start {
my $self = shift;
return $self->forward('second_runmode');
}
sub second_runmode {
my $self = shift;
my $rm = $self->get_current_runmode; # 'second_runmode'
}
=head1 DESCRIPTION
The forward method passes control to another run mode and returns its
output. This is equivalent to calling C<< $self->$other_runmode >>,
except that L<CGI::Application>'s internal value of the current run mode
is updated.
This means that calling C<< $self->get_current_runmode >> after calling
C<forward> will return the name of the new run mode. This is useful for
modules that depend on the name of the current run mode such as
L<CGI::Application::Plugin::AnyTemplate>.
For example, here's how to pass control to a run mode named C<other_action>
from C<start> while updating the value of C<current_run_mode>:
sub setup {
my $self = shift;
$self->run_modes({
start => 'start',
other_action => 'other_method',
});
}
sub start {
my $self = shift;
return $self->forward('other_action');
}
sub other_method {
my $self = shift;
my $rm = $self->get_current_runmode; # 'other_action'
}
Note that forward accepts the I<name> of the run mode (in this case
I<'other_action'>), which might not be the same as the name of the
method that handles the run mode (in this case I<'other_method'>)
You can still call C<< $self->other_method >> directly, but
C<current_run_mode> will not be updated:
sub setup {
my $self = shift;
$self->run_modes({
start => 'start',
other_action => 'other_method',
});
}
sub start {
my $self = shift;
return $self->other_method;
}
sub other_method {
my $self = shift;
my $rm = $self->get_current_runmode; # 'start'
}
Forward will work with coderef-based runmodes as well:
sub setup {
my $self = shift;
$self->run_modes({
start => 'start',
anon_action => sub {
my $self = shift;
my $rm = $self->get_current_runmode; # 'anon_action'
},
});
}
sub start {
my $self = shift;
return $self->forward('anon_action');
}
=head1 FORWARD vs. REDIRECT
Calling C<forward> changes the run mode of your application, but it
stays within the same HTTP request.
To redirect to a new runmode using a completely new web request, you
might consider using the C<redirect> method provided by
L<CGI::Application::Plugin::Redirect>.
The advantage of using an external redirect as opposed to an internal
forward is that it provides a 'clean break' between pages.
For instance, in a typical BREAD application (Browse, Read, Edit, Add,
Delete), after the user completes an action, you usually return the user
to the Browse list. For instance, when the user adds a new record
via a POST form, and your app returns them to the list of records.
If you use C<forward>, then you are still in the same request as the
original I<add record>. The user might hit I<reload>, expecting to
refresh the list of records. But in fact, I<reload> will attempt to
repost the I<add record> form. The user's browser might present a
warning about reposting the same data. The browser may refuse to
redisplay the page, due for caching reasons.
So in this case, it may make more sense to do a fresh HTTP redirect back
to the Browse list.
=head1 METHODS
=head2 forward
Runs another run mode passing any parameters you supply. Returns the
output of the new run mode.
return $self->forward('run_mode_name', @run_mode_params);
=cut
sub forward {
my $self = shift;
my $run_mode = shift;
if ($CGI::Application::Plugin::AutoRunmode::VERSION) {
if (CGI::Application::Plugin::AutoRunmode->can('is_auto_runmode')) {
if (CGI::Application::Plugin::AutoRunmode::is_auto_runmode($self, $run_mode)) {
$self->run_modes( $run_mode => $run_mode);
}
}
}
my %rm_map = $self->run_modes;
if (not exists $rm_map{$run_mode}) {
croak "CAP::Forward: run mode $run_mode does not exist";
}
my $method = $rm_map{$run_mode};
if ($self->can($method) or ref $method eq 'CODE') {
$self->{__CURRENT_RUNMODE} = $run_mode;
if ($self->can('call_hook')) {
$self->call_hook('forward_prerun');
}
return $self->$method(@_);
}
else {
croak "CAP::Forward: target method $method of run mode $run_mode does not exist";
}
}
=head1 HOOKS
Before the forwarded run mode is called, the C<forward_prerun> hook is
called. You can use this hook to do any prep work that you want to do
before any new run mode gains control.
This is similar to L<CGI::Application>'s built in C<cgiapp_prerun>
method, but it is called each time you call L<forward>; not just the
when your application starts.
sub setup {
my $self = shift;
$self->add_callback('forward_prerun' => \&prepare_rm_stuff);
}
sub prepare_rm_stuff {
my $self = shift;
# do any necessary prep work here....
}
Note that your hooked method will only be called when you call
L<forward>. If you never call C<forward>, the hook will not be called.
In particuar, the hook will not be called for your application's
C<start_mode>. For that, you still use C<cgiapp_prerun>.
If you want to have a method run for every run mode I<including> the
C<start_mode>, then you can call the hook directly from
C<cgiapp_prerun>.
sub setup {
my $self = shift;
$self->add_callback('forward_prerun' => \&prepare_rm_stuff);
}
sub cgiapp_prerun {
my $self = shift;
$self->prepare_rm_stuff;
}
sub prepare_rm_stuff {
my $self = shift;
# do any necessary prep work here....
}
Alternately, you can hook C<cgiapp_prerun> to the C<forward_prerun>
hook:
sub setup {
my $self = shift;
$self->add_callback('forward_prerun' => \&cgiapp_prerun);
}
sub cgiapp_prerun {
my $self = shift;
# do any necessary prep work here....
}
This is a less flexible solution, since certain things that can be done
in C<cgiapp_prerun> (like setting C<prerun_mode>) won't work when the
method is called from the C<forward_prerun> hook.
=head1 AUTHOR
Michael Graham, C<< <mag-perl@occamstoothbrush.com> >>
=head1 BUGS
Please report any bugs or feature requests to
C<bug-cgi-application-plugin-forward@rt.cpan.org>, or through the web interface at
L<http://rt.cpan.org>. I will be notified, and then you'll automatically
be notified of progress on your bug as I make changes.
=head1 ACKNOWLEDGEMENTS
Thanks to Mark Stosberg for the idea and...well...the implementation as
well.
=head1 COPYRIGHT & LICENSE
Copyright 2005 Michael Graham, All Rights Reserved.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
=cut
1; # End of CGI::Application::Plugin::Forward
|