/**
* Copyright (c) 2013/2014 Verein zur Foerderung der IT-Sicherheit in Oesterreich (SBA).
* The work has been developed in the TIMBUS Project and the above-mentioned are Members of the TIMBUS Consortium.
* TIMBUS is supported by the European Union under the 7th Framework Programme for research and technological
* development and demonstration activities (FP7/2007-2013) under grant agreement no. 269940.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at: http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including without
* limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTIBITLY, or FITNESS FOR A PARTICULAR
* PURPOSE. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise,
* unless required by applicable law or agreed to in writing, shall any Contributor be liable for damages, including
* any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this
* License or out of the use or inability to use the Work.
* See the License for the specific language governing permissions and limitation under the License.
*/
package net.timbusproject.dpes.alternative.AlternativesBuilder;
import com.sun.xml.ws.fault.ServerSOAPFaultException;
import net.timbusproject.dpes.alternative.PreservationAlternative;
import net.timbusproject.dpes.alternative.ReasonerClient.common.RequestData;
import net.timbusproject.dpes.alternative.ReasonerClient.SOAP.DependencyReasonerClient;
import net.timbusproject.dpes.alternative.ReasonerClient.common.ReasonerClientException;
import net.timbusproject.dpes.alternative.ReasonerClient.common.ResponseData;
import net.timbusproject.dpes.alternative.Risk;
import org.json.JSONException;
import org.sba_research.timbus.kb.PackageKnowledgeBase;
import org.sbaresearch.owl.*;
import org.semanticweb.owlapi.apibinding.OWLManager;
import org.semanticweb.owlapi.model.IRI;
import org.semanticweb.owlapi.model.OWLNamedIndividual;
import org.semanticweb.owlapi.model.OWLOntologyCreationException;
import org.semanticweb.owlapi.model.OWLOntologyStorageException;
import org.slf4j.LoggerFactory;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
/**
* @author Rudolf Mayer
*/
public class PackageAlternativesBuilder implements PreservationAlternativesBuilder {
private static final org.slf4j.Logger LOG = LoggerFactory.getLogger(PackageAlternativesBuilder.class);
public static final IRI IRI_PACKAGE = IRI.create("http://timbus.teco.edu/ontologies/DSOs/CUDF.owl#Package");
public static final IRI IRI_HAS_DEPENDENCY = IRI.create("http://timbus.teco.edu/ontologies/DSOs/CUDF.owl#hasDependency");
private final PackageKnowledgeBase knowledgeBase;
private final String baseURL;
private final OwlApiFacade originalModelFacade;
private final String identifier;
private final int limit;
private final boolean dependencyReasonerEnabled;
public PackageAlternativesBuilder(PackageKnowledgeBase packageKnowledgeBase, String baseURL, OwlApiFacade originalModelFacade, String identifier, int limit, boolean dependencyReasonerEnabled) {
this.knowledgeBase = packageKnowledgeBase;
this.baseURL = baseURL;
this.originalModelFacade = originalModelFacade;
this.identifier = identifier;
this.limit = limit;
this.dependencyReasonerEnabled = dependencyReasonerEnabled;
}
@Override
public List<PreservationAlternative> createAlternatives(Risk identifiedRisk, IRI individualAtRisk) throws OWLOntologyStorageException,
OWLOntologyCreationException, IOException, OwlElementNotFoundException {
LOG.info("Searching for package alternatives...");
List<PreservationAlternative> alternatives = new ArrayList<>();
String affectedResourceName = identifiedRisk.getAffectedResource();
ChangesOntologyBuilder changesOntologyBuilder = new ChangesOntologyBuilder(
originalModelFacade.getOntology(), originalModelFacade.getIndividual(individualAtRisk.toString()), "SoftwareReplacement");
String packageName = AlternativesBuilderHelper.getFragmentOfResource(originalModelFacade, affectedResourceName);
// 1. Get virtual package(s) that are provided by this package
// 1.a. get them directly from the model; this is the prefered way
LOG.info("Getting directly provided virtual packages for package: " + packageName);
// TODO: query which virtual package is directly providedBy this package (or which virtual package is provides by package)
PackageKnowledgeBase pkb = new PackageKnowledgeBase(new JenaQueryFacade(originalModelFacade.getJenaModel(false)));
List<String> virtualPackages = pkb.getVirtualPackages(individualAtRisk.toString());
List<String> alternativePackages = new ArrayList<>();
if (virtualPackages.size() > 0) {
LOG.info("Found virtual packages for the individual at risk in the model, using those to retrieve alternatives.");
for (String virtualPackageName : virtualPackages) {
LOG.info("Getting alternatives for package: " + packageName + " / " + virtualPackageName);
alternativePackages.addAll(knowledgeBase.getAlternativePackages(affectedResourceName, virtualPackageName));
}
} else {
LOG.info("No virtual package for the individual at risk found, using all available virtual packages.");
String affectedResourceFragment = AlternativesBuilderHelper.getFragmentOfResource(originalModelFacade, affectedResourceName);
alternativePackages.addAll(knowledgeBase.getAlternativePackages(affectedResourceFragment));
}
for (int i = 0; i < alternativePackages.size(); ++i) {
if (i >= limit) {
LOG.warn("Too many results, alternatives have been truncated...");
break;
}
LOG.info("Replacing identified software " + affectedResourceName);
String alternativeOntologyIri = AlternativesBuilderHelper.createIriFragment(baseURL, identifier, identifiedRisk, i);
String iriSuffix = identifier + "/" + i;
PreservationAlternative alternativeOntology = AlternativesBuilderHelper.createAlternativeOntology(originalModelFacade.getOntology(), identifiedRisk,
individualAtRisk, alternativePackages.get(i), alternativeOntologyIri, changesOntologyBuilder, iriSuffix);
alternatives.add(alternativeOntology);
OwlApiFacade modifiedContextModel = new OwlApiFacade(OWLManager.createOWLOntologyManager(), OWLManager.getOWLDataFactory()); //)alternativeOntology.getModifiedContextModel();
modifiedContextModel.load(new ByteArrayInputStream(alternativeOntology.getModifiedContextModel().getBytes(StandardCharsets.UTF_8)));
addRemoveResolvedPackages(identifiedRisk, alternativePackages.get(i), modifiedContextModel);
alternativeOntology.setModifiedContextModel(modifiedContextModel.toOwlXml());
}
return alternatives;
}
private void addRemoveResolvedPackages(Risk identifiedRisk, String packageToInstall, OwlApiFacade modifiedContextModel) throws IOException, OwlElementNotFoundException {
if (!dependencyReasonerEnabled) return;
ResponseData data;
try {
data = new DependencyReasonerClient().request(new RequestData(
Arrays.asList(packageToInstall),
Arrays.asList(AlternativesBuilderHelper.getFragmentOfResource(originalModelFacade, identifiedRisk.getAffectedResource())),
"TODO-target", "TODO-dataset", "TODO-ontology", "TODO-universe")); // TODO: it is not yet clarified where this information comes from
} catch (ReasonerClientException | JSONException | ServerSOAPFaultException e) {
LOG.error(e.getMessage());
data = new ResponseData();
}
// TODO: test entries, remove after integration of the dependency reasoner!
//data.getPackagesToInstall().add(packageToInstall + "-common");
//data.getPackagesToRemove().add(identifiedRisk.getAffectedResource() + "-common");
OWLNamedIndividual newPackage = modifiedContextModel.getIndividualByLabel(packageToInstall);
for (String p: data.getPackagesToInstall()) {
OWLNamedIndividual dependency = modifiedContextModel.addIndividualByLabel(p, OwlApiFacade.cleanName(p), IRI_PACKAGE.toString());
if (newPackage == null) {
LOG.error("Unable to locate package in modified model: " + packageToInstall);
} else {
modifiedContextModel.addObjectProperty(newPackage, IRI_HAS_DEPENDENCY.toString(), dependency);
}
// TODO: add changes entry? what would be the source object?
}
for (String p: data.getPackagesToRemove()) {
if (modifiedContextModel.containsIndividual(p) || modifiedContextModel.containsIndividualByLabel(p)) {
try {
OWLNamedIndividual indiv = modifiedContextModel.getIndividualByUnqualifiedName(p, true);
List<OWLNamedIndividual> affectedIndivs = modifiedContextModel.removeAllObjectProperties(indiv, IRI_HAS_DEPENDENCY.toString());
if (indiv.getObjectPropertyValues(modifiedContextModel.getOntology()).size() == 0) {
modifiedContextModel.removeIndividual(indiv.getIRI().toString());
}
for (OWLNamedIndividual affectedIndiv : affectedIndivs) {
if (affectedIndiv.getObjectPropertyValues(modifiedContextModel.getOntology()).size() == 0) {
modifiedContextModel.removeIndividual(affectedIndiv.getIRI().toString());
}
}
// TODO: add changes entry?
} catch (OwlElementNotFoundException e) {
LOG.error("Individual not found: " + p);
}
}
}
}
}