X-Git-Url: https://git.decadent.org.uk/gitweb/?a=blobdiff_plain;f=lib%2FApache%2FMVC.pm;h=cd4e96d2fc0550af8a0cdf7d6f007148a284257f;hb=c335fbb1eaabf2ada28ce78f69299a96b33f3759;hp=7869cfa45125630b03ed96f7b5d58ace40a7d501;hpb=a0b702113b5a868698f65a5a88c35d91227a775f;p=maypole.git diff --git a/lib/Apache/MVC.pm b/lib/Apache/MVC.pm index 7869cfa..cd4e96d 100644 --- a/lib/Apache/MVC.pm +++ b/lib/Apache/MVC.pm @@ -1,131 +1,190 @@ package Apache::MVC; -use base qw(Class::Accessor Class::Data::Inheritable); -use attributes (); -use Class::DBI::Loader; -use UNIVERSAL::require; -use Apache::Constants ":common"; -use strict; -use warnings; -our $VERSION = "1.0"; -__PACKAGE__->mk_classdata($_) for qw( _config init_done view_object ); -__PACKAGE__->mk_accessors ( qw( config ar params objects model_class -args action template )); -__PACKAGE__->config({}); -__PACKAGE__->init_done(0); - - -sub import { - my $real = shift; - if ($real ne "Apache::MVC") { - no strict 'refs'; - *{$real."::handler"} = sub { Apache::MVC::handler($real, @_) }; - } -} -# This is really dirty. -sub config { - my $self = shift; - if (ref $self) { return $self->_config_accessor(@_) } - return $self->_config(@_); -} - -sub set_database { - my ($calling_class, $dsn) = @_; - $calling_class = ref $calling_class if ref $calling_class; - $calling_class->config->{dsn} = $dsn; - $calling_class->config->{loader} = Class::DBI::Loader->new( - namespace => $calling_class, - dsn => $dsn - ); -} +our $VERSION = '2.05'; -sub init { - my $class = shift; - my $config = $class->config; - $config->{model} ||= "Apache::MVC::Model::CDBI"; - $config->{view} ||= "Apache::MVC::View::TT"; - $config->{model}->require; - $config->{view}->require; - $config->{classes} = [ $class->config->{loader}->classes ]; - $config->{display_tables} ||= [ $class->config->{loader}->tables ]; - for my $subclass (@{$config->{classes}}) { - no strict 'refs'; - push @{$subclass."::ISA"}, $class->config->{model}; - } - $class->view_object($class->config->{view}->new); - $class->init_done(1); +use strict; +use warnings; -} +use base 'Maypole'; +use mod_perl; -sub class_of { - my ($self, $table) = @_; - return $self->config->{loader}->_table2class($table); -} +use constant APACHE2 => $mod_perl::VERSION >= 1.99; -sub handler { - # See Apache::MVC::Workflow before trying to understand this. - my $class = shift; - $class->init unless $class->init_done; - my $r = bless { config => $class->config }, $class; - $r->get_request(); - $r->parse_location(); - - $r->model_class($r->class_of($r->{table})); - my $status = $r->is_applicable; - return $status unless $status == OK; - $status = $r->call_authenticate; - return $status unless $status == OK; - $r->additional_data(); - - $r->model_class->process($r); - $r->view_object->process($r); - return $r; # For debugging. +if (APACHE2) { + require Apache2; + require Apache::RequestIO; + require Apache::RequestRec; + require Apache::RequestUtil; + require APR::URI; } +else { require Apache } +require Apache::Request; sub get_request { - my $self = shift; - require Apache; require Apache::Request; - $self->{ar} = Apache::Request->new(Apache->request); + my ( $self, $r ) = @_; + $self->{ar} = Apache::Request->new($r); } sub parse_location { my $self = shift; - my $uri = $self->{ar}->path_info(); - my @pi = split /\//, $uri; - shift @pi while @pi and !$pi[0]; - $self->{table} = shift @pi; - $self->{action} = shift @pi; - $self->{args} = \@pi; - - $self->{params} = $self->{ar}->content; + $self->{path} = $self->{ar}->uri; + my $loc = $self->{ar}->location; + no warnings 'uninitialized'; + $self->{path} .= '/' if $self->{path} eq $loc; + $self->{path} =~ s/^($loc)?\///; + $self->parse_path; + $self->parse_args; } -sub is_applicable { +sub parse_args { my $self = shift; - my $config = $self->config; - my %ok = map {$_ => 1} @{$config->{display_tables}}; - return DECLINED() unless exists $ok{$self->{table}}; - - # Does the action method exist? - my $cv = $self->model_class->can($self->{action}); - return DECLINED() unless $cv; - - # Is it exported? - $self->{method_attribs} = join " ", attributes::get($cv); - return DECLINED() - unless $self->{method_attribs} =~ /\bExported\b/i; - return OK(); + $self->{params} = { $self->_mod_perl_args( $self->{ar} ) }; + $self->{query} = { $self->_mod_perl_args( $self->{ar} ) }; } -sub call_authenticate { - my $self = shift; - return $self->model_class->authenticate($self) if - $self->model_class->can("authenticate"); - return $self->authenticate(); +sub send_output { + my $r = shift; + $r->{ar}->content_type( + $r->{content_type} =~ m/^text/ + ? $r->{content_type} . "; charset=" . $r->{document_encoding} + : $r->{content_type} + ); + $r->{ar}->headers_out->set( + "Content-Length" => do { use bytes; length $r->{output} } + ); + APACHE2 || $r->{ar}->send_http_header; + $r->{ar}->print( $r->{output} ); } -sub additional_data {} +sub get_template_root { + my $r = shift; + $r->{ar}->document_root . "/" . $r->{ar}->location; +} -sub authenticate { return OK } +sub _mod_perl_args { + my ( $self, $apr ) = @_; + my %args; + foreach my $key ( $apr->param ) { + my @values = $apr->param($key); + $args{$key} = @values == 1 ? $values[0] : \@values; + } + return %args; +} 1; + +=head1 NAME + +Apache::MVC - Apache front-end to Maypole + +=head1 SYNOPSIS + + package BeerDB; + use base 'Apache::MVC'; + BeerDB->setup("dbi:mysql:beerdb"); + BeerDB->config->uri_base("http://your.site/"); + BeerDB->config->display_tables([qw[beer brewery pub style]]); + # Now set up your database: + # has-a relationships + # untaint columns + + 1; + +=head1 DESCRIPTION + +Maypole is a Perl web application framework to Java's struts. It is +essentially completely abstracted, and so doesn't know anything about +how to talk to the outside world. C is a mod_perl based +subclass of Maypole. + +To use it, you need to create a package which represents your entire +application. In our example above, this is the C package. + +This needs to first inherit from C, and then call setup. +This will give your package an Apache-compatible C subroutine, +and then pass any parameters onto the C method of the +model class. The default model class for Maypole uses L to +map a database to classes, but this can be changed by messing with the +configuration. (B calling setup.) + +Next, you should configure your application through the C +method. Configuration parameters at present are: + +=over + +=item uri_base + +You B specify this; it is the base URI of the application, which +will be used to construct links. + +=item display_tables + +If you do not want all of the tables in the database to be accessible, +then set this to a list of only the ones you want to display + +=item rows_per_page + +List output is paged if you set this to a positive number of rows. + +=back + +You should also set up relationships between your classes, such that, +for instance, calling C on a C object returns an +object representing its associated brewery. + +For a full example, see the included "beer database" application. + +=head1 INSTALLATION + +Create a driver module like the one above. + +Put the following in your Apache config: + + + SetHandler perl-script + PerlHandler BeerDB + + +Copy the templates found in F into the +F directory off the web root. When the designers get +back to you with custom templates, they are to go in +F. If you need to do override templates on a +database-table-by-table basis, put the new template in +F>. + +This will automatically give you C, C, C, C and +C commands; for instance, a list of breweries, go to + + http://your.site/beer/brewery/list + +For more information about how the system works and how to extend it, +see L. + +=head1 Implementation + +This class overrides a set of methods in the base Maypole class to provide it's +functionality. See L for these: + +=over + +=item get_request + +=item get_template_root + +=item parse_args + +=item parse_location + +=item send_output + +=back + +=head1 AUTHOR + +Simon Cozens, C +Marcus Ramberg, C +Screwed up by Sebastian Riedel, C + +=head1 LICENSE + +You may distribute this code under the same terms as Perl itself.