Remove unused UI variable endpoint

plugins/ChangeFileMonitor/changefilemonitor.py

@@ -1,9 +1,13 @@
 # Description: This is a Stash plugin which updates Stash if any changes occurs in the Stash library paths.
 # By David Maisonave (aka Axter) Jul-2024 (https://www.axter.com/)
 # Get the latest developers version from following link: https://github.com/David-Maisonave/Axter-Stash/tree/main/plugins/ChangeFileMonitor
+# Note: To call this script outside of Stash, pass any argument. 
+#       Example:    python changefilemonitor.py foofoo
 import os
 import sys
+import time
 import shutil
+import fileinput
 import hashlib
 import json
 from pathlib import Path
@@ -21,9 +25,9 @@ from multiprocessing import shared_memory
 # Constant global variables --------------------------------------------
 LOG_FILE_PATH = log_file_path = f"{Path(__file__).resolve().parent}\\{Path(__file__).stem}.log" 
 FORMAT = "[%(asctime)s - LN:%(lineno)s] %(message)s"
-DEFAULT_ENDPOINT = "http://localhost:9999/graphql" # Default GraphQL endpoint
 PLUGIN_ARGS = False
 PLUGIN_ARGS_MODE = False
+PLUGIN_ID = Path(__file__).stem.lower()
 # GraphQL query to fetch all scenes
 QUERY_ALL_SCENES = """
     query AllScenes {
@@ -51,6 +55,7 @@ mutex = Lock()
 signal = Condition(mutex)
 shouldUpdate = False
 TargetPaths = []
+runningInPluginMode = False
 
 # Configure local log file for plugin within plugin folder having a limited max log file size 
 logging.basicConfig(level=logging.INFO, format=FORMAT, datefmt="%y%m%d %H:%M:%S", handlers=[RFH])
@@ -59,8 +64,36 @@ logger = logging.getLogger(Path(__file__).stem)
 # **********************************************************************
 # ----------------------------------------------------------------------
 # Code section to fetch variables from Plugin UI and from changefilemonitor_settings.py
-json_input = json.loads(sys.stdin.read())
+# Check if being called as Stash plugin
-FRAGMENT_SERVER = json_input["server_connection"]
+gettingCalledAsStashPlugin = True
+stopLibraryMonitoring = False
+StdInRead = None
+try:
+    if len(sys.argv) == 1:
+        print(f"Attempting to read stdin. (len(sys.argv)={len(sys.argv)})", file=sys.stderr)
+        StdInRead = sys.stdin.read()
+        # for line in fileinput.input():
+            # StdInRead = line
+            # break
+    else:
+        if len(sys.argv) > 1 and sys.argv[1].lower() == "stop":
+            stopLibraryMonitoring = True
+        raise Exception("Not called in plugin mode.") 
+except:
+    gettingCalledAsStashPlugin = False
+    print(f"Either len(sys.argv) not expected value OR sys.stdin.read() failed! (stopLibraryMonitoring={stopLibraryMonitoring}) (StdInRead={StdInRead}) (len(sys.argv)={len(sys.argv)})", file=sys.stderr)
+    pass
+    
+if gettingCalledAsStashPlugin and StdInRead:
+    print(f"StdInRead={StdInRead} (len(sys.argv)={len(sys.argv)})", file=sys.stderr)
+    runningInPluginMode = True
+    json_input = json.loads(StdInRead)
+    FRAGMENT_SERVER = json_input["server_connection"]
+else:
+    runningInPluginMode = False
+    FRAGMENT_SERVER = {'Scheme': 'http', 'Host': '0.0.0.0', 'Port': 9999, 'SessionCookie': {'Name': 'session', 'Value': '', 'Path': '', 'Domain': '', 'Expires': '0001-01-01T00:00:00Z', 'RawExpires': '', 'MaxAge': 0, 'Secure': False, 'HttpOnly': False, 'SameSite': 0, 'Raw': '', 'Unparsed': None}, 'Dir': os.path.dirname(Path(__file__).resolve().parent), 'PluginDir': Path(__file__).resolve().parent}
+    print("Running in non-plugin mode!", file=sys.stderr)
+
 stash = StashInterface(FRAGMENT_SERVER)
 PLUGINCONFIGURATION = stash.get_configuration()["plugins"]
 STASHCONFIGURATION = stash.get_configuration()["general"]
@@ -69,12 +102,12 @@ stashPaths = []
 settings = {
     "recursiveDisabled": False,
     "runCleanAfterDelete": False,
+    "runGenerateContent": False,
     "scanModified": False,
-    "zgraphqlEndpoint": DEFAULT_ENDPOINT,
     "zzdebugTracing": False,
     "zzdryRun": False,
 }
-PLUGIN_ID = "changefilemonitor"
+
 if PLUGIN_ID in PLUGINCONFIGURATION:
     settings.update(PLUGINCONFIGURATION[PLUGIN_ID])
 # ----------------------------------------------------------------------
@@ -82,6 +115,7 @@ debugTracing = settings["zzdebugTracing"]
 RECURSIVE = settings["recursiveDisabled"] == False
 SCAN_MODIFIED = settings["scanModified"]
 RUN_CLEAN_AFTER_DELETE = settings["runCleanAfterDelete"]
+RUN_GENERATE_CONTENT = settings["runGenerateContent"]
 
 for item in STASHPATHSCONFIG: 
     stashPaths.append(item["path"])
@@ -94,7 +128,7 @@ try:
     PLUGIN_ARGS_MODE    = json_input['args']["mode"]
 except:
     pass
-logger.info(f"\nStarting (debugTracing={debugTracing}) (DRY_RUN={DRY_RUN}) (PLUGIN_ARGS_MODE={PLUGIN_ARGS_MODE}) (PLUGIN_ARGS={PLUGIN_ARGS})************************************************")
+logger.info(f"\nStarting (runningInPluginMode={runningInPluginMode}) (debugTracing={debugTracing}) (DRY_RUN={DRY_RUN}) (PLUGIN_ARGS_MODE={PLUGIN_ARGS_MODE}) (PLUGIN_ARGS={PLUGIN_ARGS})************************************************")
 if debugTracing: logger.info(f"Debug Tracing (stash.get_configuration()={stash.get_configuration()})................")
 if debugTracing: logger.info("settings: %s " % (settings,))
 if debugTracing: logger.info(f"Debug Tracing (STASHCONFIGURATION={STASHCONFIGURATION})................")
@@ -104,11 +138,6 @@ if DRY_RUN:
     logger.info("Dry run mode is enabled.")
     dry_run_prefix = "Would've "
 if debugTracing: logger.info("Debug Tracing................")
-# ToDo: Add split logic here to slpit possible string array into an array
-endpoint = settings["zgraphqlEndpoint"] # GraphQL endpoint
-if not endpoint or endpoint == "":
-    endpoint = DEFAULT_ENDPOINT
-if debugTracing: logger.info(f"Debug Tracing (endpoint={endpoint})................")
 # ----------------------------------------------------------------------
 # **********************************************************************
 if debugTracing: logger.info(f"Debug Tracing (SCAN_MODIFIED={SCAN_MODIFIED}) (RECURSIVE={RECURSIVE})................")
@@ -207,48 +236,53 @@ def start_library_monitor():
                     stash.metadata_scan(paths=TmpTargetPaths)
                 if RUN_CLEAN_AFTER_DELETE and RunCleanMetadata:
                     stash.metadata_clean(paths=TmpTargetPaths, dry_run=DRY_RUN)
-                stash.run_plugin_task(plugin_id=PLUGIN_ID, task_name="Start Library Monitor")
+                if RUN_GENERATE_CONTENT:
-                if debugTracing: logger.info("Exiting plugin so that metadata_scan task can run.")
+                    stash.metadata_generate()
-                return
+                if gettingCalledAsStashPlugin and shm_buffer[0] == CONTINUE_RUNNING_SIG:
+                    stash.run_plugin_task(plugin_id=PLUGIN_ID, task_name="Start Library Monitor")
+                    if debugTracing: logger.info("Exiting plugin so that metadata_scan task can run.")
+                    return
             else:
                 if debugTracing: logger.info("Nothing to scan.")
             if shm_buffer[0] != CONTINUE_RUNNING_SIG:
                 logger.info(f"Exiting Change File Monitor. (shm_buffer[0]={shm_buffer[0]})")
                 shm_a.close()
                 shm_a.unlink()  # Call unlink only once to release the shared memory
-                time.sleep(1)
+                raise KeyboardInterrupt
-                break
     except KeyboardInterrupt:
         observer.stop()
         if debugTracing: logger.info("Stopping observer................")
     observer.join()
     if debugTracing: logger.info("Exiting function................")
 
-# stop_library_monitor does not work because only one task can run at a time. 
+# This function is only useful when called outside of Stash. 
-# def stop_library_monitor():
+#       Example: python changefilemonitor.py stop
-    # if debugTracing: logger.info("Opening shared memory map.")
+# Stops monitoring after triggered by the next file change.
-    # try:
+# ToDo: Add logic so it doesn't have to wait until the next file change
-        # shm_a = shared_memory.SharedMemory(name="DavidMaisonaveAxter_ChangeFileMonitor", create=False, size=4)
+def stop_library_monitor():
-    # except:
+    if debugTracing: logger.info("Opening shared memory map.")
-        # pass
+    try:
-        # logger.info("Could not open shared memory map. Change File Monitor must not be running.")
+        shm_a = shared_memory.SharedMemory(name="DavidMaisonaveAxter_ChangeFileMonitor", create=False, size=4)
-        # return
+    except:
-    # type(shm_a.buf)
+        pass
-    # shm_buffer = shm_a.buf
+        logger.info("Could not open shared memory map. Change File Monitor must not be running.")
-    # len(shm_buffer)
+        return
-    # shm_buffer[0] = 123
+    type(shm_a.buf)
-    # if debugTracing: logger.info(f"Shared memory map opended, and flag set to {shm_buffer[0]}")
+    shm_buffer = shm_a.buf
-    # shm_a.close()
+    len(shm_buffer)
-    # shm_a.unlink()  # Call unlink only once to release the shared memory
+    shm_buffer[0] = 123
-    # time.sleep(1)
+    if debugTracing: logger.info(f"Shared memory map opended, and flag set to {shm_buffer[0]}")
-    # return
+    shm_a.close()
+    shm_a.unlink()  # Call unlink only once to release the shared memory
+    time.sleep(1)
+    return
     
-if PLUGIN_ARGS_MODE == "start_library_monitor":
+if stopLibraryMonitoring:
+    stop_library_monitor()
+    if debugTracing: logger.info(f"stop_library_monitor EXIT................")
+elif PLUGIN_ARGS_MODE == "start_library_monitor" or not gettingCalledAsStashPlugin:
     start_library_monitor()
     if debugTracing: logger.info(f"start_library_monitor EXIT................")
-# elif PLUGIN_ARGS_MODE == "stop_library_monitor":
-    # stop_library_monitor()
-    # if debugTracing: logger.info(f"stop_library_monitor EXIT................")
 else:
     logger.info(f"Nothing to do!!! (PLUGIN_ARGS_MODE={PLUGIN_ARGS_MODE})")
 

plugins/ChangeFileMonitor/changefilemonitor.yml

@@ -11,14 +11,14 @@ settings:
     displayName: Run Clean
     description: Enable to run metadata clean task after file deletion.
     type: BOOLEAN
+  runGenerateContent:
+    displayName: Run Generate Content
+    description: Enable to run metadata_generate (Generate Content) after metadata scan.
+    type: BOOLEAN
   scanModified:
     displayName: Scan Modifications
     description: Enable to monitor changes in file system for modification flag. This option is NOT needed for Windows, because on Windows changes are triggered via CREATE, DELETE, and MOVE flags. Other OS may differ.
     type: BOOLEAN
-  zgraphqlEndpoint:
-    displayName: GraphQL Endpoint
-    description: (Default=http://localhost:9999/graphql). Update with your endpoint, or leave blank to use default.
-    type: STRING
   zzdebugTracing:
     displayName: Debug Tracing
     description: (Default=false) [***For Advanced Users***] Enable debug tracing. When enabled, additional tracing logging is added to Stash\plugins\ChangeFileMonitor\changefilemonitor.log

plugins/RenameFile/renamefile.py

@@ -21,6 +21,7 @@ LOG_FILE_PATH = log_file_path = f"{Path(__file__).resolve().parent}\\{Path(__fil
 FORMAT = "[%(asctime)s - LN:%(lineno)s] %(message)s"
 DEFAULT_ENDPOINT = "http://localhost:9999/graphql" # Default GraphQL endpoint
 DEFAULT_FIELD_KEY_LIST = "title,performers,studio,tags" # Default Field Key List with the desired order
+PLUGIN_ID = Path(__file__).stem.lower()
 DEFAULT_SEPERATOR = "-"
 PLUGIN_ARGS = False
 PLUGIN_ARGS_MODE = False
@@ -51,7 +52,7 @@ exitMsg = "Change success!!"
 
 # Configure local log file for plugin within plugin folder having a limited max log file size 
 logging.basicConfig(level=logging.INFO, format=FORMAT, datefmt="%y%m%d %H:%M:%S", handlers=[RFH])
-logger = logging.getLogger('renamefile')
+logger = logging.getLogger(PLUGIN_ID)
 
 # **********************************************************************
 # ----------------------------------------------------------------------
@@ -75,8 +76,8 @@ settings = {
     "zzdebugTracing": False,
     "zzdryRun": False,
 }
-if "renamefile" in pluginConfiguration:
+if PLUGIN_ID in pluginConfiguration:
-    settings.update(pluginConfiguration["renamefile"])
+    settings.update(pluginConfiguration[PLUGIN_ID])
 # ----------------------------------------------------------------------
 debugTracing = settings["zzdebugTracing"]
 
@@ -94,6 +95,13 @@ except:
     pass
 logger.info(f"\nStarting (debugTracing={debugTracing}) (dry_run={dry_run}) (PLUGIN_ARGS_MODE={PLUGIN_ARGS_MODE}) (inputToUpdateScenePost={inputToUpdateScenePost})************************************************")
 if debugTracing: logger.info("settings: %s " % (settings,))
+# if PLUGIN_ID in pluginConfiguration:
+    # if debugTracing: logger.info(f"Debug Tracing (pluginConfiguration[PLUGIN_ID]={pluginConfiguration[PLUGIN_ID]})................")
+    # if 'zmaximumTagKeys' not in pluginConfiguration[PLUGIN_ID]:
+        # if debugTracing: logger.info("Debug Tracing................")
+        # stash.configure_plugin(PLUGIN_ID, settings) # , init_defaults=True
+    # if debugTracing: logger.info("Debug Tracing................")
+
 if dry_run:
     logger.info("Dry run mode is enabled.")
     dry_run_prefix = "Would've "
@@ -131,6 +139,8 @@ separator = settings["zseparators"]
 
 double_separator = separator + separator
 if debugTracing: logger.info(f"Debug Tracing (PLUGIN_ARGS={PLUGIN_ARGS}) (WRAPPER_STYLES={WRAPPER_STYLES}) (POSTFIX_STYLES={POSTFIX_STYLES})................")
+if debugTracing: logger.info(f"Debug Tracing (PLUGIN_ID=\"{PLUGIN_ID}\")................")
+if debugTracing: logger.info("Debug Tracing................")
 
 # Function to make GraphQL requests
 def graphql_request(query, variables=None):