diff options
-rw-r--r-- | Changes | 240 | ||||
-rw-r--r-- | MANIFEST | 23 | ||||
-rw-r--r-- | META.yml | 28 | ||||
-rw-r--r-- | Makefile.PL | 12 | ||||
-rw-r--r-- | README | 13 | ||||
-rw-r--r-- | SIGNATURE | 46 | ||||
-rw-r--r-- | ex/sample_server | 9 | ||||
-rw-r--r-- | inc/Module/Install.pm | 474 | ||||
-rw-r--r-- | inc/Module/Install/Base.pm | 83 | ||||
-rw-r--r-- | inc/Module/Install/Can.pm | 154 | ||||
-rw-r--r-- | inc/Module/Install/Fetch.pm | 93 | ||||
-rw-r--r-- | inc/Module/Install/Makefile.pm | 418 | ||||
-rw-r--r-- | inc/Module/Install/Metadata.pm | 722 | ||||
-rw-r--r-- | inc/Module/Install/Win32.pm | 64 | ||||
-rw-r--r-- | inc/Module/Install/WriteAll.pm | 63 | ||||
-rw-r--r-- | lib/HTTP/Server/Simple.pm | 820 | ||||
-rw-r--r-- | lib/HTTP/Server/Simple/CGI.pm | 178 | ||||
-rw-r--r-- | lib/HTTP/Server/Simple/CGI/Environment.pm | 115 | ||||
-rw-r--r-- | t/00smoke.t | 11 | ||||
-rw-r--r-- | t/01live.t | 186 | ||||
-rw-r--r-- | t/02pod.t | 9 | ||||
-rw-r--r-- | t/03podcoverage.t | 9 | ||||
-rw-r--r-- | t/04cgi.t | 207 |
23 files changed, 3977 insertions, 0 deletions
@@ -0,0 +1,240 @@ +0.50 2015-02-02 + - All collected changes since 0.44 + +0.45_08 2015-01-29 + - IPv6 skipping code always turned off tests, rather than just + skipping on bad hosts. + +0.45_07 2015-01-27T22:24Z + - Skip IPv6 tests in 01live.t on machines where IPv6 isn't configured + +0.45_06 2015-01-23T17:55Z + - Further test iteration and diagnostics for smoke failures + +0.45_05 2015-01-22T16:23Z + - Test diagnostics for cpantester failures + - Hopefully better localhost handling + +0.45_04 2015-01-20T17:40Z + - Fix compatibility for the IPv6 support in .45_02 + - Hopefully improve the live tests + +0.45_03 2015-01-14T19:48Z + - Remove useless VERSION from HTTP::Server::Simple::CGI and + HTTP::Server::Simple::CGI::Environment + +0.45_02 2012-05-20T18:15Z + - Support for IPv6 - Daniel Kahn Gillmor [rt.cpan.org #61200] + +0.45_01 2011-09-22T10:10:41Z + - Support full URIs as required by RFC2616 - penfold [rt.cpan.org #69445] + +0.44 2011-04-04T16:59:59Z + - Fix tests to run in a FreeBSD Jail - Tom Hukins [rt.cpan.org #49807] + +0.43 2010-05-01T22:23:55Z + - Support for getting REMOTE_PORT -- rgs + +0.42_01 2010-04-02T12:59:48Z + - Patch to t/01live.t to prevent spurious win32 test failures. + +0.42 2010-02-18T10:13:11Z + - Inline uri_unescape to drop URI::Escape which is the only non-core + dependency of this distribution. -- miyagawa + - Do not special case COOKIE and sets Cookie header to HTTP_COOKIE. -- + miyagawa O'Reilly's WebSite server misuses COOKIE environment instead of + HTTP_COOKIE. We don't need to replicate that bug since + HTTP::Server::Simple is a server, not a CGI library like CGI.pm. + +0.41_01 2010-02-02T12:08:15Z + - Pluggable CGI class support based on a patch from NANIS + +0.41 2009-09-29T23:05:04Z + - HTTP header concatenation fixes from miyagawa + +0.40 2009-08-17T22:01:07Z + - After a fork, we need to reset the random seed lest we have + duplicated random numbers in both forks. + +0.39 2009-08-17T09:41:05Z + - Added signature tests + +0.38_04 2009-08-12T20:15:14Z + - Another pass at the Win32 fixes from KMX + +0.38_03 2009-04-11T18:47:29Z + - Subject: [rt.cpan.org #44961] [PATCH] xdg reports select() is + problematic on win32 + +0.38_02 2009-04-10T20:57:19Z + - Specify an HTTP version for our GETs should get escaping to wokr + +0.38_01 2009-03-02T18:11:46Z + - http://rt.cpan.org/Ticket/Attachment/568795/286902/ from confound++ for + http://rt.cpan.org/Public/Bug/Display.html?id=28122 + +0.38 2009-01-11T14:42:57Z + - Improve startup banner generation + +0.37 2009-01-02T12:21:30Z + - Several fixes for [rt.cpan.org #38011] designed to help get HSS to pass + tests on Strawberry Perl + +0.36 + - Documentation fixups + +0.35 + - Pass arguments to ->run through to Net::Server->run + +0.34 + - Call setup_environment if a Net::Server is being used, for consistency. + - Don't print_banner if a Net::Server is being used. + - Make header parsing comply with RFC 2616. [rt.cpan.org #21411] + +0.33 2008-04-25T13:57:30Z + - The new support for background processes notifying the parent didn't + quite work right for some apps using HSS. It's been reverted for now and + the tests TODOED + +0.32 2008-04-24T09:45:14Z + - At least Apache and lighttpd put unencoded strings into PATH_INFO, so so + should we. + - Patch from ntyni@iki.fi to make backgrounding of the standalone server's + server process deterministic. [rt.cpan.org #28122] + +0.31 2008-03-16T20:51:04Z + - Test suite parallelization fixes. Thanks to Slaven Rezic + +0.30 2008-03-11T12:14:24Z + - Minor doc fix from Paul Miller. + - Fixing doc style from "$this" to "$self" like any self-respecting perl + code + +0.29 2008-02-15T11:43:29Z + - new example section from almut on perlmonks + +0.28 2008-01-15T09:33:58Z + - New restartability support from Mark Stosberg After reviewing the code + in HTTP::Server::Simple, Catalyst::Engine::HTTP and HTTP::Server::Brick, + I found and implemented an updated signal handling approach that I like + and understand, and actually works. The current code restarted + immediately if a SIGHUP came in, no matter what was happening, including + if a request was in process of being fulfilled. The new code works more + like "apachectl graceful". It waits for the current request cycle to + finish, and then restarts the server. This code has to be integrated in + the core, but its just about the same amount of signal handling code + that was there... it just works better. It's also written in such a way + I think subclass/mixin authors could rewrite just these parts if they + wanted. Also, it looks like a Net::Server based sub-class would already + be doing its own thing with SIGHUP handling, and should continue to be + unaffected. + +0.27 + - 0.26 release apparently didn't get to cpan correctly + +0.26 + - Supports multi-line encoded values in query_sting (like foo%0Abar) -- + Dobrica Pavlinusic + - Fixes to URI unescaping to behave like apache does + +0.24 + - Hopefully deal with an odd case where a poorly behaved Internet Explorer + could crash the server. Thanks to the Catalyst project. + +0.23 + - Fix a release-engineering messup. Thanks to ANDK + +0.22 2006-10-18T23:36:34Z + - Query string processing improvements + +0.21 2006-10-18T23:31:42Z + - [rt.cpan.org #21727] [PATCH] Support for Perl 5.004 -- Sébastien + Aperghis-Tramoni + +0.20 + - Require POSIX only if we need it, rather than "use" it all the time + - [cpan #17533] - Brad Bowman + +0.19 + - Catch and ignore SIGPIPE, so broken pipes from the client don't cause + - Standalone to drop all the way back to the shell. + +0.18 + - new method: valid_http_method() from Chris Dent to make it easier to + - create servers handling non-standard HTTP verbs. + +0.17 + - Workaround for Class::Spiffy classloading order issue + - Better handling for completely mangled requests. + +0.16 2005-11-07T14:40:43Z + - SIG{'HUP'} does not exist on Win32 (cpan #15606) + +0.15 2005-10-06T21:11:02Z + - Precompute the local host's hostname and IP to save on DNS lookups at + runtime + +0.14 2005-10-06T20:48:49Z + - Split out HTTP::Server::Simple::CGI::Environment to support non-CGI.pm + CGIs + - Ignore SIGPIPE + - Signal handlers are now installed on ->run, not on new. Also, they're + - documented. Thanks to Mark Fowler. + - We no longer lookup $ENV{'REMOTE_HOST'} by hostname, as it can cause + huge performance problems. + +0.13 2005-08-09T21:25:20Z + - Signal handlers should be 'localed', so as not to mess with others' + - code. -- Thanks to David Wheeler + +0.12 2005-07-17T02:14:57Z + - Test suite improvements from Mattia Barbon + +0.11 2005-07-08T22:56:01Z + - Bogus META.yml broke signature checks. Thanks to sungo. + +0.10 2005-06-28T11:27:58Z + - Allow separate treatment of STDIN and STDOUT handles to the server. + This gives support for HTTP::Server::Simple::Recorder. + +0.09 2005-04-19T21:43:31Z + - Now we set the GATEWAY_INTERFACE metavariable in H:S:S:CGI. + +0.08 2005-04-16T01:27:17Z + - New tests for HTTP::Server:Simple::CGI from hide. + +0.07 2005-03-26T14:25:38Z + - PAUSE broke :/ + +0.05 2005-03-26T14:14:54Z + - Fix a bug in HTTP::Server::Simple::CGI that clobbered CGI ENV variables + in some cases. Thanks, Hide. + - New public subclass-overridable method ->net_server() that can + optionally take a Net::Server subclass name and use it to replace the + default ->run() method. -- Autrijus Tang + +0.04 2005-03-22T23:34:36Z + - Changed ->headers calling conventions. This may break backwards compat, + but is cleaner and safer. + - Fixed bugs in ::CGI that broke http header handling + - Refactored code to be more transparent + - Patch from Sebastian Riedel to do proper parsing of form data from STDIN + +0.03_03 2005-03-18T15:09:52Z + - Finish fixes from http://rt.cpan.org/NoAuth/Bug.html?id=11409 + +0.03_02 2005-02-17T23:34:00Z + - Make test script not depend on LWP + - Add ->header(), and various generic hook capabilities + - Made HTTP::Server::Simple::CGI use those hooks + - Add ->bad_request(), for protocol errors + +0.03_01 2005-02-17T21:39:34Z + - Add ->setup() and ->handler() + - Add support for specifying a host to bind listener to + - Split out CGI.pm support into sub-class + - Add Changes file to MANIFEST + +0.03 2005-01-26T08:55:34Z + - Test fixes for Win32 + diff --git a/MANIFEST b/MANIFEST new file mode 100644 index 0000000..3061522 --- /dev/null +++ b/MANIFEST @@ -0,0 +1,23 @@ +ex/sample_server +inc/Module/Install.pm +inc/Module/Install/Base.pm +inc/Module/Install/Can.pm +inc/Module/Install/Fetch.pm +inc/Module/Install/Makefile.pm +inc/Module/Install/Metadata.pm +inc/Module/Install/Win32.pm +inc/Module/Install/WriteAll.pm +lib/HTTP/Server/Simple.pm +lib/HTTP/Server/Simple/CGI.pm +lib/HTTP/Server/Simple/CGI/Environment.pm +Makefile.PL +MANIFEST This list of files +META.yml +README +Changes +t/00smoke.t +t/01live.t +t/02pod.t +t/03podcoverage.t +t/04cgi.t +SIGNATURE Public-key signature (added by MakeMaker) diff --git a/META.yml b/META.yml new file mode 100644 index 0000000..8e84e78 --- /dev/null +++ b/META.yml @@ -0,0 +1,28 @@ +--- +abstract: 'Lightweight HTTP server' +author: + - 'Best Practical Solutions, LLC <modules@bestpractical.com>' +build_requires: + ExtUtils::MakeMaker: 6.36 +configure_requires: + ExtUtils::MakeMaker: 6.36 +distribution_type: module +dynamic_config: 1 +generated_by: 'Module::Install version 1.14' +license: perl +meta-spec: + url: http://module-build.sourceforge.net/META-spec-v1.4.html + version: 1.4 +module_name: HTTP::Server::Simple +name: HTTP-Server-Simple +no_index: + directory: + - inc + - t +requires: + CGI: 0 + Socket: 1.94 + Test::More: 0 +resources: + license: http://dev.perl.org/licenses/ +version: '0.50' diff --git a/Makefile.PL b/Makefile.PL new file mode 100644 index 0000000..566eb55 --- /dev/null +++ b/Makefile.PL @@ -0,0 +1,12 @@ +use inc::Module::Install; + +all_from('lib/HTTP/Server/Simple.pm'); +name('HTTP-Server-Simple'); +license('perl'); +requires( + Socket => 1.94, + 'Test::More' => 0, + CGI => 0, +); + +WriteAll( sign => 1); @@ -0,0 +1,13 @@ +HTTP::Server::Simple is a very simple standalone HTTP daemon with no non-core +module dependencies. It's ideal for building a standalone http-based UI to +your existing tools. + +This code is a derivative of the "standalone_httpd" tool used by RT. +(http://bestpractical.com/rt) + +It's desperately short of tests and documentation. It wants your love and help. + + + + Jesse Vincent + jesse@bestpractical.com. diff --git a/SIGNATURE b/SIGNATURE new file mode 100644 index 0000000..ca628fc --- /dev/null +++ b/SIGNATURE @@ -0,0 +1,46 @@ +This file contains message digests of all files listed in MANIFEST, +signed via the Module::Signature module, version 0.73. + +To verify the content in this distribution, first make sure you have +Module::Signature installed, then type: + + % cpansign -v + +It will check each file's integrity, as well as the signature's +validity. If "==> Signature verified OK! <==" is not displayed, +the distribution may already have been compromised, and you should +not run its Makefile.PL or Build.PL. + +-----BEGIN PGP SIGNED MESSAGE----- +Hash: SHA1 + +SHA1 3b4aeced6dc6d37f087743690a414e43404b76cd Changes +SHA1 86a31bfdcdcd54159cbd433fd8dad4590ea172e9 MANIFEST +SHA1 3675a3d4721c4078d9bb8c0057b9a576a301635c META.yml +SHA1 df557a7200f6ada7c845d19638eb18066bee14b4 Makefile.PL +SHA1 ed0c107672daac3bc9e266876666e1059dbe44b7 README +SHA1 4ea1e9072ca87399184a46233df52a21e285604d ex/sample_server +SHA1 d2664c57b65686abbfbbe1e71229761625be4922 inc/Module/Install.pm +SHA1 da41a8d9904f7b409b49a5f6c338d3eb305a2b4b inc/Module/Install/Base.pm +SHA1 0db0afe19cd298abba248fa089e5525bd5ab3ab6 inc/Module/Install/Can.pm +SHA1 e7152bfd5ca67d0e33f96d09c59d600bca5c1f15 inc/Module/Install/Fetch.pm +SHA1 29ee1cb0dc262b00983e3a2f5cf00b538dff5069 inc/Module/Install/Makefile.pm +SHA1 e963f80cfe255f16e55067d1feb6841cff3ed2fe inc/Module/Install/Metadata.pm +SHA1 65a1f09af1f4f9e47a98b6b45667c328b1b2f9c0 inc/Module/Install/Win32.pm +SHA1 f191c49475b3f51775180cd4f7e41e3bdab7f85a inc/Module/Install/WriteAll.pm +SHA1 cd6bb1282e33e8cbb02829fa1c86bf327bd0a88b lib/HTTP/Server/Simple.pm +SHA1 6c552ef4704ad7ff0acde604fc984982c7bb586e lib/HTTP/Server/Simple/CGI.pm +SHA1 efaa8a14cc0ddd4003e34ca479edbd91653e3761 lib/HTTP/Server/Simple/CGI/Environment.pm +SHA1 db064af54cab345a71daec576e32e64b8fb1033d t/00smoke.t +SHA1 3f1c86d2671379e820015c7f4af006fe29a42f58 t/01live.t +SHA1 aca95653cfce68912e08c57b3a4566207e2f99b3 t/02pod.t +SHA1 a7024d0d8e7b80d26f75a3551a1406a797b382f8 t/03podcoverage.t +SHA1 5bbd2261889ddec155321fd8fbaf8395f4989e80 t/04cgi.t +-----BEGIN PGP SIGNATURE----- +Version: GnuPG v1 +Comment: GPGTools - http://gpgtools.org + +iEYEARECAAYFAlTPmYcACgkQ0+gKWp5CJQqnegCfUXavjBbrd0aMvyqDrjmS54fM +wzgAnjQpdQEls0x/toI4B5l5Wh4bUZRf +=SI56 +-----END PGP SIGNATURE----- diff --git a/ex/sample_server b/ex/sample_server new file mode 100644 index 0000000..a775623 --- /dev/null +++ b/ex/sample_server @@ -0,0 +1,9 @@ +#!perl + +use warnings; +use strict; + +use HTTP::Server::Simple::CGI; + +my $server = HTTP::Server::Simple->new(); +$server->run(); diff --git a/inc/Module/Install.pm b/inc/Module/Install.pm new file mode 100644 index 0000000..ff767fa --- /dev/null +++ b/inc/Module/Install.pm @@ -0,0 +1,474 @@ +#line 1 +package Module::Install; + +# For any maintainers: +# The load order for Module::Install is a bit magic. +# It goes something like this... +# +# IF ( host has Module::Install installed, creating author mode ) { +# 1. Makefile.PL calls "use inc::Module::Install" +# 2. $INC{inc/Module/Install.pm} set to installed version of inc::Module::Install +# 3. The installed version of inc::Module::Install loads +# 4. inc::Module::Install calls "require Module::Install" +# 5. The ./inc/ version of Module::Install loads +# } ELSE { +# 1. Makefile.PL calls "use inc::Module::Install" +# 2. $INC{inc/Module/Install.pm} set to ./inc/ version of Module::Install +# 3. The ./inc/ version of Module::Install loads +# } + +use 5.006; +use strict 'vars'; +use Cwd (); +use File::Find (); +use File::Path (); + +use vars qw{$VERSION $MAIN}; +BEGIN { + # All Module::Install core packages now require synchronised versions. + # This will be used to ensure we don't accidentally load old or + # different versions of modules. + # This is not enforced yet, but will be some time in the next few + # releases once we can make sure it won't clash with custom + # Module::Install extensions. + $VERSION = '1.14'; + + # Storage for the pseudo-singleton + $MAIN = undef; + + *inc::Module::Install::VERSION = *VERSION; + @inc::Module::Install::ISA = __PACKAGE__; + +} + +sub import { + my $class = shift; + my $self = $class->new(@_); + my $who = $self->_caller; + + #------------------------------------------------------------- + # all of the following checks should be included in import(), + # to allow "eval 'require Module::Install; 1' to test + # installation of Module::Install. (RT #51267) + #------------------------------------------------------------- + + # Whether or not inc::Module::Install is actually loaded, the + # $INC{inc/Module/Install.pm} is what will still get set as long as + # the caller loaded module this in the documented manner. + # If not set, the caller may NOT have loaded the bundled version, and thus + # they may not have a MI version that works with the Makefile.PL. This would + # result in false errors or unexpected behaviour. And we don't want that. + my $file = join( '/', 'inc', split /::/, __PACKAGE__ ) . '.pm'; + unless ( $INC{$file} ) { die <<"END_DIE" } + +Please invoke ${\__PACKAGE__} with: + + use inc::${\__PACKAGE__}; + +not: + + use ${\__PACKAGE__}; + +END_DIE + + # This reportedly fixes a rare Win32 UTC file time issue, but + # as this is a non-cross-platform XS module not in the core, + # we shouldn't really depend on it. See RT #24194 for detail. + # (Also, this module only supports Perl 5.6 and above). + eval "use Win32::UTCFileTime" if $^O eq 'MSWin32' && $] >= 5.006; + + # If the script that is loading Module::Install is from the future, + # then make will detect this and cause it to re-run over and over + # again. This is bad. Rather than taking action to touch it (which + # is unreliable on some platforms and requires write permissions) + # for now we should catch this and refuse to run. + if ( -f $0 ) { + my $s = (stat($0))[9]; + + # If the modification time is only slightly in the future, + # sleep briefly to remove the problem. + my $a = $s - time; + if ( $a > 0 and $a < 5 ) { sleep 5 } + + # Too far in the future, throw an error. + my $t = time; + if ( $s > $t ) { die <<"END_DIE" } + +Your installer $0 has a modification time in the future ($s > $t). + +This is known to create infinite loops in make. + +Please correct this, then run $0 again. + +END_DIE + } + + + # Build.PL was formerly supported, but no longer is due to excessive + # difficulty in implementing every single feature twice. + if ( $0 =~ /Build.PL$/i ) { die <<"END_DIE" } + +Module::Install no longer supports Build.PL. + +It was impossible to maintain duel backends, and has been deprecated. + +Please remove all Build.PL files and only use the Makefile.PL installer. + +END_DIE + + #------------------------------------------------------------- + + # To save some more typing in Module::Install installers, every... + # use inc::Module::Install + # ...also acts as an implicit use strict. + $^H |= strict::bits(qw(refs subs vars)); + + #------------------------------------------------------------- + + unless ( -f $self->{file} ) { + foreach my $key (keys %INC) { + delete $INC{$key} if $key =~ /Module\/Install/; + } + + local $^W; + require "$self->{path}/$self->{dispatch}.pm"; + File::Path::mkpath("$self->{prefix}/$self->{author}"); + $self->{admin} = "$self->{name}::$self->{dispatch}"->new( _top => $self ); + $self->{admin}->init; + @_ = ($class, _self => $self); + goto &{"$self->{name}::import"}; + } + + local $^W; + *{"${who}::AUTOLOAD"} = $self->autoload; + $self->preload; + + # Unregister loader and worker packages so subdirs can use them again + delete $INC{'inc/Module/Install.pm'}; + delete $INC{'Module/Install.pm'}; + + # Save to the singleton + $MAIN = $self; + + return 1; +} + +sub autoload { + my $self = shift; + my $who = $self->_caller; + my $cwd = Cwd::getcwd(); + my $sym = "${who}::AUTOLOAD"; + $sym->{$cwd} = sub { + my $pwd = Cwd::getcwd(); + if ( my $code = $sym->{$pwd} ) { + # Delegate back to parent dirs + goto &$code unless $cwd eq $pwd; + } + unless ($$sym =~ s/([^:]+)$//) { + # XXX: it looks like we can't retrieve the missing function + # via $$sym (usually $main::AUTOLOAD) in this case. + # I'm still wondering if we should slurp Makefile.PL to + # get some context or not ... + my ($package, $file, $line) = caller; + die <<"EOT"; +Unknown function is found at $file line $line. +Execution of $file aborted due to runtime errors. + +If you're a contributor to a project, you may need to install +some Module::Install extensions from CPAN (or other repository). +If you're a user of a module, please contact the author. +EOT + } + my $method = $1; + if ( uc($method) eq $method ) { + # Do nothing + return; + } elsif ( $method =~ /^_/ and $self->can($method) ) { + # Dispatch to the root M:I class + return $self->$method(@_); + } + + # Dispatch to the appropriate plugin + unshift @_, ( $self, $1 ); + goto &{$self->can('call')}; + }; +} + +sub preload { + my $self = shift; + unless ( $self->{extensions} ) { + $self->load_extensions( + "$self->{prefix}/$self->{path}", $self + ); + } + + my @exts = @{$self->{extensions}}; + unless ( @exts ) { + @exts = $self->{admin}->load_all_extensions; + } + + my %seen; + foreach my $obj ( @exts ) { + while (my ($method, $glob) = each %{ref($obj) . '::'}) { + next unless $obj->can($method); + next if $method =~ /^_/; + next if $method eq uc($method); + $seen{$method}++; + } + } + + my $who = $self->_caller; + foreach my $name ( sort keys %seen ) { + local $^W; + *{"${who}::$name"} = sub { + ${"${who}::AUTOLOAD"} = "${who}::$name"; + goto &{"${who}::AUTOLOAD"}; + }; + } +} + +sub new { + my ($class, %args) = @_; + + delete $INC{'FindBin.pm'}; + { + # to suppress the redefine warning + local $SIG{__WARN__} = sub {}; + require FindBin; + } + + # ignore the prefix on extension modules built from top level. + my $base_path = Cwd::abs_path($FindBin::Bin); + unless ( Cwd::abs_path(Cwd::getcwd()) eq $base_path ) { + delete $args{prefix}; + } + return $args{_self} if $args{_self}; + + $args{dispatch} ||= 'Admin'; + $args{prefix} ||= 'inc'; + $args{author} ||= ($^O eq 'VMS' ? '_author' : '.author'); + $args{bundle} ||= 'inc/BUNDLES'; + $args{base} ||= $base_path; + $class =~ s/^\Q$args{prefix}\E:://; + $args{name} ||= $class; + $args{version} ||= $class->VERSION; + unless ( $args{path} ) { + $args{path} = $args{name}; + $args{path} =~ s!::!/!g; + } + $args{file} ||= "$args{base}/$args{prefix}/$args{path}.pm"; + $args{wrote} = 0; + + bless( \%args, $class ); +} + +sub call { + my ($self, $method) = @_; + my $obj = $self->load($method) or return; + splice(@_, 0, 2, $obj); + goto &{$obj->can($method)}; +} + +sub load { + my ($self, $method) = @_; + + $self->load_extensions( + "$self->{prefix}/$self->{path}", $self + ) unless $self->{extensions}; + + foreach my $obj (@{$self->{extensions}}) { + return $obj if $obj->can($method); + } + + my $admin = $self->{admin} or die <<"END_DIE"; +The '$method' method does not exist in the '$self->{prefix}' path! +Please remove the '$self->{prefix}' directory and run $0 again to load it. +END_DIE + + my $obj = $admin->load($method, 1); + push @{$self->{extensions}}, $obj; + + $obj; +} + +sub load_extensions { + my ($self, $path, $top) = @_; + + my $should_reload = 0; + unless ( grep { ! ref $_ and lc $_ eq lc $self->{prefix} } @INC ) { + unshift @INC, $self->{prefix}; + $should_reload = 1; + } + + foreach my $rv ( $self->find_extensions($path) ) { + my ($file, $pkg) = @{$rv}; + next if $self->{pathnames}{$pkg}; + + local $@; + my $new = eval { local $^W; require $file; $pkg->can('new') }; + unless ( $new ) { + warn $@ if $@; + next; + } + $self->{pathnames}{$pkg} = + $should_reload ? delete $INC{$file} : $INC{$file}; + push @{$self->{extensions}}, &{$new}($pkg, _top => $top ); + } + + $self->{extensions} ||= []; +} + +sub find_extensions { + my ($self, $path) = @_; + + my @found; + File::Find::find( sub { + my $file = $File::Find::name; + return unless $file =~ m!^\Q$path\E/(.+)\.pm\Z!is; + my $subpath = $1; + return if lc($subpath) eq lc($self->{dispatch}); + + $file = "$self->{path}/$subpath.pm"; + my $pkg = "$self->{name}::$subpath"; + $pkg =~ s!/!::!g; + + # If we have a mixed-case package name, assume case has been preserved + # correctly. Otherwise, root through the file to locate the case-preserved + # version of the package name. + if ( $subpath eq lc($subpath) || $subpath eq uc($subpath) ) { + my $content = Module::Install::_read($subpath . '.pm'); + my $in_pod = 0; + foreach ( split /\n/, $content ) { + $in_pod = 1 if /^=\w/; + $in_pod = 0 if /^=cut/; + next if ($in_pod || /^=cut/); # skip pod text + next if /^\s*#/; # and comments + if ( m/^\s*package\s+($pkg)\s*;/i ) { + $pkg = $1; + last; + } + } + } + + push @found, [ $file, $pkg ]; + }, $path ) if -d $path; + + @found; +} + + + + + +##################################################################### +# Common Utility Functions + +sub _caller { + my $depth = 0; + my $call = caller($depth); + while ( $call eq __PACKAGE__ ) { + $depth++; + $call = caller($depth); + } + return $call; +} + +# Done in evals to avoid confusing Perl::MinimumVersion +eval( $] >= 5.006 ? <<'END_NEW' : <<'END_OLD' ); die $@ if $@; +sub _read { + local *FH; + open( FH, '<', $_[0] ) or die "open($_[0]): $!"; + binmode FH; + my $string = do { local $/; <FH> }; + close FH or die "close($_[0]): $!"; + return $string; +} +END_NEW +sub _read { + local *FH; + open( FH, "< $_[0]" ) or die "open($_[0]): $!"; + binmode FH; + my $string = do { local $/; <FH> }; + close FH or die "close($_[0]): $!"; + return $string; +} +END_OLD + +sub _readperl { + my $string = Module::Install::_read($_[0]); + $string =~ s/(?:\015{1,2}\012|\015|\012)/\n/sg; + $string =~ s/(\n)\n*__(?:DATA|END)__\b.*\z/$1/s; + $string =~ s/\n\n=\w+.+?\n\n=cut\b.+?\n+/\n\n/sg; + return $string; +} + +sub _readpod { + my $string = Module::Install::_read($_[0]); + $string =~ s/(?:\015{1,2}\012|\015|\012)/\n/sg; + return $string if $_[0] =~ /\.pod\z/; + $string =~ s/(^|\n=cut\b.+?\n+)[^=\s].+?\n(\n=\w+|\z)/$1$2/sg; + $string =~ s/\n*=pod\b[^\n]*\n+/\n\n/sg; + $string =~ s/\n*=cut\b[^\n]*\n+/\n\n/sg; + $string =~ s/^\n+//s; + return $string; +} + +# Done in evals to avoid confusing Perl::MinimumVersion +eval( $] >= 5.006 ? <<'END_NEW' : <<'END_OLD' ); die $@ if $@; +sub _write { + local *FH; + open( FH, '>', $_[0] ) or die "open($_[0]): $!"; + binmode FH; + foreach ( 1 .. $#_ ) { + print FH $_[$_] or die "print($_[0]): $!"; + } + close FH or die "close($_[0]): $!"; +} +END_NEW +sub _write { + local *FH; + open( FH, "> $_[0]" ) or die "open($_[0]): $!"; + binmode FH; + foreach ( 1 .. $#_ ) { + print FH $_[$_] or die "print($_[0]): $!"; + } + close FH or die "close($_[0]): $!"; +} +END_OLD + +# _version is for processing module versions (eg, 1.03_05) not +# Perl versions (eg, 5.8.1). +sub _version { + my $s = shift || 0; + my $d =()= $s =~ /(\.)/g; + if ( $d >= 2 ) { + # Normalise multipart versions + $s =~ s/(\.)(\d{1,3})/sprintf("$1%03d",$2)/eg; + } + $s =~ s/^(\d+)\.?//; + my $l = $1 || 0; + my @v = map { + $_ . '0' x (3 - length $_) + } $s =~ /(\d{1,3})\D?/g; + $l = $l . '.' . join '', @v if @v; + return $l + 0; +} + +sub _cmp { + _version($_[1]) <=> _version($_[2]); +} + +# Cloned from Params::Util::_CLASS +sub _CLASS { + ( + defined $_[0] + and + ! ref $_[0] + and + $_[0] =~ m/^[^\W\d]\w*(?:::\w+)*\z/s + ) ? $_[0] : undef; +} + +1; + +# Copyright 2008 - 2012 Adam Kennedy. diff --git a/inc/Module/Install/Base.pm b/inc/Module/Install/Base.pm new file mode 100644 index 0000000..4206347 --- /dev/null +++ b/inc/Module/Install/Base.pm @@ -0,0 +1,83 @@ +#line 1 +package Module::Install::Base; + +use strict 'vars'; +use vars qw{$VERSION}; +BEGIN { + $VERSION = '1.14'; +} + +# Suspend handler for "redefined" warnings +BEGIN { + my $w = $SIG{__WARN__}; + $SIG{__WARN__} = sub { $w }; +} + +#line 42 + +sub new { + my $class = shift; + unless ( defined &{"${class}::call"} ) { + *{"${class}::call"} = sub { shift->_top->call(@_) }; + } + unless ( defined &{"${class}::load"} ) { + *{"${class}::load"} = sub { shift->_top->load(@_) }; + } + bless { @_ }, $class; +} + +#line 61 + +sub AUTOLOAD { + local $@; + my $func = eval { shift->_top->autoload } or return; + goto &$func; +} + +#line 75 + +sub _top { + $_[0]->{_top}; +} + +#line 90 + +sub admin { + $_[0]->_top->{admin} + or + Module::Install::Base::FakeAdmin->new; +} + +#line 106 + +sub is_admin { + ! $_[0]->admin->isa('Module::Install::Base::FakeAdmin'); +} + +sub DESTROY {} + +package Module::Install::Base::FakeAdmin; + +use vars qw{$VERSION}; +BEGIN { + $VERSION = $Module::Install::Base::VERSION; +} + +my $fake; + +sub new { + $fake ||= bless(\@_, $_[0]); +} + +sub AUTOLOAD {} + +sub DESTROY {} + +# Restore warning handler +BEGIN { + $SIG{__WARN__} = $SIG{__WARN__}->(); +} + +1; + +#line 159 diff --git a/inc/Module/Install/Can.pm b/inc/Module/Install/Can.pm new file mode 100644 index 0000000..9929b1b --- /dev/null +++ b/inc/Module/Install/Can.pm @@ -0,0 +1,154 @@ +#line 1 +package Module::Install::Can; + +use strict; +use Config (); +use ExtUtils::MakeMaker (); +use Module::Install::Base (); + +use vars qw{$VERSION @ISA $ISCORE}; +BEGIN { + $VERSION = '1.14'; + @ISA = 'Module::Install::Base'; + $ISCORE = 1; +} + +# check if we can load some module +### Upgrade this to not have to load the module if possible +sub can_use { + my ($self, $mod, $ver) = @_; + $mod =~ s{::|\\}{/}g; + $mod .= '.pm' unless $mod =~ /\.pm$/i; + + my $pkg = $mod; + $pkg =~ s{/}{::}g; + $pkg =~ s{\.pm$}{}i; + + local $@; + eval { require $mod; $pkg->VERSION($ver || 0); 1 }; +} + +# Check if we can run some command +sub can_run { + my ($self, $cmd) = @_; + + my $_cmd = $cmd; + return $_cmd if (-x $_cmd or $_cmd = MM->maybe_command($_cmd)); + + for my $dir ((split /$Config::Config{path_sep}/, $ENV{PATH}), '.') { + next if $dir eq ''; + require File::Spec; + my $abs = File::Spec->catfile($dir, $cmd); + return $abs if (-x $abs or $abs = MM->maybe_command($abs)); + } + + return; +} + +# Can our C compiler environment build XS files +sub can_xs { + my $self = shift; + + # Ensure we have the CBuilder module + $self->configure_requires( 'ExtUtils::CBuilder' => 0.27 ); + + # Do we have the configure_requires checker? + local $@; + eval "require ExtUtils::CBuilder;"; + if ( $@ ) { + # They don't obey configure_requires, so it is + # someone old and delicate. Try to avoid hurting + # them by falling back to an older simpler test. + return $self->can_cc(); + } + + # Do we have a working C compiler + my $builder = ExtUtils::CBuilder->new( + quiet => 1, + ); + unless ( $builder->have_compiler ) { + # No working C compiler + return 0; + } + + # Write a C file representative of what XS becomes + require File::Temp; + my ( $FH, $tmpfile ) = File::Temp::tempfile( + "compilexs-XXXXX", + SUFFIX => '.c', + ); + binmode $FH; + print $FH <<'END_C'; +#include "EXTERN.h" +#include "perl.h" +#include "XSUB.h" + +int main(int argc, char **argv) { + return 0; +} + +int boot_sanexs() { + return 1; +} + +END_C + close $FH; + + # Can the C compiler access the same headers XS does + my @libs = (); + my $object = undef; + eval { + local $^W = 0; + $object = $builder->compile( + source => $tmpfile, + ); + @libs = $builder->link( + objects => $object, + module_name => 'sanexs', + ); + }; + my $result = $@ ? 0 : 1; + + # Clean up all the build files + foreach ( $tmpfile, $object, @libs ) { + next unless defined $_; + 1 while unlink; + } + + return $result; +} + +# Can we locate a (the) C compiler +sub can_cc { + my $self = shift; + my @chunks = split(/ /, $Config::Config{cc}) or return; + + # $Config{cc} may contain args; try to find out the program part + while (@chunks) { + return $self->can_run("@chunks") || (pop(@chunks), next); + } + + return; +} + +# Fix Cygwin bug on maybe_command(); +if ( $^O eq 'cygwin' ) { + require ExtUtils::MM_Cygwin; + require ExtUtils::MM_Win32; + if ( ! defined(&ExtUtils::MM_Cygwin::maybe_command) ) { + *ExtUtils::MM_Cygwin::maybe_command = sub { + my ($self, $file) = @_; + if ($file =~ m{^/cygdrive/}i and ExtUtils::MM_Win32->can('maybe_command')) { + ExtUtils::MM_Win32->maybe_command($file); + } else { + ExtUtils::MM_Unix->maybe_command($file); + } + } + } +} + +1; + +__END__ + +#line 236 diff --git a/inc/Module/Install/Fetch.pm b/inc/Module/Install/Fetch.pm new file mode 100644 index 0000000..3d8de76 --- /dev/null +++ b/inc/Module/Install/Fetch.pm @@ -0,0 +1,93 @@ +#line 1 +package Module::Install::Fetch; + +use strict; +use Module::Install::Base (); + +use vars qw{$VERSION @ISA $ISCORE}; +BEGIN { + $VERSION = '1.14'; + @ISA = 'Module::Install::Base'; + $ISCORE = 1; +} + +sub get_file { + my ($self, %args) = @_; + my ($scheme, $host, $path, $file) = + $args{url} =~ m|^(\w+)://([^/]+)(.+)/(.+)| or return; + + if ( $scheme eq 'http' and ! eval { require LWP::Simple; 1 } ) { + $args{url} = $args{ftp_url} + or (warn("LWP support unavailable!\n"), return); + ($scheme, $host, $path, $file) = + $args{url} =~ m|^(\w+)://([^/]+)(.+)/(.+)| or return; + } + + $|++; + print "Fetching '$file' from $host... "; + + unless (eval { require Socket; Socket::inet_aton($host) }) { + warn "'$host' resolve failed!\n"; + return; + } + + return unless $scheme eq 'ftp' or $scheme eq 'http'; + + require Cwd; + my $dir = Cwd::getcwd(); + chdir $args{local_dir} or return if exists $args{local_dir}; + + if (eval { require LWP::Simple; 1 }) { + LWP::Simple::mirror($args{url}, $file); + } + elsif (eval { require Net::FTP; 1 }) { eval { + # use Net::FTP to get past firewall + my $ftp = Net::FTP->new($host, Passive => 1, Timeout => 600); + $ftp->login("anonymous", 'anonymous@example.com'); + $ftp->cwd($path); + $ftp->binary; + $ftp->get($file) or (warn("$!\n"), return); + $ftp->quit; + } } + elsif (my $ftp = $self->can_run('ftp')) { eval { + # no Net::FTP, fallback to ftp.exe + require FileHandle; + my $fh = FileHandle->new; + + local $SIG{CHLD} = 'IGNORE'; + unless ($fh->open("|$ftp -n")) { + warn "Couldn't open ftp: $!\n"; + chdir $dir; return; + } + + my @dialog = split(/\n/, <<"END_FTP"); +open $host +user anonymous anonymous\@example.com +cd $path +binary +get $file $file +quit +END_FTP + foreach (@dialog) { $fh->print("$_\n") } + $fh->close; + } } + else { + warn "No working 'ftp' program available!\n"; + chdir $dir; return; + } + + unless (-f $file) { + warn "Fetching failed: $@\n"; + chdir $dir; return; + } + + return if exists $args{size} and -s $file != $args{size}; + system($args{run}) if exists $args{run}; + unlink($file) if $args{remove}; + + print(((!exists $args{check_for} or -e $args{check_for}) + ? "done!" : "failed! ($!)"), "\n"); + chdir $dir; return !$?; +} + +1; diff --git a/inc/Module/Install/Makefile.pm b/inc/Module/Install/Makefile.pm new file mode 100644 index 0000000..66993af --- /dev/null +++ b/inc/Module/Install/Makefile.pm @@ -0,0 +1,418 @@ +#line 1 +package Module::Install::Makefile; + +use strict 'vars'; +use ExtUtils::MakeMaker (); +use Module::Install::Base (); +use Fcntl qw/:flock :seek/; + +use vars qw{$VERSION @ISA $ISCORE}; +BEGIN { + $VERSION = '1.14'; + @ISA = 'Module::Install::Base'; + $ISCORE = 1; +} + +sub Makefile { $_[0] } + +my %seen = (); + +sub prompt { + shift; + + # Infinite loop protection + my @c = caller(); + if ( ++$seen{"$c[1]|$c[2]|$_[0]"} > 3 ) { + die "Caught an potential prompt infinite loop ($c[1]|$c[2]|$_[0])"; + } + + # In automated testing or non-interactive session, always use defaults + if ( ($ENV{AUTOMATED_TESTING} or -! -t STDIN) and ! $ENV{PERL_MM_USE_DEFAULT} ) { + local $ENV{PERL_MM_USE_DEFAULT} = 1; + goto &ExtUtils::MakeMaker::prompt; + } else { + goto &ExtUtils::MakeMaker::prompt; + } +} + +# Store a cleaned up version of the MakeMaker version, +# since we need to behave differently in a variety of +# ways based on the MM version. +my $makemaker = eval $ExtUtils::MakeMaker::VERSION; + +# If we are passed a param, do a "newer than" comparison. +# Otherwise, just return the MakeMaker version. +sub makemaker { + ( @_ < 2 or $makemaker >= eval($_[1]) ) ? $makemaker : 0 +} + +# Ripped from ExtUtils::MakeMaker 6.56, and slightly modified +# as we only need to know here whether the attribute is an array +# or a hash or something else (which may or may not be appendable). +my %makemaker_argtype = ( + C => 'ARRAY', + CONFIG => 'ARRAY', +# CONFIGURE => 'CODE', # ignore + DIR => 'ARRAY', + DL_FUNCS => 'HASH', + DL_VARS => 'ARRAY', + EXCLUDE_EXT => 'ARRAY', + EXE_FILES => 'ARRAY', + FUNCLIST => 'ARRAY', + H => 'ARRAY', + IMPORTS => 'HASH', + INCLUDE_EXT => 'ARRAY', + LIBS => 'ARRAY', # ignore '' + MAN1PODS => 'HASH', + MAN3PODS => 'HASH', + META_ADD => 'HASH', + META_MERGE => 'HASH', + PL_FILES => 'HASH', + PM => 'HASH', + PMLIBDIRS => 'ARRAY', + PMLIBPARENTDIRS => 'ARRAY', + PREREQ_PM => 'HASH', + CONFIGURE_REQUIRES => 'HASH', + SKIP => 'ARRAY', + TYPEMAPS => 'ARRAY', + XS => 'HASH', +# VERSION => ['version',''], # ignore +# _KEEP_AFTER_FLUSH => '', + + clean => 'HASH', + depend => 'HASH', + dist => 'HASH', + dynamic_lib=> 'HASH', + linkext => 'HASH', + macro => 'HASH', + postamble => 'HASH', + realclean => 'HASH', + test => 'HASH', + tool_autosplit => 'HASH', + + # special cases where you can use makemaker_append + CCFLAGS => 'APPENDABLE', + DEFINE => 'APPENDABLE', + INC => 'APPENDABLE', + LDDLFLAGS => 'APPENDABLE', + LDFROM => 'APPENDABLE', +); + +sub makemaker_args { + my ($self, %new_args) = @_; + my $args = ( $self->{makemaker_args} ||= {} ); + foreach my $key (keys %new_args) { + if ($makemaker_argtype{$key}) { + if ($makemaker_argtype{$key} eq 'ARRAY') { + $args->{$key} = [] unless defined $args->{$key}; + unless (ref $args->{$key} eq 'ARRAY') { + $args->{$key} = [$args->{$key}] + } + push @{$args->{$key}}, + ref $new_args{$key} eq 'ARRAY' + ? @{$new_args{$key}} + : $new_args{$key}; + } + elsif ($makemaker_argtype{$key} eq 'HASH') { + $args->{$key} = {} unless defined $args->{$key}; + foreach my $skey (keys %{ $new_args{$key} }) { + $args->{$key}{$skey} = $new_args{$key}{$skey}; + } + } + elsif ($makemaker_argtype{$key} eq 'APPENDABLE') { + $self->makemaker_append($key => $new_args{$key}); + } + } + else { + if (defined $args->{$key}) { + warn qq{MakeMaker attribute "$key" is overriden; use "makemaker_append" to append values\n}; + } + $args->{$key} = $new_args{$key}; + } + } + return $args; +} + +# For mm args that take multiple space-separated args, +# append an argument to the current list. +sub makemaker_append { + my $self = shift; + my $name = shift; + my $args = $self->makemaker_args; + $args->{$name} = defined $args->{$name} + ? join( ' ', $args->{$name}, @_ ) + : join( ' ', @_ ); +} + +sub build_subdirs { + my $self = shift; + my $subdirs = $self->makemaker_args->{DIR} ||= []; + for my $subdir (@_) { + push @$subdirs, $subdir; + } +} + +sub clean_files { + my $self = shift; + my $clean = $self->makemaker_args->{clean} ||= {}; + %$clean = ( + %$clean, + FILES => join ' ', grep { length $_ } ($clean->{FILES} || (), @_), + ); +} + +sub realclean_files { + my $self = shift; + my $realclean = $self->makemaker_args->{realclean} ||= {}; + %$realclean = ( + %$realclean, + FILES => join ' ', grep { length $_ } ($realclean->{FILES} || (), @_), + ); +} + +sub libs { + my $self = shift; + my $libs = ref $_[0] ? shift : [ shift ]; + $self->makemaker_args( LIBS => $libs ); +} + +sub inc { + my $self = shift; + $self->makemaker_args( INC => shift ); +} + +sub _wanted_t { +} + +sub tests_recursive { + my $self = shift; + my $dir = shift || 't'; + unless ( -d $dir ) { + die "tests_recursive dir '$dir' does not exist"; + } + my %tests = map { $_ => 1 } split / /, ($self->tests || ''); + require File::Find; + File::Find::find( + sub { /\.t$/ and -f $_ and $tests{"$File::Find::dir/*.t"} = 1 }, + $dir + ); + $self->tests( join ' ', sort keys %tests ); +} + +sub write { + my $self = shift; + die "&Makefile->write() takes no arguments\n" if @_; + + # Check the current Perl version + my $perl_version = $self->perl_version; + if ( $perl_version ) { + eval "use $perl_version; 1" + or die "ERROR: perl: Version $] is installed, " + . "but we need version >= $perl_version"; + } + + # Make sure we have a new enough MakeMaker + require ExtUtils::MakeMaker; + + if ( $perl_version and $self->_cmp($perl_version, '5.006') >= 0 ) { + # This previous attempted to inherit the version of + # ExtUtils::MakeMaker in use by the module author, but this + # was found to be untenable as some authors build releases + # using future dev versions of EU:MM that nobody else has. + # Instead, #toolchain suggests we use 6.59 which is the most + # stable version on CPAN at time of writing and is, to quote + # ribasushi, "not terminally fucked, > and tested enough". + # TODO: We will now need to maintain this over time to push + # the version up as new versions are released. + $self->build_requires( 'ExtUtils::MakeMaker' => 6.59 ); + $self->configure_requires( 'ExtUtils::MakeMaker' => 6.59 ); + } else { + # Allow legacy-compatibility with 5.005 by depending on the + # most recent EU:MM that supported 5.005. + $self->build_requires( 'ExtUtils::MakeMaker' => 6.36 ); + $self->configure_requires( 'ExtUtils::MakeMaker' => 6.36 ); + } + + # Generate the MakeMaker params + my $args = $self->makemaker_args; + $args->{DISTNAME} = $self->name; + $args->{NAME} = $self->module_name || $self->name; + $args->{NAME} =~ s/-/::/g; + $args->{VERSION} = $self->version or die <<'EOT'; +ERROR: Can't determine distribution version. Please specify it +explicitly via 'version' in Makefile.PL, or set a valid $VERSION +in a module, and provide its file path via 'version_from' (or +'all_from' if you prefer) in Makefile.PL. +EOT + + if ( $self->tests ) { + my @tests = split ' ', $self->tests; + my %seen; + $args->{test} = { + TESTS => (join ' ', grep {!$seen{$_}++} @tests), + }; + } elsif ( $Module::Install::ExtraTests::use_extratests ) { + # Module::Install::ExtraTests doesn't set $self->tests and does its own tests via harness. + # So, just ignore our xt tests here. + } elsif ( -d 'xt' and ($Module::Install::AUTHOR or $ENV{RELEASE_TESTING}) ) { + $args->{test} = { + TESTS => join( ' ', map { "$_/*.t" } grep { -d $_ } qw{ t xt } ), + }; + } + if ( $] >= 5.005 ) { + $args->{ABSTRACT} = $self->abstract; + $args->{AUTHOR} = join ', ', @{$self->author || []}; + } + if ( $self->makemaker(6.10) ) { + $args->{NO_META} = 1; + #$args->{NO_MYMETA} = 1; + } + if ( $self->makemaker(6.17) and $self->sign ) { + $args->{SIGN} = 1; + } + unless ( $self->is_admin ) { + delete $args->{SIGN}; + } + if ( $self->makemaker(6.31) and $self->license ) { + $args->{LICENSE} = $self->license; + } + + my $prereq = ($args->{PREREQ_PM} ||= {}); + %$prereq = ( %$prereq, + map { @$_ } # flatten [module => version] + map { @$_ } + grep $_, + ($self->requires) + ); + + # Remove any reference to perl, PREREQ_PM doesn't support it + delete $args->{PREREQ_PM}->{perl}; + + # Merge both kinds of requires into BUILD_REQUIRES + my $build_prereq = ($args->{BUILD_REQUIRES} ||= {}); + %$build_prereq = ( %$build_prereq, + map { @$_ } # flatten [module => version] + map { @$_ } + grep $_, + ($self->configure_requires, $self->build_requires) + ); + + # Remove any reference to perl, BUILD_REQUIRES doesn't support it + delete $args->{BUILD_REQUIRES}->{perl}; + + # Delete bundled dists from prereq_pm, add it to Makefile DIR + my $subdirs = ($args->{DIR} || []); + if ($self->bundles) { + my %processed; + foreach my $bundle (@{ $self->bundles }) { + my ($mod_name, $dist_dir) = @$bundle; + delete $prereq->{$mod_name}; + $dist_dir = File::Basename::basename($dist_dir); # dir for building this module + if (not exists $processed{$dist_dir}) { + if (-d $dist_dir) { + # List as sub-directory to be processed by make + push @$subdirs, $dist_dir; + } + # Else do nothing: the module is already present on the system + $processed{$dist_dir} = undef; + } + } + } + + unless ( $self->makemaker('6.55_03') ) { + %$prereq = (%$prereq,%$build_prereq); + delete $args->{BUILD_REQUIRES}; + } + + if ( my $perl_version = $self->perl_version ) { + eval "use $perl_version; 1" + or die "ERROR: perl: Version $] is installed, " + . "but we need version >= $perl_version"; + + if ( $self->makemaker(6.48) ) { + $args->{MIN_PERL_VERSION} = $perl_version; + } + } + + if ($self->installdirs) { + warn qq{old INSTALLDIRS (probably set by makemaker_args) is overriden by installdirs\n} if $args->{INSTALLDIRS}; + $args->{INSTALLDIRS} = $self->installdirs; + } + + my %args = map { + ( $_ => $args->{$_} ) } grep {defined($args->{$_} ) + } keys %$args; + + my $user_preop = delete $args{dist}->{PREOP}; + if ( my $preop = $self->admin->preop($user_preop) ) { + foreach my $key ( keys %$preop ) { + $args{dist}->{$key} = $preop->{$key}; + } + } + + my $mm = ExtUtils::MakeMaker::WriteMakefile(%args); + $self->fix_up_makefile($mm->{FIRST_MAKEFILE} || 'Makefile'); +} + +sub fix_up_makefile { + my $self = shift; + my $makefile_name = shift; + my $top_class = ref($self->_top) || ''; + my $top_version = $self->_top->VERSION || ''; + + my $preamble = $self->preamble + ? "# Preamble by $top_class $top_version\n" + . $self->preamble + : ''; + my $postamble = "# Postamble by $top_class $top_version\n" + . ($self->postamble || ''); + + local *MAKEFILE; + open MAKEFILE, "+< $makefile_name" or die "fix_up_makefile: Couldn't open $makefile_name: $!"; + eval { flock MAKEFILE, LOCK_EX }; + my $makefile = do { local $/; <MAKEFILE> }; + + $makefile =~ s/\b(test_harness\(\$\(TEST_VERBOSE\), )/$1'inc', /; + $makefile =~ s/( -I\$\(INST_ARCHLIB\))/ -Iinc$1/g; + $makefile =~ s/( "-I\$\(INST_LIB\)")/ "-Iinc"$1/g; + $makefile =~ s/^(FULLPERL = .*)/$1 "-Iinc"/m; + $makefile =~ s/^(PERL = .*)/$1 "-Iinc"/m; + + # Module::Install will never be used to build the Core Perl + # Sometimes PERL_LIB and PERL_ARCHLIB get written anyway, which breaks + # PREFIX/PERL5LIB, and thus, install_share. Blank them if they exist + $makefile =~ s/^PERL_LIB = .+/PERL_LIB =/m; + #$makefile =~ s/^PERL_ARCHLIB = .+/PERL_ARCHLIB =/m; + + # Perl 5.005 mentions PERL_LIB explicitly, so we have to remove that as well. + $makefile =~ s/(\"?)-I\$\(PERL_LIB\)\1//g; + + # XXX - This is currently unused; not sure if it breaks other MM-users + # $makefile =~ s/^pm_to_blib\s+:\s+/pm_to_blib :: /mg; + + seek MAKEFILE, 0, SEEK_SET; + truncate MAKEFILE, 0; + print MAKEFILE "$preamble$makefile$postamble" or die $!; + close MAKEFILE or die $!; + + 1; +} + +sub preamble { + my ($self, $text) = @_; + $self->{preamble} = $text . $self->{preamble} if defined $text; + $self->{preamble}; +} + +sub postamble { + my ($self, $text) = @_; + $self->{postamble} ||= $self->admin->postamble; + $self->{postamble} .= $text if defined $text; + $self->{postamble} +} + +1; + +__END__ + +#line 544 diff --git a/inc/Module/Install/Metadata.pm b/inc/Module/Install/Metadata.pm new file mode 100644 index 0000000..e547fa0 --- /dev/null +++ b/inc/Module/Install/Metadata.pm @@ -0,0 +1,722 @@ +#line 1 +package Module::Install::Metadata; + +use strict 'vars'; +use Module::Install::Base (); + +use vars qw{$VERSION @ISA $ISCORE}; +BEGIN { + $VERSION = '1.14'; + @ISA = 'Module::Install::Base'; + $ISCORE = 1; +} + +my @boolean_keys = qw{ + sign +}; + +my @scalar_keys = qw{ + name + module_name + abstract + version + distribution_type + tests + installdirs +}; + +my @tuple_keys = qw{ + configure_requires + build_requires + requires + recommends + bundles + resources +}; + +my @resource_keys = qw{ + homepage + bugtracker + repository +}; + +my @array_keys = qw{ + keywords + author +}; + +*authors = \&author; + +sub Meta { shift } +sub Meta_BooleanKeys { @boolean_keys } +sub Meta_ScalarKeys { @scalar_keys } +sub Meta_TupleKeys { @tuple_keys } +sub Meta_ResourceKeys { @resource_keys } +sub Meta_ArrayKeys { @array_keys } + +foreach my $key ( @boolean_keys ) { + *$key = sub { + my $self = shift; + if ( defined wantarray and not @_ ) { + return $self->{values}->{$key}; + } + $self->{values}->{$key} = ( @_ ? $_[0] : 1 ); + return $self; + }; +} + +foreach my $key ( @scalar_keys ) { + *$key = sub { + my $self = shift; + return $self->{values}->{$key} if defined wantarray and !@_; + $self->{values}->{$key} = shift; + return $self; + }; +} + +foreach my $key ( @array_keys ) { + *$key = sub { + my $self = shift; + return $self->{values}->{$key} if defined wantarray and !@_; + $self->{values}->{$key} ||= []; + push @{$self->{values}->{$key}}, @_; + return $self; + }; +} + +foreach my $key ( @resource_keys ) { + *$key = sub { + my $self = shift; + unless ( @_ ) { + return () unless $self->{values}->{resources}; + return map { $_->[1] } + grep { $_->[0] eq $key } + @{ $self->{values}->{resources} }; + } + return $self->{values}->{resources}->{$key} unless @_; + my $uri = shift or die( + "Did not provide a value to $key()" + ); + $self->resources( $key => $uri ); + return 1; + }; +} + +foreach my $key ( grep { $_ ne "resources" } @tuple_keys) { + *$key = sub { + my $self = shift; + return $self->{values}->{$key} unless @_; + my @added; + while ( @_ ) { + my $module = shift or last; + my $version = shift || 0; + push @added, [ $module, $version ]; + } + push @{ $self->{values}->{$key} }, @added; + return map {@$_} @added; + }; +} + +# Resource handling +my %lc_resource = map { $_ => 1 } qw{ + homepage + license + bugtracker + repository +}; + +sub resources { + my $self = shift; + while ( @_ ) { + my $name = shift or last; + my $value = shift or next; + if ( $name eq lc $name and ! $lc_resource{$name} ) { + die("Unsupported reserved lowercase resource '$name'"); + } + $self->{values}->{resources} ||= []; + push @{ $self->{values}->{resources} }, [ $name, $value ]; + } + $self->{values}->{resources}; +} + +# Aliases for build_requires that will have alternative +# meanings in some future version of META.yml. +sub test_requires { shift->build_requires(@_) } +sub install_requires { shift->build_requires(@_) } + +# Aliases for installdirs options +sub install_as_core { $_[0]->installdirs('perl') } +sub install_as_cpan { $_[0]->installdirs('site') } +sub install_as_site { $_[0]->installdirs('site') } +sub install_as_vendor { $_[0]->installdirs('vendor') } + +sub dynamic_config { + my $self = shift; + my $value = @_ ? shift : 1; + if ( $self->{values}->{dynamic_config} ) { + # Once dynamic we never change to static, for safety + return 0; + } + $self->{values}->{dynamic_config} = $value ? 1 : 0; + return 1; +} + +# Convenience command +sub static_config { + shift->dynamic_config(0); +} + +sub perl_version { + my $self = shift; + return $self->{values}->{perl_version} unless @_; + my $version = shift or die( + "Did not provide a value to perl_version()" + ); + + # Normalize the version + $version = $self->_perl_version($version); + + # We don't support the really old versions + unless ( $version >= 5.005 ) { + die "Module::Install only supports 5.005 or newer (use ExtUtils::MakeMaker)\n"; + } + + $self->{values}->{perl_version} = $version; +} + +sub all_from { + my ( $self, $file ) = @_; + + unless ( defined($file) ) { + my $name = $self->name or die( + "all_from called with no args without setting name() first" + ); + $file = join('/', 'lib', split(/-/, $name)) . '.pm'; + $file =~ s{.*/}{} unless -e $file; + unless ( -e $file ) { + die("all_from cannot find $file from $name"); + } + } + unless ( -f $file ) { + die("The path '$file' does not exist, or is not a file"); + } + + $self->{values}{all_from} = $file; + + # Some methods pull from POD instead of code. + # If there is a matching .pod, use that instead + my $pod = $file; + $pod =~ s/\.pm$/.pod/i; + $pod = $file unless -e $pod; + + # Pull the different values + $self->name_from($file) unless $self->name; + $self->version_from($file) unless $self->version; + $self->perl_version_from($file) unless $self->perl_version; + $self->author_from($pod) unless @{$self->author || []}; + $self->license_from($pod) unless $self->license; + $self->abstract_from($pod) unless $self->abstract; + + return 1; +} + +sub provides { + my $self = shift; + my $provides = ( $self->{values}->{provides} ||= {} ); + %$provides = (%$provides, @_) if @_; + return $provides; +} + +sub auto_provides { + my $self = shift; + return $self unless $self->is_admin; + unless (-e 'MANIFEST') { + warn "Cannot deduce auto_provides without a MANIFEST, skipping\n"; + return $self; + } + # Avoid spurious warnings as we are not checking manifest here. + local $SIG{__WARN__} = sub {1}; + require ExtUtils::Manifest; + local *ExtUtils::Manifest::manicheck = sub { return }; + + require Module::Build; + my $build = Module::Build->new( + dist_name => $self->name, + dist_version => $self->version, + license => $self->license, + ); + $self->provides( %{ $build->find_dist_packages || {} } ); +} + +sub feature { + my $self = shift; + my $name = shift; + my $features = ( $self->{values}->{features} ||= [] ); + my $mods; + + if ( @_ == 1 and ref( $_[0] ) ) { + # The user used ->feature like ->features by passing in the second + # argument as a reference. Accomodate for that. + $mods = $_[0]; + } else { + $mods = \@_; + } + + my $count = 0; + push @$features, ( + $name => [ + map { + ref($_) ? ( ref($_) eq 'HASH' ) ? %$_ : @$_ : $_ + } @$mods + ] + ); + + return @$features; +} + +sub features { + my $self = shift; + while ( my ( $name, $mods ) = splice( @_, 0, 2 ) ) { + $self->feature( $name, @$mods ); + } + return $self->{values}->{features} + ? @{ $self->{values}->{features} } + : (); +} + +sub no_index { + my $self = shift; + my $type = shift; + push @{ $self->{values}->{no_index}->{$type} }, @_ if $type; + return $self->{values}->{no_index}; +} + +sub read { + my $self = shift; + $self->include_deps( 'YAML::Tiny', 0 ); + + require YAML::Tiny; + my $data = YAML::Tiny::LoadFile('META.yml'); + + # Call methods explicitly in case user has already set some values. + while ( my ( $key, $value ) = each %$data ) { + next unless $self->can($key); + if ( ref $value eq 'HASH' ) { + while ( my ( $module, $version ) = each %$value ) { + $self->can($key)->($self, $module => $version ); + } + } else { + $self->can($key)->($self, $value); + } + } + return $self; +} + +sub write { + my $self = shift; + return $self unless $self->is_admin; + $self->admin->write_meta; + return $self; +} + +sub version_from { + require ExtUtils::MM_Unix; + my ( $self, $file ) = @_; + $self->version( ExtUtils::MM_Unix->parse_version($file) ); + + # for version integrity check + $self->makemaker_args( VERSION_FROM => $file ); +} + +sub abstract_from { + require ExtUtils::MM_Unix; + my ( $self, $file ) = @_; + $self->abstract( + bless( + { DISTNAME => $self->name }, + 'ExtUtils::MM_Unix' + )->parse_abstract($file) + ); +} + +# Add both distribution and module name +sub name_from { + my ($self, $file) = @_; + if ( + Module::Install::_read($file) =~ m/ + ^ \s* + package \s* + ([\w:]+) + [\s|;]* + /ixms + ) { + my ($name, $module_name) = ($1, $1); + $name =~ s{::}{-}g; + $self->name($name); + unless ( $self->module_name ) { + $self->module_name($module_name); + } + } else { + die("Cannot determine name from $file\n"); + } +} + +sub _extract_perl_version { + if ( + $_[0] =~ m/ + ^\s* + (?:use|require) \s* + v? + ([\d_\.]+) + \s* ; + /ixms + ) { + my $perl_version = $1; + $perl_version =~ s{_}{}g; + return $perl_version; + } else { + return; + } +} + +sub perl_version_from { + my $self = shift; + my $perl_version=_extract_perl_version(Module::Install::_read($_[0])); + if ($perl_version) { + $self->perl_version($perl_version); + } else { + warn "Cannot determine perl version info from $_[0]\n"; + return; + } +} + +sub author_from { + my $self = shift; + my $content = Module::Install::_read($_[0]); + if ($content =~ m/ + =head \d \s+ (?:authors?)\b \s* + ([^\n]*) + | + =head \d \s+ (?:licen[cs]e|licensing|copyright|legal)\b \s* + .*? copyright .*? \d\d\d[\d.]+ \s* (?:\bby\b)? \s* + ([^\n]*) + /ixms) { + my $author = $1 || $2; + + # XXX: ugly but should work anyway... + if (eval "require Pod::Escapes; 1") { + # Pod::Escapes has a mapping table. + # It's in core of perl >= 5.9.3, and should be installed + # as one of the Pod::Simple's prereqs, which is a prereq + # of Pod::Text 3.x (see also below). + $author =~ s{ E<( (\d+) | ([A-Za-z]+) )> } + { + defined $2 + ? chr($2) + : defined $Pod::Escapes::Name2character_number{$1} + ? chr($Pod::Escapes::Name2character_number{$1}) + : do { + warn "Unknown escape: E<$1>"; + "E<$1>"; + }; + }gex; + } + elsif (eval "require Pod::Text; 1" && $Pod::Text::VERSION < 3) { + # Pod::Text < 3.0 has yet another mapping table, + # though the table name of 2.x and 1.x are different. + # (1.x is in core of Perl < 5.6, 2.x is in core of + # Perl < 5.9.3) + my $mapping = ($Pod::Text::VERSION < 2) + ? \%Pod::Text::HTML_Escapes + : \%Pod::Text::ESCAPES; + $author =~ s{ E<( (\d+) | ([A-Za-z]+) )> } + { + defined $2 + ? chr($2) + : defined $mapping->{$1} + ? $mapping->{$1} + : do { + warn "Unknown escape: E<$1>"; + "E<$1>"; + }; + }gex; + } + else { + $author =~ s{E<lt>}{<}g; + $author =~ s{E<gt>}{>}g; + } + $self->author($author); + } else { + warn "Cannot determine author info from $_[0]\n"; + } +} + +#Stolen from M::B +my %license_urls = ( + perl => 'http://dev.perl.org/licenses/', + apache => 'http://apache.org/licenses/LICENSE-2.0', + apache_1_1 => 'http://apache.org/licenses/LICENSE-1.1', + artistic => 'http://opensource.org/licenses/artistic-license.php', + artistic_2 => 'http://opensource.org/licenses/artistic-license-2.0.php', + lgpl => 'http://opensource.org/licenses/lgpl-license.php', + lgpl2 => 'http://opensource.org/licenses/lgpl-2.1.php', + lgpl3 => 'http://opensource.org/licenses/lgpl-3.0.html', + bsd => 'http://opensource.org/licenses/bsd-license.php', + gpl => 'http://opensource.org/licenses/gpl-license.php', + gpl2 => 'http://opensource.org/licenses/gpl-2.0.php', + gpl3 => 'http://opensource.org/licenses/gpl-3.0.html', + mit => 'http://opensource.org/licenses/mit-license.php', + mozilla => 'http://opensource.org/licenses/mozilla1.1.php', + open_source => undef, + unrestricted => undef, + restrictive => undef, + unknown => undef, +); + +sub license { + my $self = shift; + return $self->{values}->{license} unless @_; + my $license = shift or die( + 'Did not provide a value to license()' + ); + $license = __extract_license($license) || lc $license; + $self->{values}->{license} = $license; + + # Automatically fill in license URLs + if ( $license_urls{$license} ) { + $self->resources( license => $license_urls{$license} ); + } + + return 1; +} + +sub _extract_license { + my $pod = shift; + my $matched; + return __extract_license( + ($matched) = $pod =~ m/ + (=head \d \s+ L(?i:ICEN[CS]E|ICENSING)\b.*?) + (=head \d.*|=cut.*|)\z + /xms + ) || __extract_license( + ($matched) = $pod =~ m/ + (=head \d \s+ (?:C(?i:OPYRIGHTS?)|L(?i:EGAL))\b.*?) + (=head \d.*|=cut.*|)\z + /xms + ); +} + +sub __extract_license { + my $license_text = shift or return; + my @phrases = ( + '(?:under )?the same (?:terms|license) as (?:perl|the perl (?:\d )?programming language)' => 'perl', 1, + '(?:under )?the terms of (?:perl|the perl programming language) itself' => 'perl', 1, + 'Artistic and GPL' => 'perl', 1, + 'GNU general public license' => 'gpl', 1, + 'GNU public license' => 'gpl', 1, + 'GNU lesser general public license' => 'lgpl', 1, + 'GNU lesser public license' => 'lgpl', 1, + 'GNU library general public license' => 'lgpl', 1, + 'GNU library public license' => 'lgpl', 1, + 'GNU Free Documentation license' => 'unrestricted', 1, + 'GNU Affero General Public License' => 'open_source', 1, + '(?:Free)?BSD license' => 'bsd', 1, + 'Artistic license 2\.0' => 'artistic_2', 1, + 'Artistic license' => 'artistic', 1, + 'Apache (?:Software )?license' => 'apache', 1, + 'GPL' => 'gpl', 1, + 'LGPL' => 'lgpl', 1, + 'BSD' => 'bsd', 1, + 'Artistic' => 'artistic', 1, + 'MIT' => 'mit', 1, + 'Mozilla Public License' => 'mozilla', 1, + 'Q Public License' => 'open_source', 1, + 'OpenSSL License' => 'unrestricted', 1, + 'SSLeay License' => 'unrestricted', 1, + 'zlib License' => 'open_source', 1, + 'proprietary' => 'proprietary', 0, + ); + while ( my ($pattern, $license, $osi) = splice(@phrases, 0, 3) ) { + $pattern =~ s#\s+#\\s+#gs; + if ( $license_text =~ /\b$pattern\b/i ) { + return $license; + } + } + return ''; +} + +sub license_from { + my $self = shift; + if (my $license=_extract_license(Module::Install::_read($_[0]))) { + $self->license($license); + } else { + warn "Cannot determine license info from $_[0]\n"; + return 'unknown'; + } +} + +sub _extract_bugtracker { + my @links = $_[0] =~ m#L<( + https?\Q://rt.cpan.org/\E[^>]+| + https?\Q://github.com/\E[\w_]+/[\w_]+/issues| + https?\Q://code.google.com/p/\E[\w_\-]+/issues/list + )>#gx; + my %links; + @links{@links}=(); + @links=keys %links; + return @links; +} + +sub bugtracker_from { + my $self = shift; + my $content = Module::Install::_read($_[0]); + my @links = _extract_bugtracker($content); + unless ( @links ) { + warn "Cannot determine bugtracker info from $_[0]\n"; + return 0; + } + if ( @links > 1 ) { + warn "Found more than one bugtracker link in $_[0]\n"; + return 0; + } + + # Set the bugtracker + bugtracker( $links[0] ); + return 1; +} + +sub requires_from { + my $self = shift; + my $content = Module::Install::_readperl($_[0]); + my @requires = $content =~ m/^use\s+([^\W\d]\w*(?:::\w+)*)\s+(v?[\d\.]+)/mg; + while ( @requires ) { + my $module = shift @requires; + my $version = shift @requires; + $self->requires( $module => $version ); + } +} + +sub test_requires_from { + my $self = shift; + my $content = Module::Install::_readperl($_[0]); + my @requires = $content =~ m/^use\s+([^\W\d]\w*(?:::\w+)*)\s+([\d\.]+)/mg; + while ( @requires ) { + my $module = shift @requires; + my $version = shift @requires; + $self->test_requires( $module => $version ); + } +} + +# Convert triple-part versions (eg, 5.6.1 or 5.8.9) to +# numbers (eg, 5.006001 or 5.008009). +# Also, convert double-part versions (eg, 5.8) +sub _perl_version { + my $v = $_[-1]; + $v =~ s/^([1-9])\.([1-9]\d?\d?)$/sprintf("%d.%03d",$1,$2)/e; + $v =~ s/^([1-9])\.([1-9]\d?\d?)\.(0|[1-9]\d?\d?)$/sprintf("%d.%03d%03d",$1,$2,$3 || 0)/e; + $v =~ s/(\.\d\d\d)000$/$1/; + $v =~ s/_.+$//; + if ( ref($v) ) { + # Numify + $v = $v + 0; + } + return $v; +} + +sub add_metadata { + my $self = shift; + my %hash = @_; + for my $key (keys %hash) { + warn "add_metadata: $key is not prefixed with 'x_'.\n" . + "Use appopriate function to add non-private metadata.\n" unless $key =~ /^x_/; + $self->{values}->{$key} = $hash{$key}; + } +} + + +###################################################################### +# MYMETA Support + +sub WriteMyMeta { + die "WriteMyMeta has been deprecated"; +} + +sub write_mymeta_yaml { + my $self = shift; + + # We need YAML::Tiny to write the MYMETA.yml file + unless ( eval { require YAML::Tiny; 1; } ) { + return 1; + } + + # Generate the data + my $meta = $self->_write_mymeta_data or return 1; + + # Save as the MYMETA.yml file + print "Writing MYMETA.yml\n"; + YAML::Tiny::DumpFile('MYMETA.yml', $meta); +} + +sub write_mymeta_json { + my $self = shift; + + # We need JSON to write the MYMETA.json file + unless ( eval { require JSON; 1; } ) { + return 1; + } + + # Generate the data + my $meta = $self->_write_mymeta_data or return 1; + + # Save as the MYMETA.yml file + print "Writing MYMETA.json\n"; + Module::Install::_write( + 'MYMETA.json', + JSON->new->pretty(1)->canonical->encode($meta), + ); +} + +sub _write_mymeta_data { + my $self = shift; + + # If there's no existing META.yml there is nothing we can do + return undef unless -f 'META.yml'; + + # We need Parse::CPAN::Meta to load the file + unless ( eval { require Parse::CPAN::Meta; 1; } ) { + return undef; + } + + # Merge the perl version into the dependencies + my $val = $self->Meta->{values}; + my $perl = delete $val->{perl_version}; + if ( $perl ) { + $val->{requires} ||= []; + my $requires = $val->{requires}; + + # Canonize to three-dot version after Perl 5.6 + if ( $perl >= 5.006 ) { + $perl =~ s{^(\d+)\.(\d\d\d)(\d*)}{join('.', $1, int($2||0), int($3||0))}e + } + unshift @$requires, [ perl => $perl ]; + } + + # Load the advisory META.yml file + my @yaml = Parse::CPAN::Meta::LoadFile('META.yml'); + my $meta = $yaml[0]; + + # Overwrite the non-configure dependency hashes + delete $meta->{requires}; + delete $meta->{build_requires}; + delete $meta->{recommends}; + if ( exists $val->{requires} ) { + $meta->{requires} = { map { @$_ } @{ $val->{requires} } }; + } + if ( exists $val->{build_requires} ) { + $meta->{build_requires} = { map { @$_ } @{ $val->{build_requires} } }; + } + + return $meta; +} + +1; diff --git a/inc/Module/Install/Win32.pm b/inc/Module/Install/Win32.pm new file mode 100644 index 0000000..9706e5f --- /dev/null +++ b/inc/Module/Install/Win32.pm @@ -0,0 +1,64 @@ +#line 1 +package Module::Install::Win32; + +use strict; +use Module::Install::Base (); + +use vars qw{$VERSION @ISA $ISCORE}; +BEGIN { + $VERSION = '1.14'; + @ISA = 'Module::Install::Base'; + $ISCORE = 1; +} + +# determine if the user needs nmake, and download it if needed +sub check_nmake { + my $self = shift; + $self->load('can_run'); + $self->load('get_file'); + + require Config; + return unless ( + $^O eq 'MSWin32' and + $Config::Config{make} and + $Config::Config{make} =~ /^nmake\b/i and + ! $self->can_run('nmake') + ); + + print "The required 'nmake' executable not found, fetching it...\n"; + + require File::Basename; + my $rv = $self->get_file( + url => 'http://download.microsoft.com/download/vc15/Patch/1.52/W95/EN-US/Nmake15.exe', + ftp_url => 'ftp://ftp.microsoft.com/Softlib/MSLFILES/Nmake15.exe', + local_dir => File::Basename::dirname($^X), + size => 51928, + run => 'Nmake15.exe /o > nul', + check_for => 'Nmake.exe', + remove => 1, + ); + + die <<'END_MESSAGE' unless $rv; + +------------------------------------------------------------------------------- + +Since you are using Microsoft Windows, you will need the 'nmake' utility +before installation. It's available at: + + http://download.microsoft.com/download/vc15/Patch/1.52/W95/EN-US/Nmake15.exe + or + ftp://ftp.microsoft.com/Softlib/MSLFILES/Nmake15.exe + +Please download the file manually, save it to a directory in %PATH% (e.g. +C:\WINDOWS\COMMAND\), then launch the MS-DOS command line shell, "cd" to +that directory, and run "Nmake15.exe" from there; that will create the +'nmake.exe' file needed by this module. + +You may then resume the installation process described in README. + +------------------------------------------------------------------------------- +END_MESSAGE + +} + +1; diff --git a/inc/Module/Install/WriteAll.pm b/inc/Module/Install/WriteAll.pm new file mode 100644 index 0000000..dbedc00 --- /dev/null +++ b/inc/Module/Install/WriteAll.pm @@ -0,0 +1,63 @@ +#line 1 +package Module::Install::WriteAll; + +use strict; +use Module::Install::Base (); + +use vars qw{$VERSION @ISA $ISCORE}; +BEGIN { + $VERSION = '1.14'; + @ISA = qw{Module::Install::Base}; + $ISCORE = 1; +} + +sub WriteAll { + my $self = shift; + my %args = ( + meta => 1, + sign => 0, + inline => 0, + check_nmake => 1, + @_, + ); + + $self->sign(1) if $args{sign}; + $self->admin->WriteAll(%args) if $self->is_admin; + + $self->check_nmake if $args{check_nmake}; + unless ( $self->makemaker_args->{PL_FILES} ) { + # XXX: This still may be a bit over-defensive... + unless ($self->makemaker(6.25)) { + $self->makemaker_args( PL_FILES => {} ) if -f 'Build.PL'; + } + } + + # Until ExtUtils::MakeMaker support MYMETA.yml, make sure + # we clean it up properly ourself. + $self->realclean_files('MYMETA.yml'); + + if ( $args{inline} ) { + $self->Inline->write; + } else { + $self->Makefile->write; + } + + # The Makefile write process adds a couple of dependencies, + # so write the META.yml files after the Makefile. + if ( $args{meta} ) { + $self->Meta->write; + } + + # Experimental support for MYMETA + if ( $ENV{X_MYMETA} ) { + if ( $ENV{X_MYMETA} eq 'JSON' ) { + $self->Meta->write_mymeta_json; + } else { + $self->Meta->write_mymeta_yaml; + } + } + + return 1; +} + +1; diff --git a/lib/HTTP/Server/Simple.pm b/lib/HTTP/Server/Simple.pm new file mode 100644 index 0000000..89b43e4 --- /dev/null +++ b/lib/HTTP/Server/Simple.pm @@ -0,0 +1,820 @@ +use strict; +use warnings; + +package HTTP::Server::Simple; +use FileHandle; +use Socket; +use Carp; + +use vars qw($VERSION $bad_request_doc); +$VERSION = '0.50'; + +=head1 NAME + +HTTP::Server::Simple - Lightweight HTTP server + +=head1 SYNOPSIS + + use warnings; + use strict; + + use HTTP::Server::Simple; + + my $server = HTTP::Server::Simple->new(); + $server->run(); + +However, normally you will sub-class the HTTP::Server::Simple::CGI +module (see L<HTTP::Server::Simple::CGI>); + + package Your::Web::Server; + use base qw(HTTP::Server::Simple::CGI); + + sub handle_request { + my ($self, $cgi) = @_; + + #... do something, print output to default + # selected filehandle... + + } + + 1; + +=head1 DESCRIPTION + +This is a simple standalone HTTP server. By default, it doesn't thread +or fork. It does, however, act as a simple frontend which can be used +to build a standalone web-based application or turn a CGI into one. + +It is possible to use L<Net::Server> classes to create forking, +pre-forking, and other types of more complicated servers; see +L</net_server>. + +By default, the server traps a few signals: + +=over + +=item HUP + +When you C<kill -HUP> the server, it lets the current request finish being +processed, then uses the C<restart> method to re-exec itself. Please note that +in order to provide restart-on-SIGHUP, HTTP::Server::Simple sets a SIGHUP +handler during initialisation. If your request handling code forks you need to +make sure you reset this or unexpected things will happen if somebody sends a +HUP to all running processes spawned by your app (e.g. by "kill -HUP <script>") + +=item PIPE + +If the server detects a broken pipe while writing output to the client, +it ignores the signal. Otherwise, a client closing the connection early +could kill the server. + +=back + +=head1 EXAMPLE + + #!/usr/bin/perl + { + package MyWebServer; + + use HTTP::Server::Simple::CGI; + use base qw(HTTP::Server::Simple::CGI); + + my %dispatch = ( + '/hello' => \&resp_hello, + # ... + ); + + sub handle_request { + my $self = shift; + my $cgi = shift; + + my $path = $cgi->path_info(); + my $handler = $dispatch{$path}; + + if (ref($handler) eq "CODE") { + print "HTTP/1.0 200 OK\r\n"; + $handler->($cgi); + + } else { + print "HTTP/1.0 404 Not found\r\n"; + print $cgi->header, + $cgi->start_html('Not found'), + $cgi->h1('Not found'), + $cgi->end_html; + } + } + + sub resp_hello { + my $cgi = shift; # CGI.pm object + return if !ref $cgi; + + my $who = $cgi->param('name'); + + print $cgi->header, + $cgi->start_html("Hello"), + $cgi->h1("Hello $who!"), + $cgi->end_html; + } + + } + + # start the server on port 8080 + my $pid = MyWebServer->new(8080)->background(); + print "Use 'kill $pid' to stop server.\n"; + +=head1 METHODS + +=head2 HTTP::Server::Simple->new($port, $family) + +API call to start a new server. Does not actually start listening +until you call C<-E<gt>run()>. If omitted, C<$port> defaults to 8080, +and C<$family> defaults to L<Socket::AF_INET>. +The alternative domain is L<Socket::AF_INET6>. + +=cut + +sub new { + my ( $proto, $port, $family ) = @_; + my $class = ref($proto) || $proto; + + if ( $class eq __PACKAGE__ ) { + require HTTP::Server::Simple::CGI; + return HTTP::Server::Simple::CGI->new( @_[ 1 .. $#_ ] ); + } + + my $self = {}; + bless( $self, $class ); + $self->port( $port || '8080' ); + $self->family( $family || AF_INET ); + + return $self; +} + + +=head2 lookup_localhost + +Looks up the local host's IP address, and returns it. For most hosts, +this is C<127.0.0.1>, or possibly C<::1>. + +=cut + +sub lookup_localhost { + my $self = shift; + + my $local_sockaddr = getsockname( $self->stdio_handle ); + my $local_family = sockaddr_family($local_sockaddr); + + my ($host_err,$local_host, undef) = Socket::getnameinfo($local_sockaddr,0); + warn $host_err if ($host_err); + $self->host( $local_host || "localhost"); + + my ($addr_err,$local_addr,undef) = Socket::getnameinfo($local_sockaddr,Socket::NI_NUMERICHOST); + warn $addr_err if ($addr_err); + $self->{'local_addr'} = $local_addr + || (($local_family == AF_INET6) ? "::1" : "127.0.0.1"); +} + + +=head2 port [NUMBER] + +Takes an optional port number for this server to listen on. + +Returns this server's port. (Defaults to 8080) + +=cut + +sub port { + my $self = shift; + $self->{'port'} = shift if (@_); + return ( $self->{'port'} ); + +} + +=head2 family [NUMBER] + +Takes an optional address family for this server to use. Valid values +are Socket::AF_INET and Socket::AF_INET6. All other values are silently +changed into Socket::AF_INET for backwards compatibility with previous +versions of the module. + +Returns the address family of the present listening socket. (Defaults to +Socket::AF_INET.) + +=cut + +sub family { + my $self = shift; + if (@_) { + if ($_[0] == AF_INET || $_[0] == AF_INET6) { + $self->{'family'} = shift; + } else { + $self->{'family'} = AF_INET; + } + } + return ( $self->{'family'} ); + +} + +=head2 host [address] + +Takes an optional host address for this server to bind to. + +Returns this server's bound address (if any). Defaults to C<undef> +(bind to all interfaces). + +=cut + +sub host { + my $self = shift; + $self->{'host'} = shift if (@_); + return ( $self->{'host'} ); + +} + +=head2 background [ARGUMENTS] + +Runs the server in the background, and returns the process ID of the +started process. Any arguments will be passed through to L</run>. + +=cut + +sub background { + my $self = shift; + my $child = fork; + croak "Can't fork: $!" unless defined($child); + return $child if $child; + + srand(); # after a fork, we need to reset the random seed + # or we'll get the same numbers in both branches + if ( $^O !~ /MSWin32/ ) { + require POSIX; + POSIX::setsid() + or croak "Can't start a new session: $!"; + } + $self->run(@_); # should never return + exit; # just to be sure +} + +=head2 run [ARGUMENTS] + +Run the server. If all goes well, this won't ever return, but it will +start listening for C<HTTP> requests. Any arguments passed to this +will be passed on to the underlying L<Net::Server> implementation, if +one is used (see L</net_server>). + +=cut + +my $server_class_id = 0; + +use vars '$SERVER_SHOULD_RUN'; +$SERVER_SHOULD_RUN = 1; + +sub run { + my $self = shift; + my $server = $self->net_server; + + local $SIG{CHLD} = 'IGNORE'; # reap child processes + + # $pkg is generated anew for each invocation to "run" + # Just so we can use different net_server() implementations + # in different runs. + my $pkg = join '::', ref($self), "NetServer" . $server_class_id++; + + no strict 'refs'; + *{"$pkg\::process_request"} = $self->_process_request; + + if ($server) { + require join( '/', split /::/, $server ) . '.pm'; + *{"$pkg\::ISA"} = [$server]; + + # clear the environment before every request + require HTTP::Server::Simple::CGI; + *{"$pkg\::post_accept"} = sub { + HTTP::Server::Simple::CGI::Environment->setup_environment; + # $self->SUPER::post_accept uses the wrong super package + $server->can('post_accept')->(@_); + }; + } + else { + $self->setup_listener; + $self->after_setup_listener(); + *{"$pkg\::run"} = $self->_default_run; + } + + local $SIG{HUP} = sub { $SERVER_SHOULD_RUN = 0; }; + + $pkg->run( port => $self->port, @_ ); +} + +=head2 net_server + +User-overridable method. If you set it to a L<Net::Server> subclass, +that subclass is used for the C<run> method. Otherwise, a minimal +implementation is used as default. + +=cut + +sub net_server {undef} + +sub _default_run { + my $self = shift; + + # Default "run" closure method for a stub, minimal Net::Server instance. + return sub { + my $pkg = shift; + + $self->print_banner; + + while ($SERVER_SHOULD_RUN) { + local $SIG{PIPE} = 'IGNORE'; # If we don't ignore SIGPIPE, a + # client closing the connection before we + # finish sending will cause the server to exit + while ( accept( my $remote = new FileHandle, HTTPDaemon ) ) { + $self->stdio_handle($remote); + $self->lookup_localhost() unless ($self->host); + $self->accept_hook if $self->can("accept_hook"); + + + *STDIN = $self->stdin_handle(); + *STDOUT = $self->stdout_handle(); + select STDOUT; # required for HTTP::Server::Simple::Recorder + # XXX TODO glasser: why? + $pkg->process_request; + close $remote; + } + } + + # Got here? Time to restart, due to SIGHUP + $self->restart; + }; +} + +=head2 restart + +Restarts the server. Usually called by a HUP signal, not directly. + +=cut + +sub restart { + my $self = shift; + + close HTTPDaemon; + + $SIG{CHLD} = 'DEFAULT'; + wait; + + ### if the standalone server was invoked with perl -I .. we will loose + ### those include dirs upon re-exec. So add them to PERL5LIB, so they + ### are available again for the exec'ed process --kane + use Config; + $ENV{PERL5LIB} .= join $Config{path_sep}, @INC; + + # Server simple + # do the exec. if $0 is not executable, try running it with $^X. + exec {$0}( ( ( -x $0 ) ? () : ($^X) ), $0, @ARGV ); +} + + +sub _process_request { + my $self = shift; + + # Create a callback closure that is invoked for each incoming request; + # the $self above is bound into the closure. + sub { + + $self->stdio_handle(*STDIN) unless $self->stdio_handle; + + # Default to unencoded, raw data out. + # if you're sending utf8 and latin1 data mixed, you may need to override this + binmode STDIN, ':raw'; + binmode STDOUT, ':raw'; + + # The ternary operator below is to protect against a crash caused by IE + # Ported from Catalyst::Engine::HTTP (Originally by Jasper Krogh and Peter Edwards) + # ( http://dev.catalyst.perl.org/changeset/5195, 5221 ) + + my $remote_sockaddr = getpeername( $self->stdio_handle ); + my $family = sockaddr_family($remote_sockaddr); + + my ( $iport, $iaddr ) = $remote_sockaddr + ? ( ($family == AF_INET6) ? sockaddr_in6($remote_sockaddr) + : sockaddr_in($remote_sockaddr) ) + : (undef,undef); + + my $loopback = ($family == AF_INET6) ? "::1" : "127.0.0.1"; + my $peeraddr = $loopback; + if ($iaddr) { + my ($host_err,$addr, undef) = Socket::getnameinfo($remote_sockaddr,Socket::NI_NUMERICHOST); + warn ($host_err) if $host_err; + $peeraddr = $addr || $loopback; + } + + + my ( $method, $request_uri, $proto ) = $self->parse_request; + + unless ($self->valid_http_method($method) ) { + $self->bad_request; + return; + } + + $proto ||= "HTTP/0.9"; + + my ( $file, $query_string ) + = ( $request_uri =~ /([^?]*)(?:\?(.*))?/s ); # split at ? + + $self->setup( + method => $method, + protocol => $proto, + query_string => ( defined($query_string) ? $query_string : '' ), + request_uri => $request_uri, + path => $file, + localname => $self->host, + localport => $self->port, + peername => $peeraddr, + peeraddr => $peeraddr, + peerport => $iport, + ); + + # HTTP/0.9 didn't have any headers (I think) + if ( $proto =~ m{HTTP/(\d(\.\d)?)$} and $1 >= 1 ) { + + my $headers = $self->parse_headers + or do { $self->bad_request; return }; + + $self->headers($headers); + + } + + $self->post_setup_hook if $self->can("post_setup_hook"); + + $self->handler; + } +} + +=head2 stdio_handle [FILEHANDLE] + +When called with an argument, sets the socket to the server to that arg. + +Returns the socket to the server; you should only use this for actual socket-related +calls like C<getsockname>. If all you want is to read or write to the socket, +you should use C<stdin_handle> and C<stdout_handle> to get the in and out filehandles +explicitly. + +=cut + +sub stdio_handle { + my $self = shift; + $self->{'_stdio_handle'} = shift if (@_); + return $self->{'_stdio_handle'}; +} + +=head2 stdin_handle + +Returns a filehandle used for input from the client. By default, +returns whatever was set with C<stdio_handle>, but a subclass could do +something interesting here. + +=cut + +sub stdin_handle { + my $self = shift; + return $self->stdio_handle; +} + +=head2 stdout_handle + +Returns a filehandle used for output to the client. By default, +returns whatever was set with C<stdio_handle>, but a subclass +could do something interesting here. + +=cut + +sub stdout_handle { + my $self = shift; + return $self->stdio_handle; +} + +=head1 IMPORTANT SUB-CLASS METHODS + +A selection of these methods should be provided by sub-classes of this +module. + +=head2 handler + +This method is called after setup, with no parameters. It should +print a valid, I<full> HTTP response to the default selected +filehandle. + +=cut + +sub handler { + my ($self) = @_; + if ( ref($self) ne __PACKAGE__ ) { + croak "do not call " . ref($self) . "::SUPER->handler"; + } + else { + croak "handler called out of context"; + } +} + +=head2 setup(name =E<gt> $value, ...) + +This method is called with a name =E<gt> value list of various things +to do with the request. This list is given below. + +The default setup handler simply tries to call methods with the names +of keys of this list. + + ITEM/METHOD Set to Example + ----------- ------------------ ------------------------ + method Request Method "GET", "POST", "HEAD" + protocol HTTP version "HTTP/1.1" + request_uri Complete Request URI "/foobar/baz?foo=bar" + path Path part of URI "/foobar/baz" + query_string Query String undef, "foo=bar" + port Received Port 80, 8080 + peername Remote name "200.2.4.5", "foo.com" + peeraddr Remote address "200.2.4.5", "::1" + peerport Remote port 42424 + localname Local interface "localhost", "myhost.com" + +=cut + +sub setup { + my $self = shift; + while ( my ( $item, $value ) = splice @_, 0, 2 ) { + $self->$item($value) if $self->can($item); + } +} + +=head2 headers([Header =E<gt> $value, ...]) + +Receives HTTP headers and does something useful with them. This is +called by the default C<setup()> method. + +You have lots of options when it comes to how you receive headers. + +You can, if you really want, define C<parse_headers()> and parse them +raw yourself. + +Secondly, you can intercept them very slightly cooked via the +C<setup()> method, above. + +Thirdly, you can leave the C<setup()> header as-is (or calling the +superclass C<setup()> for unknown request items). Then you can define +C<headers()> in your sub-class and receive them all at once. + +Finally, you can define handlers to receive individual HTTP headers. +This can be useful for very simple SOAP servers (to name a +crack-fueled standard that defines its own special HTTP headers). + +To do so, you'll want to define the C<header()> method in your subclass. +That method will be handed a (key,value) pair of the header name and the value. + + +=cut + +sub headers { + my $self = shift; + my $headers = shift; + + my $can_header = $self->can("header"); + return unless $can_header; + while ( my ( $header, $value ) = splice @$headers, 0, 2 ) { + $self->header( $header => $value ); + } +} + +=head2 accept_hook + +If defined by a sub-class, this method is called directly after an +accept happens. An accept_hook to add SSL support might look like this: + + sub accept_hook { + my $self = shift; + my $fh = $self->stdio_handle; + + $self->SUPER::accept_hook(@_); + + my $newfh = + IO::Socket::SSL->start_SSL( $fh, + SSL_server => 1, + SSL_use_cert => 1, + SSL_cert_file => 'myserver.crt', + SSL_key_file => 'myserver.key', + ) + or warn "problem setting up SSL socket: " . IO::Socket::SSL::errstr(); + + $self->stdio_handle($newfh) if $newfh; + } + +=head2 post_setup_hook + +If defined by a sub-class, this method is called after all setup has +finished, before the handler method. + +=head2 print_banner + +This routine prints a banner before the server request-handling loop +starts. + +Methods below this point are probably not terribly useful to define +yourself in subclasses. + +=cut + +sub print_banner { + my $self = shift; + + print( ref($self) + . ": You can connect to your server at " + . "http://localhost:" + . $self->port + . "/\n" ); + +} + +=head2 parse_request + +Parse the HTTP request line. Returns three values, the request +method, request URI and the protocol. + +=cut + +sub parse_request { + my $self = shift; + my $chunk; + while ( sysread( STDIN, my $buff, 1 ) ) { + last if $buff eq "\n"; + $chunk .= $buff; + } + defined($chunk) or return undef; + $_ = $chunk; + + m/^(\w+)\s+(\S+)(?:\s+(\S+))?\r?$/; + my $method = $1 || ''; + my $uri = $2 || ''; + my $protocol = $3 || ''; + + # strip <scheme>://<host:port> out of HTTP/1.1 requests + $uri =~ s{^\w+://[^/]+/}{/}; + + return ( $method, $uri, $protocol ); +} + +=head2 parse_headers + +Parses incoming HTTP headers from STDIN, and returns an arrayref of +C<(header =E<gt> value)> pairs. See L</headers> for possibilities on +how to inspect headers. + +=cut + +sub parse_headers { + my $self = shift; + + my @headers; + + my $chunk = ''; + while ( sysread( STDIN, my $buff, 1 ) ) { + if ( $buff eq "\n" ) { + $chunk =~ s/[\r\l\n\s]+$//; + if ( $chunk =~ /^([^()<>\@,;:\\"\/\[\]?={} \t]+):\s*(.*)/i ) { + push @headers, $1 => $2; + } + last if ( $chunk =~ /^$/ ); + $chunk = ''; + } + else { $chunk .= $buff } + } + + return ( \@headers ); +} + +=head2 setup_listener + +This routine binds the server to a port and interface. + +=cut + +sub setup_listener { + my $self = shift; + + my $tcp = getprotobyname('tcp'); + my $sockaddr; + socket( HTTPDaemon, $self->{'family'}, SOCK_STREAM, $tcp ) + or croak "socket: $!"; + setsockopt( HTTPDaemon, SOL_SOCKET, SO_REUSEADDR, pack( "l", 1 ) ) + or warn "setsockopt: $!"; + + if ($self->host) { # Explicit listening address + my ($err, @res) = Socket::getaddrinfo($self->host, $self->port, { family => $self->{'family'}, socktype => SOCK_STREAM } ); + warn "$err!" + if ($err); + # we're binding only to the first returned address in the requested family. + while ($a = shift(@res)) { + # Be certain on the address family. + # TODO Accept AF_UNSPEC, reject SITE-LOCAL + next unless ($self->{'family'} == $a->{'family'}); + + # Use the first plausible address. + $sockaddr = $a->{'addr'}; + last; + } + } + else { # Use the wildcard address + $sockaddr = ($self->{'family'} == AF_INET6) + ? sockaddr_in6($self->port(), Socket::IN6ADDR_ANY) + : sockaddr_in($self->port(), INADDR_ANY); + } + + bind( HTTPDaemon, $sockaddr) + or croak "bind to @{[$self->host||'*']}:@{[$self->port]}: $!"; + listen( HTTPDaemon, SOMAXCONN ) or croak "listen: $!"; +} + + +=head2 after_setup_listener + +This method is called immediately after setup_listener. It's here just +for you to override. + +=cut + +sub after_setup_listener { +} + +=head2 bad_request + +This method should print a valid HTTP response that says that the +request was invalid. + +=cut + +$bad_request_doc = join "", <DATA>; + +sub bad_request { + my $self = shift; + + print "HTTP/1.0 400 Bad request\r\n"; # probably OK by now + print "Content-Type: text/html\r\nContent-Length: ", + length($bad_request_doc), "\r\n\r\n", $bad_request_doc; +} + +=head2 valid_http_method($method) + +Given a candidate HTTP method in $method, determine if it is valid. +Override if, for example, you'd like to do some WebDAV. The default +implementation only accepts C<GET>, C<POST>, C<HEAD>, C<PUT>, C<PATCH> +and C<DELETE>. + +=cut + +sub valid_http_method { + my $self = shift; + my $method = shift or return 0; + return $method =~ /^(?:GET|POST|HEAD|PUT|PATCH|DELETE)$/; +} + +=head1 AUTHOR + +Best Practical Solutions, LLC E<lt>modules@bestpractical.comE<gt> + +=head1 CONTRIBUTORS + +Jesse Vincent, <jesse@bestpractical.com>. Original author. + +Marcus Ramberg <drave@thefeed.no> contributed tests, cleanup, etc + +Sam Vilain, <samv@cpan.org> contributed the CGI.pm split-out and +header/setup API. + +Example section by almut on perlmonks, suggested by Mark Fuller. + +=head1 BUGS + +There certainly are some. Please report them via rt.cpan.org + +=head1 LICENSE + +This software is Copyright (c) 2004-2015 Best Practical Solutions + +This library is free software; you can redistribute it and/or modify +it under the same terms as Perl itself. + +=cut + +1; + +__DATA__ +<html> + <head> + <title>Bad Request</title> + </head> + <body> + <h1>Bad Request</h1> + + <p>Your browser sent a request which this web server could not + grok.</p> + </body> +</html> diff --git a/lib/HTTP/Server/Simple/CGI.pm b/lib/HTTP/Server/Simple/CGI.pm new file mode 100644 index 0000000..b11fc12 --- /dev/null +++ b/lib/HTTP/Server/Simple/CGI.pm @@ -0,0 +1,178 @@ + +package HTTP::Server::Simple::CGI; + +use base qw(HTTP::Server::Simple HTTP::Server::Simple::CGI::Environment); +use strict; +use warnings; + +use vars qw($default_doc $DEFAULT_CGI_INIT $DEFAULT_CGI_CLASS); + +$DEFAULT_CGI_CLASS = "CGI"; +$DEFAULT_CGI_INIT = sub { require CGI; CGI::initialize_globals()}; + + +=head1 NAME + +HTTP::Server::Simple::CGI - CGI.pm-style version of HTTP::Server::Simple + +=head1 DESCRIPTION + +HTTP::Server::Simple was already simple, but some smart-ass pointed +out that there is no CGI in HTTP, and so this module was born to +isolate the CGI.pm-related parts of this handler. + + +=head2 accept_hook + +The accept_hook in this sub-class clears the environment to the +start-up state. + +=cut + +sub accept_hook { + my $self = shift; + $self->setup_environment(@_); +} + +=head2 post_setup_hook + +Initializes the global L<CGI> object, as well as other environment +settings. + +=cut + +sub post_setup_hook { + my $self = shift; + $self->setup_server_url; + if ( my $init = $self->cgi_init ) { + $init->(); + } +} + +=head2 cgi_class [Classname] + +Gets or sets the class to use for creating the C<$cgi> object passed to +C<handle_request>. + +Called with a single argument, it sets the coderef. Called with no arguments, +it returns this field's current value. + +To provide an initialization subroutine to be run in the post_setup_hook, +see L</cgi_init>. + +e.g. + + $server->cgi_class('CGI'); + + $server->cgi_init(sub { + require CGI; + CGI::initialize_globals(); + }); + +or, if you want to use L<CGI::Simple>, + + $server->cgi_class('CGI::Simple'); + $server->cgi_init(sub { + require CGI::Simple; + }); + +=cut + +sub cgi_class { + my $self = shift; + if (@_) { + $self->{cgi_class} = shift; + } + return $self->{cgi_class} || $DEFAULT_CGI_CLASS; +} + +=head2 cgi_init [CODEREF] + +A coderef to run in the post_setup_hook. + +Called with a single argument, it sets the coderef. Called with no arguments, +it returns this field's current value. + +=cut + +sub cgi_init { + my $self = shift; + if (@_) { + $self->{cgi_init} = shift; + } + return $self->{cgi_init} || $DEFAULT_CGI_INIT; + +} + + +=head2 setup + +This method sets up CGI environment variables based on various +meta-headers, like the protocol, remote host name, request path, etc. + +See the docs in L<HTTP::Server::Simple> for more detail. + +=cut + +sub setup { + my $self = shift; + $self->setup_environment_from_metadata(@_); +} + +=head2 handle_request CGI + +This routine is called whenever your server gets a request it can +handle. + +It's called with a CGI object that's been pre-initialized. +You want to override this method in your subclass + + +=cut + +$default_doc = ( join "", <DATA> ); + +sub handle_request { + my ( $self, $cgi ) = @_; + + print "HTTP/1.0 200 OK\r\n"; # probably OK by now + print "Content-Type: text/html\r\nContent-Length: ", length($default_doc), + "\r\n\r\n", $default_doc; +} + +=head2 handler + +Handler implemented as part of HTTP::Server::Simple API + +=cut + +sub handler { + my $self = shift; + my $cgi; + $cgi = $self->cgi_class->new; + eval { $self->handle_request($cgi) }; + if ($@) { + my $error = $@; + warn $error; + } +} + +1; + +__DATA__ +<html> + <head> + <title>Hello!</title> + </head> + <body> + <h1>Congratulations!</h1> + + <p>You now have a functional HTTP::Server::Simple::CGI running. + </p> + + <p><i>(If you're seeing this page, it means you haven't subclassed + HTTP::Server::Simple::CGI, which you'll need to do to make it + useful.)</i> + </p> + </body> +</html> diff --git a/lib/HTTP/Server/Simple/CGI/Environment.pm b/lib/HTTP/Server/Simple/CGI/Environment.pm new file mode 100644 index 0000000..4b2c895 --- /dev/null +++ b/lib/HTTP/Server/Simple/CGI/Environment.pm @@ -0,0 +1,115 @@ + +package HTTP::Server::Simple::CGI::Environment; + +use strict; +use warnings; +use HTTP::Server::Simple; + +use vars qw(%ENV_MAPPING); + +my %clean_env = %ENV; + +=head1 NAME + +HTTP::Server::Simple::CGI::Environment - a HTTP::Server::Simple mixin to provide the CGI protocol + +=head1 DESCRIPTION + +This mixin abstracts the CGI protocol out from +L<HTTP::Server::Simple::CGI> so that it's easier to provide your own +CGI handlers with L<HTTP::Server::Simple> which B<don't> use CGI.pm + +=head2 setup_environment + +C<setup_environemnt> is usually called in the superclass's accept_hook + +This routine in this sub-class clears the environment to the +start-up state. + +=cut + +sub setup_environment { + %ENV = ( + %clean_env, + SERVER_SOFTWARE => "HTTP::Server::Simple/$HTTP::Server::Simple::VERSION", + GATEWAY_INTERFACE => 'CGI/1.1' + ); +} + +=head2 setup_server_url + +Sets up the C<SERVER_URL> environment variable + +=cut + +sub setup_server_url { + $ENV{SERVER_URL} + ||= ( "http://" . ($ENV{SERVER_NAME} || 'localhost') . ":" . ( $ENV{SERVER_PORT}||80) . "/" ); +} + +=head2 setup_environment_from_metadata + +This method sets up CGI environment variables based on various +meta-headers, like the protocol, remote host name, request path, etc. + +See the docs in L<HTTP::Server::Simple> for more detail. + +=cut + +%ENV_MAPPING = ( + protocol => "SERVER_PROTOCOL", + localport => "SERVER_PORT", + localname => "SERVER_NAME", + path => "PATH_INFO", + request_uri => "REQUEST_URI", + method => "REQUEST_METHOD", + peeraddr => "REMOTE_ADDR", + peername => "REMOTE_HOST", + peerport => "REMOTE_PORT", + query_string => "QUERY_STRING", +); + +sub setup_environment_from_metadata { + no warnings 'uninitialized'; + my $self = shift; + + # XXX TODO: rather than clone functionality from the base class, + # we should call super + # + while ( my ( $item, $value ) = splice @_, 0, 2 ) { + if ( my $k = $ENV_MAPPING{$item} ) { + $ENV{$k} = $value; + } + } + + # Apache and lighttpd both do one layer of unescaping on + # path_info; we should duplicate that. + $ENV{PATH_INFO} =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg; +} + +=head2 header + +C<header> turns a single HTTP headers into CGI environment variables. + +=cut + +sub header { + my $self = shift; + my $tag = shift; + my $value = shift; + + $tag = uc($tag); + $tag =~ s/^COOKIES$/COOKIE/; + $tag =~ s/-/_/g; + $tag = "HTTP_" . $tag + unless $tag =~ m/^CONTENT_(?:LENGTH|TYPE)$/; + + if ( exists $ENV{$tag} ) { + $ENV{$tag} .= ", $value"; + } + else { + $ENV{$tag} = $value; + } +} + +1; diff --git a/t/00smoke.t b/t/00smoke.t new file mode 100644 index 0000000..8e6cb95 --- /dev/null +++ b/t/00smoke.t @@ -0,0 +1,11 @@ +use Test::More tests=>8; + +use_ok(HTTP::Server::Simple); +ok(HTTP::Server::Simple->can('new'), 'can new()'); +my $s= HTTP::Server::Simple->new(); +isa_ok($s,'HTTP::Server::Simple'); +is($s->port(),8080,'Defaults to 8080'); +is($s->port(13432),13432,'Can change port'); +is($s->port(),13432,'Change persists'); +ok($s->can('print_banner'), 'can print_banner()'); +ok($s->can('run'), 'can run()'); diff --git a/t/01live.t b/t/01live.t new file mode 100644 index 0000000..69891c4 --- /dev/null +++ b/t/01live.t @@ -0,0 +1,186 @@ +# -*- perl -*- + +use Socket; +use Test::More; +use strict; + +# This script assumes that `localhost' will resolve to a local IP +# address that may be bound to, + +my $PORT = 40000 + int(rand(10000)); +my $RUN_IPV6 = eval { + my $ipv6_host = get_localhost(AF_INET6); + socket my $sockh, Socket::PF_INET6(), SOCK_STREAM, 0 or die "Cannot socket(PF_INET6) - $!"; + my ($err, @res) = Socket::getaddrinfo($ipv6_host, $PORT, { family => AF_INET6, socktype => SOCK_STREAM } ); + diag $err if $err; + for my $r (@res) { + next unless ($r->{'family'} == AF_INET6); + bind $sockh, $r->{'addr'} or die "Cannot bind - $!"; + last; + } + return 1; +}; +if ( $RUN_IPV6) { + plan tests => 34; +} else { + diag("Skipping IPv6"); + plan tests => 17; +} +use HTTP::Server::Simple; + +package SlowServer; +# This test class just waits a while before it starts +# accepting connections. This makes sure that CPAN #28122 is fixed: +# background() shouldn't return prematurely. + +use base qw(HTTP::Server::Simple::CGI); +sub setup_listener { + my $self = shift; + $self->SUPER::setup_listener(); + sleep 2; +} +1; +package main; + +my $DEBUG = 1 if @ARGV; + +my @pids = (); +my @classes = (qw(HTTP::Server::Simple SlowServer)); +for my $class (@classes) { + run_server_tests($class, AF_INET); + run_server_tests($class, AF_INET6) if $RUN_IPV6; + $PORT++; # don't reuse the port incase your bogus os doesn't release in time +} + + +for my $fam ( AF_INET, AF_INET6 ) { + next if ($fam == AF_INET6 && not $RUN_IPV6); + my $s=HTTP::Server::Simple::CGI->new($PORT, $fam); + is($fam, $s->family(), 'family OK'); + $s->host(get_localhost($fam)); + my $pid=$s->background(); + diag("started server PID='$pid'") if ($ENV{'TEST_VERBOSE'}); + like($pid, '/^-?\d+$/', 'pid is numeric'); + select(undef,undef,undef,0.2); # wait a sec + SKIP: { + skip "No localhost for $fam", 4 unless defined $s->host; + my $content=fetch($fam, "GET / HTTP/1.1", ""); + like($content, '/Congratulations/', "Returns a page"); + + eval { + like(fetch($fam, "GET a bogus request"), + '/bad request/i', + "knows what a request isn't"); + }; + fail("got exception in client: $@") if $@; + + like(fetch($fam, "GET / HTTP/1.1", ""), '/Congratulations/', + "HTTP/1.1 request"); + + like(fetch($fam, "GET /"), '/Congratulations/', + "HTTP/0.9 request"); + } + + is(kill(9,$pid),1,'Signaled 1 process successfully'); +} + +is( kill( 9, $_ ), 1, "Killed PID: $_" ) for @pids; + +# this function may look excessive, but hopefully will be very useful +# in identifying common problems +sub fetch { + my $family = shift; + my $hostname = get_localhost($family); + my $port = $PORT; + my $message = join "", map { "$_\015\012" } @_; + my $timeout = 5; + my $response; + my $proto = getprotobyname('tcp') || die "getprotobyname: $!"; + my $socktype = SOCK_STREAM; + + eval { + local $SIG{ALRM} = sub { die "early exit - SIGALRM caught" }; + alarm $timeout*2; #twice longer than timeout used later by select() + + my $paddr; + my ($err, @res) = Socket::getaddrinfo($hostname, $port, { family => $family, + socktype => $socktype, + protocol => $proto }); + die "getaddrinfo: $err operating on [$hostname] [$port] [$family] [$socktype] [$proto]" + if ($err); + while ($a = shift(@res)) { + next unless ($family == $a->{'family'}); + next unless ($proto == $a->{'protocol'}); + next unless ($socktype == $a->{'socktype'}); + + $paddr = $a->{'addr'}; + last + } + socket(SOCK, $family, $socktype, $proto) || die "socket: $!"; + connect(SOCK, $paddr) || die "connect: $!"; + (send SOCK, $message, 0) || die "send: $!"; + + my $rvec = ''; + vec($rvec, fileno(SOCK), 1) = 1; + die "vec(): $!" unless $rvec; + + $response = ''; + for (;;) { + my $r = select($rvec, undef, undef, $timeout); + die "select: timeout - no data to read from server" unless ($r > 0); + my $l = sysread(SOCK, $response, 1024, length($response)); + die "sysread: $!" unless defined($l); + last if ($l == 0); + } + $response =~ s/\015\012/\n/g; + (close SOCK) || die "close(): $!"; + alarm 0; + }; + if ($@) { + return "[ERROR] $@"; + } + else { + return $response; + } +} + +sub run_server_tests { + my $class = shift; + my $fam = shift; + my $s = $class->new($PORT, $fam); + is($s->family(), $fam, 'constructor set family properly'); + is($s->port(),$PORT,"Constructor set port correctly"); + + my $localhost = get_localhost($fam); + $s->host($localhost); # otherwise we bind to * which doesn't work on all systems + + my $pid=$s->background(); + select(undef,undef,undef,0.2); # wait a sec + + like($pid, '/^-?\d+$/', 'pid is numeric'); + + SKIP: { + skip "No localhost defined for $fam", 1 unless defined $localhost; + my $content=fetch($fam, "GET / HTTP/1.1", ""); + + like($content, '/Congratulations/', "Returns a page"); + } + push @pids, $pid; +} + +{ + my %localhost; +sub get_localhost { + my $family = shift; + + return $localhost{$family} if $localhost{$family}; + + if ($family == AF_INET) { + $localhost{$family} = gethostbyaddr(INADDR_LOOPBACK,$family); + } else { + $localhost{$family} = gethostbyaddr(Socket::IN6ADDR_LOOPBACK,$family); + } + return $localhost{$family}; + +} +} diff --git a/t/02pod.t b/t/02pod.t new file mode 100644 index 0000000..0f0480b --- /dev/null +++ b/t/02pod.t @@ -0,0 +1,9 @@ +#!/usr/bin/perl -w + +use strict; +use Test::More; + +eval "use Test::Pod 1.14"; +plan skip_all => "Test::Pod 1.14 required for testing POD" if $@; +all_pod_files_ok(); + diff --git a/t/03podcoverage.t b/t/03podcoverage.t new file mode 100644 index 0000000..6609207 --- /dev/null +++ b/t/03podcoverage.t @@ -0,0 +1,9 @@ +#!/usr/bin/perl -w + +use strict; +use Test::More; + +eval "use Test::Pod::Coverage 1.04"; +plan skip_all => "Test::Pod::Coverage 1.04 required for testing POD coverage" if $@; +all_pod_coverage_ok({ also_private => [ '/^[A-Z_]+$/' ], }); + diff --git a/t/04cgi.t b/t/04cgi.t new file mode 100644 index 0000000..76b117f --- /dev/null +++ b/t/04cgi.t @@ -0,0 +1,207 @@ +# -*- perl -*- + +use Test::More; +use Socket; +use strict; + +my $PORT = 40000 + int(rand(10000)); + +my $host = gethostbyaddr(inet_aton('localhost'), AF_INET); + +my %methods=( + url => "url: http://$host:".$PORT, + path_info => 'path_info: /cgitest/path_info', + server_name => "server_name: $host", + server_port => 'server_port: '.$PORT, + server_software => 'server_software: HTTP::Server::Simple/\d+.\d+', + request_method => 'request_method: GET', + raw_cookie => undef, # do not test + ); + +my %envvars=( + SERVER_URL => "SERVER_URL: http://$host:".$PORT.'/', + SERVER_PORT => 'SERVER_PORT: '.$PORT, + REQUEST_METHOD => 'REQUEST_METHOD: GET', + REQUEST_URI => 'REQUEST_URI: /cgitest/REQUEST_URI', + SERVER_PROTOCOL => 'SERVER_PROTOCOL: HTTP/1.1', + SERVER_NAME => "SERVER_NAME: $host", + SERVER_SOFTWARE => 'SERVER_SOFTWARE: HTTP::Server::Simple/\d+.\d+', + REMOTE_ADDR => 'REMOTE_ADDR: 127.0.0.1', + QUERY_STRING => 'QUERY_STRING: ', + PATH_INFO => 'PATH_INFO: /cgitest/PATH_INFO', + ); + +if ($^O eq 'freebsd' && `sysctl -n security.jail.jailed` == 1) { + delete @methods{qw(url server_name)}; + delete @envvars{qw(SERVER_URL SERVER_NAME REMOTE_ADDR)}; + plan tests => 55; +} +else { + plan tests => 60; +} + +{ + my $server=CGIServer->new($PORT); + is($server->port(),$PORT,'Constructor set port correctly'); + sleep(3); # wait just a moment + + my $pid=$server->background; + + like($pid, '/^-?\d+$/', 'pid is numeric'); + + select(undef,undef,undef,0.2); # wait a sec + my @message_tests = ( + [["GET / HTTP/1.1",""], '/NOFILE/', '[GET] no file'], + [["POST / HTTP/1.1","Content-Length: 0",""], '/NOFILE/', '[POST] no file'], + [["HEAD / HTTP/1.1",""], '/NOFILE/', '[HEAD] no file'], + [["PUT / HTTP/1.1","Content-Length: 0",""], '/NOFILE/', '[PUT] no file'], + [["DELETE / HTTP/1.1",""], '/NOFILE/', '[DELETE] no file'], + [["PATCH / HTTP/1.1","Content-Length: 0",""], '/NOFILE/', '[PATCH] no file'], + ); + foreach my $message_test (@message_tests) { + my ($message, $expected, $description) = @$message_test; + like(fetch(@$message), $expected, $description); + select(undef,undef,undef,0.2); # wait a sec + } + + foreach my $method (keys(%methods)) { + next unless defined $methods{$method}; + like( + fetch("GET /cgitest/$method HTTP/1.1",""), + "/$methods{$method}/", + "method - $method" + ); + select(undef,undef,undef,0.2); # wait a sec + } + + foreach my $envvar (keys(%envvars)) { + like( + fetch("GET /cgitest/$envvar HTTP/1.1",""), + "/$envvars{$envvar}/", + "Environment - $envvar" + ); + select(undef,undef,undef,0.2); # wait a sec + } + +# extra tests for HTTP/1.1 absolute URLs + + foreach my $verb ('GET', 'HEAD') { + foreach my $method (keys(%methods)) { + next unless defined $methods{$method}; + + my $method_value = $methods{$method}; + $method_value =~ s/\bGET\b/$verb/; + + like( + fetch("$verb http://localhost/cgitest/$method HTTP/1.1",""), + "/$method_value/", + "method (absolute URL) - $method" + ); + select(undef,undef,undef,0.2); # wait a sec + } + + foreach my $envvar (keys(%envvars)) { + (my $envvar_value = $envvars{$envvar}); + $envvar_value =~ s/\bGET\b/$verb/; + + like( + fetch("$verb http://localhost/cgitest/$envvar HTTP/1.1",""), + "/$envvar_value/", + "Environment (absolute URL) - $envvar" + ); + select(undef,undef,undef,0.2); # wait a sec + } + } + + like( + fetch("GET /cgitest/REQUEST_URI?foo%3Fbar HTTP/1.0",""), + qr/foo%3Fbar/, + "Didn't decode already" + ); + + like( + fetch("GET /cgitest/foo%2Fbar/PATH_INFO HTTP/1.0",""), + qr|foo/bar|, + "Did decode already" + ); + + like( + fetch("GET /cgitest/raw_cookie HTTP/1.0","Cookie: foo=bar",""), + qr|foo=bar|, + "uses HTTP_COOKIE", + ); + + is(kill(9,$pid),1,'Signaled 1 process successfully'); + wait or die "counldn't wait for sub-process completion"; +} + + +sub fetch { + my $hostname = "localhost"; + my $port = $PORT; + my $message = join "", map { "$_\015\012" } @_; + my $timeout = 5; + my $response; + + eval { + local $SIG{ALRM} = sub { die "early exit - SIGALRM caught" }; + alarm $timeout*2; #twice longer than timeout used later by select() + + my $iaddr = inet_aton($hostname) || die "inet_aton: $!"; + my $paddr = sockaddr_in($port, $iaddr) || die "sockaddr_in: $!"; + my $proto = getprotobyname('tcp') || die "getprotobyname: $!"; + socket(SOCK, PF_INET, SOCK_STREAM, $proto) || die "socket: $!"; + connect(SOCK, $paddr) || die "connect: $!"; + (send SOCK, $message, 0) || die "send: $!"; + + my $rvec = ''; + vec($rvec, fileno(SOCK), 1) = 1; + die "vec(): $!" unless $rvec; + + $response = ''; + for (;;) { + my $r = select($rvec, undef, undef, $timeout); + die "select: timeout - no data to read from server" unless ($r > 0); + my $l = sysread(SOCK, $response, 1024, length($response)); + die "sysread: $!" unless defined($l); + last if ($l == 0); + } + $response =~ s/\015\012/\n/g; + (close SOCK) || die "close(): $!"; + alarm 0; + }; + if ($@) { + return "[ERROR] $@"; + } + else { + return $response; + } +} + +{ + package CGIServer; + use base qw(HTTP::Server::Simple::CGI); + + sub handle_request { + my $self=shift; + my $cgi=shift; + + + my $file=(split('/',$cgi->path_info))[-1]||'NOFILE'; + $file=~s/\s+//g; + $file||='NOFILE'; + print "HTTP/1.0 200 OK\r\n"; # probably OK by now + print "Content-Type: text/html\r\nContent-Length: "; + my $response; + if(exists $methods{$file}) { + $response = "$file: ".$cgi->$file(); + } elsif($envvars{$file}) { + $response="$file: $ENV{$file}"; + } else { + $response=$file; + } + print length($response), "\r\n\r\n", $response; + } +} + + |