PlexKodiConnect/service.py

368 lines
15 KiB
Python
Raw Normal View History

# -*- coding: utf-8 -*-
2016-03-04 01:28:44 +11:00
###############################################################################
from logging import getLogger
2017-01-25 04:48:13 +11:00
from os import path as os_path
2017-02-06 02:26:53 +11:00
from sys import path as sys_path, argv
from xbmc import translatePath, Monitor
2017-01-25 04:48:13 +11:00
from xbmcaddon import Addon
2015-03-14 08:24:59 +11:00
2016-03-04 01:28:44 +11:00
###############################################################################
2017-01-25 04:48:13 +11:00
_addon = Addon(id='plugin.video.plexkodiconnect')
try:
2016-08-30 03:27:05 +10:00
_addon_path = _addon.getAddonInfo('path').decode('utf-8')
except TypeError:
2016-08-30 03:27:05 +10:00
_addon_path = _addon.getAddonInfo('path').decode()
try:
2017-01-25 04:48:13 +11:00
_base_resource = translatePath(os_path.join(
2016-08-30 03:27:05 +10:00
_addon_path,
'resources',
'lib')).decode('utf-8')
except TypeError:
2017-01-25 04:48:13 +11:00
_base_resource = translatePath(os_path.join(
2016-08-30 03:27:05 +10:00
_addon_path,
'resources',
'lib')).decode()
2017-01-25 04:48:13 +11:00
sys_path.append(_base_resource)
2015-03-14 08:24:59 +11:00
2016-03-04 01:28:44 +11:00
###############################################################################
from utils import settings, window, language as lang, dialog, tryDecode, \
set_replace_paths
2016-12-28 03:33:52 +11:00
from userclient import UserClient
import initialsetup
2018-01-22 21:20:37 +11:00
from kodimonitor import KodiMonitor, SpecialMonitor
2016-12-28 03:33:52 +11:00
from librarysync import LibrarySync
import videonodes
2017-03-06 01:48:08 +11:00
from websocket_client import PMS_Websocket, Alexa_Websocket
2016-03-23 20:05:29 +11:00
import downloadutils
2017-12-10 02:18:46 +11:00
import clientinfo
2015-04-07 03:17:32 +10:00
2015-12-28 02:27:49 +11:00
import PlexAPI
2016-12-28 03:33:52 +11:00
from PlexCompanion import PlexCompanion
from command_pipeline import Monitor_Window
2017-01-03 00:07:24 +11:00
from playback_starter import Playback_Starter
from playqueue import PlayqueueMonitor
from artwork import Image_Cache_Thread
from json_rpc import get_setting, set_setting
2017-01-25 02:53:50 +11:00
import variables as v
import state
2015-12-28 02:27:49 +11:00
2016-03-04 01:28:44 +11:00
###############################################################################
2016-08-30 03:27:05 +10:00
import loghandler
loghandler.config()
2017-12-10 02:18:46 +11:00
LOG = getLogger("PLEX.service")
2016-08-30 03:27:05 +10:00
###############################################################################
def set_webserver():
"""
Set the Kodi webserver details - used to set the texture cache
"""
if get_setting('services.webserver') in (None, False):
# Enable the webserver, it is disabled
set_setting('services.webserver', True)
# Set standard port and username
2017-12-10 02:01:03 +11:00
# set_setting('services.webserverport', 8080)
# set_setting('services.webserverusername', 'kodi')
# Webserver already enabled
state.WEBSERVER_PORT = get_setting('services.webserverport')
state.WEBSERVER_USERNAME = get_setting('services.webserverusername')
state.WEBSERVER_PASSWORD = get_setting('services.webserverpassword')
class Service():
2015-05-03 15:27:43 +10:00
server_online = True
warn_auth = True
2016-12-28 03:33:52 +11:00
user = None
ws = None
library = None
plexCompanion = None
user_running = False
ws_running = False
2017-03-06 01:48:08 +11:00
alexa_running = False
library_running = False
plexCompanion_running = False
2016-12-28 03:33:52 +11:00
kodimonitor_running = False
2017-01-03 00:07:24 +11:00
playback_starter_running = False
image_cache_thread_running = False
def __init__(self):
# Initial logging
2017-12-10 02:18:46 +11:00
LOG.info("======== START %s ========", v.ADDON_NAME)
LOG.info("Platform: %s", v.PLATFORM)
LOG.info("KODI Version: %s", v.KODILONGVERSION)
LOG.info("%s Version: %s", v.ADDON_NAME, v.ADDON_VERSION)
LOG.info("Using plugin paths: %s",
settings('useDirectPaths') != "true")
LOG.info("Number of sync threads: %s", settings('syncThreadNumber'))
LOG.info("Full sys.argv received: %s", argv)
# Reset window props for profile switch
properties = [
2016-05-31 16:06:42 +10:00
"plex_online", "plex_serverStatus", "plex_onWake",
2017-08-22 03:42:41 +10:00
"plex_kodiScan",
2017-05-17 23:57:30 +10:00
"plex_shouldStop", "plex_dbScan",
2018-01-06 22:55:24 +11:00
"plex_initialScan", "plex_customplayqueue", "plex_playbackProps",
2017-08-22 02:53:38 +10:00
"pms_token", "plex_token",
"pms_server", "plex_machineIdentifier", "plex_servername",
2016-04-15 19:57:49 +10:00
"plex_authenticated", "PlexUserImage", "useDirectPaths",
"countError", "countUnauthorized",
2017-01-03 00:07:24 +11:00
"plex_restricteduser", "plex_allows_mediaDeletion",
"plex_command", "plex_result", "plex_force_transcode_pix"
]
for prop in properties:
2016-02-03 10:49:22 +11:00
window(prop, clear=True)
# Clear video nodes properties
videonodes.VideoNodes().clearProperties()
2016-07-21 02:36:31 +10:00
2017-12-10 02:18:46 +11:00
# Init some stuff
2018-01-28 23:23:47 +11:00
state.VERIFY_SSL_CERT = settings('sslverify') == 'true'
state.SSL_CERT_PATH = settings('sslcert') \
if settings('sslcert') != 'None' else None
state.FULL_SYNC_INTERVALL = int(settings('fullSyncInterval')) * 60
state.SYNC_THREAD_NUMBER = int(settings('syncThreadNumber'))
state.SYNC_DIALOG = settings('dbSyncIndicator') == 'true'
state.ENABLE_MUSIC = settings('enableMusic') == 'true'
state.BACKGROUND_SYNC = settings(
'enableBackgroundSync') == 'true'
state.BACKGROUNDSYNC_SAFTYMARGIN = int(
settings('backgroundsync_saftyMargin'))
state.REPLACE_SMB_PATH = settings('replaceSMB') == 'true'
state.REMAP_PATH = settings('remapSMB') == 'true'
set_replace_paths()
2018-01-28 23:23:47 +11:00
state.KODI_PLEX_TIME_OFFSET = float(settings('kodiplextimeoffset'))
2018-02-06 07:13:53 +11:00
window('plex_minDBVersion', value="2.0.0")
2017-12-10 02:18:46 +11:00
set_webserver()
self.monitor = Monitor()
window('plex_kodiProfile',
value=tryDecode(translatePath("special://profile")))
window('fetch_pms_item_number',
value=settings('fetch_pms_item_number'))
clientinfo.getDeviceId()
2015-04-07 03:17:32 +10:00
def __stop_PKC(self):
"""
Kodi's abortRequested is really unreliable :-(
"""
return self.monitor.abortRequested() or state.STOP_PKC
2015-03-14 08:24:59 +11:00
def ServiceEntryPoint(self):
# Important: Threads depending on abortRequest will not trigger
# if profile switch happens more than once.
__stop_PKC = self.__stop_PKC
monitor = self.monitor
2017-01-25 04:48:13 +11:00
kodiProfile = v.KODI_PROFILE
# Server auto-detect
initialsetup.InitialSetup().setup()
# Detect playback start early on
self.command_pipeline = Monitor_Window()
self.command_pipeline.start()
2016-12-28 03:33:52 +11:00
# Initialize important threads, handing over self for callback purposes
self.user = UserClient()
self.ws = PMS_Websocket()
self.alexa = Alexa_Websocket()
self.library = LibrarySync()
self.plexCompanion = PlexCompanion()
2018-01-22 21:20:37 +11:00
self.specialMonitor = SpecialMonitor()
self.playback_starter = Playback_Starter()
self.playqueue = PlayqueueMonitor()
if settings('enableTextureCache') == "true":
self.image_cache_thread = Image_Cache_Thread()
2016-03-25 04:52:02 +11:00
plx = PlexAPI.PlexAPI()
2016-01-25 20:36:24 +11:00
2016-12-21 02:13:19 +11:00
welcome_msg = True
counter = 0
while not __stop_PKC():
2015-05-03 15:27:43 +10:00
if window('plex_kodiProfile') != kodiProfile:
# Profile change happened, terminate this thread and others
2017-12-10 02:18:46 +11:00
LOG.info("Kodi profile was: %s and changed to: %s. "
2016-08-30 03:27:05 +10:00
"Terminating old PlexKodiConnect thread."
2017-05-06 16:48:02 +10:00
% (kodiProfile,
window('plex_kodiProfile')))
break
2016-08-07 23:33:36 +10:00
# Before proceeding, need to make sure:
# 1. Server is online
# 2. User is set
# 3. User has access to the server
2016-05-31 16:06:42 +10:00
if window('plex_online') == "true":
# Plex server is online
# Verify if user is set and has access to the server
2016-12-28 03:33:52 +11:00
if (self.user.currUser is not None) and self.user.HasAccess:
2016-07-21 02:36:31 +10:00
if not self.kodimonitor_running:
# Start up events
self.warn_auth = True
2016-12-21 02:13:19 +11:00
if welcome_msg is True:
# Reset authentication warnings
2016-12-21 02:13:19 +11:00
welcome_msg = False
2017-01-25 06:04:53 +11:00
dialog('notification',
lang(29999),
"%s %s" % (lang(33000),
self.user.currUser),
2017-01-25 06:08:40 +11:00
icon='{plex}',
2017-01-25 06:04:53 +11:00
time=2000,
sound=False)
# Start monitoring kodi events
self.kodimonitor_running = KodiMonitor()
2018-01-22 21:20:37 +11:00
self.specialMonitor.start()
# Start the Websocket Client
2016-12-28 03:33:52 +11:00
if not self.ws_running:
self.ws_running = True
self.ws.start()
2017-03-06 01:48:08 +11:00
# Start the Alexa thread
2017-03-06 01:59:55 +11:00
if (not self.alexa_running and
settings('enable_alexa') == 'true'):
2017-03-06 01:48:08 +11:00
self.alexa_running = True
self.alexa.start()
# Start the syncing thread
if not self.library_running:
self.library_running = True
2016-12-28 03:33:52 +11:00
self.library.start()
# Start the Plex Companion thread
if not self.plexCompanion_running:
self.plexCompanion_running = True
2016-12-28 03:33:52 +11:00
self.plexCompanion.start()
2017-01-03 00:07:24 +11:00
if not self.playback_starter_running:
self.playback_starter_running = True
self.playback_starter.start()
self.playqueue.start()
if (not self.image_cache_thread_running and
settings('enableTextureCache') == "true"):
self.image_cache_thread_running = True
self.image_cache_thread.start()
else:
2016-12-28 03:33:52 +11:00
if (self.user.currUser is None) and self.warn_auth:
# Alert user is not authenticated and suppress future
# warning
self.warn_auth = False
2017-12-10 02:18:46 +11:00
LOG.warn("Not authenticated yet.")
# User access is restricted.
# Keep verifying until access is granted
# unless server goes offline or Kodi is shut down.
2016-12-28 03:33:52 +11:00
while self.user.HasAccess is False:
# Verify access with an API call
2016-12-28 03:33:52 +11:00
self.user.hasAccess()
2016-05-31 16:06:42 +10:00
if window('plex_online') != "true":
# Server went offline
break
if monitor.waitForAbort(3):
# Abort was requested while waiting. We should exit
break
else:
# Wait until Plex server is online
# or Kodi is shut down.
while not self.__stop_PKC():
2016-12-28 03:33:52 +11:00
server = self.user.getServer()
2016-03-04 23:34:30 +11:00
if server is False:
# No server info set in add-on settings
2015-05-03 15:27:43 +10:00
pass
elif plx.CheckConnection(server, verifySSL=True) is False:
2016-03-04 23:34:30 +11:00
# Server is offline or cannot be reached
# Alert the user and suppress future warning
2015-05-03 15:27:43 +10:00
if self.server_online:
2016-12-21 02:13:19 +11:00
self.server_online = False
2016-05-31 16:06:42 +10:00
window('plex_online', value="false")
# Suspend threads
state.SUSPEND_LIBRARY_THREAD = True
2017-12-10 02:18:46 +11:00
LOG.error("Plex Media Server went offline")
2016-12-21 02:13:19 +11:00
if settings('show_pms_offline') == 'true':
2017-01-25 04:48:13 +11:00
dialog('notification',
lang(33001),
"%s %s" % (lang(29999), lang(33002)),
icon='{plex}',
sound=False)
counter += 1
# Periodically check if the IP changed, e.g. per minute
2016-12-21 02:13:19 +11:00
if counter > 20:
counter = 0
setup = initialsetup.InitialSetup()
tmp = setup.PickPMS()
if tmp is not None:
setup.WritePMStoSettings(tmp)
2015-03-14 08:24:59 +11:00
else:
2015-05-03 15:27:43 +10:00
# Server is online
counter = 0
2015-05-03 15:27:43 +10:00
if not self.server_online:
# Server was offline when Kodi started.
2015-05-03 15:27:43 +10:00
# Wait for server to be fully established.
if monitor.waitForAbort(5):
2015-05-03 15:27:43 +10:00
# Abort was requested while waiting.
break
2016-12-21 02:13:19 +11:00
self.server_online = True
# Alert the user that server is online.
2016-12-21 02:13:19 +11:00
if (welcome_msg is False and
settings('show_pms_offline') == 'true'):
2017-01-25 04:48:13 +11:00
dialog('notification',
lang(29999),
lang(33003),
icon='{plex}',
time=5000,
sound=False)
2017-12-10 02:18:46 +11:00
LOG.info("Server %s is online and ready." % server)
2016-05-31 16:06:42 +10:00
window('plex_online', value="true")
if state.AUTHENTICATED:
# Server got offline when we were authenticated.
# Hence resume threads
state.SUSPEND_LIBRARY_THREAD = False
2016-03-10 01:37:27 +11:00
# Start the userclient thread
2016-12-28 03:33:52 +11:00
if not self.user_running:
self.user_running = True
self.user.start()
2015-05-03 15:27:43 +10:00
break
2016-12-21 02:13:19 +11:00
if monitor.waitForAbort(3):
2015-05-03 15:27:43 +10:00
# Abort was requested while waiting.
break
2016-07-21 02:36:31 +10:00
if monitor.waitForAbort(0.05):
# Abort was requested while waiting. We should exit
break
2016-03-23 20:05:29 +11:00
# Terminating PlexKodiConnect
2016-03-23 20:05:29 +11:00
# Tell all threads to terminate (e.g. several lib sync threads)
state.STOP_PKC = True
2016-03-25 04:52:02 +11:00
try:
downloadutils.DownloadUtils().stopSession()
except:
pass
2017-02-20 02:18:34 +11:00
window('plex_service_started', clear=True)
2017-12-10 02:18:46 +11:00
LOG.info("======== STOP %s ========" % v.ADDON_NAME)
2015-05-17 22:11:50 +10:00
2017-02-20 02:18:34 +11:00
# Safety net - Kody starts PKC twice upon first installation!
if window('plex_service_started') == 'true':
exit = True
else:
window('plex_service_started', value='true')
exit = False
# Delay option
2016-08-30 03:27:05 +10:00
delay = int(settings('startupDelay'))
2017-12-10 02:18:46 +11:00
LOG.info("Delaying Plex startup by: %s sec..." % delay)
2017-02-20 02:18:34 +11:00
if exit:
2017-12-10 02:18:46 +11:00
LOG.error('PKC service.py already started - exiting this instance')
2017-02-20 02:18:34 +11:00
elif delay and Monitor().waitForAbort(delay):
# Start the service
2017-12-10 02:18:46 +11:00
LOG.info("Abort requested while waiting. PKC not started.")
else:
2016-03-04 23:34:30 +11:00
Service().ServiceEntryPoint()