package Catalyst::Engine::CGI;
use strict;
-use base 'Catalyst::Engine';
-use URI;
+use base 'Catalyst::Engine::CGI::Base';
-require CGI::Simple;
-require CGI::Cookie;
-
-$CGI::Simple::POST_MAX = 1048576;
-$CGI::Simple::DISABLE_UPLOADS = 0;
+use CGI;
__PACKAGE__->mk_accessors('cgi');
=head1 SYNOPSIS
-See L<Catalyst>.
+A script using the Catalyst::Engine::CGI module might look like:
+
+ #!/usr/bin/perl -w
+
+ use strict;
+ use lib '/path/to/MyApp/lib';
+ use MyApp;
+
+ MyApp->run;
+
+The application module (C<MyApp>) would use C<Catalyst>, which loads the
+appropriate engine module.
=head1 DESCRIPTION
-This is the CGI engine for Catalyst.
+This is the Catalyst engine specialized for the CGI environment (using the
+C<CGI> and C<CGI::Cookie> modules). Normally Catalyst will select the
+appropriate engine according to the environment that it detects, however you
+can force Catalyst to use the CGI engine by specifying the following in your
+application module:
-=head2 METHODS
+ use Catalyst qw(-Engine=CGI);
-=head3 run
+The performance of this way of using Catalyst is not expected to be
+useful in production applications, but it may be helpful for development.
-To be called from a CGI script to start the Catalyst application.
+=head1 METHODS
-=head3 cgi
+=over 4
-This config parameter contains the C<CGI::Simple> object.
+=item $c->cgi
-=head2 OVERLOADED METHODS
+Contains the C<CGI> object.
-This class overloads some methods from C<Catalyst>.
+=back
-=head3 finalize_headers
+=head1 OVERLOADED METHODS
-=cut
+This class overloads some methods from C<Catalyst::Engine::CGI::Base>.
-sub finalize_headers {
- my $c = shift;
- my %headers = ( -nph => 1 );
- $headers{-status} = $c->response->status if $c->response->status;
- for my $name ( $c->response->headers->header_field_names ) {
- $headers{"-$name"} = $c->response->headers->header($name);
- }
- my @cookies;
- while ( my ( $name, $cookie ) = each %{ $c->response->cookies } ) {
- push @cookies, $c->cgi->cookie(
- -name => $name,
- -value => $cookie->{value},
- -expires => $cookie->{expires},
- -domain => $cookie->{domain},
- -path => $cookie->{path},
- -secure => $cookie->{secure} || 0
- );
- }
- $headers{-cookie} = \@cookies if @cookies;
- print $c->cgi->header(%headers);
-}
+=over 4
-=head3 finalize_output
+=item $c->prepare_body
=cut
-sub finalize_output {
+sub prepare_body {
my $c = shift;
- print $c->response->output;
+
+ # XXX this is undocumented in CGI.pm. If Content-Type is not
+ # application/x-www-form-urlencoded or multipart/form-data
+ # CGI.pm will read STDIN into a param, POSTDATA.
+
+ $c->request->body( $c->cgi->param('POSTDATA') );
}
-=head3 prepare_cookies
+=item $c->prepare_parameters
=cut
-sub prepare_cookies { shift->req->cookies( { CGI::Cookie->fetch } ) }
+sub prepare_parameters {
+ my $c = shift;
-=head3 prepare_headers
+ my ( @params );
-=cut
+ if ( $c->request->method eq 'POST' ) {
+ for my $param ( $c->cgi->url_param ) {
+ for my $value ( $c->cgi->url_param($param) ) {
+ push ( @params, $param, $value );
+ }
+ }
+ }
-sub prepare_headers {
- my $c = shift;
- $c->req->method( $c->cgi->request_method );
- for my $header ( $c->cgi->http ) {
- ( my $field = $header ) =~ s/^HTTPS?_//;
- $c->req->headers->header( $field => $c->cgi->http($header) );
+ for my $param ( $c->cgi->param ) {
+ for my $value ( $c->cgi->param($param) ) {
+ push ( @params, $param, $value );
+ }
}
+
+ $c->request->param(@params);
}
-=head3 prepare_parameters
+=item $c->prepare_request
=cut
-sub prepare_parameters {
- my $c = shift;
- my %vars = $c->cgi->Vars;
- while ( my ( $key, $value ) = each %vars ) {
- my @values = split "\0", $value;
- $vars{$key} = @values <= 1 ? $values[0] : \@values;
- }
- $c->req->parameters( {%vars} );
+sub prepare_request {
+ my ( $c, $cgi ) = @_;
+ $c->cgi( $cgi || CGI->new );
+ $c->cgi->_reset_globals;
}
-=head3 prepare_path
+=item $c->prepare_uploads
=cut
-sub prepare_path {
+sub prepare_uploads {
my $c = shift;
- $c->req->path( $c->cgi->url( -absolute => 1, -path_info => 1 ) );
- my $loc = $c->cgi->url( -absolute => 1 );
- no warnings 'uninitialized';
- $c->req->{path} =~ s/^($loc)?\///;
- $c->req->{path} .= '/' if $c->req->path eq $loc;
- my $base = $c->cgi->url;
- if ( $ENV{CATALYST_TEST} ) {
- my $script = $c->cgi->script_name;
- $base =~ s/$script$//i;
- }
- $base = URI->new($base);
- $base->path('/') if ( $ENV{CATALYST_TEST} || !$base->path );
- $c->req->base( $base->as_string );
- $c->req->server_base( $base->scheme . '://' . $base->authority . '/' );
-}
-=head3 prepare_request
+ my @uploads;
-=cut
+ for my $param ( $c->cgi->param ) {
-sub prepare_request { shift->cgi( CGI::Simple->new ) }
+ my @values = $c->cgi->param($param);
-=head3 prepare_uploads
+ next unless ref( $values[0] );
-=cut
+ for my $fh (@values) {
-sub prepare_uploads {
- my $c = shift;
- for my $name ( $c->cgi->upload ) {
- $c->req->uploads->{$name} = {
- fh => $c->cgi->upload($name),
- size => $c->cgi->upload_info( $name, 'size' ),
- type => $c->cgi->upload_info( $name, 'mime' )
- };
+ next unless my $size = ( stat $fh )[7];
+
+ my $info = $c->cgi->uploadInfo($fh);
+ my $tempname = $c->cgi->tmpFileName($fh);
+ my $type = $info->{'Content-Type'};
+ my $disposition = $info->{'Content-Disposition'};
+ my $filename = ( $disposition =~ / filename="([^;]*)"/ )[0];
+
+ my $upload = Catalyst::Request::Upload->new(
+ filename => $filename,
+ size => $size,
+ tempname => $tempname,
+ type => $type
+ );
+
+ push( @uploads, $param, $upload );
+ }
}
+
+ $c->request->upload(@uploads);
}
-sub run { shift->handler }
+=back
=head1 SEE ALSO
-L<Catalyst>.
+L<Catalyst> L<Catalyst::Engine> L<Catalyst::Engine::CGI::Base>.
=head1 AUTHOR
Sebastian Riedel, C<sri@cpan.org>
+Christian Hansen, C<ch@ngmedia.com>
=head1 COPYRIGHT
projects / catagits/Catalyst-Runtime.git / blobdiff