cgi::emulate::psgi(3pm) [debian man page]

CGI::Emulate::PSGI(3pm) 				User Contributed Perl Documentation				   CGI::Emulate::PSGI(3pm)

NAME

       CGI::Emulate::PSGI - PSGI adapter for CGI

SYNOPSIS

	   my $app = CGI::Emulate::PSGI->handler(sub {
	       # Existing CGI code
	   });

DESCRIPTION

       This module allows an application designed for the CGI environment to run in a PSGI environment, and thus on any of the backends that PSGI
       supports.

       It works by translating the environment provided by the PSGI specification to one expected by the CGI specification. Likewise, it captures
       output as it would be prepared for the CGI standard, and translates it to the format expected for the PSGI standard using CGI::Parse::PSGI
       module.

CGI.pm
       If your application uses CGI, be sure to cleanup the global variables in the handler loop yourself, so:

	   my $app = CGI::Emulate::PSGI->handler(sub {
	       use CGI;
	       CGI::initialize_globals();
	       my $q = CGI->new;
	       # ...
	   });

       Otherwise previous request variables will be reused in the new requests.

       Alternatively, you can install and use CGI::Compile from CPAN and compiles your existing CGI scripts into a sub that is perfectly ready to
       be converted to PSGI application using this module.

	 my $sub = CGI::Compile->compile("/path/to/script.cgi");
	 my $app = CGI::Emulate::PSGI->handler($sub);

       This will take care of assigning an unique namespace for each script etc. See CGI::Compile for details.

       You can also consider using CGI::PSGI but that would require you to slightly change your code from:

	 my $q = CGI->new;
	 # ...
	 print $q->header, $output;

       into:

	 use CGI::PSGI;

	 my $app = sub {
	     my $env = shift;
	     my $q = CGI::PSGI->new($env);
	     # ...
	     return [ $q->psgi_header, [ $output ] ];
	 };

       See CGI::PSGI for details.

METHODS

       handler
	     my $app = CGI::Emulate::PSGI->handler($code);

	   Creates a PSGI application code reference out of CGI code reference.

       emulate_environment
	     my %env = CGI::Emulate::PSGI->emulate_environment($env);

	   Creates an environment hash out of PSGI environment hash. If your code or framework just needs an environment variable emulation, use
	   this method like:

	     local %ENV = (%ENV, CGI::Emulate::PSGI->emulate_environment($env));
	     # run your application

	   If you use "handler" method to create a PSGI environment hash, this is automatically called in the created application.

AUTHOR

       Tokuhiro Matsuno <tokuhirom@cpan.org>

       Tatsuhiko Miyagawa

COPYRIGHT AND LICENSE

       Copyright (c) 2009-2010 by tokuhirom.

       This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

       The full text of the license can be found in the LICENSE file included with this module.

SEE ALSO

       PSGI CGI::Compile CGI::PSGI Plack CGI::Parse::PSGI

perl v5.14.2							    2012-03-18						   CGI::Emulate::PSGI(3pm)

CGI::PSGI(3pm)						User Contributed Perl Documentation					    CGI::PSGI(3pm)

NAME

       CGI::PSGI - Adapt CGI.pm to the PSGI protocol

SYNOPSIS

	 use CGI::PSGI;

	 my $app = sub {
	     my $env = shift;
	     my $q = CGI::PSGI->new($env);
	     return [ $q->psgi_header, [ $body ] ];
	 };

DESCRIPTION

       This module is for web application framework developers who currently uses CGI to handle query parameters, and would like for the
       frameworks to comply with the PSGI protocol.

       Only slight modifications should be required if the framework is already collecting the body content to print to STDOUT at one place
       (rather using the print-as-you-go approach).

       On the other hand, if you are an "end user" of CGI.pm and have a CGI script that you want to run under PSGI web servers, this module might
       not be what you want.  Take a look at CGI::Emulate::PSGI instead.

       Your application, typically the web application framework adapter should update the code to do "CGI::PSGI->new($env)" instead of "CGI->new"
       to create a new CGI object. (This is similar to how CGI::Fast object is initialized in a FastCGI environment.)

INTERFACES SUPPORTED

       Only the object-oriented interface of CGI.pm is supported through CGI::PSGI.  This means you should always create an object with
       "CGI::PSGI->new($env)" and should call methods on the object.

       The function-based interface like "use CGI ':standard'" does not work with this module.

METHODS

       CGI::PSGI adds the following extra methods to CGI.pm:

   env
	 $env = $cgi->env;

       Returns the PSGI environment in a hash reference. This allows CGI.pm-based application frameworks such as CGI::Application to access PSGI
       extensions, typically set by Plack Middleware components.

       So if you enable Plack::Middleware::Session, your application and plugin developers can access the session via:

	 $cgi->env->{'plack.session'}->get("foo");

       Of course this should be coded carefully by checking the existence of "env" method as well as the hash key "plack.session".

   psgi_header
	my ($status_code, $headers_aref) = $cgi->psgi_header(%args);

       Works like CGI.pm's header(), but the return format is modified. It returns an array with the status code and arrayref of header pairs that
       PSGI requires.

       If your application doesn't use "$cgi->header", you can ignore this method and generate the status code and headers arrayref another way.

   psgi_redirect
	my ($status_code, $headers_aref) = $cgi->psgi_redirect(%args);

       Works like CGI.pm's redirect(), but the return format is modified. It returns an array with the status code and arrayref of header pairs
       that PSGI requires.

       If your application doesn't use "$cgi->redirect", you can ignore this method and generate the status code and headers arrayref another way.

LIMITATIONS

       Do not use CGI::Pretty or something similar in your controller. The module messes up CGI's DIY autoloader and breaks CGI::PSGI (and
       potentially other) inheritance.

AUTHOR

       Tatsuhiko Miyagawa <miyagawa@bulknews.net>

       Mark Stosberg <mark@summersault.com>

LICENSE

       This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO

       CGI, CGI::Emulate::PSGI

perl v5.12.4							    2011-08-29							    CGI::PSGI(3pm)