X-Git-Url: https://git.decadent.org.uk/gitweb/?a=blobdiff_plain;f=lib%2FApache%2FMVC.pm;h=0f91e9a853d7c3deb1eefd34cce8371f0eeb66eb;hb=7913f720113bfd85b59a9fed57a60ec7a665fb39;hp=5d999be45e93d971dcb6a1586fef27cceb03b9d5;hpb=b4c877459674a8da7943533c780f807f3a355906;p=maypole.git diff --git a/lib/Apache/MVC.pm b/lib/Apache/MVC.pm index 5d999be..0f91e9a 100644 --- a/lib/Apache/MVC.pm +++ b/lib/Apache/MVC.pm @@ -1,45 +1,85 @@ package Apache::MVC; -use base 'Maypole'; -use Apache; -use Apache::Request; + +our $VERSION = '2.05'; + use strict; use warnings; -our $VERSION = "0.3"; + +use base 'Maypole'; +use mod_perl; + +use constant APACHE2 => $mod_perl::VERSION >= 1.99; + +if (APACHE2) { + require Apache2; + require Apache::RequestRec; + require Apache::RequestUtil; + require APR::URI; +} +else { require Apache } +require Apache::Request; sub get_request { - shift->{ar} = Apache::Request->new(Apache->request); + my ( $self, $r ) = @_; + $self->{ar} = Apache::Request->new($r); } sub parse_location { my $self = shift; $self->{path} = $self->{ar}->uri; my $loc = $self->{ar}->location; - $self->{path} =~ s/^$loc//; # I shouldn't need to do this? - $self->{path} ||= "frontpage"; - my @pi = split /\//, $self->{path}; - shift @pi while @pi and !$pi[0]; - $self->{table} = shift @pi; - $self->{action} = shift @pi; - $self->{args} = \@pi; - - $self->{params} = { $self->{ar}->content }; - $self->{query} = { $self->{ar}->args }; + no warnings 'uninitialized'; + $self->{path} =~ s/^($loc)?\///; + $self->parse_path; + $self->parse_args; +} + +sub parse_args { + my $self = shift; + $self->{params} = { $self->_mod_perl_args( $self->{ar} ) }; + $self->{query} = { $self->_mod_perl_args( $self->{ar} ) }; +} + +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" => length $r->{output} ); + APACHE2 || $r->{ar}->send_http_header; + $r->{ar}->print( $r->{output} ); +} + +sub get_template_root { + my $r = shift; + $r->{ar}->document_root . "/" . $r->{ar}->location; +} + +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 - Web front end to a data source +Apache::MVC - Apache front-end to Maypole =head1 SYNOPSIS package BeerDB; use base 'Apache::MVC'; - sub handler { Apache::MVC::handler("BeerDB", @_) } - BeerDB->set_database("dbi:mysql:beerdb"); - BeerDB->config->{uri_base} = "http://your.site/"; - BeerDB->config->{display_tables} = [qw[beer brewery pub style]]; + 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 @@ -48,106 +88,98 @@ Apache::MVC - Web front end to a data source =head1 DESCRIPTION -A large number of web programming tasks follow the same sort of pattern: -we have some data in a datasource, typically a relational database. We -have a bunch of templates provided by web designers. We have a number of -things we want to be able to do with the database - create, add, edit, -delete records, view records, run searches, and so on. We have a web -server which provides input from the user about what to do. Something in -the middle takes the input, grabs the relevant rows from the database, -performs the action, constructs a page, and spits it out. - -This module aims to be the most generic and extensible "something in the -middle". - -An example would help explain this best. You need to add a product -catalogue to a company's web site. Users need to list the products in -various categories, view a page on each product with its photo and -pricing information and so on, and there needs to be a back-end where -sales staff can add new lines, change prices, and delete out of date -records. So, you set up the database, provide some default templates -for the designers to customize, and then write an Apache handler like -this: - - package ProductDatabase; - use base 'Apache::MVC'; - __PACKAGE__->set_database("dbi:mysql:products"); - BeerDB->config->{uri_base} = "http://your.site/catalogue/"; - ProductDatabase::Product->has_a("category" => ProductDatabase::Category); - # ... - - sub authenticate { - my ($self, $request) = @_; - return OK if $request->{ar}->get_remote_host() eq "sales.yourcorp.com"; - return OK if $request->{action} =~ /^(view|list)$/; - return DECLINED; - } - 1; +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 -You then put the following in your Apache config: +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 ProductDatabase + PerlHandler BeerDB -And copy the templates found in F into the -F directory off the web root. When the designers get +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 +F. If you need to do override templates on a database-table-by-table basis, put the new template in -F>. +F>. This will automatically give you C, C, C, C and -C commands; for instance, a product list, go to +C commands; for instance, a list of breweries, go to - http://your.site/catalogue/product/list + http://your.site/beer/brewery/list -For a full example, see the included "beer database" application. +For more information about how the system works and how to extend it, +see L. -=head1 HOW IT WORKS +=head1 Implementation -There's some documentation for the workflow in L, -but the basic idea is that a URL part like C gets -translated into a call to Clist>. This -propagates the request with a set of objects from the database, and then -calls the C template; first, a C template if it -exists, then the C and finally C. +This class overrides a set of methods in the base Maypole class to provide it's +functionality. See L for these: -If there's another action you want the system to do, you need to either -subclass the model class, and configure your class slightly differently: +=over - package ProductDatabase::Model; - use base 'Apache::MVC::Model::CDBI'; - - sub supersearch :Exported { - my ($self, $request) = @_; - # Do stuff, get a bunch of objects back - $r->objects(\@objects); - $r->template("template_name"); - } +=item get_request - ProductDatabase->config->{model_class} = "ProductDatabase::Model"; +=item get_template_root -(The C<:Exported> attribute means that the method can be called via the -URL C/supersearch/...>.) +=item parse_args -Alternatively, you can put the method directly into the specific model -class for the table: +=item parse_location - sub ProductDatabase::Product::supersearch :Exported { ... } +=item send_output -By default, the view class uses Template Toolkit as the template -processor, and the model class uses C; it may help you to be -familiar with these modules before going much further with this, -although I expect there to be other subclasses for other templating -systems and database abstraction layers as time goes on. The article at -C is a great -introduction to the process we're trying to automate. +=back =head1 AUTHOR Simon Cozens, C +Marcus Ramberg, C +Screwed up by Sebastian Riedel, C =head1 LICENSE