xbmc.py

# SPDX-License-Identifier: GPL-3.0

import io
import json
import os
import signal
import time

from sakee import addoninfo
from sakee.colors import Colors
from sakee.internalplayer import KodiInteralPlayer
from sakee.stub import KodiStub
from xbmcgui import ListItem

DRIVE_NOT_READY = 1
ENGLISH_NAME = 2
ISO_639_1 = 0
ISO_639_2 = 1
LOGDEBUG = 0
LOGERROR = 4
LOGFATAL = 6
LOGINFO = 1
LOGNONE = 7
LOGNOTICE = 2
LOGSEVERE = 5
LOGWARNING = 3
PLAYLIST_MUSIC = 0
PLAYLIST_VIDEO = 1
SERVER_AIRPLAYSERVER = 2
SERVER_EVENTSERVER = 6
SERVER_JSONRPCSERVER = 3
SERVER_UPNPRENDERER = 4
SERVER_UPNPSERVER = 5
SERVER_WEBSERVER = 1
SERVER_ZEROCONF = 7
TRAY_CLOSED_MEDIA_PRESENT = 96
TRAY_CLOSED_NO_MEDIA = 64
TRAY_OPEN = 16


# noinspection PyPep8Naming
class Monitor(KodiStub):
    def __init__(self):
        """ Creates a Dummy Kodi Monitor class """

        super(Monitor, self).__init__()
        self.__abort = False

        # noinspection PyUnusedLocal
        def stop_requested(signum, frame):
            self.__abort = True

        # Requires PyCharm to set the option of "Emulate terminal in output window" to work
        signal.signal(signal.SIGINT, stop_requested)

    def abortRequested(self):  # NOSONAR
        """ Returns True if abort has been requested.

        :return: True if abort has been requested.
        :rtype: bool

        """

        return self.__abort

    def waitForAbort(self, seconds=0.0):  # NOSONAR
        """ Block until abort is requested, or until timeout occurs. If an abort requested
        have already been made, return immediately.

        :param float seconds:  timeout in seconds. Default: no timeout.

        :return: True when abort have been requested, False if a timeout is given and
        the operation times out.
        :rtype: bool

        """

        deadline = time.time() + seconds
        while time.time() < deadline:
            if self.__abort:
                return True
            time.sleep(0.1)  # Sleep 100ms

        return False


# noinspection PyPep8Naming
class Keyboard(KodiStub):
    def __init__(self, line="", heading="", hidden=False):
        """

        :param str line:        The default line to show?
        :param str heading:     The heading of the dialog
        :param bool hidden:     Hidden input?

        """

        super(Keyboard, self).__init__()

        self.log_method("xbmc.Keyboard", "__init__", line, heading, hidden)
        self.__confirmed = False
        self.__line = line
        self.__heading = heading
        self.__hidden = hidden
        self.__input = ""

    # noinspection PyUnusedLocal
    def doModal(self, autoclose=0):  # NOSONAR
        """ Show keyboard and wait for user action.

        :param int autoclose: milliseconds to autoclose dialog. (default=do not autoclose)

        """

        if not self.is_interactive:
            self.__confirmed = True
            keyboard = self.get_keyboard_stub()
            self.__input = keyboard.get_next_input()
            return

        KodiStub.print_heading(self.__heading)
        try:
            answer = self.read_input(
                "Please provide keyboard input [{}]?".format(self.__line), color=Colors.Yellow)
            if not answer:
                answer = self.__line
            self.__confirmed = True
        except EOFError:
            answer = ""
            self.__confirmed = False

        self.__input = answer

    def getText(self):  # NOSONAR
        """ Returns the user input as a string.

        :return: Returns the user input as a string.
        :rtype: str

        This will always return the text entry even if you cancel the keyboard. Use
        the isConfirmed() method to check if user cancelled the keyboard.

        """

        return self.__input

    def isConfirmed(self):  # NOSONAR
        """ Returns False if the user cancelled the input.

        :return: Returns False if the user cancelled the input.
        :rtype: bool

        """

        return self.__confirmed

    def setDefault(self, line):  # NOSONAR
        """ Set the default text entry.

        :param str line:   The default line to show?

        """

        self.__line = line

    def setHeading(self, heading):  # NOSONAR
        """ Set the keyboard heading.

        :param str heading: Keyboard heading

        """

        self.__heading = heading

    def setHiddenInput(self, hidden):  # NOSONAR
        """ Allows hidden text entry.

        :param bool hidden:     True for hidden text entry.

        """

        self.__hidden = hidden


