Implemented PDF export with PyPDF instead of PDFTk

Author: OpenNingia

l5r/exporters/fdfexporter.py

@@ -39,6 +39,15 @@ def set_model(self, model):
     def set_form(self, form):
         self.form = form
 
+    def get_fields(self):
+        fields = self.build_fields()
+        for f in fields:
+            if isinstance(fields[f], bool):
+                fields[f] = "/Yes" if fields[f] else "/Off"
+            else:
+                fields[f] = str(fields[f])
+        return fields
+
     def export(self, io):
         self.export_header(io)
         self.export_body(io)
@@ -51,7 +60,11 @@ def export_header(self, io):
         io.write(hd.encode('UTF-8'))
 
     def export_body(self, io):
-        pass
+        fields = self.build_fields()
+
+        # EXPORT FIELDS
+        for k in fields:
+            self.export_field(k, fields[k], io)
 
     def export_footer(self, io):
         ft = u"""</fields></xfdf>"""
@@ -107,7 +120,7 @@ def __init__(self):
         self.skill_offset = 0
         self.skills_per_page = 37
 
-    def export_body(self, io):
+    def build_fields(self):
         m = self.model
         f = self.form
 
@@ -301,9 +314,7 @@ def export_body(self, io):
                 fields['SKILL_ROLL.%d' % j] = sk.mod_roll
                 fields['SKILL_EMPH_MA.%d' % j] = ', '.join(sk.emph)
 
-        # EXPORT FIELDS
-        for k in fields:
-            self.export_field(k, fields[k], io)
+        return fields
 
 
 class FDFExporterShugenja(FDFExporter):
@@ -354,12 +365,11 @@ def export_spells(self, fields, pg=1, ctrl=1, off=0):
             #    lControlNumber = 1
             #    lPageNumber += 1
 
-    def export_body(self, io):
+    def build_fields(self):
         m = self.model
         f = self.form
 
         fields = {}
-        # self.export_spells(fields)
 
         def get_affinity_text_(element_or_tag):
             ring_ = api.data.get_ring(element_or_tag)
@@ -394,9 +404,7 @@ def get_affinity_text_(element_or_tag):
             else:
                 log.app.error('cannot export character school: %s'.format(str(schools[i])))
 
-        # EXPORT FIELDS
-        for k in fields:
-            self.export_field(k, fields[k], io)
+        return fields
 
 
 class FDFExporterSpells(FDFExporterShugenja):
@@ -407,22 +415,18 @@ def __init__(self, offset):
         self.spell_offset = offset
         self.spell_per_page = 6
 
-    def export_body(self, io):
-
+    def build_fields(self):
         fields = {}
         self.export_spells(fields=fields, pg=2, off=self.spell_offset)
-
-        # EXPORT FIELDS
-        for k in fields:
-            self.export_field(k, fields[k], io)
+        return fields
 
 
 class FDFExporterBushi(FDFExporter):
 
     def __init__(self):
         super(FDFExporterBushi, self).__init__()
 
-    def export_body(self, io):
+    def build_fields(self):
         m = self.model
         f = self.form
 
@@ -459,17 +463,14 @@ def export_body(self, io):
             fields['KATA_RING_MA.%d' %
                    (i + 1)] = '{0} ({1})'.format(kata.element, kata.mastery)
 
-        # EXPORT FIELDS
-        for k in fields:
-            self.export_field(k, fields[k], io)
-
+        return fields
 
 class FDFExporterMonk(FDFExporter):
 
     def __init__(self):
         super(FDFExporterMonk, self).__init__()
 
-    def export_body(self, io):
+    def build_fields(self):
         m = self.model
         f = self.form
 
@@ -527,9 +528,7 @@ def export_body(self, io):
                 fields['KIHO_ELEM.%d' % (i + 1)] = ""
 
 
-        # EXPORT FIELDS
-        for k in fields:
-            self.export_field(k, fields[k], io)
+        return fields
 
     def split_in_parts(self, text, max_lines=6):
         try:
@@ -572,7 +571,7 @@ def __init__(self, offset=0):
         self.weapons_offset = offset
         self.weapons_per_page = 10
 
-    def export_body(self, io):
+    def build_fields(self):
         m = self.model
         f = self.form
         fields = {}
