/* ====================================================================
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You 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.apache.poi.openxml4j.opc.internal;
import java.io.InputStream;
import java.io.OutputStream;
import java.text.ParsePosition;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Locale;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.apache.poi.openxml4j.exceptions.InvalidFormatException;
import org.apache.poi.openxml4j.exceptions.InvalidOperationException;
import org.apache.poi.openxml4j.opc.ContentTypes;
import org.apache.poi.openxml4j.opc.OPCPackage;
import org.apache.poi.openxml4j.opc.PackagePart;
import org.apache.poi.openxml4j.opc.PackagePartName;
import org.apache.poi.openxml4j.opc.PackageProperties;
import org.apache.poi.openxml4j.util.Nullable;
import org.apache.poi.util.LocaleUtil;
/**
* Represents the core properties part of a package.
*
* @author Julien Chable
*/
public final class PackagePropertiesPart extends PackagePart implements
PackageProperties {
public final static String NAMESPACE_DC_URI = "http://purl.org/dc/elements/1.1/";
public final static String NAMESPACE_CP_URI = "http://schemas.openxmlformats.org/package/2006/metadata/core-properties";
public final static String NAMESPACE_DCTERMS_URI = "http://purl.org/dc/terms/";
private final static String DEFAULT_DATEFORMAT = "yyyy-MM-dd'T'HH:mm:ss'Z'";
private final static String[] DATE_FORMATS = new String[]{
DEFAULT_DATEFORMAT,
"yyyy-MM-dd'T'HH:mm:ss.SS'Z'",
"yyyy-MM-dd"
};
//Had to add this and TIME_ZONE_PAT to handle tz with colons.
//When we move to Java 7, we should be able to add another
//date format to DATE_FORMATS that uses XXX and get rid of this
//and TIME_ZONE_PAT
// TODO Fix this after the Java 7 upgrade
private final String[] TZ_DATE_FORMATS = new String[]{
"yyyy-MM-dd'T'HH:mm:ssz",
"yyyy-MM-dd'T'HH:mm:ss.Sz",
"yyyy-MM-dd'T'HH:mm:ss.SSz",
"yyyy-MM-dd'T'HH:mm:ss.SSSz",
};
private final Pattern TIME_ZONE_PAT = Pattern.compile("([-+]\\d\\d):?(\\d\\d)");
/**
* Constructor.
*
* @param pack
* Container package.
* @param partName
* Name of this part.
* @throws InvalidFormatException
* Throws if the content is invalid.
*/
public PackagePropertiesPart(OPCPackage pack, PackagePartName partName)
throws InvalidFormatException {
super(pack, partName, ContentTypes.CORE_PROPERTIES_PART);
}
/**
* A categorization of the content of this package.
*
* [Example: Example values for this property might include: Resume, Letter,
* Financial Forecast, Proposal, Technical Presentation, and so on. This
* value might be used by an application's user interface to facilitate
* navigation of a large set of documents. end example]
*/
protected Nullable<String> category = new Nullable<String>();
/**
* The status of the content.
*
* [Example: Values might include "Draft", "Reviewed", and "Final". end
* example]
*/
protected Nullable<String> contentStatus = new Nullable<String>();
/**
* The type of content represented, generally defined by a specific use and
* intended audience.
*
* [Example: Values might include "Whitepaper", "Security Bulletin", and
* "Exam". end example] [Note: This property is distinct from MIME content
* types as defined in RFC 2616. end note]
*/
protected Nullable<String> contentType = new Nullable<String>();
/**
* Date of creation of the resource.
*/
protected Nullable<Date> created = new Nullable<Date>();
/**
* An entity primarily responsible for making the content of the resource.
*/
protected Nullable<String> creator = new Nullable<String>();
/**
* An explanation of the content of the resource.
*
* [Example: Values might include an abstract, table of contents, reference
* to a graphical representation of content, and a free-text account of the
* content. end example]
*/
protected Nullable<String> description = new Nullable<String>();
/**
* An unambiguous reference to the resource within a given context.
*/
protected Nullable<String> identifier = new Nullable<String>();
/**
* A delimited set of keywords to support searching and indexing. This is
* typically a list of terms that are not available elsewhere in the
* properties.
*/
protected Nullable<String> keywords = new Nullable<String>();
/**
* The language of the intellectual content of the resource.
*
* [Note: IETF RFC 3066 provides guidance on encoding to represent
* languages. end note]
*/
protected Nullable<String> language = new Nullable<String>();
/**
* The user who performed the last modification. The identification is
* environment-specific.
*
* [Example: A name, email address, or employee ID. end example] It is
* recommended that this value be as concise as possible.
*/
protected Nullable<String> lastModifiedBy = new Nullable<String>();
/**
* The date and time of the last printing.
*/
protected Nullable<Date> lastPrinted = new Nullable<Date>();
/**
* Date on which the resource was changed.
*/
protected Nullable<Date> modified = new Nullable<Date>();
/**
* The revision number.
*
* [Example: This value might indicate the number of saves or revisions,
* provided the application updates it after each revision. end example]
*/
protected Nullable<String> revision = new Nullable<String>();
/**
* The topic of the content of the resource.
*/
protected Nullable<String> subject = new Nullable<String>();
/**
* The name given to the resource.
*/
protected Nullable<String> title = new Nullable<String>();
/**
* The version number. This value is set by the user or by the application.
*/
protected Nullable<String> version = new Nullable<String>();
/*
* Getters and setters
*/
/**
* Get the category property.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#getCategoryProperty()
*/
public Nullable<String> getCategoryProperty() {
return category;
}
/**
* Get content status.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#getContentStatusProperty()
*/
public Nullable<String> getContentStatusProperty() {
return contentStatus;
}
/**
* Get content type.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#getContentTypeProperty()
*/
public Nullable<String> getContentTypeProperty() {
return contentType;
}
/**
* Get created date.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#getCreatedProperty()
*/
public Nullable<Date> getCreatedProperty() {
return created;
}
/**
* Get created date formated into a String.
*
* @return A string representation of the created date.
*/
public String getCreatedPropertyString() {
return getDateValue(created);
}
/**
* Get creator.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#getCreatorProperty()
*/
public Nullable<String> getCreatorProperty() {
return creator;
}
/**
* Get description.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#getDescriptionProperty()
*/
public Nullable<String> getDescriptionProperty() {
return description;
}
/**
* Get identifier.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#getIdentifierProperty()
*/
public Nullable<String> getIdentifierProperty() {
return identifier;
}
/**
* Get keywords.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#getKeywordsProperty()
*/
public Nullable<String> getKeywordsProperty() {
return keywords;
}
/**
* Get the language.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#getLanguageProperty()
*/
public Nullable<String> getLanguageProperty() {
return language;
}
/**
* Get the author of last modifications.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#getLastModifiedByProperty()
*/
public Nullable<String> getLastModifiedByProperty() {
return lastModifiedBy;
}
/**
* Get last printed date.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#getLastPrintedProperty()
*/
public Nullable<Date> getLastPrintedProperty() {
return lastPrinted;
}
/**
* Get last printed date formated into a String.
*
* @return A string representation of the last printed date.
*/
public String getLastPrintedPropertyString() {
return getDateValue(lastPrinted);
}
/**
* Get modified date.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#getModifiedProperty()
*/
public Nullable<Date> getModifiedProperty() {
return modified;
}
/**
* Get modified date formated into a String.
*
* @return A string representation of the modified date.
*/
public String getModifiedPropertyString() {
if (modified.hasValue()) {
return getDateValue(modified);
}
return getDateValue(new Nullable<Date>(new Date()));
}
/**
* Get revision.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#getRevisionProperty()
*/
public Nullable<String> getRevisionProperty() {
return revision;
}
/**
* Get subject.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#getSubjectProperty()
*/
public Nullable<String> getSubjectProperty() {
return subject;
}
/**
* Get title.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#getTitleProperty()
*/
public Nullable<String> getTitleProperty() {
return title;
}
/**
* Get version.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#getVersionProperty()
*/
public Nullable<String> getVersionProperty() {
return version;
}
/**
* Set the category.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#setCategoryProperty(java.lang.String)
*/
public void setCategoryProperty(String category) {
this.category = setStringValue(category);
}
/**
* Set the content status.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#setContentStatusProperty(java.lang.String)
*/
public void setContentStatusProperty(String contentStatus) {
this.contentStatus = setStringValue(contentStatus);
}
/**
* Set the content type.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#setContentTypeProperty(java.lang.String)
*/
public void setContentTypeProperty(String contentType) {
this.contentType = setStringValue(contentType);
}
/**
* Set the created date.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#setCreatedProperty(org.apache.poi.openxml4j.util.Nullable)
*/
public void setCreatedProperty(String created) {
try {
this.created = setDateValue(created);
} catch (InvalidFormatException e) {
throw new IllegalArgumentException("Date for created could not be parsed: " + created, e);
}
}
/**
* Set the created date.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#setCreatedProperty(org.apache.poi.openxml4j.util.Nullable)
*/
public void setCreatedProperty(Nullable<Date> created) {
if (created.hasValue())
this.created = created;
}
/**
* Set the creator.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#setCreatorProperty(java.lang.String)
*/
public void setCreatorProperty(String creator) {
this.creator = setStringValue(creator);
}
/**
* Set the description.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#setDescriptionProperty(java.lang.String)
*/
public void setDescriptionProperty(String description) {
this.description = setStringValue(description);
}
/**
* Set identifier.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#setIdentifierProperty(java.lang.String)
*/
public void setIdentifierProperty(String identifier) {
this.identifier = setStringValue(identifier);
}
/**
* Set keywords.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#setKeywordsProperty(java.lang.String)
*/
public void setKeywordsProperty(String keywords) {
this.keywords = setStringValue(keywords);
}
/**
* Set language.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#setLanguageProperty(java.lang.String)
*/
public void setLanguageProperty(String language) {
this.language = setStringValue(language);
}
/**
* Set last modifications author.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#setLastModifiedByProperty(java.lang.String)
*/
public void setLastModifiedByProperty(String lastModifiedBy) {
this.lastModifiedBy = setStringValue(lastModifiedBy);
}
/**
* Set last printed date.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#setLastPrintedProperty(org.apache.poi.openxml4j.util.Nullable)
*/
public void setLastPrintedProperty(String lastPrinted) {
try {
this.lastPrinted = setDateValue(lastPrinted);
} catch (InvalidFormatException e) {
throw new IllegalArgumentException("lastPrinted : "
+ e.getLocalizedMessage(), e);
}
}
/**
* Set last printed date.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#setLastPrintedProperty(org.apache.poi.openxml4j.util.Nullable)
*/
public void setLastPrintedProperty(Nullable<Date> lastPrinted) {
if (lastPrinted.hasValue())
this.lastPrinted = lastPrinted;
}
/**
* Set last modification date.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#setModifiedProperty(org.apache.poi.openxml4j.util.Nullable)
*/
public void setModifiedProperty(String modified) {
try {
this.modified = setDateValue(modified);
} catch (InvalidFormatException e) {
throw new IllegalArgumentException("modified : "
+ e.getLocalizedMessage(), e);
}
}
/**
* Set last modification date.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#setModifiedProperty(org.apache.poi.openxml4j.util.Nullable)
*/
public void setModifiedProperty(Nullable<Date> modified) {
if (modified.hasValue())
this.modified = modified;
}
/**
* Set revision.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#setRevisionProperty(java.lang.String)
*/
public void setRevisionProperty(String revision) {
this.revision = setStringValue(revision);
}
/**
* Set subject.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#setSubjectProperty(java.lang.String)
*/
public void setSubjectProperty(String subject) {
this.subject = setStringValue(subject);
}
/**
* Set title.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#setTitleProperty(java.lang.String)
*/
public void setTitleProperty(String title) {
this.title = setStringValue(title);
}
/**
* Set version.
*
* @see org.apache.poi.openxml4j.opc.PackageProperties#setVersionProperty(java.lang.String)
*/
public void setVersionProperty(String version) {
this.version = setStringValue(version);
}
/**
* Convert a strig value into a Nullable<String>
*/
private Nullable<String> setStringValue(String s) {
if (s == null || s.equals("")) {
return new Nullable<String>();
}
return new Nullable<String>(s);
}
/**
* Convert a string value represented a date into a Nullable<Date>.
*
* @throws InvalidFormatException
* Throws if the date format isnot valid.
*/
private Nullable<Date> setDateValue(String dateStr) throws InvalidFormatException {
if (dateStr == null || dateStr.equals("")) {
return new Nullable<Date>();
}
Matcher m = TIME_ZONE_PAT.matcher(dateStr);
if (m.find()) {
String dateTzStr = dateStr.substring(0, m.start())+
m.group(1)+m.group(2);
for (String fStr : TZ_DATE_FORMATS) {
SimpleDateFormat df = new SimpleDateFormat(fStr, Locale.ROOT);
df.setTimeZone(LocaleUtil.TIMEZONE_UTC);
Date d = df.parse(dateTzStr, new ParsePosition(0));
if (d != null) {
return new Nullable<Date>(d);
}
}
}
String dateTzStr = dateStr.endsWith("Z") ? dateStr : (dateStr + "Z");
for (String fStr : DATE_FORMATS) {
SimpleDateFormat df = new SimpleDateFormat(fStr, Locale.ROOT);
df.setTimeZone(LocaleUtil.TIMEZONE_UTC);
Date d = df.parse(dateTzStr, new ParsePosition(0));
if (d != null) {
return new Nullable<Date>(d);
}
}
//if you're here, no pattern matched, throw exception
StringBuilder sb = new StringBuilder();
int i = 0;
for (String fStr : TZ_DATE_FORMATS) {
if (i++ > 0) {
sb.append(", ");
}
sb.append(fStr);
}
for (String fStr : DATE_FORMATS) {
sb.append(", ").append(fStr);
}
throw new InvalidFormatException("Date " + dateStr + " not well formatted, "
+ "expected format in: "+ sb);
}
/**
* Convert a Nullable<Date> into a String.
*
* @param d
* The Date to convert.
* @return The formated date or null.
* @see java.text.SimpleDateFormat
*/
private String getDateValue(Nullable<Date> d) {
if (d == null) {
return "";
}
Date date = d.getValue();
if (date == null) {
return "";
}
SimpleDateFormat df = new SimpleDateFormat(DEFAULT_DATEFORMAT, Locale.ROOT);
df.setTimeZone(LocaleUtil.TIMEZONE_UTC);
return df.format(date);
}
@Override
protected InputStream getInputStreamImpl() {
throw new InvalidOperationException("Operation not authorized. This part may only be manipulated using the getters and setters on PackagePropertiesPart");
}
@Override
protected OutputStream getOutputStreamImpl() {
throw new InvalidOperationException(
"Can't use output stream to set properties !");
}
@Override
public boolean save(OutputStream zos) {
throw new InvalidOperationException("Operation not authorized. This part may only be manipulated using the getters and setters on PackagePropertiesPart");
}
@Override
public boolean load(InputStream ios) {
throw new InvalidOperationException("Operation not authorized. This part may only be manipulated using the getters and setters on PackagePropertiesPart");
}
@Override
public void close() {
// Do nothing
}
@Override
public void flush() {
// Do nothing
}
}