# noinspection PyArgumentList,PyPep8Naming
class PlayList(KodiStub):
    def __init__(self, playList):  # NOSONAR
        """ Playlist object

        :param int playList:    The type of playlist

        PLAYLIST_MUSIC = 13
        PLAYLIST_VIDEO = 14

        """

        self.__play_list_type = playList
        self.__items = []

        super(PlayList, self).__init__()

    def getPlayListId(self):
        """ Returns the type of playlist

        :return: The type of playlist
        :rtype: int

        """
        return self.__play_list_type

    def clear(self):
        """ Clear all items in the playlist. """
        self.__items = []

    def getposition(self):
        """ Returns the position of the current song in this playlist.

        :return: Position of the current song
        :rtype: int
        """
        self.log_method("xbmc.PlayList", "getposition")
        return 0

    def add(self, url, listitem=None, index=None):
        """`Adds a new file to the playlist.

        :param str url:                 Filename or url to add.
        :param ListItem|None listitem:  Used with setInfo() to set different infolabels.
        :param int|None index:          Position to add playlist item. (default=end)
        """

        if index is not None:
            self.__items.insert(index, (url, listitem))
        else:
            self.__items.append((url, listitem))

    def __len__(self):
        return len(self.__items)

    def __getitem__(self, i):
        return self.__items[i]


