6 use 5.008001; # probably works with earlier versions but I'm not supporting them
7 # (patches would, of course, be welcome)
14 our $VERSION = '1.007000'; # 1.7.0
16 our @KNOWN_FLAGS = qw(--self-contained);
19 my ($class, @args) = @_;
21 # Remember what PERL5LIB was when we started
22 my $perl5lib = $ENV{PERL5LIB} || '';
26 # check for lethal dash first to stop processing before causing problems
29 WHOA THERE! It looks like you've got some fancy dashes in your commandline!
30 These are *not* the traditional -- dashes that software recognizes. You
31 probably got these by copy-pasting from the perldoc for this module as
32 rendered by a UTF8-capable formatter. This most typically happens on an OS X
33 terminal, but can happen elsewhere too. Please try again after replacing the
34 dashes with normal minus signs.
37 elsif(grep { $arg eq $_ } @KNOWN_FLAGS) {
38 (my $flag = $arg) =~ s/--//;
39 $arg_store{$flag} = 1;
41 elsif($arg =~ /^--/) {
42 die "Unknown import argument: $arg";
45 # assume that what's left is a path
46 $arg_store{path} = $arg;
50 if($arg_store{'self-contained'}) {
51 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";
54 $arg_store{path} = $class->resolve_path($arg_store{path});
55 $class->setup_local_lib_for($arg_store{path});
57 for (@INC) { # Untaint @INC
58 next if ref; # Skip entry if it is an ARRAY, CODE, blessed, etc.
67 my $last = pop(@methods);
70 my ($obj, @args) = @_;
71 $obj->${pipeline @methods}(
88 { package Foo; sub foo { -$_[1] } sub bar { $_[1]+2 } sub baz { $_[1]+3 } }
89 my $foo = bless({}, 'Foo');
90 Test::More::ok($foo->${pipeline qw(foo bar baz)}(10) == -15);
98 grep { ! $seen{$_}++ } @_;
102 my ($class, $path) = @_;
103 $class->${pipeline qw(
104 resolve_relative_path
110 sub resolve_empty_path {
111 my ($class, $path) = @_;
121 #:: test classmethod setup
123 my $c = 'local::lib';
131 is($c->resolve_empty_path, '~/perl5');
132 is($c->resolve_empty_path('foo'), 'foo');
138 sub resolve_home_path {
139 my ($class, $path) = @_;
140 return $path unless ($path =~ /^~/);
141 my ($user) = ($path =~ /^~([^\/]+)/); # can assume ^~ so undef for 'us'
142 my $tried_file_homedir;
144 if (eval { require File::HomeDir } && $File::HomeDir::VERSION >= 0.65) {
145 $tried_file_homedir = 1;
147 File::HomeDir->users_home($user);
149 File::HomeDir->my_home;
155 if (defined $ENV{HOME}) {
163 unless (defined $homedir) {
165 "Couldn't resolve homedir for "
166 .(defined $user ? $user : 'current user')
167 .($tried_file_homedir ? '' : ' - consider installing File::HomeDir')
170 $path =~ s/^~[^\/]*/$homedir/;
174 sub resolve_relative_path {
175 my ($class, $path) = @_;
176 $path = File::Spec->rel2abs($path);
183 local *File::Spec::rel2abs = sub { shift; 'FOO'.shift; };
184 is($c->resolve_relative_path('bar'),'FOObar');
190 sub setup_local_lib_for {
191 my ($class, $path) = @_;
192 $path = $class->ensure_dir_structure_for($path);
194 $class->print_environment_vars_for($path);
197 $class->setup_env_hash_for($path);
198 @INC = _uniq(split($Config{path_sep}, $ENV{PERL5LIB}), @INC);
202 sub install_base_bin_path {
203 my ($class, $path) = @_;
204 File::Spec->catdir($path, 'bin');
207 sub install_base_perl_path {
208 my ($class, $path) = @_;
209 File::Spec->catdir($path, 'lib', 'perl5');
212 sub install_base_arch_path {
213 my ($class, $path) = @_;
214 File::Spec->catdir($class->install_base_perl_path($path), $Config{archname});
217 sub ensure_dir_structure_for {
218 my ($class, $path) = @_;
220 warn "Attempting to create directory ${path}\n";
222 File::Path::mkpath($path);
223 # Need to have the path exist to make a short name for it, so
224 # converting to a short name here.
225 $path = Win32::GetShortPathName($path) if $^O eq 'MSWin32';
230 sub INTERPOLATE_ENV () { 1 }
231 sub LITERAL_ENV () { 0 }
233 sub guess_shelltype {
235 if(defined $ENV{'SHELL'}) {
236 my @shell_bin_path_parts = File::Spec->splitpath($ENV{'SHELL'});
237 $shellbin = $shell_bin_path_parts[-1];
240 local $_ = $shellbin;
248 # Both Win32 and Cygwin have $ENV{COMSPEC} set.
249 if (defined $ENV{'COMSPEC'} && $^O ne 'cygwin') {
250 my @shell_bin_path_parts = File::Spec->splitpath($ENV{'COMSPEC'});
251 $shellbin = $shell_bin_path_parts[-1];
253 local $_ = $shellbin;
256 } elsif(/cmd\.exe/) {
258 } elsif(/4nt\.exe/) {
268 sub print_environment_vars_for {
269 my ($class, $path) = @_;
270 my @envs = $class->build_environment_vars_for($path, LITERAL_ENV);
273 # rather basic csh detection, goes on the assumption that something won't
274 # call itself csh unless it really is. also, default to bourne in the
275 # pathological situation where a user doesn't have $ENV{SHELL} defined.
276 # note also that shells with funny names, like zoid, are assumed to be
279 my $shelltype = $class->guess_shelltype;
282 my ($name, $value) = (shift(@envs), shift(@envs));
283 $value =~ s/(\\")/\\$1/g;
284 $out .= $class->${\"build_${shelltype}_env_declaration"}($name, $value);
289 # simple routines that take two arguments: an %ENV key and a value. return
290 # strings that are suitable for passing directly to the relevant shell to set
291 # said key to said value.
292 sub build_bourne_env_declaration {
294 my($name, $value) = @_;
295 return qq{export ${name}="${value}"\n};
298 sub build_csh_env_declaration {
300 my($name, $value) = @_;
301 return qq{setenv ${name} "${value}"\n};
304 sub build_win32_env_declaration {
306 my($name, $value) = @_;
307 return qq{set ${name}=${value}\n};
310 sub setup_env_hash_for {
311 my ($class, $path) = @_;
312 my %envs = $class->build_environment_vars_for($path, INTERPOLATE_ENV);
313 @ENV{keys %envs} = values %envs;
316 sub build_environment_vars_for {
317 my ($class, $path, $interpolate) = @_;
319 PERL_LOCAL_LIB_ROOT => $path,
320 PERL_MB_OPT => "--install_base ${path}",
321 PERL_MM_OPT => "INSTALL_BASE=${path}",
322 PERL5LIB => join($Config{path_sep},
323 $class->install_base_arch_path($path),
324 $class->install_base_perl_path($path),
325 (($ENV{PERL5LIB}||()) ?
326 ($interpolate == INTERPOLATE_ENV
328 : (($^O ne 'MSWin32') ? '$PERL5LIB' : '%PERL5LIB%' ))
331 PATH => join($Config{path_sep},
332 $class->install_base_bin_path($path),
333 ($interpolate == INTERPOLATE_ENV
335 : (($^O ne 'MSWin32') ? '$PATH' : '%PATH%' ))
344 File::Path::rmtree('t/var/splat');
346 $c->ensure_dir_structure_for('t/var/splat');
348 ok(-d 't/var/splat');
356 local::lib - create and use a local lib/ for perl modules with PERL5LIB
362 use local::lib; # sets up a local lib at ~/perl5
364 use local::lib '~/foo'; # same, but ~/foo
368 use local::lib "$FindBin::Bin/../support"; # app-local support library
372 # Install LWP and its missing dependencies to the '~/perl5' directory
373 perl -MCPAN -Mlocal::lib -e 'CPAN::install(LWP)'
375 # Just print out useful shell commands
377 export PERL_MB_OPT='--install_base /home/username/perl5'
378 export PERL_MM_OPT='INSTALL_BASE=/home/username/perl5'
379 export PERL5LIB='/home/username/perl5/lib/perl5/i386-linux:/home/username/perl5/lib/perl5'
380 export PATH="/home/username/perl5/bin:$PATH"
382 =head2 The bootstrapping technique
384 A typical way to install local::lib is using what is known as the
385 "bootstrapping" technique. You would do this if your system administrator
386 hasn't already installed local::lib. In this case, you'll need to install
387 local::lib in your home directory.
389 If you do have administrative privileges, you will still want to set up your
390 environment variables, as discussed in step 4. Without this, you would still
391 install the modules into the system CPAN installation and also your Perl scripts
392 will not use the lib/ path you bootstrapped with local::lib.
394 By default local::lib installs itself and the CPAN modules into ~/perl5.
396 Windows users must also see L</Differences when using this module under Win32>.
398 1. Download and unpack the local::lib tarball from CPAN (search for "Download"
399 on the CPAN page about local::lib). Do this as an ordinary user, not as root
400 or administrator. Unpack the file in your home directory or in any other
405 perl Makefile.PL --bootstrap
407 If the system asks you whether it should automatically configure as much
408 as possible, you would typically answer yes.
410 In order to install local::lib into a directory other than the default, you need
411 to specify the name of the directory when you call bootstrap, as follows:
413 perl Makefile.PL --bootstrap=~/foo
415 3. Run this: (local::lib assumes you have make installed on your system)
417 make test && make install
419 4. Now we need to setup the appropriate environment variables, so that Perl
420 starts using our newly generated lib/ directory. If you are using bash or
421 any other Bourne shells, you can add this to your shell startup script this
424 echo 'eval $(perl -I$HOME/perl5/lib/perl5 -Mlocal::lib)' >>~/.bashrc
426 If you are using C shell, you can do this as follows:
431 perl -I$HOME/perl5/lib/perl5 -Mlocal::lib >> ~/.cshrc
433 If you passed to bootstrap a directory other than default, you also need to give that as
434 import parameter to the call of the local::lib module like this way:
436 echo 'eval $(perl -I$HOME/foo/lib/perl5 -Mlocal::lib=$HOME/foo)' >>~/.bashrc
438 After writing your shell configuration file, be sure to re-read it to get the
439 changed settings into your current shell's environment. Bourne shells use
440 C<. ~/.bashrc> for this, whereas C shells use C<source ~/.cshrc>.
442 If you're on a slower machine, or are operating under draconian disk space
443 limitations, you can disable the automatic generation of manpages from POD when
444 installing modules by using the C<--no-manpages> argument when bootstrapping:
446 perl Makefile.PL --bootstrap --no-manpages
448 To avoid doing several bootstrap for several Perl module environments on the
449 same account, for example if you use it for several different deployed
450 applications independently, you can use one bootstrapped local::lib
451 installation to install modules in different directories directly this way:
455 eval $(perl -Mlocal::lib=./) ### To set the environment for this shell alone
456 printenv ### You will see that ~/mydir1 is in the PERL5LIB
457 perl -MCPAN -e install ... ### whatever modules you want
461 For multiple environments for multiple apps you may need to include a modified
462 version of the C<< use FindBin >> instructions in the "In code" sample above.
463 If you did something like the above, you have a set of Perl modules at C<<
464 ~/mydir1/lib >>. If you have a script at C<< ~/mydir1/scripts/myscript.pl >>,
465 you need to tell it where to find the modules you installed for it at C<<
468 In C<< ~/mydir1/scripts/myscript.pl >>:
472 use local::lib "$FindBin::Bin/.."; ### points to ~/mydir1 and local::lib finds lib
473 use lib "$FindBin::Bin/../lib"; ### points to ~/mydir1/lib
475 Put this before any BEGIN { ... } blocks that require the modules you installed.
477 =head2 Differences when using this module under Win32
479 To set up the proper environment variables for your current session of
480 C<CMD.exe>, you can use this:
482 C:\>perl -Mlocal::lib
483 set PERL_MB_OPT=--install_base C:\DOCUME~1\ADMINI~1\perl5
484 set PERL_MM_OPT=INSTALL_BASE=C:\DOCUME~1\ADMINI~1\perl5
485 set PERL5LIB=C:\DOCUME~1\ADMINI~1\perl5\lib\perl5;C:\DOCUME~1\ADMINI~1\perl5\lib\perl5\MSWin32-x86-multi-thread
486 set PATH=C:\DOCUME~1\ADMINI~1\perl5\bin;%PATH%
488 ### To set the environment for this shell alone
489 C:\>perl -Mlocal::lib > %TEMP%\tmp.bat && %TEMP%\tmp.bat && del %TEMP%\temp.bat
490 ### instead of $(perl -Mlocal::lib=./)
492 If you want the environment entries to persist, you'll need to add then to the
493 Control Panel's System applet yourself or use L<App::local::lib::Win32Helper>.
495 The "~" is translated to the user's profile directory (the directory named for
496 the user under "Documents and Settings" (Windows XP or earlier) or "Users"
497 (Windows Vista or later)) unless $ENV{HOME} exists. After that, the home
498 directory is translated to a short name (which means the directory must exist)
499 and the subdirectories are created.
503 The version of a Perl package on your machine is not always the version you
504 need. Obviously, the best thing to do would be to update to the version you
505 need. However, you might be in a situation where you're prevented from doing
506 this. Perhaps you don't have system administrator privileges; or perhaps you
507 are using a package management system such as Debian, and nobody has yet gotten
508 around to packaging up the version you need.
510 local::lib solves this problem by allowing you to create your own directory of
511 Perl packages downloaded from CPAN (in a multi-user system, this would typically
512 be within your own home directory). The existing system Perl installation is
513 not affected; you simply invoke Perl with special options so that Perl uses the
514 packages in your own local package directory rather than the system packages.
515 local::lib arranges things so that your locally installed version of the Perl
516 packages takes precedence over the system installation.
518 If you are using a package management system (such as Debian), you don't need to
519 worry about Debian and CPAN stepping on each other's toes. Your local version
520 of the packages will be written to an entirely separate directory from those
525 This module provides a quick, convenient way of bootstrapping a user-local Perl
526 module library located within the user's home directory. It also constructs and
527 prints out for the user the list of environment variables using the syntax
528 appropriate for the user's current shell (as specified by the C<SHELL>
529 environment variable), suitable for directly adding to one's shell
532 More generally, local::lib allows for the bootstrapping and usage of a
533 directory containing Perl modules outside of Perl's C<@INC>. This makes it
534 easier to ship an application with an app-specific copy of a Perl module, or
535 collection of modules. Useful in cases like when an upstream maintainer hasn't
536 applied a patch to a module of theirs that you need for your application.
538 On import, local::lib sets the following environment variables to appropriate
551 PATH is appended to, rather than clobbered.
555 These values are then available for reference by any code after import.
557 =head1 CREATING A SELF-CONTAINED SET OF MODULES
559 See L<lib::core::only> for one way to do this - but note that
560 there are a number of caveats, and the best approach is always to perform a
561 build against a clean perl (i.e. site and vendor as close to empty as possible).
565 =head2 ensure_dir_structure_for
569 =item Arguments: $path
571 =item Return value: None
575 Attempts to create the given path, and all required parent directories. Throws
576 an exception on failure.
578 =head2 print_environment_vars_for
582 =item Arguments: $path
584 =item Return value: None
588 Prints to standard output the variables listed above, properly set to use the
589 given path as the base directory.
591 =head2 build_environment_vars_for
595 =item Arguments: $path, $interpolate
597 =item Return value: \%environment_vars
601 Returns a hash with the variables listed above, properly set to use the
602 given path as the base directory.
604 =head2 setup_env_hash_for
608 =item Arguments: $path
610 =item Return value: None
614 Constructs the C<%ENV> keys for the given path, by calling
615 L</build_environment_vars_for>.
617 =head2 install_base_perl_path
621 =item Arguments: $path
623 =item Return value: $install_base_perl_path
627 Returns a path describing where to install the Perl modules for this local
628 library installation. Appends the directories C<lib> and C<perl5> to the given
631 =head2 install_base_arch_path
635 =item Arguments: $path
637 =item Return value: $install_base_arch_path
641 Returns a path describing where to install the architecture-specific Perl
642 modules for this local library installation. Based on the
643 L</install_base_perl_path> method's return value, and appends the value of
644 C<$Config{archname}>.
646 =head2 install_base_bin_path
650 =item Arguments: $path
652 =item Return value: $install_base_bin_path
656 Returns a path describing where to install the executable programs for this
657 local library installation. Based on the L</install_base_perl_path> method's
658 return value, and appends the directory C<bin>.
660 =head2 resolve_empty_path
664 =item Arguments: $path
666 =item Return value: $base_path
670 Builds and returns the base path into which to set up the local module
671 installation. Defaults to C<~/perl5>.
673 =head2 resolve_home_path
677 =item Arguments: $path
679 =item Return value: $home_path
683 Attempts to find the user's home directory. If installed, uses C<File::HomeDir>
684 for this purpose. If no definite answer is available, throws an exception.
686 =head2 resolve_relative_path
690 =item Arguments: $path
692 =item Return value: $absolute_path
696 Translates the given path into an absolute path.
702 =item Arguments: $path
704 =item Return value: $absolute_path
708 Calls the following in a pipeline, passing the result from the previous to the
709 next, in an attempt to find where to configure the environment for a local
710 library installation: L</resolve_empty_path>, L</resolve_home_path>,
711 L</resolve_relative_path>. Passes the given path argument to
712 L</resolve_empty_path> which then returns a result that is passed to
713 L</resolve_home_path>, which then has its result passed to
714 L</resolve_relative_path>. The result of this final call is returned from
717 =head1 A WARNING ABOUT UNINST=1
719 Be careful about using local::lib in combination with "make install UNINST=1".
720 The idea of this feature is that will uninstall an old version of a module
721 before installing a new one. However it lacks a safety check that the old
722 version and the new version will go in the same directory. Used in combination
723 with local::lib, you can potentially delete a globally accessible version of a
724 module while installing the new version in a local place. Only combine "make
725 install UNINST=1" and local::lib if you understand these possible consequences.
729 The perl toolchain is unable to handle directory names with spaces in it,
730 so you cant put your local::lib bootstrap into a directory with spaces. What
731 you can do is moving your local::lib to a directory with spaces B<after> you
732 installed all modules inside your local::lib bootstrap. But be aware that you
733 cant update or install CPAN modules after the move.
735 Rather basic shell detection. Right now anything with csh in its name is
736 assumed to be a C shell or something compatible, and everything else is assumed
737 to be Bourne, except on Win32 systems. If the C<SHELL> environment variable is
738 not set, a Bourne-compatible shell is assumed.
740 Bootstrap is a hack and will use CPAN.pm for ExtUtils::MakeMaker even if you
741 have CPANPLUS installed.
743 Kills any existing PERL5LIB, PERL_MM_OPT or PERL_MB_OPT.
745 Should probably auto-fixup CPAN config if not already done.
747 Patches very much welcome for any of the above.
749 On Win32 systems, does not have a way to write the created environment variables
750 to the registry, so that they can persist through a reboot.
752 =head1 TROUBLESHOOTING
754 If you've configured local::lib to install CPAN modules somewhere in to your
755 home directory, and at some point later you try to install a module with C<cpan
756 -i Foo::Bar>, but it fails with an error like: C<Warning: You do not have
757 permissions to install into /usr/lib64/perl5/site_perl/5.8.8/x86_64-linux at
758 /usr/lib64/perl5/5.8.8/Foo/Bar.pm> and buried within the install log is an
759 error saying C<'INSTALL_BASE' is not a known MakeMaker parameter name>, then
760 you've somehow lost your updated ExtUtils::MakeMaker module.
762 To remedy this situation, rerun the bootstrapping procedure documented above.
764 Then, run C<rm -r ~/.cpan/build/Foo-Bar*>
766 Finally, re-run C<cpan -i Foo::Bar> and it should install without problems.
776 local::lib looks at the user's C<SHELL> environment variable when printing out
777 commands to add to the shell configuration file.
779 On Win32 systems, C<COMSPEC> is also examined.
787 Join #local-lib on irc.perl.org.
791 Matt S Trout <mst@shadowcat.co.uk> http://www.shadowcat.co.uk/
793 auto_install fixes kindly sponsored by http://www.takkle.com/
797 Patches to correctly output commands for csh style shells, as well as some
798 documentation additions, contributed by Christopher Nehren <apeiron@cpan.org>.
800 Doc patches for a custom local::lib directory, more cleanups in the english
801 documentation and a L<german documentation|POD2::DE::local::lib> contributed by Torsten Raudssus
802 <torsten@raudssus.de>.
804 Hans Dieter Pearcey <hdp@cpan.org> sent in some additional tests for ensuring
805 things will install properly, submitted a fix for the bug causing problems with
806 writing Makefiles during bootstrapping, contributed an example program, and
807 submitted yet another fix to ensure that local::lib can install and bootstrap
808 properly. Many, many thanks!
810 pattern of Freenode IRC contributed the beginnings of the Troubleshooting
811 section. Many thanks!
813 Patch to add Win32 support contributed by Curtis Jewell <csjewell@cpan.org>.
815 Warnings for missing PATH/PERL5LIB (as when not running interactively) silenced
816 by a patch from Marco Emilio Poleggi.
818 Mark Stosberg <mark@summersault.com> provided the code for the now deleted
819 '--self-contained' option.
821 Documentation patches to make win32 usage clearer by
822 David Mertens <dcmertens.perl@gmail.com> (run4flat).
824 Brazilian L<portuguese translation|POD2::PT_BR::local::lib> and minor doc patches contributed by Breno
825 G. de Oliveira <garu@cpan.org>.
829 Copyright (c) 2007 - 2010 the local::lib L</AUTHOR> and L</CONTRIBUTORS> as
834 This library is free software and may be distributed under the same terms