/*
* Copyright 2007-2008, Plutext Pty Ltd.
*
* This file is part of docx4j.
docx4j 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.openpackaging.parts;
import java.util.HashMap;
import java.util.Map;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Unmarshaller;
import javax.xml.stream.XMLInputFactory;
import javax.xml.stream.XMLStreamReader;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.docx4j.docProps.custom.Properties;
import org.docx4j.docProps.custom.Properties.Property;
import org.docx4j.jaxb.Context;
import org.docx4j.openpackaging.exceptions.InvalidFormatException;
import org.docx4j.openpackaging.parts.relationships.Namespaces;
/**
* @author jharrop
*
*/
public class DocPropsCustomPart extends JaxbXmlPart<Properties> {
/* Specification > Shared ML > Metadata > Custom Properties
*
*/
/*
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Properties
xmlns="http://schemas.openxmlformats.org/officeDocument/2006/custom-properties"
xmlns:vt="http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes">
<property fmtid="{D5CDD505-2E9C-101B-9397-08002B2CF9AE}" pid="2" name="Grouping">
<vt:lpwstr>p</vt:lpwstr>
</property>
<property fmtid="{D5CDD505-2E9C-101B-9397-08002B2CF9AE}" pid="3" name="CheckinComments">
<vt:lpwstr>true</vt:lpwstr>
</property>
</Properties>
*/
private static Logger log = LoggerFactory.getLogger(DocPropsCustomPart.class);
/* fmtid (Format ID) Uniquely relates a custom property with an OLE property.
*
* The value of this attribute is a Globally Unique Identifier in the form of
* {HHHHHHHH-HHHH-HHHH-HHHH-HHHHHHHH} where each H is a hexidecimal.
*
*
*/
public static final String fmtidValLpwstr = "{D5CDD505-2E9C-101B-9397-08002B2CF9AE}";
public static final String MARK_AS_FINAL = "_MarkAsFinal";
/**
* @throws InvalidFormatException
*/
public DocPropsCustomPart(PartName partName) throws InvalidFormatException {
super(partName);
init();
}
public DocPropsCustomPart() throws InvalidFormatException {
super(new PartName("/docProps/custom.xml"));
init();
}
public void init() {
setJAXBContext(Context.jcDocPropsCustom);
// Used if this Part is added to [Content_Types].xml
setContentType(new org.docx4j.openpackaging.contenttype.ContentType(
org.docx4j.openpackaging.contenttype.ContentTypes.OFFICEDOCUMENT_CUSTOMPROPERTIES));
// Used when this Part is added to a rels
setRelationshipType(Namespaces.PROPERTIES_CUSTOM);
}
/**
* Unmarshal XML data from the specified InputStream and return the
* resulting content tree. Validation event location information may
* be incomplete when using this form of the unmarshal API.
*
* <p>
* Implements <a href="#unmarshalGlobal">Unmarshal Global Root Element</a>.
*
* @param is the InputStream to unmarshal XML data from
* @return the newly created root object of the java content tree
*
* @throws JAXBException
* If any unexpected errors occur while unmarshalling
*/
@Override
public Properties unmarshal( java.io.InputStream is ) throws JAXBException {
// TODO: delete this method?
try {
XMLInputFactory xif = XMLInputFactory.newInstance();
xif.setProperty(XMLInputFactory.IS_SUPPORTING_EXTERNAL_ENTITIES, false);
xif.setProperty(XMLInputFactory.SUPPORT_DTD, false); // a DTD is merely ignored, its presence doesn't cause an exception
XMLStreamReader xsr = xif.createXMLStreamReader(is);
// if (jc==null) {
// setJAXBContext(Context.jc);
// }
setJAXBContext(org.docx4j.jaxb.Context.jcDocPropsCustom);
Unmarshaller u = jc.createUnmarshaller();
//u.setSchema(org.docx4j.jaxb.WmlSchema.schema);
u.setEventHandler(new org.docx4j.jaxb.JaxbValidationEventHandler());
log.info("unmarshalling " + this.getClass().getName() );
jaxbElement = (Properties) u.unmarshal( xsr );
log.info("\n\n" + this.getClass().getName() + " unmarshalled \n\n" );
} catch (Exception e ) {
e.printStackTrace();
}
return jaxbElement;
}
public Property getProperty(String propName) {
for (org.docx4j.docProps.custom.Properties.Property prop: getJaxbElement().getProperty() ) {
if (prop.getName().equals(propName)) {
return prop;
}
}
return null;
}
public void setProperty(String propName, String propValue) {
// does it exist already?
org.docx4j.docProps.custom.Properties.Property newProp = getProperty(propName);
// If not, let's add one.
if (newProp==null) {
org.docx4j.docProps.custom.ObjectFactory factory = new org.docx4j.docProps.custom.ObjectFactory();
newProp = factory.createPropertiesProperty();
newProp.setName(propName);
newProp.setFmtid(fmtidValLpwstr ); // Magic string
newProp.setPid( getNextPid() );
getJaxbElement().getProperty().add(newProp);
}
if (!newProp.getFmtid().equals(fmtidValLpwstr )) {
log.warn("Wrong fmtid? This might not work...");
}
// set the value
newProp.setLpwstr(propValue);
}
/**
* @param propName
* @param propValue
*
* @since 3.3.0
*/
public void setProperty(String propName, boolean propValue) {
// does it exist already?
org.docx4j.docProps.custom.Properties.Property newProp = getProperty(propName);
// If not, let's add one.
if (newProp==null) {
org.docx4j.docProps.custom.ObjectFactory factory = new org.docx4j.docProps.custom.ObjectFactory();
newProp = factory.createPropertiesProperty();
newProp.setName(propName);
newProp.setFmtid(fmtidValLpwstr ); // Magic string
newProp.setPid( getNextPid() );
getJaxbElement().getProperty().add(newProp);
}
if (!newProp.getFmtid().equals(fmtidValLpwstr )) {
log.warn("Wrong fmtid? This might not work...");
}
// set the value
newProp.setBool(propValue);
}
/**
* Find the first available Pid
*
* @return
*/
public int getNextPid() {
int highestSeen = 1; // Lowest number Word 2007 seems to like is 2 (!)
org.docx4j.docProps.custom.Properties customProps = (org.docx4j.docProps.custom.Properties)getJaxbElement();
for (org.docx4j.docProps.custom.Properties.Property prop: customProps.getProperty() ) {
if (prop.getPid()>highestSeen) {
highestSeen =prop.getPid();
}
}
log.debug("Returning " + highestSeen+1);
return highestSeen+1;
}
/**
* @since 3.3.0
*/
public boolean getMarkAsFinal() {
Property prop = getProperty(MARK_AS_FINAL);
if (prop==null) return false;
return prop.isBool();
}
/**
* @since 3.3.0
*/
public void setMarkAsFinal(boolean val) {
setProperty(MARK_AS_FINAL, val);
}
//
//
///* Create an XML document from the Java object tree
// *
// */
//private Document marshall() {
//
//// <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
//// <Properties
//// xmlns="http://schemas.openxmlformats.org/officeDocument/2006/custom-properties"
//// xmlns:vt="http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes">
//// <property fmtid="{D5CDD505-2E9C-101B-9397-08002B2CF9AE}" pid="2" name="Grouping">
//// <vt:lpwstr>p</vt:lpwstr>
//// </property>
//// <property fmtid="{D5CDD505-2E9C-101B-9397-08002B2CF9AE}" pid="3" name="CheckinComments">
//// <vt:lpwstr>true</vt:lpwstr>
//// </property>
//// </Properties>
//
// Document doc = DocumentHelper.createDocument();
//
// // Note carefully how namespaces are handled here.
// // It seems we have to be syntactically identical to how
// // Word does it - semantic equivalence is not enough!
//
// Namespace docPropsVTypes = new Namespace("vt",
// "http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes");
//
// Element elDocument = doc.addElement("Properties",
// "http://schemas.openxmlformats.org/officeDocument/2006/custom-properties");
// elDocument.addNamespace("vt",
// "http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes");
//
// Integer pid = 2; // NB @pid="1" will cause Word to regard the document as corrupt.
// Iterator i = properties.entrySet().iterator();
// while (i.hasNext()) {
// Map.Entry e = (Map.Entry)i.next();
// Element property = elDocument.addElement("property",
// "http://schemas.openxmlformats.org/officeDocument/2006/custom-properties");
// property.addAttribute( "fmtid", fmtidVal);
// property.addAttribute( "pid", pid.toString() );
// property.addAttribute( "name", (String)e.getKey() );
// Element lpwstr = new DefaultElement(new QName("lpwstr", docPropsVTypes));
// lpwstr.setText( (String)e.getValue() );
// property.add(lpwstr);
// pid++;
// }
// return doc;
//}
}