# noinspection PyPep8Naming,PyArgumentList
class Player(KodiStub):
    def __init__(self):
        super(Player, self).__init__()

        # register this player with the main Kodi player
        KodiInteralPlayer.instance().register_player(self)

    def __del__(self):
        # unregister
        KodiInteralPlayer.instance().unregister_player(self)

    def getAvailableAudioStreams(self):  # NOSONAR
        """ Returns the available audio stream names.

        :return: The available audio streams.
        :rtype: List[str]

        """

        return []  # Not implemented

    def getAvailableSubtitleStreams(self):  # NOSONAR
        """ Returns the available subtitle stream names.

        :return: The available subtitle streams.
        :rtype: List[str]

        """

        return []  # Not implemented

    def getAvailableVideoStreams(self):  # NOSONAR
        """ Returns the available video stream names.

        :return: The available video streams.
        :rtype: List[str]

        """

        return []  # Not implemented

    def getMusicInfoTag(self):
        """ Return the music info tag.

        :return: Returns the MusicInfoTag of the current playing 'Song'.
        :rtype: MusicInfoTag|None

        """

        if KodiInteralPlayer.instance().status == KodiInteralPlayer.STATUS_STOPPED:
            raise Exception('Player is not playing a file.')

        return None  # Not implemented

    def getPlayingFile(self):  # NOSONAR
        """ Returns the current playing file as a string.

        :return: The filename of the playing item.
        :rtype: str

        """

        return KodiInteralPlayer.instance().file

    def getRadioRDSInfoTag(self):
        """ Return the Radio RDS info tag.

        :return: Returns the RadioRDSInfoTag of the current playing 'Radio Song if. present'.
        :rtype: RadioRDSInfoTag|None
        """

        if KodiInteralPlayer.instance().status == KodiInteralPlayer.STATUS_STOPPED:
            raise Exception('Player is not playing a file.')

        return None  # Not implemented

    def getSubtitles(self):
        """ Return the subtitle stream name.

        :return: Stream name
        :rtype: str

        """

        return ''  # Not implemented

    def getTime(self):
        """ Return the current playing time.

        :return: Returns the current time of the current playing media as fractional seconds.
        :rtype: int
        """

        return KodiInteralPlayer.instance().current_time

    def getTotalTime(self):
        """ Return the total playing time.

        :return: Returns the total time of the current playing media in seconds. This is only accurate to the full second.
        :rtype: int

        """

        if KodiInteralPlayer.instance().status == KodiInteralPlayer.STATUS_STOPPED:
            raise Exception('Player is not playing a file.')

        return KodiInteralPlayer.instance().total_time

    def getVideoInfoTag(self):
        """ Return the video info tag.

        :return: The VideoInfoTag of the current playing Movie.
        :rtype: VideoInfoTag|None

        """

        if KodiInteralPlayer.instance().status == KodiInteralPlayer.STATUS_STOPPED:
            raise Exception('Player is not playing a file.')

        return None  # Not implemented

    def isExternalPlayer(self):
        """ Check for external player.

        :return: True if kodi is playing using an external player.
        :rtype: bool

        """

        return False

    def isPlaying(self):  # NOSONAR
        """ Check Kodi is playing something.

        :return: True if Kodi is playing a file.
        :rtype: bool

        """

        return KodiInteralPlayer.instance().status == KodiInteralPlayer.STATUS_PLAYING

    def isPlayingAudio(self):  # NOSONAR
        """ Check for playing audio.

        :return: True if Kodi is playing an audio file.
        :rtype: bool

        """

        return KodiInteralPlayer.instance().status == KodiInteralPlayer.STATUS_PLAYING

    def isPlayingRDS(self):  # NOSONAR
        """ Check for playing radio data system (RDS).

        :return: True if kodi is playing a radio data system (RDS).
        :rtype: bool

        """

        return KodiInteralPlayer.instance().status == KodiInteralPlayer.STATUS_PLAYING

    def isPlayingVideo(self):  # NOSONAR
        """ Check for playing video.

        :return: True if Kodi is playing a video.
        :rtype: bool

        """

        return KodiInteralPlayer.instance().status == KodiInteralPlayer.STATUS_PLAYING

    def pause(self):  # NOSONAR
        """ Pause or resume playing if already paused. """

        if KodiInteralPlayer.instance().status == KodiInteralPlayer.STATUS_STOPPED:
            return

        if KodiInteralPlayer.instance().status == KodiInteralPlayer.STATUS_PLAYING:
            KodiInteralPlayer.instance().status = KodiInteralPlayer.STATUS_PAUSED
            self.onPlayBackPaused()
            return

        if KodiInteralPlayer.instance().status == KodiInteralPlayer.STATUS_PAUSED:
            KodiInteralPlayer.instance().status = KodiInteralPlayer.STATUS_PLAYING
            self.onPlayBackResumed()
            return

    # noinspection PyUnusedLocal
    def play(self, item=None, listitem=None, windowed=False, startpos=-1):
        """ Play an item.

        :param str|None item:            Filename, url or playlist
        :param ListItem|None listitem:   Used with setInfo() to set different infolabels.
        :param bool windowed:            True=play video windowed, False=play users preference.(default)
        :param int startpos:             Starting position when playing a playlist. Default = -1

        If item is not given then the Player will try to play the current item in the current playlist.

        You can use the above as keywords for arguments and skip certain optional arguments.
        Once you use a keyword, all following arguments require the keyword.

        """
        # Stop playing the current file (if any)
        self.stop()
        KodiInteralPlayer.instance().play(item)

    def playnext(self):  # NOSONAR
        """ Play next item in playlist."""

        pass  # Not implemented

    def playprevious(self):  # NOSONAR
        """ Play previous item in playlist."""

        pass  # Not implemented

    def playselected(self, selected):  # NOSONAR
        """ Set Audio Stream.

        :param int selected:            Item to select

        """

        pass  # Not implemented

    def seekTime(self, seekTime):  # NOSONAR
        """ Seek time.

        Seeks the specified amount of time as fractional seconds.
        The time specified is relative to the beginning of the currently. playing media file.

        :param int seekTime:            Time to seek as fractional seconds

        """

        if KodiInteralPlayer.instance().status == KodiInteralPlayer.STATUS_STOPPED:
            raise Exception('Player is not playing a file.')

        KodiInteralPlayer.instance().current_time = seekTime
        self.onPlayBackSeek(seekTime, 0)

    def setAudioStream(self, stream):  # NOSONAR
        """ Set Audio Stream.

        :param int stream:              Audio stream to select for play

        """

        pass  # Not implemented

    def setSubtitles(self, subtitleFile):  # NOSONAR
        """ Set subtitle file and enable subtitles.

        :param str subtitleFile:        File to use as source of subtitles

        """

        pass  # Not implemented

    def setSubtitleStream(self, stream):  # NOSONAR
        """ Set Subtitle Stream.

        :param int stream:              Subtitle stream to select for play

        """

        pass  # Not implemented

    def setVideoStream(self, stream):  # NOSONAR
        """ Set Video Stream.

        :param int stream:              Video stream to select for play

        """

        pass  # Not implemented

    def showSubtitles(self, visible):  # NOSONAR
        """ Enable / disable subtitles.

        :param bool visible:            True for visible subtitles.

        """

        pass  # Not implemented

    def stop(self):  # NOSONAR
        """ Stop playing."""

        KodiInteralPlayer.instance().status = KodiInteralPlayer.STATUS_STOPPED
        KodiInteralPlayer.instance().current_time = 0
        KodiInteralPlayer.instance().total_time = 0
        KodiInteralPlayer.instance().file = None
        KodiInteralPlayer.instance().stop_playback()

    # noinspection PyUnusedLocal
    def updateInfoTag(self, item):  # NOSONAR
        """ Update info labels for currently playing item.

        :param ListItem item:           ListItem with new info

        """

        if KodiInteralPlayer.instance().status == KodiInteralPlayer.STATUS_STOPPED:
            raise Exception('Player is not playing a file.')

        # Not implemented

    def onAVChange(self):  # NOSONAR
        """ onAVChange method.
        Will be called when Kodi has a video, audio or subtitle stream. Also happens when the stream changes.

        """

        self.print_line('Invoked onAVChange()', verbose=True)

    def onAVStarted(self):  # NOSONAR
        """ onAVStarted method.

        Will be called when Kodi has a video or audiostream.

        """

        self.print_line('Invoked onAVStarted()', verbose=True)

    def onPlaybackEnded(self):  # NOSONAR
        """ onPlaybackEnded method.

        Will be called when Kodi stops playing a file.

        """
        self.print_line('Invoked onPlaybackEnded()', verbose=True)

    def onPlayBackError(self):  # NOSONAR
        """ onPlayBackError method.

        Will be called when playback stops due to an error.

        """

        self.print_line('Invoked onPlayBackError()', verbose=True)

    def onPlayBackPaused(self):  # NOSONAR
        """ onPlayBackPaused method.

        Will be called when user pauses a playing file.

        """

        self.print_line('Invoked onPlayBackPaused()', verbose=True)

    def onPlayBackResumed(self):  # NOSONAR
        """ onPlayBackResumed method.

        Will be called when user resumes a paused file.

        """

        self.print_line('Invoked onPlayBackResumed()', verbose=True)

    def onPlayBackSeek(self, time, seekOffset):  # NOSONAR
        """ onPlayBackSeek method.
        Will be called when user seeks to a time.

        :param int time:            Time to seek to
        :param int seekOffset:      ?

        """
        self.print_line('Invoked onPlayBackSeek(%d, %d)' % (time, seekOffset), verbose=True)

    def onPlayBackSeekChapter(self, chapter):  # NOSONAR
        """ onPlayBackSeekChapter method.

        Will be called when user performs a chapter seek.

        :param int chapter:         Chapter to seek to

        """

        self.print_line('Invoked onPlayBackSeekChapter(%d)' % chapter, verbose=True)

    def onPlayBackSpeedChanged(self, speed):  # NOSONAR
        """ onPlayBackSpeedChanged method.

        Will be called when players speed changes (eg. user FF/RW).

        Negative speed means player is rewinding, 1 is normal playback speed.

        :param int speed:           Current speed of player

        """

        self.print_line('Invoked onPlayBackSpeedChanged(%d)' % speed, verbose=True)

    def onPlayBackStarted(self):  # NOSONAR
        """ onPlayBackStarted method.

        Will be called when Kodi player starts. Video or audio might not be available at this point.

        Use onAVStarted() instead if you need to detect if Kodi is actually playing a media file
        (i.e, if a stream is available).

        """

        self.print_line('Invoked onPlayBackStarted()', verbose=True)

    def onPlayBackStopped(self):  # NOSONAR
        """ onPlayBackStopped method.

        Will be called when user stops Kodi playing a file.

        """

        self.print_line('Invoked onPlayBackStopped()', verbose=True)

    def onQueueNextItem(self):  # NOSONAR
        """ onQueueNextItem method.

        Will be called when user queues the next item.

        """

        self.print_line('Invoked onQueueNextItem()', verbose=True)


