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.004008'; # 1.4.7
15 my @KNOWN_FLAGS = (qw/--self-contained/);
18 my ($class, @args) = @_;
19 @args <= 1 + @KNOWN_FLAGS or die <<'DEATH';
20 Please see `perldoc local::lib` for directions on using this module.
23 # Remember what PERL5LIB was when we started
24 my $perl5lib = $ENV{PERL5LIB};
28 # check for lethal dash first to stop processing before causing problems
31 WHOA THERE! It looks like you've got some fancy dashes in your commandline!
32 These are *not* the traditional -- dashes that software recognizes. You
33 probably got these by copy-pasting from the perldoc for this module as
34 rendered by a UTF8-capable formatter. This most typically happens on an OS X
35 terminal, but can happen elsewhere too. Please try again after replacing the
36 dashes with normal minus signs.
39 elsif(grep { $arg eq $_ } @KNOWN_FLAGS) {
40 (my $flag = $arg) =~ s/--//;
41 $arg_store{$flag} = 1;
43 elsif($arg =~ /^--/) {
44 die "Unknown import argument: $arg";
47 # assume that what's left is a path
48 $arg_store{path} = $arg;
52 if($arg_store{'self-contained'}) {
53 # The only directories that remain are those that we just defined and those
54 # where core modules are stored. We put PERL5LIB first, so it'll be favored
55 # over privlibexp and archlibexp
58 $class->install_base_perl_path($arg_store{path}),
59 $class->install_base_arch_path($arg_store{path}),
60 split( $Config{path_sep}, $perl5lib ),
61 $Config::Config{privlibexp},
62 $Config::Config{archlibexp}
65 # We explicitly set PERL5LIB here to the above de-duped list to prevent
66 # @INC from growing with each invocation
67 $ENV{PERL5LIB} = join( $Config{path_sep}, @INC );
70 $arg_store{path} = $class->resolve_path($arg_store{path});
71 $class->setup_local_lib_for($arg_store{path});
73 for (@INC) { # Untaint @INC
74 next if ref; # Skip entry if it is an ARRAY, CODE, blessed, etc.
83 my $last = pop(@methods);
86 my ($obj, @args) = @_;
87 $obj->${pipeline @methods}(
104 { package Foo; sub foo { -$_[1] } sub bar { $_[1]+2 } sub baz { $_[1]+3 } }
105 my $foo = bless({}, 'Foo');
106 Test::More::ok($foo->${pipeline qw(foo bar baz)}(10) == -15);
114 grep { ! $seen{$_}++ } @_;
118 my ($class, $path) = @_;
119 $class->${pipeline qw(
120 resolve_relative_path
126 sub resolve_empty_path {
127 my ($class, $path) = @_;
137 #:: test classmethod setup
139 my $c = 'local::lib';
147 is($c->resolve_empty_path, '~/perl5');
148 is($c->resolve_empty_path('foo'), 'foo');
154 sub resolve_home_path {
155 my ($class, $path) = @_;
156 return $path unless ($path =~ /^~/);
157 my ($user) = ($path =~ /^~([^\/]+)/); # can assume ^~ so undef for 'us'
158 my $tried_file_homedir;
160 no warnings 'numeric'; # Disable warning caused by version comparison with dev releases..
161 if (eval { require File::HomeDir } && $File::HomeDir::VERSION >= 0.65) {
162 $tried_file_homedir = 1;
164 File::HomeDir->users_home($user);
166 File::HomeDir->my_home;
172 if (defined $ENV{HOME}) {
180 unless (defined $homedir) {
182 "Couldn't resolve homedir for "
183 .(defined $user ? $user : 'current user')
184 .($tried_file_homedir ? '' : ' - consider installing File::HomeDir')
187 $path =~ s/^~[^\/]*/$homedir/;
191 sub resolve_relative_path {
192 my ($class, $path) = @_;
193 $path = File::Spec->rel2abs($path);
200 local *File::Spec::rel2abs = sub { shift; 'FOO'.shift; };
201 is($c->resolve_relative_path('bar'),'FOObar');
207 sub setup_local_lib_for {
208 my ($class, $path) = @_;
209 $path = $class->ensure_dir_structure_for($path);
211 $class->print_environment_vars_for($path);
214 $class->setup_env_hash_for($path);
215 @INC = _uniq(split($Config{path_sep}, $ENV{PERL5LIB}), @INC);
219 sub modulebuildrc_path {
220 my ($class, $path) = @_;
221 File::Spec->catfile($path, '.modulebuildrc');
224 sub install_base_bin_path {
225 my ($class, $path) = @_;
226 File::Spec->catdir($path, 'bin');
229 sub install_base_perl_path {
230 my ($class, $path) = @_;
231 File::Spec->catdir($path, 'lib', 'perl5');
234 sub install_base_arch_path {
235 my ($class, $path) = @_;
236 File::Spec->catdir($class->install_base_perl_path($path), $Config{archname});
239 sub ensure_dir_structure_for {
240 my ($class, $path) = @_;
242 warn "Attempting to create directory ${path}\n";
244 File::Path::mkpath($path);
245 # Need to have the path exist to make a short name for it, so
246 # converting to a short name here.
247 $path = Win32::GetShortPathName($path) if $^O eq 'MSWin32';
248 my $modulebuildrc_path = $class->modulebuildrc_path($path);
249 if (-e $modulebuildrc_path) {
251 Carp::croak("${modulebuildrc_path} exists but is not a plain file");
254 warn "Attempting to create file ${modulebuildrc_path}\n";
255 open MODULEBUILDRC, '>', $modulebuildrc_path
256 || Carp::croak("Couldn't open ${modulebuildrc_path} for writing: $!");
257 print MODULEBUILDRC qq{install --install_base ${path}\n}
258 || Carp::croak("Couldn't write line to ${modulebuildrc_path}: $!");
260 || Carp::croak("Couldn't close file ${modulebuildrc_path}: $@");
266 sub INTERPOLATE_ENV () { 1 }
267 sub LITERAL_ENV () { 0 }
269 sub print_environment_vars_for {
270 my ($class, $path) = @_;
271 my @envs = $class->build_environment_vars_for($path, LITERAL_ENV);
274 # rather basic csh detection, goes on the assumption that something won't
275 # call itself csh unless it really is. also, default to bourne in the
276 # pathological situation where a user doesn't have $ENV{SHELL} defined.
277 # note also that shells with funny names, like zoid, are assumed to be
280 if(defined $ENV{'SHELL'}) {
281 my @shell_bin_path_parts = File::Spec->splitpath($ENV{'SHELL'});
282 $shellbin = $shell_bin_path_parts[-1];
285 local $_ = $shellbin;
293 # Both Win32 and Cygwin have $ENV{COMSPEC} set.
294 if (defined $ENV{'COMSPEC'} && $^O ne 'cygwin') {
295 my @shell_bin_path_parts = File::Spec->splitpath($ENV{'COMSPEC'});
296 $shellbin = $shell_bin_path_parts[-1];
298 local $_ = $shellbin;
301 } elsif(/cmd\.exe/) {
303 } elsif(/4nt\.exe/) {
312 my ($name, $value) = (shift(@envs), shift(@envs));
313 $value =~ s/(\\")/\\$1/g;
314 $out .= $class->${\"build_${shelltype}_env_declaration"}($name, $value);
319 # simple routines that take two arguments: an %ENV key and a value. return
320 # strings that are suitable for passing directly to the relevant shell to set
321 # said key to said value.
322 sub build_bourne_env_declaration {
324 my($name, $value) = @_;
325 return qq{export ${name}="${value}"\n};
328 sub build_csh_env_declaration {
330 my($name, $value) = @_;
331 return qq{setenv ${name} "${value}"\n};
334 sub build_win32_env_declaration {
336 my($name, $value) = @_;
337 return qq{set ${name}=${value}\n};
340 sub setup_env_hash_for {
341 my ($class, $path) = @_;
342 my %envs = $class->build_environment_vars_for($path, INTERPOLATE_ENV);
343 @ENV{keys %envs} = values %envs;
346 sub build_environment_vars_for {
347 my ($class, $path, $interpolate) = @_;
349 MODULEBUILDRC => $class->modulebuildrc_path($path),
350 PERL_MM_OPT => "INSTALL_BASE=${path}",
351 PERL5LIB => join($Config{path_sep},
352 $class->install_base_perl_path($path),
353 $class->install_base_arch_path($path),
355 ($interpolate == INTERPOLATE_ENV
357 : (($^O ne 'MSWin32') ? '$PERL5LIB' : '%PERL5LIB%' ))
360 PATH => join($Config{path_sep},
361 $class->install_base_bin_path($path),
362 ($interpolate == INTERPOLATE_ENV
364 : (($^O ne 'MSWin32') ? '$PATH' : '%PATH%' ))
373 File::Path::rmtree('t/var/splat');
375 $c->ensure_dir_structure_for('t/var/splat');
377 ok(-d 't/var/splat');
379 ok(-f 't/var/splat/.modulebuildrc');
385 local::lib - create and use a local lib/ for perl modules with PERL5LIB
391 use local::lib; # sets up a local lib at ~/perl5
393 use local::lib '~/foo'; # same, but ~/foo
397 use local::lib "$FindBin::Bin/../support"; # app-local support library
401 # Install LWP and it's missing dependencies to the 'my_lwp' directory
402 perl -MCPAN -Mlocal::lib=my_lwp -e 'CPAN::install(LWP)'
404 # Install LWP and *all non-core* dependencies to the 'my_lwp' directory
405 perl -MCPAN -Mlocal::lib=--self-contained,my_lwp -e 'CPAN::install(LWP)'
407 # Just print out useful shell commands
409 export MODULEBUILDRC=/home/username/perl/.modulebuildrc
410 export PERL_MM_OPT='INSTALL_BASE=/home/username/perl'
411 export PERL5LIB='/home/username/perl/lib/perl5:/home/username/perl/lib/perl5/i386-linux'
412 export PATH="/home/username/perl/bin:$PATH"
414 =head2 The bootstrapping technique
416 A typical way to install local::lib is using what is known as the
417 "bootstrapping" technique. You would do this if your system administrator
418 hasn't already installed local::lib. In this case, you'll need to install
419 local::lib in your home directory.
421 1. Download and unpack the local::lib tarball from CPAN (search for "Download"
422 on the CPAN page about local::lib). Do this as an ordinary user, not as root
423 or administrator. Unpack the file in your home directory or in any other
428 perl Makefile.PL --bootstrap
430 If the system asks you whether it should automatically configure as much
431 as possible, you would typically answer yes.
435 make test && make install
437 4. Arrange for Perl to use your own packages instead of the system
438 packages. If you are using bash, you can do this as follows:
440 echo 'eval $(perl -I$HOME/perl5/lib/perl5 -Mlocal::lib)' >>~/.bashrc
442 If you are using C shell, you can do this as follows:
447 perl -I$HOME/perl5/lib/perl5 -Mlocal::lib >> ~/.cshrc
449 You can also pass --bootstrap=~/foo to get a different location -
451 perl Makefile.PL --bootstrap=~/foo
452 make test && make install
454 echo 'eval $(perl -I$HOME/foo/lib/perl5 -Mlocal::lib=$HOME/foo)' >>~/.bashrc
456 After writing your shell configuration file, be sure to re-read it to get the
457 changed settings into your current shell's environment. Bourne shells use C<.
458 ~/.bashrc> for this, whereas C shells use C<source ~/.cshrc>. Replace .bashrc or
459 .cshrc with the name of the file you wrote above with the echo command.
461 If you're on a slower machine, or are operating under draconian disk space
462 limitations, you can disable the automatic generation of manpages from POD when
463 installing modules by using the C<--no-manpages> argument when bootstrapping:
465 perl Makefile.PL --bootstrap --no-manpages
467 If you want to install multiple Perl module environments, say for application evelopment,
468 install local::lib globally and then:
472 eval $(perl -Mlocal::lib=./) ### To set the environment for this shell alone
473 printenv ### You will see that ~/mydir1 is in the PERL5LIB
474 perl -MCPAN -e install ... ### whatever modules you want
478 For multiple environments for multiple apps you may need to include a modified
479 version of the C<< use FindBin >> instructions in the "In code" sample above.
480 If you did something like the above, you have a set of Perl modules at C<<
481 ~/mydir1/lib >>. If you have a script at C<< ~/mydir1/scripts/myscript.pl >>,
482 you need to tell it where to find the modules you installed for it at C<<
485 In C<< ~/mydir1/scripts/myscript.pl >>:
489 use local::lib "$FindBin::Bin/.."; ### points to ~/mydir1 and local::lib finds lib
490 use lib "$FindBin::Bin/../lib"; ### points to ~/mydir1/lib
492 Put this before any BEGIN { ... } blocks that require the modules you installed.
494 =head2 Differences when using this module under Win32
496 C:\>perl -Mlocal::lib
497 set MODULEBUILDRC=C:\DOCUME~1\ADMINI~1\perl5\.modulebuildrc
498 set PERL_MM_OPT=INSTALL_BASE=C:\DOCUME~1\ADMINI~1\perl5
499 set PERL5LIB=C:\DOCUME~1\ADMINI~1\perl5\lib\perl5;C:\DOCUME~1\ADMINI~1\perl5\lib\perl5\MSWin32-x86-multi-thread
500 set PATH=C:\DOCUME~1\ADMINI~1\perl5\bin;%PATH%
502 ### To set the environment for this shell alone
503 C:\>perl -Mlocal::lib > %TEMP%\tmp.bat && %TEMP%\tmp.bat && del %TEMP%\temp.bat
504 ### instead of $(perl -Mlocal::lib=./)
506 If you want the environment entries to persist, you'll need to add then to the
507 Control Panel's System applet yourself at the moment.
509 The "~" is translated to the user's profile directory (the directory named for
510 the user under "Documents and Settings" (Windows XP or earlier) or "Users"
511 (Windows Vista or later) unless $ENV{HOME} exists. After that, the home
512 directory is translated to a short name (which means the directory must exist)
513 and the subdirectories are created.
517 The version of a Perl package on your machine is not always the version you
518 need. Obviously, the best thing to do would be to update to the version you
519 need. However, you might be in a situation where you're prevented from doing
520 this. Perhaps you don't have system administrator privileges; or perhaps you
521 are using a package management system such as Debian, and nobody has yet gotten
522 around to packaging up the version you need.
524 local::lib solves this problem by allowing you to create your own directory of
525 Perl packages downloaded from CPAN (in a multi-user system, this would typically
526 be within your own home directory). The existing system Perl installation is
527 not affected; you simply invoke Perl with special options so that Perl uses the
528 packages in your own local package directory rather than the system packages.
529 local::lib arranges things so that your locally installed version of the Perl
530 packages takes precedence over the system installation.
532 If you are using a package management system (such as Debian), you don't need to
533 worry about Debian and CPAN stepping on each other's toes. Your local version
534 of the packages will be written to an entirely separate directory from those
539 This module provides a quick, convenient way of bootstrapping a user-local Perl
540 module library located within the user's home directory. It also constructs and
541 prints out for the user the list of environment variables using the syntax
542 appropriate for the user's current shell (as specified by the C<SHELL>
543 environment variable), suitable for directly adding to one's shell
546 More generally, local::lib allows for the bootstrapping and usage of a
547 directory containing Perl modules outside of Perl's C<@INC>. This makes it
548 easier to ship an application with an app-specific copy of a Perl module, or
549 collection of modules. Useful in cases like when an upstream maintainer hasn't
550 applied a patch to a module of theirs that you need for your application.
552 On import, local::lib sets the following environment variables to appropriate
565 PATH is appended to, rather than clobbered.
569 These values are then available for reference by any code after import.
573 =head2 ensure_directory_structure_for
577 =item Arguments: path
581 Attempts to create the given path, and all required parent directories. Throws
582 an exception on failure.
584 =head2 print_environment_vars_for
588 =item Arguments: path
592 Prints to standard output the variables listed above, properly set to use the
593 given path as the base directory.
595 =head2 setup_env_hash_for
599 =item Arguments: path
603 Constructs the C<%ENV> keys for the given path, by calling
604 C<build_environment_vars_for>.
606 =head2 install_base_perl_path
610 =item Arguments: path
614 Returns a path describing where to install the Perl modules for this local
615 library installation. Appends the directories C<lib> and C<perl5> to the given
618 =head2 install_base_arch_path
622 =item Arguments: path
626 Returns a path describing where to install the architecture-specific Perl
627 modules for this local library installation. Based on the
628 L</install_base_perl_path> method's return value, and appends the value of
629 C<$Config{archname}>.
631 =head2 install_base_bin_path
635 =item Arguments: path
639 Returns a path describing where to install the executable programs for this
640 local library installation. Based on the L</install_base_perl_path> method's
641 return value, and appends the directory C<bin>.
643 =head2 modulebuildrc_path
647 =item Arguments: path
651 Returns a path describing where to install the C<.modulebuildrc> file, based on
654 =head2 resolve_empty_path
658 =item Arguments: path
662 Builds and returns the base path into which to set up the local module
663 installation. Defaults to C<~/perl5>.
665 =head2 resolve_home_path
669 =item Arguments: path
673 Attempts to find the user's home directory. If installed, uses C<File::HomeDir>
674 for this purpose. If no definite answer is available, throws an exception.
676 =head2 resolve_relative_path
680 =item Arguments: path
684 Translates the given path into an absolute path.
690 =item Arguments: path
694 Calls the following in a pipeline, passing the result from the previous to the
695 next, in an attempt to find where to configure the environment for a local
696 library installation: L</resolve_empty_path>, L</resolve_home_path>,
697 L</resolve_relative_path>. Passes the given path argument to
698 L</resolve_empty_path> which then returns a result that is passed to
699 L</resolve_home_path>, which then has its result passed to
700 L</resolve_relative_path>. The result of this final call is returned from
703 =head1 A WARNING ABOUT UNINST=1
705 Be careful about using local::lib in combination with "make install UNINST=1".
706 The idea of this feature is that will uninstall an old version of a module
707 before installing a new one. However it lacks a safety check that the old
708 version and the new version will go in the same directory. Used in combination
709 with local::lib, you can potentially delete a globally accessible version of a
710 module while installing the new version in a local place. Only combine "make
711 install UNINST=1" and local::lib if you understand these possible consequences.
715 Rather basic shell detection. Right now anything with csh in its name is
716 assumed to be a C shell or something compatible, and everything else is assumed
717 to be Bourne, except on Win32 systems. If the C<SHELL> environment variable is
718 not set, a Bourne-compatible shell is assumed.
720 Bootstrap is a hack and will use CPAN.pm for ExtUtils::MakeMaker even if you
721 have CPANPLUS installed.
723 Kills any existing PERL5LIB, PERL_MM_OPT or MODULEBUILDRC.
725 Should probably auto-fixup CPAN config if not already done.
727 Patches very much welcome for any of the above.
729 On Win32 systems, does not have a way to write the created environment variables
730 to the registry, so that they can persist through a reboot.
732 =head1 TROUBLESHOOTING
734 If you've configured local::lib to install CPAN modules somewhere in to your
735 home directory, and at some point later you try to install a module with C<cpan
736 -i Foo::Bar>, but it fails with an error like: C<Warning: You do not have
737 permissions to install into /usr/lib64/perl5/site_perl/5.8.8/x86_64-linux at
738 /usr/lib64/perl5/5.8.8/Foo/Bar.pm> and buried within the install log is an
739 error saying C<'INSTALL_BASE' is not a known MakeMaker parameter name>, then
740 you've somehow lost your updated ExtUtils::MakeMaker module.
742 To remedy this situation, rerun the bootstrapping procedure documented above.
744 Then, run C<rm -r ~/.cpan/build/Foo-Bar*>
746 Finally, re-run C<cpan -i Foo::Bar> and it should install without problems.
756 local::lib looks at the user's C<SHELL> environment variable when printing out
757 commands to add to the shell configuration file.
759 On Win32 systems, C<COMSPEC> is also examined.
765 Matt S Trout <mst@shadowcat.co.uk> http://www.shadowcat.co.uk/
767 auto_install fixes kindly sponsored by http://www.takkle.com/
771 Patches to correctly output commands for csh style shells, as well as some
772 documentation additions, contributed by Christopher Nehren <apeiron@cpan.org>.
774 '--self-contained' feature contributed by Mark Stosberg <mark@summersault.com>.
776 Ability to pass '--self-contained' without a directory inspired by frew on
777 irc.perl.org/#catalyst.
779 Doc patches for a custom local::lib directory contributed by Torsten Raudssus
780 <torsten@raudssus.de>.
782 Hans Dieter Pearcey <hdp@cpan.org> sent in some additional tests for ensuring
783 things will install properly, submitted a fix for the bug causing problems with
784 writing Makefiles during bootstrapping, contributed an example program, and
785 submitted yet another fix to ensure that local::lib can install and bootstrap
786 properly. Many, many thanks!
788 pattern of Freenode IRC contributed the beginnings of the Troubleshooting
789 section. Many thanks!
791 Patch to add Win32 support contributed by Curtis Jewell <csjewell@cpan.org>.
795 Copyright (c) 2007 - 2009 the local::lib L</AUTHOR> and L</CONTRIBUTORS> as
800 This library is free software and may be distributed under the same terms