org.spdx.compare.SpdxSnippetComparer Maven / Gradle / Ivy
/**
* Copyright (c) 2016 Source Auditor Inc.
*
* 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.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.spdx.compare;
import java.util.Iterator;
import java.util.Map;
import java.util.Map.Entry;
import org.spdx.rdfparser.InvalidSPDXAnalysisException;
import org.spdx.rdfparser.model.SpdxDocument;
import org.spdx.rdfparser.model.SpdxFile;
import org.spdx.rdfparser.model.SpdxItem;
import org.spdx.rdfparser.model.SpdxSnippet;
import com.google.common.base.Objects;
import com.google.common.collect.Maps;
/**
* Compares two SPDX snippets. The compare(snippetA, snippetB) method will perform the comparison and
* store the results. isDifferenceFound() will return true of any
* differences were found.
* @author Gary O'Neall
*
*/
public class SpdxSnippetComparer extends SpdxItemComparer {
private boolean inProgress = false;
private boolean differenceFound = false;
private boolean byteRangeEquals = true;
private boolean lineRangeEquals = true;
private boolean snippetFromFilesEquals = true;
private boolean nameEquals = true;
/**
* Map of any difference between snippet from files where the file names are equal
*/
Map> snippetFromFileDifferences = Maps.newHashMap();
/**
* Map of snippetFromFiles where the file names are different (and therefore considered a unique file)
*/
Map> uniqueSnippetFromFile = Maps.newHashMap();
/**
* @param extractedLicenseIdMap map of all extracted license IDs for any SPDX documents to be added to the comparer
*/
public SpdxSnippetComparer(Map>> extractedLicenseIdMap) {
super(extractedLicenseIdMap);
}
/**
* Add a snippet to the comparer and performs the comparison to any existing documents
* @param spdxDocument document containing the package
* @param snippet snippet to be added
* @param licenseXlationMap A mapping between the license IDs from licenses in fileA to fileB
* @throws SpdxCompareException
* @param spdxDocument
* @param snippet
*/
public void addDocumentSnippet(SpdxDocument spdxDocument,
SpdxSnippet snippet) throws SpdxCompareException {
checkInProgress();
if (this.name == null) {
this.name = snippet.toString();
}
inProgress = true;
Iterator> iter = this.documentItem.entrySet().iterator();
SpdxSnippet snippet2 = null;
SpdxDocument document2 = null;
while (iter.hasNext() && snippet2 == null) {
Entry entry = iter.next();
if (entry.getValue() instanceof SpdxSnippet) {
snippet2 = (SpdxSnippet)entry.getValue();
document2 = entry.getKey();
}
}
if (snippet2 != null) {
try {
if (!snippet2.equivalentConsideringNull(snippet2.getByteRange(), snippet.getByteRange())) {
this.byteRangeEquals = false;
this.differenceFound = true;
}
} catch (InvalidSPDXAnalysisException e) {
throw(new SpdxCompareException("SPDX error getting byte range: "+e.getMessage()));
}
try {
if (!snippet2.equivalentConsideringNull(snippet2.getLineRange(), snippet.getLineRange())) {
this.lineRangeEquals = false;
this.differenceFound = true;
}
} catch (InvalidSPDXAnalysisException e) {
throw(new SpdxCompareException("SPDX error getting line range: "+e.getMessage()));
}
try {
SpdxFile fromFile = snippet.getSnippetFromFile();
SpdxFile fromFile2 = snippet2.getSnippetFromFile();
compareSnippetFromFiles(spdxDocument, fromFile, document2, fromFile2);
} catch (InvalidSPDXAnalysisException e) {
throw(new SpdxCompareException("SPDX error getting snippet from file: "+e.getMessage()));
}
if (!SpdxComparer.stringsEqual(snippet2.getName(), snippet.getName())) {
this.nameEquals = false;
this.differenceFound = true;
}
}
inProgress = false;
super.addDocumentItem(spdxDocument, snippet);
}
/**
* Compares the snippetFromFiles and updates the properties isSnippetFromFilesEquals,
* uniqueSnippetFromFiles, and snippetFromFilesDifferences
* @param fromFile
* @param fromFile2
* @throws SpdxCompareException
*/
private void compareSnippetFromFiles(SpdxDocument spdxDocument, SpdxFile fromFile,
SpdxDocument document2, SpdxFile fromFile2) throws SpdxCompareException {
if (fromFile == null) {
if (fromFile2 != null) {
Map unique = this.uniqueSnippetFromFile.get(document2);
if (unique == null) {
unique = Maps.newHashMap();
this.uniqueSnippetFromFile.put(document2, unique);
}
unique.put(spdxDocument, fromFile2);
this.snippetFromFilesEquals = false;
}
} else if (fromFile2 == null) {
Map unique = this.uniqueSnippetFromFile.get(spdxDocument);
if (unique == null) {
unique = Maps.newHashMap();
this.uniqueSnippetFromFile.put(spdxDocument, unique);
}
unique.put(document2, fromFile);
this.snippetFromFilesEquals = false;
} else if (!Objects.equal(fromFile2.getName(), fromFile.getName())) {
Map unique = this.uniqueSnippetFromFile.get(spdxDocument);
if (unique == null) {
unique = Maps.newHashMap();
this.uniqueSnippetFromFile.put(spdxDocument, unique);
}
unique.put(document2, fromFile);
Map unique2 = this.uniqueSnippetFromFile.get(document2);
if (unique2 == null) {
unique2 = Maps.newHashMap();
this.uniqueSnippetFromFile.put(document2, unique2);
}
unique2.put(spdxDocument, fromFile2);
this.snippetFromFilesEquals = false;
} else {
SpdxFileComparer fileCompare = new SpdxFileComparer(this.extractedLicenseIdMap);
fileCompare.addDocumentFile(spdxDocument, fromFile);
fileCompare.addDocumentFile(document2, fromFile2);
if (fileCompare.isDifferenceFound()) {
this.snippetFromFilesEquals = false;
Map comparerMap = Maps.newHashMap();
this.snippetFromFileDifferences.put(spdxDocument, comparerMap);
Map comparerMap2 = this.snippetFromFileDifferences.get(document2);
if (comparerMap2 == null) {
comparerMap2 = Maps.newHashMap();
this.snippetFromFileDifferences.put(document2, comparerMap2);
}
comparerMap.put(document2, fileCompare.getFileDifference(spdxDocument, document2));
comparerMap2.put(spdxDocument, fileCompare.getFileDifference(document2, spdxDocument));
}
}
if (!this.snippetFromFilesEquals) {
this.differenceFound = true;
}
}
/**
* @return the differenceFound
* @throws SpdxCompareException
*/
@Override
public boolean isDifferenceFound() throws SpdxCompareException {
checkInProgress();
return differenceFound || super.isDifferenceFound();
}
/**
* checks to make sure there is not a compare in progress
* @throws SpdxCompareException
*
*/
@Override
protected void checkInProgress() throws SpdxCompareException {
if (inProgress) {
throw(new SpdxCompareException("File compare in progress - can not obtain compare results until compare has completed"));
}
super.checkInProgress();
}
/**
* Get any file difference for the Spdx Snippet From File between the two SPDX documents
* If the fileName is different, the they are considered unique files and the getUniqueSnippetFromFile should be called
* to obtain the unique file
* @param docA
* @param docB
* @return the file difference or null if there is no file difference
*/
public SpdxFileDifference getSnippetFromFileDifference(SpdxDocument docA,
SpdxDocument docB) throws SpdxCompareException {
checkInProgress();
Map differenceMap = this.snippetFromFileDifferences.get(docA);
if (differenceMap == null) {
return null;
}
return differenceMap.get(docB);
}
/**
* @return the byteRangeEquals
*/
public boolean isByteRangeEquals() throws SpdxCompareException {
checkInProgress();
return byteRangeEquals;
}
/**
* @return the lineRangeEquals
*/
public boolean isLineRangeEquals() throws SpdxCompareException {
checkInProgress();
return lineRangeEquals;
}
/**
* The snippetFromFiles can be true if there are some unique snippetFromFiles or differences between the snippetFromFiles (or both)
* @return the snippetFromFilesEquals
*/
public boolean isSnippetFromFilesEquals() throws SpdxCompareException {
checkInProgress();
return snippetFromFilesEquals;
}
/**
* @return the nameEquals
*/
public boolean isNameEquals() throws SpdxCompareException {
checkInProgress();
return nameEquals;
}
/**
* Get an SpdxFile that only exists in docA but not docB
* @param docA
* @param docB
* @return
*/
public SpdxFile getUniqueSnippetFromFile(SpdxDocument docA, SpdxDocument docB) throws SpdxCompareException {
checkInProgress();
Map docMap = this.uniqueSnippetFromFile.get(docA);
if (docMap == null) {
return null;
}
return docMap.get(docB);
}
/**
* @return Total number of snippets
*/
public int getNumSnippets() {
return this.documentItem.size();
}
/**
* @param spdxDocument
* @return
*/
public SpdxSnippet getDocSnippet(SpdxDocument spdxDocument) {
SpdxItem retItem = this.documentItem.get(spdxDocument);
if (retItem != null && retItem instanceof SpdxSnippet) {
return (SpdxSnippet)retItem;
} else {
return null;
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy