sebastian/pdf-sign
1
0
Fork 0
Code Issues Pull-Requests Projekte Releases Pakete Wiki Aktivität Actions
pdf-sign/pdf-sign
Axel Svensson e8eab02591 Cmd-line options and help
2021-10-11 22:57:18 +02:00

350 Zeilen
17 KiB
Python
Ausführbare Datei
Originalformat Blame Verlauf

#!/usr/bin/env python3
#Dependencies: python3, pdftk, gs, mv, pdfinfo
import argparse, os, queue, re, subprocess, sys, tempfile, threading, time, tkinter as tk
signatureDir=os.path.expanduser(os.environ['PDF_SIGNATURE_DIR'] if 'PDF_SIGNATURE_DIR' in os.environ else "~/.pdf_signatures")
# Inspired by https://unix.stackexchange.com/a/141496
def main(args):
filePath=args.input
with tempfile.TemporaryDirectory() as tempdir:
intmp=lambda fileName: os.path.join(tempdir, fileName)
# Maybe flatten (make forms non-editable) before signing
@Cell
def inputPDF():
if args.flatten:
outFile=intmp('input.pdf')
subprocess.run([
'pdftk', filePath,
'output', outFile,
'flatten'
], check=True)
return outFile
return filePath
# The chosen page
pageCount=pdfCountPages(inputPDF())
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)
pagePDF=Cell(lambda: subprocess.run(['pdftk', inputPDF(), 'cat', str(pageNumber()), 'output', intmp('page.pdf')], check=True) and intmp('page.pdf'))
pageSize=Cell(lambda: pdfGetSize(pagePDF()))
# The chosen signature
if not args.signature and args.batch:
die('In batch mode, signature must be specified.')
signatures=[*filter(lambda x: m("^.*\.pdf$", x), os.listdir(signatureDir))] if not args.signature else [None]
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 signaturePositionedPDF():
(w, h)=pageSize()
(sw, sh)=signatureSize()
resize=1.1**signatureScale()*min(args.width*w/sw, args.height*h/sh)
dx=w*signaturePositionX()/resize - sw/2
dy=h*(1-signaturePositionY())/resize - sh/2
outFile=intmp('signature-positioned.pdf')
subprocess.run([
'gs', '-dBATCH', '-dNOPAUSE', '-dSAFER', '-dQUIET',
f'-sOutputFile={outFile}',
'-sDEVICE=pdfwrite',
f'-dDEVICEWIDTHPOINTS={w}', f'-dDEVICEHEIGHTPOINTS={h}', '-dFIXEDMEDIA',
'-c', f'<</BeginPage{{{resize} {resize} scale {dx} {dy} translate}}>> setpagedevice',
'-f', signaturePath(),
], check=True)
return outFile
# The signed page
signedPagePDF=Cell(lambda: subprocess.run([
'pdftk',
pagePDF(),
'stamp', signaturePositionedPDF(),
'output', intmp('signed-page.pdf'),
], check=True) and intmp('signed-page.pdf'))
# The signed page as PNG, for GUI use
displayMaxSize=Cell((400, 800))
@Cell
def displaySize():
(maxWidth, maxHeight)=displayMaxSize()
(pageWidth, pageHeight)=pageSize()
scale=min(maxWidth/pageWidth, maxHeight/pageWidth)
return (int(pageWidth*scale), int(pageHeight*scale))
@Cell
def displayPNG():
(w, h)=displaySize()
outFile=intmp('display.png')
subprocess.run([
'gs', '-dBATCH', '-dNOPAUSE', '-dSAFER', '-dQUIET',
f'-sOutputFile={outFile}',
'-sDEVICE=pngalpha',
'-dMaxBitmap=2147483647',
f'-dDEVICEWIDTHPOINTS={w}', f'-dDEVICEHEIGHTPOINTS={h}', '-dFIXEDMEDIA', '-dPDFFitPage',
'-f', signedPagePDF(),
], check=True)
return outFile
# GUI
doSign=True
gui=not args.batch
if gui:
doSign=False
# Commands
def uf(fun):
def ret():
fun()
update()
return ret
@uf
def cmd_prevPage():
if 1<pageNumber():
pageNumber(pageNumber()-1)
@uf
def cmd_nextPage():
if pageNumber()<pageCount:
pageNumber(pageNumber()+1)
cmd_firstPage = uf(lambda: pageNumber(1))
cmd_lastPage = uf(lambda: pageNumber(pageCount))
cmd_nextSignature = uf(lambda: signatureIndex((signatureIndex()+1)%len(signatures)))
cmd_prevSignature = uf(lambda: signatureIndex((signatureIndex()-1)%len(signatures)))
cmd_moveSignatureUp = uf(lambda: signaturePositionY(signaturePositionY()-0.02))
cmd_moveSignatureDown = uf(lambda: signaturePositionY(signaturePositionY()+0.02))
cmd_moveSignatureLeft = uf(lambda: signaturePositionX(signaturePositionX()-0.02))
cmd_moveSignatureRight = uf(lambda: signaturePositionX(signaturePositionX()+0.02))
cmd_enlargeSignature = uf(lambda: signatureScale(signatureScale()+1))
cmd_shrinkSignature = uf(lambda: signatureScale(signatureScale()-1))
def cmd_positionSignature(x, y):
signaturePositionX(x)
signaturePositionY(y)
update()
def cmd_abort():
root.destroy()
def cmd_sign():
nonlocal doSign
doSign=True
root.destroy()
# Window and menu
root = tk.Tk()
rootmenu = tk.Menu(root)
root.config(menu=rootmenu)
filemenu = tk.Menu(rootmenu, tearoff=0)
rootmenu.add_cascade(label="File", underline=0, menu=filemenu)
filemenu.add_command(label='Sign & Exit', underline=0, accelerator='space / S', command=cmd_sign)
filemenu.add_command(label='Abort & Exit', underline=0, accelerator='Esc / Q', command=cmd_abort)
pagemenu = tk.Menu(rootmenu, tearoff=0)
rootmenu.add_cascade(label="Page", underline=0, menu=pagemenu)
pagemenu.add_command(label='First page', underline=0, accelerator='Home', command=cmd_firstPage)
pagemenu.add_command(label='Previous page', underline=0, accelerator='PgUp', command=cmd_prevPage)
pagemenu.add_command(label='Next page', underline=0, accelerator='PgDown', command=cmd_nextPage)
pagemenu.add_command(label='Last page', underline=0, accelerator='End', command=cmd_lastPage)
placemenu = tk.Menu(rootmenu, tearoff=0)
rootmenu.add_cascade(label="Signature", underline=1, menu=placemenu)
if not args.signature:
placemenu.add_command(label='Previous signature', underline=0, accelerator='Ctrl-Left', command=cmd_prevSignature)
placemenu.add_command(label='Next signature', underline=0, accelerator='Ctrl-Right', command=cmd_nextSignature)
placemenu.add_separator()
placemenu.add_command(label='Enlarge signature', underline=0, accelerator='+', command=cmd_enlargeSignature)
placemenu.add_command(label='Shrink signature', underline=0, accelerator='-', command=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)
placemenu.add_command(label='Move signature up', underline=15, accelerator='Click / Up', command=cmd_moveSignatureUp)
placemenu.add_command(label='Move signature right', underline=15, accelerator='Click / Right', command=cmd_moveSignatureRight)
# Key bindings
keyToFunction={
'Prior': cmd_prevPage,
'Next': cmd_nextPage,
'Home': cmd_firstPage,
'End': cmd_lastPage,
'C-Left': cmd_prevSignature,
'C-Right': cmd_nextSignature,
'Left': cmd_moveSignatureLeft,
'Down': cmd_moveSignatureDown,
'Up': cmd_moveSignatureUp,
'Right': cmd_moveSignatureRight,
'plus': cmd_enlargeSignature,
'minus': cmd_shrinkSignature,
'Escape': cmd_abort,
'Q': cmd_abort,
'q': cmd_abort,
'S': cmd_sign,
's': cmd_sign,
'space': cmd_sign,
}
def onkey(event):
key=('C-' if event.state in [4, 5] else '')+event.keysym
if key in keyToFunction:
keyToFunction[key]()
for key in keyToFunction.keys():
root.bind(f'<{key.split("-")[-1]}>', onkey)
# 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=int((canvasWidth+2*canvasMarginX)/apparentScale-10)
newMaxHeight=int((canvasHeight+2*canvasMarginY)/apparentScale-10)
if(5<abs(oldMaxWidth-newMaxWidth) or 5<abs(oldMaxHeight-newMaxHeight)):
displayMaxSize((newMaxWidth, newMaxHeight))
update()
else:
newMaxWidth=max(int(oldMaxWidth/2), 10)
newMaxHeight=max(int(oldMaxHeight/2), 10)
displayMaxSize((newMaxWidth, newMaxHeight))
update()
root._docView.bind('<Configure>', onDocViewResize)
root._docView.pack(expand=1)
root._docViewIndex=root._docView.create_image(0, 0, anchor=tk.NW)
@Cell
def updateTitle():
root.title(f'Signing page {pageNumber()}/{pageCount} of {filePath}')
def update():
(w, h) = displaySize()
root._docImg = tk.PhotoImage(file=displayPNG())
root._docView.itemconfig(root._docViewIndex, image=root._docImg)
root._docView.configure(width=w, height=h)
updateTitle()
def onclick(event):
x=event.x
y=event.y
canvasConfig=root._docView.config()
canvasWidth=int(canvasConfig['width'][4])
canvasHeight=int(canvasConfig['height'][4])
cmd_positionSignature(x/canvasWidth, y/canvasHeight)
root._docView.bind('<Button-1>', onclick)
# Run GUI
root.mainloop()
# End of GUI
if doSign:
[ignored, pathPart1, pathPart2] = m("^(.*)(\.[Pp][Dd][Ff])$", filePath)
signedFilePath=args.output if args.output else f'{pathPart1}.signed{pathPart2}'
if os.path.exists(signedFilePath):
if args.existing=='backup':
backupFilePath=f'{signedFilePath}.backup{time.strftime("%Y%m%d_%H%M%S")}'
subprocess.run([
'mv',
signedFilePath,
backupFilePath,
], check=True)
print(f'Renamed {signedFilePath} to {backupFilePath}')
elif args.existing=='fail':
die(f'Output file {signedFilePath} already exists')
else:
assert args.existing=='overwrite'
pnr=pageNumber()
subprocess.run([
'pdftk',
f'A={inputPDF()}',
f'B={signedPagePDF()}',
'cat',
*([f'A1-{pnr-1}'] if 1 < pnr else []),
'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')
# Simple dependency tracking.
# Init with a value or function to calculate the value.
# Update by calling with one argument (as in init).
# To retrieve an up-to-date value, call with no arguments.
class Cell():
currentCell=None
def __init__(self, arg):
self._arg=arg
self._isuptodate=False
self._dependents=[]
def __call__(self, *args):
if(len(args)==1):
self._arg=args[0]
self.dirty()
return
assert len(args)==0
if(Cell.currentCell):
self._dependents.append(Cell.currentCell)
if not self._isuptodate:
oldcell=Cell.currentCell
Cell.currentCell=self
self._value=self._arg() if callable(self._arg) else self._arg
self._isuptodate=True
Cell.currentCell=oldcell
return self._value
def dirty(self):
if self._isuptodate:
self._isuptodate=False
for d in self._dependents:
d.dirty()
self._dependents=[]
def pdfCountPages(filePath):
return int(fromCmdOutput(["pdfinfo", filePath], "^.*\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.*$')
return (float(w), float(h))
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 fromCmdOutput(cmd, pattern):
sp=subprocess.run(cmd, check=True, capture_output=True)
result=sp.stdout.decode('utf-8')
return m(pattern, result)
# Inspired by http://eyalarubas.com/python-subproc-nonblock.html
class NonBlockingIterable:
def __init__(self, iterable, timeout = 0.3):
self._i = iterable
self._q = queue.Queue()
self._timeout = timeout
self._done = False
def _populateQueue(iterable, queue):
for item in iterable:
queue.put(item)
self._done = True
self._t = threading.Thread(
target = _populateQueue,
args = (self._i, self._q))
self._t.daemon = True
self._t.start()
def __iter__(self):
while not self._done:
try:
yield self._q.get(block = True, timeout = self._timeout)
except queue.Empty:
yield None
def die(reason):
print(reason, file=sys.stderr)
sys.exit(2)
parser = argparse.ArgumentParser(description='Sign a PDF file.')
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 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('-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('-e', '--existing', type=str, choices=['backup', 'overwrite', 'fail'], default='backup', help='What to do if output file exists. (default: backup)')
main(parser.parse_args(sys.argv[1:] or ['-h']))
In neuem Issue referenzieren „git blame“ ansehen Permalink kopieren