Plex-Meta-Manager/modules/plex.py

828 lines
45 KiB
Python
Raw Normal View History

2021-02-24 06:42:58 +00:00
import logging, os, re, requests
from datetime import datetime, timedelta
2021-01-20 21:37:59 +00:00
from modules import util
from modules.util import Failed
from plexapi.exceptions import BadRequest, NotFound, Unauthorized
2021-02-28 01:18:05 +00:00
from plexapi.collection import Collections
2021-01-20 21:37:59 +00:00
from plexapi.server import PlexServer
from plexapi.video import Movie, Show
from retrying import retry
from ruamel import yaml
logger = logging.getLogger("Plex Meta Manager")
2021-04-08 00:20:06 +00:00
builders = ["plex_all", "plex_collection", "plex_collectionless", "plex_search"]
2021-03-30 05:50:53 +00:00
search_translation = {
"audio_language": "audioLanguage",
"content_rating": "contentRating",
"subtitle_language": "subtitleLanguage",
"added": "addedAt",
"originally_available": "originallyAvailableAt",
"audience_rating": "audienceRating",
"critic_rating": "rating",
"user_rating": "userRating"
2021-03-30 05:50:53 +00:00
}
episode_sorting_options = {"default": "-1", "oldest": "0", "newest": "1"}
keep_episodes_options = {"all": 0, "5_latest": 5, "3_latest": 3, "latest": 1, "past_3": -3, "past_7": -7, "past_30": -30}
delete_episodes_options = {"never": 0, "day": 1, "week": 7, "refresh": 100}
season_display_options = {"default": -1, "show": 0, "hide": 1}
episode_ordering_options = {"default": None, "tmdb_aired": "tmdbAiring", "tvdb_aired": "airing", "tvdb_dvd": "dvd", "tvdb_absolute": "absolute"}
plex_languages = ["default", "ar-SA", "ca-ES", "cs-CZ", "da-DK", "de-DE", "el-GR", "en-AU", "en-CA", "en-GB", "en-US",
"es-ES", "es-MX", "et-EE", "fa-IR", "fi-FI", "fr-CA", "fr-FR", "he-IL", "hi-IN", "hu-HU", "id-ID",
"it-IT", "ja-JP", "ko-KR", "lt-LT", "lv-LV", "nb-NO", "nl-NL", "pl-PL", "pt-BR", "pt-PT", "ro-RO",
"ru-RU", "sk-SK", "sv-SE", "th-TH", "tr-TR", "uk-UA", "vi-VN", "zh-CN", "zh-HK", "zh-TW"]
metadata_language_options = {lang.lower(): lang for lang in plex_languages}
metadata_language_options["default"] = None
2021-04-05 22:07:44 +00:00
use_original_title_options = {"default": -1, "no": 0, "yes": 1}
advance_keys = {
"episode_sorting": ("episodeSort", episode_sorting_options),
"keep_episodes": ("autoDeletionItemPolicyUnwatchedLibrary", keep_episodes_options),
"delete_episodes": ("autoDeletionItemPolicyWatchedLibrary", delete_episodes_options),
"season_display": ("flattenSeasons", season_display_options),
"episode_ordering": ("showOrdering", episode_ordering_options),
"metadata_language": ("languageOverride", metadata_language_options),
"use_original_title": ("useOriginalTitle", use_original_title_options)
}
item_advance_keys = {
"item_episode_sorting": ("episodeSort", episode_sorting_options),
"item_keep_episodes": ("autoDeletionItemPolicyUnwatchedLibrary", keep_episodes_options),
"item_delete_episodes": ("autoDeletionItemPolicyWatchedLibrary", delete_episodes_options),
"item_season_display": ("flattenSeasons", season_display_options),
"item_episode_ordering": ("showOrdering", episode_ordering_options),
"item_metadata_language": ("languageOverride", metadata_language_options),
"item_use_original_title": ("useOriginalTitle", use_original_title_options)
}
new_plex_agents = ["tv.plex.agents.movie", "tv.plex.agents.series"]
2021-03-30 05:50:53 +00:00
filter_alias = {
"actor": "actors",
2021-04-03 20:54:34 +00:00
"audience_rating": "audienceRating",
2021-03-30 05:50:53 +00:00
"collection": "collections",
"content_rating": "contentRating",
"country": "countries",
2021-04-03 20:54:34 +00:00
"critic_rating": "rating",
2021-03-30 05:50:53 +00:00
"director": "directors",
"genre": "genres",
"originally_available": "originallyAvailableAt",
"tmdb_vote_count": "vote_count",
"user_rating": "userRating",
2021-03-30 05:50:53 +00:00
"writer": "writers"
}
searches = [
"title", "title.and", "title.not", "title.begins", "title.ends",
"studio", "studio.and", "studio.not", "studio.begins", "studio.ends",
"actor", "actor.and", "actor.not",
"audio_language", "audio_language.and", "audio_language.not",
"collection", "collection.and", "collection.not",
"content_rating", "content_rating.and", "content_rating.not",
"country", "country.and", "country.not",
"director", "director.and", "director.not",
"genre", "genre.and", "genre.not",
"label", "label.and", "label.not",
2021-04-01 15:34:02 +00:00
"network", "network.and", "network.not",
2021-03-30 05:50:53 +00:00
"producer", "producer.and", "producer.not",
"subtitle_language", "subtitle_language.and", "subtitle_language.not",
"writer", "writer.and", "writer.not",
"decade", "resolution",
"added.before", "added.after",
"originally_available.before", "originally_available.after",
"duration.greater", "duration.less",
"user_rating.greater", "user_rating.less",
"audience_rating.greater", "audience_rating.less",
"critic_rating.greater", "critic_rating.less",
2021-03-30 05:50:53 +00:00
"year", "year.not", "year.greater", "year.less"
]
movie_only_searches = [
"audio_language", "audio_language.and", "audio_language.not",
"country", "country.and", "country.not",
"subtitle_language", "subtitle_language.and", "subtitle_language.not",
"decade", "resolution",
"originally_available.before", "originally_available.after",
"duration.greater", "duration.less"
]
2021-04-01 15:34:02 +00:00
show_only_searches = [
"network", "network.and", "network.not",
]
2021-03-30 05:50:53 +00:00
tmdb_searches = [
"actor", "actor.and", "actor.not",
"director", "director.and", "director.not",
"producer", "producer.and", "producer.not",
"writer", "writer.and", "writer.not"
]
sorts = {
None: None,
2021-03-30 05:50:53 +00:00
"title.asc": "titleSort:asc", "title.desc": "titleSort:desc",
"originally_available.asc": "originallyAvailableAt:asc", "originally_available.desc": "originallyAvailableAt:desc",
"critic_rating.asc": "rating:asc", "critic_rating.desc": "rating:desc",
"audience_rating.asc": "audienceRating:asc", "audience_rating.desc": "audienceRating:desc",
"duration.asc": "duration:asc", "duration.desc": "duration:desc",
"added.asc": "addedAt:asc", "added.desc": "addedAt:desc"
}
modifiers = {
".and": "&",
".not": "!",
".begins": "<",
".ends": ">",
".before": "<<",
".after": ">>",
".greater": ">>",
".less": "<<"
}
2021-01-20 21:37:59 +00:00
class PlexAPI:
2021-02-21 17:01:10 +00:00
def __init__(self, params, TMDb, TVDb):
2021-03-26 05:43:11 +00:00
try:
self.PlexServer = PlexServer(params["plex"]["url"], params["plex"]["token"], timeout=params["plex"]["timeout"])
except Unauthorized:
raise Failed("Plex Error: Plex token is invalid")
except ValueError as e:
raise Failed(f"Plex Error: {e}")
2021-02-24 06:42:58 +00:00
except requests.exceptions.ConnectionError:
2021-01-20 21:37:59 +00:00
util.print_stacktrace()
raise Failed("Plex Error: Plex url is invalid")
2021-04-16 18:27:39 +00:00
self.Plex = next((s for s in self.PlexServer.library.sections() if s.title == params["name"]), None)
2021-03-26 05:43:11 +00:00
if not self.Plex:
raise Failed(f"Plex Error: Plex Library {params['name']} not found")
if self.Plex.type not in ["movie", "show"]:
raise Failed(f"Plex Error: Plex Library must be a Movies or TV Shows library")
2021-03-31 04:20:20 +00:00
self.agent = self.Plex.agent
2021-04-16 18:27:39 +00:00
self.is_movie = self.Plex.type == "movie"
self.is_show = self.Plex.type == "show"
2021-03-31 00:33:08 +00:00
logger.info(f"Using Metadata File: {params['metadata_path']}")
2021-03-26 05:43:11 +00:00
try:
self.data, ind, bsi = yaml.util.load_yaml_guess_indent(open(params["metadata_path"], encoding="utf-8"))
2021-03-30 05:49:10 +00:00
except yaml.scanner.ScannerError as ye:
raise Failed(f"YAML Error: {util.tab_new_lines(ye)}")
except Exception as e:
util.print_stacktrace()
raise Failed(f"YAML Error: {e}")
2021-01-20 21:37:59 +00:00
2021-02-20 05:41:45 +00:00
def get_dict(attribute):
if attribute in self.data:
if self.data[attribute]:
2021-03-26 05:43:11 +00:00
if isinstance(self.data[attribute], dict):
return self.data[attribute]
else:
logger.warning(f"Config Warning: {attribute} must be a dictionary")
else:
logger.warning(f"Config Warning: {attribute} attribute is blank")
2021-02-20 05:41:45 +00:00
return None
self.metadata = get_dict("metadata")
self.templates = get_dict("templates")
self.collections = get_dict("collections")
2021-01-20 21:37:59 +00:00
if self.metadata is None and self.collections is None:
raise Failed("YAML Error: metadata attributes or collections attribute required")
if params["asset_directory"]:
2021-02-21 08:13:07 +00:00
for ad in params["asset_directory"]:
2021-02-24 06:44:06 +00:00
logger.info(f"Using Asset Directory: {ad}")
2021-01-20 21:37:59 +00:00
2021-02-21 08:13:07 +00:00
self.TMDb = TMDb
self.TVDb = TVDb
2021-02-21 17:01:10 +00:00
self.Radarr = None
self.Sonarr = None
self.Tautulli = None
2021-01-20 21:37:59 +00:00
self.name = params["name"]
2021-02-24 06:44:06 +00:00
self.missing_path = os.path.join(os.path.dirname(os.path.abspath(params["metadata_path"])), f"{os.path.splitext(os.path.basename(params['metadata_path']))[0]}_missing.yml")
2021-01-20 21:37:59 +00:00
self.metadata_path = params["metadata_path"]
self.asset_directory = params["asset_directory"]
self.asset_folders = params["asset_folders"]
self.assets_for_all = params["assets_for_all"]
2021-01-20 21:37:59 +00:00
self.sync_mode = params["sync_mode"]
self.show_unmanaged = params["show_unmanaged"]
self.show_filtered = params["show_filtered"]
2021-02-20 06:41:40 +00:00
self.show_missing = params["show_missing"]
self.save_missing = params["save_missing"]
2021-03-05 16:04:28 +00:00
self.mass_genre_update = params["mass_genre_update"]
2021-01-20 21:37:59 +00:00
self.plex = params["plex"]
self.url = params["plex"]["url"]
self.token = params["plex"]["token"]
2021-02-22 01:56:31 +00:00
self.timeout = params["plex"]["timeout"]
2021-02-16 21:51:38 +00:00
self.missing = {}
2021-03-01 20:59:10 +00:00
self.run_again = []
2021-01-20 21:37:59 +00:00
2021-04-08 20:10:26 +00:00
def get_all_collections(self):
return self.search(libtype="collection")
2021-01-20 21:37:59 +00:00
@retry(stop_max_attempt_number=6, wait_fixed=10000)
2021-04-08 20:10:26 +00:00
def search(self, title=None, libtype=None, sort=None, maxresults=None, **kwargs):
return self.Plex.search(title=title, sort=sort, maxresults=maxresults, libtype=libtype, **kwargs)
2021-01-20 21:37:59 +00:00
@retry(stop_max_attempt_number=6, wait_fixed=10000)
def fetchItem(self, data):
return self.PlexServer.fetchItem(data)
2021-04-08 20:10:26 +00:00
@retry(stop_max_attempt_number=6, wait_fixed=10000)
def get_all(self):
return self.Plex.all()
2021-01-20 21:37:59 +00:00
@retry(stop_max_attempt_number=6, wait_fixed=10000)
def server_search(self, data):
return self.PlexServer.search(data)
2021-04-08 20:10:26 +00:00
@retry(stop_max_attempt_number=6, wait_fixed=10000)
def add_collection(self, item, name):
item.addCollection(name)
@retry(stop_max_attempt_number=6, wait_fixed=10000, retry_on_exception=util.retry_if_not_failed)
2021-04-18 15:36:43 +00:00
def get_search_choices(self, search_name):
2021-04-01 15:34:02 +00:00
try:
2021-04-18 15:36:43 +00:00
choices = {}
for choice in self.Plex.listFilterChoices(search_name):
choices[choice.title.lower()] = choice.title
choices[choice.key.lower()] = choice.title
return choices
2021-04-01 15:34:02 +00:00
except NotFound:
raise Failed(f"Collection Error: plex search attribute: {search_name} only supported with Plex's New TV Agent")
2021-03-26 05:43:11 +00:00
@retry(stop_max_attempt_number=6, wait_fixed=10000)
def refresh_item(self, rating_key):
requests.put(f"{self.url}/library/metadata/{rating_key}/refresh?X-Plex-Token={self.token}")
2021-03-26 05:43:11 +00:00
def validate_search_list(self, data, search_name):
2021-03-30 05:50:53 +00:00
final_search = search_translation[search_name] if search_name in search_translation else search_name
2021-04-18 15:36:43 +00:00
search_choices = self.get_search_choices(final_search)
2021-03-26 05:43:11 +00:00
valid_list = []
for value in util.get_list(data):
2021-03-26 22:17:24 +00:00
if str(value).lower() in search_choices:
valid_list.append(search_choices[str(value).lower()])
2021-03-26 05:43:11 +00:00
else:
2021-03-30 20:50:34 +00:00
logger.error(f"Plex Error: {search_name}: {value} not found")
2021-03-26 05:43:11 +00:00
return valid_list
2021-01-20 21:37:59 +00:00
def get_collection(self, data):
2021-04-12 04:00:03 +00:00
collection = util.choose_from_list(self.search(title=str(data), libtype="collection"), "collection", str(data), exact=True)
2021-01-20 21:37:59 +00:00
if collection: return collection
2021-02-24 06:44:06 +00:00
else: raise Failed(f"Plex Error: Collection {data} not found")
2021-01-20 21:37:59 +00:00
def validate_collections(self, collections):
valid_collections = []
for collection in collections:
try: valid_collections.append(self.get_collection(collection))
except Failed as e: logger.error(e)
if len(valid_collections) == 0:
2021-02-24 06:44:06 +00:00
raise Failed(f"Collection Error: No valid Plex Collections in {collections}")
2021-01-20 21:37:59 +00:00
return valid_collections
def get_items(self, method, data, status_message=True):
if status_message:
logger.debug(f"Data: {data}")
pretty = util.pretty_names[method] if method in util.pretty_names else method
media_type = "Movie" if self.is_movie else "Show"
items = []
if method == "plex_all":
if status_message:
logger.info(f"Processing {pretty} {media_type}s")
2021-04-08 20:10:26 +00:00
items = self.get_all()
elif method == "plex_collection":
if status_message:
logger.info(f"Processing {pretty} {data}")
items = data.items()
elif method == "plex_search":
search_terms = {}
has_processed = False
search_limit = None
search_sort = None
for search_method, search_data in data.items():
if search_method == "limit":
search_limit = search_data
elif search_method == "sort_by":
search_sort = search_data
else:
search, modifier = os.path.splitext(str(search_method).lower())
final_search = search_translation[search] if search in search_translation else search
if search in ["added", "originally_available"] and modifier == "":
final_mod = ">>"
elif search in ["added", "originally_available"] and modifier == ".not":
final_mod = "<<"
elif search in ["critic_rating", "audience_rating"] and modifier == ".greater":
final_mod = "__gte"
elif search in ["critic_rating", "audience_rating"] and modifier == ".less":
final_mod = "__lt"
else:
final_mod = modifiers[modifier] if modifier in modifiers else ""
final_method = f"{final_search}{final_mod}"
if search == "duration":
search_terms[final_method] = search_data * 60000
elif search in ["added", "originally_available"] and modifier in ["", ".not"]:
search_terms[final_method] = f"{search_data}d"
else:
search_terms[final_method] = search_data
if status_message:
if search in ["added", "originally_available"] or modifier in [".greater", ".less", ".before", ".after"]:
ors = f"{search_method}({search_data}"
else:
ors = ""
conjunction = " AND " if final_mod == "&" else " OR "
for o, param in enumerate(search_data):
or_des = conjunction if o > 0 else f"{search_method}("
ors += f"{or_des}{param}"
if has_processed:
logger.info(f"\t\t AND {ors})")
else:
logger.info(f"Processing {pretty}: {ors})")
has_processed = True
if status_message:
if search_sort:
logger.info(f"\t\t SORT BY {search_sort})")
if search_limit:
logger.info(f"\t\t LIMIT {search_limit})")
logger.debug(f"Search: {search_terms}")
2021-04-08 20:10:26 +00:00
return self.search(sort=sorts[search_sort], maxresults=search_limit, **search_terms)
elif method == "plex_collectionless":
good_collections = []
for col in self.get_all_collections():
keep_collection = True
for pre in data["exclude_prefix"]:
if col.title.startswith(pre) or (col.titleSort and col.titleSort.startswith(pre)):
keep_collection = False
break
if keep_collection:
for ext in data["exclude"]:
if col.title == ext or (col.titleSort and col.titleSort == ext):
keep_collection = False
break
if keep_collection:
good_collections.append(col.index)
2021-04-08 20:10:26 +00:00
all_items = self.get_all()
length = 0
for i, item in enumerate(all_items, 1):
length = util.print_return(length, f"Processing: {i}/{len(all_items)} {item.title}")
add_item = True
item.reload()
for collection in item.collections:
if collection.id in good_collections:
add_item = False
break
if add_item:
items.append(item)
util.print_end(length, f"Processed {len(all_items)} {'Movies' if self.is_movie else 'Shows'}")
else:
raise Failed(f"Plex Error: Method {method} not supported")
if len(items) > 0:
return items
else:
raise Failed("Plex Error: No Items found in Plex")
2021-02-16 21:51:38 +00:00
def add_missing(self, collection, items, is_movie):
col_name = collection.encode("ascii", "replace").decode()
if col_name not in self.missing:
self.missing[col_name] = {}
section = "Movies Missing (TMDb IDs)" if is_movie else "Shows Missing (TVDb IDs)"
if section not in self.missing[col_name]:
self.missing[col_name][section] = {}
for title, item_id in items:
self.missing[col_name][section][int(item_id)] = str(title).encode("ascii", "replace").decode()
with open(self.missing_path, "w"): pass
2021-01-20 21:37:59 +00:00
try:
2021-02-16 21:51:38 +00:00
yaml.round_trip_dump(self.missing, open(self.missing_path, "w"))
2021-01-20 21:37:59 +00:00
except yaml.scanner.ScannerError as e:
2021-02-24 06:44:06 +00:00
logger.error(f"YAML Error: {util.tab_new_lines(e)}")
2021-01-20 21:37:59 +00:00
2021-02-24 06:42:58 +00:00
def add_to_collection(self, collection, items, filters, show_filtered, rating_key_map, movie_map, show_map):
2021-01-20 21:37:59 +00:00
name = collection.title if isinstance(collection, Collections) else collection
2021-01-26 06:25:05 +00:00
collection_items = collection.items() if isinstance(collection, Collections) else []
2021-01-20 21:37:59 +00:00
total = len(items)
max_length = len(str(total))
length = 0
for i, item in enumerate(items, 1):
2021-02-20 05:41:45 +00:00
try:
current = self.fetchItem(item.ratingKey if isinstance(item, (Movie, Show)) else int(item))
2021-03-15 18:11:44 +00:00
if not isinstance(current, (Movie, Show)):
raise NotFound
2021-02-15 06:51:15 +00:00
except (BadRequest, NotFound):
2021-02-24 06:44:06 +00:00
logger.error(f"Plex Error: Item {item} not found")
2021-02-15 06:51:15 +00:00
continue
2021-01-20 21:37:59 +00:00
match = True
if filters:
2021-02-24 06:44:06 +00:00
length = util.print_return(length, f"Filtering {(' ' * (max_length - len(str(i)))) + str(i)}/{total} {current.title}")
2021-02-28 08:36:40 +00:00
for filter_method, filter_data in filters:
modifier = filter_method[-4:]
2021-03-11 20:03:32 +00:00
method = filter_method[:-4] if modifier in [".not", ".lte", ".gte"] else filter_method
2021-03-30 05:50:53 +00:00
method_name = filter_alias[method] if method in filter_alias else method
2021-03-11 20:03:32 +00:00
if method_name == "max_age":
2021-02-28 08:36:40 +00:00
threshold_date = datetime.now() - timedelta(days=filter_data)
if current.originallyAvailableAt is None or current.originallyAvailableAt < threshold_date:
2021-01-20 21:37:59 +00:00
match = False
break
2021-03-11 20:03:32 +00:00
elif method_name == "original_language":
2021-02-12 15:37:04 +00:00
movie = None
for key, value in movie_map.items():
if current.ratingKey in value:
2021-02-12 15:37:04 +00:00
try:
movie = self.TMDb.get_movie(key)
break
except Failed:
pass
if movie is None:
2021-02-24 06:44:06 +00:00
logger.warning(f"Filter Error: No TMDb ID found for {current.title}")
2021-02-12 15:37:04 +00:00
continue
2021-02-28 08:36:40 +00:00
if (modifier == ".not" and movie.original_language in filter_data) or (modifier != ".not" and movie.original_language not in filter_data):
2021-02-12 15:37:04 +00:00
match = False
break
2021-03-11 20:03:32 +00:00
elif method_name == "audio_track_title":
2021-03-11 05:51:01 +00:00
jailbreak = False
2021-03-10 23:21:41 +00:00
for media in current.media:
for part in media.parts:
for audio in part.audioStreams():
for check_title in filter_data:
2021-03-11 05:51:01 +00:00
title = audio.title if audio.title else ""
if check_title.lower() in title.lower():
jailbreak = True
2021-03-10 23:21:41 +00:00
break
2021-03-11 05:51:01 +00:00
if jailbreak: break
if jailbreak: break
if jailbreak: break
if (jailbreak and modifier == ".not") or (not jailbreak and modifier != ".not"):
match = False
break
2021-01-20 21:37:59 +00:00
elif modifier in [".gte", ".lte"]:
2021-03-11 20:03:32 +00:00
if method_name == "vote_count":
2021-02-28 08:36:40 +00:00
tmdb_item = None
for key, value in movie_map.items():
if current.ratingKey in value:
2021-02-28 08:36:40 +00:00
try:
tmdb_item = self.TMDb.get_movie(key) if self.is_movie else self.TMDb.get_show(key)
break
except Failed:
pass
if tmdb_item is None:
logger.warning(f"Filter Error: No TMDb ID found for {current.title}")
continue
attr = tmdb_item.vote_count
else:
2021-03-11 20:03:32 +00:00
attr = getattr(current, method_name) / 60000 if method_name == "duration" else getattr(current, method_name)
2021-04-01 01:02:51 +00:00
if attr is None or (modifier == ".lte" and attr > filter_data) or (modifier == ".gte" and attr < filter_data):
match = False
break
2021-01-20 21:37:59 +00:00
else:
2021-02-24 06:42:58 +00:00
attrs = []
2021-03-11 20:03:32 +00:00
if method_name in ["video_resolution", "audio_language", "subtitle_language"]:
2021-01-20 21:37:59 +00:00
for media in current.media:
2021-03-21 23:39:09 +00:00
if method_name == "video_resolution":
attrs.extend([media.videoResolution])
2021-01-20 21:37:59 +00:00
for part in media.parts:
2021-03-21 23:39:09 +00:00
if method_name == "audio_language":
attrs.extend([a.language for a in part.audioStreams()])
if method_name == "subtitle_language":
attrs.extend([s.language for s in part.subtitleStreams()])
elif method_name in ["contentRating", "studio", "year", "rating", "originallyAvailableAt"]:
attrs = [str(getattr(current, method_name))]
elif method_name in ["actors", "countries", "directors", "genres", "writers", "collections"]:
attrs = [getattr(x, "tag") for x in getattr(current, method_name)]
else:
raise Failed(f"Filter Error: filter: {method_name} not supported")
2021-01-20 21:37:59 +00:00
2021-02-28 08:36:40 +00:00
if (not list(set(filter_data) & set(attrs)) and modifier != ".not") or (list(set(filter_data) & set(attrs)) and modifier == ".not"):
2021-01-20 21:37:59 +00:00
match = False
break
2021-02-24 06:44:06 +00:00
length = util.print_return(length, f"Filtering {(' ' * (max_length - len(str(i)))) + str(i)}/{total} {current.title}")
2021-01-20 21:37:59 +00:00
if match:
2021-02-24 06:44:06 +00:00
util.print_end(length, f"{name} Collection | {'=' if current in collection_items else '+'} | {current.title}")
2021-02-24 06:42:58 +00:00
if current in collection_items: rating_key_map[current.ratingKey] = None
2021-04-08 20:10:26 +00:00
else: self.add_collection(current, name)
2021-02-13 04:28:46 +00:00
elif show_filtered is True:
2021-02-24 06:44:06 +00:00
logger.info(f"{name} Collection | X | {current.title}")
media_type = f"{'Movie' if self.is_movie else 'Show'}{'s' if total > 1 else ''}"
util.print_end(length, f"{total} {media_type} Processed")
2021-02-24 06:42:58 +00:00
return rating_key_map
2021-01-20 21:37:59 +00:00
2021-02-05 14:56:05 +00:00
def search_item(self, data, year=None):
2021-04-12 04:00:03 +00:00
kwargs = {}
if year is not None:
kwargs["year"] = year
return util.choose_from_list(self.search(title=str(data), **kwargs), "movie" if self.is_movie else "show", str(data), exact=True)
2021-02-05 14:56:05 +00:00
def edit_item(self, item, name, item_type, edits, advanced=False):
if len(edits) > 0:
logger.debug(f"Details Update: {edits}")
try:
if advanced:
item.editAdvanced(**edits)
else:
item.edit(**edits)
item.reload()
if advanced and "languageOverride" in edits:
2021-04-21 21:19:54 +00:00
self.refresh_item(item.ratingKey)
logger.info(f"{item_type}: {name}{' Advanced' if advanced else ''} Details Update Successful")
except BadRequest:
util.print_stacktrace()
logger.error(f"{item_type}: {name}{' Advanced' if advanced else ''} Details Update Failed")
2021-02-15 06:51:15 +00:00
def update_metadata(self, TMDb, test):
2021-01-20 21:37:59 +00:00
logger.info("")
2021-02-24 06:44:06 +00:00
util.separator(f"{self.name} Library Metadata")
2021-01-20 21:37:59 +00:00
logger.info("")
if not self.metadata:
raise Failed("No metadata to edit")
2021-03-25 15:07:54 +00:00
for mapping_name, meta in self.metadata.items():
methods = {mm.lower(): mm for mm in meta}
if test and ("test" not in methods or meta[methods["test"]] is not True):
2021-02-15 06:51:15 +00:00
continue
updated = False
edits = {}
advance_edits = {}
def add_edit(name, current, group, alias, key=None, value=None, var_type="str"):
if value or name in alias:
if value or group[alias[name]]:
if key is None: key = name
if value is None: value = group[alias[name]]
try:
if var_type == "date":
final_value = util.check_date(value, name, return_string=True, plex_date=True)
elif var_type == "float":
final_value = util.check_number(value, name, number_type="float", minimum=0, maximum=10)
else:
final_value = value
if str(current) != str(final_value):
edits[f"{key}.value"] = final_value
edits[f"{key}.locked"] = 1
logger.info(f"Detail: {name} updated to {final_value}")
except Failed as ee:
logger.error(ee)
else:
logger.error(f"Metadata Error: {name} attribute is blank")
def add_advanced_edit(attr, obj, group, alias, show_library=False, new_agent=False):
key, options = advance_keys[attr]
if attr in alias:
if new_agent and self.agent not in new_plex_agents:
logger.error(f"Metadata Error: {attr} attribute only works for with the New Plex Movie Agent and New Plex TV Agent")
elif show_library and not self.is_show:
logger.error(f"Metadata Error: {attr} attribute only works for show libraries")
elif group[alias[attr]]:
method_data = str(group[alias[attr]]).lower()
if method_data not in options:
logger.error(f"Metadata Error: {group[alias[attr]]} {attr} attribute invalid")
elif getattr(obj, key) != options[method_data]:
advance_edits[key] = options[method_data]
logger.info(f"Detail: {attr} updated to {method_data}")
else:
logger.error(f"Metadata Error: {attr} attribute is blank")
def edit_tags(attr, obj, group, alias, key=None, extra=None, movie_library=False):
if key is None:
key = f"{attr}s"
if attr in alias and f"{attr}.sync" in alias:
logger.error(f"Metadata Error: Cannot use {attr} and {attr}.sync together")
elif attr in alias or f"{attr}.sync" in alias:
attr_key = attr if attr in alias else f"{attr}.sync"
if movie_library and not self.is_movie:
logger.error(f"Metadata Error: {attr_key} attribute only works for movie libraries")
elif group[alias[attr_key]] or extra:
item_tags = [item_tag.tag for item_tag in getattr(obj, key)]
input_tags = []
if group[alias[attr_key]]:
input_tags.extend(util.get_list(group[alias[attr_key]]))
if extra:
input_tags.extend(extra)
if f"{attr}.sync" in alias:
remove_method = getattr(obj, f"remove{attr.capitalize()}")
for tag in (t for t in item_tags if t not in input_tags):
updated = True
remove_method(tag)
logger.info(f"Detail: {attr.capitalize()} {tag} removed")
add_method = getattr(obj, f"add{attr.capitalize()}")
for tag in (t for t in input_tags if t not in item_tags):
updated = True
add_method(tag)
logger.info(f"Detail: {attr.capitalize()} {tag} added")
else:
logger.error(f"Metadata Error: {attr} attribute is blank")
def set_image(attr, obj, group, alias, is_background=False):
if group[alias[attr]]:
message = f"{'background' if is_background else 'poster'} to [{'File' if attr.startswith('file') else 'URL'}] {group[alias[attr]]}"
if group[alias[attr]] and attr.startswith("url") and is_background:
obj.uploadArt(url=group[alias[attr]])
elif group[alias[attr]] and attr.startswith("url"):
obj.uploadPoster(url=group[alias[attr]])
elif group[alias[attr]] and attr.startswith("file") and is_background:
obj.uploadArt(filepath=group[alias[attr]])
elif group[alias[attr]] and attr.startswith("file"):
obj.uploadPoster(filepath=group[alias[attr]])
logger.info(f"Detail: {attr} updated {message}")
else:
logger.error(f"Metadata Error: {attr} attribute is blank")
def set_images(obj, group, alias):
if "url_poster" in alias:
set_image("url_poster", obj, group, alias)
elif "file_poster" in alias:
set_image("file_poster", obj, group, alias)
if "url_background" in alias:
set_image("url_background", obj, group, alias, is_background=True)
elif "file_background" in alias:
set_image("file_background", obj, group, alias, is_background=True)
2021-01-20 21:37:59 +00:00
logger.info("")
2021-02-24 06:42:58 +00:00
util.separator()
2021-01-20 21:37:59 +00:00
logger.info("")
year = None
2021-03-22 03:38:10 +00:00
if "year" in methods:
2021-03-25 15:07:54 +00:00
year = util.check_number(meta[methods["year"]], "year", minimum=1800, maximum=datetime.now().year + 1)
2021-01-20 21:37:59 +00:00
2021-03-25 15:07:54 +00:00
title = mapping_name
2021-03-22 03:38:10 +00:00
if "title" in methods:
2021-03-25 15:07:54 +00:00
if meta[methods["title"]] is None: logger.error("Metadata Error: title attribute is blank")
else: title = meta[methods["title"]]
2021-02-05 14:56:05 +00:00
item = self.search_item(title, year=year)
if item is None:
2021-02-24 06:44:06 +00:00
item = self.search_item(f"{title} (SUB)", year=year)
2021-02-05 14:56:05 +00:00
2021-03-22 03:38:10 +00:00
if item is None and "alt_title" in methods:
2021-03-25 15:07:54 +00:00
if meta[methods["alt_title"]] is None:
2021-02-05 14:56:05 +00:00
logger.error("Metadata Error: alt_title attribute is blank")
else:
2021-03-25 15:07:54 +00:00
alt_title = meta["alt_title"]
2021-02-05 14:56:05 +00:00
item = self.search_item(alt_title, year=year)
if item is None:
2021-03-25 15:07:54 +00:00
logger.error(f"Plex Error: Item {mapping_name} not found")
logger.error(f"Skipping {mapping_name}")
2021-02-05 14:56:05 +00:00
continue
2021-02-24 06:44:06 +00:00
item_type = "Movie" if self.is_movie else "Show"
logger.info(f"Updating {item_type}: {title}...")
2021-01-20 21:37:59 +00:00
2021-02-05 14:56:05 +00:00
tmdb_item = None
tmdb_is_movie = None
if ("tmdb_show" in methods or "tmdb_id" in methods) and "tmdb_movie" in methods:
logger.error("Metadata Error: Cannot use tmdb_movie and tmdb_show when editing the same metadata item")
if "tmdb_show" in methods or "tmdb_id" in methods or "tmdb_movie" in methods:
try:
if "tmdb_show" in methods or "tmdb_id" in methods:
data = meta[methods["tmdb_show" if "tmdb_show" in methods else "tmdb_id"]]
if data is None:
logger.error("Metadata Error: tmdb_show attribute is blank")
else:
tmdb_is_movie = False
tmdb_item = TMDb.get_show(util.regex_first_int(data, "Show"))
elif "tmdb_movie" in methods:
if meta[methods["tmdb_movie"]] is None:
logger.error("Metadata Error: tmdb_movie attribute is blank")
else:
tmdb_is_movie = True
tmdb_item = TMDb.get_movie(util.regex_first_int(meta[methods["tmdb_movie"]], "Movie"))
except Failed as e:
logger.error(e)
originally_available = None
original_title = None
rating = None
studio = None
tagline = None
summary = None
genres = []
if tmdb_item:
originally_available = tmdb_item.release_date if tmdb_is_movie else tmdb_item.first_air_date
if tmdb_item and tmdb_is_movie is True and tmdb_item.original_title != tmdb_item.title:
original_title = tmdb_item.original_title
elif tmdb_item and tmdb_is_movie is False and tmdb_item.original_name != tmdb_item.name:
original_title = tmdb_item.original_name
rating = tmdb_item.vote_average
if tmdb_is_movie is True and tmdb_item.production_companies:
studio = tmdb_item.production_companies[0].name
elif tmdb_is_movie is False and tmdb_item.networks:
studio = tmdb_item.networks[0].name
tagline = tmdb_item.tagline if len(tmdb_item.tagline) > 0 else None
summary = tmdb_item.overview
genres = [genre.name for genre in tmdb_item.genres]
2021-03-27 21:51:35 +00:00
2021-01-20 21:37:59 +00:00
edits = {}
2021-03-25 15:07:54 +00:00
add_edit("title", item.title, meta, methods, value=title)
add_edit("sort_title", item.titleSort, meta, methods, key="titleSort")
add_edit("originally_available", str(item.originallyAvailableAt)[:-9], meta, methods, key="originallyAvailableAt", value=originally_available, var_type="date")
add_edit("critic_rating", item.rating, meta, methods, value=rating, key="rating", var_type="float")
add_edit("audience_rating", item.audienceRating, meta, methods, key="audienceRating", var_type="float")
2021-03-25 15:07:54 +00:00
add_edit("content_rating", item.contentRating, meta, methods, key="contentRating")
add_edit("original_title", item.originalTitle, meta, methods, key="originalTitle", value=original_title)
add_edit("studio", item.studio, meta, methods, value=studio)
add_edit("tagline", item.tagline, meta, methods, value=tagline)
add_edit("summary", item.summary, meta, methods, value=summary)
self.edit_item(item, mapping_name, item_type, edits)
2021-02-05 14:56:05 +00:00
2021-03-24 01:35:39 +00:00
advance_edits = {}
add_advanced_edit("episode_sorting", item, meta, methods, show_library=True)
add_advanced_edit("keep_episodes", item, meta, methods, show_library=True)
add_advanced_edit("delete_episodes", item, meta, methods, show_library=True)
add_advanced_edit("season_display", item, meta, methods, show_library=True)
add_advanced_edit("episode_ordering", item, meta, methods, show_library=True)
add_advanced_edit("metadata_language", item, meta, methods, new_agent=True)
add_advanced_edit("use_original_title", item, meta, methods, new_agent=True)
self.edit_item(item, mapping_name, item_type, advance_edits, advanced=True)
2021-03-22 06:50:37 +00:00
edit_tags("genre", item, meta, methods, extra=genres)
edit_tags("label", item, meta, methods)
edit_tags("collection", item, meta, methods)
edit_tags("country", item, meta, methods, key="countries", movie_library=True)
edit_tags("director", item, meta, methods, movie_library=True)
edit_tags("producer", item, meta, methods, movie_library=True)
edit_tags("writer", item, meta, methods, movie_library=True)
2021-01-20 21:37:59 +00:00
2021-04-14 20:55:35 +00:00
logger.info(f"{item_type}: {mapping_name} Details Update {'Complete' if updated else 'Not Needed'}")
set_images(item, meta, methods)
2021-03-22 03:38:10 +00:00
if "seasons" in methods and self.is_show:
2021-03-25 15:07:54 +00:00
if meta[methods["seasons"]]:
for season_id in meta[methods["seasons"]]:
2021-04-14 20:55:35 +00:00
updated = False
2021-01-20 21:37:59 +00:00
logger.info("")
2021-03-25 15:07:54 +00:00
logger.info(f"Updating season {season_id} of {mapping_name}...")
2021-01-20 21:37:59 +00:00
if isinstance(season_id, int):
2021-04-14 20:55:35 +00:00
season = None
for s in item.seasons():
if s.index == season_id:
season = s
break
if season is None:
logger.error(f"Metadata Error: Season: {season_id} not found")
2021-01-20 21:37:59 +00:00
else:
2021-03-25 15:07:54 +00:00
season_dict = meta[methods["seasons"]][season_id]
2021-03-22 03:38:10 +00:00
season_methods = {sm.lower(): sm for sm in season_dict}
2021-02-05 14:56:05 +00:00
2021-03-22 03:38:10 +00:00
if "title" in season_methods and season_dict[season_methods["title"]]:
title = season_dict[season_methods["title"]]
2021-02-05 14:56:05 +00:00
else:
title = season.title
2021-03-22 03:38:10 +00:00
if "sub" in season_methods:
if season_dict[season_methods["sub"]] is None:
2021-02-05 14:56:05 +00:00
logger.error("Metadata Error: sub attribute is blank")
2021-03-22 03:38:10 +00:00
elif season_dict[season_methods["sub"]] is True and "(SUB)" not in title:
2021-02-24 06:44:06 +00:00
title = f"{title} (SUB)"
2021-03-22 03:38:10 +00:00
elif season_dict[season_methods["sub"]] is False and title.endswith(" (SUB)"):
2021-02-05 14:56:05 +00:00
title = title[:-6]
else:
logger.error("Metadata Error: sub attribute must be True or False")
2021-01-20 21:37:59 +00:00
edits = {}
2021-03-22 03:38:10 +00:00
add_edit("title", season.title, season_dict, season_methods, value=title)
add_edit("summary", season.summary, season_dict, season_methods)
self.edit_item(season, season_id, "Season", edits)
set_images(season, season_dict, season_methods)
2021-01-20 21:37:59 +00:00
else:
2021-02-24 06:44:06 +00:00
logger.error(f"Metadata Error: Season: {season_id} invalid, it must be an integer")
2021-04-14 20:55:35 +00:00
logger.info(f"Season {season_id} of {mapping_name} Details Update {'Complete' if updated else 'Not Needed'}")
2021-01-20 21:37:59 +00:00
else:
logger.error("Metadata Error: seasons attribute is blank")
2021-03-30 05:49:10 +00:00
elif "seasons" in methods:
logger.error("Metadata Error: seasons attribute only works for show libraries")
2021-01-20 21:37:59 +00:00
2021-03-22 03:38:10 +00:00
if "episodes" in methods and self.is_show:
2021-03-25 15:07:54 +00:00
if meta[methods["episodes"]]:
for episode_str in meta[methods["episodes"]]:
2021-04-14 20:55:35 +00:00
updated = False
2021-01-20 21:37:59 +00:00
logger.info("")
2021-02-24 06:42:58 +00:00
match = re.search("[Ss]\\d+[Ee]\\d+", episode_str)
2021-01-20 21:37:59 +00:00
if match:
2021-03-17 23:50:18 +00:00
output = match.group(0)[1:].split("E" if "E" in match.group(0) else "e")
2021-04-22 18:07:37 +00:00
season_id = int(output[0])
episode_id = int(output[1])
2021-04-22 21:22:49 +00:00
logger.info(f"Updating episode S{season_id}E{episode_id} of {mapping_name}...")
2021-01-20 21:37:59 +00:00
try: episode = item.episode(season=season_id, episode=episode_id)
2021-02-24 06:44:06 +00:00
except NotFound: logger.error(f"Metadata Error: episode {episode_id} of season {season_id} not found")
2021-01-20 21:37:59 +00:00
else:
2021-03-25 15:07:54 +00:00
episode_dict = meta[methods["episodes"]][episode_str]
2021-03-22 03:38:10 +00:00
episode_methods = {em.lower(): em for em in episode_dict}
if "title" in episode_methods and episode_dict[episode_methods["title"]]:
title = episode_dict[episode_methods["title"]]
2021-02-05 14:56:05 +00:00
else:
title = episode.title
2021-03-22 03:38:10 +00:00
if "sub" in episode_dict:
if episode_dict[episode_methods["sub"]] is None:
2021-02-05 14:56:05 +00:00
logger.error("Metadata Error: sub attribute is blank")
2021-03-22 03:38:10 +00:00
elif episode_dict[episode_methods["sub"]] is True and "(SUB)" not in title:
2021-02-24 06:44:06 +00:00
title = f"{title} (SUB)"
2021-03-22 03:38:10 +00:00
elif episode_dict[episode_methods["sub"]] is False and title.endswith(" (SUB)"):
2021-02-05 14:56:05 +00:00
title = title[:-6]
else:
logger.error("Metadata Error: sub attribute must be True or False")
2021-01-20 21:37:59 +00:00
edits = {}
2021-03-22 03:38:10 +00:00
add_edit("title", episode.title, episode_dict, episode_methods, value=title)
add_edit("sort_title", episode.titleSort, episode_dict, episode_methods, key="titleSort")
add_edit("rating", episode.rating, episode_dict, episode_methods)
add_edit("originally_available", str(episode.originallyAvailableAt)[:-9], episode_dict, episode_methods, key="originallyAvailableAt")
add_edit("summary", episode.summary, episode_dict, episode_methods)
self.edit_item(episode, f"{season_id} Episode: {episode_id}", "Season", edits)
edit_tags("director", episode, episode_dict, episode_methods)
edit_tags("writer", episode, episode_dict, episode_methods)
set_images(episode, episode_dict, episode_methods)
2021-04-14 20:55:35 +00:00
logger.info(f"Episode S{episode_id}E{season_id} of {mapping_name} Details Update {'Complete' if updated else 'Not Needed'}")
2021-01-20 21:37:59 +00:00
else:
2021-02-24 06:44:06 +00:00
logger.error(f"Metadata Error: episode {episode_str} invalid must have S##E## format")
2021-01-20 21:37:59 +00:00
else:
logger.error("Metadata Error: episodes attribute is blank")
2021-03-30 05:49:10 +00:00
elif "episodes" in methods:
logger.error("Metadata Error: episodes attribute only works for show libraries")