add features and fixes

Adds generic timezone lineups
Adds station/channels icons
Removes old episode data from cache

Author: edit4ever

addon.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-<addon id="script.module.zap2epg" name="zap2epg" version="0.2.1" provider-name="edit4ever">
+<addon id="script.module.zap2epg" name="zap2epg" version="0.3.0" provider-name="edit4ever">
   <requires>
     <import addon="xbmc.python" version="2.7.13"/>
     <import addon="script.module.dateutil" version="2.4.2"/>
@@ -11,7 +11,7 @@
   </extension>
   <extension point="xbmc.addon.metadata">
     <summary lang="en_gb">zap2epg will generate an xmltv.xml file for USA/Canada TV lineups</summary>
-    <description lang="en_gb">zap2epg is originally designed to be easily setup in Kodi for use as a grabber for tvheadend.  It includes the ability to setup your custom channel list to reduce the amount of data downloaded and speed up the grab.  It has an option for downloading extra detail information for programs. (Note: this option will generate an extra http request per episode) It also has an option to append the extra detail information to the description (plot) field, which makes displaying this information in the Kodi EPG easier on many skins.
+    <description lang="en_gb">zap2epg is originally designed to be easily setup in Kodi for use as a grabber for tvheadend.  It includes the ability to setup your custom channel list to reduce the amount of data downloaded and speed up the grab.  It has an option for downloading extra detail information for programs. (Note: this option will generate an extra http request per series) It also has an option to append the extra detail information to the description (plot) field, which makes displaying this information in the Kodi EPG easier on many skins.
 
 Setup:
  1. Install the zap2epg addon in Kodi
@@ -29,6 +29,7 @@ Setup:
     <email></email>
     <source></source>
     <news>
+    v0.3.0 - adds generic timezone lineups and station/channels icons | removes old episode data from cache (2017-11-07)
     v0.2.1 - fix for location name and JSON file errors (2017-11-02)
     v0.2.0 - modified for new zap2it guide data (2017-10-27)
     v0.1.0 - initial test release (2017-10-24)

default.py

@@ -34,6 +34,7 @@
         os.mkdir(userdata)
 log = os.path.join(userdata, 'zap2epg.log')
 Clist = os.path.join(userdata, 'channels.json')
+cacheDir = os.path.join(userdata, 'cache')
 plugin = Plugin()
 dialog = xbmcgui.Dialog()
 gridtime = (int(time.mktime(time.strptime(str(datetime.datetime.now().replace(microsecond=0,second=0,minute=0)), '%Y-%m-%d %H:%M:%S'))))
@@ -101,19 +102,23 @@ def channels():
 
 @plugin.route('/location')
 def location():
+    country = ['USA', 'CAN']
+    countryNew = dialog.select('Select your country', list=country)
     zipcodeNew = dialog.input('Enter your zipcode', defaultt=zipcode, type=xbmcgui.INPUT_ALPHANUM)
     if not zipcodeNew:
         return
     zipcodeNew =re.sub(' ', '', zipcodeNew)
     xbmcaddon.Addon().setSetting(id='zipcode', value=zipcodeNew)
-    if zipcodeNew.isdigit():
+    if countryNew == 0:
         url = 'https://tvlistings.gracenote.com/gapzap_webapi/api/Providers/getPostalCodeProviders/USA/' + zipcodeNew
-    else:
+        lineupsN = ['AVAILABLE LINEUPS', 'TIMEZONE - Eastern', 'TIMEZONE - Central', 'TIMEZONE - Mountain', 'TIMEZONE - Pacific', 'TIMEZONE - Alaskan', 'TIMEZONE - Hawaiian']
+        lineupsC = ['NONE', 'DFLTE', 'DFLTC', 'DFLTM', 'DFLTP', 'DFLTA', 'DFLTH']
+    if countryNew == 1:
         url = 'https://tvlistings.gracenote.com/gapzap_webapi/api/Providers/getPostalCodeProviders/CAN/' + zipcodeNew
+        lineupsN = ['AVAILABLE LINEUPS', 'TIMEZONE - Eastern', 'TIMEZONE - Central', 'TIMEZONE - Mountain', 'TIMEZONE - Pacific']
+        lineupsC = ['NONE', 'DFLTEC', 'DFLTCC', 'DFLTMC', 'DFLTPC']
     content = urllib2.urlopen(url).read()
     lineupDict = json.loads(content)
-    lineupsN = ['AVAILABLE LINEUPS']
-    lineupsC = ['NONE']
     if 'Providers' in lineupDict:
         for provider in lineupDict['Providers']:
             lineupName = provider.get('name')
@@ -133,6 +138,16 @@ def location():
         lineupSelName = lineupsN[lineupSel]
         xbmcaddon.Addon().setSetting(id='lineupcode', value=lineupSelCode)
         xbmcaddon.Addon().setSetting(id='lineup', value=lineupSelName)
