#! /usr/bin/env python3
-
+"""
# Update Tvheadend recordings with additional external metadata such
# as artwork.
#
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
-#
+"""
+# pylint: disable=C0116,C0301,R0916,R0914,R0912,R0915
-import urllib
+import sys
+import os
+import json
import logging
import glob
import traceback
-# Python3 decided to rename things and break compatibility...
-try:
- import urllib.parse
- import urllib.request
-except:
- pass
-try:
- urlencode = urllib.parse.urlencode
- urlopen = urllib.request.urlopen
-except:
- urlencode = urllib.urlencode
- urlopen = urllib.urlopen
-
-import json
-import sys
-import os
-
+import argparse
# for authentication to tvheadend API in request()
import base64
+import urllib
+import urllib.parse
+import urllib.request
+
+urlencode = urllib.parse.urlencode
+urlopen = urllib.request.urlopen
+
# In development tree, the library is in ../lib/py/tvh, but in live it's
# in the install bin directory (since it is an executable in its own
# right)
sys.path.insert(0, os.path.join(os.path.dirname(__file__), '.'))
-sys.path.insert(0, os.path.join(os.path.dirname(__file__), '..', 'lib', 'py', "tvh"))
+sys.path.insert(0, os.path.join(
+ os.path.dirname(__file__), '..', 'lib', 'py', "tvh"))
sys.path.append("/usr/local/bin")
-class TvhMeta(object):
- def __init__(self, host, port, user, password, grabber_args):
- self.host = host
- self.port = port
- self.user = user
- self.password = password
- self.grabber_args = grabber_args
- logging.debug("grabber_args=%s" % grabber_args)
-
- @staticmethod
- def get_meta_grabbers():
- grabbers = set()
- for i in sys.path:
- for grabber in glob.glob(os.path.join(i, "tv_meta_*.py")):
- (path,filename) = os.path.split(grabber)
- filename = filename.replace(".py", "")
- logging.debug("Adding grabber %s from %s" % (filename, grabber))
- grabbers.add(filename)
- return sorted(list(grabbers))
-
- def _get_meta_grabbers_for_capability_common(self, capability = None, addfn = None):
- grabbers = self.get_meta_grabbers()
- logging.debug("Got grabbers %s" % grabbers)
- ret = set()
- for module_name in grabbers:
- try:
- logging.debug("Importing %s", module_name)
- mod = __import__(module_name)
- obj_fn = getattr(mod, module_name.capitalize())
- cap_fn = getattr(mod, "get_capabilities")
- capabilities = cap_fn()
- logging.debug("Module %s has capabilities %s", module_name, capabilities)
- if capability is None or capabilities[capability]:
- if addfn:
- addfn(mod, module_name, capabilities)
- else:
- ret.add(module_name)
- except Exception as e:
- logging.exception("Could not import module %s when searching for %s: %s" % (module_name, capability, e))
- return sorted(list(ret))
-
- def get_meta_grabbers_for_movie(self):
- return self._get_meta_grabbers_for_capability_common("supports_movie")
-
- def get_meta_grabbers_for_tv(self):
- return self._get_meta_grabbers_for_capability_common("supports_tv")
-
- def get_meta_grabbers_capabilities(self):
- ret = {}
- def addit(mod,module_name,capabilities): ret[module_name] = capabilities
- self._get_meta_grabbers_for_capability_common(addfn = addit)
- return ret
-
- def _get_module_init_args(self, module_name):
- """Return initialization arguments suitable for the module."""
- if self.grabber_args is None:
- return {}
- args = {}
- # Convert module name from "tv_meta_tmdb_simple" to "tmdb-simple",
- # which is more like a command line option.
- module_simple_name = module_name.replace("tv_meta_", "").replace("_", "-")
- logging.debug("Using module simple name of %s for %s" % (module_simple_name, module_name))
- # Then we find any arguments that have the prefix "tmdb-simple"
- # and add them to our arguments.
- for key in self.grabber_args:
- # Only match keys for this module. So for "tv_meta_tmdb" and command line argument
- # of "tmdb-key", we would have a simple module name of "tmdb" and would want to
- # match "tmdb-" (to ensure we don't match with tmdbabc module).
- if key.startswith(module_simple_name + "-"):
- # We want the command line option "tmdb-key" to be passed to
- # the module as simply "key" since modules don't want long
- # prefixes on every argument.
- value = self.grabber_args[key]
- key = key.replace(module_simple_name + "-", "")
- args[key] = value
-
- logging.debug("Generated arguments for module %s of %s" % (module_name, args))
- return args
-
- def request(self, url, data):
- """Send a request for data to Tvheadend."""
- full_url = "http://{}:{}/{}".format(self.host,self.port,url)
- req = urllib.request.Request(full_url, method="POST", data=bytearray(data, 'utf-8'))
- if self.user is not None and self.password is not None:
- base64string = base64.b64encode(bytes('{}:{}'.format(self.user, self.password), 'ascii'))
- req.add_header('Authorization', 'Basic {}'.format(base64string.decode('utf-8')))
-
- logging.info("Sending %s to %s" % (data, full_url))
-
- ret = urllib.request.urlopen(req).read().decode('UTF-8', errors='replace');
- logging.debug("Received: %s", ret)
- return ret
-
- def persist_artwork(self, uuid, artwork_url, fanart_url):
- """Persist the artwork to Tvheadend."""
- new_data_dict = {"uuid" : uuid}
- if artwork_url is not None: new_data_dict['image'] = artwork_url
- if fanart_url is not None: new_data_dict['fanart_image'] = fanart_url
-
- new_data = 'node=[' + json.dumps(new_data_dict) + ']';
- replace = self.request("api/idnode/save", new_data)
- return replace
-
- def _lang3_to_lang2(self, lang3):
- """Convert from ISO 639-2 (3 letter code) + region to ISO 639-1 (2 letter code)"""
- # This is taken from tvh_locale.c, but "_" is replaced with "-" on the mapped side.
- iso_map = {
- "ach": "ach",
- "ady": "ady",
- "ara": "ar",
- "bul": "bg",
- "cze": "cs",
- "dan": "da",
- "ger": "de",
- "eng": "en-US",
- "eng_GB": "en-GB",
- "eng_US": "en-US",
- "spa": "es",
- "est": "et",
- "per": "fa",
- "fin": "fi",
- "fre": "fr",
- "heb": "he",
- "hrv": "hr",
- "hun": "hu",
- "ita": "it",
- "kor": "ko",
- "lav": "lv",
- "lit": "lt",
- "dut": "nl",
- "nor": "no",
- "pol": "pl",
- "por": "pt",
- "rum": "ro",
- "rus": "ru",
- "slv": "sl",
- "slo": "sk",
- "srp": "sr",
- "alb": "sq",
- "swe": "sv",
- "tur": "tr",
- "ukr": "uk",
- "chi": "zh",
- "chi_CN": "zh-Hans",
- }
- try:
- return iso_map[lang]
- except:
- # No mapping. Return "English" as default.
- return "en"
-
-
- def fetch_and_persist_artwork(self, uuid, force_refresh, modules_movie, modules_tv):
- """Fetch artwork for the given uuid."""
- data = urlencode(
- {"uuid" : uuid,
- "list" : "uuid,image,fanart_image,title,copyright_year,episode_disp,uri",
- "grid" : 1
- })
- # Our json looks like this:
- # {"entries":[{"uuid":"abc..,"image":"...","fanart_image":"...","title":{"eng":"TITLE"},"copyright_year":2014}]}
- # So go through the structure to get the record
- recjson = self.request("api/idnode/load", data)
- recall = json.loads(recjson)
- recentries = recall["entries"]
- if (len(recentries) == 0):
- raise RuntimeError("No entries found for uuid " + uuid)
-
- rec = recentries[0]
- title_tuple = rec["title"]
- if title_tuple is None:
- raise RuntimeError("Record has no title: " + data)
-
- if not force_refresh and "image" in rec and "fanart_image" in rec and rec["image"] is not None and rec["image"] != "" and rec["fanart_image"] is not None and rec["fanart_image"] != "":
- logging.info("We have both image and fanart_image already for %s so nothing to do (%s)", uuid, recjson)
- return
-
- episode_disp = rec["episode_disp"]
- # We lazily create the objects only when needed so user can
- # specify fallback grabbers that are only initialized when needed.
- clients = {}
- client_modules = {}
- client_objects = {}
- if episode_disp is not None and episode_disp != "":
- # TV episode, so load the tv modules
- # Have to do len before split since split of an empty string
- # returns one element...
- if len(modules_tv) == 0:
- logging.info("Program is an episode, not a movie, and no modules available for lookup possible for title %s episode %s" % (title_tuple, episode_disp))
- raise RuntimeError("Program is an episode and no tv modules available " + data)
- clients = modules_tv.split(",")
- else:
- # Import our modules for processing movies.
- if len(modules_movie) == 0:
- logging.info("Program is a movie, and no modules available for lookup possible for title %s" % (title_tuple))
- raise RuntimeError("Program is movie and no movie modules available " + data)
- clients = modules_movie.split(",")
-
- year = rec["copyright_year"]
- # Avoid passing in a zero year to our lookups.
- if year == 0:
- year = None
-
- # We fetch uri (programid) since some xmltv modules
- # have artwork based on the id they provided.
- if 'uri' in rec:
- uri = rec["uri"]
- else:
- uri = None
-
- ####
- # Now do the lookup.
- art = None
- poster = fanart = None
-
- # If we're not forcing a refresh then use any existing values from
- # the dvr record.
- if not force_refresh:
- if 'image' in rec and rec['image'] is not None and len(rec['image']):
- poster = rec['image']
- if 'fanart_image' in rec and rec['fanart_image'] is not None and len(rec['fanart_image']):
- fanart = rec['fanart_image']
-
- for lang in title_tuple:
- title = title_tuple[lang]
- for module in clients:
- logging.info("Trying title %s year %s uri %s in language %s with client %s", title, year, uri, lang, module);
- try:
- # Create an object inside the imported module (with same
- # name as module, but initial letter as capital) for
- # fetching the details.
- #
- # So module "tv_meta_tmdb.py" will have class
- # "Tv_meta_tmdb" which contains functions fetch_details.
- #
- # Currently we only do one lookup per client, but in the
- # future we may allow a "refresh all" option for
- # re-parsing all recordings without artwork.
- if module not in client_modules:
- try:
- logging.debug("Importing module %s" % module)
- client_modules[module] = __import__(module)
- obj_fn = getattr(client_modules[module], module.capitalize())
- # We pass arguments to the module from the command line.
- module_init_args = self._get_module_init_args(module)
- obj = obj_fn(module_init_args)
- client_objects[module] = obj
- except Exception as e:
- logging.info("Failed to import and create module %s: %s" % (module, e))
- raise
- else:
- obj = client_objects[module]
- logging.debug("Got object %s" % obj)
- if episode_disp is not None and len(episode_disp) > 0:
- type = "tv"
- else:
- type = "movie"
- art = obj.fetch_details({
- "title": title,
- "language": self._lang3_to_lang2(lang),
- "year": year,
- "type": type,
- "episode_disp": episode_disp, # @todo Need to break this out in to season/episode, maybe subtitle too.
- "programid": uri})
-
- if poster is None and art["poster"] is not None: poster = art["poster"]
- if fanart is None and art["fanart"] is not None: fanart = art["fanart"]
- if poster is None and fanart is None:
- logging.error("Lookup success, but still no artwork")
- elif poster is not None and fanart is not None:
- break
- else:
- logging.info("Got poster %s and fanart %s so will try and get more artwork from other providers (if any)" % (poster, fanart))
- except Exception as e:
- # Only include a traceback in debug mode, otherwise it
- # clutters the text if user runs it without api keys.
- extraText = " with error " + traceback.format_exc() if logging.root.isEnabledFor(logging.DEBUG) else ""
- logging.info("Lookup failed with module %s for uuid %s title %s year %s in language %s%s", module, uuid, title, year, lang, extraText)
- # And continue to next language
-
- if poster is None and fanart is None:
- logging.error("Lookup completely failed for uuid %s title %s year %s", uuid, title, year)
- raise KeyError("Lookup completely failed for uuid {} title {} year {}".format(uuid, title, year))
-
- # Got map of fanart, poster
- logging.info("Lookup success for uuid %s title %s year %s with results poster: %s fanart: %s", uuid, title, year, poster, fanart)
- if poster is None and fanart is None:
- logging.info("No artwork found")
- else:
- self.persist_artwork(uuid, poster, fanart)
+
+class TvhMeta():
+ """ top level class for tvh meta """
+ def __init__(self, host, port, user, password, grabber_args):
+ self.host = host
+ self.port = port
+ self.user = user
+ self.password = password
+ self.grabber_args = grabber_args
+ logging.debug("grabber_args=%s", grabber_args)
+
+ @staticmethod
+ def get_meta_grabbers():
+ grabbers = set()
+ for i in sys.path:
+ for grabber in glob.glob(os.path.join(i, "tv_meta_*.py")):
+ (_path, filename) = os.path.split(grabber)
+ filename = filename.replace(".py", "")
+ logging.debug("Adding grabber %s from %s", filename, grabber)
+ grabbers.add(filename)
+ return sorted(list(grabbers))
+
+ def _get_meta_grabbers_for_capability_common(self, capability=None, addfn=None):
+ grabbers = self.get_meta_grabbers()
+ logging.debug("Got grabbers %s", grabbers)
+ ret = set()
+ for module_name in grabbers:
+ try:
+ logging.debug("Importing %s", module_name)
+ mod = __import__(module_name)
+ #obj_fn = getattr(mod, module_name.capitalize())
+ cap_fn = getattr(mod, "get_capabilities")
+ capabilities = cap_fn()
+ logging.debug("Module %s has capabilities %s", module_name, capabilities)
+
+ if capability is None or capabilities[capability]:
+ if addfn:
+ addfn(mod, module_name, capabilities)
+ else:
+ ret.add(module_name)
+ except Exception as e: # too broad -> list of exceptions to catch
+ logging.exception("Could not import module %s when searching for %s: %s",
+ module_name, capability, e)
+ return sorted(list(ret))
+
+ def get_meta_grabbers_for_movie(self):
+ return self._get_meta_grabbers_for_capability_common("supports_movie")
+
+ def get_meta_grabbers_for_tv(self):
+ return self._get_meta_grabbers_for_capability_common("supports_tv")
+
+ def get_meta_grabbers_capabilities(self):
+ ret = {}
+ def addit(_mod, module_name, capabilities):
+ ret[module_name] = capabilities
+ self._get_meta_grabbers_for_capability_common(addfn=addit)
+ return ret
+
+ def _get_module_init_args(self, module_name):
+ """Return initialization arguments suitable for the module."""
+ if self.grabber_args is None:
+ return {}
+
+ args = {}
+ # Convert module name from "tv_meta_tmdb_simple" to "tmdb-simple",
+ # which is more like a command line option.
+ module_simple_name = module_name.replace("tv_meta_", "").replace("_", "-")
+ logging.debug("Using module simple name of %s for %s", module_simple_name, module_name)
+
+ # Then we find any arguments that have the prefix "tmdb-simple"
+ # and add them to our arguments.
+ for key in self.grabber_args:
+ # Only match keys for this module. So for "tv_meta_tmdb" and command line argument
+ # of "tmdb-key", we would have a simple module name of "tmdb" and would want to
+ # match "tmdb-" (to ensure we don't match with tmdbabc module).
+ if key.startswith(module_simple_name + "-"):
+ # We want the command line option "tmdb-key" to be passed to
+ # the module as simply "key" since modules don't want long
+ # prefixes on every argument.
+ value = self.grabber_args[key]
+ key = key.replace(module_simple_name + "-", "")
+ args[key] = value
+
+ logging.debug("Generated arguments for module %s of %s",
+ module_name, args)
+ return args
+
+ def request(self, url, data):
+ """Send a request for data to Tvheadend."""
+ ret = ''
+ full_url = f'http://{self.host}:{self.port}/{url}'
+
+ try:
+ req = urllib.request.Request(full_url, method="POST", data=bytearray(data, 'utf-8'))
+ except (urllib.error.HTTPError, urllib.error.URLError) as urllib_err:
+ logging.debug('Failed with %s', urllib_err)
+ return ret
+
+ if self.user is not None and self.password is not None:
+ base64string = base64.b64encode(bytes(f'{self.user}:{self.password}','ascii'))
+ req.add_header('Authorization', f'Basic {base64string.decode("utf-8")}')
+
+ logging.info("Sending %s to %s", data, full_url)
+
+ try:
+ with urllib.request.urlopen(req) as url_fp:
+ got = url_fp.read()
+ if got:
+ ret = got.decode('UTF-8', errors='replace')
+ logging.debug("Received: %s", ret)
+ except (urllib.error.HTTPError, urllib.error.URLError) as urllib_err:
+ logging.debug('Failed with %s', urllib_err)
+ return ret
+
+ def persist_artwork(self, uuid, artwork_url, fanart_url):
+ """Persist the artwork to Tvheadend."""
+ new_data_dict = {"uuid": uuid}
+ if artwork_url is not None:
+ new_data_dict['image'] = artwork_url
+ if fanart_url is not None:
+ new_data_dict['fanart_image'] = fanart_url
+
+ new_data = 'node=[' + json.dumps(new_data_dict) + ']'
+ replace = self.request("api/idnode/save", new_data)
+ return replace
+
+ def _lang3_to_lang2(self, lang3):
+ """Convert from ISO 639-2 (3 letter code) + region to ISO 639-1 (2 letter code)"""
+ # This is taken from tvh_locale.c, but "_" is replaced with "-" on the mapped side.
+ iso_map = {
+ "ach": "ach",
+ "ady": "ady",
+ "ara": "ar",
+ "bul": "bg",
+ "cze": "cs",
+ "dan": "da",
+ "ger": "de",
+ "eng": "en-US",
+ "eng_GB": "en-GB",
+ "eng_US": "en-US",
+ "spa": "es",
+ "est": "et",
+ "per": "fa",
+ "fin": "fi",
+ "fre": "fr",
+ "heb": "he",
+ "hrv": "hr",
+ "hun": "hu",
+ "ita": "it",
+ "kor": "ko",
+ "lav": "lv",
+ "lit": "lt",
+ "dut": "nl",
+ "nor": "no",
+ "pol": "pl",
+ "por": "pt",
+ "rum": "ro",
+ "rus": "ru",
+ "slv": "sl",
+ "slo": "sk",
+ "srp": "sr",
+ "alb": "sq",
+ "swe": "sv",
+ "tur": "tr",
+ "ukr": "uk",
+ "chi": "zh",
+ "chi_CN": "zh-Hans",
+ }
+ try:
+ return iso_map[lang3]
+ except:
+ # No mapping. Return "English" as default.
+ return "en"
+
+ def fetch_and_persist_artwork(self, uuid, force_refresh, modules_movie, modules_tv):
+ """Fetch artwork for the given uuid."""
+ data = urlencode(
+ {"uuid": uuid,
+ "list": "uuid,image,fanart_image,title,copyright_year,episode_disp,uri",
+ "grid": 1
+ })
+ # Our json looks like this:
+ # {"entries":[{"uuid":"abc..,"image":"...","fanart_image":"...","title":{"eng":"TITLE"},"copyright_year":2014}]}
+ # So go through the structure to get the record
+ okay = False
+ recjson = self.request("api/idnode/load", data)
+ try:
+ recall = json.loads(recjson)
+ recentries = recall["entries"]
+ if len(recentries) == 0:
+ okay = False
+ except json.JSONDecodeError :
+ okay = False
+ if not okay:
+ raise RuntimeError("No entries found for uuid " + uuid)
+
+ rec = recentries[0]
+ title_tuple = rec["title"]
+ if title_tuple is None:
+ raise RuntimeError("Record has no title: " + data)
+
+ if not force_refresh and "image" in rec and "fanart_image" in rec and rec["image"] is not None and rec["image"] != "" and rec["fanart_image"] is not None and rec["fanart_image"] != "":
+ logging.info(
+ "We have both image and fanart_image already for %s so nothing to do (%s)", uuid, recjson)
+ return
+
+ episode_disp = rec["episode_disp"]
+ # We lazily create the objects only when needed so user can
+ # specify fallback grabbers that are only initialized when needed.
+ clients = {}
+ client_modules = {}
+ client_objects = {}
+ if episode_disp is not None and episode_disp != "":
+ # TV episode, so load the tv modules
+ # Have to do len before split since split of an empty string
+ # returns one element...
+ if len(modules_tv) == 0:
+ logging.info("Program is an episode, not a movie, and no modules available for lookup possible for title %s episode %s", title_tuple, episode_disp)
+ raise RuntimeError(f'Program is an episode and no tv modules available {data}')
+ clients = modules_tv.split(",")
+ else:
+ # Import our modules for processing movies.
+ if len(modules_movie) == 0:
+ logging.info(
+ "Program is a movie, and no modules available for lookup possible for title %s",title_tuple)
+ raise RuntimeError(f'Program is movie and no movie modules available {data}')
+ clients = modules_movie.split(",")
+
+ year = rec["copyright_year"]
+ # Avoid passing in a zero year to our lookups.
+ if year == 0:
+ year = None
+
+ # We fetch uri (programid) since some xmltv modules
+ # have artwork based on the id they provided.
+ if 'uri' in rec:
+ uri = rec["uri"]
+ else:
+ uri = None
+
+ ####
+ # Now do the lookup.
+ art = None
+ poster = fanart = None
+
+ # If we're not forcing a refresh then use any existing values from
+ # the dvr record.
+ if not force_refresh:
+ if 'image' in rec and rec['image'] is not None and len(rec['image']):
+ poster = rec['image']
+ if 'fanart_image' in rec and rec['fanart_image'] is not None and len(rec['fanart_image']):
+ fanart = rec['fanart_image']
+
+ for lang in title_tuple:
+ title = title_tuple[lang]
+ for module in clients:
+ logging.info(
+ "Trying title %s year %s uri %s in language %s with client %s", title, year, uri, lang, module)
+ try:
+ # Create an object inside the imported module (with same
+ # name as module, but initial letter as capital) for
+ # fetching the details.
+ #
+ # So module "tv_meta_tmdb.py" will have class
+ # "Tv_meta_tmdb" which contains functions fetch_details.
+ #
+ # Currently we only do one lookup per client, but in the
+ # future we may allow a "refresh all" option for
+ # re-parsing all recordings without artwork.
+ if module not in client_modules:
+ try:
+ logging.debug("Importing module %s", module)
+ client_modules[module] = __import__(module)
+ obj_fn = getattr(client_modules[module], module.capitalize())
+
+ # We pass arguments to the module from the command line.
+ module_init_args = self._get_module_init_args(module)
+ obj = obj_fn(module_init_args)
+ client_objects[module] = obj
+ except Exception as e:
+ logging.info("Failed to import and create module %s: %s", module, e)
+ raise
+ else:
+ obj = client_objects[module]
+
+ logging.debug("Got object %s", obj)
+ if episode_disp is not None and len(episode_disp) > 0:
+ _type = "tv" # dont use keyword type
+ else:
+ _type = "movie"
+ art = obj.fetch_details({
+ "title": title,
+ "language": self._lang3_to_lang2(lang),
+ "year": year,
+ "type": _type,
+ # @todo Need to break this out in to season/episode, maybe subtitle too.
+ "episode_disp": episode_disp,
+ "programid": uri})
+
+ if poster is None and art["poster"] is not None:
+ poster = art["poster"]
+ if fanart is None and art["fanart"] is not None:
+ fanart = art["fanart"]
+ if poster is None and fanart is None:
+ logging.error("Lookup success, but still no artwork")
+ elif poster is not None and fanart is not None:
+ break
+ else:
+ logging.info("Got poster %s and fanart %s so will try and get more artwork from other providers (if any)", poster, fanart)
+ except Exception as _e:
+ # Only include a traceback in debug mode, otherwise it
+ # clutters the text if user runs it without api keys.
+ extraText = " with error " + \
+ traceback.format_exc() if logging.root.isEnabledFor(logging.DEBUG) else ""
+ logging.info("Lookup failed with module %s for uuid %s title %s year %s in language %s%s",
+ module, uuid, title, year, lang, extraText)
+ # And continue to next language
+
+ if poster is None and fanart is None:
+ logging.error(
+ "Lookup completely failed for uuid %s title %s year %s", uuid, title, year)
+ raise KeyError(f"Lookup completely failed for uuid {uuid} title {title} year {year}")
+
+ # Got map of fanart, poster
+ logging.info("Lookup success for uuid %s title %s year %s with results poster: %s fanart: %s",
+ uuid, title, year, poster, fanart)
+ if poster is None and fanart is None:
+ logging.info("No artwork found")
+ else:
+ self.persist_artwork(uuid, poster, fanart)
+
if __name__ == '__main__':
- def parse_remaining_args(argv):
- """The parse_known_args returns an argv of unknown arguments.
+ def parse_remaining_args(argv):
+ """The parse_known_args returns an argv of unknown arguments.
-We split that in to a dict so we can pass to the grabbers.
-This allows us to pass additional command line options to the grabbers.
+ We split that in to a dict so we can pass to the grabbers.
+ This allows us to pass additional command line options to the grabbers.
+
+ Options are assumed to basically be name=value pairs or name (implied=1).
+ Each module should prefix their arguments with the short name of the module.
+ So for "tv_meta_tmdb" we would have "tmdb-key", "tmdb-user", etc.
+ (since we have stripped the 'tv_meta_' bit).
+ """
+ ret = {}
+ if argv is None:
+ return ret
-Options are assumed to basically be name=value pairs or name (implied=1).
-Each module should prefix their arguments with the short name of the module.
-So for "tv_meta_tmdb" we would have "tmdb-key", "tmdb-user", etc.
-(since we have stripped the 'tv_meta_' bit).
-"""
- ret = {}
- if argv is None:
- return ret
-
- prev_arg = None
-
- # We try to parse --key=value and --key (default to 1)
- # and "--key value"
- for arg in argv:
- if arg.startswith("--"):
- arg = arg[2:]
-
- if '=' in arg:
- (opt,value) = arg.split('=', 1)
- ret[opt] = value
- prev_arg = None
- else:
- ret[arg] = 1
- prev_arg = arg
- elif prev_arg is not None and '=' not in arg:
- ret[prev_arg] = arg
prev_arg = None
- logging.debug("Remaining args dict = %s" % ret)
- return ret
-
-
-
- def process(argv):
- import argparse
- optp = argparse.ArgumentParser(
- description="Fetch additional metadata (such as artwork) for Tvheadend")
- optp.add_argument('--host', default='localhost',
- help='Specify HTSP server hostname')
- optp.add_argument('--port', default=9981, type=int,
- help='Specify HTTP server port')
- optp.add_argument('--user', default=None,
- help='Specify HTTP authentication username')
- optp.add_argument('--password', default=None,
- help='Specify HTTP authentication password')
- optp.add_argument('--artwork-url', default=None,
- help='For a specific artwork URL')
- optp.add_argument('--fanart-url', default=None,
- help='Force a specific fanart URL')
- optp.add_argument('--uuid', default=None,
- help='Specify UUID on which to operate')
- optp.add_argument('--force-refresh', default=None, action="store_true",
- help='Force refreshing artwork even if artwork exists.')
- optp.add_argument('--modules-movie', default=None,
- help='Specify comma-separated list of modules for fetching artwork.')
- optp.add_argument('--modules-tv', default=None,
- help='Specify comma-separated list of modules for fetching artwork.')
- optp.add_argument('--list-grabbers', default=None, action="store_true",
- help='Generate a list of available grabbers.'),
- optp.add_argument('--list-grabber-capabilities', default=None, action="store_true",
- help='Generate a list of available grabbers with their capabilities.'),
- optp.add_argument('--debug', default=None, action="store_true",
- help='Enable debug.')
-
- (opts, remaining_args) = optp.parse_known_args(argv)
- if (opts.debug):
- logging.root.setLevel(logging.DEBUG)
- logging.debug("Got args %s and remaining_args %s" % (opts, remaining_args))
-
- # Any unknown options are assumed to be options for the grabber
- # modules.
- grabber_args = parse_remaining_args(remaining_args)
- tvhmeta = TvhMeta(opts.host, opts.port, opts.user, opts.password, grabber_args)
- if (opts.list_grabbers):
- print(json.dumps(tvhmeta.get_meta_grabbers(), sort_keys=True))
- return 0
-
- if (opts.list_grabber_capabilities):
- print(json.dumps(tvhmeta.get_meta_grabbers_capabilities(), sort_keys=True))
- return 0
-
- if (opts.uuid is None):
- print("Need --uuid")
- return 1
- # If they are explicitly specified on command line, then use them, otherwise do a lookup.
- if (opts.artwork_url is not None and opts.fanart_url is not None):
- tvhmeta.persist_artwork(opts.uuid, opts.artwork_url, opts.fanart_url)
- else:
- if opts.modules_movie is None: opts.modules_movie = ','.join(tvhmeta.get_meta_grabbers_for_movie())
- if opts.modules_tv is None: opts.modules_tv = ','.join(tvhmeta.get_meta_grabbers_for_tv())
-
- logging.info("Got movie modules: [%s] tv modules [%s]" % (opts.modules_movie, opts.modules_tv))
- tvhmeta.fetch_and_persist_artwork(opts.uuid, opts.force_refresh, opts.modules_movie, opts.modules_tv)
-
- try:
- logging.basicConfig(level=logging.INFO, format='%(asctime)s:%(levelname)s:%(module)s:%(lineno)d:%(message)s', stream=sys.stdout)
- # argv[0] is program name so don't pass that as args
- process(sys.argv[1:])
- except KeyboardInterrupt: pass
- except (KeyError, RuntimeError) as err:
- logging.error("Failed to process with error: " + str(err))
- sys.exit(1)
+ # We try to parse --key=value and --key (default to 1)
+ # and "--key value"
+ for arg in argv:
+ if arg.startswith("--"):
+ arg = arg[2:]
+
+ if '=' in arg:
+ (opt, value) = arg.split('=', 1)
+ ret[opt] = value
+ prev_arg = None
+ else:
+ ret[arg] = 1
+ prev_arg = arg
+ elif prev_arg is not None and '=' not in arg:
+ ret[prev_arg] = arg
+ prev_arg = None
+
+ logging.debug("Remaining args dict = %s", ret)
+ return ret
+
+ def process(argv):
+ optp = argparse.ArgumentParser(
+ description="Fetch additional metadata (such as artwork) for Tvheadend")
+ optp.add_argument('--host', default='localhost',
+ help='Specify HTSP server hostname')
+ optp.add_argument('--port', default=9981, type=int,
+ help='Specify HTTP server port')
+ optp.add_argument('--user', default=None,
+ help='Specify HTTP authentication username')
+ optp.add_argument('--password', default=None,
+ help='Specify HTTP authentication password')
+ optp.add_argument('--artwork-url', default=None,
+ help='For a specific artwork URL')
+ optp.add_argument('--fanart-url', default=None,
+ help='Force a specific fanart URL')
+ optp.add_argument('--uuid', default=None,
+ help='Specify UUID on which to operate')
+ optp.add_argument('--force-refresh', default=None, action="store_true",
+ help='Force refreshing artwork even if artwork exists.')
+ optp.add_argument('--modules-movie', default=None,
+ help='Specify comma-separated list of modules for fetching artwork.')
+ optp.add_argument('--modules-tv', default=None,
+ help='Specify comma-separated list of modules for fetching artwork.')
+ optp.add_argument('--list-grabbers', default=None, action="store_true",
+ help='Generate a list of available grabbers.')
+ optp.add_argument('--list-grabber-capabilities', default=None, action="store_true",
+ help='Generate a list of available grabbers with their capabilities.')
+ optp.add_argument('--debug', default=None, action="store_true",
+ help='Enable debug.')
+
+ (opts, remaining_args) = optp.parse_known_args(argv)
+ if opts.debug:
+ logging.root.setLevel(logging.DEBUG)
+ logging.debug("Got args %s and remaining_args %s", opts, remaining_args)
+
+ # Any unknown options are assumed to be options for the grabber
+ # modules.
+ grabber_args = parse_remaining_args(remaining_args)
+ tvhmeta = TvhMeta(opts.host, opts.port, opts.user, opts.password, grabber_args)
+
+ if opts.list_grabbers:
+ print(json.dumps(tvhmeta.get_meta_grabbers(), sort_keys=True))
+ return 0
+
+ if opts.list_grabber_capabilities:
+ print(json.dumps(tvhmeta.get_meta_grabbers_capabilities(), sort_keys=True))
+ return 0
+
+ if opts.uuid is None:
+ print("Need --uuid")
+ return 1
+ # If they are explicitly specified on command line, then use them, otherwise do a lookup.
+ if (opts.artwork_url is not None and opts.fanart_url is not None):
+ tvhmeta.persist_artwork(
+ opts.uuid, opts.artwork_url, opts.fanart_url)
+ else:
+ if opts.modules_movie is None:
+ opts.modules_movie = ','.join(
+ tvhmeta.get_meta_grabbers_for_movie())
+ if opts.modules_tv is None:
+ opts.modules_tv = ','.join(tvhmeta.get_meta_grabbers_for_tv())
+
+ logging.info("Got movie modules: [%s] tv modules [%s]",
+ opts.modules_movie, opts.modules_tv)
+ tvhmeta.fetch_and_persist_artwork(
+ opts.uuid, opts.force_refresh, opts.modules_movie, opts.modules_tv)
+ return 0
+
+ try:
+ logging.basicConfig(
+ level=logging.INFO, format='%(asctime)s:%(levelname)s:%(module)s:%(lineno)d:%(message)s', stream=sys.stdout)
+ # argv[0] is program name so don't pass that as args
+ process(sys.argv[1:])
+ except KeyboardInterrupt:
+ pass
+ except (KeyError, RuntimeError) as err:
+ logging.error("Failed to process with error: %s", str(err))
+ sys.exit(1)
projects / thirdparty / tvheadend.git / commitdiff
