CGI-Fast-2.15/ 000755 000765 000120 00000000000 13450326566 014241 5 ustar 00leejohnson admin 000000 000000 CGI-Fast-2.15/README 000644 000765 000120 00000014637 13447357515 015140 0 ustar 00leejohnson admin 000000 000000 # NAME CGI::Fast - CGI Interface for Fast CGI
# SYNOPSIS use CGI::Fast socket_path => '9000', socket_perm => 0777, listen_queue => 50; use CGI qw/ :standard /; $COUNTER = 0; # optional, will default to STDOUT, STDERR CGI::Fast->file_handles({ fcgi_output_file_handle => IO::Handle->new, fcgi_error_file_handle => IO::Handle->new, }); while ($q = CGI::Fast->new) { process_request($q); } # DESCRIPTION CGI::Fast is a subclass of the CGI object created by CGI.pm. It is specialized to work with the FCGI module, which greatly speeds up CGI scripts by turning them into persistently running server processes. Scripts that perform time-consuming initialization processes, such as loading large modules or opening persistent database connections, will see large performance improvements. Note that as CGI::Fast is based on CGI.pm it is no longer advised as a way to write Perl web apps. See [https://metacpan.org/pod/CGI#CGI.pm-HAS-BEEN-REMOVED-FROM-THE-PERL-CORE](https://metacpan.org/pod/CGI#CGI.pm-HAS-BEEN-REMOVED-FROM-THE-PERL-CORE) for more information about this # OTHER PIECES OF THE PUZZLE In order to use CGI::Fast you'll need the FCGI module. See http://www.cpan.org/ for details. # WRITING FASTCGI PERL SCRIPTS FastCGI scripts are persistent: one or more copies of the script are started up when the server initializes, and stay around until the server exits or they die a natural death. After performing whatever one-time initialization it needs, the script enters a loop waiting for incoming connections, processing the request, and waiting some more. A typical FastCGI script will look like this: #!perl use CGI::Fast; do_some_initialization(); while ($q = CGI::Fast->new) { process_request($q); } Each time there's a new request, CGI::Fast returns a CGI object to your loop. The rest of the time your script waits in the call to new(). When the server requests that your script be terminated, new() will return undef. You can of course exit earlier if you choose. A new version of the script will be respawned to take its place (this may be necessary in order to avoid Perl memory leaks in long-running scripts). CGI.pm's default CGI object mode also works. Just modify the loop this way: while (CGI::Fast->new) { process_request(); } Calls to header(), start\_form(), etc. will all operate on the current request. # INSTALLING FASTCGI SCRIPTS See the FastCGI developer's kit documentation for full details. On the Apache server, the following line must be added to srm.conf: AddType application/x-httpd-fcgi .fcgi FastCGI scripts must end in the extension .fcgi. For each script you install, you must add something like the following to srm.conf: FastCgiServer /usr/etc/httpd/fcgi-bin/file_upload.fcgi -processes 2 This instructs Apache to launch two copies of file\_upload.fcgi at startup time. # USING FASTCGI SCRIPTS AS CGI SCRIPTS Any script that works correctly as a FastCGI script will also work correctly when installed as a vanilla CGI script. However it will not see any performance benefit. # EXTERNAL FASTCGI SERVER INVOCATION FastCGI supports a TCP/IP transport mechanism which allows FastCGI scripts to run external to the webserver, perhaps on a remote machine. To configure the webserver to connect to an external FastCGI server, you would add the following to your srm.conf: FastCgiExternalServer /usr/etc/httpd/fcgi-bin/file_upload.fcgi -host sputnik:8888 Two environment variables affect how the `CGI::Fast` object is created, allowing `CGI::Fast` to be used as an external FastCGI server. (See `FCGI` documentation for `FCGI::OpenSocket` for more information.) You can set these as ENV variables or imports in the use CGI::Fast statement. If the ENV variables are set then these will be favoured so you can override the import statements on the command line, etc. - FCGI\_SOCKET\_PATH / socket\_path The address (TCP/IP) or path (UNIX Domain) of the socket the external FastCGI script to which bind an listen for incoming connections from the web server. - FCGI\_SOCKET\_PERM / socket\_perm Permissions for UNIX Domain socket. - FCGI\_LISTEN\_QUEUE / listen\_queue Maximum length of the queue of pending connections, defaults to 100. For example: use CGI::Fast socket_path => "sputnik:8888", listen_queue => "50" ; use CGI qw/ :standard /; do_some_initialization(); while ($q = CGI::Fast->new) { process_request($q); } Or: use CGI::Fast; use CGI qw/ :standard /; do_some_initialization(); $ENV{FCGI_SOCKET_PATH} = "sputnik:8888"; $ENV{FCGI_LISTEN_QUEUE} = 50; while ($q = CGI::Fast->new) { process_request($q); } Note the importance of having use CGI after use CGI::Fast as this will prevent any CGI import pragmas being overwritten by CGI::Fast. You can use CGI::Fast as a drop in replacement like so: use CGI::Fast qw/ :standard / # FILE HANDLES FCGI defaults to using STDOUT and STDERR as its output filehandles - this may lead to unexpected redirect of output if you migrate scripts from CGI.pm to CGI::Fast. To get around this you can use the file\_handles method, which you must do **before** the first call to CGI::Fast->new. For example using IO::Handle: CGI::Fast->file_handles({ fcgi_output_file_handle => IO::Handle->new, fcgi_error_file_handle => IO::Handle->new, }); while (CGI::Fast->new) { .. } Overriding STDIN using the `fcgi_input_file_handle` key is also possible, however doing so is likely to break at least POST requests. # CAVEATS I haven't tested this very much. # LICENSE Copyright 1996-1998, Lincoln D. Stein. All rights reserved. Currently maintained by Lee Johnson This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. Address bug reports and comments to: https://github.com/leejo/cgi-fast # BUGS This section intentionally left blank. # SEE ALSO [CGI::Carp](https://metacpan.org/pod/CGI::Carp), [CGI](https://metacpan.org/pod/CGI) CGI-Fast-2.15/Changes 000644 000765 000120 00000006370 13447357645 015552 0 ustar 00leejohnson admin 000000 000000 Revision history for CGI::Fast 2.15 2019-03-29 [FIX] - ensure upload hooks are passed to CGI.pm constructor (GH #19, thanks to ikegami) 2.14 2019-03-26 [DOCUMENTATION] - Add a link to the "you probably shouldn't use CGI.pm" docs 2.13 2017-11-17 [TESTING] remove use of Test::Deep completely (GH #17) 2.12 2016-11-22 [DOCUMENTATION] - tweak docs about overriding STDIN due to interference with POST requests (GH #16, thanks to melak) 2.11 2016-11-17 [FIX] - make sure we use CGI::Carp as we depend on it (GH #15, thanks to melak) 2.10 2015-06-22 [DOCUMENTATION] - Kwalitee improvements in distribution 2.09 2015-03-08 [DOCUMENTATION] - Clarify order of use statements when using both CGI and CGI::Fast - Replace indirect object notation with ->new [TESTING] - Tests for CGI imports and load order 2.07 2015-02-23 [FIX] - test added in 2.06 should use File::Temp 2.06 2015-02-23 [FEATURE] - Add support for changing socket permissions. Thanks to powerman for the patch and tests 2.05 2014-12-11 [TESTING] remove useless use of Test::Deep in tests this patch was sourced from the fedora perl-devel mailing list[1], in which i see more patches for CGI - fedora perl-devel people: if you're going to patch modules then please send those patches upstream where relevant. many perl modules are now on github (including this one) so it's easy, and it prevents alternate versions of modules that could lead to frustrating debugging sessions because *your* version of FCGI (2.04) is different to what the *real* version of FCGI (2.04) is[2]. * [1] https://lists.fedoraproject.org/pipermail/perl-devel * [2] the "real" version of FCGI being that available on CPAN 2.04 2014-10-12 [TESTING] - Fix tests for recent version of CGI (v4.05+), which removed the -private_tempfiles pragma and PRIVATE_TEMPFILES variable, so use on that is still available for testing 2.03 2014-09-06 [DOCUMENTATION] - Kwalitee improvements in distribution (LICENSE) [TESTING] - Add t/006_changes.t to check Changes file 2.02 2014-06-05 [INTERNALS] - allow FCGI_SOCKET_PATH and FCGI_LISTEN_QUEUE ENV variables to be passed in as import settings, although favour ENV variables if set - delay creation of FCGI::Request until the first call to CGI::Fast->new (RT #70609), removing the need to defined these in a BEGIN block - add test to check ENV values are not recycled from old requests and not set as defaults when the FCGI_SOCKET_PATH is used (RT #65492) - add file_handles method to allow setting of file handles to be passed to FCGI (RT #94423) [DOCUMENTATION] - document above changes - general tidy up 2.01 2014-05-27 [DOCUMENTATION] - update perldoc to list current bugtracker and maintainer - pod2readme the perldoc to replace content of README with something sane 2.00 2014-05-22 [DOCUMENTATION] - Repointing bugtracker at newly forked github repo - Tickets migrated from RT to github issues (both CGI and CGI.pm distributions) - Bump version to 2.00 for clear boundary of above changes - For previous Changes please see CGI.pm prior to 3.65_01 CGI-Fast-2.15/MANIFEST 000644 000765 000120 00000000557 13450326566 015401 0 ustar 00leejohnson admin 000000 000000 Changes lib/CGI/Fast.pm Makefile.PL MANIFEST README README.md t/001_basic.t t/002_import.t t/003_env_pollution.t t/004_fcgi_file_handles.t t/005_no_file_handles.t t/006_changes.t t/007_socket_perm.t META.yml Module YAML meta-data (added by MakeMaker) META.json Module JSON meta-data (added by MakeMaker) CGI-Fast-2.15/t/ 000755 000765 000120 00000000000 13450326566 014504 5 ustar 00leejohnson admin 000000 000000 CGI-Fast-2.15/META.yml 000644 000765 000120 00000001355 13450326566 015516 0 ustar 00leejohnson admin 000000 000000 --- abstract: unknown author: - unknown build_requires: File::Temp: '0' Test::More: '0' configure_requires: {} dynamic_config: 1 generated_by: 'ExtUtils::MakeMaker version 7.34, CPAN::Meta::Converter version 2.150010' license: perl meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: '1.4' name: CGI-Fast no_index: directory: - t - inc - t requires: CGI: '4' Carp: '0' FCGI: '0.67' if: '0' perl: '5.008001' resources: bugtracker: https://github.com/leejo/cgi-fast/issues homepage: https://metacpan.org/module/CGI::Fast license: http://dev.perl.org/licenses/ repository: https://github.com/leejo/cgi-fast version: '2.15' x_serialization_backend: 'CPAN::Meta::YAML version 0.018' CGI-Fast-2.15/META.json 000644 000765 000120 00000002515 13450326566 015665 0 ustar 00leejohnson admin 000000 000000 { "abstract" : "unknown", "author" : [ "unknown" ], "dynamic_config" : 1, "generated_by" : "ExtUtils::MakeMaker version 7.34, CPAN::Meta::Converter version 2.150010", "license" : [ "perl_5" ], "meta-spec" : { "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", "version" : 2 }, "name" : "CGI-Fast", "no_index" : { "directory" : [ "t", "inc", "t" ] }, "prereqs" : { "build" : { "requires" : {} }, "configure" : { "requires" : {} }, "runtime" : { "requires" : { "CGI" : "4", "Carp" : "0", "FCGI" : "0.67", "if" : "0", "perl" : "5.008001" } }, "test" : { "requires" : { "File::Temp" : "0", "Test::More" : "0" } } }, "release_status" : "stable", "resources" : { "bugtracker" : { "web" : "https://github.com/leejo/cgi-fast/issues" }, "homepage" : "https://metacpan.org/module/CGI::Fast", "license" : [ "http://dev.perl.org/licenses/" ], "repository" : { "url" : "https://github.com/leejo/cgi-fast" } }, "version" : "2.15", "x_serialization_backend" : "JSON::PP version 2.97001" } CGI-Fast-2.15/README.md 000644 000765 000120 00000014637 13447357515 015537 0 ustar 00leejohnson admin 000000 000000 # NAME CGI::Fast - CGI Interface for Fast CGI # SYNOPSIS use CGI::Fast socket_path => '9000', socket_perm => 0777, listen_queue => 50; use CGI qw/ :standard /; $COUNTER = 0; # optional, will default to STDOUT, STDERR CGI::Fast->file_handles({ fcgi_output_file_handle => IO::Handle->new, fcgi_error_file_handle => IO::Handle->new, }); while ($q = CGI::Fast->new) { process_request($q); } # DESCRIPTION CGI::Fast is a subclass of the CGI object created by CGI.pm. It is specialized to work with the FCGI module, which greatly speeds up CGI scripts by turning them into persistently running server processes. Scripts that perform time-consuming initialization processes, such as loading large modules or opening persistent database connections, will see large performance improvements. Note that as CGI::Fast is based on CGI.pm it is no longer advised as a way to write Perl web apps. See [https://metacpan.org/pod/CGI#CGI.pm-HAS-BEEN-REMOVED-FROM-THE-PERL-CORE](https://metacpan.org/pod/CGI#CGI.pm-HAS-BEEN-REMOVED-FROM-THE-PERL-CORE) for more information about this # OTHER PIECES OF THE PUZZLE In order to use CGI::Fast you'll need the FCGI module. See http://www.cpan.org/ for details. # WRITING FASTCGI PERL SCRIPTS FastCGI scripts are persistent: one or more copies of the script are started up when the server initializes, and stay around until the server exits or they die a natural death. After performing whatever one-time initialization it needs, the script enters a loop waiting for incoming connections, processing the request, and waiting some more. A typical FastCGI script will look like this: #!perl use CGI::Fast; do_some_initialization(); while ($q = CGI::Fast->new) { process_request($q); } Each time there's a new request, CGI::Fast returns a CGI object to your loop. The rest of the time your script waits in the call to new(). When the server requests that your script be terminated, new() will return undef. You can of course exit earlier if you choose. A new version of the script will be respawned to take its place (this may be necessary in order to avoid Perl memory leaks in long-running scripts). CGI.pm's default CGI object mode also works. Just modify the loop this way: while (CGI::Fast->new) { process_request(); } Calls to header(), start\_form(), etc. will all operate on the current request. # INSTALLING FASTCGI SCRIPTS See the FastCGI developer's kit documentation for full details. On the Apache server, the following line must be added to srm.conf: AddType application/x-httpd-fcgi .fcgi FastCGI scripts must end in the extension .fcgi. For each script you install, you must add something like the following to srm.conf: FastCgiServer /usr/etc/httpd/fcgi-bin/file_upload.fcgi -processes 2 This instructs Apache to launch two copies of file\_upload.fcgi at startup time. # USING FASTCGI SCRIPTS AS CGI SCRIPTS Any script that works correctly as a FastCGI script will also work correctly when installed as a vanilla CGI script. However it will not see any performance benefit. # EXTERNAL FASTCGI SERVER INVOCATION FastCGI supports a TCP/IP transport mechanism which allows FastCGI scripts to run external to the webserver, perhaps on a remote machine. To configure the webserver to connect to an external FastCGI server, you would add the following to your srm.conf: FastCgiExternalServer /usr/etc/httpd/fcgi-bin/file_upload.fcgi -host sputnik:8888 Two environment variables affect how the `CGI::Fast` object is created, allowing `CGI::Fast` to be used as an external FastCGI server. (See `FCGI` documentation for `FCGI::OpenSocket` for more information.) You can set these as ENV variables or imports in the use CGI::Fast statement. If the ENV variables are set then these will be favoured so you can override the import statements on the command line, etc. - FCGI\_SOCKET\_PATH / socket\_path The address (TCP/IP) or path (UNIX Domain) of the socket the external FastCGI script to which bind an listen for incoming connections from the web server. - FCGI\_SOCKET\_PERM / socket\_perm Permissions for UNIX Domain socket. - FCGI\_LISTEN\_QUEUE / listen\_queue Maximum length of the queue of pending connections, defaults to 100. For example: use CGI::Fast socket_path => "sputnik:8888", listen_queue => "50" ; use CGI qw/ :standard /; do_some_initialization(); while ($q = CGI::Fast->new) { process_request($q); } Or: use CGI::Fast; use CGI qw/ :standard /; do_some_initialization(); $ENV{FCGI_SOCKET_PATH} = "sputnik:8888"; $ENV{FCGI_LISTEN_QUEUE} = 50; while ($q = CGI::Fast->new) { process_request($q); } Note the importance of having use CGI after use CGI::Fast as this will prevent any CGI import pragmas being overwritten by CGI::Fast. You can use CGI::Fast as a drop in replacement like so: use CGI::Fast qw/ :standard / # FILE HANDLES FCGI defaults to using STDOUT and STDERR as its output filehandles - this may lead to unexpected redirect of output if you migrate scripts from CGI.pm to CGI::Fast. To get around this you can use the file\_handles method, which you must do **before** the first call to CGI::Fast->new. For example using IO::Handle: CGI::Fast->file_handles({ fcgi_output_file_handle => IO::Handle->new, fcgi_error_file_handle => IO::Handle->new, }); while (CGI::Fast->new) { .. } Overriding STDIN using the `fcgi_input_file_handle` key is also possible, however doing so is likely to break at least POST requests. # CAVEATS I haven't tested this very much. # LICENSE Copyright 1996-1998, Lincoln D. Stein. All rights reserved. Currently maintained by Lee Johnson This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. Address bug reports and comments to: https://github.com/leejo/cgi-fast # BUGS This section intentionally left blank. # SEE ALSO [CGI::Carp](https://metacpan.org/pod/CGI::Carp), [CGI](https://metacpan.org/pod/CGI) CGI-Fast-2.15/lib/ 000755 000765 000120 00000000000 13450326566 015007 5 ustar 00leejohnson admin 000000 000000 CGI-Fast-2.15/Makefile.PL 000644 000765 000120 00000003216 13446357414 016216 0 ustar 00leejohnson admin 000000 000000 use ExtUtils::MakeMaker; my $mm = $ExtUtils::MakeMaker::VERSION; # See lib/ExtUtils/MakeMaker.pm for details of how to influence # the contents of the Makefile that is written. WriteMakefile( INSTALLDIRS => ( $] >= 5.012 ? 'site' : 'perl' ), NAME => 'CGI::Fast', DISTNAME => 'CGI-Fast', VERSION_FROM => 'lib/CGI/Fast.pm', LICENSE => 'perl', MIN_PERL_VERSION => '5.8.1', PREREQ_PM => { 'if' => 0, # core in 5.6.2 and later, for deprecate.pm 'CGI' => 4.00, 'FCGI' => 0.67, 'Carp' => 0, # Carp was first released with perl 6 }, TEST_REQUIRES => { 'Test::More' => 0, 'File::Temp' => 0, }, test => { TESTS => 't/*.t' }, linkext => { LINKTYPE => '' }, # no link needed dist => { COMPRESS => 'gzip -9f', SUFFIX => 'gz', ZIP => '/usr/bin/zip', ZIPFLAGS => '-rl' }, ( $mm < 6.46 ? () : ( META_MERGE => { requires => { perl => '5.008001' }, resources => { license => 'http://dev.perl.org/licenses/', homepage => 'https://metacpan.org/module/CGI::Fast', repository => 'https://github.com/leejo/cgi-fast', bugtracker => 'https://github.com/leejo/cgi-fast/issues', }, no_index => { directory => [qw/t/] }, }, META_ADD => { build_requires => {}, configure_requires => {} }, ) ), ); CGI-Fast-2.15/lib/CGI/ 000755 000765 000120 00000000000 13450326566 015411 5 ustar 00leejohnson admin 000000 000000 CGI-Fast-2.15/lib/CGI/Fast.pm 000644 000765 000120 00000023065 13447357505 016655 0 ustar 00leejohnson admin 000000 000000 package CGI::Fast; use strict; use warnings; use if $] >= 5.019, 'deprecate'; $CGI::Fast::VERSION='2.15'; use CGI; use CGI::Carp; use FCGI; # use vars works like "our", but is compatible with older Perls. use vars qw( @ISA $ignore ); @ISA = ('CGI'); # workaround for known bug in libfcgi while (($ignore) = each %ENV) { } # override the initialization behavior so that # state is NOT maintained between invocations sub save_request { # no-op } # If ENV{FCGI_SOCKET_PATH} is specified, we maintain a FCGI Request handle # in this package variable. use vars qw($Ext_Request $socket $socket_perm $queue); sub import { my ($package,@import) = @_; # check imports for this class then pass on # imports to SUPER class for (my $i = 0; $i < scalar( @import ); $i++) { if ( $import[$i] eq 'socket_path' ) { $socket = $import[$i+1]; } elsif ( $import[$i] eq 'socket_perm' ) { $socket_perm = $import[$i+1]; } elsif ( $import[$i] eq 'listen_queue' ) { $queue = $import[$i+1]; } } $package->SUPER::import(@import); } sub _create_fcgi_request { my ( $in_fh,$out_fh,$err_fh ) = @_; # If we have a socket set, explicitly open it if ($ENV{FCGI_SOCKET_PATH} or $socket) { my $path = $ENV{FCGI_SOCKET_PATH} || $socket; my $perm = $ENV{FCGI_SOCKET_PERM} || $socket_perm; my $backlog = $ENV{FCGI_LISTEN_QUEUE} || $queue || 100; my $socket = FCGI::OpenSocket( $path, $backlog ); if ($path !~ /^:/ && defined $perm) { chmod $perm, $path or croak( "Couldn't chmod($path): $!" ); } return FCGI::Request( ( $in_fh || \*STDIN ), ( $out_fh || \*STDOUT ), ( $err_fh || \*STDERR ), \%ENV, $socket, 1 ); } else { return FCGI::Request( ( $in_fh || \*STDIN ), ( $out_fh || \*STDOUT ), ( $err_fh || \*STDERR ), ); } } { my ( $in_fh,$out_fh,$err_fh ); sub file_handles { my ($self, $handles) = @_; if ( ref( $handles ) eq 'HASH' ) { $in_fh = delete( $handles->{fcgi_input_file_handle} ); $out_fh = delete( $handles->{fcgi_output_file_handle} ); $err_fh = delete( $handles->{fcgi_error_file_handle} ); } } sub new { # # the interface to the ->new method is unfortunately somewhat # overloaded as it can be passed: # # nothing # an upload hook, "something", 0 # an initializer, an upload hook, "something", 0 # # these then get passed through to the SUPER class (CGI.pm) that # also has a constructor that can take various order of args # my ($self, @args) = @_; if ( ! $args[0] || ( ref( $args[0] ) && UNIVERSAL::isa( $args[0],'CODE' ) && ! $args[3] ) ) { $Ext_Request ||= _create_fcgi_request( $in_fh,$out_fh,$err_fh ); my $accept = $Ext_Request->Accept; return undef unless ( defined $accept && $accept >= 0 ); } CGI->_reset_globals; $self->_setup_symbols(@CGI::SAVED_SYMBOLS) if @CGI::SAVED_SYMBOLS; return $CGI::Q = $self->SUPER::new(@args); } } 1; =head1 NAME CGI::Fast - CGI Interface for Fast CGI =for html