/*
* 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.pdfbox.pdmodel.interactive.digitalsignature.visible;
import java.awt.geom.AffineTransform;
import java.awt.image.BufferedImage;
import java.io.IOException;
import java.io.OutputStream;
import java.util.List;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.pdfbox.cos.COSArray;
import org.apache.pdfbox.cos.COSDictionary;
import org.apache.pdfbox.cos.COSName;
import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.pdmodel.PDPage;
import org.apache.pdfbox.pdmodel.PDResources;
import org.apache.pdfbox.pdmodel.common.PDRectangle;
import org.apache.pdfbox.pdmodel.common.PDStream;
import org.apache.pdfbox.pdmodel.graphics.form.PDFormXObject;
import org.apache.pdfbox.pdmodel.graphics.image.JPEGFactory;
import org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject;
import org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary;
import org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceStream;
import org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature;
import org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm;
import org.apache.pdfbox.pdmodel.interactive.form.PDFieldTreeNode;
import org.apache.pdfbox.pdmodel.interactive.form.PDSignatureField;
/**
* Implementation of PDFTemplateBuilder.
* @see PDFTemplateBuilder
* @author Vakhtang Koroghlishvili
*/
public class PDVisibleSigBuilder implements PDFTemplateBuilder
{
private PDFTemplateStructure pdfStructure;
private static final Log log = LogFactory.getLog(PDVisibleSigBuilder.class);
@Override
public void createPage(PDVisibleSignDesigner properties)
{
PDPage page = new PDPage(new PDRectangle(properties.getPageWidth(),
properties.getPageHeight()));
pdfStructure.setPage(page);
log.info("PDF page has been created");
}
@Override
public void createTemplate(PDPage page) throws IOException
{
PDDocument template = new PDDocument();
template.addPage(page);
pdfStructure.setTemplate(template);
}
public PDVisibleSigBuilder()
{
pdfStructure = new PDFTemplateStructure();
log.info("PDF Strucure has been Created");
}
@Override
public void createAcroForm(PDDocument template)
{
PDAcroForm theAcroForm = new PDAcroForm(template);
template.getDocumentCatalog().setAcroForm(theAcroForm);
pdfStructure.setAcroForm(theAcroForm);
log.info("Acro form page has been created");
}
@Override
public PDFTemplateStructure getStructure()
{
return pdfStructure;
}
@Override
public void createSignatureField(PDAcroForm acroForm) throws IOException
{
PDSignatureField sf = new PDSignatureField(acroForm);
pdfStructure.setSignatureField(sf);
log.info("Signature field has been created");
}
@Override
public void createSignature(PDSignatureField pdSignatureField, PDPage page,
String signatureName) throws IOException
{
PDSignature pdSignature = new PDSignature();
pdSignatureField.setSignature(pdSignature);
pdSignatureField.getWidget().setPage(page);
page.getAnnotations().add(pdSignatureField.getWidget());
pdSignature.setName(signatureName);
pdSignature.setByteRange(new int[] { 0, 0, 0, 0 });
pdSignature.setContents(new byte[4096]);
pdfStructure.setPdSignature(pdSignature);
log.info("PDSignatur has been created");
}
@Override
public void createAcroFormDictionary(PDAcroForm acroForm, PDSignatureField signatureField)
throws IOException
{
@SuppressWarnings("unchecked")
List<PDFieldTreeNode> acroFormFields = acroForm.getFields();
COSDictionary acroFormDict = acroForm.getDictionary();
acroForm.setSignaturesExist(true);
acroForm.setAppendOnly(true);
acroFormDict.setDirect(true);
acroFormFields.add(signatureField);
acroForm.setDefaultAppearance("/sylfaen 0 Tf 0 g");
pdfStructure.setAcroFormFields(acroFormFields);
pdfStructure.setAcroFormDictionary(acroFormDict);
log.info("AcroForm dictionary has been created");
}
@Override
public void createSignatureRectangle(PDSignatureField signatureField,
PDVisibleSignDesigner properties) throws IOException
{
PDRectangle rect = new PDRectangle();
rect.setUpperRightX(properties.getxAxis() + properties.getWidth());
rect.setUpperRightY(properties.getTemplateHeight() - properties.getyAxis());
rect.setLowerLeftY(properties.getTemplateHeight() - properties.getyAxis() -
properties.getHeight());
rect.setLowerLeftX(properties.getxAxis());
signatureField.getWidget().setRectangle(rect);
pdfStructure.setSignatureRectangle(rect);
log.info("rectangle of signature has been created");
}
@Override
public void createAffineTransform(byte[] params)
{
AffineTransform transform = new AffineTransform(params[0], params[1], params[2],
params[3], params[4], params[5]);
pdfStructure.setAffineTransform(transform);
log.info("Matrix has been added");
}
@Override
public void createProcSetArray()
{
COSArray procSetArr = new COSArray();
procSetArr.add(COSName.getPDFName("PDF"));
procSetArr.add(COSName.getPDFName("Text"));
procSetArr.add(COSName.getPDFName("ImageB"));
procSetArr.add(COSName.getPDFName("ImageC"));
procSetArr.add(COSName.getPDFName("ImageI"));
pdfStructure.setProcSet(procSetArr);
log.info("ProcSet array has been created");
}
@Override
public void createSignatureImage(PDDocument template, BufferedImage image) throws IOException
{
pdfStructure.setImage(JPEGFactory.createFromImage(template, image));
log.info("Visible Signature Image has been created");
}
@Override
public void createFormaterRectangle(byte[] params)
{
PDRectangle formrect = new PDRectangle();
formrect.setUpperRightX(params[0]);
formrect.setUpperRightY(params[1]);
formrect.setLowerLeftX(params[2]);
formrect.setLowerLeftY(params[3]);
pdfStructure.setFormaterRectangle(formrect);
log.info("Formater rectangle has been created");
}
@Override
public void createHolderFormStream(PDDocument template)
{
PDStream holderForm = new PDStream(template);
pdfStructure.setHolderFormStream(holderForm);
log.info("Holder form Stream has been created");
}
@Override
public void createHolderFormResources()
{
PDResources holderFormResources = new PDResources();
pdfStructure.setHolderFormResources(holderFormResources);
log.info("Holder form resources have been created");
}
@Override
public void createHolderForm(PDResources holderFormResources, PDStream holderFormStream,
PDRectangle formrect)
{
PDFormXObject holderForm = new PDFormXObject(holderFormStream);
holderForm.setResources(holderFormResources);
holderForm.setBBox(formrect);
holderForm.setFormType(1);
pdfStructure.setHolderForm(holderForm);
log.info("Holder form has been created");
}
@Override
public void createAppearanceDictionary(PDFormXObject holderForml,
PDSignatureField signatureField) throws IOException
{
PDAppearanceDictionary appearance = new PDAppearanceDictionary();
appearance.getCOSObject().setDirect(true);
PDAppearanceStream appearanceStream = new PDAppearanceStream(holderForml.getCOSStream());
appearance.setNormalAppearance(appearanceStream);
signatureField.getWidget().setAppearance(appearance);
pdfStructure.setAppearanceDictionary(appearance);
log.info("PDF appereance Dictionary has been created");
}
@Override
public void createInnerFormStream(PDDocument template)
{
PDStream innterFormStream = new PDStream(template);
pdfStructure.setInnterFormStream(innterFormStream);
log.info("Stream of another form (inner form - it would be inside holder form) " +
"has been created");
}
@Override
public void createInnerFormResource()
{
PDResources innerFormResources = new PDResources();
pdfStructure.setInnerFormResources(innerFormResources);
log.info("Resources of another form (inner form - it would be inside holder form)" +
"have been created");
}
@Override
public void createInnerForm(PDResources innerFormResources, PDStream innerFormStream,
PDRectangle formrect)
{
PDFormXObject innerForm = new PDFormXObject(innerFormStream);
innerForm.setResources(innerFormResources);
innerForm.setBBox(formrect);
innerForm.setFormType(1);
pdfStructure.setInnerForm(innerForm);
log.info("Another form (inner form - it would be inside holder form) have been created");
}
@Override
public void insertInnerFormToHolerResources(PDFormXObject innerForm,
PDResources holderFormResources)
{
COSName name = holderFormResources.add(innerForm, "FRM");
pdfStructure.setInnerFormName(name);
log.info("Alerady inserted inner form inside holder form");
}
@Override
public void createImageFormStream(PDDocument template)
{
PDStream imageFormStream = new PDStream(template);
pdfStructure.setImageFormStream(imageFormStream);
log.info("Created image form Stream");
}
@Override
public void createImageFormResources()
{
PDResources imageFormResources = new PDResources();
pdfStructure.setImageFormResources(imageFormResources);
log.info("Created image form Resources");
}
@Override
public void createImageForm(PDResources imageFormResources, PDResources innerFormResource,
PDStream imageFormStream, PDRectangle formrect, AffineTransform at,
PDImageXObject img) throws IOException
{
// if you need text on the visible signature:
//
// PDFont font = PDTrueTypeFont.loadTTF(this.pdfStructure.getTemplate(),
// new File("D:\\arial.ttf"));
// font.setFontEncoding(new WinAnsiEncoding());
//
// Map<String, PDFont> fonts = new HashMap<String, PDFont>(); fonts.put("arial", font);
PDFormXObject imageForm = new PDFormXObject(imageFormStream);
imageForm.setBBox(formrect);
imageForm.setMatrix(at);
imageForm.setResources(imageFormResources);
imageForm.setFormType(1);
// imageForm.getResources().addFont(font);
// imageForm.getResources().setFonts(fonts);
imageFormResources.getCOSObject().setDirect(true);
COSName imageFormName = innerFormResource.add(imageForm, "n");
COSName imageName = imageFormResources.add(img, "img");
pdfStructure.setImageForm(imageForm);
pdfStructure.setImageFormName(imageFormName);
pdfStructure.setImageName(imageName);
log.info("Created image form");
}
@Override
public void injectProcSetArray(PDFormXObject innerForm, PDPage page,
PDResources innerFormResources, PDResources imageFormResources,
PDResources holderFormResources, COSArray procSet)
{
innerForm.getResources().getCOSObject().setItem(COSName.PROC_SET, procSet);
page.getCOSObject().setItem(COSName.PROC_SET, procSet);
innerFormResources.getCOSObject().setItem(COSName.PROC_SET, procSet);
imageFormResources.getCOSObject().setItem(COSName.PROC_SET, procSet);
holderFormResources.getCOSObject().setItem(COSName.PROC_SET, procSet);
log.info("inserted ProcSet to PDF");
}
@Override
public void injectAppearanceStreams(PDStream holderFormStream, PDStream innterFormStream,
PDStream imageFormStream, COSName imageObjectName,
COSName imageName, COSName innerFormName,
PDVisibleSignDesigner properties) throws IOException
{
// 100 means that document width is 100% via the rectangle. if rectangle
// is 500px, images 100% is 500px.
// String imgFormComment = "q "+imageWidthSize+ " 0 0 50 0 0 cm /" +
// imageName + " Do Q\n" + builder.toString();
String imgFormComment = "q " + 100 + " 0 0 50 0 0 cm /" + imageName.getName() + " Do Q\n";
String holderFormComment = "q 1 0 0 1 0 0 cm /" + innerFormName.getName() + " Do Q \n";
String innerFormComment = "q 1 0 0 1 0 0 cm /" + imageObjectName.getName() + " Do Q\n";
appendRawCommands(pdfStructure.getHolderFormStream().createOutputStream(),
holderFormComment);
appendRawCommands(pdfStructure.getInnterFormStream().createOutputStream(),
innerFormComment);
appendRawCommands(pdfStructure.getImageFormStream().createOutputStream(),
imgFormComment);
log.info("Injected apereance stream to pdf");
}
public void appendRawCommands(OutputStream os, String commands) throws IOException
{
os.write(commands.getBytes("UTF-8"));
os.close();
}
@Override
public void createVisualSignature(PDDocument template)
{
pdfStructure.setVisualSignature(template.getDocument());
log.info("Visible signature has been created");
}
@Override
public void createWidgetDictionary(PDSignatureField signatureField,
PDResources holderFormResources) throws IOException
{
COSDictionary widgetDict = signatureField.getWidget().getDictionary();
widgetDict.setNeedToBeUpdate(true);
widgetDict.setItem(COSName.DR, holderFormResources.getCOSObject());
pdfStructure.setWidgetDictionary(widgetDict);
log.info("WidgetDictionary has been crated");
}
@Override
public void closeTemplate(PDDocument template) throws IOException
{
template.close();
pdfStructure.getTemplate().close();
}
}