]> git.decadent.org.uk Git - maypole.git/blobdiff - lib/Apache/MVC.pm
projects / maypole.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
removed Maypole::Model->description,
[maypole.git] / lib / Apache / MVC.pm
diff --git a/lib/Apache/MVC.pm b/lib/Apache/MVC.pm
index 89928fa814ff04c4bc725eb7ccadd82c853f376d..45dd897ec0ac0abf65502c4d3222bc6595640871 100644 (file)
--- a/lib/Apache/MVC.pm
+++ b/lib/Apache/MVC.pm
@@ -1,163 +1,106 @@
 package Apache::MVC;
 package Apache::MVC;
-use base qw(Class::Accessor Class::Data::Inheritable);
-use attributes ();
-use Class::DBI::Loader;
-use UNIVERSAL::require;
-use Apache::Constants ":common";
-use strict;
-use warnings;
-our $VERSION = "0.2";
-__PACKAGE__->mk_classdata($_) for qw( _config init_done view_object );
-__PACKAGE__->mk_accessors ( qw( config ar params query 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, @_) };
-    }
-}
 
 
-# This is really dirty.
-sub config {
-    my $self = shift;
-    if (ref $self) { return $self->_config_accessor(@_) }
-    return $self->_config(@_);
-}
-
-sub set_database {
-    my ($calling_class, $dsn) = @_;
-    $calling_class = ref $calling_class if ref $calling_class;
-    my $config = $calling_class->config;
-    $config->{model} ||= "Apache::MVC::Model::CDBI";
-    $config->{model}->require;
-    $config->{dsn} = $dsn;
-    $config->{loader} = Class::DBI::Loader->new(
-        namespace => $calling_class,
-        dsn => $dsn
-    ); 
-    $config->{classes} = [ $config->{loader}->classes ];
-    for my $subclass (@{$config->{classes}}) {
-        no strict 'refs';
-        unshift @{$subclass."::ISA"}, $config->{model};
-        $config->{model}->adopt($subclass)
-           if $config->{model}->can("adopt");
-    }
-}
+our $VERSION = '2.07';
 
 
-sub init {
-    my $class = shift;
-    my $config = $class->config;
-    $config->{view}  ||= "Apache::MVC::View::TT";
-    $config->{view}->require;
-    $config->{display_tables} ||= [ $class->config->{loader}->tables ];
-    $class->view_object($class->config->{view}->new);
-    $class->init_done(1);
+use strict;
+use warnings;
 
 
-}
+use base 'Maypole';
+use mod_perl;
+use Maypole::Headers;
 
 
-sub class_of {
-    my ($self, $table) = @_;
-    return $self->config->{loader}->_table2class($table);
-}
+use constant APACHE2 => $mod_perl::VERSION >= 1.99;
 
 
-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;
-    if ($status == OK) { 
-        $status = $r->call_authenticate;
-        return $status unless $status == OK;
-        $r->additional_data();
-    
-        $r->model_class->process($r);
-    } else { 
-        # Otherwise, it's just a plain template.
-        delete $r->{model_class};
-        $r->{path} =~ s{/}{}; # De-absolutify
-        $r->template($r->{path});
-    }
-    return $r->view_object->process($r);
+if (APACHE2) {
+    require Apache2;
+    require Apache::RequestIO;
+    require Apache::RequestRec;
+    require Apache::RequestUtil;
+    require APR::URI;
 }
 }
+else { require Apache }
+require Apache::Request;
 
 sub get_request {
 
 sub get_request {
-    my $self = shift;
-    require Apache; require Apache::Request; 
-    $self->{ar} = Apache::Request->new(Apache->request);
+    my ( $self, $r ) = @_;
+    $self->{ar} = Apache::Request->new($r);
 }
 
 sub parse_location {
     my $self = shift;
 }
 
 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; }
+    for (keys %headers) {
+        $self->headers_in->set($_, $headers{$_});
+    }
+
     $self->{path} = $self->{ar}->uri;
     my $loc = $self->{ar}->location;
     $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 };
