Create Chapter 6 Bullets in Additional.lyx and move the bullet section into it; this...

[lyx.git] / lib / scripts / docbook2epub.py

diff --git a/lib/scripts/docbook2epub.py b/lib/scripts/docbook2epub.py
index 9836240913572b0c36d8bbe0aba167c6116282e2..0e9d268a473288a361977aeadc47078349bc1d40 100644 (file)
--- a/lib/scripts/docbook2epub.py
+++ b/lib/scripts/docbook2epub.py
@@ -9,7 +9,7 @@
 # Full author contact details are available in file CREDITS
 
 # Usage:
-#   python docbook2epub.py java_binary in.docbook out.epub
+#   python docbook2epub.py java_binary saxon_path xsltproc_path xslt_path in.docbook in.orig.path out.epub
 
 from __future__ import print_function
 
@@ -19,6 +19,18 @@ import shutil
 import sys
 import tempfile
 import zipfile
+from io import open  # Required for Python 2.
+
+
+def _parse_nullable_argument(arg):
+    return arg if arg != '' and arg != 'none' else None
+
+
+class ImageRename:
+    def __init__(self, opf_path, local_path, epub_path):
+        self.opf_path = opf_path
+        self.local_path = local_path
+        self.epub_path = epub_path
 
 
 class DocBookToEpub:
@@ -26,23 +38,28 @@ class DocBookToEpub:
         if args is None:
             args = sys.argv
 
-        if len(args) != 5:
-            print('Five arguments are expected, only %s found.' % len(sys.argv))
-            print(args)
+        if len(args) != 8:
+            print('Exactly eight arguments are expected, only %s found: %s.' % (len(args), args))
             sys.exit(1)
 
         self.own_path = sys.argv[0]
-        self.java_path = sys.argv[1] if sys.argv[1] != '' and sys.argv[1] != 'none' else ''
-        self.xsltproc_path = sys.argv[2] if sys.argv[2] != '' and sys.argv[2] != 'none' else ''
-        self.input = sys.argv[3]
-        self.output = sys.argv[4]
+        self.java_path = _parse_nullable_argument(sys.argv[1])
+        self.saxon_path = _parse_nullable_argument(sys.argv[2])
+        self.xsltproc_path = _parse_nullable_argument(sys.argv[3])
+        self.xslt_path = _parse_nullable_argument(sys.argv[4])
+        self.input = sys.argv[5]
+        self.input_path = sys.argv[6]
+        self.output = sys.argv[7]
         self.script_folder = os.path.dirname(self.own_path) + '/../'
 
         print('Generating ePub with the following parameters:')
         print(self.own_path)
         print(self.java_path)
+        print(self.saxon_path)
         print(self.xsltproc_path)
+        print(self.xslt_path)
         print(self.input)
+        print(self.input_path)
         print(self.output)
 
         # Precompute paths that will be used later.
@@ -50,10 +67,16 @@ class DocBookToEpub:
         self.package_opf = self.output_dir + '/OEBPS/package.opf'  # Does not exist yet,
         print('Temporary output directory: %s' % self.output_dir)
 
-        self.xslt = self.script_folder + 'docbook/epub3/chunk.xsl'
+        if self.xslt_path is None:
+            self.xslt = self.script_folder + 'docbook/epub3/chunk.xsl'
+        else:
+            self.xslt = self.xslt_path + '/epub3/chunk.xsl'
         print('XSLT style sheet to use:')
         print(self.xslt)
 
+        if self.saxon_path is None:
+            self.saxon_path = self.script_folder + 'scripts/saxon6.5.5.jar'
+
         # These will be filled during the execution of the script.
         self.renamed = None
 
@@ -64,9 +87,9 @@ class DocBookToEpub:
 
     def start_xslt_transformation(self):
         command = None
-        if self.xsltproc_path != '':
+        if self.xsltproc_path is not None:
             command = self.start_xslt_transformation_xsltproc()
-        elif self.java_path != '':
+        elif self.java_path is not None:
             command = self.start_xslt_transformation_saxon6()
 
         if command is None:
@@ -92,9 +115,8 @@ class DocBookToEpub:
         return '"' + self.xsltproc_path + '" ' + params + ' "' + self.xslt + '" "' + self.input + '"'
 
     def start_xslt_transformation_saxon6(self):
-        saxon_jar = self.script_folder + 'scripts/saxon6.5.5.jar'
         params = 'base.dir=%s' % self.output_dir
-        executable = '"' + self.java_path + '" -jar "' + saxon_jar + '"'
+        executable = '"' + self.java_path + '" -jar "' + self.saxon_path + '"'
         return executable + ' "' + self.input + '" "' + self.xslt + '" "' + params + '"'
 
     def get_images_from_package_opf(self):
@@ -114,6 +136,21 @@ class DocBookToEpub:
 
         return images
 
+    def get_image_changes(self):
+        epub_folder = 'images/'
+
+        changes = []
+        for image in self.get_images_from_package_opf():
+            if os.path.exists(image):
+                file_system_path = image
+            elif os.path.exists(self.input_path + image):
+                file_system_path = self.input_path + image
+            else:
+                file_system_path = ''
+
+            changes.append(ImageRename(image, file_system_path, epub_folder + os.path.basename(image)))
+        return changes
+
     def change_image_paths(self, file):
         # This could be optimised, as the same operation is performed a zillion times on many files:
         # https://www.oreilly.com/library/view/python-cookbook/0596001673/ch03s15.html
@@ -122,8 +159,8 @@ class DocBookToEpub:
 
         with open(file, 'w', encoding='utf8') as f:
             for line in contents:
-                for (old, new) in self.renamed.items():
-                    line = line.replace(old, new)
+                for change in self.renamed:
+                    line = line.replace(change.opf_path, change.epub_path)
                 f.write(line)
 
     def copy_images(self):
@@ -131,8 +168,7 @@ class DocBookToEpub:
         # changed in the XHTML files. Typically, the current paths are absolute.
 
         # First, get the mapping old file => file in the ePub archive.
-        original_images = self.get_images_from_package_opf()
-        self.renamed = {img: 'images/' + os.path.basename(img) for img in original_images}
+        self.renamed = self.get_image_changes()
 
         # Then, transform all paths (both OPF and XHTML files).
         self.change_image_paths(self.output_dir + '/OEBPS/package.opf')
@@ -144,8 +180,8 @@ class DocBookToEpub:
             os.mkdir(self.output_dir + '/OEBPS/images/')
 
         # Finally, actually copy the image files.
-        for (old, new) in self.renamed.items():
-            shutil.copyfile(old, self.output_dir + '/OEBPS/' + new)
+        for change in self.renamed:
+            shutil.copyfile(change.local_path, self.output_dir + '/OEBPS/' + change.epub_path)
 
     def create_zip_archive(self):
         with zipfile.ZipFile(self.output, 'w', zipfile.ZIP_DEFLATED) as zip: