add dependency fdfgen.py
Before the user somehow had to aquire fdfgen. Either via pip but pip is not installed or installable everywhere. Or via download and putting this fdfgen.py file here. But this can stop user from using it. Now we have the problem that we cannot get updates for fdfgen but it works the way it is now and maybe an update might break things.
This commit is contained in:
Bela
parent
84f437b1b7
commit
6c287f69eb
1 changed files with 187 additions and 0 deletions
187
fdfgen.py
Normal file
187
fdfgen.py
Normal file
|
|
@ -0,0 +1,187 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
"""
|
||||
Port of the PHP forge_fdf library by Sid Steward
|
||||
(http://www.pdfhacks.com/forge_fdf/)
|
||||
|
||||
Anders Pearson <anders@columbia.edu> at Columbia Center For New Media Teaching
|
||||
and Learning <http://ccnmtl.columbia.edu/>
|
||||
"""
|
||||
|
||||
__author__ = "Anders Pearson <anders@columbia.edu>"
|
||||
__credits__ = ("Sébastien Fievet <zyegfryed@gmail.com>",
|
||||
"Brandon Rhodes <brandon@rhodesmill.org>",
|
||||
"Robert Stewart <https://github.com/rwjs>",
|
||||
"Evan Fredericksen <https://github.com/evfredericksen>")
|
||||
|
||||
import codecs
|
||||
import sys
|
||||
|
||||
if sys.version_info[0] < 3:
|
||||
bytes = str
|
||||
|
||||
|
||||
def smart_encode_str(s):
|
||||
"""Create a UTF-16 encoded PDF string literal for `s`."""
|
||||
try:
|
||||
utf16 = s.encode('utf_16_be')
|
||||
except AttributeError: # ints and floats
|
||||
utf16 = str(s).encode('utf_16_be')
|
||||
safe = utf16.replace(b'\x00)', b'\x00\\)').replace(b'\x00(', b'\x00\\(')
|
||||
return b''.join((codecs.BOM_UTF16_BE, safe))
|
||||
|
||||
|
||||
def handle_hidden(key, fields_hidden):
|
||||
if key in fields_hidden:
|
||||
return b"/SetF 2"
|
||||
else:
|
||||
return b"/ClrF 2"
|
||||
|
||||
|
||||
def handle_readonly(key, fields_readonly):
|
||||
if key in fields_readonly:
|
||||
return b"/SetFf 1"
|
||||
else:
|
||||
return b"/ClrFf 1"
|
||||
|
||||
|
||||
class FDFIdentifier(object):
|
||||
"""A PDF value, such as /Yes or /Off that should be passed through with the / and without parenthesis (which would indicate it was a value, not an identifier)
|
||||
This allows for different checkbox checked/unchecked names per checkbox!
|
||||
"""
|
||||
def __init__(self, value):
|
||||
# make sure value is str right away, to avoid TypeError in startswith
|
||||
if isinstance(value, bytes):
|
||||
value = value.decode('utf-8')
|
||||
|
||||
if value.startswith('/'):
|
||||
value = value[1:]
|
||||
|
||||
value = u'/%s' % value
|
||||
value = value.encode('utf-8')
|
||||
|
||||
self._value = value
|
||||
|
||||
@property
|
||||
def value(self):
|
||||
return self._value
|
||||
|
||||
|
||||
def handle_data_strings(fdf_data_strings, fields_hidden, fields_readonly,
|
||||
checkbox_checked_name):
|
||||
if isinstance(fdf_data_strings, dict):
|
||||
fdf_data_strings = fdf_data_strings.items()
|
||||
|
||||
for (key, value) in fdf_data_strings:
|
||||
if value is True:
|
||||
value = FDFIdentifier(checkbox_checked_name).value
|
||||
elif value is False:
|
||||
value = FDFIdentifier('Off').value
|
||||
elif isinstance(value, FDFIdentifier):
|
||||
value = value.value
|
||||
else:
|
||||
value = b''.join([b'(', smart_encode_str(value), b')'])
|
||||
|
||||
yield b''.join([
|
||||
b'<<',
|
||||
b'/T(',
|
||||
smart_encode_str(key),
|
||||
b')',
|
||||
b'/V',
|
||||
value,
|
||||
handle_hidden(key, fields_hidden),
|
||||
b'',
|
||||
handle_readonly(key, fields_readonly),
|
||||
b'>>',
|
||||
])
|
||||
|
||||
|
||||
def handle_data_names(fdf_data_names, fields_hidden, fields_readonly):
|
||||
if isinstance(fdf_data_names, dict):
|
||||
fdf_data_names = fdf_data_names.items()
|
||||
|
||||
for (key, value) in fdf_data_names:
|
||||
yield b''.join([b'<<\x0a/V /', smart_encode_str(value), b'\x0a/T (',
|
||||
smart_encode_str(key), b')\x0a',
|
||||
handle_hidden(key, fields_hidden), b'\x0a',
|
||||
handle_readonly(key, fields_readonly), b'\x0a>>\x0a'])
|
||||
|
||||
|
||||
def forge_fdf(pdf_form_url=None, fdf_data_strings=[], fdf_data_names=[],
|
||||
fields_hidden=[], fields_readonly=[],
|
||||
checkbox_checked_name=b"Yes"):
|
||||
"""Generates fdf string from fields specified
|
||||
|
||||
* pdf_form_url (default: None): just the url for the form.
|
||||
* fdf_data_strings (default: []): array of (string, value) tuples for the
|
||||
form fields (or dicts). Value is passed as a UTF-16 encoded string,
|
||||
unless True/False, in which case it is assumed to be a checkbox
|
||||
(and passes names, '/Yes' (by default) or '/Off').
|
||||
* fdf_data_names (default: []): array of (string, value) tuples for the
|
||||
form fields (or dicts). Value is passed to FDF as a name, '/value'
|
||||
* fields_hidden (default: []): list of field names that should be set
|
||||
hidden.
|
||||
* fields_readonly (default: []): list of field names that should be set
|
||||
readonly.
|
||||
* checkbox_checked_value (default: "Yes"): By default means a checked
|
||||
checkboxes gets passed the value "/Yes". You may find that the default
|
||||
does not work with your PDF, in which case you might want to try "On".
|
||||
|
||||
The result is a string suitable for writing to a .fdf file.
|
||||
|
||||
"""
|
||||
fdf = [b'%FDF-1.2\x0a%\xe2\xe3\xcf\xd3\x0d\x0a']
|
||||
fdf.append(b'1 0 obj\x0a<</FDF')
|
||||
fdf.append(b'<</Fields[')
|
||||
fdf.append(b''.join(handle_data_strings(fdf_data_strings,
|
||||
fields_hidden, fields_readonly,
|
||||
checkbox_checked_name)))
|
||||
fdf.append(b''.join(handle_data_names(fdf_data_names,
|
||||
fields_hidden, fields_readonly)))
|
||||
if pdf_form_url:
|
||||
fdf.append(b''.join(b'/F (', smart_encode_str(pdf_form_url), b')\x0a'))
|
||||
fdf.append(b']\x0a')
|
||||
fdf.append(b'>>\x0a')
|
||||
fdf.append(b'>>\x0aendobj\x0a')
|
||||
fdf.append(b'trailer\x0a\x0a<<\x0a/Root 1 0 R\x0a>>\x0a')
|
||||
fdf.append(b'%%EOF\x0a\x0a')
|
||||
return b''.join(fdf)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
# a simple example of using fdfgen
|
||||
# this will create an FDF file suitable to fill in
|
||||
# the vacation request forms we use at work.
|
||||
|
||||
from datetime import datetime
|
||||
fields = [('Name', 'Anders Pearson'),
|
||||
('Date', datetime.now().strftime("%x")),
|
||||
('Request_1', 'Next Monday through Friday'),
|
||||
('Request_2', ''),
|
||||
('Request_3', ''),
|
||||
('Total_days', 5),
|
||||
('emergency_phone', '857-6309')]
|
||||
fdf = forge_fdf(fdf_data_strings=fields)
|
||||
fdf_file = open("vacation.fdf", "wb")
|
||||
fdf_file.write(fdf)
|
||||
fdf_file.close()
|
||||
|
||||
# Parse command-line arguments
|
||||
import argparse
|
||||
parser = argparse.ArgumentParser()
|
||||
parser.add_argument(
|
||||
"--output", "-o",
|
||||
help="FDF File to output to",
|
||||
default='vacation.fdf',
|
||||
type=argparse.FileType('wb'))
|
||||
parser.add_argument(
|
||||
"--fields", "-f",
|
||||
help="Fields used in form; syntax is fieldname=fieldvalue",
|
||||
default=fields,
|
||||
nargs='*')
|
||||
args = parser.parse_args()
|
||||
if args.fields is not fields:
|
||||
for e, x in enumerate(args. fields):
|
||||
args.fields[e] = x.split('=')
|
||||
fdf = forge_fdf(fdf_data_strings=args.fields)
|
||||
args.output.write(fdf)
|
||||
args.output.close()
|
||||
Loading…
Reference in a new issue