stash

stash/config/scrapers/community/ComicInfoXML/ComicInfoXML.py

@@ -0,0 +1,88 @@
+import json
+import pathlib
+import sys
+import xml.etree.ElementTree as ET
+
+import py_common.graphql as graphql
+import py_common.log as log
+
+"""
+This script parses xml files for metadata. 
+The .xml file must be in the same directory as the gallery files and named either ComicInfo.xml for loose files (folder full of jpg/png's) 
+or the same name as the .cbz/.zip file
+"""
+
+
+def query_xml(gallery_path, title):
+    res = {"title": title}
+    try:
+        tree = ET.parse(gallery_path)
+    except Exception as e:
+        log.error(f"xml parsing failed:{e}")
+        print("null")
+        exit(1)
+
+    if (node := tree.find("Title")) and (original_title := node.text):
+        res["title"] = original_title
+
+    if (node := tree.find("Web")) and (url := node.text):
+        res["url"] = url
+
+    if (node := tree.find("Summary")) and (details := node.text):
+        res["details"] = details
+
+    if (node := tree.find("Released")) and (date := node.text):
+        res["date"] = date
+
+    year = month = day = None
+    if node := tree.find("Year"):
+        year = node.text
+    if node := tree.find("Month"):
+        month = node.text
+    if node := tree.find("Day"):
+        day = node.text
+
+    if year and month and day:
+        res["date"] = f"{year}-{month:>02}-{day:>02}"
+
+    if (node := tree.find("Genre")) and (tags := node.text):
+        res["tags"] = [{"name": x} for x in tags.split(", ")]
+
+    if (node := tree.find("Series")) and (series := node.text):
+        res["tags"] = res.get("tags", []) + [{"name": f"Series/Parody: {series}"}]
+
+    if (node := tree.find("Characters")) and (characters := node.text):
+        res["performers"] = [{"name": x} for x in characters.split(", ")]
+
+    if (node := tree.find("Writer")) and (studio := node.text):
+        res["studio"] = {"name": studio}
+
+    return res
+
+
+if sys.argv[1] == "query":
+    fragment = json.loads(sys.stdin.read())
+    if not (gallery_path := graphql.getGalleryPath(fragment["id"])):
+        log.error(f"No gallery path found for gallery with ID {fragment['id']}")
+        print("null")
+        sys.exit(1)
+
+    p = pathlib.Path(gallery_path)
+    # Determine if loose file format or archive such as .cbz or .zip
+    if "cbz" in gallery_path or "zip" in gallery_path:
+        # Look for filename.xml where filename.(cbz|zip) is the gallery
+        f = p.with_suffix(".xml")
+        log.debug(f"Single File Format: trying '{f}'")
+    else:
+        # Use loose files format
+        # Look for ComicInfo.xml in the gallery's folder
+        f = p.resolve() / "ComicInfo.xml"
+        log.debug(f"Folder format: trying '{f}'")
+
+    if not f.is_file():
+        log.warning(f"No xml files found for the gallery: {p}")
+        print("null")
+        sys.exit(1)
+
+    res = query_xml(f, fragment["title"])
+    print(json.dumps(res))

stash/config/scrapers/community/ComicInfoXML/ComicInfoXML.yml

@@ -0,0 +1,12 @@
+name: "ComicInfo XML"
+# requires: py_common
+
+galleryByFragment:
+  action: script
+  script:
+    - python3
+    - ComicInfoXML.py
+    - query
+    - gallery
+
+# Last Updated December 26, 2021

stash/config/scrapers/community/ComicInfoXML/manifest

@@ -0,0 +1,10 @@
+id: ComicInfoXML
+name: ComicInfo XML
+metadata: {}
+version: 99ebb37
+date: "2024-04-04 15:06:31"
+requires: []
+source_repository: https://stashapp.github.io/CommunityScrapers/stable/index.yml
+files:
+- ComicInfoXML.py
+- ComicInfoXML.yml