Skip to content

Commit c990673

Browse files
dwalluckdwalluck
committed
package-urlGH-188: Implement package type providers
1 parent dd5f743 commit c990673

34 files changed

+649
-10
lines changed

‎src/main/java/com/github/packageurl/PackageURL.java‎

Lines changed: 30 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@
3434
import java.util.TreeMap;
3535
import java.util.function.IntPredicate;
3636
import java.util.stream.Collectors;
37+
38+
import com.github.packageurl.type.PackageTypeFactory;
3739
import org.jspecify.annotations.Nullable;
3840

3941
/**
@@ -96,7 +98,7 @@ public PackageURL(final String type, final String name) throws MalformedPackageU
9698
* @deprecated use {@link #PackageURL(String, String, String, String, Map, String)} instead
9799
*/
98100
@Deprecated
99-
public PackageURL(final String type, final @Nullable String namespace, final String name, final @Nullable String version,
101+
public PackageURL(final @Nullable String type, final @Nullable String namespace, final @Nullable String name, final @Nullable String version,
100102
final @Nullable TreeMap<String, String> qualifiers, final @Nullable String subpath)
101103
throws MalformedPackageURLException {
102104
this.type = toLowerCase(validateType(requireNonNull(type, "type")));
@@ -105,7 +107,8 @@ public PackageURL(final String type, final @Nullable String namespace, final Str
105107
this.version = validateVersion(type, version);
106108
this.qualifiers = parseQualifiers(qualifiers);
107109
this.subpath = validateSubpath(subpath);
108-
verifyTypeConstraints(this.type, this.namespace, this.name);
110+
//verifyTypeConstraints(this.type, this.namespace, this.name);
111+
PackageTypeFactory.getDefault().validateComponents(type, namespace, name, version, qualifiers, subpath);
109112
}
110113

111114
/**
@@ -121,7 +124,7 @@ public PackageURL(final String type, final @Nullable String namespace, final Str
121124
* @throws NullPointerException if {@code type} or {@code name} are {@code null}
122125
* @since 1.6.0
123126
*/
124-
public PackageURL(final String type, final @Nullable String namespace, final String name, final @Nullable String version,
127+
public PackageURL(final @Nullable String type, final @Nullable String namespace, final @Nullable String name, final @Nullable String version,
125128
final @Nullable Map<String, @Nullable String> qualifiers, final @Nullable String subpath)
126129
throws MalformedPackageURLException {
127130
this(type, namespace, name, version, (qualifiers != null) ? new TreeMap<>(qualifiers) : null, subpath);
@@ -280,7 +283,7 @@ private static boolean isValidCharForType(int c) {
280283
return (isAlphaNumeric(c) || c == '.' || c == '+' || c == '-');
281284
}
282285

283-
private static boolean isValidCharForKey(int c) {
286+
public static boolean isValidCharForKey(int c) {
284287
return (isAlphaNumeric(c) || c == '.' || c == '_' || c == '-');
285288
}
286289

@@ -438,6 +441,10 @@ private static void validateValue(final String key, final @Nullable String value
438441
}
439442
}
440443

444+
public PackageURL normalize() throws MalformedPackageURLException {
445+
return PackageTypeFactory.getDefault().normalizeComponents(type, namespace, name, version, qualifiers, subpath);
446+
}
447+
441448
/**
442449
* Returns the canonicalized representation of the purl.
443450
*
@@ -466,6 +473,17 @@ public String canonicalize() {
466473
* @since 1.3.2
467474
*/
468475
private String canonicalize(boolean coordinatesOnly) {
476+
try {
477+
PackageURL packageURL = normalize();
478+
namespace = packageURL.getNamespace();
479+
name = packageURL.getName();
480+
version = packageURL.getVersion();
481+
qualifiers = packageURL.getQualifiers();
482+
subpath = packageURL.getSubpath();
483+
} catch (MalformedPackageURLException e) {
484+
throw new ValidationException("Normalization failed", e);
485+
}
486+
469487
final StringBuilder purl = new StringBuilder();
470488
purl.append(SCHEME_PART).append(type).append("/");
471489
if (namespace != null) {
@@ -523,18 +541,22 @@ private static boolean isUnreserved(int c) {
523541
return (isValidCharForKey(c) || c == '~');
524542
}
525543

526-
private static boolean isAlpha(int c) {
544+
public static boolean isAlpha(int c) {
527545
return (isLowerCase(c) || isUpperCase(c));
528546
}
529547

530548
private static boolean isDigit(int c) {
531549
return (c >= '0' && c <= '9');
532550
}
533551

534-
private static boolean isAlphaNumeric(int c) {
552+
public static boolean isAlphaNumeric(int c) {
535553
return (isDigit(c) || isAlpha(c));
536554
}
537555

556+
public static boolean isWhitespace(int c) {
557+
return (c == ' ' || c == '\t' || c == '\r' || c == '\n');
558+
}
559+
538560
private static boolean isUpperCase(int c) {
539561
return (c >= 'A' && c <= 'Z');
540562
}
@@ -559,7 +581,7 @@ private static int toLowerCase(int c) {
559581
return (c ^ 0x20);
560582
}
561583

562-
private static String toLowerCase(String s) {
584+
public static String toLowerCase(String s) {
563585
int pos = indexOfFirstUpperCaseChar(s);
564586

565587
if (pos == -1) {
@@ -697,7 +719,7 @@ private void parse(final String purl) throws MalformedPackageURLException {
697719
remainder = remainder.substring(0, index);
698720
this.namespace = validateNamespace(parsePath(remainder.substring(start), false));
699721
}
700-
verifyTypeConstraints(this.type, this.namespace, this.name);
722+
//verifyTypeConstraints(this.type, this.namespace, this.name);
701723
} catch (URISyntaxException e) {
702724
throw new MalformedPackageURLException("Invalid purl: " + e.getMessage(), e);
703725
}

‎src/main/java/com/github/packageurl/ValidationException.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,8 @@ class ValidationException extends RuntimeException {
3838
ValidationException(String msg) {
3939
super(msg);
4040
}
41+
42+
ValidationException(String msg, Throwable cause) {
43+
super(msg, cause);
44+
}
4145
}

‎src/main/java/com/github/packageurl/type/ApkPackageTypeProvider.java‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
package com.github.packageurl.type;
2+
3+
public class ApkPackageTypeProvider extends LowercaseNamespaceAndNameTypeProvider {
4+
5+
}

‎src/main/java/com/github/packageurl/type/BitbucketPackageTypeProvider.java‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
package com.github.packageurl.type;
2+
3+
public class BitbucketPackageTypeProvider extends LowercaseNamespaceAndNameTypeProvider {
4+
5+
}

‎src/main/java/com/github/packageurl/type/BitnamiPackageTypeProvider.java‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
package com.github.packageurl.type;
2+
3+
public class BitnamiPackageTypeProvider extends LowercaseNamespacePackageTypeProvider {
4+
5+
}

‎src/main/java/com/github/packageurl/type/CocoapodsPackageTypeProvider.java‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
package com.github.packageurl.type;
2+
3+
import com.github.packageurl.MalformedPackageURLException;
4+
import com.github.packageurl.PackageURL;
5+
import org.jspecify.annotations.NonNull;
6+
import org.jspecify.annotations.Nullable;
7+
8+
import java.util.Map;
9+
10+
public class CocoapodsPackageTypeProvider implements PackageTypeProvider {
11+
@Override
12+
public void validateComponents(@NonNull String type, @Nullable String namespace, @Nullable String name, @Nullable String version, @Nullable Map<String, String> qualifiers, @Nullable String subpath) throws MalformedPackageURLException {
13+
if (namespace != null && !namespace.isEmpty()) {
14+
throw new MalformedPackageURLException("invalid cocoapods purl cannot have a namespace");
15+
}
16+
17+
if (name == null || name.isEmpty() || name.chars().anyMatch(PackageURL::isWhitespace) || name.startsWith(".") || name.contains("+")) {
18+
throw new MalformedPackageURLException("invalid cocoapods purl invalid name");
19+
}
20+
}
21+
}

‎src/main/java/com/github/packageurl/type/ComposerPackageTypeProvider.java‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
package com.github.packageurl.type;
2+
3+
public class ComposerPackageTypeProvider extends LowercaseNamespaceAndNameTypeProvider {
4+
5+
}

‎src/main/java/com/github/packageurl/type/ConanPackageTypeProvider.java‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
package com.github.packageurl.type;
2+
3+
import com.github.packageurl.MalformedPackageURLException;
4+
import org.jspecify.annotations.NonNull;
5+
import org.jspecify.annotations.Nullable;
6+
7+
import java.util.Map;
8+
9+
public class ConanPackageTypeProvider implements PackageTypeProvider {
10+
@Override
11+
public void validateComponents(@NonNull String type, @Nullable String namespace, @Nullable String name, @Nullable String version, @Nullable Map<String, String> qualifiers, @Nullable String subpath) throws MalformedPackageURLException {
12+
boolean hasChannel = (qualifiers != null && !qualifiers.isEmpty());
13+
14+
if ((namespace != null && !namespace.isEmpty()) && !hasChannel) {
15+
throw new MalformedPackageURLException("invalid conan purl only namespace");
16+
} else if ((namespace == null || namespace.isEmpty()) && hasChannel) {
17+
throw new MalformedPackageURLException("invalid conan purl only channel qualifier");
18+
}
19+
}
20+
}

‎src/main/java/com/github/packageurl/type/CpanPackageTypeProvider.java‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
package com.github.packageurl.type;
2+
3+
import com.github.packageurl.MalformedPackageURLException;
4+
import org.jspecify.annotations.NonNull;
5+
import org.jspecify.annotations.Nullable;
6+
7+
import java.util.Map;
8+
9+
public class CpanPackageTypeProvider implements PackageTypeProvider {
10+
@Override
11+
public void validateComponents(@NonNull String type, @Nullable String namespace, @Nullable String name, @Nullable String version, @Nullable Map<String, String> qualifiers, @Nullable String subpath) throws MalformedPackageURLException {
12+
if ((namespace == null || namespace.isEmpty()) && name != null && name.indexOf('-') != -1) {
13+
throw new MalformedPackageURLException("cpan module name like distribution name");
14+
} else if ((namespace != null && !namespace.isEmpty()) && name != null && name.contains("::")) {
15+
throw new MalformedPackageURLException("cpan distribution name like module name");
16+
}
17+
}
18+
}

‎src/main/java/com/github/packageurl/type/CranPackageTypeProvider.java‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
package com.github.packageurl.type;
2+
3+
import com.github.packageurl.MalformedPackageURLException;
4+
import org.jspecify.annotations.NonNull;
5+
import org.jspecify.annotations.Nullable;
6+
7+
import java.util.Map;
8+
9+
public class CranPackageTypeProvider implements PackageTypeProvider {
10+
@Override
11+
public void validateComponents(@NonNull String type, @Nullable String namespace, @Nullable String name, @Nullable String version, @Nullable Map<String, String> qualifiers, @Nullable String subpath) throws MalformedPackageURLException {
12+
if (name == null || name.isEmpty()) {
13+
throw new MalformedPackageURLException("invalid cran purl without name");
14+
}
15+
16+
if (version == null || version.isEmpty()) {
17+
throw new MalformedPackageURLException("invalid cran purl without version");
18+
}
19+
}
20+
}

0 commit comments

Comments
 (0)