# noinspection PyPep8Naming
def executeJSONRPC(jsonrpccommand):  # NOSONAR
    """ Execute an JSONRPC command.

    :param str jsonrpccommand:   jsonrpc command to execute.

    :return: jsonrpc return string
    :rtype: str

    See https://codedocs.xyz/xbmc/xbmc/namespace_j_s_o_n_r_p_c.html
    """
    from sakee.sakejsonrpc import JsonRpcApi

    json_data = json.loads(jsonrpccommand)
    try:
        # Implement some methods for real
        return json.dumps(JsonRpcApi().handle(json_data))

    except NotImplementedError:
        # Fallback to stubs
        pass

    json_responses = os.environ.get("KODI_STUB_RPC_RESPONSES")
    if json_responses:
        path = "{}.json".format(os.path.join(json_responses, json_data["method"].lower()))
        if os.path.isfile(path):
            with io.open(path, mode='r', encoding='utf-8') as fd:
                stub_content = json.loads(fd.read())
                if isinstance(stub_content, dict):
                    return json.dumps(stub_content)
                try:
                    return json.dumps(next(stub.get('response')
                                           for stub in stub_content
                                           if json_data.get('params')
                                           and stub.get('request', {}).get('method') == json_data.get('method')
                                           and stub.get('request', {}).get('params') == json_data.get('params')))
                except StopIteration:
                    pass
    else:
        KodiStub.print_line("Warning: Could not find JSON Response folder. Use the environment variable KODI_STUB_RPC_RESPONSES to set one.", color=Colors.Red)

    return json.dumps(dict(id=1, jsonrpc="2.0", result="OK"))


