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.
312 $class = ref $class if ref $class;
313 my $config = $class->config;
314 $config->model || $config->model('Maypole::Model::CDBI');
315 $config->model->require or die sprintf
316 "Couldn't load the model class %s: %s", $config->model, $@;
318 # among other things, this populates $config->classes
319 $config->model->setup_database($config, $class, @_);
321 foreach my $subclass ( @{ $config->classes } ) {
322 next if $subclass->isa("Maypole::Model::Base");
324 unshift @{ $subclass . "::ISA" }, $config->model;
328 # Load custom model code, if it exists - nb this must happen after the
329 # unshift, to allow code attributes to work, but before adopt(),
330 # in case adopt() calls overridden methods on $subclass
331 foreach my $subclass ( @{ $config->classes } ) {
332 $class->load_model_subclass($subclass) unless ($class->model_classes_loaded());
333 $config->model->adopt($subclass) if $config->model->can("adopt");
338 =item load_model_subclass($subclass)
340 This method is called from C<setup_model()>. It attempts to load the
341 C<$subclass> package, if one exists. So if you make a customized C<BeerDB::Beer>
342 package, you don't need to explicitly load it.
344 If automatic loading causes problems, Override load_model_subclass in your driver.
346 sub load_model_subclass {};
348 Or perhaps during development, if you don't want to load up custom classes, you
349 can override this method and load them manually.
353 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 ) {
362 warn "Loaded external module for '$subclass'\n" if $class->debug > 1;
364 (my $filename = $subclass) =~ s!::!/!g;
365 die "Loading '$subclass' failed: $@\n"
366 unless $@ =~ /Can\'t locate \Q$filename\E\.pm/;
367 warn "No external module for '$subclass'"
368 if $class->debug > 1;
374 Loads the view class and instantiates the view object.
376 You should not call this directly, but you may wish to override this to add
377 application-specific initialisation - see L<Maypole::Manual::Plugins>.
384 my $config = $class->config;
385 $config->view || $config->view("Maypole::View::TT");
386 $config->view->require;
387 die "Couldn't load the view class " . $config->view . ": $@" if $@;
388 $config->display_tables
389 || $config->display_tables( $class->config->tables );
390 $class->view_object( $class->config->view->new );
391 $class->init_done(1);
396 Constructs a very minimal new Maypole request object.
406 config => $class->config,
414 Get/set the Maypole::View object
418 =head1 INSTANCE METHODS
426 This method sets up the class if it's not done yet, sets some defaults and
427 leaves the dirty work to C<handler_guts>.
431 # handler() has a method attribute so that mod_perl will invoke
432 # BeerDB->handler() as a method rather than a plain function
433 # BeerDB::handler() and so this inherited implementation will be
434 # found. See e.g. "Practical mod_perl" by Bekman & Cholet for
435 # more information <http://modperlbook.org/html/ch25_01.html>
436 sub handler : method {
437 # See Maypole::Workflow before trying to understand this.
438 my ($class, $req) = @_;
440 $class->init unless $class->init_done;
442 my $self = $class->new;
444 # initialise the request
445 $self->headers_out(Maypole::Headers->new);
446 $self->get_request($req);
447 $self->parse_location;
449 # hook useful for declining static requests e.g. images, or perhaps for
450 # sanitizing request parameters
451 $self->status(Maypole::Constants::OK()); # set the default
452 $self->__call_hook('start_request_hook');
453 return $self->status unless $self->status == Maypole::Constants::OK();
455 die "status undefined after start_request_hook()" unless defined
461 my $status = $self->handler_guts;
462 return $status unless $status == OK;
464 # TODO: require send_output to return a status code
472 my $component = Maypole::Components->new(@_);
473 return $component->handler($path);
477 # Instead of making plugin authors use the NEXT::DISTINCT hoopla to ensure other
478 # plugins also get to call the hook, we can cycle through the application's
479 # @ISA and call them all here. Doesn't work for setup() though, because it's
480 # too ingrained in the stack. We could add a run_setup() method, but we'd break
481 # lots of existing code.
484 my ($self, $hook) = @_;
488 my $class = ref($self);
490 @plugins = @{"$class\::ISA"};
493 # this is either a custom method in the driver, or the method in the 1st
494 # plugin, or the 'null' method in the frontend (i.e. inherited from
495 # Maypole.pm) - we need to be careful to only call it once
496 my $first_hook = $self->can($hook);
499 my %seen = ( $first_hook => 1 );
501 # @plugins includes the frontend
502 foreach my $plugin (@plugins)
504 next unless my $plugin_hook = $plugin->can($hook);
505 next if $seen{$plugin_hook}++;
512 This is the main request handling method and calls various methods to handle the
513 request/response and defines the workflow within Maypole.
515 B<Currently undocumented and liable to be refactored without warning>.
519 # The root of all evil
524 $self->__load_request_model;
526 my $applicable = $self->is_model_applicable == OK;
528 $self->__setup_plain_template unless $applicable;
532 eval { $status = $self->call_authenticate };
534 if ( my $error = $@ )
536 $status = $self->call_exception($error, "authentication");
540 warn "caught authenticate error: $error";
541 return $self->debug ?
542 $self->view_object->error($self, $error) : ERROR;
546 if ( $self->debug and $status != OK and $status != DECLINED )
548 $self->view_object->error( $self,
549 "Got unexpected status $status from calling authentication" );
552 return $status unless $status == OK;
554 # We run additional_data for every request
555 $self->additional_data;
559 eval { $self->model_class->process($self) };
561 if ( my $error = $@ )
563 $status = $self->call_exception($error, "model");
567 warn "caught model error: $error";
568 return $self->debug ?
569 $self->view_object->error($self, $error) : ERROR;
574 # less frequent path - perhaps output has been set to an error message
575 return OK if $self->output;
577 # normal path - no output has been generated yet
578 my $processed_view_ok = $self->__call_process_view;
580 $self->{content_type} ||= $self->__get_mime_type();
581 $self->{document_encoding} ||= "utf-8";
583 return $processed_view_ok;
587 'js' => 'text/javascript',
589 'htm' => 'text/html',
590 'html' => 'text/html',
593 sub __get_mime_type {
596 if ($self->path =~ m/.*\.(\w{3,4})$/) {
597 $type = $filetypes{$1};
599 $type = $mmagic->checktype_contents($self->output);
604 sub __load_request_model
607 $self->model_class( $self->config->model->class_of($self, $self->table) );
610 # is_applicable() returned false, so set up a plain template. Model processing
611 # will be skipped, but need to remove the model anyway so the template can't
613 sub __setup_plain_template
617 # It's just a plain template
618 $self->model_class(undef);
620 my $path = $self->path;
621 $path =~ s{/$}{}; # De-absolutify
624 $self->template($self->path);
627 # The model has been processed or skipped (if is_applicable returned false),
628 # any exceptions have been handled, and there's no content in $self->output
629 sub __call_process_view
635 eval { $status = $self->view_object->process($self) };
637 if ( my $error = $@ )
639 $status = $self->call_exception($error, "view");
643 warn "caught view error: $error" if $self->debug;
644 return $self->debug ?
645 $self->view_object->error($self, $error) : ERROR;
654 You should only need to define this method if you are writing a new
655 Maypole backend. It should return something that looks like an Apache
656 or CGI request object, it defaults to blank.
664 Turns the backend request (e.g. Apache::MVC, Maypole, CGI) into a Maypole
665 request. It does this by setting the C<path>, and invoking C<parse_path> and
668 You should only need to define this method if you are writing a new Maypole
675 die "parse_location is a virtual method. Do not use Maypole directly; " .
676 "use Apache::MVC or similar";
679 =item start_request_hook
681 This is called immediately after setting up the basic request. The default
684 The value of C<< $r->status >> is set to C<OK> before this hook is run. Your
685 implementation can change the status code, or leave it alone.
687 After this hook has run, Maypole will check the value of C<status>. For any
688 value other than C<OK>, Maypole returns the C<status> immediately.
690 This is useful for filtering out requests for static files, e.g. images, which
691 should not be processed by Maypole or by the templating engine:
693 sub start_request_hook
697 $r->status(DECLINED) if $r->path =~ /\.jpg$/;
700 Multiple plugins, and the driver, can define this hook - Maypole will call all
701 of them. You should check for and probably not change any non-OK C<status>
704 package Maypole::Plugin::MyApp::SkipFavicon;
706 sub start_request_hook
710 # check if a previous plugin has already DECLINED this request
711 # - probably unnecessary in this example, but you get the idea
712 return unless $r->status == OK;
715 $r->status(DECLINED) if $r->path =~ /favicon\.ico/;
720 sub start_request_hook { }
724 B<This method is deprecated> as of version 2.11. If you have overridden it,
725 please override C<is_model_applicable> instead, and change the return type
726 from a Maypole:Constant to a true/false value.
728 Returns a Maypole::Constant to indicate whether the request is valid.
732 sub is_applicable { return shift->is_model_applicable(@_); }
734 =item is_model_applicable
736 Returns true or false to indicate whether the request is valid.
738 The default implementation checks that C<< $r->table >> is publicly
739 accessible and that the model class is configured to handle the
744 sub is_model_applicable {
747 # Establish which tables should be processed by the model
748 my $config = $self->config;
750 $config->ok_tables || $config->ok_tables( $config->display_tables );
752 $config->ok_tables( { map { $_ => 1 } @{ $config->ok_tables } } )
753 if ref $config->ok_tables eq "ARRAY";
755 my $ok_tables = $config->ok_tables;
757 # Does this request concern a table to be processed by the model?
758 my $table = $self->table;
762 if (exists $ok_tables->{$table})
769 warn "We don't have that table ($table).\n"
770 . "Available tables are: "
771 . join( ",", keys %$ok_tables )
772 if $self->debug and not $ok_tables->{$table};
777 # Is the action public?
778 my $action = $self->action;
779 return OK if $self->model_class->is_public($action);
781 warn "The action '$action' is not applicable to the table '$table'"
789 Called immediately after C<start_request_hook()>.
791 This method should return a session, which will be stored in the request's
792 C<session> attribute.
794 The default method is empty.
802 Called immediately after C<get_session>.
804 This method should return a user, which will be stored in the request's C<user>
807 The default method is empty.
813 =item call_authenticate
815 This method first checks if the relevant model class
816 can authenticate the user, or falls back to the default
817 authenticate method of your Maypole application.
821 sub call_authenticate
825 # Check if we have a model class with an authenticate() to delegate to
826 return $self->model_class->authenticate($self)
827 if $self->model_class and $self->model_class->can('authenticate');
829 # Interface consistency is a Good Thing -
830 # the invocant and the argument may one day be different things
831 # (i.e. controller and request), like they are when authenticate()
832 # is called on a model class (i.e. model and request)
833 return $self->authenticate($self);
838 Returns a Maypole::Constant to indicate whether the user is authenticated for
841 The default implementation returns C<OK>
845 sub authenticate { return OK }
850 This model is called to catch exceptions, first after authenticate, then after
851 processing the model class, and finally to check for exceptions from the view
854 This method first checks if the relevant model class
855 can handle exceptions the user, or falls back to the default
856 exception method of your Maypole application.
862 my ($self, $error, $when) = @_;
864 # Check if we have a model class with an exception() to delegate to
865 if ( $self->model_class && $self->model_class->can('exception') )
867 my $status = $self->model_class->exception( $self, $error, $when );
868 return $status if $status == OK;
871 return $self->exception($error, $when);
877 This method is called if any exceptions are raised during the authentication or
878 model/view processing. It should accept the exception as a parameter and return
879 a Maypole::Constant to indicate whether the request should continue to be
885 my ($self, $error, $when) = @_;
886 if ($self->view_object->can("report_error") and $self->debug) {
887 $self->view_object->report_error($self, $error, $when);
893 =item additional_data
895 Called before the model processes the request, this method gives you a chance to
896 do some processing for each request, for example, manipulating C<template_args>.
900 sub additional_data { }
904 Sends the output and additional headers to the user.
909 die "send_output is a virtual method. Do not use Maypole directly; use Apache::MVC or similar";
917 =head2 Path processing and manipulation
923 Returns the request path
927 Parses the request path and sets the C<args>, C<action> and C<table>
928 properties. Calls C<preprocess_path> before parsing path and setting properties.
936 # Previous versions unconditionally set table, action and args to whatever
937 # was in @pi (or else to defaults, if @pi is empty).
938 # Adding preprocess_path(), and then setting table, action and args
939 # conditionally, broke lots of tests, hence this:
940 $self->$_(undef) for qw/action table args/;
942 $self->preprocess_path;
943 $self->path || $self->path('frontpage');
945 my @pi = grep {length} split '/', $self->path;
948 $self->table || $self->table(shift @pi);
949 $self->action || $self->action( shift @pi or 'index' );
950 $self->args || $self->args(\@pi);
953 =item preprocess_path
955 Sometimes when you don't want to rewrite or over-ride parse_path but
956 want to rewrite urls or extract data from them before it is parsed.
958 This method is called after parse_location has populated the request
959 information and before parse_path has populated the model and action
960 information, and is passed the request object.
962 You can set action, args or table in this method and parse_path will
963 then leave those values in place or populate them if not present
967 sub preprocess_path { };
969 =item make_path( %args or \%args or @args )
971 This is the counterpart to C<parse_path>. It generates a path to use
972 in links, form actions etc. To implement your own path scheme, just override
973 this method and C<parse_path>.
975 %args = ( table => $table,
977 additional => $additional, # optional - generally an object ID
980 \%args = as above, but a ref
982 @args = ( $table, $action, $additional ); # $additional is optional
984 C<id> can be used as an alternative key to C<additional>.
986 C<$additional> can be a string, an arrayref, or a hashref. An arrayref is
987 expanded into extra path elements, whereas a hashref is translated into a query
998 if (@_ == 1 and ref $_[0] and ref $_[0] eq 'HASH')
1002 elsif ( @_ > 1 and @_ < 4 )
1004 $args{table} = shift;
1005 $args{action} = shift;
1006 $args{additional} = shift;
1013 do { die "no $_" unless $args{$_} } for qw( table action );
1015 my $additional = $args{additional} || $args{id};
1021 # if $additional is a href, make_uri() will transform it into a query
1022 @add = (ref $additional eq 'ARRAY') ? @$additional : ($additional);
1025 my $uri = $r->make_uri($args{table}, $args{action}, @add);
1027 return $uri->as_string;
1032 =item make_uri( @segments )
1034 Make a L<URI> object given table, action etc. Automatically adds
1037 If the final element in C<@segments> is a hash ref, C<make_uri> will render it
1044 my ($r, @segments) = @_;
1046 my $query = (ref $segments[-1] eq 'HASH') ? pop(@segments) : undef;
1048 my $base = $r->config->uri_base;
1051 my $uri = URI->new($base);
1052 $uri->path_segments($uri->path_segments, grep {length} @segments);
1054 my $abs_uri = $uri->abs('/');
1055 $abs_uri->query_form($query) if $query;
1061 Turns post data and query string paramaters into a hash of C<params>.
1063 You should only need to define this method if you are writing a new Maypole
1070 die "parse_args() is a virtual method. Do not use Maypole directly; ".
1071 "use Apache::MVC or similar";
1074 =item get_template_root
1076 Implementation-specific path to template root.
1078 You should only need to define this method if you are writing a new Maypole
1079 backend. Otherwise, see L<Maypole::Config/"template_root">
1083 sub get_template_root {'.'}
1087 =head2 Request properties
1093 Returns the perl package name that will serve as the model for the
1094 request. It corresponds to the request C<table> attribute.
1099 Get/set a list of model objects. The objects will be accessible in the view
1102 If the first item in C<$self-E<gt>args> can be C<retrieve()>d by the model
1103 class, it will be removed from C<args> and the retrieved object will be added to
1104 the C<objects> list. See L<Maypole::Model> for more information.
1108 $self->template_args->{foo} = 'bar';
1110 Get/set a hash of template variables.
1114 A place to put custom application data. Not used by Maypole itself.
1118 Get/set the template to be used by the view. By default, it returns
1119 C<$self-E<gt>action>
1124 Get/set a request error
1128 Get/set the response output. This is usually populated by the view class. You
1129 can skip view processing by setting the C<output>.
1133 The table part of the Maypole request path
1137 The action part of the Maypole request path
1141 A list of remaining parts of the request path after table and action
1147 A L<Maypole::Headers> object containing HTTP headers for the request
1151 A L<HTTP::Headers> object that contains HTTP headers for the output
1153 =item document_encoding
1155 Get/set the output encoding. Default: utf-8.
1159 Get/set the output content type. Default: text/html
1163 Returns the protocol the request was made with, i.e. https
1168 die "get_protocol is a virtual method. Do not use Maypole directly; use Apache::MVC or similar";
1173 =head2 Request parameters
1175 The source of the parameters may vary depending on the Maypole backend, but they
1176 are usually populated from request query string and POST data.
1178 Maypole supplies several approaches for accessing the request parameters. Note
1179 that the current implementation (via a hashref) of C<query> and C<params> is
1180 likely to change in a future version of Maypole. So avoid direct access to these
1183 $r->{params}->{foo} # bad
1184 $r->params->{foo} # better
1186 $r->{query}->{foo} # bad
1187 $r->query->{foo} # better
1189 $r->param('foo') # best
1195 An accessor (get or set) for request parameters. It behaves similarly to
1196 CGI::param() for accessing CGI parameters, i.e.
1198 $r->param # returns list of keys
1199 $r->param($key) # returns value for $key
1200 $r->param($key => $value) # returns old value, sets to new value
1206 my ($self, $key) = (shift, shift);
1208 return keys %{$self->params} unless defined $key;
1210 return unless exists $self->params->{$key};
1212 my $val = $self->params->{$key};
1216 my $new_val = shift;
1217 $self->params->{$key} = $new_val;
1220 return ref $val ? @$val : ($val) if wantarray;
1222 return ref $val ? $val->[0] : $val;
1228 Returns a hashref of request parameters.
1230 B<Note:> Where muliple values of a parameter were supplied, the C<params> value
1231 will be an array reference.
1235 Alias for C<params>.
1239 =head3 Utility methods
1243 =item redirect_request
1245 Sets output headers to redirect based on the arguments provided
1247 Accepts either a single argument of the full url to redirect to, or a hash of
1250 $r->redirect_request('http://www.example.com/path');
1254 $r->redirect_request(protocol=>'https', domain=>'www.example.com', path=>'/path/file?arguments', status=>'302', url=>'..');
1256 The named parameters are protocol, domain, path, status and url
1258 Only 1 named parameter is required but other than url, they can be combined as
1259 required and current values (from the request) will be used in place of any
1260 missing arguments. The url argument must be a full url including protocol and
1261 can only be combined with status.
1265 sub redirect_request {
1266 die "redirect_request is a virtual method. Do not use Maypole directly; use Apache::MVC or similar";
1269 =item redirect_internal_request
1273 sub redirect_internal_request {
1278 =item make_random_id
1280 returns a unique id for this request can be used to prevent or detect repeat
1285 # Session and Repeat Submission Handling
1286 sub make_random_id {
1287 use Maypole::Session;
1288 return Maypole::Session::generate_unique_id();
1293 =head1 SEQUENCE DIAGRAMS
1295 See L<Maypole::Manual::Workflow> for a detailed discussion of the sequence of
1296 calls during processing of a request. This is a brief summary:
1300 BeerDB Maypole::Model::CDBI
1304 || setup_model | setup_database() creates
1305 ||------+ | a subclass of the Model
1306 |||<----+ | for each table
1308 ||| setup_database | |
1309 |||--------------------->|| 'create' *
1310 ||| ||----------> $subclass
1312 ||| load_model_subclass | |
1313 foreach |||------+ ($subclass) | |
1314 $subclass ||||<----+ | require |
1315 ||||--------------------------------------->|
1317 ||| adopt($subclass) | |
1318 |||--------------------->|| |
1323 || | new | view_object: e.g.
1324 ||---------------------------------------------> Maypole::View::TT
1336 BeerDB Model $subclass view_object
1339 o-------->| new | | |
1340 |-----> r:BeerDB | | |
1344 | ||-----+ parse_location | | |
1347 | ||-----+ start_request_hook | | |
1350 | ||-----+ get_session | | |
1353 | ||-----+ get_user | | |
1356 | ||-----+ handler_guts | | |
1358 | ||| class_of($table) | | |
1359 | |||------------------------->|| | |
1360 | ||| $subclass || | |
1361 | |||<-------------------------|| | |
1363 | |||-----+ is_model_applicable| | |
1366 | |||-----+ call_authenticate | | |
1369 | |||-----+ additional_data | | |
1372 | |||--------------------------------->|| fetch_objects
1380 | |||------------------------------------------->|| template
1384 | || send_output | | |
1388 <------------------|| | | |
1399 There's more documentation, examples, and information on our mailing lists
1400 at the Maypole web site:
1402 L<http://maypole.perl.org/>
1404 L<Maypole::Application>, L<Apache::MVC>, L<CGI::Maypole>.
1408 Maypole is currently maintained by Aaron Trevena, David Baird, Dave Howorth and
1411 =head1 AUTHOR EMERITUS
1413 Simon Cozens, C<simon#cpan.org>
1415 Simon Flack maintained Maypole from 2.05 to 2.09
1417 Sebastian Riedel, C<sri#oook.de> maintained Maypole from 1.99_01 to 2.04
1421 Sebastian Riedel, Danijel Milicevic, Dave Slack, Jesse Sheidlower, Jody Belka,
1422 Marcus Ramberg, Mickael Joanne, Randal Schwartz, Simon Flack, Steve Simms,
1423 Veljko Vidovic and all the others who've helped.
1427 You may distribute this code under the same terms as Perl itself.
1435 =item register_cleanup($coderef)
1437 Analogous to L<Apache>'s C<register_cleanup>. If an Apache request object is
1438 available, this call simply redispatches there. If not, the cleanup is
1439 registered in the Maypole request, and executed when the request is
1442 This method is only useful in persistent environments, where you need to ensure
1443 that some code runs when the request finishes, no matter how it finishes (e.g.
1444 after an unexpected error).
1451 sub register_cleanup
1453 my ($self, $cleanup) = @_;
1455 die "register_cleanup() is an instance method, not a class method"
1457 die "Cleanup must be a coderef" unless ref($cleanup) eq 'CODE';
1459 if ($self->can('ar') && $self->ar)
1461 $self->ar->register_cleanup($cleanup);
1465 push @_cleanups, $cleanup;
1473 while (my $cleanup = shift @_cleanups)
1475 eval { $cleanup->() };
1478 warn "Error during request cleanup: $@";