Open Source Projects Europe

/**

 * 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 net.timbusproject.dpes.alternative.PreservationAlternative;

import net.timbusproject.dpes.alternative.Risk;

import org.sba_research.timbus.kb.FormatMigrationOption;

import org.sba_research.timbus.kb.ToolKnowledgeBase;

import org.sbaresearch.owl.AlternativesBuilder;

import org.sbaresearch.owl.JenaQueryFacade;

import org.sbaresearch.owl.OwlApiFacade;

import org.sbaresearch.owl.OwlElementNotFoundException;

import org.semanticweb.owlapi.apibinding.OWLManager;

import org.semanticweb.owlapi.model.*;

import java.io.IOException;

import java.util.ArrayList;

import java.util.List;

/**

 * Creates alternative ontologies where files at risk are replaced.

 */

public class FileAlternativesBuilder implements PreservationAlternativesBuilder {

    public static final IRI IRI_FILE = IRI.create("http://id.loc.gov/ontologies/premis.rdf#File");

    public static final IRI IRI_FORMAT_PROPERTY = IRI.create("http://id.loc.gov/ontologies/premis.rdf#Format");

    public static final IRI IRI_FORMAT_REGISTRY = IRI.create("http://id.loc.gov/ontologies/premis.rdf#FormatRegistry");

    public static final IRI IRI_FORMAT_REGISTRY_PROPERTY = IRI.create("http://id.loc.gov/ontologies/premis.rdf#FormatRegistry");

    public static final IRI IRI_FORMAT_REGISTRY_KEY_PROPERTY = IRI.create("http://www.loc.gov/premis/rdf/v1#hasFormatRegistryKey");

    public static final IRI IRI_FORMAT_REGISTRY_NAME_PROPERTY = IRI.create("http://www.loc.gov/premis/rdf/v1#hasFormatRegistryName");

    public static final IRI IRI_OBJECT_CHARACTERISTICS_PROPERTY = IRI.create("http://multimedialab.elis.ugent.be/users/samcoppe/ontologies/Premis/premis.owl#objectCharacteristics");

    public static final IRI IRI_OBJECT_CHARACTERISTICS = IRI.create("http://www.loc.gov/premis/rdf/v1#ObjectCharacteristics");

    private final ToolKnowledgeBase knowledgeBase;

    private final String baseURL;

    private final OwlApiFacade originalModelFacade;

    private final String identifier;

    public FileAlternativesBuilder(ToolKnowledgeBase knowledgeBase, String baseURL, OwlApiFacade originalModelFacade, String identifier) {

        this.knowledgeBase = knowledgeBase;

        this.baseURL = baseURL;

        this.originalModelFacade = originalModelFacade;

        this.identifier = identifier;

    }

    public List<PreservationAlternative> createAlternatives(Risk identifiedRisk, IRI individualAtRisk) throws OWLOntologyCreationException, OWLOntologyStorageException, IOException, OwlElementNotFoundException {

        System.out.println("Searching for file alternatives...");

        List<PreservationAlternative> alternatives = new ArrayList<>();

        List<FormatMigrationOption> alternativeFormats = getAlternativeFormats(originalModelFacade, individualAtRisk);

        AlternativesBuilder alternativesBuilder = new AlternativesBuilder(originalModelFacade);

        ChangesOntologyBuilder changesOntologyBuilder = new ChangesOntologyBuilder(originalModelFacade.getOntology(), originalModelFacade.getIndividual(individualAtRisk.toString()),  "FileReplacement");

        for (int i = 0; i < alternativeFormats.size(); ++i) {

            String formatName = alternativeFormats.get(i).getFormat();

            String toolName = alternativeFormats.get(i).getTool();

            System.out.println(String.format("Replacing %s with %s using %s.", individualAtRisk, formatName, toolName));

            String alternativeOntologyIri = createIriFragment(baseURL, identifier, identifiedRisk, i);

            OwlApiFacade modifiedModel = new OwlApiFacade(alternativesBuilder.copyOntology(IRI.create(alternativeOntologyIri, originalModelFacade.getOntology().getOntologyID().getOntologyIRI().getFragment())));

            OWLNamedIndividual individual = modifiedModel.addIndividual(formatName + "_file", IRI_FILE.toString());

            OWLNamedIndividual objectCharacteristics = modifiedModel.addIndividual(formatName + "Characteristics", IRI_OBJECT_CHARACTERISTICS.toString());

            modifiedModel.addObjectProperty(individual, IRI_OBJECT_CHARACTERISTICS_PROPERTY.toString(), objectCharacteristics);

            OWLNamedIndividual format = modifiedModel.addIndividual(formatName + "Format");

            modifiedModel.addObjectProperty(objectCharacteristics, IRI_FORMAT_PROPERTY.toString(), format);

            OWLNamedIndividual formatRegistry = modifiedModel.addIndividual(formatName + "FormatRegistry", IRI_FORMAT_REGISTRY.toString());

            modifiedModel.addObjectProperty(format, IRI_FORMAT_REGISTRY_PROPERTY.toString(), formatRegistry);

            modifiedModel.addDataProperty(formatRegistry, IRI_FORMAT_REGISTRY_NAME_PROPERTY.toString(), OWLManager.getOWLDataFactory().getOWLLiteral("http://www.nationalarchives.gov.uk/PRONOM/"));

            List<String> pronom_ids = knowledgeBase.getFormatIDs(formatName);

            for (String pronom_id : pronom_ids) {

                modifiedModel.addDataProperty(formatRegistry, IRI_FORMAT_REGISTRY_KEY_PROPERTY.toString(), OWLManager.getOWLDataFactory().getOWLLiteral(pronom_id));

            }

            if (pronom_ids.isEmpty()) {

                modifiedModel.addDataProperty(formatRegistry, IRI_FORMAT_REGISTRY_KEY_PROPERTY.toString(), OWLManager.getOWLDataFactory().getOWLLiteral("fmt/null"));

            }

            // TODO: copy relations

            // TODO: remove original individual

            // TODO: add converting tool to the changes ontology!

            OWLOntology eventsOntology = changesOntologyBuilder.createChangesOntology(identifier + "/" + i, modifiedModel.getOntology(), individual);

            alternatives.add(new PreservationAlternative(

                    originalModelFacade.toOwlXml(), modifiedModel.toOwlXml(),

                    OwlApiFacade.toOwlXml(eventsOntology), identifiedRisk.getRiskIdentifier(), new ArrayList<String>()));

        }

        // TODO: avoid duplicate filecharacteristics and registries somehow

        return alternatives;

    }

    private List<FormatMigrationOption> getAlternativeFormats(OwlApiFacade originalModelFacade, IRI fileAtRisk) throws OWLOntologyStorageException, OWLOntologyCreationException, IOException {

        JenaQueryFacade queryFacade = new JenaQueryFacade(originalModelFacade.getJenaModel(false));

        List<String> pronomIDs = JenaQueryFacade.extractColumn(queryFacade.query(QueryHelper.getQueryGetFormatID(fileAtRisk.toString())), "pronom_id");

        List<FormatMigrationOption> alternativeTools = knowledgeBase.getConvertToMigrationOptions(pronomIDs.get(0)); // TODO: also get ConvertFromMigrationOptions!

        System.out.println("Alternative options found: " + alternativeTools);

        return alternativeTools;

    }

    private String createIriFragment(String baseURL, String identifier, Risk identifiedRisk, int count) {

        return baseURL + "/" + identifier + "/" + identifiedRisk.getRiskIdentifier() + "/" + count + "/";

    }

}