Skip to content

Improve visible PDF signature capabilities

Martin requested to merge martin-bts/poppler:martin/pretty_signature_annotation into master

As far as I can tell, digitally signing a PDF document and creating a corresponding annotation widget is exceptionally rare in the open source world. I am currently working to make this feature in Okular applicable to my every day use cases. A few of the issues I encountered along the way do concern Poppler:

  1. PDFDoc::sign draws a border around the signature. It's width can be controlled through the borderWidth parameter. However, signatureAnnot->generateFieldAppearance() is called before border->setWidth(borderWidth), and therefore the parameter has no effect.
  2. Applications cannot pass a font size to be used with signatureLeftText and therefore Poppler always uses its default (20).
  3. Background images are only drawn if signatureLeftText is empty.
  4. Qt applications cannot pass an imagePath to PDFDoc::sign as the data structure passed around doesn't have an attribute for it.

This pull request contains how I did solve these issues. First, I defined a new class NewSignatureData, which semantically mirrors the class NewSignatureData I found in the Qt APIs. Then I changed the APIs to use instances of this new class to pass signature related data to PDFDoc::sign, which is a breaking change to its signature. After that I changed the widget drawing, starting from PDFDoc::sign and into AnnotAppearanceBuilder to what I think yields better results: I moved signatureAnnot->generateFieldAppearance(); after border->setWidth() and changed drawSignatureFieldText to always draw a background image (if available), not just if signatureLeftText is empty.

While developing this I kept moving things back and forth between Okular and Poppler, because I had no idea what could and should be done in Poppler and what could and should be done in Okular. Ultimately the changes I did ...

  • enable Qt applications to provide an additional font sized, to be used for "fancy" signatures
  • enable Qt applications to provide a background image for signature widgets
  • make borderWidth have an effect on the generated signature widget

Changing PDFDoc::sign's three line signature to a new object seems a bit arbitrary. It made things easier for me while moving things back and forth and a change is required anyways to provide the second font size. Further more, future work may see users providing their own fonts for their signatures. This is also data that would have to be passed into PDFDoc::sign ...

I understand this PR is quite unsolicited, doesn't fix any recorded issues and is not a small patch. I am happy to make adaptions before these changes can be accepted.

Merge request reports