Assorted fixes

This PR includes:
- Support for studio icons (optional)
- Add get_cond_visibility() support
- Renamed /live to /livetv
- Rewrote plot formatting for programs, episodes, movies and livetv
- Added studio support
- Improved geo-blocked support (most, if not all, are not geo-blocked)
- Use dict get() to avoid potential KeyError
- Strip episode number from name
- Add branch name to ZIP file

Makefile

@@ -5,9 +5,10 @@ addon_xml = addon.xml
 # Collect information to build as sensible package name
 name = $(shell xmllint --xpath 'string(/addon/@id)' $(addon_xml))
 version = $(shell xmllint --xpath 'string(/addon/@version)' $(addon_xml))
+git_branch = $(shell git rev-parse --abbrev-ref HEAD)
 git_hash = $(shell git rev-parse --short HEAD)
 
-zip_name = $(name)-$(version)-$(git_hash).zip
+zip_name = $(name)-$(version)-$(git_branch)-$(git_hash).zip
 include_files = main.py addon.xml LICENSE README.md resources/
 include_paths = $(patsubst %,$(name)/%,$(include_files))
 exclude_files = \*.new \*.orig \*.pyc \*.pyo

addon.xml

@@ -2,6 +2,8 @@
 <addon id="plugin.video.vtm.go" name="VTM GO" version="0.1" provider-name="Michaël Arnauts">
     <requires>
         <import addon="xbmc.python" version="2.25.0"/>
+        <!-- import addon="resource.images.studios.coloured" version="0.0.18" optional="true"/ -->
+        <!-- import addon="resource.images.studios.white" version="0.0.22" optional="true"/ -->
         <import addon="script.module.dateutil" version="2.6.0"/>
         <import addon="script.module.pysocks" version="1.6.8" optional="true"/>
         <import addon="script.module.requests"/>

resources/lib/kodiutils.py

@@ -85,6 +85,11 @@ def get_global_setting(setting):
         return None
 
 
+def get_cond_visibility(condition):
+    ''' Test a condition in XBMC '''
+    return xbmc.getCondVisibility(condition)
+
+
 def has_socks():
     ''' Test if socks is installed, and remember this information '''
     if not hasattr(has_socks, 'installed'):

resources/lib/plugin.py

@@ -12,7 +12,7 @@
 import routing
 from resources.lib import kodilogging
 from resources.lib import vtmgostream
-from resources.lib.kodiutils import get_setting, get_global_setting, notification, show_ok_dialog, show_settings
+from resources.lib.kodiutils import get_cond_visibility, get_global_setting, get_setting, notification, show_ok_dialog, show_settings
 from resources.lib.vtmgo import VtmGo, Content
 
 ADDON = Addon()
@@ -42,7 +42,7 @@ def index():
     listitem.setInfo('video', {
         'plot': 'Watch channels live via Internet',
     })
-    xbmcplugin.addDirectoryItem(plugin.handle, plugin.url_for(show_live), listitem, True)
+    xbmcplugin.addDirectoryItem(plugin.handle, plugin.url_for(show_livetv), listitem, True)
 
     # Only provide YouTube option when plugin.video.youtube is available
     if xbmc.getCondVisibility('System.HasAddon(plugin.video.youtube)') != 0:
@@ -79,8 +79,8 @@ def check_credentials():
     show_settings()
 
 
-@plugin.route('/live')
-def show_live():
+@plugin.route('/livetv')
+def show_livetv():
     try:
         _vtmGo = VtmGo()
         channels = _vtmGo.get_live()
@@ -90,36 +90,35 @@ def show_live():
 
     for channel in channels:
         listitem = ListItem(channel.name, offscreen=True)
-        listitem.setArt({
-            'icon': channel.logo,
-        })
 
