[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: 1744 $,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 }
    (
     "applypatch",
     "auto_commit",
     "build_cache",
     "build_dir",
     "build_dir_reuse",
     "build_requires_install_policy",
     "bzip2",
     "cache_metadata",
     "check_sigs",
     "colorize_debug",
     "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");
        }
        my $changed;


        # one day I used randomize_urllist for a boolean, so we must
        # list them explicitly --ak
	if (0) {
        } elsif ($o =~ /^(wait_list|urllist|dontload_list)$/) {

            #
            # ARRAYS
            #

	    $func = shift @args;
	    $func ||= "";
            CPAN->debug("func[$func]args[@args]") if $CPAN::DEBUG;
	    # 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) {
                if ($o eq "urllist") {
                    # reset the cached values
                    undef $CPAN::FTP::Thesite;
                    undef $CPAN::FTP::Themethod;
                    $CPAN::Index::LAST_TIME = 0;
                } elsif ($o eq "dontload_list") {
                    # empty it, it will be built up again
                    $CPAN::META->{dontload_hash} = {};
                }
            }
        } elsif ($o =~ /_hash$/) {

            #
            # HASHES
            #

            if (@args==1 && $args[0] eq ""){
                @args = ();
            } elsif (@args % 2) {
                push @args, "";
            }
            $CPAN::Config->{$o} = { @args };
            $changed = 1;
        } else {

            #
            # SCALARS
            #

            if (defined $args[0]){
                $CPAN::CONFIG_DIRTY = 1;
                $CPAN::Config->{$o} = $args[0];
                $changed = 1;
            }
	    $self->prettyprint($o)
                if exists $keys{$o} or defined $CPAN::Config->{$o};
	}
        if ($changed) {
            if ($CPAN::Config->{auto_commit}) {
                $self->commit;
            } else {
                $CPAN::CONFIG_DIRTY = 1;
                $CPAN::Frontend->myprint("Please use 'o conf commit' to ".
                                         "make the config permanent!\n\n");
            }
        }
    }
}

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{$_}) {
            # do not drop them: forward compatibility!
            $CPAN::Frontend->mywarn("Unknown config variable '$_'\n");
            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);
}


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