Save ComicInfo.xml in CBZ Files (Optional) (#6102)

* Add ComicInfo.xml generator and include it in chapters file

* The label has been updated to provide clarity for the user

* Fix code issues

* Remove wrong code

src/web/mjs/HakuNeko.mjs

@@ -7,6 +7,7 @@ import BookmarkManager from './engine/BookmarkManager.mjs';
 import ChaptermarkManager from './engine/ChaptermarkManager.mjs';
 import Connectors from './engine/Connectors.mjs';
 import DownloadManager from './engine/DownloadManager.mjs';
+import ComicInfoGenerator from './engine/ComicInfoGenerator.mjs';
 //import HistoryWorker from './engine/HistoryWorker.mjs'
 import Request from './engine/Request.mjs';
 import Settings from './engine/Settings.mjs';
@@ -29,6 +30,7 @@ export default class HakuNeko {
         this._connectors = new Connectors(this._request);
         this._storage = new Storage();
         this._bookmarkManager = new BookmarkManager(this._settings, new BookmarkImporter());
+        this._comicInfoGenerator = new ComicInfoGenerator();
         this._chaptermarkManager = new ChaptermarkManager(this._settings);
     }
 
@@ -59,6 +61,10 @@ export default class HakuNeko {
         return this._bookmarkManager;
     }
 
+    get ComicInfoGenerator() {
+        return this._comicInfoGenerator;
+    }
+
     get ChaptermarkManager() {
         return this._chaptermarkManager;
     }

src/web/mjs/engine/ComicInfoGenerator.mjs

@@ -0,0 +1,26 @@
+export default class ComicInfoGenerator {
+    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>`;
+    }
+
+    escapeXML(str) {
+        const symbols = {
+            '<': '&lt;',
+            '>': '&gt;',
+            '&': '&amp;',
+            '\'': '&apos;',
+            '"': '&quot;'
+        };
+
+        return str.replace(/[<>&'"]/g, function (c) {
+            return symbols[c];
+        });
+    }
+}

src/web/mjs/engine/Settings.mjs

@@ -385,4 +385,4 @@ export default class Settings extends EventTarget {
                 return value;
         }
     }
-}
+}

src/web/mjs/engine/Storage.mjs

@@ -448,7 +448,7 @@ export default class Storage {
             }
             if (Engine.Settings.chapterFormat.value === extensions.cbz) {
                 this._createDirectoryChain(this.path.dirname(output));
-                promise = this._saveChapterPagesCBZ(output, pageData)
+                promise = this._saveChapterPagesCBZ(output, pageData, chapter.manga.title, chapter.title)
                     .then(() => this._runPostChapterDownloadCommand(chapter, output));
             }
             if (Engine.Settings.chapterFormat.value === extensions.pdf) {
@@ -548,8 +548,12 @@ 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();
+
+        let comicFile = Engine.ComicInfoGenerator.createComicInfoXML(mangaName, chapterName, pageData.length);
+        zip.file('ComicInfo.xml', comicFile);
+
         pageData.forEach(page => {
             zip.file(page.name, page.data);
         });
@@ -893,4 +897,4 @@ export default class Storage {
             });
         });
     }
-}
+}