org.spdx.rdfparser.SpdxVerificationHelper Maven / Gradle / Ivy
/**
* 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.rdfparser;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import org.spdx.rdfparser.model.Checksum.ChecksumAlgorithm;
import org.spdx.rdfparser.model.SpdxFile.FileType;
import org.apache.jena.iri.IRIFactory;
/**
* Holds static methods used for verify various property values
* @author Gary O'Neall
*
*/
public class SpdxVerificationHelper {
static IRIFactory iriFactory = IRIFactory.iriImplementation();
static final String[] VALID_CREATOR_PREFIXES = new String[] {SpdxRdfConstants.CREATOR_PREFIX_PERSON,
SpdxRdfConstants.CREATOR_PREFIX_ORGANIZATION, SpdxRdfConstants.CREATOR_PREFIX_TOOL};
static final String[] VALID_ORIGINATOR_SUPPLIER_PREFIXES = new String[] {SpdxRdfConstants.NOASSERTION_VALUE, "Person:", "Organization:"};
public static String verifyNonStdLicenseid(String licenseId) {
if (SpdxRdfConstants.LICENSE_ID_PATTERN.matcher(licenseId).matches()) {
return null;
} else {
return "Invalid license id '"+licenseId+"'. Must start with 'LicenseRef-' " +
"and made up of the characters from the set 'a'-'z', 'A'-'Z', '0'-'9', '+', '_', '.', and '-'.";
}
}
public static String verifyChecksumString(String checksum) {
return verifyChecksumString(checksum, ChecksumAlgorithm.checksumAlgorithm_sha1);
}
public static String verifyChecksumString(String checksum, ChecksumAlgorithm algorithm) {
for (int i = 0; i < checksum.length(); i++) {
char c = checksum.charAt(i);
if (!((c >= '0' && c <= '9') || (c >= 'a' && c <= 'f') || (c >= 'A' && c <= 'F'))) {
return "Invalid checksum string character at position "+String.valueOf(i);
}
}
if (ChecksumAlgorithm.checksumAlgorithm_sha1.equals(algorithm) && checksum.length() != 40) {
return "Invalid number of characters for checksum";
}
if (ChecksumAlgorithm.checksumAlgorithm_sha256.equals(algorithm) && checksum.length() != 64) {
return "Invalid number of characters for checksum";
}
if (ChecksumAlgorithm.checksumAlgorithm_md5.equals(algorithm) && checksum.length() != 32) {
return "Invalid number of characters for checksum";
}
return null; // if we got here, all OK
}
/**
* @param fileType
* @return
*/
public static String verifyFileType(String fileType) {
if (FileType.fromTag(fileType) == null) {
return "Unrecognized file type";
} else {
return null;
}
}
/**
* Verifies a creator string value
* @param creator
* @return
*/
public static String verifyCreator(String creator) {
boolean ok = false;
for (int i = 0; i < VALID_CREATOR_PREFIXES.length; i++) {
if (creator.startsWith(VALID_CREATOR_PREFIXES[i])) {
ok = true;
break;
}
}
if (!ok) {
StringBuilder sb = new StringBuilder("Creator does not start with one of ");
sb.append(VALID_CREATOR_PREFIXES[0]);
for (int i = 1; i < VALID_CREATOR_PREFIXES.length; i++) {
sb.append(", ");
sb.append(VALID_CREATOR_PREFIXES[i]);
}
return sb.toString();
} else {
return null;
}
}
/**
* Verifies the originator string
* @param originator
* @return
*/
public static String verifyOriginator(String originator) {
return verifyOriginatorOrSupplier(originator);
}
/**
* Verifies the supplier String
* @param supplier
* @return
*/
public static String verifySupplier(String supplier) {
return verifyOriginatorOrSupplier(supplier);
}
/**
* Verifies a the originator or supplier
* @param creator
* @return
*/
private static String verifyOriginatorOrSupplier(String originatorOrSupplier) {
boolean ok = false;
for (int i = 0; i < VALID_ORIGINATOR_SUPPLIER_PREFIXES.length; i++) {
if (originatorOrSupplier.startsWith(VALID_ORIGINATOR_SUPPLIER_PREFIXES[i])) {
ok = true;
break;
}
}
if (!ok) {
StringBuilder sb = new StringBuilder("Value must start with one of ");
sb.append(VALID_ORIGINATOR_SUPPLIER_PREFIXES[0]);
for (int i = 1; i < VALID_ORIGINATOR_SUPPLIER_PREFIXES.length; i++) {
sb.append(", ");
sb.append(VALID_ORIGINATOR_SUPPLIER_PREFIXES[i]);
}
return sb.toString();
} else {
return null;
}
}
/**
* @param creationDate
* @return
*/
public static String verifyDate(String creationDate) {
SimpleDateFormat format = new SimpleDateFormat(SpdxRdfConstants.SPDX_DATE_FORMAT);
try {
format.parse(creationDate);
} catch (ParseException e) {
return("Invalid date format: "+e.getMessage());
}
return null;
}
/**
* @param reviewer
* @return
*/
public static String verifyReviewer(String reviewer) {
if (!reviewer.startsWith("Person:") && !reviewer.startsWith("Tool:") &&
!reviewer.startsWith("Organization:")) {
return "Reviewer does not start with Person:, Organization:, or Tool:";
} else {
return null;
}
}
/**
* Validates a URI is indeed valid
* @param uri
* @return
*/
public static boolean isValidUri(String uri) {
return !iriFactory.create(uri).hasViolation(false);
}
/**
* Returns true if s1 equals s2 taking into account the possibility of null values
* @param s1
* @param s2
* @return
*/
public static boolean equalsWithNull(Object s1, Object s2) {
if (s1 == null) {
return (s2 == null);
}
if (s2 == null) {
return false;
}
return s1.equals(s2);
}
/**
* Returns true if the array s1 contains the same objects as s2 independent of order
* and allowing for null values
* @param s1
* @param s2
* @return
*/
public static boolean equivalentArray(Object[] s1, Object[] s2) {
if (s1 == null) {
return (s2 == null);
}
if (s2 == null) {
return false;
}
if (s1.length != s2.length) {
return false;
}
for (int i = 0; i < s1.length; i++) {
boolean found = false;
for (int j = 0; j < s2.length; j++) {
if (equalsWithNull(s1[i], s2[j])) {
found = true;
break;
}
}
if (!found) {
return false;
}
}
return true;
}
/**
* @param annotator
* @return
*/
public static String verifyAnnotator(String annotator) {
if (!annotator.startsWith("Person:") && !annotator.startsWith("Tool:") &&
!annotator.startsWith("Organization:")) {
return "Annotator does not start with Person:, Organization:, or Tool";
} else {
return null;
}
}
/**
* @param externalDocumentId
* @return
*/
public static boolean isValidExternalDocRef(String externalDocumentId) {
return SpdxRdfConstants.EXTERNAL_DOC_REF_PATTERN.matcher(externalDocumentId).matches();
}
}