org.docx4j.model.datastorage.CustomXmlDataStoragePartSelector Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of docx4j-core Show documentation
docx4j is a library which helps you to work with the Office Open XML file format as used in docx documents, pptx presentations, and xlsx spreadsheets.
There is a newer version: 11.4.11
Show newest version
/*
 *  Copyright 2010-14, Plutext Pty Ltd.
 *   
 *  This file is part of OpenDoPE Java simple webapp.

    OpenDoPE Java simple webapp is 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.docx4j.model.datastorage;

import org.docx4j.XmlUtils;
import org.docx4j.openpackaging.exceptions.Docx4JException;
import org.docx4j.openpackaging.packages.WordprocessingMLPackage;
import org.docx4j.openpackaging.parts.CustomXmlDataStoragePart;
import org.docx4j.openpackaging.parts.CustomXmlPart;
import org.docx4j.openpackaging.parts.WordprocessingML.MainDocumentPart;
import org.docx4j.openpackaging.parts.opendope.StandardisedAnswersPart;
import org.docx4j.utils.SingleTraversalUtilVisitorCallback;
import org.docx4j.utils.TraversalUtilVisitor;
import org.docx4j.wml.SdtElement;
import org.opendope.xpaths.Xpaths.Xpath;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.HashMap;
import java.util.List;

/**
 * Mechanism to find the user's XML data part
 * (typically to replace it with the runtime
 *  instance XML data).
 * 
 * @author jharrop
 * @since 3.0.1
 */
public class CustomXmlDataStoragePartSelector {
	
	protected static Logger log = LoggerFactory.getLogger(CustomXmlDataStoragePartSelector.class);
	
	
	/**
	 * We need the item id of the custom xml part.  
	 * It skips coverPageProps, properties and core-properties parts. 
	 *  
	 * @param wordMLPackage
	 * @return 
	 */
	public static CustomXmlPart getCustomXmlDataStoragePart(WordprocessingMLPackage wordMLPackage) throws Docx4JException {
		
		MainDocumentPart documentPart = wordMLPackage.getMainDocumentPart();	
		
		if (wordMLPackage.getMainDocumentPart().getXPathsPart()==null) {
			
			// Can't do it the easy way, so inspect content controls
			log.info("No XPaths part, so inspecting content controls to identify CustomXmlDataStoragePart");
			TraversalUtilCCVisitor visitor = new TraversalUtilCCVisitor();
			visitor.customXmlParts = wordMLPackage.getCustomXmlDataStorageParts();
			SingleTraversalUtilVisitorCallback ccFinder 
			= new SingleTraversalUtilVisitorCallback(visitor);
			ccFinder.walkJAXBElements(
				wordMLPackage.getMainDocumentPart().getJaxbElement().getBody());
			if (visitor.customXmlDataStoragePart==null) {
				log.error("FATAL. Couldn't find CustomXmlDataStoragePart  " );
				return null;
			} else {
				return visitor.customXmlDataStoragePart;
				
			}
			
		} else {
	
			org.opendope.xpaths.Xpaths xPaths = wordMLPackage.getMainDocumentPart().getXPathsPart().getJaxbElement();
			
			if (xPaths.getXpath().isEmpty()) {
				log.info("No xpaths found, so can't determine CustomXmlDataStoragePart from them" );
				return null;
			}
			
			for (Xpath xp : xPaths.getXpath()) {
				
				if (shouldSkip(xp.getDataBinding().getPrefixMappings())) {
					continue;
				}
				

				// OK, this one looks ok
				//System.out.println(xp.getDataBinding().getXpath());
				String itemId = xp.getDataBinding().getStoreItemID().toLowerCase();
				log.debug("Attempting to use item id: " + itemId);
								
				if (wordMLPackage.getCustomXmlDataStorageParts().get(itemId)==null) {

                    if(log.isWarnEnabled()) {
                        log.warn("Couldn't find CustomXmlDataStoragePart referenced from " + XmlUtils.marshaltoString(xp));

                    }
					continue;			
					
				} else {
					
					if (wordMLPackage.getCustomXmlDataStorageParts().get(itemId) instanceof CustomXmlDataStoragePart) {
						
						log.debug("Using " + xp.getDataBinding().getStoreItemID());
						return wordMLPackage.getCustomXmlDataStorageParts().get(itemId);

					} else if (wordMLPackage.getCustomXmlDataStorageParts().get(itemId) instanceof StandardisedAnswersPart) {
						
						log.debug("Using " + xp.getDataBinding().getStoreItemID());
						return wordMLPackage.getCustomXmlDataStorageParts().get(itemId);	
						
					} else {
						log.warn(wordMLPackage.getCustomXmlDataStorageParts().get(itemId).getClass().getName() + " --> can't cast");
						continue;			
					}
					
				}
								
				
			}
			log.error("Couldn't identify XML part from XPaths part entries");
			return null;
			
			
		}
	}
	
	private static boolean shouldSkip(String prefixMappings) {

		if (prefixMappings==null) return false;
		
		/*
		 * Skip:
		 * 
				
					
				

			 */
		if (prefixMappings.contains("http://schemas.microsoft.com/office/2006/coverPageProps")) {
			return true;
		}

		
		/*
		 * Skip:
		 * 
				
				
					
				

			 */
		if (prefixMappings.contains("http://schemas.microsoft.com/office/2006/metadata/properties")) {
			return true;
		}

		
		/*
		 * Skip:
		 * 
				
					
				
			 */
		if (prefixMappings.contains("http://schemas.openxmlformats.org/package/2006/metadata/core-properties")) {
			return true;
		}
		
		return false;
	}

	private static class TraversalUtilCCVisitor extends TraversalUtilVisitor {
		
		
		HashMap customXmlParts = null; 
		
		CustomXmlDataStoragePart customXmlDataStoragePart = null;
		
		@Override
		public void apply(SdtElement element, Object parent, List