Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
package org.opendaylight.odlparent;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.net.MalformedURLException;
import java.net.URL;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;
import java.util.regex.Pattern;
import org.apache.karaf.features.BundleInfo;
import org.apache.karaf.features.Conditional;
import org.apache.karaf.features.internal.model.Bundle;
import org.apache.karaf.features.internal.model.ConfigFile;
import org.apache.karaf.features.internal.model.Feature;
import org.apache.karaf.features.internal.model.Features;
import org.apache.karaf.features.internal.model.JaxbUtil;
import org.apache.maven.plugin.MojoExecutionException;
import org.checkerframework.checker.regex.qual.Regex;
import org.eclipse.aether.artifact.Artifact;
import org.ops4j.pax.url.mvn.internal.Parser;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public final class FeatureUtil {
private static final Logger LOG = LoggerFactory.getLogger(FeatureUtil.class);
private static final Pattern MVN_PATTERN = Pattern.compile("mvn:", Pattern.LITERAL);
private static final Pattern WRAP_PATTERN = Pattern.compile("wrap:", Pattern.LITERAL);
@Regex
private static final String VERSION_STRIP_PATTERN_STR = "\\$.*$";
private static final Pattern VERSION_STRIP_PATTERN = Pattern.compile(VERSION_STRIP_PATTERN_STR);
private final AetherUtil aetherUtil;
private final File localRepo;
public FeatureUtil(AetherUtil aetherUtil, File localRepo) {
this.aetherUtil = aetherUtil;
this.localRepo = localRepo;
}
/**
* Converts the given list of URLs to artifact coordinates.
*
* @param urls The URLs.
* @return The corresponding artifact coordinates.
* @throws MalformedURLException if a URL is malformed.
*/
public static List toCoord(final List urls) throws MalformedURLException {
List result = new ArrayList<>();
for (URL url : urls) {
result.add(toCoord(url));
}
LOG.trace("toCoord({}) returns {}", urls, result);
return result;
}
/**
* Converts the given URL to artifact coordinates.
*
* @param url The URL.
* @return The corresponding artifact coordinates.
* @throws MalformedURLException if the URL is malformed.
*/
public static String toCoord(final URL url) throws MalformedURLException {
String repository = url.toString();
String unwrappedRepo = WRAP_PATTERN.matcher(repository).replaceFirst("");
Parser parser = new Parser(unwrappedRepo);
String coord = MVN_PATTERN.matcher(parser.getGroup()).replaceFirst("") + ":" + parser.getArtifact();
if (parser.getType() != null) {
coord = coord + ":" + parser.getType();
}
if (parser.getClassifier() != null) {
coord = coord + ":" + parser.getClassifier();
}
coord = coord + ":" + VERSION_STRIP_PATTERN.matcher(parser.getVersion()).replaceAll("");
LOG.trace("toCoord({}) returns {}", url, coord);
return coord;
}
/**
* Parses the given repository as URLs and converts them to artifact coordinates.
*
* @param repository The repository (list of URLs).
* @return The corresponding artifact coordinates.
* @throws MalformedURLException if a URL is malformed.
*/
public static Set mvnUrlsToCoord(final List repository) throws MalformedURLException {
Set result = new LinkedHashSet<>();
for (String url : repository) {
result.add(toCoord(new URL(url)));
}
LOG.trace("mvnUrlsToCoord({}) returns {}", repository, result);
return result;
}
/**
* Converts the given features' repository to artifact coordinates.
*
* @param features The features.
* @return The corresponding artifact coordinates.
* @throws MalformedURLException if a URL is malformed.
*/
public static Set featuresRepositoryToCoords(final Features features) throws MalformedURLException {
return mvnUrlsToCoord(features.getRepository());
}
/**
* Converts all the given features' repositories to artifact coordinates.
*
* @param features The features.
* @return The corresponding artifact coordinates.
* @throws MalformedURLException if a URL is malformed.
*/
public static Set featuresRepositoryToCoords(final Set features) throws MalformedURLException {
Set result = new LinkedHashSet<>();
for (Features feature : features) {
result.addAll(featuresRepositoryToCoords(feature));
}
LOG.trace("featuresRepositoryToCoords({}) returns {}", features, result);
return result;
}
/**
* Lists the artifact coordinates of the given feature's bundles and configuration files.
*
* @param feature The feature.
* @return The corresponding coordinates.
* @throws MalformedURLException if a URL is malformed.
*/
public static Set featureToCoords(final Feature feature) throws MalformedURLException {
Set result = new LinkedHashSet<>();
if (feature.getBundle() != null) {
result.addAll(bundlesToCoords(feature.getBundle()));
}
if (feature.getConditional() != null) {
for (Conditional conditional : feature.getConditional()) {
if (conditional.getBundles() != null) {
for (BundleInfo bundleInfo : conditional.getBundles()) {
result.add(toCoord(new URL(bundleInfo.getLocation())));
}
}
}
// TODO Dependencies
}
if (feature.getConfigfile() != null) {
result.addAll(configFilesToCoords(feature.getConfigfile()));
}
LOG.trace("featureToCoords({}) returns {}", feature.getName(), result);
return result;
}
/**
* Lists the artifact coordinates of the given configuration files.
*
* @param configfiles The configuration files.
* @return The corresponding coordinates.
* @throws MalformedURLException if a URL is malformed.
*/
public static Set configFilesToCoords(final List configfiles) throws MalformedURLException {
Set result = new LinkedHashSet<>();
for (ConfigFile configFile : configfiles) {
result.add(toCoord(new URL(configFile.getLocation())));
}
LOG.trace("configFilesToCoords({}) returns {}", configfiles, result);
return result;
}
/**
* Lists the artifact coordinates of the given bundles.
*
* @param bundles The bundles.
* @return The corresponding coordinates.
* @throws MalformedURLException if a URL is malformed.
*/
public static Set bundlesToCoords(final List bundles) throws MalformedURLException {
Set result = new LinkedHashSet<>();
for (Bundle bundle : bundles) {
try {
result.add(toCoord(new URL(bundle.getLocation())));
} catch (MalformedURLException e) {
LOG.error("Invalid URL {}", bundle.getLocation(), e);
throw e;
}
}
LOG.trace("bundlesToCoords({}) returns {}", bundles, result);
return result;
}
/**
* Extracts all the artifact coordinates for the given features (repositories, bundles, configuration files).
*
* @param features The feature.
* @return The artifact coordinates.
* @throws MojoExecutionException if an error occurs during processing.
*/
public static Set featuresToCoords(final Features features) throws MojoExecutionException {
Set result = new LinkedHashSet<>();
if (features.getRepository() != null) {
try {
result.addAll(featuresRepositoryToCoords(features));
} catch (MalformedURLException e) {
throw new MojoExecutionException("Feature " + features.getName() + " has an invalid repository URL", e);
}
}
if (features.getFeature() != null) {
for (Feature feature : features.getFeature()) {
try {
result.addAll(featureToCoords(feature));
} catch (MalformedURLException e) {
throw new MojoExecutionException("Feature " + feature.getName() + " in " + features.getName()
+ " contains an invalid or missing URL", e);
}
}
}
LOG.trace("featuresToCoords({}) returns {}", features.getName(), result);
return result;
}
/**
* Extracts all the artifact coordinates for the given set of features (repositories, bundles, configuration
* files).
*
* @param features The features.
* @return The artifact coordinates.
* @throws MojoExecutionException if an error occurs during processing.
*/
public static Set featuresToCoords(final Set features) throws MojoExecutionException {
Set result = new LinkedHashSet<>();
for (Features feature : features) {
result.addAll(featuresToCoords(feature));
}
LOG.trace("featuresToCoords({}) returns {}", features, result);
return result;
}
/**
* Unmarshal all the features in the given artifacts.
*
* @param featureArtifacts The artifacts.
* @return The features.
* @throws FileNotFoundException if a file is missing.
*/
public Set readFeatures(final Set featureArtifacts) throws FileNotFoundException {
Set result = new LinkedHashSet<>();
for (Artifact artifact : featureArtifacts) {
result.add(readFeature(artifact));
}
LOG.trace("readFeatures({}) returns {}", featureArtifacts, result);
return result;
}
/**
* Unmarshal the features in the given artifact.
*
* @param artifact The artifact.
* @return The features.
* @throws FileNotFoundException if a file is missing.
*/
public Features readFeature(final Artifact artifact) throws FileNotFoundException {
return readFeature(artifact.getFile());
}
/**
* Unmarshal the features in the given file.
*
* @param file The file.
* @return The features.
* @throws FileNotFoundException if a file is missing.
*/
public Features readFeature(final File file) throws FileNotFoundException {
File localFile = getFileInLocalRepo(file);
FileInputStream stream = new FileInputStream(localFile != null ? localFile : file);
Features result = JaxbUtil.unmarshal(file.toURI().toString(), stream, false);
LOG.trace("readFeature({}) returns {} without resolving first", file, result.getName());
return result;
}
/**
* Unmarshal the features matching the given artifact coordinates.
*
* @param coords The artifact coordinates.
* @return The features.
* @throws FileNotFoundException if a file is missing.
*/
public Features readFeature(final String coords) throws FileNotFoundException {
Artifact artifact = aetherUtil.resolveArtifact(coords);
Features result = readFeature(artifact);
LOG.trace("readFeature({}) returns {} after resolving first", coords, result.getName());
return result;
}
/**
* Unmarshals all the features starting from the given feature.
*
* @param features The starting features.
* @param existingCoords The artifact coordinates which have already been unmarshalled.
* @return The features.
* @throws MalformedURLException if a URL is malformed.
* @throws FileNotFoundException if a file is missing.
*/
public Set findAllFeaturesRecursively(final Features features, final Set existingCoords)
throws MalformedURLException, FileNotFoundException {
LOG.debug("findAllFeaturesRecursively({}) starts", features.getName());
LOG.trace("findAllFeaturesRecursively knows about these coords: {}", existingCoords);
Set result = new LinkedHashSet<>();
Set coords = FeatureUtil.featuresRepositoryToCoords(features);
for (String coord : coords) {
if (!existingCoords.contains(coord)) {
LOG.trace("findAllFeaturesRecursively() going to add {}", coord);
existingCoords.add(coord);
Features feature = readFeature(coord);
result.add(feature);
LOG.debug("findAllFeaturesRecursively() added {}", coord);
result.addAll(findAllFeaturesRecursively(feature, existingCoords));
} else {
LOG.trace("findAllFeaturesRecursively() skips known {}", coord);
}
}
return result;
}
/**
* Unmarshals all the features starting from the given features.
*
* @param features The starting features.
* @param existingCoords The artifact coordinates which have already been unmarshalled.
* @return The features.
* @throws MalformedURLException if a URL is malformed.
* @throws FileNotFoundException if a file is missing.
*/
public Set findAllFeaturesRecursively(final Set features, final Set existingCoords)
throws MalformedURLException, FileNotFoundException {
Set result = new LinkedHashSet<>();
for (Features feature : features) {
result.addAll(findAllFeaturesRecursively(feature, existingCoords));
}
return result;
}
/**
* Unmarshals all the features (including known ones) starting from the given features.
*
* @param features The starting features.
* @return The features.
* @throws MalformedURLException if a URL is malformed.
* @throws FileNotFoundException if a file is missing.
*/
public Set findAllFeaturesRecursively(final Set features)
throws MalformedURLException, FileNotFoundException {
return findAllFeaturesRecursively(features, new LinkedHashSet<>());
}
void removeLocalArtifacts(Set artifacts) {
if (localRepo != null) {
Iterator it = artifacts.iterator();
while (it.hasNext()) {
Artifact artifact = it.next();
if (getFileInLocalRepo(artifact.getFile()) != null) {
LOG.trace("Removing artifact {}", artifact);
it.remove();
}
}
}
}
private File getFileInLocalRepo(File file) {
Path filePath = file.toPath();
Path parent = filePath.getParent();
while (parent != null) {
File candidate = new File(localRepo, parent.relativize(filePath).toString());
if (candidate.exists()) {
return candidate;
}
parent = parent.getParent();
}
return null;
}
}