-        description = '[B][COLOR red]Geo-blocked[/COLOR][/B]\n\n'
-        if channel.epg:
-            description += 'Now: %s - %s\n' % (
-                channel.epg[0].start.strftime('%H:%M'),
-                channel.epg[0].end.strftime('%H:%M')
-            )
-            description += channel.epg[0].title + '\n'
-            description += '\n'
+        # Try to use the white icons for thumbnails (used for icons as well)
+        if get_cond_visibility('System.HasAddon(resource.images.studios.white)') == 1:
+            thumb = 'resource://resource.images.studios.white/{studio}.png'.format(studio=channel.name)
+        else:
+            thumb = channel.logo
 
-        if len(channel.epg) > 1:
-            description += 'Next: %s - %s\n' % (
-                channel.epg[1].start.strftime('%H:%M'),
-                channel.epg[1].end.strftime('%H:%M')
-            )
-            description += channel.epg[1].title + '\n'
-            description += '\n'
+        # Try to use the coloured icons for fanart
+        if get_cond_visibility('System.HasAddon(resource.images.studios.coloured)') == 1:
+            fanart = 'resource://resource.images.studios.coloured/{studio}.png'.format(studio=channel.name)
+        elif get_cond_visibility('System.HasAddon(resource.images.studios.white)') == 1:
+            fanart = 'resource://resource.images.studios.white/{studio}.png'.format(studio=channel.name)
+        else:
+            fanart = channel.logo
 
         listitem.setInfo('video', {
-            'plot': description,
+            'plot': _format_plot(channel),
             'playcount': 0,
             'studio': channel.name,
             'mediatype': channel.mediatype,
         })
+        listitem.setArt({
+            'icon': channel.logo,
+            'fanart': fanart,
+            'thumb': thumb,
+        })
         listitem.setProperty('IsPlayable', 'true')
 
-        xbmcplugin.addDirectoryItem(plugin.handle, plugin.url_for(play_live, channel=channel.id) + '?.pvr', listitem)
+        xbmcplugin.addDirectoryItem(plugin.handle, plugin.url_for(play_livetv, channel=channel.id) + '?.pvr', listitem)
 
     # Sort live channels by default like in VTM GO.
     xbmcplugin.addSortMethod(plugin.handle, xbmcplugin.SORT_METHOD_UNSORTED)
@@ -207,7 +206,7 @@ def show_movie(movie):
     })
     listitem.setInfo('video', {
         'title': movie_obj.name,
-        'plot': _format_remaining(movie_obj.remaining) + movie_obj.description,
+        'plot': _format_plot(movie_obj),
         'duration': movie_obj.duration,
         'year': movie_obj.year,
         'mediatype': movie_obj.mediatype,
@@ -247,7 +246,7 @@ def show_program(program, season=None):
                 'tvshowtitle': program_obj.name,
                 'title': 'All seasons',
                 'subtitle': program_obj.description,
-                'plot': '[B]%s[/B]\n%s' % (program_obj.name, program_obj.description),
+                'plot': _format_plot(program_obj),
                 'set': program_obj.name,
             })
             xbmcplugin.addDirectoryItem(plugin.handle, plugin.url_for(show_program, program=program, season='all'), listitem, True)
@@ -262,7 +261,7 @@ def show_program(program, season=None):
                 'tvshowtitle': program_obj.name,
                 'title': 'Season %d' % s.number,
                 'subtitle': program_obj.description,
-                'plot': '[B]%s[/B]\n%s' % (program_obj.name, program_obj.description),
+                'plot': _format_plot(program_obj),
                 'set': program_obj.name,
                 'season': season,
             })
@@ -290,12 +289,13 @@ def show_program(program, season=None):
                 'tvshowtitle': program_obj.name,
                 'title': episode.name,
                 'subtitle': program_obj.description,
-                'plot': _format_remaining(episode.remaining) + episode.description,
+                'plot': _format_plot(episode),
                 'duration': episode.duration,
                 'season': episode.season,
                 'episode': episode.number,
                 'mediatype': episode.mediatype,
                 'set': program_obj.name,
