Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: a0a21521deb972c5b3d9e1474e1d7530196ef170 (plain) (blame)
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
/*****************************************************************************
 * Copyright (c) 2016 Christian W. Damus and others.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *   Christian W. Damus - Initial API and implementation
 *
 *****************************************************************************/

package org.eclipse.papyrus.dev.project.management.internal.operations;

import java.util.Objects;
import java.util.function.BiFunction;
import java.util.function.BiPredicate;
import java.util.function.Predicate;
import java.util.stream.Stream;

import org.eclipse.osgi.service.resolver.BundleDescription;
import org.eclipse.osgi.service.resolver.ExportPackageDescription;
import org.eclipse.pde.core.plugin.IPluginModelBase;
import org.eclipse.pde.core.plugin.PluginRegistry;
import org.osgi.framework.Version;
import org.osgi.framework.VersionRange;

/**
 * Utility for management of bundle dependency version ranges, defining rules
 * governing how various specific dependencies are to be managed.
 */
public class VersionRules {

	private final VersionRule rule = VersionRule.composeAll(
			new CurrentVersionRule(), // The default behaviour
			new FixedRangeRule(dep -> dep.startsWith("org.apache.batik"), "[1.6.0,1.7.0)"), //$NON-NLS-1$//$NON-NLS-2$
			new SkipRule("com.ibm.icu") //$NON-NLS-1$
	,new FixedRangeRule("com.google.guava", "30.1.0") //$NON-NLS-1$
	);

	public VersionRules() {
		super();
	}

	/**
	 * Queries the version range that should constraint a dependency of the given {@code kind}
	 * on a bundle or package.
	 *
	 * @param kind
	 *            the dependency kind
	 * @param dependency
	 *            the bundle or package dependency
	 *
	 * @return the appropriate version range, or {@code null} if unknown or the range
	 *         currently specified in the manfiest can be retained as is
	 */
	public VersionRange getDependencyVersionRange(DependencyKind kind, String dependency) {
		return rule.apply(kind, dependency);
	}

	static Version getCurrentMinorVersion(String dependencyName, boolean isPackageImport) {
		Version result = Version.emptyVersion;

		if (!isPackageImport) {
			IPluginModelBase model = PluginRegistry.findModel(dependencyName);
			if (model != null) {
				result = Version.valueOf(model.getPluginBase().getVersion());
			}
		} else {
			// Look for a bundle that exports the package
			result = Stream.of(PluginRegistry.getActiveModels(false))
					.filter(p -> exports(p, dependencyName))
					// TODO: Sort by longest prefix match to the package name
					.map(p -> getExportedVersion(p, dependencyName))
					.findFirst()
					.orElse(Version.emptyVersion);
		}

		if (!result.equals(Version.emptyVersion)) {
			// 'Minorize' it
			result = new Version(result.getMajor(), result.getMinor(), 0);
		}

		return result;
	}

	private static boolean exports(IPluginModelBase pluginModel, String packageName) {
		boolean result = false;

		BundleDescription desc = pluginModel.getBundleDescription();
		if (desc != null) {
			result = Stream.of(desc.getExportPackages())
					.anyMatch(ep -> packageName.equals(ep.getName()));
		}

		return result;
	}

	private static Version getExportedVersion(IPluginModelBase pluginModel, String packageName) {
		// In case there is no bundle description, which would be odd at this point
		Version result = Version.emptyVersion;

		BundleDescription desc = pluginModel.getBundleDescription();
		if (desc != null) {
			result = Stream.of(desc.getExportPackages())
					.filter(ep -> packageName.equals(ep.getName()))
					.map(ExportPackageDescription::getVersion)
					.filter(Objects::nonNull)
					.findAny().orElse(Version.emptyVersion);
		}

		return result;
	}

	//
	// Nested types
	//

	private interface VersionRule extends BiPredicate<DependencyKind, String>, BiFunction<DependencyKind, String, VersionRange> {
		default VersionRule compose(VersionRule other) {
			return new VersionRule() {

				@Override
				public VersionRange apply(DependencyKind kind, String dependencyName) {
					return VersionRule.this.test(kind, dependencyName)
							? VersionRule.this.apply(kind, dependencyName)
							: other.apply(kind, dependencyName);
				}

				@Override
				public boolean test(DependencyKind kind, String dependencyName) {
					return VersionRule.this.test(kind, dependencyName) || other.test(kind, dependencyName);
				}
			};
		}

		static VersionRule composeAll(VersionRule default_, VersionRule... rules) {
			VersionRule result = default_;
			for (VersionRule next : rules) {
				result = next.compose(result);
			}
			return result;
		}
	}

	private static abstract class AbstractRule implements VersionRule {
		private final BiPredicate<DependencyKind, String> predicate;

		AbstractRule(BiPredicate<DependencyKind, String> predicate) {
			super();

			this.predicate = predicate;
		}

		AbstractRule(Predicate<String> predicate) {
			this((kind, dep) -> predicate.test(dep));
		}

		@Override
		public boolean test(DependencyKind kind, String dependencyName) {
			return predicate.test(kind, dependencyName);
		}
	}

	private static final class FixedRangeRule extends AbstractRule {
		private final VersionRange range;

		FixedRangeRule(String bundleID, String range) {
			this(bundleID::equals, VersionRange.valueOf(range));
		}

		FixedRangeRule(Predicate<String> predicate, String range) {
			this(predicate, VersionRange.valueOf(range));
		}

		FixedRangeRule(Predicate<String> predicate, VersionRange range) {
			super(predicate);

			this.range = range;
		}

		@Override
		public VersionRange apply(DependencyKind kind, String dependencyName) {
			return range;
		}
	}

	private static final class SkipRule extends AbstractRule {
		SkipRule(String dependencyName) {
			this(dependencyName::equals);
		}

		SkipRule(Predicate<String> predicate) {
			super(predicate);
		}

		@Override
		public VersionRange apply(DependencyKind kind, String dependencyName) {
			return null;
		}
	}

	private static class CurrentVersionRule extends AbstractRule {
		private CurrentVersionRule() {
			super((kind, dep) -> true);
		}

		@Override
		public VersionRange apply(DependencyKind kind, String dependencyName) {
			Version current = getCurrentMinorVersion(dependencyName, kind == DependencyKind.IMPORT_PACKAGE);
			Version next = ((current == null) || current.equals(Version.emptyVersion))
					? null
					: new Version(current.getMajor() + 1, 0, 0);

			return (next == null)
					? null
					: new VersionRange(VersionRange.LEFT_CLOSED, current, next, VersionRange.RIGHT_OPEN);
		}
	}
}

Back to the top