Commit | Line | Data |
b5cc15f7 |
1 | use strict; |
2 | use warnings; |
3 | |
4 | package local::lib; |
5 | |
c1441fb6 |
6 | use 5.008001; # probably works with earlier versions but I'm not supporting them |
7 | # (patches would, of course, be welcome) |
b5cc15f7 |
8 | |
9 | use File::Spec (); |
10 | use File::Path (); |
11 | use Carp (); |
12 | use Config; |
13 | |
adf315c3 |
14 | our $VERSION = '1.006007'; # 1.6.7 |
1f8043c8 |
15 | |
16 | our @KNOWN_FLAGS = qw(--self-contained); |
b5cc15f7 |
17 | |
18 | sub import { |
0fb70b9a |
19 | my ($class, @args) = @_; |
20 | |
e4892f2b |
21 | # Remember what PERL5LIB was when we started |
ea0824e7 |
22 | my $perl5lib = $ENV{PERL5LIB} || ''; |
e4892f2b |
23 | |
b9c94c15 |
24 | my %arg_store; |
25 | for my $arg (@args) { |
26 | # check for lethal dash first to stop processing before causing problems |
27 | if ($arg =~ /−/) { |
d4dbe584 |
28 | die <<'DEATH'; |
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. |
35 | DEATH |
b9c94c15 |
36 | } |
37 | elsif(grep { $arg eq $_ } @KNOWN_FLAGS) { |
38 | (my $flag = $arg) =~ s/--//; |
39 | $arg_store{$flag} = 1; |
40 | } |
41 | elsif($arg =~ /^--/) { |
42 | die "Unknown import argument: $arg"; |
43 | } |
44 | else { |
45 | # assume that what's left is a path |
46 | $arg_store{path} = $arg; |
47 | } |
d4dbe584 |
48 | } |
b9c94c15 |
49 | |
b10fc4d4 |
50 | if($arg_store{'self-contained'}) { |
1f8043c8 |
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"; |
0fb70b9a |
52 | } |
b9c94c15 |
53 | |
54 | $arg_store{path} = $class->resolve_path($arg_store{path}); |
55 | $class->setup_local_lib_for($arg_store{path}); |
0fb70b9a |
56 | |
6e5079df |
57 | for (@INC) { # Untaint @INC |
58 | next if ref; # Skip entry if it is an ARRAY, CODE, blessed, etc. |
59 | m/(.*)/ and $_ = $1; |
60 | } |
b5cc15f7 |
61 | } |
62 | |
5b94dce5 |
63 | sub pipeline; |
b5cc15f7 |
64 | |
5b94dce5 |
65 | sub pipeline { |
b5cc15f7 |
66 | my @methods = @_; |
67 | my $last = pop(@methods); |
68 | if (@methods) { |
69 | \sub { |
70 | my ($obj, @args) = @_; |
5b94dce5 |
71 | $obj->${pipeline @methods}( |
b5cc15f7 |
72 | $obj->$last(@args) |
73 | ); |
74 | }; |
75 | } else { |
76 | \sub { |
77 | shift->$last(@_); |
78 | }; |
79 | } |
80 | } |
81 | |
275c9dae |
82 | =begin testing |
83 | |
84 | #:: test pipeline |
b5cc15f7 |
85 | |
86 | package local::lib; |
87 | |
88 | { package Foo; sub foo { -$_[1] } sub bar { $_[1]+2 } sub baz { $_[1]+3 } } |
89 | my $foo = bless({}, 'Foo'); |
4c375968 |
90 | Test::More::ok($foo->${pipeline qw(foo bar baz)}(10) == -15); |
b5cc15f7 |
91 | |
275c9dae |
92 | =end testing |
93 | |
b5cc15f7 |
94 | =cut |
95 | |
a9489cb0 |
96 | sub _uniq { |
97 | my %seen; |
98 | grep { ! $seen{$_}++ } @_; |
99 | } |
100 | |
b5cc15f7 |
101 | sub resolve_path { |
102 | my ($class, $path) = @_; |
5b94dce5 |
103 | $class->${pipeline qw( |
b5cc15f7 |
104 | resolve_relative_path |
105 | resolve_home_path |
106 | resolve_empty_path |
107 | )}($path); |
108 | } |
109 | |
110 | sub resolve_empty_path { |
111 | my ($class, $path) = @_; |
112 | if (defined $path) { |
113 | $path; |
114 | } else { |
115 | '~/perl5'; |
116 | } |
117 | } |
118 | |
275c9dae |
119 | =begin testing |
120 | |
121 | #:: test classmethod setup |
b5cc15f7 |
122 | |
123 | my $c = 'local::lib'; |
124 | |
275c9dae |
125 | =end testing |
126 | |
127 | =begin testing |
b5cc15f7 |
128 | |
275c9dae |
129 | #:: test classmethod |
b5cc15f7 |
130 | |
131 | is($c->resolve_empty_path, '~/perl5'); |
132 | is($c->resolve_empty_path('foo'), 'foo'); |
133 | |
275c9dae |
134 | =end testing |
135 | |
b5cc15f7 |
136 | =cut |
137 | |
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; |
143 | my $homedir = do { |
8c6c886f |
144 | if (eval { require File::HomeDir } && $File::HomeDir::VERSION >= 0.65) { |
b5cc15f7 |
145 | $tried_file_homedir = 1; |
146 | if (defined $user) { |
147 | File::HomeDir->users_home($user); |
148 | } else { |
dc8ddd06 |
149 | File::HomeDir->my_home; |
b5cc15f7 |
150 | } |
151 | } else { |
152 | if (defined $user) { |
153 | (getpwnam $user)[7]; |
154 | } else { |
155 | if (defined $ENV{HOME}) { |
156 | $ENV{HOME}; |
157 | } else { |
158 | (getpwuid $<)[7]; |
159 | } |
160 | } |
161 | } |
162 | }; |
163 | unless (defined $homedir) { |
164 | Carp::croak( |
165 | "Couldn't resolve homedir for " |
166 | .(defined $user ? $user : 'current user') |
167 | .($tried_file_homedir ? '' : ' - consider installing File::HomeDir') |
168 | ); |
169 | } |
170 | $path =~ s/^~[^\/]*/$homedir/; |
171 | $path; |
172 | } |
173 | |
174 | sub resolve_relative_path { |
175 | my ($class, $path) = @_; |
53699c99 |
176 | $path = File::Spec->rel2abs($path); |
b5cc15f7 |
177 | } |
178 | |
275c9dae |
179 | =begin testing |
180 | |
181 | #:: test classmethod |
b5cc15f7 |
182 | |
183 | local *File::Spec::rel2abs = sub { shift; 'FOO'.shift; }; |
184 | is($c->resolve_relative_path('bar'),'FOObar'); |
185 | |
275c9dae |
186 | =end testing |
187 | |
b5cc15f7 |
188 | =cut |
189 | |
190 | sub setup_local_lib_for { |
191 | my ($class, $path) = @_; |
53699c99 |
192 | $path = $class->ensure_dir_structure_for($path); |
b5cc15f7 |
193 | if ($0 eq '-') { |
194 | $class->print_environment_vars_for($path); |
195 | exit 0; |
196 | } else { |
197 | $class->setup_env_hash_for($path); |
a9489cb0 |
198 | @INC = _uniq(split($Config{path_sep}, $ENV{PERL5LIB}), @INC); |
b5cc15f7 |
199 | } |
200 | } |
201 | |
202 | sub modulebuildrc_path { |
203 | my ($class, $path) = @_; |
204 | File::Spec->catfile($path, '.modulebuildrc'); |
205 | } |
206 | |
207 | sub install_base_bin_path { |
208 | my ($class, $path) = @_; |
209 | File::Spec->catdir($path, 'bin'); |
210 | } |
211 | |
212 | sub install_base_perl_path { |
213 | my ($class, $path) = @_; |
214 | File::Spec->catdir($path, 'lib', 'perl5'); |
215 | } |
216 | |
217 | sub install_base_arch_path { |
218 | my ($class, $path) = @_; |
219 | File::Spec->catdir($class->install_base_perl_path($path), $Config{archname}); |
220 | } |
221 | |
222 | sub ensure_dir_structure_for { |
223 | my ($class, $path) = @_; |
224 | unless (-d $path) { |
225 | warn "Attempting to create directory ${path}\n"; |
226 | } |
227 | File::Path::mkpath($path); |
53699c99 |
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'; |
b5cc15f7 |
231 | my $modulebuildrc_path = $class->modulebuildrc_path($path); |
232 | if (-e $modulebuildrc_path) { |
233 | unless (-f _) { |
234 | Carp::croak("${modulebuildrc_path} exists but is not a plain file"); |
235 | } |
236 | } else { |
237 | warn "Attempting to create file ${modulebuildrc_path}\n"; |
238 | open MODULEBUILDRC, '>', $modulebuildrc_path |
239 | || Carp::croak("Couldn't open ${modulebuildrc_path} for writing: $!"); |
18bb63e0 |
240 | print MODULEBUILDRC qq{install --install_base ${path}\n} |
b5cc15f7 |
241 | || Carp::croak("Couldn't write line to ${modulebuildrc_path}: $!"); |
242 | close MODULEBUILDRC |
243 | || Carp::croak("Couldn't close file ${modulebuildrc_path}: $@"); |
244 | } |
53699c99 |
245 | |
246 | return $path; |
b5cc15f7 |
247 | } |
248 | |
c2447f35 |
249 | sub INTERPOLATE_ENV () { 1 } |
250 | sub LITERAL_ENV () { 0 } |
b5cc15f7 |
251 | |
252 | sub print_environment_vars_for { |
253 | my ($class, $path) = @_; |
c2447f35 |
254 | my @envs = $class->build_environment_vars_for($path, LITERAL_ENV); |
b5cc15f7 |
255 | my $out = ''; |
1bc71e56 |
256 | |
0353dbc0 |
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 |
261 | # bourne. |
262 | my $shellbin = 'sh'; |
263 | if(defined $ENV{'SHELL'}) { |
264 | my @shell_bin_path_parts = File::Spec->splitpath($ENV{'SHELL'}); |
265 | $shellbin = $shell_bin_path_parts[-1]; |
266 | } |
1bc71e56 |
267 | my $shelltype = do { |
268 | local $_ = $shellbin; |
b42496e0 |
269 | if(/csh/) { |
1bc71e56 |
270 | 'csh' |
b42496e0 |
271 | } else { |
1bc71e56 |
272 | 'bourne' |
273 | } |
274 | }; |
275 | |
f58534b1 |
276 | # Both Win32 and Cygwin have $ENV{COMSPEC} set. |
277 | if (defined $ENV{'COMSPEC'} && $^O ne 'cygwin') { |
53699c99 |
278 | my @shell_bin_path_parts = File::Spec->splitpath($ENV{'COMSPEC'}); |
279 | $shellbin = $shell_bin_path_parts[-1]; |
280 | $shelltype = do { |
281 | local $_ = $shellbin; |
282 | if(/command\.com/) { |
283 | 'win32' |
284 | } elsif(/cmd\.exe/) { |
285 | 'win32' |
286 | } elsif(/4nt\.exe/) { |
287 | 'win32' |
288 | } else { |
289 | $shelltype |
290 | } |
291 | }; |
292 | } |
293 | |
b5cc15f7 |
294 | while (@envs) { |
295 | my ($name, $value) = (shift(@envs), shift(@envs)); |
296 | $value =~ s/(\\")/\\$1/g; |
1bc71e56 |
297 | $out .= $class->${\"build_${shelltype}_env_declaration"}($name, $value); |
b5cc15f7 |
298 | } |
299 | print $out; |
300 | } |
301 | |
1bc71e56 |
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 { |
306 | my $class = shift; |
307 | my($name, $value) = @_; |
308 | return qq{export ${name}="${value}"\n}; |
309 | } |
310 | |
311 | sub build_csh_env_declaration { |
312 | my $class = shift; |
313 | my($name, $value) = @_; |
314 | return qq{setenv ${name} "${value}"\n}; |
315 | } |
316 | |
53699c99 |
317 | sub build_win32_env_declaration { |
318 | my $class = shift; |
319 | my($name, $value) = @_; |
320 | return qq{set ${name}=${value}\n}; |
321 | } |
322 | |
b5cc15f7 |
323 | sub setup_env_hash_for { |
324 | my ($class, $path) = @_; |
c2447f35 |
325 | my %envs = $class->build_environment_vars_for($path, INTERPOLATE_ENV); |
b5cc15f7 |
326 | @ENV{keys %envs} = values %envs; |
327 | } |
328 | |
329 | sub build_environment_vars_for { |
330 | my ($class, $path, $interpolate) = @_; |
331 | return ( |
332 | MODULEBUILDRC => $class->modulebuildrc_path($path), |
333 | PERL_MM_OPT => "INSTALL_BASE=${path}", |
53699c99 |
334 | PERL5LIB => join($Config{path_sep}, |
b5cc15f7 |
335 | $class->install_base_arch_path($path), |
1b2a57eb |
336 | $class->install_base_perl_path($path), |
03b91976 |
337 | (($ENV{PERL5LIB}||()) ? |
c2447f35 |
338 | ($interpolate == INTERPOLATE_ENV |
339 | ? ($ENV{PERL5LIB}) |
53699c99 |
340 | : (($^O ne 'MSWin32') ? '$PERL5LIB' : '%PERL5LIB%' )) |
c2447f35 |
341 | : ()) |
b5cc15f7 |
342 | ), |
53699c99 |
343 | PATH => join($Config{path_sep}, |
b5cc15f7 |
344 | $class->install_base_bin_path($path), |
c2447f35 |
345 | ($interpolate == INTERPOLATE_ENV |
03b91976 |
346 | ? ($ENV{PATH}||()) |
53699c99 |
347 | : (($^O ne 'MSWin32') ? '$PATH' : '%PATH%' )) |
b5cc15f7 |
348 | ), |
349 | ) |
350 | } |
351 | |
275c9dae |
352 | =begin testing |
353 | |
354 | #:: test classmethod |
b5cc15f7 |
355 | |
356 | File::Path::rmtree('t/var/splat'); |
357 | |
4c375968 |
358 | $c->ensure_dir_structure_for('t/var/splat'); |
b5cc15f7 |
359 | |
360 | ok(-d 't/var/splat'); |
361 | |
362 | ok(-f 't/var/splat/.modulebuildrc'); |
363 | |
275c9dae |
364 | =end testing |
365 | |
898f36cf |
366 | =encoding utf8 |
367 | |
b5cc15f7 |
368 | =head1 NAME |
369 | |
370 | local::lib - create and use a local lib/ for perl modules with PERL5LIB |
371 | |
372 | =head1 SYNOPSIS |
373 | |
374 | In code - |
375 | |
376 | use local::lib; # sets up a local lib at ~/perl5 |
377 | |
378 | use local::lib '~/foo'; # same, but ~/foo |
379 | |
1bc71e56 |
380 | # Or... |
381 | use FindBin; |
382 | use local::lib "$FindBin::Bin/../support"; # app-local support library |
383 | |
b5cc15f7 |
384 | From the shell - |
385 | |
359329d3 |
386 | # Install LWP and its missing dependencies to the '~/perl5' directory |
387 | perl -MCPAN -Mlocal::lib -e 'CPAN::install(LWP)' |
0fb70b9a |
388 | |
0fb70b9a |
389 | # Just print out useful shell commands |
b5cc15f7 |
390 | $ perl -Mlocal::lib |
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" |
395 | |
322b0a0d |
396 | =head2 The bootstrapping technique |
bc30e1d5 |
397 | |
730f5dda |
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 |
898f36cf |
401 | local::lib in your home directory. |
402 | |
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. |
407 | |
04f8efde |
408 | By default local::lib installs itself and the CPAN modules into ~/perl5. |
409 | |
898f36cf |
410 | Windows users must also see L</Differences when using this module under Win32>. |
715c31a0 |
411 | |
730f5dda |
412 | 1. Download and unpack the local::lib tarball from CPAN (search for "Download" |
413 | on the CPAN page about local::lib). Do this as an ordinary user, not as root |
414 | or administrator. Unpack the file in your home directory or in any other |
415 | convenient location. |
715c31a0 |
416 | |
730f5dda |
417 | 2. Run this: |
715c31a0 |
418 | |
730f5dda |
419 | perl Makefile.PL --bootstrap |
715c31a0 |
420 | |
730f5dda |
421 | If the system asks you whether it should automatically configure as much |
422 | as possible, you would typically answer yes. |
423 | |
04f8efde |
424 | In order to install local::lib into a directory other than the default, you need |
425 | to specify the name of the directory when you call bootstrap, as follows: |
898f36cf |
426 | |
427 | perl Makefile.PL --bootstrap=~/foo |
428 | |
429 | 3. Run this: (local::lib assumes you have make installed on your system) |
730f5dda |
430 | |
431 | make test && make install |
432 | |
898f36cf |
433 | 4. Now we need to setup the appropriate environment variables, so that Perl |
434 | starts using our newly generated lib/ directory. If you are using bash or |
435 | any other Bourne shells, you can add this to your shell startup script this |
436 | way: |
730f5dda |
437 | |
438 | echo 'eval $(perl -I$HOME/perl5/lib/perl5 -Mlocal::lib)' >>~/.bashrc |
439 | |
440 | If you are using C shell, you can do this as follows: |
441 | |
442 | /bin/csh |
443 | echo $SHELL |
618272fe |
444 | /bin/csh |
730f5dda |
445 | perl -I$HOME/perl5/lib/perl5 -Mlocal::lib >> ~/.cshrc |
dc8ddd06 |
446 | |
898f36cf |
447 | If you passed to bootstrap a directory other than default, you also need to give that as |
448 | import parameter to the call of the local::lib module like this way: |
8b1e8e69 |
449 | |
730f5dda |
450 | echo 'eval $(perl -I$HOME/foo/lib/perl5 -Mlocal::lib=$HOME/foo)' >>~/.bashrc |
618272fe |
451 | |
aab64481 |
452 | After writing your shell configuration file, be sure to re-read it to get the |
898f36cf |
453 | changed settings into your current shell's environment. Bourne shells use |
454 | C<. ~/.bashrc> for this, whereas C shells use C<source ~/.cshrc>. |
aab64481 |
455 | |
b9c94c15 |
456 | If you're on a slower machine, or are operating under draconian disk space |
457 | limitations, you can disable the automatic generation of manpages from POD when |
458 | installing modules by using the C<--no-manpages> argument when bootstrapping: |
459 | |
730f5dda |
460 | perl Makefile.PL --bootstrap --no-manpages |
b9c94c15 |
461 | |
898f36cf |
462 | To avoid doing several bootstrap for several Perl module environments on the |
463 | same account, for example if you use it for several different deployed |
464 | applications independently, you can use one bootstrapped local::lib |
465 | installation to install modules in different directories directly this way: |
977a9ca3 |
466 | |
730f5dda |
467 | cd ~/mydir1 |
468 | perl -Mlocal::lib=./ |
469 | eval $(perl -Mlocal::lib=./) ### To set the environment for this shell alone |
898f36cf |
470 | printenv ### You will see that ~/mydir1 is in the PERL5LIB |
730f5dda |
471 | perl -MCPAN -e install ... ### whatever modules you want |
472 | cd ../mydir2 |
473 | ... REPEAT ... |
474 | |
475 | For multiple environments for multiple apps you may need to include a modified |
476 | version of the C<< use FindBin >> instructions in the "In code" sample above. |
477 | If you did something like the above, you have a set of Perl modules at C<< |
478 | ~/mydir1/lib >>. If you have a script at C<< ~/mydir1/scripts/myscript.pl >>, |
479 | you need to tell it where to find the modules you installed for it at C<< |
480 | ~/mydir1/lib >>. |
977a9ca3 |
481 | |
482 | In C<< ~/mydir1/scripts/myscript.pl >>: |
483 | |
730f5dda |
484 | use strict; |
485 | use warnings; |
486 | use local::lib "$FindBin::Bin/.."; ### points to ~/mydir1 and local::lib finds lib |
487 | use lib "$FindBin::Bin/../lib"; ### points to ~/mydir1/lib |
977a9ca3 |
488 | |
489 | Put this before any BEGIN { ... } blocks that require the modules you installed. |
490 | |
53699c99 |
491 | =head2 Differences when using this module under Win32 |
492 | |
76f30678 |
493 | To set up the proper environment variables for your current session of |
494 | C<CMD.exe>, you can use this: |
495 | |
730f5dda |
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% |
501 | |
898f36cf |
502 | ### To set the environment for this shell alone |
730f5dda |
503 | C:\>perl -Mlocal::lib > %TEMP%\tmp.bat && %TEMP%\tmp.bat && del %TEMP%\temp.bat |
504 | ### instead of $(perl -Mlocal::lib=./) |
53699c99 |
505 | |
506 | If you want the environment entries to persist, you'll need to add then to the |
76f30678 |
507 | Control Panel's System applet yourself or use L<App::local::lib::Win32Helper>. |
53699c99 |
508 | |
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" |
9bc0788f |
511 | (Windows Vista or later)) unless $ENV{HOME} exists. After that, the home |
53699c99 |
512 | directory is translated to a short name (which means the directory must exist) |
513 | and the subdirectories are created. |
514 | |
730f5dda |
515 | =head1 RATIONALE |
516 | |
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. |
523 | |
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. |
531 | |
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 |
535 | installed by Debian. |
536 | |
618272fe |
537 | =head1 DESCRIPTION |
538 | |
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> |
730f5dda |
543 | environment variable), suitable for directly adding to one's shell |
544 | configuration file. |
545 | |
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. |
1bc71e56 |
551 | |
552 | On import, local::lib sets the following environment variables to appropriate |
553 | values: |
554 | |
555 | =over 4 |
556 | |
557 | =item MODULEBUILDRC |
558 | |
559 | =item PERL_MM_OPT |
560 | |
561 | =item PERL5LIB |
562 | |
563 | =item PATH |
564 | |
565 | PATH is appended to, rather than clobbered. |
566 | |
567 | =back |
568 | |
569 | These values are then available for reference by any code after import. |
570 | |
b0c48f8e |
571 | =head1 CREATING A SELF-CONTAINED SET OF MODULES |
572 | |
a949ebcd |
573 | See L<lib::core::only> for one way to do this - but note that |
d8b1a404 |
574 | there are a number of caveats, and the best approach is always to perform a |
575 | build against a clean perl (i.e. site and vendor as close to empty as possible). |
b0c48f8e |
576 | |
480e6e85 |
577 | =head1 METHODS |
578 | |
a949ebcd |
579 | =head2 ensure_dir_structure_for |
480e6e85 |
580 | |
581 | =over 4 |
582 | |
a949ebcd |
583 | =item Arguments: $path |
584 | |
585 | =item Return value: None |
480e6e85 |
586 | |
587 | =back |
588 | |
589 | Attempts to create the given path, and all required parent directories. Throws |
590 | an exception on failure. |
591 | |
592 | =head2 print_environment_vars_for |
593 | |
594 | =over 4 |
595 | |
a949ebcd |
596 | =item Arguments: $path |
597 | |
598 | =item Return value: None |
480e6e85 |
599 | |
600 | =back |
601 | |
602 | Prints to standard output the variables listed above, properly set to use the |
603 | given path as the base directory. |
604 | |
a949ebcd |
605 | =head2 build_environment_vars_for |
606 | |
607 | =over 4 |
608 | |
609 | =item Arguments: $path, $interpolate |
610 | |
611 | =item Return value: \%environment_vars |
612 | |
613 | =back |
614 | |
291b5a3a |
615 | Returns a hash with the variables listed above, properly set to use the |
616 | given path as the base directory. |
617 | |
480e6e85 |
618 | =head2 setup_env_hash_for |
619 | |
620 | =over 4 |
621 | |
a949ebcd |
622 | =item Arguments: $path |
623 | |
624 | =item Return value: None |
480e6e85 |
625 | |
626 | =back |
627 | |
628 | Constructs the C<%ENV> keys for the given path, by calling |
a949ebcd |
629 | L</build_environment_vars_for>. |
480e6e85 |
630 | |
631 | =head2 install_base_perl_path |
632 | |
633 | =over 4 |
634 | |
a949ebcd |
635 | =item Arguments: $path |
636 | |
637 | =item Return value: $install_base_perl_path |
480e6e85 |
638 | |
639 | =back |
640 | |
641 | Returns a path describing where to install the Perl modules for this local |
642 | library installation. Appends the directories C<lib> and C<perl5> to the given |
643 | path. |
644 | |
645 | =head2 install_base_arch_path |
646 | |
647 | =over 4 |
648 | |
a949ebcd |
649 | =item Arguments: $path |
650 | |
651 | =item Return value: $install_base_arch_path |
480e6e85 |
652 | |
653 | =back |
654 | |
655 | Returns a path describing where to install the architecture-specific Perl |
656 | modules for this local library installation. Based on the |
657 | L</install_base_perl_path> method's return value, and appends the value of |
658 | C<$Config{archname}>. |
659 | |
660 | =head2 install_base_bin_path |
661 | |
662 | =over 4 |
663 | |
a949ebcd |
664 | =item Arguments: $path |
665 | |
666 | =item Return value: $install_base_bin_path |
480e6e85 |
667 | |
668 | =back |
669 | |
670 | Returns a path describing where to install the executable programs for this |
671 | local library installation. Based on the L</install_base_perl_path> method's |
672 | return value, and appends the directory C<bin>. |
673 | |
674 | =head2 modulebuildrc_path |
675 | |
676 | =over 4 |
677 | |
a949ebcd |
678 | =item Arguments: $path |
679 | |
680 | =item Return value: $modulebuildrc_path |
480e6e85 |
681 | |
682 | =back |
683 | |
684 | Returns a path describing where to install the C<.modulebuildrc> file, based on |
685 | the given path. |
686 | |
687 | =head2 resolve_empty_path |
688 | |
689 | =over 4 |
690 | |
a949ebcd |
691 | =item Arguments: $path |
692 | |
693 | =item Return value: $base_path |
480e6e85 |
694 | |
695 | =back |
696 | |
697 | Builds and returns the base path into which to set up the local module |
698 | installation. Defaults to C<~/perl5>. |
699 | |
700 | =head2 resolve_home_path |
701 | |
702 | =over 4 |
703 | |
a949ebcd |
704 | =item Arguments: $path |
705 | |
706 | =item Return value: $home_path |
480e6e85 |
707 | |
708 | =back |
709 | |
710 | Attempts to find the user's home directory. If installed, uses C<File::HomeDir> |
711 | for this purpose. If no definite answer is available, throws an exception. |
712 | |
713 | =head2 resolve_relative_path |
714 | |
715 | =over 4 |
716 | |
a949ebcd |
717 | =item Arguments: $path |
718 | |
719 | =item Return value: $absolute_path |
480e6e85 |
720 | |
721 | =back |
722 | |
723 | Translates the given path into an absolute path. |
724 | |
725 | =head2 resolve_path |
726 | |
727 | =over 4 |
728 | |
a949ebcd |
729 | =item Arguments: $path |
730 | |
731 | =item Return value: $absolute_path |
480e6e85 |
732 | |
733 | =back |
734 | |
735 | Calls the following in a pipeline, passing the result from the previous to the |
736 | next, in an attempt to find where to configure the environment for a local |
737 | library installation: L</resolve_empty_path>, L</resolve_home_path>, |
738 | L</resolve_relative_path>. Passes the given path argument to |
739 | L</resolve_empty_path> which then returns a result that is passed to |
740 | L</resolve_home_path>, which then has its result passed to |
741 | L</resolve_relative_path>. The result of this final call is returned from |
742 | L</resolve_path>. |
743 | |
0fb70b9a |
744 | =head1 A WARNING ABOUT UNINST=1 |
745 | |
746 | Be careful about using local::lib in combination with "make install UNINST=1". |
747 | The idea of this feature is that will uninstall an old version of a module |
748 | before installing a new one. However it lacks a safety check that the old |
749 | version and the new version will go in the same directory. Used in combination |
750 | with local::lib, you can potentially delete a globally accessible version of a |
381738d7 |
751 | module while installing the new version in a local place. Only combine "make |
0fb70b9a |
752 | install UNINST=1" and local::lib if you understand these possible consequences. |
753 | |
dc8ddd06 |
754 | =head1 LIMITATIONS |
755 | |
47e70ca1 |
756 | The perl toolchain is unable to handle directory names with spaces in it, |
a8e981cf |
757 | so you cant put your local::lib bootstrap into a directory with spaces. What |
758 | you can do is moving your local::lib to a directory with spaces B<after> you |
759 | installed all modules inside your local::lib bootstrap. But be aware that you |
760 | cant update or install CPAN modules after the move. |
47e70ca1 |
761 | |
618272fe |
762 | Rather basic shell detection. Right now anything with csh in its name is |
763 | assumed to be a C shell or something compatible, and everything else is assumed |
53699c99 |
764 | to be Bourne, except on Win32 systems. If the C<SHELL> environment variable is |
765 | not set, a Bourne-compatible shell is assumed. |
dc8ddd06 |
766 | |
767 | Bootstrap is a hack and will use CPAN.pm for ExtUtils::MakeMaker even if you |
768 | have CPANPLUS installed. |
769 | |
770 | Kills any existing PERL5LIB, PERL_MM_OPT or MODULEBUILDRC. |
771 | |
e423efce |
772 | Should probably auto-fixup CPAN config if not already done. |
773 | |
dc8ddd06 |
774 | Patches very much welcome for any of the above. |
bc30e1d5 |
775 | |
53699c99 |
776 | On Win32 systems, does not have a way to write the created environment variables |
777 | to the registry, so that they can persist through a reboot. |
778 | |
9a021b2b |
779 | =head1 TROUBLESHOOTING |
780 | |
781 | If you've configured local::lib to install CPAN modules somewhere in to your |
782 | home directory, and at some point later you try to install a module with C<cpan |
783 | -i Foo::Bar>, but it fails with an error like: C<Warning: You do not have |
784 | permissions to install into /usr/lib64/perl5/site_perl/5.8.8/x86_64-linux at |
785 | /usr/lib64/perl5/5.8.8/Foo/Bar.pm> and buried within the install log is an |
786 | error saying C<'INSTALL_BASE' is not a known MakeMaker parameter name>, then |
787 | you've somehow lost your updated ExtUtils::MakeMaker module. |
788 | |
789 | To remedy this situation, rerun the bootstrapping procedure documented above. |
790 | |
791 | Then, run C<rm -r ~/.cpan/build/Foo-Bar*> |
792 | |
793 | Finally, re-run C<cpan -i Foo::Bar> and it should install without problems. |
794 | |
618272fe |
795 | =head1 ENVIRONMENT |
796 | |
797 | =over 4 |
798 | |
799 | =item SHELL |
800 | |
53699c99 |
801 | =item COMSPEC |
802 | |
618272fe |
803 | local::lib looks at the user's C<SHELL> environment variable when printing out |
804 | commands to add to the shell configuration file. |
805 | |
53699c99 |
806 | On Win32 systems, C<COMSPEC> is also examined. |
807 | |
618272fe |
808 | =back |
809 | |
cc19e8d4 |
810 | =head1 SUPPORT |
811 | |
812 | IRC: |
813 | |
814 | Join #local-lib on irc.perl.org. |
815 | |
b5cc15f7 |
816 | =head1 AUTHOR |
817 | |
818 | Matt S Trout <mst@shadowcat.co.uk> http://www.shadowcat.co.uk/ |
819 | |
d6b71a2d |
820 | auto_install fixes kindly sponsored by http://www.takkle.com/ |
821 | |
b5c1154d |
822 | =head1 CONTRIBUTORS |
823 | |
824 | Patches to correctly output commands for csh style shells, as well as some |
825 | documentation additions, contributed by Christopher Nehren <apeiron@cpan.org>. |
826 | |
cc19e8d4 |
827 | Doc patches for a custom local::lib directory, more cleanups in the english |
a949ebcd |
828 | documentation and a L<german documentation|POD2::DE::local::lib> contributed by Torsten Raudssus |
8b1e8e69 |
829 | <torsten@raudssus.de>. |
830 | |
be160790 |
831 | Hans Dieter Pearcey <hdp@cpan.org> sent in some additional tests for ensuring |
9a021b2b |
832 | things will install properly, submitted a fix for the bug causing problems with |
833 | writing Makefiles during bootstrapping, contributed an example program, and |
834 | submitted yet another fix to ensure that local::lib can install and bootstrap |
835 | properly. Many, many thanks! |
836 | |
837 | pattern of Freenode IRC contributed the beginnings of the Troubleshooting |
838 | section. Many thanks! |
be160790 |
839 | |
53699c99 |
840 | Patch to add Win32 support contributed by Curtis Jewell <csjewell@cpan.org>. |
841 | |
03b91976 |
842 | Warnings for missing PATH/PERL5LIB (as when not running interactively) silenced |
843 | by a patch from Marco Emilio Poleggi. |
844 | |
1f8043c8 |
845 | Mark Stosberg <mark@summersault.com> provided the code for the now deleted |
846 | '--self-contained' option. |
847 | |
76f30678 |
848 | Documentation patches to make win32 usage clearer by |
849 | David Mertens <dcmertens.perl@gmail.com> (run4flat). |
850 | |
a949ebcd |
851 | Brazilian L<portuguese translation|POD2::PT_BR::local::lib> and minor doc patches contributed by Breno |
ccf362c0 |
852 | G. de Oliveira <garu@cpan.org>. |
853 | |
7c0db165 |
854 | =head1 COPYRIGHT |
855 | |
cc19e8d4 |
856 | Copyright (c) 2007 - 2010 the local::lib L</AUTHOR> and L</CONTRIBUTORS> as |
7c0db165 |
857 | listed above. |
858 | |
b5cc15f7 |
859 | =head1 LICENSE |
860 | |
7c0db165 |
861 | This library is free software and may be distributed under the same terms |
862 | as perl itself. |
b5cc15f7 |
863 | |
864 | =cut |
865 | |
866 | 1; |