[p5sagit/p5-mst-13.2.git] / lib / CPAN / HandleConfig.pm

package CPAN::HandleConfig;
use strict;
use vars qw(%can %keys $VERSION);

$VERSION = sprintf "%.6f", substr(q$Rev: 1379 $,4)/1000000 + 5.4;

%can = (
        commit   => "Commit changes to disk",
        defaults => "Reload defaults from disk",
        help     => "Short help about 'o conf' usage",
        init     => "Interactive setting of all options",
);

# Q: where is the "How do I add a new config option" HOWTO?
# A1: svn diff -r 757:758 # where dagolden added test_report
# A2: svn diff -r 985:986 # where andk added yaml_module
%keys = map { $_ => undef }
    (
     "build_cache",
     "build_dir",
     "build_dir_reuse",
     "build_requires_install_policy",
     "bzip2",
     "cache_metadata",
     "check_sigs",
     "colorize_output",
     "colorize_print",
     "colorize_warn",
     "commandnumber_in_prompt",
     "commands_quote",
     "cpan_home",
     "curl",
     "dontload_hash", # deprecated after 1.83_68 (rev. 581)
     "dontload_list",
     "ftp",
     "ftp_passive",
     "ftp_proxy",
     "getcwd",
     "gpg",
     "gzip",
     "histfile",
     "histsize",
     "http_proxy",
     "inactivity_timeout",
     "index_expire",
     "inhibit_startup_message",
     "keep_source_where",
     "lynx",
     "make",
     "make_arg",
     "make_install_arg",
     "make_install_make_command",
     "makepl_arg",
     "mbuild_arg",
     "mbuild_install_arg",
     "mbuild_install_build_command",
     "mbuildpl_arg",
     "ncftp",
     "ncftpget",
     "no_proxy",
     "pager",
     "password",
     "patch",
     "prefer_installer",
     "prerequisites_policy",
     "prefs_dir",
     "proxy_pass",
     "proxy_user",
     "randomize_urllist",
     "scan_cache",
     "shell",
     "show_upload_date",
     "tar",
     "term_is_latin",
     "term_ornaments",
     "test_report",
     "unzip",
     "urllist",
     "use_sqlite",
     "username",
     "wait_list",
     "wget",
     "yaml_module",
    );

my %prefssupport = map { $_ => 1 }
    (
     "build_requires_install_policy",
     "check_sigs",
     "make",
     "make_install_make_command",
     "prefer_installer",
     "test_report",
    );

if ($^O eq "MSWin32") {
    for my $k (qw(
                  mbuild_install_build_command
                  make_install_make_command
                 )) {
        delete $keys{$k};
        if (exists $CPAN::Config->{$k}) {
            for ("deleting previously set config variable '$k' => '$CPAN::Config->{$k}'") {
                $CPAN::Frontend ? $CPAN::Frontend->mywarn($_) : warn $_;
            }
            delete $CPAN::Config->{$k};
        }
    }
}

