From 0ae1636d5803c6e00d5484a17bbc17147865eff2 Mon Sep 17 00:00:00 2001 From: David Maisonave <47364845+David-Maisonave@users.noreply.github.com> Date: Fri, 26 Jul 2024 12:32:50 -0400 Subject: [PATCH] misc --- plugins/.gitignore | 528 ++++++++++++++++++++++++++++++ plugins/RenameFile/manifest | 2 +- plugins/RenameFile/renamefile.py | 189 +++++------ plugins/RenameFile/renamefile.yml | 2 +- 4 files changed, 620 insertions(+), 101 deletions(-) create mode 100644 plugins/.gitignore diff --git a/plugins/.gitignore b/plugins/.gitignore new file mode 100644 index 0000000..4cf98f6 --- /dev/null +++ b/plugins/.gitignore @@ -0,0 +1,528 @@ +$ cat .gitignore + +# Ignore these patterns +desktop.ini +~AutoRecover*.* +*.aps +*.exe +*.idb +*.ipch +*.lib +*.log +*.log.1 +*.log.2 +*.manifest +*.obj +*.pch +*.pdb +*.sdf +*.suo +*.tlog +*.user +*.7z +*.swp +*.zip +data.csv +/boost +/scintilla +/bin +/SQL +/__pycache__ +__pycache__/ +renamefile_settings.cpython-310.pyc +/WindowsSymbolicLinkCleaner +/DeleteMe +/ChangeFileMonitor + +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. +## +## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore + +# User-specific files +*.rsuser +*.suo +*.user +*.userosscache +*.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Mono auto generated files +mono_crash.* + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +[Ww][Ii][Nn]32/ +[Aa][Rr][Mm]/ +[Aa][Rr][Mm]64/ +bld/ +[Bb]in/ +[Oo]bj/ +[Ll]og/ +[Ll]ogs/ + + +# Visual Studio 2015/2017 cache/options directory +.vs/ +# Uncomment if you have tasks that create the project's static files in wwwroot +#wwwroot/ + +# Visual Studio 2017 auto generated files +Generated\ Files/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUnit +*.VisualState.xml +TestResult.xml +nunit-*.xml + +# Build Results of an ATL Project +[Dd]ebugPS/ +[Rr]eleasePS/ +dlldata.c + +# Benchmark Results +BenchmarkDotNet.Artifacts/ + +# .NET Core +project.lock.json +project.fragment.lock.json +artifacts/ + +# Tye +.tye/ + +# ASP.NET Scaffolding +ScaffoldingReadMe.txt + +# StyleCop +StyleCopReport.xml + +# Files built by Visual Studio +*_i.c +*_p.c +*_h.h +*_i.h +*.ilk +*.meta +*.obj +*.iobj +*.pch +*.pdb +*.ipdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*_wpftmp.csproj +*.log +*.vspscc +*.vssscc +.builds +*.pidb +*.svclog +*.scc + +# Chutzpah Test files +_Chutzpah* + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile +*.VC.db +*.VC.VC.opendb + +# Visual Studio profiler +*.psess +*.vsp +*.vspx +*.sap + +# Visual Studio Trace Files +*.e2e + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper +*.DotSettings.user +# JustCode is a .NET coding add-in +.JustCode + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# AxoCover is a Code Coverage Tool +.axoCover/* +!.axoCover/settings.json + +# Coverlet is a free, cross platform Code Coverage Tool +coverage*.json +coverage*.xml +coverage*.info + +# Visual Studio code coverage results +*.coverage +*.coveragexml + +# NCrunch +_NCrunch_* +.*crunch*.local.xml +nCrunchTemp_* + +# MightyMoose +*.mm.* +AutoTest.Net/ + +# Web workbench (sass) +.sass-cache/ + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.[Pp]ublish.xml +*.azurePubxml +# Note: Comment the next line if you want to checkin your web deploy settings, +# but database connection strings (with potential passwords) will be unencrypted +*.pubxml +*.publishproj + +# Microsoft Azure Web App publish settings. Comment the next line if you want to +# checkin your Azure Web App publish settings, but sensitive information contained +# in these scripts will be unencrypted +PublishScripts/ + +# NuGet Packages +*.nupkg +# NuGet Symbol Packages +*.snupkg +# The packages folder can be ignored because of Package Restore +**/[Pp]ackages/* +# except build/, which is used as an MSBuild target. +!**/[Pp]ackages/build/ +# Uncomment if necessary however generally it will be regenerated when needed +#!**/[Pp]ackages/repositories.config +# NuGet v3's project.json files produces more ignorable files +*.nuget.props +*.nuget.targets + +# Microsoft Azure Build Output +csx/ +*.build.csdef + +# Microsoft Azure Emulator +ecf/ +rcf/ + +# Windows Store app package directories and files +AppPackages/ +BundleArtifacts/ +Package.StoreAssociation.xml +_pkginfo.txt +*.appx +*.appxbundle +*.appxupload + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!?*.[Cc]ache/ + +# Others +ClientBin/ +~$* +*~ +*.dbmdl +*.dbproj.schemaview +*.jfm +*.pfx +*.publishsettings +node_modules/ +orleans.codegen.cs + +# Including strong name files can present a security risk +# (https://github.com/github/gitignore/pull/2483#issue-259490424) +#*.snk + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +#bower_components/ + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm +ServiceFabricBackup/ +*.rptproj.bak + +# SQL Server files +*.mdf +*.ldf +*.ndf + +# Business Intelligence projects +*.rdl.data +*.bim.layout +*.bim_*.settings +*.rptproj.rsuser +*- [Bb]ackup.rdl +*- [Bb]ackup ([0-9]).rdl +*- [Bb]ackup ([0-9][0-9]).rdl + +# Microsoft Fakes +FakesAssemblies/ + +# GhostDoc plugin setting file +*.GhostDoc.xml + +# Node.js Tools for Visual Studio +.ntvs_analysis.dat +node_modules/ + +# Visual Studio 6 build log +*.plg + +# Visual Studio 6 workspace options file +*.opt + +# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) +*.vbw + +# Visual Studio LightSwitch build output +**/*.HTMLClient/GeneratedArtifacts +**/*.DesktopClient/GeneratedArtifacts +**/*.DesktopClient/ModelManifest.xml +**/*.Server/GeneratedArtifacts +**/*.Server/ModelManifest.xml +_Pvt_Extensions + +# Paket dependency manager +.paket/paket.exe +paket-files/ + +# FAKE - F# Make +.fake/ + +# JetBrains Rider +.idea/ +*.sln.iml + +# CodeRush +.cr/ + +# CodeRush personal settings +.cr/personal + +# Python Tools for Visual Studio (PTVS) +__pycache__/ +*.pyc + +# Cake - Uncomment if you are using it +# tools/** +# !tools/packages.config + +# Tabs Studio +*.tss + +# Telerik's JustMock configuration file +*.jmconfig + +# BizTalk build output +*.btp.cs +*.btm.cs +*.odx.cs +*.xsd.cs + +# OpenCover UI analysis results +OpenCover/ + +# Azure Stream Analytics local run output +ASALocalRun/ + +# MSBuild Binary and Structured Log +*.binlog + +# NVidia Nsight GPU debugger configuration file +*.nvuser + +# MFractors (Xamarin productivity tool) working folder +.mfractor/ + +# Local History for Visual Studio +.localhistory/ + +# BeatPulse healthcheck temp database +healthchecksdb + +# Backup folder for Package Reference Convert tool in Visual Studio 2017 +MigrationBackup/ + +# Ionide (cross platform F# VS Code tools) working folder +.ionide/ + +# Fody - auto-generated XML schema +FodyWeavers.xsd + +## +## Visual studio for Mac +## + + +# globs +Makefile.in +*.userprefs +*.usertasks +config.make +config.status +aclocal.m4 +install-sh +autom4te.cache/ +*.tar.gz +tarballs/ +test-results/ + +# Mac bundle stuff +*.dmg +*.app + +# content below from: https://github.com/github/gitignore/blob/master/Global/macOS.gitignore +# General +.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + +# content below from: https://github.com/github/gitignore/blob/master/Global/Windows.gitignore +# Windows thumbnail cache files +Thumbs.db +ehthumbs.db +ehthumbs_vista.db + +# Dump file +*.stackdump + +# Folder config file +[Dd]esktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Windows Installer files +*.cab +*.msi +*.msix +*.msm +*.msp + +# Windows shortcuts +*.lnk + +# JetBrains Rider +.idea/ +*.sln.iml + +## +## Visual Studio Code +## +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json + +# Other miscellaneous folders +zzMiscellaneous/ +zzExcludeFromGithub/ +FromAnotherLanuageKit/ +_BadLanguages/ + +# Exclude test data and temp files +Test_Data/ +*__ExcludeFromRepo__*.* +*__DoNotAddToRepo__*.* +deleteme/ +RelatedProjects/ +obj/ + +# Exclude temp and backup files +*.bak + +# ########################################### +# Unique to this project +# ########################################### +# Exclude reparsepoint files which are used to help view file using VS +*.xaml.xml +gitignore.txt + +GTranslate/obj/ diff --git a/plugins/RenameFile/manifest b/plugins/RenameFile/manifest index a98d0dc..c376197 100644 --- a/plugins/RenameFile/manifest +++ b/plugins/RenameFile/manifest @@ -2,7 +2,7 @@ id: renamefile name: RenameFile metadata: description: Renames video (scene) file names when the user edits the [Title] field located in the scene [Edit] tab. -version: 0.4.0 +version: 0.4.1 date: "2024-07-26 08:00:00" requires: [pip install stashapp-tools, pip install pyYAML] source_repository: https://github.com/David-Maisonave/Axter-Stash/tree/main/plugins/RenameFile diff --git a/plugins/RenameFile/renamefile.py b/plugins/RenameFile/renamefile.py index d67ef44..fe4eed5 100644 --- a/plugins/RenameFile/renamefile.py +++ b/plugins/RenameFile/renamefile.py @@ -1,50 +1,62 @@ -# This is a Stash plugin which allows users to rename the video (scene) file name by editing the [Title] field located in the scene [Edit] tab. -# By David Maisonave (aka Axter) Jul-2024 +# Description: This is a Stash plugin which allows users to rename the video (scene) file name by editing the [Title] field located in the scene [Edit] tab. +# 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/RenameFile # Based on source code from https://github.com/Serechops/Serechops-Stash/tree/main/plugins/Renamer - -import requests import os -import logging -import stashapi.log as log # Importing stashapi.log as log for critical events ONLY +import sys import shutil -from pathlib import Path import hashlib import json -import sys -from stashapi.stashapp import StashInterface +from pathlib import Path +import requests +import logging from logging.handlers import RotatingFileHandler -# Import settings from renamefile_settings.py -from renamefile_settings import config +import stashapi.log as log # Importing stashapi.log as log for critical events ONLY +from stashapi.stashapp import StashInterface +from renamefile_settings import config # Import settings from renamefile_settings.py -# Get the directory of the script -script_dir = Path(__file__).resolve().parent - -# Configure logging for this script with max log file size -log_file_path = script_dir / 'renamefile.log' -rfh = RotatingFileHandler( - filename=log_file_path, - mode='a', - maxBytes=2*1024*1024, - backupCount=2, - encoding=None, - delay=0 -) +# ********************************************************************** +# Constant global variables -------------------------------------------- +SCRIPT_DIR = Path(__file__).resolve().parent # Get the directory of the script +LOG_FILE_PATH = SCRIPT_DIR / 'renamefile.log' FORMAT = "[%(asctime)s - LN:%(lineno)s] %(message)s" -logging.basicConfig(level=logging.INFO, format=FORMAT, datefmt="%y%m%d %H:%M:%S", handlers=[rfh]) -logger = logging.getLogger('renamefile') 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 DEFAULT_SEPERATOR = "-" PLUGIN_ARGS = False -errOccurred = False +PLUGIN_ARGS_MODE = False +WRAPPER_STYLES = config["wrapper_styles"] +POSTFIX_STYLES = config["postfix_styles"] +# GraphQL query to fetch all scenes +QUERY_ALL_SCENES = """ + query AllScenes { + allScenes { + id + updated_at + } + } +""" +RFH = RotatingFileHandler( + filename=LOG_FILE_PATH, + mode='a', + maxBytes=2*1024*1024, # Configure logging for this script with max log file size of 2000K + backupCount=2, + encoding=None, + delay=0 +) + +# ********************************************************************** +# Global variables -------------------------------------------- inputToUpdateScenePost = False 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') -# ------------------------------------------ -# ------------------------------------------ -# Code to fetch variables from Plugin UI +# ********************************************************************** +# ---------------------------------------------------------------------- +# Code section to fetch variables from Plugin UI and from renamefile_settings.py json_input = json.loads(sys.stdin.read()) FRAGMENT_SERVER = json_input["server_connection"] stash = StashInterface(FRAGMENT_SERVER) @@ -66,21 +78,22 @@ settings = { } if "renamefile" in pluginConfiguration: settings.update(pluginConfiguration["renamefile"]) -# ------------------------------------------ +# ---------------------------------------------------------------------- debugTracing = settings["zzdebugTracing"] # Extract dry_run setting from settings dry_run = settings["zzdryRun"] dry_run_prefix = '' try: - PLUGIN_ARGS = json_input['args']["mode"] + PLUGIN_ARGS = json_input['args'] + PLUGIN_ARGS_MODE = json_input['args']["mode"] except: pass try: - if json_input['args']['hookContext']['input']: inputToUpdateScenePost = True # This avoid calling rename logic twice + if json_input['args']['hookContext']['input']: inputToUpdateScenePost = True # This avoids calling rename logic twice except: pass -logger.info(f"\nStarting (debugTracing={debugTracing}) (dry_run={dry_run}) (PLUGIN_ARGS={PLUGIN_ARGS}) (inputToUpdateScenePost={inputToUpdateScenePost})************************************************") +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 dry_run: logger.info("Dry run mode is enabled.") @@ -97,10 +110,11 @@ tag_whitelist = settings["ztagWhitelist"] if debugTracing: logger.info("Debug Tracing................") if not tag_whitelist: tag_whitelist = "" +if debugTracing: logger.info(f"Debug Tracing (tag_whitelist={tag_whitelist})................") endpoint = settings["zgraphqlEndpoint"] # GraphQL endpoint -if debugTracing: logger.info("Debug Tracing................") if not endpoint or endpoint == "": endpoint = DEFAULT_ENDPOINT +if debugTracing: logger.info(f"Debug Tracing (endpoint={endpoint})................") # Extract rename_files and move_files settings from renamefile_settings.py rename_files = config["rename_files"] move_files = settings["zafileRenameViaMove"] @@ -113,29 +127,11 @@ fieldKeyList = fieldKeyList.replace(";", ",") fieldKeyList = fieldKeyList.split(",") if debugTracing: logger.info(f"Debug Tracing (fieldKeyList={fieldKeyList})................") separator = settings["zseparators"] -# ------------------------------------------ -# ------------------------------------------ +# ---------------------------------------------------------------------- +# ********************************************************************** + double_separator = separator + separator - -# Extract styles from config -wrapper_styles = config["wrapper_styles"] -postfix_styles = config["postfix_styles"] - -try: - if debugTracing: logger.info(f"Debug Tracing (json_input['args']={json_input['args']})................") -except: - pass - -# GraphQL query to fetch all scenes -query_all_scenes = """ - query AllScenes { - allScenes { - id - updated_at - } - } -""" -if debugTracing: logger.info("Debug Tracing................") +if debugTracing: logger.info(f"Debug Tracing (PLUGIN_ARGS={PLUGIN_ARGS}) (WRAPPER_STYLES={WRAPPER_STYLES}) (POSTFIX_STYLES={POSTFIX_STYLES})................") # Function to make GraphQL requests def graphql_request(query, variables=None): @@ -193,8 +189,8 @@ def form_filename(original_file_stem, scene_details): # Check if the tag name is in the whitelist if tag_whitelist == "" or tag_whitelist == None or (tag_whitelist and tag_name in tag_whitelist): - if wrapper_styles.get('tag'): - filename_parts.append(f"{wrapper_styles['tag'][0]}{tag_name}{wrapper_styles['tag'][1]}") + if WRAPPER_STYLES.get('tag'): + filename_parts.append(f"{WRAPPER_STYLES['tag'][0]}{tag_name}{WRAPPER_STYLES['tag'][1]}") if debugTracing: logger.info("Debug Tracing................") else: filename_parts.append(tag_name) @@ -215,81 +211,81 @@ def form_filename(original_file_stem, scene_details): studio_name = scene_details.get('studio', {}).get('name', '') if debugTracing: logger.info(f"Debug Tracing (studio_name={studio_name})................") if studio_name: - studio_name += postfix_styles.get('studio') + studio_name += POSTFIX_STYLES.get('studio') if debugTracing: logger.info("Debug Tracing................") if include_keyField_if_in_name or studio_name.lower() not in title.lower(): - if wrapper_styles.get('studio'): - filename_parts.append(f"{wrapper_styles['studio'][0]}{studio_name}{wrapper_styles['studio'][1]}") + if WRAPPER_STYLES.get('studio'): + filename_parts.append(f"{WRAPPER_STYLES['studio'][0]}{studio_name}{WRAPPER_STYLES['studio'][1]}") else: filename_parts.append(studio_name) elif key == 'title': if title: # This value has already been fetch in start of function because it needs to be defined before tags and performers - title += postfix_styles.get('title') - if wrapper_styles.get('title'): - filename_parts.append(f"{wrapper_styles['title'][0]}{title}{wrapper_styles['title'][1]}") + title += POSTFIX_STYLES.get('title') + if WRAPPER_STYLES.get('title'): + filename_parts.append(f"{WRAPPER_STYLES['title'][0]}{title}{WRAPPER_STYLES['title'][1]}") else: filename_parts.append(title) elif key == 'performers': if settings["performerAppend"]: performers = '-'.join([performer.get('name', '') for performer in scene_details.get('performers', [])]) if performers: - performers += postfix_styles.get('performers') + performers += POSTFIX_STYLES.get('performers') if debugTracing: logger.info(f"Debug Tracing (include_keyField_if_in_name={include_keyField_if_in_name})................") if include_keyField_if_in_name or performers.lower() not in title.lower(): if debugTracing: logger.info(f"Debug Tracing (performers={performers})................") - if wrapper_styles.get('performers'): - filename_parts.append(f"{wrapper_styles['performers'][0]}{performers}{wrapper_styles['performers'][1]}") + if WRAPPER_STYLES.get('performers'): + filename_parts.append(f"{WRAPPER_STYLES['performers'][0]}{performers}{WRAPPER_STYLES['performers'][1]}") else: filename_parts.append(performers) elif key == 'date': scene_date = scene_details.get('date', '') if debugTracing: logger.info("Debug Tracing................") if scene_date: - scene_date += postfix_styles.get('date') + scene_date += POSTFIX_STYLES.get('date') if debugTracing: logger.info("Debug Tracing................") - if wrapper_styles.get('date'): - filename_parts.append(f"{wrapper_styles['date'][0]}{scene_date}{wrapper_styles['date'][1]}") + if WRAPPER_STYLES.get('date'): + filename_parts.append(f"{WRAPPER_STYLES['date'][0]}{scene_date}{WRAPPER_STYLES['date'][1]}") else: filename_parts.append(scene_date) elif key == 'resolution': width = str(scene_details.get('files', [{}])[0].get('width', '')) # Convert width to string height = str(scene_details.get('files', [{}])[0].get('height', '')) # Convert height to string if width and height: - resolution = width + postfix_styles.get('width_height_seperator') + height + postfix_styles.get('resolution') - if wrapper_styles.get('resolution'): - filename_parts.append(f"{wrapper_styles['resolution'][0]}{resolution}{wrapper_styles['width'][1]}") + resolution = width + POSTFIX_STYLES.get('width_height_seperator') + height + POSTFIX_STYLES.get('resolution') + if WRAPPER_STYLES.get('resolution'): + filename_parts.append(f"{WRAPPER_STYLES['resolution'][0]}{resolution}{WRAPPER_STYLES['width'][1]}") else: filename_parts.append(resolution) elif key == 'width': width = str(scene_details.get('files', [{}])[0].get('width', '')) # Convert width to string if width: - width += postfix_styles.get('width') - if wrapper_styles.get('width'): - filename_parts.append(f"{wrapper_styles['width'][0]}{width}{wrapper_styles['width'][1]}") + width += POSTFIX_STYLES.get('width') + if WRAPPER_STYLES.get('width'): + filename_parts.append(f"{WRAPPER_STYLES['width'][0]}{width}{WRAPPER_STYLES['width'][1]}") else: filename_parts.append(width) elif key == 'height': height = str(scene_details.get('files', [{}])[0].get('height', '')) # Convert height to string if height: - height += postfix_styles.get('height') - if wrapper_styles.get('height'): - filename_parts.append(f"{wrapper_styles['height'][0]}{height}{wrapper_styles['height'][1]}") + height += POSTFIX_STYLES.get('height') + if WRAPPER_STYLES.get('height'): + filename_parts.append(f"{WRAPPER_STYLES['height'][0]}{height}{WRAPPER_STYLES['height'][1]}") else: filename_parts.append(height) elif key == 'video_codec': video_codec = scene_details.get('files', [{}])[0].get('video_codec', '').upper() # Convert to uppercase if video_codec: - video_codec += postfix_styles.get('video_codec') - if wrapper_styles.get('video_codec'): - filename_parts.append(f"{wrapper_styles['video_codec'][0]}{video_codec}{wrapper_styles['video_codec'][1]}") + video_codec += POSTFIX_STYLES.get('video_codec') + if WRAPPER_STYLES.get('video_codec'): + filename_parts.append(f"{WRAPPER_STYLES['video_codec'][0]}{video_codec}{WRAPPER_STYLES['video_codec'][1]}") else: filename_parts.append(video_codec) elif key == 'frame_rate': frame_rate = str(scene_details.get('files', [{}])[0].get('frame_rate', '')) + 'FPS' # Convert to string and append ' FPS' if frame_rate: - frame_rate += postfix_styles.get('frame_rate') - if wrapper_styles.get('frame_rate'): - filename_parts.append(f"{wrapper_styles['frame_rate'][0]}{frame_rate}{wrapper_styles['frame_rate'][1]}") + frame_rate += POSTFIX_STYLES.get('frame_rate') + if WRAPPER_STYLES.get('frame_rate'): + filename_parts.append(f"{WRAPPER_STYLES['frame_rate'][0]}{frame_rate}{WRAPPER_STYLES['frame_rate'][1]}") else: filename_parts.append(frame_rate) elif key == 'galleries': @@ -298,9 +294,9 @@ def form_filename(original_file_stem, scene_details): for gallery_name in galleries: if debugTracing: logger.info(f"Debug Tracing (include_keyField_if_in_name={include_keyField_if_in_name}) (gallery_name={gallery_name})................") if include_keyField_if_in_name or gallery_name.lower() not in title.lower(): - gallery_name += postfix_styles.get('galleries') - if wrapper_styles.get('galleries'): - filename_parts.append(f"{wrapper_styles['galleries'][0]}{gallery_name}{wrapper_styles['galleries'][1]}") + gallery_name += POSTFIX_STYLES.get('galleries') + if WRAPPER_STYLES.get('galleries'): + filename_parts.append(f"{WRAPPER_STYLES['galleries'][0]}{gallery_name}{WRAPPER_STYLES['galleries'][1]}") if debugTracing: logger.info("Debug Tracing................") else: filename_parts.append(gallery_name) @@ -314,7 +310,7 @@ def form_filename(original_file_stem, scene_details): for tag_name in tags: if debugTracing: logger.info(f"Debug Tracing (include_keyField_if_in_name={include_keyField_if_in_name}) (tag_name={tag_name})................") if include_keyField_if_in_name or tag_name.lower() not in title.lower(): - add_tag(tag_name + postfix_styles.get('tag')) + add_tag(tag_name + POSTFIX_STYLES.get('tag')) if debugTracing: logger.info(f"Debug Tracing (tag_name={tag_name})................") if debugTracing: logger.info("Debug Tracing................") @@ -408,7 +404,6 @@ def move_or_rename_files(scene_details, new_filename, original_parent_directory) logger.error(f"Failed to move or rename file: {path}. Error: {e}") exitMsg = "Failed to move or rename file" continue - return new_path # Return the new_path variable after the loop def perform_metadata_scan(metadata_scan_path): @@ -499,10 +494,9 @@ def rename_scene(scene_id, stash_directory): # Main default function for rename scene def rename_files_task(): - global exitMsg if debugTracing: logger.info("Debug Tracing................") # Execute the GraphQL query to fetch all scenes - scene_result = graphql_request(query_all_scenes) + scene_result = graphql_request(QUERY_ALL_SCENES) if debugTracing: logger.info("Debug Tracing................") all_scenes = scene_result.get('data', {}).get('allScenes', []) if debugTracing: logger.info("Debug Tracing................") @@ -523,8 +517,6 @@ def rename_files_task(): stash_directory = config.get('stash_directory', '') if debugTracing: logger.info("Debug Tracing................") - if debugTracing: logger.info("Debug Tracing................") - # Rename the latest scene and trigger metadata scan new_filename = rename_scene(latest_scene_id, stash_directory) if debugTracing: logger.info(f"Debug Tracing (exitMsg={exitMsg})................") @@ -542,16 +534,15 @@ def rename_files_task(): def fetch_dup_filename_tags(): # Place holder for new implementation return -if PLUGIN_ARGS == "fetch_dup_filename_tags": +if PLUGIN_ARGS_MODE == "fetch_dup_filename_tags": fetch_dup_filename_tags() -elif PLUGIN_ARGS == "rename_files_task": +elif PLUGIN_ARGS_MODE == "rename_files_task": rename_files_task() elif inputToUpdateScenePost: rename_files_task() if debugTracing: logger.info("\n*********************************\nEXITING ***********************\n*********************************") - -# ToDo List +# ToDo: Wish List # Add logic to update Sqlite DB on file name change, instead of perform_metadata_scan. # Add code to get tags from duplicate filenames \ No newline at end of file diff --git a/plugins/RenameFile/renamefile.yml b/plugins/RenameFile/renamefile.yml index 14006c3..e9a0fd9 100644 --- a/plugins/RenameFile/renamefile.yml +++ b/plugins/RenameFile/renamefile.yml @@ -1,7 +1,7 @@ name: RenameFile description: Renames video (scene) file names when the user edits the [Title] field located in the scene [Edit] tab. # By David Maisonave (aka Axter) 2024 -version: 0.4.0 +version: 0.4.1 url: https://github.com/David-Maisonave/Axter-Stash/tree/main/plugins/RenameFile settings: performerAppend: