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 | |
45fa6ab3 |
14 | our $VERSION = '1.008001'; # 1.8.1 |
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 | |
b5cc15f7 |
202 | sub install_base_bin_path { |
203 | my ($class, $path) = @_; |
204 | File::Spec->catdir($path, 'bin'); |
205 | } |
206 | |
207 | sub install_base_perl_path { |
208 | my ($class, $path) = @_; |
209 | File::Spec->catdir($path, 'lib', 'perl5'); |
210 | } |
211 | |
212 | sub install_base_arch_path { |
213 | my ($class, $path) = @_; |
214 | File::Spec->catdir($class->install_base_perl_path($path), $Config{archname}); |
215 | } |
216 | |
217 | sub ensure_dir_structure_for { |
218 | my ($class, $path) = @_; |
219 | unless (-d $path) { |
220 | warn "Attempting to create directory ${path}\n"; |
221 | } |
222 | File::Path::mkpath($path); |
53699c99 |
223 | # Need to have the path exist to make a short name for it, so |
224 | # converting to a short name here. |
225 | $path = Win32::GetShortPathName($path) if $^O eq 'MSWin32'; |
53699c99 |
226 | |
227 | return $path; |
b5cc15f7 |
228 | } |
229 | |
c2447f35 |
230 | sub INTERPOLATE_ENV () { 1 } |
231 | sub LITERAL_ENV () { 0 } |
b5cc15f7 |
232 | |
c4e3c83b |
233 | sub guess_shelltype { |
0353dbc0 |
234 | my $shellbin = 'sh'; |
235 | if(defined $ENV{'SHELL'}) { |
236 | my @shell_bin_path_parts = File::Spec->splitpath($ENV{'SHELL'}); |
237 | $shellbin = $shell_bin_path_parts[-1]; |
238 | } |
1bc71e56 |
239 | my $shelltype = do { |
240 | local $_ = $shellbin; |
b42496e0 |
241 | if(/csh/) { |
1bc71e56 |
242 | 'csh' |
b42496e0 |
243 | } else { |
1bc71e56 |
244 | 'bourne' |
245 | } |
246 | }; |
247 | |
f58534b1 |
248 | # Both Win32 and Cygwin have $ENV{COMSPEC} set. |
249 | if (defined $ENV{'COMSPEC'} && $^O ne 'cygwin') { |
53699c99 |
250 | my @shell_bin_path_parts = File::Spec->splitpath($ENV{'COMSPEC'}); |
251 | $shellbin = $shell_bin_path_parts[-1]; |
252 | $shelltype = do { |
253 | local $_ = $shellbin; |
254 | if(/command\.com/) { |
255 | 'win32' |
256 | } elsif(/cmd\.exe/) { |
257 | 'win32' |
258 | } elsif(/4nt\.exe/) { |
259 | 'win32' |
260 | } else { |
261 | $shelltype |
262 | } |
263 | }; |
264 | } |
c4e3c83b |
265 | return $shelltype; |
266 | } |
267 | |
268 | sub print_environment_vars_for { |
269 | my ($class, $path) = @_; |
8cc924b8 |
270 | print $class->environment_vars_string_for($path); |
271 | } |
272 | |
273 | sub environment_vars_string_for { |
274 | my ($class, $path) = @_; |
c4e3c83b |
275 | my @envs = $class->build_environment_vars_for($path, LITERAL_ENV); |
276 | my $out = ''; |
277 | |
278 | # rather basic csh detection, goes on the assumption that something won't |
279 | # call itself csh unless it really is. also, default to bourne in the |
280 | # pathological situation where a user doesn't have $ENV{SHELL} defined. |
281 | # note also that shells with funny names, like zoid, are assumed to be |
282 | # bourne. |
283 | |
284 | my $shelltype = $class->guess_shelltype; |
53699c99 |
285 | |
b5cc15f7 |
286 | while (@envs) { |
287 | my ($name, $value) = (shift(@envs), shift(@envs)); |
288 | $value =~ s/(\\")/\\$1/g; |
1bc71e56 |
289 | $out .= $class->${\"build_${shelltype}_env_declaration"}($name, $value); |
b5cc15f7 |
290 | } |
8cc924b8 |
291 | return $out; |
b5cc15f7 |
292 | } |
293 | |
1bc71e56 |
294 | # simple routines that take two arguments: an %ENV key and a value. return |
295 | # strings that are suitable for passing directly to the relevant shell to set |
296 | # said key to said value. |
297 | sub build_bourne_env_declaration { |
298 | my $class = shift; |
299 | my($name, $value) = @_; |
300 | return qq{export ${name}="${value}"\n}; |
301 | } |
302 | |
303 | sub build_csh_env_declaration { |
304 | my $class = shift; |
305 | my($name, $value) = @_; |
306 | return qq{setenv ${name} "${value}"\n}; |
307 | } |
308 | |
53699c99 |
309 | sub build_win32_env_declaration { |
310 | my $class = shift; |
311 | my($name, $value) = @_; |
312 | return qq{set ${name}=${value}\n}; |
313 | } |
314 | |
b5cc15f7 |
315 | sub setup_env_hash_for { |
316 | my ($class, $path) = @_; |
c2447f35 |
317 | my %envs = $class->build_environment_vars_for($path, INTERPOLATE_ENV); |
b5cc15f7 |
318 | @ENV{keys %envs} = values %envs; |
319 | } |
320 | |
321 | sub build_environment_vars_for { |
322 | my ($class, $path, $interpolate) = @_; |
323 | return ( |
4de80824 |
324 | PERL_LOCAL_LIB_ROOT => $path, |
e322149f |
325 | PERL_MB_OPT => "--install_base ${path}", |
b5cc15f7 |
326 | PERL_MM_OPT => "INSTALL_BASE=${path}", |
53699c99 |
327 | PERL5LIB => join($Config{path_sep}, |
b5cc15f7 |
328 | $class->install_base_arch_path($path), |
1b2a57eb |
329 | $class->install_base_perl_path($path), |
03b91976 |
330 | (($ENV{PERL5LIB}||()) ? |
c2447f35 |
331 | ($interpolate == INTERPOLATE_ENV |
332 | ? ($ENV{PERL5LIB}) |
53699c99 |
333 | : (($^O ne 'MSWin32') ? '$PERL5LIB' : '%PERL5LIB%' )) |
c2447f35 |
334 | : ()) |
b5cc15f7 |
335 | ), |
53699c99 |
336 | PATH => join($Config{path_sep}, |
b5cc15f7 |
337 | $class->install_base_bin_path($path), |
c2447f35 |
338 | ($interpolate == INTERPOLATE_ENV |
03b91976 |
339 | ? ($ENV{PATH}||()) |
53699c99 |
340 | : (($^O ne 'MSWin32') ? '$PATH' : '%PATH%' )) |
b5cc15f7 |
341 | ), |
342 | ) |
343 | } |
344 | |
275c9dae |
345 | =begin testing |
346 | |
347 | #:: test classmethod |
b5cc15f7 |
348 | |
349 | File::Path::rmtree('t/var/splat'); |
350 | |
4c375968 |
351 | $c->ensure_dir_structure_for('t/var/splat'); |
b5cc15f7 |
352 | |
353 | ok(-d 't/var/splat'); |
354 | |
275c9dae |
355 | =end testing |
356 | |
898f36cf |
357 | =encoding utf8 |
358 | |
b5cc15f7 |
359 | =head1 NAME |
360 | |
361 | local::lib - create and use a local lib/ for perl modules with PERL5LIB |
362 | |
363 | =head1 SYNOPSIS |
364 | |
365 | In code - |
366 | |
367 | use local::lib; # sets up a local lib at ~/perl5 |
368 | |
369 | use local::lib '~/foo'; # same, but ~/foo |
370 | |
1bc71e56 |
371 | # Or... |
372 | use FindBin; |
373 | use local::lib "$FindBin::Bin/../support"; # app-local support library |
374 | |
b5cc15f7 |
375 | From the shell - |
376 | |
359329d3 |
377 | # Install LWP and its missing dependencies to the '~/perl5' directory |
378 | perl -MCPAN -Mlocal::lib -e 'CPAN::install(LWP)' |
0fb70b9a |
379 | |
0fb70b9a |
380 | # Just print out useful shell commands |
b5cc15f7 |
381 | $ perl -Mlocal::lib |
e322149f |
382 | export PERL_MB_OPT='--install_base /home/username/perl5' |
c4e3c83b |
383 | export PERL_MM_OPT='INSTALL_BASE=/home/username/perl5' |
384 | export PERL5LIB='/home/username/perl5/lib/perl5/i386-linux:/home/username/perl5/lib/perl5' |
385 | export PATH="/home/username/perl5/bin:$PATH" |
b5cc15f7 |
386 | |
322b0a0d |
387 | =head2 The bootstrapping technique |
bc30e1d5 |
388 | |
730f5dda |
389 | A typical way to install local::lib is using what is known as the |
390 | "bootstrapping" technique. You would do this if your system administrator |
391 | hasn't already installed local::lib. In this case, you'll need to install |
898f36cf |
392 | local::lib in your home directory. |
393 | |
394 | If you do have administrative privileges, you will still want to set up your |
395 | environment variables, as discussed in step 4. Without this, you would still |
396 | install the modules into the system CPAN installation and also your Perl scripts |
397 | will not use the lib/ path you bootstrapped with local::lib. |
398 | |
04f8efde |
399 | By default local::lib installs itself and the CPAN modules into ~/perl5. |
400 | |
898f36cf |
401 | Windows users must also see L</Differences when using this module under Win32>. |
715c31a0 |
402 | |
730f5dda |
403 | 1. Download and unpack the local::lib tarball from CPAN (search for "Download" |
404 | on the CPAN page about local::lib). Do this as an ordinary user, not as root |
405 | or administrator. Unpack the file in your home directory or in any other |
406 | convenient location. |
715c31a0 |
407 | |
730f5dda |
408 | 2. Run this: |
715c31a0 |
409 | |
730f5dda |
410 | perl Makefile.PL --bootstrap |
715c31a0 |
411 | |
730f5dda |
412 | If the system asks you whether it should automatically configure as much |
413 | as possible, you would typically answer yes. |
414 | |
04f8efde |
415 | In order to install local::lib into a directory other than the default, you need |
416 | to specify the name of the directory when you call bootstrap, as follows: |
898f36cf |
417 | |
418 | perl Makefile.PL --bootstrap=~/foo |
419 | |
420 | 3. Run this: (local::lib assumes you have make installed on your system) |
730f5dda |
421 | |
422 | make test && make install |
423 | |
898f36cf |
424 | 4. Now we need to setup the appropriate environment variables, so that Perl |
425 | starts using our newly generated lib/ directory. If you are using bash or |
426 | any other Bourne shells, you can add this to your shell startup script this |
427 | way: |
730f5dda |
428 | |
429 | echo 'eval $(perl -I$HOME/perl5/lib/perl5 -Mlocal::lib)' >>~/.bashrc |
430 | |
431 | If you are using C shell, you can do this as follows: |
432 | |
433 | /bin/csh |
434 | echo $SHELL |
618272fe |
435 | /bin/csh |
730f5dda |
436 | perl -I$HOME/perl5/lib/perl5 -Mlocal::lib >> ~/.cshrc |
dc8ddd06 |
437 | |
898f36cf |
438 | If you passed to bootstrap a directory other than default, you also need to give that as |
439 | import parameter to the call of the local::lib module like this way: |
8b1e8e69 |
440 | |
730f5dda |
441 | echo 'eval $(perl -I$HOME/foo/lib/perl5 -Mlocal::lib=$HOME/foo)' >>~/.bashrc |
618272fe |
442 | |
aab64481 |
443 | After writing your shell configuration file, be sure to re-read it to get the |
898f36cf |
444 | changed settings into your current shell's environment. Bourne shells use |
445 | C<. ~/.bashrc> for this, whereas C shells use C<source ~/.cshrc>. |
aab64481 |
446 | |
b9c94c15 |
447 | If you're on a slower machine, or are operating under draconian disk space |
448 | limitations, you can disable the automatic generation of manpages from POD when |
449 | installing modules by using the C<--no-manpages> argument when bootstrapping: |
450 | |
730f5dda |
451 | perl Makefile.PL --bootstrap --no-manpages |
b9c94c15 |
452 | |
898f36cf |
453 | To avoid doing several bootstrap for several Perl module environments on the |
454 | same account, for example if you use it for several different deployed |
455 | applications independently, you can use one bootstrapped local::lib |
456 | installation to install modules in different directories directly this way: |
977a9ca3 |
457 | |
730f5dda |
458 | cd ~/mydir1 |
459 | perl -Mlocal::lib=./ |
460 | eval $(perl -Mlocal::lib=./) ### To set the environment for this shell alone |
898f36cf |
461 | printenv ### You will see that ~/mydir1 is in the PERL5LIB |
730f5dda |
462 | perl -MCPAN -e install ... ### whatever modules you want |
463 | cd ../mydir2 |
464 | ... REPEAT ... |
465 | |
466 | For multiple environments for multiple apps you may need to include a modified |
467 | version of the C<< use FindBin >> instructions in the "In code" sample above. |
468 | If you did something like the above, you have a set of Perl modules at C<< |
469 | ~/mydir1/lib >>. If you have a script at C<< ~/mydir1/scripts/myscript.pl >>, |
470 | you need to tell it where to find the modules you installed for it at C<< |
471 | ~/mydir1/lib >>. |
977a9ca3 |
472 | |
473 | In C<< ~/mydir1/scripts/myscript.pl >>: |
474 | |
730f5dda |
475 | use strict; |
476 | use warnings; |
477 | use local::lib "$FindBin::Bin/.."; ### points to ~/mydir1 and local::lib finds lib |
478 | use lib "$FindBin::Bin/../lib"; ### points to ~/mydir1/lib |
977a9ca3 |
479 | |
480 | Put this before any BEGIN { ... } blocks that require the modules you installed. |
481 | |
53699c99 |
482 | =head2 Differences when using this module under Win32 |
483 | |
76f30678 |
484 | To set up the proper environment variables for your current session of |
485 | C<CMD.exe>, you can use this: |
486 | |
730f5dda |
487 | C:\>perl -Mlocal::lib |
e322149f |
488 | set PERL_MB_OPT=--install_base C:\DOCUME~1\ADMINI~1\perl5 |
730f5dda |
489 | set PERL_MM_OPT=INSTALL_BASE=C:\DOCUME~1\ADMINI~1\perl5 |
490 | set PERL5LIB=C:\DOCUME~1\ADMINI~1\perl5\lib\perl5;C:\DOCUME~1\ADMINI~1\perl5\lib\perl5\MSWin32-x86-multi-thread |
491 | set PATH=C:\DOCUME~1\ADMINI~1\perl5\bin;%PATH% |
492 | |
898f36cf |
493 | ### To set the environment for this shell alone |
730f5dda |
494 | C:\>perl -Mlocal::lib > %TEMP%\tmp.bat && %TEMP%\tmp.bat && del %TEMP%\temp.bat |
495 | ### instead of $(perl -Mlocal::lib=./) |
53699c99 |
496 | |
497 | If you want the environment entries to persist, you'll need to add then to the |
76f30678 |
498 | Control Panel's System applet yourself or use L<App::local::lib::Win32Helper>. |
53699c99 |
499 | |
500 | The "~" is translated to the user's profile directory (the directory named for |
501 | the user under "Documents and Settings" (Windows XP or earlier) or "Users" |
9bc0788f |
502 | (Windows Vista or later)) unless $ENV{HOME} exists. After that, the home |
53699c99 |
503 | directory is translated to a short name (which means the directory must exist) |
504 | and the subdirectories are created. |
505 | |
730f5dda |
506 | =head1 RATIONALE |
507 | |
508 | The version of a Perl package on your machine is not always the version you |
509 | need. Obviously, the best thing to do would be to update to the version you |
510 | need. However, you might be in a situation where you're prevented from doing |
511 | this. Perhaps you don't have system administrator privileges; or perhaps you |
512 | are using a package management system such as Debian, and nobody has yet gotten |
513 | around to packaging up the version you need. |
514 | |
515 | local::lib solves this problem by allowing you to create your own directory of |
516 | Perl packages downloaded from CPAN (in a multi-user system, this would typically |
517 | be within your own home directory). The existing system Perl installation is |
518 | not affected; you simply invoke Perl with special options so that Perl uses the |
519 | packages in your own local package directory rather than the system packages. |
520 | local::lib arranges things so that your locally installed version of the Perl |
521 | packages takes precedence over the system installation. |
522 | |
523 | If you are using a package management system (such as Debian), you don't need to |
524 | worry about Debian and CPAN stepping on each other's toes. Your local version |
525 | of the packages will be written to an entirely separate directory from those |
526 | installed by Debian. |
527 | |
618272fe |
528 | =head1 DESCRIPTION |
529 | |
530 | This module provides a quick, convenient way of bootstrapping a user-local Perl |
531 | module library located within the user's home directory. It also constructs and |
532 | prints out for the user the list of environment variables using the syntax |
533 | appropriate for the user's current shell (as specified by the C<SHELL> |
730f5dda |
534 | environment variable), suitable for directly adding to one's shell |
535 | configuration file. |
536 | |
537 | More generally, local::lib allows for the bootstrapping and usage of a |
538 | directory containing Perl modules outside of Perl's C<@INC>. This makes it |
539 | easier to ship an application with an app-specific copy of a Perl module, or |
540 | collection of modules. Useful in cases like when an upstream maintainer hasn't |
541 | applied a patch to a module of theirs that you need for your application. |
1bc71e56 |
542 | |
543 | On import, local::lib sets the following environment variables to appropriate |
544 | values: |
545 | |
546 | =over 4 |
547 | |
e322149f |
548 | =item PERL_MB_OPT |
1bc71e56 |
549 | |
550 | =item PERL_MM_OPT |
551 | |
552 | =item PERL5LIB |
553 | |
554 | =item PATH |
555 | |
556 | PATH is appended to, rather than clobbered. |
557 | |
558 | =back |
559 | |
560 | These values are then available for reference by any code after import. |
561 | |
b0c48f8e |
562 | =head1 CREATING A SELF-CONTAINED SET OF MODULES |
563 | |
a949ebcd |
564 | See L<lib::core::only> for one way to do this - but note that |
d8b1a404 |
565 | there are a number of caveats, and the best approach is always to perform a |
566 | build against a clean perl (i.e. site and vendor as close to empty as possible). |
b0c48f8e |
567 | |
480e6e85 |
568 | =head1 METHODS |
569 | |
a949ebcd |
570 | =head2 ensure_dir_structure_for |
480e6e85 |
571 | |
572 | =over 4 |
573 | |
a949ebcd |
574 | =item Arguments: $path |
575 | |
576 | =item Return value: None |
480e6e85 |
577 | |
578 | =back |
579 | |
580 | Attempts to create the given path, and all required parent directories. Throws |
581 | an exception on failure. |
582 | |
583 | =head2 print_environment_vars_for |
584 | |
585 | =over 4 |
586 | |
a949ebcd |
587 | =item Arguments: $path |
588 | |
589 | =item Return value: None |
480e6e85 |
590 | |
591 | =back |
592 | |
593 | Prints to standard output the variables listed above, properly set to use the |
594 | given path as the base directory. |
595 | |
a949ebcd |
596 | =head2 build_environment_vars_for |
597 | |
598 | =over 4 |
599 | |
600 | =item Arguments: $path, $interpolate |
601 | |
602 | =item Return value: \%environment_vars |
603 | |
604 | =back |
605 | |
291b5a3a |
606 | Returns a hash with the variables listed above, properly set to use the |
607 | given path as the base directory. |
608 | |
480e6e85 |
609 | =head2 setup_env_hash_for |
610 | |
611 | =over 4 |
612 | |
a949ebcd |
613 | =item Arguments: $path |
614 | |
615 | =item Return value: None |
480e6e85 |
616 | |
617 | =back |
618 | |
619 | Constructs the C<%ENV> keys for the given path, by calling |
a949ebcd |
620 | L</build_environment_vars_for>. |
480e6e85 |
621 | |
622 | =head2 install_base_perl_path |
623 | |
624 | =over 4 |
625 | |
a949ebcd |
626 | =item Arguments: $path |
627 | |
628 | =item Return value: $install_base_perl_path |
480e6e85 |
629 | |
630 | =back |
631 | |
632 | Returns a path describing where to install the Perl modules for this local |
633 | library installation. Appends the directories C<lib> and C<perl5> to the given |
634 | path. |
635 | |
636 | =head2 install_base_arch_path |
637 | |
638 | =over 4 |
639 | |
a949ebcd |
640 | =item Arguments: $path |
641 | |
642 | =item Return value: $install_base_arch_path |
480e6e85 |
643 | |
644 | =back |
645 | |
646 | Returns a path describing where to install the architecture-specific Perl |
647 | modules for this local library installation. Based on the |
648 | L</install_base_perl_path> method's return value, and appends the value of |
649 | C<$Config{archname}>. |
650 | |
651 | =head2 install_base_bin_path |
652 | |
653 | =over 4 |
654 | |
a949ebcd |
655 | =item Arguments: $path |
656 | |
657 | =item Return value: $install_base_bin_path |
480e6e85 |
658 | |
659 | =back |
660 | |
661 | Returns a path describing where to install the executable programs for this |
662 | local library installation. Based on the L</install_base_perl_path> method's |
663 | return value, and appends the directory C<bin>. |
664 | |
480e6e85 |
665 | =head2 resolve_empty_path |
666 | |
667 | =over 4 |
668 | |
a949ebcd |
669 | =item Arguments: $path |
670 | |
671 | =item Return value: $base_path |
480e6e85 |
672 | |
673 | =back |
674 | |
675 | Builds and returns the base path into which to set up the local module |
676 | installation. Defaults to C<~/perl5>. |
677 | |
678 | =head2 resolve_home_path |
679 | |
680 | =over 4 |
681 | |
a949ebcd |
682 | =item Arguments: $path |
683 | |
684 | =item Return value: $home_path |
480e6e85 |
685 | |
686 | =back |
687 | |
688 | Attempts to find the user's home directory. If installed, uses C<File::HomeDir> |
689 | for this purpose. If no definite answer is available, throws an exception. |
690 | |
691 | =head2 resolve_relative_path |
692 | |
693 | =over 4 |
694 | |
a949ebcd |
695 | =item Arguments: $path |
696 | |
697 | =item Return value: $absolute_path |
480e6e85 |
698 | |
699 | =back |
700 | |
701 | Translates the given path into an absolute path. |
702 | |
703 | =head2 resolve_path |
704 | |
705 | =over 4 |
706 | |
a949ebcd |
707 | =item Arguments: $path |
708 | |
709 | =item Return value: $absolute_path |
480e6e85 |
710 | |
711 | =back |
712 | |
713 | Calls the following in a pipeline, passing the result from the previous to the |
714 | next, in an attempt to find where to configure the environment for a local |
715 | library installation: L</resolve_empty_path>, L</resolve_home_path>, |
716 | L</resolve_relative_path>. Passes the given path argument to |
717 | L</resolve_empty_path> which then returns a result that is passed to |
718 | L</resolve_home_path>, which then has its result passed to |
719 | L</resolve_relative_path>. The result of this final call is returned from |
720 | L</resolve_path>. |
721 | |
0fb70b9a |
722 | =head1 A WARNING ABOUT UNINST=1 |
723 | |
724 | Be careful about using local::lib in combination with "make install UNINST=1". |
725 | The idea of this feature is that will uninstall an old version of a module |
726 | before installing a new one. However it lacks a safety check that the old |
727 | version and the new version will go in the same directory. Used in combination |
728 | with local::lib, you can potentially delete a globally accessible version of a |
381738d7 |
729 | module while installing the new version in a local place. Only combine "make |
0fb70b9a |
730 | install UNINST=1" and local::lib if you understand these possible consequences. |
731 | |
dc8ddd06 |
732 | =head1 LIMITATIONS |
733 | |
47e70ca1 |
734 | The perl toolchain is unable to handle directory names with spaces in it, |
a8e981cf |
735 | so you cant put your local::lib bootstrap into a directory with spaces. What |
736 | you can do is moving your local::lib to a directory with spaces B<after> you |
737 | installed all modules inside your local::lib bootstrap. But be aware that you |
738 | cant update or install CPAN modules after the move. |
47e70ca1 |
739 | |
618272fe |
740 | Rather basic shell detection. Right now anything with csh in its name is |
741 | assumed to be a C shell or something compatible, and everything else is assumed |
53699c99 |
742 | to be Bourne, except on Win32 systems. If the C<SHELL> environment variable is |
743 | not set, a Bourne-compatible shell is assumed. |
dc8ddd06 |
744 | |
745 | Bootstrap is a hack and will use CPAN.pm for ExtUtils::MakeMaker even if you |
746 | have CPANPLUS installed. |
747 | |
e322149f |
748 | Kills any existing PERL5LIB, PERL_MM_OPT or PERL_MB_OPT. |
dc8ddd06 |
749 | |
e423efce |
750 | Should probably auto-fixup CPAN config if not already done. |
751 | |
dc8ddd06 |
752 | Patches very much welcome for any of the above. |
bc30e1d5 |
753 | |
53699c99 |
754 | On Win32 systems, does not have a way to write the created environment variables |
755 | to the registry, so that they can persist through a reboot. |
756 | |
9a021b2b |
757 | =head1 TROUBLESHOOTING |
758 | |
759 | If you've configured local::lib to install CPAN modules somewhere in to your |
760 | home directory, and at some point later you try to install a module with C<cpan |
761 | -i Foo::Bar>, but it fails with an error like: C<Warning: You do not have |
762 | permissions to install into /usr/lib64/perl5/site_perl/5.8.8/x86_64-linux at |
763 | /usr/lib64/perl5/5.8.8/Foo/Bar.pm> and buried within the install log is an |
764 | error saying C<'INSTALL_BASE' is not a known MakeMaker parameter name>, then |
765 | you've somehow lost your updated ExtUtils::MakeMaker module. |
766 | |
767 | To remedy this situation, rerun the bootstrapping procedure documented above. |
768 | |
769 | Then, run C<rm -r ~/.cpan/build/Foo-Bar*> |
770 | |
771 | Finally, re-run C<cpan -i Foo::Bar> and it should install without problems. |
772 | |
618272fe |
773 | =head1 ENVIRONMENT |
774 | |
775 | =over 4 |
776 | |
777 | =item SHELL |
778 | |
53699c99 |
779 | =item COMSPEC |
780 | |
618272fe |
781 | local::lib looks at the user's C<SHELL> environment variable when printing out |
782 | commands to add to the shell configuration file. |
783 | |
53699c99 |
784 | On Win32 systems, C<COMSPEC> is also examined. |
785 | |
618272fe |
786 | =back |
787 | |
cc19e8d4 |
788 | =head1 SUPPORT |
789 | |
790 | IRC: |
791 | |
792 | Join #local-lib on irc.perl.org. |
793 | |
b5cc15f7 |
794 | =head1 AUTHOR |
795 | |
796 | Matt S Trout <mst@shadowcat.co.uk> http://www.shadowcat.co.uk/ |
797 | |
d6b71a2d |
798 | auto_install fixes kindly sponsored by http://www.takkle.com/ |
799 | |
b5c1154d |
800 | =head1 CONTRIBUTORS |
801 | |
802 | Patches to correctly output commands for csh style shells, as well as some |
803 | documentation additions, contributed by Christopher Nehren <apeiron@cpan.org>. |
804 | |
cc19e8d4 |
805 | Doc patches for a custom local::lib directory, more cleanups in the english |
a949ebcd |
806 | documentation and a L<german documentation|POD2::DE::local::lib> contributed by Torsten Raudssus |
8b1e8e69 |
807 | <torsten@raudssus.de>. |
808 | |
be160790 |
809 | Hans Dieter Pearcey <hdp@cpan.org> sent in some additional tests for ensuring |
9a021b2b |
810 | things will install properly, submitted a fix for the bug causing problems with |
811 | writing Makefiles during bootstrapping, contributed an example program, and |
812 | submitted yet another fix to ensure that local::lib can install and bootstrap |
813 | properly. Many, many thanks! |
814 | |
815 | pattern of Freenode IRC contributed the beginnings of the Troubleshooting |
816 | section. Many thanks! |
be160790 |
817 | |
53699c99 |
818 | Patch to add Win32 support contributed by Curtis Jewell <csjewell@cpan.org>. |
819 | |
03b91976 |
820 | Warnings for missing PATH/PERL5LIB (as when not running interactively) silenced |
821 | by a patch from Marco Emilio Poleggi. |
822 | |
1f8043c8 |
823 | Mark Stosberg <mark@summersault.com> provided the code for the now deleted |
824 | '--self-contained' option. |
825 | |
76f30678 |
826 | Documentation patches to make win32 usage clearer by |
827 | David Mertens <dcmertens.perl@gmail.com> (run4flat). |
828 | |
a949ebcd |
829 | Brazilian L<portuguese translation|POD2::PT_BR::local::lib> and minor doc patches contributed by Breno |
ccf362c0 |
830 | G. de Oliveira <garu@cpan.org>. |
831 | |
7c0db165 |
832 | =head1 COPYRIGHT |
833 | |
cc19e8d4 |
834 | Copyright (c) 2007 - 2010 the local::lib L</AUTHOR> and L</CONTRIBUTORS> as |
7c0db165 |
835 | listed above. |
836 | |
b5cc15f7 |
837 | =head1 LICENSE |
838 | |
7c0db165 |
839 | This library is free software and may be distributed under the same terms |
840 | as perl itself. |
b5cc15f7 |
841 | |
842 | =cut |
843 | |
844 | 1; |