/*
* 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.tika.parser.microsoft;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.util.Date;
import org.apache.poi.hpsf.CustomProperties;
import org.apache.poi.hpsf.DocumentSummaryInformation;
import org.apache.poi.hpsf.MarkUnsupportedException;
import org.apache.poi.hpsf.NoPropertySetStreamException;
import org.apache.poi.hpsf.PropertySet;
import org.apache.poi.hpsf.SummaryInformation;
import org.apache.poi.hpsf.UnexpectedPropertySetTypeException;
import org.apache.poi.poifs.filesystem.DocumentEntry;
import org.apache.poi.poifs.filesystem.DocumentInputStream;
import org.apache.poi.poifs.filesystem.POIFSFileSystem;
import org.apache.tika.exception.TikaException;
import org.apache.tika.metadata.Metadata;
/**
* Outlook Message Parser.
*/
class SummaryExtractor {
private static final String SUMMARY_INFORMATION =
SummaryInformation.DEFAULT_STREAM_NAME;
private static final String DOCUMENT_SUMMARY_INFORMATION =
DocumentSummaryInformation.DEFAULT_STREAM_NAME;
private final Metadata metadata;
public SummaryExtractor(Metadata metadata) {
this.metadata = metadata;
}
public void parseSummaries(POIFSFileSystem filesystem)
throws IOException, TikaException {
parseSummaryEntryIfExists(filesystem, SUMMARY_INFORMATION);
parseSummaryEntryIfExists(filesystem, DOCUMENT_SUMMARY_INFORMATION);
}
private void parseSummaryEntryIfExists(
POIFSFileSystem filesystem, String entryName)
throws IOException, TikaException {
try {
DocumentEntry entry =
(DocumentEntry) filesystem.getRoot().getEntry(entryName);
PropertySet properties =
new PropertySet(new DocumentInputStream(entry));
if (properties.isSummaryInformation()) {
parse(new SummaryInformation(properties));
}
if (properties.isDocumentSummaryInformation()) {
parse(new DocumentSummaryInformation(properties));
}
} catch (FileNotFoundException e) {
// entry does not exist, just skip it
} catch (NoPropertySetStreamException e) {
throw new TikaException("Not a HPSF document", e);
} catch (UnexpectedPropertySetTypeException e) {
throw new TikaException("Unexpected HPSF document", e);
} catch (MarkUnsupportedException e) {
throw new TikaException("Invalid DocumentInputStream", e);
}
}
private void parse(SummaryInformation summary) {
set(Metadata.TITLE, summary.getTitle());
set(Metadata.AUTHOR, summary.getAuthor());
set(Metadata.KEYWORDS, summary.getKeywords());
set(Metadata.SUBJECT, summary.getSubject());
set(Metadata.LAST_AUTHOR, summary.getLastAuthor());
set(Metadata.COMMENTS, summary.getComments());
set(Metadata.TEMPLATE, summary.getTemplate());
set(Metadata.APPLICATION_NAME, summary.getApplicationName());
set(Metadata.REVISION_NUMBER, summary.getRevNumber());
set(Metadata.CREATION_DATE, summary.getCreateDateTime());
set(Metadata.CHARACTER_COUNT, summary.getCharCount());
set(Metadata.EDIT_TIME, summary.getEditTime());
set(Metadata.LAST_SAVED, summary.getLastSaveDateTime());
set(Metadata.PAGE_COUNT, summary.getPageCount());
set(Metadata.SECURITY, summary.getSecurity());
set(Metadata.WORD_COUNT, summary.getWordCount());
set(Metadata.LAST_PRINTED, summary.getLastPrinted());
}
private void parse(DocumentSummaryInformation summary) {
set(Metadata.COMPANY, summary.getCompany());
set(Metadata.MANAGER, summary.getManager());
set(Metadata.LANGUAGE, getLanguage(summary));
set(Metadata.CATEGORY, summary.getCategory());
}
private String getLanguage(DocumentSummaryInformation summary) {
CustomProperties customProperties = summary.getCustomProperties();
if (customProperties != null) {
Object value = customProperties.get("Language");
if (value instanceof String) {
return (String) value;
}
}
return null;
}
private void set(String name, String value) {
if (value != null) {
metadata.set(name, value);
}
}
private void set(String name, Date value) {
if (value != null) {
metadata.set(name, value.toString());
}
}
private void set(String name, long value) {
if (value > 0) {
metadata.set(name, Long.toString(value));
}
}
}