Commit | Line | Data |
b5cc15f7 |
1 | use strict; |
2 | use warnings; |
3 | |
4 | package local::lib; |
5 | |
387f8022 |
6 | use 5.006; |
b5cc15f7 |
7 | |
8 | use File::Spec (); |
b5cc15f7 |
9 | use Config; |
10 | |
7c0e6b54 |
11 | our $VERSION = '1.008026'; # 1.8.26 |
d04dfa50 |
12 | $VERSION = eval $VERSION; |
1f8043c8 |
13 | |
b5cc15f7 |
14 | sub import { |
0fb70b9a |
15 | my ($class, @args) = @_; |
16 | |
e4b5a839 |
17 | my @steps; |
db6f44a9 |
18 | my %opts; |
e4892f2b |
19 | |
e4b5a839 |
20 | while (@args) { |
21 | my $arg = shift @args; |
b9c94c15 |
22 | # check for lethal dash first to stop processing before causing problems |
5eff9c24 |
23 | # the fancy dash is U+2212 or \xE2\x88\x92 |
24 | if ($arg =~ /\xE2\x88\x92/ or $arg =~ /−/) { |
d4dbe584 |
25 | die <<'DEATH'; |
26 | WHOA THERE! It looks like you've got some fancy dashes in your commandline! |
27 | These are *not* the traditional -- dashes that software recognizes. You |
28 | probably got these by copy-pasting from the perldoc for this module as |
29 | rendered by a UTF8-capable formatter. This most typically happens on an OS X |
30 | terminal, but can happen elsewhere too. Please try again after replacing the |
31 | dashes with normal minus signs. |
32 | DEATH |
b9c94c15 |
33 | } |
e4b5a839 |
34 | elsif ($arg eq '--self-contained') { |
35 | 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"; |
36 | } |
939821af |
37 | elsif( $arg =~ /^--deactivate(?:=(.*))?$/ ) { |
38 | my $path = defined $1 ? $1 : shift @args; |
e4b5a839 |
39 | push @steps, ['deactivate', $path]; |
b9c94c15 |
40 | } |
e4b5a839 |
41 | elsif ( $arg eq '--deactivate-all' ) { |
42 | push @steps, ['deactivate_all']; |
43 | } |
db6f44a9 |
44 | elsif ( $arg =~ /^--shelltype(?:=(.*))?$/ ) { |
45 | my $shell = defined $1 ? $1 : shift @args; |
46 | $opts{shelltype} = $shell; |
47 | } |
80816e53 |
48 | elsif ( $arg eq '--no-create' ) { |
49 | $opts{no_create} = 1; |
50 | } |
e4b5a839 |
51 | elsif ( $arg =~ /^--/ ) { |
b9c94c15 |
52 | die "Unknown import argument: $arg"; |
53 | } |
54 | else { |
e4b5a839 |
55 | push @steps, ['activate', $arg]; |
b9c94c15 |
56 | } |
d4dbe584 |
57 | } |
e4b5a839 |
58 | if (!@steps) { |
59 | push @steps, ['activate', undef]; |
60 | } |
61 | |
db6f44a9 |
62 | my $self = $class->new(%opts); |
e4b5a839 |
63 | |
64 | for (@steps) { |
65 | my ($method, @args) = @$_; |
66 | $self = $self->$method(@args); |
67 | } |
68 | |
69 | if ($0 eq '-') { |
70 | $self->print_environment_vars_for; |
71 | exit 0; |
72 | } |
73 | else { |
74 | $self->setup_local_lib_for; |
75 | } |
76 | } |
77 | |
78 | sub new { |
79 | my $class = shift; |
80 | bless {@_}, $class; |
81 | } |
82 | |
83 | sub clone { |
84 | my $self = shift; |
85 | bless {%$self, @_}, ref $self; |
86 | } |
87 | |
88 | sub inc { $_[0]->{inc} ||= \@INC } |
89 | sub libs { $_[0]->{libs} ||= [ \'PERL5LIB' ] } |
90 | sub bins { $_[0]->{bins} ||= [ \'PATH' ] } |
91 | sub roots { $_[0]->{roots} ||= [ \'PERL_LOCAL_LIB_ROOT' ] } |
92 | sub extra { $_[0]->{extra} ||= {} } |
93 | sub shelltype { $_[0]->{shelltype} ||= $_[0]->guess_shelltype } |
80816e53 |
94 | sub no_create { $_[0]->{no_create} } |
e4b5a839 |
95 | |
96 | my $_archname = $Config{archname}; |
97 | my $_version = $Config{version}; |
98 | my @_inc_version_list = reverse split / /, $Config{inc_version_list}; |
99 | my $_path_sep = $Config{path_sep}; |
100 | |
101 | sub _as_list { |
102 | my $list = shift; |
103 | grep length, map { |
104 | !(ref $_ && ref $_ eq 'SCALAR') ? $_ : ( |
105 | defined $ENV{$$_} ? split(/\Q$_path_sep/, $ENV{$$_}) |
106 | : () |
107 | ) |
108 | } ref $list ? @$list : $list; |
109 | } |
110 | sub _remove_from { |
111 | my ($list, @remove) = @_; |
112 | my %remove = map { $_ => 1 } @remove; |
113 | grep !$remove{$_}, _as_list($list); |
114 | } |
115 | |
116 | my @_lib_subdirs = ( |
117 | [$_version, $_archname], |
118 | [$_version], |
119 | [$_archname], |
120 | (@_inc_version_list ? \@_inc_version_list : ()), |
121 | [], |
122 | ); |
123 | |
124 | sub install_base_bin_path { |
125 | my ($class, $path) = @_; |
126 | return File::Spec->catdir($path, 'bin'); |
127 | } |
128 | sub install_base_perl_path { |
129 | my ($class, $path) = @_; |
130 | return File::Spec->catdir($path, 'lib', 'perl5'); |
131 | } |
132 | sub install_base_arch_path { |
133 | my ($class, $path) = @_; |
134 | File::Spec->catdir($class->install_base_perl_path($path), $_archname); |
135 | } |
136 | |
137 | sub lib_paths_for { |
138 | my ($class, $path) = @_; |
139 | my $base = $class->install_base_perl_path($path); |
140 | return map { File::Spec->catdir($base, @$_) } @_lib_subdirs; |
141 | } |
142 | |
143 | sub _mm_escape_path { |
144 | my $path = shift; |
145 | $path =~ s/\\/\\\\\\\\/g; |
146 | if ($path =~ s/ /\\ /g) { |
147 | $path = qq{"\\"$path\\""}; |
148 | } |
149 | return $path; |
150 | } |
151 | |
152 | sub _mb_escape_path { |
153 | my $path = shift; |
154 | $path =~ s/\\/\\\\/g; |
155 | return qq{"$path"}; |
156 | } |
157 | |
158 | sub installer_options_for { |
159 | my ($class, $path) = @_; |
160 | return { |
161 | PERL_MM_OPT => defined $path ? "INSTALL_BASE="._mm_escape_path($path) : undef, |
162 | PERL_MB_OPT => defined $path ? "--install_base "._mb_escape_path($path) : undef, |
163 | }; |
164 | } |
b9c94c15 |
165 | |
e4b5a839 |
166 | sub active_paths { |
167 | my ($self) = @_; |
168 | $self = ref $self ? $self : $self->new; |
169 | |
170 | return grep { |
171 | # screen out entries that aren't actually reflected in @INC |
172 | my $active_ll = $self->install_base_perl_path($_); |
173 | grep { $_ eq $active_ll } @{$self->inc}; |
174 | } _as_list($self->roots); |
175 | } |
176 | |
177 | |
178 | sub deactivate { |
179 | my ($self, $path) = @_; |
180 | $self = $self->new unless ref $self; |
181 | $path = $self->resolve_path($path); |
182 | |
183 | my @active_lls = $self->active_paths; |
184 | |
185 | if (!grep { $_ eq $path } @active_lls) { |
186 | warn "Tried to deactivate inactive local::lib '$path'\n"; |
fe125a69 |
187 | return $self; |
0fb70b9a |
188 | } |
b9c94c15 |
189 | |
e4b5a839 |
190 | my %args = ( |
191 | bins => [ _remove_from($self->bins, $self->install_base_bin_path($path)) ], |
192 | libs => [ _remove_from($self->libs, $self->install_base_perl_path($path)) ], |
193 | inc => [ _remove_from($self->inc, $self->lib_paths_for($path)) ], |
194 | roots => [ _remove_from($self->roots, $path) ], |
195 | ); |
196 | |
197 | $args{extra} = $self->installer_options_for($args{roots}[0]); |
198 | |
199 | $self->clone(%args); |
200 | } |
201 | |
202 | sub deactivate_all { |
203 | my ($self) = @_; |
204 | $self = $self->new unless ref $self; |
205 | |
206 | my @active_lls = $self->active_paths; |
207 | |
208 | my %args = ( |
209 | bins => [ _remove_from($self->bins, |
210 | map $self->install_base_bin_path($_), @active_lls) ], |
211 | libs => [ _remove_from($self->libs, |
212 | map $self->install_base_perl_path($_), @active_lls) ], |
213 | inc => [ _remove_from($self->inc, |
214 | map $self->lib_paths_for($_), @active_lls) ], |
215 | roots => [ _remove_from($self->roots, @active_lls) ], |
216 | ); |
217 | |
218 | $args{extra} = $self->installer_options_for(undef); |
219 | |
220 | $self->clone(%args); |
221 | } |
222 | |
223 | sub activate { |
224 | my ($self, $path) = @_; |
225 | $self = $self->new unless ref $self; |
226 | $path = $self->resolve_path($path); |
80816e53 |
227 | $self->ensure_dir_structure_for($path) |
228 | unless $self->no_create; |
e4b5a839 |
229 | |
b209481c |
230 | $path = ( Win32::GetShortPathName($path) || $path ) |
231 | if $^O eq 'MSWin32'; |
232 | |
e4b5a839 |
233 | my @active_lls = $self->active_paths; |
234 | |
235 | if (grep { $_ eq $path } @active_lls) { |
236 | $self = $self->deactivate($path); |
15f79556 |
237 | } |
e4b5a839 |
238 | |
239 | my %args = ( |
240 | bins => [ $self->install_base_bin_path($path), @{$self->bins} ], |
241 | libs => [ $self->install_base_perl_path($path), @{$self->libs} ], |
242 | inc => [ $self->lib_paths_for($path), @{$self->inc} ], |
243 | roots => [ $path, @{$self->roots} ], |
244 | ); |
245 | |
246 | $args{extra} = $self->installer_options_for($path); |
247 | |
248 | $self->clone(%args); |
249 | } |
250 | |
251 | sub _legacy { |
42c70458 |
252 | my ($self, $path) = @_; |
e4b5a839 |
253 | $self = $self->new unless ref $self; |
42c70458 |
254 | if (defined $path) { |
255 | $self = $self->activate($path); |
256 | } |
e4b5a839 |
257 | $self; |
258 | } |
259 | |
260 | sub build_environment_vars_for { |
261 | my ($self) = _legacy(@_); |
262 | ( |
263 | PATH => join($_path_sep, _as_list($self->bins)), |
264 | PERL5LIB => join($_path_sep, _as_list($self->libs)), |
265 | PERL_LOCAL_LIB_ROOT => join($_path_sep, _as_list($self->roots)), |
266 | %{$self->extra}, |
267 | ); |
268 | } |
269 | |
270 | sub setup_local_lib_for { |
271 | my ($self) = _legacy(@_); |
272 | $self->setup_env_hash_for; |
273 | @INC = @{$self->inc}; |
274 | } |
275 | |
276 | sub setup_env_hash_for { |
277 | my $self = shift; |
278 | my %env = $self->build_environment_vars_for(@_); |
279 | for my $key (keys %env) { |
280 | if (defined $env{$key}) { |
281 | $ENV{$key} = $env{$key}; |
282 | } |
283 | else { |
284 | delete $ENV{$key}; |
285 | } |
15f79556 |
286 | } |
e4b5a839 |
287 | } |
15f79556 |
288 | |
e4b5a839 |
289 | sub print_environment_vars_for { |
290 | my $self = shift; |
291 | print $self->environment_vars_string_for(@_); |
292 | } |
293 | |
294 | sub environment_vars_string_for { |
295 | my $self = _legacy(@_); |
296 | |
297 | my $build_method = 'build_' . $self->shelltype . '_env_declaration'; |
298 | |
299 | my @envs = ( |
300 | PATH => $self->bins, |
301 | PERL5LIB => $self->libs, |
302 | PERL_LOCAL_LIB_ROOT => $self->roots, |
303 | %{$self->extra}, |
304 | ); |
305 | my $out = ''; |
306 | while (@envs) { |
307 | my ($name, $value) = (shift(@envs), shift(@envs)); |
308 | if ( |
309 | ref $value |
310 | && @$value == 1 |
311 | && ref $value->[0] |
312 | && ref $value->[0] eq 'SCALAR' |
313 | && ${$value->[0]} eq $name) { |
314 | next; |
315 | } |
f643299c |
316 | if (!ref $value |
b01292d6 |
317 | && defined $value ? $value eq $ENV{$name} : !defined $ENV{$name} |
318 | ) { |
f643299c |
319 | next; |
320 | } |
e4b5a839 |
321 | $out .= $self->$build_method($name, $value); |
322 | } |
323 | return $out; |
324 | } |
325 | |
326 | sub build_bourne_env_declaration { |
327 | my ($class, $name, $args) = @_; |
328 | my $value = $class->_interpolate($args); |
35f4f261 |
329 | defined $value |
330 | ? qq{export ${name}="${value}";\n} |
331 | : qq{unset ${name};\n}; |
e4b5a839 |
332 | } |
333 | sub build_csh_env_declaration { |
334 | my ($class, $name, $args) = @_; |
35f4f261 |
335 | my ($value, @vars) = $class->_interpolate($args, undef, undef, '"', qq{"\\"}); |
336 | (join '', map qq{if ! \$?$_ setenv $_ "";\n}, @vars) |
337 | . defined $value |
e4b5a839 |
338 | ? qq{setenv $name "$value";\n} |
35f4f261 |
339 | : qq{unsetenv $name;\n}; |
e4b5a839 |
340 | } |
341 | sub build_cmd_env_declaration { |
342 | my ($class, $name, $args) = @_; |
35f4f261 |
343 | my $value = $class->_interpolate($args, '%', '%', qr([()!^"<>&|]), '^'); |
344 | defined $value |
345 | ? qq{set $name=$value\n} |
346 | : qq{set $name=\n}; |
e4b5a839 |
347 | } |
fbbea0e7 |
348 | sub build_powershell_env_declaration { |
349 | my ($class, $name, $args) = @_; |
35f4f261 |
350 | my $value = $class->_interpolate($args, '$env:', '', '"', '`'); |
351 | defined $value |
352 | ? qq{\$env:$name = "$value"\n} |
353 | : "Remove-Item Env:\\$name\n"; |
fbbea0e7 |
354 | } |
355 | |
e4b5a839 |
356 | |
357 | sub _interpolate { |
35f4f261 |
358 | my ($class, $args, $start, $end, $escape, $escape_char) = @_; |
e4b5a839 |
359 | return |
360 | unless defined $args; |
361 | return $args |
362 | unless ref $args; |
363 | return |
364 | unless @$args; |
365 | $start = '$' unless defined $start; |
366 | $end = '' unless defined $end; |
35f4f261 |
367 | $escape = '"' unless defined $escape; |
368 | $escape_char = "\\" unless defined $escape_char; |
e4b5a839 |
369 | my @vars; |
370 | my $string = join($Config{path_sep}, map { |
35f4f261 |
371 | if (ref $_ && ref $_ eq 'SCALAR') { |
372 | push @vars, $$_; |
373 | $start.$$_.$end; |
374 | } |
375 | else { |
376 | my $str = $_; |
377 | $str =~ s/($escape)/$escape_char$1/g; |
378 | $str; |
379 | } |
e4b5a839 |
380 | } @$args); |
381 | return wantarray ? ($string, @vars) : $string; |
b5cc15f7 |
382 | } |
383 | |
5b94dce5 |
384 | sub pipeline; |
b5cc15f7 |
385 | |
5b94dce5 |
386 | sub pipeline { |
b5cc15f7 |
387 | my @methods = @_; |
388 | my $last = pop(@methods); |
389 | if (@methods) { |
390 | \sub { |
391 | my ($obj, @args) = @_; |
5b94dce5 |
392 | $obj->${pipeline @methods}( |
b5cc15f7 |
393 | $obj->$last(@args) |
394 | ); |
395 | }; |
396 | } else { |
397 | \sub { |
398 | shift->$last(@_); |
399 | }; |
400 | } |
401 | } |
402 | |
275c9dae |
403 | =begin testing |
404 | |
405 | #:: test pipeline |
b5cc15f7 |
406 | |
407 | package local::lib; |
408 | |
409 | { package Foo; sub foo { -$_[1] } sub bar { $_[1]+2 } sub baz { $_[1]+3 } } |
8522f4d5 |
410 | my $foo = bless({}, 'Foo'); |
4c375968 |
411 | Test::More::ok($foo->${pipeline qw(foo bar baz)}(10) == -15); |
b5cc15f7 |
412 | |
275c9dae |
413 | =end testing |
414 | |
b5cc15f7 |
415 | =cut |
416 | |
417 | sub resolve_path { |
418 | my ($class, $path) = @_; |
e4b5a839 |
419 | |
420 | $path = $class->${pipeline qw( |
b5cc15f7 |
421 | resolve_relative_path |
422 | resolve_home_path |
423 | resolve_empty_path |
424 | )}($path); |
e4b5a839 |
425 | |
e4b5a839 |
426 | $path; |
b5cc15f7 |
427 | } |
428 | |
429 | sub resolve_empty_path { |
430 | my ($class, $path) = @_; |
431 | if (defined $path) { |
432 | $path; |
433 | } else { |
434 | '~/perl5'; |
435 | } |
436 | } |
437 | |
275c9dae |
438 | =begin testing |
439 | |
440 | #:: test classmethod setup |
b5cc15f7 |
441 | |
442 | my $c = 'local::lib'; |
443 | |
275c9dae |
444 | =end testing |
445 | |
446 | =begin testing |
b5cc15f7 |
447 | |
275c9dae |
448 | #:: test classmethod |
b5cc15f7 |
449 | |
450 | is($c->resolve_empty_path, '~/perl5'); |
451 | is($c->resolve_empty_path('foo'), 'foo'); |
452 | |
275c9dae |
453 | =end testing |
454 | |
b5cc15f7 |
455 | =cut |
456 | |
457 | sub resolve_home_path { |
458 | my ($class, $path) = @_; |
459 | return $path unless ($path =~ /^~/); |
460 | my ($user) = ($path =~ /^~([^\/]+)/); # can assume ^~ so undef for 'us' |
b5cc15f7 |
461 | my $homedir = do { |
5c957a4b |
462 | if (!defined $user && defined $ENV{HOME}) { |
463 | $ENV{HOME} |
464 | } |
465 | else { |
466 | require File::Glob; |
467 | File::Glob::bsd_glob("~$user", File::Glob::GLOB_TILDE()); |
b5cc15f7 |
468 | } |
469 | }; |
470 | unless (defined $homedir) { |
cd3eb741 |
471 | require Carp; |
b5cc15f7 |
472 | Carp::croak( |
473 | "Couldn't resolve homedir for " |
474 | .(defined $user ? $user : 'current user') |
b5cc15f7 |
475 | ); |
476 | } |
477 | $path =~ s/^~[^\/]*/$homedir/; |
478 | $path; |
479 | } |
480 | |
481 | sub resolve_relative_path { |
482 | my ($class, $path) = @_; |
53699c99 |
483 | $path = File::Spec->rel2abs($path); |
b5cc15f7 |
484 | } |
485 | |
275c9dae |
486 | =begin testing |
487 | |
488 | #:: test classmethod |
b5cc15f7 |
489 | |
490 | local *File::Spec::rel2abs = sub { shift; 'FOO'.shift; }; |
491 | is($c->resolve_relative_path('bar'),'FOObar'); |
492 | |
275c9dae |
493 | =end testing |
494 | |
b5cc15f7 |
495 | =cut |
496 | |
b5cc15f7 |
497 | sub ensure_dir_structure_for { |
498 | my ($class, $path) = @_; |
499 | unless (-d $path) { |
500 | warn "Attempting to create directory ${path}\n"; |
501 | } |
5c957a4b |
502 | require File::Basename; |
503 | my @dirs; |
504 | while(!-d $path) { |
505 | push @dirs, $path; |
506 | $path = File::Basename::dirname($path); |
507 | } |
508 | mkdir $_ for reverse @dirs; |
509 | return; |
b5cc15f7 |
510 | } |
511 | |
0d6470a5 |
512 | =begin testing |
513 | |
514 | #:: test classmethod |
515 | |
516 | File::Path::rmtree('t/var/splat'); |
517 | |
518 | $c->ensure_dir_structure_for('t/var/splat'); |
519 | |
520 | ok(-d 't/var/splat'); |
521 | |
522 | =end testing |
523 | |
524 | =cut |
525 | |
c4e3c83b |
526 | sub guess_shelltype { |
fc5f07c3 |
527 | my $shellbin |
528 | = defined $ENV{SHELL} |
529 | ? (File::Spec->splitpath($ENV{SHELL}))[-1] |
530 | : ( $^O eq 'MSWin32' && exists $ENV{'!EXITCODE'} ) |
531 | ? 'bash' |
532 | : ( $^O eq 'MSWin32' && $ENV{PROMPT} && $ENV{COMSPEC} ) |
533 | ? (File::Spec->splitpath($ENV{COMSPEC}))[-1] |
534 | : ( $^O eq 'MSWin32' && !$ENV{PROMPT} ) |
535 | ? 'powershell.exe' |
536 | : 'sh'; |
537 | |
538 | for ($shellbin) { |
539 | return |
540 | /csh/ ? 'csh' |
541 | : /command\.com/ ? 'cmd' |
542 | : /cmd\.exe/ ? 'cmd' |
543 | : /4nt\.exe/ ? 'cmd' |
544 | : /powershell\.exe/ ? 'powershell' |
545 | : 'bourne'; |
0353dbc0 |
546 | } |
c4e3c83b |
547 | } |
548 | |
0d6470a5 |
549 | 1; |
550 | __END__ |
275c9dae |
551 | |
898f36cf |
552 | =encoding utf8 |
553 | |
b5cc15f7 |
554 | =head1 NAME |
555 | |
556 | local::lib - create and use a local lib/ for perl modules with PERL5LIB |
557 | |
558 | =head1 SYNOPSIS |
559 | |
560 | In code - |
561 | |
562 | use local::lib; # sets up a local lib at ~/perl5 |
563 | |
564 | use local::lib '~/foo'; # same, but ~/foo |
565 | |
1bc71e56 |
566 | # Or... |
567 | use FindBin; |
568 | use local::lib "$FindBin::Bin/../support"; # app-local support library |
569 | |
b5cc15f7 |
570 | From the shell - |
571 | |
359329d3 |
572 | # Install LWP and its missing dependencies to the '~/perl5' directory |
573 | perl -MCPAN -Mlocal::lib -e 'CPAN::install(LWP)' |
0fb70b9a |
574 | |
0fb70b9a |
575 | # Just print out useful shell commands |
b5cc15f7 |
576 | $ perl -Mlocal::lib |
e322149f |
577 | export PERL_MB_OPT='--install_base /home/username/perl5' |
c4e3c83b |
578 | export PERL_MM_OPT='INSTALL_BASE=/home/username/perl5' |
0d6470a5 |
579 | export PERL5LIB="/home/username/perl5/lib/perl5" |
c4e3c83b |
580 | export PATH="/home/username/perl5/bin:$PATH" |
b5cc15f7 |
581 | |
322b0a0d |
582 | =head2 The bootstrapping technique |
bc30e1d5 |
583 | |
730f5dda |
584 | A typical way to install local::lib is using what is known as the |
585 | "bootstrapping" technique. You would do this if your system administrator |
586 | hasn't already installed local::lib. In this case, you'll need to install |
8522f4d5 |
587 | local::lib in your home directory. |
898f36cf |
588 | |
0ad9f83d |
589 | Even if you do have administrative privileges, you will still want to set up your |
898f36cf |
590 | environment variables, as discussed in step 4. Without this, you would still |
591 | install the modules into the system CPAN installation and also your Perl scripts |
592 | will not use the lib/ path you bootstrapped with local::lib. |
593 | |
04f8efde |
594 | By default local::lib installs itself and the CPAN modules into ~/perl5. |
595 | |
898f36cf |
596 | Windows users must also see L</Differences when using this module under Win32>. |
715c31a0 |
597 | |
730f5dda |
598 | 1. Download and unpack the local::lib tarball from CPAN (search for "Download" |
599 | on the CPAN page about local::lib). Do this as an ordinary user, not as root |
600 | or administrator. Unpack the file in your home directory or in any other |
601 | convenient location. |
715c31a0 |
602 | |
730f5dda |
603 | 2. Run this: |
715c31a0 |
604 | |
730f5dda |
605 | perl Makefile.PL --bootstrap |
715c31a0 |
606 | |
730f5dda |
607 | If the system asks you whether it should automatically configure as much |
608 | as possible, you would typically answer yes. |
609 | |
04f8efde |
610 | In order to install local::lib into a directory other than the default, you need |
611 | to specify the name of the directory when you call bootstrap, as follows: |
898f36cf |
612 | |
613 | perl Makefile.PL --bootstrap=~/foo |
614 | |
615 | 3. Run this: (local::lib assumes you have make installed on your system) |
730f5dda |
616 | |
617 | make test && make install |
618 | |
8522f4d5 |
619 | 4. Now we need to setup the appropriate environment variables, so that Perl |
898f36cf |
620 | starts using our newly generated lib/ directory. If you are using bash or |
621 | any other Bourne shells, you can add this to your shell startup script this |
622 | way: |
730f5dda |
623 | |
624 | echo 'eval $(perl -I$HOME/perl5/lib/perl5 -Mlocal::lib)' >>~/.bashrc |
625 | |
626 | If you are using C shell, you can do this as follows: |
627 | |
628 | /bin/csh |
629 | echo $SHELL |
618272fe |
630 | /bin/csh |
730f5dda |
631 | perl -I$HOME/perl5/lib/perl5 -Mlocal::lib >> ~/.cshrc |
dc8ddd06 |
632 | |
0d6470a5 |
633 | If you passed to bootstrap a directory other than default, you also need to |
634 | give that as import parameter to the call of the local::lib module like this |
635 | way: |
8b1e8e69 |
636 | |
730f5dda |
637 | echo 'eval $(perl -I$HOME/foo/lib/perl5 -Mlocal::lib=$HOME/foo)' >>~/.bashrc |
618272fe |
638 | |
aab64481 |
639 | After writing your shell configuration file, be sure to re-read it to get the |
8522f4d5 |
640 | changed settings into your current shell's environment. Bourne shells use |
898f36cf |
641 | C<. ~/.bashrc> for this, whereas C shells use C<source ~/.cshrc>. |
aab64481 |
642 | |
b9c94c15 |
643 | If you're on a slower machine, or are operating under draconian disk space |
644 | limitations, you can disable the automatic generation of manpages from POD when |
645 | installing modules by using the C<--no-manpages> argument when bootstrapping: |
646 | |
730f5dda |
647 | perl Makefile.PL --bootstrap --no-manpages |
b9c94c15 |
648 | |
8522f4d5 |
649 | To avoid doing several bootstrap for several Perl module environments on the |
650 | same account, for example if you use it for several different deployed |
651 | applications independently, you can use one bootstrapped local::lib |
898f36cf |
652 | installation to install modules in different directories directly this way: |
977a9ca3 |
653 | |
730f5dda |
654 | cd ~/mydir1 |
655 | perl -Mlocal::lib=./ |
656 | eval $(perl -Mlocal::lib=./) ### To set the environment for this shell alone |
898f36cf |
657 | printenv ### You will see that ~/mydir1 is in the PERL5LIB |
730f5dda |
658 | perl -MCPAN -e install ... ### whatever modules you want |
659 | cd ../mydir2 |
660 | ... REPEAT ... |
661 | |
480534a8 |
662 | If you are working with several C<local::lib> environments, you may want to |
663 | remove some of them from the current environment without disturbing the others. |
664 | You can deactivate one environment like this (using bourne sh): |
665 | |
666 | eval $(perl -Mlocal::lib=--deactivate,~/path) |
667 | |
668 | which will generate and run the commands needed to remove C<~/path> from your |
669 | various search paths. Whichever environment was B<activated most recently> will |
670 | remain the target for module installations. That is, if you activate |
671 | C<~/path_A> and then you activate C<~/path_B>, new modules you install will go |
672 | in C<~/path_B>. If you deactivate C<~/path_B> then modules will be installed |
673 | into C<~/pathA> -- but if you deactivate C<~/path_A> then they will still be |
674 | installed in C<~/pathB> because pathB was activated later. |
675 | |
676 | You can also ask C<local::lib> to clean itself completely out of the current |
677 | shell's environment with the C<--deactivate-all> option. |
730f5dda |
678 | For multiple environments for multiple apps you may need to include a modified |
679 | version of the C<< use FindBin >> instructions in the "In code" sample above. |
680 | If you did something like the above, you have a set of Perl modules at C<< |
681 | ~/mydir1/lib >>. If you have a script at C<< ~/mydir1/scripts/myscript.pl >>, |
682 | you need to tell it where to find the modules you installed for it at C<< |
683 | ~/mydir1/lib >>. |
977a9ca3 |
684 | |
685 | In C<< ~/mydir1/scripts/myscript.pl >>: |
686 | |
730f5dda |
687 | use strict; |
688 | use warnings; |
689 | use local::lib "$FindBin::Bin/.."; ### points to ~/mydir1 and local::lib finds lib |
690 | use lib "$FindBin::Bin/../lib"; ### points to ~/mydir1/lib |
977a9ca3 |
691 | |
692 | Put this before any BEGIN { ... } blocks that require the modules you installed. |
693 | |
53699c99 |
694 | =head2 Differences when using this module under Win32 |
695 | |
76f30678 |
696 | To set up the proper environment variables for your current session of |
697 | C<CMD.exe>, you can use this: |
698 | |
730f5dda |
699 | C:\>perl -Mlocal::lib |
e322149f |
700 | set PERL_MB_OPT=--install_base C:\DOCUME~1\ADMINI~1\perl5 |
730f5dda |
701 | set PERL_MM_OPT=INSTALL_BASE=C:\DOCUME~1\ADMINI~1\perl5 |
0d6470a5 |
702 | set PERL5LIB=C:\DOCUME~1\ADMINI~1\perl5\lib\perl5 |
730f5dda |
703 | set PATH=C:\DOCUME~1\ADMINI~1\perl5\bin;%PATH% |
8522f4d5 |
704 | |
898f36cf |
705 | ### To set the environment for this shell alone |
d4ccf2ea |
706 | C:\>perl -Mlocal::lib > %TEMP%\tmp.bat && %TEMP%\tmp.bat && del %TEMP%\tmp.bat |
730f5dda |
707 | ### instead of $(perl -Mlocal::lib=./) |
53699c99 |
708 | |
709 | If you want the environment entries to persist, you'll need to add then to the |
76f30678 |
710 | Control Panel's System applet yourself or use L<App::local::lib::Win32Helper>. |
53699c99 |
711 | |
712 | The "~" is translated to the user's profile directory (the directory named for |
713 | the user under "Documents and Settings" (Windows XP or earlier) or "Users" |
9bc0788f |
714 | (Windows Vista or later)) unless $ENV{HOME} exists. After that, the home |
53699c99 |
715 | directory is translated to a short name (which means the directory must exist) |
716 | and the subdirectories are created. |
717 | |
730f5dda |
718 | =head1 RATIONALE |
719 | |
720 | The version of a Perl package on your machine is not always the version you |
721 | need. Obviously, the best thing to do would be to update to the version you |
722 | need. However, you might be in a situation where you're prevented from doing |
723 | this. Perhaps you don't have system administrator privileges; or perhaps you |
724 | are using a package management system such as Debian, and nobody has yet gotten |
725 | around to packaging up the version you need. |
726 | |
727 | local::lib solves this problem by allowing you to create your own directory of |
728 | Perl packages downloaded from CPAN (in a multi-user system, this would typically |
729 | be within your own home directory). The existing system Perl installation is |
730 | not affected; you simply invoke Perl with special options so that Perl uses the |
731 | packages in your own local package directory rather than the system packages. |
732 | local::lib arranges things so that your locally installed version of the Perl |
733 | packages takes precedence over the system installation. |
734 | |
735 | If you are using a package management system (such as Debian), you don't need to |
736 | worry about Debian and CPAN stepping on each other's toes. Your local version |
737 | of the packages will be written to an entirely separate directory from those |
8522f4d5 |
738 | installed by Debian. |
730f5dda |
739 | |
618272fe |
740 | =head1 DESCRIPTION |
741 | |
742 | This module provides a quick, convenient way of bootstrapping a user-local Perl |
743 | module library located within the user's home directory. It also constructs and |
744 | prints out for the user the list of environment variables using the syntax |
745 | appropriate for the user's current shell (as specified by the C<SHELL> |
730f5dda |
746 | environment variable), suitable for directly adding to one's shell |
747 | configuration file. |
748 | |
749 | More generally, local::lib allows for the bootstrapping and usage of a |
750 | directory containing Perl modules outside of Perl's C<@INC>. This makes it |
751 | easier to ship an application with an app-specific copy of a Perl module, or |
752 | collection of modules. Useful in cases like when an upstream maintainer hasn't |
753 | applied a patch to a module of theirs that you need for your application. |
1bc71e56 |
754 | |
755 | On import, local::lib sets the following environment variables to appropriate |
756 | values: |
757 | |
758 | =over 4 |
759 | |
e322149f |
760 | =item PERL_MB_OPT |
1bc71e56 |
761 | |
762 | =item PERL_MM_OPT |
763 | |
764 | =item PERL5LIB |
765 | |
766 | =item PATH |
767 | |
1bc71e56 |
768 | =back |
769 | |
0d6470a5 |
770 | When possible, these will be appended to instead of overwritten entirely. |
771 | |
1bc71e56 |
772 | These values are then available for reference by any code after import. |
773 | |
b0c48f8e |
774 | =head1 CREATING A SELF-CONTAINED SET OF MODULES |
775 | |
a949ebcd |
776 | See L<lib::core::only> for one way to do this - but note that |
d8b1a404 |
777 | there are a number of caveats, and the best approach is always to perform a |
778 | build against a clean perl (i.e. site and vendor as close to empty as possible). |
b0c48f8e |
779 | |
480534a8 |
780 | =head1 OPTIONS |
781 | |
782 | Options are values that can be passed to the C<local::lib> import besides the |
783 | directory to use. They are specified as C<use local::lib '--option'[, path];> |
784 | or C<perl -Mlocal::lib=--option[,path]>. |
785 | |
786 | =head2 --deactivate |
787 | |
788 | Remove the chosen path (or the default path) from the module search paths if it |
789 | was added by C<local::lib>, instead of adding it. |
790 | |
791 | =head2 --deactivate-all |
792 | |
793 | Remove all directories that were added to search paths by C<local::lib> from the |
794 | search paths. |
795 | |
daad8782 |
796 | =head2 --shelltype |
797 | |
798 | Specify the shell type to use for output. By default, the shell will be |
799 | detected based on the environment. Should be one of: C<bourne>, C<csh>, |
800 | C<cmd>, or C<powershell>. |
801 | |
80816e53 |
802 | =head2 --no-create |
803 | |
804 | Prevents C<local::lib> from creating directories when activating dirs. This is |
805 | likely to cause issues on Win32 systems. |
806 | |
480e6e85 |
807 | =head1 METHODS |
808 | |
a949ebcd |
809 | =head2 ensure_dir_structure_for |
480e6e85 |
810 | |
811 | =over 4 |
812 | |
a949ebcd |
813 | =item Arguments: $path |
814 | |
815 | =item Return value: None |
480e6e85 |
816 | |
817 | =back |
818 | |
819 | Attempts to create the given path, and all required parent directories. Throws |
820 | an exception on failure. |
821 | |
822 | =head2 print_environment_vars_for |
823 | |
824 | =over 4 |
825 | |
a949ebcd |
826 | =item Arguments: $path |
827 | |
828 | =item Return value: None |
480e6e85 |
829 | |
830 | =back |
831 | |
832 | Prints to standard output the variables listed above, properly set to use the |
833 | given path as the base directory. |
834 | |
a949ebcd |
835 | =head2 build_environment_vars_for |
836 | |
837 | =over 4 |
838 | |
c40e10d7 |
839 | =item Arguments: $path |
a949ebcd |
840 | |
9f9da00a |
841 | =item Return value: %environment_vars |
a949ebcd |
842 | |
843 | =back |
844 | |
291b5a3a |
845 | Returns a hash with the variables listed above, properly set to use the |
846 | given path as the base directory. |
847 | |
480e6e85 |
848 | =head2 setup_env_hash_for |
849 | |
850 | =over 4 |
851 | |
a949ebcd |
852 | =item Arguments: $path |
853 | |
854 | =item Return value: None |
480e6e85 |
855 | |
856 | =back |
857 | |
858 | Constructs the C<%ENV> keys for the given path, by calling |
a949ebcd |
859 | L</build_environment_vars_for>. |
480e6e85 |
860 | |
5a63c13e |
861 | =head2 active_paths |
862 | |
863 | =over 4 |
864 | |
865 | =item Arguments: None |
866 | |
867 | =item Return value: @paths |
868 | |
869 | =back |
870 | |
871 | Returns a list of active C<local::lib> paths, according to the |
24351831 |
872 | C<PERL_LOCAL_LIB_ROOT> environment variable and verified against |
873 | what is really in C<@INC>. |
5a63c13e |
874 | |
480e6e85 |
875 | =head2 install_base_perl_path |
876 | |
877 | =over 4 |
878 | |
a949ebcd |
879 | =item Arguments: $path |
880 | |
881 | =item Return value: $install_base_perl_path |
480e6e85 |
882 | |
883 | =back |
884 | |
885 | Returns a path describing where to install the Perl modules for this local |
886 | library installation. Appends the directories C<lib> and C<perl5> to the given |
887 | path. |
888 | |
480e6e85 |
889 | =head2 install_base_bin_path |
890 | |
891 | =over 4 |
892 | |
a949ebcd |
893 | =item Arguments: $path |
894 | |
895 | =item Return value: $install_base_bin_path |
480e6e85 |
896 | |
897 | =back |
898 | |
899 | Returns a path describing where to install the executable programs for this |
9f9da00a |
900 | local library installation. Appends the directory C<bin> to the given path. |
480e6e85 |
901 | |
480e6e85 |
902 | =head2 resolve_empty_path |
903 | |
904 | =over 4 |
905 | |
a949ebcd |
906 | =item Arguments: $path |
907 | |
908 | =item Return value: $base_path |
480e6e85 |
909 | |
910 | =back |
911 | |
912 | Builds and returns the base path into which to set up the local module |
913 | installation. Defaults to C<~/perl5>. |
914 | |
915 | =head2 resolve_home_path |
916 | |
917 | =over 4 |
918 | |
a949ebcd |
919 | =item Arguments: $path |
920 | |
921 | =item Return value: $home_path |
480e6e85 |
922 | |
923 | =back |
924 | |
925 | Attempts to find the user's home directory. If installed, uses C<File::HomeDir> |
926 | for this purpose. If no definite answer is available, throws an exception. |
927 | |
928 | =head2 resolve_relative_path |
929 | |
930 | =over 4 |
931 | |
a949ebcd |
932 | =item Arguments: $path |
933 | |
934 | =item Return value: $absolute_path |
480e6e85 |
935 | |
936 | =back |
937 | |
938 | Translates the given path into an absolute path. |
939 | |
940 | =head2 resolve_path |
941 | |
942 | =over 4 |
943 | |
a949ebcd |
944 | =item Arguments: $path |
945 | |
946 | =item Return value: $absolute_path |
480e6e85 |
947 | |
948 | =back |
949 | |
950 | Calls the following in a pipeline, passing the result from the previous to the |
951 | next, in an attempt to find where to configure the environment for a local |
952 | library installation: L</resolve_empty_path>, L</resolve_home_path>, |
953 | L</resolve_relative_path>. Passes the given path argument to |
954 | L</resolve_empty_path> which then returns a result that is passed to |
955 | L</resolve_home_path>, which then has its result passed to |
956 | L</resolve_relative_path>. The result of this final call is returned from |
957 | L</resolve_path>. |
958 | |
0fb70b9a |
959 | =head1 A WARNING ABOUT UNINST=1 |
960 | |
961 | Be careful about using local::lib in combination with "make install UNINST=1". |
962 | The idea of this feature is that will uninstall an old version of a module |
963 | before installing a new one. However it lacks a safety check that the old |
964 | version and the new version will go in the same directory. Used in combination |
965 | with local::lib, you can potentially delete a globally accessible version of a |
381738d7 |
966 | module while installing the new version in a local place. Only combine "make |
0fb70b9a |
967 | install UNINST=1" and local::lib if you understand these possible consequences. |
968 | |
dc8ddd06 |
969 | =head1 LIMITATIONS |
970 | |
788ea146 |
971 | =over 4 |
972 | |
0d6470a5 |
973 | =item * Directory names with spaces in them are not well supported by the perl |
974 | toolchain and the programs it uses. Pure-perl distributions should support |
975 | spaces, but problems are more likely with dists that require compilation. A |
976 | workaround you can do is moving your local::lib to a directory with spaces |
977 | B<after> you installed all modules inside your local::lib bootstrap. But be |
978 | aware that you can't update or install CPAN modules after the move. |
47e70ca1 |
979 | |
788ea146 |
980 | =item * Rather basic shell detection. Right now anything with csh in its name is |
618272fe |
981 | assumed to be a C shell or something compatible, and everything else is assumed |
53699c99 |
982 | to be Bourne, except on Win32 systems. If the C<SHELL> environment variable is |
983 | not set, a Bourne-compatible shell is assumed. |
dc8ddd06 |
984 | |
0d6470a5 |
985 | =item * Kills any existing PERL_MM_OPT or PERL_MB_OPT. |
dc8ddd06 |
986 | |
788ea146 |
987 | =item * Should probably auto-fixup CPAN config if not already done. |
988 | |
989 | =back |
e423efce |
990 | |
dc8ddd06 |
991 | Patches very much welcome for any of the above. |
bc30e1d5 |
992 | |
788ea146 |
993 | =over 4 |
994 | |
0d6470a5 |
995 | =item * On Win32 systems, does not have a way to write the created environment |
996 | variables to the registry, so that they can persist through a reboot. |
53699c99 |
997 | |
788ea146 |
998 | =back |
999 | |
9a021b2b |
1000 | =head1 TROUBLESHOOTING |
1001 | |
1002 | If you've configured local::lib to install CPAN modules somewhere in to your |
1003 | home directory, and at some point later you try to install a module with C<cpan |
1004 | -i Foo::Bar>, but it fails with an error like: C<Warning: You do not have |
1005 | permissions to install into /usr/lib64/perl5/site_perl/5.8.8/x86_64-linux at |
1006 | /usr/lib64/perl5/5.8.8/Foo/Bar.pm> and buried within the install log is an |
1007 | error saying C<'INSTALL_BASE' is not a known MakeMaker parameter name>, then |
1008 | you've somehow lost your updated ExtUtils::MakeMaker module. |
1009 | |
1010 | To remedy this situation, rerun the bootstrapping procedure documented above. |
1011 | |
1012 | Then, run C<rm -r ~/.cpan/build/Foo-Bar*> |
1013 | |
1014 | Finally, re-run C<cpan -i Foo::Bar> and it should install without problems. |
1015 | |
618272fe |
1016 | =head1 ENVIRONMENT |
1017 | |
1018 | =over 4 |
1019 | |
1020 | =item SHELL |
1021 | |
53699c99 |
1022 | =item COMSPEC |
1023 | |
618272fe |
1024 | local::lib looks at the user's C<SHELL> environment variable when printing out |
1025 | commands to add to the shell configuration file. |
1026 | |
53699c99 |
1027 | On Win32 systems, C<COMSPEC> is also examined. |
1028 | |
618272fe |
1029 | =back |
1030 | |
163f162c |
1031 | =head1 SEE ALSO |
1032 | |
1033 | =over 4 |
1034 | |
1035 | =item * L<Perl Advent article, 2011|http://perladvent.org/2011/2011-12-01.html> |
1036 | |
1037 | =back |
1038 | |
cc19e8d4 |
1039 | =head1 SUPPORT |
1040 | |
1041 | IRC: |
1042 | |
1043 | Join #local-lib on irc.perl.org. |
1044 | |
b5cc15f7 |
1045 | =head1 AUTHOR |
1046 | |
1047 | Matt S Trout <mst@shadowcat.co.uk> http://www.shadowcat.co.uk/ |
1048 | |
d6b71a2d |
1049 | auto_install fixes kindly sponsored by http://www.takkle.com/ |
1050 | |
b5c1154d |
1051 | =head1 CONTRIBUTORS |
1052 | |
1053 | Patches to correctly output commands for csh style shells, as well as some |
1054 | documentation additions, contributed by Christopher Nehren <apeiron@cpan.org>. |
1055 | |
cc19e8d4 |
1056 | Doc patches for a custom local::lib directory, more cleanups in the english |
0d6470a5 |
1057 | documentation and a L<german documentation|POD2::DE::local::lib> contributed by |
1058 | Torsten Raudssus <torsten@raudssus.de>. |
8b1e8e69 |
1059 | |
be160790 |
1060 | Hans Dieter Pearcey <hdp@cpan.org> sent in some additional tests for ensuring |
9a021b2b |
1061 | things will install properly, submitted a fix for the bug causing problems with |
1062 | writing Makefiles during bootstrapping, contributed an example program, and |
1063 | submitted yet another fix to ensure that local::lib can install and bootstrap |
1064 | properly. Many, many thanks! |
1065 | |
1066 | pattern of Freenode IRC contributed the beginnings of the Troubleshooting |
1067 | section. Many thanks! |
be160790 |
1068 | |
53699c99 |
1069 | Patch to add Win32 support contributed by Curtis Jewell <csjewell@cpan.org>. |
1070 | |
03b91976 |
1071 | Warnings for missing PATH/PERL5LIB (as when not running interactively) silenced |
1072 | by a patch from Marco Emilio Poleggi. |
1073 | |
1f8043c8 |
1074 | Mark Stosberg <mark@summersault.com> provided the code for the now deleted |
1075 | '--self-contained' option. |
1076 | |
76f30678 |
1077 | Documentation patches to make win32 usage clearer by |
1078 | David Mertens <dcmertens.perl@gmail.com> (run4flat). |
1079 | |
0d6470a5 |
1080 | Brazilian L<portuguese translation|POD2::PT_BR::local::lib> and minor doc |
1081 | patches contributed by Breno G. de Oliveira <garu@cpan.org>. |
ccf362c0 |
1082 | |
a0b3d98a |
1083 | Improvements to stacking multiple local::lib dirs and removing them from the |
1084 | environment later on contributed by Andrew Rodland <arodland@cpan.org>. |
1085 | |
0d6470a5 |
1086 | Patch for Carp version mismatch contributed by Hakim Cassimally |
1087 | <osfameron@cpan.org>. |
cd3eb741 |
1088 | |
7c0db165 |
1089 | =head1 COPYRIGHT |
1090 | |
cc19e8d4 |
1091 | Copyright (c) 2007 - 2010 the local::lib L</AUTHOR> and L</CONTRIBUTORS> as |
7c0db165 |
1092 | listed above. |
1093 | |
b5cc15f7 |
1094 | =head1 LICENSE |
1095 | |
73c9a8ad |
1096 | This is free software; you can redistribute it and/or modify it under |
1097 | the same terms as the Perl 5 programming language system itself. |
b5cc15f7 |
1098 | |
1099 | =cut |