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)
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 # We authenticate every request, needed for proper session management
126 eval { $status = $self->call_authenticate };
128 if ( my $error = $@ )
130 $status = $self->call_exception($error);
134 warn "caught authenticate error: $error";
135 return $self->debug ?
136 $self->view_object->error($self, $error) : ERROR;
140 if ( $self->debug and $status != OK and $status != DECLINED )
142 $self->view_object->error( $self,
143 "Got unexpected status $status from calling authentication" );
146 return $status unless $status == OK;
148 # We run additional_data for every request
149 $self->additional_data;
153 eval { $self->model_class->process($self) };
155 if ( my $error = $@ )
157 $status = $self->call_exception($error);
161 warn "caught model error: $error";
162 return $self->debug ?
163 $self->view_object->error($self, $error) : ERROR;
168 # less frequent path - perhaps output has been set to an error message
169 return OK if $self->output;
171 # normal path - no output has been generated yet
172 return $self->__call_process_view;
175 # is_applicable() returned false, so set up a plain template. Model processing
176 # will be skipped, but need to remove the model anyway so the template can't
178 sub __setup_plain_template
182 # It's just a plain template
183 $self->model_class(undef);
185 my $path = $self->path;
186 $path =~ s{/$}{}; # De-absolutify
189 $self->template($self->path);
192 # The model has been processed or skipped (if is_applicable returned false),
193 # any exceptions have been handled, and there's no content in $self->output
194 sub __call_process_view
200 eval { $status = $self->view_object->process($self) };
202 if ( my $error = $@ )
204 $status = $self->call_exception($error);
208 warn "caught view error: $error" if $self->debug;
209 return $self->debug ?
210 $self->view_object->error($self, $error) : ERROR;
220 $self->model_class( $self->config->model->class_of($self, $self->table) );
223 # is_applicable() should return true or false, not OK or DECLINED, because
224 # the return value is never used as the return value from handler(). There's
225 # probably a lot of code out there supplying the return codes though, so
226 # instead of changing is_applicable() to return 0 or 1, the return value is
227 # passed through __to_boolean. I think it helps handler_guts() if we don't
228 # have multiple sets of return codes being checked for different things -drb.
229 sub is_model_applicable
233 # cater for applications that are using obsolete version
234 if ($self->can('is_applicable'))
236 warn "DEPRECATION WARNING: rewrite is_applicable to the interface ".
237 "of Maypole::is_model_applicable\n";
238 return $self->is_applicable == OK;
241 # Establish which tables should be processed by the model
242 my $config = $self->config;
244 $config->ok_tables || $config->ok_tables( $config->display_tables );
246 $config->ok_tables( { map { $_ => 1 } @{ $config->ok_tables } } )
247 if ref $config->ok_tables eq "ARRAY";
249 my $ok_tables = $config->ok_tables;
251 # Does this request concern a table to be processed by the model?
252 my $table = $self->table;
256 if (exists $ok_tables->{$table})
260 # implements tj's default_table_view(), but there's no _default_table_view()
261 # or _have_default_table_view() yet
264 # $ok = $self->default_table_view($self->path, $self->args)
265 # if $self->_have_default_table_view;
270 warn "We don't have that table ($table).\n"
271 . "Available tables are: "
272 . join( ",", keys %$ok_tables )
273 if $self->debug and not $ok_tables->{$table};
278 # Is the action public?
279 my $action = $self->action;
280 return 1 if $self->model_class->is_public($action);
282 warn "The action '$action' is not applicable to the table $table"
288 sub call_authenticate
292 # Check if we have a model class with an authenticate() to delegate to
293 return $self->model_class->authenticate($self)
294 if $self->model_class and $self->model_class->can('authenticate');
296 # Interface consistency is a Good Thing -
297 # the invocant and the argument may one day be different things
298 # (i.e. controller and request), like they are when authenticate()
299 # is called on a model class (i.e. model and request)
300 return $self->authenticate($self);
305 my ($self, $error) = @_;
307 # Check if we have a model class with an exception() to delegate to
308 if ( $self->model_class && $self->model_class->can('exception') )
310 my $status = $self->model_class->exception( $self, $error );
311 return $status if $status == OK;
314 return $self->exception($error);
317 sub default_table_view {
318 my ($self,$path,$args) = @_;
320 my $default_table_view = __PACKAGE__->_default_table_view;
321 # (path class action field)
322 my @path = $self->{path} =~ m{([^/]+)/?}g;
323 my $search_value = shift(@path);
324 if ($default_table_view->{path}) {
325 if ($default_table_view->{path} eq $search_value) {
326 $search_value = shift(@path);
332 $self->{table} = $default_table_view->{class};
333 $self->{action} = $default_table_view->{action};
334 $self->{args} = [ $search_value,@path ];
338 sub additional_data { }
340 sub authenticate { return OK }
342 sub exception { return ERROR }
348 $self->path || $self->path('frontpage');
350 my @pi = grep {length} split '/', $self->path;
352 $self->table(shift @pi);
354 $self->action( shift @pi or 'index' );
359 =head3 make_path( %args or \%args or @args )
361 This is the counterpart to C<Maypole::parse_path>. It generates a path to use
362 in links, form actions etc. To implement your own path scheme, just override
363 this method and C<parse_path>.
365 %args = ( table => $table,
367 additional => $additional, # optional - generally an object ID
370 \%args = as above, but a ref
372 @args = ( $table, $action, $additional ); # $additional is optional
374 C<id> can be used as an alternative key to C<additional>.
376 C<$additional> can be a string, an arrayref, or a hashref. An arrayref is
377 expanded into extra path elements, whereas a hashref is translated into a query
388 if (@_ == 1 and ref $_[0] and ref $_[0] eq 'HASH')
392 elsif ( @_ > 1 and @_ < 4 )
394 $args{table} = shift;
395 $args{action} = shift;
396 $args{additional} = shift;
403 do { die "no $_" unless $args{$_} } for qw( table action );
405 my $additional = $args{additional} || $args{id};
411 # if $additional is a href, make_uri() will transform it into a query
412 @add = (ref $additional eq 'ARRAY') ? @$additional : ($additional);
415 my $uri = $r->make_uri($args{table}, $args{action}, @add);
417 return $uri->as_string;
420 =head3 make_uri( @segments )
422 Make a L<URI> object given table, action etc. Automatically adds
425 If the final element in C<@segments> is a hash ref, C<make_uri> will render it
432 my ($r, @segments) = @_;
434 my $query = (ref $segments[-1] eq 'HASH') ? pop(@segments) : undef;
436 my $base = $r->config->uri_base;
439 my $uri = URI->new($base);
440 $uri->path_segments($uri->path_segments, grep {length} @segments);
442 my $abs_uri = $uri->abs('/');
443 $abs_uri->query_form($query) if $query;
448 # like CGI::param(), but read only
451 my ($self, $key) = @_;
453 return keys %{$self->params} unless defined $key;
455 return unless exists $self->params->{$key};
457 my $val = $self->params->{$key};
459 return ref $val ? @$val : ($val) if wantarray;
461 return ref $val ? $val->[0] : $val;
464 sub get_template_root {'.'}
468 die "get_protocol is a virtual method. Do not use Maypole directly; use Apache::MVC or similar";
472 die "parse_location is a virtual method. Do not use Maypole directly; use Apache::MVC or similar";
475 sub redirect_request {
476 die "parse_location is a virtual method. Do not use Maypole directly; use Apache::MVC or similar";
479 sub redirect_internal_request {
484 die "send_output is a virtual method. Do not use Maypole directly; use Apache::MVC or similar";
487 # Session and Repeat Submission Handling
490 use Maypole::Session;
491 return Maypole::Session::generate_unique_id();
496 Maypole - MVC web application framework
500 See L<Maypole::Application>.
504 This documents the Maypole request object. See the L<Maypole::Manual>, for a
505 detailed guide to using Maypole.
507 Maypole is a Perl web application framework similar to Java's struts. It is
508 essentially completely abstracted, and so doesn't know anything about
509 how to talk to the outside world.
511 To use it, you need to create a package which represents your entire
512 application. In our example above, this is the C<BeerDB> package.
514 This needs to first use L<Maypole::Application> which will make your package
515 inherit from the appropriate platform driver such as C<Apache::MVC> or
516 C<CGI::Maypole>, and then call setup. This sets up the model classes and
517 configures your application. The default model class for Maypole uses
518 L<Class::DBI> to map a database to classes, but this can be changed by altering
519 configuration. (B<Before> calling setup.)
525 Returns the L<Maypole::Config> object
529 My::App->setup($data_source, $user, $password, \%attr);
531 Initialise the maypole application and model classes. Your application should
532 call this after setting configuration via L<"config">
536 You should not call this directly, but you may wish to override this to
538 application-specific initialisation.
542 Constructs a very minimal new Maypole request object.
546 Get/set the Maypole::View object
550 sub My::App::debug {1}
552 Returns the debugging flag. Override this in your application class to
553 enable/disable debugging.
555 =head2 INSTANCE METHODS
557 =head3 parse_location
559 Turns the backend request (e.g. Apache::MVC, Maypole, CGI) into a
561 request. It does this by setting the C<path>, and invoking C<parse_path>
565 You should only need to define this method if you are writing a new
571 Returns the request path
575 Parses the request path and sets the C<args>, C<action> and C<table>
580 The table part of the Maypole request path
584 The action part of the Maypole request path
588 A list of remaining parts of the request path after table and action
594 A L<Maypole::Headers> object containing HTTP headers for the request
598 A L<HTTP::Headers> object that contains HTTP headers for the output
602 Turns post data and query string paramaters into a hash of C<params>.
604 You should only need to define this method if you are writing a new
610 An accessor for request parameters. It behaves similarly to CGI::param() for
611 accessing CGI parameters.
615 Returns a hash of request parameters. The source of the parameters may vary
616 depending on the Maypole backend, but they are usually populated from request
617 query string and POST data.
619 B<Note:> Where muliple values of a parameter were supplied, the
622 will be an array reference.
624 =head3 get_template_root
626 Implementation-specific path to template root.
628 You should only need to define this method if you are writing a new
630 backend. Otherwise, see L<Maypole::Config/"template_root">
634 You should only need to define this method if you are writing a new
635 Maypole backend. It should return something that looks like an Apache
636 or CGI request object, it defaults to blank.
638 =head3 default_table_view
642 Returns a Maypole::Constant to indicate whether the request is valid.
644 B<This method is deprecated> as of version 2.11. If you have overridden it,
645 please override C<is_model_applicable> instead, and change the return type
646 from Maypole:Constants to true/false.
648 =head3 is_model_applicable
650 Returns true or false to indicate whether the request is valid.
652 The default implementation checks that C<< $r->table >> is publicly
653 accessible and that the model class is configured to handle the
658 Returns a Maypole::Constant to indicate whether the user is
662 The default implementation returns C<OK>
666 Returns the perl package name that will serve as the model for the
667 request. It corresponds to the request C<table> attribute.
669 =head3 additional_data
671 Called before the model processes the request, this method gives you a
673 to do some processing for each request, for example, manipulating
678 Get/set a list of model objects. The objects will be accessible in the
682 If the first item in C<$self-E<gt>args> can be C<retrieve()>d by the model
684 it will be removed from C<args> and the retrieved object will be added
686 C<objects> list. See L<Maypole::Model> for more information.
690 $self->template_args->{foo} = 'bar';
692 Get/set a hash of template variables.
696 A place to put custom application data. Not used by Maypole itself.
700 Get/set the template to be used by the view. By default, it returns
705 This method is called if any exceptions are raised during the
708 model/view processing. It should accept the exception as a parameter and
710 a Maypole::Constant to indicate whether the request should continue to
716 Get/set a request error
720 Get/set the response output. This is usually populated by the view
722 can skip view processing by setting the C<output>.
724 =head3 document_encoding
726 Get/set the output encoding. Default: utf-8.
730 Get/set the output content type. Default: text/html
734 Sends the output and additional headers to the user.
736 =head3 call_authenticate
738 This method first checks if the relevant model class
739 can authenticate the user, or falls back to the default
740 authenticate method of your Maypole application.
743 =head3 call_exception
745 This model is called to catch exceptions, first after authenticate, then after
746 processing the model class, and finally to check for exceptions from the view
749 This method first checks if the relevant model class
750 can handle exceptions the user, or falls back to the default
751 exception method of your Maypole application.
753 =head3 make_random_id
755 returns a unique id for this request can be used to prevent or detect repeat
760 Returns the protocol the request was made with, i.e. https
762 =head3 redirect_request
764 Sets output headers to redirect based on the arguments provided
766 Accepts either a single argument of the full url to redirect to, or a hash of named parameters :
768 $r->redirect_request('http://www.example.com/path');
772 $r->redirect_request(protocol=>'https', domain=>'www.example.com', path=>'/path/file?arguments', status=>'302', url=>'..');
774 The named parameters are protocol, domain, path, status and url
776 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.
778 =head3 redirect_internal_request
782 This method sets up the class if it's not done yet, sets some
783 defaults and leaves the dirty work to handler_guts.
787 This is the main request handling method and calls various methods to handle the request/response
788 and defines the workflow within Maypole.
790 Currently undocumented and liable to be refactored without warning.
794 There's more documentation, examples, and a information on our mailing lists
795 at the Maypole web site:
797 L<http://maypole.perl.org/>
799 L<Maypole::Application>, L<Apache::MVC>, L<CGI::Maypole>.
803 Maypole is currently maintained by Simon Flack C<simonflk#cpan.org>
805 =head1 AUTHOR EMERITUS
807 Simon Cozens, C<simon#cpan.org>
809 Sebastian Riedel, C<sri#oook.de> maintained Maypole from 1.99_01 to 2.04
813 Sebastian Riedel, Danijel Milicevic, Dave Slack, Jesse Sheidlower, Jody Belka,
814 Marcus Ramberg, Mickael Joanne, Randal Schwartz, Simon Flack, Steve Simms,
815 Veljko Vidovic and all the others who've helped.
819 You may distribute this code under the same terms as Perl itself.