2 use base qw(Class::Accessor::Fast Class::Data::Inheritable);
3 use UNIVERSAL::require;
7 use Maypole::Constants;
11 our $VERSION = '2.11';
13 # proposed privacy conventions:
14 # - no leading underscore - public to custom application code and plugins
15 # - single leading underscore - private to the main Maypole stack - *not*
17 # - double leading underscore - private to the current package
19 __PACKAGE__->mk_classdata($_) for qw( config init_done view_object );
20 __PACKAGE__->mk_accessors(
21 qw( params query objects model_class template_args output path
22 args action template error document_encoding content_type table
23 headers_in headers_out stash session)
25 __PACKAGE__->config( Maypole::Config->new() );
26 __PACKAGE__->init_done(0);
32 my $calling_class = shift;
34 $calling_class = ref $calling_class if ref $calling_class;
36 my $config = $calling_class->config;
38 $config->model || $config->model('Maypole::Model::CDBI');
40 $config->model->require or die sprintf
41 "Couldn't load the model class %s: %s", $config->model, $@;
43 $config->model->setup_database($config, $calling_class, @_);
45 foreach my $subclass ( @{ $config->classes } )
48 unshift @{ $subclass . "::ISA" }, $config->model;
49 $config->model->adopt($subclass)
50 if $config->model->can("adopt");
57 my $config = $class->config;
58 $config->view || $config->view("Maypole::View::TT");
59 $config->view->require;
60 die "Couldn't load the view class " . $config->view . ": $@" if $@;
61 $config->display_tables
62 || $config->display_tables( $class->config->tables );
63 $class->view_object( $class->config->view->new );
74 config => $class->config,
80 # handler() has a method attribute so that mod_perl will invoke
81 # BeerDB->handler() as a method rather than a plain function
82 # BeerDB::handler() and so this inherited implementation will be
83 # found. See e.g. "Practical mod_perl" by Bekman & Cholet for
84 # more information <http://modperlbook.org/html/ch25_01.html>
87 # See Maypole::Workflow before trying to understand this.
88 my ($class, $req) = @_;
90 $class->init unless $class->init_done;
92 my $self = $class->new;
94 # initialise the request
95 $self->headers_out(Maypole::Headers->new);
96 $self->get_request($req);
97 $self->parse_location;
99 my $status = $self->handler_guts;
101 # moving this here causes unit test failures - need to check why
102 # before committing the move
103 #$status = $self->__call_process_view unless $self->output;
105 return $status unless $status == OK;
112 # The root of all evil
119 my $applicable = $self->is_model_applicable;
121 $self->__setup_plain_template unless $applicable;
123 $self->session($self->call_get_session);
127 eval { $status = $self->call_authenticate };
129 if ( my $error = $@ )
131 $status = $self->call_exception($error);
135 warn "caught authenticate error: $error";
136 return $self->debug ?
137 $self->view_object->error($self, $error) : ERROR;
141 if ( $self->debug and $status != OK and $status != DECLINED )
143 $self->view_object->error( $self,
144 "Got unexpected status $status from calling authentication" );
147 return $status unless $status == OK;
149 # We run additional_data for every request
150 $self->additional_data;
154 eval { $self->model_class->process($self) };
156 if ( my $error = $@ )
158 $status = $self->call_exception($error);
162 warn "caught model error: $error";
163 return $self->debug ?
164 $self->view_object->error($self, $error) : ERROR;
169 # less frequent path - perhaps output has been set to an error message
170 return OK if $self->output;
172 # normal path - no output has been generated yet
173 return $self->__call_process_view;
176 # is_applicable() returned false, so set up a plain template. Model processing
177 # will be skipped, but need to remove the model anyway so the template can't
179 sub __setup_plain_template
183 # It's just a plain template
184 $self->model_class(undef);
186 my $path = $self->path;
187 $path =~ s{/$}{}; # De-absolutify
190 $self->template($self->path);
193 # The model has been processed or skipped (if is_applicable returned false),
194 # any exceptions have been handled, and there's no content in $self->output
195 sub __call_process_view
201 eval { $status = $self->view_object->process($self) };
203 if ( my $error = $@ )
205 $status = $self->call_exception($error);
209 warn "caught view error: $error" if $self->debug;
210 return $self->debug ?
211 $self->view_object->error($self, $error) : ERROR;
221 $self->model_class( $self->config->model->class_of($self, $self->table) );
224 # is_applicable() should return true or false, not OK or DECLINED, because
225 # the return value is never used as the return value from handler(). There's
226 # probably a lot of code out there supplying the return codes though, so
227 # instead of changing is_applicable() to return 0 or 1, the return value is
228 # passed through __to_boolean. I think it helps handler_guts() if we don't
229 # have multiple sets of return codes being checked for different things -drb.
230 sub is_model_applicable
234 # cater for applications that are using obsolete version
235 if ($self->can('is_applicable'))
237 warn "DEPRECATION WARNING: rewrite is_applicable to the interface ".
238 "of Maypole::is_model_applicable\n";
239 return $self->is_applicable == OK;
242 # Establish which tables should be processed by the model
243 my $config = $self->config;
245 $config->ok_tables || $config->ok_tables( $config->display_tables );
247 $config->ok_tables( { map { $_ => 1 } @{ $config->ok_tables } } )
248 if ref $config->ok_tables eq "ARRAY";
250 my $ok_tables = $config->ok_tables;
252 # Does this request concern a table to be processed by the model?
253 my $table = $self->table;
257 if (exists $ok_tables->{$table})
261 # implements tj's default_table_view(), but there's no _default_table_view()
262 # or _have_default_table_view() yet
265 # $ok = $self->default_table_view($self->path, $self->args)
266 # if $self->_have_default_table_view;
271 warn "We don't have that table ($table).\n"
272 . "Available tables are: "
273 . join( ",", keys %$ok_tables )
274 if $self->debug and not $ok_tables->{$table};
279 # Is the action public?
280 my $action = $self->action;
281 return 1 if $self->model_class->is_public($action);
283 warn "The action '$action' is not applicable to the table $table"
289 sub call_authenticate
293 # Check if we have a model class with an authenticate() to delegate to
294 return $self->model_class->authenticate($self)
295 if $self->model_class and $self->model_class->can('authenticate');
297 # Interface consistency is a Good Thing -
298 # the invocant and the argument may one day be different things
299 # (i.e. controller and request), like they are when authenticate()
300 # is called on a model class (i.e. model and request)
301 return $self->authenticate($self);
304 sub call_get_session {
306 return $self->get_session($self);
311 my ($self, $error) = @_;
313 # Check if we have a model class with an exception() to delegate to
314 if ( $self->model_class && $self->model_class->can('exception') )
316 my $status = $self->model_class->exception( $self, $error );
317 return $status if $status == OK;
320 return $self->exception($error);
323 sub default_table_view {
324 my ($self,$path,$args) = @_;
326 my $default_table_view = __PACKAGE__->_default_table_view;
327 # (path class action field)
328 my @path = $self->{path} =~ m{([^/]+)/?}g;
329 my $search_value = shift(@path);
330 if ($default_table_view->{path}) {
331 if ($default_table_view->{path} eq $search_value) {
332 $search_value = shift(@path);
338 $self->{table} = $default_table_view->{class};
339 $self->{action} = $default_table_view->{action};
340 $self->{args} = [ $search_value,@path ];
344 sub additional_data { }
346 sub authenticate { return OK }
350 sub exception { return ERROR }
352 sub preprocess_path { };
358 $self->preprocess_path;
360 $self->path || $self->path('frontpage');
362 my @pi = grep {length} split '/', $self->path;
364 $self->table || $self->table(shift @pi);
366 $self->action || $self->action( shift @pi or 'index' );
368 $self->args || $self->args(\@pi);
378 if (@_ == 1 and ref $_[0] and ref $_[0] eq 'HASH')
382 elsif ( @_ > 1 and @_ < 4 )
384 $args{table} = shift;
385 $args{action} = shift;
386 $args{additional} = shift;
393 do { die "no $_" unless $args{$_} } for qw( table action );
395 my $additional = $args{additional} || $args{id};
401 # if $additional is a href, make_uri() will transform it into a query
402 @add = (ref $additional eq 'ARRAY') ? @$additional : ($additional);
405 my $uri = $r->make_uri($args{table}, $args{action}, @add);
407 return $uri->as_string;
412 my ($r, @segments) = @_;
414 my $query = (ref $segments[-1] eq 'HASH') ? pop(@segments) : undef;
416 my $base = $r->config->uri_base;
419 my $uri = URI->new($base);
420 $uri->path_segments($uri->path_segments, grep {length} @segments);
422 my $abs_uri = $uri->abs('/');
423 $abs_uri->query_form($query) if $query;
428 # like CGI::param(), but read only
431 my ($self, $key) = @_;
433 return keys %{$self->params} unless defined $key;
435 return unless exists $self->params->{$key};
437 my $val = $self->params->{$key};
439 return ref $val ? @$val : ($val) if wantarray;
441 return ref $val ? $val->[0] : $val;
444 sub get_template_root {'.'}
448 die "get_protocol is a virtual method. Do not use Maypole directly; use Apache::MVC or similar";
452 die "parse_location is a virtual method. Do not use Maypole directly; use Apache::MVC or similar";
455 sub redirect_request {
456 die "parse_location is a virtual method. Do not use Maypole directly; use Apache::MVC or similar";
459 sub redirect_internal_request {
464 die "send_output is a virtual method. Do not use Maypole directly; use Apache::MVC or similar";
467 # Session and Repeat Submission Handling
470 use Maypole::Session;
471 return Maypole::Session::generate_unique_id();
476 Maypole - MVC web application framework
480 See L<Maypole::Application>.
484 This documents the Maypole request object. See the L<Maypole::Manual>, for a
485 detailed guide to using Maypole.
487 Maypole is a Perl web application framework similar to Java's struts. It is
488 essentially completely abstracted, and so doesn't know anything about
489 how to talk to the outside world.
491 To use it, you need to create a package which represents your entire
492 application. In our example above, this is the C<BeerDB> package.
494 This needs to first use L<Maypole::Application> which will make your package
495 inherit from the appropriate platform driver such as C<Apache::MVC> or
496 C<CGI::Maypole>, and then call setup. This sets up the model classes and
497 configures your application. The default model class for Maypole uses
498 L<Class::DBI> to map a database to classes, but this can be changed by altering
499 configuration. (B<Before> calling setup.)
505 Returns the L<Maypole::Config> object
509 My::App->setup($data_source, $user, $password, \%attr);
511 Initialise the maypole application and model classes. Your application should
512 call this after setting configuration via L<"config">
516 You should not call this directly, but you may wish to override this to
518 application-specific initialisation.
522 Constructs a very minimal new Maypole request object.
526 Get/set the Maypole::View object
530 sub My::App::debug {1}
532 Returns the debugging flag. Override this in your application class to
533 enable/disable debugging.
535 =head2 INSTANCE METHODS
537 =head3 parse_location
539 Turns the backend request (e.g. Apache::MVC, Maypole, CGI) into a
541 request. It does this by setting the C<path>, and invoking C<parse_path>
545 You should only need to define this method if you are writing a new
551 Returns the request path
555 Parses the request path and sets the C<args>, C<action> and C<table>
556 properties. Calls preprocess_path before parsing path and setting properties.
558 =head3 make_path( %args or \%args or @args )
560 This is the counterpart to C<parse_path>. It generates a path to use
561 in links, form actions etc. To implement your own path scheme, just override
562 this method and C<parse_path>.
564 %args = ( table => $table,
566 additional => $additional, # optional - generally an object ID
569 \%args = as above, but a ref
571 @args = ( $table, $action, $additional ); # $additional is optional
573 C<id> can be used as an alternative key to C<additional>.
575 C<$additional> can be a string, an arrayref, or a hashref. An arrayref is
576 expanded into extra path elements, whereas a hashref is translated into a query
579 =head3 preprocess_path
581 Sometimes when you don't want to rewrite or over-ride parse_path but
582 want to rewrite urls or extract data from them before it is parsed.
584 This method is called after parse_location has populated the request
585 information and before parse_path has populated the model and action
586 information, and is passed the request object.
588 You can set action, args or table in this method and parse_path will
589 then leave those values in place or populate them if not present
591 =head3 make_uri( @segments )
593 Make a L<URI> object given table, action etc. Automatically adds
596 If the final element in C<@segments> is a hash ref, C<make_uri> will render it
601 The table part of the Maypole request path
605 The action part of the Maypole request path
609 A list of remaining parts of the request path after table and action
615 A L<Maypole::Headers> object containing HTTP headers for the request
619 A L<HTTP::Headers> object that contains HTTP headers for the output
623 Turns post data and query string paramaters into a hash of C<params>.
625 You should only need to define this method if you are writing a new
631 An accessor for request parameters. It behaves similarly to CGI::param() for
632 accessing CGI parameters.
636 Returns a hash of request parameters. The source of the parameters may vary
637 depending on the Maypole backend, but they are usually populated from request
638 query string and POST data.
640 B<Note:> Where muliple values of a parameter were supplied, the
643 will be an array reference.
645 =head3 get_template_root
647 Implementation-specific path to template root.
649 You should only need to define this method if you are writing a new
651 backend. Otherwise, see L<Maypole::Config/"template_root">
655 You should only need to define this method if you are writing a new
656 Maypole backend. It should return something that looks like an Apache
657 or CGI request object, it defaults to blank.
659 =head3 default_table_view
663 Returns a Maypole::Constant to indicate whether the request is valid.
665 B<This method is deprecated> as of version 2.11. If you have overridden it,
666 please override C<is_model_applicable> instead, and change the return type
667 from Maypole:Constants to true/false.
669 =head3 is_model_applicable
671 Returns true or false to indicate whether the request is valid.
673 The default implementation checks that C<< $r->table >> is publicly
674 accessible and that the model class is configured to handle the
679 Returns a Maypole::Constant to indicate whether the user is
683 The default implementation returns C<OK>
687 Returns the perl package name that will serve as the model for the
688 request. It corresponds to the request C<table> attribute.
690 =head3 additional_data
692 Called before the model processes the request, this method gives you a
694 to do some processing for each request, for example, manipulating
699 Get/set a list of model objects. The objects will be accessible in the
703 If the first item in C<$self-E<gt>args> can be C<retrieve()>d by the model
705 it will be removed from C<args> and the retrieved object will be added
707 C<objects> list. See L<Maypole::Model> for more information.
711 $self->template_args->{foo} = 'bar';
713 Get/set a hash of template variables.
717 A place to put custom application data. Not used by Maypole itself.
721 Get/set the template to be used by the view. By default, it returns
726 This method is called if any exceptions are raised during the
729 model/view processing. It should accept the exception as a parameter and
731 a Maypole::Constant to indicate whether the request should continue to
737 Get/set a request error
741 Get/set the response output. This is usually populated by the view
743 can skip view processing by setting the C<output>.
745 =head3 document_encoding
747 Get/set the output encoding. Default: utf-8.
751 Get/set the output content type. Default: text/html
755 Sends the output and additional headers to the user.
757 =head3 call_authenticate
759 This method first checks if the relevant model class
760 can authenticate the user, or falls back to the default
761 authenticate method of your Maypole application.
764 =head3 call_exception
766 This model is called to catch exceptions, first after authenticate, then after
767 processing the model class, and finally to check for exceptions from the view
770 This method first checks if the relevant model class
771 can handle exceptions the user, or falls back to the default
772 exception method of your Maypole application.
774 =head3 make_random_id
776 returns a unique id for this request can be used to prevent or detect repeat
781 Returns the protocol the request was made with, i.e. https
783 =head3 redirect_request
785 Sets output headers to redirect based on the arguments provided
787 Accepts either a single argument of the full url to redirect to, or a hash of named parameters :
789 $r->redirect_request('http://www.example.com/path');
793 $r->redirect_request(protocol=>'https', domain=>'www.example.com', path=>'/path/file?arguments', status=>'302', url=>'..');
795 The named parameters are protocol, domain, path, status and url
797 Only 1 named parameter is required but other than url, they can be combined as required and current values (from the request) will be used in place of any missing arguments. The url argument must be a full url including protocol and can only be combined with status.
799 =head3 redirect_internal_request
803 This method sets up the class if it's not done yet, sets some
804 defaults and leaves the dirty work to handler_guts.
808 This is the main request handling method and calls various methods to handle the request/response
809 and defines the workflow within Maypole.
811 Currently undocumented and liable to be refactored without warning.
815 There's more documentation, examples, and a information on our mailing lists
816 at the Maypole web site:
818 L<http://maypole.perl.org/>
820 L<Maypole::Application>, L<Apache::MVC>, L<CGI::Maypole>.
824 Maypole is currently maintained by Aaron Trevena
826 =head1 AUTHOR EMERITUS
828 Simon Cozens, C<simon#cpan.org>
830 Sebastian Riedel, C<sri#oook.de> maintained Maypole from 1.99_01 to 2.04
834 Sebastian Riedel, Danijel Milicevic, Dave Slack, Jesse Sheidlower, Jody Belka,
835 Marcus Ramberg, Mickael Joanne, Randal Schwartz, Simon Flack, Steve Simms,
836 Veljko Vidovic and all the others who've helped.
840 You may distribute this code under the same terms as Perl itself.