Merge branch 'stashapp:main' into main

Author: Nonoty

plugins/DateParser/date_parser.py

@@ -1,5 +1,8 @@
+import os
 import sys, json
-
+from PythonDepManager import ensure_import
+ensure_import("dateparser>=1.2.1")
+ensure_import("stashapi:stashapp-tools")
 import stashapi.log as log
 from stashapi.stashapp import StashInterface
 import re
@@ -11,30 +14,38 @@ def main():
     global pattern
 
     pattern = re.compile(
-        r"\D(\d{4}|\d{1,2})[\._\- /\\](\d{1,2}|[a-zA-Z]{3,}\.*)[\._\- /\\](\d{4}|\d{1,2})\D"
+        r"\D((\d{4}|\d{1,2})[\._\- /\\](\d{1,2}|[a-zA-Z]{3,}\.*)[\._\- /\\](\d{4}|\d{1,2}))\D*"
     )
     json_input = json.loads(sys.stdin.read())
     mode_arg = json_input["args"]["mode"]
 
     stash = StashInterface(json_input["server_connection"])
-
+    config = stash.get_configuration()["plugins"]
+    settings = {"setTitle": False}
+    if "date_parser" in config:
+        settings.update(config["date_parser"])
     if mode_arg == "gallery":
-        find_date_for_galleries()
+        find_date_for_galleries(settings)
 
 
 def parse_date_candidate(string):
     result = None
     for match in pattern.finditer(string):
-        g1 = match.group(1)
-        g2 = match.group(2)
-        g3 = match.group(3)
+        g0 = match.group(1)
+        g1 = match.group(2)
+        g2 = match.group(3)
+        g3 = match.group(4)
         temp = parse(g1 + " " + g2 + " " + g3)
         if temp:
-            result = temp.strftime("%Y-%m-%d")
+            potential_title = None
+            _,ext = os.path.splitext(string)
+            if not ext and g0 in os.path.basename(string):
+                potential_title = os.path.basename(string).replace(g0, "").strip()
+            result = [temp.strftime("%Y-%m-%d"), potential_title]
     return result
 
 
-def find_date_for_galleries():
+def find_date_for_galleries(settings):
 
     galleries = stash.find_galleries(f={"is_missing": "date"})
 
@@ -60,9 +71,11 @@ def find_date_for_galleries():
                 "Gallery ID ("
                 + gallery.get("id")
                 + ") has matched the date : "
-                + acceptableDate
+                + acceptableDate[0]
             )
-            updateObject = {"id": gallery.get("id"), "date": acceptableDate}
+            updateObject = {"id": gallery.get("id"), "date": acceptableDate[0]}
+            if settings['setTitle'] and not gallery.get("title") and acceptableDate[1]:
+                updateObject["title"] = acceptableDate[1]
             stash.update_gallery(updateObject)
 
 

plugins/DateParser/date_parser.yml

@@ -1,6 +1,7 @@
 name: Gallery Date Parser
+# requires: PythonDepManager
 description: Find date in path or filename and add it to the gallery
-version: 0.3.0
+version: 1.1.0
 exec:
   - python
   - "{pluginDir}/date_parser.py"
@@ -10,3 +11,8 @@ tasks:
     description: Add the date on galleries based on their path
     defaultArgs:
       mode: gallery
+settings:
+  setTitle:
+    displayName: Set title ?
+    description: Set title from folder name minus the found date ? Only applies on galleries without titles
+    type: BOOLEAN

plugins/bulkImageScrape/BulkImageScrape.yml

@@ -1,7 +1,7 @@
 name: Bulk Image Scrape
 # requires: PythonDepManager 
 description: Apply an image scraper to all images
-version: 0.3.2
+version: 0.3.3
 url: https://github.com/stashapp/CommunityScripts/
 exec:
   - python
@@ -33,6 +33,9 @@ settings:
   SkipEntriesNum:
     displayName: number of entries to skip over (mostly for rerunning after an error on large collections)
     type: NUMBER
+  PerformerIdsFilter:
+    displayName: List of performers IDs (comma separated) to filter images the plugins sees
+    type: STRING
 
 tasks:
   - name: "Bulk Image Scrape"

plugins/bulkImageScrape/bulkImageScrape.py

@@ -114,10 +114,28 @@ def parse_skip_tags(client: StashInterface, skip_tags: str) -> list[str]:
             tag_ids.append(tag_id)
     return tag_ids
 
+def parse_performerIds_filter(performerIdsFilter: str) -> list[str]:
+    """
+    Parse a list of performer ids
+    """
+    if performerIdsFilter == "" or performerIdsFilter is None:
+        return []
+
+    performerIdsFilter = performerIdsFilter.split(",")
+    return performerIdsFilter
 
-def build_image_filter(skip_tags: list[str], exclude_organized: bool) -> dict:
+
+def build_image_filter(skip_tags: list[str], performerIdsFilter: list[str], exclude_organized: bool
+) -> dict:
     image_filter: dict = {}
 
