org.spdx.html.MustacheMap 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.html;

import java.util.Arrays;
import java.util.Comparator;
import java.util.List;
import java.util.Map;

import org.spdx.rdfparser.InvalidSPDXAnalysisException;
import org.spdx.rdfparser.SPDXReview;
import org.spdx.rdfparser.license.AnyLicenseInfo;
import org.spdx.rdfparser.license.ExtractedLicenseInfo;
import org.spdx.rdfparser.license.SimpleLicensingInfo;
import org.spdx.rdfparser.model.Annotation;
import org.spdx.rdfparser.model.ExternalDocumentRef;
import org.spdx.rdfparser.model.Relationship;
import org.spdx.rdfparser.model.SpdxDocument;
import org.spdx.rdfparser.model.SpdxFile;
import org.spdx.rdfparser.model.SpdxItem;
import org.spdx.rdfparser.model.SpdxPackage;
import org.spdx.rdfparser.model.SpdxSnippet;

import com.google.common.collect.Lists;
import com.google.common.collect.Maps;

/**
 * Provides a hashmap which maps the Mustache template strings to SPDX Document
 * methods and strings.  The constants are used in the SpdxHTMLTemplate.html file
 * in the resources directory.
 * 
 * Note that the Mustache variable names are the tag values in the SPDX specification
 * 
 * @author Gary O'Neall
 *
 */
public class MustacheMap {

	public static Map buildDocMustachMap(SpdxDocument doc,
			Map spdxIdToUrl) throws InvalidSPDXAnalysisException {
		Map  retval = Maps.newHashMap();
		// Document level information
		retval.put("documentName", doc.getName());
		retval.put("documentNamespace", doc.getDocumentNamespace());
		retval.put("specVersion", doc.getSpecVersion());
		retval.put("dataLicense", getDataLicenseName(doc));
		retval.put("creationInfo", new CreatorInfoContext(doc));
		retval.put("docComment", doc.getComment());
		Annotation[] sortedAnnotations = doc.getAnnotations();
		Arrays.sort(sortedAnnotations);
		List annotations = Arrays.asList(sortedAnnotations);
		retval.put("annotations", annotations);
		List relationships = getRelationshipContexts(
				doc.getRelationships(), spdxIdToUrl);
		retval.put("relationships", relationships);
		ExternalDocumentRef[] sortedDocRefs = doc.getExternalDocumentRefs();
		Arrays.sort(sortedDocRefs);
		List externalDocumentReferences = 
				Arrays.asList(sortedDocRefs);
		retval.put("externalDocRelationships", externalDocumentReferences);
		retval.put("reviewed", getReviewers(doc));
		SpdxItem[] describedItems = doc.getDocumentDescribes();
		Arrays.sort(describedItems, new Comparator() {

			@Override
			public int compare(SpdxItem o1, SpdxItem o2) {
				if (o1 == null || o1.getId() == null) {
					if (o2 != null && o2.getId() != null) {
						return 1;
					}
				}
				if (o2 == null || o2.getId() == null) {
					return -1;
				}
				return o1.getId().compareTo(o2.getId());
			}
			
		});
		List describedPkgs = Lists.newArrayList();
		List describedFiles = Lists.newArrayList();
		for (int i = 0; i < describedItems.length; i++) {
			if (describedItems[i] instanceof SpdxPackage) {
				describedPkgs.add(new ElementContext(describedItems[i], spdxIdToUrl));
			} else if (describedItems[i] instanceof SpdxFile) {
				describedFiles.add(new ElementContext(describedItems[i], spdxIdToUrl));
			}
		}
		
		retval.put("describesPackage", describedPkgs);
		retval.put("describesFile", describedFiles);
		retval.put("hasExtractedLicensingInfo", getExtractedLicensingInfo(doc, spdxIdToUrl));
		return retval;
	}
	
	/**
	 * @param relationships
	 * @return
	 */
	private static List getRelationshipContexts(
			Relationship[] relationships, Map spdxIdToUrl) {
	    List retval = Lists.newArrayList();
	    
	    if (relationships != null) {
	        Arrays.sort(relationships);
		
    		for (Relationship relationship : relationships) {
    		    retval.add(new RelationshipContext(relationship, spdxIdToUrl));
    		}
	    }
	    
		return retval;
	}

	/**
	 * @param doc
	 * @param files
	 * @param spdxIdToUrl
	 * @return
	 * @throws InvalidSPDXAnalysisException 
	 */
	public static Map buildDocFileMustacheMap(SpdxDocument doc, SpdxFile[] files,
			Map spdxIdToUrl, Map> fileIdToSnippets) throws InvalidSPDXAnalysisException {
		Map retval = Maps.newHashMap();
		retval.put("about", "SPDX Document "+doc.getName());
		SpdxItem[] describedItems = doc.getDocumentDescribes();
		Arrays.sort(describedItems, new Comparator() {

			@Override
			public int compare(SpdxItem o1, SpdxItem o2) {
				if (o1 == null || o1.getId() == null) {
					if (o2 != null && o2.getId() != null) {
						return 1;
					}
				}
				if (o2 == null || o2.getId() == null) {
					return -1;
				}
				return o1.getId().compareTo(o2.getId());
			}
			
		});
		List describedFiles = Lists.newArrayList();
		for (int i = 0; i < describedItems.length; i++) {
			if (describedItems[i] instanceof SpdxFile) {
				describedFiles.add(new FileContext((SpdxFile)describedItems[i],spdxIdToUrl, fileIdToSnippets));
			}
		}
		retval.put("hasFile", describedFiles);
		return retval;
	}
	
