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 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
|
#!/usr/bin/perl
use strict;
use Dpkg::IPC;
use Debian::PkgJs::Banned;
use Debian::PkgJs::Cache;
use Debian::PkgJs::Dependencies;
use Debian::PkgJs::Semver;
use Debian::PkgJs::Utils;
use Debian::PkgJs::Version;
use Getopt::Long;
use IO::Pipe;
use JSON;
use List::Util qw(any);
use Progress::Any '$progress';
use Progress::Any::Output;
use constant OFFSET => ' ';
use constant DEFAULTRECURSIONLIMIT => 100;
Progress::Any::Output->set( 'TermProgressBarColor',
template =>
'<color ffff00>%p%</color> <color 808000>[</color>%B<color 808000>]</color>'
);
my %opt;
my @CMP;
# I - Initialization: get options/args
GetOptions(
\%opt, qw(
h|help
v|version
dev|development
debug
c|checkversions
a|all-components
clearcache
nocache|no-cache
l|limit=s
graph|g
mg|missing-graph
np|no-progress
npd|no-peer-dependencies
)
);
my $currentPackage = '';
$opt{cachedelay} //= CACHEDELAY;
my $cache = Debian::PkgJs::Cache->new(%opt);
# Find name
if ( !@ARGV and -e 'package.json' ) {
local $/ = undef;
open my $f, 'package.json';
eval {
my $res = JSON::from_json(<$f>);
if ( $res->{name} ) {
push @ARGV,
$res->{name} . ( $res->{version} ? "\@$res->{version}" : '' );
$opt{local} = $res;
}
else {
print STDERR "Unable to find name from ./package.json\n";
}
};
}
# Usage and version
if ( $opt{v} ) {
print "$VERSION\n";
exit;
}
if ( $opt{h} or !@ARGV ) {
print <<EOF;
Usage: pkgjs-depends
Search recursively dependencies of the given module name (else use
`package.json#name`) and displays:
* related Debian packages (using apt-file)
* missing modules
Options:
-h, --help: print this
--dev, --development: includes dev dependencies
(for main package only, not dependencies)
--no-peer-dependencies, --npd: don't include peer dependencies
--debug
-c, --checkversions: verify that version matches
--nocache: don't use local cache
--clearcache: clear local cache
--limit: recursion limit (default: 100)
--graph, -g: display modules using a digraph of relations
--missing-graph, --mg: display only missing modules using a digraph of relations
--no-progress, --np: don't print progress bar
EOF
exit;
}
$opt{np} //= 1 if not( -t STDOUT ) or $opt{graph} or $opt{mg};
my $recursionLimit = $opt{l} || DEFAULTRECURSIONLIMIT;
# nodejs paths
my @npaths =
( '/usr/share/nodejs', '/usr/lib/nodejs', glob("/usr/lib/*/nodejs") );
# II - Main
sub debug {
print STDERR '# ' . ( OFFSET x ( $_[1] // 0 ) ) . $_[0] . "\n"
if $opt{debug};
}
# Global graph entries
my @graphEntries;
# hashref getDeps( string: $mod, int: $recursionCount )
# Get dependencies of $mod module using the result of `npm view` and
# launches checkMods() with it
#
# $mod: module name
# $recursionCount: recursion count
# result: dependencies tree
sub getDeps {
my ( $mod, $recursionCount ) = @_;
my $pb = !$recursionCount;
push @graphEntries,
qq'"$mod" [color=red; peripheries=3; label="' . uc($mod) . '"];'
if $pb;
$recursionCount //= 0;
debug( " checking $mod:", $recursionCount );
my $res;
# $opt{local} is set to package.json#name if no arg is given
$progress->update( message => "checking $mod " ) if $pb and !$opt{np};
unless ( $opt{local} ) {
my ( $out, $stderr );
unless ( $res = $cache->get($mod) ) {
# Launch `npm view`
spawn(
exec => [
'npm', 'view', '--json', $mod, 'version', 'name',
'dependencies', 'peerDependencies',
( ( $opt{dev} and $pb ) ? ('devDependencies') : () )
],
nocheck => 1,
wait_child => 1,
to_string => \$out,
error_to_string => \$stderr,
);
$opt{dev} = 0;
if ( $@ or !$out ) {
print STDERR "$mod not found\n" . ( $stderr ? $stderr : '' );
return {};
}
eval { $res = JSON::from_json($out); };
if ($@) {
print STDERR "`npm view` returned bad JSON for $mod\n$@";
return {};
}
$res = pop @{$res} if ref $res eq 'ARRAY';
}
if ( ref $res ) {
$cache->set( $mod, $res, CACHEDELAY );
}
else { return () }
}
else {
if ( $opt{a} ) {
my $cmp = component_list;
$cmp->{&main_package} = pjson(&main_package);
my $deps = {};
foreach ( keys %$cmp ) {
$deps->{ pjson($_)->{name} } = pjson($_)->{version} // '*';
push @CMP, pjson($_)->{name} . ' (' . pjson($_)->{version} .')';
}
$res = { dependencies => $deps };
}
else {
$res = $opt{local};
}
delete $opt{local};
delete $res->{devDependencies} unless $opt{dev};
}
delete $res->{peerDependencies} if $opt{npd};
if ($pb) {
my $count = 1;
foreach my $type (qw(dependencies peerDependencies devDependencies)) {
if ( $res->{$type} and %{ $res->{$type} } ) {
my @a = keys %{ $res->{$type} };
$count += @a;
}
}
$progress->target($count) if !$opt{np};
}
if ( $recursionCount < $recursionLimit ) {
checkMods( $res, $recursionCount );
}
else {
print STDERR "Recursion limit reached\n";
}
delete $res->{name};
return $res;
}
# Debian packages
my $global = {};
# Missing modules
my $missing = {};
# Already checked module
my $known = {};
# Workaround for circular dependencies
my $seen = {};
# Versions of Debian modules (works only for installed packages
my $debianVersions = {};
# Debian module that mismatch wanted version
my $mismatch = {};
# void checkMods( hashref: $res, int: $recursionCount )
# Parse `npm view` result and search for dependencies existing in Debian
# using local tree and apt/dpkg-query
# If dependency isn't found in Debian, checkMods() calls getDeps() for it.
#
# $res: dependencies tree
# $recursionCount: recursion count
sub checkMods {
my ( $res, $recursionCount ) = @_;
my $pb = !$recursionCount;
foreach my $f ( 'dependencies', 'peerDependencies', 'devDependencies' ) {
next unless $res->{$f};
foreach my $mod ( sort keys %{ $res->{$f} } ) {
my $want = $res->{$f}->{$mod};
$progress->update( message => "checking $mod " )
if $pb and !$opt{np};
if ( $known->{$mod} ) {
$global->{ $known->{$mod} }->{$mod}++;
$res->{$f}->{$mod} = { global => $known->{$mod} };
debug( " => package (seen): $known->{$mod}", $recursionCount );
next;
}
my $path;
my $debianVersion;
foreach (@npaths) {
if ( -d "$_/$mod" ) {
$path = "$_/$mod";
unless ( $debianVersion = $cache->get("dv-$mod") ) {
$debianVersion = `pkgjs-pjson $path version` if $opt{c};
chomp $debianVersion;
$cache->set( "dv-$mod", $debianVersion, CACHEDELAY );
}
last;
}
elsif ( -f "$_/$mod.js" ) {
$path = "$_/$mod.js";
last;
}
}
if ($path) {
if ( my $debianPackage = availableModules()->{$mod} ) {
$res->{$f}->{$mod} = { global => $debianPackage };
# Check versions if wanted
if ( $opt{c} ) {
unless ( semver( $debianVersion, $want ) ) {
$debianVersions->{$debianPackage} = $debianVersion;
push @{ $mismatch->{$mod} }, $want;
}
debug( "Semver result: "
. semver( $debianVersion, $want ) );
}
$global->{$debianPackage}->{$mod}++;
$known->{$mod} = $debianPackage;
debug( " => package: $known->{$mod}", $recursionCount );
my $color =
$debianPackage eq $currentPackage ? 'red' : 'blue';
if ( $known->{$mod} eq $currentPackage ) {
debug("$mod is member of current package, continue");
getDeps( $mod . '@' . $want, $recursionCount + 1 );
$color = 'red';
}
push @graphEntries,
qq'"$mod" [color=$color; peripheries=2; label="'
. uc($mod)
. '"];', qq'"$res->{name}" -> "$mod";';
}
else {
print STDERR "Fail to find package for $path\n";
$res->{$f}->{$mod} = { global => $path };
}
}
else {
my $out;
if ( my $package = availableModules()->{$mod} ) {
$res->{$f}->{$mod} = { global => $package };
$global->{$package}->{$mod}++;
$known->{$mod} = $package;
debug( " => package: $known->{$mod} ($currentPackage)",
$recursionCount );
if ( $known->{$mod} eq $currentPackage ) {
debug("$mod is member of current package, continue");
getDeps( $mod . '@' . $want, $recursionCount + 1 );
}
push @graphEntries,
qq'"$mod" [color=blue; peripheries=2; label='
. uc($mod)
. '];', qq'"$res->{name}" -> "$mod";';
# Check versions if wanted
if ( $opt{c} ) {
unless ( $debianVersion =
$cache->get("dv-$known->{$mod}") )
{
spawn(
exec => [ 'dpkg-query', '-p', $known->{$mod} ],
wait_child => 1,
to_string => \$out,
);
die "Unable to get $known->{$mod} version"
unless $out =~ /\nVersion: ([^\s-]+)/s;
$debianVersion = $1;
my $normalizedName =
normalize_name( $known->{$mod} );
# Check "Provides" field
if ( $out =~
/\nProvides:[^\n]*node-$normalizedName\s*\(\s*=\s*(\d[\.\da-zA-Z]*)/s
)
{
$debianVersion = $1;
}
else {
$debianVersion =~ s/\+~.*$//;
}
$cache->set( "dv-$known->{$mod}", $debianVersion,
CACHEDELAY );
}
unless ( semver( $debianVersion, $want ) ) {
$debianVersions->{ $known->{$mod} } =
$debianVersion;
push @{ $mismatch->{$mod} }, $want;
}
}
}
else {
push @graphEntries, qq'"$res->{name}" -> "$mod";';
if ( $missing->{$mod} ) {
$res->{$f}->{$mod} =
ref $missing->{$mod} ? $missing->{$mod} : {};
$missing->{$mod}->{$want}++;
}
elsif ( $mod eq $ARGV[0] ) {
$res->{$f}->{$mod} = { $want => 1 };
}
elsif ( !$seen->{$mod} ) {
$seen->{$mod}++;
debug( " => missing: $mod", $recursionCount );
$missing->{$mod} = $res->{$f}->{$mod} =
getDeps( $mod . '@' . $want, $recursionCount + 1 );
$missing->{$mod}->{$want}++;
}
}
}
}
}
}
sub displayMissing {
my ( $res, $offset, $graph ) = @_;
$offset //= '';
foreach my $f ( 'dependencies', 'peerDependencies', 'devDependencies' ) {
next unless $res->{$f};
foreach my $mod ( sort keys %{ $res->{$f} } ) {
# This is a side effect of circular dependencies,
# $res->{$f}->{$mod} might be '*'
next unless ( ref $res->{$f}->{$mod} );
next if $res->{$f}->{$mod}->{global};
my $reason = banned($mod);
my $suffix = ( $reason ? " # BANNED ($reason)" : '' );
my $val = "$mod ($res->{$f}->{$mod}->{version})$suffix";
if ( ref $missing->{$mod} ) {
$missing->{$mod} = '';
print $graph
? qq' "$offset" -> "$val";\n'
: "$offset └── $val\n";
displayMissing( $res->{$f}->{$mod},
( $graph ? $val : " $offset" ), $graph )
if $res->{$f}->{$mod}->{dependencies};
}
#elsif ( not( any { $_ eq $val } @CMP ) ) {
else {
print $graph
? qq' "$offset" -> "$val";\n'
: "$offset └── (^) $val\n";
}
}
}
}
my $reason = '';
$missing->{ $ARGV[0] } = "\@$ARGV[0]";
my $mainVersion = '';
my $moduleWithVersion = $ARGV[0];
my $moduleWithoutVersion = $moduleWithVersion;
$moduleWithoutVersion =~ s/(.)\@.*$/$1/;
$currentPackage = availableModules()->{$moduleWithoutVersion} // '';
if ( $ARGV[0] !~ /.\@.*$/ ) {
spawn(
exec => [ 'npm', 'view', '--json', $ARGV[0], 'version', ],
nocheck => 1,
wait_child => 1,
to_string => \$mainVersion,
);
chomp $mainVersion;
$mainVersion =~ s/"//g;
$moduleWithVersion = "$ARGV[0]\@$mainVersion";
}
if ( $opt{graph} ) {
getDeps( $ARGV[0] );
print qq'digraph "$moduleWithVersion" {\n rankdir=LR;\n',
join( "\n", @graphEntries ), "}\n";
}
elsif ( $opt{mg} ) {
print qq'digraph "$moduleWithVersion" {\n rankdir=LR;\n';
displayMissing( getDeps( $ARGV[0] ), $moduleWithVersion, 1 );
# qq' "$name" -> "$_";\n'
print "}\n";
}
else {
print "# $moduleWithVersion";
{
my $out;
my $module = $ARGV[0];
$module =~ s/(.)\@.*$/$1/;
$reason = banned($module);
print " /!\\ BANNED: $reason" if $reason;
if ($currentPackage) {
print " ($currentPackage)\n";
}
else {
print "\n";
}
}
my $res = getDeps( $ARGV[0] );
$progress->finish() if !$opt{np};
delete $missing->{ $ARGV[0] };
if (%$missing) {
print '# ' . scalar( keys %$missing ) . " missing npm module(s)\n";
}
if (%$global) {
print "DEPENDENCIES:\n";
foreach my $mod ( sort keys %$global ) {
print " $mod ("
. join( ', ', sort keys %{ $global->{$mod} } ) . ")\n";
}
print "\n";
}
delete $missing->{ $ARGV[0] };
if (%$missing) {
print "MISSING:\n$ARGV[0]"
. ( $mainVersion ? "\@$mainVersion" : '' )
. ( $reason ? " /!\\ BANNED: $reason" : '' ) . "\n";
displayMissing($res);
}
if (%$mismatch) {
print "\nWARNING: some version mismatch\n";
foreach ( sort keys %$mismatch ) {
print " $_ "
. $debianVersions->{ $known->{$_} }
. ", wanted: "
. join( ', ', @{ $mismatch->{$_} } ) . "\n";
}
}
}
|