Commits vergleichen

...
Anmelden, um einen neuen Pull-Request zu erstellen.

24 Commits

Autor SHA1 Nachricht Datum
4d40254f62 added the PKGBuild to the repo 2025-07-22 00:12:57 +02:00
Axel Svensson
48cbf7830a Polish README.md 2025-04-20 16:51:00 +02:00
Axel Svensson
f63c07f37b Support numpad + and - 2025-04-06 13:29:50 +02:00
Axel Svensson
8a6c7d5f2f Handle qpdf warnings
Fixes #12
2025-03-14 20:39:24 +01:00
Axel Svensson
7b5a699060 Merge branch 'dev' 2024-10-24 06:53:39 +02:00
Axel Svensson
b3a9474e4e Fix: Account for imprecision in ghostscript
Fixes #14.
2024-10-24 06:52:09 +02:00
Axel Svensson
9c7ba6da50 Improve signature sizing
Fixes #13.

- Improve README.md to clarify signature anchor point.
- Change -x and -y
  - Require % unit
  - Support specifying coordinate relative both edges.
- Add -r / --resize
- Change -W and -H
  - Add support for units
  - Change default to 50%
2024-10-24 06:51:51 +02:00
Axel Svensson
bcc37b0929 Refactor signature path logic 2024-07-17 16:36:48 +00:00
Axel Svensson
17ccf8b527 Revert "Minimize empty-3inx2in.pdf"
This reverts commit 2e9395cee3.
2024-07-17 16:36:46 +00:00
Axel Svensson
6c373e3df2 Merge branch 'dev' 2024-07-16 21:11:03 +00:00
Axel Svensson
1a69e20946 Check python version 2024-07-16 20:31:54 +00:00
Axel Svensson
9e0ef1a65c Update copyright 2024-07-16 14:40:16 +00:00
Axel Svensson
21aad7d1b9 Fix regex in pdfGetSize 2024-07-16 13:29:12 +00:00
Axel Svensson
ed54c79aa7 Refactor dependency tracking for files 2024-07-16 13:27:10 +00:00
Axel Svensson
c0dfb3ec4c Check that --signature exists 2024-07-16 13:27:10 +00:00
Axel Svensson
c61747cf7a Add pdf-sign --text and pdf-from-text
Fixes #9.
2024-07-16 13:27:10 +00:00
Axel Svensson
3eed74e1ef Refuse to operate on files with dash prefix
Fixes #6.
2024-07-16 13:27:10 +00:00
Axel Svensson
0a0c7c9e13 Improve information about signature directory
Rejects #8.
2024-07-16 13:27:10 +00:00
Axel Svensson
0fbba14076 Support signature PDFs with an explicit CropBox 2024-07-16 13:27:10 +00:00
Axel Svensson
17ec3c5e56 Improve startup time 2024-07-16 13:27:10 +00:00
Axel Svensson
a3d25a566f Make initial window size adaptive 2024-07-16 13:27:10 +00:00
Axel Svensson
34fdeb1043 Improve display size calculations 2024-07-16 13:27:10 +00:00
Axel Svensson
8f299dda2e Improve help text
Fixes #11.
2024-07-16 13:27:10 +00:00
Axel Svensson
6b80860a9b Use either qpdf or pdftk
Fixes #5.
2024-07-16 07:20:15 +00:00
10 geänderte Dateien mit 638 neuen und 104 gelöschten Zeilen

23
.SRCINFO Normale Datei
Datei anzeigen

@ -0,0 +1,23 @@
pkgbase = pdf-sign
pkgdesc = Simple tool to sign PDFs using an saved signature
pkgver = 1.0
pkgrel = 1
url = https://github.com/svenssonaxel/pdf-sign
arch = x86_64
license = MIT
depends = ghostscript
depends = python
depends = qpdf
depends = poppler
optdepends = tk: for interactive usage
optdepends = pdftk: an alterative tool to process PDF for qpdf
source = pdf-create-empty
source = pdf-from-text
source = pdf-sign
source = empty-3inx2in.pdf
sha256sums = d6b3bd23a3fcf28561e152690332738babf5e71afde40e5727c643a5805ae76b
sha256sums = 4a509aa3e787c3e617f151bcd25dd93adf9af3af477562c64988f7784395d40d
sha256sums = 7b52792ead60257c57f4a12d727a882936f24b9cb3ae57d73beb90cdd7960707
sha256sums = a2fd2476c1d8364853c2382a8090d8fbc2f11fb4a535714e27a3069ce009eef3
pkgname = pdf-sign

Datei anzeigen

@ -1,6 +1,6 @@
The MIT License (MIT)
Copyright © 2021 Axel Svensson
Copyright © 2021-2024 Axel Svensson
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

39
PKGBUILD Normale Datei
Datei anzeigen

@ -0,0 +1,39 @@
# Maintainer: Sebastian Tobie <archlinux@sebastian-tobie.de>
# based on the PKGBUILD of sulis
pkgname=pdf-sign
pkgver=1.0
pkgrel=1
pkgdesc='Simple tool to sign PDFs using an saved signature'
arch=('x86_64')
url='https://github.com/svenssonaxel/pdf-sign'
license=('MIT')
depends=(
'ghostscript'
'python'
'qpdf'
'poppler'
)
optdepends=(
'tk: for interactive usage'
'pdftk: an alterative tool to process PDF for qpdf'
)
source=(
'pdf-create-empty'
'pdf-from-text'
'pdf-sign'
'empty-3inx2in.pdf'
)
sha256sums=(
'd6b3bd23a3fcf28561e152690332738babf5e71afde40e5727c643a5805ae76b'
'4a509aa3e787c3e617f151bcd25dd93adf9af3af477562c64988f7784395d40d'
'7b52792ead60257c57f4a12d727a882936f24b9cb3ae57d73beb90cdd7960707'
'a2fd2476c1d8364853c2382a8090d8fbc2f11fb4a535714e27a3069ce009eef3'
)
package() {
install -Dm755 -T pdf-create-empty "${pkgdir}/usr/bin/pdf-create-empty"
install -Dm755 -T pdf-from-text "${pkgdir}/usr/bin/pdf-from-text"
install -Dm755 -T pdf-sign "${pkgdir}/usr/bin/pdf-sign"
install -Dm644 -T empty-3inx2in.pdf "${pkgdir}/usr/share/doc/pdf-sign/examples/empty-3inx2in.pdf"
}

