Save ComicInfo.xml in CBZ Files (Optional)

src/web/mjs/engine/ComicInfoGenerator.mjs

@@ -0,0 +1,29 @@
+export default class ComicInfoGenerator {
+    static createComicInfoXML(series, title, pagesCount) {
+        series = this.escapeXML(series);
+        title = this.escapeXML(title);
+        return `<?xml version="1.0" encoding="utf-8"?>
+<ComicInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+    <Title>${title}</Title>
+    <Series>${series}</Series>
+    <PageCount>${pagesCount}</PageCount>
+</ComicInfo>`;
+    }
+
+    static escapeXML(str) {
+        return str.replace(/[<>&'"]/g, function (c) {
+            switch (c) {
+                case '<':
+                    return '&lt;';
+                case '>':
+                    return '&gt;';
+                case '&':
+                    return '&amp;';
+                case '\'':
+                    return '&apos;';
+                case '"':
+                    return '&quot;';
+            }
+        });
+    }
+}

src/web/mjs/engine/Settings.mjs

@@ -125,6 +125,13 @@ export default class Settings extends EventTarget {
             value: extensions.img
         };
 
+        this.includesComicFile = {
+            label: 'Include Comic File in CBZ',
+            description: 'Include a comic file (comicinfo.xml) in the chapter archive',
+            input: types.checkbox,
+            value: false
+        };
+
         this.recompressionFormat = {
             label: 'De-Scrambling Format',
             description: [
@@ -420,4 +427,4 @@ export default class Settings extends EventTarget {
                 return value;
         }
     }
-}
+}

src/web/mjs/engine/Storage.mjs

@@ -1,4 +1,5 @@
 import EbookGenerator from './EbookGenerator.mjs';
+import ComicInfoGenerator from './ComicInfoGenerator.mjs';
 import Chapter from './Chapter.mjs';
 
 const extensions = {
@@ -448,7 +449,9 @@ export default class Storage {
             }
             if (Engine.Settings.chapterFormat.value === extensions.cbz) {
                 this._createDirectoryChain(this.path.dirname(output));
-                promise = this._saveChapterPagesCBZ(output, pageData)
+                let mangaName = chapter.manga.title;
+                let chapterName = chapter.title;
+                promise = this._saveChapterPagesCBZ(output, pageData, mangaName, chapterName)
                     .then(() => this._runPostChapterDownloadCommand(chapter, output));
             }
             if (Engine.Settings.chapterFormat.value === extensions.pdf) {
@@ -548,8 +551,14 @@ export default class Storage {
      * Create and save pages to the given archive file.
      * Callback will be executed after completion and provided with an array of errors (or an empty array when no errors occured).
      */
-    _saveChapterPagesCBZ(archive, pageData) {
+    _saveChapterPagesCBZ(archive, pageData, mangaName = '', chapterName = '') {
         let zip = new JSZip();
+
+        if (Engine.Settings.includesComicFile.value) {
+            let comicFile = ComicInfoGenerator.createComicInfoXML(mangaName, chapterName, pageData.length);
+            zip.file('ComicInfo.xml', comicFile);
+        }
+
         pageData.forEach(page => {
             zip.file(page.name, page.data);
         });