2 use base qw(Class::Accessor::Fast Class::Data::Inheritable);
3 use UNIVERSAL::require;
7 use Maypole::Constants;
10 our $VERSION = '2.10';
12 __PACKAGE__->mk_classdata($_) for qw( config init_done view_object );
13 __PACKAGE__->mk_accessors(
14 qw( ar params query objects model_class template_args output path
15 args action template error document_encoding content_type table
16 headers_in headers_out )
18 __PACKAGE__->config( Maypole::Config->new() );
19 __PACKAGE__->init_done(0);
24 my $calling_class = shift;
25 $calling_class = ref $calling_class if ref $calling_class;
28 no warnings 'redefine';
31 *{ $calling_class . "::handler" } =
32 sub { Maypole::handler( $calling_class, @_ ) };
34 my $config = $calling_class->config;
35 $config->model || $config->model("Maypole::Model::CDBI");
36 $config->model->require;
37 die "Couldn't load the model class $config->{model}: $@" if $@;
38 $config->model->setup_database( $config, $calling_class, @_ );
39 for my $subclass ( @{ $config->classes } ) {
41 unshift @{ $subclass . "::ISA" }, $config->model;
42 $config->model->adopt($subclass)
43 if $config->model->can("adopt");
49 my $config = $class->config;
50 $config->view || $config->view("Maypole::View::TT");
51 $config->view->require;
52 die "Couldn't load the view class " . $config->view . ": $@" if $@;
53 $config->display_tables
54 || $config->display_tables( $class->config->tables );
55 $class->view_object( $class->config->view->new );
62 # See Maypole::Workflow before trying to understand this.
63 my ( $class, $req ) = @_;
64 $class->init unless $class->init_done;
66 # Create the request object
69 config => $class->config
71 $r->headers_out(Maypole::Headers->new);
72 $r->get_request($req);
74 my $status = $r->handler_guts();
75 return $status unless $status == OK;
80 # The root of all evil
83 $r->model_class( $r->config->model->class_of( $r, $r->{table} ) );
85 my $applicable = $r->is_applicable;
86 unless ( $applicable == OK ) {
88 # It's just a plain template
89 delete $r->{model_class};
90 $r->{path} =~ s{/$}{}; # De-absolutify
91 $r->template( $r->{path} );
94 # We authenticate every request, needed for proper session management
96 eval { $status = $r->call_authenticate };
97 if ( my $error = $@ ) {
98 $status = $r->call_exception($error);
99 if ( $status != OK ) {
100 warn "caught authenticate error: $error";
101 return $r->debug ? $r->view_object->error( $r, $error ) : ERROR;
104 if ( $r->debug and $status != OK and $status != DECLINED ) {
105 $r->view_object->error( $r,
106 "Got unexpected status $status from calling authentication" );
108 return $status unless $status == OK;
110 # We run additional_data for every request
112 if ( $applicable == OK ) {
113 eval { $r->model_class->process($r) };
114 if ( my $error = $@ ) {
115 $status = $r->call_exception($error);
116 if ( $status != OK ) {
117 warn "caught model error: $error";
118 return $r->debug ? $r->view_object->error( $r, $error ) : ERROR;
122 if ( !$r->{output} ) { # You might want to do it yourself
123 eval { $status = $r->view_object->process($r) };
124 if ( my $error = $@ ) {
125 $status = $r->call_exception($error);
126 if ( $status != OK ) {
127 warn "caught view error: $error" if $r->debug;
128 return $r->debug ? $r->view_object->error( $r, $error ) : ERROR;
138 my $config = $self->config;
139 $config->ok_tables || $config->ok_tables( $config->display_tables );
140 $config->ok_tables( { map { $_ => 1 } @{ $config->ok_tables } } )
141 if ref $config->ok_tables eq "ARRAY";
142 warn "We don't have that table ($self->{table}).\n"
143 . "Available tables are: "
144 . join( ",", @{ $config->{display_tables} } )
146 and not $config->ok_tables->{ $self->{table} }
148 return DECLINED() unless exists $config->ok_tables->{ $self->{table} };
151 return DECLINED unless $self->model_class->is_public( $self->{action} );
155 sub call_authenticate {
158 # Check if we have a model class
159 if ( $self->{model_class} ) {
160 return $self->model_class->authenticate($self)
161 if $self->model_class->can("authenticate");
163 return $self->authenticate($self); # Interface consistency is a Good Thing
170 # Check if we have a model class
171 if ( $self->{model_class}
172 && $self->model_class->can('exception') )
174 my $status = $self->model_class->exception( $self, $error );
175 return $status if $status == OK;
177 return $self->exception($error);
180 sub additional_data { }
182 sub authenticate { return OK }
184 sub exception { return ERROR }
188 $self->{path} ||= "frontpage";
189 my @pi = $self->{path} =~ m{([^/]+)/?}g;
190 $self->{table} = shift @pi;
191 $self->{action} = shift @pi;
192 $self->{action} ||= "index";
193 $self->{args} = \@pi;
196 sub param { # like CGI::param(), but read-only
200 unless (exists $r->{params}{$key}) {
201 return wantarray() ? () : undef;
203 my $val = $r->{params}{$key};
205 return ref $val ? @$val : $val;
207 return ref $val ? $val->[0] : $val;
210 return keys %{$r->{params}};
214 sub get_template_root { "." }
218 die "Do not use Maypole directly; use Apache::MVC or similar";
222 die "Do not use Maypole directly; use Apache::MVC or similar";
225 # Session and Repeat Submission Handling
228 use Maypole::Session;
229 return Maypole::Session::generate_unique_id();
234 Maypole - MVC web application framework
238 See L<Maypole::Application>.
242 This documents the Maypole request object. See the L<Maypole::Manual>, for a
243 detailed guide to using Maypole.
245 Maypole is a Perl web application framework similar to Java's struts. It is
246 essentially completely abstracted, and so doesn't know anything about
247 how to talk to the outside world.
249 To use it, you need to create a package which represents your entire
250 application. In our example above, this is the C<BeerDB> package.
252 This needs to first use L<Maypole::Application> which will make your package
253 inherit from the appropriate platform driver such as C<Apache::MVC> or
254 C<CGI::Maypole>, and then call setup. This sets up the model classes and
255 configures your application. The default model class for Maypole uses
256 L<Class::DBI> to map a database to classes, but this can be changed by altering
257 configuration. (B<Before> calling setup.)
263 Returns the L<Maypole::Config> object
267 My::App->setup($data_source, $user, $password, \%attr);
269 Initialise the maypole application and model classes. Your application should
270 call this after setting configuration via L<"config">
274 You should not call this directly, but you may wish to override this to
276 application-specific initialisation.
280 Get/set the Maypole::View object
284 sub My::App::debug {1}
286 Returns the debugging flag. Override this in your application class to
287 enable/disable debugging.
289 =head2 INSTANCE METHODS
291 =head3 parse_location
293 Turns the backend request (e.g. Apache::MVC, Maypole, CGI) into a
295 request. It does this by setting the C<path>, and invoking C<parse_path>
299 You should only need to define this method if you are writing a new
305 Returns the request path
309 Parses the request path and sets the C<args>, C<action> and C<table>
314 The table part of the Maypole request path
318 The action part of the Maypole request path
322 A list of remaining parts of the request path after table and action
328 A L<Maypole::Headers> object containing HTTP headers for the request
332 A L<HTTP::Headers> object that contains HTTP headers for the output
336 Turns post data and query string paramaters into a hash of C<params>.
338 You should only need to define this method if you are writing a new
344 An accessor for request parameters. It behaves similarly to CGI::param() for
345 accessing CGI parameters.
349 Returns a hash of request parameters. The source of the parameters may vary
350 depending on the Maypole backend, but they are usually populated from request
351 query string and POST data.
353 B<Note:> Where muliple values of a parameter were supplied, the
356 will be an array reference.
358 =head3 get_template_root
360 Implementation-specific path to template root.
362 You should only need to define this method if you are writing a new
364 backend. Otherwise, see L<Maypole::Config/"template_root">
368 You should only need to define this method if you are writing a new
369 Maypole backend. It should return something that looks like an Apache
370 or CGI request object, it defaults to blank.
375 Returns a Maypole::Constant to indicate whether the request is valid.
377 The default implementation checks that C<$r-E<gt>table> is publicly
379 and that the model class is configured to handle the C<$r-E<gt>action>
383 Returns a Maypole::Constant to indicate whether the user is
387 The default implementation returns C<OK>
391 Returns the perl package name that will serve as the model for the
392 request. It corresponds to the request C<table> attribute.
394 =head3 additional_data
396 Called before the model processes the request, this method gives you a
398 to do some processing for each request, for example, manipulating
403 Get/set a list of model objects. The objects will be accessible in the
407 If the first item in C<$r-E<gt>args> can be C<retrieve()>d by the model
409 it will be removed from C<args> and the retrieved object will be added
411 C<objects> list. See L<Maypole::Model> for more information.
415 $r->template_args->{foo} = 'bar';
417 Get/set a hash of template variables.
421 Get/set the template to be used by the view. By default, it returns
426 This method is called if any exceptions are raised during the
429 model/view processing. It should accept the exception as a parameter and
431 a Maypole::Constant to indicate whether the request should continue to
437 Get/set a request error
441 Get/set the response output. This is usually populated by the view
443 can skip view processing by setting the C<output>.
445 =head3 document_encoding
447 Get/set the output encoding. Default: utf-8.
451 Get/set the output content type. Default: text/html
455 Sends the output and additional headers to the user.
457 =head3 call_authenticate
459 This method first checks if the relevant model class
460 can authenticate the user, or falls back to the default
461 authenticate method of your Maypole application.
464 =head3 call_exception
466 This model is called to catch exceptions, first after authenticate, then after
467 processing the model class, and finally to check for exceptions from the view
470 This method first checks if the relevant model class
471 can handle exceptions the user, or falls back to the default
472 exception method of your Maypole application.
474 =head3 make_random_id
476 returns a unique id for this request can be used to prevent or detect repeat submissions.
480 This method sets up the class if it's not done yet, sets some
481 defaults and leaves the dirty work to handler_guts.
485 This is the core of maypole. You don't want to know.
489 There's more documentation, examples, and a information on our mailing lists
490 at the Maypole web site:
492 L<http://maypole.perl.org/>
494 L<Maypole::Application>, L<Apache::MVC>, L<CGI::Maypole>.
498 Maypole is currently maintained by Simon Flack C<simonflk#cpan.org>
500 =head1 AUTHOR EMERITUS
502 Simon Cozens, C<simon#cpan.org>
504 Sebastian Riedel, C<sri#oook.de> maintained Maypole from 1.99_01 to 2.04
508 Sebastian Riedel, Danijel Milicevic, Dave Slack, Jesse Sheidlower, Jody Belka,
509 Marcus Ramberg, Mickael Joanne, Randal Schwartz, Simon Flack, Steve Simms,
510 Veljko Vidovic and all the others who've helped.
514 You may distribute this code under the same terms as Perl itself.