jellyfin-kodi/resources/lib/artwork.py

# -*- coding: utf-8 -*-

#################################################################################################

import json
import requests
import os
import urllib
from sqlite3 import OperationalError

import xbmc
import xbmcgui
import xbmcvfs

import clientinfo
import image_cache_thread
from utils import Logging, window, settings, kodiSQL

#################################################################################################


class Artwork():

    xbmc_host = 'localhost'
    xbmc_port = None
    xbmc_username = None
    xbmc_password = None

    imageCacheThreads = []
    imageCacheLimitThreads = 0


    def __init__(self):

        global log
        log = Logging(self.__class__.__name__).log

        self.clientinfo = clientinfo.ClientInfo()
        self.addonName = self.clientinfo.getAddonName()

        self.enableTextureCache = settings('enableTextureCache') == "true"
        self.imageCacheLimitThreads = int(settings('imageCacheLimit'))
        self.imageCacheLimitThreads = int(self.imageCacheLimitThreads * 5)
        log("Using Image Cache Thread Count: %s" % self.imageCacheLimitThreads, 1)

        if not self.xbmc_port and self.enableTextureCache:
            self.setKodiWebServerDetails()

        self.userId = window('emby_currUser')
        self.server = window('emby_server%s' % self.userId)


    def double_urlencode(self, text):
        text = self.single_urlencode(text)
        text = self.single_urlencode(text)

        return text

    def single_urlencode(self, text):
        # urlencode needs a utf- string
        text = urllib.urlencode({'blahblahblah':text.encode("utf-8")}) 
        text = text[13:]

        return text.decode("utf-8") #return the result again as unicode

    def setKodiWebServerDetails(self):
        # Get the Kodi webserver details - used to set the texture cache
        web_query = {

            "jsonrpc": "2.0",
            "id": 1,
            "method": "Settings.GetSettingValue",
            "params": {

                "setting": "services.webserver"
            }
        }
        result = xbmc.executeJSONRPC(json.dumps(web_query))
        result = json.loads(result)
        try:
            xbmc_webserver_enabled = result['result']['value']
        except (KeyError, TypeError):
            xbmc_webserver_enabled = False

        if not xbmc_webserver_enabled:
            # Enable the webserver, it is disabled
            web_port = {

                "jsonrpc": "2.0",
                "id": 1,
                "method": "Settings.SetSettingValue",
                "params": {

                    "setting": "services.webserverport",
                    "value": 8080
                }
            }
            result = xbmc.executeJSONRPC(json.dumps(web_port))
            self.xbmc_port = 8080

            web_user = {

                "jsonrpc": "2.0",
                "id": 1,
                "method": "Settings.SetSettingValue",
                "params": {

                    "setting": "services.webserver",
                    "value": True
                }
            }
            result = xbmc.executeJSONRPC(json.dumps(web_user))
            self.xbmc_username = "kodi"


        # Webserver already enabled
        web_port = {

            "jsonrpc": "2.0",
            "id": 1,
            "method": "Settings.GetSettingValue",
            "params": {

                "setting": "services.webserverport"
            }
        }
        result = xbmc.executeJSONRPC(json.dumps(web_port))
        result = json.loads(result)
        try:
            self.xbmc_port = result['result']['value']
        except TypeError:
            pass

        web_user = {

            "jsonrpc": "2.0",
            "id": 1,
            "method": "Settings.GetSettingValue",
            "params": {

                "setting": "services.webserverusername"
            }
        }
        result = xbmc.executeJSONRPC(json.dumps(web_user))
        result = json.loads(result)
        try:
            self.xbmc_username = result['result']['value']
        except TypeError:
            pass

        web_pass = {

            "jsonrpc": "2.0",
            "id": 1,
            "method": "Settings.GetSettingValue",
            "params": {

                "setting": "services.webserverpassword"
            }
        }
        result = xbmc.executeJSONRPC(json.dumps(web_pass))
        result = json.loads(result)
        try:
            self.xbmc_password = result['result']['value']
        except TypeError:
            pass

    def FullTextureCacheSync(self):
        # This method will sync all Kodi artwork to textures13.db
        # and cache them locally. This takes diskspace!
        dialog = xbmcgui.Dialog()

        if not dialog.yesno(
                    heading="Image Texture Cache",
                    line1=(
                        "Running the image cache process can take some time. "
                        "Are you sure you want continue?")):
            return

        log("Doing Image Cache Sync", 1)

        pdialog = xbmcgui.DialogProgress()
        pdialog.create("Emby for Kodi", "Image Cache Sync")

        # ask to rest all existing or not
        if dialog.yesno("Image Texture Cache", "Reset all existing cache data first?"):
            log("Resetting all cache data first.", 1)
            
            # Remove all existing textures first
            path = xbmc.translatePath('special://thumbnails/').decode('utf-8')
            if xbmcvfs.exists(path):
                allDirs, allFiles = xbmcvfs.listdir(path)
                for dir in allDirs:
                    allDirs, allFiles = xbmcvfs.listdir(path+dir)
                    for file in allFiles:
                        if os.path.supports_unicode_filenames:
                            path = os.path.join(path+dir.decode('utf-8'),file.decode('utf-8'))
                            xbmcvfs.delete(path)
                        else:
                            xbmcvfs.delete(os.path.join(path.encode('utf-8')+dir,file))

            # remove all existing data from texture DB
            connection = kodiSQL('texture')
            cursor = connection.cursor()
            cursor.execute('SELECT tbl_name FROM sqlite_master WHERE type="table"')
            rows = cursor.fetchall()
            for row in rows:
                tableName = row[0]
                if tableName != "version":
                    cursor.execute("DELETE FROM " + tableName)
            connection.commit()
            cursor.close()

        # Cache all entries in video DB
        connection = kodiSQL('video')
        cursor = connection.cursor()
        cursor.execute("SELECT url FROM art WHERE media_type != 'actor'") # dont include actors
        result = cursor.fetchall()
        total = len(result)
        log("Image cache sync about to process %s images" % total, 1)
        cursor.close()

        count = 0
        for url in result:
            
            if pdialog.iscanceled():
                break

            percentage = int((float(count) / float(total))*100)
            message = "%s of %s (%s)" % (count, total, self.imageCacheThreads)
            pdialog.update(percentage, "Updating Image Cache: %s" % message)
            self.cacheTexture(url[0])
            count += 1
        

        # Cache all entries in music DB
        connection = kodiSQL('music')
        cursor = connection.cursor()
        cursor.execute("SELECT url FROM art")
        result = cursor.fetchall()
        total = len(result)
        log("Image cache sync about to process %s images" % total, 1)
        cursor.close()

        count = 0
        for url in result:
            
            if pdialog.iscanceled():
                break

            percentage = int((float(count) / float(total))*100)
            message = "%s of %s" % (count, total)
            pdialog.update(percentage, "Updating Image Cache: %s" % message)
            self.cacheTexture(url[0])
            count += 1
        

        pdialog.update(100, "Waiting for all threads to exit: %s" % len(self.imageCacheThreads))
        log("Waiting for all threads to exit", 1)
        
        while len(self.imageCacheThreads):
            for thread in self.imageCacheThreads:
                if thread.isFinished:
                    self.imageCacheThreads.remove(thread)
            pdialog.update(100, "Waiting for all threads to exit: %s" % len(self.imageCacheThreads))
            log("Waiting for all threads to exit: %s" % len(self.imageCacheThreads), 1)
            xbmc.sleep(500)

        pdialog.close()

    def addWorkerImageCacheThread(self, url):

        while True:
            # removed finished
            for thread in self.imageCacheThreads:
                if thread.isFinished:
                    self.imageCacheThreads.remove(thread)

            # add a new thread or wait and retry if we hit our limit
            if len(self.imageCacheThreads) < self.imageCacheLimitThreads:
                newThread = image_cache_thread.image_cache_thread()
                newThread.setUrl(self.double_urlencode(url))
                newThread.setHost(self.xbmc_host, self.xbmc_port)
                newThread.setAuth(self.xbmc_username, self.xbmc_password)
                newThread.start()
                self.imageCacheThreads.append(newThread)
                return
            else:
                log("Waiting for empty queue spot: %s" % len(self.imageCacheThreads), 2)
                xbmc.sleep(50)

    def cacheTexture(self, url):
        # Cache a single image url to the texture cache
        if url and self.enableTextureCache:
            log("Processing: %s" % url, 2)

            if not self.imageCacheLimitThreads:
                # Add image to texture cache by simply calling it at the http endpoint

                url = self.double_urlencode(url)
                try: # Extreme short timeouts so we will have a exception.
                    response = requests.head(
                                        url=("http://%s:%s/image/image://%s"
                                            % (self.xbmc_host, self.xbmc_port, url)),
                                        auth=(self.xbmc_username, self.xbmc_password),
                                        timeout=(0.01, 0.01))
                # We don't need the result
                except: pass

            else:
                self.addWorkerImageCacheThread(url)


    def addArtwork(self, artwork, kodi_id, media_type, cursor):
        # Kodi conversion table
        kodiart = {

            'Primary': ["thumb", "poster"],
            'Banner': "banner",
            'Logo': "clearlogo",
            'Art': "clearart",
            'Thumb': "landscape",
            'Disc': "discart",
            'Backdrop': "fanart",
            'BoxRear': "poster"
        }

        # Artwork is a dictionary
        for art in artwork:

            if art == "Backdrop":
                # Backdrop entry is a list
                # Process extra fanart for artwork downloader (fanart, fanart1, fanart2...)
                backdrops = artwork[art]
                backdropsNumber = len(backdrops)

                query = ' '.join((

                    "SELECT url",
                    "FROM art",
                    "WHERE media_id = ?",
                    "AND media_type = ?",
                    "AND type LIKE ?"
                ))
                cursor.execute(query, (kodi_id, media_type, "fanart%",))
                rows = cursor.fetchall()

                if len(rows) > backdropsNumber:
                    # More backdrops in database. Delete extra fanart.
                    query = ' '.join((

                        "DELETE FROM art",
                        "WHERE media_id = ?",
                        "AND media_type = ?",
                        "AND type LIKE ?"
                    ))
                    cursor.execute(query, (kodi_id, media_type, "fanart_",))

                # Process backdrops and extra fanart
                index = ""
                for backdrop in backdrops:
                    self.addOrUpdateArt(
                        image_url=backdrop,
                        kodi_id=kodi_id,
                        media_type=media_type,
                        image_type="%s%s" % ("fanart", index),
                        cursor=cursor)

                    if backdropsNumber > 1:
                        try: # Will only fail on the first try, str to int.
                            index += 1
                        except TypeError:
                            index = 1

            elif art == "Primary":
                # Primary art is processed as thumb and poster for Kodi.
                for artType in kodiart[art]:
                    self.addOrUpdateArt(
                        image_url=artwork[art],
                        kodi_id=kodi_id,
                        media_type=media_type,
                        image_type=artType,
                        cursor=cursor)

            elif kodiart.get(art):
                # Process the rest artwork type that Kodi can use
                self.addOrUpdateArt(
                    image_url=artwork[art],
                    kodi_id=kodi_id,
                    media_type=media_type,
                    image_type=kodiart[art],
                    cursor=cursor)

    def addOrUpdateArt(self, image_url, kodi_id, media_type, image_type, cursor):
        # Possible that the imageurl is an empty string
        if image_url:
            cacheimage = False

            query = ' '.join((

                "SELECT url",
                "FROM art",
                "WHERE media_id = ?",
                "AND media_type = ?",
                "AND type = ?"
            ))
            cursor.execute(query, (kodi_id, media_type, image_type,))
            try: # Update the artwork
                url = cursor.fetchone()[0]

            except TypeError: # Add the artwork
                cacheimage = True
                log("Adding Art Link for kodiId: %s (%s)" % (kodi_id, image_url), 2)

                query = (
                    '''
                    INSERT INTO art(media_id, media_type, type, url)

                    VALUES (?, ?, ?, ?)
                    '''
                )
                cursor.execute(query, (kodi_id, media_type, image_type, image_url))

            else: # Only cache artwork if it changed
                if url != image_url:
                    cacheimage = True

                    # Only for the main backdrop, poster
                    if (window('emby_initialScan') != "true" and
                            image_type in ("fanart", "poster")):
                        # Delete current entry before updating with the new one
                        self.deleteCachedArtwork(url)

                    log("Updating Art url for %s kodiId: %s (%s) -> (%s)"
                        % (image_type, kodi_id, url, image_url), 1)

                    query = ' '.join((

                        "UPDATE art",
                        "SET url = ?",
                        "WHERE media_id = ?",
                        "AND media_type = ?",
                        "AND type = ?"
                    ))
                    cursor.execute(query, (image_url, kodi_id, media_type, image_type))

            # Cache fanart and poster in Kodi texture cache
            if cacheimage and image_type in ("fanart", "poster"):
                self.cacheTexture(image_url)

    def deleteArtwork(self, kodi_id, media_type, cursor):

        query = ' '.join((

            "SELECT url, type",
            "FROM art",
            "WHERE media_id = ?",
            "AND media_type = ?"
        ))
        cursor.execute(query, (kodi_id, media_type,))
        rows = cursor.fetchall()
        for row in rows:

            url = row[0]
            imagetype = row[1]
            if imagetype in ("poster", "fanart"):
                self.deleteCachedArtwork(url)

    def deleteCachedArtwork(self, url):
        # Only necessary to remove and apply a new backdrop or poster
        connection = kodiSQL('texture')
        cursor = connection.cursor()

        try:
            cursor.execute("SELECT cachedurl FROM texture WHERE url = ?", (url,))
            cachedurl = cursor.fetchone()[0]

        except TypeError:
            log("Could not find cached url.", 1)

        except OperationalError:
            log("Database is locked. Skip deletion process.", 1)

        else: # Delete thumbnail as well as the entry
            thumbnails = xbmc.translatePath("special://thumbnails/%s" % cachedurl).decode('utf-8')
            log("Deleting cached thumbnail: %s" % thumbnails, 1)
            xbmcvfs.delete(thumbnails)

            try:
                cursor.execute("DELETE FROM texture WHERE url = ?", (url,))
                connection.commit()
            except OperationalError:
                log("Issue deleting url from cache. Skipping.", 2)

        finally:
            cursor.close()

    def getPeopleArtwork(self, people):
        # append imageurl if existing
        for person in people:

            personId = person['Id']
            tag = person.get('PrimaryImageTag')

            image = ""
            if tag:
                image = (
                    "%s/emby/Items/%s/Images/Primary?"
                    "MaxWidth=400&MaxHeight=400&Index=0&Tag=%s"
                    % (self.server, personId, tag))

            person['imageurl'] = image

        return people

    def getUserArtwork(self, item_id, item_type):
        # Load user information set by UserClient
        image = ("%s/emby/Users/%s/Images/%s?Format=original"
                    % (self.server, item_id, item_type))
        return image

    def getAllArtwork(self, item, parentInfo=False):

        itemid = item['Id']
        artworks = item['ImageTags']
        backdrops = item.get('BackdropImageTags', [])

        maxHeight = 10000
        maxWidth = 10000
        customquery = ""

        if settings('compressArt') == "true":
            customquery = "&Quality=90"

        if settings('enableCoverArt') == "false":
            customquery += "&EnableImageEnhancers=false"

        allartworks = {

            'Primary': "",
            'Art': "",
            'Banner': "",
            'Logo': "",
            'Thumb': "",
            'Disc': "",
            'Backdrop': []
        }

        # Process backdrops
        for index, tag in enumerate(backdrops):
            artwork = (
                "%s/emby/Items/%s/Images/Backdrop/%s?"
                "MaxWidth=%s&MaxHeight=%s&Format=original&Tag=%s%s"
                % (self.server, itemid, index, maxWidth, maxHeight, tag, customquery))
            allartworks['Backdrop'].append(artwork)

        # Process the rest of the artwork
        for art in artworks:
            # Filter backcover
            if art != "BoxRear":
                tag = artworks[art]
                artwork = (
                    "%s/emby/Items/%s/Images/%s/0?"
                    "MaxWidth=%s&MaxHeight=%s&Format=original&Tag=%s%s"
                    % (self.server, itemid, art, maxWidth, maxHeight, tag, customquery))
                allartworks[art] = artwork

        # Process parent items if the main item is missing artwork
        if parentInfo:

            # Process parent backdrops
            if not allartworks['Backdrop']:

                parentId = item.get('ParentBackdropItemId')
                if parentId:
                    # If there is a parentId, go through the parent backdrop list
                    parentbackdrops = item['ParentBackdropImageTags']

                    for index, tag in enumerate(parentbackdrops):
                        artwork = (
                            "%s/emby/Items/%s/Images/Backdrop/%s?"
                            "MaxWidth=%s&MaxHeight=%s&Format=original&Tag=%s%s"
                            % (self.server, parentId, index, maxWidth, maxHeight, tag, customquery))
                        allartworks['Backdrop'].append(artwork)

            # Process the rest of the artwork
            parentartwork = ['Logo', 'Art', 'Thumb']
            for parentart in parentartwork:

                if not allartworks[parentart]:

                    parentId = item.get('Parent%sItemId' % parentart)
                    if parentId:

                        parentTag = item['Parent%sImageTag' % parentart]
                        artwork = (
                            "%s/emby/Items/%s/Images/%s/0?"
                            "MaxWidth=%s&MaxHeight=%s&Format=original&Tag=%s%s"
                            % (self.server, parentId, parentart,
                                maxWidth, maxHeight, parentTag, customquery))
                        allartworks[parentart] = artwork

            # Parent album works a bit differently
            if not allartworks['Primary']:

                parentId = item.get('AlbumId')
                if parentId and item.get('AlbumPrimaryImageTag'):

                    parentTag = item['AlbumPrimaryImageTag']
                    artwork = (
                        "%s/emby/Items/%s/Images/Primary/0?"
                        "MaxWidth=%s&MaxHeight=%s&Format=original&Tag=%s%s"
                        % (self.server, parentId, maxWidth, maxHeight, parentTag, customquery))
                    allartworks['Primary'] = artwork

        return allartworks