File: Util.pm

package info (click to toggle)
liburi-packageurl-perl 2.24-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,784 kB
  • sloc: perl: 3,556; sh: 71; makefile: 2
file content (705 lines) | stat: -rw-r--r-- 16,035 bytes parent folder | download
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
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
package URI::VersionRange::Util;

use feature ':5.10';
use strict;
use utf8;
use warnings;

use Exporter qw(import);
use Carp ();

our $VERSION = '2.24';

our @EXPORT = qw(
    parse_semver normalize_semver is_semver
    native_range_to_vers
    version_compare semver_version_compare generic_version_compare
);

# https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string
my $SEMVER_REGEXP = qr{(?x)
    ^
    (?P<major>0|[1-9]\d*)
    \.
    (?P<minor>0|[1-9]\d*)
    \.
    (?P<patch>0|[1-9]\d*)
    (?:-(?P<prerelease>(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?
    (?:\+(?P<buildmetadata>[0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?
    $
};

sub native_range_to_vers {

    my ($scheme, $range) = @_;

    my %TYPES = (
        conan  => \&_conan_native_range,
        gem    => \&_gem_native_range,
        nginx  => \&_nginx_native_range,
        npm    => \&_semver_native_range,
        nuget  => \&_nuget_native_range,
        raku   => \&_raku_native_range,
        semver => \&_semver_native_range,
    );

    if (defined $TYPES{$scheme}) {
        return sprintf 'vers:%s/%s', $scheme, $TYPES{$scheme}->($range);
    }

    my @parts = split /\,/, $range;
    map {s{\s+}{}g} @parts;

    return sprintf 'vers:%s/%s', $scheme, join '|', sort @parts;

}

sub _nginx_native_range {

    my $native = shift;
    $native =~ s/\s+//g;

    my @plus   = ();
    my @others = ();

    my @p = split /,/, $native;

    foreach my $part (@p) {

        next unless length $part;

        # "1.0.0-1.0.1"
        if ($part =~ /^(.*?)-(.*)$/) {
            my $min = normalize_semver($1);
            my $max = normalize_semver($2);
            push @others, ">=$min|<=$max";
            next;
        }

        # "1.0.1+"
        if ($part =~ /^\s*(.*?)\+\s*$/) {
            my $version = normalize_semver($1);
            push @plus, $version if defined $version;
            next;
        }

        if (my $v = normalize_semver($part)) {
            push @others, $v;
            next;
        }

        push @others, $part;
    }

    if (@plus) {

        my %seen = ();

        # Remove duplicates and sort
        @plus = sort {

            my $A = parse_semver($a);
            my $B = parse_semver($b);

            $A->{major} <=> $B->{major} || $A->{minor} <=> $B->{minor} || $A->{patch} <=> $B->{patch}

        } grep { !$seen{$_}++ } @plus;

        # One "+"
        if (@plus == 1) {

            my $semver = parse_semver($plus[0]);
            my $upper  = join('.', $semver->{major}, $semver->{minor} + 1, 0);

            return join('|', (">=$plus[0]", "<$upper", @others));

        }

        my @parts = (">=$plus[0]");

        # Skip first plus
        for (my $i = 1; $i < @plus; $i++) {
            push @parts, "<$plus[$i]", ">=$plus[$i]";
        }

        return join('|', @parts, @others);

    }

    return join('|', grep {$_} @others);

}

sub _nuget_native_range {

    my $native = shift;

    # https://learn.microsoft.com/en-us/nuget/concepts/package-versioning

    # Notation      Applied rule    Description
    # 1.0           x ≥ 1.0         Minimum version, inclusive
    # [1.0,)        x ≥ 1.0         Minimum version, inclusive
    # (1.0,)        x > 1.0         Minimum version, exclusive
    # [1.0]         x == 1.0        Exact version match
    # (,1.0]        x ≤ 1.0         Maximum version, inclusive
    # (,1.0)        x < 1.0         Maximum version, exclusive
    # [1.0,2.0]     1.0 ≤ x ≤ 2.0   Exact range, inclusive
    # (1.0,2.0)     1.0 < x < 2.0   Exact range, exclusive
    # [1.0,2.0)     1.0 ≤ x < 2.0   Mixed inclusive minimum and exclusive maximum version
    # (1.0)         invalid         invalid

    my @parts = map {
        /^\((.*)\)$/
            ? Carp::croak 'Invalid nuget version range'    # (1.0)
            : /^\($/       ? '>0.0'                        # (
            : /^\)$/       ? ''                            # )
            : /^\[(.*)\]$/ ? $1                            # [1.0]
            : /^\[(.*)/    ? ">=$1"                        # [1.0
            : /(.*)\]$/    ? "<=$1"                        # 1.0]
            : /^\((.*)/    ? ">$1"                         # (1.0
            : /(.*)\)$/    ? "<$1"                         # 1.0)
            : $_                                           # 1.0
    } grep {$_} split /\,/, $native;

    return join('|', grep {$_} @parts);

}

sub _semver_native_range {

    my $native = shift;

    $native =~ s/^(.*)\s\-\s(.*)$/>= $1 <= $2/g;    # TODO
    $native =~ s/(>\=|<\=|>|<)\s+/$1/g;

    my @p = grep {$_} split /(?:\s+|\|\|)/, $native;
    my @constraints = ();

    foreach my $part (@p) {

        $part =~ s{v(\d+)}{$1};
        $part =~ s{^=}{};
        $part =~ s/^\s+|\s+$//g;

        # Wildcards (1.x or 2.0.x)
        if (my @wildcards = _semver_wildcards('>=', $part)) {
            push @constraints, @wildcards;
            next;
        }

        # Tilde operator
        if ($part =~ /^(~)(.*)/) {
            push @constraints, _tilde_operator('semver', $2);
            next;
        }

        # Caret operator
        if ($part =~ /^(\^)(.*)/) {
            push @constraints, _caret_operator('semver', $2);
            next;
        }

        # Operators
        if ($part =~ /(>\=|<\=|>|<)(.*)/) {

            my ($operator, $version) = ($1, $2);

            # Wildcards (1.x or 2.0.x)
            if (my @wildcards = _semver_wildcards($operator, $version)) {
                push @constraints, @wildcards;
                next;
            }


            $version = normalize_semver($version);

            if ($version and is_semver($version)) {
                push @constraints, join('', $operator, $version);
                next;
            }

        }

        if ($part ne '*') {

            my $version = normalize_semver($part);

            if ($version and is_semver($version)) {
                push @constraints, normalize_semver($part);
                next;
            }

        }

        push @constraints, $part;

    }

    return join '|', @constraints;
}

sub _conan_native_range {

    my $native = shift;

    my @p     = grep {$_} split /(?:\s+|\|\|)/, $native;
    my @parts = ();

    foreach my $part (@p) {

        $part =~ s{^=}{}g;
        $part =~ s{\-$}{}g;
        $part =~ s{\,}{}g;

        if ($part =~ /^(\*|\*\-)$/) {
            push @parts, '>=0.0.0';
            next;
        }

        if ($part =~ /^(~)(.*)/) {
            push @parts, _tilde_operator('conan', $2);
            next;
        }

        if ($part =~ /^(\^)(.*)/) {
            push @parts, _caret_operator('conan', $2);
            next;

        }

        push @parts, $part;

    }

    return join '|', @parts;

}

sub _raku_native_range {

    my $native = shift;

    my @parts = map {
              /(.*)\+$/
            ? ">=$1"                            # 1.0+
            : /^(\d+)\.\*/        ? ">=$1"      # 1.*
            : /^(\d+)\.(\d+)\.\*/ ? ">=$1.0"    # 1.0.*
            : $_                                # 1.0
    } grep {$_} split /\,/, $native;

    return join('|', grep {$_} @parts);

}

sub _gem_native_range {

    # Convert GEM version spec to VERS range

    my $native = shift;

    # Specification From  ... To (exclusive)
    # ">= 3.0"      3.0   ... &infin;
    # "~> 3.0"      3.0   ... 4.0
    # "~> 3.0.0"    3.0.0 ... 3.1
    # "~> 3.5"      3.5   ... 4.0
    # "~> 3.5.0"    3.5.0 ... 3.6
    # "~> 3"        3.0   ... 4.0

    if ($native =~ /^(~>)(.*)/) {
        return _tilde_operator('gem', $2);
    }

    return $native;

}

sub _semver_wildcards {

    my ($operator, $term) = @_;
    $term =~ s/\s+//g;

    # >= major.x
    if ($operator eq '>=' && $term =~ /^(\d+)\.x(?:\.x)?$/) {
        my $major = $1;
        return (">=$major.0.0", '<' . ($major + 1) . ".0.0");
    }

    # >= major.minor.x
    if ($operator eq '>=' && $term =~ /^(\d+)\.(\d+)\.x$/) {
        my ($major, $minor) = ($1, $2);
        return (">=$major.$minor.0", "<$major." . ($minor + 1) . ".0");
    }

    return ();

}

sub _tilde_operator {

    my ($scheme, $version) = @_;
    $version =~ s/\s+//;

    my $semver = parse_semver($version);

    my $has_prerelease = defined($semver->{prerelease}) && ($semver->{prerelease} ne '');
    my ($major, $minor, $patch) = @{$semver}{qw[major minor patch]};

    if ($has_prerelease && defined $patch) {

        my $lower = join('.', $major, $minor, $patch);
        my $upper = join('.', $major, $minor, $patch + 1);

        return join '|', ">=$version", "<$lower", ">=$lower", "<$upper";
    }

    my ($upper_major, $upper_minor, $upper_patch) = ($major, $minor, $patch);

    if ($patch > 0) {
        ($upper_minor, $upper_patch) = ($minor + 1, 0);
    }
    elsif ($minor > 0) {
        ($upper_minor, $upper_patch) = ($minor + 1, 0);
    }
    else {
        ($upper_major, $upper_minor, $upper_patch) = ($major + 1, 0, 0);
    }

    my @upper = ($upper_major, $upper_minor, $upper_patch);

SWITCH:
    for ($scheme) {

        if (/gem/) {
            pop @upper;
            last SWITCH;
        }

        if (/conan/) {

            # strip trailing zeros
            pop @upper while @upper && $upper[-1] == 0;
            $upper[-1] .= '-';
            last SWITCH;
        }

    }

    # >= min and < max version
    return join '|', ">=$version", sprintf('<%s', join('.', @upper));

}

sub _caret_operator {

    my ($scheme, $version) = @_;
    $version =~ s/\s+//;

    my $semver = parse_semver($version);
    my ($major, $minor, $patch) = @{$semver}{qw[major minor patch]};

    my ($upper_major, $upper_minor, $upper_patch) = ($major, $minor, $patch);

    if ($major > 0) {
        ($upper_major, $upper_minor, $upper_patch) = ($major + 1, 0, 0);
    }
    elsif ($minor > 0) {
        ($upper_minor, $upper_patch) = ($minor + 1, 0);
    }
    else {
        $upper_patch = $patch + 1;
    }

    my @upper = ($upper_major, $upper_minor, $upper_patch);

SWITCH:
    for ($scheme) {

        if (/conan/) {

            # strip trailing zeros
            pop @upper while @upper && $upper[-1] == 0;
            $upper[-1] .= '-';
            last SWITCH;
        }

    }

    # >= min and < max version
    return join '|', ">=$version", sprintf('<%s', join('.', @upper));
}

sub is_semver {
    ($_[0] =~ /$SEMVER_REGEXP/) ? 1 : 0;
}

sub parse_semver {

    my $version = shift;

    # FIX semver (1 --> 1.0.0 or 1.0 -> 1.0.0)
    my @parts = split /\./, $version;

    $version = join '.', (@parts, 0, 0) if (@parts == 1);
    $version = join '.', (@parts, 0) if (@parts == 2);

    my %semver = (major => 0, minor => 0, patch => 0, prerelease => undef, buildmetadata => undef);

    if ($version =~ /$SEMVER_REGEXP/) {
        %semver = map { $_ => $+{$_} } qw[major minor patch prerelease buildmetadata];
    }

    return wantarray ? %semver : \%semver;

}

sub normalize_semver {
    return unless $_[0];
    return hash_to_semver(parse_semver($_[0]));
}

sub hash_to_semver {

    my %hash = (major => 0, minor => 0, patch => 0, prerelease => undef, buildmetadata => undef, @_);

    my $semver = join '.', $hash{major}, $hash{minor}, $hash{patch};

    $semver .= '-' . $hash{prerelease}    if $hash{prerelease};
    $semver .= '+' . $hash{buildmetadata} if $hash{buildmetadata};

    return $semver;
}

sub version_compare {

    my $scheme = shift;

    my %TYPES = (npm => \&semver_version_compare, semver => \&semver_version_compare);

    if (defined $TYPES{$scheme}) {
        return $TYPES{$scheme}->(@_);
    }

    return generic_version_compare(@_);
}

# Semver compare

sub semver_version_compare {

    return 0 if $_[0] eq $_[1];

    my $a = parse_semver($_[0]);
    my $b = parse_semver($_[1]);

    my $major_cmp = $a->{major} <=> $b->{major};
    return $major_cmp if $major_cmp != 0;

    my $minor_cmp = $a->{minor} <=> $b->{minor};
    return $minor_cmp if $minor_cmp != 0;

    my $patch_cmp = $a->{patch} <=> $b->{patch};
    return $patch_cmp if $patch_cmp != 0;

    return -1 if defined $a->{prerelease}  && !defined $b->{prerelease};
    return 1  if !defined $a->{prerelease} && defined $b->{prerelease};
    return 0  if !defined $a->{prerelease} && !defined $b->{prerelease};

    if (defined $a->{prerelease} && defined $b->{prerelease}) {

        my @pre_a = split(/\./, $a->{prerelease});
        my @pre_b = split(/\./, $b->{prerelease});

        my $min = @pre_a < @pre_b ? scalar(@pre_a) : scalar(@pre_b);

        for my $i (0 .. $min - 1) {
            my $pre_cmp = _cmp_prerelease($pre_a[$i], $pre_b[$i]);
            return $pre_cmp if $pre_cmp != 0;
        }

        return @pre_a <=> @pre_b;

    }

    return 0;

}

sub _cmp_prerelease {

    my ($a, $b) = @_;

    if ($a =~ /^\d+$/ && $b =~ /^\d+$/) {
        return $a <=> $b;
    }

    if ($a =~ /^\d+$/ || $b =~ /^\d+$/) {
        return $a =~ /^\d+$/ ? -1 : 1;
    }

    return $a cmp $b;

}

# Optimized version of Sort::Version

sub generic_version_compare {

    my ($a, $b) = @_;

    $a =~ s/^[vV]//;
    $b =~ s/^[vV]//;

    return 0 if $a eq $b;

    my @A = ($a =~ /([-.]|\d+|[^-.\d]+)/g);
    my @B = ($b =~ /([-.]|\d+|[^-.\d]+)/g);

    my ($A, $B);

    while (@A and @B) {

        $A = shift @A;
        $B = shift @B;

        return -1 if $A eq '-' && $B ne '-';
        return 1  if $B eq '-' && $A ne '-';

        return -1 if $A eq '.' && $B ne '.';
        return 1  if $B eq '.' && $A ne '.';

        next if $A eq '-' && $B eq '-';
        next if $A eq '.' && $B eq '.';

        if ($A =~ /^\d+$/ and $B =~ /^\d+$/) {
            my $num_cmp = ($A =~ /^0/ || $B =~ /^0/) ? ($A cmp $B) : ($A <=> $B);
            return $num_cmp if $num_cmp;
        }
        else {
            my $str_cmp = uc($A) cmp uc($B);
            return $str_cmp;
        }

    }

    return @A <=> @B;

}

1;

__END__

=encoding utf-8

=head1 NAME

URI::VersionRange::Util - Utility for URI::VersionRange

=head1 SYNOPSIS

  use URI::VersionRange::Util qw(native_range_to_vers);

  $vers = native_range_to_vers('npm', '~1.6.5 || >=1.7.2'); # vers:npm/>=1.6.5|<1.7.0|>=1.7.2'


=head1 DESCRIPTION

URL::VersionRange::Util is the utility package for URL::VersionRange.

=over

=item $string = native_range_to_vers($scheme, $native_range)

Converts the specified native range string and returns the corresponding VERS string.

    $vers = native_range_to_vers('npm', '~1.6.5 || >=1.7.2'); # vers:npm/>=1.6.5|<1.7.0|>=1.7.2'


Supported native range scheme:

=over

=item conan

=item gem

=item nginx

=item npm

=item nuget

=item raku

=item semver

=back

For other schemes, C<native_range_to_vers> will attempt to convert the native
range string to a VERS string, but this may not work perfectly.

=back


=head2 Version compare utility

=over

=item $int = version_compare($scheme, $a, $b)

=item $int = generic_version_compare($a, $b)

=item $int = semver_version_compare($a, $b)

=back


=head2 Semver utility

=over

=item $string = hash_to_semver(%hash)

=item $bool = is_semver($string)

=item $string = normalize_semver($string)

=item %hash = parse_semver($string)

=back

=head1 SUPPORT

=head2 Bugs / Feature Requests

Please report any bugs or feature requests through the issue tracker
at L<https://github.com/giterlizzi/perl-URI-PackageURL/issues>.
You will be notified automatically of any progress on your issue.

=head2 Source Code

This is open source software.  The code repository is available for
public review and contribution under the terms of the license.

L<https://github.com/giterlizzi/perl-URI-PackageURL>

    git clone https://github.com/giterlizzi/perl-URI-PackageURL.git


=head1 AUTHOR

=over

=item * Giuseppe Di Terlizzi <gdt@cpan.org>

=back


=head1 LICENSE AND COPYRIGHT

This software is copyright (c) 2022-2026 by Giuseppe Di Terlizzi.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=cut