X-Git-Url: https://git.decadent.org.uk/gitweb/?a=blobdiff_plain;f=lib%2FApache%2FMVC.pm;h=1695bf5f525d0332a5810b565f4acdc8f02c5886;hb=32ecafee815b0fd8043c0acc2c785f5748fc20ff;hp=5005effb96f244fa0eaeae8526fc64d146160b80;hpb=e1058b36db231a58f819075b0e5658a872e94f11;p=maypole.git diff --git a/lib/Apache/MVC.pm b/lib/Apache/MVC.pm index 5005eff..1695bf5 100644 --- a/lib/Apache/MVC.pm +++ b/lib/Apache/MVC.pm @@ -1,27 +1,45 @@ package Apache::MVC; -use base qw(Apache::MVC::Base Maypole); -use Apache; -use Apache::Request; +our $VERSION = '2.11'; + use strict; use warnings; -our $VERSION = "0.3"; - -sub get_request { - shift->{ar} = Apache::Request->new( Apache->request ); -} - -sub parse_args { - my $self = shift; - $self->{params} = { $self->{ar}->content }; - while ( my ( $key, $value ) = each %{ $self->{params} } ) { - $self->{params}{$key} = '' unless defined $value; +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 { + $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; } - $self->{query} = { $self->{ar}->args }; -} -1; +} =head1 NAME @@ -30,91 +48,252 @@ 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; + use Maypole::Application; =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 is a mod_perl based -subclass of Maypole. +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 -To use it, you need to create a package which represents your entire -application. In our example above, this is the C package. +For more information about how the system works and how to extend it, +see L. -This needs to first inherit from C, and then call setup. -This will give your package an Apache-compatible C subroutine, -and then pass any parameters onto the C method of the -model class. The default model class for Maypole uses L to -map a database to classes, but this can be changed by messing with the -configuration. (B calling setup.) +=head1 Implementation -Next, you should configure your application through the C -method. Configuration parameters at present are: +This class overrides a set of methods in the base Maypole class to provide its +functionality. See L for these: =over -=item uri_base +=item get_request -You B specify this; it is the base URI of the application, which -will be used to construct links. +=cut -=item display_tables +sub get_request { + my ($self, $r) = @_; + my $ar; + if ($MODPERL2) { + $ar = eval {require Apache2::Request} ? Apache2::Request->new($r) : $r; + } + else { $ar = Apache::Request->instance($r); } + $self->ar($ar); +} -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 warn { + my ($self,@args) = @_; + my ($package, $line) = (caller)[0,2]; + if ( $args[0] and ref $self ) { + $self->{ar}->warn("[$package line $line] ", @args) ; + } else { + print "warn called by ", caller, " with ", @_, "\n"; + } + return; +} -=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 on a C object returns an -object representing its associated brewery. + # 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{$_}); + } + 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; +} -For a full example, see the included "beer database" application. +=item parse_args -=head1 INSTALLATION +=cut -Create a driver module like the one above. +sub parse_args { + my $self = shift; + $self->params( { $self->_mod_perl_args( $self->ar ) } ); + $self->query( $self->params ); +} -Put the following in your Apache config: +=item redirect_request + +=cut + +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; + $redirect_url = "${protocol}://${host}/${path}"; + } + $status = $args{status} if ($args{status}); + } - - SetHandler perl-script - PerlHandler BeerDB - + $r->ar->status($status); + $r->ar->headers_out->set('Location' => $redirect_url); + return OK; +} -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>. +=item get_protocol -This will automatically give you C, C, C, C and -C commands; for instance, a list of breweries, go to +=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->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($_)); + } + + $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; +} + +=back + +=cut + +######################################################### +# private / internal methods and subs + + +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}; +} - http://your.site/beer/brewery/list -For more information about how the system works and how to extend it, -see L. =head1 AUTHOR Simon Cozens, C -Screwed up by Sebastian Riedel, C + +=head1 CREDITS + +Aaron Trevena +Marcus Ramberg, C +Sebastian Riedel, C =head1 LICENSE You may distribute this code under the same terms as Perl itself. + +=cut + +1;