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) 2011 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.tag;
import java.net.URI;
import java.net.URISyntaxException;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Arrays;
import java.util.Date;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Properties;
import java.util.Set;
import java.util.UUID;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.spdx.rdfparser.InvalidSPDXAnalysisException;
import org.spdx.rdfparser.SPDXCreatorInformation;
import org.spdx.rdfparser.SPDXReview;
import org.spdx.rdfparser.SpdxDocumentContainer;
import org.spdx.rdfparser.SpdxPackageVerificationCode;
import org.spdx.rdfparser.SpdxRdfConstants;
import org.spdx.rdfparser.license.AnyLicenseInfo;
import org.spdx.rdfparser.license.ExtractedLicenseInfo;
import org.spdx.rdfparser.license.LicenseInfoFactory;
import org.spdx.rdfparser.model.Annotation;
import org.spdx.rdfparser.model.Annotation.AnnotationType;
import org.spdx.rdfparser.model.Checksum;
import org.spdx.rdfparser.model.Checksum.ChecksumAlgorithm;
import org.spdx.rdfparser.model.DoapProject;
import org.spdx.rdfparser.model.ExternalDocumentRef;
import org.spdx.rdfparser.model.ExternalRef;
import org.spdx.rdfparser.model.ExternalRef.ReferenceCategory;
import org.spdx.rdfparser.model.Relationship;
import org.spdx.rdfparser.model.Relationship.RelationshipType;
import org.spdx.rdfparser.model.SpdxDocument;
import org.spdx.rdfparser.model.SpdxElement;
import org.spdx.rdfparser.model.SpdxFile;
import org.spdx.rdfparser.model.SpdxFile.FileType;
import org.spdx.rdfparser.model.SpdxItem;
import org.spdx.rdfparser.model.SpdxNoAssertionElement;
import org.spdx.rdfparser.model.SpdxNoneElement;
import org.spdx.rdfparser.model.SpdxPackage;
import org.spdx.rdfparser.model.SpdxSnippet;
import org.spdx.rdfparser.model.pointer.ByteOffsetPointer;
import org.spdx.rdfparser.model.pointer.LineCharPointer;
import org.spdx.rdfparser.model.pointer.StartEndPointer;
import org.spdx.rdfparser.referencetype.ListedReferenceTypes;
import org.spdx.rdfparser.referencetype.ReferenceType;
import org.spdx.spdxspreadsheet.InvalidLicenseStringException;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
/**
* Translates an tag-value file to a an SPDX Document.
*
* Supports SPDX version 2.0
*
* 2.0 changes made by Gary O'Neall
*
* @author Rana Rahal, Protecode Inc.
*/
public class BuildDocument implements TagValueBehavior {
private static class AnnotationWithId {
private Annotation annotation;
private String id;
private int lineNumber;
private AnnotationWithId(String annotator, int lineNumber) {
this.annotation = new Annotation(annotator, null, null, null);
this.lineNumber = lineNumber;
}
@SuppressWarnings("unused")
public void setAnnotator(String annotator) {
annotation.setAnnotator(annotator);
}
public void setDate(String date) throws InvalidSPDXAnalysisException {
annotation.setAnnotationDate(date);
}
public void setAnnotationType(AnnotationType annotationType) throws InvalidSPDXAnalysisException {
annotation.setAnnotationType(annotationType);
}
public void setComment(String comment) {
annotation.setComment(comment);
}
public void setId(String id) {
this.id = id;
}
public String getId() {
return this.id;
}
public Annotation getAnnotation() {
return this.annotation;
}
public int getLineNumber() {
return lineNumber;
}
}
private static class RelationshipWithId {
private String id;
private String relatedId;
private RelationshipType relationshipType;
private String comment;
private int lineNumber;
public RelationshipWithId(String id, String relatedId,
RelationshipType relationshipType, int lineNumber) {
this.id = id;
this.relatedId = relatedId;
this.relationshipType = relationshipType;
this.lineNumber = lineNumber;
}
public void setComment(String comment) {
this.comment = comment;
}
public String getId() {
return id;
}
public String getRelatedId() {
return relatedId;
}
public RelationshipType getRelationshipType() {
return relationshipType;
}
public String getComment() {
return comment;
}
public int getLineNumber() {
return lineNumber;
}
}
private static Pattern EXTERNAL_DOC_REF_PATTERN = Pattern.compile("(\\S+)\\s+(\\S+)\\s+SHA1:\\s+(\\S+)");
private static Pattern RELATIONSHIP_PATTERN = Pattern.compile("(\\S+)\\s+(\\S+)\\s+(\\S+)");
public static Pattern CHECKSUM_PATTERN = Pattern.compile("(\\S+)\\s+(\\S+)");
private static Pattern NUMBER_RANGE_PATTERN = Pattern.compile("(\\d+):(\\d+)");
private static Pattern EXTERNAL_REF_PATTERN = Pattern.compile("([^ ]+) ([^ ]+) (.+)");
/**
* Tags used in the definition of an annotation
*/
private Set ANNOTATION_TAGS = Sets.newHashSet();
/**
* Tags used in the definition of a file
*/
private Set FILE_TAGS = Sets.newHashSet();
/**
* Tags used in the definition of a Snippet
*/
private Set SNIPPET_TAGS = Sets.newHashSet();
/**
* Tags used in the definition of a package
*/
/**
* Tags used in the definition of an extracted license
*/
private Set EXTRACTED_LICENSE_TAGS = Sets.newHashSet();
private Set PACKAGE_TAGS = Sets.newHashSet();
private Properties constants;
private SpdxDocument analysis;
private DateFormat format = new SimpleDateFormat(SpdxRdfConstants.SPDX_DATE_FORMAT);
//When we retrieve a list from the SpdxDocument the order changes, therefore keep track of
//the last object that we are looking at so that we can fill in all of it's information
private SPDXReview lastReviewer = null;
private int lastReviewerLineNumber = 0;
private ExtractedLicenseInfo lastExtractedLicense = null;
private int lastExtractedLicenseLineNumber = 0;
private SpdxFile lastFile = null;
private int lastFileLineNumber = 0;
private SpdxSnippet lastSnippet = null;
private int lastSnippetLineNumber = 0;
private DoapProject lastProject = null;
private int lastProjectLineNumber = 0;
private Map elementIdLineNumberMap = Maps.newHashMap();
// Keep track of all file dependencies since these need to be added after all of the files
// have been parsed. Map of file dependency file name to the SPDX files which depends on it
private Map> fileDependencyMap = Maps.newHashMap();
/**
* Map of all snippetFileID's collected during parsing so that we can add the files
* at the end of the document creation once the files are actually created
*/
private Map> snippetDependencyMap = Maps.newHashMap();
/**
* Keep track of the last relationship for any following relationship related tags
*/
private RelationshipWithId lastRelationship = null;
/**
* Keep track of all relationships and add them at the end of the parsing
*/
private List relationships = Lists.newArrayList();
/**
* Keep track of the last annotation for any following annotation related tags
*/
private AnnotationWithId lastAnnotation;
/**
* Keep track of all annotations and add them at the end of the parsing
*/
private List annotations = Lists.newArrayList();
private SpdxDocumentContainer[] result = null;
private String specVersion;
private AnyLicenseInfo dataLicense;
private String documentName;
List warningMessages;
/**
* True if we have started defining a package in the tag/value file
*/
private boolean inPackageDefinition = false;
/**
* True if we have started to define a file AT THE DOCUMENT LEVEL
* in the tag/value file. Note that files defined as part of a package
* will have the state flag inPackageDefinition set, and inFileDefinition will be false.
*/
private boolean inFileDefinition = false;
/**
* true if we have started to define a Snippet
*/
private boolean inSnippetDefinition = false;;
/**
* True if we have started to define an annotation
* in the tag/value file.
*/
private boolean inAnnotation = false;
/**
* True if we are building an extracted license definition
*/
private boolean inExtractedLicenseDefinition = false;
/**
* The last (or current) package being defined by the tag/value file
*/
private SpdxPackage lastPackage = null;
private int lastPackageLineNumber = 0;
/**
* The last external reference found
*/
private ExternalRef lastExternalRef = null;
public BuildDocument(SpdxDocumentContainer[] result, Properties constants, List warnings) {
this.constants = constants;
this.warningMessages = warnings;
this.result = result;
this.ANNOTATION_TAGS.add(constants.getProperty("PROP_ANNOTATION_DATE").trim()+" ");
this.ANNOTATION_TAGS.add(constants.getProperty("PROP_ANNOTATION_COMMENT").trim()+" ");
this.ANNOTATION_TAGS.add(constants.getProperty("PROP_ANNOTATION_ID").trim()+" ");
this.ANNOTATION_TAGS.add(constants.getProperty("PROP_ANNOTATION_TYPE").trim()+" ");
this.FILE_TAGS.add(constants.getProperty("PROP_FILE_TYPE").trim()+" ");
this.FILE_TAGS.add(constants.getProperty("PROP_FILE_LICENSE").trim()+" ");
this.FILE_TAGS.add(constants.getProperty("PROP_FILE_COPYRIGHT").trim()+" ");
this.FILE_TAGS.add(constants.getProperty("PROP_FILE_CHECKSUM").trim()+" ");
this.FILE_TAGS.add(constants.getProperty("PROP_FILE_SEEN_LICENSE").trim()+" ");
this.FILE_TAGS.add(constants.getProperty("PROP_FILE_LIC_COMMENTS").trim()+" ");
this.FILE_TAGS.add(constants.getProperty("PROP_FILE_COMMENT").trim()+" ");
this.FILE_TAGS.add(constants.getProperty("PROP_FILE_DEPENDENCY").trim()+" ");
this.FILE_TAGS.add(constants.getProperty("PROP_FILE_CONTRIBUTOR").trim()+" ");
this.FILE_TAGS.add(constants.getProperty("PROP_FILE_NOTICE_TEXT").trim()+" ");
this.FILE_TAGS.add(constants.getProperty("PROP_ELEMENT_ID").trim()+" ");
this.FILE_TAGS.add(constants.getProperty("PROP_PROJECT_NAME").trim()+" ");
this.FILE_TAGS.add(constants.getProperty("PROP_PROJECT_HOMEPAGE").trim()+" ");
this.FILE_TAGS.add(constants.getProperty("PROP_PROJECT_URI").trim()+" ");
this.FILE_TAGS.add(constants.getProperty("PROP_DOCUMENT_NAMESPACE").trim()+" ");
this.FILE_TAGS.add(constants.getProperty("PROP_RELATIONSHIP").trim()+" ");
this.FILE_TAGS.add(constants.getProperty("PROP_RELATIONSHIP_COMMENT").trim()+" ");
this.FILE_TAGS.add(constants.getProperty("PROP_ANNOTATOR").trim()+" ");
this.FILE_TAGS.add(constants.getProperty("PROP_ANNOTATION_DATE").trim()+" ");
this.FILE_TAGS.add(constants.getProperty("PROP_ANNOTATION_COMMENT").trim()+" ");
this.FILE_TAGS.add(constants.getProperty("PROP_ANNOTATION_ID").trim()+" ");
this.FILE_TAGS.add(constants.getProperty("PROP_ANNOTATION_TYPE").trim()+" ");
this.FILE_TAGS.add(constants.getProperty("PROP_FILE_ATTRIBUTION_TEXT").trim()+" ");
this.SNIPPET_TAGS.add(constants.getProperty("PROP_SNIPPET_SPDX_ID").trim()+" ");
this.SNIPPET_TAGS.add(constants.getProperty("PROP_SNIPPET_FROM_FILE_ID").trim()+" ");
this.SNIPPET_TAGS.add(constants.getProperty("PROP_SNIPPET_BYTE_RANGE").trim()+" ");
this.SNIPPET_TAGS.add(constants.getProperty("PROP_SNIPPET_LINE_RANGE").trim()+" ");
this.SNIPPET_TAGS.add(constants.getProperty("PROP_SNIPPET_CONCLUDED_LICENSE").trim()+" ");
this.SNIPPET_TAGS.add(constants.getProperty("PROP_SNIPPET_LIC_COMMENTS").trim()+" ");
this.SNIPPET_TAGS.add(constants.getProperty("PROP_SNIPPET_COPYRIGHT").trim()+" ");
this.SNIPPET_TAGS.add(constants.getProperty("PROP_SNIPPET_COMMENT").trim()+" ");
this.SNIPPET_TAGS.add(constants.getProperty("PROP_SNIPPET_NAME").trim()+" ");
this.SNIPPET_TAGS.add(constants.getProperty("PROP_SNIPPET_SEEN_LICENSE").trim()+" ");
this.SNIPPET_TAGS.add(constants.getProperty("PROP_DOCUMENT_NAMESPACE").trim()+" ");
this.SNIPPET_TAGS.add(constants.getProperty("PROP_RELATIONSHIP").trim()+" ");
this.SNIPPET_TAGS.add(constants.getProperty("PROP_RELATIONSHIP_COMMENT").trim()+" ");
this.SNIPPET_TAGS.add(constants.getProperty("PROP_ANNOTATOR").trim()+" ");
this.SNIPPET_TAGS.add(constants.getProperty("PROP_ANNOTATION_DATE").trim()+" ");
this.SNIPPET_TAGS.add(constants.getProperty("PROP_ANNOTATION_COMMENT").trim()+" ");
this.SNIPPET_TAGS.add(constants.getProperty("PROP_ANNOTATION_ID").trim()+" ");
this.SNIPPET_TAGS.add(constants.getProperty("PROP_ANNOTATION_TYPE").trim()+" ");
this.PACKAGE_TAGS.add(constants.getProperty("PROP_PACKAGE_COMMENT").trim()+" ");
this.PACKAGE_TAGS.add(constants.getProperty("PROP_PACKAGE_FILE_NAME").trim()+" ");
this.PACKAGE_TAGS.add(constants.getProperty("PROP_PACKAGE_CHECKSUM").trim()+" ");
this.PACKAGE_TAGS.add(constants.getProperty("PROP_PACKAGE_DOWNLOAD_URL").trim()+" ");
this.PACKAGE_TAGS.add(constants.getProperty("PROP_PACKAGE_SOURCE_INFO").trim()+" ");
this.PACKAGE_TAGS.add(constants.getProperty("PROP_PACKAGE_DECLARED_LICENSE").trim()+" ");
this.PACKAGE_TAGS.add(constants.getProperty("PROP_PACKAGE_CONCLUDED_LICENSE").trim()+" ");
this.PACKAGE_TAGS.add(constants.getProperty("PROP_PACKAGE_DECLARED_COPYRIGHT").trim()+" ");
this.PACKAGE_TAGS.add(constants.getProperty("PROP_PACKAGE_SHORT_DESC").trim()+" ");
this.PACKAGE_TAGS.add(constants.getProperty("PROP_PACKAGE_DESCRIPTION").trim()+" ");
this.PACKAGE_TAGS.add(constants.getProperty("PROP_PACKAGE_VERIFICATION_CODE").trim()+" ");
this.PACKAGE_TAGS.add(constants.getProperty("PROP_PACKAGE_LICENSE_INFO_FROM_FILES").trim()+" ");
this.PACKAGE_TAGS.add(constants.getProperty("PROP_PACKAGE_LICENSE_COMMENT").trim()+" ");
this.PACKAGE_TAGS.add(constants.getProperty("PROP_PACKAGE_VERSION_INFO").trim()+" ");
this.PACKAGE_TAGS.add(constants.getProperty("PROP_PACKAGE_ORIGINATOR").trim()+" ");
this.PACKAGE_TAGS.add(constants.getProperty("PROP_PACKAGE_SUPPLIER").trim()+" ");
this.PACKAGE_TAGS.add(constants.getProperty("PROP_PACKAGE_HOMEPAGE_URL").trim()+" ");
this.PACKAGE_TAGS.add(constants.getProperty("PROP_ELEMENT_ID").trim()+" ");
this.PACKAGE_TAGS.add(constants.getProperty("PROP_FILE_NAME").trim()+" ");
this.PACKAGE_TAGS.add(constants.getProperty("PROP_RELATIONSHIP").trim()+" ");
this.PACKAGE_TAGS.add(constants.getProperty("PROP_RELATIONSHIP_COMMENT").trim()+" ");
this.PACKAGE_TAGS.add(constants.getProperty("PROP_ANNOTATOR").trim()+" ");
this.PACKAGE_TAGS.add(constants.getProperty("PROP_ANNOTATION_DATE").trim()+" ");
this.PACKAGE_TAGS.add(constants.getProperty("PROP_ANNOTATION_COMMENT").trim()+" ");
this.PACKAGE_TAGS.add(constants.getProperty("PROP_ANNOTATION_ID").trim()+" ");
this.PACKAGE_TAGS.add(constants.getProperty("PROP_ANNOTATION_TYPE").trim()+" ");
this.PACKAGE_TAGS.add(constants.getProperty("PROP_EXTERNAL_REFERENCE").trim()+" ");
this.PACKAGE_TAGS.add(constants.getProperty("PROP_EXTERNAL_REFERENCE_COMMENT").trim()+" ");
this.PACKAGE_TAGS.add(constants.getProperty("PROP_PACKAGE_FILES_ANALYZED").trim()+" ");
this.PACKAGE_TAGS.add(constants.getProperty("PROP_PACKAGE_ATTRIBUTION_TEXT").trim()+" ");
this.EXTRACTED_LICENSE_TAGS.add(constants.getProperty("PROP_LICENSE_TEXT").trim()+" ");
this.EXTRACTED_LICENSE_TAGS.add(constants.getProperty("PROP_EXTRACTED_TEXT").trim()+" ");
this.EXTRACTED_LICENSE_TAGS.add(constants.getProperty("PROP_LICENSE_COMMENT").trim()+" ");
this.EXTRACTED_LICENSE_TAGS.add(constants.getProperty("PROP_LICENSE_NAME").trim()+" ");
this.EXTRACTED_LICENSE_TAGS.add(constants.getProperty("PROP_SOURCE_URLS").trim()+" ");
}
@Override
public void enter() throws Exception {
// do nothing???
}
@Override
public void buildDocument(String tag, String value, int lineNumber) throws Exception {
tag = tag.trim()+" ";
value = trim(value.trim());
if (this.inAnnotation && ANNOTATION_TAGS.contains(tag)) {
buildAnnotation(tag, value, lastAnnotation);
} else if (this.inFileDefinition && FILE_TAGS.contains(tag)) {
buildFile(this.lastFile, tag, value, lineNumber);
} else if (this.inSnippetDefinition && SNIPPET_TAGS.contains(tag)) {
buildSnippet(this.lastSnippet, tag, value, lineNumber);
} else if (this.inPackageDefinition && PACKAGE_TAGS.contains(tag)) {
buildPackage(this.lastPackage, tag, value, lineNumber);
} else if (this.inExtractedLicenseDefinition && EXTRACTED_LICENSE_TAGS.contains(tag)) {
buildExtractedLicense(this.lastExtractedLicense, tag, value, lineNumber);
} else {
if (inExtractedLicenseDefinition && lastExtractedLicense != null) {
verifyElement(lastExtractedLicense.verify(), "Extracted License", lastExtractedLicenseLineNumber, false);
}
if (inFileDefinition) {
addLastFile();
}
if (inSnippetDefinition) {
addLastSnippet();
}
inAnnotation = false;
inFileDefinition = false;
inPackageDefinition = false;
inSnippetDefinition = false;
buildDocumentProperties(tag, value, lineNumber);
}
}
/**
* Add tag value properties to an existing snippet
* @param snippet
* @param tag
* @param value
* @param lineNumber
* @throws InvalidSpdxTagFileException
* @throws InvalidSPDXAnalysisException
* @throws InvalidLicenseStringException
*/
private void buildSnippet(SpdxSnippet snippet, String tag, String value, int lineNumber) throws InvalidSpdxTagFileException, InvalidSPDXAnalysisException, InvalidLicenseStringException {
if (snippet == null) {
throw(new InvalidSpdxTagFileException("Missing Snippet ID - An SPDX Snippet ID must be specified before the snippet properties"));
} else if (tag.equals(constants.getProperty("PROP_SNIPPET_SPDX_ID"))) {
snippet.setId(value);
elementIdLineNumberMap.put(value, lineNumber);
} else if (tag.equals(constants.getProperty("PROP_SNIPPET_FROM_FILE_ID"))) {
// Since the files have not all been parsed, we just keep track of the
// dependencies in a hashmap until we finish all processing and are building the package
List snippetsWithThisAsADependency = this.snippetDependencyMap.get(value);
if (snippetsWithThisAsADependency == null) {
snippetsWithThisAsADependency = Lists.newArrayList();
this.snippetDependencyMap.put(value, snippetsWithThisAsADependency);
}
snippetsWithThisAsADependency.add(snippet);
} else if (tag.equals(constants.getProperty("PROP_SNIPPET_BYTE_RANGE"))) {
snippet.setByteRange(parseByteRange(value, lineNumber));
} else if (tag.equals(constants.getProperty("PROP_SNIPPET_LINE_RANGE"))) {
snippet.setLineRange(parseLineRange(value, lineNumber));
} else if (tag.equals(constants.getProperty("PROP_SNIPPET_CONCLUDED_LICENSE"))) {
snippet.setLicenseConcluded(LicenseInfoFactory.parseSPDXLicenseString(value, this.analysis.getDocumentContainer()));
// can not verify any licenses at this point since the extracted license infos may not be set
} else if (tag.equals(constants.getProperty("PROP_SNIPPET_LIC_COMMENTS"))) {
snippet.setLicenseComments(value);
} else if (tag.equals(constants.getProperty("PROP_SNIPPET_COPYRIGHT"))) {
snippet.setCopyrightText(value);
} else if (tag.equals(constants.getProperty("PROP_SNIPPET_COMMENT"))) {
snippet.setComment(value);
} else if (tag.equals(constants.getProperty("PROP_SNIPPET_NAME"))) {
snippet.setName(value);
} else if (tag.equals(constants.getProperty("PROP_SNIPPET_SEEN_LICENSE"))) {
snippet.setLicenseInfosFromFiles(new AnyLicenseInfo[] {LicenseInfoFactory.parseSPDXLicenseString(value, this.analysis.getDocumentContainer())});
// can not verify any licenses at this point since the extracted license infos may not be set
} else if (tag.equals(constants.getProperty("PROP_ANNOTATOR"))) {
if (lastAnnotation != null) {
annotations.add(lastAnnotation);
}
this.inAnnotation = true;
lastAnnotation = new AnnotationWithId(value, lineNumber);
} else if (tag.equals(constants.getProperty("PROP_RELATIONSHIP"))) {
if (lastRelationship != null) {
relationships.add(lastRelationship);
}
lastRelationship = parseRelationship(value, lineNumber);
} else if (tag.equals(constants.getProperty("PROP_RELATIONSHIP_COMMENT"))) {
if (lastRelationship == null) {
throw(new InvalidSpdxTagFileException("Relationship comment found outside of a relationship: "+value + " at line number "+lineNumber));
}
lastRelationship.setComment(value);
} else {
throw new InvalidSPDXAnalysisException("Error parsing snippet. Unrecognized tag: "+tag + " at line number " + lineNumber);
}
}
private void verifyElement(List verify, String prefix, int lineNumber) {
verifyElement(verify, prefix, lineNumber, false);
}
/**
* Add warning messages for any element verification list
* @param verify List of verification warnings
* @param prefix Prefix to prepend the warning with
* @param lineNumber Line number where the error occurs
* @param ignoreMissingLicenseText if true, don't record any missing license text errors
*/
private void verifyElement(List verify, String prefix, int lineNumber, boolean ignoreMissingLicenseText) {
if (!verify.isEmpty()) {
for (String verMsg:verify) {
if (!ignoreMissingLicenseText || !verMsg.contains("Missing required license text")) {
boolean found = false;
String newWarning = prefix + " at line "+lineNumber+" invalid: "+verMsg;
for (String existingWarn:this.warningMessages) {
if (existingWarn.equals(newWarning)) {
found = true;
break;
}
}
if (!found) {
this.warningMessages.add(newWarning);
}
}
}
}
}
/**
* @param value
* @param lineNumber
* @return
* @throws InvalidSpdxTagFileException
*/
private StartEndPointer parseLineRange(String value, int lineNumber) throws InvalidSpdxTagFileException {
Matcher matcher = NUMBER_RANGE_PATTERN.matcher(value.trim());
if (!matcher.find()) {
throw(new InvalidSpdxTagFileException("Invalid snippet line range: "+ value + " at line number "+lineNumber));
}
LineCharPointer start = null;
try {
start = new LineCharPointer(null, Integer.parseInt(matcher.group(1)));
} catch (Exception ex) {
throw new InvalidSpdxTagFileException("Non integer start to snippet line offset: "+value + " at line number "+lineNumber);
}
LineCharPointer end = null;
try {
end = new LineCharPointer(null, Integer.parseInt(matcher.group(2)));
} catch (Exception ex) {
throw new InvalidSpdxTagFileException("Non integer end to snippet line offset: "+value + " at line number "+lineNumber);
}
return new StartEndPointer(start, end);
}
/**
* @param value
* @param lineNumber
* @return
* @throws InvalidSpdxTagFileException
*/
private StartEndPointer parseByteRange(String value, int lineNumber) throws InvalidSpdxTagFileException {
Matcher matcher = NUMBER_RANGE_PATTERN.matcher(value.trim());
if (!matcher.find()) {
throw(new InvalidSpdxTagFileException("Invalid snippet byte range: "+value + " at line number "+lineNumber));
}
ByteOffsetPointer start = null;
try {
start = new ByteOffsetPointer(null, Integer.parseInt(matcher.group(1)));
} catch (Exception ex) {
throw new InvalidSpdxTagFileException("Non integer start to snippet byte offset: "+value + " at line number "+lineNumber);
}
ByteOffsetPointer end = null;
try {
end = new ByteOffsetPointer(null, Integer.parseInt(matcher.group(2)));
} catch (Exception ex) {
throw new InvalidSpdxTagFileException("Non integer end to snippet byte offset: "+value + " at line number "+lineNumber);
}
return new StartEndPointer(start, end);
}
/**
* @param license
* @param tag
* @param value
* @param lineNumber
* @throws InvalidSpdxTagFileException
*/
private void buildExtractedLicense(
ExtractedLicenseInfo license, String tag, String value, int lineNumber) throws InvalidSpdxTagFileException {
if (tag.equals(constants.getProperty("PROP_EXTRACTED_TEXT"))) {
if (lastExtractedLicense == null) {
throw(new InvalidSpdxTagFileException("Missing Extracted License - An extracted license ID must be provided before the license text at line number "+lineNumber));
}
license.setExtractedText(value);
} else if (tag.equals(constants.getProperty("PROP_LICENSE_NAME"))) {
if (lastExtractedLicense == null) {
throw(new InvalidSpdxTagFileException("Missing Extracted License - An extracted license ID must be provided before the license name at line number "+lineNumber));
}
license.setName(value);
} else if (tag.equals(constants.getProperty("PROP_SOURCE_URLS"))) {
if (lastExtractedLicense == null) {
throw(new InvalidSpdxTagFileException("Missing Extracted License - An extracted license ID must be provided before the license URL at line number "+lineNumber));
}
String[] values = value.split(",");
for (int i = 0; i < values.length; i++) {
values[i] = values[i].trim();
}
license.setSeeAlso(values);
} else if (tag.equals(constants.getProperty("PROP_LICENSE_COMMENT"))) {
if (lastExtractedLicense == null) {
throw(new InvalidSpdxTagFileException("Missing Extracted License - An extracted license ID must be provided before the license comment at line number "+lineNumber));
}
license.setComment(value);
}
}
@SuppressWarnings("deprecation")
private void buildDocumentProperties(String tag, String value, int lineNumber) throws Exception {
if (tag.equals(constants.getProperty("PROP_SPDX_VERSION"))) {
this.specVersion = value;
if (analysis != null) {
analysis.setSpecVersion(value);
}
} else if (tag.equals(constants.getProperty("PROP_SPDX_DATA_LICENSE"))) {
try {
this.dataLicense = LicenseInfoFactory.getListedLicenseById(value);
} catch(InvalidSPDXAnalysisException ex) {
this.dataLicense = null;
}
if (this.dataLicense == null) {
this.dataLicense = new ExtractedLicenseInfo(value, "NO TEXT FOR "+value);
}
if (analysis != null) {
analysis.setDataLicense(this.dataLicense);
}
} else if (tag.equals(constants.getProperty("PROP_DOCUMENT_NAME"))) {
this.documentName = value;
if (analysis != null) {
this.analysis.setName(value);
}
} else if (tag.equals(constants.getProperty("PROP_DOCUMENT_NAMESPACE"))) {
if (this.analysis != null) {
throw(new InvalidSpdxTagFileException("More than one document namespace was specified at line number "+lineNumber));
}
if (this.specVersion == null) {
result[0] = new SpdxDocumentContainer(value);
} else {
result[0] = new SpdxDocumentContainer(value, this.specVersion);
}
this.analysis = result[0].getSpdxDocument();
if (this.dataLicense != null) {
this.analysis.setDataLicense(this.dataLicense);
}
if (this.documentName != null) {
this.analysis.setName(this.documentName);
}
} else if (tag.equals(constants.getProperty("PROP_ELEMENT_ID"))) {
if (!value.equals(SpdxRdfConstants.SPDX_DOCUMENT_ID)) {
throw(new InvalidSpdxTagFileException("SPDX Document "+value
+" is invalid. Document IDs must be "+SpdxRdfConstants.SPDX_DOCUMENT_ID + " at line number "+lineNumber));
}
} else if (tag.equals(constants.getProperty("PROP_EXTERNAL_DOC_URI"))) {
checkAnalysisNull();
addExternalDocRef(value, lineNumber);
} else if (tag.equals(constants.getProperty("PROP_RELATIONSHIP"))) {
if (lastRelationship != null) {
relationships.add(lastRelationship);
}
lastRelationship = parseRelationship(value, lineNumber);
} else if (tag.equals(constants.getProperty("PROP_RELATIONSHIP_COMMENT"))) {
if (lastRelationship == null) {
throw(new InvalidSpdxTagFileException("Relationship comment found outside of a relationship: "+value + " at line number "+lineNumber));
}
lastRelationship.setComment(value);
} else if (tag.equals(constants.getProperty("PROP_ANNOTATOR"))) {
if (lastAnnotation != null) {
annotations.add(lastAnnotation);
}
this.inAnnotation = true;
lastAnnotation = new AnnotationWithId(value, lineNumber);
} else if (tag.equals(constants.getProperty("PROP_ANNOTATION_DATE"))) {
throw(new InvalidSpdxTagFileException("Annotation date found outside of an annotation: "+value + " at line number "+lineNumber));
} else if (tag.equals(constants.getProperty("PROP_ANNOTATION_COMMENT"))) {
throw(new InvalidSpdxTagFileException("Annotation comment found outside of an annotation: "+value + " at line number "+lineNumber));
} else if (tag.equals(constants.getProperty("PROP_ANNOTATION_ID"))) {
throw(new InvalidSpdxTagFileException("Annotation ID found outside of an annotation: "+value + " at line number "+lineNumber));
} else if (tag.equals(constants.getProperty("PROP_ANNOTATION_TYPE"))) {
throw(new InvalidSpdxTagFileException("Annotation type found outside of an annotation: "+value + " at line number "+lineNumber));
} else if (tag.equals(constants.getProperty("PROP_CREATION_CREATOR"))) {
checkAnalysisNull();
if (analysis.getCreationInfo() == null) {
SPDXCreatorInformation creator = new SPDXCreatorInformation(new String[] { value }, "", "", "");
analysis.setCreationInfo(creator);
} else {
List creators = Lists.newArrayList(analysis.getCreationInfo().getCreators());
creators.add(value);
analysis.getCreationInfo().setCreators(creators.toArray(new String[0]));
}
} else if (tag.equals(constants.getProperty("PROP_CREATION_CREATED"))) {
checkAnalysisNull();
if (analysis.getCreationInfo() == null) {
SPDXCreatorInformation creator = new SPDXCreatorInformation(new String[] { }, "", "", "");
analysis.setCreationInfo(creator);
}
analysis.getCreationInfo().setCreated(value);
} else if (tag.equals(constants.getProperty("PROP_CREATION_COMMENT"))) {
checkAnalysisNull();
if (analysis.getCreationInfo() == null) {
SPDXCreatorInformation creator = new SPDXCreatorInformation(new String[] { value }, "", "", "");
analysis.setCreationInfo(creator);
}
analysis.getCreationInfo().setComment(value);
} else if (tag.equals(constants.getProperty("PROP_LICENSE_LIST_VERSION"))) {
checkAnalysisNull();
if (analysis.getCreationInfo() == null) {
SPDXCreatorInformation creator = new SPDXCreatorInformation(new String[] { value }, "", "", "");
analysis.setCreationInfo(creator);
}
analysis.getCreationInfo().setLicenseListVersion(value);
} else if (tag.equals(constants.getProperty("PROP_SPDX_COMMENT"))) {
checkAnalysisNull();
analysis.setComment(value);
} else if (tag.equals(constants.getProperty("PROP_REVIEW_REVIEWER"))) {
checkAnalysisNull();
lastReviewer = new SPDXReview(value, format.format(new Date()), ""); // update date later
List reviewers = Lists.newArrayList(analysis.getReviewers());
reviewers.add(lastReviewer);
analysis.setReviewers(reviewers.toArray(new SPDXReview[0]));
this.verifyElement(lastReviewer.verify(), "Reviewer", lastReviewerLineNumber);
} else if (tag.equals(constants.getProperty("PROP_REVIEW_DATE"))) {
checkAnalysisNull();
if (lastReviewer == null) {
throw(new InvalidSpdxTagFileException("Missing Reviewer - A reviewer must be provided before a review date"));
}
lastReviewer.setReviewDate(value);
this.verifyElement(lastReviewer.verify(), "Reviewer", lastReviewerLineNumber);
} else if (tag.equals(constants.getProperty("PROP_REVIEW_COMMENT"))) {
checkAnalysisNull();
if (lastReviewer == null) {
throw(new InvalidSpdxTagFileException("Missing Reviewer - A reviewer must be provided before a review comment"));
}
lastReviewer.setComment(value);
} else if (tag.equals(constants.getProperty("PROP_LICENSE_ID"))) {
checkAnalysisNull();
if (inExtractedLicenseDefinition) {
verifyElement(lastExtractedLicense.verify(), "Extracted License", lastExtractedLicenseLineNumber, false);
}
if (analysis.getDocumentContainer().extractedLicenseExists(value)) {
lastExtractedLicense = analysis.getDocumentContainer().getExtractedLicense(value);
} else {
lastExtractedLicense = new ExtractedLicenseInfo(value, "WARNING: TEXT IS REQUIRED", null, null, null); //change text later
lastExtractedLicenseLineNumber = lineNumber;
analysis.addExtractedLicenseInfos(lastExtractedLicense);
}
this.inExtractedLicenseDefinition = true;
} else if (tag.equals(constants.getProperty("PROP_PACKAGE_DECLARED_NAME"))) {
checkAnalysisNull();
inPackageDefinition = true;
inFileDefinition = false;
inAnnotation = false;
inSnippetDefinition = false;
inExtractedLicenseDefinition = false;
if (this.lastPackage != null) {
this.analysis.getDocumentContainer().addElement(this.lastPackage);
elementIdLineNumberMap.put(this.lastPackage.getId(), lastPackageLineNumber);
}
this.lastPackage = new SpdxPackage(value, null, null, null, null, null, null, null);
lastPackageLineNumber = lineNumber;
} else if (tag.equals(constants.getProperty("PROP_FILE_NAME"))) {
checkAnalysisNull();
//NOTE: This must follow the inPackageDefinition check since
// if a file is defined following a package, it is assumed to
// be part of the package and not something standalone
addLastFile();
inFileDefinition = true;
inPackageDefinition = false;
inAnnotation = false;
inSnippetDefinition = false;
inExtractedLicenseDefinition = false;
this.lastFile = new SpdxFile(value, null, new Annotation[0], new Relationship[0], null,
new AnyLicenseInfo[0], null, null, new FileType[0], new Checksum[0],
new String[0] , null, new DoapProject[0]);
lastFileLineNumber = lineNumber;
} else if (tag.equals(constants.getProperty("PROP_SNIPPET_SPDX_ID"))) {
checkAnalysisNull();
addLastSnippet();
inSnippetDefinition = true;
inFileDefinition = false;
inPackageDefinition = false;
inAnnotation = false;
inExtractedLicenseDefinition = false;
this.lastSnippet = new SpdxSnippet(null, null, new Annotation[0], new Relationship[0], null,
new AnyLicenseInfo[0], null, null, null, null, null);
this.lastSnippet.setId(value);
this.lastSnippetLineNumber = lineNumber;
} else {
throw new InvalidSpdxTagFileException("Expecting a definition of a file, package, license information, or document property at "+tag+value+" line number "+lineNumber);
}
}
/**
* Adds the last file to either the last package or the document
* @throws InvalidSPDXAnalysisException
*
*/
private void addLastFile() throws InvalidSPDXAnalysisException {
if (this.lastFile != null) {
if (lastPackage != null) {
this.lastPackage.addFile(lastFile);
} else {
this.analysis.getDocumentContainer().addElement(lastFile);
}
elementIdLineNumberMap.put(lastFile.getId(),lastFileLineNumber);
}
this.lastFile = null;
}
/**
* Adds the last snippet to the document
* @throws InvalidSPDXAnalysisException
*
*/
private void addLastSnippet() throws InvalidSPDXAnalysisException {
if (this.lastSnippet != null) {
this.analysis.getDocumentContainer().addElement(lastSnippet);
elementIdLineNumberMap.put(lastSnippet.getId(), lastSnippetLineNumber);
}
this.lastSnippet = null;
}
/**
* @param tag
* @param value
* @param annotation
* @throws InvalidSPDXAnalysisException
*/
private void buildAnnotation(String tag, String value,
AnnotationWithId annotation) throws InvalidSPDXAnalysisException {
if (tag.equals(constants.getProperty("PROP_ANNOTATION_DATE"))) {
annotation.setDate(value);
} else if (tag.equals(constants.getProperty("PROP_ANNOTATION_COMMENT"))) {
annotation.setComment(value);
} else if (tag.equals(constants.getProperty("PROP_ANNOTATION_ID"))) {
annotation.setId(value);
} else if (tag.equals(constants.getProperty("PROP_ANNOTATION_TYPE"))) {
AnnotationType annotationType = AnnotationType.fromTag(value);
if (annotationType == null) {
throw(new InvalidSPDXAnalysisException("Invalid annotation type: "+value + " at line number "+annotation.getLineNumber()));
}
annotation.setAnnotationType(annotationType);
}
}
/**
* @param value
* @return
* @throws InvalidSpdxTagFileException
*/
private RelationshipWithId parseRelationship(String value, int lineNumber) throws InvalidSpdxTagFileException {
Matcher matcher = RELATIONSHIP_PATTERN.matcher(value.trim());
if (!matcher.find()) {
throw(new InvalidSpdxTagFileException("Invalid relationship: "+value + " at line number "+lineNumber));
}
RelationshipType relationshipType = null;
try {
relationshipType = RelationshipType.fromTag(matcher.group(2).toUpperCase());
} catch (IllegalArgumentException ex) {
throw(new InvalidSpdxTagFileException("Invalid relationship type: "+value + " at line number "+lineNumber));
}
return new RelationshipWithId(matcher.group(1), matcher.group(3),
relationshipType, lineNumber);
}
private void checkAnalysisNull() throws InvalidSpdxTagFileException, InvalidSPDXAnalysisException,InvalidFileFormatException {
if (this.analysis == null) {
if (this.specVersion != null && this.specVersion.compareTo("SPDX-2.0") < 0) {
result[0] = new SpdxDocumentContainer(generateDocumentNamespace());
this.analysis = result[0].getSpdxDocument();
} else {
throw(new InvalidFileFormatException("The SPDX Document Namespace must be set before other SPDX document properties are set."));
}
}
}
/**
* @return
*/
private String generateDocumentNamespace() {
return "http://spdx.org/documents/"+UUID.randomUUID().toString();
}
/**
* @param value
* @param lineNumber
* @throws InvalidSpdxTagFileException
* @throws InvalidSPDXAnalysisException
*/
private void addExternalDocRef(String value, int lineNumber) throws InvalidSpdxTagFileException, InvalidSPDXAnalysisException {
ExternalDocumentRef ref = parseExternalDocumentRef(value, lineNumber);
verifyElement(ref.verify(), "External Document Reference", lineNumber);
ExternalDocumentRef[] oldRefs = this.analysis.getExternalDocumentRefs();
if (oldRefs == null) {
oldRefs = new ExternalDocumentRef[0];
}
ExternalDocumentRef[] newRefs = Arrays.copyOf(oldRefs, oldRefs.length+1);
newRefs[oldRefs.length] = ref;
this.analysis.setExternalDocumentRefs(newRefs);
}
/**
* Parse a tag/value external document reference string
* @param refStr
* @param lineNumber
* @return
* @throws InvalidSpdxTagFileException
*/
public static ExternalDocumentRef parseExternalDocumentRef(String refStr, int lineNumber) throws InvalidSpdxTagFileException {
Matcher matcher = EXTERNAL_DOC_REF_PATTERN.matcher(refStr.trim());
if (!matcher.find()) {
throw(new InvalidSpdxTagFileException("Invalid external document reference: "+refStr+" at line number "+lineNumber));
}
Checksum checksum = new Checksum(ChecksumAlgorithm.checksumAlgorithm_sha1, matcher.group(3));
ExternalDocumentRef ref = new ExternalDocumentRef(matcher.group(2),
checksum, matcher.group(1));
return ref;
}
/**
* @param pkg
* @param tag
* @param value
* @param lineNumber
* @throws InvalidSPDXAnalysisException
* @throws InvalidSpdxTagFileException
* @throws InvalidLicenseStringException
*/
private void buildPackage(SpdxPackage pkg, String tag, String value, int lineNumber)
throws InvalidSPDXAnalysisException, InvalidSpdxTagFileException, InvalidLicenseStringException {
if (tag.equals(constants.getProperty("PROP_ELEMENT_ID"))) {
pkg.setId(value);
} else if (tag.equals(constants.getProperty("PROP_PACKAGE_VERSION_INFO"))) {
pkg.setVersionInfo(value);
} else if (tag.equals(constants.getProperty("PROP_PACKAGE_FILE_NAME"))) {
pkg.setPackageFileName(value);
} else if (tag.equals(constants.getProperty("PROP_PACKAGE_SUPPLIER"))) {
pkg.setSupplier(value);
} else if (tag.equals(constants.getProperty("PROP_PACKAGE_ORIGINATOR"))) {
pkg.setOriginator(value);
} else if (tag.equals(constants.getProperty("PROP_PACKAGE_DOWNLOAD_URL"))) {
pkg.setDownloadLocation(value);
} else if (tag.equals(constants.getProperty("PROP_PACKAGE_VERIFICATION_CODE"))) {
SpdxPackageVerificationCode verificationCode = null;
if (value.contains("(")) {
String[] verification = value.split("\\(");
String[] excludedFiles = verification[1].replace(")", "").split(",");
for (int i = 0; i < excludedFiles.length; i++) {
excludedFiles[i] = excludedFiles[i].trim();
}
verificationCode = new SpdxPackageVerificationCode(verification[0].trim(), excludedFiles);
}
else {
verificationCode = new SpdxPackageVerificationCode(value, new String[0]);
}
verifyElement(verificationCode.verify(), "Verification Code", lineNumber);
pkg.setPackageVerificationCode(verificationCode);
} else if (constants.getProperty("PROP_PACKAGE_CHECKSUM").startsWith(tag)) {
Checksum checksum = parseChecksum(value, lineNumber);
verifyElement(checksum.verify(), "Package Checksum", lineNumber);
pkg.addChecksum(checksum);
} else if (tag.equals(constants.getProperty("PROP_PACKAGE_HOMEPAGE_URL"))) {
pkg.setHomepage(value);
} else if (tag.equals(constants.getProperty("PROP_PACKAGE_SOURCE_INFO"))) {
pkg.setSourceInfo(value);
} else if (tag.equals(constants.getProperty("PROP_PACKAGE_CONCLUDED_LICENSE"))) {
AnyLicenseInfo licenseSet = LicenseInfoFactory.parseSPDXLicenseString(value, this.analysis.getDocumentContainer());
// can not verify any licenses at this point since the extracted license infos may not be set
pkg.setLicenseConcluded(licenseSet);
} else if (tag.equals(constants.getProperty("PROP_PACKAGE_LICENSE_INFO_FROM_FILES"))) {
AnyLicenseInfo license = LicenseInfoFactory.parseSPDXLicenseString(value, this.analysis.getDocumentContainer());
// can not verify any licenses at this point since the extracted license infos may not be set
List licenses = Lists.newArrayList(pkg.getLicenseInfoFromFiles());
licenses.add(license);
pkg.setLicenseInfosFromFiles(licenses.toArray(new AnyLicenseInfo[0]));
} else if (tag.equals(constants.getProperty("PROP_PACKAGE_DECLARED_LICENSE"))) {
AnyLicenseInfo licenseSet = LicenseInfoFactory.parseSPDXLicenseString(value, this.analysis.getDocumentContainer());
// can not verify any licenses at this point since the extracted license infos may not be set
pkg.setLicenseDeclared(licenseSet);
} else if (tag.equals(constants.getProperty("PROP_PACKAGE_LICENSE_COMMENT"))) {
pkg.setLicenseComments(value);
} else if (tag.equals(constants.getProperty("PROP_PACKAGE_DECLARED_COPYRIGHT"))) {
pkg.setCopyrightText(value);
} else if (tag.equals(constants.getProperty("PROP_PACKAGE_SHORT_DESC"))) {
pkg.setSummary(value);
} else if (tag.equals(constants.getProperty("PROP_PACKAGE_DESCRIPTION"))) {
pkg.setDescription(value);
} else if (tag.equals(constants.getProperty("PROP_EXTERNAL_REFERENCE"))) {
this.lastExternalRef = parseExternalRef(value, lineNumber);
verifyElement(this.lastExternalRef.verify(), "External Reference", lineNumber);
pkg.addExternalRef(this.lastExternalRef);
} else if (tag.equals(constants.getProperty("PROP_EXTERNAL_REFERENCE_COMMENT"))) {
if (this.lastExternalRef == null) {
throw new InvalidSpdxTagFileException("External reference comment found without an external reference: "+value + " at line number "+lineNumber);
}
if (this.lastExternalRef.getComment() != null && !this.lastExternalRef.getComment().isEmpty()) {
throw new InvalidSpdxTagFileException("Second reference comment found for the same external reference: "+value + " at line number "+lineNumber);
}
this.lastExternalRef.setComment(value);
} else if (tag.equals(constants.getProperty("PROP_ANNOTATOR"))) {
if (lastAnnotation != null) {
annotations.add(lastAnnotation);
}
this.inAnnotation = true;
lastAnnotation = new AnnotationWithId(value, lineNumber);
} else if (tag.equals(constants.getProperty("PROP_RELATIONSHIP"))) {
if (lastRelationship != null) {
relationships.add(lastRelationship);
}
lastRelationship = parseRelationship(value, lineNumber);
} else if (tag.equals(constants.getProperty("PROP_RELATIONSHIP_COMMENT"))) {
if (lastRelationship == null) {
throw(new InvalidSpdxTagFileException("Relationship comment found outside of a relationship: "+value + " at line number "+lineNumber));
}
lastRelationship.setComment(value);
} else if (tag.equals(constants.getProperty("PROP_FILE_NAME"))) {
addLastFile();
this.lastFile = new SpdxFile(value, null, new Annotation[0], new Relationship[0], null,
new AnyLicenseInfo[0], null, null, new FileType[0], new Checksum[0],
new String[0] , null, new DoapProject[0]);
this.inFileDefinition = true;
inSnippetDefinition = false;
inAnnotation = false;
} else if (tag.equals(constants.getProperty("PROP_SNIPPET_SPDX_ID"))) {
addLastSnippet();
inSnippetDefinition = true;
inFileDefinition = false;
inPackageDefinition = false;
inAnnotation = false;
this.lastSnippet = new SpdxSnippet(null, null, new Annotation[0], new Relationship[0], null,
new AnyLicenseInfo[0], null, null, null, null, null);
this.lastSnippet.setId(value);
this.lastSnippetLineNumber = lineNumber;
} else if (tag.equals(constants.getProperty("PROP_PACKAGE_COMMENT"))) {
pkg.setComment(value);
} else if (tag.equals(constants.getProperty("PROP_PACKAGE_ATTRIBUTION_TEXT"))) {
addAttributionText(pkg, value);
} else if (tag.equals(constants.getProperty("PROP_PACKAGE_FILES_ANALYZED"))) {
if ("TRUE".equals(value.toUpperCase())) {
pkg.setFilesAnalyzed(true);
} else if ("FALSE".equals(value.toUpperCase())) {
pkg.setFilesAnalyzed(false);
} else {
throw(new InvalidSpdxTagFileException("Invalid value for files analyzed. Must be 'true' or 'false'. Found value: "+value+" at line number "+lineNumber));
}
} else {
throw(new InvalidSpdxTagFileException("Expecting a file definition, snippet definition or a package property. Found "+value+" at line number "+lineNumber));
}
}
/**
* Parse the external reference string
* @param value
* @param lineNumber
* @return
* @throws InvalidSpdxTagFileException
* @throws InvalidSPDXAnalysisException
*/
private ExternalRef parseExternalRef(String value, int lineNumber) throws InvalidSpdxTagFileException, InvalidSPDXAnalysisException {
Matcher matcher = EXTERNAL_REF_PATTERN.matcher(value);
if (!matcher.find()) {
throw new InvalidSpdxTagFileException("Invalid External Ref format: "+value+" at line number "+lineNumber);
}
ReferenceCategory referenceCategory = ReferenceCategory.fromTag(matcher.group(1).trim());
if (referenceCategory == null) {
throw new InvalidSpdxTagFileException("Invalid External Ref category: "+value+" at line number "+lineNumber);
}
ReferenceType referenceType = null;
String tagType = matcher.group(2).trim();
try {
// First, try to find a listed type
referenceType = ListedReferenceTypes.getListedReferenceTypes().getListedReferenceTypeByName(tagType);
} catch (InvalidSPDXAnalysisException e) {
referenceType = null;
}
if (referenceType == null) {
try {
URI refTypeUri = null;
if (tagType.contains("/") || tagType.contains(":")) {
// Assume a full URI
refTypeUri = new URI(tagType);
} else {
// User the document namespace
refTypeUri = new URI(this.result[0].getDocumentNamespace() + matcher.group(2).trim());
}
referenceType = new ReferenceType(refTypeUri, null, null, null);
} catch (URISyntaxException e) {
throw new InvalidSpdxTagFileException("Invalid External Ref type: "+value+" at line number "+lineNumber);
}
}
return new ExternalRef(referenceCategory, referenceType, matcher.group(3), null);
}
/**
* Creates a Checksum from the parameters specified in the tag value
* @param value
* @param lineNumber
* @return
* @throws InvalidSpdxTagFileException
*/
public static Checksum parseChecksum(String value, int lineNumber) throws InvalidSpdxTagFileException {
Matcher matcher = CHECKSUM_PATTERN.matcher(value.trim());
if (!matcher.find()) {
throw(new InvalidSpdxTagFileException("Invalid checksum: "+value+" at line number "+lineNumber));
}
ChecksumAlgorithm algorithm = Checksum.CHECKSUM_TAG_TO_ALGORITHM.get(matcher.group(1));
if (algorithm == null) {
throw(new InvalidSpdxTagFileException("Invalid checksum algorithm: "+value+" at line number "+lineNumber));
}
return new Checksum(algorithm, matcher.group(2));
}
/**
* @param file
* @param tag
* @param value
* @param lineNumber
*/
private void buildFile(SpdxFile file, String tag, String value, int lineNumber)
throws Exception {
if (file == null) {
if (FILE_TAGS.contains(tag)) {
throw(new InvalidSpdxTagFileException("Missing File Name - A file name must be specified before the file properties at line number "+lineNumber));
} else {
throw(new InvalidSpdxTagFileException("Unrecognized SPDX Tag: "+tag+" at line number "+lineNumber));
}
}
if (tag.equals(constants.getProperty("PROP_ELEMENT_ID"))) {
file.setId(value);
} else if (tag.equals(constants.getProperty("PROP_FILE_TYPE"))) {
FileType fileType = FileType.fromTag(value.trim());
if (fileType == null) {
fileType = FileType.fromTag(value.trim().toUpperCase());
if (fileType == null) {
throw(new InvalidSpdxTagFileException("Unknown file type: "+value+" at line number "+lineNumber));
} else {
this.warningMessages.add("Invalid filetype - needs to be uppercased: "+value+" at line number "+lineNumber);
}
}
file.addFileType(fileType);
} else if (constants.getProperty("PROP_FILE_CHECKSUM").startsWith(tag)) {
file.addChecksum(parseChecksum(value, lineNumber));
} else if (tag.equals(constants.getProperty("PROP_FILE_LICENSE"))) {
AnyLicenseInfo licenseSet = LicenseInfoFactory.parseSPDXLicenseString(value, this.analysis.getDocumentContainer());
// can not verify any licenses at this point since the extracted license infos may not be set
file.setLicenseConcluded(licenseSet);
} else if (tag.equals(constants.getProperty("PROP_FILE_SEEN_LICENSE"))) {
AnyLicenseInfo fileLicense = (LicenseInfoFactory.parseSPDXLicenseString(value, this.analysis.getDocumentContainer()));
// can not verify any licenses at this point since the extracted license infos may not be set
List seenLicenses = Lists.newArrayList(file.getLicenseInfoFromFiles());
seenLicenses.add(fileLicense);
file.setLicenseInfosFromFiles(seenLicenses.toArray(new AnyLicenseInfo[0]));
} else if (tag.equals(constants.getProperty("PROP_FILE_LIC_COMMENTS"))) {
file.setLicenseComments(value);
} else if (tag.equals(constants.getProperty("PROP_FILE_COPYRIGHT"))) {
file.setCopyrightText(value);
} else if (tag.equals(constants.getProperty("PROP_FILE_COMMENT"))) {
file.setComment(value);
} else if (tag.equals(constants.getProperty("PROP_FILE_NOTICE_TEXT"))) {
file.setNoticeText(value);
} else if (tag.equals(constants.getProperty("PROP_FILE_CONTRIBUTOR"))) {
addFileContributor(file, value);
} else if (tag.equals(constants.getProperty("PROP_FILE_DEPENDENCY"))) {
addFileDependency(file, value);
} else if (tag.equals(constants.getProperty("PROP_FILE_ATTRIBUTION_TEXT"))) {
addAttributionText(file, value);
} else if (tag.equals(constants.getProperty("PROP_ANNOTATOR"))) {
if (lastAnnotation != null) {
annotations.add(lastAnnotation);
}
this.inAnnotation = true;
lastAnnotation = new AnnotationWithId(value, lineNumber);
} else if (tag.equals(constants.getProperty("PROP_RELATIONSHIP"))) {
if (lastRelationship != null) {
relationships.add(lastRelationship);
}
lastRelationship = parseRelationship(value, lineNumber);
} else if (tag.equals(constants.getProperty("PROP_RELATIONSHIP_COMMENT"))) {
if (lastRelationship == null) {
throw(new InvalidSpdxTagFileException("Relationship comment found outside of a relationship: "+value+" at line number "+lineNumber));
}
lastRelationship.setComment(value);
} else {
buildProject(file, tag, value, lineNumber);
}
}
/**
* Adds a file contributor to the list of contributors for this file
* @param file
* @param contributor
*/
private void addFileContributor(SpdxFile file, String contributor) {
String[] contributors = file.getFileContributors();
if (contributors == null) {
contributors = new String[] {contributor};
} else {
contributors = Arrays.copyOf(contributors, contributors.length + 1);
contributors[contributors.length-1] = contributor;
}
file.setFileContributors(contributors);
}
/**
* Adds a file attribution text to the list of attribution texts for this file
* @param item
* @param attributionText
*/
private void addAttributionText(SpdxItem item, String attributionText) {
String[] attributionTexts = item.getAttributionText();
if (attributionTexts == null) {
attributionTexts = new String[] {attributionText};
} else {
attributionTexts = Arrays.copyOf(attributionTexts, attributionTexts.length + 1);
attributionTexts[attributionTexts.length-1] = attributionText;
}
item.setAttributionText(attributionTexts);
}
/**
* Adds a file dependency to a file
* @param file
* @param dependentFileName
*/
private void addFileDependency(SpdxFile file, String dependentFileName) {
// Since the files have not all been parsed, we just keep track of the
// dependencies in a hashmap until we finish all processing and are building the package
List filesWithThisAsADependency = this.fileDependencyMap.get(dependentFileName);
if (filesWithThisAsADependency == null) {
filesWithThisAsADependency = Lists.newArrayList();
this.fileDependencyMap.put(dependentFileName, filesWithThisAsADependency);
}
filesWithThisAsADependency.add(file);
}
/**
* @param file
* @param tag
* @param value
* @param lineNumber
*/
@SuppressWarnings("deprecation")
private void buildProject(SpdxFile file, String tag, String value, int lineNumber)
throws Exception {
if (tag.equals(constants.getProperty("PROP_PROJECT_NAME"))) {
if (lastProject != null) {
verifyElement(lastProject.verify(), "DOAP Project", lastProjectLineNumber);
}
lastProject = new DoapProject(value, null);
lastProjectLineNumber = lineNumber;
List projects = Lists.newArrayList(file.getArtifactOf());
projects.add(lastProject);
file.setArtifactOf(projects.toArray(new DoapProject[0]));
} else {
if (tag.equals(constants.getProperty("PROP_PROJECT_HOMEPAGE"))) {
if (lastProject == null) {
throw(new InvalidSpdxTagFileException("Missing Project Name - A project name must be provided before the project properties at line number" + lineNumber));
}
lastProject.setHomePage(value);
} else if (tag.equals(constants.getProperty("PROP_PROJECT_URI"))) {
if (lastProject == null) {
throw(new InvalidSpdxTagFileException("Missing Project Name - A project name must be provided before the project properties at line number" + lineNumber));
}
// can not set the URI since it is already created, we need to replace DOAP project
DoapProject[] existingProjects = file.getArtifactOf();
int i = 0;
while (i < existingProjects.length && !existingProjects[i].equals(lastProject)) {
i++;
}
if (i >= existingProjects.length) {
existingProjects = Arrays.copyOf(existingProjects, existingProjects.length+1);
}
existingProjects[i] = new DoapProject(lastProject.getName(), lastProject.getHomePage());
existingProjects[i].setProjectUri(value);
file.setArtifactOf(existingProjects);
lastProject = existingProjects[i];
} else {
throw(new InvalidSpdxTagFileException("Unrecognized tag: "+tag+" at line number" + lineNumber));
}
}
}
private static String trim(String value) {
value = value.replaceAll("\u00A0", " ");
value = value.trim();
value = value.replaceAll("", "").replaceAll("", "");
return value;
}
@Override
public void exit() throws Exception {
if (inExtractedLicenseDefinition && lastExtractedLicense != null) {
verifyElement(lastExtractedLicense.verify(), "Extracted License", lastExtractedLicenseLineNumber, false);
}
addLastFile();
if (this.lastPackage != null) {
this.analysis.getDocumentContainer().addElement(this.lastPackage);
elementIdLineNumberMap.put(this.lastPackage.getId(), this.lastPackageLineNumber);
}
fixFileAndSnippetDependencies();
addRelationships();
checkSinglePackageDefault();
addAnnotations();
List allElements = analysis.getDocumentContainer().findAllElements();
for (SpdxElement element:allElements) {
if (elementIdLineNumberMap.containsKey(element.getId())) {
String prefix = "Element";
if (element instanceof SpdxPackage) {
prefix = "Package";
} else if (element instanceof SpdxSnippet) {
prefix = "Snippet";
} else if (element instanceof SpdxFile) {
prefix = "File";
}
verifyElement(element.verify(), prefix, elementIdLineNumberMap.get(element.getId()));
}
}
List analysisVerify = analysis.verify();
for (String analysisVerifyMsg:analysisVerify) {
// add any missing messages
boolean found = false;
for (String warningMsg:warningMessages) {
if (warningMsg.contains(analysisVerifyMsg)) {
found = true;
break;
}
}
if (!found) {
warningMessages.add(analysisVerifyMsg);
}
}
}
/**
* Makes sure there is a describes relationships for a single package
* SPDX document
* @throws InvalidSPDXAnalysisException
* @throws InvalidSpdxTagFileException
*/
private void checkSinglePackageDefault() throws InvalidSPDXAnalysisException, InvalidSpdxTagFileException {
Relationship[] documentRelationships = this.analysis.getRelationships();
for (int i = 0; i < documentRelationships.length; i++) {
if (documentRelationships[i].getRelationshipType() == Relationship.RelationshipType.DESCRIBES) {
return; // We found at least one document describes, we don't need to add a default
}
}
List pkgs = this.analysis.getDocumentContainer().findAllPackages();
if (pkgs.size() == 0) {
throw new InvalidSpdxTagFileException("Missing describes relationship and there is no package to create a default - see SPDX specification relationship section under DESCRIBES relationship description for more information");
}
Relationship describesRelationship = new Relationship(pkgs.get(0),
Relationship.RelationshipType.DESCRIBES,
"This describes relationship was added as a default relationship by the SPDX Tools Tag parser.");
this.analysis.addRelationship(describesRelationship);
}
/**
* @throws InvalidSPDXAnalysisException
*
*/
private void addAnnotations() throws InvalidSPDXAnalysisException {
if (this.lastAnnotation != null) {
this.annotations.add(lastAnnotation);
lastAnnotation = null;
}
for (int i = 0; i < annotations.size(); i++) {
String id = annotations.get(i).getId();
if (id == null) {
this.warningMessages.add("missing SPDXREF: tag in annotation " + annotations.get(i).getAnnotation().getComment() +
" at line number "+annotations.get(i).getLineNumber());
continue;
}
SpdxElement element = this.analysis.getDocumentContainer().findElementById(id);
if (element == null) {
this.warningMessages.add("Invalid element reference in annotation: " + id + " at line number "+annotations.get(i).getLineNumber());
continue;
}
Annotation[] elementAnnotations = element.getAnnotations();
if (elementAnnotations == null) {
elementAnnotations = new Annotation[0];
}
Annotation[] newAnnotations = Arrays.copyOf(elementAnnotations, elementAnnotations.length+1);
newAnnotations[elementAnnotations.length] = annotations.get(i).getAnnotation();
verifyElement(annotations.get(i).getAnnotation().verify(), "Annotation", annotations.get(i).getLineNumber());
element.setAnnotations(newAnnotations);
}
}
/**
* @throws InvalidSPDXAnalysisException
*
*/
private void addRelationships() throws InvalidSPDXAnalysisException {
if (this.lastRelationship != null) {
this.relationships.add(lastRelationship);
lastRelationship = null;
}
for (int i = 0; i < relationships.size(); i++) {
RelationshipWithId relationship = relationships.get(i);
SpdxElement element = this.analysis.getDocumentContainer().findElementById(relationship.getId());
if (element == null) {
this.warningMessages.add("Missing element for a relationship. SPDX ID: "+relationship.getId()+" at line number "+relationship.getLineNumber());
continue;
}
SpdxElement relatedElement = null;
if (SpdxNoneElement.NONE_ELEMENT_ID.equals(relationship.getRelatedId())) {
relatedElement = new SpdxNoneElement();
} else if (SpdxNoAssertionElement.NOASSERTION_ELEMENT_ID.equals(relationship.getRelatedId())) {
relatedElement = new SpdxNoAssertionElement();
} else {
relatedElement = this.analysis.getDocumentContainer().findElementById(relationship.getRelatedId());
}
//Invoked for processing
element.getRelationships();
Relationship newRelationship = new Relationship(relatedElement,
relationships.get(i).getRelationshipType(), relationships.get(i).getComment());
verifyElement(newRelationship.verify(), "Relationship", relationships.get(i).getLineNumber());
element.addRelationship(newRelationship);
}
}
/**
* Go through all of the file dependencies and snippet dependencies and add them to the file
* @throws InvalidSPDXAnalysisException
* @throws InvalidSpdxTagFileException
*/
@SuppressWarnings("deprecation")
private void fixFileAndSnippetDependencies() throws InvalidSPDXAnalysisException, InvalidSpdxTagFileException,InvalidFileFormatException {
// be prepared - it is complicate to make this efficient
// the HashMap fileDependencyMap contains a map from a file name to all SPDX files which
// reference that file name as a dependency
// This method goes through all of the files in the analysis in a single pass and creates
// a new HashMap of files (as the key) and the dependency files (arraylist) as the values.
// We also take care of updating the files in the Snippet Dependencies in this pass.
// Once that hashmap is built, the actual dependencies and snippets are then updated.
// the key contains an SPDX file with one or more dependencies. The value is the array list of file dependencies
Map> filesWithDependencies = Maps.newHashMap();
Map> filesWithSnippets = Maps.newHashMap();
this.checkAnalysisNull();
SpdxFile[] allFiles = analysis.getDocumentContainer().getFileReferences();
// fill in the filesWithDependencies map
for (int i = 0;i < allFiles.length; i++) {
List alFilesHavingThisDependency = this.fileDependencyMap.get(allFiles[i].getName());
if (alFilesHavingThisDependency != null) {
for (int j = 0; j < alFilesHavingThisDependency.size(); j++) {
SpdxFile fileWithDependency = alFilesHavingThisDependency.get(j);
List alDepdenciesForThisFile = filesWithDependencies.get(fileWithDependency);
if (alDepdenciesForThisFile == null) {
alDepdenciesForThisFile = Lists.newArrayList();
filesWithDependencies.put(fileWithDependency, alDepdenciesForThisFile);
}
alDepdenciesForThisFile.add(allFiles[i]);
}
// remove from the file dependency map so we can keep track of any files which did
// not match at the end
this.fileDependencyMap.remove(allFiles[i].getName());
}
List alSnippetsWithThisFile = this.snippetDependencyMap.get(allFiles[i].getId());
if (alSnippetsWithThisFile != null) {
List snippets = Lists.newArrayList();
filesWithSnippets.put(allFiles[i], snippets);
for (SpdxSnippet snippet:alSnippetsWithThisFile) {
snippets.add(snippet);
}
}
this.snippetDependencyMap.remove(allFiles[i].getId());
}
// Go through the file dependency hashmap we just created and add the dependent files
Iterator>> iter = filesWithDependencies.entrySet().iterator();
while (iter.hasNext()) {
Entry> entry = iter.next();
List alDependencies = entry.getValue();
if (alDependencies != null && alDependencies.size() > 0) {
entry.getKey().setFileDependencies(alDependencies.toArray(new SpdxFile[alDependencies.size()]));
}
}
// Now go through the snippets map
Iterator>> snIter = filesWithSnippets.entrySet().iterator();
while (snIter.hasNext()) {
Entry> entry = snIter.next();
List alSnippets = entry.getValue();
if (alSnippets != null) {
for (SpdxSnippet snippet:alSnippets) {
snippet.setSnippetFromFile(entry.getKey());
}
}
}
// Check to see if there are any left over and and throw an error if the dependent files were
// not found
Set missingDependencies = this.fileDependencyMap.keySet();
if (missingDependencies != null && missingDependencies.size() > 0) {
this.warningMessages.add("The following file names were listed as file dependencies but were not found in the list of files:");
Iterator missingIter = missingDependencies.iterator();
while(missingIter.hasNext()) {
this.warningMessages.add("\t"+missingIter.next());
}
}
Set missingSnippetFileIds = this.snippetDependencyMap.keySet();
if (missingSnippetFileIds != null && missingSnippetFileIds.size() > 0) {
this.warningMessages.add("The following file IDs were listed as files for snippets but were not found in the list of files:");
Iterator missingIter = missingDependencies.iterator();
while(missingIter.hasNext()) {
this.warningMessages.add("\t"+missingIter.next());
}
}
}
}
