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.006004'; # 1.6.4
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 modulebuildrc_path {
203 my ($class, $path) = @_;
204 File::Spec->catfile($path, '.modulebuildrc');
207 sub install_base_bin_path {
208 my ($class, $path) = @_;
209 File::Spec->catdir($path, 'bin');
212 sub install_base_perl_path {
213 my ($class, $path) = @_;
214 File::Spec->catdir($path, 'lib', 'perl5');
217 sub install_base_arch_path {
218 my ($class, $path) = @_;
219 File::Spec->catdir($class->install_base_perl_path($path), $Config{archname});
222 sub ensure_dir_structure_for {
223 my ($class, $path) = @_;
225 warn "Attempting to create directory ${path}\n";
227 File::Path::mkpath($path);
228 # Need to have the path exist to make a short name for it, so
229 # converting to a short name here.
230 $path = Win32::GetShortPathName($path) if $^O eq 'MSWin32';
231 my $modulebuildrc_path = $class->modulebuildrc_path($path);
232 if (-e $modulebuildrc_path) {
234 Carp::croak("${modulebuildrc_path} exists but is not a plain file");
237 warn "Attempting to create file ${modulebuildrc_path}\n";
238 open MODULEBUILDRC, '>', $modulebuildrc_path
239 || Carp::croak("Couldn't open ${modulebuildrc_path} for writing: $!");
240 print MODULEBUILDRC qq{install --install_base ${path}\n}
241 || Carp::croak("Couldn't write line to ${modulebuildrc_path}: $!");
243 || Carp::croak("Couldn't close file ${modulebuildrc_path}: $@");
249 sub INTERPOLATE_ENV () { 1 }
250 sub LITERAL_ENV () { 0 }
252 sub print_environment_vars_for {
253 my ($class, $path) = @_;
254 my @envs = $class->build_environment_vars_for($path, LITERAL_ENV);
257 # rather basic csh detection, goes on the assumption that something won't
258 # call itself csh unless it really is. also, default to bourne in the
259 # pathological situation where a user doesn't have $ENV{SHELL} defined.
260 # note also that shells with funny names, like zoid, are assumed to be
263 if(defined $ENV{'SHELL'}) {
264 my @shell_bin_path_parts = File::Spec->splitpath($ENV{'SHELL'});
265 $shellbin = $shell_bin_path_parts[-1];
268 local $_ = $shellbin;
276 # Both Win32 and Cygwin have $ENV{COMSPEC} set.
277 if (defined $ENV{'COMSPEC'} && $^O ne 'cygwin') {
278 my @shell_bin_path_parts = File::Spec->splitpath($ENV{'COMSPEC'});
279 $shellbin = $shell_bin_path_parts[-1];
281 local $_ = $shellbin;
284 } elsif(/cmd\.exe/) {
286 } elsif(/4nt\.exe/) {
295 my ($name, $value) = (shift(@envs), shift(@envs));
296 $value =~ s/(\\")/\\$1/g;
297 $out .= $class->${\"build_${shelltype}_env_declaration"}($name, $value);
302 # simple routines that take two arguments: an %ENV key and a value. return
303 # strings that are suitable for passing directly to the relevant shell to set
304 # said key to said value.
305 sub build_bourne_env_declaration {
307 my($name, $value) = @_;
308 return qq{export ${name}="${value}"\n};
311 sub build_csh_env_declaration {
313 my($name, $value) = @_;
314 return qq{setenv ${name} "${value}"\n};
317 sub build_win32_env_declaration {
319 my($name, $value) = @_;
320 return qq{set ${name}=${value}\n};
323 sub setup_env_hash_for {
324 my ($class, $path) = @_;
325 my %envs = $class->build_environment_vars_for($path, INTERPOLATE_ENV);
326 @ENV{keys %envs} = values %envs;
329 sub build_environment_vars_for {
330 my ($class, $path, $interpolate) = @_;
332 MODULEBUILDRC => $class->modulebuildrc_path($path),
333 PERL_MM_OPT => "INSTALL_BASE=${path}",
334 PERL5LIB => join($Config{path_sep},
335 $class->install_base_arch_path($path),
336 $class->install_base_perl_path($path),
337 (($ENV{PERL5LIB}||()) ?
338 ($interpolate == INTERPOLATE_ENV
340 : (($^O ne 'MSWin32') ? '$PERL5LIB' : '%PERL5LIB%' ))
343 PATH => join($Config{path_sep},
344 $class->install_base_bin_path($path),
345 ($interpolate == INTERPOLATE_ENV
347 : (($^O ne 'MSWin32') ? '$PATH' : '%PATH%' ))
356 File::Path::rmtree('t/var/splat');
358 $c->ensure_dir_structure_for('t/var/splat');
360 ok(-d 't/var/splat');
362 ok(-f 't/var/splat/.modulebuildrc');
370 local::lib - create and use a local lib/ for perl modules with PERL5LIB
376 use local::lib; # sets up a local lib at ~/perl5
378 use local::lib '~/foo'; # same, but ~/foo
382 use local::lib "$FindBin::Bin/../support"; # app-local support library
386 # Install LWP and its missing dependencies to the '~/perl5' directory
387 perl -MCPAN -Mlocal::lib -e 'CPAN::install(LWP)'
389 # Just print out useful shell commands
391 export MODULEBUILDRC=/home/username/perl/.modulebuildrc
392 export PERL_MM_OPT='INSTALL_BASE=/home/username/perl'
393 export PERL5LIB='/home/username/perl/lib/perl5:/home/username/perl/lib/perl5/i386-linux'
394 export PATH="/home/username/perl/bin:$PATH"
396 =head2 The bootstrapping technique
398 A typical way to install local::lib is using what is known as the
399 "bootstrapping" technique. You would do this if your system administrator
400 hasn't already installed local::lib. In this case, you'll need to install
401 local::lib in your home directory.
403 If you do have administrative privileges, you will still want to set up your
404 environment variables, as discussed in step 4. Without this, you would still
405 install the modules into the system CPAN installation and also your Perl scripts
406 will not use the lib/ path you bootstrapped with local::lib.
408 Windows users must also see L</Differences when using this module under Win32>.
410 1. Download and unpack the local::lib tarball from CPAN (search for "Download"
411 on the CPAN page about local::lib). Do this as an ordinary user, not as root
412 or administrator. Unpack the file in your home directory or in any other
417 perl Makefile.PL --bootstrap
419 If the system asks you whether it should automatically configure as much
420 as possible, you would typically answer yes.
422 In order to install local::lib into a directory other than default, you need
423 to give that directory on the call of bootstrap like this:
425 perl Makefile.PL --bootstrap=~/foo
427 3. Run this: (local::lib assumes you have make installed on your system)
429 make test && make install
431 4. Now we need to setup the appropriate environment variables, so that Perl
432 starts using our newly generated lib/ directory. If you are using bash or
433 any other Bourne shells, you can add this to your shell startup script this
436 echo 'eval $(perl -I$HOME/perl5/lib/perl5 -Mlocal::lib)' >>~/.bashrc
438 If you are using C shell, you can do this as follows:
443 perl -I$HOME/perl5/lib/perl5 -Mlocal::lib >> ~/.cshrc
445 If you passed to bootstrap a directory other than default, you also need to give that as
446 import parameter to the call of the local::lib module like this way:
448 echo 'eval $(perl -I$HOME/foo/lib/perl5 -Mlocal::lib=$HOME/foo)' >>~/.bashrc
450 After writing your shell configuration file, be sure to re-read it to get the
451 changed settings into your current shell's environment. Bourne shells use
452 C<. ~/.bashrc> for this, whereas C shells use C<source ~/.cshrc>.
454 If you're on a slower machine, or are operating under draconian disk space
455 limitations, you can disable the automatic generation of manpages from POD when
456 installing modules by using the C<--no-manpages> argument when bootstrapping:
458 perl Makefile.PL --bootstrap --no-manpages
460 To avoid doing several bootstrap for several Perl module environments on the
461 same account, for example if you use it for several different deployed
462 applications independently, you can use one bootstrapped local::lib
463 installation to install modules in different directories directly this way:
467 eval $(perl -Mlocal::lib=./) ### To set the environment for this shell alone
468 printenv ### You will see that ~/mydir1 is in the PERL5LIB
469 perl -MCPAN -e install ... ### whatever modules you want
473 For multiple environments for multiple apps you may need to include a modified
474 version of the C<< use FindBin >> instructions in the "In code" sample above.
475 If you did something like the above, you have a set of Perl modules at C<<
476 ~/mydir1/lib >>. If you have a script at C<< ~/mydir1/scripts/myscript.pl >>,
477 you need to tell it where to find the modules you installed for it at C<<
480 In C<< ~/mydir1/scripts/myscript.pl >>:
484 use local::lib "$FindBin::Bin/.."; ### points to ~/mydir1 and local::lib finds lib
485 use lib "$FindBin::Bin/../lib"; ### points to ~/mydir1/lib
487 Put this before any BEGIN { ... } blocks that require the modules you installed.
489 =head2 Differences when using this module under Win32
491 To set up the proper environment variables for your current session of
492 C<CMD.exe>, you can use this:
494 C:\>perl -Mlocal::lib
495 set MODULEBUILDRC=C:\DOCUME~1\ADMINI~1\perl5\.modulebuildrc
496 set PERL_MM_OPT=INSTALL_BASE=C:\DOCUME~1\ADMINI~1\perl5
497 set PERL5LIB=C:\DOCUME~1\ADMINI~1\perl5\lib\perl5;C:\DOCUME~1\ADMINI~1\perl5\lib\perl5\MSWin32-x86-multi-thread
498 set PATH=C:\DOCUME~1\ADMINI~1\perl5\bin;%PATH%
500 ### To set the environment for this shell alone
501 C:\>perl -Mlocal::lib > %TEMP%\tmp.bat && %TEMP%\tmp.bat && del %TEMP%\temp.bat
502 ### instead of $(perl -Mlocal::lib=./)
504 If you want the environment entries to persist, you'll need to add then to the
505 Control Panel's System applet yourself or use L<App::local::lib::Win32Helper>.
507 The "~" is translated to the user's profile directory (the directory named for
508 the user under "Documents and Settings" (Windows XP or earlier) or "Users"
509 (Windows Vista or later) unless $ENV{HOME} exists. After that, the home
510 directory is translated to a short name (which means the directory must exist)
511 and the subdirectories are created.
515 The version of a Perl package on your machine is not always the version you
516 need. Obviously, the best thing to do would be to update to the version you
517 need. However, you might be in a situation where you're prevented from doing
518 this. Perhaps you don't have system administrator privileges; or perhaps you
519 are using a package management system such as Debian, and nobody has yet gotten
520 around to packaging up the version you need.
522 local::lib solves this problem by allowing you to create your own directory of
523 Perl packages downloaded from CPAN (in a multi-user system, this would typically
524 be within your own home directory). The existing system Perl installation is
525 not affected; you simply invoke Perl with special options so that Perl uses the
526 packages in your own local package directory rather than the system packages.
527 local::lib arranges things so that your locally installed version of the Perl
528 packages takes precedence over the system installation.
530 If you are using a package management system (such as Debian), you don't need to
531 worry about Debian and CPAN stepping on each other's toes. Your local version
532 of the packages will be written to an entirely separate directory from those
537 This module provides a quick, convenient way of bootstrapping a user-local Perl
538 module library located within the user's home directory. It also constructs and
539 prints out for the user the list of environment variables using the syntax
540 appropriate for the user's current shell (as specified by the C<SHELL>
541 environment variable), suitable for directly adding to one's shell
544 More generally, local::lib allows for the bootstrapping and usage of a
545 directory containing Perl modules outside of Perl's C<@INC>. This makes it
546 easier to ship an application with an app-specific copy of a Perl module, or
547 collection of modules. Useful in cases like when an upstream maintainer hasn't
548 applied a patch to a module of theirs that you need for your application.
550 On import, local::lib sets the following environment variables to appropriate
563 PATH is appended to, rather than clobbered.
567 These values are then available for reference by any code after import.
569 =head1 CREATING A SELF-CONTAINED SET OF MODULES
571 See L<lib::core::only|lib::core::only> for one way to do this - but note that
572 there are a number of caveats, and the best approach is always to perform a
573 build against a clean perl (i.e. site and vendor as close to empty as possible).
577 =head2 ensure_directory_structure_for
581 =item Arguments: path
585 Attempts to create the given path, and all required parent directories. Throws
586 an exception on failure.
588 =head2 print_environment_vars_for
592 =item Arguments: path
596 Prints to standard output the variables listed above, properly set to use the
597 given path as the base directory.
599 =head2 setup_env_hash_for
603 =item Arguments: path
607 Constructs the C<%ENV> keys for the given path, by calling
608 C<build_environment_vars_for>.
610 =head2 install_base_perl_path
614 =item Arguments: path
618 Returns a path describing where to install the Perl modules for this local
619 library installation. Appends the directories C<lib> and C<perl5> to the given
622 =head2 install_base_arch_path
626 =item Arguments: path
630 Returns a path describing where to install the architecture-specific Perl
631 modules for this local library installation. Based on the
632 L</install_base_perl_path> method's return value, and appends the value of
633 C<$Config{archname}>.
635 =head2 install_base_bin_path
639 =item Arguments: path
643 Returns a path describing where to install the executable programs for this
644 local library installation. Based on the L</install_base_perl_path> method's
645 return value, and appends the directory C<bin>.
647 =head2 modulebuildrc_path
651 =item Arguments: path
655 Returns a path describing where to install the C<.modulebuildrc> file, based on
658 =head2 resolve_empty_path
662 =item Arguments: path
666 Builds and returns the base path into which to set up the local module
667 installation. Defaults to C<~/perl5>.
669 =head2 resolve_home_path
673 =item Arguments: path
677 Attempts to find the user's home directory. If installed, uses C<File::HomeDir>
678 for this purpose. If no definite answer is available, throws an exception.
680 =head2 resolve_relative_path
684 =item Arguments: path
688 Translates the given path into an absolute path.
694 =item Arguments: path
698 Calls the following in a pipeline, passing the result from the previous to the
699 next, in an attempt to find where to configure the environment for a local
700 library installation: L</resolve_empty_path>, L</resolve_home_path>,
701 L</resolve_relative_path>. Passes the given path argument to
702 L</resolve_empty_path> which then returns a result that is passed to
703 L</resolve_home_path>, which then has its result passed to
704 L</resolve_relative_path>. The result of this final call is returned from
707 =head1 A WARNING ABOUT UNINST=1
709 Be careful about using local::lib in combination with "make install UNINST=1".
710 The idea of this feature is that will uninstall an old version of a module
711 before installing a new one. However it lacks a safety check that the old
712 version and the new version will go in the same directory. Used in combination
713 with local::lib, you can potentially delete a globally accessible version of a
714 module while installing the new version in a local place. Only combine "make
715 install UNINST=1" and local::lib if you understand these possible consequences.
719 Rather basic shell detection. Right now anything with csh in its name is
720 assumed to be a C shell or something compatible, and everything else is assumed
721 to be Bourne, except on Win32 systems. If the C<SHELL> environment variable is
722 not set, a Bourne-compatible shell is assumed.
724 Bootstrap is a hack and will use CPAN.pm for ExtUtils::MakeMaker even if you
725 have CPANPLUS installed.
727 Kills any existing PERL5LIB, PERL_MM_OPT or MODULEBUILDRC.
729 Should probably auto-fixup CPAN config if not already done.
731 Patches very much welcome for any of the above.
733 On Win32 systems, does not have a way to write the created environment variables
734 to the registry, so that they can persist through a reboot.
736 =head1 TROUBLESHOOTING
738 If you've configured local::lib to install CPAN modules somewhere in to your
739 home directory, and at some point later you try to install a module with C<cpan
740 -i Foo::Bar>, but it fails with an error like: C<Warning: You do not have
741 permissions to install into /usr/lib64/perl5/site_perl/5.8.8/x86_64-linux at
742 /usr/lib64/perl5/5.8.8/Foo/Bar.pm> and buried within the install log is an
743 error saying C<'INSTALL_BASE' is not a known MakeMaker parameter name>, then
744 you've somehow lost your updated ExtUtils::MakeMaker module.
746 To remedy this situation, rerun the bootstrapping procedure documented above.
748 Then, run C<rm -r ~/.cpan/build/Foo-Bar*>
750 Finally, re-run C<cpan -i Foo::Bar> and it should install without problems.
760 local::lib looks at the user's C<SHELL> environment variable when printing out
761 commands to add to the shell configuration file.
763 On Win32 systems, C<COMSPEC> is also examined.
769 Matt S Trout <mst@shadowcat.co.uk> http://www.shadowcat.co.uk/
771 auto_install fixes kindly sponsored by http://www.takkle.com/
775 Patches to correctly output commands for csh style shells, as well as some
776 documentation additions, contributed by Christopher Nehren <apeiron@cpan.org>.
778 Doc patches for a custom local::lib directory contributed by Torsten Raudssus
779 <torsten@raudssus.de>.
781 Hans Dieter Pearcey <hdp@cpan.org> sent in some additional tests for ensuring
782 things will install properly, submitted a fix for the bug causing problems with
783 writing Makefiles during bootstrapping, contributed an example program, and
784 submitted yet another fix to ensure that local::lib can install and bootstrap
785 properly. Many, many thanks!
787 pattern of Freenode IRC contributed the beginnings of the Troubleshooting
788 section. Many thanks!
790 Patch to add Win32 support contributed by Curtis Jewell <csjewell@cpan.org>.
792 Warnings for missing PATH/PERL5LIB (as when not running interactively) silenced
793 by a patch from Marco Emilio Poleggi.
795 Mark Stosberg <mark@summersault.com> provided the code for the now deleted
796 '--self-contained' option.
798 Documentation patches to make win32 usage clearer by
799 David Mertens <dcmertens.perl@gmail.com> (run4flat).
803 Copyright (c) 2007 - 2009 the local::lib L</AUTHOR> and L</CONTRIBUTORS> as
808 This library is free software and may be distributed under the same terms