This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
a51f55728ffb11c4827ca2d275fb07c3a07eafcb
[perl5.git] / lib / CPAN / HandleConfig.pm
1 package CPAN::HandleConfig;
2 use strict;
3 use vars qw(%can %keys $VERSION);
4
5 $VERSION = sprintf "%.6f", substr(q$Rev: 1128 $,4)/1000000 + 5.4;
6
7 %can = (
8         commit   => "Commit changes to disk",
9         defaults => "Reload defaults from disk",
10         help     => "Short help about 'o conf' usage",
11         init     => "Interactive setting of all options",
12 );
13
14 # Q: where is the "How do I add a new config option" HOWTO?
15 # A1: svn diff -r 757:758 # where dagolden added test_report
16 # A2: svn diff -r 985:986 # where andk added yaml_module
17 %keys = map { $_ => undef }
18     (
19      "build_cache",
20      "build_dir",
21      "build_requires_install_policy",
22      "bzip2",
23      "cache_metadata",
24      "check_sigs",
25      "colorize_output",
26      "colorize_print",
27      "colorize_warn",
28      "commandnumber_in_prompt",
29      "commands_quote",
30      "cpan_home",
31      "curl",
32      "dontload_hash", # deprecated after 1.83_68 (rev. 581)
33      "dontload_list",
34      "ftp",
35      "ftp_passive",
36      "ftp_proxy",
37      "getcwd",
38      "gpg",
39      "gzip",
40      "histfile",
41      "histsize",
42      "http_proxy",
43      "inactivity_timeout",
44      "index_expire",
45      "inhibit_startup_message",
46      "keep_source_where",
47      "lynx",
48      "make",
49      "make_arg",
50      "make_install_arg",
51      "make_install_make_command",
52      "makepl_arg",
53      "mbuild_arg",
54      "mbuild_install_arg",
55      "mbuild_install_build_command",
56      "mbuildpl_arg",
57      "ncftp",
58      "ncftpget",
59      "no_proxy",
60      "pager",
61      "password",
62      "patch",
63      "prefer_installer",
64      "prerequisites_policy",
65      "prefs_dir",
66      "proxy_pass",
67      "proxy_user",
68      "scan_cache",
69      "shell",
70      "show_upload_date",
71      "tar",
72      "term_is_latin",
73      "term_ornaments",
74      "test_report",
75      "unzip",
76      "urllist",
77      "username",
78      "wait_list",
79      "wget",
80      "yaml_module",
81     );
82
83 my %prefssupport = map { $_ => 1 }
84     (
85      "build_requires_install_policy",
86      "make",
87      "make_install_make_command",
88      "prefer_installer",
89      "test_report",
90     );
91
92 if ($^O eq "MSWin32") {
93     for my $k (qw(
94                   mbuild_install_build_command
95                   make_install_make_command
96                  )) {
97         delete $keys{$k};
98         if (exists $CPAN::Config->{$k}) {
99             for ("deleting previously set config variable '$k' => '$CPAN::Config->{$k}'") {
100                 $CPAN::Frontend ? $CPAN::Frontend->mywarn($_) : warn $_;
101             }
102             delete $CPAN::Config->{$k};
103         }
104     }
105 }
106
107 # returns true on successful action
108 sub edit {
109     my($self,@args) = @_;
110     return unless @args;
111     CPAN->debug("self[$self]args[".join(" | ",@args)."]");
112     my($o,$str,$func,$args,$key_exists);
113     $o = shift @args;
114     $DB::single = 1;
115     if($can{$o}) {
116         $self->$o(args => \@args); # o conf init => sub init => sub load
117         return 1;
118     } else {
119         CPAN->debug("o[$o]") if $CPAN::DEBUG;
120         unless (exists $keys{$o}) {
121             $CPAN::Frontend->mywarn("Warning: unknown configuration variable '$o'\n");
122         }
123         if ($o =~ /list$/) {
124             $func = shift @args;
125             $func ||= "";
126             CPAN->debug("func[$func]") if $CPAN::DEBUG;
127             my $changed;
128             # Let's avoid eval, it's easier to comprehend without.
129             if ($func eq "push") {
130                 push @{$CPAN::Config->{$o}}, @args;
131                 $changed = 1;
132             } elsif ($func eq "pop") {
133                 pop @{$CPAN::Config->{$o}};
134                 $changed = 1;
135             } elsif ($func eq "shift") {
136                 shift @{$CPAN::Config->{$o}};
137                 $changed = 1;
138             } elsif ($func eq "unshift") {
139                 unshift @{$CPAN::Config->{$o}}, @args;
140                 $changed = 1;
141             } elsif ($func eq "splice") {
142                 splice @{$CPAN::Config->{$o}}, @args;
143                 $changed = 1;
144             } elsif (@args) {
145                 $CPAN::Config->{$o} = [@args];
146                 $changed = 1;
147             } else {
148                 $self->prettyprint($o);
149             }
150             if ($changed) {
151                 $CPAN::CONFIG_DIRTY = 1;
152                 if ($o eq "urllist") {
153                     # reset the cached values
154                     undef $CPAN::FTP::Thesite;
155                     undef $CPAN::FTP::Themethod;
156                 } elsif ($o eq "dontload_list") {
157                     # empty it, it will be built up again
158                     $CPAN::META->{dontload_hash} = {};
159                 }
160             }
161             return $changed;
162         } elsif ($o =~ /_hash$/) {
163             if (@args==1 && $args[0] eq ""){
164                 @args = ();
165             } elsif (@args % 2) {
166                 push @args, "";
167             }
168             $CPAN::Config->{$o} = { @args };
169             $CPAN::CONFIG_DIRTY = 1;
170         } else {
171             if (defined $args[0]){
172                 $CPAN::CONFIG_DIRTY = 1;
173                 $CPAN::Config->{$o} = $args[0];
174             }
175             $self->prettyprint($o)
176                 if exists $keys{$o} or defined $CPAN::Config->{$o};
177             return 1;
178         }
179     }
180 }
181
182 sub prettyprint {
183   my($self,$k) = @_;
184   my $v = $CPAN::Config->{$k};
185   if (ref $v) {
186     my(@report);
187     if (ref $v eq "ARRAY") {
188       @report = map {"\t[$_]\n"} @$v;
189     } else {
190       @report = map { sprintf("\t%-18s => %s\n",
191                               map { "[$_]" } $_,
192                               defined $v->{$_} ? $v->{$_} : "UNDEFINED"
193                              )} keys %$v;
194     }
195     $CPAN::Frontend->myprint(
196                              join(
197                                   "",
198                                   sprintf(
199                                           "    %-18s\n",
200                                           $k
201                                          ),
202                                   @report
203                                  )
204                             );
205   } elsif (defined $v) {
206     $CPAN::Frontend->myprint(sprintf "    %-18s [%s]\n", $k, $v);
207   } else {
208     $CPAN::Frontend->myprint(sprintf "    %-18s [%s]\n", $k, "UNDEFINED");
209   }
210 }
211
212 sub commit {
213     my($self,@args) = @_;
214     CPAN->debug("args[@args]") if $CPAN::DEBUG;
215     my $configpm;
216     if (@args) {
217       if ($args[0] eq "args") {
218         # we have not signed that contract
219       } else {
220         $configpm = $args[0];
221       }
222     }
223     unless (defined $configpm){
224         $configpm ||= $INC{"CPAN/MyConfig.pm"};
225         $configpm ||= $INC{"CPAN/Config.pm"};
226         $configpm || Carp::confess(q{
227 CPAN::Config::commit called without an argument.
228 Please specify a filename where to save the configuration or try
229 "o conf init" to have an interactive course through configing.
230 });
231     }
232     my($mode);
233     if (-f $configpm) {
234         $mode = (stat $configpm)[2];
235         if ($mode && ! -w _) {
236             Carp::confess("$configpm is not writable");
237         }
238     }
239
240     my $msg;
241     $msg = <<EOF unless $configpm =~ /MyConfig/;
242
243 # This is CPAN.pm's systemwide configuration file. This file provides
244 # defaults for users, and the values can be changed in a per-user
245 # configuration file. The user-config file is being looked for as
246 # ~/.cpan/CPAN/MyConfig.pm.
247
248 EOF
249     $msg ||= "\n";
250     my($fh) = FileHandle->new;
251     rename $configpm, "$configpm~" if -f $configpm;
252     open $fh, ">$configpm" or
253         $CPAN::Frontend->mydie("Couldn't open >$configpm: $!");
254     $fh->print(qq[$msg\$CPAN::Config = \{\n]);
255     foreach (sort keys %$CPAN::Config) {
256         unless (exists $keys{$_}) {
257             $CPAN::Frontend->mywarn("Dropping unknown config variable '$_'\n");
258             delete $CPAN::Config->{$_};
259             next;
260         }
261         $fh->print(
262                    "  '$_' => ",
263                    $self->neatvalue($CPAN::Config->{$_}),
264                    ",\n"
265                   );
266     }
267
268     $fh->print("};\n1;\n__END__\n");
269     close $fh;
270
271     #$mode = 0444 | ( $mode & 0111 ? 0111 : 0 );
272     #chmod $mode, $configpm;
273 ###why was that so?    $self->defaults;
274     $CPAN::Frontend->myprint("commit: wrote '$configpm'\n");
275     $CPAN::CONFIG_DIRTY = 0;
276     1;
277 }
278
279 # stolen from MakeMaker; not taking the original because it is buggy;
280 # bugreport will have to say: keys of hashes remain unquoted and can
281 # produce syntax errors
282 sub neatvalue {
283     my($self, $v) = @_;
284     return "undef" unless defined $v;
285     my($t) = ref $v;
286     unless ($t){
287         $v =~ s/\\/\\\\/g;
288         return "q[$v]";
289     }
290     if ($t eq 'ARRAY') {
291         my(@m, @neat);
292         push @m, "[";
293         foreach my $elem (@$v) {
294             push @neat, "q[$elem]";
295         }
296         push @m, join ", ", @neat;
297         push @m, "]";
298         return join "", @m;
299     }
300     return "$v" unless $t eq 'HASH';
301     my(@m, $key, $val);
302     while (($key,$val) = each %$v){
303         last unless defined $key; # cautious programming in case (undef,undef) is true
304         push(@m,"q[$key]=>".$self->neatvalue($val)) ;
305     }
306     return "{ ".join(', ',@m)." }";
307 }
308
309 sub defaults {
310     my($self) = @_;
311     my $done;
312     for my $config (qw(CPAN/MyConfig.pm CPAN/Config.pm)) {
313         if ($INC{$config}) {
314             CPAN->debug("INC{'$config'}[$INC{$config}]") if $CPAN::DEBUG;
315             CPAN::Shell->reload_this($config,{force => 1});
316             $CPAN::Frontend->myprint("'$INC{$config}' reread\n");
317             last;
318         }
319     }
320     $CPAN::CONFIG_DIRTY = 0;
321     1;
322 }
323
324 =head2 C<< CLASS->safe_quote ITEM >>
325
326 Quotes an item to become safe against spaces
327 in shell interpolation. An item is enclosed
328 in double quotes if:
329
330   - the item contains spaces in the middle
331   - the item does not start with a quote
332
333 This happens to avoid shell interpolation
334 problems when whitespace is present in
335 directory names.
336
337 This method uses C<commands_quote> to determine
338 the correct quote. If C<commands_quote> is
339 a space, no quoting will take place.
340
341
342 if it starts and ends with the same quote character: leave it as it is
343
344 if it contains no whitespace: leave it as it is
345
346 if it contains whitespace, then
347
348 if it contains quotes: better leave it as it is
349
350 else: quote it with the correct quote type for the box we're on
351
352 =cut
353
354 {
355     # Instead of patching the guess, set commands_quote
356     # to the right value
357     my ($quotes,$use_quote)
358         = $^O eq 'MSWin32'
359             ? ('"', '"')
360                 : (q<"'>, "'")
361                     ;
362
363     sub safe_quote {
364         my ($self, $command) = @_;
365         # Set up quote/default quote
366         my $quote = $CPAN::Config->{commands_quote} || $quotes;
367
368         if ($quote ne ' '
369             and defined($command )
370             and $command =~ /\s/
371             and $command !~ /[$quote]/) {
372             return qq<$use_quote$command$use_quote>
373         }
374         return $command;
375     }
376 }
377
378 sub init {
379     my($self,@args) = @_;
380     undef $CPAN::Config->{'inhibit_startup_message'}; # lazy trick to
381                                                       # have the least
382                                                       # important
383                                                       # variable
384                                                       # undefined
385     $self->load(@args);
386     1;
387 }
388
389 # This is a piece of repeated code that is abstracted here for
390 # maintainability.  RMB
391 #
392 sub _configpmtest {
393     my($configpmdir, $configpmtest) = @_; 
394     if (-w $configpmtest) {
395         return $configpmtest;
396     } elsif (-w $configpmdir) {
397         #_#_# following code dumped core on me with 5.003_11, a.k.
398         my $configpm_bak = "$configpmtest.bak";
399         unlink $configpm_bak if -f $configpm_bak;
400         if( -f $configpmtest ) {
401             if( rename $configpmtest, $configpm_bak ) {
402                                 $CPAN::Frontend->mywarn(<<END);
403 Old configuration file $configpmtest
404     moved to $configpm_bak
405 END
406             }
407         }
408         my $fh = FileHandle->new;
409         if ($fh->open(">$configpmtest")) {
410             $fh->print("1;\n");
411             return $configpmtest;
412         } else {
413             # Should never happen
414             Carp::confess("Cannot open >$configpmtest");
415         }
416     } else { return }
417 }
418
419 sub require_myconfig_or_config () {
420     return if $INC{"CPAN/MyConfig.pm"};
421     local @INC = @INC;
422     my $home = home();
423     unshift @INC, File::Spec->catdir($home,'.cpan');
424     eval { require CPAN::MyConfig };
425     my $err_myconfig = $@;
426     if ($err_myconfig and $err_myconfig !~ m#locate CPAN/MyConfig\.pm#) {
427         die "Error while requiring CPAN::MyConfig:\n$err_myconfig";
428     }
429     unless ($INC{"CPAN/MyConfig.pm"}) { # this guy has settled his needs already
430       eval {require CPAN::Config;}; # not everybody has one
431       my $err_config = $@;
432       if ($err_config and $err_config !~ m#locate CPAN/Config\.pm#) {
433           die "Error while requiring CPAN::Config:\n$err_config";
434       }
435     }
436 }
437
438 sub home () {
439     my $home;
440     if ($CPAN::META->has_usable("File::HomeDir")) {
441         $home = File::HomeDir->my_data;
442     } else {
443         $home = $ENV{HOME};
444     }
445     $home;
446 }
447
448 sub load {
449     my($self, %args) = @_;
450         $CPAN::Be_Silent++ if $args{be_silent};
451
452     my(@miss);
453     use Carp;
454     require_myconfig_or_config;
455     return unless @miss = $self->missing_config_data;
456
457     require CPAN::FirstTime;
458     my($configpm,$fh,$redo,$theycalled);
459     $redo ||= "";
460     $theycalled++ if @miss==1 && $miss[0] eq 'inhibit_startup_message';
461     if (defined $INC{"CPAN/Config.pm"} && -w $INC{"CPAN/Config.pm"}) {
462         $configpm = $INC{"CPAN/Config.pm"};
463         $redo++;
464     } elsif (defined $INC{"CPAN/MyConfig.pm"} && -w $INC{"CPAN/MyConfig.pm"}) {
465         $configpm = $INC{"CPAN/MyConfig.pm"};
466         $redo++;
467     } else {
468         my($path_to_cpan) = File::Basename::dirname($INC{"CPAN.pm"});
469         my($configpmdir) = File::Spec->catdir($path_to_cpan,"CPAN");
470         my($configpmtest) = File::Spec->catfile($configpmdir,"Config.pm");
471         my $inc_key;
472         if (-d $configpmdir or File::Path::mkpath($configpmdir)) {
473             $configpm = _configpmtest($configpmdir,$configpmtest);
474             $inc_key = "CPAN/Config.pm";
475         }
476         unless ($configpm) {
477             $configpmdir = File::Spec->catdir(home,".cpan","CPAN");
478             File::Path::mkpath($configpmdir);
479             $configpmtest = File::Spec->catfile($configpmdir,"MyConfig.pm");
480             $configpm = _configpmtest($configpmdir,$configpmtest);
481             $inc_key = "CPAN/MyConfig.pm";
482         }
483         if ($configpm) {
484           $INC{$inc_key} = $configpm;
485         } else {
486           my $text = qq{WARNING: CPAN.pm is unable to } .
487               qq{create a configuration file.};
488           output($text, 'confess');
489         }
490
491     }
492     local($") = ", ";
493     if ($redo && ! $theycalled){
494         $CPAN::Frontend->myprint(<<END);
495 Sorry, we have to rerun the configuration dialog for CPAN.pm due to
496 the following indispensable but missing parameters:
497
498 @miss
499 END
500         $args{args} = \@miss;
501     }
502     if (0) {
503         # where do we need this?
504         $CPAN::Frontend->myprint(qq{
505 $configpm initialized.
506 });
507     }
508     CPAN::FirstTime::init($configpm, %args);
509 }
510
511 sub missing_config_data {
512     my(@miss);
513     for (
514          "build_cache",
515          "build_dir",
516          "cache_metadata",
517          "cpan_home",
518          "ftp_proxy",
519          #"gzip",
520          "http_proxy",
521          "index_expire",
522          "inhibit_startup_message",
523          "keep_source_where",
524          #"make",
525          "make_arg",
526          "make_install_arg",
527          "makepl_arg",
528          "mbuild_arg",
529          "mbuild_install_arg",
530          "mbuild_install_build_command",
531          "mbuildpl_arg",
532          "no_proxy",
533          #"pager",
534          "prerequisites_policy",
535          "scan_cache",
536          #"tar",
537          #"unzip",
538          "urllist",
539         ) {
540         next unless exists $keys{$_};
541         push @miss, $_ unless defined $CPAN::Config->{$_};
542     }
543     return @miss;
544 }
545
546 sub help {
547     $CPAN::Frontend->myprint(q[
548 Known options:
549   commit    commit session changes to disk
550   defaults  reload default config values from disk
551   help      this help
552   init      enter a dialog to set all or a set of parameters
553
554 Edit key values as in the following (the "o" is a literal letter o):
555   o conf build_cache 15
556   o conf build_dir "/foo/bar"
557   o conf urllist shift
558   o conf urllist unshift ftp://ftp.foo.bar/
559   o conf inhibit_startup_message 1
560
561 ]);
562     undef; #don't reprint CPAN::Config
563 }
564
565 sub cpl {
566     my($word,$line,$pos) = @_;
567     $word ||= "";
568     CPAN->debug("word[$word] line[$line] pos[$pos]") if $CPAN::DEBUG;
569     my(@words) = split " ", substr($line,0,$pos+1);
570     if (
571         defined($words[2])
572         and
573         $words[2] =~ /list$/
574         and
575         (
576          @words == 3
577          ||
578          @words == 4 && length($word)
579         )
580        ) {
581         return grep /^\Q$word\E/, qw(splice shift unshift pop push);
582     } elsif (defined($words[2])
583              and
584              $words[2] eq "init"
585              and
586             (
587              @words == 3
588              ||
589              @words >= 4 && length($word)
590             )) {
591         return sort grep /^\Q$word\E/, keys %keys;
592     } elsif (@words >= 4) {
593         return ();
594     }
595     my %seen;
596     my(@o_conf) =  sort grep { !$seen{$_}++ }
597         keys %can,
598             keys %$CPAN::Config,
599                 keys %keys;
600     return grep /^\Q$word\E/, @o_conf;
601 }
602
603 sub prefs_lookup {
604     my($self,$distro,$what) = @_;
605     if ($prefssupport{$what}) {
606         return $distro->prefs->{cpanconfig}{$what} || $CPAN::Config->{$what};
607     } else {
608         warn "Warning: $what no yet officially supported for distroprefs, doing a normal lookup";
609         return $CPAN::Config->{$what};
610     }
611 }
612
613
614 {
615     package
616         CPAN::Config; ####::###### #hide from indexer
617     # note: J. Nick Koston wrote me that they are using
618     # CPAN::Config->commit although undocumented. I suggested
619     # CPAN::Shell->o("conf","commit") even when ugly it is at least
620     # documented
621
622     # that's why I added the CPAN::Config class with autoload and
623     # deprecated warning
624
625     use strict;
626     use vars qw($AUTOLOAD $VERSION);
627     $VERSION = sprintf "%.2f", substr(q$Rev: 1128 $,4)/100;
628
629     # formerly CPAN::HandleConfig was known as CPAN::Config
630     sub AUTOLOAD {
631         my($l) = $AUTOLOAD;
632         $CPAN::Frontend->mywarn("Dispatching deprecated method '$l' to CPAN::HandleConfig\n");
633         $l =~ s/.*:://;
634         CPAN::HandleConfig->$l(@_);
635     }
636 }
637
638 1;
639
640 __END__
641
642 =head1 LICENSE
643
644 This program is free software; you can redistribute it and/or
645 modify it under the same terms as Perl itself.
646
647 =cut
648
649 # Local Variables:
650 # mode: cperl
651 # cperl-indent-level: 4
652 # End: