feat(shows): add support for tv shows

.github/workflows/CI.yml

@@ -181,14 +181,15 @@ jobs:
         env:
           PLEXAPI_PLEXAPI_TIMEOUT: "60"
         id: bootstrap
-        uses: LizardByte/plexhints@v2023.1226.203406
+        uses: LizardByte/plexhints@feat(action)-add-legacy-tv-agents  # todo - switch back to release version
         with:
           additional_server_queries_put: >-
             /system/agents/com.plexapp.agents.imdb/config/1?order=com.plexapp.agents.imdb%2Cdev.lizardbyte.themerr-plex
             /system/agents/com.plexapp.agents.themoviedb/config/1?order=com.plexapp.agents.themoviedb%2Cdev.lizardbyte.themerr-plex
+            /system/agents/com.plexapp.agents.themoviedb/config/2?order=com.plexapp.agents.themoviedb%2Cdev.lizardbyte.themerr-plex
+            /system/agents/com.plexapp.agents.themoviedb/config/2?order=com.plexapp.agents.thetvdb%2Cdev.lizardbyte.themerr-plex
           plugin_bundles_to_install: >-
             Themerr-plex.bundle
-          without_shows: true
           without_music: true
           without_photos: true
 
@@ -211,7 +212,6 @@ jobs:
         run: |
           python -m pytest \
             -rxXs \
-            --maxfail=1 \
             --tb=native \
             --verbose \
             --cov=Contents/Code \

Contents/Code/__init__.py

@@ -18,12 +18,12 @@
     from plexhints.decorator_kit import handler  # decorator kit
     from plexhints.locale_kit import Locale
     from plexhints.log_kit import Log  # log kit
-    from plexhints.model_kit import Movie  # model kit
+    from plexhints.model_kit import MetadataModel  # model kit
     from plexhints.object_kit import MessageContainer, MetadataSearchResult, SearchResult  # object kit
     from plexhints.prefs_kit import Prefs  # prefs kit
 
 # imports from Libraries\Shared
-from typing import Optional
+from typing import Optional, Union
 
 try:
     # get the original Python builtins module
@@ -216,9 +216,9 @@ def main():
     pass
 
 
-class Themerr(Agent.Movies):
+class Themerr(object):
     """
-    Class representing the Themerr-plex Movie Agent.
+    Class representing the Themerr-plex Agent.
 
     This class defines the metadata agent. See the archived Plex documentation
     `Defining an agent class
@@ -270,9 +270,12 @@ class Themerr(Agent.Movies):
     accepts_from = []
     contributes_to = contributes_to
 
-    @staticmethod
-    def search(results, media, lang, manual):
-        # type: (SearchResult, Media.Movie, str, bool) -> Optional[SearchResult]
+    def __init__(self, *args, **kwargs):
+        super(Themerr, self).__init__(*args, **kwargs)
+        self.agent_type = "movies" if isinstance(self, Agent.Movies) else "tv_shows"
+
+    def search(self, results, media, lang, manual):
+        # type: (SearchResult, Union[Media.Movie, Media.TV_Show], str, bool) -> Optional[SearchResult]
         """
         Search for an item.
 
@@ -286,7 +289,7 @@ def search(results, media, lang, manual):
         ----------
         results : SearchResult
             An empty container that the developer should populate with potential matches.
-        media : Media.Movie
+        media : Union[Media.Movie, Media.TV_Show]
             An object containing hints to be used when performing the search.
         lang : str
             A string identifying the user’s currently selected language. This will be one of the constants added to the
@@ -319,14 +322,18 @@ def search(results, media, lang, manual):
         if media.primary_agent == 'dev.lizardbyte.retroarcher-plex':
             media_id = 'games-%s' % re.search(r'((igdb)-(\d+))', media.primary_metadata.id).group(1)
         else:
