X-Git-Url: https://git.decadent.org.uk/gitweb/?a=blobdiff_plain;f=lib%2FApache%2FMVC.pm;h=0f6b7d0e9fc8c0dda03506ff398da25900b17cf0;hb=ef9ebe8ef9785b0fec3e3b20e70212e701f1c397;hp=465311293f122422537a498dccff44b7790930e5;hpb=2e483f35964e1ddd2022df6adc2b6d6a631c0cbd;p=maypole.git diff --git a/lib/Apache/MVC.pm b/lib/Apache/MVC.pm index 4653112..0f6b7d0 100644 --- a/lib/Apache/MVC.pm +++ b/lib/Apache/MVC.pm @@ -1,45 +1,105 @@ package Apache::MVC; -our $VERSION = '2.10'; +our $VERSION = '2.11'; use strict; use warnings; +use URI; +use URI::QueryParam; + use base 'Maypole'; use Maypole::Headers; use Maypole::Constants; __PACKAGE__->mk_accessors( qw( ar ) ); +our $MODPERL2; +our $modperl_version; + BEGIN { - my $version; - eval 'use mod_perl2; $version = $mod_perl2::VERSION; '; - if ($@) { - use mod_perl; - $version = 0; - require Apache; - require Apache::Request; + $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 { - require Apache2::RequestIO; - require Apache2::RequestRec; - require Apache2::RequestUtil; - require APR::URI; - require Apache2::Request; + eval ' use mod_perl; '; + require Apache; + require Apache::Request; + eval 'use Apache::Constants -compile => qw/REDIRECT/;'; + $modperl_version = 1; } - use constant APACHE2 => $version; } +=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. + +=head1 INSTALLATION + +Create a driver module like the one illustrated in L. + +Put the following in your Apache config: + + + SetHandler perl-script + PerlHandler BeerDB + + +Copy the templates found in F into the F +directory off the web root. When the designers get back to you with custom +templates, they are to go in F. If you need to override templates +on a database-table-by-table basis, put the new template in F>. + +This will automatically give you C, C, C, C and C +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. + +=head1 Implementation + +This class overrides a set of methods in the base Maypole class to provide its +functionality. See L for these: + +=over + +=item get_request + +=cut + sub get_request { - my ( $self, $r ) = @_; - $self->{ar} = (APACHE2) ? Apache2::Request->new($r) : Apache::Request->new($r); + my ($self, $r) = @_; + my $ar = ($MODPERL2) ? $r : Apache::Request->instance($r); + $self->ar($ar); } -sub get_protocol { - my $self = shift; - my $protocol = ( $self->{ar}->protocol =~ m/https/i ) ? 'https' : 'http' ; - return $protocol; -} +=item parse_location + +=cut sub parse_location { my $self = shift; @@ -47,163 +107,178 @@ sub parse_location { # 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; } + if ($MODPERL2) { %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)?\///; + 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; } +=item parse_args + +=cut + sub parse_args { my $self = shift; - $self->{params} = { $self->_mod_perl_args( $self->{ar} ) }; - $self->{query} = { $self->_mod_perl_args( $self->{ar} ) }; + $self->params( { $self->_mod_perl_args( $self->ar ) } ); + $self->query( $self->params ); } -# FIXME: use headers_in to gather host and other information? -sub redirect_request { - my $self = shift; +=item redirect_request + +=cut + +sub redirect_request +{ + my $r = shift; my $redirect_url = $_[0]; - my $status = "302"; + 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} || $self->{path}; - my $host = $args{domain} || $self->{ar}->hostname; - my $protocol = $args{protocol} || ( $self->{ar}->protocol =~ m/https/i ) ? 'https' : 'http' ;; + my $path = $args{path} || $r->path; + my $host = $args{domain} || $r->ar->hostname; + my $protocol = $args{protocol} || $r->get_protocol; $redirect_url = "${protocol}://${host}/${path}"; } $status = $args{status} if ($args{status}); } - $self->headers_out->set('Status' => $status); - $self->headers_out->set('Location' => $redirect_url); + $r->ar->status($status); + $r->ar->headers_out->set('Location' => $redirect_url); return OK; } +=item get_protocol + +=cut + +sub get_protocol { + my $self = shift; + my $protocol = ( $self->ar->protocol =~ m/https/i ) ? 'https' : 'http' ; + return $protocol; +} + +=item send_output + +=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->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} } + $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($_)); + $r->ar->headers_out->set($_ => $r->headers_out->get($_)); } - APACHE2 || $r->{ar}->send_http_header; - $r->{ar}->print( $r->{output} ); + $MODPERL2 || $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; + $r->ar->document_root . "/" . $r->ar->location; } +=back + +=cut + +######################################################### +# private / internal methods and subs + + sub _mod_perl_args { my ( $self, $apr ) = @_; my %args; - foreach my $key ( $apr->param ) { + 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->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; } -1; - -=head1 NAME - -Apache::MVC - Apache 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 - -A mod_perl platform driver for Maypole. Your application can inherit from -Apache::MVC directly, but it is recommended that you use -L. - -=head1 INSTALLATION - -Create a driver module like the one above. - -Put the following in your Apache config: - - - SetHandler perl-script - PerlHandler BeerDB - - -Copy the templates found in F into the -F directory off the web root. When the designers get -back to you with custom templates, they are to go in -F. If you need to do override templates on a -database-table-by-table basis, put the new template in -F>. - -This will automatically give you C, C, C, C and -C 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. - -=head1 Implementation - -This class overrides a set of methods in the base Maypole class to provide it's -functionality. See L for these: - -=over - -=item get_request - -=item get_template_root - -=item parse_args +sub _prepare_body { + my ( $self, $r ) = @_; -=item parse_location + 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 + +=head1 CREDITS + +Aaron Trevena Marcus Ramberg, C -Screwed up by Sebastian Riedel, C +Sebastian Riedel, C =head1 LICENSE You may distribute this code under the same terms as Perl itself. =cut + +1;