package CPAN::HandleConfig;
use strict;
-use vars qw(%can %keys $dot_cpan $VERSION);
+use vars qw(%can %keys $VERSION);
-$VERSION = sprintf "%.2f", substr(q$Rev: 469 $,4)/100;
+$VERSION = sprintf "%.6f", substr(q$Rev: 1566 $,4)/1000000 + 5.4;
%can = (
- 'commit' => "Commit changes to disk",
- 'defaults' => "Reload defaults from disk",
- 'init' => "Interactive setting of all options",
+ commit => "Commit changes to disk",
+ defaults => "Reload defaults from disk",
+ help => "Short help about 'o conf' usage",
+ init => "Interactive setting of all options",
);
-%keys = map { $_ => undef } qw(
- build_cache build_dir bzip2
- cache_metadata commandnumber_in_prompt cpan_home curl
- dontload_hash
- 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
- prefer_installer prerequisites_policy
- scan_cache shell show_upload_date
- tar term_is_latin
- unzip urllist
- wait_list wget
-);
+# 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 {
$o = shift @args;
$DB::single = 1;
if($can{$o}) {
- $self->$o(args => \@args);
+ $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");
}
- if ($o =~ /list$/) {
+ 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]") if $CPAN::DEBUG;
- my $changed;
+ 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;
unshift @{$CPAN::Config->{$o}}, @args;
$changed = 1;
} elsif ($func eq "splice") {
- splice @{$CPAN::Config->{$o}}, @args;
+ my $offset = shift @args || 0;
+ my $length = shift @args || 0;
+ splice @{$CPAN::Config->{$o}}, $offset, $length, @args; # may warn
$changed = 1;
- } elsif (@args) {
- $CPAN::Config->{$o} = [@args];
+ } elsif ($func) {
+ $CPAN::Config->{$o} = [$func, @args];
$changed = 1;
} else {
$self->prettyprint($o);
}
- if ($o eq "urllist" && $changed) {
- # reset the cached values
- undef $CPAN::FTP::Thesite;
- undef $CPAN::FTP::Themethod;
+ 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} = {};
+ }
}
- return $changed;
} elsif ($o =~ /_hash$/) {
- push @args, "" if @args % 2;
+
+ #
+ # HASHES
+ #
+
+ if (@args==1 && $args[0] eq ""){
+ @args = ();
+ } elsif (@args % 2) {
+ push @args, "";
+ }
$CPAN::Config->{$o} = { @args };
+ $changed = 1;
} else {
- $CPAN::Config->{$o} = $args[0] if defined $args[0];
- $self->prettyprint($o);
+
+ #
+ # 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");
+ }
+ }
}
}
if (ref $v) {
my(@report);
if (ref $v eq "ARRAY") {
- @report = map {"\t[$_]\n"} @$v;
+ @report = map {"\t$_ \[$v->[$_]]\n"} 0..$#$v;
} else {
@report = map { sprintf("\t%-18s => %s\n",
map { "[$_]" } $_,
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") {
$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->{$_}),
#chmod $mode, $configpm;
###why was that so? $self->defaults;
$CPAN::Frontend->myprint("commit: wrote '$configpm'\n");
+ $CPAN::CONFIG_DIRTY = 0;
1;
}
my($self, $v) = @_;
return "undef" unless defined $v;
my($t) = ref $v;
- return "q[$v]" unless $t;
+ unless ($t){
+ $v =~ s/\\/\\\\/g;
+ return "q[$v]";
+ }
if ($t eq 'ARRAY') {
my(@m, @neat);
push @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)) {
- CPAN::Shell->reload_this($config) and $done++;
- last if $done;
+ 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
} 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;
- unless ($INC{"CPAN/MyConfig.pm"}) { # this guy has settled his needs already
- eval {require CPAN::Config;}; # not everybody has one
- }
- unless ($dot_cpan++){
- unshift @INC, File::Spec->catdir($ENV{HOME},".cpan");
- eval {require CPAN::MyConfig;}; # override system wide settings
- shift @INC;
- }
+ require_myconfig_or_config;
return unless @miss = $self->missing_config_data;
require CPAN::FirstTime;
$inc_key = "CPAN/Config.pm";
}
unless ($configpm) {
- $configpmdir = File::Spec->catdir($ENV{HOME},".cpan","CPAN");
+ $configpmdir = File::Spec->catdir(home,".cpan","CPAN");
File::Path::mkpath($configpmdir);
$configpmtest = File::Spec->catfile($configpmdir,"MyConfig.pm");
$configpm = _configpmtest($configpmdir,$configpmtest);
}
local($") = ", ";
- $CPAN::Frontend->myprint(<<END) if $redo && ! $theycalled;
+ 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
- $CPAN::Frontend->myprint(qq{
+ $args{args} = \@miss;
+ }
+ if (0) {
+ # where do we need this?
+ $CPAN::Frontend->myprint(qq{
$configpm initialized.
});
-
- sleep 2;
+ }
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",
+ #"gzip",
"http_proxy",
"index_expire",
"inhibit_startup_message",
"keep_source_where",
- "make",
+ #"make",
"make_arg",
"make_install_arg",
"makepl_arg",
"mbuild_install_build_command",
"mbuildpl_arg",
"no_proxy",
- "pager",
+ #"pager",
"prerequisites_policy",
"scan_cache",
- "tar",
- "unzip",
+ #"tar",
+ #"unzip",
"urllist",
) {
+ next unless exists $keys{$_};
push @miss, $_ unless defined $CPAN::Config->{$_};
}
return @miss;
sub help {
$CPAN::Frontend->myprint(q[
Known options:
- defaults reload default config values from disk
commit commit session changes to disk
- init go through a dialog to set all parameters
-
-You may edit key values in the follow fashion (the "o" is a literal
-letter o):
+ 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
if (
defined($words[2])
and
+ $words[2] =~ /list$/
+ and
(
- $words[2] =~ /list$/ && @words == 3
+ @words == 3
||
- $words[2] =~ /list$/ && @words == 4 && length($word)
+ @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 ();
}
return grep /^\Q$word\E/, @o_conf;
}
+sub prefs_lookup {
+ my($self,$distro,$what) = @_;
-package ####::###### #hide from indexer
- CPAN::Config;
-# 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
+ 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};
+ }
+}
-# 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: 469 $,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");
- $l =~ s/.*:://;
- CPAN::HandleConfig->$l(@_);
+{
+ 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: 1566 $,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