# -*- Mode: cperl; coding: utf-8; cperl-indent-level: 4 -*-
+# vim: ts=4 sts=4 sw=4:
use strict;
package CPAN;
-$CPAN::VERSION = '1.88_69';
-$CPAN::VERSION = eval $CPAN::VERSION;
+$CPAN::VERSION = '1.93_51';
+$CPAN::VERSION =~ s/_//;
+# we need to run chdir all over and we would get at wrong libraries
+# there
+use File::Spec ();
+BEGIN {
+ if (File::Spec->can("rel2abs")) {
+ for my $inc (@INC) {
+ $inc = File::Spec->rel2abs($inc) unless ref $inc;
+ }
+ }
+}
+use CPAN::Author;
use CPAN::HandleConfig;
use CPAN::Version;
+use CPAN::Bundle;
+use CPAN::CacheMgr;
+use CPAN::Complete;
use CPAN::Debug;
+use CPAN::Distribution;
+use CPAN::Distrostatus;
+use CPAN::FTP;
+use CPAN::Index;
+use CPAN::InfoObj;
+use CPAN::Module;
+use CPAN::Prompt;
+use CPAN::URL;
use CPAN::Queue;
use CPAN::Tarzip;
+use CPAN::DeferredCode;
+use CPAN::Shell;
+use CPAN::LWP::UserAgent;
+use CPAN::Exception::RecursiveDependency;
+use CPAN::Exception::yaml_not_installed;
+
use Carp ();
use Config ();
-use Cwd ();
+use Cwd qw(chdir);
use DirHandle ();
use Exporter ();
use ExtUtils::MakeMaker qw(prompt); # for some unknown reason,
use File::Copy ();
use File::Find;
use File::Path ();
-use File::Spec ();
use FileHandle ();
use Fcntl qw(:flock);
use Safe ();
use Text::ParseWords ();
use Text::Wrap ();
-# we need to run chdir all over and we would get at wrong libraries
-# there
-BEGIN {
- if (File::Spec->can("rel2abs")) {
- for my $inc (@INC) {
- $inc = File::Spec->rel2abs($inc);
- }
- }
-}
+# protect against "called too early"
+sub find_perl ();
+sub anycwd ();
+sub _uniq;
+
no lib ".";
require Mac::BuildTools if $^O eq 'MacOS';
-$ENV{PERL5_CPAN_IS_RUNNING}=1;
+if ($ENV{PERL5_CPAN_IS_RUNNING} && $$ != $ENV{PERL5_CPAN_IS_RUNNING}) {
+ $ENV{PERL5_CPAN_IS_RUNNING_IN_RECURSION} ||= $ENV{PERL5_CPAN_IS_RUNNING};
+ my @rec = _uniq split(/,/, $ENV{PERL5_CPAN_IS_RUNNING_IN_RECURSION}), $$;
+ $ENV{PERL5_CPAN_IS_RUNNING_IN_RECURSION} = join ",", @rec;
+ # warn "# Note: Recursive call of CPAN.pm detected\n";
+ my $w = sprintf "# Note: CPAN.pm is running in process %d now", pop @rec;
+ my %sleep = (
+ 5 => 30,
+ 6 => 60,
+ 7 => 120,
+ );
+ my $sleep = @rec > 7 ? 300 : ($sleep{scalar @rec}||0);
+ my $verbose = @rec >= 4;
+ while (@rec) {
+ $w .= sprintf " which has been called by process %d", pop @rec;
+ }
+ if ($sleep) {
+ $w .= ".\n\n# Sleeping $sleep seconds to protect other processes\n";
+ }
+ if ($verbose) {
+ warn $w;
+ }
+ local $| = 1;
+ while ($sleep > 0) {
+ printf "\r#%5d", --$sleep;
+ sleep 1;
+ }
+ print "\n";
+}
+$ENV{PERL5_CPAN_IS_RUNNING}=$$;
+$ENV{PERL5_CPANPLUS_IS_RUNNING}=$$; # https://rt.cpan.org/Ticket/Display.html?id=23735
END { $CPAN::End++; &cleanup; }
$CPAN::Signal ||= 0;
$CPAN::Frontend ||= "CPAN::Shell";
-unless (@CPAN::Defaultsites){
+unless (@CPAN::Defaultsites) {
@CPAN::Defaultsites = map {
CPAN::URL->new(TEXT => $_, FROM => "DEF")
}
"http://www.perl.org/CPAN/",
- "ftp://ftp.perl.org/pub/CPAN/";
+ "ftp://ftp.perl.org/pub/CPAN/";
}
-# $CPAN::iCwd (i for initial) is going to be initialized during find_perl
+# $CPAN::iCwd (i for initial)
+$CPAN::iCwd ||= CPAN::anycwd();
$CPAN::Perl ||= CPAN::find_perl();
$CPAN::Defaultdocs ||= "http://search.cpan.org/perldoc?";
-$CPAN::Defaultrecent ||= "http://search.cpan.org/recent";
+$CPAN::Defaultrecent ||= "http://search.cpan.org/uploads.rdf";
+$CPAN::Defaultrecent ||= "http://cpan.uwinnipeg.ca/htdocs/cpan.xml";
# our globals are getting a mess
use vars qw(
$AUTOLOAD
$Be_Silent
$CONFIG_DIRTY
- $DEBUG
$Defaultdocs
- $Defaultrecent
+ $Echo_readline
$Frontend
$GOTOSHELL
$HAS_USABLE
$Have_warned
+ $MAX_RECURSION
$META
$RUN_DEGRADED
$Signal
@EXPORT
);
+$MAX_RECURSION = 32;
+
@CPAN::ISA = qw(CPAN::Debug Exporter);
# note that these functions live in CPAN::Shell and get executed via
get
install
install_tested
+ is_tested
make
mkmyconfig
notest
recompile
report
shell
+ smoke
test
upgrade
- );
+ );
sub soft_chdir_with_alternatives ($);
$autoload_recursion ||= 0;
#-> sub CPAN::AUTOLOAD ;
- sub AUTOLOAD {
+ sub AUTOLOAD { ## no critic
$autoload_recursion++;
my($l) = $AUTOLOAD;
$l =~ s/.*:://;
my(%export);
@export{@EXPORT} = '';
CPAN::HandleConfig->load unless $CPAN::Config_loaded++;
- if (exists $export{$l}){
+ if (exists $export{$l}) {
CPAN::Shell->$l(@_);
} else {
die(qq{Unknown CPAN command "$AUTOLOAD". }.
}
}
+{
+ my $x = *SAVEOUT; # avoid warning
+ open($x,">&STDOUT") or die "dup failed";
+ my $redir = 0;
+ sub _redirect(@) {
+ #die if $redir;
+ local $_;
+ push(@_,undef);
+ while(defined($_=shift)) {
+ if (s/^\s*>//){
+ my ($m) = s/^>// ? ">" : "";
+ s/\s+//;
+ $_=shift unless length;
+ die "no dest" unless defined;
+ open(STDOUT,">$m$_") or die "open:$_:$!\n";
+ $redir=1;
+ } elsif ( s/^\s*\|\s*// ) {
+ my $pipe="| $_";
+ while(defined($_[0])){
+ $pipe .= ' ' . shift;
+ }
+ open(STDOUT,$pipe) or die "open:$pipe:$!\n";
+ $redir=1;
+ } else {
+ push(@_,$_);
+ }
+ }
+ return @_;
+ }
+ sub _unredirect {
+ return unless $redir;
+ $redir = 0;
+ ## redirect: unredirect and propagate errors. explicit close to wait for pipe.
+ close(STDOUT);
+ open(STDOUT,">&SAVEOUT");
+ die "$@" if "$@";
+ ## redirect: done
+ }
+}
+
+sub _uniq {
+ my(@list) = @_;
+ my %seen;
+ return map { !$seen{$_} } @list;
+}
+
#-> sub CPAN::shell ;
sub shell {
my($self) = @_;
local($^W) = 1;
unless ($Suppress_readline) {
- require Term::ReadLine;
+ require Term::ReadLine;
if (! $term
or
$term->ReadLine eq "Term::ReadLine::Stub"
) {
$term = Term::ReadLine->new('CPAN Monitor');
}
- if ($term->ReadLine eq "Term::ReadLine::Gnu") {
- my $attribs = $term->Attribs;
- $attribs->{attempted_completion_function} = sub {
- &CPAN::Complete::gnu_cpl;
- }
- } else {
- $readline::rl_completion_function =
- $readline::rl_completion_function = 'CPAN::Complete::cpl';
- }
+ if ($term->ReadLine eq "Term::ReadLine::Gnu") {
+ my $attribs = $term->Attribs;
+ $attribs->{attempted_completion_function} = sub {
+ &CPAN::Complete::gnu_cpl;
+ }
+ } else {
+ $readline::rl_completion_function =
+ $readline::rl_completion_function = 'CPAN::Complete::cpl';
+ }
if (my $histfile = $CPAN::Config->{'histfile'}) {{
unless ($term->can("AddHistory")) {
$CPAN::Frontend->mywarn("Terminal does not support AddHistory.\n");
last;
}
- my($fh) = FileHandle->new;
- open $fh, "<$histfile" or last;
- local $/ = "\n";
- while (<$fh>) {
- chomp;
- $term->AddHistory($_);
- }
- close $fh;
+ $META->readhist($term,$histfile);
}}
for ($CPAN::Config->{term_ornaments}) { # alias
local $Term::ReadLine::termcap_nowarn = 1;
$term->ornaments($_) if defined;
}
- # $term->OUT is autoflushed anyway
- my $odef = select STDERR;
- $| = 1;
- select STDOUT;
- $| = 1;
- select $odef;
+ # $term->OUT is autoflushed anyway
+ my $odef = select STDERR;
+ $| = 1;
+ select STDOUT;
+ $| = 1;
+ select $odef;
}
$META->checklock();
File::Spec->rootdir();
my $try_detect_readline;
$try_detect_readline = $term->ReadLine eq "Term::ReadLine::Stub" if $term;
- my $rl_avail = $Suppress_readline ? "suppressed" :
- ($term->ReadLine ne "Term::ReadLine::Stub") ? "enabled" :
- "available (try 'install Bundle::CPAN')";
-
- unless ($CPAN::Config->{'inhibit_startup_message'}){
+ unless ($CPAN::Config->{inhibit_startup_message}) {
+ my $rl_avail = $Suppress_readline ? "suppressed" :
+ ($term->ReadLine ne "Term::ReadLine::Stub") ? "enabled" :
+ "available (maybe install Bundle::CPAN or Bundle::CPANxxl?)";
$CPAN::Frontend->myprint(
sprintf qq{
cpan shell -- CPAN exploration and modules installation (v%s)
my($continuation) = "";
my $last_term_ornaments;
SHELLCOMMAND: while () {
- if ($Suppress_readline) {
- print $prompt;
- last SHELLCOMMAND unless defined ($_ = <> );
- chomp;
- } else {
- last SHELLCOMMAND unless
+ if ($Suppress_readline) {
+ if ($Echo_readline) {
+ $|=1;
+ }
+ print $prompt;
+ last SHELLCOMMAND unless defined ($_ = <> );
+ if ($Echo_readline) {
+ # backdoor: I could not find a way to record sessions
+ print $_;
+ }
+ chomp;
+ } else {
+ last SHELLCOMMAND unless
defined ($_ = $term->readline($prompt, $commandline));
- }
- $_ = "$continuation$_" if $continuation;
- s/^\s+//;
- next SHELLCOMMAND if /^$/;
- $_ = 'h' if /^\s*\?/;
- if (/^(?:q(?:uit)?|bye|exit)$/i) {
- last SHELLCOMMAND;
- } elsif (s/\\$//s) {
- chomp;
- $continuation = $_;
- $prompt = " > ";
- } elsif (/^\!/) {
- s/^\!//;
- my($eval) = $_;
- package CPAN::Eval;
+ }
+ $_ = "$continuation$_" if $continuation;
+ s/^\s+//;
+ next SHELLCOMMAND if /^$/;
+ s/^\s*\?\s*/help /;
+ if (/^(?:q(?:uit)?|bye|exit)$/i) {
+ last SHELLCOMMAND;
+ } elsif (s/\\$//s) {
+ chomp;
+ $continuation = $_;
+ $prompt = " > ";
+ } elsif (/^\!/) {
+ s/^\!//;
+ my($eval) = $_;
+ package CPAN::Eval;
use strict;
- use vars qw($import_done);
- CPAN->import(':DEFAULT') unless $import_done++;
- CPAN->debug("eval[$eval]") if $CPAN::DEBUG;
- eval($eval);
- warn $@ if $@;
- $continuation = "";
- $prompt = $oprompt;
- } elsif (/./) {
- my(@line);
+ use vars qw($import_done);
+ CPAN->import(':DEFAULT') unless $import_done++;
+ CPAN->debug("eval[$eval]") if $CPAN::DEBUG;
+ eval($eval);
+ warn $@ if $@;
+ $continuation = "";
+ $prompt = $oprompt;
+ } elsif (/./) {
+ my(@line);
eval { @line = Text::ParseWords::shellwords($_) };
warn($@), next SHELLCOMMAND if $@;
warn("Text::Parsewords could not parse the line [$_]"),
next SHELLCOMMAND unless @line;
- $CPAN::META->debug("line[".join("|",@line)."]") if $CPAN::DEBUG;
- my $command = shift @line;
- eval { CPAN::Shell->$command(@line) };
- if ($@ && "$@" =~ /\S/){
- require Carp;
- Carp::cluck("Catching error: '$@'");
+ $CPAN::META->debug("line[".join("|",@line)."]") if $CPAN::DEBUG;
+ my $command = shift @line;
+ eval {
+ local (*STDOUT)=*STDOUT;
+ @line = _redirect(@line);
+ CPAN::Shell->$command(@line)
+ };
+ _unredirect;
+ if ($@) {
+ my $err = "$@";
+ if ($err =~ /\S/) {
+ require Carp;
+ require Dumpvalue;
+ my $dv = Dumpvalue->new(tick => '"');
+ Carp::cluck(sprintf "Catching error: %s", $dv->stringify($err));
+ }
}
- if ($command =~ /^(make|test|install|ff?orce|notest|clean|report|upgrade)$/) {
+ if ($command =~ /^(
+ # classic commands
+ make
+ |test
+ |install
+ |clean
+
+ # pragmas for classic commands
+ |ff?orce
+ |notest
+
+ # compounds
+ |report
+ |smoke
+ |upgrade
+ )$/x) {
+ # only commands that tell us something about failed distros
CPAN::Shell->failed($CPAN::CurrentCommandId,1);
}
soft_chdir_with_alternatives(\@cwd);
- $CPAN::Frontend->myprint("\n");
- $continuation = "";
+ $CPAN::Frontend->myprint("\n");
+ $continuation = "";
$CPAN::CurrentCommandId++;
- $prompt = $oprompt;
- }
+ $prompt = $oprompt;
+ }
} continue {
- $commandline = ""; # I do want to be able to pass a default to
- # shell, but on the second command I see no
- # use in that
- $Signal=0;
- CPAN::Queue->nullify_queue;
- if ($try_detect_readline) {
- if ($CPAN::META->has_inst("Term::ReadLine::Gnu")
- ||
- $CPAN::META->has_inst("Term::ReadLine::Perl")
- ) {
- delete $INC{"Term/ReadLine.pm"};
- my $redef = 0;
- local($SIG{__WARN__}) = CPAN::Shell::paintdots_onreload(\$redef);
- require Term::ReadLine;
- $CPAN::Frontend->myprint("\n$redef subroutines in ".
- "Term::ReadLine redefined\n");
- $GOTOSHELL = 1;
- }
- }
- if ($term and $term->can("ornaments")) {
- for ($CPAN::Config->{term_ornaments}) { # alias
- if (defined $_) {
- if (not defined $last_term_ornaments
- or $_ != $last_term_ornaments
- ) {
- local $Term::ReadLine::termcap_nowarn = 1;
- $term->ornaments($_);
- $last_term_ornaments = $_;
- }
- } else {
- undef $last_term_ornaments;
- }
- }
- }
- for my $class (qw(Module Distribution)) {
- # again unsafe meta access?
- for my $dm (keys %{$CPAN::META->{readwrite}{"CPAN::$class"}}) {
- next unless $CPAN::META->{readwrite}{"CPAN::$class"}{$dm}{incommandcolor};
- CPAN->debug("BUG: $class '$dm' was in command state, resetting");
- delete $CPAN::META->{readwrite}{"CPAN::$class"}{$dm}{incommandcolor};
- }
- }
- if ($GOTOSHELL) {
- $GOTOSHELL = 0; # not too often
- $META->savehist if $CPAN::term && $CPAN::term->can("GetHistory");
- @_ = ($oprompt,"");
- goto &shell;
- }
+ $commandline = ""; # I do want to be able to pass a default to
+ # shell, but on the second command I see no
+ # use in that
+ $Signal=0;
+ CPAN::Queue->nullify_queue;
+ if ($try_detect_readline) {
+ if ($CPAN::META->has_inst("Term::ReadLine::Gnu")
+ ||
+ $CPAN::META->has_inst("Term::ReadLine::Perl")
+ ) {
+ delete $INC{"Term/ReadLine.pm"};
+ my $redef = 0;
+ local($SIG{__WARN__}) = CPAN::Shell::paintdots_onreload(\$redef);
+ require Term::ReadLine;
+ $CPAN::Frontend->myprint("\n$redef subroutines in ".
+ "Term::ReadLine redefined\n");
+ $GOTOSHELL = 1;
+ }
+ }
+ if ($term and $term->can("ornaments")) {
+ for ($CPAN::Config->{term_ornaments}) { # alias
+ if (defined $_) {
+ if (not defined $last_term_ornaments
+ or $_ != $last_term_ornaments
+ ) {
+ local $Term::ReadLine::termcap_nowarn = 1;
+ $term->ornaments($_);
+ $last_term_ornaments = $_;
+ }
+ } else {
+ undef $last_term_ornaments;
+ }
+ }
+ }
+ for my $class (qw(Module Distribution)) {
+ # again unsafe meta access?
+ for my $dm (keys %{$CPAN::META->{readwrite}{"CPAN::$class"}}) {
+ next unless $CPAN::META->{readwrite}{"CPAN::$class"}{$dm}{incommandcolor};
+ CPAN->debug("BUG: $class '$dm' was in command state, resetting");
+ delete $CPAN::META->{readwrite}{"CPAN::$class"}{$dm}{incommandcolor};
+ }
+ }
+ if ($GOTOSHELL) {
+ $GOTOSHELL = 0; # not too often
+ $META->savehist if $CPAN::term && $CPAN::term->can("GetHistory");
+ @_ = ($oprompt,"");
+ goto &shell;
+ }
}
soft_chdir_with_alternatives(\@cwd);
}
+#-> CPAN::soft_chdir_with_alternatives ;
sub soft_chdir_with_alternatives ($) {
my($cwd) = @_;
unless (@$cwd) {
}
}
+sub _flock {
+ my($fh,$mode) = @_;
+ if ( $Config::Config{d_flock} || $Config::Config{d_fcntl_can_lock} ) {
+ return flock $fh, $mode;
+ } elsif (!$Have_warned->{"d_flock"}++) {
+ $CPAN::Frontend->mywarn("Your OS does not seem to support locking; continuing and ignoring all locking issues\n");
+ $CPAN::Frontend->mysleep(5);
+ return 1;
+ } else {
+ return 1;
+ }
+}
+
sub _yaml_module () {
my $yaml_module = $CPAN::Config->{yaml_module} || "YAML";
if (
# $CPAN::Frontend->mywarn("'$yaml_module' not installed, falling back to 'YAML'\n");
$yaml_module = "YAML";
}
+ if ($yaml_module eq "YAML"
+ &&
+ $CPAN::META->has_inst($yaml_module)
+ &&
+ $YAML::VERSION < 0.60
+ &&
+ !$Have_warned->{"YAML"}++
+ ) {
+ $CPAN::Frontend->mywarn("Warning: YAML version '$YAML::VERSION' is too low, please upgrade!\n".
+ "I'll continue but problems are *very* likely to happen.\n"
+ );
+ $CPAN::Frontend->mysleep(5);
+ }
return $yaml_module;
}
return +[] unless -s $local_file;
my $yaml_module = _yaml_module;
if ($CPAN::META->has_inst($yaml_module)) {
- my $code = UNIVERSAL::can($yaml_module, "LoadFile");
- my @yaml;
- eval { @yaml = $code->($local_file); };
- if ($@) {
- # this shall not be done by the frontend
- die CPAN::Exception::yaml_process_error->new($yaml_module,$local_file,"parse",$@);
+ # temporarly enable yaml code deserialisation
+ no strict 'refs';
+ # 5.6.2 could not do the local() with the reference
+ # so we do it manually instead
+ my $old_loadcode = ${"$yaml_module\::LoadCode"};
+ ${ "$yaml_module\::LoadCode" } = $CPAN::Config->{yaml_load_code} || 0;
+
+ my ($code, @yaml);
+ if ($code = UNIVERSAL::can($yaml_module, "LoadFile")) {
+ eval { @yaml = $code->($local_file); };
+ if ($@) {
+ # this shall not be done by the frontend
+ die CPAN::Exception::yaml_process_error->new($yaml_module,$local_file,"parse",$@);
+ }
+ } elsif ($code = UNIVERSAL::can($yaml_module, "Load")) {
+ local *FH;
+ open FH, $local_file or die "Could not open '$local_file': $!";
+ local $/;
+ my $ystream = <FH>;
+ eval { @yaml = $code->($ystream); };
+ if ($@) {
+ # this shall not be done by the frontend
+ die CPAN::Exception::yaml_process_error->new($yaml_module,$local_file,"parse",$@);
+ }
}
+ ${"$yaml_module\::LoadCode"} = $old_loadcode;
return \@yaml;
} else {
# this shall not be done by the frontend
my($self,$local_file,@what) = @_;
my $yaml_module = _yaml_module;
if ($CPAN::META->has_inst($yaml_module)) {
+ my $code;
if (UNIVERSAL::isa($local_file, "FileHandle")) {
- my $code = UNIVERSAL::can($yaml_module, "Dump");
+ $code = UNIVERSAL::can($yaml_module, "Dump");
eval { print $local_file $code->(@what) };
- } else {
- my $code = UNIVERSAL::can($yaml_module, "DumpFile");
+ } elsif ($code = UNIVERSAL::can($yaml_module, "DumpFile")) {
eval { $code->($local_file,@what); };
+ } elsif ($code = UNIVERSAL::can($yaml_module, "Dump")) {
+ local *FH;
+ open FH, ">$local_file" or die "Could not open '$local_file': $!";
+ print FH $code->(@what);
}
if ($@) {
die CPAN::Exception::yaml_process_error->new($yaml_module,$local_file,"dump",$@);
}
}
-package CPAN::CacheMgr;
-use strict;
-@CPAN::CacheMgr::ISA = qw(CPAN::InfoObj CPAN);
-use File::Find;
-
-package CPAN::FTP;
-use strict;
-use Fcntl qw(:flock);
-use vars qw($Ua $Thesite $ThesiteURL $Themethod);
-@CPAN::FTP::ISA = qw(CPAN::Debug);
-
-package CPAN::LWP::UserAgent;
-use strict;
-use vars qw(@ISA $USER $PASSWD $SETUPDONE);
-# we delay requiring LWP::UserAgent and setting up inheritance until we need it
-
-package CPAN::Complete;
-use strict;
-@CPAN::Complete::ISA = qw(CPAN::Debug);
-# Q: where is the "How do I add a new command" HOWTO?
-# A: svn diff -r 1048:1049 where andk added the report command
-@CPAN::Complete::COMMANDS = sort qw(
- ! a b d h i m o q r u
- autobundle
- clean
- cvs_import
- dump
- force
- fforce
- hosts
- install
- install_tested
- look
- ls
- make
- mkmyconfig
- notest
- perldoc
- readme
- recent
- recompile
- reload
- report
- scripts
- test
- upgrade
-);
-
-package CPAN::Index;
-use strict;
-use vars qw($LAST_TIME $DATE_OF_02 $DATE_OF_03 $HAVE_REANIMATED);
-@CPAN::Index::ISA = qw(CPAN::Debug);
-$LAST_TIME ||= 0;
-$DATE_OF_03 ||= 0;
-# use constant PROTOCOL => "2.0"; # outcommented to avoid warning on upgrade from 1.57
-sub PROTOCOL { 2.0 }
-
-package CPAN::InfoObj;
-use strict;
-@CPAN::InfoObj::ISA = qw(CPAN::Debug);
-
-package CPAN::Author;
-use strict;
-@CPAN::Author::ISA = qw(CPAN::InfoObj);
-
-package CPAN::Distribution;
-use strict;
-@CPAN::Distribution::ISA = qw(CPAN::InfoObj);
-
-package CPAN::Bundle;
-use strict;
-@CPAN::Bundle::ISA = qw(CPAN::Module);
-
-package CPAN::Module;
-use strict;
-@CPAN::Module::ISA = qw(CPAN::InfoObj);
-
-package CPAN::Exception::RecursiveDependency;
-use strict;
-use overload '""' => "as_string";
-
-sub new {
- my($class) = shift;
- my($deps) = shift;
- my @deps;
- my %seen;
- for my $dep (@$deps) {
- push @deps, $dep;
- last if $seen{$dep}++;
- }
- bless { deps => \@deps }, $class;
-}
-
-sub as_string {
- my($self) = shift;
- "\nRecursive dependency detected:\n " .
- join("\n => ", @{$self->{deps}}) .
- ".\nCannot continue.\n";
-}
-
-package CPAN::Exception::yaml_not_installed;
-use strict;
-use overload '""' => "as_string";
-
-sub new {
- my($class,$module,$file,$during) = @_;
- bless { module => $module, file => $file, during => $during }, $class;
-}
-
-sub as_string {
- my($self) = shift;
- "'$self->{module}' not installed, cannot $self->{during} '$self->{file}'\n";
-}
-
-package CPAN::Exception::yaml_process_error;
-use strict;
-use overload '""' => "as_string";
-
-sub new {
- my($class,$module,$file,$during,$error) = shift;
- bless { module => $module,
- file => $file,
- during => $during,
- error => $error }, $class;
-}
-
-sub as_string {
- my($self) = shift;
- "Alert: While trying to $self->{during} YAML file\n".
- " $self->{file}\n".
- "with '$self->{module}' the following error was encountered:\n".
- " $self->{error}\n";
-}
-
-package CPAN::Prompt; use overload '""' => "as_string";
-use vars qw($prompt);
-$prompt = "cpan> ";
-$CPAN::CurrentCommandId ||= 0;
-sub new {
- bless {}, shift;
-}
-sub as_string {
- my $word = "cpan";
- unless ($CPAN::META->{LOCK}) {
- $word = "nolock_cpan";
- }
- if ($CPAN::Config->{commandnumber_in_prompt}) {
- sprintf "$word\[%d]> ", $CPAN::CurrentCommandId;
- } else {
- "$word> ";
- }
-}
-
-package CPAN::URL; use overload '""' => "as_string", fallback => 1;
-# accessors: TEXT(the url string), FROM(DEF=>defaultlist,USER=>urllist),
-# planned are things like age or quality
-sub new {
- my($class,%args) = @_;
- bless {
- %args
- }, $class;
-}
-sub as_string {
- my($self) = @_;
- $self->text;
-}
-sub text {
- my($self,$set) = @_;
- if (defined $set) {
- $self->{TEXT} = $set;
- }
- $self->{TEXT};
-}
-
-package CPAN::Distrostatus;
-use overload '""' => "as_string",
- fallback => 1;
-sub new {
- my($class,$arg) = @_;
- bless {
- TEXT => $arg,
- FAILED => substr($arg,0,2) eq "NO",
- COMMANDID => $CPAN::CurrentCommandId,
- TIME => time,
- }, $class;
-}
-sub commandid { shift->{COMMANDID} }
-sub failed { shift->{FAILED} }
-sub text {
- my($self,$set) = @_;
- if (defined $set) {
- $self->{TEXT} = $set;
- }
- $self->{TEXT};
-}
-sub as_string {
- my($self) = @_;
- $self->text;
-}
-
-package CPAN::Shell;
-use strict;
-use vars qw(
- $ADVANCED_QUERY
- $AUTOLOAD
- $COLOR_REGISTERED
- $autoload_recursion
- $reload
- @ISA
- );
-@CPAN::Shell::ISA = qw(CPAN::Debug);
-$COLOR_REGISTERED ||= 0;
-
-{
- $autoload_recursion ||= 0;
-
- #-> sub CPAN::Shell::AUTOLOAD ;
- sub AUTOLOAD {
- $autoload_recursion++;
- my($l) = $AUTOLOAD;
- my $class = shift(@_);
- # warn "autoload[$l] class[$class]";
- $l =~ s/.*:://;
- if ($CPAN::Signal) {
- warn "Refusing to autoload '$l' while signal pending";
- $autoload_recursion--;
- return;
- }
- if ($autoload_recursion > 1) {
- my $fullcommand = join " ", map { "'$_'" } $l, @_;
- warn "Refusing to autoload $fullcommand in recursion\n";
- $autoload_recursion--;
- return;
- }
- if ($l =~ /^w/) {
- # XXX needs to be reconsidered
- if ($CPAN::META->has_inst('CPAN::WAIT')) {
- CPAN::WAIT->$l(@_);
- } else {
- $CPAN::Frontend->mywarn(qq{
-Commands starting with "w" require CPAN::WAIT to be installed.
-Please consider installing CPAN::WAIT to use the fulltext index.
-For this you just need to type
- install CPAN::WAIT
-});
- }
- } else {
- $CPAN::Frontend->mywarn(qq{Unknown shell command '$l'. }.
- qq{Type ? for help.
-});
- }
- $autoload_recursion--;
- }
-}
-
-package CPAN;
-use strict;
-
$META ||= CPAN->new; # In case we re-eval ourselves we need the ||
# from here on only subs.
if (defined $dll) {
$mtime_dll = (-f $dll ? (stat(_))[9] : '-1');
}
+ my $mtime_perl = (-f CPAN::find_perl ? (stat(_))[9] : '-1');
my $this_fingerprint = {
- '$^X' => $^X,
+ '$^X' => CPAN::find_perl,
sitearchexp => $Config::Config{sitearchexp},
- 'mtime_$^X' => (stat $^X)[9],
+ 'mtime_$^X' => $mtime_perl,
'mtime_dll' => $mtime_dll,
};
if ($other_fingerprint) {
my($self) = @_;
my $lockfile = File::Spec->catfile($CPAN::Config->{cpan_home},".lock");
if (-f $lockfile && -M _ > 0) {
- my $fh = FileHandle->new($lockfile) or
+ my $fh = FileHandle->new($lockfile) or
$CPAN::Frontend->mydie("Could not open lockfile '$lockfile': $!");
- my $otherpid = <$fh>;
- my $otherhost = <$fh>;
- $fh->close;
- if (defined $otherpid && $otherpid) {
- chomp $otherpid;
+ my $otherpid = <$fh>;
+ my $otherhost = <$fh>;
+ $fh->close;
+ if (defined $otherpid && $otherpid) {
+ chomp $otherpid;
+ }
+ if (defined $otherhost && $otherhost) {
+ chomp $otherhost;
}
- if (defined $otherhost && $otherhost) {
- chomp $otherhost;
- }
- my $thishost = hostname();
- if (defined $otherhost && defined $thishost &&
- $otherhost ne '' && $thishost ne '' &&
- $otherhost ne $thishost) {
+ my $thishost = hostname();
+ if (defined $otherhost && defined $thishost &&
+ $otherhost ne '' && $thishost ne '' &&
+ $otherhost ne $thishost) {
$CPAN::Frontend->mydie(sprintf("CPAN.pm panic: Lockfile '$lockfile'\n".
"reports other host $otherhost and other ".
"process $otherpid.\n".
"Cannot proceed.\n"));
- } elsif ($RUN_DEGRADED) {
- $CPAN::Frontend->mywarn("Running in degraded mode (experimental)\n");
+ } elsif ($RUN_DEGRADED) {
+ $CPAN::Frontend->mywarn("Running in downgraded mode (experimental)\n");
} elsif (defined $otherpid && $otherpid) {
- return if $$ == $otherpid; # should never happen
- $CPAN::Frontend->mywarn(
- qq{
+ return if $$ == $otherpid; # should never happen
+ $CPAN::Frontend->mywarn(
+ qq{
There seems to be running another CPAN process (pid $otherpid). Contacting...
});
- if (kill 0, $otherpid) {
- $CPAN::Frontend->mywarn(qq{Other job is running.\n});
- my($ans) =
- CPAN::Shell::colorable_makemaker_prompt
- (qq{Shall I try to run in degraded }.
- qq{mode? (Y/n)},"y");
+ if (kill 0, $otherpid or $!{EPERM}) {
+ $CPAN::Frontend->mywarn(qq{Other job is running.\n});
+ my($ans) =
+ CPAN::Shell::colorable_makemaker_prompt
+ (qq{Shall I try to run in downgraded }.
+ qq{mode? (Y/n)},"y");
if ($ans =~ /^y/i) {
- $CPAN::Frontend->mywarn("Running in degraded mode (experimental).
+ $CPAN::Frontend->mywarn("Running in downgraded mode (experimental).
Please report if something unexpected happens\n");
$RUN_DEGRADED = 1;
for ($CPAN::Config) {
# XXX
# $_->{build_dir_reuse} = 0; # 2006-11-17 akoenig Why was that?
$_->{commandnumber_in_prompt} = 0; # visibility
- $_->{histfile} = ""; # who should win otherwise?
- $_->{cache_metadata} = 0; # better would be a lock?
- $_->{use_sqlite} = 0; # better would be a write lock!
+ $_->{histfile} = ""; # who should win otherwise?
+ $_->{cache_metadata} = 0; # better would be a lock?
+ $_->{use_sqlite} = 0; # better would be a write lock!
+ $_->{auto_commit} = 0; # we are violent, do not persist
+ $_->{test_report} = 0; # Oliver Paukstadt had sent wrong reports in degraded mode
}
} else {
$CPAN::Frontend->mydie("
rm $lockfile
");
}
- } elsif (-w $lockfile) {
- my($ans) =
- CPAN::Shell::colorable_makemaker_prompt
- (qq{Other job not responding. Shall I overwrite }.
- qq{the lockfile '$lockfile'? (Y/n)},"y");
- $CPAN::Frontend->myexit("Ok, bye\n")
- unless $ans =~ /^y/i;
- } else {
- Carp::croak(
- qq{Lockfile '$lockfile' not writeable by you. }.
- qq{Cannot proceed.\n}.
- qq{ On UNIX try:\n}.
- qq{ rm '$lockfile'\n}.
- qq{ and then rerun us.\n}
- );
- }
- } else {
+ } elsif (-w $lockfile) {
+ my($ans) =
+ CPAN::Shell::colorable_makemaker_prompt
+ (qq{Other job not responding. Shall I overwrite }.
+ qq{the lockfile '$lockfile'? (Y/n)},"y");
+ $CPAN::Frontend->myexit("Ok, bye\n")
+ unless $ans =~ /^y/i;
+ } else {
+ Carp::croak(
+ qq{Lockfile '$lockfile' not writable by you. }.
+ qq{Cannot proceed.\n}.
+ qq{ On UNIX try:\n}.
+ qq{ rm '$lockfile'\n}.
+ qq{ and then rerun us.\n}
+ );
+ }
+ } else {
$CPAN::Frontend->mydie(sprintf("CPAN.pm panic: Found invalid lockfile ".
"'$lockfile', please remove. Cannot proceed.\n"));
}
$mess .= qq{
Please make sure the directory exists and is writable.
};
- $CPAN::Frontend->myprint($mess);
+ $CPAN::Frontend->mywarn($mess);
return suggest_myconfig;
}
} # $@ after eval mkpath $dotcpan
my $fh;
unless ($fh = FileHandle->new("+>>$lockfile")) {
if ($! =~ /Permission/) {
- $CPAN::Frontend->myprint(qq{
+ $CPAN::Frontend->mywarn(qq{
Your configuration suggests that CPAN.pm should use a working
directory of
}
}
my $sleep = 1;
- while (!flock $fh, LOCK_EX|LOCK_NB) {
+ while (!CPAN::_flock($fh, LOCK_EX|LOCK_NB)) {
if ($sleep>10) {
$CPAN::Frontend->mydie("Giving up\n");
}
seek $fh, 0, 0;
truncate $fh, 0;
+ $fh->autoflush(1);
$fh->print($$, "\n");
$fh->print(hostname(), "\n");
$self->{LOCK} = $lockfile;
sub backtickcwd {my $cwd = `cwd`; chomp $cwd; $cwd}
#-> sub CPAN::find_perl ;
-sub find_perl {
+sub find_perl () {
my($perl) = File::Spec->file_name_is_absolute($^X) ? $^X : "";
- my $pwd = $CPAN::iCwd = CPAN::anycwd();
- my $candidate = File::Spec->catfile($pwd,$^X);
- $perl ||= $candidate if MM->maybe_command($candidate);
-
unless ($perl) {
- my ($component,$perl_name);
+ my $candidate = File::Spec->catfile($CPAN::iCwd,$^X);
+ $^X = $perl = $candidate if MM->maybe_command($candidate);
+ }
+ unless ($perl) {
+ my ($component,$perl_name);
DIST_PERLNAME: foreach $perl_name ($^X, 'perl', 'perl5', "perl$]") {
- PATH_COMPONENT: foreach $component (File::Spec->path(),
- $Config::Config{'binexp'}) {
- next unless defined($component) && $component;
- my($abs) = File::Spec->catfile($component,$perl_name);
- if (MM->maybe_command($abs)) {
- $perl = $abs;
- last DIST_PERLNAME;
- }
- }
- }
+ PATH_COMPONENT: foreach $component (File::Spec->path(),
+ $Config::Config{'binexp'}) {
+ next unless defined($component) && $component;
+ my($abs) = File::Spec->catfile($component,$perl_name);
+ if (MM->maybe_command($abs)) {
+ $^X = $perl = $abs;
+ last DIST_PERLNAME;
+ }
+ }
+ }
}
-
return $perl;
}
],
'File::HomeDir' => [
sub {require File::HomeDir;
- unless (File::HomeDir::->VERSION >= 0.52){
+ unless (CPAN::Version->vge(File::HomeDir::->VERSION, 0.52)) {
for ("Will not use File::HomeDir, need 0.52\n") {
$CPAN::Frontend->mywarn($_);
die $_;
}
},
],
+ 'Archive::Tar' => [
+ sub {require Archive::Tar;
+ unless (CPAN::Version->vge(Archive::Tar::->VERSION, 1.00)) {
+ for ("Will not use Archive::Tar, need 1.00\n") {
+ $CPAN::Frontend->mywarn($_);
+ die $_;
+ }
+ }
+ },
+ ],
+ 'File::Temp' => [
+ # XXX we should probably delete from
+ # %INC too so we can load after we
+ # installed a new enough version --
+ # I'm not sure.
+ sub {require File::Temp;
+ unless (CPAN::Version->vge(File::Temp::->VERSION,0.16)) {
+ for ("Will not use File::Temp, need 0.16\n") {
+ $CPAN::Frontend->mywarn($_);
+ die $_;
+ }
+ }
+ },
+ ]
};
if ($usable->{$mod}) {
for my $c (0..$#{$usable->{$mod}}) {
sub has_inst {
my($self,$mod,$message) = @_;
Carp::croak("CPAN->has_inst() called without an argument")
- unless defined $mod;
+ unless defined $mod;
my %dont = map { $_ => 1 } keys %{$CPAN::META->{dontload_hash}||{}},
keys %{$CPAN::Config->{dontload_hash}||{}},
@{$CPAN::Config->{dontload_list}||[]};
$file =~ s|::|/|g;
$file .= ".pm";
if ($INC{$file}) {
- # checking %INC is wrong, because $INC{LWP} may be true
- # although $INC{"URI/URL.pm"} may have failed. But as
- # I really want to say "bla loaded OK", I have to somehow
- # cache results.
- ### warn "$file in %INC"; #debug
- return 1;
+ # checking %INC is wrong, because $INC{LWP} may be true
+ # although $INC{"URI/URL.pm"} may have failed. But as
+ # I really want to say "bla loaded OK", I have to somehow
+ # cache results.
+ ### warn "$file in %INC"; #debug
+ return 1;
} elsif (eval { require $file }) {
- # eval is good: if we haven't yet read the database it's
- # perfect and if we have installed the module in the meantime,
- # it tries again. The second require is only a NOOP returning
- # 1 if we had success, otherwise it's retrying
-
+ # eval is good: if we haven't yet read the database it's
+ # perfect and if we have installed the module in the meantime,
+ # it tries again. The second require is only a NOOP returning
+ # 1 if we had success, otherwise it's retrying
+
+ my $mtime = (stat $INC{$file})[9];
+ # privileged files loaded by has_inst; Note: we use $mtime
+ # as a proxy for a checksum.
+ $CPAN::Shell::reload->{$file} = $mtime;
my $v = eval "\$$mod\::VERSION";
$v = $v ? " (v$v)" : "";
- $CPAN::Frontend->myprint("CPAN: $mod loaded ok$v\n");
- if ($mod eq "CPAN::WAIT") {
- push @CPAN::Shell::ISA, 'CPAN::WAIT';
- }
- return 1;
+ CPAN::Shell->optprint("load_module","CPAN: $mod loaded ok$v\n");
+ if ($mod eq "CPAN::WAIT") {
+ push @CPAN::Shell::ISA, 'CPAN::WAIT';
+ }
+ return 1;
} elsif ($mod eq "Net::FTP") {
- $CPAN::Frontend->mywarn(qq{
+ $CPAN::Frontend->mywarn(qq{
Please, install Net::FTP as soon as possible. CPAN.pm installs it for you
if you just type
install Bundle::libnet
}) unless $Have_warned->{"Net::FTP"}++;
- $CPAN::Frontend->mysleep(3);
- } elsif ($mod eq "Digest::SHA"){
+ $CPAN::Frontend->mysleep(3);
+ } elsif ($mod eq "Digest::SHA") {
if ($Have_warned->{"Digest::SHA"}++) {
- $CPAN::Frontend->myprint(qq{CPAN: checksum security checks disabled}.
+ $CPAN::Frontend->mywarn(qq{CPAN: checksum security checks disabled }.
qq{because Digest::SHA not installed.\n});
} else {
$CPAN::Frontend->mywarn(qq{
});
$CPAN::Frontend->mysleep(2);
}
- } elsif ($mod eq "Module::Signature"){
+ } elsif ($mod eq "Module::Signature") {
# NOT prefs_lookup, we are not a distro
my $check_sigs = $CPAN::Config->{check_sigs};
if (not $check_sigs) {
# they do not want us:-(
} elsif (not $Have_warned->{"Module::Signature"}++) {
- # No point in complaining unless the user can
- # reasonably install and use it.
- if (eval { require Crypt::OpenPGP; 1 } ||
- (
+ # No point in complaining unless the user can
+ # reasonably install and use it.
+ if (eval { require Crypt::OpenPGP; 1 } ||
+ (
defined $CPAN::Config->{'gpg'}
&&
$CPAN::Config->{'gpg'} =~ /\S/
)
) {
- $CPAN::Frontend->mywarn(qq{
+ $CPAN::Frontend->mywarn(qq{
CPAN: Module::Signature security checks disabled because Module::Signature
not installed. Please consider installing the Module::Signature module.
You may also need to be able to connect over the Internet to the public
keyservers like pgp.mit.edu (port 11371).
});
- $CPAN::Frontend->mysleep(2);
- }
- }
+ $CPAN::Frontend->mysleep(2);
+ }
+ }
} else {
- delete $INC{$file}; # if it inc'd LWP but failed during, say, URI
+ delete $INC{$file}; # if it inc'd LWP but failed during, say, URI
}
return 0;
}
my($subroutine);
while ((undef,undef,undef,$subroutine) = caller(++$i)) {
$ineval = 1, last if
- $subroutine eq '(eval)';
+ $subroutine eq '(eval)';
}
return if $ineval && !$CPAN::End;
return unless defined $META->{LOCK};
$CPAN::Frontend->myprint("Lockfile removed.\n");
}
+#-> sub CPAN::readhist
+sub readhist {
+ my($self,$term,$histfile) = @_;
+ my $histsize = $CPAN::Config->{'histsize'} || 100;
+ $term->Attribs->{'MaxHistorySize'} = $histsize if (defined($term->Attribs->{'MaxHistorySize'}));
+ my($fh) = FileHandle->new;
+ open $fh, "<$histfile" or return;
+ local $/ = "\n";
+ while (<$fh>) {
+ chomp;
+ $term->AddHistory($_);
+ }
+ close $fh;
+}
+
#-> sub CPAN::savehist
sub savehist {
my($self) = @_;
my($histfile,$histsize);
- unless ($histfile = $CPAN::Config->{'histfile'}){
+ unless ($histfile = $CPAN::Config->{'histfile'}) {
$CPAN::Frontend->mywarn("No history written (no histfile specified).\n");
return;
}
$histsize = $CPAN::Config->{'histsize'} || 100;
- if ($CPAN::term){
+ if ($CPAN::term) {
unless ($CPAN::term->can("GetHistory")) {
$CPAN::Frontend->mywarn("Terminal does not support GetHistory.\n");
return;
$self->{is_tested}{$what} = $when;
}
+#-> sub CPAN::reset_tested
+# forget all distributions tested -- resets what gets included in PERL5LIB
+sub reset_tested {
+ my ($self) = @_;
+ $self->{is_tested} = {};
+}
+
#-> sub CPAN::is_installed
# unsets the is_tested flag: as soon as the thing is installed, it is
# not needed in set_perl5lib anymore
}
#-> sub CPAN::set_perl5lib
+# Notes on max environment variable length:
+# - Win32 : XP or later, 8191; Win2000 or NT4, 2047
+{
+my $fh;
sub set_perl5lib {
my($self,$for) = @_;
unless ($for) {
my $env = $ENV{PERL5LIB};
$env = $ENV{PERLLIB} unless defined $env;
my @env;
- push @env, $env if defined $env and length $env;
+ push @env, split /\Q$Config::Config{path_sep}\E/, $env if defined $env and length $env;
#my @dirs = map {("$_/blib/arch", "$_/blib/lib")} keys %{$self->{is_tested}};
#$CPAN::Frontend->myprint("Prepending @dirs to PERL5LIB.\n");
my @dirs = map {("$_/blib/arch", "$_/blib/lib")} $self->_list_sorted_descending_is_tested;
+ return if !@dirs;
+
if (@dirs < 12) {
- $CPAN::Frontend->myprint("Prepending @dirs to PERL5LIB for '$for'\n");
- } elsif (@dirs < 24) {
+ $CPAN::Frontend->optprint('perl5lib', "Prepending @dirs to PERL5LIB for '$for'\n");
+ $ENV{PERL5LIB} = join $Config::Config{path_sep}, @dirs, @env;
+ } elsif (@dirs < 24 ) {
my @d = map {my $cp = $_;
$cp =~ s/^\Q$CPAN::Config->{build_dir}\E/%BUILDDIR%/;
$cp
} @dirs;
- $CPAN::Frontend->myprint("Prepending @d to PERL5LIB; ".
+ $CPAN::Frontend->optprint('perl5lib', "Prepending @d to PERL5LIB; ".
"%BUILDDIR%=$CPAN::Config->{build_dir} ".
"for '$for'\n"
);
+ $ENV{PERL5LIB} = join $Config::Config{path_sep}, @dirs, @env;
} else {
my $cnt = keys %{$self->{is_tested}};
- $CPAN::Frontend->myprint("Prepending blib/arch and blib/lib of ".
+ $CPAN::Frontend->optprint('perl5lib', "Prepending blib/arch and blib/lib of ".
"$cnt build dirs to PERL5LIB; ".
"for '$for'\n"
);
+ $ENV{PERL5LIB} = join $Config::Config{path_sep}, @dirs, @env;
}
+}}
- $ENV{PERL5LIB} = join $Config::Config{path_sep}, @dirs, @env;
-}
-package CPAN::CacheMgr;
-use strict;
+1;
-#-> sub CPAN::CacheMgr::as_string ;
-sub as_string {
- eval { require Data::Dumper };
- if ($@) {
- return shift->SUPER::as_string;
- } else {
- return Data::Dumper::Dumper(shift);
- }
-}
-#-> sub CPAN::CacheMgr::cachesize ;
-sub cachesize {
- shift->{DU};
-}
+__END__
-#-> sub CPAN::CacheMgr::tidyup ;
-sub tidyup {
- my($self) = @_;
- return unless $CPAN::META->{LOCK};
- return unless -d $self->{ID};
- while ($self->{DU} > $self->{'MAX'} ) {
- my($toremove) = shift @{$self->{FIFO}};
- unless ($toremove =~ /\.yml$/) {
- $CPAN::Frontend->myprint(sprintf(
- "DEL: $toremove (%.1f>%.1f MB)\n",
- $self->{DU}, $self->{'MAX'})
- );
- }
- return if $CPAN::Signal;
- $self->_clean_cache($toremove);
- return if $CPAN::Signal;
- }
-}
+=head1 NAME
-#-> sub CPAN::CacheMgr::dir ;
-sub dir {
- shift->{ID};
-}
+CPAN - query, download and build perl modules from CPAN sites
-#-> sub CPAN::CacheMgr::entries ;
-sub entries {
- my($self,$dir) = @_;
- return unless defined $dir;
- $self->debug("reading dir[$dir]") if $CPAN::DEBUG;
- $dir ||= $self->{ID};
- my($cwd) = CPAN::anycwd();
- chdir $dir or Carp::croak("Can't chdir to $dir: $!");
- my $dh = DirHandle->new(File::Spec->curdir)
- or Carp::croak("Couldn't opendir $dir: $!");
- my(@entries);
- for ($dh->read) {
- next if $_ eq "." || $_ eq "..";
- if (-f $_) {
- push @entries, File::Spec->catfile($dir,$_);
- } elsif (-d _) {
- push @entries, File::Spec->catdir($dir,$_);
- } else {
- $CPAN::Frontend->mywarn("Warning: weird direntry in $dir: $_\n");
- }
- }
- chdir $cwd or Carp::croak("Can't chdir to $cwd: $!");
- sort { -M $b <=> -M $a} @entries;
-}
+=head1 SYNOPSIS
-#-> sub CPAN::CacheMgr::disk_usage ;
-sub disk_usage {
- my($self,$dir) = @_;
- return if exists $self->{SIZE}{$dir};
- return if $CPAN::Signal;
- my($Du) = 0;
- if (-e $dir) {
- unless (-x $dir) {
- unless (chmod 0755, $dir) {
- $CPAN::Frontend->mywarn("I have neither the -x permission nor the ".
- "permission to change the permission; cannot ".
- "estimate disk usage of '$dir'\n");
- $CPAN::Frontend->mysleep(5);
- return;
- }
- }
- } else {
- $CPAN::Frontend->mywarn("Directory '$dir' has gone. Cannot continue.\n");
- return;
- }
- find(
- sub {
- $File::Find::prune++ if $CPAN::Signal;
- return if -l $_;
- if ($^O eq 'MacOS') {
- require Mac::Files;
- my $cat = Mac::Files::FSpGetCatInfo($_);
- $Du += $cat->ioFlLgLen() + $cat->ioFlRLgLen() if $cat;
- } else {
- if (-d _) {
- unless (-x _) {
- unless (chmod 0755, $_) {
- $CPAN::Frontend->mywarn("I have neither the -x permission nor ".
- "the permission to change the permission; ".
- "can only partially estimate disk usage ".
- "of '$_'\n");
- $CPAN::Frontend->mysleep(5);
- return;
- }
- }
- } else {
- $Du += (-s _);
- }
- }
- },
- $dir
- );
- return if $CPAN::Signal;
- $self->{SIZE}{$dir} = $Du/1024/1024;
- push @{$self->{FIFO}}, $dir;
- $self->debug("measured $dir is $Du") if $CPAN::DEBUG;
- $self->{DU} += $Du/1024/1024;
- $self->{DU};
-}
+Interactive mode:
-#-> sub CPAN::CacheMgr::_clean_cache ;
-sub _clean_cache {
- my($self,$dir) = @_;
- return unless -e $dir;
- unless (File::Spec->canonpath(File::Basename::dirname($dir))
- eq File::Spec->canonpath($CPAN::Config->{build_dir})) {
- $CPAN::Frontend->mywarn("Directory '$dir' not below $CPAN::Config->{build_dir}, ".
- "will not remove\n");
- $CPAN::Frontend->mysleep(5);
- return;
- }
- $self->debug("have to rmtree $dir, will free $self->{SIZE}{$dir}")
- if $CPAN::DEBUG;
- File::Path::rmtree($dir);
- unlink "$dir.yml"; # may fail
- $self->{DU} -= $self->{SIZE}{$dir};
- delete $self->{SIZE}{$dir};
-}
+ perl -MCPAN -e shell
-#-> sub CPAN::CacheMgr::new ;
-sub new {
- my $class = shift;
- my $time = time;
- my($debug,$t2);
- $debug = "";
- my $self = {
- ID => $CPAN::Config->{build_dir},
- MAX => $CPAN::Config->{'build_cache'},
- SCAN => $CPAN::Config->{'scan_cache'} || 'atstart',
- DU => 0
- };
- File::Path::mkpath($self->{ID});
- my $dh = DirHandle->new($self->{ID});
- bless $self, $class;
- $self->scan_cache;
- $t2 = time;
- $debug .= "timing of CacheMgr->new: ".($t2 - $time);
- $time = $t2;
- CPAN->debug($debug) if $CPAN::DEBUG;
- $self;
-}
+--or--
-#-> sub CPAN::CacheMgr::scan_cache ;
-sub scan_cache {
- my $self = shift;
- return if $self->{SCAN} eq 'never';
- $CPAN::Frontend->mydie("Unknown scan_cache argument: $self->{SCAN}")
- unless $self->{SCAN} eq 'atstart';
- $CPAN::Frontend->myprint(
- sprintf("Scanning cache %s for sizes\n",
- $self->{ID}));
- my $e;
- my @entries = grep { !/^\.\.?$/ } $self->entries($self->{ID});
- my $i = 0;
- my $painted = 0;
- for $e (@entries) {
- # next if $e eq ".." || $e eq ".";
- $self->disk_usage($e);
- $i++;
- while (($painted/76) < ($i/@entries)) {
- $CPAN::Frontend->myprint(".");
- $painted++;
- }
- return if $CPAN::Signal;
- }
- $CPAN::Frontend->myprint("DONE\n");
- $self->tidyup;
-}
+ cpan
-package CPAN::Shell;
-use strict;
+Basic commands:
-#-> sub CPAN::Shell::h ;
-sub h {
- my($class,$about) = @_;
- if (defined $about) {
- $CPAN::Frontend->myprint("Detailed help not yet implemented\n");
- } else {
- my $filler = " " x (80 - 28 - length($CPAN::VERSION));
- $CPAN::Frontend->myprint(qq{
-Display Information $filler (ver $CPAN::VERSION)
- command argument description
- a,b,d,m WORD or /REGEXP/ about authors, bundles, distributions, modules
- i WORD or /REGEXP/ about any of the above
- ls AUTHOR or GLOB about files in the author's directory
- (with WORD being a module, bundle or author name or a distribution
- name of the form AUTHOR/DISTRIBUTION)
-
-Download, Test, Make, Install...
- get download clean make clean
- make make (implies get) look open subshell in dist directory
- test make test (implies make) readme display these README files
- install make install (implies test) perldoc display POD documentation
-
-Upgrade
- r WORDs or /REGEXP/ or NONE report updates for some/matching/all modules
- upgrade WORDs or /REGEXP/ or NONE upgrade some/matching/all modules
-
-Pragmas
- force CMD try hard to do command fforce CMD try harder
- notest CMD skip testing
-
-Other
- h,? display this menu ! perl-code eval a perl command
- o conf [opt] set and query options q quit the cpan shell
- reload cpan load CPAN.pm again reload index load newer indices
- autobundle Snapshot recent latest CPAN uploads});
-}
-}
+ # Modules:
-*help = \&h;
+ cpan> install Acme::Meta # in the shell
-#-> sub CPAN::Shell::a ;
-sub a {
- my($self,@arg) = @_;
- # authors are always UPPERCASE
- for (@arg) {
- $_ = uc $_ unless /=/;
- }
- $CPAN::Frontend->myprint($self->format_result('Author',@arg));
-}
+ CPAN::Shell->install("Acme::Meta"); # in perl
-#-> sub CPAN::Shell::globls ;
-sub globls {
- my($self,$s,$pragmas) = @_;
- # ls is really very different, but we had it once as an ordinary
- # command in the Shell (upto rev. 321) and we could not handle
- # force well then
- my(@accept,@preexpand);
- if ($s =~ /[\*\?\/]/) {
- if ($CPAN::META->has_inst("Text::Glob")) {
- if (my($au,$pathglob) = $s =~ m|(.*?)/(.*)|) {
- my $rau = Text::Glob::glob_to_regex(uc $au);
- CPAN::Shell->debug("au[$au]pathglob[$pathglob]rau[$rau]")
- if $CPAN::DEBUG;
- push @preexpand, map { $_->id . "/" . $pathglob }
- CPAN::Shell->expand_by_method('CPAN::Author',['id'],"/$rau/");
- } else {
- my $rau = Text::Glob::glob_to_regex(uc $s);
- push @preexpand, map { $_->id }
- CPAN::Shell->expand_by_method('CPAN::Author',
- ['id'],
- "/$rau/");
- }
- } else {
- $CPAN::Frontend->mydie("Text::Glob not installed, cannot proceed");
- }
- } else {
- push @preexpand, uc $s;
- }
- for (@preexpand) {
- unless (/^[A-Z0-9\-]+(\/|$)/i) {
- $CPAN::Frontend->mywarn("ls command rejects argument $_: not an author\n");
- next;
- }
- push @accept, $_;
- }
- my $silent = @accept>1;
- my $last_alpha = "";
- my @results;
- for my $a (@accept){
- my($author,$pathglob);
- if ($a =~ m|(.*?)/(.*)|) {
- my $a2 = $1;
- $pathglob = $2;
- $author = CPAN::Shell->expand_by_method('CPAN::Author',
- ['id'],
- $a2)
- or $CPAN::Frontend->mydie("No author found for $a2\n");
- } else {
- $author = CPAN::Shell->expand_by_method('CPAN::Author',
- ['id'],
- $a)
- or $CPAN::Frontend->mydie("No author found for $a\n");
- }
- if ($silent) {
- my $alpha = substr $author->id, 0, 1;
- my $ad;
- if ($alpha eq $last_alpha) {
- $ad = "";
- } else {
- $ad = "[$alpha]";
- $last_alpha = $alpha;
- }
- $CPAN::Frontend->myprint($ad);
- }
- for my $pragma (@$pragmas) {
- if ($author->can($pragma)) {
- $author->$pragma();
- }
- }
- push @results, $author->ls($pathglob,$silent); # silent if
- # more than one
- # author
- for my $pragma (@$pragmas) {
- my $unpragma = "un$pragma";
- if ($author->can($unpragma)) {
- $author->$unpragma();
- }
- }
- }
- @results;
-}
+ # Distributions:
-#-> sub CPAN::Shell::local_bundles ;
-sub local_bundles {
- my($self,@which) = @_;
- my($incdir,$bdir,$dh);
- foreach $incdir ($CPAN::Config->{'cpan_home'},@INC) {
- my @bbase = "Bundle";
- while (my $bbase = shift @bbase) {
- $bdir = File::Spec->catdir($incdir,split /::/, $bbase);
- CPAN->debug("bdir[$bdir]\@bbase[@bbase]") if $CPAN::DEBUG;
- if ($dh = DirHandle->new($bdir)) { # may fail
- my($entry);
- for $entry ($dh->read) {
- next if $entry =~ /^\./;
- next unless $entry =~ /^\w+(\.pm)?(?!\n)\Z/;
- if (-d File::Spec->catdir($bdir,$entry)){
- push @bbase, "$bbase\::$entry";
- } else {
- next unless $entry =~ s/\.pm(?!\n)\Z//;
- $CPAN::META->instance('CPAN::Bundle',"$bbase\::$entry");
- }
- }
- }
- }
- }
-}
+ cpan> install NWCLARK/Acme-Meta-0.02.tar.gz # in the shell
-#-> sub CPAN::Shell::b ;
-sub b {
- my($self,@which) = @_;
- CPAN->debug("which[@which]") if $CPAN::DEBUG;
- $self->local_bundles;
- $CPAN::Frontend->myprint($self->format_result('Bundle',@which));
-}
+ CPAN::Shell->
+ install("NWCLARK/Acme-Meta-0.02.tar.gz"); # in perl
-#-> sub CPAN::Shell::d ;
-sub d { $CPAN::Frontend->myprint(shift->format_result('Distribution',@_));}
+ # module objects:
-#-> sub CPAN::Shell::m ;
-sub m { # emacs confused here }; sub mimimimimi { # emacs in sync here
- my $self = shift;
- $CPAN::Frontend->myprint($self->format_result('Module',@_));
-}
+ $mo = CPAN::Shell->expandany($mod);
+ $mo = CPAN::Shell->expand("Module",$mod); # same thing
-#-> sub CPAN::Shell::i ;
-sub i {
- my($self) = shift;
- my(@args) = @_;
- @args = '/./' unless @args;
- my(@result);
- for my $type (qw/Bundle Distribution Module/) {
- push @result, $self->expand($type,@args);
- }
- # Authors are always uppercase.
- push @result, $self->expand("Author", map { uc $_ } @args);
-
- my $result = @result == 1 ?
- $result[0]->as_string :
- @result == 0 ?
- "No objects found of any type for argument @args\n" :
- join("",
- (map {$_->as_glimpse} @result),
- scalar @result, " items found\n",
- );
- $CPAN::Frontend->myprint($result);
-}
+ # distribution objects:
-#-> sub CPAN::Shell::o ;
-
-# CPAN::Shell::o and CPAN::HandleConfig::edit are closely related. 'o
-# conf' calls through to CPAN::HandleConfig::edit. 'o conf' should
-# probably have been called 'set' and 'o debug' maybe 'set debug' or
-# 'debug'; 'o conf ARGS' calls ->edit in CPAN/HandleConfig.pm
-sub o {
- my($self,$o_type,@o_what) = @_;
- $o_type ||= "";
- CPAN->debug("o_type[$o_type] o_what[".join(" | ",@o_what)."]\n");
- if ($o_type eq 'conf') {
- if (!@o_what) { # print all things, "o conf"
- my($k,$v);
- $CPAN::Frontend->myprint("\$CPAN::Config options from ");
- my @from;
- if (exists $INC{'CPAN/Config.pm'}) {
- push @from, $INC{'CPAN/Config.pm'};
- }
- if (exists $INC{'CPAN/MyConfig.pm'}) {
- push @from, $INC{'CPAN/MyConfig.pm'};
- }
- $CPAN::Frontend->myprint(join " and ", map {"'$_'"} @from);
- $CPAN::Frontend->myprint(":\n");
- for $k (sort keys %CPAN::HandleConfig::can) {
- $v = $CPAN::HandleConfig::can{$k};
- $CPAN::Frontend->myprint(sprintf " %-18s [%s]\n", $k, $v);
- }
- $CPAN::Frontend->myprint("\n");
- for $k (sort keys %$CPAN::Config) {
- CPAN::HandleConfig->prettyprint($k);
- }
- $CPAN::Frontend->myprint("\n");
- } else {
- if (CPAN::HandleConfig->edit(@o_what)) {
- } else {
- $CPAN::Frontend->myprint(qq{Type 'o conf' to view all configuration }.
- qq{items\n\n});
- }
- }
- } elsif ($o_type eq 'debug') {
- my(%valid);
- @o_what = () if defined $o_what[0] && $o_what[0] =~ /help/i;
- if (@o_what) {
- while (@o_what) {
- my($what) = shift @o_what;
- if ($what =~ s/^-// && exists $CPAN::DEBUG{$what}) {
- $CPAN::DEBUG &= $CPAN::DEBUG ^ $CPAN::DEBUG{$what};
- next;
- }
- if ( exists $CPAN::DEBUG{$what} ) {
- $CPAN::DEBUG |= $CPAN::DEBUG{$what};
- } elsif ($what =~ /^\d/) {
- $CPAN::DEBUG = $what;
- } elsif (lc $what eq 'all') {
- my($max) = 0;
- for (values %CPAN::DEBUG) {
- $max += $_;
- }
- $CPAN::DEBUG = $max;
- } else {
- my($known) = 0;
- for (keys %CPAN::DEBUG) {
- next unless lc($_) eq lc($what);
- $CPAN::DEBUG |= $CPAN::DEBUG{$_};
- $known = 1;
- }
- $CPAN::Frontend->myprint("unknown argument [$what]\n")
- unless $known;
- }
- }
- } else {
- my $raw = "Valid options for debug are ".
- join(", ",sort(keys %CPAN::DEBUG), 'all').
- qq{ or a number. Completion works on the options. }.
- qq{Case is ignored.};
- require Text::Wrap;
- $CPAN::Frontend->myprint(Text::Wrap::fill("","",$raw));
- $CPAN::Frontend->myprint("\n\n");
- }
- if ($CPAN::DEBUG) {
- $CPAN::Frontend->myprint("Options set for debugging ($CPAN::DEBUG):\n");
- my($k,$v);
- for $k (sort {$CPAN::DEBUG{$a} <=> $CPAN::DEBUG{$b}} keys %CPAN::DEBUG) {
- $v = $CPAN::DEBUG{$k};
- $CPAN::Frontend->myprint(sprintf " %-14s(%s)\n", $k, $v)
- if $v & $CPAN::DEBUG;
- }
- } else {
- $CPAN::Frontend->myprint("Debugging turned off completely.\n");
- }
- } else {
- $CPAN::Frontend->myprint(qq{
-Known options:
- conf set or get configuration variables
- debug set or get debugging options
-});
- }
-}
+ $do = CPAN::Shell->expand("Module",$mod)->distribution;
+ $do = CPAN::Shell->expandany($distro); # same thing
+ $do = CPAN::Shell->expand("Distribution",
+ $distro); # same thing
-# CPAN::Shell::paintdots_onreload
-sub paintdots_onreload {
- my($ref) = shift;
- sub {
- if ( $_[0] =~ /[Ss]ubroutine ([\w:]+) redefined/ ) {
- my($subr) = $1;
- ++$$ref;
- local($|) = 1;
- # $CPAN::Frontend->myprint(".($subr)");
- $CPAN::Frontend->myprint(".");
- if ($subr =~ /\bshell\b/i) {
- # warn "debug[$_[0]]";
-
- # It would be nice if we could detect that a
- # subroutine has actually changed, but for now we
- # practically always set the GOTOSHELL global
-
- $CPAN::GOTOSHELL=1;
- }
- return;
- }
- warn @_;
- };
-}
+=head1 DESCRIPTION
-#-> sub CPAN::Shell::hosts ;
-sub hosts {
- my($self) = @_;
- my $fullstats = CPAN::FTP->_ftp_statistics();
- my $history = $fullstats->{history} || [];
- my %S; # statistics
- while (my $last = pop @$history) {
- my $attempts = $last->{attempts} or next;
- my $start;
- if (@$attempts) {
- $start = $attempts->[-1]{start};
- if ($#$attempts > 0) {
- for my $i (0..$#$attempts-1) {
- my $url = $attempts->[$i]{url} or next;
- $S{no}{$url}++;
- }
- }
- } else {
- $start = $last->{start};
- }
- next unless $last->{thesiteurl}; # C-C? bad filenames?
- $S{start} = $start;
- $S{end} ||= $last->{end};
- my $dltime = $last->{end} - $start;
- my $dlsize = $last->{filesize} || 0;
- my $url = $last->{thesiteurl}->text;
- my $s = $S{ok}{$url} ||= {};
- $s->{n}++;
- $s->{dlsize} ||= 0;
- $s->{dlsize} += $dlsize/1024;
- $s->{dltime} ||= 0;
- $s->{dltime} += $dltime;
- }
- my $res;
- for my $url (keys %{$S{ok}}) {
- next if $S{ok}{$url}{dltime} == 0; # div by zero
- push @{$res->{ok}}, [@{$S{ok}{$url}}{qw(n dlsize dltime)},
- $S{ok}{$url}{dlsize}/$S{ok}{$url}{dltime},
- $url,
- ];
- }
- for my $url (keys %{$S{no}}) {
- push @{$res->{no}}, [$S{no}{$url},
- $url,
- ];
- }
- my $R = ""; # report
- if ($S{start} && $S{end}) {
- $R .= sprintf "Log starts: %s\n", $S{start} ? scalar(localtime $S{start}) : "unknown";
- $R .= sprintf "Log ends : %s\n", $S{end} ? scalar(localtime $S{end}) : "unknown";
- }
- if ($res->{ok} && @{$res->{ok}}) {
- $R .= sprintf "\nSuccessful downloads:
- N kB secs kB/s url\n";
- my $i = 20;
- for (sort { $b->[3] <=> $a->[3] } @{$res->{ok}}) {
- $R .= sprintf "%4d %8d %5d %9.1f %s\n", @$_;
- last if --$i<=0;
- }
- }
- if ($res->{no} && @{$res->{no}}) {
- $R .= sprintf "\nUnsuccessful downloads:\n";
- my $i = 20;
- for (sort { $b->[0] <=> $a->[0] } @{$res->{no}}) {
- $R .= sprintf "%4d %s\n", @$_;
- last if --$i<=0;
- }
- }
- $CPAN::Frontend->myprint($R);
-}
+The CPAN module automates or at least simplifies the make and install
+of perl modules and extensions. It includes some primitive searching
+capabilities and knows how to use Net::FTP, LWP, and certain external
+download clients to fetch distributions from the net.
-#-> sub CPAN::Shell::reload ;
-sub reload {
- my($self,$command,@arg) = @_;
- $command ||= "";
- $self->debug("self[$self]command[$command]arg[@arg]") if $CPAN::DEBUG;
- if ($command =~ /^cpan$/i) {
- my $redef = 0;
- chdir $CPAN::iCwd if $CPAN::iCwd; # may fail
- my $failed;
- my @relo = (
- "CPAN.pm",
- "CPAN/Debug.pm",
- "CPAN/FirstTime.pm",
- "CPAN/HandleConfig.pm",
- "CPAN/Kwalify.pm",
- "CPAN/Queue.pm",
- "CPAN/Reporter.pm",
- "CPAN/Tarzip.pm",
- "CPAN/Version.pm",
- );
- MFILE: for my $f (@relo) {
- next unless exists $INC{$f};
- my $p = $f;
- $p =~ s/\.pm$//;
- $p =~ s|/|::|g;
- $CPAN::Frontend->myprint("($p");
- local($SIG{__WARN__}) = paintdots_onreload(\$redef);
- $self->_reload_this($f) or $failed++;
- my $v = eval "$p\::->VERSION";
- $CPAN::Frontend->myprint("v$v)");
- }
- $CPAN::Frontend->myprint("\n$redef subroutines redefined\n");
- if ($failed) {
- my $errors = $failed == 1 ? "error" : "errors";
- $CPAN::Frontend->mywarn("\n$failed $errors during reload. You better quit ".
- "this session.\n");
- }
- } elsif ($command =~ /^index$/i) {
- CPAN::Index->force_reload;
- } else {
- $CPAN::Frontend->myprint(qq{cpan re-evals the CPAN modules
-index re-reads the index files\n});
- }
-}
+These are fetched from one or more mirrored CPAN (Comprehensive
+Perl Archive Network) sites and unpacked in a dedicated directory.
-# reload means only load again what we have loaded before
-#-> sub CPAN::Shell::_reload_this ;
-sub _reload_this {
- my($self,$f,$args) = @_;
- CPAN->debug("f[$f]") if $CPAN::DEBUG;
- return 1 unless $INC{$f}; # we never loaded this, so we do not
- # reload but say OK
- my $pwd = CPAN::anycwd();
- CPAN->debug("pwd[$pwd]") if $CPAN::DEBUG;
- my($file);
- for my $inc (@INC) {
- $file = File::Spec->catfile($inc,split /\//, $f);
- last if -f $file;
- $file = "";
- }
- CPAN->debug("file[$file]") if $CPAN::DEBUG;
- my @inc = @INC;
- unless ($file && -f $file) {
- # this thingie is not in the INC path, maybe CPAN/MyConfig.pm?
- $file = $INC{$f};
- unless (CPAN->has_inst("File::Basename")) {
- @inc = File::Basename::dirname($file);
- } else {
- # do we ever need this?
- @inc = substr($file,0,-length($f)-1); # bring in back to me!
- }
- }
- CPAN->debug("file[$file]inc[@inc]") if $CPAN::DEBUG;
- unless (-f $file) {
- $CPAN::Frontend->mywarn("Found no file to reload for '$f'\n");
- return;
- }
- my $mtime = (stat $file)[9];
- $reload->{$f} ||= $^T;
- my $must_reload = $mtime > $reload->{$f};
- $args ||= {};
- $must_reload ||= $args->{reloforce};
- if ($must_reload) {
- my $fh = FileHandle->new($file) or
- $CPAN::Frontend->mydie("Could not open $file: $!");
- local($/);
- local $^W = 1;
- my $content = <$fh>;
- CPAN->debug(sprintf("reload file[%s] content[%s...]",$file,substr($content,0,128)))
- if $CPAN::DEBUG;
- delete $INC{$f};
- local @INC = @inc;
- eval "require '$f'";
- if ($@){
- warn $@;
- return;
- }
- $reload->{$f} = time;
- } else {
- $CPAN::Frontend->myprint("__unchanged__");
- }
- return 1;
-}
+The CPAN module also supports named and versioned
+I<bundles> of modules. Bundles simplify handling of sets of
+related modules. See Bundles below.
-#-> sub CPAN::Shell::mkmyconfig ;
-sub mkmyconfig {
- my($self, $cpanpm, %args) = @_;
- require CPAN::FirstTime;
- my $home = CPAN::HandleConfig::home;
- $cpanpm = $INC{'CPAN/MyConfig.pm'} ||
- File::Spec->catfile(split /\//, "$home/.cpan/CPAN/MyConfig.pm");
- File::Path::mkpath(File::Basename::dirname($cpanpm)) unless -e $cpanpm;
- CPAN::HandleConfig::require_myconfig_or_config;
- $CPAN::Config ||= {};
- $CPAN::Config = {
- %$CPAN::Config,
- build_dir => undef,
- cpan_home => undef,
- keep_source_where => undef,
- histfile => undef,
- };
- CPAN::FirstTime::init($cpanpm, %args);
-}
+The package contains a session manager and a cache manager. The
+session manager keeps track of what has been fetched, built, and
+installed in the current session. The cache manager keeps track of the
+disk space occupied by the make processes and deletes excess space
+using a simple FIFO mechanism.
-#-> sub CPAN::Shell::_binary_extensions ;
-sub _binary_extensions {
- my($self) = shift @_;
- my(@result,$module,%seen,%need,$headerdone);
- for $module ($self->expand('Module','/./')) {
- my $file = $module->cpan_file;
- next if $file eq "N/A";
- next if $file =~ /^Contact Author/;
- my $dist = $CPAN::META->instance('CPAN::Distribution',$file);
- next if $dist->isa_perl;
- next unless $module->xs_file;
- local($|) = 1;
- $CPAN::Frontend->myprint(".");
- push @result, $module;
- }
-# print join " | ", @result;
- $CPAN::Frontend->myprint("\n");
- return @result;
-}
+All methods provided are accessible in a programmer style and in an
+interactive shell style.
-#-> sub CPAN::Shell::recompile ;
-sub recompile {
- my($self) = shift @_;
- my($module,@module,$cpan_file,%dist);
- @module = $self->_binary_extensions();
- for $module (@module){ # we force now and compile later, so we
- # don't do it twice
- $cpan_file = $module->cpan_file;
- my $pack = $CPAN::META->instance('CPAN::Distribution',$cpan_file);
- $pack->force; #
- $dist{$cpan_file}++;
- }
- for $cpan_file (sort keys %dist) {
- $CPAN::Frontend->myprint(" CPAN: Recompiling $cpan_file\n\n");
- my $pack = $CPAN::META->instance('CPAN::Distribution',$cpan_file);
- $pack->install;
- $CPAN::Signal = 0; # it's tempting to reset Signal, so we can
- # stop a package from recompiling,
- # e.g. IO-1.12 when we have perl5.003_10
- }
-}
+=head2 CPAN::shell([$prompt, $command]) Starting Interactive Mode
-#-> sub CPAN::Shell::scripts ;
-sub scripts {
- my($self, $arg) = @_;
- $CPAN::Frontend->mywarn(">>>> experimental command, currently unsupported <<<<\n\n");
+Enter interactive mode by running
- for my $req (qw( HTML::LinkExtor Sort::Versions List::Util )) {
- unless ($CPAN::META->has_inst($req)) {
- $CPAN::Frontend->mywarn(" $req not available\n");
- }
- }
- my $p = HTML::LinkExtor->new();
- my $indexfile = "/home/ftp/pub/PAUSE/scripts/new/index.html";
- unless (-f $indexfile) {
- $CPAN::Frontend->mydie("found no indexfile[$indexfile]\n");
- }
- $p->parse_file($indexfile);
- my @hrefs;
- my $qrarg;
- if ($arg =~ s|^/(.+)/$|$1|) {
- $qrarg = eval 'qr/$arg/'; # hide construct from 5.004
- }
- for my $l ($p->links) {
- my $tag = shift @$l;
- next unless $tag eq "a";
- my %att = @$l;
- my $href = $att{href};
- next unless $href =~ s|^\.\./authors/id/./../||;
- if ($arg) {
- if ($qrarg) {
- if ($href =~ $qrarg) {
- push @hrefs, $href;
- }
- } else {
- if ($href =~ /\Q$arg\E/) {
- push @hrefs, $href;
- }
- }
- } else {
- push @hrefs, $href;
- }
- }
- # now filter for the latest version if there is more than one of a name
- my %stems;
- for (sort @hrefs) {
- my $href = $_;
- s/-v?\d.*//;
- my $stem = $_;
- $stems{$stem} ||= [];
- push @{$stems{$stem}}, $href;
- }
- for (sort keys %stems) {
- my $highest;
- if (@{$stems{$_}} > 1) {
- $highest = List::Util::reduce {
- Sort::Versions::versioncmp($a,$b) > 0 ? $a : $b
- } @{$stems{$_}};
- } else {
- $highest = $stems{$_}[0];
- }
- $CPAN::Frontend->myprint("$highest\n");
- }
-}
+ perl -MCPAN -e shell
-#-> sub CPAN::Shell::report ;
-sub report {
- my($self,@args) = @_;
- unless ($CPAN::META->has_inst("CPAN::Reporter")) {
- $CPAN::Frontend->mydie("CPAN::Reporter not installed; cannot continue");
- }
- local $CPAN::Config->{test_report} = 1;
- $self->force("test",@args); # force is there so that the test be
- # re-run (as documented)
-}
+or
-# experimental (compare with _is_tested)
-#-> sub CPAN::Shell::install_tested
-sub install_tested {
- my($self,@some) = @_;
- $CPAN::Frontend->mywarn("install_tested() must not be called with arguments.\n"),
- return if @some;
- CPAN::Index->reload;
+ cpan
- for my $b (reverse $CPAN::META->_list_sorted_descending_is_tested) {
- my $yaml = "$b.yml";
- unless (-f $yaml){
- $CPAN::Frontend->mywarn("No YAML file for $b available, skipping\n");
- next;
- }
- my $yaml_content = CPAN::_yaml_loadfile($yaml);
- my $id = $yaml_content->[0]{ID};
- unless ($id){
- $CPAN::Frontend->mywarn("No ID found in '$yaml', skipping\n");
- next;
- }
- my $do = CPAN::Shell->expandany($id);
- unless ($do){
- $CPAN::Frontend->mywarn("Could not expand ID '$id', skipping\n");
- next;
- }
- unless ($do->{build_dir}) {
- $CPAN::Frontend->mywarn("Distro '$id' has no build_dir, skipping\n");
- next;
- }
- unless ($do->{build_dir} eq $b) {
- $CPAN::Frontend->mywarn("Distro '$id' has build_dir '$do->{build_dir}' but expected '$b', skipping\n");
- next;
- }
- push @some, $do;
- }
+which puts you into a readline interface. If C<Term::ReadKey> and
+either of C<Term::ReadLine::Perl> or C<Term::ReadLine::Gnu> are installed,
+history and command completion are supported.
- $CPAN::Frontend->mywarn("No tested distributions found.\n"),
- return unless @some;
+Once at the command line, type C<h> for one-page help
+screen; the rest should be self-explanatory.
- @some = grep { $_->{make_test} && ! $_->{make_test}->failed } @some;
- $CPAN::Frontend->mywarn("No distributions tested with this build of perl found.\n"),
- return unless @some;
+The function call C<shell> takes two optional arguments: one the
+prompt, the second the default initial command line (the latter
+only works if a real ReadLine interface module is installed).
- # @some = grep { not $_->uptodate } @some;
- # $CPAN::Frontend->mywarn("No non-uptodate distributions tested with this build of perl found.\n"),
- # return unless @some;
+The most common uses of the interactive modes are
- CPAN->debug("some[@some]");
- for my $d (@some) {
- my $id = $d->can("pretty_id") ? $d->pretty_id : $d->id;
- $CPAN::Frontend->myprint("install_tested: Running for $id\n");
- $CPAN::Frontend->mysleep(1);
- $self->install($d);
- }
-}
+=over 2
-#-> sub CPAN::Shell::upgrade ;
-sub upgrade {
- my($self,@args) = @_;
- $self->install($self->r(@args));
-}
+=item Searching for authors, bundles, distribution files and modules
-#-> sub CPAN::Shell::_u_r_common ;
-sub _u_r_common {
- my($self) = shift @_;
- my($what) = shift @_;
- CPAN->debug("self[$self] what[$what] args[@_]") if $CPAN::DEBUG;
- Carp::croak "Usage: \$obj->_u_r_common(a|r|u)" unless
- $what && $what =~ /^[aru]$/;
- my(@args) = @_;
- @args = '/./' unless @args;
- my(@result,$module,%seen,%need,$headerdone,
- $version_undefs,$version_zeroes);
- $version_undefs = $version_zeroes = 0;
- my $sprintf = "%s%-25s%s %9s %9s %s\n";
- my @expand = $self->expand('Module',@args);
- my $expand = scalar @expand;
- if (0) { # Looks like noise to me, was very useful for debugging
- # for metadata cache
- $CPAN::Frontend->myprint(sprintf "%d matches in the database\n", $expand);
- }
- MODULE: for $module (@expand) {
- my $file = $module->cpan_file;
- next MODULE unless defined $file; # ??
- $file =~ s|^./../||;
- my($latest) = $module->cpan_version;
- my($inst_file) = $module->inst_file;
- my($have);
- return if $CPAN::Signal;
- if ($inst_file){
- if ($what eq "a") {
- $have = $module->inst_version;
- } elsif ($what eq "r") {
- $have = $module->inst_version;
- local($^W) = 0;
- if ($have eq "undef"){
- $version_undefs++;
- } elsif ($have == 0){
- $version_zeroes++;
- }
- next MODULE unless CPAN::Version->vgt($latest, $have);
-# to be pedantic we should probably say:
-# && !($have eq "undef" && $latest ne "undef" && $latest gt "");
-# to catch the case where CPAN has a version 0 and we have a version undef
- } elsif ($what eq "u") {
- next MODULE;
- }
- } else {
- if ($what eq "a") {
- next MODULE;
- } elsif ($what eq "r") {
- next MODULE;
- } elsif ($what eq "u") {
- $have = "-";
- }
- }
- return if $CPAN::Signal; # this is sometimes lengthy
- $seen{$file} ||= 0;
- if ($what eq "a") {
- push @result, sprintf "%s %s\n", $module->id, $have;
- } elsif ($what eq "r") {
- push @result, $module->id;
- next MODULE if $seen{$file}++;
- } elsif ($what eq "u") {
- push @result, $module->id;
- next MODULE if $seen{$file}++;
- next MODULE if $file =~ /^Contact/;
- }
- unless ($headerdone++){
- $CPAN::Frontend->myprint("\n");
- $CPAN::Frontend->myprint(sprintf(
- $sprintf,
- "",
- "Package namespace",
- "",
- "installed",
- "latest",
- "in CPAN file"
- ));
- }
- my $color_on = "";
- my $color_off = "";
- if (
- $COLOR_REGISTERED
- &&
- $CPAN::META->has_inst("Term::ANSIColor")
- &&
- $module->description
- ) {
- $color_on = Term::ANSIColor::color("green");
- $color_off = Term::ANSIColor::color("reset");
- }
- $CPAN::Frontend->myprint(sprintf $sprintf,
- $color_on,
- $module->id,
- $color_off,
- $have,
- $latest,
- $file);
- $need{$module->id}++;
- }
- unless (%need) {
- if ($what eq "u") {
- $CPAN::Frontend->myprint("No modules found for @args\n");
- } elsif ($what eq "r") {
- $CPAN::Frontend->myprint("All modules are up to date for @args\n");
- }
- }
- if ($what eq "r") {
- if ($version_zeroes) {
- my $s_has = $version_zeroes > 1 ? "s have" : " has";
- $CPAN::Frontend->myprint(qq{$version_zeroes installed module$s_has }.
- qq{a version number of 0\n});
- }
- if ($version_undefs) {
- my $s_has = $version_undefs > 1 ? "s have" : " has";
- $CPAN::Frontend->myprint(qq{$version_undefs installed module$s_has no }.
- qq{parseable version number\n});
- }
- }
- @result;
-}
+There are corresponding one-letter commands C<a>, C<b>, C<d>, and C<m>
+for each of the four categories and another, C<i> for any of the
+mentioned four. Each of the four entities is implemented as a class
+with slightly differing methods for displaying an object.
-#-> sub CPAN::Shell::r ;
-sub r {
- shift->_u_r_common("r",@_);
-}
+Arguments to these commands are either strings exactly matching
+the identification string of an object, or regular expressions
+matched case-insensitively against various attributes of the
+objects. The parser only recognizes a regular expression when you
+enclose it with slashes.
-#-> sub CPAN::Shell::u ;
-sub u {
- shift->_u_r_common("u",@_);
-}
+The principle is that the number of objects found influences how an
+item is displayed. If the search finds one item, the result is
+displayed with the rather verbose method C<as_string>, but if
+more than one is found, each object is displayed with the terse method
+C<as_glimpse>.
-#-> sub CPAN::Shell::failed ;
-sub failed {
- my($self,$only_id,$silent) = @_;
- my @failed;
- DIST: for my $d ($CPAN::META->all_objects("CPAN::Distribution")) {
- my $failed = "";
- NAY: for my $nosayer ( # order matters!
- "unwrapped",
- "writemakefile",
- "signature_verify",
- "make",
- "make_test",
- "install",
- "make_clean",
- ) {
- next unless exists $d->{$nosayer};
- next unless defined $d->{$nosayer};
- next unless (
- UNIVERSAL::can($d->{$nosayer},"failed") ?
- $d->{$nosayer}->failed :
- $d->{$nosayer} =~ /^NO/
- );
- next NAY if $only_id && $only_id != (
- UNIVERSAL::can($d->{$nosayer},"commandid")
- ?
- $d->{$nosayer}->commandid
- :
- $CPAN::CurrentCommandId
- );
- $failed = $nosayer;
- last;
- }
- next DIST unless $failed;
- my $id = $d->id;
- $id =~ s|^./../||;
- #$print .= sprintf(
- # " %-45s: %s %s\n",
- push @failed,
- (
- UNIVERSAL::can($d->{$failed},"failed") ?
- [
- $d->{$failed}->commandid,
- $id,
- $failed,
- $d->{$failed}->text,
- $d->{$failed}{TIME}||0,
- ] :
- [
- 1,
- $id,
- $failed,
- $d->{$failed},
- 0,
- ]
- );
- }
- my $scope;
- if ($only_id) {
- $scope = "this command";
- } elsif ($CPAN::Index::HAVE_REANIMATED) {
- $scope = "this or a previous session";
- # it might be nice to have a section for previous session and
- # a second for this
- } else {
- $scope = "this session";
- }
- if (@failed) {
- my $print;
- my $debug = 0;
- if ($debug) {
- $print = join "",
- map { sprintf "%5d %-45s: %s %s\n", @$_ }
- sort { $a->[0] <=> $b->[0] } @failed;
- } else {
- $print = join "",
- map { sprintf " %-45s: %s %s\n", @$_[1..3] }
- sort {
- $a->[0] <=> $b->[0]
- ||
- $a->[4] <=> $b->[4]
- } @failed;
- }
- $CPAN::Frontend->myprint("Failed during $scope:\n$print");
- } elsif (!$only_id || !$silent) {
- $CPAN::Frontend->myprint("Nothing failed in $scope\n");
- }
-}
+Examples:
-# XXX intentionally undocumented because completely bogus, unportable,
-# useless, etc.
+ cpan> m Acme::MetaSyntactic
+ Module id = Acme::MetaSyntactic
+ CPAN_USERID BOOK (Philippe Bruhat (BooK) <[...]>)
+ CPAN_VERSION 0.99
+ CPAN_FILE B/BO/BOOK/Acme-MetaSyntactic-0.99.tar.gz
+ UPLOAD_DATE 2006-11-06
+ MANPAGE Acme::MetaSyntactic - Themed metasyntactic variables names
+ INST_FILE /usr/local/lib/perl/5.10.0/Acme/MetaSyntactic.pm
+ INST_VERSION 0.99
+ cpan> a BOOK
+ Author id = BOOK
+ EMAIL [...]
+ FULLNAME Philippe Bruhat (BooK)
+ cpan> d BOOK/Acme-MetaSyntactic-0.99.tar.gz
+ Distribution id = B/BO/BOOK/Acme-MetaSyntactic-0.99.tar.gz
+ CPAN_USERID BOOK (Philippe Bruhat (BooK) <[...]>)
+ CONTAINSMODS Acme::MetaSyntactic Acme::MetaSyntactic::Alias [...]
+ UPLOAD_DATE 2006-11-06
+ cpan> m /lorem/
+ Module = Acme::MetaSyntactic::loremipsum (BOOK/Acme-MetaSyntactic-0.99.tar.gz)
+ Module Text::Lorem (ADEOLA/Text-Lorem-0.3.tar.gz)
+ Module Text::Lorem::More (RKRIMEN/Text-Lorem-More-0.12.tar.gz)
+ Module Text::Lorem::More::Source (RKRIMEN/Text-Lorem-More-0.12.tar.gz)
+ cpan> i /berlin/
+ Distribution BEATNIK/Filter-NumberLines-0.02.tar.gz
+ Module = DateTime::TimeZone::Europe::Berlin (DROLSKY/DateTime-TimeZone-0.7904.tar.gz)
+ Module Filter::NumberLines (BEATNIK/Filter-NumberLines-0.02.tar.gz)
+ Author [...]
+
+The examples illustrate several aspects: the first three queries
+target modules, authors, or distros directly and yield exactly one
+result. The last two use regular expressions and yield several
+results. The last one targets all of bundles, modules, authors, and
+distros simultaneously. When more than one result is available, they
+are printed in one-line format.
+
+=item C<get>, C<make>, C<test>, C<install>, C<clean> modules or distributions
-#-> sub CPAN::Shell::status ;
-sub status {
- my($self) = @_;
- require Devel::Size;
- my $ps = FileHandle->new;
- open $ps, "/proc/$$/status";
- my $vm = 0;
- while (<$ps>) {
- next unless /VmSize:\s+(\d+)/;
- $vm = $1;
- last;
- }
- $CPAN::Frontend->mywarn(sprintf(
- "%-27s %6d\n%-27s %6d\n",
- "vm",
- $vm,
- "CPAN::META",
- Devel::Size::total_size($CPAN::META)/1024,
- ));
- for my $k (sort keys %$CPAN::META) {
- next unless substr($k,0,4) eq "read";
- warn sprintf " %-26s %6d\n", $k, Devel::Size::total_size($CPAN::META->{$k})/1024;
- for my $k2 (sort keys %{$CPAN::META->{$k}}) {
- warn sprintf " %-25s %6d (keys: %6d)\n",
- $k2,
- Devel::Size::total_size($CPAN::META->{$k}{$k2})/1024,
- scalar keys %{$CPAN::META->{$k}{$k2}};
- }
- }
-}
+These commands take any number of arguments and investigate what is
+necessary to perform the action. If the argument is a distribution
+file name (recognized by embedded slashes), it is processed. If it is
+a module, CPAN determines the distribution file in which this module
+is included and processes that, following any dependencies named in
+the module's META.yml or Makefile.PL (this behavior is controlled by
+the configuration parameter C<prerequisites_policy>.)
-# experimental (must run after failed or similar [I think])
-# intended as a preparation ot install_tested
-#-> sub CPAN::Shell::is_tested
-sub _is_tested {
- my($self) = @_;
- for my $b (reverse $CPAN::META->_list_sorted_descending_is_tested) {
- my $time;
- if ($CPAN::META->{is_tested}{$b}) {
- $time = scalar(localtime $CPAN::META->{is_tested}{$b});
- } else {
- $time = scalar localtime;
- $time =~ s/\S/?/g;
- }
- $CPAN::Frontend->myprint(sprintf "%s %s\n", $time, $b);
- }
-}
+C<get> downloads a distribution file and untars or unzips it, C<make>
+builds it, C<test> runs the test suite, and C<install> installs it.
-#-> sub CPAN::Shell::autobundle ;
-sub autobundle {
- my($self) = shift;
- CPAN::HandleConfig->load unless $CPAN::Config_loaded++;
- my(@bundle) = $self->_u_r_common("a",@_);
- my($todir) = File::Spec->catdir($CPAN::Config->{'cpan_home'},"Bundle");
- File::Path::mkpath($todir);
- unless (-d $todir) {
- $CPAN::Frontend->myprint("Couldn't mkdir $todir for some reason\n");
- return;
- }
- my($y,$m,$d) = (localtime)[5,4,3];
- $y+=1900;
- $m++;
- my($c) = 0;
- my($me) = sprintf "Snapshot_%04d_%02d_%02d_%02d", $y, $m, $d, $c;
- my($to) = File::Spec->catfile($todir,"$me.pm");
- while (-f $to) {
- $me = sprintf "Snapshot_%04d_%02d_%02d_%02d", $y, $m, $d, ++$c;
- $to = File::Spec->catfile($todir,"$me.pm");
- }
- my($fh) = FileHandle->new(">$to") or Carp::croak "Can't open >$to: $!";
- $fh->print(
- "package Bundle::$me;\n\n",
- "\$VERSION = '0.01';\n\n",
- "1;\n\n",
- "__END__\n\n",
- "=head1 NAME\n\n",
- "Bundle::$me - Snapshot of installation on ",
- $Config::Config{'myhostname'},
- " on ",
- scalar(localtime),
- "\n\n=head1 SYNOPSIS\n\n",
- "perl -MCPAN -e 'install Bundle::$me'\n\n",
- "=head1 CONTENTS\n\n",
- join("\n", @bundle),
- "\n\n=head1 CONFIGURATION\n\n",
- Config->myconfig,
- "\n\n=head1 AUTHOR\n\n",
- "This Bundle has been generated automatically ",
- "by the autobundle routine in CPAN.pm.\n",
- );
- $fh->close;
- $CPAN::Frontend->myprint("\nWrote bundle file
- $to\n\n");
-}
+Any C<make> or C<test> is run unconditionally. An
-#-> sub CPAN::Shell::expandany ;
-sub expandany {
- my($self,$s) = @_;
- CPAN->debug("s[$s]") if $CPAN::DEBUG;
- if ($s =~ m|/| or substr($s,-1,1) eq ".") { # looks like a file or a directory
- $s = CPAN::Distribution->normalize($s);
- return $CPAN::META->instance('CPAN::Distribution',$s);
- # Distributions spring into existence, not expand
- } elsif ($s =~ m|^Bundle::|) {
- $self->local_bundles; # scanning so late for bundles seems
- # both attractive and crumpy: always
- # current state but easy to forget
- # somewhere
- return $self->expand('Bundle',$s);
- } else {
- return $self->expand('Module',$s)
- if $CPAN::META->exists('CPAN::Module',$s);
- }
- return;
-}
+ install <distribution_file>
-#-> sub CPAN::Shell::expand ;
-sub expand {
- my $self = shift;
- my($type,@args) = @_;
- CPAN->debug("type[$type]args[@args]") if $CPAN::DEBUG;
- my $class = "CPAN::$type";
- my $methods = ['id'];
- for my $meth (qw(name)) {
- next unless $class->can($meth);
- push @$methods, $meth;
- }
- $self->expand_by_method($class,$methods,@args);
-}
+is also run unconditionally. But for
-#-> sub CPAN::Shell::expand_by_method ;
-sub expand_by_method {
- my $self = shift;
- my($class,$methods,@args) = @_;
- my($arg,@m);
- for $arg (@args) {
- my($regex,$command);
- if ($arg =~ m|^/(.*)/$|) {
- $regex = $1;
- } elsif ($arg =~ m/=/) {
- $command = 1;
- }
- my $obj;
- CPAN->debug(sprintf "class[%s]regex[%s]command[%s]",
- $class,
- defined $regex ? $regex : "UNDEFINED",
- defined $command ? $command : "UNDEFINED",
- ) if $CPAN::DEBUG;
- if (defined $regex) {
- if (CPAN::_sqlite_running) {
- $CPAN::SQLite->search($class, $regex);
- }
- for $obj (
- $CPAN::META->all_objects($class)
- ) {
- unless ($obj && UNIVERSAL::can($obj,"id") && $obj->id){
- # BUG, we got an empty object somewhere
- require Data::Dumper;
- CPAN->debug(sprintf(
- "Bug in CPAN: Empty id on obj[%s][%s]",
- $obj,
- Data::Dumper::Dumper($obj)
- )) if $CPAN::DEBUG;
- next;
- }
- for my $method (@$methods) {
- my $match = eval {$obj->$method() =~ /$regex/i};
- if ($@) {
- my($err) = $@ =~ /^(.+) at .+? line \d+\.$/;
- $err ||= $@; # if we were too restrictive above
- $CPAN::Frontend->mydie("$err\n");
- } elsif ($match) {
- push @m, $obj;
- last;
- }
- }
- }
- } elsif ($command) {
- die "equal sign in command disabled (immature interface), ".
- "you can set
- ! \$CPAN::Shell::ADVANCED_QUERY=1
-to enable it. But please note, this is HIGHLY EXPERIMENTAL code
-that may go away anytime.\n"
- unless $ADVANCED_QUERY;
- my($method,$criterion) = $arg =~ /(.+?)=(.+)/;
- my($matchcrit) = $criterion =~ m/^~(.+)/;
- for my $self (
- sort
- {$a->id cmp $b->id}
- $CPAN::META->all_objects($class)
- ) {
- my $lhs = $self->$method() or next; # () for 5.00503
- if ($matchcrit) {
- push @m, $self if $lhs =~ m/$matchcrit/;
- } else {
- push @m, $self if $lhs eq $criterion;
- }
- }
- } else {
- my($xarg) = $arg;
- if ( $class eq 'CPAN::Bundle' ) {
- $xarg =~ s/^(Bundle::)?(.*)/Bundle::$2/;
- } elsif ($class eq "CPAN::Distribution") {
- $xarg = CPAN::Distribution->normalize($arg);
- } else {
- $xarg =~ s/:+/::/g;
- }
- if ($CPAN::META->exists($class,$xarg)) {
- $obj = $CPAN::META->instance($class,$xarg);
- } elsif ($CPAN::META->exists($class,$arg)) {
- $obj = $CPAN::META->instance($class,$arg);
- } else {
- next;
- }
- push @m, $obj;
- }
- }
- @m = sort {$a->id cmp $b->id} @m;
- if ( $CPAN::DEBUG ) {
- my $wantarray = wantarray;
- my $join_m = join ",", map {$_->id} @m;
- $self->debug("wantarray[$wantarray]join_m[$join_m]");
- }
- return wantarray ? @m : $m[0];
-}
+ install <module>
-#-> sub CPAN::Shell::format_result ;
-sub format_result {
- my($self) = shift;
- my($type,@args) = @_;
- @args = '/./' unless @args;
- my(@result) = $self->expand($type,@args);
- my $result = @result == 1 ?
- $result[0]->as_string :
- @result == 0 ?
- "No objects of type $type found for argument @args\n" :
- join("",
- (map {$_->as_glimpse} @result),
- scalar @result, " items found\n",
- );
- $result;
-}
+CPAN checks whether an install is needed and prints
+I<module up to date> if the distribution file containing
+the module doesn't need updating.
-#-> sub CPAN::Shell::report_fh ;
-{
- my $installation_report_fh;
- my $previously_noticed = 0;
-
- sub report_fh {
- return $installation_report_fh if $installation_report_fh;
- if ($CPAN::META->has_inst("File::Temp")) {
- $installation_report_fh
- = File::Temp->new(
- template => 'cpan_install_XXXX',
- suffix => '.txt',
- unlink => 0,
- );
- }
- unless ( $installation_report_fh ) {
- warn("Couldn't open installation report file; " .
- "no report file will be generated."
- ) unless $previously_noticed++;
- }
- }
-}
+CPAN also keeps track of what it has done within the current session
+and doesn't try to build a package a second time regardless of whether it
+succeeded or not. It does not repeat a test run if the test
+has been run successfully before. Same for install runs.
+The C<force> pragma may precede another command (currently: C<get>,
+C<make>, C<test>, or C<install>) to execute the command from scratch
+and attempt to continue past certain errors. See the section below on
+the C<force> and the C<fforce> pragma.
-# The only reason for this method is currently to have a reliable
-# debugging utility that reveals which output is going through which
-# channel. No, I don't like the colors ;-)
+The C<notest> pragma skips the test part in the build
+process.
-# to turn colordebugging on, write
-# cpan> o conf colorize_output 1
+Example:
-#-> sub CPAN::Shell::print_ornamented ;
-{
- my $print_ornamented_have_warned = 0;
- sub colorize_output {
- my $colorize_output = $CPAN::Config->{colorize_output};
- if ($colorize_output && !$CPAN::META->has_inst("Term::ANSIColor")) {
- unless ($print_ornamented_have_warned++) {
- # no myprint/mywarn within myprint/mywarn!
- warn "Colorize_output is set to true but Term::ANSIColor is not
-installed. To activate colorized output, please install Term::ANSIColor.\n\n";
- }
- $colorize_output = 0;
- }
- return $colorize_output;
- }
-}
+ cpan> notest install Tk
+A C<clean> command results in a
-#-> sub CPAN::Shell::print_ornamented ;
-sub print_ornamented {
- my($self,$what,$ornament) = @_;
- return unless defined $what;
+ make clean
- local $| = 1; # Flush immediately
- if ( $CPAN::Be_Silent ) {
- print {report_fh()} $what;
- return;
- }
- my $swhat = "$what"; # stringify if it is an object
- if ($CPAN::Config->{term_is_latin}){
- # courtesy jhi:
- $swhat
- =~ s{([\xC0-\xDF])([\x80-\xBF])}{chr(ord($1)<<6&0xC0|ord($2)&0x3F)}eg; #};
- }
- if ($self->colorize_output) {
- if ( $CPAN::DEBUG && $swhat =~ /^Debug\(/ ) {
- # if you want to have this configurable, please file a bugreport
- $ornament = $CPAN::Config->{colorize_debug} || "black on_cyan";
- }
- my $color_on = eval { Term::ANSIColor::color($ornament) } || "";
- if ($@) {
- print "Term::ANSIColor rejects color[$ornament]: $@\n
-Please choose a different color (Hint: try 'o conf init color.*')\n";
- }
- print $color_on,
- $swhat,
- Term::ANSIColor::color("reset");
- } else {
- print $swhat;
- }
-}
+being executed within the distribution file's working directory.
-#-> sub CPAN::Shell::myprint ;
+=item C<readme>, C<perldoc>, C<look> module or distribution
-# where is myprint/mywarn/Frontend/etc. documented? We need guidelines
-# where to use what! I think, we send everything to STDOUT and use
-# print for normal/good news and warn for news that need more
-# attention. Yes, this is our working contract for now.
-sub myprint {
- my($self,$what) = @_;
+C<readme> displays the README file of the associated distribution.
+C<Look> gets and untars (if not yet done) the distribution file,
+changes to the appropriate directory and opens a subshell process in
+that directory. C<perldoc> displays the module's pod documentation
+in html or plain text format.
- $self->print_ornamented($what, $CPAN::Config->{colorize_print}||'bold blue on_white');
-}
+=item C<ls> author
-#-> sub CPAN::Shell::myexit ;
-sub myexit {
- my($self,$what) = @_;
- $self->myprint($what);
- exit;
-}
+=item C<ls> globbing_expression
-#-> sub CPAN::Shell::mywarn ;
-sub mywarn {
- my($self,$what) = @_;
- $self->print_ornamented($what, $CPAN::Config->{colorize_warn}||'bold red on_white');
-}
+The first form lists all distribution files in and below an author's
+CPAN directory as stored in the CHECKUMS files distributed on
+CPAN. The listing recurses into subdirectories.
-# only to be used for shell commands
-#-> sub CPAN::Shell::mydie ;
-sub mydie {
- my($self,$what) = @_;
- $self->print_ornamented($what, $CPAN::Config->{colorize_warn}||'bold red on_white');
+The second form limits or expands the output with shell
+globbing as in the following examples:
- # If it is the shell, we want that the following die to be silent,
- # but if it is not the shell, we would need a 'die $what'. We need
- # to take care that only shell commands use mydie. Is this
- # possible?
+ ls JV/make*
+ ls GSAR/*make*
+ ls */*make*
- die "\n";
-}
+The last example is very slow and outputs extra progress indicators
+that break the alignment of the result.
-# sub CPAN::Shell::colorable_makemaker_prompt ;
-sub colorable_makemaker_prompt {
- my($foo,$bar) = @_;
- if (CPAN::Shell->colorize_output) {
- my $ornament = $CPAN::Config->{colorize_print}||'bold blue on_white';
- my $color_on = eval { Term::ANSIColor::color($ornament); } || "";
- print $color_on;
- }
- my $ans = ExtUtils::MakeMaker::prompt($foo,$bar);
- if (CPAN::Shell->colorize_output) {
- print Term::ANSIColor::color('reset');
- }
- return $ans;
-}
-
-# use this only for unrecoverable errors!
-#-> sub CPAN::Shell::unrecoverable_error ;
-sub unrecoverable_error {
- my($self,$what) = @_;
- my @lines = split /\n/, $what;
- my $longest = 0;
- for my $l (@lines) {
- $longest = length $l if length $l > $longest;
- }
- $longest = 62 if $longest > 62;
- for my $l (@lines) {
- if ($l =~ /^\s*$/){
- $l = "\n";
- next;
- }
- $l = "==> $l";
- if (length $l < 66) {
- $l = pack "A66 A*", $l, "<==";
- }
- $l .= "\n";
- }
- unshift @lines, "\n";
- $self->mydie(join "", @lines);
-}
+Note that globbing only lists directories explicitly asked for, for
+example FOO/* will not list FOO/bar/Acme-Sthg-n.nn.tar.gz. This may be
+regarded as a bug that may be changed in some future version.
-#-> sub CPAN::Shell::mysleep ;
-sub mysleep {
- my($self, $sleep) = @_;
- sleep $sleep;
-}
+=item C<failed>
-#-> sub CPAN::Shell::setup_output ;
-sub setup_output {
- return if -t STDOUT;
- my $odef = select STDERR;
- $| = 1;
- select STDOUT;
- $| = 1;
- select $odef;
-}
+The C<failed> command reports all distributions that failed on one of
+C<make>, C<test> or C<install> for some reason in the currently
+running shell session.
-#-> sub CPAN::Shell::rematein ;
-# RE-adme||MA-ke||TE-st||IN-stall : nearly everything runs through here
-sub rematein {
- my $self = shift;
- my($meth,@some) = @_;
- my @pragma;
- while($meth =~ /^(ff?orce|notest)$/) {
- push @pragma, $meth;
- $meth = shift @some or
- $CPAN::Frontend->mydie("Pragma $pragma[-1] used without method: ".
- "cannot continue");
- }
- setup_output();
- CPAN->debug("pragma[@pragma]meth[$meth]some[@some]") if $CPAN::DEBUG;
-
- # Here is the place to set "test_count" on all involved parties to
- # 0. We then can pass this counter on to the involved
- # distributions and those can refuse to test if test_count > X. In
- # the first stab at it we could use a 1 for "X".
-
- # But when do I reset the distributions to start with 0 again?
- # Jost suggested to have a random or cycling interaction ID that
- # we pass through. But the ID is something that is just left lying
- # around in addition to the counter, so I'd prefer to set the
- # counter to 0 now, and repeat at the end of the loop. But what
- # about dependencies? They appear later and are not reset, they
- # enter the queue but not its copy. How do they get a sensible
- # test_count?
-
- # construct the queue
- my($s,@s,@qcopy);
- STHING: foreach $s (@some) {
- my $obj;
- if (ref $s) {
- CPAN->debug("s is an object[$s]") if $CPAN::DEBUG;
- $obj = $s;
- } elsif ($s =~ m|[\$\@\%]|) { # looks like a perl variable
- } elsif ($s =~ m|^/|) { # looks like a regexp
- if (substr($s,-1,1) eq ".") {
- $obj = CPAN::Shell->expandany($s);
- } else {
- $CPAN::Frontend->mywarn("Sorry, $meth with a regular expression is ".
- "not supported.\nRejecting argument '$s'\n");
- $CPAN::Frontend->mysleep(2);
- next;
- }
- } elsif ($meth eq "ls") {
- $self->globls($s,\@pragma);
- next STHING;
- } else {
- CPAN->debug("calling expandany [$s]") if $CPAN::DEBUG;
- $obj = CPAN::Shell->expandany($s);
- }
- if (0) {
- } elsif (ref $obj) {
- $obj->color_cmd_tmps(0,1);
- CPAN::Queue->new(qmod => $obj->id, reqtype => "c");
- push @qcopy, $obj;
- } elsif ($CPAN::META->exists('CPAN::Author',uc($s))) {
- $obj = $CPAN::META->instance('CPAN::Author',uc($s));
- if ($meth =~ /^(dump|ls)$/) {
- $obj->$meth();
- } else {
- $CPAN::Frontend->mywarn(
- join "",
- "Don't be silly, you can't $meth ",
- $obj->fullname,
- " ;-)\n"
- );
- $CPAN::Frontend->mysleep(2);
- }
- } elsif ($s =~ m|[\$\@\%]| && $meth eq "dump") {
- CPAN::InfoObj->dump($s);
- } else {
- $CPAN::Frontend
- ->mywarn(qq{Warning: Cannot $meth $s, }.
- qq{don't know what it is.
-Try the command
+=item Persistence between sessions
- i /$s/
+If the C<YAML> or the C<YAML::Syck> module is installed a record of
+the internal state of all modules is written to disk after each step.
+The files contain a signature of the currently running perl version
+for later perusal.
-to find objects with matching identifiers.
-});
- $CPAN::Frontend->mysleep(2);
- }
- }
+If the configurations variable C<build_dir_reuse> is set to a true
+value, then CPAN.pm reads the collected YAML files. If the stored
+signature matches the currently running perl, the stored state is
+loaded into memory such that persistence between sessions
+is effectively established.
- # queuerunner (please be warned: when I started to change the
- # queue to hold objects instead of names, I made one or two
- # mistakes and never found which. I reverted back instead)
- while (my $q = CPAN::Queue->first) {
- my $obj;
- my $s = $q->as_string;
- my $reqtype = $q->reqtype || "";
- $obj = CPAN::Shell->expandany($s);
- $obj->{reqtype} ||= "";
- {
- # force debugging because CPAN::SQLite somehow delivers us
- # an empty object;
-
- # local $CPAN::DEBUG = 1024; # Shell; probably fixed now
-
- CPAN->debug("s[$s]obj-reqtype[$obj->{reqtype}]".
- "q-reqtype[$reqtype]") if $CPAN::DEBUG;
- }
- if ($obj->{reqtype}) {
- if ($obj->{reqtype} eq "b" && $reqtype =~ /^[rc]$/) {
- $obj->{reqtype} = $reqtype;
- if (
- exists $obj->{install}
- &&
- (
- UNIVERSAL::can($obj->{install},"failed") ?
- $obj->{install}->failed :
- $obj->{install} =~ /^NO/
- )
- ) {
- delete $obj->{install};
- $CPAN::Frontend->mywarn
- ("Promoting $obj->{ID} from 'build_requires' to 'requires'");
- }
- }
- } else {
- $obj->{reqtype} = $reqtype;
- }
+=item The C<force> and the C<fforce> pragma
- for my $pragma (@pragma) {
- if ($pragma
- &&
- $obj->can($pragma)){
- $obj->$pragma($meth);
- }
- }
- if (UNIVERSAL::can($obj, 'called_for')) {
- $obj->called_for($s);
- }
- CPAN->debug(qq{pragma[@pragma]meth[$meth]}.
- qq{ID[$obj->{ID}]}) if $CPAN::DEBUG;
-
- push @qcopy, $obj;
- if (! UNIVERSAL::can($obj,$meth)) {
- # Must never happen
- my $serialized = "";
- if (0) {
- } elsif ($CPAN::META->has_inst("YAML::Syck")) {
- $serialized = YAML::Syck::Dump($obj);
- } elsif ($CPAN::META->has_inst("YAML")) {
- $serialized = YAML::Dump($obj);
- } elsif ($CPAN::META->has_inst("Data::Dumper")) {
- $serialized = Data::Dumper::Dumper($obj);
- } else {
- require overload;
- $serialized = overload::StrVal($obj);
- }
- $CPAN::Frontend->mydie("Panic: obj[$serialized] cannot meth[$meth]");
- } elsif ($obj->$meth()){
- CPAN::Queue->delete($s);
- } else {
- CPAN->debug("failed");
- }
+To speed things up in complex installation scenarios, CPAN.pm keeps
+track of what it has already done and refuses to do some things a
+second time. A C<get>, a C<make>, and an C<install> are not repeated.
+A C<test> is repeated only if the previous test was unsuccessful. The
+diagnostic message when CPAN.pm refuses to do something a second time
+is one of I<Has already been >C<unwrapped|made|tested successfully> or
+something similar. Another situation where CPAN refuses to act is an
+C<install> if the corresponding C<test> was not successful.
- $obj->undelay;
- for my $pragma (@pragma) {
- my $unpragma = "un$pragma";
- if ($obj->can($unpragma)) {
- $obj->$unpragma();
- }
- }
- CPAN::Queue->delete_first($s);
- }
- for my $obj (@qcopy) {
- $obj->color_cmd_tmps(0,0);
- }
-}
+In all these cases, the user can override this stubborn behaviour by
+prepending the command with the word force, for example:
-#-> sub CPAN::Shell::recent ;
-sub recent {
- my($self) = @_;
+ cpan> force get Foo
+ cpan> force make AUTHOR/Bar-3.14.tar.gz
+ cpan> force test Baz
+ cpan> force install Acme::Meta
- CPAN::Distribution::_display_url( $self, $CPAN::Defaultrecent );
- return;
-}
+Each I<forced> command is executed with the corresponding part of its
+memory erased.
-{
- # set up the dispatching methods
- no strict "refs";
- for my $command (qw(
- clean
- cvs_import
- dump
- force
- fforce
- get
- install
- look
- ls
- make
- notest
- perldoc
- readme
- test
- )) {
- *$command = sub { shift->rematein($command, @_); };
- }
-}
+The C<fforce> pragma is a variant that emulates a C<force get> which
+erases the entire memory followed by the action specified, effectively
+restarting the whole get/make/test/install procedure from scratch.
-package CPAN::LWP::UserAgent;
-use strict;
+=item Lockfile
-sub config {
- return if $SETUPDONE;
- if ($CPAN::META->has_usable('LWP::UserAgent')) {
- require LWP::UserAgent;
- @ISA = qw(Exporter LWP::UserAgent);
- $SETUPDONE++;
- } else {
- $CPAN::Frontend->mywarn(" LWP::UserAgent not available\n");
- }
-}
+Interactive sessions maintain a lockfile, by default C<~/.cpan/.lock>.
+Batch jobs can run without a lockfile and not disturb each other.
-sub get_basic_credentials {
- my($self, $realm, $uri, $proxy) = @_;
- if ($USER && $PASSWD) {
- return ($USER, $PASSWD);
- }
- if ( $proxy ) {
- ($USER,$PASSWD) = $self->get_proxy_credentials();
- } else {
- ($USER,$PASSWD) = $self->get_non_proxy_credentials();
- }
- return($USER,$PASSWD);
-}
+The shell offers to run in I<downgraded mode> when another process is
+holding the lockfile. This is an experimental feature that is not yet
+tested very well. This second shell then does not write the history
+file, does not use the metadata file, and has a different prompt.
-sub get_proxy_credentials {
- my $self = shift;
- my ($user, $password);
- if ( defined $CPAN::Config->{proxy_user} &&
- defined $CPAN::Config->{proxy_pass}) {
- $user = $CPAN::Config->{proxy_user};
- $password = $CPAN::Config->{proxy_pass};
- return ($user, $password);
- }
- my $username_prompt = "\nProxy authentication needed!
- (Note: to permanently configure username and password run
- o conf proxy_user your_username
- o conf proxy_pass your_password
- )\nUsername:";
- ($user, $password) =
- _get_username_and_password_from_user($username_prompt);
- return ($user,$password);
-}
+=item Signals
-sub get_non_proxy_credentials {
- my $self = shift;
- my ($user,$password);
- if ( defined $CPAN::Config->{username} &&
- defined $CPAN::Config->{password}) {
- $user = $CPAN::Config->{username};
- $password = $CPAN::Config->{password};
- return ($user, $password);
- }
- my $username_prompt = "\nAuthentication needed!
- (Note: to permanently configure username and password run
- o conf username your_username
- o conf password your_password
- )\nUsername:";
-
- ($user, $password) =
- _get_username_and_password_from_user($username_prompt);
- return ($user,$password);
-}
+CPAN.pm installs signal handlers for SIGINT and SIGTERM. While you are
+in the cpan-shell, it is intended that you can press C<^C> anytime and
+return to the cpan-shell prompt. A SIGTERM will cause the cpan-shell
+to clean up and leave the shell loop. You can emulate the effect of a
+SIGTERM by sending two consecutive SIGINTs, which usually means by
+pressing C<^C> twice.
-sub _get_username_and_password_from_user {
- my $username_message = shift;
- my ($username,$password);
+CPAN.pm ignores SIGPIPE. If the user sets C<inactivity_timeout>, a
+SIGALRM is used during the run of the C<perl Makefile.PL> or C<perl
+Build.PL> subprocess.
- ExtUtils::MakeMaker->import(qw(prompt));
- $username = prompt($username_message);
- if ($CPAN::META->has_inst("Term::ReadKey")) {
- Term::ReadKey::ReadMode("noecho");
- }
- else {
- $CPAN::Frontend->mywarn(
- "Warning: Term::ReadKey seems not to be available, your password will be echoed to the terminal!\n"
- );
- }
- $password = prompt("Password:");
+=back
- if ($CPAN::META->has_inst("Term::ReadKey")) {
- Term::ReadKey::ReadMode("restore");
- }
- $CPAN::Frontend->myprint("\n\n");
- return ($username,$password);
-}
+=head2 CPAN::Shell
-# mirror(): Its purpose is to deal with proxy authentication. When we
-# call SUPER::mirror, we relly call the mirror method in
-# LWP::UserAgent. LWP::UserAgent will then call
-# $self->get_basic_credentials or some equivalent and this will be
-# $self->dispatched to our own get_basic_credentials method.
-
-# Our own get_basic_credentials sets $USER and $PASSWD, two globals.
-
-# 407 stands for HTTP_PROXY_AUTHENTICATION_REQUIRED. Which means
-# although we have gone through our get_basic_credentials, the proxy
-# server refuses to connect. This could be a case where the username or
-# password has changed in the meantime, so I'm trying once again without
-# $USER and $PASSWD to give the get_basic_credentials routine another
-# chance to set $USER and $PASSWD.
-
-# mirror(): Its purpose is to deal with proxy authentication. When we
-# call SUPER::mirror, we relly call the mirror method in
-# LWP::UserAgent. LWP::UserAgent will then call
-# $self->get_basic_credentials or some equivalent and this will be
-# $self->dispatched to our own get_basic_credentials method.
-
-# Our own get_basic_credentials sets $USER and $PASSWD, two globals.
-
-# 407 stands for HTTP_PROXY_AUTHENTICATION_REQUIRED. Which means
-# although we have gone through our get_basic_credentials, the proxy
-# server refuses to connect. This could be a case where the username or
-# password has changed in the meantime, so I'm trying once again without
-# $USER and $PASSWD to give the get_basic_credentials routine another
-# chance to set $USER and $PASSWD.
-
-sub mirror {
- my($self,$url,$aslocal) = @_;
- my $result = $self->SUPER::mirror($url,$aslocal);
- if ($result->code == 407) {
- undef $USER;
- undef $PASSWD;
- $result = $self->SUPER::mirror($url,$aslocal);
- }
- $result;
-}
+The commands available in the shell interface are methods in
+the package CPAN::Shell. If you enter the shell command, your
+input is split by the Text::ParseWords::shellwords() routine, which
+acts like most shells do. The first word is interpreted as the
+method to be invoked, and the rest of the words are treated as the method's arguments.
+Continuation lines are supported by ending a line with a
+literal backslash.
-package CPAN::FTP;
-use strict;
+=head2 autobundle
-#-> sub CPAN::FTP::ftp_statistics
-# if they want to rewrite, they need to pass in a filehandle
-sub _ftp_statistics {
- my($self,$fh) = @_;
- my $locktype = $fh ? LOCK_EX : LOCK_SH;
- $fh ||= FileHandle->new;
- my $file = File::Spec->catfile($CPAN::Config->{cpan_home},"FTPstats.yml");
- open $fh, "+>>$file" or $CPAN::Frontend->mydie("Could not open '$file': $!");
- my $sleep = 1;
- my $waitstart;
- while (!flock $fh, $locktype|LOCK_NB) {
- $waitstart ||= localtime();
- if ($sleep>3) {
- $CPAN::Frontend->mywarn("Waiting for a read lock on '$file' (since $waitstart)\n");
- }
- $CPAN::Frontend->mysleep($sleep);
- if ($sleep <= 3) {
- $sleep+=0.33;
- } elsif ($sleep <=6) {
- $sleep+=0.11;
- }
- }
- my $stats = eval { CPAN->_yaml_loadfile($file); };
- if ($@) {
- if (ref $@) {
- if (ref $@ eq "CPAN::Exception::yaml_not_installed") {
- $CPAN::Frontend->myprint("Warning (usually harmless): $@");
- return;
- } elsif (ref $@ eq "CPAN::Exception::yaml_process_error") {
- $CPAN::Frontend->mydie($@);
- }
- } else {
- $CPAN::Frontend->mydie($@);
- }
- }
- return $stats->[0];
-}
+C<autobundle> writes a bundle file into the
+C<$CPAN::Config-E<gt>{cpan_home}/Bundle> directory. The file contains
+a list of all modules that are both available from CPAN and currently
+installed within @INC. The name of the bundle file is based on the
+current date and a counter.
-#-> sub CPAN::FTP::_mytime
-sub _mytime () {
- if (CPAN->has_inst("Time::HiRes")) {
- return Time::HiRes::time();
- } else {
- return time;
- }
-}
+=head2 hosts
-#-> sub CPAN::FTP::_new_stats
-sub _new_stats {
- my($self,$file) = @_;
- my $ret = {
- file => $file,
- attempts => [],
- start => _mytime,
- };
- $ret;
-}
+Note: this feature is still in alpha state and may change in future
+versions of CPAN.pm
-#-> sub CPAN::FTP::_add_to_statistics
-sub _add_to_statistics {
- my($self,$stats) = @_;
- my $yaml_module = CPAN::_yaml_module;
- if ($CPAN::META->has_inst($yaml_module)) {
- $stats->{thesiteurl} = $ThesiteURL;
- if (CPAN->has_inst("Time::HiRes")) {
- $stats->{end} = Time::HiRes::time();
- } else {
- $stats->{end} = time;
- }
- my $fh = FileHandle->new;
- my $time = time;
- my $sdebug = 0;
- my @debug;
- @debug = $time if $sdebug;
- my $fullstats = $self->_ftp_statistics($fh);
- close $fh;
- $fullstats->{history} ||= [];
- push @debug, scalar @{$fullstats->{history}} if $sdebug;
- push @debug, time if $sdebug;
- push @{$fullstats->{history}}, $stats;
- # arbitrary hardcoded constants until somebody demands to have
- # them settable
- while (
- @{$fullstats->{history}} > 9999
- || $time - $fullstats->{history}[0]{start} > 30*86400 # one month
- ) {
- shift @{$fullstats->{history}}
- }
- push @debug, scalar @{$fullstats->{history}} if $sdebug;
- push @debug, time if $sdebug;
- push @debug, scalar localtime($fullstats->{history}[0]{start}) if $sdebug;
- # need no eval because if this fails, it is serious
- my $sfile = File::Spec->catfile($CPAN::Config->{cpan_home},"FTPstats.yml");
- CPAN->_yaml_dumpfile("$sfile.$$",$fullstats);
- if ( $sdebug||$CPAN::DEBUG ) {
- local $CPAN::DEBUG = 512; # FTP
- push @debug, time;
- CPAN->debug(sprintf("DEBUG history: before_read[%d]before[%d]at[%d]".
- "after[%d]at[%d]oldest[%s]dumped backat[%d]",
- @debug,
- ));
- }
- # Win32 cannot rename a file to an existing filename
- unlink($sfile) if ($^O eq 'MSWin32');
- rename "$sfile.$$", $sfile
- or $CPAN::Frontend->mydie("Could not rename '$sfile.$$' to '$sfile': $!\n");
- }
-}
+This commands provides a statistical overview over recent download
+activities. The data for this is collected in the YAML file
+C<FTPstats.yml> in your C<cpan_home> directory. If no YAML module is
+configured or YAML not installed, no stats are provided.
-# if file is CHECKSUMS, suggest the place where we got the file to be
-# checked from, maybe only for young files?
-#-> sub CPAN::FTP::_recommend_url_for
-sub _recommend_url_for {
- my($self, $file) = @_;
- my $urllist = $self->_get_urllist;
- if ($file =~ s|/CHECKSUMS(.gz)?$||) {
- my $fullstats = $self->_ftp_statistics();
- my $history = $fullstats->{history} || [];
- while (my $last = pop @$history) {
- last if $last->{end} - time > 3600; # only young results are interesting
- next unless $last->{file}; # dirname of nothing dies!
- next unless $file eq File::Basename::dirname($last->{file});
- return $last->{thesiteurl};
- }
- }
- if ($CPAN::Config->{randomize_urllist}
- &&
- rand(1) < $CPAN::Config->{randomize_urllist}
- ) {
- $urllist->[int rand scalar @$urllist];
- } else {
- return ();
- }
-}
+=head2 mkmyconfig
-#-> sub CPAN::FTP::_get_urllist
-sub _get_urllist {
- my($self) = @_;
- $CPAN::Config->{urllist} ||= [];
- unless (ref $CPAN::Config->{urllist} eq 'ARRAY') {
- $CPAN::Frontend->mywarn("Malformed urllist; ignoring. Configuration file corrupt?\n");
- $CPAN::Config->{urllist} = [];
- }
- my @urllist = grep { defined $_ and length $_ } @{$CPAN::Config->{urllist}};
- for my $u (@urllist) {
- CPAN->debug("u[$u]") if $CPAN::DEBUG;
- if (UNIVERSAL::can($u,"text")) {
- $u->{TEXT} .= "/" unless substr($u->{TEXT},-1) eq "/";
- } else {
- $u .= "/" unless substr($u,-1) eq "/";
- $u = CPAN::URL->new(TEXT => $u, FROM => "USER");
- }
- }
- \@urllist;
-}
+mkmyconfig() writes your own CPAN::MyConfig file into your C<~/.cpan/>
+directory so that you can save your own preferences instead of the
+system-wide ones.
-#-> sub CPAN::FTP::ftp_get ;
-sub ftp_get {
- my($class,$host,$dir,$file,$target) = @_;
- $class->debug(
- qq[Going to fetch file [$file] from dir [$dir]
- on host [$host] as local [$target]\n]
- ) if $CPAN::DEBUG;
- my $ftp = Net::FTP->new($host);
- unless ($ftp) {
- $CPAN::Frontend->mywarn(" Could not connect to host '$host' with Net::FTP\n");
- return;
- }
- return 0 unless defined $ftp;
- $ftp->debug(1) if $CPAN::DEBUG{'FTP'} & $CPAN::DEBUG;
- $class->debug(qq[Going to login("anonymous","$Config::Config{cf_email}")]);
- unless ( $ftp->login("anonymous",$Config::Config{'cf_email'}) ){
- my $msg = $ftp->message;
- $CPAN::Frontend->mywarn(" Couldn't login on $host: $msg");
- return;
- }
- unless ( $ftp->cwd($dir) ){
- my $msg = $ftp->message;
- $CPAN::Frontend->mywarn(" Couldn't cwd $dir: $msg");
- return;
- }
- $ftp->binary;
- $class->debug(qq[Going to ->get("$file","$target")\n]) if $CPAN::DEBUG;
- unless ( $ftp->get($file,$target) ){
- my $msg = $ftp->message;
- $CPAN::Frontend->mywarn(" Couldn't fetch $file from $host: $msg");
- return;
- }
- $ftp->quit; # it's ok if this fails
- return 1;
-}
+=head2 recent ***EXPERIMENTAL COMMAND***
-# If more accuracy is wanted/needed, Chris Leach sent me this patch...
-
- # > *** /install/perl/live/lib/CPAN.pm- Wed Sep 24 13:08:48 1997
- # > --- /tmp/cp Wed Sep 24 13:26:40 1997
- # > ***************
- # > *** 1562,1567 ****
- # > --- 1562,1580 ----
- # > return 1 if substr($url,0,4) eq "file";
- # > return 1 unless $url =~ m|://([^/]+)|;
- # > my $host = $1;
- # > + my $proxy = $CPAN::Config->{'http_proxy'} || $ENV{'http_proxy'};
- # > + if ($proxy) {
- # > + $proxy =~ m|://([^/:]+)|;
- # > + $proxy = $1;
- # > + my $noproxy = $CPAN::Config->{'no_proxy'} || $ENV{'no_proxy'};
- # > + if ($noproxy) {
- # > + if ($host !~ /$noproxy$/) {
- # > + $host = $proxy;
- # > + }
- # > + } else {
- # > + $host = $proxy;
- # > + }
- # > + }
- # > require Net::Ping;
- # > return 1 unless $Net::Ping::VERSION >= 2;
- # > my $p;
-
-
-#-> sub CPAN::FTP::localize ;
-sub localize {
- my($self,$file,$aslocal,$force) = @_;
- $force ||= 0;
- Carp::croak "Usage: ->localize(cpan_file,as_local_file[,$force])"
- unless defined $aslocal;
- $self->debug("file[$file] aslocal[$aslocal] force[$force]")
- if $CPAN::DEBUG;
-
- if ($^O eq 'MacOS') {
- # Comment by AK on 2000-09-03: Uniq short filenames would be
- # available in CHECKSUMS file
- my($name, $path) = File::Basename::fileparse($aslocal, '');
- if (length($name) > 31) {
- $name =~ s/(
- \.(
- readme(\.(gz|Z))? |
- (tar\.)?(gz|Z) |
- tgz |
- zip |
- pm\.(gz|Z)
- )
- )$//x;
- my $suf = $1;
- my $size = 31 - length($suf);
- while (length($name) > $size) {
- chop $name;
- }
- $name .= $suf;
- $aslocal = File::Spec->catfile($path, $name);
- }
- }
+The C<recent> command downloads a list of recent uploads to CPAN and
+displays them I<slowly>. While the command is running, a $SIG{INT}
+exits the loop after displaying the current item.
- if (-f $aslocal && -r _ && !($force & 1)){
- my $size;
- if ($size = -s $aslocal) {
- $self->debug("aslocal[$aslocal]size[$size]") if $CPAN::DEBUG;
- return $aslocal;
- } else {
- # empty file from a previous unsuccessful attempt to download it
- unlink $aslocal or
- $CPAN::Frontend->mydie("Found a zero-length '$aslocal' that I ".
- "could not remove.");
- }
- }
- my($maybe_restore) = 0;
- if (-f $aslocal){
- rename $aslocal, "$aslocal.bak$$";
- $maybe_restore++;
- }
+B<Note>: This command requires XML::LibXML installed.
- my($aslocal_dir) = File::Basename::dirname($aslocal);
- File::Path::mkpath($aslocal_dir);
- $CPAN::Frontend->mywarn(qq{Warning: You are not allowed to write into }.
- qq{directory "$aslocal_dir".
- I\'ll continue, but if you encounter problems, they may be due
- to insufficient permissions.\n}) unless -w $aslocal_dir;
-
- # Inheritance is not easier to manage than a few if/else branches
- if ($CPAN::META->has_usable('LWP::UserAgent')) {
- unless ($Ua) {
- CPAN::LWP::UserAgent->config;
- eval {$Ua = CPAN::LWP::UserAgent->new;}; # Why is has_usable still not fit enough?
- if ($@) {
- $CPAN::Frontend->mywarn("CPAN::LWP::UserAgent->new dies with $@\n")
- if $CPAN::DEBUG;
- } else {
- my($var);
- $Ua->proxy('ftp', $var)
- if $var = $CPAN::Config->{ftp_proxy} || $ENV{ftp_proxy};
- $Ua->proxy('http', $var)
- if $var = $CPAN::Config->{http_proxy} || $ENV{http_proxy};
-
-
-# >>>>> On Wed, 13 Dec 2000 09:21:34 -0500, "Robison, Jonathon (J.M.)" <jrobiso2@visteon.com> said:
-#
-# > I note that although CPAN.pm can use proxies, it doesn't seem equipped to
-# > use ones that require basic autorization.
-#
-# > Example of when I use it manually in my own stuff:
-#
-# > $ua->proxy(['http','ftp'], http://my.proxy.server:83');
-# > $req->proxy_authorization_basic("username","password");
-# > $res = $ua->request($req);
-#
-
- $Ua->no_proxy($var)
- if $var = $CPAN::Config->{no_proxy} || $ENV{no_proxy};
- }
- }
- }
- for my $prx (qw(ftp_proxy http_proxy no_proxy)) {
- $ENV{$prx} = $CPAN::Config->{$prx} if $CPAN::Config->{$prx};
- }
+B<Note>: This whole command currently is just a hack and will
+probably change in future versions of CPAN.pm, but the general
+approach will likely remain.
- # Try the list of urls for each single object. We keep a record
- # where we did get a file from
- my(@reordered,$last);
- my $ccurllist = $self->_get_urllist;
- $last = $#$ccurllist;
- if ($force & 2) { # local cpans probably out of date, don't reorder
- @reordered = (0..$last);
- } else {
- @reordered =
- sort {
- (substr($ccurllist->[$b],0,4) eq "file")
- <=>
- (substr($ccurllist->[$a],0,4) eq "file")
- or
- defined($ThesiteURL)
- and
- ($ccurllist->[$b] eq $ThesiteURL)
- <=>
- ($ccurllist->[$a] eq $ThesiteURL)
- } 0..$last;
- }
- my(@levels);
- $Themethod ||= "";
- $self->debug("Themethod[$Themethod]reordered[@reordered]") if $CPAN::DEBUG;
- if ($Themethod) {
- @levels = ($Themethod, grep {$_ ne $Themethod} qw/easy hard hardest/);
- } else {
- @levels = qw/easy hard hardest/;
- }
- @levels = qw/easy/ if $^O eq 'MacOS';
- my($levelno);
- local $ENV{FTP_PASSIVE} =
- exists $CPAN::Config->{ftp_passive} ?
- $CPAN::Config->{ftp_passive} : 1;
- my $ret;
- my $stats = $self->_new_stats($file);
- LEVEL: for $levelno (0..$#levels) {
- my $level = $levels[$levelno];
- my $method = "host$level";
- my @host_seq = $level eq "easy" ?
- @reordered : 0..$last; # reordered has CDROM up front
- my @urllist = map { $ccurllist->[$_] } @host_seq;
- for my $u (@CPAN::Defaultsites) {
- push @urllist, $u unless grep { $_ eq $u } @urllist;
- }
- $self->debug("synth. urllist[@urllist]") if $CPAN::DEBUG;
- my $aslocal_tempfile = $aslocal . ".tmp" . $$;
- if (my $recommend = $self->_recommend_url_for($file)) {
- @urllist = grep { $_ ne $recommend } @urllist;
- unshift @urllist, $recommend;
- }
- $self->debug("synth. urllist[@urllist]") if $CPAN::DEBUG;
- $ret = $self->$method(\@urllist,$file,$aslocal_tempfile,$stats);
- if ($ret) {
- CPAN->debug("ret[$ret]aslocal[$aslocal]") if $CPAN::DEBUG;
- if ($ret eq $aslocal_tempfile) {
- # if we got it exactly as we asked for, only then we
- # want to rename
- rename $aslocal_tempfile, $aslocal
- or $CPAN::Frontend->mydie("Error while trying to rename ".
- "'$ret' to '$aslocal': $!");
- $ret = $aslocal;
- }
- $Themethod = $level;
- my $now = time;
- # utime $now, $now, $aslocal; # too bad, if we do that, we
- # might alter a local mirror
- $self->debug("level[$level]") if $CPAN::DEBUG;
- last LEVEL;
- } else {
- unlink $aslocal_tempfile;
- last if $CPAN::Signal; # need to cleanup
- }
- }
- if ($ret) {
- $stats->{filesize} = -s $ret;
- }
- $self->_add_to_statistics($stats);
- if ($ret) {
- unlink "$aslocal.bak$$";
- return $ret;
- }
- unless ($CPAN::Signal) {
- my(@mess);
- local $" = " ";
- if (@{$CPAN::Config->{urllist}}) {
- push @mess,
- qq{Please check, if the URLs I found in your configuration file \(}.
- join(", ", @{$CPAN::Config->{urllist}}).
- qq{\) are valid.};
- } else {
- push @mess, qq{Your urllist is empty!};
- }
- push @mess, qq{The urllist can be edited.},
- qq{E.g. with 'o conf urllist push ftp://myurl/'};
- $CPAN::Frontend->mywarn(Text::Wrap::wrap("","","@mess"). "\n\n");
- $CPAN::Frontend->mywarn("Could not fetch $file\n");
- $CPAN::Frontend->mysleep(2);
- }
- if ($maybe_restore) {
- rename "$aslocal.bak$$", $aslocal;
- $CPAN::Frontend->myprint("Trying to get away with old file:\n" .
- $self->ls($aslocal));
- return $aslocal;
- }
- return;
-}
+B<Note>: See also L<smoke>
-sub _set_attempt {
- my($self,$stats,$method,$url) = @_;
- push @{$stats->{attempts}}, {
- method => $method,
- start => _mytime,
- url => $url,
- };
-}
+=head2 recompile
-# package CPAN::FTP;
-sub hosteasy {
- my($self,$host_seq,$file,$aslocal,$stats) = @_;
- my($ro_url);
- HOSTEASY: for $ro_url (@$host_seq) {
- $self->_set_attempt($stats,"easy",$ro_url);
- my $url .= "$ro_url$file";
- $self->debug("localizing perlish[$url]") if $CPAN::DEBUG;
- if ($url =~ /^file:/) {
- my $l;
- if ($CPAN::META->has_inst('URI::URL')) {
- my $u = URI::URL->new($url);
- $l = $u->path;
- } else { # works only on Unix, is poorly constructed, but
- # hopefully better than nothing.
- # RFC 1738 says fileurl BNF is
- # fileurl = "file://" [ host | "localhost" ] "/" fpath
- # Thanks to "Mark D. Baushke" <mdb@cisco.com> for
- # the code
- ($l = $url) =~ s|^file://[^/]*/|/|; # discard the host part
- $l =~ s|^file:||; # assume they
- # meant
- # file://localhost
- $l =~ s|^/||s
- if ! -f $l && $l =~ m|^/\w:|; # e.g. /P:
- }
- $self->debug("local file[$l]") if $CPAN::DEBUG;
- if ( -f $l && -r _) {
- $ThesiteURL = $ro_url;
- return $l;
- }
- if ($l =~ /(.+)\.gz$/) {
- my $ungz = $1;
- if ( -f $ungz && -r _) {
- $ThesiteURL = $ro_url;
- return $ungz;
- }
- }
- # Maybe mirror has compressed it?
- if (-f "$l.gz") {
- $self->debug("found compressed $l.gz") if $CPAN::DEBUG;
- eval { CPAN::Tarzip->new("$l.gz")->gunzip($aslocal) };
- if ( -f $aslocal) {
- $ThesiteURL = $ro_url;
- return $aslocal;
- }
- }
- }
- $self->debug("it was not a file URL") if $CPAN::DEBUG;
- if ($CPAN::META->has_usable('LWP')) {
- $CPAN::Frontend->myprint("Fetching with LWP:
- $url
-");
- unless ($Ua) {
- CPAN::LWP::UserAgent->config;
- eval { $Ua = CPAN::LWP::UserAgent->new; };
- if ($@) {
- $CPAN::Frontend->mywarn("CPAN::LWP::UserAgent->new dies with $@\n");
- }
- }
- my $res = $Ua->mirror($url, $aslocal);
- if ($res->is_success) {
- $ThesiteURL = $ro_url;
- my $now = time;
- utime $now, $now, $aslocal; # download time is more
- # important than upload
- # time
- return $aslocal;
- } elsif ($url !~ /\.gz(?!\n)\Z/) {
- my $gzurl = "$url.gz";
- $CPAN::Frontend->myprint("Fetching with LWP:
- $gzurl
-");
- $res = $Ua->mirror($gzurl, "$aslocal.gz");
- if ($res->is_success) {
- if (eval {CPAN::Tarzip->new("$aslocal.gz")->gunzip($aslocal)}) {
- $ThesiteURL = $ro_url;
- return $aslocal;
- }
- }
- } else {
- $CPAN::Frontend->myprint(sprintf(
- "LWP failed with code[%s] message[%s]\n",
- $res->code,
- $res->message,
- ));
- # Alan Burlison informed me that in firewall environments
- # Net::FTP can still succeed where LWP fails. So we do not
- # skip Net::FTP anymore when LWP is available.
- }
- } else {
- $CPAN::Frontend->mywarn(" LWP not available\n");
- }
- return if $CPAN::Signal;
- if ($url =~ m|^ftp://(.*?)/(.*)/(.*)|) {
- # that's the nice and easy way thanks to Graham
- $self->debug("recognized ftp") if $CPAN::DEBUG;
- my($host,$dir,$getfile) = ($1,$2,$3);
- if ($CPAN::META->has_usable('Net::FTP')) {
- $dir =~ s|/+|/|g;
- $CPAN::Frontend->myprint("Fetching with Net::FTP:
- $url
-");
- $self->debug("getfile[$getfile]dir[$dir]host[$host]" .
- "aslocal[$aslocal]") if $CPAN::DEBUG;
- if (CPAN::FTP->ftp_get($host,$dir,$getfile,$aslocal)) {
- $ThesiteURL = $ro_url;
- return $aslocal;
- }
- if ($aslocal !~ /\.gz(?!\n)\Z/) {
- my $gz = "$aslocal.gz";
- $CPAN::Frontend->myprint("Fetching with Net::FTP
- $url.gz
-");
- if (CPAN::FTP->ftp_get($host,
- $dir,
- "$getfile.gz",
- $gz) &&
- eval{CPAN::Tarzip->new($gz)->gunzip($aslocal)}
- ){
- $ThesiteURL = $ro_url;
- return $aslocal;
- }
- }
- # next HOSTEASY;
- } else {
- CPAN->debug("Net::FTP does not count as usable atm") if $CPAN::DEBUG;
- }
- }
- if (
- UNIVERSAL::can($ro_url,"text")
- and
- $ro_url->{FROM} eq "USER"
- ){
- ##address #17973: default URLs should not try to override
- ##user-defined URLs just because LWP is not available
- my $ret = $self->hosthard([$ro_url],$file,$aslocal,$stats);
- return $ret if $ret;
- }
- return if $CPAN::Signal;
- }
-}
+recompile() is a special command that takes no argument and
+runs the make/test/install cycle with brute force over all installed
+dynamically loadable extensions (aka XS modules) with 'force' in
+effect. The primary purpose of this command is to finish a network
+installation. Imagine you have a common source tree for two different
+architectures. You decide to do a completely independent fresh
+installation. You start on one architecture with the help of a Bundle
+file produced earlier. CPAN installs the whole Bundle for you, but
+when you try to repeat the job on the second architecture, CPAN
+responds with a C<"Foo up to date"> message for all modules. So you
+invoke CPAN's recompile on the second architecture and you're done.
-# package CPAN::FTP;
-sub hosthard {
- my($self,$host_seq,$file,$aslocal,$stats) = @_;
-
- # Came back if Net::FTP couldn't establish connection (or
- # failed otherwise) Maybe they are behind a firewall, but they
- # gave us a socksified (or other) ftp program...
-
- my($ro_url);
- my($devnull) = $CPAN::Config->{devnull} || "";
- # < /dev/null ";
- my($aslocal_dir) = File::Basename::dirname($aslocal);
- File::Path::mkpath($aslocal_dir);
- HOSTHARD: for $ro_url (@$host_seq) {
- $self->_set_attempt($stats,"hard",$ro_url);
- my $url = "$ro_url$file";
- my($proto,$host,$dir,$getfile);
-
- # Courtesy Mark Conty mark_conty@cargill.com change from
- # if ($url =~ m|^ftp://(.*?)/(.*)/(.*)|) {
- # to
- if ($url =~ m|^([^:]+)://(.*?)/(.*)/(.*)|) {
- # proto not yet used
- ($proto,$host,$dir,$getfile) = ($1,$2,$3,$4);
- } else {
- next HOSTHARD; # who said, we could ftp anything except ftp?
- }
- next HOSTHARD if $proto eq "file"; # file URLs would have had
- # success above. Likely a bogus URL
-
- $self->debug("localizing funkyftpwise[$url]") if $CPAN::DEBUG;
-
- # Try the most capable first and leave ncftp* for last as it only
- # does FTP.
- DLPRG: for my $f (qw(curl wget lynx ncftpget ncftp)) {
- my $funkyftp = CPAN::HandleConfig->safe_quote($CPAN::Config->{$f});
- next unless defined $funkyftp;
- next if $funkyftp =~ /^\s*$/;
-
- my($asl_ungz, $asl_gz);
- ($asl_ungz = $aslocal) =~ s/\.gz//;
- $asl_gz = "$asl_ungz.gz";
-
- my($src_switch) = "";
- my($chdir) = "";
- my($stdout_redir) = " > $asl_ungz";
- if ($f eq "lynx"){
- $src_switch = " -source";
- } elsif ($f eq "ncftp"){
- $src_switch = " -c";
- } elsif ($f eq "wget"){
- $src_switch = " -O $asl_ungz";
- $stdout_redir = "";
- } elsif ($f eq 'curl'){
- $src_switch = ' -L -f -s -S --netrc-optional';
- }
-
- if ($f eq "ncftpget"){
- $chdir = "cd $aslocal_dir && ";
- $stdout_redir = "";
- }
- $CPAN::Frontend->myprint(
- qq[
-Trying with "$funkyftp$src_switch" to get
- $url
-]);
- my($system) =
- "$chdir$funkyftp$src_switch \"$url\" $devnull$stdout_redir";
- $self->debug("system[$system]") if $CPAN::DEBUG;
- my($wstatus) = system($system);
- if ($f eq "lynx") {
- # lynx returns 0 when it fails somewhere
- if (-s $asl_ungz) {
- my $content = do { local *FH;
- open FH, $asl_ungz or die;
- local $/;
- <FH> };
- if ($content =~ /^<.*(<title>[45]|Error [45])/si) {
- $CPAN::Frontend->mywarn(qq{
-No success, the file that lynx has has downloaded looks like an error message:
-$content
-});
- $CPAN::Frontend->mysleep(1);
- next DLPRG;
- }
- } else {
- $CPAN::Frontend->myprint(qq{
-No success, the file that lynx has has downloaded is an empty file.
-});
- next DLPRG;
- }
- }
- if ($wstatus == 0) {
- if (-s $aslocal) {
- # Looks good
- } elsif ($asl_ungz ne $aslocal) {
- # test gzip integrity
- if (eval{CPAN::Tarzip->new($asl_ungz)->gtest}) {
- # e.g. foo.tar is gzipped --> foo.tar.gz
- rename $asl_ungz, $aslocal;
- } else {
- eval{CPAN::Tarzip->new($asl_gz)->gzip($asl_ungz)};
- }
- }
- $ThesiteURL = $ro_url;
- return $aslocal;
- } elsif ($url !~ /\.gz(?!\n)\Z/) {
- unlink $asl_ungz if
- -f $asl_ungz && -s _ == 0;
- my $gz = "$aslocal.gz";
- my $gzurl = "$url.gz";
- $CPAN::Frontend->myprint(
- qq[
-Trying with "$funkyftp$src_switch" to get
- $url.gz
-]);
- my($system) = "$funkyftp$src_switch \"$url.gz\" $devnull > $asl_gz";
- $self->debug("system[$system]") if $CPAN::DEBUG;
- my($wstatus);
- if (($wstatus = system($system)) == 0
- &&
- -s $asl_gz
- ) {
- # test gzip integrity
- my $ct = eval{CPAN::Tarzip->new($asl_gz)};
- if ($ct && $ct->gtest) {
- $ct->gunzip($aslocal);
- } else {
- # somebody uncompressed file for us?
- rename $asl_ungz, $aslocal;
- }
- $ThesiteURL = $ro_url;
- return $aslocal;
- } else {
- unlink $asl_gz if -f $asl_gz;
- }
- } else {
- my $estatus = $wstatus >> 8;
- my $size = -f $aslocal ?
- ", left\n$aslocal with size ".-s _ :
- "\nWarning: expected file [$aslocal] doesn't exist";
- $CPAN::Frontend->myprint(qq{
-System call "$system"
-returned status $estatus (wstat $wstatus)$size
-});
- }
- return if $CPAN::Signal;
- } # transfer programs
- } # host
-}
+Another popular use for C<recompile> is to act as a rescue in case your
+perl breaks binary compatibility. If one of the modules that CPAN uses
+is in turn depending on binary compatibility (so you cannot run CPAN
+commands), then you should try the CPAN::Nox module for recovery.
-# package CPAN::FTP;
-sub hosthardest {
- my($self,$host_seq,$file,$aslocal,$stats) = @_;
+=head2 report Bundle|Distribution|Module
- my($ro_url);
- my($aslocal_dir) = File::Basename::dirname($aslocal);
- File::Path::mkpath($aslocal_dir);
- my $ftpbin = $CPAN::Config->{ftp};
- unless ($ftpbin && length $ftpbin && MM->maybe_command($ftpbin)) {
- $CPAN::Frontend->myprint("No external ftp command available\n\n");
- return;
- }
- $CPAN::Frontend->mywarn(qq{
-As a last ressort we now switch to the external ftp command '$ftpbin'
-to get '$aslocal'.
+The C<report> command temporarily turns on the C<test_report> config
+variable, then runs the C<force test> command with the given
+arguments. The C<force> pragma reruns the tests and repeats
+every step that might have failed before.
-Doing so often leads to problems that are hard to diagnose.
+=head2 smoke ***EXPERIMENTAL COMMAND***
-If you're victim of such problems, please consider unsetting the ftp
-config variable with
+B<*** WARNING: this command downloads and executes software from CPAN to
+your computer of completely unknown status. You should never do
+this with your normal account and better have a dedicated well
+separated and secured machine to do this. ***>
- o conf ftp ""
- o conf commit
+The C<smoke> command takes the list of recent uploads to CPAN as
+provided by the C<recent> command and tests them all. While the
+command is running $SIG{INT} is defined to mean that the current item
+shall be skipped.
-});
- $CPAN::Frontend->mysleep(2);
- HOSTHARDEST: for $ro_url (@$host_seq) {
- $self->_set_attempt($stats,"hardest",$ro_url);
- my $url = "$ro_url$file";
- $self->debug("localizing ftpwise[$url]") if $CPAN::DEBUG;
- unless ($url =~ m|^ftp://(.*?)/(.*)/(.*)|) {
- next;
- }
- my($host,$dir,$getfile) = ($1,$2,$3);
- my $timestamp = 0;
- my($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size,$atime,$mtime,
- $ctime,$blksize,$blocks) = stat($aslocal);
- $timestamp = $mtime ||= 0;
- my($netrc) = CPAN::FTP::netrc->new;
- my($netrcfile) = $netrc->netrc;
- my($verbose) = $CPAN::DEBUG{'FTP'} & $CPAN::DEBUG ? " -v" : "";
- my $targetfile = File::Basename::basename($aslocal);
- my(@dialog);
- push(
- @dialog,
- "lcd $aslocal_dir",
- "cd /",
- map("cd $_", split /\//, $dir), # RFC 1738
- "bin",
- "get $getfile $targetfile",
- "quit"
- );
- if (! $netrcfile) {
- CPAN->debug("No ~/.netrc file found") if $CPAN::DEBUG;
- } elsif ($netrc->hasdefault || $netrc->contains($host)) {
- CPAN->debug(sprintf("hasdef[%d]cont($host)[%d]",
- $netrc->hasdefault,
- $netrc->contains($host))) if $CPAN::DEBUG;
- if ($netrc->protected) {
- my $dialog = join "", map { " $_\n" } @dialog;
- my $netrc_explain;
- if ($netrc->contains($host)) {
- $netrc_explain = "Relying that your .netrc entry for '$host' ".
- "manages the login";
- } else {
- $netrc_explain = "Relying that your default .netrc entry ".
- "manages the login";
- }
- $CPAN::Frontend->myprint(qq{
- Trying with external ftp to get
- $url
- $netrc_explain
- Going to send the dialog
-$dialog
-}
- );
- $self->talk_ftp("$ftpbin$verbose $host",
- @dialog);
- ($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size,
- $atime,$mtime,$ctime,$blksize,$blocks) = stat($aslocal);
- $mtime ||= 0;
- if ($mtime > $timestamp) {
- $CPAN::Frontend->myprint("GOT $aslocal\n");
- $ThesiteURL = $ro_url;
- return $aslocal;
- } else {
- $CPAN::Frontend->myprint("Hmm... Still failed!\n");
- }
- return if $CPAN::Signal;
- } else {
- $CPAN::Frontend->mywarn(qq{Your $netrcfile is not }.
- qq{correctly protected.\n});
- }
- } else {
- $CPAN::Frontend->mywarn("Your ~/.netrc neither contains $host
- nor does it have a default entry\n");
- }
-
- # OK, they don't have a valid ~/.netrc. Use 'ftp -n'
- # then and login manually to host, using e-mail as
- # password.
- $CPAN::Frontend->myprint(qq{Issuing "$ftpbin$verbose -n"\n});
- unshift(
- @dialog,
- "open $host",
- "user anonymous $Config::Config{'cf_email'}"
- );
- my $dialog = join "", map { " $_\n" } @dialog;
- $CPAN::Frontend->myprint(qq{
- Trying with external ftp to get
- $url
- Going to send the dialog
-$dialog
-}
- );
- $self->talk_ftp("$ftpbin$verbose -n", @dialog);
- ($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size,
- $atime,$mtime,$ctime,$blksize,$blocks) = stat($aslocal);
- $mtime ||= 0;
- if ($mtime > $timestamp) {
- $CPAN::Frontend->myprint("GOT $aslocal\n");
- $ThesiteURL = $ro_url;
- return $aslocal;
- } else {
- $CPAN::Frontend->myprint("Bad luck... Still failed!\n");
- }
- return if $CPAN::Signal;
- $CPAN::Frontend->mywarn("Can't access URL $url.\n\n");
- $CPAN::Frontend->mysleep(2);
- } # host
-}
+B<Note>: This whole command currently is just a hack and will
+probably change in future versions of CPAN.pm, but the general
+approach will likely remain.
-# package CPAN::FTP;
-sub talk_ftp {
- my($self,$command,@dialog) = @_;
- my $fh = FileHandle->new;
- $fh->open("|$command") or die "Couldn't open ftp: $!";
- foreach (@dialog) { $fh->print("$_\n") }
- $fh->close; # Wait for process to complete
- my $wstatus = $?;
- my $estatus = $wstatus >> 8;
- $CPAN::Frontend->myprint(qq{
-Subprocess "|$command"
- returned status $estatus (wstat $wstatus)
-}) if $wstatus;
-}
+B<Note>: See also L<recent>
-# find2perl needs modularization, too, all the following is stolen
-# from there
-# CPAN::FTP::ls
-sub ls {
- my($self,$name) = @_;
- my ($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$sizemm,
- $atime,$mtime,$ctime,$blksize,$blocks) = lstat($name);
+=head2 upgrade [Module|/Regex/]...
- my($perms,%user,%group);
- my $pname = $name;
+The C<upgrade> command first runs an C<r> command with the given
+arguments and then installs the newest versions of all modules that
+were listed by that.
- if ($blocks) {
- $blocks = int(($blocks + 1) / 2);
- }
- else {
- $blocks = int(($sizemm + 1023) / 1024);
- }
+=head2 The four C<CPAN::*> Classes: Author, Bundle, Module, Distribution
- if (-f _) { $perms = '-'; }
- elsif (-d _) { $perms = 'd'; }
- elsif (-c _) { $perms = 'c'; $sizemm = &sizemm; }
- elsif (-b _) { $perms = 'b'; $sizemm = &sizemm; }
- elsif (-p _) { $perms = 'p'; }
- elsif (-S _) { $perms = 's'; }
- else { $perms = 'l'; $pname .= ' -> ' . readlink($_); }
-
- my(@rwx) = ('---','--x','-w-','-wx','r--','r-x','rw-','rwx');
- my(@moname) = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
- my $tmpmode = $mode;
- my $tmp = $rwx[$tmpmode & 7];
- $tmpmode >>= 3;
- $tmp = $rwx[$tmpmode & 7] . $tmp;
- $tmpmode >>= 3;
- $tmp = $rwx[$tmpmode & 7] . $tmp;
- substr($tmp,2,1) =~ tr/-x/Ss/ if -u _;
- substr($tmp,5,1) =~ tr/-x/Ss/ if -g _;
- substr($tmp,8,1) =~ tr/-x/Tt/ if -k _;
- $perms .= $tmp;
-
- my $user = $user{$uid} || $uid; # too lazy to implement lookup
- my $group = $group{$gid} || $gid;
-
- my($sec,$min,$hour,$mday,$mon,$year) = localtime($mtime);
- my($timeyear);
- my($moname) = $moname[$mon];
- if (-M _ > 365.25 / 2) {
- $timeyear = $year + 1900;
- }
- else {
- $timeyear = sprintf("%02d:%02d", $hour, $min);
- }
+Although it may be considered internal, the class hierarchy does matter
+for both users and programmer. CPAN.pm deals with the four
+classes mentioned above, and those classes all share a set of methods. Classical
+single polymorphism is in effect. A metaclass object registers all
+objects of all kinds and indexes them with a string. The strings
+referencing objects have a separated namespace (well, not completely
+separated):
- sprintf "%5lu %4ld %-10s %2d %-8s %-8s %8s %s %2d %5s %s\n",
- $ino,
- $blocks,
- $perms,
- $nlink,
- $user,
- $group,
- $sizemm,
- $moname,
- $mday,
- $timeyear,
- $pname;
-}
+ Namespace Class
-package CPAN::FTP::netrc;
-use strict;
+ words containing a "/" (slash) Distribution
+ words starting with Bundle:: Bundle
+ everything else Module or Author
-# package CPAN::FTP::netrc;
-sub new {
- my($class) = @_;
- my $home = CPAN::HandleConfig::home;
- my $file = File::Spec->catfile($home,".netrc");
-
- my($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size,
- $atime,$mtime,$ctime,$blksize,$blocks)
- = stat($file);
- $mode ||= 0;
- my $protected = 0;
-
- my($fh,@machines,$hasdefault);
- $hasdefault = 0;
- $fh = FileHandle->new or die "Could not create a filehandle";
-
- if($fh->open($file)){
- $protected = ($mode & 077) == 0;
- local($/) = "";
- NETRC: while (<$fh>) {
- my(@tokens) = split " ", $_;
- TOKEN: while (@tokens) {
- my($t) = shift @tokens;
- if ($t eq "default"){
- $hasdefault++;
- last NETRC;
- }
- last TOKEN if $t eq "macdef";
- if ($t eq "machine") {
- push @machines, shift @tokens;
- }
- }
- }
- } else {
- $file = $hasdefault = $protected = "";
- }
-
- bless {
- 'mach' => [@machines],
- 'netrc' => $file,
- 'hasdefault' => $hasdefault,
- 'protected' => $protected,
- }, $class;
-}
-
-# CPAN::FTP::netrc::hasdefault;
-sub hasdefault { shift->{'hasdefault'} }
-sub netrc { shift->{'netrc'} }
-sub protected { shift->{'protected'} }
-sub contains {
- my($self,$mach) = @_;
- for ( @{$self->{'mach'}} ) {
- return 1 if $_ eq $mach;
- }
- return 0;
-}
-
-package CPAN::Complete;
-use strict;
-
-sub gnu_cpl {
- my($text, $line, $start, $end) = @_;
- my(@perlret) = cpl($text, $line, $start);
- # find longest common match. Can anybody show me how to peruse
- # T::R::Gnu to have this done automatically? Seems expensive.
- return () unless @perlret;
- my($newtext) = $text;
- for (my $i = length($text)+1;;$i++) {
- last unless length($perlret[0]) && length($perlret[0]) >= $i;
- my $try = substr($perlret[0],0,$i);
- my @tries = grep {substr($_,0,$i) eq $try} @perlret;
- # warn "try[$try]tries[@tries]";
- if (@tries == @perlret) {
- $newtext = $try;
- } else {
- last;
- }
- }
- ($newtext,@perlret);
-}
-
-#-> sub CPAN::Complete::cpl ;
-sub cpl {
- my($word,$line,$pos) = @_;
- $word ||= "";
- $line ||= "";
- $pos ||= 0;
- CPAN->debug("word [$word] line[$line] pos[$pos]") if $CPAN::DEBUG;
- $line =~ s/^\s*//;
- if ($line =~ s/^(force\s*)//) {
- $pos -= length($1);
- }
- my @return;
- if ($pos == 0) {
- @return = grep /^$word/, @CPAN::Complete::COMMANDS;
- } elsif ( $line !~ /^[\!abcdghimorutl]/ ) {
- @return = ();
- } elsif ($line =~ /^(a|ls)\s/) {
- @return = cplx('CPAN::Author',uc($word));
- } elsif ($line =~ /^b\s/) {
- CPAN::Shell->local_bundles;
- @return = cplx('CPAN::Bundle',$word);
- } elsif ($line =~ /^d\s/) {
- @return = cplx('CPAN::Distribution',$word);
- } elsif ($line =~ m/^(
- [mru]|make|clean|dump|get|test|install|readme|look|cvs_import|perldoc|recent
- )\s/x ) {
- if ($word =~ /^Bundle::/) {
- CPAN::Shell->local_bundles;
- }
- @return = (cplx('CPAN::Module',$word),cplx('CPAN::Bundle',$word));
- } elsif ($line =~ /^i\s/) {
- @return = cpl_any($word);
- } elsif ($line =~ /^reload\s/) {
- @return = cpl_reload($word,$line,$pos);
- } elsif ($line =~ /^o\s/) {
- @return = cpl_option($word,$line,$pos);
- } elsif ($line =~ m/^\S+\s/ ) {
- # fallback for future commands and what we have forgotten above
- @return = (cplx('CPAN::Module',$word),cplx('CPAN::Bundle',$word));
- } else {
- @return = ();
- }
- return @return;
-}
-
-#-> sub CPAN::Complete::cplx ;
-sub cplx {
- my($class, $word) = @_;
- if (CPAN::_sqlite_running) {
- $CPAN::SQLite->search($class, "^\Q$word\E");
- }
- sort grep /^\Q$word\E/, map { $_->id } $CPAN::META->all_objects($class);
-}
-
-#-> sub CPAN::Complete::cpl_any ;
-sub cpl_any {
- my($word) = shift;
- return (
- cplx('CPAN::Author',$word),
- cplx('CPAN::Bundle',$word),
- cplx('CPAN::Distribution',$word),
- cplx('CPAN::Module',$word),
- );
-}
-
-#-> sub CPAN::Complete::cpl_reload ;
-sub cpl_reload {
- my($word,$line,$pos) = @_;
- $word ||= "";
- my(@words) = split " ", $line;
- CPAN->debug("word[$word] line[$line] pos[$pos]") if $CPAN::DEBUG;
- my(@ok) = qw(cpan index);
- return @ok if @words == 1;
- return grep /^\Q$word\E/, @ok if @words == 2 && $word;
-}
+Modules know their associated Distribution objects. They always refer
+to the most recent official release. Developers may mark their releases
+as unstable development versions (by inserting an underbar into the
+module version number which will also be reflected in the distribution
+name when you run 'make dist'), so the really hottest and newest
+distribution is not always the default. If a module Foo circulates
+on CPAN in both version 1.23 and 1.23_90, CPAN.pm offers a convenient
+way to install version 1.23 by saying
-#-> sub CPAN::Complete::cpl_option ;
-sub cpl_option {
- my($word,$line,$pos) = @_;
- $word ||= "";
- my(@words) = split " ", $line;
- CPAN->debug("word[$word] line[$line] pos[$pos]") if $CPAN::DEBUG;
- my(@ok) = qw(conf debug);
- return @ok if @words == 1;
- return grep /^\Q$word\E/, @ok if @words == 2 && length($word);
- if (0) {
- } elsif ($words[1] eq 'index') {
- return ();
- } elsif ($words[1] eq 'conf') {
- return CPAN::HandleConfig::cpl(@_);
- } elsif ($words[1] eq 'debug') {
- return sort grep /^\Q$word\E/i,
- sort keys %CPAN::DEBUG, 'all';
- }
-}
+ install Foo
-package CPAN::Index;
-use strict;
+This would install the complete distribution file (say
+BAR/Foo-1.23.tar.gz) with all accompanying material. But if you would
+like to install version 1.23_90, you need to know where the
+distribution file resides on CPAN relative to the authors/id/
+directory. If the author is BAR, this might be BAR/Foo-1.23_90.tar.gz;
+so you would have to say
-#-> sub CPAN::Index::force_reload ;
-sub force_reload {
- my($class) = @_;
- $CPAN::Index::LAST_TIME = 0;
- $class->reload(1);
-}
+ install BAR/Foo-1.23_90.tar.gz
-#-> sub CPAN::Index::reload ;
-sub reload {
- my($self,$force) = @_;
- my $time = time;
+The first example will be driven by an object of the class
+CPAN::Module, the second by an object of class CPAN::Distribution.
- # XXX check if a newer one is available. (We currently read it
- # from time to time)
- for ($CPAN::Config->{index_expire}) {
- $_ = 0.001 unless $_ && $_ > 0.001;
- }
- unless (1 || $CPAN::Have_warned->{readmetadatacache}++) {
- # debug here when CPAN doesn't seem to read the Metadata
- require Carp;
- Carp::cluck("META-PROTOCOL[$CPAN::META->{PROTOCOL}]");
- }
- unless ($CPAN::META->{PROTOCOL}) {
- $self->read_metadata_cache;
- $CPAN::META->{PROTOCOL} ||= "1.0";
- }
- if ( $CPAN::META->{PROTOCOL} < PROTOCOL ) {
- # warn "Setting last_time to 0";
- $LAST_TIME = 0; # No warning necessary
- }
- if ($LAST_TIME + $CPAN::Config->{index_expire}*86400 > $time
- and ! $force){
- # called too often
- # CPAN->debug("LAST_TIME[$LAST_TIME]index_expire[$CPAN::Config->{index_expire}]time[$time]");
- } elsif (0) {
- # IFF we are developing, it helps to wipe out the memory
- # between reloads, otherwise it is not what a user expects.
- undef $CPAN::META; # Neue Gruendlichkeit since v1.52(r1.274)
- $CPAN::META = CPAN->new;
- } else {
- my($debug,$t2);
- local $LAST_TIME = $time;
- local $CPAN::META->{PROTOCOL} = PROTOCOL;
-
- my $needshort = $^O eq "dos";
-
- $self->rd_authindex($self
- ->reload_x(
- "authors/01mailrc.txt.gz",
- $needshort ?
- File::Spec->catfile('authors', '01mailrc.gz') :
- File::Spec->catfile('authors', '01mailrc.txt.gz'),
- $force));
- $t2 = time;
- $debug = "timing reading 01[".($t2 - $time)."]";
- $time = $t2;
- return if $CPAN::Signal; # this is sometimes lengthy
- $self->rd_modpacks($self
- ->reload_x(
- "modules/02packages.details.txt.gz",
- $needshort ?
- File::Spec->catfile('modules', '02packag.gz') :
- File::Spec->catfile('modules', '02packages.details.txt.gz'),
- $force));
- $t2 = time;
- $debug .= "02[".($t2 - $time)."]";
- $time = $t2;
- return if $CPAN::Signal; # this is sometimes lengthy
- $self->rd_modlist($self
- ->reload_x(
- "modules/03modlist.data.gz",
- $needshort ?
- File::Spec->catfile('modules', '03mlist.gz') :
- File::Spec->catfile('modules', '03modlist.data.gz'),
- $force));
- $self->write_metadata_cache;
- $t2 = time;
- $debug .= "03[".($t2 - $time)."]";
- $time = $t2;
- CPAN->debug($debug) if $CPAN::DEBUG;
- }
- if ($CPAN::Config->{build_dir_reuse}) {
- $self->reanimate_build_dir;
- }
- if (CPAN::_sqlite_running) {
- $CPAN::SQLite->reload(time => $time, force => $force)
- if not $LAST_TIME;
- }
- $LAST_TIME = $time;
- $CPAN::META->{PROTOCOL} = PROTOCOL;
-}
+=head2 Integrating local directories
-#-> sub CPAN::Index::reanimate_build_dir ;
-sub reanimate_build_dir {
- my($self) = @_;
- unless ($CPAN::META->has_inst($CPAN::Config->{yaml_module}||"YAML")) {
- return;
- }
- return if $HAVE_REANIMATED++;
- my $d = $CPAN::Config->{build_dir};
- my $dh = DirHandle->new;
- opendir $dh, $d or return; # does not exist
- my $dirent;
- my $i = 0;
- my $painted = 0;
- my $restored = 0;
- $CPAN::Frontend->myprint("Going to read $CPAN::Config->{build_dir}/\n");
- my @candidates = map { $_->[0] }
- sort { $b->[1] <=> $a->[1] }
- map { [ $_, -M File::Spec->catfile($d,$_) ] }
- grep {/\.yml$/} readdir $dh;
- DISTRO: for $dirent (@candidates) {
- my $y = eval {CPAN->_yaml_loadfile(File::Spec->catfile($d,$dirent))};
- die $@ if $@;
- my $c = $y->[0];
- if ($c && CPAN->_perl_fingerprint($c->{perl})) {
- my $key = $c->{distribution}{ID};
- for my $k (keys %{$c->{distribution}}) {
- if ($c->{distribution}{$k}
- && ref $c->{distribution}{$k}
- && UNIVERSAL::isa($c->{distribution}{$k},"CPAN::Distrostatus")) {
- $c->{distribution}{$k}{COMMANDID} = $i - @candidates;
- }
- }
+Note: this feature is still in alpha state and may change in future
+versions of CPAN.pm
- #we tried to restore only if element already
- #exists; but then we do not work with metadata
- #turned off.
- my $do
- = $CPAN::META->{readwrite}{'CPAN::Distribution'}{$key}
- = $c->{distribution};
- delete $do->{badtestcnt};
- # $DB::single = 1;
- if ($do->{make_test}
- && $do->{build_dir}
- && !$do->{make_test}->failed
- && (
- !$do->{install}
- ||
- $do->{install}->failed
- )
- ) {
- $CPAN::META->is_tested($do->{build_dir},$do->{make_test}{TIME});
- }
- $restored++;
- }
- $i++;
- while (($painted/76) < ($i/@candidates)) {
- $CPAN::Frontend->myprint(".");
- $painted++;
- }
- }
- $CPAN::Frontend->myprint(sprintf(
- "DONE\nFound %s old builds, restored the state of %s\n",
- @candidates ? sprintf("%d",scalar @candidates) : "no",
- $restored || "none",
- ));
-}
+Distribution objects are normally distributions from the CPAN, but
+there is a slightly degenerate case for Distribution objects, too, of
+projects held on the local disk. These distribution objects have the
+same name as the local directory and end with a dot. A dot by itself
+is also allowed for the current directory at the time CPAN.pm was
+used. All actions such as C<make>, C<test>, and C<install> are applied
+directly to that directory. This gives the command C<cpan .> an
+interesting touch: while the normal mantra of installing a CPAN module
+without CPAN.pm is one of
+ perl Makefile.PL perl Build.PL
+ ( go and get prerequisites )
+ make ./Build
+ make test ./Build test
+ make install ./Build install
-#-> sub CPAN::Index::reload_x ;
-sub reload_x {
- my($cl,$wanted,$localname,$force) = @_;
- $force |= 2; # means we're dealing with an index here
- CPAN::HandleConfig->load; # we should guarantee loading wherever
- # we rely on Config XXX
- $localname ||= $wanted;
- my $abs_wanted = File::Spec->catfile($CPAN::Config->{'keep_source_where'},
- $localname);
- if (
- -f $abs_wanted &&
- -M $abs_wanted < $CPAN::Config->{'index_expire'} &&
- !($force & 1)
- ) {
- my $s = $CPAN::Config->{'index_expire'} == 1 ? "" : "s";
- $cl->debug(qq{$abs_wanted younger than $CPAN::Config->{'index_expire'} }.
- qq{day$s. I\'ll use that.});
- return $abs_wanted;
- } else {
- $force |= 1; # means we're quite serious about it.
- }
- return CPAN::FTP->localize($wanted,$abs_wanted,$force);
-}
+the command C<cpan .> does all of this at once. It figures out which
+of the two mantras is appropriate, fetches and installs all
+prerequisites, takes care of them recursively, and finally finishes the
+installation of the module in the current directory, be it a CPAN
+module or not.
-#-> sub CPAN::Index::rd_authindex ;
-sub rd_authindex {
- my($cl, $index_target) = @_;
- return unless defined $index_target;
- return if CPAN::_sqlite_running;
- my @lines;
- $CPAN::Frontend->myprint("Going to read $index_target\n");
- local(*FH);
- tie *FH, 'CPAN::Tarzip', $index_target;
- local($/) = "\n";
- local($_);
- push @lines, split /\012/ while <FH>;
- my $i = 0;
- my $painted = 0;
- foreach (@lines) {
- my($userid,$fullname,$email) =
- m/alias\s+(\S+)\s+\"([^\"\<]*)\s+\<(.*)\>\"/;
- $fullname ||= $email;
- if ($userid && $fullname && $email){
- my $userobj = $CPAN::META->instance('CPAN::Author',$userid);
- $userobj->set('FULLNAME' => $fullname, 'EMAIL' => $email);
- } else {
- CPAN->debug(sprintf "line[%s]", $_) if $CPAN::DEBUG;
- }
- $i++;
- while (($painted/76) < ($i/@lines)) {
- $CPAN::Frontend->myprint(".");
- $painted++;
- }
- return if $CPAN::Signal;
- }
- $CPAN::Frontend->myprint("DONE\n");
-}
+The typical usage case is for private modules or working copies of
+projects from remote repositories on the local disk.
-sub userid {
- my($self,$dist) = @_;
- $dist = $self->{'id'} unless defined $dist;
- my($ret) = $dist =~ m|(?:\w/\w\w/)?([^/]+)/|;
- $ret;
-}
+=head2 Redirection
-#-> sub CPAN::Index::rd_modpacks ;
-sub rd_modpacks {
- my($self, $index_target) = @_;
- return unless defined $index_target;
- return if CPAN::_sqlite_running;
- $CPAN::Frontend->myprint("Going to read $index_target\n");
- my $fh = CPAN::Tarzip->TIEHANDLE($index_target);
- local $_;
- CPAN->debug(sprintf "start[%d]", time) if $CPAN::DEBUG;
- my $slurp = "";
- my $chunk;
- while (my $bytes = $fh->READ(\$chunk,8192)) {
- $slurp.=$chunk;
- }
- my @lines = split /\012/, $slurp;
- CPAN->debug(sprintf "end[%d]", time) if $CPAN::DEBUG;
- undef $fh;
- # read header
- my($line_count,$last_updated);
- while (@lines) {
- my $shift = shift(@lines);
- last if $shift =~ /^\s*$/;
- $shift =~ /^Line-Count:\s+(\d+)/ and $line_count = $1;
- $shift =~ /^Last-Updated:\s+(.+)/ and $last_updated = $1;
- }
- CPAN->debug("line_count[$line_count]last_updated[$last_updated]") if $CPAN::DEBUG;
- if (not defined $line_count) {
+The usual shell redirection symbols C< | > and C<< > >> are recognized
+by the cpan shell B<only when surrounded by whitespace>. So piping to
+pager or redirecting output into a file works somewhat as in a normal
+shell, with the stipulation that you must type extra spaces.
- $CPAN::Frontend->mywarn(qq{Warning: Your $index_target does not contain a Line-Count header.
-Please check the validity of the index file by comparing it to more
-than one CPAN mirror. I'll continue but problems seem likely to
-happen.\a
-});
+=head1 CONFIGURATION
- $CPAN::Frontend->mysleep(5);
- } elsif ($line_count != scalar @lines) {
+When the CPAN module is used for the first time, a configuration
+dialogue tries to determine a couple of site specific options. The
+result of the dialog is stored in a hash reference C< $CPAN::Config >
+in a file CPAN/Config.pm.
- $CPAN::Frontend->mywarn(sprintf qq{Warning: Your %s
-contains a Line-Count header of %d but I see %d lines there. Please
-check the validity of the index file by comparing it to more than one
-CPAN mirror. I'll continue but problems seem likely to happen.\a\n},
-$index_target, $line_count, scalar(@lines));
+Default values defined in the CPAN/Config.pm file can be
+overridden in a user specific file: CPAN/MyConfig.pm. Such a file is
+best placed in C<$HOME/.cpan/CPAN/MyConfig.pm>, because C<$HOME/.cpan> is
+added to the search path of the CPAN module before the use() or
+require() statements. The mkmyconfig command writes this file for you.
- }
- if (not defined $last_updated) {
+The C<o conf> command has various bells and whistles:
- $CPAN::Frontend->mywarn(qq{Warning: Your $index_target does not contain a Last-Updated header.
-Please check the validity of the index file by comparing it to more
-than one CPAN mirror. I'll continue but problems seem likely to
-happen.\a
-});
+=over
- $CPAN::Frontend->mysleep(5);
- } else {
+=item completion support
- $CPAN::Frontend
- ->myprint(sprintf qq{ Database was generated on %s\n},
- $last_updated);
- $DATE_OF_02 = $last_updated;
+If you have a ReadLine module installed, you can hit TAB at any point
+of the commandline and C<o conf> will offer you completion for the
+built-in subcommands and/or config variable names.
- my $age = time;
- if ($CPAN::META->has_inst('HTTP::Date')) {
- require HTTP::Date;
- $age -= HTTP::Date::str2time($last_updated);
- } else {
- $CPAN::Frontend->mywarn(" HTTP::Date not available\n");
- require Time::Local;
- my(@d) = $last_updated =~ / (\d+) (\w+) (\d+) (\d+):(\d+):(\d+) /;
- $d[1] = index("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec", $d[1])/4;
- $age -= $d[1]>=0 ? Time::Local::timegm(@d[5,4,3,0,1,2]) : 0;
- }
- $age /= 3600*24;
- if ($age > 30) {
-
- $CPAN::Frontend
- ->mywarn(sprintf
- qq{Warning: This index file is %d days old.
- Please check the host you chose as your CPAN mirror for staleness.
- I'll continue but problems seem likely to happen.\a\n},
- $age);
-
- } elsif ($age < -1) {
-
- $CPAN::Frontend
- ->mywarn(sprintf
- qq{Warning: Your system date is %d days behind this index file!
- System time: %s
- Timestamp index file: %s
- Please fix your system time, problems with the make command expected.\n},
- -$age,
- scalar gmtime,
- $DATE_OF_02,
- );
+=item displaying some help: o conf help
- }
- }
+Displays a short help
+=item displaying current values: o conf [KEY]
- # A necessity since we have metadata_cache: delete what isn't
- # there anymore
- my $secondtime = $CPAN::META->exists("CPAN::Module","CPAN");
- CPAN->debug("secondtime[$secondtime]") if $CPAN::DEBUG;
- my(%exists);
- my $i = 0;
- my $painted = 0;
- foreach (@lines) {
- # before 1.56 we split into 3 and discarded the rest. From
- # 1.57 we assign remaining text to $comment thus allowing to
- # influence isa_perl
- my($mod,$version,$dist,$comment) = split " ", $_, 4;
- my($bundle,$id,$userid);
-
- if ($mod eq 'CPAN' &&
- ! (
- CPAN::Queue->exists('Bundle::CPAN') ||
- CPAN::Queue->exists('CPAN')
- )
- ) {
- local($^W)= 0;
- if ($version > $CPAN::VERSION){
- $CPAN::Frontend->mywarn(qq{
- New CPAN.pm version (v$version) available.
- [Currently running version is v$CPAN::VERSION]
- You might want to try
- install CPAN
- reload cpan
- to both upgrade CPAN.pm and run the new version without leaving
- the current session.
-
-}); #});
- $CPAN::Frontend->mysleep(2);
- $CPAN::Frontend->myprint(qq{\n});
- }
- last if $CPAN::Signal;
- } elsif ($mod =~ /^Bundle::(.*)/) {
- $bundle = $1;
- }
-
- if ($bundle){
- $id = $CPAN::META->instance('CPAN::Bundle',$mod);
- # Let's make it a module too, because bundles have so much
- # in common with modules.
-
- # Changed in 1.57_63: seems like memory bloat now without
- # any value, so commented out
-
- # $CPAN::META->instance('CPAN::Module',$mod);
-
- } else {
-
- # instantiate a module object
- $id = $CPAN::META->instance('CPAN::Module',$mod);
-
- }
-
- # Although CPAN prohibits same name with different version the
- # indexer may have changed the version for the same distro
- # since the last time ("Force Reindexing" feature)
- if ($id->cpan_file ne $dist
- ||
- $id->cpan_version ne $version
- ){
- $userid = $id->userid || $self->userid($dist);
- $id->set(
- 'CPAN_USERID' => $userid,
- 'CPAN_VERSION' => $version,
- 'CPAN_FILE' => $dist,
- );
- }
-
- # instantiate a distribution object
- if ($CPAN::META->exists('CPAN::Distribution',$dist)) {
- # we do not need CONTAINSMODS unless we do something with
- # this dist, so we better produce it on demand.
-
- ## my $obj = $CPAN::META->instance(
- ## 'CPAN::Distribution' => $dist
- ## );
- ## $obj->{CONTAINSMODS}{$mod} = undef; # experimental
- } else {
- $CPAN::META->instance(
- 'CPAN::Distribution' => $dist
- )->set(
- 'CPAN_USERID' => $userid,
- 'CPAN_COMMENT' => $comment,
- );
- }
- if ($secondtime) {
- for my $name ($mod,$dist) {
- # $self->debug("exists name[$name]") if $CPAN::DEBUG;
- $exists{$name} = undef;
- }
- }
- $i++;
- while (($painted/76) < ($i/@lines)) {
- $CPAN::Frontend->myprint(".");
- $painted++;
- }
- return if $CPAN::Signal;
- }
- $CPAN::Frontend->myprint("DONE\n");
- if ($secondtime) {
- for my $class (qw(CPAN::Module CPAN::Bundle CPAN::Distribution)) {
- for my $o ($CPAN::META->all_objects($class)) {
- next if exists $exists{$o->{ID}};
- $CPAN::META->delete($class,$o->{ID});
- # CPAN->debug("deleting ID[$o->{ID}] in class[$class]")
- # if $CPAN::DEBUG;
- }
- }
- }
-}
+Displays the current value(s) for this config variable. Without KEY,
+displays all subcommands and config variables.
-#-> sub CPAN::Index::rd_modlist ;
-sub rd_modlist {
- my($cl,$index_target) = @_;
- return unless defined $index_target;
- return if CPAN::_sqlite_running;
- $CPAN::Frontend->myprint("Going to read $index_target\n");
- my $fh = CPAN::Tarzip->TIEHANDLE($index_target);
- local $_;
- my $slurp = "";
- my $chunk;
- while (my $bytes = $fh->READ(\$chunk,8192)) {
- $slurp.=$chunk;
- }
- my @eval2 = split /\012/, $slurp;
+Example:
- while (@eval2) {
- my $shift = shift(@eval2);
- if ($shift =~ /^Date:\s+(.*)/){
- if ($DATE_OF_03 eq $1){
- $CPAN::Frontend->myprint("Unchanged.\n");
- return;
- }
- ($DATE_OF_03) = $1;
- }
- last if $shift =~ /^\s*$/;
- }
- push @eval2, q{CPAN::Modulelist->data;};
- local($^W) = 0;
- my($comp) = Safe->new("CPAN::Safe1");
- my($eval2) = join("\n", @eval2);
- CPAN->debug(sprintf "length of eval2[%d]", length $eval2) if $CPAN::DEBUG;
- my $ret = $comp->reval($eval2);
- Carp::confess($@) if $@;
- return if $CPAN::Signal;
- my $i = 0;
- my $until = keys(%$ret);
- my $painted = 0;
- CPAN->debug(sprintf "until[%d]", $until) if $CPAN::DEBUG;
- for (keys %$ret) {
- my $obj = $CPAN::META->instance("CPAN::Module",$_);
- delete $ret->{$_}{modid}; # not needed here, maybe elsewhere
- $obj->set(%{$ret->{$_}});
- $i++;
- while (($painted/76) < ($i/$until)) {
- $CPAN::Frontend->myprint(".");
- $painted++;
- }
- return if $CPAN::Signal;
- }
- $CPAN::Frontend->myprint("DONE\n");
-}
+ o conf shell
-#-> sub CPAN::Index::write_metadata_cache ;
-sub write_metadata_cache {
- my($self) = @_;
- return unless $CPAN::Config->{'cache_metadata'};
- return if CPAN::_sqlite_running;
- return unless $CPAN::META->has_usable("Storable");
- my $cache;
- foreach my $k (qw(CPAN::Bundle CPAN::Author CPAN::Module
- CPAN::Distribution)) {
- $cache->{$k} = $CPAN::META->{readonly}{$k}; # unsafe meta access, ok
- }
- my $metadata_file = File::Spec->catfile($CPAN::Config->{cpan_home},"Metadata");
- $cache->{last_time} = $LAST_TIME;
- $cache->{DATE_OF_02} = $DATE_OF_02;
- $cache->{PROTOCOL} = PROTOCOL;
- $CPAN::Frontend->myprint("Going to write $metadata_file\n");
- eval { Storable::nstore($cache, $metadata_file) };
- $CPAN::Frontend->mywarn($@) if $@; # ?? missing "\n" after $@ in mywarn ??
-}
+If KEY starts and ends with a slash, the string in between is
+treated as a regular expression and only keys matching this regex
+are displayed
-#-> sub CPAN::Index::read_metadata_cache ;
-sub read_metadata_cache {
- my($self) = @_;
- return unless $CPAN::Config->{'cache_metadata'};
- return if CPAN::_sqlite_running;
- return unless $CPAN::META->has_usable("Storable");
- my $metadata_file = File::Spec->catfile($CPAN::Config->{cpan_home},"Metadata");
- return unless -r $metadata_file and -f $metadata_file;
- $CPAN::Frontend->myprint("Going to read $metadata_file\n");
- my $cache;
- eval { $cache = Storable::retrieve($metadata_file) };
- $CPAN::Frontend->mywarn($@) if $@; # ?? missing "\n" after $@ in mywarn ??
- if (!$cache || !UNIVERSAL::isa($cache, 'HASH')){
- $LAST_TIME = 0;
- return;
- }
- if (exists $cache->{PROTOCOL}) {
- if (PROTOCOL > $cache->{PROTOCOL}) {
- $CPAN::Frontend->mywarn(sprintf("Ignoring Metadata cache written ".
- "with protocol v%s, requiring v%s\n",
- $cache->{PROTOCOL},
- PROTOCOL)
- );
- return;
- }
- } else {
- $CPAN::Frontend->mywarn("Ignoring Metadata cache written ".
- "with protocol v1.0\n");
- return;
- }
- my $clcnt = 0;
- my $idcnt = 0;
- while(my($class,$v) = each %$cache) {
- next unless $class =~ /^CPAN::/;
- $CPAN::META->{readonly}{$class} = $v; # unsafe meta access, ok
- while (my($id,$ro) = each %$v) {
- $CPAN::META->{readwrite}{$class}{$id} ||=
- $class->new(ID=>$id, RO=>$ro);
- $idcnt++;
- }
- $clcnt++;
- }
- unless ($clcnt) { # sanity check
- $CPAN::Frontend->myprint("Warning: Found no data in $metadata_file\n");
- return;
- }
- if ($idcnt < 1000) {
- $CPAN::Frontend->myprint("Warning: Found only $idcnt objects ".
- "in $metadata_file\n");
- return;
- }
- $CPAN::META->{PROTOCOL} ||=
- $cache->{PROTOCOL}; # reading does not up or downgrade, but it
- # does initialize to some protocol
- $LAST_TIME = $cache->{last_time};
- $DATE_OF_02 = $cache->{DATE_OF_02};
- $CPAN::Frontend->myprint(" Database was generated on $DATE_OF_02\n")
- if defined $DATE_OF_02; # An old cache may not contain DATE_OF_02
- return;
-}
+Example:
-package CPAN::InfoObj;
-use strict;
+ o conf /color/
-sub ro {
- my $self = shift;
- exists $self->{RO} and return $self->{RO};
-}
+=item changing of scalar values: o conf KEY VALUE
-#-> sub CPAN::InfoObj::cpan_userid
-sub cpan_userid {
- my $self = shift;
- my $ro = $self->ro;
- if ($ro) {
- return $ro->{CPAN_USERID} || "N/A";
- } else {
- $self->debug("ID[$self->{ID}]");
- # N/A for bundles found locally
- return "N/A";
- }
-}
+Sets the config variable KEY to VALUE. The empty string can be
+specified as usual in shells, with C<''> or C<"">
-sub id { shift->{ID}; }
+Example:
-#-> sub CPAN::InfoObj::new ;
-sub new {
- my $this = bless {}, shift;
- %$this = @_;
- $this
-}
+ o conf wget /usr/bin/wget
-# The set method may only be used by code that reads index data or
-# otherwise "objective" data from the outside world. All session
-# related material may do anything else with instance variables but
-# must not touch the hash under the RO attribute. The reason is that
-# the RO hash gets written to Metadata file and is thus persistent.
-
-#-> sub CPAN::InfoObj::safe_chdir ;
-sub safe_chdir {
- my($self,$todir) = @_;
- # we die if we cannot chdir and we are debuggable
- Carp::confess("safe_chdir called without todir argument")
- unless defined $todir and length $todir;
- if (chdir $todir) {
- $self->debug(sprintf "changed directory to %s", CPAN::anycwd())
- if $CPAN::DEBUG;
- } else {
- if (-e $todir) {
- unless (-x $todir) {
- unless (chmod 0755, $todir) {
- my $cwd = CPAN::anycwd();
- $CPAN::Frontend->mywarn("I have neither the -x permission nor the ".
- "permission to change the permission; cannot ".
- "chdir to '$todir'\n");
- $CPAN::Frontend->mysleep(5);
- $CPAN::Frontend->mydie(qq{Could not chdir from cwd[$cwd] }.
- qq{to todir[$todir]: $!});
- }
- }
- } else {
- $CPAN::Frontend->mydie("Directory '$todir' has gone. Cannot continue.\n");
- }
- if (chdir $todir) {
- $self->debug(sprintf "changed directory to %s", CPAN::anycwd())
- if $CPAN::DEBUG;
- } else {
- my $cwd = CPAN::anycwd();
- $CPAN::Frontend->mydie(qq{Could not chdir from cwd[$cwd] }.
- qq{to todir[$todir] (a chmod has been issued): $!});
- }
- }
-}
+=item changing of list values: o conf KEY SHIFT|UNSHIFT|PUSH|POP|SPLICE|LIST
-#-> sub CPAN::InfoObj::set ;
-sub set {
- my($self,%att) = @_;
- my $class = ref $self;
-
- # This must be ||=, not ||, because only if we write an empty
- # reference, only then the set method will write into the readonly
- # area. But for Distributions that spring into existence, maybe
- # because of a typo, we do not like it that they are written into
- # the readonly area and made permanent (at least for a while) and
- # that is why we do not "allow" other places to call ->set.
- unless ($self->id) {
- CPAN->debug("Bug? Empty ID, rejecting");
- return;
- }
- my $ro = $self->{RO} =
- $CPAN::META->{readonly}{$class}{$self->id} ||= {};
+If a config variable name ends with C<list>, it is a list. C<o conf
+KEY shift> removes the first element of the list, C<o conf KEY pop>
+removes the last element of the list. C<o conf KEYS unshift LIST>
+prepends a list of values to the list, C<o conf KEYS push LIST>
+appends a list of valued to the list.
- while (my($k,$v) = each %att) {
- $ro->{$k} = $v;
- }
-}
+Likewise, C<o conf KEY splice LIST> passes the LIST to the corresponding
+splice command.
-#-> sub CPAN::InfoObj::as_glimpse ;
-sub as_glimpse {
- my($self) = @_;
- my(@m);
- my $class = ref($self);
- $class =~ s/^CPAN:://;
- my $id = $self->can("pretty_id") ? $self->pretty_id : $self->{ID};
- push @m, sprintf "%-15s %s\n", $class, $id;
- join "", @m;
-}
+Finally, any other list of arguments is taken as a new list value for
+the KEY variable discarding the previous value.
-#-> sub CPAN::InfoObj::as_string ;
-sub as_string {
- my($self) = @_;
- my(@m);
- my $class = ref($self);
- $class =~ s/^CPAN:://;
- push @m, $class, " id = $self->{ID}\n";
- my $ro;
- unless ($ro = $self->ro) {
- if (substr($self->{ID},-1,1) eq ".") { # directory
- $ro = +{};
- } else {
- $CPAN::Frontend->mydie("Unknown object $self->{ID}");
- }
- }
- for (sort keys %$ro) {
- # next if m/^(ID|RO)$/;
- my $extra = "";
- if ($_ eq "CPAN_USERID") {
- $extra .= " (";
- $extra .= $self->fullname;
- my $email; # old perls!
- if ($email = $CPAN::META->instance("CPAN::Author",
- $self->cpan_userid
- )->email) {
- $extra .= " <$email>";
- } else {
- $extra .= " <no email>";
- }
- $extra .= ")";
- } elsif ($_ eq "FULLNAME") { # potential UTF-8 conversion
- push @m, sprintf " %-12s %s\n", $_, $self->fullname;
- next;
- }
- next unless defined $ro->{$_};
- push @m, sprintf " %-12s %s%s\n", $_, $ro->{$_}, $extra;
- }
- KEY: for (sort keys %$self) {
- next if m/^(ID|RO)$/;
- unless (defined $self->{$_}) {
- delete $self->{$_};
- next KEY;
- }
- if (ref($self->{$_}) eq "ARRAY") {
- push @m, sprintf " %-12s %s\n", $_, "@{$self->{$_}}";
- } elsif (ref($self->{$_}) eq "HASH") {
- my $value;
- if (/^CONTAINSMODS$/) {
- $value = join(" ",sort keys %{$self->{$_}});
- } elsif (/^prereq_pm$/) {
- my @value;
- my $v = $self->{$_};
- for my $x (sort keys %$v) {
- my @svalue;
- for my $y (sort keys %{$v->{$x}}) {
- push @svalue, "$y=>$v->{$x}{$y}";
- }
- push @value, "$x\:" . join ",", @svalue if @svalue;
- }
- $value = join ";", @value;
- } else {
- $value = $self->{$_};
- }
- push @m, sprintf(
- " %-12s %s\n",
- $_,
- $value,
- );
- } else {
- push @m, sprintf " %-12s %s\n", $_, $self->{$_};
- }
- }
- join "", @m, "\n";
-}
+Examples:
-#-> sub CPAN::InfoObj::fullname ;
-sub fullname {
- my($self) = @_;
- $CPAN::META->instance("CPAN::Author",$self->cpan_userid)->fullname;
-}
+ o conf urllist unshift http://cpan.dev.local/CPAN
+ o conf urllist splice 3 1
+ o conf urllist http://cpan1.local http://cpan2.local ftp://ftp.perl.org
-#-> sub CPAN::InfoObj::dump ;
-sub dump {
- my($self, $what) = @_;
- unless ($CPAN::META->has_inst("Data::Dumper")) {
- $CPAN::Frontend->mydie("dump command requires Data::Dumper installed");
- }
- local $Data::Dumper::Sortkeys;
- $Data::Dumper::Sortkeys = 1;
- my $out = Data::Dumper::Dumper($what ? eval $what : $self);
- if (length $out > 100000) {
- my $fh_pager = FileHandle->new;
- local($SIG{PIPE}) = "IGNORE";
- my $pager = $CPAN::Config->{'pager'} || "cat";
- $fh_pager->open("|$pager")
- or die "Could not open pager $pager\: $!";
- $fh_pager->print($out);
- close $fh_pager;
- } else {
- $CPAN::Frontend->myprint($out);
- }
-}
+=item reverting to saved: o conf defaults
-package CPAN::Author;
-use strict;
+Reverts all config variables to the state in the saved config file.
-#-> sub CPAN::Author::force
-sub force {
- my $self = shift;
- $self->{force}++;
-}
+=item saving the config: o conf commit
-#-> sub CPAN::Author::force
-sub unforce {
- my $self = shift;
- delete $self->{force};
-}
+Saves all config variables to the current config file (CPAN/Config.pm
+or CPAN/MyConfig.pm that was loaded at start).
-#-> sub CPAN::Author::id
-sub id {
- my $self = shift;
- my $id = $self->{ID};
- $CPAN::Frontend->mydie("Illegal author id[$id]") unless $id =~ /^[A-Z]/;
- $id;
-}
+=back
-#-> sub CPAN::Author::as_glimpse ;
-sub as_glimpse {
- my($self) = @_;
- my(@m);
- my $class = ref($self);
- $class =~ s/^CPAN:://;
- push @m, sprintf(qq{%-15s %s ("%s" <%s>)\n},
- $class,
- $self->{ID},
- $self->fullname,
- $self->email);
- join "", @m;
-}
+The configuration dialog can be started any time later again by
+issuing the command C< o conf init > in the CPAN shell. A subset of
+the configuration dialog can be run by issuing C<o conf init WORD>
+where WORD is any valid config variable or a regular expression.
-#-> sub CPAN::Author::fullname ;
-sub fullname {
- shift->ro->{FULLNAME};
-}
-*name = \&fullname;
-
-#-> sub CPAN::Author::email ;
-sub email { shift->ro->{EMAIL}; }
-
-#-> sub CPAN::Author::ls ;
-sub ls {
- my $self = shift;
- my $glob = shift || "";
- my $silent = shift || 0;
- my $id = $self->id;
-
- # adapted from CPAN::Distribution::verifyCHECKSUM ;
- my(@csf); # chksumfile
- @csf = $self->id =~ /(.)(.)(.*)/;
- $csf[1] = join "", @csf[0,1];
- $csf[2] = join "", @csf[1,2]; # ("A","AN","ANDK")
- my(@dl);
- @dl = $self->dir_listing([$csf[0],"CHECKSUMS"], 0, 1);
- unless (grep {$_->[2] eq $csf[1]} @dl) {
- $CPAN::Frontend->myprint("Directory $csf[1]/ does not exist\n") unless $silent ;
- return;
- }
- @dl = $self->dir_listing([@csf[0,1],"CHECKSUMS"], 0, 1);
- unless (grep {$_->[2] eq $csf[2]} @dl) {
- $CPAN::Frontend->myprint("Directory $id/ does not exist\n") unless $silent;
- return;
- }
- @dl = $self->dir_listing([@csf,"CHECKSUMS"], 1, 1);
- if ($glob) {
- if ($CPAN::META->has_inst("Text::Glob")) {
- my $rglob = Text::Glob::glob_to_regex($glob);
- @dl = grep { $_->[2] =~ /$rglob/ } @dl;
- } else {
- $CPAN::Frontend->mydie("Text::Glob not installed, cannot proceed");
- }
- }
- $CPAN::Frontend->myprint(join "", map {
- sprintf("%8d %10s %s/%s\n", $_->[0], $_->[1], $id, $_->[2])
- } sort { $a->[2] cmp $b->[2] } @dl);
- @dl;
-}
+=head2 Config Variables
-# returns an array of arrays, the latter contain (size,mtime,filename)
-#-> sub CPAN::Author::dir_listing ;
-sub dir_listing {
- my $self = shift;
- my $chksumfile = shift;
- my $recursive = shift;
- my $may_ftp = shift;
-
- my $lc_want =
- File::Spec->catfile($CPAN::Config->{keep_source_where},
- "authors", "id", @$chksumfile);
-
- my $fh;
-
- # Purge and refetch old (pre-PGP) CHECKSUMS; they are a security
- # hazard. (Without GPG installed they are not that much better,
- # though.)
- $fh = FileHandle->new;
- if (open($fh, $lc_want)) {
- my $line = <$fh>; close $fh;
- unlink($lc_want) unless $line =~ /PGP/;
- }
+The following keys in the hash reference $CPAN::Config are
+currently defined:
- local($") = "/";
- # connect "force" argument with "index_expire".
- my $force = $self->{force};
- if (my @stat = stat $lc_want) {
- $force ||= $stat[9] + $CPAN::Config->{index_expire}*86400 <= time;
- }
- my $lc_file;
- if ($may_ftp) {
- $lc_file = CPAN::FTP->localize(
- "authors/id/@$chksumfile",
- $lc_want,
- $force,
- );
- unless ($lc_file) {
- $CPAN::Frontend->myprint("Trying $lc_want.gz\n");
- $chksumfile->[-1] .= ".gz";
- $lc_file = CPAN::FTP->localize("authors/id/@$chksumfile",
- "$lc_want.gz",1);
- if ($lc_file) {
- $lc_file =~ s{\.gz(?!\n)\Z}{}; #};
- eval{CPAN::Tarzip->new("$lc_file.gz")->gunzip($lc_file)};
- } else {
- return;
- }
- }
- } else {
- $lc_file = $lc_want;
- # we *could* second-guess and if the user has a file: URL,
- # then we could look there. But on the other hand, if they do
- # have a file: URL, wy did they choose to set
- # $CPAN::Config->{show_upload_date} to false?
- }
-
- # adapted from CPAN::Distribution::CHECKSUM_check_file ;
- $fh = FileHandle->new;
- my($cksum);
- if (open $fh, $lc_file){
- local($/);
- my $eval = <$fh>;
- $eval =~ s/\015?\012/\n/g;
- close $fh;
- my($comp) = Safe->new();
- $cksum = $comp->reval($eval);
- if ($@) {
- rename $lc_file, "$lc_file.bad";
- Carp::confess($@) if $@;
- }
- } elsif ($may_ftp) {
- Carp::carp "Could not open '$lc_file' for reading.";
- } else {
- # Maybe should warn: "You may want to set show_upload_date to a true value"
- return;
- }
- my(@result,$f);
- for $f (sort keys %$cksum) {
- if (exists $cksum->{$f}{isdir}) {
- if ($recursive) {
- my(@dir) = @$chksumfile;
- pop @dir;
- push @dir, $f, "CHECKSUMS";
- push @result, map {
- [$_->[0], $_->[1], "$f/$_->[2]"]
- } $self->dir_listing(\@dir,1,$may_ftp);
- } else {
- push @result, [ 0, "-", $f ];
- }
- } else {
- push @result, [
- ($cksum->{$f}{"size"}||0),
- $cksum->{$f}{"mtime"}||"---",
- $f
- ];
- }
- }
- @result;
-}
-
-package CPAN::Distribution;
-use strict;
-
-# Accessors
-sub cpan_comment {
- my $self = shift;
- my $ro = $self->ro or return;
- $ro->{CPAN_COMMENT}
-}
-
-# CPAN::Distribution::undelay
-sub undelay {
- my $self = shift;
- delete $self->{later};
-}
-
-# add the A/AN/ stuff
-# CPAN::Distribution::normalize
-sub normalize {
- my($self,$s) = @_;
- $s = $self->id unless defined $s;
- if (substr($s,-1,1) eq ".") {
- # using a global because we are sometimes called as static method
- if (!$CPAN::META->{LOCK}
- && !$CPAN::Have_warned->{"$s is unlocked"}++
- ) {
- $CPAN::Frontend->mywarn("You are visiting the local directory
- '$s'
- without lock, take care that concurrent processes do not do likewise.\n");
- $CPAN::Frontend->mysleep(1);
- }
- if ($s eq ".") {
- $s = "$CPAN::iCwd/.";
- } elsif (File::Spec->file_name_is_absolute($s)) {
- } elsif (File::Spec->can("rel2abs")) {
- $s = File::Spec->rel2abs($s);
- } else {
- $CPAN::Frontend->mydie("Your File::Spec is too old, please upgrade File::Spec");
- }
- CPAN->debug("s[$s]") if $CPAN::DEBUG;
- unless ($CPAN::META->exists("CPAN::Distribution", $s)) {
- for ($CPAN::META->instance("CPAN::Distribution", $s)) {
- $_->{build_dir} = $s;
- $_->{archived} = "local_directory";
- $_->{unwrapped} = CPAN::Distrostatus->new("YES -- local_directory");
- }
- }
- } elsif (
- $s =~ tr|/|| == 1
- or
- $s !~ m|[A-Z]/[A-Z-]{2}/[A-Z-]{2,}/|
- ) {
- return $s if $s =~ m:^N/A|^Contact Author: ;
- $s =~ s|^(.)(.)([^/]*/)(.+)$|$1/$1$2/$1$2$3$4| or
- $CPAN::Frontend->mywarn("Strange distribution name [$s]\n");
- CPAN->debug("s[$s]") if $CPAN::DEBUG;
- }
- $s;
-}
-
-#-> sub CPAN::Distribution::author ;
-sub author {
- my($self) = @_;
- my($authorid);
- if (substr($self->id,-1,1) eq ".") {
- $authorid = "LOCAL";
- } else {
- ($authorid) = $self->pretty_id =~ /^([\w\-]+)/;
- }
- CPAN::Shell->expand("Author",$authorid);
-}
-
-# tries to get the yaml from CPAN instead of the distro itself:
-# EXPERIMENTAL, UNDOCUMENTED AND UNTESTED, for Tels
-sub fast_yaml {
- my($self) = @_;
- my $meta = $self->pretty_id;
- $meta =~ s/\.(tar.gz|tgz|zip|tar.bz2)/.meta/;
- my(@ls) = CPAN::Shell->globls($meta);
- my $norm = $self->normalize($meta);
-
- my($local_file);
- my($local_wanted) =
- File::Spec->catfile(
- $CPAN::Config->{keep_source_where},
- "authors",
- "id",
- split(/\//,$norm)
- );
- $self->debug("Doing localize") if $CPAN::DEBUG;
- unless ($local_file =
- CPAN::FTP->localize("authors/id/$norm",
- $local_wanted)) {
- $CPAN::Frontend->mydie("Giving up on downloading yaml file '$local_wanted'\n");
- }
- my $yaml = CPAN->_yaml_loadfile($local_file)->[0];
-}
-
-#-> sub CPAN::Distribution::cpan_userid
-sub cpan_userid {
- my $self = shift;
- if ($self->{ID} =~ m{[A-Z]/[A-Z\-]{2}/([A-Z\-]+)/}) {
- return $1;
- }
- return $self->SUPER::cpan_userid;
-}
-
-#-> sub CPAN::Distribution::pretty_id
-sub pretty_id {
- my $self = shift;
- my $id = $self->id;
- return $id unless $id =~ m|^./../|;
- substr($id,5);
-}
-
-# mark as dirty/clean
-#-> sub CPAN::Distribution::color_cmd_tmps ;
-sub color_cmd_tmps {
- my($self) = shift;
- my($depth) = shift || 0;
- my($color) = shift || 0;
- my($ancestors) = shift || [];
- # a distribution needs to recurse into its prereq_pms
-
- return if exists $self->{incommandcolor}
- && $self->{incommandcolor}==$color;
- if ($depth>=100){
- $CPAN::Frontend->mydie(CPAN::Exception::RecursiveDependency->new($ancestors));
- }
- # warn "color_cmd_tmps $depth $color " . $self->id; # sleep 1;
- my $prereq_pm = $self->prereq_pm;
- if (defined $prereq_pm) {
- PREREQ: for my $pre (keys %{$prereq_pm->{requires}||{}},
- keys %{$prereq_pm->{build_requires}||{}}) {
- next PREREQ if $pre eq "perl";
- my $premo;
- unless ($premo = CPAN::Shell->expand("Module",$pre)) {
- $CPAN::Frontend->mywarn("prerequisite module[$pre] not known\n");
- $CPAN::Frontend->mysleep(2);
- next PREREQ;
- }
- $premo->color_cmd_tmps($depth+1,$color,[@$ancestors, $self->id]);
- }
- }
- if ($color==0) {
- delete $self->{sponsored_mods};
-
- # as we are at the end of a command, we'll give up this
- # reminder of a broken test. Other commands may test this guy
- # again. Maybe 'badtestcnt' should be renamed to
- # 'makte_test_failed_within_command'?
- delete $self->{badtestcnt};
- }
- $self->{incommandcolor} = $color;
-}
-
-#-> sub CPAN::Distribution::as_string ;
-sub as_string {
- my $self = shift;
- $self->containsmods;
- $self->upload_date;
- $self->SUPER::as_string(@_);
-}
-
-#-> sub CPAN::Distribution::containsmods ;
-sub containsmods {
- my $self = shift;
- return keys %{$self->{CONTAINSMODS}} if exists $self->{CONTAINSMODS};
- my $dist_id = $self->{ID};
- for my $mod ($CPAN::META->all_objects("CPAN::Module")) {
- my $mod_file = $mod->cpan_file or next;
- my $mod_id = $mod->{ID} or next;
- # warn "mod_file[$mod_file] dist_id[$dist_id] mod_id[$mod_id]";
- # sleep 1;
- if ($CPAN::Signal) {
- delete $self->{CONTAINSMODS};
- return;
- }
- $self->{CONTAINSMODS}{$mod_id} = undef if $mod_file eq $dist_id;
- }
- keys %{$self->{CONTAINSMODS}||{}};
-}
-
-#-> sub CPAN::Distribution::upload_date ;
-sub upload_date {
- my $self = shift;
- return $self->{UPLOAD_DATE} if exists $self->{UPLOAD_DATE};
- my(@local_wanted) = split(/\//,$self->id);
- my $filename = pop @local_wanted;
- push @local_wanted, "CHECKSUMS";
- my $author = CPAN::Shell->expand("Author",$self->cpan_userid);
- return unless $author;
- my @dl = $author->dir_listing(\@local_wanted,0,$CPAN::Config->{show_upload_date});
- return unless @dl;
- my($dirent) = grep { $_->[2] eq $filename } @dl;
- # warn sprintf "dirent[%s]id[%s]", $dirent, $self->id;
- return unless $dirent->[1];
- return $self->{UPLOAD_DATE} = $dirent->[1];
-}
-
-#-> sub CPAN::Distribution::uptodate ;
-sub uptodate {
- my($self) = @_;
- my $c;
- foreach $c ($self->containsmods) {
- my $obj = CPAN::Shell->expandany($c);
- unless ($obj->uptodate){
- my $id = $self->pretty_id;
- $self->debug("$id not uptodate due to $c") if $CPAN::DEBUG;
- return 0;
- }
- }
- return 1;
-}
-
-#-> sub CPAN::Distribution::called_for ;
-sub called_for {
- my($self,$id) = @_;
- $self->{CALLED_FOR} = $id if defined $id;
- return $self->{CALLED_FOR};
-}
-
-#-> sub CPAN::Distribution::get ;
-sub get {
- my($self) = @_;
- $self->debug("checking goto id[$self->{ID}]") if $CPAN::DEBUG;
- if (my $goto = $self->prefs->{goto}) {
- $CPAN::Frontend->mywarn
- (sprintf(
- "delegating to '%s' as specified in prefs file '%s' doc %d\n",
- $goto,
- $self->{prefs_file},
- $self->{prefs_file_doc},
- ));
- return $self->goto($goto);
- }
- local $ENV{PERL5LIB} = defined($ENV{PERL5LIB})
- ? $ENV{PERL5LIB}
- : ($ENV{PERLLIB} || "");
-
- $CPAN::META->set_perl5lib;
- local $ENV{MAKEFLAGS}; # protect us from outer make calls
-
- EXCUSE: {
- my @e;
- $self->debug("checking disabled id[$self->{ID}]") if $CPAN::DEBUG;
- if ($self->prefs->{disabled}) {
- my $why = sprintf(
- "Disabled via prefs file '%s' doc %d",
- $self->{prefs_file},
- $self->{prefs_file_doc},
- );
- push @e, $why;
- $self->{unwrapped} = CPAN::Distrostatus->new("NO -- $why");
- # note: not intended to be persistent but at least visible
- # during this session
- } else {
- if (exists $self->{build_dir}) {
- # this deserves print, not warn:
- $CPAN::Frontend->myprint(" Has already been unwrapped into directory ".
- "$self->{build_dir}\n"
- );
- return;
- }
-
- # although we talk about 'force' we shall not test on
- # force directly. New model of force tries to refrain from
- # direct checking of force.
- exists $self->{unwrapped} and (
- UNIVERSAL::can($self->{unwrapped},"failed") ?
- $self->{unwrapped}->failed :
- $self->{unwrapped} =~ /^NO/
- )
- and push @e, "Unwrapping had some problem, won't try again without force";
- }
-
- $CPAN::Frontend->mywarn(join "", map {"$_\n"} @e) and return if @e;
- }
- my $sub_wd = CPAN::anycwd(); # for cleaning up as good as possible
-
- #
- # Get the file on local disk
- #
-
- my($local_file);
- my($local_wanted) =
- File::Spec->catfile(
- $CPAN::Config->{keep_source_where},
- "authors",
- "id",
- split(/\//,$self->id)
- );
-
- $self->debug("Doing localize") if $CPAN::DEBUG;
- unless ($local_file =
- CPAN::FTP->localize("authors/id/$self->{ID}",
- $local_wanted)) {
- my $note = "";
- if ($CPAN::Index::DATE_OF_02) {
- $note = "Note: Current database in memory was generated ".
- "on $CPAN::Index::DATE_OF_02\n";
- }
- $CPAN::Frontend->mydie("Giving up on '$local_wanted'\n$note");
- }
-
- $self->debug("local_wanted[$local_wanted]local_file[$local_file]") if $CPAN::DEBUG;
- $self->{localfile} = $local_file;
- return if $CPAN::Signal;
-
- #
- # Check integrity
- #
- if ($CPAN::META->has_inst("Digest::SHA")) {
- $self->debug("Digest::SHA is installed, verifying");
- $self->verifyCHECKSUM;
- } else {
- $self->debug("Digest::SHA is NOT installed");
- }
- return if $CPAN::Signal;
-
- #
- # Create a clean room and go there
- #
- $CPAN::META->{cachemgr} ||= CPAN::CacheMgr->new(); # unsafe meta access, ok
- my $builddir = $CPAN::META->{cachemgr}->dir; # unsafe meta access, ok
- $self->safe_chdir($builddir);
- $self->debug("Removing tmp-$$") if $CPAN::DEBUG;
- File::Path::rmtree("tmp-$$");
- unless (mkdir "tmp-$$", 0755) {
- $CPAN::Frontend->unrecoverable_error(<<EOF);
-Couldn't mkdir '$builddir/tmp-$$': $!
-
-Cannot continue: Please find the reason why I cannot make the
-directory
-$builddir/tmp-$$
-and fix the problem, then retry.
-
-EOF
- }
- if ($CPAN::Signal){
- $self->safe_chdir($sub_wd);
- return;
- }
- $self->safe_chdir("tmp-$$");
-
- #
- # Unpack the goods
- #
- my $ct = eval{CPAN::Tarzip->new($local_file)};
- unless ($ct) {
- $self->{unwrapped} = CPAN::Distrostatus->new("NO");
- delete $self->{build_dir};
- return;
- }
- if ($local_file =~ /(\.tar\.(bz2|gz|Z)|\.tgz)(?!\n)\Z/i){
- $self->{was_uncompressed}++ unless eval{$ct->gtest()};
- $self->untar_me($ct);
- } elsif ( $local_file =~ /\.zip(?!\n)\Z/i ) {
- $self->unzip_me($ct);
- } else {
- $self->{was_uncompressed}++ unless $ct->gtest();
- $local_file = $self->handle_singlefile($local_file);
-# } else {
-# $self->{archived} = "NO";
-# $self->safe_chdir($sub_wd);
-# return;
- }
-
- # we are still in the tmp directory!
- # Let's check if the package has its own directory.
- my $dh = DirHandle->new(File::Spec->curdir)
- or Carp::croak("Couldn't opendir .: $!");
- my @readdir = grep $_ !~ /^\.\.?(?!\n)\Z/s, $dh->read; ### MAC??
- $dh->close;
- my ($packagedir);
- # XXX here we want in each branch File::Temp to protect all build_dir directories
- if (CPAN->has_inst("File::Temp")) {
- my $tdir_base;
- my $from_dir;
- my @dirents;
- if (@readdir == 1 && -d $readdir[0]) {
- $tdir_base = $readdir[0];
- $from_dir = File::Spec->catdir(File::Spec->curdir,$readdir[0]);
- my $dh2 = DirHandle->new($from_dir)
- or Carp::croak("Couldn't opendir $from_dir: $!");
- @dirents = grep $_ !~ /^\.\.?(?!\n)\Z/s, $dh2->read; ### MAC??
- } else {
- my $userid = $self->cpan_userid;
- CPAN->debug("userid[$userid]");
- if (!$userid or $userid eq "N/A") {
- $userid = "anon";
- }
- $tdir_base = $userid;
- $from_dir = File::Spec->curdir;
- @dirents = @readdir;
- }
- $packagedir = File::Temp::tempdir(
- "$tdir_base-XXXXXX",
- DIR => $builddir,
- CLEANUP => 0,
- );
- my $f;
- for $f (@dirents) { # is already without "." and ".."
- my $from = File::Spec->catdir($from_dir,$f);
- my $to = File::Spec->catdir($packagedir,$f);
- unless (File::Copy::move($from,$to)) {
- my $err = $!;
- $from = File::Spec->rel2abs($from);
- Carp::confess("Couldn't move $from to $to: $err");
- }
- }
- } else { # older code below, still better than nothing when there is no File::Temp
- my($distdir);
- if (@readdir == 1 && -d $readdir[0]) {
- $distdir = $readdir[0];
- $packagedir = File::Spec->catdir($builddir,$distdir);
- $self->debug("packagedir[$packagedir]builddir[$builddir]distdir[$distdir]")
- if $CPAN::DEBUG;
- -d $packagedir and $CPAN::Frontend->myprint("Removing previously used ".
- "$packagedir\n");
- File::Path::rmtree($packagedir);
- unless (File::Copy::move($distdir,$packagedir)) {
- $CPAN::Frontend->unrecoverable_error(<<EOF);
-Couldn't move '$distdir' to '$packagedir': $!
-
-Cannot continue: Please find the reason why I cannot move
-$builddir/tmp-$$/$distdir
-to
-$packagedir
-and fix the problem, then retry
-
-EOF
- }
- $self->debug(sprintf("moved distdir[%s] to packagedir[%s] -e[%s]-d[%s]",
- $distdir,
- $packagedir,
- -e $packagedir,
- -d $packagedir,
- )) if $CPAN::DEBUG;
- } else {
- my $userid = $self->cpan_userid;
- CPAN->debug("userid[$userid]") if $CPAN::DEBUG;
- if (!$userid or $userid eq "N/A") {
- $userid = "anon";
- }
- my $pragmatic_dir = $userid . '000';
- $pragmatic_dir =~ s/\W_//g;
- $pragmatic_dir++ while -d "../$pragmatic_dir";
- $packagedir = File::Spec->catdir($builddir,$pragmatic_dir);
- $self->debug("packagedir[$packagedir]") if $CPAN::DEBUG;
- File::Path::mkpath($packagedir);
- my($f);
- for $f (@readdir) { # is already without "." and ".."
- my $to = File::Spec->catdir($packagedir,$f);
- File::Copy::move($f,$to) or Carp::confess("Couldn't move $f to $to: $!");
- }
- }
- }
- if ($CPAN::Signal){
- $self->safe_chdir($sub_wd);
- return;
- }
-
- $self->{build_dir} = $packagedir;
- $self->safe_chdir($builddir);
- File::Path::rmtree("tmp-$$");
-
- $self->safe_chdir($packagedir);
- $self->_signature_business();
- $self->safe_chdir($builddir);
- return if $CPAN::Signal;
-
-
- my($mpl) = File::Spec->catfile($packagedir,"Makefile.PL");
- my($mpl_exists) = -f $mpl;
- unless ($mpl_exists) {
- # NFS has been reported to have racing problems after the
- # renaming of a directory in some environments.
- # This trick helps.
- $CPAN::Frontend->mysleep(1);
- my $mpldh = DirHandle->new($packagedir)
- or Carp::croak("Couldn't opendir $packagedir: $!");
- $mpl_exists = grep /^Makefile\.PL$/, $mpldh->read;
- $mpldh->close;
- }
- my $prefer_installer = "eumm"; # eumm|mb
- if (-f File::Spec->catfile($packagedir,"Build.PL")) {
- if ($mpl_exists) { # they *can* choose
- $prefer_installer = CPAN::HandleConfig->prefs_lookup($self,
- q{prefer_installer});
- } else {
- $prefer_installer = "mb";
- }
- }
- return unless $self->patch;
- if (lc($prefer_installer) eq "mb") {
- $self->{modulebuild} = 1;
- } elsif (! $mpl_exists) {
- $self->_edge_cases($mpl,$packagedir,$local_file);
- }
- if ($self->{build_dir}
- &&
- $CPAN::Config->{build_dir_reuse}
- ) {
- $self->store_persistent_state;
- }
-
- return $self;
-}
-
-#-> CPAN::Distribution::store_persistent_state
-sub store_persistent_state {
- my($self) = @_;
- my $dir = $self->{build_dir};
- unless (File::Spec->canonpath(File::Basename::dirname($dir))
- eq File::Spec->canonpath($CPAN::Config->{build_dir})) {
- $CPAN::Frontend->mywarn("Directory '$dir' not below $CPAN::Config->{build_dir}, ".
- "will not store persistent state\n");
- return;
- }
- my $file = sprintf "%s.yml", $dir;
- my $yaml_module = CPAN::_yaml_module;
- if ($CPAN::META->has_inst($yaml_module)) {
- CPAN->_yaml_dumpfile(
- $file,
- {
- time => time,
- perl => CPAN::_perl_fingerprint,
- distribution => $self,
- }
- );
- } else {
- $CPAN::Frontend->myprint("Warning (usually harmless): '$yaml_module' not installed, ".
- "will not store persistent state\n");
- }
-}
-
-#-> CPAN::Distribution::patch
-sub try_download {
- my($self,$patch) = @_;
- my $norm = $self->normalize($patch);
- my($local_wanted) =
- File::Spec->catfile(
- $CPAN::Config->{keep_source_where},
- "authors",
- "id",
- split(/\//,$norm),
- );
- $self->debug("Doing localize") if $CPAN::DEBUG;
- return CPAN::FTP->localize("authors/id/$norm",
- $local_wanted);
-}
-
-#-> CPAN::Distribution::patch
-sub patch {
- my($self) = @_;
- $self->debug("checking patches id[$self->{ID}]") if $CPAN::DEBUG;
- my $patches = $self->prefs->{patches};
- $patches ||= "";
- $self->debug("patches[$patches]") if $CPAN::DEBUG;
- if ($patches) {
- return unless @$patches;
- $self->safe_chdir($self->{build_dir});
- CPAN->debug("patches[$patches]") if $CPAN::DEBUG;
- my $patchbin = $CPAN::Config->{patch};
- unless ($patchbin && length $patchbin) {
- $CPAN::Frontend->mydie("No external patch command configured\n\n".
- "Please run 'o conf init /patch/'\n\n");
- }
- unless (MM->maybe_command($patchbin)) {
- $CPAN::Frontend->mydie("No external patch command available\n\n".
- "Please run 'o conf init /patch/'\n\n");
- }
- $patchbin = CPAN::HandleConfig->safe_quote($patchbin);
- local $ENV{PATCH_GET} = 0; # shall replace -g0 which is not
- # supported everywhere (and then,
- # not ever necessary there)
- my $stdpatchargs = "-N --fuzz=3";
- my $countedpatches = @$patches == 1 ? "1 patch" : (scalar @$patches . " patches");
- $CPAN::Frontend->myprint("Going to apply $countedpatches:\n");
- for my $patch (@$patches) {
- unless (-f $patch) {
- if (my $trydl = $self->try_download($patch)) {
- $patch = $trydl;
- } else {
- my $fail = "Could not find patch '$patch'";
- $CPAN::Frontend->mywarn("$fail; cannot continue\n");
- $self->{unwrapped} = CPAN::Distrostatus->new("NO -- $fail");
- delete $self->{build_dir};
- return;
- }
- }
- $CPAN::Frontend->myprint(" $patch\n");
- my $readfh = CPAN::Tarzip->TIEHANDLE($patch);
-
- my $pcommand;
- my $ppp = $self->_patch_p_parameter($readfh);
- if ($ppp eq "applypatch") {
- $pcommand = "$CPAN::Config->{applypatch} -verbose";
- } else {
- my $thispatchargs = join " ", $stdpatchargs, $ppp;
- $pcommand = "$patchbin $thispatchargs";
- }
-
- $readfh = CPAN::Tarzip->TIEHANDLE($patch); # open again
- my $writefh = FileHandle->new;
- $CPAN::Frontend->myprint(" $pcommand\n");
- unless (open $writefh, "|$pcommand") {
- my $fail = "Could not fork '$pcommand'";
- $CPAN::Frontend->mywarn("$fail; cannot continue\n");
- $self->{unwrapped} = CPAN::Distrostatus->new("NO -- $fail");
- delete $self->{build_dir};
- return;
- }
- while (my $x = $readfh->READLINE) {
- print $writefh $x;
- }
- unless (close $writefh) {
- my $fail = "Could not apply patch '$patch'";
- $CPAN::Frontend->mywarn("$fail; cannot continue\n");
- $self->{unwrapped} = CPAN::Distrostatus->new("NO -- $fail");
- delete $self->{build_dir};
- return;
- }
- }
- $self->{patched}++;
- }
- return 1;
-}
-
-sub _patch_p_parameter {
- my($self,$fh) = @_;
- my $cnt_files = 0;
- my $cnt_p0files = 0;
- local($_);
- while ($_ = $fh->READLINE) {
- if (
- $CPAN::Config->{applypatch}
- &&
- /\#\#\#\# ApplyPatch data follows \#\#\#\#/
- ) {
- return "applypatch"
- }
- next unless /^[\*\+]{3}\s(\S+)/;
- my $file = $1;
- $cnt_files++;
- $cnt_p0files++ if -f $file;
- CPAN->debug("file[$file]cnt_files[$cnt_files]cnt_p0files[$cnt_p0files]")
- if $CPAN::DEBUG;
- }
- return "-p1" unless $cnt_files;
- return $cnt_files==$cnt_p0files ? "-p0" : "-p1";
-}
-
-#-> sub CPAN::Distribution::_edge_cases
-# with "configure" or "Makefile" or single file scripts
-sub _edge_cases {
- my($self,$mpl,$packagedir,$local_file) = @_;
- $self->debug(sprintf("makefilepl[%s]anycwd[%s]",
- $mpl,
- CPAN::anycwd(),
- )) if $CPAN::DEBUG;
- my($configure) = File::Spec->catfile($packagedir,"Configure");
- if (-f $configure) {
- # do we have anything to do?
- $self->{configure} = $configure;
- } elsif (-f File::Spec->catfile($packagedir,"Makefile")) {
- $CPAN::Frontend->mywarn(qq{
-Package comes with a Makefile and without a Makefile.PL.
-We\'ll try to build it with that Makefile then.
-});
- $self->{writemakefile} = CPAN::Distrostatus->new("YES");
- $CPAN::Frontend->mysleep(2);
- } else {
- my $cf = $self->called_for || "unknown";
- if ($cf =~ m|/|) {
- $cf =~ s|.*/||;
- $cf =~ s|\W.*||;
- }
- $cf =~ s|[/\\:]||g; # risk of filesystem damage
- $cf = "unknown" unless length($cf);
- $CPAN::Frontend->mywarn(qq{Package seems to come without Makefile.PL.
- (The test -f "$mpl" returned false.)
- Writing one on our own (setting NAME to $cf)\a\n});
- $self->{had_no_makefile_pl}++;
- $CPAN::Frontend->mysleep(3);
-
- # Writing our own Makefile.PL
-
- my $script = "";
- if ($self->{archived} eq "maybe_pl") {
- my $fh = FileHandle->new;
- my $script_file = File::Spec->catfile($packagedir,$local_file);
- $fh->open($script_file)
- or Carp::croak("Could not open $script_file: $!");
- local $/ = "\n";
- # name parsen und prereq
- my($state) = "poddir";
- my($name, $prereq) = ("", "");
- while (<$fh>) {
- if ($state eq "poddir" && /^=head\d\s+(\S+)/) {
- if ($1 eq 'NAME') {
- $state = "name";
- } elsif ($1 eq 'PREREQUISITES') {
- $state = "prereq";
- }
- } elsif ($state =~ m{^(name|prereq)$}) {
- if (/^=/) {
- $state = "poddir";
- } elsif (/^\s*$/) {
- # nop
- } elsif ($state eq "name") {
- if ($name eq "") {
- ($name) = /^(\S+)/;
- $state = "poddir";
- }
- } elsif ($state eq "prereq") {
- $prereq .= $_;
- }
- } elsif (/^=cut\b/) {
- last;
- }
- }
- $fh->close;
-
- for ($name) {
- s{.*<}{}; # strip X<...>
- s{>.*}{};
- }
- chomp $prereq;
- $prereq = join " ", split /\s+/, $prereq;
- my($PREREQ_PM) = join("\n", map {
- s{.*<}{}; # strip X<...>
- s{>.*}{};
- if (/[\s\'\"]/) { # prose?
- } else {
- s/[^\w:]$//; # period?
- " "x28 . "'$_' => 0,";
- }
- } split /\s*,\s*/, $prereq);
-
- $script = "
- EXE_FILES => ['$name'],
- PREREQ_PM => {
-$PREREQ_PM
- },
-";
- if ($name) {
- my $to_file = File::Spec->catfile($packagedir, $name);
- rename $script_file, $to_file
- or die "Can't rename $script_file to $to_file: $!";
- }
- }
-
- my $fh = FileHandle->new;
- $fh->open(">$mpl")
- or Carp::croak("Could not open >$mpl: $!");
- $fh->print(
- qq{# This Makefile.PL has been autogenerated by the module CPAN.pm
-# because there was no Makefile.PL supplied.
-# Autogenerated on: }.scalar localtime().qq{
-
-use ExtUtils::MakeMaker;
-WriteMakefile(
- NAME => q[$cf],$script
- );
-});
- $fh->close;
- }
-}
-
-#-> CPAN::Distribution::_signature_business
-sub _signature_business {
- my($self) = @_;
- my $check_sigs = CPAN::HandleConfig->prefs_lookup($self,
- q{check_sigs});
- if ($check_sigs) {
- if ($CPAN::META->has_inst("Module::Signature")) {
- if (-f "SIGNATURE") {
- $self->debug("Module::Signature is installed, verifying") if $CPAN::DEBUG;
- my $rv = Module::Signature::verify();
- if ($rv != Module::Signature::SIGNATURE_OK() and
- $rv != Module::Signature::SIGNATURE_MISSING()) {
- $CPAN::Frontend->mywarn(
- qq{\nSignature invalid for }.
- qq{distribution file. }.
- qq{Please investigate.\n\n}
- );
-
- my $wrap =
- sprintf(qq{I'd recommend removing %s. Its signature
-is invalid. Maybe you have configured your 'urllist' with
-a bad URL. Please check this array with 'o conf urllist', and
-retry. For more information, try opening a subshell with
- look %s
-and there run
- cpansign -v
-},
- $self->{localfile},
- $self->pretty_id,
- );
- $self->{signature_verify} = CPAN::Distrostatus->new("NO");
- $CPAN::Frontend->mywarn(Text::Wrap::wrap("","",$wrap));
- $CPAN::Frontend->mysleep(5) if $CPAN::Frontend->can("mysleep");
- } else {
- $self->{signature_verify} = CPAN::Distrostatus->new("YES");
- $self->debug("Module::Signature has verified") if $CPAN::DEBUG;
- }
- } else {
- $CPAN::Frontend->mywarn(qq{Package came without SIGNATURE\n\n});
- }
- } else {
- $self->debug("Module::Signature is NOT installed") if $CPAN::DEBUG;
- }
- }
-}
-
-#-> CPAN::Distribution::untar_me ;
-sub untar_me {
- my($self,$ct) = @_;
- $self->{archived} = "tar";
- if ($ct->untar()) {
- $self->{unwrapped} = CPAN::Distrostatus->new("YES");
- } else {
- $self->{unwrapped} = CPAN::Distrostatus->new("NO -- untar failed");
- }
-}
-
-# CPAN::Distribution::unzip_me ;
-sub unzip_me {
- my($self,$ct) = @_;
- $self->{archived} = "zip";
- if ($ct->unzip()) {
- $self->{unwrapped} = CPAN::Distrostatus->new("YES");
- } else {
- $self->{unwrapped} = CPAN::Distrostatus->new("NO -- unzip failed");
- }
- return;
-}
-
-sub handle_singlefile {
- my($self,$local_file) = @_;
-
- if ( $local_file =~ /\.pm(\.(gz|Z))?(?!\n)\Z/ ){
- $self->{archived} = "pm";
- } else {
- $self->{archived} = "maybe_pl";
- }
-
- my $to = File::Basename::basename($local_file);
- if ($to =~ s/\.(gz|Z)(?!\n)\Z//) {
- if (eval{CPAN::Tarzip->new($local_file)->gunzip($to)}) {
- $self->{unwrapped} = CPAN::Distrostatus->new("YES");
- } else {
- $self->{unwrapped} = CPAN::Distrostatus->new("NO -- uncompressing failed");
- }
- } else {
- File::Copy::cp($local_file,".");
- $self->{unwrapped} = CPAN::Distrostatus->new("NO -- copying failed");
- }
- return $to;
-}
-
-#-> sub CPAN::Distribution::new ;
-sub new {
- my($class,%att) = @_;
-
- # $CPAN::META->{cachemgr} ||= CPAN::CacheMgr->new();
-
- my $this = { %att };
- return bless $this, $class;
-}
-
-#-> sub CPAN::Distribution::look ;
-sub look {
- my($self) = @_;
-
- if ($^O eq 'MacOS') {
- $self->Mac::BuildTools::look;
- return;
- }
-
- if ( $CPAN::Config->{'shell'} ) {
- $CPAN::Frontend->myprint(qq{
-Trying to open a subshell in the build directory...
-});
- } else {
- $CPAN::Frontend->myprint(qq{
-Your configuration does not define a value for subshells.
-Please define it with "o conf shell <your shell>"
-});
- return;
- }
- my $dist = $self->id;
- my $dir;
- unless ($dir = $self->dir) {
- $self->get;
- }
- unless ($dir ||= $self->dir) {
- $CPAN::Frontend->mywarn(qq{
-Could not determine which directory to use for looking at $dist.
-});
- return;
- }
- my $pwd = CPAN::anycwd();
- $self->safe_chdir($dir);
- $CPAN::Frontend->myprint(qq{Working directory is $dir\n});
- {
- local $ENV{CPAN_SHELL_LEVEL} = $ENV{CPAN_SHELL_LEVEL}||0;
- $ENV{CPAN_SHELL_LEVEL} += 1;
- my $shell = CPAN::HandleConfig->safe_quote($CPAN::Config->{'shell'});
- unless (system($shell) == 0) {
- my $code = $? >> 8;
- $CPAN::Frontend->mywarn("Subprocess shell exit code $code\n");
- }
- }
- $self->safe_chdir($pwd);
-}
-
-# CPAN::Distribution::cvs_import ;
-sub cvs_import {
- my($self) = @_;
- $self->get;
- my $dir = $self->dir;
-
- my $package = $self->called_for;
- my $module = $CPAN::META->instance('CPAN::Module', $package);
- my $version = $module->cpan_version;
-
- my $userid = $self->cpan_userid;
-
- my $cvs_dir = (split /\//, $dir)[-1];
- $cvs_dir =~ s/-\d+[^-]+(?!\n)\Z//;
- my $cvs_root =
- $CPAN::Config->{cvsroot} || $ENV{CVSROOT};
- my $cvs_site_perl =
- $CPAN::Config->{cvs_site_perl} || $ENV{CVS_SITE_PERL};
- if ($cvs_site_perl) {
- $cvs_dir = "$cvs_site_perl/$cvs_dir";
- }
- my $cvs_log = qq{"imported $package $version sources"};
- $version =~ s/\./_/g;
- # XXX cvs: undocumented and unclear how it was meant to work
- my @cmd = ('cvs', '-d', $cvs_root, 'import', '-m', $cvs_log,
- "$cvs_dir", $userid, "v$version");
-
- my $pwd = CPAN::anycwd();
- chdir($dir) or $CPAN::Frontend->mydie(qq{Could not chdir to "$dir": $!});
-
- $CPAN::Frontend->myprint(qq{Working directory is $dir\n});
-
- $CPAN::Frontend->myprint(qq{@cmd\n});
- system(@cmd) == 0 or
- # XXX cvs
- $CPAN::Frontend->mydie("cvs import failed");
- chdir($pwd) or $CPAN::Frontend->mydie(qq{Could not chdir to "$pwd": $!});
-}
-
-#-> sub CPAN::Distribution::readme ;
-sub readme {
- my($self) = @_;
- my($dist) = $self->id;
- my($sans,$suffix) = $dist =~ /(.+)\.(tgz|tar[\._-]gz|tar\.Z|zip)$/;
- $self->debug("sans[$sans] suffix[$suffix]\n") if $CPAN::DEBUG;
- my($local_file);
- my($local_wanted) =
- File::Spec->catfile(
- $CPAN::Config->{keep_source_where},
- "authors",
- "id",
- split(/\//,"$sans.readme"),
- );
- $self->debug("Doing localize") if $CPAN::DEBUG;
- $local_file = CPAN::FTP->localize("authors/id/$sans.readme",
- $local_wanted)
- or $CPAN::Frontend->mydie(qq{No $sans.readme found});;
-
- if ($^O eq 'MacOS') {
- Mac::BuildTools::launch_file($local_file);
- return;
- }
-
- my $fh_pager = FileHandle->new;
- local($SIG{PIPE}) = "IGNORE";
- my $pager = $CPAN::Config->{'pager'} || "cat";
- $fh_pager->open("|$pager")
- or die "Could not open pager $pager\: $!";
- my $fh_readme = FileHandle->new;
- $fh_readme->open($local_file)
- or $CPAN::Frontend->mydie(qq{Could not open "$local_file": $!});
- $CPAN::Frontend->myprint(qq{
-Displaying file
- $local_file
-with pager "$pager"
-});
- $fh_pager->print(<$fh_readme>);
- $fh_pager->close;
-}
-
-#-> sub CPAN::Distribution::verifyCHECKSUM ;
-sub verifyCHECKSUM {
- my($self) = @_;
- EXCUSE: {
- my @e;
- $self->{CHECKSUM_STATUS} ||= "";
- $self->{CHECKSUM_STATUS} eq "OK" and push @e, "Checksum was ok";
- $CPAN::Frontend->myprint(join "", map {" $_\n"} @e) and return if @e;
- }
- my($lc_want,$lc_file,@local,$basename);
- @local = split(/\//,$self->id);
- pop @local;
- push @local, "CHECKSUMS";
- $lc_want =
- File::Spec->catfile($CPAN::Config->{keep_source_where},
- "authors", "id", @local);
- local($") = "/";
- if (my $size = -s $lc_want) {
- $self->debug("lc_want[$lc_want]size[$size]") if $CPAN::DEBUG;
- if ($self->CHECKSUM_check_file($lc_want,1)) {
- return $self->{CHECKSUM_STATUS} = "OK";
- }
- }
- $lc_file = CPAN::FTP->localize("authors/id/@local",
- $lc_want,1);
- unless ($lc_file) {
- $CPAN::Frontend->myprint("Trying $lc_want.gz\n");
- $local[-1] .= ".gz";
- $lc_file = CPAN::FTP->localize("authors/id/@local",
- "$lc_want.gz",1);
- if ($lc_file) {
- $lc_file =~ s/\.gz(?!\n)\Z//;
- eval{CPAN::Tarzip->new("$lc_file.gz")->gunzip($lc_file)};
- } else {
- return;
- }
- }
- if ($self->CHECKSUM_check_file($lc_file)) {
- return $self->{CHECKSUM_STATUS} = "OK";
- }
-}
-
-#-> sub CPAN::Distribution::SIG_check_file ;
-sub SIG_check_file {
- my($self,$chk_file) = @_;
- my $rv = eval { Module::Signature::_verify($chk_file) };
-
- if ($rv == Module::Signature::SIGNATURE_OK()) {
- $CPAN::Frontend->myprint("Signature for $chk_file ok\n");
- return $self->{SIG_STATUS} = "OK";
- } else {
- $CPAN::Frontend->myprint(qq{\nSignature invalid for }.
- qq{distribution file. }.
- qq{Please investigate.\n\n}.
- $self->as_string,
- $CPAN::META->instance(
- 'CPAN::Author',
- $self->cpan_userid
- )->as_string);
-
- my $wrap = qq{I\'d recommend removing $chk_file. Its signature
-is invalid. Maybe you have configured your 'urllist' with
-a bad URL. Please check this array with 'o conf urllist', and
-retry.};
-
- $CPAN::Frontend->mydie(Text::Wrap::wrap("","",$wrap));
- }
-}
-
-#-> sub CPAN::Distribution::CHECKSUM_check_file ;
-
-# sloppy is 1 when we have an old checksums file that maybe is good
-# enough
-
-sub CHECKSUM_check_file {
- my($self,$chk_file,$sloppy) = @_;
- my($cksum,$file,$basename);
-
- $sloppy ||= 0;
- $self->debug("chk_file[$chk_file]sloppy[$sloppy]") if $CPAN::DEBUG;
- my $check_sigs = CPAN::HandleConfig->prefs_lookup($self,
- q{check_sigs});
- if ($check_sigs) {
- if ($CPAN::META->has_inst("Module::Signature")) {
- $self->debug("Module::Signature is installed, verifying") if $CPAN::DEBUG;
- $self->SIG_check_file($chk_file);
- } else {
- $self->debug("Module::Signature is NOT installed") if $CPAN::DEBUG;
- }
- }
-
- $file = $self->{localfile};
- $basename = File::Basename::basename($file);
- my $fh = FileHandle->new;
- if (open $fh, $chk_file){
- local($/);
- my $eval = <$fh>;
- $eval =~ s/\015?\012/\n/g;
- close $fh;
- my($comp) = Safe->new();
- $cksum = $comp->reval($eval);
- if ($@) {
- rename $chk_file, "$chk_file.bad";
- Carp::confess($@) if $@;
- }
- } else {
- Carp::carp "Could not open $chk_file for reading";
- }
-
- if (! ref $cksum or ref $cksum ne "HASH") {
- $CPAN::Frontend->mywarn(qq{
-Warning: checksum file '$chk_file' broken.
-
-When trying to read that file I expected to get a hash reference
-for further processing, but got garbage instead.
-});
- my $answer = CPAN::Shell::colorable_makemaker_prompt("Proceed nonetheless?", "no");
- $answer =~ /^\s*y/i or $CPAN::Frontend->mydie("Aborted.\n");
- $self->{CHECKSUM_STATUS} = "NIL -- CHECKSUMS file broken";
- return;
- } elsif (exists $cksum->{$basename}{sha256}) {
- $self->debug("Found checksum for $basename:" .
- "$cksum->{$basename}{sha256}\n") if $CPAN::DEBUG;
-
- open($fh, $file);
- binmode $fh;
- my $eq = $self->eq_CHECKSUM($fh,$cksum->{$basename}{sha256});
- $fh->close;
- $fh = CPAN::Tarzip->TIEHANDLE($file);
-
- unless ($eq) {
- my $dg = Digest::SHA->new(256);
- my($data,$ref);
- $ref = \$data;
- while ($fh->READ($ref, 4096) > 0){
- $dg->add($data);
- }
- my $hexdigest = $dg->hexdigest;
- $eq += $hexdigest eq $cksum->{$basename}{'sha256-ungz'};
- }
-
- if ($eq) {
- $CPAN::Frontend->myprint("Checksum for $file ok\n");
- return $self->{CHECKSUM_STATUS} = "OK";
- } else {
- $CPAN::Frontend->myprint(qq{\nChecksum mismatch for }.
- qq{distribution file. }.
- qq{Please investigate.\n\n}.
- $self->as_string,
- $CPAN::META->instance(
- 'CPAN::Author',
- $self->cpan_userid
- )->as_string);
-
- my $wrap = qq{I\'d recommend removing $file. Its
-checksum is incorrect. Maybe you have configured your 'urllist' with
-a bad URL. Please check this array with 'o conf urllist', and
-retry.};
-
- $CPAN::Frontend->mydie(Text::Wrap::wrap("","",$wrap));
-
- # former versions just returned here but this seems a
- # serious threat that deserves a die
-
- # $CPAN::Frontend->myprint("\n\n");
- # sleep 3;
- # return;
- }
- # close $fh if fileno($fh);
- } else {
- return if $sloppy;
- unless ($self->{CHECKSUM_STATUS}) {
- $CPAN::Frontend->mywarn(qq{
-Warning: No checksum for $basename in $chk_file.
-
-The cause for this may be that the file is very new and the checksum
-has not yet been calculated, but it may also be that something is
-going awry right now.
-});
- my $answer = CPAN::Shell::colorable_makemaker_prompt("Proceed?", "yes");
- $answer =~ /^\s*y/i or $CPAN::Frontend->mydie("Aborted.\n");
- }
- $self->{CHECKSUM_STATUS} = "NIL -- distro not in CHECKSUMS file";
- return;
- }
-}
-
-#-> sub CPAN::Distribution::eq_CHECKSUM ;
-sub eq_CHECKSUM {
- my($self,$fh,$expect) = @_;
- if ($CPAN::META->has_inst("Digest::SHA")) {
- my $dg = Digest::SHA->new(256);
- my($data);
- while (read($fh, $data, 4096)){
- $dg->add($data);
- }
- my $hexdigest = $dg->hexdigest;
- # warn "fh[$fh] hex[$hexdigest] aexp[$expectMD5]";
- return $hexdigest eq $expect;
- }
- return 1;
-}
-
-#-> sub CPAN::Distribution::force ;
-
-# Both CPAN::Modules and CPAN::Distributions know if "force" is in
-# effect by autoinspection, not by inspecting a global variable. One
-# of the reason why this was chosen to work that way was the treatment
-# of dependencies. They should not automatically inherit the force
-# status. But this has the downside that ^C and die() will return to
-# the prompt but will not be able to reset the force_update
-# attributes. We try to correct for it currently in the read_metadata
-# routine, and immediately before we check for a Signal. I hope this
-# works out in one of v1.57_53ff
-
-# "Force get forgets previous error conditions"
-
-#-> sub CPAN::Distribution::fforce ;
-sub fforce {
- my($self, $method) = @_;
- $self->force($method,1);
-}
-
-#-> sub CPAN::Distribution::force ;
-sub force {
- my($self, $method,$fforce) = @_;
- my %phase_map = (
- get => [
- "unwrapped",
- "build_dir",
- "archived",
- "localfile",
- "CHECKSUM_STATUS",
- "signature_verify",
- "prefs",
- "prefs_file",
- "prefs_file_doc",
- ],
- make => [
- "writemakefile",
- "make",
- "modulebuild",
- "prereq_pm",
- "prereq_pm_detected",
- ],
- test => [
- "badtestcnt",
- "make_test",
- ],
- install => [
- "install",
- ],
- unknown => [
- "reqtype",
- "yaml_content",
- ],
- );
- my $methodmatch = 0;
- my $ldebug = 0;
- PHASE: for my $phase (qw(unknown get make test install)) { # order matters
- $methodmatch = 1 if $fforce || $phase eq $method;
- next unless $methodmatch;
- ATTRIBUTE: for my $att (@{$phase_map{$phase}}) {
- if ($phase eq "get") {
- if (substr($self->id,-1,1) eq "."
- && $att =~ /(unwrapped|build_dir|archived)/ ) {
- # cannot be undone for local distros
- next ATTRIBUTE;
- }
- if ($att eq "build_dir"
- && $self->{build_dir}
- && $CPAN::META->{is_tested}
- ) {
- delete $CPAN::META->{is_tested}{$self->{build_dir}};
- }
- } elsif ($phase eq "test") {
- if ($att eq "make_test"
- && $self->{make_test}
- && $self->{make_test}{COMMANDID}
- && $self->{make_test}{COMMANDID} == $CPAN::CurrentCommandId
- ) {
- # endless loop too likely
- next ATTRIBUTE;
- }
- }
- delete $self->{$att};
- if ($ldebug || $CPAN::DEBUG) {
- # local $CPAN::DEBUG = 16; # Distribution
- CPAN->debug(sprintf "id[%s]phase[%s]att[%s]", $self->id, $phase, $att);
- }
- }
- }
- if ($method && $method =~ /make|test|install/) {
- $self->{force_update} = 1; # name should probably have been force_install
- }
-}
-
-#-> sub CPAN::Distribution::notest ;
-sub notest {
- my($self, $method) = @_;
- # warn "XDEBUG: set notest for $self $method";
- $self->{"notest"}++; # name should probably have been force_install
-}
-
-#-> sub CPAN::Distribution::unnotest ;
-sub unnotest {
- my($self) = @_;
- # warn "XDEBUG: deleting notest";
- delete $self->{'notest'};
-}
-
-#-> sub CPAN::Distribution::unforce ;
-sub unforce {
- my($self) = @_;
- delete $self->{force_update};
-}
-
-#-> sub CPAN::Distribution::isa_perl ;
-sub isa_perl {
- my($self) = @_;
- my $file = File::Basename::basename($self->id);
- if ($file =~ m{ ^ perl
- -?
- (5)
- ([._-])
- (
- \d{3}(_[0-4][0-9])?
- |
- \d+\.\d+
- )
- \.tar[._-](?:gz|bz2)
- (?!\n)\Z
- }xs){
- return "$1.$3";
- } elsif ($self->cpan_comment
- &&
- $self->cpan_comment =~ /isa_perl\(.+?\)/){
- return $1;
- }
-}
-
-
-#-> sub CPAN::Distribution::perl ;
-sub perl {
- my ($self) = @_;
- if (! $self) {
- use Carp qw(carp);
- carp __PACKAGE__ . "::perl was called without parameters.";
- }
- return CPAN::HandleConfig->safe_quote($CPAN::Perl);
-}
-
-
-#-> sub CPAN::Distribution::make ;
-sub make {
- my($self) = @_;
- if (my $goto = $self->prefs->{goto}) {
- return $self->goto($goto);
- }
- my $make = $self->{modulebuild} ? "Build" : "make";
- # Emergency brake if they said install Pippi and get newest perl
- if ($self->isa_perl) {
- if (
- $self->called_for ne $self->id &&
- ! $self->{force_update}
- ) {
- # if we die here, we break bundles
- $CPAN::Frontend
- ->mywarn(sprintf(
- qq{The most recent version "%s" of the module "%s"
-is part of the perl-%s distribution. To install that, you need to run
- force install %s --or--
- install %s
-},
- $CPAN::META->instance(
- 'CPAN::Module',
- $self->called_for
- )->cpan_version,
- $self->called_for,
- $self->isa_perl,
- $self->called_for,
- $self->id,
- ));
- $self->{make} = CPAN::Distrostatus->new("NO isa perl");
- $CPAN::Frontend->mysleep(1);
- return;
- }
- }
- $CPAN::Frontend->myprint(sprintf "Running %s for %s\n", $make, $self->id);
- $self->get;
- local $ENV{PERL5LIB} = defined($ENV{PERL5LIB})
- ? $ENV{PERL5LIB}
- : ($ENV{PERLLIB} || "");
- $CPAN::META->set_perl5lib;
- local $ENV{MAKEFLAGS}; # protect us from outer make calls
-
- if ($CPAN::Signal){
- delete $self->{force_update};
- return;
- }
-
- my $builddir;
- EXCUSE: {
- my @e;
- if (!$self->{archived} || $self->{archived} eq "NO") {
- push @e, "Is neither a tar nor a zip archive.";
- }
-
- if (!$self->{unwrapped}
- || (
- UNIVERSAL::can($self->{unwrapped},"failed") ?
- $self->{unwrapped}->failed :
- $self->{unwrapped} =~ /^NO/
- )) {
- push @e, "Had problems unarchiving. Please build manually";
- }
-
- unless ($self->{force_update}) {
- exists $self->{signature_verify} and
- (
- UNIVERSAL::can($self->{signature_verify},"failed") ?
- $self->{signature_verify}->failed :
- $self->{signature_verify} =~ /^NO/
- )
- and push @e, "Did not pass the signature test.";
- }
-
- if (exists $self->{writemakefile} &&
- (
- UNIVERSAL::can($self->{writemakefile},"failed") ?
- $self->{writemakefile}->failed :
- $self->{writemakefile} =~ /^NO/
- )) {
- # XXX maybe a retry would be in order?
- my $err = UNIVERSAL::can($self->{writemakefile},"text") ?
- $self->{writemakefile}->text :
- $self->{writemakefile};
- $err =~ s/^NO\s*//;
- $err ||= "Had some problem writing Makefile";
- $err .= ", won't make";
- push @e, $err;
- }
-
- defined $self->{make} and push @e,
- "Has already been made";
-
- if (exists $self->{later} and length($self->{later})) {
- if ($self->unsat_prereq) {
- push @e, $self->{later};
-# RT ticket 18438 raises doubts if the deletion of {later} is valid.
-# YAML-0.53 triggered the later hodge-podge here, but my margin notes
-# are not sufficient to be sure if we really must/may do the delete
-# here. SO I accept the suggested patch for now. If we trigger a bug
-# again, I must go into deep contemplation about the {later} flag.
-
-# } else {
-# delete $self->{later};
- }
- }
-
- $CPAN::Frontend->myprint(join "", map {" $_\n"} @e) and return if @e;
- $builddir = $self->dir or
- $CPAN::Frontend->mydie("PANIC: Cannot determine build directory\n");
- unless (chdir $builddir) {
- push @e, "Couldn't chdir to '$builddir': $!";
- }
- $CPAN::Frontend->mywarn(join "", map {" $_\n"} @e) and return if @e;
- }
- if ($CPAN::Signal){
- delete $self->{force_update};
- return;
- }
- $CPAN::Frontend->myprint("\n CPAN.pm: Going to build ".$self->id."\n\n");
- $self->debug("Changed directory to $builddir") if $CPAN::DEBUG;
-
- if ($^O eq 'MacOS') {
- Mac::BuildTools::make($self);
- return;
- }
-
- my %env;
- while (my($k,$v) = each %ENV) {
- next unless defined $v;
- $env{$k} = $v;
- }
- local %ENV = %env;
- my $system;
- if (my $commandline = $self->prefs->{pl}{commandline}) {
- $system = $commandline;
- $ENV{PERL} = $^X;
- } elsif ($self->{'configure'}) {
- $system = $self->{'configure'};
- } elsif ($self->{modulebuild}) {
- my($perl) = $self->perl or die "Couldn\'t find executable perl\n";
- $system = "$perl Build.PL $CPAN::Config->{mbuildpl_arg}";
- } else {
- my($perl) = $self->perl or die "Couldn\'t find executable perl\n";
- my $switch = "";
-# This needs a handler that can be turned on or off:
-# $switch = "-MExtUtils::MakeMaker ".
-# "-Mops=:default,:filesys_read,:filesys_open,require,chdir"
-# if $] > 5.00310;
- my $makepl_arg = $self->make_x_arg("pl");
- $system = sprintf("%s%s Makefile.PL%s",
- $perl,
- $switch ? " $switch" : "",
- $makepl_arg ? " $makepl_arg" : "",
- );
- }
- if (my $env = $self->prefs->{pl}{env}) {
- for my $e (keys %$env) {
- $ENV{$e} = $env->{$e};
- }
- }
- if (exists $self->{writemakefile}) {
- } else {
- local($SIG{ALRM}) = sub { die "inactivity_timeout reached\n" };
- my($ret,$pid);
- $@ = "";
- my $go_via_alarm;
- if ($CPAN::Config->{inactivity_timeout}) {
- require Config;
- if ($Config::Config{d_alarm}
- &&
- $Config::Config{d_alarm} eq "define"
- ) {
- $go_via_alarm++
- } else {
- $CPAN::Frontend->mywarn("Warning: you have configured the config ".
- "variable 'inactivity_timeout' to ".
- "'$CPAN::Config->{inactivity_timeout}'. But ".
- "on this machine the system call 'alarm' ".
- "isn't available. This means that we cannot ".
- "provide the feature of intercepting long ".
- "waiting code and will turn this feature off.\n"
- );
- $CPAN::Config->{inactivity_timeout} = 0;
- }
- }
- if ($go_via_alarm) {
- eval {
- alarm $CPAN::Config->{inactivity_timeout};
- local $SIG{CHLD}; # = sub { wait };
- if (defined($pid = fork)) {
- if ($pid) { #parent
- # wait;
- waitpid $pid, 0;
- } else { #child
- # note, this exec isn't necessary if
- # inactivity_timeout is 0. On the Mac I'd
- # suggest, we set it always to 0.
- exec $system;
- }
- } else {
- $CPAN::Frontend->myprint("Cannot fork: $!");
- return;
- }
- };
- alarm 0;
- if ($@){
- kill 9, $pid;
- waitpid $pid, 0;
- my $err = "$@";
- $CPAN::Frontend->myprint($err);
- $self->{writemakefile} = CPAN::Distrostatus->new("NO $err");
- $@ = "";
- return;
- }
- } else {
- if (my $expect_model = $self->_prefs_with_expect("pl")) {
- $ret = $self->_run_via_expect($system,$expect_model);
- if (! defined $ret
- && $self->{writemakefile}
- && $self->{writemakefile}->failed) {
- # timeout
- return;
- }
- } else {
- $ret = system($system);
- }
- if ($ret != 0) {
- $self->{writemakefile} = CPAN::Distrostatus
- ->new("NO '$system' returned status $ret");
- $CPAN::Frontend->mywarn("Warning: No success on command[$system]\n");
- $self->store_persistent_state;
- $self->store_persistent_state;
- return;
- }
- }
- if (-f "Makefile" || -f "Build") {
- $self->{writemakefile} = CPAN::Distrostatus->new("YES");
- delete $self->{make_clean}; # if cleaned before, enable next
- } else {
- $self->{writemakefile} = CPAN::Distrostatus
- ->new(qq{NO -- Unknown reason});
- }
- }
- if ($CPAN::Signal){
- delete $self->{force_update};
- return;
- }
- if (my @prereq = $self->unsat_prereq){
- if ($prereq[0][0] eq "perl") {
- my $need = "requires perl '$prereq[0][1]'";
- my $id = $self->pretty_id;
- $CPAN::Frontend->mywarn("$id $need; you have only $]; giving up\n");
- $self->{make} = CPAN::Distrostatus->new("NO $need");
- $self->store_persistent_state;
- return;
- } else {
- return 1 if $self->follow_prereqs(@prereq); # signal success to the queuerunner
- }
- }
- if ($CPAN::Signal){
- delete $self->{force_update};
- return;
- }
- if (my $commandline = $self->prefs->{make}{commandline}) {
- $system = $commandline;
- $ENV{PERL} = $^X;
- } else {
- if ($self->{modulebuild}) {
- unless (-f "Build") {
- my $cwd = CPAN::anycwd();
- $CPAN::Frontend->mywarn("Alert: no Build file available for 'make $self->{id}'".
- " in cwd[$cwd]. Danger, Will Robinson!");
- $CPAN::Frontend->mysleep(5);
- }
- $system = join " ", $self->_build_command(), $CPAN::Config->{mbuild_arg};
- } else {
- $system = join " ", $self->_make_command(), $CPAN::Config->{make_arg};
- }
- $system =~ s/\s+$//;
- my $make_arg = $self->make_x_arg("make");
- $system = sprintf("%s%s",
- $system,
- $make_arg ? " $make_arg" : "",
- );
- }
- if (my $env = $self->prefs->{make}{env}) { # overriding the local
- # ENV of PL, not the
- # outer ENV, but
- # unlikely to be a risk
- for my $e (keys %$env) {
- $ENV{$e} = $env->{$e};
- }
- }
- my $expect_model = $self->_prefs_with_expect("make");
- my $want_expect = 0;
- if ( $expect_model && @{$expect_model->{talk}} ) {
- my $can_expect = $CPAN::META->has_inst("Expect");
- if ($can_expect) {
- $want_expect = 1;
- } else {
- $CPAN::Frontend->mywarn("Expect not installed, falling back to ".
- "system()\n");
- }
- }
- my $system_ok;
- if ($want_expect) {
- $system_ok = $self->_run_via_expect($system,$expect_model) == 0;
- } else {
- $system_ok = system($system) == 0;
- }
- $self->introduce_myself;
- if ( $system_ok ) {
- $CPAN::Frontend->myprint(" $system -- OK\n");
- $self->{make} = CPAN::Distrostatus->new("YES");
- } else {
- $self->{writemakefile} ||= CPAN::Distrostatus->new("YES");
- $self->{make} = CPAN::Distrostatus->new("NO");
- $CPAN::Frontend->mywarn(" $system -- NOT OK\n");
- }
- $self->store_persistent_state;
-}
-
-# CPAN::Distribution::_run_via_expect
-sub _run_via_expect {
- my($self,$system,$expect_model) = @_;
- CPAN->debug("system[$system]expect_model[$expect_model]") if $CPAN::DEBUG;
- if ($CPAN::META->has_inst("Expect")) {
- my $expo = Expect->new; # expo Expect object;
- $expo->spawn($system);
- $expect_model->{mode} ||= "deterministic";
- if ($expect_model->{mode} eq "deterministic") {
- return $self->_run_via_expect_deterministic($expo,$expect_model);
- } elsif ($expect_model->{mode} eq "anyorder") {
- return $self->_run_via_expect_anyorder($expo,$expect_model);
- } else {
- die "Panic: Illegal expect mode: $expect_model->{mode}";
- }
- } else {
- $CPAN::Frontend->mywarn("Expect not installed, falling back to system()\n");
- return system($system);
- }
-}
-
-sub _run_via_expect_anyorder {
- my($self,$expo,$expect_model) = @_;
- my $timeout = $expect_model->{timeout} || 5;
- my @expectacopy = @{$expect_model->{talk}}; # we trash it!
- my $but = "";
- EXPECT: while () {
- my($eof,$ran_into_timeout);
- my @match = $expo->expect($timeout,
- [ eof => sub {
- $eof++;
- } ],
- [ timeout => sub {
- $ran_into_timeout++;
- } ],
- -re => eval"qr{.}",
- );
- if ($match[2]) {
- $but .= $match[2];
- }
- $but .= $expo->clear_accum;
- if ($eof) {
- $expo->soft_close;
- return $expo->exitstatus();
- } elsif ($ran_into_timeout) {
- # warn "DEBUG: they are asking a question, but[$but]";
- for (my $i = 0; $i <= $#expectacopy; $i+=2) {
- my($next,$send) = @expectacopy[$i,$i+1];
- my $regex = eval "qr{$next}";
- # warn "DEBUG: will compare with regex[$regex].";
- if ($but =~ /$regex/) {
- # warn "DEBUG: will send send[$send]";
- $expo->send($send);
- splice @expectacopy, $i, 2; # never allow reusing an QA pair
- next EXPECT;
- }
- }
- my $why = "could not answer a question during the dialog";
- $CPAN::Frontend->mywarn("Failing: $why\n");
- $self->{writemakefile} =
- CPAN::Distrostatus->new("NO $why");
- return;
- }
- }
-}
-
-sub _run_via_expect_deterministic {
- my($self,$expo,$expect_model) = @_;
- my $ran_into_timeout;
- my $timeout = $expect_model->{timeout} || 15; # currently unsettable
- my $expecta = $expect_model->{talk};
- EXPECT: for (my $i = 0; $i <= $#$expecta; $i+=2) {
- my($re,$send) = @$expecta[$i,$i+1];
- CPAN->debug("timeout[$timeout]re[$re]") if $CPAN::DEBUG;
- my $regex = eval "qr{$re}";
- $expo->expect($timeout,
- [ eof => sub {
- my $but = $expo->clear_accum;
- $CPAN::Frontend->mywarn("EOF (maybe harmless)
-expected[$regex]\nbut[$but]\n\n");
- last EXPECT;
- } ],
- [ timeout => sub {
- my $but = $expo->clear_accum;
- $CPAN::Frontend->mywarn("TIMEOUT
-expected[$regex]\nbut[$but]\n\n");
- $ran_into_timeout++;
- } ],
- -re => $regex);
- if ($ran_into_timeout){
- # note that the caller expects 0 for success
- $self->{writemakefile} =
- CPAN::Distrostatus->new("NO timeout during expect dialog");
- return;
- }
- $expo->send($send);
- }
- $expo->soft_close;
- return $expo->exitstatus();
-}
-
-#-> CPAN::Distribution::_validate_distropref
-sub _validate_distropref {
- my($self,@args) = @_;
- if (
- $CPAN::META->has_inst("CPAN::Kwalify")
- &&
- $CPAN::META->has_inst("Kwalify")
- ) {
- eval {CPAN::Kwalify::_validate("distroprefs",@args);};
- if ($@) {
- $CPAN::Frontend->mywarn($@);
- }
- } else {
- CPAN->debug("not validating '@args'") if $CPAN::DEBUG;
- }
-}
-
-#-> CPAN::Distribution::_find_prefs
-sub _find_prefs {
- my($self) = @_;
- my $distroid = $self->pretty_id;
- #CPAN->debug("distroid[$distroid]") if $CPAN::DEBUG;
- my $prefs_dir = $CPAN::Config->{prefs_dir};
- eval { File::Path::mkpath($prefs_dir); };
- if ($@) {
- $CPAN::Frontend->mydie("Cannot create directory $prefs_dir");
- }
- my $yaml_module = CPAN::_yaml_module;
- my @extensions;
- if ($CPAN::META->has_inst($yaml_module)) {
- push @extensions, "yml";
- } else {
- my @fallbacks;
- if ($CPAN::META->has_inst("Data::Dumper")) {
- push @extensions, "dd";
- push @fallbacks, "Data::Dumper";
- }
- if ($CPAN::META->has_inst("Storable")) {
- push @extensions, "st";
- push @fallbacks, "Storable";
- }
- if (@fallbacks) {
- local $" = " and ";
- unless ($self->{have_complained_about_missing_yaml}++) {
- $CPAN::Frontend->mywarn("'$yaml_module' not installed, falling back ".
- "to @fallbacks to read prefs '$prefs_dir'\n");
- }
- } else {
- unless ($self->{have_complained_about_missing_yaml}++) {
- $CPAN::Frontend->mywarn("'$yaml_module' not installed, cannot ".
- "read prefs '$prefs_dir'\n");
- }
- }
- }
- if (@extensions) {
- my $dh = DirHandle->new($prefs_dir)
- or die Carp::croak("Couldn't open '$prefs_dir': $!");
- DIRENT: for (sort $dh->read) {
- next if $_ eq "." || $_ eq "..";
- my $exte = join "|", @extensions;
- next unless /\.($exte)$/;
- my $thisexte = $1;
- my $abs = File::Spec->catfile($prefs_dir, $_);
- if (-f $abs) {
- #CPAN->debug(sprintf "abs[%s]", $abs) if $CPAN::DEBUG;
- my @distropref;
- if ($thisexte eq "yml") {
- # need no eval because if we have no YAML we do not try to read *.yml
- #CPAN->debug(sprintf "before yaml load abs[%s]", $abs) if $CPAN::DEBUG;
- @distropref = @{CPAN->_yaml_loadfile($abs)};
- #CPAN->debug(sprintf "after yaml load abs[%s]", $abs) if $CPAN::DEBUG;
- } elsif ($thisexte eq "dd") {
- package CPAN::Eval;
- no strict;
- open FH, "<$abs" or $CPAN::Frontend->mydie("Could not open '$abs': $!");
- local $/;
- my $eval = <FH>;
- close FH;
- eval $eval;
- if ($@) {
- $CPAN::Frontend->mydie("Error in distroprefs file $_\: $@");
- }
- my $i = 1;
- while (${"VAR".$i}) {
- push @distropref, ${"VAR".$i};
- $i++;
- }
- } elsif ($thisexte eq "st") {
- # eval because Storable is never forward compatible
- eval { @distropref = @{scalar Storable::retrieve($abs)}; };
- if ($@) {
- $CPAN::Frontend->mywarn("Error reading distroprefs file ".
- "$_, skipping\: $@");
- $CPAN::Frontend->mysleep(4);
- next DIRENT;
- }
- }
- # $DB::single=1;
- #CPAN->debug(sprintf "#distropref[%d]", scalar @distropref) if $CPAN::DEBUG;
- ELEMENT: for my $y (0..$#distropref) {
- my $distropref = $distropref[$y];
- $self->_validate_distropref($distropref,$abs,$y);
- my $match = $distropref->{match};
- unless ($match) {
- #CPAN->debug("no 'match' in abs[$abs], skipping") if $CPAN::DEBUG;
- next ELEMENT;
- }
- my $ok = 1;
- # do not take the order of C<keys %$match> because
- # "module" is by far the slowest
- for my $sub_attribute (qw(distribution perl module)) {
- next unless exists $match->{$sub_attribute};
- my $qr = eval "qr{$distropref->{match}{$sub_attribute}}";
- if ($sub_attribute eq "module") {
- my $okm = 0;
- #CPAN->debug(sprintf "distropref[%d]", scalar @distropref) if $CPAN::DEBUG;
- my @modules = $self->containsmods;
- #CPAN->debug(sprintf "modules[%s]", join(",",@modules)) if $CPAN::DEBUG;
- MODULE: for my $module (@modules) {
- $okm ||= $module =~ /$qr/;
- last MODULE if $okm;
- }
- $ok &&= $okm;
- } elsif ($sub_attribute eq "distribution") {
- my $okd = $distroid =~ /$qr/;
- $ok &&= $okd;
- } elsif ($sub_attribute eq "perl") {
- my $okp = $^X =~ /$qr/;
- $ok &&= $okp;
- } else {
- $CPAN::Frontend->mydie("Nonconforming .$thisexte file '$abs': ".
- "unknown sub_attribut '$sub_attribute'. ".
- "Please ".
- "remove, cannot continue.");
- }
- last if $ok == 0; # short circuit
- }
- #CPAN->debug(sprintf "ok[%d]", $ok) if $CPAN::DEBUG;
- if ($ok) {
- return {
- prefs => $distropref,
- prefs_file => $abs,
- prefs_file_doc => $y,
- };
- }
-
- }
- }
- }
- $dh->close;
- }
- return;
-}
-
-# CPAN::Distribution::prefs
-sub prefs {
- my($self) = @_;
- if (exists $self->{prefs}) {
- return $self->{prefs}; # XXX comment out during debugging
- }
- if ($CPAN::Config->{prefs_dir}) {
- CPAN->debug("prefs_dir[$CPAN::Config->{prefs_dir}]") if $CPAN::DEBUG;
- my $prefs = $self->_find_prefs();
- $prefs ||= ""; # avoid warning next line
- CPAN->debug("prefs[$prefs]") if $CPAN::DEBUG;
- if ($prefs) {
- for my $x (qw(prefs prefs_file prefs_file_doc)) {
- $self->{$x} = $prefs->{$x};
- }
- my $bs = sprintf(
- "%s[%s]",
- File::Basename::basename($self->{prefs_file}),
- $self->{prefs_file_doc},
- );
- my $filler1 = "_" x 22;
- my $filler2 = int(66 - length($bs))/2;
- $filler2 = 0 if $filler2 < 0;
- $filler2 = " " x $filler2;
- $CPAN::Frontend->myprint("
-$filler1 D i s t r o P r e f s $filler1
-$filler2 $bs $filler2
-");
- $CPAN::Frontend->mysleep(1);
- return $self->{prefs};
- }
- }
- return +{};
-}
-
-# CPAN::Distribution::make_x_arg
-sub make_x_arg {
- my($self, $whixh) = @_;
- my $make_x_arg;
- my $prefs = $self->prefs;
- if (
- $prefs
- && exists $prefs->{$whixh}
- && exists $prefs->{$whixh}{args}
- && $prefs->{$whixh}{args}
- ) {
- $make_x_arg = join(" ",
- map {CPAN::HandleConfig
- ->safe_quote($_)} @{$prefs->{$whixh}{args}},
- );
- }
- my $what = sprintf "make%s_arg", $whixh eq "make" ? "" : $whixh;
- $make_x_arg ||= $CPAN::Config->{$what};
- return $make_x_arg;
-}
-
-# CPAN::Distribution::_make_command
-sub _make_command {
- my ($self) = @_;
- if ($self) {
- return
- CPAN::HandleConfig
- ->safe_quote(
- CPAN::HandleConfig->prefs_lookup($self,
- q{make})
- || $Config::Config{make}
- || 'make'
- );
- } else {
- # Old style call, without object. Deprecated
- Carp::confess("CPAN::_make_command() used as function. Don't Do That.");
- return
- safe_quote(undef,
- CPAN::HandleConfig->prefs_lookup($self,q{make})
- || $CPAN::Config->{make}
- || $Config::Config{make}
- || 'make');
- }
-}
-
-#-> sub CPAN::Distribution::follow_prereqs ;
-sub follow_prereqs {
- my($self) = shift;
- my(@prereq_tuples) = grep {$_->[0] ne "perl"} @_;
- return unless @prereq_tuples;
- my @prereq = map { $_->[0] } @prereq_tuples;
- my $pretty_id = $self->pretty_id;
- my %map = (
- b => "build_requires",
- r => "requires",
- c => "commandline",
- );
- my($filler1,$filler2,$filler3,$filler4);
- my $unsat = "Unsatisfied dependencies detected during";
- my $w = length($unsat) > length($pretty_id) ? length($unsat) : length($pretty_id);
- {
- my $r = int(($w - length($unsat))/2);
- my $l = $w - length($unsat) - $r;
- $filler1 = "-"x4 . " "x$l;
- $filler2 = " "x$r . "-"x4 . "\n";
- }
- {
- my $r = int(($w - length($pretty_id))/2);
- my $l = $w - length($pretty_id) - $r;
- $filler3 = "-"x4 . " "x$l;
- $filler4 = " "x$r . "-"x4 . "\n";
- }
- $CPAN::Frontend->
- myprint("$filler1 $unsat $filler2".
- "$filler3 $pretty_id $filler4".
- join("", map {" $_->[0] \[$map{$_->[1]}]\n"} @prereq_tuples),
- );
- my $follow = 0;
- if ($CPAN::Config->{prerequisites_policy} eq "follow") {
- $follow = 1;
- } elsif ($CPAN::Config->{prerequisites_policy} eq "ask") {
- my $answer = CPAN::Shell::colorable_makemaker_prompt(
-"Shall I follow them and prepend them to the queue
-of modules we are processing right now?", "yes");
- $follow = $answer =~ /^\s*y/i;
- } else {
- local($") = ", ";
- $CPAN::Frontend->
- myprint(" Ignoring dependencies on modules @prereq\n");
- }
- if ($follow) {
- my $id = $self->id;
- # color them as dirty
- for my $p (@prereq) {
- # warn "calling color_cmd_tmps(0,1)";
- my $any = CPAN::Shell->expandany($p);
- if ($any) {
- $any->color_cmd_tmps(0,1);
- } else {
- $CPAN::Frontend->mywarn("Warning (maybe a bug): Cannot expand prereq '$p'\n");
- $CPAN::Frontend->mysleep(2);
- }
- }
- # queue them and re-queue yourself
- CPAN::Queue->jumpqueue([$id,$self->{reqtype}],
- reverse @prereq_tuples);
- $self->{later} = "Delayed until after prerequisites";
- return 1; # signal success to the queuerunner
- }
-}
-
-#-> sub CPAN::Distribution::unsat_prereq ;
-# return ([Foo=>1],[Bar=>1.2]) for normal modules
-# return ([perl=>5.008]) if we need a newer perl than we are running under
-sub unsat_prereq {
- my($self) = @_;
- my $prereq_pm = $self->prereq_pm or return;
- my(@need);
- my %merged = (%{$prereq_pm->{requires}||{}},%{$prereq_pm->{build_requires}||{}});
- NEED: while (my($need_module, $need_version) = each %merged) {
- my($available_version,$available_file);
- if ($need_module eq "perl") {
- $available_version = $];
- $available_file = $^X;
- } else {
- my $nmo = $CPAN::META->instance("CPAN::Module",$need_module);
- next if $nmo->uptodate;
- $available_file = $nmo->available_file;
-
- # if they have not specified a version, we accept any installed one
- if (not defined $need_version or
- $need_version eq "0" or
- $need_version eq "undef") {
- next if defined $available_file;
- }
-
- $available_version = $nmo->available_version;
- }
-
- # We only want to install prereqs if either they're not installed
- # or if the installed version is too old. We cannot omit this
- # check, because if 'force' is in effect, nobody else will check.
- if (defined $available_file) {
- my(@all_requirements) = split /\s*,\s*/, $need_version;
- local($^W) = 0;
- my $ok = 0;
- RQ: for my $rq (@all_requirements) {
- if ($rq =~ s|>=\s*||) {
- } elsif ($rq =~ s|>\s*||) {
- # 2005-12: one user
- if (CPAN::Version->vgt($available_version,$rq)){
- $ok++;
- }
- next RQ;
- } elsif ($rq =~ s|!=\s*||) {
- # 2005-12: no user
- if (CPAN::Version->vcmp($available_version,$rq)){
- $ok++;
- next RQ;
- } else {
- last RQ;
- }
- } elsif ($rq =~ m|<=?\s*|) {
- # 2005-12: no user
- $CPAN::Frontend->mywarn("Downgrading not supported (rq[$rq])\n");
- $ok++;
- next RQ;
- }
- if (! CPAN::Version->vgt($rq, $available_version)){
- $ok++;
- }
- CPAN->debug(sprintf("need_module[%s]available_file[%s]".
- "available_version[%s]rq[%s]ok[%d]",
- $need_module,
- $available_file,
- $available_version,
- CPAN::Version->readable($rq),
- $ok,
- )) if $CPAN::DEBUG;
- }
- next NEED if $ok == @all_requirements;
- }
-
- if ($need_module eq "perl") {
- return ["perl", $need_version];
- }
- if ($self->{sponsored_mods}{$need_module}++){
- # We have already sponsored it and for some reason it's still
- # not available. So we do nothing. Or what should we do?
- # if we push it again, we have a potential infinite loop
- next;
- }
- my $needed_as = exists $prereq_pm->{requires}{$need_module} ? "r" : "b";
- push @need, [$need_module,$needed_as];
- }
- @need;
-}
-
-#-> sub CPAN::Distribution::read_yaml ;
-sub read_yaml {
- my($self) = @_;
- return $self->{yaml_content} if exists $self->{yaml_content};
- my $build_dir = $self->{build_dir};
- my $yaml = File::Spec->catfile($build_dir,"META.yml");
- $self->debug("yaml[$yaml]") if $CPAN::DEBUG;
- return unless -f $yaml;
- eval { $self->{yaml_content} = CPAN->_yaml_loadfile($yaml)->[0]; };
- if ($@) {
- $CPAN::Frontend->mywarn("Could not read ".
- "'$yaml'. Falling back to other ".
- "methods to determine prerequisites\n");
- return $self->{yaml_content} = undef; # if we die, then we
- # cannot read YAML's own
- # META.yml
- }
- if (not exists $self->{yaml_content}{dynamic_config}
- or $self->{yaml_content}{dynamic_config}
- ) {
- $self->{yaml_content} = undef;
- }
- $self->debug(sprintf "yaml_content[%s]", $self->{yaml_content} || "UNDEF")
- if $CPAN::DEBUG;
- return $self->{yaml_content};
-}
-
-#-> sub CPAN::Distribution::prereq_pm ;
-sub prereq_pm {
- my($self) = @_;
- $self->{prereq_pm_detected} ||= 0;
- CPAN->debug("prereq_pm_detected[$self->{prereq_pm_detected}]") if $CPAN::DEBUG;
- return $self->{prereq_pm} if $self->{prereq_pm_detected};
- return unless $self->{writemakefile} # no need to have succeeded
- # but we must have run it
- || $self->{modulebuild};
- CPAN->debug(sprintf "writemakefile[%s]modulebuild[%s]",
- $self->{writemakefile}||"",
- $self->{modulebuild}||"",
- ) if $CPAN::DEBUG;
- my($req,$breq);
- if (my $yaml = $self->read_yaml) { # often dynamic_config prevents a result here
- $req = $yaml->{requires} || {};
- $breq = $yaml->{build_requires} || {};
- undef $req unless ref $req eq "HASH" && %$req;
- if ($req) {
- if ($yaml->{generated_by} &&
- $yaml->{generated_by} =~ /ExtUtils::MakeMaker version ([\d\._]+)/) {
- my $eummv = do { local $^W = 0; $1+0; };
- if ($eummv < 6.2501) {
- # thanks to Slaven for digging that out: MM before
- # that could be wrong because it could reflect a
- # previous release
- undef $req;
- }
- }
- my $areq;
- my $do_replace;
- while (my($k,$v) = each %{$req||{}}) {
- if ($v =~ /\d/) {
- $areq->{$k} = $v;
- } elsif ($k =~ /[A-Za-z]/ &&
- $v =~ /[A-Za-z]/ &&
- $CPAN::META->exists("Module",$v)
- ) {
- $CPAN::Frontend->mywarn("Suspicious key-value pair in META.yml's ".
- "requires hash: $k => $v; I'll take both ".
- "key and value as a module name\n");
- $CPAN::Frontend->mysleep(1);
- $areq->{$k} = 0;
- $areq->{$v} = 0;
- $do_replace++;
- }
- }
- $req = $areq if $do_replace;
- }
- }
- unless ($req || $breq) {
- my $build_dir = $self->{build_dir} or die "Panic: no build_dir?";
- my $makefile = File::Spec->catfile($build_dir,"Makefile");
- my $fh;
- if (-f $makefile
- and
- $fh = FileHandle->new("<$makefile\0")) {
- CPAN->debug("Getting prereq from Makefile") if $CPAN::DEBUG;
- local($/) = "\n";
- while (<$fh>) {
- last if /MakeMaker post_initialize section/;
- my($p) = m{^[\#]
- \s+PREREQ_PM\s+=>\s+(.+)
- }x;
- next unless $p;
- # warn "Found prereq expr[$p]";
-
- # Regexp modified by A.Speer to remember actual version of file
- # PREREQ_PM hash key wants, then add to
- while ( $p =~ m/(?:\s)([\w\:]+)=>q\[(.*?)\],?/g ){
- # In case a prereq is mentioned twice, complain.
- if ( defined $req->{$1} ) {
- warn "Warning: PREREQ_PM mentions $1 more than once, ".
- "last mention wins";
- }
- $req->{$1} = $2;
- }
- last;
- }
- }
- }
- unless ($req || $breq) {
- my $build_dir = $self->{build_dir} or die "Panic: no build_dir?";
- my $buildfile = File::Spec->catfile($build_dir,"Build");
- if (-f $buildfile) {
- CPAN->debug("Found '$buildfile'") if $CPAN::DEBUG;
- my $build_prereqs = File::Spec->catfile($build_dir,"_build","prereqs");
- if (-f $build_prereqs) {
- CPAN->debug("Getting prerequisites from '$build_prereqs'") if $CPAN::DEBUG;
- my $content = do { local *FH;
- open FH, $build_prereqs
- or $CPAN::Frontend->mydie("Could not open ".
- "'$build_prereqs': $!");
- local $/;
- <FH>;
- };
- my $bphash = eval $content;
- if ($@) {
- } else {
- $req = $bphash->{requires} || +{};
- $breq = $bphash->{build_requires} || +{};
- }
- }
- }
- }
- if (-f "Build.PL"
- && ! -f "Makefile.PL"
- && ! exists $req->{"Module::Build"}
- && ! $CPAN::META->has_inst("Module::Build")) {
- $CPAN::Frontend->mywarn(" Warning: CPAN.pm discovered Module::Build as ".
- "undeclared prerequisite.\n".
- " Adding it now as such.\n"
- );
- $CPAN::Frontend->mysleep(5);
- $req->{"Module::Build"} = 0;
- delete $self->{writemakefile};
- }
- if ($req || $breq) {
- $self->{prereq_pm_detected}++;
- return $self->{prereq_pm} = { requires => $req, build_requires => $breq };
- }
-}
-
-#-> sub CPAN::Distribution::test ;
-sub test {
- my($self) = @_;
- if (my $goto = $self->prefs->{goto}) {
- return $self->goto($goto);
- }
- $self->make;
- if ($CPAN::Signal){
- delete $self->{force_update};
- return;
- }
- # warn "XDEBUG: checking for notest: $self->{notest} $self";
- if ($self->{notest}) {
- $CPAN::Frontend->myprint("Skipping test because of notest pragma\n");
- return 1;
- }
-
- my $make = $self->{modulebuild} ? "Build" : "make";
-
- local $ENV{PERL5LIB} = defined($ENV{PERL5LIB})
- ? $ENV{PERL5LIB}
- : ($ENV{PERLLIB} || "");
-
- $CPAN::META->set_perl5lib;
- local $ENV{MAKEFLAGS}; # protect us from outer make calls
-
- $CPAN::Frontend->myprint("Running $make test\n");
- if (my @prereq = $self->unsat_prereq){
- unless ($prereq[0][0] eq "perl") {
- return 1 if $self->follow_prereqs(@prereq); # signal success to the queuerunner
- }
- }
- EXCUSE: {
- my @e;
- unless (exists $self->{make} or exists $self->{later}) {
- push @e,
- "Make had some problems, won't test";
- }
-
- exists $self->{make} and
- (
- UNIVERSAL::can($self->{make},"failed") ?
- $self->{make}->failed :
- $self->{make} =~ /^NO/
- ) and push @e, "Can't test without successful make";
-
- $self->{badtestcnt} ||= 0;
- $self->{badtestcnt} > 0 and
- push @e, "Won't repeat unsuccessful test during this command";
-
- exists $self->{later} and length($self->{later}) and
- push @e, $self->{later};
-
- if (exists $self->{build_dir}) {
- if ($CPAN::META->{is_tested}{$self->{build_dir}}
- &&
- exists $self->{make_test}
- &&
- !(
- UNIVERSAL::can($self->{make_test},"failed") ?
- $self->{make_test}->failed :
- $self->{make_test} =~ /^NO/
- )
- ) {
- push @e, "Has already been tested successfully";
- }
- } elsif (!@e) {
- push @e, "Has no own directory";
- }
- $CPAN::Frontend->myprint(join "", map {" $_\n"} @e) and return if @e;
- unless (chdir $self->{build_dir}) {
- push @e, "Couldn't chdir to '$self->{build_dir}': $!";
- }
- $CPAN::Frontend->mywarn(join "", map {" $_\n"} @e) and return if @e;
- }
- $self->debug("Changed directory to $self->{build_dir}")
- if $CPAN::DEBUG;
-
- if ($^O eq 'MacOS') {
- Mac::BuildTools::make_test($self);
- return;
- }
-
- if ($self->{modulebuild}) {
- my $v = CPAN::Shell->expand("Module","Test::Harness")->inst_version;
- if (CPAN::Version->vlt($v,2.62)) {
- $CPAN::Frontend->mywarn(qq{The version of your Test::Harness is only
- '$v', you need at least '2.62'. Please upgrade your Test::Harness.\n});
- $self->{make_test} = CPAN::Distrostatus->new("NO Test::Harness too old");
- return;
- }
- }
-
- my $system;
- if (my $commandline = $self->prefs->{test}{commandline}) {
- $system = $commandline;
- $ENV{PERL} = $^X;
- } elsif ($self->{modulebuild}) {
- $system = sprintf "%s test", $self->_build_command();
- } else {
- $system = join " ", $self->_make_command(), "test";
- }
- my($tests_ok);
- my %env;
- while (my($k,$v) = each %ENV) {
- next unless defined $v;
- $env{$k} = $v;
- }
- local %ENV = %env;
- if (my $env = $self->prefs->{test}{env}) {
- for my $e (keys %$env) {
- $ENV{$e} = $env->{$e};
- }
- }
- my $expect_model = $self->_prefs_with_expect("test");
- my $want_expect = 0;
- if ( $expect_model && @{$expect_model->{talk}} ) {
- my $can_expect = $CPAN::META->has_inst("Expect");
- if ($can_expect) {
- $want_expect = 1;
- } else {
- $CPAN::Frontend->mywarn("Expect not installed, falling back to ".
- "testing without\n");
- }
- }
- my $test_report = CPAN::HandleConfig->prefs_lookup($self,
- q{test_report});
- my $want_report;
- if ($test_report) {
- my $can_report = $CPAN::META->has_inst("CPAN::Reporter");
- if ($can_report) {
- $want_report = 1;
- } else {
- $CPAN::Frontend->mywarn("CPAN::Reporter not installed, falling back to ".
- "testing without\n");
- }
- }
- my $ready_to_report = $want_report;
- if ($ready_to_report
- && (
- substr($self->id,-1,1) eq "."
- ||
- $self->author->id eq "LOCAL"
- )
- ) {
- $CPAN::Frontend->mywarn("Reporting via CPAN::Reporter is disabled ".
- "for local directories\n");
- $ready_to_report = 0;
- }
- if ($ready_to_report
- &&
- $self->prefs->{patches}
- &&
- @{$self->prefs->{patches}}
- &&
- $self->{patched}
- ) {
- $CPAN::Frontend->mywarn("Reporting via CPAN::Reporter is disabled ".
- "when the source has been patched\n");
- $ready_to_report = 0;
- }
- if ($want_expect) {
- if ($ready_to_report) {
- $CPAN::Frontend->mywarn("Reporting via CPAN::Reporter is currently ".
- "not supported when distroprefs specify ".
- "an interactive test\n");
- }
- $tests_ok = $self->_run_via_expect($system,$expect_model) == 0;
- } elsif ( $ready_to_report ) {
- $tests_ok = CPAN::Reporter::test($self, $system);
- } else {
- $tests_ok = system($system) == 0;
- }
- $self->introduce_myself;
- if ( $tests_ok ) {
- {
- my @prereq;
-
- # local $CPAN::DEBUG = 16; # Distribution
- for my $m (keys %{$self->{sponsored_mods}}) {
- my $m_obj = CPAN::Shell->expand("Module",$m);
- # XXX we need available_version which reflects
- # $ENV{PERL5LIB} so that already tested but not yet
- # installed modules are counted.
- my $available_version = $m_obj->available_version;
- my $available_file = $m_obj->available_file;
- if ($available_version &&
- !CPAN::Version->vlt($available_version,$self->{prereq_pm}{$m})
- ) {
- CPAN->debug("m[$m] good enough available_version[$available_version]")
- if $CPAN::DEBUG;
- } elsif ($available_file
- && (
- !$self->{prereq_pm}{$m}
- ||
- $self->{prereq_pm}{$m} == 0
- )
- ) {
- # lex Class::Accessor::Chained::Fast which has no $VERSION
- CPAN->debug("m[$m] have available_file[$available_file]")
- if $CPAN::DEBUG;
- } else {
- push @prereq, $m;
- }
- }
- if (@prereq){
- my $cnt = @prereq;
- my $which = join ",", @prereq;
- my $but = $cnt == 1 ? "one dependency not OK ($which)" :
- "$cnt dependencies missing ($which)";
- $CPAN::Frontend->mywarn("Tests succeeded but $but\n");
- $self->{make_test} = CPAN::Distrostatus->new("NO $but");
- $self->store_persistent_state;
- return;
- }
- }
-
- $CPAN::Frontend->myprint(" $system -- OK\n");
- $self->{make_test} = CPAN::Distrostatus->new("YES");
- $CPAN::META->is_tested($self->{build_dir},$self->{make_test}{TIME});
- # probably impossible to need the next line because badtestcnt
- # has a lifespan of one command
- delete $self->{badtestcnt};
- } else {
- $self->{make_test} = CPAN::Distrostatus->new("NO");
- $self->{badtestcnt}++;
- $CPAN::Frontend->mywarn(" $system -- NOT OK\n");
- }
- $self->store_persistent_state;
-}
-
-sub _prefs_with_expect {
- my($self,$where) = @_;
- return unless my $prefs = $self->prefs;
- return unless my $where_prefs = $prefs->{$where};
- if ($where_prefs->{expect}) {
- return {
- mode => "deterministic",
- timeout => 15,
- talk => $where_prefs->{expect},
- };
- } elsif ($where_prefs->{"eexpect"}) {
- return $where_prefs->{"eexpect"};
- }
- return;
-}
-
-#-> sub CPAN::Distribution::clean ;
-sub clean {
- my($self) = @_;
- my $make = $self->{modulebuild} ? "Build" : "make";
- $CPAN::Frontend->myprint("Running $make clean\n");
- unless (exists $self->{archived}) {
- $CPAN::Frontend->mywarn("Distribution seems to have never been unzipped".
- "/untarred, nothing done\n");
- return 1;
- }
- unless (exists $self->{build_dir}) {
- $CPAN::Frontend->mywarn("Distribution has no own directory, nothing to do.\n");
- return 1;
- }
- EXCUSE: {
- my @e;
- exists $self->{make_clean} and $self->{make_clean} eq "YES" and
- push @e, "make clean already called once";
- $CPAN::Frontend->myprint(join "", map {" $_\n"} @e) and return if @e;
- }
- chdir $self->{build_dir} or
- Carp::confess("Couldn't chdir to $self->{build_dir}: $!");
- $self->debug("Changed directory to $self->{build_dir}") if $CPAN::DEBUG;
-
- if ($^O eq 'MacOS') {
- Mac::BuildTools::make_clean($self);
- return;
- }
-
- my $system;
- if ($self->{modulebuild}) {
- unless (-f "Build") {
- my $cwd = CPAN::anycwd();
- $CPAN::Frontend->mywarn("Alert: no Build file available for 'clean $self->{id}".
- " in cwd[$cwd]. Danger, Will Robinson!");
- $CPAN::Frontend->mysleep(5);
- }
- $system = sprintf "%s clean", $self->_build_command();
- } else {
- $system = join " ", $self->_make_command(), "clean";
- }
- my $system_ok = system($system) == 0;
- $self->introduce_myself;
- if ( $system_ok ) {
- $CPAN::Frontend->myprint(" $system -- OK\n");
-
- # $self->force;
-
- # Jost Krieger pointed out that this "force" was wrong because
- # it has the effect that the next "install" on this distribution
- # will untar everything again. Instead we should bring the
- # object's state back to where it is after untarring.
-
- for my $k (qw(
- force_update
- install
- writemakefile
- make
- make_test
- )) {
- delete $self->{$k};
- }
- $self->{make_clean} = CPAN::Distrostatus->new("YES");
-
- } else {
- # Hmmm, what to do if make clean failed?
-
- $self->{make_clean} = CPAN::Distrostatus->new("NO");
- $CPAN::Frontend->mywarn(qq{ $system -- NOT OK\n});
-
- # 2006-02-27: seems silly to me to force a make now
- # $self->force("make"); # so that this directory won't be used again
-
- }
- $self->store_persistent_state;
-}
-
-#-> sub CPAN::Distribution::goto ;
-sub goto {
- my($self,$goto) = @_;
- $goto = $self->normalize($goto);
-
- # inject into the queue
-
- CPAN::Queue->delete($self->id);
- CPAN::Queue->jumpqueue([$goto,$self->{reqtype}]);
-
- # and run where we left off
-
- my($method) = (caller(1))[3];
- CPAN->instance("CPAN::Distribution",$goto)->$method;
- CPAN::Queue->delete_first($goto);
-}
-
-#-> sub CPAN::Distribution::install ;
-sub install {
- my($self) = @_;
- if (my $goto = $self->prefs->{goto}) {
- return $self->goto($goto);
- }
- $self->test;
- if ($CPAN::Signal){
- delete $self->{force_update};
- return;
- }
- my $make = $self->{modulebuild} ? "Build" : "make";
- $CPAN::Frontend->myprint("Running $make install\n");
- EXCUSE: {
- my @e;
- unless (exists $self->{make} or exists $self->{later}) {
- push @e,
- "Make had some problems, won't install";
- }
-
- exists $self->{make} and
- (
- UNIVERSAL::can($self->{make},"failed") ?
- $self->{make}->failed :
- $self->{make} =~ /^NO/
- ) and
- push @e, "Make had returned bad status, install seems impossible";
-
- if (exists $self->{build_dir}) {
- } elsif (!@e) {
- push @e, "Has no own directory";
- }
-
- if (exists $self->{make_test} and
- (
- UNIVERSAL::can($self->{make_test},"failed") ?
- $self->{make_test}->failed :
- $self->{make_test} =~ /^NO/
- )){
- if ($self->{force_update}) {
- $self->{make_test}->text("FAILED but failure ignored because ".
- "'force' in effect");
- } else {
- push @e, "make test had returned bad status, ".
- "won't install without force"
- }
- }
- if (exists $self->{install}) {
- if (UNIVERSAL::can($self->{install},"text") ?
- $self->{install}->text eq "YES" :
- $self->{install} =~ /^YES/
- ) {
- push @e, "Already done";
- } else {
- # comment in Todo on 2006-02-11; maybe retry?
- push @e, "Already tried without success";
- }
- }
-
- exists $self->{later} and length($self->{later}) and
- push @e, $self->{later};
-
- $CPAN::Frontend->myprint(join "", map {" $_\n"} @e) and return if @e;
- unless (chdir $self->{build_dir}) {
- push @e, "Couldn't chdir to '$self->{build_dir}': $!";
- }
- $CPAN::Frontend->mywarn(join "", map {" $_\n"} @e) and return if @e;
- }
- $self->debug("Changed directory to $self->{build_dir}")
- if $CPAN::DEBUG;
-
- if ($^O eq 'MacOS') {
- Mac::BuildTools::make_install($self);
- return;
- }
-
- my $system;
- if (my $commandline = $self->prefs->{install}{commandline}) {
- $system = $commandline;
- $ENV{PERL} = $^X;
- } elsif ($self->{modulebuild}) {
- my($mbuild_install_build_command) =
- exists $CPAN::HandleConfig::keys{mbuild_install_build_command} &&
- $CPAN::Config->{mbuild_install_build_command} ?
- $CPAN::Config->{mbuild_install_build_command} :
- $self->_build_command();
- $system = sprintf("%s install %s",
- $mbuild_install_build_command,
- $CPAN::Config->{mbuild_install_arg},
- );
- } else {
- my($make_install_make_command) =
- CPAN::HandleConfig->prefs_lookup($self,
- q{make_install_make_command})
- || $self->_make_command();
- $system = sprintf("%s install %s",
- $make_install_make_command,
- $CPAN::Config->{make_install_arg},
- );
- }
-
- my($stderr) = $^O eq "MSWin32" ? "" : " 2>&1 ";
- my $brip = CPAN::HandleConfig->prefs_lookup($self,
- q{build_requires_install_policy});
- $brip ||="ask/yes";
- my $id = $self->id;
- my $reqtype = $self->{reqtype} ||= "c"; # in doubt it was a command
- my $want_install = "yes";
- if ($reqtype eq "b") {
- if ($brip eq "no") {
- $want_install = "no";
- } elsif ($brip =~ m|^ask/(.+)|) {
- my $default = $1;
- $default = "yes" unless $default =~ /^(y|n)/i;
- $want_install =
- CPAN::Shell::colorable_makemaker_prompt
- ("$id is just needed temporarily during building or testing. ".
- "Do you want to install it permanently? (Y/n)",
- $default);
- }
- }
- unless ($want_install =~ /^y/i) {
- my $is_only = "is only 'build_requires'";
- $CPAN::Frontend->mywarn("Not installing because $is_only\n");
- $self->{install} = CPAN::Distrostatus->new("NO -- $is_only");
- delete $self->{force_update};
- return;
- }
- my($pipe) = FileHandle->new("$system $stderr |");
- my($makeout) = "";
- while (<$pipe>){
- print $_; # intentionally NOT use Frontend->myprint because it
- # looks irritating when we markup in color what we
- # just pass through from an external program
- $makeout .= $_;
- }
- $pipe->close;
- my $close_ok = $? == 0;
- $self->introduce_myself;
- if ( $close_ok ) {
- $CPAN::Frontend->myprint(" $system -- OK\n");
- $CPAN::META->is_installed($self->{build_dir});
- $self->{install} = CPAN::Distrostatus->new("YES");
- } else {
- $self->{install} = CPAN::Distrostatus->new("NO");
- $CPAN::Frontend->mywarn(" $system -- NOT OK\n");
- my $mimc =
- CPAN::HandleConfig->prefs_lookup($self,
- q{make_install_make_command});
- if (
- $makeout =~ /permission/s
- && $> > 0
- && (
- ! $mimc
- || $mimc eq (CPAN::HandleConfig->prefs_lookup($self,
- q{make}))
- )
- ) {
- $CPAN::Frontend->myprint(
- qq{----\n}.
- qq{ You may have to su }.
- qq{to root to install the package\n}.
- qq{ (Or you may want to run something like\n}.
- qq{ o conf make_install_make_command 'sudo make'\n}.
- qq{ to raise your permissions.}
- );
- }
- }
- delete $self->{force_update};
- # $DB::single = 1;
- $self->store_persistent_state;
-}
-
-sub introduce_myself {
- my($self) = @_;
- $CPAN::Frontend->myprint(sprintf(" %s\n",$self->pretty_id));
-}
-
-#-> sub CPAN::Distribution::dir ;
-sub dir {
- shift->{build_dir};
-}
-
-#-> sub CPAN::Distribution::perldoc ;
-sub perldoc {
- my($self) = @_;
-
- my($dist) = $self->id;
- my $package = $self->called_for;
-
- $self->_display_url( $CPAN::Defaultdocs . $package );
-}
-
-#-> sub CPAN::Distribution::_check_binary ;
-sub _check_binary {
- my ($dist,$shell,$binary) = @_;
- my ($pid,$out);
-
- $CPAN::Frontend->myprint(qq{ + _check_binary($binary)\n})
- if $CPAN::DEBUG;
-
- if ($CPAN::META->has_inst("File::Which")) {
- return File::Which::which($binary);
- } else {
- local *README;
- $pid = open README, "which $binary|"
- or $CPAN::Frontend->mywarn(qq{Could not fork 'which $binary': $!\n});
- return unless $pid;
- while (<README>) {
- $out .= $_;
- }
- close README
- or $CPAN::Frontend->mywarn("Could not run 'which $binary': $!\n")
- and return;
- }
-
- $CPAN::Frontend->myprint(qq{ + $out \n})
- if $CPAN::DEBUG && $out;
-
- return $out;
-}
-
-#-> sub CPAN::Distribution::_display_url ;
-sub _display_url {
- my($self,$url) = @_;
- my($res,$saved_file,$pid,$out);
-
- $CPAN::Frontend->myprint(qq{ + _display_url($url)\n})
- if $CPAN::DEBUG;
-
- # should we define it in the config instead?
- my $html_converter = "html2text";
-
- my $web_browser = $CPAN::Config->{'lynx'} || undef;
- my $web_browser_out = $web_browser
- ? CPAN::Distribution->_check_binary($self,$web_browser)
- : undef;
-
- if ($web_browser_out) {
- # web browser found, run the action
- my $browser = CPAN::HandleConfig->safe_quote($CPAN::Config->{'lynx'});
- $CPAN::Frontend->myprint(qq{system[$browser $url]})
- if $CPAN::DEBUG;
- $CPAN::Frontend->myprint(qq{
-Displaying URL
- $url
-with browser $browser
-});
- $CPAN::Frontend->mysleep(1);
- system("$browser $url");
- if ($saved_file) { 1 while unlink($saved_file) }
- } else {
- # web browser not found, let's try text only
- my $html_converter_out =
- CPAN::Distribution->_check_binary($self,$html_converter);
- $html_converter_out = CPAN::HandleConfig->safe_quote($html_converter_out);
-
- if ($html_converter_out ) {
- # html2text found, run it
- $saved_file = CPAN::Distribution->_getsave_url( $self, $url );
- $CPAN::Frontend->mydie(qq{ERROR: problems while getting $url\n})
- unless defined($saved_file);
-
- local *README;
- $pid = open README, "$html_converter $saved_file |"
- or $CPAN::Frontend->mydie(qq{
-Could not fork '$html_converter $saved_file': $!});
- my($fh,$filename);
- if ($CPAN::META->has_inst("File::Temp")) {
- $fh = File::Temp->new(
- template => 'cpan_htmlconvert_XXXX',
- suffix => '.txt',
- unlink => 0,
- );
- $filename = $fh->filename;
- } else {
- $filename = "cpan_htmlconvert_$$.txt";
- $fh = FileHandle->new();
- open $fh, ">$filename" or die;
- }
- while (<README>) {
- $fh->print($_);
- }
- close README or
- $CPAN::Frontend->mydie(qq{Could not run '$html_converter $saved_file': $!});
- my $tmpin = $fh->filename;
- $CPAN::Frontend->myprint(sprintf(qq{
-Run '%s %s' and
-saved output to %s\n},
- $html_converter,
- $saved_file,
- $tmpin,
- )) if $CPAN::DEBUG;
- close $fh;
- local *FH;
- open FH, $tmpin
- or $CPAN::Frontend->mydie(qq{Could not open "$tmpin": $!});
- my $fh_pager = FileHandle->new;
- local($SIG{PIPE}) = "IGNORE";
- my $pager = $CPAN::Config->{'pager'} || "cat";
- $fh_pager->open("|$pager")
- or $CPAN::Frontend->mydie(qq{
-Could not open pager '$pager': $!});
- $CPAN::Frontend->myprint(qq{
-Displaying URL
- $url
-with pager "$pager"
-});
- $CPAN::Frontend->mysleep(1);
- $fh_pager->print(<FH>);
- $fh_pager->close;
- } else {
- # coldn't find the web browser or html converter
- $CPAN::Frontend->myprint(qq{
-You need to install lynx or $html_converter to use this feature.});
- }
- }
-}
-
-#-> sub CPAN::Distribution::_getsave_url ;
-sub _getsave_url {
- my($dist, $shell, $url) = @_;
-
- $CPAN::Frontend->myprint(qq{ + _getsave_url($url)\n})
- if $CPAN::DEBUG;
-
- my($fh,$filename);
- if ($CPAN::META->has_inst("File::Temp")) {
- $fh = File::Temp->new(
- template => "cpan_getsave_url_XXXX",
- suffix => ".html",
- unlink => 0,
- );
- $filename = $fh->filename;
- } else {
- $fh = FileHandle->new;
- $filename = "cpan_getsave_url_$$.html";
- }
- my $tmpin = $filename;
- if ($CPAN::META->has_usable('LWP')) {
- $CPAN::Frontend->myprint("Fetching with LWP:
- $url
-");
- my $Ua;
- CPAN::LWP::UserAgent->config;
- eval { $Ua = CPAN::LWP::UserAgent->new; };
- if ($@) {
- $CPAN::Frontend->mywarn("ERROR: CPAN::LWP::UserAgent->new dies with $@\n");
- return;
- } else {
- my($var);
- $Ua->proxy('http', $var)
- if $var = $CPAN::Config->{http_proxy} || $ENV{http_proxy};
- $Ua->no_proxy($var)
- if $var = $CPAN::Config->{no_proxy} || $ENV{no_proxy};
- }
-
- my $req = HTTP::Request->new(GET => $url);
- $req->header('Accept' => 'text/html');
- my $res = $Ua->request($req);
- if ($res->is_success) {
- $CPAN::Frontend->myprint(" + request successful.\n")
- if $CPAN::DEBUG;
- print $fh $res->content;
- close $fh;
- $CPAN::Frontend->myprint(qq{ + saved content to $tmpin \n})
- if $CPAN::DEBUG;
- return $tmpin;
- } else {
- $CPAN::Frontend->myprint(sprintf(
- "LWP failed with code[%s], message[%s]\n",
- $res->code,
- $res->message,
- ));
- return;
- }
- } else {
- $CPAN::Frontend->mywarn(" LWP not available\n");
- return;
- }
-}
-
-# sub CPAN::Distribution::_build_command
-sub _build_command {
- my($self) = @_;
- if ($^O eq "MSWin32") { # special code needed at least up to
- # Module::Build 0.2611 and 0.2706; a fix
- # in M:B has been promised 2006-01-30
- my($perl) = $self->perl or $CPAN::Frontend->mydie("Couldn't find executable perl\n");
- return "$perl ./Build";
- }
- return "./Build";
-}
-
-package CPAN::Bundle;
-use strict;
-
-sub look {
- my $self = shift;
- $CPAN::Frontend->myprint($self->as_string);
-}
-
-sub undelay {
- my $self = shift;
- delete $self->{later};
- for my $c ( $self->contains ) {
- my $obj = CPAN::Shell->expandany($c) or next;
- $obj->undelay;
- }
-}
-
-# mark as dirty/clean
-#-> sub CPAN::Bundle::color_cmd_tmps ;
-sub color_cmd_tmps {
- my($self) = shift;
- my($depth) = shift || 0;
- my($color) = shift || 0;
- my($ancestors) = shift || [];
- # a module needs to recurse to its cpan_file, a distribution needs
- # to recurse into its prereq_pms, a bundle needs to recurse into its modules
-
- return if exists $self->{incommandcolor}
- && $self->{incommandcolor}==$color;
- if ($depth>=100){
- $CPAN::Frontend->mydie(CPAN::Exception::RecursiveDependency->new($ancestors));
- }
- # warn "color_cmd_tmps $depth $color " . $self->id; # sleep 1;
-
- for my $c ( $self->contains ) {
- my $obj = CPAN::Shell->expandany($c) or next;
- CPAN->debug("c[$c]obj[$obj]") if $CPAN::DEBUG;
- $obj->color_cmd_tmps($depth+1,$color,[@$ancestors, $self->id]);
- }
- # never reached code?
- #if ($color==0) {
- #delete $self->{badtestcnt};
- #}
- $self->{incommandcolor} = $color;
-}
-
-#-> sub CPAN::Bundle::as_string ;
-sub as_string {
- my($self) = @_;
- $self->contains;
- # following line must be "=", not "||=" because we have a moving target
- $self->{INST_VERSION} = $self->inst_version;
- return $self->SUPER::as_string;
-}
-
-#-> sub CPAN::Bundle::contains ;
-sub contains {
- my($self) = @_;
- my($inst_file) = $self->inst_file || "";
- my($id) = $self->id;
- $self->debug("inst_file[$inst_file]id[$id]") if $CPAN::DEBUG;
- if ($inst_file && CPAN::Version->vlt($self->inst_version,$self->cpan_version)) {
- undef $inst_file;
- }
- unless ($inst_file) {
- # Try to get at it in the cpan directory
- $self->debug("no inst_file") if $CPAN::DEBUG;
- my $cpan_file;
- $CPAN::Frontend->mydie("I don't know a bundle with ID $id\n") unless
- $cpan_file = $self->cpan_file;
- if ($cpan_file eq "N/A") {
- $CPAN::Frontend->mydie("Bundle $id not found on disk and not on CPAN.
- Maybe stale symlink? Maybe removed during session? Giving up.\n");
- }
- my $dist = $CPAN::META->instance('CPAN::Distribution',
- $self->cpan_file);
- $self->debug("before get id[$dist->{ID}]") if $CPAN::DEBUG;
- $dist->get;
- $self->debug("after get id[$dist->{ID}]") if $CPAN::DEBUG;
- my($todir) = $CPAN::Config->{'cpan_home'};
- my(@me,$from,$to,$me);
- @me = split /::/, $self->id;
- $me[-1] .= ".pm";
- $me = File::Spec->catfile(@me);
- $from = $self->find_bundle_file($dist->{build_dir},join('/',@me));
- $to = File::Spec->catfile($todir,$me);
- File::Path::mkpath(File::Basename::dirname($to));
- File::Copy::copy($from, $to)
- or Carp::confess("Couldn't copy $from to $to: $!");
- $inst_file = $to;
- }
- my @result;
- my $fh = FileHandle->new;
- local $/ = "\n";
- open($fh,$inst_file) or die "Could not open '$inst_file': $!";
- my $in_cont = 0;
- $self->debug("inst_file[$inst_file]") if $CPAN::DEBUG;
- while (<$fh>) {
- $in_cont = m/^=(?!head1\s+CONTENTS)/ ? 0 :
- m/^=head1\s+CONTENTS/ ? 1 : $in_cont;
- next unless $in_cont;
- next if /^=/;
- s/\#.*//;
- next if /^\s+$/;
- chomp;
- push @result, (split " ", $_, 2)[0];
- }
- close $fh;
- delete $self->{STATUS};
- $self->{CONTAINS} = \@result;
- $self->debug("CONTAINS[@result]") if $CPAN::DEBUG;
- unless (@result) {
- $CPAN::Frontend->mywarn(qq{
-The bundle file "$inst_file" may be a broken
-bundlefile. It seems not to contain any bundle definition.
-Please check the file and if it is bogus, please delete it.
-Sorry for the inconvenience.
-});
- }
- @result;
-}
-
-#-> sub CPAN::Bundle::find_bundle_file
-# $where is in local format, $what is in unix format
-sub find_bundle_file {
- my($self,$where,$what) = @_;
- $self->debug("where[$where]what[$what]") if $CPAN::DEBUG;
-### The following two lines let CPAN.pm become Bundle/CPAN.pm :-(
-### my $bu = File::Spec->catfile($where,$what);
-### return $bu if -f $bu;
- my $manifest = File::Spec->catfile($where,"MANIFEST");
- unless (-f $manifest) {
- require ExtUtils::Manifest;
- my $cwd = CPAN::anycwd();
- $self->safe_chdir($where);
- ExtUtils::Manifest::mkmanifest();
- $self->safe_chdir($cwd);
- }
- my $fh = FileHandle->new($manifest)
- or Carp::croak("Couldn't open $manifest: $!");
- local($/) = "\n";
- my $bundle_filename = $what;
- $bundle_filename =~ s|Bundle.*/||;
- my $bundle_unixpath;
- while (<$fh>) {
- next if /^\s*\#/;
- my($file) = /(\S+)/;
- if ($file =~ m|\Q$what\E$|) {
- $bundle_unixpath = $file;
- # return File::Spec->catfile($where,$bundle_unixpath); # bad
- last;
- }
- # retry if she managed to have no Bundle directory
- $bundle_unixpath = $file if $file =~ m|\Q$bundle_filename\E$|;
- }
- return File::Spec->catfile($where, split /\//, $bundle_unixpath)
- if $bundle_unixpath;
- Carp::croak("Couldn't find a Bundle file in $where");
-}
+ applypatch path to external prg
+ auto_commit commit all changes to config variables to disk
+ build_cache size of cache for directories to build modules
+ build_dir locally accessible directory to build modules
+ build_dir_reuse boolean if distros in build_dir are persistent
+ build_requires_install_policy
+ to install or not to install when a module is
+ only needed for building. yes|no|ask/yes|ask/no
+ bzip2 path to external prg
+ cache_metadata use serializer to cache metadata
+ check_sigs if signatures should be verified
+ colorize_debug Term::ANSIColor attributes for debugging output
+ colorize_output boolean if Term::ANSIColor should colorize output
+ colorize_print Term::ANSIColor attributes for normal output
+ colorize_warn Term::ANSIColor attributes for warnings
+ commandnumber_in_prompt
+ boolean if you want to see current command number
+ commands_quote preferred character to use for quoting external
+ commands when running them. Defaults to double
+ quote on Windows, single tick everywhere else;
+ can be set to space to disable quoting
+ connect_to_internet_ok
+ whether to ask if opening a connection is ok before
+ urllist is specified
+ cpan_home local directory reserved for this package
+ curl path to external prg
+ dontload_hash DEPRECATED
+ dontload_list arrayref: modules in the list will not be
+ loaded by the CPAN::has_inst() routine
+ ftp path to external prg
+ ftp_passive if set, the envariable FTP_PASSIVE is set for downloads
+ ftp_proxy proxy host for ftp requests
+ ftpstats_period max number of days to keep download statistics
+ ftpstats_size max number of items to keep in the download statistics
+ getcwd see below
+ gpg path to external prg
+ gzip location of external program gzip
+ halt_on_failure stop processing after the first failure of queued
+ items or dependencies
+ histfile file to maintain history between sessions
+ histsize maximum number of lines to keep in histfile
+ http_proxy proxy host for http requests
+ inactivity_timeout breaks interactive Makefile.PLs or Build.PLs
+ after this many seconds inactivity. Set to 0 to
+ disable timeouts.
+ index_expire refetch index files after this many days
+ inhibit_startup_message
+ if true, suppress the startup message
+ keep_source_where directory in which to keep the source (if we do)
+ load_module_verbosity
+ report loading of optional modules used by CPAN.pm
+ lynx path to external prg
+ make location of external make program
+ make_arg arguments that should always be passed to 'make'
+ make_install_make_command
+ the make command for running 'make install', for
+ example 'sudo make'
+ make_install_arg same as make_arg for 'make install'
+ makepl_arg arguments passed to 'perl Makefile.PL'
+ mbuild_arg arguments passed to './Build'
+ mbuild_install_arg arguments passed to './Build install'
+ mbuild_install_build_command
+ command to use instead of './Build' when we are
+ in the install stage, for example 'sudo ./Build'
+ mbuildpl_arg arguments passed to 'perl Build.PL'
+ ncftp path to external prg
+ ncftpget path to external prg
+ no_proxy don't proxy to these hosts/domains (comma separated list)
+ pager location of external program more (or any pager)
+ password your password if you CPAN server wants one
+ patch path to external prg
+ patches_dir local directory containing patch files
+ perl5lib_verbosity verbosity level for PERL5LIB additions
+ prefer_installer legal values are MB and EUMM: if a module comes
+ with both a Makefile.PL and a Build.PL, use the
+ former (EUMM) or the latter (MB); if the module
+ comes with only one of the two, that one will be
+ used no matter the setting
+ prerequisites_policy
+ what to do if you are missing module prerequisites
+ ('follow' automatically, 'ask' me, or 'ignore')
+ prefs_dir local directory to store per-distro build options
+ proxy_user username for accessing an authenticating proxy
+ proxy_pass password for accessing an authenticating proxy
+ randomize_urllist add some randomness to the sequence of the urllist
+ scan_cache controls scanning of cache ('atstart' or 'never')
+ shell your favorite shell
+ show_unparsable_versions
+ boolean if r command tells which modules are versionless
+ show_upload_date boolean if commands should try to determine upload date
+ show_zero_versions boolean if r command tells for which modules $version==0
+ tar location of external program tar
+ tar_verbosity verbosity level for the tar command
+ term_is_latin deprecated: if true Unicode is translated to ISO-8859-1
+ (and nonsense for characters outside latin range)
+ term_ornaments boolean to turn ReadLine ornamenting on/off
+ test_report email test reports (if CPAN::Reporter is installed)
+ trust_test_report_history
+ skip testing when previously tested ok (according to
+ CPAN::Reporter history)
+ unzip location of external program unzip
+ urllist arrayref to nearby CPAN sites (or equivalent locations)
+ use_sqlite use CPAN::SQLite for metadata storage (fast and lean)
+ username your username if you CPAN server wants one
+ wait_list arrayref to a wait server to try (See CPAN::WAIT)
+ wget path to external prg
+ yaml_load_code enable YAML code deserialisation via CPAN::DeferredCode
+ yaml_module which module to use to read/write YAML files
-# needs to work quite differently from Module::inst_file because of
-# cpan_home/Bundle/ directory and the possibility that we have
-# shadowing effect. As it makes no sense to take the first in @INC for
-# Bundles, we parse them all for $VERSION and take the newest.
+You can set and query each of these options interactively in the cpan
+shell with the C<o conf> or the C<o conf init> command as specified below.
-#-> sub CPAN::Bundle::inst_file ;
-sub inst_file {
- my($self) = @_;
- my($inst_file);
- my(@me);
- @me = split /::/, $self->id;
- $me[-1] .= ".pm";
- my($incdir,$bestv);
- foreach $incdir ($CPAN::Config->{'cpan_home'},@INC) {
- my $bfile = File::Spec->catfile($incdir, @me);
- CPAN->debug("bfile[$bfile]") if $CPAN::DEBUG;
- next unless -f $bfile;
- my $foundv = MM->parse_version($bfile);
- if (!$bestv || CPAN::Version->vgt($foundv,$bestv)) {
- $self->{INST_FILE} = $bfile;
- $self->{INST_VERSION} = $bestv = $foundv;
- }
- }
- $self->{INST_FILE};
-}
+=over 2
-#-> sub CPAN::Bundle::inst_version ;
-sub inst_version {
- my($self) = @_;
- $self->inst_file; # finds INST_VERSION as side effect
- $self->{INST_VERSION};
-}
+=item C<o conf E<lt>scalar optionE<gt>>
-#-> sub CPAN::Bundle::rematein ;
-sub rematein {
- my($self,$meth) = @_;
- $self->debug("self[$self] meth[$meth]") if $CPAN::DEBUG;
- my($id) = $self->id;
- Carp::croak "Can't $meth $id, don't have an associated bundle file. :-(\n"
- unless $self->inst_file || $self->cpan_file;
- my($s,%fail);
- for $s ($self->contains) {
- my($type) = $s =~ m|/| ? 'CPAN::Distribution' :
- $s =~ m|^Bundle::| ? 'CPAN::Bundle' : 'CPAN::Module';
- if ($type eq 'CPAN::Distribution') {
- $CPAN::Frontend->mywarn(qq{
-The Bundle }.$self->id.qq{ contains
-explicitly a file '$s'.
-Going to $meth that.
-});
- $CPAN::Frontend->mysleep(5);
- }
- # possibly noisy action:
- $self->debug("type[$type] s[$s]") if $CPAN::DEBUG;
- my $obj = $CPAN::META->instance($type,$s);
- $obj->{reqtype} = $self->{reqtype};
- $obj->$meth();
- if ($obj->isa('CPAN::Bundle')
- &&
- exists $obj->{install_failed}
- &&
- ref($obj->{install_failed}) eq "HASH"
- ) {
- for (keys %{$obj->{install_failed}}) {
- $self->{install_failed}{$_} = undef; # propagate faiure up
- # to me in a
- # recursive call
- $fail{$s} = 1; # the bundle itself may have succeeded but
- # not all children
- }
- } else {
- my $success;
- $success = $obj->can("uptodate") ? $obj->uptodate : 0;
- $success ||= $obj->{install} && $obj->{install} eq "YES";
- if ($success) {
- delete $self->{install_failed}{$s};
- } else {
- $fail{$s} = 1;
- }
- }
- }
+prints the current value of the I<scalar option>
- # recap with less noise
- if ( $meth eq "install" ) {
- if (%fail) {
- require Text::Wrap;
- my $raw = sprintf(qq{Bundle summary:
-The following items in bundle %s had installation problems:},
- $self->id
- );
- $CPAN::Frontend->myprint(Text::Wrap::fill("","",$raw));
- $CPAN::Frontend->myprint("\n");
- my $paragraph = "";
- my %reported;
- for $s ($self->contains) {
- if ($fail{$s}){
- $paragraph .= "$s ";
- $self->{install_failed}{$s} = undef;
- $reported{$s} = undef;
- }
- }
- my $report_propagated;
- for $s (sort keys %{$self->{install_failed}}) {
- next if exists $reported{$s};
- $paragraph .= "and the following items had problems
-during recursive bundle calls: " unless $report_propagated++;
- $paragraph .= "$s ";
- }
- $CPAN::Frontend->myprint(Text::Wrap::fill(" "," ",$paragraph));
- $CPAN::Frontend->myprint("\n");
- } else {
- $self->{install} = 'YES';
- }
- }
-}
+=item C<o conf E<lt>scalar optionE<gt> E<lt>valueE<gt>>
-# If a bundle contains another that contains an xs_file we have here,
-# we just don't bother I suppose
-#-> sub CPAN::Bundle::xs_file
-sub xs_file {
- return 0;
-}
+Sets the value of the I<scalar option> to I<value>
-#-> sub CPAN::Bundle::force ;
-sub fforce { shift->rematein('fforce',@_); }
-#-> sub CPAN::Bundle::force ;
-sub force { shift->rematein('force',@_); }
-#-> sub CPAN::Bundle::notest ;
-sub notest { shift->rematein('notest',@_); }
-#-> sub CPAN::Bundle::get ;
-sub get { shift->rematein('get',@_); }
-#-> sub CPAN::Bundle::make ;
-sub make { shift->rematein('make',@_); }
-#-> sub CPAN::Bundle::test ;
-sub test {
- my $self = shift;
- # $self->{badtestcnt} ||= 0;
- $self->rematein('test',@_);
-}
-#-> sub CPAN::Bundle::install ;
-sub install {
- my $self = shift;
- $self->rematein('install',@_);
-}
-#-> sub CPAN::Bundle::clean ;
-sub clean { shift->rematein('clean',@_); }
+=item C<o conf E<lt>list optionE<gt>>
-#-> sub CPAN::Bundle::uptodate ;
-sub uptodate {
- my($self) = @_;
- return 0 unless $self->SUPER::uptodate; # we mut have the current Bundle def
- my $c;
- foreach $c ($self->contains) {
- my $obj = CPAN::Shell->expandany($c);
- return 0 unless $obj->uptodate;
- }
- return 1;
-}
+prints the current value of the I<list option> in MakeMaker's
+neatvalue format.
-#-> sub CPAN::Bundle::readme ;
-sub readme {
- my($self) = @_;
- my($file) = $self->cpan_file or $CPAN::Frontend->myprint(qq{
-No File found for bundle } . $self->id . qq{\n}), return;
- $self->debug("self[$self] file[$file]") if $CPAN::DEBUG;
- $CPAN::META->instance('CPAN::Distribution',$file)->readme;
-}
+=item C<o conf E<lt>list optionE<gt> [shift|pop]>
-package CPAN::Module;
-use strict;
+shifts or pops the array in the I<list option> variable
-# Accessors
-# sub CPAN::Module::userid
-sub userid {
- my $self = shift;
- my $ro = $self->ro;
- return unless $ro;
- return $ro->{userid} || $ro->{CPAN_USERID};
-}
-# sub CPAN::Module::description
-sub description {
- my $self = shift;
- my $ro = $self->ro or return "";
- $ro->{description}
-}
+=item C<o conf E<lt>list optionE<gt> [unshift|push|splice] E<lt>listE<gt>>
-sub distribution {
- my($self) = @_;
- CPAN::Shell->expand("Distribution",$self->cpan_file);
-}
+works like the corresponding perl commands.
-# sub CPAN::Module::undelay
-sub undelay {
- my $self = shift;
- delete $self->{later};
- if ( my $dist = CPAN::Shell->expand("Distribution", $self->cpan_file) ) {
- $dist->undelay;
- }
-}
+=item interactive editing: o conf init [MATCH|LIST]
-# mark as dirty/clean
-#-> sub CPAN::Module::color_cmd_tmps ;
-sub color_cmd_tmps {
- my($self) = shift;
- my($depth) = shift || 0;
- my($color) = shift || 0;
- my($ancestors) = shift || [];
- # a module needs to recurse to its cpan_file
-
- return if exists $self->{incommandcolor}
- && $self->{incommandcolor}==$color;
- return if $depth>=1 && $self->uptodate;
- if ($depth>=100){
- $CPAN::Frontend->mydie(CPAN::Exception::RecursiveDependency->new($ancestors));
- }
- # warn "color_cmd_tmps $depth $color " . $self->id; # sleep 1;
+Runs an interactive configuration dialog for matching variables.
+Without argument runs the dialog over all supported config variables.
+To specify a MATCH the argument must be enclosed by slashes.
- if ( my $dist = CPAN::Shell->expand("Distribution", $self->cpan_file) ) {
- $dist->color_cmd_tmps($depth+1,$color,[@$ancestors, $self->id]);
- }
- # unreached code?
- # if ($color==0) {
- # delete $self->{badtestcnt};
- # }
- $self->{incommandcolor} = $color;
-}
+Examples:
-#-> sub CPAN::Module::as_glimpse ;
-sub as_glimpse {
- my($self) = @_;
- my(@m);
- my $class = ref($self);
- $class =~ s/^CPAN:://;
- my $color_on = "";
- my $color_off = "";
- if (
- $CPAN::Shell::COLOR_REGISTERED
- &&
- $CPAN::META->has_inst("Term::ANSIColor")
- &&
- $self->description
- ) {
- $color_on = Term::ANSIColor::color("green");
- $color_off = Term::ANSIColor::color("reset");
- }
- my $uptodateness = " ";
- if ($class eq "Bundle") {
- } elsif ($self->uptodate) {
- $uptodateness = "=";
- } elsif ($self->inst_version) {
- $uptodateness = "<";
- }
- push @m, sprintf("%-7s %1s %s%-22s%s (%s)\n",
- $class,
- $uptodateness,
- $color_on,
- $self->id,
- $color_off,
- ($self->distribution ?
- $self->distribution->pretty_id :
- $self->cpan_userid
- ),
- );
- join "", @m;
-}
+ o conf init ftp_passive ftp_proxy
+ o conf init /color/
-#-> sub CPAN::Module::dslip_status
-sub dslip_status {
- my($self) = @_;
- my($stat);
- @{$stat->{D}}{qw,i c a b R M S,} = qw,idea
- pre-alpha alpha beta released
- mature standard,;
- @{$stat->{S}}{qw,m d u n a,} = qw,mailing-list
- developer comp.lang.perl.*
- none abandoned,;
- @{$stat->{L}}{qw,p c + o h,} = qw,perl C C++ other hybrid,;
- @{$stat->{I}}{qw,f r O p h n,} = qw,functions
- references+ties
- object-oriented pragma
- hybrid none,;
- @{$stat->{P}}{qw,p g l b a o d r n,} = qw,Standard-Perl
- GPL LGPL
- BSD Artistic
- open-source
- distribution_allowed
- restricted_distribution
- no_licence,;
- for my $x (qw(d s l i p)) {
- $stat->{$x}{' '} = 'unknown';
- $stat->{$x}{'?'} = 'unknown';
- }
- my $ro = $self->ro;
- return +{} unless $ro && $ro->{statd};
- return {
- D => $ro->{statd},
- S => $ro->{stats},
- L => $ro->{statl},
- I => $ro->{stati},
- P => $ro->{statp},
- DV => $stat->{D}{$ro->{statd}},
- SV => $stat->{S}{$ro->{stats}},
- LV => $stat->{L}{$ro->{statl}},
- IV => $stat->{I}{$ro->{stati}},
- PV => $stat->{P}{$ro->{statp}},
- };
-}
+Note: this method of setting config variables often provides more
+explanation about the functioning of a variable than the manpage.
-#-> sub CPAN::Module::as_string ;
-sub as_string {
- my($self) = @_;
- my(@m);
- CPAN->debug("$self entering as_string") if $CPAN::DEBUG;
- my $class = ref($self);
- $class =~ s/^CPAN:://;
- local($^W) = 0;
- push @m, $class, " id = $self->{ID}\n";
- my $sprintf = " %-12s %s\n";
- push @m, sprintf($sprintf, 'DESCRIPTION', $self->description)
- if $self->description;
- my $sprintf2 = " %-12s %s (%s)\n";
- my($userid);
- $userid = $self->userid;
- if ( $userid ){
- my $author;
- if ($author = CPAN::Shell->expand('Author',$userid)) {
- my $email = "";
- my $m; # old perls
- if ($m = $author->email) {
- $email = " <$m>";
- }
- push @m, sprintf(
- $sprintf2,
- 'CPAN_USERID',
- $userid,
- $author->fullname . $email
- );
- }
- }
- push @m, sprintf($sprintf, 'CPAN_VERSION', $self->cpan_version)
- if $self->cpan_version;
- if (my $cpan_file = $self->cpan_file){
- push @m, sprintf($sprintf, 'CPAN_FILE', $cpan_file);
- if (my $dist = CPAN::Shell->expand("Distribution",$cpan_file)) {
- my $upload_date = $dist->upload_date;
- if ($upload_date) {
- push @m, sprintf($sprintf, 'UPLOAD_DATE', $upload_date);
- }
- }
- }
- my $sprintf3 = " %-12s %1s%1s%1s%1s%1s (%s,%s,%s,%s,%s)\n";
- my $dslip = $self->dslip_status;
- push @m, sprintf(
- $sprintf3,
- 'DSLIP_STATUS',
- @{$dslip}{qw(D S L I P DV SV LV IV PV)},
- ) if $dslip->{D};
- my $local_file = $self->inst_file;
- unless ($self->{MANPAGE}) {
- my $manpage;
- if ($local_file) {
- $manpage = $self->manpage_headline($local_file);
- } else {
- # If we have already untarred it, we should look there
- my $dist = $CPAN::META->instance('CPAN::Distribution',
- $self->cpan_file);
- # warn "dist[$dist]";
- # mff=manifest file; mfh=manifest handle
- my($mff,$mfh);
- if (
- $dist->{build_dir}
- and
- (-f ($mff = File::Spec->catfile($dist->{build_dir}, "MANIFEST")))
- and
- $mfh = FileHandle->new($mff)
- ) {
- CPAN->debug("mff[$mff]") if $CPAN::DEBUG;
- my $lfre = $self->id; # local file RE
- $lfre =~ s/::/./g;
- $lfre .= "\\.pm\$";
- my($lfl); # local file file
- local $/ = "\n";
- my(@mflines) = <$mfh>;
- for (@mflines) {
- s/^\s+//;
- s/\s.*//s;
- }
- while (length($lfre)>5 and !$lfl) {
- ($lfl) = grep /$lfre/, @mflines;
- CPAN->debug("lfl[$lfl]lfre[$lfre]") if $CPAN::DEBUG;
- $lfre =~ s/.+?\.//;
- }
- $lfl =~ s/\s.*//; # remove comments
- $lfl =~ s/\s+//g; # chomp would maybe be too system-specific
- my $lfl_abs = File::Spec->catfile($dist->{build_dir},$lfl);
- # warn "lfl_abs[$lfl_abs]";
- if (-f $lfl_abs) {
- $manpage = $self->manpage_headline($lfl_abs);
- }
- }
- }
- $self->{MANPAGE} = $manpage if $manpage;
- }
- my($item);
- for $item (qw/MANPAGE/) {
- push @m, sprintf($sprintf, $item, $self->{$item})
- if exists $self->{$item};
- }
- for $item (qw/CONTAINS/) {
- push @m, sprintf($sprintf, $item, join(" ",@{$self->{$item}}))
- if exists $self->{$item} && @{$self->{$item}};
- }
- push @m, sprintf($sprintf, 'INST_FILE',
- $local_file || "(not installed)");
- push @m, sprintf($sprintf, 'INST_VERSION',
- $self->inst_version) if $local_file;
- join "", @m, "\n";
-}
+=back
-sub manpage_headline {
- my($self,$local_file) = @_;
- my(@local_file) = $local_file;
- $local_file =~ s/\.pm(?!\n)\Z/.pod/;
- push @local_file, $local_file;
- my(@result,$locf);
- for $locf (@local_file) {
- next unless -f $locf;
- my $fh = FileHandle->new($locf)
- or $Carp::Frontend->mydie("Couldn't open $locf: $!");
- my $inpod = 0;
- local $/ = "\n";
- while (<$fh>) {
- $inpod = m/^=(?!head1\s+NAME\s*$)/ ? 0 :
- m/^=head1\s+NAME\s*$/ ? 1 : $inpod;
- next unless $inpod;
- next if /^=/;
- next if /^\s+$/;
- chomp;
- push @result, $_;
- }
- close $fh;
- last if @result;
- }
- for (@result) {
- s/^\s+//;
- s/\s+$//;
- }
- join " ", @result;
-}
+=head2 CPAN::anycwd($path): Note on config variable getcwd
-#-> sub CPAN::Module::cpan_file ;
-# Note: also inherited by CPAN::Bundle
-sub cpan_file {
- my $self = shift;
- # CPAN->debug(sprintf "id[%s]", $self->id) if $CPAN::DEBUG;
- unless ($self->ro) {
- CPAN::Index->reload;
- }
- my $ro = $self->ro;
- if ($ro && defined $ro->{CPAN_FILE}){
- return $ro->{CPAN_FILE};
- } else {
- my $userid = $self->userid;
- if ( $userid ) {
- if ($CPAN::META->exists("CPAN::Author",$userid)) {
- my $author = $CPAN::META->instance("CPAN::Author",
- $userid);
- my $fullname = $author->fullname;
- my $email = $author->email;
- unless (defined $fullname && defined $email) {
- return sprintf("Contact Author %s",
- $userid,
- );
- }
- return "Contact Author $fullname <$email>";
- } else {
- return "Contact Author $userid (Email address not available)";
- }
- } else {
- return "N/A";
- }
- }
-}
+CPAN.pm changes the current working directory often and needs to
+determine its own current working directory. By default it uses
+Cwd::cwd, but if for some reason this doesn't work on your system,
+configure alternatives according to the following table:
-#-> sub CPAN::Module::cpan_version ;
-sub cpan_version {
- my $self = shift;
+=over 4
- my $ro = $self->ro;
- unless ($ro) {
- # Can happen with modules that are not on CPAN
- $ro = {};
- }
- $ro->{CPAN_VERSION} = 'undef'
- unless defined $ro->{CPAN_VERSION};
- $ro->{CPAN_VERSION};
-}
+=item cwd
-#-> sub CPAN::Module::force ;
-sub force {
- my($self) = @_;
- $self->{force_update} = 1;
-}
+Calls Cwd::cwd
-#-> sub CPAN::Module::fforce ;
-sub fforce {
- my($self) = @_;
- $self->{force_update} = 2;
-}
+=item getcwd
-sub notest {
- my($self) = @_;
- # warn "XDEBUG: set notest for Module";
- $self->{'notest'}++;
-}
+Calls Cwd::getcwd
-#-> sub CPAN::Module::rematein ;
-sub rematein {
- my($self,$meth) = @_;
- $CPAN::Frontend->myprint(sprintf("Running %s for module '%s'\n",
- $meth,
- $self->id));
- my $cpan_file = $self->cpan_file;
- if ($cpan_file eq "N/A" || $cpan_file =~ /^Contact Author/){
- $CPAN::Frontend->mywarn(sprintf qq{
- The module %s isn\'t available on CPAN.
-
- Either the module has not yet been uploaded to CPAN, or it is
- temporary unavailable. Please contact the author to find out
- more about the status. Try 'i %s'.
-},
- $self->id,
- $self->id,
- );
- return;
- }
- my $pack = $CPAN::META->instance('CPAN::Distribution',$cpan_file);
- $pack->called_for($self->id);
- if (exists $self->{force_update}){
- if ($self->{force_update} == 2) {
- $pack->fforce($meth);
- } else {
- $pack->force($meth);
- }
- }
- $pack->notest($meth) if exists $self->{'notest'};
-
- $pack->{reqtype} ||= "";
- CPAN->debug("dist-reqtype[$pack->{reqtype}]".
- "self-reqtype[$self->{reqtype}]") if $CPAN::DEBUG;
- if ($pack->{reqtype}) {
- if ($pack->{reqtype} eq "b" && $self->{reqtype} =~ /^[rc]$/) {
- $pack->{reqtype} = $self->{reqtype};
- if (
- exists $pack->{install}
- &&
- (
- UNIVERSAL::can($pack->{install},"failed") ?
- $pack->{install}->failed :
- $pack->{install} =~ /^NO/
- )
- ) {
- delete $pack->{install};
- $CPAN::Frontend->mywarn
- ("Promoting $pack->{ID} from 'build_requires' to 'requires'");
- }
- }
- } else {
- $pack->{reqtype} = $self->{reqtype};
- }
+=item fastcwd
- eval {
- $pack->$meth();
- };
- my $err = $@;
- $pack->unforce if $pack->can("unforce") && exists $self->{force_update};
- $pack->unnotest if $pack->can("unnotest") && exists $self->{'notest'};
- delete $self->{force_update};
- delete $self->{'notest'};
- if ($err) {
- die $err;
- }
-}
+Calls Cwd::fastcwd
-#-> sub CPAN::Module::perldoc ;
-sub perldoc { shift->rematein('perldoc') }
-#-> sub CPAN::Module::readme ;
-sub readme { shift->rematein('readme') }
-#-> sub CPAN::Module::look ;
-sub look { shift->rematein('look') }
-#-> sub CPAN::Module::cvs_import ;
-sub cvs_import { shift->rematein('cvs_import') }
-#-> sub CPAN::Module::get ;
-sub get { shift->rematein('get',@_) }
-#-> sub CPAN::Module::make ;
-sub make { shift->rematein('make') }
-#-> sub CPAN::Module::test ;
-sub test {
- my $self = shift;
- # $self->{badtestcnt} ||= 0;
- $self->rematein('test',@_);
-}
-#-> sub CPAN::Module::uptodate ;
-sub uptodate {
- my($self) = @_;
- local($_); # protect against a bug in MakeMaker 6.17
- my($latest) = $self->cpan_version;
- $latest ||= 0;
- my($inst_file) = $self->inst_file;
- my($have) = 0;
- if (defined $inst_file) {
- $have = $self->inst_version;
- }
- local($^W)=0;
- if ($inst_file
- &&
- ! CPAN::Version->vgt($latest, $have)
- ) {
- CPAN->debug("returning uptodate. inst_file[$inst_file] ".
- "latest[$latest] have[$have]") if $CPAN::DEBUG;
- return 1;
- }
- return;
-}
-#-> sub CPAN::Module::install ;
-sub install {
- my($self) = @_;
- my($doit) = 0;
- if ($self->uptodate
- &&
- not exists $self->{force_update}
- ) {
- $CPAN::Frontend->myprint(sprintf("%s is up to date (%s).\n",
- $self->id,
- $self->inst_version,
- ));
- } else {
- $doit = 1;
- }
- my $ro = $self->ro;
- if ($ro && $ro->{stats} && $ro->{stats} eq "a") {
- $CPAN::Frontend->mywarn(qq{
-\n\n\n ***WARNING***
- The module $self->{ID} has no active maintainer.\n\n\n
-});
- $CPAN::Frontend->mysleep(5);
- }
- $self->rematein('install') if $doit;
-}
-#-> sub CPAN::Module::clean ;
-sub clean { shift->rematein('clean') }
+=item backtickcwd
-#-> sub CPAN::Module::inst_file ;
-sub inst_file {
- my($self) = @_;
- $self->_file_in_path([@INC]);
-}
+Calls the external command cwd.
-#-> sub CPAN::Module::available_file ;
-sub available_file {
- my($self) = @_;
- my $sep = $Config::Config{path_sep};
- my $perllib = $ENV{PERL5LIB};
- $perllib = $ENV{PERLLIB} unless defined $perllib;
- my @perllib = split(/$sep/,$perllib) if defined $perllib;
- $self->_file_in_path([@perllib,@INC]);
-}
+=back
-#-> sub CPAN::Module::file_in_path ;
-sub _file_in_path {
- my($self,$path) = @_;
- my($dir,@packpath);
- @packpath = split /::/, $self->{ID};
- $packpath[-1] .= ".pm";
- if (@packpath == 1 && $packpath[0] eq "readline.pm") {
- unshift @packpath, "Term", "ReadLine"; # historical reasons
- }
- foreach $dir (@$path) {
- my $pmfile = File::Spec->catfile($dir,@packpath);
- if (-f $pmfile){
- return $pmfile;
- }
- }
- return;
-}
+=head2 Note on the format of the urllist parameter
-#-> sub CPAN::Module::xs_file ;
-sub xs_file {
- my($self) = @_;
- my($dir,@packpath);
- @packpath = split /::/, $self->{ID};
- push @packpath, $packpath[-1];
- $packpath[-1] .= "." . $Config::Config{'dlext'};
- foreach $dir (@INC) {
- my $xsfile = File::Spec->catfile($dir,'auto',@packpath);
- if (-f $xsfile){
- return $xsfile;
- }
- }
- return;
-}
+urllist parameters are URLs according to RFC 1738. We do a little
+guessing if your URL is not compliant, but if you have problems with
+C<file> URLs, please try the correct format. Either:
-#-> sub CPAN::Module::inst_version ;
-sub inst_version {
- my($self) = @_;
- my $parsefile = $self->inst_file or return;
- my $have = $self->parse_version($parsefile);
- $have;
-}
+ file://localhost/whatever/ftp/pub/CPAN/
-#-> sub CPAN::Module::inst_version ;
-sub available_version {
- my($self) = @_;
- my $parsefile = $self->available_file or return;
- my $have = $self->parse_version($parsefile);
- $have;
-}
+or
-#-> sub CPAN::Module::parse_version ;
-sub parse_version {
- my($self,$parsefile) = @_;
- my $have = MM->parse_version($parsefile);
- $have = "undef" unless defined $have && length $have;
- $have =~ s/^ //; # since the %vd hack these two lines here are needed
- $have =~ s/ $//; # trailing whitespace happens all the time
+ file:///home/ftp/pub/CPAN/
- $have = CPAN::Version->readable($have);
+=head2 The urllist parameter has CD-ROM support
- $have =~ s/\s*//g; # stringify to float around floating point issues
- $have; # no stringify needed, \s* above matches always
-}
+The C<urllist> parameter of the configuration table contains a list of
+URLs used for downloading. If the list contains any
+C<file> URLs, CPAN always tries there first. This
+feature is disabled for index files. So the recommendation for the
+owner of a CD-ROM with CPAN contents is: include your local, possibly
+outdated CD-ROM as a C<file> URL at the end of urllist, e.g.
-package CPAN;
-use strict;
+ o conf urllist push file://localhost/CDROM/CPAN
-1;
+CPAN.pm will then fetch the index files from one of the CPAN sites
+that come at the beginning of urllist. It will later check for each
+module to see whether there is a local copy of the most recent version.
+Another peculiarity of urllist is that the site that we could
+successfully fetch the last file from automatically gets a preference
+token and is tried as the first site for the next request. So if you
+add a new site at runtime it may happen that the previously preferred
+site will be tried another time. This means that if you want to disallow
+a site for the next transfer, it must be explicitly removed from
+urllist.
-__END__
+=head2 Maintaining the urllist parameter
-=head1 NAME
+If you have YAML.pm (or some other YAML module configured in
+C<yaml_module>) installed, CPAN.pm collects a few statistical data
+about recent downloads. You can view the statistics with the C<hosts>
+command or inspect them directly by looking into the C<FTPstats.yml>
+file in your C<cpan_home> directory.
-CPAN - query, download and build perl modules from CPAN sites
+To get some interesting statistics, it is recommended that
+C<randomize_urllist> be set; this introduces some amount of
+randomness into the URL selection.
-=head1 SYNOPSIS
+=head2 The C<requires> and C<build_requires> dependency declarations
-Interactive mode:
+Since CPAN.pm version 1.88_51 modules declared as C<build_requires> by
+a distribution are treated differently depending on the config
+variable C<build_requires_install_policy>. By setting
+C<build_requires_install_policy> to C<no>, such a module is not
+installed. It is only built and tested, and then kept in the list of
+tested but uninstalled modules. As such, it is available during the
+build of the dependent module by integrating the path to the
+C<blib/arch> and C<blib/lib> directories in the environment variable
+PERL5LIB. If C<build_requires_install_policy> is set ti C<yes>, then
+both modules declared as C<requires> and those declared as
+C<build_requires> are treated alike. By setting to C<ask/yes> or
+C<ask/no>, CPAN.pm asks the user and sets the default accordingly.
- perl -MCPAN -e shell;
+=head2 Configuration for individual distributions (I<Distroprefs>)
-Batch mode:
+(B<Note:> This feature has been introduced in CPAN.pm 1.8854 and is
+still considered beta quality)
- use CPAN;
+Distributions on CPAN usually behave according to what we call the
+CPAN mantra. Or since the event of Module::Build, we should talk about
+two mantras:
- # Modules:
+ perl Makefile.PL perl Build.PL
+ make ./Build
+ make test ./Build test
+ make install ./Build install
- cpan> install Acme::Meta # in the shell
+But some modules cannot be built with this mantra. They try to get
+some extra data from the user via the environment, extra arguments, or
+interactively--thus disturbing the installation of large bundles like
+Phalanx100 or modules with many dependencies like Plagger.
- CPAN::Shell->install("Acme::Meta"); # in perl
+The distroprefs system of C<CPAN.pm> addresses this problem by
+allowing the user to specify extra informations and recipes in YAML
+files to either
- # Distributions:
+=over
- cpan> install NWCLARK/Acme-Meta-0.02.tar.gz # in the shell
+=item
- CPAN::Shell->
- install("NWCLARK/Acme-Meta-0.02.tar.gz"); # in perl
+pass additional arguments to one of the four commands,
- # module objects:
+=item
- $mo = CPAN::Shell->expandany($mod);
- $mo = CPAN::Shell->expand("Module",$mod); # same thing
+set environment variables
- # distribution objects:
+=item
- $do = CPAN::Shell->expand("Module",$mod)->distribution;
- $do = CPAN::Shell->expandany($distro); # same thing
- $do = CPAN::Shell->expand("Distribution",
- $distro); # same thing
+instantiate an Expect object that reads from the console, waits for
+some regular expressions and enters some answers
-=head1 DESCRIPTION
+=item
-The CPAN module is designed to automate the make and install of perl
-modules and extensions. It includes some primitive searching
-capabilities and knows how to use Net::FTP or LWP (or some external
-download clients) to fetch the raw data from the net.
+temporarily override assorted C<CPAN.pm> configuration variables
-Distributions are fetched from one or more of the mirrored CPAN
-(Comprehensive Perl Archive Network) sites and unpacked in a dedicated
-directory.
+=item
-The CPAN module also supports the concept of named and versioned
-I<bundles> of modules. Bundles simplify the handling of sets of
-related modules. See Bundles below.
+specify dependencies the original maintainer forgot
-The package contains a session manager and a cache manager. The
-session manager keeps track of what has been fetched, built and
-installed in the current session. The cache manager keeps track of the
-disk space occupied by the make processes and deletes excess space
-according to a simple FIFO mechanism.
+=item
-All methods provided are accessible in a programmer style and in an
-interactive shell style.
+disable the installation of an object altogether
-=head2 CPAN::shell([$prompt, $command]) Starting Interactive Mode
+=back
-The interactive mode is entered by running
+See the YAML and Data::Dumper files that come with the C<CPAN.pm>
+distribution in the C<distroprefs/> directory for examples.
+
+=head2 Filenames
- perl -MCPAN -e shell
+The YAML files themselves must have the C<.yml> extension; all other
+files are ignored (for two exceptions see I<Fallback Data::Dumper and
+Storable> below). The containing directory can be specified in
+C<CPAN.pm> in the C<prefs_dir> config variable. Try C<o conf init
+prefs_dir> in the CPAN shell to set and activate the distroprefs
+system.
-which puts you into a readline interface. If Term::ReadKey and either
-Term::ReadLine::Perl or Term::ReadLine::Gnu are installed it supports
-both history and command completion.
+Every YAML file may contain arbitrary documents according to the YAML
+specification, and every document is treated as an entity that
+can specify the treatment of a single distribution.
+
+Filenames can be picked arbitrarily; C<CPAN.pm> always reads
+all files (in alphabetical order) and takes the key C<match> (see
+below in I<Language Specs>) as a hashref containing match criteria
+that determine if the current distribution matches the YAML document
+or not.
-Once you are on the command line, type 'h' to get a one page help
-screen and the rest should be self-explanatory.
+=head2 Fallback Data::Dumper and Storable
-The function call C<shell> takes two optional arguments, one is the
-prompt, the second is the default initial command line (the latter
-only works if a real ReadLine interface module is installed).
+If neither your configured C<yaml_module> nor YAML.pm is installed,
+CPAN.pm falls back to using Data::Dumper and Storable and looks for
+files with the extensions C<.dd> or C<.st> in the C<prefs_dir>
+directory. These files are expected to contain one or more hashrefs.
+For Data::Dumper generated files, this is expected to be done with by
+defining C<$VAR1>, C<$VAR2>, etc. The YAML shell would produce these
+with the command
-The most common uses of the interactive modes are
+ ysh < somefile.yml > somefile.dd
-=over 2
+For Storable files the rule is that they must be constructed such that
+C<Storable::retrieve(file)> returns an array reference and the array
+elements represent one distropref object each. The conversion from
+YAML would look like so:
-=item Searching for authors, bundles, distribution files and modules
+ perl -MYAML=LoadFile -MStorable=nstore -e '
+ @y=LoadFile(shift);
+ nstore(\@y, shift)' somefile.yml somefile.st
-There are corresponding one-letter commands C<a>, C<b>, C<d>, and C<m>
-for each of the four categories and another, C<i> for any of the
-mentioned four. Each of the four entities is implemented as a class
-with slightly differing methods for displaying an object.
+In bootstrapping situations it is usually sufficient to translate only
+a few YAML files to Data::Dumper for crucial modules like
+C<YAML::Syck>, C<YAML.pm> and C<Expect.pm>. If you prefer Storable
+over Data::Dumper, remember to pull out a Storable version that writes
+an older format than all the other Storable versions that will need to
+read them.
-Arguments you pass to these commands are either strings exactly matching
-the identification string of an object or regular expressions that are
-then matched case-insensitively against various attributes of the
-objects. The parser recognizes a regular expression only if you
-enclose it between two slashes.
+=head2 Blueprint
-The principle is that the number of found objects influences how an
-item is displayed. If the search finds one item, the result is
-displayed with the rather verbose method C<as_string>, but if we find
-more than one, we display each object with the terse method
-C<as_glimpse>.
+The following example contains all supported keywords and structures
+with the exception of C<eexpect> which can be used instead of
+C<expect>.
-=item get, make, test, install, clean modules or distributions
+ ---
+ comment: "Demo"
+ match:
+ module: "Dancing::Queen"
+ distribution: "^CHACHACHA/Dancing-"
+ not_distribution: "\.zip$"
+ perl: "/usr/local/cariba-perl/bin/perl"
+ perlconfig:
+ archname: "freebsd"
+ not_cc: "gcc"
+ env:
+ DANCING_FLOOR: "Shubiduh"
+ disabled: 1
+ cpanconfig:
+ make: gmake
+ pl:
+ args:
+ - "--somearg=specialcase"
-These commands take any number of arguments and investigate what is
-necessary to perform the action. If the argument is a distribution
-file name (recognized by embedded slashes), it is processed. If it is
-a module, CPAN determines the distribution file in which this module
-is included and processes that, following any dependencies named in
-the module's META.yml or Makefile.PL (this behavior is controlled by
-the configuration parameter C<prerequisites_policy>.)
+ env: {}
-C<get> downloads a distribution file and untars or unzips it, C<make>
-builds it, C<test> runs the test suite, and C<install> installs it.
+ expect:
+ - "Which is your favorite fruit"
+ - "apple\n"
-Any C<make> or C<test> are run unconditionally. An
+ make:
+ args:
+ - all
+ - extra-all
- install <distribution_file>
+ env: {}
-also is run unconditionally. But for
+ expect: []
- install <module>
+ commendline: "echo SKIPPING make"
-CPAN checks if an install is actually needed for it and prints
-I<module up to date> in the case that the distribution file containing
-the module doesn't need to be updated.
+ test:
+ args: []
-CPAN also keeps track of what it has done within the current session
-and doesn't try to build a package a second time regardless if it
-succeeded or not. It does not repeat a test run if the test
-has been run successfully before. Same for install runs.
+ env: {}
-The C<force> pragma may precede another command (currently: C<get>,
-C<make>, C<test>, or C<install>) and executes the command from scratch
-and tries to continue in case of some errors. See the section below on
-The C<force> and the C<fforce> pragma.
+ expect: []
-The C<notest> pragma may be used to skip the test part in the build
-process.
+ install:
+ args: []
-Example:
+ env:
+ WANT_TO_INSTALL: YES
- cpan> notest install Tk
+ expect:
+ - "Do you really want to install"
+ - "y\n"
-A C<clean> command results in a
+ patches:
+ - "ABCDE/Fedcba-3.14-ABCDE-01.patch"
- make clean
+ depends:
+ configure_requires:
+ LWP: 5.8
+ build_requires:
+ Test::Exception: 0.25
+ requires:
+ Spiffy: 0.30
-being executed within the distribution file's working directory.
-=item readme, perldoc, look module or distribution
+=head2 Language Specs
-C<readme> displays the README file of the associated distribution.
-C<Look> gets and untars (if not yet done) the distribution file,
-changes to the appropriate directory and opens a subshell process in
-that directory. C<perldoc> displays the pod documentation of the
-module in html or plain text format.
+Every YAML document represents a single hash reference. The valid keys
+in this hash are as follows:
-=item ls author
+=over
-=item ls globbing_expression
+=item comment [scalar]
-The first form lists all distribution files in and below an author's
-CPAN directory as they are stored in the CHECKUMS files distributed on
-CPAN. The listing goes recursive into all subdirectories.
+A comment
-The second form allows to limit or expand the output with shell
-globbing as in the following examples:
+=item cpanconfig [hash]
- ls JV/make*
- ls GSAR/*make*
- ls */*make*
+Temporarily override assorted C<CPAN.pm> configuration variables.
-The last example is very slow and outputs extra progress indicators
-that break the alignment of the result.
+Supported are: C<build_requires_install_policy>, C<check_sigs>,
+C<make>, C<make_install_make_command>, C<prefer_installer>,
+C<test_report>. Please report as a bug when you need another one
+supported.
-Note that globbing only lists directories explicitly asked for, for
-example FOO/* will not list FOO/bar/Acme-Sthg-n.nn.tar.gz. This may be
-regarded as a bug and may be changed in future versions.
+=item depends [hash] *** EXPERIMENTAL FEATURE ***
-=item failed
+All three types, namely C<configure_requires>, C<build_requires>, and
+C<requires> are supported in the way specified in the META.yml
+specification. The current implementation I<merges> the specified
+dependencies with those declared by the package maintainer. In a
+future implementation this may be changed to override the original
+declaration.
-The C<failed> command reports all distributions that failed on one of
-C<make>, C<test> or C<install> for some reason in the currently
-running shell session.
+=item disabled [boolean]
-=item Persistence between sessions
+Specifies that this distribution shall not be processed at all.
-If the C<YAML> or the c<YAML::Syck> module is installed a record of
-the internal state of all modules is written to disk after each step.
-The files contain a signature of the currently running perl version
-for later perusal.
+=item features [array] *** EXPERIMENTAL FEATURE ***
-If the configurations variable C<build_dir_reuse> is set to a true
-value, then CPAN.pm reads the collected YAML files. If the stored
-signature matches the currently running perl the stored state is
-loaded into memory such that effectively persistence between sessions
-is established.
+Experimental implementation to deal with optional_features from
+META.yml. Still needs coordination with installer software and
+currently works only for META.yml declaring C<dynamic_config=0>. Use
+with caution.
-=item The C<force> and the C<fforce> pragma
+=item goto [string]
-To speed things up in complex installation scenarios, CPAN.pm keeps
-track of what it has already done and refuses to do some things a
-second time. A C<get>, a C<make>, and an C<install> are not repeated.
-A C<test> is only repeated if the previous test was unsuccessful. The
-diagnostic message when CPAN.pm refuses to do something a second time
-is one of I<Has already been >C<unwrapped|made|tested successfully> or
-something similar. Another situation where CPAN refuses to act is an
-C<install> if the according C<test> was not successful.
+The canonical name of a delegate distribution to install
+instead. Useful when a new version, although it tests OK itself,
+breaks something else or a developer release or a fork is already
+uploaded that is better than the last released version.
-In all these cases, the user can override the goatish behaviour by
-prepending the command with the word force, for example:
+=item install [hash]
- cpan> force get Foo
- cpan> force make AUTHOR/Bar-3.14.tar.gz
- cpan> force test Baz
- cpan> force install Acme::Meta
+Processing instructions for the C<make install> or C<./Build install>
+phase of the CPAN mantra. See below under I<Processing Instructions>.
-Each I<forced> command is executed with the according part of its
-memory erased.
+=item make [hash]
-The C<fforce> pragma is a variant that emulates a C<force get> which
-erases the entire memory followed by the action specified, effectively
-restarting the whole get/make/test/install procedure from scratch.
+Processing instructions for the C<make> or C<./Build> phase of the
+CPAN mantra. See below under I<Processing Instructions>.
-=item Lockfile
+=item match [hash]
-Interactive sessions maintain a lockfile, per default C<~/.cpan/.lock>.
-Batch jobs can run without a lockfile and do not disturb each other.
+A hashref with one or more of the keys C<distribution>, C<modules>,
+C<perl>, C<perlconfig>, and C<env> that specify whether a document is
+targeted at a specific CPAN distribution or installation.
+Keys prefixed with C<not_> negates the corresponding match.
-The shell offers to run in I<degraded mode> when another process is
-holding the lockfile. This is an experimental feature that is not yet
-tested very well. This second shell then does not write the history
-file, does not use the metadata file and has a different prompt.
+The corresponding values are interpreted as regular expressions. The
+C<distribution> related one will be matched against the canonical
+distribution name, e.g. "AUTHOR/Foo-Bar-3.14.tar.gz".
-=item Signals
+The C<module> related one will be matched against I<all> modules
+contained in the distribution until one module matches.
-CPAN.pm installs signal handlers for SIGINT and SIGTERM. While you are
-in the cpan-shell it is intended that you can press C<^C> anytime and
-return to the cpan-shell prompt. A SIGTERM will cause the cpan-shell
-to clean up and leave the shell loop. You can emulate the effect of a
-SIGTERM by sending two consecutive SIGINTs, which usually means by
-pressing C<^C> twice.
+The C<perl> related one will be matched against C<$^X> (but with the
+absolute path).
-CPAN.pm ignores a SIGPIPE. If the user sets inactivity_timeout, a
-SIGALRM is used during the run of the C<perl Makefile.PL> or C<perl
-Build.PL> subprocess.
+The value associated with C<perlconfig> is itself a hashref that is
+matched against corresponding values in the C<%Config::Config> hash
+living in the C<Config.pm> module.
+Keys prefixed with C<not_> negates the corresponding match.
-=back
+The value associated with C<env> is itself a hashref that is
+matched against corresponding values in the C<%ENV> hash.
+Keys prefixed with C<not_> negates the corresponding match.
-=head2 CPAN::Shell
+If more than one restriction of C<module>, C<distribution>, etc. is
+specified, the results of the separately computed match values must
+all match. If so, the hashref represented by the
+YAML document is returned as the preference structure for the current
+distribution.
-The commands that are available in the shell interface are methods in
-the package CPAN::Shell. If you enter the shell command, all your
-input is split by the Text::ParseWords::shellwords() routine which
-acts like most shells do. The first word is being interpreted as the
-method to be called and the rest of the words are treated as arguments
-to this method. Continuation lines are supported if a line ends with a
-literal backslash.
+=item patches [array]
-=head2 autobundle
+An array of patches on CPAN or on the local disk to be applied in
+order via an external patch program. If the value for the C<-p>
+parameter is C<0> or C<1> is determined by reading the patch
+beforehand. The path to each patch is either an absolute path on the
+local filesystem or relative to a patch directory specified in the
+C<patches_dir> configuration variable or in the format of a canonical
+distroname. For examples please consult the distroprefs/ directory in
+the CPAN.pm distribution (these examples are not installed by
+default).
-C<autobundle> writes a bundle file into the
-C<$CPAN::Config-E<gt>{cpan_home}/Bundle> directory. The file contains
-a list of all modules that are both available from CPAN and currently
-installed within @INC. The name of the bundle file is based on the
-current date and a counter.
+Note: if the C<applypatch> program is installed and C<CPAN::Config>
+knows about it B<and> a patch is written by the C<makepatch> program,
+then C<CPAN.pm> lets C<applypatch> apply the patch. Both C<makepatch>
+and C<applypatch> are available from CPAN in the C<JV/makepatch-*>
+distribution.
-=head2 hosts
+=item pl [hash]
-This commands provides a statistical overview over recent download
-activities. The data for this is collected in the YAML file
-C<FTPstats.yml> in your C<cpan_home> directory. If no YAML module is
-configured or YAML not installed, then no stats are provided.
+Processing instructions for the C<perl Makefile.PL> or C<perl
+Build.PL> phase of the CPAN mantra. See below under I<Processing
+Instructions>.
-=head2 mkmyconfig
+=item test [hash]
-mkmyconfig() writes your own CPAN::MyConfig file into your ~/.cpan/
-directory so that you can save your own preferences instead of the
-system wide ones.
+Processing instructions for the C<make test> or C<./Build test> phase
+of the CPAN mantra. See below under I<Processing Instructions>.
-=head2 recompile
+=back
-recompile() is a very special command in that it takes no argument and
-runs the make/test/install cycle with brute force over all installed
-dynamically loadable extensions (aka XS modules) with 'force' in
-effect. The primary purpose of this command is to finish a network
-installation. Imagine, you have a common source tree for two different
-architectures. You decide to do a completely independent fresh
-installation. You start on one architecture with the help of a Bundle
-file produced earlier. CPAN installs the whole Bundle for you, but
-when you try to repeat the job on the second architecture, CPAN
-responds with a C<"Foo up to date"> message for all modules. So you
-invoke CPAN's recompile on the second architecture and you're done.
+=head2 Processing Instructions
-Another popular use for C<recompile> is to act as a rescue in case your
-perl breaks binary compatibility. If one of the modules that CPAN uses
-is in turn depending on binary compatibility (so you cannot run CPAN
-commands), then you should try the CPAN::Nox module for recovery.
+=over
-=head2 report Bundle|Distribution|Module
+=item args [array]
-The C<report> command temporarily turns on the C<test_report> config
-variable, then runs the C<force test> command with the given
-arguments. The C<force> pragma is used to re-run the tests and repeat
-every step that might have failed before.
+Arguments to be added to the command line
-=head2 upgrade [Module|/Regex/]...
+=item commandline
-The C<upgrade> command first runs an C<r> command with the given
-arguments and then installs the newest versions of all modules that
-were listed by that.
+A full commandline to run via C<system()>.
+During execution, the environment variable PERL is set
+to $^X (but with an absolute path). If C<commandline> is specified,
+C<args> is not used.
-=head2 The four C<CPAN::*> Classes: Author, Bundle, Module, Distribution
+=item eexpect [hash]
-Although it may be considered internal, the class hierarchy does matter
-for both users and programmer. CPAN.pm deals with above mentioned four
-classes, and all those classes share a set of methods. A classical
-single polymorphism is in effect. A metaclass object registers all
-objects of all kinds and indexes them with a string. The strings
-referencing objects have a separated namespace (well, not completely
-separated):
+Extended C<expect>. This is a hash reference with four allowed keys,
+C<mode>, C<timeout>, C<reuse>, and C<talk>.
- Namespace Class
+C<mode> may have the values C<deterministic> for the case where all
+questions come in the order written down and C<anyorder> for the case
+where the questions may come in any order. The default mode is
+C<deterministic>.
- words containing a "/" (slash) Distribution
- words starting with Bundle:: Bundle
- everything else Module or Author
+C<timeout> denotes a timeout in seconds. Floating-point timeouts are
+OK. With C<mode=deterministic>, the timeout denotes the
+timeout per question; with C<mode=anyorder> it denotes the
+timeout per byte received from the stream or questions.
-Modules know their associated Distribution objects. They always refer
-to the most recent official release. Developers may mark their releases
-as unstable development versions (by inserting an underbar into the
-module version number which will also be reflected in the distribution
-name when you run 'make dist'), so the really hottest and newest
-distribution is not always the default. If a module Foo circulates
-on CPAN in both version 1.23 and 1.23_90, CPAN.pm offers a convenient
-way to install version 1.23 by saying
+C<talk> is a reference to an array that contains alternating questions
+and answers. Questions are regular expressions and answers are literal
+strings. The Expect module watches the stream from the
+execution of the external program (C<perl Makefile.PL>, C<perl
+Build.PL>, C<make>, etc.).
- install Foo
+For C<mode=deterministic>, the CPAN.pm injects the
+corresponding answer as soon as the stream matches the regular expression.
-This would install the complete distribution file (say
-BAR/Foo-1.23.tar.gz) with all accompanying material. But if you would
-like to install version 1.23_90, you need to know where the
-distribution file resides on CPAN relative to the authors/id/
-directory. If the author is BAR, this might be BAR/Foo-1.23_90.tar.gz;
-so you would have to say
+For C<mode=anyorder> CPAN.pm answers a question as soon
+as the timeout is reached for the next byte in the input stream. In
+this mode you can use the C<reuse> parameter to decide what will
+happen with a question-answer pair after it has been used. In the
+default case (reuse=0) it is removed from the array, avoiding being
+used again accidentally. If you want to answer the
+question C<Do you really want to do that> several times, then it must
+be included in the array at least as often as you want this answer to
+be given. Setting the parameter C<reuse> to 1 makes this repetition
+unnecessary.
+
+=item env [hash]
- install BAR/Foo-1.23_90.tar.gz
+Environment variables to be set during the command
-The first example will be driven by an object of the class
-CPAN::Module, the second by an object of class CPAN::Distribution.
+=item expect [array]
-=head2 Integrating local directories
+C<< expect: <array> >> is a short notation for
-Distribution objects are normally distributions from the CPAN, but
-there is a slightly degenerate case for Distribution objects, too, of
-projects held on the local disk. These distribution objects have the
-same name as the local directory and end with a dot. A dot by itself
-is also allowed for the current directory at the time CPAN.pm was
-used. All actions such as C<make>, C<test>, and C<install> are applied
-directly to that directory. This gives the command C<cpan .> an
-interesting touch: while the normal mantra of installing a CPAN module
-without CPAN.pm is one of
+eexpect:
+ mode: deterministic
+ timeout: 15
+ talk: <array>
- perl Makefile.PL perl Build.PL
- ( go and get prerequisites )
- make ./Build
- make test ./Build test
- make install ./Build install
+=back
-the command C<cpan .> does all of this at once. It figures out which
-of the two mantras is appropriate, fetches and installs all
-prerequisites, cares for them recursively and finally finishes the
-installation of the module in the current directory, be it a CPAN
-module or not.
+=head2 Schema verification with C<Kwalify>
-The typical usage case is for private modules or working copies of
-projects from remote repositories on the local disk.
+If you have the C<Kwalify> module installed (which is part of the
+Bundle::CPANxxl), then all your distroprefs files are checked for
+syntactic correctness.
+
+=head2 Example Distroprefs Files
+
+C<CPAN.pm> comes with a collection of example YAML files. Note that these
+are really just examples and should not be used without care because
+they cannot fit everybody's purpose. After all, the authors of the
+packages that ask questions had a need to ask, so you should watch
+their questions and adjust the examples to your environment and your
+needs. You have been warned:-)
=head1 PROGRAMMER'S INTERFACE
-If you do not enter the shell, the available shell commands are both
-available as methods (C<CPAN::Shell-E<gt>install(...)>) and as
+If you do not enter the shell, shell commands are
+available both as methods (C<CPAN::Shell-E<gt>install(...)>) and as
functions in the calling package (C<install(...)>). Before calling low-level
-commands it makes sense to initialize components of CPAN you need, e.g.:
+commands, it makes sense to initialize components of CPAN you need, e.g.:
CPAN::HandleConfig->load;
CPAN::Shell::setup_output;
be expanded to the corresponding real objects with the
C<CPAN::Shell-E<gt>expand("Module",@things)> method. Expand returns a
list of CPAN::Module objects according to the C<@things> arguments
-given. In scalar context it only returns the first element of the
+given. In scalar context, it returns only the first element of the
list.
=item expandany(@things)
Like expand, but returns objects of the appropriate type, i.e.
-CPAN::Bundle objects for bundles, CPAN::Module objects for modules and
+CPAN::Bundle objects for bundles, CPAN::Module objects for modules, and
CPAN::Distribution objects for distributions. Note: it does not expand
to CPAN::Author objects.
perl -MCPAN -e 'CPAN::Shell->install(CPAN::Shell->r)'
# install my favorite programs if necessary:
- for $mod (qw(Net::FTP Digest::SHA Data::Dumper)){
+ for $mod (qw(Net::FTP Digest::SHA Data::Dumper)) {
CPAN::Shell->install($mod);
}
# list all modules on my disk that have no VERSION number
- for $mod (CPAN::Shell->expand("Module","/./")){
- next unless $mod->inst_file;
+ for $mod (CPAN::Shell->expand("Module","/./")) {
+ next unless $mod->inst_file;
# MakeMaker convention for undefined $VERSION:
- next unless $mod->inst_version eq "undef";
- print "No VERSION in ", $mod->id, "\n";
+ next unless $mod->inst_version eq "undef";
+ print "No VERSION in ", $mod->id, "\n";
}
# find out which distribution on CPAN contains a module:
print CPAN::Shell->expand("Module","Apache::Constants")->cpan_file
-Or if you want to write a cronjob to watch The CPAN, you could list
+Or if you want to schedule a I<cron> job to watch CPAN, you could list
all modules that need updating. First a quick and dirty way:
perl -e 'use CPAN; CPAN::Shell->r;'
-If you don't want to get any output in the case that all modules are
-up to date, you can parse the output of above command for the regular
-expression //modules are up to date// and decide to mail the output
-only if it doesn't match. Ick?
+If you don't want any output should all modules be
+up to date, parse the output of above command for the regular
+expression C</modules are up to date/> and decide to mail the output
+only if it doesn't match.
-If you prefer to do it more in a programmer style in one single
-process, maybe something like this suits you better:
+If you prefer to do it more in a programmerish style in one single
+process, something like this may better suit you:
# list all modules on my disk that have newer versions on CPAN
- for $mod (CPAN::Shell->expand("Module","/./")){
+ for $mod (CPAN::Shell->expand("Module","/./")) {
next unless $mod->inst_file;
next if $mod->uptodate;
printf "Module %s is installed as %s, could be updated to %s from CPAN\n",
$mod->id, $mod->inst_version, $mod->cpan_version;
}
-If that gives you too much output every day, you maybe only want to
-watch for three modules. You can write
+If that gives too much output every day, you may want to
+watch only for three modules. You can write
- for $mod (CPAN::Shell->expand("Module","/Apache|LWP|CGI/")){
+ for $mod (CPAN::Shell->expand("Module","/Apache|LWP|CGI/")) {
as the first line instead. Or you can combine some of the above
tricks:
Returns the CPAN::Author object of the maintainer who uploaded this
distribution
+=item CPAN::Distribution::pretty_id()
+
+Returns a string of the form "AUTHORID/TARBALL", where AUTHORID is the
+author's PAUSE ID and TARBALL is the distribution filename.
+
+=item CPAN::Distribution::base_id()
+
+Returns the distribution filename without any archive suffix. E.g
+"Foo-Bar-0.01"
+
=item CPAN::Distribution::clean()
Changes to the directory where the distribution has been unpacked and
=item CPAN::Distribution::containsmods()
Returns a list of IDs of modules contained in a distribution file.
-Only works for distributions listed in the 02packages.details.txt.gz
-file. This typically means that only the most recent version of a
+Works only for distributions listed in the 02packages.details.txt.gz
+file. This typically means that just most recent version of a
distribution is covered.
=item CPAN::Distribution::cvs_import()
Changes to the directory where the distribution has been unpacked and
runs the external command C<make install> there. If C<make> has not
-yet been run, it will be run first. A C<make test> will be issued in
-any case and if this fails, the install will be canceled. The
+yet been run, it will be run first. A C<make test> is issued in
+any case and if this fails, the install is cancelled. The
cancellation can be avoided by letting C<force> run the C<install> for
you.
-This install method has only the power to install the distribution if
-there are no dependencies in the way. To install an object and all of
+This install method only has the power to install the distribution if
+there are no dependencies in the way. To install an object along with all
its dependencies, use CPAN::Shell->install.
Note that install() gives no meaningful return value. See uptodate().
+=item CPAN::Distribution::install_tested()
+
+Install all distributions that have tested sucessfully but
+not yet installed. See also C<is_tested>.
+
=item CPAN::Distribution::isa_perl()
Returns 1 if this distribution file seems to be a perl distribution.
=item CPAN::Distribution::perldoc()
Downloads the pod documentation of the file associated with a
-distribution (in html format) and runs it through the external
-command lynx specified in C<$CPAN::Config->{lynx}>. If lynx
-isn't available, it converts it to plain text with external
-command html2text and runs it through the pager specified
+distribution (in HTML format) and runs it through the external
+command I<lynx> specified in C<$CPAN::Config->{lynx}>. If I<lynx>
+isn't available, it converts it to plain text with the external
+command I<html2text> and runs it through the pager specified
in C<$CPAN::Config->{pager}>
=item CPAN::Distribution::prefs()
Returns the hash reference from the first matching YAML file that the
user has deposited in the C<prefs_dir/> directory. The first
succeeding match wins. The files in the C<prefs_dir/> are processed
-alphabetically and the canonical distroname (e.g.
+alphabetically, and the canonical distroname (e.g.
AUTHOR/Foo-Bar-3.14.tar.gz) is matched against the regular expressions
stored in the $root->{match}{distribution} attribute value.
Additionally all module names contained in a distribution are matched
-agains the regular expressions in the $root->{match}{module} attribute
+against the regular expressions in the $root->{match}{module} attribute
value. The two match values are ANDed together. Each of the two
attributes are optional.
=item CPAN::Distribution::prereq_pm()
Returns the hash reference that has been announced by a distribution
-as the merge of the C<requires> element and the C<build_requires>
-element of the META.yml or the C<PREREQ_PM> hash in the
-C<Makefile.PL>. Note: works only after an attempt has been made to
-C<make> the distribution. Returns undef otherwise.
+as the C<requires> and C<build_requires> elements. These can be
+declared either by the C<META.yml> (if authoritative) or can be
+deposited after the run of C<Build.PL> in the file C<./_build/prereqs>
+or after the run of C<Makfile.PL> written as the C<PREREQ_PM> hash in
+a comment in the produced C<Makefile>. I<Note>: this method only works
+after an attempt has been made to C<make> the distribution. Returns
+undef otherwise.
=item CPAN::Distribution::readme()
Downloads the README file associated with a distribution and runs it
through the pager specified in C<$CPAN::Config->{pager}>.
+=item CPAN::Distribution::reports()
+
+Downloads report data for this distribution from www.cpantesters.org
+and displays a subset of them.
+
=item CPAN::Distribution::read_yaml()
Returns the content of the META.yml of this distro as a hashref. Note:
works only after an attempt has been made to C<make> the distribution.
Returns undef otherwise. Also returns undef if the content of META.yml
-is dynamic.
+is not authoritative. (The rules about what exactly makes the content
+authoritative are still in flux.)
=item CPAN::Distribution::test()
"GNU Library General Public License")
b - BSD: The BSD License
a - Artistic license alone
+ 2 - Artistic license 2.0 or later
o - open source: appoved by www.opensource.org
d - allows distribution without restrictions
r - restricted distribtion
=item CPAN::Module::force($method,@args)
-Forces CPAN to perform a task that it normally would have refused to
-do. Force takes as arguments a method name to be called and any number
-of additional arguments that should be passed to the called method.
+Forces CPAN to perform a task it would normally refuse to
+do. Force takes as arguments a method name to be invoked and any number
+of additional arguments to pass that method.
The internals of the object get the needed changes so that CPAN.pm
does not refuse to take the action. See also the section above on the
C<force> and the C<fforce> pragma.
=item CPAN::Module::inst_file()
Returns the filename of the module found in @INC. The first file found
-is reported just like perl itself stops searching @INC when it finds a
+is reported, just as perl itself stops searching @INC once it finds a
module.
=item CPAN::Module::available_file()
=item CPAN::Module::manpage_headline()
If module is installed, peeks into the module's manpage, reads the
-headline and returns it. Moreover, if the module has been downloaded
+headline, and returns it. Moreover, if the module has been downloaded
within this session, does the equivalent on the downloaded module even
-if it is not installed.
+if it hasn't been installed yet.
=item CPAN::Module::perldoc()
Runs a C<readme> on the distribution associated with this module.
+=item CPAN::Module::reports()
+
+Calls the reports() method on the associated distribution object.
+
=item CPAN::Module::test()
Runs a C<test> on the distribution associated with this module.
use these directories for building modules on different architectures.
There is another directory ($CPAN::Config->{keep_source_where}) where
-the original distribution files are kept. This directory is not
-covered by the cache manager and must be controlled by the user. If
-you choose to have the same directory as build_dir and as
-keep_source_where directory, then your sources will be deleted with
-the same fifo mechanism.
-
-=head2 Bundles
-
-A bundle is just a perl module in the namespace Bundle:: that does not
-define any functions or methods. It usually only contains documentation.
-
-It starts like a perl module with a package declaration and a $VERSION
-variable. After that the pod section looks like any other pod with the
-only difference being that I<one special pod section> exists starting with
-(verbatim):
-
- =head1 CONTENTS
-
-In this pod section each line obeys the format
-
- Module_Name [Version_String] [- optional text]
-
-The only required part is the first field, the name of a module
-(e.g. Foo::Bar, ie. I<not> the name of the distribution file). The rest
-of the line is optional. The comment part is delimited by a dash just
-as in the man page header.
-
-The distribution of a bundle should follow the same convention as
-other distributions.
-
-Bundles are treated specially in the CPAN package. If you say 'install
-Bundle::Tkkit' (assuming such a bundle exists), CPAN will install all
-the modules in the CONTENTS section of the pod. You can install your
-own Bundles locally by placing a conformant Bundle file somewhere into
-your @INC path. The autobundle() command which is available in the
-shell interface does that for you by including all currently installed
-modules in a snapshot bundle file.
-
-=head1 PREREQUISITES
-
-If you have a local mirror of CPAN and can access all files with
-"file:" URLs, then you only need a perl better than perl5.003 to run
-this module. Otherwise Net::FTP is strongly recommended. LWP may be
-required for non-UNIX systems or if your nearest CPAN site is
-associated with a URL that is not C<ftp:>.
-
-If you have neither Net::FTP nor LWP, there is a fallback mechanism
-implemented for an external ftp command or for an external lynx
-command.
-
-=head1 UTILITIES
-
-=head2 Finding packages and VERSION
-
-This module presumes that all packages on CPAN
-
-=over 2
-
-=item *
-
-declare their $VERSION variable in an easy to parse manner. This
-prerequisite can hardly be relaxed because it consumes far too much
-memory to load all packages into the running program just to determine
-the $VERSION variable. Currently all programs that are dealing with
-version use something like this
-
- perl -MExtUtils::MakeMaker -le \
- 'print MM->parse_version(shift)' filename
-
-If you are author of a package and wonder if your $VERSION can be
-parsed, please try the above method.
-
-=item *
-
-come as compressed or gzipped tarfiles or as zip files and contain a
-C<Makefile.PL> or C<Build.PL> (well, we try to handle a bit more, but
-without much enthusiasm).
-
-=back
-
-=head2 Debugging
-
-The debugging of this module is a bit complex, because we have
-interferences of the software producing the indices on CPAN, of the
-mirroring process on CPAN, of packaging, of configuration, of
-synchronicity, and of bugs within CPAN.pm.
-
-For debugging the code of CPAN.pm itself in interactive mode some more
-or less useful debugging aid can be turned on for most packages within
-CPAN.pm with one of
-
-=over 2
-
-=item o debug package...
-
-sets debug mode for packages.
-
-=item o debug -package...
-
-unsets debug mode for packages.
-
-=item o debug all
-
-turns debugging on for all packages.
-
-=item o debug number
-
-=back
-
-which sets the debugging packages directly. Note that C<o debug 0>
-turns debugging off.
-
-What seems quite a successful strategy is the combination of C<reload
-cpan> and the debugging switches. Add a new debug statement while
-running in the shell and then issue a C<reload cpan> and see the new
-debugging messages immediately without losing the current context.
-
-C<o debug> without an argument lists the valid package names and the
-current set of packages in debugging mode. C<o debug> has built-in
-completion support.
-
-For debugging of CPAN data there is the C<dump> command which takes
-the same arguments as make/test/install and outputs each object's
-Data::Dumper dump. If an argument looks like a perl variable and
-contains one of C<$>, C<@> or C<%>, it is eval()ed and fed to
-Data::Dumper directly.
-
-=head2 Floppy, Zip, Offline Mode
-
-CPAN.pm works nicely without network too. If you maintain machines
-that are not networked at all, you should consider working with file:
-URLs. Of course, you have to collect your modules somewhere first. So
-you might use CPAN.pm to put together all you need on a networked
-machine. Then copy the $CPAN::Config->{keep_source_where} (but not
-$CPAN::Config->{build_dir}) directory on a floppy. This floppy is kind
-of a personal CPAN. CPAN.pm on the non-networked machines works nicely
-with this floppy. See also below the paragraph about CD-ROM support.
-
-=head2 Basic Utilities for Programmers
-
-=over 2
-
-=item has_inst($module)
-
-Returns true if the module is installed. Used to load all modules into
-the running CPAN.pm which are considered optional. The config variable
-C<dontload_list> can be used to intercept the C<has_inst()> call such
-that an optional module is not loaded despite being available. For
-example the following command will prevent that C<YAML.pm> is being
-loaded:
-
- cpan> o conf dontload_list push YAML
-
-See the source for details.
-
-=item has_usable($module)
-
-Returns true if the module is installed and is in a usable state. Only
-useful for a handful of modules that are used internally. See the
-source for details.
-
-=item instance($module)
-
-The constructor for all the singletons used to represent modules,
-distributions, authors and bundles. If the object already exists, this
-method returns the object, otherwise it calls the constructor.
-
-=back
-
-=head1 CONFIGURATION
-
-When the CPAN module is used for the first time, a configuration
-dialog tries to determine a couple of site specific options. The
-result of the dialog is stored in a hash reference C< $CPAN::Config >
-in a file CPAN/Config.pm.
-
-The default values defined in the CPAN/Config.pm file can be
-overridden in a user specific file: CPAN/MyConfig.pm. Such a file is
-best placed in $HOME/.cpan/CPAN/MyConfig.pm, because $HOME/.cpan is
-added to the search path of the CPAN module before the use() or
-require() statements. The mkmyconfig command writes this file for you.
-
-The C<o conf> command has various bells and whistles:
-
-=over
-
-=item completion support
-
-If you have a ReadLine module installed, you can hit TAB at any point
-of the commandline and C<o conf> will offer you completion for the
-built-in subcommands and/or config variable names.
-
-=item displaying some help: o conf help
-
-Displays a short help
-
-=item displaying current values: o conf [KEY]
-
-Displays the current value(s) for this config variable. Without KEY
-displays all subcommands and config variables.
-
-Example:
-
- o conf shell
-
-=item changing of scalar values: o conf KEY VALUE
-
-Sets the config variable KEY to VALUE. The empty string can be
-specified as usual in shells, with C<''> or C<"">
-
-Example:
-
- o conf wget /usr/bin/wget
-
-=item changing of list values: o conf KEY SHIFT|UNSHIFT|PUSH|POP|SPLICE|LIST
-
-If a config variable name ends with C<list>, it is a list. C<o conf
-KEY shift> removes the first element of the list, C<o conf KEY pop>
-removes the last element of the list. C<o conf KEYS unshift LIST>
-prepends a list of values to the list, C<o conf KEYS push LIST>
-appends a list of valued to the list.
-
-Likewise, C<o conf KEY splice LIST> passes the LIST to the according
-splice command.
-
-Finally, any other list of arguments is taken as a new list value for
-the KEY variable discarding the previous value.
-
-Examples:
-
- o conf urllist unshift http://cpan.dev.local/CPAN
- o conf urllist splice 3 1
- o conf urllist http://cpan1.local http://cpan2.local ftp://ftp.perl.org
-
-=item interactive editing: o conf init [MATCH|LIST]
-
-Runs an interactive configuration dialog for matching variables.
-Without argument runs the dialog over all supported config variables.
-To specify a MATCH the argument must be enclosed by slashes.
-
-Examples:
+the original distribution files are kept. This directory is not
+covered by the cache manager and must be controlled by the user. If
+you choose to have the same directory as build_dir and as
+keep_source_where directory, then your sources will be deleted with
+the same fifo mechanism.
- o conf init ftp_passive ftp_proxy
- o conf init /color/
+=head2 Bundles
-=item reverting to saved: o conf defaults
+A bundle is just a perl module in the namespace Bundle:: that does not
+define any functions or methods. It usually only contains documentation.
-Reverts all config variables to the state in the saved config file.
+It starts like a perl module with a package declaration and a $VERSION
+variable. After that the pod section looks like any other pod with the
+only difference being that I<one special pod section> exists starting with
+(verbatim):
-=item saving the config: o conf commit
+ =head1 CONTENTS
-Saves all config variables to the current config file (CPAN/Config.pm
-or CPAN/MyConfig.pm that was loaded at start).
+In this pod section each line obeys the format
-=back
+ Module_Name [Version_String] [- optional text]
-The configuration dialog can be started any time later again by
-issuing the command C< o conf init > in the CPAN shell. A subset of
-the configuration dialog can be run by issuing C<o conf init WORD>
-where WORD is any valid config variable or a regular expression.
+The only required part is the first field, the name of a module
+(e.g. Foo::Bar, ie. I<not> the name of the distribution file). The rest
+of the line is optional. The comment part is delimited by a dash just
+as in the man page header.
-=head2 Config Variables
+The distribution of a bundle should follow the same convention as
+other distributions.
-Currently the following keys in the hash reference $CPAN::Config are
-defined:
+Bundles are treated specially in the CPAN package. If you say 'install
+Bundle::Tkkit' (assuming such a bundle exists), CPAN will install all
+the modules in the CONTENTS section of the pod. You can install your
+own Bundles locally by placing a conformant Bundle file somewhere into
+your @INC path. The autobundle() command which is available in the
+shell interface does that for you by including all currently installed
+modules in a snapshot bundle file.
- applypatch path to external prg
- auto_commit commit all changes to config variables to disk
- build_cache size of cache for directories to build modules
- build_dir locally accessible directory to build modules
- build_dir_reuse boolean if distros in build_dir are persistent
- build_requires_install_policy
- to install or not to install: when a module is
- only needed for building. yes|no|ask/yes|ask/no
- bzip2 path to external prg
- cache_metadata use serializer to cache metadata
- commands_quote prefered character to use for quoting external
- commands when running them. Defaults to double
- quote on Windows, single tick everywhere else;
- can be set to space to disable quoting
- check_sigs if signatures should be verified
- colorize_debug Term::ANSIColor attributes for debugging output
- colorize_output boolean if Term::ANSIColor should colorize output
- colorize_print Term::ANSIColor attributes for normal output
- colorize_warn Term::ANSIColor attributes for warnings
- commandnumber_in_prompt
- boolean if you want to see current command number
- cpan_home local directory reserved for this package
- curl path to external prg
- dontload_hash DEPRECATED
- dontload_list arrayref: modules in the list will not be
- loaded by the CPAN::has_inst() routine
- ftp path to external prg
- ftp_passive if set, the envariable FTP_PASSIVE is set for downloads
- ftp_proxy proxy host for ftp requests
- getcwd see below
- gpg path to external prg
- gzip location of external program gzip
- histfile file to maintain history between sessions
- histsize maximum number of lines to keep in histfile
- http_proxy proxy host for http requests
- inactivity_timeout breaks interactive Makefile.PLs or Build.PLs
- after this many seconds inactivity. Set to 0 to
- never break.
- index_expire after this many days refetch index files
- inhibit_startup_message
- if true, does not print the startup message
- keep_source_where directory in which to keep the source (if we do)
- lynx path to external prg
- make location of external make program
- make_arg arguments that should always be passed to 'make'
- make_install_make_command
- the make command for running 'make install', for
- example 'sudo make'
- make_install_arg same as make_arg for 'make install'
- makepl_arg arguments passed to 'perl Makefile.PL'
- mbuild_arg arguments passed to './Build'
- mbuild_install_arg arguments passed to './Build install'
- mbuild_install_build_command
- command to use instead of './Build' when we are
- in the install stage, for example 'sudo ./Build'
- mbuildpl_arg arguments passed to 'perl Build.PL'
- ncftp path to external prg
- ncftpget path to external prg
- no_proxy don't proxy to these hosts/domains (comma separated list)
- pager location of external program more (or any pager)
- password your password if you CPAN server wants one
- patch path to external prg
- prefer_installer legal values are MB and EUMM: if a module comes
- with both a Makefile.PL and a Build.PL, use the
- former (EUMM) or the latter (MB); if the module
- comes with only one of the two, that one will be
- used in any case
- prerequisites_policy
- what to do if you are missing module prerequisites
- ('follow' automatically, 'ask' me, or 'ignore')
- prefs_dir local directory to store per-distro build options
- proxy_user username for accessing an authenticating proxy
- proxy_pass password for accessing an authenticating proxy
- randomize_urllist add some randomness to the sequence of the urllist
- scan_cache controls scanning of cache ('atstart' or 'never')
- shell your favorite shell
- show_upload_date boolean if commands should try to determine upload date
- tar location of external program tar
- term_is_latin if true internal UTF-8 is translated to ISO-8859-1
- (and nonsense for characters outside latin range)
- term_ornaments boolean to turn ReadLine ornamenting on/off
- test_report email test reports (if CPAN::Reporter is installed)
- unzip location of external program unzip
- urllist arrayref to nearby CPAN sites (or equivalent locations)
- use_sqlite use CPAN::SQLite for metadata storage (fast and lean)
- username your username if you CPAN server wants one
- wait_list arrayref to a wait server to try (See CPAN::WAIT)
- wget path to external prg
- yaml_module which module to use to read/write YAML files
+=head1 PREREQUISITES
-You can set and query each of these options interactively in the cpan
-shell with the command set defined within the C<o conf> command:
+If you have a local mirror of CPAN and can access all files with
+"file:" URLs, then you only need a perl later than perl5.003 to run
+this module. Otherwise Net::FTP is strongly recommended. LWP may be
+required for non-UNIX systems, or if your nearest CPAN site is
+associated with a URL that is not C<ftp:>.
-=over 2
+If you have neither Net::FTP nor LWP, there is a fallback mechanism
+implemented for an external ftp command or for an external lynx
+command.
-=item C<o conf E<lt>scalar optionE<gt>>
+=head1 UTILITIES
-prints the current value of the I<scalar option>
+=head2 Finding packages and VERSION
-=item C<o conf E<lt>scalar optionE<gt> E<lt>valueE<gt>>
+This module presumes that all packages on CPAN
-Sets the value of the I<scalar option> to I<value>
+=over 2
-=item C<o conf E<lt>list optionE<gt>>
+=item *
-prints the current value of the I<list option> in MakeMaker's
-neatvalue format.
+declare their $VERSION variable in an easy to parse manner. This
+prerequisite can hardly be relaxed because it consumes far too much
+memory to load all packages into the running program just to determine
+the $VERSION variable. Currently all programs that are dealing with
+version use something like this
-=item C<o conf E<lt>list optionE<gt> [shift|pop]>
+ perl -MExtUtils::MakeMaker -le \
+ 'print MM->parse_version(shift)' filename
-shifts or pops the array in the I<list option> variable
+If you are author of a package and wonder if your $VERSION can be
+parsed, please try the above method.
-=item C<o conf E<lt>list optionE<gt> [unshift|push|splice] E<lt>listE<gt>>
+=item *
-works like the corresponding perl commands.
+come as compressed or gzipped tarfiles or as zip files and contain a
+C<Makefile.PL> or C<Build.PL> (well, we try to handle a bit more, but
+with little enthusiasm).
=back
-=head2 CPAN::anycwd($path): Note on config variable getcwd
+=head2 Debugging
-CPAN.pm changes the current working directory often and needs to
-determine its own current working directory. Per default it uses
-Cwd::cwd but if this doesn't work on your system for some reason,
-alternatives can be configured according to the following table:
+Debugging this module is more than a bit complex due to interference from
+the software producing the indices on CPAN, the mirroring process on CPAN,
+packaging, configuration, synchronicity, and even (gasp!) due to bugs
+within the CPAN.pm module itself.
-=over 2
+For debugging the code of CPAN.pm itself in interactive mode, some
+debugging aid can be turned on for most packages within
+CPAN.pm with one of
-=item cwd
+=over 2
-Calls Cwd::cwd
+=item o debug package...
-=item getcwd
+sets debug mode for packages.
-Calls Cwd::getcwd
+=item o debug -package...
-=item fastcwd
+unsets debug mode for packages.
-Calls Cwd::fastcwd
+=item o debug all
-=item backtickcwd
+turns debugging on for all packages.
-Calls the external command cwd.
+=item o debug number
=back
-=head2 Note on the format of the urllist parameter
+which sets the debugging packages directly. Note that C<o debug 0>
+turns debugging off.
-urllist parameters are URLs according to RFC 1738. We do a little
-guessing if your URL is not compliant, but if you have problems with
-C<file> URLs, please try the correct format. Either:
+What seems a successful strategy is the combination of C<reload
+cpan> and the debugging switches. Add a new debug statement while
+running in the shell and then issue a C<reload cpan> and see the new
+debugging messages immediately without losing the current context.
- file://localhost/whatever/ftp/pub/CPAN/
+C<o debug> without an argument lists the valid package names and the
+current set of packages in debugging mode. C<o debug> has built-in
+completion support.
-or
+For debugging of CPAN data there is the C<dump> command which takes
+the same arguments as make/test/install and outputs each object's
+Data::Dumper dump. If an argument looks like a perl variable and
+contains one of C<$>, C<@> or C<%>, it is eval()ed and fed to
+Data::Dumper directly.
- file:///home/ftp/pub/CPAN/
+=head2 Floppy, Zip, Offline Mode
-=head2 urllist parameter has CD-ROM support
+CPAN.pm works nicely without network access, too. If you maintain machines
+that are not networked at all, you should consider working with C<file:>
+URLs. You'll have to collect your modules somewhere first. So
+you might use CPAN.pm to put together all you need on a networked
+machine. Then copy the $CPAN::Config->{keep_source_where} (but not
+$CPAN::Config->{build_dir}) directory on a floppy. This floppy is kind
+of a personal CPAN. CPAN.pm on the non-networked machines works nicely
+with this floppy. See also below the paragraph about CD-ROM support.
-The C<urllist> parameter of the configuration table contains a list of
-URLs that are to be used for downloading. If the list contains any
-C<file> URLs, CPAN always tries to get files from there first. This
-feature is disabled for index files. So the recommendation for the
-owner of a CD-ROM with CPAN contents is: include your local, possibly
-outdated CD-ROM as a C<file> URL at the end of urllist, e.g.
+=head2 Basic Utilities for Programmers
- o conf urllist push file://localhost/CDROM/CPAN
+=over 2
-CPAN.pm will then fetch the index files from one of the CPAN sites
-that come at the beginning of urllist. It will later check for each
-module if there is a local copy of the most recent version.
+=item has_inst($module)
-Another peculiarity of urllist is that the site that we could
-successfully fetch the last file from automatically gets a preference
-token and is tried as the first site for the next request. So if you
-add a new site at runtime it may happen that the previously preferred
-site will be tried another time. This means that if you want to disallow
-a site for the next transfer, it must be explicitly removed from
-urllist.
+Returns true if the module is installed. Used to load all modules into
+the running CPAN.pm that are considered optional. The config variable
+C<dontload_list> intercepts the C<has_inst()> call such
+that an optional module is not loaded despite being available. For
+example, the following command will prevent C<YAML.pm> from being
+loaded:
-=head2 Maintaining the urllist parameter
+ cpan> o conf dontload_list push YAML
-If you have YAML.pm (or some other YAML module configured in
-C<yaml_module>) installed, CPAN.pm collects a few statistical data
-about recent downloads. You can view the statistics with the C<hosts>
-command or inspect them directly by looking into the C<FTPstats.yml>
-file in your C<cpan_home> directory.
+See the source for details.
-To get some interesting statistics it is recommended to set the
-C<randomize_urllist> parameter that introduces some amount of
-randomness into the URL selection.
+=item has_usable($module)
+
+Returns true if the module is installed and in a usable state. Only
+useful for a handful of modules that are used internally. See the
+source for details.
-=head2 prefs_dir for avoiding interactive questions (ALPHA)
+=item instance($module)
-(B<Note:> This feature has been introduced in CPAN.pm 1.8854 and is
-still considered experimental and may still be changed)
-
-The files in the directory specified in C<prefs_dir> are YAML files
-that specify how CPAN.pm shall treat distributions that deviate from
-the normal non-interactive model of building and installing CPAN
-modules.
-
-Some modules try to get some data from the user interactively thus
-disturbing the installation of large bundles like Phalanx100 or
-modules like Plagger.
-
-CPAN.pm can use YAML files to either pass additional arguments to one
-of the four commands, set environment variables or instantiate an
-Expect object that reads from the console and enters answers on your
-behalf (latter option requires Expect.pm installed). A further option
-is to apply patches from the local disk or from CPAN.
-
-CPAN.pm comes with a couple of such YAML files. The structure is
-currently not documented because in flux. Please see the distroprefs
-directory of the CPAN distribution for examples and follow the
-C<00.README> file in there.
-
-Please note that setting the environment variable PERL_MM_USE_DEFAULT
-to a true value can also get you a long way if you want to always pick
-the default answers. But this only works if the author of a package
-used the prompt function provided by ExtUtils::MakeMaker and if the
-defaults are OK for you.
+The constructor for all the singletons used to represent modules,
+distributions, authors, and bundles. If the object already exists, this
+method returns the object; otherwise, it calls the constructor.
+
+=back
=head1 SECURITY
=head2 Cryptographically signed modules
-Since release 1.77 CPAN.pm has been able to verify cryptographically
+Since release 1.77, CPAN.pm has been able to verify cryptographically
signed module distributions using Module::Signature. The CPAN modules
can be signed by their authors, thus giving more security. The simple
unsigned MD5 checksums that were used before by CPAN protect mainly
=head1 EXPORT
-Most functions in package CPAN are exported per default. The reason
+Most functions in package CPAN are exported by default. The reason
for this is that the primary use is intended for the cpan shell or for
one-liners.
=head1 ENVIRONMENT
When the CPAN shell enters a subshell via the look command, it sets
-the environment CPAN_SHELL_LEVEL to 1 or increments it if it is
+the environment CPAN_SHELL_LEVEL to 1, or increments that variable if it is
already set.
-When CPAN runs, it sets the environment variable PERL5_CPAN_IS_RUNNING.
+When CPAN runs, it sets the environment variable PERL5_CPAN_IS_RUNNING
+to the ID of the running process. It also sets
+PERL5_CPANPLUS_IS_RUNNING to prevent runaway processes which could
+happen with older versions of Module::Install.
+
+When running C<perl Makefile.PL>, the environment variable
+C<PERL5_CPAN_IS_EXECUTING> is set to the full path of the
+C<Makefile.PL> that is being executed. This prevents runaway processes
+with newer versions of Module::Install.
When the config variable ftp_passive is set, all downloads will be run
with the environment variable FTP_PASSIVE set to this value. This is
=head1 POPULATE AN INSTALLATION WITH LOTS OF MODULES
-Populating a freshly installed perl with my favorite modules is pretty
+Populating a freshly installed perl with one's favorite modules is pretty
easy if you maintain a private bundle definition file. To get a useful
blueprint of a bundle definition file, the command autobundle can be used
on the CPAN shell command line. This command writes a bundle definition
-file for all modules that are installed for the currently running perl
-interpreter. It's recommended to run this command only once and from then
+file for all modules installed for the current perl
+interpreter. It's recommended to run this command once only, and from then
on maintain the file manually under a private name, say
Bundle/my_bundle.pm. With a clever bundle file you can then simply say
cpan> install Bundle::my_bundle
-then answer a few questions and then go out for a coffee.
+then answer a few questions and go out for coffee (possibly
+even in a different city).
Maintaining a bundle definition file means keeping track of two
things: dependencies and interactivity. CPAN.pm sometimes fails on
calculating dependencies because not all modules define all MakeMaker
attributes correctly, so a bundle definition file should specify
-prerequisites as early as possible. On the other hand, it's a bit
-annoying that many distributions need some interactive configuring. So
-what I try to accomplish in my private bundle file is to have the
+prerequisites as early as possible. On the other hand, it's
+annoying that so many distributions need some interactive configuring. So
+what you can try to accomplish in your private bundle file is to have the
packages that need to be configured early in the file and the gentle
-ones later, so I can go out after a few minutes and leave CPAN.pm
-untended.
+ones later, so you can go out for cofeee after a few minutes and leave CPAN.pm
+to churn away untended.
=head1 WORKING WITH CPAN.pm BEHIND FIREWALLS
Thanks to Graham Barr for contributing the following paragraphs about
the interaction between perl, and various firewall configurations. For
further information on firewalls, it is recommended to consult the
-documentation that comes with the ncftp program. If you are unable to
-go through the firewall with a simple Perl setup, it is very likely
-that you can configure ncftp so that it works for your firewall.
+documentation that comes with the I<ncftp> program. If you are unable to
+go through the firewall with a simple Perl setup, it is likely
+that you can configure I<ncftp> so that it works through your firewall.
=head2 Three basic types of firewalls
=item http firewall
-This is where the firewall machine runs a web server and to access the
-outside world you must do it via the web server. If you set environment
-variables like http_proxy or ftp_proxy to a values beginning with http://
-or in your web browser you have to set proxy information then you know
-you are running an http firewall.
+This is when the firewall machine runs a web server, and to access the
+outside world, you must do so via that web server. If you set environment
+variables like http_proxy or ftp_proxy to values beginning with http://,
+or in your web browser you've proxy information set, then you know
+you are running behind an http firewall.
To access servers outside these types of firewalls with perl (even for
-ftp) you will need to use LWP.
+ftp), you need LWP.
=item ftp firewall
This where the firewall machine runs an ftp server. This kind of
firewall will only let you access ftp servers outside the firewall.
This is usually done by connecting to the firewall with ftp, then
-entering a username like "user@outside.host.com"
+entering a username like "user@outside.host.com".
-To access servers outside these type of firewalls with perl you
-will need to use Net::FTP.
+To access servers outside these type of firewalls with perl, you
+need Net::FTP.
-=item One way visibility
+=item One-way visibility
-I say one way visibility as these firewalls try to make themselves look
-invisible to the users inside the firewall. An FTP data connection is
-normally created by sending the remote server your IP address and then
-listening for the connection. But the remote server will not be able to
-connect to you because of the firewall. So for these types of firewall
+One-way visibility means these firewalls try to make themselves
+invisible to users inside the firewall. An FTP data connection is
+normally created by sending your IP address to the remote server and then
+listening for the return connection. But the remote server will not be able to
+connect to you because of the firewall. For these types of firewall,
FTP connections need to be done in a passive mode.
There are two that I can think off.
=item SOCKS
-If you are using a SOCKS firewall you will need to compile perl and link
-it with the SOCKS library, this is what is normally called a 'socksified'
+If you are using a SOCKS firewall, you will need to compile perl and link
+it with the SOCKS library. This is what is normally called a 'socksified'
perl. With this executable you will be able to connect to servers outside
-the firewall as if it is not there.
+the firewall as if it were not there.
=item IP Masquerade
-This is the firewall implemented in the Linux kernel, it allows you to
-hide a complete network behind one IP address. With this firewall no
-special compiling is needed as you can access hosts directly.
+This is when the firewall implemented in the kernel (via NAT, or networking
+address translation), it allows you to hide a complete network behind one
+IP address. With this firewall no special compiling is needed as you can
+access hosts directly.
For accessing ftp servers behind such firewalls you usually need to
set the environment variable C<FTP_PASSIVE> or the config variable
I installed a new version of module X but CPAN keeps saying,
I have the old version installed
-Most probably you B<do> have the old version installed. This can
+Probably you B<do> have the old version installed. This can
happen if a module installs itself into a different directory in the
@INC path than it was previously installed. This is not really a
CPAN.pm problem, you would have the same problem when installing the
o conf makepl_arg "LIB=~/myperl/lib \
INSTALLMAN1DIR=~/myperl/man/man1 \
- INSTALLMAN3DIR=~/myperl/man/man3"
+ INSTALLMAN3DIR=~/myperl/man/man3 \
+ INSTALLSCRIPT=~/myperl/bin \
+ INSTALLBIN=~/myperl/bin"
+
+and then (oh joy) the equivalent command for Module::Build. That would
+be
+
+ o conf mbuildpl_arg "--lib=~/myperl/lib \
+ --installman1dir=~/myperl/man/man1 \
+ --installman3dir=~/myperl/man/man3 \
+ --installscript=~/myperl/bin \
+ --installbin=~/myperl/bin"
You can make this setting permanent like all C<o conf> settings with
-C<o conf commit>.
+C<o conf commit> or by setting C<auto_commit> beforehand.
You will have to add ~/myperl/man to the MANPATH environment variable
and also tell your perl programs to look into ~/myperl/lib, e.g. by
equivalent to the concept of the home directory on Unix.
Another thing you should bear in mind is that the UNINST parameter can
-be dnagerous when you are installing into a private area because you
+be dangerous when you are installing into a private area because you
might accidentally remove modules that other people depend on that are
not using the private area.
depending item and thus your second try is able to resolve everything.
Please note, CPAN.pm does not know the dependency tree in advance and
cannot sort the queue of things to install in a topologically correct
-order. It resolves perfectly well IF all modules declare the
+order. It resolves perfectly well B<if> all modules declare the
prerequisites correctly with the PREREQ_PM attribute to MakeMaker or
the C<requires> stanza of Module::Build. For bundles which fail and
you need to install often, it is recommended to sort the Bundle
=item 8)
-In our intranet we have many modules for internal use. How
+In our intranet, we have many modules for internal use. How
can I integrate these modules with CPAN.pm but without uploading
the modules to CPAN?
=item 9)
When I run CPAN's shell, I get an error message about things in my
-/etc/inputrc (or ~/.inputrc) file.
+C</etc/inputrc> (or C<~/.inputrc>) file.
These are readline issues and can only be fixed by studying readline
configuration on your architecture and adjusting the referenced file
-accordingly. Please make a backup of the /etc/inputrc or ~/.inputrc
+accordingly. Please make a backup of the C</etc/inputrc> or C<~/.inputrc>
and edit them. Quite often harmless changes like uppercasing or
lowercasing some arguments solves the problem.
CPAN.pm at rt.cpan.org and describe your needs. Maybe we can extend
the support or maybe UTF-8 terminals become widely available.
+Note: this config variable is deprecated and will be removed in a
+future version of CPAN.pm. It will be replaced with the conventions
+around the family of $LANG and $LC_* environment variables.
+
=item 11)
When an install fails for some reason and then I correct the error
look Foo::Bar
-and then 'make install' directly in the subshell.
+and then C<make install> directly in the subshell.
=item 12)
http://search.cpan.org/search?query=Module::Build::Convert
-http://accognoscere.org/papers/perl-module-build-convert/module-build-convert.html
+http://www.refcnt.org/papers/module-build-convert
=item 15)
-What's the best CPAN site for me?
+I'm frequently irritated with the CPAN shell's inability to help me
+select a good mirror.
The urllist config parameter is yours. You can add and remove sites at
will. You should find out which sites have the best uptodateness,
http://www.cs.uu.nl/people/henkp/mirmon/cpan.html
+Also, feel free to play with experimental features. Run
+
+ o conf init randomize_urllist ftpstats_period ftpstats_size
+
+and choose your favorite parameters. After a few downloads running the
+C<hosts> command will probably assist you in choosing the best mirror
+sites.
+
+=item 16)
+
+Why do I get asked the same questions every time I start the shell?
+
+You can make your configuration changes permanent by calling the
+command C<o conf commit>. Alternatively set the C<auto_commit>
+variable to true by running C<o conf init auto_commit> and answering
+the following question with yes.
+
+=item 17)
+
+Older versions of CPAN.pm had the original root directory of all
+tarballs in the build directory. Now there are always random
+characters appended to these directory names. Why was this done?
+
+The random characters are provided by File::Temp and ensure that each
+module's individual build directory is unique. This makes running
+CPAN.pm in concurrent processes simultaneously safe.
+
+=item 18)
+
+Speaking of the build directory. Do I have to clean it up myself?
+
+You have the choice to set the config variable C<scan_cache> to
+C<never>. Then you must clean it up yourself. The other possible
+value, C<atstart> only cleans up the build directory when you start
+the CPAN shell. If you never start up the CPAN shell, you probably
+also have to clean up the build directory yourself.
+
=back
=head1 COMPATIBILITY
This module and its competitor, the CPANPLUS module, are both much
cooler than the other. CPAN.pm is older. CPANPLUS was designed to be
-more modular but it was never tried to make it compatible with CPAN.pm.
+more modular, but it was never intended to be compatible with CPAN.pm.
=head1 SECURITY ADVICE
=head1 BUGS
-Please report bugs via http://rt.cpan.org/
+Please report bugs via L<http://rt.cpan.org/>
Before submitting a bug, please make sure that the traditional method
of building a Perl module package from a shell by following the
=head1 TRANSLATIONS
Kawai,Takanori provides a Japanese translation of this manpage at
-http://homepage3.nifty.com/hippo2000/perltips/CPAN.htm
+L<http://homepage3.nifty.com/hippo2000/perltips/CPAN.htm>
=head1 SEE ALSO
-cpan(1), CPAN::Nox(3pm), CPAN::Version(3pm)
+L<cpan>, L<CPAN::Nox>, L<CPAN::Version>
=cut
-
-
projects / p5sagit/p5-mst-13.2.git / blobdiff