|
| 1 | +/******************************************************************************* |
| 2 | + * Copyright (c) 2025, 2025 IBM Corporation and others. |
| 3 | + * |
| 4 | + * This program and the accompanying materials |
| 5 | + * are made available under the terms of the Eclipse Public License 2.0 |
| 6 | + * which accompanies this distribution, and is available at |
| 7 | + * https://www.eclipse.org/legal/epl-2.0/ |
| 8 | + * |
| 9 | + * SPDX-License-Identifier: EPL-2.0 |
| 10 | + * |
| 11 | + * Contributors: |
| 12 | + * IBM Corporation - initial API and implementation |
| 13 | + *******************************************************************************/ |
| 14 | + |
| 15 | +package org.eclipse.pde.internal.ui.correction; |
| 16 | + |
| 17 | +import java.util.HashSet; |
| 18 | +import java.util.Objects; |
| 19 | +import java.util.Set; |
| 20 | + |
| 21 | +import org.eclipse.core.resources.IMarker; |
| 22 | +import org.eclipse.osgi.service.resolver.BundleDescription; |
| 23 | +import org.eclipse.osgi.service.resolver.ExportPackageDescription; |
| 24 | +import org.eclipse.pde.core.plugin.IPluginModelBase; |
| 25 | +import org.eclipse.pde.core.plugin.PluginRegistry; |
| 26 | +import org.eclipse.pde.core.target.NameVersionDescriptor; |
| 27 | +import org.eclipse.pde.internal.core.text.bundle.Bundle; |
| 28 | +import org.eclipse.pde.internal.core.text.bundle.BundleModel; |
| 29 | +import org.eclipse.pde.internal.core.text.bundle.ImportPackageHeader; |
| 30 | +import org.eclipse.pde.internal.core.text.bundle.ImportPackageObject; |
| 31 | +import org.eclipse.pde.internal.core.text.bundle.ManifestHeader; |
| 32 | +import org.eclipse.pde.internal.core.text.bundle.PackageObject; |
| 33 | +import org.eclipse.pde.internal.core.util.VersionUtil; |
| 34 | +import org.eclipse.pde.internal.ui.PDEUIMessages; |
| 35 | +import org.osgi.framework.Constants; |
| 36 | + |
| 37 | +/** |
| 38 | + * Resolution to add available matching version for Imported package in MANIFEST |
| 39 | + */ |
| 40 | +public class VersionMatchImportPackageResolution extends AbstractManifestMarkerResolution { |
| 41 | + |
| 42 | + public VersionMatchImportPackageResolution(int type, IMarker marker) { |
| 43 | + super(type, marker); |
| 44 | + } |
| 45 | + |
| 46 | + public String getVersion(Object inputElement) { |
| 47 | + IPluginModelBase[] models = PluginRegistry.getActiveModels(); |
| 48 | + Set<NameVersionDescriptor> nameVersions = new HashSet<>(); |
| 49 | + for (IPluginModelBase pluginModel : models) { |
| 50 | + BundleDescription desc = pluginModel.getBundleDescription(); |
| 51 | + |
| 52 | + String id = desc == null ? null : desc.getSymbolicName(); |
| 53 | + if (id == null) { |
| 54 | + continue; |
| 55 | + } |
| 56 | + ExportPackageDescription[] exported = desc.getExportPackages(); |
| 57 | + for (ExportPackageDescription exportedPackage : exported) { |
| 58 | + String name = exportedPackage.getName(); |
| 59 | + ManifestHeader mHeader = new ManifestHeader("Export-Package", "", //$NON-NLS-1$//$NON-NLS-2$ |
| 60 | + new org.eclipse.pde.internal.core.bundle.Bundle(), "\n"); //$NON-NLS-1$ |
| 61 | + PackageObject po = new PackageObject(mHeader, exportedPackage.getName(), |
| 62 | + exportedPackage.getVersion().toString(), "version"); //$NON-NLS-1$ |
| 63 | + |
| 64 | + NameVersionDescriptor nameVersion = new NameVersionDescriptor(exportedPackage.getName(), |
| 65 | + exportedPackage.getVersion().toString(), NameVersionDescriptor.TYPE_PACKAGE); |
| 66 | + exportedPackage.getExporter().getBundle(); |
| 67 | + |
| 68 | + if (("java".equals(name) || name.startsWith("java."))) { //$NON-NLS-1$ //$NON-NLS-2$ |
| 69 | + // $NON-NLS-2$ |
| 70 | + continue; |
| 71 | + } |
| 72 | + if (nameVersions.add(nameVersion)) { |
| 73 | + if (name.equalsIgnoreCase(inputElement.toString())) { |
| 74 | + return po.getVersion(); |
| 75 | + } |
| 76 | + } |
| 77 | + } |
| 78 | + } |
| 79 | + return ""; //$NON-NLS-1$ |
| 80 | + } |
| 81 | + |
| 82 | + @Override |
| 83 | + protected void createChange(BundleModel model) { |
| 84 | + String bundleId = Objects.requireNonNull(marker.getAttribute("bundleId", (String) null)); //$NON-NLS-1$ |
| 85 | + Bundle bundle = (Bundle) model.getBundle(); |
| 86 | + ImportPackageHeader header = (ImportPackageHeader) bundle.getManifestHeader(Constants.IMPORT_PACKAGE); |
| 87 | + if (header != null) { |
| 88 | + for (ImportPackageObject importPackage : header.getPackages()) { |
| 89 | + if (bundleId.equals(importPackage.getName())) { |
| 90 | + String version = getVersion(bundleId); |
| 91 | + if (!version.isEmpty()) { |
| 92 | + // Sanitize version: Remove a potential qualifier |
| 93 | + version = VersionUtil.computeInitialPluginVersion(version); |
| 94 | + importPackage.setVersion(version); |
| 95 | + } |
| 96 | + } |
| 97 | + } |
| 98 | + } |
| 99 | + } |
| 100 | + |
| 101 | + @Override |
| 102 | + public String getLabel() { |
| 103 | + return PDEUIMessages.AddMatchingVersion; |
| 104 | + } |
| 105 | + |
| 106 | + |
| 107 | +} |
0 commit comments