@@ -601,16 +600,14 @@ def export_body(self, io):
                 fields['WEAPON.DMG.%d' % j] = weap.base_dmg
             fields['WEAPON.NOTES.%d' % j] = weap.desc
 
-        # EXPORT FIELDS
-        for k in fields:
-            self.export_field(k, fields[k], io)
+        return fields
 
 class FDFExporterCourtier(FDFExporter):
 
     def __init__(self):
         super(FDFExporterCourtier, self).__init__()
 
-    def export_body(self, io):
+    def build_fields(self):
         m = self.model
         f = self.form
 
@@ -636,9 +633,7 @@ def export_body(self, io):
                 fields['BUSHI_TECH.%d.%d' % (rank, i)] = tech.name
                 fields['BUSHI_TECH_TEXT.%d.%d' % (rank, i)] = tech.desc
 
-        # EXPORT FIELDS
-        for k in fields:
-            self.export_field(k, fields[k], io)
+        return fields
 
 
 class FDFExporterSkills(FDFExporter):
@@ -649,7 +644,7 @@ def __init__(self, offset=0):
         self.skill_offset = offset
         self.skills_per_page = 37
 
-    def export_body(self, io):
+    def build_fields(self):
         m = self.model
         f = self.form
 
@@ -669,6 +664,5 @@ def export_body(self, io):
             fields['SKILL_ROLL.%d' % i] = sk.mod_roll
             fields['SKILL_EMPH_MA.%d' % i] = ', '.join(sk.emph)
 
-        # EXPORT FIELDS
-        for k in fields:
-            self.export_field(k, fields[k], io)
+        return fields
+

l5r/l5rcmcore/__init__.py

@@ -39,6 +39,9 @@
 from PyQt5.QtGui import QDesktopServices
 from PyQt5.QtCore import QUrl
 
+# PyPDF
+from pypdf import PdfReader, PdfWriter
+
 APP_NAME = 'l5rcm'
 APP_DESC = 'Legend of the Five Rings: Character Manager'
 APP_VERSION = '3.17.0'
@@ -105,18 +108,13 @@ def export_as_text(self, export_file):
         #    exporter.export(f)
         #f.close()
 
-    def create_fdf(self, exporter):
-
+    def create_form_fields(self, exporter):
         exporter.set_form(self)
         exporter.set_model(self.pc)
+        return exporter.get_fields()
 
-        fd, fpath = mkstemp(suffix='.fdf', text=False)
-        with os.fdopen(fd, 'wb') as fobj:
-            exporter.export(fobj)
-
-        return fpath
 
-    def flatten_pdf(self, fdf_file, source_pdf, target_pdf, target_suffix=None):
+    def flatten_pdf(self, form_fields, source_pdf, target_pdf, target_suffix=None):
         basen = os.path.splitext(os.path.basename(target_pdf))[0]
         based = os.path.dirname(target_pdf)
 
@@ -125,49 +123,41 @@ def flatten_pdf(self, fdf_file, source_pdf, target_pdf, target_suffix=None):
         else:
             target_pdf = os.path.join(based, basen) + '.pdf'
 
-        # call pdftk
-        args_ = [self.get_pdftk(), source_pdf, 'fill_form',
-                 fdf_file, 'output', target_pdf, 'flatten']
+        try:
+            reader = PdfReader(source_pdf)
+            writer = PdfWriter()
+            writer.append(reader)
 
-        log.app.debug('call %s', args_)
+            writer.update_page_form_field_values(
+                None,
+                form_fields,
+                auto_regenerate=False,
+                flatten=False
+            )
 
-        ret = subprocess.call(args_)
-        self.try_remove(fdf_file)
+            with open(target_pdf, "wb") as output_stream:
+                writer.write(output_stream)     
 
-        if ret == 0:            
             log.app.info('created pdf %s', target_pdf)
-        else:
-            log.app.warn('could not flatten pdf. pdftk exited with error code: %d', ret)
-
-        return ret == 0
+            return True
+        finally:
+            pass
+        #except Exception as ex:
+        #    log.app.error('could not generate output pdf. exception: %s', ex)
+        #    return False
 
     def merge_pdf(self, input_files, output_file):