# returns true on successful action
sub edit {
    my($self,@args) = @_;
    return unless @args;
    CPAN->debug("self[$self]args[".join(" | ",@args)."]");
    my($o,$str,$func,$args,$key_exists);
    $o = shift @args;
    $DB::single = 1;
    if($can{$o}) {
	$self->$o(args => \@args); # o conf init => sub init => sub load
	return 1;
    } else {
        CPAN->debug("o[$o]") if $CPAN::DEBUG;
        unless (exists $keys{$o}) {
            $CPAN::Frontend->mywarn("Warning: unknown configuration variable '$o'\n");
        }
        # one day I used randomize_urllist for a boolean, so we must
        # list them explicitly --ak
	if ($o =~ /^(wait_list|urllist|dontload_list)$/) {
	    $func = shift @args;
	    $func ||= "";
            CPAN->debug("func[$func]args[@args]") if $CPAN::DEBUG;
            my $changed;
	    # Let's avoid eval, it's easier to comprehend without.
	    if ($func eq "push") {
		push @{$CPAN::Config->{$o}}, @args;
                $changed = 1;
	    } elsif ($func eq "pop") {
		pop @{$CPAN::Config->{$o}};
                $changed = 1;
	    } elsif ($func eq "shift") {
		shift @{$CPAN::Config->{$o}};
                $changed = 1;
	    } elsif ($func eq "unshift") {
		unshift @{$CPAN::Config->{$o}}, @args;
                $changed = 1;
	    } elsif ($func eq "splice") {
                my $offset = shift @args || 0;
                my $length = shift @args || 0;
		splice @{$CPAN::Config->{$o}}, $offset, $length, @args; # may warn
                $changed = 1;
	    } elsif ($func) {
		$CPAN::Config->{$o} = [$func, @args];
                $changed = 1;
	    } else {
                $self->prettyprint($o);
	    }
            if ($changed) {
                $CPAN::CONFIG_DIRTY = 1;
                if ($o eq "urllist") {
                    # reset the cached values
                    undef $CPAN::FTP::Thesite;
                    undef $CPAN::FTP::Themethod;
                } elsif ($o eq "dontload_list") {
                    # empty it, it will be built up again
                    $CPAN::META->{dontload_hash} = {};
                }
            }
            return $changed;
        } elsif ($o =~ /_hash$/) {
            if (@args==1 && $args[0] eq ""){
                @args = ();
            } elsif (@args % 2) {
                push @args, "";
            }
            $CPAN::Config->{$o} = { @args };
            $CPAN::CONFIG_DIRTY = 1;
        } else {
            if (defined $args[0]){
                $CPAN::CONFIG_DIRTY = 1;
                $CPAN::Config->{$o} = $args[0];
            }
	    $self->prettyprint($o)
                if exists $keys{$o} or defined $CPAN::Config->{$o};
            return 1;
	}
    }
}

sub prettyprint {
  my($self,$k) = @_;
  my $v = $CPAN::Config->{$k};
  if (ref $v) {
    my(@report);
    if (ref $v eq "ARRAY") {
      @report = map {"\t$_ \[$v->[$_]]\n"} 0..$#$v;
    } else {
      @report = map { sprintf("\t%-18s => %s\n",
                              map { "[$_]" } $_,
                              defined $v->{$_} ? $v->{$_} : "UNDEFINED"
                             )} keys %$v;
    }
    $CPAN::Frontend->myprint(
                             join(
                                  "",
                                  sprintf(
                                          "    %-18s\n",
                                          $k
                                         ),
                                  @report
                                 )
                            );
  } elsif (defined $v) {
    $CPAN::Frontend->myprint(sprintf "    %-18s [%s]\n", $k, $v);
  } else {
    $CPAN::Frontend->myprint(sprintf "    %-18s [%s]\n", $k, "UNDEFINED");
  }
}