+        if os.path.exists(cacheDir):
+            entries = os.listdir(cacheDir)
+            for entry in entries:
+                oldfile = entry.split('.')[0]
+                if oldfile.isdigit():
+                    fn = os.path.join(cacheDir, entry)
+                    try:
+                        os.remove(fn)
+                    except:
+                        pass
         xbmc.executebuiltin('Container.Refresh')
     else:
         xbmc.executebuiltin('Container.Refresh')

zap2epg.py

@@ -27,6 +27,7 @@
 import sys
 from os.path import dirname
 import xml.etree.ElementTree as ET
+from collections import OrderedDict
 
 
 def mainRun(userdata):
@@ -70,7 +71,7 @@ def mainRun(userdata):
     gridtimeStart = (int(time.mktime(time.strptime(str(datetime.datetime.now().replace(microsecond=0,second=0,minute=0)), '%Y-%m-%d %H:%M:%S'))))
     schedule = {}
 
-    def deleteOldCache(gridtime):
+    def deleteOldCache(gridtimeStart, showList):
         logging.info('Checking for old cache files...')
         try:
             if os.path.exists(cacheDir):
@@ -79,22 +80,20 @@ def deleteOldCache(gridtime):
                     oldfile = entry.split('.')[0]
                     if oldfile.isdigit():
                         fn = os.path.join(cacheDir, entry)
-                        if (int(oldfile) + 10800) < gridtime:
+                        if (int(oldfile) + 10800) < gridtimeStart:
+                            try:
+                                os.remove(fn)
+                                logging.info('Deleting old cache: %s', entry)
+                            except OSError, e:
+                                logging.warn('Error Deleting: %s - %s.' % (e.filename, e.strerror))
+                    elif not oldfile.isdigit():
+                        fn = os.path.join(cacheDir, entry)
+                        if oldfile not in showList:
                             try:
                                 os.remove(fn)
                                 logging.info('Deleting old cache: %s', entry)
                             except OSError, e:
                                 logging.warn('Error Deleting: %s - %s.' % (e.filename, e.strerror))
-                    # elif not oldfile.isdigit():
-                    #     episodeSet = {j for i in schedule.values() for j in i}
-                    #     episodeList = list(episodeSet)
-                    #     fn = os.path.join(cacheDir, entry)
-                    #     if oldfile not in episodeList:
-                    #         try:
-                    #             os.remove(fn)
-                    #             logging.info('Deleting old cache: %s', entry)
-                    #         except OSError, e:
-                    #             logging.warn('Error Deleting: %s - %s.' % (e.filename, e.strerror))
         except Exception as e:
             logging.exception('Exception: deleteOldCache')
 
@@ -155,20 +154,26 @@ def printStations(fh):
         stationCount = 0
         try:
             logging.info('Writing Stations to xmltv.xml file...')
-            for station in schedule:
+            try:
+                scheduleSort = OrderedDict(sorted(schedule.iteritems(), key=lambda x: int(x[1]['chnum'])))
+            except:
+                scheduleSort = OrderedDict(sorted(schedule.iteritems(), key=lambda x: x[1]['chfcc']))
+            for station in scheduleSort:
                 fh.write('\t<channel id=\"' + station + '.zap2epg\">\n')
-                if 'chnum' in schedule[station] and 'chfcc' in schedule[station]:
-                    xchnum = schedule[station]['chnum']
-                    xchfcc = schedule[station]['chfcc']
-                    fh.write('\t\t<display-name>' + xchnum + ' ' + xchfcc + '</display-name>\n')
+                if 'chnum' in scheduleSort[station] and 'chfcc' in scheduleSort[station]:
+                    xchnum = scheduleSort[station]['chnum']
+                    xchfcc = scheduleSort[station]['chfcc']
                     fh.write('\t\t<display-name>' + xchfcc + '</display-name>\n')
                     fh.write('\t\t<display-name>' + xchnum + '</display-name>\n')
-                elif 'chfcc' in schedule[station]:
-                    xchnum = schedule[station]['chfcc']
+                    fh.write('\t\t<display-name>' + xchnum + ' ' + xchfcc + '</display-name>\n')
+                elif 'chfcc' in scheduleSort[station]:
+                    xchnum = scheduleSort[station]['chfcc']
                     fh.write('\t\t<display-name>' + xcfcc + '</display-name>\n')
-                elif 'chnum' in schedule[station]:
-                    xchnum = schedule[station]['chnum']
+                elif 'chnum' in scheduleSort[station]:
+                    xchnum = scheduleSort[station]['chnum']
                     fh.write('\t\t<display-name>' + xchnum + '</display-name>\n')
+                if 'chicon' in scheduleSort[station]:
+                    fh.write("\t\t<icon src=\"http:" + scheduleSort[station]['chicon'] + "\" />\n")
                 fh.write("\t</channel>\n")
                 stationCount += 1
         except Exception as e:
