lib/Apache/MVC.pm

   1 package Apache::MVC;
   2
   3 use strict;
   4 use warnings;
   5
   6 use base 'Maypole';
   7 use mod_perl;
   8
   9 use constant APACHE2 => $mod_perl::VERSION >= 1.99;
  10
  11 if (APACHE2) {
  12     require Apache2;
  13     require Apache::RequestRec;
  14     require Apache::RequestUtil;
  15     require APR::URI;
  16 }
  17 else { require Apache }
  18 require Apache::Request;
  19
  20 our $VERSION = "0.4";
  21
  22 sub get_request {
  23     my ( $self, $r ) = @_;
  24     $self->{ar} = Apache::Request->new($r);
  25 }
  26
  27 sub parse_location {
  28     my $self = shift;
  29     $self->{path} = $self->{ar}->uri;
  30     my $loc = $self->{ar}->location;
  31     no warnings 'uninitialized';
  32     $self->{path} =~ s/^($loc)?\///;
  33     $self->parse_path;
  34     $self->parse_args;
  35 }
  36
  37 sub parse_args {
  38     my $self = shift;
  39     $self->{params} = { $self->_mod_perl_args( $self->{ar} ) };
  40     $self->{query}  = { $self->_mod_perl_args( $self->{ar} ) };
  41 }
  42
  43 sub send_output {
  44     my $r = shift;
  45     $r->{ar}->content_type( $r->{content_type} ."; encoding=".$r->{document_encoding} );
  46     $r->{ar}->headers_out->set( "Content-Length" => length $r->{output} );
  47     APACHE2 || $r->{ar}->send_http_header;
  48     $r->{ar}->print( $r->{output} );
  49 }
  50
  51 sub get_template_root {
  52     my $r = shift;
  53     $r->{ar}->document_root . "/" . $r->{ar}->location;
  54 }
  55
  56 sub _mod_perl_args {
  57     my ( $self, $apr ) = @_;
  58     my %args;
  59     foreach my $key ( $apr->param ) {
  60         my @values = $apr->param($key);
  61         $args{$key} = @values == 1 ? $values[0] : \@values;
  62     }
  63     return %args;
  64 }
  65
  66 1;
  67
  68 =head1 NAME
  69
  70 Apache::MVC - Apache front-end to Maypole
  71
  72 =head1 SYNOPSIS
  73
  74     package BeerDB;
  75     use base 'Apache::MVC';
  76     BeerDB->setup("dbi:mysql:beerdb");
  77     BeerDB->config->uri_base("http://your.site/");
  78     BeerDB->config->display_tables([qw[beer brewery pub style]]);
  79     # Now set up your database:
  80     # has-a relationships
  81     # untaint columns
  82
  83     1;
  84
  85 =head1 DESCRIPTION
  86
  87 Maypole is a Perl web application framework to Java's struts. It is
  88 essentially completely abstracted, and so doesn't know anything about
  89 how to talk to the outside world. C<Apache::MVC> is a mod_perl based
  90 subclass of Maypole.
  91
  92 To use it, you need to create a package which represents your entire
  93 application. In our example above, this is the C<BeerDB> package.
  94
  95 This needs to first inherit from C<Apache::MVC>, and then call setup.
  96 This will give your package an Apache-compatible C<handler> subroutine,
  97 and then pass any parameters onto the C<setup_database> method of the
  98 model class. The default model class for Maypole uses L<Class::DBI> to
  99 map a database to classes, but this can be changed by messing with the
 100 configuration. (B<Before> calling setup.)
 101
 102 Next, you should configure your application through the C<config>
 103 method. Configuration parameters at present are:
 104
 105 =over
 106
 107 =item uri_base
 108
 109 You B<must> specify this; it is the base URI of the application, which
 110 will be used to construct links.
 111
 112 =item display_tables
 113
 114 If you do not want all of the tables in the database to be accessible,
 115 then set this to a list of only the ones you want to display
 116
 117 =item rows_per_page
 118
 119 List output is paged if you set this to a positive number of rows.
 120
 121 =back
 122
 123 You should also set up relationships between your classes, such that,
 124 for instance, calling C<brewery> on a C<BeerDB::Beer> object returns an
 125 object representing its associated brewery.
 126
 127 For a full example, see the included "beer database" application.
 128
 129 =head1 INSTALLATION
 130
 131 Create a driver module like the one above.
 132
 133 Put the following in your Apache config:
 134
 135     <Location /beer>
 136         SetHandler perl-script
 137         PerlHandler BeerDB
 138     </Location>
 139
 140 Copy the templates found in F<templates/factory> into the
 141 F<beer/factory> directory off the web root. When the designers get
 142 back to you with custom templates, they are to go in
 143 F<beer/custom>. If you need to do override templates on a
 144 database-table-by-table basis, put the new template in
 145 F<beer/I<table>>.
 146
 147 This will automatically give you C<add>, C<edit>, C<list>, C<view> and
 148 C<delete> commands; for instance, a list of breweries, go to
 149
 150     http://your.site/beer/brewery/list
 151
 152 For more information about how the system works and how to extend it,
 153 see L<Maypole>.
 154
 155 =head1 AUTHOR
 156
 157 Simon Cozens, C<simon@cpan.org>
 158 Marcus Ramberg, C<marcus@thefeed.no>
 159 Screwed up by Sebastian Riedel, C<sri@oook.de>
 160
 161 =head1 LICENSE
 162
 163 You may distribute this code under the same terms as Perl itself.