bundle-plugin/src/main/java/com/yahoo/container/plugin/bundle/AnalyzeBundle.java


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

// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.container.plugin.bundle;

import com.yahoo.container.plugin.osgi.ExportPackageParser;
import com.yahoo.container.plugin.osgi.ExportPackages.Export;
import com.yahoo.container.plugin.util.JarFiles;

import java.io.File;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import java.util.jar.Manifest;

import static com.yahoo.container.plugin.util.JarFiles.getMainAttributeValue;

/**
 * Static utilities for analyzing jar files.
 *
 * @author Tony Vaagenes
 * @author ollivir
 * @author gjoranv
 */
public class AnalyzeBundle {

    public static List<Export> exportedPackagesAggregated(Collection<File> jarFiles) {
        List<Export> exports = new ArrayList<>();

        for (File jarFile : jarFiles) {
            var exported = exportedPackages(jarFile);
            exports.addAll(exported);
        }
        return exports;
    }

    static List<Export> exportedPackages(File jarFile) {
        var manifest = getOsgiManifest(jarFile);
        if (manifest == null) return Collections.emptyList();
        try {
            return parseExports(manifest);
        } catch (Exception e) {
            throw new RuntimeException(String.format("Invalid manifest in bundle '%s'", jarFile.getPath()), e);
        }
    }

    public static List<String> nonPublicApiPackagesAggregated(Collection<File> jarFiles) {
        return jarFiles.stream()
                .map(AnalyzeBundle::nonPublicApiPackages)
                .flatMap(List::stream)
                .distinct()
                .toList();
    }

    private static List<String> nonPublicApiPackages(File jarFile) {
        var manifest = getOsgiManifest(jarFile);
        if (manifest == null) return Collections.emptyList();
        return getMainAttributeValue(manifest, "X-JDisc-Non-PublicApi-Export-Package")
                .map(s -> Arrays.asList(s.split(",")))
                .orElseGet(ArrayList::new);
    }

    private static Manifest getOsgiManifest(File jarFile) {
        Optional<Manifest> jarManifest = JarFiles.getManifest(jarFile);
        if (jarManifest.isPresent()) {
            Manifest manifest = jarManifest.get();
            if (isOsgiManifest(manifest)) {
                return manifest;
            }
        }
        return null;
    }

    public static Optional<String> bundleSymbolicName(File jarFile) {
        return JarFiles.getManifest(jarFile).flatMap(AnalyzeBundle::getBundleSymbolicName);
    }

    private static List<Export> parseExports(Manifest jarManifest) {
        return getMainAttributeValue(jarManifest, "Export-Package")
                .map(ExportPackageParser::parseExports)
                .orElseGet(ArrayList::new);
    }

    private static boolean isOsgiManifest(Manifest mf) {
        return getBundleSymbolicName(mf).isPresent();
    }

    private static Optional<String> getBundleSymbolicName(Manifest mf) {
        return getMainAttributeValue(mf, "Bundle-SymbolicName");
    }
}