+                'studio': episode.channel,
             })
             listitem.addStreamInfo('video', {
                 'duration': episode.duration,
@@ -317,12 +317,31 @@ def show_program(program, season=None):
 def show_youtube():
     from resources.lib import YOUTUBE
     for entry in YOUTUBE:
+        # Try to use the white icons for thumbnails (used for icons as well)
+        if get_cond_visibility('System.HasAddon(resource.images.studios.white)') == 1:
+            thumb = 'resource://resource.images.studios.white/{studio}.png'.format(**entry)
+        else:
+            thumb = 'DefaultTags.png'
+
+        # Try to use the coloured icons for fanart
+        if get_cond_visibility('System.HasAddon(resource.images.studios.coloured)') == 1:
+            fanart = 'resource://resource.images.studios.coloured/{studio}.png'.format(**entry)
+        elif get_cond_visibility('System.HasAddon(resource.images.studios.white)') == 1:
+            fanart = 'resource://resource.images.studios.white/{studio}.png'.format(**entry)
+        else:
+            fanart = 'DefaultTags.png'
+
         listitem = ListItem(entry.get('label'), offscreen=True)
         listitem.setInfo('video', {
             'plot': 'Watch [B]%(label)s[/B] on YouTube' % entry,
             'studio': entry.get('studio'),
             'mediatype': 'video',
         })
+        listitem.setArt({
+            'icon': 'DefaultTags.png',
+            'fanart': fanart,
+            'thumb': thumb,
+        })
         xbmcplugin.addDirectoryItem(plugin.handle, entry.get('path'), listitem, True)
 
     # Sort by default like in our dict.
@@ -372,8 +391,8 @@ def show_search():
     xbmcplugin.endOfDirectory(plugin.handle)
 
 
-@plugin.route('/play/live/<channel>')
-def play_live(channel):
+@plugin.route('/play/livetv/<channel>')
+def play_livetv(channel):
     _stream('channels', channel)
 
 
@@ -387,17 +406,46 @@ def play_episode(episode):
     _stream('episodes', episode)
 
 
-def _format_remaining(days):
-    if days is None:
-        return ''
-    if days == 0:
-        availability = 'Available until midnight'
-    elif days == 1:
-        availability = '%d day remaining' % days
-    else:
-        availability = '%d days remaining' % days
+def _format_plot(obj):
+    plot = ''
+
+    # Add program name to plot
+    if hasattr(obj, 'name'):
+        plot += '[B]{name}[/B]\n'.format(name=obj.name)
+
+    if hasattr(obj, 'geoblocked') and obj.geoblocked:
+        plot += '[COLOR red]Geo-blocked[/COLOR]\n'
+
+    if hasattr(obj, 'remaining') and obj.remaining is not None:
+        if obj.remaining == 0:
+            plot += '[COLOR blue]Available until midnight[/COLOR]\n'
+        elif obj.remaining == 1:
+            plot += '[COLOR blue]One day remaining[/COLOR]\n'
+        else:
+            plot += '[COLOR blue]{days} days remaining[/COLOR]\n'.format(days=obj.remaining)
+
+    if plot:
+        plot += '\n'
+
+    if hasattr(obj, 'description'):
+        plot += obj.description
+
+    if hasattr(obj, 'epg'):
+        if obj.epg:
+            plot += '[COLOR yellow][B]Now:[/B] %s - %s\n' % (
+                obj.epg[0].start.strftime('%H:%M'),
+                obj.epg[0].end.strftime('%H:%M'),
+            )
+            plot += '» %s[/COLOR]\n' % obj.epg[0].title
+
+        if len(obj.epg) > 1:
+            plot += '[B]Next:[/B] %s - %s\n' % (
+                obj.epg[1].start.strftime('%H:%M'),
+                obj.epg[1].end.strftime('%H:%M'),
+            )
+            plot += '» %s\n' % obj.epg[1].title
 
-    return '[B][COLOR blue]%s[/COLOR][/B]\n\n' % availability
+    return plot
 
 
 def _stream(strtype, strid):