2 use base qw(Class::Accessor::Fast Class::Data::Inheritable);
3 use UNIVERSAL::require;
7 use Maypole::Constants;
10 our $VERSION = '2.10';
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 )
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 return DECLINED unless $self->model_class->is_public($self->action);
256 # *only* intended for translating the return code from is_applicable()
257 sub __to_boolean { $_[0] == OK ? 1 : 0 }
259 sub call_authenticate
263 # Check if we have a model class with an authenticate() to delegate to
264 return $self->model_class->authenticate($self)
265 if $self->model_class and $self->model_class->can('authenticate');
267 # Interface consistency is a Good Thing -
268 # the invocant and the argument may one day be different things
269 # (i.e. controller and request), like they are when authenticate()
270 # is called on a model class (i.e. model and request)
271 return $self->authenticate($self);
276 my ($self, $error) = @_;
278 # Check if we have a model class with an exception() to delegate to
279 if ( $self->model_class && $self->model_class->can('exception') )
281 my $status = $self->model_class->exception( $self, $error );
282 return $status if $status == OK;
285 return $self->exception($error);
288 sub additional_data { }
290 sub authenticate { return OK }
292 sub exception { return ERROR }
298 $self->path || $self->path('frontpage');
300 my @pi = grep {length} split '/', $self->path;
302 $self->table(shift @pi);
304 $self->action( shift @pi or 'index' );
309 # like CGI::param(), but read only
312 my ($self, $key) = @_;
314 return keys %{$self->params} unless defined $key;
316 return unless exists $self->params->{$key};
318 my $val = $self->params->{$key};
320 return ref $val ? @$val : ($val) if wantarray;
322 return ref $val ? $val->[0] : $val;
325 sub get_template_root {'.'}
329 die "Do not use Maypole directly; use Apache::MVC or similar";
333 die "Do not use Maypole directly; use Apache::MVC or similar";
336 # Session and Repeat Submission Handling
339 use Maypole::Session;
340 return Maypole::Session::generate_unique_id();
345 Maypole - MVC web application framework
349 See L<Maypole::Application>.
353 This documents the Maypole request object. See the L<Maypole::Manual>, for a
354 detailed guide to using Maypole.
356 Maypole is a Perl web application framework similar to Java's struts. It is
357 essentially completely abstracted, and so doesn't know anything about
358 how to talk to the outside world.
360 To use it, you need to create a package which represents your entire
361 application. In our example above, this is the C<BeerDB> package.
363 This needs to first use L<Maypole::Application> which will make your package
364 inherit from the appropriate platform driver such as C<Apache::MVC> or
365 C<CGI::Maypole>, and then call setup. This sets up the model classes and
366 configures your application. The default model class for Maypole uses
367 L<Class::DBI> to map a database to classes, but this can be changed by altering
368 configuration. (B<Before> calling setup.)
374 Returns the L<Maypole::Config> object
378 My::App->setup($data_source, $user, $password, \%attr);
380 Initialise the maypole application and model classes. Your application should
381 call this after setting configuration via L<"config">
385 You should not call this directly, but you may wish to override this to
387 application-specific initialisation.
391 Constructs a very minimal new Maypole request object.
395 Get/set the Maypole::View object
399 sub My::App::debug {1}
401 Returns the debugging flag. Override this in your application class to
402 enable/disable debugging.
404 =head2 INSTANCE METHODS
406 =head3 parse_location
408 Turns the backend request (e.g. Apache::MVC, Maypole, CGI) into a
410 request. It does this by setting the C<path>, and invoking C<parse_path>
414 You should only need to define this method if you are writing a new
420 Returns the request path
424 Parses the request path and sets the C<args>, C<action> and C<table>
429 The table part of the Maypole request path
433 The action part of the Maypole request path
437 A list of remaining parts of the request path after table and action
443 A L<Maypole::Headers> object containing HTTP headers for the request
447 A L<HTTP::Headers> object that contains HTTP headers for the output
451 Turns post data and query string paramaters into a hash of C<params>.
453 You should only need to define this method if you are writing a new
459 An accessor for request parameters. It behaves similarly to CGI::param() for
460 accessing CGI parameters.
464 Returns a hash of request parameters. The source of the parameters may vary
465 depending on the Maypole backend, but they are usually populated from request
466 query string and POST data.
468 B<Note:> Where muliple values of a parameter were supplied, the
471 will be an array reference.
473 =head3 get_template_root
475 Implementation-specific path to template root.
477 You should only need to define this method if you are writing a new
479 backend. Otherwise, see L<Maypole::Config/"template_root">
483 You should only need to define this method if you are writing a new
484 Maypole backend. It should return something that looks like an Apache
485 or CGI request object, it defaults to blank.
490 Returns a Maypole::Constant to indicate whether the request is valid.
492 The default implementation checks that C<$self-E<gt>table> is publicly
494 and that the model class is configured to handle the C<$self-E<gt>action>
498 Returns a Maypole::Constant to indicate whether the user is
502 The default implementation returns C<OK>
506 Returns the perl package name that will serve as the model for the
507 request. It corresponds to the request C<table> attribute.
509 =head3 additional_data
511 Called before the model processes the request, this method gives you a
513 to do some processing for each request, for example, manipulating
518 Get/set a list of model objects. The objects will be accessible in the
522 If the first item in C<$self-E<gt>args> can be C<retrieve()>d by the model
524 it will be removed from C<args> and the retrieved object will be added
526 C<objects> list. See L<Maypole::Model> for more information.
530 $self->template_args->{foo} = 'bar';
532 Get/set a hash of template variables.
536 Get/set the template to be used by the view. By default, it returns
541 This method is called if any exceptions are raised during the
544 model/view processing. It should accept the exception as a parameter and
546 a Maypole::Constant to indicate whether the request should continue to
552 Get/set a request error
556 Get/set the response output. This is usually populated by the view
558 can skip view processing by setting the C<output>.
560 =head3 document_encoding
562 Get/set the output encoding. Default: utf-8.
566 Get/set the output content type. Default: text/html
570 Sends the output and additional headers to the user.
572 =head3 call_authenticate
574 This method first checks if the relevant model class
575 can authenticate the user, or falls back to the default
576 authenticate method of your Maypole application.
579 =head3 call_exception
581 This model is called to catch exceptions, first after authenticate, then after
582 processing the model class, and finally to check for exceptions from the view
585 This method first checks if the relevant model class
586 can handle exceptions the user, or falls back to the default
587 exception method of your Maypole application.
589 =head3 make_random_id
591 returns a unique id for this request can be used to prevent or detect repeat
596 This method sets up the class if it's not done yet, sets some
597 defaults and leaves the dirty work to handler_guts.
601 This is the core of maypole. You don't want to know.
605 There's more documentation, examples, and a information on our mailing lists
606 at the Maypole web site:
608 L<http://maypole.perl.org/>
610 L<Maypole::Application>, L<Apache::MVC>, L<CGI::Maypole>.
614 Maypole is currently maintained by Simon Flack C<simonflk#cpan.org>
616 =head1 AUTHOR EMERITUS
618 Simon Cozens, C<simon#cpan.org>
620 Sebastian Riedel, C<sri#oook.de> maintained Maypole from 1.99_01 to 2.04
624 Sebastian Riedel, Danijel Milicevic, Dave Slack, Jesse Sheidlower, Jody Belka,
625 Marcus Ramberg, Mickael Joanne, Randal Schwartz, Simon Flack, Steve Simms,
626 Veljko Vidovic and all the others who've helped.
630 You may distribute this code under the same terms as Perl itself.