X-Git-Url: https://git.decadent.org.uk/gitweb/?a=blobdiff_plain;f=lib%2FApache%2FMVC.pm;h=84454bc6cf3ae8c458907a2448876264261b50b7;hb=6a32fecf39ede7a47ff157f3bb73cb281a542a6a;hp=68f2c0af1fdf0319d4ffa4de080532f5f787bba5;hpb=9bbeafd23117d2b489a298cc002a97b133de17bd;p=maypole.git diff --git a/lib/Apache/MVC.pm b/lib/Apache/MVC.pm index 68f2c0a..84454bc 100644 --- a/lib/Apache/MVC.pm +++ b/lib/Apache/MVC.pm @@ -1,33 +1,35 @@ package Apache::MVC; -use base 'Maypole'; -use Apache; -use Apache::Request; + +our $VERSION = '2.10'; + use strict; use warnings; -our $VERSION = "0.3"; - -sub get_request { - shift->{ar} = Apache::Request->new(Apache->request); -} -sub parse_location { - my $self = shift; - $self->{path} = $self->{ar}->uri; - my $loc = $self->{ar}->location; - $self->{path} =~ s/^$loc//; # I shouldn't need to do this? - $self->{path} ||= "frontpage"; - my @pi = split /\//, $self->{path}; - shift @pi while @pi and !$pi[0]; - $self->{table} = shift @pi; - $self->{action} = shift @pi; - $self->{args} = \@pi; - - $self->{params} = { $self->{ar}->content }; - $self->{query} = { $self->{ar}->args }; +use base 'Maypole'; +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; + } + + use constant APACHE2 => $version; } -1; - =head1 NAME Apache::MVC - Apache front-end to Maypole @@ -35,90 +37,187 @@ 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. -To use it, you need to create a package which represents your entire -application. In our example above, this is the C package. +=head1 INSTALLATION -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.) +Create a driver module like the one illustrated in L. -Next, you should configure your application through the C -method. Configuration parameters at present are: +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 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 = (APACHE2) ? Apache2::Request->new($r) : Apache::Request->new($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 +=item get_protocol -=item rows_per_page +=cut -List output is paged if you set this to a positive number of rows. +sub get_protocol { + my $self = shift; + my $protocol = ( $self->ar->protocol =~ m/https/i ) ? 'https' : 'http' ; + return $protocol; +} -=back +=item parse_location -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. +=cut -For a full example, see the included "beer database" application. +sub parse_location { + my $self = shift; -=head1 INSTALLATION + # 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{$_}); + } + + 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; +} -Create a driver module like the one above. +=item parse_args -Put the following in your Apache config: +=cut - - SetHandler perl-script - PerlHandler BeerDB - +sub parse_args { + my $self = shift; + $self->params( { $self->_mod_perl_args( $self->ar ) } ); + $self->query( $self->params ); +} -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 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}); + } + + $self->headers_out->set('Status' => $status); + $self->headers_out->set('Location' => $redirect_url); + return OK; +} -This will automatically give you C, C, C, C and -C 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. +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 +Marcus Ramberg, C +Sebastian Riedel, C =head1 LICENSE You may distribute this code under the same terms as Perl itself. + +=cut