JBOPS/fun/playlist_manager.py

1033 lines
39 KiB
Python
Raw Normal View History

#!/usr/bin/env python
# -*- coding: utf-8 -*-
2018-09-26 13:10:40 +00:00
"""
Description: Create and share playlists based on Most Popular TV/Movies from Tautulli
and Aired this day in history.
Author: blacktwin
Requires: requests, plexapi, flatten_json
2018-09-26 13:10:40 +00:00
Create, share, and clean Playlists for users.
optional arguments:
-h, --help show this help message and exit
--jbop Playlist selector.
2018-12-21 14:13:06 +00:00
Choices: (historyToday, historyWeek, historyMonth, popularTv, popularMovies)
--action Action selector.
add - create new playlist for admin or users
remove - remove playlist type or name from admin or users
update - remove playlist type and create new playlist type for admin or users
show - show contents of playlist type or admin or users current playlists
share - share existing playlist by title from admin to users
export - export playlist by title from admin to users
2018-10-19 06:31:55 +00:00
2018-09-26 13:10:40 +00:00
--users {] The Plex usernames to create/share to or delete from.
Choices: (USERNAMES)
--libraries [ ...] Space separated list of case sensitive names to
process. Allowed names are:
Choices: (LIBRARIES)
--allLibraries Select all libraries.
2018-09-26 13:10:40 +00:00
--self Create playlist for admin.
Default: False
--days DAYS The time range to calculate statistics.
Default: 30
--top TOP The number of top items to list.
Default: 5
--playlists Space separated list of case sensitive names to
2018-10-19 06:31:55 +00:00
process. Allowed names are:
Choices: (PLAYLISTS)
2019-01-03 16:14:32 +00:00
--allPlaylist Select all playlists.
--name NAME Custom name for playlist.
--limit LIMIT Limit the amount items to be added to a playlist.
--filter FILTER Search filtered metadata fields
Filters: (mood unwatched country contentRating collection label director duplicate
studio actor year genre guid resolution decade network).
--search SEARCH Search non-filtered metadata fields for keywords in title, summary, etc.
2018-09-26 13:10:40 +00:00
Example:
Use with cron or task to schedule runs
2018-10-07 13:15:20 +00:00
Create Aired Today Playlist from Movies and TV Shows libraries for admin user
2018-12-21 14:13:06 +00:00
python playlist_manager.py --jbop historyToday --libraries Movies "TV Shows" --action add
2018-09-26 13:10:40 +00:00
Create Aired Today Playlist from Movies and TV Shows libraries and share to users bob, Black Twin and admin user
2018-12-21 14:13:06 +00:00
python playlist_manager.py --jbop historyToday --libraries Movies "TV Shows" --action add --users bob "Black Twin" --self
2018-09-26 13:10:40 +00:00
Update previous Aired Today Playlist(s) from Movies and TV Shows libraries and share to users bob and Black Twin
2018-12-21 14:13:06 +00:00
python playlist_manager.py --jbop historyToday --libraries Movies "TV Shows" --action update --users bob "Black Twin"
2018-09-26 13:10:40 +00:00
Delete all previous Aired Today Playlist(s) from users bob and Black Twin
2018-12-21 14:13:06 +00:00
python playlist_manager.py --jbop historyToday --action remove --users bob "Black Twin"
2018-09-26 13:10:40 +00:00
Create 5 Most Popular TV Shows (30 days) Playlist and share to users bob and Black Twin
python playlist_manager.py --jbop popularTv --libraries "TV Shows" --action add --users bob "Black Twin"
2018-09-26 13:10:40 +00:00
Create 10 Most Popular Movies (60 days) Playlist and share to users bob and Black Twin
python playlist_manager.py --jbop popularMovies --libraries Movies --action add --users bob "Black Twin" --days 60 --top 10
2018-10-19 06:31:55 +00:00
Show 5 Most Popular TV Shows (30 days) Playlist
python playlist_manager.py --jbop popularTv --libraries "TV Shows" --action show
2018-10-19 06:31:55 +00:00
Show all users current playlists
python playlist_manager.py --action show --allUsers
2018-10-19 06:31:55 +00:00
Share existing admin Playlists "My Custom Playlist" and "Another Playlist" with all users
python playlist_manager.py --action share --allUsers --playlists "My Custom Playlist" "Another Playlist"
Export each of an user's Playlists contents to a json file in the root of the script
2022-04-22 02:35:03 +00:00
python playlist_manager.py --action export --user USER --playlists "Most Popular Movies (30 days)" "New Hot"
Export each of an user's Playlists contents to a csv file in the root of the script
2022-04-22 02:35:03 +00:00
python playlist_manager.py --action export --user USER --allPlaylists --export csv
Import a user's exported Playlist json file to the admin's Movies library
python playlist_manager.py --action import --self --importJson "User-Title-Playlist.json" --libraries "Movies"
Import a admin's exported Playlist json file to users shared Movies library
python playlist_manager.py --action import --users User1 "Another User" --importJson "User-Title-Playlist.json" --libraries "Movies"
2019-05-24 14:38:29 +00:00
Search and Filter;
2019-05-24 14:38:29 +00:00
metadata_field_name = title, summary, etc.
2019-05-24 14:38:29 +00:00
--search {metadata_field_name}=value
search through metadata field for existence of value.
2019-05-24 14:38:29 +00:00
--search {metadata_field_name}=value1,value2,*
search through metadata field for existence of values.
*comma separated for AND (value1 AND value2 AND *)
2018-10-19 06:31:55 +00:00
Excluding;
--user becomes excluded if --allUsers is set
python playlist_manager.py --action show --allUsers --user USER
- Show all users current Playlists... all users but USER
--libraries becomes excluded if --allLibraries is set
python playlist_manager.py --jbop historyToday --allLibraries --libraries Movies --action add
- Create Aired Today Playlist from every library by Movies for admin user
2018-09-26 13:10:40 +00:00
"""
2020-07-04 20:31:02 +00:00
from __future__ import unicode_literals
2018-09-26 13:10:40 +00:00
2020-07-04 20:23:47 +00:00
from builtins import str
2018-09-26 13:10:40 +00:00
import sys
import os
import json
2019-02-03 21:58:40 +00:00
import random
import logging
2018-09-26 13:10:40 +00:00
import requests
import argparse
import operator
import datetime
from collections import Counter
2018-09-26 13:10:40 +00:00
from plexapi.server import PlexServer, CONFIG
filename = os.path.basename(__file__)
filename = filename.split('.')[0]
logger = logging.getLogger(filename)
logger.setLevel(logging.DEBUG)
error_format = logging.Formatter('%(asctime)s:%(name)s:%(funcName)s:%(message)s')
stream_format = logging.Formatter('%(message)s')
file_handler = logging.FileHandler('{}.log'.format(filename))
file_handler.setLevel(logging.ERROR)
file_handler.setFormatter(error_format)
stream_handler = logging.StreamHandler()
stream_handler.setFormatter(stream_format)
logger.addHandler(file_handler)
logger.addHandler(stream_handler)
# ### EDIT SETTINGS ###
2018-09-26 13:10:40 +00:00
PLEX_URL = ''
PLEX_TOKEN = ''
TAUTULLI_URL = ''
TAUTULLI_APIKEY = ''
# ## CODE BELOW ##
2018-09-26 13:10:40 +00:00
if not PLEX_URL:
PLEX_URL = CONFIG.data['auth'].get('server_baseurl')
if not PLEX_TOKEN:
PLEX_TOKEN = CONFIG.data['auth'].get('server_token')
if not TAUTULLI_URL:
TAUTULLI_URL = CONFIG.data['auth'].get('tautulli_baseurl')
if not TAUTULLI_APIKEY:
TAUTULLI_APIKEY = CONFIG.data['auth'].get('tautulli_apikey')
# Defaults
DAYS = 30
TOP = 5
sess = requests.Session()
# Ignore verifying the SSL certificate
sess.verify = False # '/path/to/certfile'
# If verify is set to a path to a directory,
# the directory must have been processed using the c_rehash utility supplied
# with OpenSSL.
if sess.verify is False:
# Disable the warning that the request is insecure, we know that...
import urllib3
urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
plex = PlexServer(PLEX_URL, PLEX_TOKEN, session=sess)
account = plex.myPlexAccount()
2022-10-02 20:25:47 +00:00
user_lst = [x.title for x in plex.myPlexAccount().users() if x.servers]
sections = plex.library.sections()
sections_dict = {x.key: x.title for x in sections}
filters_lst = list(set([y.key for x in sections if x.type != 'photo' for y in x.listFields()]))
admin_playlist_lst = [x for x in plex.playlists()]
2018-09-26 13:10:40 +00:00
today = datetime.datetime.now().date()
weeknum = datetime.date(today.year, today.month, today.day).isocalendar()[1]
json_check = sorted([f for f in os.listdir('.') if os.path.isfile(f) and f.endswith(".json")],
key=os.path.getmtime)
2018-09-26 13:10:40 +00:00
def actions():
"""
add - create new playlist for admin or users
remove - remove playlist type or name from admin or users
update - remove playlist type and create new playlist type for admin or users
show - show contents of playlist type or admin or users current playlists
share - share existing playlist by title from admin to users
2020-07-13 23:45:50 +00:00
export - export playlist by title from admin to users
"""
2022-04-21 18:43:28 +00:00
return ['add', 'remove', 'update', 'show', 'share', 'export', 'import']
def selectors():
"""Predefined Playlist selections and titles
"""
2019-05-24 14:38:29 +00:00
selections = {'historyToday': 'Aired Today {month}-{day} in History',
'historyWeek': 'Aired This Week ({week}) in History',
'historyMonth': 'Aired in {month}',
2018-11-23 20:45:21 +00:00
'popularTv': 'Most Popular TV Shows ({days} days)',
'popularMovies': 'Most Popular Movies ({days} days)',
2019-05-24 14:38:29 +00:00
'custom': '{custom} Playlist',
'random': '{count} Random {libraries} Playlist',
'label': '{custom}',
'collection': '{custom}'
}
return selections
2019-01-04 18:09:43 +00:00
def exclusions(all_true, select, all_items):
2019-01-04 18:49:05 +00:00
"""
Parameters
----------
all_true: bool
All of something (allLibraries, allPlaylists, allUsers)
select: list
List from arguments (user, playlists, libraries)
all_items: list or dict
List or Dictionary of all possible somethings
Returns
-------
2019-01-05 06:05:30 +00:00
output: list or dict
2019-01-04 18:49:05 +00:00
List of what was included/excluded
"""
2019-01-04 18:09:43 +00:00
output = ''
if isinstance(all_items, list):
output = []
if all_true and not select:
output = all_items
elif not all_true and select:
for item in all_items:
if isinstance(item, str):
return select
else:
if item.title in select:
output.append(item)
2019-01-04 18:09:43 +00:00
elif all_true and select:
for x in select:
all_items.remove(x)
output = all_items
2019-01-04 18:09:43 +00:00
elif isinstance(all_items, dict):
output = {}
if all_true and not select:
output = all_items
elif not all_true and select:
for key, value in all_items.items():
if value in select:
output[key] = value
elif all_true and select:
for key, value in all_items.items():
if value not in select:
output[key] = value
2019-01-04 18:09:43 +00:00
return output
2018-09-26 13:10:40 +00:00
def get_home_stats(time_range, stats_count):
# Get the homepage watch statistics.
payload = {'apikey': TAUTULLI_APIKEY,
'cmd': 'get_home_stats',
'time_range': time_range,
'stats_count': stats_count,
'stats_type': 0} # stats_type = plays
2018-09-26 13:10:40 +00:00
try:
r = requests.get(TAUTULLI_URL.rstrip('/') + '/api/v2', params=payload)
response = r.json()
res_data = response['response']['data']
return res_data
except Exception as e:
sys.stderr.write("Tautulli API 'get_home_stats' request failed: {0}.".format(e))
def sort_by_dates(video, date_type):
"""Find air dates of content
2018-09-26 13:10:40 +00:00
Parameters
----------
video
video object to find air date
Returns
-------
list
list of rating key and date aired
"""
try:
ad_year = video.originallyAvailableAt.year
ad_month = video.originallyAvailableAt.month
ad_day = video.originallyAvailableAt.day
ad_week = int(datetime.date(ad_year, ad_month, ad_day).isocalendar()[1])
if date_type == 'historyToday':
if ad_month == today.month and ad_day == today.day:
return [[video.ratingKey] + [str(video.originallyAvailableAt)]]
elif date_type == 'historyWeek':
if ad_week == weeknum:
return [[video.ratingKey] + [str(video.originallyAvailableAt)]]
elif date_type == 'historyMonth':
if ad_month == today.month:
return [[video.ratingKey] + [str(video.originallyAvailableAt)]]
else:
logger.debug("{} is outside of range for {}".format(video.title, date_type))
pass
# todo-me return object
except Exception as e:
logger.error("Error:{} for {}".format(e, video._prettyfilename()))
# exit()
2018-09-26 13:10:40 +00:00
def multi_filter_search(keyword_dict, library, search_eps=None):
"""Allowing for multiple filter or search values
Parameters
----------
keyword_dict: dict
library: class
search_eps: bool
Returns
-------
list
items that include all searched or filtered values
"""
multi_lst = []
ep_lst = []
logs = {}
ep_logs = []
# How many keywords
keyword_count = len(keyword_dict)
for key, values in keyword_dict.items():
if isinstance(values, list):
keyword_count += 1
for value in values:
search_dict = {}
search_dict[key] = value
if search_eps:
logs["data"] = [{key: value}]
for show in library.all():
for episode in show.episodes(**search_dict):
ep_lst += [episode.ratingKey]
ep_logs += [episode.title, episode.summary]
logs["data"].append({"keys": ep_lst, "info": ep_logs})
search_lst = ep_lst
else:
search_lst = [item.ratingKey for item in library.all(**search_dict)]
multi_lst += search_lst
else:
if search_eps:
for show in library.all():
for episode in show.episodes(**{key: values}):
ep_lst += [episode.ratingKey]
multi_lst += ep_lst
else:
multi_lst += [item.ratingKey for item in library.all(**{key: values})]
counts = Counter(multi_lst)
# Use amount of keywords to check that all keywords were found in results
search_lst = [id for id in multi_lst if counts[id] >= keyword_count]
return list(set(search_lst))
2019-02-03 21:58:40 +00:00
def get_content(libraries, jbop, filters=None, search=None, limit=None):
"""Get all movies or episodes from LIBRARY_NAME.
2018-09-26 13:10:40 +00:00
Parameters
----------
libraries: dict
dict of libraries key and name
jbop: str
jbop value for searching
2018-09-26 13:10:40 +00:00
Returns
-------
list
Sorted list of Movie and episodes that
aired on today's date.
2018-09-26 13:10:40 +00:00
"""
child_lst = []
2019-01-01 04:38:30 +00:00
filter_lst = []
search_lst = []
keywords = {}
tags = "__tag__icontains"
2019-01-01 07:46:48 +00:00
2019-01-01 04:38:30 +00:00
if search or filters:
if search:
# todo-me replace with documentation showing the available search operators
keywords = {key + '__icontains': value for key, value in search.items()}
2019-01-01 07:46:48 +00:00
# Loop through each library
for library in libraries.keys():
plex_library = plex.library.sectionByID(library)
2019-01-01 07:46:48 +00:00
library_type = plex_library.type
# Find media type, if show then search/filter episodes
if library_type == 'movie':
# Decisions to stack filter and search
if keywords:
child_lst += multi_filter_search(keywords, plex_library)
2019-01-01 07:46:48 +00:00
if filters:
for key, value in filters.items():
# Only genre filtering should allow multiple values and allow for AND statement
2020-11-26 04:02:52 +00:00
if key == "genre":
child_lst += multi_filter_search({key + tags: value}, plex_library)
else:
filter_lst = [movie.ratingKey for movie in plex_library.search(**{key: value})]
child_lst += filter_lst
if keywords and filters:
child_lst += list(set(filter_lst) & set(search_lst))
2019-01-01 07:46:48 +00:00
elif library_type == 'show':
2019-02-03 21:58:40 +00:00
# Decisions to stack filter and search
if keywords:
search_lst = multi_filter_search(keywords, plex_library, search_eps=True)
child_lst += search_lst
2019-01-01 07:46:48 +00:00
if filters:
for key, value in filters.items():
# Only genre filtering should allow multiple values and allow for AND statement
2020-11-26 04:02:52 +00:00
if key == "genre":
shows_lst = multi_filter_search({key: value}, plex_library)
else:
2019-07-24 12:10:18 +00:00
shows_lst = [show.ratingKey for show in plex_library.search(**{key: value})]
for showkey in shows_lst:
show = plex.fetchItem(showkey)
for episode in show.episodes():
filter_lst += [episode.ratingKey]
child_lst += filter_lst
if keywords and filters:
child_lst += list(set(filter_lst) & set(search_lst))
2019-01-01 07:46:48 +00:00
else:
pass
# Keep only results found from both search and filters
if keywords and filters:
child_lst = list(set(i for i in child_lst if child_lst.count(i) > 1))
play_lst = child_lst
else:
2019-07-24 12:11:15 +00:00
for library_id in libraries.keys():
plex_library = plex.library.sectionByID(library_id)
2019-02-03 21:58:40 +00:00
library_type = plex_library.type
2019-07-24 12:12:55 +00:00
if library_type == 'movie':
2019-02-03 21:58:40 +00:00
for child in plex_library.all():
if jbop.startswith("history"):
2019-02-03 21:58:40 +00:00
if sort_by_dates(child, jbop):
item_date = sort_by_dates(child, jbop)
child_lst += item_date
2019-02-03 21:58:40 +00:00
else:
child_lst += [child.ratingKey]
elif library_type == 'show':
for child in plex_library.all():
for episode in child.episodes():
if jbop.startswith("history"):
if sort_by_dates(episode, jbop):
item_date = sort_by_dates(episode, jbop)
child_lst += item_date
else:
child_lst += [episode.ratingKey]
else:
pass
2019-02-03 21:58:40 +00:00
# check if sort_by_dates was used
if isinstance(child_lst[0], list):
# Sort by original air date, oldest first
# todo-me move sorting and add more sorting options
aired_lst = sorted(child_lst, key=operator.itemgetter(1))
2019-02-03 21:58:40 +00:00
# Remove date used for sorting
play_lst = [x[0] for x in aired_lst]
else:
# todo-me probably will want to check limit by itself
2019-07-24 12:12:55 +00:00
if jbop == "random" and limit:
child_lst = random.sample(child_lst, limit)
2019-02-03 21:58:40 +00:00
play_lst = child_lst
2018-09-26 13:10:40 +00:00
return play_lst
2019-02-03 21:58:40 +00:00
def build_playlist(jbop, libraries=None, days=None, top=None, filters=None, search=None, limit=None):
"""
Parameters
----------
jbop: str
The predefined Playlist type
libraries: dict
{key: name}
Libraries to use to build Playlist
days: int
Days to search for Top Movies/Tv Shows
top: int
Limit to search for Top Movies/Tv Shows
Returns
-------
key_list
"""
keys_list = []
2019-02-04 04:54:55 +00:00
if jbop in ['popularTv', 'popularMovies']:
home_stats = get_home_stats(days, top)
for stat in home_stats:
if stat['stat_id'] in ['popular_tv', 'popular_movies']:
keys_list += [x['rating_key'] for x in stat['rows'] if
2021-07-16 03:20:17 +00:00
x['section_id'] in libraries.keys()]
2019-02-04 04:54:55 +00:00
else:
2019-02-03 21:58:40 +00:00
try:
keys_list = get_content(libraries, jbop, filters, search, limit)
except TypeError as e:
logger.exception("Libraries are not defined for {}. Use --libraries.".format(jbop))
exit()
return keys_list
2021-10-25 04:41:10 +00:00
def share_playlists(playlists, users):
"""
Parameters
----------
2021-10-25 04:41:10 +00:00
playlists: list
2019-01-05 06:05:30 +00:00
list of playlist titles
users: list
list of user names
"""
for user in users:
2021-10-25 04:41:10 +00:00
for playlist in playlists:
if isinstance(playlist, str):
title = playlist
else:
title = playlist.title
logger.info("...Shared {title} playlist to '{user}'.".format(title=title, user=user))
plex.playlist(title).copyToUser(user)
exit()
def show_playlist(playlist_title, playlist_keys):
"""
Parameters
----------
2019-01-05 06:05:30 +00:00
playlist_title: str
playlist's title
playlist_keys: list
list of rating keys for playlist
"""
playlist_list = []
for key in playlist_keys:
# todo-me add try to catch when Tautulli reports a rating key that is now missing from Plex
plex_obj = plex.fetchItem(key)
if plex_obj.type == 'show':
for episode in plex_obj.episodes():
title = str("{}".format(episode._prettyfilename()))
playlist_list.append(title)
2020-11-03 03:50:57 +00:00
else:
title = str("{} ({})".format(plex_obj._prettyfilename(), plex_obj.year))
playlist_list.append(title)
logger.info(u"Contents of Playlist {title}:\n{playlist}".format(
title=playlist_title,
playlist=', '.join(playlist_list)))
exit()
2018-09-26 13:10:40 +00:00
def create_playlist(playlist_title, playlist_keys, server, user):
"""
Parameters
----------
2019-01-05 06:05:30 +00:00
playlist_title: str
playlist title
playlist_keys: list
list of rating keys for playlist
server: class
server instance
user: str
users name
2018-09-26 13:10:40 +00:00
"""
playlist_list = []
for key in playlist_keys:
try:
plex_obj = server.fetchItem(key)
if plex_obj.type == 'show':
for episode in plex_obj.episodes():
playlist_list.append(episode)
else:
playlist_list.append(plex_obj)
except Exception:
try:
obj = plex.fetchItem(key)
logger.exception("{} may not have permission to this title: {}".format(user, obj.title))
pass
except Exception:
logger.exception('Rating Key: {}, may have been deleted or moved.'.format(key))
2018-09-26 13:10:40 +00:00
if playlist_list:
server.createPlaylist(playlist_title, items=playlist_list)
logger.info("...Added Playlist: {title} to '{user}'.".format(title=playlist_title, user=user))
2018-09-26 13:10:40 +00:00
def delete_playlist(playlist_dict, title, jbop=None):
2018-09-26 13:10:40 +00:00
"""
Parameters
----------
2019-02-09 06:20:41 +00:00
playlist_dict: dict
Server and user information
title: str, list
Playlist title(s)
2018-09-26 13:10:40 +00:00
"""
server = playlist_dict['server']
user = playlist_dict['user']
2018-09-26 13:10:40 +00:00
try:
# todo-me this needs improvement
2018-09-26 13:10:40 +00:00
for playlist in server.playlists():
2019-02-09 06:14:21 +00:00
if isinstance(title, str):
# If str then updating playlist
# The same title should catch popular* jbops
2019-02-09 06:14:21 +00:00
if playlist.title == title:
playlist.delete()
logger.info("...Deleted Playlist: {playlist.title} for '{user}'."
2019-02-09 06:14:21 +00:00
.format(playlist=playlist, user=user))
else:
# catching for history* jbops
titleTemplate = selectors().get(jbop)
titleStart = titleTemplate.split('{')[0]
if titleStart and playlist.title.startswith(titleStart):
playlist.delete()
logger.info("...Deleted Playlist: {playlist.title} for '{user}'."
.format(playlist=playlist, user=user))
2019-02-09 06:14:21 +00:00
if isinstance(title, list):
# If list then removing selected playlists
2020-12-10 02:02:50 +00:00
playlists_titles = [playlist if isinstance(playlist, str) else playlist.title for playlist in title]
if playlist.title in playlists_titles:
2019-02-09 06:14:21 +00:00
playlist.delete()
logger.info("...Deleted Playlist: {playlist.title} for '{user}'."
2019-02-09 06:14:21 +00:00
.format(playlist=playlist, user=user))
except Exception:
logger.exception("Playlist not found on '{user}' account".format(user=user))
2018-09-26 13:10:40 +00:00
pass
def create_title(jbop, libraries, days, filters, search, limit):
2019-02-09 06:20:41 +00:00
"""
2019-02-09 06:20:41 +00:00
Parameters
----------
jbop: str
Playlist selector
libraries: dict
Plex libraries information
days: int
Amount of days for Popular media types
filters: dict
Plex media filters
search: dict
Search terms
limit
Playlist size limit
Returns
-------
title
"""
title = ''
if jbop == 'historyToday':
title = selectors()['historyToday'].format(month=today.month, day=today.day)
elif jbop == 'historyWeek':
title = selectors()['historyWeek'].format(week=weeknum)
elif jbop == 'historyMonth':
title = selectors()['historyMonth'].format(month=today.strftime("%B"))
elif jbop == 'custom':
if search and not filters:
title_lst = []
for values in search.values():
if isinstance(values, list):
title_lst += values
else:
title_lst += [values]
title = " ".join(title_lst)
elif filters and not search:
title_lst = []
for values in filters.values():
if isinstance(values, list):
title_lst += values
else:
title_lst += [values]
title = " ".join(title_lst)
elif search and filters:
search_title = ' '.join(search.values())
filters_title = ' '.join(filters.values())
title = filters_title + ' ' + search_title
# Capitalize each word in title
title = " ".join(word.capitalize() for word in title.split())
title = selectors()['custom'].format(custom=title)
elif jbop == 'random':
if not limit:
logger.info("Random selector needs a limit. Use --limit.")
exit()
title = selectors()['random'].format(count=limit, libraries='/'.join(libraries.values()))
2019-02-19 05:10:31 +00:00
elif jbop == 'popularTv':
title = selectors()['popularTv'].format(days=days)
elif jbop == 'popularMovies':
title = selectors()['popularMovies'].format(days=days)
return title
def export_min(item):
"""
Parameters
----------
item: class
A Playlist item
Returns
-------
export_dict
"""
try:
if item.isPartialObject:
item.reload()
except:
pass
export_dict = dict()
item_dict = vars(item)
guids = []
if item.TYPE in ['track', 'episode']:
export_list = ['grandparentGuid', 'grandparentTitle', 'parentGuid', 'parentTitle', 'guid', 'title', 'guids']
else:
export_list = ['guid', 'title', 'guids']
for export in item_dict.items():
if export[0] in export_list:
if export[0] == 'guids':
for guid in export[1]:
guids.append(guid.id)
export_dict.update({'guids': guids})
else:
export_dict.update(dict([export]))
return export_dict
2018-09-26 13:10:40 +00:00
if __name__ == "__main__":
parser = argparse.ArgumentParser(
description="Create, share, and clean Playlists for users.",
formatter_class=argparse.RawTextHelpFormatter)
# todo-me use parser grouping instead of choices for action and jbop?
parser.add_argument('--jbop', choices=selectors().keys(), metavar='',
2018-09-26 13:10:40 +00:00
help='Playlist selector.\n'
'Choices: (%(choices)s)')
parser.add_argument('--action', required=True, choices=actions(),
help='Action selector.'
'{}'.format(actions.__doc__))
parser.add_argument('--users', nargs='+', choices=user_lst, metavar='',
2018-12-21 05:14:11 +00:00
help='The Plex usernames to create/share to or delete from. Allowed names are:\n'
2018-09-26 13:10:40 +00:00
'Choices: %(choices)s')
2018-10-19 03:57:42 +00:00
parser.add_argument('--allUsers', default=False, action='store_true',
help='Select all users.')
parser.add_argument('--libraries', nargs='+', choices=sections_dict.values(), metavar='',
2018-12-21 05:14:11 +00:00
help='Space separated list of case sensitive names to process. Allowed names are:\n'
2018-09-26 13:10:40 +00:00
'Choices: %(choices)s')
parser.add_argument('--allLibraries', default=False, action='store_true',
help='Select all libraries.')
2018-09-26 13:10:40 +00:00
parser.add_argument('--self', default=False, action='store_true',
2018-12-21 05:14:11 +00:00
help='Create playlist for admin.\n'
2018-09-26 13:10:40 +00:00
'Default: %(default)s')
parser.add_argument('--days', type=str, default=DAYS,
2018-12-21 05:14:11 +00:00
help='The time range to calculate statistics.\n'
2018-09-26 13:10:40 +00:00
'Default: %(default)s')
parser.add_argument('--top', type=str, default=TOP,
2018-12-21 05:14:11 +00:00
help='The number of top items to list.\n'
2018-09-26 13:10:40 +00:00
'Default: %(default)s')
parser.add_argument('--playlists', nargs='+', metavar='',
help='Enter Playlist name to be managed.')
2019-01-03 16:14:32 +00:00
parser.add_argument('--allPlaylists', default=False, action='store_true',
help='Select all playlists.')
parser.add_argument('--name', type=str,
help='Custom name for playlist.')
parser.add_argument('--limit', type=int, default=False,
help='Limit the amount items to be added to a playlist.')
parser.add_argument('--filter', action='append', type=lambda kv: kv.split("="),
2018-12-23 07:03:01 +00:00
help='Search filtered metadata fields.\n'
'Filters: ({}).'.format(', '.join(filters_lst)))
2019-02-19 15:07:59 +00:00
parser.add_argument('--search', action='append', type=lambda kv: kv.split("="),
help='Search non-filtered metadata fields for keywords '
'in title, summary, etc.')
2020-07-13 23:45:50 +00:00
parser.add_argument('--export', choices=['csv', 'json'], default='json',
help='Space separated list of case sensitive names to process. Allowed names are:\n'
'Choices: %(choices)s\nDefault: %(default)s)')
2022-04-21 18:43:28 +00:00
parser.add_argument('--importJson', nargs='?', type=str, choices=json_check, metavar='',
help='Filename of json file to use. \n(choices: %(choices)s)')
2018-09-26 13:10:40 +00:00
opts = parser.parse_args()
2019-01-01 04:38:30 +00:00
title = ''
2018-12-21 21:24:32 +00:00
search = ''
2019-01-01 04:38:30 +00:00
filters = ''
2019-01-03 16:14:32 +00:00
playlists = []
2019-01-01 04:38:30 +00:00
keys_list = []
playlist_dict = {'data': []}
if opts.search:
search = dict(opts.search)
for k, v in search.items():
# If comma separated search then consider searching values with AND statement
if "," in v:
search[k] = v.split(",")
2019-01-01 04:38:30 +00:00
if opts.filter:
if len(opts.filter) >= 2:
# Check if filter key was used twice or more
filter_key = opts.filter[0][0]
filter_count = sum(f.count(filter_key) for f in opts.filter)
# If filter key used more than once than consider filtering values with OR statement
if filter_count > 1:
filters_lst = []
2019-01-01 04:38:30 +00:00
filters = dict(opts.filter)
for k, v in filters.items():
# If comma separated filter then consider filtering values with AND statement
if "," in v:
filters[k] = v.split(",")
# Check if provided filter exist, exit if it doesn't exist
if not (set(filters.keys()) & set(filters_lst)):
logger.error('({}) was not found in filters list: [{}]'
.format(' '.join(filters.keys()), ', '.join(filters_lst)))
exit()
2018-10-19 03:57:42 +00:00
# Defining users
users = exclusions(opts.allUsers, opts.users, user_lst)
2019-01-04 18:09:43 +00:00
# Defining libraries
2019-01-04 18:09:43 +00:00
libraries = exclusions(opts.allLibraries, opts.libraries, sections_dict)
# Defining selected playlists
selected_playlists = exclusions(opts.allPlaylists, opts.playlists, admin_playlist_lst)
2018-12-21 05:14:11 +00:00
# Create user server objects
2018-10-19 03:57:42 +00:00
if users:
for user in users:
2019-02-02 14:23:54 +00:00
# todo-me smart playlists will have to recreated in users server instance
if opts.action == 'share' and selected_playlists:
logger.info("Sharing playlist(s)...")
share_playlists(selected_playlists, users)
2018-09-26 13:10:40 +00:00
user_acct = account.user(user)
user_server = PlexServer(PLEX_URL, user_acct.get_token(plex.machineIdentifier))
all_playlists = [pl for pl in user_server.playlists()]
user_selected = exclusions(opts.allPlaylists, opts.playlists, all_playlists)
playlist_dict['data'].append({
'server': user_server,
'user': user,
'user_selected': user_selected,
'all_playlists': all_playlists})
if opts.self or not users:
playlist_dict['data'].append({
'server': plex,
'user': 'admin',
'user_selected': selected_playlists,
'all_playlists': admin_playlist_lst})
if not opts.jbop and opts.action == 'show':
logger.info("Displaying the user's playlist(s)...")
2019-02-02 14:23:54 +00:00
for data in playlist_dict['data']:
user = data['user']
playlists = [playlist if isinstance(playlist, str) else playlist.title for playlist in data['all_playlists']]
logger.info("{}'s current playlist(s): {}".format(user, ', '.join(playlists)))
2019-01-05 06:07:01 +00:00
exit()
2022-04-21 18:43:28 +00:00
if libraries and opts.importJson == None:
title = create_title(opts.jbop, libraries, opts.days, filters, search, opts.limit)
keys_list = build_playlist(opts.jbop, libraries, opts.days, opts.top, filters, search, opts.limit)
2019-02-09 06:14:21 +00:00
# Remove or build playlists
if opts.action == 'remove':
logger.info("Deleting the playlist(s)...")
2019-02-09 06:14:21 +00:00
for data in playlist_dict['data']:
titles = data['user_selected']
# if no titles were selected then assume jbop, libraries, and title used
titles = titles if titles else title
2019-02-09 06:14:21 +00:00
delete_playlist(data, titles)
# Check if limit exist and if it's greater than the pulled list of rating keys
if opts.limit and len(keys_list) > int(opts.limit):
2019-02-03 21:58:40 +00:00
if opts.jbop == 'random':
keys_list = random.sample((keys_list), opts.limit)
else:
keys_list = keys_list[:opts.limit]
2019-01-03 16:14:32 +00:00
# Setting custom name if provided
if opts.name:
title = opts.name
elif not opts.name and opts.jbop in ['collection', 'label']:
logger.error("If using --jbop collection or label, "
"you must provide a custom name")
exit()
if opts.jbop and opts.action == 'show':
if len(libraries) > 0:
show_playlist(title, keys_list)
else:
logger.error("Missing --libraries or --allLibraries")
exit()
2018-09-26 13:10:40 +00:00
if opts.action == 'update':
logger.info("Deleting the playlist(s)...")
for data in playlist_dict['data']:
delete_playlist(data, title, opts.jbop)
logger.info('Creating playlist(s)...')
for data in playlist_dict['data']:
create_playlist(title, keys_list, data['server'], data['user'])
2018-09-26 13:10:40 +00:00
if opts.action == 'add':
if opts.jbop == 'collection':
logger.info('Creating collection(s)...')
for key in keys_list:
item = plex.fetchItem(int(key))
item.addCollection([title])
elif opts.jbop == 'label':
logger.info('Creating label(s)...')
for key in keys_list:
item = plex.fetchItem(int(key))
item.addLabel([title])
else:
logger.info('Creating playlist(s)...')
for data in playlist_dict['data']:
create_playlist(title, keys_list, data['server'], data['user'])
if opts.action == 'export':
logger.info("Exporting the user's playlist(s)...")
# Only import if exporting
import json
2020-07-17 18:12:47 +00:00
import csv
from flatten_json import flatten
for data in playlist_dict['data']:
user = data['user']
if data['user_selected']:
playlists = data['user_selected']
else:
playlists = data['all_playlists']
for pl in playlists:
2022-04-21 18:42:21 +00:00
logger.info("Exporting {}'s playlist: {}".format(user, pl.title))
2022-04-22 02:35:03 +00:00
pl_dict = {'title': pl.title}
if pl.smart:
pl_dict['smartFilters'] = pl.filters()
else:
pl_dict['items'] = []
items = plex.fetchItem(pl.ratingKey).items()
for item in items:
item_dict = export_min(item)
pl_dict['items'].append(item_dict)
2022-04-21 18:04:42 +00:00
title = pl.title
output_file = '{}-{}-Playlist.{}'.format(user, title, opts.export)
if opts.export == 'json':
with open(output_file, 'w') as fp:
json.dump(pl_dict, fp, indent=4, sort_keys=True)
elif opts.export == 'csv':
columns = []
data_list = []
for rows in pl_dict['items']:
flat_data = flatten(rows)
columns += list(rows)
data_list.append(rows)
2020-07-17 18:12:47 +00:00
with open(output_file, 'w', encoding='UTF-8', newline='') as data_file:
columns = sorted(list(set(columns)))
2020-07-17 18:12:47 +00:00
writer = csv.DictWriter(data_file, fieldnames=columns)
writer.writeheader()
for data in pl_dict['items']:
2020-07-17 18:12:47 +00:00
writer.writerow(data)
2022-04-21 18:43:28 +00:00
logger.info("Exported (./{})".format(output_file))
if opts.action == 'import':
if len(opts.libraries) > 1:
logger.error("Import can only use one library.")
exit()
logger.info('Using {} file to import.'.format(opts.importJson))
with open(''.join(opts.importJson)) as json_data:
import_json = json.load(json_data)
title = import_json['title']
2022-04-22 02:35:03 +00:00
section = opts.libraries[0]
if import_json.get('items'):
items = []
for item in import_json['items']:
import_library = plex.library.section(opts.libraries[0])
plex_guid = item['guid'].rsplit('/', 1)[1]
item_guid = plex.library.search(guid=item['guid'])
items += item_guid
logger.info("Total items from playlist to import: {}".format(len(items)))
for user in playlist_dict['data']:
logger.info("Importing playlist {} to user {}".format(title, user['user']))
user['server'].createPlaylist(title, section=section, items=items)
else:
logger.info("Importing Smart Playlist: {}".format(title))
limit = import_json["smartFilters"].get("limit")
libtype = import_json["smartFilters"].get("libtype")
sort = import_json["smartFilters"].get("sort")
filters = import_json["smartFilters"].get("filters")
for user in playlist_dict['data']:
logger.info("Importing playlist {} to user {}".format(title, user['user']))
user['server'].createPlaylist(title, section=section, smart=True, limit=limit,
libtype=libtype, sort=sort, filters=filters)
2022-04-21 18:43:28 +00:00
2018-09-26 13:10:40 +00:00
logger.info("Done.")