+    if performerIdsFilter is not None and len(performerIdsFilter) > 0:
+        log.info(f"Images filtered for performer ID : {performerIdsFilter}")
+        image_filter["performers"] = {
+            "value": performerIdsFilter,
+            "modifier": "INCLUDES",
+        }
+
     if exclude_organized:
         image_filter["organized"] = False
 
@@ -134,12 +152,12 @@ def build_image_filter(skip_tags: list[str], exclude_organized: bool) -> dict:
 
 
 def count_all_images(
-    client: StashInterface, skip_tags: list[str], exclude_organized: bool
+    client: StashInterface, skip_tags: list[str], performerIdsFilter: list[str], exclude_organized: bool
 ) -> int:
     """
     count all images from the stash
     """
-    image_filter: dict = build_image_filter(skip_tags=skip_tags, exclude_organized=exclude_organized)
+    image_filter: dict = build_image_filter(skip_tags=skip_tags, performerIdsFilter=performerIdsFilter, exclude_organized=exclude_organized)
 
     all_results: dict = {
         "page": 1,
@@ -154,12 +172,12 @@ def count_all_images(
 
 
 def get_all_images(
-    client: StashInterface, skip_tags: list[str], exclude_organized: bool, skip_entries: int = 0
+    client: StashInterface, skip_tags: list[str], performerIdsFilter: list[str], exclude_organized: bool, skip_entries: int = 0
 ) -> Generator[dict, None, None]:
     """
     Get all images from the stash
     """
-    image_filter: dict = build_image_filter(skip_tags=skip_tags, exclude_organized=exclude_organized)
+    image_filter: dict = build_image_filter(skip_tags=skip_tags, performerIdsFilter=performerIdsFilter, exclude_organized=exclude_organized)
 
     page_size = 100
     page = 1
@@ -281,12 +299,14 @@ def update_image(client: StashInterface, update: dict) -> dict | None:
 settings: dict[str, any] = {
     "ScraperID": "",
     "SkipTags": "",
+    "PerformerIdsFilter": "",
     "CreateMissingPerformers": False,
     "CreateMissingStudios": False,
     "CreateMissingTags": False,
     "MergeExistingTags": False,
     "ExcludeOrganized": False,
     "SkipEntriesNum": 0,
+
 }
 
 if "BulkImageScrape" in config:
@@ -308,14 +328,15 @@ def update_image(client: StashInterface, update: dict) -> dict | None:
 validate_stashapi(StashItem.IMAGE, stash)
 scraper_id: str = validate_scraper(stash, settings["ScraperID"])
 parsed_skip_tags: list[str] = parse_skip_tags(stash, settings["SkipTags"])
+parsed_performerids_filter: list[str] = parse_performerIds_filter(settings["PerformerIdsFilter"])
 
 #
 # MAIN
 #
 
 log.info("Querying images from stash")
 total_images: int = count_all_images(
-    stash, parsed_skip_tags, settings["ExcludeOrganized"]
+    stash, parsed_skip_tags, parsed_performerids_filter, settings["ExcludeOrganized"]
 ) - settings["SkipEntriesNum"]
 
 if total_images == 0:
@@ -325,7 +346,7 @@ def update_image(client: StashInterface, update: dict) -> dict | None:
     log.info(f"Found {total_images} images")
 
 images: Generator[dict, None, None] = get_all_images(
-    stash, parsed_skip_tags, settings["ExcludeOrganized"], settings["SkipEntriesNum"]
+    stash, parsed_skip_tags, parsed_performerids_filter, settings["ExcludeOrganized"], settings["SkipEntriesNum"]
 )
 
 for i, image in enumerate(images, start=1):

plugins/image_date_from_metadata/README.md

@@ -0,0 +1,3 @@
+# Image Date From Metadata
+
+https://discourse.stashapp.cc/t/image-date-from-metadata/2225

plugins/nfoSceneParser/config.py

@@ -10,6 +10,11 @@
 # ! Not yet implemented. Currently, only "with files" is supported
 nfo_location = "with files"
 
+# By default the plugin will look for an nfo based on file name:
+# "Movie Title (2023).nfo"
+# If you want to use a custom file name eg. "movie.nfo", set it here.
+custom_nfo_name = ""
+
 # If True, will never update already "organized" scenes.
 skip_organized = True
 
@@ -41,6 +46,15 @@
 create_missing_tags = True
 create_missing_movies = True
 
+# Choose which field should be parsed into user rating
+# and if it should be multiplied by a factor.
+user_rating_field = "userrating"
+user_rating_multiplier = 1
+
+# Let you decide from where genres should be loaded from.
+# Possible values: "tags", "genres", "both"
+load_tags_from = "both"
+
 ###############################################################################
 # Do not change config below unless you are absolutely sure of what you do...
 ###############################################################################

plugins/nfoSceneParser/nfoParser.py

@@ -16,13 +16,16 @@ def __init__(self, scene_path, defaults=None, folder_mode=False):
             self._defaults = defaults
         # Finds nfo file
         self._nfo_file = None
+        dir_path = os.path.dirname(scene_path)
         if config.nfo_location.lower() == "with files":
             if folder_mode:
                 # look in current dir & parents for a folder.nfo file...
-                dir_path = os.path.dirname(scene_path)
                 self._nfo_file = self._find_in_parents(dir_path, "folder.nfo")
             else:
-                self._nfo_file = os.path.splitext(scene_path)[0] + ".nfo"
+                if len(getattr(config, "custom_nfo_name", "")) > 0:
+                    self._nfo_file = os.path.join(dir_path, config.custom_nfo_name)
+                else:
+                    self._nfo_file = os.path.splitext(scene_path)[0] + ".nfo"
         # else:
             # TODO: support dedicated dir instead of "with files" (compatibility with nfo exporters)
         self._nfo_root = None
@@ -56,7 +59,7 @@ def __read_cover_image_file(self):
         # Not found? Look tor folder image...
         path_dir = os.path.dirname(self._nfo_file)
         folder_files = sorted(glob.glob(f"{glob.escape(path_dir)}{os.path.sep}*.*"))
-        folder_pattern = re.compile("^.*(landscape\\d{0,2}|thumb\\d{0,2}|poster\\d{0,2}|cover\\d{0,2})\\.(jpe?g|png|webp)$", re.I)
+        folder_pattern = re.compile("^.*(landscape\\d{0,2}|thumb\\d{0,2}|poster\\d{0,2}|folder\\d{0,2}|cover\\d{0,2})\\.(jpe?g|png|webp)$", re.I)
         result = self.__match_image_files(folder_files, folder_pattern)
         return result
 
@@ -103,7 +106,8 @@ def __extract_cover_images_b64(self):
         return file_images
 
     def __extract_nfo_rating(self):
-        user_rating = round(float(self._nfo_root.findtext("userrating") or 0))
+        multiplier = getattr(config, "user_rating_multiplier", 1)
+        user_rating = round(float(self._nfo_root.findtext(getattr(config, "user_rating_field", "userrating")) or 0) * multiplier)
         if user_rating > 0:
             return user_rating
         # <rating> is converted to a scale of 5 if needed
@@ -124,17 +128,20 @@ def __extract_nfo_date(self):
         return self._nfo_root.findtext("premiered") or year
 
     def __extract_nfo_tags(self):
+        source = getattr(config, "load_tags_from", "both").lower()
         file_tags = []
-        # from nfo <tag>
-        tags = self._nfo_root.findall("tag")
-        for tag in tags:
-            if tag.text:
-                file_tags.append(tag.text)
-        # from nfo <genre>
-        genres = self._nfo_root.findall("genre")
-        for genre in genres:
-            if genre.text:
-                file_tags.append(genre.text)
+        if source in ["tags", "both"]:
+            # from nfo <tag>
+            tags = self._nfo_root.findall("tag")
+            for tag in tags:
+                if tag.text:
+                    file_tags.append(tag.text)
+        if source in ["genres", "both"]:
+            # from nfo <genre>
+            genres = self._nfo_root.findall("genre")
+            for genre in genres:
+                if genre.text:
+                    file_tags.append(genre.text)
         return list(set(file_tags))
 
     def __extract_nfo_actors(self):
@@ -147,6 +154,8 @@ def __extract_nfo_actors(self):
 
     def parse(self):
         if not self._nfo_file or not os.path.exists(self._nfo_file):
+            if self._nfo_file:
+                log.LogDebug(f"The NFO file \"{os.path.split(self._nfo_file)[1]}\" was not found")
             return {}
         log.LogDebug("Parsing '{}'".format(self._nfo_file))
         # Parse NFO xml content

plugins/nfoSceneParser/nfoSceneParser.yml

@@ -1,7 +1,7 @@
 name: nfoSceneParser
 description: Fills scene data from NFO or filename pattern
 url: https://github.com/stashapp/CommunityScripts/tree/main/plugins/nfoSceneParser
-version: 1.3.1
+version: 1.4.0
 exec:
   - python
   - "{pluginDir}/nfoSceneParser.py"
@@ -16,4 +16,4 @@ tasks:
     description: Reload all scenes that have specific "marker" tag (see plugin's config.py)
     defaultArgs:
       mode: reload
-# Last Updated January 3, 2024
+# Last Updated June 24, 2025

plugins/nfoSceneParser/stashInterface.py

@@ -149,6 +149,7 @@ def gql_updateScene(self, scene_id, scene_data):
             "date": scene_data["date"],
             "rating100": scene_data["rating"],
             "urls": scene_data["urls"],
+            "studio_id": scene_data["studio_id"],
             "code": scene_data["code"],
             "performer_ids": scene_data["performer_ids"],
             "tag_ids": scene_data["tag_ids"],