X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2Flocal%2Flib.pm;h=c9f9f485ea8e52a17657c32a07717996b563a385;hb=49c9e33470b288061568ca818c418d6adaa382e7;hp=80f56adea76d74414ac3f12cc17e5534659f9b63;hpb=b01292d64375db099a596cb0e65931e932de7889;p=p5sagit%2Flocal-lib.git diff --git a/lib/local/lib.pm b/lib/local/lib.pm index 80f56ad..c9f9f48 100644 --- a/lib/local/lib.pm +++ b/lib/local/lib.pm @@ -16,6 +16,7 @@ sub import { my @steps; my %opts; + my $shelltype; while (@args) { my $arg = shift @args; @@ -32,7 +33,17 @@ dashes with normal minus signs. DEATH } elsif ($arg eq '--self-contained') { - die "FATAL: The local::lib --self-contained flag has never worked reliably and the original author, Mark Stosberg, was unable or unwilling to maintain it. As such, this flag has been removed from the local::lib codebase in order to prevent misunderstandings and potentially broken builds. The local::lib authors recommend that you look at the lib::core::only module shipped with this distribution in order to create a more robust environment that is equivalent to what --self-contained provided (although quite possibly not what you originally thought it provided due to the poor quality of the documentation, for which we apologise).\n"; + die <<'DEATH'; +FATAL: The local::lib --self-contained flag has never worked reliably and the +original author, Mark Stosberg, was unable or unwilling to maintain it. As +such, this flag has been removed from the local::lib codebase in order to +prevent misunderstandings and potentially broken builds. The local::lib authors +recommend that you look at the lib::core::only module shipped with this +distribution in order to create a more robust environment that is equivalent to +what --self-contained provided (although quite possibly not what you originally +thought it provided due to the poor quality of the documentation, for which we +apologise). +DEATH } elsif( $arg =~ /^--deactivate(?:=(.*))?$/ ) { my $path = defined $1 ? $1 : shift @args; @@ -42,8 +53,7 @@ DEATH push @steps, ['deactivate_all']; } elsif ( $arg =~ /^--shelltype(?:=(.*))?$/ ) { - my $shell = defined $1 ? $1 : shift @args; - $opts{shelltype} = $shell; + $shelltype = defined $1 ? $1 : shift @args; } elsif ( $arg eq '--no-create' ) { $opts{no_create} = 1; @@ -67,11 +77,11 @@ DEATH } if ($0 eq '-') { - $self->print_environment_vars_for; + print $self->environment_vars_string($shelltype); exit 0; } else { - $self->setup_local_lib_for; + $self->setup_local_lib; } } @@ -109,6 +119,8 @@ sub _as_list { } sub _remove_from { my ($list, @remove) = @_; + return @$list + if !@remove; my %remove = map { $_ => 1 } @remove; grep !$remove{$_}, _as_list($list); } @@ -157,10 +169,12 @@ sub _mb_escape_path { sub installer_options_for { my ($class, $path) = @_; - return { - PERL_MM_OPT => defined $path ? "INSTALL_BASE="._mm_escape_path($path) : undef, - PERL_MB_OPT => defined $path ? "--install_base "._mb_escape_path($path) : undef, - }; + return ( + PERL_MM_OPT => + defined $path ? "INSTALL_BASE="._mm_escape_path($path) : undef, + PERL_MB_OPT => + defined $path ? "--install_base "._mb_escape_path($path) : undef, + ); } sub active_paths { @@ -179,6 +193,7 @@ sub deactivate { my ($self, $path) = @_; $self = $self->new unless ref $self; $path = $self->resolve_path($path); + $path = $self->normalize_path($path); my @active_lls = $self->active_paths; @@ -188,13 +203,16 @@ sub deactivate { } my %args = ( - bins => [ _remove_from($self->bins, $self->install_base_bin_path($path)) ], - libs => [ _remove_from($self->libs, $self->install_base_perl_path($path)) ], - inc => [ _remove_from($self->inc, $self->lib_paths_for($path)) ], + bins => [ _remove_from($self->bins, + $self->install_base_bin_path($path)) ], + libs => [ _remove_from($self->libs, + $self->install_base_perl_path($path)) ], + inc => [ _remove_from($self->inc, + $self->lib_paths_for($path)) ], roots => [ _remove_from($self->roots, $path) ], ); - $args{extra} = $self->installer_options_for($args{roots}[0]); + $args{extra} = { $self->installer_options_for($args{roots}[0]) }; $self->clone(%args); } @@ -205,17 +223,20 @@ sub deactivate_all { my @active_lls = $self->active_paths; - my %args = ( - bins => [ _remove_from($self->bins, - map $self->install_base_bin_path($_), @active_lls) ], - libs => [ _remove_from($self->libs, - map $self->install_base_perl_path($_), @active_lls) ], - inc => [ _remove_from($self->inc, - map $self->lib_paths_for($_), @active_lls) ], - roots => [ _remove_from($self->roots, @active_lls) ], - ); + my %args; + if (@active_lls) { + %args = ( + bins => [ _remove_from($self->bins, + map $self->install_base_bin_path($_), @active_lls) ], + libs => [ _remove_from($self->libs, + map $self->install_base_perl_path($_), @active_lls) ], + inc => [ _remove_from($self->inc, + map $self->lib_paths_for($_), @active_lls) ], + roots => [ _remove_from($self->roots, @active_lls) ], + ); + } - $args{extra} = $self->installer_options_for(undef); + $args{extra} = { $self->installer_options_for(undef) }; $self->clone(%args); } @@ -227,38 +248,42 @@ sub activate { $self->ensure_dir_structure_for($path) unless $self->no_create; - $path = ( Win32::GetShortPathName($path) || $path ) - if $^O eq 'MSWin32'; + $path = $self->normalize_path($path); my @active_lls = $self->active_paths; - if (grep { $_ eq $path } @active_lls) { + if (grep { $_ eq $path } @active_lls[1 .. $#active_lls]) { $self = $self->deactivate($path); } - my %args = ( - bins => [ $self->install_base_bin_path($path), @{$self->bins} ], - libs => [ $self->install_base_perl_path($path), @{$self->libs} ], - inc => [ $self->lib_paths_for($path), @{$self->inc} ], - roots => [ $path, @{$self->roots} ], - ); + my %args; + if (!@active_lls || $active_lls[0] ne $path) { + %args = ( + bins => [ $self->install_base_bin_path($path), @{$self->bins} ], + libs => [ $self->install_base_perl_path($path), @{$self->libs} ], + inc => [ $self->lib_paths_for($path), @{$self->inc} ], + roots => [ $path, @{$self->roots} ], + ); + } - $args{extra} = $self->installer_options_for($path); + $args{extra} = { $self->installer_options_for($path) }; $self->clone(%args); } -sub _legacy { +sub normalize_path { my ($self, $path) = @_; - $self = $self->new unless ref $self; - if (defined $path) { - $self = $self->activate($path); - } - $self; + $path = ( Win32::GetShortPathName($path) || $path ) + if $^O eq 'MSWin32'; + return $path; } sub build_environment_vars_for { - my ($self) = _legacy(@_); + my $self = $_[0]->new->activate($_[1]); + $self->build_environment_vars; +} +sub build_environment_vars { + my $self = shift; ( PATH => join($_path_sep, _as_list($self->bins)), PERL5LIB => join($_path_sep, _as_list($self->libs)), @@ -268,14 +293,23 @@ sub build_environment_vars_for { } sub setup_local_lib_for { - my ($self) = _legacy(@_); - $self->setup_env_hash_for; + my $self = $_[0]->new->activate($_[1]); + $self->setup_local_lib; +} + +sub setup_local_lib { + my $self = shift; + $self->setup_env_hash; @INC = @{$self->inc}; } sub setup_env_hash_for { + my $self = $_[0]->new->activate($_[1]); + $self->setup_env_hash; +} +sub setup_env_hash { my $self = shift; - my %env = $self->build_environment_vars_for(@_); + my %env = $self->build_environment_vars; for my $key (keys %env) { if (defined $env{$key}) { $ENV{$key} = $env{$key}; @@ -287,14 +321,19 @@ sub setup_env_hash_for { } sub print_environment_vars_for { - my $self = shift; - print $self->environment_vars_string_for(@_); + print $_[0]->environment_vars_string_for(@_[1..$#_]); } sub environment_vars_string_for { - my $self = _legacy(@_); + my $self = $_[0]->new->activate($_[1]); + $self->environment_vars_string; +} +sub environment_vars_string { + my ($self, $shelltype) = @_; - my $build_method = 'build_' . $self->shelltype . '_env_declaration'; + $shelltype ||= $self->guess_shelltype; + + my $build_method = "build_${shelltype}_env_declaration"; my @envs = ( PATH => $self->bins, @@ -313,69 +352,108 @@ sub environment_vars_string_for { && ${$value->[0]} eq $name) { next; } - if (!ref $value - && defined $value ? $value eq $ENV{$name} : !defined $ENV{$name} + if ( + !ref $value + and defined $value + ? (defined $ENV{$name} && $value eq $ENV{$name}) + : !defined $ENV{$name} ) { next; } $out .= $self->$build_method($name, $value); } + my $wrap_method = 'wrap_' . $self->shelltype . '_output'; + if ($self->can($wrap_method)) { + return $self->$wrap_method($out); + } return $out; } sub build_bourne_env_declaration { my ($class, $name, $args) = @_; - my $value = $class->_interpolate($args); - $value =~ s/"/\\"/g - if defined $value; - return defined($value) ? qq{export ${name}="${value}"\n} : qq{unset ${name}\n}; + my $value = $class->_interpolate($args, '$%s', '"', '\\%s'); + + if (!defined $value) { + return qq{unset $name;\n}; + } + + $value =~ s/(^|\G|$_path_sep)\$$name$_path_sep/$1\$$name\${$name+$_path_sep}/g; + $value =~ s/$_path_sep\$$name$/\${$name+$_path_sep}\$$name/; + + qq{export ${name}="$value";\n} } + sub build_csh_env_declaration { my ($class, $name, $args) = @_; - my ($value, @vars) = $class->_interpolate($args); - @vars = grep { $_ ne $name || defined $value } @vars; - $value =~ s/"/"\\""/g - if defined $value; - join '', - (map qq{if ! \$?$_ setenv $_ "";\n}, @vars), - (defined($value) - ? qq{setenv $name "$value";\n} - : qq{unsetenv $name;\n}); + my ($value, @vars) = $class->_interpolate($args, '$%s', '"', '"\\%s"'); + if (!defined $value) { + return qq{unsetenv $name;\n}; + } + + my $out = ''; + for my $var (@vars) { + $out .= qq{if ! \$?$name setenv $name '';\n}; + } + + my $value_without = $value; + if ($value_without =~ s/(?:^|$_path_sep)\$$name(?:$_path_sep|$)//g) { + $out .= qq{if "\$$name" != '' setenv $name "$value";\n}; + $out .= qq{if "\$$name" == '' }; + } + $out .= qq{setenv $name "$value_without";\n}; + return $out; } + sub build_cmd_env_declaration { my ($class, $name, $args) = @_; - my $value = $class->_interpolate($args, '%', '%'); - $value =~ s/"/\\"/g - if defined $value; - return qq{set $name=} . (defined($value) ? qq{"$value"} : '') . "\n"; + my $value = $class->_interpolate($args, '%%%s%%', qr([()!^"<>&|]), '^%s'); + if (!$value) { + return qq{\@set $name=\n}; + } + + my $out = ''; + my $value_without = $value; + if ($value_without =~ s/(?:^|$_path_sep)%$name%(?:$_path_sep|$)//g) { + $out .= qq{\@if not "%$name%"=="" set $name=$value\n}; + $out .= qq{\@if "%$name%"=="" }; + } + $out .= qq{\@set $name=$value_without\n}; + return $out; } + sub build_powershell_env_declaration { my ($class, $name, $args) = @_; - my $value = $class->_interpolate($args, '$env:'); - if (defined $value) { - $value =~ s/"/\\"/g; - return qq{\$env:$name = "$value"\n}; + my $value = $class->_interpolate($args, '$env:%s', '"', '`%s'); + + if (!$value) { + return qq{Remove-Item Env:\\$name;\n}; } - return "Remove-Item Env:\\$name\n"; -} + my $maybe_path_sep = qq{\$(if("\$env:$name"-eq""){""}else{"$_path_sep"})}; + $value =~ s/(^|\G|$_path_sep)\$env:$name$_path_sep/$1\$env:$name"+$maybe_path_sep+"/g; + $value =~ s/$_path_sep\$env:$name$/"+$maybe_path_sep+\$env:$name+"/; + + qq{\$env:$name = \$("$value");\n}; +} +sub wrap_powershell_output { + my ($class, $out) = @_; + return $out || " \n"; +} sub _interpolate { - my ($class, $args, $start, $end) = @_; + my ($class, $args, $var_pat, $escape, $escape_pat) = @_; return unless defined $args; - return $args - unless ref $args; + my @args = ref $args ? @$args : $args; return - unless @$args; - $start = '$' unless defined $start; - $end = '' unless defined $end; - my @vars; - my $string = join($Config{path_sep}, map { - (ref $_ && ref $_ eq 'SCALAR') ? do { push @vars, $$_; $start.$$_.$end } - : $_ - } @$args); - return wantarray ? ($string, @vars) : $string; + unless @args; + my @vars = map { $$_ } grep { ref $_ eq 'SCALAR' } @args; + my $string = join $_path_sep, map { + ref $_ eq 'SCALAR' ? sprintf($var_pat, $$_) : do { + s/($escape)/sprintf($escape_pat, $1)/ge; $_; + }; + } @args; + return wantarray ? ($string, \@vars) : $string; } sub pipeline; @@ -534,12 +612,12 @@ sub guess_shelltype { for ($shellbin) { return - /csh/ ? 'csh' - : /command\.com/ ? 'cmd' - : /cmd\.exe/ ? 'cmd' - : /4nt\.exe/ ? 'cmd' - : /powershell\.exe/ ? 'powershell' - : 'bourne'; + /csh/ ? 'csh' + : /command\.com/i ? 'cmd' + : /cmd\.exe/i ? 'cmd' + : /4nt\.exe/i ? 'cmd' + : /powershell\.exe/i ? 'powershell' + : 'bourne'; } } @@ -625,7 +703,7 @@ If you are using C shell, you can do this as follows: /bin/csh echo $SHELL /bin/csh - perl -I$HOME/perl5/lib/perl5 -Mlocal::lib >> ~/.cshrc + echo 'eval `perl -I$HOME/perl5/lib/perl5 -Mlocal::lib`' >> ~/.cshrc If you passed to bootstrap a directory other than default, you also need to give that as import parameter to the call of the local::lib module like this @@ -703,7 +781,7 @@ C, you can use this: C:\>perl -Mlocal::lib > %TEMP%\tmp.bat && %TEMP%\tmp.bat && del %TEMP%\tmp.bat ### instead of $(perl -Mlocal::lib=./) -If you want the environment entries to persist, you'll need to add then to the +If you want the environment entries to persist, you'll need to add them to the Control Panel's System applet yourself or use L. The "~" is translated to the user's profile directory (the directory named for @@ -712,6 +790,13 @@ the user under "Documents and Settings" (Windows XP or earlier) or "Users" directory is translated to a short name (which means the directory must exist) and the subdirectories are created. +=head3 PowerShell + +local::lib also supports PowerShell, and an be used with the +C cmdlet. + + Invoke-Expression "$(perl -Mlocal::lib)" + =head1 RATIONALE The version of a Perl package on your machine is not always the version you @@ -762,6 +847,8 @@ values: =item PATH +=item PERL_LOCAL_LIB_ROOT + =back When possible, these will be appended to instead of overwritten entirely. @@ -774,7 +861,7 @@ See L for one way to do this - but note that there are a number of caveats, and the best approach is always to perform a build against a clean perl (i.e. site and vendor as close to empty as possible). -=head1 OPTIONS +=head1 IMPORT OPTIONS Options are values that can be passed to the C import besides the directory to use. They are specified as C @@ -801,7 +888,7 @@ C, or C. Prevents C from creating directories when activating dirs. This is likely to cause issues on Win32 systems. -=head1 METHODS +=head1 CLASS METHODS =head2 ensure_dir_structure_for @@ -883,6 +970,20 @@ Returns a path describing where to install the Perl modules for this local library installation. Appends the directories C and C to the given path. +=head2 lib_paths_for + +=over 4 + +=item Arguments: $path + +=item Return value: @lib_paths + +=back + +Returns the list of paths perl will search for libraries, given a base path. +This includes the base path itself, the architecture specific subdirectory, and +perl version specific subdirectories. These paths may not all exist. + =head2 install_base_bin_path =over 4 @@ -896,6 +997,19 @@ path. Returns a path describing where to install the executable programs for this local library installation. Appends the directory C to the given path. +=head2 installer_options_for + +=over 4 + +=item Arguments: $path + +=item Return value: %installer_env_vars + +=back + +Returns a hash of environment variables that should be set to cause +installation into the given path. + =head2 resolve_empty_path =over 4 @@ -953,6 +1067,141 @@ L, which then has its result passed to L. The result of this final call is returned from L. +=head1 OBJECT INTERFACE + +=head2 new + +=over 4 + +=item Arguments: %attributes + +=item Return value: $local_lib + +=back + +Constructs a new C object, representing the current state of +C<@INC> and the relevant environment variables. + +=head1 ATTRIBUTES + +=head2 roots + +An arrayref representing active C directories. + +=head2 inc + +An arrayref representing C<@INC>. + +=head2 libs + +An arrayref representing the PERL5LIB environment variable. + +=head2 bins + +An arrayref representing the PATH environment variable. + +=head2 extra + +A hashref of extra environment variables (e.g. C and +C) + +=head2 no_create + +If set, C will not try to create directories when activating them. + +=head1 OBJECT METHODS + +=head2 clone + +=over 4 + +=item Arguments: %attributes + +=item Return value: $local_lib + +=back + +Constructs a new C object based on the existing one, overriding the +specified attributes. + +=head2 activate + +=over 4 + +=item Arguments: $path + +=item Return value: $new_local_lib + +=back + +Constructs a new instance with the specified path active. + +=head2 deactivate + +=over 4 + +=item Arguments: $path + +=item Return value: $new_local_lib + +=back + +Constructs a new instance with the specified path deactivated. + +=head2 deactivate_all + +=over 4 + +=item Arguments: None + +=item Return value: $new_local_lib + +=back + +Constructs a new instance with all C directories deactivated. + +=head2 environment_vars_string + +=over 4 + +=item Arguments: [ $shelltype ] + +=item Return value: $shell_env_string + +=back + +Returns a string to set up the C, meant to be run by a shell. + +=head2 build_environment_vars + +=over 4 + +=item Arguments: None + +=item Return value: %environment_vars + +=back + +Returns a hash with the variables listed above, properly set to use the +given path as the base directory. + +=head2 setup_env_hash + +=over 4 + +=item Arguments: None + +=item Return value: None + +=back + +Constructs the C<%ENV> keys for the given path, by calling +L. + +=head2 setup_local_lib + +Constructs the C<%ENV> hash using L, and set up C<@INC>. + =head1 A WARNING ABOUT UNINST=1 Be careful about using local::lib in combination with "make install UNINST=1".