org.jpedal.objects.PdfFileInformation Maven / Gradle / Ivy
/*
* ===========================================
* Java Pdf Extraction Decoding Access Library
* ===========================================
*
* Project Info: http://www.idrsolutions.com
* Help section for developers at http://www.idrsolutions.com/support/
*
* (C) Copyright 1997-2017 IDRsolutions and Contributors.
*
* This file is part of JPedal/JPDF2HTML5
*
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* ---------------
* PdfFileInformation.java
* ---------------
*/
package org.jpedal.objects;
import org.jpedal.constants.PDFflags;
import org.jpedal.io.ObjectDecoder;
import org.jpedal.io.PdfFileReader;
import org.jpedal.io.PdfObjectReader;
import org.jpedal.io.security.DecryptionFactory;
import org.jpedal.objects.raw.MetadataObject;
import org.jpedal.objects.raw.PdfDictionary;
import org.jpedal.objects.raw.PdfObject;
import org.jpedal.utils.LogWriter;
import org.jpedal.utils.StringUtils;
/**
* Added as a repository to store PDF file metadata (both legacy fields and XML metadata) in so that it can be accesed.
*
Please see org.jpedal.examples (especially Viewer) for example code.
*/
public class PdfFileInformation {
/**
* list of pdf information fields data might contain
*/
private static final String[] information_fields =
{
"Title",
"Author",
"Subject",
"Keywords",
"Creator",
"Producer",
"CreationDate",
"ModDate",
"Trapped"};
/**
* list of pdf information fields data might contain
*/
public static final int[] information_field_IDs =
{
PdfDictionary.Title,
PdfDictionary.Author,
PdfDictionary.Subject,
PdfDictionary.Keywords,
PdfDictionary.Creator,
PdfDictionary.Producer,
PdfDictionary.CreationDate,
PdfDictionary.ModDate,
PdfDictionary.Trapped};
/**
* assigned values found in pdf information object
*/
private final String[] information_values = {"", "", "", "", "", "", "", "", ""};
/**
* Any XML metadata as a string
*/
private String XMLmetadata;
private byte[] rawData;
/**
* @return list of field names
*/
public static String[] getFieldNames() {
return information_fields;
}
/**
* @return XML data embedded inside PDF
*/
public String getFileXMLMetaData() {
if (rawData == null) {
return "";
} else {
if (XMLmetadata == null) {
//make deep copy
final int length = rawData.length;
byte[] stream = new byte[length];
System.arraycopy(rawData, 0, stream, 0, length);
//strip empty lines
final int count = stream.length;
int reached = 0;
byte lastValue = 0;
for (int ii = 0; ii < count; ii++) {
if (lastValue == 13 && stream[ii] == 10) {
//convert return
stream[reached - 1] = 10;
} else if ((lastValue == 10 || lastValue == 32) && (stream[ii] == 32 || stream[ii] == 10)) {
} else {
stream[reached] = stream[ii];
lastValue = stream[ii];
reached++;
}
}
if (reached != count) {
final byte[] cleanedStream = new byte[reached];
System.arraycopy(stream, 0, cleanedStream, 0, reached);
stream = cleanedStream;
}
XMLmetadata = new String(stream);
}
return XMLmetadata;
}
}
/**
* set list of field names as file opened by JPedal (should not be used externally)
*
* @param rawData An array containing list of field names
*/
public void setFileXMLMetaData(final byte[] rawData) {
this.rawData = rawData;
}
/**
* @return list of field values to match field names (legacy non-XML information fields)
*/
public String[] getFieldValues() {
return information_values;
}
/**
* set the information values as file opened by JPedal (should not be used externally)
*
* @param i position of the pointer
* @param convertedValue new value of the pointer
*/
public void setFieldValue(final int i, final String convertedValue) {
information_values[i] = convertedValue;
}
/**
* read information object and return pointer to correct
* place
*
* @param infoObj a value of information object
* @param objectDecoder gets information of information object
*/
public void readInformationObject(final PdfObject infoObj, final ObjectDecoder objectDecoder) {
//get info
try {
objectDecoder.checkResolved(infoObj);
} catch (final Exception e) {
LogWriter.writeLog("Exception: " + e.getMessage());
}
String newValue;
int id;
byte[] data;
final int count = PdfFileInformation.information_field_IDs.length;
//put into fields so we can display
for (int i = 0; i < count; i++) {
id = PdfFileInformation.information_field_IDs[i];
if (id == PdfDictionary.Trapped) {
newValue = infoObj.getName(id);
if (newValue == null) {
newValue = "";
}
} else {
data = infoObj.getTextStreamValueAsByte(id);
if (data == null) {
newValue = "";
} else {
newValue = StringUtils.getTextString(data, false);
}
}
setFieldValue(i, newValue);
}
}
/**
* read the form data from the file
*
* @param metadataObj XML value
* @param currentPdfFile the Current PDF File
* @return form data from the file
*/
public final PdfFileInformation readPdfFileMetadata(final PdfObject metadataObj, final PdfObjectReader currentPdfFile) {
final PdfFileReader objectReader = currentPdfFile.getObjectReader();
final ObjectDecoder objectDecoder = new ObjectDecoder(currentPdfFile.getObjectReader());
//read info object (may be defined and object set in different trailers so must be done at end)
final DecryptionFactory decryption = objectReader.getDecryptionObject();
final PdfObject infoObject = objectReader.getInfoObject();
if (infoObject != null && (!(decryption != null && (decryption.getBooleanValue(PDFflags.IS_FILE_ENCRYPTED) || decryption.getBooleanValue(PDFflags.IS_PASSWORD_SUPPLIED))))) {
readInformationObject(infoObject, objectDecoder);
}
//read and set XML value
if (metadataObj != null) {
final String objectRef = new String(metadataObj.getUnresolvedData());
//byte[] stream= metadataObj.DecodedStream;
//start old
//get data
final MetadataObject oldMetaDataObj = new MetadataObject(objectRef);
objectReader.readObject(oldMetaDataObj);
rawData = oldMetaDataObj.getDecodedStream();
/*
* remove any rubbish at end (last char should be > so find last >
* and remove the rest)
*/
if (rawData != null) {
int count = rawData.length;
while (count > 1) {
if (rawData[count - 1] == '>') {
break;
}
count--;
}
//copy and resize
if (count > 0) {
final byte[] trimmedVersion = new byte[count];
System.arraycopy(rawData, 0, trimmedVersion, 0, count);
rawData = trimmedVersion;
}
}
}
return this;
}
}