2 use base qw(Class::Accessor::Fast Class::Data::Inheritable);
3 use UNIVERSAL::require;
7 use Maypole::Constants;
9 use Maypole::Components;
11 use File::MMagic::XS qw(:compat);
13 our $VERSION = '2.11';
14 our $mmagic = File::MMagic::XS->new();
16 # proposed privacy conventions:
17 # - no leading underscore - public to custom application code and plugins
18 # - single leading underscore - private to the main Maypole stack - *not*
20 # - double leading underscore - private to the current package
24 Maypole - MVC web application framework
28 The canonical example used in the Maypole documentation is the beer database:
34 # choose a frontend, initialise the config object, and load a plugin
35 use Maypole::Application qw/Relationship/;
37 # get the empty config object created by Maypole::Application
38 my $config = __PACKAGE__->config;
41 $config->uri_base("http://localhost/beerdb");
42 $config->template_root("/path/to/templates");
43 $config->rows_per_page(10);
44 $config->display_tables([qw/beer brewery pub style/]);
47 $config->relationships([
48 "a brewery produces beers",
49 "a style defines beers",
50 "a pub has beers on handpumps",
54 BeerDB::Brewery->untaint_columns( printable => [qw/name notes url/] );
55 BeerDB::Pub->untaint_columns( printable => [qw/name notes url/] );
56 BeerDB::Style->untaint_columns( printable => [qw/name notes/] );
57 BeerDB::Beer->untaint_columns(
58 printable => [qw/abv name price notes/],
59 integer => [qw/style brewery score/],
64 __PACKAGE__->setup("dbi:SQLite:t/beerdb.db");
70 This documents the Maypole request object. See the L<Maypole::Manual>, for a
71 detailed guide to using Maypole.
73 Maypole is a Perl web application framework similar to Java's struts. It is
74 essentially completely abstracted, and so doesn't know anything about
75 how to talk to the outside world.
77 To use it, you need to create a driver package which represents your entire
78 application. This is the C<BeerDB> package used as an example in the manual.
80 This needs to first use L<Maypole::Application> which will make your package
81 inherit from the appropriate platform driver such as C<Apache::MVC> or
82 C<CGI::Maypole>. Then, the driver calls C<setup>. This sets up the model classes
83 and configures your application. The default model class for Maypole uses
84 L<Class::DBI> to map a database to classes, but this can be changed by altering
85 configuration (B<before> calling setup.)
88 =head1 DOCUMENTATION AND SUPPORT
90 Note that some details in some of these resources may be out of date.
94 =item The Maypole Manual
96 The primary documentation is the Maypole manual. This lives in the
97 C<Maypole::Manual> pod documents included with the distribution.
101 Individual packages within the distribution contain (more or less) detailed
102 reference documentation for their API.
106 There are two mailing lists - maypole-devel and maypole-users - see
107 http://maypole.perl.org/?MailingList
109 =item The Maypole Wiki
111 The Maypole wiki provides a useful store of extra documentation -
112 http://maypole.perl.org
114 In particular, there's a FAQ (http://maypole.perl.org/?FAQ) and a cookbook
115 (http://maypole.perl.org/?Cookbook). Again, certain information on these pages
118 =item Web applications with Maypole
120 A tutorial written by Simon Cozens for YAPC::EU 2005 -
121 http://www.droogs.org/perl/maypole/maypole-tutorial.pdf [228KB].
123 =item A Database-Driven Web Application in 18 Lines of Code
125 By Paul Barry, published in Linux Journal, March 2005.
127 http://www.linuxjournal.com/article/7937
129 "From zero to Web-based database application in eight easy steps".
131 Maypole won a 2005 Linux Journal Editor's Choice Award
132 (http://www.linuxjournal.com/article/8293) after featuring in this article.
134 =item Build Web apps with Maypole
136 By Simon Cozens, on IBM's DeveloperWorks website, May 2004.
138 http://www-128.ibm.com/developerworks/linux/library/l-maypole/
140 =item Rapid Web Application Deployment with Maypole
142 By Simon Cozens, on O'Reilly's Perl website, April 2004.
144 http://www.perl.com/pub/a/2004/04/15/maypole.html
148 Some notes written by Simon Cozens. A little bit out of date, but still
149 very useful: http://www.droogs.org/perl/maypole/authentication.html
153 There's a refcard for the Maypole (and Class::DBI) APIs on the wiki -
154 http://maypole.perl.org/?CheatSheet. Probably a little out of date now - it's a
155 wiki, so feel free to fix any errors!
157 =item Plugins and add-ons
159 There are a large and growing number of plugins and other add-on modules
160 available on CPAN - http://search.cpan.org/search?query=maypole&mode=module
164 You can find a range of useful Maypole links, particularly to several thoughtful
165 blog entries, starting here: http://del.icio.us/search/?all=maypole
169 There are a couple of short reviews here:
170 http://cpanratings.perl.org/dist/Maypole
176 A couple of demos are available, sometimes with source code and configs.
180 =item http://maypole.perl.org/beerdb/
182 The standard BeerDB example, using the TT factory templates supplied in the
185 =item beerdb.riverside-cms.co.uk
187 The standard BeerDB example, running on Mason, using the factory templates
188 supplied in the L<MasonX::Maypole> distribution.
190 =item beerfb.riverside-cms.co.uk
192 A demo of L<Maypole::FormBuilder>. This site is running on the set of Mason
193 templates included in the L<Maypole::FormBuilder> distribution. See the
194 synopsis of L<Maypole::Plugin::FormBuilder> for an example driver
200 __PACKAGE__->mk_classdata($_) for qw( config init_done view_object model_classes_loaded);
202 __PACKAGE__->mk_accessors(
203 qw( params query objects model_class template_args output path
204 args action template error document_encoding content_type table
205 headers_in headers_out stash status)
208 __PACKAGE__->config( Maypole::Config->new() );
210 __PACKAGE__->init_done(0);
212 __PACKAGE__->model_classes_loaded(0);
214 =head1 HOOKABLE METHODS
216 As a framework, Maypole provides a number of B<hooks> - methods that are
217 intended to be overridden. Some of these methods come with useful default
218 behaviour, others do nothing by default. Hooks include:
244 sub My::App::debug {1}
246 Returns the debugging flag. Override this in your application class to
247 enable/disable debugging.
249 You can also set the C<debug> flag via L<Maypole::Application>.
251 Some packages respond to higher debug levels, try increasing it to 2 or 3.
260 Returns the L<Maypole::Config> object
264 My::App->setup($data_source, $user, $password, \%attr);
266 Initialise the Maypole application and plugins and model classes.
267 Your application should call this B<after> setting up configuration data via
270 It calls the hook C<setup_model> to setup the model. The %attr hash contains
271 options and arguments used to set up the model. See the particular model's
272 documentation. However here is the most usage of setup where
273 Maypole::Model::CDBI is the base class.
275 My::App->setup($data_source, $user, $password,
276 { opitons => { # These are DB connection options
281 # These are Class::DBI::Loader arguments.
287 Also, see L<Maypole::Manual::Plugins>.
296 $class->setup_model(@_);
301 Called by C<setup>. This method builds the Maypole model hierarchy.
303 A likely target for over-riding, if you need to build a customised model.
305 This method also ensures any code in custom model classes is loaded, so you
306 don't need to load them in the driver.
314 $class = ref $class if ref $class;
316 my $config = $class->config;
318 $config->model || $config->model('Maypole::Model::CDBI');
320 $config->model->require or die sprintf
321 "Couldn't load the model class %s: %s", $config->model, $@;
323 # among other things, this populates $config->classes
324 $config->model->setup_database($config, $class, @_);
326 foreach my $subclass ( @{ $config->classes } )
328 next if $subclass->isa("Maypole::Model::Base");
330 unshift @{ $subclass . "::ISA" }, $config->model;
332 # Load custom model code, if it exists - nb this must happen after the
333 # unshift, to allow code attributes to work, but before adopt(),
334 # in case adopt() calls overridden methods on $subclass
335 $class->load_model_subclass($subclass) unless ($class->model_classes_loaded());
337 $config->model->adopt($subclass) if $config->model->can("adopt");
341 =item load_model_subclass($subclass)
343 This method is called from C<setup_model()>. It attempts to load the
344 C<$subclass> package, if one exists. So if you make a customized C<BeerDB::Beer>
345 package, you don't need to explicitly load it.
347 If, perhaps during development, you don't want to load up custom classes, you
348 can override this method and load them manually.
352 sub load_model_subclass
354 my ($class, $subclass) = @_;
356 my $config = $class->config;
358 # Load any external files for the model base class or subclasses
359 # (e.g. BeerDB/DBI.pm or BeerDB/Beer.pm) based on code borrowed from
360 # Maypole::Plugin::Loader and Class::DBI.
361 if ( $subclass->require )
363 warn "Loaded external module for '$subclass'\n" if $class->debug > 1;
367 (my $filename = $subclass) =~ s!::!/!g;
368 die "Loading '$subclass' failed: $@\n"
369 unless $@ =~ /Can\'t locate \Q$filename\E\.pm/;
370 warn "No external module for '$subclass'"
371 if $class->debug > 1;
377 Loads the view class and instantiates the view object.
379 You should not call this directly, but you may wish to override this to add
380 application-specific initialisation - see L<Maypole::Manual::Plugins>.
387 my $config = $class->config;
388 $config->view || $config->view("Maypole::View::TT");
389 $config->view->require;
390 die "Couldn't load the view class " . $config->view . ": $@" if $@;
391 $config->display_tables
392 || $config->display_tables( $class->config->tables );
393 $class->view_object( $class->config->view->new );
394 $class->init_done(1);
399 Constructs a very minimal new Maypole request object.
409 config => $class->config,
417 Get/set the Maypole::View object
421 =head1 INSTANCE METHODS
429 This method sets up the class if it's not done yet, sets some defaults and
430 leaves the dirty work to C<handler_guts>.
434 # handler() has a method attribute so that mod_perl will invoke
435 # BeerDB->handler() as a method rather than a plain function
436 # BeerDB::handler() and so this inherited implementation will be
437 # found. See e.g. "Practical mod_perl" by Bekman & Cholet for
438 # more information <http://modperlbook.org/html/ch25_01.html>
439 sub handler : method {
440 # See Maypole::Workflow before trying to understand this.
441 my ($class, $req) = @_;
443 $class->init unless $class->init_done;
445 my $self = $class->new;
447 # initialise the request
448 $self->headers_out(Maypole::Headers->new);
449 $self->get_request($req);
450 $self->parse_location;
452 # hook useful for declining static requests e.g. images, or perhaps for
453 # sanitizing request parameters
454 $self->status(Maypole::Constants::OK()); # set the default
455 $self->__call_hook('start_request_hook');
456 return $self->status unless $self->status == Maypole::Constants::OK();
458 die "status undefined after start_request_hook()" unless defined
464 my $status = $self->handler_guts;
465 return $status unless $status == OK;
467 # TODO: require send_output to return a status code
475 my $component = Maypole::Components->new(@_);
476 return $component->handler($path);
480 # Instead of making plugin authors use the NEXT::DISTINCT hoopla to ensure other
481 # plugins also get to call the hook, we can cycle through the application's
482 # @ISA and call them all here. Doesn't work for setup() though, because it's
483 # too ingrained in the stack. We could add a run_setup() method, but we'd break
484 # lots of existing code.
487 my ($self, $hook) = @_;
491 my $class = ref($self);
493 @plugins = @{"$class\::ISA"};
496 # this is either a custom method in the driver, or the method in the 1st
497 # plugin, or the 'null' method in the frontend (i.e. inherited from
498 # Maypole.pm) - we need to be careful to only call it once
499 my $first_hook = $self->can($hook);
502 my %seen = ( $first_hook => 1 );
504 # @plugins includes the frontend
505 foreach my $plugin (@plugins)
507 next unless my $plugin_hook = $plugin->can($hook);
508 next if $seen{$plugin_hook}++;
515 This is the main request handling method and calls various methods to handle the
516 request/response and defines the workflow within Maypole.
518 B<Currently undocumented and liable to be refactored without warning>.
522 # The root of all evil
527 $self->__load_request_model;
529 my $applicable = $self->is_model_applicable;
531 $self->__setup_plain_template unless $applicable;
535 eval { $status = $self->call_authenticate };
537 if ( my $error = $@ )
539 $status = $self->call_exception($error, "authentication");
543 warn "caught authenticate error: $error";
544 return $self->debug ?
545 $self->view_object->error($self, $error) : ERROR;
549 if ( $self->debug and $status != OK and $status != DECLINED )
551 $self->view_object->error( $self,
552 "Got unexpected status $status from calling authentication" );
555 return $status unless $status == OK;
557 # We run additional_data for every request
558 $self->additional_data;
562 eval { $self->model_class->process($self) };
564 if ( my $error = $@ )
566 $status = $self->call_exception($error, "model");
570 warn "caught model error: $error";
571 return $self->debug ?
572 $self->view_object->error($self, $error) : ERROR;
577 # less frequent path - perhaps output has been set to an error message
578 return OK if $self->output;
580 # normal path - no output has been generated yet
581 my $processed_view_ok = $self->__call_process_view;
583 $self->{content_type} ||= $self->__get_mime_type();
584 $self->{document_encoding} ||= "utf-8";
586 return $processed_view_ok;
590 'js' => 'text/javascript',
592 'htm' => 'text/html',
593 'html' => 'text/html',
596 sub __get_mime_type {
599 if ($self->path =~ m/.*\.(\w{3,4})$/) {
600 $type = $filetypes{$1};
602 $type = $mmagic->checktype_contents($self->output);
607 sub __load_request_model
610 $self->model_class( $self->config->model->class_of($self, $self->table) );
613 # is_applicable() returned false, so set up a plain template. Model processing
614 # will be skipped, but need to remove the model anyway so the template can't
616 sub __setup_plain_template
620 # It's just a plain template
621 $self->model_class(undef);
623 my $path = $self->path;
624 $path =~ s{/$}{}; # De-absolutify
627 $self->template($self->path);
630 # The model has been processed or skipped (if is_applicable returned false),
631 # any exceptions have been handled, and there's no content in $self->output
632 sub __call_process_view
638 eval { $status = $self->view_object->process($self) };
640 if ( my $error = $@ )
642 $status = $self->call_exception($error, "view");
646 warn "caught view error: $error" if $self->debug;
647 return $self->debug ?
648 $self->view_object->error($self, $error) : ERROR;
657 You should only need to define this method if you are writing a new
658 Maypole backend. It should return something that looks like an Apache
659 or CGI request object, it defaults to blank.
667 Turns the backend request (e.g. Apache::MVC, Maypole, CGI) into a Maypole
668 request. It does this by setting the C<path>, and invoking C<parse_path> and
671 You should only need to define this method if you are writing a new Maypole
678 die "parse_location is a virtual method. Do not use Maypole directly; " .
679 "use Apache::MVC or similar";
682 =item start_request_hook
684 This is called immediately after setting up the basic request. The default
687 The value of C<< $r->status >> is set to C<OK> before this hook is run. Your
688 implementation can change the status code, or leave it alone.
690 After this hook has run, Maypole will check the value of C<status>. For any
691 value other than C<OK>, Maypole returns the C<status> immediately.
693 This is useful for filtering out requests for static files, e.g. images, which
694 should not be processed by Maypole or by the templating engine:
696 sub start_request_hook
700 $r->status(DECLINED) if $r->path =~ /\.jpg$/;
703 Multiple plugins, and the driver, can define this hook - Maypole will call all
704 of them. You should check for and probably not change any non-OK C<status>
707 package Maypole::Plugin::MyApp::SkipFavicon;
709 sub start_request_hook
713 # check if a previous plugin has already DECLINED this request
714 # - probably unnecessary in this example, but you get the idea
715 return unless $r->status == OK;
718 $r->status(DECLINED) if $r->path =~ /favicon\.ico/;
723 sub start_request_hook { }
727 B<This method is deprecated> as of version 2.11. If you have overridden it,
728 please override C<is_model_applicable> instead, and change the return type
729 from a Maypole:Constant to a true/false value.
731 Returns a Maypole::Constant to indicate whether the request is valid.
733 =item is_model_applicable
735 Returns true or false to indicate whether the request is valid.
737 The default implementation checks that C<< $r->table >> is publicly
738 accessible and that the model class is configured to handle the
743 sub is_model_applicable
747 # cater for applications that are using obsolete version
748 if ($self->can('is_applicable'))
750 warn "DEPRECATION WARNING: rewrite is_applicable to the interface ".
751 "of Maypole::is_model_applicable\n";
752 return $self->is_applicable == OK;
755 # Establish which tables should be processed by the model
756 my $config = $self->config;
758 $config->ok_tables || $config->ok_tables( $config->display_tables );
760 $config->ok_tables( { map { $_ => 1 } @{ $config->ok_tables } } )
761 if ref $config->ok_tables eq "ARRAY";
763 my $ok_tables = $config->ok_tables;
765 # Does this request concern a table to be processed by the model?
766 my $table = $self->table;
770 if (exists $ok_tables->{$table})
777 warn "We don't have that table ($table).\n"
778 . "Available tables are: "
779 . join( ",", keys %$ok_tables )
780 if $self->debug and not $ok_tables->{$table};
785 # Is the action public?
786 my $action = $self->action;
787 return 1 if $self->model_class->is_public($action);
789 warn "The action '$action' is not applicable to the table '$table'"
797 Called immediately after C<start_request_hook()>.
799 This method should return a session, which will be stored in the request's
800 C<session> attribute.
802 The default method is empty.
810 Called immediately after C<get_session>.
812 This method should return a user, which will be stored in the request's C<user>
815 The default method is empty.
821 =item call_authenticate
823 This method first checks if the relevant model class
824 can authenticate the user, or falls back to the default
825 authenticate method of your Maypole application.
829 sub call_authenticate
833 # Check if we have a model class with an authenticate() to delegate to
834 return $self->model_class->authenticate($self)
835 if $self->model_class and $self->model_class->can('authenticate');
837 # Interface consistency is a Good Thing -
838 # the invocant and the argument may one day be different things
839 # (i.e. controller and request), like they are when authenticate()
840 # is called on a model class (i.e. model and request)
841 return $self->authenticate($self);
846 Returns a Maypole::Constant to indicate whether the user is authenticated for
849 The default implementation returns C<OK>
853 sub authenticate { return OK }
858 This model is called to catch exceptions, first after authenticate, then after
859 processing the model class, and finally to check for exceptions from the view
862 This method first checks if the relevant model class
863 can handle exceptions the user, or falls back to the default
864 exception method of your Maypole application.
870 my ($self, $error, $when) = @_;
872 # Check if we have a model class with an exception() to delegate to
873 if ( $self->model_class && $self->model_class->can('exception') )
875 my $status = $self->model_class->exception( $self, $error, $when );
876 return $status if $status == OK;
879 return $self->exception($error, $when);
885 This method is called if any exceptions are raised during the authentication or
886 model/view processing. It should accept the exception as a parameter and return
887 a Maypole::Constant to indicate whether the request should continue to be
893 my ($self, $error, $when) = @_;
894 if ($self->view_object->can("report_error") and $self->debug) {
895 $self->view_object->report_error($self, $error, $when);
901 =item additional_data
903 Called before the model processes the request, this method gives you a chance to
904 do some processing for each request, for example, manipulating C<template_args>.
908 sub additional_data { }
912 Sends the output and additional headers to the user.
917 die "send_output is a virtual method. Do not use Maypole directly; use Apache::MVC or similar";
925 =head2 Path processing and manipulation
931 Returns the request path
935 Parses the request path and sets the C<args>, C<action> and C<table>
936 properties. Calls C<preprocess_path> before parsing path and setting properties.
944 # Previous versions unconditionally set table, action and args to whatever
945 # was in @pi (or else to defaults, if @pi is empty).
946 # Adding preprocess_path(), and then setting table, action and args
947 # conditionally, broke lots of tests, hence this:
948 $self->$_(undef) for qw/action table args/;
950 $self->preprocess_path;
951 $self->path || $self->path('frontpage');
953 my @pi = grep {length} split '/', $self->path;
956 $self->table || $self->table(shift @pi);
957 $self->action || $self->action( shift @pi or 'index' );
958 $self->args || $self->args(\@pi);
961 =item preprocess_path
963 Sometimes when you don't want to rewrite or over-ride parse_path but
964 want to rewrite urls or extract data from them before it is parsed.
966 This method is called after parse_location has populated the request
967 information and before parse_path has populated the model and action
968 information, and is passed the request object.
970 You can set action, args or table in this method and parse_path will
971 then leave those values in place or populate them if not present
975 sub preprocess_path { };
977 =item make_path( %args or \%args or @args )
979 This is the counterpart to C<parse_path>. It generates a path to use
980 in links, form actions etc. To implement your own path scheme, just override
981 this method and C<parse_path>.
983 %args = ( table => $table,
985 additional => $additional, # optional - generally an object ID
988 \%args = as above, but a ref
990 @args = ( $table, $action, $additional ); # $additional is optional
992 C<id> can be used as an alternative key to C<additional>.
994 C<$additional> can be a string, an arrayref, or a hashref. An arrayref is
995 expanded into extra path elements, whereas a hashref is translated into a query
1006 if (@_ == 1 and ref $_[0] and ref $_[0] eq 'HASH')
1010 elsif ( @_ > 1 and @_ < 4 )
1012 $args{table} = shift;
1013 $args{action} = shift;
1014 $args{additional} = shift;
1021 do { die "no $_" unless $args{$_} } for qw( table action );
1023 my $additional = $args{additional} || $args{id};
1029 # if $additional is a href, make_uri() will transform it into a query
1030 @add = (ref $additional eq 'ARRAY') ? @$additional : ($additional);
1033 my $uri = $r->make_uri($args{table}, $args{action}, @add);
1035 return $uri->as_string;
1040 =item make_uri( @segments )
1042 Make a L<URI> object given table, action etc. Automatically adds
1045 If the final element in C<@segments> is a hash ref, C<make_uri> will render it
1052 my ($r, @segments) = @_;
1054 my $query = (ref $segments[-1] eq 'HASH') ? pop(@segments) : undef;
1056 my $base = $r->config->uri_base;
1059 my $uri = URI->new($base);
1060 $uri->path_segments($uri->path_segments, grep {length} @segments);
1062 my $abs_uri = $uri->abs('/');
1063 $abs_uri->query_form($query) if $query;
1069 Turns post data and query string paramaters into a hash of C<params>.
1071 You should only need to define this method if you are writing a new Maypole
1078 die "parse_args() is a virtual method. Do not use Maypole directly; ".
1079 "use Apache::MVC or similar";
1082 =item get_template_root
1084 Implementation-specific path to template root.
1086 You should only need to define this method if you are writing a new Maypole
1087 backend. Otherwise, see L<Maypole::Config/"template_root">
1091 sub get_template_root {'.'}
1095 =head2 Request properties
1101 Returns the perl package name that will serve as the model for the
1102 request. It corresponds to the request C<table> attribute.
1107 Get/set a list of model objects. The objects will be accessible in the view
1110 If the first item in C<$self-E<gt>args> can be C<retrieve()>d by the model
1111 class, it will be removed from C<args> and the retrieved object will be added to
1112 the C<objects> list. See L<Maypole::Model> for more information.
1116 $self->template_args->{foo} = 'bar';
1118 Get/set a hash of template variables.
1122 A place to put custom application data. Not used by Maypole itself.
1126 Get/set the template to be used by the view. By default, it returns
1127 C<$self-E<gt>action>
1132 Get/set a request error
1136 Get/set the response output. This is usually populated by the view class. You
1137 can skip view processing by setting the C<output>.
1141 The table part of the Maypole request path
1145 The action part of the Maypole request path
1149 A list of remaining parts of the request path after table and action
1155 A L<Maypole::Headers> object containing HTTP headers for the request
1159 A L<HTTP::Headers> object that contains HTTP headers for the output
1161 =item document_encoding
1163 Get/set the output encoding. Default: utf-8.
1167 Get/set the output content type. Default: text/html
1171 Returns the protocol the request was made with, i.e. https
1176 die "get_protocol is a virtual method. Do not use Maypole directly; use Apache::MVC or similar";
1181 =head2 Request parameters
1183 The source of the parameters may vary depending on the Maypole backend, but they
1184 are usually populated from request query string and POST data.
1186 Maypole supplies several approaches for accessing the request parameters. Note
1187 that the current implementation (via a hashref) of C<query> and C<params> is
1188 likely to change in a future version of Maypole. So avoid direct access to these
1191 $r->{params}->{foo} # bad
1192 $r->params->{foo} # better
1194 $r->{query}->{foo} # bad
1195 $r->query->{foo} # better
1197 $r->param('foo') # best
1203 An accessor (get or set) for request parameters. It behaves similarly to
1204 CGI::param() for accessing CGI parameters, i.e.
1206 $r->param # returns list of keys
1207 $r->param($key) # returns value for $key
1208 $r->param($key => $value) # returns old value, sets to new value
1214 my ($self, $key) = (shift, shift);
1216 return keys %{$self->params} unless defined $key;
1218 return unless exists $self->params->{$key};
1220 my $val = $self->params->{$key};
1224 my $new_val = shift;
1225 $self->params->{$key} = $new_val;
1228 return ref $val ? @$val : ($val) if wantarray;
1230 return ref $val ? $val->[0] : $val;
1236 Returns a hashref of request parameters.
1238 B<Note:> Where muliple values of a parameter were supplied, the C<params> value
1239 will be an array reference.
1243 Alias for C<params>.
1247 =head3 Utility methods
1251 =item redirect_request
1253 Sets output headers to redirect based on the arguments provided
1255 Accepts either a single argument of the full url to redirect to, or a hash of
1258 $r->redirect_request('http://www.example.com/path');
1262 $r->redirect_request(protocol=>'https', domain=>'www.example.com', path=>'/path/file?arguments', status=>'302', url=>'..');
1264 The named parameters are protocol, domain, path, status and url
1266 Only 1 named parameter is required but other than url, they can be combined as
1267 required and current values (from the request) will be used in place of any
1268 missing arguments. The url argument must be a full url including protocol and
1269 can only be combined with status.
1273 sub redirect_request {
1274 die "redirect_request is a virtual method. Do not use Maypole directly; use Apache::MVC or similar";
1277 =item redirect_internal_request
1281 sub redirect_internal_request {
1286 =item make_random_id
1288 returns a unique id for this request can be used to prevent or detect repeat
1293 # Session and Repeat Submission Handling
1294 sub make_random_id {
1295 use Maypole::Session;
1296 return Maypole::Session::generate_unique_id();
1301 =head1 SEQUENCE DIAGRAMS
1303 See L<Maypole::Manual::Workflow> for a detailed discussion of the sequence of
1304 calls during processing of a request. This is a brief summary:
1308 BeerDB Maypole::Model::CDBI
1312 || setup_model | setup_database() creates
1313 ||------+ | a subclass of the Model
1314 |||<----+ | for each table
1316 ||| setup_database | |
1317 |||--------------------->|| 'create' *
1318 ||| ||----------> $subclass
1320 ||| load_model_subclass | |
1321 foreach |||------+ ($subclass) | |
1322 $subclass ||||<----+ | require |
1323 ||||--------------------------------------->|
1325 ||| adopt($subclass) | |
1326 |||--------------------->|| |
1331 || | new | view_object: e.g.
1332 ||---------------------------------------------> Maypole::View::TT
1344 BeerDB Model $subclass view_object
1347 o-------->| new | | |
1348 |-----> r:BeerDB | | |
1352 | ||-----+ parse_location | | |
1355 | ||-----+ start_request_hook | | |
1358 | ||-----+ get_session | | |
1361 | ||-----+ get_user | | |
1364 | ||-----+ handler_guts | | |
1366 | ||| class_of($table) | | |
1367 | |||------------------------->|| | |
1368 | ||| $subclass || | |
1369 | |||<-------------------------|| | |
1371 | |||-----+ is_model_applicable| | |
1374 | |||-----+ call_authenticate | | |
1377 | |||-----+ additional_data | | |
1380 | |||--------------------------------->|| fetch_objects
1388 | |||------------------------------------------->|| template
1392 | || send_output | | |
1396 <------------------|| | | |
1407 There's more documentation, examples, and information on our mailing lists
1408 at the Maypole web site:
1410 L<http://maypole.perl.org/>
1412 L<Maypole::Application>, L<Apache::MVC>, L<CGI::Maypole>.
1416 Maypole is currently maintained by Aaron Trevena, David Baird, Dave Howorth and
1419 =head1 AUTHOR EMERITUS
1421 Simon Cozens, C<simon#cpan.org>
1423 Simon Flack maintained Maypole from 2.05 to 2.09
1425 Sebastian Riedel, C<sri#oook.de> maintained Maypole from 1.99_01 to 2.04
1429 Sebastian Riedel, Danijel Milicevic, Dave Slack, Jesse Sheidlower, Jody Belka,
1430 Marcus Ramberg, Mickael Joanne, Randal Schwartz, Simon Flack, Steve Simms,
1431 Veljko Vidovic and all the others who've helped.
1435 You may distribute this code under the same terms as Perl itself.
1443 =item register_cleanup($coderef)
1445 Analogous to L<Apache>'s C<register_cleanup>. If an Apache request object is
1446 available, this call simply redispatches there. If not, the cleanup is
1447 registered in the Maypole request, and executed when the request is
1450 This method is only useful in persistent environments, where you need to ensure
1451 that some code runs when the request finishes, no matter how it finishes (e.g.
1452 after an unexpected error).
1459 sub register_cleanup
1461 my ($self, $cleanup) = @_;
1463 die "register_cleanup() is an instance method, not a class method"
1465 die "Cleanup must be a coderef" unless ref($cleanup) eq 'CODE';
1467 if ($self->can('ar') && $self->ar)
1469 $self->ar->register_cleanup($cleanup);
1473 push @_cleanups, $cleanup;
1481 while (my $cleanup = shift @_cleanups)
1483 eval { $cleanup->() };
1486 warn "Error during request cleanup: $@";