13 use Maypole::Constants;
15 __PACKAGE__->mk_accessors( qw( ar ) );
21 $MODPERL2 = ( exists $ENV{MOD_PERL_API_VERSION} and
22 $ENV{MOD_PERL_API_VERSION} >= 2 );
24 eval 'use mod_perl2; $modperl_version = $mod_perl2::VERSION;';
26 $modperl_version = $Apache2::RequestRec::VERSION;
28 require Apache2::RequestIO;
29 require Apache2::RequestRec;
30 require Apache2::RequestUtil;
31 eval 'use Apache2::Const -compile => qw/REDIRECT/;'; # -compile 4 no import
35 eval ' use mod_perl; ';
37 require Apache::Request;
38 eval 'use Apache::Constants -compile => qw/REDIRECT/;';
46 Apache::MVC - Apache front-end to Maypole
51 use Maypole::Application;
55 A mod_perl platform driver for Maypole. Your application can inherit from
56 Apache::MVC directly, but it is recommended that you use
57 L<Maypole::Application>.
61 Create a driver module like the one illustrated in L<Maypole::Application>.
63 Put the following in your Apache config:
66 SetHandler perl-script
70 Copy the templates found in F<templates/factory> into the F<beer/factory>
71 directory off the web root. When the designers get back to you with custom
72 templates, they are to go in F<beer/custom>. If you need to override templates
73 on a database-table-by-table basis, put the new template in F<beer/I<table>>.
75 This will automatically give you C<add>, C<edit>, C<list>, C<view> and C<delete>
76 commands; for instance, to see a list of breweries, go to
78 http://your.site/beer/brewery/list
80 For more information about how the system works and how to extend it,
85 This class overrides a set of methods in the base Maypole class to provide its
86 functionality. See L<Maypole> for these:
98 $ar = eval {require Apache2::Request} ? Apache2::Request->new($r) : $r;
100 else { $ar = Apache::Request->instance($r); }
109 my ($self,@args) = @_;
110 my ($package, $line) = (caller)[0,2];
111 my $ar = $self->parent ? $self->parent->{ar} : $self->{ar};
112 if ( $args[0] and ref $self ) {
113 $ar->warn("[$package line $line] ", @args) ;
115 print "warn called by ", caller, " with ", @_, "\n";
128 # Reconstruct the request headers
129 $self->headers_in(Maypole::Headers->new);
132 if ($MODPERL2) { %headers = %{$self->ar->headers_in};
133 } else { %headers = $self->ar->headers_in; }
134 for (keys %headers) {
135 $self->headers_in->set($_, $headers{$_});
138 $self->preprocess_location();
140 my $path = $self->ar->uri;
141 my $base = URI->new($self->config->uri_base);
142 my $loc = $base->path;
145 no warnings 'uninitialized';
146 $path .= '/' if $path eq $loc;
148 $path =~ s/^($loc)?//;
150 $path =~ s/^($loc)?\///;
165 $self->params( { $self->_mod_perl_args( $self->ar ) } );
166 $self->query( $self->params );
169 =item redirect_request
171 Sets output headers to redirect based on the arguments provided
173 Accepts either a single argument of the full url to redirect to, or a hash of
176 $r->redirect_request('http://www.example.com/path');
180 $r->redirect_request(protocol=>'https', domain=>'www.example.com', path=>'/path/file?arguments', status=>'302', url=>'..');
182 The named parameters are protocol, domain, path, status and url
184 Only 1 named parameter is required but other than url, they can be combined as
185 required and current values (from the request) will be used in place of any
186 missing arguments. The url argument must be a full url including protocol and
187 can only be combined with status.
191 sub redirect_request {
193 my $redirect_url = $_[0];
194 my $status = $MODPERL2 ? eval 'Apache2::Const::REDIRECT;' :
195 eval 'Apache::Constants::REDIRECT;'; # why have to eval this?
199 $redirect_url = $args{url};
201 my $path = $args{path} || $r->path;
202 my $host = $args{domain} || $r->ar->hostname;
203 my $protocol = $args{protocol} || $r->get_protocol;
205 $redirect_url = URI->new;
206 $redirect_url->scheme($protocol);
207 $redirect_url->host($host);
208 $redirect_url->path($path);
210 $status = $args{status} if ($args{status});
213 $r->ar->status($status);
214 $r->ar->headers_out->set('Location' => $redirect_url);
225 my $protocol = ( $self->ar->protocol =~ m/https/i ) ? 'https' : 'http' ;
235 $r->ar->content_type(
236 $r->content_type =~ m/^text/
237 ? $r->content_type . "; charset=" . $r->document_encoding
240 $r->ar->headers_out->set(
241 "Content-Length" => do { use bytes; length $r->output }
244 foreach ($r->headers_out->field_names) {
245 next if /^Content-(Type|Length)/;
246 $r->ar->headers_out->set($_ => $r->headers_out->get($_));
249 $MODPERL2 || $r->ar->send_http_header;
250 $r->ar->print( $r->output );
253 =item get_template_root
257 sub get_template_root {
259 $r->ar->document_root . "/" . $r->ar->location;
266 #########################################################
267 # private / internal methods and subs
271 my ( $self, $apr ) = @_;
273 if ($apr->isa('Apache::Request')) {
274 foreach my $key ( $apr->param ) {
275 my @values = $apr->param($key);
276 $args{$key} = @values == 1 ? $values[0] : \@values;
279 my $body = $self->_prepare_body($apr);
280 %args = %{$body->param};
281 my $uri = URI->new($self->ar->unparsed_uri);
282 foreach my $key ($uri->query_param) {
283 if (ref $args{$key}) {
284 push (@{$args{$key}}, $uri->query_param($key));
287 $args{$key} = [ $args{$key}, $uri->query_param($key) ];
289 my @args = $uri->query_param($key);
290 if (scalar @args > 1) {
291 $args{$key} = [ $uri->query_param($key) ];
293 $args{$key} = $uri->query_param($key);
303 my ( $self, $r ) = @_;
305 unless ($self->{__http_body}) {
306 my $content_type = $r->headers_in->get('Content-Type');
307 my $content_length = $r->headers_in->get('Content-Length');
308 my $body = HTTP::Body->new( $content_type, $content_length );
309 my $length = $content_length;
311 $r->read( my $buffer, ( $length < 8192 ) ? $length : 8192 );
312 $length -= length($buffer);
315 $self->{__http_body} = $body;
317 return $self->{__http_body};
324 Simon Cozens, C<simon@cpan.org>
329 Marcus Ramberg, C<marcus@thefeed.no>
330 Sebastian Riedel, C<sri@oook.de>
334 You may distribute this code under the same terms as Perl itself.