Add categories and clips (#23)

Author: michaelarnauts

resources/language/resource.language.en_gb/strings.po

@@ -64,6 +64,22 @@ msgctxt "#30056"
 msgid "Browse the Catalog for [B]{channel}[/B]"
 msgstr ""
 
+msgctxt "#30057"
+msgid "Categories for [B]{channel}[/B]"
+msgstr ""
+
+msgctxt "#30058"
+msgid "Browse the Categories for [B]{channel}[/B]"
+msgstr ""
+
+msgctxt "#30059"
+msgid "Clips of [B]{program}[/B]"
+msgstr ""
+
+msgctxt "#30060"
+msgid "Watch short clips of [B]{program}[/B]"
+msgstr ""
+
 
 ### CONTEXT MENU
 msgctxt "#30102"

resources/language/resource.language.nl_nl/strings.po

@@ -65,6 +65,22 @@ msgctxt "#30056"
 msgid "Browse the Catalog for [B]{channel}[/B]"
 msgstr "Doorblader de catalogus voor [B]{channel}[/B]"
 
+msgctxt "#30057"
+msgid "Categories for [B]{channel}[/B]"
+msgstr "Categoriën voor [B]{channel}[/B]"
+
+msgctxt "#30058"
+msgid "Browse the Categories for [B]{channel}[/B]"
+msgstr "Doorblader de categoriën van [B]{channel}[/B]"
+
+msgctxt "#30059"
+msgid "Clips of [B]{program}[/B]"
+msgstr "Clips van [B]{program}[/B]"
+
+msgctxt "#30060"
+msgid "Watch short clips of [B]{program}[/B]"
+msgstr "Bekijk korte videoclips van [B]{program}[/B]"
+
 
 ### CONTEXT MENU
 msgctxt "#30102"

resources/lib/addon.py

@@ -35,18 +35,32 @@ def show_channel_menu(channel):
     Channels().show_channel_menu(channel)
 
 
-@routing.route('/tvguide/channel/<channel>')
-def show_tvguide_channel(channel):
+@routing.route('/channels/<channel>/categories')
+def show_channel_categories(channel):
+    """ Shows TV Channel categories """
+    from resources.lib.modules.channels import Channels
+    Channels().show_channel_categories(channel)
+
+
+@routing.route('/channels/<channel>/categories/<category>')
+def show_channel_category(channel, category):
+    """ Shows TV Channel categories """
+    from resources.lib.modules.channels import Channels
+    Channels().show_channel_category(channel, category)
+
+
+@routing.route('/channels/<channel>/tvguide')
+def show_channel_tvguide(channel):
     """ Shows the dates in the tv guide """
     from resources.lib.modules.tvguide import TvGuide
-    TvGuide().show_tvguide_channel(channel)
+    TvGuide().show_channel(channel)
 
 
-@routing.route('/tvguide/channel/<channel>/<date>')
-def show_tvguide_detail(channel=None, date=None):
+@routing.route('/channels/<channel>/tvguide/<date>')
+def show_channel_tvguide_detail(channel=None, date=None):
     """ Shows the programs of a specific date in the tv guide """
     from resources.lib.modules.tvguide import TvGuide
-    TvGuide().show_tvguide_detail(channel, date)
+    TvGuide().show_detail(channel, date)
 
 
 @routing.route('/catalog')
@@ -56,23 +70,30 @@ def show_catalog():
     Catalog().show_catalog()
 
 
-@routing.route('/catalog/by-channel/<channel>')
-def show_catalog_channel(channel):
+@routing.route('/catalog/<channel>')
+def show_channel_catalog(channel):
     """ Show a category in the catalog """
     from resources.lib.modules.catalog import Catalog
     Catalog().show_catalog_channel(channel)
 
 
-@routing.route('/catalog/program/<channel>/<program>')
+@routing.route('/catalog/<channel>/<program>')
 def show_catalog_program(channel, program):
     """ Show a program from the catalog """
     from resources.lib.modules.catalog import Catalog
     Catalog().show_program(channel, program)
 
 
-@routing.route('/catalog/program/<channel>/<program>/<season>')
+@routing.route('/catalog/<channel>/<program>/clips')
+def show_catalog_program_clips(channel, program):
+    """ Show the clips from a program """
+    from resources.lib.modules.catalog import Catalog
+    Catalog().show_program_clips(channel, program)
+
+
+@routing.route('/catalog/<channel>/<program>/season/<season>')
 def show_catalog_program_season(channel, program, season):
-    """ Show a program from the catalog """
+    """ Show a season from a program """
     from resources.lib.modules.catalog import Catalog
     Catalog().show_program_season(channel, program, season)
 

resources/lib/modules/catalog.py

@@ -22,7 +22,6 @@ def __init__(self):
         """ Initialise object """
         auth = AuthApi(kodiutils.get_setting('username'), kodiutils.get_setting('password'), kodiutils.get_tokens_path())
         self._api = ContentApi(auth, cache_path=kodiutils.get_cache_path())
-        self._menu = Menu()
 
     def show_catalog(self):
         """ Show all the programs of all channels """
@@ -34,7 +33,7 @@ def show_catalog(self):
             kodiutils.notification(message=str(ex))
             raise
 
-        listing = [self._menu.generate_titleitem(item) for item in items]
+        listing = [Menu.generate_titleitem(item) for item in items]
 
         # Sort items by title
         # Used for A-Z listing or when movies and episodes are mixed.
@@ -52,7 +51,7 @@ def show_catalog_channel(self, channel):
 
         listing = []
         for item in items:
-            listing.append(self._menu.generate_titleitem(item))
+            listing.append(Menu.generate_titleitem(item))
 
         # Sort items by title
         # Used for A-Z listing or when movies and episodes are mixed.
@@ -64,19 +63,19 @@ def show_program(self, channel, program_id):
         :type program_id: str
          """
         try:
-            program = self._api.get_program(channel, program_id, cache=CACHE_PREVENT)  # Use CACHE_PREVENT since we want fresh data
+            program = self._api.get_program(channel, program_id, extract_clips=True, cache=CACHE_PREVENT)  # Use CACHE_PREVENT since we want fresh data
         except UnavailableException:
             kodiutils.ok_dialog(message=kodiutils.localize(30717))  # This program is not available in the catalogue.
             kodiutils.end_of_directory()
             return
 
-        if not program.episodes:
+        if not program.episodes and not program.clips:
             kodiutils.ok_dialog(message=kodiutils.localize(30717))  # This program is not available in the catalogue.
             kodiutils.end_of_directory()
             return
 
-        # Go directly to the season when we have only one season
-        if len(program.seasons) == 1:
+        # Go directly to the season when we have only one season and no clips
+        if not program.clips and len(program.seasons) == 1:
             self.show_program_season(channel, program_id, list(program.seasons.values())[0].uuid)
             return
 
@@ -85,7 +84,7 @@ def show_program(self, channel, program_id):
         listing = []
 
         # Add an '* All seasons' entry when configured in Kodi
-        if kodiutils.get_global_setting('videolibrary.showallitems') is True:
+        if program.seasons and kodiutils.get_global_setting('videolibrary.showallitems') is True:
             listing.append(
                 TitleItem(
                     title='* %s' % kodiutils.localize(30204),  # * All seasons
@@ -122,6 +121,25 @@ def show_program(self, channel, program_id):
                 )
             )
 
+        # Add Clips
+        if program.clips:
+            listing.append(
+                TitleItem(
+                    title=kodiutils.localize(30059, program=program.title),  # Clips for {program}
+                    path=kodiutils.url_for('show_catalog_program_clips', channel=channel, program=program_id),
+                    art_dict={
+                        'fanart': program.background,
+                    },
+                    info_dict={
+                        'tvshowtitle': program.title,
+                        'title': kodiutils.localize(30059, program=program.title),  # Clips for {program}
+                        'plot': kodiutils.localize(30060, program=program.title),  # Watch short clips of {program}
+                        'set': program.title,
+                        'studio': studio,
+                    }
+                )
+            )
+
         # Sort by label. Some programs return seasons unordered.
         kodiutils.show_listing(listing, 30003, content='tvshows')
 
@@ -145,7 +163,25 @@ def show_program_season(self, channel, program_id, season_uuid):
             # Show the episodes of the season that was selected
             episodes = [e for e in program.episodes if e.season_uuid == season_uuid]
 
-        listing = [self._menu.generate_titleitem(episode) for episode in episodes]
+        listing = [Menu.generate_titleitem(episode) for episode in episodes]
 
         # Sort by episode number by default. Takes seasons into account.
         kodiutils.show_listing(listing, 30003, content='episodes', sort=['episode', 'duration'])
+
+    def show_program_clips(self, channel, program_id):
+        """ Show the clips of a program from the catalog
+        :type channel: str
+        :type program_id: str
+        """
+        try:
+            # We need to query the backend, since we don't cache clips.
+            program = self._api.get_program(channel, program_id, extract_clips=True, cache=CACHE_PREVENT)
+        except UnavailableException:
+            kodiutils.ok_dialog(message=kodiutils.localize(30717))  # This program is not available in the catalogue.
+            kodiutils.end_of_directory()
+            return
+
+        listing = [Menu.generate_titleitem(episode) for episode in program.clips]
+
+        # Sort like we get our results back.
+        kodiutils.show_listing(listing, 30003, content='episodes')

resources/lib/modules/channels.py

@@ -7,7 +7,10 @@
 
 from resources.lib import kodiutils
 from resources.lib.kodiutils import TitleItem
+from resources.lib.modules.menu import Menu
 from resources.lib.viervijfzes import CHANNELS, STREAM_DICT
+from resources.lib.viervijfzes.auth import AuthApi
+from resources.lib.viervijfzes.content import ContentApi, CACHE_ONLY, CACHE_AUTO
 
 _LOGGER = logging.getLogger('channels')
 
@@ -17,6 +20,8 @@ class Channels:
 
     def __init__(self):
         """ Initialise object """
+        auth = AuthApi(kodiutils.get_setting('username'), kodiutils.get_setting('password'), kodiutils.get_tokens_path())
+        self._api = ContentApi(auth, cache_path=kodiutils.get_cache_path())
 
     @staticmethod
     def show_channels():
@@ -33,7 +38,7 @@ def show_channels():
                 (
                     kodiutils.localize(30053, channel=channel.get('name')),  # TV Guide for {channel}
                     'Container.Update(%s)' %
-                    kodiutils.url_for('show_tvguide_channel', channel=channel.get('epg'))
+                    kodiutils.url_for('show_channel_tvguide', channel=channel.get('epg'))
                 )
             ]
 
@@ -60,43 +65,54 @@ def show_channels():
         kodiutils.show_listing(listing, 30007)
 
     @staticmethod
-    def show_channel_menu(key):
+    def show_channel_menu(channel):
         """ Shows a TV channel
-        :type key: str
+        :type channel: str
         """
-        channel = CHANNELS[key]
+        channel_info = CHANNELS[channel]
 
         # Lookup the high resolution logo based on the channel name
-        fanart = '{path}/resources/logos/{logo}'.format(path=kodiutils.addon_path(), logo=channel.get('background'))
+        fanart = '{path}/resources/logos/{logo}'.format(path=kodiutils.addon_path(), logo=channel_info.get('background'))
 
         listing = [
             TitleItem(
-                title=kodiutils.localize(30053, channel=channel.get('name')),  # TV Guide for {channel}
-                path=kodiutils.url_for('show_tvguide_channel', channel=key),
+                title=kodiutils.localize(30053, channel=channel_info.get('name')),  # TV Guide for {channel}
+                path=kodiutils.url_for('show_channel_tvguide', channel=channel),
                 art_dict={
                     'icon': 'DefaultAddonTvInfo.png',
                     'fanart': fanart,
                 },
                 info_dict={
-                    'plot': kodiutils.localize(30054, channel=channel.get('name')),  # Browse the TV Guide for {channel}
+                    'plot': kodiutils.localize(30054, channel=channel_info.get('name')),  # Browse the TV Guide for {channel}
                 }
             ),
             TitleItem(
-                title=kodiutils.localize(30055, channel=channel.get('name')),  # Catalog for {channel}
-                path=kodiutils.url_for('show_catalog_channel', channel=key),
+                title=kodiutils.localize(30055, channel=channel_info.get('name')),  # Catalog for {channel}
+                path=kodiutils.url_for('show_channel_catalog', channel=channel),
                 art_dict={
                     'icon': 'DefaultMovieTitle.png',
                     'fanart': fanart,
                 },
                 info_dict={
-                    'plot': kodiutils.localize(30056, channel=channel.get('name')),  # Browse the Catalog for {channel}
+                    'plot': kodiutils.localize(30056, channel=channel_info.get('name')),  # Browse the Catalog for {channel}
                 }
-            )
+            ),
+            TitleItem(
+                title=kodiutils.localize(30057, channel=channel_info.get('name')),  # Categories for {channel}
+                path=kodiutils.url_for('show_channel_categories', channel=channel),
+                art_dict={
+                    'icon': 'DefaultGenre.png',
+                    'fanart': fanart,
+                },
+                info_dict={
+                    'plot': kodiutils.localize(30058, channel=channel_info.get('name')),  # Browse the Categories for {channel}
+                }
+            ),
         ]
 
         # Add YouTube channels
         if kodiutils.get_cond_visibility('System.HasAddon(plugin.video.youtube)') != 0:
-            for youtube in channel.get('youtube', []):
+            for youtube in channel_info.get('youtube', []):
                 listing.append(
                     TitleItem(
                         title=kodiutils.localize(30206, label=youtube.get('label')),  # Watch {label} on YouTube
@@ -108,3 +124,58 @@ def show_channel_menu(key):
                 )
 
         kodiutils.show_listing(listing, 30007, sort=['unsorted'])
+
+    def show_channel_categories(self, channel):
+        """ Shows the categories of a channel
+        :type channel: str
+        """
+        categories = self._api.get_categories(channel)
+
+        listing = [
+            TitleItem(
+                title=category.title,
+                path=kodiutils.url_for('show_channel_category', channel=category.channel, category=category.uuid),
+                art_dict={
+                    'icon': 'DefaultGenre.png',
+                },
+            ) for category in categories
+        ]
+
+        kodiutils.show_listing(listing, 30007, sort=['unsorted'])
+
+    def show_channel_category(self, channel, category_id):
+        """ Shows a selected category of a channel
+        :type channel: str
+        :type category_id: str
+        """
+        categories = self._api.get_categories(channel)
+
+        # Extract selected category
+        category = next(category for category in categories if category.uuid == category_id)
+        if not category:
+            raise Exception('Unknown category')
+
+        # Add programs
+        listing_programs = []
+        for item in category.programs:
+            program = self._api.get_program(channel, item.path, CACHE_ONLY)  # Get program details, but from cache only
+
+            if program:
+                listing_programs.append(Menu.generate_titleitem(program))
+            else:
+                listing_programs.append(Menu.generate_titleitem(item))
+
+        # Add episodes
+        listing_episodes = []
+        for item in category.episodes:
+            # We don't have the Program Name without making a request to the page, so we use CACHE_AUTO instead of CACHE_ONLY.
+            # This will make a request for each item in this view (about 12 items), but it goes quite fast.
+            # Results are cached, so this will only happen once.
+            episode = self._api.get_episode(channel, item.path, CACHE_AUTO)
+
+            if episode:
+                listing_episodes.append(Menu.generate_titleitem(episode))
+            else:
+                listing_episodes.append(Menu.generate_titleitem(item))
+
+        kodiutils.show_listing(listing_programs + listing_episodes, 30007, content='tvshows', sort=['unsorted'])