From 6a32fecf39ede7a47ff157f3bb73cb281a542a6a Mon Sep 17 00:00:00 2001 From: David Baird Date: Fri, 4 Nov 2005 15:40:32 +0000 Subject: [PATCH] Reorganised pod in Apache::MVC. Removed all direct hash access to request parameters from Apache::MVC git-svn-id: http://svn.maypole.perl.org/Maypole/trunk@410 48953598-375a-da11-a14b-00016c27c3ee --- lib/Apache/MVC.pm | 202 ++++++++++++++++++++++++---------------------- 1 file changed, 106 insertions(+), 96 deletions(-) diff --git a/lib/Apache/MVC.pm b/lib/Apache/MVC.pm index 827d5d2..84454bc 100644 --- a/lib/Apache/MVC.pm +++ b/lib/Apache/MVC.pm @@ -30,44 +30,115 @@ BEGIN { 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 = (APACHE2) ? Apache2::Request->new($r) : Apache::Request->new($r); + $self->ar($ar); } +=item get_protocol + +=cut + sub get_protocol { my $self = shift; - my $protocol = ( $self->{ar}->protocol =~ m/https/i ) ? 'https' : 'http' ; + my $protocol = ( $self->ar->protocol =~ m/https/i ) ? 'https' : 'http' ; return $protocol; } +=item parse_location + +=cut + 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; } + 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)?\///; + 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 ); } +=item redirect_request + +=cut + # FIXME: use headers_in to gather host and other information? sub redirect_request { my $self = shift; @@ -78,9 +149,10 @@ sub redirect_request { 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} || $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}); @@ -91,29 +163,37 @@ sub redirect_request { return OK; } +=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} ); + 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; + $r->ar->document_root . "/" . $r->ar->location; } sub _mod_perl_args { @@ -128,83 +208,13 @@ sub _mod_perl_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 get_protocol - -=item parse_args - -=item parse_location - -=item send_output - -=item redirect_request - =back =head1 AUTHOR Simon Cozens, C Marcus Ramberg, C -Screwed up by Sebastian Riedel, C +Sebastian Riedel, C =head1 LICENSE -- 2.39.2