3 use base qw(Class::Accessor::Fast Class::Data::Inheritable);
4 use UNIVERSAL::require;
9 use Maypole::Constants;
14 use File::MMagic::XS qw(:compat);
16 our $VERSION = '2.12';
17 our $mmagic = File::MMagic::XS->new();
19 # proposed privacy conventions:
20 # - no leading underscore - public to custom application code and plugins
21 # - single leading underscore - private to the main Maypole stack - *not*
23 # - double leading underscore - private to the current package
27 Maypole - MVC web application framework
31 The canonical example used in the Maypole documentation is the beer database:
37 # choose a frontend, initialise the config object, and load a plugin
38 use Maypole::Application qw/Relationship/;
41 __PACKAGE__->setup("dbi:SQLite:t/beerdb.db");
43 # get the empty config object created by Maypole::Application
44 my $config = __PACKAGE__->config;
47 $config->uri_base("http://localhost/beerdb");
48 $config->template_root("/path/to/templates");
49 $config->rows_per_page(10);
50 $config->display_tables([qw/beer brewery pub style/]);
53 $config->relationships([
54 "a brewery produces beers",
55 "a style defines beers",
56 "a pub has beers on handpumps",
60 BeerDB::Brewery->untaint_columns( printable => [qw/name notes url/] );
61 BeerDB::Pub->untaint_columns( printable => [qw/name notes url/] );
62 BeerDB::Style->untaint_columns( printable => [qw/name notes/] );
63 BeerDB::Beer->untaint_columns(
64 printable => [qw/abv name price notes/],
65 integer => [qw/style brewery score/],
69 # note : set up model before calling this method
70 BeerDB::Beer->required_columns([qw/name/]);
76 This documents the Maypole request object. See the L<Maypole::Manual>, for a
77 detailed guide to using Maypole.
79 Maypole is a Perl web application framework similar to Java's struts. It is
80 essentially completely abstracted, and so doesn't know anything about
81 how to talk to the outside world.
83 To use it, you need to create a driver package which represents your entire
84 application. This is the C<BeerDB> package used as an example in the manual.
86 This needs to first use L<Maypole::Application> which will make your package
87 inherit from the appropriate platform driver such as C<Apache::MVC> or
88 C<CGI::Maypole>. Then, the driver calls C<setup>. This sets up the model classes
89 and configures your application. The default model class for Maypole uses
90 L<Class::DBI> to map a database to classes, but this can be changed by altering
91 configuration (B<before> calling setup.)
94 =head1 DOCUMENTATION AND SUPPORT
96 Note that some details in some of these resources may be out of date.
100 =item The Maypole Manual
102 The primary documentation is the Maypole manual. This lives in the
103 C<Maypole::Manual> pod documents included with the distribution.
107 Individual packages within the distribution contain (more or less) detailed
108 reference documentation for their API.
112 There are two mailing lists - maypole-devel and maypole-users - see
113 http://maypole.perl.org/?MailingList
115 =item The Maypole Wiki
117 The Maypole wiki provides a useful store of extra documentation -
118 http://maypole.perl.org
120 In particular, there's a FAQ (http://maypole.perl.org/?FAQ) and a cookbook
121 (http://maypole.perl.org/?Cookbook). Again, certain information on these pages
124 =item Web applications with Maypole
126 A tutorial written by Simon Cozens for YAPC::EU 2005 -
127 http://www.aarontrevena.co.uk/opensource/maypole/maypole-tutorial.pdf [228KB].
129 =item A Database-Driven Web Application in 18 Lines of Code
131 By Paul Barry, published in Linux Journal, March 2005.
133 http://www.linuxjournal.com/article/7937
135 "From zero to Web-based database application in eight easy steps".
137 Maypole won a 2005 Linux Journal Editor's Choice Award
138 (http://www.linuxjournal.com/article/8293) after featuring in this article.
140 =item Build Web apps with Maypole
142 By Simon Cozens, on IBM's DeveloperWorks website, May 2004.
144 http://www-128.ibm.com/developerworks/linux/library/l-maypole/
146 =item Rapid Web Application Deployment with Maypole
148 By Simon Cozens, on O'Reilly's Perl website, April 2004.
150 http://www.perl.com/pub/a/2004/04/15/maypole.html
154 Some notes written by Simon Cozens. A little bit out of date, but still
155 very useful: http://www.aarontrevena.co.uk/opensource/maypole/authentication.html
159 There's a refcard for the Maypole (and Class::DBI) APIs on the wiki -
160 http://maypole.perl.org/?CheatSheet. Probably a little out of date now - it's a
161 wiki, so feel free to fix any errors!
163 =item Plugins and add-ons
165 There are a large and growing number of plugins and other add-on modules
166 available on CPAN - http://search.cpan.org/search?query=maypole&mode=module
170 You can find a range of useful Maypole links, particularly to several thoughtful
171 blog entries, starting here: http://del.icio.us/search/?all=maypole
175 There are a couple of short reviews here:
176 http://cpanratings.perl.org/dist/Maypole
182 __PACKAGE__->mk_classdata($_) for qw( config init_done view_object model_classes_loaded);
184 __PACKAGE__->mk_accessors(
185 qw( params query objects model_class template_args output path
186 args action template error document_encoding content_type table
187 headers_in headers_out stash status parent build_form_elements)
190 __PACKAGE__->config( Maypole::Config->new() );
192 __PACKAGE__->init_done(0);
194 __PACKAGE__->model_classes_loaded(0);
196 =head1 HOOKABLE METHODS
198 As a framework, Maypole provides a number of B<hooks> - methods that are
199 intended to be overridden. Some of these methods come with useful default
200 behaviour, others do nothing by default. Hooks include:
226 sub My::App::debug {1}
228 Returns the debugging flag. Override this in your application class to
229 enable/disable debugging.
231 You can also set the C<debug> flag via L<Maypole::Application>.
233 Some packages respond to higher debug levels, try increasing it to 2 or 3.
242 Returns the L<Maypole::Config> object
246 My::App->setup($data_source, $user, $password, \%attr);
248 Initialise the Maypole application and plugins and model classes.
249 Your application should call this B<after> setting up configuration data via
252 It calls the hook C<setup_model> to setup the model. The %attr hash contains
253 options and arguments used to set up the model. See the particular model's
254 documentation. However here is the most usage of setup where
255 Maypole::Model::CDBI is the base class.
257 My::App->setup($data_source, $user, $password,
258 { options => { # These are DB connection options
263 # These are Class::DBI::Loader arguments.
269 Also, see L<Maypole::Manual::Plugins>.
278 $class->setup_model(@_);
283 Called by C<setup>. This method builds the Maypole model hierarchy.
285 A likely target for over-riding, if you need to build a customised model.
287 This method also ensures any code in custom model classes is loaded, so you
288 don't need to load them in the driver.
294 $class = ref $class if ref $class;
295 my $config = $class->config;
296 $config->model || $config->model('Maypole::Model::CDBI');
297 $config->model->require or die sprintf
298 "Couldn't load the model class %s: %s", $config->model, $@;
300 # among other things, this populates $config->classes
301 $config->model->setup_database($config, $class, @_);
303 $config->model->add_model_superclass($config);
305 # Load custom model code, if it exists - nb this must happen after the
306 # adding the model superclass, to allow code attributes to work, but before adopt(),
307 # in case adopt() calls overridden methods on $subclass
308 foreach my $subclass ( @{ $config->classes } ) {
309 $class->load_model_subclass($subclass) unless ($class->model_classes_loaded());
310 $config->model->adopt($subclass) if $config->model->can("adopt");
315 =item load_model_subclass($subclass)
317 This method is called from C<setup_model()>. It attempts to load the
318 C<$subclass> package, if one exists. So if you make a customized C<BeerDB::Beer>
319 package, you don't need to explicitly load it.
321 If automatic loading causes problems, Override load_model_subclass in your driver.
323 sub load_model_subclass {};
325 Or perhaps during development, if you don't want to load up custom classes, you
326 can override this method and load them manually.
330 sub load_model_subclass {
331 my ($class, $subclass) = @_;
333 my $config = $class->config;
335 # Load any external files for the model base class or subclasses
336 # (e.g. BeerDB/DBI.pm or BeerDB/Beer.pm) based on code borrowed from
337 # Maypole::Plugin::Loader and Class::DBI.
338 if ( $subclass->require ) {
339 warn "Loaded external module for '$subclass'\n" if $class->debug > 1;
341 (my $filename = $subclass) =~ s!::!/!g;
342 die "Loading '$subclass' failed: $@\n"
343 unless $@ =~ /Can\'t locate \Q$filename\E\.pm/;
344 warn "No external module for '$subclass'"
345 if $class->debug > 1;
351 Loads the view class and instantiates the view object.
353 You should not call this directly, but you may wish to override this to add
354 application-specific initialisation - see L<Maypole::Manual::Plugins>.
361 my $config = $class->config;
362 $config->view || $config->view("Maypole::View::TT");
363 $config->view->require;
364 die "Couldn't load the view class " . $config->view . ": $@" if $@;
365 $config->display_tables
366 || $config->display_tables( $class->config->tables );
367 $class->view_object( $class->config->view->new );
368 $class->init_done(1);
373 Constructs a very minimal new Maypole request object.
381 config => $class->config,
387 $self->template_args({});
395 Get/set the Maypole::View object
399 =head1 INSTANCE METHODS
407 This method sets up the class if it's not done yet, sets some defaults and
408 leaves the dirty work to C<handler_guts>.
412 # handler() has a method attribute so that mod_perl will invoke
413 # BeerDB->handler() as a method rather than a plain function
414 # BeerDB::handler() and so this inherited implementation will be
415 # found. See e.g. "Practical mod_perl" by Bekman & Cholet for
416 # more information <http://modperlbook.org/html/ch25_01.html>
417 sub handler : method {
418 # See Maypole::Workflow before trying to understand this.
419 my ($class, $req) = @_;
421 $class->init unless $class->init_done;
423 my $self = $class->new;
425 # initialise the request
426 $self->headers_out(Maypole::Headers->new);
427 $self->get_request($req);
429 $self->parse_location;
431 # hook useful for declining static requests e.g. images, or perhaps for
432 # sanitizing request parameters
433 $self->status(Maypole::Constants::OK()); # set the default
434 $self->__call_hook('start_request_hook');
435 return $self->status unless $self->status == Maypole::Constants::OK();
436 die "status undefined after start_request_hook()" unless defined
440 my $status = $self->handler_guts;
441 return $status unless $status == OK;
442 # TODO: require send_output to return a status code
449 Run Maypole sub-requests as a component of the request
451 [% request.component("/beer/view_as_component/20") %]
453 Allows you to integrate the results of a Maypole request into an existing
454 request. You'll need to set up actions and templates
455 which return fragments of HTML rather than entire pages, but once you've
456 done that, you can use the C<component> method of the Maypole request object
457 to call those actions. You may pass a query string in the usual URL style.
459 You should not fully qualify the Maypole URLs.
461 Note: any HTTP POST or URL parameters passed to the parent are not passed to the
462 component sub-request, only what is included in the url passed as an argyument
468 my ( $r, $path ) = @_;
469 my $self = bless { parent => $r, config => $r->{config}, } , ref $r;
473 $self->template_args({});
478 my $url = URI->new($path);
479 $self->{path} = $url->path;
481 $self->params( $url->query_form_hash );
483 return $self->output;
486 sub get_template_root {
489 return $r->parent->get_template_root if $r->{parent};
490 return $self->NEXT::DISTINCT::get_template_root( $r, @_ );
496 return $r->parent->view_object if $r->{parent};
497 return $self->NEXT::DISTINCT::view_object( $r, @_ );
500 # Instead of making plugin authors use the NEXT::DISTINCT hoopla to ensure other
501 # plugins also get to call the hook, we can cycle through the application's
502 # @ISA and call them all here. Doesn't work for setup() though, because it's
503 # too ingrained in the stack. We could add a run_setup() method, but we'd break
504 # lots of existing code.
507 my ($self, $hook) = @_;
511 my $class = ref($self);
513 @plugins = @{"$class\::ISA"};
516 # this is either a custom method in the driver, or the method in the 1st
517 # plugin, or the 'null' method in the frontend (i.e. inherited from
518 # Maypole.pm) - we need to be careful to only call it once
519 my $first_hook = $self->can($hook);
522 my %seen = ( $first_hook => 1 );
524 # @plugins includes the frontend
525 foreach my $plugin (@plugins)
527 next unless my $plugin_hook = $plugin->can($hook);
528 next if $seen{$plugin_hook}++;
535 This is the main request handling method and calls various methods to handle the
536 request/response and defines the workflow within Maypole.
540 # The root of all evil
543 $self->build_form_elements(1) unless (defined ($self->config->build_form_elements) && $self->config->build_form_elements == 0);
544 $self->__load_request_model;
546 my $applicable = $self->is_model_applicable == OK;
550 # handle authentication
551 eval { $status = $self->call_authenticate };
552 if ( my $error = $@ ) {
553 $status = $self->call_exception($error, "authentication");
554 if ( $status != OK ) {
555 $self->warn("caught authenticate error: $error");
556 return $self->debug ?
557 $self->view_object->error($self, $error) : ERROR;
560 if ( $self->debug and $status != OK and $status != DECLINED ) {
561 $self->view_object->error( $self,
562 "Got unexpected status $status from calling authentication" );
565 return $status unless $status == OK;
567 # We run additional_data for every request
568 $self->additional_data;
571 eval { $self->model_class->process($self) };
572 if ( my $error = $@ ) {
573 $status = $self->call_exception($error, "model");
574 if ( $status != OK ) {
575 $self->warn("caught model error: $error");
576 return $self->debug ?
577 $self->view_object->error($self, $error) : ERROR;
581 $self->__setup_plain_template;
584 # less frequent path - perhaps output has been set to an error message
586 $self->{content_type} ||= $self->__get_mime_type();
587 $self->{document_encoding} ||= "utf-8";
591 # normal path - no output has been generated yet
592 my $processed_view_ok = $self->__call_process_view;
594 $self->{content_type} ||= $self->__get_mime_type();
595 $self->{document_encoding} ||= "utf-8";
597 return $processed_view_ok;
601 'js' => 'text/javascript',
603 'htm' => 'text/html',
604 'html' => 'text/html',
607 sub __get_mime_type {
609 my $type = 'text/html';
610 if ($self->path =~ m/.*\.(\w{3,4})$/) {
611 $type = $filetypes{$1};
613 my $output = $self->output;
614 if (defined $output) {
615 $type = $mmagic->checktype_contents($output);
621 sub __load_request_model
624 # We may get a made up class from class_of
625 my $mclass = $self->config->model->class_of($self, $self->table);
626 if ( eval {$mclass->isa('Maypole::Model::Base')} ) {
627 $self->model_class( $mclass );
629 elsif ($self->debug > 1) {
630 $self->warn("***Warning: No $mclass class appropriate for model. @_");
635 # is_applicable() returned false, so set up a plain template. Model processing
636 # will be skipped, but need to remove the model anyway so the template can't
638 sub __setup_plain_template
642 # It's just a plain template
643 $self->build_form_elements(0);
644 $self->model_class(undef);
646 unless ($self->template) {
647 # FIXME: this is likely to be redundant and is definately causing problems.
648 my $path = $self->path;
649 $path =~ s{/$}{}; # De-absolutify
651 $self->template($self->path);
655 # The model has been processed or skipped (if is_applicable returned false),
656 # any exceptions have been handled, and there's no content in $self->output
657 sub __call_process_view {
660 my $status = eval { $self->view_object->process($self) };
662 my $error = $@ || $self->{error};
665 $status = $self->call_exception($error, "view");
667 if ( $status != OK ) {
668 warn "caught view error: $error" if $self->debug;
669 return $self->debug ?
670 $self->view_object->error($self, $error) : ERROR;
679 $r->warn('its all gone pete tong');
681 Warn must be implemented by the backend, i.e. Apache::MVC
682 and warn to stderr or appropriate logfile.
684 You can also over-ride this in your Maypole driver, should you
685 want to use something like Log::Log4perl instead.
691 =item build_form_elements
693 $r->build_form_elements(0);
695 Specify (in an action) whether to build HTML form elements and populate
696 the cgi element of classmetadata in the view.
698 You can set this globally using the accessor of the same name in Maypole::Config,
699 this method allows you to over-ride that setting per action.
705 You should only need to define this method if you are writing a new
706 Maypole backend. It should return something that looks like an Apache
707 or CGI request object, it defaults to blank.
715 Turns the backend request (e.g. Apache::MVC, Maypole, CGI) into a Maypole
716 request. It does this by setting the C<path>, and invoking C<parse_path> and
719 You should only need to define this method if you are writing a new Maypole
726 die "parse_location is a virtual method. Do not use Maypole directly; " .
727 "use Apache::MVC or similar";
730 =item start_request_hook
732 This is called immediately after setting up the basic request. The default
735 The value of C<< $r->status >> is set to C<OK> before this hook is run. Your
736 implementation can change the status code, or leave it alone.
738 After this hook has run, Maypole will check the value of C<status>. For any
739 value other than C<OK>, Maypole returns the C<status> immediately.
741 This is useful for filtering out requests for static files, e.g. images, which
742 should not be processed by Maypole or by the templating engine:
744 sub start_request_hook
748 $r->status(DECLINED) if $r->path =~ /\.jpg$/;
751 Multiple plugins, and the driver, can define this hook - Maypole will call all
752 of them. You should check for and probably not change any non-OK C<status>
755 package Maypole::Plugin::MyApp::SkipFavicon;
757 sub start_request_hook
761 # check if a previous plugin has already DECLINED this request
762 # - probably unnecessary in this example, but you get the idea
763 return unless $r->status == OK;
766 $r->status(DECLINED) if $r->path =~ /favicon\.ico/;
771 sub start_request_hook { }
775 B<This method is deprecated> as of version 2.11. If you have overridden it,
776 please override C<is_model_applicable> instead, and change the return type
777 from a Maypole:Constant to a true/false value.
779 Returns a Maypole::Constant to indicate whether the request is valid.
783 sub is_applicable { return shift->is_model_applicable(@_); }
785 =item is_model_applicable
787 Returns true or false to indicate whether the request is valid.
789 The default implementation checks that C<< $r->table >> is publicly
790 accessible and that the model class is configured to handle the
795 sub is_model_applicable {
798 # Establish which tables should be processed by the model
799 my $config = $self->config;
801 $config->ok_tables || $config->ok_tables( $config->display_tables );
803 $config->ok_tables( { map { $_ => 1 } @{ $config->ok_tables } } )
804 if ref $config->ok_tables eq "ARRAY";
806 my $ok_tables = $config->ok_tables;
808 # Does this request concern a table to be processed by the model?
809 my $table = $self->table;
813 if (exists $ok_tables->{$table})
820 $self->warn ("We don't have that table ($table).\n"
821 . "Available tables are: "
822 . join( ",", keys %$ok_tables ))
823 if $self->debug and not $ok_tables->{$table};
828 # Is the action public?
829 my $action = $self->action;
830 return OK if $self->model_class->is_public($action);
832 $self->warn("The action '$action' is not applicable to the table '$table'")
840 Called immediately after C<start_request_hook()>.
842 This method should return a session, which will be stored in the request's
843 C<session> attribute.
845 The default method is empty.
853 Called immediately after C<get_session>.
855 This method should return a user, which will be stored in the request's C<user>
858 The default method is empty.
864 =item call_authenticate
866 This method first checks if the relevant model class
867 can authenticate the user, or falls back to the default
868 authenticate method of your Maypole application.
872 sub call_authenticate
876 # Check if we have a model class with an authenticate() to delegate to
877 return $self->model_class->authenticate($self)
878 if $self->model_class and $self->model_class->can('authenticate');
880 # Interface consistency is a Good Thing -
881 # the invocant and the argument may one day be different things
882 # (i.e. controller and request), like they are when authenticate()
883 # is called on a model class (i.e. model and request)
884 return $self->authenticate($self);
889 Returns a Maypole::Constant to indicate whether the user is authenticated for
892 The default implementation returns C<OK>
896 sub authenticate { return OK }
901 This model is called to catch exceptions, first after authenticate, then after
902 processing the model class, and finally to check for exceptions from the view
905 This method first checks if the relevant model class
906 can handle exceptions the user, or falls back to the default
907 exception method of your Maypole application.
913 my ($self, $error, $when) = @_;
915 # Check if we have a model class with an exception() to delegate to
916 if ( $self->model_class && $self->model_class->can('exception') )
918 my $status = $self->model_class->exception( $self, $error, $when );
919 return $status if $status == OK;
922 return $self->exception($error, $when);
928 This method is called if any exceptions are raised during the authentication or
929 model/view processing. It should accept the exception as a parameter and return
930 a Maypole::Constant to indicate whether the request should continue to be
936 my ($self, $error, $when) = @_;
937 if (ref $self->view_object && $self->view_object->can("report_error") and $self->debug) {
938 $self->view_object->report_error($self, $error, $when);
944 =item additional_data
946 Called before the model processes the request, this method gives you a chance to
947 do some processing for each request, for example, manipulating C<template_args>.
951 sub additional_data { }
955 Sends the output and additional headers to the user.
960 die "send_output is a virtual method. Do not use Maypole directly; use Apache::MVC or similar";
966 =head2 Path processing and manipulation
972 Returns the request path
976 Parses the request path and sets the C<args>, C<action> and C<table>
977 properties. Calls C<preprocess_path> before parsing path and setting properties.
985 # Previous versions unconditionally set table, action and args to whatever
986 # was in @pi (or else to defaults, if @pi is empty).
987 # Adding preprocess_path(), and then setting table, action and args
988 # conditionally, broke lots of tests, hence this:
989 $self->$_(undef) for qw/action table args/;
990 $self->preprocess_path;
992 # use frontpage template for frontpage
993 unless ($self->path && $self->path ne '/') {
994 $self->path('frontpage');
997 my @pi = grep {length} split '/', $self->path;
999 $self->table || $self->table(shift @pi);
1000 $self->action || $self->action( shift @pi or 'index' );
1001 $self->args || $self->args(\@pi);
1004 =item preprocess_path
1006 Sometimes when you don't want to rewrite or over-ride parse_path but
1007 want to rewrite urls or extract data from them before it is parsed.
1009 This method is called after parse_location has populated the request
1010 information and before parse_path has populated the model and action
1011 information, and is passed the request object.
1013 You can set action, args or table in this method and parse_path will
1014 then leave those values in place or populate them if not present
1018 sub preprocess_path { };
1020 =item make_path( %args or \%args or @args )
1022 This is the counterpart to C<parse_path>. It generates a path to use
1023 in links, form actions etc. To implement your own path scheme, just override
1024 this method and C<parse_path>.
1026 %args = ( table => $table,
1028 additional => $additional, # optional - generally an object ID
1031 \%args = as above, but a ref
1033 @args = ( $table, $action, $additional ); # $additional is optional
1035 C<id> can be used as an alternative key to C<additional>.
1037 C<$additional> can be a string, an arrayref, or a hashref. An arrayref is
1038 expanded into extra path elements, whereas a hashref is translated into a query
1049 if (@_ == 1 and ref $_[0] and ref $_[0] eq 'HASH')
1053 elsif ( @_ > 1 and @_ < 4 )
1055 $args{table} = shift;
1056 $args{action} = shift;
1057 $args{additional} = shift;
1064 do { die "no $_" unless $args{$_} } for qw( table action );
1066 my $additional = $args{additional} || $args{id};
1072 # if $additional is a href, make_uri() will transform it into a query
1073 @add = (ref $additional eq 'ARRAY') ? @$additional : ($additional);
1076 my $uri = $r->make_uri($args{table}, $args{action}, @add);
1078 return $uri->as_string;
1083 =item make_uri( @segments )
1085 Make a L<URI> object given table, action etc. Automatically adds
1088 If the final element in C<@segments> is a hash ref, C<make_uri> will render it
1095 my ($r, @segments) = @_;
1097 my $query = (ref $segments[-1] eq 'HASH') ? pop(@segments) : undef;
1099 my $base = $r->config->uri_base;
1102 my $uri = URI->new($base);
1103 $uri->path_segments($uri->path_segments, grep {length} @segments);
1105 my $abs_uri = $uri->abs('/');
1106 $abs_uri->query_form($query) if $query;
1112 Turns post data and query string paramaters into a hash of C<params>.
1114 You should only need to define this method if you are writing a new Maypole
1121 die "parse_args() is a virtual method. Do not use Maypole directly; ".
1122 "use Apache::MVC or similar";
1125 =item get_template_root
1127 Implementation-specific path to template root.
1129 You should only need to define this method if you are writing a new Maypole
1130 backend. Otherwise, see L<Maypole::Config/"template_root">
1136 =head2 Request properties
1142 Returns the perl package name that will serve as the model for the
1143 request. It corresponds to the request C<table> attribute.
1148 Get/set a list of model objects. The objects will be accessible in the view
1151 If the first item in C<$self-E<gt>args> can be C<retrieve()>d by the model
1152 class, it will be removed from C<args> and the retrieved object will be added to
1153 the C<objects> list. See L<Maypole::Model> for more information.
1158 Alias to get/set the first/only model object. The object will be accessible
1159 in the view templates.
1161 When used to set the object, will overwrite the request objects
1162 with a single object.
1167 my ($r,$object) = @_;
1168 $r->objects([$object]) if ($object);
1169 return undef unless $r->objects();
1170 return $r->objects->[0];
1175 $self->template_args->{foo} = 'bar';
1177 Get/set a hash of template variables.
1179 Maypole reserved words for template variables will over-ride values in template_variables.
1181 Reserved words are : r, request, object, objects, base, config and errors, as well as the
1182 current class or object name.
1186 A place to put custom application data. Not used by Maypole itself.
1190 Get/set the template to be used by the view. By default, it returns
1191 C<$self-E<gt>action>
1196 Get/set a request error
1200 Get/set the response output. This is usually populated by the view class. You
1201 can skip view processing by setting the C<output>.
1205 The table part of the Maypole request path
1209 The action part of the Maypole request path
1213 A list of remaining parts of the request path after table and action
1219 A L<Maypole::Headers> object containing HTTP headers for the request
1223 A L<HTTP::Headers> object that contains HTTP headers for the output
1225 =item document_encoding
1227 Get/set the output encoding. Default: utf-8.
1231 Get/set the output content type. Default: text/html
1235 Returns the protocol the request was made with, i.e. https
1240 die "get_protocol is a virtual method. Do not use Maypole directly; use Apache::MVC or similar";
1245 =head2 Request parameters
1247 The source of the parameters may vary depending on the Maypole backend, but they
1248 are usually populated from request query string and POST data.
1250 Maypole supplies several approaches for accessing the request parameters. Note
1251 that the current implementation (via a hashref) of C<query> and C<params> is
1252 likely to change in a future version of Maypole. So avoid direct access to these
1255 $r->{params}->{foo} # bad
1256 $r->params->{foo} # better
1258 $r->{query}->{foo} # bad
1259 $r->query->{foo} # better
1261 $r->param('foo') # best
1267 An accessor (get or set) for request parameters. It behaves similarly to
1268 CGI::param() for accessing CGI parameters, i.e.
1270 $r->param # returns list of keys
1271 $r->param($key) # returns value for $key
1272 $r->param($key => $value) # returns old value, sets to new value
1278 my ($self, $key) = (shift, shift);
1280 return keys %{$self->params} unless defined $key;
1282 return unless exists $self->params->{$key};
1284 my $val = $self->params->{$key};
1288 my $new_val = shift;
1289 $self->params->{$key} = $new_val;
1292 return ref $val ? @$val : ($val) if wantarray;
1294 return ref $val ? $val->[0] : $val;
1300 Returns a hashref of request parameters.
1302 B<Note:> Where muliple values of a parameter were supplied, the C<params> value
1303 will be an array reference.
1307 Alias for C<params>.
1311 =head3 Utility methods
1315 =item redirect_request
1317 Sets output headers to redirect based on the arguments provided
1319 Accepts either a single argument of the full url to redirect to, or a hash of
1322 $r->redirect_request('http://www.example.com/path');
1326 $r->redirect_request(protocol=>'https', domain=>'www.example.com', path=>'/path/file?arguments', status=>'302', url=>'..');
1328 The named parameters are protocol, domain, path, status and url
1330 Only 1 named parameter is required but other than url, they can be combined as
1331 required and current values (from the request) will be used in place of any
1332 missing arguments. The url argument must be a full url including protocol and
1333 can only be combined with status.
1337 sub redirect_request {
1338 die "redirect_request is a virtual method. Do not use Maypole directly; use Apache::MVC or similar";
1341 # =item redirect_internal_request
1345 # sub redirect_internal_request {
1350 =item make_random_id
1352 returns a unique id for this request can be used to prevent or detect repeat
1357 # Session and Repeat Submission Handling
1358 sub make_random_id {
1359 use Maypole::Session;
1360 return Maypole::Session::generate_unique_id();
1365 =head1 SEQUENCE DIAGRAMS
1367 See L<Maypole::Manual::Workflow> for a detailed discussion of the sequence of
1368 calls during processing of a request. This is a brief summary:
1372 BeerDB Maypole::Model::CDBI
1376 || setup_model | setup_database() creates
1377 ||------+ | a subclass of the Model
1378 |||<----+ | for each table
1380 ||| setup_database | |
1381 |||--------------------->|| 'create' *
1382 ||| ||----------> $subclass
1384 ||| load_model_subclass | |
1385 foreach |||------+ ($subclass) | |
1386 $subclass ||||<----+ | require |
1387 ||||--------------------------------------->|
1389 ||| adopt($subclass) | |
1390 |||--------------------->|| |
1395 || | new | view_object: e.g.
1396 ||---------------------------------------------> Maypole::View::TT
1408 BeerDB Model $subclass view_object
1411 o-------->| new | | |
1412 |-----> r:BeerDB | | |
1416 | ||-----+ parse_location | | |
1419 | ||-----+ start_request_hook | | |
1422 | ||-----+ get_session | | |
1425 | ||-----+ get_user | | |
1428 | ||-----+ handler_guts | | |
1430 | ||| class_of($table) | | |
1431 | |||------------------------->|| | |
1432 | ||| $subclass || | |
1433 | |||<-------------------------|| | |
1435 | |||-----+ is_model_applicable| | |
1438 | |||-----+ call_authenticate | | |
1441 | |||-----+ additional_data | | |
1444 | |||--------------------------------->|| fetch_objects
1452 | |||------------------------------------------->|| template
1456 | || send_output | | |
1460 <------------------|| | | |
1471 There's more documentation, examples, and information on our mailing lists
1472 at the Maypole web site:
1474 L<http://maypole.perl.org/>
1476 L<Maypole::Application>, L<Apache::MVC>, L<CGI::Maypole>.
1480 Maypole is currently maintained by Aaron Trevena.
1482 =head1 AUTHOR EMERITUS
1484 Simon Cozens, C<simon#cpan.org>
1486 Simon Flack maintained Maypole from 2.05 to 2.09
1488 Sebastian Riedel, C<sri#oook.de> maintained Maypole from 1.99_01 to 2.04
1492 Sebastian Riedel, Danijel Milicevic, Dave Slack, Jesse Sheidlower, Jody Belka,
1493 Marcus Ramberg, Mickael Joanne, Randal Schwartz, Simon Flack, Steve Simms,
1494 Veljko Vidovic and all the others who've helped.
1498 You may distribute this code under the same terms as Perl itself.
1506 =item register_cleanup($coderef)
1508 Analogous to L<Apache>'s C<register_cleanup>. If an Apache request object is
1509 available, this call simply redispatches there. If not, the cleanup is
1510 registered in the Maypole request, and executed when the request is
1513 This method is only useful in persistent environments, where you need to ensure
1514 that some code runs when the request finishes, no matter how it finishes (e.g.
1515 after an unexpected error).
1522 sub register_cleanup
1524 my ($self, $cleanup) = @_;
1526 die "register_cleanup() is an instance method, not a class method"
1528 die "Cleanup must be a coderef" unless ref($cleanup) eq 'CODE';
1530 if ($self->can('ar') && $self->ar)
1532 $self->ar->register_cleanup($cleanup);
1536 push @_cleanups, $cleanup;
1544 while (my $cleanup = shift @_cleanups)
1546 eval { $cleanup->() };
1549 warn "Error during request cleanup: $@";