X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2Flocal%2Flib.pm;h=dd3d5da0ccf247f70ca2f6833f597961f7c81e9c;hb=99f8e6214f8afd8719c787b29230f3d04d3e8d86;hp=ee326e5c9c55fea23bdcc5882ff09a2b439ce639;hpb=71f1f1db30a1f5360d0694dcccca74fd55338b4a;p=p5sagit%2Flocal-lib.git diff --git a/lib/local/lib.pm b/lib/local/lib.pm old mode 100755 new mode 100644 index ee326e5..dd3d5da --- a/lib/local/lib.pm +++ b/lib/local/lib.pm @@ -11,9 +11,15 @@ use File::Path (); use Carp (); use Config; -our $VERSION = '1.006003'; # 1.6.3 +our $VERSION = '1.008003'; # 1.8.3 -our @KNOWN_FLAGS = qw(--self-contained); +our @KNOWN_FLAGS = qw(--self-contained --deactivate --deactivate-all); + +sub DEACTIVATE_ONE () { 1 } +sub DEACTIVATE_ALL () { 2 } + +sub INTERPOLATE_ENV () { 1 } +sub LITERAL_ENV () { 0 } sub import { my ($class, @args) = @_; @@ -51,8 +57,16 @@ DEATH 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"; } + my $deactivating = 0; + if ($arg_store{deactivate}) { + $deactivating = DEACTIVATE_ONE; + } + if ($arg_store{'deactivate-all'}) { + $deactivating = DEACTIVATE_ALL; + } + $arg_store{path} = $class->resolve_path($arg_store{path}); - $class->setup_local_lib_for($arg_store{path}); + $class->setup_local_lib_for($arg_store{path}, $deactivating); for (@INC) { # Untaint @INC next if ref; # Skip entry if it is an ARRAY, CODE, blessed, etc. @@ -188,22 +202,36 @@ is($c->resolve_relative_path('bar'),'FOObar'); =cut sub setup_local_lib_for { - my ($class, $path) = @_; + my ($class, $path, $deactivating) = @_; + + my $interpolate = LITERAL_ENV; + my @active_lls = $class->active_paths; + + if (! $deactivating) { + if (@active_lls && $active_lls[-1] eq $path) { + exit 0 if $0 eq '-'; + return; # Asked to add what's already at the top of the stack + } elsif (grep { $_ eq $path} @active_lls) { + # Asked to add a dir that's lower in the stack -- so we remove it from + # where it is, and then add it back at the top. + $class->setup_env_hash_for($path, DEACTIVATE_ONE); + # Which means we can no longer output "PERL5LIB=...:$PERL5LIB" stuff + # anymore because we're taking something *out*. + $interpolate = INTERPOLATE_ENV; + } + } + $path = $class->ensure_dir_structure_for($path); + if ($0 eq '-') { - $class->print_environment_vars_for($path); + $class->print_environment_vars_for($path, $deactivating, $interpolate); exit 0; } else { - $class->setup_env_hash_for($path); + $class->setup_env_hash_for($path, $deactivating); @INC = _uniq(split($Config{path_sep}, $ENV{PERL5LIB}), @INC); } } -sub modulebuildrc_path { - my ($class, $path) = @_; - File::Spec->catfile($path, '.modulebuildrc'); -} - sub install_base_bin_path { my ($class, $path) = @_; File::Spec->catdir($path, 'bin'); @@ -228,37 +256,11 @@ sub ensure_dir_structure_for { # Need to have the path exist to make a short name for it, so # converting to a short name here. $path = Win32::GetShortPathName($path) if $^O eq 'MSWin32'; - my $modulebuildrc_path = $class->modulebuildrc_path($path); - if (-e $modulebuildrc_path) { - unless (-f _) { - Carp::croak("${modulebuildrc_path} exists but is not a plain file"); - } - } else { - warn "Attempting to create file ${modulebuildrc_path}\n"; - open MODULEBUILDRC, '>', $modulebuildrc_path - || Carp::croak("Couldn't open ${modulebuildrc_path} for writing: $!"); - print MODULEBUILDRC qq{install --install_base ${path}\n} - || Carp::croak("Couldn't write line to ${modulebuildrc_path}: $!"); - close MODULEBUILDRC - || Carp::croak("Couldn't close file ${modulebuildrc_path}: $@"); - } return $path; } -sub INTERPOLATE_ENV () { 1 } -sub LITERAL_ENV () { 0 } - -sub print_environment_vars_for { - my ($class, $path) = @_; - my @envs = $class->build_environment_vars_for($path, LITERAL_ENV); - my $out = ''; - - # rather basic csh detection, goes on the assumption that something won't - # call itself csh unless it really is. also, default to bourne in the - # pathological situation where a user doesn't have $ENV{SHELL} defined. - # note also that shells with funny names, like zoid, are assumed to be - # bourne. +sub guess_shelltype { my $shellbin = 'sh'; if(defined $ENV{'SHELL'}) { my @shell_bin_path_parts = File::Spec->splitpath($ENV{'SHELL'}); @@ -290,13 +292,33 @@ sub print_environment_vars_for { } }; } + return $shelltype; +} + +sub print_environment_vars_for { + my ($class, $path, $deactivating, $interpolate) = @_; + print $class->environment_vars_string_for($path, $deactivating, $interpolate); +} + +sub environment_vars_string_for { + my ($class, $path, $deactivating, $interpolate) = @_; + my @envs = $class->build_environment_vars_for($path, $deactivating, $interpolate); + my $out = ''; + + # rather basic csh detection, goes on the assumption that something won't + # call itself csh unless it really is. also, default to bourne in the + # pathological situation where a user doesn't have $ENV{SHELL} defined. + # note also that shells with funny names, like zoid, are assumed to be + # bourne. + + my $shelltype = $class->guess_shelltype; while (@envs) { my ($name, $value) = (shift(@envs), shift(@envs)); - $value =~ s/(\\")/\\$1/g; + $value =~ s/(\\")/\\$1/g if defined $value; $out .= $class->${\"build_${shelltype}_env_declaration"}($name, $value); } - print $out; + return $out; } # simple routines that take two arguments: an %ENV key and a value. return @@ -305,31 +327,52 @@ sub print_environment_vars_for { sub build_bourne_env_declaration { my $class = shift; my($name, $value) = @_; - return qq{export ${name}="${value}"\n}; + return defined($value) ? qq{export ${name}="${value}";\n} : qq{unset ${name};\n}; } sub build_csh_env_declaration { my $class = shift; my($name, $value) = @_; - return qq{setenv ${name} "${value}"\n}; + return defined($value) ? qq{setenv ${name} "${value}"\n} : qq{unsetenv ${name}\n}; } sub build_win32_env_declaration { my $class = shift; my($name, $value) = @_; - return qq{set ${name}=${value}\n}; + return defined($value) ? qq{set ${name}=${value}\n} : qq{set ${name}=\n}; } sub setup_env_hash_for { - my ($class, $path) = @_; - my %envs = $class->build_environment_vars_for($path, INTERPOLATE_ENV); + my ($class, $path, $deactivating) = @_; + my %envs = $class->build_environment_vars_for($path, $deactivating, INTERPOLATE_ENV); @ENV{keys %envs} = values %envs; } sub build_environment_vars_for { + my ($class, $path, $deactivating, $interpolate) = @_; + + if ($deactivating == DEACTIVATE_ONE) { + return $class->build_deactivate_environment_vars_for($path, $interpolate); + } elsif ($deactivating == DEACTIVATE_ALL) { + return $class->build_deact_all_environment_vars_for($path, $interpolate); + } else { + return $class->build_activate_environment_vars_for($path, $interpolate); + } +} + +sub build_activate_environment_vars_for { my ($class, $path, $interpolate) = @_; return ( - MODULEBUILDRC => $class->modulebuildrc_path($path), + PERL_LOCAL_LIB_ROOT => join($Config{path_sep}, + (($ENV{PERL_LOCAL_LIB_ROOT}||()) ? + ($interpolate == INTERPOLATE_ENV + ? ($ENV{PERL_LOCAL_LIB_ROOT}||()) + : (($^O ne 'MSWin32') ? '$PERL_LOCAL_LIB_ROOT' + : '%PERL_LOCAL_LIB_ROOT%' )) + : ()), + $path + ), + PERL_MB_OPT => "--install_base ${path}", PERL_MM_OPT => "INSTALL_BASE=${path}", PERL5LIB => join($Config{path_sep}, $class->install_base_arch_path($path), @@ -349,6 +392,94 @@ sub build_environment_vars_for { ) } +sub active_paths { + my ($class) = @_; + + return () unless defined $ENV{PERL_LOCAL_LIB_ROOT}; + return split /\Q$Config{path_sep}/, $ENV{PERL_LOCAL_LIB_ROOT}; +} + +sub build_deactivate_environment_vars_for { + my ($class, $path, $interpolate) = @_; + + my @active_lls = $class->active_paths; + + if (!grep { $_ eq $path } @active_lls) { + warn "Tried to deactivate inactive local::lib '$path'\n"; + return (); + } + + my @new_ll_root = grep { $_ ne $path } @active_lls; + my @new_perl5lib = grep { + $_ ne $class->install_base_arch_path($path) && + $_ ne $class->install_base_perl_path($path) + } split /\Q$Config{path_sep}/, $ENV{PERL5LIB}; + + my %env = ( + PERL_LOCAL_LIB_ROOT => (@new_ll_root ? + join($Config{path_sep}, @new_ll_root) : undef + ), + PERL5LIB => (@new_perl5lib ? + join($Config{path_sep}, @new_perl5lib) : undef + ), + PATH => join($Config{path_sep}, + grep { $_ ne $class->install_base_bin_path($path) } + split /\Q$Config{path_sep}/, $ENV{PATH} + ), + ); + + # If removing ourselves from the "top of the stack", set install paths to + # correspond with the new top of stack. + if ($active_lls[-1] eq $path) { + if (@active_lls > 1) { + my $new_top = $active_lls[-2]; + %env = (%env, + PERL_MB_OPT => "--install_base ${new_top}", + PERL_MM_OPT => "INSTALL_BASE=${new_top}", + ); + } else { + %env = (%env, + PERL_MB_OPT => undef, + PERL_MM_OPT => undef, + ); + } + } + + return %env; +} + +sub build_deact_all_environment_vars_for { + my ($class, $path, $interpolate) = @_; + + my @active_lls = $class->active_paths; + + my @new_perl5lib = split /\Q$Config{path_sep}/, $ENV{PERL5LIB}; + my @new_path = split /\Q$Config{path_sep}/, $ENV{PATH}; + + for my $path (@active_lls) { + @new_perl5lib = grep { + $_ ne $class->install_base_arch_path($path) && + $_ ne $class->install_base_perl_path($path) + } @new_perl5lib; + + @new_path = grep { + $_ ne $class->install_base_bin_path($path) + } @new_path; + } + + my %env = ( + PERL_LOCAL_LIB_ROOT => undef, + PERL_MM_OPT => undef, + PERL_MB_OPT => undef, + PERL5LIB => (@new_perl5lib ? + join($Config{path_sep}, @new_perl5lib) : undef + ), + PATH => join($Config{path_sep}, @new_path), + ); + + return %env; +} + =begin testing #:: test classmethod @@ -359,8 +490,6 @@ $c->ensure_dir_structure_for('t/var/splat'); ok(-d 't/var/splat'); -ok(-f 't/var/splat/.modulebuildrc'); - =end testing =encoding utf8 @@ -388,10 +517,10 @@ From the shell - # Just print out useful shell commands $ perl -Mlocal::lib - export MODULEBUILDRC=/home/username/perl/.modulebuildrc - export PERL_MM_OPT='INSTALL_BASE=/home/username/perl' - export PERL5LIB='/home/username/perl/lib/perl5:/home/username/perl/lib/perl5/i386-linux' - export PATH="/home/username/perl/bin:$PATH" + export PERL_MB_OPT='--install_base /home/username/perl5' + export PERL_MM_OPT='INSTALL_BASE=/home/username/perl5' + export PERL5LIB='/home/username/perl5/lib/perl5/i386-linux:/home/username/perl5/lib/perl5' + export PATH="/home/username/perl5/bin:$PATH" =head2 The bootstrapping technique @@ -405,6 +534,8 @@ environment variables, as discussed in step 4. Without this, you would still install the modules into the system CPAN installation and also your Perl scripts will not use the lib/ path you bootstrapped with local::lib. +By default local::lib installs itself and the CPAN modules into ~/perl5. + Windows users must also see L. 1. Download and unpack the local::lib tarball from CPAN (search for "Download" @@ -419,8 +550,8 @@ convenient location. If the system asks you whether it should automatically configure as much as possible, you would typically answer yes. -In order to install local::lib into a directory other than default, you need -to give that directory on the call of bootstrap like this: +In order to install local::lib into a directory other than the default, you need +to specify the name of the directory when you call bootstrap, as follows: perl Makefile.PL --bootstrap=~/foo @@ -470,6 +601,22 @@ installation to install modules in different directories directly this way: cd ../mydir2 ... REPEAT ... +If you are working with several C environments, you may want to +remove some of them from the current environment without disturbing the others. +You can deactivate one environment like this (using bourne sh): + + eval $(perl -Mlocal::lib=--deactivate,~/path) + +which will generate and run the commands needed to remove C<~/path> from your +various search paths. Whichever environment was B will +remain the target for module installations. That is, if you activate +C<~/path_A> and then you activate C<~/path_B>, new modules you install will go +in C<~/path_B>. If you deactivate C<~/path_B> then modules will be installed +into C<~/pathA> -- but if you deactivate C<~/path_A> then they will still be +installed in C<~/pathB> because pathB was activated later. + +You can also ask C to clean itself completely out of the current +shell's environment with the C<--deactivate-all> option. For multiple environments for multiple apps you may need to include a modified version of the C<< use FindBin >> instructions in the "In code" sample above. If you did something like the above, you have a set of Perl modules at C<< @@ -492,7 +639,7 @@ To set up the proper environment variables for your current session of C, you can use this: C:\>perl -Mlocal::lib - set MODULEBUILDRC=C:\DOCUME~1\ADMINI~1\perl5\.modulebuildrc + set PERL_MB_OPT=--install_base C:\DOCUME~1\ADMINI~1\perl5 set PERL_MM_OPT=INSTALL_BASE=C:\DOCUME~1\ADMINI~1\perl5 set PERL5LIB=C:\DOCUME~1\ADMINI~1\perl5\lib\perl5;C:\DOCUME~1\ADMINI~1\perl5\lib\perl5\MSWin32-x86-multi-thread set PATH=C:\DOCUME~1\ADMINI~1\perl5\bin;%PATH% @@ -506,7 +653,7 @@ Control Panel's System applet yourself or use L. The "~" is translated to the user's profile directory (the directory named for the user under "Documents and Settings" (Windows XP or earlier) or "Users" -(Windows Vista or later) unless $ENV{HOME} exists. After that, the home +(Windows Vista or later)) unless $ENV{HOME} exists. After that, the home directory is translated to a short name (which means the directory must exist) and the subdirectories are created. @@ -552,7 +699,7 @@ values: =over 4 -=item MODULEBUILDRC +=item PERL_MB_OPT =item PERL_MM_OPT @@ -568,17 +715,35 @@ These values are then available for reference by any code after import. =head1 CREATING A SELF-CONTAINED SET OF MODULES -See L for one way to do this - but note that +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 + +Options are values that can be passed to the C import besides the +directory to use. They are specified as C +or C. + +=head2 --deactivate + +Remove the chosen path (or the default path) from the module search paths if it +was added by C, instead of adding it. + +=head2 --deactivate-all + +Remove all directories that were added to search paths by C from the +search paths. + =head1 METHODS -=head2 ensure_directory_structure_for +=head2 ensure_dir_structure_for =over 4 -=item Arguments: path +=item Arguments: $path + +=item Return value: None =back @@ -589,29 +754,61 @@ an exception on failure. =over 4 -=item Arguments: path +=item Arguments: $path + +=item Return value: None =back Prints to standard output the variables listed above, properly set to use the given path as the base directory. +=head2 build_environment_vars_for + +=over 4 + +=item Arguments: $path, $interpolate + +=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_for =over 4 -=item Arguments: path +=item Arguments: $path + +=item Return value: None =back Constructs the C<%ENV> keys for the given path, by calling -C. +L. + +=head2 active_paths + +=over 4 + +=item Arguments: None + +=item Return value: @paths + +=back + +Returns a list of active C paths, according to the +C environment variable. =head2 install_base_perl_path =over 4 -=item Arguments: path +=item Arguments: $path + +=item Return value: $install_base_perl_path =back @@ -623,7 +820,9 @@ path. =over 4 -=item Arguments: path +=item Arguments: $path + +=item Return value: $install_base_arch_path =back @@ -636,7 +835,9 @@ C<$Config{archname}>. =over 4 -=item Arguments: path +=item Arguments: $path + +=item Return value: $install_base_bin_path =back @@ -644,22 +845,13 @@ Returns a path describing where to install the executable programs for this local library installation. Based on the L method's return value, and appends the directory C. -=head2 modulebuildrc_path - -=over 4 - -=item Arguments: path - -=back - -Returns a path describing where to install the C<.modulebuildrc> file, based on -the given path. - =head2 resolve_empty_path =over 4 -=item Arguments: path +=item Arguments: $path + +=item Return value: $base_path =back @@ -670,7 +862,9 @@ installation. Defaults to C<~/perl5>. =over 4 -=item Arguments: path +=item Arguments: $path + +=item Return value: $home_path =back @@ -681,7 +875,9 @@ for this purpose. If no definite answer is available, throws an exception. =over 4 -=item Arguments: path +=item Arguments: $path + +=item Return value: $absolute_path =back @@ -691,7 +887,9 @@ Translates the given path into an absolute path. =over 4 -=item Arguments: path +=item Arguments: $path + +=item Return value: $absolute_path =back @@ -716,6 +914,12 @@ install UNINST=1" and local::lib if you understand these possible consequences. =head1 LIMITATIONS +The perl toolchain is unable to handle directory names with spaces in it, +so you cant put your local::lib bootstrap into a directory with spaces. What +you can do is moving your local::lib to a directory with spaces B you +installed all modules inside your local::lib bootstrap. But be aware that you +cant update or install CPAN modules after the move. + Rather basic shell detection. Right now anything with csh in its name is assumed to be a C shell or something compatible, and everything else is assumed to be Bourne, except on Win32 systems. If the C environment variable is @@ -724,7 +928,7 @@ not set, a Bourne-compatible shell is assumed. Bootstrap is a hack and will use CPAN.pm for ExtUtils::MakeMaker even if you have CPANPLUS installed. -Kills any existing PERL5LIB, PERL_MM_OPT or MODULEBUILDRC. +Kills any existing PERL5LIB, PERL_MM_OPT or PERL_MB_OPT. Should probably auto-fixup CPAN config if not already done. @@ -764,6 +968,12 @@ On Win32 systems, C is also examined. =back +=head1 SUPPORT + +IRC: + + Join #local-lib on irc.perl.org. + =head1 AUTHOR Matt S Trout http://www.shadowcat.co.uk/ @@ -775,7 +985,8 @@ auto_install fixes kindly sponsored by http://www.takkle.com/ Patches to correctly output commands for csh style shells, as well as some documentation additions, contributed by Christopher Nehren . -Doc patches for a custom local::lib directory contributed by Torsten Raudssus +Doc patches for a custom local::lib directory, more cleanups in the english +documentation and a L contributed by Torsten Raudssus . Hans Dieter Pearcey sent in some additional tests for ensuring @@ -798,9 +1009,15 @@ Mark Stosberg provided the code for the now deleted Documentation patches to make win32 usage clearer by David Mertens (run4flat). +Brazilian L and minor doc patches contributed by Breno +G. de Oliveira . + +Improvements to stacking multiple local::lib dirs and removing them from the +environment later on contributed by Andrew Rodland . + =head1 COPYRIGHT -Copyright (c) 2007 - 2009 the local::lib L and L as +Copyright (c) 2007 - 2010 the local::lib L and L as listed above. =head1 LICENSE