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);
131 if ($MODPERL2) { %headers = %{$self->ar->headers_in};
132 } else { %headers = $self->ar->headers_in; }
133 for (keys %headers) {
134 $self->headers_in->set($_, $headers{$_});
137 my $path = $self->ar->uri;
138 my $base = URI->new($self->config->uri_base);
139 my $loc = $base->path;
142 no warnings 'uninitialized';
143 $path .= '/' if $path eq $loc;
145 $path =~ s/^($loc)?//;
147 $path =~ s/^($loc)?\///;
162 $self->params( { $self->_mod_perl_args( $self->ar ) } );
163 $self->query( $self->params );
166 =item redirect_request
168 Sets output headers to redirect based on the arguments provided
170 Accepts either a single argument of the full url to redirect to, or a hash of
173 $r->redirect_request('http://www.example.com/path');
177 $r->redirect_request(protocol=>'https', domain=>'www.example.com', path=>'/path/file?arguments', status=>'302', url=>'..');
179 The named parameters are protocol, domain, path, status and url
181 Only 1 named parameter is required but other than url, they can be combined as
182 required and current values (from the request) will be used in place of any
183 missing arguments. The url argument must be a full url including protocol and
184 can only be combined with status.
188 sub redirect_request {
190 my $redirect_url = $_[0];
191 my $status = $MODPERL2 ? eval 'Apache2::Const::REDIRECT;' :
192 eval 'Apache::Constants::REDIRECT;'; # why have to eval this?
196 $redirect_url = $args{url};
198 my $path = $args{path} || $r->path;
199 my $host = $args{domain} || $r->ar->hostname;
200 my $protocol = $args{protocol} || $r->get_protocol;
202 $redirect_url = URI->new;
203 $redirect_url->scheme($protocol);
204 $redirect_url->host($host);
205 $redirect_url->path($path);
207 $status = $args{status} if ($args{status});
210 $r->ar->status($status);
211 $r->ar->headers_out->set('Location' => $redirect_url);
222 my $protocol = ( $self->ar->protocol =~ m/https/i ) ? 'https' : 'http' ;
232 $r->ar->content_type(
233 $r->content_type =~ m/^text/
234 ? $r->content_type . "; charset=" . $r->document_encoding
237 $r->ar->headers_out->set(
238 "Content-Length" => do { use bytes; length $r->output }
241 foreach ($r->headers_out->field_names) {
242 next if /^Content-(Type|Length)/;
243 $r->ar->headers_out->set($_ => $r->headers_out->get($_));
246 $MODPERL2 || $r->ar->send_http_header;
247 $r->ar->print( $r->output );
250 =item get_template_root
254 sub get_template_root {
256 $r->ar->document_root . "/" . $r->ar->location;
263 #########################################################
264 # private / internal methods and subs
268 my ( $self, $apr ) = @_;
270 if ($apr->isa('Apache::Request')) {
271 foreach my $key ( $apr->param ) {
272 my @values = $apr->param($key);
273 $args{$key} = @values == 1 ? $values[0] : \@values;
276 my $body = $self->_prepare_body($apr);
277 %args = %{$body->param};
278 my $uri = URI->new($self->ar->unparsed_uri);
279 foreach my $key ($uri->query_param) {
280 if (ref $args{$key}) {
281 push (@{$args{$key}}, $uri->query_param($key));
284 $args{$key} = [ $args{$key}, $uri->query_param($key) ];
286 my @args = $uri->query_param($key);
287 if (scalar @args > 1) {
288 $args{$key} = [ $uri->query_param($key) ];
290 $args{$key} = $uri->query_param($key);
300 my ( $self, $r ) = @_;
302 unless ($self->{__http_body}) {
303 my $content_type = $r->headers_in->get('Content-Type');
304 my $content_length = $r->headers_in->get('Content-Length');
305 my $body = HTTP::Body->new( $content_type, $content_length );
306 my $length = $content_length;
308 $r->read( my $buffer, ( $length < 8192 ) ? $length : 8192 );
309 $length -= length($buffer);
312 $self->{__http_body} = $body;
314 return $self->{__http_body};
321 Simon Cozens, C<simon@cpan.org>
326 Marcus Ramberg, C<marcus@thefeed.no>
327 Sebastian Riedel, C<sri@oook.de>
331 You may distribute this code under the same terms as Perl itself.