@@ -209,14 +214,17 @@ def printEpisodes(fh):
                                 fh.write("\t\t<episode-num system=\"xmltv_ns\">" + str(int(edict['epsn'])-1) +  "." + str(int(edict['epen'])-1) + ".</episode-num>\n")
                             if edict['epyear'] is not None:
                                 fh.write('\t\t<date>' + edict['epyear'] + '</date>\n')
-                            if edict['epthumb'] is not None or edict['epimage'] is not None:
-                                if not episode.startswith("MV"):
-                                    if epicon == '1':
+                            if not episode.startswith("MV"):
+                                if epicon == '1':
+                                    if edict['epimage'] is not None:
                                         fh.write('\t\t<icon src="https://zap2it.tmsimg.com/assets/' + edict['epimage'] + '.jpg" />\n')
-                                    if epicon == '2':
+                                    else:
                                         fh.write('\t\t<icon src="https://zap2it.tmsimg.com/assets/' + edict['epthumb'] + '.jpg" />\n')
-                                else:
-                                    fh.write('\t\t<icon src="https://zap2it.tmsimg.com/assets/' + edict['epthumb'] + '.jpg" />\n')
+                                if epicon == '2':
+                                    if edict['epthumb'] is not None:
+                                        fh.write('\t\t<icon src="https://zap2it.tmsimg.com/assets/' + edict['epthumb'] + '.jpg" />\n')
+                            if episode.startswith("MV"):
+                                fh.write('\t\t<icon src="https://zap2it.tmsimg.com/assets/' + edict['epthumb'] + '.jpg" />\n')
                             if not any(i in ['New', 'Live'] for i in edict['epflag']):
                                 fh.write("\t\t<previously-shown ")
                                 if edict['epoad'] is not None and int(edict['epoad']) > 0:
@@ -277,10 +285,12 @@ def parseStations(content):
                         schedule[skey] = {}
                         schedule[skey]['chnum'] = station.get('channelNo')
                         schedule[skey]['chfcc'] = station.get('callSign')
+                        schedule[skey]['chicon'] = station.get('thumbnail').split('?')[0]
                 else:
                     schedule[skey] = {}
                     schedule[skey]['chnum'] = station.get('channelNo')
                     schedule[skey]['chfcc'] = station.get('callSign')
+                    schedule[skey]['chicon'] = station.get('thumbnail').split('?')[0]
         except Exception as e:
             logging.exception('Exception: parseStations')
 
@@ -293,7 +303,6 @@ def parseEpisodes(content):
                     if skey in stationList:
                         episodes = station.get('events')
                         for episode in episodes:
-                            #epkeyStart = str(calendar.timegm(time.strptime(episode.get('startTime'), '%Y-%m-%dT%H:%M:%SZ')))
                             epkey = episode['program'].get('tmsId')
                             schedule[skey][epkey] = {}
                             schedule[skey][epkey]['epid'] = episode['program'].get('tmsId')
@@ -322,7 +331,6 @@ def parseEpisodes(content):
                 else:
                     episodes = station.get('events')
                     for episode in episodes:
-                        #epkeyStart = str(calendar.timegm(time.strptime(episode.get('startTime'), '%Y-%m-%dT%H:%M:%SZ')))
                         epkey = episode['program'].get('tmsId')
                         schedule[skey][epkey] = {}
                         schedule[skey][epkey]['epid'] = episode['program'].get('tmsId')
@@ -352,13 +360,15 @@ def parseEpisodes(content):
             logging.exception('Exception: parseEpisodes')
 
     def parseXdetails():
+        showList = []
         try:
             for station in schedule:
                 sdict = schedule[station]
                 for episode in sdict:
                         if not episode.startswith("ch"):
                             edict = sdict[episode]
                             EPseries = edict['epseries']
+                            showList.append(edict['epseries'])
                             filename = EPseries + '.json'
                             fileDir = os.path.join(cacheDir, filename)
                             try:
@@ -421,6 +431,7 @@ def parseXdetails():
                                 #os.remove(fileDir)
         except Exception as e:
             logging.exception('Exception: parseXdetails')
+        return showList
 
     def addXDetails(edict):
         try:
@@ -594,9 +605,9 @@ def makeDescsortList(optList):
             count += 1
             gridtime = gridtime + 10800
         if xdetails == 'true':
-            parseXdetails()
+            showList = parseXdetails()
         xmltv()
-        deleteOldCache(gridtimeStart)
+        deleteOldCache(gridtimeStart, showList)
         timeRun = round((time.time() - pythonStartTime),2)
         logging.info('zap2epg completed in %s seconds. ', timeRun)
         logging.info('%s Stations and %s Episodes written to xmltv.xml file.', str(stationCount), str(episodeCount))