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 base qw(Apache::MVC::Base Maypole);
+use Apache;
+use Apache::Request;
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, @_) };
- }
+
+our $VERSION = "0.3";
+
+sub get_request {
+ shift->{ar} = Apache::Request->new( Apache->request );
}
-# This is really dirty.
-sub config {
+sub parse_args {
my $self = shift;
- if (ref $self) { return $self->_config_accessor(@_) }
- return $self->_config(@_);
+ $self->{params} = { $self->{ar}->content };
+ while ( my ( $key, $value ) = each %{ $self->{params} } ) {
+ $self->{params}{$key} = '' unless defined $value;
+ }
+ $self->{query} = { $self->{ar}->args };
}
-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
- );
-}
+1;
-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';
- unshift @{$subclass."::ISA"}, $class->config->{model};
- $config->{model}->adopt($subclass)
- if $config->{model}->can("adopt");
- }
- $class->view_object($class->config->{view}->new);
- $class->init_done(1);
+=head1 NAME
-}
+Apache::MVC - Apache front-end to Maypole
-sub class_of {
- my ($self, $table) = @_;
- return $self->config->{loader}->_table2class($table);
-}
+=head1 SYNOPSIS
-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.
-}
+ 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
-sub get_request {
- my $self = shift;
- require Apache; require Apache::Request;
- $self->{ar} = Apache::Request->new(Apache->request);
-}
+ 1;
-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;
+=head1 DESCRIPTION
- $self->{params} = { $self->{ar}->content };
-}
+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<Apache::MVC> is a mod_perl based
+subclass of Maypole.
-sub is_applicable {
- my $self = shift;
- my $config = $self->config;
- my %ok = map {$_ => 1} @{$config->{display_tables}};
- warn "We don't have that table ($self->{table})"
- unless $ok{$self->{table}};
- return DECLINED() unless exists $ok{$self->{table}};
-
- # Does the action method exist?
- # XXX We should set the method class to the class for the table
- my $cv = $self->model_class->can($self->{action});
- warn "We don't have that action ($self->{action})" unless $cv;
- return DECLINED() unless $cv;
-
- # Is it exported?
- $self->{method_attribs} = join " ", attributes::get($cv);
- do { warn "$self->{action} not exported";
- return DECLINED()
- } unless $self->{method_attribs} =~ /\bExported\b/i;
- return OK();
-}
+To use it, you need to create a package which represents your entire
+application. In our example above, this is the C<BeerDB> package.
-sub call_authenticate {
- my $self = shift;
- return $self->model_class->authenticate($self) if
- $self->model_class->can("authenticate");
- return $self->authenticate();
-}
+This needs to first inherit from C<Apache::MVC>, and then call setup.
+This will give your package an Apache-compatible C<handler> subroutine,
+and then pass any parameters onto the C<setup_database> method of the
+model class. The default model class for Maypole uses L<Class::DBI> to
+map a database to classes, but this can be changed by messing with the
+configuration. (B<Before> calling setup.)
-sub additional_data {}
+Next, you should configure your application through the C<config>
+method. Configuration parameters at present are:
-sub authenticate { return OK }
+=over
-1;
+=item uri_base
+
+You B<must> 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<brewery> on a C<BeerDB::Beer> 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:
+
+ <Location /beer>
+ SetHandler perl-script
+ PerlHandler BeerDB
+ </Location>
+
+Copy the templates found in F<templates/factory> into the
+F<beer/factory> directory off the web root. When the designers get
+back to you with custom templates, they are to go in
+F<beer/custom>. If you need to do override templates on a
+database-table-by-table basis, put the new template in
+F<beer/I<table>>.
+
+This will automatically give you C<add>, C<edit>, C<list>, C<view> and
+C<delete> 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<Maypole>.
+
+=head1 AUTHOR
+
+Simon Cozens, C<simon@cpan.org>
+Screwed up by Sebastian Riedel, C<sri@oook.de>
+
+=head1 LICENSE
+
+You may distribute this code under the same terms as Perl itself.
projects / maypole.git / blobdiff