1 # -*- Mode: cperl; coding: utf-8; cperl-indent-level: 4 -*-
4 # $Id: CPAN.pm,v 1.409 2003/07/28 22:07:23 k Exp $
6 # only used during development:
8 # $Revision = "[".substr(q$Revision: 1.409 $, 10)."]";
15 use ExtUtils::MakeMaker (); # $SelfLoader::DEBUG=1;
16 use File::Basename ();
22 use Text::ParseWords ();
26 no lib "."; # we need to run chdir all over and we would get at wrong
29 require Mac::BuildTools if $^O eq 'MacOS';
31 END { $End++; &cleanup; }
54 $CPAN::Frontend ||= "CPAN::Shell";
55 $CPAN::Defaultsite ||= "ftp://ftp.perl.org/pub/CPAN";
60 use vars qw($VERSION @EXPORT $AUTOLOAD $DEBUG $META $HAS_USABLE $term
61 $Revision $Signal $End $Suppress_readline $Frontend
62 $Defaultsite $Have_warned);
64 @CPAN::ISA = qw(CPAN::Debug Exporter);
67 autobundle bundle expand force get cvs_import
68 install make readme recompile shell test clean
71 #-> sub CPAN::AUTOLOAD ;
76 @EXPORT{@EXPORT} = '';
77 CPAN::Config->load unless $CPAN::Config_loaded++;
78 if (exists $EXPORT{$l}){
81 $CPAN::Frontend->mywarn(qq{Unknown command "$AUTOLOAD". }.
90 $Suppress_readline = ! -t STDIN unless defined $Suppress_readline;
91 CPAN::Config->load unless $CPAN::Config_loaded++;
93 my $oprompt = shift || "cpan> ";
94 my $prompt = $oprompt;
95 my $commandline = shift || "";
98 unless ($Suppress_readline) {
99 require Term::ReadLine;
102 $term->ReadLine eq "Term::ReadLine::Stub"
104 $term = Term::ReadLine->new('CPAN Monitor');
106 if ($term->ReadLine eq "Term::ReadLine::Gnu") {
107 my $attribs = $term->Attribs;
108 $attribs->{attempted_completion_function} = sub {
109 &CPAN::Complete::gnu_cpl;
112 $readline::rl_completion_function =
113 $readline::rl_completion_function = 'CPAN::Complete::cpl';
115 if (my $histfile = $CPAN::Config->{'histfile'}) {{
116 unless ($term->can("AddHistory")) {
117 $CPAN::Frontend->mywarn("Terminal does not support AddHistory.\n");
120 my($fh) = FileHandle->new;
121 open $fh, "<$histfile" or last;
125 $term->AddHistory($_);
129 # $term->OUT is autoflushed anyway
130 my $odef = select STDERR;
137 # no strict; # I do not recall why no strict was here (2000-09-03)
139 my $cwd = CPAN::anycwd();
140 my $try_detect_readline;
141 $try_detect_readline = $term->ReadLine eq "Term::ReadLine::Stub" if $term;
142 my $rl_avail = $Suppress_readline ? "suppressed" :
143 ($term->ReadLine ne "Term::ReadLine::Stub") ? "enabled" :
144 "available (try 'install Bundle::CPAN')";
146 $CPAN::Frontend->myprint(
148 cpan shell -- CPAN exploration and modules installation (v%s%s)
156 unless $CPAN::Config->{'inhibit_startup_message'} ;
157 my($continuation) = "";
158 SHELLCOMMAND: while () {
159 if ($Suppress_readline) {
161 last SHELLCOMMAND unless defined ($_ = <> );
164 last SHELLCOMMAND unless
165 defined ($_ = $term->readline($prompt, $commandline));
167 $_ = "$continuation$_" if $continuation;
169 next SHELLCOMMAND if /^$/;
170 $_ = 'h' if /^\s*\?/;
171 if (/^(?:q(?:uit)?|bye|exit)$/i) {
181 use vars qw($import_done);
182 CPAN->import(':DEFAULT') unless $import_done++;
183 CPAN->debug("eval[$eval]") if $CPAN::DEBUG;
190 if ($] < 5.00322) { # parsewords had a bug until recently
193 eval { @line = Text::ParseWords::shellwords($_) };
194 warn($@), next SHELLCOMMAND if $@;
195 warn("Text::Parsewords could not parse the line [$_]"),
196 next SHELLCOMMAND unless @line;
198 $CPAN::META->debug("line[".join("|",@line)."]") if $CPAN::DEBUG;
199 my $command = shift @line;
200 eval { CPAN::Shell->$command(@line) };
202 chdir $cwd or $CPAN::Frontend->mydie(qq{Could not chdir to "$cwd": $!});
203 $CPAN::Frontend->myprint("\n");
208 $commandline = ""; # I do want to be able to pass a default to
209 # shell, but on the second command I see no
212 CPAN::Queue->nullify_queue;
213 if ($try_detect_readline) {
214 if ($CPAN::META->has_inst("Term::ReadLine::Gnu")
216 $CPAN::META->has_inst("Term::ReadLine::Perl")
218 delete $INC{"Term/ReadLine.pm"};
220 local($SIG{__WARN__}) = CPAN::Shell::paintdots_onreload(\$redef);
221 require Term::ReadLine;
222 $CPAN::Frontend->myprint("\n$redef subroutines in ".
223 "Term::ReadLine redefined\n");
229 chdir $cwd or $CPAN::Frontend->mydie(qq{Could not chdir to "$cwd": $!});
232 package CPAN::CacheMgr;
233 @CPAN::CacheMgr::ISA = qw(CPAN::InfoObj CPAN);
236 package CPAN::Config;
237 use vars qw(%can $dot_cpan);
240 'commit' => "Commit changes to disk",
241 'defaults' => "Reload defaults from disk",
242 'init' => "Interactive setting of all options",
246 use vars qw($Ua $Thesite $Themethod);
247 @CPAN::FTP::ISA = qw(CPAN::Debug);
249 package CPAN::LWP::UserAgent;
250 use vars qw(@ISA $USER $PASSWD $SETUPDONE);
251 # we delay requiring LWP::UserAgent and setting up inheritence until we need it
253 package CPAN::Complete;
254 @CPAN::Complete::ISA = qw(CPAN::Debug);
255 @CPAN::Complete::COMMANDS = sort qw(
256 ! a b d h i m o q r u autobundle clean dump
257 make test install force readme reload look
259 ) unless @CPAN::Complete::COMMANDS;
262 use vars qw($LAST_TIME $DATE_OF_02 $DATE_OF_03);
263 @CPAN::Index::ISA = qw(CPAN::Debug);
266 # use constant PROTOCOL => "2.0"; # outcommented to avoid warning on upgrade from 1.57
269 package CPAN::InfoObj;
270 @CPAN::InfoObj::ISA = qw(CPAN::Debug);
272 package CPAN::Author;
273 @CPAN::Author::ISA = qw(CPAN::InfoObj);
275 package CPAN::Distribution;
276 @CPAN::Distribution::ISA = qw(CPAN::InfoObj);
278 package CPAN::Bundle;
279 @CPAN::Bundle::ISA = qw(CPAN::Module);
281 package CPAN::Module;
282 @CPAN::Module::ISA = qw(CPAN::InfoObj);
284 package CPAN::Exception::RecursiveDependency;
285 use overload '""' => "as_string";
292 for my $dep (@$deps) {
294 last if $seen{$dep}++;
296 bless { deps => \@deps }, $class;
301 "\nRecursive dependency detected:\n " .
302 join("\n => ", @{$self->{deps}}) .
303 ".\nCannot continue.\n";
307 use vars qw($AUTOLOAD @ISA $COLOR_REGISTERED $ADVANCED_QUERY $PRINT_ORNAMENTING);
308 @CPAN::Shell::ISA = qw(CPAN::Debug);
309 $COLOR_REGISTERED ||= 0;
310 $PRINT_ORNAMENTING ||= 0;
312 #-> sub CPAN::Shell::AUTOLOAD ;
314 my($autoload) = $AUTOLOAD;
315 my $class = shift(@_);
316 # warn "autoload[$autoload] class[$class]";
317 $autoload =~ s/.*:://;
318 if ($autoload =~ /^w/) {
319 if ($CPAN::META->has_inst('CPAN::WAIT')) {
320 CPAN::WAIT->$autoload(@_);
322 $CPAN::Frontend->mywarn(qq{
323 Commands starting with "w" require CPAN::WAIT to be installed.
324 Please consider installing CPAN::WAIT to use the fulltext index.
325 For this you just need to type
330 $CPAN::Frontend->mywarn(qq{Unknown command '$autoload'. }.
336 package CPAN::Tarzip;
337 use vars qw($AUTOLOAD @ISA $BUGHUNTING);
338 @CPAN::Tarzip::ISA = qw(CPAN::Debug);
339 $BUGHUNTING = 0; # released code must have turned off
343 # One use of the queue is to determine if we should or shouldn't
344 # announce the availability of a new CPAN module
346 # Now we try to use it for dependency tracking. For that to happen
347 # we need to draw a dependency tree and do the leaves first. This can
348 # easily be reached by running CPAN.pm recursively, but we don't want
349 # to waste memory and run into deep recursion. So what we can do is
352 # CPAN::Queue is the package where the queue is maintained. Dependencies
353 # often have high priority and must be brought to the head of the queue,
354 # possibly by jumping the queue if they are already there. My first code
355 # attempt tried to be extremely correct. Whenever a module needed
356 # immediate treatment, I either unshifted it to the front of the queue,
357 # or, if it was already in the queue, I spliced and let it bypass the
358 # others. This became a too correct model that made it impossible to put
359 # an item more than once into the queue. Why would you need that? Well,
360 # you need temporary duplicates as the manager of the queue is a loop
363 # (1) looks at the first item in the queue without shifting it off
365 # (2) cares for the item
367 # (3) removes the item from the queue, *even if its agenda failed and
368 # even if the item isn't the first in the queue anymore* (that way
369 # protecting against never ending queues)
371 # So if an item has prerequisites, the installation fails now, but we
372 # want to retry later. That's easy if we have it twice in the queue.
374 # I also expect insane dependency situations where an item gets more
375 # than two lives in the queue. Simplest example is triggered by 'install
376 # Foo Foo Foo'. People make this kind of mistakes and I don't want to
377 # get in the way. I wanted the queue manager to be a dumb servant, not
378 # one that knows everything.
380 # Who would I tell in this model that the user wants to be asked before
381 # processing? I can't attach that information to the module object,
382 # because not modules are installed but distributions. So I'd have to
383 # tell the distribution object that it should ask the user before
384 # processing. Where would the question be triggered then? Most probably
385 # in CPAN::Distribution::rematein.
386 # Hope that makes sense, my head is a bit off:-) -- AK
393 my $self = bless { qmod => $s }, $class;
398 # CPAN::Queue::first ;
404 # CPAN::Queue::delete_first ;
406 my($class,$what) = @_;
408 for my $i (0..$#All) {
409 if ( $All[$i]->{qmod} eq $what ) {
416 # CPAN::Queue::jumpqueue ;
420 CPAN->debug(sprintf("before jumpqueue All[%s] what[%s]",
421 join(",",map {$_->{qmod}} @All),
424 WHAT: for my $what (reverse @what) {
426 for (my $i=0; $i<$#All;$i++) { #prevent deep recursion
427 CPAN->debug("i[$All[$i]]what[$what]") if $CPAN::DEBUG;
428 if ($All[$i]->{qmod} eq $what){
430 if ($jumped > 100) { # one's OK if e.g. just
431 # processing now; more are OK if
432 # user typed it several times
433 $CPAN::Frontend->mywarn(
434 qq{Object [$what] queued more than 100 times, ignoring}
440 my $obj = bless { qmod => $what }, $class;
443 CPAN->debug(sprintf("after jumpqueue All[%s] what[%s]",
444 join(",",map {$_->{qmod}} @All),
449 # CPAN::Queue::exists ;
451 my($self,$what) = @_;
452 my @all = map { $_->{qmod} } @All;
453 my $exists = grep { $_->{qmod} eq $what } @All;
454 # warn "in exists what[$what] all[@all] exists[$exists]";
458 # CPAN::Queue::delete ;
461 @All = grep { $_->{qmod} ne $mod } @All;
464 # CPAN::Queue::nullify_queue ;
473 $META ||= CPAN->new; # In case we re-eval ourselves we need the ||
475 # from here on only subs.
476 ################################################################################
478 #-> sub CPAN::all_objects ;
480 my($mgr,$class) = @_;
481 CPAN::Config->load unless $CPAN::Config_loaded++;
482 CPAN->debug("mgr[$mgr] class[$class]") if $CPAN::DEBUG;
484 values %{ $META->{readwrite}{$class} }; # unsafe meta access, ok
486 *all = \&all_objects;
488 # Called by shell, not in batch mode. In batch mode I see no risk in
489 # having many processes updating something as installations are
490 # continually checked at runtime. In shell mode I suspect it is
491 # unintentional to open more than one shell at a time
493 #-> sub CPAN::checklock ;
496 my $lockfile = File::Spec->catfile($CPAN::Config->{cpan_home},".lock");
497 if (-f $lockfile && -M _ > 0) {
498 my $fh = FileHandle->new($lockfile) or
499 $CPAN::Frontend->mydie("Could not open $lockfile: $!");
500 my $otherpid = <$fh>;
501 my $otherhost = <$fh>;
503 if (defined $otherpid && $otherpid) {
506 if (defined $otherhost && $otherhost) {
509 my $thishost = hostname();
510 if (defined $otherhost && defined $thishost &&
511 $otherhost ne '' && $thishost ne '' &&
512 $otherhost ne $thishost) {
513 $CPAN::Frontend->mydie(sprintf("CPAN.pm panic: Lockfile $lockfile\n".
514 "reports other host $otherhost and other process $otherpid.\n".
515 "Cannot proceed.\n"));
517 elsif (defined $otherpid && $otherpid) {
518 return if $$ == $otherpid; # should never happen
519 $CPAN::Frontend->mywarn(
521 There seems to be running another CPAN process (pid $otherpid). Contacting...
523 if (kill 0, $otherpid) {
524 $CPAN::Frontend->mydie(qq{Other job is running.
525 You may want to kill it and delete the lockfile, maybe. On UNIX try:
529 } elsif (-w $lockfile) {
531 ExtUtils::MakeMaker::prompt
532 (qq{Other job not responding. Shall I overwrite }.
533 qq{the lockfile? (Y/N)},"y");
534 $CPAN::Frontend->myexit("Ok, bye\n")
535 unless $ans =~ /^y/i;
538 qq{Lockfile $lockfile not writeable by you. }.
539 qq{Cannot proceed.\n}.
542 qq{ and then rerun us.\n}
546 $CPAN::Frontend->mydie(sprintf("CPAN.pm panic: Lockfile $lockfile\n".
547 "reports other process with ID ".
548 "$otherpid. Cannot proceed.\n"));
551 my $dotcpan = $CPAN::Config->{cpan_home};
552 eval { File::Path::mkpath($dotcpan);};
554 # A special case at least for Jarkko.
559 $symlinkcpan = readlink $dotcpan;
560 die "readlink $dotcpan failed: $!" unless defined $symlinkcpan;
561 eval { File::Path::mkpath($symlinkcpan); };
565 $CPAN::Frontend->mywarn(qq{
566 Working directory $symlinkcpan created.
570 unless (-d $dotcpan) {
572 Your configuration suggests "$dotcpan" as your
573 CPAN.pm working directory. I could not create this directory due
574 to this error: $firsterror\n};
576 As "$dotcpan" is a symlink to "$symlinkcpan",
577 I tried to create that, but I failed with this error: $seconderror
580 Please make sure the directory exists and is writable.
582 $CPAN::Frontend->mydie($diemess);
586 unless ($fh = FileHandle->new(">$lockfile")) {
587 if ($! =~ /Permission/) {
588 my $incc = $INC{'CPAN/Config.pm'};
589 my $myincc = File::Spec->catfile($ENV{HOME},'.cpan','CPAN','MyConfig.pm');
590 $CPAN::Frontend->myprint(qq{
592 Your configuration suggests that CPAN.pm should use a working
594 $CPAN::Config->{cpan_home}
595 Unfortunately we could not create the lock file
597 due to permission problems.
599 Please make sure that the configuration variable
600 \$CPAN::Config->{cpan_home}
601 points to a directory where you can write a .lock file. You can set
602 this variable in either
609 $CPAN::Frontend->mydie("Could not open >$lockfile: $!");
611 $fh->print($$, "\n");
612 $fh->print(hostname(), "\n");
613 $self->{LOCK} = $lockfile;
617 $CPAN::Frontend->mydie("Got SIGTERM, leaving");
622 $CPAN::Frontend->mydie("Got another SIGINT") if $Signal;
623 print "Caught SIGINT\n";
627 # From: Larry Wall <larry@wall.org>
628 # Subject: Re: deprecating SIGDIE
629 # To: perl5-porters@perl.org
630 # Date: Thu, 30 Sep 1999 14:58:40 -0700 (PDT)
632 # The original intent of __DIE__ was only to allow you to substitute one
633 # kind of death for another on an application-wide basis without respect
634 # to whether you were in an eval or not. As a global backstop, it should
635 # not be used any more lightly (or any more heavily :-) than class
636 # UNIVERSAL. Any attempt to build a general exception model on it should
637 # be politely squashed. Any bug that causes every eval {} to have to be
638 # modified should be not so politely squashed.
640 # Those are my current opinions. It is also my optinion that polite
641 # arguments degenerate to personal arguments far too frequently, and that
642 # when they do, it's because both people wanted it to, or at least didn't
643 # sufficiently want it not to.
647 # global backstop to cleanup if we should really die
648 $SIG{__DIE__} = \&cleanup;
649 $self->debug("Signal handler set.") if $CPAN::DEBUG;
652 #-> sub CPAN::DESTROY ;
654 &cleanup; # need an eval?
657 #-> sub CPAN::anycwd ;
660 $getcwd = $CPAN::Config->{'getcwd'} || 'cwd';
665 sub cwd {Cwd::cwd();}
667 #-> sub CPAN::getcwd ;
668 sub getcwd {Cwd::getcwd();}
670 #-> sub CPAN::exists ;
672 my($mgr,$class,$id) = @_;
673 CPAN::Config->load unless $CPAN::Config_loaded++;
675 ### Carp::croak "exists called without class argument" unless $class;
677 exists $META->{readonly}{$class}{$id} or
678 exists $META->{readwrite}{$class}{$id}; # unsafe meta access, ok
681 #-> sub CPAN::delete ;
683 my($mgr,$class,$id) = @_;
684 delete $META->{readonly}{$class}{$id}; # unsafe meta access, ok
685 delete $META->{readwrite}{$class}{$id}; # unsafe meta access, ok
688 #-> sub CPAN::has_usable
689 # has_inst is sometimes too optimistic, we should replace it with this
690 # has_usable whenever a case is given
692 my($self,$mod,$message) = @_;
693 return 1 if $HAS_USABLE->{$mod};
694 my $has_inst = $self->has_inst($mod,$message);
695 return unless $has_inst;
698 LWP => [ # we frequently had "Can't locate object
699 # method "new" via package "LWP::UserAgent" at
700 # (eval 69) line 2006
702 sub {require LWP::UserAgent},
703 sub {require HTTP::Request},
704 sub {require URI::URL},
707 sub {require Net::FTP},
708 sub {require Net::Config},
711 if ($usable->{$mod}) {
712 for my $c (0..$#{$usable->{$mod}}) {
713 my $code = $usable->{$mod}[$c];
714 my $ret = eval { &$code() };
716 warn "DEBUG: c[$c]\$\@[$@]ret[$ret]";
721 return $HAS_USABLE->{$mod} = 1;
724 #-> sub CPAN::has_inst
726 my($self,$mod,$message) = @_;
727 Carp::croak("CPAN->has_inst() called without an argument")
729 if (defined $message && $message eq "no"
731 exists $CPAN::META->{dontload_hash}{$mod} # unsafe meta access, ok
733 exists $CPAN::Config->{dontload_hash}{$mod}
735 $CPAN::META->{dontload_hash}{$mod}||=1; # unsafe meta access, ok
741 $file =~ s|/|\\|g if $^O eq 'MSWin32';
744 # checking %INC is wrong, because $INC{LWP} may be true
745 # although $INC{"URI/URL.pm"} may have failed. But as
746 # I really want to say "bla loaded OK", I have to somehow
748 ### warn "$file in %INC"; #debug
750 } elsif (eval { require $file }) {
751 # eval is good: if we haven't yet read the database it's
752 # perfect and if we have installed the module in the meantime,
753 # it tries again. The second require is only a NOOP returning
754 # 1 if we had success, otherwise it's retrying
756 $CPAN::Frontend->myprint("CPAN: $mod loaded ok\n");
757 if ($mod eq "CPAN::WAIT") {
758 push @CPAN::Shell::ISA, CPAN::WAIT;
761 } elsif ($mod eq "Net::FTP") {
762 $CPAN::Frontend->mywarn(qq{
763 Please, install Net::FTP as soon as possible. CPAN.pm installs it for you
765 install Bundle::libnet
767 }) unless $Have_warned->{"Net::FTP"}++;
769 } elsif ($mod eq "Digest::MD5"){
770 $CPAN::Frontend->myprint(qq{
771 CPAN: MD5 security checks disabled because Digest::MD5 not installed.
772 Please consider installing the Digest::MD5 module.
776 } elsif ($mod eq "Module::Signature"){
777 $CPAN::Frontend->myprint(qq{
778 CPAN: Module::Signature security checks disabled because Module::Signature
779 not installed. Please consider installing the Module::Signature module.
784 delete $INC{$file}; # if it inc'd LWP but failed during, say, URI
789 #-> sub CPAN::instance ;
791 my($mgr,$class,$id) = @_;
794 # unsafe meta access, ok?
795 return $META->{readwrite}{$class}{$id} if exists $META->{readwrite}{$class}{$id};
796 $META->{readwrite}{$class}{$id} ||= $class->new(ID => $id);
804 #-> sub CPAN::cleanup ;
806 # warn "cleanup called with arg[@_] End[$End] Signal[$Signal]";
807 local $SIG{__DIE__} = '';
812 while ((undef,undef,undef,$subroutine) = caller(++$i)) {
814 $subroutine eq '(eval)';
816 return if $ineval && !$End;
817 return unless defined $META->{LOCK};
818 return unless -f $META->{LOCK};
820 unlink $META->{LOCK};
822 # Carp::cluck("DEBUGGING");
823 $CPAN::Frontend->mywarn("Lockfile removed.\n");
826 #-> sub CPAN::savehist
829 my($histfile,$histsize);
830 unless ($histfile = $CPAN::Config->{'histfile'}){
831 $CPAN::Frontend->mywarn("No history written (no histfile specified).\n");
834 $histsize = $CPAN::Config->{'histsize'} || 100;
836 unless ($CPAN::term->can("GetHistory")) {
837 $CPAN::Frontend->mywarn("Terminal does not support GetHistory.\n");
843 my @h = $CPAN::term->GetHistory;
844 splice @h, 0, @h-$histsize if @h>$histsize;
845 my($fh) = FileHandle->new;
846 open $fh, ">$histfile" or $CPAN::Frontend->mydie("Couldn't open >$histfile: $!");
847 local $\ = local $, = "\n";
853 my($self,$what) = @_;
854 $self->{is_tested}{$what} = 1;
858 my($self,$what) = @_;
859 delete $self->{is_tested}{$what};
864 $self->{is_tested} ||= {};
865 return unless %{$self->{is_tested}};
866 my $env = $ENV{PERL5LIB};
867 $env = $ENV{PERLLIB} unless defined $env;
869 push @env, $env if defined $env and length $env;
870 my @dirs = map {("$_/blib/arch", "$_/blib/lib")} keys %{$self->{is_tested}};
871 $CPAN::Frontend->myprint("Prepending @dirs to PERL5LIB.\n");
872 $ENV{PERL5LIB} = join $Config::Config{path_sep}, @dirs, @env;
875 package CPAN::CacheMgr;
877 #-> sub CPAN::CacheMgr::as_string ;
879 eval { require Data::Dumper };
881 return shift->SUPER::as_string;
883 return Data::Dumper::Dumper(shift);
887 #-> sub CPAN::CacheMgr::cachesize ;
892 #-> sub CPAN::CacheMgr::tidyup ;
895 return unless -d $self->{ID};
896 while ($self->{DU} > $self->{'MAX'} ) {
897 my($toremove) = shift @{$self->{FIFO}};
898 $CPAN::Frontend->myprint(sprintf(
899 "Deleting from cache".
900 ": $toremove (%.1f>%.1f MB)\n",
901 $self->{DU}, $self->{'MAX'})
903 return if $CPAN::Signal;
904 $self->force_clean_cache($toremove);
905 return if $CPAN::Signal;
909 #-> sub CPAN::CacheMgr::dir ;
914 #-> sub CPAN::CacheMgr::entries ;
917 return unless defined $dir;
918 $self->debug("reading dir[$dir]") if $CPAN::DEBUG;
919 $dir ||= $self->{ID};
920 my($cwd) = CPAN::anycwd();
921 chdir $dir or Carp::croak("Can't chdir to $dir: $!");
922 my $dh = DirHandle->new(File::Spec->curdir)
923 or Carp::croak("Couldn't opendir $dir: $!");
926 next if $_ eq "." || $_ eq "..";
928 push @entries, File::Spec->catfile($dir,$_);
930 push @entries, File::Spec->catdir($dir,$_);
932 $CPAN::Frontend->mywarn("Warning: weird direntry in $dir: $_\n");
935 chdir $cwd or Carp::croak("Can't chdir to $cwd: $!");
936 sort { -M $b <=> -M $a} @entries;
939 #-> sub CPAN::CacheMgr::disk_usage ;
942 return if exists $self->{SIZE}{$dir};
943 return if $CPAN::Signal;
947 $File::Find::prune++ if $CPAN::Signal;
949 if ($^O eq 'MacOS') {
951 my $cat = Mac::Files::FSpGetCatInfo($_);
952 $Du += $cat->ioFlLgLen() + $cat->ioFlRLgLen() if $cat;
959 return if $CPAN::Signal;
960 $self->{SIZE}{$dir} = $Du/1024/1024;
961 push @{$self->{FIFO}}, $dir;
962 $self->debug("measured $dir is $Du") if $CPAN::DEBUG;
963 $self->{DU} += $Du/1024/1024;
967 #-> sub CPAN::CacheMgr::force_clean_cache ;
968 sub force_clean_cache {
970 return unless -e $dir;
971 $self->debug("have to rmtree $dir, will free $self->{SIZE}{$dir}")
973 File::Path::rmtree($dir);
974 $self->{DU} -= $self->{SIZE}{$dir};
975 delete $self->{SIZE}{$dir};
978 #-> sub CPAN::CacheMgr::new ;
985 ID => $CPAN::Config->{'build_dir'},
986 MAX => $CPAN::Config->{'build_cache'},
987 SCAN => $CPAN::Config->{'scan_cache'} || 'atstart',
990 File::Path::mkpath($self->{ID});
991 my $dh = DirHandle->new($self->{ID});
995 $debug .= "timing of CacheMgr->new: ".($t2 - $time);
997 CPAN->debug($debug) if $CPAN::DEBUG;
1001 #-> sub CPAN::CacheMgr::scan_cache ;
1004 return if $self->{SCAN} eq 'never';
1005 $CPAN::Frontend->mydie("Unknown scan_cache argument: $self->{SCAN}")
1006 unless $self->{SCAN} eq 'atstart';
1007 $CPAN::Frontend->myprint(
1008 sprintf("Scanning cache %s for sizes\n",
1011 for $e ($self->entries($self->{ID})) {
1012 next if $e eq ".." || $e eq ".";
1013 $self->disk_usage($e);
1014 return if $CPAN::Signal;
1019 package CPAN::Debug;
1021 #-> sub CPAN::Debug::debug ;
1023 my($self,$arg) = @_;
1024 my($caller,$func,$line,@rest) = caller(1); # caller(0) eg
1025 # Complete, caller(1)
1027 ($caller) = caller(0);
1028 $caller =~ s/.*:://;
1029 $arg = "" unless defined $arg;
1030 my $rest = join "|", map { defined $_ ? $_ : "UNDEF" } @rest;
1031 if ($CPAN::DEBUG{$caller} & $CPAN::DEBUG){
1032 if ($arg and ref $arg) {
1033 eval { require Data::Dumper };
1035 $CPAN::Frontend->myprint($arg->as_string);
1037 $CPAN::Frontend->myprint(Data::Dumper::Dumper($arg));
1040 $CPAN::Frontend->myprint("Debug($caller:$func,$line,[$rest]): $arg\n");
1045 package CPAN::Config;
1047 #-> sub CPAN::Config::edit ;
1048 # returns true on successful action
1050 my($self,@args) = @_;
1051 return unless @args;
1052 CPAN->debug("self[$self]args[".join(" | ",@args)."]");
1053 my($o,$str,$func,$args,$key_exists);
1059 CPAN->debug("o[$o]") if $CPAN::DEBUG;
1060 if ($o =~ /list$/) {
1061 $func = shift @args;
1063 CPAN->debug("func[$func]") if $CPAN::DEBUG;
1065 # Let's avoid eval, it's easier to comprehend without.
1066 if ($func eq "push") {
1067 push @{$CPAN::Config->{$o}}, @args;
1069 } elsif ($func eq "pop") {
1070 pop @{$CPAN::Config->{$o}};
1072 } elsif ($func eq "shift") {
1073 shift @{$CPAN::Config->{$o}};
1075 } elsif ($func eq "unshift") {
1076 unshift @{$CPAN::Config->{$o}}, @args;
1078 } elsif ($func eq "splice") {
1079 splice @{$CPAN::Config->{$o}}, @args;
1082 $CPAN::Config->{$o} = [@args];
1085 $self->prettyprint($o);
1087 if ($o eq "urllist" && $changed) {
1088 # reset the cached values
1089 undef $CPAN::FTP::Thesite;
1090 undef $CPAN::FTP::Themethod;
1094 $CPAN::Config->{$o} = $args[0] if defined $args[0];
1095 $self->prettyprint($o);
1102 my $v = $CPAN::Config->{$k};
1104 my(@report) = ref $v eq "ARRAY" ?
1106 map { sprintf(" %-18s => %s\n",
1108 defined $v->{$_} ? $v->{$_} : "UNDEFINED"
1110 $CPAN::Frontend->myprint(
1117 map {"\t$_\n"} @report
1120 } elsif (defined $v) {
1121 $CPAN::Frontend->myprint(sprintf " %-18s %s\n", $k, $v);
1123 $CPAN::Frontend->myprint(sprintf " %-18s %s\n", $k, "UNDEFINED");
1127 #-> sub CPAN::Config::commit ;
1129 my($self,$configpm) = @_;
1130 unless (defined $configpm){
1131 $configpm ||= $INC{"CPAN/MyConfig.pm"};
1132 $configpm ||= $INC{"CPAN/Config.pm"};
1133 $configpm || Carp::confess(q{
1134 CPAN::Config::commit called without an argument.
1135 Please specify a filename where to save the configuration or try
1136 "o conf init" to have an interactive course through configing.
1141 $mode = (stat $configpm)[2];
1142 if ($mode && ! -w _) {
1143 Carp::confess("$configpm is not writable");
1148 $msg = <<EOF unless $configpm =~ /MyConfig/;
1150 # This is CPAN.pm's systemwide configuration file. This file provides
1151 # defaults for users, and the values can be changed in a per-user
1152 # configuration file. The user-config file is being looked for as
1153 # ~/.cpan/CPAN/MyConfig.pm.
1157 my($fh) = FileHandle->new;
1158 rename $configpm, "$configpm~" if -f $configpm;
1159 open $fh, ">$configpm" or
1160 $CPAN::Frontend->mydie("Couldn't open >$configpm: $!");
1161 $fh->print(qq[$msg\$CPAN::Config = \{\n]);
1162 foreach (sort keys %$CPAN::Config) {
1165 ExtUtils::MakeMaker::neatvalue($CPAN::Config->{$_}),
1170 $fh->print("};\n1;\n__END__\n");
1173 #$mode = 0444 | ( $mode & 0111 ? 0111 : 0 );
1174 #chmod $mode, $configpm;
1175 ###why was that so? $self->defaults;
1176 $CPAN::Frontend->myprint("commit: wrote $configpm\n");
1180 *default = \&defaults;
1181 #-> sub CPAN::Config::defaults ;
1191 undef $CPAN::Config->{'inhibit_startup_message'}; # lazy trick to
1200 # This is a piece of repeated code that is abstracted here for
1201 # maintainability. RMB
1204 my($configpmdir, $configpmtest) = @_;
1205 if (-w $configpmtest) {
1206 return $configpmtest;
1207 } elsif (-w $configpmdir) {
1208 #_#_# following code dumped core on me with 5.003_11, a.k.
1209 my $configpm_bak = "$configpmtest.bak";
1210 unlink $configpm_bak if -f $configpm_bak;
1211 if( -f $configpmtest ) {
1212 if( rename $configpmtest, $configpm_bak ) {
1213 $CPAN::Frontend->mywarn(<<END)
1214 Old configuration file $configpmtest
1215 moved to $configpm_bak
1219 my $fh = FileHandle->new;
1220 if ($fh->open(">$configpmtest")) {
1222 return $configpmtest;
1224 # Should never happen
1225 Carp::confess("Cannot open >$configpmtest");
1230 #-> sub CPAN::Config::load ;
1235 eval {require CPAN::Config;}; # We eval because of some
1236 # MakeMaker problems
1237 unless ($dot_cpan++){
1238 unshift @INC, File::Spec->catdir($ENV{HOME},".cpan");
1239 eval {require CPAN::MyConfig;}; # where you can override
1240 # system wide settings
1243 return unless @miss = $self->missing_config_data;
1245 require CPAN::FirstTime;
1246 my($configpm,$fh,$redo,$theycalled);
1248 $theycalled++ if @miss==1 && $miss[0] eq 'inhibit_startup_message';
1249 if (defined $INC{"CPAN/Config.pm"} && -w $INC{"CPAN/Config.pm"}) {
1250 $configpm = $INC{"CPAN/Config.pm"};
1252 } elsif (defined $INC{"CPAN/MyConfig.pm"} && -w $INC{"CPAN/MyConfig.pm"}) {
1253 $configpm = $INC{"CPAN/MyConfig.pm"};
1256 my($path_to_cpan) = File::Basename::dirname($INC{"CPAN.pm"});
1257 my($configpmdir) = File::Spec->catdir($path_to_cpan,"CPAN");
1258 my($configpmtest) = File::Spec->catfile($configpmdir,"Config.pm");
1259 if (-d $configpmdir or File::Path::mkpath($configpmdir)) {
1260 $configpm = _configpmtest($configpmdir,$configpmtest);
1262 unless ($configpm) {
1263 $configpmdir = File::Spec->catdir($ENV{HOME},".cpan","CPAN");
1264 File::Path::mkpath($configpmdir);
1265 $configpmtest = File::Spec->catfile($configpmdir,"MyConfig.pm");
1266 $configpm = _configpmtest($configpmdir,$configpmtest);
1267 unless ($configpm) {
1268 Carp::confess(qq{WARNING: CPAN.pm is unable to }.
1269 qq{create a configuration file.});
1274 $CPAN::Frontend->myprint(<<END) if $redo && ! $theycalled;
1275 We have to reconfigure CPAN.pm due to following uninitialized parameters:
1279 $CPAN::Frontend->myprint(qq{
1280 $configpm initialized.
1283 CPAN::FirstTime::init($configpm);
1286 #-> sub CPAN::Config::missing_config_data ;
1287 sub missing_config_data {
1290 "cpan_home", "keep_source_where", "build_dir", "build_cache",
1291 "scan_cache", "index_expire", "gzip", "tar", "unzip", "make",
1293 "makepl_arg", "make_arg", "make_install_arg", "urllist",
1294 "inhibit_startup_message", "ftp_proxy", "http_proxy", "no_proxy",
1295 "prerequisites_policy",
1298 push @miss, $_ unless defined $CPAN::Config->{$_};
1303 #-> sub CPAN::Config::unload ;
1305 delete $INC{'CPAN/MyConfig.pm'};
1306 delete $INC{'CPAN/Config.pm'};
1309 #-> sub CPAN::Config::help ;
1311 $CPAN::Frontend->myprint(q[
1313 defaults reload default config values from disk
1314 commit commit session changes to disk
1315 init go through a dialog to set all parameters
1317 You may edit key values in the follow fashion (the "o" is a literal
1320 o conf build_cache 15
1322 o conf build_dir "/foo/bar"
1324 o conf urllist shift
1326 o conf urllist unshift ftp://ftp.foo.bar/
1329 undef; #don't reprint CPAN::Config
1332 #-> sub CPAN::Config::cpl ;
1334 my($word,$line,$pos) = @_;
1336 CPAN->debug("word[$word] line[$line] pos[$pos]") if $CPAN::DEBUG;
1337 my(@words) = split " ", substr($line,0,$pos+1);
1342 $words[2] =~ /list$/ && @words == 3
1344 $words[2] =~ /list$/ && @words == 4 && length($word)
1347 return grep /^\Q$word\E/, qw(splice shift unshift pop push);
1348 } elsif (@words >= 4) {
1351 my(@o_conf) = (keys %CPAN::Config::can, keys %$CPAN::Config);
1352 return grep /^\Q$word\E/, @o_conf;
1355 package CPAN::Shell;
1357 #-> sub CPAN::Shell::h ;
1359 my($class,$about) = @_;
1360 if (defined $about) {
1361 $CPAN::Frontend->myprint("Detailed help not yet implemented\n");
1363 $CPAN::Frontend->myprint(q{
1365 command argument description
1366 a,b,d,m WORD or /REGEXP/ about authors, bundles, distributions, modules
1367 i WORD or /REGEXP/ about anything of above
1368 r NONE reinstall recommendations
1369 ls AUTHOR about files in the author's directory
1371 Download, Test, Make, Install...
1373 make make (implies get)
1374 test MODULES, make test (implies make)
1375 install DISTS, BUNDLES make install (implies test)
1377 look open subshell in these dists' directories
1378 readme display these dists' README files
1381 h,? display this menu ! perl-code eval a perl command
1382 o conf [opt] set and query options q quit the cpan shell
1383 reload cpan load CPAN.pm again reload index load newer indices
1384 autobundle Snapshot force cmd unconditionally do cmd});
1390 #-> sub CPAN::Shell::a ;
1392 my($self,@arg) = @_;
1393 # authors are always UPPERCASE
1395 $_ = uc $_ unless /=/;
1397 $CPAN::Frontend->myprint($self->format_result('Author',@arg));
1400 #-> sub CPAN::Shell::ls ;
1402 my($self,@arg) = @_;
1405 unless (/^[A-Z\-]+$/i) {
1406 $CPAN::Frontend->mywarn("ls command rejects argument $_: not an author\n");
1409 push @accept, uc $_;
1411 for my $a (@accept){
1412 my $author = $self->expand('Author',$a) or die "No author found for $a";
1417 #-> sub CPAN::Shell::local_bundles ;
1419 my($self,@which) = @_;
1420 my($incdir,$bdir,$dh);
1421 foreach $incdir ($CPAN::Config->{'cpan_home'},@INC) {
1422 my @bbase = "Bundle";
1423 while (my $bbase = shift @bbase) {
1424 $bdir = File::Spec->catdir($incdir,split /::/, $bbase);
1425 CPAN->debug("bdir[$bdir]\@bbase[@bbase]") if $CPAN::DEBUG;
1426 if ($dh = DirHandle->new($bdir)) { # may fail
1428 for $entry ($dh->read) {
1429 next if $entry =~ /^\./;
1430 if (-d File::Spec->catdir($bdir,$entry)){
1431 push @bbase, "$bbase\::$entry";
1433 next unless $entry =~ s/\.pm(?!\n)\Z//;
1434 $CPAN::META->instance('CPAN::Bundle',"$bbase\::$entry");
1442 #-> sub CPAN::Shell::b ;
1444 my($self,@which) = @_;
1445 CPAN->debug("which[@which]") if $CPAN::DEBUG;
1446 $self->local_bundles;
1447 $CPAN::Frontend->myprint($self->format_result('Bundle',@which));
1450 #-> sub CPAN::Shell::d ;
1451 sub d { $CPAN::Frontend->myprint(shift->format_result('Distribution',@_));}
1453 #-> sub CPAN::Shell::m ;
1454 sub m { # emacs confused here }; sub mimimimimi { # emacs in sync here
1456 $CPAN::Frontend->myprint($self->format_result('Module',@_));
1459 #-> sub CPAN::Shell::i ;
1464 @type = qw/Author Bundle Distribution Module/;
1465 @args = '/./' unless @args;
1468 push @result, $self->expand($type,@args);
1470 my $result = @result == 1 ?
1471 $result[0]->as_string :
1473 "No objects found of any type for argument @args\n" :
1475 (map {$_->as_glimpse} @result),
1476 scalar @result, " items found\n",
1478 $CPAN::Frontend->myprint($result);
1481 #-> sub CPAN::Shell::o ;
1483 # CPAN::Shell::o and CPAN::Config::edit are closely related. 'o conf'
1484 # should have been called set and 'o debug' maybe 'set debug'
1486 my($self,$o_type,@o_what) = @_;
1488 CPAN->debug("o_type[$o_type] o_what[".join(" | ",@o_what)."]\n");
1489 if ($o_type eq 'conf') {
1490 shift @o_what if @o_what && $o_what[0] eq 'help';
1491 if (!@o_what) { # print all things, "o conf"
1493 $CPAN::Frontend->myprint("CPAN::Config options");
1494 if (exists $INC{'CPAN/Config.pm'}) {
1495 $CPAN::Frontend->myprint(" from $INC{'CPAN/Config.pm'}");
1497 if (exists $INC{'CPAN/MyConfig.pm'}) {
1498 $CPAN::Frontend->myprint(" and $INC{'CPAN/MyConfig.pm'}");
1500 $CPAN::Frontend->myprint(":\n");
1501 for $k (sort keys %CPAN::Config::can) {
1502 $v = $CPAN::Config::can{$k};
1503 $CPAN::Frontend->myprint(sprintf " %-18s %s\n", $k, $v);
1505 $CPAN::Frontend->myprint("\n");
1506 for $k (sort keys %$CPAN::Config) {
1507 CPAN::Config->prettyprint($k);
1509 $CPAN::Frontend->myprint("\n");
1510 } elsif (!CPAN::Config->edit(@o_what)) {
1511 $CPAN::Frontend->myprint(qq{Type 'o conf' to view configuration }.
1512 qq{edit options\n\n});
1514 } elsif ($o_type eq 'debug') {
1516 @o_what = () if defined $o_what[0] && $o_what[0] =~ /help/i;
1519 my($what) = shift @o_what;
1520 if ($what =~ s/^-// && exists $CPAN::DEBUG{$what}) {
1521 $CPAN::DEBUG &= $CPAN::DEBUG ^ $CPAN::DEBUG{$what};
1524 if ( exists $CPAN::DEBUG{$what} ) {
1525 $CPAN::DEBUG |= $CPAN::DEBUG{$what};
1526 } elsif ($what =~ /^\d/) {
1527 $CPAN::DEBUG = $what;
1528 } elsif (lc $what eq 'all') {
1530 for (values %CPAN::DEBUG) {
1533 $CPAN::DEBUG = $max;
1536 for (keys %CPAN::DEBUG) {
1537 next unless lc($_) eq lc($what);
1538 $CPAN::DEBUG |= $CPAN::DEBUG{$_};
1541 $CPAN::Frontend->myprint("unknown argument [$what]\n")
1546 my $raw = "Valid options for debug are ".
1547 join(", ",sort(keys %CPAN::DEBUG), 'all').
1548 qq{ or a number. Completion works on the options. }.
1549 qq{Case is ignored.};
1551 $CPAN::Frontend->myprint(Text::Wrap::fill("","",$raw));
1552 $CPAN::Frontend->myprint("\n\n");
1555 $CPAN::Frontend->myprint("Options set for debugging:\n");
1557 for $k (sort {$CPAN::DEBUG{$a} <=> $CPAN::DEBUG{$b}} keys %CPAN::DEBUG) {
1558 $v = $CPAN::DEBUG{$k};
1559 $CPAN::Frontend->myprint(sprintf " %-14s(%s)\n", $k, $v)
1560 if $v & $CPAN::DEBUG;
1563 $CPAN::Frontend->myprint("Debugging turned off completely.\n");
1566 $CPAN::Frontend->myprint(qq{
1568 conf set or get configuration variables
1569 debug set or get debugging options
1574 sub paintdots_onreload {
1577 if ( $_[0] =~ /[Ss]ubroutine ([\w:]+) redefined/ ) {
1581 # $CPAN::Frontend->myprint(".($subr)");
1582 $CPAN::Frontend->myprint(".");
1589 #-> sub CPAN::Shell::reload ;
1591 my($self,$command,@arg) = @_;
1593 $self->debug("self[$self]command[$command]arg[@arg]") if $CPAN::DEBUG;
1594 if ($command =~ /cpan/i) {
1595 for my $f (qw(CPAN.pm CPAN/FirstTime.pm)) {
1596 next unless $INC{$f};
1597 CPAN->debug("reloading the whole $f") if $CPAN::DEBUG;
1598 my $fh = FileHandle->new($INC{$f});
1601 local($SIG{__WARN__}) = paintdots_onreload(\$redef);
1604 $CPAN::Frontend->myprint("\n$redef subroutines redefined\n");
1606 } elsif ($command =~ /index/) {
1607 CPAN::Index->force_reload;
1609 $CPAN::Frontend->myprint(qq{cpan re-evals the CPAN.pm file
1610 index re-reads the index files\n});
1614 #-> sub CPAN::Shell::_binary_extensions ;
1615 sub _binary_extensions {
1616 my($self) = shift @_;
1617 my(@result,$module,%seen,%need,$headerdone);
1618 for $module ($self->expand('Module','/./')) {
1619 my $file = $module->cpan_file;
1620 next if $file eq "N/A";
1621 next if $file =~ /^Contact Author/;
1622 my $dist = $CPAN::META->instance('CPAN::Distribution',$file);
1623 next if $dist->isa_perl;
1624 next unless $module->xs_file;
1626 $CPAN::Frontend->myprint(".");
1627 push @result, $module;
1629 # print join " | ", @result;
1630 $CPAN::Frontend->myprint("\n");
1634 #-> sub CPAN::Shell::recompile ;
1636 my($self) = shift @_;
1637 my($module,@module,$cpan_file,%dist);
1638 @module = $self->_binary_extensions();
1639 for $module (@module){ # we force now and compile later, so we
1641 $cpan_file = $module->cpan_file;
1642 my $pack = $CPAN::META->instance('CPAN::Distribution',$cpan_file);
1644 $dist{$cpan_file}++;
1646 for $cpan_file (sort keys %dist) {
1647 $CPAN::Frontend->myprint(" CPAN: Recompiling $cpan_file\n\n");
1648 my $pack = $CPAN::META->instance('CPAN::Distribution',$cpan_file);
1650 $CPAN::Signal = 0; # it's tempting to reset Signal, so we can
1651 # stop a package from recompiling,
1652 # e.g. IO-1.12 when we have perl5.003_10
1656 #-> sub CPAN::Shell::_u_r_common ;
1658 my($self) = shift @_;
1659 my($what) = shift @_;
1660 CPAN->debug("self[$self] what[$what] args[@_]") if $CPAN::DEBUG;
1661 Carp::croak "Usage: \$obj->_u_r_common(a|r|u)" unless
1662 $what && $what =~ /^[aru]$/;
1664 @args = '/./' unless @args;
1665 my(@result,$module,%seen,%need,$headerdone,
1666 $version_undefs,$version_zeroes);
1667 $version_undefs = $version_zeroes = 0;
1668 my $sprintf = "%s%-25s%s %9s %9s %s\n";
1669 my @expand = $self->expand('Module',@args);
1670 my $expand = scalar @expand;
1671 if (0) { # Looks like noise to me, was very useful for debugging
1672 # for metadata cache
1673 $CPAN::Frontend->myprint(sprintf "%d matches in the database\n", $expand);
1675 for $module (@expand) {
1676 my $file = $module->cpan_file;
1677 next unless defined $file; # ??
1678 my($latest) = $module->cpan_version;
1679 my($inst_file) = $module->inst_file;
1681 return if $CPAN::Signal;
1684 $have = $module->inst_version;
1685 } elsif ($what eq "r") {
1686 $have = $module->inst_version;
1688 if ($have eq "undef"){
1690 } elsif ($have == 0){
1693 next unless CPAN::Version->vgt($latest, $have);
1694 # to be pedantic we should probably say:
1695 # && !($have eq "undef" && $latest ne "undef" && $latest gt "");
1696 # to catch the case where CPAN has a version 0 and we have a version undef
1697 } elsif ($what eq "u") {
1703 } elsif ($what eq "r") {
1705 } elsif ($what eq "u") {
1709 return if $CPAN::Signal; # this is sometimes lengthy
1712 push @result, sprintf "%s %s\n", $module->id, $have;
1713 } elsif ($what eq "r") {
1714 push @result, $module->id;
1715 next if $seen{$file}++;
1716 } elsif ($what eq "u") {
1717 push @result, $module->id;
1718 next if $seen{$file}++;
1719 next if $file =~ /^Contact/;
1721 unless ($headerdone++){
1722 $CPAN::Frontend->myprint("\n");
1723 $CPAN::Frontend->myprint(sprintf(
1726 "Package namespace",
1738 $CPAN::META->has_inst("Term::ANSIColor")
1740 $module->{RO}{description}
1742 $color_on = Term::ANSIColor::color("green");
1743 $color_off = Term::ANSIColor::color("reset");
1745 $CPAN::Frontend->myprint(sprintf $sprintf,
1752 $need{$module->id}++;
1756 $CPAN::Frontend->myprint("No modules found for @args\n");
1757 } elsif ($what eq "r") {
1758 $CPAN::Frontend->myprint("All modules are up to date for @args\n");
1762 if ($version_zeroes) {
1763 my $s_has = $version_zeroes > 1 ? "s have" : " has";
1764 $CPAN::Frontend->myprint(qq{$version_zeroes installed module$s_has }.
1765 qq{a version number of 0\n});
1767 if ($version_undefs) {
1768 my $s_has = $version_undefs > 1 ? "s have" : " has";
1769 $CPAN::Frontend->myprint(qq{$version_undefs installed module$s_has no }.
1770 qq{parseable version number\n});
1776 #-> sub CPAN::Shell::r ;
1778 shift->_u_r_common("r",@_);
1781 #-> sub CPAN::Shell::u ;
1783 shift->_u_r_common("u",@_);
1786 #-> sub CPAN::Shell::autobundle ;
1789 CPAN::Config->load unless $CPAN::Config_loaded++;
1790 my(@bundle) = $self->_u_r_common("a",@_);
1791 my($todir) = File::Spec->catdir($CPAN::Config->{'cpan_home'},"Bundle");
1792 File::Path::mkpath($todir);
1793 unless (-d $todir) {
1794 $CPAN::Frontend->myprint("Couldn't mkdir $todir for some reason\n");
1797 my($y,$m,$d) = (localtime)[5,4,3];
1801 my($me) = sprintf "Snapshot_%04d_%02d_%02d_%02d", $y, $m, $d, $c;
1802 my($to) = File::Spec->catfile($todir,"$me.pm");
1804 $me = sprintf "Snapshot_%04d_%02d_%02d_%02d", $y, $m, $d, ++$c;
1805 $to = File::Spec->catfile($todir,"$me.pm");
1807 my($fh) = FileHandle->new(">$to") or Carp::croak "Can't open >$to: $!";
1809 "package Bundle::$me;\n\n",
1810 "\$VERSION = '0.01';\n\n",
1814 "Bundle::$me - Snapshot of installation on ",
1815 $Config::Config{'myhostname'},
1818 "\n\n=head1 SYNOPSIS\n\n",
1819 "perl -MCPAN -e 'install Bundle::$me'\n\n",
1820 "=head1 CONTENTS\n\n",
1821 join("\n", @bundle),
1822 "\n\n=head1 CONFIGURATION\n\n",
1824 "\n\n=head1 AUTHOR\n\n",
1825 "This Bundle has been generated automatically ",
1826 "by the autobundle routine in CPAN.pm.\n",
1829 $CPAN::Frontend->myprint("\nWrote bundle file
1833 #-> sub CPAN::Shell::expandany ;
1836 CPAN->debug("s[$s]") if $CPAN::DEBUG;
1837 if ($s =~ m|/|) { # looks like a file
1838 $s = CPAN::Distribution->normalize($s);
1839 return $CPAN::META->instance('CPAN::Distribution',$s);
1840 # Distributions spring into existence, not expand
1841 } elsif ($s =~ m|^Bundle::|) {
1842 $self->local_bundles; # scanning so late for bundles seems
1843 # both attractive and crumpy: always
1844 # current state but easy to forget
1846 return $self->expand('Bundle',$s);
1848 return $self->expand('Module',$s)
1849 if $CPAN::META->exists('CPAN::Module',$s);
1854 #-> sub CPAN::Shell::expand ;
1857 my($type,@args) = @_;
1859 CPAN->debug("type[$type]args[@args]") if $CPAN::DEBUG;
1861 my($regex,$command);
1862 if ($arg =~ m|^/(.*)/$|) {
1864 } elsif ($arg =~ m/=/) {
1867 my $class = "CPAN::$type";
1869 CPAN->debug(sprintf "class[%s]regex[%s]command[%s]",
1871 defined $regex ? $regex : "UNDEFINED",
1872 $command || "UNDEFINED",
1874 if (defined $regex) {
1878 $CPAN::META->all_objects($class)
1881 # BUG, we got an empty object somewhere
1882 require Data::Dumper;
1883 CPAN->debug(sprintf(
1884 "Bug in CPAN: Empty id on obj[%s][%s]",
1886 Data::Dumper::Dumper($obj)
1891 if $obj->id =~ /$regex/i
1895 $] < 5.00303 ### provide sort of
1896 ### compatibility with 5.003
1901 $obj->name =~ /$regex/i
1904 } elsif ($command) {
1905 die "equal sign in command disabled (immature interface), ".
1907 ! \$CPAN::Shell::ADVANCED_QUERY=1
1908 to enable it. But please note, this is HIGHLY EXPERIMENTAL code
1909 that may go away anytime.\n"
1910 unless $ADVANCED_QUERY;
1911 my($method,$criterion) = $arg =~ /(.+?)=(.+)/;
1912 my($matchcrit) = $criterion =~ m/^~(.+)/;
1916 $CPAN::META->all_objects($class)
1918 my $lhs = $self->$method() or next; # () for 5.00503
1920 push @m, $self if $lhs =~ m/$matchcrit/;
1922 push @m, $self if $lhs eq $criterion;
1927 if ( $type eq 'Bundle' ) {
1928 $xarg =~ s/^(Bundle::)?(.*)/Bundle::$2/;
1929 } elsif ($type eq "Distribution") {
1930 $xarg = CPAN::Distribution->normalize($arg);
1932 if ($CPAN::META->exists($class,$xarg)) {
1933 $obj = $CPAN::META->instance($class,$xarg);
1934 } elsif ($CPAN::META->exists($class,$arg)) {
1935 $obj = $CPAN::META->instance($class,$arg);
1942 return wantarray ? @m : $m[0];
1945 #-> sub CPAN::Shell::format_result ;
1948 my($type,@args) = @_;
1949 @args = '/./' unless @args;
1950 my(@result) = $self->expand($type,@args);
1951 my $result = @result == 1 ?
1952 $result[0]->as_string :
1954 "No objects of type $type found for argument @args\n" :
1956 (map {$_->as_glimpse} @result),
1957 scalar @result, " items found\n",
1962 # The only reason for this method is currently to have a reliable
1963 # debugging utility that reveals which output is going through which
1964 # channel. No, I don't like the colors ;-)
1966 #-> sub CPAN::Shell::print_ornameted ;
1967 sub print_ornamented {
1968 my($self,$what,$ornament) = @_;
1970 return unless defined $what;
1972 if ($CPAN::Config->{term_is_latin}){
1975 =~ s{([\xC0-\xDF])([\x80-\xBF])}{chr(ord($1)<<6&0xC0|ord($2)&0x3F)}eg; #};
1977 if ($PRINT_ORNAMENTING) {
1978 unless (defined &color) {
1979 if ($CPAN::META->has_inst("Term::ANSIColor")) {
1980 import Term::ANSIColor "color";
1982 *color = sub { return "" };
1986 for $line (split /\n/, $what) {
1987 $longest = length($line) if length($line) > $longest;
1989 my $sprintf = "%-" . $longest . "s";
1991 $what =~ s/(.*\n?)//m;
1994 my($nl) = chomp $line ? "\n" : "";
1995 # print "line[$line]ornament[$ornament]sprintf[$sprintf]\n";
1996 print color($ornament), sprintf($sprintf,$line), color("reset"), $nl;
2000 # $what .= "\n"; # newlines unless $PRINT_ORNAMENTING
2006 my($self,$what) = @_;
2008 $self->print_ornamented($what, 'bold blue on_yellow');
2012 my($self,$what) = @_;
2013 $self->myprint($what);
2018 my($self,$what) = @_;
2019 $self->print_ornamented($what, 'bold red on_yellow');
2023 my($self,$what) = @_;
2024 $self->print_ornamented($what, 'bold red on_white');
2025 Carp::confess "died";
2029 my($self,$what) = @_;
2030 $self->print_ornamented($what, 'bold red on_white');
2035 return if -t STDOUT;
2036 my $odef = select STDERR;
2043 #-> sub CPAN::Shell::rematein ;
2044 # RE-adme||MA-ke||TE-st||IN-stall
2047 my($meth,@some) = @_;
2049 if ($meth eq 'force') {
2051 $meth = shift @some;
2054 CPAN->debug("pragma[$pragma]meth[$meth] some[@some]") if $CPAN::DEBUG;
2056 # Here is the place to set "test_count" on all involved parties to
2057 # 0. We then can pass this counter on to the involved
2058 # distributions and those can refuse to test if test_count > X. In
2059 # the first stab at it we could use a 1 for "X".
2061 # But when do I reset the distributions to start with 0 again?
2062 # Jost suggested to have a random or cycling interaction ID that
2063 # we pass through. But the ID is something that is just left lying
2064 # around in addition to the counter, so I'd prefer to set the
2065 # counter to 0 now, and repeat at the end of the loop. But what
2066 # about dependencies? They appear later and are not reset, they
2067 # enter the queue but not its copy. How do they get a sensible
2070 # construct the queue
2072 foreach $s (@some) {
2075 CPAN->debug("s is an object[$s]") if $CPAN::DEBUG;
2077 } elsif ($s =~ m|^/|) { # looks like a regexp
2078 $CPAN::Frontend->mywarn("Sorry, $meth with a regular expression is ".
2083 CPAN->debug("calling expandany [$s]") if $CPAN::DEBUG;
2084 $obj = CPAN::Shell->expandany($s);
2087 $obj->color_cmd_tmps(0,1);
2088 CPAN::Queue->new($obj->id);
2090 } elsif ($CPAN::META->exists('CPAN::Author',$s)) {
2091 $obj = $CPAN::META->instance('CPAN::Author',$s);
2092 if ($meth =~ /^(dump|ls)$/) {
2095 $CPAN::Frontend->myprint(
2097 "Don't be silly, you can't $meth ",
2105 ->myprint(qq{Warning: Cannot $meth $s, }.
2106 qq{don\'t know what it is.
2111 to find objects with matching identifiers.
2117 # queuerunner (please be warned: when I started to change the
2118 # queue to hold objects instead of names, I made one or two
2119 # mistakes and never found which. I reverted back instead)
2120 while ($s = CPAN::Queue->first) {
2123 $obj = $s; # I do not believe, we would survive if this happened
2125 $obj = CPAN::Shell->expandany($s);
2129 ($] < 5.00303 || $obj->can($pragma))){
2130 ### compatibility with 5.003
2131 $obj->$pragma($meth); # the pragma "force" in
2132 # "CPAN::Distribution" must know
2133 # what we are intending
2135 if ($]>=5.00303 && $obj->can('called_for')) {
2136 $obj->called_for($s);
2139 qq{pragma[$pragma]meth[$meth]obj[$obj]as_string\[}.
2145 CPAN::Queue->delete($s);
2147 CPAN->debug("failed");
2151 CPAN::Queue->delete_first($s);
2153 for my $obj (@qcopy) {
2154 $obj->color_cmd_tmps(0,0);
2158 #-> sub CPAN::Shell::dump ;
2159 sub dump { shift->rematein('dump',@_); }
2160 #-> sub CPAN::Shell::force ;
2161 sub force { shift->rematein('force',@_); }
2162 #-> sub CPAN::Shell::get ;
2163 sub get { shift->rematein('get',@_); }
2164 #-> sub CPAN::Shell::readme ;
2165 sub readme { shift->rematein('readme',@_); }
2166 #-> sub CPAN::Shell::make ;
2167 sub make { shift->rematein('make',@_); }
2168 #-> sub CPAN::Shell::test ;
2169 sub test { shift->rematein('test',@_); }
2170 #-> sub CPAN::Shell::install ;
2171 sub install { shift->rematein('install',@_); }
2172 #-> sub CPAN::Shell::clean ;
2173 sub clean { shift->rematein('clean',@_); }
2174 #-> sub CPAN::Shell::look ;
2175 sub look { shift->rematein('look',@_); }
2176 #-> sub CPAN::Shell::cvs_import ;
2177 sub cvs_import { shift->rematein('cvs_import',@_); }
2179 package CPAN::LWP::UserAgent;
2182 return if $SETUPDONE;
2183 if ($CPAN::META->has_usable('LWP::UserAgent')) {
2184 require LWP::UserAgent;
2185 @ISA = qw(Exporter LWP::UserAgent);
2188 $CPAN::Frontend->mywarn("LWP::UserAgent not available\n");
2192 sub get_basic_credentials {
2193 my($self, $realm, $uri, $proxy) = @_;
2194 return unless $proxy;
2195 if ($USER && $PASSWD) {
2196 } elsif (defined $CPAN::Config->{proxy_user} &&
2197 defined $CPAN::Config->{proxy_pass}) {
2198 $USER = $CPAN::Config->{proxy_user};
2199 $PASSWD = $CPAN::Config->{proxy_pass};
2201 require ExtUtils::MakeMaker;
2202 ExtUtils::MakeMaker->import(qw(prompt));
2203 $USER = prompt("Proxy authentication needed!
2204 (Note: to permanently configure username and password run
2205 o conf proxy_user your_username
2206 o conf proxy_pass your_password
2208 if ($CPAN::META->has_inst("Term::ReadKey")) {
2209 Term::ReadKey::ReadMode("noecho");
2211 $CPAN::Frontend->mywarn("Warning: Term::ReadKey seems not to be available, your password will be echoed to the terminal!\n");
2213 $PASSWD = prompt("Password:");
2214 if ($CPAN::META->has_inst("Term::ReadKey")) {
2215 Term::ReadKey::ReadMode("restore");
2217 $CPAN::Frontend->myprint("\n\n");
2219 return($USER,$PASSWD);
2223 my($self,$url,$aslocal) = @_;
2224 my $result = $self->SUPER::mirror($url,$aslocal);
2225 if ($result->code == 407) {
2228 $result = $self->SUPER::mirror($url,$aslocal);
2235 #-> sub CPAN::FTP::ftp_get ;
2237 my($class,$host,$dir,$file,$target) = @_;
2239 qq[Going to fetch file [$file] from dir [$dir]
2240 on host [$host] as local [$target]\n]
2242 my $ftp = Net::FTP->new($host);
2243 return 0 unless defined $ftp;
2244 $ftp->debug(1) if $CPAN::DEBUG{'FTP'} & $CPAN::DEBUG;
2245 $class->debug(qq[Going to login("anonymous","$Config::Config{cf_email}")]);
2246 unless ( $ftp->login("anonymous",$Config::Config{'cf_email'}) ){
2247 warn "Couldn't login on $host";
2250 unless ( $ftp->cwd($dir) ){
2251 warn "Couldn't cwd $dir";
2255 $class->debug(qq[Going to ->get("$file","$target")\n]) if $CPAN::DEBUG;
2256 unless ( $ftp->get($file,$target) ){
2257 warn "Couldn't fetch $file from $host\n";
2260 $ftp->quit; # it's ok if this fails
2264 # If more accuracy is wanted/needed, Chris Leach sent me this patch...
2266 # > *** /install/perl/live/lib/CPAN.pm- Wed Sep 24 13:08:48 1997
2267 # > --- /tmp/cp Wed Sep 24 13:26:40 1997
2269 # > *** 1562,1567 ****
2270 # > --- 1562,1580 ----
2271 # > return 1 if substr($url,0,4) eq "file";
2272 # > return 1 unless $url =~ m|://([^/]+)|;
2274 # > + my $proxy = $CPAN::Config->{'http_proxy'} || $ENV{'http_proxy'};
2276 # > + $proxy =~ m|://([^/:]+)|;
2278 # > + my $noproxy = $CPAN::Config->{'no_proxy'} || $ENV{'no_proxy'};
2279 # > + if ($noproxy) {
2280 # > + if ($host !~ /$noproxy$/) {
2281 # > + $host = $proxy;
2284 # > + $host = $proxy;
2287 # > require Net::Ping;
2288 # > return 1 unless $Net::Ping::VERSION >= 2;
2292 #-> sub CPAN::FTP::localize ;
2294 my($self,$file,$aslocal,$force) = @_;
2296 Carp::croak "Usage: ->localize(cpan_file,as_local_file[,$force])"
2297 unless defined $aslocal;
2298 $self->debug("file[$file] aslocal[$aslocal] force[$force]")
2301 if ($^O eq 'MacOS') {
2302 # Comment by AK on 2000-09-03: Uniq short filenames would be
2303 # available in CHECKSUMS file
2304 my($name, $path) = File::Basename::fileparse($aslocal, '');
2305 if (length($name) > 31) {
2316 my $size = 31 - length($suf);
2317 while (length($name) > $size) {
2321 $aslocal = File::Spec->catfile($path, $name);
2325 return $aslocal if -f $aslocal && -r _ && !($force & 1);
2328 rename $aslocal, "$aslocal.bak";
2332 my($aslocal_dir) = File::Basename::dirname($aslocal);
2333 File::Path::mkpath($aslocal_dir);
2334 $CPAN::Frontend->mywarn(qq{Warning: You are not allowed to write into }.
2335 qq{directory "$aslocal_dir".
2336 I\'ll continue, but if you encounter problems, they may be due
2337 to insufficient permissions.\n}) unless -w $aslocal_dir;
2339 # Inheritance is not easier to manage than a few if/else branches
2340 if ($CPAN::META->has_usable('LWP::UserAgent')) {
2342 CPAN::LWP::UserAgent->config;
2343 eval {$Ua = CPAN::LWP::UserAgent->new;}; # Why is has_usable still not fit enough?
2345 $CPAN::Frontend->mywarn("CPAN::LWP::UserAgent->new dies with $@\n")
2349 $Ua->proxy('ftp', $var)
2350 if $var = $CPAN::Config->{ftp_proxy} || $ENV{ftp_proxy};
2351 $Ua->proxy('http', $var)
2352 if $var = $CPAN::Config->{http_proxy} || $ENV{http_proxy};
2355 # >>>>> On Wed, 13 Dec 2000 09:21:34 -0500, "Robison, Jonathon (J.M.)" <jrobiso2@visteon.com> said:
2357 # > I note that although CPAN.pm can use proxies, it doesn't seem equipped to
2358 # > use ones that require basic autorization.
2360 # > Example of when I use it manually in my own stuff:
2362 # > $ua->proxy(['http','ftp'], http://my.proxy.server:83');
2363 # > $req->proxy_authorization_basic("username","password");
2364 # > $res = $ua->request($req);
2368 if $var = $CPAN::Config->{no_proxy} || $ENV{no_proxy};
2372 for my $prx (qw(ftp_proxy http_proxy no_proxy)) {
2373 $ENV{$prx} = $CPAN::Config->{$prx} if $CPAN::Config->{$prx};
2376 # Try the list of urls for each single object. We keep a record
2377 # where we did get a file from
2378 my(@reordered,$last);
2379 $CPAN::Config->{urllist} ||= [];
2380 unless (ref $CPAN::Config->{urllist} eq 'ARRAY') {
2381 warn "Malformed urllist; ignoring. Configuration file corrupt?\n";
2383 $last = $#{$CPAN::Config->{urllist}};
2384 if ($force & 2) { # local cpans probably out of date, don't reorder
2385 @reordered = (0..$last);
2389 (substr($CPAN::Config->{urllist}[$b],0,4) eq "file")
2391 (substr($CPAN::Config->{urllist}[$a],0,4) eq "file")
2402 @levels = ($Themethod, grep {$_ ne $Themethod} qw/easy hard hardest/);
2404 @levels = qw/easy hard hardest/;
2406 @levels = qw/easy/ if $^O eq 'MacOS';
2408 for $levelno (0..$#levels) {
2409 my $level = $levels[$levelno];
2410 my $method = "host$level";
2411 my @host_seq = $level eq "easy" ?
2412 @reordered : 0..$last; # reordered has CDROM up front
2413 @host_seq = (0) unless @host_seq;
2414 my $ret = $self->$method(\@host_seq,$file,$aslocal);
2416 $Themethod = $level;
2418 # utime $now, $now, $aslocal; # too bad, if we do that, we
2419 # might alter a local mirror
2420 $self->debug("level[$level]") if $CPAN::DEBUG;
2424 last if $CPAN::Signal; # need to cleanup
2427 unless ($CPAN::Signal) {
2430 qq{Please check, if the URLs I found in your configuration file \(}.
2431 join(", ", @{$CPAN::Config->{urllist}}).
2432 qq{\) are valid. The urllist can be edited.},
2433 qq{E.g. with 'o conf urllist push ftp://myurl/'};
2434 $CPAN::Frontend->myprint(Text::Wrap::wrap("","",@mess). "\n\n");
2436 $CPAN::Frontend->myprint("Could not fetch $file\n");
2439 rename "$aslocal.bak", $aslocal;
2440 $CPAN::Frontend->myprint("Trying to get away with old file:\n" .
2441 $self->ls($aslocal));
2448 my($self,$host_seq,$file,$aslocal) = @_;
2450 HOSTEASY: for $i (@$host_seq) {
2451 my $url = $CPAN::Config->{urllist}[$i] || $CPAN::Defaultsite;
2452 $url .= "/" unless substr($url,-1) eq "/";
2454 $self->debug("localizing perlish[$url]") if $CPAN::DEBUG;
2455 if ($url =~ /^file:/) {
2457 if ($CPAN::META->has_inst('URI::URL')) {
2458 my $u = URI::URL->new($url);
2460 } else { # works only on Unix, is poorly constructed, but
2461 # hopefully better than nothing.
2462 # RFC 1738 says fileurl BNF is
2463 # fileurl = "file://" [ host | "localhost" ] "/" fpath
2464 # Thanks to "Mark D. Baushke" <mdb@cisco.com> for
2466 ($l = $url) =~ s|^file://[^/]*/|/|; # discard the host part
2467 $l =~ s|^file:||; # assume they
2470 $l =~ s|^/||s unless -f $l; # e.g. /P:
2471 $self->debug("without URI::URL we try local file $l") if $CPAN::DEBUG;
2473 if ( -f $l && -r _) {
2477 # Maybe mirror has compressed it?
2479 $self->debug("found compressed $l.gz") if $CPAN::DEBUG;
2480 CPAN::Tarzip->gunzip("$l.gz", $aslocal);
2487 if ($CPAN::META->has_usable('LWP')) {
2488 $CPAN::Frontend->myprint("Fetching with LWP:
2492 CPAN::LWP::UserAgent->config;
2493 eval { $Ua = CPAN::LWP::UserAgent->new; };
2495 $CPAN::Frontend->mywarn("CPAN::LWP::UserAgent->new dies with $@\n");
2498 my $res = $Ua->mirror($url, $aslocal);
2499 if ($res->is_success) {
2502 utime $now, $now, $aslocal; # download time is more
2503 # important than upload time
2505 } elsif ($url !~ /\.gz(?!\n)\Z/) {
2506 my $gzurl = "$url.gz";
2507 $CPAN::Frontend->myprint("Fetching with LWP:
2510 $res = $Ua->mirror($gzurl, "$aslocal.gz");
2511 if ($res->is_success &&
2512 CPAN::Tarzip->gunzip("$aslocal.gz",$aslocal)
2518 $CPAN::Frontend->myprint(sprintf(
2519 "LWP failed with code[%s] message[%s]\n",
2523 # Alan Burlison informed me that in firewall environments
2524 # Net::FTP can still succeed where LWP fails. So we do not
2525 # skip Net::FTP anymore when LWP is available.
2528 $CPAN::Frontend->myprint("LWP not available\n");
2530 return if $CPAN::Signal;
2531 if ($url =~ m|^ftp://(.*?)/(.*)/(.*)|) {
2532 # that's the nice and easy way thanks to Graham
2533 my($host,$dir,$getfile) = ($1,$2,$3);
2534 if ($CPAN::META->has_usable('Net::FTP')) {
2536 $CPAN::Frontend->myprint("Fetching with Net::FTP:
2539 $self->debug("getfile[$getfile]dir[$dir]host[$host]" .
2540 "aslocal[$aslocal]") if $CPAN::DEBUG;
2541 if (CPAN::FTP->ftp_get($host,$dir,$getfile,$aslocal)) {
2545 if ($aslocal !~ /\.gz(?!\n)\Z/) {
2546 my $gz = "$aslocal.gz";
2547 $CPAN::Frontend->myprint("Fetching with Net::FTP
2550 if (CPAN::FTP->ftp_get($host,
2554 CPAN::Tarzip->gunzip($gz,$aslocal)
2563 return if $CPAN::Signal;
2568 my($self,$host_seq,$file,$aslocal) = @_;
2570 # Came back if Net::FTP couldn't establish connection (or
2571 # failed otherwise) Maybe they are behind a firewall, but they
2572 # gave us a socksified (or other) ftp program...
2575 my($devnull) = $CPAN::Config->{devnull} || "";
2577 my($aslocal_dir) = File::Basename::dirname($aslocal);
2578 File::Path::mkpath($aslocal_dir);
2579 HOSTHARD: for $i (@$host_seq) {
2580 my $url = $CPAN::Config->{urllist}[$i] || $CPAN::Defaultsite;
2581 $url .= "/" unless substr($url,-1) eq "/";
2583 my($proto,$host,$dir,$getfile);
2585 # Courtesy Mark Conty mark_conty@cargill.com change from
2586 # if ($url =~ m|^ftp://(.*?)/(.*)/(.*)|) {
2588 if ($url =~ m|^([^:]+)://(.*?)/(.*)/(.*)|) {
2589 # proto not yet used
2590 ($proto,$host,$dir,$getfile) = ($1,$2,$3,$4);
2592 next HOSTHARD; # who said, we could ftp anything except ftp?
2594 next HOSTHARD if $proto eq "file"; # file URLs would have had
2595 # success above. Likely a bogus URL
2597 $self->debug("localizing funkyftpwise[$url]") if $CPAN::DEBUG;
2599 for $f ('lynx','ncftpget','ncftp','wget') {
2600 next unless exists $CPAN::Config->{$f};
2601 $funkyftp = $CPAN::Config->{$f};
2602 next unless defined $funkyftp;
2603 next if $funkyftp =~ /^\s*$/;
2604 my($asl_ungz, $asl_gz);
2605 ($asl_ungz = $aslocal) =~ s/\.gz//;
2606 $asl_gz = "$asl_ungz.gz";
2607 my($src_switch) = "";
2609 $src_switch = " -source";
2610 } elsif ($f eq "ncftp"){
2611 $src_switch = " -c";
2612 } elsif ($f eq "wget"){
2613 $src_switch = " -O -";
2616 my($stdout_redir) = " > $asl_ungz";
2617 if ($f eq "ncftpget"){
2618 $chdir = "cd $aslocal_dir && ";
2621 $CPAN::Frontend->myprint(
2623 Trying with "$funkyftp$src_switch" to get
2627 "$chdir$funkyftp$src_switch \"$url\" $devnull$stdout_redir";
2628 $self->debug("system[$system]") if $CPAN::DEBUG;
2630 if (($wstatus = system($system)) == 0
2633 -s $asl_ungz # lynx returns 0 when it fails somewhere
2639 } elsif ($asl_ungz ne $aslocal) {
2640 # test gzip integrity
2641 if (CPAN::Tarzip->gtest($asl_ungz)) {
2642 # e.g. foo.tar is gzipped --> foo.tar.gz
2643 rename $asl_ungz, $aslocal;
2645 CPAN::Tarzip->gzip($asl_ungz,$asl_gz);
2650 } elsif ($url !~ /\.gz(?!\n)\Z/) {
2652 -f $asl_ungz && -s _ == 0;
2653 my $gz = "$aslocal.gz";
2654 my $gzurl = "$url.gz";
2655 $CPAN::Frontend->myprint(
2657 Trying with "$funkyftp$src_switch" to get
2660 my($system) = "$funkyftp$src_switch \"$url.gz\" $devnull > $asl_gz";
2661 $self->debug("system[$system]") if $CPAN::DEBUG;
2663 if (($wstatus = system($system)) == 0
2667 # test gzip integrity
2668 if (CPAN::Tarzip->gtest($asl_gz)) {
2669 CPAN::Tarzip->gunzip($asl_gz,$aslocal);
2671 # somebody uncompressed file for us?
2672 rename $asl_ungz, $aslocal;
2677 unlink $asl_gz if -f $asl_gz;
2680 my $estatus = $wstatus >> 8;
2681 my $size = -f $aslocal ?
2682 ", left\n$aslocal with size ".-s _ :
2683 "\nWarning: expected file [$aslocal] doesn't exist";
2684 $CPAN::Frontend->myprint(qq{
2685 System call "$system"
2686 returned status $estatus (wstat $wstatus)$size
2689 return if $CPAN::Signal;
2690 } # lynx,ncftpget,ncftp
2695 my($self,$host_seq,$file,$aslocal) = @_;
2698 my($aslocal_dir) = File::Basename::dirname($aslocal);
2699 File::Path::mkpath($aslocal_dir);
2700 my $ftpbin = $CPAN::Config->{ftp};
2701 HOSTHARDEST: for $i (@$host_seq) {
2702 unless (length $ftpbin && MM->maybe_command($ftpbin)) {
2703 $CPAN::Frontend->myprint("No external ftp command available\n\n");
2706 my $url = $CPAN::Config->{urllist}[$i] || $CPAN::Defaultsite;
2707 $url .= "/" unless substr($url,-1) eq "/";
2709 $self->debug("localizing ftpwise[$url]") if $CPAN::DEBUG;
2710 unless ($url =~ m|^ftp://(.*?)/(.*)/(.*)|) {
2713 my($host,$dir,$getfile) = ($1,$2,$3);
2715 my($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size,$atime,$mtime,
2716 $ctime,$blksize,$blocks) = stat($aslocal);
2717 $timestamp = $mtime ||= 0;
2718 my($netrc) = CPAN::FTP::netrc->new;
2719 my($netrcfile) = $netrc->netrc;
2720 my($verbose) = $CPAN::DEBUG{'FTP'} & $CPAN::DEBUG ? " -v" : "";
2721 my $targetfile = File::Basename::basename($aslocal);
2727 map("cd $_", split /\//, $dir), # RFC 1738
2729 "get $getfile $targetfile",
2733 CPAN->debug("No ~/.netrc file found") if $CPAN::DEBUG;
2734 } elsif ($netrc->hasdefault || $netrc->contains($host)) {
2735 CPAN->debug(sprintf("hasdef[%d]cont($host)[%d]",
2737 $netrc->contains($host))) if $CPAN::DEBUG;
2738 if ($netrc->protected) {
2739 $CPAN::Frontend->myprint(qq{
2740 Trying with external ftp to get
2742 As this requires some features that are not thoroughly tested, we\'re
2743 not sure, that we get it right....
2747 $self->talk_ftp("$ftpbin$verbose $host",
2749 ($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size,
2750 $atime,$mtime,$ctime,$blksize,$blocks) = stat($aslocal);
2752 if ($mtime > $timestamp) {
2753 $CPAN::Frontend->myprint("GOT $aslocal\n");
2757 $CPAN::Frontend->myprint("Hmm... Still failed!\n");
2759 return if $CPAN::Signal;
2761 $CPAN::Frontend->mywarn(qq{Your $netrcfile is not }.
2762 qq{correctly protected.\n});
2765 $CPAN::Frontend->mywarn("Your ~/.netrc neither contains $host
2766 nor does it have a default entry\n");
2769 # OK, they don't have a valid ~/.netrc. Use 'ftp -n'
2770 # then and login manually to host, using e-mail as
2772 $CPAN::Frontend->myprint(qq{Issuing "$ftpbin$verbose -n"\n});
2776 "user anonymous $Config::Config{'cf_email'}"
2778 $self->talk_ftp("$ftpbin$verbose -n", @dialog);
2779 ($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size,
2780 $atime,$mtime,$ctime,$blksize,$blocks) = stat($aslocal);
2782 if ($mtime > $timestamp) {
2783 $CPAN::Frontend->myprint("GOT $aslocal\n");
2787 $CPAN::Frontend->myprint("Bad luck... Still failed!\n");
2789 return if $CPAN::Signal;
2790 $CPAN::Frontend->myprint("Can't access URL $url.\n\n");
2796 my($self,$command,@dialog) = @_;
2797 my $fh = FileHandle->new;
2798 $fh->open("|$command") or die "Couldn't open ftp: $!";
2799 foreach (@dialog) { $fh->print("$_\n") }
2800 $fh->close; # Wait for process to complete
2802 my $estatus = $wstatus >> 8;
2803 $CPAN::Frontend->myprint(qq{
2804 Subprocess "|$command"
2805 returned status $estatus (wstat $wstatus)
2809 # find2perl needs modularization, too, all the following is stolen
2813 my($self,$name) = @_;
2814 my ($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$sizemm,
2815 $atime,$mtime,$ctime,$blksize,$blocks) = lstat($name);
2817 my($perms,%user,%group);
2821 $blocks = int(($blocks + 1) / 2);
2824 $blocks = int(($sizemm + 1023) / 1024);
2827 if (-f _) { $perms = '-'; }
2828 elsif (-d _) { $perms = 'd'; }
2829 elsif (-c _) { $perms = 'c'; $sizemm = &sizemm; }
2830 elsif (-b _) { $perms = 'b'; $sizemm = &sizemm; }
2831 elsif (-p _) { $perms = 'p'; }
2832 elsif (-S _) { $perms = 's'; }
2833 else { $perms = 'l'; $pname .= ' -> ' . readlink($_); }
2835 my(@rwx) = ('---','--x','-w-','-wx','r--','r-x','rw-','rwx');
2836 my(@moname) = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
2837 my $tmpmode = $mode;
2838 my $tmp = $rwx[$tmpmode & 7];
2840 $tmp = $rwx[$tmpmode & 7] . $tmp;
2842 $tmp = $rwx[$tmpmode & 7] . $tmp;
2843 substr($tmp,2,1) =~ tr/-x/Ss/ if -u _;
2844 substr($tmp,5,1) =~ tr/-x/Ss/ if -g _;
2845 substr($tmp,8,1) =~ tr/-x/Tt/ if -k _;
2848 my $user = $user{$uid} || $uid; # too lazy to implement lookup
2849 my $group = $group{$gid} || $gid;
2851 my($sec,$min,$hour,$mday,$mon,$year) = localtime($mtime);
2853 my($moname) = $moname[$mon];
2854 if (-M _ > 365.25 / 2) {
2855 $timeyear = $year + 1900;
2858 $timeyear = sprintf("%02d:%02d", $hour, $min);
2861 sprintf "%5lu %4ld %-10s %2d %-8s %-8s %8s %s %2d %5s %s\n",
2875 package CPAN::FTP::netrc;
2879 my $file = File::Spec->catfile($ENV{HOME},".netrc");
2881 my($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size,
2882 $atime,$mtime,$ctime,$blksize,$blocks)
2887 my($fh,@machines,$hasdefault);
2889 $fh = FileHandle->new or die "Could not create a filehandle";
2891 if($fh->open($file)){
2892 $protected = ($mode & 077) == 0;
2894 NETRC: while (<$fh>) {
2895 my(@tokens) = split " ", $_;
2896 TOKEN: while (@tokens) {
2897 my($t) = shift @tokens;
2898 if ($t eq "default"){
2902 last TOKEN if $t eq "macdef";
2903 if ($t eq "machine") {
2904 push @machines, shift @tokens;
2909 $file = $hasdefault = $protected = "";
2913 'mach' => [@machines],
2915 'hasdefault' => $hasdefault,
2916 'protected' => $protected,
2920 # CPAN::FTP::hasdefault;
2921 sub hasdefault { shift->{'hasdefault'} }
2922 sub netrc { shift->{'netrc'} }
2923 sub protected { shift->{'protected'} }
2925 my($self,$mach) = @_;
2926 for ( @{$self->{'mach'}} ) {
2927 return 1 if $_ eq $mach;
2932 package CPAN::Complete;
2935 my($text, $line, $start, $end) = @_;
2936 my(@perlret) = cpl($text, $line, $start);
2937 # find longest common match. Can anybody show me how to peruse
2938 # T::R::Gnu to have this done automatically? Seems expensive.
2939 return () unless @perlret;
2940 my($newtext) = $text;
2941 for (my $i = length($text)+1;;$i++) {
2942 last unless length($perlret[0]) && length($perlret[0]) >= $i;
2943 my $try = substr($perlret[0],0,$i);
2944 my @tries = grep {substr($_,0,$i) eq $try} @perlret;
2945 # warn "try[$try]tries[@tries]";
2946 if (@tries == @perlret) {
2952 ($newtext,@perlret);
2955 #-> sub CPAN::Complete::cpl ;
2957 my($word,$line,$pos) = @_;
2961 CPAN->debug("word [$word] line[$line] pos[$pos]") if $CPAN::DEBUG;
2963 if ($line =~ s/^(force\s*)//) {
2968 @return = grep /^$word/, @CPAN::Complete::COMMANDS;
2969 } elsif ( $line !~ /^[\!abcdghimorutl]/ ) {
2971 } elsif ($line =~ /^(a|ls)\s/) {
2972 @return = cplx('CPAN::Author',uc($word));
2973 } elsif ($line =~ /^b\s/) {
2974 CPAN::Shell->local_bundles;
2975 @return = cplx('CPAN::Bundle',$word);
2976 } elsif ($line =~ /^d\s/) {
2977 @return = cplx('CPAN::Distribution',$word);
2978 } elsif ($line =~ m/^(
2979 [mru]|make|clean|dump|get|test|install|readme|look|cvs_import
2981 if ($word =~ /^Bundle::/) {
2982 CPAN::Shell->local_bundles;
2984 @return = (cplx('CPAN::Module',$word),cplx('CPAN::Bundle',$word));
2985 } elsif ($line =~ /^i\s/) {
2986 @return = cpl_any($word);
2987 } elsif ($line =~ /^reload\s/) {
2988 @return = cpl_reload($word,$line,$pos);
2989 } elsif ($line =~ /^o\s/) {
2990 @return = cpl_option($word,$line,$pos);
2991 } elsif ($line =~ m/^\S+\s/ ) {
2992 # fallback for future commands and what we have forgotten above
2993 @return = (cplx('CPAN::Module',$word),cplx('CPAN::Bundle',$word));
3000 #-> sub CPAN::Complete::cplx ;
3002 my($class, $word) = @_;
3003 # I believed for many years that this was sorted, today I
3004 # realized, it wasn't sorted anymore. Now (rev 1.301 / v 1.55) I
3005 # make it sorted again. Maybe sort was dropped when GNU-readline
3006 # support came in? The RCS file is difficult to read on that:-(
3007 sort grep /^\Q$word\E/, map { $_->id } $CPAN::META->all_objects($class);
3010 #-> sub CPAN::Complete::cpl_any ;
3014 cplx('CPAN::Author',$word),
3015 cplx('CPAN::Bundle',$word),
3016 cplx('CPAN::Distribution',$word),
3017 cplx('CPAN::Module',$word),
3021 #-> sub CPAN::Complete::cpl_reload ;
3023 my($word,$line,$pos) = @_;
3025 my(@words) = split " ", $line;
3026 CPAN->debug("word[$word] line[$line] pos[$pos]") if $CPAN::DEBUG;
3027 my(@ok) = qw(cpan index);
3028 return @ok if @words == 1;
3029 return grep /^\Q$word\E/, @ok if @words == 2 && $word;
3032 #-> sub CPAN::Complete::cpl_option ;
3034 my($word,$line,$pos) = @_;
3036 my(@words) = split " ", $line;
3037 CPAN->debug("word[$word] line[$line] pos[$pos]") if $CPAN::DEBUG;
3038 my(@ok) = qw(conf debug);
3039 return @ok if @words == 1;
3040 return grep /^\Q$word\E/, @ok if @words == 2 && length($word);
3042 } elsif ($words[1] eq 'index') {
3044 } elsif ($words[1] eq 'conf') {
3045 return CPAN::Config::cpl(@_);
3046 } elsif ($words[1] eq 'debug') {
3047 return sort grep /^\Q$word\E/, sort keys %CPAN::DEBUG, 'all';
3051 package CPAN::Index;
3053 #-> sub CPAN::Index::force_reload ;
3056 $CPAN::Index::LAST_TIME = 0;
3060 #-> sub CPAN::Index::reload ;
3062 my($cl,$force) = @_;
3065 # XXX check if a newer one is available. (We currently read it
3066 # from time to time)
3067 for ($CPAN::Config->{index_expire}) {
3068 $_ = 0.001 unless $_ && $_ > 0.001;
3070 unless (1 || $CPAN::Have_warned->{readmetadatacache}++) {
3071 # debug here when CPAN doesn't seem to read the Metadata
3073 Carp::cluck("META-PROTOCOL[$CPAN::META->{PROTOCOL}]");
3075 unless ($CPAN::META->{PROTOCOL}) {
3076 $cl->read_metadata_cache;
3077 $CPAN::META->{PROTOCOL} ||= "1.0";
3079 if ( $CPAN::META->{PROTOCOL} < PROTOCOL ) {
3080 # warn "Setting last_time to 0";
3081 $LAST_TIME = 0; # No warning necessary
3083 return if $LAST_TIME + $CPAN::Config->{index_expire}*86400 > $time
3086 # IFF we are developing, it helps to wipe out the memory
3087 # between reloads, otherwise it is not what a user expects.
3088 undef $CPAN::META; # Neue Gruendlichkeit since v1.52(r1.274)
3089 $CPAN::META = CPAN->new;
3093 local $LAST_TIME = $time;
3094 local $CPAN::META->{PROTOCOL} = PROTOCOL;
3096 my $needshort = $^O eq "dos";
3098 $cl->rd_authindex($cl
3100 "authors/01mailrc.txt.gz",
3102 File::Spec->catfile('authors', '01mailrc.gz') :
3103 File::Spec->catfile('authors', '01mailrc.txt.gz'),
3106 $debug = "timing reading 01[".($t2 - $time)."]";
3108 return if $CPAN::Signal; # this is sometimes lengthy
3109 $cl->rd_modpacks($cl
3111 "modules/02packages.details.txt.gz",
3113 File::Spec->catfile('modules', '02packag.gz') :
3114 File::Spec->catfile('modules', '02packages.details.txt.gz'),
3117 $debug .= "02[".($t2 - $time)."]";
3119 return if $CPAN::Signal; # this is sometimes lengthy
3122 "modules/03modlist.data.gz",
3124 File::Spec->catfile('modules', '03mlist.gz') :
3125 File::Spec->catfile('modules', '03modlist.data.gz'),
3127 $cl->write_metadata_cache;
3129 $debug .= "03[".($t2 - $time)."]";
3131 CPAN->debug($debug) if $CPAN::DEBUG;
3134 $CPAN::META->{PROTOCOL} = PROTOCOL;
3137 #-> sub CPAN::Index::reload_x ;
3139 my($cl,$wanted,$localname,$force) = @_;
3140 $force |= 2; # means we're dealing with an index here
3141 CPAN::Config->load; # we should guarantee loading wherever we rely
3143 $localname ||= $wanted;
3144 my $abs_wanted = File::Spec->catfile($CPAN::Config->{'keep_source_where'},
3148 -M $abs_wanted < $CPAN::Config->{'index_expire'} &&
3151 my $s = $CPAN::Config->{'index_expire'} == 1 ? "" : "s";
3152 $cl->debug(qq{$abs_wanted younger than $CPAN::Config->{'index_expire'} }.
3153 qq{day$s. I\'ll use that.});
3156 $force |= 1; # means we're quite serious about it.
3158 return CPAN::FTP->localize($wanted,$abs_wanted,$force);
3161 #-> sub CPAN::Index::rd_authindex ;
3163 my($cl, $index_target) = @_;
3165 return unless defined $index_target;
3166 $CPAN::Frontend->myprint("Going to read $index_target\n");
3168 tie *FH, CPAN::Tarzip, $index_target;
3170 push @lines, split /\012/ while <FH>;
3172 my($userid,$fullname,$email) =
3173 m/alias\s+(\S+)\s+\"([^\"\<]+)\s+\<([^\>]+)\>\"/;
3174 next unless $userid && $fullname && $email;
3176 # instantiate an author object
3177 my $userobj = $CPAN::META->instance('CPAN::Author',$userid);
3178 $userobj->set('FULLNAME' => $fullname, 'EMAIL' => $email);
3179 return if $CPAN::Signal;
3184 my($self,$dist) = @_;
3185 $dist = $self->{'id'} unless defined $dist;
3186 my($ret) = $dist =~ m|(?:\w/\w\w/)?([^/]+)/|;
3190 #-> sub CPAN::Index::rd_modpacks ;
3192 my($self, $index_target) = @_;
3194 return unless defined $index_target;
3195 $CPAN::Frontend->myprint("Going to read $index_target\n");
3196 my $fh = CPAN::Tarzip->TIEHANDLE($index_target);
3198 while ($_ = $fh->READLINE) {
3200 my @ls = map {"$_\n"} split /\n/, $_;
3201 unshift @ls, "\n" x length($1) if /^(\n+)/;
3205 my($line_count,$last_updated);
3207 my $shift = shift(@lines);
3208 last if $shift =~ /^\s*$/;
3209 $shift =~ /^Line-Count:\s+(\d+)/ and $line_count = $1;
3210 $shift =~ /^Last-Updated:\s+(.+)/ and $last_updated = $1;
3212 if (not defined $line_count) {
3214 warn qq{Warning: Your $index_target does not contain a Line-Count header.
3215 Please check the validity of the index file by comparing it to more
3216 than one CPAN mirror. I'll continue but problems seem likely to
3221 } elsif ($line_count != scalar @lines) {
3223 warn sprintf qq{Warning: Your %s
3224 contains a Line-Count header of %d but I see %d lines there. Please
3225 check the validity of the index file by comparing it to more than one
3226 CPAN mirror. I'll continue but problems seem likely to happen.\a\n},
3227 $index_target, $line_count, scalar(@lines);
3230 if (not defined $last_updated) {
3232 warn qq{Warning: Your $index_target does not contain a Last-Updated header.
3233 Please check the validity of the index file by comparing it to more
3234 than one CPAN mirror. I'll continue but problems seem likely to
3242 ->myprint(sprintf qq{ Database was generated on %s\n},
3244 $DATE_OF_02 = $last_updated;
3246 if ($CPAN::META->has_inst(HTTP::Date)) {
3248 my($age) = (time - HTTP::Date::str2time($last_updated))/3600/24;
3253 qq{Warning: This index file is %d days old.
3254 Please check the host you chose as your CPAN mirror for staleness.
3255 I'll continue but problems seem likely to happen.\a\n},
3260 $CPAN::Frontend->myprint(" HTTP::Date not available\n");
3265 # A necessity since we have metadata_cache: delete what isn't
3267 my $secondtime = $CPAN::META->exists("CPAN::Module","CPAN");
3268 CPAN->debug("secondtime[$secondtime]") if $CPAN::DEBUG;
3272 # before 1.56 we split into 3 and discarded the rest. From
3273 # 1.57 we assign remaining text to $comment thus allowing to
3274 # influence isa_perl
3275 my($mod,$version,$dist,$comment) = split " ", $_, 4;
3276 my($bundle,$id,$userid);
3278 if ($mod eq 'CPAN' &&
3280 CPAN::Queue->exists('Bundle::CPAN') ||
3281 CPAN::Queue->exists('CPAN')
3285 if ($version > $CPAN::VERSION){
3286 $CPAN::Frontend->myprint(qq{
3287 There's a new CPAN.pm version (v$version) available!
3288 [Current version is v$CPAN::VERSION]
3289 You might want to try
3290 install Bundle::CPAN
3292 without quitting the current session. It should be a seamless upgrade
3293 while we are running...
3296 $CPAN::Frontend->myprint(qq{\n});
3298 last if $CPAN::Signal;
3299 } elsif ($mod =~ /^Bundle::(.*)/) {
3304 $id = $CPAN::META->instance('CPAN::Bundle',$mod);
3305 # Let's make it a module too, because bundles have so much
3306 # in common with modules.
3308 # Changed in 1.57_63: seems like memory bloat now without
3309 # any value, so commented out
3311 # $CPAN::META->instance('CPAN::Module',$mod);
3315 # instantiate a module object
3316 $id = $CPAN::META->instance('CPAN::Module',$mod);
3320 if ($id->cpan_file ne $dist){ # update only if file is
3321 # different. CPAN prohibits same
3322 # name with different version
3323 $userid = $id->userid || $self->userid($dist);
3325 'CPAN_USERID' => $userid,
3326 'CPAN_VERSION' => $version,
3327 'CPAN_FILE' => $dist,
3331 # instantiate a distribution object
3332 if ($CPAN::META->exists('CPAN::Distribution',$dist)) {
3333 # we do not need CONTAINSMODS unless we do something with
3334 # this dist, so we better produce it on demand.
3336 ## my $obj = $CPAN::META->instance(
3337 ## 'CPAN::Distribution' => $dist
3339 ## $obj->{CONTAINSMODS}{$mod} = undef; # experimental
3341 $CPAN::META->instance(
3342 'CPAN::Distribution' => $dist
3344 'CPAN_USERID' => $userid,
3345 'CPAN_COMMENT' => $comment,
3349 for my $name ($mod,$dist) {
3350 CPAN->debug("exists name[$name]") if $CPAN::DEBUG;
3351 $exists{$name} = undef;
3354 return if $CPAN::Signal;
3358 for my $class (qw(CPAN::Module CPAN::Bundle CPAN::Distribution)) {
3359 for my $o ($CPAN::META->all_objects($class)) {
3360 next if exists $exists{$o->{ID}};
3361 $CPAN::META->delete($class,$o->{ID});
3362 CPAN->debug("deleting ID[$o->{ID}] in class[$class]")
3369 #-> sub CPAN::Index::rd_modlist ;
3371 my($cl,$index_target) = @_;
3372 return unless defined $index_target;
3373 $CPAN::Frontend->myprint("Going to read $index_target\n");
3374 my $fh = CPAN::Tarzip->TIEHANDLE($index_target);
3377 while ($_ = $fh->READLINE) {
3379 my @ls = map {"$_\n"} split /\n/, $_;
3380 unshift @ls, "\n" x length($1) if /^(\n+)/;
3384 my $shift = shift(@eval);
3385 if ($shift =~ /^Date:\s+(.*)/){
3386 return if $DATE_OF_03 eq $1;
3389 last if $shift =~ /^\s*$/;
3392 push @eval, q{CPAN::Modulelist->data;};
3394 my($comp) = Safe->new("CPAN::Safe1");
3395 my($eval) = join("", @eval);
3396 my $ret = $comp->reval($eval);
3397 Carp::confess($@) if $@;
3398 return if $CPAN::Signal;
3400 my $obj = $CPAN::META->instance("CPAN::Module",$_);
3401 delete $ret->{$_}{modid}; # not needed here, maybe elsewhere
3402 $obj->set(%{$ret->{$_}});
3403 return if $CPAN::Signal;
3407 #-> sub CPAN::Index::write_metadata_cache ;
3408 sub write_metadata_cache {
3410 return unless $CPAN::Config->{'cache_metadata'};
3411 return unless $CPAN::META->has_usable("Storable");
3413 foreach my $k (qw(CPAN::Bundle CPAN::Author CPAN::Module
3414 CPAN::Distribution)) {
3415 $cache->{$k} = $CPAN::META->{readonly}{$k}; # unsafe meta access, ok
3417 my $metadata_file = File::Spec->catfile($CPAN::Config->{cpan_home},"Metadata");
3418 $cache->{last_time} = $LAST_TIME;
3419 $cache->{DATE_OF_02} = $DATE_OF_02;
3420 $cache->{PROTOCOL} = PROTOCOL;
3421 $CPAN::Frontend->myprint("Going to write $metadata_file\n");
3422 eval { Storable::nstore($cache, $metadata_file) };
3423 $CPAN::Frontend->mywarn($@) if $@; # ?? missing "\n" after $@ in mywarn ??
3426 #-> sub CPAN::Index::read_metadata_cache ;
3427 sub read_metadata_cache {
3429 return unless $CPAN::Config->{'cache_metadata'};
3430 return unless $CPAN::META->has_usable("Storable");
3431 my $metadata_file = File::Spec->catfile($CPAN::Config->{cpan_home},"Metadata");
3432 return unless -r $metadata_file and -f $metadata_file;
3433 $CPAN::Frontend->myprint("Going to read $metadata_file\n");
3435 eval { $cache = Storable::retrieve($metadata_file) };
3436 $CPAN::Frontend->mywarn($@) if $@; # ?? missing "\n" after $@ in mywarn ??
3437 if (!$cache || ref $cache ne 'HASH'){
3441 if (exists $cache->{PROTOCOL}) {
3442 if (PROTOCOL > $cache->{PROTOCOL}) {
3443 $CPAN::Frontend->mywarn(sprintf("Ignoring Metadata cache written ".
3444 "with protocol v%s, requiring v%s\n",
3451 $CPAN::Frontend->mywarn("Ignoring Metadata cache written ".
3452 "with protocol v1.0\n");
3457 while(my($class,$v) = each %$cache) {
3458 next unless $class =~ /^CPAN::/;
3459 $CPAN::META->{readonly}{$class} = $v; # unsafe meta access, ok
3460 while (my($id,$ro) = each %$v) {
3461 $CPAN::META->{readwrite}{$class}{$id} ||=
3462 $class->new(ID=>$id, RO=>$ro);
3467 unless ($clcnt) { # sanity check
3468 $CPAN::Frontend->myprint("Warning: Found no data in $metadata_file\n");
3471 if ($idcnt < 1000) {
3472 $CPAN::Frontend->myprint("Warning: Found only $idcnt objects ".
3473 "in $metadata_file\n");
3476 $CPAN::META->{PROTOCOL} ||=
3477 $cache->{PROTOCOL}; # reading does not up or downgrade, but it
3478 # does initialize to some protocol
3479 $LAST_TIME = $cache->{last_time};
3480 $DATE_OF_02 = $cache->{DATE_OF_02};
3481 $CPAN::Frontend->myprint(" Database was generated on $DATE_OF_02\n")
3482 if defined $DATE_OF_02; # An old cache may not contain DATE_OF_02
3486 package CPAN::InfoObj;
3491 $self->{RO}{CPAN_USERID}
3494 sub id { shift->{ID}; }
3496 #-> sub CPAN::InfoObj::new ;
3498 my $this = bless {}, shift;
3503 # The set method may only be used by code that reads index data or
3504 # otherwise "objective" data from the outside world. All session
3505 # related material may do anything else with instance variables but
3506 # must not touch the hash under the RO attribute. The reason is that
3507 # the RO hash gets written to Metadata file and is thus persistent.
3509 #-> sub CPAN::InfoObj::set ;
3511 my($self,%att) = @_;
3512 my $class = ref $self;
3514 # This must be ||=, not ||, because only if we write an empty
3515 # reference, only then the set method will write into the readonly
3516 # area. But for Distributions that spring into existence, maybe
3517 # because of a typo, we do not like it that they are written into
3518 # the readonly area and made permanent (at least for a while) and
3519 # that is why we do not "allow" other places to call ->set.
3520 unless ($self->id) {
3521 CPAN->debug("Bug? Empty ID, rejecting");
3524 my $ro = $self->{RO} =
3525 $CPAN::META->{readonly}{$class}{$self->id} ||= {};
3527 while (my($k,$v) = each %att) {
3532 #-> sub CPAN::InfoObj::as_glimpse ;
3536 my $class = ref($self);
3537 $class =~ s/^CPAN:://;
3538 push @m, sprintf "%-15s %s\n", $class, $self->{ID};
3542 #-> sub CPAN::InfoObj::as_string ;
3546 my $class = ref($self);
3547 $class =~ s/^CPAN:://;
3548 push @m, $class, " id = $self->{ID}\n";
3549 for (sort keys %{$self->{RO}}) {
3550 # next if m/^(ID|RO)$/;
3552 if ($_ eq "CPAN_USERID") {
3553 $extra .= " (".$self->author;
3554 my $email; # old perls!
3555 if ($email = $CPAN::META->instance("CPAN::Author",
3558 $extra .= " <$email>";
3560 $extra .= " <no email>";
3563 } elsif ($_ eq "FULLNAME") { # potential UTF-8 conversion
3564 push @m, sprintf " %-12s %s\n", $_, $self->fullname;
3567 next unless defined $self->{RO}{$_};
3568 push @m, sprintf " %-12s %s%s\n", $_, $self->{RO}{$_}, $extra;
3570 for (sort keys %$self) {
3571 next if m/^(ID|RO)$/;
3572 if (ref($self->{$_}) eq "ARRAY") {
3573 push @m, sprintf " %-12s %s\n", $_, "@{$self->{$_}}";
3574 } elsif (ref($self->{$_}) eq "HASH") {
3578 join(" ",keys %{$self->{$_}}),
3581 push @m, sprintf " %-12s %s\n", $_, $self->{$_};
3587 #-> sub CPAN::InfoObj::author ;
3590 $CPAN::META->instance("CPAN::Author",$self->cpan_userid)->fullname;
3593 #-> sub CPAN::InfoObj::dump ;
3596 require Data::Dumper;
3597 print Data::Dumper::Dumper($self);
3600 package CPAN::Author;
3602 #-> sub CPAN::Author::id
3605 my $id = $self->{ID};
3606 $CPAN::Frontend->mydie("Illegal author id[$id]") unless $id =~ /^[A-Z]/;
3610 #-> sub CPAN::Author::as_glimpse ;
3614 my $class = ref($self);
3615 $class =~ s/^CPAN:://;
3616 push @m, sprintf(qq{%-15s %s ("%s" <%s>)\n},
3624 #-> sub CPAN::Author::fullname ;
3626 shift->{RO}{FULLNAME};
3630 #-> sub CPAN::Author::email ;
3631 sub email { shift->{RO}{EMAIL}; }
3633 #-> sub CPAN::Author::ls ;
3638 # adapted from CPAN::Distribution::verifyMD5 ;
3639 my(@csf); # chksumfile
3640 @csf = $self->id =~ /(.)(.)(.*)/;
3641 $csf[1] = join "", @csf[0,1];
3642 $csf[2] = join "", @csf[1,2];
3644 @dl = $self->dir_listing([$csf[0],"CHECKSUMS"], 0);
3645 unless (grep {$_->[2] eq $csf[1]} @dl) {
3646 $CPAN::Frontend->myprint("No files in the directory of $id\n");
3649 @dl = $self->dir_listing([@csf[0,1],"CHECKSUMS"], 0);
3650 unless (grep {$_->[2] eq $csf[2]} @dl) {
3651 $CPAN::Frontend->myprint("No files in the directory of $id\n");
3654 @dl = $self->dir_listing([@csf,"CHECKSUMS"], 1);
3655 $CPAN::Frontend->myprint(join "", map {
3656 sprintf("%8d %10s %s/%s\n", $_->[0], $_->[1], $id, $_->[2])
3657 } sort { $a->[2] cmp $b->[2] } @dl);
3660 # returns an array of arrays, the latter contain (size,mtime,filename)
3661 #-> sub CPAN::Author::dir_listing ;
3664 my $chksumfile = shift;
3665 my $recursive = shift;
3667 File::Spec->catfile($CPAN::Config->{keep_source_where},
3668 "authors", "id", @$chksumfile);
3670 # connect "force" argument with "index_expire".
3672 if (my @stat = stat $lc_want) {
3673 $force = $stat[9] + $CPAN::Config->{index_expire}*86400 <= time;
3675 my $lc_file = CPAN::FTP->localize("authors/id/@$chksumfile",
3678 $CPAN::Frontend->myprint("Trying $lc_want.gz\n");
3679 $chksumfile->[-1] .= ".gz";
3680 $lc_file = CPAN::FTP->localize("authors/id/@$chksumfile",
3683 $lc_file =~ s{\.gz(?!\n)\Z}{}; #};
3684 CPAN::Tarzip->gunzip("$lc_file.gz",$lc_file);
3690 # adapted from CPAN::Distribution::MD5_check_file ;
3691 my $fh = FileHandle->new;
3693 if (open $fh, $lc_file){
3696 $eval =~ s/\015?\012/\n/g;
3698 my($comp) = Safe->new();
3699 $cksum = $comp->reval($eval);
3701 rename $lc_file, "$lc_file.bad";
3702 Carp::confess($@) if $@;
3705 Carp::carp "Could not open $lc_file for reading";
3708 for $f (sort keys %$cksum) {
3709 if (exists $cksum->{$f}{isdir}) {
3711 my(@dir) = @$chksumfile;
3713 push @dir, $f, "CHECKSUMS";
3715 [$_->[0], $_->[1], "$f/$_->[2]"]
3716 } $self->dir_listing(\@dir,1);
3718 push @result, [ 0, "-", $f ];
3722 ($cksum->{$f}{"size"}||0),
3723 $cksum->{$f}{"mtime"}||"---",
3731 package CPAN::Distribution;
3734 sub cpan_comment { shift->{RO}{CPAN_COMMENT} }
3738 delete $self->{later};
3741 # CPAN::Distribution::normalize
3744 $s = $self->id unless defined $s;
3748 $s !~ m|[A-Z]/[A-Z-]{2}/[A-Z-]{2,}/|
3750 return $s if $s =~ m:^N/A|^Contact Author: ;
3751 $s =~ s|^(.)(.)([^/]*/)(.+)$|$1/$1$2/$1$2$3$4| or
3752 $CPAN::Frontend->mywarn("Strange distribution name [$s]\n");
3753 CPAN->debug("s[$s]") if $CPAN::DEBUG;
3758 #-> sub CPAN::Distribution::color_cmd_tmps ;
3759 sub color_cmd_tmps {
3761 my($depth) = shift || 0;
3762 my($color) = shift || 0;
3763 my($ancestors) = shift || [];
3764 # a distribution needs to recurse into its prereq_pms
3766 return if exists $self->{incommandcolor}
3767 && $self->{incommandcolor}==$color;
3769 $CPAN::Frontend->mydie(CPAN::Exception::RecursiveDependency->new($ancestors));
3771 # warn "color_cmd_tmps $depth $color " . $self->id; # sleep 1;
3772 my $prereq_pm = $self->prereq_pm;
3773 if (defined $prereq_pm) {
3774 for my $pre (keys %$prereq_pm) {
3775 my $premo = CPAN::Shell->expand("Module",$pre);
3776 $premo->color_cmd_tmps($depth+1,$color,[@$ancestors, $self->id]);
3780 delete $self->{sponsored_mods};
3781 delete $self->{badtestcnt};
3783 $self->{incommandcolor} = $color;
3786 #-> sub CPAN::Distribution::as_string ;
3789 $self->containsmods;
3790 $self->SUPER::as_string(@_);
3793 #-> sub CPAN::Distribution::containsmods ;
3796 return keys %{$self->{CONTAINSMODS}} if exists $self->{CONTAINSMODS};
3797 my $dist_id = $self->{ID};
3798 for my $mod ($CPAN::META->all_objects("CPAN::Module")) {
3799 my $mod_file = $mod->cpan_file or next;
3800 my $mod_id = $mod->{ID} or next;
3801 # warn "mod_file[$mod_file] dist_id[$dist_id] mod_id[$mod_id]";
3803 $self->{CONTAINSMODS}{$mod_id} = undef if $mod_file eq $dist_id;
3805 keys %{$self->{CONTAINSMODS}};
3808 #-> sub CPAN::Distribution::uptodate ;
3812 foreach $c ($self->containsmods) {
3813 my $obj = CPAN::Shell->expandany($c);
3814 return 0 unless $obj->uptodate;
3819 #-> sub CPAN::Distribution::called_for ;
3822 $self->{CALLED_FOR} = $id if defined $id;
3823 return $self->{CALLED_FOR};
3826 #-> sub CPAN::Distribution::safe_chdir ;
3828 my($self,$todir) = @_;
3829 # we die if we cannot chdir and we are debuggable
3830 Carp::confess("safe_chdir called without todir argument")
3831 unless defined $todir and length $todir;
3833 $self->debug(sprintf "changed directory to %s", CPAN::anycwd())
3836 my $cwd = CPAN::anycwd();
3837 $CPAN::Frontend->mydie(qq{Could not chdir from cwd[$cwd] }.
3838 qq{to todir[$todir]: $!});
3842 #-> sub CPAN::Distribution::get ;
3847 exists $self->{'build_dir'} and push @e,
3848 "Is already unwrapped into directory $self->{'build_dir'}";
3849 $CPAN::Frontend->myprint(join "", map {" $_\n"} @e) and return if @e;
3851 my $sub_wd = CPAN::anycwd(); # for cleaning up as good as possible
3854 # Get the file on local disk
3859 File::Spec->catfile(
3860 $CPAN::Config->{keep_source_where},
3863 split(/\//,$self->id)
3866 $self->debug("Doing localize") if $CPAN::DEBUG;
3867 unless ($local_file =
3868 CPAN::FTP->localize("authors/id/$self->{ID}",
3871 if ($CPAN::Index::DATE_OF_02) {
3872 $note = "Note: Current database in memory was generated ".
3873 "on $CPAN::Index::DATE_OF_02\n";
3875 $CPAN::Frontend->mydie("Giving up on '$local_wanted'\n$note");
3877 $self->debug("local_file[$local_file]") if $CPAN::DEBUG;
3878 $self->{localfile} = $local_file;
3879 return if $CPAN::Signal;
3884 if ($CPAN::META->has_inst("Digest::MD5")) {
3885 $self->debug("Digest::MD5 is installed, verifying");
3888 $self->debug("Digest::MD5 is NOT installed");
3890 return if $CPAN::Signal;
3893 # Create a clean room and go there
3895 $CPAN::META->{cachemgr} ||= CPAN::CacheMgr->new(); # unsafe meta access, ok
3896 my $builddir = $CPAN::META->{cachemgr}->dir; # unsafe meta access, ok
3897 $self->safe_chdir($builddir);
3898 $self->debug("Removing tmp") if $CPAN::DEBUG;
3899 File::Path::rmtree("tmp");
3900 mkdir "tmp", 0755 or Carp::croak "Couldn't mkdir tmp: $!";
3902 $self->safe_chdir($sub_wd);
3905 $self->safe_chdir("tmp");
3910 if ($local_file =~ /(\.tar\.(gz|Z)|\.tgz)(?!\n)\Z/i){
3911 $self->{was_uncompressed}++ unless CPAN::Tarzip->gtest($local_file);
3912 $self->untar_me($local_file);
3913 } elsif ( $local_file =~ /\.zip(?!\n)\Z/i ) {
3914 $self->unzip_me($local_file);
3915 } elsif ( $local_file =~ /\.pm\.(gz|Z)(?!\n)\Z/) {
3916 $self->{was_uncompressed}++ unless CPAN::Tarzip->gtest($local_file);
3917 $self->pm2dir_me($local_file);
3919 $self->{archived} = "NO";
3920 $self->safe_chdir($sub_wd);
3924 # we are still in the tmp directory!
3925 # Let's check if the package has its own directory.
3926 my $dh = DirHandle->new(File::Spec->curdir)
3927 or Carp::croak("Couldn't opendir .: $!");
3928 my @readdir = grep $_ !~ /^\.\.?(?!\n)\Z/s, $dh->read; ### MAC??
3930 my ($distdir,$packagedir);
3931 if (@readdir == 1 && -d $readdir[0]) {
3932 $distdir = $readdir[0];
3933 $packagedir = File::Spec->catdir($builddir,$distdir);
3934 $self->debug("packagedir[$packagedir]builddir[$builddir]distdir[$distdir]")
3936 -d $packagedir and $CPAN::Frontend->myprint("Removing previously used ".
3938 File::Path::rmtree($packagedir);
3939 rename($distdir,$packagedir) or
3940 Carp::confess("Couldn't rename $distdir to $packagedir: $!");
3941 $self->debug(sprintf("renamed distdir[%s] to packagedir[%s] -e[%s]-d[%s]",
3948 my $userid = $self->cpan_userid;
3950 CPAN->debug("no userid? self[$self]");
3953 my $pragmatic_dir = $userid . '000';
3954 $pragmatic_dir =~ s/\W_//g;
3955 $pragmatic_dir++ while -d "../$pragmatic_dir";
3956 $packagedir = File::Spec->catdir($builddir,$pragmatic_dir);
3957 $self->debug("packagedir[$packagedir]") if $CPAN::DEBUG;
3958 File::Path::mkpath($packagedir);
3960 for $f (@readdir) { # is already without "." and ".."
3961 my $to = File::Spec->catdir($packagedir,$f);
3962 rename($f,$to) or Carp::confess("Couldn't rename $f to $to: $!");
3966 $self->safe_chdir($sub_wd);
3970 $self->{'build_dir'} = $packagedir;
3971 $self->safe_chdir($builddir);
3972 File::Path::rmtree("tmp");
3974 $self->safe_chdir($packagedir);
3975 if ($CPAN::META->has_inst("Module::Signature")) {
3976 if (-f "SIGNATURE") {
3977 $self->debug("Module::Signature is installed, verifying") if $CPAN::DEBUG;
3978 my $rv = Module::Signature::verify();
3979 if ($rv != Module::Signature::SIGNATURE_OK() and
3980 $rv != Module::Signature::SIGNATURE_MISSING()) {
3981 $CPAN::Frontend->myprint(
3982 qq{\nSignature invalid for }.
3983 qq{distribution file. }.
3984 qq{Please investigate.\n\n}.
3986 $CPAN::META->instance(
3992 my $wrap = qq{I\'d recommend removing $self->{localfile}. Its signature
3993 is invalid. Maybe you have configured your 'urllist' with
3994 a bad URL. Please check this array with 'o conf urllist', and
3996 $CPAN::Frontend->mydie(Text::Wrap::wrap("","",$wrap));
3999 $CPAN::Frontend->myprint(qq{Package came without SIGNATURE\n\n});
4002 $self->debug("Module::Signature is NOT installed") if $CPAN::DEBUG;
4004 $self->safe_chdir($builddir);
4005 return if $CPAN::Signal;
4009 my($mpl) = File::Spec->catfile($packagedir,"Makefile.PL");
4010 my($mpl_exists) = -f $mpl;
4011 unless ($mpl_exists) {
4012 # NFS has been reported to have racing problems after the
4013 # renaming of a directory in some environments.
4016 my $mpldh = DirHandle->new($packagedir)
4017 or Carp::croak("Couldn't opendir $packagedir: $!");
4018 $mpl_exists = grep /^Makefile\.PL$/, $mpldh->read;
4021 unless ($mpl_exists) {
4022 $self->debug(sprintf("makefilepl[%s]anycwd[%s]",
4026 my($configure) = File::Spec->catfile($packagedir,"Configure");
4027 if (-f $configure) {
4028 # do we have anything to do?
4029 $self->{'configure'} = $configure;
4030 } elsif (-f File::Spec->catfile($packagedir,"Makefile")) {
4031 $CPAN::Frontend->myprint(qq{
4032 Package comes with a Makefile and without a Makefile.PL.
4033 We\'ll try to build it with that Makefile then.
4035 $self->{writemakefile} = "YES";
4038 my $cf = $self->called_for || "unknown";
4043 $cf =~ s|[/\\:]||g; # risk of filesystem damage
4044 $cf = "unknown" unless length($cf);
4045 $CPAN::Frontend->myprint(qq{Package seems to come without Makefile.PL.
4046 (The test -f "$mpl" returned false.)
4047 Writing one on our own (setting NAME to $cf)\a\n});
4048 $self->{had_no_makefile_pl}++;
4051 # Writing our own Makefile.PL
4053 my $fh = FileHandle->new;
4055 or Carp::croak("Could not open >$mpl: $!");
4057 qq{# This Makefile.PL has been autogenerated by the module CPAN.pm
4058 # because there was no Makefile.PL supplied.
4059 # Autogenerated on: }.scalar localtime().qq{
4061 use ExtUtils::MakeMaker;
4062 WriteMakefile(NAME => q[$cf]);
4072 # CPAN::Distribution::untar_me ;
4074 my($self,$local_file) = @_;
4075 $self->{archived} = "tar";
4076 if (CPAN::Tarzip->untar($local_file)) {
4077 $self->{unwrapped} = "YES";
4079 $self->{unwrapped} = "NO";
4083 # CPAN::Distribution::unzip_me ;
4085 my($self,$local_file) = @_;
4086 $self->{archived} = "zip";
4087 if (CPAN::Tarzip->unzip($local_file)) {
4088 $self->{unwrapped} = "YES";
4090 $self->{unwrapped} = "NO";
4096 my($self,$local_file) = @_;
4097 $self->{archived} = "pm";
4098 my $to = File::Basename::basename($local_file);
4099 $to =~ s/\.(gz|Z)(?!\n)\Z//;
4100 if (CPAN::Tarzip->gunzip($local_file,$to)) {
4101 $self->{unwrapped} = "YES";
4103 $self->{unwrapped} = "NO";
4107 #-> sub CPAN::Distribution::new ;
4109 my($class,%att) = @_;
4111 # $CPAN::META->{cachemgr} ||= CPAN::CacheMgr->new();
4113 my $this = { %att };
4114 return bless $this, $class;
4117 #-> sub CPAN::Distribution::look ;
4121 if ($^O eq 'MacOS') {
4122 $self->Mac::BuildTools::look;
4126 if ( $CPAN::Config->{'shell'} ) {
4127 $CPAN::Frontend->myprint(qq{
4128 Trying to open a subshell in the build directory...
4131 $CPAN::Frontend->myprint(qq{
4132 Your configuration does not define a value for subshells.
4133 Please define it with "o conf shell <your shell>"
4137 my $dist = $self->id;
4139 unless ($dir = $self->dir) {
4142 unless ($dir ||= $self->dir) {
4143 $CPAN::Frontend->mywarn(qq{
4144 Could not determine which directory to use for looking at $dist.
4148 my $pwd = CPAN::anycwd();
4149 $self->safe_chdir($dir);
4150 $CPAN::Frontend->myprint(qq{Working directory is $dir\n});
4151 unless (system($CPAN::Config->{'shell'}) == 0) {
4153 $CPAN::Frontend->mywarn("Subprocess shell exit code $code\n");
4155 $self->safe_chdir($pwd);
4158 # CPAN::Distribution::cvs_import ;
4162 my $dir = $self->dir;
4164 my $package = $self->called_for;
4165 my $module = $CPAN::META->instance('CPAN::Module', $package);
4166 my $version = $module->cpan_version;
4168 my $userid = $self->cpan_userid;
4170 my $cvs_dir = (split /\//, $dir)[-1];
4171 $cvs_dir =~ s/-\d+[^-]+(?!\n)\Z//;
4173 $CPAN::Config->{cvsroot} || $ENV{CVSROOT};
4175 $CPAN::Config->{cvs_site_perl} || $ENV{CVS_SITE_PERL};
4176 if ($cvs_site_perl) {
4177 $cvs_dir = "$cvs_site_perl/$cvs_dir";
4179 my $cvs_log = qq{"imported $package $version sources"};
4180 $version =~ s/\./_/g;
4181 my @cmd = ('cvs', '-d', $cvs_root, 'import', '-m', $cvs_log,
4182 "$cvs_dir", $userid, "v$version");
4184 my $pwd = CPAN::anycwd();
4185 chdir($dir) or $CPAN::Frontend->mydie(qq{Could not chdir to "$dir": $!});
4187 $CPAN::Frontend->myprint(qq{Working directory is $dir\n});
4189 $CPAN::Frontend->myprint(qq{@cmd\n});
4190 system(@cmd) == 0 or
4191 $CPAN::Frontend->mydie("cvs import failed");
4192 chdir($pwd) or $CPAN::Frontend->mydie(qq{Could not chdir to "$pwd": $!});
4195 #-> sub CPAN::Distribution::readme ;
4198 my($dist) = $self->id;
4199 my($sans,$suffix) = $dist =~ /(.+)\.(tgz|tar[\._-]gz|tar\.Z|zip)$/;
4200 $self->debug("sans[$sans] suffix[$suffix]\n") if $CPAN::DEBUG;
4203 File::Spec->catfile(
4204 $CPAN::Config->{keep_source_where},
4207 split(/\//,"$sans.readme"),
4209 $self->debug("Doing localize") if $CPAN::DEBUG;
4210 $local_file = CPAN::FTP->localize("authors/id/$sans.readme",
4212 or $CPAN::Frontend->mydie(qq{No $sans.readme found});;
4214 if ($^O eq 'MacOS') {
4215 Mac::BuildTools::launch_file($local_file);
4219 my $fh_pager = FileHandle->new;
4220 local($SIG{PIPE}) = "IGNORE";
4221 $fh_pager->open("|$CPAN::Config->{'pager'}")
4222 or die "Could not open pager $CPAN::Config->{'pager'}: $!";
4223 my $fh_readme = FileHandle->new;
4224 $fh_readme->open($local_file)
4225 or $CPAN::Frontend->mydie(qq{Could not open "$local_file": $!});
4226 $CPAN::Frontend->myprint(qq{
4229 with pager "$CPAN::Config->{'pager'}"
4232 $fh_pager->print(<$fh_readme>);
4235 #-> sub CPAN::Distribution::verifyMD5 ;
4240 $self->{MD5_STATUS} ||= "";
4241 $self->{MD5_STATUS} eq "OK" and push @e, "MD5 Checksum was ok";
4242 $CPAN::Frontend->myprint(join "", map {" $_\n"} @e) and return if @e;
4244 my($lc_want,$lc_file,@local,$basename);
4245 @local = split(/\//,$self->id);
4247 push @local, "CHECKSUMS";
4249 File::Spec->catfile($CPAN::Config->{keep_source_where},
4250 "authors", "id", @local);
4255 $self->MD5_check_file($lc_want)
4257 return $self->{MD5_STATUS} = "OK";
4259 $lc_file = CPAN::FTP->localize("authors/id/@local",
4262 $CPAN::Frontend->myprint("Trying $lc_want.gz\n");
4263 $local[-1] .= ".gz";
4264 $lc_file = CPAN::FTP->localize("authors/id/@local",
4267 $lc_file =~ s/\.gz(?!\n)\Z//;
4268 CPAN::Tarzip->gunzip("$lc_file.gz",$lc_file);
4273 $self->MD5_check_file($lc_file);
4276 sub SIG_check_file {
4277 my($self,$chk_file) = @_;
4278 my $rv = eval { Module::Signature::_verify($chk_file) };
4280 if ($rv == Module::Signature::SIGNATURE_OK()) {
4281 $CPAN::Frontend->myprint("Signature for $chk_file ok\n");
4282 return $self->{SIG_STATUS} = "OK";
4284 $CPAN::Frontend->myprint(qq{\nSignature invalid for }.
4285 qq{distribution file. }.
4286 qq{Please investigate.\n\n}.
4288 $CPAN::META->instance(
4293 my $wrap = qq{I\'d recommend removing $chk_file. Its signature
4294 is invalid. Maybe you have configured your 'urllist' with
4295 a bad URL. Please check this array with 'o conf urllist', and
4298 $CPAN::Frontend->mydie(Text::Wrap::wrap("","",$wrap));
4302 #-> sub CPAN::Distribution::MD5_check_file ;
4303 sub MD5_check_file {
4304 my($self,$chk_file) = @_;
4305 my($cksum,$file,$basename);
4307 if ($CPAN::META->has_inst("Module::Signature") and Module::Signature->VERSION >= 0.26) {
4308 $self->debug("Module::Signature is installed, verifying");
4309 $self->SIG_check_file($chk_file);
4311 $self->debug("Module::Signature is NOT installed");
4314 $file = $self->{localfile};
4315 $basename = File::Basename::basename($file);
4316 my $fh = FileHandle->new;
4317 if (open $fh, $chk_file){
4320 $eval =~ s/\015?\012/\n/g;
4322 my($comp) = Safe->new();
4323 $cksum = $comp->reval($eval);
4325 rename $chk_file, "$chk_file.bad";
4326 Carp::confess($@) if $@;
4329 Carp::carp "Could not open $chk_file for reading";
4332 if (exists $cksum->{$basename}{md5}) {
4333 $self->debug("Found checksum for $basename:" .
4334 "$cksum->{$basename}{md5}\n") if $CPAN::DEBUG;
4338 my $eq = $self->eq_MD5($fh,$cksum->{$basename}{'md5'});
4340 $fh = CPAN::Tarzip->TIEHANDLE($file);
4343 # had to inline it, when I tied it, the tiedness got lost on
4344 # the call to eq_MD5. (Jan 1998)
4345 my $md5 = Digest::MD5->new;
4348 while ($fh->READ($ref, 4096) > 0){
4351 my $hexdigest = $md5->hexdigest;
4352 $eq += $hexdigest eq $cksum->{$basename}{'md5-ungz'};
4356 $CPAN::Frontend->myprint("Checksum for $file ok\n");
4357 return $self->{MD5_STATUS} = "OK";
4359 $CPAN::Frontend->myprint(qq{\nChecksum mismatch for }.
4360 qq{distribution file. }.
4361 qq{Please investigate.\n\n}.
4363 $CPAN::META->instance(
4368 my $wrap = qq{I\'d recommend removing $file. Its MD5
4369 checksum is incorrect. Maybe you have configured your 'urllist' with
4370 a bad URL. Please check this array with 'o conf urllist', and
4373 $CPAN::Frontend->mydie(Text::Wrap::wrap("","",$wrap));
4375 # former versions just returned here but this seems a
4376 # serious threat that deserves a die
4378 # $CPAN::Frontend->myprint("\n\n");
4382 # close $fh if fileno($fh);
4384 $self->{MD5_STATUS} ||= "";
4385 if ($self->{MD5_STATUS} eq "NIL") {
4386 $CPAN::Frontend->mywarn(qq{
4387 Warning: No md5 checksum for $basename in $chk_file.
4389 The cause for this may be that the file is very new and the checksum
4390 has not yet been calculated, but it may also be that something is
4391 going awry right now.
4393 my $answer = ExtUtils::MakeMaker::prompt("Proceed?", "yes");
4394 $answer =~ /^\s*y/i or $CPAN::Frontend->mydie("Aborted.");
4396 $self->{MD5_STATUS} = "NIL";
4401 #-> sub CPAN::Distribution::eq_MD5 ;
4403 my($self,$fh,$expectMD5) = @_;
4404 my $md5 = Digest::MD5->new;
4406 while (read($fh, $data, 4096)){
4409 # $md5->addfile($fh);
4410 my $hexdigest = $md5->hexdigest;
4411 # warn "fh[$fh] hex[$hexdigest] aexp[$expectMD5]";
4412 $hexdigest eq $expectMD5;
4415 #-> sub CPAN::Distribution::force ;
4417 # Both modules and distributions know if "force" is in effect by
4418 # autoinspection, not by inspecting a global variable. One of the
4419 # reason why this was chosen to work that way was the treatment of
4420 # dependencies. They should not autpomatically inherit the force
4421 # status. But this has the downside that ^C and die() will return to
4422 # the prompt but will not be able to reset the force_update
4423 # attributes. We try to correct for it currently in the read_metadata
4424 # routine, and immediately before we check for a Signal. I hope this
4425 # works out in one of v1.57_53ff
4428 my($self, $method) = @_;
4430 MD5_STATUS archived build_dir localfile make install unwrapped
4433 delete $self->{$att};
4435 if ($method && $method eq "install") {
4436 $self->{"force_update"}++; # name should probably have been force_install
4440 #-> sub CPAN::Distribution::unforce ;
4443 delete $self->{'force_update'};
4446 #-> sub CPAN::Distribution::isa_perl ;
4449 my $file = File::Basename::basename($self->id);
4450 if ($file =~ m{ ^ perl
4463 } elsif ($self->cpan_comment
4465 $self->cpan_comment =~ /isa_perl\(.+?\)/){
4470 #-> sub CPAN::Distribution::perl ;
4473 my($perl) = File::Spec->file_name_is_absolute($^X) ? $^X : "";
4474 my $pwd = CPAN::anycwd();
4475 my $candidate = File::Spec->catfile($pwd,$^X);
4476 $perl ||= $candidate if MM->maybe_command($candidate);
4478 my ($component,$perl_name);
4479 DIST_PERLNAME: foreach $perl_name ($^X, 'perl', 'perl5', "perl$]") {
4480 PATH_COMPONENT: foreach $component (File::Spec->path(),
4481 $Config::Config{'binexp'}) {
4482 next unless defined($component) && $component;
4483 my($abs) = File::Spec->catfile($component,$perl_name);
4484 if (MM->maybe_command($abs)) {
4494 #-> sub CPAN::Distribution::make ;
4497 $CPAN::Frontend->myprint(sprintf "Running make for %s\n", $self->id);
4498 # Emergency brake if they said install Pippi and get newest perl
4499 if ($self->isa_perl) {
4501 $self->called_for ne $self->id &&
4502 ! $self->{force_update}
4504 # if we die here, we break bundles
4505 $CPAN::Frontend->mywarn(sprintf qq{
4506 The most recent version "%s" of the module "%s"
4507 comes with the current version of perl (%s).
4508 I\'ll build that only if you ask for something like
4513 $CPAN::META->instance(
4527 $self->{archived} eq "NO" and push @e,
4528 "Is neither a tar nor a zip archive.";
4530 $self->{unwrapped} eq "NO" and push @e,
4531 "had problems unarchiving. Please build manually";
4533 exists $self->{writemakefile} &&
4534 $self->{writemakefile} =~ m/ ^ NO\s* ( .* ) /sx and push @e,
4535 $1 || "Had some problem writing Makefile";
4537 defined $self->{'make'} and push @e,
4538 "Has already been processed within this session";
4540 exists $self->{later} and length($self->{later}) and
4541 push @e, $self->{later};
4543 $CPAN::Frontend->myprint(join "", map {" $_\n"} @e) and return if @e;
4545 $CPAN::Frontend->myprint("\n CPAN.pm: Going to build ".$self->id."\n\n");
4546 my $builddir = $self->dir;
4547 chdir $builddir or Carp::croak("Couldn't chdir $builddir: $!");
4548 $self->debug("Changed directory to $builddir") if $CPAN::DEBUG;
4550 if ($^O eq 'MacOS') {
4551 Mac::BuildTools::make($self);
4556 if ($self->{'configure'}) {
4557 $system = $self->{'configure'};
4559 my($perl) = $self->perl or die "Couldn\'t find executable perl\n";
4561 # This needs a handler that can be turned on or off:
4562 # $switch = "-MExtUtils::MakeMaker ".
4563 # "-Mops=:default,:filesys_read,:filesys_open,require,chdir"
4565 $system = "$perl $switch Makefile.PL $CPAN::Config->{makepl_arg}";
4567 unless (exists $self->{writemakefile}) {
4568 local($SIG{ALRM}) = sub { die "inactivity_timeout reached\n" };
4571 if ($CPAN::Config->{inactivity_timeout}) {
4573 alarm $CPAN::Config->{inactivity_timeout};
4574 local $SIG{CHLD}; # = sub { wait };
4575 if (defined($pid = fork)) {
4580 # note, this exec isn't necessary if
4581 # inactivity_timeout is 0. On the Mac I'd
4582 # suggest, we set it always to 0.
4586 $CPAN::Frontend->myprint("Cannot fork: $!");
4594 $CPAN::Frontend->myprint($@);
4595 $self->{writemakefile} = "NO $@";
4600 $ret = system($system);
4602 $self->{writemakefile} = "NO Makefile.PL returned status $ret";
4606 if (-f "Makefile") {
4607 $self->{writemakefile} = "YES";
4608 delete $self->{make_clean}; # if cleaned before, enable next
4610 $self->{writemakefile} =
4611 qq{NO Makefile.PL refused to write a Makefile.};
4612 # It's probably worth it to record the reason, so let's retry
4614 # my $fh = IO::File->new("$system |"); # STDERR? STDIN?
4615 # $self->{writemakefile} .= <$fh>;
4619 delete $self->{force_update};
4622 if (my @prereq = $self->unsat_prereq){
4623 return 1 if $self->follow_prereqs(@prereq); # signal success to the queuerunner
4625 $system = join " ", $CPAN::Config->{'make'}, $CPAN::Config->{make_arg};
4626 if (system($system) == 0) {
4627 $CPAN::Frontend->myprint(" $system -- OK\n");
4628 $self->{'make'} = "YES";
4630 $self->{writemakefile} ||= "YES";
4631 $self->{'make'} = "NO";
4632 $CPAN::Frontend->myprint(" $system -- NOT OK\n");
4636 sub follow_prereqs {
4640 $CPAN::Frontend->myprint("---- Unsatisfied dependencies detected ".
4641 "during [$id] -----\n");
4643 for my $p (@prereq) {
4644 $CPAN::Frontend->myprint(" $p\n");
4647 if ($CPAN::Config->{prerequisites_policy} eq "follow") {
4649 } elsif ($CPAN::Config->{prerequisites_policy} eq "ask") {
4650 require ExtUtils::MakeMaker;
4651 my $answer = ExtUtils::MakeMaker::prompt(
4652 "Shall I follow them and prepend them to the queue
4653 of modules we are processing right now?", "yes");
4654 $follow = $answer =~ /^\s*y/i;
4658 myprint(" Ignoring dependencies on modules @prereq\n");
4661 # color them as dirty
4662 for my $p (@prereq) {
4663 # warn "calling color_cmd_tmps(0,1)";
4664 CPAN::Shell->expandany($p)->color_cmd_tmps(0,1);
4666 CPAN::Queue->jumpqueue(@prereq,$id); # queue them and requeue yourself
4667 $self->{later} = "Delayed until after prerequisites";
4668 return 1; # signal success to the queuerunner
4672 #-> sub CPAN::Distribution::unsat_prereq ;
4675 my $prereq_pm = $self->prereq_pm or return;
4677 NEED: while (my($need_module, $need_version) = each %$prereq_pm) {
4678 my $nmo = $CPAN::META->instance("CPAN::Module",$need_module);
4679 # we were too demanding:
4680 next if $nmo->uptodate;
4682 # if they have not specified a version, we accept any installed one
4683 if (not defined $need_version or
4684 $need_version == 0 or
4685 $need_version eq "undef") {
4686 next if defined $nmo->inst_file;
4689 # We only want to install prereqs if either they're not installed
4690 # or if the installed version is too old. We cannot omit this
4691 # check, because if 'force' is in effect, nobody else will check.
4695 defined $nmo->inst_file &&
4696 ! CPAN::Version->vgt($need_version, $nmo->inst_version)
4698 CPAN->debug(sprintf "id[%s]inst_file[%s]inst_version[%s]need_version[%s]",
4702 CPAN::Version->readable($need_version)
4708 if ($self->{sponsored_mods}{$need_module}++){
4709 # We have already sponsored it and for some reason it's still
4710 # not available. So we do nothing. Or what should we do?
4711 # if we push it again, we have a potential infinite loop
4714 push @need, $need_module;
4719 #-> sub CPAN::Distribution::prereq_pm ;
4722 return $self->{prereq_pm} if
4723 exists $self->{prereq_pm_detected} && $self->{prereq_pm_detected};
4724 return unless $self->{writemakefile}; # no need to have succeeded
4725 # but we must have run it
4726 my $build_dir = $self->{build_dir} or die "Panic: no build_dir?";
4727 my $makefile = File::Spec->catfile($build_dir,"Makefile");
4732 $fh = FileHandle->new("<$makefile\0")) {
4736 # A.Speer @p -> %p, where %p is $p{Module::Name}=Required_Version
4738 last if /MakeMaker post_initialize section/;
4740 \s+PREREQ_PM\s+=>\s+(.+)
4743 # warn "Found prereq expr[$p]";
4745 # Regexp modified by A.Speer to remember actual version of file
4746 # PREREQ_PM hash key wants, then add to
4747 while ( $p =~ m/(?:\s)([\w\:]+)=>q\[(.*?)\],?/g ){
4748 # In case a prereq is mentioned twice, complain.
4749 if ( defined $p{$1} ) {
4750 warn "Warning: PREREQ_PM mentions $1 more than once, last mention wins";
4757 $self->{prereq_pm_detected}++;
4758 return $self->{prereq_pm} = \%p;
4761 #-> sub CPAN::Distribution::test ;
4766 delete $self->{force_update};
4769 $CPAN::Frontend->myprint("Running make test\n");
4770 if (my @prereq = $self->unsat_prereq){
4771 return 1 if $self->follow_prereqs(@prereq); # signal success to the queuerunner
4775 exists $self->{make} or exists $self->{later} or push @e,
4776 "Make had some problems, maybe interrupted? Won't test";
4778 exists $self->{'make'} and
4779 $self->{'make'} eq 'NO' and
4780 push @e, "Can't test without successful make";
4782 exists $self->{build_dir} or push @e, "Has no own directory";
4783 $self->{badtestcnt} ||= 0;
4784 $self->{badtestcnt} > 0 and
4785 push @e, "Won't repeat unsuccessful test during this command";
4787 exists $self->{later} and length($self->{later}) and
4788 push @e, $self->{later};
4790 $CPAN::Frontend->myprint(join "", map {" $_\n"} @e) and return if @e;
4792 chdir $self->{'build_dir'} or
4793 Carp::croak("Couldn't chdir to $self->{'build_dir'}");
4794 $self->debug("Changed directory to $self->{'build_dir'}")
4797 if ($^O eq 'MacOS') {
4798 Mac::BuildTools::make_test($self);
4802 local $ENV{PERL5LIB} = $ENV{PERL5LIB} || "";
4803 $CPAN::META->set_perl5lib;
4804 my $system = join " ", $CPAN::Config->{'make'}, "test";
4805 if (system($system) == 0) {
4806 $CPAN::Frontend->myprint(" $system -- OK\n");
4807 $CPAN::META->is_tested($self->{'build_dir'});
4808 $self->{make_test} = "YES";
4810 $self->{make_test} = "NO";
4811 $self->{badtestcnt}++;
4812 $CPAN::Frontend->myprint(" $system -- NOT OK\n");
4816 #-> sub CPAN::Distribution::clean ;
4819 $CPAN::Frontend->myprint("Running make clean\n");
4822 exists $self->{make_clean} and $self->{make_clean} eq "YES" and
4823 push @e, "make clean already called once";
4824 exists $self->{build_dir} or push @e, "Has no own directory";
4825 $CPAN::Frontend->myprint(join "", map {" $_\n"} @e) and return if @e;
4827 chdir $self->{'build_dir'} or
4828 Carp::croak("Couldn't chdir to $self->{'build_dir'}");
4829 $self->debug("Changed directory to $self->{'build_dir'}") if $CPAN::DEBUG;
4831 if ($^O eq 'MacOS') {
4832 Mac::BuildTools::make_clean($self);
4836 my $system = join " ", $CPAN::Config->{'make'}, "clean";
4837 if (system($system) == 0) {
4838 $CPAN::Frontend->myprint(" $system -- OK\n");
4842 # Jost Krieger pointed out that this "force" was wrong because
4843 # it has the effect that the next "install" on this distribution
4844 # will untar everything again. Instead we should bring the
4845 # object's state back to where it is after untarring.
4847 delete $self->{force_update};
4848 delete $self->{install};
4849 delete $self->{writemakefile};
4850 delete $self->{make};
4851 delete $self->{make_test}; # no matter if yes or no, tests must be redone
4852 $self->{make_clean} = "YES";
4855 # Hmmm, what to do if make clean failed?
4857 $CPAN::Frontend->myprint(qq{ $system -- NOT OK
4859 make clean did not succeed, marking directory as unusable for further work.
4861 $self->force("make"); # so that this directory won't be used again
4866 #-> sub CPAN::Distribution::install ;
4871 delete $self->{force_update};
4874 $CPAN::Frontend->myprint("Running make install\n");
4877 exists $self->{build_dir} or push @e, "Has no own directory";
4879 exists $self->{make} or exists $self->{later} or push @e,
4880 "Make had some problems, maybe interrupted? Won't install";
4882 exists $self->{'make'} and
4883 $self->{'make'} eq 'NO' and
4884 push @e, "make had returned bad status, install seems impossible";
4886 push @e, "make test had returned bad status, ".
4887 "won't install without force"
4888 if exists $self->{'make_test'} and
4889 $self->{'make_test'} eq 'NO' and
4890 ! $self->{'force_update'};
4892 exists $self->{'install'} and push @e,
4893 $self->{'install'} eq "YES" ?
4894 "Already done" : "Already tried without success";
4896 exists $self->{later} and length($self->{later}) and
4897 push @e, $self->{later};
4899 $CPAN::Frontend->myprint(join "", map {" $_\n"} @e) and return if @e;
4901 chdir $self->{'build_dir'} or
4902 Carp::croak("Couldn't chdir to $self->{'build_dir'}");
4903 $self->debug("Changed directory to $self->{'build_dir'}")
4906 if ($^O eq 'MacOS') {
4907 Mac::BuildTools::make_install($self);
4911 my $system = join(" ", $CPAN::Config->{'make'},
4912 "install", $CPAN::Config->{make_install_arg});
4913 my($stderr) = $^O =~ /Win/i ? "" : " 2>&1 ";
4914 my($pipe) = FileHandle->new("$system $stderr |");
4917 $CPAN::Frontend->myprint($_);
4922 $CPAN::Frontend->myprint(" $system -- OK\n");
4923 $CPAN::META->is_installed($self->{'build_dir'});
4924 return $self->{'install'} = "YES";
4926 $self->{'install'} = "NO";
4927 $CPAN::Frontend->myprint(" $system -- NOT OK\n");
4928 if ($makeout =~ /permission/s && $> > 0) {
4929 $CPAN::Frontend->myprint(qq{ You may have to su }.
4930 qq{to root to install the package\n});
4933 delete $self->{force_update};
4936 #-> sub CPAN::Distribution::dir ;
4938 shift->{'build_dir'};
4941 package CPAN::Bundle;
4945 $CPAN::Frontend->myprint($self->as_string);
4950 delete $self->{later};
4951 for my $c ( $self->contains ) {
4952 my $obj = CPAN::Shell->expandany($c) or next;
4957 #-> sub CPAN::Bundle::color_cmd_tmps ;
4958 sub color_cmd_tmps {
4960 my($depth) = shift || 0;
4961 my($color) = shift || 0;
4962 my($ancestors) = shift || [];
4963 # a module needs to recurse to its cpan_file, a distribution needs
4964 # to recurse into its prereq_pms, a bundle needs to recurse into its modules
4966 return if exists $self->{incommandcolor}
4967 && $self->{incommandcolor}==$color;
4969 $CPAN::Frontend->mydie(CPAN::Exception::RecursiveDependency->new($ancestors));
4971 # warn "color_cmd_tmps $depth $color " . $self->id; # sleep 1;
4973 for my $c ( $self->contains ) {
4974 my $obj = CPAN::Shell->expandany($c) or next;
4975 CPAN->debug("c[$c]obj[$obj]") if $CPAN::DEBUG;
4976 $obj->color_cmd_tmps($depth+1,$color,[@$ancestors, $self->id]);
4979 delete $self->{badtestcnt};
4981 $self->{incommandcolor} = $color;
4984 #-> sub CPAN::Bundle::as_string ;
4988 # following line must be "=", not "||=" because we have a moving target
4989 $self->{INST_VERSION} = $self->inst_version;
4990 return $self->SUPER::as_string;
4993 #-> sub CPAN::Bundle::contains ;
4996 my($inst_file) = $self->inst_file || "";
4997 my($id) = $self->id;
4998 $self->debug("inst_file[$inst_file]id[$id]") if $CPAN::DEBUG;
4999 unless ($inst_file) {
5000 # Try to get at it in the cpan directory
5001 $self->debug("no inst_file") if $CPAN::DEBUG;
5003 $CPAN::Frontend->mydie("I don't know a bundle with ID $id\n") unless
5004 $cpan_file = $self->cpan_file;
5005 if ($cpan_file eq "N/A") {
5006 $CPAN::Frontend->mydie("Bundle $id not found on disk and not on CPAN.
5007 Maybe stale symlink? Maybe removed during session? Giving up.\n");
5009 my $dist = $CPAN::META->instance('CPAN::Distribution',
5012 $self->debug($dist->as_string) if $CPAN::DEBUG;
5013 my($todir) = $CPAN::Config->{'cpan_home'};
5014 my(@me,$from,$to,$me);
5015 @me = split /::/, $self->id;
5017 $me = File::Spec->catfile(@me);
5018 $from = $self->find_bundle_file($dist->{'build_dir'},$me);
5019 $to = File::Spec->catfile($todir,$me);
5020 File::Path::mkpath(File::Basename::dirname($to));
5021 File::Copy::copy($from, $to)
5022 or Carp::confess("Couldn't copy $from to $to: $!");
5026 my $fh = FileHandle->new;
5028 open($fh,$inst_file) or die "Could not open '$inst_file': $!";
5030 $self->debug("inst_file[$inst_file]") if $CPAN::DEBUG;
5032 $in_cont = m/^=(?!head1\s+CONTENTS)/ ? 0 :
5033 m/^=head1\s+CONTENTS/ ? 1 : $in_cont;
5034 next unless $in_cont;
5039 push @result, (split " ", $_, 2)[0];
5042 delete $self->{STATUS};
5043 $self->{CONTAINS} = \@result;
5044 $self->debug("CONTAINS[@result]") if $CPAN::DEBUG;
5046 $CPAN::Frontend->mywarn(qq{
5047 The bundle file "$inst_file" may be a broken
5048 bundlefile. It seems not to contain any bundle definition.
5049 Please check the file and if it is bogus, please delete it.
5050 Sorry for the inconvenience.
5056 #-> sub CPAN::Bundle::find_bundle_file
5057 sub find_bundle_file {
5058 my($self,$where,$what) = @_;
5059 $self->debug("where[$where]what[$what]") if $CPAN::DEBUG;
5060 ### The following two lines let CPAN.pm become Bundle/CPAN.pm :-(
5061 ### my $bu = File::Spec->catfile($where,$what);
5062 ### return $bu if -f $bu;
5063 my $manifest = File::Spec->catfile($where,"MANIFEST");
5064 unless (-f $manifest) {
5065 require ExtUtils::Manifest;
5066 my $cwd = CPAN::anycwd();
5067 chdir $where or $CPAN::Frontend->mydie(qq{Could not chdir to "$where": $!});
5068 ExtUtils::Manifest::mkmanifest();
5069 chdir $cwd or $CPAN::Frontend->mydie(qq{Could not chdir to "$cwd": $!});
5071 my $fh = FileHandle->new($manifest)
5072 or Carp::croak("Couldn't open $manifest: $!");
5075 if ($^O eq 'MacOS') {
5078 $what2 =~ s/:Bundle://;
5081 $what2 =~ s|Bundle[/\\]||;
5086 my($file) = /(\S+)/;
5087 if ($file =~ m|\Q$what\E$|) {
5089 # return File::Spec->catfile($where,$bu); # bad
5092 # retry if she managed to
5093 # have no Bundle directory
5094 $bu = $file if $file =~ m|\Q$what2\E$|;
5096 $bu =~ tr|/|:| if $^O eq 'MacOS';
5097 return File::Spec->catfile($where, $bu) if $bu;
5098 Carp::croak("Couldn't find a Bundle file in $where");
5101 # needs to work quite differently from Module::inst_file because of
5102 # cpan_home/Bundle/ directory and the possibility that we have
5103 # shadowing effect. As it makes no sense to take the first in @INC for
5104 # Bundles, we parse them all for $VERSION and take the newest.
5106 #-> sub CPAN::Bundle::inst_file ;
5111 @me = split /::/, $self->id;
5114 foreach $incdir ($CPAN::Config->{'cpan_home'},@INC) {
5115 my $bfile = File::Spec->catfile($incdir, @me);
5116 CPAN->debug("bfile[$bfile]") if $CPAN::DEBUG;
5117 next unless -f $bfile;
5118 my $foundv = MM->parse_version($bfile);
5119 if (!$bestv || CPAN::Version->vgt($foundv,$bestv)) {
5120 $self->{INST_FILE} = $bfile;
5121 $self->{INST_VERSION} = $bestv = $foundv;
5127 #-> sub CPAN::Bundle::inst_version ;
5130 $self->inst_file; # finds INST_VERSION as side effect
5131 $self->{INST_VERSION};
5134 #-> sub CPAN::Bundle::rematein ;
5136 my($self,$meth) = @_;
5137 $self->debug("self[$self] meth[$meth]") if $CPAN::DEBUG;
5138 my($id) = $self->id;
5139 Carp::croak "Can't $meth $id, don't have an associated bundle file. :-(\n"
5140 unless $self->inst_file || $self->cpan_file;
5142 for $s ($self->contains) {
5143 my($type) = $s =~ m|/| ? 'CPAN::Distribution' :
5144 $s =~ m|^Bundle::| ? 'CPAN::Bundle' : 'CPAN::Module';
5145 if ($type eq 'CPAN::Distribution') {
5146 $CPAN::Frontend->mywarn(qq{
5147 The Bundle }.$self->id.qq{ contains
5148 explicitly a file $s.
5152 # possibly noisy action:
5153 $self->debug("type[$type] s[$s]") if $CPAN::DEBUG;
5154 my $obj = $CPAN::META->instance($type,$s);
5156 if ($obj->isa(CPAN::Bundle)
5158 exists $obj->{install_failed}
5160 ref($obj->{install_failed}) eq "HASH"
5162 for (keys %{$obj->{install_failed}}) {
5163 $self->{install_failed}{$_} = undef; # propagate faiure up
5166 $fail{$s} = 1; # the bundle itself may have succeeded but
5171 $success = $obj->can("uptodate") ? $obj->uptodate : 0;
5172 $success ||= $obj->{'install'} && $obj->{'install'} eq "YES";
5174 delete $self->{install_failed}{$s};
5181 # recap with less noise
5182 if ( $meth eq "install" ) {
5185 my $raw = sprintf(qq{Bundle summary:
5186 The following items in bundle %s had installation problems:},
5189 $CPAN::Frontend->myprint(Text::Wrap::fill("","",$raw));
5190 $CPAN::Frontend->myprint("\n");
5193 for $s ($self->contains) {
5195 $paragraph .= "$s ";
5196 $self->{install_failed}{$s} = undef;
5197 $reported{$s} = undef;
5200 my $report_propagated;
5201 for $s (sort keys %{$self->{install_failed}}) {
5202 next if exists $reported{$s};
5203 $paragraph .= "and the following items had problems
5204 during recursive bundle calls: " unless $report_propagated++;
5205 $paragraph .= "$s ";
5207 $CPAN::Frontend->myprint(Text::Wrap::fill(" "," ",$paragraph));
5208 $CPAN::Frontend->myprint("\n");
5210 $self->{'install'} = 'YES';
5215 #sub CPAN::Bundle::xs_file
5217 # If a bundle contains another that contains an xs_file we have
5218 # here, we just don't bother I suppose
5222 #-> sub CPAN::Bundle::force ;
5223 sub force { shift->rematein('force',@_); }
5224 #-> sub CPAN::Bundle::get ;
5225 sub get { shift->rematein('get',@_); }
5226 #-> sub CPAN::Bundle::make ;
5227 sub make { shift->rematein('make',@_); }
5228 #-> sub CPAN::Bundle::test ;
5231 $self->{badtestcnt} ||= 0;
5232 $self->rematein('test',@_);
5234 #-> sub CPAN::Bundle::install ;
5237 $self->rematein('install',@_);
5239 #-> sub CPAN::Bundle::clean ;
5240 sub clean { shift->rematein('clean',@_); }
5242 #-> sub CPAN::Bundle::uptodate ;
5245 return 0 unless $self->SUPER::uptodate; # we mut have the current Bundle def
5247 foreach $c ($self->contains) {
5248 my $obj = CPAN::Shell->expandany($c);
5249 return 0 unless $obj->uptodate;
5254 #-> sub CPAN::Bundle::readme ;
5257 my($file) = $self->cpan_file or $CPAN::Frontend->myprint(qq{
5258 No File found for bundle } . $self->id . qq{\n}), return;
5259 $self->debug("self[$self] file[$file]") if $CPAN::DEBUG;
5260 $CPAN::META->instance('CPAN::Distribution',$file)->readme;
5263 package CPAN::Module;
5266 # sub CPAN::Module::userid
5269 return unless exists $self->{RO}; # should never happen
5270 return $self->{RO}{userid} || $self->{RO}{CPAN_USERID};
5272 # sub CPAN::Module::description
5273 sub description { shift->{RO}{description} }
5277 delete $self->{later};
5278 if ( my $dist = CPAN::Shell->expand("Distribution", $self->cpan_file) ) {
5283 #-> sub CPAN::Module::color_cmd_tmps ;
5284 sub color_cmd_tmps {
5286 my($depth) = shift || 0;
5287 my($color) = shift || 0;
5288 my($ancestors) = shift || [];
5289 # a module needs to recurse to its cpan_file
5291 return if exists $self->{incommandcolor}
5292 && $self->{incommandcolor}==$color;
5294 $CPAN::Frontend->mydie(CPAN::Exception::RecursiveDependency->new($ancestors));
5296 # warn "color_cmd_tmps $depth $color " . $self->id; # sleep 1;
5298 if ( my $dist = CPAN::Shell->expand("Distribution", $self->cpan_file) ) {
5299 $dist->color_cmd_tmps($depth+1,$color,[@$ancestors, $self->id]);
5302 delete $self->{badtestcnt};
5304 $self->{incommandcolor} = $color;
5307 #-> sub CPAN::Module::as_glimpse ;
5311 my $class = ref($self);
5312 $class =~ s/^CPAN:://;
5316 $CPAN::Shell::COLOR_REGISTERED
5318 $CPAN::META->has_inst("Term::ANSIColor")
5320 $self->{RO}{description}
5322 $color_on = Term::ANSIColor::color("green");
5323 $color_off = Term::ANSIColor::color("reset");
5325 push @m, sprintf("%-15s %s%-15s%s (%s)\n",
5334 #-> sub CPAN::Module::as_string ;
5338 CPAN->debug("$self entering as_string") if $CPAN::DEBUG;
5339 my $class = ref($self);
5340 $class =~ s/^CPAN:://;
5342 push @m, $class, " id = $self->{ID}\n";
5343 my $sprintf = " %-12s %s\n";
5344 push @m, sprintf($sprintf, 'DESCRIPTION', $self->description)
5345 if $self->description;
5346 my $sprintf2 = " %-12s %s (%s)\n";
5348 $userid = $self->userid;
5351 if ($author = CPAN::Shell->expand('Author',$userid)) {
5354 if ($m = $author->email) {
5361 $author->fullname . $email
5365 push @m, sprintf($sprintf, 'CPAN_VERSION', $self->cpan_version)
5366 if $self->cpan_version;
5367 push @m, sprintf($sprintf, 'CPAN_FILE', $self->cpan_file)
5368 if $self->cpan_file;
5369 my $sprintf3 = " %-12s %1s%1s%1s%1s (%s,%s,%s,%s)\n";
5370 my(%statd,%stats,%statl,%stati);
5371 @statd{qw,? i c a b R M S,} = qw,unknown idea
5372 pre-alpha alpha beta released mature standard,;
5373 @stats{qw,? m d u n a,} = qw,unknown mailing-list
5374 developer comp.lang.perl.* none abandoned,;
5375 @statl{qw,? p c + o h,} = qw,unknown perl C C++ other hybrid,;
5376 @stati{qw,? f r O h,} = qw,unknown functions
5377 references+ties object-oriented hybrid,;
5378 $statd{' '} = 'unknown';
5379 $stats{' '} = 'unknown';
5380 $statl{' '} = 'unknown';
5381 $stati{' '} = 'unknown';
5389 $statd{$self->{RO}{statd}},
5390 $stats{$self->{RO}{stats}},
5391 $statl{$self->{RO}{statl}},
5392 $stati{$self->{RO}{stati}}
5393 ) if $self->{RO}{statd};
5394 my $local_file = $self->inst_file;
5395 unless ($self->{MANPAGE}) {
5397 $self->{MANPAGE} = $self->manpage_headline($local_file);
5399 # If we have already untarred it, we should look there
5400 my $dist = $CPAN::META->instance('CPAN::Distribution',
5402 # warn "dist[$dist]";
5403 # mff=manifest file; mfh=manifest handle
5408 (-f ($mff = File::Spec->catfile($dist->{build_dir}, "MANIFEST")))
5410 $mfh = FileHandle->new($mff)
5412 CPAN->debug("mff[$mff]") if $CPAN::DEBUG;
5413 my $lfre = $self->id; # local file RE
5416 my($lfl); # local file file
5418 my(@mflines) = <$mfh>;
5423 while (length($lfre)>5 and !$lfl) {
5424 ($lfl) = grep /$lfre/, @mflines;
5425 CPAN->debug("lfl[$lfl]lfre[$lfre]") if $CPAN::DEBUG;
5428 $lfl =~ s/\s.*//; # remove comments
5429 $lfl =~ s/\s+//g; # chomp would maybe be too system-specific
5430 my $lfl_abs = File::Spec->catfile($dist->{build_dir},$lfl);
5431 # warn "lfl_abs[$lfl_abs]";
5433 $self->{MANPAGE} = $self->manpage_headline($lfl_abs);
5439 for $item (qw/MANPAGE/) {
5440 push @m, sprintf($sprintf, $item, $self->{$item})
5441 if exists $self->{$item};
5443 for $item (qw/CONTAINS/) {
5444 push @m, sprintf($sprintf, $item, join(" ",@{$self->{$item}}))
5445 if exists $self->{$item} && @{$self->{$item}};
5447 push @m, sprintf($sprintf, 'INST_FILE',
5448 $local_file || "(not installed)");
5449 push @m, sprintf($sprintf, 'INST_VERSION',
5450 $self->inst_version) if $local_file;
5454 sub manpage_headline {
5455 my($self,$local_file) = @_;
5456 my(@local_file) = $local_file;
5457 $local_file =~ s/\.pm(?!\n)\Z/.pod/;
5458 push @local_file, $local_file;
5460 for $locf (@local_file) {
5461 next unless -f $locf;
5462 my $fh = FileHandle->new($locf)
5463 or $Carp::Frontend->mydie("Couldn't open $locf: $!");
5467 $inpod = m/^=(?!head1\s+NAME\s*$)/ ? 0 :
5468 m/^=head1\s+NAME\s*$/ ? 1 : $inpod;
5481 #-> sub CPAN::Module::cpan_file ;
5482 # Note: also inherited by CPAN::Bundle
5485 CPAN->debug(sprintf "id[%s]", $self->id) if $CPAN::DEBUG;
5486 unless (defined $self->{RO}{CPAN_FILE}) {
5487 CPAN::Index->reload;
5489 if (exists $self->{RO}{CPAN_FILE} && defined $self->{RO}{CPAN_FILE}){
5490 return $self->{RO}{CPAN_FILE};
5492 my $userid = $self->userid;
5494 if ($CPAN::META->exists("CPAN::Author",$userid)) {
5495 my $author = $CPAN::META->instance("CPAN::Author",
5497 my $fullname = $author->fullname;
5498 my $email = $author->email;
5499 unless (defined $fullname && defined $email) {
5500 return sprintf("Contact Author %s",
5504 return "Contact Author $fullname <$email>";
5506 return "UserID $userid";
5514 #-> sub CPAN::Module::cpan_version ;
5518 $self->{RO}{CPAN_VERSION} = 'undef'
5519 unless defined $self->{RO}{CPAN_VERSION};
5520 # I believe this is always a bug in the index and should be reported
5521 # as such, but usually I find out such an error and do not want to
5522 # provoke too many bugreports
5524 $self->{RO}{CPAN_VERSION};
5527 #-> sub CPAN::Module::force ;
5530 $self->{'force_update'}++;
5533 #-> sub CPAN::Module::rematein ;
5535 my($self,$meth) = @_;
5536 $CPAN::Frontend->myprint(sprintf("Running %s for module %s\n",
5539 my $cpan_file = $self->cpan_file;
5540 if ($cpan_file eq "N/A" || $cpan_file =~ /^Contact Author/){
5541 $CPAN::Frontend->mywarn(sprintf qq{
5542 The module %s isn\'t available on CPAN.
5544 Either the module has not yet been uploaded to CPAN, or it is
5545 temporary unavailable. Please contact the author to find out
5546 more about the status. Try 'i %s'.
5553 my $pack = $CPAN::META->instance('CPAN::Distribution',$cpan_file);
5554 $pack->called_for($self->id);
5555 $pack->force($meth) if exists $self->{'force_update'};
5557 $pack->unforce if $pack->can("unforce") && exists $self->{'force_update'};
5558 delete $self->{'force_update'};
5561 #-> sub CPAN::Module::readme ;
5562 sub readme { shift->rematein('readme') }
5563 #-> sub CPAN::Module::look ;
5564 sub look { shift->rematein('look') }
5565 #-> sub CPAN::Module::cvs_import ;
5566 sub cvs_import { shift->rematein('cvs_import') }
5567 #-> sub CPAN::Module::get ;
5568 sub get { shift->rematein('get',@_); }
5569 #-> sub CPAN::Module::make ;
5572 $self->rematein('make');
5574 #-> sub CPAN::Module::test ;
5577 $self->{badtestcnt} ||= 0;
5578 $self->rematein('test',@_);
5580 #-> sub CPAN::Module::uptodate ;
5583 my($latest) = $self->cpan_version;
5585 my($inst_file) = $self->inst_file;
5587 if (defined $inst_file) {
5588 $have = $self->inst_version;
5593 ! CPAN::Version->vgt($latest, $have)
5595 CPAN->debug("returning uptodate. inst_file[$inst_file] ".
5596 "latest[$latest] have[$have]") if $CPAN::DEBUG;
5601 #-> sub CPAN::Module::install ;
5607 not exists $self->{'force_update'}
5609 $CPAN::Frontend->myprint( $self->id. " is up to date.\n");
5613 if ($self->{RO}{stats} && $self->{RO}{stats} eq "a") {
5614 $CPAN::Frontend->mywarn(qq{
5615 \n\n\n ***WARNING***
5616 The module $self->{ID} has no active maintainer.\n\n\n
5620 $self->rematein('install') if $doit;
5622 #-> sub CPAN::Module::clean ;
5623 sub clean { shift->rematein('clean') }
5625 #-> sub CPAN::Module::inst_file ;
5629 @packpath = split /::/, $self->{ID};
5630 $packpath[-1] .= ".pm";
5631 foreach $dir (@INC) {
5632 my $pmfile = File::Spec->catfile($dir,@packpath);
5640 #-> sub CPAN::Module::xs_file ;
5644 @packpath = split /::/, $self->{ID};
5645 push @packpath, $packpath[-1];
5646 $packpath[-1] .= "." . $Config::Config{'dlext'};
5647 foreach $dir (@INC) {
5648 my $xsfile = File::Spec->catfile($dir,'auto',@packpath);
5656 #-> sub CPAN::Module::inst_version ;
5659 my $parsefile = $self->inst_file or return;
5660 local($^W) = 0 if $] < 5.00303 && $ExtUtils::MakeMaker::VERSION < 5.38;
5663 # there was a bug in 5.6.0 that let lots of unini warnings out of
5664 # parse_version. Fixed shortly after 5.6.0 by PMQS. We can remove
5665 # the following workaround after 5.6.1 is out.
5666 local($SIG{__WARN__}) = sub { my $w = shift;
5667 return if $w =~ /uninitialized/i;
5671 $have = MM->parse_version($parsefile) || "undef";
5672 $have =~ s/^ //; # since the %vd hack these two lines here are needed
5673 $have =~ s/ $//; # trailing whitespace happens all the time
5675 # My thoughts about why %vd processing should happen here
5677 # Alt1 maintain it as string with leading v:
5678 # read index files do nothing
5679 # compare it use utility for compare
5680 # print it do nothing
5682 # Alt2 maintain it as what it is
5683 # read index files convert
5684 # compare it use utility because there's still a ">" vs "gt" issue
5685 # print it use CPAN::Version for print
5687 # Seems cleaner to hold it in memory as a string starting with a "v"
5689 # If the author of this module made a mistake and wrote a quoted
5690 # "v1.13" instead of v1.13, we simply leave it at that with the
5691 # effect that *we* will treat it like a v-tring while the rest of
5692 # perl won't. Seems sensible when we consider that any action we
5693 # could take now would just add complexity.
5695 $have = CPAN::Version->readable($have);
5697 $have =~ s/\s*//g; # stringify to float around floating point issues
5698 $have; # no stringify needed, \s* above matches always
5701 package CPAN::Tarzip;
5703 # CPAN::Tarzip::gzip
5705 my($class,$read,$write) = @_;
5706 if ($CPAN::META->has_inst("Compress::Zlib")) {
5708 $fhw = FileHandle->new($read)
5709 or $CPAN::Frontend->mydie("Could not open $read: $!");
5710 my $gz = Compress::Zlib::gzopen($write, "wb")
5711 or $CPAN::Frontend->mydie("Cannot gzopen $write: $!\n");
5712 $gz->gzwrite($buffer)
5713 while read($fhw,$buffer,4096) > 0 ;
5718 system("$CPAN::Config->{gzip} -c $read > $write")==0;
5723 # CPAN::Tarzip::gunzip
5725 my($class,$read,$write) = @_;
5726 if ($CPAN::META->has_inst("Compress::Zlib")) {
5728 $fhw = FileHandle->new(">$write")
5729 or $CPAN::Frontend->mydie("Could not open >$write: $!");
5730 my $gz = Compress::Zlib::gzopen($read, "rb")
5731 or $CPAN::Frontend->mydie("Cannot gzopen $read: $!\n");
5732 $fhw->print($buffer)
5733 while $gz->gzread($buffer) > 0 ;
5734 $CPAN::Frontend->mydie("Error reading from $read: $!\n")
5735 if $gz->gzerror != Compress::Zlib::Z_STREAM_END();
5740 system("$CPAN::Config->{gzip} -dc $read > $write")==0;
5745 # CPAN::Tarzip::gtest
5747 my($class,$read) = @_;
5748 # After I had reread the documentation in zlib.h, I discovered that
5749 # uncompressed files do not lead to an gzerror (anymore?).
5750 if ( $CPAN::META->has_inst("Compress::Zlib") ) {
5753 my $gz = Compress::Zlib::gzopen($read, "rb")
5754 or $CPAN::Frontend->mydie(sprintf("Cannot gzopen %s: %s\n",
5756 $Compress::Zlib::gzerrno));
5757 while ($gz->gzread($buffer) > 0 ){
5758 $len += length($buffer);
5761 my $err = $gz->gzerror;
5762 my $success = ! $err || $err == Compress::Zlib::Z_STREAM_END();
5763 if ($len == -s $read){
5765 CPAN->debug("hit an uncompressed file") if $CPAN::DEBUG;
5768 CPAN->debug("err[$err]success[$success]") if $CPAN::DEBUG;
5771 return system("$CPAN::Config->{gzip} -dt $read")==0;
5776 # CPAN::Tarzip::TIEHANDLE
5778 my($class,$file) = @_;
5780 $class->debug("file[$file]");
5781 if ($CPAN::META->has_inst("Compress::Zlib")) {
5782 my $gz = Compress::Zlib::gzopen($file,"rb") or
5783 die "Could not gzopen $file";
5784 $ret = bless {GZ => $gz}, $class;
5786 my $pipe = "$CPAN::Config->{gzip} --decompress --stdout $file |";
5787 my $fh = FileHandle->new($pipe) or die "Could not pipe[$pipe]: $!";
5789 $ret = bless {FH => $fh}, $class;
5795 # CPAN::Tarzip::READLINE
5798 if (exists $self->{GZ}) {
5799 my $gz = $self->{GZ};
5800 my($line,$bytesread);
5801 $bytesread = $gz->gzreadline($line);
5802 return undef if $bytesread <= 0;
5805 my $fh = $self->{FH};
5806 return scalar <$fh>;
5811 # CPAN::Tarzip::READ
5813 my($self,$ref,$length,$offset) = @_;
5814 die "read with offset not implemented" if defined $offset;
5815 if (exists $self->{GZ}) {
5816 my $gz = $self->{GZ};
5817 my $byteread = $gz->gzread($$ref,$length);# 30eaf79e8b446ef52464b5422da328a8
5820 my $fh = $self->{FH};
5821 return read($fh,$$ref,$length);
5826 # CPAN::Tarzip::DESTROY
5829 if (exists $self->{GZ}) {
5830 my $gz = $self->{GZ};
5831 $gz->gzclose() if defined $gz; # hard to say if it is allowed
5832 # to be undef ever. AK, 2000-09
5834 my $fh = $self->{FH};
5835 $fh->close if defined $fh;
5841 # CPAN::Tarzip::untar
5843 my($class,$file) = @_;
5846 if (0) { # makes changing order easier
5847 } elsif ($BUGHUNTING){
5849 } elsif (MM->maybe_command($CPAN::Config->{gzip})
5851 MM->maybe_command($CPAN::Config->{'tar'})) {
5852 # should be default until Archive::Tar is fixed
5855 $CPAN::META->has_inst("Archive::Tar")
5857 $CPAN::META->has_inst("Compress::Zlib") ) {
5860 $CPAN::Frontend->mydie(qq{
5861 CPAN.pm needs either both external programs tar and gzip installed or
5862 both the modules Archive::Tar and Compress::Zlib. Neither prerequisite
5863 is available. Can\'t continue.
5866 if ($prefer==1) { # 1 => external gzip+tar
5868 my $is_compressed = $class->gtest($file);
5869 if ($is_compressed) {
5870 $system = "$CPAN::Config->{gzip} --decompress --stdout " .
5871 "< $file | $CPAN::Config->{tar} xvf -";
5873 $system = "$CPAN::Config->{tar} xvf $file";
5875 if (system($system) != 0) {
5876 # people find the most curious tar binaries that cannot handle
5878 if ($is_compressed) {
5879 (my $ungzf = $file) =~ s/\.gz(?!\n)\Z//;
5880 if (CPAN::Tarzip->gunzip($file, $ungzf)) {
5881 $CPAN::Frontend->myprint(qq{Uncompressed $file successfully\n});
5883 $CPAN::Frontend->mydie(qq{Couldn\'t uncompress $file\n});
5887 $system = "$CPAN::Config->{tar} xvf $file";
5888 $CPAN::Frontend->myprint(qq{Using Tar:$system:\n});
5889 if (system($system)==0) {
5890 $CPAN::Frontend->myprint(qq{Untarred $file successfully\n});
5892 $CPAN::Frontend->mydie(qq{Couldn\'t untar $file\n});
5898 } elsif ($prefer==2) { # 2 => modules
5899 my $tar = Archive::Tar->new($file,1);
5900 my $af; # archive file
5903 # RCS 1.337 had this code, it turned out unacceptable slow but
5904 # it revealed a bug in Archive::Tar. Code is only here to hunt
5905 # the bug again. It should never be enabled in published code.
5906 # GDGraph3d-0.53 was an interesting case according to Larry
5908 warn(">>>Bughunting code enabled<<< " x 20);
5909 for $af ($tar->list_files) {
5910 if ($af =~ m!^(/|\.\./)!) {
5911 $CPAN::Frontend->mydie("ALERT: Archive contains ".
5912 "illegal member [$af]");
5914 $CPAN::Frontend->myprint("$af\n");
5915 $tar->extract($af); # slow but effective for finding the bug
5916 return if $CPAN::Signal;
5919 for $af ($tar->list_files) {
5920 if ($af =~ m!^(/|\.\./)!) {
5921 $CPAN::Frontend->mydie("ALERT: Archive contains ".
5922 "illegal member [$af]");
5924 $CPAN::Frontend->myprint("$af\n");
5926 return if $CPAN::Signal;
5931 Mac::BuildTools::convert_files([$tar->list_files], 1)
5932 if ($^O eq 'MacOS');
5939 my($class,$file) = @_;
5940 if ($CPAN::META->has_inst("Archive::Zip")) {
5941 # blueprint of the code from Archive::Zip::Tree::extractTree();
5942 my $zip = Archive::Zip->new();
5944 $status = $zip->read($file);
5945 die "Read of file[$file] failed\n" if $status != Archive::Zip::AZ_OK();
5946 $CPAN::META->debug("Successfully read file[$file]") if $CPAN::DEBUG;
5947 my @members = $zip->members();
5948 for my $member ( @members ) {
5949 my $af = $member->fileName();
5950 if ($af =~ m!^(/|\.\./)!) {
5951 $CPAN::Frontend->mydie("ALERT: Archive contains ".
5952 "illegal member [$af]");
5954 my $status = $member->extractToFileNamed( $af );
5955 $CPAN::META->debug("af[$af]status[$status]") if $CPAN::DEBUG;
5956 die "Extracting of file[$af] from zipfile[$file] failed\n" if
5957 $status != Archive::Zip::AZ_OK();
5958 return if $CPAN::Signal;
5962 my $unzip = $CPAN::Config->{unzip} or
5963 $CPAN::Frontend->mydie("Cannot unzip, no unzip program available");
5964 my @system = ($unzip, $file);
5965 return system(@system) == 0;
5970 package CPAN::Version;
5971 # CPAN::Version::vcmp courtesy Jost Krieger
5973 my($self,$l,$r) = @_;
5975 CPAN->debug("l[$l] r[$r]") if $CPAN::DEBUG;
5977 return 0 if $l eq $r; # short circuit for quicker success
5979 if ($l=~/^v/ <=> $r=~/^v/) {
5982 $_ = $self->float2vv($_);
5987 ($l ne "undef") <=> ($r ne "undef") ||
5991 $self->vstring($l) cmp $self->vstring($r)) ||
5997 my($self,$l,$r) = @_;
5998 $self->vcmp($l,$r) > 0;
6003 $n =~ s/^v// or die "CPAN::Version::vstring() called with invalid arg [$n]";
6004 pack "U*", split /\./, $n;
6007 # vv => visible vstring
6012 my($mantissa) = $n =~ /\.(\d{1,12})/; # limit to 12 digits to limit
6013 # architecture influence
6015 $mantissa .= "0" while length($mantissa)%3;
6016 my $ret = "v" . $rev;
6018 $mantissa =~ s/(\d{1,3})// or
6019 die "Panic: length>0 but not a digit? mantissa[$mantissa]";
6020 $ret .= ".".int($1);
6022 # warn "n[$n]ret[$ret]";
6028 $n =~ /^([\w\-\+\.]+)/;
6030 return $1 if defined $1 && length($1)>0;
6031 # if the first user reaches version v43, he will be treated as "+".
6032 # We'll have to decide about a new rule here then, depending on what
6033 # will be the prevailing versioning behavior then.
6035 if ($] < 5.006) { # or whenever v-strings were introduced
6036 # we get them wrong anyway, whatever we do, because 5.005 will
6037 # have already interpreted 0.2.4 to be "0.24". So even if he
6038 # indexer sends us something like "v0.2.4" we compare wrongly.
6040 # And if they say v1.2, then the old perl takes it as "v12"
6042 $CPAN::Frontend->mywarn("Suspicious version string seen [$n]\n");
6045 my $better = sprintf "v%vd", $n;
6046 CPAN->debug("n[$n] better[$better]") if $CPAN::DEBUG;
6058 CPAN - query, download and build perl modules from CPAN sites
6064 perl -MCPAN -e shell;
6070 autobundle, clean, install, make, recompile, test
6074 This module will eventually be replaced by CPANPLUS. CPANPLUS is kind
6075 of a modern rewrite from ground up with greater extensibility and more
6076 features but no full compatibility. If you're new to CPAN.pm, you
6077 probably should investigate if CPANPLUS is the better choice for you.
6078 If you're already used to CPAN.pm you're welcome to continue using it,
6079 if you accept that its development is mostly (though not completely)
6084 The CPAN module is designed to automate the make and install of perl
6085 modules and extensions. It includes some primitive searching capabilities and
6086 knows how to use Net::FTP or LWP (or lynx or an external ftp client)
6087 to fetch the raw data from the net.
6089 Modules are fetched from one or more of the mirrored CPAN
6090 (Comprehensive Perl Archive Network) sites and unpacked in a dedicated
6093 The CPAN module also supports the concept of named and versioned
6094 I<bundles> of modules. Bundles simplify the handling of sets of
6095 related modules. See Bundles below.
6097 The package contains a session manager and a cache manager. There is
6098 no status retained between sessions. The session manager keeps track
6099 of what has been fetched, built and installed in the current
6100 session. The cache manager keeps track of the disk space occupied by
6101 the make processes and deletes excess space according to a simple FIFO
6104 For extended searching capabilities there's a plugin for CPAN available,
6105 L<C<CPAN::WAIT>|CPAN::WAIT>. C<CPAN::WAIT> is a full-text search engine
6106 that indexes all documents available in CPAN authors directories. If
6107 C<CPAN::WAIT> is installed on your system, the interactive shell of
6108 CPAN.pm will enable the C<wq>, C<wr>, C<wd>, C<wl>, and C<wh> commands
6109 which send queries to the WAIT server that has been configured for your
6112 All other methods provided are accessible in a programmer style and in an
6113 interactive shell style.
6115 =head2 Interactive Mode
6117 The interactive mode is entered by running
6119 perl -MCPAN -e shell
6121 which puts you into a readline interface. You will have the most fun if
6122 you install Term::ReadKey and Term::ReadLine to enjoy both history and
6125 Once you are on the command line, type 'h' and the rest should be
6128 The function call C<shell> takes two optional arguments, one is the
6129 prompt, the second is the default initial command line (the latter
6130 only works if a real ReadLine interface module is installed).
6132 The most common uses of the interactive modes are
6136 =item Searching for authors, bundles, distribution files and modules
6138 There are corresponding one-letter commands C<a>, C<b>, C<d>, and C<m>
6139 for each of the four categories and another, C<i> for any of the
6140 mentioned four. Each of the four entities is implemented as a class
6141 with slightly differing methods for displaying an object.
6143 Arguments you pass to these commands are either strings exactly matching
6144 the identification string of an object or regular expressions that are
6145 then matched case-insensitively against various attributes of the
6146 objects. The parser recognizes a regular expression only if you
6147 enclose it between two slashes.
6149 The principle is that the number of found objects influences how an
6150 item is displayed. If the search finds one item, the result is
6151 displayed with the rather verbose method C<as_string>, but if we find
6152 more than one, we display each object with the terse method
6155 =item make, test, install, clean modules or distributions
6157 These commands take any number of arguments and investigate what is
6158 necessary to perform the action. If the argument is a distribution
6159 file name (recognized by embedded slashes), it is processed. If it is
6160 a module, CPAN determines the distribution file in which this module
6161 is included and processes that, following any dependencies named in
6162 the module's Makefile.PL (this behavior is controlled by
6163 I<prerequisites_policy>.)
6165 Any C<make> or C<test> are run unconditionally. An
6167 install <distribution_file>
6169 also is run unconditionally. But for
6173 CPAN checks if an install is actually needed for it and prints
6174 I<module up to date> in the case that the distribution file containing
6175 the module doesn't need to be updated.
6177 CPAN also keeps track of what it has done within the current session
6178 and doesn't try to build a package a second time regardless if it
6179 succeeded or not. The C<force> command takes as a first argument the
6180 method to invoke (currently: C<make>, C<test>, or C<install>) and executes the
6181 command from scratch.
6185 cpan> install OpenGL
6186 OpenGL is up to date.
6187 cpan> force install OpenGL
6190 OpenGL-0.4/COPYRIGHT
6193 A C<clean> command results in a
6197 being executed within the distribution file's working directory.
6199 =item get, readme, look module or distribution
6201 C<get> downloads a distribution file without further action. C<readme>
6202 displays the README file of the associated distribution. C<Look> gets
6203 and untars (if not yet done) the distribution file, changes to the
6204 appropriate directory and opens a subshell process in that directory.
6208 C<ls> lists all distribution files in and below an author's CPAN
6209 directory. Only those files that contain modules are listed and if
6210 there is more than one for any given module, only the most recent one
6215 CPAN.pm installs signal handlers for SIGINT and SIGTERM. While you are
6216 in the cpan-shell it is intended that you can press C<^C> anytime and
6217 return to the cpan-shell prompt. A SIGTERM will cause the cpan-shell
6218 to clean up and leave the shell loop. You can emulate the effect of a
6219 SIGTERM by sending two consecutive SIGINTs, which usually means by
6220 pressing C<^C> twice.
6222 CPAN.pm ignores a SIGPIPE. If the user sets inactivity_timeout, a
6223 SIGALRM is used during the run of the C<perl Makefile.PL> subprocess.
6229 The commands that are available in the shell interface are methods in
6230 the package CPAN::Shell. If you enter the shell command, all your
6231 input is split by the Text::ParseWords::shellwords() routine which
6232 acts like most shells do. The first word is being interpreted as the
6233 method to be called and the rest of the words are treated as arguments
6234 to this method. Continuation lines are supported if a line ends with a
6239 C<autobundle> writes a bundle file into the
6240 C<$CPAN::Config-E<gt>{cpan_home}/Bundle> directory. The file contains
6241 a list of all modules that are both available from CPAN and currently
6242 installed within @INC. The name of the bundle file is based on the
6243 current date and a counter.
6247 recompile() is a very special command in that it takes no argument and
6248 runs the make/test/install cycle with brute force over all installed
6249 dynamically loadable extensions (aka XS modules) with 'force' in
6250 effect. The primary purpose of this command is to finish a network
6251 installation. Imagine, you have a common source tree for two different
6252 architectures. You decide to do a completely independent fresh
6253 installation. You start on one architecture with the help of a Bundle
6254 file produced earlier. CPAN installs the whole Bundle for you, but
6255 when you try to repeat the job on the second architecture, CPAN
6256 responds with a C<"Foo up to date"> message for all modules. So you
6257 invoke CPAN's recompile on the second architecture and you're done.
6259 Another popular use for C<recompile> is to act as a rescue in case your
6260 perl breaks binary compatibility. If one of the modules that CPAN uses
6261 is in turn depending on binary compatibility (so you cannot run CPAN
6262 commands), then you should try the CPAN::Nox module for recovery.
6264 =head2 The four C<CPAN::*> Classes: Author, Bundle, Module, Distribution
6266 Although it may be considered internal, the class hierarchy does matter
6267 for both users and programmer. CPAN.pm deals with above mentioned four
6268 classes, and all those classes share a set of methods. A classical
6269 single polymorphism is in effect. A metaclass object registers all
6270 objects of all kinds and indexes them with a string. The strings
6271 referencing objects have a separated namespace (well, not completely
6276 words containing a "/" (slash) Distribution
6277 words starting with Bundle:: Bundle
6278 everything else Module or Author
6280 Modules know their associated Distribution objects. They always refer
6281 to the most recent official release. Developers may mark their releases
6282 as unstable development versions (by inserting an underbar into the
6283 module version number which will also be reflected in the distribution
6284 name when you run 'make dist'), so the really hottest and newest
6285 distribution is not always the default. If a module Foo circulates
6286 on CPAN in both version 1.23 and 1.23_90, CPAN.pm offers a convenient
6287 way to install version 1.23 by saying
6291 This would install the complete distribution file (say
6292 BAR/Foo-1.23.tar.gz) with all accompanying material. But if you would
6293 like to install version 1.23_90, you need to know where the
6294 distribution file resides on CPAN relative to the authors/id/
6295 directory. If the author is BAR, this might be BAR/Foo-1.23_90.tar.gz;
6296 so you would have to say
6298 install BAR/Foo-1.23_90.tar.gz
6300 The first example will be driven by an object of the class
6301 CPAN::Module, the second by an object of class CPAN::Distribution.
6303 =head2 Programmer's interface
6305 If you do not enter the shell, the available shell commands are both
6306 available as methods (C<CPAN::Shell-E<gt>install(...)>) and as
6307 functions in the calling package (C<install(...)>).
6309 There's currently only one class that has a stable interface -
6310 CPAN::Shell. All commands that are available in the CPAN shell are
6311 methods of the class CPAN::Shell. Each of the commands that produce
6312 listings of modules (C<r>, C<autobundle>, C<u>) also return a list of
6313 the IDs of all modules within the list.
6317 =item expand($type,@things)
6319 The IDs of all objects available within a program are strings that can
6320 be expanded to the corresponding real objects with the
6321 C<CPAN::Shell-E<gt>expand("Module",@things)> method. Expand returns a
6322 list of CPAN::Module objects according to the C<@things> arguments
6323 given. In scalar context it only returns the first element of the
6326 =item expandany(@things)
6328 Like expand, but returns objects of the appropriate type, i.e.
6329 CPAN::Bundle objects for bundles, CPAN::Module objects for modules and
6330 CPAN::Distribution objects fro distributions.
6332 =item Programming Examples
6334 This enables the programmer to do operations that combine
6335 functionalities that are available in the shell.
6337 # install everything that is outdated on my disk:
6338 perl -MCPAN -e 'CPAN::Shell->install(CPAN::Shell->r)'
6340 # install my favorite programs if necessary:
6341 for $mod (qw(Net::FTP Digest::MD5 Data::Dumper)){
6342 my $obj = CPAN::Shell->expand('Module',$mod);
6346 # list all modules on my disk that have no VERSION number
6347 for $mod (CPAN::Shell->expand("Module","/./")){
6348 next unless $mod->inst_file;
6349 # MakeMaker convention for undefined $VERSION:
6350 next unless $mod->inst_version eq "undef";
6351 print "No VERSION in ", $mod->id, "\n";
6354 # find out which distribution on CPAN contains a module:
6355 print CPAN::Shell->expand("Module","Apache::Constants")->cpan_file
6357 Or if you want to write a cronjob to watch The CPAN, you could list
6358 all modules that need updating. First a quick and dirty way:
6360 perl -e 'use CPAN; CPAN::Shell->r;'
6362 If you don't want to get any output in the case that all modules are
6363 up to date, you can parse the output of above command for the regular
6364 expression //modules are up to date// and decide to mail the output
6365 only if it doesn't match. Ick?
6367 If you prefer to do it more in a programmer style in one single
6368 process, maybe something like this suits you better:
6370 # list all modules on my disk that have newer versions on CPAN
6371 for $mod (CPAN::Shell->expand("Module","/./")){
6372 next unless $mod->inst_file;
6373 next if $mod->uptodate;
6374 printf "Module %s is installed as %s, could be updated to %s from CPAN\n",
6375 $mod->id, $mod->inst_version, $mod->cpan_version;
6378 If that gives you too much output every day, you maybe only want to
6379 watch for three modules. You can write
6381 for $mod (CPAN::Shell->expand("Module","/Apache|LWP|CGI/")){
6383 as the first line instead. Or you can combine some of the above
6386 # watch only for a new mod_perl module
6387 $mod = CPAN::Shell->expand("Module","mod_perl");
6388 exit if $mod->uptodate;
6389 # new mod_perl arrived, let me know all update recommendations
6394 =head2 Methods in the other Classes
6396 The programming interface for the classes CPAN::Module,
6397 CPAN::Distribution, CPAN::Bundle, and CPAN::Author is still considered
6398 beta and partially even alpha. In the following paragraphs only those
6399 methods are documented that have proven useful over a longer time and
6400 thus are unlikely to change.
6404 =item CPAN::Author::as_glimpse()
6406 Returns a one-line description of the author
6408 =item CPAN::Author::as_string()
6410 Returns a multi-line description of the author
6412 =item CPAN::Author::email()
6414 Returns the author's email address
6416 =item CPAN::Author::fullname()
6418 Returns the author's name
6420 =item CPAN::Author::name()
6422 An alias for fullname
6424 =item CPAN::Bundle::as_glimpse()
6426 Returns a one-line description of the bundle
6428 =item CPAN::Bundle::as_string()
6430 Returns a multi-line description of the bundle
6432 =item CPAN::Bundle::clean()
6434 Recursively runs the C<clean> method on all items contained in the bundle.
6436 =item CPAN::Bundle::contains()
6438 Returns a list of objects' IDs contained in a bundle. The associated
6439 objects may be bundles, modules or distributions.
6441 =item CPAN::Bundle::force($method,@args)
6443 Forces CPAN to perform a task that normally would have failed. Force
6444 takes as arguments a method name to be called and any number of
6445 additional arguments that should be passed to the called method. The
6446 internals of the object get the needed changes so that CPAN.pm does
6447 not refuse to take the action. The C<force> is passed recursively to
6448 all contained objects.
6450 =item CPAN::Bundle::get()
6452 Recursively runs the C<get> method on all items contained in the bundle
6454 =item CPAN::Bundle::inst_file()
6456 Returns the highest installed version of the bundle in either @INC or
6457 C<$CPAN::Config->{cpan_home}>. Note that this is different from
6458 CPAN::Module::inst_file.
6460 =item CPAN::Bundle::inst_version()
6462 Like CPAN::Bundle::inst_file, but returns the $VERSION
6464 =item CPAN::Bundle::uptodate()
6466 Returns 1 if the bundle itself and all its members are uptodate.
6468 =item CPAN::Bundle::install()
6470 Recursively runs the C<install> method on all items contained in the bundle
6472 =item CPAN::Bundle::make()
6474 Recursively runs the C<make> method on all items contained in the bundle
6476 =item CPAN::Bundle::readme()
6478 Recursively runs the C<readme> method on all items contained in the bundle
6480 =item CPAN::Bundle::test()
6482 Recursively runs the C<test> method on all items contained in the bundle
6484 =item CPAN::Distribution::as_glimpse()
6486 Returns a one-line description of the distribution
6488 =item CPAN::Distribution::as_string()
6490 Returns a multi-line description of the distribution
6492 =item CPAN::Distribution::clean()
6494 Changes to the directory where the distribution has been unpacked and
6495 runs C<make clean> there.
6497 =item CPAN::Distribution::containsmods()
6499 Returns a list of IDs of modules contained in a distribution file.
6500 Only works for distributions listed in the 02packages.details.txt.gz
6501 file. This typically means that only the most recent version of a
6502 distribution is covered.
6504 =item CPAN::Distribution::cvs_import()
6506 Changes to the directory where the distribution has been unpacked and
6509 cvs -d $cvs_root import -m $cvs_log $cvs_dir $userid v$version
6513 =item CPAN::Distribution::dir()
6515 Returns the directory into which this distribution has been unpacked.
6517 =item CPAN::Distribution::force($method,@args)
6519 Forces CPAN to perform a task that normally would have failed. Force
6520 takes as arguments a method name to be called and any number of
6521 additional arguments that should be passed to the called method. The
6522 internals of the object get the needed changes so that CPAN.pm does
6523 not refuse to take the action.
6525 =item CPAN::Distribution::get()
6527 Downloads the distribution from CPAN and unpacks it. Does nothing if
6528 the distribution has already been downloaded and unpacked within the
6531 =item CPAN::Distribution::install()
6533 Changes to the directory where the distribution has been unpacked and
6534 runs the external command C<make install> there. If C<make> has not
6535 yet been run, it will be run first. A C<make test> will be issued in
6536 any case and if this fails, the install will be canceled. The
6537 cancellation can be avoided by letting C<force> run the C<install> for
6540 =item CPAN::Distribution::isa_perl()
6542 Returns 1 if this distribution file seems to be a perl distribution.
6543 Normally this is derived from the file name only, but the index from
6544 CPAN can contain a hint to achieve a return value of true for other
6547 =item CPAN::Distribution::look()
6549 Changes to the directory where the distribution has been unpacked and
6550 opens a subshell there. Exiting the subshell returns.
6552 =item CPAN::Distribution::make()
6554 First runs the C<get> method to make sure the distribution is
6555 downloaded and unpacked. Changes to the directory where the
6556 distribution has been unpacked and runs the external commands C<perl
6557 Makefile.PL> and C<make> there.
6559 =item CPAN::Distribution::prereq_pm()
6561 Returns the hash reference that has been announced by a distribution
6562 as the PREREQ_PM hash in the Makefile.PL. Note: works only after an
6563 attempt has been made to C<make> the distribution. Returns undef
6566 =item CPAN::Distribution::readme()
6568 Downloads the README file associated with a distribution and runs it
6569 through the pager specified in C<$CPAN::Config->{pager}>.
6571 =item CPAN::Distribution::test()
6573 Changes to the directory where the distribution has been unpacked and
6574 runs C<make test> there.
6576 =item CPAN::Distribution::uptodate()
6578 Returns 1 if all the modules contained in the distribution are
6579 uptodate. Relies on containsmods.
6581 =item CPAN::Index::force_reload()
6583 Forces a reload of all indices.
6585 =item CPAN::Index::reload()
6587 Reloads all indices if they have been read more than
6588 C<$CPAN::Config->{index_expire}> days.
6590 =item CPAN::InfoObj::dump()
6592 CPAN::Author, CPAN::Bundle, CPAN::Module, and CPAN::Distribution
6593 inherit this method. It prints the data structure associated with an
6594 object. Useful for debugging. Note: the data structure is considered
6595 internal and thus subject to change without notice.
6597 =item CPAN::Module::as_glimpse()
6599 Returns a one-line description of the module
6601 =item CPAN::Module::as_string()
6603 Returns a multi-line description of the module
6605 =item CPAN::Module::clean()
6607 Runs a clean on the distribution associated with this module.
6609 =item CPAN::Module::cpan_file()
6611 Returns the filename on CPAN that is associated with the module.
6613 =item CPAN::Module::cpan_version()
6615 Returns the latest version of this module available on CPAN.
6617 =item CPAN::Module::cvs_import()
6619 Runs a cvs_import on the distribution associated with this module.
6621 =item CPAN::Module::description()
6623 Returns a 44 character description of this module. Only available for
6624 modules listed in The Module List (CPAN/modules/00modlist.long.html
6625 or 00modlist.long.txt.gz)
6627 =item CPAN::Module::force($method,@args)
6629 Forces CPAN to perform a task that normally would have failed. Force
6630 takes as arguments a method name to be called and any number of
6631 additional arguments that should be passed to the called method. The
6632 internals of the object get the needed changes so that CPAN.pm does
6633 not refuse to take the action.
6635 =item CPAN::Module::get()
6637 Runs a get on the distribution associated with this module.
6639 =item CPAN::Module::inst_file()
6641 Returns the filename of the module found in @INC. The first file found
6642 is reported just like perl itself stops searching @INC when it finds a
6645 =item CPAN::Module::inst_version()
6647 Returns the version number of the module in readable format.
6649 =item CPAN::Module::install()
6651 Runs an C<install> on the distribution associated with this module.
6653 =item CPAN::Module::look()
6655 Changes to the directory where the distribution associated with this
6656 module has been unpacked and opens a subshell there. Exiting the
6659 =item CPAN::Module::make()
6661 Runs a C<make> on the distribution associated with this module.
6663 =item CPAN::Module::manpage_headline()
6665 If module is installed, peeks into the module's manpage, reads the
6666 headline and returns it. Moreover, if the module has been downloaded
6667 within this session, does the equivalent on the downloaded module even
6668 if it is not installed.
6670 =item CPAN::Module::readme()
6672 Runs a C<readme> on the distribution associated with this module.
6674 =item CPAN::Module::test()
6676 Runs a C<test> on the distribution associated with this module.
6678 =item CPAN::Module::uptodate()
6680 Returns 1 if the module is installed and up-to-date.
6682 =item CPAN::Module::userid()
6684 Returns the author's ID of the module.
6688 =head2 Cache Manager
6690 Currently the cache manager only keeps track of the build directory
6691 ($CPAN::Config->{build_dir}). It is a simple FIFO mechanism that
6692 deletes complete directories below C<build_dir> as soon as the size of
6693 all directories there gets bigger than $CPAN::Config->{build_cache}
6694 (in MB). The contents of this cache may be used for later
6695 re-installations that you intend to do manually, but will never be
6696 trusted by CPAN itself. This is due to the fact that the user might
6697 use these directories for building modules on different architectures.
6699 There is another directory ($CPAN::Config->{keep_source_where}) where
6700 the original distribution files are kept. This directory is not
6701 covered by the cache manager and must be controlled by the user. If
6702 you choose to have the same directory as build_dir and as
6703 keep_source_where directory, then your sources will be deleted with
6704 the same fifo mechanism.
6708 A bundle is just a perl module in the namespace Bundle:: that does not
6709 define any functions or methods. It usually only contains documentation.
6711 It starts like a perl module with a package declaration and a $VERSION
6712 variable. After that the pod section looks like any other pod with the
6713 only difference being that I<one special pod section> exists starting with
6718 In this pod section each line obeys the format
6720 Module_Name [Version_String] [- optional text]
6722 The only required part is the first field, the name of a module
6723 (e.g. Foo::Bar, ie. I<not> the name of the distribution file). The rest
6724 of the line is optional. The comment part is delimited by a dash just
6725 as in the man page header.
6727 The distribution of a bundle should follow the same convention as
6728 other distributions.
6730 Bundles are treated specially in the CPAN package. If you say 'install
6731 Bundle::Tkkit' (assuming such a bundle exists), CPAN will install all
6732 the modules in the CONTENTS section of the pod. You can install your
6733 own Bundles locally by placing a conformant Bundle file somewhere into
6734 your @INC path. The autobundle() command which is available in the
6735 shell interface does that for you by including all currently installed
6736 modules in a snapshot bundle file.
6738 =head2 Prerequisites
6740 If you have a local mirror of CPAN and can access all files with
6741 "file:" URLs, then you only need a perl better than perl5.003 to run
6742 this module. Otherwise Net::FTP is strongly recommended. LWP may be
6743 required for non-UNIX systems or if your nearest CPAN site is
6744 associated with a URL that is not C<ftp:>.
6746 If you have neither Net::FTP nor LWP, there is a fallback mechanism
6747 implemented for an external ftp command or for an external lynx
6750 =head2 Finding packages and VERSION
6752 This module presumes that all packages on CPAN
6758 declare their $VERSION variable in an easy to parse manner. This
6759 prerequisite can hardly be relaxed because it consumes far too much
6760 memory to load all packages into the running program just to determine
6761 the $VERSION variable. Currently all programs that are dealing with
6762 version use something like this
6764 perl -MExtUtils::MakeMaker -le \
6765 'print MM->parse_version(shift)' filename
6767 If you are author of a package and wonder if your $VERSION can be
6768 parsed, please try the above method.
6772 come as compressed or gzipped tarfiles or as zip files and contain a
6773 Makefile.PL (well, we try to handle a bit more, but without much
6780 The debugging of this module is a bit complex, because we have
6781 interferences of the software producing the indices on CPAN, of the
6782 mirroring process on CPAN, of packaging, of configuration, of
6783 synchronicity, and of bugs within CPAN.pm.
6785 For code debugging in interactive mode you can try "o debug" which
6786 will list options for debugging the various parts of the code. You
6787 should know that "o debug" has built-in completion support.
6789 For data debugging there is the C<dump> command which takes the same
6790 arguments as make/test/install and outputs the object's Data::Dumper
6793 =head2 Floppy, Zip, Offline Mode
6795 CPAN.pm works nicely without network too. If you maintain machines
6796 that are not networked at all, you should consider working with file:
6797 URLs. Of course, you have to collect your modules somewhere first. So
6798 you might use CPAN.pm to put together all you need on a networked
6799 machine. Then copy the $CPAN::Config->{keep_source_where} (but not
6800 $CPAN::Config->{build_dir}) directory on a floppy. This floppy is kind
6801 of a personal CPAN. CPAN.pm on the non-networked machines works nicely
6802 with this floppy. See also below the paragraph about CD-ROM support.
6804 =head1 CONFIGURATION
6806 When the CPAN module is used for the first time, a configuration
6807 dialog tries to determine a couple of site specific options. The
6808 result of the dialog is stored in a hash reference C< $CPAN::Config >
6809 in a file CPAN/Config.pm.
6811 The default values defined in the CPAN/Config.pm file can be
6812 overridden in a user specific file: CPAN/MyConfig.pm. Such a file is
6813 best placed in $HOME/.cpan/CPAN/MyConfig.pm, because $HOME/.cpan is
6814 added to the search path of the CPAN module before the use() or
6815 require() statements.
6817 The configuration dialog can be started any time later again by
6818 issueing the command C< o conf init > in the CPAN shell.
6820 Currently the following keys in the hash reference $CPAN::Config are
6823 build_cache size of cache for directories to build modules
6824 build_dir locally accessible directory to build modules
6825 index_expire after this many days refetch index files
6826 cache_metadata use serializer to cache metadata
6827 cpan_home local directory reserved for this package
6828 dontload_hash anonymous hash: modules in the keys will not be
6829 loaded by the CPAN::has_inst() routine
6830 gzip location of external program gzip
6831 histfile file to maintain history between sessions
6832 histsize maximum number of lines to keep in histfile
6833 inactivity_timeout breaks interactive Makefile.PLs after this
6834 many seconds inactivity. Set to 0 to never break.
6835 inhibit_startup_message
6836 if true, does not print the startup message
6837 keep_source_where directory in which to keep the source (if we do)
6838 make location of external make program
6839 make_arg arguments that should always be passed to 'make'
6840 make_install_arg same as make_arg for 'make install'
6841 makepl_arg arguments passed to 'perl Makefile.PL'
6842 pager location of external program more (or any pager)
6843 prerequisites_policy
6844 what to do if you are missing module prerequisites
6845 ('follow' automatically, 'ask' me, or 'ignore')
6846 proxy_user username for accessing an authenticating proxy
6847 proxy_pass password for accessing an authenticating proxy
6848 scan_cache controls scanning of cache ('atstart' or 'never')
6849 tar location of external program tar
6850 term_is_latin if true internal UTF-8 is translated to ISO-8859-1
6851 (and nonsense for characters outside latin range)
6852 unzip location of external program unzip
6853 urllist arrayref to nearby CPAN sites (or equivalent locations)
6854 wait_list arrayref to a wait server to try (See CPAN::WAIT)
6855 ftp_proxy, } the three usual variables for configuring
6856 http_proxy, } proxy requests. Both as CPAN::Config variables
6857 no_proxy } and as environment variables configurable.
6859 You can set and query each of these options interactively in the cpan
6860 shell with the command set defined within the C<o conf> command:
6864 =item C<o conf E<lt>scalar optionE<gt>>
6866 prints the current value of the I<scalar option>
6868 =item C<o conf E<lt>scalar optionE<gt> E<lt>valueE<gt>>
6870 Sets the value of the I<scalar option> to I<value>
6872 =item C<o conf E<lt>list optionE<gt>>
6874 prints the current value of the I<list option> in MakeMaker's
6877 =item C<o conf E<lt>list optionE<gt> [shift|pop]>
6879 shifts or pops the array in the I<list option> variable
6881 =item C<o conf E<lt>list optionE<gt> [unshift|push|splice] E<lt>listE<gt>>
6883 works like the corresponding perl commands.
6887 =head2 Note on urllist parameter's format
6889 urllist parameters are URLs according to RFC 1738. We do a little
6890 guessing if your URL is not compliant, but if you have problems with
6891 file URLs, please try the correct format. Either:
6893 file://localhost/whatever/ftp/pub/CPAN/
6897 file:///home/ftp/pub/CPAN/
6899 =head2 urllist parameter has CD-ROM support
6901 The C<urllist> parameter of the configuration table contains a list of
6902 URLs that are to be used for downloading. If the list contains any
6903 C<file> URLs, CPAN always tries to get files from there first. This
6904 feature is disabled for index files. So the recommendation for the
6905 owner of a CD-ROM with CPAN contents is: include your local, possibly
6906 outdated CD-ROM as a C<file> URL at the end of urllist, e.g.
6908 o conf urllist push file://localhost/CDROM/CPAN
6910 CPAN.pm will then fetch the index files from one of the CPAN sites
6911 that come at the beginning of urllist. It will later check for each
6912 module if there is a local copy of the most recent version.
6914 Another peculiarity of urllist is that the site that we could
6915 successfully fetch the last file from automatically gets a preference
6916 token and is tried as the first site for the next request. So if you
6917 add a new site at runtime it may happen that the previously preferred
6918 site will be tried another time. This means that if you want to disallow
6919 a site for the next transfer, it must be explicitly removed from
6924 There's no strong security layer in CPAN.pm. CPAN.pm helps you to
6925 install foreign, unmasked, unsigned code on your machine. We compare
6926 to a checksum that comes from the net just as the distribution file
6927 itself. If somebody has managed to tamper with the distribution file,
6928 they may have as well tampered with the CHECKSUMS file. Future
6929 development will go towards strong authentication.
6933 Most functions in package CPAN are exported per default. The reason
6934 for this is that the primary use is intended for the cpan shell or for
6937 =head1 POPULATE AN INSTALLATION WITH LOTS OF MODULES
6939 Populating a freshly installed perl with my favorite modules is pretty
6940 easy if you maintain a private bundle definition file. To get a useful
6941 blueprint of a bundle definition file, the command autobundle can be used
6942 on the CPAN shell command line. This command writes a bundle definition
6943 file for all modules that are installed for the currently running perl
6944 interpreter. It's recommended to run this command only once and from then
6945 on maintain the file manually under a private name, say
6946 Bundle/my_bundle.pm. With a clever bundle file you can then simply say
6948 cpan> install Bundle::my_bundle
6950 then answer a few questions and then go out for a coffee.
6952 Maintaining a bundle definition file means keeping track of two
6953 things: dependencies and interactivity. CPAN.pm sometimes fails on
6954 calculating dependencies because not all modules define all MakeMaker
6955 attributes correctly, so a bundle definition file should specify
6956 prerequisites as early as possible. On the other hand, it's a bit
6957 annoying that many distributions need some interactive configuring. So
6958 what I try to accomplish in my private bundle file is to have the
6959 packages that need to be configured early in the file and the gentle
6960 ones later, so I can go out after a few minutes and leave CPAN.pm
6963 =head1 WORKING WITH CPAN.pm BEHIND FIREWALLS
6965 Thanks to Graham Barr for contributing the following paragraphs about
6966 the interaction between perl, and various firewall configurations. For
6967 further informations on firewalls, it is recommended to consult the
6968 documentation that comes with the ncftp program. If you are unable to
6969 go through the firewall with a simple Perl setup, it is very likely
6970 that you can configure ncftp so that it works for your firewall.
6972 =head2 Three basic types of firewalls
6974 Firewalls can be categorized into three basic types.
6980 This is where the firewall machine runs a web server and to access the
6981 outside world you must do it via the web server. If you set environment
6982 variables like http_proxy or ftp_proxy to a values beginning with http://
6983 or in your web browser you have to set proxy information then you know
6984 you are running an http firewall.
6986 To access servers outside these types of firewalls with perl (even for
6987 ftp) you will need to use LWP.
6991 This where the firewall machine runs an ftp server. This kind of
6992 firewall will only let you access ftp servers outside the firewall.
6993 This is usually done by connecting to the firewall with ftp, then
6994 entering a username like "user@outside.host.com"
6996 To access servers outside these type of firewalls with perl you
6997 will need to use Net::FTP.
6999 =item One way visibility
7001 I say one way visibility as these firewalls try to make themselves look
7002 invisible to the users inside the firewall. An FTP data connection is
7003 normally created by sending the remote server your IP address and then
7004 listening for the connection. But the remote server will not be able to
7005 connect to you because of the firewall. So for these types of firewall
7006 FTP connections need to be done in a passive mode.
7008 There are two that I can think off.
7014 If you are using a SOCKS firewall you will need to compile perl and link
7015 it with the SOCKS library, this is what is normally called a 'socksified'
7016 perl. With this executable you will be able to connect to servers outside
7017 the firewall as if it is not there.
7021 This is the firewall implemented in the Linux kernel, it allows you to
7022 hide a complete network behind one IP address. With this firewall no
7023 special compiling is needed as you can access hosts directly.
7025 For accessing ftp servers behind such firewalls you may need to set
7026 the environment variable C<FTP_PASSIVE> to a true value, e.g.
7028 env FTP_PASSIVE=1 perl -MCPAN -eshell
7032 perl -MCPAN -e '$ENV{FTP_PASSIVE} = 1; shell'
7039 =head2 Configuring lynx or ncftp for going through a firewall
7041 If you can go through your firewall with e.g. lynx, presumably with a
7044 /usr/local/bin/lynx -pscott:tiger
7046 then you would configure CPAN.pm with the command
7048 o conf lynx "/usr/local/bin/lynx -pscott:tiger"
7050 That's all. Similarly for ncftp or ftp, you would configure something
7053 o conf ncftp "/usr/bin/ncftp -f /home/scott/ncftplogin.cfg"
7055 Your mileage may vary...
7063 I installed a new version of module X but CPAN keeps saying,
7064 I have the old version installed
7066 Most probably you B<do> have the old version installed. This can
7067 happen if a module installs itself into a different directory in the
7068 @INC path than it was previously installed. This is not really a
7069 CPAN.pm problem, you would have the same problem when installing the
7070 module manually. The easiest way to prevent this behaviour is to add
7071 the argument C<UNINST=1> to the C<make install> call, and that is why
7072 many people add this argument permanently by configuring
7074 o conf make_install_arg UNINST=1
7078 So why is UNINST=1 not the default?
7080 Because there are people who have their precise expectations about who
7081 may install where in the @INC path and who uses which @INC array. In
7082 fine tuned environments C<UNINST=1> can cause damage.
7086 I want to clean up my mess, and install a new perl along with
7087 all modules I have. How do I go about it?
7089 Run the autobundle command for your old perl and optionally rename the
7090 resulting bundle file (e.g. Bundle/mybundle.pm), install the new perl
7091 with the Configure option prefix, e.g.
7093 ./Configure -Dprefix=/usr/local/perl-5.6.78.9
7095 Install the bundle file you produced in the first step with something like
7097 cpan> install Bundle::mybundle
7103 When I install bundles or multiple modules with one command
7104 there is too much output to keep track of.
7106 You may want to configure something like
7108 o conf make_arg "| tee -ai /root/.cpan/logs/make.out"
7109 o conf make_install_arg "| tee -ai /root/.cpan/logs/make_install.out"
7111 so that STDOUT is captured in a file for later inspection.
7116 I am not root, how can I install a module in a personal directory?
7118 You will most probably like something like this:
7120 o conf makepl_arg "LIB=~/myperl/lib \
7121 INSTALLMAN1DIR=~/myperl/man/man1 \
7122 INSTALLMAN3DIR=~/myperl/man/man3"
7123 install Sybase::Sybperl
7125 You can make this setting permanent like all C<o conf> settings with
7128 You will have to add ~/myperl/man to the MANPATH environment variable
7129 and also tell your perl programs to look into ~/myperl/lib, e.g. by
7132 use lib "$ENV{HOME}/myperl/lib";
7134 or setting the PERL5LIB environment variable.
7136 Another thing you should bear in mind is that the UNINST parameter
7137 should never be set if you are not root.
7141 How to get a package, unwrap it, and make a change before building it?
7143 look Sybase::Sybperl
7147 I installed a Bundle and had a couple of fails. When I
7148 retried, everything resolved nicely. Can this be fixed to work
7151 The reason for this is that CPAN does not know the dependencies of all
7152 modules when it starts out. To decide about the additional items to
7153 install, it just uses data found in the generated Makefile. An
7154 undetected missing piece breaks the process. But it may well be that
7155 your Bundle installs some prerequisite later than some depending item
7156 and thus your second try is able to resolve everything. Please note,
7157 CPAN.pm does not know the dependency tree in advance and cannot sort
7158 the queue of things to install in a topologically correct order. It
7159 resolves perfectly well IFF all modules declare the prerequisites
7160 correctly with the PREREQ_PM attribute to MakeMaker. For bundles which
7161 fail and you need to install often, it is recommended sort the Bundle
7162 definition file manually. It is planned to improve the metadata
7163 situation for dependencies on CPAN in general, but this will still
7168 In our intranet we have many modules for internal use. How
7169 can I integrate these modules with CPAN.pm but without uploading
7170 the modules to CPAN?
7172 Have a look at the CPAN::Site module.
7176 When I run CPAN's shell, I get error msg about line 1 to 4,
7177 setting meta input/output via the /etc/inputrc file.
7179 Some versions of readline are picky about capitalization in the
7180 /etc/inputrc file and specifically RedHat 6.2 comes with a
7181 /etc/inputrc that contains the word C<on> in lowercase. Change the
7182 occurrences of C<on> to C<On> and the bug should disappear.
7186 Some authors have strange characters in their names.
7188 Internally CPAN.pm uses the UTF-8 charset. If your terminal is
7189 expecting ISO-8859-1 charset, a converter can be activated by setting
7190 term_is_latin to a true value in your config file. One way of doing so
7193 cpan> ! $CPAN::Config->{term_is_latin}=1
7195 Extended support for converters will be made available as soon as perl
7196 becomes stable with regard to charset issues.
7202 We should give coverage for B<all> of the CPAN and not just the PAUSE
7203 part, right? In this discussion CPAN and PAUSE have become equal --
7204 but they are not. PAUSE is authors/, modules/ and scripts/. CPAN is
7205 PAUSE plus the clpa/, doc/, misc/, ports/, and src/.
7207 Future development should be directed towards a better integration of
7210 If a Makefile.PL requires special customization of libraries, prompts
7211 the user for special input, etc. then you may find CPAN is not able to
7212 build the distribution. In that case, you should attempt the
7213 traditional method of building a Perl module package from a shell.
7217 Andreas Koenig E<lt>andreas.koenig@anima.deE<gt>
7221 Kawai,Takanori provides a Japanese translation of this manpage at
7222 http://member.nifty.ne.jp/hippo2000/perltips/CPAN.htm
7226 perl(1), CPAN::Nox(3)