Merge fe85144471 into 4580ca0bc6

Add utility/save_posters.py

utility/add_label_by_filepaths.pyw

@@ -0,0 +1,87 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+'''
+Description: Automatically add a label to recently added items in 
+                your Plex library, based on a list of tags and if the 
+                media's filepath contains one of those tags an assigns the label dynamically.
+Author:    DaTurkeyslayer + SwiftPanda16 + Blacktwin
+Requires:   plexapi
+Usage:
+  python add_label_recently_added.py --rating_key 1234 --tags 'John,Jane,Alice,4K'
+
+Tautulli script trigger:
+  * Notify on recently added
+Tautulli script conditions:
+  * Filter which media to add labels to using conditions. Examples:
+    [ Media Type | is | movie ]
+    [ Show Name | is | Game of Thrones ]
+    [ Album Name | is | Reputation ]
+    [ Video Resolution | is | 4k ]
+    [ Genre | contains | horror ]
+Tautulli script arguments:
+  * Recently Added:
+    --rating_key {rating_key} --tagsList John,Jane,Alice
+'''
+
+import argparse
+import os
+import plexapi
+from plexapi.server import PlexServer
+
+# ## OVERRIDES - ONLY EDIT IF RUNNING SCRIPT WITHOUT TAUTULLI ##
+
+PLEX_URL = ''
+PLEX_TOKEN = ''
+
+# Environmental Variables
+PLEX_URL = PLEX_URL or os.getenv('PLEX_URL', PLEX_URL)
+PLEX_TOKEN = PLEX_TOKEN or os.getenv('PLEX_TOKEN', PLEX_TOKEN)
+
+def add_label_parent(plex, rating_key, tags):
+    item = plex.fetchItem(rating_key)
+
+    if item.type in ('movie', 'show', 'album'):
+        mediaRecord = item
+    elif item.type in ('episode'):
+        mediaRecord = item.show()
+    elif item.type == 'track':
+        mediaRecord = item.album()
+    else:
+        print(f"Cannot add label to '{item.title}' ({item.ratingKey}): Invalid media type '{item.type}'")
+        return
+
+    # Get all of the items filepaths and save them to a list
+    filepaths = item.locations
+    
+    # Loop through each filepath for the item 
+    for filepath in filepaths:
+        # Loop through each tag to check if it is in the current filepath
+        for tag in tags:
+            # Check if the tag is in the filepath
+            if tag.lower() in filepath.lower():
+                # Use the found tag to dynamically assign the label
+                dynamic_label = tag + "'s"
+                
+                # Check if the label already exists
+                existing_labels = [label.tag for label in mediaRecord.labels]
+                
+                if dynamic_label not in existing_labels:
+                    # Create the label if it doesn't exist
+                    mediaRecord.addLabel(dynamic_label)
+                    print(f"Adding label '{dynamic_label}' to '{mediaRecord.title}' ({mediaRecord.ratingKey})")
+    else:
+        print(f"No matching tag found in any of the file paths for '{mediaRecord.title}' ({mediaRecord.ratingKey})")
+    
+
+if __name__ == '__main__':
+    parser = argparse.ArgumentParser()
+    parser.add_argument('--rating_key', required=True, type=int)
+    parser.add_argument('--tagsList', type=str, required=True, help='Comma-separated list of tags')
+    opts = parser.parse_args()
+
+    # Parse comma-separated tags
+    tags = [tag.strip() for tag in opts.tagsList.split(',')] if opts.tagsList else []
+
+    plex = PlexServer(PLEX_URL, PLEX_TOKEN)
+    add_label_parent(plex, opts.rating_key, tags)

utility/save_posters.py

