PlexKodiConnect/resources/lib/sync.py

290 lines
12 KiB
Python
Raw Normal View History

#!/usr/bin/env python
2015-12-25 07:07:00 +11:00
# -*- coding: utf-8 -*-
from __future__ import absolute_import, division, unicode_literals
2017-08-18 18:38:03 +10:00
from logging import getLogger
2015-12-25 07:07:00 +11:00
import xbmc
2018-10-24 16:08:32 +11:00
from .downloadutils import DownloadUtils as DU
2018-11-19 00:59:17 +11:00
from . import library_sync, timing
from . import backgroundthread, utils, artwork, variables as v, app
2018-12-22 02:48:57 +11:00
from . import kodi_db
2015-12-25 07:07:00 +11:00
2018-10-25 02:19:36 +11:00
LOG = getLogger('PLEX.sync')
2015-12-25 07:07:00 +11:00
2018-10-24 16:08:32 +11:00
def set_library_scan_toggle(boolean=True):
"""
Make sure to hit this function before starting large scans
"""
if not boolean:
# Deactivate
2018-11-19 00:59:17 +11:00
app.SYNC.db_scan = False
2018-10-24 16:08:32 +11:00
utils.window('plex_dbScan', clear=True)
else:
2018-11-19 00:59:17 +11:00
app.SYNC.db_scan = True
2018-10-24 16:08:32 +11:00
utils.window('plex_dbScan', value="true")
2016-09-02 03:07:28 +10:00
2018-10-25 02:19:36 +11:00
class Sync(backgroundthread.KillableThread):
2016-03-25 04:52:02 +11:00
"""
The one and only library sync thread. Spawn only 1!
2016-03-25 04:52:02 +11:00
"""
def __init__(self):
2018-10-24 16:08:32 +11:00
self.sync_successful = False
self.last_full_sync = 0
2018-11-03 20:36:37 +11:00
self.fanart = None
# Show sync dialog even if user deactivated?
2018-10-24 16:08:32 +11:00
self.force_dialog = False
2018-11-06 01:23:51 +11:00
self.image_cache_thread = None
2018-10-24 16:08:32 +11:00
# Lock used to wait on a full sync, e.g. on initial sync
# self.lock = backgroundthread.threading.Lock()
2018-10-25 02:19:36 +11:00
super(Sync, self).__init__()
2018-10-24 16:08:32 +11:00
def isSuspended(self):
return self._suspended or app.APP.suspend_threads
2015-12-25 07:07:00 +11:00
2017-08-22 02:53:38 +10:00
def triage_lib_scans(self):
"""
2018-11-19 00:59:17 +11:00
Decides what to do if app.SYNC.run_lib_scan has been set. E.g. manually
2017-08-22 03:38:41 +10:00
triggered full or repair syncs
2017-08-22 02:53:38 +10:00
"""
2018-11-19 00:59:17 +11:00
if app.SYNC.run_lib_scan in ("full", "repair"):
2018-10-24 16:08:32 +11:00
set_library_scan_toggle()
2018-04-16 02:33:20 +10:00
LOG.info('Full library scan requested, starting')
2018-10-24 16:08:32 +11:00
self.start_library_sync(show_dialog=True,
2018-11-19 00:59:17 +11:00
repair=app.SYNC.run_lib_scan == 'repair',
2018-10-24 16:08:32 +11:00
block=True)
if not self.sync_successful and not self.isSuspended() and not self.isCanceled():
# ERROR in library sync
LOG.warn('Triggered full/repair sync has not been successful')
2018-11-19 00:59:17 +11:00
elif app.SYNC.run_lib_scan == 'fanart':
2018-11-03 20:36:37 +11:00
# Only look for missing fanart (No) or refresh all fanart (Yes)
2018-09-19 00:26:40 +10:00
from .windows import optionsdialog
refresh = optionsdialog.show(utils.lang(29999),
utils.lang(39223),
utils.lang(39224), # refresh all
utils.lang(39225)) == 0
2018-11-03 20:36:37 +11:00
if not self.start_fanart_download(refresh=refresh):
2018-11-06 00:13:25 +11:00
# Fanart download already running
2018-11-03 20:36:37 +11:00
utils.dialog('notification',
heading='{plex}',
2018-11-06 00:13:25 +11:00
message=utils.lang(30015),
2018-11-03 20:36:37 +11:00
icon='{plex}',
sound=False)
2018-11-19 00:59:17 +11:00
elif app.SYNC.run_lib_scan == 'textures':
2018-11-06 04:00:01 +11:00
LOG.info("Caching of images requested")
if not utils.yesno_dialog("Image Texture Cache", utils.lang(39250)):
return
# ask to reset all existing or not
if utils.yesno_dialog('Image Texture Cache', utils.lang(39251)):
2018-11-09 07:22:16 +11:00
kodi_db.reset_cached_images()
2018-11-06 04:00:01 +11:00
self.start_image_cache_thread()
2018-10-24 16:08:32 +11:00
2018-11-03 20:36:37 +11:00
def on_library_scan_finished(self, successful):
2018-10-24 16:08:32 +11:00
"""
Hit this after the full sync has finished
"""
self.sync_successful = successful
2018-11-19 00:59:17 +11:00
self.last_full_sync = timing.unix_timestamp()
2018-10-24 16:08:32 +11:00
set_library_scan_toggle(boolean=False)
if not successful:
LOG.warn('Could not finish scheduled full sync')
# try:
# self.lock.release()
# except backgroundthread.threading.ThreadError:
# pass
2018-10-24 16:08:32 +11:00
def start_library_sync(self, show_dialog=None, repair=False, block=False):
2018-11-06 04:13:57 +11:00
set_library_scan_toggle(boolean=True)
2018-11-19 00:59:17 +11:00
show_dialog = show_dialog if show_dialog is not None else app.SYNC.sync_dialog
library_sync.start(show_dialog, repair, self.on_library_scan_finished)
# if block:
# self.lock.acquire()
# Will block until scan is finished
# self.lock.acquire()
# self.lock.release()
2018-11-03 20:36:37 +11:00
def start_fanart_download(self, refresh):
if not utils.settings('FanartTV') == 'true':
LOG.info('Additional fanart download is deactivated')
return False
2019-01-05 06:38:45 +11:00
if not app.SYNC.artwork:
LOG.info('Not synching Plex PMS artwork, not getting artwork')
return False
2018-11-03 20:36:37 +11:00
elif self.fanart is None or not self.fanart.is_alive():
LOG.info('Start downloading additional fanart with refresh %s',
refresh)
self.fanart = library_sync.FanartThread(self.on_fanart_download_finished, refresh)
self.fanart.start()
return True
else:
LOG.info('Still downloading fanart')
return False
def on_fanart_download_finished(self, successful):
2018-11-03 20:36:37 +11:00
# FanartTV lookup completed
if successful:
# Toggled to "Yes"
utils.settings('plex_status_fanarttv_lookup', value=utils.lang(107))
2017-08-22 02:53:38 +10:00
2018-11-06 01:23:51 +11:00
def start_image_cache_thread(self):
if not utils.settings('enableTextureCache') == "true":
2018-11-06 01:23:51 +11:00
LOG.info('Image caching has been deactivated')
2018-11-06 04:00:01 +11:00
return
2019-01-05 06:38:45 +11:00
if not app.SYNC.artwork:
LOG.info('Not synching Plex artwork - not caching')
return
2018-11-06 04:00:01 +11:00
if self.image_cache_thread and self.image_cache_thread.is_alive():
2019-02-02 21:30:03 +11:00
self.image_cache_thread.abort()
2018-11-06 04:00:01 +11:00
self.image_cache_thread.join()
self.image_cache_thread = artwork.ImageCachingThread()
self.image_cache_thread.start()
2018-11-06 01:23:51 +11:00
2016-08-07 23:33:36 +10:00
def run(self):
2015-12-25 07:07:00 +11:00
try:
self._run_internal()
2018-10-24 16:08:32 +11:00
except:
2018-11-19 00:59:17 +11:00
app.SYNC.db_scan = False
2018-06-22 03:24:37 +10:00
utils.window('plex_dbScan', clear=True)
2018-11-03 20:36:37 +11:00
utils.ERROR(txt='sync.py crashed', notify=True)
2015-12-25 07:07:00 +11:00
raise
def _run_internal(self):
2018-11-06 00:03:19 +11:00
LOG.info("---===### Starting Sync Thread ###===---")
2018-10-24 16:08:32 +11:00
install_sync_done = utils.settings('SyncInstallRunDone') == 'true'
playlist_monitor = None
initial_sync_done = False
2018-11-02 01:43:27 +11:00
last_websocket_processing = 0
2018-05-20 22:28:56 +10:00
last_time_sync = 0
2018-06-22 03:24:37 +10:00
one_day_in_seconds = 60 * 60 * 24
2016-12-28 03:33:52 +11:00
# Link to Websocket queue
2018-11-19 00:59:17 +11:00
queue = app.APP.websocket_queue
2016-03-25 04:52:02 +11:00
2018-10-25 21:46:57 +11:00
# Check whether we need to reset the Kodi DB
if install_sync_done:
current_version = utils.settings('dbCreatedWithVersion')
if not utils.compare_version(current_version,
v.MIN_DB_VERSION):
LOG.warn("Db version out of date: %s minimum version "
"required: %s", current_version, v.MIN_DB_VERSION)
# DB out of date. Proceed to recreate?
if not utils.yesno_dialog(utils.lang(29999),
utils.lang(39401)):
LOG.warn("Db version out of date! USER IGNORED!")
# PKC may not work correctly until reset
utils.messageDialog(utils.lang(29999),
'%s%s' % (utils.lang(29999),
utils.lang(39402)))
else:
utils.reset(ask_user=False)
return
utils.init_dbs()
2018-10-24 16:08:32 +11:00
while not self.isCanceled():
# In the event the server goes offline
2018-10-24 16:08:32 +11:00
while self.isSuspended():
if self.isCanceled():
2015-12-25 07:07:00 +11:00
# Abort was requested while waiting. We should exit
2018-11-06 00:03:19 +11:00
LOG.info("###===--- Sync Thread Stopped ---===###")
2016-01-28 06:41:28 +11:00
return
app.APP.monitor.waitForAbort(1)
2015-12-25 07:07:00 +11:00
2018-10-24 16:08:32 +11:00
if not install_sync_done:
# Very FIRST sync ever upon installation or reset of Kodi DB
set_library_scan_toggle()
2018-11-06 04:13:57 +11:00
self.force_dialog = True
2018-05-20 22:28:56 +10:00
# Initialize time offset Kodi - PMS
2018-10-24 16:08:32 +11:00
library_sync.sync_pms_time()
2018-11-19 00:59:17 +11:00
last_time_sync = timing.unix_timestamp()
LOG.info('Initial start-up full sync starting')
xbmc.executebuiltin('InhibitIdleShutdown(true)')
2018-10-24 16:08:32 +11:00
# This call will block until scan is completed
self.start_library_sync(show_dialog=True, block=True)
if self.sync_successful:
LOG.info('Initial start-up full sync successful')
2018-06-22 03:24:37 +10:00
utils.settings('SyncInstallRunDone', value='true')
2018-10-24 16:08:32 +11:00
install_sync_done = True
2018-10-25 21:46:57 +11:00
initial_sync_done = True
2018-06-22 03:24:37 +10:00
utils.settings('dbCreatedWithVersion', v.ADDON_VERSION)
2018-10-24 16:08:32 +11:00
if library_sync.PLAYLIST_SYNC_ENABLED:
from . import playlists
playlist_monitor = playlists.kodi_playlist_monitor()
2018-11-03 20:36:37 +11:00
self.start_fanart_download(refresh=False)
2018-11-06 01:23:51 +11:00
self.start_image_cache_thread()
else:
LOG.error('Initial start-up full sync unsuccessful')
app.APP.monitor.waitForAbort(1)
self.force_dialog = False
2018-10-25 21:46:57 +11:00
xbmc.executebuiltin('InhibitIdleShutdown(false)')
elif not initial_sync_done:
# First sync upon PKC restart. Skipped if very first sync upon
# PKC installation has been completed
LOG.info('Doing initial sync on Kodi startup')
2018-10-24 16:08:32 +11:00
self.start_library_sync(block=True)
if self.sync_successful:
initial_sync_done = True
LOG.info('Done initial sync on Kodi startup')
2018-10-24 16:08:32 +11:00
if library_sync.PLAYLIST_SYNC_ENABLED:
from . import playlists
playlist_monitor = playlists.kodi_playlist_monitor()
2018-11-03 20:36:37 +11:00
self.start_fanart_download(refresh=False)
2018-11-06 01:23:51 +11:00
self.start_image_cache_thread()
else:
LOG.info('Startup sync has not yet been successful')
app.APP.monitor.waitForAbort(1)
2016-01-28 06:41:28 +11:00
2018-10-24 16:08:32 +11:00
# Currently no db scan, so we could start a new scan
2018-11-19 00:59:17 +11:00
elif app.SYNC.db_scan is False:
# Full scan was requested from somewhere else
if app.SYNC.run_lib_scan is not None:
2017-08-22 02:53:38 +10:00
# Force-show dialogs since they are user-initiated
self.force_dialog = True
self.triage_lib_scans()
self.force_dialog = False
2018-10-24 16:08:32 +11:00
# Reset the flag
2018-11-19 00:59:17 +11:00
app.SYNC.run_lib_scan = None
2017-08-22 02:53:38 +10:00
continue
2018-10-24 16:08:32 +11:00
2017-08-22 02:53:38 +10:00
# Standard syncs - don't force-show dialogs
2018-11-19 00:59:17 +11:00
now = timing.unix_timestamp()
if (now - self.last_full_sync > app.SYNC.full_sync_intervall and
not app.SYNC.suspend_sync):
2018-04-16 02:33:20 +10:00
LOG.info('Doing scheduled full library scan')
2018-11-06 04:13:57 +11:00
self.start_library_sync()
elif now - last_time_sync > one_day_in_seconds:
2018-04-16 02:33:20 +10:00
LOG.info('Starting daily time sync')
2018-10-24 16:08:32 +11:00
library_sync.sync_pms_time()
last_time_sync = now
2018-11-19 00:59:17 +11:00
elif not app.SYNC.background_sync_disabled:
2018-11-02 01:43:27 +11:00
# Check back whether we should process something Only do
# this once a while (otherwise, potentially many screen
# refreshes lead to flickering)
if (library_sync.WEBSOCKET_MESSAGES and
now - last_websocket_processing > 5):
last_websocket_processing = now
library_sync.process_websocket_messages()
2017-08-22 02:53:38 +10:00
# See if there is a PMS message we need to handle
try:
message = queue.get(block=False)
2018-10-24 16:08:32 +11:00
except backgroundthread.Queue.Empty:
pass
2017-08-22 02:53:38 +10:00
# Got a message from PMS; process it
else:
2018-11-02 01:43:27 +11:00
library_sync.store_websocket_message(message)
2017-08-22 02:53:38 +10:00
queue.task_done()
# Sleep just a bit
app.APP.monitor.waitForAbort(0.01)
2017-08-22 02:53:38 +10:00
continue
app.APP.monitor.waitForAbort(0.1)
2018-04-28 17:12:29 +10:00
# Shut down playlist monitoring
2018-05-01 22:48:49 +10:00
if playlist_monitor:
playlist_monitor.stop()
2016-04-10 00:57:45 +10:00
# doUtils could still have a session open due to interrupted sync
try:
DU().stopSession()
2018-10-24 16:08:32 +11:00
except AttributeError:
2016-04-10 00:57:45 +10:00
pass
2018-11-06 00:03:19 +11:00
LOG.info("###===--- Sync Thread Stopped ---===###")