/*
* 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.net.URI;
import java.util.ArrayList;
import java.util.List;
import org.docx4j.openpackaging.Base;
import org.docx4j.openpackaging.contenttype.ContentType;
import org.docx4j.openpackaging.exceptions.Docx4JException;
import org.docx4j.openpackaging.exceptions.InvalidFormatException;
import org.docx4j.openpackaging.packages.OpcPackage;
import org.docx4j.openpackaging.parts.relationships.RelationshipsPart;
import org.docx4j.relationships.Relationship;
import org.docx4j.relationships.Relationships;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* An abstraction of an Open Packaging Convention (OPC) Part.
*
* OPC Parts are either XML, or binary (or text) documents.
*
* Most are XML documents.
*
* docx4j aims to represent XML parts using JAXB. We have
* JAXB representations for all the common parts.
*
* To instantiate a Part use (or create) an appropriate subclass.
* When an existing document is being loaded, ContentTypeManager.getPart
* will instantiate the appropriate subclass.
*/
public abstract class Part extends Base {
/**
* Logger.
*/
protected static Logger log = LoggerFactory.getLogger(Part.class);
protected OpcPackage pack;
private List<Relationship> sourceRelationships = new ArrayList<Relationship>();
/**
* @since 2.7.1
*/
public List<Relationship> getSourceRelationships() {
// TODO: use this exclusively, instead of relationshipType
return sourceRelationships;
}
/**
* @return the sourceRelationship
*/
@Deprecated
public Relationship getSourceRelationship() {
return sourceRelationships.get(0);
}
/**
* NB a media part could be referenced from multiple
* source parts, but this method can only record one!
*
* @param sourceRelationship the sourceRelationship to set
*/
@Deprecated
public void setSourceRelationship(Relationship sourceRelationship) {
sourceRelationships.clear();
sourceRelationships.add(sourceRelationship);
}
/** The Namespace of this Part.
* Used when adding the Part to a relationship Part.
* TODO: set this when the Part is constructed.
*/
private String relationshipType;
public String getRelationshipType() {
if (relationshipType == null ) {
// 20091029, since we now have sourceRelationship,
// there is little point in also have relationshipType,
// except for a part which isn't yet connected to
// a package via a relationship.
if (this.sourceRelationships.size()==0) {
log.warn(this.getPartName().getName() + " has no source rel set");
return null;
} else {
// It ought to be the same in each source rel
return this.sourceRelationships.get(0).getType();
}
} else {
return relationshipType;
}
}
public void setRelationshipType(String relationshipType) {
this.relationshipType = relationshipType;
}
/** Every part is the target of some relationship,
* specified in a RelationshipsPart. Every part can also
* have its own RelationshipsPart - for that, see Base
* (since Package has one as well).
*/
private RelationshipsPart owningRelationshipPart;
// instead of Part.getOwningRelationshipPart(),
// we now have getSourceRelationships()
// TODO can't get OwningRelationshipPart from that
// (set that on the Relationships object?)
@Deprecated
public RelationshipsPart getOwningRelationshipPart() {
return owningRelationshipPart;
}
@Deprecated
public void setOwningRelationshipPart(
RelationshipsPart owningRelationshipPart) {
this.owningRelationshipPart = owningRelationshipPart;
}
private long contentLengthAsLoaded = -1;
/**
* returns the size in bytes of this part as stored,
* or -1 if unknown.
* @return the contentLengthAsLoaded
* @since 3.0.0
*/
public long getContentLengthAsLoaded() {
return contentLengthAsLoaded;
}
/**
* @param contentLengthAsLoaded the contentLengthAsLoaded to set
* @since 3.0.0
*/
protected void setContentLengthAsLoaded(long contentLengthAsLoaded) {
this.contentLengthAsLoaded = contentLengthAsLoaded;
}
public Part() {
}
/**
* Constructor.
*
* @param pack
* Parent package.
* @param partName
* The part name, relative to the parent Package root.
* @throws InvalidFormatException
* If the specified URI is not valid.
*/
public Part(PartName partName)
throws InvalidFormatException {
// log.debug( partName.getName() );
this.setPartName(partName);
}
/**
* Constructor.
*
* @param pack
* Parent package.
* @param partName
* The part name, relative to the parent Package root.
* @param contentType
* The Multipurpose Internet Mail Extensions (MIME) content type
* of the part's data stream.
*/
public Part(PartName partName,
String contentType) throws InvalidFormatException {
this(partName);
this.contentType = new ContentType(contentType);
}
public OpcPackage getPackage() {
if (pack==null) {
log.error("Package field null for this Part " + this.getClass().getName() );
} else if (log.isDebugEnabled() ) {
log.debug(pack.name());
}
return pack;
}
// TODO - this is not always set ...
// think through whether, and if so
// where and how it should be set
public void setPackage( OpcPackage pack) {
log.debug("setPackage to " + pack.name() + " called for " + this.getClass().getName() );
//(new Throwable()).printStackTrace();
this.pack = pack;
}
@Override
public boolean setPartShortcut(Part part, String relationshipType) {
return false;
}
// The version of this part.
// Useful for some applications, particularly where unzipped parts
// are stored in a document management system.
// This field is available for the use of client applications as
// they see fit.
private long version;
public void setVersion(long version) {
this.version = version;
}
public long getVersion() {
return version;
}
/**
* Rename this part. Useful when merging documents, if you need to
* take action to avoid name collisions.
*
* @param newName
* @since 3.2.0
*/
public void rename(PartName newName) {
log.info("Renaming part " + this.getPartName().getName() + " to " + newName.getName() );
// Remove this part
this.getPackage().getParts().remove(this.getPartName() );
// Update the source relationship
// Work out new target
URI tobeRelativized = newName.getURI();
URI relativizeAgainst = this.getOwningRelationshipPart().getSourceURI();
log.debug("Relativising target " + tobeRelativized
+ " against source " + relativizeAgainst);
String result = org.docx4j.openpackaging.URIHelper.relativizeURI(relativizeAgainst, tobeRelativized).toString();
if (relativizeAgainst.getPath().equals("/")
&& result.startsWith("/")) {
result = result.substring(1);
}
log.debug("Result " + result);
for (Relationship rel : sourceRelationships) {
rel.setTarget(result);
}
// Set the new part name
this.setPartName(newName);
// Add this part back to the parts collection
this.getPackage().getParts().put(this);
}
public abstract boolean isContentEqual(Part other) throws Docx4JException;
/**
* Remove this part from the pkg. Beware: it is up to you to make sure
* your content doesn't rely on this part being present! A symptom of
* that would be that Office now reports your file to be corrupt or in
* need of repair.
*
* @since 3.0.2
*/
public void remove() {
for (Relationship r : getSourceRelationships()) {
if (r.getParent()==null) {
log.warn("source rel of " + this.getPartName().getName() + " has no parent rels element");
} else if (
((Relationships)r.getParent()).getRelationship().remove(r)
) {
log.debug("Successfully removed rel " + r.getId() );
// we don't know which rels part Relationships belongs to, but it doesn't matter
} else {
log.warn("source rel of " + this.getPartName().getName() + " not present in parent rels element");
}
}
if (this.getPackage()==null) {
log.warn(this.getPartName().getName() + " not attached to any package");
} else {
this.getPackage().getParts().remove(getPartName());
// Note, this doesn't remove any child parts from that collection
}
}
}