new business template: erp5_pdf_merge

This business template contains an external method to merge multiple PDF as a
single document.

bt5/erp5_pdf_merge/ExtensionTemplateItem/ERP5PDFMerge.py

+##############################################################################
+#
+# Copyright (c) 2002-2013 Nexedi SA and Contributors. All Rights Reserved.
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsibility 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
+# guarantees 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+#
+##############################################################################
+
+
+def mergePDFList(self, pdf_data_list, start_on_recto=False):
+  """Merge multiple PDFs in a new PDF.
+  
+  Both input and output are raw PDF data as string, so pdf_data_list must be
+  a list of strings, and the output is the merged pdf as a string.
+  If "start_on_recto" is set to true, some blank pages will be added in order
+  to have each PDF as the recto page. This is useful if you have to print the
+  merged pdf in recto/verso mode.
+  """
+  from StringIO import StringIO
+  from pyPdf import PdfFileWriter, PdfFileReader
+  
+  output = PdfFileWriter()
+  
+  for pdf_data in pdf_data_list:
+    pdf_reader = PdfFileReader(StringIO(pdf_data))
+    page_count = pdf_reader.getNumPages()
+    for page in range(page_count):
+      output.addPage(pdf_reader.getPage(page))
+    if start_on_recto and page_count % 2:
+      output.addBlankPage()
+      
+  outputStream = StringIO()
+  output.write(outputStream)
+  return outputStream.getvalue()

bt5/erp5_pdf_merge/SkinTemplateItem/portal_skins/erp5_pdf_merge.xml

+<?xml version="1.0"?>
+<ZopeData>
+  <record id="1" aka="AAAAAAAAAAE=">
+    <pickle>
+      <global name="Folder" module="OFS.Folder"/>
+    </pickle>
+    <pickle>
+      <dictionary>
+        <item>
+            <key> <string>_objects</string> </key>
+            <value>
+              <tuple/>
+            </value>
+        </item>
+        <item>
+            <key> <string>id</string> </key>
+            <value> <string>erp5_pdf_merge</string> </value>
+        </item>
+        <item>
+            <key> <string>title</string> </key>
+            <value> <string></string> </value>
+        </item>
+      </dictionary>
+    </pickle>
+  </record>
+</ZopeData>

bt5/erp5_pdf_merge/SkinTemplateItem/portal_skins/erp5_pdf_merge/ERP5Site_mergePDFList.xml

+<?xml version="1.0"?>
+<ZopeData>
+  <record id="1" aka="AAAAAAAAAAE=">
+    <pickle>
+      <global name="ExternalMethod" module="Products.ExternalMethod.ExternalMethod"/>
+    </pickle>
+    <pickle>
+      <dictionary>
+        <item>
+            <key> <string>_function</string> </key>
+            <value> <string>mergePDFList</string> </value>
+        </item>
+        <item>
+            <key> <string>_module</string> </key>
+            <value> <string>ERP5PDFMerge</string> </value>
+        </item>
+        <item>
+            <key> <string>id</string> </key>
+            <value> <string>ERP5Site_mergePDFList</string> </value>
+        </item>
+        <item>
+            <key> <string>title</string> </key>
+            <value> <string></string> </value>
+        </item>
+      </dictionary>
+    </pickle>
+  </record>
+</ZopeData>

bt5/erp5_pdf_merge/TestTemplateItem/testERP5PDFMerge.py

+##############################################################################
+#
+# Copyright (c) 2002-2013 Nexedi SA and Contributors. All Rights Reserved.
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsibility 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
+# guarantees 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+#
+##############################################################################
+
+from Products.ERP5Type.tests.ERP5TypeTestCase import ERP5TypeTestCase
+from Products.ERP5OOo.tests.testDms import makeFileUpload
+
+class TestERP5PDFMerge(ERP5TypeTestCase):
+  def getBusinessTemplateList(self):
+    """Tuple of Business Templates we need to install
+    """
+    return ( 'erp5_base',
+             'erp5_web',
+             'erp5_ingestion',
+             'erp5_dms',
+             'erp5_pdf_merge' )
+
+  def test_erp5_merge_pdf(self):
+    document = self.portal.portal_contributions.newContent(
+      file=makeFileUpload('REF-en-001.pdf'))
+    merged_pdf_data = self.portal.ERP5Site_mergePDFList(
+      [document.getData(), document.getData()])
+    merged_document = self.portal.document_module.newContent(
+      portal_type='PDF',
+      data=merged_pdf_data)
+    self.assertEqual('2', merged_document.getContentInformation()['Pages'])
+
+  def test_erp5_merge_pdf_start_on_recto(self):
+    document = self.portal.portal_contributions.newContent(
+      file=makeFileUpload('REF-en-001.pdf'))
+    merged_pdf_data = self.portal.ERP5Site_mergePDFList(
+      [document.getData(), document.getData()], start_on_recto=True)
+    merged_document = self.portal.document_module.newContent(
+      portal_type='PDF',
+      data=merged_pdf_data)
+    # there are four pages, because blank pages has been added so that the
+    # second time, our document starts on a recto page.
+    self.assertEqual('4', merged_document.getContentInformation()['Pages'])
+

bt5/erp5_pdf_merge/bt/revision

+1
\ No newline at end of file

bt5/erp5_pdf_merge/bt/template_extension_id_list

+ERP5PDFMerge
\ No newline at end of file

bt5/erp5_pdf_merge/bt/template_format_version

+1
\ No newline at end of file

bt5/erp5_pdf_merge/bt/template_skin_id_list

+erp5_pdf_merge
\ No newline at end of file

bt5/erp5_pdf_merge/bt/template_test_id_list

+testERP5PDFMerge
\ No newline at end of file

bt5/erp5_pdf_merge/bt/title

+erp5_pdf_merge
\ No newline at end of file

bt5/erp5_registry_ohada/ExtensionTemplateItem/PdftkUtils.py

@@ -78,6 +78,8 @@ def addBackgroundOnPdfFile(orginal_pdf, background_pdf):
 def mergePDF(pdf_document_list):
   '''Merge all pdf in the pdf_document_list in one using pdftk and return it'''
 
+  from warnings import warn
+  warn("mergePDF is deprecated, use erp5_pdf_merge business template instead")
   tmp_pdf_list = []
   # create as tmp file as there is pdf_documents
   for pdf_document in pdf_document_list: