mirror of
https://github.com/pkkid/python-plexapi
synced 2024-11-25 21:20:18 +00:00
401 lines
13 KiB
Python
401 lines
13 KiB
Python
# -*- coding: utf-8 -*-
|
|
from urllib.parse import quote_plus, urlencode
|
|
|
|
from plexapi import media, utils
|
|
from plexapi.exceptions import NotFound
|
|
|
|
|
|
class ArtMixin(object):
|
|
""" Mixin for Plex objects that can have artwork."""
|
|
|
|
def arts(self):
|
|
""" Returns list of available :class:`~plexapi.media.Art` objects. """
|
|
return self.fetchItems('/library/metadata/%s/arts' % self.ratingKey, cls=media.Art)
|
|
|
|
def uploadArt(self, url=None, filepath=None):
|
|
""" Upload art from url or filepath and set it as the selected art.
|
|
|
|
Parameters:
|
|
url (str): The full URL to the image to upload.
|
|
filepath (str): The full file path the the image to upload.
|
|
"""
|
|
if url:
|
|
key = '/library/metadata/%s/arts?url=%s' % (self.ratingKey, quote_plus(url))
|
|
self._server.query(key, method=self._server._session.post)
|
|
elif filepath:
|
|
key = '/library/metadata/%s/arts?' % self.ratingKey
|
|
data = open(filepath, 'rb').read()
|
|
self._server.query(key, method=self._server._session.post, data=data)
|
|
|
|
def setArt(self, art):
|
|
""" Set the artwork for a Plex object.
|
|
|
|
Parameters:
|
|
art (:class:`~plexapi.media.Art`): The art object to select.
|
|
"""
|
|
art.select()
|
|
|
|
|
|
class PosterMixin(object):
|
|
""" Mixin for Plex objects that can have posters."""
|
|
|
|
def posters(self):
|
|
""" Returns list of available :class:`~plexapi.media.Poster` objects. """
|
|
return self.fetchItems('/library/metadata/%s/posters' % self.ratingKey, cls=media.Poster)
|
|
|
|
def uploadPoster(self, url=None, filepath=None):
|
|
""" Upload poster from url or filepath and set it as the selected poster.
|
|
|
|
Parameters:
|
|
url (str): The full URL to the image to upload.
|
|
filepath (str): The full file path the the image to upload.
|
|
"""
|
|
if url:
|
|
key = '/library/metadata/%s/posters?url=%s' % (self.ratingKey, quote_plus(url))
|
|
self._server.query(key, method=self._server._session.post)
|
|
elif filepath:
|
|
key = '/library/metadata/%s/posters?' % self.ratingKey
|
|
data = open(filepath, 'rb').read()
|
|
self._server.query(key, method=self._server._session.post, data=data)
|
|
|
|
def setPoster(self, poster):
|
|
""" Set the poster for a Plex object.
|
|
|
|
Parameters:
|
|
poster (:class:`~plexapi.media.Poster`): The poster object to select.
|
|
"""
|
|
poster.select()
|
|
|
|
|
|
class SplitMergeMixin(object):
|
|
""" Mixin for Plex objects that can be split and merged."""
|
|
|
|
def split(self):
|
|
""" Split duplicated Plex object into separate objects. """
|
|
key = '/library/metadata/%s/split' % self.ratingKey
|
|
return self._server.query(key, method=self._server._session.put)
|
|
|
|
def merge(self, ratingKeys):
|
|
""" Merge other Plex objects into the current object.
|
|
|
|
Parameters:
|
|
ratingKeys (list): A list of rating keys to merge.
|
|
"""
|
|
if not isinstance(ratingKeys, list):
|
|
ratingKeys = str(ratingKeys).split(',')
|
|
|
|
key = '%s/merge?ids=%s' % (self.key, ','.join([str(r) for r in ratingKeys]))
|
|
return self._server.query(key, method=self._server._session.put)
|
|
|
|
|
|
class UnmatchMatchMixin(object):
|
|
""" Mixin for Plex objects that can be unmatched and matched."""
|
|
|
|
def unmatch(self):
|
|
""" Unmatches metadata match from object. """
|
|
key = '/library/metadata/%s/unmatch' % self.ratingKey
|
|
self._server.query(key, method=self._server._session.put)
|
|
|
|
def matches(self, agent=None, title=None, year=None, language=None):
|
|
""" Return list of (:class:`~plexapi.media.SearchResult`) metadata matches.
|
|
|
|
Parameters:
|
|
agent (str): Agent name to be used (imdb, thetvdb, themoviedb, etc.)
|
|
title (str): Title of item to search for
|
|
year (str): Year of item to search in
|
|
language (str) : Language of item to search in
|
|
|
|
Examples:
|
|
1. video.matches()
|
|
2. video.matches(title="something", year=2020)
|
|
3. video.matches(title="something")
|
|
4. video.matches(year=2020)
|
|
5. video.matches(title="something", year="")
|
|
6. video.matches(title="", year=2020)
|
|
7. video.matches(title="", year="")
|
|
|
|
1. The default behaviour in Plex Web = no params in plexapi
|
|
2. Both title and year specified by user
|
|
3. Year automatically filled in
|
|
4. Title automatically filled in
|
|
5. Explicitly searches for title with blank year
|
|
6. Explicitly searches for blank title with year
|
|
7. I don't know what the user is thinking... return the same result as 1
|
|
|
|
For 2 to 7, the agent and language is automatically filled in
|
|
"""
|
|
key = '/library/metadata/%s/matches' % self.ratingKey
|
|
params = {'manual': 1}
|
|
|
|
if agent and not any([title, year, language]):
|
|
params['language'] = self.section().language
|
|
params['agent'] = utils.getAgentIdentifier(self.section(), agent)
|
|
else:
|
|
if any(x is not None for x in [agent, title, year, language]):
|
|
if title is None:
|
|
params['title'] = self.title
|
|
else:
|
|
params['title'] = title
|
|
|
|
if year is None:
|
|
params['year'] = self.year
|
|
else:
|
|
params['year'] = year
|
|
|
|
params['language'] = language or self.section().language
|
|
|
|
if agent is None:
|
|
params['agent'] = self.section().agent
|
|
else:
|
|
params['agent'] = utils.getAgentIdentifier(self.section(), agent)
|
|
|
|
key = key + '?' + urlencode(params)
|
|
data = self._server.query(key, method=self._server._session.get)
|
|
return self.findItems(data, initpath=key)
|
|
|
|
def fixMatch(self, searchResult=None, auto=False, agent=None):
|
|
""" Use match result to update show metadata.
|
|
|
|
Parameters:
|
|
auto (bool): True uses first match from matches
|
|
False allows user to provide the match
|
|
searchResult (:class:`~plexapi.media.SearchResult`): Search result from
|
|
~plexapi.base.matches()
|
|
agent (str): Agent name to be used (imdb, thetvdb, themoviedb, etc.)
|
|
"""
|
|
key = '/library/metadata/%s/match' % self.ratingKey
|
|
if auto:
|
|
autoMatch = self.matches(agent=agent)
|
|
if autoMatch:
|
|
searchResult = autoMatch[0]
|
|
else:
|
|
raise NotFound('No matches found using this agent: (%s:%s)' % (agent, autoMatch))
|
|
elif not searchResult:
|
|
raise NotFound('fixMatch() requires either auto=True or '
|
|
'searchResult=:class:`~plexapi.media.SearchResult`.')
|
|
|
|
params = {'guid': searchResult.guid,
|
|
'name': searchResult.name}
|
|
|
|
data = key + '?' + urlencode(params)
|
|
self._server.query(data, method=self._server._session.put)
|
|
|
|
|
|
class CollectionMixin(object):
|
|
""" Mixin for Plex objects that can have collections. """
|
|
|
|
def addCollection(self, collections):
|
|
""" Add a collection tag(s).
|
|
|
|
Parameters:
|
|
collections (list): List of strings.
|
|
"""
|
|
self._edit_tags('collection', collections)
|
|
|
|
def removeCollection(self, collections):
|
|
""" Remove a collection tag(s).
|
|
|
|
Parameters:
|
|
collections (list): List of strings.
|
|
"""
|
|
self._edit_tags('collection', collections, remove=True)
|
|
|
|
|
|
class CountryMixin(object):
|
|
""" Mixin for Plex objects that can have countries. """
|
|
|
|
def addCountry(self, countries):
|
|
""" Add a country tag(s).
|
|
|
|
Parameters:
|
|
countries (list): List of strings.
|
|
"""
|
|
self._edit_tags('country', countries)
|
|
|
|
def removeCountry(self, countries):
|
|
""" Remove a country tag(s).
|
|
|
|
Parameters:
|
|
countries (list): List of strings.
|
|
"""
|
|
self._edit_tags('country', countries, remove=True)
|
|
|
|
|
|
class DirectorMixin(object):
|
|
""" Mixin for Plex objects that can have directors. """
|
|
|
|
def addDirector(self, directors):
|
|
""" Add a director tag(s).
|
|
|
|
Parameters:
|
|
directors (list): List of strings.
|
|
"""
|
|
self._edit_tags('director', directors)
|
|
|
|
def removeDirector(self, directors):
|
|
""" Remove a director tag(s).
|
|
|
|
Parameters:
|
|
directors (list): List of strings.
|
|
"""
|
|
self._edit_tags('director', directors, remove=True)
|
|
|
|
|
|
class GenreMixin(object):
|
|
""" Mixin for Plex objects that can have genres. """
|
|
|
|
def addGenre(self, genres):
|
|
""" Add a genre tag(s).
|
|
|
|
Parameters:
|
|
genres (list): List of strings.
|
|
"""
|
|
self._edit_tags('genre', genres)
|
|
|
|
def removeGenre(self, genres):
|
|
""" Remove a genre tag(s).
|
|
|
|
Parameters:
|
|
genres (list): List of strings.
|
|
"""
|
|
self._edit_tags('genre', genres, remove=True)
|
|
|
|
|
|
class LabelMixin(object):
|
|
""" Mixin for Plex objects that can have labels. """
|
|
|
|
def addLabel(self, labels):
|
|
""" Add a label tag(s).
|
|
|
|
Parameters:
|
|
labels (list): List of strings.
|
|
"""
|
|
self._edit_tags('label', labels)
|
|
|
|
def removeLabel(self, labels):
|
|
""" Remove a label tag(s).
|
|
|
|
Parameters:
|
|
labels (list): List of strings.
|
|
"""
|
|
self._edit_tags('label', labels, remove=True)
|
|
|
|
|
|
class MoodMixin(object):
|
|
""" Mixin for Plex objects that can have moods. """
|
|
|
|
def addMood(self, moods):
|
|
""" Add a mood tag(s).
|
|
|
|
Parameters:
|
|
moods (list): List of strings.
|
|
"""
|
|
self._edit_tags('mood', moods)
|
|
|
|
def removeMood(self, moods):
|
|
""" Remove a mood tag(s).
|
|
|
|
Parameters:
|
|
moods (list): List of strings.
|
|
"""
|
|
self._edit_tags('mood', moods, remove=True)
|
|
|
|
|
|
class ProducerMixin(object):
|
|
""" Mixin for Plex objects that can have producers. """
|
|
|
|
def addProducer(self, producers):
|
|
""" Add a producer tag(s).
|
|
|
|
Parameters:
|
|
producers (list): List of strings.
|
|
"""
|
|
self._edit_tags('producer', producers)
|
|
|
|
def removeProducer(self, producers):
|
|
""" Remove a producer tag(s).
|
|
|
|
Parameters:
|
|
producers (list): List of strings.
|
|
"""
|
|
self._edit_tags('producer', producers, remove=True)
|
|
|
|
|
|
class SimilarArtistMixin(object):
|
|
""" Mixin for Plex objects that can have similar artists. """
|
|
|
|
def addSimilarArtist(self, artists):
|
|
""" Add a similar artist tag(s).
|
|
|
|
Parameters:
|
|
artists (list): List of strings.
|
|
"""
|
|
self._edit_tags('similar', artists)
|
|
|
|
def removeSimilarArtist(self, artists):
|
|
""" Remove a similar artist tag(s).
|
|
|
|
Parameters:
|
|
artists (list): List of strings.
|
|
"""
|
|
self._edit_tags('similar', artists, remove=True)
|
|
|
|
|
|
class StyleMixin(object):
|
|
""" Mixin for Plex objects that can have styles. """
|
|
|
|
def addStyle(self, styles):
|
|
""" Add a style tag(s).
|
|
|
|
Parameters:
|
|
styles (list): List of strings.
|
|
"""
|
|
self._edit_tags('style', styles)
|
|
|
|
def removeStyle(self, styles):
|
|
""" Remove a style tag(s).
|
|
|
|
Parameters:
|
|
styles (list): List of strings.
|
|
"""
|
|
self._edit_tags('style', styles, remove=True)
|
|
|
|
|
|
class TagMixin(object):
|
|
""" Mixin for Plex objects that can have tags. """
|
|
|
|
def addTag(self, tags):
|
|
""" Add a tag(s).
|
|
|
|
Parameters:
|
|
tags (list): List of strings.
|
|
"""
|
|
self._edit_tags('tag', tags)
|
|
|
|
def removeTag(self, tags):
|
|
""" Remove a tag(s).
|
|
|
|
Parameters:
|
|
tags (list): List of strings.
|
|
"""
|
|
self._edit_tags('tag', tags, remove=True)
|
|
|
|
|
|
class EditWriter(object):
|
|
""" Mixin for Plex objects that can have writers. """
|
|
|
|
def addWriter(self, writers):
|
|
""" Add a writer tag(s).
|
|
|
|
Parameters:
|
|
writers (list): List of strings.
|
|
"""
|
|
self._edit_tags('writer', writers)
|
|
|
|
def removeWriter(self, writers):
|
|
""" Remove a writer tag(s).
|
|
|
|
Parameters:
|
|
writers (list): List of strings.
|
|
"""
|
|
self._edit_tags('writer', writers, remove=True)
|