1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
##############################################################################
#
# Copyright (c) 2005 Nexedi SARL and Contributors. All Rights Reserved.
# Jerome PERRIN <jerome@nexedi.com>
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#
##############################################################################
from OFS.Image import File
from Products.PageTemplates.PageTemplateFile import PageTemplateFile
from Products.ERP5Type import PropertySheet, Permissions
from Products.PageTemplates.Expressions import getEngine
from Products.PageTemplates.TALES import SafeMapping
from urllib import quote
from Globals import InitializeClass, PersistentMapping, DTMLFile
from AccessControl import ClassSecurityInfo
from AccessControl.SecurityInfo import allow_class
from zLOG import LOG, PROBLEM
import types, popen2, os
from tempfile import mktemp
try:
from webdav.Lockable import ResourceLockedError
SUPPORTS_WEBDAV_LOCKS = 1
except ImportError:
SUPPORTS_WEBDAV_LOCKS = 0
# FIXME: Programs linked against mandriva libgcj v 3.4.0 ave a strange
# issue that make them impossible to popen within zope.
# That's why we do not use the 'real' pdftk but a replacement program,
# pdftk-emulation available from nexedi's RPM repositories.
PDFTK_EXECUTABLE = "pdftk-emulation"
# With python >= 2.4 and zope >= 2.7.8, pdftk-emulation is no longer needed
import sys, App.version_txt
python_version = sys.version.split(' ')[0].split('.')
python_version = int(python_version[0]) * 100 +\
int(python_version[1])
zope_version = App.version_txt.getZopeVersion()
zope_version = int(zope_version[0]) * 100 * 100 +\
int(zope_version[1]) * 100 +\
int(zope_version[2])
if python_version >= 204 and zope_version >= 20708:
PDFTK_EXECUTABLE = "pdftk"
class PDFTk :
"""
A class to wrapp calls to pdftk executable, found at
http://www.accesspdf.com/pdftk/
"""
def catPages(self, pdfFile, cat_option) :
""" limit to a specific range of pages, like pdftk's cat option"""
return self._getOutput(
PDFTK_EXECUTABLE+
" - cat %s output - "%cat_option, pdfFile)
def dumpDataFields(self, pdfFile) :
""" returns the output of pdftk dump_data_fields as dict """
return self._parseDumpDataFields(self.dumpDataFieldsTxt(pdfFile))
def fillFormWithDict(self, pdfFile, values) :
""" fill the form with values in """
return self.fillFormWithFDF(pdfFile, self._createFdf(values))
def fillFormWithFDF(self, pdfFile, fdfFile) :
""" fill the form of pdfFile with the FDF data fdfFile """
pdfFormFileName = mktemp(suffix=".pdf")
fdfFormFileName = mktemp(suffix=".fdf")
if hasattr(pdfFile, "read") :
pdfFile = pdfFile.read()
tmpPdfFile = open(pdfFormFileName, "w")
tmpPdfFile.write(pdfFile)
tmpPdfFile.close()
if hasattr(fdfFile, "read") :
fdfFile = fdfFile.read()
tmpFdfFile = open(fdfFormFileName, "w")
tmpFdfFile.write(fdfFile)
tmpFdfFile.close()
out = self._getOutput(
PDFTK_EXECUTABLE+
" %s fill_form %s output - flatten "%(
pdfFormFileName, fdfFormFileName))
os.remove(fdfFormFileName)
os.remove(pdfFormFileName)
return out
def dumpDataFieldsTxt(self, pdfFile) :
""" returns the output of pdftk dump_data_fields as text,
pdf file is either the file object or its content"""
return self._getOutput(
PDFTK_EXECUTABLE+" - dump_data_fields", pdfFile,
assert_not_empty=0)
def _parseDumpDataFields(self, data_fields_dump) :
""" parses the output of pdftk X.pdf dump_data_fields and
returns a sequence of dicts [{key = value}] """
fields = []
for txtfield in data_fields_dump.split("---") :
field = {}
for line in txtfield.splitlines() :
if line.strip() == "" :
continue
splits = line.split(":", 1)
if len(splits) == 2 :
field[splits[0]] = splits[1].strip()
if field != {} :
fields += [field]
return fields
def _getOutput(self, command, input=None, assert_not_empty=1) :
""" returns the output of command with sending input through command's
input stream (if input parameter is given) """
stdout, stdin = popen2.popen2(command)
if input:
if hasattr(input, "read") :
input = input.read()
try :
stdin.write(input)
except IOError, e:
raise IOError, str(e) + " ( make sure "\
"%s exists and is in your $PATH )"%PDFTK_EXECUTABLE
stdin.close()
ret = stdout.read()
stdout.close()
if assert_not_empty and len(ret) == 0 :
raise IOError, "Got no output from external program, make sure"\
" %s exists and is in your $PATH"%PDFTK_EXECUTABLE
return ret
def _escapeString(self, value) :
if value is None :
return ""
string = str(value)
escaped = ''
for c in string :
if (ord(c) == 0x28 or # open paren
ord(c) == 0x29 or # close paren
ord(c) == 0x5c): # backslash
escaped += '\\' + c
elif ord(c) < 32 or 126 < ord(c):
escaped += "\\%03o" % ord(c)
else:
escaped += c
return escaped
def _createFdf(self, values, pdfFormUrl=None) :
""" create an fdf document with the dict values """
fdf = "%FDF-1.2\x0d%\xe2\xe3\xcf\xd3\x0d\x0a"
fdf += "1 0 obj\x0d<< \x0d/FDF << /Fields [ "
for key, value in values.items():
fdf += "<< /T (%s) /V (%s) /ClrF 2 /ClrFf 1 >> \x0d" % (
self._escapeString(key),
self._escapeString(value))
fdf += "] \x0d"
# the PDF form filename or URL, if any
if pdfFormUrl not in ("", None) :
fdf += "/F ("+self._escapeString(pdfFormUrl)+") \x0d"
fdf += ">> \x0d>> \x0dendobj\x0d";
fdf += "trailer\x0d<<\x0d/Root 1 0 R \x0d\x0d>>\x0d%%EOF\x0d\x0a"
return fdf
# Constructors
manage_addPDFForm = DTMLFile("dtml/PDFForm_add", globals())
def addPDFForm(self, id, title="", pdf_file=None, REQUEST=None):
""" Add a pdf form to folder. """
# add actual object
id = self._setObject(id, PDFForm(id, title, pdf_file))
# upload content
if pdf_file:
self._getOb(id).manage_upload(pdf_file)
self._getOb(id).content_type="application/pdf"
if REQUEST :
u = REQUEST['URL1']
if REQUEST['submit'] == " Add and Edit ":
u = "%s/%s" % (u, quote(id))
REQUEST.RESPONSE.redirect(u+'/manage_main')
class CalculatedValues :
"""
This class holds a reference to calculated values, for use in TALES,
because in PDF Form filling, there is lots of references to others cell
values (sums ...). This class will be in TALES context under the key 'cell'
It will make possible the use of TALES expressions like :
cell/a95
python: cell['a1'] + cell['a2']
"""
security = ClassSecurityInfo()
def __init__(self, values, key, not_founds) :
""" 'values' are a dict of already calculated values
'key' is the key we are evaluating
'not_founds' is the list in which we will put not found values """
self.__values = values
self.__key = key
self.__not_founds = not_founds
def __getitem__(self, attr) :
if not self.__values.has_key(attr) :
self.__not_founds.append(attr)
return 0 # We do not return None, so that cell['a1'] + cell['a2']
# doesn't complain that NoneType doesn't support + when a1 not found
return self.__values[attr]
__getattr__ = __getitem__
allow_class(CalculatedValues)
class PDFForm(File):
"""
This class allows to fill PDF Form with TALES expressions,
using a TALES expression for each cell.
"""
meta_type = "ERP5 PDF Form"
icon = "www/PDFForm.png"
# Declarative Security
security = ClassSecurityInfo()
# Declarative properties
property_sheets = ( PropertySheet.Base
, PropertySheet.SimpleItem
)
# Constructors
constructors = (manage_addPDFForm, addPDFForm)
manage_options = ( (
{'label':'Edit Cell TALES', 'action':'manage_cells'},
{'label':'Display Cell Names', 'action':'showCellNames'},
{'label':'Test PDF generation', 'action':'generatePDF'},
{'label':'View original', 'action':'viewOriginal'},
) +
filter(lambda option:option['label'] != "View", File.manage_options)
)
pdftk = PDFTk()
def __init__ (self, id, title, pdf_file) :
# holds all the cell informations, even those not related to this form
self.all_cells = PersistentMapping()
# holds the cells related to this pdf form
self.cells = PersistentMapping()
# the page range we want to print
self.__page_range__ = ""
# the method to format values
self.__format_method__ = ""
if not pdf_file :
raise ValueError ("The pdf form file should not be empty")
# File constructor will call manage_upload, so we don't need to call it
File.__init__(self, id, title, pdf_file)
security.declareProtected(Permissions.ManagePortal, 'manage_upload')
def manage_upload(self, file=None, REQUEST=None) :
""" Zope calls this when the content of the enclosed file changes.
The 'cells' attribute is updated, but already defined cells are not
erased, they are saved in the 'all_cells' attribute so if the pdf
file is reverted, you do not loose the cells definitions.
"""
if not file or not hasattr(file, "read") :
raise ValueError ("The pdf form file should not be empty")
file.seek(0) # file is always valid here
values = self.pdftk.dumpDataFields(file)
self.cells = {}
for v in values :
if v["FieldType"] != "Button" :
k = v["FieldName"]
if not self.all_cells.has_key(k) :
self.cells[k] = ""
else :
self.cells[k] = self.all_cells[k]
self.all_cells.update(self.cells)
file.seek(0)
File.manage_upload(self, file, REQUEST)
if REQUEST:
message = "Saved changes."
return self.manage_main(self, REQUEST, manage_tabs_message=message)
security.declareProtected(Permissions.ViewManagementScreens, 'manage_cells')
manage_cells = PageTemplateFile('www/PDFForm_manageCells',
globals(), __name__='manage_cells')
security.declareProtected(Permissions.View, 'manage_FTPget')
def manage_FTPget(self, REQUEST=None, RESPONSE=None) :
""" get this pdf form via webDAV/FTP, it returns an XML
representation of all the fields, then the pdf itself."""
from xml.dom.minidom import getDOMImplementation
impl = getDOMImplementation()
newdoc = impl.createDocument(None, "pdfform", None)
top_element = newdoc.documentElement
cells = newdoc.createElement('cells')
pdfform_cell_list = self.cells.keys()
pdfform_cell_list.sort()
for cell in pdfform_cell_list :
cell_node = newdoc.createElement('cell')
cell_node.setAttribute('name', cell)
tales = newdoc.createTextNode(self.cells[cell])
cell_node.appendChild(tales)
cells.appendChild(cell_node)
top_element.appendChild(cells)
pdf_data = newdoc.createElement('pdf_data')
pdf_content = newdoc.createTextNode(str(self.data))
pdf_data.appendChild(pdf_content)
top_element.appendChild(pdf_data)
content = newdoc.toprettyxml(' ')
if RESPONSE :
RESPONSE.setHeader('Content-Type', 'application/x-erp5-pdfform')
RESPONSE.setHeader('Content-Length', len(content))
RESPONSE.write(content)
return content
manage_DAVget = manage_FTPget
security.declareProtected(Permissions.ManagePortal, 'PUT')
def PUT(self, REQUEST, RESPONSE):
"""(does not) Handle HTTP PUT requests."""
RESPONSE.setStatus(501)
return RESPONSE
manage_FTPput = PUT
security.declareProtected(Permissions.View, 'viewOriginal')
def viewOriginal(self, REQUEST=None, RESPONSE=None, *args, **kwargs) :
""" publish original pdf """
pdf = File.index_html(self, REQUEST, RESPONSE, *args, **kwargs)
RESPONSE.setHeader('Content-Type', 'application/pdf')
RESPONSE.setHeader('Content-Disposition', 'inline;filename="%s.pdf"'
% (self.title_or_id()))
return pdf
security.declareProtected(Permissions.View, 'showCellNames')
def showCellNames(self, REQUEST=None, RESPONSE=None, *args, **kwargs) :
""" generates a pdf with fields filled-in by their names,
usefull to fill in settings.
"""
values = {}
for cell in self.cells.keys() :
values[cell] = cell
pdf = self.pdftk.fillFormWithDict(str(self.data), values)
if RESPONSE :
RESPONSE.setHeader('Content-Type', 'application/pdf')
RESPONSE.setHeader('Content-Length', len(pdf))
RESPONSE.setHeader('Content-Disposition',
'inline;filename="%s.template.pdf"' % (
self.title_or_id()))
return pdf
security.declareProtected(Permissions.ManagePortal, 'doEditCells')
def doEditCells(self, REQUEST):
""" This is the action to the 'Edit Cell TALES' tab. """
if SUPPORTS_WEBDAV_LOCKS and self.wl_isLocked():
raise ResourceLockedError, "File is locked via WebDAV"
for k, v in self.cells.items() :
self.setCellTALES(k, REQUEST.get(str(k), v))
self.__format_method__ = REQUEST.get("__format_method__")
self.__page_range__ = REQUEST.get("__page_range__")
message = "Saved changes."
if getattr(self, '_v_warnings', None):
message = ("<strong>Warning:</strong> <i>%s</i>"
% '<br>'.join(self._v_warnings))
return self.manage_cells(manage_tabs_message=message)
security.declareProtected(Permissions.View, 'generatePDF')
def generatePDF(self, REQUEST=None, RESPONSE=None, *args, **kwargs) :
""" generates the PDF with form filled in """
values = self.calculateCellValues(REQUEST, *args, **kwargs)
context = { 'here' : self.aq_parent,
'context' : self.aq_parent,
'request' : REQUEST }
if hasattr(self, "__format_method__") \
and self.__format_method__ not in ('', None) :
compiled_tales = getEngine().compile(self.__format_method__)
format_method = getEngine().getContext(context).evaluate(compiled_tales)
# try to support both method name and method object
if not callable(format_method) :
format_method = self.restrictedTraverse(format_method)
if callable(format_method) :
for k, v in values.items() :
values[k] = format_method(v, cell_name=k)
else :
LOG("PDFForm", PROBLEM,
'format method (%r) is not callable' % format_method)
data = str(self.data)
pdf = self.pdftk.fillFormWithDict(data, values)
if self.__page_range__ not in ('', None) :
compiled_tales = getEngine().compile(self.__page_range__)
page_range = getEngine().getContext(context).evaluate(compiled_tales)
if page_range :
pdf = self.pdftk.catPages(pdf, page_range)
if RESPONSE :
RESPONSE.setHeader('Content-Type', 'application/pdf')
RESPONSE.setHeader('Content-Length', len(pdf))
RESPONSE.setHeader('Content-Disposition', 'inline;filename="%s.pdf"'
% (self.title_or_id()))
return pdf
index_html = generatePDF
__call__ = generatePDF
security.declareProtected(Permissions.View, 'calculateCellValues')
def calculateCellValues(self, REQUEST=None, *args, **kwargs) :
""" returns a dict of cell values """
# values to be returned
values = {}
# list of values that need to be reevaluated (i.e. they depend on the
# value of a cell that was not already evaluated when evaluating them )
uncalculated_values = []
for cell_name in self.cells.keys() :
not_founds = []
value = self.evaluateCell(cell_name, REQUEST = REQUEST,
cell = SafeMapping(CalculatedValues(
values, cell_name, not_founds)))
if len(not_founds) != 0 :
uncalculated_values.append(cell_name)
else :
values[cell_name] = value
# now we iterate on the list of uncalculated values, trying
# to evaluate them again, if an iteration doesn't decrement
# the length of this list, there are some circular references
# and we cannot continue.
while 1 :
uncalculated_values_len = len(uncalculated_values)
if uncalculated_values_len == 0 :
return values
for cell_name in uncalculated_values :
not_founds = []
value = self.evaluateCell(cell_name, REQUEST = REQUEST,
cell = SafeMapping(CalculatedValues(
values, cell_name, not_founds)))
if len(not_founds) == 0 :
uncalculated_values.remove(cell_name)
values[cell_name] = value
if len(uncalculated_values) == uncalculated_values_len :
raise ValueError, "Circular reference: unable to evaluate cells " \
+ `uncalculated_values`
security.declareProtected(Permissions.View, 'getCellNames')
def getCellNames(self, REQUEST=None) :
""" returns a list of cell names """
names = self.cells.keys()
names.sort()
return names
security.declareProtected(Permissions.ManagePortal, 'deleteCell')
def deleteCell(self, cell_name):
""" Delete a cell.
As setCellTALES add the cell if it is not present, we must have a
way to remove cells created by mistake. """
del self.all_cells[cell_name]
del self.cells[cell_name]
security.declareProtected(Permissions.ManagePortal, 'setCellTALES')
def setCellTALES(self, cell_name, TALES):
""" changes the TALES expression that will be used to evaluate
cell value """
if type(TALES) != types.StringType :
LOG("PDFForm", PROBLEM,
'TALES is not a string for cell "%s", it is = "%s"'
%(cell_name, `TALES`))
raise ValueError, 'TALES must be a string'
self.all_cells[str(cell_name)] = self.cells[str(cell_name)] = TALES
# invalidate for persistence
self.all_cells = self.all_cells
security.declareProtected(Permissions.View, 'getCellTALES')
def getCellTALES(self, cell_name):
""" returns the TALES expression associated with this cell """
return self.cells[str(cell_name)]
security.declareProtected(Permissions.View, 'evaluateCell')
def evaluateCell(self, cell_name, REQUEST=None, **kwargs):
""" evaluate the TALES expression for this cell """
cell_name = str(cell_name)
# we don't pass empty strings in TALES engine
# (and this also raises the KeyError for non existant cells)
if not self.cells[cell_name] :
return None
context = { 'here' : self.aq_parent,
'context' : self.aq_parent,
'request' : REQUEST }
context.update (kwargs)
try :
compiled_tales = getEngine().compile(self.cells[cell_name])
value = getEngine().getContext(context).evaluate(compiled_tales)
return value
except Exception, e :
LOG('PDFForm', PROBLEM, "Exception in cell %s"%cell_name, e)
raise e.__class__, "Exception in %s :\n %s"%(cell_name, e)
security.declareProtected(Permissions.ManagePortal, 'setAllCellTALES')
def setAllCellTALES(self, new_cells) :
""" set all cell values from a dict containing { name: TALES } """
for cell_name, cell_TALES in new_cells.items() :
self.setCellTALES(cell_name, cell_TALES)
security.declareProtected(Permissions.View, 'getFormatMethodTALES')
def getFormatMethodTALES(self):
""" returns the TALES expression for the format method attribute """
# backward compat
if not hasattr(self, "__format_method__") :
self.__format_method__ = ""
return self.__format_method__
security.declareProtected(Permissions.ManagePortal, 'setFormatMethodTALES')
def setFormatMethodTALES(self, TALES):
""" sets TALES expression for the format method attribute """
self.__format_method__ = str(TALES)
security.declareProtected(Permissions.View, 'getPageRangeTALES')
def getPageRangeTALES(self):
""" returns the TALES expression for the page range attribute """
return self.__page_range__
security.declareProtected(Permissions.ManagePortal, 'setPageRangeTALES')
def setPageRangeTALES(self, TALES):
""" sets TALES expression for the page range attribute """
self.__page_range__ = str(TALES)
InitializeClass(PDFForm)