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.004009'; # 1.4.9
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_arch_path($arg_store{path}),
59 $class->install_base_perl_path($arg_store{path}),
60 split( $Config{path_sep}, $perl5lib ),
61 $Config::Config{archlibexp},
62 $Config::Config{privlibexp},
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 if (eval { require File::HomeDir } && $File::HomeDir::VERSION >= 0.65) {
161 $tried_file_homedir = 1;
163 File::HomeDir->users_home($user);
165 File::HomeDir->my_home;
171 if (defined $ENV{HOME}) {
179 unless (defined $homedir) {
181 "Couldn't resolve homedir for "
182 .(defined $user ? $user : 'current user')
183 .($tried_file_homedir ? '' : ' - consider installing File::HomeDir')
186 $path =~ s/^~[^\/]*/$homedir/;
190 sub resolve_relative_path {
191 my ($class, $path) = @_;
192 $path = File::Spec->rel2abs($path);
199 local *File::Spec::rel2abs = sub { shift; 'FOO'.shift; };
200 is($c->resolve_relative_path('bar'),'FOObar');
206 sub setup_local_lib_for {
207 my ($class, $path) = @_;
208 $path = $class->ensure_dir_structure_for($path);
210 $class->print_environment_vars_for($path);
213 $class->setup_env_hash_for($path);
214 @INC = _uniq(split($Config{path_sep}, $ENV{PERL5LIB}), @INC);
218 sub modulebuildrc_path {
219 my ($class, $path) = @_;
220 File::Spec->catfile($path, '.modulebuildrc');
223 sub install_base_bin_path {
224 my ($class, $path) = @_;
225 File::Spec->catdir($path, 'bin');
228 sub install_base_perl_path {
229 my ($class, $path) = @_;
230 File::Spec->catdir($path, 'lib', 'perl5');
233 sub install_base_arch_path {
234 my ($class, $path) = @_;
235 File::Spec->catdir($class->install_base_perl_path($path), $Config{archname});
238 sub ensure_dir_structure_for {
239 my ($class, $path) = @_;
241 warn "Attempting to create directory ${path}\n";
243 File::Path::mkpath($path);
244 # Need to have the path exist to make a short name for it, so
245 # converting to a short name here.
246 $path = Win32::GetShortPathName($path) if $^O eq 'MSWin32';
247 my $modulebuildrc_path = $class->modulebuildrc_path($path);
248 if (-e $modulebuildrc_path) {
250 Carp::croak("${modulebuildrc_path} exists but is not a plain file");
253 warn "Attempting to create file ${modulebuildrc_path}\n";
254 open MODULEBUILDRC, '>', $modulebuildrc_path
255 || Carp::croak("Couldn't open ${modulebuildrc_path} for writing: $!");
256 print MODULEBUILDRC qq{install --install_base ${path}\n}
257 || Carp::croak("Couldn't write line to ${modulebuildrc_path}: $!");
259 || Carp::croak("Couldn't close file ${modulebuildrc_path}: $@");
265 sub INTERPOLATE_ENV () { 1 }
266 sub LITERAL_ENV () { 0 }
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 if(defined $ENV{'SHELL'}) {
280 my @shell_bin_path_parts = File::Spec->splitpath($ENV{'SHELL'});
281 $shellbin = $shell_bin_path_parts[-1];
284 local $_ = $shellbin;
292 # Both Win32 and Cygwin have $ENV{COMSPEC} set.
293 if (defined $ENV{'COMSPEC'} && $^O ne 'cygwin') {
294 my @shell_bin_path_parts = File::Spec->splitpath($ENV{'COMSPEC'});
295 $shellbin = $shell_bin_path_parts[-1];
297 local $_ = $shellbin;
300 } elsif(/cmd\.exe/) {
302 } elsif(/4nt\.exe/) {
311 my ($name, $value) = (shift(@envs), shift(@envs));
312 $value =~ s/(\\")/\\$1/g;
313 $out .= $class->${\"build_${shelltype}_env_declaration"}($name, $value);
318 # simple routines that take two arguments: an %ENV key and a value. return
319 # strings that are suitable for passing directly to the relevant shell to set
320 # said key to said value.
321 sub build_bourne_env_declaration {
323 my($name, $value) = @_;
324 return qq{export ${name}="${value}"\n};
327 sub build_csh_env_declaration {
329 my($name, $value) = @_;
330 return qq{setenv ${name} "${value}"\n};
333 sub build_win32_env_declaration {
335 my($name, $value) = @_;
336 return qq{set ${name}=${value}\n};
339 sub setup_env_hash_for {
340 my ($class, $path) = @_;
341 my %envs = $class->build_environment_vars_for($path, INTERPOLATE_ENV);
342 @ENV{keys %envs} = values %envs;
345 sub build_environment_vars_for {
346 my ($class, $path, $interpolate) = @_;
348 MODULEBUILDRC => $class->modulebuildrc_path($path),
349 PERL_MM_OPT => "INSTALL_BASE=${path}",
350 PERL5LIB => join($Config{path_sep},
351 $class->install_base_perl_path($path),
352 $class->install_base_arch_path($path),
354 ($interpolate == INTERPOLATE_ENV
356 : (($^O ne 'MSWin32') ? '$PERL5LIB' : '%PERL5LIB%' ))
359 PATH => join($Config{path_sep},
360 $class->install_base_bin_path($path),
361 ($interpolate == INTERPOLATE_ENV
363 : (($^O ne 'MSWin32') ? '$PATH' : '%PATH%' ))
372 File::Path::rmtree('t/var/splat');
374 $c->ensure_dir_structure_for('t/var/splat');
376 ok(-d 't/var/splat');
378 ok(-f 't/var/splat/.modulebuildrc');
384 local::lib - create and use a local lib/ for perl modules with PERL5LIB
390 use local::lib; # sets up a local lib at ~/perl5
392 use local::lib '~/foo'; # same, but ~/foo
396 use local::lib "$FindBin::Bin/../support"; # app-local support library
400 # Install LWP and it's missing dependencies to the 'my_lwp' directory
401 perl -MCPAN -Mlocal::lib=my_lwp -e 'CPAN::install(LWP)'
403 # Install LWP and *all non-core* dependencies to the 'my_lwp' directory
404 perl -MCPAN -Mlocal::lib=--self-contained,my_lwp -e 'CPAN::install(LWP)'
406 # Just print out useful shell commands
408 export MODULEBUILDRC=/home/username/perl/.modulebuildrc
409 export PERL_MM_OPT='INSTALL_BASE=/home/username/perl'
410 export PERL5LIB='/home/username/perl/lib/perl5:/home/username/perl/lib/perl5/i386-linux'
411 export PATH="/home/username/perl/bin:$PATH"
413 =head2 The bootstrapping technique
415 A typical way to install local::lib is using what is known as the
416 "bootstrapping" technique. You would do this if your system administrator
417 hasn't already installed local::lib. In this case, you'll need to install
418 local::lib in your home directory.
420 1. Download and unpack the local::lib tarball from CPAN (search for "Download"
421 on the CPAN page about local::lib). Do this as an ordinary user, not as root
422 or administrator. Unpack the file in your home directory or in any other
427 perl Makefile.PL --bootstrap
429 If the system asks you whether it should automatically configure as much
430 as possible, you would typically answer yes.
434 make test && make install
436 4. Arrange for Perl to use your own packages instead of the system
437 packages. If you are using bash, you can do this as follows:
439 echo 'eval $(perl -I$HOME/perl5/lib/perl5 -Mlocal::lib)' >>~/.bashrc
441 If you are using C shell, you can do this as follows:
446 perl -I$HOME/perl5/lib/perl5 -Mlocal::lib >> ~/.cshrc
448 You can also pass --bootstrap=~/foo to get a different location -
450 perl Makefile.PL --bootstrap=~/foo
451 make test && make install
453 echo 'eval $(perl -I$HOME/foo/lib/perl5 -Mlocal::lib=$HOME/foo)' >>~/.bashrc
455 After writing your shell configuration file, be sure to re-read it to get the
456 changed settings into your current shell's environment.
460 If you are using C shell, you can do this as follows:
465 perl -I$HOME/perl5/lib/perl5 -Mlocal::lib >> ~/.cshrc
469 You can also pass --bootstrap=~/foo to get a different location -
471 perl Makefile.PL --bootstrap=~/foo
472 make test && make install
474 echo 'eval $(perl -I$HOME/foo/lib/perl5 -Mlocal::lib=$HOME/foo)' >> ~/.bashrc
478 If you're on a slower machine, or are operating under draconian disk space
479 limitations, you can disable the automatic generation of manpages from POD when
480 installing modules by using the C<--no-manpages> argument when bootstrapping:
482 perl Makefile.PL --bootstrap --no-manpages
484 If you want to install multiple Perl module environments, say for application evelopment,
485 install local::lib globally and then:
489 eval $(perl -Mlocal::lib=./) ### To set the environment for this shell alone
490 printenv ### You will see that ~/mydir1 is in the PERL5LIB
491 perl -MCPAN -e install ... ### whatever modules you want
495 For multiple environments for multiple apps you may need to include a modified
496 version of the C<< use FindBin >> instructions in the "In code" sample above.
497 If you did something like the above, you have a set of Perl modules at C<<
498 ~/mydir1/lib >>. If you have a script at C<< ~/mydir1/scripts/myscript.pl >>,
499 you need to tell it where to find the modules you installed for it at C<<
502 In C<< ~/mydir1/scripts/myscript.pl >>:
506 use local::lib "$FindBin::Bin/.."; ### points to ~/mydir1 and local::lib finds lib
507 use lib "$FindBin::Bin/../lib"; ### points to ~/mydir1/lib
509 Put this before any BEGIN { ... } blocks that require the modules you installed.
511 =head2 Differences when using this module under Win32
513 C:\>perl -Mlocal::lib
514 set MODULEBUILDRC=C:\DOCUME~1\ADMINI~1\perl5\.modulebuildrc
515 set PERL_MM_OPT=INSTALL_BASE=C:\DOCUME~1\ADMINI~1\perl5
516 set PERL5LIB=C:\DOCUME~1\ADMINI~1\perl5\lib\perl5;C:\DOCUME~1\ADMINI~1\perl5\lib\perl5\MSWin32-x86-multi-thread
517 set PATH=C:\DOCUME~1\ADMINI~1\perl5\bin;%PATH%
519 ### To set the environment for this shell alone
520 C:\>perl -Mlocal::lib > %TEMP%\tmp.bat && %TEMP%\tmp.bat && del %TEMP%\temp.bat
521 ### instead of $(perl -Mlocal::lib=./)
523 If you want the environment entries to persist, you'll need to add then to the
524 Control Panel's System applet yourself at the moment.
526 The "~" is translated to the user's profile directory (the directory named for
527 the user under "Documents and Settings" (Windows XP or earlier) or "Users"
528 (Windows Vista or later) unless $ENV{HOME} exists. After that, the home
529 directory is translated to a short name (which means the directory must exist)
530 and the subdirectories are created.
534 The version of a Perl package on your machine is not always the version you
535 need. Obviously, the best thing to do would be to update to the version you
536 need. However, you might be in a situation where you're prevented from doing
537 this. Perhaps you don't have system administrator privileges; or perhaps you
538 are using a package management system such as Debian, and nobody has yet gotten
539 around to packaging up the version you need.
541 local::lib solves this problem by allowing you to create your own directory of
542 Perl packages downloaded from CPAN (in a multi-user system, this would typically
543 be within your own home directory). The existing system Perl installation is
544 not affected; you simply invoke Perl with special options so that Perl uses the
545 packages in your own local package directory rather than the system packages.
546 local::lib arranges things so that your locally installed version of the Perl
547 packages takes precedence over the system installation.
549 If you are using a package management system (such as Debian), you don't need to
550 worry about Debian and CPAN stepping on each other's toes. Your local version
551 of the packages will be written to an entirely separate directory from those
556 This module provides a quick, convenient way of bootstrapping a user-local Perl
557 module library located within the user's home directory. It also constructs and
558 prints out for the user the list of environment variables using the syntax
559 appropriate for the user's current shell (as specified by the C<SHELL>
560 environment variable), suitable for directly adding to one's shell
563 More generally, local::lib allows for the bootstrapping and usage of a
564 directory containing Perl modules outside of Perl's C<@INC>. This makes it
565 easier to ship an application with an app-specific copy of a Perl module, or
566 collection of modules. Useful in cases like when an upstream maintainer hasn't
567 applied a patch to a module of theirs that you need for your application.
569 On import, local::lib sets the following environment variables to appropriate
582 PATH is appended to, rather than clobbered.
586 These values are then available for reference by any code after import.
590 =head2 ensure_directory_structure_for
594 =item Arguments: path
598 Attempts to create the given path, and all required parent directories. Throws
599 an exception on failure.
601 =head2 print_environment_vars_for
605 =item Arguments: path
609 Prints to standard output the variables listed above, properly set to use the
610 given path as the base directory.
612 =head2 setup_env_hash_for
616 =item Arguments: path
620 Constructs the C<%ENV> keys for the given path, by calling
621 C<build_environment_vars_for>.
623 =head2 install_base_perl_path
627 =item Arguments: path
631 Returns a path describing where to install the Perl modules for this local
632 library installation. Appends the directories C<lib> and C<perl5> to the given
635 =head2 install_base_arch_path
639 =item Arguments: path
643 Returns a path describing where to install the architecture-specific Perl
644 modules for this local library installation. Based on the
645 L</install_base_perl_path> method's return value, and appends the value of
646 C<$Config{archname}>.
648 =head2 install_base_bin_path
652 =item Arguments: 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 modulebuildrc_path
664 =item Arguments: path
668 Returns a path describing where to install the C<.modulebuildrc> file, based on
671 =head2 resolve_empty_path
675 =item Arguments: path
679 Builds and returns the base path into which to set up the local module
680 installation. Defaults to C<~/perl5>.
682 =head2 resolve_home_path
686 =item Arguments: path
690 Attempts to find the user's home directory. If installed, uses C<File::HomeDir>
691 for this purpose. If no definite answer is available, throws an exception.
693 =head2 resolve_relative_path
697 =item Arguments: path
701 Translates the given path into an absolute path.
707 =item Arguments: path
711 Calls the following in a pipeline, passing the result from the previous to the
712 next, in an attempt to find where to configure the environment for a local
713 library installation: L</resolve_empty_path>, L</resolve_home_path>,
714 L</resolve_relative_path>. Passes the given path argument to
715 L</resolve_empty_path> which then returns a result that is passed to
716 L</resolve_home_path>, which then has its result passed to
717 L</resolve_relative_path>. The result of this final call is returned from
720 =head1 A WARNING ABOUT UNINST=1
722 Be careful about using local::lib in combination with "make install UNINST=1".
723 The idea of this feature is that will uninstall an old version of a module
724 before installing a new one. However it lacks a safety check that the old
725 version and the new version will go in the same directory. Used in combination
726 with local::lib, you can potentially delete a globally accessible version of a
727 module while installing the new version in a local place. Only combine "make
728 install UNINST=1" and local::lib if you understand these possible consequences.
732 Rather basic shell detection. Right now anything with csh in its name is
733 assumed to be a C shell or something compatible, and everything else is assumed
734 to be Bourne, except on Win32 systems. If the C<SHELL> environment variable is
735 not set, a Bourne-compatible shell is assumed.
737 Bootstrap is a hack and will use CPAN.pm for ExtUtils::MakeMaker even if you
738 have CPANPLUS installed.
740 Kills any existing PERL5LIB, PERL_MM_OPT or MODULEBUILDRC.
742 Should probably auto-fixup CPAN config if not already done.
744 Patches very much welcome for any of the above.
746 On Win32 systems, does not have a way to write the created environment variables
747 to the registry, so that they can persist through a reboot.
749 =head1 TROUBLESHOOTING
751 If you've configured local::lib to install CPAN modules somewhere in to your
752 home directory, and at some point later you try to install a module with C<cpan
753 -i Foo::Bar>, but it fails with an error like: C<Warning: You do not have
754 permissions to install into /usr/lib64/perl5/site_perl/5.8.8/x86_64-linux at
755 /usr/lib64/perl5/5.8.8/Foo/Bar.pm> and buried within the install log is an
756 error saying C<'INSTALL_BASE' is not a known MakeMaker parameter name>, then
757 you've somehow lost your updated ExtUtils::MakeMaker module.
759 To remedy this situation, rerun the bootstrapping procedure documented above.
761 Then, run C<rm -r ~/.cpan/build/Foo-Bar*>
763 Finally, re-run C<cpan -i Foo::Bar> and it should install without problems.
773 local::lib looks at the user's C<SHELL> environment variable when printing out
774 commands to add to the shell configuration file.
776 On Win32 systems, C<COMSPEC> is also examined.
782 Matt S Trout <mst@shadowcat.co.uk> http://www.shadowcat.co.uk/
784 auto_install fixes kindly sponsored by http://www.takkle.com/
788 Chris Nehren <apeiron@cpan.org> now oversees maintenance of local::lib, in
789 addition to providing doc patches and bootstrap fixes to prevent users from
790 shooting themselves in the foot (it's more likely than you think).
792 Patches to correctly output commands for csh style shells, as well as some
793 documentation additions, contributed by Christopher Nehren <apeiron@cpan.org>.
795 '--self-contained' feature contributed by Mark Stosberg <mark@summersault.com>.
797 Ability to pass '--self-contained' without a directory inspired by frew on
798 irc.perl.org/#catalyst.
800 Doc patches for a custom local::lib directory contributed by Torsten Raudssus
801 <torsten@raudssus.de>.
803 Hans Dieter Pearcey <hdp@cpan.org> sent in some additional tests for ensuring
804 things will install properly, submitted a fix for the bug causing problems with
805 writing Makefiles during bootstrapping, contributed an example program, and
806 submitted yet another fix to ensure that local::lib can install and bootstrap
807 properly. Many, many thanks!
809 pattern of Freenode IRC contributed the beginnings of the Troubleshooting
810 section. Many thanks!
812 Patch to add Win32 support contributed by Curtis Jewell <csjewell@cpan.org>.
814 kgish/#perl-help@irc.perl.org suggested revamping the section on sourcing the
815 shell file to make it clearer to those quickly reading the POD.
817 t0m and chrisa on #local-lib@irc.perl.org pointed out a PERL5LIB ordering issue
818 with C<--self-contained>.
822 Copyright (c) 2007 - 2009 the local::lib L</AUTHOR> and L</CONTRIBUTORS> as
827 This library is free software and may be distributed under the same terms