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 model_classes_loaded);
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 __PACKAGE__->model_classes_loaded(0);
211 =head1 HOOKABLE METHODS
213 As a framework, Maypole provides a number of B<hooks> - methods that are
214 intended to be overridden. Some of these methods come with useful default
215 behaviour, others do nothing by default. Hooks include:
241 sub My::App::debug {1}
243 Returns the debugging flag. Override this in your application class to
244 enable/disable debugging.
246 You can also set the C<debug> flag via L<Maypole::Application>.
248 Some packages respond to higher debug levels, try increasing it to 2 or 3.
257 Returns the L<Maypole::Config> object
261 My::App->setup($data_source, $user, $password, \%attr);
263 Initialise the Maypole application and plugins and model classes - see
264 L<Maypole::Manual::Plugins>.
266 If your model is based on L<Maypole::Model::CDBI>, the C<\%attr> hashref can
267 contain options that are passed directly to L<Class::DBI::Loader>, to control
268 how the model hierarchy is constructed.
270 Your application should call this B<after> setting up configuration data via
279 $class->setup_model(@_);
284 Called by C<setup>. This method builds the Maypole model hierarchy.
286 A likely target for over-riding, if you need to build a customised model.
288 This method also ensures any code in custom model classes is loaded, so you
289 don't need to load them in the driver.
297 $class = ref $class if ref $class;
299 my $config = $class->config;
301 $config->model || $config->model('Maypole::Model::CDBI');
303 $config->model->require or die sprintf
304 "Couldn't load the model class %s: %s", $config->model, $@;
306 # among other things, this populates $config->classes
307 $config->model->setup_database($config, $class, @_);
309 foreach my $subclass ( @{ $config->classes } )
311 next if $subclass->isa("Maypole::Model::Base");
313 unshift @{ $subclass . "::ISA" }, $config->model;
315 # Load custom model code, if it exists - nb this must happen after the
316 # unshift, to allow code attributes to work, but before adopt(),
317 # in case adopt() calls overridden methods on $subclass
318 $class->load_model_subclass($subclass) unless ($class->model_classes_loaded());
320 $config->model->adopt($subclass) if $config->model->can("adopt");
324 =item load_model_subclass($subclass)
326 This method is called from C<setup_model()>. It attempts to load the
327 C<$subclass> package, if one exists. So if you make a customized C<BeerDB::Beer>
328 package, you don't need to explicitly load it.
330 If, perhaps during development, you don't want to load up custom classes, you
331 can override this method and load them manually.
335 sub load_model_subclass
337 my ($class, $subclass) = @_;
339 my $config = $class->config;
341 # Load any external files for the model base class or subclasses
342 # (e.g. BeerDB/DBI.pm or BeerDB/Beer.pm) based on code borrowed from
343 # Maypole::Plugin::Loader and Class::DBI.
344 if ( $subclass->require )
346 warn "Loaded external module for '$subclass'\n" if $class->debug > 1;
350 (my $filename = $subclass) =~ s!::!/!g;
351 die "Loading '$subclass' failed: $@\n"
352 unless $@ =~ /Can\'t locate \Q$filename\E\.pm/;
353 warn "No external module for '$subclass'"
354 if $class->debug > 1;
360 Loads the view class and instantiates the view object.
362 You should not call this directly, but you may wish to override this to add
363 application-specific initialisation - see L<Maypole::Manual::Plugins>.
370 my $config = $class->config;
371 $config->view || $config->view("Maypole::View::TT");
372 $config->view->require;
373 die "Couldn't load the view class " . $config->view . ": $@" if $@;
374 $config->display_tables
375 || $config->display_tables( $class->config->tables );
376 $class->view_object( $class->config->view->new );
377 $class->init_done(1);
382 Constructs a very minimal new Maypole request object.
392 config => $class->config,
400 Get/set the Maypole::View object
404 =head1 INSTANCE METHODS
412 This method sets up the class if it's not done yet, sets some defaults and
413 leaves the dirty work to C<handler_guts>.
417 # handler() has a method attribute so that mod_perl will invoke
418 # BeerDB->handler() as a method rather than a plain function
419 # BeerDB::handler() and so this inherited implementation will be
420 # found. See e.g. "Practical mod_perl" by Bekman & Cholet for
421 # more information <http://modperlbook.org/html/ch25_01.html>
424 # See Maypole::Workflow before trying to understand this.
425 my ($class, $req) = @_;
427 $class->init unless $class->init_done;
429 my $self = $class->new;
431 # initialise the request
432 $self->headers_out(Maypole::Headers->new);
433 $self->get_request($req);
434 $self->parse_location;
436 # hook useful for declining static requests e.g. images, or perhaps for
437 # sanitizing request parameters
438 $self->status(Maypole::Constants::OK()); # set the default
439 $self->__call_hook('start_request_hook');
440 return $self->status unless $self->status == Maypole::Constants::OK();
442 die "status undefined after start_request_hook()" unless defined
448 my $status = $self->handler_guts;
449 return $status unless $status == OK;
451 # TODO: require send_output to return a status code
457 # Instead of making plugin authors use the NEXT::DISTINCT hoopla to ensure other
458 # plugins also get to call the hook, we can cycle through the application's
459 # @ISA and call them all here. Doesn't work for setup() though, because it's
460 # too ingrained in the stack. We could add a run_setup() method, but we'd break
461 # lots of existing code.
464 my ($self, $hook) = @_;
468 my $class = ref($self);
470 @plugins = @{"$class\::ISA"};
473 # this is either a custom method in the driver, or the method in the 1st
474 # plugin, or the 'null' method in the frontend (i.e. inherited from
475 # Maypole.pm) - we need to be careful to only call it once
476 my $first_hook = $self->can($hook);
479 my %seen = ( $first_hook => 1 );
481 # @plugins includes the frontend
482 foreach my $plugin (@plugins)
484 next unless my $plugin_hook = $plugin->can($hook);
485 next if $seen{$plugin_hook}++;
492 This is the main request handling method and calls various methods to handle the
493 request/response and defines the workflow within Maypole.
495 B<Currently undocumented and liable to be refactored without warning>.
499 # The root of all evil
504 $self->__load_request_model;
506 my $applicable = $self->is_model_applicable;
508 $self->__setup_plain_template unless $applicable;
512 eval { $status = $self->call_authenticate };
514 if ( my $error = $@ )
516 $status = $self->call_exception($error, "authentication");
520 warn "caught authenticate error: $error";
521 return $self->debug ?
522 $self->view_object->error($self, $error) : ERROR;
526 if ( $self->debug and $status != OK and $status != DECLINED )
528 $self->view_object->error( $self,
529 "Got unexpected status $status from calling authentication" );
532 return $status unless $status == OK;
534 # We run additional_data for every request
535 $self->additional_data;
539 eval { $self->model_class->process($self) };
541 if ( my $error = $@ )
543 $status = $self->call_exception($error, "model");
547 warn "caught model error: $error";
548 return $self->debug ?
549 $self->view_object->error($self, $error) : ERROR;
554 # less frequent path - perhaps output has been set to an error message
555 return OK if $self->output;
557 # normal path - no output has been generated yet
558 return $self->__call_process_view;
561 sub __load_request_model
564 $self->model_class( $self->config->model->class_of($self, $self->table) );
567 # is_applicable() returned false, so set up a plain template. Model processing
568 # will be skipped, but need to remove the model anyway so the template can't
570 sub __setup_plain_template
574 # It's just a plain template
575 $self->model_class(undef);
577 my $path = $self->path;
578 $path =~ s{/$}{}; # De-absolutify
581 $self->template($self->path);
584 # The model has been processed or skipped (if is_applicable returned false),
585 # any exceptions have been handled, and there's no content in $self->output
586 sub __call_process_view
592 eval { $status = $self->view_object->process($self) };
594 if ( my $error = $@ )
596 $status = $self->call_exception($error, "view");
600 warn "caught view error: $error" if $self->debug;
601 return $self->debug ?
602 $self->view_object->error($self, $error) : ERROR;
611 You should only need to define this method if you are writing a new
612 Maypole backend. It should return something that looks like an Apache
613 or CGI request object, it defaults to blank.
621 Turns the backend request (e.g. Apache::MVC, Maypole, CGI) into a Maypole
622 request. It does this by setting the C<path>, and invoking C<parse_path> and
625 You should only need to define this method if you are writing a new Maypole
632 die "parse_location is a virtual method. Do not use Maypole directly; " .
633 "use Apache::MVC or similar";
636 =item start_request_hook
638 This is called immediately after setting up the basic request. The default
641 The value of C<< $r->status >> is set to C<OK> before this hook is run. Your
642 implementation can change the status code, or leave it alone.
644 After this hook has run, Maypole will check the value of C<status>. For any
645 value other than C<OK>, Maypole returns the C<status> immediately.
647 This is useful for filtering out requests for static files, e.g. images, which
648 should not be processed by Maypole or by the templating engine:
650 sub start_request_hook
654 $r->status(DECLINED) if $r->path =~ /\.jpg$/;
657 Multiple plugins, and the driver, can define this hook - Maypole will call all
658 of them. You should check for and probably not change any non-OK C<status>
661 package Maypole::Plugin::MyApp::SkipFavicon;
663 sub start_request_hook
667 # check if a previous plugin has already DECLINED this request
668 # - probably unnecessary in this example, but you get the idea
669 return unless $r->status == OK;
672 $r->status(DECLINED) if $r->path =~ /favicon\.ico/;
677 sub start_request_hook { }
681 B<This method is deprecated> as of version 2.11. If you have overridden it,
682 please override C<is_model_applicable> instead, and change the return type
683 from a Maypole:Constant to a true/false value.
685 Returns a Maypole::Constant to indicate whether the request is valid.
687 =item is_model_applicable
689 Returns true or false to indicate whether the request is valid.
691 The default implementation checks that C<< $r->table >> is publicly
692 accessible and that the model class is configured to handle the
697 sub is_model_applicable
701 # cater for applications that are using obsolete version
702 if ($self->can('is_applicable'))
704 warn "DEPRECATION WARNING: rewrite is_applicable to the interface ".
705 "of Maypole::is_model_applicable\n";
706 return $self->is_applicable == OK;
709 # Establish which tables should be processed by the model
710 my $config = $self->config;
712 $config->ok_tables || $config->ok_tables( $config->display_tables );
714 $config->ok_tables( { map { $_ => 1 } @{ $config->ok_tables } } )
715 if ref $config->ok_tables eq "ARRAY";
717 my $ok_tables = $config->ok_tables;
719 # Does this request concern a table to be processed by the model?
720 my $table = $self->table;
724 if (exists $ok_tables->{$table})
731 warn "We don't have that table ($table).\n"
732 . "Available tables are: "
733 . join( ",", keys %$ok_tables )
734 if $self->debug and not $ok_tables->{$table};
739 # Is the action public?
740 my $action = $self->action;
741 return 1 if $self->model_class->is_public($action);
743 warn "The action '$action' is not applicable to the table '$table'"
751 Called immediately after C<start_request_hook()>.
753 This method should return a session, which will be stored in the request's
754 C<session> attribute.
756 The default method is empty.
764 Called immediately after C<get_session>.
766 This method should return a user, which will be stored in the request's C<user>
769 The default method is empty.
775 =item call_authenticate
777 This method first checks if the relevant model class
778 can authenticate the user, or falls back to the default
779 authenticate method of your Maypole application.
783 sub call_authenticate
787 # Check if we have a model class with an authenticate() to delegate to
788 return $self->model_class->authenticate($self)
789 if $self->model_class and $self->model_class->can('authenticate');
791 # Interface consistency is a Good Thing -
792 # the invocant and the argument may one day be different things
793 # (i.e. controller and request), like they are when authenticate()
794 # is called on a model class (i.e. model and request)
795 return $self->authenticate($self);
800 Returns a Maypole::Constant to indicate whether the user is authenticated for
803 The default implementation returns C<OK>
807 sub authenticate { return OK }
812 This model is called to catch exceptions, first after authenticate, then after
813 processing the model class, and finally to check for exceptions from the view
816 This method first checks if the relevant model class
817 can handle exceptions the user, or falls back to the default
818 exception method of your Maypole application.
824 my ($self, $error, $when) = @_;
826 # Check if we have a model class with an exception() to delegate to
827 if ( $self->model_class && $self->model_class->can('exception') )
829 my $status = $self->model_class->exception( $self, $error, $when );
830 return $status if $status == OK;
833 return $self->exception($error, $when);
839 This method is called if any exceptions are raised during the authentication or
840 model/view processing. It should accept the exception as a parameter and return
841 a Maypole::Constant to indicate whether the request should continue to be
847 my ($self, $error, $when) = @_;
848 if ($self->view_object->can("report_error") and $self->debug) {
849 $self->view_object->report_error($self, $error, $when);
855 =item additional_data
857 Called before the model processes the request, this method gives you a chance to
858 do some processing for each request, for example, manipulating C<template_args>.
862 sub additional_data { }
866 Sends the output and additional headers to the user.
871 die "send_output is a virtual method. Do not use Maypole directly; use Apache::MVC or similar";
879 =head2 Path processing and manipulation
885 Returns the request path
889 Parses the request path and sets the C<args>, C<action> and C<table>
890 properties. Calls C<preprocess_path> before parsing path and setting properties.
898 # Previous versions unconditionally set table, action and args to whatever
899 # was in @pi (or else to defaults, if @pi is empty).
900 # Adding preprocess_path(), and then setting table, action and args
901 # conditionally, broke lots of tests, hence this:
902 $self->$_(undef) for qw/action table args/;
904 $self->preprocess_path;
905 $self->path || $self->path('frontpage');
907 my @pi = grep {length} split '/', $self->path;
910 $self->table || $self->table(shift @pi);
911 $self->action || $self->action( shift @pi or 'index' );
912 $self->args || $self->args(\@pi);
915 =item preprocess_path
917 Sometimes when you don't want to rewrite or over-ride parse_path but
918 want to rewrite urls or extract data from them before it is parsed.
920 This method is called after parse_location has populated the request
921 information and before parse_path has populated the model and action
922 information, and is passed the request object.
924 You can set action, args or table in this method and parse_path will
925 then leave those values in place or populate them if not present
929 sub preprocess_path { };
931 =item make_path( %args or \%args or @args )
933 This is the counterpart to C<parse_path>. It generates a path to use
934 in links, form actions etc. To implement your own path scheme, just override
935 this method and C<parse_path>.
937 %args = ( table => $table,
939 additional => $additional, # optional - generally an object ID
942 \%args = as above, but a ref
944 @args = ( $table, $action, $additional ); # $additional is optional
946 C<id> can be used as an alternative key to C<additional>.
948 C<$additional> can be a string, an arrayref, or a hashref. An arrayref is
949 expanded into extra path elements, whereas a hashref is translated into a query
960 if (@_ == 1 and ref $_[0] and ref $_[0] eq 'HASH')
964 elsif ( @_ > 1 and @_ < 4 )
966 $args{table} = shift;
967 $args{action} = shift;
968 $args{additional} = shift;
975 do { die "no $_" unless $args{$_} } for qw( table action );
977 my $additional = $args{additional} || $args{id};
983 # if $additional is a href, make_uri() will transform it into a query
984 @add = (ref $additional eq 'ARRAY') ? @$additional : ($additional);
987 my $uri = $r->make_uri($args{table}, $args{action}, @add);
989 return $uri->as_string;
994 =item make_uri( @segments )
996 Make a L<URI> object given table, action etc. Automatically adds
999 If the final element in C<@segments> is a hash ref, C<make_uri> will render it
1006 my ($r, @segments) = @_;
1008 my $query = (ref $segments[-1] eq 'HASH') ? pop(@segments) : undef;
1010 my $base = $r->config->uri_base;
1013 my $uri = URI->new($base);
1014 $uri->path_segments($uri->path_segments, grep {length} @segments);
1016 my $abs_uri = $uri->abs('/');
1017 $abs_uri->query_form($query) if $query;
1023 Turns post data and query string paramaters into a hash of C<params>.
1025 You should only need to define this method if you are writing a new Maypole
1032 die "parse_args() is a virtual method. Do not use Maypole directly; ".
1033 "use Apache::MVC or similar";
1036 =item get_template_root
1038 Implementation-specific path to template root.
1040 You should only need to define this method if you are writing a new Maypole
1041 backend. Otherwise, see L<Maypole::Config/"template_root">
1045 sub get_template_root {'.'}
1049 =head2 Request properties
1055 Returns the perl package name that will serve as the model for the
1056 request. It corresponds to the request C<table> attribute.
1061 Get/set a list of model objects. The objects will be accessible in the view
1064 If the first item in C<$self-E<gt>args> can be C<retrieve()>d by the model
1065 class, it will be removed from C<args> and the retrieved object will be added to
1066 the C<objects> list. See L<Maypole::Model> for more information.
1070 $self->template_args->{foo} = 'bar';
1072 Get/set a hash of template variables.
1076 A place to put custom application data. Not used by Maypole itself.
1080 Get/set the template to be used by the view. By default, it returns
1081 C<$self-E<gt>action>
1086 Get/set a request error
1090 Get/set the response output. This is usually populated by the view class. You
1091 can skip view processing by setting the C<output>.
1095 The table part of the Maypole request path
1099 The action part of the Maypole request path
1103 A list of remaining parts of the request path after table and action
1109 A L<Maypole::Headers> object containing HTTP headers for the request
1113 A L<HTTP::Headers> object that contains HTTP headers for the output
1115 =item document_encoding
1117 Get/set the output encoding. Default: utf-8.
1121 Get/set the output content type. Default: text/html
1125 Returns the protocol the request was made with, i.e. https
1130 die "get_protocol is a virtual method. Do not use Maypole directly; use Apache::MVC or similar";
1135 =head2 Request parameters
1137 The source of the parameters may vary depending on the Maypole backend, but they
1138 are usually populated from request query string and POST data.
1140 Maypole supplies several approaches for accessing the request parameters. Note
1141 that the current implementation (via a hashref) of C<query> and C<params> is
1142 likely to change in a future version of Maypole. So avoid direct access to these
1145 $r->{params}->{foo} # bad
1146 $r->params->{foo} # better
1148 $r->{query}->{foo} # bad
1149 $r->query->{foo} # better
1151 $r->param('foo') # best
1157 An accessor (get or set) for request parameters. It behaves similarly to
1158 CGI::param() for accessing CGI parameters, i.e.
1160 $r->param # returns list of keys
1161 $r->param($key) # returns value for $key
1162 $r->param($key => $value) # returns old value, sets to new value
1168 my ($self, $key) = (shift, shift);
1170 return keys %{$self->params} unless defined $key;
1172 return unless exists $self->params->{$key};
1174 my $val = $self->params->{$key};
1178 my $new_val = shift;
1179 $self->params->{$key} = $new_val;
1182 return ref $val ? @$val : ($val) if wantarray;
1184 return ref $val ? $val->[0] : $val;
1190 Returns a hashref of request parameters.
1192 B<Note:> Where muliple values of a parameter were supplied, the C<params> value
1193 will be an array reference.
1197 Alias for C<params>.
1201 =head3 Utility methods
1205 =item redirect_request
1207 Sets output headers to redirect based on the arguments provided
1209 Accepts either a single argument of the full url to redirect to, or a hash of
1212 $r->redirect_request('http://www.example.com/path');
1216 $r->redirect_request(protocol=>'https', domain=>'www.example.com', path=>'/path/file?arguments', status=>'302', url=>'..');
1218 The named parameters are protocol, domain, path, status and url
1220 Only 1 named parameter is required but other than url, they can be combined as
1221 required and current values (from the request) will be used in place of any
1222 missing arguments. The url argument must be a full url including protocol and
1223 can only be combined with status.
1227 sub redirect_request {
1228 die "redirect_request is a virtual method. Do not use Maypole directly; use Apache::MVC or similar";
1231 =item redirect_internal_request
1235 sub redirect_internal_request {
1240 =item make_random_id
1242 returns a unique id for this request can be used to prevent or detect repeat
1247 # Session and Repeat Submission Handling
1248 sub make_random_id {
1249 use Maypole::Session;
1250 return Maypole::Session::generate_unique_id();
1255 =head1 SEQUENCE DIAGRAMS
1257 See L<Maypole::Manual::Workflow> for a detailed discussion of the sequence of
1258 calls during processing of a request. This is a brief summary:
1262 BeerDB Maypole::Model::CDBI
1266 || setup_model | setup_database() creates
1267 ||------+ | a subclass of the Model
1268 |||<----+ | for each table
1270 ||| setup_database | |
1271 |||--------------------->|| 'create' *
1272 ||| ||----------> $subclass
1274 ||| load_model_subclass | |
1275 foreach |||------+ ($subclass) | |
1276 $subclass ||||<----+ | require |
1277 ||||--------------------------------------->|
1279 ||| adopt($subclass) | |
1280 |||--------------------->|| |
1285 || | new | view_object: e.g.
1286 ||---------------------------------------------> Maypole::View::TT
1298 BeerDB Model $subclass view_object
1301 o-------->| new | | |
1302 |-----> r:BeerDB | | |
1306 | ||-----+ parse_location | | |
1309 | ||-----+ start_request_hook | | |
1312 | ||-----+ get_session | | |
1315 | ||-----+ get_user | | |
1318 | ||-----+ handler_guts | | |
1320 | ||| class_of($table) | | |
1321 | |||------------------------->|| | |
1322 | ||| $subclass || | |
1323 | |||<-------------------------|| | |
1325 | |||-----+ is_model_applicable| | |
1328 | |||-----+ call_authenticate | | |
1331 | |||-----+ additional_data | | |
1334 | |||--------------------------------->|| fetch_objects
1342 | |||------------------------------------------->|| template
1346 | || send_output | | |
1350 <------------------|| | | |
1361 There's more documentation, examples, and information on our mailing lists
1362 at the Maypole web site:
1364 L<http://maypole.perl.org/>
1366 L<Maypole::Application>, L<Apache::MVC>, L<CGI::Maypole>.
1370 Maypole is currently maintained by Aaron Trevena, David Baird, Dave Howorth and
1373 =head1 AUTHOR EMERITUS
1375 Simon Cozens, C<simon#cpan.org>
1377 Simon Flack maintained Maypole from 2.05 to 2.09
1379 Sebastian Riedel, C<sri#oook.de> maintained Maypole from 1.99_01 to 2.04
1383 Sebastian Riedel, Danijel Milicevic, Dave Slack, Jesse Sheidlower, Jody Belka,
1384 Marcus Ramberg, Mickael Joanne, Randal Schwartz, Simon Flack, Steve Simms,
1385 Veljko Vidovic and all the others who've helped.
1389 You may distribute this code under the same terms as Perl itself.
1397 =item register_cleanup($coderef)
1399 Analogous to L<Apache>'s C<register_cleanup>. If an Apache request object is
1400 available, this call simply redispatches there. If not, the cleanup is
1401 registered in the Maypole request, and executed when the request is
1404 This method is only useful in persistent environments, where you need to ensure
1405 that some code runs when the request finishes, no matter how it finishes (e.g.
1406 after an unexpected error).
1413 sub register_cleanup
1415 my ($self, $cleanup) = @_;
1417 die "register_cleanup() is an instance method, not a class method"
1419 die "Cleanup must be a coderef" unless ref($cleanup) eq 'CODE';
1421 if ($self->can('ar') && $self->ar)
1423 $self->ar->register_cleanup($cleanup);
1427 push @_cleanups, $cleanup;
1435 while (my $cleanup = shift @_cleanups)
1437 eval { $cleanup->() };
1440 warn "Error during request cleanup: $@";