/*
* Copyright 2003 Paulo Soares
*
*
* The Original Code is 'iText, a free JAVA-PDF library'.
*
* The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
* the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
* All Rights Reserved.
* Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
* are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
*
* Contributor(s): all the names of the contributors are added in the source code
* where applicable.
*
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*
*
* If you didn't download this code from the following link, you should check if
* you aren't using an obsolete version:
* http://www.lowagie.com/iText/
*/
package pdftk.com.lowagie.text.pdf;
import java.io.*;
import java.net.URL;
/** Specifies a file or an URL. The file can be extern or embedded.
*
* @author Paulo Soares (psoares@consiste.pt)
*/
public class PdfFileSpecification extends PdfDictionary {
protected PdfWriter writer;
protected PdfIndirectReference ref;
/** Creates a new instance of PdfFileSpecification. The static methods are preferred. */
public PdfFileSpecification() {
// ssteward: for Acrobat 5 compatibility, set Type to "F" instead
// of the (more correct) "Filesec"; this quirk is documented
// in Implementation Note 38 on page 955 of the PDF Ref. ver. 1.5;
// Acrobat 6 (and later) accept either "Filespec" or "F"
//super(PdfName.FILESPEC);
super(PdfName.F);
}
/**
* Creates a file specification of type URL.
* @param writer the PdfWriter
* @param url the URL
* @return the file specification
*/
public static PdfFileSpecification url(PdfWriter writer, String url) {
PdfFileSpecification fs = new PdfFileSpecification();
fs.writer = writer;
fs.put(PdfName.FS, PdfName.URL);
fs.put(PdfName.F, new PdfString(url));
return fs;
}
/**
* Creates a file specification with the file embedded. The file may
* come from the file system or from a byte array. The data is flate compressed.
* @param writer the PdfWriter
* @param filePath the file path
* @param fileDisplay the file information that is presented to the user
* @param fileStore the byte array with the file. If it is not null
* it takes precedence over filePath
* @throws IOException on error
* @return the file specification
*/
public static PdfFileSpecification fileEmbedded(PdfWriter writer, String filePath, String fileDisplay, byte fileStore[]) throws IOException {
return fileEmbedded(writer, filePath, fileDisplay, fileStore, true);
}
/**
* Creates a file specification with the file embedded. The file may
* come from the file system or from a byte array.
* @param writer the PdfWriter
* @param filePath the file path
* @param fileDisplay the file information that is presented to the user
* @param fileStore the byte array with the file. If it is not null
* it takes precedence over filePath
* @param compress sets the compression on the data. Multimedia content will benefit little
* from compression
* @throws IOException on error
* @return the file specification
*/
public static PdfFileSpecification fileEmbedded(PdfWriter writer, String filePath, String fileDisplay, byte fileStore[], boolean compress) throws IOException {
PdfFileSpecification fs = new PdfFileSpecification();
fs.writer = writer;
PdfString fileDisplayPdf= new PdfString( fileDisplay, PdfObject.TEXT_PDFDOCENCODING );
PdfString fileDisplayPdfUnicode= new PdfString( fileDisplay, PdfObject.TEXT_UNICODE );
fs.put(PdfName.F, fileDisplayPdf);
fs.put(PdfName.UF, fileDisplayPdfUnicode); // introduced in PDF 1.7
PdfStream stream;
InputStream in = null;
PdfIndirectReference ref;
PdfIndirectReference refFileLength;
try {
refFileLength = writer.getPdfIndirectReference();
if (fileStore == null) {
File file = new File(filePath);
if (file.canRead()) {
in = new FileInputStream(filePath);
}
else {
if (filePath.startsWith("file:/") || filePath.startsWith("http://") || filePath.startsWith("https://") || filePath.startsWith("jar:")) {
in = new URL(filePath).openStream();
}
else {
in = BaseFont.getResourceStream(filePath);
if (in == null)
throw new IOException(filePath + " not found as file or resource.");
}
}
stream = new PdfStream(in, writer);
}
else
stream = new PdfStream(fileStore);
stream.put(PdfName.TYPE, PdfName.EMBEDDEDFILE);
if (compress)
stream.flateCompress();
stream.put(PdfName.PARAMS, refFileLength);
ref = writer.addToBody(stream).getIndirectReference();
if (fileStore == null) {
stream.writeLength();
}
PdfDictionary params = new PdfDictionary();
params.put(PdfName.SIZE, new PdfNumber(stream.getRawLength()));
writer.addToBody(params, refFileLength);
}
finally {
if (in != null)
try{in.close();}catch(Exception e){}
}
PdfDictionary f = new PdfDictionary();
f.put(PdfName.F, ref);
fs.put(PdfName.EF, f);
return fs;
}
/**
* Creates a file specification for an external file.
* @param writer the PdfWriter
* @param filePath the file path
* @return the file specification
*/
public static PdfFileSpecification fileExtern(PdfWriter writer, String filePath) {
PdfFileSpecification fs = new PdfFileSpecification();
fs.writer = writer;
fs.put(PdfName.F, new PdfString(filePath));
return fs;
}
/**
* Gets the indirect reference to this file specification.
* Multiple invocations will retrieve the same value.
* @throws IOException on error
* @return the indirect reference
*/
public PdfIndirectReference getReference() throws IOException {
if (ref != null)
return ref;
ref = writer.addToBody(this).getIndirectReference();
return ref;
}
/**
* Sets the file name (the key /F) string as an hex representation
* to support multi byte file names. The name must heve th slash and
* backslash escaped according to the file specification rules
* @param fileName the file name as a byte array
*/
/* ssteward: appears that fileName should hold the multi-byte data -- it isn't converted,
but is packed literally into the PDF;
public void setMultiByteFileName(byte fileName[]) {
put(PdfName.F, new PdfString(fileName).setHexWriting(true));
}
*/
}