1 # -*- Mode: cperl; coding: utf-8; cperl-indent-level: 4 -*-
2 package CPAN::Mirrored::By;
8 sub continent { shift->[0] }
9 sub country { shift->[1] }
10 sub url { shift->[2] }
12 package CPAN::FirstTime;
15 use ExtUtils::MakeMaker qw(prompt);
17 use File::Basename ();
20 use vars qw($VERSION);
21 $VERSION = substr q$Revision: 1.58 $, 10;
25 CPAN::FirstTime - Utility for CPAN::Config file Initialization
29 CPAN::FirstTime::init()
33 The init routine asks a few questions and writes a CPAN::Config
34 file. Nothing special.
42 unless ($CPAN::VERSION) {
45 eval {require CPAN::Config;};
59 CPAN is the world-wide archive of perl resources. It consists of about
60 100 sites that all replicate the same contents all around the globe.
61 Many countries have at least one CPAN site already. The resources
62 found on CPAN are easily accessible with the CPAN.pm module. If you
63 want to use CPAN.pm, you have to configure it properly.
65 If you do not want to enter a dialog now, you can answer 'no' to this
66 question and I\'ll try to autoconfigure. (Note: you can revisit this
67 dialog anytime later by typing 'o conf init' at the cpan prompt.)
72 ExtUtils::MakeMaker::prompt("Are you ready for manual configuration?",
77 if ($manual_conf =~ /^\s*y/i) {
79 *prompt = \&ExtUtils::MakeMaker::prompt;
82 $CPAN::Config->{urllist} ||= [];
83 # prototype should match that of &MakeMaker::prompt
86 my($ret) = defined $a ? $a : "";
87 printf qq{%s [%s]\n\n}, $q, $ret;
94 The following questions are intended to help you with the
95 configuration. The CPAN module needs a directory of its own to cache
96 important index files and maybe keep a temporary mirror of CPAN files.
97 This may be a site-wide directory or a personal directory.
101 my $cpan_home = $CPAN::Config->{cpan_home} || File::Spec->catdir($ENV{HOME}, ".cpan");
105 I see you already have a directory
107 Shall we use it as the general CPAN build and cache directory?
113 First of all, I\'d like to create this directory. Where?
118 $default = $cpan_home;
119 while ($ans = prompt("CPAN build and cache directory?",$default)) {
120 unless (File::Spec->file_name_is_absolute($ans)) {
122 my $cwd = Cwd::cwd();
123 my $absans = File::Spec->catdir($cwd,$ans);
124 warn "The path '$ans' is not an absolute path. Please specify an absolute path\n";
128 eval { File::Path::mkpath($ans); }; # dies if it can't
130 warn "Couldn't create directory $ans.
134 if (-d $ans && -w _) {
137 warn "Couldn't find directory $ans
138 or directory is not writable. Please retry.\n";
141 $CPAN::Config->{cpan_home} = $ans;
145 If you want, I can keep the source files after a build in the cpan
146 home directory. If you choose so then future builds will take the
147 files from there. If you don\'t want to keep them, answer 0 to the
152 $CPAN::Config->{keep_source_where} = File::Spec->catdir($CPAN::Config->{cpan_home},"sources");
153 $CPAN::Config->{build_dir} = File::Spec->catdir($CPAN::Config->{cpan_home},"build");
156 # Cache size, Index expire
161 How big should the disk cache be for keeping the build directories
162 with all the intermediate files\?
166 $default = $CPAN::Config->{build_cache} || 10;
167 $ans = prompt("Cache size for build directory (in MB)?", $default);
168 $CPAN::Config->{build_cache} = $ans;
170 # XXX This the time when we refetch the index files (in days)
171 $CPAN::Config->{'index_expire'} = 1;
175 By default, each time the CPAN module is started, cache scanning
176 is performed to keep the cache size in sync. To prevent from this,
177 disable the cache scanning with 'never'.
181 $default = $CPAN::Config->{scan_cache} || 'atstart';
183 $ans = prompt("Perform cache scanning (atstart or never)?", $default);
184 } while ($ans ne 'atstart' && $ans ne 'never');
185 $CPAN::Config->{scan_cache} = $ans;
192 To considerably speed up the initial CPAN shell startup, it is
193 possible to use Storable to create a cache of metadata. If Storable
194 is not available, the normal index mechanism will be used.
198 defined($default = $CPAN::Config->{cache_metadata}) or $default = 1;
200 $ans = prompt("Cache metadata (yes/no)?", ($default ? 'yes' : 'no'));
201 } while ($ans !~ /^\s*[yn]/i);
202 $CPAN::Config->{cache_metadata} = ($ans =~ /^\s*y/i ? 1 : 0);
209 The next option deals with the charset your terminal supports. In
210 general CPAN is English speaking territory, thus the charset does not
211 matter much, but some of the aliens out there who upload their
212 software to CPAN bear names that are outside the ASCII range. If your
213 terminal supports UTF-8, you say no to the next question, if it
214 supports ISO-8859-1 (also known as LATIN1) then you say yes, and if it
215 supports neither nor, your answer does not matter, you will not be
216 able to read the names of some authors anyway. If you answer no, names
217 will be output in UTF-8.
221 defined($default = $CPAN::Config->{term_is_latin}) or $default = 1;
223 $ans = prompt("Your terminal expects ISO-8859-1 (yes/no)?",
224 ($default ? 'yes' : 'no'));
225 } while ($ans !~ /^\s*[yn]/i);
226 $CPAN::Config->{term_is_latin} = ($ans =~ /^\s*y/i ? 1 : 0);
229 # save history in file histfile
233 If you have one of the readline packages (Term::ReadLine::Perl,
234 Term::ReadLine::Gnu, possibly others) installed, the interactive CPAN
235 shell will have history support. The next two questions deal with the
236 filename of the history file and with its size. If you do not want to
237 set this variable, please hit SPACE RETURN to the following question.
241 defined($default = $CPAN::Config->{histfile}) or
242 $default = File::Spec->catfile($CPAN::Config->{cpan_home},"histfile");
243 $ans = prompt("File to save your history?", $default);
246 $CPAN::Config->{histfile} = $ans;
248 if ($CPAN::Config->{histfile}) {
249 defined($default = $CPAN::Config->{histsize}) or $default = 100;
250 $ans = prompt("Number of lines to save?", $default);
251 $CPAN::Config->{histsize} = $ans;
255 # prerequisites_policy
256 # Do we follow PREREQ_PM?
260 The CPAN module can detect when a module that which you are trying to
261 build depends on prerequisites. If this happens, it can build the
262 prerequisites for you automatically ('follow'), ask you for
263 confirmation ('ask'), or just ignore them ('ignore'). Please set your
264 policy to one of the three values.
268 $default = $CPAN::Config->{prerequisites_policy} || 'ask';
271 prompt("Policy on building prerequisites (follow, ask or ignore)?",
273 } while ($ans ne 'follow' && $ans ne 'ask' && $ans ne 'ignore');
274 $CPAN::Config->{prerequisites_policy} = $ans;
282 The CPAN module will need a few external programs to work properly.
283 Please correct me, if I guess the wrong path for a program. Don\'t
284 panic if you do not have some of them, just press ENTER for those. To
285 disable the use of a download program, you can type a space followed
291 local $^W if $^O eq 'MacOS';
292 my(@path) = split /$Config{'path_sep'}/, $ENV{'PATH'};
293 local $^W = $old_warn;
295 for $progname (qw/gzip tar unzip make lynx wget ncftpget ncftp ftp/){
296 if ($^O eq 'MacOS') {
297 $CPAN::Config->{$progname} = 'not_here';
300 my $progcall = $progname;
301 # we don't need ncftp if we have ncftpget
302 next if $progname eq "ncftp" && $CPAN::Config->{ncftpget} gt " ";
303 my $path = $CPAN::Config->{$progname}
304 || $Config::Config{$progname}
306 if (File::Spec->file_name_is_absolute($path)) {
307 # testing existence is not good enough, some have these exe
310 # warn "Warning: configured $path does not exist\n" unless -e $path;
317 $progcall = $Config::Config{$progname} if $Config::Config{$progname};
320 $path ||= find_exe($progcall,[@path]);
321 warn "Warning: $progcall not found in PATH\n" unless
322 $path; # not -e $path, because find_exe already checked that
323 $ans = prompt("Where is your $progname program?",$path) || $path;
324 $CPAN::Config->{$progname} = $ans;
326 my $path = $CPAN::Config->{'pager'} ||
327 $ENV{PAGER} || find_exe("less",[@path]) ||
328 find_exe("more",[@path]) || ($^O eq 'MacOS' ? $ENV{EDITOR} : 0 )
330 $ans = prompt("What is your favorite pager program?",$path);
331 $CPAN::Config->{'pager'} = $ans;
332 $path = $CPAN::Config->{'shell'};
333 if (File::Spec->file_name_is_absolute($path)) {
334 warn "Warning: configured $path does not exist\n" unless -e $path;
337 $path ||= $ENV{SHELL};
338 if ($^O eq 'MacOS') {
339 $CPAN::Config->{'shell'} = 'not_here';
341 $path =~ s,\\,/,g if $^O eq 'os2'; # Cosmetic only
342 $ans = prompt("What is your favorite shell?",$path);
343 $CPAN::Config->{'shell'} = $ans;
347 # Arguments to make etc.
352 Every Makefile.PL is run by perl in a separate process. Likewise we
353 run \'make\' and \'make install\' in processes. If you have any
354 parameters \(e.g. PREFIX, LIB, UNINST or the like\) you want to pass
355 to the calls, please specify them here.
357 If you don\'t understand this question, just press ENTER.
361 $default = $CPAN::Config->{makepl_arg} || "";
362 $CPAN::Config->{makepl_arg} =
363 prompt("Parameters for the 'perl Makefile.PL' command?
364 Typical frequently used settings:
366 POLLUTE=1 increasing backwards compatibility
367 LIB=~/perl non-root users (please see manual for more hints)
369 Your choice: ",$default);
370 $default = $CPAN::Config->{make_arg} || "";
371 $CPAN::Config->{make_arg} = prompt("Parameters for the 'make' command?
372 Typical frequently used setting:
374 -j3 dual processor system
376 Your choice: ",$default);
378 $default = $CPAN::Config->{make_install_arg} || $CPAN::Config->{make_arg} || "";
379 $CPAN::Config->{make_install_arg} =
380 prompt("Parameters for the 'make install' command?
381 Typical frequently used setting:
383 UNINST=1 to always uninstall potentially conflicting files
385 Your choice: ",$default);
393 Sometimes you may wish to leave the processes run by CPAN alone
394 without caring about them. As sometimes the Makefile.PL contains
395 question you\'re expected to answer, you can set a timer that will
396 kill a 'perl Makefile.PL' process after the specified time in seconds.
398 If you set this value to 0, these processes will wait forever. This is
399 the default and recommended setting.
403 $default = $CPAN::Config->{inactivity_timeout} || 0;
404 $CPAN::Config->{inactivity_timeout} =
405 prompt("Timeout for inactivity during Makefile.PL?",$default);
411 If you\'re accessing the net via proxies, you can specify them in the
412 CPAN configuration or via environment variables. The variable in
413 the \$CPAN::Config takes precedence.
417 for (qw/ftp_proxy http_proxy no_proxy/) {
418 $default = $CPAN::Config->{$_} || $ENV{$_};
419 $CPAN::Config->{$_} = prompt("Your $_?",$default);
422 if ($CPAN::Config->{ftp_proxy} ||
423 $CPAN::Config->{http_proxy}) {
424 $default = $CPAN::Config->{proxy_user} || $CPAN::LWP::UserAgent::USER;
427 If your proxy is an authenticating proxy, you can store your username
428 permanently. If you do not want that, just press RETURN. You will then
429 be asked for your username in every future session.
432 if ($CPAN::Config->{proxy_user} = prompt("Your proxy user id?",$default)) {
435 Your password for the authenticating proxy can also be stored
436 permanently on disk. If this violates your security policy, just press
437 RETURN. You will then be asked for the password in every future
442 if ($CPAN::META->has_inst("Term::ReadKey")) {
443 Term::ReadKey::ReadMode("noecho");
447 Warning: Term::ReadKey seems not to be available, your password will
448 be echoed to the terminal!
452 $CPAN::Config->{proxy_pass} = prompt("Your proxy password?");
453 if ($CPAN::META->has_inst("Term::ReadKey")) {
454 Term::ReadKey::ReadMode("restore");
456 $CPAN::Frontend->myprint("\n\n");
464 conf_sites() unless $fastread;
466 unless (@{$CPAN::Config->{'wait_list'}||[]}) {
469 WAIT support is available as a Plugin. You need the CPAN::WAIT module
470 to actually use it. But we need to know your favorite WAIT server. If
471 you don\'t know a WAIT server near you, just press ENTER.
474 $default = "wait://ls6-www.informatik.uni-dortmund.de:1404";
475 $ans = prompt("Your favorite WAIT server?\n ",$default);
476 push @{$CPAN::Config->{'wait_list'}}, $ans;
479 # We don't ask that now, it will be noticed in time, won't it?
480 $CPAN::Config->{'inhibit_startup_message'} = 0;
481 $CPAN::Config->{'getcwd'} = 'cwd';
484 CPAN::Config->commit($configpm);
488 my $m = 'MIRRORED.BY';
489 my $mby = File::Spec->catfile($CPAN::Config->{keep_source_where},$m);
490 File::Path::mkpath(File::Basename::dirname($mby));
491 if (-f $mby && -f $m && -M $m < -M $mby) {
493 File::Copy::copy($m,$mby) or die "Could not update $mby: $!";
497 my $overwrite_local = 0;
498 if ($mby && -f $mby && -M _ <= 60 && -s _ > 0) {
499 my $mtime = localtime((stat _)[9]);
500 my $prompt = qq{Found $mby as of $mtime
502 I\'d use that as a database of CPAN sites. If that is OK for you,
503 please answer 'y', but if you want me to get a new database now,
504 please answer 'n' to the following question.
506 Shall I use the local database in $mby?};
507 my $ans = prompt($prompt,"y");
508 $overwrite_local = 1 unless $ans =~ /^y/i;
511 if ($overwrite_local) {
512 print qq{Trying to overwrite $mby
514 $mby = CPAN::FTP->localize($m,$mby,3);
515 $overwrite_local = 0;
516 } elsif ( ! -f $mby ){
517 print qq{You have no $mby
518 I\'m trying to fetch one
520 $mby = CPAN::FTP->localize($m,$mby,3);
521 } elsif (-M $mby > 60 && $loopcount == 0) {
522 print qq{Your $mby is older than 60 days,
523 I\'m trying to fetch one
525 $mby = CPAN::FTP->localize($m,$mby,3);
527 } elsif (-s $mby == 0) {
528 print qq{You have an empty $mby,
529 I\'m trying to fetch one
531 $mby = CPAN::FTP->localize($m,$mby,3);
536 read_mirrored_by($mby);
543 #warn "in find_exe exe[$exe] path[@$path]";
545 my $abs = File::Spec->catfile($dir,$exe);
546 if (($abs = MM->maybe_command($abs))) {
553 my($items,$prompt,$default,$require_nonempty,$empty_warning)=@_;
561 # display, at most, 15 items at a time
562 my $limit = $#{ $items } - $pos;
563 $limit = 15 if $limit > 15;
565 # show the next $limit items, get the new position
566 $pos = display_some($items, $limit, $pos);
567 $pos = 0 if $pos >= @$items;
569 my $num = prompt($prompt,$default);
571 @nums = split (' ', $num);
572 my $i = scalar @$items;
573 (warn "invalid items entered, try again\n"), next
574 if grep (/\D/ || $_ < 1 || $_ > $i, @nums);
575 if ($require_nonempty) {
576 (warn "$empty_warning\n");
580 # a blank line continues...
589 my ($items, $limit, $pos) = @_;
592 my @displayable = @$items[$pos .. ($pos + $limit)];
593 for my $item (@displayable) {
594 printf "(%d) %s\n", ++$pos, $item;
596 printf("%d more items, hit SPACE RETURN to show them\n",
603 sub read_mirrored_by {
604 my $local = shift or return;
605 my(%all,$url,$expected_size,$default,$ans,$host,$dst,$country,$continent,@location);
606 my $fh = FileHandle->new;
607 $fh->open($local) or die "Couldn't open $local: $!";
610 ($host) = /^([\w\.\-]+)/ unless defined $host;
611 next unless defined $host;
612 next unless /\s+dst_(dst|location)/;
613 /location\s+=\s+\"([^\"]+)/ and @location = (split /\s*,\s*/, $1) and
614 ($continent, $country) = @location[-1,-2];
615 $continent =~ s/\s\(.*//;
616 $continent =~ s/\W+$//; # if Jarkko doesn't know latitude/longitude
617 /dst_dst\s+=\s+\"([^\"]+)/ and $dst = $1;
618 next unless $host && $dst && $continent && $country;
619 $all{$continent}{$country}{$dst} = CPAN::Mirrored::By->new($continent,$country,$dst);
621 $dst=$continent=$country="";
624 $CPAN::Config->{urllist} ||= [];
626 if (@previous_urls = @{$CPAN::Config->{urllist}}) {
627 $CPAN::Config->{urllist} = [];
632 Now we need to know where your favorite CPAN sites are located. Push
633 a few sites onto the array (just in case the first on the array won\'t
634 work). If you are mirroring CPAN to your local workstation, specify a
637 First, pick a nearby continent and country (you can pick several of
638 each, separated by spaces, or none if you just want to keep your
639 existing selections). Then, you will be presented with a list of URLs
640 of CPAN mirrors in the countries you selected, along with previously
641 selected URLs. Select some of those URLs, or just keep the old list.
642 Finally, you will be prompted for any extra URLs -- file:, ftp:, or
643 http: -- that host a CPAN mirror.
647 my (@cont, $cont, %cont, @countries, @urls, %seen);
648 my $no_previous_warn =
649 "Sorry! since you don't have any existing picks, you must make a\n" .
650 "geographic selection.";
651 @cont = picklist([sort keys %all],
652 "Select your continent (or several nearby continents)",
658 foreach $cont (@cont) {
659 my @c = sort keys %{$all{$cont}};
660 @cont{@c} = map ($cont, 0..$#c);
661 @c = map ("$_ ($cont)", @c) if @cont > 1;
662 push (@countries, @c);
666 @countries = picklist (\@countries,
667 "Select your country (or several nearby countries)",
671 %seen = map (($_ => 1), @previous_urls);
672 # hmmm, should take list of defaults from CPAN::Config->{'urllist'}...
673 foreach $country (@countries) {
674 (my $bare_country = $country) =~ s/ \(.*\)//;
675 my @u = sort keys %{$all{$cont{$bare_country}}{$bare_country}};
676 @u = grep (! $seen{$_}, @u);
677 @u = map ("$_ ($bare_country)", @u)
682 push (@urls, map ("$_ (previous pick)", @previous_urls));
683 my $prompt = "Select as many URLs as you like (by number),
684 put them on one line, separated by blanks, e.g. '1 4 5'";
685 if (@previous_urls) {
686 $default = join (' ', ((scalar @urls) - (scalar @previous_urls) + 1) ..
688 $prompt .= "\n(or just hit RETURN to keep your previous picks)";
691 @urls = picklist (\@urls, $prompt, $default);
692 foreach (@urls) { s/ \(.*\)//; }
693 push @{$CPAN::Config->{urllist}}, @urls;
697 my %seen = map (($_ => 1), @{$CPAN::Config->{urllist}});
700 my $prompt = "Enter another URL or RETURN to quit:";
702 $prompt = qq{CPAN.pm needs at least one URL where it can fetch CPAN files from.
704 Please enter your CPAN site:};
706 $ans = prompt ($prompt, "");
709 $ans =~ s/^\s+//; # no leading spaces
710 $ans =~ s/\s+\z//; # no trailing spaces
711 $ans =~ s|/?\z|/|; # has to end with one slash
712 $ans = "file:$ans" unless $ans =~ /:/; # without a scheme is a file:
713 if ($ans =~ /^\w+:\/./) {
714 push @urls, $ans unless $seen{$ans}++;
716 printf(qq{"%s" doesn\'t look like an URL at first sight.
717 I\'ll ignore it for now.
718 You can add it to your %s
719 later if you\'re sure it\'s right.\n},
721 $INC{'CPAN/MyConfig.pm'} || $INC{'CPAN/Config.pm'} || "configuration file",
725 } while $ans || !%seen;
727 push @{$CPAN::Config->{urllist}}, @urls;
728 # xxx delete or comment these out when you're happy that it works
729 print "New set of picks:\n";
730 map { print " $_\n" } @{$CPAN::Config->{urllist}};