+    no warnings 'uninitialized';
+    $self->{path} .= '/' if $self->{path} eq $loc;
+    $self->{path} =~ s/^($loc)?\///;
+    $self->parse_path;
+    $self->parse_args;
 }
 
 }
 
-sub is_applicable {
+sub parse_args {
     my $self = shift;
     my $self = shift;
-    my $config = $self->config;
-    $config->{ok_tables} = {map {$_ => 1} @{$config->{display_tables}}};
-    warn "We don't have that table ($self->{table})"
-        unless $config->{ok_tables}{$self->{table}};
-    return DECLINED() unless exists $config->{ok_tables}{$self->{table}};
-
-    # Does the action method exist?
-    my $cv = $self->model_class->can($self->{action});
-    warn "We don't have that action ($self->{action})" unless $cv;
-    return DECLINED() unless $cv;
-
-    # Is it exported?
-    $self->{method_attribs} = join " ", attributes::get($cv);
-    do { warn "$self->{action} not exported";
-    return DECLINED() 
-     } unless $self->{method_attribs} =~ /\bExported\b/i;
-    return OK();
+    $self->{params} = { $self->_mod_perl_args( $self->{ar} ) };
+    $self->{query}  = { $self->_mod_perl_args( $self->{ar} ) };
 }
 
 }
 
-sub call_authenticate {
-    my $self = shift;
-    return $self->model_class->authenticate($self) if 
-        $self->model_class->can("authenticate");
-    return $self->authenticate();
+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} );
 }
 
 }
 
-sub additional_data {}
+sub get_template_root {
+    my $r = shift;
+    $r->{ar}->document_root . "/" . $r->{ar}->location;
+}
 
 
-sub authenticate { return OK }
+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;
 
 =head1 NAME
 
 
 1;
 
 =head1 NAME
 
-Apache::MVC - Web front end to a data source
+Apache::MVC - Apache front-end to Maypole
 
 =head1 SYNOPSIS
 
     package BeerDB;
     use base 'Apache::MVC';
 
 =head1 SYNOPSIS
 
     package BeerDB;
     use base 'Apache::MVC';
-    sub handler { Apache::MVC::handler("BeerDB", @_) }
-    BeerDB->set_database("dbi:mysql:beerdb");
-    BeerDB->config->{uri_base} = "http://your.site/";
-    BeerDB->config->{display_tables} = [qw[beer brewery pub style]];
+    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
     # Now set up your database:
     # has-a relationships
     # untaint columns
@@ -166,107 +109,63 @@ Apache::MVC - Web front end to a data source
 
 =head1 DESCRIPTION
 
 
 =head1 DESCRIPTION
 
-A large number of web programming tasks follow the same sort of pattern:
-we have some data in a datasource, typically a relational database. We
-have a bunch of templates provided by web designers. We have a number of
-things we want to be able to do with the database - create, add, edit,
-delete records, view records, run searches, and so on. We have a web
-server which provides input from the user about what to do. Something in
-the middle takes the input, grabs the relevant rows from the database,
-performs the action, constructs a page, and spits it out.
-
-This module aims to be the most generic and extensible "something in the
-middle".
-
-An example would help explain this best. You need to add a product
-catalogue to a company's web site. Users need to list the products in
-various categories, view a page on each product with its photo and
-pricing information and so on, and there needs to be a back-end where
-sales staff can add new lines, change prices, and delete out of date
-records. So, you set up the database, provide some default templates
-for the designers to customize, and then write an Apache handler like
-this:
-
-    package ProductDatabase;
-    use base 'Apache::MVC';
-    __PACKAGE__->set_database("dbi:mysql:products");
-    BeerDB->config->{uri_base} = "http://your.site/catalogue/";
-    ProductDatabase::Product->has_a("category" => ProductDatabase::Category); 
-    # ...
-
-    sub authenticate {
-        my ($self, $request) = @_;
-        return OK if $request->{ar}->get_remote_host() eq "sales.yourcorp.com";
-        return OK if $request->{action} =~ /^(view|list)$/;
-        return DECLINED;
-    }
-    1;
+A mod_perl platform driver for Maypole. Your application can inherit from
+Apache::MVC directly, but it is recommended that you use
+L<Maypole::Application>.
+
+=head1 INSTALLATION
 
 
-You then put the following in your Apache config:
+Create a driver module like the one above.
 
 
-    <Location /catalogue>
+Put the following in your Apache config:
+
+    <Location /beer>
         SetHandler perl-script
         SetHandler perl-script