BIN
README-example-signature.gif Normale Datei

Binäre Datei nicht angezeigt.

Nachher

Breite:  |  Höhe:  |  Größe: 22 KiB

Datei anzeigen

Vorher

Breite:  |  Höhe:  |  Größe: 342 KiB

Nachher

Breite:  |  Höhe:  |  Größe: 342 KiB

Datei anzeigen

@ -5,7 +5,7 @@
A tool to sign PDF files, with Linux support.
We are here referring to the visible, non-cryptographic squiggles.
![](README-example.gif)
![](README-example-use.gif)
## How
@ -16,12 +16,18 @@ The recommended way is:
* Use an application of your choice to sign it.
You can for example use Okular's Freehand Line, or transfer it to your smartphone and use Adobe Acrobat Reader.
Keep in mind that it's the center of this mini-page that will be used for positioning the signature.
* Put the signed file in `~/.pdf_signatures/`.
<img src="README-example-signature.gif" width="250"/>
It's a good idea to write your signature on an imagined line through the center of the mini-page.
That way, it can be positioned correctly by clicking on the signature line.
* Put the signed file in your signature directory.
The signature directory is `$PDF_SIGNATURE_DIR`, `$XDG_CONFIG_HOME/pdf_signatures`, `$HOME/.config/pdf_signatures` or `$HOME/.pdf_signatures/`; the first one that exists. Use `pdf-sign -h` to confirm which one will be used on your system.
You can now use the `pdf-sign` tool interactively (or non-interactively) to sign PDF files.
The GUI is self documented and allows both keyboard-only and pointer-only operation.
Run `pdf-sign -h` or `pdf-create-empty -h` for details.
Run `pdf-sign -h`, `pdf-create-empty -h` or `pdf-from-text -h` for details.
**Installation**
@ -29,9 +35,9 @@ Run `pdf-sign -h` or `pdf-create-empty -h` for details.
* `python3.7` or later
* Python module `tkinter` (only needed for interactive use)
* `gs` (Ghostscript)
* `pdftk`
* `qpdf` or `pdftk` (at least one of them)
* `pdfinfo`
* Copy one or both tools to a directory in your `$PATH`.
* Copy the tools to a directory in your `$PATH`.
**Installation on Debian**
@ -40,9 +46,20 @@ apt-get update
apt-get install -y coreutils git python3 python3-tk ghostscript pdftk poppler-utils
git clone https://github.com/svenssonaxel/pdf-sign.git
cd pdf-sign
cp pdf-sign pdf-create-empty /usr/local/bin/
cp pdf-* /usr/local/bin/
```
### Related use cases
* You can add the date or other pieces of text using the `--text` CLI option or `Signature -> Custom text` menu option.
If you want both a date and a signature, you have to invoke `pdf-sign` twice.
* You can convert SVG stamps/marks and add them to your signature directory. Example:
```
curl -LO https://www.svgrepo.com/download/438371/checkmark-round.svg
sudo apt-get install librsvg2-bin
rsvg-convert -f pdf -o ~/.config/pdf_signatures/check.pdf checkmark-round.svg
```
## Why
There appears to be a lack of applications that run on Linux and allow for attaching free-hand signatures to PDF files in a good way.

Binäre Datei nicht angezeigt.

Datei anzeigen

@ -1,6 +1,8 @@
#!/usr/bin/env python3
#Dependencies: python3, gs
# Dependencies:
# - python3.7 or later
# - gs (Ghostscript)
import argparse, os, re, subprocess, sys
@ -42,6 +44,10 @@ def die(reason):
print(reason, file=sys.stderr)
sys.exit(2)
pyver = sys.version_info
if not (pyver.major == 3 and pyver.minor >= 7):
die("Requires python 3.7 or later")
parser = argparse.ArgumentParser(description='Create an empty, transparent PDF file.')
parser.add_argument('-o', '--output', metavar='FILE', type=str, help='Output PDF file. (default: empty-DIMENSIONS.pdf)')
parser.add_argument('-d', '--dimensions', type=str, default='3inx2in', help='The page dimensions of the file to create. Supports units pts, in, cm, and mm. (default: 3inx2in)')

102
pdf-from-text Ausführbare Datei
Datei anzeigen

@ -0,0 +1,102 @@
#!/usr/bin/env python3
#Dependencies: python3.7 or later and gs (Ghostscript)
import argparse, os, re, subprocess, sys, tempfile
def main():
parser = argparse.ArgumentParser(description="Create a correctly cropped PDF from one line of text. Only Latin-1 character set is supported.")
parser.add_argument("-t", "--text", required=True, help="Text to be converted to PDF.")
parser.add_argument("-o", "--output", required=True, help="Output PDF file.")
parser.add_argument("-s", "--size", type=int, default=12, help="Font size in points (default 12).")
parser.add_argument("-m", "--margin", type=int, default=1, help="Margin in points (default 1).")
args = parser.parse_args()
text_to_pdf(args.text, args.output, args.size, args.margin)
# Keep this function in sync with pdf-sign
def text_to_pdf(text, output, size, margin):
# Validate text
text_chars=set(map(ord, text))
latin1_chars=set([*range(0x20, 0x7f), *range(0xa0, 0x100)])
if not text_chars.issubset(latin1_chars):
die(f"Error: Only non-control latin-1 characters are supported. Unsupported characters: {', '.join(map(hex, text_chars - latin1_chars))}")
text.encode('latin-1').decode('latin-1') # Assertion. E.i., an exception here indicates a bug.
with tempfile.TemporaryDirectory() as tempdir:
# Write postscript file
ps_file=os.path.join(tempdir, "file.ps")
text_len=len(text)
w=text_len * size + margin * 2
h=size * 3 + margin * 2
x=size + margin
y=size + margin
ps_text = (text
.replace("\\", "\\\\")
.replace("(", "\\(")
.replace(")", "\\)")
)
def write_ps():
with open(ps_file, "w", encoding="latin-1") as f:
f.write('\n'.join([
"%!PS-Adobe-3.0",
f"%%BoundingBox: 0 0 {w} {h}",
"%%Pages: 1",
"%%EndComments",
"%%Page: 1 1",
f"/DejaVuSansMono findfont {size} scalefont setfont",
f"{x} {y} moveto",
f"({ps_text}) show",
"showpage"]))
# Write postscript file with too big bounding box
write_ps()
# Get correct bounding box
bbox_result = subprocess.run([
"gs", '-dBATCH', '-dNOPAUSE', '-dSAFER', '-dQUIET',
"-sDEVICE=bbox",
ps_file
], stderr=subprocess.PIPE, text=True, check=True)
bbox = m(r'.*%%HiResBoundingBox: (\d+(\.\d+)?) (\d+(\.\d+)?) (\d+(\.\d+)?) (\d+(\.\d+)?)\n.*', bbox_result.stderr)
if not bbox:
die("Error: Unable to extract bounding box.")
# Adjust variables for bounding box
llx, lly, urx, ury = float(bbox[1]), float(bbox[3]), float(bbox[5]), float(bbox[7])
llx, lly, urx, ury = llx - margin, lly - margin, urx + margin, ury + margin
w=urx - llx
h=ury - lly
x-=llx
y-=lly
# Write postscript file with correct bounding box
write_ps()
# Convert to PDF
gs_cmd = [
"gs", '-dBATCH', '-dNOPAUSE', '-dSAFER', '-dQUIET',
"-o", output,
"-sDEVICE=pdfwrite",
f"-dDEVICEWIDTHPOINTS={w}",
f"-dDEVICEHEIGHTPOINTS={h}",
"-dFIXEDMEDIA",
"-c", "[ /PAGES pdfmark",
"-f", ps_file
]
subprocess.run(gs_cmd, check=True, stdout=subprocess.DEVNULL)
def m(pattern, string):
match = re.match(pattern, string, re.DOTALL)
if not match:
return None
if(match.group(0) != string):
die(f'Pattern /${pattern}/ matched only part of string')
ret = []
for index in range((match.lastindex or 0)+1):
ret.append(match.group(index))
return ret
def die(reason):
print(reason, file=sys.stderr)
sys.exit(2)
pyver = sys.version_info
if not (pyver.major == 3 and pyver.minor >= 7):
die("Requires python 3.7 or later")
if __name__ == "__main__":
main()

539
pdf-sign
Datei anzeigen

@ -1,24 +1,50 @@
#!/usr/bin/env python3
#Dependencies: python3.7 or later with module tkinter, gs (Ghostscript), pdftk and pdfinfo.
# Dependencies:
# - python3.7 or later with module tkinter
# - gs (Ghostscript)
# - qpdf or pdftk (pdf-sign will use pdftk if qpdf cannot be found)
# - pdfinfo.
import argparse, os, queue, re, subprocess, sys, tempfile, traceback, time
def die(reason):
print(reason, file=sys.stderr)
sys.exit(1)
pyver = sys.version_info
if not (pyver.major == 3 and pyver.minor >= 7):
die("Requires python 3.7 or later")
# Inspired by https://unix.stackexchange.com/a/141496
def main(args):
if not hasQpdf and not has("pdftk"):
die("Needs either qpdf or pdftk installed")
if not has("gs"):
die("Needs Ghostscript installed")
if not has("pdfinfo"):
die("Needs pdfinfo installed")
filePath=args.input
if not isPdfFilename(filePath):
die("Input file must end with .pdf (case insensitive)")
if filePath.startswith('-'):
# A cheap solution to a rare problem
die("Input file may not start with a dash (-)")
with tempfile.TemporaryDirectory() as tempdir:
intmp=lambda fileName: Volatile(os.path.join(tempdir, fileName))
intmp=lambda fileName: os.path.join(tempdir, fileName)
# Maybe flatten (make forms non-editable) before signing
if args.flatten:
inputPDF=str(intmp('input.pdf'))
subprocess.run([
inputPDF=intmp('input.pdf')
qpdfOrPdftk(args, [
'qpdf',
'--flatten-annotations=all',
'--generate-appearances',
filePath, inputPDF,
],[
'pdftk', filePath,
'output', inputPDF,
'flatten'
], check=True)
])
else:
inputPDF=filePath
# The chosen page
@ -26,35 +52,150 @@ def main(args):
if args.page < -pageCount or args.page==0 or pageCount < args.page:
die('Page number out of range')
pageNumber=Cell(args.page if 0 < args.page else pageCount+args.page+1)
@Cell
@VolatileCell
def pagePDF():
outFile=intmp('page.pdf')
subprocess.run([
qpdfOrPdftk(args, [
'qpdf', '--pages', '.', f'{pageNumber()}', '--',
inputPDF, outFile
],[
'pdftk', inputPDF,
'cat', str(pageNumber()),
'output', str(outFile)
], check=True)
'output', outFile])
return outFile
pageSize=Cell(lambda: pdfGetSize(str(pagePDF())))
pageSize=Cell(lambda: pdfGetSize(pagePDF()))
# The chosen signature
if not args.signature and args.batch:
die('In batch mode, signature must be specified.')
signatureDir=getSignatureDir()
signatures=[*filter(isPdfFilename, os.listdir(signatureDir))] if not args.signature else [None]
if not signatures:
die(f'No .pdf files found in {signatureDir}')
signatures.sort()
if args.signature:
if args.text:
die('--signature and --text cannot be specified together.')
if not os.path.exists(args.signature):
die(f'File not found: {args.signature}')
signatures=[('file', args.signature, args.signature)]
elif args.batch:
assert not args.signature
if not args.text:
die('In batch mode, --signature or --text must be specified.')
if len(args.text) > 1:
die('In batch mode, --text must be given only once.')
validateText(args.text[0], True)
signatures=[('text', textLabel(args.text[0]), args.text[0])]
else:
(signatureDir, signatureDirHelp)=getSignatureDirAndHelp()
signatures=([('file', x, os.path.join(signatureDir, x))
for x in filter(isPdfFilename, os.listdir(signatureDir))]
if signatureDir else [])
signatures.sort()
if not signatures and not args.text:
die('Could not find any usable signatures. No --signature, no --text, and ' +
('no .pdf files found in {signatureDir}.'
if signatureDir else
f'no signature directory. The options considered for signature directory are: {signatureDirHelp}'))
if args.text:
assert(len(args.text) > 0)
for text in args.text:
validateText(text, True)
signatures=[('text', textLabel(x), x) for x in args.text] + signatures
signatureIndex=Cell(0)
signaturePath=Cell(lambda: args.signature if args.signature else os.path.join(signatureDir, signatures[signatureIndex()]))
signatureSize=Cell(lambda: pdfGetSize(signaturePath()))
signaturePositionX=Cell(args.x_coordinate)
signaturePositionY=Cell(args.y_coordinate)
signatureScale=Cell(0)
@Cell
def signaturePath():
(signType, _, content)=signatures[signatureIndex()]
if signType=='cell':
(signType, _, content)=content()
if signType=='file':
return content
assert signType=='text'
cache = signaturePath._cache
if content in cache:
return cache[content]
fileName=intmp(f"text{len(cache)}.pdf")
text_to_pdf(content, fileName, 12, 1)
cache[content]=fileName
return fileName
signaturePath._cache={}
signatureSize=Cell(lambda: pdfGetSize(signaturePath()))
try:
xm=m("^(L\\+|L-|R\\+|R-|-|)([0-9.]+)%$", args.x_coordinate)
default_x=(lambda x:{'L+':x,'L-':-x,'R+':1+x,'R-':1-x,'-':-x,'':x}[xm[1]])(float(xm[2])/100)
except:
die('Invalid -x option')
try:
ym=m("^(T\\+|T-|B\\+|B-|-|)([0-9.]+)%$", args.y_coordinate)
default_y=(lambda y:{'T+':y,'T-':-y,'B+':1+y,'B-':1-y,'-':-y,'':y}[ym[1]])(float(ym[2])/100)
except:
die('Invalid -y option')
signaturePositionX=Cell(default_x)
signaturePositionY=Cell(default_y)
signatureScale=Cell(0)
def translatablePDF(path):
cache = translatablePDF._cache
if path not in cache:
(w, h) = pdfGetSize(path)
if not (1 < w and 1 < h):
die(f"The PDF at {path} is unusable as a signature due to too small dimensions.")
(double_w, double_h) = (2*w, 2*h)
testFile = intmp('translateTest.pdf')
subprocess.run([
'gs', '-dBATCH', '-dNOPAUSE', '-dSAFER', '-dQUIET',
f'-sOutputFile={testFile}',
'-sDEVICE=pdfwrite',
f'-dDEVICEWIDTHPOINTS={double_w}', f'-dDEVICEHEIGHTPOINTS={double_h}', '-dFIXEDMEDIA',
'-c', f'<</BeginPage{{{w} {h} translate}}>> setpagedevice',
'-f', path,
], check=True)
(test_w, test_h) = pdfGetSize(testFile)
if abs(test_w - double_w) < 0.01 and abs(test_h - double_h) < 0.01:
# The pdf file at path can be translated correctly
cache[path] = path
elif (test_w, test_h) == (w, h):
# The pdf file at path cannot be translated correctly.
# Rather, the size is unchanged. This can happen if the PDF
# has an explicit CropBox set, e.g. is created with
# gs -c '[/CropBox [0 0 100 50] /PAGES pdfmark'. We have to
# remove it to make the PDF translatable and usable as a
# signature.
translatableFileName = intmp(f'translatable{len(cache)}.pdf')
emptyFileName = intmp(f'empty{len(cache)}.pdf')
subprocess.run([
'gs', '-dBATCH', '-dNOPAUSE', '-dSAFER', '-dQUIET',
f'-sOutputFile={emptyFileName}',
'-sDEVICE=pdfwrite',
f'-dDEVICEWIDTHPOINTS={w}', f'-dDEVICEHEIGHTPOINTS={h}',
], check=True)
qpdfOrPdftk(args, [
'qpdf', '--overlay', path, '--',
emptyFileName, translatableFileName,
],[
'pdftk', emptyFileName,
'stamp', path,
'output', translatableFileName
])
cache[path] = translatableFileName
else:
die(f"The PDF at {path} is unusable as a signature. Reason unknown.")
return cache[path]
translatablePDF._cache={}
@Cell
def defaultResizeFactor():
(pageWidth, pageHeight)=pageSize()
try:
wm=m("^([0-9.]+)(pts|pt|in|cm|mm|%)$", args.width)
maxSignatureWidth=int(float(wm[1])*({'pts':1,'pt':1,'in':72,'cm':28.3,'mm':2.83,'%':pageWidth/100}[wm[2]]))
except:
die('Invalid -W option')
try:
hm=m("^([0-9.]+)(pts|pt|in|cm|mm|%)$", args.height)
maxSignatureHeight=int(float(hm[1])*({'pts':1,'pt':1,'in':72,'cm':28.3,'mm':2.83,'%':pageHeight/100}[hm[2]]))
except:
die('Invalid -H option')
(signatureWidth, signatureHeight)=signatureSize()
return min(args.resize_factor,
maxSignatureWidth / signatureWidth,
maxSignatureHeight / signatureHeight)
@VolatileCell
def signaturePositionedPDF():
(w, h)=pageSize()
(sw, sh)=signatureSize()
resize=1.1**signatureScale()*min(args.width*w/sw, args.height*h/sh)
resize=1.1**signatureScale()*defaultResizeFactor()
dx=w*signaturePositionX()/resize - sw/2
dy=h*(1-signaturePositionY())/resize - sh/2
outFile=intmp('signature-positioned.pdf')
@ -64,18 +205,21 @@ def main(args):
'-sDEVICE=pdfwrite',
f'-dDEVICEWIDTHPOINTS={w}', f'-dDEVICEHEIGHTPOINTS={h}', '-dFIXEDMEDIA',
'-c', f'<</BeginPage{{{resize} {resize} scale {dx} {dy} translate}}>> setpagedevice',
'-f', signaturePath(),
'-f', translatablePDF(signaturePath()),
], check=True)
return outFile
# The signed page
@Cell
@VolatileCell
def signedPagePDF():
outFile=intmp('signed-page.pdf')
subprocess.run([
'pdftk', str(pagePDF()),
'stamp', str(signaturePositionedPDF()),
'output', str(outFile)
], check=True)
qpdfOrPdftk(args, [
'qpdf', '--overlay', signaturePositionedPDF(), '--',
pagePDF(), outFile,
],[
'pdftk', pagePDF(),
'stamp', signaturePositionedPDF(),
'output', outFile
])
return outFile
# The signed page as PNG, for GUI use
displayMaxSize=Cell((400, 800))
@ -85,7 +229,7 @@ def main(args):
(pageWidth, pageHeight)=pageSize()
scale=min(maxWidth/pageWidth, maxHeight/pageHeight)
return (round(pageWidth*scale), round(pageHeight*scale))
@Cell
@VolatileCell
def displayPNG():
(w, h)=displaySize()
outFile=intmp('display.png')
@ -95,7 +239,7 @@ def main(args):
'-sDEVICE=pngalpha',
'-dMaxBitmap=2147483647',
f'-dDEVICEWIDTHPOINTS={w}', f'-dDEVICEHEIGHTPOINTS={h}', '-dFIXEDMEDIA', '-dPDFFitPage',
'-f', str(signedPagePDF()),
'-f', signedPagePDF(),
], check=True)
return outFile
# GUI
@ -104,9 +248,12 @@ def main(args):
if gui:
try:
import tkinter as tk
from tkinter import simpledialog
except ModuleNotFoundError:
die('Cannot find Python module `tkinter`, which is needed for interactive use.')
doSign=False
customText=Cell(('text', None, time.strftime('%Y-%m-%d')))
customTextIndex = len(signatures)
# Commands
def uf(fun):
def ret():
@ -139,6 +286,32 @@ def main(args):
if i<len(signatures):
signatureIndex(i)
update()
def cmd_customText():
if args.signature:
return
# Get text from user
text = simpledialog.askstring(
"Custom Text",
"Input the text you want to stamp this PDF file with",
initialvalue=customText()[2])
if text == None:
return
# Validate text
validateMsg = validateText(text, False)
if validateMsg:
simpledialog.messagebox.showerror(
parent=root,
title="Invalid text",
message=validateMsg
)
return
# Set text
customText(('text', None, text))
signatureIndex(customTextIndex)
label='Custom text: ' + textLabel(text)
placemenu.entryconfig(len(signatures) + 2, label=label)
update()
def textLabel(text): return f'"{text}"' if len(text) <= 20 else f'Custom text: "{text[:17]}"...'
def cmd_abort():
root.destroy()
def cmd_sign():
@ -176,11 +349,27 @@ def main(args):
if root.signatureControlVar.get() != signatureIndex():
signatureIndex(root.signatureControlVar.get())
update()
for index, filename in enumerate(signatures):
placemenu.add_radiobutton(value=index, label=f'{index+1}: {filename}', underline=0 if index<9 else None, variable=root.signatureControlVar, accelerator=(str(index+1) if index<9 else None), command=updateFromSignatureRadio)
for index, (_, signatureText, _) in enumerate(signatures):
placemenu.add_radiobutton(
value=index,
label=f'{index+1}: {signatureText}',
underline=0 if index<9 else None,
variable=root.signatureControlVar,
accelerator=(str(index+1) if index<9 else None),
command=updateFromSignatureRadio)
signatures.append(('cell', None, customText))
placemenu.add_radiobutton(
value=customTextIndex,
label='Custom text: ' + textLabel(customText()[2]),
underline=7,
variable=root.signatureControlVar,
accelerator='T',
command=cmd_customText)
placemenu.add_separator()
placemenu.add_command(label='Enlarge signature', underline=0, accelerator='+', command=cmd_enlargeSignature)
root.bind_all('<KP_Add>', lambda e: cmd_enlargeSignature())
placemenu.add_command(label='Shrink signature', underline=0, accelerator='-', command=cmd_shrinkSignature)
root.bind_all('<KP_Subtract>', lambda e: cmd_shrinkSignature())
placemenu.add_separator()
placemenu.add_command(label='Move signature left', underline=15, accelerator='Click / Left', command=cmd_moveSignatureLeft)
placemenu.add_command(label='Move signature down', underline=15, accelerator='Click / Down', command=cmd_moveSignatureDown)
@ -205,6 +394,8 @@ def main(args):
'q': cmd_abort,
'S': cmd_sign,
's': cmd_sign,
'T': cmd_customText,
't': cmd_customText,
'space': cmd_sign,
}
def onkey(event):
@ -218,38 +409,48 @@ def main(args):
root.bind(f'{char}', onkey)
for i, char in enumerate("123456789"): bindDigit(i, char)
# Canvas and click binding
root._docView=tk.Canvas(root, borderwidth=0, background='#ffffff', confine=True)
def onDocViewResize(event):
canvasMarginX=event.x
canvasMarginY=event.y
canvasWidth=event.width
canvasHeight=event.height
(oldMaxWidth, oldMaxHeight)=displayMaxSize()
if(0<canvasMarginX and 0<canvasMarginY):
apparentScale=max(canvasHeight/oldMaxHeight, canvasWidth/oldMaxWidth, 0.5)
newMaxWidth=(canvasWidth+2*canvasMarginX)/apparentScale-10
newMaxHeight=(canvasHeight+2*canvasMarginY)/apparentScale-10
else:
newMaxWidth=oldMaxWidth/2
newMaxHeight=oldMaxHeight/2
newMaxWidth=max(newMaxWidth, 10)
newMaxHeight=max(newMaxHeight, 10)
if abs(oldMaxWidth-newMaxWidth) < 5: newMaxWidth=oldMaxWidth
if abs(oldMaxHeight-newMaxHeight) < 5: newMaxHeight=oldMaxHeight
if oldMaxWidth != newMaxWidth or oldMaxHeight != newMaxHeight:
displayMaxSize((newMaxWidth, newMaxHeight))
root._docView=tk.Canvas(root, borderwidth=0, background='#ffffff')
docViewMargin=5
docViewMinDimension=50
def onRootResize(event):
rootWidth=root.winfo_width()
rootHeight=root.winfo_height()
newMaxDisplayDimensions=(max(rootWidth - 2 * docViewMargin, docViewMinDimension),
max(rootHeight - 2 * docViewMargin, docViewMinDimension))
if displayMaxSize() != newMaxDisplayDimensions:
displayMaxSize(newMaxDisplayDimensions)
update()
root._docView.pack(expand=1)
root._docView.place(x=docViewMargin, y=docViewMargin)
root._docViewIndex=root._docView.create_image(0, 0, anchor=tk.NW)
root._docView.bind('<Configure>', onDocViewResize)
root.geometry("800x600")
root.bind('<Configure>', onRootResize)
initWinSize=(root.winfo_screenwidth() * 0.8, root.winfo_screenheight() * 0.8)
initWinSize=(min(initWinSize[0], initWinSize[1] * pageSize()[0] / pageSize()[1]),
min(initWinSize[1], initWinSize[0] * pageSize()[1] / pageSize()[0]))
root.geometry(f"{int(initWinSize[0])}x{int(initWinSize[1])}")
@Cell
def updateTitle():
root.title(f'Signing page {pageNumber()}/{pageCount} of {filePath}')
# The update function triggers heavy PDF file operations, so we try
# to avoid calling it too much. In particular,
# 1) Depending on desktop environment and window manager, one or
# more resizes can happen soon after startup, triggering an
# update. We use the updateActive flag to avoid these, then
# instead update once 100 ms after startup.
# 2) An interactive resizing process using the pointer can produce a
# lot of resizing events. We use the @tkthrottle decorator to
# reduce them.
updateActive = False
def soonAfterStart():
nonlocal updateActive
updateActive = True
update()
root.after(100, soonAfterStart)
@tkthrottle(100, root)
def update():
if not updateActive:
return
(w, h) = displaySize()
root._docImg = tk.PhotoImage(file=str(displayPNG()))
root._docImg = tk.PhotoImage(file=displayPNG())
root._docView.itemconfig(root._docViewIndex, image=root._docImg)
root._docView.configure(width=w, height=h)
updateTitle()
@ -283,7 +484,15 @@ def main(args):
else:
assert args.existing=='overwrite'
pnr=pageNumber()
subprocess.run([
qpdfOrPdftk(args, [
'qpdf', '--pages',
*(['.', f'1-{pnr-1}'] if 1 < pnr else []),
signedPagePDF(), '1',
*(['.', f'{pnr+1}-z'] if pnr < pageCount else []),
'--',
inputPDF,
signedFilePath,
],[
'pdftk',
f'A={inputPDF}',
f'B={signedPagePDF()}',
@ -292,32 +501,80 @@ def main(args):
'B',
*([f'A{pnr+1}-end'] if pnr < pageCount else []),
'output', signedFilePath,
], check=True)
])
print(f'Signed document saved as {signedFilePath}')
else:
print(f'Aborted')
# Used for file names that don't change but represents changed content
class Volatile():
def __init__(self, underlying): self._underlying = underlying
def __eq__(self, other): return self is other
def __str__(self): return str(self._underlying)
def getSignatureDir():
if 'PDF_SIGNATURE_DIR' in os.environ:
sd=os.environ['PDF_SIGNATURE_DIR']
elif 'XDG_CONFIG_HOME' in os.environ:
sd=os.path.join(os.environ['XDG_CONFIG_HOME'], 'pdf_signatures')
elif os.path.exists(os.path.expanduser("~/.config/pdf_signatures")):
sd="~/.config/pdf_signatures"
def has(cmd):
return subprocess.run(["which", cmd], check=False, capture_output=True).returncode == 0
hasQpdf = has("qpdf")
def qpdfOrPdftk(args, qpdfCmd, pdftkCmd):
assert qpdfCmd[0] == "qpdf" and pdftkCmd[0] == "pdftk"
if hasQpdf:
if args.continue_on_warnings:
subprocess.run(['qpdf', '--warning-exit-0', *qpdfCmd[1:]], check=True)
else:
try:
subprocess.run(qpdfCmd, check=True)
except subprocess.CalledProcessError as e:
if e.returncode == 3:
# https://qpdf.readthedocs.io/en/stable/cli.html#exit-status
die("qpdf exited with code 3, indicating warnings. Run pdf-sign with flag --continue-on-warnings to ignore.")
raise
else:
sd="~/.pdf_signatures"
sd=os.path.expanduser(sd)
if not os.path.exists(sd):
raise Exception(f'Signature directory {sd} does not exist')
if not os.path.isdir(sd):
raise Exception(f'Signature directory {sd} is not a directory')
return sd
subprocess.run(pdftkCmd, check=True)
return True # Some lambdas above rely on this
def validateText(text, do_die):
latin1_chars=set([*range(0x20, 0x7f), *range(0xa0, 0x100)])
text_chars=set(map(ord, text))
msg = ""
if not text_chars.issubset(latin1_chars):
msg = ("Error: Only non-control latin-1 characters are supported" +
(" in --text" if do_die else "") +
". Unsupported characters: " + ', '.join(map(hex, text_chars - latin1_chars)))
elif not (1 <= len(text) and len(text) <= 100):
msg = "Text must be between 1 and 100 characters long."
if not msg:
return None
if do_die:
die(msg)
return msg
def getSignatureDirAndHelp():
def candidate(prevpath, prevhelptxt, nr, lbl, envvar, path):
helptxt = f"{nr}) {lbl}"
if prevhelptxt: helptxt = f"{prevhelptxt} {helptxt}"
if envvar and not envvar in os.environ:
helptxt += " which is not used since the environment variable is not set."
return (prevpath, helptxt)
path = os.path.expanduser(path)
if not os.path.exists(path):
helptxt += f" which is not used since {path} does not exist."
return (prevpath, helptxt)
if not os.path.isdir(path):
helptxt += f" which is not used since {path} is not a directory."
return (prevpath, helptxt)
if prevpath:
helptxt += f" which is valid, but not used since it's not the highest priority directory."
return (prevpath, helptxt)
helptxt += f" which resolves to {path} and IS USED as the signature directory."
return (path, helptxt)
(path, helptxt) = (None, None)
(path, helptxt) = candidate(path, helptxt,
1, '$PDF_SIGNATURE_DIR', 'PDF_SIGNATURE_DIR',
os.environ.get('PDF_SIGNATURE_DIR'))
(path, helptxt) = candidate(path, helptxt,
2, '$XDG_CONFIG_HOME/pdf_signatures', 'XDG_CONFIG_HOME',
os.path.join(os.environ.get('XDG_CONFIG_HOME') or '/', 'pdf_signatures'))
(path, helptxt) = candidate(path, helptxt,
3, '~/.config/pdf_signatures', None,
'~/.config/pdf_signatures')
(path, helptxt) = candidate(path, helptxt,
4, '~/.pdf_signatures', None,
'~/.pdf_signatures')
return (path, helptxt)
# Simple dependency tracking.
# Init with a value or function to calculate the value.
@ -347,7 +604,8 @@ class Cell():
for i in range(len(self._precedents)):
p=self._precedents[i]
oldval=self._precedentvalues[i]
newval=p()
p()
newval=p._cacheid()
if oldval!=newval:
self._needEval=True
break
@ -364,13 +622,89 @@ class Cell():
if(Cell.currentCell):
self._dependents.append(Cell.currentCell)
Cell.currentCell._precedents.append(self)
Cell.currentCell._precedentvalues.append(self._value)
Cell.currentCell._precedentvalues.append(self._cacheid())
return self._value
def _dirty(self):
if self._isuptodate:
self._isuptodate=False
for d in self._dependents:
d._dirty()
def _cacheid(self):
assert self._isuptodate
return self._value
# When the return value is just a file name, the contents of that file needs to
# be taken into account in order to decide whether the "value" has changed. In
# these cases, we track the precedent values along the cell's own value.
class VolatileCell(Cell):
def _cacheid(self):
assert self._isuptodate
return (self._value, self._precedentvalues)
# Keep this function in sync with pdf-from-text
def text_to_pdf(text, output, size, margin):
# Validate text
text_chars=set(map(ord, text))
latin1_chars=set([*range(0x20, 0x7f), *range(0xa0, 0x100)])
if not text_chars.issubset(latin1_chars):
die(f"Error: Only non-control latin-1 characters are supported. Unsupported characters: {', '.join(map(hex, text_chars - latin1_chars))}")
text.encode('latin-1').decode('latin-1') # Assertion. E.i., an exception here indicates a bug.
with tempfile.TemporaryDirectory() as tempdir:
# Write postscript file
ps_file=os.path.join(tempdir, "file.ps")
text_len=len(text)
w=text_len * size + margin * 2
h=size * 3 + margin * 2
x=size + margin
y=size + margin
ps_text = (text
.replace("\\", "\\\\")
.replace("(", "\\(")
.replace(")", "\\)")
)
def write_ps():
with open(ps_file, "w", encoding="latin-1") as f:
f.write('\n'.join([
"%!PS-Adobe-3.0",
f"%%BoundingBox: 0 0 {w} {h}",
"%%Pages: 1",
"%%EndComments",
"%%Page: 1 1",
f"/DejaVuSansMono findfont {size} scalefont setfont",
f"{x} {y} moveto",
f"({ps_text}) show",
"showpage"]))
# Write postscript file with too big bounding box
write_ps()
# Get correct bounding box
bbox_result = subprocess.run([
"gs", '-dBATCH', '-dNOPAUSE', '-dSAFER', '-dQUIET',
"-sDEVICE=bbox",
ps_file
], stderr=subprocess.PIPE, text=True, check=True)
bbox = m(r'.*%%HiResBoundingBox: (\d+(\.\d+)?) (\d+(\.\d+)?) (\d+(\.\d+)?) (\d+(\.\d+)?)\n.*', bbox_result.stderr)
if not bbox:
die("Error: Unable to extract bounding box.")
# Adjust variables for bounding box
llx, lly, urx, ury = float(bbox[1]), float(bbox[3]), float(bbox[5]), float(bbox[7])
llx, lly, urx, ury = llx - margin, lly - margin, urx + margin, ury + margin
w=urx - llx
h=ury - lly
x-=llx
y-=lly
# Write postscript file with correct bounding box
write_ps()
# Convert to PDF
gs_cmd = [
"gs", '-dBATCH', '-dNOPAUSE', '-dSAFER', '-dQUIET',
"-o", output,
"-sDEVICE=pdfwrite",
f"-dDEVICEWIDTHPOINTS={w}",
f"-dDEVICEHEIGHTPOINTS={h}",
"-dFIXEDMEDIA",
"-c", "[ /PAGES pdfmark",
"-f", ps_file
]
subprocess.run(gs_cmd, check=True, stdout=subprocess.DEVNULL)
def tkthrottle(frequency, root):
wait=1/frequency
@ -394,10 +728,10 @@ def tkthrottle(frequency, root):
return decorator
def pdfCountPages(filePath):
return int(fromCmdOutput(["pdfinfo", str(filePath)], "^.*\nPages: +([0-9]+)\n.*$")[1])
return int(fromCmdOutput(["pdfinfo", filePath], r"^.*\nPages: +([0-9]+)\n.*$")[1])
def pdfGetSize(filePath):
[ignored, w, h, *ignored2]=fromCmdOutput(['pdfinfo', filePath], '^.*\nPage size: +([0-9.]+) x ([0-9.]+) pts( \([A-Za-z0-9]+\))?\n.*$')
[ignored, w, h, *ignored2]=fromCmdOutput(['pdfinfo', filePath], r'^.*\nPage size: +([0-9.]+) x ([0-9.]+) pts( \([A-Za-z0-9]+\))?\n.*$')
return (float(w), float(h))
def m(pattern, string):
@ -419,10 +753,6 @@ def fromCmdOutput(cmd, pattern):
result=sp.stdout.decode('utf-8')
return m(pattern, result)
def die(reason):
print(reason, file=sys.stderr)
sys.exit(1)
# Monkey-patch argparse if necessary
if not 'BooleanOptionalAction' in dir(argparse):
class BooleanOptionalAction(argparse.Action):
@ -443,17 +773,34 @@ if not 'BooleanOptionalAction' in dir(argparse):
return ' | '.join(self.option_strings)
argparse.BooleanOptionalAction = BooleanOptionalAction
parser = argparse.ArgumentParser(description='Sign a PDF file.')
def getSignatureHelp():
(path, helptxt) = getSignatureDirAndHelp()
ret="""
Path to file used as signature.
Required in batch mode unless -t is given.
In GUI mode, the user can choose among PDF files in the signature directory.
"""
if path:
ret += f"The signature directory is {path}, chosen from these options: {helptxt}"
else:
ret += f"Right now, no signature directory could be found. The options are: {helptxt}"
return ret
parser = argparse.ArgumentParser(description='Sign a PDF file, with a non-cryptographic squiggle.')
parser.add_argument('input', metavar='input.pdf', type=str, help='Input PDF file.')
parser.add_argument('-p', '--page', type=int, default=-1, help='The page to sign, negative for counting from the end. (default: -1)')
parser.add_argument('-s', '--signature', type=str, help='Path to file used as signature. Required in batch mode. In GUI mode, the user can choose among files in $PDF_SIGNATURE_DIR, $XDG_CONFIG_HOME/pdf_signatures (defaulting to ~/.config/pdf_signatures), or ~/.pdf_signatures.')
parser.add_argument('-x', '--x-coordinate', type=float, default=0.5, help='Horizontal coordinate of signature center, in page width units. (default: 0.5)')
parser.add_argument('-y', '--y-coordinate', type=float, default=0.75, help='Vertical coordinate of signature center, in page height units. (default: 0.75)')
parser.add_argument('-W', '--width', type=float, default=0.28, help='Width of box to fit signature to, in page width units. (default: 0.28)')
parser.add_argument('-H', '--height', type=float, default=0.28, help='Height of box to fit signature to, in page height units. (default: 0.28)')
parser.add_argument('-s', '--signature', type=str, help=getSignatureHelp())
parser.add_argument('-x', '--x-coordinate', type=str, default="50%", help='Horizontal coordinate of signature center. Requires unit %% (meaning percent of page width). May be preceded by L+ (default), L-, R+ or R- to give coordinate relative left of right edge of the page. For example, 25%% means a quarter page width from left edge, R-3%% means 3%% of page width from right edge. (default: 50%%)')
parser.add_argument('-y', '--y-coordinate', type=str, default="B-25%", help='Vertical coordinate of signature center. Requires unit %% (meaning percent of page height). May be preceded by T+ (default), T-, B+ or B- to give coordinate relative top or bottom edge of the page. For example, 3%% means 3%% of page height from top edge, B-10%% means 10%% of page height from bottom edge. (default: B-25%%)')
parser.add_argument('-r', '--resize-factor', type=float, default=1.0, help='Resize signature by this factor. If this would make the signature larger than allowed by -W or -H, then instead use the maximum allowed size.')
parser.add_argument('-W', '--width', type=str, default="50%", help='Maximum width of signature. Supports units pts, in, cm, mm and %% (meaning percent of page width). (default: 50%%)')
parser.add_argument('-H', '--height', type=str, default="50%", help='Maximum height of signature. Supports units pts, in, cm, mm and %% (meaning percent of page height). (default: 50%%)')
parser.add_argument('-o', '--output', type=str, help='Output file. (default: Add ".signed" before the extension)')
parser.add_argument('-b', '--batch', action=argparse.BooleanOptionalAction, default=False, help='Batch mode: do not show GUI.')
parser.add_argument('-f', '--flatten', action=argparse.BooleanOptionalAction, default=True, help='Flatten before signing.')
parser.add_argument('-b', '--batch', action=argparse.BooleanOptionalAction, default=False, help='Batch mode: do not show GUI. (default: False)')
parser.add_argument('-f', '--flatten', action=argparse.BooleanOptionalAction, default=True, help='Flatten before signing, preventing subsequent changes in PDF forms. (default: True)')
parser.add_argument('-e', '--existing', type=str, choices=['backup', 'overwrite', 'fail'], default='backup', help='What to do if output file exists. (default: backup)')
parser.add_argument('-t', '--text', type=str, action='append', help='In GUI mode, a text option to be added to the list of signatures (can be repeated). In batch mode only one can be given, and will be used instead of --signature.')
parser.add_argument('--continue-on-warnings', action=argparse.BooleanOptionalAction, default=False, help='Do not fail on warnings from qpdf. (default: False)')
main(parser.parse_args(sys.argv[1:] or ['-h']))