1 package org.simantics.export.core.pdf;
\r
3 import java.awt.Graphics2D;
\r
5 import java.io.FileInputStream;
\r
6 import java.io.FileOutputStream;
\r
7 import java.io.IOException;
\r
8 import java.security.KeyStore;
\r
9 import java.security.KeyStoreException;
\r
10 import java.security.NoSuchAlgorithmException;
\r
11 import java.security.PrivateKey;
\r
12 import java.security.UnrecoverableKeyException;
\r
13 import java.security.cert.Certificate;
\r
14 import java.security.cert.CertificateException;
\r
15 import java.util.ArrayList;
\r
16 import java.util.Collections;
\r
17 import java.util.HashMap;
\r
18 import java.util.List;
\r
19 import java.util.Map;
\r
21 import org.simantics.Simantics;
\r
22 import org.simantics.databoard.binding.mutable.Variant;
\r
23 import org.simantics.export.core.ExportContext;
\r
24 import org.simantics.export.core.error.ExportException;
\r
25 import org.simantics.export.core.intf.Format;
\r
26 import org.simantics.export.core.manager.Content;
\r
27 import org.simantics.utils.page.MarginUtils.Margins;
\r
28 import org.simantics.utils.page.PageDesc;
\r
29 import org.simantics.utils.page.PageOrientation;
\r
31 import com.lowagie.text.Document;
\r
32 import com.lowagie.text.DocumentException;
\r
33 import com.lowagie.text.Element;
\r
34 import com.lowagie.text.ExceptionConverter;
\r
35 import com.lowagie.text.Font;
\r
36 import com.lowagie.text.PageSize;
\r
37 import com.lowagie.text.Phrase;
\r
38 import com.lowagie.text.Rectangle;
\r
39 import com.lowagie.text.pdf.AcroFields;
\r
40 import com.lowagie.text.pdf.BadPdfFormatException;
\r
41 import com.lowagie.text.pdf.ColumnText;
\r
42 import com.lowagie.text.pdf.FontMapper;
\r
43 import com.lowagie.text.pdf.PdfContentByte;
\r
44 import com.lowagie.text.pdf.PdfCopy;
\r
45 import com.lowagie.text.pdf.PdfDictionary;
\r
46 import com.lowagie.text.pdf.PdfFileSpecification;
\r
47 import com.lowagie.text.pdf.PdfImportedPage;
\r
48 import com.lowagie.text.pdf.PdfReader;
\r
49 import com.lowagie.text.pdf.PdfSignatureAppearance;
\r
50 import com.lowagie.text.pdf.PdfStamper;
\r
51 import com.lowagie.text.pdf.PdfTemplate;
\r
52 import com.lowagie.text.pdf.PdfWriter;
\r
55 * A PDF writer object.
\r
57 * @author toni.kalajainen@semantum.fi
\r
59 public class ExportPdfWriter {
\r
62 public Document document;
\r
64 /** PDF Output stream */
\r
65 public PdfCopy pdfCopy;
\r
67 /** Open output stream */
\r
68 public FileOutputStream fos;
\r
70 /** The direct content byte of the document */
\r
71 public PdfContentByte cb;
\r
73 /** Contains Pdf Templates, e.g. symbols. Resource Uri -> Template mapping */
\r
74 public Map<String, PdfTemplate> templates = new HashMap<String, PdfTemplate>();
\r
77 public List<Page> pages = new ArrayList<Page>();
\r
79 /** Suggested Page Desc */
\r
80 public PageDesc defaultPageDesc;
\r
82 /** PageDesc as PDF rectangle */
\r
83 public Rectangle defaultRectangle;
\r
85 /** Initialized FontMapper */
\r
86 public FontMapper fontMapper;
\r
88 /** The output file */
\r
89 public File outputFile;
\r
92 public Variant options;
\r
94 /** Export Context */
\r
95 public ExportContext ctx;
\r
97 /** The margins the user selected. */
\r
98 public Margins margins;
\r
100 /** Compression Level */
\r
101 public int compressionLevel;
\r
106 * @param (Optional) page description. If null is used, the default size is used.
\r
107 * @return Page for writing
\r
108 * @throws ExportException
\r
110 public Page createPage( PageDesc pd ) throws ExportException {
\r
113 if ( pd == null || pd.isInfinite() ) {
\r
114 pd = defaultPageDesc;
\r
115 rect = defaultRectangle;
\r
117 rect = toRectangle( pd );
\r
120 Page page = new Page( pd, rect, pages.size() );
\r
126 * Create a new template.
\r
128 * Note, template is not visible on the document until you add it with
\r
129 * cb.addTemplate( template.tp, 0, 0);
\r
131 * @param name (Optional) Template identifier
\r
132 * @param pd (Optional) template size description. If null is used, the default size is used.
\r
133 * @return Template handle
\r
134 * @throws ExportException
\r
136 public Template createTemplate( String name, PageDesc pd ) throws ExportException {
\r
138 if ( pd == null || pd.isInfinite() ) {
\r
139 pd = defaultPageDesc;
\r
140 rect = defaultRectangle;
\r
142 rect = toRectangle( pd );
\r
145 int w = (int) pd.getWidth();
\r
146 int h = (int) pd.getHeight();
\r
147 PdfTemplate tp = cb.createTemplate(w, h);
\r
148 Template canvas = new Template( name, pd, rect, tp );
\r
149 canvas.name = name;
\r
150 if ( name!=null ) templates.put(name, tp);
\r
155 * Sign the file with a private+public key pair (PPK).
\r
156 * The file must be closed already.
\r
158 * @param keystoreFile the keystore file
\r
159 * @param keystorePassword (optional) password
\r
160 * @param privateKeyPassword (optional) password
\r
161 * @param signLocation (optional) sign locaiton, e.g. "Helsinki"
\r
162 * @param signReason (optional) e.g. "approved"
\r
163 * @throws ExportException
\r
165 public void sign( File keystoreFile, String keystorePassword, String privateKeyPassword, String signLocation, String signReason) throws ExportException {
\r
166 // Add Bouncycastle, if found. If not, try anyway.
\r
168 if (providerAdded.compareAndSet(false, true)) {
\r
170 String className = "org.bouncycastle.jce.provider.BouncyCastleProvider";
\r
171 Class<?> clazz = Class.forName(className);
\r
172 Provider provide = (Provider) clazz.newInstance();
\r
173 Security.addProvider( provide );
\r
174 } catch (SecurityException se) {
\r
175 se.printStackTrace();
\r
176 } catch (NullPointerException npe) {
\r
177 npe.printStackTrace();
\r
178 } catch (ClassNotFoundException e) {
\r
179 e.printStackTrace();
\r
180 } catch (InstantiationException e) {
\r
181 e.printStackTrace();
\r
182 } catch (IllegalAccessException e) {
\r
183 e.printStackTrace();
\r
188 FileInputStream ksfis = null;
\r
189 FileInputStream fis = null;
\r
190 FileOutputStream fos = null;
\r
191 File signedFile = null;
\r
193 KeyStore ks = KeyStore.getInstance("pkcs12");
\r
194 signedFile = new File( outputFile.getCanonicalPath()+".signed" );
\r
195 if (signedFile.exists()) signedFile.delete();
\r
196 ksfis = new FileInputStream(keystoreFile);
\r
197 fis = new FileInputStream(outputFile);
\r
198 fos = new FileOutputStream( signedFile );
\r
199 ks.load(ksfis, keystorePassword != null ? keystorePassword.toCharArray() : null);
\r
201 List<String> aliases = Collections.list(ks.aliases());
\r
202 String alias = aliases.get(0);
\r
203 PrivateKey key = (PrivateKey)ks.getKey(alias, privateKeyPassword != null ? privateKeyPassword.toCharArray() : null);
\r
204 Certificate[] chain = ks.getCertificateChain(alias);
\r
206 PdfReader reader = new PdfReader( fis );
\r
207 PdfStamper stp = PdfStamper.createSignature(reader, fos, '\0');
\r
208 PdfSignatureAppearance sap = stp.getSignatureAppearance();
\r
211 String fieldName = "sign"; //signReason==null?"sign":URIUtil.encodeFilename( signReason );
\r
212 AcroFields af = stp.getAcroFields();
\r
213 AcroFields.Item item = af.getFieldItem(fieldName);
\r
214 if (signReason!=null) sap.setReason( signReason );
\r
215 if (signLocation!=null) sap.setLocation( signLocation );
\r
216 sap.setCrypto(key, chain, null, PdfSignatureAppearance.SELF_SIGNED);
\r
217 sap.setCertificationLevel(PdfSignatureAppearance.CERTIFIED_NO_CHANGES_ALLOWED);
\r
218 sap.setRender(PdfSignatureAppearance.SignatureRenderNameAndDescription);
\r
220 // Make field the signature
\r
221 //sap.setVisibleSignature(fieldName);
\r
223 // Visible signature
\r
224 //AcroFields af = stp.getAcroFields();
\r
225 //AcroFields.Item item = af.getFieldItem(fieldName);
\r
226 //sap.setVisibleSignature(new Rectangle(0, 0, 100, 10), 0, fieldName);
\r
228 // comment next line to have an invisible signature
\r
229 //sap.setVisibleSignature(new Rectangle(682, 130, 822, 145), 1, "approved_by");
\r
231 //stp.getAcroFields().setField(fieldName, "someValue");
\r
236 } catch (DocumentException e) {
\r
237 throw new ExportException( e.getClass().getName()+": "+e.getMessage(), e );
\r
238 } catch (UnrecoverableKeyException e) {
\r
239 throw new ExportException( e.getClass().getName()+": "+e.getMessage(), e );
\r
240 } catch (NoSuchAlgorithmException e) {
\r
241 throw new ExportException( e.getClass().getName()+": "+e.getMessage(), e );
\r
242 } catch (CertificateException e) {
\r
243 throw new ExportException( e.getClass().getName()+": "+e.getMessage(),e );
\r
244 } catch (IOException e) {
\r
245 throw new ExportException( e.getClass().getName()+": "+e.getMessage(), e );
\r
246 } catch (KeyStoreException e) {
\r
247 throw new ExportException( e.getClass().getName()+": "+e.getMessage(), e );
\r
249 if ( ksfis != null ) try { ksfis.close(); } catch (IOException e) {}
\r
250 if ( fis != null ) try { fis.close(); } catch (IOException e) {}
\r
251 if ( fos != null ) try { fos.close(); } catch (IOException e) {}
\r
253 if ( signedFile!=null && signedFile.exists() && outputFile.exists() ) {
\r
254 outputFile.delete();
\r
255 signedFile.renameTo( outputFile );
\r
261 public void addAttachment(Content content) throws ExportException {
\r
263 if ( content.tmpFile == null ) throw new ExportException("Could not export "+content.filename+", null file.");
\r
264 if ( !content.tmpFile.exists() ) throw new ExportException("Could not export "+content.filename+", file not found.");
\r
266 Format format = ctx.eep.getFormat( content.formatId );
\r
267 //byte[] data = StreamUtil.readFully( content.tmpFile );
\r
268 PdfDictionary fileParameter = new PdfDictionary();
\r
269 PdfFileSpecification spec = PdfFileSpecification.fileEmbedded(
\r
271 content.tmpFile.getAbsolutePath(),
\r
275 "application/simantics/"+format.id(),
\r
278 pdfCopy.addFileAttachment( content.filename, spec );
\r
281 } catch (IOException e) {
\r
282 throw new ExportException( e.getClass().getName()+": "+e.getMessage() );
\r
286 public void close() throws ExportException {
\r
289 if ( pages.isEmpty() ) {
\r
290 Page page = createPage(null);
\r
291 Graphics2D g2d = page.createGraphics(true);
\r
293 g2d.drawString("This page is intentionally left blank.", 100, 100);
\r
299 for ( Page page : pages ) page.close();
\r
301 Font f = new Font(Font.HELVETICA, 8);
\r
303 int totalPages = 0;
\r
304 int currentPage = 1;
\r
306 for ( Page page : pages ) {
\r
307 PdfReader reader = new PdfReader( page.tmpFile.getAbsolutePath() );
\r
309 totalPages += reader.getNumberOfPages();
\r
315 for ( Page page : pages ) {
\r
316 PdfReader reader = new PdfReader( page.tmpFile.getAbsolutePath() );
\r
318 int n = reader.getNumberOfPages();
\r
320 for (int i = 0; i < n; ) {
\r
321 Rectangle pageSize = reader.getPageSizeWithRotation(n);
\r
323 PdfImportedPage imp = pdfCopy.getImportedPage(reader, ++i);
\r
324 PdfCopy.PageStamp ps = pdfCopy.createPageStamp(imp);
\r
326 PdfContentByte over = ps.getOverContent();
\r
328 ColumnText.showTextAligned(over, Element.ALIGN_RIGHT,
\r
330 String.format("%d / %d", currentPage++, totalPages), f),
\r
331 pageSize.getWidth()-12, 12, 0);
\r
332 ps.alterContents();
\r
333 pdfCopy.addPage(imp);
\r
340 } catch (IOException e) {
\r
341 throw new ExportException( e );
\r
342 } catch (ExceptionConverter e) {
\r
343 throw new ExportException( e );
\r
344 } catch (BadPdfFormatException e) {
\r
345 throw new ExportException( e );
\r
346 } catch (Exception e) {
\r
347 throw new ExportException( e );
\r
349 for ( Page page : pages ) {
\r
350 if ( page.tmpFile != null ) { page.tmpFile.delete(); page.tmpFile = null; }
\r
354 if ( document != null ) { document.close(); document = null; }
\r
355 if ( pdfCopy != null ) { pdfCopy.close(); pdfCopy = null; }
\r
356 if ( fos != null ) { try {
\r
358 } catch (IOException e) {
\r
359 throw new ExportException(e);
\r
364 public class Page {
\r
366 /** PDF Output stream */
\r
367 public PdfWriter pdfWriter;
\r
369 /** PDF Document */
\r
370 public Document document;
\r
372 /** Open output stream */
\r
373 public FileOutputStream fos;
\r
375 /** The direct content byte of the document */
\r
376 public PdfContentByte cb;
\r
378 /** Tmp-file where the page is written to */
\r
379 public File tmpFile;
\r
381 /** Suggested Page Desc */
\r
382 public PageDesc pageDesc;
\r
384 /** PageDesc as PDF rectangle */
\r
385 public Rectangle rectangle;
\r
388 public int pageNumber;
\r
390 Page(PageDesc pageDesc, Rectangle rect, int pageNumber) throws ExportException {
\r
392 this.pageDesc = pageDesc;
\r
393 this.rectangle = rect;
\r
394 this.pageNumber = pageNumber;
\r
395 this.tmpFile = Simantics.getTempfile("export.core", "pdf");
\r
396 this.fos = new FileOutputStream( tmpFile, false );
\r
397 this.document = new Document(rectangle);
\r
398 this.document.setPageSize( rect ); // redundant?
\r
399 this.pdfWriter = PdfWriter.getInstance(document, fos);
\r
400 this.pdfWriter.setPdfVersion(PdfWriter.PDF_VERSION_1_7);
\r
401 this.pdfWriter.setCompressionLevel( compressionLevel );
\r
402 this.pdfWriter.setPageEvent(new ServiceBasedPdfExportPageEvent());
\r
403 this.document.open();
\r
404 this.cb = this.pdfWriter.getDirectContent();
\r
405 if (!this.document.newPage()) throw new ExportException("Failed to create new page.");
\r
406 } catch (IOException e) {
\r
407 throw new ExportException( e );
\r
408 } catch (DocumentException e) {
\r
409 throw new ExportException( e );
\r
414 * Create a graphics 2d Context that uses millimeters.
\r
416 * @param applyMargins top left position of margins is applied
\r
417 * @return graphics 2d context
\r
419 public Graphics2D createGraphics(boolean applyMargins) {
\r
420 float w = rectangle.getWidth();
\r
421 float h = rectangle.getHeight();
\r
422 double pw = pageDesc.getOrientedWidth();
\r
423 double ph = pageDesc.getOrientedHeight();
\r
424 Graphics2D g2d = cb.createGraphics(w, h, fontMapper);
\r
426 if ( applyMargins ) {
\r
427 Margins m = pageDesc.getMargins();
\r
429 double mw = pw - m.left.diagramAbsolute - m.right.diagramAbsolute;
\r
430 double mh = ph - m.top.diagramAbsolute - m.bottom.diagramAbsolute;
\r
431 double sx = m.left.diagramAbsolute;
\r
432 double sy = m.top.diagramAbsolute;
\r
434 // Convert to points
\r
435 mw = PageDesc.toPoints( mw );
\r
436 mh = PageDesc.toPoints( mh );
\r
437 sx = PageDesc.toPoints( sx );
\r
438 sy = PageDesc.toPoints( sy );
\r
440 g2d.translate(sx, sy);
\r
443 g2d.scale(w/pw, h/ph);
\r
448 * Of area inside the margins, return the width of the page in millimeters.
\r
450 * @return width (mm)
\r
452 public double getWidth() {
\r
453 Margins m = pageDesc.getMargins();
\r
454 return pageDesc.getOrientedWidth() - m.left.diagramAbsolute - m.right.diagramAbsolute;
\r
457 public double getHeight() {
\r
458 Margins m = pageDesc.getMargins();
\r
459 return pageDesc.getOrientedHeight() - m.top.diagramAbsolute - m.bottom.diagramAbsolute;
\r
463 * Add attachment to this page
\r
465 * @throws ExportException
\r
467 public void addAttachment(Content content) throws ExportException {
\r
470 if ( content.tmpFile == null ) throw new ExportException("Could not export "+content.filename+", null file.");
\r
471 if ( !content.tmpFile.exists() ) throw new ExportException("Could not export "+content.filename+", file not found.");
\r
473 Format format = ctx.eep.getFormat( content.formatId );
\r
474 //byte[] data = StreamUtil.readFully( content.tmpFile );
\r
475 PdfDictionary fileParameter = new PdfDictionary();
\r
476 PdfFileSpecification spec = PdfFileSpecification.fileEmbedded(
\r
478 content.tmpFile.getAbsolutePath(),
\r
482 "application/simantics/"+format.id(),
\r
485 pdfWriter.addFileAttachment( content.filename, spec );
\r
486 } catch (IOException e) {
\r
487 throw new ExportException( e.getClass().getName()+": "+e.getMessage() );
\r
489 ExportPdfWriter.this.addAttachment(content);
\r
492 public void close() throws ExportException {
\r
494 if ( document != null ) { document.close(); document = null; }
\r
495 if ( pdfWriter != null ) { pdfWriter.close(); pdfWriter = null; }
\r
496 if ( fos != null ) { fos.close(); fos = null; }
\r
497 if ( cb != null ) { cb = null; }
\r
498 } catch (IOException e) {
\r
499 throw new ExportException(e);
\r
505 public class Template {
\r
507 /** Suggested Page Desc */
\r
508 public PageDesc pageDesc;
\r
510 /** PageDesc as PDF rectangle */
\r
511 public Rectangle rectangle;
\r
513 /** Template name */
\r
514 public String name;
\r
517 public PdfTemplate tp;
\r
519 Template(String name, PageDesc pd, Rectangle rect, PdfTemplate tp) {
\r
520 this.pageDesc = pd;
\r
521 this.rectangle = rect;
\r
526 public Graphics2D createGraphics() {
\r
527 double w = pageDesc.getWidth();
\r
528 double h = pageDesc.getHeight();
\r
529 return tp.createGraphics((float) w, (float) h, fontMapper);
\r
534 public static Rectangle toRectangle(PageDesc pageDesc) {
\r
535 String arg = PageDesc.toPoints(pageDesc.getWidth()) + " " + PageDesc.toPoints(pageDesc.getHeight());
\r
536 Rectangle r = PageSize.getRectangle(arg);
\r
538 if (PageOrientation.Landscape == pageDesc.getOrientation())
\r
541 // Disable inherent borders from the PDF writer.
\r