sub commit {
    my($self,@args) = @_;
    CPAN->debug("args[@args]") if $CPAN::DEBUG;
    if ($CPAN::RUN_DEGRADED) {
                             $CPAN::Frontend->mydie(
                                                    "'o conf commit' disabled in ".
                                                    "degraded mode. Maybe try\n".
                                                    " !undef \$CPAN::RUN_DEGRADED\n"
                                                   );
    }
    my $configpm;
    if (@args) {
      if ($args[0] eq "args") {
        # we have not signed that contract
      } else {
        $configpm = $args[0];
      }
    }
    unless (defined $configpm){
	$configpm ||= $INC{"CPAN/MyConfig.pm"};
	$configpm ||= $INC{"CPAN/Config.pm"};
	$configpm || Carp::confess(q{
CPAN::Config::commit called without an argument.
Please specify a filename where to save the configuration or try
"o conf init" to have an interactive course through configing.
});
    }
    my($mode);
    if (-f $configpm) {
	$mode = (stat $configpm)[2];
	if ($mode && ! -w _) {
	    Carp::confess("$configpm is not writable");
	}
    }

    my $msg;
    $msg = <<EOF unless $configpm =~ /MyConfig/;

# This is CPAN.pm's systemwide configuration file. This file provides
# defaults for users, and the values can be changed in a per-user
# configuration file. The user-config file is being looked for as
# ~/.cpan/CPAN/MyConfig.pm.

EOF
    $msg ||= "\n";
    my($fh) = FileHandle->new;
    rename $configpm, "$configpm~" if -f $configpm;
    open $fh, ">$configpm" or
        $CPAN::Frontend->mydie("Couldn't open >$configpm: $!");
    $fh->print(qq[$msg\$CPAN::Config = \{\n]);
    foreach (sort keys %$CPAN::Config) {
        unless (exists $keys{$_}) {
            $CPAN::Frontend->mywarn("Dropping unknown config variable '$_'\n");
            delete $CPAN::Config->{$_};
            next;
        }
	$fh->print(
		   "  '$_' => ",
		   $self->neatvalue($CPAN::Config->{$_}),
		   ",\n"
		  );
    }

    $fh->print("};\n1;\n__END__\n");
    close $fh;

    #$mode = 0444 | ( $mode & 0111 ? 0111 : 0 );
    #chmod $mode, $configpm;
###why was that so?    $self->defaults;
    $CPAN::Frontend->myprint("commit: wrote '$configpm'\n");
    $CPAN::CONFIG_DIRTY = 0;
    1;
}

# stolen from MakeMaker; not taking the original because it is buggy;
# bugreport will have to say: keys of hashes remain unquoted and can
# produce syntax errors
sub neatvalue {
    my($self, $v) = @_;
    return "undef" unless defined $v;
    my($t) = ref $v;
    unless ($t){
        $v =~ s/\\/\\\\/g;
        return "q[$v]";
    }
    if ($t eq 'ARRAY') {
        my(@m, @neat);
        push @m, "[";
        foreach my $elem (@$v) {
            push @neat, "q[$elem]";
        }
        push @m, join ", ", @neat;
        push @m, "]";
        return join "", @m;
    }
    return "$v" unless $t eq 'HASH';
    my(@m, $key, $val);
    while (($key,$val) = each %$v){
        last unless defined $key; # cautious programming in case (undef,undef) is true
        push(@m,"q[$key]=>".$self->neatvalue($val)) ;
    }
    return "{ ".join(', ',@m)." }";
}

sub defaults {
    my($self) = @_;
    if ($CPAN::RUN_DEGRADED) {
                             $CPAN::Frontend->mydie(
                                                    "'o conf defaults' disabled in ".
                                                    "degraded mode. Maybe try\n".
                                                    " !undef \$CPAN::RUN_DEGRADED\n"
                                                   );
    }
    my $done;
    for my $config (qw(CPAN/MyConfig.pm CPAN/Config.pm)) {
        if ($INC{$config}) {
            CPAN->debug("INC{'$config'}[$INC{$config}]") if $CPAN::DEBUG;
            CPAN::Shell->_reload_this($config,{reloforce => 1});
            $CPAN::Frontend->myprint("'$INC{$config}' reread\n");
            last;
        }
    }
    $CPAN::CONFIG_DIRTY = 0;
    1;
}

=head2 C<< CLASS->safe_quote ITEM >>

Quotes an item to become safe against spaces
in shell interpolation. An item is enclosed
in double quotes if:

  - the item contains spaces in the middle
  - the item does not start with a quote

This happens to avoid shell interpolation
problems when whitespace is present in
directory names.

This method uses C<commands_quote> to determine
the correct quote. If C<commands_quote> is
a space, no quoting will take place.


if it starts and ends with the same quote character: leave it as it is

if it contains no whitespace: leave it as it is

if it contains whitespace, then

if it contains quotes: better leave it as it is

else: quote it with the correct quote type for the box we're on

=cut

{
    # Instead of patching the guess, set commands_quote
    # to the right value
    my ($quotes,$use_quote)
        = $^O eq 'MSWin32'
            ? ('"', '"')
                : (q<"'>, "'")
                    ;

    sub safe_quote {
        my ($self, $command) = @_;
        # Set up quote/default quote
        my $quote = $CPAN::Config->{commands_quote} || $quotes;

        if ($quote ne ' '
            and defined($command )
            and $command =~ /\s/
            and $command !~ /[$quote]/) {
            return qq<$use_quote$command$use_quote>
        }
        return $command;
    }
}

sub init {
    my($self,@args) = @_;
    undef $CPAN::Config->{'inhibit_startup_message'}; # lazy trick to
                                                      # have the least
                                                      # important
                                                      # variable
                                                      # undefined
    $self->load(@args);
    1;
}

# This is a piece of repeated code that is abstracted here for
# maintainability.  RMB
#
sub _configpmtest {
    my($configpmdir, $configpmtest) = @_; 
    if (-w $configpmtest) {
        return $configpmtest;
    } elsif (-w $configpmdir) {
        #_#_# following code dumped core on me with 5.003_11, a.k.
        my $configpm_bak = "$configpmtest.bak";
        unlink $configpm_bak if -f $configpm_bak;
        if( -f $configpmtest ) {
            if( rename $configpmtest, $configpm_bak ) {
				$CPAN::Frontend->mywarn(<<END);
Old configuration file $configpmtest
    moved to $configpm_bak
END
	    }
	}
	my $fh = FileHandle->new;
	if ($fh->open(">$configpmtest")) {
	    $fh->print("1;\n");
	    return $configpmtest;
	} else {
	    # Should never happen
	    Carp::confess("Cannot open >$configpmtest");
	}
    } else { return }
}

sub require_myconfig_or_config () {
    return if $INC{"CPAN/MyConfig.pm"};
    local @INC = @INC;
    my $home = home();
    unshift @INC, File::Spec->catdir($home,'.cpan');
    eval { require CPAN::MyConfig };
    my $err_myconfig = $@;
    if ($err_myconfig and $err_myconfig !~ m#locate CPAN/MyConfig\.pm#) {
        die "Error while requiring CPAN::MyConfig:\n$err_myconfig";
    }
    unless ($INC{"CPAN/MyConfig.pm"}) { # this guy has settled his needs already
      eval {require CPAN::Config;}; # not everybody has one
      my $err_config = $@;
      if ($err_config and $err_config !~ m#locate CPAN/Config\.pm#) {
          die "Error while requiring CPAN::Config:\n$err_config";
      }
    }
}

sub home () {
    my $home;
    if ($CPAN::META->has_usable("File::HomeDir")) {
        $home = File::HomeDir->my_data;
    } else {
        $home = $ENV{HOME};
    }
    $home;
}

sub load {
    my($self, %args) = @_;
	$CPAN::Be_Silent++ if $args{be_silent};

    my(@miss);
    use Carp;
    require_myconfig_or_config;
    return unless @miss = $self->missing_config_data;

    require CPAN::FirstTime;
    my($configpm,$fh,$redo,$theycalled);
    $redo ||= "";
    $theycalled++ if @miss==1 && $miss[0] eq 'inhibit_startup_message';
    if (defined $INC{"CPAN/Config.pm"} && -w $INC{"CPAN/Config.pm"}) {
	$configpm = $INC{"CPAN/Config.pm"};
	$redo++;
    } elsif (defined $INC{"CPAN/MyConfig.pm"} && -w $INC{"CPAN/MyConfig.pm"}) {
	$configpm = $INC{"CPAN/MyConfig.pm"};
	$redo++;
    } else {
	my($path_to_cpan) = File::Basename::dirname($INC{"CPAN.pm"});
	my($configpmdir) = File::Spec->catdir($path_to_cpan,"CPAN");
	my($configpmtest) = File::Spec->catfile($configpmdir,"Config.pm");
        my $inc_key;
	if (-d $configpmdir or File::Path::mkpath($configpmdir)) {
	    $configpm = _configpmtest($configpmdir,$configpmtest);
            $inc_key = "CPAN/Config.pm";
	}
	unless ($configpm) {
	    $configpmdir = File::Spec->catdir(home,".cpan","CPAN");
	    File::Path::mkpath($configpmdir);
	    $configpmtest = File::Spec->catfile($configpmdir,"MyConfig.pm");
	    $configpm = _configpmtest($configpmdir,$configpmtest);
            $inc_key = "CPAN/MyConfig.pm";
	}
        if ($configpm) {
          $INC{$inc_key} = $configpm;
        } else {
          my $text = qq{WARNING: CPAN.pm is unable to } .
              qq{create a configuration file.};
          output($text, 'confess');
        }

    }
    local($") = ", ";
    if ($redo && ! $theycalled){
        $CPAN::Frontend->myprint(<<END);
Sorry, we have to rerun the configuration dialog for CPAN.pm due to
the following indispensable but missing parameters:

@miss
END
        $args{args} = \@miss;
    }
    if (0) {
        # where do we need this?
        $CPAN::Frontend->myprint(qq{
$configpm initialized.
});
    }
    CPAN::FirstTime::init($configpm, %args);
}

sub missing_config_data {
    my(@miss);
    for (
         "build_cache",
         "build_dir",
         "cache_metadata",
         "cpan_home",
         "ftp_proxy",
         #"gzip",
         "http_proxy",
         "index_expire",
         "inhibit_startup_message",
         "keep_source_where",
         #"make",
         "make_arg",
         "make_install_arg",
         "makepl_arg",
         "mbuild_arg",
         "mbuild_install_arg",
         "mbuild_install_build_command",
         "mbuildpl_arg",
         "no_proxy",
         #"pager",
         "prerequisites_policy",
         "scan_cache",
         #"tar",
         #"unzip",
         "urllist",
        ) {
        next unless exists $keys{$_};
	push @miss, $_ unless defined $CPAN::Config->{$_};
    }
    return @miss;
}

sub help {
    $CPAN::Frontend->myprint(q[
Known options:
  commit    commit session changes to disk
  defaults  reload default config values from disk
  help      this help
  init      enter a dialog to set all or a set of parameters

Edit key values as in the following (the "o" is a literal letter o):
  o conf build_cache 15
  o conf build_dir "/foo/bar"
  o conf urllist shift
  o conf urllist unshift ftp://ftp.foo.bar/
  o conf inhibit_startup_message 1

]);
    undef; #don't reprint CPAN::Config
}

sub cpl {
    my($word,$line,$pos) = @_;
    $word ||= "";
    CPAN->debug("word[$word] line[$line] pos[$pos]") if $CPAN::DEBUG;
    my(@words) = split " ", substr($line,0,$pos+1);
    if (
	defined($words[2])
	and
        $words[2] =~ /list$/
        and
	(
	 @words == 3
	 ||
	 @words == 4 && length($word)
	)
       ) {
	return grep /^\Q$word\E/, qw(splice shift unshift pop push);
    } elsif (defined($words[2])
             and
             $words[2] eq "init"
             and
            (
             @words == 3
             ||
             @words >= 4 && length($word)
            )) {
	return sort grep /^\Q$word\E/, keys %keys;
    } elsif (@words >= 4) {
	return ();
    }
    my %seen;
    my(@o_conf) =  sort grep { !$seen{$_}++ }
        keys %can,
            keys %$CPAN::Config,
                keys %keys;
    return grep /^\Q$word\E/, @o_conf;
}

sub prefs_lookup {
    my($self,$distro,$what) = @_;

    if ($prefssupport{$what}) {
        return $CPAN::Config->{$what} unless
            $distro
                and $distro->prefs
                    and $distro->prefs->{cpanconfig}
                        and defined $distro->prefs->{cpanconfig}{$what};
        return $distro->prefs->{cpanconfig}{$what};
    } else {
        $CPAN::Frontend->mywarn("Warning: $what not yet officially ".
                                "supported for distroprefs, doing a normal lookup");
        return $CPAN::Config->{$what};
    }
}


{
    package
        CPAN::Config; ####::###### #hide from indexer
    # note: J. Nick Koston wrote me that they are using
    # CPAN::Config->commit although undocumented. I suggested
    # CPAN::Shell->o("conf","commit") even when ugly it is at least
    # documented

    # that's why I added the CPAN::Config class with autoload and
    # deprecated warning

    use strict;
    use vars qw($AUTOLOAD $VERSION);
    $VERSION = sprintf "%.2f", substr(q$Rev: 1379 $,4)/100;

    # formerly CPAN::HandleConfig was known as CPAN::Config
    sub AUTOLOAD {
        my($l) = $AUTOLOAD;
        $CPAN::Frontend->mywarn("Dispatching deprecated method '$l' to CPAN::HandleConfig\n");
        $l =~ s/.*:://;
        CPAN::HandleConfig->$l(@_);
    }
}

1;

__END__

=head1 LICENSE

This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.

=cut

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