package Apache::MVC;
-our $VERSION = '2.05';
+our $VERSION = '2.121';
use strict;
use warnings;
-use base 'Maypole';
-use mod_perl;
+use URI;
+use URI::QueryParam;
-use constant APACHE2 => $mod_perl::VERSION >= 1.99;
+use base 'Maypole';
+use Maypole::Headers;
+use Maypole::Constants;
+
+__PACKAGE__->mk_accessors( qw( ar ) );
+
+our $MODPERL2;
+our $modperl_version;
+
+BEGIN {
+ $MODPERL2 = ( exists $ENV{MOD_PERL_API_VERSION} and
+ $ENV{MOD_PERL_API_VERSION} >= 2 );
+ if ($MODPERL2) {
+ eval 'use mod_perl2; $modperl_version = $mod_perl2::VERSION;';
+ if ($@) {
+ $modperl_version = $Apache2::RequestRec::VERSION;
+ }
+ require Apache2::RequestIO;
+ require Apache2::RequestRec;
+ require Apache2::RequestUtil;
+ eval 'use Apache2::Const -compile => qw/REDIRECT/;'; # -compile 4 no import
+ require APR::URI;
+ require HTTP::Body;
+ } else {
+ eval ' use mod_perl; ';
+ require Apache;
+ require Apache::Request;
+ eval 'use Apache::Constants -compile => qw/REDIRECT/;';
+ $modperl_version = 1;
+ }
-if (APACHE2) {
- require Apache2;
- require Apache::RequestRec;
- require Apache::RequestUtil;
- require APR::URI;
}
-else { require Apache }
-require Apache::Request;
+
+=head1 NAME
+
+Apache::MVC - Apache front-end to Maypole
+
+=head1 SYNOPSIS
+
+ package BeerDB;
+ use Maypole::Application;
+
+=head1 DESCRIPTION
+
+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
+
+Create a driver module like the one illustrated in L<Maypole::Application>.
+
+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 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, to see 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 Implementation
+
+This class overrides a set of methods in the base Maypole class to provide its
+functionality. See L<Maypole> for these:
+
+=over
+
+=item get_request
+
+=cut
sub get_request {
- my ( $self, $r ) = @_;
- $self->{ar} = Apache::Request->new($r);
+ my ($self, $r) = @_;
+ my $request_options = $self->config->request_options || {};
+ my $ar;
+ if ($MODPERL2) {
+ $ar = eval {require Apache2::Request} ? Apache2::Request->new($r,%{$request_options}) : $r;
+ } else {
+ if (keys %$request_options) {
+ $ar = Apache::Request->new($r,%{$request_options});
+ } else {
+ $ar = Apache::Request->instance($r);
+ }
+ }
+ $self->ar($ar);
}
-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;
-}
+=item warn
-sub parse_args {
- my $self = shift;
- $self->{params} = { $self->_mod_perl_args( $self->{ar} ) };
- $self->{query} = { $self->_mod_perl_args( $self->{ar} ) };
-}
+=cut
-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 warn {
+ my ($self,@args) = @_;
+ my ($package, $line) = (caller)[0,2];
+ my $ar = $self->parent ? $self->parent->{ar} : $self->{ar};
+ if ( $args[0] and ref $self ) {
+ $ar->warn("[$package line $line] ", @args) ;
+ } else {
+ print "warn called by ", caller, " with ", @_, "\n";
+ }
+ return;
}
-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;
+=item parse_location
+
+=cut
+
+sub parse_location {
+ my $self = shift;
+
+ # Reconstruct the request headers
+ $self->headers_in(Maypole::Headers->new);
+
+ my %headers;
+ if ($MODPERL2) { %headers = %{$self->ar->headers_in};
+ } else { %headers = $self->ar->headers_in; }
+ for (keys %headers) {
+ $self->headers_in->set($_, $headers{$_});
}
- return %args;
-}
-1;
+ $self->preprocess_location();
-=head1 NAME
+ my $path = $self->ar->uri;
+ my $base = URI->new($self->config->uri_base);
+ my $loc = $base->path;
-Apache::MVC - Apache front-end to Maypole
+ {
+ no warnings 'uninitialized';
+ $path .= '/' if $path eq $loc;
+ if ($loc =~ /\/$/) {
+ $path =~ s/^($loc)?//;
+ } else {
+ $path =~ s/^($loc)?\///;
+ }
+ }
-=head1 SYNOPSIS
+ $self->path($path);
+ $self->parse_path;
+ $self->parse_args;
+}
- 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
+=item parse_args
- 1;
+=cut
-=head1 DESCRIPTION
+sub parse_args {
+ my $self = shift;
+ $self->params( { $self->_mod_perl_args( $self->ar ) } );
+ $self->query( $self->params );
+}
-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.
+=item redirect_request
-To use it, you need to create a package which represents your entire
-application. In our example above, this is the C<BeerDB> package.
+Sets output headers to redirect based on the arguments provided
-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.)
+Accepts either a single argument of the full url to redirect to, or a hash of
+named parameters :
-Next, you should configure your application through the C<config>
-method. Configuration parameters at present are:
+$r->redirect_request('http://www.example.com/path');
-=over
+or
-=item uri_base
+$r->redirect_request(protocol=>'https', domain=>'www.example.com', path=>'/path/file?arguments', status=>'302', url=>'..');
-You B<must> specify this; it is the base URI of the application, which
-will be used to construct links.
+The named parameters are protocol, domain, path, status and url
-=item display_tables
+Only 1 named parameter is required but other than url, they can be combined as
+required and current values (from the request) will be used in place of any
+missing arguments. The url argument must be a full url including protocol and
+can only be combined with status.
-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
+=cut
-=item rows_per_page
+sub redirect_request {
+ my $r = shift;
+ my $redirect_url = $_[0];
+ my $status = $MODPERL2 ? eval 'Apache2::Const::REDIRECT;' :
+ eval 'Apache::Constants::REDIRECT;'; # why have to eval this?
+ if ($_[1]) {
+ my %args = @_;
+ if ($args{url}) {
+ $redirect_url = $args{url};
+ } else {
+ my $path = $args{path} || $r->path;
+ my $host = $args{domain} || $r->ar->hostname;
+ my $protocol = $args{protocol} || $r->get_protocol;
-List output is paged if you set this to a positive number of rows.
+ $redirect_url = URI->new;
+ $redirect_url->scheme($protocol);
+ $redirect_url->host($host);
+ $redirect_url->path($path);
+ }
+ $status = $args{status} if ($args{status});
+ }
-=back
+ $r->ar->status($status);
+ $r->ar->headers_out->set('Location' => $redirect_url);
+ return OK;
+}
-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.
+=item get_protocol
-=head1 INSTALLATION
+=cut
-Create a driver module like the one above.
+sub get_protocol {
+ my $self = shift;
+ my $protocol = ( $self->ar->protocol =~ m/https/i ) ? 'https' : 'http' ;
+ return $protocol;
+}
-Put the following in your Apache config:
+=item send_output
- <Location /beer>
- SetHandler perl-script
- PerlHandler BeerDB
- </Location>
+=cut
-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>>.
+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 }
+ );
-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
+ foreach ($r->headers_out->field_names) {
+ next if /^Content-(Type|Length)/;
+ $r->ar->headers_out->set($_ => $r->headers_out->get($_));
+ }
- http://your.site/beer/brewery/list
+ $MODPERL2 || $r->ar->send_http_header;
+ $r->ar->print( $r->output );
+}
-For more information about how the system works and how to extend it,
-see L<Maypole>.
+=item get_template_root
-=head1 Implementation
+=cut
-This class overrides a set of methods in the base Maypole class to provide it's
-functionality. See L<Maypole> for these:
+sub get_template_root {
+ my $r = shift;
+ $r->ar->document_root . "/" . $r->ar->location;
+}
-=over
+=back
-=item get_request
+=cut
-=item get_template_root
+#########################################################
+# private / internal methods and subs
-=item parse_args
-=item parse_location
+sub _mod_perl_args {
+ my ( $self, $apr ) = @_;
+ my %args;
+ if ($apr->isa('Apache::Request')) {
+ foreach my $key ( $apr->param ) {
+ my @values = $apr->param($key);
+ $args{$key} = @values == 1 ? $values[0] : \@values;
+ }
+ } else {
+ my $body = $self->_prepare_body($apr);
+ %args = %{$body->param};
+ my $uri = URI->new($self->ar->unparsed_uri);
+ foreach my $key ($uri->query_param) {
+ if (ref $args{$key}) {
+ push (@{$args{$key}}, $uri->query_param($key));
+ } else {
+ if ($args{$key}) {
+ $args{$key} = [ $args{$key}, $uri->query_param($key) ];
+ } else {
+ my @args = $uri->query_param($key);
+ if (scalar @args > 1) {
+ $args{$key} = [ $uri->query_param($key) ];
+ } else {
+ $args{$key} = $uri->query_param($key);
+ }
+ }
+ }
+ }
+ }
+ return %args;
+}
+
+sub _prepare_body {
+ my ( $self, $r ) = @_;
+
+ unless ($self->{__http_body}) {
+ my $content_type = $r->headers_in->get('Content-Type');
+ my $content_length = $r->headers_in->get('Content-Length');
+ my $body = HTTP::Body->new( $content_type, $content_length );
+ my $length = $content_length;
+ while ( $length ) {
+ $r->read( my $buffer, ( $length < 8192 ) ? $length : 8192 );
+ $length -= length($buffer);
+ $body->add($buffer);
+ }
+ $self->{__http_body} = $body;
+ }
+ return $self->{__http_body};
+}
-=item send_output
-=back
=head1 AUTHOR
Simon Cozens, C<simon@cpan.org>
+
+=head1 CREDITS
+
+Aaron Trevena
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
+
+1;
projects / maypole.git / blobdiff