2018-10-20 23:49:04 +11:00
|
|
|
#!/usr/bin/env python
|
|
|
|
# -*- coding: utf-8 -*-
|
|
|
|
from logging import getLogger
|
|
|
|
import copy
|
|
|
|
|
2019-01-09 04:00:54 +11:00
|
|
|
from . import nodes
|
2018-10-25 02:17:02 +11:00
|
|
|
from ..plex_db import PlexDB
|
2019-01-09 04:00:54 +11:00
|
|
|
from ..plex_api import API
|
2018-11-09 07:22:16 +11:00
|
|
|
from .. import kodi_db
|
2019-01-09 04:00:54 +11:00
|
|
|
from .. import itemtypes, path_ops
|
2018-11-19 00:59:17 +11:00
|
|
|
from .. import plex_functions as PF, music, utils, variables as v, app
|
2019-01-09 04:00:54 +11:00
|
|
|
from ..utils import etree
|
2018-10-20 23:49:04 +11:00
|
|
|
|
2018-11-02 01:43:43 +11:00
|
|
|
LOG = getLogger('PLEX.sync.sections')
|
2018-10-20 23:49:04 +11:00
|
|
|
|
2019-02-05 23:21:08 +11:00
|
|
|
BATCH_SIZE = 500
|
2019-01-09 04:00:54 +11:00
|
|
|
# Need a way to interrupt our synching process
|
2019-11-29 03:49:48 +11:00
|
|
|
SHOULD_CANCEL = None
|
2018-10-20 23:49:04 +11:00
|
|
|
|
2019-01-09 04:00:54 +11:00
|
|
|
LIBRARY_PATH = path_ops.translate_path('special://profile/library/video/')
|
|
|
|
# The video library might not yet exist for this user - create it
|
|
|
|
if not path_ops.exists(LIBRARY_PATH):
|
2021-05-14 16:46:06 +10:00
|
|
|
path_ops.copytree(
|
2019-01-09 04:00:54 +11:00
|
|
|
src=path_ops.translate_path('special://xbmc/system/library/video'),
|
|
|
|
dst=LIBRARY_PATH,
|
2021-05-14 16:46:06 +10:00
|
|
|
copy_function=path_ops.shutil.copyfile)
|
2019-01-09 04:00:54 +11:00
|
|
|
PLAYLISTS_PATH = path_ops.translate_path("special://profile/playlists/video/")
|
|
|
|
if not path_ops.exists(PLAYLISTS_PATH):
|
|
|
|
path_ops.makedirs(PLAYLISTS_PATH)
|
|
|
|
|
|
|
|
# Windows variables we set for each node
|
|
|
|
WINDOW_ARGS = ('index', 'title', 'id', 'path', 'type', 'content', 'artwork')
|
|
|
|
|
|
|
|
|
|
|
|
class Section(object):
|
|
|
|
"""
|
|
|
|
Setting the attribute section_type will automatically set content and
|
|
|
|
sync_to_kodi
|
|
|
|
"""
|
|
|
|
def __init__(self, index=None, xml_element=None, section_db_element=None):
|
|
|
|
# Unique Plex id of this Plex library section
|
2019-05-29 02:42:04 +10:00
|
|
|
self._section_id = None # int
|
2019-01-09 04:00:54 +11:00
|
|
|
# Building block for window variable
|
|
|
|
self._node = None # unicode
|
2019-05-29 02:42:04 +10:00
|
|
|
# Index of this section (as section_id might not be subsequent)
|
2019-01-09 04:00:54 +11:00
|
|
|
# This follows 1:1 the sequence in with the PMS returns the sections
|
|
|
|
self._index = None # Codacy-bug
|
|
|
|
self.index = index # int
|
|
|
|
# This section's name for the user to display
|
|
|
|
self.name = None # unicode
|
|
|
|
# Library type section (NOT the same as the KODI_TYPE_...)
|
|
|
|
# E.g. 'movies', 'tvshows', 'episodes'
|
|
|
|
self.content = None # unicode
|
|
|
|
# Setting the section_type WILL re_set sync_to_kodi!
|
|
|
|
self._section_type = None # unicode
|
2019-11-24 19:33:16 +11:00
|
|
|
# E.g. "season" or "movie" (translated)
|
|
|
|
self.section_type_text = None
|
2019-01-09 04:00:54 +11:00
|
|
|
# Do we sync all items of this section to the Kodi DB?
|
|
|
|
# This will be set with section_type!!
|
|
|
|
self.sync_to_kodi = None # bool
|
2019-05-29 02:42:04 +10:00
|
|
|
# For sections to be synched, the section name will be recorded as a
|
|
|
|
# tag. This is the corresponding id for this tag
|
|
|
|
self.kodi_tagid = None # int
|
2019-01-09 04:00:54 +11:00
|
|
|
# When was this section last successfully/completely synched to the
|
|
|
|
# Kodi database?
|
|
|
|
self.last_sync = None # int
|
|
|
|
# Path to the Kodi userdata library FOLDER for this section
|
|
|
|
self._path = None # unicode
|
|
|
|
# Path to the smart playlist for this section
|
|
|
|
self._playlist_path = None
|
|
|
|
# "Poster" for this section
|
|
|
|
self.icon = None # unicode
|
|
|
|
# Background image for this section
|
|
|
|
self.artwork = None
|
|
|
|
# Thumbnail for this section, similar for each section type
|
|
|
|
self.thumb = None
|
|
|
|
# Order number in which xmls will be listed inside Kodei
|
|
|
|
self.order = None
|
|
|
|
# Original PMS xml for this section, including children
|
|
|
|
self.xml = None
|
|
|
|
# A section_type encompasses possible several plex_types! E.g. shows
|
|
|
|
# contain shows, seasons, episodes
|
2019-11-24 19:33:16 +11:00
|
|
|
self._plex_type = None
|
2019-01-09 04:00:54 +11:00
|
|
|
if xml_element is not None:
|
|
|
|
self.from_xml(xml_element)
|
|
|
|
elif section_db_element:
|
|
|
|
self.from_db_element(section_db_element)
|
|
|
|
|
2019-05-29 02:42:04 +10:00
|
|
|
def __repr__(self):
|
2019-01-09 04:00:54 +11:00
|
|
|
return ("{{"
|
|
|
|
"'index': {self.index}, "
|
|
|
|
"'name': '{self.name}', "
|
2019-05-29 02:42:04 +10:00
|
|
|
"'section_id': {self.section_id}, "
|
2019-01-09 04:00:54 +11:00
|
|
|
"'section_type': '{self.section_type}', "
|
|
|
|
"'sync_to_kodi': {self.sync_to_kodi}, "
|
2019-05-29 02:42:04 +10:00
|
|
|
"'last_sync': {self.last_sync}"
|
2020-12-19 05:59:33 +11:00
|
|
|
"}}").format(self=self)
|
2019-01-09 04:00:54 +11:00
|
|
|
|
2020-12-19 03:10:20 +11:00
|
|
|
def __bool__(self):
|
2020-12-28 03:31:08 +11:00
|
|
|
"""bool(Section) returns True if section_id, name and section_type are set."""
|
2019-05-29 02:42:04 +10:00
|
|
|
return (self.section_id is not None and
|
2019-01-09 04:00:54 +11:00
|
|
|
self.name is not None and
|
|
|
|
self.section_type is not None)
|
|
|
|
|
|
|
|
def __eq__(self, section):
|
2020-12-28 03:31:08 +11:00
|
|
|
"""Sections compare equal if their section_id, name and plex_type (first prio) OR section_type (if there is no plex_type is set) compare equal.
|
2019-11-24 19:33:16 +11:00
|
|
|
"""
|
2019-05-29 02:42:04 +10:00
|
|
|
return (self.section_id == section.section_id and
|
2019-01-09 04:00:54 +11:00
|
|
|
self.name == section.name and
|
2019-11-24 19:33:16 +11:00
|
|
|
(self.plex_type == section.plex_type if self.plex_type else
|
|
|
|
self.section_type == section.section_type))
|
2019-04-13 20:51:14 +10:00
|
|
|
|
|
|
|
def __ne__(self, section):
|
|
|
|
return not self == section
|
2019-01-09 04:00:54 +11:00
|
|
|
|
|
|
|
@property
|
2019-05-29 02:42:04 +10:00
|
|
|
def section_id(self):
|
|
|
|
return self._section_id
|
2019-01-09 04:00:54 +11:00
|
|
|
|
2019-05-29 02:42:04 +10:00
|
|
|
@section_id.setter
|
|
|
|
def section_id(self, value):
|
|
|
|
self._section_id = value
|
2019-01-09 04:00:54 +11:00
|
|
|
self._path = path_ops.path.join(LIBRARY_PATH, 'Plex-%s' % value, '')
|
|
|
|
self._playlist_path = path_ops.path.join(PLAYLISTS_PATH,
|
|
|
|
'Plex %s.xsp' % value)
|
|
|
|
|
|
|
|
@property
|
|
|
|
def section_type(self):
|
|
|
|
return self._section_type
|
|
|
|
|
|
|
|
@section_type.setter
|
|
|
|
def section_type(self, value):
|
|
|
|
self._section_type = value
|
2019-07-07 05:20:23 +10:00
|
|
|
self.content = v.CONTENT_FROM_PLEX_TYPE[value]
|
2019-01-09 04:00:54 +11:00
|
|
|
# Default values whether we sync or not based on the Plex type
|
|
|
|
if value == v.PLEX_TYPE_PHOTO:
|
|
|
|
self.sync_to_kodi = False
|
|
|
|
elif not app.SYNC.enable_music and value == v.PLEX_TYPE_ARTIST:
|
|
|
|
self.sync_to_kodi = False
|
|
|
|
else:
|
|
|
|
self.sync_to_kodi = True
|
|
|
|
|
2019-11-24 19:33:16 +11:00
|
|
|
@property
|
|
|
|
def plex_type(self):
|
|
|
|
return self._plex_type
|
|
|
|
|
|
|
|
@plex_type.setter
|
|
|
|
def plex_type(self, value):
|
|
|
|
self._plex_type = value
|
|
|
|
self.section_type_text = utils.lang(v.TRANSLATION_FROM_PLEXTYPE[value])
|
|
|
|
|
2019-01-09 04:00:54 +11:00
|
|
|
@property
|
|
|
|
def index(self):
|
|
|
|
return self._index
|
|
|
|
|
|
|
|
@index.setter
|
|
|
|
def index(self, value):
|
|
|
|
self._index = value
|
|
|
|
self._node = 'Plex.nodes.%s' % value
|
|
|
|
|
|
|
|
@property
|
|
|
|
def node(self):
|
|
|
|
return self._node
|
|
|
|
|
|
|
|
@property
|
|
|
|
def path(self):
|
|
|
|
return self._path
|
|
|
|
|
|
|
|
@property
|
|
|
|
def playlist_path(self):
|
|
|
|
return self._playlist_path
|
|
|
|
|
|
|
|
def from_db_element(self, section_db_element):
|
2019-05-29 02:42:04 +10:00
|
|
|
self.section_id = section_db_element['section_id']
|
2019-01-09 04:00:54 +11:00
|
|
|
self.name = section_db_element['section_name']
|
|
|
|
self.section_type = section_db_element['plex_type']
|
2019-05-29 02:42:04 +10:00
|
|
|
self.kodi_tagid = section_db_element['kodi_tagid']
|
2019-01-09 04:00:54 +11:00
|
|
|
self.sync_to_kodi = section_db_element['sync_to_kodi']
|
|
|
|
self.last_sync = section_db_element['last_sync']
|
|
|
|
|
|
|
|
def from_xml(self, xml_element):
|
|
|
|
"""
|
|
|
|
Reads section from a PMS xml (Plex id, name, Plex type)
|
|
|
|
"""
|
|
|
|
api = API(xml_element)
|
2019-05-29 02:42:04 +10:00
|
|
|
self.section_id = utils.cast(int, xml_element.get('key'))
|
2019-01-09 04:00:54 +11:00
|
|
|
self.name = api.title()
|
2019-06-11 05:29:42 +10:00
|
|
|
self.section_type = api.plex_type
|
2019-01-09 04:00:54 +11:00
|
|
|
self.icon = api.one_artwork('composite')
|
|
|
|
self.artwork = api.one_artwork('art')
|
|
|
|
self.thumb = api.one_artwork('thumb')
|
|
|
|
self.xml = xml_element
|
|
|
|
|
|
|
|
def from_plex_db(self, section_id, plexdb=None):
|
|
|
|
"""
|
|
|
|
Reads section with id section_id from the plex.db
|
|
|
|
"""
|
|
|
|
if plexdb:
|
|
|
|
section = plexdb.section(section_id)
|
|
|
|
else:
|
|
|
|
with PlexDB(lock=False) as plexdb:
|
|
|
|
section = plexdb.section(section_id)
|
|
|
|
if section:
|
|
|
|
self.from_db_element(section)
|
|
|
|
|
|
|
|
def to_plex_db(self, plexdb=None):
|
|
|
|
"""
|
|
|
|
Writes this Section to the plex.db, potentially overwriting
|
|
|
|
(INSERT OR REPLACE)
|
|
|
|
"""
|
|
|
|
if not self:
|
|
|
|
raise RuntimeError('Section not clearly defined: %s' % self)
|
|
|
|
if plexdb:
|
2019-05-29 02:42:04 +10:00
|
|
|
plexdb.add_section(self.section_id,
|
2019-01-09 04:00:54 +11:00
|
|
|
self.name,
|
|
|
|
self.section_type,
|
2019-05-29 02:42:04 +10:00
|
|
|
self.kodi_tagid,
|
2019-01-09 04:00:54 +11:00
|
|
|
self.sync_to_kodi,
|
|
|
|
self.last_sync)
|
|
|
|
else:
|
|
|
|
with PlexDB(lock=False) as plexdb:
|
2019-05-29 02:42:04 +10:00
|
|
|
plexdb.add_section(self.section_id,
|
2019-01-09 04:00:54 +11:00
|
|
|
self.name,
|
|
|
|
self.section_type,
|
2019-05-29 02:42:04 +10:00
|
|
|
self.kodi_tagid,
|
2019-01-09 04:00:54 +11:00
|
|
|
self.sync_to_kodi,
|
|
|
|
self.last_sync)
|
|
|
|
|
|
|
|
def addon_path(self, args):
|
|
|
|
"""
|
|
|
|
Returns the plugin path pointing back to PKC for key in order to browse
|
|
|
|
args is a dict. Its values may contain string info of the form
|
|
|
|
{key: '{self.<Section attribute>}'}
|
|
|
|
"""
|
|
|
|
args = copy.deepcopy(args)
|
2020-12-19 03:10:20 +11:00
|
|
|
for key, value in args.items():
|
2019-01-09 04:00:54 +11:00
|
|
|
args[key] = value.format(self=self)
|
2019-03-30 20:32:56 +11:00
|
|
|
return utils.extend_url('plugin://%s' % v.ADDON_ID, args)
|
2019-01-09 04:00:54 +11:00
|
|
|
|
|
|
|
def to_kodi(self):
|
|
|
|
"""
|
|
|
|
Writes this section's nodes to the library folder in the Kodi userdata
|
|
|
|
directory
|
|
|
|
Won't do anything if self.sync_to_kodi is not True
|
|
|
|
"""
|
|
|
|
if self.index is None:
|
|
|
|
raise RuntimeError('Index not initialized')
|
|
|
|
# Main list entry for this section - which will show the different
|
|
|
|
# nodes as "submenus" once the user navigates into this section
|
|
|
|
if self.sync_to_kodi and self.section_type in v.PLEX_VIDEOTYPES:
|
2019-07-09 15:54:17 +10:00
|
|
|
# Node showing a menu for this section
|
2019-07-07 05:20:23 +10:00
|
|
|
args = {
|
|
|
|
'mode': 'show_section',
|
|
|
|
'section_index': self.index
|
|
|
|
}
|
2019-07-09 15:54:17 +10:00
|
|
|
index = utils.extend_url('plugin://%s' % v.ADDON_ID, args)
|
|
|
|
# Node directly displaying all content
|
|
|
|
path = 'library://video/Plex-{0}/{0}_all.xml'
|
|
|
|
path = path.format(self.section_id)
|
2019-01-09 04:00:54 +11:00
|
|
|
else:
|
2019-07-09 15:54:17 +10:00
|
|
|
# Node showing a menu for this section
|
2019-07-07 05:20:23 +10:00
|
|
|
args = {
|
|
|
|
'mode': 'browseplex',
|
2019-07-09 15:37:18 +10:00
|
|
|
'key': '/library/sections/%s' % self.section_id,
|
2020-12-19 03:10:20 +11:00
|
|
|
'section_id': str(self.section_id)
|
2019-07-07 05:20:23 +10:00
|
|
|
}
|
|
|
|
if not self.sync_to_kodi:
|
|
|
|
args['synched'] = 'false'
|
|
|
|
# No library xmls to speed things up
|
|
|
|
# Immediately show the PMS options for this section
|
2019-07-09 15:54:17 +10:00
|
|
|
index = self.addon_path(args)
|
|
|
|
# Node directly displaying all content
|
|
|
|
args = {
|
|
|
|
'mode': 'browseplex',
|
|
|
|
'key': '/library/sections/%s/all' % self.section_id,
|
2020-12-19 03:10:20 +11:00
|
|
|
'section_id': str(self.section_id)
|
2019-07-09 15:54:17 +10:00
|
|
|
}
|
|
|
|
if not self.sync_to_kodi:
|
|
|
|
args['synched'] = 'false'
|
2019-03-17 22:56:23 +11:00
|
|
|
path = self.addon_path(args)
|
|
|
|
utils.window('%s.index' % self.node, value=index)
|
2019-01-09 04:00:54 +11:00
|
|
|
utils.window('%s.title' % self.node, value=self.name)
|
|
|
|
utils.window('%s.type' % self.node, value=self.content)
|
2019-07-09 15:54:17 +10:00
|
|
|
utils.window('%s.content' % self.node, value=index)
|
2019-03-17 22:56:23 +11:00
|
|
|
# .path leads to all elements of this library
|
2019-04-14 19:03:05 +10:00
|
|
|
if self.section_type in v.PLEX_VIDEOTYPES:
|
|
|
|
utils.window('%s.path' % self.node,
|
|
|
|
value='ActivateWindow(videos,%s,return)' % path)
|
|
|
|
elif self.section_type == v.PLEX_TYPE_ARTIST:
|
|
|
|
utils.window('%s.path' % self.node,
|
|
|
|
value='ActivateWindow(music,%s,return)' % path)
|
|
|
|
else:
|
|
|
|
# Pictures
|
|
|
|
utils.window('%s.path' % self.node,
|
|
|
|
value='ActivateWindow(pictures,%s,return)' % path)
|
2019-05-29 02:42:04 +10:00
|
|
|
utils.window('%s.id' % self.node, value=str(self.section_id))
|
2019-01-09 04:00:54 +11:00
|
|
|
if not self.sync_to_kodi:
|
|
|
|
self.remove_files_from_kodi()
|
|
|
|
return
|
|
|
|
if self.section_type == v.PLEX_TYPE_ARTIST:
|
|
|
|
# Todo: Write window variables for music
|
|
|
|
return
|
|
|
|
if self.section_type == v.PLEX_TYPE_PHOTO:
|
|
|
|
# Todo: Write window variables for photos
|
|
|
|
return
|
|
|
|
|
|
|
|
# Create a dedicated directory for this section
|
|
|
|
if not path_ops.exists(self.path):
|
|
|
|
path_ops.makedirs(self.path)
|
|
|
|
# Create a tag just like the section name in the Kodi DB
|
|
|
|
with kodi_db.KodiVideoDB(lock=False) as kodidb:
|
2019-05-29 02:42:04 +10:00
|
|
|
self.kodi_tagid = kodidb.create_tag(self.name)
|
2019-01-09 04:00:54 +11:00
|
|
|
# The xmls are numbered in order of appearance
|
|
|
|
self.order = 0
|
|
|
|
if not path_ops.exists(path_ops.path.join(self.path, 'index.xml')):
|
|
|
|
LOG.debug('Creating index.xml for section %s', self.name)
|
|
|
|
xml = etree.Element('node',
|
2020-12-19 03:10:20 +11:00
|
|
|
attrib={'order': str(self.order)})
|
2019-01-09 04:00:54 +11:00
|
|
|
etree.SubElement(xml, 'label').text = self.name
|
|
|
|
etree.SubElement(xml, 'icon').text = self.icon or nodes.ICON_PATH
|
|
|
|
self._write_xml(xml, 'index.xml')
|
|
|
|
self.order += 1
|
|
|
|
# Create the one smart playlist for this section
|
|
|
|
if not path_ops.exists(self.playlist_path):
|
|
|
|
self._write_playlist()
|
|
|
|
# Now build all nodes for this section - potentially creating xmls
|
|
|
|
for node in nodes.NODE_TYPES[self.section_type]:
|
|
|
|
self._build_node(*node)
|
|
|
|
|
|
|
|
def _build_node(self, node_type, node_name, args, content, pms_node):
|
|
|
|
self.content = content
|
|
|
|
node_name = node_name.format(self=self)
|
2019-07-07 05:20:23 +10:00
|
|
|
if pms_node:
|
|
|
|
# Do NOT write a Kodi video library xml - can't use type="filter"
|
|
|
|
# to point back to plugin://plugin.video.plexkodiconnect
|
|
|
|
xml = nodes.node_pms(self, node_name, args)
|
|
|
|
args.pop('folder', None)
|
|
|
|
path = self.addon_path(args)
|
|
|
|
else:
|
|
|
|
# Write a Kodi video library xml
|
|
|
|
xml_name = '%s_%s.xml' % (self.section_id, node_type)
|
|
|
|
path = path_ops.path.join(self.path, xml_name)
|
|
|
|
if not path_ops.exists(path):
|
2019-01-09 04:00:54 +11:00
|
|
|
# Let's use Kodi's logic to sort/filter the Kodi library
|
|
|
|
xml = getattr(nodes, 'node_%s' % node_type)(self, node_name)
|
2019-07-07 05:20:23 +10:00
|
|
|
self._write_xml(xml, xml_name)
|
|
|
|
path = 'library://video/Plex-%s/%s' % (self.section_id, xml_name)
|
2019-01-09 04:00:54 +11:00
|
|
|
self.order += 1
|
2019-03-17 22:27:14 +11:00
|
|
|
self._window_node(path, node_name, node_type, pms_node)
|
2019-01-09 04:00:54 +11:00
|
|
|
|
|
|
|
def _write_xml(self, xml, xml_name):
|
|
|
|
LOG.debug('Creating xml for section %s: %s', self.name, xml_name)
|
|
|
|
utils.indent(xml)
|
|
|
|
etree.ElementTree(xml).write(path_ops.path.join(self.path, xml_name),
|
|
|
|
encoding='utf-8',
|
|
|
|
xml_declaration=True)
|
|
|
|
|
|
|
|
def _write_playlist(self):
|
|
|
|
LOG.debug('Creating smart playlist for section %s: %s',
|
|
|
|
self.name, self.playlist_path)
|
|
|
|
xml = etree.Element('smartplaylist',
|
2019-07-07 05:20:23 +10:00
|
|
|
attrib={'type': v.CONTENT_FROM_PLEX_TYPE[self.section_type]})
|
2019-01-09 04:00:54 +11:00
|
|
|
etree.SubElement(xml, 'name').text = self.name
|
|
|
|
etree.SubElement(xml, 'match').text = 'all'
|
|
|
|
rule = etree.SubElement(xml, 'rule', attrib={'field': 'tag',
|
|
|
|
'operator': 'is'})
|
|
|
|
etree.SubElement(rule, 'value').text = self.name
|
|
|
|
utils.indent(xml)
|
|
|
|
etree.ElementTree(xml).write(self.playlist_path, encoding='utf-8')
|
|
|
|
|
2019-03-17 22:27:14 +11:00
|
|
|
def _window_node(self, path, node_name, node_type, pms_node):
|
2019-01-09 04:00:54 +11:00
|
|
|
"""
|
|
|
|
Will save this section's node to the Kodi window variables
|
|
|
|
|
|
|
|
Uses the same conventions/logic as Emby for Kodi does
|
|
|
|
"""
|
2019-03-17 22:27:14 +11:00
|
|
|
if pms_node or not self.sync_to_kodi:
|
2019-01-09 04:00:54 +11:00
|
|
|
# Check: elif node_type in ('browse', 'homevideos', 'photos'):
|
|
|
|
window_path = path
|
2019-03-17 22:27:14 +11:00
|
|
|
elif self.section_type == v.PLEX_TYPE_ARTIST:
|
|
|
|
window_path = 'ActivateWindow(Music,%s,return)' % path
|
2019-01-09 04:00:54 +11:00
|
|
|
else:
|
|
|
|
window_path = 'ActivateWindow(Videos,%s,return)' % path
|
|
|
|
# if node_type == 'all':
|
|
|
|
# var = self.node
|
|
|
|
# utils.window('%s.index' % var,
|
2019-05-29 02:42:04 +10:00
|
|
|
# value=path.replace('%s_all.xml' % self.section_id, ''))
|
2019-01-09 04:00:54 +11:00
|
|
|
# utils.window('%s.title' % var, value=self.name)
|
|
|
|
# else:
|
|
|
|
var = '%s.%s' % (self.node, node_type)
|
|
|
|
utils.window('%s.index' % var, value=path)
|
|
|
|
utils.window('%s.title' % var, value=node_name)
|
2019-05-29 02:42:04 +10:00
|
|
|
utils.window('%s.id' % var, value=str(self.section_id))
|
2019-01-09 04:00:54 +11:00
|
|
|
utils.window('%s.path' % var, value=window_path)
|
|
|
|
utils.window('%s.type' % var, value=self.content)
|
|
|
|
utils.window('%s.content' % var, value=path)
|
|
|
|
utils.window('%s.artwork' % var, value=self.artwork)
|
|
|
|
|
|
|
|
def remove_files_from_kodi(self):
|
|
|
|
"""
|
|
|
|
Removes this sections from the Kodi userdata library folder (if appl.)
|
|
|
|
Also removes the smart playlist
|
|
|
|
"""
|
|
|
|
if self.section_type in (v.PLEX_TYPE_ARTIST, v.PLEX_TYPE_PHOTO):
|
|
|
|
# No files created for these types
|
|
|
|
return
|
|
|
|
if path_ops.exists(self.path):
|
|
|
|
path_ops.rmtree(self.path, ignore_errors=True)
|
|
|
|
if path_ops.exists(self.playlist_path):
|
|
|
|
try:
|
|
|
|
path_ops.remove(self.playlist_path)
|
|
|
|
except (OSError, IOError):
|
|
|
|
LOG.warn('Could not delete smart playlist for section %s: %s',
|
|
|
|
self.name, self.playlist_path)
|
|
|
|
|
|
|
|
def remove_window_vars(self):
|
|
|
|
"""
|
|
|
|
Removes all windows variables 'Plex.nodes.<section_id>.xxx'
|
|
|
|
"""
|
|
|
|
if self.index is not None:
|
|
|
|
_clear_window_vars(self.index)
|
|
|
|
|
|
|
|
def remove_from_plex(self, plexdb=None):
|
|
|
|
"""
|
|
|
|
Removes this sections completely from the Plex DB
|
|
|
|
"""
|
|
|
|
if plexdb:
|
2019-05-29 02:42:04 +10:00
|
|
|
plexdb.remove_section(self.section_id)
|
2019-01-09 04:00:54 +11:00
|
|
|
else:
|
|
|
|
with PlexDB(lock=False) as plexdb:
|
2019-05-29 02:42:04 +10:00
|
|
|
plexdb.remove_section(self.section_id)
|
2019-01-09 04:00:54 +11:00
|
|
|
|
|
|
|
def remove(self):
|
|
|
|
"""
|
|
|
|
Completely and utterly removes this section from Kodi and Plex DB
|
|
|
|
as well as from the window variables
|
|
|
|
"""
|
|
|
|
self.remove_files_from_kodi()
|
|
|
|
self.remove_window_vars()
|
|
|
|
self.remove_from_plex()
|
|
|
|
|
2018-10-20 23:49:04 +11:00
|
|
|
|
2019-11-24 19:33:16 +11:00
|
|
|
def _get_children(plex_type):
|
|
|
|
if plex_type == v.PLEX_TYPE_ALBUM:
|
|
|
|
return True
|
|
|
|
else:
|
|
|
|
return False
|
|
|
|
|
|
|
|
|
|
|
|
def get_sync_section(section, plex_type):
|
|
|
|
"""
|
|
|
|
Deep-copies section and adds certain arguments in order to prep section
|
|
|
|
for the library sync
|
|
|
|
"""
|
|
|
|
section = copy.deepcopy(section)
|
|
|
|
section.plex_type = plex_type
|
|
|
|
section.context = itemtypes.ITEMTYPE_FROM_PLEXTYPE[plex_type]
|
|
|
|
section.get_children = _get_children(plex_type)
|
|
|
|
# Some more init stuff
|
|
|
|
# Has sync for this section been successful?
|
|
|
|
section.sync_successful = True
|
|
|
|
# List of tuples: (collection index [as in an item's metadata with
|
|
|
|
# "Collection id"], collection plex id)
|
|
|
|
section.collection_match = None
|
|
|
|
# Dict with entries of the form <collection index>: <collection xml>
|
|
|
|
section.collection_xmls = {}
|
|
|
|
# Keep count during sync
|
|
|
|
section.count = 0
|
|
|
|
# Total number of items that we need to sync
|
|
|
|
section.number_of_items = 0
|
|
|
|
# Iterator to get one sync item after the other
|
|
|
|
section.iterator = None
|
|
|
|
return section
|
|
|
|
|
|
|
|
|
2019-02-08 06:15:49 +11:00
|
|
|
def force_full_sync():
|
|
|
|
"""
|
|
|
|
Resets the sync timestamp for all sections to 0, thus forcing a subsequent
|
|
|
|
full sync (not delta)
|
|
|
|
"""
|
|
|
|
LOG.info('Telling PKC to do a full sync instead of a delta sync')
|
|
|
|
with PlexDB() as plexdb:
|
|
|
|
plexdb.force_full_sync()
|
|
|
|
|
|
|
|
|
2019-01-09 04:00:54 +11:00
|
|
|
def _save_sections_to_plex_db(sections):
|
|
|
|
with PlexDB() as plexdb:
|
|
|
|
for section in sections:
|
|
|
|
section.to_plex_db(plexdb=plexdb)
|
2019-01-31 06:36:52 +11:00
|
|
|
|
|
|
|
|
2019-01-09 04:00:54 +11:00
|
|
|
def _retrieve_old_settings(sections, old_sections):
|
|
|
|
"""
|
|
|
|
Overwrites the PKC settings for sections, grabing them from old_sections
|
|
|
|
if a particular section is in both sections and old_sections
|
2018-10-20 23:49:04 +11:00
|
|
|
|
2019-01-09 04:00:54 +11:00
|
|
|
Thus sets to the old values:
|
|
|
|
section.last_sync
|
2019-05-29 02:42:04 +10:00
|
|
|
section.kodi_tagid
|
2019-01-09 04:00:54 +11:00
|
|
|
section.sync_to_kodi
|
|
|
|
section.last_sync
|
|
|
|
"""
|
|
|
|
for section in sections:
|
|
|
|
for old_section in old_sections:
|
|
|
|
if section == old_section:
|
|
|
|
section.last_sync = old_section.last_sync
|
2019-05-29 02:42:04 +10:00
|
|
|
section.kodi_tagid = old_section.kodi_tagid
|
2019-01-09 04:00:54 +11:00
|
|
|
section.sync_to_kodi = old_section.sync_to_kodi
|
|
|
|
section.last_sync = old_section.last_sync
|
2018-10-20 23:49:04 +11:00
|
|
|
|
2019-01-09 04:00:54 +11:00
|
|
|
|
|
|
|
def _delete_kodi_db_items(section):
|
|
|
|
if section.section_type == v.PLEX_TYPE_MOVIE:
|
2019-01-31 00:34:35 +11:00
|
|
|
kodi_context = kodi_db.KodiVideoDB
|
|
|
|
types = ((v.PLEX_TYPE_MOVIE, itemtypes.Movie), )
|
2019-01-09 04:00:54 +11:00
|
|
|
elif section.section_type == v.PLEX_TYPE_SHOW:
|
2019-01-31 00:34:35 +11:00
|
|
|
kodi_context = kodi_db.KodiVideoDB
|
|
|
|
types = ((v.PLEX_TYPE_SHOW, itemtypes.Show),
|
|
|
|
(v.PLEX_TYPE_SEASON, itemtypes.Season),
|
|
|
|
(v.PLEX_TYPE_EPISODE, itemtypes.Episode))
|
2019-01-09 04:00:54 +11:00
|
|
|
elif section.section_type == v.PLEX_TYPE_ARTIST:
|
2019-01-31 00:34:35 +11:00
|
|
|
kodi_context = kodi_db.KodiMusicDB
|
|
|
|
types = ((v.PLEX_TYPE_ARTIST, itemtypes.Artist),
|
|
|
|
(v.PLEX_TYPE_ALBUM, itemtypes.Album),
|
|
|
|
(v.PLEX_TYPE_SONG, itemtypes.Song))
|
2020-07-30 01:42:04 +10:00
|
|
|
else:
|
|
|
|
types = ()
|
|
|
|
LOG.debug('Skipping deletion of DB elements for section %s', section)
|
2019-01-31 00:34:35 +11:00
|
|
|
for plex_type, context in types:
|
|
|
|
while True:
|
|
|
|
with PlexDB() as plexdb:
|
2019-05-29 02:42:04 +10:00
|
|
|
plex_ids = list(plexdb.plexid_by_sectionid(section.section_id,
|
2019-01-31 00:34:35 +11:00
|
|
|
plex_type,
|
|
|
|
BATCH_SIZE))
|
|
|
|
with kodi_context(texture_db=True) as kodidb:
|
|
|
|
typus = context(None, plexdb=plexdb, kodidb=kodidb)
|
|
|
|
for plex_id in plex_ids:
|
2019-11-29 03:49:48 +11:00
|
|
|
if SHOULD_CANCEL():
|
2019-01-31 00:34:35 +11:00
|
|
|
return False
|
|
|
|
typus.remove(plex_id)
|
|
|
|
if len(plex_ids) < BATCH_SIZE:
|
|
|
|
break
|
|
|
|
return True
|
|
|
|
|
|
|
|
|
2019-01-09 04:00:54 +11:00
|
|
|
def _choose_libraries(sections):
|
2019-02-08 06:15:49 +11:00
|
|
|
"""
|
|
|
|
Displays a dialog for the user to select the libraries he wants synched
|
|
|
|
|
2019-01-09 04:00:54 +11:00
|
|
|
Returns True if the user chose new sections, False if he aborted
|
2019-02-08 06:15:49 +11:00
|
|
|
"""
|
|
|
|
import xbmcgui
|
2019-01-09 04:00:54 +11:00
|
|
|
selectable_sections = []
|
|
|
|
preselected = []
|
2019-02-08 20:59:12 +11:00
|
|
|
index = 0
|
2019-01-09 04:00:54 +11:00
|
|
|
for section in sections:
|
|
|
|
if not app.SYNC.enable_music and section.section_type == v.PLEX_TYPE_ARTIST:
|
2019-02-08 20:59:12 +11:00
|
|
|
LOG.info('Ignoring music section: %s', section)
|
|
|
|
continue
|
2019-01-09 04:00:54 +11:00
|
|
|
elif section.section_type == v.PLEX_TYPE_PHOTO:
|
|
|
|
# We won't ever show Photo sections
|
2019-02-08 20:59:12 +11:00
|
|
|
continue
|
2019-02-08 06:15:49 +11:00
|
|
|
else:
|
2019-01-09 04:00:54 +11:00
|
|
|
# Offer user the new section
|
|
|
|
selectable_sections.append(section.name)
|
|
|
|
# Sections have been either preselected by the user or they are new
|
|
|
|
if section.sync_to_kodi:
|
|
|
|
preselected.append(index)
|
2019-02-08 20:59:12 +11:00
|
|
|
index += 1
|
2019-01-09 04:00:54 +11:00
|
|
|
# Don't ask the user again for this PMS even if user cancel the sync dialog
|
|
|
|
utils.settings('sections_asked_for_machine_identifier',
|
|
|
|
value=app.CONN.machine_identifier)
|
2019-02-08 20:59:12 +11:00
|
|
|
# "Select Plex libraries to sync"
|
2019-01-09 04:00:54 +11:00
|
|
|
selected_sections = xbmcgui.Dialog().multiselect(utils.lang(30524),
|
|
|
|
selectable_sections,
|
|
|
|
preselect=preselected,
|
|
|
|
useDetails=False)
|
2020-11-07 01:57:24 +11:00
|
|
|
if selected_sections is None:
|
2019-01-09 04:00:54 +11:00
|
|
|
LOG.info('User chose not to select which libraries to sync')
|
2019-02-08 06:15:49 +11:00
|
|
|
return False
|
2019-02-08 20:59:12 +11:00
|
|
|
index = 0
|
2019-01-09 04:00:54 +11:00
|
|
|
for section in sections:
|
|
|
|
if not app.SYNC.enable_music and section.section_type == v.PLEX_TYPE_ARTIST:
|
|
|
|
continue
|
|
|
|
elif section.section_type == v.PLEX_TYPE_PHOTO:
|
|
|
|
continue
|
|
|
|
else:
|
|
|
|
section.sync_to_kodi = index in selected_sections
|
|
|
|
index += 1
|
|
|
|
return True
|
|
|
|
|
|
|
|
|
|
|
|
def delete_playlists():
|
|
|
|
"""
|
|
|
|
Clean up the playlists
|
|
|
|
"""
|
|
|
|
path = path_ops.translate_path('special://profile/playlists/video/')
|
|
|
|
for root, _, files in path_ops.walk(path):
|
|
|
|
for file in files:
|
|
|
|
if file.startswith('Plex'):
|
|
|
|
path_ops.remove(path_ops.path.join(root, file))
|
|
|
|
|
|
|
|
|
|
|
|
def delete_nodes():
|
|
|
|
"""
|
|
|
|
Clean up video nodes
|
|
|
|
"""
|
|
|
|
path = path_ops.translate_path("special://profile/library/video/")
|
|
|
|
for root, dirs, _ in path_ops.walk(path):
|
|
|
|
for directory in dirs:
|
|
|
|
if directory.startswith('Plex-'):
|
|
|
|
path_ops.rmtree(path_ops.path.join(root, directory))
|
|
|
|
break
|
|
|
|
|
|
|
|
|
|
|
|
def delete_files():
|
|
|
|
"""
|
|
|
|
Deletes both all the Plex-xxx video node xmls as well as smart playlists
|
|
|
|
"""
|
|
|
|
delete_nodes()
|
|
|
|
delete_playlists()
|
|
|
|
|
|
|
|
|
|
|
|
def sync_from_pms(parent_self, pick_libraries=False):
|
|
|
|
"""
|
|
|
|
Sync the Plex library sections.
|
|
|
|
pick_libraries=True will prompt the user the select the libraries he
|
|
|
|
wants to sync
|
|
|
|
"""
|
2019-11-29 03:49:48 +11:00
|
|
|
global SHOULD_CANCEL
|
2019-01-09 04:00:54 +11:00
|
|
|
LOG.info('Starting synching sections from the PMS')
|
2019-11-29 03:49:48 +11:00
|
|
|
SHOULD_CANCEL = parent_self.should_cancel
|
2019-01-09 04:00:54 +11:00
|
|
|
try:
|
|
|
|
return _sync_from_pms(pick_libraries)
|
|
|
|
finally:
|
2019-11-29 03:49:48 +11:00
|
|
|
SHOULD_CANCEL = None
|
2019-08-29 01:46:25 +10:00
|
|
|
LOG.info('Done synching sections from the PMS: %s', app.SYNC.sections)
|
2019-01-09 04:00:54 +11:00
|
|
|
|
|
|
|
|
|
|
|
def _sync_from_pms(pick_libraries):
|
|
|
|
# Re-set value in order to make sure we got the lastest user input
|
|
|
|
app.SYNC.enable_music = utils.settings('enableMusic') == 'true'
|
|
|
|
xml = PF.get_plex_sections()
|
|
|
|
if xml is None:
|
|
|
|
LOG.error("Error download PMS sections, abort")
|
|
|
|
return False
|
|
|
|
sections = []
|
|
|
|
old_sections = []
|
|
|
|
for i, xml_element in enumerate(xml.findall('Directory')):
|
2021-02-07 23:00:58 +11:00
|
|
|
api = API(xml_element)
|
|
|
|
if api.plex_type in v.UNSUPPORTED_PLEX_TYPES:
|
|
|
|
continue
|
2019-01-09 04:00:54 +11:00
|
|
|
sections.append(Section(index=i, xml_element=xml_element))
|
2019-02-08 06:15:49 +11:00
|
|
|
with PlexDB() as plexdb:
|
2019-01-09 04:00:54 +11:00
|
|
|
for section_db in plexdb.all_sections():
|
|
|
|
old_sections.append(Section(section_db_element=section_db))
|
|
|
|
# Update our latest PMS sections with info saved in the PMS DB
|
|
|
|
_retrieve_old_settings(sections, old_sections)
|
|
|
|
if (app.CONN.machine_identifier != utils.settings('sections_asked_for_machine_identifier') or
|
|
|
|
pick_libraries):
|
|
|
|
if not pick_libraries:
|
|
|
|
LOG.info('First time connecting to this PMS, choosing libraries')
|
|
|
|
_choose_libraries(sections)
|
|
|
|
|
|
|
|
# We got everything - save to Plex db in case Kodi restarts before we're
|
|
|
|
# done here
|
|
|
|
_save_sections_to_plex_db(sections)
|
|
|
|
# Tweak some settings so Kodi does NOT scan the music folders
|
|
|
|
if app.SYNC.direct_paths is True:
|
|
|
|
# Will reboot Kodi is new library detected
|
|
|
|
music.excludefromscan_music_folders(sections)
|
|
|
|
|
|
|
|
# Delete all old sections that are obsolete
|
|
|
|
# This will also delete sections whose name (or type) have changed
|
|
|
|
for old_section in old_sections:
|
|
|
|
for section in sections:
|
|
|
|
if old_section == section:
|
|
|
|
break
|
|
|
|
else:
|
|
|
|
if not old_section.sync_to_kodi:
|
2019-02-08 20:59:12 +11:00
|
|
|
continue
|
2019-01-09 04:00:54 +11:00
|
|
|
LOG.info('Deleting entire section: %s', old_section)
|
|
|
|
# Remove all linked items
|
|
|
|
if not _delete_kodi_db_items(old_section):
|
|
|
|
return False
|
|
|
|
# Remove the section itself
|
|
|
|
old_section.remove()
|
|
|
|
|
2019-04-17 23:39:44 +10:00
|
|
|
# Clear all existing window vars because we did NOT remove them with the
|
|
|
|
# command section.remove()
|
|
|
|
clear_window_vars()
|
2019-01-09 04:00:54 +11:00
|
|
|
# Time to write the sections to Kodi
|
|
|
|
for section in sections:
|
|
|
|
section.to_kodi()
|
|
|
|
# Counter that tells us how many sections we have - e.g. for skins and
|
|
|
|
# listings
|
|
|
|
utils.window('Plex.nodes.total', str(len(sections)))
|
2019-08-29 01:46:25 +10:00
|
|
|
app.SYNC.sections = sections
|
2019-02-08 06:15:49 +11:00
|
|
|
return True
|
2019-01-09 04:00:54 +11:00
|
|
|
|
|
|
|
|
|
|
|
def _clear_window_vars(index):
|
|
|
|
node = 'Plex.nodes.%s' % index
|
2019-04-17 23:39:44 +10:00
|
|
|
utils.window('%s.index' % node, clear=True)
|
2019-01-09 04:00:54 +11:00
|
|
|
utils.window('%s.title' % node, clear=True)
|
|
|
|
utils.window('%s.type' % node, clear=True)
|
|
|
|
utils.window('%s.content' % node, clear=True)
|
|
|
|
utils.window('%s.path' % node, clear=True)
|
|
|
|
utils.window('%s.id' % node, clear=True)
|
2019-04-17 23:39:44 +10:00
|
|
|
# Just clear everything here, ignore the plex_type
|
2020-12-19 03:10:20 +11:00
|
|
|
for typus in (x[0] for y in list(nodes.NODE_TYPES.values()) for x in y):
|
2019-04-17 23:39:44 +10:00
|
|
|
for kind in WINDOW_ARGS:
|
|
|
|
node = 'Plex.nodes.%s.%s.%s' % (index, typus, kind)
|
|
|
|
utils.window(node, clear=True)
|
2019-01-09 04:00:54 +11:00
|
|
|
|
|
|
|
|
|
|
|
def clear_window_vars():
|
|
|
|
"""
|
|
|
|
Removes all references to sections stored in window vars 'Plex.nodes...'
|
|
|
|
"""
|
2019-04-17 23:39:44 +10:00
|
|
|
LOG.debug('Clearing all the Plex video node variables')
|
2019-01-09 04:00:54 +11:00
|
|
|
number_of_nodes = int(utils.window('Plex.nodes.total') or 0)
|
|
|
|
utils.window('Plex.nodes.total', clear=True)
|
|
|
|
for index in range(number_of_nodes):
|
|
|
|
_clear_window_vars(index)
|
2019-04-14 22:20:03 +10:00
|
|
|
|
|
|
|
|
|
|
|
def delete_videonode_files():
|
|
|
|
"""
|
|
|
|
Removes all the PKC video node files under userdata/library/video that
|
|
|
|
start with 'Plex-'
|
|
|
|
"""
|
|
|
|
for root, dirs, _ in path_ops.walk(LIBRARY_PATH):
|
|
|
|
for directory in dirs:
|
|
|
|
if directory.startswith('Plex-'):
|
|
|
|
abs_path = path_ops.path.join(root, directory)
|
|
|
|
LOG.info('Removing video node directory %s', abs_path)
|
|
|
|
path_ops.rmtree(abs_path, ignore_errors=True)
|
|
|
|
break
|