import java.io.File;
import java.io.InputStream;
import java.net.URI;
import java.net.URISyntaxException;
import javax.xml.stream.XMLInputFactory;
import javax.xml.stream.XMLStreamReader;
import org.apache.commons.io.IOUtils;
import org.docx4j.XmlUtils;
import org.docx4j.docProps.coverPageProps.CoverPageProperties;
import org.docx4j.events.PackageIdentifier;
import org.docx4j.events.PackageIdentifierTransient;
import org.docx4j.jaxb.Context;
import org.docx4j.model.datastorage.CustomXmlDataStorage;
import org.docx4j.openpackaging.Base;
import org.docx4j.openpackaging.PackageRelsUtil;
import org.docx4j.openpackaging.URIHelper;
import org.docx4j.openpackaging.contenttype.ContentType;
import org.docx4j.openpackaging.contenttype.ContentTypeManager;
import org.docx4j.openpackaging.exceptions.Docx4JException;
import org.docx4j.openpackaging.exceptions.InvalidFormatException;
import org.docx4j.openpackaging.exceptions.PartUnrecognisedException;
import org.docx4j.openpackaging.io.ExternalResourceUtils;
import org.docx4j.openpackaging.io.Load;
import org.docx4j.openpackaging.io3.stores.PartStore;
import org.docx4j.openpackaging.io3.stores.ZipPartStore;
import org.docx4j.openpackaging.packages.OpcPackage;
import org.docx4j.openpackaging.packages.WordprocessingMLPackage;
import org.docx4j.openpackaging.parts.DefaultXmlPart;
import org.docx4j.openpackaging.parts.DocPropsCoverPagePart;
import org.docx4j.openpackaging.parts.Part;
import org.docx4j.openpackaging.parts.PartName;
import org.docx4j.openpackaging.parts.XmlPart;
import org.docx4j.openpackaging.parts.WordprocessingML.BibliographyPart;
import org.docx4j.openpackaging.parts.WordprocessingML.BinaryPart;
import org.docx4j.openpackaging.parts.WordprocessingML.MainDocumentPart;
import org.docx4j.openpackaging.parts.opendope.ComponentsPart;
import org.docx4j.openpackaging.parts.opendope.ConditionsPart;
import org.docx4j.openpackaging.parts.opendope.QuestionsPart;
import org.docx4j.openpackaging.parts.opendope.StandardisedAnswersPart;
import org.docx4j.openpackaging.parts.opendope.XPathsPart;
import org.docx4j.openpackaging.parts.relationships.Namespaces;
import org.docx4j.openpackaging.parts.relationships.RelationshipsPart;
import org.docx4j.relationships.Relationship;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import jakarta.xml.bind.JAXBElement;
import jakarta.xml.bind.Unmarshaller;
public class OpenCustom
{
public static void main
(String[] args
) throws Exception {
String inputfilepath
= System.
getProperty("user.dir")
+ "/sample-docs/sample-docx.docx";
// Instead of
// WordprocessingMLPackage wordMLPackage = WordprocessingMLPackage
// .load(new java.io.File(inputfilepath));
File file
= new java.
io.
File(inputfilepath
);
final ZipPartStore partLoader
= new ZipPartStore
(file
);
final MyLoader loader
= new MyLoader
(partLoader
);
WordprocessingMLPackage
wordMLPackage = (WordprocessingMLPackage
)loader.
get();
wordMLPackage.
setNew(false);
PackageIdentifier pkgIdentifier
= new PackageIdentifierTransient
(file.
getName());
wordMLPackage.
setName(pkgIdentifier.
name());
MainDocumentPart documentPart
= wordMLPackage.
getMainDocumentPart();
System.
out.
println(documentPart.
getXML());
}
static class MyLoader
extends Load
{
private static Logger log
= LoggerFactory.
getLogger(MyLoader.
class);
private PartStore partStore
;
public MyLoader
(PartStore partLoader
) {
this.
partStore = partLoader
;
}
public MyLoader
() {
throw new RuntimeException();
}
/**
* By setting this, you can load the contents into
* this existing package (ie instead of returning a new one).
*
* @param existingPkg
* @since 3.3.7
*/
public void reuseExistingOpcPackage
(OpcPackage existingPkg
) {
this.
existingPkg = existingPkg
;
}
private OpcPackage
existingPkg = null;
public OpcPackage get
() throws Docx4JException
{
long startTime
= System.
currentTimeMillis();
// 1. Get [Content_Types].xml
ContentTypeManager ctm
= new ContentTypeManager
();
InputStream is
= null;
try {
is
= partStore.
loadPart("[Content_Types].xml");
ctm.
parseContentTypesFile(is
);
} catch (Docx4JException e
) {
throw new Docx4JException
("Couldn't get [Content_Types].xml from ZipFile", e
);
} catch (NullPointerException e
) {
throw new Docx4JException
("Couldn't get [Content_Types].xml from ZipFile", e
);
} finally {
IOUtils.
closeQuietly(is
);
}
// .. now find the name of the main part
RelationshipsPart rp
= RelationshipsPart.
createPackageRels();
populatePackageRels
(rp
);
String mainPartName
= PackageRelsUtil.
getNameOfMainPart(rp
);
PartName mainPartNameObj
;
if (mainPartName.
startsWith("/")) {
// OpenXML SDK 2.0 writes Target="/word/document.xml" (note leading "/")
mainPartNameObj
= new PartName
(mainPartName
);
} else {
// Microsoft Word, docx4j etc write Target="word/document.xml"
mainPartNameObj
= new PartName
("/" + mainPartName
);
}
String pkgContentType
= ctm.
getContentType(mainPartNameObj
);
// 2. Create a new Package; this'll return the appropriate subclass
OpcPackage
p = ctm.
createPackage(pkgContentType
);
if (existingPkg
==null) {
p
= ctm.
createPackage(pkgContentType
);
} else {
if (existingPkg.
getClass()!=p.
getClass()) {
throw new Docx4JException
("Can't fill " + existingPkg.
getClass().
getName()
+ " with " + p.
getClass().
getName() + " contents." );
}
log.
info("loading into (re-using) existing package object " + existingPkg.
hashCode());
existingPkg.
reset();
existingPkg.
setPartName(new PartName
("/",
false));
existingPkg.
setContentTypeManager(ctm
);
p
= existingPkg
;
}
log.
info("Instantiated package of type " + p.
getClass().
getName() );
p.
setSourcePartStore(partStore
);
p.
setRelationships(rp
);
rp.
setSourceP(p
); //
// 5. Now recursively
// (i) create new Parts for each thing listed
// in the relationships
// (ii) add the new Part to the package
// (iii) cross the PartName off unusedZipEntries
addPartsFromRelationships
(p, rp, ctm
);
// 6.
registerCustomXmlDataStorageParts
(p
);
// partStore.finishLoad();
existingPkg
= null;
long endTime
= System.
currentTimeMillis();
log.
info("package read; elapsed time: " + Math.
round((endTime
-startTime
)) + " ms" );
return p
;
}
private void populatePackageRels
(RelationshipsPart rp
)
throws Docx4JException
{
InputStream is
= null;
try {
is
= partStore.
loadPart( "_rels/.rels");
if (is
==null) {
throw new Docx4JException
("_rels/.rels appears to be missing from this package!");
}
rp.
unmarshal(is
);
} catch (Exception e
) {
throw new Docx4JException
("Error getting document from Zipped Part: _rels/.rels " , e
);
} finally {
IOUtils.
closeQuietly(is
);
}
}
private RelationshipsPart getRelationshipsPartFromZip
(Base p,
String partName
)
throws Docx4JException
{
RelationshipsPart rp
= null;
InputStream is
= null;
try {
is
= partStore.
loadPart( partName
);
if (is
==null) {
return null; // that's ok
}
rp
= p.
getRelationshipsPart(true);
rp.
unmarshal(is
);
} catch (Exception e
) {
e.
printStackTrace();
throw new Docx4JException
("Error getting document from Zipped Part:" + partName, e
);
} finally {
IOUtils.
closeQuietly(is
);
}
return rp
;
}
/* recursively
(i) create new Parts for each thing listed
in the relationships
(ii) add the new Part to the package
(iii) cross the PartName off unusedZipEntries
*/
private void addPartsFromRelationships
(
Base source, RelationshipsPart rp, ContentTypeManager ctm
)
throws Docx4JException
{
OpcPackage
pkg = source.
getPackage();
for ( Relationship r
: rp.
getRelationships().
getRelationship() ) {
log.
debug("\n For Relationship Id=" + r.
getId()
+ " Source is " + rp.
getSourceP().
getPartName()
+ ", Target is " + r.
getTarget()
+ ", type: " + r.
getType() );
// This is usually the first logged comment for
// a part, so start with a line break.
try {
getPart
(pkg, rp, r, ctm
);
} catch (Docx4JException e
) {
throw e
;
} catch (Exception e
) {
throw new Docx4JException
("Failed to add parts from relationships", e
);
}
}
}
/**
* Get a Part (except a relationships part), and all its related parts.
* This can be called directly from outside the library, in which case
* the Part will not be owned by a Package until the calling code makes it so.
*
* @param zf
* @param source
* @param unusedZipEntries
* @param pkg
* @param r
* @param resolvedPartUri
* @throws Docx4JException
* @throws InvalidFormatException
*/
private void getPart
(OpcPackage pkg, RelationshipsPart rp,
Relationship r, ContentTypeManager ctm
)
throws Docx4JException, InvalidFormatException, URISyntaxException
{
Base source
= null;
String resolvedPartUri
= null;
if (r.
getType().
equals(Namespaces.
HYPERLINK)) {
// Could be Internal or External
// Example of Internal is w:drawing/wp:inline/wp:docPr/a:hlinkClick
log.
debug("Encountered (but not loading) hyperlink " + r.
getTarget() );
return;
} else
if (r.
getTargetMode() == null
|| !r.
getTargetMode().
equals("External") ) {
// Usual case
source
= rp.
getSourceP();
resolvedPartUri
= URIHelper.
resolvePartUri(rp.
getSourceURI(),
new URI
(r.
getTarget() ) ).
toString();
// Now drop leading "/'
resolvedPartUri
= resolvedPartUri.
substring(1
);
// Now normalise it .. ie abc/def/../ghi
// becomes abc/ghi
// Maybe this isn't necessary with a zip file,
// - ZipFile class may be smart enough to do it.
// But it is certainly necessary in the JCR case.
// resolvedPartUri = (new java.net.URI(resolvedPartUri)).normalize().toString();
// log.info("Normalised, it is " + resolvedPartUri );
} else {
// EXTERNAL
if (loadExternalTargets
&&
r.
getType().
equals( Namespaces.
IMAGE ) ) {
// It could instead be, for example, of type hyperlink,
// and we don't want to try to fetch that
log.
debug("Loading external resource " + r.
getTarget()
+ " of type " + r.
getType() );
BinaryPart bp
= ExternalResourceUtils.
getExternalResource(r.
getTarget());
pkg.
getExternalResources().
put(bp.
getExternalTarget(), bp
);
} else {
log.
debug("Encountered (but not loading) external resource " + r.
getTarget()
+ " of type " + r.
getType() );
}
return;
}
String relationshipType
= r.
getType();
Part part
;
if (pkg.
handled.
get(resolvedPartUri
)!=null) {
// The source Part (or Package) might have a convenience
// method for this
part
= pkg.
getParts().
getParts().
get(new PartName
("/" + resolvedPartUri
));
if (source.
setPartShortcut(part, relationshipType
) ) {
log.
debug("Convenience method established from " + source.
getPartName()
+ " to " + part.
getPartName());
}
// v3.2.1: also note this additional source rel
part.
getSourceRelationships().
add(r
);
return;
}
part
= getRawPart
(ctm, resolvedPartUri, r, rp
); // will throw exception if null
// The source Part (or Package) might have a convenience
// method for this
if (source.
setPartShortcut(part, relationshipType
) ) {
log.
debug("Convenience method established from " + source.
getPartName()
+ " to " + part.
getPartName());
}
if (part
instanceof BinaryPart
|| part
instanceof DefaultXmlPart
) {
// The constructors of other parts should take care of this...
part.
setRelationshipType(relationshipType
);
}
rp.
loadPart(part, r
);
// That loads a pre-existing target part into the package
// (but does not load its contents as such; that is
// done elsewhere).
pkg.
handled.
put(resolvedPartUri, resolvedPartUri
);
// unusedZipEntries.put(resolvedPartUri, new Boolean(false));
RelationshipsPart rrp
= getRelationshipsPart
(part
);
if (rrp
!=null) {
// recurse via this parts relationships, if it has any
addPartsFromRelationships
(part, rrp, ctm
);
// String relPart = PartName.getRelationshipsPartName(
// part.getPartName().getName().substring(1) );
// unusedZipEntries.put(relPart, new Boolean(false));
}
}
/**
* Get the Relationships Part (if there is one) for a given Part.
* Otherwise return null.
*
* @param zf
* @param part
* @return
* @throws InvalidFormatException
*/
public RelationshipsPart getRelationshipsPart
(Part part
)
throws Docx4JException, InvalidFormatException
{
RelationshipsPart rrp
= null;
// recurse via this parts relationships, if it has any
//String relPart = PartName.getRelationshipsPartName(target);
String relPart
= PartName.
getRelationshipsPartName(
part.
getPartName().
getName().
substring(1
) );
rrp
= getRelationshipsPartFromZip
(part, relPart
);
part.
setRelationships(rrp
);
// if (partStore.partExists(relPart)) {
// //if (partByteArrays.get(relPart) !=null ) {
// log.debug("Found relationships " + relPart );
// rrp = getRelationshipsPartFromZip(part, relPart);
// part.setRelationships(rrp);
// } else {
// log.debug("No relationships " + relPart );
// return null;
// }
return rrp
;
}
/**
* Get a Part (except a relationships part), but not its relationships part
* or related parts. Useful if you need quick access to just this part.
* This can be called directly from outside the library, in which case
* the Part will not be owned by a Package until the calling code makes it so.
* @see To get a Part and all its related parts, and add all to a package, use
* getPart.
* @param partByteArrays
* @param ctm
* @param resolvedPartUri
* @param rel
* @return
* @throws Docx4JException including if result is null
*/
public Part getRawPart
(
ContentTypeManager ctm,
String resolvedPartUri, Relationship rel, RelationshipsPart rp
/* for error logging */)
throws Docx4JException
{
Part part
= null;
InputStream is
= null;
try {
try {
log.
debug("resolved uri: " + resolvedPartUri
);
// Get a subclass of Part appropriate for this content type
// This will throw UnrecognisedPartException in the absence of
// specific knowledge. Hence it is important to get the InputStream
// first, as we do above.
part
= ctm.
getPart("/" + resolvedPartUri, rel
);
if (log.
isDebugEnabled() && part
!=null) {
log.
debug("ctm returned " + part.
getClass().
getName() );
}
if (part
instanceof org.
docx4j.
openpackaging.
parts.
ThemePart
|| part
instanceof org.
docx4j.
openpackaging.
parts.
DocPropsCorePart
|| part
instanceof org.
docx4j.
openpackaging.
parts.
DocPropsCustomPart
|| part
instanceof org.
docx4j.
openpackaging.
parts.
DocPropsExtendedPart
|| part
instanceof org.
docx4j.
openpackaging.
parts.
CustomXmlDataStoragePropertiesPart
// || part.getClass().getName().equals("org.docx4j.openpackaging.parts.digitalsignature.XmlSignaturePart")
|| part
instanceof org.
docx4j.
openpackaging.
parts.
JaxbXmlPart) {
// Nothing to do here
} else if (part
instanceof org.
docx4j.
openpackaging.
parts.
WordprocessingML.
BinaryPart) {
log.
debug("Detected BinaryPart " + part.
getClass().
getName() );
// Note that this is done lazily, since the below lines are commented out
// is = partStore.loadPart( resolvedPartUri);
// ((BinaryPart)part).setBinaryData(is);
} else if (part
instanceof org.
docx4j.
openpackaging.
parts.
CustomXmlDataStoragePart ) {
// ContentTypeManager initially detects them as CustomXmlDataStoragePart;
// the below changes as necessary
// Is it a part we know?
is
= partStore.
loadPart( resolvedPartUri
);
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
);
Unmarshaller u
= Context.
jc.
createUnmarshaller();
Object o
= u.
unmarshal( xsr
);
log.
debug(o.
getClass().
getName());
PartName name
= part.
getPartName();
if (o
instanceof CoverPageProperties
) {
part
= new DocPropsCoverPagePart
(name
);
((DocPropsCoverPagePart
)part
).
setJaxbElement(
(CoverPageProperties
)o
);
} else
if (o
instanceof org.
opendope.
conditions.
Conditions) {
part
= new ConditionsPart
(name
);
((ConditionsPart
)part
).
setJaxbElement(
(org.
opendope.
conditions.
Conditions)o
);
} else if (o
instanceof org.
opendope.
xpaths.
Xpaths) {
part
= new XPathsPart
(name
);
((XPathsPart
)part
).
setJaxbElement(
(org.
opendope.
xpaths.
Xpaths)o
);
} else if (o
instanceof org.
opendope.
questions.
Questionnaire) {
part
= new QuestionsPart
(name
);
((QuestionsPart
)part
).
setJaxbElement(
(org.
opendope.
questions.
Questionnaire)o
);
} else if (o
instanceof org.
opendope.
answers.
Answers) {
part
= new StandardisedAnswersPart
(name
);
((StandardisedAnswersPart
)part
).
setJaxbElement(
(org.
opendope.
answers.
Answers)o
);
} else if (o
instanceof org.
opendope.
components.
Components) {
part
= new ComponentsPart
(name
);
((ComponentsPart
)part
).
setJaxbElement(
(org.
opendope.
components.
Components)o
);
} else if (o
instanceof JAXBElement
<?>
&& XmlUtils.
unwrap(o
) instanceof org.
docx4j.
bibliography.
CTSources) {
part
= new BibliographyPart
(name
);
((BibliographyPart
)part
).
setJaxbElement(
(JAXBElement
<org.
docx4j.
bibliography.
CTSources>)o
);
} else {
log.
error("TODO: handle known CustomXmlPart part " + o.
getClass().
getName());
CustomXmlDataStorage data
= getCustomXmlDataStorageClass
().
factory();
is.
reset();
data.
setDocument(is
); // Not necessarily JAXB, that's just our method name
((org.
docx4j.
openpackaging.
parts.
CustomXmlDataStoragePart)part
).
setData(data
);
}
} catch (jakarta.
xml.
bind.
UnmarshalException ue
) {
log.
info("No JAXB model for this CustomXmlDataStorage part; " + ue.
getMessage() );
CustomXmlDataStorage data
= getCustomXmlDataStorageClass
().
factory();
is.
reset();
data.
setDocument(is
); // Not necessarily JAXB, that's just our method name
((org.
docx4j.
openpackaging.
parts.
CustomXmlDataStoragePart)part
).
setData(data
);
}
} else if (part
instanceof org.
docx4j.
openpackaging.
parts.
XmlPart ) {
is
= partStore.
loadPart( resolvedPartUri
);
// try {
((XmlPart
)part
).
setDocument(is
);
// Experimental 22/6/2011; don't fall back to binary (which we used to)
// } catch (Docx4JException d) {
// // This isn't an XML part after all,
// // even though ContentTypeManager detected it as such
// // So get it as a binary part
// part = getBinaryPart(partByteArrays, ctm, resolvedPartUri);
// log.warn("Could not parse as XML, so using BinaryPart for "
// + resolvedPartUri);
// ((BinaryPart)part).setBinaryData(is);
// }
} else {
// Shouldn't happen, since ContentTypeManagerImpl should
// return an instance of one of the above, or throw an
// Exception.
log.
error("No suitable part found for: " + resolvedPartUri
);
part
= null;
}
} catch (PartUnrecognisedException e
) {
log.
error("PartUnrecognisedException shouldn't happen anymore!", e
);
// Try to get it as a binary part
part
= getBinaryPart
(ctm, resolvedPartUri
);
log.
warn("Using BinaryPart for " + resolvedPartUri
);
// is = partStore.loadPart( resolvedPartUri);
// ((BinaryPart)part).setBinaryData(is);
}
} catch (Exception ex
) {
// IOException, URISyntaxException
ex.
printStackTrace();
throw new Docx4JException
("Failed to getPart", ex
);
} finally {
IOUtils.
closeQuietly(is
);
}
if (part
== null) {
throw new Docx4JException
("For source " + rp.
getSourceP().
getPartName() + ", cannot find part " + resolvedPartUri
+ " from rel "+ rel.
getId() + "=" + rel.
getTarget());
}
return part
;
}
public Part getBinaryPart
(
ContentTypeManager ctm,
String resolvedPartUri
)
throws Docx4JException
{
Part part
= null;
InputStream is
= null;
try {
is
= partStore.
loadPart(resolvedPartUri
);
//in = partByteArrays.get(resolvedPartUri).getInputStream();
part
= new BinaryPart
( new PartName
("/" + resolvedPartUri
));
// Set content type
part.
setContentType(
new ContentType
(
ctm.
getContentType(new PartName
("/" + resolvedPartUri
)) ) );
((BinaryPart
)part
).
setBinaryData(is
);
log.
info("Stored as BinaryData" );
} catch (Exception ioe
) {
ioe.
printStackTrace() ;
} finally {
IOUtils.
closeQuietly(is
);
}
return part
;
}
}
}
Parsed in 0.058 seconds, using
GeSHi 1.0.8.4
Posted: Sat Jun 01, 2024 11:45 am