@@ -0,0 +1,121 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+'''
+Description:  Saves poster and art images from Plex to same folder as the media files.
+Author:       /u/SwiftPanda16
+Requires:     plexapi, tqdm (optional)
+Usage:
+    * Save posters for an entire library:
+        python save_posters.py --library "TV Shows" --poster
+
+    * Save art for an entire library:
+        python save_posters.py --library "Music" --art
+
+    * Save posters and art for an entire library:
+        python save_posters.py --library "Movies" --poster --art
+
+    * Save posters and art for a specific media type in a library:
+        python save_posters.py --library "TV Shows" --libtype season --poster --art
+
+    * Save posters for a specific item:
+        python save_posters.py --rating_key 1234 --poster
+
+    * Save art for a specific item:
+        python save_posters.py --rating_key 1234 --art
+
+    * Save posters and art for a specific item:
+        python save_posters.py --rating_key 1234 --poster --art
+'''
+
+import argparse
+from pathlib import Path
+from plexapi.server import PlexServer
+from plexapi.utils import download
+
+
+PLEX_URL = 'http://localhost:32400'
+PLEX_TOKEN = 'XXXXXXXXXXXXXXXXXXXX'
+# Specify the mapped docker folder paths {host: container}. Leave blank {} if non-docker.
+MAPPED_FOLDERS = {
+    '/mnt/movies': '/movies',
+    '/mnt/tvshows': '/tv',
+}
+
+_MAPPED_FOLDERS = {Path(host): Path(container) for host, container in MAPPED_FOLDERS.items()}
+
+
+def map_path(file_path):
+    for host, container in _MAPPED_FOLDERS.items():
+        if container in file_path.parents:
+            return host / file_path.relative_to(container)
+    return file_path
+
+
+def save_library(library, libtype=None, poster=False, art=False):
+    for item in library.all(libtype=libtype, includeGuids=False):
+        save_item(item, poster=poster, art=art)
+
+
+def save_item(item, poster=False, art=False):
+    if hasattr(item, 'locations'):
+        file_path = Path(item.locations[0])
+    else:
+        file_path = Path(next(iter(item)).locations[0])
+    save_path = map_path(file_path)
+    if save_path.is_file():
+        save_path = save_path.parent
+
+    if poster:
+        save_item_poster(item, save_path)
+    if art:
+        save_item_art(item, save_path)
+
+
+def save_item_poster(item, save_path):
+    print(f"Downloading poster for {item.title} to {save_path}")
+    try:
+        download(
+            url=item.posterUrl,
+            token=plex._token,
+            filename='poster.jpg',
+            savepath=save_path,
+            showstatus=True  # Requires `tqdm` package
+        )
+    except Exception as e:
+        print(f"Failed to download poster for {item.title}: {e}")
+
+
+def save_item_art(item, save_path):
+    print(f"Downloading art for {item.title} to {save_path}")
+    try:
+        download(
+            url=item.artUrl,
+            token=plex._token,
+            filename='background.jpg',
+            savepath=save_path,
+            showstatus=True  # Requires `tqdm` package
+        )
+    except Exception as e:
+        print(f"Failed to download art for {item.title}: {e}")
+
+
+if __name__ == '__main__':
+    parser = argparse.ArgumentParser()
+    parser.add_argument('--rating_key', type=int)
+    parser.add_argument('--library')
+    parser.add_argument('--libtype', choices=['movie', 'show', 'season', 'artist', 'album'])
+    parser.add_argument('--poster', action='store_true')
+    parser.add_argument('--art', action='store_true')
+    opts = parser.parse_args()
+
+    plex = PlexServer(PLEX_URL, PLEX_TOKEN)
+
+    if opts.rating_key:
+        item = plex.fetchItem(opts.rating_key)
+        save_item(item, opts.poster, opts.art)
+    elif opts.library:
+        library = plex.library.section(opts.library)
+        save_library(library, opts.libtype, opts.poster, opts.art)
+    else:
+        print("No --rating_key or --library specified. Exiting.")

utility/select_tmdb_poster.py