-        # call pdftk
-        args_ = [self.get_pdftk()] + input_files + ['output', output_file]
-
-        log.app.debug('call %s', args_)
-        subprocess.call(args_)
-        for f in input_files:
-            self.try_remove(f)
-
-    def get_pdftk(self):
-    
-        sys_path = shutil.which('pdftk')
-        if sys_path is not None and os.path.exists(sys_path):
-            return sys_path
-    
-        if sys.platform == 'win32':
-            return os.path.join(MY_CWD, 'tools', 'pdftk.exe')
-        elif sys.platform == 'linux' or sys.platform == 'linux2':
-            sys_path = '/usr/bin/pdftk'
-            loc_path = os.path.join(MY_CWD, 'tools', 'pdftk')
-            if os.path.exists(sys_path):
-                return sys_path
-            else:
-                return loc_path
-        elif sys.platform == 'darwin':
-            return os.path.join(MY_CWD, 'tools', 'pdftk')
-        return 'pdftk'
+        try:
+            merger = PdfWriter()
+
+            for pdf in input_files:
+                merger.append(pdf)
+
+            merger.write(output_file)
+            merger.close()
+        finally:
+            for f in input_files:
+                self.try_remove(f)
 
     def try_remove(self, fpath):
         try:
@@ -178,10 +168,11 @@ def try_remove(self, fpath):
 
     def write_pdf(self, source, exporter):
         source_pdf = get_app_file(source)
-        source_fdf = self.create_fdf(exporter)
+        form_fields = self.create_form_fields(exporter)
+
         fd, fpath = mkstemp(suffix='.pdf')
         os.fdopen(fd, 'wb').close()
-        self.flatten_pdf(source_fdf, source_pdf, fpath)
+        self.flatten_pdf(form_fields, source_pdf, fpath)
         self.temp_files.append(fpath)
 
     def commit_pdf_export(self, export_file):
@@ -211,11 +202,11 @@ def export_as_pdf(self, export_file):
 
         # GENERIC SHEET
         source_pdf = get_app_file('sheet_all.pdf')
-        source_fdf = self.create_fdf(exporters.FDFExporterAll())
+        form_fields = self.create_form_fields(exporters.FDFExporterAll())
         fd, fpath = mkstemp(suffix='.pdf')
         os.fdopen(fd, 'wb').close()
 
-        self.flatten_pdf(source_fdf, source_pdf, fpath)
+        self.flatten_pdf(form_fields, source_pdf, fpath)
         self.temp_files.append(fpath)
 
         # SAMURAI MONKS ALSO FITS IN THE BUSHI CHARACTER SHEET

l5r/sinks/sink_1.py

@@ -16,26 +16,31 @@
 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
 from PyQt5 import QtCore, QtGui, QtWidgets
+from PyQt5.QtCore import Qt
 
 import l5r.dialogs as dialogs
 import l5r.models as models
 import os
 
 from l5r.util import log, osutil, names
 from l5r.util.settings import L5RCMSettings
+from l5r.util.worker import Worker
 
 import l5r.api as api
 import l5r.api.character
 import l5r.api.character.books
 
 from l5r.l5rcmcore import get_app_file, DB_VERSION, get_icon_path
 
+import pyqtspinner
 
 class Sink1(QtCore.QObject):
 
     def __init__(self, parent=None):
         super(Sink1, self).__init__(parent)
         self.form = parent
+        self.thread_pool = QtCore.QThreadPool()
+        self.thread_pool.setMaxThreadCount(2)
 
     def new_character(self):
         form = self.form
@@ -87,11 +92,17 @@ def export_character_as_pdf(self):
         file_ = form.select_export_file(".pdf")
 
         if file_:
-            try:
-                form.export_as_pdf(file_)
-                form.open_pdf_file_as_shell(file_)
-            except Exception as e:
-                self.form.advise_error(self.tr("Cannot save pdf sheet."))            
+
+            spinner = pyqtspinner.WaitingSpinner(form, True, True, Qt.ApplicationModal)                      
+
+            worker = Worker(form.export_as_pdf, file_) # Any other args, kwargs are passed to the run function
+            worker.signals.result.connect(lambda x: form.open_pdf_file_as_shell(file_))
+            worker.signals.finished.connect(lambda: spinner.stop())
+            worker.signals.error.connect(lambda x: form.advise_error(self.tr("Cannot save pdf sheet.")))
+
+            self.thread_pool.start(worker)
+
+            spinner.start() # starts spinning           
 
     def switch_to_page_1(self):
         self.form.tabs.setCurrentIndex(0)