PlexKodiConnect/resources/lib/playlists/__init__.py

476 lines
16 KiB
Python
Raw Normal View History

2018-07-12 05:24:27 +10:00
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
2018-09-05 00:43:16 +10:00
:module: plexkodiconnect.playlists
:synopsis: This module syncs Plex playlists to Kodi playlists and vice-versa
:author: Croneter
2018-07-12 05:24:27 +10:00
2018-09-05 00:43:16 +10:00
.. autoclass:: kodi_playlist_monitor
2018-07-12 05:24:27 +10:00
2018-09-05 00:43:16 +10:00
.. autoclass:: full_sync
2018-07-12 05:24:27 +10:00
2018-09-05 00:43:16 +10:00
.. autoclass:: websocket
2018-07-12 05:24:27 +10:00
"""
from __future__ import absolute_import, division, unicode_literals
2018-07-12 05:24:27 +10:00
from logging import getLogger
from sqlite3 import OperationalError
2018-07-12 05:24:27 +10:00
from .common import Playlist, PlaylistError, PlaylistObserver, \
kodi_playlist_hash
2018-07-12 05:24:27 +10:00
from . import pms, db, kodi_pl, plex_pl
from ..watchdog import events
from ..plex_api import API
2018-11-19 00:59:17 +11:00
from .. import utils, path_ops, variables as v, app
2018-07-12 05:24:27 +10:00
###############################################################################
LOG = getLogger('PLEX.playlists')
# Safety margin for playlist filesystem operations
FILESYSTEM_TIMEOUT = 1
# Which playlist formates are supported by PKC?
SUPPORTED_FILETYPES = (
'm3u',
# 'm3u8'
# 'pls',
# 'cue',
)
###############################################################################
def should_cancel():
return app.APP.stop_pkc or app.SYNC.stop_sync
2018-07-12 05:24:27 +10:00
def kodi_playlist_monitor():
"""
2018-09-05 00:43:16 +10:00
Monitor for the Kodi playlist folder special://profile/playlist
Monitors for all file changes and will thus catch all changes on the Kodi
side of things (as soon as the user saves a new or modified playlist). This
is accomplished by starting a PlaylistObserver with the
PlaylistEventhandler
Returns
-------
PlaylistObserver
Returns an already started PlaylistObserver instance
2018-07-12 05:24:27 +10:00
2018-09-05 00:43:16 +10:00
Notes
-----
Be sure to stop the returned PlaylistObserver with observer.stop()
(and maybe observer.join()) to shut down properly
2018-07-12 05:24:27 +10:00
"""
event_handler = PlaylistEventhandler()
observer = PlaylistObserver(timeout=FILESYSTEM_TIMEOUT)
observer.schedule(event_handler, v.PLAYLIST_PATH, recursive=True)
observer.start()
return observer
def remove_synced_playlists():
"""
Deletes all synched playlists on the Kodi side, not on the Plex side
"""
LOG.info('Removing all playlists that we synced to Kodi')
with app.APP.lock_playlists:
try:
paths = db.get_all_kodi_playlist_paths()
except OperationalError:
LOG.info('Playlists table has not yet been set-up')
return
kodi_pl.delete_kodi_playlists(paths)
db.wipe_table()
LOG.info('Done removing all synced playlists')
2018-07-12 05:24:27 +10:00
def websocket(plex_id, status):
"""
2018-09-05 00:43:16 +10:00
Call this function to process websocket messages from the PMS
Will use the playlist lock to process one single websocket message from
the PMS, and e.g. create or delete the corresponding Kodi playlist (if
applicable settings are set)
Parameters
----------
plex_id : unicode
The unqiue Plex id 'ratingKey' as received from the PMS
status : int
'state' as communicated by the PMS in the websocket message. This
function will then take the correct actions to process the message
* 0: 'created'
* 2: 'matching'
* 3: 'downloading'
* 4: 'loading'
* 5: 'finished'
* 6: 'analyzing'
* 9: 'deleted'
2018-07-12 05:24:27 +10:00
"""
create = False
2018-12-23 23:01:50 +11:00
plex_id = int(plex_id)
2018-11-19 00:59:17 +11:00
with app.APP.lock_playlists:
2018-07-12 05:24:27 +10:00
playlist = db.get_playlist(plex_id=plex_id)
if plex_id in plex_pl.IGNORE_PLEX_PLAYLIST_CHANGE:
LOG.debug('Ignoring detected Plex playlist change for %s',
playlist)
plex_pl.IGNORE_PLEX_PLAYLIST_CHANGE.remove(plex_id)
return
2018-07-12 05:24:27 +10:00
if playlist and status == 9:
# Won't be able to download metadata of the deleted playlist
if sync_plex_playlist(playlist=playlist):
LOG.debug('Plex deletion of playlist detected: %s', playlist)
try:
kodi_pl.delete(playlist)
except PlaylistError:
pass
2018-07-12 05:24:27 +10:00
return
xml = pms.metadata(plex_id)
if xml is None:
LOG.debug('Could not download playlist %s, probably deleted',
plex_id)
return
if not sync_plex_playlist(xml=xml[0]):
return
api = API(xml[0])
try:
if playlist:
if api.updated_at() == playlist.plex_updatedat:
LOG.debug('Playlist with id %s already synced: %s',
plex_id, playlist)
else:
LOG.debug('Change of Plex playlist detected: %s',
playlist)
kodi_pl.delete(playlist)
create = True
elif not playlist and not status == 9:
LOG.debug('Creation of new Plex playlist detected: %s',
plex_id)
create = True
# To the actual work
if create:
kodi_pl.create(plex_id)
except PlaylistError:
pass
2018-07-12 05:24:27 +10:00
def full_sync():
"""
2018-09-05 00:43:16 +10:00
Full sync of playlists between Kodi and Plex
Call to trigger a full sync both ways, e.g. on Kodi start-up. If issues
with a single playlist are encountered on either the Plex or Kodi side,
this particular playlist is omitted. Will use the playlist lock.
Returns
-------
bool
True if successful, False otherwise (actually only if we failed to
fetch the PMS playlists)
2018-07-12 05:24:27 +10:00
"""
LOG.info('Starting playlist full sync')
2018-11-19 00:59:17 +11:00
with app.APP.lock_playlists:
2018-09-05 00:43:16 +10:00
# Need to lock because we're messing with playlists
2018-07-12 05:24:27 +10:00
return _full_sync()
def _full_sync():
# Get all Plex playlists
xml = pms.all_playlists()
if xml is None:
return False
# For each playlist, check Plex database to see whether we already synced
# before. If yes, make sure that hashes are identical. If not, sync it.
old_plex_ids = db.plex_playlist_ids()
for xml_playlist in xml:
if should_cancel():
return False
2018-07-12 05:24:27 +10:00
api = API(xml_playlist)
try:
2019-06-11 05:29:42 +10:00
old_plex_ids.remove(api.plex_id)
2018-07-12 05:24:27 +10:00
except ValueError:
pass
if not sync_plex_playlist(xml=xml_playlist):
continue
2019-06-11 05:29:42 +10:00
playlist = db.get_playlist(plex_id=api.plex_id)
if not playlist:
LOG.debug('New Plex playlist %s discovered: %s',
2019-06-11 05:29:42 +10:00
api.plex_id, api.title())
try:
2019-06-11 05:29:42 +10:00
kodi_pl.create(api.plex_id)
except PlaylistError:
2019-06-11 05:29:42 +10:00
LOG.info('Skipping creation of playlist %s', api.plex_id)
elif playlist.plex_updatedat != api.updated_at():
LOG.debug('Detected changed Plex playlist %s: %s',
2019-06-11 05:29:42 +10:00
api.plex_id, api.title())
# Since we are DELETING a playlist, we need to catch with path!
try:
2018-07-12 05:24:27 +10:00
kodi_pl.delete(playlist)
except PlaylistError:
2019-06-11 05:29:42 +10:00
LOG.info('Skipping recreation of playlist %s', api.plex_id)
else:
try:
2019-06-11 05:29:42 +10:00
kodi_pl.create(api.plex_id)
except PlaylistError:
2019-06-11 05:29:42 +10:00
LOG.info('Could not recreate playlist %s', api.plex_id)
2018-07-12 05:24:27 +10:00
# Get rid of old Plex playlists that were deleted on the Plex side
for plex_id in old_plex_ids:
if should_cancel():
return False
2018-07-12 05:24:27 +10:00
playlist = db.get_playlist(plex_id=plex_id)
LOG.debug('Removing outdated Plex playlist from Kodi: %s', playlist)
if playlist is None:
continue
2018-07-12 15:58:48 +10:00
try:
kodi_pl.delete(playlist)
except PlaylistError:
LOG.debug('Skipping deletion of playlist: %s', playlist)
2018-07-12 05:24:27 +10:00
# Look at all supported Kodi playlists. Check whether they are in the DB.
old_kodi_paths = db.kodi_playlist_paths()
for root, _, files in path_ops.walk(v.PLAYLIST_PATH):
for f in files:
if should_cancel():
return False
2018-07-12 05:24:27 +10:00
path = path_ops.path.join(root, f)
try:
old_kodi_paths.remove(path)
except ValueError:
pass
if not sync_kodi_playlist(path):
continue
kodi_hash = kodi_playlist_hash(path)
2018-07-12 05:24:27 +10:00
playlist = db.get_playlist(path=path)
if playlist and playlist.kodi_hash == kodi_hash:
continue
if not playlist:
LOG.debug('New Kodi playlist detected: %s', path)
playlist = Playlist()
playlist.kodi_path = path
playlist.kodi_hash = kodi_hash
try:
2018-07-12 05:24:27 +10:00
plex_pl.create(playlist)
except PlaylistError:
LOG.info('Skipping Kodi playlist %s', path)
else:
LOG.debug('Changed Kodi playlist detected: %s', path)
plex_pl.delete(playlist)
playlist.kodi_hash = kodi_hash
try:
2018-07-12 05:24:27 +10:00
plex_pl.create(playlist)
except PlaylistError:
LOG.info('Skipping Kodi playlist %s', path)
2018-07-12 05:24:27 +10:00
for kodi_path in old_kodi_paths:
if should_cancel():
return False
2018-07-12 15:49:48 +10:00
playlist = db.get_playlist(path=kodi_path)
if not playlist:
continue
2018-07-12 05:24:27 +10:00
try:
plex_pl.delete(playlist)
except PlaylistError:
LOG.debug('Skipping deletion of Plex playlist: %s', playlist)
2018-07-12 05:24:27 +10:00
LOG.info('Playlist full sync done')
return True
def sync_kodi_playlist(path):
"""
2018-09-05 00:43:16 +10:00
Checks whether we should sync a specific Kodi playlist to Plex
Will check the following conditions for one single Kodi playlist:
* Kodi mixed playlists return False
* Support of the file type of the playlist, e.g. m3u
* Whether filename matches user settings to sync, if enabled
Parameters
----------
path : unicode
Absolute file path to the Kodi playlist in question
Returns
-------
bool
True if we should sync this Kodi playlist to Plex, False otherwise
2018-07-12 05:24:27 +10:00
"""
if path.startswith(v.PLAYLIST_PATH_MIXED):
return False
try:
extension = path.rsplit('.', 1)[1].lower()
except IndexError:
return False
if extension not in SUPPORTED_FILETYPES:
return False
2018-11-19 00:59:17 +11:00
if not app.SYNC.sync_specific_kodi_playlists:
2018-07-12 05:24:27 +10:00
return True
playlist = Playlist()
playlist.kodi_path = path
prefix = utils.settings('syncSpecificKodiPlaylistsPrefix').lower()
if playlist.kodi_filename.lower().startswith(prefix):
return True
LOG.debug('User chose to not sync Kodi playlist %s', path)
return False
2018-09-05 00:43:16 +10:00
def sync_plex_playlist(playlist=None, xml=None, plex_id=None):
2018-07-12 05:24:27 +10:00
"""
2018-09-05 00:43:16 +10:00
Checks whether we should sync a specific Plex playlist to Kodi
Will check the following conditions for one single Plex playlist:
* Plex music playlists return False if PKC audio sync is disabled
* Whether filename matches user settings to sync, if enabled
* False is returned if we could not retrieve more information about the
playlist if only the plex_id was given
2018-07-12 05:24:27 +10:00
2018-09-05 00:43:16 +10:00
Parameters
----------
Pass in either playlist, xml or plex_id (preferably in this order)
plex_id : unicode
Absolute file path to the Kodi playlist in question
xml : etree xml
PMS metadata for the Plex element in question. API(xml) instead of
the usual API(xml[0]) will be used!
playlist: PlayList
A PlayList instance with Playlist.plex_name and PlayList.kodi_type set
Returns
-------
bool
True if we should sync this Plex playlist to Kodi, False otherwise
2018-07-12 05:24:27 +10:00
"""
if playlist:
# Mainly once we DELETED a Plex playlist that we're NOT supposed
# to sync
name = playlist.plex_name
typus = playlist.kodi_type
else:
if xml is None:
xml = pms.metadata(plex_id)
if xml is None:
LOG.info('Could not get Plex metadata for playlist %s',
plex_id)
return False
api = API(xml[0])
else:
api = API(xml)
if api.playlist_type() == v.PLEX_TYPE_PHOTO_PLAYLIST:
# Not supported by Kodi
return False
2018-07-12 05:24:27 +10:00
name = api.title()
typus = v.KODI_PLAYLIST_TYPE_FROM_PLEX[api.playlist_type()]
2018-11-19 00:59:17 +11:00
if (not app.SYNC.enable_music and typus == v.PLEX_PLAYLIST_TYPE_AUDIO):
2018-07-12 05:24:27 +10:00
LOG.debug('Not synching Plex audio playlist')
return False
2018-11-19 00:59:17 +11:00
if not app.SYNC.sync_specific_plex_playlists:
return True
2018-07-12 05:24:27 +10:00
prefix = utils.settings('syncSpecificPlexPlaylistsPrefix').lower()
if name and name.lower().startswith(prefix):
return True
2018-07-12 18:50:45 +10:00
LOG.debug('User chose to not sync Plex playlist %s', name)
2018-07-12 05:24:27 +10:00
return False
class PlaylistEventhandler(events.FileSystemEventHandler):
"""
PKC eventhandler to monitor Kodi playlists safed to disk
"""
def dispatch(self, event):
"""
Dispatches events to the appropriate methods.
2018-09-05 00:43:16 +10:00
Parameters
----------
2018-07-12 05:24:27 +10:00
:type event:
:class:`FileSystemEvent`
2018-09-05 00:43:16 +10:00
The event object representing the file system event.
2018-07-12 05:24:27 +10:00
"""
path = event.dest_path if event.event_type == events.EVENT_TYPE_MOVED \
else event.src_path
2018-11-19 00:59:17 +11:00
with app.APP.lock_playlists:
if not sync_kodi_playlist(path):
return
if path in kodi_pl.IGNORE_KODI_PLAYLIST_CHANGE:
LOG.debug('Ignoring event %s', event)
kodi_pl.IGNORE_KODI_PLAYLIST_CHANGE.remove(path)
return
_method_map = {
events.EVENT_TYPE_MODIFIED: self.on_modified,
events.EVENT_TYPE_MOVED: self.on_moved,
events.EVENT_TYPE_CREATED: self.on_created,
events.EVENT_TYPE_DELETED: self.on_deleted,
}
2018-07-12 05:24:27 +10:00
_method_map[event.event_type](event)
def on_created(self, event):
LOG.debug('on_created: %s', event.src_path)
old_playlist = db.get_playlist(path=event.src_path)
kodi_hash = kodi_playlist_hash(event.src_path)
2018-07-12 05:24:27 +10:00
if old_playlist and old_playlist.kodi_hash == kodi_hash:
LOG.debug('Playlist already in DB - skipping')
return
elif old_playlist:
LOG.debug('Playlist already in DB but it has been changed')
self.on_modified(event)
return
playlist = Playlist()
playlist.kodi_path = event.src_path
playlist.kodi_hash = kodi_hash
try:
plex_pl.create(playlist)
except PlaylistError:
pass
def on_modified(self, event):
LOG.debug('on_modified: %s', event.src_path)
old_playlist = db.get_playlist(path=event.src_path)
kodi_hash = kodi_playlist_hash(event.src_path)
2018-07-12 05:24:27 +10:00
if old_playlist and old_playlist.kodi_hash == kodi_hash:
LOG.debug('Nothing modified, playlist already in DB - skipping')
return
new_playlist = Playlist()
if old_playlist:
# Retain the name! Might've come from Plex
# (rename should fire on_moved)
new_playlist.plex_name = old_playlist.plex_name
plex_pl.delete(old_playlist)
new_playlist.kodi_path = event.src_path
new_playlist.kodi_hash = kodi_hash
try:
plex_pl.create(new_playlist)
except PlaylistError:
pass
def on_moved(self, event):
LOG.debug('on_moved: %s to %s', event.src_path, event.dest_path)
kodi_hash = kodi_playlist_hash(event.dest_path)
2018-07-12 05:24:27 +10:00
# First check whether we don't already have destination playlist in
# our DB. Just in case....
old_playlist = db.get_playlist(path=event.dest_path)
if old_playlist:
LOG.warning('Found target playlist already in our DB!')
new_event = events.FileModifiedEvent(event.dest_path)
self.on_modified(new_event)
return
# All good
old_playlist = db.get_playlist(path=event.src_path)
if not old_playlist:
LOG.debug('Did not have source path in the DB %s', event.src_path)
else:
plex_pl.delete(old_playlist)
new_playlist = Playlist()
new_playlist.kodi_path = event.dest_path
new_playlist.kodi_hash = kodi_hash
try:
plex_pl.create(new_playlist)
except PlaylistError:
pass
def on_deleted(self, event):
LOG.debug('on_deleted: %s', event.src_path)
playlist = db.get_playlist(path=event.src_path)
if not playlist:
LOG.debug('Playlist not found in DB for path %s', event.src_path)
else:
plex_pl.delete(playlist)