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* including plugins
15 # - double leading underscore - private to the current package
17 __PACKAGE__->mk_classdata($_) for qw( config init_done view_object );
18 __PACKAGE__->mk_accessors(
19 qw( params query objects model_class template_args output path
20 args action template error document_encoding content_type table
21 headers_in headers_out )
23 __PACKAGE__->config( Maypole::Config->new() );
24 __PACKAGE__->init_done(0);
30 my $calling_class = shift;
32 $calling_class = ref $calling_class if ref $calling_class;
34 my $config = $calling_class->config;
36 $config->model || $config->model('Maypole::Model::CDBI');
38 $config->model->require or die
39 "Couldn't load the model class $config->{model}: $@";
41 $config->model->setup_database($config, $calling_class, @_);
43 foreach my $subclass ( @{ $config->classes } )
46 unshift @{ $subclass . "::ISA" }, $config->model;
47 $config->model->adopt($subclass)
48 if $config->model->can("adopt");
55 my $config = $class->config;
56 $config->view || $config->view("Maypole::View::TT");
57 $config->view->require;
58 die "Couldn't load the view class " . $config->view . ": $@" if $@;
59 $config->display_tables
60 || $config->display_tables( $class->config->tables );
61 $class->view_object( $class->config->view->new );
66 # handler() has a method attribute so that mod_perl will invoke
67 # BeerDB->handler() as a method rather than a plain function
68 # BeerDB::handler() and so this inherited implementation will be
69 # found. See e.g. "Practical mod_perl" by Bekman & Cholet for
70 # more information <http://modperlbook.org/html/ch25_01.html>
73 # See Maypole::Workflow before trying to understand this.
74 my ($class, $req) = @_;
76 $class->init unless $class->init_done;
78 # Create the request object
81 config => $class->config
84 $r->headers_out(Maypole::Headers->new);
86 $r->get_request($req);
90 my $status = $r->handler_guts();
92 return $status unless $status == OK;
99 # The root of all evil
106 my $applicable = $r->is_applicable;
108 unless ( $applicable == OK )
110 # It's just a plain template
111 $r->model_class(undef);
114 $path =~ s{/$}{}; # De-absolutify
117 $r->template($r->path);
120 # We authenticate every request, needed for proper session management
123 eval { $status = $r->call_authenticate };
125 if ( my $error = $@ )
127 $status = $r->call_exception($error);
131 warn "caught authenticate error: $error";
132 return $r->debug ? $r->view_object->error($r, $error) : ERROR;
136 if ( $r->debug and $status != OK and $status != DECLINED )
138 $r->view_object->error( $r,
139 "Got unexpected status $status from calling authentication" );
142 return $status unless $status == OK;
144 # We run additional_data for every request
147 if ( $applicable == OK )
149 eval { $r->model_class->process($r) };
151 if ( my $error = $@ )
153 $status = $r->call_exception($error);
156 warn "caught model error: $error";
157 return $r->debug ? $r->view_object->error($r, $error) : ERROR;
162 # unusual path - perhaps output has been set to an error message
163 return OK if $r->output;
165 # normal path - no output has been generated yet
166 return $r->__call_process_view;
169 sub __call_process_view
175 eval { $status = $r->view_object->process($r) };
177 if ( my $error = $@ )
179 $status = $r->call_exception($error);
183 warn "caught view error: $error" if $r->debug;
184 return $r->debug ? $r->view_object->error($r, $error) : ERROR;
194 $r->model_class( $r->config->model->class_of($r, $r->table) );
199 my $config = $self->config;
200 $config->ok_tables || $config->ok_tables( $config->display_tables );
201 $config->ok_tables( { map { $_ => 1 } @{ $config->ok_tables } } )
202 if ref $config->ok_tables eq "ARRAY";
203 warn "We don't have that table ($self->{table}).\n"
204 . "Available tables are: "
205 . join( ",", @{ $config->{display_tables} } )
207 and not $config->ok_tables->{ $self->{table} }
209 return DECLINED() unless exists $config->ok_tables->{ $self->{table} };
212 return DECLINED unless $self->model_class->is_public( $self->{action} );
216 sub call_authenticate {
219 # Check if we have a model class
220 if ( $self->{model_class} ) {
221 return $self->model_class->authenticate($self)
222 if $self->model_class->can("authenticate");
224 return $self->authenticate($self); # Interface consistency is a Good Thing
231 # Check if we have a model class
232 if ( $self->{model_class}
233 && $self->model_class->can('exception') )
235 my $status = $self->model_class->exception( $self, $error );
236 return $status if $status == OK;
238 return $self->exception($error);
241 sub additional_data { }
243 sub authenticate { return OK }
245 sub exception { return ERROR }
249 $self->{path} ||= "frontpage";
250 my @pi = $self->{path} =~ m{([^/]+)/?}g;
251 $self->{table} = shift @pi;
252 $self->{action} = shift @pi;
253 $self->{action} ||= "index";
254 $self->{args} = \@pi;
257 sub param { # like CGI::param(), but read-only
261 unless (exists $r->{params}{$key}) {
262 return wantarray() ? () : undef;
264 my $val = $r->{params}{$key};
266 return ref $val ? @$val : $val;
268 return ref $val ? $val->[0] : $val;
271 return keys %{$r->{params}};
275 sub get_template_root { "." }
279 die "Do not use Maypole directly; use Apache::MVC or similar";
283 die "Do not use Maypole directly; use Apache::MVC or similar";
286 # Session and Repeat Submission Handling
289 use Maypole::Session;
290 return Maypole::Session::generate_unique_id();
295 Maypole - MVC web application framework
299 See L<Maypole::Application>.
303 This documents the Maypole request object. See the L<Maypole::Manual>, for a
304 detailed guide to using Maypole.
306 Maypole is a Perl web application framework similar to Java's struts. It is
307 essentially completely abstracted, and so doesn't know anything about
308 how to talk to the outside world.
310 To use it, you need to create a package which represents your entire
311 application. In our example above, this is the C<BeerDB> package.
313 This needs to first use L<Maypole::Application> which will make your package
314 inherit from the appropriate platform driver such as C<Apache::MVC> or
315 C<CGI::Maypole>, and then call setup. This sets up the model classes and
316 configures your application. The default model class for Maypole uses
317 L<Class::DBI> to map a database to classes, but this can be changed by altering
318 configuration. (B<Before> calling setup.)
324 Returns the L<Maypole::Config> object
328 My::App->setup($data_source, $user, $password, \%attr);
330 Initialise the maypole application and model classes. Your application should
331 call this after setting configuration via L<"config">
335 You should not call this directly, but you may wish to override this to
337 application-specific initialisation.
341 Get/set the Maypole::View object
345 sub My::App::debug {1}
347 Returns the debugging flag. Override this in your application class to
348 enable/disable debugging.
350 =head2 INSTANCE METHODS
352 =head3 parse_location
354 Turns the backend request (e.g. Apache::MVC, Maypole, CGI) into a
356 request. It does this by setting the C<path>, and invoking C<parse_path>
360 You should only need to define this method if you are writing a new
366 Returns the request path
370 Parses the request path and sets the C<args>, C<action> and C<table>
375 The table part of the Maypole request path
379 The action part of the Maypole request path
383 A list of remaining parts of the request path after table and action
389 A L<Maypole::Headers> object containing HTTP headers for the request
393 A L<HTTP::Headers> object that contains HTTP headers for the output
397 Turns post data and query string paramaters into a hash of C<params>.
399 You should only need to define this method if you are writing a new
405 An accessor for request parameters. It behaves similarly to CGI::param() for
406 accessing CGI parameters.
410 Returns a hash of request parameters. The source of the parameters may vary
411 depending on the Maypole backend, but they are usually populated from request
412 query string and POST data.
414 B<Note:> Where muliple values of a parameter were supplied, the
417 will be an array reference.
419 =head3 get_template_root
421 Implementation-specific path to template root.
423 You should only need to define this method if you are writing a new
425 backend. Otherwise, see L<Maypole::Config/"template_root">
429 You should only need to define this method if you are writing a new
430 Maypole backend. It should return something that looks like an Apache
431 or CGI request object, it defaults to blank.
436 Returns a Maypole::Constant to indicate whether the request is valid.
438 The default implementation checks that C<$r-E<gt>table> is publicly
440 and that the model class is configured to handle the C<$r-E<gt>action>
444 Returns a Maypole::Constant to indicate whether the user is
448 The default implementation returns C<OK>
452 Returns the perl package name that will serve as the model for the
453 request. It corresponds to the request C<table> attribute.
455 =head3 additional_data
457 Called before the model processes the request, this method gives you a
459 to do some processing for each request, for example, manipulating
464 Get/set a list of model objects. The objects will be accessible in the
468 If the first item in C<$r-E<gt>args> can be C<retrieve()>d by the model
470 it will be removed from C<args> and the retrieved object will be added
472 C<objects> list. See L<Maypole::Model> for more information.
476 $r->template_args->{foo} = 'bar';
478 Get/set a hash of template variables.
482 Get/set the template to be used by the view. By default, it returns
487 This method is called if any exceptions are raised during the
490 model/view processing. It should accept the exception as a parameter and
492 a Maypole::Constant to indicate whether the request should continue to
498 Get/set a request error
502 Get/set the response output. This is usually populated by the view
504 can skip view processing by setting the C<output>.
506 =head3 document_encoding
508 Get/set the output encoding. Default: utf-8.
512 Get/set the output content type. Default: text/html
516 Sends the output and additional headers to the user.
518 =head3 call_authenticate
520 This method first checks if the relevant model class
521 can authenticate the user, or falls back to the default
522 authenticate method of your Maypole application.
525 =head3 call_exception
527 This model is called to catch exceptions, first after authenticate, then after
528 processing the model class, and finally to check for exceptions from the view
531 This method first checks if the relevant model class
532 can handle exceptions the user, or falls back to the default
533 exception method of your Maypole application.
535 =head3 make_random_id
537 returns a unique id for this request can be used to prevent or detect repeat submissions.
541 This method sets up the class if it's not done yet, sets some
542 defaults and leaves the dirty work to handler_guts.
546 This is the core of maypole. You don't want to know.
550 There's more documentation, examples, and a information on our mailing lists
551 at the Maypole web site:
553 L<http://maypole.perl.org/>
555 L<Maypole::Application>, L<Apache::MVC>, L<CGI::Maypole>.
559 Maypole is currently maintained by Simon Flack C<simonflk#cpan.org>
561 =head1 AUTHOR EMERITUS
563 Simon Cozens, C<simon#cpan.org>
565 Sebastian Riedel, C<sri#oook.de> maintained Maypole from 1.99_01 to 2.04
569 Sebastian Riedel, Danijel Milicevic, Dave Slack, Jesse Sheidlower, Jody Belka,
570 Marcus Ramberg, Mickael Joanne, Randal Schwartz, Simon Flack, Steve Simms,
571 Veljko Vidovic and all the others who've helped.
575 You may distribute this code under the same terms as Perl itself.