-            media_id = 'movies-%s-%s' % (media.primary_agent.rsplit('.', 1)[-1], media.primary_metadata.id)
+            media_id = '{}-{}-{}'.format(
+                self.agent_type,
+                media.primary_agent.rsplit('.', 1)[-1],
+                media.primary_metadata.id
+            )
             # e.g. = 'movies-imdb-tt0113189'
             # e.g. = 'movies-themoviedb-710'
 
         results.Append(MetadataSearchResult(
             id=media_id,
             name=media.primary_metadata.title,
-            year=media.primary_metadata.year,
+            year=getattr(media.primary_metadata, 'year', None),  # TV Shows don't have a year attribute
             score=100,
             lang=lang,  # no lang to get from db
             thumb=None  # no point in adding thumb since plex won't show it anywhere
@@ -339,7 +346,7 @@ def search(results, media, lang, manual):
 
     @staticmethod
     def update(metadata, media, lang, force):
-        # type: (Movie, Media.Movie, str, bool) -> Optional[Movie]
+        # type: (MetadataModel, Union[Media.Movie, Media.TV_Show], str, bool) -> MetadataModel
         """
         Update metadata for an item.
 
@@ -351,10 +358,10 @@ def update(metadata, media, lang, force):
 
         Parameters
         ----------
-        metadata : object
+        metadata : MetadataModel
             A pre-initialized metadata object if this is the first time the item is being updated, or the existing
             metadata object if the item is being refreshed.
-        media : object
+        media : Union[Media.Movie, Media.TV_Show]
             An object containing information about the media hierarchy in the database.
         lang : str
             A string identifying which language should be used for the metadata. This will be one of the constants
@@ -363,6 +370,11 @@ def update(metadata, media, lang, force):
             A boolean value identifying whether the user forced a full refresh of the metadata. If this argument is
             ``True``, all metadata should be refreshed, regardless of whether it has been populated previously.
 
+        Returns
+        -------
+        MetadataModel
+            The metadata object.
+
         Examples
         --------
         >>> Themerr().update(metadata=..., media=..., lang='en', force=True)
@@ -375,3 +387,11 @@ def update(metadata, media, lang, force):
         update_plex_item(rating_key=rating_key)
 
         return metadata
+
+
+class ThemerrMovies(Themerr, Agent.Movies):
+    agent_type_verbose = "Movies"
+
+
+class ThemerrTvShows(Themerr, Agent.TV_Shows):
+    agent_type_verbose = "TV"

Contents/Code/constants.py

@@ -41,11 +41,12 @@
 themerr_data_directory = os.path.join(plugin_support_data_directory, plugin_identifier, 'DataItems')
 
 contributes_to = [
-    'tv.plex.agents.movie',
-    'com.plexapp.agents.imdb',
-    'com.plexapp.agents.themoviedb',
-    # 'com.plexapp.agents.thetvdb',  # not available as movie agent
-    'dev.lizardbyte.retroarcher-plex'
+    'tv.plex.agents.movie',  # new movie agent
+    'tv.plex.agents.series',  # new tv show agent
+    'com.plexapp.agents.imdb',  # legacy movie agent
+    'com.plexapp.agents.themoviedb',  # legacy movie and tv show agent
+    'com.plexapp.agents.thetvdb',  # legacy tv show agent
+    'dev.lizardbyte.retroarcher-plex'  # retroarcher plugin
 ]
 
 guid_map = dict(
@@ -73,13 +74,15 @@
     game_franchises='[GAME FRANCHISE]: ',
     movies='[MOVIE]: ',
     movie_collections='[MOVIE COLLECTION]: ',
+    tv_shows='[TV SHOW]: ',
 )
 url_prefix = dict(
     games='https://www.igdb.com/games/',
     game_collections='https://www.igdb.com/collections/',
     game_franchises='https://www.igdb.com/franchises/',
     movies='https://www.themoviedb.org/movie/',
     movie_collections='https://www.themoviedb.org/collection/',
+    tv_shows='https://www.themoviedb.org/tv/',
 )
 
 # two additional strings to fill in later, item title and item url
@@ -97,6 +100,8 @@
     movie_collections='{}&labels={}&template={}&title={}{}&{}={}{}'.format(
         base_url, issue_label, issue_template, title_prefix['movie_collections'], '{}', url_name,
         url_prefix['movie_collections'], '{}'),
+    tv_shows='{}&labels={}&template={}&title={}{}&{}={}{}'.format(
+        base_url, issue_label, issue_template, title_prefix['tv_shows'], '{}', url_name, url_prefix['tv_shows'], '{}'),
 )
 
 media_type_dict = dict(

Contents/Code/default_prefs.py

@@ -8,6 +8,7 @@
     bool_remove_unused_posters='False',
     bool_auto_update_items='True',
     bool_auto_update_movie_themes='True',
+    bool_auto_update_tv_themes='True',
     bool_auto_update_collection_themes='True',
     bool_update_collection_metadata_plex_movie='False',
     bool_update_collection_metadata_legacy='True',

Contents/Code/plex_api_helper.py

@@ -503,6 +503,26 @@
                 database = 'imdb'
                 database_id = item.guid.split('://')[1].split('?')[0]
 
+    elif item.type == 'show':
+        split_guid = item.guid.split('://')
+        agent = split_guid[0]
+        if agent == 'com.plexapp.agents.themoviedb':
+            database_type = 'tv_shows'
+            database = 'themoviedb'
+            database_id = item.guid.split('://')[1].split('?')[0]
+        elif agent == 'com.plexapp.agents.thetvdb':
+            database_type = 'tv_shows'
+            temp_database = 'thetvdb'
+            temp_database_id = item.guid.split('://')[1].split('?')[0]
+
+            # ThemerrDB does not have TVDB IDs, so we need to convert it to TMDB ID
+            database_id = tmdb_helper.get_tmdb_id_from_external_id(
+                external_id=temp_database_id,
+                database='tvdb',
+                item_type='tv',
+            )
+            database = 'themoviedb' if database_id else None
+
     elif item.type == 'collection':
         # this is tricky since collections don't match up with any of the databases
         # we'll use the collection title and try to find a match
@@ -715,15 +735,20 @@
                 Log.Debug('Themerr-plex is disabled for agent "{}"'.format(section.agent))
                 continue
 
+        all_items = []
+
         # get all the items in the section
-        media_items = section.all() if Prefs['bool_auto_update_movie_themes'] else []
+        if section.type == 'movie':
+            media_items = section.all() if Prefs['bool_auto_update_movie_themes'] else []
 
-        # get all collections in the section
-        collections = section.collections() if Prefs['bool_auto_update_collection_themes'] else []
+            # get all collections in the section
+            collections = section.collections() if Prefs['bool_auto_update_collection_themes'] else []
 
-        # combine the items and collections into one list
-        # this is done so that we can process both items and collections in the same loop
-        all_items = media_items + collections
+            # combine the items and collections into one list
+            # this is done so that we can process both items and collections in the same loop
+            all_items = media_items + collections
+        elif section.type == 'show':
+            all_items = section.all() if Prefs['bool_auto_update_tv_themes'] else []
 
         for item in all_items:
             if item.ratingKey not in q.queue:

Contents/Code/themerr_db_helper.py

@@ -25,6 +25,7 @@
     game_franchises={'igdb': 'id'},
     movies={'themoviedb': 'id', 'imdb': 'imdb_id'},
     movie_collections={'themoviedb': 'id'},
+    tv_shows={'themoviedb': 'id'},
 )
 
 lock = Lock()

Contents/Code/tmdb_helper.py

@@ -18,17 +18,21 @@
 tmdb_base_url = 'http://127.0.0.1:32400/services/tmdb?uri='
 
 
-def get_tmdb_id_from_imdb_id(imdb_id):
-    # type: (str) -> Optional[int]
+def get_tmdb_id_from_external_id(external_id, database, item_type):
+    # type: (str, str, str) -> Optional[int]
     """
     Convert IMDB ID to TMDB ID.
 
     Use the builtin Plex tmdb api service to search for a movie by IMDB ID.
 
     Parameters
     ----------
-    imdb_id : str
-        IMDB ID to convert.
+    external_id : str
+        External ID to convert.
+    database : str
+        Database to search. Must be one of 'imdb' or 'tvdb'.
+    item_type : str
+        Item type to search. Must be one of 'movie' or 'tv'.
 
     Returns
     -------
@@ -37,25 +41,38 @@
 
     Examples
     --------
-    >>> get_tmdb_id_from_imdb_id(imdb_id='tt1254207')
+    >>> get_tmdb_id_from_external_id(imdb_id='tt1254207', database='imdb', item_type='movie')
     10378
+    >>> get_tmdb_id_from_external_id(imdb_id='268592', database='tvdb', item_type='tv')
+    48866
     """
-    # according to https://www.themoviedb.org/talk/5f6a0500688cd000351c1712 we can search by imdb id
+    if database.lower() not in ['imdb', 'tvdb']:
+        Log.Exception('Invalid database: {}'.format(database))
+        return
+    if item_type.lower() not in ['movie', 'tv']:
+        Log.Exception('Invalid item type: {}'.format(item_type))
+        return
+
+    # according to https://www.themoviedb.org/talk/5f6a0500688cd000351c1712 we can search by external id
     # https://api.themoviedb.org/3/find/tt0458290?api_key=###&external_source=imdb_id
-    find_imdb_item = 'find/{}?external_source=imdb_id'
+    find_imdb_item = 'find/{}?external_source={}_id'
 
-    url = '{}/{}'.format(tmdb_base_url, find_imdb_item.format(String.Quote(s=imdb_id, usePlus=True)))
+    url = '{}/{}'.format(
+        tmdb_base_url,
+        find_imdb_item.format(String.Quote(s=external_id, usePlus=True), database.lower())
+    )
     try:
         tmdb_data = JSON.ObjectFromURL(
             url=url, sleep=2.0, headers=dict(Accept='application/json'), cacheTime=CACHE_1DAY, errors='strict')
     except Exception as e:
-        Log.Debug('Error converting IMDB ID to TMDB ID: {}'.format(e))
+        Log.Debug('Error converting external ID to TMDB ID: {}'.format(e))
     else:
         Log.Debug('TMDB data: {}'.format(tmdb_data))
         try:
-            tmdb_id = int(tmdb_data['movie_results'][0]['id'])  # this is already an integer, but let's force it
+            # this is already an integer, but let's force it
+            tmdb_id = int(tmdb_data['{}_results'.format(item_type.lower())][0]['id'])
         except (IndexError, KeyError, ValueError):
-            Log.Debug('Error converting IMDB ID to TMDB ID: {}'.format(tmdb_data))
+            Log.Debug('Error converting external ID to TMDB ID: {}'.format(tmdb_data))
         else:
             return tmdb_id
 

Contents/Code/webapp.py

@@ -271,7 +271,14 @@
                     or database_id.startswith('tt')
             ):
                 # try to get tmdb id from imdb id
-                tmdb_id = tmdb_helper.get_tmdb_id_from_imdb_id(imdb_id=database_id)
+                tmdb_id = tmdb_helper.get_tmdb_id_from_external_id(
+                    external_id=database_id, database='imdb', item_type='movie')
+                database_id = tmdb_id if tmdb_id else None
+
+            elif item.type == 'show' and item_agent == 'com.plexapp.agents.tvdb':
+                # try to get tmdb id from tvdb id
+                tmdb_id = tmdb_helper.get_tmdb_id_from_external_id(
+                    external_id=database_id, database='tvdb', item_type='tv')
                 database_id = tmdb_id if tmdb_id else None
 
             item_issue_url = None
@@ -300,6 +307,8 @@
                             database_id = None
                     else:
                         issue_title = '{} ({})'.format(getattr(item, "originalTitle", None) or item.title, year)
+                elif item.type == 'show':
+                    issue_title = '{} ({})'.format(item.title, year)
                 else:  # collections
                     issue_title = item.title
 

Contents/DefaultPrefs.json

@@ -48,6 +48,13 @@
 		"default": "True",
 		"secure": "false"
 	},
+	{
+		"id": "bool_auto_update_tv_themes",
+		"type": "bool",
+		"label": "Update tv show themes during automatic update",
+		"default": "True",
+		"secure": "false"
+	},
 	{
 		"id": "bool_auto_update_collection_themes",
 		"type": "bool",

docs/source/about/usage.rst

@@ -131,6 +131,15 @@ Description
 Default
    ``True``
 
+Update tv show themes during automatic update
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Description
+   When enabled, Themerr-plex will update tv show themes during automatic updates.
+
+Default
+   ``True``
+
 Update collection themes during automatic update
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^