# noinspection PyPep8Naming
def translatePath(path):  # NOSONAR
    """ Returns the translated path.

    :param str path:    Path to format

    :return: Translated path
    :rtype: str

    See http://kodi.wiki/view/Special_protocol

    E.g:
        special://home/ is mapped to: kodi/
        special://profile/ is mapped to: kodi/userdata

    Or in portable:
        special://home/ is mapped to: kodi/portable_data/
        special://profile/ is mapped to: kodi/portable_data/userdata

    """

    KodiStub.print_line("Warning: 'xbmc.translatePath' was moved to xbmcvfs in Kodi Matrix (API version 19.0)", color=Colors.Red)
    import xbmcvfs
    return xbmcvfs.translatePath(path)


def executebuiltin(function):
    """ Execute a built in Kodi function.

    :param str function:    builtin function to execute.

    See: http://kodi.wiki/view/List_of_Built_In_Functions

    """
    from sakee.sakebuiltin import BuiltinApi

    try:
        # Implement some methods for real
        BuiltinApi().handle(function)

    except NotImplementedError:
        # Fallback to stubs
        KodiStub.print_line("Executebuiltin: {0} is not implemented".format(function), color=Colors.Red)


# noinspection PyPep8Naming
def getCondVisibility(condition):  # NOSONAR
    """ Get visibility conditions

    :param str condition:   condition to check

    :return: True (1) or False (0) as a bool
    :rtype: int

    List of Conditions - http://kodi.wiki/view/List_of_Boolean_Conditions

    """

    if "+" in condition:
        final_result = 1
        conditions = condition.split("+", 1)
        for c in conditions:
            sub_result = __get_cond_visibility(c)
            final_result = final_result and sub_result

    elif "|" in condition:
        final_result = 0
        conditions = condition.split("|", 1)
        for c in conditions:
            sub_result = __get_cond_visibility(c)
            final_result = final_result or sub_result
    else:
        final_result = __get_cond_visibility(condition)

    return final_result


