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