1 package CPAN::HandleConfig;
3 use vars qw(%can %keys $VERSION);
5 $VERSION = sprintf "%.6f", substr(q$Rev: 826 $,4)/1000000 + 5.4;
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",
14 %keys = map { $_ => undef } (
15 # allow_unauthenticated ?? some day...
24 "commandnumber_in_prompt",
27 "dontload_hash", # deprecated after 1.83_68 (rev. 581)
40 "inhibit_startup_message",
46 "make_install_make_command",
50 "mbuild_install_build_command",
58 "prerequisites_policy",
74 if ($^O eq "MSWin32") {
76 mbuild_install_build_command
77 make_install_make_command
80 if (exists $CPAN::Config->{$k}) {
81 for ("deleting previously set config variable '$k' => '$CPAN::Config->{$k}'") {
82 $CPAN::Frontend ? $CPAN::Frontend->mywarn($_) : warn $_;
84 delete $CPAN::Config->{$k};
89 # returns true on successful action
93 CPAN->debug("self[$self]args[".join(" | ",@args)."]");
94 my($o,$str,$func,$args,$key_exists);
98 $self->$o(args => \@args); # o conf init => sub init => sub load
101 CPAN->debug("o[$o]") if $CPAN::DEBUG;
102 unless (exists $keys{$o}) {
103 $CPAN::Frontend->mywarn("Warning: unknown configuration variable '$o'\n");
108 CPAN->debug("func[$func]") if $CPAN::DEBUG;
110 # Let's avoid eval, it's easier to comprehend without.
111 if ($func eq "push") {
112 push @{$CPAN::Config->{$o}}, @args;
114 } elsif ($func eq "pop") {
115 pop @{$CPAN::Config->{$o}};
117 } elsif ($func eq "shift") {
118 shift @{$CPAN::Config->{$o}};
120 } elsif ($func eq "unshift") {
121 unshift @{$CPAN::Config->{$o}}, @args;
123 } elsif ($func eq "splice") {
124 splice @{$CPAN::Config->{$o}}, @args;
127 $CPAN::Config->{$o} = [@args];
130 $self->prettyprint($o);
133 if ($o eq "urllist") {
134 # reset the cached values
135 undef $CPAN::FTP::Thesite;
136 undef $CPAN::FTP::Themethod;
137 } elsif ($o eq "dontload_list") {
138 # empty it, it will be built up again
139 $CPAN::META->{dontload_hash} = {};
143 } elsif ($o =~ /_hash$/) {
144 @args = () if @args==1 && $args[0] eq "";
145 push @args, "" if @args % 2;
146 $CPAN::Config->{$o} = { @args };
148 $CPAN::Config->{$o} = $args[0] if defined $args[0];
149 $self->prettyprint($o);
157 my $v = $CPAN::Config->{$k};
160 if (ref $v eq "ARRAY") {
161 @report = map {"\t[$_]\n"} @$v;
163 @report = map { sprintf("\t%-18s => %s\n",
165 defined $v->{$_} ? $v->{$_} : "UNDEFINED"
168 $CPAN::Frontend->myprint(
178 } elsif (defined $v) {
179 $CPAN::Frontend->myprint(sprintf " %-18s [%s]\n", $k, $v);
181 $CPAN::Frontend->myprint(sprintf " %-18s [%s]\n", $k, "UNDEFINED");
186 my($self,@args) = @_;
189 if ($args[0] eq "args") {
190 # we have not signed that contract
192 $configpm = $args[0];
195 unless (defined $configpm){
196 $configpm ||= $INC{"CPAN/MyConfig.pm"};
197 $configpm ||= $INC{"CPAN/Config.pm"};
198 $configpm || Carp::confess(q{
199 CPAN::Config::commit called without an argument.
200 Please specify a filename where to save the configuration or try
201 "o conf init" to have an interactive course through configing.
206 $mode = (stat $configpm)[2];
207 if ($mode && ! -w _) {
208 Carp::confess("$configpm is not writable");
213 $msg = <<EOF unless $configpm =~ /MyConfig/;
215 # This is CPAN.pm's systemwide configuration file. This file provides
216 # defaults for users, and the values can be changed in a per-user
217 # configuration file. The user-config file is being looked for as
218 # ~/.cpan/CPAN/MyConfig.pm.
222 my($fh) = FileHandle->new;
223 rename $configpm, "$configpm~" if -f $configpm;
224 open $fh, ">$configpm" or
225 $CPAN::Frontend->mydie("Couldn't open >$configpm: $!");
226 $fh->print(qq[$msg\$CPAN::Config = \{\n]);
227 foreach (sort keys %$CPAN::Config) {
228 unless (exists $keys{$_}) {
229 $CPAN::Frontend->mywarn("Dropping unknown config variable '$_'\n");
230 delete $CPAN::Config->{$_};
235 $self->neatvalue($CPAN::Config->{$_}),
240 $fh->print("};\n1;\n__END__\n");
243 #$mode = 0444 | ( $mode & 0111 ? 0111 : 0 );
244 #chmod $mode, $configpm;
245 ###why was that so? $self->defaults;
246 $CPAN::Frontend->myprint("commit: wrote '$configpm'\n");
250 # stolen from MakeMaker; not taking the original because it is buggy;
251 # bugreport will have to say: keys of hashes remain unquoted and can
252 # produce syntax errors
255 return "undef" unless defined $v;
257 return "q[$v]" unless $t;
261 foreach my $elem (@$v) {
262 push @neat, "q[$elem]";
264 push @m, join ", ", @neat;
268 return "$v" unless $t eq 'HASH';
270 while (($key,$val) = each %$v){
271 last unless defined $key; # cautious programming in case (undef,undef) is true
272 push(@m,"q[$key]=>".$self->neatvalue($val)) ;
274 return "{ ".join(', ',@m)." }";
280 for my $config (qw(CPAN/MyConfig.pm CPAN/Config.pm)) {
281 CPAN::Shell->reload_this($config) and $done++;
282 $CPAN::Frontend->myprint("'$config' reread\n");
288 =head2 C<< CLASS->safe_quote ITEM >>
290 Quotes an item to become safe against spaces
291 in shell interpolation. An item is enclosed
294 - the item contains spaces in the middle
295 - the item does not start with a quote
297 This happens to avoid shell interpolation
298 problems when whitespace is present in
301 This method uses C<commands_quote> to determine
302 the correct quote. If C<commands_quote> is
303 a space, no quoting will take place.
306 if it starts and ends with the same quote character: leave it as it is
308 if it contains no whitespace: leave it as it is
310 if it contains whitespace, then
312 if it contains quotes: better leave it as it is
314 else: quote it with the correct quote type for the box we're on
319 # Instead of patching the guess, set commands_quote
321 my ($quotes,$use_quote)
328 my ($self, $command) = @_;
329 # Set up quote/default quote
330 my $quote = $CPAN::Config->{commands_quote} || $quotes;
334 and $command !~ /[$quote]/) {
335 return qq<$use_quote$command$use_quote>
342 my($self,@args) = @_;
343 undef $CPAN::Config->{'inhibit_startup_message'}; # lazy trick to
352 # This is a piece of repeated code that is abstracted here for
353 # maintainability. RMB
356 my($configpmdir, $configpmtest) = @_;
357 if (-w $configpmtest) {
358 return $configpmtest;
359 } elsif (-w $configpmdir) {
360 #_#_# following code dumped core on me with 5.003_11, a.k.
361 my $configpm_bak = "$configpmtest.bak";
362 unlink $configpm_bak if -f $configpm_bak;
363 if( -f $configpmtest ) {
364 if( rename $configpmtest, $configpm_bak ) {
365 $CPAN::Frontend->mywarn(<<END);
366 Old configuration file $configpmtest
367 moved to $configpm_bak
371 my $fh = FileHandle->new;
372 if ($fh->open(">$configpmtest")) {
374 return $configpmtest;
376 # Should never happen
377 Carp::confess("Cannot open >$configpmtest");
382 sub require_myconfig_or_config () {
383 return if $INC{"CPAN/MyConfig.pm"};
386 unshift @INC, File::Spec->catdir($home,'.cpan');
387 eval { require CPAN::MyConfig };
388 my $err_myconfig = $@;
389 if ($err_myconfig and $err_myconfig !~ m#locate CPAN/MyConfig\.pm#) {
390 die "Error while requiring CPAN::MyConfig:\n$err_myconfig";
392 unless ($INC{"CPAN/MyConfig.pm"}) { # this guy has settled his needs already
393 eval {require CPAN::Config;}; # not everybody has one
395 if ($err_config and $err_config !~ m#locate CPAN/Config\.pm#) {
396 die "Error while requiring CPAN::Config:\n$err_config";
403 if ($CPAN::META->has_usable("File::HomeDir")) {
404 $home = File::HomeDir->my_data;
412 my($self, %args) = @_;
413 $CPAN::Be_Silent++ if $args{be_silent};
417 require_myconfig_or_config;
418 return unless @miss = $self->missing_config_data;
420 require CPAN::FirstTime;
421 my($configpm,$fh,$redo,$theycalled);
423 $theycalled++ if @miss==1 && $miss[0] eq 'inhibit_startup_message';
424 if (defined $INC{"CPAN/Config.pm"} && -w $INC{"CPAN/Config.pm"}) {
425 $configpm = $INC{"CPAN/Config.pm"};
427 } elsif (defined $INC{"CPAN/MyConfig.pm"} && -w $INC{"CPAN/MyConfig.pm"}) {
428 $configpm = $INC{"CPAN/MyConfig.pm"};
431 my($path_to_cpan) = File::Basename::dirname($INC{"CPAN.pm"});
432 my($configpmdir) = File::Spec->catdir($path_to_cpan,"CPAN");
433 my($configpmtest) = File::Spec->catfile($configpmdir,"Config.pm");
435 if (-d $configpmdir or File::Path::mkpath($configpmdir)) {
436 $configpm = _configpmtest($configpmdir,$configpmtest);
437 $inc_key = "CPAN/Config.pm";
440 $configpmdir = File::Spec->catdir(home,".cpan","CPAN");
441 File::Path::mkpath($configpmdir);
442 $configpmtest = File::Spec->catfile($configpmdir,"MyConfig.pm");
443 $configpm = _configpmtest($configpmdir,$configpmtest);
444 $inc_key = "CPAN/MyConfig.pm";
447 $INC{$inc_key} = $configpm;
449 my $text = qq{WARNING: CPAN.pm is unable to } .
450 qq{create a configuration file.};
451 output($text, 'confess');
456 if ($redo && ! $theycalled){
457 $CPAN::Frontend->myprint(<<END);
458 Sorry, we have to rerun the configuration dialog for CPAN.pm due to
459 the following indispensable but missing parameters:
463 $args{args} = ["\\b".join("|",@miss)."\\b"];
466 # where do we need this?
467 $CPAN::Frontend->myprint(qq{
468 $configpm initialized.
471 CPAN::FirstTime::init($configpm, %args);
474 sub missing_config_data {
485 "inhibit_startup_message",
492 "mbuild_install_arg",
493 "mbuild_install_build_command",
497 "prerequisites_policy",
503 next unless exists $keys{$_};
504 push @miss, $_ unless defined $CPAN::Config->{$_};
510 $CPAN::Frontend->myprint(q[
512 commit commit session changes to disk
513 defaults reload default config values from disk
515 init go through a dialog to set all parameters
517 Edit key values as in the following (the "o" is a literal letter o):
518 o conf build_cache 15
519 o conf build_dir "/foo/bar"
521 o conf urllist unshift ftp://ftp.foo.bar/
522 o conf inhibit_startup_message 1
525 undef; #don't reprint CPAN::Config
529 my($word,$line,$pos) = @_;
531 CPAN->debug("word[$word] line[$line] pos[$pos]") if $CPAN::DEBUG;
532 my(@words) = split " ", substr($line,0,$pos+1);
541 @words == 4 && length($word)
544 return grep /^\Q$word\E/, qw(splice shift unshift pop push);
545 } elsif (defined($words[2])
552 @words == 4 && length($word)
554 return sort grep /^\Q$word\E/, keys %keys;
555 } elsif (@words >= 4) {
559 my(@o_conf) = sort grep { !$seen{$_}++ }
563 return grep /^\Q$word\E/, @o_conf;
568 CPAN::Config; ####::###### #hide from indexer
569 # note: J. Nick Koston wrote me that they are using
570 # CPAN::Config->commit although undocumented. I suggested
571 # CPAN::Shell->o("conf","commit") even when ugly it is at least
574 # that's why I added the CPAN::Config class with autoload and
578 use vars qw($AUTOLOAD $VERSION);
579 $VERSION = sprintf "%.2f", substr(q$Rev: 826 $,4)/100;
581 # formerly CPAN::HandleConfig was known as CPAN::Config
584 $CPAN::Frontend->mywarn("Dispatching deprecated method '$l' to CPAN::HandleConfig");
586 CPAN::HandleConfig->$l(@_);
594 # cperl-indent-level: 4