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 } )
309 next if $subclass->isa("Maypole::Model::Base");
311 unshift @{ $subclass . "::ISA" }, $config->model;
313 # Load custom model code, if it exists - nb this must happen after the
314 # unshift, to allow code attributes to work, but before adopt(),
315 # in case adopt() calls overridden methods on $subclass
316 $class->load_model_subclass($subclass);
318 $config->model->adopt($subclass) if $config->model->can("adopt");
322 =item load_model_subclass($subclass)
324 This method is called from C<setup_model()>. It attempts to load the
325 C<$subclass> package, if one exists. So if you make a customized C<BeerDB::Beer>
326 package, you don't need to explicitly load it.
328 If, perhaps during development, you don't want to load up custom classes, you
329 can override this method and load them manually.
333 sub load_model_subclass
335 my ($class, $subclass) = @_;
337 my $config = $class->config;
339 # Load any external files for the model base class or subclasses
340 # (e.g. BeerDB/DBI.pm or BeerDB/Beer.pm) based on code borrowed from
341 # Maypole::Plugin::Loader and Class::DBI.
342 if ( $subclass->require )
344 warn "Loaded external module for '$subclass'\n" if $class->debug > 1;
348 (my $filename = $subclass) =~ s!::!/!g;
349 die "Loading '$subclass' failed: $@\n"
350 unless $@ =~ /Can\'t locate \Q$filename\E\.pm/;
351 warn "No external module for '$subclass'"
352 if $class->debug > 1;
358 Loads the view class and instantiates the view object.
360 You should not call this directly, but you may wish to override this to add
361 application-specific initialisation - see L<Maypole::Manual::Plugins>.
368 my $config = $class->config;
369 $config->view || $config->view("Maypole::View::TT");
370 $config->view->require;
371 die "Couldn't load the view class " . $config->view . ": $@" if $@;
372 $config->display_tables
373 || $config->display_tables( $class->config->tables );
374 $class->view_object( $class->config->view->new );
375 $class->init_done(1);
380 Constructs a very minimal new Maypole request object.
390 config => $class->config,
398 Get/set the Maypole::View object
402 =head1 INSTANCE METHODS
410 This method sets up the class if it's not done yet, sets some defaults and
411 leaves the dirty work to C<handler_guts>.
415 # handler() has a method attribute so that mod_perl will invoke
416 # BeerDB->handler() as a method rather than a plain function
417 # BeerDB::handler() and so this inherited implementation will be
418 # found. See e.g. "Practical mod_perl" by Bekman & Cholet for
419 # more information <http://modperlbook.org/html/ch25_01.html>
422 # See Maypole::Workflow before trying to understand this.
423 my ($class, $req) = @_;
425 $class->init unless $class->init_done;
427 my $self = $class->new;
429 # initialise the request
430 $self->headers_out(Maypole::Headers->new);
431 $self->get_request($req);
432 $self->parse_location;
434 # hook useful for declining static requests e.g. images, or perhaps for
435 # sanitizing request parameters
436 $self->status(Maypole::Constants::OK()); # set the default
437 $self->__call_hook('start_request_hook');
438 return $self->status unless $self->status == Maypole::Constants::OK();
440 die "status undefined after start_request_hook()" unless defined
446 my $status = $self->handler_guts;
447 return $status unless $status == OK;
449 # TODO: require send_output to return a status code
455 # Instead of making plugin authors use the NEXT::DISTINCT hoopla to ensure other
456 # plugins also get to call the hook, we can cycle through the application's
457 # @ISA and call them all here. Doesn't work for setup() though, because it's
458 # too ingrained in the stack. We could add a run_setup() method, but we'd break
459 # lots of existing code.
462 my ($self, $hook) = @_;
466 my $class = ref($self);
468 @plugins = @{"$class\::ISA"};
471 # this is either a custom method in the driver, or the method in the 1st
472 # plugin, or the 'null' method in the frontend (i.e. inherited from
473 # Maypole.pm) - we need to be careful to only call it once
474 my $first_hook = $self->can($hook);
477 my %seen = ( $first_hook => 1 );
479 # @plugins includes the frontend
480 foreach my $plugin (@plugins)
482 next unless my $plugin_hook = $plugin->can($hook);
483 next if $seen{$plugin_hook}++;
490 This is the main request handling method and calls various methods to handle the
491 request/response and defines the workflow within Maypole.
493 B<Currently undocumented and liable to be refactored without warning>.
497 # The root of all evil
502 $self->__load_request_model;
504 my $applicable = $self->is_model_applicable;
506 $self->__setup_plain_template unless $applicable;
510 eval { $status = $self->call_authenticate };
512 if ( my $error = $@ )
514 $status = $self->call_exception($error, "authentication");
518 warn "caught authenticate error: $error";
519 return $self->debug ?
520 $self->view_object->error($self, $error) : ERROR;
524 if ( $self->debug and $status != OK and $status != DECLINED )
526 $self->view_object->error( $self,
527 "Got unexpected status $status from calling authentication" );
530 return $status unless $status == OK;
532 # We run additional_data for every request
533 $self->additional_data;
537 eval { $self->model_class->process($self) };
539 if ( my $error = $@ )
541 $status = $self->call_exception($error, "model");
545 warn "caught model error: $error";
546 return $self->debug ?
547 $self->view_object->error($self, $error) : ERROR;
552 # less frequent path - perhaps output has been set to an error message
553 return OK if $self->output;
555 # normal path - no output has been generated yet
556 return $self->__call_process_view;
559 sub __load_request_model
562 $self->model_class( $self->config->model->class_of($self, $self->table) );
565 # is_applicable() returned false, so set up a plain template. Model processing
566 # will be skipped, but need to remove the model anyway so the template can't
568 sub __setup_plain_template
572 # It's just a plain template
573 $self->model_class(undef);
575 my $path = $self->path;
576 $path =~ s{/$}{}; # De-absolutify
579 $self->template($self->path);
582 # The model has been processed or skipped (if is_applicable returned false),
583 # any exceptions have been handled, and there's no content in $self->output
584 sub __call_process_view
590 eval { $status = $self->view_object->process($self) };
592 if ( my $error = $@ )
594 $status = $self->call_exception($error, "view");
598 warn "caught view error: $error" if $self->debug;
599 return $self->debug ?
600 $self->view_object->error($self, $error) : ERROR;
609 You should only need to define this method if you are writing a new
610 Maypole backend. It should return something that looks like an Apache
611 or CGI request object, it defaults to blank.
619 Turns the backend request (e.g. Apache::MVC, Maypole, CGI) into a Maypole
620 request. It does this by setting the C<path>, and invoking C<parse_path> and
623 You should only need to define this method if you are writing a new Maypole
630 die "parse_location is a virtual method. Do not use Maypole directly; " .
631 "use Apache::MVC or similar";
634 =item start_request_hook
636 This is called immediately after setting up the basic request. The default
639 The value of C<< $r->status >> is set to C<OK> before this hook is run. Your
640 implementation can change the status code, or leave it alone.
642 After this hook has run, Maypole will check the value of C<status>. For any
643 value other than C<OK>, Maypole returns the C<status> immediately.
645 This is useful for filtering out requests for static files, e.g. images, which
646 should not be processed by Maypole or by the templating engine:
648 sub start_request_hook
652 $r->status(DECLINED) if $r->path =~ /\.jpg$/;
655 Multiple plugins, and the driver, can define this hook - Maypole will call all
656 of them. You should check for and probably not change any non-OK C<status>
659 package Maypole::Plugin::MyApp::SkipFavicon;
661 sub start_request_hook
665 # check if a previous plugin has already DECLINED this request
666 # - probably unnecessary in this example, but you get the idea
667 return unless $r->status == OK;
670 $r->status(DECLINED) if $r->path =~ /favicon\.ico/;
675 sub start_request_hook { }
679 B<This method is deprecated> as of version 2.11. If you have overridden it,
680 please override C<is_model_applicable> instead, and change the return type
681 from a Maypole:Constant to a true/false value.
683 Returns a Maypole::Constant to indicate whether the request is valid.
685 =item is_model_applicable
687 Returns true or false to indicate whether the request is valid.
689 The default implementation checks that C<< $r->table >> is publicly
690 accessible and that the model class is configured to handle the
695 sub is_model_applicable
699 # cater for applications that are using obsolete version
700 if ($self->can('is_applicable'))
702 warn "DEPRECATION WARNING: rewrite is_applicable to the interface ".
703 "of Maypole::is_model_applicable\n";
704 return $self->is_applicable == OK;
707 # Establish which tables should be processed by the model
708 my $config = $self->config;
710 $config->ok_tables || $config->ok_tables( $config->display_tables );
712 $config->ok_tables( { map { $_ => 1 } @{ $config->ok_tables } } )
713 if ref $config->ok_tables eq "ARRAY";
715 my $ok_tables = $config->ok_tables;
717 # Does this request concern a table to be processed by the model?
718 my $table = $self->table;
722 if (exists $ok_tables->{$table})
729 warn "We don't have that table ($table).\n"
730 . "Available tables are: "
731 . join( ",", keys %$ok_tables )
732 if $self->debug and not $ok_tables->{$table};
737 # Is the action public?
738 my $action = $self->action;
739 return 1 if $self->model_class->is_public($action);
741 warn "The action '$action' is not applicable to the table '$table'"
749 Called immediately after C<start_request_hook()>.
751 This method should return a session, which will be stored in the request's
752 C<session> attribute.
754 The default method is empty.
762 Called immediately after C<get_session>.
764 This method should return a user, which will be stored in the request's C<user>
767 The default method is empty.
773 =item call_authenticate
775 This method first checks if the relevant model class
776 can authenticate the user, or falls back to the default
777 authenticate method of your Maypole application.
781 sub call_authenticate
785 # Check if we have a model class with an authenticate() to delegate to
786 return $self->model_class->authenticate($self)
787 if $self->model_class and $self->model_class->can('authenticate');
789 # Interface consistency is a Good Thing -
790 # the invocant and the argument may one day be different things
791 # (i.e. controller and request), like they are when authenticate()
792 # is called on a model class (i.e. model and request)
793 return $self->authenticate($self);
798 Returns a Maypole::Constant to indicate whether the user is authenticated for
801 The default implementation returns C<OK>
805 sub authenticate { return OK }
810 This model is called to catch exceptions, first after authenticate, then after
811 processing the model class, and finally to check for exceptions from the view
814 This method first checks if the relevant model class
815 can handle exceptions the user, or falls back to the default
816 exception method of your Maypole application.
822 my ($self, $error, $when) = @_;
824 # Check if we have a model class with an exception() to delegate to
825 if ( $self->model_class && $self->model_class->can('exception') )
827 my $status = $self->model_class->exception( $self, $error, $when );
828 return $status if $status == OK;
831 return $self->exception($error, $when);
837 This method is called if any exceptions are raised during the authentication or
838 model/view processing. It should accept the exception as a parameter and return
839 a Maypole::Constant to indicate whether the request should continue to be
845 my ($self, $error, $when) = @_;
846 if ($self->view_object->can("report_error") and $self->debug) {
847 $self->view_object->report_error($self, $error, $when);
853 =item additional_data
855 Called before the model processes the request, this method gives you a chance to
856 do some processing for each request, for example, manipulating C<template_args>.
860 sub additional_data { }
864 Sends the output and additional headers to the user.
869 die "send_output is a virtual method. Do not use Maypole directly; use Apache::MVC or similar";
877 =head2 Path processing and manipulation
883 Returns the request path
887 Parses the request path and sets the C<args>, C<action> and C<table>
888 properties. Calls C<preprocess_path> before parsing path and setting properties.
896 # Previous versions unconditionally set table, action and args to whatever
897 # was in @pi (or else to defaults, if @pi is empty).
898 # Adding preprocess_path(), and then setting table, action and args
899 # conditionally, broke lots of tests, hence this:
900 $self->$_(undef) for qw/action table args/;
902 $self->preprocess_path;
903 $self->path || $self->path('frontpage');
905 my @pi = grep {length} split '/', $self->path;
908 $self->table || $self->table(shift @pi);
909 $self->action || $self->action( shift @pi or 'index' );
910 $self->args || $self->args(\@pi);
913 =item preprocess_path
915 Sometimes when you don't want to rewrite or over-ride parse_path but
916 want to rewrite urls or extract data from them before it is parsed.
918 This method is called after parse_location has populated the request
919 information and before parse_path has populated the model and action
920 information, and is passed the request object.
922 You can set action, args or table in this method and parse_path will
923 then leave those values in place or populate them if not present
927 sub preprocess_path { };
929 =item make_path( %args or \%args or @args )
931 This is the counterpart to C<parse_path>. It generates a path to use
932 in links, form actions etc. To implement your own path scheme, just override
933 this method and C<parse_path>.
935 %args = ( table => $table,
937 additional => $additional, # optional - generally an object ID
940 \%args = as above, but a ref
942 @args = ( $table, $action, $additional ); # $additional is optional
944 C<id> can be used as an alternative key to C<additional>.
946 C<$additional> can be a string, an arrayref, or a hashref. An arrayref is
947 expanded into extra path elements, whereas a hashref is translated into a query
958 if (@_ == 1 and ref $_[0] and ref $_[0] eq 'HASH')
962 elsif ( @_ > 1 and @_ < 4 )
964 $args{table} = shift;
965 $args{action} = shift;
966 $args{additional} = shift;
973 do { die "no $_" unless $args{$_} } for qw( table action );
975 my $additional = $args{additional} || $args{id};
981 # if $additional is a href, make_uri() will transform it into a query
982 @add = (ref $additional eq 'ARRAY') ? @$additional : ($additional);
985 my $uri = $r->make_uri($args{table}, $args{action}, @add);
987 return $uri->as_string;
992 =item make_uri( @segments )
994 Make a L<URI> object given table, action etc. Automatically adds
997 If the final element in C<@segments> is a hash ref, C<make_uri> will render it
1004 my ($r, @segments) = @_;
1006 my $query = (ref $segments[-1] eq 'HASH') ? pop(@segments) : undef;
1008 my $base = $r->config->uri_base;
1011 my $uri = URI->new($base);
1012 $uri->path_segments($uri->path_segments, grep {length} @segments);
1014 my $abs_uri = $uri->abs('/');
1015 $abs_uri->query_form($query) if $query;
1021 Turns post data and query string paramaters into a hash of C<params>.
1023 You should only need to define this method if you are writing a new Maypole
1030 die "parse_args() is a virtual method. Do not use Maypole directly; ".
1031 "use Apache::MVC or similar";
1034 =item get_template_root
1036 Implementation-specific path to template root.
1038 You should only need to define this method if you are writing a new Maypole
1039 backend. Otherwise, see L<Maypole::Config/"template_root">
1043 sub get_template_root {'.'}
1047 =head2 Request properties
1053 Returns the perl package name that will serve as the model for the
1054 request. It corresponds to the request C<table> attribute.
1059 Get/set a list of model objects. The objects will be accessible in the view
1062 If the first item in C<$self-E<gt>args> can be C<retrieve()>d by the model
1063 class, it will be removed from C<args> and the retrieved object will be added to
1064 the C<objects> list. See L<Maypole::Model> for more information.
1068 $self->template_args->{foo} = 'bar';
1070 Get/set a hash of template variables.
1074 A place to put custom application data. Not used by Maypole itself.
1078 Get/set the template to be used by the view. By default, it returns
1079 C<$self-E<gt>action>
1084 Get/set a request error
1088 Get/set the response output. This is usually populated by the view class. You
1089 can skip view processing by setting the C<output>.
1093 The table part of the Maypole request path
1097 The action part of the Maypole request path
1101 A list of remaining parts of the request path after table and action
1107 A L<Maypole::Headers> object containing HTTP headers for the request
1111 A L<HTTP::Headers> object that contains HTTP headers for the output
1113 =item document_encoding
1115 Get/set the output encoding. Default: utf-8.
1119 Get/set the output content type. Default: text/html
1123 Returns the protocol the request was made with, i.e. https
1128 die "get_protocol is a virtual method. Do not use Maypole directly; use Apache::MVC or similar";
1133 =head2 Request parameters
1135 The source of the parameters may vary depending on the Maypole backend, but they
1136 are usually populated from request query string and POST data.
1138 Maypole supplies several approaches for accessing the request parameters. Note
1139 that the current implementation (via a hashref) of C<query> and C<params> is
1140 likely to change in a future version of Maypole. So avoid direct access to these
1143 $r->{params}->{foo} # bad
1144 $r->params->{foo} # better
1146 $r->{query}->{foo} # bad
1147 $r->query->{foo} # better
1149 $r->param('foo') # best
1155 An accessor (get or set) for request parameters. It behaves similarly to
1156 CGI::param() for accessing CGI parameters, i.e.
1158 $r->param # returns list of keys
1159 $r->param($key) # returns value for $key
1160 $r->param($key => $value) # returns old value, sets to new value
1166 my ($self, $key) = (shift, shift);
1168 return keys %{$self->params} unless defined $key;
1170 return unless exists $self->params->{$key};
1172 my $val = $self->params->{$key};
1176 my $new_val = shift;
1177 $self->params->{$key} = $new_val;
1180 return ref $val ? @$val : ($val) if wantarray;
1182 return ref $val ? $val->[0] : $val;
1188 Returns a hashref of request parameters.
1190 B<Note:> Where muliple values of a parameter were supplied, the C<params> value
1191 will be an array reference.
1195 Alias for C<params>.
1199 =head3 Utility methods
1203 =item redirect_request
1205 Sets output headers to redirect based on the arguments provided
1207 Accepts either a single argument of the full url to redirect to, or a hash of
1210 $r->redirect_request('http://www.example.com/path');
1214 $r->redirect_request(protocol=>'https', domain=>'www.example.com', path=>'/path/file?arguments', status=>'302', url=>'..');
1216 The named parameters are protocol, domain, path, status and url
1218 Only 1 named parameter is required but other than url, they can be combined as
1219 required and current values (from the request) will be used in place of any
1220 missing arguments. The url argument must be a full url including protocol and
1221 can only be combined with status.
1225 sub redirect_request {
1226 die "redirect_request is a virtual method. Do not use Maypole directly; use Apache::MVC or similar";
1229 =item redirect_internal_request
1233 sub redirect_internal_request {
1238 =item make_random_id
1240 returns a unique id for this request can be used to prevent or detect repeat
1245 # Session and Repeat Submission Handling
1246 sub make_random_id {
1247 use Maypole::Session;
1248 return Maypole::Session::generate_unique_id();
1253 =head1 SEQUENCE DIAGRAMS
1255 See L<Maypole::Manual::Workflow> for a detailed discussion of the sequence of
1256 calls during processing of a request. This is a brief summary:
1260 BeerDB Maypole::Model::CDBI
1264 || setup_model | setup_database() creates
1265 ||------+ | a subclass of the Model
1266 |||<----+ | for each table
1268 ||| setup_database | |
1269 |||--------------------->|| 'create' *
1270 ||| ||----------> $subclass
1272 ||| load_model_subclass | |
1273 foreach |||------+ ($subclass) | |
1274 $subclass ||||<----+ | require |
1275 ||||--------------------------------------->|
1277 ||| adopt($subclass) | |
1278 |||--------------------->|| |
1283 || | new | view_object: e.g.
1284 ||---------------------------------------------> Maypole::View::TT
1296 BeerDB Model $subclass view_object
1299 o-------->| new | | |
1300 |-----> r:BeerDB | | |
1304 | ||-----+ parse_location | | |
1307 | ||-----+ start_request_hook | | |
1310 | ||-----+ get_session | | |
1313 | ||-----+ get_user | | |
1316 | ||-----+ handler_guts | | |
1318 | ||| class_of($table) | | |
1319 | |||------------------------->|| | |
1320 | ||| $subclass || | |
1321 | |||<-------------------------|| | |
1323 | |||-----+ is_model_applicable| | |
1326 | |||-----+ call_authenticate | | |
1329 | |||-----+ additional_data | | |
1332 | |||--------------------------------->|| fetch_objects
1340 | |||------------------------------------------->|| template
1344 | || send_output | | |
1348 <------------------|| | | |
1359 There's more documentation, examples, and information on our mailing lists
1360 at the Maypole web site:
1362 L<http://maypole.perl.org/>
1364 L<Maypole::Application>, L<Apache::MVC>, L<CGI::Maypole>.
1368 Maypole is currently maintained by Aaron Trevena, David Baird, Dave Howorth and
1371 =head1 AUTHOR EMERITUS
1373 Simon Cozens, C<simon#cpan.org>
1375 Simon Flack maintained Maypole from 2.05 to 2.09
1377 Sebastian Riedel, C<sri#oook.de> maintained Maypole from 1.99_01 to 2.04
1381 Sebastian Riedel, Danijel Milicevic, Dave Slack, Jesse Sheidlower, Jody Belka,
1382 Marcus Ramberg, Mickael Joanne, Randal Schwartz, Simon Flack, Steve Simms,
1383 Veljko Vidovic and all the others who've helped.
1387 You may distribute this code under the same terms as Perl itself.
1395 =item register_cleanup($coderef)
1397 Analogous to L<Apache>'s C<register_cleanup>. If an Apache request object is
1398 available, this call simply redispatches there. If not, the cleanup is
1399 registered in the Maypole request, and executed when the request is
1402 This method is only useful in persistent environments, where you need to ensure
1403 that some code runs when the request finishes, no matter how it finishes (e.g.
1404 after an unexpected error).
1411 sub register_cleanup
1413 my ($self, $cleanup) = @_;
1415 die "register_cleanup() is an instance method, not a class method"
1417 die "Cleanup must be a coderef" unless ref($cleanup) eq 'CODE';
1419 if ($self->can('ar') && $self->ar)
1421 $self->ar->register_cleanup($cleanup);
1425 push @_cleanups, $cleanup;
1433 while (my $cleanup = shift @_cleanups)
1435 eval { $cleanup->() };
1438 warn "Error during request cleanup: $@";