	private static List getExtractedLicensingInfo(SpdxDocument doc, Map spdxIdToUrl) {
		List retval = Lists.newArrayList();
		try {
			ExtractedLicenseInfo[] extractedLicenseInfos = doc.getExtractedLicenseInfos();
			Arrays.sort(extractedLicenseInfos, new Comparator() {

				@Override
				public int compare(ExtractedLicenseInfo o1,
						ExtractedLicenseInfo o2) {
					if (o1 == null || o2.getLicenseId() == null) {
						if (o2 != null && o2.getLicenseId() != null) {
							return 1;
						}
					}
					if (o2 == null || o2.getLicenseId() == null) {
						return -1;
					}
					return o1.getLicenseId().compareTo(o2.getLicenseId());
				}
				
			});
			for (int i = 0;i < extractedLicenseInfos.length; i++) {
				retval.add(new ExtractedLicensingInfoContext(extractedLicenseInfos[i], spdxIdToUrl));
			}
		} catch (InvalidSPDXAnalysisException e) {
			retval.add(new ExtractedLicensingInfoContext(e));
		}
		return retval;
	}


	/**
	 * @param doc
	 * @return
	 */
	private static List getReviewers(SpdxDocument doc) {
		List retval = Lists.newArrayList();
		try {
			@SuppressWarnings("deprecation")
			SPDXReview[] reviewers = doc.getReviewers();
			if (reviewers != null) {
				for (int i = 0; i < reviewers.length; i++) {
					retval.add(new ReviewerContext(reviewers[i]));
				}
			}
		} catch (InvalidSPDXAnalysisException e) {
			retval.add(new ReviewerContext(e));
		}
		return retval;
	}


	/**
	 * @param doc
	 * @return
	 * @throws InvalidSPDXAnalysisException 
	 */
	private static String getDataLicenseName(SpdxDocument doc) throws InvalidSPDXAnalysisException {
		AnyLicenseInfo dataLicense = doc.getDataLicense();
		if (dataLicense != null) {
			if (dataLicense instanceof SimpleLicensingInfo) {
				return ((SimpleLicensingInfo)dataLicense).getName();
			} else {
				return dataLicense.toString();
			}			
		} else {
			return "NONE";
		}
	}

	/**
	 * @param doc
	 * @param spdxIdToUrl
	 * @return
	 */
	public static Map buildExtractedLicMustachMap(SpdxDocument doc, Map spdxIdToUrl) {
		Map retval = Maps.newHashMap();
		retval.put("hasExtractedLicensingInfo", getExtractedLicensingInfo(doc, spdxIdToUrl));
		return retval;
	}

	/**
	 * @param pkg
	 * @param spdxIdToUrl
	 * @return
	 * @throws InvalidSPDXAnalysisException 
	 */
	public static Map buildPkgFileMap(SpdxPackage pkg,
			Map spdxIdToUrl, Map> fileIdToSnippets) throws InvalidSPDXAnalysisException {
		Map retval = Maps.newHashMap();
		retval.put("about", "SPDX Package "+pkg.getName());
		SpdxFile[] files = pkg.getFiles();
		Arrays.sort(files, new Comparator() {

			@Override
			public int compare(SpdxFile o1, SpdxFile o2) {
				if (o1 == null || o1.getName() == null) {
					if (o2 != null && o2.getName() != null) {
						return 1;
					}
				}
				if (o2 == null || o2.getName() == null) {
					return -1;
				}
				return o1.getName().compareTo(o2.getName());
			}
			
		});
		List alFiles = Lists.newArrayList();
		for (int i = 0; i < files.length; i++) {
			if (files[i] != null) {
				alFiles.add(new FileContext(files[i], spdxIdToUrl, fileIdToSnippets));
			}
		}
		retval.put("hasFile", alFiles);
		return retval;
	}

	/**
	 * @param doc
	 * @param spdxIdToUrl
	 * @return
	 */
	public static Map buildSnippetMustachMap(SpdxDocument doc,
			Map spdxIdToUrl) {
		List snippetContexts = Lists.newArrayList();
		try {
			List snippets = doc.getDocumentContainer().findAllSnippets();
			for (SpdxSnippet snippet:snippets) {
				snippetContexts.add(new SnippetContext(snippet, spdxIdToUrl));
			}
		} catch (InvalidSPDXAnalysisException e) {
			snippetContexts.add(new SnippetContext(e));
		}
		Map retval = Maps.newHashMap();
		retval.put("snippets", snippetContexts);
		return retval;
	}
}