Revision history for Perl extension Maypole
+1.8 XXX XXX XX XX:XX:XX XXX XXXX
+ - Added parse_args() (Simon Flack)
+ - call additional_data() and authenticate() for plain templates
+ - added Apache2::MVC mod_perl2 front-end
+ - added Maypole::Application universal loader
+ - added Apache::MVC::Base base class for Apache front-ends
+
+1.7 Sat Jul 17 20:15:26 BST 2004
+ - Emergency release - we lost the "use Maypole::Constants" from
+ CLI.pm somehow
+
+1.6 Fri Jul 16 23:51:21 BST 2004
+ - Two very trivial fixes:
+ - Put ::Plain in the MANIFEST, so it actually ships this time
+ - Make CLI test == OK, not just true
+
1.5 Mon Jun 21 14:36:54 BST 2004
- CLI mode correctly uses Constants module
- Template footers as well as headers (Markus Ramberg)
-TODO:
-Write tests
+See http://wiki.simon-cozens.org/?MaypoleToDo
+
package Apache::MVC;
-use base 'Maypole';
+
+use base qw(Apache::MVC::Base Maypole);
use Apache;
use Apache::Request;
use strict;
use warnings;
+
our $VERSION = "0.3";
sub get_request {
- shift->{ar} = Apache::Request->new(Apache->request);
+ shift->{ar} = Apache::Request->new( Apache->request );
}
-sub parse_location {
+sub parse_args {
my $self = shift;
- $self->{path} = $self->{ar}->uri;
- my $loc = $self->{ar}->location;
- no warnings 'uninitialized';
- $self->{path} =~ s/^($loc)?\///;
- $self->parse_path;
-
$self->{params} = { $self->{ar}->content };
- while (my ($key, $value) = each %{$self->{params}}) {
- $self->{params}{$key} = '' unless defined $value;
+ while ( my ( $key, $value ) = each %{ $self->{params} } ) {
+ $self->{params}{$key} = '' unless defined $value;
}
- $self->{query} = { $self->{ar}->args };
-}
-
-sub send_output {
- my $r = shift;
- $r->{ar}->content_type($r->{content_type});
- $r->{ar}->headers_out->set("Content-Length" => length $r->{output});
- $r->{ar}->send_http_header;
- $r->{ar}->print($r->{output});
-}
-
-sub get_template_root {
- my $r = shift;
- $r->{ar}->document_root . "/". $r->{ar}->location;
+ $self->{query} = { $self->{ar}->args };
}
1;
=head1 AUTHOR
Simon Cozens, C<simon@cpan.org>
+Screwed up by Sebastian Riedel, C<sri@oook.de>
=head1 LICENSE
--- /dev/null
+package Apache::MVC::Base;
+
+use strict;
+use warnings;
+
+sub parse_location {
+ my $self = shift;
+ $self->{path} = $self->{ar}->uri;
+ my $loc = $self->{ar}->location;
+ no warnings 'uninitialized';
+ $self->{path} =~ s/^($loc)?\///;
+ $self->parse_path;
+ $self->parse_args;
+}
+
+sub send_output {
+ my $r = shift;
+ $r->{ar}->content_type( $r->{content_type} );
+ $r->{ar}->headers_out->set( "Content-Length" => length $r->{output} );
+ $r->{ar}->send_http_header;
+ $r->{ar}->print( $r->{output} );
+}
+
+sub get_template_root {
+ my $r = shift;
+ $r->{ar}->document_root . "/" . $r->{ar}->location;
+}
+
+1;
+
+=head1 NAME
+
+Apache::MVC::Base - Apache front-end base class
+
+=head1 SYNOPSIS
+
+ use base 'Apache::Maypole::Base';
+
+=head1 DESCRIPTION
+
+The base class for the Apache and Apache2 front-ends.
+
+=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.
--- /dev/null
+package Apache2::MVC;
+
+use base qw(Apache::MVC::Base Maypole);
+use Apache2;
+use Apache::RequestRec;
+use Apache::RequestUtil;
+use Apache::Request;
+use APR::URI;
+use strict;
+use warnings;
+
+our $VERSION = "0.1";
+
+sub get_request {
+ my ( $self, $r ) = @_;
+ $self->{ar} = Apache::Request->new($r);
+}
+
+sub parse_args {
+ my $self = shift;
+ $self->{params} = { $self->_mod_perl_args( $self->{ar} ) };
+ $self->{query} = { $self->_mod_perl_args( $self->{ar} ) };
+}
+
+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
+
+Apache2::MVC - Apache2 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<Apache2::MVC> is a mod_perl2 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<BeerDB> package.
+
+This needs to first inherit from C<Apache2::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.)
+
+Next, you should configure your application through the C<config>
+method. Configuration parameters at present are:
+
+=over
+
+=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>
+Marcus Ramberg, C<marcus@thefeed.no>
+Screwed up by Sebastian Riedel, C<sri@oook.de>
+
+=head1 LICENSE
+
+You may distribute this code under the same terms as Perl itself.
use UNIVERSAL::require;
use strict;
use warnings;
-our $VERSION = "1.7";
+our $VERSION = "1.8";
__PACKAGE__->mk_classdata($_) for qw( config init_done view_object );
__PACKAGE__->mk_accessors ( qw( ar params query objects model_class
args action template ));
my $class = shift;
$class->init unless $class->init_done;
my $r = bless { config => $class->config }, $class;
- $r->get_request(@_);
+ $r->get_request();
$r->parse_location();
my $status = $r->handler_guts();
return $status unless $status == OK;
- $r->{content_type} ||= "text/html";
$r->send_output;
return $status;
}
sub handler_guts {
my $r = shift;
$r->model_class($r->config->{model}->class_of($r, $r->{table}));
- my $status = $r->is_applicable;
- if ($status == OK) {
- $status = $r->call_authenticate;
- if ($r->debug and $status != OK and $status != DECLINED) {
- $r->view_object->error($r,
- "Got unexpected status $status from calling authentication");
- }
- return $status unless $status == OK;
- $r->additional_data();
-
- $r->model_class->process($r);
- } else {
- # Otherwise, it's just a plain template.
+ my $applicable = $r->is_applicable;
+ unless ($applicable == OK) {
+ # It's just a plain template
delete $r->{model_class};
$r->{path} =~ s{/}{}; # De-absolutify
$r->template($r->{path});
}
+ # We authenticate every request, needed for proper session management
+ my $status = $r->call_authenticate;
+ if ($r->debug and $status != OK and $status != DECLINED) {
+ $r->view_object->error($r,
+ "Got unexpected status $status from calling authentication");
+ }
+ return $status unless $status == OK;
+ # We run additional_data for every request
+ $r->additional_data;
+ if ($applicable == OK) {
+ $r->model_class->process($r);
+ }
if (!$r->{output}) { # You might want to do it yourself
return $r->view_object->process($r);
} else { return OK; }
sub call_authenticate {
my $self = shift;
- return $self->model_class->authenticate($self) if
- $self->model_class->can("authenticate");
+ # Check if we have a model class
+ if ($self->{model_class}) {
+ return $self->model_class->authenticate($self) if
+ $self->model_class->can("authenticate");
+ }
return $self->authenticate($self); # Interface consistency is a Good Thing
}
L<Apache::MVC>, L<CGI::Maypole>.
+=head1 MAINTAINER
+
+Sebastian Riedel, c<sri@oook.de>
+
=head1 AUTHOR
Simon Cozens, C<simon@cpan.org>
+=head1 THANK YOU
+
+Jesse Scheildlower, Jody Belka, Markus Ramberg, Mickael Joanne, Simon Flack and all the others who've helped.
+
=head1 LICENSE
You may distribute this code under the same terms as Perl itself.
=cut
1;
-
--- /dev/null
+package Maypole::Application;
+
+use strict;
+use warnings;
+
+if ( $ENV{MOD_PERL} ) {
+ require mod_perl;
+ if ( $mod_perl::VERSION >= 1.99 ) {
+ require Apache2::MVC;
+ our @ISA = qw(Apache2::MVC);
+ }
+ else {
+ require Apache::MVC;
+ our @ISA = qw(Apache::MVC);
+ }
+}
+else {
+ require CGI::Maypole;
+ our @ISA = qw(CGI::Maypole);
+}
+
+1;
+
+=head1 NAME
+
+Maypole::Application - all in wonder front-end
+
+=head1 SYNOPSIS
+
+ use base 'Maypole::Application';
+
+=head1 DESCRIPTION
+
+The all in wonder front-end.
+
+=head1 AUTHOR
+
+Sebastian Riedel, C<sri@oook.de>
+Idea by Marcus Ramberg, C<marcus@thefeed.no>
+
+=head1 LICENSE
+
+You may distribute this code under the same terms as Perl itself.
projects / maypole.git / commitdiff