forked from perl-carton/carton
/
Carton.pm
448 lines (342 loc) · 11 KB
/
Carton.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
package Carton;
use strict;
use warnings;
use 5.008_001;
use version; our $VERSION = "v0.9_7";
use Cwd;
use Config qw(%Config);
use Carton::Util;
use CPAN::Meta;
use CPAN::Meta::Requirements;
use File::Path ();
use File::Spec ();
use File::Temp ();
use Capture::Tiny 'capture';
use Module::CPANfile;
use constant CARTON_LOCK_VERSION => '0.9';
our $DefaultMirror = 'http://cpan.metacpan.org/';
sub new {
my($class, %args) = @_;
bless {
path => $ENV{PERL_CARTON_PATH} || 'local',
mirror => $ENV{PERL_CARTON_MIRROR} || $DefaultMirror,
}, $class;
}
sub configure {
my($self, %args) = @_;
%{$self} = (%$self, %args);
}
sub lock { $_[0]->{lock} }
sub local_mirror { File::Spec->rel2abs("$_[0]->{path}/cache") }
sub download_from_cpanfile {
my($self, $cpanfile, $local_mirror) = @_;
my @modules = $self->list_dependencies;
$self->download_conservative(\@modules, $local_mirror, 1)
or die "Bundling modules failed\n";
}
sub install_from_cpanfile {
my($self, $file) = @_;
my @modules;
if ($self->lock) {
my $tree = $self->build_tree($self->lock->{modules});
push @modules, map $_->spec, $tree->children;
}
push @modules, $self->list_dependencies;
$self->install_conservative(\@modules, 1)
or die "Installing modules failed\n";
}
sub list_dependencies {
my $self = shift;
my $cpanfile = Module::CPANfile->load;
my $prereq = $cpanfile->prereq;
my $reqs = CPAN::Meta::Requirements->new;
$reqs->add_requirements($prereq->requirements_for($_, 'requires'))
for qw( configure build runtime);
my $hash = $reqs->as_string_hash;
return map "$_~$hash->{$_}", keys %$hash; # TODO refactor to not rely on string representation
}
sub install_from_lock {
my($self) = @_;
my @root = ();
for my $meta ( values %{$self->lock->{modules}} ) {
my $version = $meta->{provides}{$meta->{name}}{version} || $meta->{version};
push @root, $meta->{name} . ($version ? '~' . $version : '');
}
$self->install_conservative(\@root, 0)
or die "Installing modules failed\n";
}
sub dedupe_modules {
my($self, $modules) = @_;
my %seen;
my @result;
for my $spec (reverse @$modules) {
my($mod, $ver) = split /~/, $spec;
next if $seen{$mod}++;
push @result, $spec;
}
return [ reverse @result ];
}
sub download_conservative {
my($self, $modules, $dir, $cascade) = @_;
$modules = $self->dedupe_modules($modules);
my $mirror = $self->{mirror} || $DefaultMirror;
local $self->{path} = File::Temp::tempdir(CLEANUP => 1); # ignore installed
$self->run_cpanm(
"--mirror", $mirror,
"--mirror", "http://backpan.perl.org/", # fallback
"--no-skip-satisfied",
( $mirror ne $DefaultMirror ? "--mirror-only" : () ),
( $cascade ? "--cascade-search" : () ),
"--scandeps",
"--save-dists", $dir,
@$modules,
);
# write 02packages using local installations
my %installs = $self->find_installs;
my $index = $self->build_index(\%installs);
$self->build_mirror_file($index, $self->{mirror_file});
}
sub install_conservative {
my($self, $modules, $cascade) = @_;
$modules = $self->dedupe_modules($modules);
if ($self->lock) {
my $index = $self->build_index($self->lock->{modules});
$self->build_mirror_file($index, $self->{mirror_file});
}
my $mirror = $self->{mirror} || $DefaultMirror;
my $is_default_mirror = 0;
if ( !ref $mirror ) {
$is_default_mirror = $mirror eq $DefaultMirror ? 1 : 0;
$mirror = [split /,/, $mirror];
}
$self->run_cpanm(
(map { ("--mirror", $_) } @{$mirror}),
"--mirror", "http://backpan.perl.org/", # fallback
"--skip-satisfied",
( $is_default_mirror ? () : "--mirror-only" ),
( $self->lock ? ("--mirror-index", $self->{mirror_file}) : () ),
( $cascade ? "--cascade-search" : () ),
@$modules,
);
}
sub build_mirror_file {
my($self, $index, $file) = @_;
my @packages = $self->build_packages($index);
my $fh;
if ($file =~ /\.gz$/i) {
require IO::Compress::Gzip;
$fh = IO::Compress::Gzip->new($file) or die $IO::Compress::Gzip::GzipError;
} else {
open $fh, ">", $file or die $!;
}
print $fh <<EOF;
File: 02packages.details.txt
URL: http://www.perl.com/CPAN/modules/02packages.details.txt
Description: Package names found in carton.lock
Columns: package name, version, path
Intended-For: Automated fetch routines, namespace documentation.
Written-By: Carton $Carton::VERSION
Line-Count: @{[ scalar(@packages) ]}
Last-Updated: @{[ scalar localtime ]}
EOF
for my $p (@packages) {
print $fh sprintf "%s %s %s\n", pad($p->[0], 32), pad($p->[1] || 'undef', 10, 1), $p->[2];
}
return $file;
}
sub pad {
my($str, $len, $left) = @_;
my $howmany = $len - length($str);
return $str if $howmany <= 0;
my $pad = " " x $howmany;
return $left ? "$pad$str" : "$str$pad";
}
sub build_packages {
my($self, $index) = @_;
my @packages;
for my $package (sort keys %$index) {
my $module = $index->{$package};
push @packages, [ $package, $module->{version}, $module->{meta}{pathname} ];
}
return @packages;
}
sub build_index {
my($self, $modules) = @_;
my $index;
while (my($name, $metadata) = each %$modules) {
for my $mod (keys %{$metadata->{provides}}) {
$index->{$mod} = { %{$metadata->{provides}{$mod}}, meta => $metadata };
}
}
return $index;
}
sub is_core {
my($self, $module, $want_ver, $perl_version) = @_;
$perl_version ||= $];
require Module::CoreList;
my $is_core = exists $Module::CoreList::version{$perl_version + 0}{$module}
or return;
my $core_ver = $Module::CoreList::version{$perl_version + 0}{$module};
return 1 unless $want_ver;
return version->new($core_ver) >= version->new($want_ver);
};
sub walk_down_tree {
my($self, $tree, $cb, $no_warn) = @_;
my %seen;
$tree->walk_down(sub {
my($node, $depth, $parent) = @_;
return $tree->abort if $seen{$node->key}++;
if ($node->metadata->{dist}) {
$cb->($node->metadata, $depth);
} elsif (!$self->is_core($node->key, 0) && !$no_warn) {
warn "Couldn't find ", $node->key, "\n";
}
});
}
sub build_tree {
my($self, $modules, $root) = @_;
my $idx = $self->build_index($modules);
my $pool = { %$modules }; # copy
my $tree = Carton::Tree->new;
while (my $pick = (keys %$pool)[0]) {
$self->_build_tree($pick, $tree, $tree, $pool, $idx);
}
$tree->finalize($root);
return $tree;
}
sub _build_tree {
my($self, $elem, $tree, $curr_node, $pool, $idx) = @_;
if (my $cached = Carton::TreeNode->cached($elem)) {
$curr_node->add_child($cached);
return;
}
my $node = Carton::TreeNode->new($elem, $pool);
$curr_node->add_child($node);
for my $child ( $self->build_deps($node->metadata, $idx) ) {
$self->_build_tree($child, $tree, $node, $pool, $idx);
}
}
sub merge_prereqs {
my($self, $prereqs) = @_;
my %requires;
for my $phase (qw( configure build test runtime )) {
%requires = (%requires, %{$prereqs->{$phase}{requires} || {}});
}
return \%requires;
}
sub build_deps {
my($self, $meta, $idx) = @_;
my $requires = $self->merge_prereqs($meta->{mymeta}{prereqs});
my @deps;
for my $module (keys %$requires) {
next if $module eq 'perl';
if (exists $idx->{$module}) {
push @deps, $idx->{$module}{meta}{name};
} else {
push @deps, $module;
}
}
return @deps;
}
sub run_cpanm_output {
my($self, @args) = @_;
my $deps = capture {
local $ENV{PERL_CPANM_OPT};
system "cpanm", "--quiet", "-L", $self->{path}, @args;
};
my @deps = split $/, $deps;
return @deps;
}
sub run_cpanm {
my($self, @args) = @_;
local $ENV{PERL_CPANM_OPT};
!system "cpanm", "--quiet", "-L", $self->{path}, "--notest", @args;
}
sub update_lock_file {
my($self, $file) = @_;
my $lock = $self->build_lock;
Carton::Util::dump_json($lock, $file);
return 1;
}
sub build_lock {
my $self = shift;
my %installs = $self->find_installs;
return {
modules => \%installs,
version => CARTON_LOCK_VERSION,
};
}
sub find_installs {
my $self = shift;
require File::Find;
my $libdir = "$self->{path}/lib/perl5/$Config{archname}/.meta";
return unless -e $libdir;
my @installs;
my $wanted = sub {
if ($_ eq 'install.json') {
push @installs, [ $File::Find::name, "$File::Find::dir/MYMETA.json" ];
}
};
File::Find::find($wanted, $libdir);
return map {
my $module = Carton::Util::load_json($_->[0]);
my $mymeta = -f $_->[1] ? CPAN::Meta->load_file($_->[1])->as_struct({ version => "2" }) : {};
($module->{name} => { %$module, mymeta => $mymeta }) } @installs;
}
sub check_satisfies {
my($self, $lock, $deps) = @_;
my @unsatisfied;
my $index = $self->build_index($lock->{modules});
my %pool = %{$lock->{modules}}; # copy
my @root = map { [ split /~/, $_, 2 ] } @$deps;
for my $dep (@root) {
$self->_check_satisfies($dep, \@unsatisfied, $index, \%pool);
}
my $tree = keys %pool ? $self->build_tree(\%pool) : undef;
return {
unsatisfied => \@unsatisfied,
superflous => $tree,
};
}
sub _check_satisfies {
my($self, $dep, $unsatisfied, $index, $pool) = @_;
my($mod, $ver) = @$dep;
my $found = $index->{$mod};
if ($found) {
delete $pool->{$found->{meta}{name}};
} elsif ($self->is_core($mod, $ver)) {
return;
}
unless ($found and (!$ver or version->new($found->{version}) >= version->new($ver))) {
push @$unsatisfied, {
module => $mod,
version => $ver,
found => $found ? $found->{version} : undef,
};
return;
}
my $requires = $self->merge_prereqs($found->{meta}{mymeta}{prereqs});
for my $module (keys %$requires) {
next if $module eq 'perl';
$self->_check_satisfies([ $module, $requires->{$module} ], $unsatisfied, $index, $pool);
}
}
sub uninstall {
my($self, $lock, $module) = @_;
my $meta = $lock->{modules}{$module};
(my $path_name = $meta->{name}) =~ s!::!/!g;
my $path = Cwd::realpath($self->{path});
my $packlist = "$path/lib/perl5/$Config{archname}/auto/$path_name/.packlist";
open my $fh, "<", $packlist or die "Couldn't locate .packlist for $meta->{name}";
while (<$fh>) {
# EUMM merges with site and perl library paths
chomp;
next unless /^\Q$path\E/;
unlink $_ or warn "Couldn't unlink $_: $!";
}
unlink $packlist;
if ($meta->{dist}) { # safety guard not to rm -r auto/meta
File::Path::rmtree("$self->{path}/lib/perl5/$Config{archname}/.meta/$meta->{dist}");
}
}
1;