def __get_cond_visibility(condition):
    result = False
    condition = condition.strip()
    if condition.startswith('System.HasAddon('):
        add_on_id = condition.replace('System.HasAddon(', '').replace(')', '').strip('"')
        add_ons = os.listdir(os.path.join(__add_on_info.kodi_home_path, "addons"))

        parent_path = os.path.join(__add_on_info.kodi_home_path, "..", "addons")
        if os.path.isdir(parent_path):
            add_ons += os.listdir(parent_path)

        result = add_on_id in add_ons

    elif condition.startswith('System.AddonIsEnabled('):
        result = True

    elif condition == 'system.platform.windows':
        result = os.name == "nt"

    elif condition == 'system.platform.linux':
        result = os.name == "posix"

    elif condition == 'system.platform.xbox' or condition == 'system.platform.uwp':
        result = False

    else:
        KodiStub.print_line("Missing condition: {}".format(condition), color=Colors.Yellow)

    KodiStub.print_line("Condition: {0}={1}".format(condition, result), color=Colors.Blue, verbose=True)
    return 1 if result else 0


# noinspection PyPep8Naming
def getInfoLabel(infoTag):  # NOSONAR
    """ Get a info label

    :param str infoTag:  infoTag for value you want returned.

    :return: InfoLabel as a string
    :rtype: str

    List of InfoTags - http://kodi.wiki/view/InfoLabels
    """

    if infoTag.lower() == "system.buildversion":
        return "21.0 Git:20240406-xxxxxxxxxx"

    if infoTag.lower() == "network.ipaddress":
        import socket
        ## getting the hostname by socket.gethostname() method
        hostname = socket.gethostname()
        ## getting the IP address using socket.gethostbyname() method
        ip_address = socket.gethostbyname(hostname)
        return ip_address

    return "InfoLabel:{}".format(infoTag)


# noinspection PyPep8Naming,PyShadowingBuiltins,PyUnusedLocal
def getLanguage(format=ENGLISH_NAME, region=False):  # NOSONAR
    """ Get the active language.

    :param int format:          Format of the returned language string (see table)
    :param bool region:         append the region delimited by "-" of the language
                                (setting) to the returned language string

    :return: The active language as a string
    :rtype: str|unicode

    ==================  ========================================================
    Value               Description
    ==================  ========================================================
    xbmc.ISO_639_1      Two letter code as defined in ISO 639-1
    xbmc.ISO_639_2      Three letter code as defined in ISO 639-2/T
                        or ISO 639-2/B
    xbmc.ENGLISH_NAME   Full language name in English (default)
    ==================  ========================================================

    """

    if format == ISO_639_1:
        return "en" if not region else "en-gb"
    if format == ISO_639_2:
        return "eng" if not region else "eng-gbr"

    return "English"


# noinspection PyShadowingBuiltins,PyPep8Naming
def getLocalizedString(id):  # NOSONAR
    """ Get a localized `unicode string`.

    :param int id:  id# for string you want to localize.

    :return: Localized `unicode string`
    :rtype: str

    """

    return "xbmc:po:{}".format(id)


def log(msg, level=0):
    """ Write a string to Kodi's log file and the debug window.

    :param str msg:      Text to output.
    :param int level:    Log level to output at. (default=LOGDEBUG)

    ==================  ========================================================
    Value               Description
    ==================  ========================================================
    xbmc.LOGDEBUG       In depth information about the status of Kodi. This information can pretty much only be deciphered by a developer or long time Kodi power user.
    xbmc.LOGINFO        Something has happened. It's not a problem, we just thought you might want to know. Fairly excessive output that most people won't care about.
    xbmc.LOGNOTICE      Similar to INFO but the average Joe might want to know about these events. This level and above are logged by default.
    xbmc.LOGWARNING     Something potentially bad has happened. If Kodi did something you didn't expect, this is probably why. Watch for errors to follow.
    xbmc.LOGERROR       This event is bad. Something has failed. You likely noticed problems with the application be it skin artifacts, failure of playback a crash, etc.
    xbmc.LOGFATAL       We're screwed. Kodi is about to crash.
    ==================  ========================================================

    Note: You can use the above as keywords for arguments and skip certain optional arguments.
    Once you use a keyword, all following arguments require the keyword.

    """

    if level == LOGERROR:
        print(Colors.Red + msg + Colors.EndColor)
    elif level == LOGWARNING:
        print(Colors.Yellow + msg + Colors.EndColor)
    else:
        print(msg)


__add_on_info = addoninfo.get_add_on_info_from_calling_script(print_info=True)