@@ -2,19 +2,34 @@
 # -*- coding: utf-8 -*-
 
 '''
-Description:  Selects the default TMDB poster if no poster is selected
+Description:  Selects the default TMDB poster and art for items in a Plex library
-              or the current poster is from Gracenote.
+              if no poster/art is selected or the current poster/art is from Gracenote.
 Author:       /u/SwiftPanda16
 Requires:     plexapi
 Usage:
     * Change the posters for an entire library:
-        python select_tmdb_poster.py --library "Movies"
+        python select_tmdb_poster.py --library "Movies" --poster
+
+    * Change the art for an entire library:
+        python select_tmdb_poster.py --library "Movies" --art
+
+    * Change the posters and art for an entire library:
+        python select_tmdb_poster.py --library "Movies" --poster --art
 
     * Change the poster for a specific item:
-        python select_tmdb_poster.py --rating_key 1234
+        python select_tmdb_poster.py --rating_key 1234 --poster
+
+    * Change the art for a specific item:
+        python select_tmdb_poster.py --rating_key 1234 --art
+
+    * Change the poster and art for a specific item:
+        python select_tmdb_poster.py --rating_key 1234 --poster --art
 
     * By default locked posters are skipped. To update locked posters:
-        python select_tmdb_poster.py --library "Movies" --include_locked
+        python select_tmdb_poster.py --library "Movies" --include_locked --poster --art
+
+    * To override the preferred provider:
+        python select_tmdb_poster.py --library "Movies" --art --art_provider "fanarttv"
 
 Tautulli script trigger:
     * Notify on recently added
@@ -23,7 +38,7 @@ Tautulli script conditions:
         [ Media Type | is | movie ]
 Tautulli script arguments:
     * Recently Added:
-        --rating_key {rating_key}
+        --rating_key {rating_key} --poster --art
 '''
 
 import argparse
@@ -33,6 +48,15 @@ from plexapi.server import PlexServer
 plexapi.base.USER_DONT_RELOAD_FOR_KEYS.add('fields')
 
 
+# Poster and art providers to replace
+REPLACE_PROVIDERS = ['gracenote', 'plex', None]
+
+# Preferred poster and art provider to use (Note not all providers are availble for all items)
+# Possible options: tmdb, tvdb, imdb, fanarttv, gracenote, plex
+PREFERRED_POSTER_PROVIDER = 'tmdb'
+PREFERRED_ART_PROVIDER = 'tmdb'
+
+
 # ## OVERRIDES - ONLY EDIT IF RUNNING SCRIPT WITHOUT TAUTULLI ##
 
 PLEX_URL = ''
@@ -43,49 +67,114 @@ PLEX_URL = PLEX_URL or os.getenv('PLEX_URL', PLEX_URL)
 PLEX_TOKEN = PLEX_TOKEN or os.getenv('PLEX_TOKEN', PLEX_TOKEN)
 
 
-def select_tmdb_poster_library(library, include_locked=False):
+def select_library(
+    library,
+    include_locked=False,
+    poster=False,
+    poster_provider=PREFERRED_POSTER_PROVIDER,
+    art=False,
+    art_provider=PREFERRED_ART_PROVIDER
+):
     for item in library.all(includeGuids=False):
         # Only reload for fields
         item.reload(**{k: 0 for k, v in item._INCLUDES.items()})
-        select_tmdb_poster_item(item, include_locked=include_locked)
+        select_item(
+            item,
+            include_locked=include_locked,
+            poster=poster,
+            poster_provider=poster_provider,
+            art=art,
+            art_provider=art_provider
+        )
 
 
-def select_tmdb_poster_item(item, include_locked=False):
+def select_item(
-    if item.isLocked('thumb') and not include_locked:
+    item,
-        print(f"Locked poster for {item.title}. Skipping.")
+    include_locked=False,
+    poster=False,
+    poster_provider=PREFERRED_POSTER_PROVIDER,
+    art=False,
+    art_provider=PREFERRED_ART_PROVIDER
+):
+    print(f"{item.title} ({item.year})")
+
+    if poster:
+        select_poster(item, include_locked, poster_provider)
+    if art:
+        select_art(item, include_locked, art_provider)
+
+
+def select_poster(item, include_locked=False, provider=PREFERRED_POSTER_PROVIDER):
+    print("  Checking poster...")
+
+    if item.isLocked('thumb') and not include_locked:  # PlexAPI 4.5.10
+        print(f"  - Locked poster for {item.title}. Skipping.")
         return
 
     posters = item.posters()
     selected_poster = next((p for p in posters if p.selected), None)
 
     if selected_poster is None:
