mirror of
https://github.com/beetbox/beets.git
synced 2025-12-06 08:39:17 +01:00
113 lines
3.7 KiB
Python
113 lines
3.7 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
"""Updates an Plex library whenever the beets library is changed.
|
|
|
|
Plex Home users enter the Plex Token to enable updating.
|
|
Put something like the following in your config.yaml to configure:
|
|
plex:
|
|
host: localhost
|
|
port: 32400
|
|
token: token
|
|
"""
|
|
from __future__ import division, absolute_import, print_function
|
|
|
|
import requests
|
|
from xml.etree import ElementTree
|
|
from six.moves.urllib.parse import urljoin, urlencode
|
|
from beets import config
|
|
from beets.plugins import BeetsPlugin
|
|
|
|
|
|
def get_music_section(host, port, token, library_name, use_secure,
|
|
ignore_cert_errors):
|
|
"""Getting the section key for the music library in Plex.
|
|
"""
|
|
api_endpoint = append_token('library/sections', token)
|
|
url = urljoin('{0}://{1}:{2}'.format(get_protocol(use_secure), host,
|
|
port), api_endpoint)
|
|
|
|
# Sends request.
|
|
r = requests.get(url, verify=not ignore_cert_errors)
|
|
|
|
# Parse xml tree and extract music section key.
|
|
tree = ElementTree.fromstring(r.content)
|
|
for child in tree.findall('Directory'):
|
|
if child.get('title') == library_name:
|
|
return child.get('key')
|
|
|
|
|
|
def update_plex(host, port, token, library_name, use_secure,
|
|
ignore_cert_errors):
|
|
"""Ignore certificate errors if configured to.
|
|
"""
|
|
if ignore_cert_errors:
|
|
import urllib3
|
|
urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
|
|
"""Sends request to the Plex api to start a library refresh.
|
|
"""
|
|
# Getting section key and build url.
|
|
section_key = get_music_section(host, port, token, library_name,
|
|
use_secure, ignore_cert_errors)
|
|
api_endpoint = 'library/sections/{0}/refresh'.format(section_key)
|
|
api_endpoint = append_token(api_endpoint, token)
|
|
url = urljoin('{0}://{1}:{2}'.format(get_protocol(use_secure), host,
|
|
port), api_endpoint)
|
|
|
|
# Sends request and returns requests object.
|
|
r = requests.get(url, verify=not ignore_cert_errors)
|
|
return r
|
|
|
|
|
|
def append_token(url, token):
|
|
"""Appends the Plex Home token to the api call if required.
|
|
"""
|
|
if token:
|
|
url += '?' + urlencode({'X-Plex-Token': token})
|
|
return url
|
|
|
|
|
|
def get_protocol(use_secure):
|
|
if use_secure:
|
|
return 'https'
|
|
else:
|
|
return 'http'
|
|
|
|
|
|
class PlexUpdate(BeetsPlugin):
|
|
def __init__(self):
|
|
super(PlexUpdate, self).__init__()
|
|
|
|
# Adding defaults.
|
|
config['plex'].add({
|
|
u'host': u'localhost',
|
|
u'port': 32400,
|
|
u'token': u'',
|
|
u'library_name': u'Music',
|
|
u'use_secure': False,
|
|
u'ignore_cert_errors': False})
|
|
|
|
config['plex']['token'].redact = True
|
|
self.register_listener('database_change', self.listen_for_db_change)
|
|
|
|
def listen_for_db_change(self, lib, model):
|
|
"""Listens for beets db change and register the update for the end"""
|
|
self.register_listener('cli_exit', self.update)
|
|
|
|
def update(self, lib):
|
|
"""When the client exists try to send refresh request to Plex server.
|
|
"""
|
|
self._log.info(u'Updating Plex library...')
|
|
|
|
# Try to send update request.
|
|
try:
|
|
update_plex(
|
|
config['plex']['host'].get(),
|
|
config['plex']['port'].get(),
|
|
config['plex']['token'].get(),
|
|
config['plex']['library_name'].get(),
|
|
config['plex']['use_secure'].get(bool),
|
|
config['plex']['ignore_cert_errors'].get(bool))
|
|
self._log.info(u'... started.')
|
|
|
|
except requests.exceptions.RequestException:
|
|
self._log.warning(u'Update failed.')
|