package Apache::MVC;
+our $VERSION = '2.10';
+
use strict;
use warnings;
use base 'Maypole';
-use mod_perl;
-
-use constant APACHE2 => $mod_perl::VERSION >= 1.99;
+use Maypole::Headers;
+use Maypole::Constants;
+
+__PACKAGE__->mk_accessors( qw( ar ) );
+
+BEGIN {
+ my $version;
+ eval 'use mod_perl2; $version = $mod_perl2::VERSION; ';
+ if ($@) {
+ use mod_perl;
+ $version = 0;
+ require Apache;
+ require Apache::Request;
+ } else {
+ require Apache2::RequestIO;
+ require Apache2::RequestRec;
+ require Apache2::RequestUtil;
+ require APR::URI;
+ require Apache2::Request;
+ }
-if (APACHE2) {
- require Apache2;
- require Apache::RequestRec;
- require Apache::RequestUtil;
- require APR::URI;
+ use constant APACHE2 => $version;
}
-else { require Apache }
-require Apache::Request;
-our $VERSION = "0.4";
+=head1 NAME
-sub get_request {
- my ( $self, $r ) = @_;
- $self->{ar} = Apache::Request->new($r);
-}
+Apache::MVC - Apache front-end to Maypole
-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;
-}
+=head1 SYNOPSIS
-sub parse_args {
- my $self = shift;
- $self->{params} = { $self->_mod_perl_args( $self->{ar} ) };
- $self->{query} = { $self->_mod_perl_args( $self->{ar} ) };
-}
+ package BeerDB;
+ use Maypole::Application;
-sub send_output {
- my $r = shift;
- $r->{ar}->content_type( $r->{content_type} );
- $r->{ar}->headers_out->set( "Content-Length" => length $r->{output} );
- APACHE2 || $r->{ar}->send_http_header;
- $r->{ar}->print( $r->{output} );
-}
+=head1 DESCRIPTION
-sub get_template_root {
- my $r = shift;
- $r->{ar}->document_root . "/" . $r->{ar}->location;
-}
+A mod_perl platform driver for Maypole. Your application can inherit from
+Apache::MVC directly, but it is recommended that you use
+L<Maypole::Application>.
-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;
-}
+=head1 INSTALLATION
-1;
+Create a driver module like the one illustrated in L<Maypole::Application>.
-=head1 NAME
+Put the following in your Apache config:
-Apache::MVC - Apache front-end to Maypole
+ <Location /beer>
+ SetHandler perl-script
+ PerlHandler BeerDB
+ </Location>
-=head1 SYNOPSIS
+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 override templates
+on a database-table-by-table basis, put the new template in F<beer/I<table>>.
- 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
+This will automatically give you C<add>, C<edit>, C<list>, C<view> and C<delete>
+commands; for instance, to see a list of breweries, go to
- 1;
+ http://your.site/beer/brewery/list
-=head1 DESCRIPTION
+For more information about how the system works and how to extend it,
+see L<Maypole>.
-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.
+=head1 Implementation
-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 class overrides a set of methods in the base Maypole class to provide its
+functionality. See L<Maypole> for these:
-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.)
+=over
-Next, you should configure your application through the C<config>
-method. Configuration parameters at present are:
+=item get_request
-=over
+=cut
-=item uri_base
+sub get_request {
+ my ($self, $r) = @_;
+ my $ar = (APACHE2) ? Apache2::Request->new($r) : Apache::Request->new($r);
+ $self->ar($ar);
+}
-You B<must> specify this; it is the base URI of the application, which
-will be used to construct links.
+=item get_protocol
-=item display_tables
+=cut
-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
+sub get_protocol {
+ my $self = shift;
+ my $protocol = ( $self->ar->protocol =~ m/https/i ) ? 'https' : 'http' ;
+ return $protocol;
+}
-=item rows_per_page
+=item parse_location
-List output is paged if you set this to a positive number of rows.
+=cut
-=back
+sub parse_location {
+ my $self = shift;
-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.
+ # Reconstruct the request headers
+ $self->headers_in(Maypole::Headers->new);
+ my %headers;
+ if (APACHE2) { %headers = %{$self->ar->headers_in};
+ } else { %headers = $self->ar->headers_in; }
+ for (keys %headers) {
+ $self->headers_in->set($_, $headers{$_});
+ }
-For a full example, see the included "beer database" application.
+ my $path = $self->ar->uri;
+ my $loc = $self->ar->location;
+ {
+ no warnings 'uninitialized';
+ $path .= '/' if $path eq $loc;
+ $path =~ s/^($loc)?\///;
+ }
+ $self->path($path);
+
+ $self->parse_path;
+ $self->parse_args;
+}
-=head1 INSTALLATION
+=item parse_args
-Create a driver module like the one above.
+=cut
-Put the following in your Apache config:
+sub parse_args {
+ my $self = shift;
+ $self->params( { $self->_mod_perl_args( $self->ar ) } );
+ $self->query( $self->params );
+}
- <Location /beer>
- SetHandler perl-script
- PerlHandler BeerDB
- </Location>
+=item redirect_request
+
+=cut
+
+# FIXME: use headers_in to gather host and other information?
+sub redirect_request {
+ my $self = shift;
+ my $redirect_url = $_[0];
+ my $status = "302";
+ if ($_[1]) {
+ my %args = @_;
+ if ($args{url}) {
+ $redirect_url = $args{url};
+ } else {
+ my $path = $args{path} || $self->path;
+ my $host = $args{domain} || $self->ar->hostname;
+ my $protocol = $args{protocol} ||
+ ( $self->ar->protocol =~ m/https/i ) ? 'https' : 'http' ;
+ $redirect_url = "${protocol}://${host}/${path}";
+ }
+ $status = $args{status} if ($args{status});
+ }
-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>>.
+ $self->headers_out->set('Status' => $status);
+ $self->headers_out->set('Location' => $redirect_url);
+ return OK;
+}
-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
+=item send_output
- http://your.site/beer/brewery/list
+=cut
-For more information about how the system works and how to extend it,
-see L<Maypole>.
+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 }
+ );
+
+ foreach ($r->headers_out->field_names) {
+ next if /^Content-(Type|Length)/;
+ $r->ar->headers_out->set($_ => $r->headers_out->get($_));
+ }
+
+ APACHE2 || $r->ar->send_http_header;
+ $r->ar->print( $r->output );
+}
+
+=item get_template_root
+
+=cut
+
+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;
+
+=back
=head1 AUTHOR
Simon Cozens, C<simon@cpan.org>
Marcus Ramberg, C<marcus@thefeed.no>
-Screwed up by Sebastian Riedel, C<sri@oook.de>
+Sebastian Riedel, C<sri@oook.de>
=head1 LICENSE
You may distribute this code under the same terms as Perl itself.
+
+=cut
projects / maypole.git / blobdiff