X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FController%2FWrapCGI.pm;h=8a66114429a3c66c0f4ca090401be01bdf1af4d7;hb=2369e5a42fcc6df4a949b9db7e05e2d875f9423b;hp=169725e8a6d7f5d3cb3738cc538b9e4e05a3bd03;hpb=71e6daf629655737c7074eff756e3c2a5d017b07;p=catagits%2FCatalyst-Controller-WrapCGI.git diff --git a/lib/Catalyst/Controller/WrapCGI.pm b/lib/Catalyst/Controller/WrapCGI.pm index 169725e..8a66114 100644 --- a/lib/Catalyst/Controller/WrapCGI.pm +++ b/lib/Catalyst/Controller/WrapCGI.pm @@ -1,21 +1,93 @@ package Catalyst::Controller::WrapCGI; -# AUTHOR: Matt S Trout, mst@shadowcatsystems.co.uk -# Original development sponsored by http://www.altinity.com/ - use strict; use warnings; -use base 'Catalyst::Controller'; +use parent 'Catalyst::Controller'; use HTTP::Request::AsCGI; use HTTP::Request; -use URI::Escape; +use URI; +use Catalyst::Exception (); + +=head1 NAME + +Catalyst::Controller::WrapCGI - Run CGIs in Catalyst + +=head1 VERSION + +Version 0.0023 + +=cut + +our $VERSION = '0.0023'; + +=head1 SYNOPSIS + + package MyApp::Controller::Foo; + + use parent qw/Catalyst::Controller::WrapCGI/; + + sub hello : Path('cgi-bin/hello.cgi') { + my ($self, $c) = @_; + + $self->cgi_to_response($c, sub { + use CGI ':standard'; + + print header, start_html('Hello'), + h1('Catalyst Rocks!'), + end_html; + }); + } + +In your .conf, configure which environment variables to pass: + + + + username_field username # used for REMOTE_USER env var + pass_env PERL5LIB + pass_env PATH + pass_env /^MYAPP_/ + + + +=head1 DESCRIPTION + +Allows you to run Perl code in a CGI environment derived from your L +context. + +If you just want to run CGIs from files, see L. + +=head1 CONFIGURATION + +C<$your_controller->{CGI}{pass_env}> should be an array of environment variables +or regular expressions to pass through to your CGIs. Entries surrounded by C +characters are considered regular expressions. + +Default is to pass the whole of C<%ENV>. + +C<{CGI}{username_field}> should be the field for your user's name, which will be +read from C<$c->user->obj>. Defaults to 'username'. + +See L for an example. + +=cut # Hack-around because Catalyst::Engine::HTTP goes and changes # them to be the remote socket, and FCGI.pm does even dumber things. -open(*REAL_STDIN, "<&=".fileno(*STDIN)); -open(*REAL_STDOUT, ">>&=".fileno(*STDOUT)); +open my $REAL_STDIN, "<&=".fileno(*STDIN); +open my $REAL_STDOUT, ">>&=".fileno(*STDOUT); + +=head1 METHODS + +=head2 $self->cgi_to_response($c, $coderef) + +Does the magic of running $coderef in a CGI environment, and populating the +appropriate parts of your Catalyst context with the results. + +Calls wrap_cgi (below.) + +=cut sub cgi_to_response { my ($self, $c, $script) = @_; @@ -24,7 +96,9 @@ sub cgi_to_response { # if the CGI doesn't set the response code but sets location they were # probably trying to redirect so set 302 for them - if (length($res->headers->header('Location')) && $res->code == 200) { + my $location = $res->headers->header('Location'); + + if (defined $location && length $location && $res->code == 200) { $c->res->status(302); } else { $c->res->status($res->code); @@ -33,6 +107,21 @@ sub cgi_to_response { $c->res->headers($res->headers); } +=head2 $self->wrap_cgi($c, $coderef) + +Runs $coderef in a CGI environment using L, returns an +L. + +The CGI environment is set up based on $c. + +The environment variables to pass on are taken from the configuration for your +Controller, see L for an example. If you don't supply a list of +environment variables to pass, the whole of %ENV is used. + +Used by cgi_to_response (above), which is probably what you want to use as well. + +=cut + sub wrap_cgi { my ($self, $c, $call) = @_; my $req = HTTP::Request->new( @@ -47,38 +136,50 @@ sub wrap_cgi { local $/; $body_content = <$body>; } else { my $body_params = $c->req->body_parameters; - if (keys %$body_params) { - my @parts; - foreach my $key (keys %$body_params) { - my $raw = $body_params->{$key}; - foreach my $value (ref $raw ? @$raw : ($raw)) { - push(@parts, join('=', map { uri_escape($_) } ($key, $value))); - } - } - $body_content = join('&', @parts); + if (%$body_params) { + my $encoder = URI->new; + $encoder->query_form(%$body_params); + $body_content = $encoder->query; $req->content_type('application/x-www-form-urlencoded'); } } - #warn "Body type: ".$req->content_type; - #warn "Body: ${body_content}"; - + my @env; + + my $pass_env = $self->{CGI}{pass_env}; + $pass_env = [] if not defined $pass_env; + $pass_env = [ $pass_env ] unless ref $pass_env; + + for (@$pass_env) { + if (m!^/(.*)/\z!) { + my $re = qr/$1/; + push @env, grep /$re/, keys %ENV; + } else { + push @env, $_; + } + } + + @env = keys %ENV unless @env; + $req->content($body_content); $req->content_length(length($body_content)); - my $user = (($c->can('user_exists') && $c->user_exists) - ? $c->user_object->username + + my $username_field = $self->{CGI}{username_field} || 'username'; + + my $username = (($c->can('user_exists') && $c->user_exists) + ? eval { $c->user->obj->$username_field } : ''); my $env = HTTP::Request::AsCGI->new( $req, - REMOTE_USER => $user, - PERL5LIB => $ENV{PERL5LIB} # propagate custom perl lib paths + ($username ? (REMOTE_USER => $username) : ()), + map { ($_, $ENV{$_}) } @env ); { - local *STDIN = \*REAL_STDIN; # restore the real ones so the filenos - local *STDOUT = \*REAL_STDOUT; # are 0 and 1 for the env setup + local *STDIN = $REAL_STDIN; # restore the real ones so the filenos + local *STDOUT = $REAL_STDOUT; # are 0 and 1 for the env setup - my $old = select(REAL_STDOUT); # in case somebody just calls 'print' + my $old = select($REAL_STDOUT); # in case somebody just calls 'print' my $saved_error; @@ -89,11 +190,68 @@ sub wrap_cgi { select($old); - warn "CGI invoke failed: $saved_error" if $saved_error; - + Catalyst::Exception->throw( + message => "CGI invocation failed: $saved_error" + ) if $saved_error; } return $env->response; } -1; +=head1 ACKNOWLEDGEMENTS + +Original development sponsored by L + +=head1 SEE ALSO + +L, L, +L, L, L + +=head1 AUTHOR + +Matt S. Trout, C<< >> + +=head1 BUGS + +Please report any bugs or feature requests to C, or through the web interface at +L. +I will be notified, and then you'll automatically be notified of progress on +your bug as I make changes. + +=head1 SUPPORT + +More information at: + +=over 4 + +=item * RT: CPAN's request tracker + +L + +=item * AnnoCPAN: Annotated CPAN documentation + +L + +=item * CPAN Ratings + +L + +=item * Search CPAN + +L + +=back + +=head1 COPYRIGHT & LICENSE + +Copyright (c) 2008 Matt S. Trout + +This program is free software; you can redistribute it and/or modify it +under the same terms as Perl itself. + +=cut + +1; # End of Catalyst::Controller::WrapCGI + +# vim: expandtab shiftwidth=2 ts=2 tw=80: