Port new kodiutils changes and stubs (#236)

This PR includes:
- Make use of the jsonrpc() function
- Introduce addon_profile() (replacing get_userdata_path)
- Update xbmc stubs

Author: dagwieers

.github/codecov.yml

@@ -1,13 +1,10 @@
 coverage:
-  range: 50..100
   round: nearest
   status:
     project:
       default:
         target: 75%
         threshold: 6%
-#        base: auto
-#        branches: null
     patch: false
 comment: false
 ignore:

.gitignore

@@ -3,12 +3,16 @@
 .tox/
 __pycache__/
 *.py[cod]
+
+# Userdata
 test/cdm/
 test/userdata/addon_settings.json
 test/userdata/addon_data/
 test/userdata/cdm/
+test/userdata/backup/
 test/userdata/tmp/
 
+# Temporary
 experiment/
 *.zip
 

.pylintrc

@@ -10,3 +10,4 @@ disable=
     too-many-lines,
     too-many-locals,
     too-many-return-statements,
+    unexpected-keyword-arg,

.travis.yml

@@ -11,6 +11,7 @@ sudo: false
 
 env:
   PYTHONPATH: lib:test
+  PYTHONIOENCODING: utf-8
 
 install:
 - pip install -r requirements.txt
@@ -21,9 +22,9 @@ script:
 - pylint lib/ test/
 #- kodi-addon-checker . --branch=krypton
 #- kodi-addon-checker . --branch=leia
-- coverage run -a default.py
 - proxy.py &
 - coverage run -m unittest discover
+- coverage run -a default.py
 
 after_success:
 - codecov

Makefile

@@ -1,9 +1,8 @@
 export PYTHONPATH := $(CURDIR)/lib:$(CURDIR)/test
-addon_xml := addon.xml
+PYTHON := python
 
-# 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))
+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)
 
@@ -13,7 +12,7 @@ include_paths = $(patsubst %,$(name)/%,$(include_files))
 exclude_files = \*.new \*.orig \*.pyc \*.pyo
 zip_dir = $(name)/
 
-languages := de_de el_gr fr_fr it_it nl_nl ru_ru sv_se
+languages = $(filter-out en_gb, $(patsubst resources/language/resource.language.%, %, $(wildcard resources/language/*)))
 
 blue = \e[1;34m
 white = \e[1;37m
@@ -31,11 +30,11 @@ sanity: tox pylint language
 
 tox:
 	@echo -e "$(white)=$(blue) Starting sanity tox test$(reset)"
-	tox -q
+	$(PYTHON) -m tox -q
 
 pylint:
 	@echo -e "$(white)=$(blue) Starting sanity pylint test$(reset)"
-	pylint lib/ test/
+	$(PYTHON) -m pylint lib/ test/
 
 language:
 	@echo -e "$(white)=$(blue) Starting language test$(reset)"
@@ -50,25 +49,28 @@ addon: clean
 
 unit: clean
 	@echo -e "$(white)=$(blue) Starting unit tests$(reset)"
-	-pkill -ef proxy.py
-	proxy.py &
-	python -m unittest discover
-	pkill -ef proxy.py
+	-pkill -ef '$(PYTHON) -m proxy'
+	$(PYTHON) -m proxy &
+	$(PYTHON) -m unittest discover
+	pkill -ef '$(PYTHON) -m proxy'
 
 run:
 	@echo -e "$(white)=$(blue) Run CLI$(reset)"
-	python default.py
+	$(PYTHON) default.py
 
 zip: clean
 	@echo -e "$(white)=$(blue) Building new package$(reset)"
 	@rm -f ../$(zip_name)
 	cd ..; zip -r $(zip_name) $(include_paths) -x $(exclude_files)
 	@echo -e "$(white)=$(blue) Successfully wrote package as: $(white)../$(zip_name)$(reset)"
 
+codecov:
+	@echo -e "$(white)=$(blue) Test codecov.yml syntax$(reset)"
+	curl --data-binary @.github/codecov.yml https://codecov.io/validate
+
 clean:
 	@echo -e "$(white)=$(blue) Cleaning up$(reset)"
-	find . -name '*.pyc' -type f -delete
-	find . -name '*.pyo' -type f -delete
+	find . -name '*.py[cod]' -type f -delete
 	find . -name '__pycache__' -type d -delete
 	find test/userdata/ -mindepth 1 -not -name '*settings.json' -delete
 	rm -rf .pytest_cache/ .tox/ *.log lib/inputstreamhelper.egg-info/

default.py

@@ -2,18 +2,18 @@
 ''' This is the actual InputStream Helper API script entry point '''
 
 from __future__ import absolute_import, division, unicode_literals
-import os
 import sys
-import xbmc
-import xbmcaddon
+import os.path
+from xbmc import translatePath
+from xbmcaddon import Addon
 
 
 def to_unicode(text, encoding='utf-8'):
     ''' Force text to unicode '''
     return text.decode(encoding) if isinstance(text, bytes) else text
 
 
-sys.path.append(os.path.join(to_unicode(xbmc.translatePath(xbmcaddon.Addon().getAddonInfo('path'))), 'lib'))
+sys.path.append(os.path.join(to_unicode(translatePath(Addon().getAddonInfo('path'))), 'lib'))
 from inputstreamhelper.api import run  # noqa: E402
 
 run(sys.argv)

lib/inputstreamhelper/__init__.py

@@ -3,7 +3,7 @@
 from __future__ import absolute_import, division, unicode_literals
 import os
 from inputstreamhelper import config
-from .kodiutils import (browsesingle, execute_jsonrpc, get_addon_info, get_proxies, get_setting, get_userdata_path, kodi_to_ascii, localize,
+from .kodiutils import (addon_profile, browsesingle, get_addon_info, get_proxies, get_setting, jsonrpc, kodi_to_ascii, localize,
                         log, notification, ok_dialog, progress_dialog, select_dialog, set_setting, textviewer, translate_path, yesno_dialog)
 
 # NOTE: Work around issue caused by platform still using os.popen()
@@ -118,7 +118,7 @@ def _ia_cdm_path(cls):
     def _backup_path(cls):
         ''' Return the path to the cdm backups '''
         from xbmcvfs import exists, mkdir
-        path = os.path.join(get_userdata_path(), 'backup')
+        path = os.path.join(addon_profile(), 'backup')
         if not exists(path):
             mkdir(path)
         return path
@@ -433,7 +433,7 @@ def _http_download(self, url, message=None):
 
     def _has_inputstream(self):
         """Checks if selected InputStream add-on is installed."""
-        data = execute_jsonrpc(dict(jsonrpc='2.0', id=1, method='Addons.GetAddonDetails', params=dict(addonid=self.inputstream_addon)))
+        data = jsonrpc(method='Addons.GetAddonDetails', params=dict(addonid=self.inputstream_addon))
         if 'error' in data:
             log('{addon} is not installed.', addon=self.inputstream_addon)
             return False
@@ -443,7 +443,7 @@ def _has_inputstream(self):
 
     def _inputstream_enabled(self):
         """Returns whether selected InputStream add-on is enabled.."""
-        data = execute_jsonrpc(dict(jsonrpc='2.0', id=1, method='Addons.GetAddonDetails', params=dict(addonid=self.inputstream_addon, properties=['enabled'])))
+        data = jsonrpc(method='Addons.GetAddonDetails', params=dict(addonid=self.inputstream_addon, properties=['enabled']))
         if data.get('result', {}).get('addon', {}).get('enabled'):
             log('{addon} {version} is enabled.', addon=self.inputstream_addon, version=self._inputstream_version())
             return True
@@ -453,7 +453,7 @@ def _inputstream_enabled(self):
 
     def _enable_inputstream(self):
         """Enables selected InputStream add-on."""
-        data = execute_jsonrpc(dict(jsonrpc='2.0', id=1, method='Addons.SetAddonEnabled', params=dict(addonid=self.inputstream_addon, enabled=True)))
+        data = jsonrpc(method='Addons.SetAddonEnabled', params=dict(addonid=self.inputstream_addon, enabled=True))
         if 'error' in data:
             return False
         return True

lib/inputstreamhelper/kodiutils.py

@@ -7,7 +7,7 @@
 from xbmcaddon import Addon
 from .unicodehelper import from_unicode, to_unicode
 
-ADDON = Addon('script.module.inputstreamhelper')
+ADDON = Addon()
 
 
 class SafeDict(dict):
@@ -17,20 +17,22 @@ def __missing__(self, key):
         return '{' + key + '}'
 
 
-def has_socks():
-    ''' Test if socks is installed, and remember this information '''
+def addon_profile():
+    ''' Cache and return add-on profile '''
+    return to_unicode(xbmc.translatePath(ADDON.getAddonInfo('profile')))
 
-    # If it wasn't stored before, check if socks is installed
-    if not hasattr(has_socks, 'installed'):
-        try:
-            import socks  # noqa: F401; pylint: disable=unused-variable,unused-import
-            has_socks.installed = True
-        except ImportError:
-            has_socks.installed = False
-            return None  # Detect if this is the first run
 
-    # Return the stored value
-    return has_socks.installed
+def has_socks():
+    ''' Test if socks is installed, and use a static variable to remember '''
+    if hasattr(has_socks, 'cached'):
+        return getattr(has_socks, 'cached')
+    try:
+        import socks  # noqa: F401; pylint: disable=unused-variable,unused-import
+    except ImportError:
+        has_socks.cached = False
+        return None  # Detect if this is the first run
+    has_socks.cached = True
+    return True
 
 
 def browsesingle(type, heading, shares='', mask='', useThumbs=False, treatAsFolder=False, defaultt=None):  # pylint: disable=invalid-name,redefined-builtin
@@ -90,15 +92,17 @@ def yesno_dialog(heading='', message='', nolabel=None, yeslabel=None, autoclose=
 def localize(string_id, **kwargs):
     ''' Return the translated string from the .po language files, optionally translating variables '''
     if kwargs:
-        import string
-        return string.Formatter().vformat(ADDON.getLocalizedString(string_id), (), SafeDict(**kwargs))
-
+        from string import Formatter
+        return Formatter().vformat(ADDON.getLocalizedString(string_id), (), SafeDict(**kwargs))
     return ADDON.getLocalizedString(string_id)
 
 
-def get_setting(setting_id, default=None):
+def get_setting(key, default=None):
     ''' Get an add-on setting '''
-    value = to_unicode(ADDON.getSetting(setting_id))
+    try:
+        value = to_unicode(ADDON.getSetting(key))
+    except RuntimeError:  # Occurs when the add-on is disabled
+        return default
     if value == '' and default is not None:
         return default
     return value
@@ -109,15 +113,15 @@ def translate_path(path):
     return to_unicode(xbmc.translatePath(path))
 
 
-def set_setting(setting_id, setting_value):
+def set_setting(key, value):
     ''' Set an add-on setting '''
-    return ADDON.setSetting(setting_id, setting_value)
+    return ADDON.setSetting(key, from_unicode(str(value)))
 
 
-def get_global_setting(setting):
+def get_global_setting(key):
     ''' Get a Kodi setting '''
-    result = execute_jsonrpc(dict(jsonrpc='2.0', id=1, method='Settings.GetSettingValue', params=dict(setting='%s' % setting)))
-    return result.get('result', dict()).get('value')
+    result = jsonrpc(method='Settings.GetSettingValue', params=dict(setting=key))
+    return result.get('result', {}).get('value')
 
 
 def get_proxies():
@@ -163,28 +167,40 @@ def get_proxies():
     return dict(http=proxy_address, https=proxy_address)
 
 
-def get_userdata_path():
-    ''' Return the addon's addon_data path '''
-    return translate_path(ADDON.getAddonInfo('profile'))
-
-
 def get_addon_info(key):
     ''' Return addon information '''
     return to_unicode(ADDON.getAddonInfo(key))
 
 
-def execute_jsonrpc(payload):
-    ''' Kodi JSON-RPC request. Return the response in a dictionary. '''
-    import json
-    log('jsonrpc payload: {payload}', payload=payload)
-    response = xbmc.executeJSONRPC(json.dumps(payload))
-    log('jsonrpc response: {response}', response=response)
-    return json.loads(response)
+def jsonrpc(*args, **kwargs):
+    ''' Perform JSONRPC calls '''
+    from json import dumps, loads
+
+    # We do not accept both args and kwargs
+    if args and kwargs:
+        log('ERROR: Wrong use of jsonrpc()')
+        return None
+
+    # Process a list of actions
+    if args:
+        for (idx, cmd) in enumerate(args):
+            if cmd.get('id') is None:
+                cmd.update(id=idx)
+            if cmd.get('jsonrpc') is None:
+                cmd.update(jsonrpc='2.0')
+        return loads(xbmc.executeJSONRPC(dumps(args)))
+
+    # Process a single action
+    if kwargs.get('id') is None:
+        kwargs.update(id=0)
+    if kwargs.get('jsonrpc') is None:
+        kwargs.update(jsonrpc='2.0')
+    return loads(xbmc.executeJSONRPC(dumps(kwargs)))
 
 
 def log(msg, level=xbmc.LOGDEBUG, **kwargs):
     ''' InputStream Helper log method '''
-    xbmc.log(msg=from_unicode('[{addon}]: {msg}'.format(addon=get_addon_info('id'), msg=msg.format(**kwargs))), level=level)
+    xbmc.log(msg=from_unicode('[{addon}] {msg}'.format(addon=get_addon_info('id'), msg=msg.format(**kwargs))), level=level)
 
 
 def kodi_to_ascii(string):

test/test_proxy.py

@@ -20,13 +20,13 @@
 class LinuxProxyTests(unittest.TestCase):
 
     def setUp(self):
-        xbmc.GLOBAL_SETTINGS['network.usehttpproxy'] = True
-        xbmc.GLOBAL_SETTINGS['network.httpproxytype'] = 0
-        xbmc.GLOBAL_SETTINGS['network.httpproxyserver'] = '127.0.0.1'
-        xbmc.GLOBAL_SETTINGS['network.httpproxyport'] = '8899'
+        xbmc.settings['network.usehttpproxy'] = True
+        xbmc.settings['network.httpproxytype'] = 0
+        xbmc.settings['network.httpproxyserver'] = '127.0.0.1'
+        xbmc.settings['network.httpproxyport'] = '8899'
 
     def tearDown(self):
-        xbmc.GLOBAL_SETTINGS['network.usehttpproxy'] = False
+        xbmc.settings['network.usehttpproxy'] = False
 
     def test_check_inputstream_mpd(self):
         inputstreamhelper.system_os = lambda: 'Linux'