X-Git-Url: https://git.decadent.org.uk/gitweb/?a=blobdiff_plain;f=lib%2FMaypole.pm;h=83607c8db34137662cf0694cf8a494179d319d18;hb=f94c2679992bf0db0b360a0a475b3e646466aee0;hp=5d3e25963c7f2d29fb8c2f3286ba5031b44c9a25;hpb=3886be13f39d6d3fc8d0b76d4716175df1bb8056;p=maypole.git diff --git a/lib/Maypole.pm b/lib/Maypole.pm index 5d3e259..83607c8 100644 --- a/lib/Maypole.pm +++ b/lib/Maypole.pm @@ -3,12 +3,17 @@ use base qw(Class::Accessor::Fast Class::Data::Inheritable); use UNIVERSAL::require; use strict; use warnings; +use Data::Dumper; use Maypole::Config; use Maypole::Constants; use Maypole::Headers; use URI(); +use URI::QueryParam; +use NEXT; +use File::MMagic::XS qw(:compat); our $VERSION = '2.11'; +our $mmagic = File::MMagic::XS->new(); # proposed privacy conventions: # - no leading underscore - public to custom application code and plugins @@ -199,7 +204,7 @@ __PACKAGE__->mk_classdata($_) for qw( config init_done view_object model_classes __PACKAGE__->mk_accessors( qw( params query objects model_class template_args output path args action template error document_encoding content_type table - headers_in headers_out stash status) + headers_in headers_out stash status parent) ); __PACKAGE__->config( Maypole::Config->new() ); @@ -250,7 +255,7 @@ Some packages respond to higher debug levels, try increasing it to 2 or 3. =cut -sub debug { 0 } +sub debug { 1 } =item config @@ -258,20 +263,34 @@ Returns the L object =item setup - My::App->setup($data_source, $user, $password, \%attr); - -Initialise the Maypole application and plugins and model classes - see -L. - -If your model is based on L, the C<\%attr> hashref can -contain options that are passed directly to L, to control -how the model hierarchy is constructed. + My::App->setup($data_source, $user, $password, \%attr); +Initialise the Maypole application and plugins and model classes. Your application should call this B setting up configuration data via L<"config">. +It calls the hook C to setup the model. The %attr hash contains +options and arguments used to set up the model. See the particular model's +documentation. However here is the most usage of setup where +Maypole::Model::CDBI is the base class. + + My::App->setup($data_source, $user, $password, + { options => { # These are DB connection options + AutoCommit => 0, + RaiseError => 1, + ... + }, + # These are Class::DBI::Loader arguments. + relationships => 1, + ... + } + ); + +Also, see L. + =cut + sub setup { my $class = shift; @@ -290,35 +309,31 @@ don't need to load them in the driver. =cut -sub setup_model -{ - my $class = shift; - - $class = ref $class if ref $class; - - my $config = $class->config; - - $config->model || $config->model('Maypole::Model::CDBI'); - - $config->model->require or die sprintf - "Couldn't load the model class %s: %s", $config->model, $@; - - # among other things, this populates $config->classes - $config->model->setup_database($config, $class, @_); - - foreach my $subclass ( @{ $config->classes } ) - { - next if $subclass->isa("Maypole::Model::Base"); - no strict 'refs'; - unshift @{ $subclass . "::ISA" }, $config->model; - - # Load custom model code, if it exists - nb this must happen after the - # unshift, to allow code attributes to work, but before adopt(), - # in case adopt() calls overridden methods on $subclass - $class->load_model_subclass($subclass) unless ($class->model_classes_loaded()); - - $config->model->adopt($subclass) if $config->model->can("adopt"); - } +sub setup_model { + my $class = shift; + $class = ref $class if ref $class; + my $config = $class->config; + $config->model || $config->model('Maypole::Model::CDBI'); + $config->model->require or die sprintf + "Couldn't load the model class %s: %s", $config->model, $@; + + # among other things, this populates $config->classes + $config->model->setup_database($config, $class, @_); + + foreach my $subclass ( @{ $config->classes } ) { + next if $subclass->isa("Maypole::Model::Base"); + no strict 'refs'; + unshift @{ $subclass . "::ISA" }, $config->model; + } + + # Load custom model code, if it exists - nb this must happen after the + # unshift, to allow code attributes to work, but before adopt(), + # in case adopt() calls overridden methods on $subclass + foreach my $subclass ( @{ $config->classes } ) { + $class->load_model_subclass($subclass) unless ($class->model_classes_loaded()); + $config->model->adopt($subclass) if $config->model->can("adopt"); + } + } =item load_model_subclass($subclass) @@ -327,32 +342,32 @@ This method is called from C. It attempts to load the C<$subclass> package, if one exists. So if you make a customized C package, you don't need to explicitly load it. -If, perhaps during development, you don't want to load up custom classes, you +If automatic loading causes problems, Override load_model_subclass in your driver. + +sub load_model_subclass {}; + +Or perhaps during development, if you don't want to load up custom classes, you can override this method and load them manually. =cut -sub load_model_subclass -{ - my ($class, $subclass) = @_; - - my $config = $class->config; - - # Load any external files for the model base class or subclasses - # (e.g. BeerDB/DBI.pm or BeerDB/Beer.pm) based on code borrowed from - # Maypole::Plugin::Loader and Class::DBI. - if ( $subclass->require ) - { - warn "Loaded external module for '$subclass'\n" if $class->debug > 1; - } - else - { - (my $filename = $subclass) =~ s!::!/!g; - die "Loading '$subclass' failed: $@\n" - unless $@ =~ /Can\'t locate \Q$filename\E\.pm/; - warn "No external module for '$subclass'" - if $class->debug > 1; - } +sub load_model_subclass { + my ($class, $subclass) = @_; + + my $config = $class->config; + + # Load any external files for the model base class or subclasses + # (e.g. BeerDB/DBI.pm or BeerDB/Beer.pm) based on code borrowed from + # Maypole::Plugin::Loader and Class::DBI. + if ( $subclass->require ) { + warn "Loaded external module for '$subclass'\n" if $class->debug > 1; + } else { + (my $filename = $subclass) =~ s!::!/!g; + die "Loading '$subclass' failed: $@\n" + unless $@ =~ /Can\'t locate \Q$filename\E\.pm/; + warn "No external module for '$subclass'" + if $class->debug > 1; + } } =item init @@ -419,39 +434,87 @@ leaves the dirty work to C. # BeerDB::handler() and so this inherited implementation will be # found. See e.g. "Practical mod_perl" by Bekman & Cholet for # more information -sub handler : method -{ - # See Maypole::Workflow before trying to understand this. - my ($class, $req) = @_; +sub handler : method { + # See Maypole::Workflow before trying to understand this. + my ($class, $req) = @_; - $class->init unless $class->init_done; + $class->init unless $class->init_done; - my $self = $class->new; + my $self = $class->new; - # initialise the request - $self->headers_out(Maypole::Headers->new); - $self->get_request($req); - $self->parse_location; + # initialise the request + $self->headers_out(Maypole::Headers->new); + $self->get_request($req); + + $self->parse_location; + + # hook useful for declining static requests e.g. images, or perhaps for + # sanitizing request parameters + $self->status(Maypole::Constants::OK()); # set the default + $self->__call_hook('start_request_hook'); + return $self->status unless $self->status == Maypole::Constants::OK(); - # hook useful for declining static requests e.g. images, or perhaps for - # sanitizing request parameters - $self->status(Maypole::Constants::OK()); # set the default - $self->__call_hook('start_request_hook'); - return $self->status unless $self->status == Maypole::Constants::OK(); + die "status undefined after start_request_hook()" unless defined + $self->status; - die "status undefined after start_request_hook()" unless defined - $self->status; + $self->get_session; + $self->get_user; - $self->get_session; + my $status = $self->handler_guts; + + return $status unless $status == OK; + + # TODO: require send_output to return a status code + $self->send_output; + + return $status; +} + +=item component + + Run Maypole sub-requests as a component of the request + + [% request.component("/beer/view_as_component/20") %] + + Allows you to integrate the results of a Maypole request into an existing +request. You'll need to set up actions and templates +which return fragments of HTML rather than entire pages, but once you've +done that, you can use the C method of the Maypole request object +to call those actions. You may pass a query string in the usual URL style. + +You should not fully qualify the Maypole URLs. + +Note: any HTTP POST or URL parameters passed to the parent are not passed to the +component sub-request, only what is included in the url passed as an argyument +to the method + +=cut + +sub component { + my ( $r, $path ) = @_; + my $self = bless { parent => $r, config => $r->{config}, template_args => {}, }, ref $r; $self->get_user; - - my $status = $self->handler_guts; - return $status unless $status == OK; - - # TODO: require send_output to return a status code - $self->send_output; + my $url = URI->new($path); + warn "path : $path\n"; + $self->{path} = $url->path; + $self->parse_path; + $self->params( $url->query_form_hash ); + $self->handler_guts; + return $self->output; +} - return $status; +sub get_template_root { + my $self = shift; + my $r = shift; + return $r->parent->get_template_root if $r->{parent}; + return $self->NEXT::DISTINCT::get_template_root( $r, @_ ); +} + +sub view_object { + my $self = shift; + my $r = shift; + return $r->parent->view_object if $r->{parent}; + return $self->NEXT::DISTINCT::view_object( $r, @_ ); } # Instead of making plugin authors use the NEXT::DISTINCT hoopla to ensure other @@ -503,18 +566,15 @@ sub handler_guts $self->__load_request_model; - my $applicable = $self->is_model_applicable; - - $self->__setup_plain_template unless $applicable; + my $applicable = $self->is_model_applicable == OK; my $status; + # handle authentication eval { $status = $self->call_authenticate }; - if ( my $error = $@ ) { $status = $self->call_exception($error, "authentication"); - if ( $status != OK ) { warn "caught authenticate error: $error"; @@ -522,40 +582,65 @@ sub handler_guts $self->view_object->error($self, $error) : ERROR; } } - if ( $self->debug and $status != OK and $status != DECLINED ) { $self->view_object->error( $self, "Got unexpected status $status from calling authentication" ); } - + return $status unless $status == OK; # We run additional_data for every request $self->additional_data; - - if ($applicable) - { - eval { $self->model_class->process($self) }; - - if ( my $error = $@ ) + + if ($applicable) { + eval { $self->model_class->process($self) }; + if ( my $error = $@ ) { - $status = $self->call_exception($error, "model"); - - if ( $status != OK ) + $status = $self->call_exception($error, "model"); + if ( $status != OK ) { - warn "caught model error: $error"; - return $self->debug ? - $self->view_object->error($self, $error) : ERROR; + warn "caught model error: $error"; + return $self->debug ? + $self->view_object->error($self, $error) : ERROR; } } + } else { + $self->__setup_plain_template; } - + # less frequent path - perhaps output has been set to an error message return OK if $self->output; - + # normal path - no output has been generated yet - return $self->__call_process_view; + my $processed_view_ok = $self->__call_process_view; + + $self->{content_type} ||= $self->__get_mime_type(); + $self->{document_encoding} ||= "utf-8"; + + + return $processed_view_ok; +} + +my %filetypes = ( + 'js' => 'text/javascript', + 'css' => 'text/css', + 'htm' => 'text/html', + 'html' => 'text/html', + ); + +sub __get_mime_type { + my $self = shift; + my $type = 'text/html'; + if ($self->path =~ m/.*\.(\w{3,4})$/) { + $type = $filetypes{$1}; + } else { + my $output = $self->output; + if (defined $output) { + $type = $mmagic->checktype_contents($output); + } + } + return $type; } sub __load_request_model @@ -570,7 +655,7 @@ sub __load_request_model sub __setup_plain_template { my ($self) = @_; - + # It's just a plain template $self->model_class(undef); @@ -583,27 +668,24 @@ sub __setup_plain_template # The model has been processed or skipped (if is_applicable returned false), # any exceptions have been handled, and there's no content in $self->output -sub __call_process_view -{ - my ($self) = @_; - - my $status; - - eval { $status = $self->view_object->process($self) }; - - if ( my $error = $@ ) - { - $status = $self->call_exception($error, "view"); - - if ( $status != OK ) - { - warn "caught view error: $error" if $self->debug; - return $self->debug ? - $self->view_object->error($self, $error) : ERROR; - } +sub __call_process_view { + my ($self) = @_; + + my $status = eval { $self->view_object->process($self) }; + + my $error = $@ || $self->{error}; + + if ( $error ) { + $status = $self->call_exception($error, "view"); + + if ( $status != OK ) { + warn "caught view error: $error" if $self->debug; + return $self->debug ? + $self->view_object->error($self, $error) : ERROR; } - - return $status; + } + + return $status; } =item get_request @@ -684,6 +766,10 @@ from a Maypole:Constant to a true/false value. Returns a Maypole::Constant to indicate whether the request is valid. +=cut + +sub is_applicable { return shift->is_model_applicable(@_); } + =item is_model_applicable Returns true or false to indicate whether the request is valid. @@ -694,17 +780,8 @@ C<< $r->action >>. =cut -sub is_model_applicable -{ +sub is_model_applicable { my ($self) = @_; - - # cater for applications that are using obsolete version - if ($self->can('is_applicable')) - { - warn "DEPRECATION WARNING: rewrite is_applicable to the interface ". - "of Maypole::is_model_applicable\n"; - return $self->is_applicable == OK; - } # Establish which tables should be processed by the model my $config = $self->config; @@ -733,17 +810,17 @@ sub is_model_applicable . join( ",", keys %$ok_tables ) if $self->debug and not $ok_tables->{$table}; - return 0; + return DECLINED; } # Is the action public? my $action = $self->action; - return 1 if $self->model_class->is_public($action); + return OK if $self->model_class->is_public($action); warn "The action '$action' is not applicable to the table '$table'" - if $self->debug; + if $self->debug; - return 0; + return DECLINED; } =item get_session @@ -1042,8 +1119,6 @@ backend. Otherwise, see L =cut -sub get_template_root {'.'} - =back =head2 Request properties @@ -1367,8 +1442,7 @@ L, L, L. =head1 AUTHOR -Maypole is currently maintained by Aaron Trevena, David Baird, Dave Howorth and -Peter Speltz. +Maypole is currently maintained by Aaron Trevena. =head1 AUTHOR EMERITUS