2 use base qw(Class::Accessor::Fast Class::Data::Inheritable);
3 use UNIVERSAL::require;
7 use Maypole::Constants;
10 our $VERSION = '2.11';
12 # proposed privacy conventions:
13 # - no leading underscore - public to custom application code and plugins
14 # - single leading underscore - private to the main Maypole stack - *not*
16 # - double leading underscore - private to the current package
18 __PACKAGE__->mk_classdata($_) for qw( config init_done view_object );
19 __PACKAGE__->mk_accessors(
20 qw( params query objects model_class template_args output path
21 args action template error document_encoding content_type table
22 headers_in headers_out stash )
24 __PACKAGE__->config( Maypole::Config->new() );
25 __PACKAGE__->init_done(0);
31 my $calling_class = shift;
33 $calling_class = ref $calling_class if ref $calling_class;
35 my $config = $calling_class->config;
37 $config->model || $config->model('Maypole::Model::CDBI');
39 $config->model->require or die sprintf
40 "Couldn't load the model class %s: %s", $config->model, $@;
42 $config->model->setup_database($config, $calling_class, @_);
44 foreach my $subclass ( @{ $config->classes } )
47 unshift @{ $subclass . "::ISA" }, $config->model;
48 $config->model->adopt($subclass)
49 if $config->model->can("adopt");
56 my $config = $class->config;
57 $config->view || $config->view("Maypole::View::TT");
58 $config->view->require;
59 die "Couldn't load the view class " . $config->view . ": $@" if $@;
60 $config->display_tables
61 || $config->display_tables( $class->config->tables );
62 $class->view_object( $class->config->view->new );
73 config => $class->config,
79 # handler() has a method attribute so that mod_perl will invoke
80 # BeerDB->handler() as a method rather than a plain function
81 # BeerDB::handler() and so this inherited implementation will be
82 # found. See e.g. "Practical mod_perl" by Bekman & Cholet for
83 # more information <http://modperlbook.org/html/ch25_01.html>
86 # See Maypole::Workflow before trying to understand this.
87 my ($class, $req) = @_;
89 $class->init unless $class->init_done;
91 my $self = $class->new;
93 # initialise the request
94 $self->headers_out(Maypole::Headers->new);
95 $self->get_request($req);
96 $self->parse_location;
98 my $status = $self->handler_guts;
100 # moving this here causes unit test failures - need to check why
101 # before committing the move
102 #$status = $self->__call_process_view unless $self->output;
104 return $status unless $status == OK;
111 # The root of all evil
118 my $applicable = __to_boolean( $self->is_applicable );
120 $self->__setup_plain_template unless $applicable;
122 # We authenticate every request, needed for proper session management
125 eval { $status = $self->call_authenticate };
127 if ( my $error = $@ )
129 $status = $self->call_exception($error);
133 warn "caught authenticate error: $error";
134 return $self->debug ?
135 $self->view_object->error($self, $error) : ERROR;
139 if ( $self->debug and $status != OK and $status != DECLINED )
141 $self->view_object->error( $self,
142 "Got unexpected status $status from calling authentication" );
145 return $status unless $status == OK;
147 # We run additional_data for every request
148 $self->additional_data;
152 eval { $self->model_class->process($self) };
154 if ( my $error = $@ )
156 $status = $self->call_exception($error);
160 warn "caught model error: $error";
161 return $self->debug ?
162 $self->view_object->error($self, $error) : ERROR;
167 # less frequent path - perhaps output has been set to an error message
168 return OK if $self->output;
170 # normal path - no output has been generated yet
171 return $self->__call_process_view;
174 # is_applicable() returned false, so set up a plain template. Model processing
175 # will be skipped, but need to remove the model anyway so the template can't
177 sub __setup_plain_template
181 # It's just a plain template
182 $self->model_class(undef);
184 my $path = $self->path;
185 $path =~ s{/$}{}; # De-absolutify
188 $self->template($self->path);
191 # The model has been processed or skipped (if is_applicable returned false),
192 # any exceptions have been handled, and there's no content in $self->output
193 sub __call_process_view
199 eval { $status = $self->view_object->process($self) };
201 if ( my $error = $@ )
203 $status = $self->call_exception($error);
207 warn "caught view error: $error" if $self->debug;
208 return $self->debug ?
209 $self->view_object->error($self, $error) : ERROR;
219 $self->model_class( $self->config->model->class_of($self, $self->table) );
222 # is_applicable() should return true or false, not OK or DECLINED, because
223 # the return value is never used as the return value from handler(). There's
224 # probably a lot of code out there supplying the return codes though, so
225 # instead of changing is_applicable() to return 0 or 1, the return value is
226 # passed through __to_boolean. I think it helps handler_guts() if we don't
227 # have multiple sets of return codes being checked for different things -drb.
232 my $config = $self->config;
234 $config->ok_tables || $config->ok_tables( $config->display_tables );
236 $config->ok_tables( { map { $_ => 1 } @{ $config->ok_tables } } )
237 if ref $config->ok_tables eq "ARRAY";
239 my $table = $self->table;
241 warn "We don't have that table ($table).\n"
242 . "Available tables are: "
243 . join( ",", @{ $config->display_tables } )
245 and not $config->ok_tables->{$table}
246 and $self->action; # this is probably always true
248 return DECLINED unless exists $config->ok_tables->{$table};
251 if (exists $config->ok_tables->{ $self->{table} }) {
254 if ( $self->_have_default_table_view ) {
255 my $path_is_ok = $self->default_table_view($self->{path},$self->{args});
257 unless ($path_is_ok) {
258 warn "We don't have that table ($self->{table}).\n"
259 . "Available tables are: "
260 . join( ",", @{ $config->{display_tables} } )
262 and not $config->ok_tables->{ $self->{table} }
267 return DECLINED() unless $path_is_ok;
270 return DECLINED unless $self->model_class->is_public($self->action);
275 # *only* intended for translating the return code from is_applicable()
276 sub __to_boolean { $_[0] == OK ? 1 : 0 }
278 sub call_authenticate
282 # Check if we have a model class with an authenticate() to delegate to
283 return $self->model_class->authenticate($self)
284 if $self->model_class and $self->model_class->can('authenticate');
286 # Interface consistency is a Good Thing -
287 # the invocant and the argument may one day be different things
288 # (i.e. controller and request), like they are when authenticate()
289 # is called on a model class (i.e. model and request)
290 return $self->authenticate($self);
295 my ($self, $error) = @_;
297 # Check if we have a model class with an exception() to delegate to
298 if ( $self->model_class && $self->model_class->can('exception') )
300 my $status = $self->model_class->exception( $self, $error );
301 return $status if $status == OK;
304 return $self->exception($error);
307 sub default_table_view {
308 my ($self,$path,$args) = @_;
310 my $default_table_view = __PACKAGE__->_default_table_view;
311 # (path class action field)
312 my @path = $self->{path} =~ m{([^/]+)/?}g;
313 my $search_value = shift(@path);
314 if ($default_table_view->{path}) {
315 if ($default_table_view->{path} eq $search_value) {
316 $search_value = shift(@path);
322 $self->{table} = $default_table_view->{class};
323 $self->{action} = $default_table_view->{action};
324 $self->{args} = [ $search_value,@path ];
328 sub additional_data { }
330 sub authenticate { return OK }
332 sub exception { return ERROR }
338 $self->path || $self->path('frontpage');
340 my @pi = grep {length} split '/', $self->path;
342 $self->table(shift @pi);
344 $self->action( shift @pi or 'index' );
349 # like CGI::param(), but read only
352 my ($self, $key) = @_;
354 return keys %{$self->params} unless defined $key;
356 return unless exists $self->params->{$key};
358 my $val = $self->params->{$key};
360 return ref $val ? @$val : ($val) if wantarray;
362 return ref $val ? $val->[0] : $val;
365 sub get_template_root {'.'}
369 die "get_protocol is a virtual method. Do not use Maypole directly; use Apache::MVC or similar";
373 die "parse_location is a virtual method. Do not use Maypole directly; use Apache::MVC or similar";
376 sub redirect_request {
377 die "parse_location is a virtual method. Do not use Maypole directly; use Apache::MVC or similar";
381 die "send_output is a virtual method. Do not use Maypole directly; use Apache::MVC or similar";
384 # Session and Repeat Submission Handling
387 use Maypole::Session;
388 return Maypole::Session::generate_unique_id();
393 Maypole - MVC web application framework
397 See L<Maypole::Application>.
401 This documents the Maypole request object. See the L<Maypole::Manual>, for a
402 detailed guide to using Maypole.
404 Maypole is a Perl web application framework similar to Java's struts. It is
405 essentially completely abstracted, and so doesn't know anything about
406 how to talk to the outside world.
408 To use it, you need to create a package which represents your entire
409 application. In our example above, this is the C<BeerDB> package.
411 This needs to first use L<Maypole::Application> which will make your package
412 inherit from the appropriate platform driver such as C<Apache::MVC> or
413 C<CGI::Maypole>, and then call setup. This sets up the model classes and
414 configures your application. The default model class for Maypole uses
415 L<Class::DBI> to map a database to classes, but this can be changed by altering
416 configuration. (B<Before> calling setup.)
422 Returns the L<Maypole::Config> object
426 My::App->setup($data_source, $user, $password, \%attr);
428 Initialise the maypole application and model classes. Your application should
429 call this after setting configuration via L<"config">
433 You should not call this directly, but you may wish to override this to
435 application-specific initialisation.
439 Constructs a very minimal new Maypole request object.
443 Get/set the Maypole::View object
447 sub My::App::debug {1}
449 Returns the debugging flag. Override this in your application class to
450 enable/disable debugging.
452 =head2 INSTANCE METHODS
454 =head3 parse_location
456 Turns the backend request (e.g. Apache::MVC, Maypole, CGI) into a
458 request. It does this by setting the C<path>, and invoking C<parse_path>
462 You should only need to define this method if you are writing a new
468 Returns the request path
472 Parses the request path and sets the C<args>, C<action> and C<table>
477 The table part of the Maypole request path
481 The action part of the Maypole request path
485 A list of remaining parts of the request path after table and action
491 A L<Maypole::Headers> object containing HTTP headers for the request
495 A L<HTTP::Headers> object that contains HTTP headers for the output
499 Turns post data and query string paramaters into a hash of C<params>.
501 You should only need to define this method if you are writing a new
507 An accessor for request parameters. It behaves similarly to CGI::param() for
508 accessing CGI parameters.
512 Returns a hash of request parameters. The source of the parameters may vary
513 depending on the Maypole backend, but they are usually populated from request
514 query string and POST data.
516 B<Note:> Where muliple values of a parameter were supplied, the
519 will be an array reference.
521 =head3 get_template_root
523 Implementation-specific path to template root.
525 You should only need to define this method if you are writing a new
527 backend. Otherwise, see L<Maypole::Config/"template_root">
531 You should only need to define this method if you are writing a new
532 Maypole backend. It should return something that looks like an Apache
533 or CGI request object, it defaults to blank.
535 =head3 default_table_view
539 Returns a Maypole::Constant to indicate whether the request is valid.
541 The default implementation checks that C<$self-E<gt>table> is publicly
543 and that the model class is configured to handle the C<$self-E<gt>action>
547 Returns a Maypole::Constant to indicate whether the user is
551 The default implementation returns C<OK>
555 Returns the perl package name that will serve as the model for the
556 request. It corresponds to the request C<table> attribute.
558 =head3 additional_data
560 Called before the model processes the request, this method gives you a
562 to do some processing for each request, for example, manipulating
567 Get/set a list of model objects. The objects will be accessible in the
571 If the first item in C<$self-E<gt>args> can be C<retrieve()>d by the model
573 it will be removed from C<args> and the retrieved object will be added
575 C<objects> list. See L<Maypole::Model> for more information.
579 $self->template_args->{foo} = 'bar';
581 Get/set a hash of template variables.
585 A place to put custom application data. Not used by Maypole itself.
589 Get/set the template to be used by the view. By default, it returns
594 This method is called if any exceptions are raised during the
597 model/view processing. It should accept the exception as a parameter and
599 a Maypole::Constant to indicate whether the request should continue to
605 Get/set a request error
609 Get/set the response output. This is usually populated by the view
611 can skip view processing by setting the C<output>.
613 =head3 document_encoding
615 Get/set the output encoding. Default: utf-8.
619 Get/set the output content type. Default: text/html
623 Sends the output and additional headers to the user.
625 =head3 call_authenticate
627 This method first checks if the relevant model class
628 can authenticate the user, or falls back to the default
629 authenticate method of your Maypole application.
632 =head3 call_exception
634 This model is called to catch exceptions, first after authenticate, then after
635 processing the model class, and finally to check for exceptions from the view
638 This method first checks if the relevant model class
639 can handle exceptions the user, or falls back to the default
640 exception method of your Maypole application.
642 =head3 make_random_id
644 returns a unique id for this request can be used to prevent or detect repeat
649 Returns the protocol the request was made with, i.e. https
651 =head3 redirect_request
653 Sets output headers to redirect based on the arguments provided
655 Accepts either a single argument of the full url to redirect to, or a hash of named parameters :
657 $r->redirect_request('http://www.example.com/path');
661 $r->redirect_request(protocol=>'https', domain=>'www.example.com', path=>'/path/file?arguments', status=>'302', url=>'..');
663 The named parameters are protocol, domain, path, status and url
665 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.
669 This method sets up the class if it's not done yet, sets some
670 defaults and leaves the dirty work to handler_guts.
674 This is the main request handling method and calls various methods to handle the request/response
675 and defines the workflow within Maypole.
677 Currently undocumented and liable to be refactored without warning.
681 There's more documentation, examples, and a information on our mailing lists
682 at the Maypole web site:
684 L<http://maypole.perl.org/>
686 L<Maypole::Application>, L<Apache::MVC>, L<CGI::Maypole>.
690 Maypole is currently maintained by Simon Flack C<simonflk#cpan.org>
692 =head1 AUTHOR EMERITUS
694 Simon Cozens, C<simon#cpan.org>
696 Sebastian Riedel, C<sri#oook.de> maintained Maypole from 1.99_01 to 2.04
700 Sebastian Riedel, Danijel Milicevic, Dave Slack, Jesse Sheidlower, Jody Belka,
701 Marcus Ramberg, Mickael Joanne, Randal Schwartz, Simon Flack, Steve Simms,
702 Veljko Vidovic and all the others who've helped.
706 You may distribute this code under the same terms as Perl itself.