-        print(f"WARNING: No poster selected for {item.title}.")
+        print(f"  - WARNING: No poster selected for {item.title}.")
     else:
-        skipping = ' Skipping.' if selected_poster.provider != 'gracenote' else ''
+        skip_poster = selected_poster.provider not in REPLACE_PROVIDERS
-        print(f"Poster provider is '{selected_poster.provider}' for {item.title}.{skipping}")
+        print(f"  - Poster provider is '{selected_poster.provider}' for {item.title}.")
 
-    if selected_poster is None or selected_poster.provider == 'gracenote':
+    if posters and (selected_poster is None or selected_poster.provider in REPLACE_PROVIDERS):
-        # Fallback to first poster if no TMDB posters are available
+        # Fallback to first poster if no preferred provider posters are available
-        tmdb_poster = next((p for p in posters if p.provider == 'tmdb'), posters[0])
+        provider_poster = next((p for p in posters if p.provider == provider), posters[0])
         # Selecting the poster automatically locks it
-        tmdb_poster.select()
+        provider_poster.select()
-        print(f"Selected {tmdb_poster.provider} poster for {item.title}.")
+        print(f"  - Selected and locked {provider_poster.provider} poster for {item.title}.")
+    elif skip_poster and selected_poster:
+        item.lockPoster()
+        print(f"  - Locked {selected_poster.provider} poster for {item.title}.")
 
 
+def select_art(item, include_locked=False, provider=PREFERRED_ART_PROVIDER):
+    print("  Checking art...")
+
+    if item.isLocked('art') and not include_locked:  # PlexAPI 4.5.10
+        print(f"  - Locked art for {item.title}. Skipping.")
+        return
+
+    arts = item.arts()
+    selected_art = next((p for p in arts if p.selected), None)
+
+    if selected_art is None:
+        print(f"  - WARNING: No art selected for {item.title}.")
+    else:
+        skip_art = selected_art.provider not in REPLACE_PROVIDERS
+        print(f"  - Art provider is '{selected_art.provider}' for {item.title}.")
+
+    if arts and (selected_art is None or selected_art.provider in REPLACE_PROVIDERS):
+        # Fallback to first art if no preferred provider arts are available
+        provider_art = next((p for p in arts if p.provider == provider), arts[0])
+        # Selecting the art automatically locks it
+        provider_art.select()
+        print(f"  - Selected and locked {provider_art.provider} art for {item.title}.")
+    elif skip_art and selected_art:
+        item.lockArt()
+        print(f"  - Locked {selected_art.provider} art for {item.title}.")
+
 if __name__ == '__main__':
     parser = argparse.ArgumentParser()
     parser.add_argument('--rating_key', type=int)
     parser.add_argument('--library')
     parser.add_argument('--include_locked', action='store_true')
+    parser.add_argument('--poster', action='store_true')
+    parser.add_argument('--poster_provider', default=PREFERRED_POSTER_PROVIDER)
+    parser.add_argument('--art', action='store_true')
+    parser.add_argument('--art_provider', default=PREFERRED_ART_PROVIDER)
     opts = parser.parse_args()
 
     plex = PlexServer(PLEX_URL, PLEX_TOKEN)
 
     if opts.rating_key:
         item = plex.fetchItem(opts.rating_key)
-        select_tmdb_poster_item(item, opts.include_locked)
+        select_item(item, opts.include_locked, opts.poster, opts.poster_provider, opts.art, opts.art_provider)
     elif opts.library:
         library = plex.library.section(opts.library)
-        select_tmdb_poster_library(library, opts.include_locked)
+        select_library(library, opts.include_locked, opts.poster, opts.poster_provider, opts.art, opts.art_provider)
     else:
         print("No --rating_key or --library specified. Exiting.")