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;
446 return $status unless $status == OK;
448 # TODO: require send_output to return a status code
454 # Instead of making plugin authors use the NEXT::DISTINCT hoopla to ensure other
455 # plugins also get to call the hook, we can cycle through the application's
456 # @ISA and call them all here. Doesn't work for setup() though, because it's
457 # too ingrained in the stack. We could add a run_setup() method, but we'd break
458 # lots of existing code.
461 my ($self, $hook) = @_;
465 my $class = ref($self);
467 @plugins = @{"$class\::ISA"};
470 # this is either a custom method in the driver, or the method in the 1st
471 # plugin, or the 'null' method in the frontend (i.e. inherited from
472 # Maypole.pm) - we need to be careful to only call it once
473 my $first_hook = $self->can($hook);
476 my %seen = ( $first_hook => 1 );
478 # @plugins includes the frontend
479 foreach my $plugin (@plugins)
481 next unless my $plugin_hook = $plugin->can($hook);
482 next if $seen{$plugin_hook}++;
489 This is the main request handling method and calls various methods to handle the
490 request/response and defines the workflow within Maypole.
492 B<Currently undocumented and liable to be refactored without warning>.
496 # The root of all evil
501 $self->__load_request_model;
503 my $applicable = $self->is_model_applicable;
505 $self->__setup_plain_template unless $applicable;
509 eval { $status = $self->call_authenticate };
511 if ( my $error = $@ )
513 $status = $self->call_exception($error, "authentication");
517 warn "caught authenticate error: $error";
518 return $self->debug ?
519 $self->view_object->error($self, $error) : ERROR;
523 if ( $self->debug and $status != OK and $status != DECLINED )
525 $self->view_object->error( $self,
526 "Got unexpected status $status from calling authentication" );
529 return $status unless $status == OK;
531 # We run additional_data for every request
532 $self->additional_data;
536 eval { $self->model_class->process($self) };
538 if ( my $error = $@ )
540 $status = $self->call_exception($error, "model");
544 warn "caught model error: $error";
545 return $self->debug ?
546 $self->view_object->error($self, $error) : ERROR;
551 # less frequent path - perhaps output has been set to an error message
552 return OK if $self->output;
554 # normal path - no output has been generated yet
555 return $self->__call_process_view;
558 sub __load_request_model
561 $self->model_class( $self->config->model->class_of($self, $self->table) );
564 # is_applicable() returned false, so set up a plain template. Model processing
565 # will be skipped, but need to remove the model anyway so the template can't
567 sub __setup_plain_template
571 # It's just a plain template
572 $self->model_class(undef);
574 my $path = $self->path;
575 $path =~ s{/$}{}; # De-absolutify
578 $self->template($self->path);
581 # The model has been processed or skipped (if is_applicable returned false),
582 # any exceptions have been handled, and there's no content in $self->output
583 sub __call_process_view
589 eval { $status = $self->view_object->process($self) };
591 if ( my $error = $@ )
593 $status = $self->call_exception($error, "view");
597 warn "caught view error: $error" if $self->debug;
598 return $self->debug ?
599 $self->view_object->error($self, $error) : ERROR;
608 You should only need to define this method if you are writing a new
609 Maypole backend. It should return something that looks like an Apache
610 or CGI request object, it defaults to blank.
618 Turns the backend request (e.g. Apache::MVC, Maypole, CGI) into a Maypole
619 request. It does this by setting the C<path>, and invoking C<parse_path> and
622 You should only need to define this method if you are writing a new Maypole
629 die "parse_location is a virtual method. Do not use Maypole directly; " .
630 "use Apache::MVC or similar";
633 =item start_request_hook
635 This is called immediately after setting up the basic request. The default
638 The value of C<< $r->status >> is set to C<OK> before this hook is run. Your
639 implementation can change the status code, or leave it alone.
641 After this hook has run, Maypole will check the value of C<status>. For any
642 value other than C<OK>, Maypole returns the C<status> immediately.
644 This is useful for filtering out requests for static files, e.g. images, which
645 should not be processed by Maypole or by the templating engine:
647 sub start_request_hook
651 $r->status(DECLINED) if $r->path =~ /\.jpg$/;
654 Multiple plugins, and the driver, can define this hook - Maypole will call all
655 of them. You should check for and probably not change any non-OK C<status>
658 package Maypole::Plugin::MyApp::SkipFavicon;
660 sub start_request_hook
664 # check if a previous plugin has already DECLINED this request
665 # - probably unnecessary in this example, but you get the idea
666 return unless $r->status == OK;
669 $r->status(DECLINED) if $r->path =~ /favicon\.ico/;
674 sub start_request_hook { }
678 B<This method is deprecated> as of version 2.11. If you have overridden it,
679 please override C<is_model_applicable> instead, and change the return type
680 from a Maypole:Constant to a true/false value.
682 Returns a Maypole::Constant to indicate whether the request is valid.
684 =item is_model_applicable
686 Returns true or false to indicate whether the request is valid.
688 The default implementation checks that C<< $r->table >> is publicly
689 accessible and that the model class is configured to handle the
694 sub is_model_applicable
698 # cater for applications that are using obsolete version
699 if ($self->can('is_applicable'))
701 warn "DEPRECATION WARNING: rewrite is_applicable to the interface ".
702 "of Maypole::is_model_applicable\n";
703 return $self->is_applicable == OK;
706 # Establish which tables should be processed by the model
707 my $config = $self->config;
709 $config->ok_tables || $config->ok_tables( $config->display_tables );
711 $config->ok_tables( { map { $_ => 1 } @{ $config->ok_tables } } )
712 if ref $config->ok_tables eq "ARRAY";
714 my $ok_tables = $config->ok_tables;
716 # Does this request concern a table to be processed by the model?
717 my $table = $self->table;
721 if (exists $ok_tables->{$table})
728 warn "We don't have that table ($table).\n"
729 . "Available tables are: "
730 . join( ",", keys %$ok_tables )
731 if $self->debug and not $ok_tables->{$table};
736 # Is the action public?
737 my $action = $self->action;
738 return 1 if $self->model_class->is_public($action);
740 warn "The action '$action' is not applicable to the table '$table'"
748 Called immediately after C<start_request_hook()>.
750 This method should return a session, which will be stored in the request's
751 C<session> attribute.
753 The default method is empty.
761 Called immediately after C<get_session>.
763 This method should return a user, which will be stored in the request's C<user>
766 The default method is empty.
772 =item call_authenticate
774 This method first checks if the relevant model class
775 can authenticate the user, or falls back to the default
776 authenticate method of your Maypole application.
780 sub call_authenticate
784 # Check if we have a model class with an authenticate() to delegate to
785 return $self->model_class->authenticate($self)
786 if $self->model_class and $self->model_class->can('authenticate');
788 # Interface consistency is a Good Thing -
789 # the invocant and the argument may one day be different things
790 # (i.e. controller and request), like they are when authenticate()
791 # is called on a model class (i.e. model and request)
792 return $self->authenticate($self);
797 Returns a Maypole::Constant to indicate whether the user is authenticated for
800 The default implementation returns C<OK>
804 sub authenticate { return OK }
809 This model is called to catch exceptions, first after authenticate, then after
810 processing the model class, and finally to check for exceptions from the view
813 This method first checks if the relevant model class
814 can handle exceptions the user, or falls back to the default
815 exception method of your Maypole application.
821 my ($self, $error, $when) = @_;
823 # Check if we have a model class with an exception() to delegate to
824 if ( $self->model_class && $self->model_class->can('exception') )
826 my $status = $self->model_class->exception( $self, $error, $when );
827 return $status if $status == OK;
830 return $self->exception($error, $when);
836 This method is called if any exceptions are raised during the authentication or
837 model/view processing. It should accept the exception as a parameter and return
838 a Maypole::Constant to indicate whether the request should continue to be
844 my ($self, $error, $when) = @_;
845 if ($self->view_object->can("report_error") and $self->debug) {
846 $self->view_object->report_error($self, $error, $when);
852 =item additional_data
854 Called before the model processes the request, this method gives you a chance to
855 do some processing for each request, for example, manipulating C<template_args>.
859 sub additional_data { }
863 Sends the output and additional headers to the user.
868 die "send_output is a virtual method. Do not use Maypole directly; use Apache::MVC or similar";
876 =head2 Path processing and manipulation
882 Returns the request path
886 Parses the request path and sets the C<args>, C<action> and C<table>
887 properties. Calls C<preprocess_path> before parsing path and setting properties.
895 # Previous versions unconditionally set table, action and args to whatever
896 # was in @pi (or else to defaults, if @pi is empty).
897 # Adding preprocess_path(), and then setting table, action and args
898 # conditionally, broke lots of tests, hence this:
899 $self->$_(undef) for qw/action table args/;
901 $self->preprocess_path;
902 $self->path || $self->path('frontpage');
904 my @pi = grep {length} split '/', $self->path;
907 $self->table || $self->table(shift @pi);
908 $self->action || $self->action( shift @pi or 'index' );
909 $self->args || $self->args(\@pi);
912 =item preprocess_path
914 Sometimes when you don't want to rewrite or over-ride parse_path but
915 want to rewrite urls or extract data from them before it is parsed.
917 This method is called after parse_location has populated the request
918 information and before parse_path has populated the model and action
919 information, and is passed the request object.
921 You can set action, args or table in this method and parse_path will
922 then leave those values in place or populate them if not present
926 sub preprocess_path { };
928 =item make_path( %args or \%args or @args )
930 This is the counterpart to C<parse_path>. It generates a path to use
931 in links, form actions etc. To implement your own path scheme, just override
932 this method and C<parse_path>.
934 %args = ( table => $table,
936 additional => $additional, # optional - generally an object ID
939 \%args = as above, but a ref
941 @args = ( $table, $action, $additional ); # $additional is optional
943 C<id> can be used as an alternative key to C<additional>.
945 C<$additional> can be a string, an arrayref, or a hashref. An arrayref is
946 expanded into extra path elements, whereas a hashref is translated into a query
957 if (@_ == 1 and ref $_[0] and ref $_[0] eq 'HASH')
961 elsif ( @_ > 1 and @_ < 4 )
963 $args{table} = shift;
964 $args{action} = shift;
965 $args{additional} = shift;
972 do { die "no $_" unless $args{$_} } for qw( table action );
974 my $additional = $args{additional} || $args{id};
980 # if $additional is a href, make_uri() will transform it into a query
981 @add = (ref $additional eq 'ARRAY') ? @$additional : ($additional);
984 my $uri = $r->make_uri($args{table}, $args{action}, @add);
986 return $uri->as_string;
991 =item make_uri( @segments )
993 Make a L<URI> object given table, action etc. Automatically adds
996 If the final element in C<@segments> is a hash ref, C<make_uri> will render it
1003 my ($r, @segments) = @_;
1005 my $query = (ref $segments[-1] eq 'HASH') ? pop(@segments) : undef;
1007 my $base = $r->config->uri_base;
1010 my $uri = URI->new($base);
1011 $uri->path_segments($uri->path_segments, grep {length} @segments);
1013 my $abs_uri = $uri->abs('/');
1014 $abs_uri->query_form($query) if $query;
1020 Turns post data and query string paramaters into a hash of C<params>.
1022 You should only need to define this method if you are writing a new Maypole
1029 die "parse_args() is a virtual method. Do not use Maypole directly; ".
1030 "use Apache::MVC or similar";
1033 =item get_template_root
1035 Implementation-specific path to template root.
1037 You should only need to define this method if you are writing a new Maypole
1038 backend. Otherwise, see L<Maypole::Config/"template_root">
1042 sub get_template_root {'.'}
1046 =head2 Request properties
1052 Returns the perl package name that will serve as the model for the
1053 request. It corresponds to the request C<table> attribute.
1058 Get/set a list of model objects. The objects will be accessible in the view
1061 If the first item in C<$self-E<gt>args> can be C<retrieve()>d by the model
1062 class, it will be removed from C<args> and the retrieved object will be added to
1063 the C<objects> list. See L<Maypole::Model> for more information.
1067 $self->template_args->{foo} = 'bar';
1069 Get/set a hash of template variables.
1073 A place to put custom application data. Not used by Maypole itself.
1077 Get/set the template to be used by the view. By default, it returns
1078 C<$self-E<gt>action>
1083 Get/set a request error
1087 Get/set the response output. This is usually populated by the view class. You
1088 can skip view processing by setting the C<output>.
1092 The table part of the Maypole request path
1096 The action part of the Maypole request path
1100 A list of remaining parts of the request path after table and action
1106 A L<Maypole::Headers> object containing HTTP headers for the request
1110 A L<HTTP::Headers> object that contains HTTP headers for the output
1112 =item document_encoding
1114 Get/set the output encoding. Default: utf-8.
1118 Get/set the output content type. Default: text/html
1122 Returns the protocol the request was made with, i.e. https
1127 die "get_protocol is a virtual method. Do not use Maypole directly; use Apache::MVC or similar";
1132 =head2 Request parameters
1134 The source of the parameters may vary depending on the Maypole backend, but they
1135 are usually populated from request query string and POST data.
1137 Maypole supplies several approaches for accessing the request parameters. Note
1138 that the current implementation (via a hashref) of C<query> and C<params> is
1139 likely to change in a future version of Maypole. So avoid direct access to these
1142 $r->{params}->{foo} # bad
1143 $r->params->{foo} # better
1145 $r->{query}->{foo} # bad
1146 $r->query->{foo} # better
1148 $r->param('foo') # best
1154 An accessor (get or set) for request parameters. It behaves similarly to
1155 CGI::param() for accessing CGI parameters, i.e.
1157 $r->param # returns list of keys
1158 $r->param($key) # returns value for $key
1159 $r->param($key => $value) # returns old value, sets to new value
1165 my ($self, $key) = (shift, shift);
1167 return keys %{$self->params} unless defined $key;
1169 return unless exists $self->params->{$key};
1171 my $val = $self->params->{$key};
1175 my $new_val = shift;
1176 $self->params->{$key} = $new_val;
1179 return ref $val ? @$val : ($val) if wantarray;
1181 return ref $val ? $val->[0] : $val;
1187 Returns a hashref of request parameters.
1189 B<Note:> Where muliple values of a parameter were supplied, the C<params> value
1190 will be an array reference.
1194 Alias for C<params>.
1198 =head3 Utility methods
1202 =item redirect_request
1204 Sets output headers to redirect based on the arguments provided
1206 Accepts either a single argument of the full url to redirect to, or a hash of
1209 $r->redirect_request('http://www.example.com/path');
1213 $r->redirect_request(protocol=>'https', domain=>'www.example.com', path=>'/path/file?arguments', status=>'302', url=>'..');
1215 The named parameters are protocol, domain, path, status and url
1217 Only 1 named parameter is required but other than url, they can be combined as
1218 required and current values (from the request) will be used in place of any
1219 missing arguments. The url argument must be a full url including protocol and
1220 can only be combined with status.
1224 sub redirect_request {
1225 die "redirect_request is a virtual method. Do not use Maypole directly; use Apache::MVC or similar";
1228 =item redirect_internal_request
1232 sub redirect_internal_request {
1237 =item make_random_id
1239 returns a unique id for this request can be used to prevent or detect repeat
1244 # Session and Repeat Submission Handling
1245 sub make_random_id {
1246 use Maypole::Session;
1247 return Maypole::Session::generate_unique_id();
1252 =head1 SEQUENCE DIAGRAMS
1254 See L<Maypole::Manual::Workflow> for a detailed discussion of the sequence of
1255 calls during processing of a request. This is a brief summary:
1259 BeerDB Maypole::Model::CDBI
1263 || setup_model | setup_database() creates
1264 ||------+ | a subclass of the Model
1265 |||<----+ | for each table
1267 ||| setup_database | |
1268 |||--------------------->|| 'create' *
1269 ||| ||----------> $subclass
1271 ||| load_model_subclass | |
1272 foreach |||------+ ($subclass) | |
1273 $subclass ||||<----+ | require |
1274 ||||--------------------------------------->|
1276 ||| adopt($subclass) | |
1277 |||--------------------->|| |
1282 || | new | view_object: e.g.
1283 ||---------------------------------------------> Maypole::View::TT
1295 BeerDB Model $subclass view_object
1298 o-------->| new | | |
1299 |-----> r:BeerDB | | |
1303 | ||-----+ parse_location | | |
1306 | ||-----+ start_request_hook | | |
1309 | ||-----+ get_session | | |
1312 | ||-----+ get_user | | |
1315 | ||-----+ handler_guts | | |
1317 | ||| class_of($table) | | |
1318 | |||------------------------->|| | |
1319 | ||| $subclass || | |
1320 | |||<-------------------------|| | |
1322 | |||-----+ is_model_applicable| | |
1325 | |||-----+ call_authenticate | | |
1328 | |||-----+ additional_data | | |
1331 | |||--------------------------------->|| fetch_objects
1339 | |||------------------------------------------->|| template
1343 | || send_output | | |
1347 <------------------|| | | |
1358 There's more documentation, examples, and information on our mailing lists
1359 at the Maypole web site:
1361 L<http://maypole.perl.org/>
1363 L<Maypole::Application>, L<Apache::MVC>, L<CGI::Maypole>.
1367 Maypole is currently maintained by Aaron Trevena, David Baird, Dave Howorth and
1370 =head1 AUTHOR EMERITUS
1372 Simon Cozens, C<simon#cpan.org>
1374 Simon Flack maintained Maypole from 2.05 to 2.09
1376 Sebastian Riedel, C<sri#oook.de> maintained Maypole from 1.99_01 to 2.04
1380 Sebastian Riedel, Danijel Milicevic, Dave Slack, Jesse Sheidlower, Jody Belka,
1381 Marcus Ramberg, Mickael Joanne, Randal Schwartz, Simon Flack, Steve Simms,
1382 Veljko Vidovic and all the others who've helped.
1386 You may distribute this code under the same terms as Perl itself.
1394 =item register_cleanup($coderef)
1396 Analogous to L<Apache>'s C<register_cleanup>. If an Apache request object is
1397 available, this call simply redispatches there. If not, the cleanup is
1398 registered in the Maypole request, and executed when the request is
1401 This method is only useful in persistent environments, where you need to ensure
1402 that some code runs when the request finishes, no matter how it finishes (e.g.
1403 after an unexpected error).
1410 sub register_cleanup
1412 my ($self, $cleanup) = @_;
1414 die "register_cleanup() is an instance method, not a class method"
1416 die "Cleanup must be a coderef" unless ref($cleanup) eq 'CODE';
1418 if ($self->can('ar') && $self->ar)
1420 $self->ar->register_cleanup($cleanup);
1424 push @_cleanups, $cleanup;
1432 while (my $cleanup = shift @_cleanups)
1434 eval { $cleanup->() };
1437 warn "Error during request cleanup: $@";