2 use base qw(Class::Accessor::Fast Class::Data::Inheritable);
3 use UNIVERSAL::require;
7 use Maypole::Constants;
11 our $VERSION = '2.11';
13 # proposed privacy conventions:
14 # - no leading underscore - public to custom application code and plugins
15 # - single leading underscore - private to the main Maypole stack - *not*
17 # - double leading underscore - private to the current package
21 Maypole - MVC web application framework
25 The canonical example used in the Maypole documentation is the beer database:
31 # choose a frontend, initialise the config object, and load a plugin
32 use Maypole::Application qw/Relationship/;
34 # get the empty config object created by Maypole::Application
35 my $config = __PACKAGE__->config;
38 $config->uri_base("http://localhost/beerdb");
39 $config->template_root("/path/to/templates");
40 $config->rows_per_page(10);
41 $config->display_tables([qw/beer brewery pub style/]);
44 $config->relationships([
45 "a brewery produces beers",
46 "a style defines beers",
47 "a pub has beers on handpumps",
51 BeerDB::Brewery->untaint_columns( printable => [qw/name notes url/] );
52 BeerDB::Pub->untaint_columns( printable => [qw/name notes url/] );
53 BeerDB::Style->untaint_columns( printable => [qw/name notes/] );
54 BeerDB::Beer->untaint_columns(
55 printable => [qw/abv name price notes/],
56 integer => [qw/style brewery score/],
61 __PACKAGE__->setup("dbi:SQLite:t/beerdb.db");
67 This documents the Maypole request object. See the L<Maypole::Manual>, for a
68 detailed guide to using Maypole.
70 Maypole is a Perl web application framework similar to Java's struts. It is
71 essentially completely abstracted, and so doesn't know anything about
72 how to talk to the outside world.
74 To use it, you need to create a driver package which represents your entire
75 application. This is the C<BeerDB> package used as an example in the manual.
77 This needs to first use L<Maypole::Application> which will make your package
78 inherit from the appropriate platform driver such as C<Apache::MVC> or
79 C<CGI::Maypole>. Then, the driver calls C<setup>. This sets up the model classes
80 and configures your application. The default model class for Maypole uses
81 L<Class::DBI> to map a database to classes, but this can be changed by altering
82 configuration (B<before> calling setup.)
85 =head1 DOCUMENTATION AND SUPPORT
87 Note that some details in some of these resources may be out of date.
91 =item The Maypole Manual
93 The primary documentation is the Maypole manual. This lives in the
94 C<Maypole::Manual> pod documents included with the distribution.
98 Individual packages within the distribution contain (more or less) detailed
99 reference documentation for their API.
103 There are two mailing lists - maypole-devel and maypole-users - see
104 http://maypole.perl.org/?MailingList
106 =item The Maypole Wiki
108 The Maypole wiki provides a useful store of extra documentation -
109 http://maypole.perl.org
111 In particular, there's a FAQ (http://maypole.perl.org/?FAQ) and a cookbook
112 (http://maypole.perl.org/?Cookbook). Again, certain information on these pages
115 =item Web applications with Maypole
117 A tutorial written by Simon Cozens for YAPC::EU 2005 -
118 http://www.droogs.org/perl/maypole/maypole-tutorial.pdf [228KB].
120 =item A Database-Driven Web Application in 18 Lines of Code
122 By Paul Barry, published in Linux Journal, March 2005.
124 http://www.linuxjournal.com/article/7937
126 "From zero to Web-based database application in eight easy steps".
128 Maypole won a 2005 Linux Journal Editor's Choice Award
129 (http://www.linuxjournal.com/article/8293) after featuring in this article.
131 =item Build Web apps with Maypole
133 By Simon Cozens, on IBM's DeveloperWorks website, May 2004.
135 http://www-128.ibm.com/developerworks/linux/library/l-maypole/
137 =item Rapid Web Application Deployment with Maypole
139 By Simon Cozens, on O'Reilly's Perl website, April 2004.
141 http://www.perl.com/pub/a/2004/04/15/maypole.html
145 Some notes written by Simon Cozens. A little bit out of date, but still
146 very useful: http://www.droogs.org/perl/maypole/authentication.html
150 There's a refcard for the Maypole (and Class::DBI) APIs on the wiki -
151 http://maypole.perl.org/?CheatSheet. Probably a little out of date now - it's a
152 wiki, so feel free to fix any errors!
154 =item Plugins and add-ons
156 There are a large and growing number of plugins and other add-on modules
157 available on CPAN - http://search.cpan.org/search?query=maypole&mode=module
161 You can find a range of useful Maypole links, particularly to several thoughtful
162 blog entries, starting here: http://del.icio.us/search/?all=maypole
166 There are a couple of short reviews here:
167 http://cpanratings.perl.org/dist/Maypole
173 A couple of demos are available, sometimes with source code and configs.
177 =item http://maypole.perl.org/beerdb/
179 The standard BeerDB example, using the TT factory templates supplied in the
182 =item beerdb.riverside-cms.co.uk
184 The standard BeerDB example, running on Mason, using the factory templates
185 supplied in the L<MasonX::Maypole> distribution.
187 =item beerfb.riverside-cms.co.uk
189 A demo of L<Maypole::FormBuilder>. This site is running on the set of Mason
190 templates included in the L<Maypole::FormBuilder> distribution. See the
191 synopsis of L<Maypole::Plugin::FormBuilder> for an example driver
197 __PACKAGE__->mk_classdata($_) for qw( config init_done view_object );
199 __PACKAGE__->mk_accessors(
200 qw( params query objects model_class template_args output path
201 args action template error document_encoding content_type table
202 headers_in headers_out stash status)
205 __PACKAGE__->config( Maypole::Config->new() );
207 __PACKAGE__->init_done(0);
209 =head1 HOOKABLE METHODS
211 As a framework, Maypole provides a number of B<hooks> - methods that are
212 intended to be overridden. Some of these methods come with useful default
213 behaviour, others do nothing by default. Hooks include:
239 sub My::App::debug {1}
241 Returns the debugging flag. Override this in your application class to
242 enable/disable debugging.
244 You can also set the C<debug> flag via L<Maypole::Application>.
246 Some packages respond to higher debug levels, try increasing it to 2 or 3.
255 Returns the L<Maypole::Config> object
259 My::App->setup($data_source, $user, $password, \%attr);
261 Initialise the Maypole application and plugins and model classes - see
262 L<Maypole::Manual::Plugins>.
264 If your model is based on L<Maypole::Model::CDBI>, the C<\%attr> hashref can
265 contain options that are passed directly to L<Class::DBI::Loader>, to control
266 how the model hierarchy is constructed.
268 Your application should call this B<after> setting up configuration data via
277 $class->setup_model(@_);
282 Called by C<setup>. This method builds the Maypole model hierarchy.
284 A likely target for over-riding, if you need to build a customised model.
286 This method also ensures any code in custom model classes is loaded, so you
287 don't need to load them in the driver.
295 $class = ref $class if ref $class;
297 my $config = $class->config;
299 $config->model || $config->model('Maypole::Model::CDBI');
301 $config->model->require or die sprintf
302 "Couldn't load the model class %s: %s", $config->model, $@;
304 # among other things, this populates $config->classes
305 $config->model->setup_database($config, $class, @_);
307 foreach my $subclass ( @{ $config->classes } )
310 unshift @{ $subclass . "::ISA" }, $config->model;
312 # Load custom model code, if it exists - nb this must happen after the
313 # unshift, to allow code attributes to work, but before adopt(),
314 # in case adopt() calls overridden methods on $subclass
315 $class->load_model_subclass($subclass);
317 $config->model->adopt($subclass) if $config->model->can("adopt");
321 =item load_model_subclass($subclass)
323 This method is called from C<setup_model()>. It attempts to load the
324 C<$subclass> package, if one exists. So if you make a customized C<BeerDB::Beer>
325 package, you don't need to explicitly load it.
327 If, perhaps during development, you don't want to load up custom classes, you
328 can override this method and load them manually.
332 sub load_model_subclass
334 my ($class, $subclass) = @_;
336 my $config = $class->config;
338 # Load any external files for the model base class or subclasses
339 # (e.g. BeerDB/DBI.pm or BeerDB/Beer.pm) based on code borrowed from
340 # Maypole::Plugin::Loader and Class::DBI.
341 if ( $subclass->require )
343 warn "Loaded external module for '$subclass'\n" if $class->debug > 1;
347 (my $filename = $subclass) =~ s!::!/!g;
348 die "Loading '$subclass' failed: $@\n"
349 unless $@ =~ /Can\'t locate \Q$filename\E\.pm/;
350 warn "No external module for '$subclass'"
351 if $class->debug > 1;
357 Loads the view class and instantiates the view object.
359 You should not call this directly, but you may wish to override this to add
360 application-specific initialisation - see L<Maypole::Manual::Plugins>.
367 my $config = $class->config;
368 $config->view || $config->view("Maypole::View::TT");
369 $config->view->require;
370 die "Couldn't load the view class " . $config->view . ": $@" if $@;
371 $config->display_tables
372 || $config->display_tables( $class->config->tables );
373 $class->view_object( $class->config->view->new );
374 $class->init_done(1);
379 Constructs a very minimal new Maypole request object.
389 config => $class->config,
397 Get/set the Maypole::View object
401 =head1 INSTANCE METHODS
409 This method sets up the class if it's not done yet, sets some defaults and
410 leaves the dirty work to C<handler_guts>.
414 # handler() has a method attribute so that mod_perl will invoke
415 # BeerDB->handler() as a method rather than a plain function
416 # BeerDB::handler() and so this inherited implementation will be
417 # found. See e.g. "Practical mod_perl" by Bekman & Cholet for
418 # more information <http://modperlbook.org/html/ch25_01.html>
421 # See Maypole::Workflow before trying to understand this.
422 my ($class, $req) = @_;
424 $class->init unless $class->init_done;
426 my $self = $class->new;
428 # initialise the request
429 $self->headers_out(Maypole::Headers->new);
430 $self->get_request($req);
431 $self->parse_location;
433 # hook useful for declining static requests e.g. images, or perhaps for
434 # sanitizing request parameters
435 $self->status(Maypole::Constants::OK()); # set the default
436 $self->__call_hook('start_request_hook');
437 return $self->status unless $self->status == Maypole::Constants::OK();
439 die "status undefined after start_request_hook()" unless defined
445 my $status = $self->handler_guts;
447 # moving this here causes unit test failures - need to check why
448 # before committing the move
449 #$status = $self->__call_process_view unless $self->output;
451 return $status unless $status == OK;
453 # TODO: require send_output to return a status code
459 # Instead of making plugin authors use the NEXT::DISTINCT hoopla to ensure other
460 # plugins also get to call the hook, we can cycle through the application's
461 # @ISA and call them all here. Doesn't work for setup() though, because it's
462 # too ingrained in the stack. We could add a run_setup() method, but we'd break
463 # lots of existing code.
466 my ($self, $hook) = @_;
470 my $class = ref($self);
472 @plugins = @{"$class\::ISA"};
475 # this is either a custom method in the driver, or the method in the 1st
476 # plugin, or the 'null' method in the frontend (i.e. inherited from
477 # Maypole.pm) - we need to be careful to only call it once
478 my $first_hook = $self->can($hook);
481 my %seen = ( $first_hook => 1 );
483 # @plugins includes the frontend
484 foreach my $plugin (@plugins)
486 next unless my $plugin_hook = $plugin->can($hook);
487 next if $seen{$plugin_hook}++;
494 This is the main request handling method and calls various methods to handle the
495 request/response and defines the workflow within Maypole.
497 B<Currently undocumented and liable to be refactored without warning>.
501 # The root of all evil
506 $self->__load_request_model;
508 my $applicable = $self->is_model_applicable;
510 $self->__setup_plain_template unless $applicable;
514 eval { $status = $self->call_authenticate };
516 if ( my $error = $@ )
518 $status = $self->call_exception($error, "authentication");
522 warn "caught authenticate error: $error";
523 return $self->debug ?
524 $self->view_object->error($self, $error) : ERROR;
528 if ( $self->debug and $status != OK and $status != DECLINED )
530 $self->view_object->error( $self,
531 "Got unexpected status $status from calling authentication" );
534 return $status unless $status == OK;
536 # We run additional_data for every request
537 $self->additional_data;
541 eval { $self->model_class->process($self) };
543 if ( my $error = $@ )
545 $status = $self->call_exception($error, "model");
549 warn "caught model error: $error";
550 return $self->debug ?
551 $self->view_object->error($self, $error) : ERROR;
556 # less frequent path - perhaps output has been set to an error message
557 return OK if $self->output;
559 # normal path - no output has been generated yet
560 return $self->__call_process_view;
563 sub __load_request_model
566 $self->model_class( $self->config->model->class_of($self, $self->table) );
569 # is_applicable() returned false, so set up a plain template. Model processing
570 # will be skipped, but need to remove the model anyway so the template can't
572 sub __setup_plain_template
576 # It's just a plain template
577 $self->model_class(undef);
579 my $path = $self->path;
580 $path =~ s{/$}{}; # De-absolutify
583 $self->template($self->path);
586 # The model has been processed or skipped (if is_applicable returned false),
587 # any exceptions have been handled, and there's no content in $self->output
588 sub __call_process_view
594 eval { $status = $self->view_object->process($self) };
596 if ( my $error = $@ )
598 $status = $self->call_exception($error, "view");
602 warn "caught view error: $error" if $self->debug;
603 return $self->debug ?
604 $self->view_object->error($self, $error) : ERROR;
613 You should only need to define this method if you are writing a new
614 Maypole backend. It should return something that looks like an Apache
615 or CGI request object, it defaults to blank.
623 Turns the backend request (e.g. Apache::MVC, Maypole, CGI) into a Maypole
624 request. It does this by setting the C<path>, and invoking C<parse_path> and
627 You should only need to define this method if you are writing a new Maypole
634 die "parse_location is a virtual method. Do not use Maypole directly; " .
635 "use Apache::MVC or similar";
638 =item start_request_hook
640 This is called immediately after setting up the basic request. The default
643 The value of C<< $r->status >> is set to C<OK> before this hook is run. Your
644 implementation can change the status code, or leave it alone.
646 After this hook has run, Maypole will check the value of C<status>. For any
647 value other than C<OK>, Maypole returns the C<status> immediately.
649 This is useful for filtering out requests for static files, e.g. images, which
650 should not be processed by Maypole or by the templating engine:
652 sub start_request_hook
656 $r->status(DECLINED) if $r->path =~ /\.jpg$/;
659 Multiple plugins, and the driver, can define this hook - Maypole will call all
660 of them. You should check for and probably not change any non-OK C<status>
663 package Maypole::Plugin::MyApp::SkipFavicon;
665 sub start_request_hook
669 # check if a previous plugin has already DECLINED this request
670 # - probably unnecessary in this example, but you get the idea
671 return unless $r->status == OK;
674 $r->status(DECLINED) if $r->path =~ /favicon\.ico/;
679 sub start_request_hook { }
683 B<This method is deprecated> as of version 2.11. If you have overridden it,
684 please override C<is_model_applicable> instead, and change the return type
685 from a Maypole:Constant to a true/false value.
687 Returns a Maypole::Constant to indicate whether the request is valid.
689 =item is_model_applicable
691 Returns true or false to indicate whether the request is valid.
693 The default implementation checks that C<< $r->table >> is publicly
694 accessible and that the model class is configured to handle the
699 sub is_model_applicable
703 # cater for applications that are using obsolete version
704 if ($self->can('is_applicable'))
706 warn "DEPRECATION WARNING: rewrite is_applicable to the interface ".
707 "of Maypole::is_model_applicable\n";
708 return $self->is_applicable == OK;
711 # Establish which tables should be processed by the model
712 my $config = $self->config;
714 $config->ok_tables || $config->ok_tables( $config->display_tables );
716 $config->ok_tables( { map { $_ => 1 } @{ $config->ok_tables } } )
717 if ref $config->ok_tables eq "ARRAY";
719 my $ok_tables = $config->ok_tables;
721 # Does this request concern a table to be processed by the model?
722 my $table = $self->table;
726 if (exists $ok_tables->{$table})
733 warn "We don't have that table ($table).\n"
734 . "Available tables are: "
735 . join( ",", keys %$ok_tables )
736 if $self->debug and not $ok_tables->{$table};
741 # Is the action public?
742 my $action = $self->action;
743 return 1 if $self->model_class->is_public($action);
745 warn "The action '$action' is not applicable to the table '$table'"
753 Called immediately after C<start_request_hook()>.
755 This method should return a session, which will be stored in the request's
756 C<session> attribute.
758 The default method is empty.
766 Called immediately after C<get_session>.
768 This method should return a user, which will be stored in the request's C<user>
771 The default method is empty.
777 =item call_authenticate
779 This method first checks if the relevant model class
780 can authenticate the user, or falls back to the default
781 authenticate method of your Maypole application.
785 sub call_authenticate
789 # Check if we have a model class with an authenticate() to delegate to
790 return $self->model_class->authenticate($self)
791 if $self->model_class and $self->model_class->can('authenticate');
793 # Interface consistency is a Good Thing -
794 # the invocant and the argument may one day be different things
795 # (i.e. controller and request), like they are when authenticate()
796 # is called on a model class (i.e. model and request)
797 return $self->authenticate($self);
802 Returns a Maypole::Constant to indicate whether the user is authenticated for
805 The default implementation returns C<OK>
809 sub authenticate { return OK }
814 This model is called to catch exceptions, first after authenticate, then after
815 processing the model class, and finally to check for exceptions from the view
818 This method first checks if the relevant model class
819 can handle exceptions the user, or falls back to the default
820 exception method of your Maypole application.
826 my ($self, $error, $when) = @_;
828 # Check if we have a model class with an exception() to delegate to
829 if ( $self->model_class && $self->model_class->can('exception') )
831 my $status = $self->model_class->exception( $self, $error, $when );
832 return $status if $status == OK;
835 return $self->exception($error, $when);
841 This method is called if any exceptions are raised during the authentication or
842 model/view processing. It should accept the exception as a parameter and return
843 a Maypole::Constant to indicate whether the request should continue to be
849 my ($self, $error, $when) = @_;
850 if ($self->view_object->can("report_error") and $self->debug) {
851 $self->view_object->report_error($self, $error, $when);
857 =item additional_data
859 Called before the model processes the request, this method gives you a chance to
860 do some processing for each request, for example, manipulating C<template_args>.
864 sub additional_data { }
868 Sends the output and additional headers to the user.
873 die "send_output is a virtual method. Do not use Maypole directly; use Apache::MVC or similar";
881 =head2 Path processing and manipulation
887 Returns the request path
891 Parses the request path and sets the C<args>, C<action> and C<table>
892 properties. Calls C<preprocess_path> before parsing path and setting properties.
900 # Previous versions unconditionally set table, action and args to whatever
901 # was in @pi (or else to defaults, if @pi is empty).
902 # Adding preprocess_path(), and then setting table, action and args
903 # conditionally, broke lots of tests, hence this:
904 $self->$_(undef) for qw/action table args/;
906 $self->preprocess_path;
907 $self->path || $self->path('frontpage');
909 my @pi = grep {length} split '/', $self->path;
912 $self->table || $self->table(shift @pi);
913 $self->action || $self->action( shift @pi or 'index' );
914 $self->args || $self->args(\@pi);
917 =item preprocess_path
919 Sometimes when you don't want to rewrite or over-ride parse_path but
920 want to rewrite urls or extract data from them before it is parsed.
922 This method is called after parse_location has populated the request
923 information and before parse_path has populated the model and action
924 information, and is passed the request object.
926 You can set action, args or table in this method and parse_path will
927 then leave those values in place or populate them if not present
931 sub preprocess_path { };
933 =item make_path( %args or \%args or @args )
935 This is the counterpart to C<parse_path>. It generates a path to use
936 in links, form actions etc. To implement your own path scheme, just override
937 this method and C<parse_path>.
939 %args = ( table => $table,
941 additional => $additional, # optional - generally an object ID
944 \%args = as above, but a ref
946 @args = ( $table, $action, $additional ); # $additional is optional
948 C<id> can be used as an alternative key to C<additional>.
950 C<$additional> can be a string, an arrayref, or a hashref. An arrayref is
951 expanded into extra path elements, whereas a hashref is translated into a query
962 if (@_ == 1 and ref $_[0] and ref $_[0] eq 'HASH')
966 elsif ( @_ > 1 and @_ < 4 )
968 $args{table} = shift;
969 $args{action} = shift;
970 $args{additional} = shift;
977 do { die "no $_" unless $args{$_} } for qw( table action );
979 my $additional = $args{additional} || $args{id};
985 # if $additional is a href, make_uri() will transform it into a query
986 @add = (ref $additional eq 'ARRAY') ? @$additional : ($additional);
989 my $uri = $r->make_uri($args{table}, $args{action}, @add);
991 return $uri->as_string;
996 =item make_uri( @segments )
998 Make a L<URI> object given table, action etc. Automatically adds
1001 If the final element in C<@segments> is a hash ref, C<make_uri> will render it
1008 my ($r, @segments) = @_;
1010 my $query = (ref $segments[-1] eq 'HASH') ? pop(@segments) : undef;
1012 my $base = $r->config->uri_base;
1015 my $uri = URI->new($base);
1016 $uri->path_segments($uri->path_segments, grep {length} @segments);
1018 my $abs_uri = $uri->abs('/');
1019 $abs_uri->query_form($query) if $query;
1025 Turns post data and query string paramaters into a hash of C<params>.
1027 You should only need to define this method if you are writing a new Maypole
1034 die "parse_args() is a virtual method. Do not use Maypole directly; ".
1035 "use Apache::MVC or similar";
1038 =item get_template_root
1040 Implementation-specific path to template root.
1042 You should only need to define this method if you are writing a new Maypole
1043 backend. Otherwise, see L<Maypole::Config/"template_root">
1047 sub get_template_root {'.'}
1051 =head2 Request properties
1057 Returns the perl package name that will serve as the model for the
1058 request. It corresponds to the request C<table> attribute.
1063 Get/set a list of model objects. The objects will be accessible in the view
1066 If the first item in C<$self-E<gt>args> can be C<retrieve()>d by the model
1067 class, it will be removed from C<args> and the retrieved object will be added to
1068 the C<objects> list. See L<Maypole::Model> for more information.
1072 $self->template_args->{foo} = 'bar';
1074 Get/set a hash of template variables.
1078 A place to put custom application data. Not used by Maypole itself.
1082 Get/set the template to be used by the view. By default, it returns
1083 C<$self-E<gt>action>
1088 Get/set a request error
1092 Get/set the response output. This is usually populated by the view class. You
1093 can skip view processing by setting the C<output>.
1097 The table part of the Maypole request path
1101 The action part of the Maypole request path
1105 A list of remaining parts of the request path after table and action
1111 A L<Maypole::Headers> object containing HTTP headers for the request
1115 A L<HTTP::Headers> object that contains HTTP headers for the output
1117 =item document_encoding
1119 Get/set the output encoding. Default: utf-8.
1123 Get/set the output content type. Default: text/html
1127 Returns the protocol the request was made with, i.e. https
1132 die "get_protocol is a virtual method. Do not use Maypole directly; use Apache::MVC or similar";
1137 =head2 Request parameters
1139 The source of the parameters may vary depending on the Maypole backend, but they
1140 are usually populated from request query string and POST data.
1142 Maypole supplies several approaches for accessing the request parameters. Note
1143 that the current implementation (via a hashref) of C<query> and C<params> is
1144 likely to change in a future version of Maypole. So avoid direct access to these
1147 $r->{params}->{foo} # bad
1148 $r->params->{foo} # better
1150 $r->{query}->{foo} # bad
1151 $r->query->{foo} # better
1153 $r->param('foo') # best
1159 An accessor (get or set) for request parameters. It behaves similarly to
1160 CGI::param() for accessing CGI parameters, i.e.
1162 $r->param # returns list of keys
1163 $r->param($key) # returns value for $key
1164 $r->param($key => $value) # returns old value, sets to new value
1170 my ($self, $key) = (shift, shift);
1172 return keys %{$self->params} unless defined $key;
1174 return unless exists $self->params->{$key};
1176 my $val = $self->params->{$key};
1180 my $new_val = shift;
1181 $self->params->{$key} = $new_val;
1184 return ref $val ? @$val : ($val) if wantarray;
1186 return ref $val ? $val->[0] : $val;
1192 Returns a hashref of request parameters.
1194 B<Note:> Where muliple values of a parameter were supplied, the C<params> value
1195 will be an array reference.
1199 Alias for C<params>.
1203 =head3 Utility methods
1207 =item redirect_request
1209 Sets output headers to redirect based on the arguments provided
1211 Accepts either a single argument of the full url to redirect to, or a hash of
1214 $r->redirect_request('http://www.example.com/path');
1218 $r->redirect_request(protocol=>'https', domain=>'www.example.com', path=>'/path/file?arguments', status=>'302', url=>'..');
1220 The named parameters are protocol, domain, path, status and url
1222 Only 1 named parameter is required but other than url, they can be combined as
1223 required and current values (from the request) will be used in place of any
1224 missing arguments. The url argument must be a full url including protocol and
1225 can only be combined with status.
1229 sub redirect_request {
1230 die "redirect_request is a virtual method. Do not use Maypole directly; use Apache::MVC or similar";
1233 =item redirect_internal_request
1237 sub redirect_internal_request {
1242 =item make_random_id
1244 returns a unique id for this request can be used to prevent or detect repeat
1249 # Session and Repeat Submission Handling
1250 sub make_random_id {
1251 use Maypole::Session;
1252 return Maypole::Session::generate_unique_id();
1257 =head1 SEQUENCE DIAGRAMS
1259 See L<Maypole::Manual::Workflow> for a detailed discussion of the sequence of
1260 calls during processing of a request. This is a brief summary:
1264 BeerDB Maypole::Model::CDBI
1268 || setup_model | setup_database() creates
1269 ||------+ | a subclass of the Model
1270 |||<----+ | for each table
1272 ||| setup_database | |
1273 |||--------------------->|| 'create' *
1274 ||| ||----------> $subclass
1276 ||| load_model_subclass | |
1277 foreach |||------+ ($subclass) | |
1278 $subclass ||||<----+ | require |
1279 ||||--------------------------------------->|
1281 ||| adopt($subclass) | |
1282 |||--------------------->|| |
1287 || | new | view_object: e.g.
1288 ||---------------------------------------------> Maypole::View::TT
1300 BeerDB Model $subclass view_object
1303 o-------->| new | | |
1304 |-----> r:BeerDB | | |
1308 | ||-----+ parse_location | | |
1311 | ||-----+ start_request_hook | | |
1314 | ||-----+ get_session | | |
1317 | ||-----+ get_user | | |
1320 | ||-----+ handler_guts | | |
1322 | ||| class_of($table) | | |
1323 | |||------------------------->|| | |
1324 | ||| $subclass || | |
1325 | |||<-------------------------|| | |
1327 | |||-----+ is_model_applicable| | |
1330 | |||-----+ call_authenticate | | |
1333 | |||-----+ additional_data | | |
1336 | |||--------------------------------->|| fetch_objects
1344 | |||------------------------------------------->|| template
1348 | || send_output | | |
1352 <------------------|| | | |
1363 There's more documentation, examples, and information on our mailing lists
1364 at the Maypole web site:
1366 L<http://maypole.perl.org/>
1368 L<Maypole::Application>, L<Apache::MVC>, L<CGI::Maypole>.
1372 Maypole is currently maintained by Aaron Trevena, David Baird, Dave Howorth and
1375 =head1 AUTHOR EMERITUS
1377 Simon Cozens, C<simon#cpan.org>
1379 Simon Flack maintained Maypole from 2.05 to 2.09
1381 Sebastian Riedel, C<sri#oook.de> maintained Maypole from 1.99_01 to 2.04
1385 Sebastian Riedel, Danijel Milicevic, Dave Slack, Jesse Sheidlower, Jody Belka,
1386 Marcus Ramberg, Mickael Joanne, Randal Schwartz, Simon Flack, Steve Simms,
1387 Veljko Vidovic and all the others who've helped.
1391 You may distribute this code under the same terms as Perl itself.
1399 =item register_cleanup($coderef)
1401 Analogous to L<Apache>'s C<register_cleanup>. If an Apache request object is
1402 available, this call simply redispatches there. If not, the cleanup is
1403 registered in the Maypole request, and executed when the request is
1406 This method is only useful in persistent environments, where you need to ensure
1407 that some code runs when the request finishes, no matter how it finishes (e.g.
1408 after an unexpected error).
1415 sub register_cleanup
1417 my ($self, $cleanup) = @_;
1419 die "register_cleanup() is an instance method, not a class method"
1421 die "Cleanup must be a coderef" unless ref($cleanup) eq 'CODE';
1423 if ($self->can('ar') && $self->ar)
1425 $self->ar->register_cleanup($cleanup);
1429 push @_cleanups, $cleanup;
1437 while (my $cleanup = shift @_cleanups)
1439 eval { $cleanup->() };
1442 warn "Error during request cleanup: $@";