mirror of
https://github.com/beetbox/beets.git
synced 2025-12-06 08:39:17 +01:00
cb13d21ad6
- MetaSources get loaded from the modules automatically - The MetaSources can define their own item_types, that get loaded for the plugin - __init__ doesn't need any changes to accept new metasources - Fix the --sources option to actually accept sources (it was being interpreted as boolean flag before, crashing the plugin) - More safety w.r.t. external dependencies
97 lines
3.4 KiB
Python
97 lines
3.4 KiB
Python
# This file is part of beets.
|
|
# Copyright 2015, Tom Jaspers.
|
|
#
|
|
# Permission is hereby granted, free of charge, to any person obtaining
|
|
# a copy of this software and associated documentation files (the
|
|
# "Software"), to deal in the Software without restriction, including
|
|
# without limitation the rights to use, copy, modify, merge, publish,
|
|
# distribute, sublicense, and/or sell copies of the Software, and to
|
|
# permit persons to whom the Software is furnished to do so, subject to
|
|
# the following conditions:
|
|
#
|
|
# The above copyright notice and this permission notice shall be
|
|
# included in all copies or substantial portions of the Software.
|
|
|
|
"""Synchronize information from iTunes's library
|
|
"""
|
|
from contextlib import contextmanager
|
|
import os
|
|
import shutil
|
|
import tempfile
|
|
import plistlib
|
|
from time import mktime
|
|
|
|
from beets import util
|
|
from beets.dbcore import types
|
|
from beets.library import DateType
|
|
from beets.util.confit import ConfigValueError
|
|
from beetsplug.metasync import MetaSource
|
|
|
|
|
|
@contextmanager
|
|
def create_temporary_copy(path):
|
|
temp_dir = tempfile.gettempdir()
|
|
temp_path = os.path.join(temp_dir, 'temp_itunes_lib')
|
|
shutil.copyfile(path, temp_path)
|
|
try:
|
|
yield temp_path
|
|
finally:
|
|
shutil.rmtree(temp_dir)
|
|
|
|
|
|
class Itunes(MetaSource):
|
|
|
|
item_types = {
|
|
'itunes_rating': types.INTEGER, # 0..100 scale
|
|
'itunes_playcount': types.INTEGER,
|
|
'itunes_skipcount': types.INTEGER,
|
|
'itunes_lastplayed': DateType(),
|
|
'itunes_lastskipped': DateType(),
|
|
}
|
|
|
|
def __init__(self, config, log):
|
|
super(Itunes, self).__init__(config, log)
|
|
|
|
# Load the iTunes library, which has to be the .xml one (not the .itl)
|
|
library_path = util.normpath(config['itunes']['library'].get(str))
|
|
|
|
try:
|
|
self._log.debug(
|
|
u'loading iTunes library from {0}'.format(library_path))
|
|
with create_temporary_copy(library_path) as library_copy:
|
|
raw_library = plistlib.readPlist(library_copy)
|
|
except IOError as e:
|
|
raise ConfigValueError(u'invalid iTunes library: ' + e.strerror)
|
|
except Exception:
|
|
# It's likely the user configured their '.itl' library (<> xml)
|
|
if os.path.splitext(library_path)[1].lower() != '.xml':
|
|
hint = u': please ensure that the configured path' \
|
|
u' points to the .XML library'
|
|
else:
|
|
hint = ''
|
|
raise ConfigValueError(u'invalid iTunes library' + hint)
|
|
|
|
# Convert the library in to something we can query more easily
|
|
self.collection = {
|
|
(track['Name'], track['Album'], track['Album Artist']): track
|
|
for track in raw_library['Tracks'].values()}
|
|
|
|
def sync_data(self, item):
|
|
key = (item.title, item.album, item.albumartist)
|
|
result = self.collection.get(key)
|
|
|
|
if not all(key) or not result:
|
|
self._log.warning(u'no iTunes match found for {0}'.format(item))
|
|
return
|
|
|
|
item.itunes_rating = result.get('Rating')
|
|
item.itunes_playcount = result.get('Play Count')
|
|
item.itunes_skipcount = result.get('Skip Count')
|
|
|
|
if result.get('Play Date UTC'):
|
|
item.itunes_lastplayed = mktime(
|
|
result.get('Play Date UTC').timetuple())
|
|
|
|
if result.get('Skip Date'):
|
|
item.itunes_lastskipped = mktime(
|
|
result.get('Skip Date').timetuple())
|