-        PerlHandler ProductDatabase
+        PerlHandler BeerDB
     </Location>
 
     </Location>
 
-And copy the templates found in F<templates/factory> into the
-F<catalogue/factory> directory off the web root. When the designers get
+Copy the templates found in F<templates/factory> into the
+F<beer/factory> directory off the web root. When the designers get
 back to you with custom templates, they are to go in
 back to you with custom templates, they are to go in
-F<catalogue/custom>. If you need to do override templates on a
+F<beer/custom>. If you need to do override templates on a
 database-table-by-table basis, put the new template in
 database-table-by-table basis, put the new template in
-F<catalogue/I<table>>. 
+F<beer/I<table>>. 
 
 This will automatically give you C<add>, C<edit>, C<list>, C<view> and
 
 This will automatically give you C<add>, C<edit>, C<list>, C<view> and
-C<delete> commands; for instance, a product list, go to 
-
-    http://your.site/catalogue/product/list
+C<delete> commands; for instance, a list of breweries, go to 
 
 
-For a full example, see the included "beer database" application.
+    http://your.site/beer/brewery/list
 
 
-=head1 HOW IT WORKS
+For more information about how the system works and how to extend it,
+see L<Maypole>.
 
 
-There's some documentation for the workflow in L<Apache::MVC::Workflow>,
-but the basic idea is that a URL part like C<product/list> gets
-translated into a call to C<ProductDatabase::Product-E<gt>list>. This
-propagates the request with a set of objects from the database, and then 
-calls the C<list> template; first, a C<product/list> template if it
-exists, then the C<custom/list> and finally C<factory/list>. 
+=head1 Implementation
 
 
-If there's another action you want the system to do, you need to either
-subclass the model class, and configure your class slightly differently:
+This class overrides a set of methods in the base Maypole class to provide it's
+functionality. See L<Maypole> for these:
 
 
-    package ProductDatabase::Model;
-    use base 'Apache::MVC::Model::CDBI';
+=over
 
 
-    sub supersearch :Exported {
-        my ($self, $request) = @_;
-        # Do stuff, get a bunch of objects back
-        $r->objects(\@objects);
-        $r->template("template_name");
-    }
+=item get_request
 
 
-    ProductDatabase->config->{model_class} = "ProductDatabase::Model";
+=item get_template_root
 
 
-(The C<:Exported> attribute means that the method can be called via the
-URL C</I<table>/supersearch/...>.)
+=item parse_args
 
 
-Alternatively, you can put the method directly into the specific model
-class for the table:
+=item parse_location
 
 
-    sub ProductDatabase::Product::supersearch :Exported { ... }
+=item send_output
 
 
-By default, the view class uses Template Toolkit as the template
-processor, and the model class uses C<Class::DBI>; it may help you to be
-familiar with these modules before going much further with this,
-although I expect there to be other subclasses for other templating
-systems and database abstraction layers as time goes on. The article at
-C<http://www.perl.com/pub/a/2003/07/15/nocode.html> is a great
-introduction to the process we're trying to automate.
+=back
 
 =head1 AUTHOR
 
 Simon Cozens, C<simon@cpan.org>
 
 =head1 AUTHOR
 
 Simon Cozens, C<simon@cpan.org>
+Marcus Ramberg, C<marcus@thefeed.no>
+Screwed up by Sebastian Riedel, C<sri@oook.de>
 
 =head1 LICENSE
 
 You may distribute this code under the same terms as Perl itself.
 
 =head1 LICENSE
 
 You may distribute this code under the same terms as Perl itself.
+
+=cut
Package: Maypole [unmaintained]