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";
sub get_request {
my ( $self, $r ) = @_;
- $self->{ar} = Apache::Request->new($r);
+ $self->{ar} = (APACHE2) ? Apache2::Request->new($r) : Apache::Request->new($r);
+}
+
+sub get_protocol {
+ my $self = shift;
+ my $protocol = ( $self->{ar}->protocol =~ m/https/i ) ? 'https' : 'http' ;
+ return $protocol;
}
sub parse_location {
my $self = shift;
+
+ # 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{$_});
+ }
+
$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;
$self->{query} = { $self->_mod_perl_args( $self->{ar} ) };
}
+# 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});
+ }
+
+ $self->headers_out->set('Status' => $status);
+ $self->headers_out->set('Location' => $redirect_url);
+ return OK;
+}
+
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}->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} );
}
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]];
+ 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
=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<Apache::MVC> 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<BeerDB> package.
-
-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.)
-
-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.
+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>.
=head1 INSTALLATION
For more information about how the system works and how to extend it,
see L<Maypole>.
+=head1 Implementation
+
+This class overrides a set of methods in the base Maypole class to provide it's
+functionality. See L<Maypole> for these:
+
+=over
+
+=item get_request
+
+=item get_template_root
+
+=item get_protocol
+
+=item parse_args
+
+=item parse_location
+
+=item send_output
+
+=item redirect_request
+
+=back
+
=head1 AUTHOR
Simon Cozens, C<simon@cpan.org>
=head1 LICENSE
You may distribute this code under the same terms as Perl itself.
+
+=cut