X-Git-Url: https://git.decadent.org.uk/gitweb/?a=blobdiff_plain;f=lib%2FApache%2FMVC.pm;h=4623b9f607dbaf3c6fb2d0f47876166ed7b9d111;hb=12d8a77a713d5ed4f08414e5f34e96d45f60e2d3;hp=42d0d9102bbf4533526faa53f97dbe421b467e8d;hpb=58398cbb7b75bf3106e8503b81ee782178c248c3;p=maypole.git diff --git a/lib/Apache/MVC.pm b/lib/Apache/MVC.pm index 42d0d91..4623b9f 100644 --- a/lib/Apache/MVC.pm +++ b/lib/Apache/MVC.pm @@ -1,133 +1,222 @@ package Apache::MVC; -use base qw(Class::Accessor Class::Data::Inheritable); -use attributes (); -use Class::DBI::Loader; -use UNIVERSAL::require; -use Apache::Constants ":common"; + +our $VERSION = '2.10'; + use strict; use warnings; -our $VERSION = "1.0"; -__PACKAGE__->mk_classdata($_) for qw( _config init_done view_object ); -__PACKAGE__->mk_accessors ( qw( config ar params objects model_class -args action template )); -__PACKAGE__->config({}); -__PACKAGE__->init_done(0); - - -sub import { - my $real = shift; - if ($real ne "Apache::MVC") { - no strict 'refs'; - *{$real."::handler"} = sub { Apache::MVC::handler($real, @_) }; + +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; } -} -# This is really dirty. -sub config { - my $self = shift; - if (ref $self) { return $self->_config_accessor(@_) } - return $self->_config(@_); + use constant APACHE2 => $version; } -sub set_database { - my ($calling_class, $dsn) = @_; - $calling_class = ref $calling_class if ref $calling_class; - $calling_class->config->{dsn} = $dsn; - $calling_class->config->{loader} = Class::DBI::Loader->new( - namespace => $calling_class, - dsn => $dsn - ); -} +=head1 NAME -sub init { - my $class = shift; - my $config = $class->config; - $config->{model} ||= "Apache::MVC::Model::CDBI"; - $config->{view} ||= "Apache::MVC::View::TT"; - $config->{model}->require; - $config->{view}->require; - $config->{classes} = [ $class->config->{loader}->classes ]; - $config->{display_tables} ||= [ $class->config->{loader}->tables ]; - for my $subclass (@{$config->{classes}}) { - no strict 'refs'; - push @{$subclass."::ISA"}, $class->config->{model}; - } - $class->view_object($class->config->{view}->new); - $class->init_done(1); +Apache::MVC - Apache front-end to Maypole -} +=head1 SYNOPSIS -sub class_of { - my ($self, $table) = @_; - return $self->config->{loader}->_table2class($table); -} + package BeerDB; + use Maypole::Application; -sub handler { - # See Apache::MVC::Workflow before trying to understand this. - my $class = shift; - $class->init unless $class->init_done; - my $r = bless { config => $class->config }, $class; - $r->get_request(); - $r->parse_location(); - - $r->model_class($r->class_of($r->{table})); - my $status = $r->is_applicable; - return $status unless $status == OK; - $status = $r->call_authenticate; - return $status unless $status == OK; - $r->additional_data(); - - $r->model_class->process($r); - $r->view_object->process($r); - return $r; # For debugging. -} +=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 = shift; - require Apache; require Apache::Request; - $self->{ar} = Apache::Request->new(Apache->request); + my ($self, $r) = @_; + my $ar = (APACHE2) ? Apache2::Request->new($r) : Apache::Request->instance($r); + $self->ar($ar); } +=item parse_location + +=cut + sub parse_location { my $self = shift; - my $uri = $self->{ar}->uri(); - my $loc = $self->{ar}->location(); - $uri =~ s/^$loc//; - my @pi = split /\//, $uri; - shift @pi while @pi and !$pi[0]; - $self->{table} = shift @pi; - $self->{action} = shift @pi; - $self->{args} = \@pi; - - $self->{params} = $self->{ar}->content; + + # 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; } -sub is_applicable { +=item parse_args + +=cut + +sub parse_args { my $self = shift; - my $config = $self->config; - my %ok = map {$_ => 1} @{$config->{display_tables}}; - return DECLINED() unless exists $ok{$self->{table}}; - - # Does the action method exist? - my $cv = $self->model_class->can($self->{action}); - return DECLINED() unless $cv; - - # Is it exported? - $self->{method_attribs} = join " ", attributes::get($cv); - return DECLINED() - unless $self->{method_attribs} =~ /\bExported\b/i; - return OK(); + $self->params( { $self->_mod_perl_args( $self->ar ) } ); + $self->query( $self->params ); } -sub call_authenticate { - my $self = shift; - return $self->model_class->authenticate($self) if - $self->model_class->can("authenticate"); - return $self->authenticate(); +=item redirect_request + +=cut + +# FIXME: use headers_in to gather host and other information? +sub redirect_request +{ + my $r = shift; + my $redirect_url = $_[0]; + my $status = "302"; + 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}); + } + + $r->headers_out->set('Status' => $status); + $r->headers_out->set('Location' => $redirect_url); + return OK; } -sub additional_data {} +=item get_protocol -sub authenticate { return OK } +=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($_)); + } + + 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