diff --git a/data/interfaces/default/history.html b/data/interfaces/default/history.html
index f0736872..c76875e1 100644
--- a/data/interfaces/default/history.html
+++ b/data/interfaces/default/history.html
@@ -1,7 +1,7 @@
<%inherit file="base.html"/>
<%!
from headphones import helpers
- import cgi
+ from html import escape as html_escape
%>
<%def name="headerIncludes()">
@@ -62,11 +62,11 @@
%>
| ${item['DateAdded']} |
- ${cgi.escape(item['Title'], quote=True)} [${fileid}][album page] |
+ ${html_escape(item['Title'], quote=True)} [${fileid}][album page] |
${helpers.bytes_to_mb(item['Size'])} |
${item['Status']} |
- [retry][new] |
- 
+ | [retry][new] |
+
|
%endfor
diff --git a/headphones/__init__.py b/headphones/__init__.py
index 9a0c4fc5..2952e0af 100644
--- a/headphones/__init__.py
+++ b/headphones/__init__.py
@@ -218,7 +218,7 @@ def daemonize():
pid = os.fork() # @UndefinedVariable - only available in UNIX
if pid != 0:
sys.exit(0)
- except OSError, e:
+ except OSError as e:
raise RuntimeError("1st fork failed: %s [%d]", e.strerror, e.errno)
os.setsid()
@@ -232,7 +232,7 @@ def daemonize():
pid = os.fork() # @UndefinedVariable - only available in UNIX
if pid != 0:
sys.exit(0)
- except OSError, e:
+ except OSError as e:
raise RuntimeError("2nd fork failed: %s [%d]", e.strerror, e.errno)
dev_null = file('/dev/null', 'r')
diff --git a/headphones/api.py b/headphones/api.py
index 2ae742e3..025f12cf 100644
--- a/headphones/api.py
+++ b/headphones/api.py
@@ -86,7 +86,7 @@ class Api(object):
methodToCall = getattr(self, "_" + self.cmd)
methodToCall(**self.kwargs)
if 'callback' not in self.kwargs:
- if isinstance(self.data, basestring):
+ if isinstance(self.data, str):
return self.data
else:
return json.dumps(self.data)
@@ -106,7 +106,7 @@ class Api(object):
rows_as_dic = []
for row in rows:
- row_as_dic = dict(zip(row.keys(), row))
+ row_as_dic = dict(list(zip(list(row.keys()), row)))
rows_as_dic.append(row_as_dic)
return rows_as_dic
@@ -474,17 +474,17 @@ class Api(object):
# Handle situations where the torrent url contains arguments that are
# parsed
if kwargs:
- import urllib
- import urllib2
- url = urllib2.quote(
- url, safe=":?/=&") + '&' + urllib.urlencode(kwargs)
+ import urllib.request, urllib.parse, urllib.error
+ import urllib.request, urllib.error, urllib.parse
+ url = urllib.parse.quote(
+ url, safe=":?/=&") + '&' + urllib.parse.urlencode(kwargs)
try:
result = [(title, int(size), url, provider, kind)]
except ValueError:
result = [(title, float(size), url, provider, kind)]
- logger.info(u"Making sure we can download the chosen result")
+ logger.info("Making sure we can download the chosen result")
(data, bestqual) = searcher.preprocess(result)
if data and bestqual:
diff --git a/headphones/cache.py b/headphones/cache.py
index db42bd18..fb5c1fbe 100644
--- a/headphones/cache.py
+++ b/headphones/cache.py
@@ -240,7 +240,7 @@ class Cache(object):
# fallback to 1st album cover if none of the above
elif 'albums' in data:
- for mbid, art in data.get('albums', dict()).items():
+ for mbid, art in list(data.get('albums', dict()).items()):
if 'albumcover' in art:
image_url = art['albumcover'][0]['url']
break
@@ -352,7 +352,7 @@ class Cache(object):
# fallback to 1st album cover if none of the above
elif 'albums' in data:
- for mbid, art in data.get('albums', dict()).items():
+ for mbid, art in list(data.get('albums', dict()).items()):
if 'albumcover' in art:
image_url = art['albumcover'][0]['url']
break
diff --git a/headphones/classes.py b/headphones/classes.py
index 6015a0f2..a06f4f82 100644
--- a/headphones/classes.py
+++ b/headphones/classes.py
@@ -18,12 +18,12 @@
#######################################
-import urllib
+import urllib.request, urllib.parse, urllib.error
-from common import USER_AGENT
+from .common import USER_AGENT
-class HeadphonesURLopener(urllib.FancyURLopener):
+class HeadphonesURLopener(urllib.request.FancyURLopener):
version = USER_AGENT
@@ -44,7 +44,7 @@ class AuthURLOpener(HeadphonesURLopener):
self.numTries = 0
# call the base class
- urllib.FancyURLopener.__init__(self)
+ urllib.request.FancyURLopener.__init__(self)
def prompt_user_passwd(self, host, realm):
"""
diff --git a/headphones/common.py b/headphones/common.py
index 0a33bde7..a311860a 100644
--- a/headphones/common.py
+++ b/headphones/common.py
@@ -24,6 +24,7 @@ import operator
import os
import re
from headphones import version
+from functools import reduce
# Identify Our Application
@@ -74,7 +75,7 @@ class Quality:
@staticmethod
def _getStatusStrings(status):
toReturn = {}
- for x in Quality.qualityStrings.keys():
+ for x in list(Quality.qualityStrings.keys()):
toReturn[Quality.compositeStatus(status, x)] = Quality.statusPrefixes[status] + " (" + \
Quality.qualityStrings[x] + ")"
return toReturn
@@ -93,7 +94,7 @@ class Quality:
def splitQuality(quality):
anyQualities = []
bestQualities = []
- for curQual in Quality.qualityStrings.keys():
+ for curQual in list(Quality.qualityStrings.keys()):
if curQual & quality:
anyQualities.append(curQual)
if curQual << 16 & quality:
@@ -151,7 +152,7 @@ class Quality:
@staticmethod
def splitCompositeStatus(status):
"""Returns a tuple containing (status, quality)"""
- for x in sorted(Quality.qualityStrings.keys(), reverse=True):
+ for x in sorted(list(Quality.qualityStrings.keys()), reverse=True):
if status > x * 100:
return (status - x * 100, x)
@@ -169,10 +170,10 @@ class Quality:
SNATCHED_PROPER = None
-Quality.DOWNLOADED = [Quality.compositeStatus(DOWNLOADED, x) for x in Quality.qualityStrings.keys()]
-Quality.SNATCHED = [Quality.compositeStatus(SNATCHED, x) for x in Quality.qualityStrings.keys()]
+Quality.DOWNLOADED = [Quality.compositeStatus(DOWNLOADED, x) for x in list(Quality.qualityStrings.keys())]
+Quality.SNATCHED = [Quality.compositeStatus(SNATCHED, x) for x in list(Quality.qualityStrings.keys())]
Quality.SNATCHED_PROPER = [Quality.compositeStatus(SNATCHED_PROPER, x) for x in
- Quality.qualityStrings.keys()]
+ list(Quality.qualityStrings.keys())]
MP3 = Quality.combineQualities([Quality.B192, Quality.B256, Quality.B320, Quality.VBR], [])
LOSSLESS = Quality.combineQualities([Quality.FLAC], [])
diff --git a/headphones/config.py b/headphones/config.py
index 7a8b93fc..69fdff08 100644
--- a/headphones/config.py
+++ b/headphones/config.py
@@ -2,15 +2,16 @@ import itertools
import os
import re
+import ast
+from configparser import ConfigParser
import headphones.logger
-from configobj import ConfigObj
def bool_int(value):
"""
Casts a config value into a 0 or 1
"""
- if isinstance(value, basestring):
+ if isinstance(value, str):
if value.lower() in ('', '0', 'false', 'f', 'no', 'n', 'off'):
value = 0
return int(bool(value))
@@ -326,8 +327,9 @@ class Config(object):
def __init__(self, config_file):
""" Initialize the config with values from a file """
self._config_file = config_file
- self._config = ConfigObj(self._config_file, encoding='utf-8')
- for key in _CONFIG_DEFINITIONS.keys():
+ self._config = ConfigParser()
+ self._config.read(self._config_file)
+ for key in list(_CONFIG_DEFINITIONS.keys()):
self.check_setting(key)
self.ENCODER_MULTICORE_COUNT = max(0, self.ENCODER_MULTICORE_COUNT)
self._upgrade()
@@ -344,7 +346,7 @@ class Config(object):
def check_section(self, section):
""" Check if INI section exists, if not create it """
- if section not in self._config:
+ if not self._config.has_section(section):
self._config[section] = {}
return True
else:
@@ -354,28 +356,38 @@ class Config(object):
""" Cast any value in the config to the right type or use the default """
key, definition_type, section, ini_key, default = self._define(key)
self.check_section(section)
+
+ # ConfigParser values are strings, so need to convert to actual list
+ if definition_type == list:
+ definition_type = ast.literal_eval
+
try:
my_val = definition_type(self._config[section][ini_key])
+ # ConfigParser interprets empty strings in the config
+ # literally, so we need to sanitize it. It's not really
+ # a config upgrade, since a user can at any time put
+ # some_key = ''
+ if my_val == '""' or my_val == "''":
+ my_val = ''
except Exception:
- my_val = definition_type(default)
- self._config[section][ini_key] = my_val
+ my_val = default
+ self._config[section][ini_key] = str(my_val)
return my_val
def write(self):
""" Make a copy of the stored config and write it to the configured file """
- new_config = ConfigObj(encoding="UTF-8")
- new_config.filename = self._config_file
+ new_config = ConfigParser()
# first copy over everything from the old config, even if it is not
# correctly defined to keep from losing data
- for key, subkeys in self._config.items():
+ for key, subkeys in list(self._config.items()):
if key not in new_config:
new_config[key] = {}
- for subkey, value in subkeys.items():
+ for subkey, value in list(subkeys.items()):
new_config[key][subkey] = value
# next make sure that everything we expect to have defined is so
- for key in _CONFIG_DEFINITIONS.keys():
+ for key in list(_CONFIG_DEFINITIONS.keys()):
key, definition_type, section, ini_key, default = self._define(key)
self.check_setting(key)
if section not in new_config:
@@ -386,14 +398,15 @@ class Config(object):
headphones.logger.info("Writing configuration to file")
try:
- new_config.write()
+ with open(self._config_file, 'w') as configfile:
+ new_config.write(configfile)
except IOError as e:
headphones.logger.error("Error writing configuration file: %s", e)
def get_extra_newznabs(self):
""" Return the extra newznab tuples """
extra_newznabs = list(
- itertools.izip(*[itertools.islice(self.EXTRA_NEWZNABS, i, None, 3)
+ zip(*[itertools.islice(self.EXTRA_NEWZNABS, i, None, 3)
for i in range(3)])
)
return extra_newznabs
@@ -412,7 +425,7 @@ class Config(object):
def get_extra_torznabs(self):
""" Return the extra torznab tuples """
extra_torznabs = list(
- itertools.izip(*[itertools.islice(self.EXTRA_TORZNABS, i, None, 4)
+ zip(*[itertools.islice(self.EXTRA_TORZNABS, i, None, 4)
for i in range(4)])
)
return extra_torznabs
@@ -448,20 +461,21 @@ class Config(object):
return value
else:
key, definition_type, section, ini_key, default = self._define(name)
- self._config[section][ini_key] = definition_type(value)
+ self._config[section][ini_key] = str(value)
return self._config[section][ini_key]
def process_kwargs(self, kwargs):
"""
Given a big bunch of key value pairs, apply them to the ini.
"""
- for name, value in kwargs.items():
+ for name, value in list(kwargs.items()):
key, definition_type, section, ini_key, default = self._define(name)
- self._config[section][ini_key] = definition_type(value)
+ self._config[section][ini_key] = str(value)
def _upgrade(self):
"""
- Bring old configs up to date
+ Bring old configs up to date. Although this is kind of a dumb
+ way to do it because it doesn't handle multi-step upgrades
"""
if self.CONFIG_VERSION == '2':
# Update the config to use direct path to the encoder rather than the encoder folder
@@ -488,12 +502,12 @@ class Config(object):
# Add Seed Ratio to Torznabs
if self.EXTRA_TORZNABS:
extra_torznabs = list(
- itertools.izip(*[itertools.islice(self.EXTRA_TORZNABS, i, None, 3)
+ zip(*[itertools.islice(self.EXTRA_TORZNABS, i, None, 3)
for i in range(3)])
)
new_torznabs = []
for torznab in extra_torznabs:
- new_torznabs.extend([torznab[0], torznab[1], u'', torznab[2]])
+ new_torznabs.extend([torznab[0], torznab[1], '', torznab[2]])
if new_torznabs:
self.EXTRA_TORZNABS = new_torznabs
diff --git a/headphones/config_test.py b/headphones/config_test.py
index 69e71efa..69424465 100644
--- a/headphones/config_test.py
+++ b/headphones/config_test.py
@@ -2,8 +2,8 @@ import mock
from mock import MagicMock
import headphones.config
import re
-import unittestcompat
-from unittestcompat import TestCase, TestArgs
+from . import unittestcompat
+from .unittestcompat import TestCase, TestArgs
class ConfigApiTest(TestCase):
@@ -101,7 +101,7 @@ class ConfigApiTest(TestCase):
# call methods
c = headphones.config.Config(path)
# assertions:
- with self.assertRaisesRegexp(KeyError, exc_regex):
+ with self.assertRaisesRegex(KeyError, exc_regex):
c.check_setting(setting_name)
pass
diff --git a/headphones/crier.py b/headphones/crier.py
index 2399f6a9..d0bd54cf 100644
--- a/headphones/crier.py
+++ b/headphones/crier.py
@@ -21,7 +21,7 @@ def cry():
main_thread = t
# Loop over each thread's current frame, writing info about it
- for tid, frame in sys._current_frames().iteritems():
+ for tid, frame in sys._current_frames().items():
thread = tmap.get(tid, main_thread)
lines = []
diff --git a/headphones/cuesplit.py b/headphones/cuesplit.py
index 6d7ae7a0..271d3049 100755
--- a/headphones/cuesplit.py
+++ b/headphones/cuesplit.py
@@ -87,7 +87,7 @@ def check_splitter(command):
def split_baby(split_file, split_cmd):
'''Let's split baby'''
- logger.info('Splitting %s...', split_file.decode(headphones.SYS_ENCODING, 'replace'))
+ logger.info(f"Splitting {split_file}...")
logger.debug(subprocess.list2cmdline(split_cmd))
# Prevent Windows from opening a terminal window
@@ -108,16 +108,16 @@ def split_baby(split_file, split_cmd):
process = subprocess.Popen(split_cmd, startupinfo=startupinfo,
stdin=open(os.devnull, 'rb'), stdout=subprocess.PIPE,
- stderr=subprocess.PIPE, env=env)
+ stderr=subprocess.PIPE, env=env, text=True)
stdout, stderr = process.communicate()
if process.returncode:
- logger.error('Split failed for %s', split_file.decode(headphones.SYS_ENCODING, 'replace'))
- out = stdout if stdout else stderr
- logger.error('Error details: %s', out.decode(headphones.SYS_ENCODING, 'replace'))
+ logger.error(f"Split failed for {split_file}")
+ out = stdout or stderr
+ logger.error(f"Error details: {out}")
return False
else:
- logger.info('Split success %s', split_file.decode(headphones.SYS_ENCODING, 'replace'))
+ logger.info(f"Split succeeded for {split_file}")
return True
@@ -232,7 +232,7 @@ class Directory:
for i in list_dir:
if not check_match(i):
# music file
- if os.path.splitext(i)[-1] in WAVE_FILE_TYPE_BY_EXTENSION.keys():
+ if os.path.splitext(i)[-1] in list(WAVE_FILE_TYPE_BY_EXTENSION.keys()):
track_nr = identify_track_number(i)
if track_nr:
self.content.append(WaveFile(self.path + os.sep + i, track_nr=track_nr))
@@ -378,7 +378,7 @@ class CueFile(File):
except:
raise ValueError('Cant encode CUE Sheet.')
- if self.content[0] == u'\ufeff':
+ if self.content[0] == '\ufeff':
self.content = self.content[1:]
header = header_parser()
@@ -581,7 +581,7 @@ def split(albumpath):
# use xld profile to split cue
if headphones.CONFIG.ENCODER == 'xld' and headphones.CONFIG.MUSIC_ENCODER and headphones.CONFIG.XLDPROFILE:
- import getXldProfile
+ from . import getXldProfile
xldprofile, xldformat, _ = getXldProfile.getXldProfile(headphones.CONFIG.XLDPROFILE)
if not xldformat:
raise ValueError(
@@ -601,7 +601,7 @@ def split(albumpath):
raise ValueError('Command not found, ensure shntool or xld installed')
# Determine if file can be split
- if wave.name_ext not in WAVE_FILE_TYPE_BY_EXTENSION.keys():
+ if wave.name_ext not in list(WAVE_FILE_TYPE_BY_EXTENSION.keys()):
raise ValueError('Cannot split, audio file has unsupported extension')
# Split with xld
diff --git a/headphones/db.py b/headphones/db.py
index 35b447d6..e0b36afe 100644
--- a/headphones/db.py
+++ b/headphones/db.py
@@ -17,7 +17,7 @@
# Stolen from Sick-Beard's db.py #
###################################
-from __future__ import with_statement
+
import time
@@ -116,7 +116,7 @@ class DBConnection:
break
- except sqlite3.OperationalError, e:
+ except sqlite3.OperationalError as e:
if "unable to open database file" in e.message or "database is locked" in e.message:
dberror = e
if args is None:
@@ -128,7 +128,7 @@ class DBConnection:
else:
logger.error('Database error: %s', e)
raise
- except sqlite3.DatabaseError, e:
+ except sqlite3.DatabaseError as e:
logger.error('Fatal Error executing %s :: %s', query, e)
raise
@@ -156,14 +156,14 @@ class DBConnection:
If the table is not updated then the 'WHERE changes' will be 0 and the table inserted
"""
def genParams(myDict):
- return [x + " = ?" for x in myDict.keys()]
+ return [x + " = ?" for x in list(myDict.keys())]
update_query = "UPDATE " + tableName + " SET " + ", ".join(genParams(valueDict)) + " WHERE " + " AND ".join(genParams(keyDict))
- insert_query = ("INSERT INTO " + tableName + " (" + ", ".join(valueDict.keys() + keyDict.keys()) + ")" + " SELECT " + ", ".join(
- ["?"] * len(valueDict.keys() + keyDict.keys())) + " WHERE changes()=0")
+ insert_query = ("INSERT INTO " + tableName + " (" + ", ".join(list(valueDict.keys()) + list(keyDict.keys())) + ")" + " SELECT " + ", ".join(
+ ["?"] * len(list(valueDict.keys()) + list(keyDict.keys()))) + " WHERE changes()=0")
try:
- self.action(update_query, valueDict.values() + keyDict.values(), upsert_insert_qry=insert_query)
+ self.action(update_query, list(valueDict.values()) + list(keyDict.values()), upsert_insert_qry=insert_query)
except sqlite3.IntegrityError:
logger.info('Queries failed: %s and %s', update_query, insert_query)
diff --git a/headphones/deluge.py b/headphones/deluge.py
index 6b0a13f6..e0e6b1f4 100644
--- a/headphones/deluge.py
+++ b/headphones/deluge.py
@@ -34,7 +34,7 @@
# You should have received a copy of the GNU General Public License
# along with SickRage. If not, see
.
-from __future__ import unicode_literals
+
from headphones import logger
diff --git a/headphones/getXldProfile.py b/headphones/getXldProfile.py
index 6fd1ce2e..c368d3f7 100755
--- a/headphones/getXldProfile.py
+++ b/headphones/getXldProfile.py
@@ -15,7 +15,7 @@ def getXldProfile(xldProfile):
# Get xld preferences plist
try:
preferences = biplist.readPlist(expanded)
- except (biplist.InvalidPlistException, biplist.NotBinaryPlistException), e:
+ except (biplist.InvalidPlistException, biplist.NotBinaryPlistException) as e:
logger.error("Error reading xld preferences plist: %s", e)
return (xldProfileNotFound, None, None)
diff --git a/headphones/helpers.py b/headphones/helpers.py
index 07044a8c..b70ad08d 100644
--- a/headphones/helpers.py
+++ b/headphones/helpers.py
@@ -28,9 +28,10 @@ import six
from contextlib import contextmanager
import fnmatch
+import functools
import re
import os
-from beets.mediafile import MediaFile, FileTypeError, UnreadableFileError
+from mediafile import MediaFile, FileTypeError, UnreadableFileError
import headphones
@@ -40,6 +41,17 @@ RE_FEATURING = re.compile(r"[fF]t\.|[fF]eaturing|[fF]eat\.|\b[wW]ith\b|&|vs\.")
RE_CD_ALBUM = re.compile(r"\(?((CD|disc)\s*[0-9]+)\)?", re.I)
RE_CD = re.compile(r"^(CD|dics)\s*[0-9]+$", re.I)
+def cmp(x, y):
+ """
+ Replacement for built-in function cmp that was removed in Python 3
+
+ Compare the two objects x and y and return an integer according to
+ the outcome. The return value is negative if x < y, zero if x == y
+ and strictly positive if x > y.
+
+ https://portingguide.readthedocs.io/en/latest/comparisons.html#the-cmp-function
+ """
+ return (x > y) - (x < y)
def multikeysort(items, columns):
comparers = [
@@ -54,7 +66,7 @@ def multikeysort(items, columns):
else:
return 0
- return sorted(items, cmp=comparer)
+ return sorted(items, key=functools.cmp_to_key(comparer))
def checked(variable):
@@ -210,7 +222,7 @@ def pattern_substitute(pattern, dic, normalize=False):
if normalize:
new_dic = {}
- for i, j in dic.iteritems():
+ for i, j in dic.items():
if j is not None:
try:
if sys.platform == 'darwin':
@@ -229,7 +241,7 @@ def replace_all(text, dic):
if not text:
return ''
- for i, j in dic.iteritems():
+ for i, j in dic.items():
text = text.replace(i, j)
return text
@@ -242,8 +254,8 @@ def replace_illegal_chars(string, type="file"):
return string
-_CN_RE1 = re.compile(ur'[^\w]+', re.UNICODE)
-_CN_RE2 = re.compile(ur'[\s_]+', re.UNICODE)
+_CN_RE1 = re.compile(r'[^\w]+', re.UNICODE)
+_CN_RE2 = re.compile(r'[\s_]+', re.UNICODE)
_XLATE_GRAPHICAL_AND_DIACRITICAL = {
@@ -253,33 +265,33 @@ _XLATE_GRAPHICAL_AND_DIACRITICAL = {
# ©ª«®²³¹»¼½¾ÆÐØÞßæðøþĐđĦħıIJijĸĿŀŁłŒœŦŧDŽDždžLJLjljNJNjnjǤǥDZDzdzȤȥ. This
# includes also some graphical symbols which can be easily replaced and
# usually are written by people who don't have appropriate keyboard layout.
- u'©': '(C)', u'ª': 'a.', u'«': '<<', u'®': '(R)', u'²': '2', u'³': '3',
- u'¹': '1', u'»': '>>', u'¼': ' 1/4 ', u'½': ' 1/2 ', u'¾': ' 3/4 ',
- u'Æ': 'AE', u'Ð': 'D', u'Ø': 'O', u'Þ': 'Th', u'ß': 'ss', u'æ': 'ae',
- u'ð': 'd', u'ø': 'o', u'þ': 'th', u'Đ': 'D', u'đ': 'd', u'Ħ': 'H',
- u'ħ': 'h', u'ı': 'i', u'IJ': 'IJ', u'ij': 'ij', u'ĸ': 'q', u'Ŀ': 'L',
- u'ŀ': 'l', u'Ł': 'L', u'ł': 'l', u'Œ': 'OE', u'œ': 'oe', u'Ŧ': 'T',
- u'ŧ': 't', u'DŽ': 'DZ', u'Dž': 'Dz', u'LJ': 'LJ', u'Lj': 'Lj',
- u'lj': 'lj', u'NJ': 'NJ', u'Nj': 'Nj', u'nj': 'nj',
- u'Ǥ': 'G', u'ǥ': 'g', u'DZ': 'DZ', u'Dz': 'Dz', u'dz': 'dz',
- u'Ȥ': 'Z', u'ȥ': 'z', u'№': 'No.',
- u'º': 'o.', # normalize Nº abbrev (popular w/ classical music),
+ '©': '(C)', 'ª': 'a.', '«': '<<', '®': '(R)', '²': '2', '³': '3',
+ '¹': '1', '»': '>>', '¼': ' 1/4 ', '½': ' 1/2 ', '¾': ' 3/4 ',
+ 'Æ': 'AE', 'Ð': 'D', 'Ø': 'O', 'Þ': 'Th', 'ß': 'ss', 'æ': 'ae',
+ 'ð': 'd', 'ø': 'o', 'þ': 'th', 'Đ': 'D', 'đ': 'd', 'Ħ': 'H',
+ 'ħ': 'h', 'ı': 'i', 'IJ': 'IJ', 'ij': 'ij', 'ĸ': 'q', 'Ŀ': 'L',
+ 'ŀ': 'l', 'Ł': 'L', 'ł': 'l', 'Œ': 'OE', 'œ': 'oe', 'Ŧ': 'T',
+ 'ŧ': 't', 'DŽ': 'DZ', 'Dž': 'Dz', 'LJ': 'LJ', 'Lj': 'Lj',
+ 'lj': 'lj', 'NJ': 'NJ', 'Nj': 'Nj', 'nj': 'nj',
+ 'Ǥ': 'G', 'ǥ': 'g', 'DZ': 'DZ', 'Dz': 'Dz', 'dz': 'dz',
+ 'Ȥ': 'Z', 'ȥ': 'z', '№': 'No.',
+ 'º': 'o.', # normalize Nº abbrev (popular w/ classical music),
# this is 'masculine ordering indicator', not degree
}
_XLATE_SPECIAL = {
# Translation table.
# Cover additional special characters processing normalization.
- u"'": '', # replace apostrophe with nothing
- u"’": '', # replace musicbrainz style apostrophe with nothing
- u'&': ' and ', # expand & to ' and '
+ "'": '', # replace apostrophe with nothing
+ "’": '', # replace musicbrainz style apostrophe with nothing
+ '&': ' and ', # expand & to ' and '
}
_XLATE_MUSICBRAINZ = {
# Translation table for Musicbrainz.
- u"…": '...', # HORIZONTAL ELLIPSIS (U+2026)
- u"’": "'", # APOSTROPHE (U+0027)
- u"‐": "-", # EN DASH (U+2013)
+ "…": '...', # HORIZONTAL ELLIPSIS (U+2026)
+ "’": "'", # APOSTROPHE (U+0027)
+ "‐": "-", # EN DASH (U+2013)
}
@@ -314,10 +326,10 @@ def _transliterate(u, xlate):
Perform transliteration using the specified dictionary
"""
u = unicodedata.normalize('NFD', u)
- u = u''.join([u'' if _is_unicode_combining(x) else x for x in u])
+ u = ''.join(['' if _is_unicode_combining(x) else x for x in u])
u = _translate(u, xlate)
# at this point output is either unicode, or plain ascii
- return unicode(u)
+ return str(u)
def clean_name(s):
@@ -327,10 +339,10 @@ def clean_name(s):
:param s: string to clean up, possibly unicode one.
:return: cleaned-up version of input string.
"""
- if not isinstance(s, unicode):
+ if not isinstance(s, str):
# ignore extended chars if someone was dumb enough to pass non-ascii
# narrow string here, use only unicode for meaningful texts
- u = unicode(s, 'ascii', 'replace')
+ u = str(s, 'ascii', 'replace')
else:
u = s
# 1. don't bother doing normalization NFKC, rather transliterate
@@ -341,9 +353,9 @@ def clean_name(s):
# 3. translate spacials
u = _translate(u, _XLATE_SPECIAL)
# 4. replace any non-alphanumeric character sequences by spaces
- u = _CN_RE1.sub(u' ', u)
+ u = _CN_RE1.sub(' ', u)
# 5. coalesce interleaved space/underscore sequences
- u = _CN_RE2.sub(u' ', u)
+ u = _CN_RE2.sub(' ', u)
# 6. trim
u = u.strip()
# 7. lowercase
@@ -357,8 +369,8 @@ def clean_musicbrainz_name(s, return_as_string=True):
:param s: string to clean up, probably unicode.
:return: cleaned-up version of input string.
"""
- if not isinstance(s, unicode):
- u = unicode(s, 'ascii', 'replace')
+ if not isinstance(s, str):
+ u = str(s, 'ascii', 'replace')
else:
u = s
u = _translate(u, _XLATE_MUSICBRAINZ)
@@ -452,8 +464,7 @@ def expand_subfolders(f):
if difference > 0:
logger.info(
- "Found %d media folders, but depth difference between lowest and deepest media folder is %d (expected zero). If this is a discography or a collection of albums, make sure albums are per folder.",
- len(media_folders), difference)
+ f"Found {len(media_folders)} media folders, but depth difference between lowest and deepest media folder is {difference} (expected zero). If this is a discography or a collection of albums, make sure albums are per folder.")
# While already failed, advice the user what he could try. We assume the
# directory may contain separate CD's and maybe some extra's. The
@@ -465,8 +476,7 @@ def expand_subfolders(f):
set([os.path.join(*media_folder) for media_folder in extra_media_folders]))
logger.info(
- "Please look at the following folder(s), since they cause the depth difference: %s",
- extra_media_folders)
+ f"Please look at the following folder(s), since they cause the depth difference: {extra_media_folders}")
return
# Convert back to paths and remove duplicates, which may be there after
@@ -480,7 +490,7 @@ def expand_subfolders(f):
logger.debug("Did not expand subfolder, as it resulted in one folder.")
return
- logger.debug("Expanded subfolders in folder: %s", media_folders)
+ logger.debug(f"Expanded subfolders in folder: {media_folders}")
return media_folders
@@ -498,7 +508,7 @@ def path_match_patterns(path, patterns):
return False
-def path_filter_patterns(paths, patterns, root=None):
+def path_filter_patterns(paths, patterns, root=''):
"""
Scan for ignored paths based on glob patterns. Note that the whole path
will be matched, therefore paths should only contain the relative paths.
@@ -512,8 +522,7 @@ def path_filter_patterns(paths, patterns, root=None):
for path in paths[:]:
if path_match_patterns(path, patterns):
- logger.debug("Path ignored by pattern: %s",
- os.path.join(root or "", path))
+ logger.debug(f"Path ignored by pattern: {os.path.join(root, path)}")
ignored += 1
paths.remove(path)
@@ -595,7 +604,7 @@ def extract_metadata(f):
count_ratio = 0.75
if count < (count_ratio * len(results)):
- logger.info("Counted %d media files, but only %d have tags, ignoring.", count, len(results))
+ logger.info(f"Counted {count} media files, but only {len(results)} have tags, ignoring.")
return (None, None, None)
# Count distinct values
@@ -613,8 +622,7 @@ def extract_metadata(f):
old_album = new_albums[index]
new_albums[index] = RE_CD_ALBUM.sub("", album).strip()
- logger.debug("Stripped albumd number identifier: %s -> %s", old_album,
- new_albums[index])
+ logger.debug(f"Stripped album number identifier: {old_album} -> {new_albums[index]}")
# Remove duplicates
new_albums = list(set(new_albums))
@@ -632,7 +640,7 @@ def extract_metadata(f):
if len(artists) > 1 and len(albums) == 1:
split_artists = [RE_FEATURING.split(x) for x in artists]
featurings = [len(split_artist) - 1 for split_artist in split_artists]
- logger.info("Album seem to feature %d different artists", sum(featurings))
+ logger.info("Album seem to feature {sum(featurings)} different artists")
if sum(featurings) > 0:
# Find the artist of which the least splits have been generated.
@@ -644,9 +652,11 @@ def extract_metadata(f):
return (artist, albums[0], years[0])
# Not sure what to do here.
- logger.info("Found %d artists, %d albums and %d years in metadata, so ignoring", len(artists),
- len(albums), len(years))
- logger.debug("Artists: %s, Albums: %s, Years: %s", artists, albums, years)
+ logger.info(
+ f"Found {len(artists)} artists, {len(albums)} albums and "
+ f"{len(years)} years in metadata, so ignoring"
+ )
+ logger.debug("Artists: {artists}, Albums: {albums}, Years: {years}")
return (None, None, None)
@@ -678,8 +688,7 @@ def preserve_torrent_directory(albumpath, forced=False, single=False):
else:
tempdir = tempfile.gettempdir()
- logger.info("Preparing to copy to a temporary directory for post processing: " + albumpath.decode(
- headphones.SYS_ENCODING, 'replace'))
+ logger.info(f"Preparing to copy to a temporary directory for post processing: {albumpath}")
try:
file_name = os.path.basename(os.path.normpath(albumpath))
@@ -689,8 +698,7 @@ def preserve_torrent_directory(albumpath, forced=False, single=False):
prefix = "headphones_" + os.path.splitext(file_name)[0] + "_@hp@_"
new_folder = tempfile.mkdtemp(prefix=prefix, dir=tempdir)
except Exception as e:
- logger.error("Cannot create temp directory: " + tempdir.decode(
- headphones.SYS_ENCODING, 'replace') + ". Error: " + str(e))
+ logger.error(f"Cannot create temp directory: {tempdir}. Error: {e}")
return None
# Attempt to stop multiple temp dirs being created for the same albumpath
@@ -701,17 +709,21 @@ def preserve_torrent_directory(albumpath, forced=False, single=False):
workdir = re.sub(r'(?= 3:
logger.error(
- "Looks like a temp directory has previously been created for this albumpath, not continuing " + workdir.decode(
- headphones.SYS_ENCODING, 'replace'))
+ "Looks like a temp directory has previously been created "
+ "for this albumpath, not continuing "
+ )
shutil.rmtree(new_folder)
return None
except Exception as e:
- logger.warn("Cannot determine if already copied/processed, will copy anyway: Warning: " + str(e))
+ logger.warn(
+ "Cannot determine if already copied/processed, will copy anyway. "
+ f"Warning: {e}"
+ )
# Copy to temp dir
try:
subdir = os.path.join(new_folder, "headphones")
- logger.info("Copying files to " + subdir.decode(headphones.SYS_ENCODING, 'replace'))
+ logger.info(f"Copying files to {subdir}")
if not single:
shutil.copytree(albumpath, subdir)
else:
@@ -720,9 +732,10 @@ def preserve_torrent_directory(albumpath, forced=False, single=False):
# Update the album path with the new location
return subdir
except Exception as e:
- logger.warn("Cannot copy/move files to temp directory: " + new_folder.decode(headphones.SYS_ENCODING,
- 'replace') + ". Not continuing. Error: " + str(
- e))
+ logger.warn(
+ f"Cannot copy/move files to temp directory: {new_folder}. "
+ f"Not continuing. Error: {e}"
+ )
shutil.rmtree(new_folder)
return None
@@ -767,7 +780,7 @@ def cue_split(albumpath, keep_original_folder=False):
cuesplit.split(cue_dir)
except Exception as e:
os.chdir(cwd)
- logger.warn("Cue not split: " + str(e))
+ logger.warn(f"Cue not split. Error: {e}")
return None
os.chdir(cwd)
@@ -805,7 +818,7 @@ def extract_song_data(s):
year = match.group("year")
return (name, album, year)
else:
- logger.info("Couldn't parse %s into a valid default format", s)
+ logger.info(f"Couldn't parse {s} into a valid default format")
# newzbin default format
pattern = re.compile(r'(?P
.*?)\s\-\s(?P.*?)\s\((?P\d+?\))', re.VERBOSE)
@@ -816,7 +829,7 @@ def extract_song_data(s):
year = match.group("year")
return (name, album, year)
else:
- logger.info("Couldn't parse %s into a valid Newbin format", s)
+ logger.info(f"Couldn't parse {s} into a valid Newbin format")
return (name, album, year)
@@ -829,7 +842,7 @@ def smartMove(src, dest, delete=True):
dest_path = os.path.join(dest, filename)
if os.path.isfile(dest_path):
- logger.info('Destination file exists: %s', dest_path)
+ logger.info(f"Destination file exists: {dest_path}")
title = os.path.splitext(filename)[0]
ext = os.path.splitext(filename)[1]
i = 1
@@ -838,13 +851,12 @@ def smartMove(src, dest, delete=True):
if os.path.isfile(os.path.join(dest, newfile)):
i += 1
else:
- logger.info('Renaming to %s', newfile)
+ logger.info(f"Renaming to {newfile}")
try:
os.rename(src, os.path.join(source_dir, newfile))
filename = newfile
except Exception as e:
- logger.warn('Error renaming %s: %s',
- src.decode(headphones.SYS_ENCODING, 'replace'), e)
+ logger.warn(f"Error renaming {src}: {e}")
break
if delete:
@@ -854,8 +866,9 @@ def smartMove(src, dest, delete=True):
except Exception as e:
exists = os.path.exists(dest_path)
if exists and os.path.getsize(source_path) == os.path.getsize(dest_path):
- logger.warn('Successfully moved file "%s", but something went wrong: %s',
- filename.decode(headphones.SYS_ENCODING, 'replace'), e)
+ logger.warn(
+ f"Successfully moved {filename}, but something went wrong: {e}"
+ )
os.unlink(source_path)
else:
# remove faultly copied file
@@ -864,12 +877,11 @@ def smartMove(src, dest, delete=True):
raise
else:
try:
- logger.info('Copying "%s" to "%s"', source_path, dest_path)
+ logger.info(f"Copying {source_path} to {dest_path}")
shutil.copy(source_path, dest_path)
return True
except Exception as e:
- logger.warn('Error copying file %s: %s', filename.decode(headphones.SYS_ENCODING, 'replace'),
- e)
+ logger.warn(f"Error copying {filename}: {e}")
def walk_directory(basedir, followlinks=True):
@@ -878,7 +890,7 @@ def walk_directory(basedir, followlinks=True):
with care. In case a folder is already processed, don't traverse it again.
"""
- import logger
+ from . import logger
# Add the base path, because symlinks poiting to the basedir should not be
# traversed again.
@@ -892,8 +904,10 @@ def walk_directory(basedir, followlinks=True):
real_path = os.path.abspath(os.readlink(path))
if real_path in traversed:
- logger.debug("Skipping '%s' since it is a symlink to "
- "'%s', which is already visited.", path, real_path)
+ logger.debug(
+ f"Skipping {path} since it is a symlink to "
+ f"{real_path}, which is already visited."
+ )
else:
traversed.append(real_path)
@@ -935,22 +949,13 @@ def sab_sanitize_foldername(name):
FL_ILLEGAL = CH_ILLEGAL + ':\x92"'
FL_LEGAL = CH_LEGAL + "-''"
- uFL_ILLEGAL = FL_ILLEGAL.decode('latin-1')
- uFL_LEGAL = FL_LEGAL.decode('latin-1')
-
if not name:
- return name
- if isinstance(name, unicode):
- illegal = uFL_ILLEGAL
- legal = uFL_LEGAL
- else:
- illegal = FL_ILLEGAL
- legal = FL_LEGAL
+ return
lst = []
for ch in name.strip():
- if ch in illegal:
- ch = legal[illegal.find(ch)]
+ if ch in FL_ILLEGAL:
+ ch = FL_LEGAL[FL_ILLEGAL.find(ch)]
lst.append(ch)
else:
lst.append(ch)
@@ -1006,7 +1011,7 @@ def create_https_certificates(ssl_cert, ssl_key):
with open(ssl_cert, "w") as fp:
fp.write(crypto.dump_certificate(crypto.FILETYPE_PEM, cert))
except IOError as e:
- logger.error("Error creating SSL key and certificate: %s", e)
+ logger.error(f"Error creating SSL key and certificate: e")
return False
return True
diff --git a/headphones/helpers_test.py b/headphones/helpers_test.py
index 14b8540d..3fd09aa4 100644
--- a/headphones/helpers_test.py
+++ b/headphones/helpers_test.py
@@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
-from unittestcompat import TestCase
+from .unittestcompat import TestCase
from headphones.helpers import clean_name
@@ -8,28 +8,28 @@ class HelpersTest(TestCase):
def test_clean_name(self):
"""helpers: check correctness of clean_name() function"""
cases = {
- u' Weiße & rose ': 'Weisse and rose',
- u'Multiple / spaces': 'Multiple spaces',
- u'Kevin\'s m²': 'Kevins m2',
- u'Symphonęy Nº9': 'Symphoney No.9',
- u'ÆæßðÞIJij': u'AeaessdThIJıj',
- u'Obsessió (Cerebral Apoplexy remix)': 'obsessio cerebral '
+ ' Weiße & rose ': 'Weisse and rose',
+ 'Multiple / spaces': 'Multiple spaces',
+ 'Kevin\'s m²': 'Kevins m2',
+ 'Symphonęy Nº9': 'Symphoney No.9',
+ 'ÆæßðÞIJij': 'AeaessdThIJıj',
+ 'Obsessió (Cerebral Apoplexy remix)': 'obsessio cerebral '
'apoplexy remix',
- u'Doktór Hałabała i siedmiu zbojów': 'doktor halabala i siedmiu '
+ 'Doktór Hałabała i siedmiu zbojów': 'doktor halabala i siedmiu '
'zbojow',
- u'Arbetets Söner och Döttrar': 'arbetets soner och dottrar',
- u'Björk Guðmundsdóttir': 'bjork gudmundsdottir',
- u'L\'Arc~en~Ciel': 'larc en ciel',
- u'Orquesta de la Luz (オルケスタ・デ・ラ・ルス)':
- u'Orquesta de la Luz オルケスタ デ ラ ルス'
+ 'Arbetets Söner och Döttrar': 'arbetets soner och dottrar',
+ 'Björk Guðmundsdóttir': 'bjork gudmundsdottir',
+ 'L\'Arc~en~Ciel': 'larc en ciel',
+ 'Orquesta de la Luz (オルケスタ・デ・ラ・ルス)':
+ 'Orquesta de la Luz オルケスタ デ ラ ルス'
}
- for first, second in cases.iteritems():
+ for first, second in cases.items():
nf = clean_name(first).lower()
ns = clean_name(second).lower()
self.assertEqual(
- nf, ns, u"check cleaning of case (%s,"
- u"%s)" % (nf, ns)
+ nf, ns, "check cleaning of case (%s,"
+ "%s)" % (nf, ns)
)
def test_clean_name_nonunicode(self):
diff --git a/headphones/importer.py b/headphones/importer.py
index 5595d37e..b2459787 100644
--- a/headphones/importer.py
+++ b/headphones/importer.py
@@ -16,7 +16,7 @@
import time
from headphones import logger, helpers, db, mb, lastfm, metacritic
-from beets.mediafile import MediaFile
+from mediafile import MediaFile
import headphones
blacklisted_special_artist_names = ['[anonymous]', '[data]', '[no artist]',
@@ -39,7 +39,7 @@ def is_exists(artistid):
if any(artistid in x for x in artistlist):
logger.info(artistlist[0][
- 1] + u" is already in the database. Updating 'have tracks', but not artist information")
+ 1] + " is already in the database. Updating 'have tracks', but not artist information")
return True
else:
return False
@@ -53,7 +53,7 @@ def artistlist_to_mbids(artistlist, forced=False):
# If adding artists through Manage New Artists, they're coming through as non-unicode (utf-8?)
# and screwing everything up
- if not isinstance(artist, unicode):
+ if not isinstance(artist, str):
try:
artist = artist.decode('utf-8', 'replace')
except Exception:
@@ -184,7 +184,7 @@ def addArtisttoDB(artistid, extrasonly=False, forcefull=False, type="artist"):
else:
sortname = artist['artist_name']
- logger.info(u"Now adding/updating: " + artist['artist_name'])
+ logger.info("Now adding/updating: " + artist['artist_name'])
controlValueDict = {"ArtistID": artistid}
newValueDict = {"ArtistName": artist['artist_name'],
"ArtistSortName": sortname,
@@ -263,8 +263,8 @@ def addArtisttoDB(artistid, extrasonly=False, forcefull=False, type="artist"):
new_releases = mb.get_new_releases(rgid, includeExtras)
else:
- if check_release_date is None or check_release_date == u"None":
- if headphones.CONFIG.MB_IGNORE_AGE_MISSING is not 1:
+ if check_release_date is None or check_release_date == "None":
+ if not headphones.CONFIG.MB_IGNORE_AGE_MISSING:
logger.info("[%s] Now updating: %s (No Release Date)" % (artist['artist_name'], rg['title']))
new_releases = mb.get_new_releases(rgid, includeExtras, True)
else:
@@ -517,7 +517,7 @@ def addArtisttoDB(artistid, extrasonly=False, forcefull=False, type="artist"):
marked_as_downloaded = True
logger.info(
- u"[%s] Seeing if we need album art for %s" % (artist['artist_name'], rg['title']))
+ "[%s] Seeing if we need album art for %s" % (artist['artist_name'], rg['title']))
try:
cache.getThumb(AlbumID=rg['id'])
except Exception as e:
@@ -530,19 +530,19 @@ def addArtisttoDB(artistid, extrasonly=False, forcefull=False, type="artist"):
album_searches.append(rg['id'])
else:
if skip_log == 0:
- logger.info(u"[%s] No new releases, so no changes made to %s" % (
+ logger.info("[%s] No new releases, so no changes made to %s" % (
artist['artist_name'], rg['title']))
time.sleep(3)
finalize_update(artistid, artist['artist_name'], errors)
- logger.info(u"Seeing if we need album art for: %s" % artist['artist_name'])
+ logger.info("Seeing if we need album art for: %s" % artist['artist_name'])
try:
cache.getThumb(ArtistID=artistid)
except Exception as e:
logger.error("Error getting album art: %s", e)
- logger.info(u"Fetching Metacritic reviews for: %s" % artist['artist_name'])
+ logger.info("Fetching Metacritic reviews for: %s" % artist['artist_name'])
try:
metacritic.update(artistid, artist['artist_name'], artist['releasegroups'])
except Exception as e:
@@ -554,7 +554,7 @@ def addArtisttoDB(artistid, extrasonly=False, forcefull=False, type="artist"):
artist['artist_name'], artist['artist_name']))
else:
myDB.action('DELETE FROM newartists WHERE ArtistName = ?', [artist['artist_name']])
- logger.info(u"Updating complete for: %s" % artist['artist_name'])
+ logger.info("Updating complete for: %s" % artist['artist_name'])
# Start searching for newly added albums
if album_searches:
@@ -663,7 +663,7 @@ def addReleaseById(rid, rgid=None):
sortname = release_dict['artist_name']
logger.info(
- u"Now manually adding: " + release_dict['artist_name'] + " - with status Paused")
+ "Now manually adding: " + release_dict['artist_name'] + " - with status Paused")
controlValueDict = {"ArtistID": release_dict['artist_id']}
newValueDict = {"ArtistName": release_dict['artist_name'],
"ArtistSortName": sortname,
@@ -696,7 +696,7 @@ def addReleaseById(rid, rgid=None):
if not rg_exists and release_dict or status == 'Loading' and release_dict: # it should never be the case that we have an rg and not the artist
# but if it is this will fail
- logger.info(u"Now adding-by-id album (" + release_dict['title'] + ") from id: " + rgid)
+ logger.info("Now adding-by-id album (" + release_dict['title'] + ") from id: " + rgid)
controlValueDict = {"AlbumID": rgid}
if status != 'Loading':
status = 'Wanted'
@@ -772,7 +772,7 @@ def addReleaseById(rid, rgid=None):
# Start a search for the album
if headphones.CONFIG.AUTOWANT_MANUALLY_ADDED:
- import searcher
+ from . import searcher
searcher.searchforalbum(rgid, False)
elif not rg_exists and not release_dict:
diff --git a/headphones/lastfm.py b/headphones/lastfm.py
index db3e1aec..5b23e447 100644
--- a/headphones/lastfm.py
+++ b/headphones/lastfm.py
@@ -91,7 +91,7 @@ def getSimilar():
for artist, mbid in artistlist:
count[artist, mbid] += 1
- items = count.items()
+ items = list(count.items())
top_list = sorted(items, key=lambda x: x[1], reverse=True)[:25]
random.shuffle(top_list)
diff --git a/headphones/librarysync.py b/headphones/librarysync.py
index dbf9fb4b..13619d37 100644
--- a/headphones/librarysync.py
+++ b/headphones/librarysync.py
@@ -17,7 +17,7 @@ import os
import math
import headphones
-from beets.mediafile import MediaFile, FileTypeError, UnreadableFileError
+from mediafile import MediaFile, FileTypeError, UnreadableFileError
from headphones import db, logger, helpers, importer, lastfm
@@ -30,72 +30,64 @@ def libraryScan(dir=None, append=False, ArtistID=None, ArtistName=None,
if not dir:
if not headphones.CONFIG.MUSIC_DIR:
+ logger.info(
+ "No music directory configured. Add it under "
+ "Manage -> Scan Music Library"
+ )
return
else:
dir = headphones.CONFIG.MUSIC_DIR
- # If we're appending a dir, it's coming from the post processor which is
- # already bytestring
- if not append or artistScan:
- dir = dir.encode(headphones.SYS_ENCODING)
-
if not os.path.isdir(dir):
- logger.warn('Cannot find directory: %s. Not scanning' % dir.decode(headphones.SYS_ENCODING,
- 'replace'))
+ logger.warn(f"Cannot find music directory: {dir}")
return
myDB = db.DBConnection()
new_artists = []
- logger.info('Scanning music directory: %s' % dir.decode(headphones.SYS_ENCODING, 'replace'))
+ logger.info(f"Scanning music directory: {dir}")
if not append:
# Clean up bad filepaths. Queries can take some time, ensure all results are loaded before processing
if ArtistID:
- tracks = myDB.action(
+ dbtracks = myDB.action(
'SELECT Location FROM alltracks WHERE ArtistID = ? AND Location IS NOT NULL UNION SELECT Location FROM tracks WHERE ArtistID = ? AND Location '
'IS NOT NULL',
[ArtistID, ArtistID])
else:
- tracks = myDB.action(
+ dbtracks = myDB.action(
'SELECT Location FROM alltracks WHERE Location IS NOT NULL UNION SELECT Location FROM tracks WHERE Location IS NOT NULL')
- locations = []
- for track in tracks:
- locations.append(track['Location'])
- for location in locations:
- encoded_track_string = location.encode(headphones.SYS_ENCODING, 'replace')
- if not os.path.isfile(encoded_track_string):
+ for track in dbtracks:
+ track_location = track['Location']
+ if not os.path.isfile(track_location):
myDB.action('UPDATE tracks SET Location=?, BitRate=?, Format=? WHERE Location=?',
- [None, None, None, location])
+ [None, None, None, track_location])
myDB.action('UPDATE alltracks SET Location=?, BitRate=?, Format=? WHERE Location=?',
- [None, None, None, location])
+ [None, None, None, track_location])
if ArtistName:
del_have_tracks = myDB.select('SELECT Location, Matched, ArtistName FROM have WHERE ArtistName = ? COLLATE NOCASE', [ArtistName])
else:
del_have_tracks = myDB.select('SELECT Location, Matched, ArtistName FROM have')
- locations = []
for track in del_have_tracks:
- locations.append([track['Location'], track['ArtistName']])
- for location in locations:
- encoded_track_string = location[0].encode(headphones.SYS_ENCODING, 'replace')
- if not os.path.isfile(encoded_track_string):
- if location[1]:
+ if not os.path.isfile(track['Location']):
+ if track['ArtistName']:
# Make sure deleted files get accounted for when updating artist track counts
- new_artists.append(location[1])
- myDB.action('DELETE FROM have WHERE Location=?', [location[0]])
+ new_artists.append(track['ArtistName'])
+ myDB.action('DELETE FROM have WHERE Location=?', [Track['Location']])
logger.info(
- 'File %s removed from Headphones, as it is no longer on disk' % encoded_track_string.decode(
- headphones.SYS_ENCODING, 'replace'))
+ f"{Track['Location']} removed from Headphones, as it "
+ f"is no longer on disk"
+ )
bitrates = []
- song_list = []
+ track_list = []
latest_subdirectory = []
- new_song_count = 0
+ new_track_count = 0
file_count = 0
for r, d, f in helpers.walk_directory(dir):
@@ -110,32 +102,16 @@ def libraryScan(dir=None, append=False, ArtistID=None, ArtistName=None,
subdirectory = r.replace(dir, '')
latest_subdirectory.append(subdirectory)
- if file_count == 0 and r.replace(dir, '') != '':
- logger.info("[%s] Now scanning subdirectory %s" % (
- dir.decode(headphones.SYS_ENCODING, 'replace'),
- subdirectory.decode(headphones.SYS_ENCODING, 'replace')))
- elif latest_subdirectory[file_count] != latest_subdirectory[
- file_count - 1] and file_count != 0:
- logger.info("[%s] Now scanning subdirectory %s" % (
- dir.decode(headphones.SYS_ENCODING, 'replace'),
- subdirectory.decode(headphones.SYS_ENCODING, 'replace')))
-
- song = os.path.join(r, files)
-
- # We need the unicode path to use for logging, inserting into database
- unicode_song_path = song.decode(headphones.SYS_ENCODING, 'replace')
+ track_path = os.path.join(r, files)
# Try to read the metadata
try:
- f = MediaFile(song)
+ f = MediaFile(track_path)
except (FileTypeError, UnreadableFileError):
- logger.warning(
- "Cannot read media file '%s', skipping. It may be corrupted or not a media file.",
- unicode_song_path)
+ logger.warning(f"Cannot read `{track_path}`. It may be corrupted or not a media file.")
continue
except IOError:
- logger.warning("Cannnot read media file '%s', skipping. Does the file exists?",
- unicode_song_path)
+ logger.warning(f"Cannnot read `{track_path}`. Does the file exists?")
continue
# Grab the bitrates for the auto detect bit rate option
@@ -150,15 +126,15 @@ def libraryScan(dir=None, append=False, ArtistID=None, ArtistName=None,
else:
f_artist = None
- # Add the song to our song list -
- # TODO: skip adding songs without the minimum requisite information (just a matter of putting together the right if statements)
+ # Add the track to our track list -
+ # TODO: skip adding tracks without the minimum requisite information (just a matter of putting together the right if statements)
if f_artist and f.album and f.title:
CleanName = helpers.clean_name(f_artist + ' ' + f.album + ' ' + f.title)
else:
CleanName = None
- controlValueDict = {'Location': unicode_song_path}
+ controlValueDict = {'Location': track_path}
newValueDict = {'TrackID': f.mb_trackid,
# 'ReleaseID' : f.mb_albumid,
@@ -174,24 +150,24 @@ def libraryScan(dir=None, append=False, ArtistID=None, ArtistName=None,
'CleanName': CleanName
}
- # song_list.append(song_dict)
- check_exist_song = myDB.action("SELECT * FROM have WHERE Location=?",
- [unicode_song_path]).fetchone()
- # Only attempt to match songs that are new, haven't yet been matched, or metadata has changed.
- if not check_exist_song:
+ # track_list.append(track_dict)
+ check_exist_track = myDB.action("SELECT * FROM have WHERE Location=?",
+ [track_path]).fetchone()
+ # Only attempt to match tracks that are new, haven't yet been matched, or metadata has changed.
+ if not check_exist_track:
# This is a new track
if f_artist:
new_artists.append(f_artist)
myDB.upsert("have", newValueDict, controlValueDict)
- new_song_count += 1
+ new_track_count += 1
else:
- if check_exist_song['ArtistName'] != f_artist or check_exist_song[
- 'AlbumTitle'] != f.album or check_exist_song['TrackTitle'] != f.title:
+ if check_exist_track['ArtistName'] != f_artist or check_exist_track[
+ 'AlbumTitle'] != f.album or check_exist_track['TrackTitle'] != f.title:
# Important track metadata has been modified, need to run matcher again
- if f_artist and f_artist != check_exist_song['ArtistName']:
+ if f_artist and f_artist != check_exist_track['ArtistName']:
new_artists.append(f_artist)
- elif f_artist and f_artist == check_exist_song['ArtistName'] and \
- check_exist_song['Matched'] != "Ignored":
+ elif f_artist and f_artist == check_exist_track['ArtistName'] and \
+ check_exist_track['Matched'] != "Ignored":
new_artists.append(f_artist)
else:
continue
@@ -200,51 +176,59 @@ def libraryScan(dir=None, append=False, ArtistID=None, ArtistName=None,
myDB.upsert("have", newValueDict, controlValueDict)
myDB.action(
'UPDATE tracks SET Location=?, BitRate=?, Format=? WHERE Location=?',
- [None, None, None, unicode_song_path])
+ [None, None, None, track_path])
myDB.action(
'UPDATE alltracks SET Location=?, BitRate=?, Format=? WHERE Location=?',
- [None, None, None, unicode_song_path])
- new_song_count += 1
+ [None, None, None, track_path])
+ new_track_count += 1
else:
# This track information hasn't changed
- if f_artist and check_exist_song['Matched'] != "Ignored":
+ if f_artist and check_exist_track['Matched'] != "Ignored":
new_artists.append(f_artist)
file_count += 1
# Now we start track matching
- logger.info("%s new/modified songs found and added to the database" % new_song_count)
- song_list = myDB.action("SELECT * FROM have WHERE Matched IS NULL AND LOCATION LIKE ?",
- [dir.decode(headphones.SYS_ENCODING, 'replace') + "%"])
- total_number_of_songs = \
- myDB.action("SELECT COUNT(*) FROM have WHERE Matched IS NULL AND LOCATION LIKE ?",
- [dir.decode(headphones.SYS_ENCODING, 'replace') + "%"]).fetchone()[0]
- logger.info("Found " + str(total_number_of_songs) + " new/modified tracks in: '" + dir.decode(
- headphones.SYS_ENCODING, 'replace') + "'. Matching tracks to the appropriate releases....")
+ logger.info(f"{new_track_count} new/modified tracks found and added to the database")
+ dbtracks = myDB.action(
+ "SELECT * FROM have WHERE Matched IS NULL AND LOCATION LIKE ?",
+ [f"{dir}%"]
+ )
+ dbtracks_count = myDB.action(
+ "SELECT COUNT(*) FROM have WHERE Matched IS NULL AND LOCATION LIKE ?",
+ [f"{dir}%"]
+ ).fetchone()[0]
+ logger.info(f"Found {dbtracks_count} new/modified tracks in `{dir}`")
+ logger.info("Matching tracks to the appropriate releases....")
- # Sort the song_list by most vague (e.g. no trackid or releaseid) to most specific (both trackid & releaseid)
- # When we insert into the database, the tracks with the most specific information will overwrite the more general matches
- # song_list = helpers.multikeysort(song_list, ['ReleaseID', 'TrackID'])
- song_list = helpers.multikeysort(song_list, ['ArtistName', 'AlbumTitle'])
- # We'll use this to give a % completion, just because the track matching might take a while
- song_count = 0
- latest_artist = []
+ # Sort the track_list by most vague (e.g. no trackid or releaseid)
+ # to most specific (both trackid & releaseid)
+ # When we insert into the database, the tracks with the most
+ # specific information will overwrite the more general matches
+
+ sorted_dbtracks = helpers.multikeysort(dbtracks, ['ArtistName', 'AlbumTitle'])
+
+
+ # We'll use this to give a % completion, just because the
+ # track matching might take a while
+ tracks_completed = 0
+ latest_artist = None
last_completion_percentage = 0
prev_artist_name = None
artistid = None
- for song in song_list:
+ for track in sorted_dbtracks:
- latest_artist.append(song['ArtistName'])
- if song_count == 0:
- logger.info("Now matching songs by %s" % song['ArtistName'])
- elif latest_artist[song_count] != latest_artist[song_count - 1] and song_count != 0:
- logger.info("Now matching songs by %s" % song['ArtistName'])
+ if latest_artist != track['ArtistName']:
+ logger.info(f"Now matching tracks by {track['ArtistName']}")
+ latest_artist = track['ArtistName']
- song_count += 1
- completion_percentage = math.floor(float(song_count) / total_number_of_songs * 1000) / 10
+ tracks_completed += 1
+ completion_percentage = math.floor(
+ float(tracks_completed) / dbtracks_count * 1000
+ ) / 10
if completion_percentage >= (last_completion_percentage + 10):
logger.info("Track matching is " + str(completion_percentage) + "% complete")
@@ -257,9 +241,9 @@ def libraryScan(dir=None, append=False, ArtistID=None, ArtistName=None,
albumid = None
- if song['ArtistName'] and song['CleanName']:
- artist_name = song['ArtistName']
- clean_name = song['CleanName']
+ if track['ArtistName'] and track['CleanName']:
+ artist_name = track['ArtistName']
+ clean_name = track['CleanName']
# Only update if artist is in the db
if artist_name != prev_artist_name:
@@ -297,12 +281,12 @@ def libraryScan(dir=None, append=False, ArtistID=None, ArtistName=None,
# matching on CleanName should be enough, ensure it's the same artist just in case
# Update tracks
- track = myDB.action('SELECT AlbumID, ArtistName FROM tracks WHERE CleanName = ? AND ArtistID = ?', [clean_name, artistid]).fetchone()
- if track:
- albumid = track['AlbumID']
+ dbtrack = myDB.action('SELECT AlbumID, ArtistName FROM tracks WHERE CleanName = ? AND ArtistID = ?', [clean_name, artistid]).fetchone()
+ if dbtrack:
+ albumid = dbtrack['AlbumID']
myDB.action(
'UPDATE tracks SET Location = ?, BitRate = ?, Format = ? WHERE CleanName = ? AND ArtistID = ?',
- [song['Location'], song['BitRate'], song['Format'], clean_name, artistid])
+ [track['Location'], track['BitRate'], track['Format'], clean_name, artistid])
# Update alltracks
alltrack = myDB.action('SELECT AlbumID, ArtistName FROM alltracks WHERE CleanName = ? AND ArtistID = ?', [clean_name, artistid]).fetchone()
@@ -310,26 +294,25 @@ def libraryScan(dir=None, append=False, ArtistID=None, ArtistName=None,
albumid = alltrack['AlbumID']
myDB.action(
'UPDATE alltracks SET Location = ?, BitRate = ?, Format = ? WHERE CleanName = ? AND ArtistID = ?',
- [song['Location'], song['BitRate'], song['Format'], clean_name, artistid])
+ [track['Location'], track['BitRate'], track['Format'], clean_name, artistid])
# Update have
- controlValueDict2 = {'Location': song['Location']}
+ controlValueDict2 = {'Location': track['Location']}
if albumid:
newValueDict2 = {'Matched': albumid}
else:
newValueDict2 = {'Matched': "Failed"}
myDB.upsert("have", newValueDict2, controlValueDict2)
- # myDB.action('INSERT INTO have (ArtistName, AlbumTitle, TrackNumber, TrackTitle, TrackLength, BitRate, Genre, Date, TrackID, Location, CleanName, Format) VALUES( ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)', [song['ArtistName'], song['AlbumTitle'], song['TrackNumber'], song['TrackTitle'], song['TrackLength'], song['BitRate'], song['Genre'], song['Date'], song['TrackID'], song['Location'], CleanName, song['Format']])
+ # myDB.action('INSERT INTO have (ArtistName, AlbumTitle, TrackNumber, TrackTitle, TrackLength, BitRate, Genre, Date, TrackID, Location, CleanName, Format) VALUES( ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)', [track['ArtistName'], track['AlbumTitle'], track['TrackNumber'], track['TrackTitle'], track['TrackLength'], track['BitRate'], track['Genre'], track['Date'], track['TrackID'], track['Location'], CleanName, track['Format']])
- logger.info('Completed matching tracks from directory: %s' % dir.decode(headphones.SYS_ENCODING,
- 'replace'))
+ logger.info(f"Completed matching tracks from `{dir}`")
if not append or artistScan:
logger.info('Updating scanned artist track counts')
# Clean up the new artist list
- unique_artists = {}.fromkeys(new_artists).keys()
+ unique_artists = list({}.fromkeys(new_artists).keys())
# # Don't think we need to do this, check the db instead below
#
diff --git a/headphones/lock.py b/headphones/lock.py
index 8d385738..2eb28cfc 100644
--- a/headphones/lock.py
+++ b/headphones/lock.py
@@ -4,7 +4,7 @@ Locking-related classes
import time
import threading
-import Queue
+import queue
import headphones.logger
@@ -29,7 +29,7 @@ class TimedLock(object):
self.lock = threading.Lock()
self.last_used = 0
self.minimum_delta = minimum_delta
- self.queue = Queue.Queue()
+ self.queue = queue.Queue()
def __enter__(self):
"""
@@ -47,7 +47,7 @@ class TimedLock(object):
seconds = self.queue.get(False)
headphones.logger.debug('Sleeping %s (queued)', seconds)
time.sleep(seconds)
- except Queue.Empty:
+ except queue.Empty:
continue
self.queue.task_done()
diff --git a/headphones/logger.py b/headphones/logger.py
index 1eaac7cc..f49da8ac 100644
--- a/headphones/logger.py
+++ b/headphones/logger.py
@@ -153,7 +153,8 @@ def initLogger(console=False, log_dir=False, verbose=False):
file_formatter = logging.Formatter(
'%(asctime)s - %(levelname)-7s :: %(threadName)s : %(message)s', '%d-%b-%Y %H:%M:%S')
file_handler = handlers.RotatingFileHandler(filename, maxBytes=MAX_SIZE,
- backupCount=MAX_FILES)
+ backupCount=MAX_FILES,
+ encoding='utf8')
file_handler.setLevel(logging.DEBUG)
file_handler.setFormatter(file_formatter)
diff --git a/headphones/lyrics.py b/headphones/lyrics.py
index c0f45ed5..93b59cf3 100644
--- a/headphones/lyrics.py
+++ b/headphones/lyrics.py
@@ -13,7 +13,7 @@
# You should have received a copy of the GNU General Public License
# along with Headphones. If not, see .
-import htmlentitydefs
+import html.entities
import re
from headphones import logger, request
@@ -53,7 +53,7 @@ def getLyrics(artist, song):
'''''').search(
lyricspage)
if m:
- return u'(Instrumental)'
+ return '(Instrumental)'
else:
logger.warn('Cannot find lyrics on: %s' % lyricsurl)
return
@@ -72,7 +72,7 @@ def convert_html_entities(s):
name = hit[2:-1]
try:
entnum = int(name)
- s = s.replace(hit, unichr(entnum))
+ s = s.replace(hit, chr(entnum))
except ValueError:
pass
@@ -83,7 +83,7 @@ def convert_html_entities(s):
hits.remove(amp)
for hit in hits:
name = hit[1:-1]
- if name in htmlentitydefs.name2codepoint:
- s = s.replace(hit, unichr(htmlentitydefs.name2codepoint[name]))
+ if name in html.entities.name2codepoint:
+ s = s.replace(hit, chr(html.entities.name2codepoint[name]))
s = s.replace(amp, "&")
return s
diff --git a/headphones/mb.py b/headphones/mb.py
index 7d9b9c50..45d35122 100644
--- a/headphones/mb.py
+++ b/headphones/mb.py
@@ -112,9 +112,9 @@ def findArtist(name, limit=1):
return False
for result in artistResults:
if 'disambiguation' in result:
- uniquename = unicode(result['sort-name'] + " (" + result['disambiguation'] + ")")
+ uniquename = str(result['sort-name'] + " (" + result['disambiguation'] + ")")
else:
- uniquename = unicode(result['sort-name'])
+ uniquename = str(result['sort-name'])
if result['name'] != uniquename and limit == 1:
logger.info(
'Found an artist with a disambiguation: %s - doing an album based search' % name)
@@ -126,7 +126,7 @@ def findArtist(name, limit=1):
# Just need the artist id if the limit is 1
# 'name': unicode(result['sort-name']),
# 'uniquename': uniquename,
- 'id': unicode(result['id']),
+ 'id': str(result['id']),
# 'url': unicode("http://musicbrainz.org/artist/" + result['id']),#probably needs to be changed
# 'score': int(result['ext:score'])
})
@@ -134,10 +134,10 @@ def findArtist(name, limit=1):
artistlist.append(artistdict)
else:
artistlist.append({
- 'name': unicode(result['sort-name']),
+ 'name': str(result['sort-name']),
'uniquename': uniquename,
- 'id': unicode(result['id']),
- 'url': unicode("http://musicbrainz.org/artist/" + result['id']),
+ 'id': str(result['id']),
+ 'url': str("http://musicbrainz.org/artist/" + result['id']),
# probably needs to be changed
'score': int(result['ext:score'])
})
@@ -187,7 +187,7 @@ def findRelease(name, limit=1, artist=None):
if tracks:
tracks += ' + '
tracks += str(medium['track-count'])
- for format, count in format_dict.items():
+ for format, count in list(format_dict.items()):
if formats:
formats += ' + '
if count > 1:
@@ -203,22 +203,22 @@ def findRelease(name, limit=1, artist=None):
rg_type = secondary_type
releaselist.append({
- 'uniquename': unicode(result['artist-credit'][0]['artist']['name']),
- 'title': unicode(title),
- 'id': unicode(result['artist-credit'][0]['artist']['id']),
- 'albumid': unicode(result['id']),
- 'url': unicode(
+ 'uniquename': str(result['artist-credit'][0]['artist']['name']),
+ 'title': str(title),
+ 'id': str(result['artist-credit'][0]['artist']['id']),
+ 'albumid': str(result['id']),
+ 'url': str(
"http://musicbrainz.org/artist/" + result['artist-credit'][0]['artist']['id']),
# probably needs to be changed
- 'albumurl': unicode("http://musicbrainz.org/release/" + result['id']),
+ 'albumurl': str("http://musicbrainz.org/release/" + result['id']),
# probably needs to be changed
'score': int(result['ext:score']),
- 'date': unicode(result['date']) if 'date' in result else '',
- 'country': unicode(result['country']) if 'country' in result else '',
- 'formats': unicode(formats),
- 'tracks': unicode(tracks),
- 'rgid': unicode(result['release-group']['id']),
- 'rgtype': unicode(rg_type)
+ 'date': str(result['date']) if 'date' in result else '',
+ 'country': str(result['country']) if 'country' in result else '',
+ 'formats': str(formats),
+ 'tracks': str(tracks),
+ 'rgid': str(result['release-group']['id']),
+ 'rgtype': str(rg_type)
})
return releaselist
@@ -240,15 +240,15 @@ def findSeries(name, limit=1):
return False
for result in seriesResults:
if 'disambiguation' in result:
- uniquename = unicode(result['name'] + " (" + result['disambiguation'] + ")")
+ uniquename = str(result['name'] + " (" + result['disambiguation'] + ")")
else:
- uniquename = unicode(result['name'])
+ uniquename = str(result['name'])
serieslist.append({
'uniquename': uniquename,
- 'name': unicode(result['name']),
- 'type': unicode(result['type']),
- 'id': unicode(result['id']),
- 'url': unicode("http://musicbrainz.org/series/" + result['id']),
+ 'name': str(result['name']),
+ 'type': str(result['type']),
+ 'id': str(result['id']),
+ 'url': str("http://musicbrainz.org/series/" + result['id']),
# probably needs to be changed
'score': int(result['ext:score'])
})
@@ -284,19 +284,19 @@ def getArtist(artistid, extrasonly=False):
if not artist:
return False
- artist_dict['artist_name'] = unicode(artist['name'])
+ artist_dict['artist_name'] = str(artist['name'])
releasegroups = []
if not extrasonly:
for rg in artist['release-group-list']:
- if "secondary-type-list" in rg.keys(): # only add releases without a secondary type
+ if "secondary-type-list" in list(rg.keys()): # only add releases without a secondary type
continue
releasegroups.append({
- 'title': unicode(rg['title']),
- 'id': unicode(rg['id']),
- 'url': u"http://musicbrainz.org/release-group/" + rg['id'],
- 'type': unicode(rg['type'])
+ 'title': str(rg['title']),
+ 'id': str(rg['id']),
+ 'url': "http://musicbrainz.org/release-group/" + rg['id'],
+ 'type': str(rg['type'])
})
# See if we need to grab extras. Artist specific extras take precedence over global option
@@ -314,7 +314,7 @@ def getArtist(artistid, extrasonly=False):
# Need to convert extras string from something like '2,5.6' to ['ep','live','remix'] (append new extras to end)
if db_artist['Extras']:
- extras = map(int, db_artist['Extras'].split(','))
+ extras = list(map(int, db_artist['Extras'].split(',')))
else:
extras = []
extras_list = headphones.POSSIBLE_EXTRAS
@@ -354,10 +354,10 @@ def getArtist(artistid, extrasonly=False):
rg_type = secondary_type
releasegroups.append({
- 'title': unicode(rg['title']),
- 'id': unicode(rg['id']),
- 'url': u"http://musicbrainz.org/release-group/" + rg['id'],
- 'type': unicode(rg_type)
+ 'title': str(rg['title']),
+ 'id': str(rg['id']),
+ 'url': "http://musicbrainz.org/release-group/" + rg['id'],
+ 'type': str(rg_type)
})
artist_dict['releasegroups'] = releasegroups
return artist_dict
@@ -382,10 +382,10 @@ def getSeries(seriesid):
return False
if 'disambiguation' in series:
- series_dict['artist_name'] = unicode(
- series['name'] + " (" + unicode(series['disambiguation']) + ")")
+ series_dict['artist_name'] = str(
+ series['name'] + " (" + str(series['disambiguation']) + ")")
else:
- series_dict['artist_name'] = unicode(series['name'])
+ series_dict['artist_name'] = str(series['name'])
releasegroups = []
@@ -448,42 +448,42 @@ def getRelease(releaseid, include_artist_info=True):
if not results:
return False
- release['title'] = unicode(results['title'])
- release['id'] = unicode(results['id'])
- release['asin'] = unicode(results['asin']) if 'asin' in results else None
- release['date'] = unicode(results['date']) if 'date' in results else None
+ release['title'] = str(results['title'])
+ release['id'] = str(results['id'])
+ release['asin'] = str(results['asin']) if 'asin' in results else None
+ release['date'] = str(results['date']) if 'date' in results else None
try:
- release['format'] = unicode(results['medium-list'][0]['format'])
+ release['format'] = str(results['medium-list'][0]['format'])
except:
- release['format'] = u'Unknown'
+ release['format'] = 'Unknown'
try:
- release['country'] = unicode(results['country'])
+ release['country'] = str(results['country'])
except:
- release['country'] = u'Unknown'
+ release['country'] = 'Unknown'
if include_artist_info:
if 'release-group' in results:
- release['rgid'] = unicode(results['release-group']['id'])
- release['rg_title'] = unicode(results['release-group']['title'])
+ release['rgid'] = str(results['release-group']['id'])
+ release['rg_title'] = str(results['release-group']['title'])
try:
- release['rg_type'] = unicode(results['release-group']['type'])
+ release['rg_type'] = str(results['release-group']['type'])
if release['rg_type'] == 'Album' and 'secondary-type-list' in results[
'release-group']:
- secondary_type = unicode(results['release-group']['secondary-type-list'][0])
+ secondary_type = str(results['release-group']['secondary-type-list'][0])
if secondary_type != release['rg_type']:
release['rg_type'] = secondary_type
except KeyError:
- release['rg_type'] = u'Unknown'
+ release['rg_type'] = 'Unknown'
else:
logger.warn("Release " + releaseid + "had no ReleaseGroup associated")
- release['artist_name'] = unicode(results['artist-credit'][0]['artist']['name'])
- release['artist_id'] = unicode(results['artist-credit'][0]['artist']['id'])
+ release['artist_name'] = str(results['artist-credit'][0]['artist']['name'])
+ release['artist_id'] = str(results['artist-credit'][0]['artist']['id'])
release['tracks'] = getTracksFromRelease(results)
@@ -529,7 +529,7 @@ def get_new_releases(rgid, includeExtras=False, forcefull=False):
force_repackage1 = 0
if len(results) != 0:
for release_mark in results:
- release_list.append(unicode(release_mark['id']))
+ release_list.append(str(release_mark['id']))
release_title = release_mark['title']
remove_missing_releases = myDB.action("SELECT ReleaseID FROM allalbums WHERE AlbumID=?",
[rgid])
@@ -561,31 +561,31 @@ def get_new_releases(rgid, includeExtras=False, forcefull=False):
# DELETE all references to this release since we're updating it anyway.
myDB.action('DELETE from allalbums WHERE ReleaseID=?', [rel_id_check])
myDB.action('DELETE from alltracks WHERE ReleaseID=?', [rel_id_check])
- release['AlbumTitle'] = unicode(releasedata['title'])
- release['AlbumID'] = unicode(rgid)
- release['AlbumASIN'] = unicode(releasedata['asin']) if 'asin' in releasedata else None
- release['ReleaseDate'] = unicode(releasedata['date']) if 'date' in releasedata else None
+ release['AlbumTitle'] = str(releasedata['title'])
+ release['AlbumID'] = str(rgid)
+ release['AlbumASIN'] = str(releasedata['asin']) if 'asin' in releasedata else None
+ release['ReleaseDate'] = str(releasedata['date']) if 'date' in releasedata else None
release['ReleaseID'] = releasedata['id']
if 'release-group' not in releasedata:
raise Exception('No release group associated with release id ' + releasedata[
'id'] + ' album id' + rgid)
- release['Type'] = unicode(releasedata['release-group']['type'])
+ release['Type'] = str(releasedata['release-group']['type'])
if release['Type'] == 'Album' and 'secondary-type-list' in releasedata['release-group']:
- secondary_type = unicode(releasedata['release-group']['secondary-type-list'][0])
+ secondary_type = str(releasedata['release-group']['secondary-type-list'][0])
if secondary_type != release['Type']:
release['Type'] = secondary_type
# making the assumption that the most important artist will be first in the list
if 'artist-credit' in releasedata:
- release['ArtistID'] = unicode(releasedata['artist-credit'][0]['artist']['id'])
- release['ArtistName'] = unicode(releasedata['artist-credit-phrase'])
+ release['ArtistID'] = str(releasedata['artist-credit'][0]['artist']['id'])
+ release['ArtistName'] = str(releasedata['artist-credit-phrase'])
else:
logger.warn('Release ' + releasedata['id'] + ' has no Artists associated.')
return False
- release['ReleaseCountry'] = unicode(
- releasedata['country']) if 'country' in releasedata else u'Unknown'
+ release['ReleaseCountry'] = str(
+ releasedata['country']) if 'country' in releasedata else 'Unknown'
# assuming that the list will contain media and that the format will be consistent
try:
additional_medium = ''
@@ -600,9 +600,9 @@ def get_new_releases(rgid, includeExtras=False, forcefull=False):
disc_number = str(medium_count) + 'x'
packaged_medium = disc_number + releasedata['medium-list'][0][
'format'] + additional_medium
- release['ReleaseFormat'] = unicode(packaged_medium)
+ release['ReleaseFormat'] = str(packaged_medium)
except:
- release['ReleaseFormat'] = u'Unknown'
+ release['ReleaseFormat'] = 'Unknown'
release['Tracks'] = getTracksFromRelease(releasedata)
@@ -684,14 +684,14 @@ def getTracksFromRelease(release):
for medium in release['medium-list']:
for track in medium['track-list']:
try:
- track_title = unicode(track['title'])
+ track_title = str(track['title'])
except:
- track_title = unicode(track['recording']['title'])
+ track_title = str(track['recording']['title'])
tracks.append({
'number': totalTracks,
'title': track_title,
- 'id': unicode(track['recording']['id']),
- 'url': u"http://musicbrainz.org/track/" + track['recording']['id'],
+ 'id': str(track['recording']['id']),
+ 'url': "http://musicbrainz.org/track/" + track['recording']['id'],
'duration': int(track['length']) if 'length' in track else 0
})
totalTracks += 1
@@ -739,7 +739,7 @@ def findArtistbyAlbum(name):
# uniquename = unicode(newArtist['sort-name'])
# artist_dict['name'] = unicode(newArtist['sort-name'])
# artist_dict['uniquename'] = uniquename
- artist_dict['id'] = unicode(newArtist['id'])
+ artist_dict['id'] = str(newArtist['id'])
# artist_dict['url'] = u'http://musicbrainz.org/artist/' + newArtist['id']
# artist_dict['score'] = int(releaseGroup['ext:score'])
@@ -768,7 +768,7 @@ def findAlbumID(artist=None, album=None):
if len(results) < 1:
return False
- rgid = unicode(results[0]['id'])
+ rgid = str(results[0]['id'])
return rgid
diff --git a/headphones/metacritic.py b/headphones/metacritic.py
index 4c65ffcd..fc9c7c40 100644
--- a/headphones/metacritic.py
+++ b/headphones/metacritic.py
@@ -35,7 +35,7 @@ def update(artistid, artist_name, release_groups):
headers = {
'User-Agent': 'Mozilla/5.0 (Windows NT 6.3; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2243.2 Safari/537.36'}
- url = "http://www.metacritic.com/person/" + mc_artist_name + "?filter-options=music&sort_options=date&num_items=100"
+ url = "https://www.metacritic.com/person/" + mc_artist_name + "?filter-options=music&sort_options=date&num_items=100"
res = request.request_soup(url, headers=headers, whitelist_status_code=404)
diff --git a/headphones/metadata.py b/headphones/metadata.py
index c8797801..20bdddd4 100644
--- a/headphones/metadata.py
+++ b/headphones/metadata.py
@@ -17,8 +17,8 @@
Track/album metadata handling routines.
"""
-from __future__ import print_function
-from beets.mediafile import MediaFile, UnreadableFileError
+
+from mediafile import MediaFile, UnreadableFileError
import headphones
from headphones import logger
import os.path
@@ -60,7 +60,7 @@ class MetadataDict(dict):
self._lower = {}
if seq is not None:
try:
- self.add_items(seq.iteritems())
+ self.add_items(iter(seq.items()))
except KeyError:
self.add_items(seq)
@@ -103,11 +103,11 @@ def _verify_var_type(val):
"""
Check if type of value is allowed as a variable in pathname substitution.
"""
- return isinstance(val, (basestring, int, float, datetime.date))
+ return isinstance(val, (str, int, float, datetime.date))
def _as_str(val):
- if isinstance(val, basestring):
+ if isinstance(val, str):
return val
else:
return str(val)
@@ -134,7 +134,7 @@ def _row_to_dict(row, d):
"""
Populate dict with database row fields.
"""
- for fld in row.keys():
+ for fld in list(row.keys()):
val = row[fld]
if val is None:
val = ''
@@ -184,9 +184,7 @@ def file_metadata(path, release):
try:
f = MediaFile(path)
except UnreadableFileError as ex:
- logger.info("MediaFile couldn't parse: %s (%s)",
- path.decode(headphones.SYS_ENCODING, 'replace'),
- str(ex))
+ logger.info(f"MediaFile couldn't parse {path}: {e}")
return None, None
res = MetadataDict()
@@ -207,8 +205,7 @@ def file_metadata(path, release):
track_number = '%02d' % f.track
if not f.title:
- basename = os.path.basename(
- path.decode(headphones.SYS_ENCODING, 'replace'))
+ basename = os.path.basename(path)
title = os.path.splitext(basename)[0]
from_metadata = False
else:
@@ -242,7 +239,7 @@ def file_metadata(path, release):
Vars.SORT_ARTIST_LOWER: _lower(sort_name),
Vars.ALBUM_LOWER: _lower(album_title),
}
- res.add_items(override_values.iteritems())
+ res.add_items(iter(override_values.items()))
return res, from_metadata
@@ -252,7 +249,7 @@ def _intersect(d1, d2):
Create intersection (common part) of two dictionaries.
"""
res = {}
- for key, val in d1.iteritems():
+ for key, val in d1.items():
if key in d2 and d2[key] == val:
res[key] = val
return res
@@ -284,21 +281,19 @@ def album_metadata(path, release, common_tags):
sort_name = artist
if not sort_name or sort_name[0].isdigit():
- first_char = u'0-9'
+ first_char = '0-9'
else:
first_char = sort_name[0]
- orig_folder = u''
+ orig_folder = ''
# Get from temp path
if "_@hp@_" in path:
orig_folder = path.rsplit("headphones_", 1)[1].split("_@hp@_")[0]
- orig_folder = orig_folder.decode(headphones.SYS_ENCODING, 'replace')
else:
for r, d, f in os.walk(path):
try:
- orig_folder = os.path.basename(
- os.path.normpath(r).decode(headphones.SYS_ENCODING, 'replace'))
+ orig_folder = os.path.basename(os.path.normpath(r))
break
except:
pass
@@ -320,7 +315,7 @@ def album_metadata(path, release, common_tags):
Vars.ORIGINAL_FOLDER_LOWER: _lower(orig_folder)
}
res = MetadataDict(common_tags)
- res.add_items(override_values.iteritems())
+ res.add_items(iter(override_values.items()))
return res
@@ -345,7 +340,7 @@ def albumart_metadata(release, common_tags):
Vars.ALBUM_LOWER: _lower(album)
}
res = MetadataDict(common_tags)
- res.add_items(override_values.iteritems())
+ res.add_items(iter(override_values.items()))
return res
diff --git a/headphones/metadata_test.py b/headphones/metadata_test.py
index 5d79d442..de4c2b31 100644
--- a/headphones/metadata_test.py
+++ b/headphones/metadata_test.py
@@ -22,7 +22,7 @@ import headphones.helpers as _hp
from headphones.metadata import MetadataDict
import datetime
-from unittestcompat import TestCase
+from .unittestcompat import TestCase
__author__ = "Andrzej Ciarkowski "
@@ -50,7 +50,7 @@ class _MockDatabaseRow(object):
self._dict = dict(d)
def keys(self):
- return self._dict.iterkeys()
+ return iter(self._dict.keys())
def __getitem__(self, item):
return self._dict[item]
@@ -63,9 +63,9 @@ class MetadataTest(TestCase):
def test_metadata_dict_ci(self):
"""MetadataDict: case-insensitive lookup"""
- expected = u'naïve'
+ expected = 'naïve'
key_var = '$TitlE'
- m = MetadataDict({key_var.lower(): u'naïve'})
+ m = MetadataDict({key_var.lower(): 'naïve'})
self.assertFalse('$track' in m)
self.assertTrue('$tITLe' in m, "cross-case lookup with 'in'")
self.assertEqual(m[key_var], expected, "cross-case lookup success")
@@ -74,7 +74,7 @@ class MetadataTest(TestCase):
def test_metadata_dict_cs(self):
"""MetadataDice: case-preserving lookup"""
- expected_var = u'NaïVe'
+ expected_var = 'NaïVe'
key_var = '$TitlE'
m = MetadataDict({
key_var.lower(): expected_var.lower(),
@@ -171,5 +171,5 @@ class MetadataTest(TestCase):
res = _hp.pattern_substitute(
"/music/$First/$Artist/$Artist - $Album{ [$Year]}", md, True)
- self.assertEqual(res, u"/music/A/artist/artist - Album",
+ self.assertEqual(res, "/music/A/artist/artist - Album",
"check correct rendering of None via pattern_substitute()")
diff --git a/headphones/music_encoder.py b/headphones/music_encoder.py
index b51001f6..bb9b672e 100644
--- a/headphones/music_encoder.py
+++ b/headphones/music_encoder.py
@@ -14,6 +14,7 @@
# along with Headphones. If not, see .
import time
+import datetime
import shutil
import subprocess
import multiprocessing
@@ -21,14 +22,15 @@ import multiprocessing
import os
import headphones
from headphones import logger
-from beets.mediafile import MediaFile
+from mediafile import MediaFile
# xld
-import getXldProfile
+from . import getXldProfile
def encode(albumPath):
+ print(albumPath)
use_xld = headphones.CONFIG.ENCODER == 'xld'
# Return if xld details not found
@@ -63,8 +65,7 @@ def encode(albumPath):
for music in f:
if any(music.lower().endswith('.' + x.lower()) for x in headphones.MEDIA_FORMATS):
if not use_xld:
- encoderFormat = headphones.CONFIG.ENCODEROUTPUTFORMAT.encode(
- headphones.SYS_ENCODING)
+ encoderFormat = headphones.CONFIG.ENCODEROUTPUTFORMAT
else:
xldMusicFile = os.path.join(r, music)
xldInfoMusic = MediaFile(xldMusicFile)
@@ -86,7 +87,7 @@ def encode(albumPath):
musicTempFiles.append(os.path.join(tempDirEncode, musicTemp))
if headphones.CONFIG.ENCODER_PATH:
- encoder = headphones.CONFIG.ENCODER_PATH.encode(headphones.SYS_ENCODING)
+ encoder = headphones.CONFIG.ENCODER_PATH
else:
if use_xld:
encoder = os.path.join('/Applications', 'xld')
@@ -117,18 +118,17 @@ def encode(albumPath):
if use_xld:
if xldBitrate and (infoMusic.bitrate / 1000 <= xldBitrate):
- logger.info('%s has bitrate <= %skb, will not be re-encoded',
- music.decode(headphones.SYS_ENCODING, 'replace'), xldBitrate)
+ logger.info(f"{music} has bitrate <= {xldBitrate}kb, will not be re-encoded")
else:
encode = True
elif headphones.CONFIG.ENCODER == 'lame':
if not any(
- music.decode(headphones.SYS_ENCODING, 'replace').lower().endswith('.' + x) for x
+ music.lower().endswith('.' + x) for x
in ["mp3", "wav"]):
logger.warn('Lame cannot encode %s format for %s, use ffmpeg',
os.path.splitext(music)[1], music)
else:
- if music.decode(headphones.SYS_ENCODING, 'replace').lower().endswith('.mp3') and (
+ if music.lower().endswith('.mp3') and (
int(infoMusic.bitrate / 1000) <= headphones.CONFIG.BITRATE):
logger.info('%s has bitrate <= %skb, will not be re-encoded', music,
headphones.CONFIG.BITRATE)
@@ -136,13 +136,12 @@ def encode(albumPath):
encode = True
else:
if headphones.CONFIG.ENCODEROUTPUTFORMAT == 'ogg':
- if music.decode(headphones.SYS_ENCODING, 'replace').lower().endswith('.ogg'):
- logger.warn('Cannot re-encode .ogg %s',
- music.decode(headphones.SYS_ENCODING, 'replace'))
+ if music.lower().endswith('.ogg'):
+ logger.warn(f"Cannot re-encode .ogg {music}")
else:
encode = True
else:
- if music.decode(headphones.SYS_ENCODING, 'replace').lower().endswith('.' + headphones.CONFIG.ENCODEROUTPUTFORMAT) and (int(infoMusic.bitrate / 1000) <= headphones.CONFIG.BITRATE):
+ if music.lower().endswith('.' + headphones.CONFIG.ENCODEROUTPUTFORMAT) and (int(infoMusic.bitrate / 1000) <= headphones.CONFIG.BITRATE):
logger.info('%s has bitrate <= %skb, will not be re-encoded', music, headphones.CONFIG.BITRATE)
else:
encode = True
@@ -185,13 +184,13 @@ def encode(albumPath):
# Retrieve the results
results = results.get()
else:
- results = map(command_map, jobs)
+ results = list(map(command_map, jobs))
# The results are either True or False, so determine if one is False
encoder_failed = not all(results)
- musicFiles = filter(None, musicFiles)
- musicTempFiles = filter(None, musicTempFiles)
+ musicFiles = [_f for _f in musicFiles if _f]
+ musicTempFiles = [_f for _f in musicTempFiles if _f]
# check all files to be encoded now exist in temp directory
if not encoder_failed and musicTempFiles:
@@ -352,36 +351,31 @@ def command(encoder, musicSource, musicDest, albumPath, xldProfile):
startupinfo.dwFlags |= subprocess._subprocess.STARTF_USESHOWWINDOW
# Encode
- logger.info('Encoding %s...' % (musicSource.decode(headphones.SYS_ENCODING, 'replace')))
+ logger.info(f"Encoding {musicSource}")
logger.debug(subprocess.list2cmdline(cmd))
process = subprocess.Popen(cmd, startupinfo=startupinfo,
stdin=open(os.devnull, 'rb'), stdout=subprocess.PIPE,
- stderr=subprocess.PIPE)
+ stderr=subprocess.PIPE, text=True)
stdout, stderr = process.communicate(headphones.CONFIG.ENCODER)
# Error if return code not zero
if process.returncode:
- logger.error(
- 'Encoding failed for %s' % (musicSource.decode(headphones.SYS_ENCODING, 'replace')))
- out = stdout if stdout else stderr
- out = out.decode(headphones.SYS_ENCODING, 'replace')
+ logger.error(f"Encoding failed for {musicSource}")
+ out = stdout or stderr
outlast2lines = '\n'.join(out.splitlines()[-2:])
- logger.error('%s error details: %s' % (headphones.CONFIG.ENCODER, outlast2lines))
+ logger.error(f"{headphones.CONFIG.ENCODER} error details: {outlast2lines}")
out = out.rstrip("\n")
logger.debug(out)
encoded = False
else:
- logger.info('%s encoded in %s', musicSource, getTimeEncode(startMusicTime))
+ logger.info(f"{musicSource} encoded in {getTimeEncode(startMusicTime)}")
encoded = True
return encoded
def getTimeEncode(start):
- seconds = int(time.time() - start)
- hours = seconds / 3600
- seconds -= 3600 * hours
- minutes = seconds / 60
- seconds -= 60 * minutes
- return "%02d:%02d:%02d" % (hours, minutes, seconds)
+ finish = time.time()
+ seconds = int(finish - start)
+ return datetime.timedelta(seconds=seconds)
diff --git a/headphones/notifiers.py b/headphones/notifiers.py
index 5f3e8620..79b7f596 100644
--- a/headphones/notifiers.py
+++ b/headphones/notifiers.py
@@ -1,28 +1,13 @@
-# This file is part of Headphones.
-#
-# Headphones is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Headphones is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Headphones. If not, see .
-
-from urllib import urlencode, quote_plus
-import urllib
+from urllib.parse import urlencode, quote_plus
+import urllib.request, urllib.parse, urllib.error
import subprocess
import json
from email.mime.text import MIMEText
import smtplib
import email.utils
-from httplib import HTTPSConnection
-from urlparse import parse_qsl
-import urllib2
+from http.client import HTTPSConnection
+from urllib.parse import parse_qsl
+import urllib.request, urllib.error, urllib.parse
import requests as requests
import os.path
@@ -31,8 +16,8 @@ from pynma import pynma
import cherrypy
import headphones
import gntp.notifier
-import oauth2 as oauth
-import pythontwitter as twitter
+#import oauth2 as oauth
+import twitter
class GROWL(object):
@@ -81,10 +66,10 @@ class GROWL(object):
try:
growl.register()
except gntp.notifier.errors.NetworkError:
- logger.warning(u'Growl notification failed: network error')
+ logger.warning('Growl notification failed: network error')
return
except gntp.notifier.errors.AuthError:
- logger.warning(u'Growl notification failed: authentication error')
+ logger.warning('Growl notification failed: authentication error')
return
# Fix message
@@ -105,10 +90,10 @@ class GROWL(object):
icon=image
)
except gntp.notifier.errors.NetworkError:
- logger.warning(u'Growl notification failed: network error')
+ logger.warning('Growl notification failed: network error')
return
- logger.info(u"Growl notifications sent.")
+ logger.info("Growl notifications sent.")
def updateLibrary(self):
# For uniformity reasons not removed
@@ -157,13 +142,13 @@ class PROWL(object):
request_status = response.status
if request_status == 200:
- logger.info(u"Prowl notifications sent.")
+ logger.info("Prowl notifications sent.")
return True
elif request_status == 401:
- logger.info(u"Prowl auth failed: %s" % response.reason)
+ logger.info("Prowl auth failed: %s" % response.reason)
return False
else:
- logger.info(u"Prowl notification failed.")
+ logger.info("Prowl notification failed.")
return False
def updateLibrary(self):
@@ -202,7 +187,7 @@ class XBMC(object):
self.password = headphones.CONFIG.XBMC_PASSWORD
def _sendhttp(self, host, command):
- url_command = urllib.urlencode(command)
+ url_command = urllib.parse.urlencode(command)
url = host + '/xbmcCmds/xbmcHttp/?' + url_command
if self.password:
@@ -295,10 +280,10 @@ class LMS(object):
content = {'Content-Type': 'application/json'}
- req = urllib2.Request(host + '/jsonrpc.js', data, content)
+ req = urllib.request.Request(host + '/jsonrpc.js', data, content)
try:
- handle = urllib2.urlopen(req)
+ handle = urllib.request.urlopen(req)
except Exception as e:
logger.warn('Error opening LMS url: %s' % e)
return
@@ -424,7 +409,7 @@ class Plex(object):
sections = r.getElementsByTagName('Directory')
if not sections:
- logger.info(u"Plex Media Server not running on: " + host)
+ logger.info("Plex Media Server not running on: " + host)
return False
for s in sections:
@@ -483,9 +468,9 @@ class NMA(object):
api = headphones.CONFIG.NMA_APIKEY
nma_priority = headphones.CONFIG.NMA_PRIORITY
- logger.debug(u"NMA title: " + title)
- logger.debug(u"NMA API: " + api)
- logger.debug(u"NMA Priority: " + str(nma_priority))
+ logger.debug("NMA title: " + title)
+ logger.debug("NMA API: " + api)
+ logger.debug("NMA Priority: " + str(nma_priority))
if snatched:
event = snatched + " snatched!"
@@ -495,8 +480,8 @@ class NMA(object):
message = "Headphones has downloaded and postprocessed: " + \
artist + ' [' + album + ']'
- logger.debug(u"NMA event: " + event)
- logger.debug(u"NMA message: " + message)
+ logger.debug("NMA event: " + event)
+ logger.debug("NMA message: " + message)
batch = False
@@ -510,8 +495,8 @@ class NMA(object):
response = p.push(title, event, message, priority=nma_priority,
batch_mode=batch)
- if not response[api][u'code'] == u'200':
- logger.error(u'Could not send notification to NotifyMyAndroid')
+ if not response[api]['code'] == '200':
+ logger.error('Could not send notification to NotifyMyAndroid')
return False
else:
return True
@@ -543,10 +528,10 @@ class PUSHBULLET(object):
data=json.dumps(data))
if response:
- logger.info(u"PushBullet notifications sent.")
+ logger.info("PushBullet notifications sent.")
return True
else:
- logger.info(u"PushBullet notification failed.")
+ logger.info("PushBullet notification failed.")
return False
@@ -557,9 +542,9 @@ class PUSHALOT(object):
pushalot_authorizationtoken = headphones.CONFIG.PUSHALOT_APIKEY
- logger.debug(u"Pushalot event: " + event)
- logger.debug(u"Pushalot message: " + message)
- logger.debug(u"Pushalot api: " + pushalot_authorizationtoken)
+ logger.debug("Pushalot event: " + event)
+ logger.debug("Pushalot message: " + message)
+ logger.debug("Pushalot api: " + pushalot_authorizationtoken)
http_handler = HTTPSConnection("pushalot.com")
@@ -576,18 +561,18 @@ class PUSHALOT(object):
response = http_handler.getresponse()
request_status = response.status
- logger.debug(u"Pushalot response status: %r" % request_status)
- logger.debug(u"Pushalot response headers: %r" % response.getheaders())
- logger.debug(u"Pushalot response body: %r" % response.read())
+ logger.debug("Pushalot response status: %r" % request_status)
+ logger.debug("Pushalot response headers: %r" % response.getheaders())
+ logger.debug("Pushalot response body: %r" % response.read())
if request_status == 200:
- logger.info(u"Pushalot notifications sent.")
+ logger.info("Pushalot notifications sent.")
return True
elif request_status == 410:
- logger.info(u"Pushalot auth failed: %s" % response.reason)
+ logger.info("Pushalot auth failed: %s" % response.reason)
return False
else:
- logger.info(u"Pushalot notification failed.")
+ logger.info("Pushalot notification failed.")
return False
@@ -618,7 +603,7 @@ class JOIN(object):
else:
self.url += '&deviceId={deviceid}'
- response = urllib2.urlopen(self.url.format(apikey=self.apikey,
+ response = urllib.request.urlopen(self.url.format(apikey=self.apikey,
title=quote_plus(event),
text=quote_plus(
message.encode(
@@ -627,10 +612,10 @@ class JOIN(object):
deviceid=self.deviceid))
if response:
- logger.info(u"Join notifications sent.")
+ logger.info("Join notifications sent.")
return True
else:
- logger.error(u"Join notification failed.")
+ logger.error("Join notification failed.")
return False
@@ -669,7 +654,7 @@ class Synoindex(object):
out, error = p.communicate()
# synoindex never returns any codes other than '0',
# highly irritating
- except OSError, e:
+ except OSError as e:
logger.warn("Error sending notification: %s" % str(e))
def notify_multiple(self, path_list):
@@ -710,10 +695,10 @@ class PUSHOVER(object):
headers=headers, data=data)
if response:
- logger.info(u"Pushover notifications sent.")
+ logger.info("Pushover notifications sent.")
return True
else:
- logger.error(u"Pushover notification failed.")
+ logger.error("Pushover notification failed.")
return False
def updateLibrary(self):
@@ -832,7 +817,7 @@ class TwitterNotifier(object):
access_token_key = headphones.CONFIG.TWITTER_USERNAME
access_token_secret = headphones.CONFIG.TWITTER_PASSWORD
- logger.info(u"Sending tweet: " + message)
+ logger.info("Sending tweet: " + message)
api = twitter.Api(username, password, access_token_key,
access_token_secret)
@@ -840,7 +825,7 @@ class TwitterNotifier(object):
try:
api.PostUpdate(message)
except Exception as e:
- logger.info(u"Error Sending Tweet: %s" % e)
+ logger.info("Error Sending Tweet: %s" % e)
return False
return True
@@ -938,7 +923,7 @@ class BOXCAR(object):
message += '
MusicBrainz' % rgid
- data = urllib.urlencode({
+ data = urllib.parse.urlencode({
'user_credentials': headphones.CONFIG.BOXCAR_TOKEN,
'notification[title]': title.encode('utf-8'),
'notification[long_message]': message.encode('utf-8'),
@@ -947,12 +932,12 @@ class BOXCAR(object):
"/headphoneslogo.png"
})
- req = urllib2.Request(self.url)
- handle = urllib2.urlopen(req, data)
+ req = urllib.request.Request(self.url)
+ handle = urllib.request.urlopen(req, data)
handle.close()
return True
- except urllib2.URLError as e:
+ except urllib.error.URLError as e:
logger.warn('Error sending Boxcar2 Notification: %s' % e)
return False
@@ -1011,7 +996,7 @@ class Email(object):
mailserver.quit()
return True
- except Exception, e:
+ except Exception as e:
logger.warn('Error sending Email: %s' % e)
return False
@@ -1044,15 +1029,15 @@ class TELEGRAM(object):
payload = {'chat_id': userid, 'parse_mode': "HTML", 'caption': status + message}
try:
response = requests.post(TELEGRAM_API % (token, "sendPhoto"), data=payload, files=image_file)
- except Exception, e:
- logger.info(u'Telegram notify failed: ' + str(e))
+ except Exception as e:
+ logger.info('Telegram notify failed: ' + str(e))
# Sent text
else:
payload = {'chat_id': userid, 'parse_mode': "HTML", 'text': status + message}
try:
response = requests.post(TELEGRAM_API % (token, "sendMessage"), data=payload)
- except Exception, e:
- logger.info(u'Telegram notify failed: ' + str(e))
+ except Exception as e:
+ logger.info('Telegram notify failed: ' + str(e))
# Error logging
sent_successfuly = True
@@ -1060,7 +1045,7 @@ class TELEGRAM(object):
logger.info("Could not send notification to TelegramBot (token=%s). Response: [%s]", token, response.text)
sent_successfuly = False
- logger.info(u"Telegram notifications sent.")
+ logger.info("Telegram notifications sent.")
return sent_successfuly
@@ -1080,15 +1065,15 @@ class SLACK(object):
try:
response = requests.post(SLACK_URL, json=payload)
- except Exception, e:
- logger.info(u'Slack notify failed: ' + str(e))
+ except Exception as e:
+ logger.info('Slack notify failed: ' + str(e))
sent_successfuly = True
if not response.status_code == 200:
logger.info(
- u'Could not send notification to Slack. Response: [%s]',
+ 'Could not send notification to Slack. Response: [%s]',
(response.text))
sent_successfuly = False
- logger.info(u"Slack notifications sent.")
+ logger.info("Slack notifications sent.")
return sent_successfuly
diff --git a/headphones/nzbget.py b/headphones/nzbget.py
index 779558ef..4884df7f 100644
--- a/headphones/nzbget.py
+++ b/headphones/nzbget.py
@@ -20,8 +20,8 @@
from base64 import standard_b64encode
-import httplib
-import xmlrpclib
+import http.client
+import xmlrpc.client
import headphones
from headphones import logger
@@ -32,7 +32,7 @@ def sendNZB(nzb):
nzbgetXMLrpc = "%(protocol)s://%(username)s:%(password)s@%(host)s/xmlrpc"
if not headphones.CONFIG.NZBGET_HOST:
- logger.error(u"No NZBget host found in configuration. Please configure it.")
+ logger.error("No NZBget host found in configuration. Please configure it.")
return False
if headphones.CONFIG.NZBGET_HOST.startswith('https://'):
@@ -46,25 +46,25 @@ def sendNZB(nzb):
"username": headphones.CONFIG.NZBGET_USERNAME,
"password": headphones.CONFIG.NZBGET_PASSWORD}
- nzbGetRPC = xmlrpclib.ServerProxy(url)
+ nzbGetRPC = xmlrpc.client.ServerProxy(url)
try:
if nzbGetRPC.writelog("INFO", "headphones connected to drop of %s any moment now." % (
nzb.name + ".nzb")):
- logger.debug(u"Successfully connected to NZBget")
+ logger.debug("Successfully connected to NZBget")
else:
- logger.info(u"Successfully connected to NZBget, but unable to send a message" % (
+ logger.info("Successfully connected to NZBget, but unable to send a message" % (
nzb.name + ".nzb"))
- except httplib.socket.error:
+ except http.client.socket.error:
logger.error(
- u"Please check your NZBget host and port (if it is running). NZBget is not responding to this combination")
+ "Please check your NZBget host and port (if it is running). NZBget is not responding to this combination")
return False
- except xmlrpclib.ProtocolError, e:
+ except xmlrpc.client.ProtocolError as e:
if e.errmsg == "Unauthorized":
- logger.error(u"NZBget password is incorrect.")
+ logger.error("NZBget password is incorrect.")
else:
- logger.error(u"Protocol Error: " + e.errmsg)
+ logger.error("Protocol Error: " + e.errmsg)
return False
nzbcontent64 = None
@@ -72,8 +72,8 @@ def sendNZB(nzb):
data = nzb.extraInfo[0]
nzbcontent64 = standard_b64encode(data)
- logger.info(u"Sending NZB to NZBget")
- logger.debug(u"URL: " + url)
+ logger.info("Sending NZB to NZBget")
+ logger.debug("URL: " + url)
dupekey = ""
dupescore = 0
@@ -131,12 +131,12 @@ def sendNZB(nzb):
nzb.url)
if nzbget_result:
- logger.debug(u"NZB sent to NZBget successfully")
+ logger.debug("NZB sent to NZBget successfully")
return True
else:
- logger.error(u"NZBget could not add %s to the queue" % (nzb.name + ".nzb"))
+ logger.error("NZBget could not add %s to the queue" % (nzb.name + ".nzb"))
return False
except:
logger.error(
- u"Connect Error to NZBget: could not add %s to the queue" % (nzb.name + ".nzb"))
+ "Connect Error to NZBget: could not add %s to the queue" % (nzb.name + ".nzb"))
return False
diff --git a/headphones/pathrender.py b/headphones/pathrender.py
index 48798dd7..a456c059 100644
--- a/headphones/pathrender.py
+++ b/headphones/pathrender.py
@@ -30,7 +30,7 @@ syntax elements are supported:
nonempty value only if any variable or optional inside returned
nonempty value, ignoring literals (like {'{'$That'}'}).
"""
-from __future__ import print_function
+
from enum import Enum
__author__ = "Andrzej Ciarkowski "
@@ -111,9 +111,9 @@ class _OptionalBlock(_Generator):
# type: (Mapping[str,str]) -> str
res = [(isinstance(x, _Generator), x.render(replacement)) for x in self._scope]
if any((t[0] and t[1] is not None and len(t[1]) != 0) for t in res):
- return u"".join(t[1] for t in res)
+ return "".join(t[1] for t in res)
else:
- return u""
+ return ""
def __eq__(self, other):
"""
@@ -122,15 +122,15 @@ class _OptionalBlock(_Generator):
return isinstance(other, _OptionalBlock) and self._scope == other._scope
-_OPTIONAL_START = u'{'
-_OPTIONAL_END = u'}'
-_ESCAPE_CHAR = u'\''
-_REPLACEMENT_START = u'$'
+_OPTIONAL_START = '{'
+_OPTIONAL_END = '}'
+_ESCAPE_CHAR = '\''
+_REPLACEMENT_START = '$'
def _is_replacement_valid(c):
# type: (str) -> bool
- return c.isalnum() or c == u'_'
+ return c.isalnum() or c == '_'
class _State(Enum):
@@ -243,7 +243,7 @@ class Pattern(object):
def __call__(self, replacement):
# type: (Mapping[str,str]) -> str
'''Execute path rendering/substitution based on replacement dictionary.'''
- return u"".join(p.render(replacement) for p in self._pattern)
+ return "".join(p.render(replacement) for p in self._pattern)
def _get_warnings(self):
# type: () -> str
@@ -262,6 +262,6 @@ def render(pattern, replacement):
if __name__ == "__main__":
# primitive test ;)
- p = Pattern(u"{$Disc.}$Track - $Artist - $Title{ [$Year]}")
- d = {'$Disc': '', '$Track': '05', '$Artist': u'Grzegżółka', '$Title': u'Błona kapłona', '$Year': '2019'}
- assert p(d) == u"05 - Grzegżółka - Błona kapłona [2019]"
+ p = Pattern("{$Disc.}$Track - $Artist - $Title{ [$Year]}")
+ d = {'$Disc': '', '$Track': '05', '$Artist': 'Grzegżółka', '$Title': 'Błona kapłona', '$Year': '2019'}
+ assert p(d) == "05 - Grzegżółka - Błona kapłona [2019]"
diff --git a/headphones/pathrender_test.py b/headphones/pathrender_test.py
index 9bcb7f4c..9d67e68d 100644
--- a/headphones/pathrender_test.py
+++ b/headphones/pathrender_test.py
@@ -19,7 +19,7 @@ Test module for pathrender.
import headphones.pathrender as _pr
from headphones.pathrender import Pattern, Warnings
-from unittestcompat import TestCase
+from .unittestcompat import TestCase
__author__ = "Andrzej Ciarkowski "
@@ -32,21 +32,21 @@ class PathRenderTest(TestCase):
def test_parsing(self):
"""pathrender: pattern parsing"""
- pattern = Pattern(u"{$Disc.}$Track - $Artist - $Title{ [$Year]}")
+ pattern = Pattern("{$Disc.}$Track - $Artist - $Title{ [$Year]}")
expected = [
_pr._OptionalBlock([
- _pr._Replacement(u"$Disc"),
- _pr._LiteralText(u".")
+ _pr._Replacement("$Disc"),
+ _pr._LiteralText(".")
]),
- _pr._Replacement(u"$Track"),
- _pr._LiteralText(u" - "),
- _pr._Replacement(u"$Artist"),
- _pr._LiteralText(u" - "),
- _pr._Replacement(u"$Title"),
+ _pr._Replacement("$Track"),
+ _pr._LiteralText(" - "),
+ _pr._Replacement("$Artist"),
+ _pr._LiteralText(" - "),
+ _pr._Replacement("$Title"),
_pr._OptionalBlock([
- _pr._LiteralText(u" ["),
- _pr._Replacement(u"$Year"),
- _pr._LiteralText(u"]")
+ _pr._LiteralText(" ["),
+ _pr._Replacement("$Year"),
+ _pr._LiteralText("]")
])
]
self.assertEqual(expected, pattern._pattern)
@@ -54,27 +54,27 @@ class PathRenderTest(TestCase):
def test_parsing_warnings(self):
"""pathrender: pattern parsing with warnings"""
- pattern = Pattern(u"{$Disc.}$Track - $Artist - $Title{ [$Year]")
+ pattern = Pattern("{$Disc.}$Track - $Artist - $Title{ [$Year]")
self.assertEqual(set([Warnings.UNCLOSED_OPTIONAL]), pattern.warnings)
- pattern = Pattern(u"{$Disc.}$Track - $Artist - $Title{ [$Year]'}")
+ pattern = Pattern("{$Disc.}$Track - $Artist - $Title{ [$Year]'}")
self.assertEqual(set([Warnings.UNCLOSED_ESCAPE, Warnings.UNCLOSED_OPTIONAL]), pattern.warnings)
def test_replacement(self):
"""pathrender: _Replacement variable substitution"""
- r = _pr._Replacement(u"$Title")
+ r = _pr._Replacement("$Title")
subst = {'$Title': 'foo', '$Track': 'bar'}
res = r.render(subst)
- self.assertEqual(res, u'foo', 'check valid replacement')
+ self.assertEqual(res, 'foo', 'check valid replacement')
subst = {}
res = r.render(subst)
- self.assertEqual(res, u'$Title', 'check missing replacement')
+ self.assertEqual(res, '$Title', 'check missing replacement')
subst = {'$Title': None}
res = r.render(subst)
self.assertEqual(res, '', 'check render() works with None')
def test_literal(self):
"""pathrender: _Literal text rendering"""
- l = _pr._LiteralText(u"foo")
+ l = _pr._LiteralText("foo")
subst = {'$foo': 'bar'}
res = l.render(subst)
self.assertEqual(res, 'foo')
@@ -82,12 +82,12 @@ class PathRenderTest(TestCase):
def test_optional(self):
"""pathrender: _OptionalBlock element processing"""
o = _pr._OptionalBlock([
- _pr._Replacement(u"$Title"),
- _pr._LiteralText(u".foobar")
+ _pr._Replacement("$Title"),
+ _pr._LiteralText(".foobar")
])
subst = {'$Title': 'foo', '$Track': 'bar'}
res = o.render(subst)
- self.assertEqual(res, u'foo.foobar', 'check non-empty replacement')
+ self.assertEqual(res, 'foo.foobar', 'check non-empty replacement')
subst = {'$Title': ''}
res = o.render(subst)
self.assertEqual(res, '', 'check empty replacement')
diff --git a/headphones/postprocessor.py b/headphones/postprocessor.py
index 5c7f4ebe..875bad80 100755
--- a/headphones/postprocessor.py
+++ b/headphones/postprocessor.py
@@ -25,7 +25,7 @@ import headphones
from beets import autotag
from beets import config as beetsconfig
from beets import logging as beetslogging
-from beets.mediafile import MediaFile, FileTypeError, UnreadableFileError
+from mediafile import MediaFile, FileTypeError, UnreadableFileError
from beetsplug import lyrics as beetslyrics
from headphones import notifiers, utorrent, transmission, deluge, qbittorrent
from headphones import db, albumart, librarysync
@@ -65,8 +65,8 @@ def checkFolder():
folder_name = torrent_folder_name
if folder_name:
- album_path = os.path.join(download_dir, folder_name).encode(
- headphones.SYS_ENCODING, 'replace')
+ print(folder_name)
+ album_path = os.path.join(download_dir, folder_name)
logger.debug("Checking if %s exists" % album_path)
if os.path.exists(album_path):
@@ -80,6 +80,7 @@ def checkFolder():
def verify(albumid, albumpath, Kind=None, forced=False, keep_original_folder=False, single=False):
+ print(albumpath)
myDB = db.DBConnection()
release = myDB.action('SELECT * from albums WHERE AlbumID=?', [albumid]).fetchone()
tracks = myDB.select('SELECT * from tracks WHERE AlbumID=?', [albumid])
@@ -135,11 +136,11 @@ def verify(albumid, albumpath, Kind=None, forced=False, keep_original_folder=Fal
if headphones.CONFIG.RENAME_FROZEN:
renameUnprocessedFolder(albumpath, tag="Frozen")
else:
- logger.warn(u"Won't rename %s to mark as 'Frozen', because it is disabled.",
- albumpath.decode(headphones.SYS_ENCODING, 'replace'))
+ logger.warn("Won't rename %s to mark as 'Frozen', because it is disabled.",
+ albumpath)
return
- logger.info(u"Now adding/updating artist: " + release_dict['artist_name'])
+ logger.info("Now adding/updating artist: " + release_dict['artist_name'])
if release_dict['artist_name'].startswith('The '):
sortname = release_dict['artist_name'][4:]
@@ -161,7 +162,7 @@ def verify(albumid, albumpath, Kind=None, forced=False, keep_original_folder=Fal
myDB.upsert("artists", newValueDict, controlValueDict)
- logger.info(u"Now adding album: " + release_dict['title'])
+ logger.info("Now adding album: " + release_dict['title'])
controlValueDict = {"AlbumID": albumid}
newValueDict = {"ArtistID": release_dict['artist_id'],
@@ -202,7 +203,7 @@ def verify(albumid, albumpath, Kind=None, forced=False, keep_original_folder=Fal
newValueDict = {"Status": "Paused"}
myDB.upsert("artists", newValueDict, controlValueDict)
- logger.info(u"Addition complete for: " + release_dict['title'] + " - " + release_dict[
+ logger.info("Addition complete for: " + release_dict['title'] + " - " + release_dict[
'artist_name'])
release = myDB.action('SELECT * from albums WHERE AlbumID=?', [albumid]).fetchone()
@@ -211,17 +212,18 @@ def verify(albumid, albumpath, Kind=None, forced=False, keep_original_folder=Fal
downloaded_track_list = []
downloaded_cuecount = 0
- for r, d, f in os.walk(albumpath):
- for files in f:
- if any(files.lower().endswith('.' + x.lower()) for x in headphones.MEDIA_FORMATS):
- downloaded_track_list.append(os.path.join(r, files))
- elif files.lower().endswith('.cue'):
+ media_extensions = tuple(map(lambda x: '.' + x, headphones.MEDIA_FORMATS))
+
+ for root, dirs, files in os.walk(albumpath):
+ for file in files:
+ if file.endswith(media_extensions):
+ downloaded_track_list.append(os.path.join(root, file))
+ elif file.endswith('.cue'):
downloaded_cuecount += 1
# if any of the files end in *.part, we know the torrent isn't done yet. Process if forced, though
- elif files.lower().endswith(('.part', '.utpart')) and not forced:
+ elif file.endswith(('.part', '.utpart')) and not forced:
logger.info(
- "Looks like " + os.path.basename(albumpath).decode(headphones.SYS_ENCODING,
- 'replace') + " isn't complete yet. Will try again on the next run")
+ "Looks like " + os.path.basename(albumpath) + " isn't complete yet. Will try again on the next run")
return
# Force single file through
@@ -264,10 +266,7 @@ def verify(albumid, albumpath, Kind=None, forced=False, keep_original_folder=Fal
try:
f = MediaFile(downloaded_track)
except Exception as e:
- logger.info(
- u"Exception from MediaFile for: " + downloaded_track.decode(headphones.SYS_ENCODING,
- 'replace') + u" : " + unicode(
- e))
+ logger.info(f"Exception from MediaFile for {downloaded_track}: {e}")
continue
if not f.artist:
@@ -275,10 +274,10 @@ def verify(albumid, albumpath, Kind=None, forced=False, keep_original_folder=Fal
if not f.album:
continue
- metaartist = helpers.latinToAscii(f.artist.lower()).encode('UTF-8')
- dbartist = helpers.latinToAscii(release['ArtistName'].lower()).encode('UTF-8')
- metaalbum = helpers.latinToAscii(f.album.lower()).encode('UTF-8')
- dbalbum = helpers.latinToAscii(release['AlbumTitle'].lower()).encode('UTF-8')
+ metaartist = helpers.latinToAscii(f.artist.lower())
+ dbartist = helpers.latinToAscii(release['ArtistName'].lower())
+ metaalbum = helpers.latinToAscii(f.album.lower())
+ dbalbum = helpers.latinToAscii(release['AlbumTitle'].lower())
logger.debug('Matching metadata artist: %s with artist name: %s' % (metaartist, dbartist))
logger.debug('Matching metadata album: %s with album name: %s' % (metaalbum, dbalbum))
@@ -298,8 +297,8 @@ def verify(albumid, albumpath, Kind=None, forced=False, keep_original_folder=Fal
if not track['TrackTitle']:
continue
- dbtrack = helpers.latinToAscii(track['TrackTitle'].lower()).encode('UTF-8')
- filetrack = helpers.latinToAscii(split_track_name).encode('UTF-8')
+ dbtrack = helpers.latinToAscii(track['TrackTitle'].lower())
+ filetrack = helpers.latinToAscii(split_track_name)
logger.debug('Checking if track title: %s is in file name: %s' % (dbtrack, filetrack))
if dbtrack in filetrack:
@@ -340,11 +339,9 @@ def verify(albumid, albumpath, Kind=None, forced=False, keep_original_folder=Fal
keep_original_folder, forced, single)
return
- logger.warn(u'Could not identify album: %s. It may not be the intended album.',
- albumpath.decode(headphones.SYS_ENCODING, 'replace'))
+ logger.warn(f"Could not identify {albumpath}. It may not be the intended album")
markAsUnprocessed(albumid, albumpath, keep_original_folder)
-
def markAsUnprocessed(albumid, albumpath, keep_original_folder=False):
myDB = db.DBConnection()
myDB.action(
@@ -354,13 +351,19 @@ def markAsUnprocessed(albumid, albumpath, keep_original_folder=False):
if headphones.CONFIG.RENAME_UNPROCESSED and not keep_original_folder:
renameUnprocessedFolder(albumpath, tag="Unprocessed")
else:
- logger.warn(u"Won't rename %s to mark as 'Unprocessed', because it is disabled or folder is being kept.",
- albumpath.decode(headphones.SYS_ENCODING, 'replace'))
+ logger.warn(
+ f"Won't rename {albumpath} to mark as 'Unprocessed', "
+ f"because it is disabled or folder is being kept."
+ )
+ return
def doPostProcessing(albumid, albumpath, release, tracks, downloaded_track_list, Kind=None,
keep_original_folder=False, forced=False, single=False):
- logger.info('Starting post-processing for: %s - %s' % (release['ArtistName'], release['AlbumTitle']))
+ logger.info(
+ f"Starting post-processing for: {release['ArtistName']} - "
+ f"{release['AlbumTitle']}"
+ )
new_folder = None
# Preserve the torrent dir
@@ -393,12 +396,10 @@ def doPostProcessing(albumid, albumpath, release, tracks, downloaded_track_list,
f = MediaFile(downloaded_track)
builder.add_media_file(f)
except (FileTypeError, UnreadableFileError):
- logger.error("Track file is not a valid media file: %s. Not continuing.",
- downloaded_track.decode(headphones.SYS_ENCODING, "replace"))
+ logger.error(f"`{downloaded_track}` is not a valid media file. Not continuing.")
return
except IOError:
- logger.error("Unable to find media file: %s. Not continuing.", downloaded_track.decode(
- headphones.SYS_ENCODING, "replace"))
+ logger.error(f"Unable to find `{downloaded_track}`. Not continuing.")
if new_folder:
shutil.rmtree(new_folder)
return
@@ -416,9 +417,10 @@ def doPostProcessing(albumid, albumpath, release, tracks, downloaded_track_list,
fp.seek(0)
except IOError as e:
logger.debug("Write check exact error: %s", e)
- logger.error("Track file is not writable. This is required "
- "for some post processing steps: %s. Not continuing.",
- downloaded_track.decode(headphones.SYS_ENCODING, "replace"))
+ logger.error(
+ f"`{downloaded_track}` is not writable. This is required "
+ "for some post processing steps. Not continuing."
+ )
if new_folder:
shutil.rmtree(new_folder)
return
@@ -475,7 +477,8 @@ def doPostProcessing(albumid, albumpath, release, tracks, downloaded_track_list,
else:
albumpaths = [albumpath]
- updateFilePermissions(albumpaths)
+ if headphones.CONFIG.FILE_PERMISSIONS_ENABLED:
+ updateFilePermissions(albumpaths)
myDB = db.DBConnection()
myDB.action('UPDATE albums SET status = "Downloaded" WHERE AlbumID=?', [albumid])
@@ -491,7 +494,7 @@ def doPostProcessing(albumid, albumpath, release, tracks, downloaded_track_list,
if seed_snatched:
hash = seed_snatched['TorrentHash']
torrent_removed = False
- logger.info(u'%s - %s. Checking if torrent has finished seeding and can be removed' % (
+ logger.info('%s - %s. Checking if torrent has finished seeding and can be removed' % (
release['ArtistName'], release['AlbumTitle']))
if headphones.CONFIG.TORRENT_DOWNLOADER == 1:
torrent_removed = transmission.removeTorrent(hash, True)
@@ -517,18 +520,18 @@ def doPostProcessing(albumid, albumpath, release, tracks, downloaded_track_list,
ArtistName=release['ArtistName'])
logger.info(
- u'Post-processing for %s - %s complete' % (release['ArtistName'], release['AlbumTitle']))
+ 'Post-processing for %s - %s complete' % (release['ArtistName'], release['AlbumTitle']))
pushmessage = release['ArtistName'] + ' - ' + release['AlbumTitle']
statusmessage = "Download and Postprocessing completed"
if headphones.CONFIG.GROWL_ENABLED:
- logger.info(u"Growl request")
+ logger.info("Growl request")
growl = notifiers.GROWL()
growl.notify(pushmessage, statusmessage)
if headphones.CONFIG.PROWL_ENABLED:
- logger.info(u"Prowl request")
+ logger.info("Prowl request")
prowl = notifiers.PROWL()
prowl.notify(pushmessage, statusmessage)
@@ -559,7 +562,7 @@ def doPostProcessing(albumid, albumpath, release, tracks, downloaded_track_list,
nma.notify(release['ArtistName'], release['AlbumTitle'])
if headphones.CONFIG.PUSHALOT_ENABLED:
- logger.info(u"Pushalot request")
+ logger.info("Pushalot request")
pushalot = notifiers.PUSHALOT()
pushalot.notify(pushmessage, statusmessage)
@@ -569,35 +572,36 @@ def doPostProcessing(albumid, albumpath, release, tracks, downloaded_track_list,
syno.notify(albumpath)
if headphones.CONFIG.PUSHOVER_ENABLED:
- logger.info(u"Pushover request")
+ logger.info("Pushover request")
pushover = notifiers.PUSHOVER()
pushover.notify(pushmessage, "Headphones")
if headphones.CONFIG.PUSHBULLET_ENABLED:
- logger.info(u"PushBullet request")
+ logger.info("PushBullet request")
pushbullet = notifiers.PUSHBULLET()
pushbullet.notify(pushmessage, statusmessage)
if headphones.CONFIG.JOIN_ENABLED:
- logger.info(u"Join request")
+ logger.info("Join request")
join = notifiers.JOIN()
join.notify(pushmessage, statusmessage)
if headphones.CONFIG.TELEGRAM_ENABLED:
- logger.info(u"Telegram request")
+ logger.info("Telegram request")
telegram = notifiers.TELEGRAM()
telegram.notify(statusmessage, pushmessage)
if headphones.CONFIG.TWITTER_ENABLED:
- logger.info(u"Sending Twitter notification")
- twitter = notifiers.TwitterNotifier()
- twitter.notify_download(pushmessage)
+ logger.info("Twitter notifications temporarily disabled")
+ #logger.info("Sending Twitter notification")
+ #twitter = notifiers.TwitterNotifier()
+ #twitter.notify_download(pushmessage)
if headphones.CONFIG.OSX_NOTIFY_ENABLED:
from headphones import cache
c = cache.Cache()
album_art = c.get_artwork_from_cache(None, release['AlbumID'])
- logger.info(u"Sending OS X notification")
+ logger.info("Sending OS X notification")
osx_notify = notifiers.OSX_NOTIFY()
osx_notify.notify(release['ArtistName'],
release['AlbumTitle'],
@@ -605,13 +609,13 @@ def doPostProcessing(albumid, albumpath, release, tracks, downloaded_track_list,
image=album_art)
if headphones.CONFIG.BOXCAR_ENABLED:
- logger.info(u"Sending Boxcar2 notification")
+ logger.info("Sending Boxcar2 notification")
boxcar = notifiers.BOXCAR()
boxcar.notify('Headphones processed: ' + pushmessage,
statusmessage, release['AlbumID'])
if headphones.CONFIG.SUBSONIC_ENABLED:
- logger.info(u"Sending Subsonic update")
+ logger.info("Sending Subsonic update")
subsonic = notifiers.SubSonicNotifier()
subsonic.notify(albumpaths)
@@ -620,7 +624,7 @@ def doPostProcessing(albumid, albumpath, release, tracks, downloaded_track_list,
mpc.notify()
if headphones.CONFIG.EMAIL_ENABLED:
- logger.info(u"Sending Email notification")
+ logger.info("Sending Email notification")
email = notifiers.Email()
subject = release['ArtistName'] + ' - ' + release['AlbumTitle']
email.notify(subject, "Download and Postprocessing completed")
@@ -636,23 +640,21 @@ def embedAlbumArt(artwork, downloaded_track_list):
try:
f = MediaFile(downloaded_track)
except:
- logger.error(u'Could not read %s. Not adding album art' % downloaded_track.decode(
- headphones.SYS_ENCODING, 'replace'))
+ logger.error(f"Could not read {downloaded_track}. Not adding album art")
continue
- logger.debug('Adding album art to: %s' % downloaded_track)
+ logger.debug(f"Adding album art to `{downloaded_track}`")
try:
f.art = artwork
f.save()
except Exception as e:
- logger.error(u'Error embedding album art to: %s. Error: %s' % (
- downloaded_track.decode(headphones.SYS_ENCODING, 'replace'), str(e)))
+ logger.error(f"Error embedding album art to `{downloaded_track}`: {e}")
continue
def addAlbumArt(artwork, albumpath, release, metadata_dict):
- logger.info('Adding album art to folder')
+ logger.info(f"Adding album art to `{albumpath}`")
md = metadata.album_metadata(albumpath, release, metadata_dict)
ext = ".jpg"
@@ -663,8 +665,7 @@ def addAlbumArt(artwork, albumpath, release, metadata_dict):
album_art_name = helpers.pattern_substitute(
headphones.CONFIG.ALBUM_ART_FORMAT.strip(), md) + ext
- album_art_name = helpers.replace_illegal_chars(album_art_name).encode(
- headphones.SYS_ENCODING, 'replace')
+ album_art_name = helpers.replace_illegal_chars(album_art_name)
if headphones.CONFIG.FILE_UNDERSCORES:
album_art_name = album_art_name.replace(' ', '_')
@@ -684,14 +685,13 @@ def cleanupFiles(albumpath):
logger.info('Cleaning up files')
for r, d, f in os.walk(albumpath):
- for files in f:
- if not any(files.lower().endswith('.' + x.lower()) for x in headphones.MEDIA_FORMATS):
- logger.debug('Removing: %s' % files)
+ for file in f:
+ if not any(file.lower().endswith('.' + x.lower()) for x in headphones.MEDIA_FORMATS):
+ logger.debug('Removing: %s' % file)
try:
- os.remove(os.path.join(r, files))
+ os.remove(os.path.join(r, file))
except Exception as e:
- logger.error(u'Could not remove file: %s. Error: %s' % (
- files.decode(headphones.SYS_ENCODING, 'replace'), e))
+ logger.error('Could not remove file: %s. Error: %s' % (file, e))
def renameNFO(albumpath):
@@ -701,19 +701,16 @@ def renameNFO(albumpath):
for file in f:
if file.lower().endswith('.nfo'):
if not file.lower().endswith('.orig.nfo'):
- logger.debug('Renaming: "%s" to "%s"' % (
- file.decode(headphones.SYS_ENCODING, 'replace'),
- file.decode(headphones.SYS_ENCODING, 'replace') + '-orig'))
try:
new_file_name = os.path.join(r, file)[:-3] + 'orig.nfo'
+ logger.debug(f"Renaming `{file}` to `{new_file_name}`")
os.rename(os.path.join(r, file), new_file_name)
except Exception as e:
- logger.error(u'Could not rename file: %s. Error: %s' % (
- os.path.join(r, file).decode(headphones.SYS_ENCODING, 'replace'), e))
+ logger.error(f"Could not rename {file}: {e}")
def moveFiles(albumpath, release, metadata_dict):
- logger.info("Moving files: %s" % albumpath)
+ logger.info(f"Moving files: `{albumpath}`")
md = metadata.album_metadata(albumpath, release, metadata_dict)
folder = helpers.pattern_substitute(
@@ -750,12 +747,8 @@ def moveFiles(albumpath, release, metadata_dict):
make_lossy_folder = False
make_lossless_folder = False
- lossy_destination_path = os.path.normpath(
- os.path.join(headphones.CONFIG.DESTINATION_DIR, folder)).encode(headphones.SYS_ENCODING,
- 'replace')
- lossless_destination_path = os.path.normpath(
- os.path.join(headphones.CONFIG.LOSSLESS_DESTINATION_DIR, folder)).encode(
- headphones.SYS_ENCODING, 'replace')
+ lossy_destination_path = os.path.join(headphones.CONFIG.DESTINATION_DIR, folder)
+ lossless_destination_path = os.path.join(headphones.CONFIG.LOSSLESS_DESTINATION_DIR, folder)
# If they set a destination dir for lossless media, only create the lossy folder if there is lossy media
if headphones.CONFIG.LOSSLESS_DESTINATION_DIR:
@@ -780,8 +773,9 @@ def moveFiles(albumpath, release, metadata_dict):
shutil.rmtree(lossless_destination_path)
except Exception as e:
logger.error(
- "Error deleting existing folder: %s. Creating duplicate folder. Error: %s" % (
- lossless_destination_path.decode(headphones.SYS_ENCODING, 'replace'), e))
+ f"Error deleting `{lossless_destination_path}`. "
+ f"Creating duplicate folder. Error: {e}"
+ )
create_duplicate_folder = True
if not headphones.CONFIG.REPLACE_EXISTING_FOLDERS or create_duplicate_folder:
@@ -791,8 +785,11 @@ def moveFiles(albumpath, release, metadata_dict):
while True:
newfolder = temp_folder + '[%i]' % i
lossless_destination_path = os.path.normpath(
- os.path.join(headphones.CONFIG.LOSSLESS_DESTINATION_DIR, newfolder)).encode(
- headphones.SYS_ENCODING, 'replace')
+ os.path.join(
+ headphones.CONFIG.LOSSLESS_DESTINATION_DIR,
+ newfolder
+ )
+ )
if os.path.exists(lossless_destination_path):
i += 1
else:
@@ -818,8 +815,9 @@ def moveFiles(albumpath, release, metadata_dict):
shutil.rmtree(lossy_destination_path)
except Exception as e:
logger.error(
- "Error deleting existing folder: %s. Creating duplicate folder. Error: %s" % (
- lossy_destination_path.decode(headphones.SYS_ENCODING, 'replace'), e))
+ f"Error deleting `{lossy_destination_path}`. "
+ f"Creating duplicate folder. Error: {e}"
+ )
create_duplicate_folder = True
if not headphones.CONFIG.REPLACE_EXISTING_FOLDERS or create_duplicate_folder:
@@ -829,8 +827,11 @@ def moveFiles(albumpath, release, metadata_dict):
while True:
newfolder = temp_folder + '[%i]' % i
lossy_destination_path = os.path.normpath(
- os.path.join(headphones.CONFIG.DESTINATION_DIR, newfolder)).encode(
- headphones.SYS_ENCODING, 'replace')
+ os.path.join(
+ headphones.CONFIG.DESTINATION_DIR,
+ newfolder
+ )
+ )
if os.path.exists(lossy_destination_path):
i += 1
else:
@@ -876,12 +877,11 @@ def moveFiles(albumpath, release, metadata_dict):
os.remove(file_to_move)
except Exception as e:
logger.error(
- "Error deleting file '" + file_to_move.decode(headphones.SYS_ENCODING,
- 'replace') + "' from source directory")
+ f"Error deleting `{file_to_move}` from source directory")
else:
- logger.error("Error copying '" + file_to_move.decode(headphones.SYS_ENCODING,
- 'replace') + "'. Not deleting from download directory")
-
+ logger.error(
+ f"Error copying `{file_to_move}`. "
+ f"Not deleting from download directory")
elif make_lossless_folder and not make_lossy_folder:
for file_to_move in files_to_move:
@@ -910,20 +910,20 @@ def moveFiles(albumpath, release, metadata_dict):
if headphones.CONFIG.FOLDER_PERMISSIONS_ENABLED:
try:
- os.chmod(os.path.normpath(temp_f).encode(headphones.SYS_ENCODING, 'replace'),
+ os.chmod(os.path.normpath(temp_f),
int(headphones.CONFIG.FOLDER_PERMISSIONS, 8))
except Exception as e:
- logger.error("Error trying to change permissions on folder: %s. %s",
- temp_f.decode(headphones.SYS_ENCODING, 'replace'), e)
+ logger.error(f"Error trying to change permissions on `{temp_f}`: {e}")
else:
- logger.debug("Not changing folder permissions, since it is disabled: %s",
- temp_f.decode(headphones.SYS_ENCODING, 'replace'))
+ logger.debug(
+ f"Not changing permissions on `{temp_f}`, "
+ "since it is disabled")
# If we failed to move all the files out of the directory, this will fail too
try:
shutil.rmtree(albumpath)
except Exception as e:
- logger.error('Could not remove directory: %s. %s', albumpath, e)
+ logger.error(f"Could not remove `{albumpath}`: {e}")
destination_paths = []
@@ -952,11 +952,15 @@ def correctMetadata(albumid, release, downloaded_track_list):
headphones.LOSSY_MEDIA_FORMATS):
lossy_items.append(beets.library.Item.from_path(downloaded_track))
else:
- logger.warn("Skipping: %s because it is not a mutagen friendly file format",
- downloaded_track.decode(headphones.SYS_ENCODING, 'replace'))
+ logger.warn(
+ f"Skipping `{downloaded_track}` because it is "
+ f"not a mutagen friendly file format"
+ )
+ continue
except Exception as e:
- logger.error("Beets couldn't create an Item from: %s - not a media file? %s",
- downloaded_track.decode(headphones.SYS_ENCODING, 'replace'), str(e))
+ logger.error(
+ f"Beets couldn't create an Item from `{downloaded_track}`: {e}")
+ continue
for items in [lossy_items, lossless_items]:
@@ -1018,11 +1022,9 @@ def correctMetadata(albumid, release, downloaded_track_list):
for item in items:
try:
item.write()
- logger.info("Successfully applied metadata to: %s",
- item.path.decode(headphones.SYS_ENCODING, 'replace'))
+ logger.info(f"Successfully applied metadata to `{item.path}`")
except Exception as e:
- logger.warn("Error writing metadata to '%s': %s",
- item.path.decode(headphones.SYS_ENCODING, 'replace'), str(e))
+ logger.warn(f"Error writing metadata to `{item.path}: {e}")
return False
return True
@@ -1048,11 +1050,11 @@ def embedLyrics(downloaded_track_list):
headphones.LOSSY_MEDIA_FORMATS):
lossy_items.append(beets.library.Item.from_path(downloaded_track))
else:
- logger.warn("Skipping: %s because it is not a mutagen friendly file format",
- downloaded_track.decode(headphones.SYS_ENCODING, 'replace'))
+ logger.warn(
+ f"Skipping `{downloaded_track}` because it is "
+ f"not a mutagen friendly file format")
except Exception as e:
- logger.error("Beets couldn't create an Item from: %s - not a media file? %s",
- downloaded_track.decode(headphones.SYS_ENCODING, 'replace'), str(e))
+ logger.error(f"Beets couldn't create an Item from `{downloaded_track}`: {e}")
for items in [lossy_items, lossless_items]:
@@ -1067,7 +1069,7 @@ def embedLyrics(downloaded_track_list):
if any(lyrics):
break
- lyrics = u"\n\n---\n\n".join([l for l in lyrics if l])
+ lyrics = "\n\n---\n\n".join([l for l in lyrics if l])
if lyrics:
logger.debug('Adding lyrics to: %s', item.title)
@@ -1099,8 +1101,7 @@ def renameFiles(albumpath, downloaded_track_list, release):
headphones.CONFIG.FILE_FORMAT.strip(), md
).replace('/', '_') + ext
- new_file_name = helpers.replace_illegal_chars(new_file_name).encode(
- headphones.SYS_ENCODING, 'replace')
+ new_file_name = helpers.replace_illegal_chars(new_file_name)
if headphones.CONFIG.FILE_UNDERSCORES:
new_file_name = new_file_name.replace(' ', '_')
@@ -1111,37 +1112,28 @@ def renameFiles(albumpath, downloaded_track_list, release):
new_file = os.path.join(albumpath, new_file_name)
if downloaded_track == new_file_name:
- logger.debug("Renaming for: " + downloaded_track.decode(
- headphones.SYS_ENCODING, 'replace') + " is not neccessary")
+ logger.debug(f"Renaming for {downloaded_track} is not neccessary")
continue
- logger.debug('Renaming %s ---> %s',
- downloaded_track.decode(headphones.SYS_ENCODING, 'replace'),
- new_file_name.decode(headphones.SYS_ENCODING, 'replace'))
+ logger.debug(f"Renaming {downloaded_track} ---> {new_file_name}")
try:
os.rename(downloaded_track, new_file)
except Exception as e:
- logger.error('Error renaming file: %s. Error: %s',
- downloaded_track.decode(headphones.SYS_ENCODING, 'replace'), e)
+ logger.error(f"Error renaming {downloaded_track}: {e}")
continue
def updateFilePermissions(albumpaths):
for folder in albumpaths:
- logger.info("Updating file permissions in %s", folder)
+ logger.info(f"Updating file permissions in `{folder}`")
for r, d, f in os.walk(folder):
for files in f:
full_path = os.path.join(r, files)
- if headphones.CONFIG.FILE_PERMISSIONS_ENABLED:
- try:
- os.chmod(full_path, int(headphones.CONFIG.FILE_PERMISSIONS, 8))
- except:
- logger.error("Could not change permissions for file: %s", full_path)
- continue
- else:
- logger.debug("Not changing file permissions, since it is disabled: %s",
- full_path.decode(headphones.SYS_ENCODING, 'replace'))
-
+ try:
+ os.chmod(full_path, int(headphones.CONFIG.FILE_PERMISSIONS, 8))
+ except:
+ logger.error(f"Could not change permissions for `{full_path}`")
+ continue
def renameUnprocessedFolder(path, tag):
"""
@@ -1168,18 +1160,16 @@ def forcePostProcess(dir=None, expand_subfolders=True, album_dir=None, keep_orig
ignored = 0
if album_dir:
- folders = [album_dir.encode(headphones.SYS_ENCODING, 'replace')]
+ folders = [album_dir]
else:
download_dirs = []
if dir:
- download_dirs.append(dir.encode(headphones.SYS_ENCODING, 'replace'))
+ download_dirs.append(dir)
if headphones.CONFIG.DOWNLOAD_DIR and not dir:
- download_dirs.append(
- headphones.CONFIG.DOWNLOAD_DIR.encode(headphones.SYS_ENCODING, 'replace'))
+ download_dirs.append(headphones.CONFIG.DOWNLOAD_DIR)
if headphones.CONFIG.DOWNLOAD_TORRENT_DIR and not dir:
- download_dirs.append(
- headphones.CONFIG.DOWNLOAD_TORRENT_DIR.encode(headphones.SYS_ENCODING, 'replace'))
+ download_dirs.append(headphones.CONFIG.DOWNLOAD_TORRENT_DIR)
# If DOWNLOAD_DIR and DOWNLOAD_TORRENT_DIR are the same, remove the duplicate to prevent us from trying to process the same folder twice.
download_dirs = list(set(download_dirs))
@@ -1223,7 +1213,7 @@ def forcePostProcess(dir=None, expand_subfolders=True, album_dir=None, keep_orig
myDB = db.DBConnection()
for folder in folders:
- folder_basename = os.path.basename(folder).decode(headphones.SYS_ENCODING, 'replace')
+ folder_basename = os.path.basename(folder)
logger.info('Processing: %s', folder_basename)
# Attempt 1: First try to see if there's a match in the snatched table,
diff --git a/headphones/qbittorrent.py b/headphones/qbittorrent.py
index f32c1155..236c9b00 100755
--- a/headphones/qbittorrent.py
+++ b/headphones/qbittorrent.py
@@ -13,9 +13,9 @@
# You should have received a copy of the GNU General Public License
# along with Headphones. If not, see .
-import urllib
-import urllib2
-import cookielib
+import urllib.request, urllib.parse, urllib.error
+import urllib.request, urllib.error, urllib.parse
+import http.cookiejar
import json
import time
import mimetypes
@@ -61,23 +61,23 @@ class qbittorrentclient(object):
self.version = 2
except Exception as e:
logger.warning("Error with qBittorrent v2 api, check settings or update, will try v1: %s" % e)
- self.cookiejar = cookielib.CookieJar()
+ self.cookiejar = http.cookiejar.CookieJar()
self.opener = self._make_opener()
self._get_sid(self.base_url, self.username, self.password)
self.version = 1
def _make_opener(self):
# create opener with cookie handler to carry QBitTorrent SID cookie
- cookie_handler = urllib2.HTTPCookieProcessor(self.cookiejar)
+ cookie_handler = urllib.request.HTTPCookieProcessor(self.cookiejar)
handlers = [cookie_handler]
- return urllib2.build_opener(*handlers)
+ return urllib.request.build_opener(*handlers)
def _get_sid(self, base_url, username, password):
# login so we can capture SID cookie
- login_data = urllib.urlencode({'username': username, 'password': password})
+ login_data = urllib.parse.urlencode({'username': username, 'password': password})
try:
self.opener.open(base_url + '/login', login_data)
- except urllib2.URLError as err:
+ except urllib.error.URLError as err:
logger.debug('Error getting SID. qBittorrent responded with error: ' + str(err.reason))
return
for cookie in self.cookiejar:
@@ -95,14 +95,14 @@ class qbittorrentclient(object):
data, headers = encode_multipart(args, files)
else:
if args:
- data = urllib.urlencode(args)
+ data = urllib.parse.urlencode(args)
if content_type:
headers['Content-Type'] = content_type
logger.debug('%s' % json.dumps(headers, indent=4))
logger.debug('%s' % data)
- request = urllib2.Request(url, data, headers)
+ request = urllib.request.Request(url, data, headers)
try:
response = self.opener.open(request)
info = response.info()
@@ -117,7 +117,7 @@ class qbittorrentclient(object):
return response.code, json.loads(resp)
logger.debug('response code: %s' % str(response.code))
return response.code, None
- except urllib2.URLError as err:
+ except urllib.error.URLError as err:
logger.debug('Failed URL: %s' % url)
logger.debug('QBitTorrent webUI raised the following error: %s' % str(err))
return None, None
@@ -319,7 +319,7 @@ def encode_multipart(args, files, boundary=None):
lines = []
if args:
- for name, value in args.items():
+ for name, value in list(args.items()):
lines.extend((
'--{0}'.format(boundary),
'Content-Disposition: form-data; name="{0}"'.format(escape_quote(name)),
@@ -329,7 +329,7 @@ def encode_multipart(args, files, boundary=None):
logger.debug(''.join(lines))
if files:
- for name, value in files.items():
+ for name, value in list(files.items()):
filename = value['filename']
if 'mimetype' in value:
mimetype = value['mimetype']
diff --git a/headphones/request.py b/headphones/request.py
index dac4ffb4..6b8a3630 100644
--- a/headphones/request.py
+++ b/headphones/request.py
@@ -138,7 +138,7 @@ def request_soup(url, **kwargs):
no exceptions are raised.
"""
- parser = kwargs.pop("parser", "html5lib")
+ parser = kwargs.pop("parser", "html.parser")
response = request_response(url, **kwargs)
if response is not None:
@@ -222,7 +222,7 @@ def server_message(response):
if response.headers.get("content-type") and \
"text/html" in response.headers.get("content-type"):
try:
- soup = BeautifulSoup(response.content, "html5lib")
+ soup = BeautifulSoup(response.content, "html.parser")
except Exception:
pass
diff --git a/headphones/rutracker.py b/headphones/rutracker.py
index a9407194..8c04d33f 100644
--- a/headphones/rutracker.py
+++ b/headphones/rutracker.py
@@ -1,8 +1,8 @@
#!/usr/bin/env python
-import urllib
+import urllib.request, urllib.parse, urllib.error
import time
-from urlparse import urlparse
+from urllib.parse import urlparse
import re
import requests as requests
@@ -68,10 +68,10 @@ class Rutracker(object):
return self.loggedin
def has_bb_session_cookie(self, response):
- if 'bb_session' in response.cookies.keys():
+ if 'bb_session' in list(response.cookies.keys()):
return True
# Rutracker randomly send a 302 redirect code, cookie may be present in response history
- return next(('bb_session' in r.cookies.keys() for r in response.history), False)
+ return next(('bb_session' in list(r.cookies.keys()) for r in response.history), False)
def searchurl(self, artist, album, year, format):
"""
@@ -99,10 +99,10 @@ class Rutracker(object):
# sort by size, descending.
sort = '&o=7&s=2'
try:
- searchurl = "%s?nm=%s%s%s" % (self.search_referer, urllib.quote(searchterm), format, sort)
+ searchurl = "%s?nm=%s%s%s" % (self.search_referer, urllib.parse.quote(searchterm), format, sort)
except:
searchterm = searchterm.encode('utf-8')
- searchurl = "%s?nm=%s%s%s" % (self.search_referer, urllib.quote(searchterm), format, sort)
+ searchurl = "%s?nm=%s%s%s" % (self.search_referer, urllib.parse.quote(searchterm), format, sort)
logger.info("Searching rutracker using term: %s", searchterm)
return searchurl
@@ -114,7 +114,7 @@ class Rutracker(object):
try:
headers = {'Referer': self.search_referer}
r = self.session.get(url=searchurl, headers=headers, timeout=self.timeout)
- soup = BeautifulSoup(r.content, 'html5lib')
+ soup = BeautifulSoup(r.content, 'html.parser')
# Debug
# logger.debug (soup.prettify())
@@ -123,7 +123,7 @@ class Rutracker(object):
if not self.still_logged_in(soup):
self.login()
r = self.session.get(url=searchurl, timeout=self.timeout)
- soup = BeautifulSoup(r.content, 'html5lib')
+ soup = BeautifulSoup(r.content, 'html.parser')
if not self.still_logged_in(soup):
logger.error("Error getting rutracker data")
return None
diff --git a/headphones/sab.py b/headphones/sab.py
index fa7c3309..01ef6e21 100644
--- a/headphones/sab.py
+++ b/headphones/sab.py
@@ -17,7 +17,7 @@
# Stolen from Sick-Beard's sab.py #
###################################
-import cookielib
+import http.cookiejar
import headphones
from headphones.common import USER_AGENT
@@ -74,29 +74,28 @@ def sendNZB(nzb):
# if we get a raw data result we want to upload it to SAB
elif nzb.resultType == "nzbdata":
- # Sanitize the file a bit, since we can only use ascii chars with MultiPartPostHandler
- nzbdata = helpers.latinToAscii(nzb.extraInfo[0])
+ nzbdata = nzb.extraInfo[0]
params['mode'] = 'addfile'
- files = {"nzbfile": (helpers.latinToAscii(nzb.name) + ".nzb", nzbdata)}
+ files = {"nzbfile": (nzb.name + ".nzb", nzbdata)}
headers = {'User-Agent': USER_AGENT}
logger.info("Attempting to connect to SABnzbd on url: %s" % headphones.CONFIG.SAB_HOST)
if nzb.resultType == "nzb":
response = sab_api_call('send_nzb', params=params)
elif nzb.resultType == "nzbdata":
- cookies = cookielib.CookieJar()
+ cookies = http.cookiejar.CookieJar()
response = sab_api_call('send_nzb', params=params, method="post", files=files,
cookies=cookies, headers=headers)
if not response:
- logger.info(u"No data returned from SABnzbd, NZB not sent")
+ logger.info("No data returned from SABnzbd, NZB not sent")
return False
if response['status']:
- logger.info(u"NZB sent to SABnzbd successfully")
+ logger.info("NZB sent to SABnzbd successfully")
return True
else:
- logger.error(u"Error sending NZB to SABnzbd: %s" % response['error'])
+ logger.error("Error sending NZB to SABnzbd: %s" % response['error'])
return False
diff --git a/headphones/searcher.py b/headphones/searcher.py
index 499b69b8..fbb4826d 100644
--- a/headphones/searcher.py
+++ b/headphones/searcher.py
@@ -19,11 +19,11 @@ from base64 import b16encode, b32decode
from hashlib import sha1
import string
import random
-import urllib
+import urllib.request, urllib.parse, urllib.error
import datetime
import subprocess
import unicodedata
-import urlparse
+import urllib.parse
import os
import re
@@ -35,7 +35,8 @@ import headphones
from headphones.common import USER_AGENT
from headphones import logger, db, helpers, classes, sab, nzbget, request
from headphones import utorrent, transmission, notifiers, rutracker, deluge, qbittorrent
-from bencode import bencode, bdecode
+from bencode import encode as bencode
+from bencode import decode as bdecode
# Magnet to torrent services, for Black hole. Stolen from CouchPotato.
TORRENT_TO_MAGNET_SERVICES = [
@@ -56,14 +57,11 @@ def fix_url(s, charset="utf-8"):
Fix the URL so it is proper formatted and encoded.
"""
- if isinstance(s, unicode):
- s = s.encode(charset, 'ignore')
+ scheme, netloc, path, qs, anchor = urllib.parse.urlsplit(s)
+ path = urllib.parse.quote(path, '/%')
+ qs = urllib.parse.quote_plus(qs, ':&=')
- scheme, netloc, path, qs, anchor = urlparse.urlsplit(s)
- path = urllib.quote(path, '/%')
- qs = urllib.quote_plus(qs, ':&=')
-
- return urlparse.urlunsplit((scheme, netloc, path, qs, anchor))
+ return urllib.parse.urlunsplit((scheme, netloc, path, qs, anchor))
def torrent_to_file(target_file, data):
@@ -88,14 +86,10 @@ def torrent_to_file(target_file, data):
try:
os.chmod(target_file, int(headphones.CONFIG.FILE_PERMISSIONS, 8))
except OSError as e:
- logger.warn(
- "Could not change permissions for file '%s': %s. Continuing.",
- target_file.decode(headphones.SYS_ENCODING, "replace"),
- e.message)
+ logger.warn(f"Could not change permissions for `{target_file}`: {e}")
else:
logger.debug(
- "Not changing file permissions, since it is disabled: %s",
- target_file.decode(headphones.SYS_ENCODING, "replace"))
+ f"Not changing file permissions for `{target_file}, since it is disabled")
# Done
return True
@@ -332,19 +326,13 @@ def do_sorted_search(album, new, losslessOnly, choose_specific_download=False):
if not sorted_search_results:
return
- logger.info(u"Making sure we can download the best result")
+ logger.info("Making sure we can download the best result")
(data, bestqual) = preprocess(sorted_search_results)
if data and bestqual:
send_to_downloader(data, bestqual, album)
-def removeDisallowedFilenameChars(filename):
- validFilenameChars = "-_.() %s%s" % (string.ascii_letters, string.digits)
- cleanedFilename = unicodedata.normalize('NFKD', filename).encode('ASCII', 'ignore').lower()
- return ''.join(c for c in cleanedFilename if c in validFilenameChars)
-
-
def more_filtering(results, album, albumlength, new):
low_size_limit = None
high_size_limit = None
@@ -533,9 +521,9 @@ def searchNZB(album, new=False, losslessOnly=False, albumlength=None,
else:
term = cleanartist + ' ' + cleanalbum
- # Replace bad characters in the term and unicode it
- term = re.sub('[\.\-\/]', ' ', term).encode('utf-8')
- artistterm = re.sub('[\.\-\/]', ' ', cleanartist).encode('utf-8')
+ # Replace bad characters in the term
+ term = re.sub('[\.\-\/]', ' ', term)
+ artistterm = re.sub('[\.\-\/]', ' ', cleanartist)
# If Preferred Bitrate and High Limit and Allow Lossless then get both lossy and lossless
if headphones.CONFIG.PREFERRED_QUALITY == 2 and headphones.CONFIG.PREFERRED_BITRATE and headphones.CONFIG.PREFERRED_BITRATE_HIGH_BUFFER and headphones.CONFIG.PREFERRED_BITRATE_ALLOW_LOSSLESS:
@@ -582,7 +570,7 @@ def searchNZB(album, new=False, losslessOnly=False, albumlength=None,
# Process feed
if data:
if not len(data.entries):
- logger.info(u"No results found from %s for %s" % ('Headphones Index', term))
+ logger.info("No results found from %s for %s" % ('Headphones Index', term))
else:
for item in data.entries:
try:
@@ -593,7 +581,7 @@ def searchNZB(album, new=False, losslessOnly=False, albumlength=None,
resultlist.append((title, size, url, provider, 'nzb', True))
logger.info('Found %s. Size: %s' % (title, helpers.bytes_to_mb(size)))
except Exception as e:
- logger.error(u"An unknown error occurred trying to parse the feed: %s" % e)
+ logger.error("An unknown error occurred trying to parse the feed: %s" % e)
if headphones.CONFIG.NEWZNAB:
provider = "newznab"
@@ -653,7 +641,7 @@ def searchNZB(album, new=False, losslessOnly=False, albumlength=None,
# Process feed
if data:
if not len(data.entries):
- logger.info(u"No results found from %s for %s", newznab_host[0], term)
+ logger.info("No results found from %s for %s", newznab_host[0], term)
else:
for item in data.entries:
try:
@@ -703,7 +691,7 @@ def searchNZB(album, new=False, losslessOnly=False, albumlength=None,
# Process feed
if data:
if not len(data.entries):
- logger.info(u"No results found from nzbs.org for %s" % term)
+ logger.info("No results found from nzbs.org for %s" % term)
else:
for item in data.entries:
try:
@@ -750,7 +738,7 @@ def searchNZB(album, new=False, losslessOnly=False, albumlength=None,
# Parse response
if data:
if 'notice' in data:
- logger.info(u"No results returned from omgwtfnzbs: %s" % data['notice'])
+ logger.info("No results returned from omgwtfnzbs: %s" % data['notice'])
else:
for item in data:
try:
@@ -780,7 +768,7 @@ def searchNZB(album, new=False, losslessOnly=False, albumlength=None,
def send_to_downloader(data, bestqual, album):
- logger.info(u'Found best result from %s: %s - %s', bestqual[3], bestqual[2],
+ logger.info('Found best result from %s: %s - %s', bestqual[3], bestqual[2],
bestqual[0], helpers.bytes_to_mb(bestqual[1]))
# Get rid of any dodgy chars here so we can prevent sab from renaming our downloads
kind = bestqual[4]
@@ -831,8 +819,8 @@ def send_to_downloader(data, bestqual, album):
return
else:
folder_name = '%s - %s [%s]' % (
- helpers.latinToAscii(album['ArtistName']).encode('UTF-8').replace('/', '_'),
- helpers.latinToAscii(album['AlbumTitle']).encode('UTF-8').replace('/', '_'),
+ helpers.latinToAscii(album['ArtistName']).replace('/', '_'),
+ helpers.latinToAscii(album['AlbumTitle']).replace('/', '_'),
get_year_from_release_date(album['ReleaseDate']))
# Blackhole
@@ -1058,31 +1046,31 @@ def send_to_downloader(data, bestqual, album):
name = folder_name if folder_name else None
if headphones.CONFIG.GROWL_ENABLED and headphones.CONFIG.GROWL_ONSNATCH:
- logger.info(u"Sending Growl notification")
+ logger.info("Sending Growl notification")
growl = notifiers.GROWL()
growl.notify(name, "Download started")
if headphones.CONFIG.PROWL_ENABLED and headphones.CONFIG.PROWL_ONSNATCH:
- logger.info(u"Sending Prowl notification")
+ logger.info("Sending Prowl notification")
prowl = notifiers.PROWL()
prowl.notify(name, "Download started")
if headphones.CONFIG.PUSHOVER_ENABLED and headphones.CONFIG.PUSHOVER_ONSNATCH:
- logger.info(u"Sending Pushover notification")
+ logger.info("Sending Pushover notification")
prowl = notifiers.PUSHOVER()
prowl.notify(name, "Download started")
if headphones.CONFIG.PUSHBULLET_ENABLED and headphones.CONFIG.PUSHBULLET_ONSNATCH:
- logger.info(u"Sending PushBullet notification")
+ logger.info("Sending PushBullet notification")
pushbullet = notifiers.PUSHBULLET()
pushbullet.notify(name, "Download started")
if headphones.CONFIG.JOIN_ENABLED and headphones.CONFIG.JOIN_ONSNATCH:
- logger.info(u"Sending Join notification")
+ logger.info("Sending Join notification")
join = notifiers.JOIN()
join.notify(name, "Download started")
if headphones.CONFIG.SLACK_ENABLED and headphones.CONFIG.SLACK_ONSNATCH:
- logger.info(u"Sending Slack notification")
+ logger.info("Sending Slack notification")
slack = notifiers.SLACK()
slack.notify(name, "Download started")
if headphones.CONFIG.TELEGRAM_ENABLED and headphones.CONFIG.TELEGRAM_ONSNATCH:
- logger.info(u"Sending Telegram notification")
+ logger.info("Sending Telegram notification")
from headphones import cache
c = cache.Cache()
album_art = c.get_artwork_from_cache(None, rgid)
@@ -1090,34 +1078,35 @@ def send_to_downloader(data, bestqual, album):
message = 'Snatched from ' + provider + '. ' + name
telegram.notify(message, "Snatched: " + title, rgid, image=album_art)
if headphones.CONFIG.TWITTER_ENABLED and headphones.CONFIG.TWITTER_ONSNATCH:
- logger.info(u"Sending Twitter notification")
- twitter = notifiers.TwitterNotifier()
- twitter.notify_snatch(name)
+ logger.info("Twitter notifications temporarily disabled")
+ #logger.info("Sending Twitter notification")
+ #twitter = notifiers.TwitterNotifier()
+ #twitter.notify_snatch(name)
if headphones.CONFIG.NMA_ENABLED and headphones.CONFIG.NMA_ONSNATCH:
- logger.info(u"Sending NMA notification")
+ logger.info("Sending NMA notification")
nma = notifiers.NMA()
nma.notify(snatched=name)
if headphones.CONFIG.PUSHALOT_ENABLED and headphones.CONFIG.PUSHALOT_ONSNATCH:
- logger.info(u"Sending Pushalot notification")
+ logger.info("Sending Pushalot notification")
pushalot = notifiers.PUSHALOT()
pushalot.notify(name, "Download started")
if headphones.CONFIG.OSX_NOTIFY_ENABLED and headphones.CONFIG.OSX_NOTIFY_ONSNATCH:
from headphones import cache
c = cache.Cache()
album_art = c.get_artwork_from_cache(None, rgid)
- logger.info(u"Sending OS X notification")
+ logger.info("Sending OS X notification")
osx_notify = notifiers.OSX_NOTIFY()
osx_notify.notify(artist,
albumname,
'Snatched: ' + provider + '. ' + name,
image=album_art)
if headphones.CONFIG.BOXCAR_ENABLED and headphones.CONFIG.BOXCAR_ONSNATCH:
- logger.info(u"Sending Boxcar2 notification")
+ logger.info("Sending Boxcar2 notification")
b2msg = 'From ' + provider + '
' + name
boxcar = notifiers.BOXCAR()
boxcar.notify('Headphones snatched: ' + title, b2msg, rgid)
if headphones.CONFIG.EMAIL_ENABLED and headphones.CONFIG.EMAIL_ONSNATCH:
- logger.info(u"Sending Email notification")
+ logger.info("Sending Email notification")
email = notifiers.Email()
message = 'Snatched from ' + provider + '. ' + name
email.notify("Snatched: " + title, message)
@@ -1252,12 +1241,12 @@ def searchTorrent(album, new=False, losslessOnly=False, albumlength=None,
else:
usersearchterm = ''
- semi_clean_artist_term = re.sub('[\.\-\/]', ' ', semi_cleanartist).encode('utf-8', 'replace')
- semi_clean_album_term = re.sub('[\.\-\/]', ' ', semi_cleanalbum).encode('utf-8', 'replace')
- # Replace bad characters in the term and unicode it
- term = re.sub('[\.\-\/]', ' ', term).encode('utf-8')
- artistterm = re.sub('[\.\-\/]', ' ', cleanartist).encode('utf-8', 'replace')
- albumterm = re.sub('[\.\-\/]', ' ', cleanalbum).encode('utf-8', 'replace')
+ semi_clean_artist_term = re.sub('[\.\-\/]', ' ', semi_cleanartist)
+ semi_clean_album_term = re.sub('[\.\-\/]', ' ', semi_cleanalbum)
+ # Replace bad characters in the term
+ term = re.sub('[\.\-\/]', ' ', term)
+ artistterm = re.sub('[\.\-\/]', ' ', cleanartist)
+ albumterm = re.sub('[\.\-\/]', ' ', cleanalbum)
# If Preferred Bitrate and High Limit and Allow Lossless then get both lossy and lossless
if headphones.CONFIG.PREFERRED_QUALITY == 2 and headphones.CONFIG.PREFERRED_BITRATE and headphones.CONFIG.PREFERRED_BITRATE_HIGH_BUFFER and headphones.CONFIG.PREFERRED_BITRATE_ALLOW_LOSSLESS:
@@ -1333,7 +1322,7 @@ def searchTorrent(album, new=False, losslessOnly=False, albumlength=None,
if data:
items = data.find_all('item')
if not items:
- logger.info(u"No results found from %s for %s", provider, term)
+ logger.info("No results found from %s for %s", provider, term)
else:
for item in items:
try:
@@ -1427,7 +1416,7 @@ def searchTorrent(album, new=False, losslessOnly=False, albumlength=None,
# Process feed
if data:
if not len(data.entries):
- logger.info(u"No results found from %s for %s", provider, term)
+ logger.info("No results found from %s for %s", provider, term)
else:
for item in data.entries:
try:
@@ -1439,7 +1428,7 @@ def searchTorrent(album, new=False, losslessOnly=False, albumlength=None,
logger.info('Found %s. Size: %s', title, helpers.bytes_to_mb(size))
except Exception as e:
logger.error(
- u"An error occurred while trying to parse the response from Waffles.ch: %s",
+ "An error occurred while trying to parse the response from Waffles.ch: %s",
e)
# rutracker.org
@@ -1448,7 +1437,7 @@ def searchTorrent(album, new=False, losslessOnly=False, albumlength=None,
# Ignore if release date not specified, results too unpredictable
if not year and not usersearchterm:
- logger.info(u"Release date not specified, ignoring for rutracker.org")
+ logger.info("Release date not specified, ignoring for rutracker.org")
else:
if headphones.CONFIG.PREFERRED_QUALITY == 3 or losslessOnly:
format = 'lossless'
@@ -1501,7 +1490,7 @@ def searchTorrent(album, new=False, losslessOnly=False, albumlength=None,
bitrate_string = encoding_string
if bitrate_string not in gazelleencoding.ALL_ENCODINGS:
logger.info(
- u"Your preferred bitrate is not one of the available Orpheus.network filters, so not using it as a search parameter.")
+ "Your preferred bitrate is not one of the available Orpheus.network filters, so not using it as a search parameter.")
maxsize = 10000000000
elif headphones.CONFIG.PREFERRED_QUALITY == 1 or allow_lossless: # Highest quality including lossless
search_formats = [gazelleformat.FLAC, gazelleformat.MP3]
@@ -1512,18 +1501,18 @@ def searchTorrent(album, new=False, losslessOnly=False, albumlength=None,
if not orpheusobj or not orpheusobj.logged_in():
try:
- logger.info(u"Attempting to log in to Orpheus.network...")
+ logger.info("Attempting to log in to Orpheus.network...")
orpheusobj = gazelleapi.GazelleAPI(headphones.CONFIG.ORPHEUS_USERNAME,
headphones.CONFIG.ORPHEUS_PASSWORD,
headphones.CONFIG.ORPHEUS_URL)
orpheusobj._login()
except Exception as e:
orpheusobj = None
- logger.error(u"Orpheus.network credentials incorrect or site is down. Error: %s %s" % (
+ logger.error("Orpheus.network credentials incorrect or site is down. Error: %s %s" % (
e.__class__.__name__, str(e)))
if orpheusobj and orpheusobj.logged_in():
- logger.info(u"Searching %s..." % provider)
+ logger.info("Searching %s..." % provider)
all_torrents = []
album_type = ""
@@ -1570,18 +1559,18 @@ def searchTorrent(album, new=False, losslessOnly=False, albumlength=None,
releasetype=album_type)['results'])
# filter on format, size, and num seeders
- logger.info(u"Filtering torrents by format, maximum size, and minimum seeders...")
+ logger.info("Filtering torrents by format, maximum size, and minimum seeders...")
match_torrents = [t for t in all_torrents if
t.size <= maxsize and t.seeders >= minimumseeders]
logger.info(
- u"Remaining torrents: %s" % ", ".join(repr(torrent) for torrent in match_torrents))
+ "Remaining torrents: %s" % ", ".join(repr(torrent) for torrent in match_torrents))
# sort by times d/l'd
if not len(match_torrents):
- logger.info(u"No results found from %s for %s after filtering" % (provider, term))
+ logger.info("No results found from %s for %s after filtering" % (provider, term))
elif len(match_torrents) > 1:
- logger.info(u"Found %d matching releases from %s for %s - %s after filtering" %
+ logger.info("Found %d matching releases from %s for %s - %s after filtering" %
(len(match_torrents), provider, artistterm, albumterm))
logger.info('Sorting torrents by number of seeders...')
match_torrents.sort(key=lambda x: int(x.seeders), reverse=True)
@@ -1595,7 +1584,7 @@ def searchTorrent(album, new=False, losslessOnly=False, albumlength=None,
# match_torrents.sort(key=lambda x: re.match("mp3", x.getTorrentDetails(), flags=re.I), reverse=True)
# match_torrents.sort(key=lambda x: str(bitrate) in x.getTorrentFolderName(), reverse=True)
logger.info(
- u"New order: %s" % ", ".join(repr(torrent) for torrent in match_torrents))
+ "New order: %s" % ", ".join(repr(torrent) for torrent in match_torrents))
for torrent in match_torrents:
if not torrent.file_path:
@@ -1632,7 +1621,7 @@ def searchTorrent(album, new=False, losslessOnly=False, albumlength=None,
bitrate_string = encoding_string
if bitrate_string not in gazelleencoding.ALL_ENCODINGS:
logger.info(
- u"Your preferred bitrate is not one of the available RED filters, so not using it as a search parameter.")
+ "Your preferred bitrate is not one of the available RED filters, so not using it as a search parameter.")
maxsize = 10000000000
elif headphones.CONFIG.PREFERRED_QUALITY == 1 or allow_lossless: # Highest quality including lossless
search_formats = [gazelleformat.FLAC, gazelleformat.MP3]
@@ -1643,18 +1632,18 @@ def searchTorrent(album, new=False, losslessOnly=False, albumlength=None,
if not redobj or not redobj.logged_in():
try:
- logger.info(u"Attempting to log in to Redacted...")
+ logger.info("Attempting to log in to Redacted...")
redobj = gazelleapi.GazelleAPI(headphones.CONFIG.REDACTED_USERNAME,
headphones.CONFIG.REDACTED_PASSWORD,
providerurl)
redobj._login()
except Exception as e:
redobj = None
- logger.error(u"Redacted credentials incorrect or site is down. Error: %s %s" % (
+ logger.error("Redacted credentials incorrect or site is down. Error: %s %s" % (
e.__class__.__name__, str(e)))
if redobj and redobj.logged_in():
- logger.info(u"Searching %s..." % provider)
+ logger.info("Searching %s..." % provider)
all_torrents = []
for search_format in search_formats:
if usersearchterm:
@@ -1668,18 +1657,18 @@ def searchTorrent(album, new=False, losslessOnly=False, albumlength=None,
encoding=bitrate_string)['results'])
# filter on format, size, and num seeders
- logger.info(u"Filtering torrents by format, maximum size, and minimum seeders...")
+ logger.info("Filtering torrents by format, maximum size, and minimum seeders...")
match_torrents = [t for t in all_torrents if
t.size <= maxsize and t.seeders >= minimumseeders]
logger.info(
- u"Remaining torrents: %s" % ", ".join(repr(torrent) for torrent in match_torrents))
+ "Remaining torrents: %s" % ", ".join(repr(torrent) for torrent in match_torrents))
# sort by times d/l'd
if not len(match_torrents):
- logger.info(u"No results found from %s for %s after filtering" % (provider, term))
+ logger.info("No results found from %s for %s after filtering" % (provider, term))
elif len(match_torrents) > 1:
- logger.info(u"Found %d matching releases from %s for %s - %s after filtering" %
+ logger.info("Found %d matching releases from %s for %s - %s after filtering" %
(len(match_torrents), provider, artistterm, albumterm))
logger.info(
"Sorting torrents by times snatched and preferred bitrate %s..." % bitrate_string)
@@ -1695,7 +1684,7 @@ def searchTorrent(album, new=False, losslessOnly=False, albumlength=None,
# match_torrents.sort(key=lambda x: re.match("mp3", x.getTorrentDetails(), flags=re.I), reverse=True)
# match_torrents.sort(key=lambda x: str(bitrate) in x.getTorrentFolderName(), reverse=True)
logger.info(
- u"New order: %s" % ", ".join(repr(torrent) for torrent in match_torrents))
+ "New order: %s" % ", ".join(repr(torrent) for torrent in match_torrents))
for torrent in match_torrents:
if not torrent.file_path:
@@ -1767,8 +1756,8 @@ def searchTorrent(album, new=False, losslessOnly=False, albumlength=None,
if url.lower().startswith("//"):
url = "http:" + url
- formatted_size = re.search('Size (.*),', unicode(item)).group(1).replace(
- u'\xa0', ' ')
+ formatted_size = re.search('Size (.*),', str(item)).group(1).replace(
+ '\xa0', ' ')
size = helpers.piratesize(formatted_size)
if size < maxsize and minimumseeders < seeds and url is not None:
@@ -1781,7 +1770,7 @@ def searchTorrent(album, new=False, losslessOnly=False, albumlength=None,
resultlist.append((title, size, url, provider, "torrent", match))
except Exception as e:
- logger.error(u"An unknown error occurred in the Pirate Bay parser: %s" % e)
+ logger.error("An unknown error occurred in the Pirate Bay parser: %s" % e)
# Old Pirate Bay Compatible
if headphones.CONFIG.OLDPIRATEBAY:
@@ -1802,7 +1791,7 @@ def searchTorrent(album, new=False, losslessOnly=False, albumlength=None,
headers = {
'User-Agent': 'Mozilla/5.0 (Windows NT 6.3; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2243.2 Safari/537.36'}
provider_url = fix_url(headphones.CONFIG.OLDPIRATEBAY_URL) + \
- "/search.php?" + urllib.urlencode({"q": tpb_term, "iht": 6})
+ "/search.php?" + urllib.parse.urlencode({"q": tpb_term, "iht": 6})
data = request.request_soup(url=provider_url, headers=headers)
@@ -1836,7 +1825,7 @@ def searchTorrent(album, new=False, losslessOnly=False, albumlength=None,
resultlist.append((title, size, url, provider, "torrent", match))
except Exception as e:
logger.error(
- u"An unknown error occurred in the Old Pirate Bay parser: %s" % e)
+ "An unknown error occurred in the Old Pirate Bay parser: %s" % e)
# attempt to verify that this isn't a substring result
# when looking for "Foo - Foo" we don't want "Foobar"
diff --git a/headphones/softchroot_test.py b/headphones/softchroot_test.py
index b310ce12..7a9b0831 100644
--- a/headphones/softchroot_test.py
+++ b/headphones/softchroot_test.py
@@ -38,8 +38,8 @@ class SoftChrootTest(TestCase):
cf = SoftChroot(path)
self.assertIsNone(cf)
- self.assertRegexpMatches(str(exc.exception), r'No such directory')
- self.assertRegexpMatches(str(exc.exception), path)
+ self.assertRegex(str(exc.exception), r'No such directory')
+ self.assertRegex(str(exc.exception), path)
@mock.patch('headphones.softchroot.os', wrap=os, name='OsMock')
def test_create_on_file(self, os_mock):
@@ -57,8 +57,8 @@ class SoftChrootTest(TestCase):
self.assertTrue(os_mock.path.isdir.called)
- self.assertRegexpMatches(str(exc.exception), r'No such directory')
- self.assertRegexpMatches(str(exc.exception), path)
+ self.assertRegex(str(exc.exception), r'No such directory')
+ self.assertRegex(str(exc.exception), path)
@TestArgs(
(None, None),
diff --git a/headphones/transmission.py b/headphones/transmission.py
index 6abc2d70..a787344c 100644
--- a/headphones/transmission.py
+++ b/headphones/transmission.py
@@ -16,7 +16,7 @@
import time
import json
import base64
-import urlparse
+import urllib.parse
import os
from headphones import logger, request
@@ -57,7 +57,7 @@ def addTorrent(link, data=None):
else:
retid = False
- logger.info(u"Torrent sent to Transmission successfully")
+ logger.info("Torrent sent to Transmission successfully")
return retid
else:
@@ -167,7 +167,7 @@ def torrentAction(method, arguments):
# Fix the URL. We assume that the user does not point to the RPC endpoint,
# so add it if it is missing.
- parts = list(urlparse.urlparse(host))
+ parts = list(urllib.parse.urlparse(host))
if not parts[0] in ("http", "https"):
parts[0] = "http"
@@ -175,7 +175,7 @@ def torrentAction(method, arguments):
if not parts[2].endswith("/rpc"):
parts[2] += "/transmission/rpc"
- host = urlparse.urlunparse(parts)
+ host = urllib.parse.urlunparse(parts)
data = {'method': method, 'arguments': arguments}
data_json = json.dumps(data)
auth = (username, password) if username and password else None
@@ -205,5 +205,5 @@ def torrentAction(method, arguments):
continue
resp_json = response.json()
- print resp_json
+ print(resp_json)
return resp_json
diff --git a/headphones/unittestcompat.py b/headphones/unittestcompat.py
index 0bf26c3c..e11b2aee 100644
--- a/headphones/unittestcompat.py
+++ b/headphones/unittestcompat.py
@@ -44,7 +44,7 @@ class TestCase(TC):
@_d
def assertRegexpMatches(self, *args, **kw):
- return super(TestCase, self).assertRegexpMatches(*args, **kw)
+ return super(TestCase, self).assertRegex(*args, **kw)
# -----------------------------------------------------------
# NOT DUMMY ASSERTIONS
diff --git a/headphones/utorrent.py b/headphones/utorrent.py
index 43befbd2..1b4b2ab2 100644
--- a/headphones/utorrent.py
+++ b/headphones/utorrent.py
@@ -13,13 +13,13 @@
# You should have received a copy of the GNU General Public License
# along with Headphones. If not, see .
-import urllib
+import urllib.request, urllib.parse, urllib.error
import json
import time
from collections import namedtuple
-import urllib2
-import urlparse
-import cookielib
+import urllib.request, urllib.error, urllib.parse
+import urllib.parse
+import http.cookiejar
import re
import os
@@ -52,23 +52,23 @@ class utorrentclient(object):
def _make_opener(self, realm, base_url, username, password):
"""uTorrent API need HTTP Basic Auth and cookie support for token verify."""
- auth = urllib2.HTTPBasicAuthHandler()
+ auth = urllib.request.HTTPBasicAuthHandler()
auth.add_password(realm=realm, uri=base_url, user=username, passwd=password)
- opener = urllib2.build_opener(auth)
- urllib2.install_opener(opener)
+ opener = urllib.request.build_opener(auth)
+ urllib.request.install_opener(opener)
- cookie_jar = cookielib.CookieJar()
- cookie_handler = urllib2.HTTPCookieProcessor(cookie_jar)
+ cookie_jar = http.cookiejar.CookieJar()
+ cookie_handler = urllib.request.HTTPCookieProcessor(cookie_jar)
handlers = [auth, cookie_handler]
- opener = urllib2.build_opener(*handlers)
+ opener = urllib.request.build_opener(*handlers)
return opener
def _get_token(self):
- url = urlparse.urljoin(self.base_url, 'gui/token.html')
+ url = urllib.parse.urljoin(self.base_url, 'gui/token.html')
try:
response = self.opener.open(url)
- except urllib2.HTTPError as err:
+ except urllib.error.HTTPError as err:
logger.debug('URL: ' + str(url))
logger.debug('Error getting Token. uTorrent responded with error: ' + str(err))
return
@@ -77,7 +77,7 @@ class utorrentclient(object):
def list(self, **kwargs):
params = [('list', '1')]
- params += kwargs.items()
+ params += list(kwargs.items())
return self._action(params)
def add_url(self, url):
@@ -150,8 +150,8 @@ class utorrentclient(object):
if not self.token:
return
- url = self.base_url + '/gui/' + '?token=' + self.token + '&' + urllib.urlencode(params)
- request = urllib2.Request(url)
+ url = self.base_url + '/gui/' + '?token=' + self.token + '&' + urllib.parse.urlencode(params)
+ request = urllib.request.Request(url)
if body:
request.add_data(body)
@@ -162,7 +162,7 @@ class utorrentclient(object):
try:
response = self.opener.open(request)
return response.code, json.loads(response.read())
- except urllib2.HTTPError as err:
+ except urllib.error.HTTPError as err:
logger.debug('URL: ' + str(url))
logger.debug('uTorrent webUI raised the following error: ' + str(err))
diff --git a/headphones/versioncheck.py b/headphones/versioncheck.py
index 11c4e225..a63129c2 100644
--- a/headphones/versioncheck.py
+++ b/headphones/versioncheck.py
@@ -43,7 +43,7 @@ def runGit(args):
shell=True,
cwd=headphones.PROG_DIR)
output, err = p.communicate()
- output = output.strip()
+ output = output.decode('utf-8').strip()
logger.debug('Git output: ' + output)
except OSError as e:
diff --git a/headphones/webserve.py b/headphones/webserve.py
index 9e2f1979..3f678da2 100644
--- a/headphones/webserve.py
+++ b/headphones/webserve.py
@@ -17,14 +17,14 @@
from operator import itemgetter
import threading
-import hashlib
+import secrets
import random
-import urllib
+import urllib.request, urllib.parse, urllib.error
import json
import time
-import cgi
import sys
-import urllib2
+from html import escape as html_escape
+import urllib.request, urllib.error, urllib.parse
import os
import re
@@ -97,7 +97,7 @@ class WebInterface(object):
# Serve the extras up as a dict to make things easier for new templates (append new extras to the end)
extras_list = headphones.POSSIBLE_EXTRAS
if artist['Extras']:
- artist_extras = map(int, artist['Extras'].split(','))
+ artist_extras = list(map(int, artist['Extras'].split(',')))
else:
artist_extras = []
@@ -158,8 +158,8 @@ class WebInterface(object):
else:
searchresults = mb.findSeries(name, limit=100)
return serve_template(templatename="searchresults.html",
- title='Search Results for: "' + cgi.escape(name) + '"',
- searchresults=searchresults, name=cgi.escape(name), type=type)
+ title='Search Results for: "' + html_escape(name) + '"',
+ searchresults=searchresults, name=html_escape(name), type=type)
@cherrypy.expose
def addArtist(self, artistid):
@@ -230,7 +230,7 @@ class WebInterface(object):
@cherrypy.expose
def pauseArtist(self, ArtistID):
- logger.info(u"Pausing artist: " + ArtistID)
+ logger.info("Pausing artist: " + ArtistID)
myDB = db.DBConnection()
controlValueDict = {'ArtistID': ArtistID}
newValueDict = {'Status': 'Paused'}
@@ -239,7 +239,7 @@ class WebInterface(object):
@cherrypy.expose
def resumeArtist(self, ArtistID):
- logger.info(u"Resuming artist: " + ArtistID)
+ logger.info("Resuming artist: " + ArtistID)
myDB = db.DBConnection()
controlValueDict = {'ArtistID': ArtistID}
newValueDict = {'Status': 'Active'}
@@ -252,9 +252,9 @@ class WebInterface(object):
for name in namecheck:
artistname = name['ArtistName']
try:
- logger.info(u"Deleting all traces of artist: " + artistname)
+ logger.info("Deleting all traces of artist: " + artistname)
except TypeError:
- logger.info(u"Deleting all traces of artist: null")
+ logger.info("Deleting all traces of artist: null")
myDB.action('DELETE from artists WHERE ArtistID=?', [ArtistID])
from headphones import cache
@@ -291,7 +291,7 @@ class WebInterface(object):
myDB = db.DBConnection()
artist_name = myDB.select('SELECT DISTINCT ArtistName FROM artists WHERE ArtistID=?', [ArtistID])[0][0]
- logger.info(u"Scanning artist: %s", artist_name)
+ logger.info("Scanning artist: %s", artist_name)
full_folder_format = headphones.CONFIG.FOLDER_FORMAT
folder_format = re.findall(r'(.*?[Aa]rtist?)\.*', full_folder_format)[0]
@@ -314,7 +314,7 @@ class WebInterface(object):
sortname = artist
if sortname[0].isdigit():
- firstchar = u'0-9'
+ firstchar = '0-9'
else:
firstchar = sortname[0]
@@ -363,7 +363,7 @@ class WebInterface(object):
@cherrypy.expose
def deleteEmptyArtists(self):
- logger.info(u"Deleting all empty artists")
+ logger.info("Deleting all empty artists")
myDB = db.DBConnection()
emptyArtistIDs = [row['ArtistID'] for row in
myDB.select("SELECT ArtistID FROM artists WHERE LatestAlbum IS NULL")]
@@ -423,7 +423,7 @@ class WebInterface(object):
@cherrypy.expose
def queueAlbum(self, AlbumID, ArtistID=None, new=False, redirect=None, lossless=False):
- logger.info(u"Marking album: " + AlbumID + " as wanted...")
+ logger.info("Marking album: " + AlbumID + " as wanted...")
myDB = db.DBConnection()
controlValueDict = {'AlbumID': AlbumID}
if lossless:
@@ -438,10 +438,11 @@ class WebInterface(object):
raise cherrypy.HTTPRedirect(redirect)
@cherrypy.expose
+ @cherrypy.tools.json_out()
def choose_specific_download(self, AlbumID):
results = searcher.searchforalbum(AlbumID, choose_specific_download=True)
- results_as_dicts = []
+ data = []
for result in results:
result_dict = {
@@ -452,35 +453,34 @@ class WebInterface(object):
'kind': result[4],
'matches': result[5]
}
- results_as_dicts.append(result_dict)
- s = json.dumps(results_as_dicts)
- cherrypy.response.headers['Content-type'] = 'application/json'
- return s
+ data.append(result_dict)
+ return data
@cherrypy.expose
+ @cherrypy.tools.json_out()
def download_specific_release(self, AlbumID, title, size, url, provider, kind, **kwargs):
# Handle situations where the torrent url contains arguments that are parsed
if kwargs:
- url = urllib2.quote(url, safe=":?/=&") + '&' + urllib.urlencode(kwargs)
+ url = urllib.parse.quote(url, safe=":?/=&") + '&' + urllib.parse.urlencode(kwargs)
try:
result = [(title, int(size), url, provider, kind)]
except ValueError:
result = [(title, float(size), url, provider, kind)]
- logger.info(u"Making sure we can download the chosen result")
+ logger.info("Making sure we can download the chosen result")
(data, bestqual) = searcher.preprocess(result)
if data and bestqual:
myDB = db.DBConnection()
album = myDB.action('SELECT * from albums WHERE AlbumID=?', [AlbumID]).fetchone()
searcher.send_to_downloader(data, bestqual, album)
- return json.dumps({'result': 'success'})
+ return {'result': 'success'}
else:
- return json.dumps({'result': 'failure'})
+ return {'result': 'failure'}
@cherrypy.expose
def unqueueAlbum(self, AlbumID, ArtistID):
- logger.info(u"Marking album: " + AlbumID + "as skipped...")
+ logger.info("Marking album: " + AlbumID + "as skipped...")
myDB = db.DBConnection()
controlValueDict = {'AlbumID': AlbumID}
newValueDict = {'Status': 'Skipped'}
@@ -489,7 +489,7 @@ class WebInterface(object):
@cherrypy.expose
def deleteAlbum(self, AlbumID, ArtistID=None):
- logger.info(u"Deleting all traces of album: " + AlbumID)
+ logger.info("Deleting all traces of album: " + AlbumID)
myDB = db.DBConnection()
myDB.action('DELETE from have WHERE Matched=?', [AlbumID])
@@ -528,7 +528,7 @@ class WebInterface(object):
@cherrypy.expose
def editSearchTerm(self, AlbumID, SearchTerm):
- logger.info(u"Updating search term for albumid: " + AlbumID)
+ logger.info("Updating search term for albumid: " + AlbumID)
myDB = db.DBConnection()
controlValueDict = {'AlbumID': AlbumID}
newValueDict = {'SearchTerm': SearchTerm}
@@ -959,6 +959,7 @@ class WebInterface(object):
raise cherrypy.HTTPRedirect("logs")
@cherrypy.expose
+ @cherrypy.tools.json_out()
def getLog(self, iDisplayStart=0, iDisplayLength=100, iSortCol_0=0, sSortDir_0="desc",
sSearch="", **kwargs):
iDisplayStart = int(iDisplayStart)
@@ -981,13 +982,14 @@ class WebInterface(object):
rows = filtered[iDisplayStart:(iDisplayStart + iDisplayLength)]
rows = [[row[0], row[2], row[1]] for row in rows]
- return json.dumps({
+ return {
'iTotalDisplayRecords': len(filtered),
'iTotalRecords': len(headphones.LOG_LIST),
'aaData': rows,
- })
+ }
@cherrypy.expose
+ @cherrypy.tools.json_out()
def getArtists_json(self, iDisplayStart=0, iDisplayLength=100, sSearch="", iSortCol_0='0',
sSortDir_0='asc', **kwargs):
iDisplayStart = int(iDisplayStart)
@@ -1055,61 +1057,58 @@ class WebInterface(object):
rows.append(row)
- dict = {'iTotalDisplayRecords': len(filtered),
+ data = {'iTotalDisplayRecords': len(filtered),
'iTotalRecords': totalcount,
'aaData': rows,
}
- s = json.dumps(dict)
- cherrypy.response.headers['Content-type'] = 'application/json'
- return s
+ return data
@cherrypy.expose
+ @cherrypy.tools.json_out()
def getAlbumsByArtist_json(self, artist=None):
myDB = db.DBConnection()
- album_json = {}
+ data = {}
counter = 0
album_list = myDB.select("SELECT AlbumTitle from albums WHERE ArtistName=?", [artist])
for album in album_list:
- album_json[counter] = album['AlbumTitle']
+ data[counter] = album['AlbumTitle']
counter += 1
- json_albums = json.dumps(album_json)
- cherrypy.response.headers['Content-type'] = 'application/json'
- return json_albums
+ return data
@cherrypy.expose
+ @cherrypy.tools.json_out()
def getArtistjson(self, ArtistID, **kwargs):
myDB = db.DBConnection()
artist = myDB.action('SELECT * FROM artists WHERE ArtistID=?', [ArtistID]).fetchone()
- artist_json = json.dumps({
+ return {
'ArtistName': artist['ArtistName'],
'Status': artist['Status']
- })
- return artist_json
+ }
@cherrypy.expose
+ @cherrypy.tools.json_out()
def getAlbumjson(self, AlbumID, **kwargs):
myDB = db.DBConnection()
album = myDB.action('SELECT * from albums WHERE AlbumID=?', [AlbumID]).fetchone()
- album_json = json.dumps({
+ return {
'AlbumTitle': album['AlbumTitle'],
'ArtistName': album['ArtistName'],
'Status': album['Status']
- })
- return album_json
+ }
@cherrypy.expose
def clearhistory(self, type=None, date_added=None, title=None):
myDB = db.DBConnection()
if type:
if type == 'all':
- logger.info(u"Clearing all history")
+ logger.info("Clearing all history")
myDB.action('DELETE from snatched WHERE Status NOT LIKE "Seed%"')
else:
- logger.info(u"Clearing history where status is %s" % type)
+ logger.info("Clearing history where status is %s" % type)
myDB.action('DELETE from snatched WHERE Status=?', [type])
else:
- logger.info(u"Deleting '%s' from history" % title)
+ logger.info("Deleting '%s' from history" % title)
myDB.action(
'DELETE from snatched WHERE Status NOT LIKE "Seed%" AND Title=? AND DateAdded=?',
[title, date_added])
@@ -1117,7 +1116,7 @@ class WebInterface(object):
@cherrypy.expose
def generateAPI(self):
- apikey = hashlib.sha224(str(random.getrandbits(256))).hexdigest()[0:32]
+ apikey = secrets.token_hex(nbytes=16)
logger.info("New API generated")
return apikey
@@ -1418,7 +1417,7 @@ class WebInterface(object):
"join_deviceid": headphones.CONFIG.JOIN_DEVICEID
}
- for k, v in config.iteritems():
+ for k, v in config.items():
if isinstance(v, headphones.config.path):
# need to apply SoftChroot to paths:
nv = headphones.SOFT_CHROOT.apply(v)
@@ -1435,7 +1434,7 @@ class WebInterface(object):
extras_list = [extra_munges.get(x, x) for x in headphones.POSSIBLE_EXTRAS]
if headphones.CONFIG.EXTRAS:
- extras = map(int, headphones.CONFIG.EXTRAS.split(','))
+ extras = list(map(int, headphones.CONFIG.EXTRAS.split(',')))
else:
extras = []
@@ -1496,7 +1495,7 @@ class WebInterface(object):
kwargs[plain_config] = kwargs[use_config]
del kwargs[use_config]
- for k, v in kwargs.iteritems():
+ for k, v in kwargs.items():
# TODO : HUGE crutch. It is all because there is no way to deal with options...
try:
_conf = headphones.CONFIG._define(k)
@@ -1648,12 +1647,13 @@ class WebInterface(object):
return a.fetchData()
@cherrypy.expose
+ @cherrypy.tools.json_out()
def getInfo(self, ArtistID=None, AlbumID=None):
from headphones import cache
info_dict = cache.getInfo(ArtistID, AlbumID)
- return json.dumps(info_dict)
+ return info_dict
@cherrypy.expose
def getArtwork(self, ArtistID=None, AlbumID=None):
@@ -1670,6 +1670,7 @@ class WebInterface(object):
# If you just want to get the last.fm image links for an album, make sure
# to pass a releaseid and not a releasegroupid
@cherrypy.expose
+ @cherrypy.tools.json_out()
def getImageLinks(self, ArtistID=None, AlbumID=None):
from headphones import cache
image_dict = cache.getImageLinks(ArtistID, AlbumID)
@@ -1687,7 +1688,7 @@ class WebInterface(object):
image_dict[
'thumbnail'] = "http://coverartarchive.org/release/%s/front-250.jpg" % AlbumID
- return json.dumps(image_dict)
+ return image_dict
@cherrypy.expose
def twitterStep1(self):
@@ -1700,7 +1701,7 @@ class WebInterface(object):
cherrypy.response.headers['Cache-Control'] = "max-age=0,no-cache,no-store"
tweet = notifiers.TwitterNotifier()
result = tweet._get_credentials(key)
- logger.info(u"result: " + str(result))
+ logger.info("result: " + str(result))
if result:
return "Key verification successful"
else:
@@ -1732,14 +1733,14 @@ class WebInterface(object):
@cherrypy.expose
def testPushover(self):
- logger.info(u"Sending Pushover notification")
+ logger.info("Sending Pushover notification")
pushover = notifiers.PUSHOVER()
result = pushover.notify("hooray!", "This is a test")
return str(result)
@cherrypy.expose
def testPlex(self):
- logger.info(u"Testing plex update")
+ logger.info("Testing plex update")
plex = notifiers.Plex()
plex.update()
diff --git a/headphones/webstart.py b/headphones/webstart.py
index 61417803..d5412c32 100644
--- a/headphones/webstart.py
+++ b/headphones/webstart.py
@@ -111,12 +111,9 @@ def initialize(options):
})
conf['/api'] = {'tools.auth_basic.on': False}
- # Prevent time-outs
- cherrypy.engine.timeout_monitor.unsubscribe()
cherrypy.tree.mount(WebInterface(), str(options['http_root']), config=conf)
try:
- cherrypy.process.servers.check_port(str(options['http_host']), options['http_port'])
cherrypy.server.start()
except IOError:
sys.stderr.write(
diff --git a/lib/MultipartPostHandler.py b/lib/MultipartPostHandler.py
index ef63afa2..5d469bed 100644
--- a/lib/MultipartPostHandler.py
+++ b/lib/MultipartPostHandler.py
@@ -15,8 +15,8 @@
# Lesser General Public License for more details.
#
-import urllib
-import urllib2
+import urllib.request, urllib.parse, urllib.error
+import urllib.request, urllib.error, urllib.parse
import mimetools, mimetypes
import os, sys
@@ -24,8 +24,8 @@ import os, sys
# assigning a sequence.
doseq = 1
-class MultipartPostHandler(urllib2.BaseHandler):
- handler_order = urllib2.HTTPHandler.handler_order - 10 # needs to run first
+class MultipartPostHandler(urllib.request.BaseHandler):
+ handler_order = urllib.request.HTTPHandler.handler_order - 10 # needs to run first
def http_request(self, request):
data = request.get_data()
@@ -33,23 +33,23 @@ class MultipartPostHandler(urllib2.BaseHandler):
v_files = []
v_vars = []
try:
- for(key, value) in data.items():
+ for(key, value) in list(data.items()):
if type(value) in (file, list, tuple):
v_files.append((key, value))
else:
v_vars.append((key, value))
except TypeError:
systype, value, traceback = sys.exc_info()
- raise TypeError, "not a valid non-string sequence or mapping object", traceback
+ raise TypeError("not a valid non-string sequence or mapping object").with_traceback(traceback)
if len(v_files) == 0:
- data = urllib.urlencode(v_vars, doseq)
+ data = urllib.parse.urlencode(v_vars, doseq)
else:
boundary, data = MultipartPostHandler.multipart_encode(v_vars, v_files)
contenttype = 'multipart/form-data; boundary=%s' % boundary
if(request.has_header('Content-Type')
and request.get_header('Content-Type').find('multipart/form-data') != 0):
- print "Replacing %s with %s" % (request.get_header('content-type'), 'multipart/form-data')
+ print("Replacing %s with %s" % (request.get_header('content-type'), 'multipart/form-data'))
request.add_unredirected_header('Content-Type', contenttype)
request.add_data(data)
diff --git a/lib/apscheduler/executors/asyncio.py b/lib/apscheduler/executors/asyncio.py
index fade99f8..c354eb98 100644
--- a/lib/apscheduler/executors/asyncio.py
+++ b/lib/apscheduler/executors/asyncio.py
@@ -1,4 +1,4 @@
-from __future__ import absolute_import
+
import sys
from apscheduler.executors.base import BaseExecutor, run_job
diff --git a/lib/apscheduler/executors/gevent.py b/lib/apscheduler/executors/gevent.py
index 9f4db2fc..2f81ae06 100644
--- a/lib/apscheduler/executors/gevent.py
+++ b/lib/apscheduler/executors/gevent.py
@@ -1,4 +1,4 @@
-from __future__ import absolute_import
+
import sys
from apscheduler.executors.base import BaseExecutor, run_job
diff --git a/lib/apscheduler/executors/twisted.py b/lib/apscheduler/executors/twisted.py
index 29217221..ba446eb3 100644
--- a/lib/apscheduler/executors/twisted.py
+++ b/lib/apscheduler/executors/twisted.py
@@ -1,4 +1,4 @@
-from __future__ import absolute_import
+
from apscheduler.executors.base import BaseExecutor, run_job
diff --git a/lib/apscheduler/jobstores/memory.py b/lib/apscheduler/jobstores/memory.py
index 645391f3..011d13cb 100644
--- a/lib/apscheduler/jobstores/memory.py
+++ b/lib/apscheduler/jobstores/memory.py
@@ -1,4 +1,4 @@
-from __future__ import absolute_import
+
from apscheduler.jobstores.base import BaseJobStore, JobLookupError, ConflictingIdError
from apscheduler.util import datetime_to_utc_timestamp
diff --git a/lib/apscheduler/jobstores/mongodb.py b/lib/apscheduler/jobstores/mongodb.py
index ff762f7e..95f47ee4 100644
--- a/lib/apscheduler/jobstores/mongodb.py
+++ b/lib/apscheduler/jobstores/mongodb.py
@@ -1,11 +1,11 @@
-from __future__ import absolute_import
+
from apscheduler.jobstores.base import BaseJobStore, JobLookupError, ConflictingIdError
from apscheduler.util import maybe_ref, datetime_to_utc_timestamp, utc_timestamp_to_datetime
from apscheduler.job import Job
try:
- import cPickle as pickle
+ import pickle as pickle
except ImportError: # pragma: nocover
import pickle
diff --git a/lib/apscheduler/jobstores/redis.py b/lib/apscheduler/jobstores/redis.py
index 2b4ffd52..cf29d388 100644
--- a/lib/apscheduler/jobstores/redis.py
+++ b/lib/apscheduler/jobstores/redis.py
@@ -1,4 +1,4 @@
-from __future__ import absolute_import
+
import six
@@ -7,7 +7,7 @@ from apscheduler.util import datetime_to_utc_timestamp, utc_timestamp_to_datetim
from apscheduler.job import Job
try:
- import cPickle as pickle
+ import pickle as pickle
except ImportError: # pragma: nocover
import pickle
diff --git a/lib/apscheduler/jobstores/sqlalchemy.py b/lib/apscheduler/jobstores/sqlalchemy.py
index f8a3c151..1de6468d 100644
--- a/lib/apscheduler/jobstores/sqlalchemy.py
+++ b/lib/apscheduler/jobstores/sqlalchemy.py
@@ -1,11 +1,11 @@
-from __future__ import absolute_import
+
from apscheduler.jobstores.base import BaseJobStore, JobLookupError, ConflictingIdError
from apscheduler.util import maybe_ref, datetime_to_utc_timestamp, utc_timestamp_to_datetime
from apscheduler.job import Job
try:
- import cPickle as pickle
+ import pickle as pickle
except ImportError: # pragma: nocover
import pickle
diff --git a/lib/apscheduler/schedulers/asyncio.py b/lib/apscheduler/schedulers/asyncio.py
index b91ee97a..2538bdc5 100644
--- a/lib/apscheduler/schedulers/asyncio.py
+++ b/lib/apscheduler/schedulers/asyncio.py
@@ -1,4 +1,4 @@
-from __future__ import absolute_import
+
from functools import wraps
from apscheduler.schedulers.base import BaseScheduler
diff --git a/lib/apscheduler/schedulers/background.py b/lib/apscheduler/schedulers/background.py
index 86ff2ba3..624db594 100644
--- a/lib/apscheduler/schedulers/background.py
+++ b/lib/apscheduler/schedulers/background.py
@@ -1,4 +1,4 @@
-from __future__ import absolute_import
+
from threading import Thread, Event
from apscheduler.schedulers.base import BaseScheduler
diff --git a/lib/apscheduler/schedulers/base.py b/lib/apscheduler/schedulers/base.py
index cdc0bf06..22735540 100644
--- a/lib/apscheduler/schedulers/base.py
+++ b/lib/apscheduler/schedulers/base.py
@@ -1,4 +1,4 @@
-from __future__ import print_function
+
from abc import ABCMeta, abstractmethod
from collections import MutableMapping
from threading import RLock
diff --git a/lib/apscheduler/schedulers/blocking.py b/lib/apscheduler/schedulers/blocking.py
index 2720822c..8bdb33f8 100644
--- a/lib/apscheduler/schedulers/blocking.py
+++ b/lib/apscheduler/schedulers/blocking.py
@@ -1,4 +1,4 @@
-from __future__ import absolute_import
+
from threading import Event
from apscheduler.schedulers.base import BaseScheduler
diff --git a/lib/apscheduler/schedulers/gevent.py b/lib/apscheduler/schedulers/gevent.py
index 9cce6589..b61b2417 100644
--- a/lib/apscheduler/schedulers/gevent.py
+++ b/lib/apscheduler/schedulers/gevent.py
@@ -1,4 +1,4 @@
-from __future__ import absolute_import
+
from apscheduler.schedulers.blocking import BlockingScheduler
from apscheduler.schedulers.base import BaseScheduler
diff --git a/lib/apscheduler/schedulers/qt.py b/lib/apscheduler/schedulers/qt.py
index dde5afaa..7de3b97f 100644
--- a/lib/apscheduler/schedulers/qt.py
+++ b/lib/apscheduler/schedulers/qt.py
@@ -1,4 +1,4 @@
-from __future__ import absolute_import
+
from apscheduler.schedulers.base import BaseScheduler
diff --git a/lib/apscheduler/schedulers/tornado.py b/lib/apscheduler/schedulers/tornado.py
index 78093308..989d0225 100644
--- a/lib/apscheduler/schedulers/tornado.py
+++ b/lib/apscheduler/schedulers/tornado.py
@@ -1,4 +1,4 @@
-from __future__ import absolute_import
+
from datetime import timedelta
from functools import wraps
diff --git a/lib/apscheduler/schedulers/twisted.py b/lib/apscheduler/schedulers/twisted.py
index 166b6130..7236ec06 100644
--- a/lib/apscheduler/schedulers/twisted.py
+++ b/lib/apscheduler/schedulers/twisted.py
@@ -1,4 +1,4 @@
-from __future__ import absolute_import
+
from functools import wraps
from apscheduler.schedulers.base import BaseScheduler
diff --git a/lib/apscheduler/util.py b/lib/apscheduler/util.py
index 988f9427..86d96da3 100644
--- a/lib/apscheduler/util.py
+++ b/lib/apscheduler/util.py
@@ -1,6 +1,6 @@
"""This module contains several handy functions primarily meant for internal use."""
-from __future__ import division
+
from datetime import date, datetime, time, timedelta, tzinfo
from inspect import isfunction, ismethod, getargspec
from calendar import timegm
@@ -23,7 +23,7 @@ __all__ = ('asint', 'asbool', 'astimezone', 'convert_to_datetime', 'datetime_to_
class _Undefined(object):
- def __nonzero__(self):
+ def __bool__(self):
return False
def __bool__(self):
@@ -116,7 +116,7 @@ def convert_to_datetime(input, tz, arg_name):
m = _DATE_REGEX.match(input)
if not m:
raise ValueError('Invalid date string')
- values = [(k, int(v or 0)) for k, v in m.groupdict().items()]
+ values = [(k, int(v or 0)) for k, v in list(m.groupdict().items())]
values = dict(values)
datetime_ = datetime(**values)
else:
diff --git a/lib/beets/__init__.py b/lib/beets/__init__.py
old mode 100755
new mode 100644
index 9291673b..9642a6f3
--- a/lib/beets/__init__.py
+++ b/lib/beets/__init__.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
# This file is part of beets.
# Copyright 2016, Adrian Sampson.
#
@@ -13,33 +12,29 @@
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
-from __future__ import division, absolute_import, print_function
-import os
+import confuse
+from sys import stderr
-from beets.util import confit
-
-# This particular version has been slightly modified to work with Headphones
-# https://github.com/rembo10/headphones
-__version__ = u'1.4.4-headphones'
-__author__ = u'Adrian Sampson '
+__version__ = '1.6.0'
+__author__ = 'Adrian Sampson '
-class IncludeLazyConfig(confit.LazyConfig):
- """A version of Confit's LazyConfig that also merges in data from
+class IncludeLazyConfig(confuse.LazyConfig):
+ """A version of Confuse's LazyConfig that also merges in data from
YAML files specified in an `include` setting.
"""
def read(self, user=True, defaults=True):
- super(IncludeLazyConfig, self).read(user, defaults)
+ super().read(user, defaults)
try:
for view in self['include']:
- filename = view.as_filename()
- if os.path.isfile(filename):
- self.set_file(filename)
- except confit.NotFoundError:
+ self.set_file(view.as_filename())
+ except confuse.NotFoundError:
pass
+ except confuse.ConfigReadError as err:
+ stderr.write("configuration `import` failed: {}"
+ .format(err.reason))
-# headphones
-#config = IncludeLazyConfig('beets', __name__)
-config = IncludeLazyConfig(os.path.dirname(__file__), __name__)
+
+config = IncludeLazyConfig('beets', __name__)
diff --git a/lib/beets/__main__.py b/lib/beets/__main__.py
old mode 100755
new mode 100644
index 8010ca0d..ac829de9
--- a/lib/beets/__main__.py
+++ b/lib/beets/__main__.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
# This file is part of beets.
# Copyright 2017, Adrian Sampson.
#
@@ -17,7 +16,6 @@
`python -m beets`.
"""
-from __future__ import division, absolute_import, print_function
import sys
from .ui import main
diff --git a/lib/beets/art.py b/lib/beets/art.py
old mode 100755
new mode 100644
index 979a6f72..13d5dfbd
--- a/lib/beets/art.py
+++ b/lib/beets/art.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
# This file is part of beets.
# Copyright 2016, Adrian Sampson.
#
@@ -17,7 +16,6 @@
music and items' embedded album art.
"""
-from __future__ import division, absolute_import, print_function
import subprocess
import platform
@@ -26,7 +24,7 @@ import os
from beets.util import displayable_path, syspath, bytestring_path
from beets.util.artresizer import ArtResizer
-from beets import mediafile
+import mediafile
def mediafile_image(image_path, maxwidth=None):
@@ -43,7 +41,7 @@ def get_art(log, item):
try:
mf = mediafile.MediaFile(syspath(item.path))
except mediafile.UnreadableFileError as exc:
- log.warning(u'Could not extract art from {0}: {1}',
+ log.warning('Could not extract art from {0}: {1}',
displayable_path(item.path), exc)
return
@@ -51,26 +49,27 @@ def get_art(log, item):
def embed_item(log, item, imagepath, maxwidth=None, itempath=None,
- compare_threshold=0, ifempty=False, as_album=False):
+ compare_threshold=0, ifempty=False, as_album=False, id3v23=None,
+ quality=0):
"""Embed an image into the item's media file.
"""
# Conditions and filters.
if compare_threshold:
if not check_art_similarity(log, item, imagepath, compare_threshold):
- log.info(u'Image not similar; skipping.')
+ log.info('Image not similar; skipping.')
return
if ifempty and get_art(log, item):
- log.info(u'media file already contained art')
- return
+ log.info('media file already contained art')
+ return
if maxwidth and not as_album:
- imagepath = resize_image(log, imagepath, maxwidth)
+ imagepath = resize_image(log, imagepath, maxwidth, quality)
# Get the `Image` object from the file.
try:
- log.debug(u'embedding {0}', displayable_path(imagepath))
+ log.debug('embedding {0}', displayable_path(imagepath))
image = mediafile_image(imagepath, maxwidth)
- except IOError as exc:
- log.warning(u'could not read image file: {0}', exc)
+ except OSError as exc:
+ log.warning('could not read image file: {0}', exc)
return
# Make sure the image kind is safe (some formats only support PNG
@@ -80,36 +79,39 @@ def embed_item(log, item, imagepath, maxwidth=None, itempath=None,
image.mime_type)
return
- item.try_write(path=itempath, tags={'images': [image]})
+ item.try_write(path=itempath, tags={'images': [image]}, id3v23=id3v23)
-def embed_album(log, album, maxwidth=None, quiet=False,
- compare_threshold=0, ifempty=False):
+def embed_album(log, album, maxwidth=None, quiet=False, compare_threshold=0,
+ ifempty=False, quality=0):
"""Embed album art into all of the album's items.
"""
imagepath = album.artpath
if not imagepath:
- log.info(u'No album art present for {0}', album)
+ log.info('No album art present for {0}', album)
return
if not os.path.isfile(syspath(imagepath)):
- log.info(u'Album art not found at {0} for {1}',
+ log.info('Album art not found at {0} for {1}',
displayable_path(imagepath), album)
return
if maxwidth:
- imagepath = resize_image(log, imagepath, maxwidth)
+ imagepath = resize_image(log, imagepath, maxwidth, quality)
- log.info(u'Embedding album art into {0}', album)
+ log.info('Embedding album art into {0}', album)
for item in album.items():
- embed_item(log, item, imagepath, maxwidth, None,
- compare_threshold, ifempty, as_album=True)
+ embed_item(log, item, imagepath, maxwidth, None, compare_threshold,
+ ifempty, as_album=True, quality=quality)
-def resize_image(log, imagepath, maxwidth):
- """Returns path to an image resized to maxwidth.
+def resize_image(log, imagepath, maxwidth, quality):
+ """Returns path to an image resized to maxwidth and encoded with the
+ specified quality level.
"""
- log.debug(u'Resizing album art to {0} pixels wide', maxwidth)
- imagepath = ArtResizer.shared.resize(maxwidth, syspath(imagepath))
+ log.debug('Resizing album art to {0} pixels wide and encoding at quality \
+ level {1}', maxwidth, quality)
+ imagepath = ArtResizer.shared.resize(maxwidth, syspath(imagepath),
+ quality=quality)
return imagepath
@@ -131,7 +133,7 @@ def check_art_similarity(log, item, imagepath, compare_threshold):
syspath(art, prefix=False),
'-colorspace', 'gray', 'MIFF:-']
compare_cmd = ['compare', '-metric', 'PHASH', '-', 'null:']
- log.debug(u'comparing images with pipeline {} | {}',
+ log.debug('comparing images with pipeline {} | {}',
convert_cmd, compare_cmd)
convert_proc = subprocess.Popen(
convert_cmd,
@@ -155,7 +157,7 @@ def check_art_similarity(log, item, imagepath, compare_threshold):
convert_proc.wait()
if convert_proc.returncode:
log.debug(
- u'ImageMagick convert failed with status {}: {!r}',
+ 'ImageMagick convert failed with status {}: {!r}',
convert_proc.returncode,
convert_stderr,
)
@@ -165,7 +167,7 @@ def check_art_similarity(log, item, imagepath, compare_threshold):
stdout, stderr = compare_proc.communicate()
if compare_proc.returncode:
if compare_proc.returncode != 1:
- log.debug(u'ImageMagick compare failed: {0}, {1}',
+ log.debug('ImageMagick compare failed: {0}, {1}',
displayable_path(imagepath),
displayable_path(art))
return
@@ -176,10 +178,10 @@ def check_art_similarity(log, item, imagepath, compare_threshold):
try:
phash_diff = float(out_str)
except ValueError:
- log.debug(u'IM output is not a number: {0!r}', out_str)
+ log.debug('IM output is not a number: {0!r}', out_str)
return
- log.debug(u'ImageMagick compare score: {0}', phash_diff)
+ log.debug('ImageMagick compare score: {0}', phash_diff)
return phash_diff <= compare_threshold
return True
@@ -189,18 +191,18 @@ def extract(log, outpath, item):
art = get_art(log, item)
outpath = bytestring_path(outpath)
if not art:
- log.info(u'No album art present in {0}, skipping.', item)
+ log.info('No album art present in {0}, skipping.', item)
return
# Add an extension to the filename.
ext = mediafile.image_extension(art)
if not ext:
- log.warning(u'Unknown image type in {0}.',
+ log.warning('Unknown image type in {0}.',
displayable_path(item.path))
return
outpath += bytestring_path('.' + ext)
- log.info(u'Extracting album art from: {0} to: {1}',
+ log.info('Extracting album art from: {0} to: {1}',
item, displayable_path(outpath))
with open(syspath(outpath), 'wb') as f:
f.write(art)
@@ -216,7 +218,7 @@ def extract_first(log, outpath, items):
def clear(log, lib, query):
items = lib.items(query)
- log.info(u'Clearing album art from {0} items', len(items))
+ log.info('Clearing album art from {0} items', len(items))
for item in items:
- log.debug(u'Clearing art for {0}', item)
+ log.debug('Clearing art for {0}', item)
item.try_write(tags={'images': None})
diff --git a/lib/beets/autotag/__init__.py b/lib/beets/autotag/__init__.py
old mode 100755
new mode 100644
index 54ce8e0c..e62f492c
--- a/lib/beets/autotag/__init__.py
+++ b/lib/beets/autotag/__init__.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
# This file is part of beets.
# Copyright 2016, Adrian Sampson.
#
@@ -16,19 +15,59 @@
"""Facilities for automatically determining files' correct metadata.
"""
-from __future__ import division, absolute_import, print_function
from beets import logging
from beets import config
# Parts of external interface.
-from .hooks import AlbumInfo, TrackInfo, AlbumMatch, TrackMatch # noqa
+from .hooks import ( # noqa
+ AlbumInfo,
+ TrackInfo,
+ AlbumMatch,
+ TrackMatch,
+ Distance,
+)
from .match import tag_item, tag_album, Proposal # noqa
from .match import Recommendation # noqa
# Global logger.
log = logging.getLogger('beets')
+# Metadata fields that are already hardcoded, or where the tag name changes.
+SPECIAL_FIELDS = {
+ 'album': (
+ 'va',
+ 'releasegroup_id',
+ 'artist_id',
+ 'album_id',
+ 'mediums',
+ 'tracks',
+ 'year',
+ 'month',
+ 'day',
+ 'artist',
+ 'artist_credit',
+ 'artist_sort',
+ 'data_url'
+ ),
+ 'track': (
+ 'track_alt',
+ 'artist_id',
+ 'release_track_id',
+ 'medium',
+ 'index',
+ 'medium_index',
+ 'title',
+ 'artist_credit',
+ 'artist_sort',
+ 'artist',
+ 'track_id',
+ 'medium_total',
+ 'data_url',
+ 'length'
+ )
+}
+
# Additional utilities for the main interface.
@@ -40,17 +79,17 @@ def apply_item_metadata(item, track_info):
item.artist_credit = track_info.artist_credit
item.title = track_info.title
item.mb_trackid = track_info.track_id
+ item.mb_releasetrackid = track_info.release_track_id
if track_info.artist_id:
item.mb_artistid = track_info.artist_id
- if track_info.data_source:
- item.data_source = track_info.data_source
- if track_info.lyricist is not None:
- item.lyricist = track_info.lyricist
- if track_info.composer is not None:
- item.composer = track_info.composer
- if track_info.arranger is not None:
- item.arranger = track_info.arranger
+ for field, value in track_info.items():
+ # We only overwrite fields that are not already hardcoded.
+ if field in SPECIAL_FIELDS['track']:
+ continue
+ if value is None:
+ continue
+ item[field] = value
# At the moment, the other metadata is left intact (including album
# and track number). Perhaps these should be emptied?
@@ -61,12 +100,19 @@ def apply_metadata(album_info, mapping):
mapping from Items to TrackInfo objects.
"""
for item, track_info in mapping.items():
- # Album, artist, track count.
- if track_info.artist:
- item.artist = track_info.artist
+ # Artist or artist credit.
+ if config['artist_credit']:
+ item.artist = (track_info.artist_credit or
+ track_info.artist or
+ album_info.artist_credit or
+ album_info.artist)
+ item.albumartist = (album_info.artist_credit or
+ album_info.artist)
else:
- item.artist = album_info.artist
- item.albumartist = album_info.artist
+ item.artist = (track_info.artist or album_info.artist)
+ item.albumartist = album_info.artist
+
+ # Album.
item.album = album_info.album
# Artist sort and credit names.
@@ -120,6 +166,7 @@ def apply_metadata(album_info, mapping):
# MusicBrainz IDs.
item.mb_trackid = track_info.track_id
+ item.mb_releasetrackid = track_info.release_track_id
item.mb_albumid = album_info.album_id
if track_info.artist_id:
item.mb_artistid = track_info.artist_id
@@ -131,34 +178,24 @@ def apply_metadata(album_info, mapping):
# Compilation flag.
item.comp = album_info.va
- # Miscellaneous metadata.
- for field in ('albumtype',
- 'label',
- 'asin',
- 'catalognum',
- 'script',
- 'language',
- 'country',
- 'albumstatus',
- 'albumdisambig',
- 'data_source',):
- value = getattr(album_info, field)
- if value is not None:
- item[field] = value
- if track_info.disctitle is not None:
- item.disctitle = track_info.disctitle
-
- if track_info.media is not None:
- item.media = track_info.media
-
- if track_info.lyricist is not None:
- item.lyricist = track_info.lyricist
- if track_info.composer is not None:
- item.composer = track_info.composer
- if track_info.arranger is not None:
- item.arranger = track_info.arranger
-
+ # Track alt.
item.track_alt = track_info.track_alt
- # Headphones seal of approval
- item.comments = 'tagged by headphones/beets'
+ # Don't overwrite fields with empty values unless the
+ # field is explicitly allowed to be overwritten
+ for field, value in album_info.items():
+ if field in SPECIAL_FIELDS['album']:
+ continue
+ clobber = field in config['overwrite_null']['album'].as_str_seq()
+ if value is None and not clobber:
+ continue
+ item[field] = value
+
+ for field, value in track_info.items():
+ if field in SPECIAL_FIELDS['track']:
+ continue
+ clobber = field in config['overwrite_null']['track'].as_str_seq()
+ value = getattr(track_info, field)
+ if value is None and not clobber:
+ continue
+ item[field] = value
diff --git a/lib/beets/autotag/hooks.py b/lib/beets/autotag/hooks.py
old mode 100755
new mode 100644
index 3c403fcf..9cd6f2cd
--- a/lib/beets/autotag/hooks.py
+++ b/lib/beets/autotag/hooks.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
# This file is part of beets.
# Copyright 2016, Adrian Sampson.
#
@@ -14,7 +13,6 @@
# included in all copies or substantial portions of the Software.
"""Glue between metadata sources and the matching logic."""
-from __future__ import division, absolute_import, print_function
from collections import namedtuple
from functools import total_ordering
@@ -27,14 +25,36 @@ from beets.util import as_string
from beets.autotag import mb
from jellyfish import levenshtein_distance
from unidecode import unidecode
-import six
log = logging.getLogger('beets')
+# The name of the type for patterns in re changed in Python 3.7.
+try:
+ Pattern = re._pattern_type
+except AttributeError:
+ Pattern = re.Pattern
+
# Classes used to represent candidate options.
+class AttrDict(dict):
+ """A dictionary that supports attribute ("dot") access, so `d.field`
+ is equivalent to `d['field']`.
+ """
-class AlbumInfo(object):
+ def __getattr__(self, attr):
+ if attr in self:
+ return self.get(attr)
+ else:
+ raise AttributeError
+
+ def __setattr__(self, key, value):
+ self.__setitem__(key, value)
+
+ def __hash__(self):
+ return id(self)
+
+
+class AlbumInfo(AttrDict):
"""Describes a canonical release that may be used to match a release
in the library. Consists of these data members:
@@ -43,38 +63,22 @@ class AlbumInfo(object):
- ``artist``: name of the release's primary artist
- ``artist_id``
- ``tracks``: list of TrackInfo objects making up the release
- - ``asin``: Amazon ASIN
- - ``albumtype``: string describing the kind of release
- - ``va``: boolean: whether the release has "various artists"
- - ``year``: release year
- - ``month``: release month
- - ``day``: release day
- - ``label``: music label responsible for the release
- - ``mediums``: the number of discs in this release
- - ``artist_sort``: name of the release's artist for sorting
- - ``releasegroup_id``: MBID for the album's release group
- - ``catalognum``: the label's catalog number for the release
- - ``script``: character set used for metadata
- - ``language``: human language of the metadata
- - ``country``: the release country
- - ``albumstatus``: MusicBrainz release status (Official, etc.)
- - ``media``: delivery mechanism (Vinyl, etc.)
- - ``albumdisambig``: MusicBrainz release disambiguation comment
- - ``artist_credit``: Release-specific artist name
- - ``data_source``: The original data source (MusicBrainz, Discogs, etc.)
- - ``data_url``: The data source release URL.
- The fields up through ``tracks`` are required. The others are
- optional and may be None.
+ ``mediums`` along with the fields up through ``tracks`` are required.
+ The others are optional and may be None.
"""
- def __init__(self, album, album_id, artist, artist_id, tracks, asin=None,
- albumtype=None, va=False, year=None, month=None, day=None,
- label=None, mediums=None, artist_sort=None,
- releasegroup_id=None, catalognum=None, script=None,
- language=None, country=None, albumstatus=None, media=None,
- albumdisambig=None, artist_credit=None, original_year=None,
- original_month=None, original_day=None, data_source=None,
- data_url=None):
+
+ def __init__(self, tracks, album=None, album_id=None, artist=None,
+ artist_id=None, asin=None, albumtype=None, va=False,
+ year=None, month=None, day=None, label=None, mediums=None,
+ artist_sort=None, releasegroup_id=None, catalognum=None,
+ script=None, language=None, country=None, style=None,
+ genre=None, albumstatus=None, media=None, albumdisambig=None,
+ releasegroupdisambig=None, artist_credit=None,
+ original_year=None, original_month=None,
+ original_day=None, data_source=None, data_url=None,
+ discogs_albumid=None, discogs_labelid=None,
+ discogs_artistid=None, **kwargs):
self.album = album
self.album_id = album_id
self.artist = artist
@@ -94,15 +98,22 @@ class AlbumInfo(object):
self.script = script
self.language = language
self.country = country
+ self.style = style
+ self.genre = genre
self.albumstatus = albumstatus
self.media = media
self.albumdisambig = albumdisambig
+ self.releasegroupdisambig = releasegroupdisambig
self.artist_credit = artist_credit
self.original_year = original_year
self.original_month = original_month
self.original_day = original_day
self.data_source = data_source
self.data_url = data_url
+ self.discogs_albumid = discogs_albumid
+ self.discogs_labelid = discogs_labelid
+ self.discogs_artistid = discogs_artistid
+ self.update(kwargs)
# Work around a bug in python-musicbrainz-ngs that causes some
# strings to be bytes rather than Unicode.
@@ -112,53 +123,49 @@ class AlbumInfo(object):
constituent `TrackInfo` objects, are decoded to Unicode.
"""
for fld in ['album', 'artist', 'albumtype', 'label', 'artist_sort',
- 'catalognum', 'script', 'language', 'country',
- 'albumstatus', 'albumdisambig', 'artist_credit', 'media']:
+ 'catalognum', 'script', 'language', 'country', 'style',
+ 'genre', 'albumstatus', 'albumdisambig',
+ 'releasegroupdisambig', 'artist_credit',
+ 'media', 'discogs_albumid', 'discogs_labelid',
+ 'discogs_artistid']:
value = getattr(self, fld)
if isinstance(value, bytes):
setattr(self, fld, value.decode(codec, 'ignore'))
- if self.tracks:
- for track in self.tracks:
- track.decode(codec)
+ for track in self.tracks:
+ track.decode(codec)
+
+ def copy(self):
+ dupe = AlbumInfo([])
+ dupe.update(self)
+ dupe.tracks = [track.copy() for track in self.tracks]
+ return dupe
-class TrackInfo(object):
+class TrackInfo(AttrDict):
"""Describes a canonical track present on a release. Appears as part
of an AlbumInfo's ``tracks`` list. Consists of these data members:
- ``title``: name of the track
- ``track_id``: MusicBrainz ID; UUID fragment only
- - ``artist``: individual track artist name
- - ``artist_id``
- - ``length``: float: duration of the track in seconds
- - ``index``: position on the entire release
- - ``media``: delivery mechanism (Vinyl, etc.)
- - ``medium``: the disc number this track appears on in the album
- - ``medium_index``: the track's position on the disc
- - ``medium_total``: the number of tracks on the item's disc
- - ``artist_sort``: name of the track artist for sorting
- - ``disctitle``: name of the individual medium (subtitle)
- - ``artist_credit``: Recording-specific artist name
- - ``data_source``: The original data source (MusicBrainz, Discogs, etc.)
- - ``data_url``: The data source release URL.
- - ``lyricist``: individual track lyricist name
- - ``composer``: individual track composer name
- - ``arranger`: individual track arranger name
- - ``track_alt``: alternative track number (tape, vinyl, etc.)
Only ``title`` and ``track_id`` are required. The rest of the fields
may be None. The indices ``index``, ``medium``, and ``medium_index``
are all 1-based.
"""
- def __init__(self, title, track_id, artist=None, artist_id=None,
- length=None, index=None, medium=None, medium_index=None,
- medium_total=None, artist_sort=None, disctitle=None,
- artist_credit=None, data_source=None, data_url=None,
- media=None, lyricist=None, composer=None, arranger=None,
- track_alt=None):
+
+ def __init__(self, title=None, track_id=None, release_track_id=None,
+ artist=None, artist_id=None, length=None, index=None,
+ medium=None, medium_index=None, medium_total=None,
+ artist_sort=None, disctitle=None, artist_credit=None,
+ data_source=None, data_url=None, media=None, lyricist=None,
+ composer=None, composer_sort=None, arranger=None,
+ track_alt=None, work=None, mb_workid=None,
+ work_disambig=None, bpm=None, initial_key=None, genre=None,
+ **kwargs):
self.title = title
self.track_id = track_id
+ self.release_track_id = release_track_id
self.artist = artist
self.artist_id = artist_id
self.length = length
@@ -174,8 +181,16 @@ class TrackInfo(object):
self.data_url = data_url
self.lyricist = lyricist
self.composer = composer
+ self.composer_sort = composer_sort
self.arranger = arranger
self.track_alt = track_alt
+ self.work = work
+ self.mb_workid = mb_workid
+ self.work_disambig = work_disambig
+ self.bpm = bpm
+ self.initial_key = initial_key
+ self.genre = genre
+ self.update(kwargs)
# As above, work around a bug in python-musicbrainz-ngs.
def decode(self, codec='utf-8'):
@@ -188,6 +203,11 @@ class TrackInfo(object):
if isinstance(value, bytes):
setattr(self, fld, value.decode(codec, 'ignore'))
+ def copy(self):
+ dupe = TrackInfo()
+ dupe.update(self)
+ return dupe
+
# Candidate distance scoring.
@@ -215,8 +235,8 @@ def _string_dist_basic(str1, str2):
transliteration/lowering to ASCII characters. Normalized by string
length.
"""
- assert isinstance(str1, six.text_type)
- assert isinstance(str2, six.text_type)
+ assert isinstance(str1, str)
+ assert isinstance(str2, str)
str1 = as_string(unidecode(str1))
str2 = as_string(unidecode(str2))
str1 = re.sub(r'[^a-z0-9]', '', str1.lower())
@@ -244,9 +264,9 @@ def string_dist(str1, str2):
# "something, the".
for word in SD_END_WORDS:
if str1.endswith(', %s' % word):
- str1 = '%s %s' % (word, str1[:-len(word) - 2])
+ str1 = '{} {}'.format(word, str1[:-len(word) - 2])
if str2.endswith(', %s' % word):
- str2 = '%s %s' % (word, str2[:-len(word) - 2])
+ str2 = '{} {}'.format(word, str2[:-len(word) - 2])
# Perform a couple of basic normalizing substitutions.
for pat, repl in SD_REPLACE:
@@ -284,11 +304,12 @@ def string_dist(str1, str2):
return base_dist + penalty
-class LazyClassProperty(object):
+class LazyClassProperty:
"""A decorator implementing a read-only property that is *lazy* in
the sense that the getter is only invoked once. Subsequent accesses
through *any* instance use the cached result.
"""
+
def __init__(self, getter):
self.getter = getter
self.computed = False
@@ -301,17 +322,17 @@ class LazyClassProperty(object):
@total_ordering
-@six.python_2_unicode_compatible
-class Distance(object):
+class Distance:
"""Keeps track of multiple distance penalties. Provides a single
weighted distance for all penalties as well as a weighted distance
for each individual penalty.
"""
+
def __init__(self):
self._penalties = {}
@LazyClassProperty
- def _weights(cls): # noqa
+ def _weights(cls): # noqa: N805
"""A dictionary from keys to floating-point weights.
"""
weights_view = config['match']['distance_weights']
@@ -389,7 +410,7 @@ class Distance(object):
return other - self.distance
def __str__(self):
- return "{0:.2f}".format(self.distance)
+ return f"{self.distance:.2f}"
# Behave like a dict.
@@ -416,7 +437,7 @@ class Distance(object):
"""
if not isinstance(dist, Distance):
raise ValueError(
- u'`dist` must be a Distance object, not {0}'.format(type(dist))
+ '`dist` must be a Distance object, not {}'.format(type(dist))
)
for key, penalties in dist._penalties.items():
self._penalties.setdefault(key, []).extend(penalties)
@@ -428,7 +449,7 @@ class Distance(object):
be a compiled regular expression, in which case it will be
matched against `value2`.
"""
- if isinstance(value1, re._pattern_type):
+ if isinstance(value1, Pattern):
return bool(value1.match(value2))
return value1 == value2
@@ -440,7 +461,7 @@ class Distance(object):
"""
if not 0.0 <= dist <= 1.0:
raise ValueError(
- u'`dist` must be between 0.0 and 1.0, not {0}'.format(dist)
+ f'`dist` must be between 0.0 and 1.0, not {dist}'
)
self._penalties.setdefault(key, []).append(dist)
@@ -534,7 +555,10 @@ def album_for_mbid(release_id):
if the ID is not found.
"""
try:
- return mb.album_for_id(release_id)
+ album = mb.album_for_id(release_id)
+ if album:
+ plugins.send('albuminfo_received', info=album)
+ return album
except mb.MusicBrainzAPIError as exc:
exc.log(log)
@@ -544,12 +568,14 @@ def track_for_mbid(recording_id):
if the ID is not found.
"""
try:
- return mb.track_for_id(recording_id)
+ track = mb.track_for_id(recording_id)
+ if track:
+ plugins.send('trackinfo_received', info=track)
+ return track
except mb.MusicBrainzAPIError as exc:
exc.log(log)
-@plugins.notify_info_yielded(u'albuminfo_received')
def albums_for_id(album_id):
"""Get a list of albums for an ID."""
a = album_for_mbid(album_id)
@@ -557,10 +583,10 @@ def albums_for_id(album_id):
yield a
for a in plugins.album_for_id(album_id):
if a:
+ plugins.send('albuminfo_received', info=a)
yield a
-@plugins.notify_info_yielded(u'trackinfo_received')
def tracks_for_id(track_id):
"""Get a list of tracks for an ID."""
t = track_for_mbid(track_id)
@@ -568,39 +594,43 @@ def tracks_for_id(track_id):
yield t
for t in plugins.track_for_id(track_id):
if t:
+ plugins.send('trackinfo_received', info=t)
yield t
-@plugins.notify_info_yielded(u'albuminfo_received')
-def album_candidates(items, artist, album, va_likely):
+@plugins.notify_info_yielded('albuminfo_received')
+def album_candidates(items, artist, album, va_likely, extra_tags):
"""Search for album matches. ``items`` is a list of Item objects
that make up the album. ``artist`` and ``album`` are the respective
names (strings), which may be derived from the item list or may be
entered by the user. ``va_likely`` is a boolean indicating whether
- the album is likely to be a "various artists" release.
+ the album is likely to be a "various artists" release. ``extra_tags``
+ is an optional dictionary of additional tags used to further
+ constrain the search.
"""
+
# Base candidates if we have album and artist to match.
if artist and album:
try:
- for candidate in mb.match_album(artist, album, len(items)):
- yield candidate
+ yield from mb.match_album(artist, album, len(items),
+ extra_tags)
except mb.MusicBrainzAPIError as exc:
exc.log(log)
# Also add VA matches from MusicBrainz where appropriate.
if va_likely and album:
try:
- for candidate in mb.match_album(None, album, len(items)):
- yield candidate
+ yield from mb.match_album(None, album, len(items),
+ extra_tags)
except mb.MusicBrainzAPIError as exc:
exc.log(log)
# Candidates from plugins.
- for candidate in plugins.candidates(items, artist, album, va_likely):
- yield candidate
+ yield from plugins.candidates(items, artist, album, va_likely,
+ extra_tags)
-@plugins.notify_info_yielded(u'trackinfo_received')
+@plugins.notify_info_yielded('trackinfo_received')
def item_candidates(item, artist, title):
"""Search for item matches. ``item`` is the Item to be matched.
``artist`` and ``title`` are strings and either reflect the item or
@@ -610,11 +640,9 @@ def item_candidates(item, artist, title):
# MusicBrainz candidates.
if artist and title:
try:
- for candidate in mb.match_track(artist, title):
- yield candidate
+ yield from mb.match_track(artist, title)
except mb.MusicBrainzAPIError as exc:
exc.log(log)
# Plugin candidates.
- for candidate in plugins.item_candidates(item, artist, title):
- yield candidate
+ yield from plugins.item_candidates(item, artist, title)
diff --git a/lib/beets/autotag/match.py b/lib/beets/autotag/match.py
old mode 100755
new mode 100644
index 71b62adb..d352a013
--- a/lib/beets/autotag/match.py
+++ b/lib/beets/autotag/match.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
# This file is part of beets.
# Copyright 2016, Adrian Sampson.
#
@@ -17,7 +16,6 @@
releases and tracks.
"""
-from __future__ import division, absolute_import, print_function
import datetime
import re
@@ -35,7 +33,7 @@ from beets.util.enumeration import OrderedEnum
# album level to determine whether a given release is likely a VA
# release and also on the track level to to remove the penalty for
# differing artists.
-VA_ARTISTS = (u'', u'various artists', u'various', u'va', u'unknown')
+VA_ARTISTS = ('', 'various artists', 'various', 'va', 'unknown')
# Global logger.
log = logging.getLogger('beets')
@@ -108,7 +106,7 @@ def assign_items(items, tracks):
log.debug('...done.')
# Produce the output matching.
- mapping = dict((items[i], tracks[j]) for (i, j) in matching)
+ mapping = {items[i]: tracks[j] for (i, j) in matching}
extra_items = list(set(items) - set(mapping.keys()))
extra_items.sort(key=lambda i: (i.disc, i.track, i.title))
extra_tracks = list(set(tracks) - set(mapping.values()))
@@ -276,16 +274,16 @@ def match_by_id(items):
try:
first = next(albumids)
except StopIteration:
- log.debug(u'No album ID found.')
+ log.debug('No album ID found.')
return None
# Is there a consensus on the MB album ID?
for other in albumids:
if other != first:
- log.debug(u'No album ID consensus.')
+ log.debug('No album ID consensus.')
return None
# If all album IDs are equal, look up the album.
- log.debug(u'Searching for discovered album ID: {0}', first)
+ log.debug('Searching for discovered album ID: {0}', first)
return hooks.album_for_mbid(first)
@@ -351,23 +349,23 @@ def _add_candidate(items, results, info):
checking the track count, ordering the items, checking for
duplicates, and calculating the distance.
"""
- log.debug(u'Candidate: {0} - {1} ({2})',
+ log.debug('Candidate: {0} - {1} ({2})',
info.artist, info.album, info.album_id)
# Discard albums with zero tracks.
if not info.tracks:
- log.debug(u'No tracks.')
+ log.debug('No tracks.')
return
# Don't duplicate.
if info.album_id in results:
- log.debug(u'Duplicate.')
+ log.debug('Duplicate.')
return
# Discard matches without required tags.
for req_tag in config['match']['required'].as_str_seq():
if getattr(info, req_tag) is None:
- log.debug(u'Ignored. Missing required tag: {0}', req_tag)
+ log.debug('Ignored. Missing required tag: {0}', req_tag)
return
# Find mapping between the items and the track info.
@@ -380,10 +378,10 @@ def _add_candidate(items, results, info):
penalties = [key for key, _ in dist]
for penalty in config['match']['ignored'].as_str_seq():
if penalty in penalties:
- log.debug(u'Ignored. Penalty: {0}', penalty)
+ log.debug('Ignored. Penalty: {0}', penalty)
return
- log.debug(u'Success. Distance: {0}', dist)
+ log.debug('Success. Distance: {0}', dist)
results[info.album_id] = hooks.AlbumMatch(dist, info, mapping,
extra_items, extra_tracks)
@@ -411,7 +409,7 @@ def tag_album(items, search_artist=None, search_album=None,
likelies, consensus = current_metadata(items)
cur_artist = likelies['artist']
cur_album = likelies['album']
- log.debug(u'Tagging {0} - {1}', cur_artist, cur_album)
+ log.debug('Tagging {0} - {1}', cur_artist, cur_album)
# The output result (distance, AlbumInfo) tuples (keyed by MB album
# ID).
@@ -420,7 +418,7 @@ def tag_album(items, search_artist=None, search_album=None,
# Search by explicit ID.
if search_ids:
for search_id in search_ids:
- log.debug(u'Searching for album ID: {0}', search_id)
+ log.debug('Searching for album ID: {0}', search_id)
for id_candidate in hooks.albums_for_id(search_id):
_add_candidate(items, candidates, id_candidate)
@@ -431,13 +429,13 @@ def tag_album(items, search_artist=None, search_album=None,
if id_info:
_add_candidate(items, candidates, id_info)
rec = _recommendation(list(candidates.values()))
- log.debug(u'Album ID match recommendation is {0}', rec)
+ log.debug('Album ID match recommendation is {0}', rec)
if candidates and not config['import']['timid']:
# If we have a very good MBID match, return immediately.
# Otherwise, this match will compete against metadata-based
# matches.
if rec == Recommendation.strong:
- log.debug(u'ID match.')
+ log.debug('ID match.')
return cur_artist, cur_album, \
Proposal(list(candidates.values()), rec)
@@ -445,22 +443,29 @@ def tag_album(items, search_artist=None, search_album=None,
if not (search_artist and search_album):
# No explicit search terms -- use current metadata.
search_artist, search_album = cur_artist, cur_album
- log.debug(u'Search terms: {0} - {1}', search_artist, search_album)
+ log.debug('Search terms: {0} - {1}', search_artist, search_album)
+
+ extra_tags = None
+ if config['musicbrainz']['extra_tags']:
+ tag_list = config['musicbrainz']['extra_tags'].get()
+ extra_tags = {k: v for (k, v) in likelies.items() if k in tag_list}
+ log.debug('Additional search terms: {0}', extra_tags)
# Is this album likely to be a "various artist" release?
va_likely = ((not consensus['artist']) or
(search_artist.lower() in VA_ARTISTS) or
any(item.comp for item in items))
- log.debug(u'Album might be VA: {0}', va_likely)
+ log.debug('Album might be VA: {0}', va_likely)
# Get the results from the data sources.
for matched_candidate in hooks.album_candidates(items,
search_artist,
search_album,
- va_likely):
+ va_likely,
+ extra_tags):
_add_candidate(items, candidates, matched_candidate)
- log.debug(u'Evaluating {0} candidates.', len(candidates))
+ log.debug('Evaluating {0} candidates.', len(candidates))
# Sort and get the recommendation.
candidates = _sort_candidates(candidates.values())
rec = _recommendation(candidates)
@@ -485,7 +490,7 @@ def tag_item(item, search_artist=None, search_title=None,
trackids = search_ids or [t for t in [item.mb_trackid] if t]
if trackids:
for trackid in trackids:
- log.debug(u'Searching for track ID: {0}', trackid)
+ log.debug('Searching for track ID: {0}', trackid)
for track_info in hooks.tracks_for_id(trackid):
dist = track_distance(item, track_info, incl_artist=True)
candidates[track_info.track_id] = \
@@ -494,7 +499,7 @@ def tag_item(item, search_artist=None, search_title=None,
rec = _recommendation(_sort_candidates(candidates.values()))
if rec == Recommendation.strong and \
not config['import']['timid']:
- log.debug(u'Track ID match.')
+ log.debug('Track ID match.')
return Proposal(_sort_candidates(candidates.values()), rec)
# If we're searching by ID, don't proceed.
@@ -507,7 +512,7 @@ def tag_item(item, search_artist=None, search_title=None,
# Search terms.
if not (search_artist and search_title):
search_artist, search_title = item.artist, item.title
- log.debug(u'Item search terms: {0} - {1}', search_artist, search_title)
+ log.debug('Item search terms: {0} - {1}', search_artist, search_title)
# Get and evaluate candidate metadata.
for track_info in hooks.item_candidates(item, search_artist, search_title):
@@ -515,7 +520,7 @@ def tag_item(item, search_artist=None, search_title=None,
candidates[track_info.track_id] = hooks.TrackMatch(dist, track_info)
# Sort by distance and return with recommendation.
- log.debug(u'Found {0} candidates.', len(candidates))
+ log.debug('Found {0} candidates.', len(candidates))
candidates = _sort_candidates(candidates.values())
rec = _recommendation(candidates)
return Proposal(candidates, rec)
diff --git a/lib/beets/autotag/mb.py b/lib/beets/autotag/mb.py
old mode 100755
new mode 100644
index a6133adb..e6a2e277
--- a/lib/beets/autotag/mb.py
+++ b/lib/beets/autotag/mb.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
# This file is part of beets.
# Copyright 2016, Adrian Sampson.
#
@@ -15,55 +14,72 @@
"""Searches for albums in the MusicBrainz database.
"""
-from __future__ import division, absolute_import, print_function
import musicbrainzngs
import re
import traceback
-from six.moves.urllib.parse import urljoin
from beets import logging
+from beets import plugins
import beets.autotag.hooks
import beets
from beets import util
from beets import config
-import six
+from collections import Counter
+from urllib.parse import urljoin
VARIOUS_ARTISTS_ID = '89ad4ac3-39f7-470e-963a-56509c546377'
-if util.SNI_SUPPORTED:
- BASE_URL = 'https://musicbrainz.org/'
-else:
- BASE_URL = 'http://musicbrainz.org/'
+BASE_URL = 'https://musicbrainz.org/'
+
+SKIPPED_TRACKS = ['[data track]']
+
+FIELDS_TO_MB_KEYS = {
+ 'catalognum': 'catno',
+ 'country': 'country',
+ 'label': 'label',
+ 'media': 'format',
+ 'year': 'date',
+}
musicbrainzngs.set_useragent('beets', beets.__version__,
- 'http://beets.io/')
+ 'https://beets.io/')
class MusicBrainzAPIError(util.HumanReadableException):
"""An error while talking to MusicBrainz. The `query` field is the
parameter to the action and may have any type.
"""
+
def __init__(self, reason, verb, query, tb=None):
self.query = query
if isinstance(reason, musicbrainzngs.WebServiceError):
- reason = u'MusicBrainz not reachable'
- super(MusicBrainzAPIError, self).__init__(reason, verb, tb)
+ reason = 'MusicBrainz not reachable'
+ super().__init__(reason, verb, tb)
def get_message(self):
- return u'{0} in {1} with query {2}'.format(
+ return '{} in {} with query {}'.format(
self._reasonstr(), self.verb, repr(self.query)
)
+
log = logging.getLogger('beets')
RELEASE_INCLUDES = ['artists', 'media', 'recordings', 'release-groups',
'labels', 'artist-credits', 'aliases',
'recording-level-rels', 'work-rels',
- 'work-level-rels', 'artist-rels']
-TRACK_INCLUDES = ['artists', 'aliases']
+ 'work-level-rels', 'artist-rels', 'isrcs']
+BROWSE_INCLUDES = ['artist-credits', 'work-rels',
+ 'artist-rels', 'recording-rels', 'release-rels']
+if "work-level-rels" in musicbrainzngs.VALID_BROWSE_INCLUDES['recording']:
+ BROWSE_INCLUDES.append("work-level-rels")
+BROWSE_CHUNKSIZE = 100
+BROWSE_MAXTRACKS = 500
+TRACK_INCLUDES = ['artists', 'aliases', 'isrcs']
if 'work-level-rels' in musicbrainzngs.VALID_INCLUDES['recording']:
TRACK_INCLUDES += ['work-level-rels', 'artist-rels']
+if 'genres' in musicbrainzngs.VALID_INCLUDES['recording']:
+ RELEASE_INCLUDES += ['genres']
def track_url(trackid):
@@ -79,7 +95,11 @@ def configure():
from the beets configuration. This should be called at startup.
"""
hostname = config['musicbrainz']['host'].as_str()
- musicbrainzngs.set_hostname(hostname)
+ https = config['musicbrainz']['https'].get(bool)
+ # Only call set_hostname when a custom server is configured. Since
+ # musicbrainz-ngs connects to musicbrainz.org with HTTPS by default
+ if hostname != "musicbrainz.org":
+ musicbrainzngs.set_hostname(hostname, https)
musicbrainzngs.set_rate_limit(
config['musicbrainz']['ratelimit_interval'].as_number(),
config['musicbrainz']['ratelimit'].get(int),
@@ -109,6 +129,24 @@ def _preferred_alias(aliases):
return matches[0]
+def _preferred_release_event(release):
+ """Given a release, select and return the user's preferred release
+ event as a tuple of (country, release_date). Fall back to the
+ default release event if a preferred event is not found.
+ """
+ countries = config['match']['preferred']['countries'].as_str_seq()
+
+ for country in countries:
+ for event in release.get('release-event-list', {}):
+ try:
+ if country in event['area']['iso-3166-1-code-list']:
+ return country, event['date']
+ except KeyError:
+ pass
+
+ return release.get('country'), release.get('date')
+
+
def _flatten_artist_credit(credit):
"""Given a list representing an ``artist-credit`` block, flatten the
data into a triple of joined artist name strings: canonical, sort, and
@@ -118,7 +156,7 @@ def _flatten_artist_credit(credit):
artist_sort_parts = []
artist_credit_parts = []
for el in credit:
- if isinstance(el, six.string_types):
+ if isinstance(el, str):
# Join phrase.
artist_parts.append(el)
artist_credit_parts.append(el)
@@ -165,13 +203,13 @@ def track_info(recording, index=None, medium=None, medium_index=None,
the number of tracks on the medium. Each number is a 1-based index.
"""
info = beets.autotag.hooks.TrackInfo(
- recording['title'],
- recording['id'],
+ title=recording['title'],
+ track_id=recording['id'],
index=index,
medium=medium,
medium_index=medium_index,
medium_total=medium_total,
- data_source=u'MusicBrainz',
+ data_source='MusicBrainz',
data_url=track_url(recording['id']),
)
@@ -187,11 +225,22 @@ def track_info(recording, index=None, medium=None, medium_index=None,
if recording.get('length'):
info.length = int(recording['length']) / (1000.0)
+ info.trackdisambig = recording.get('disambiguation')
+
+ if recording.get('isrc-list'):
+ info.isrc = ';'.join(recording['isrc-list'])
+
lyricist = []
composer = []
+ composer_sort = []
for work_relation in recording.get('work-relation-list', ()):
if work_relation['type'] != 'performance':
continue
+ info.work = work_relation['work']['title']
+ info.mb_workid = work_relation['work']['id']
+ if 'disambiguation' in work_relation['work']:
+ info.work_disambig = work_relation['work']['disambiguation']
+
for artist_relation in work_relation['work'].get(
'artist-relation-list', ()):
if 'type' in artist_relation:
@@ -200,10 +249,13 @@ def track_info(recording, index=None, medium=None, medium_index=None,
lyricist.append(artist_relation['artist']['name'])
elif type == 'composer':
composer.append(artist_relation['artist']['name'])
+ composer_sort.append(
+ artist_relation['artist']['sort-name'])
if lyricist:
- info.lyricist = u', '.join(lyricist)
+ info.lyricist = ', '.join(lyricist)
if composer:
- info.composer = u', '.join(composer)
+ info.composer = ', '.join(composer)
+ info.composer_sort = ', '.join(composer_sort)
arranger = []
for artist_relation in recording.get('artist-relation-list', ()):
@@ -212,7 +264,12 @@ def track_info(recording, index=None, medium=None, medium_index=None,
if type == 'arranger':
arranger.append(artist_relation['artist']['name'])
if arranger:
- info.arranger = u', '.join(arranger)
+ info.arranger = ', '.join(arranger)
+
+ # Supplementary fields provided by plugins
+ extra_trackdatas = plugins.send('mb_track_extract', data=recording)
+ for extra_trackdata in extra_trackdatas:
+ info.update(extra_trackdata)
info.decode()
return info
@@ -246,6 +303,26 @@ def album_info(release):
artist_name, artist_sort_name, artist_credit_name = \
_flatten_artist_credit(release['artist-credit'])
+ ntracks = sum(len(m['track-list']) for m in release['medium-list'])
+
+ # The MusicBrainz API omits 'artist-relation-list' and 'work-relation-list'
+ # when the release has more than 500 tracks. So we use browse_recordings
+ # on chunks of tracks to recover the same information in this case.
+ if ntracks > BROWSE_MAXTRACKS:
+ log.debug('Album {} has too many tracks', release['id'])
+ recording_list = []
+ for i in range(0, ntracks, BROWSE_CHUNKSIZE):
+ log.debug('Retrieving tracks starting at {}', i)
+ recording_list.extend(musicbrainzngs.browse_recordings(
+ release=release['id'], limit=BROWSE_CHUNKSIZE,
+ includes=BROWSE_INCLUDES,
+ offset=i)['recording-list'])
+ track_map = {r['id']: r for r in recording_list}
+ for medium in release['medium-list']:
+ for recording in medium['track-list']:
+ recording_info = track_map[recording['recording']['id']]
+ recording['recording'] = recording_info
+
# Basic info.
track_infos = []
index = 0
@@ -253,11 +330,29 @@ def album_info(release):
disctitle = medium.get('title')
format = medium.get('format')
+ if format in config['match']['ignored_media'].as_str_seq():
+ continue
+
all_tracks = medium['track-list']
+ if ('data-track-list' in medium
+ and not config['match']['ignore_data_tracks']):
+ all_tracks += medium['data-track-list']
+ track_count = len(all_tracks)
+
if 'pregap' in medium:
all_tracks.insert(0, medium['pregap'])
for track in all_tracks:
+
+ if ('title' in track['recording'] and
+ track['recording']['title'] in SKIPPED_TRACKS):
+ continue
+
+ if ('video' in track['recording'] and
+ track['recording']['video'] == 'true' and
+ config['match']['ignore_video_tracks']):
+ continue
+
# Basic information from the recording.
index += 1
ti = track_info(
@@ -265,8 +360,9 @@ def album_info(release):
index,
int(medium['position']),
int(track['position']),
- len(medium['track-list']),
+ track_count,
)
+ ti.release_track_id = track['id']
ti.disctitle = disctitle
ti.media = format
ti.track_alt = track['number']
@@ -285,15 +381,15 @@ def album_info(release):
track_infos.append(ti)
info = beets.autotag.hooks.AlbumInfo(
- release['title'],
- release['id'],
- artist_name,
- release['artist-credit'][0]['artist']['id'],
- track_infos,
+ album=release['title'],
+ album_id=release['id'],
+ artist=artist_name,
+ artist_id=release['artist-credit'][0]['artist']['id'],
+ tracks=track_infos,
mediums=len(release['medium-list']),
artist_sort=artist_sort_name,
artist_credit=artist_credit_name,
- data_source=u'MusicBrainz',
+ data_source='MusicBrainz',
data_url=album_url(release['id']),
)
info.va = info.artist_id == VARIOUS_ARTISTS_ID
@@ -301,25 +397,36 @@ def album_info(release):
info.artist = config['va_name'].as_str()
info.asin = release.get('asin')
info.releasegroup_id = release['release-group']['id']
- info.country = release.get('country')
info.albumstatus = release.get('status')
- # Build up the disambiguation string from the release group and release.
- disambig = []
+ # Get the disambiguation strings at the release and release group level.
if release['release-group'].get('disambiguation'):
- disambig.append(release['release-group'].get('disambiguation'))
+ info.releasegroupdisambig = \
+ release['release-group'].get('disambiguation')
if release.get('disambiguation'):
- disambig.append(release.get('disambiguation'))
- info.albumdisambig = u', '.join(disambig)
+ info.albumdisambig = release.get('disambiguation')
- # Release type not always populated.
+ # Get the "classic" Release type. This data comes from a legacy API
+ # feature before MusicBrainz supported multiple release types.
if 'type' in release['release-group']:
reltype = release['release-group']['type']
if reltype:
info.albumtype = reltype.lower()
- # Release dates.
- release_date = release.get('date')
+ # Set the new-style "primary" and "secondary" release types.
+ albumtypes = []
+ if 'primary-type' in release['release-group']:
+ rel_primarytype = release['release-group']['primary-type']
+ if rel_primarytype:
+ albumtypes.append(rel_primarytype.lower())
+ if 'secondary-type-list' in release['release-group']:
+ if release['release-group']['secondary-type-list']:
+ for sec_type in release['release-group']['secondary-type-list']:
+ albumtypes.append(sec_type.lower())
+ info.albumtypes = '; '.join(albumtypes)
+
+ # Release events.
+ info.country, release_date = _preferred_release_event(release)
release_group_date = release['release-group'].get('first-release-date')
if not release_date:
# Fall back if release-specific date is not available.
@@ -347,17 +454,33 @@ def album_info(release):
first_medium = release['medium-list'][0]
info.media = first_medium.get('format')
+ if config['musicbrainz']['genres']:
+ sources = [
+ release['release-group'].get('genre-list', []),
+ release.get('genre-list', []),
+ ]
+ genres = Counter()
+ for source in sources:
+ for genreitem in source:
+ genres[genreitem['name']] += int(genreitem['count'])
+ info.genre = '; '.join(g[0] for g in sorted(genres.items(),
+ key=lambda g: -g[1]))
+
+ extra_albumdatas = plugins.send('mb_album_extract', data=release)
+ for extra_albumdata in extra_albumdatas:
+ info.update(extra_albumdata)
+
info.decode()
return info
-def match_album(artist, album, tracks=None):
+def match_album(artist, album, tracks=None, extra_tags=None):
"""Searches for a single album ("release" in MusicBrainz parlance)
and returns an iterator over AlbumInfo objects. May raise a
MusicBrainzAPIError.
The query consists of an artist name, an album name, and,
- optionally, a number of tracks on the album.
+ optionally, a number of tracks on the album and any other extra tags.
"""
# Build search criteria.
criteria = {'release': album.lower().strip()}
@@ -367,14 +490,24 @@ def match_album(artist, album, tracks=None):
# Various Artists search.
criteria['arid'] = VARIOUS_ARTISTS_ID
if tracks is not None:
- criteria['tracks'] = six.text_type(tracks)
+ criteria['tracks'] = str(tracks)
+
+ # Additional search cues from existing metadata.
+ if extra_tags:
+ for tag in extra_tags:
+ key = FIELDS_TO_MB_KEYS[tag]
+ value = str(extra_tags.get(tag, '')).lower().strip()
+ if key == 'catno':
+ value = value.replace(' ', '')
+ if value:
+ criteria[key] = value
# Abort if we have no search terms.
if not any(criteria.values()):
return
try:
- log.debug(u'Searching for MusicBrainz releases with: {!r}', criteria)
+ log.debug('Searching for MusicBrainz releases with: {!r}', criteria)
res = musicbrainzngs.search_releases(
limit=config['musicbrainz']['searchlimit'].get(int), **criteria)
except musicbrainzngs.MusicBrainzError as exc:
@@ -415,7 +548,7 @@ def _parse_id(s):
no ID can be found, return None.
"""
# Find the first thing that looks like a UUID/MBID.
- match = re.search(u'[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}', s)
+ match = re.search('[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}', s)
if match:
return match.group()
@@ -425,19 +558,19 @@ def album_for_id(releaseid):
object or None if the album is not found. May raise a
MusicBrainzAPIError.
"""
- log.debug(u'Requesting MusicBrainz release {}', releaseid)
+ log.debug('Requesting MusicBrainz release {}', releaseid)
albumid = _parse_id(releaseid)
if not albumid:
- log.debug(u'Invalid MBID ({0}).', releaseid)
+ log.debug('Invalid MBID ({0}).', releaseid)
return
try:
res = musicbrainzngs.get_release_by_id(albumid,
RELEASE_INCLUDES)
except musicbrainzngs.ResponseError:
- log.debug(u'Album ID match failed.')
+ log.debug('Album ID match failed.')
return None
except musicbrainzngs.MusicBrainzError as exc:
- raise MusicBrainzAPIError(exc, u'get release by ID', albumid,
+ raise MusicBrainzAPIError(exc, 'get release by ID', albumid,
traceback.format_exc())
return album_info(res['release'])
@@ -448,14 +581,14 @@ def track_for_id(releaseid):
"""
trackid = _parse_id(releaseid)
if not trackid:
- log.debug(u'Invalid MBID ({0}).', releaseid)
+ log.debug('Invalid MBID ({0}).', releaseid)
return
try:
res = musicbrainzngs.get_recording_by_id(trackid, TRACK_INCLUDES)
except musicbrainzngs.ResponseError:
- log.debug(u'Track ID match failed.')
+ log.debug('Track ID match failed.')
return None
except musicbrainzngs.MusicBrainzError as exc:
- raise MusicBrainzAPIError(exc, u'get recording by ID', trackid,
+ raise MusicBrainzAPIError(exc, 'get recording by ID', trackid,
traceback.format_exc())
return track_info(res['recording'])
diff --git a/lib/beets/config_default.yaml b/lib/beets/config_default.yaml
old mode 100755
new mode 100644
index 3b037796..74540891
--- a/lib/beets/config_default.yaml
+++ b/lib/beets/config_default.yaml
@@ -7,9 +7,12 @@ import:
move: no
link: no
hardlink: no
+ reflink: no
delete: no
resume: ask
incremental: no
+ incremental_skip_later: no
+ from_scratch: no
quiet_fallback: skip
none_rec_action: ask
timid: no
@@ -25,6 +28,8 @@ import:
pretend: false
search_ids: []
duplicate_action: ask
+ bell: no
+ set_fields: {}
clutter: ["Thumbs.DB", ".DS_Store"]
ignore: [".*", "*~", "System Volume Information", "lost+found"]
@@ -38,11 +43,22 @@ replace:
'\.$': _
'\s+$': ''
'^\s+': ''
+ '^-': _
path_sep_replace: _
+drive_sep_replace: _
asciify_paths: false
art_filename: cover
max_filename_length: 0
+aunique:
+ keys: albumartist album
+ disambiguators: albumtype year label catalognum albumdisambig releasegroupdisambig
+ bracket: '[]'
+
+overwrite_null:
+ album: []
+ track: []
+
plugins: []
pluginpath: []
threaded: yes
@@ -51,6 +67,7 @@ per_disc_numbering: no
verbose: 0
terminal_encoding:
original_date: no
+artist_credit: no
id3v23: no
va_name: "Various Artists"
@@ -85,9 +102,12 @@ statefile: state.pickle
musicbrainz:
host: musicbrainz.org
+ https: no
ratelimit: 1
ratelimit_interval: 1.0
searchlimit: 5
+ extra_tags: []
+ genres: no
match:
strong_rec_thresh: 0.04
@@ -122,5 +142,8 @@ match:
original_year: no
ignored: []
required: []
+ ignored_media: []
+ ignore_data_tracks: yes
+ ignore_video_tracks: yes
track_length_grace: 10
track_length_max: 30
diff --git a/lib/beets/dbcore/__init__.py b/lib/beets/dbcore/__init__.py
old mode 100755
new mode 100644
index 689e7202..923c34ca
--- a/lib/beets/dbcore/__init__.py
+++ b/lib/beets/dbcore/__init__.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
# This file is part of beets.
# Copyright 2016, Adrian Sampson.
#
@@ -16,7 +15,6 @@
"""DBCore is an abstract database package that forms the basis for beets'
Library.
"""
-from __future__ import division, absolute_import, print_function
from .db import Model, Database
from .query import Query, FieldQuery, MatchQuery, AndQuery, OrQuery
diff --git a/lib/beets/dbcore/db.py b/lib/beets/dbcore/db.py
index 6b0ed8b4..acd131be 100755
--- a/lib/beets/dbcore/db.py
+++ b/lib/beets/dbcore/db.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
# This file is part of beets.
# Copyright 2016, Adrian Sampson.
#
@@ -15,38 +14,56 @@
"""The central Model and Database constructs for DBCore.
"""
-from __future__ import division, absolute_import, print_function
import time
import os
+import re
from collections import defaultdict
import threading
import sqlite3
import contextlib
-import collections
import beets
-from beets.util.functemplate import Template
+from beets.util import functemplate
from beets.util import py3_path
from beets.dbcore import types
from .query import MatchQuery, NullSort, TrueQuery
-import six
+from collections.abc import Mapping
-class FormattedMapping(collections.Mapping):
+class DBAccessError(Exception):
+ """The SQLite database became inaccessible.
+
+ This can happen when trying to read or write the database when, for
+ example, the database file is deleted or otherwise disappears. There
+ is probably no way to recover from this error.
+ """
+
+
+class FormattedMapping(Mapping):
"""A `dict`-like formatted view of a model.
The accessor `mapping[key]` returns the formatted version of
`model[key]` as a unicode string.
+ The `included_keys` parameter allows filtering the fields that are
+ returned. By default all fields are returned. Limiting to specific keys can
+ avoid expensive per-item database queries.
+
If `for_path` is true, all path separators in the formatted values
are replaced.
"""
- def __init__(self, model, for_path=False):
+ ALL_KEYS = '*'
+
+ def __init__(self, model, included_keys=ALL_KEYS, for_path=False):
self.for_path = for_path
self.model = model
- self.model_keys = model.keys(True)
+ if included_keys == self.ALL_KEYS:
+ # Performance note: this triggers a database query.
+ self.model_keys = self.model.keys(True)
+ else:
+ self.model_keys = included_keys
def __getitem__(self, key):
if key in self.model_keys:
@@ -63,7 +80,7 @@ class FormattedMapping(collections.Mapping):
def get(self, key, default=None):
if default is None:
default = self.model._type(key).format(None)
- return super(FormattedMapping, self).get(key, default)
+ return super().get(key, default)
def _get_formatted(self, model, key):
value = model._type(key).format(model.get(key))
@@ -72,6 +89,11 @@ class FormattedMapping(collections.Mapping):
if self.for_path:
sep_repl = beets.config['path_sep_replace'].as_str()
+ sep_drive = beets.config['drive_sep_replace'].as_str()
+
+ if re.match(r'^\w:', value):
+ value = re.sub(r'(?<=^\w):', sep_drive, value)
+
for sep in (os.path.sep, os.path.altsep):
if sep:
value = value.replace(sep, sep_repl)
@@ -79,11 +101,105 @@ class FormattedMapping(collections.Mapping):
return value
+class LazyConvertDict:
+ """Lazily convert types for attributes fetched from the database
+ """
+
+ def __init__(self, model_cls):
+ """Initialize the object empty
+ """
+ self.data = {}
+ self.model_cls = model_cls
+ self._converted = {}
+
+ def init(self, data):
+ """Set the base data that should be lazily converted
+ """
+ self.data = data
+
+ def _convert(self, key, value):
+ """Convert the attribute type according the the SQL type
+ """
+ return self.model_cls._type(key).from_sql(value)
+
+ def __setitem__(self, key, value):
+ """Set an attribute value, assume it's already converted
+ """
+ self._converted[key] = value
+
+ def __getitem__(self, key):
+ """Get an attribute value, converting the type on demand
+ if needed
+ """
+ if key in self._converted:
+ return self._converted[key]
+ elif key in self.data:
+ value = self._convert(key, self.data[key])
+ self._converted[key] = value
+ return value
+
+ def __delitem__(self, key):
+ """Delete both converted and base data
+ """
+ if key in self._converted:
+ del self._converted[key]
+ if key in self.data:
+ del self.data[key]
+
+ def keys(self):
+ """Get a list of available field names for this object.
+ """
+ return list(self._converted.keys()) + list(self.data.keys())
+
+ def copy(self):
+ """Create a copy of the object.
+ """
+ new = self.__class__(self.model_cls)
+ new.data = self.data.copy()
+ new._converted = self._converted.copy()
+ return new
+
+ # Act like a dictionary.
+
+ def update(self, values):
+ """Assign all values in the given dict.
+ """
+ for key, value in values.items():
+ self[key] = value
+
+ def items(self):
+ """Iterate over (key, value) pairs that this object contains.
+ Computed fields are not included.
+ """
+ for key in self:
+ yield key, self[key]
+
+ def get(self, key, default=None):
+ """Get the value for a given key or `default` if it does not
+ exist.
+ """
+ if key in self:
+ return self[key]
+ else:
+ return default
+
+ def __contains__(self, key):
+ """Determine whether `key` is an attribute on this object.
+ """
+ return key in self.keys()
+
+ def __iter__(self):
+ """Iterate over the available field names (excluding computed
+ fields).
+ """
+ return iter(self.keys())
+
+
# Abstract base for model classes.
-class Model(object):
+class Model:
"""An abstract object representing an object in the database. Model
- objects act like dictionaries (i.e., the allow subscript access like
+ objects act like dictionaries (i.e., they allow subscript access like
``obj['field']``). The same field set is available via attribute
access as a shortcut (i.e., ``obj.field``). Three kinds of attributes are
available:
@@ -134,12 +250,22 @@ class Model(object):
are subclasses of `Sort`.
"""
+ _queries = {}
+ """Named queries that use a field-like `name:value` syntax but which
+ do not relate to any specific field.
+ """
+
_always_dirty = False
"""By default, fields only become "dirty" when their value actually
changes. Enabling this flag marks fields as dirty even when the new
value is the same as the old value (e.g., `o.f = o.f`).
"""
+ _revision = -1
+ """A revision number from when the model was loaded from or written
+ to the database.
+ """
+
@classmethod
def _getters(cls):
"""Return a mapping from field names to getter functions.
@@ -163,8 +289,8 @@ class Model(object):
"""
self._db = db
self._dirty = set()
- self._values_fixed = {}
- self._values_flex = {}
+ self._values_fixed = LazyConvertDict(self)
+ self._values_flex = LazyConvertDict(self)
# Initial contents.
self.update(values)
@@ -178,23 +304,25 @@ class Model(object):
ordinary construction are bypassed.
"""
obj = cls(db)
- for key, value in fixed_values.items():
- obj._values_fixed[key] = cls._type(key).from_sql(value)
- for key, value in flex_values.items():
- obj._values_flex[key] = cls._type(key).from_sql(value)
+
+ obj._values_fixed.init(fixed_values)
+ obj._values_flex.init(flex_values)
+
return obj
def __repr__(self):
- return '{0}({1})'.format(
+ return '{}({})'.format(
type(self).__name__,
- ', '.join('{0}={1!r}'.format(k, v) for k, v in dict(self).items()),
+ ', '.join(f'{k}={v!r}' for k, v in dict(self).items()),
)
def clear_dirty(self):
"""Mark all fields as *clean* (i.e., not needing to be stored to
- the database).
+ the database). Also update the revision.
"""
self._dirty = set()
+ if self._db:
+ self._revision = self._db.revision
def _check_db(self, need_id=True):
"""Ensure that this object is associated with a database row: it
@@ -203,10 +331,25 @@ class Model(object):
"""
if not self._db:
raise ValueError(
- u'{0} has no database'.format(type(self).__name__)
+ '{} has no database'.format(type(self).__name__)
)
if need_id and not self.id:
- raise ValueError(u'{0} has no id'.format(type(self).__name__))
+ raise ValueError('{} has no id'.format(type(self).__name__))
+
+ def copy(self):
+ """Create a copy of the model object.
+
+ The field values and other state is duplicated, but the new copy
+ remains associated with the same database as the old object.
+ (A simple `copy.deepcopy` will not work because it would try to
+ duplicate the SQLite connection.)
+ """
+ new = self.__class__()
+ new._db = self._db
+ new._values_fixed = self._values_fixed.copy()
+ new._values_flex = self._values_flex.copy()
+ new._dirty = self._dirty.copy()
+ return new
# Essential field accessors.
@@ -219,22 +362,36 @@ class Model(object):
"""
return cls._fields.get(key) or cls._types.get(key) or types.DEFAULT
- def __getitem__(self, key):
- """Get the value for a field. Raise a KeyError if the field is
- not available.
+ def _get(self, key, default=None, raise_=False):
+ """Get the value for a field, or `default`. Alternatively,
+ raise a KeyError if the field is not available.
"""
getters = self._getters()
if key in getters: # Computed.
return getters[key](self)
elif key in self._fields: # Fixed.
- return self._values_fixed.get(key)
+ if key in self._values_fixed:
+ return self._values_fixed[key]
+ else:
+ return self._type(key).null
elif key in self._values_flex: # Flexible.
return self._values_flex[key]
- else:
+ elif raise_:
raise KeyError(key)
+ else:
+ return default
- def __setitem__(self, key, value):
- """Assign the value for a field.
+ get = _get
+
+ def __getitem__(self, key):
+ """Get the value for a field. Raise a KeyError if the field is
+ not available.
+ """
+ return self._get(key, raise_=True)
+
+ def _setitem(self, key, value):
+ """Assign the value for a field, return whether new and old value
+ differ.
"""
# Choose where to place the value.
if key in self._fields:
@@ -248,21 +405,29 @@ class Model(object):
# Assign value and possibly mark as dirty.
old_value = source.get(key)
source[key] = value
- if self._always_dirty or old_value != value:
+ changed = old_value != value
+ if self._always_dirty or changed:
self._dirty.add(key)
+ return changed
+
+ def __setitem__(self, key, value):
+ """Assign the value for a field.
+ """
+ self._setitem(key, value)
+
def __delitem__(self, key):
"""Remove a flexible attribute from the model.
"""
if key in self._values_flex: # Flexible.
del self._values_flex[key]
self._dirty.add(key) # Mark for dropping on store.
+ elif key in self._fields: # Fixed
+ setattr(self, key, self._type(key).null)
elif key in self._getters(): # Computed.
- raise KeyError(u'computed field {0} cannot be deleted'.format(key))
- elif key in self._fields: # Fixed.
- raise KeyError(u'fixed field {0} cannot be deleted'.format(key))
+ raise KeyError(f'computed field {key} cannot be deleted')
else:
- raise KeyError(u'no such field {0}'.format(key))
+ raise KeyError(f'no such field {key}')
def keys(self, computed=False):
"""Get a list of available field names for this object. The
@@ -297,19 +462,10 @@ class Model(object):
for key in self:
yield key, self[key]
- def get(self, key, default=None):
- """Get the value for a given key or `default` if it does not
- exist.
- """
- if key in self:
- return self[key]
- else:
- return default
-
def __contains__(self, key):
"""Determine whether `key` is an attribute on this object.
"""
- return key in self.keys(True)
+ return key in self.keys(computed=True)
def __iter__(self):
"""Iterate over the available field names (excluding computed
@@ -321,22 +477,22 @@ class Model(object):
def __getattr__(self, key):
if key.startswith('_'):
- raise AttributeError(u'model has no attribute {0!r}'.format(key))
+ raise AttributeError(f'model has no attribute {key!r}')
else:
try:
return self[key]
except KeyError:
- raise AttributeError(u'no such field {0!r}'.format(key))
+ raise AttributeError(f'no such field {key!r}')
def __setattr__(self, key, value):
if key.startswith('_'):
- super(Model, self).__setattr__(key, value)
+ super().__setattr__(key, value)
else:
self[key] = value
def __delattr__(self, key):
if key.startswith('_'):
- super(Model, self).__delattr__(key)
+ super().__delattr__(key)
else:
del self[key]
@@ -365,7 +521,7 @@ class Model(object):
with self._db.transaction() as tx:
# Main table update.
if assignments:
- query = 'UPDATE {0} SET {1} WHERE id=?'.format(
+ query = 'UPDATE {} SET {} WHERE id=?'.format(
self._table, assignments
)
subvars.append(self.id)
@@ -376,7 +532,7 @@ class Model(object):
if key in self._dirty:
self._dirty.remove(key)
tx.mutate(
- 'INSERT INTO {0} '
+ 'INSERT INTO {} '
'(entity_id, key, value) '
'VALUES (?, ?, ?);'.format(self._flex_table),
(self.id, key, value),
@@ -385,7 +541,7 @@ class Model(object):
# Deleted flexible attributes.
for key in self._dirty:
tx.mutate(
- 'DELETE FROM {0} '
+ 'DELETE FROM {} '
'WHERE entity_id=? AND key=?'.format(self._flex_table),
(self.id, key)
)
@@ -394,12 +550,18 @@ class Model(object):
def load(self):
"""Refresh the object's metadata from the library database.
+
+ If check_revision is true, the database is only queried loaded when a
+ transaction has been committed since the item was last loaded.
"""
self._check_db()
+ if not self._dirty and self._db.revision == self._revision:
+ # Exit early
+ return
stored_obj = self._db._get(type(self), self.id)
- assert stored_obj is not None, u"object {0} not in DB".format(self.id)
- self._values_fixed = {}
- self._values_flex = {}
+ assert stored_obj is not None, f"object {self.id} not in DB"
+ self._values_fixed = LazyConvertDict(self)
+ self._values_flex = LazyConvertDict(self)
self.update(dict(stored_obj))
self.clear_dirty()
@@ -409,11 +571,11 @@ class Model(object):
self._check_db()
with self._db.transaction() as tx:
tx.mutate(
- 'DELETE FROM {0} WHERE id=?'.format(self._table),
+ f'DELETE FROM {self._table} WHERE id=?',
(self.id,)
)
tx.mutate(
- 'DELETE FROM {0} WHERE entity_id=?'.format(self._flex_table),
+ f'DELETE FROM {self._flex_table} WHERE entity_id=?',
(self.id,)
)
@@ -431,7 +593,7 @@ class Model(object):
with self._db.transaction() as tx:
new_id = tx.mutate(
- 'INSERT INTO {0} DEFAULT VALUES'.format(self._table)
+ f'INSERT INTO {self._table} DEFAULT VALUES'
)
self.id = new_id
self.added = time.time()
@@ -446,11 +608,11 @@ class Model(object):
_formatter = FormattedMapping
- def formatted(self, for_path=False):
+ def formatted(self, included_keys=_formatter.ALL_KEYS, for_path=False):
"""Get a mapping containing all values on this object formatted
as human-readable unicode strings.
"""
- return self._formatter(self, for_path)
+ return self._formatter(self, included_keys, for_path)
def evaluate_template(self, template, for_path=False):
"""Evaluate a template (a string or a `Template` object) using
@@ -458,9 +620,9 @@ class Model(object):
separators will be added to the template.
"""
# Perform substitution.
- if isinstance(template, six.string_types):
- template = Template(template)
- return template.substitute(self.formatted(for_path),
+ if isinstance(template, str):
+ template = functemplate.template(template)
+ return template.substitute(self.formatted(for_path=for_path),
self._template_funcs())
# Parsing.
@@ -469,8 +631,8 @@ class Model(object):
def _parse(cls, key, string):
"""Parse a string as a value for the given key.
"""
- if not isinstance(string, six.string_types):
- raise TypeError(u"_parse() argument must be a string")
+ if not isinstance(string, str):
+ raise TypeError("_parse() argument must be a string")
return cls._type(key).parse(string)
@@ -482,11 +644,13 @@ class Model(object):
# Database controller and supporting interfaces.
-class Results(object):
+class Results:
"""An item query result set. Iterating over the collection lazily
constructs LibModel objects that reflect database rows.
"""
- def __init__(self, model_class, rows, db, query=None, sort=None):
+
+ def __init__(self, model_class, rows, db, flex_rows,
+ query=None, sort=None):
"""Create a result set that will construct objects of type
`model_class`.
@@ -506,6 +670,7 @@ class Results(object):
self.db = db
self.query = query
self.sort = sort
+ self.flex_rows = flex_rows
# We keep a queue of rows we haven't yet consumed for
# materialization. We preserve the original total number of
@@ -527,6 +692,10 @@ class Results(object):
a `Results` object a second time should be much faster than the
first.
"""
+
+ # Index flexible attributes by the item ID, so we have easier access
+ flex_attrs = self._get_indexed_flex_attrs()
+
index = 0 # Position in the materialized objects.
while index < len(self._objects) or self._rows:
# Are there previously-materialized objects to produce?
@@ -539,7 +708,7 @@ class Results(object):
else:
while self._rows:
row = self._rows.pop(0)
- obj = self._make_model(row)
+ obj = self._make_model(row, flex_attrs.get(row['id'], {}))
# If there is a slow-query predicate, ensurer that the
# object passes it.
if not self.query or self.query.match(obj):
@@ -561,20 +730,24 @@ class Results(object):
# Objects are pre-sorted (i.e., by the database).
return self._get_objects()
- def _make_model(self, row):
- # Get the flexible attributes for the object.
- with self.db.transaction() as tx:
- flex_rows = tx.query(
- 'SELECT * FROM {0} WHERE entity_id=?'.format(
- self.model_class._flex_table
- ),
- (row['id'],)
- )
+ def _get_indexed_flex_attrs(self):
+ """ Index flexible attributes by the entity id they belong to
+ """
+ flex_values = {}
+ for row in self.flex_rows:
+ if row['entity_id'] not in flex_values:
+ flex_values[row['entity_id']] = {}
+ flex_values[row['entity_id']][row['key']] = row['value']
+
+ return flex_values
+
+ def _make_model(self, row, flex_values={}):
+ """ Create a Model object for the given row
+ """
cols = dict(row)
- values = dict((k, v) for (k, v) in cols.items()
- if not k[:4] == 'flex')
- flex_values = dict((row['key'], row['value']) for row in flex_rows)
+ values = {k: v for (k, v) in cols.items()
+ if not k[:4] == 'flex'}
# Construct the Python object
obj = self.model_class._awaken(self.db, values, flex_values)
@@ -623,7 +796,7 @@ class Results(object):
next(it)
return next(it)
except StopIteration:
- raise IndexError(u'result index {0} out of range'.format(n))
+ raise IndexError(f'result index {n} out of range')
def get(self):
"""Return the first matching object, or None if no objects
@@ -636,10 +809,16 @@ class Results(object):
return None
-class Transaction(object):
+class Transaction:
"""A context manager for safe, concurrent access to the database.
All SQL commands should be executed through a transaction.
"""
+
+ _mutated = False
+ """A flag storing whether a mutation has been executed in the
+ current transaction.
+ """
+
def __init__(self, db):
self.db = db
@@ -661,12 +840,15 @@ class Transaction(object):
entered but not yet exited transaction. If it is the last active
transaction, the database updates are committed.
"""
+ # Beware of races; currently secured by db._db_lock
+ self.db.revision += self._mutated
with self.db._tx_stack() as stack:
assert stack.pop() is self
empty = not stack
if empty:
# Ending a "root" transaction. End the SQLite transaction.
self.db._connection().commit()
+ self._mutated = False
self.db._db_lock.release()
def query(self, statement, subvals=()):
@@ -680,28 +862,52 @@ class Transaction(object):
"""Execute an SQL statement with substitution values and return
the row ID of the last affected row.
"""
- cursor = self.db._connection().execute(statement, subvals)
- return cursor.lastrowid
+ try:
+ cursor = self.db._connection().execute(statement, subvals)
+ except sqlite3.OperationalError as e:
+ # In two specific cases, SQLite reports an error while accessing
+ # the underlying database file. We surface these exceptions as
+ # DBAccessError so the application can abort.
+ if e.args[0] in ("attempt to write a readonly database",
+ "unable to open database file"):
+ raise DBAccessError(e.args[0])
+ else:
+ raise
+ else:
+ self._mutated = True
+ return cursor.lastrowid
def script(self, statements):
"""Execute a string containing multiple SQL statements."""
+ # We don't know whether this mutates, but quite likely it does.
+ self._mutated = True
self.db._connection().executescript(statements)
-class Database(object):
+class Database:
"""A container for Model objects that wraps an SQLite database as
the backend.
"""
+
_models = ()
"""The Model subclasses representing tables in this database.
"""
+ supports_extensions = hasattr(sqlite3.Connection, 'enable_load_extension')
+ """Whether or not the current version of SQLite supports extensions"""
+
+ revision = 0
+ """The current revision of the database. To be increased whenever
+ data is written in a transaction.
+ """
+
def __init__(self, path, timeout=5.0):
self.path = path
self.timeout = timeout
self._connections = {}
self._tx_stacks = defaultdict(list)
+ self._extensions = []
# A lock to protect the _connections and _tx_stacks maps, which
# both map thread IDs to private resources.
@@ -751,6 +957,13 @@ class Database(object):
py3_path(self.path), timeout=self.timeout
)
+ if self.supports_extensions:
+ conn.enable_load_extension(True)
+
+ # Load any extension that are already loaded for other connections.
+ for path in self._extensions:
+ conn.load_extension(path)
+
# Access SELECT results like dictionaries.
conn.row_factory = sqlite3.Row
return conn
@@ -779,6 +992,18 @@ class Database(object):
"""
return Transaction(self)
+ def load_extension(self, path):
+ """Load an SQLite extension into all open connections."""
+ if not self.supports_extensions:
+ raise ValueError(
+ 'this sqlite3 installation does not support extensions')
+
+ self._extensions.append(path)
+
+ # Load the extension into every open connection.
+ for conn in self._connections.values():
+ conn.load_extension(path)
+
# Schema setup and migration.
def _make_table(self, table, fields):
@@ -788,7 +1013,7 @@ class Database(object):
# Get current schema.
with self.transaction() as tx:
rows = tx.query('PRAGMA table_info(%s)' % table)
- current_fields = set([row[1] for row in rows])
+ current_fields = {row[1] for row in rows}
field_names = set(fields.keys())
if current_fields.issuperset(field_names):
@@ -799,9 +1024,9 @@ class Database(object):
# No table exists.
columns = []
for name, typ in fields.items():
- columns.append('{0} {1}'.format(name, typ.sql))
- setup_sql = 'CREATE TABLE {0} ({1});\n'.format(table,
- ', '.join(columns))
+ columns.append(f'{name} {typ.sql}')
+ setup_sql = 'CREATE TABLE {} ({});\n'.format(table,
+ ', '.join(columns))
else:
# Table exists does not match the field set.
@@ -809,7 +1034,7 @@ class Database(object):
for name, typ in fields.items():
if name in current_fields:
continue
- setup_sql += 'ALTER TABLE {0} ADD COLUMN {1} {2};\n'.format(
+ setup_sql += 'ALTER TABLE {} ADD COLUMN {} {};\n'.format(
table, name, typ.sql
)
@@ -845,17 +1070,31 @@ class Database(object):
where, subvals = query.clause()
order_by = sort.order_clause()
- sql = ("SELECT * FROM {0} WHERE {1} {2}").format(
+ sql = ("SELECT * FROM {} WHERE {} {}").format(
model_cls._table,
where or '1',
- "ORDER BY {0}".format(order_by) if order_by else '',
+ f"ORDER BY {order_by}" if order_by else '',
+ )
+
+ # Fetch flexible attributes for items matching the main query.
+ # Doing the per-item filtering in python is faster than issuing
+ # one query per item to sqlite.
+ flex_sql = ("""
+ SELECT * FROM {} WHERE entity_id IN
+ (SELECT id FROM {} WHERE {});
+ """.format(
+ model_cls._flex_table,
+ model_cls._table,
+ where or '1',
+ )
)
with self.transaction() as tx:
rows = tx.query(sql, subvals)
+ flex_rows = tx.query(flex_sql, subvals)
return Results(
- model_cls, rows, self,
+ model_cls, rows, self, flex_rows,
None if where else query, # Slow query component.
sort if sort.is_slow() else None, # Slow sort component.
)
diff --git a/lib/beets/dbcore/query.py b/lib/beets/dbcore/query.py
old mode 100755
new mode 100644
index 470ca2ac..96476a5b
--- a/lib/beets/dbcore/query.py
+++ b/lib/beets/dbcore/query.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
# This file is part of beets.
# Copyright 2016, Adrian Sampson.
#
@@ -15,7 +14,6 @@
"""The Query type hierarchy for DBCore.
"""
-from __future__ import division, absolute_import, print_function
import re
from operator import mul
@@ -23,10 +21,6 @@ from beets import util
from datetime import datetime, timedelta
import unicodedata
from functools import reduce
-import six
-
-if not six.PY2:
- buffer = memoryview # sqlite won't accept memoryview in python 2
class ParsingError(ValueError):
@@ -40,29 +34,32 @@ class InvalidQueryError(ParsingError):
The query should be a unicode string or a list, which will be space-joined.
"""
+
def __init__(self, query, explanation):
if isinstance(query, list):
query = " ".join(query)
- message = u"'{0}': {1}".format(query, explanation)
- super(InvalidQueryError, self).__init__(message)
+ message = f"'{query}': {explanation}"
+ super().__init__(message)
-class InvalidQueryArgumentTypeError(ParsingError):
+class InvalidQueryArgumentValueError(ParsingError):
"""Represent a query argument that could not be converted as expected.
It exists to be caught in upper stack levels so a meaningful (i.e. with the
query) InvalidQueryError can be raised.
"""
+
def __init__(self, what, expected, detail=None):
- message = u"'{0}' is not {1}".format(what, expected)
+ message = f"'{what}' is not {expected}"
if detail:
- message = u"{0}: {1}".format(message, detail)
- super(InvalidQueryArgumentTypeError, self).__init__(message)
+ message = f"{message}: {detail}"
+ super().__init__(message)
-class Query(object):
+class Query:
"""An abstract class representing a query into the item database.
"""
+
def clause(self):
"""Generate an SQLite expression implementing the query.
@@ -79,7 +76,7 @@ class Query(object):
raise NotImplementedError
def __repr__(self):
- return "{0.__class__.__name__}()".format(self)
+ return f"{self.__class__.__name__}()"
def __eq__(self, other):
return type(self) == type(other)
@@ -95,6 +92,7 @@ class FieldQuery(Query):
string. Subclasses may also provide `col_clause` to implement the
same matching functionality in SQLite.
"""
+
def __init__(self, field, pattern, fast=True):
self.field = field
self.pattern = pattern
@@ -125,7 +123,7 @@ class FieldQuery(Query):
"{0.fast})".format(self))
def __eq__(self, other):
- return super(FieldQuery, self).__eq__(other) and \
+ return super().__eq__(other) and \
self.field == other.field and self.pattern == other.pattern
def __hash__(self):
@@ -134,6 +132,7 @@ class FieldQuery(Query):
class MatchQuery(FieldQuery):
"""A query that looks for exact matches in an item field."""
+
def col_clause(self):
return self.field + " = ?", [self.pattern]
@@ -143,19 +142,16 @@ class MatchQuery(FieldQuery):
class NoneQuery(FieldQuery):
+ """A query that checks whether a field is null."""
def __init__(self, field, fast=True):
- super(NoneQuery, self).__init__(field, None, fast)
+ super().__init__(field, None, fast)
def col_clause(self):
return self.field + " IS NULL", ()
- @classmethod
- def match(cls, item):
- try:
- return item[cls.field] is None
- except KeyError:
- return True
+ def match(self, item):
+ return item.get(self.field) is None
def __repr__(self):
return "{0.__class__.__name__}({0.field!r}, {0.fast})".format(self)
@@ -165,6 +161,7 @@ class StringFieldQuery(FieldQuery):
"""A FieldQuery that converts values to strings before matching
them.
"""
+
@classmethod
def value_match(cls, pattern, value):
"""Determine whether the value matches the pattern. The value
@@ -182,11 +179,12 @@ class StringFieldQuery(FieldQuery):
class SubstringQuery(StringFieldQuery):
"""A query that matches a substring in a specific item field."""
+
def col_clause(self):
pattern = (self.pattern
- .replace('\\', '\\\\')
- .replace('%', '\\%')
- .replace('_', '\\_'))
+ .replace('\\', '\\\\')
+ .replace('%', '\\%')
+ .replace('_', '\\_'))
search = '%' + pattern + '%'
clause = self.field + " like ? escape '\\'"
subvals = [search]
@@ -204,16 +202,17 @@ class RegexpQuery(StringFieldQuery):
Raises InvalidQueryError when the pattern is not a valid regular
expression.
"""
+
def __init__(self, field, pattern, fast=True):
- super(RegexpQuery, self).__init__(field, pattern, fast)
+ super().__init__(field, pattern, fast)
pattern = self._normalize(pattern)
try:
self.pattern = re.compile(self.pattern)
except re.error as exc:
# Invalid regular expression.
- raise InvalidQueryArgumentTypeError(pattern,
- u"a regular expression",
- format(exc))
+ raise InvalidQueryArgumentValueError(pattern,
+ "a regular expression",
+ format(exc))
@staticmethod
def _normalize(s):
@@ -231,9 +230,10 @@ class BooleanQuery(MatchQuery):
"""Matches a boolean field. Pattern should either be a boolean or a
string reflecting a boolean.
"""
+
def __init__(self, field, pattern, fast=True):
- super(BooleanQuery, self).__init__(field, pattern, fast)
- if isinstance(pattern, six.string_types):
+ super().__init__(field, pattern, fast)
+ if isinstance(pattern, str):
self.pattern = util.str2bool(pattern)
self.pattern = int(self.pattern)
@@ -244,17 +244,18 @@ class BytesQuery(MatchQuery):
`unicode` equivalently in Python 2. Always use this query instead of
`MatchQuery` when matching on BLOB values.
"""
+
def __init__(self, field, pattern):
- super(BytesQuery, self).__init__(field, pattern)
+ super().__init__(field, pattern)
# Use a buffer/memoryview representation of the pattern for SQLite
# matching. This instructs SQLite to treat the blob as binary
# rather than encoded Unicode.
- if isinstance(self.pattern, (six.text_type, bytes)):
- if isinstance(self.pattern, six.text_type):
+ if isinstance(self.pattern, (str, bytes)):
+ if isinstance(self.pattern, str):
self.pattern = self.pattern.encode('utf-8')
- self.buf_pattern = buffer(self.pattern)
- elif isinstance(self.pattern, buffer):
+ self.buf_pattern = memoryview(self.pattern)
+ elif isinstance(self.pattern, memoryview):
self.buf_pattern = self.pattern
self.pattern = bytes(self.pattern)
@@ -270,6 +271,7 @@ class NumericQuery(FieldQuery):
Raises InvalidQueryError when the pattern does not represent an int or
a float.
"""
+
def _convert(self, s):
"""Convert a string to a numeric type (float or int).
@@ -285,10 +287,10 @@ class NumericQuery(FieldQuery):
try:
return float(s)
except ValueError:
- raise InvalidQueryArgumentTypeError(s, u"an int or a float")
+ raise InvalidQueryArgumentValueError(s, "an int or a float")
def __init__(self, field, pattern, fast=True):
- super(NumericQuery, self).__init__(field, pattern, fast)
+ super().__init__(field, pattern, fast)
parts = pattern.split('..', 1)
if len(parts) == 1:
@@ -306,7 +308,7 @@ class NumericQuery(FieldQuery):
if self.field not in item:
return False
value = item[self.field]
- if isinstance(value, six.string_types):
+ if isinstance(value, str):
value = self._convert(value)
if self.point is not None:
@@ -323,20 +325,21 @@ class NumericQuery(FieldQuery):
return self.field + '=?', (self.point,)
else:
if self.rangemin is not None and self.rangemax is not None:
- return (u'{0} >= ? AND {0} <= ?'.format(self.field),
+ return ('{0} >= ? AND {0} <= ?'.format(self.field),
(self.rangemin, self.rangemax))
elif self.rangemin is not None:
- return u'{0} >= ?'.format(self.field), (self.rangemin,)
+ return f'{self.field} >= ?', (self.rangemin,)
elif self.rangemax is not None:
- return u'{0} <= ?'.format(self.field), (self.rangemax,)
+ return f'{self.field} <= ?', (self.rangemax,)
else:
- return u'1', ()
+ return '1', ()
class CollectionQuery(Query):
"""An abstract query class that aggregates other queries. Can be
indexed like a list to access the sub-queries.
"""
+
def __init__(self, subqueries=()):
self.subqueries = subqueries
@@ -374,7 +377,7 @@ class CollectionQuery(Query):
return "{0.__class__.__name__}({0.subqueries!r})".format(self)
def __eq__(self, other):
- return super(CollectionQuery, self).__eq__(other) and \
+ return super().__eq__(other) and \
self.subqueries == other.subqueries
def __hash__(self):
@@ -389,6 +392,7 @@ class AnyFieldQuery(CollectionQuery):
any field. The individual field query class is provided to the
constructor.
"""
+
def __init__(self, pattern, fields, cls):
self.pattern = pattern
self.fields = fields
@@ -397,7 +401,7 @@ class AnyFieldQuery(CollectionQuery):
subqueries = []
for field in self.fields:
subqueries.append(cls(field, pattern, True))
- super(AnyFieldQuery, self).__init__(subqueries)
+ super().__init__(subqueries)
def clause(self):
return self.clause_with_joiner('or')
@@ -413,7 +417,7 @@ class AnyFieldQuery(CollectionQuery):
"{0.query_class.__name__})".format(self))
def __eq__(self, other):
- return super(AnyFieldQuery, self).__eq__(other) and \
+ return super().__eq__(other) and \
self.query_class == other.query_class
def __hash__(self):
@@ -424,6 +428,7 @@ class MutableCollectionQuery(CollectionQuery):
"""A collection query whose subqueries may be modified after the
query is initialized.
"""
+
def __setitem__(self, key, value):
self.subqueries[key] = value
@@ -433,33 +438,36 @@ class MutableCollectionQuery(CollectionQuery):
class AndQuery(MutableCollectionQuery):
"""A conjunction of a list of other queries."""
+
def clause(self):
return self.clause_with_joiner('and')
def match(self, item):
- return all([q.match(item) for q in self.subqueries])
+ return all(q.match(item) for q in self.subqueries)
class OrQuery(MutableCollectionQuery):
"""A conjunction of a list of other queries."""
+
def clause(self):
return self.clause_with_joiner('or')
def match(self, item):
- return any([q.match(item) for q in self.subqueries])
+ return any(q.match(item) for q in self.subqueries)
class NotQuery(Query):
"""A query that matches the negation of its `subquery`, as a shorcut for
performing `not(subquery)` without using regular expressions.
"""
+
def __init__(self, subquery):
self.subquery = subquery
def clause(self):
clause, subvals = self.subquery.clause()
if clause:
- return 'not ({0})'.format(clause), subvals
+ return f'not ({clause})', subvals
else:
# If there is no clause, there is nothing to negate. All the logic
# is handled by match() for slow queries.
@@ -472,7 +480,7 @@ class NotQuery(Query):
return "{0.__class__.__name__}({0.subquery!r})".format(self)
def __eq__(self, other):
- return super(NotQuery, self).__eq__(other) and \
+ return super().__eq__(other) and \
self.subquery == other.subquery
def __hash__(self):
@@ -481,6 +489,7 @@ class NotQuery(Query):
class TrueQuery(Query):
"""A query that always matches."""
+
def clause(self):
return '1', ()
@@ -490,6 +499,7 @@ class TrueQuery(Query):
class FalseQuery(Query):
"""A query that never matches."""
+
def clause(self):
return '0', ()
@@ -526,42 +536,88 @@ def _parse_periods(pattern):
return (start, end)
-class Period(object):
+class Period:
"""A period of time given by a date, time and precision.
Example: 2014-01-01 10:50:30 with precision 'month' represents all
instants of time during January 2014.
"""
- precisions = ('year', 'month', 'day')
- date_formats = ('%Y', '%Y-%m', '%Y-%m-%d')
+ precisions = ('year', 'month', 'day', 'hour', 'minute', 'second')
+ date_formats = (
+ ('%Y',), # year
+ ('%Y-%m',), # month
+ ('%Y-%m-%d',), # day
+ ('%Y-%m-%dT%H', '%Y-%m-%d %H'), # hour
+ ('%Y-%m-%dT%H:%M', '%Y-%m-%d %H:%M'), # minute
+ ('%Y-%m-%dT%H:%M:%S', '%Y-%m-%d %H:%M:%S') # second
+ )
+ relative_units = {'y': 365, 'm': 30, 'w': 7, 'd': 1}
+ relative_re = '(?P[+|-]?)(?P[0-9]+)' + \
+ '(?P[y|m|w|d])'
def __init__(self, date, precision):
"""Create a period with the given date (a `datetime` object) and
- precision (a string, one of "year", "month", or "day").
+ precision (a string, one of "year", "month", "day", "hour", "minute",
+ or "second").
"""
if precision not in Period.precisions:
- raise ValueError(u'Invalid precision {0}'.format(precision))
+ raise ValueError(f'Invalid precision {precision}')
self.date = date
self.precision = precision
@classmethod
def parse(cls, string):
"""Parse a date and return a `Period` object or `None` if the
- string is empty.
+ string is empty, or raise an InvalidQueryArgumentValueError if
+ the string cannot be parsed to a date.
+
+ The date may be absolute or relative. Absolute dates look like
+ `YYYY`, or `YYYY-MM-DD`, or `YYYY-MM-DD HH:MM:SS`, etc. Relative
+ dates have three parts:
+
+ - Optionally, a ``+`` or ``-`` sign indicating the future or the
+ past. The default is the future.
+ - A number: how much to add or subtract.
+ - A letter indicating the unit: days, weeks, months or years
+ (``d``, ``w``, ``m`` or ``y``). A "month" is exactly 30 days
+ and a "year" is exactly 365 days.
"""
+
+ def find_date_and_format(string):
+ for ord, format in enumerate(cls.date_formats):
+ for format_option in format:
+ try:
+ date = datetime.strptime(string, format_option)
+ return date, ord
+ except ValueError:
+ # Parsing failed.
+ pass
+ return (None, None)
+
if not string:
return None
- ordinal = string.count('-')
- if ordinal >= len(cls.date_formats):
- # Too many components.
- return None
- date_format = cls.date_formats[ordinal]
- try:
- date = datetime.strptime(string, date_format)
- except ValueError:
- # Parsing failed.
- return None
+
+ # Check for a relative date.
+ match_dq = re.match(cls.relative_re, string)
+ if match_dq:
+ sign = match_dq.group('sign')
+ quantity = match_dq.group('quantity')
+ timespan = match_dq.group('timespan')
+
+ # Add or subtract the given amount of time from the current
+ # date.
+ multiplier = -1 if sign == '-' else 1
+ days = cls.relative_units[timespan]
+ date = datetime.now() + \
+ timedelta(days=int(quantity) * days) * multiplier
+ return cls(date, cls.precisions[5])
+
+ # Check for an absolute date.
+ date, ordinal = find_date_and_format(string)
+ if date is None:
+ raise InvalidQueryArgumentValueError(string,
+ 'a valid date/time string')
precision = cls.precisions[ordinal]
return cls(date, precision)
@@ -580,11 +636,17 @@ class Period(object):
return date.replace(year=date.year + 1, month=1)
elif 'day' == precision:
return date + timedelta(days=1)
+ elif 'hour' == precision:
+ return date + timedelta(hours=1)
+ elif 'minute' == precision:
+ return date + timedelta(minutes=1)
+ elif 'second' == precision:
+ return date + timedelta(seconds=1)
else:
- raise ValueError(u'unhandled precision {0}'.format(precision))
+ raise ValueError(f'unhandled precision {precision}')
-class DateInterval(object):
+class DateInterval:
"""A closed-open interval of dates.
A left endpoint of None means since the beginning of time.
@@ -593,7 +655,7 @@ class DateInterval(object):
def __init__(self, start, end):
if start is not None and end is not None and not start < end:
- raise ValueError(u"start date {0} is not before end date {1}"
+ raise ValueError("start date {} is not before end date {}"
.format(start, end))
self.start = start
self.end = end
@@ -614,7 +676,7 @@ class DateInterval(object):
return True
def __str__(self):
- return '[{0}, {1})'.format(self.start, self.end)
+ return f'[{self.start}, {self.end})'
class DateQuery(FieldQuery):
@@ -626,8 +688,9 @@ class DateQuery(FieldQuery):
The value of a date field can be matched against a date interval by
using an ellipsis interval syntax similar to that of NumericQuery.
"""
+
def __init__(self, field, pattern, fast=True):
- super(DateQuery, self).__init__(field, pattern, fast)
+ super().__init__(field, pattern, fast)
start, end = _parse_periods(pattern)
self.interval = DateInterval.from_periods(start, end)
@@ -635,7 +698,7 @@ class DateQuery(FieldQuery):
if self.field not in item:
return False
timestamp = float(item[self.field])
- date = datetime.utcfromtimestamp(timestamp)
+ date = datetime.fromtimestamp(timestamp)
return self.interval.contains(date)
_clause_tmpl = "{0} {1} ?"
@@ -669,6 +732,7 @@ class DurationQuery(NumericQuery):
Raises InvalidQueryError when the pattern does not represent an int, float
or M:SS time interval.
"""
+
def _convert(self, s):
"""Convert a M:SS or numeric string to a float.
@@ -683,14 +747,14 @@ class DurationQuery(NumericQuery):
try:
return float(s)
except ValueError:
- raise InvalidQueryArgumentTypeError(
+ raise InvalidQueryArgumentValueError(
s,
- u"a M:SS string or a float")
+ "a M:SS string or a float")
# Sorting.
-class Sort(object):
+class Sort:
"""An abstract class representing a sort operation for a query into
the item database.
"""
@@ -777,13 +841,13 @@ class MultipleSort(Sort):
return items
def __repr__(self):
- return 'MultipleSort({!r})'.format(self.sorts)
+ return f'MultipleSort({self.sorts!r})'
def __hash__(self):
return hash(tuple(self.sorts))
def __eq__(self, other):
- return super(MultipleSort, self).__eq__(other) and \
+ return super().__eq__(other) and \
self.sorts == other.sorts
@@ -791,6 +855,7 @@ class FieldSort(Sort):
"""An abstract sort criterion that orders by a specific field (of
any kind).
"""
+
def __init__(self, field, ascending=True, case_insensitive=True):
self.field = field
self.ascending = ascending
@@ -803,14 +868,14 @@ class FieldSort(Sort):
def key(item):
field_val = item.get(self.field, '')
- if self.case_insensitive and isinstance(field_val, six.text_type):
+ if self.case_insensitive and isinstance(field_val, str):
field_val = field_val.lower()
return field_val
return sorted(objs, key=key, reverse=not self.ascending)
def __repr__(self):
- return '<{0}: {1}{2}>'.format(
+ return '<{}: {}{}>'.format(
type(self).__name__,
self.field,
'+' if self.ascending else '-',
@@ -820,7 +885,7 @@ class FieldSort(Sort):
return hash((self.field, self.ascending))
def __eq__(self, other):
- return super(FieldSort, self).__eq__(other) and \
+ return super().__eq__(other) and \
self.field == other.field and \
self.ascending == other.ascending
@@ -828,6 +893,7 @@ class FieldSort(Sort):
class FixedFieldSort(FieldSort):
"""Sort object to sort on a fixed field.
"""
+
def order_clause(self):
order = "ASC" if self.ascending else "DESC"
if self.case_insensitive:
@@ -837,19 +903,21 @@ class FixedFieldSort(FieldSort):
'ELSE {0} END)'.format(self.field)
else:
field = self.field
- return "{0} {1}".format(field, order)
+ return f"{field} {order}"
class SlowFieldSort(FieldSort):
"""A sort criterion by some model field other than a fixed field:
i.e., a computed or flexible field.
"""
+
def is_slow(self):
return True
class NullSort(Sort):
"""No sorting. Leave results unsorted."""
+
def sort(self, items):
return items
diff --git a/lib/beets/dbcore/queryparse.py b/lib/beets/dbcore/queryparse.py
old mode 100755
new mode 100644
index bc9cc77e..3bf02e4d
--- a/lib/beets/dbcore/queryparse.py
+++ b/lib/beets/dbcore/queryparse.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
# This file is part of beets.
# Copyright 2016, Adrian Sampson.
#
@@ -15,12 +14,10 @@
"""Parsing of strings into DBCore queries.
"""
-from __future__ import division, absolute_import, print_function
import re
import itertools
from . import query
-import beets
PARSE_QUERY_PART_REGEX = re.compile(
# Non-capturing optional segment for the keyword.
@@ -89,7 +86,7 @@ def parse_query_part(part, query_classes={}, prefixes={},
assert match # Regex should always match
negate = bool(match.group(1))
key = match.group(2)
- term = match.group(3).replace('\:', ':')
+ term = match.group(3).replace('\\:', ':')
# Check whether there's a prefix in the query and use the
# corresponding query type.
@@ -119,12 +116,13 @@ def construct_query_part(model_cls, prefixes, query_part):
if not query_part:
return query.TrueQuery()
- # Use `model_cls` to build up a map from field names to `Query`
- # classes.
+ # Use `model_cls` to build up a map from field (or query) names to
+ # `Query` classes.
query_classes = {}
for k, t in itertools.chain(model_cls._fields.items(),
model_cls._types.items()):
query_classes[k] = t.query
+ query_classes.update(model_cls._queries) # Non-field queries.
# Parse the string.
key, pattern, query_class, negate = \
@@ -137,26 +135,27 @@ def construct_query_part(model_cls, prefixes, query_part):
# The query type matches a specific field, but none was
# specified. So we use a version of the query that matches
# any field.
- q = query.AnyFieldQuery(pattern, model_cls._search_fields,
- query_class)
- if negate:
- return query.NotQuery(q)
- else:
- return q
+ out_query = query.AnyFieldQuery(pattern, model_cls._search_fields,
+ query_class)
else:
# Non-field query type.
- if negate:
- return query.NotQuery(query_class(pattern))
- else:
- return query_class(pattern)
+ out_query = query_class(pattern)
- # Otherwise, this must be a `FieldQuery`. Use the field name to
- # construct the query object.
- key = key.lower()
- q = query_class(key.lower(), pattern, key in model_cls._fields)
+ # Field queries get constructed according to the name of the field
+ # they are querying.
+ elif issubclass(query_class, query.FieldQuery):
+ key = key.lower()
+ out_query = query_class(key.lower(), pattern, key in model_cls._fields)
+
+ # Non-field (named) query.
+ else:
+ out_query = query_class(pattern)
+
+ # Apply negation.
if negate:
- return query.NotQuery(q)
- return q
+ return query.NotQuery(out_query)
+ else:
+ return out_query
def query_from_strings(query_cls, model_cls, prefixes, query_parts):
@@ -172,11 +171,13 @@ def query_from_strings(query_cls, model_cls, prefixes, query_parts):
return query_cls(subqueries)
-def construct_sort_part(model_cls, part):
+def construct_sort_part(model_cls, part, case_insensitive=True):
"""Create a `Sort` from a single string criterion.
`model_cls` is the `Model` being queried. `part` is a single string
- ending in ``+`` or ``-`` indicating the sort.
+ ending in ``+`` or ``-`` indicating the sort. `case_insensitive`
+ indicates whether or not the sort should be performed in a case
+ sensitive manner.
"""
assert part, "part must be a field name and + or -"
field = part[:-1]
@@ -185,7 +186,6 @@ def construct_sort_part(model_cls, part):
assert direction in ('+', '-'), "part must end with + or -"
is_ascending = direction == '+'
- case_insensitive = beets.config['sort_case_insensitive'].get(bool)
if field in model_cls._sorts:
sort = model_cls._sorts[field](model_cls, is_ascending,
case_insensitive)
@@ -197,21 +197,23 @@ def construct_sort_part(model_cls, part):
return sort
-def sort_from_strings(model_cls, sort_parts):
+def sort_from_strings(model_cls, sort_parts, case_insensitive=True):
"""Create a `Sort` from a list of sort criteria (strings).
"""
if not sort_parts:
sort = query.NullSort()
elif len(sort_parts) == 1:
- sort = construct_sort_part(model_cls, sort_parts[0])
+ sort = construct_sort_part(model_cls, sort_parts[0], case_insensitive)
else:
sort = query.MultipleSort()
for part in sort_parts:
- sort.add_sort(construct_sort_part(model_cls, part))
+ sort.add_sort(construct_sort_part(model_cls, part,
+ case_insensitive))
return sort
-def parse_sorted_query(model_cls, parts, prefixes={}):
+def parse_sorted_query(model_cls, parts, prefixes={},
+ case_insensitive=True):
"""Given a list of strings, create the `Query` and `Sort` that they
represent.
"""
@@ -222,8 +224,8 @@ def parse_sorted_query(model_cls, parts, prefixes={}):
# Split up query in to comma-separated subqueries, each representing
# an AndQuery, which need to be joined together in one OrQuery
subquery_parts = []
- for part in parts + [u',']:
- if part.endswith(u','):
+ for part in parts + [',']:
+ if part.endswith(','):
# Ensure we can catch "foo, bar" as well as "foo , bar"
last_subquery_part = part[:-1]
if last_subquery_part:
@@ -237,8 +239,8 @@ def parse_sorted_query(model_cls, parts, prefixes={}):
else:
# Sort parts (1) end in + or -, (2) don't have a field, and
# (3) consist of more than just the + or -.
- if part.endswith((u'+', u'-')) \
- and u':' not in part \
+ if part.endswith(('+', '-')) \
+ and ':' not in part \
and len(part) > 1:
sort_parts.append(part)
else:
@@ -246,5 +248,5 @@ def parse_sorted_query(model_cls, parts, prefixes={}):
# Avoid needlessly wrapping single statements in an OR
q = query.OrQuery(query_parts) if len(query_parts) > 1 else query_parts[0]
- s = sort_from_strings(model_cls, sort_parts)
+ s = sort_from_strings(model_cls, sort_parts, case_insensitive)
return q, s
diff --git a/lib/beets/dbcore/types.py b/lib/beets/dbcore/types.py
old mode 100755
new mode 100644
index b909904b..40f6a080
--- a/lib/beets/dbcore/types.py
+++ b/lib/beets/dbcore/types.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
# This file is part of beets.
# Copyright 2016, Adrian Sampson.
#
@@ -15,25 +14,20 @@
"""Representation of type information for DBCore model fields.
"""
-from __future__ import division, absolute_import, print_function
from . import query
from beets.util import str2bool
-import six
-
-if not six.PY2:
- buffer = memoryview # sqlite won't accept memoryview in python 2
# Abstract base.
-class Type(object):
+class Type:
"""An object encapsulating the type of a model field. Includes
information about how to store, query, format, and parse a given
field.
"""
- sql = u'TEXT'
+ sql = 'TEXT'
"""The SQLite column type for the value.
"""
@@ -41,7 +35,7 @@ class Type(object):
"""The `Query` subclass to be used when querying the field.
"""
- model_type = six.text_type
+ model_type = str
"""The Python type that is used to represent the value in the model.
The model is guaranteed to return a value of this type if the field
@@ -63,11 +57,11 @@ class Type(object):
value = self.null
# `self.null` might be `None`
if value is None:
- value = u''
+ value = ''
if isinstance(value, bytes):
value = value.decode('utf-8', 'ignore')
- return six.text_type(value)
+ return str(value)
def parse(self, string):
"""Parse a (possibly human-written) string and return the
@@ -97,16 +91,16 @@ class Type(object):
For fixed fields the type of `value` is determined by the column
type affinity given in the `sql` property and the SQL to Python
mapping of the database adapter. For more information see:
- http://www.sqlite.org/datatype3.html
+ https://www.sqlite.org/datatype3.html
https://docs.python.org/2/library/sqlite3.html#sqlite-and-python-types
Flexible fields have the type affinity `TEXT`. This means the
- `sql_value` is either a `buffer`/`memoryview` or a `unicode` object`
+ `sql_value` is either a `memoryview` or a `unicode` object`
and the method must handle these in addition.
"""
- if isinstance(sql_value, buffer):
+ if isinstance(sql_value, memoryview):
sql_value = bytes(sql_value).decode('utf-8', 'ignore')
- if isinstance(sql_value, six.text_type):
+ if isinstance(sql_value, str):
return self.parse(sql_value)
else:
return self.normalize(sql_value)
@@ -127,10 +121,18 @@ class Default(Type):
class Integer(Type):
"""A basic integer type.
"""
- sql = u'INTEGER'
+ sql = 'INTEGER'
query = query.NumericQuery
model_type = int
+ def normalize(self, value):
+ try:
+ return self.model_type(round(float(value)))
+ except ValueError:
+ return self.null
+ except TypeError:
+ return self.null
+
class PaddedInt(Integer):
"""An integer field that is formatted with a given number of digits,
@@ -140,19 +142,25 @@ class PaddedInt(Integer):
self.digits = digits
def format(self, value):
- return u'{0:0{1}d}'.format(value or 0, self.digits)
+ return '{0:0{1}d}'.format(value or 0, self.digits)
+
+
+class NullPaddedInt(PaddedInt):
+ """Same as `PaddedInt`, but does not normalize `None` to `0.0`.
+ """
+ null = None
class ScaledInt(Integer):
"""An integer whose formatting operation scales the number by a
constant and adds a suffix. Good for units with large magnitudes.
"""
- def __init__(self, unit, suffix=u''):
+ def __init__(self, unit, suffix=''):
self.unit = unit
self.suffix = suffix
def format(self, value):
- return u'{0}{1}'.format((value or 0) // self.unit, self.suffix)
+ return '{}{}'.format((value or 0) // self.unit, self.suffix)
class Id(Integer):
@@ -163,18 +171,22 @@ class Id(Integer):
def __init__(self, primary=True):
if primary:
- self.sql = u'INTEGER PRIMARY KEY'
+ self.sql = 'INTEGER PRIMARY KEY'
class Float(Type):
- """A basic floating-point type.
+ """A basic floating-point type. The `digits` parameter specifies how
+ many decimal places to use in the human-readable representation.
"""
- sql = u'REAL'
+ sql = 'REAL'
query = query.NumericQuery
model_type = float
+ def __init__(self, digits=1):
+ self.digits = digits
+
def format(self, value):
- return u'{0:.1f}'.format(value or 0.0)
+ return '{0:.{1}f}'.format(value or 0, self.digits)
class NullFloat(Float):
@@ -186,19 +198,25 @@ class NullFloat(Float):
class String(Type):
"""A Unicode string type.
"""
- sql = u'TEXT'
+ sql = 'TEXT'
query = query.SubstringQuery
+ def normalize(self, value):
+ if value is None:
+ return self.null
+ else:
+ return self.model_type(value)
+
class Boolean(Type):
"""A boolean type.
"""
- sql = u'INTEGER'
+ sql = 'INTEGER'
query = query.BooleanQuery
model_type = bool
def format(self, value):
- return six.text_type(bool(value))
+ return str(bool(value))
def parse(self, string):
return str2bool(string)
diff --git a/lib/beets/importer.py b/lib/beets/importer.py
old mode 100755
new mode 100644
index 690a499f..561cedd2
--- a/lib/beets/importer.py
+++ b/lib/beets/importer.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
# This file is part of beets.
# Copyright 2016, Adrian Sampson.
#
@@ -13,7 +12,6 @@
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
-from __future__ import division, absolute_import, print_function
"""Provides the basic, interface-agnostic workflow for importing and
autotagging music files.
@@ -37,10 +35,10 @@ from beets import dbcore
from beets import plugins
from beets import util
from beets import config
-from beets.util import pipeline, sorted_walk, ancestry
+from beets.util import pipeline, sorted_walk, ancestry, MoveOperation
from beets.util import syspath, normpath, displayable_path
from enum import Enum
-from beets import mediafile
+import mediafile
action = Enum('action',
['SKIP', 'ASIS', 'TRACKS', 'APPLY', 'ALBUMS', 'RETAG'])
@@ -75,7 +73,7 @@ def _open_state():
# unpickling, including ImportError. We use a catch-all
# exception to avoid enumerating them all (the docs don't even have a
# full list!).
- log.debug(u'state file could not be read: {0}', exc)
+ log.debug('state file could not be read: {0}', exc)
return {}
@@ -84,8 +82,8 @@ def _save_state(state):
try:
with open(config['statefile'].as_filename(), 'wb') as f:
pickle.dump(state, f)
- except IOError as exc:
- log.error(u'state file could not be written: {0}', exc)
+ except OSError as exc:
+ log.error('state file could not be written: {0}', exc)
# Utilities for reading and writing the beets progress file, which
@@ -174,10 +172,11 @@ def history_get():
# Abstract session class.
-class ImportSession(object):
+class ImportSession:
"""Controls an import action. Subclasses should implement methods to
communicate with the user or otherwise make decisions.
"""
+
def __init__(self, lib, loghandler, paths, query):
"""Create a session. `lib` is a Library object. `loghandler` is a
logging.Handler. Either `paths` or `query` is non-null and indicates
@@ -187,7 +186,9 @@ class ImportSession(object):
self.logger = self._setup_logging(loghandler)
self.paths = paths
self.query = query
- self._is_resuming = dict()
+ self._is_resuming = {}
+ self._merged_items = set()
+ self._merged_dirs = set()
# Normalize the paths.
if self.paths:
@@ -220,19 +221,31 @@ class ImportSession(object):
iconfig['resume'] = False
iconfig['incremental'] = False
- # Copy, move, link, and hardlink are mutually exclusive.
+ if iconfig['reflink']:
+ iconfig['reflink'] = iconfig['reflink'] \
+ .as_choice(['auto', True, False])
+
+ # Copy, move, reflink, link, and hardlink are mutually exclusive.
if iconfig['move']:
iconfig['copy'] = False
iconfig['link'] = False
iconfig['hardlink'] = False
+ iconfig['reflink'] = False
elif iconfig['link']:
iconfig['copy'] = False
iconfig['move'] = False
iconfig['hardlink'] = False
+ iconfig['reflink'] = False
elif iconfig['hardlink']:
iconfig['copy'] = False
iconfig['move'] = False
iconfig['link'] = False
+ iconfig['reflink'] = False
+ elif iconfig['reflink']:
+ iconfig['copy'] = False
+ iconfig['move'] = False
+ iconfig['link'] = False
+ iconfig['hardlink'] = False
# Only delete when copying.
if not iconfig['copy']:
@@ -244,7 +257,7 @@ class ImportSession(object):
"""Log a message about a given album to the importer log. The status
should reflect the reason the album couldn't be tagged.
"""
- self.logger.info(u'{0} {1}', status, displayable_path(paths))
+ self.logger.info('{0} {1}', status, displayable_path(paths))
def log_choice(self, task, duplicate=False):
"""Logs the task's current choice if it should be logged. If
@@ -255,17 +268,17 @@ class ImportSession(object):
if duplicate:
# Duplicate: log all three choices (skip, keep both, and trump).
if task.should_remove_duplicates:
- self.tag_log(u'duplicate-replace', paths)
+ self.tag_log('duplicate-replace', paths)
elif task.choice_flag in (action.ASIS, action.APPLY):
- self.tag_log(u'duplicate-keep', paths)
+ self.tag_log('duplicate-keep', paths)
elif task.choice_flag is (action.SKIP):
- self.tag_log(u'duplicate-skip', paths)
+ self.tag_log('duplicate-skip', paths)
else:
# Non-duplicate: log "skip" and "asis" choices.
if task.choice_flag is action.ASIS:
- self.tag_log(u'asis', paths)
+ self.tag_log('asis', paths)
elif task.choice_flag is action.SKIP:
- self.tag_log(u'skip', paths)
+ self.tag_log('skip', paths)
def should_resume(self, path):
raise NotImplementedError
@@ -282,7 +295,7 @@ class ImportSession(object):
def run(self):
"""Run the import task.
"""
- self.logger.info(u'import started {0}', time.asctime())
+ self.logger.info('import started {0}', time.asctime())
self.set_config(config['import'])
# Set up the pipeline.
@@ -311,6 +324,8 @@ class ImportSession(object):
stages += [import_asis(self)]
# Plugin stages.
+ for stage_func in plugins.early_import_stages():
+ stages.append(plugin_stage(self, stage_func))
for stage_func in plugins.import_stages():
stages.append(plugin_stage(self, stage_func))
@@ -350,6 +365,24 @@ class ImportSession(object):
self._history_dirs = history_get()
return self._history_dirs
+ def already_merged(self, paths):
+ """Returns true if all the paths being imported were part of a merge
+ during previous tasks.
+ """
+ for path in paths:
+ if path not in self._merged_items \
+ and path not in self._merged_dirs:
+ return False
+ return True
+
+ def mark_merged(self, paths):
+ """Mark paths and directories as merged for future reimport tasks.
+ """
+ self._merged_items.update(paths)
+ dirs = {os.path.dirname(path) if os.path.isfile(path) else path
+ for path in paths}
+ self._merged_dirs.update(dirs)
+
def is_resuming(self, toppath):
"""Return `True` if user wants to resume import of this path.
@@ -367,7 +400,7 @@ class ImportSession(object):
# Either accept immediately or prompt for input to decide.
if self.want_resume is True or \
self.should_resume(toppath):
- log.warning(u'Resuming interrupted import of {0}',
+ log.warning('Resuming interrupted import of {0}',
util.displayable_path(toppath))
self._is_resuming[toppath] = True
else:
@@ -377,11 +410,12 @@ class ImportSession(object):
# The importer task class.
-class BaseImportTask(object):
+class BaseImportTask:
"""An abstract base class for importer tasks.
Tasks flow through the importer pipeline. Each stage can update
them. """
+
def __init__(self, toppath, paths, items):
"""Create a task. The primary fields that define a task are:
@@ -419,7 +453,7 @@ class ImportTask(BaseImportTask):
from the `candidates` list.
* `find_duplicates()` Returns a list of albums from `lib` with the
- same artist and album name as the task.
+ same artist and album name as the task.
* `apply_metadata()` Sets the attributes of the items from the
task's `match` attribute.
@@ -429,17 +463,22 @@ class ImportTask(BaseImportTask):
* `manipulate_files()` Copy, move, and write files depending on the
session configuration.
+ * `set_fields()` Sets the fields given at CLI or configuration to
+ the specified values.
+
* `finalize()` Update the import progress and cleanup the file
system.
"""
+
def __init__(self, toppath, paths, items):
- super(ImportTask, self).__init__(toppath, paths, items)
+ super().__init__(toppath, paths, items)
self.choice_flag = None
self.cur_album = None
self.cur_artist = None
self.candidates = []
self.rec = None
self.should_remove_duplicates = False
+ self.should_merge_duplicates = False
self.is_album = True
self.search_ids = [] # user-supplied candidate IDs.
@@ -510,6 +549,10 @@ class ImportTask(BaseImportTask):
def apply_metadata(self):
"""Copy metadata from match info to the items.
"""
+ if config['import']['from_scratch']:
+ for item in self.match.mapping:
+ item.clear()
+
autotag.apply_metadata(self.match.info, self.match.mapping)
def duplicate_items(self, lib):
@@ -520,23 +563,45 @@ class ImportTask(BaseImportTask):
def remove_duplicates(self, lib):
duplicate_items = self.duplicate_items(lib)
- log.debug(u'removing {0} old duplicated items', len(duplicate_items))
+ log.debug('removing {0} old duplicated items', len(duplicate_items))
for item in duplicate_items:
item.remove()
if lib.directory in util.ancestry(item.path):
- log.debug(u'deleting duplicate {0}',
+ log.debug('deleting duplicate {0}',
util.displayable_path(item.path))
util.remove(item.path)
util.prune_dirs(os.path.dirname(item.path),
lib.directory)
+ def set_fields(self, lib):
+ """Sets the fields given at CLI or configuration to the specified
+ values, for both the album and all its items.
+ """
+ items = self.imported_items()
+ for field, view in config['import']['set_fields'].items():
+ value = view.get()
+ log.debug('Set field {1}={2} for {0}',
+ displayable_path(self.paths),
+ field,
+ value)
+ self.album[field] = value
+ for item in items:
+ item[field] = value
+ with lib.transaction():
+ for item in items:
+ item.store()
+ self.album.store()
+
def finalize(self, session):
"""Save progress, clean up files, and emit plugin event.
"""
# Update progress.
if session.want_resume:
self.save_progress()
- if session.config['incremental']:
+ if session.config['incremental'] and not (
+ # Should we skip recording to incremental list?
+ self.skip and session.config['incremental_skip_later']
+ ):
self.save_history()
self.cleanup(copy=session.config['copy'],
@@ -609,17 +674,18 @@ class ImportTask(BaseImportTask):
return []
duplicates = []
- task_paths = set(i.path for i in self.items if i)
+ task_paths = {i.path for i in self.items if i}
duplicate_query = dbcore.AndQuery((
dbcore.MatchQuery('albumartist', artist),
dbcore.MatchQuery('album', album),
))
for album in lib.albums(duplicate_query):
- # Check whether the album is identical in contents, in which
- # case it is not a duplicate (will be replaced).
- album_paths = set(i.path for i in album.items())
- if album_paths != task_paths:
+ # Check whether the album paths are all present in the task
+ # i.e. album is being completely re-imported by the task,
+ # in which case it is not a duplicate (will be replaced).
+ album_paths = {i.path for i in album.items()}
+ if not (album_paths <= task_paths):
duplicates.append(album)
return duplicates
@@ -659,20 +725,28 @@ class ImportTask(BaseImportTask):
for item in self.items:
item.update(changes)
- def manipulate_files(self, move=False, copy=False, write=False,
- link=False, hardlink=False, session=None):
+ def manipulate_files(self, operation=None, write=False, session=None):
+ """ Copy, move, link, hardlink or reflink (depending on `operation`) the files
+ as well as write metadata.
+
+ `operation` should be an instance of `util.MoveOperation`.
+
+ If `write` is `True` metadata is written to the files.
+ """
+
items = self.imported_items()
# Save the original paths of all items for deletion and pruning
# in the next step (finalization).
self.old_paths = [item.path for item in items]
for item in items:
- if move or copy or link or hardlink:
+ if operation is not None:
# In copy and link modes, treat re-imports specially:
# move in-library files. (Out-of-library files are
# copied/moved as usual).
old_path = item.path
- if (copy or link or hardlink) and self.replaced_items[item] \
- and session.lib.directory in util.ancestry(old_path):
+ if (operation != MoveOperation.MOVE
+ and self.replaced_items[item]
+ and session.lib.directory in util.ancestry(old_path)):
item.move()
# We moved the item, so remove the
# now-nonexistent file from old_paths.
@@ -680,7 +754,7 @@ class ImportTask(BaseImportTask):
else:
# A normal import. Just copy files and keep track of
# old paths.
- item.move(copy, link, hardlink)
+ item.move(operation)
if write and (self.apply or self.choice_flag == action.RETAG):
item.try_write()
@@ -699,6 +773,8 @@ class ImportTask(BaseImportTask):
self.record_replaced(lib)
self.remove_replaced(lib)
self.album = lib.add_album(self.imported_items())
+ if 'data_source' in self.imported_items()[0]:
+ self.album.data_source = self.imported_items()[0].data_source
self.reimport_metadata(lib)
def record_replaced(self, lib):
@@ -717,7 +793,7 @@ class ImportTask(BaseImportTask):
if (not dup_item.album_id or
dup_item.album_id in replaced_album_ids):
continue
- replaced_album = dup_item.get_album()
+ replaced_album = dup_item._cached_album
if replaced_album:
replaced_album_ids.add(dup_item.album_id)
self.replaced_albums[replaced_album.path] = replaced_album
@@ -734,8 +810,8 @@ class ImportTask(BaseImportTask):
self.album.artpath = replaced_album.artpath
self.album.store()
log.debug(
- u'Reimported album: added {0}, flexible '
- u'attributes {1} from album {2} for {3}',
+ 'Reimported album: added {0}, flexible '
+ 'attributes {1} from album {2} for {3}',
self.album.added,
replaced_album._values_flex.keys(),
replaced_album.id,
@@ -748,16 +824,16 @@ class ImportTask(BaseImportTask):
if dup_item.added and dup_item.added != item.added:
item.added = dup_item.added
log.debug(
- u'Reimported item added {0} '
- u'from item {1} for {2}',
+ 'Reimported item added {0} '
+ 'from item {1} for {2}',
item.added,
dup_item.id,
displayable_path(item.path)
)
item.update(dup_item._values_flex)
log.debug(
- u'Reimported item flexible attributes {0} '
- u'from item {1} for {2}',
+ 'Reimported item flexible attributes {0} '
+ 'from item {1} for {2}',
dup_item._values_flex.keys(),
dup_item.id,
displayable_path(item.path)
@@ -770,10 +846,10 @@ class ImportTask(BaseImportTask):
"""
for item in self.imported_items():
for dup_item in self.replaced_items[item]:
- log.debug(u'Replacing item {0}: {1}',
+ log.debug('Replacing item {0}: {1}',
dup_item.id, displayable_path(item.path))
dup_item.remove()
- log.debug(u'{0} of {1} items replaced',
+ log.debug('{0} of {1} items replaced',
sum(bool(l) for l in self.replaced_items.values()),
len(self.imported_items()))
@@ -811,7 +887,7 @@ class SingletonImportTask(ImportTask):
"""
def __init__(self, toppath, item):
- super(SingletonImportTask, self).__init__(toppath, [item.path], [item])
+ super().__init__(toppath, [item.path], [item])
self.item = item
self.is_album = False
self.paths = [item.path]
@@ -877,6 +953,19 @@ class SingletonImportTask(ImportTask):
def reload(self):
self.item.load()
+ def set_fields(self, lib):
+ """Sets the fields given at CLI or configuration to the specified
+ values, for the singleton item.
+ """
+ for field, view in config['import']['set_fields'].items():
+ value = view.get()
+ log.debug('Set field {1}={2} for {0}',
+ displayable_path(self.paths),
+ field,
+ value)
+ self.item[field] = value
+ self.item.store()
+
# FIXME The inheritance relationships are inverted. This is why there
# are so many methods which pass. More responsibility should be delegated to
@@ -891,7 +980,7 @@ class SentinelImportTask(ImportTask):
"""
def __init__(self, toppath, paths):
- super(SentinelImportTask, self).__init__(toppath, paths, ())
+ super().__init__(toppath, paths, ())
# TODO Remove the remaining attributes eventually
self.should_remove_duplicates = False
self.is_album = True
@@ -935,7 +1024,7 @@ class ArchiveImportTask(SentinelImportTask):
"""
def __init__(self, toppath):
- super(ArchiveImportTask, self).__init__(toppath, ())
+ super().__init__(toppath, ())
self.extracted = False
@classmethod
@@ -964,14 +1053,20 @@ class ArchiveImportTask(SentinelImportTask):
cls._handlers = []
from zipfile import is_zipfile, ZipFile
cls._handlers.append((is_zipfile, ZipFile))
- from tarfile import is_tarfile, TarFile
- cls._handlers.append((is_tarfile, TarFile))
+ import tarfile
+ cls._handlers.append((tarfile.is_tarfile, tarfile.open))
try:
from rarfile import is_rarfile, RarFile
except ImportError:
pass
else:
cls._handlers.append((is_rarfile, RarFile))
+ try:
+ from py7zr import is_7zfile, SevenZipFile
+ except ImportError:
+ pass
+ else:
+ cls._handlers.append((is_7zfile, SevenZipFile))
return cls._handlers
@@ -979,7 +1074,7 @@ class ArchiveImportTask(SentinelImportTask):
"""Removes the temporary directory the archive was extracted to.
"""
if self.extracted:
- log.debug(u'Removing extracted directory: {0}',
+ log.debug('Removing extracted directory: {0}',
displayable_path(self.toppath))
shutil.rmtree(self.toppath)
@@ -991,9 +1086,9 @@ class ArchiveImportTask(SentinelImportTask):
if path_test(util.py3_path(self.toppath)):
break
+ extract_to = mkdtemp()
+ archive = handler_class(util.py3_path(self.toppath), mode='r')
try:
- extract_to = mkdtemp()
- archive = handler_class(util.py3_path(self.toppath), mode='r')
archive.extractall(extract_to)
finally:
archive.close()
@@ -1001,10 +1096,11 @@ class ArchiveImportTask(SentinelImportTask):
self.toppath = extract_to
-class ImportTaskFactory(object):
+class ImportTaskFactory:
"""Generate album and singleton import tasks for all media files
indicated by a path.
"""
+
def __init__(self, toppath, session):
"""Create a new task factory.
@@ -1042,14 +1138,12 @@ class ImportTaskFactory(object):
if self.session.config['singletons']:
for path in paths:
tasks = self._create(self.singleton(path))
- for task in tasks:
- yield task
+ yield from tasks
yield self.sentinel(dirs)
else:
tasks = self._create(self.album(paths, dirs))
- for task in tasks:
- yield task
+ yield from tasks
# Produce the final sentinel for this toppath to indicate that
# it is finished. This is usually just a SentinelImportTask, but
@@ -1097,7 +1191,7 @@ class ImportTaskFactory(object):
"""Return a `SingletonImportTask` for the music file.
"""
if self.session.already_imported(self.toppath, [path]):
- log.debug(u'Skipping previously-imported path: {0}',
+ log.debug('Skipping previously-imported path: {0}',
displayable_path(path))
self.skipped += 1
return None
@@ -1118,10 +1212,10 @@ class ImportTaskFactory(object):
return None
if dirs is None:
- dirs = list(set(os.path.dirname(p) for p in paths))
+ dirs = list({os.path.dirname(p) for p in paths})
if self.session.already_imported(self.toppath, dirs):
- log.debug(u'Skipping previously-imported path: {0}',
+ log.debug('Skipping previously-imported path: {0}',
displayable_path(dirs))
self.skipped += 1
return None
@@ -1151,22 +1245,22 @@ class ImportTaskFactory(object):
if not (self.session.config['move'] or
self.session.config['copy']):
- log.warning(u"Archive importing requires either "
- u"'copy' or 'move' to be enabled.")
+ log.warning("Archive importing requires either "
+ "'copy' or 'move' to be enabled.")
return
- log.debug(u'Extracting archive: {0}',
+ log.debug('Extracting archive: {0}',
displayable_path(self.toppath))
archive_task = ArchiveImportTask(self.toppath)
try:
archive_task.extract()
except Exception as exc:
- log.error(u'extraction failed: {0}', exc)
+ log.error('extraction failed: {0}', exc)
return
# Now read albums from the extracted directory.
self.toppath = archive_task.toppath
- log.debug(u'Archive extracted to: {0}', self.toppath)
+ log.debug('Archive extracted to: {0}', self.toppath)
return archive_task
def read_item(self, path):
@@ -1182,12 +1276,33 @@ class ImportTaskFactory(object):
# Silently ignore non-music files.
pass
elif isinstance(exc.reason, mediafile.UnreadableFileError):
- log.warning(u'unreadable file: {0}', displayable_path(path))
+ log.warning('unreadable file: {0}', displayable_path(path))
else:
- log.error(u'error reading {0}: {1}',
+ log.error('error reading {0}: {1}',
displayable_path(path), exc)
+# Pipeline utilities
+
+def _freshen_items(items):
+ # Clear IDs from re-tagged items so they appear "fresh" when
+ # we add them back to the library.
+ for item in items:
+ item.id = None
+ item.album_id = None
+
+
+def _extend_pipeline(tasks, *stages):
+ # Return pipeline extension for stages with list of tasks
+ if type(tasks) == list:
+ task_iter = iter(tasks)
+ else:
+ task_iter = tasks
+
+ ipl = pipeline.Pipeline([task_iter] + list(stages))
+ return pipeline.multiple(ipl.pull())
+
+
# Full-album pipeline stages.
def read_tasks(session):
@@ -1202,17 +1317,16 @@ def read_tasks(session):
# Generate tasks.
task_factory = ImportTaskFactory(toppath, session)
- for t in task_factory.tasks():
- yield t
+ yield from task_factory.tasks()
skipped += task_factory.skipped
if not task_factory.imported:
- log.warning(u'No files imported from {0}',
+ log.warning('No files imported from {0}',
displayable_path(toppath))
# Show skipped directories (due to incremental/resume).
if skipped:
- log.info(u'Skipped {0} paths.', skipped)
+ log.info('Skipped {0} paths.', skipped)
def query_tasks(session):
@@ -1230,15 +1344,10 @@ def query_tasks(session):
else:
# Search for albums.
for album in session.lib.albums(session.query):
- log.debug(u'yielding album {0}: {1} - {2}',
+ log.debug('yielding album {0}: {1} - {2}',
album.id, album.albumartist, album.album)
items = list(album.items())
-
- # Clear IDs from re-tagged items so they appear "fresh" when
- # we add them back to the library.
- for item in items:
- item.id = None
- item.album_id = None
+ _freshen_items(items)
task = ImportTask(None, [album.item_dir()], items)
for task in task.handle_created(session):
@@ -1258,7 +1367,7 @@ def lookup_candidates(session, task):
return
plugins.send('import_task_start', session=session, task=task)
- log.debug(u'Looking up: {0}', displayable_path(task.paths))
+ log.debug('Looking up: {0}', displayable_path(task.paths))
# Restrict the initial lookup to IDs specified by the user via the -m
# option. Currently all the IDs are passed onto the tasks directly.
@@ -1284,6 +1393,9 @@ def user_query(session, task):
if task.skip:
return task
+ if session.already_merged(task.paths):
+ return pipeline.BUBBLE
+
# Ask the user for a choice.
task.choose_match(session)
plugins.send('import_task_choice', session=session, task=task)
@@ -1294,28 +1406,41 @@ def user_query(session, task):
def emitter(task):
for item in task.items:
task = SingletonImportTask(task.toppath, item)
- for new_task in task.handle_created(session):
- yield new_task
+ yield from task.handle_created(session)
yield SentinelImportTask(task.toppath, task.paths)
- ipl = pipeline.Pipeline([
- emitter(task),
- lookup_candidates(session),
- user_query(session),
- ])
- return pipeline.multiple(ipl.pull())
+ return _extend_pipeline(emitter(task),
+ lookup_candidates(session),
+ user_query(session))
# As albums: group items by albums and create task for each album
if task.choice_flag is action.ALBUMS:
- ipl = pipeline.Pipeline([
- iter([task]),
- group_albums(session),
- lookup_candidates(session),
- user_query(session)
- ])
- return pipeline.multiple(ipl.pull())
+ return _extend_pipeline([task],
+ group_albums(session),
+ lookup_candidates(session),
+ user_query(session))
resolve_duplicates(session, task)
+
+ if task.should_merge_duplicates:
+ # Create a new task for tagging the current items
+ # and duplicates together
+ duplicate_items = task.duplicate_items(session.lib)
+
+ # Duplicates would be reimported so make them look "fresh"
+ _freshen_items(duplicate_items)
+ duplicate_paths = [item.path for item in duplicate_items]
+
+ # Record merged paths in the session so they are not reimported
+ session.mark_merged(duplicate_paths)
+
+ merged_task = ImportTask(None, task.paths + duplicate_paths,
+ task.items + duplicate_items)
+
+ return _extend_pipeline([merged_task],
+ lookup_candidates(session),
+ user_query(session))
+
apply_choice(session, task)
return task
@@ -1327,28 +1452,32 @@ def resolve_duplicates(session, task):
if task.choice_flag in (action.ASIS, action.APPLY, action.RETAG):
found_duplicates = task.find_duplicates(session.lib)
if found_duplicates:
- log.debug(u'found duplicates: {}'.format(
+ log.debug('found duplicates: {}'.format(
[o.id for o in found_duplicates]
))
# Get the default action to follow from config.
duplicate_action = config['import']['duplicate_action'].as_choice({
- u'skip': u's',
- u'keep': u'k',
- u'remove': u'r',
- u'ask': u'a',
+ 'skip': 's',
+ 'keep': 'k',
+ 'remove': 'r',
+ 'merge': 'm',
+ 'ask': 'a',
})
- log.debug(u'default action for duplicates: {0}', duplicate_action)
+ log.debug('default action for duplicates: {0}', duplicate_action)
- if duplicate_action == u's':
+ if duplicate_action == 's':
# Skip new.
task.set_choice(action.SKIP)
- elif duplicate_action == u'k':
+ elif duplicate_action == 'k':
# Keep both. Do nothing; leave the choice intact.
pass
- elif duplicate_action == u'r':
+ elif duplicate_action == 'r':
# Remove old.
task.should_remove_duplicates = True
+ elif duplicate_action == 'm':
+ # Merge duplicates together
+ task.should_merge_duplicates = True
else:
# No default action set; ask the session.
session.resolve_duplicate(task, found_duplicates)
@@ -1366,7 +1495,7 @@ def import_asis(session, task):
if task.skip:
return
- log.info(u'{}', displayable_path(task.paths))
+ log.info('{}', displayable_path(task.paths))
task.set_choice(action.ASIS)
apply_choice(session, task)
@@ -1385,6 +1514,14 @@ def apply_choice(session, task):
task.add(session.lib)
+ # If ``set_fields`` is set, set those fields to the
+ # configured values.
+ # NOTE: This cannot be done before the ``task.add()`` call above,
+ # because then the ``ImportTask`` won't have an `album` for which
+ # it can set the fields.
+ if config['import']['set_fields']:
+ task.set_fields(session.lib)
+
@pipeline.mutator_stage
def plugin_stage(session, func, task):
@@ -1413,12 +1550,22 @@ def manipulate_files(session, task):
if task.should_remove_duplicates:
task.remove_duplicates(session.lib)
+ if session.config['move']:
+ operation = MoveOperation.MOVE
+ elif session.config['copy']:
+ operation = MoveOperation.COPY
+ elif session.config['link']:
+ operation = MoveOperation.LINK
+ elif session.config['hardlink']:
+ operation = MoveOperation.HARDLINK
+ elif session.config['reflink']:
+ operation = MoveOperation.REFLINK
+ else:
+ operation = None
+
task.manipulate_files(
- move=session.config['move'],
- copy=session.config['copy'],
+ operation,
write=session.config['write'],
- link=session.config['link'],
- hardlink=session.config['hardlink'],
session=session,
)
@@ -1431,11 +1578,11 @@ def log_files(session, task):
"""A coroutine (pipeline stage) to log each file to be imported.
"""
if isinstance(task, SingletonImportTask):
- log.info(u'Singleton: {0}', displayable_path(task.item['path']))
+ log.info('Singleton: {0}', displayable_path(task.item['path']))
elif task.items:
- log.info(u'Album: {0}', displayable_path(task.paths[0]))
+ log.info('Album: {0}', displayable_path(task.paths[0]))
for item in task.items:
- log.info(u' {0}', displayable_path(item['path']))
+ log.info(' {0}', displayable_path(item['path']))
def group_albums(session):
@@ -1469,6 +1616,14 @@ MULTIDISC_MARKERS = (br'dis[ck]', br'cd')
MULTIDISC_PAT_FMT = br'^(.*%s[\W_]*)\d'
+def is_subdir_of_any_in_list(path, dirs):
+ """Returns True if path os a subdirectory of any directory in dirs
+ (a list). In other case, returns False.
+ """
+ ancestors = ancestry(path)
+ return any(d in ancestors for d in dirs)
+
+
def albums_in_dir(path):
"""Recursively searches the given directory and returns an iterable
of (paths, items) where paths is a list of directories and items is
@@ -1488,7 +1643,7 @@ def albums_in_dir(path):
# and add the current directory. If so, just add the directory
# and move on to the next directory. If not, stop collapsing.
if collapse_paths:
- if (not collapse_pat and collapse_paths[0] in ancestry(root)) or \
+ if (is_subdir_of_any_in_list(root, collapse_paths)) or \
(collapse_pat and
collapse_pat.match(os.path.basename(root))):
# Still collapsing.
diff --git a/lib/beets/library.py b/lib/beets/library.py
old mode 100755
new mode 100644
index b263ecd6..888836cd
--- a/lib/beets/library.py
+++ b/lib/beets/library.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
# This file is part of beets.
# Copyright 2016, Adrian Sampson.
#
@@ -15,33 +14,30 @@
"""The core data store and collection logic for beets.
"""
-from __future__ import division, absolute_import, print_function
import os
import sys
import unicodedata
import time
import re
-import six
+import string
+import shlex
from beets import logging
-from beets.mediafile import MediaFile, UnreadableFileError
+from mediafile import MediaFile, UnreadableFileError
from beets import plugins
from beets import util
-from beets.util import bytestring_path, syspath, normpath, samefile
-from beets.util.functemplate import Template
+from beets.util import bytestring_path, syspath, normpath, samefile, \
+ MoveOperation, lazy_property
+from beets.util.functemplate import template, Template
from beets import dbcore
from beets.dbcore import types
import beets
# To use the SQLite "blob" type, it doesn't suffice to provide a byte
-# string; SQLite treats that as encoded text. Wrapping it in a `buffer` or a
-# `memoryview`, depending on the Python version, tells it that we
-# actually mean non-text data.
-if six.PY2:
- BLOB_TYPE = buffer # noqa: F821
-else:
- BLOB_TYPE = memoryview
+# string; SQLite treats that as encoded text. Wrapping it in a
+# `memoryview` tells it that we actually mean non-text data.
+BLOB_TYPE = memoryview
log = logging.getLogger('beets')
@@ -63,7 +59,7 @@ class PathQuery(dbcore.FieldQuery):
`case_sensitive` can be a bool or `None`, indicating that the
behavior should depend on the filesystem.
"""
- super(PathQuery, self).__init__(field, pattern, fast)
+ super().__init__(field, pattern, fast)
# By default, the case sensitivity depends on the filesystem
# that the query path is located on.
@@ -144,10 +140,27 @@ class DateType(types.Float):
class PathType(types.Type):
- sql = u'BLOB'
+ """A dbcore type for filesystem paths. These are represented as
+ `bytes` objects, in keeping with the Unix filesystem abstraction.
+ """
+
+ sql = 'BLOB'
query = PathQuery
model_type = bytes
+ def __init__(self, nullable=False):
+ """Create a path type object. `nullable` controls whether the
+ type may be missing, i.e., None.
+ """
+ self.nullable = nullable
+
+ @property
+ def null(self):
+ if self.nullable:
+ return None
+ else:
+ return b''
+
def format(self, value):
return util.displayable_path(value)
@@ -155,7 +168,7 @@ class PathType(types.Type):
return normpath(bytestring_path(string))
def normalize(self, value):
- if isinstance(value, six.text_type):
+ if isinstance(value, str):
# Paths stored internally as encoded bytes.
return bytestring_path(value)
@@ -188,6 +201,8 @@ class MusicalKey(types.String):
r'bb': 'a#',
}
+ null = None
+
def parse(self, key):
key = key.lower()
for flat, sharp in self.ENHARMONIC.items():
@@ -231,6 +246,7 @@ class SmartArtistSort(dbcore.query.Sort):
"""Sort by artist (either album artist or track artist),
prioritizing the sort field over the raw field.
"""
+
def __init__(self, model_cls, ascending=True, case_insensitive=True):
self.album = model_cls is Album
self.ascending = ascending
@@ -246,12 +262,15 @@ class SmartArtistSort(dbcore.query.Sort):
def sort(self, objs):
if self.album:
- field = lambda a: a.albumartist_sort or a.albumartist
+ def field(a):
+ return a.albumartist_sort or a.albumartist
else:
- field = lambda i: i.artist_sort or i.artist
+ def field(i):
+ return i.artist_sort or i.artist
if self.case_insensitive:
- key = lambda x: field(x).lower()
+ def key(x):
+ return field(x).lower()
else:
key = field
return sorted(objs, key=key, reverse=not self.ascending)
@@ -262,17 +281,17 @@ PF_KEY_DEFAULT = 'default'
# Exceptions.
-@six.python_2_unicode_compatible
class FileOperationError(Exception):
"""Indicates an error when interacting with a file on disk.
Possibilities include an unsupported media type, a permissions
error, and an unhandled Mutagen exception.
"""
+
def __init__(self, path, reason):
"""Create an exception describing an operation on the file at
`path` with the underlying (chained) exception `reason`.
"""
- super(FileOperationError, self).__init__(path, reason)
+ super().__init__(path, reason)
self.path = path
self.reason = reason
@@ -280,9 +299,9 @@ class FileOperationError(Exception):
"""Get a string representing the error. Describes both the
underlying reason and the file path in question.
"""
- return u'{0}: {1}'.format(
+ return '{}: {}'.format(
util.displayable_path(self.path),
- six.text_type(self.reason)
+ str(self.reason)
)
# define __str__ as text to avoid infinite loop on super() calls
@@ -290,25 +309,24 @@ class FileOperationError(Exception):
__str__ = text
-@six.python_2_unicode_compatible
class ReadError(FileOperationError):
"""An error while reading a file (i.e. in `Item.read`).
"""
+
def __str__(self):
- return u'error reading ' + super(ReadError, self).text()
+ return 'error reading ' + super().text()
-@six.python_2_unicode_compatible
class WriteError(FileOperationError):
"""An error while writing a file (i.e. in `Item.write`).
"""
+
def __str__(self):
- return u'error writing ' + super(WriteError, self).text()
+ return 'error writing ' + super().text()
# Item and Album model classes.
-@six.python_2_unicode_compatible
class LibModel(dbcore.Model):
"""Shared concrete functionality for Items and Albums.
"""
@@ -323,21 +341,21 @@ class LibModel(dbcore.Model):
return funcs
def store(self, fields=None):
- super(LibModel, self).store(fields)
+ super().store(fields)
plugins.send('database_change', lib=self._db, model=self)
def remove(self):
- super(LibModel, self).remove()
+ super().remove()
plugins.send('database_change', lib=self._db, model=self)
def add(self, lib=None):
- super(LibModel, self).add(lib)
+ super().add(lib)
plugins.send('database_change', lib=self._db, model=self)
def __format__(self, spec):
if not spec:
spec = beets.config[self._format_config_key].as_str()
- assert isinstance(spec, six.text_type)
+ assert isinstance(spec, str)
return self.evaluate_template(spec)
def __str__(self):
@@ -353,15 +371,42 @@ class FormattedItemMapping(dbcore.db.FormattedMapping):
Album-level fields take precedence if `for_path` is true.
"""
- def __init__(self, item, for_path=False):
- super(FormattedItemMapping, self).__init__(item, for_path)
- self.album = item.get_album()
- self.album_keys = []
+ ALL_KEYS = '*'
+
+ def __init__(self, item, included_keys=ALL_KEYS, for_path=False):
+ # We treat album and item keys specially here,
+ # so exclude transitive album keys from the model's keys.
+ super().__init__(item, included_keys=[],
+ for_path=for_path)
+ self.included_keys = included_keys
+ if included_keys == self.ALL_KEYS:
+ # Performance note: this triggers a database query.
+ self.model_keys = item.keys(computed=True, with_album=False)
+ else:
+ self.model_keys = included_keys
+ self.item = item
+
+ @lazy_property
+ def all_keys(self):
+ return set(self.model_keys).union(self.album_keys)
+
+ @lazy_property
+ def album_keys(self):
+ album_keys = []
if self.album:
- for key in self.album.keys(True):
- if key in Album.item_keys or key not in item._fields.keys():
- self.album_keys.append(key)
- self.all_keys = set(self.model_keys).union(self.album_keys)
+ if self.included_keys == self.ALL_KEYS:
+ # Performance note: this triggers a database query.
+ for key in self.album.keys(computed=True):
+ if key in Album.item_keys \
+ or key not in self.item._fields.keys():
+ album_keys.append(key)
+ else:
+ album_keys = self.included_keys
+ return album_keys
+
+ @property
+ def album(self):
+ return self.item._cached_album
def _get(self, key):
"""Get the value for a key, either from the album or the item.
@@ -377,19 +422,23 @@ class FormattedItemMapping(dbcore.db.FormattedMapping):
raise KeyError(key)
def __getitem__(self, key):
- """Get the value for a key. Certain unset values are remapped.
+ """Get the value for a key. `artist` and `albumartist`
+ are fallback values for each other when not set.
"""
value = self._get(key)
# `artist` and `albumartist` fields fall back to one another.
# This is helpful in path formats when the album artist is unset
# on as-is imports.
- if key == 'artist' and not value:
- return self._get('albumartist')
- elif key == 'albumartist' and not value:
- return self._get('artist')
- else:
- return value
+ try:
+ if key == 'artist' and not value:
+ return self._get('albumartist')
+ elif key == 'albumartist' and not value:
+ return self._get('artist')
+ except KeyError:
+ pass
+
+ return value
def __iter__(self):
return iter(self.all_keys)
@@ -402,70 +451,85 @@ class Item(LibModel):
_table = 'items'
_flex_table = 'item_attributes'
_fields = {
- 'id': types.PRIMARY_ID,
- 'path': PathType(),
+ 'id': types.PRIMARY_ID,
+ 'path': PathType(),
'album_id': types.FOREIGN_ID,
- 'title': types.STRING,
- 'artist': types.STRING,
- 'artist_sort': types.STRING,
- 'artist_credit': types.STRING,
- 'album': types.STRING,
- 'albumartist': types.STRING,
- 'albumartist_sort': types.STRING,
- 'albumartist_credit': types.STRING,
- 'genre': types.STRING,
- 'lyricist': types.STRING,
- 'composer': types.STRING,
- 'arranger': types.STRING,
- 'grouping': types.STRING,
- 'year': types.PaddedInt(4),
- 'month': types.PaddedInt(2),
- 'day': types.PaddedInt(2),
- 'track': types.PaddedInt(2),
- 'tracktotal': types.PaddedInt(2),
- 'disc': types.PaddedInt(2),
- 'disctotal': types.PaddedInt(2),
- 'lyrics': types.STRING,
- 'comments': types.STRING,
- 'bpm': types.INTEGER,
- 'comp': types.BOOLEAN,
- 'mb_trackid': types.STRING,
- 'mb_albumid': types.STRING,
- 'mb_artistid': types.STRING,
- 'mb_albumartistid': types.STRING,
- 'albumtype': types.STRING,
- 'label': types.STRING,
+ 'title': types.STRING,
+ 'artist': types.STRING,
+ 'artist_sort': types.STRING,
+ 'artist_credit': types.STRING,
+ 'album': types.STRING,
+ 'albumartist': types.STRING,
+ 'albumartist_sort': types.STRING,
+ 'albumartist_credit': types.STRING,
+ 'genre': types.STRING,
+ 'style': types.STRING,
+ 'discogs_albumid': types.INTEGER,
+ 'discogs_artistid': types.INTEGER,
+ 'discogs_labelid': types.INTEGER,
+ 'lyricist': types.STRING,
+ 'composer': types.STRING,
+ 'composer_sort': types.STRING,
+ 'work': types.STRING,
+ 'mb_workid': types.STRING,
+ 'work_disambig': types.STRING,
+ 'arranger': types.STRING,
+ 'grouping': types.STRING,
+ 'year': types.PaddedInt(4),
+ 'month': types.PaddedInt(2),
+ 'day': types.PaddedInt(2),
+ 'track': types.PaddedInt(2),
+ 'tracktotal': types.PaddedInt(2),
+ 'disc': types.PaddedInt(2),
+ 'disctotal': types.PaddedInt(2),
+ 'lyrics': types.STRING,
+ 'comments': types.STRING,
+ 'bpm': types.INTEGER,
+ 'comp': types.BOOLEAN,
+ 'mb_trackid': types.STRING,
+ 'mb_albumid': types.STRING,
+ 'mb_artistid': types.STRING,
+ 'mb_albumartistid': types.STRING,
+ 'mb_releasetrackid': types.STRING,
+ 'trackdisambig': types.STRING,
+ 'albumtype': types.STRING,
+ 'albumtypes': types.STRING,
+ 'label': types.STRING,
'acoustid_fingerprint': types.STRING,
- 'acoustid_id': types.STRING,
- 'mb_releasegroupid': types.STRING,
- 'asin': types.STRING,
- 'catalognum': types.STRING,
- 'script': types.STRING,
- 'language': types.STRING,
- 'country': types.STRING,
- 'albumstatus': types.STRING,
- 'media': types.STRING,
- 'albumdisambig': types.STRING,
- 'disctitle': types.STRING,
- 'encoder': types.STRING,
- 'rg_track_gain': types.NULL_FLOAT,
- 'rg_track_peak': types.NULL_FLOAT,
- 'rg_album_gain': types.NULL_FLOAT,
- 'rg_album_peak': types.NULL_FLOAT,
- 'original_year': types.PaddedInt(4),
- 'original_month': types.PaddedInt(2),
- 'original_day': types.PaddedInt(2),
- 'initial_key': MusicalKey(),
+ 'acoustid_id': types.STRING,
+ 'mb_releasegroupid': types.STRING,
+ 'asin': types.STRING,
+ 'isrc': types.STRING,
+ 'catalognum': types.STRING,
+ 'script': types.STRING,
+ 'language': types.STRING,
+ 'country': types.STRING,
+ 'albumstatus': types.STRING,
+ 'media': types.STRING,
+ 'albumdisambig': types.STRING,
+ 'releasegroupdisambig': types.STRING,
+ 'disctitle': types.STRING,
+ 'encoder': types.STRING,
+ 'rg_track_gain': types.NULL_FLOAT,
+ 'rg_track_peak': types.NULL_FLOAT,
+ 'rg_album_gain': types.NULL_FLOAT,
+ 'rg_album_peak': types.NULL_FLOAT,
+ 'r128_track_gain': types.NullPaddedInt(6),
+ 'r128_album_gain': types.NullPaddedInt(6),
+ 'original_year': types.PaddedInt(4),
+ 'original_month': types.PaddedInt(2),
+ 'original_day': types.PaddedInt(2),
+ 'initial_key': MusicalKey(),
- 'length': DurationType(),
- 'bitrate': types.ScaledInt(1000, u'kbps'),
- 'format': types.STRING,
- 'samplerate': types.ScaledInt(1000, u'kHz'),
- 'bitdepth': types.INTEGER,
- 'channels': types.INTEGER,
- 'mtime': DateType(),
- 'added': DateType(),
+ 'length': DurationType(),
+ 'bitrate': types.ScaledInt(1000, 'kbps'),
+ 'format': types.STRING,
+ 'samplerate': types.ScaledInt(1000, 'kHz'),
+ 'bitdepth': types.INTEGER,
+ 'channels': types.INTEGER,
+ 'mtime': DateType(),
+ 'added': DateType(),
}
_search_fields = ('artist', 'title', 'comments',
@@ -498,6 +562,29 @@ class Item(LibModel):
_format_config_key = 'format_item'
+ __album = None
+ """Cached album object. Read-only."""
+
+ @property
+ def _cached_album(self):
+ """The Album object that this item belongs to, if any, or
+ None if the item is a singleton or is not associated with a
+ library.
+ The instance is cached and refreshed on access.
+
+ DO NOT MODIFY!
+ If you want a copy to modify, use :meth:`get_album`.
+ """
+ if not self.__album and self._db:
+ self.__album = self._db.get_album(self)
+ elif self.__album:
+ self.__album.load()
+ return self.__album
+
+ @_cached_album.setter
+ def _cached_album(self, album):
+ self.__album = album
+
@classmethod
def _getters(cls):
getters = plugins.item_field_getters()
@@ -520,24 +607,74 @@ class Item(LibModel):
"""
# Encode unicode paths and read buffers.
if key == 'path':
- if isinstance(value, six.text_type):
+ if isinstance(value, str):
value = bytestring_path(value)
elif isinstance(value, BLOB_TYPE):
value = bytes(value)
+ elif key == 'album_id':
+ self._cached_album = None
- if key in MediaFile.fields():
+ changed = super()._setitem(key, value)
+
+ if changed and key in MediaFile.fields():
self.mtime = 0 # Reset mtime on dirty.
- super(Item, self).__setitem__(key, value)
+ def __getitem__(self, key):
+ """Get the value for a field, falling back to the album if
+ necessary. Raise a KeyError if the field is not available.
+ """
+ try:
+ return super().__getitem__(key)
+ except KeyError:
+ if self._cached_album:
+ return self._cached_album[key]
+ raise
+
+ def __repr__(self):
+ # This must not use `with_album=True`, because that might access
+ # the database. When debugging, that is not guaranteed to succeed, and
+ # can even deadlock due to the database lock.
+ return '{}({})'.format(
+ type(self).__name__,
+ ', '.join('{}={!r}'.format(k, self[k])
+ for k in self.keys(with_album=False)),
+ )
+
+ def keys(self, computed=False, with_album=True):
+ """Get a list of available field names. `with_album`
+ controls whether the album's fields are included.
+ """
+ keys = super().keys(computed=computed)
+ if with_album and self._cached_album:
+ keys = set(keys)
+ keys.update(self._cached_album.keys(computed=computed))
+ keys = list(keys)
+ return keys
+
+ def get(self, key, default=None, with_album=True):
+ """Get the value for a given key or `default` if it does not
+ exist. Set `with_album` to false to skip album fallback.
+ """
+ try:
+ return self._get(key, default, raise_=with_album)
+ except KeyError:
+ if self._cached_album:
+ return self._cached_album.get(key, default)
+ return default
def update(self, values):
"""Set all key/value pairs in the mapping. If mtime is
specified, it is not reset (as it might otherwise be).
"""
- super(Item, self).update(values)
+ super().update(values)
if self.mtime == 0 and 'mtime' in values:
self.mtime = values['mtime']
+ def clear(self):
+ """Set all key/value pairs to None."""
+ for key in self._media_tag_fields:
+ setattr(self, key, None)
+
def get_album(self):
"""Get the Album object that this item belongs to, if any, or
None if the item is a singleton or is not associated with a
@@ -569,7 +706,7 @@ class Item(LibModel):
for key in self._media_fields:
value = getattr(mediafile, key)
- if isinstance(value, six.integer_types):
+ if isinstance(value, int):
if value.bit_length() > 63:
value = 0
self[key] = value
@@ -580,7 +717,7 @@ class Item(LibModel):
self.path = read_path
- def write(self, path=None, tags=None):
+ def write(self, path=None, tags=None, id3v23=None):
"""Write the item's metadata to a media file.
All fields in `_media_fields` are written to disk according to
@@ -592,6 +729,9 @@ class Item(LibModel):
`tags` is a dictionary of additional metadata the should be
written to the file. (These tags need not be in `_media_fields`.)
+ `id3v23` will override the global `id3v23` config option if it is
+ set to something other than `None`.
+
Can raise either a `ReadError` or a `WriteError`.
"""
if path is None:
@@ -599,6 +739,9 @@ class Item(LibModel):
else:
path = normpath(path)
+ if id3v23 is None:
+ id3v23 = beets.config['id3v23'].get(bool)
+
# Get the data to write to the file.
item_tags = dict(self)
item_tags = {k: v for k, v in item_tags.items()
@@ -609,10 +752,9 @@ class Item(LibModel):
# Open the file.
try:
- mediafile = MediaFile(syspath(path),
- id3v23=beets.config['id3v23'].get(bool))
+ mediafile = MediaFile(syspath(path), id3v23=id3v23)
except UnreadableFileError as exc:
- raise ReadError(self.path, exc)
+ raise ReadError(path, exc)
# Write the tags to the file.
mediafile.update(item_tags)
@@ -626,17 +768,17 @@ class Item(LibModel):
self.mtime = self.current_mtime()
plugins.send('after_write', item=self, path=path)
- def try_write(self, path=None, tags=None):
+ def try_write(self, *args, **kwargs):
"""Calls `write()` but catches and logs `FileOperationError`
exceptions.
Returns `False` an exception was caught and `True` otherwise.
"""
try:
- self.write(path, tags)
+ self.write(*args, **kwargs)
return True
except FileOperationError as exc:
- log.error(u"{0}", exc)
+ log.error("{0}", exc)
return False
def try_sync(self, write, move, with_album=True):
@@ -656,38 +798,51 @@ class Item(LibModel):
if move:
# Check whether this file is inside the library directory.
if self._db and self._db.directory in util.ancestry(self.path):
- log.debug(u'moving {0} to synchronize path',
+ log.debug('moving {0} to synchronize path',
util.displayable_path(self.path))
self.move(with_album=with_album)
self.store()
# Files themselves.
- def move_file(self, dest, copy=False, link=False, hardlink=False):
- """Moves or copies the item's file, updating the path value if
- the move succeeds. If a file exists at ``dest``, then it is
- slightly modified to be unique.
+ def move_file(self, dest, operation=MoveOperation.MOVE):
+ """Move, copy, link or hardlink the item's depending on `operation`,
+ updating the path value if the move succeeds.
+
+ If a file exists at `dest`, then it is slightly modified to be unique.
+
+ `operation` should be an instance of `util.MoveOperation`.
"""
if not util.samefile(self.path, dest):
dest = util.unique_path(dest)
- if copy:
- util.copy(self.path, dest)
- plugins.send("item_copied", item=self, source=self.path,
- destination=dest)
- elif link:
- util.link(self.path, dest)
- plugins.send("item_linked", item=self, source=self.path,
- destination=dest)
- elif hardlink:
- util.hardlink(self.path, dest)
- plugins.send("item_hardlinked", item=self, source=self.path,
- destination=dest)
- else:
+ if operation == MoveOperation.MOVE:
plugins.send("before_item_moved", item=self, source=self.path,
destination=dest)
util.move(self.path, dest)
plugins.send("item_moved", item=self, source=self.path,
destination=dest)
+ elif operation == MoveOperation.COPY:
+ util.copy(self.path, dest)
+ plugins.send("item_copied", item=self, source=self.path,
+ destination=dest)
+ elif operation == MoveOperation.LINK:
+ util.link(self.path, dest)
+ plugins.send("item_linked", item=self, source=self.path,
+ destination=dest)
+ elif operation == MoveOperation.HARDLINK:
+ util.hardlink(self.path, dest)
+ plugins.send("item_hardlinked", item=self, source=self.path,
+ destination=dest)
+ elif operation == MoveOperation.REFLINK:
+ util.reflink(self.path, dest, fallback=False)
+ plugins.send("item_reflinked", item=self, source=self.path,
+ destination=dest)
+ elif operation == MoveOperation.REFLINK_AUTO:
+ util.reflink(self.path, dest, fallback=True)
+ plugins.send("item_reflinked", item=self, source=self.path,
+ destination=dest)
+ else:
+ assert False, 'unknown MoveOperation'
# Either copying or moving succeeded, so update the stored path.
self.path = dest
@@ -706,7 +861,7 @@ class Item(LibModel):
try:
return os.path.getsize(syspath(self.path))
except (OSError, Exception) as exc:
- log.warning(u'could not get filesize: {0}', exc)
+ log.warning('could not get filesize: {0}', exc)
return 0
# Model methods.
@@ -716,7 +871,7 @@ class Item(LibModel):
removed from disk. If `with_album`, then the item's album (if
any) is removed if it the item was the last in the album.
"""
- super(Item, self).remove()
+ super().remove()
# Remove the album if it is empty.
if with_album:
@@ -734,29 +889,27 @@ class Item(LibModel):
self._db._memotable = {}
- def move(self, copy=False, link=False, hardlink=False, basedir=None,
+ def move(self, operation=MoveOperation.MOVE, basedir=None,
with_album=True, store=True):
"""Move the item to its designated location within the library
directory (provided by destination()). Subdirectories are
created as needed. If the operation succeeds, the item's path
field is updated to reflect the new location.
- If `copy` is true, moving the file is copied rather than moved.
- Similarly, `link` creates a symlink instead, and `hardlink`
- creates a hardlink.
+ Instead of moving the item it can also be copied, linked or hardlinked
+ depending on `operation` which should be an instance of
+ `util.MoveOperation`.
- basedir overrides the library base directory for the
- destination.
+ `basedir` overrides the library base directory for the destination.
- If the item is in an album, the album is given an opportunity to
- move its art. (This can be disabled by passing
- with_album=False.)
+ If the item is in an album and `with_album` is `True`, the album is
+ given an opportunity to move its art.
By default, the item is stored to the database if it is in the
database, so any dirty fields prior to the move() call will be written
- as a side effect. You probably want to call save() to commit the DB
- transaction. If `store` is true however, the item won't be stored, and
- you'll have to manually store it after invoking this method.
+ as a side effect.
+ If `store` is `False` however, the item won't be stored and you'll
+ have to manually store it after invoking this method.
"""
self._check_db()
dest = self.destination(basedir=basedir)
@@ -766,7 +919,7 @@ class Item(LibModel):
# Perform the move and store the change.
old_path = self.path
- self.move_file(dest, copy, link, hardlink)
+ self.move_file(dest, operation)
if store:
self.store()
@@ -774,18 +927,18 @@ class Item(LibModel):
if with_album:
album = self.get_album()
if album:
- album.move_art(copy)
+ album.move_art(operation)
if store:
album.store()
# Prune vacated directory.
- if not copy:
+ if operation == MoveOperation.MOVE:
util.prune_dirs(os.path.dirname(old_path), self._db.directory)
# Templating.
def destination(self, fragment=False, basedir=None, platform=None,
- path_formats=None):
+ path_formats=None, replacements=None):
"""Returns the path in the library directory designated for the
item (i.e., where the file ought to be). fragment makes this
method return just the path fragment underneath the root library
@@ -797,6 +950,8 @@ class Item(LibModel):
platform = platform or sys.platform
basedir = basedir or self._db.directory
path_formats = path_formats or self._db.path_formats
+ if replacements is None:
+ replacements = self._db.replacements
# Use a path format based on a query, falling back on the
# default.
@@ -814,11 +969,11 @@ class Item(LibModel):
if query == PF_KEY_DEFAULT:
break
else:
- assert False, u"no default path format"
+ assert False, "no default path format"
if isinstance(path_format, Template):
subpath_tmpl = path_format
else:
- subpath_tmpl = Template(path_format)
+ subpath_tmpl = template(path_format)
# Evaluate the selected template.
subpath = self.evaluate_template(subpath_tmpl, True)
@@ -841,16 +996,16 @@ class Item(LibModel):
maxlen = util.max_filename_length(self._db.directory)
subpath, fellback = util.legalize_path(
- subpath, self._db.replacements, maxlen,
+ subpath, replacements, maxlen,
os.path.splitext(self.path)[1], fragment
)
if fellback:
# Print an error message if legalization fell back to
# default replacements because of the maximum length.
log.warning(
- u'Fell back to default replacements when naming '
- u'file {}. Configure replacements to avoid lengthening '
- u'the filename.',
+ 'Fell back to default replacements when naming '
+ 'file {}. Configure replacements to avoid lengthening '
+ 'the filename.',
subpath
)
@@ -869,43 +1024,50 @@ class Album(LibModel):
_flex_table = 'album_attributes'
_always_dirty = True
_fields = {
- 'id': types.PRIMARY_ID,
- 'artpath': PathType(),
- 'added': DateType(),
+ 'id': types.PRIMARY_ID,
+ 'artpath': PathType(True),
+ 'added': DateType(),
- 'albumartist': types.STRING,
- 'albumartist_sort': types.STRING,
+ 'albumartist': types.STRING,
+ 'albumartist_sort': types.STRING,
'albumartist_credit': types.STRING,
- 'album': types.STRING,
- 'genre': types.STRING,
- 'year': types.PaddedInt(4),
- 'month': types.PaddedInt(2),
- 'day': types.PaddedInt(2),
- 'disctotal': types.PaddedInt(2),
- 'comp': types.BOOLEAN,
- 'mb_albumid': types.STRING,
- 'mb_albumartistid': types.STRING,
- 'albumtype': types.STRING,
- 'label': types.STRING,
- 'mb_releasegroupid': types.STRING,
- 'asin': types.STRING,
- 'catalognum': types.STRING,
- 'script': types.STRING,
- 'language': types.STRING,
- 'country': types.STRING,
- 'albumstatus': types.STRING,
- 'albumdisambig': types.STRING,
- 'rg_album_gain': types.NULL_FLOAT,
- 'rg_album_peak': types.NULL_FLOAT,
- 'original_year': types.PaddedInt(4),
- 'original_month': types.PaddedInt(2),
- 'original_day': types.PaddedInt(2),
+ 'album': types.STRING,
+ 'genre': types.STRING,
+ 'style': types.STRING,
+ 'discogs_albumid': types.INTEGER,
+ 'discogs_artistid': types.INTEGER,
+ 'discogs_labelid': types.INTEGER,
+ 'year': types.PaddedInt(4),
+ 'month': types.PaddedInt(2),
+ 'day': types.PaddedInt(2),
+ 'disctotal': types.PaddedInt(2),
+ 'comp': types.BOOLEAN,
+ 'mb_albumid': types.STRING,
+ 'mb_albumartistid': types.STRING,
+ 'albumtype': types.STRING,
+ 'albumtypes': types.STRING,
+ 'label': types.STRING,
+ 'mb_releasegroupid': types.STRING,
+ 'asin': types.STRING,
+ 'catalognum': types.STRING,
+ 'script': types.STRING,
+ 'language': types.STRING,
+ 'country': types.STRING,
+ 'albumstatus': types.STRING,
+ 'albumdisambig': types.STRING,
+ 'releasegroupdisambig': types.STRING,
+ 'rg_album_gain': types.NULL_FLOAT,
+ 'rg_album_peak': types.NULL_FLOAT,
+ 'r128_album_gain': types.NullPaddedInt(6),
+ 'original_year': types.PaddedInt(4),
+ 'original_month': types.PaddedInt(2),
+ 'original_day': types.PaddedInt(2),
}
_search_fields = ('album', 'albumartist', 'genre')
_types = {
- 'path': PathType(),
+ 'path': PathType(),
'data_source': types.STRING,
}
@@ -921,6 +1083,10 @@ class Album(LibModel):
'albumartist_credit',
'album',
'genre',
+ 'style',
+ 'discogs_albumid',
+ 'discogs_artistid',
+ 'discogs_labelid',
'year',
'month',
'day',
@@ -929,6 +1095,7 @@ class Album(LibModel):
'mb_albumid',
'mb_albumartistid',
'albumtype',
+ 'albumtypes',
'label',
'mb_releasegroupid',
'asin',
@@ -938,8 +1105,10 @@ class Album(LibModel):
'country',
'albumstatus',
'albumdisambig',
+ 'releasegroupdisambig',
'rg_album_gain',
'rg_album_peak',
+ 'r128_album_gain',
'original_year',
'original_month',
'original_day',
@@ -971,7 +1140,10 @@ class Album(LibModel):
containing the album are also removed (recursively) if empty.
Set with_items to False to avoid removing the album's items.
"""
- super(Album, self).remove()
+ super().remove()
+
+ # Send a 'album_removed' signal to plugins
+ plugins.send('album_removed', album=self)
# Delete art file.
if delete:
@@ -984,45 +1156,60 @@ class Album(LibModel):
for item in self.items():
item.remove(delete, False)
- def move_art(self, copy=False, link=False, hardlink=False):
- """Move or copy any existing album art so that it remains in the
- same directory as the items.
+ def move_art(self, operation=MoveOperation.MOVE):
+ """Move, copy, link or hardlink (depending on `operation`) any
+ existing album art so that it remains in the same directory as
+ the items.
+
+ `operation` should be an instance of `util.MoveOperation`.
"""
old_art = self.artpath
if not old_art:
return
+ if not os.path.exists(old_art):
+ log.error('removing reference to missing album art file {}',
+ util.displayable_path(old_art))
+ self.artpath = None
+ return
+
new_art = self.art_destination(old_art)
if new_art == old_art:
return
new_art = util.unique_path(new_art)
- log.debug(u'moving album art {0} to {1}',
+ log.debug('moving album art {0} to {1}',
util.displayable_path(old_art),
util.displayable_path(new_art))
- if copy:
- util.copy(old_art, new_art)
- elif link:
- util.link(old_art, new_art)
- elif hardlink:
- util.hardlink(old_art, new_art)
- else:
+ if operation == MoveOperation.MOVE:
util.move(old_art, new_art)
+ util.prune_dirs(os.path.dirname(old_art), self._db.directory)
+ elif operation == MoveOperation.COPY:
+ util.copy(old_art, new_art)
+ elif operation == MoveOperation.LINK:
+ util.link(old_art, new_art)
+ elif operation == MoveOperation.HARDLINK:
+ util.hardlink(old_art, new_art)
+ elif operation == MoveOperation.REFLINK:
+ util.reflink(old_art, new_art, fallback=False)
+ elif operation == MoveOperation.REFLINK_AUTO:
+ util.reflink(old_art, new_art, fallback=True)
+ else:
+ assert False, 'unknown MoveOperation'
self.artpath = new_art
- # Prune old path when moving.
- if not copy:
- util.prune_dirs(os.path.dirname(old_art),
- self._db.directory)
+ def move(self, operation=MoveOperation.MOVE, basedir=None, store=True):
+ """Move, copy, link or hardlink (depending on `operation`)
+ all items to their destination. Any album art moves along with them.
- def move(self, copy=False, link=False, hardlink=False, basedir=None,
- store=True):
- """Moves (or copies) all items to their destination. Any album
- art moves along with them. basedir overrides the library base
- directory for the destination. By default, the album is stored to the
- database, persisting any modifications to its metadata. If `store` is
- true however, the album is not stored automatically, and you'll have
- to manually store it after invoking this method.
+ `basedir` overrides the library base directory for the destination.
+
+ `operation` should be an instance of `util.MoveOperation`.
+
+ By default, the album is stored to the database, persisting any
+ modifications to its metadata. If `store` is `False` however,
+ the album is not stored automatically, and you'll have to manually
+ store it after invoking this method.
"""
basedir = basedir or self._db.directory
@@ -1034,11 +1221,11 @@ class Album(LibModel):
# Move items.
items = list(self.items())
for item in items:
- item.move(copy, link, hardlink, basedir=basedir, with_album=False,
+ item.move(operation, basedir=basedir, with_album=False,
store=store)
# Move art.
- self.move_art(copy, link, hardlink)
+ self.move_art(operation)
if store:
self.store()
@@ -1048,7 +1235,7 @@ class Album(LibModel):
"""
item = self.items().get()
if not item:
- raise ValueError(u'empty album')
+ raise ValueError('empty album for album id %d' % self.id)
return os.path.dirname(item.path)
def _albumtotal(self):
@@ -1084,7 +1271,7 @@ class Album(LibModel):
image = bytestring_path(image)
item_dir = item_dir or self.item_dir()
- filename_tmpl = Template(
+ filename_tmpl = template(
beets.config['art_filename'].as_str())
subpath = self.evaluate_template(filename_tmpl, True)
if beets.config['asciify_paths']:
@@ -1145,7 +1332,7 @@ class Album(LibModel):
track_updates[key] = self[key]
with self._db.transaction():
- super(Album, self).store(fields)
+ super().store(fields)
if track_updates:
for item in self.items():
for key, value in track_updates.items():
@@ -1189,8 +1376,10 @@ def parse_query_parts(parts, model_cls):
else:
non_path_parts.append(s)
+ case_insensitive = beets.config['sort_case_insensitive'].get(bool)
+
query, sort = dbcore.parse_sorted_query(
- model_cls, non_path_parts, prefixes
+ model_cls, non_path_parts, prefixes, case_insensitive
)
# Add path queries to aggregate query.
@@ -1208,10 +1397,10 @@ def parse_query_string(s, model_cls):
The string is split into components using shell-like syntax.
"""
- message = u"Query is not unicode: {0!r}".format(s)
- assert isinstance(s, six.text_type), message
+ message = f"Query is not unicode: {s!r}"
+ assert isinstance(s, str), message
try:
- parts = util.shlex_split(s)
+ parts = shlex.split(s)
except ValueError as exc:
raise dbcore.InvalidQueryError(s, exc)
return parse_query_parts(parts, model_cls)
@@ -1224,10 +1413,7 @@ def _sqlite_bytelower(bytestring):
``-DSQLITE_LIKE_DOESNT_MATCH_BLOBS``. See
``https://github.com/beetbox/beets/issues/2172`` for details.
"""
- if not six.PY2:
- return bytestring.lower()
-
- return buffer(bytes(bytestring).lower()) # noqa: F821
+ return bytestring.lower()
# The Library: interface to the database.
@@ -1243,7 +1429,7 @@ class Library(dbcore.Database):
'$artist/$album/$track $title'),),
replacements=None):
timeout = beets.config['timeout'].as_number()
- super(Library, self).__init__(path, timeout=timeout)
+ super().__init__(path, timeout=timeout)
self.directory = bytestring_path(normpath(directory))
self.path_formats = path_formats
@@ -1252,7 +1438,7 @@ class Library(dbcore.Database):
self._memotable = {} # Used for template substitution performance.
def _create_connection(self):
- conn = super(Library, self)._create_connection()
+ conn = super()._create_connection()
conn.create_function('bytelower', 1, _sqlite_bytelower)
return conn
@@ -1274,10 +1460,10 @@ class Library(dbcore.Database):
be empty.
"""
if not items:
- raise ValueError(u'need at least one item')
+ raise ValueError('need at least one item')
# Create the album structure using metadata from the first item.
- values = dict((key, items[0][key]) for key in Album.item_keys)
+ values = {key: items[0][key] for key in Album.item_keys}
album = Album(self, **values)
# Add the album structure and set the items' album_id fields.
@@ -1302,11 +1488,11 @@ class Library(dbcore.Database):
# Parse the query, if necessary.
try:
parsed_sort = None
- if isinstance(query, six.string_types):
+ if isinstance(query, str):
query, parsed_sort = parse_query_string(query, model_cls)
elif isinstance(query, (list, tuple)):
query, parsed_sort = parse_query_parts(query, model_cls)
- except dbcore.query.InvalidQueryArgumentTypeError as exc:
+ except dbcore.query.InvalidQueryArgumentValueError as exc:
raise dbcore.InvalidQueryError(query, exc)
# Any non-null sort specified by the parsed query overrides the
@@ -1314,7 +1500,7 @@ class Library(dbcore.Database):
if parsed_sort and not isinstance(parsed_sort, dbcore.query.NullSort):
sort = parsed_sort
- return super(Library, self)._fetch(
+ return super()._fetch(
model_cls, query, sort
)
@@ -1373,7 +1559,7 @@ def _int_arg(s):
return int(s.strip())
-class DefaultTemplateFunctions(object):
+class DefaultTemplateFunctions:
"""A container class for the default functions provided to path
templates. These functions are contained in an object to provide
additional context to the functions -- specifically, the Item being
@@ -1412,7 +1598,7 @@ class DefaultTemplateFunctions(object):
@staticmethod
def tmpl_title(s):
"""Convert a string to title case."""
- return s.title()
+ return string.capwords(s)
@staticmethod
def tmpl_left(s, chars):
@@ -1425,7 +1611,7 @@ class DefaultTemplateFunctions(object):
return s[-_int_arg(chars):]
@staticmethod
- def tmpl_if(condition, trueval, falseval=u''):
+ def tmpl_if(condition, trueval, falseval=''):
"""If ``condition`` is nonempty and nonzero, emit ``trueval``;
otherwise, emit ``falseval`` (if provided).
"""
@@ -1467,18 +1653,25 @@ class DefaultTemplateFunctions(object):
"""
# Fast paths: no album, no item or library, or memoized value.
if not self.item or not self.lib:
- return u''
- if self.item.album_id is None:
- return u''
- memokey = ('aunique', keys, disam, self.item.album_id)
+ return ''
+
+ if isinstance(self.item, Item):
+ album_id = self.item.album_id
+ elif isinstance(self.item, Album):
+ album_id = self.item.id
+
+ if album_id is None:
+ return ''
+
+ memokey = ('aunique', keys, disam, album_id)
memoval = self.lib._memotable.get(memokey)
if memoval is not None:
return memoval
- keys = keys or 'albumartist album'
- disam = disam or 'albumtype year label catalognum albumdisambig'
+ keys = keys or beets.config['aunique']['keys'].as_str()
+ disam = disam or beets.config['aunique']['disambiguators'].as_str()
if bracket is None:
- bracket = '[]'
+ bracket = beets.config['aunique']['bracket'].as_str()
keys = keys.split()
disam = disam.split()
@@ -1487,32 +1680,34 @@ class DefaultTemplateFunctions(object):
bracket_l = bracket[0]
bracket_r = bracket[1]
else:
- bracket_l = u''
- bracket_r = u''
+ bracket_l = ''
+ bracket_r = ''
- album = self.lib.get_album(self.item)
+ album = self.lib.get_album(album_id)
if not album:
# Do nothing for singletons.
- self.lib._memotable[memokey] = u''
- return u''
+ self.lib._memotable[memokey] = ''
+ return ''
# Find matching albums to disambiguate with.
subqueries = []
for key in keys:
value = album.get(key, '')
- subqueries.append(dbcore.MatchQuery(key, value))
+ # Use slow queries for flexible attributes.
+ fast = key in album.item_keys
+ subqueries.append(dbcore.MatchQuery(key, value, fast))
albums = self.lib.albums(dbcore.AndQuery(subqueries))
# If there's only one album to matching these details, then do
# nothing.
if len(albums) == 1:
- self.lib._memotable[memokey] = u''
- return u''
+ self.lib._memotable[memokey] = ''
+ return ''
# Find the first disambiguator that distinguishes the albums.
for disambiguator in disam:
# Get the value for each album for the current field.
- disam_values = set([a.get(disambiguator, '') for a in albums])
+ disam_values = {a.get(disambiguator, '') for a in albums}
# If the set of unique values is equal to the number of
# albums in the disambiguation set, we're done -- this is
@@ -1522,24 +1717,24 @@ class DefaultTemplateFunctions(object):
else:
# No disambiguator distinguished all fields.
- res = u' {1}{0}{2}'.format(album.id, bracket_l, bracket_r)
+ res = f' {bracket_l}{album.id}{bracket_r}'
self.lib._memotable[memokey] = res
return res
# Flatten disambiguation value into a string.
- disam_value = album.formatted(True).get(disambiguator)
+ disam_value = album.formatted(for_path=True).get(disambiguator)
# Return empty string if disambiguator is empty.
if disam_value:
- res = u' {1}{0}{2}'.format(disam_value, bracket_l, bracket_r)
+ res = f' {bracket_l}{disam_value}{bracket_r}'
else:
- res = u''
+ res = ''
self.lib._memotable[memokey] = res
return res
@staticmethod
- def tmpl_first(s, count=1, skip=0, sep=u'; ', join_str=u'; '):
+ def tmpl_first(s, count=1, skip=0, sep='; ', join_str='; '):
""" Gets the item(s) from x to y in a string separated by something
and join then with something
@@ -1553,7 +1748,7 @@ class DefaultTemplateFunctions(object):
count = skip + int(count)
return join_str.join(s.split(sep)[skip:count])
- def tmpl_ifdef(self, field, trueval=u'', falseval=u''):
+ def tmpl_ifdef(self, field, trueval='', falseval=''):
""" If field exists return trueval or the field (default)
otherwise, emit return falseval (if provided).
@@ -1562,7 +1757,7 @@ class DefaultTemplateFunctions(object):
:param falseval: The string if the condition is false
:return: The string, based on condition
"""
- if self.item.formatted().get(field):
+ if field in self.item:
return trueval if trueval else self.item.formatted().get(field)
else:
return falseval
diff --git a/lib/beets/logging.py b/lib/beets/logging.py
old mode 100755
new mode 100644
index d5ec7b73..4f004f8d
--- a/lib/beets/logging.py
+++ b/lib/beets/logging.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
# This file is part of beets.
# Copyright 2016, Adrian Sampson.
#
@@ -21,13 +20,11 @@ that when getLogger(name) instantiates a logger that logger uses
{}-style formatting.
"""
-from __future__ import division, absolute_import, print_function
from copy import copy
from logging import * # noqa
import subprocess
import threading
-import six
def logsafe(val):
@@ -43,7 +40,7 @@ def logsafe(val):
example.
"""
# Already Unicode.
- if isinstance(val, six.text_type):
+ if isinstance(val, str):
return val
# Bytestring: needs decoding.
@@ -57,7 +54,7 @@ def logsafe(val):
# A "problem" object: needs a workaround.
elif isinstance(val, subprocess.CalledProcessError):
try:
- return six.text_type(val)
+ return str(val)
except UnicodeDecodeError:
# An object with a broken __unicode__ formatter. Use __str__
# instead.
@@ -74,7 +71,7 @@ class StrFormatLogger(Logger):
instead of %-style formatting.
"""
- class _LogMessage(object):
+ class _LogMessage:
def __init__(self, msg, args, kwargs):
self.msg = msg
self.args = args
@@ -82,22 +79,23 @@ class StrFormatLogger(Logger):
def __str__(self):
args = [logsafe(a) for a in self.args]
- kwargs = dict((k, logsafe(v)) for (k, v) in self.kwargs.items())
+ kwargs = {k: logsafe(v) for (k, v) in self.kwargs.items()}
return self.msg.format(*args, **kwargs)
def _log(self, level, msg, args, exc_info=None, extra=None, **kwargs):
"""Log msg.format(*args, **kwargs)"""
m = self._LogMessage(msg, args, kwargs)
- return super(StrFormatLogger, self)._log(level, m, (), exc_info, extra)
+ return super()._log(level, m, (), exc_info, extra)
class ThreadLocalLevelLogger(Logger):
"""A version of `Logger` whose level is thread-local instead of shared.
"""
+
def __init__(self, name, level=NOTSET):
self._thread_level = threading.local()
self.default_level = NOTSET
- super(ThreadLocalLevelLogger, self).__init__(name, level)
+ super().__init__(name, level)
@property
def level(self):
diff --git a/lib/beets/mediafile.py b/lib/beets/mediafile.py
old mode 100755
new mode 100644
index 13f1b2df..82bcc973
--- a/lib/beets/mediafile.py
+++ b/lib/beets/mediafile.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
# This file is part of beets.
# Copyright 2016, Adrian Sampson.
#
@@ -13,2053 +12,15 @@
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
-"""Handles low-level interfacing for files' tags. Wraps Mutagen to
-automatically detect file types and provide a unified interface for a
-useful subset of music files' tags.
-Usage:
+import mediafile
- >>> f = MediaFile('Lucy.mp3')
- >>> f.title
- u'Lucy in the Sky with Diamonds'
- >>> f.artist = 'The Beatles'
- >>> f.save()
+import warnings
+warnings.warn("beets.mediafile is deprecated; use mediafile instead")
-A field will always return a reasonable value of the correct type, even
-if no tag is present. If no value is available, the value will be false
-(e.g., zero or the empty string).
+# Import everything from the mediafile module into this module.
+for key, value in mediafile.__dict__.items():
+ if key not in ['__name__']:
+ globals()[key] = value
-Internally ``MediaFile`` uses ``MediaField`` descriptors to access the
-data from the tags. In turn ``MediaField`` uses a number of
-``StorageStyle`` strategies to handle format specific logic.
-"""
-from __future__ import division, absolute_import, print_function
-
-import mutagen
-import mutagen.id3
-import mutagen.mp4
-import mutagen.flac
-import mutagen.asf
-
-import codecs
-import datetime
-import re
-import base64
-import binascii
-import math
-import struct
-import imghdr
-import os
-import traceback
-import enum
-import logging
-import six
-
-
-__all__ = ['UnreadableFileError', 'FileTypeError', 'MediaFile']
-
-log = logging.getLogger(__name__)
-
-# Human-readable type names.
-TYPES = {
- 'mp3': 'MP3',
- 'aac': 'AAC',
- 'alac': 'ALAC',
- 'ogg': 'OGG',
- 'opus': 'Opus',
- 'flac': 'FLAC',
- 'ape': 'APE',
- 'wv': 'WavPack',
- 'mpc': 'Musepack',
- 'asf': 'Windows Media',
- 'aiff': 'AIFF',
- 'dsf': 'DSD Stream File',
-}
-
-PREFERRED_IMAGE_EXTENSIONS = {'jpeg': 'jpg'}
-
-
-# Exceptions.
-
-class UnreadableFileError(Exception):
- """Mutagen is not able to extract information from the file.
- """
- def __init__(self, path, msg):
- Exception.__init__(self, msg if msg else repr(path))
-
-
-class FileTypeError(UnreadableFileError):
- """Reading this type of file is not supported.
-
- If passed the `mutagen_type` argument this indicates that the
- mutagen type is not supported by `Mediafile`.
- """
- def __init__(self, path, mutagen_type=None):
- if mutagen_type is None:
- msg = repr(path)
- else:
- msg = u'{0}: of mutagen type {1}'.format(repr(path), mutagen_type)
- Exception.__init__(self, msg)
-
-
-class MutagenError(UnreadableFileError):
- """Raised when Mutagen fails unexpectedly---probably due to a bug.
- """
- def __init__(self, path, mutagen_exc):
- msg = u'{0}: {1}'.format(repr(path), mutagen_exc)
- Exception.__init__(self, msg)
-
-
-# Interacting with Mutagen.
-
-def mutagen_call(action, path, func, *args, **kwargs):
- """Call a Mutagen function with appropriate error handling.
-
- `action` is a string describing what the function is trying to do,
- and `path` is the relevant filename. The rest of the arguments
- describe the callable to invoke.
-
- We require at least Mutagen 1.33, where `IOError` is *never* used,
- neither for internal parsing errors *nor* for ordinary IO error
- conditions such as a bad filename. Mutagen-specific parsing errors and IO
- errors are reraised as `UnreadableFileError`. Other exceptions
- raised inside Mutagen---i.e., bugs---are reraised as `MutagenError`.
- """
- try:
- return func(*args, **kwargs)
- except mutagen.MutagenError as exc:
- log.debug(u'%s failed: %s', action, six.text_type(exc))
- raise UnreadableFileError(path, six.text_type(exc))
- except Exception as exc:
- # Isolate bugs in Mutagen.
- log.debug(u'%s', traceback.format_exc())
- log.error(u'uncaught Mutagen exception in %s: %s', action, exc)
- raise MutagenError(path, exc)
-
-
-# Utility.
-
-def _safe_cast(out_type, val):
- """Try to covert val to out_type but never raise an exception. If
- the value can't be converted, then a sensible default value is
- returned. out_type should be bool, int, or unicode; otherwise, the
- value is just passed through.
- """
- if val is None:
- return None
-
- if out_type == int:
- if isinstance(val, int) or isinstance(val, float):
- # Just a number.
- return int(val)
- else:
- # Process any other type as a string.
- if not isinstance(val, six.string_types):
- val = six.text_type(val)
- # Get a number from the front of the string.
- val = re.match(r'[0-9]*', val.strip()).group(0)
- if not val:
- return 0
- else:
- return int(val)
-
- elif out_type == bool:
- try:
- # Should work for strings, bools, ints:
- return bool(int(val))
- except ValueError:
- return False
-
- elif out_type == six.text_type:
- if isinstance(val, bytes):
- return val.decode('utf-8', 'ignore')
- elif isinstance(val, six.text_type):
- return val
- else:
- return six.text_type(val)
-
- elif out_type == float:
- if isinstance(val, int) or isinstance(val, float):
- return float(val)
- else:
- if isinstance(val, bytes):
- val = val.decode('utf-8', 'ignore')
- else:
- val = six.text_type(val)
- match = re.match(r'[\+-]?([0-9]+\.?[0-9]*|[0-9]*\.[0-9]+)',
- val.strip())
- if match:
- val = match.group(0)
- if val:
- return float(val)
- return 0.0
-
- else:
- return val
-
-
-# Image coding for ASF/WMA.
-
-def _unpack_asf_image(data):
- """Unpack image data from a WM/Picture tag. Return a tuple
- containing the MIME type, the raw image data, a type indicator, and
- the image's description.
-
- This function is treated as "untrusted" and could throw all manner
- of exceptions (out-of-bounds, etc.). We should clean this up
- sometime so that the failure modes are well-defined.
- """
- type, size = struct.unpack_from(' 0:
- gain = math.log10(maxgain / 1000.0) * -10
- else:
- # Invalid gain value found.
- gain = 0.0
-
- # SoundCheck stores peak values as the actual value of the sample,
- # and again separately for the left and right channels. We need to
- # convert this to a percentage of full scale, which is 32768 for a
- # 16 bit sample. Once again, we play it safe by using the larger of
- # the two values.
- peak = max(soundcheck[6:8]) / 32768.0
-
- return round(gain, 2), round(peak, 6)
-
-
-def _sc_encode(gain, peak):
- """Encode ReplayGain gain/peak values as a Sound Check string.
- """
- # SoundCheck stores the peak value as the actual value of the
- # sample, rather than the percentage of full scale that RG uses, so
- # we do a simple conversion assuming 16 bit samples.
- peak *= 32768.0
-
- # SoundCheck stores absolute RMS values in some unknown units rather
- # than the dB values RG uses. We can calculate these absolute values
- # from the gain ratio using a reference value of 1000 units. We also
- # enforce the maximum value here, which is equivalent to about
- # -18.2dB.
- g1 = int(min(round((10 ** (gain / -10)) * 1000), 65534))
- # Same as above, except our reference level is 2500 units.
- g2 = int(min(round((10 ** (gain / -10)) * 2500), 65534))
-
- # The purpose of these values are unknown, but they also seem to be
- # unused so we just use zero.
- uk = 0
- values = (g1, g1, g2, g2, uk, uk, int(peak), int(peak), uk, uk)
- return (u' %08X' * 10) % values
-
-
-# Cover art and other images.
-def _imghdr_what_wrapper(data):
- """A wrapper around imghdr.what to account for jpeg files that can only be
- identified as such using their magic bytes
- See #1545
- See https://github.com/file/file/blob/master/magic/Magdir/jpeg#L12
- """
- # imghdr.what returns none for jpegs with only the magic bytes, so
- # _wider_test_jpeg is run in that case. It still returns None if it didn't
- # match such a jpeg file.
- return imghdr.what(None, h=data) or _wider_test_jpeg(data)
-
-
-def _wider_test_jpeg(data):
- """Test for a jpeg file following the UNIX file implementation which
- uses the magic bytes rather than just looking for the bytes that
- represent 'JFIF' or 'EXIF' at a fixed position.
- """
- if data[:2] == b'\xff\xd8':
- return 'jpeg'
-
-
-def image_mime_type(data):
- """Return the MIME type of the image data (a bytestring).
- """
- # This checks for a jpeg file with only the magic bytes (unrecognized by
- # imghdr.what). imghdr.what returns none for that type of file, so
- # _wider_test_jpeg is run in that case. It still returns None if it didn't
- # match such a jpeg file.
- kind = _imghdr_what_wrapper(data)
- if kind in ['gif', 'jpeg', 'png', 'tiff', 'bmp']:
- return 'image/{0}'.format(kind)
- elif kind == 'pgm':
- return 'image/x-portable-graymap'
- elif kind == 'pbm':
- return 'image/x-portable-bitmap'
- elif kind == 'ppm':
- return 'image/x-portable-pixmap'
- elif kind == 'xbm':
- return 'image/x-xbitmap'
- else:
- return 'image/x-{0}'.format(kind)
-
-
-def image_extension(data):
- ext = _imghdr_what_wrapper(data)
- return PREFERRED_IMAGE_EXTENSIONS.get(ext, ext)
-
-
-class ImageType(enum.Enum):
- """Indicates the kind of an `Image` stored in a file's tag.
- """
- other = 0
- icon = 1
- other_icon = 2
- front = 3
- back = 4
- leaflet = 5
- media = 6
- lead_artist = 7
- artist = 8
- conductor = 9
- group = 10
- composer = 11
- lyricist = 12
- recording_location = 13
- recording_session = 14
- performance = 15
- screen_capture = 16
- fish = 17
- illustration = 18
- artist_logo = 19
- publisher_logo = 20
-
-
-class Image(object):
- """Structure representing image data and metadata that can be
- stored and retrieved from tags.
-
- The structure has four properties.
- * ``data`` The binary data of the image
- * ``desc`` An optional description of the image
- * ``type`` An instance of `ImageType` indicating the kind of image
- * ``mime_type`` Read-only property that contains the mime type of
- the binary data
- """
- def __init__(self, data, desc=None, type=None):
- assert isinstance(data, bytes)
- if desc is not None:
- assert isinstance(desc, six.text_type)
- self.data = data
- self.desc = desc
- if isinstance(type, int):
- try:
- type = list(ImageType)[type]
- except IndexError:
- log.debug(u"ignoring unknown image type index %s", type)
- type = ImageType.other
- self.type = type
-
- @property
- def mime_type(self):
- if self.data:
- return image_mime_type(self.data)
-
- @property
- def type_index(self):
- if self.type is None:
- # This method is used when a tag format requires the type
- # index to be set, so we return "other" as the default value.
- return 0
- return self.type.value
-
-
-# StorageStyle classes describe strategies for accessing values in
-# Mutagen file objects.
-
-class StorageStyle(object):
- """A strategy for storing a value for a certain tag format (or set
- of tag formats). This basic StorageStyle describes simple 1:1
- mapping from raw values to keys in a Mutagen file object; subclasses
- describe more sophisticated translations or format-specific access
- strategies.
-
- MediaFile uses a StorageStyle via three methods: ``get()``,
- ``set()``, and ``delete()``. It passes a Mutagen file object to
- each.
-
- Internally, the StorageStyle implements ``get()`` and ``set()``
- using two steps that may be overridden by subtypes. To get a value,
- the StorageStyle first calls ``fetch()`` to retrieve the value
- corresponding to a key and then ``deserialize()`` to convert the raw
- Mutagen value to a consumable Python value. Similarly, to set a
- field, we call ``serialize()`` to encode the value and then
- ``store()`` to assign the result into the Mutagen object.
-
- Each StorageStyle type has a class-level `formats` attribute that is
- a list of strings indicating the formats that the style applies to.
- MediaFile only uses StorageStyles that apply to the correct type for
- a given audio file.
- """
-
- formats = ['FLAC', 'OggOpus', 'OggTheora', 'OggSpeex', 'OggVorbis',
- 'OggFlac', 'APEv2File', 'WavPack', 'Musepack', 'MonkeysAudio']
- """List of mutagen classes the StorageStyle can handle.
- """
-
- def __init__(self, key, as_type=six.text_type, suffix=None,
- float_places=2):
- """Create a basic storage strategy. Parameters:
-
- - `key`: The key on the Mutagen file object used to access the
- field's data.
- - `as_type`: The Python type that the value is stored as
- internally (`unicode`, `int`, `bool`, or `bytes`).
- - `suffix`: When `as_type` is a string type, append this before
- storing the value.
- - `float_places`: When the value is a floating-point number and
- encoded as a string, the number of digits to store after the
- decimal point.
- """
- self.key = key
- self.as_type = as_type
- self.suffix = suffix
- self.float_places = float_places
-
- # Convert suffix to correct string type.
- if self.suffix and self.as_type is six.text_type \
- and not isinstance(self.suffix, six.text_type):
- self.suffix = self.suffix.decode('utf-8')
-
- # Getter.
-
- def get(self, mutagen_file):
- """Get the value for the field using this style.
- """
- return self.deserialize(self.fetch(mutagen_file))
-
- def fetch(self, mutagen_file):
- """Retrieve the raw value of for this tag from the Mutagen file
- object.
- """
- try:
- return mutagen_file[self.key][0]
- except (KeyError, IndexError):
- return None
-
- def deserialize(self, mutagen_value):
- """Given a raw value stored on a Mutagen object, decode and
- return the represented value.
- """
- if self.suffix and isinstance(mutagen_value, six.text_type) \
- and mutagen_value.endswith(self.suffix):
- return mutagen_value[:-len(self.suffix)]
- else:
- return mutagen_value
-
- # Setter.
-
- def set(self, mutagen_file, value):
- """Assign the value for the field using this style.
- """
- self.store(mutagen_file, self.serialize(value))
-
- def store(self, mutagen_file, value):
- """Store a serialized value in the Mutagen file object.
- """
- mutagen_file[self.key] = [value]
-
- def serialize(self, value):
- """Convert the external Python value to a type that is suitable for
- storing in a Mutagen file object.
- """
- if isinstance(value, float) and self.as_type is six.text_type:
- value = u'{0:.{1}f}'.format(value, self.float_places)
- value = self.as_type(value)
- elif self.as_type is six.text_type:
- if isinstance(value, bool):
- # Store bools as 1/0 instead of True/False.
- value = six.text_type(int(bool(value)))
- elif isinstance(value, bytes):
- value = value.decode('utf-8', 'ignore')
- else:
- value = six.text_type(value)
- else:
- value = self.as_type(value)
-
- if self.suffix:
- value += self.suffix
-
- return value
-
- def delete(self, mutagen_file):
- """Remove the tag from the file.
- """
- if self.key in mutagen_file:
- del mutagen_file[self.key]
-
-
-class ListStorageStyle(StorageStyle):
- """Abstract storage style that provides access to lists.
-
- The ListMediaField descriptor uses a ListStorageStyle via two
- methods: ``get_list()`` and ``set_list()``. It passes a Mutagen file
- object to each.
-
- Subclasses may overwrite ``fetch`` and ``store``. ``fetch`` must
- return a (possibly empty) list and ``store`` receives a serialized
- list of values as the second argument.
-
- The `serialize` and `deserialize` methods (from the base
- `StorageStyle`) are still called with individual values. This class
- handles packing and unpacking the values into lists.
- """
- def get(self, mutagen_file):
- """Get the first value in the field's value list.
- """
- try:
- return self.get_list(mutagen_file)[0]
- except IndexError:
- return None
-
- def get_list(self, mutagen_file):
- """Get a list of all values for the field using this style.
- """
- return [self.deserialize(item) for item in self.fetch(mutagen_file)]
-
- def fetch(self, mutagen_file):
- """Get the list of raw (serialized) values.
- """
- try:
- return mutagen_file[self.key]
- except KeyError:
- return []
-
- def set(self, mutagen_file, value):
- """Set an individual value as the only value for the field using
- this style.
- """
- self.set_list(mutagen_file, [value])
-
- def set_list(self, mutagen_file, values):
- """Set all values for the field using this style. `values`
- should be an iterable.
- """
- self.store(mutagen_file, [self.serialize(value) for value in values])
-
- def store(self, mutagen_file, values):
- """Set the list of all raw (serialized) values for this field.
- """
- mutagen_file[self.key] = values
-
-
-class SoundCheckStorageStyleMixin(object):
- """A mixin for storage styles that read and write iTunes SoundCheck
- analysis values. The object must have an `index` field that
- indicates which half of the gain/peak pair---0 or 1---the field
- represents.
- """
- def get(self, mutagen_file):
- data = self.fetch(mutagen_file)
- if data is not None:
- return _sc_decode(data)[self.index]
-
- def set(self, mutagen_file, value):
- data = self.fetch(mutagen_file)
- if data is None:
- gain_peak = [0, 0]
- else:
- gain_peak = list(_sc_decode(data))
- gain_peak[self.index] = value or 0
- data = self.serialize(_sc_encode(*gain_peak))
- self.store(mutagen_file, data)
-
-
-class ASFStorageStyle(ListStorageStyle):
- """A general storage style for Windows Media/ASF files.
- """
- formats = ['ASF']
-
- def deserialize(self, data):
- if isinstance(data, mutagen.asf.ASFBaseAttribute):
- data = data.value
- return data
-
-
-class MP4StorageStyle(StorageStyle):
- """A general storage style for MPEG-4 tags.
- """
- formats = ['MP4']
-
- def serialize(self, value):
- value = super(MP4StorageStyle, self).serialize(value)
- if self.key.startswith('----:') and isinstance(value, six.text_type):
- value = value.encode('utf-8')
- return value
-
-
-class MP4TupleStorageStyle(MP4StorageStyle):
- """A style for storing values as part of a pair of numbers in an
- MPEG-4 file.
- """
- def __init__(self, key, index=0, **kwargs):
- super(MP4TupleStorageStyle, self).__init__(key, **kwargs)
- self.index = index
-
- def deserialize(self, mutagen_value):
- items = mutagen_value or []
- packing_length = 2
- return list(items) + [0] * (packing_length - len(items))
-
- def get(self, mutagen_file):
- value = super(MP4TupleStorageStyle, self).get(mutagen_file)[self.index]
- if value == 0:
- # The values are always present and saved as integers. So we
- # assume that "0" indicates it is not set.
- return None
- else:
- return value
-
- def set(self, mutagen_file, value):
- if value is None:
- value = 0
- items = self.deserialize(self.fetch(mutagen_file))
- items[self.index] = int(value)
- self.store(mutagen_file, items)
-
- def delete(self, mutagen_file):
- if self.index == 0:
- super(MP4TupleStorageStyle, self).delete(mutagen_file)
- else:
- self.set(mutagen_file, None)
-
-
-class MP4ListStorageStyle(ListStorageStyle, MP4StorageStyle):
- pass
-
-
-class MP4SoundCheckStorageStyle(SoundCheckStorageStyleMixin, MP4StorageStyle):
- def __init__(self, key, index=0, **kwargs):
- super(MP4SoundCheckStorageStyle, self).__init__(key, **kwargs)
- self.index = index
-
-
-class MP4BoolStorageStyle(MP4StorageStyle):
- """A style for booleans in MPEG-4 files. (MPEG-4 has an atom type
- specifically for representing booleans.)
- """
- def get(self, mutagen_file):
- try:
- return mutagen_file[self.key]
- except KeyError:
- return None
-
- def get_list(self, mutagen_file):
- raise NotImplementedError(u'MP4 bool storage does not support lists')
-
- def set(self, mutagen_file, value):
- mutagen_file[self.key] = value
-
- def set_list(self, mutagen_file, values):
- raise NotImplementedError(u'MP4 bool storage does not support lists')
-
-
-class MP4ImageStorageStyle(MP4ListStorageStyle):
- """Store images as MPEG-4 image atoms. Values are `Image` objects.
- """
- def __init__(self, **kwargs):
- super(MP4ImageStorageStyle, self).__init__(key='covr', **kwargs)
-
- def deserialize(self, data):
- return Image(data)
-
- def serialize(self, image):
- if image.mime_type == 'image/png':
- kind = mutagen.mp4.MP4Cover.FORMAT_PNG
- elif image.mime_type == 'image/jpeg':
- kind = mutagen.mp4.MP4Cover.FORMAT_JPEG
- else:
- raise ValueError(u'MP4 files only supports PNG and JPEG images')
- return mutagen.mp4.MP4Cover(image.data, kind)
-
-
-class MP3StorageStyle(StorageStyle):
- """Store data in ID3 frames.
- """
- formats = ['MP3', 'AIFF', 'DSF']
-
- def __init__(self, key, id3_lang=None, **kwargs):
- """Create a new ID3 storage style. `id3_lang` is the value for
- the language field of newly created frames.
- """
- self.id3_lang = id3_lang
- super(MP3StorageStyle, self).__init__(key, **kwargs)
-
- def fetch(self, mutagen_file):
- try:
- return mutagen_file[self.key].text[0]
- except (KeyError, IndexError):
- return None
-
- def store(self, mutagen_file, value):
- frame = mutagen.id3.Frames[self.key](encoding=3, text=[value])
- mutagen_file.tags.setall(self.key, [frame])
-
-
-class MP3PeopleStorageStyle(MP3StorageStyle):
- """Store list of people in ID3 frames.
- """
- def __init__(self, key, involvement='', **kwargs):
- self.involvement = involvement
- super(MP3PeopleStorageStyle, self).__init__(key, **kwargs)
-
- def store(self, mutagen_file, value):
- frames = mutagen_file.tags.getall(self.key)
-
- # Try modifying in place.
- found = False
- for frame in frames:
- if frame.encoding == mutagen.id3.Encoding.UTF8:
- for pair in frame.people:
- if pair[0].lower() == self.involvement.lower():
- pair[1] = value
- found = True
-
- # Try creating a new frame.
- if not found:
- frame = mutagen.id3.Frames[self.key](
- encoding=mutagen.id3.Encoding.UTF8,
- people=[[self.involvement, value]]
- )
- mutagen_file.tags.add(frame)
-
- def fetch(self, mutagen_file):
- for frame in mutagen_file.tags.getall(self.key):
- for pair in frame.people:
- if pair[0].lower() == self.involvement.lower():
- try:
- return pair[1]
- except IndexError:
- return None
-
-
-class MP3ListStorageStyle(ListStorageStyle, MP3StorageStyle):
- """Store lists of data in multiple ID3 frames.
- """
- def fetch(self, mutagen_file):
- try:
- return mutagen_file[self.key].text
- except KeyError:
- return []
-
- def store(self, mutagen_file, values):
- frame = mutagen.id3.Frames[self.key](encoding=3, text=values)
- mutagen_file.tags.setall(self.key, [frame])
-
-
-class MP3UFIDStorageStyle(MP3StorageStyle):
- """Store string data in a UFID ID3 frame with a particular owner.
- """
- def __init__(self, owner, **kwargs):
- self.owner = owner
- super(MP3UFIDStorageStyle, self).__init__('UFID:' + owner, **kwargs)
-
- def fetch(self, mutagen_file):
- try:
- return mutagen_file[self.key].data
- except KeyError:
- return None
-
- def store(self, mutagen_file, value):
- # This field type stores text data as encoded data.
- assert isinstance(value, six.text_type)
- value = value.encode('utf-8')
-
- frames = mutagen_file.tags.getall(self.key)
- for frame in frames:
- # Replace existing frame data.
- if frame.owner == self.owner:
- frame.data = value
- else:
- # New frame.
- frame = mutagen.id3.UFID(owner=self.owner, data=value)
- mutagen_file.tags.setall(self.key, [frame])
-
-
-class MP3DescStorageStyle(MP3StorageStyle):
- """Store data in a TXXX (or similar) ID3 frame. The frame is
- selected based its ``desc`` field.
- """
- def __init__(self, desc=u'', key='TXXX', **kwargs):
- assert isinstance(desc, six.text_type)
- self.description = desc
- super(MP3DescStorageStyle, self).__init__(key=key, **kwargs)
-
- def store(self, mutagen_file, value):
- frames = mutagen_file.tags.getall(self.key)
- if self.key != 'USLT':
- value = [value]
-
- # Try modifying in place.
- found = False
- for frame in frames:
- if frame.desc.lower() == self.description.lower():
- frame.text = value
- frame.encoding = mutagen.id3.Encoding.UTF8
- found = True
-
- # Try creating a new frame.
- if not found:
- frame = mutagen.id3.Frames[self.key](
- desc=self.description,
- text=value,
- encoding=mutagen.id3.Encoding.UTF8,
- )
- if self.id3_lang:
- frame.lang = self.id3_lang
- mutagen_file.tags.add(frame)
-
- def fetch(self, mutagen_file):
- for frame in mutagen_file.tags.getall(self.key):
- if frame.desc.lower() == self.description.lower():
- if self.key == 'USLT':
- return frame.text
- try:
- return frame.text[0]
- except IndexError:
- return None
-
- def delete(self, mutagen_file):
- found_frame = None
- for frame in mutagen_file.tags.getall(self.key):
- if frame.desc.lower() == self.description.lower():
- found_frame = frame
- break
- if found_frame is not None:
- del mutagen_file[frame.HashKey]
-
-
-class MP3SlashPackStorageStyle(MP3StorageStyle):
- """Store value as part of pair that is serialized as a slash-
- separated string.
- """
- def __init__(self, key, pack_pos=0, **kwargs):
- super(MP3SlashPackStorageStyle, self).__init__(key, **kwargs)
- self.pack_pos = pack_pos
-
- def _fetch_unpacked(self, mutagen_file):
- data = self.fetch(mutagen_file)
- if data:
- items = six.text_type(data).split('/')
- else:
- items = []
- packing_length = 2
- return list(items) + [None] * (packing_length - len(items))
-
- def get(self, mutagen_file):
- return self._fetch_unpacked(mutagen_file)[self.pack_pos]
-
- def set(self, mutagen_file, value):
- items = self._fetch_unpacked(mutagen_file)
- items[self.pack_pos] = value
- if items[0] is None:
- items[0] = ''
- if items[1] is None:
- items.pop() # Do not store last value
- self.store(mutagen_file, '/'.join(map(six.text_type, items)))
-
- def delete(self, mutagen_file):
- if self.pack_pos == 0:
- super(MP3SlashPackStorageStyle, self).delete(mutagen_file)
- else:
- self.set(mutagen_file, None)
-
-
-class MP3ImageStorageStyle(ListStorageStyle, MP3StorageStyle):
- """Converts between APIC frames and ``Image`` instances.
-
- The `get_list` method inherited from ``ListStorageStyle`` returns a
- list of ``Image``s. Similarly, the `set_list` method accepts a
- list of ``Image``s as its ``values`` argument.
- """
- def __init__(self):
- super(MP3ImageStorageStyle, self).__init__(key='APIC')
- self.as_type = bytes
-
- def deserialize(self, apic_frame):
- """Convert APIC frame into Image."""
- return Image(data=apic_frame.data, desc=apic_frame.desc,
- type=apic_frame.type)
-
- def fetch(self, mutagen_file):
- return mutagen_file.tags.getall(self.key)
-
- def store(self, mutagen_file, frames):
- mutagen_file.tags.setall(self.key, frames)
-
- def delete(self, mutagen_file):
- mutagen_file.tags.delall(self.key)
-
- def serialize(self, image):
- """Return an APIC frame populated with data from ``image``.
- """
- assert isinstance(image, Image)
- frame = mutagen.id3.Frames[self.key]()
- frame.data = image.data
- frame.mime = image.mime_type
- frame.desc = image.desc or u''
-
- # For compatibility with OS X/iTunes prefer latin-1 if possible.
- # See issue #899
- try:
- frame.desc.encode("latin-1")
- except UnicodeEncodeError:
- frame.encoding = mutagen.id3.Encoding.UTF16
- else:
- frame.encoding = mutagen.id3.Encoding.LATIN1
-
- frame.type = image.type_index
- return frame
-
-
-class MP3SoundCheckStorageStyle(SoundCheckStorageStyleMixin,
- MP3DescStorageStyle):
- def __init__(self, index=0, **kwargs):
- super(MP3SoundCheckStorageStyle, self).__init__(**kwargs)
- self.index = index
-
-
-class ASFImageStorageStyle(ListStorageStyle):
- """Store images packed into Windows Media/ASF byte array attributes.
- Values are `Image` objects.
- """
- formats = ['ASF']
-
- def __init__(self):
- super(ASFImageStorageStyle, self).__init__(key='WM/Picture')
-
- def deserialize(self, asf_picture):
- mime, data, type, desc = _unpack_asf_image(asf_picture.value)
- return Image(data, desc=desc, type=type)
-
- def serialize(self, image):
- pic = mutagen.asf.ASFByteArrayAttribute()
- pic.value = _pack_asf_image(image.mime_type, image.data,
- type=image.type_index,
- description=image.desc or u'')
- return pic
-
-
-class VorbisImageStorageStyle(ListStorageStyle):
- """Store images in Vorbis comments. Both legacy COVERART fields and
- modern METADATA_BLOCK_PICTURE tags are supported. Data is
- base64-encoded. Values are `Image` objects.
- """
- formats = ['OggOpus', 'OggTheora', 'OggSpeex', 'OggVorbis',
- 'OggFlac']
-
- def __init__(self):
- super(VorbisImageStorageStyle, self).__init__(
- key='metadata_block_picture'
- )
- self.as_type = bytes
-
- def fetch(self, mutagen_file):
- images = []
- if 'metadata_block_picture' not in mutagen_file:
- # Try legacy COVERART tags.
- if 'coverart' in mutagen_file:
- for data in mutagen_file['coverart']:
- images.append(Image(base64.b64decode(data)))
- return images
- for data in mutagen_file["metadata_block_picture"]:
- try:
- pic = mutagen.flac.Picture(base64.b64decode(data))
- except (TypeError, AttributeError):
- continue
- images.append(Image(data=pic.data, desc=pic.desc,
- type=pic.type))
- return images
-
- def store(self, mutagen_file, image_data):
- # Strip all art, including legacy COVERART.
- if 'coverart' in mutagen_file:
- del mutagen_file['coverart']
- if 'coverartmime' in mutagen_file:
- del mutagen_file['coverartmime']
- super(VorbisImageStorageStyle, self).store(mutagen_file, image_data)
-
- def serialize(self, image):
- """Turn a Image into a base64 encoded FLAC picture block.
- """
- pic = mutagen.flac.Picture()
- pic.data = image.data
- pic.type = image.type_index
- pic.mime = image.mime_type
- pic.desc = image.desc or u''
-
- # Encoding with base64 returns bytes on both Python 2 and 3.
- # Mutagen requires the data to be a Unicode string, so we decode
- # it before passing it along.
- return base64.b64encode(pic.write()).decode('ascii')
-
-
-class FlacImageStorageStyle(ListStorageStyle):
- """Converts between ``mutagen.flac.Picture`` and ``Image`` instances.
- """
- formats = ['FLAC']
-
- def __init__(self):
- super(FlacImageStorageStyle, self).__init__(key='')
-
- def fetch(self, mutagen_file):
- return mutagen_file.pictures
-
- def deserialize(self, flac_picture):
- return Image(data=flac_picture.data, desc=flac_picture.desc,
- type=flac_picture.type)
-
- def store(self, mutagen_file, pictures):
- """``pictures`` is a list of mutagen.flac.Picture instances.
- """
- mutagen_file.clear_pictures()
- for pic in pictures:
- mutagen_file.add_picture(pic)
-
- def serialize(self, image):
- """Turn a Image into a mutagen.flac.Picture.
- """
- pic = mutagen.flac.Picture()
- pic.data = image.data
- pic.type = image.type_index
- pic.mime = image.mime_type
- pic.desc = image.desc or u''
- return pic
-
- def delete(self, mutagen_file):
- """Remove all images from the file.
- """
- mutagen_file.clear_pictures()
-
-
-class APEv2ImageStorageStyle(ListStorageStyle):
- """Store images in APEv2 tags. Values are `Image` objects.
- """
- formats = ['APEv2File', 'WavPack', 'Musepack', 'MonkeysAudio', 'OptimFROG']
-
- TAG_NAMES = {
- ImageType.other: 'Cover Art (other)',
- ImageType.icon: 'Cover Art (icon)',
- ImageType.other_icon: 'Cover Art (other icon)',
- ImageType.front: 'Cover Art (front)',
- ImageType.back: 'Cover Art (back)',
- ImageType.leaflet: 'Cover Art (leaflet)',
- ImageType.media: 'Cover Art (media)',
- ImageType.lead_artist: 'Cover Art (lead)',
- ImageType.artist: 'Cover Art (artist)',
- ImageType.conductor: 'Cover Art (conductor)',
- ImageType.group: 'Cover Art (band)',
- ImageType.composer: 'Cover Art (composer)',
- ImageType.lyricist: 'Cover Art (lyricist)',
- ImageType.recording_location: 'Cover Art (studio)',
- ImageType.recording_session: 'Cover Art (recording)',
- ImageType.performance: 'Cover Art (performance)',
- ImageType.screen_capture: 'Cover Art (movie scene)',
- ImageType.fish: 'Cover Art (colored fish)',
- ImageType.illustration: 'Cover Art (illustration)',
- ImageType.artist_logo: 'Cover Art (band logo)',
- ImageType.publisher_logo: 'Cover Art (publisher logo)',
- }
-
- def __init__(self):
- super(APEv2ImageStorageStyle, self).__init__(key='')
-
- def fetch(self, mutagen_file):
- images = []
- for cover_type, cover_tag in self.TAG_NAMES.items():
- try:
- frame = mutagen_file[cover_tag]
- text_delimiter_index = frame.value.find(b'\x00')
- if text_delimiter_index > 0:
- comment = frame.value[0:text_delimiter_index]
- comment = comment.decode('utf-8', 'replace')
- else:
- comment = None
- image_data = frame.value[text_delimiter_index + 1:]
- images.append(Image(data=image_data, type=cover_type,
- desc=comment))
- except KeyError:
- pass
-
- return images
-
- def set_list(self, mutagen_file, values):
- self.delete(mutagen_file)
-
- for image in values:
- image_type = image.type or ImageType.other
- comment = image.desc or ''
- image_data = comment.encode('utf-8') + b'\x00' + image.data
- cover_tag = self.TAG_NAMES[image_type]
- mutagen_file[cover_tag] = image_data
-
- def delete(self, mutagen_file):
- """Remove all images from the file.
- """
- for cover_tag in self.TAG_NAMES.values():
- try:
- del mutagen_file[cover_tag]
- except KeyError:
- pass
-
-
-# MediaField is a descriptor that represents a single logical field. It
-# aggregates several StorageStyles describing how to access the data for
-# each file type.
-
-class MediaField(object):
- """A descriptor providing access to a particular (abstract) metadata
- field.
- """
- def __init__(self, *styles, **kwargs):
- """Creates a new MediaField.
-
- :param styles: `StorageStyle` instances that describe the strategy
- for reading and writing the field in particular
- formats. There must be at least one style for
- each possible file format.
-
- :param out_type: the type of the value that should be returned when
- getting this property.
-
- """
- self.out_type = kwargs.get('out_type', six.text_type)
- self._styles = styles
-
- def styles(self, mutagen_file):
- """Yields the list of storage styles of this field that can
- handle the MediaFile's format.
- """
- for style in self._styles:
- if mutagen_file.__class__.__name__ in style.formats:
- yield style
-
- def __get__(self, mediafile, owner=None):
- out = None
- for style in self.styles(mediafile.mgfile):
- out = style.get(mediafile.mgfile)
- if out:
- break
- return _safe_cast(self.out_type, out)
-
- def __set__(self, mediafile, value):
- if value is None:
- value = self._none_value()
- for style in self.styles(mediafile.mgfile):
- style.set(mediafile.mgfile, value)
-
- def __delete__(self, mediafile):
- for style in self.styles(mediafile.mgfile):
- style.delete(mediafile.mgfile)
-
- def _none_value(self):
- """Get an appropriate "null" value for this field's type. This
- is used internally when setting the field to None.
- """
- if self.out_type == int:
- return 0
- elif self.out_type == float:
- return 0.0
- elif self.out_type == bool:
- return False
- elif self.out_type == six.text_type:
- return u''
-
-
-class ListMediaField(MediaField):
- """Property descriptor that retrieves a list of multiple values from
- a tag.
-
- Uses ``get_list`` and set_list`` methods of its ``StorageStyle``
- strategies to do the actual work.
- """
- def __get__(self, mediafile, _):
- values = []
- for style in self.styles(mediafile.mgfile):
- values.extend(style.get_list(mediafile.mgfile))
- return [_safe_cast(self.out_type, value) for value in values]
-
- def __set__(self, mediafile, values):
- for style in self.styles(mediafile.mgfile):
- style.set_list(mediafile.mgfile, values)
-
- def single_field(self):
- """Returns a ``MediaField`` descriptor that gets and sets the
- first item.
- """
- options = {'out_type': self.out_type}
- return MediaField(*self._styles, **options)
-
-
-class DateField(MediaField):
- """Descriptor that handles serializing and deserializing dates
-
- The getter parses value from tags into a ``datetime.date`` instance
- and setter serializes such an instance into a string.
-
- For granular access to year, month, and day, use the ``*_field``
- methods to create corresponding `DateItemField`s.
- """
- def __init__(self, *date_styles, **kwargs):
- """``date_styles`` is a list of ``StorageStyle``s to store and
- retrieve the whole date from. The ``year`` option is an
- additional list of fallback styles for the year. The year is
- always set on this style, but is only retrieved if the main
- storage styles do not return a value.
- """
- super(DateField, self).__init__(*date_styles)
- year_style = kwargs.get('year', None)
- if year_style:
- self._year_field = MediaField(*year_style)
-
- def __get__(self, mediafile, owner=None):
- year, month, day = self._get_date_tuple(mediafile)
- if not year:
- return None
- try:
- return datetime.date(
- year,
- month or 1,
- day or 1
- )
- except ValueError: # Out of range values.
- return None
-
- def __set__(self, mediafile, date):
- if date is None:
- self._set_date_tuple(mediafile, None, None, None)
- else:
- self._set_date_tuple(mediafile, date.year, date.month, date.day)
-
- def __delete__(self, mediafile):
- super(DateField, self).__delete__(mediafile)
- if hasattr(self, '_year_field'):
- self._year_field.__delete__(mediafile)
-
- def _get_date_tuple(self, mediafile):
- """Get a 3-item sequence representing the date consisting of a
- year, month, and day number. Each number is either an integer or
- None.
- """
- # Get the underlying data and split on hyphens and slashes.
- datestring = super(DateField, self).__get__(mediafile, None)
- if isinstance(datestring, six.string_types):
- datestring = re.sub(r'[Tt ].*$', '', six.text_type(datestring))
- items = re.split('[-/]', six.text_type(datestring))
- else:
- items = []
-
- # Ensure that we have exactly 3 components, possibly by
- # truncating or padding.
- items = items[:3]
- if len(items) < 3:
- items += [None] * (3 - len(items))
-
- # Use year field if year is missing.
- if not items[0] and hasattr(self, '_year_field'):
- items[0] = self._year_field.__get__(mediafile)
-
- # Convert each component to an integer if possible.
- items_ = []
- for item in items:
- try:
- items_.append(int(item))
- except:
- items_.append(None)
- return items_
-
- def _set_date_tuple(self, mediafile, year, month=None, day=None):
- """Set the value of the field given a year, month, and day
- number. Each number can be an integer or None to indicate an
- unset component.
- """
- if year is None:
- self.__delete__(mediafile)
- return
-
- date = [u'{0:04d}'.format(int(year))]
- if month:
- date.append(u'{0:02d}'.format(int(month)))
- if month and day:
- date.append(u'{0:02d}'.format(int(day)))
- date = map(six.text_type, date)
- super(DateField, self).__set__(mediafile, u'-'.join(date))
-
- if hasattr(self, '_year_field'):
- self._year_field.__set__(mediafile, year)
-
- def year_field(self):
- return DateItemField(self, 0)
-
- def month_field(self):
- return DateItemField(self, 1)
-
- def day_field(self):
- return DateItemField(self, 2)
-
-
-class DateItemField(MediaField):
- """Descriptor that gets and sets constituent parts of a `DateField`:
- the month, day, or year.
- """
- def __init__(self, date_field, item_pos):
- self.date_field = date_field
- self.item_pos = item_pos
-
- def __get__(self, mediafile, _):
- return self.date_field._get_date_tuple(mediafile)[self.item_pos]
-
- def __set__(self, mediafile, value):
- items = self.date_field._get_date_tuple(mediafile)
- items[self.item_pos] = value
- self.date_field._set_date_tuple(mediafile, *items)
-
- def __delete__(self, mediafile):
- self.__set__(mediafile, None)
-
-
-class CoverArtField(MediaField):
- """A descriptor that provides access to the *raw image data* for the
- cover image on a file. This is used for backwards compatibility: the
- full `ImageListField` provides richer `Image` objects.
-
- When there are multiple images we try to pick the most likely to be a front
- cover.
- """
- def __init__(self):
- pass
-
- def __get__(self, mediafile, _):
- candidates = mediafile.images
- if candidates:
- return self.guess_cover_image(candidates).data
- else:
- return None
-
- @staticmethod
- def guess_cover_image(candidates):
- if len(candidates) == 1:
- return candidates[0]
- try:
- return next(c for c in candidates if c.type == ImageType.front)
- except StopIteration:
- return candidates[0]
-
- def __set__(self, mediafile, data):
- if data:
- mediafile.images = [Image(data=data)]
- else:
- mediafile.images = []
-
- def __delete__(self, mediafile):
- delattr(mediafile, 'images')
-
-
-class ImageListField(ListMediaField):
- """Descriptor to access the list of images embedded in tags.
-
- The getter returns a list of `Image` instances obtained from
- the tags. The setter accepts a list of `Image` instances to be
- written to the tags.
- """
- def __init__(self):
- # The storage styles used here must implement the
- # `ListStorageStyle` interface and get and set lists of
- # `Image`s.
- super(ImageListField, self).__init__(
- MP3ImageStorageStyle(),
- MP4ImageStorageStyle(),
- ASFImageStorageStyle(),
- VorbisImageStorageStyle(),
- FlacImageStorageStyle(),
- APEv2ImageStorageStyle(),
- out_type=Image,
- )
-
-
-# MediaFile is a collection of fields.
-
-class MediaFile(object):
- """Represents a multimedia file on disk and provides access to its
- metadata.
- """
- def __init__(self, path, id3v23=False):
- """Constructs a new `MediaFile` reflecting the file at path. May
- throw `UnreadableFileError`.
-
- By default, MP3 files are saved with ID3v2.4 tags. You can use
- the older ID3v2.3 standard by specifying the `id3v23` option.
- """
- self.path = path
-
- self.mgfile = mutagen_call('open', path, mutagen.File, path)
-
- if self.mgfile is None:
- # Mutagen couldn't guess the type
- raise FileTypeError(path)
- elif (type(self.mgfile).__name__ == 'M4A' or
- type(self.mgfile).__name__ == 'MP4'):
- info = self.mgfile.info
- if info.codec and info.codec.startswith('alac'):
- self.type = 'alac'
- else:
- self.type = 'aac'
- elif (type(self.mgfile).__name__ == 'ID3' or
- type(self.mgfile).__name__ == 'MP3'):
- self.type = 'mp3'
- elif type(self.mgfile).__name__ == 'FLAC':
- self.type = 'flac'
- elif type(self.mgfile).__name__ == 'OggOpus':
- self.type = 'opus'
- elif type(self.mgfile).__name__ == 'OggVorbis':
- self.type = 'ogg'
- elif type(self.mgfile).__name__ == 'MonkeysAudio':
- self.type = 'ape'
- elif type(self.mgfile).__name__ == 'WavPack':
- self.type = 'wv'
- elif type(self.mgfile).__name__ == 'Musepack':
- self.type = 'mpc'
- elif type(self.mgfile).__name__ == 'ASF':
- self.type = 'asf'
- elif type(self.mgfile).__name__ == 'AIFF':
- self.type = 'aiff'
- elif type(self.mgfile).__name__ == 'DSF':
- self.type = 'dsf'
- else:
- raise FileTypeError(path, type(self.mgfile).__name__)
-
- # Add a set of tags if it's missing.
- if self.mgfile.tags is None:
- self.mgfile.add_tags()
-
- # Set the ID3v2.3 flag only for MP3s.
- self.id3v23 = id3v23 and self.type == 'mp3'
-
- def save(self):
- """Write the object's tags back to the file. May
- throw `UnreadableFileError`.
- """
- # Possibly save the tags to ID3v2.3.
- kwargs = {}
- if self.id3v23:
- id3 = self.mgfile
- if hasattr(id3, 'tags'):
- # In case this is an MP3 object, not an ID3 object.
- id3 = id3.tags
- id3.update_to_v23()
- kwargs['v2_version'] = 3
-
- mutagen_call('save', self.path, self.mgfile.save, **kwargs)
-
- def delete(self):
- """Remove the current metadata tag from the file. May
- throw `UnreadableFileError`.
- """
- mutagen_call('delete', self.path, self.mgfile.delete)
-
- # Convenient access to the set of available fields.
-
- @classmethod
- def fields(cls):
- """Get the names of all writable properties that reflect
- metadata tags (i.e., those that are instances of
- :class:`MediaField`).
- """
- for property, descriptor in cls.__dict__.items():
- if isinstance(descriptor, MediaField):
- if isinstance(property, bytes):
- # On Python 2, class field names are bytes. This method
- # produces text strings.
- yield property.decode('utf8', 'ignore')
- else:
- yield property
-
- @classmethod
- def _field_sort_name(cls, name):
- """Get a sort key for a field name that determines the order
- fields should be written in.
-
- Fields names are kept unchanged, unless they are instances of
- :class:`DateItemField`, in which case `year`, `month`, and `day`
- are replaced by `date0`, `date1`, and `date2`, respectively, to
- make them appear in that order.
- """
- if isinstance(cls.__dict__[name], DateItemField):
- name = re.sub('year', 'date0', name)
- name = re.sub('month', 'date1', name)
- name = re.sub('day', 'date2', name)
- return name
-
- @classmethod
- def sorted_fields(cls):
- """Get the names of all writable metadata fields, sorted in the
- order that they should be written.
-
- This is a lexicographic order, except for instances of
- :class:`DateItemField`, which are sorted in year-month-day
- order.
- """
- for property in sorted(cls.fields(), key=cls._field_sort_name):
- yield property
-
- @classmethod
- def readable_fields(cls):
- """Get all metadata fields: the writable ones from
- :meth:`fields` and also other audio properties.
- """
- for property in cls.fields():
- yield property
- for property in ('length', 'samplerate', 'bitdepth', 'bitrate',
- 'channels', 'format'):
- yield property
-
- @classmethod
- def add_field(cls, name, descriptor):
- """Add a field to store custom tags.
-
- :param name: the name of the property the field is accessed
- through. It must not already exist on this class.
-
- :param descriptor: an instance of :class:`MediaField`.
- """
- if not isinstance(descriptor, MediaField):
- raise ValueError(
- u'{0} must be an instance of MediaField'.format(descriptor))
- if name in cls.__dict__:
- raise ValueError(
- u'property "{0}" already exists on MediaField'.format(name))
- setattr(cls, name, descriptor)
-
- def update(self, dict):
- """Set all field values from a dictionary.
-
- For any key in `dict` that is also a field to store tags the
- method retrieves the corresponding value from `dict` and updates
- the `MediaFile`. If a key has the value `None`, the
- corresponding property is deleted from the `MediaFile`.
- """
- for field in self.sorted_fields():
- if field in dict:
- if dict[field] is None:
- delattr(self, field)
- else:
- setattr(self, field, dict[field])
-
- # Field definitions.
-
- title = MediaField(
- MP3StorageStyle('TIT2'),
- MP4StorageStyle('\xa9nam'),
- StorageStyle('TITLE'),
- ASFStorageStyle('Title'),
- )
- artist = MediaField(
- MP3StorageStyle('TPE1'),
- MP4StorageStyle('\xa9ART'),
- StorageStyle('ARTIST'),
- ASFStorageStyle('Author'),
- )
- album = MediaField(
- MP3StorageStyle('TALB'),
- MP4StorageStyle('\xa9alb'),
- StorageStyle('ALBUM'),
- ASFStorageStyle('WM/AlbumTitle'),
- )
- genres = ListMediaField(
- MP3ListStorageStyle('TCON'),
- MP4ListStorageStyle('\xa9gen'),
- ListStorageStyle('GENRE'),
- ASFStorageStyle('WM/Genre'),
- )
- genre = genres.single_field()
-
- lyricist = MediaField(
- MP3StorageStyle('TEXT'),
- MP4StorageStyle('----:com.apple.iTunes:LYRICIST'),
- StorageStyle('LYRICIST'),
- ASFStorageStyle('WM/Writer'),
- )
- composer = MediaField(
- MP3StorageStyle('TCOM'),
- MP4StorageStyle('\xa9wrt'),
- StorageStyle('COMPOSER'),
- ASFStorageStyle('WM/Composer'),
- )
- arranger = MediaField(
- MP3PeopleStorageStyle('TIPL', involvement='arranger'),
- MP4StorageStyle('----:com.apple.iTunes:Arranger'),
- StorageStyle('ARRANGER'),
- ASFStorageStyle('beets/Arranger'),
- )
-
- grouping = MediaField(
- MP3StorageStyle('TIT1'),
- MP4StorageStyle('\xa9grp'),
- StorageStyle('GROUPING'),
- ASFStorageStyle('WM/ContentGroupDescription'),
- )
- track = MediaField(
- MP3SlashPackStorageStyle('TRCK', pack_pos=0),
- MP4TupleStorageStyle('trkn', index=0),
- StorageStyle('TRACK'),
- StorageStyle('TRACKNUMBER'),
- ASFStorageStyle('WM/TrackNumber'),
- out_type=int,
- )
- tracktotal = MediaField(
- MP3SlashPackStorageStyle('TRCK', pack_pos=1),
- MP4TupleStorageStyle('trkn', index=1),
- StorageStyle('TRACKTOTAL'),
- StorageStyle('TRACKC'),
- StorageStyle('TOTALTRACKS'),
- ASFStorageStyle('TotalTracks'),
- out_type=int,
- )
- disc = MediaField(
- MP3SlashPackStorageStyle('TPOS', pack_pos=0),
- MP4TupleStorageStyle('disk', index=0),
- StorageStyle('DISC'),
- StorageStyle('DISCNUMBER'),
- ASFStorageStyle('WM/PartOfSet'),
- out_type=int,
- )
- disctotal = MediaField(
- MP3SlashPackStorageStyle('TPOS', pack_pos=1),
- MP4TupleStorageStyle('disk', index=1),
- StorageStyle('DISCTOTAL'),
- StorageStyle('DISCC'),
- StorageStyle('TOTALDISCS'),
- ASFStorageStyle('TotalDiscs'),
- out_type=int,
- )
- lyrics = MediaField(
- MP3DescStorageStyle(key='USLT'),
- MP4StorageStyle('\xa9lyr'),
- StorageStyle('LYRICS'),
- ASFStorageStyle('WM/Lyrics'),
- )
- comments = MediaField(
- MP3DescStorageStyle(key='COMM'),
- MP4StorageStyle('\xa9cmt'),
- StorageStyle('DESCRIPTION'),
- StorageStyle('COMMENT'),
- ASFStorageStyle('WM/Comments'),
- ASFStorageStyle('Description')
- )
- bpm = MediaField(
- MP3StorageStyle('TBPM'),
- MP4StorageStyle('tmpo', as_type=int),
- StorageStyle('BPM'),
- ASFStorageStyle('WM/BeatsPerMinute'),
- out_type=int,
- )
- comp = MediaField(
- MP3StorageStyle('TCMP'),
- MP4BoolStorageStyle('cpil'),
- StorageStyle('COMPILATION'),
- ASFStorageStyle('WM/IsCompilation', as_type=bool),
- out_type=bool,
- )
- albumartist = MediaField(
- MP3StorageStyle('TPE2'),
- MP4StorageStyle('aART'),
- StorageStyle('ALBUM ARTIST'),
- StorageStyle('ALBUMARTIST'),
- ASFStorageStyle('WM/AlbumArtist'),
- )
- albumtype = MediaField(
- MP3DescStorageStyle(u'MusicBrainz Album Type'),
- MP4StorageStyle('----:com.apple.iTunes:MusicBrainz Album Type'),
- StorageStyle('MUSICBRAINZ_ALBUMTYPE'),
- ASFStorageStyle('MusicBrainz/Album Type'),
- )
- label = MediaField(
- MP3StorageStyle('TPUB'),
- MP4StorageStyle('----:com.apple.iTunes:Label'),
- MP4StorageStyle('----:com.apple.iTunes:publisher'),
- StorageStyle('LABEL'),
- StorageStyle('PUBLISHER'), # Traktor
- ASFStorageStyle('WM/Publisher'),
- )
- artist_sort = MediaField(
- MP3StorageStyle('TSOP'),
- MP4StorageStyle('soar'),
- StorageStyle('ARTISTSORT'),
- ASFStorageStyle('WM/ArtistSortOrder'),
- )
- albumartist_sort = MediaField(
- MP3DescStorageStyle(u'ALBUMARTISTSORT'),
- MP4StorageStyle('soaa'),
- StorageStyle('ALBUMARTISTSORT'),
- ASFStorageStyle('WM/AlbumArtistSortOrder'),
- )
- asin = MediaField(
- MP3DescStorageStyle(u'ASIN'),
- MP4StorageStyle('----:com.apple.iTunes:ASIN'),
- StorageStyle('ASIN'),
- ASFStorageStyle('MusicBrainz/ASIN'),
- )
- catalognum = MediaField(
- MP3DescStorageStyle(u'CATALOGNUMBER'),
- MP4StorageStyle('----:com.apple.iTunes:CATALOGNUMBER'),
- StorageStyle('CATALOGNUMBER'),
- ASFStorageStyle('WM/CatalogNo'),
- )
- disctitle = MediaField(
- MP3StorageStyle('TSST'),
- MP4StorageStyle('----:com.apple.iTunes:DISCSUBTITLE'),
- StorageStyle('DISCSUBTITLE'),
- ASFStorageStyle('WM/SetSubTitle'),
- )
- encoder = MediaField(
- MP3StorageStyle('TENC'),
- MP4StorageStyle('\xa9too'),
- StorageStyle('ENCODEDBY'),
- StorageStyle('ENCODER'),
- ASFStorageStyle('WM/EncodedBy'),
- )
- script = MediaField(
- MP3DescStorageStyle(u'Script'),
- MP4StorageStyle('----:com.apple.iTunes:SCRIPT'),
- StorageStyle('SCRIPT'),
- ASFStorageStyle('WM/Script'),
- )
- language = MediaField(
- MP3StorageStyle('TLAN'),
- MP4StorageStyle('----:com.apple.iTunes:LANGUAGE'),
- StorageStyle('LANGUAGE'),
- ASFStorageStyle('WM/Language'),
- )
- country = MediaField(
- MP3DescStorageStyle(u'MusicBrainz Album Release Country'),
- MP4StorageStyle('----:com.apple.iTunes:MusicBrainz '
- 'Album Release Country'),
- StorageStyle('RELEASECOUNTRY'),
- ASFStorageStyle('MusicBrainz/Album Release Country'),
- )
- albumstatus = MediaField(
- MP3DescStorageStyle(u'MusicBrainz Album Status'),
- MP4StorageStyle('----:com.apple.iTunes:MusicBrainz Album Status'),
- StorageStyle('MUSICBRAINZ_ALBUMSTATUS'),
- ASFStorageStyle('MusicBrainz/Album Status'),
- )
- media = MediaField(
- MP3StorageStyle('TMED'),
- MP4StorageStyle('----:com.apple.iTunes:MEDIA'),
- StorageStyle('MEDIA'),
- ASFStorageStyle('WM/Media'),
- )
- albumdisambig = MediaField(
- # This tag mapping was invented for beets (not used by Picard, etc).
- MP3DescStorageStyle(u'MusicBrainz Album Comment'),
- MP4StorageStyle('----:com.apple.iTunes:MusicBrainz Album Comment'),
- StorageStyle('MUSICBRAINZ_ALBUMCOMMENT'),
- ASFStorageStyle('MusicBrainz/Album Comment'),
- )
-
- # Release date.
- date = DateField(
- MP3StorageStyle('TDRC'),
- MP4StorageStyle('\xa9day'),
- StorageStyle('DATE'),
- ASFStorageStyle('WM/Year'),
- year=(StorageStyle('YEAR'),))
-
- year = date.year_field()
- month = date.month_field()
- day = date.day_field()
-
- # *Original* release date.
- original_date = DateField(
- MP3StorageStyle('TDOR'),
- MP4StorageStyle('----:com.apple.iTunes:ORIGINAL YEAR'),
- StorageStyle('ORIGINALDATE'),
- ASFStorageStyle('WM/OriginalReleaseYear'))
-
- original_year = original_date.year_field()
- original_month = original_date.month_field()
- original_day = original_date.day_field()
-
- # Nonstandard metadata.
- artist_credit = MediaField(
- MP3DescStorageStyle(u'Artist Credit'),
- MP4StorageStyle('----:com.apple.iTunes:Artist Credit'),
- StorageStyle('ARTIST_CREDIT'),
- ASFStorageStyle('beets/Artist Credit'),
- )
- albumartist_credit = MediaField(
- MP3DescStorageStyle(u'Album Artist Credit'),
- MP4StorageStyle('----:com.apple.iTunes:Album Artist Credit'),
- StorageStyle('ALBUMARTIST_CREDIT'),
- ASFStorageStyle('beets/Album Artist Credit'),
- )
-
- # Legacy album art field
- art = CoverArtField()
-
- # Image list
- images = ImageListField()
-
- # MusicBrainz IDs.
- mb_trackid = MediaField(
- MP3UFIDStorageStyle(owner='http://musicbrainz.org'),
- MP4StorageStyle('----:com.apple.iTunes:MusicBrainz Track Id'),
- StorageStyle('MUSICBRAINZ_TRACKID'),
- ASFStorageStyle('MusicBrainz/Track Id'),
- )
- mb_albumid = MediaField(
- MP3DescStorageStyle(u'MusicBrainz Album Id'),
- MP4StorageStyle('----:com.apple.iTunes:MusicBrainz Album Id'),
- StorageStyle('MUSICBRAINZ_ALBUMID'),
- ASFStorageStyle('MusicBrainz/Album Id'),
- )
- mb_artistid = MediaField(
- MP3DescStorageStyle(u'MusicBrainz Artist Id'),
- MP4StorageStyle('----:com.apple.iTunes:MusicBrainz Artist Id'),
- StorageStyle('MUSICBRAINZ_ARTISTID'),
- ASFStorageStyle('MusicBrainz/Artist Id'),
- )
- mb_albumartistid = MediaField(
- MP3DescStorageStyle(u'MusicBrainz Album Artist Id'),
- MP4StorageStyle('----:com.apple.iTunes:MusicBrainz Album Artist Id'),
- StorageStyle('MUSICBRAINZ_ALBUMARTISTID'),
- ASFStorageStyle('MusicBrainz/Album Artist Id'),
- )
- mb_releasegroupid = MediaField(
- MP3DescStorageStyle(u'MusicBrainz Release Group Id'),
- MP4StorageStyle('----:com.apple.iTunes:MusicBrainz Release Group Id'),
- StorageStyle('MUSICBRAINZ_RELEASEGROUPID'),
- ASFStorageStyle('MusicBrainz/Release Group Id'),
- )
-
- # Acoustid fields.
- acoustid_fingerprint = MediaField(
- MP3DescStorageStyle(u'Acoustid Fingerprint'),
- MP4StorageStyle('----:com.apple.iTunes:Acoustid Fingerprint'),
- StorageStyle('ACOUSTID_FINGERPRINT'),
- ASFStorageStyle('Acoustid/Fingerprint'),
- )
- acoustid_id = MediaField(
- MP3DescStorageStyle(u'Acoustid Id'),
- MP4StorageStyle('----:com.apple.iTunes:Acoustid Id'),
- StorageStyle('ACOUSTID_ID'),
- ASFStorageStyle('Acoustid/Id'),
- )
-
- # ReplayGain fields.
- rg_track_gain = MediaField(
- MP3DescStorageStyle(
- u'REPLAYGAIN_TRACK_GAIN',
- float_places=2, suffix=u' dB'
- ),
- MP3DescStorageStyle(
- u'replaygain_track_gain',
- float_places=2, suffix=u' dB'
- ),
- MP3SoundCheckStorageStyle(
- key='COMM',
- index=0, desc=u'iTunNORM',
- id3_lang='eng'
- ),
- MP4StorageStyle(
- '----:com.apple.iTunes:replaygain_track_gain',
- float_places=2, suffix=' dB'
- ),
- MP4SoundCheckStorageStyle(
- '----:com.apple.iTunes:iTunNORM',
- index=0
- ),
- StorageStyle(
- u'REPLAYGAIN_TRACK_GAIN',
- float_places=2, suffix=u' dB'
- ),
- ASFStorageStyle(
- u'replaygain_track_gain',
- float_places=2, suffix=u' dB'
- ),
- out_type=float
- )
- rg_album_gain = MediaField(
- MP3DescStorageStyle(
- u'REPLAYGAIN_ALBUM_GAIN',
- float_places=2, suffix=u' dB'
- ),
- MP3DescStorageStyle(
- u'replaygain_album_gain',
- float_places=2, suffix=u' dB'
- ),
- MP4StorageStyle(
- '----:com.apple.iTunes:replaygain_album_gain',
- float_places=2, suffix=' dB'
- ),
- StorageStyle(
- u'REPLAYGAIN_ALBUM_GAIN',
- float_places=2, suffix=u' dB'
- ),
- ASFStorageStyle(
- u'replaygain_album_gain',
- float_places=2, suffix=u' dB'
- ),
- out_type=float
- )
- rg_track_peak = MediaField(
- MP3DescStorageStyle(
- u'REPLAYGAIN_TRACK_PEAK',
- float_places=6
- ),
- MP3DescStorageStyle(
- u'replaygain_track_peak',
- float_places=6
- ),
- MP3SoundCheckStorageStyle(
- key=u'COMM',
- index=1, desc=u'iTunNORM',
- id3_lang='eng'
- ),
- MP4StorageStyle(
- '----:com.apple.iTunes:replaygain_track_peak',
- float_places=6
- ),
- MP4SoundCheckStorageStyle(
- '----:com.apple.iTunes:iTunNORM',
- index=1
- ),
- StorageStyle(u'REPLAYGAIN_TRACK_PEAK', float_places=6),
- ASFStorageStyle(u'replaygain_track_peak', float_places=6),
- out_type=float,
- )
- rg_album_peak = MediaField(
- MP3DescStorageStyle(
- u'REPLAYGAIN_ALBUM_PEAK',
- float_places=6
- ),
- MP3DescStorageStyle(
- u'replaygain_album_peak',
- float_places=6
- ),
- MP4StorageStyle(
- '----:com.apple.iTunes:replaygain_album_peak',
- float_places=6
- ),
- StorageStyle(u'REPLAYGAIN_ALBUM_PEAK', float_places=6),
- ASFStorageStyle(u'replaygain_album_peak', float_places=6),
- out_type=float,
- )
-
- initial_key = MediaField(
- MP3StorageStyle('TKEY'),
- MP4StorageStyle('----:com.apple.iTunes:initialkey'),
- StorageStyle('INITIALKEY'),
- ASFStorageStyle('INITIALKEY'),
- )
-
- @property
- def length(self):
- """The duration of the audio in seconds (a float)."""
- return self.mgfile.info.length
-
- @property
- def samplerate(self):
- """The audio's sample rate (an int)."""
- if hasattr(self.mgfile.info, 'sample_rate'):
- return self.mgfile.info.sample_rate
- elif self.type == 'opus':
- # Opus is always 48kHz internally.
- return 48000
- return 0
-
- @property
- def bitdepth(self):
- """The number of bits per sample in the audio encoding (an int).
- Only available for certain file formats (zero where
- unavailable).
- """
- if hasattr(self.mgfile.info, 'bits_per_sample'):
- return self.mgfile.info.bits_per_sample
- return 0
-
- @property
- def channels(self):
- """The number of channels in the audio (an int)."""
- if hasattr(self.mgfile.info, 'channels'):
- return self.mgfile.info.channels
- return 0
-
- @property
- def bitrate(self):
- """The number of bits per seconds used in the audio coding (an
- int). If this is provided explicitly by the compressed file
- format, this is a precise reflection of the encoding. Otherwise,
- it is estimated from the on-disk file size. In this case, some
- imprecision is possible because the file header is incorporated
- in the file size.
- """
- if hasattr(self.mgfile.info, 'bitrate') and self.mgfile.info.bitrate:
- # Many formats provide it explicitly.
- return self.mgfile.info.bitrate
- else:
- # Otherwise, we calculate bitrate from the file size. (This
- # is the case for all of the lossless formats.)
- if not self.length:
- # Avoid division by zero if length is not available.
- return 0
- size = os.path.getsize(self.path)
- return int(size * 8 / self.length)
-
- @property
- def format(self):
- """A string describing the file format/codec."""
- return TYPES[self.type]
+del key, value, warnings, mediafile
diff --git a/lib/beets/plugins.py b/lib/beets/plugins.py
old mode 100755
new mode 100644
index 2ecdb847..ed1f82d8
--- a/lib/beets/plugins.py
+++ b/lib/beets/plugins.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
# This file is part of beets.
# Copyright 2016, Adrian Sampson.
#
@@ -15,19 +14,19 @@
"""Support for beets plugins."""
-from __future__ import division, absolute_import, print_function
-import inspect
import traceback
import re
+import inspect
+import abc
from collections import defaultdict
from functools import wraps
import beets
from beets import logging
-from beets import mediafile
-import six
+import mediafile
+
PLUGIN_NAMESPACE = 'beetsplug'
@@ -50,26 +49,28 @@ class PluginLogFilter(logging.Filter):
"""A logging filter that identifies the plugin that emitted a log
message.
"""
+
def __init__(self, plugin):
- self.prefix = u'{0}: '.format(plugin.name)
+ self.prefix = f'{plugin.name}: '
def filter(self, record):
if hasattr(record.msg, 'msg') and isinstance(record.msg.msg,
- six.string_types):
+ str):
# A _LogMessage from our hacked-up Logging replacement.
record.msg.msg = self.prefix + record.msg.msg
- elif isinstance(record.msg, six.string_types):
+ elif isinstance(record.msg, str):
record.msg = self.prefix + record.msg
return True
# Managing the plugins themselves.
-class BeetsPlugin(object):
+class BeetsPlugin:
"""The base class for all beets plugins. Plugins provide
functionality by defining a subclass of BeetsPlugin and overriding
the abstract methods defined here.
"""
+
def __init__(self, name=None):
"""Perform one-time plugin setup.
"""
@@ -81,6 +82,7 @@ class BeetsPlugin(object):
self.template_fields = {}
if not self.album_template_fields:
self.album_template_fields = {}
+ self.early_import_stages = []
self.import_stages = []
self._log = log.getChild(self.name)
@@ -94,6 +96,22 @@ class BeetsPlugin(object):
"""
return ()
+ def _set_stage_log_level(self, stages):
+ """Adjust all the stages in `stages` to WARNING logging level.
+ """
+ return [self._set_log_level_and_params(logging.WARNING, stage)
+ for stage in stages]
+
+ def get_early_import_stages(self):
+ """Return a list of functions that should be called as importer
+ pipelines stages early in the pipeline.
+
+ The callables are wrapped versions of the functions in
+ `self.early_import_stages`. Wrapping provides some bookkeeping for the
+ plugin: specifically, the logging level is adjusted to WARNING.
+ """
+ return self._set_stage_log_level(self.early_import_stages)
+
def get_import_stages(self):
"""Return a list of functions that should be called as importer
pipelines stages.
@@ -102,8 +120,7 @@ class BeetsPlugin(object):
`self.import_stages`. Wrapping provides some bookkeeping for the
plugin: specifically, the logging level is adjusted to WARNING.
"""
- return [self._set_log_level_and_params(logging.WARNING, import_stage)
- for import_stage in self.import_stages]
+ return self._set_stage_log_level(self.import_stages)
def _set_log_level_and_params(self, base_log_level, func):
"""Wrap `func` to temporarily set this plugin's logger level to
@@ -111,27 +128,24 @@ class BeetsPlugin(object):
value after the function returns). Also determines which params may not
be sent for backwards-compatibility.
"""
- argspec = inspect.getargspec(func)
+ argspec = inspect.getfullargspec(func)
@wraps(func)
def wrapper(*args, **kwargs):
assert self._log.level == logging.NOTSET
+
verbosity = beets.config['verbose'].get(int)
log_level = max(logging.DEBUG, base_log_level - 10 * verbosity)
self._log.setLevel(log_level)
+ if argspec.varkw is None:
+ kwargs = {k: v for k, v in kwargs.items()
+ if k in argspec.args}
+
try:
- try:
- return func(*args, **kwargs)
- except TypeError as exc:
- if exc.args[0].startswith(func.__name__):
- # caused by 'func' and not stuff internal to 'func'
- kwargs = dict((arg, val) for arg, val in kwargs.items()
- if arg in argspec.args)
- return func(*args, **kwargs)
- else:
- raise
+ return func(*args, **kwargs)
finally:
self._log.setLevel(logging.NOTSET)
+
return wrapper
def queries(self):
@@ -151,7 +165,7 @@ class BeetsPlugin(object):
"""
return beets.autotag.hooks.Distance()
- def candidates(self, items, artist, album, va_likely):
+ def candidates(self, items, artist, album, va_likely, extra_tags=None):
"""Should return a sequence of AlbumInfo objects that match the
album whose items are provided.
"""
@@ -185,7 +199,7 @@ class BeetsPlugin(object):
``descriptor`` must be an instance of ``mediafile.MediaField``.
"""
- # Defer impor to prevent circular dependency
+ # Defer import to prevent circular dependency
from beets import library
mediafile.MediaFile.add_field(name, descriptor)
library.Item._media_fields.add(name)
@@ -248,14 +262,14 @@ def load_plugins(names=()):
BeetsPlugin subclasses desired.
"""
for name in names:
- modname = '{0}.{1}'.format(PLUGIN_NAMESPACE, name)
+ modname = f'{PLUGIN_NAMESPACE}.{name}'
try:
try:
namespace = __import__(modname, None, None)
except ImportError as exc:
# Again, this is hacky:
if exc.args[0].endswith(' ' + name):
- log.warning(u'** plugin {0} not found', name)
+ log.warning('** plugin {0} not found', name)
else:
raise
else:
@@ -264,9 +278,9 @@ def load_plugins(names=()):
and obj != BeetsPlugin and obj not in _classes:
_classes.add(obj)
- except:
+ except Exception:
log.warning(
- u'** error loading plugin {}:\n{}',
+ '** error loading plugin {}:\n{}',
name,
traceback.format_exc(),
)
@@ -280,6 +294,11 @@ def find_plugins():
currently loaded beets plugins. Loads the default plugin set
first.
"""
+ if _instances:
+ # After the first call, use cached instances for performance reasons.
+ # See https://github.com/beetbox/beets/pull/3810
+ return list(_instances.values())
+
load_plugins()
plugins = []
for cls in _classes:
@@ -313,21 +332,31 @@ def queries():
def types(model_cls):
# Gives us `item_types` and `album_types`
- attr_name = '{0}_types'.format(model_cls.__name__.lower())
+ attr_name = f'{model_cls.__name__.lower()}_types'
types = {}
for plugin in find_plugins():
plugin_types = getattr(plugin, attr_name, {})
for field in plugin_types:
if field in types and plugin_types[field] != types[field]:
raise PluginConflictException(
- u'Plugin {0} defines flexible field {1} '
- u'which has already been defined with '
- u'another type.'.format(plugin.name, field)
+ 'Plugin {} defines flexible field {} '
+ 'which has already been defined with '
+ 'another type.'.format(plugin.name, field)
)
types.update(plugin_types)
return types
+def named_queries(model_cls):
+ # Gather `item_queries` and `album_queries` from the plugins.
+ attr_name = f'{model_cls.__name__.lower()}_queries'
+ queries = {}
+ for plugin in find_plugins():
+ plugin_queries = getattr(plugin, attr_name, {})
+ queries.update(plugin_queries)
+ return queries
+
+
def track_distance(item, info):
"""Gets the track distance calculated by all loaded plugins.
Returns a Distance object.
@@ -348,20 +377,19 @@ def album_distance(items, album_info, mapping):
return dist
-def candidates(items, artist, album, va_likely):
+def candidates(items, artist, album, va_likely, extra_tags=None):
"""Gets MusicBrainz candidates for an album from each plugin.
"""
for plugin in find_plugins():
- for candidate in plugin.candidates(items, artist, album, va_likely):
- yield candidate
+ yield from plugin.candidates(items, artist, album, va_likely,
+ extra_tags)
def item_candidates(item, artist, title):
"""Gets MusicBrainz candidates for an item from the plugins.
"""
for plugin in find_plugins():
- for item_candidate in plugin.item_candidates(item, artist, title):
- yield item_candidate
+ yield from plugin.item_candidates(item, artist, title)
def album_for_id(album_id):
@@ -393,6 +421,14 @@ def template_funcs():
return funcs
+def early_import_stages():
+ """Get a list of early import stage functions defined by plugins."""
+ stages = []
+ for plugin in find_plugins():
+ stages += plugin.get_early_import_stages()
+ return stages
+
+
def import_stages():
"""Get a list of import stage functions defined by plugins."""
stages = []
@@ -446,7 +482,7 @@ def send(event, **arguments):
Return a list of non-None values returned from the handlers.
"""
- log.debug(u'Sending event: {0}', event)
+ log.debug('Sending event: {0}', event)
results = []
for handler in event_handlers()[event]:
result = handler(**arguments)
@@ -464,7 +500,7 @@ def feat_tokens(for_artist=True):
feat_words = ['ft', 'featuring', 'feat', 'feat.', 'ft.']
if for_artist:
feat_words += ['with', 'vs', 'and', 'con', '&']
- return '(?<=\s)(?:{0})(?=\s)'.format(
+ return r'(?<=\s)(?:{})(?=\s)'.format(
'|'.join(re.escape(x) for x in feat_words)
)
@@ -478,9 +514,50 @@ def sanitize_choices(choices, choices_all):
others = [x for x in choices_all if x not in choices]
res = []
for s in choices:
- if s in list(choices_all) + ['*']:
- if not (s in seen or seen.add(s)):
- res.extend(list(others) if s == '*' else [s])
+ if s not in seen:
+ if s in list(choices_all):
+ res.append(s)
+ elif s == '*':
+ res.extend(others)
+ seen.add(s)
+ return res
+
+
+def sanitize_pairs(pairs, pairs_all):
+ """Clean up a single-element mapping configuration attribute as returned
+ by Confuse's `Pairs` template: keep only two-element tuples present in
+ pairs_all, remove duplicate elements, expand ('str', '*') and ('*', '*')
+ wildcards while keeping the original order. Note that ('*', '*') and
+ ('*', 'whatever') have the same effect.
+
+ For example,
+
+ >>> sanitize_pairs(
+ ... [('foo', 'baz bar'), ('key', '*'), ('*', '*')],
+ ... [('foo', 'bar'), ('foo', 'baz'), ('foo', 'foobar'),
+ ... ('key', 'value')]
+ ... )
+ [('foo', 'baz'), ('foo', 'bar'), ('key', 'value'), ('foo', 'foobar')]
+ """
+ pairs_all = list(pairs_all)
+ seen = set()
+ others = [x for x in pairs_all if x not in pairs]
+ res = []
+ for k, values in pairs:
+ for v in values.split():
+ x = (k, v)
+ if x in pairs_all:
+ if x not in seen:
+ seen.add(x)
+ res.append(x)
+ elif k == '*':
+ new = [o for o in others if o not in seen]
+ seen.update(new)
+ res.extend(new)
+ elif v == '*':
+ new = [o for o in others if o not in seen and o[0] == k]
+ seen.update(new)
+ res.extend(new)
return res
@@ -498,3 +575,188 @@ def notify_info_yielded(event):
yield v
return decorated
return decorator
+
+
+def get_distance(config, data_source, info):
+ """Returns the ``data_source`` weight and the maximum source weight
+ for albums or individual tracks.
+ """
+ dist = beets.autotag.Distance()
+ if info.data_source == data_source:
+ dist.add('source', config['source_weight'].as_number())
+ return dist
+
+
+def apply_item_changes(lib, item, move, pretend, write):
+ """Store, move, and write the item according to the arguments.
+
+ :param lib: beets library.
+ :type lib: beets.library.Library
+ :param item: Item whose changes to apply.
+ :type item: beets.library.Item
+ :param move: Move the item if it's in the library.
+ :type move: bool
+ :param pretend: Return without moving, writing, or storing the item's
+ metadata.
+ :type pretend: bool
+ :param write: Write the item's metadata to its media file.
+ :type write: bool
+ """
+ if pretend:
+ return
+
+ from beets import util
+
+ # Move the item if it's in the library.
+ if move and lib.directory in util.ancestry(item.path):
+ item.move(with_album=False)
+
+ if write:
+ item.try_write()
+
+ item.store()
+
+
+class MetadataSourcePlugin(metaclass=abc.ABCMeta):
+ def __init__(self):
+ super().__init__()
+ self.config.add({'source_weight': 0.5})
+
+ @abc.abstractproperty
+ def id_regex(self):
+ raise NotImplementedError
+
+ @abc.abstractproperty
+ def data_source(self):
+ raise NotImplementedError
+
+ @abc.abstractproperty
+ def search_url(self):
+ raise NotImplementedError
+
+ @abc.abstractproperty
+ def album_url(self):
+ raise NotImplementedError
+
+ @abc.abstractproperty
+ def track_url(self):
+ raise NotImplementedError
+
+ @abc.abstractmethod
+ def _search_api(self, query_type, filters, keywords=''):
+ raise NotImplementedError
+
+ @abc.abstractmethod
+ def album_for_id(self, album_id):
+ raise NotImplementedError
+
+ @abc.abstractmethod
+ def track_for_id(self, track_id=None, track_data=None):
+ raise NotImplementedError
+
+ @staticmethod
+ def get_artist(artists, id_key='id', name_key='name'):
+ """Returns an artist string (all artists) and an artist_id (the main
+ artist) for a list of artist object dicts.
+
+ For each artist, this function moves articles (such as 'a', 'an',
+ and 'the') to the front and strips trailing disambiguation numbers. It
+ returns a tuple containing the comma-separated string of all
+ normalized artists and the ``id`` of the main/first artist.
+
+ :param artists: Iterable of artist dicts or lists returned by API.
+ :type artists: list[dict] or list[list]
+ :param id_key: Key or index corresponding to the value of ``id`` for
+ the main/first artist. Defaults to 'id'.
+ :type id_key: str or int
+ :param name_key: Key or index corresponding to values of names
+ to concatenate for the artist string (containing all artists).
+ Defaults to 'name'.
+ :type name_key: str or int
+ :return: Normalized artist string.
+ :rtype: str
+ """
+ artist_id = None
+ artist_names = []
+ for artist in artists:
+ if not artist_id:
+ artist_id = artist[id_key]
+ name = artist[name_key]
+ # Strip disambiguation number.
+ name = re.sub(r' \(\d+\)$', '', name)
+ # Move articles to the front.
+ name = re.sub(r'^(.*?), (a|an|the)$', r'\2 \1', name, flags=re.I)
+ artist_names.append(name)
+ artist = ', '.join(artist_names).replace(' ,', ',') or None
+ return artist, artist_id
+
+ def _get_id(self, url_type, id_):
+ """Parse an ID from its URL if necessary.
+
+ :param url_type: Type of URL. Either 'album' or 'track'.
+ :type url_type: str
+ :param id_: Album/track ID or URL.
+ :type id_: str
+ :return: Album/track ID.
+ :rtype: str
+ """
+ self._log.debug(
+ "Searching {} for {} '{}'", self.data_source, url_type, id_
+ )
+ match = re.search(self.id_regex['pattern'].format(url_type), str(id_))
+ if match:
+ id_ = match.group(self.id_regex['match_group'])
+ if id_:
+ return id_
+ return None
+
+ def candidates(self, items, artist, album, va_likely, extra_tags=None):
+ """Returns a list of AlbumInfo objects for Search API results
+ matching an ``album`` and ``artist`` (if not various).
+
+ :param items: List of items comprised by an album to be matched.
+ :type items: list[beets.library.Item]
+ :param artist: The artist of the album to be matched.
+ :type artist: str
+ :param album: The name of the album to be matched.
+ :type album: str
+ :param va_likely: True if the album to be matched likely has
+ Various Artists.
+ :type va_likely: bool
+ :return: Candidate AlbumInfo objects.
+ :rtype: list[beets.autotag.hooks.AlbumInfo]
+ """
+ query_filters = {'album': album}
+ if not va_likely:
+ query_filters['artist'] = artist
+ results = self._search_api(query_type='album', filters=query_filters)
+ albums = [self.album_for_id(album_id=r['id']) for r in results]
+ return [a for a in albums if a is not None]
+
+ def item_candidates(self, item, artist, title):
+ """Returns a list of TrackInfo objects for Search API results
+ matching ``title`` and ``artist``.
+
+ :param item: Singleton item to be matched.
+ :type item: beets.library.Item
+ :param artist: The artist of the track to be matched.
+ :type artist: str
+ :param title: The title of the track to be matched.
+ :type title: str
+ :return: Candidate TrackInfo objects.
+ :rtype: list[beets.autotag.hooks.TrackInfo]
+ """
+ tracks = self._search_api(
+ query_type='track', keywords=title, filters={'artist': artist}
+ )
+ return [self.track_for_id(track_data=track) for track in tracks]
+
+ def album_distance(self, items, album_info, mapping):
+ return get_distance(
+ data_source=self.data_source, info=album_info, config=self.config
+ )
+
+ def track_distance(self, item, track_info):
+ return get_distance(
+ data_source=self.data_source, info=track_info, config=self.config
+ )
diff --git a/lib/beets/random.py b/lib/beets/random.py
new file mode 100644
index 00000000..eb4f55af
--- /dev/null
+++ b/lib/beets/random.py
@@ -0,0 +1,113 @@
+# This file is part of beets.
+# Copyright 2016, Philippe Mongeau.
+#
+# 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.
+
+"""Get a random song or album from the library.
+"""
+
+import random
+from operator import attrgetter
+from itertools import groupby
+
+
+def _length(obj, album):
+ """Get the duration of an item or album.
+ """
+ if album:
+ return sum(i.length for i in obj.items())
+ else:
+ return obj.length
+
+
+def _equal_chance_permutation(objs, field='albumartist', random_gen=None):
+ """Generate (lazily) a permutation of the objects where every group
+ with equal values for `field` have an equal chance of appearing in
+ any given position.
+ """
+ rand = random_gen or random
+
+ # Group the objects by artist so we can sample from them.
+ key = attrgetter(field)
+ objs.sort(key=key)
+ objs_by_artists = {}
+ for artist, v in groupby(objs, key):
+ objs_by_artists[artist] = list(v)
+
+ # While we still have artists with music to choose from, pick one
+ # randomly and pick a track from that artist.
+ while objs_by_artists:
+ # Choose an artist and an object for that artist, removing
+ # this choice from the pool.
+ artist = rand.choice(list(objs_by_artists.keys()))
+ objs_from_artist = objs_by_artists[artist]
+ i = rand.randint(0, len(objs_from_artist) - 1)
+ yield objs_from_artist.pop(i)
+
+ # Remove the artist if we've used up all of its objects.
+ if not objs_from_artist:
+ del objs_by_artists[artist]
+
+
+def _take(iter, num):
+ """Return a list containing the first `num` values in `iter` (or
+ fewer, if the iterable ends early).
+ """
+ out = []
+ for val in iter:
+ out.append(val)
+ num -= 1
+ if num <= 0:
+ break
+ return out
+
+
+def _take_time(iter, secs, album):
+ """Return a list containing the first values in `iter`, which should
+ be Item or Album objects, that add up to the given amount of time in
+ seconds.
+ """
+ out = []
+ total_time = 0.0
+ for obj in iter:
+ length = _length(obj, album)
+ if total_time + length <= secs:
+ out.append(obj)
+ total_time += length
+ return out
+
+
+def random_objs(objs, album, number=1, time=None, equal_chance=False,
+ random_gen=None):
+ """Get a random subset of the provided `objs`.
+
+ If `number` is provided, produce that many matches. Otherwise, if
+ `time` is provided, instead select a list whose total time is close
+ to that number of minutes. If `equal_chance` is true, give each
+ artist an equal chance of being included so that artists with more
+ songs are not represented disproportionately.
+ """
+ rand = random_gen or random
+
+ # Permute the objects either in a straightforward way or an
+ # artist-balanced way.
+ if equal_chance:
+ perm = _equal_chance_permutation(objs)
+ else:
+ perm = objs
+ rand.shuffle(perm) # N.B. This shuffles the original list.
+
+ # Select objects by time our count.
+ if time:
+ return _take_time(perm, time * 60, album)
+ else:
+ return _take(perm, number)
diff --git a/lib/beets/ui/__init__.py b/lib/beets/ui/__init__.py
old mode 100755
new mode 100644
index df370b52..121cb5dc
--- a/lib/beets/ui/__init__.py
+++ b/lib/beets/ui/__init__.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
# This file is part of beets.
# Copyright 2016, Adrian Sampson.
#
@@ -18,7 +17,6 @@ interface. To invoke the CLI, just call beets.ui.main(). The actual
CLI commands are implemented in the ui.commands module.
"""
-from __future__ import division, absolute_import, print_function
import optparse
import textwrap
@@ -30,18 +28,18 @@ import re
import struct
import traceback
import os.path
-from six.moves import input
from beets import logging
from beets import library
from beets import plugins
from beets import util
-from beets.util.functemplate import Template
+from beets.util.functemplate import template
from beets import config
-from beets.util import confit, as_string
+from beets.util import as_string
from beets.autotag import mb
from beets.dbcore import query as db_query
-import six
+from beets.dbcore import db
+import confuse
# On Windows platforms, use colorama to support "ANSI" terminal colors.
if sys.platform == 'win32':
@@ -60,8 +58,8 @@ log.propagate = False # Don't propagate to root handler.
PF_KEY_QUERIES = {
- 'comp': u'comp:true',
- 'singleton': u'singleton:true',
+ 'comp': 'comp:true',
+ 'singleton': 'singleton:true',
}
@@ -111,10 +109,7 @@ def decargs(arglist):
"""Given a list of command-line argument bytestrings, attempts to
decode them to Unicode strings when running under Python 2.
"""
- if six.PY2:
- return [s.decode(util.arg_encoding()) for s in arglist]
- else:
- return arglist
+ return arglist
def print_(*strings, **kwargs):
@@ -129,29 +124,25 @@ def print_(*strings, **kwargs):
(it defaults to a newline).
"""
if not strings:
- strings = [u'']
- assert isinstance(strings[0], six.text_type)
+ strings = ['']
+ assert isinstance(strings[0], str)
- txt = u' '.join(strings)
- txt += kwargs.get('end', u'\n')
+ txt = ' '.join(strings)
+ txt += kwargs.get('end', '\n')
# Encode the string and write it to stdout.
- if six.PY2:
- # On Python 2, sys.stdout expects bytes.
+ # On Python 3, sys.stdout expects text strings and uses the
+ # exception-throwing encoding error policy. To avoid throwing
+ # errors and use our configurable encoding override, we use the
+ # underlying bytes buffer instead.
+ if hasattr(sys.stdout, 'buffer'):
out = txt.encode(_out_encoding(), 'replace')
- sys.stdout.write(out)
+ sys.stdout.buffer.write(out)
+ sys.stdout.buffer.flush()
else:
- # On Python 3, sys.stdout expects text strings and uses the
- # exception-throwing encoding error policy. To avoid throwing
- # errors and use our configurable encoding override, we use the
- # underlying bytes buffer instead.
- if hasattr(sys.stdout, 'buffer'):
- out = txt.encode(_out_encoding(), 'replace')
- sys.stdout.buffer.write(out)
- else:
- # In our test harnesses (e.g., DummyOut), sys.stdout.buffer
- # does not exist. We instead just record the text string.
- sys.stdout.write(txt)
+ # In our test harnesses (e.g., DummyOut), sys.stdout.buffer
+ # does not exist. We instead just record the text string.
+ sys.stdout.write(txt)
# Configuration wrappers.
@@ -201,19 +192,16 @@ def input_(prompt=None):
"""
# raw_input incorrectly sends prompts to stderr, not stdout, so we
# use print_() explicitly to display prompts.
- # http://bugs.python.org/issue1927
+ # https://bugs.python.org/issue1927
if prompt:
- print_(prompt, end=u' ')
+ print_(prompt, end=' ')
try:
resp = input()
except EOFError:
- raise UserError(u'stdin stream ended while input required')
+ raise UserError('stdin stream ended while input required')
- if six.PY2:
- return resp.decode(_in_encoding(), 'ignore')
- else:
- return resp
+ return resp
def input_options(options, require=False, prompt=None, fallback_prompt=None,
@@ -257,7 +245,7 @@ def input_options(options, require=False, prompt=None, fallback_prompt=None,
found_letter = letter
break
else:
- raise ValueError(u'no unambiguous lettering found')
+ raise ValueError('no unambiguous lettering found')
letters[found_letter.lower()] = option
index = option.index(found_letter)
@@ -265,7 +253,7 @@ def input_options(options, require=False, prompt=None, fallback_prompt=None,
# Mark the option's shortcut letter for display.
if not require and (
(default is None and not numrange and first) or
- (isinstance(default, six.string_types) and
+ (isinstance(default, str) and
found_letter.lower() == default.lower())):
# The first option is the default; mark it.
show_letter = '[%s]' % found_letter.upper()
@@ -301,11 +289,11 @@ def input_options(options, require=False, prompt=None, fallback_prompt=None,
prompt_part_lengths = []
if numrange:
if isinstance(default, int):
- default_name = six.text_type(default)
+ default_name = str(default)
default_name = colorize('action_default', default_name)
tmpl = '# selection (default %s)'
prompt_parts.append(tmpl % default_name)
- prompt_part_lengths.append(len(tmpl % six.text_type(default)))
+ prompt_part_lengths.append(len(tmpl % str(default)))
else:
prompt_parts.append('# selection')
prompt_part_lengths.append(len(prompt_parts[-1]))
@@ -340,9 +328,9 @@ def input_options(options, require=False, prompt=None, fallback_prompt=None,
# Make a fallback prompt too. This is displayed if the user enters
# something that is not recognized.
if not fallback_prompt:
- fallback_prompt = u'Enter one of '
+ fallback_prompt = 'Enter one of '
if numrange:
- fallback_prompt += u'%i-%i, ' % numrange
+ fallback_prompt += '%i-%i, ' % numrange
fallback_prompt += ', '.join(display_letters) + ':'
resp = input_(prompt)
@@ -381,34 +369,41 @@ def input_yn(prompt, require=False):
"yes" unless `require` is `True`, in which case there is no default.
"""
sel = input_options(
- ('y', 'n'), require, prompt, u'Enter Y or N:'
+ ('y', 'n'), require, prompt, 'Enter Y or N:'
)
- return sel == u'y'
+ return sel == 'y'
-def input_select_objects(prompt, objs, rep):
+def input_select_objects(prompt, objs, rep, prompt_all=None):
"""Prompt to user to choose all, none, or some of the given objects.
Return the list of selected objects.
`prompt` is the prompt string to use for each question (it should be
- phrased as an imperative verb). `rep` is a function to call on each
- object to print it out when confirming objects individually.
+ phrased as an imperative verb). If `prompt_all` is given, it is used
+ instead of `prompt` for the first (yes(/no/select) question.
+ `rep` is a function to call on each object to print it out when confirming
+ objects individually.
"""
choice = input_options(
- (u'y', u'n', u's'), False,
- u'%s? (Yes/no/select)' % prompt)
+ ('y', 'n', 's'), False,
+ '%s? (Yes/no/select)' % (prompt_all or prompt))
print() # Blank line.
- if choice == u'y': # Yes.
+ if choice == 'y': # Yes.
return objs
- elif choice == u's': # Select.
+ elif choice == 's': # Select.
out = []
for obj in objs:
rep(obj)
- if input_yn(u'%s? (yes/no)' % prompt, True):
+ answer = input_options(
+ ('y', 'n', 'q'), True, '%s? (yes/no/quit)' % prompt,
+ 'Enter Y or N:'
+ )
+ if answer == 'y':
out.append(obj)
- print() # go to a new line
+ elif answer == 'q':
+ return out
return out
else: # No.
@@ -419,14 +414,14 @@ def input_select_objects(prompt, objs, rep):
def human_bytes(size):
"""Formats size, a number of bytes, in a human-readable way."""
- powers = [u'', u'K', u'M', u'G', u'T', u'P', u'E', u'Z', u'Y', u'H']
+ powers = ['', 'K', 'M', 'G', 'T', 'P', 'E', 'Z', 'Y', 'H']
unit = 'B'
for power in powers:
if size < 1024:
- return u"%3.1f %s%s" % (size, power, unit)
+ return f"{size:3.1f} {power}{unit}"
size /= 1024.0
- unit = u'iB'
- return u"big"
+ unit = 'iB'
+ return "big"
def human_seconds(interval):
@@ -434,13 +429,13 @@ def human_seconds(interval):
interval using English words.
"""
units = [
- (1, u'second'),
- (60, u'minute'),
- (60, u'hour'),
- (24, u'day'),
- (7, u'week'),
- (52, u'year'),
- (10, u'decade'),
+ (1, 'second'),
+ (60, 'minute'),
+ (60, 'hour'),
+ (24, 'day'),
+ (7, 'week'),
+ (52, 'year'),
+ (10, 'decade'),
]
for i in range(len(units) - 1):
increment, suffix = units[i]
@@ -453,7 +448,7 @@ def human_seconds(interval):
increment, suffix = units[-1]
interval /= float(increment)
- return u"%3.1f %ss" % (interval, suffix)
+ return f"{interval:3.1f} {suffix}s"
def human_seconds_short(interval):
@@ -461,13 +456,13 @@ def human_seconds_short(interval):
string.
"""
interval = int(interval)
- return u'%i:%02i' % (interval // 60, interval % 60)
+ return '%i:%02i' % (interval // 60, interval % 60)
# Colorization.
# ANSI terminal colorization code heavily inspired by pygments:
-# http://dev.pocoo.org/hg/pygments-main/file/b2deea5b5030/pygments/console.py
+# https://bitbucket.org/birkenfeld/pygments-main/src/default/pygments/console.py
# (pygments is by Tim Hatch, Armin Ronacher, et al.)
COLOR_ESCAPE = "\x1b["
DARK_COLORS = {
@@ -514,7 +509,7 @@ def _colorize(color, text):
elif color in LIGHT_COLORS:
escape = COLOR_ESCAPE + "%i;01m" % (LIGHT_COLORS[color] + 30)
else:
- raise ValueError(u'no such color %s', color)
+ raise ValueError('no such color %s', color)
return escape + text + RESET_COLOR
@@ -522,22 +517,22 @@ def colorize(color_name, text):
"""Colorize text if colored output is enabled. (Like _colorize but
conditional.)
"""
- if config['ui']['color']:
- global COLORS
- if not COLORS:
- COLORS = dict((name,
- config['ui']['colors'][name].as_str())
- for name in COLOR_NAMES)
- # In case a 3rd party plugin is still passing the actual color ('red')
- # instead of the abstract color name ('text_error')
- color = COLORS.get(color_name)
- if not color:
- log.debug(u'Invalid color_name: {0}', color_name)
- color = color_name
- return _colorize(color, text)
- else:
+ if not config['ui']['color'] or 'NO_COLOR' in os.environ.keys():
return text
+ global COLORS
+ if not COLORS:
+ COLORS = {name:
+ config['ui']['colors'][name].as_str()
+ for name in COLOR_NAMES}
+ # In case a 3rd party plugin is still passing the actual color ('red')
+ # instead of the abstract color name ('text_error')
+ color = COLORS.get(color_name)
+ if not color:
+ log.debug('Invalid color_name: {0}', color_name)
+ color = color_name
+ return _colorize(color, text)
+
def _colordiff(a, b, highlight='text_highlight',
minor_highlight='text_highlight_minor'):
@@ -546,11 +541,11 @@ def _colordiff(a, b, highlight='text_highlight',
highlighted intelligently to show differences; other values are
stringified and highlighted in their entirety.
"""
- if not isinstance(a, six.string_types) \
- or not isinstance(b, six.string_types):
+ if not isinstance(a, str) \
+ or not isinstance(b, str):
# Non-strings: use ordinary equality.
- a = six.text_type(a)
- b = six.text_type(b)
+ a = str(a)
+ b = str(b)
if a == b:
return a, b
else:
@@ -588,7 +583,7 @@ def _colordiff(a, b, highlight='text_highlight',
else:
assert(False)
- return u''.join(a_out), u''.join(b_out)
+ return ''.join(a_out), ''.join(b_out)
def colordiff(a, b, highlight='text_highlight'):
@@ -598,7 +593,7 @@ def colordiff(a, b, highlight='text_highlight'):
if config['ui']['color']:
return _colordiff(a, b, highlight)
else:
- return six.text_type(a), six.text_type(b)
+ return str(a), str(b)
def get_path_formats(subview=None):
@@ -609,12 +604,12 @@ def get_path_formats(subview=None):
subview = subview or config['paths']
for query, view in subview.items():
query = PF_KEY_QUERIES.get(query, query) # Expand common queries.
- path_formats.append((query, Template(view.as_str())))
+ path_formats.append((query, template(view.as_str())))
return path_formats
def get_replacements():
- """Confit validation function that reads regex/string pairs.
+ """Confuse validation function that reads regex/string pairs.
"""
replacements = []
for pattern, repl in config['replace'].get(dict).items():
@@ -623,7 +618,7 @@ def get_replacements():
replacements.append((re.compile(pattern), repl))
except re.error:
raise UserError(
- u'malformed regular expression in replace: {0}'.format(
+ 'malformed regular expression in replace: {}'.format(
pattern
)
)
@@ -644,7 +639,7 @@ def term_width():
try:
buf = fcntl.ioctl(0, termios.TIOCGWINSZ, ' ' * 4)
- except IOError:
+ except OSError:
return fallback
try:
height, width = struct.unpack('hh', buf)
@@ -656,10 +651,10 @@ def term_width():
FLOAT_EPSILON = 0.01
-def _field_diff(field, old, new):
- """Given two Model objects, format their values for `field` and
- highlight changes among them. Return a human-readable string. If the
- value has not changed, return None instead.
+def _field_diff(field, old, old_fmt, new, new_fmt):
+ """Given two Model objects and their formatted views, format their values
+ for `field` and highlight changes among them. Return a human-readable
+ string. If the value has not changed, return None instead.
"""
oldval = old.get(field)
newval = new.get(field)
@@ -672,18 +667,18 @@ def _field_diff(field, old, new):
return None
# Get formatted values for output.
- oldstr = old.formatted().get(field, u'')
- newstr = new.formatted().get(field, u'')
+ oldstr = old_fmt.get(field, '')
+ newstr = new_fmt.get(field, '')
# For strings, highlight changes. For others, colorize the whole
# thing.
- if isinstance(oldval, six.string_types):
+ if isinstance(oldval, str):
oldstr, newstr = colordiff(oldval, newstr)
else:
oldstr = colorize('text_error', oldstr)
newstr = colorize('text_error', newstr)
- return u'{0} -> {1}'.format(oldstr, newstr)
+ return f'{oldstr} -> {newstr}'
def show_model_changes(new, old=None, fields=None, always=False):
@@ -698,6 +693,11 @@ def show_model_changes(new, old=None, fields=None, always=False):
"""
old = old or new._db._get(type(new), new.id)
+ # Keep the formatted views around instead of re-creating them in each
+ # iteration step
+ old_fmt = old.formatted()
+ new_fmt = new.formatted()
+
# Build up lines showing changed fields.
changes = []
for field in old:
@@ -706,25 +706,25 @@ def show_model_changes(new, old=None, fields=None, always=False):
continue
# Detect and show difference for this field.
- line = _field_diff(field, old, new)
+ line = _field_diff(field, old, old_fmt, new, new_fmt)
if line:
- changes.append(u' {0}: {1}'.format(field, line))
+ changes.append(f' {field}: {line}')
# New fields.
for field in set(new) - set(old):
if fields and field not in fields:
continue
- changes.append(u' {0}: {1}'.format(
+ changes.append(' {}: {}'.format(
field,
- colorize('text_highlight', new.formatted()[field])
+ colorize('text_highlight', new_fmt[field])
))
# Print changes.
if changes or always:
print_(format(old))
if changes:
- print_(u'\n'.join(changes))
+ print_('\n'.join(changes))
return bool(changes)
@@ -757,18 +757,55 @@ def show_path_changes(path_changes):
if max_width > col_width:
# Print every change over two lines
for source, dest in zip(sources, destinations):
- log.info(u'{0} \n -> {1}', source, dest)
+ color_source, color_dest = colordiff(source, dest)
+ print_('{0} \n -> {1}'.format(color_source, color_dest))
else:
# Print every change on a single line, and add a header
title_pad = max_width - len('Source ') + len(' -> ')
- log.info(u'Source {0} Destination', ' ' * title_pad)
+ print_('Source {0} Destination'.format(' ' * title_pad))
for source, dest in zip(sources, destinations):
pad = max_width - len(source)
- log.info(u'{0} {1} -> {2}', source, ' ' * pad, dest)
+ color_source, color_dest = colordiff(source, dest)
+ print_('{0} {1} -> {2}'.format(
+ color_source,
+ ' ' * pad,
+ color_dest,
+ ))
-class CommonOptionsParser(optparse.OptionParser, object):
+# Helper functions for option parsing.
+
+def _store_dict(option, opt_str, value, parser):
+ """Custom action callback to parse options which have ``key=value``
+ pairs as values. All such pairs passed for this option are
+ aggregated into a dictionary.
+ """
+ dest = option.dest
+ option_values = getattr(parser.values, dest, None)
+
+ if option_values is None:
+ # This is the first supplied ``key=value`` pair of option.
+ # Initialize empty dictionary and get a reference to it.
+ setattr(parser.values, dest, {})
+ option_values = getattr(parser.values, dest)
+
+ # Decode the argument using the platform's argument encoding.
+ value = util.text_string(value, util.arg_encoding())
+
+ try:
+ key, value = value.split('=', 1)
+ if not (key and value):
+ raise ValueError
+ except ValueError:
+ raise UserError(
+ "supplied argument `{}' is not of the form `key=value'"
+ .format(value))
+
+ option_values[key] = value
+
+
+class CommonOptionsParser(optparse.OptionParser):
"""Offers a simple way to add common formatting options.
Options available include:
@@ -783,8 +820,9 @@ class CommonOptionsParser(optparse.OptionParser, object):
Each method is fully documented in the related method.
"""
+
def __init__(self, *args, **kwargs):
- super(CommonOptionsParser, self).__init__(*args, **kwargs)
+ super().__init__(*args, **kwargs)
self._album_flags = False
# this serves both as an indicator that we offer the feature AND allows
# us to check whether it has been specified on the CLI - bypassing the
@@ -798,7 +836,7 @@ class CommonOptionsParser(optparse.OptionParser, object):
Sets the album property on the options extracted from the CLI.
"""
album = optparse.Option(*flags, action='store_true',
- help=u'match albums instead of tracks')
+ help='match albums instead of tracks')
self.add_option(album)
self._album_flags = set(flags)
@@ -816,7 +854,7 @@ class CommonOptionsParser(optparse.OptionParser, object):
elif value:
value, = decargs([value])
else:
- value = u''
+ value = ''
parser.values.format = value
if target:
@@ -843,14 +881,14 @@ class CommonOptionsParser(optparse.OptionParser, object):
By default this affects both items and albums. If add_album_option()
is used then the target will be autodetected.
- Sets the format property to u'$path' on the options extracted from the
+ Sets the format property to '$path' on the options extracted from the
CLI.
"""
path = optparse.Option(*flags, nargs=0, action='callback',
callback=self._set_format,
- callback_kwargs={'fmt': u'$path',
+ callback_kwargs={'fmt': '$path',
'store_true': True},
- help=u'print paths for matched items or albums')
+ help='print paths for matched items or albums')
self.add_option(path)
def add_format_option(self, flags=('-f', '--format'), target=None):
@@ -870,7 +908,7 @@ class CommonOptionsParser(optparse.OptionParser, object):
"""
kwargs = {}
if target:
- if isinstance(target, six.string_types):
+ if isinstance(target, str):
target = {'item': library.Item,
'album': library.Album}[target]
kwargs['target'] = target
@@ -878,7 +916,7 @@ class CommonOptionsParser(optparse.OptionParser, object):
opt = optparse.Option(*flags, action='callback',
callback=self._set_format,
callback_kwargs=kwargs,
- help=u'print with custom format')
+ help='print with custom format')
self.add_option(opt)
def add_all_common_options(self):
@@ -893,14 +931,15 @@ class CommonOptionsParser(optparse.OptionParser, object):
#
# This is a fairly generic subcommand parser for optparse. It is
# maintained externally here:
-# http://gist.github.com/462717
+# https://gist.github.com/462717
# There you will also find a better description of the code and a more
# succinct example program.
-class Subcommand(object):
+class Subcommand:
"""A subcommand of a root command-line application that may be
invoked by a SubcommandOptionParser.
"""
+
def __init__(self, name, parser=None, help='', aliases=(), hide=False):
"""Creates a new subcommand. name is the primary way to invoke
the subcommand; aliases are alternate names. parser is an
@@ -928,7 +967,7 @@ class Subcommand(object):
@root_parser.setter
def root_parser(self, root_parser):
self._root_parser = root_parser
- self.parser.prog = '{0} {1}'.format(
+ self.parser.prog = '{} {}'.format(
as_string(root_parser.get_prog_name()), self.name)
@@ -944,13 +983,13 @@ class SubcommandsOptionParser(CommonOptionsParser):
"""
# A more helpful default usage.
if 'usage' not in kwargs:
- kwargs['usage'] = u"""
+ kwargs['usage'] = """
%prog COMMAND [ARGS...]
%prog help COMMAND"""
kwargs['add_help_option'] = False
# Super constructor.
- super(SubcommandsOptionParser, self).__init__(*args, **kwargs)
+ super().__init__(*args, **kwargs)
# Our root parser needs to stop on the first unrecognized argument.
self.disable_interspersed_args()
@@ -967,7 +1006,7 @@ class SubcommandsOptionParser(CommonOptionsParser):
# Add the list of subcommands to the help message.
def format_help(self, formatter=None):
# Get the original help message, to which we will append.
- out = super(SubcommandsOptionParser, self).format_help(formatter)
+ out = super().format_help(formatter)
if formatter is None:
formatter = self.formatter
@@ -1053,7 +1092,7 @@ class SubcommandsOptionParser(CommonOptionsParser):
cmdname = args.pop(0)
subcommand = self._subcommand_for_name(cmdname)
if not subcommand:
- raise UserError(u"unknown command '{0}'".format(cmdname))
+ raise UserError(f"unknown command '{cmdname}'")
suboptions, subargs = subcommand.parse_args(args)
return subcommand, suboptions, subargs
@@ -1064,26 +1103,32 @@ optparse.Option.ALWAYS_TYPED_ACTIONS += ('callback',)
# The main entry point and bootstrapping.
-def _load_plugins(config):
- """Load the plugins specified in the configuration.
+def _load_plugins(options, config):
+ """Load the plugins specified on the command line or in the configuration.
"""
paths = config['pluginpath'].as_str_seq(split=False)
paths = [util.normpath(p) for p in paths]
- log.debug(u'plugin paths: {0}', util.displayable_path(paths))
+ log.debug('plugin paths: {0}', util.displayable_path(paths))
# On Python 3, the search paths need to be unicode.
paths = [util.py3_path(p) for p in paths]
# Extend the `beetsplug` package to include the plugin paths.
import beetsplug
- beetsplug.__path__ = paths + beetsplug.__path__
+ beetsplug.__path__ = paths + list(beetsplug.__path__)
# For backwards compatibility, also support plugin paths that
# *contain* a `beetsplug` package.
sys.path += paths
- plugins.load_plugins(config['plugins'].as_str_seq())
- plugins.send("pluginload")
+ # If we were given any plugins on the command line, use those.
+ if options.plugins is not None:
+ plugin_list = (options.plugins.split(',')
+ if len(options.plugins) > 0 else [])
+ else:
+ plugin_list = config['plugins'].as_str_seq()
+
+ plugins.load_plugins(plugin_list)
return plugins
@@ -1097,7 +1142,20 @@ def _setup(options, lib=None):
config = _configure(options)
- plugins = _load_plugins(config)
+ plugins = _load_plugins(options, config)
+
+ # Add types and queries defined by plugins.
+ plugin_types_album = plugins.types(library.Album)
+ library.Album._types.update(plugin_types_album)
+ item_types = plugin_types_album.copy()
+ item_types.update(library.Item._types)
+ item_types.update(plugins.types(library.Item))
+ library.Item._types = item_types
+
+ library.Item._queries.update(plugins.named_queries(library.Item))
+ library.Album._queries.update(plugins.named_queries(library.Album))
+
+ plugins.send("pluginload")
# Get the default subcommands.
from beets.ui.commands import default_commands
@@ -1108,8 +1166,6 @@ def _setup(options, lib=None):
if lib is None:
lib = _open_library(config)
plugins.send("library_opened", lib=lib)
- library.Item._types.update(plugins.types(library.Item))
- library.Album._types.update(plugins.types(library.Album))
return subcommands, plugins, lib
@@ -1121,9 +1177,11 @@ def _configure(options):
# special handling lets specified plugins get loaded before we
# finish parsing the command line.
if getattr(options, 'config', None) is not None:
- config_path = options.config
+ overlay_path = options.config
del options.config
- config.set_file(config_path)
+ config.set_file(overlay_path)
+ else:
+ overlay_path = None
config.set_args(options)
# Configure the logger.
@@ -1132,15 +1190,19 @@ def _configure(options):
else:
log.set_global_level(logging.INFO)
+ if overlay_path:
+ log.debug('overlaying configuration: {0}',
+ util.displayable_path(overlay_path))
+
config_path = config.user_config_path()
if os.path.isfile(config_path):
- log.debug(u'user configuration: {0}',
+ log.debug('user configuration: {0}',
util.displayable_path(config_path))
else:
- log.debug(u'no user configuration found at {0}',
+ log.debug('no user configuration found at {0}',
util.displayable_path(config_path))
- log.debug(u'data directory: {0}',
+ log.debug('data directory: {0}',
util.displayable_path(config.config_dir()))
return config
@@ -1157,13 +1219,14 @@ def _open_library(config):
get_replacements(),
)
lib.get_item(0) # Test database connection.
- except (sqlite3.OperationalError, sqlite3.DatabaseError):
- log.debug(u'{}', traceback.format_exc())
- raise UserError(u"database file {0} could not be opened".format(
- util.displayable_path(dbpath)
+ except (sqlite3.OperationalError, sqlite3.DatabaseError) as db_error:
+ log.debug('{}', traceback.format_exc())
+ raise UserError("database file {} cannot not be opened: {}".format(
+ util.displayable_path(dbpath),
+ db_error
))
- log.debug(u'library database: {0}\n'
- u'library directory: {1}',
+ log.debug('library database: {0}\n'
+ 'library directory: {1}',
util.displayable_path(lib.path),
util.displayable_path(lib.directory))
return lib
@@ -1177,15 +1240,17 @@ def _raw_main(args, lib=None):
parser.add_format_option(flags=('--format-item',), target=library.Item)
parser.add_format_option(flags=('--format-album',), target=library.Album)
parser.add_option('-l', '--library', dest='library',
- help=u'library database file to use')
+ help='library database file to use')
parser.add_option('-d', '--directory', dest='directory',
- help=u"destination music directory")
+ help="destination music directory")
parser.add_option('-v', '--verbose', dest='verbose', action='count',
- help=u'log more details (use twice for even more)')
+ help='log more details (use twice for even more)')
parser.add_option('-c', '--config', dest='config',
- help=u'path to configuration file')
+ help='path to configuration file')
+ parser.add_option('-p', '--plugins', dest='plugins',
+ help='a comma-separated list of plugins to load')
parser.add_option('-h', '--help', dest='help', action='store_true',
- help=u'show this help message and exit')
+ help='show this help message and exit')
parser.add_option('--version', dest='version', action='store_true',
help=optparse.SUPPRESS_HELP)
@@ -1220,7 +1285,7 @@ def main(args=None):
_raw_main(args)
except UserError as exc:
message = exc.args[0] if exc.args else None
- log.error(u'error: {0}', message)
+ log.error('error: {0}', message)
sys.exit(1)
except util.HumanReadableException as exc:
exc.log(log)
@@ -1231,18 +1296,25 @@ def main(args=None):
log.debug('{}', traceback.format_exc())
log.error('{}', exc)
sys.exit(1)
- except confit.ConfigError as exc:
- log.error(u'configuration error: {0}', exc)
+ except confuse.ConfigError as exc:
+ log.error('configuration error: {0}', exc)
sys.exit(1)
except db_query.InvalidQueryError as exc:
- log.error(u'invalid query: {0}', exc)
+ log.error('invalid query: {0}', exc)
sys.exit(1)
- except IOError as exc:
+ except OSError as exc:
if exc.errno == errno.EPIPE:
# "Broken pipe". End silently.
- pass
+ sys.stderr.close()
else:
raise
except KeyboardInterrupt:
# Silently ignore ^C except in verbose mode.
- log.debug(u'{}', traceback.format_exc())
+ log.debug('{}', traceback.format_exc())
+ except db.DBAccessError as exc:
+ log.error(
+ 'database access error: {0}\n'
+ 'the library file might have a permissions problem',
+ exc
+ )
+ sys.exit(1)
diff --git a/lib/beets/ui/commands.py b/lib/beets/ui/commands.py
index 8a07f614..3a337401 100755
--- a/lib/beets/ui/commands.py
+++ b/lib/beets/ui/commands.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
# This file is part of beets.
# Copyright 2016, Adrian Sampson.
#
@@ -17,7 +16,6 @@
interface.
"""
-from __future__ import division, absolute_import, print_function
import os
import re
@@ -34,14 +32,15 @@ from beets.autotag import hooks
from beets import plugins
from beets import importer
from beets import util
-from beets.util import syspath, normpath, ancestry, displayable_path
+from beets.util import syspath, normpath, ancestry, displayable_path, \
+ MoveOperation
from beets import library
from beets import config
from beets import logging
-from beets.util.confit import _package_path
-import six
-VARIOUS_ARTISTS = u'Various Artists'
+from . import _store_dict
+
+VARIOUS_ARTISTS = 'Various Artists'
PromptChoice = namedtuple('PromptChoice', ['short', 'long', 'callback'])
# Global logger.
@@ -73,9 +72,9 @@ def _do_query(lib, query, album, also_items=True):
items = list(lib.items(query))
if album and not albums:
- raise ui.UserError(u'No matching albums found.')
+ raise ui.UserError('No matching albums found.')
elif not album and not items:
- raise ui.UserError(u'No matching items found.')
+ raise ui.UserError('No matching items found.')
return items, albums
@@ -84,36 +83,37 @@ def _do_query(lib, query, album, also_items=True):
def _print_keys(query):
"""Given a SQLite query result, print the `key` field of each
- returned row, with identation of 2 spaces.
+ returned row, with indentation of 2 spaces.
"""
for row in query:
- print_(u' ' * 2 + row['key'])
+ print_(' ' * 2 + row['key'])
def fields_func(lib, opts, args):
def _print_rows(names):
names.sort()
- print_(u' ' + u'\n '.join(names))
+ print_(' ' + '\n '.join(names))
- print_(u"Item fields:")
+ print_("Item fields:")
_print_rows(library.Item.all_keys())
- print_(u"Album fields:")
+ print_("Album fields:")
_print_rows(library.Album.all_keys())
with lib.transaction() as tx:
# The SQL uses the DISTINCT to get unique values from the query
unique_fields = 'SELECT DISTINCT key FROM (%s)'
- print_(u"Item flexible attributes:")
+ print_("Item flexible attributes:")
_print_keys(tx.query(unique_fields % library.Item._flex_table))
- print_(u"Album flexible attributes:")
+ print_("Album flexible attributes:")
_print_keys(tx.query(unique_fields % library.Album._flex_table))
+
fields_cmd = ui.Subcommand(
'fields',
- help=u'show fields available for queries and format strings'
+ help='show fields available for queries and format strings'
)
fields_cmd.func = fields_func
default_commands.append(fields_cmd)
@@ -124,9 +124,9 @@ default_commands.append(fields_cmd)
class HelpCommand(ui.Subcommand):
def __init__(self):
- super(HelpCommand, self).__init__(
+ super().__init__(
'help', aliases=('?',),
- help=u'give detailed help on a specific sub-command',
+ help='give detailed help on a specific sub-command',
)
def func(self, lib, opts, args):
@@ -134,7 +134,7 @@ class HelpCommand(ui.Subcommand):
cmdname = args[0]
helpcommand = self.root_parser._subcommand_for_name(cmdname)
if not helpcommand:
- raise ui.UserError(u"unknown command '{0}'".format(cmdname))
+ raise ui.UserError(f"unknown command '{cmdname}'")
helpcommand.print_help()
else:
self.root_parser.print_help()
@@ -159,29 +159,31 @@ def disambig_string(info):
if isinstance(info, hooks.AlbumInfo):
if info.media:
if info.mediums and info.mediums > 1:
- disambig.append(u'{0}x{1}'.format(
+ disambig.append('{}x{}'.format(
info.mediums, info.media
))
else:
disambig.append(info.media)
if info.year:
- disambig.append(six.text_type(info.year))
+ disambig.append(str(info.year))
if info.country:
disambig.append(info.country)
if info.label:
disambig.append(info.label)
+ if info.catalognum:
+ disambig.append(info.catalognum)
if info.albumdisambig:
disambig.append(info.albumdisambig)
if disambig:
- return u', '.join(disambig)
+ return ', '.join(disambig)
def dist_string(dist):
"""Formats a distance (a float) as a colorized similarity percentage
string.
"""
- out = u'%.1f%%' % ((1 - dist) * 100)
+ out = '%.1f%%' % ((1 - dist) * 100)
if dist <= config['match']['strong_rec_thresh'].as_number():
out = ui.colorize('text_success', out)
elif dist <= config['match']['medium_rec_thresh'].as_number():
@@ -204,7 +206,7 @@ def penalty_string(distance, limit=None):
if penalties:
if limit and len(penalties) > limit:
penalties = penalties[:limit] + ['...']
- return ui.colorize('text_warning', u'(%s)' % ', '.join(penalties))
+ return ui.colorize('text_warning', '(%s)' % ', '.join(penalties))
def show_change(cur_artist, cur_album, match):
@@ -214,11 +216,11 @@ def show_change(cur_artist, cur_album, match):
"""
def show_album(artist, album):
if artist:
- album_description = u' %s - %s' % (artist, album)
+ album_description = f' {artist} - {album}'
elif album:
- album_description = u' %s' % album
+ album_description = ' %s' % album
else:
- album_description = u' (unknown album)'
+ album_description = ' (unknown album)'
print_(album_description)
def format_index(track_info):
@@ -235,41 +237,45 @@ def show_change(cur_artist, cur_album, match):
medium = track_info.disc
mediums = track_info.disctotal
if config['per_disc_numbering']:
- if mediums > 1:
- return u'{0}-{1}'.format(medium, medium_index)
+ if mediums and mediums > 1:
+ return f'{medium}-{medium_index}'
else:
- return six.text_type(medium_index or index)
+ return str(medium_index if medium_index is not None
+ else index)
else:
- return six.text_type(index)
+ return str(index)
# Identify the album in question.
if cur_artist != match.info.artist or \
(cur_album != match.info.album and
match.info.album != VARIOUS_ARTISTS):
artist_l, artist_r = cur_artist or '', match.info.artist
- album_l, album_r = cur_album or '', match.info.album
+ album_l, album_r = cur_album or '', match.info.album
if artist_r == VARIOUS_ARTISTS:
# Hide artists for VA releases.
- artist_l, artist_r = u'', u''
+ artist_l, artist_r = '', ''
+
+ if config['artist_credit']:
+ artist_r = match.info.artist_credit
artist_l, artist_r = ui.colordiff(artist_l, artist_r)
album_l, album_r = ui.colordiff(album_l, album_r)
- print_(u"Correcting tags from:")
+ print_("Correcting tags from:")
show_album(artist_l, album_l)
- print_(u"To:")
+ print_("To:")
show_album(artist_r, album_r)
else:
- print_(u"Tagging:\n {0.artist} - {0.album}".format(match.info))
+ print_("Tagging:\n {0.artist} - {0.album}".format(match.info))
# Data URL.
if match.info.data_url:
- print_(u'URL:\n %s' % match.info.data_url)
+ print_('URL:\n %s' % match.info.data_url)
# Info line.
info = []
# Similarity.
- info.append(u'(Similarity: %s)' % dist_string(match.distance))
+ info.append('(Similarity: %s)' % dist_string(match.distance))
# Penalties.
penalties = penalty_string(match.distance)
if penalties:
@@ -277,7 +283,7 @@ def show_change(cur_artist, cur_album, match):
# Disambiguation.
disambig = disambig_string(match.info)
if disambig:
- info.append(ui.colorize('text_highlight_minor', u'(%s)' % disambig))
+ info.append(ui.colorize('text_highlight_minor', '(%s)' % disambig))
print_(' '.join(info))
# Tracks.
@@ -295,16 +301,16 @@ def show_change(cur_artist, cur_album, match):
if medium != track_info.medium or disctitle != track_info.disctitle:
media = match.info.media or 'Media'
if match.info.mediums > 1 and track_info.disctitle:
- lhs = u'%s %s: %s' % (media, track_info.medium,
- track_info.disctitle)
+ lhs = '{} {}: {}'.format(media, track_info.medium,
+ track_info.disctitle)
elif match.info.mediums > 1:
- lhs = u'%s %s' % (media, track_info.medium)
+ lhs = f'{media} {track_info.medium}'
elif track_info.disctitle:
- lhs = u'%s: %s' % (media, track_info.disctitle)
+ lhs = f'{media}: {track_info.disctitle}'
else:
lhs = None
if lhs:
- lines.append((lhs, u'', 0))
+ lines.append((lhs, '', 0))
medium, disctitle = track_info.medium, track_info.disctitle
# Titles.
@@ -325,7 +331,7 @@ def show_change(cur_artist, cur_album, match):
color = 'text_highlight_minor'
else:
color = 'text_highlight'
- templ = ui.colorize(color, u' (#{0})')
+ templ = ui.colorize(color, ' (#{0})')
lhs += templ.format(cur_track)
rhs += templ.format(new_track)
lhs_width += len(cur_track) + 4
@@ -336,7 +342,7 @@ def show_change(cur_artist, cur_album, match):
config['ui']['length_diff_thresh'].as_number():
cur_length = ui.human_seconds_short(item.length)
new_length = ui.human_seconds_short(track_info.length)
- templ = ui.colorize('text_highlight', u' ({0})')
+ templ = ui.colorize('text_highlight', ' ({0})')
lhs += templ.format(cur_length)
rhs += templ.format(new_length)
lhs_width += len(cur_length) + 3
@@ -347,9 +353,9 @@ def show_change(cur_artist, cur_album, match):
rhs += ' %s' % penalties
if lhs != rhs:
- lines.append((u' * %s' % lhs, rhs, lhs_width))
+ lines.append((' * %s' % lhs, rhs, lhs_width))
elif config['import']['detail']:
- lines.append((u' * %s' % lhs, '', lhs_width))
+ lines.append((' * %s' % lhs, '', lhs_width))
# Print each track in two columns, or across two lines.
col_width = (ui.term_width() - len(''.join([' * ', ' -> ']))) // 2
@@ -359,29 +365,36 @@ def show_change(cur_artist, cur_album, match):
if not rhs:
print_(lhs)
elif max_width > col_width:
- print_(u'%s ->\n %s' % (lhs, rhs))
+ print_(f'{lhs} ->\n {rhs}')
else:
pad = max_width - lhs_width
- print_(u'%s%s -> %s' % (lhs, ' ' * pad, rhs))
+ print_('{}{} -> {}'.format(lhs, ' ' * pad, rhs))
# Missing and unmatched tracks.
if match.extra_tracks:
- print_(u'Missing tracks ({0}/{1} - {2:.1%}):'.format(
+ print_('Missing tracks ({}/{} - {:.1%}):'.format(
len(match.extra_tracks),
len(match.info.tracks),
len(match.extra_tracks) / len(match.info.tracks)
))
+ pad_width = max(len(track_info.title) for track_info in
+ match.extra_tracks)
for track_info in match.extra_tracks:
- line = u' ! %s (#%s)' % (track_info.title, format_index(track_info))
+ line = ' ! {0: <{width}} (#{1: >2})'.format(track_info.title,
+ format_index(track_info),
+ width=pad_width)
if track_info.length:
- line += u' (%s)' % ui.human_seconds_short(track_info.length)
+ line += ' (%s)' % ui.human_seconds_short(track_info.length)
print_(ui.colorize('text_warning', line))
if match.extra_items:
- print_(u'Unmatched tracks ({0}):'.format(len(match.extra_items)))
+ print_('Unmatched tracks ({}):'.format(len(match.extra_items)))
+ pad_width = max(len(item.title) for item in match.extra_items)
for item in match.extra_items:
- line = u' ! %s (#%s)' % (item.title, format_index(item))
+ line = ' ! {0: <{width}} (#{1: >2})'.format(item.title,
+ format_index(item),
+ width=pad_width)
if item.length:
- line += u' (%s)' % ui.human_seconds_short(item.length)
+ line += ' (%s)' % ui.human_seconds_short(item.length)
print_(ui.colorize('text_warning', line))
@@ -396,22 +409,22 @@ def show_item_change(item, match):
cur_artist, new_artist = ui.colordiff(cur_artist, new_artist)
cur_title, new_title = ui.colordiff(cur_title, new_title)
- print_(u"Correcting track tags from:")
- print_(u" %s - %s" % (cur_artist, cur_title))
- print_(u"To:")
- print_(u" %s - %s" % (new_artist, new_title))
+ print_("Correcting track tags from:")
+ print_(f" {cur_artist} - {cur_title}")
+ print_("To:")
+ print_(f" {new_artist} - {new_title}")
else:
- print_(u"Tagging track: %s - %s" % (cur_artist, cur_title))
+ print_(f"Tagging track: {cur_artist} - {cur_title}")
# Data URL.
if match.info.data_url:
- print_(u'URL:\n %s' % match.info.data_url)
+ print_('URL:\n %s' % match.info.data_url)
# Info line.
info = []
# Similarity.
- info.append(u'(Similarity: %s)' % dist_string(match.distance))
+ info.append('(Similarity: %s)' % dist_string(match.distance))
# Penalties.
penalties = penalty_string(match.distance)
if penalties:
@@ -419,7 +432,7 @@ def show_item_change(item, match):
# Disambiguation.
disambig = disambig_string(match.info)
if disambig:
- info.append(ui.colorize('text_highlight_minor', u'(%s)' % disambig))
+ info.append(ui.colorize('text_highlight_minor', '(%s)' % disambig))
print_(' '.join(info))
@@ -433,7 +446,7 @@ def summarize_items(items, singleton):
"""
summary_parts = []
if not singleton:
- summary_parts.append(u"{0} items".format(len(items)))
+ summary_parts.append("{} items".format(len(items)))
format_counts = {}
for item in items:
@@ -447,26 +460,31 @@ def summarize_items(items, singleton):
format_counts.items(),
key=lambda fmt_and_count: (-fmt_and_count[1], fmt_and_count[0])
):
- summary_parts.append('{0} {1}'.format(fmt, count))
+ summary_parts.append(f'{fmt} {count}')
if items:
average_bitrate = sum([item.bitrate for item in items]) / len(items)
total_duration = sum([item.length for item in items])
total_filesize = sum([item.filesize for item in items])
- summary_parts.append(u'{0}kbps'.format(int(average_bitrate / 1000)))
+ summary_parts.append('{}kbps'.format(int(average_bitrate / 1000)))
+ if items[0].format == "FLAC":
+ sample_bits = '{}kHz/{} bit'.format(
+ round(int(items[0].samplerate) / 1000, 1), items[0].bitdepth)
+ summary_parts.append(sample_bits)
summary_parts.append(ui.human_seconds_short(total_duration))
summary_parts.append(ui.human_bytes(total_filesize))
- return u', '.join(summary_parts)
+ return ', '.join(summary_parts)
def _summary_judgment(rec):
"""Determines whether a decision should be made without even asking
the user. This occurs in quiet mode and when an action is chosen for
- NONE recommendations. Return an action or None if the user should be
- queried. May also print to the console if a summary judgment is
- made.
+ NONE recommendations. Return None if the user should be queried.
+ Otherwise, returns an action. May also print to the console if a
+ summary judgment is made.
"""
+
if config['import']['quiet']:
if rec == Recommendation.strong:
return importer.action.APPLY
@@ -475,21 +493,21 @@ def _summary_judgment(rec):
'skip': importer.action.SKIP,
'asis': importer.action.ASIS,
})
-
+ elif config['import']['timid']:
+ return None
elif rec == Recommendation.none:
action = config['import']['none_rec_action'].as_choice({
'skip': importer.action.SKIP,
'asis': importer.action.ASIS,
'ask': None,
})
-
else:
return None
if action == importer.action.SKIP:
- print_(u'Skipping.')
+ print_('Skipping.')
elif action == importer.action.ASIS:
- print_(u'Importing as-is.')
+ print_('Importing as-is.')
return action
@@ -524,12 +542,12 @@ def choose_candidate(candidates, singleton, rec, cur_artist=None,
# Zero candidates.
if not candidates:
if singleton:
- print_(u"No matching recordings found.")
+ print_("No matching recordings found.")
else:
- print_(u"No matching release found for {0} tracks."
+ print_("No matching release found for {} tracks."
.format(itemcount))
- print_(u'For help, see: '
- u'http://beets.readthedocs.org/en/latest/faq.html#nomatch')
+ print_('For help, see: '
+ 'https://beets.readthedocs.org/en/latest/faq.html#nomatch')
sel = ui.input_options(choice_opts)
if sel in choice_actions:
return choice_actions[sel]
@@ -548,22 +566,22 @@ def choose_candidate(candidates, singleton, rec, cur_artist=None,
if not bypass_candidates:
# Display list of candidates.
- print_(u'Finding tags for {0} "{1} - {2}".'.format(
- u'track' if singleton else u'album',
+ print_('Finding tags for {} "{} - {}".'.format(
+ 'track' if singleton else 'album',
item.artist if singleton else cur_artist,
item.title if singleton else cur_album,
))
- print_(u'Candidates:')
+ print_('Candidates:')
for i, match in enumerate(candidates):
# Index, metadata, and distance.
line = [
- u'{0}.'.format(i + 1),
- u'{0} - {1}'.format(
+ '{}.'.format(i + 1),
+ '{} - {}'.format(
match.info.artist,
match.info.title if singleton else match.info.album,
),
- u'({0})'.format(dist_string(match.distance)),
+ '({})'.format(dist_string(match.distance)),
]
# Penalties.
@@ -575,14 +593,14 @@ def choose_candidate(candidates, singleton, rec, cur_artist=None,
disambig = disambig_string(match.info)
if disambig:
line.append(ui.colorize('text_highlight_minor',
- u'(%s)' % disambig))
+ '(%s)' % disambig))
- print_(u' '.join(line))
+ print_(' '.join(line))
# Ask the user for a choice.
sel = ui.input_options(choice_opts,
numrange=(1, len(candidates)))
- if sel == u'm':
+ if sel == 'm':
pass
elif sel in choice_actions:
return choice_actions[sel]
@@ -606,16 +624,19 @@ def choose_candidate(candidates, singleton, rec, cur_artist=None,
# Ask for confirmation.
default = config['import']['default_action'].as_choice({
- u'apply': u'a',
- u'skip': u's',
- u'asis': u'u',
- u'none': None,
+ 'apply': 'a',
+ 'skip': 's',
+ 'asis': 'u',
+ 'none': None,
})
if default is None:
require = True
- sel = ui.input_options((u'Apply', u'More candidates') + choice_opts,
+ # Bell ring when user interaction is needed.
+ if config['import']['bell']:
+ ui.print_('\a', end='')
+ sel = ui.input_options(('Apply', 'More candidates') + choice_opts,
require=require, default=default)
- if sel == u'a':
+ if sel == 'a':
return match
elif sel in choice_actions:
return choice_actions[sel]
@@ -627,8 +648,8 @@ def manual_search(session, task):
Input either an artist and album (for full albums) or artist and
track name (for singletons) for manual search.
"""
- artist = input_(u'Artist:').strip()
- name = input_(u'Album:' if task.is_album else u'Track:').strip()
+ artist = input_('Artist:').strip()
+ name = input_('Album:' if task.is_album else 'Track:').strip()
if task.is_album:
_, _, prop = autotag.tag_album(
@@ -644,8 +665,8 @@ def manual_id(session, task):
Input an ID, either for an album ("release") or a track ("recording").
"""
- prompt = u'Enter {0} ID:'.format(u'release' if task.is_album
- else u'recording')
+ prompt = 'Enter {} ID:'.format('release' if task.is_album
+ else 'recording')
search_id = input_(prompt).strip()
if task.is_album:
@@ -666,6 +687,7 @@ def abort_action(session, task):
class TerminalImportSession(importer.ImportSession):
"""An import session that runs in a terminal.
"""
+
def choose_match(self, task):
"""Given an initial autotagging of items, go through an interactive
dance with the user to ask for a choice of metadata. Returns an
@@ -673,8 +695,21 @@ class TerminalImportSession(importer.ImportSession):
"""
# Show what we're tagging.
print_()
- print_(displayable_path(task.paths, u'\n') +
- u' ({0} items)'.format(len(task.items)))
+ print_(displayable_path(task.paths, '\n') +
+ ' ({} items)'.format(len(task.items)))
+
+ # Let plugins display info or prompt the user before we go through the
+ # process of selecting candidate.
+ results = plugins.send('import_task_before_choice',
+ session=self, task=task)
+ actions = [action for action in results if action]
+
+ if len(actions) == 1:
+ return actions[0]
+ elif len(actions) > 1:
+ raise plugins.PluginConflictException(
+ 'Only one handler for `import_task_before_choice` may return '
+ 'an action.')
# Take immediate action if appropriate.
action = _summary_judgment(task.rec)
@@ -686,7 +721,6 @@ class TerminalImportSession(importer.ImportSession):
return action
# Loop until we have a choice.
- candidates, rec = task.candidates, task.rec
while True:
# Ask for a choice from the user. The result of
# `choose_candidate` may be an `importer.action`, an
@@ -694,8 +728,8 @@ class TerminalImportSession(importer.ImportSession):
# `PromptChoice`.
choices = self._get_choices(task)
choice = choose_candidate(
- candidates, False, rec, task.cur_artist, task.cur_album,
- itemcount=len(task.items), choices=choices
+ task.candidates, False, task.rec, task.cur_artist,
+ task.cur_album, itemcount=len(task.items), choices=choices
)
# Basic choices that require no more action here.
@@ -711,8 +745,8 @@ class TerminalImportSession(importer.ImportSession):
return post_choice
elif isinstance(post_choice, autotag.Proposal):
# Use the new candidates and continue around the loop.
- candidates = post_choice.candidates
- rec = post_choice.recommendation
+ task.candidates = post_choice.candidates
+ task.rec = post_choice.recommendation
# Otherwise, we have a specific match selection.
else:
@@ -764,46 +798,48 @@ class TerminalImportSession(importer.ImportSession):
"""Decide what to do when a new album or item seems similar to one
that's already in the library.
"""
- log.warning(u"This {0} is already in the library!",
- (u"album" if task.is_album else u"item"))
+ log.warning("This {0} is already in the library!",
+ ("album" if task.is_album else "item"))
if config['import']['quiet']:
# In quiet mode, don't prompt -- just skip.
- log.info(u'Skipping.')
- sel = u's'
+ log.info('Skipping.')
+ sel = 's'
else:
# Print some detail about the existing and new items so the
# user can make an informed decision.
for duplicate in found_duplicates:
- print_(u"Old: " + summarize_items(
+ print_("Old: " + summarize_items(
list(duplicate.items()) if task.is_album else [duplicate],
not task.is_album,
))
- print_(u"New: " + summarize_items(
+ print_("New: " + summarize_items(
task.imported_items(),
not task.is_album,
))
sel = ui.input_options(
- (u'Skip new', u'Keep both', u'Remove old')
+ ('Skip new', 'Keep all', 'Remove old', 'Merge all')
)
- if sel == u's':
+ if sel == 's':
# Skip new.
task.set_choice(importer.action.SKIP)
- elif sel == u'k':
+ elif sel == 'k':
# Keep both. Do nothing; leave the choice intact.
pass
- elif sel == u'r':
+ elif sel == 'r':
# Remove old.
task.should_remove_duplicates = True
+ elif sel == 'm':
+ task.should_merge_duplicates = True
else:
assert False
def should_resume(self, path):
- return ui.input_yn(u"Import of the directory:\n{0}\n"
- u"was interrupted. Resume (Y/n)?"
+ return ui.input_yn("Import of the directory:\n{}\n"
+ "was interrupted. Resume (Y/n)?"
.format(displayable_path(path)))
def _get_choices(self, task):
@@ -824,22 +860,22 @@ class TerminalImportSession(importer.ImportSession):
"""
# Standard, built-in choices.
choices = [
- PromptChoice(u's', u'Skip',
+ PromptChoice('s', 'Skip',
lambda s, t: importer.action.SKIP),
- PromptChoice(u'u', u'Use as-is',
+ PromptChoice('u', 'Use as-is',
lambda s, t: importer.action.ASIS)
]
if task.is_album:
choices += [
- PromptChoice(u't', u'as Tracks',
+ PromptChoice('t', 'as Tracks',
lambda s, t: importer.action.TRACKS),
- PromptChoice(u'g', u'Group albums',
+ PromptChoice('g', 'Group albums',
lambda s, t: importer.action.ALBUMS),
]
choices += [
- PromptChoice(u'e', u'Enter search', manual_search),
- PromptChoice(u'i', u'enter Id', manual_id),
- PromptChoice(u'b', u'aBort', abort_action),
+ PromptChoice('e', 'Enter search', manual_search),
+ PromptChoice('i', 'enter Id', manual_id),
+ PromptChoice('b', 'aBort', abort_action),
]
# Send the before_choose_candidate event and flatten list.
@@ -849,7 +885,7 @@ class TerminalImportSession(importer.ImportSession):
# Add a "dummy" choice for the other baked-in option, for
# duplicate checking.
all_choices = [
- PromptChoice(u'a', u'Apply', None),
+ PromptChoice('a', 'Apply', None),
] + choices + extra_choices
# Check for conflicts.
@@ -862,8 +898,8 @@ class TerminalImportSession(importer.ImportSession):
# Keep the first of the choices, removing the rest.
dup_choices = [c for c in all_choices if c.short == short]
for c in dup_choices[1:]:
- log.warning(u"Prompt choice '{0}' removed due to conflict "
- u"with '{1}' (short letter: '{2}')",
+ log.warning("Prompt choice '{0}' removed due to conflict "
+ "with '{1}' (short letter: '{2}')",
c.long, dup_choices[0].long, c.short)
extra_choices.remove(c)
@@ -880,21 +916,21 @@ def import_files(lib, paths, query):
# Check the user-specified directories.
for path in paths:
if not os.path.exists(syspath(normpath(path))):
- raise ui.UserError(u'no such file or directory: {0}'.format(
+ raise ui.UserError('no such file or directory: {}'.format(
displayable_path(path)))
# Check parameter consistency.
if config['import']['quiet'] and config['import']['timid']:
- raise ui.UserError(u"can't be both quiet and timid")
+ raise ui.UserError("can't be both quiet and timid")
# Open the log.
if config['import']['log'].get() is not None:
logpath = syspath(config['import']['log'].as_filename())
try:
loghandler = logging.FileHandler(logpath)
- except IOError:
- raise ui.UserError(u"could not open log file for writing: "
- u"{0}".format(displayable_path(logpath)))
+ except OSError:
+ raise ui.UserError("could not open log file for writing: "
+ "{}".format(displayable_path(logpath)))
else:
loghandler = None
@@ -925,94 +961,111 @@ def import_func(lib, opts, args):
query = None
paths = args
if not paths:
- raise ui.UserError(u'no path specified')
+ raise ui.UserError('no path specified')
+
+ # On Python 2, we used to get filenames as raw bytes, which is
+ # what we need. On Python 3, we need to undo the "helpful"
+ # conversion to Unicode strings to get the real bytestring
+ # filename.
+ paths = [p.encode(util.arg_encoding(), 'surrogateescape')
+ for p in paths]
import_files(lib, paths, query)
import_cmd = ui.Subcommand(
- u'import', help=u'import new music', aliases=(u'imp', u'im')
+ 'import', help='import new music', aliases=('imp', 'im')
)
import_cmd.parser.add_option(
- u'-c', u'--copy', action='store_true', default=None,
- help=u"copy tracks into library directory (default)"
+ '-c', '--copy', action='store_true', default=None,
+ help="copy tracks into library directory (default)"
)
import_cmd.parser.add_option(
- u'-C', u'--nocopy', action='store_false', dest='copy',
- help=u"don't copy tracks (opposite of -c)"
+ '-C', '--nocopy', action='store_false', dest='copy',
+ help="don't copy tracks (opposite of -c)"
)
import_cmd.parser.add_option(
- u'-m', u'--move', action='store_true', dest='move',
- help=u"move tracks into the library (overrides -c)"
+ '-m', '--move', action='store_true', dest='move',
+ help="move tracks into the library (overrides -c)"
)
import_cmd.parser.add_option(
- u'-w', u'--write', action='store_true', default=None,
- help=u"write new metadata to files' tags (default)"
+ '-w', '--write', action='store_true', default=None,
+ help="write new metadata to files' tags (default)"
)
import_cmd.parser.add_option(
- u'-W', u'--nowrite', action='store_false', dest='write',
- help=u"don't write metadata (opposite of -w)"
+ '-W', '--nowrite', action='store_false', dest='write',
+ help="don't write metadata (opposite of -w)"
)
import_cmd.parser.add_option(
- u'-a', u'--autotag', action='store_true', dest='autotag',
- help=u"infer tags for imported files (default)"
+ '-a', '--autotag', action='store_true', dest='autotag',
+ help="infer tags for imported files (default)"
)
import_cmd.parser.add_option(
- u'-A', u'--noautotag', action='store_false', dest='autotag',
- help=u"don't infer tags for imported files (opposite of -a)"
+ '-A', '--noautotag', action='store_false', dest='autotag',
+ help="don't infer tags for imported files (opposite of -a)"
)
import_cmd.parser.add_option(
- u'-p', u'--resume', action='store_true', default=None,
- help=u"resume importing if interrupted"
+ '-p', '--resume', action='store_true', default=None,
+ help="resume importing if interrupted"
)
import_cmd.parser.add_option(
- u'-P', u'--noresume', action='store_false', dest='resume',
- help=u"do not try to resume importing"
+ '-P', '--noresume', action='store_false', dest='resume',
+ help="do not try to resume importing"
)
import_cmd.parser.add_option(
- u'-q', u'--quiet', action='store_true', dest='quiet',
- help=u"never prompt for input: skip albums instead"
+ '-q', '--quiet', action='store_true', dest='quiet',
+ help="never prompt for input: skip albums instead"
)
import_cmd.parser.add_option(
- u'-l', u'--log', dest='log',
- help=u'file to log untaggable albums for later review'
+ '-l', '--log', dest='log',
+ help='file to log untaggable albums for later review'
)
import_cmd.parser.add_option(
- u'-s', u'--singletons', action='store_true',
- help=u'import individual tracks instead of full albums'
+ '-s', '--singletons', action='store_true',
+ help='import individual tracks instead of full albums'
)
import_cmd.parser.add_option(
- u'-t', u'--timid', dest='timid', action='store_true',
- help=u'always confirm all actions'
+ '-t', '--timid', dest='timid', action='store_true',
+ help='always confirm all actions'
)
import_cmd.parser.add_option(
- u'-L', u'--library', dest='library', action='store_true',
- help=u'retag items matching a query'
+ '-L', '--library', dest='library', action='store_true',
+ help='retag items matching a query'
)
import_cmd.parser.add_option(
- u'-i', u'--incremental', dest='incremental', action='store_true',
- help=u'skip already-imported directories'
+ '-i', '--incremental', dest='incremental', action='store_true',
+ help='skip already-imported directories'
)
import_cmd.parser.add_option(
- u'-I', u'--noincremental', dest='incremental', action='store_false',
- help=u'do not skip already-imported directories'
+ '-I', '--noincremental', dest='incremental', action='store_false',
+ help='do not skip already-imported directories'
)
import_cmd.parser.add_option(
- u'--flat', dest='flat', action='store_true',
- help=u'import an entire tree as a single album'
+ '--from-scratch', dest='from_scratch', action='store_true',
+ help='erase existing metadata before applying new metadata'
)
import_cmd.parser.add_option(
- u'-g', u'--group-albums', dest='group_albums', action='store_true',
- help=u'group tracks in a folder into separate albums'
+ '--flat', dest='flat', action='store_true',
+ help='import an entire tree as a single album'
)
import_cmd.parser.add_option(
- u'--pretend', dest='pretend', action='store_true',
- help=u'just print the files to import'
+ '-g', '--group-albums', dest='group_albums', action='store_true',
+ help='group tracks in a folder into separate albums'
)
import_cmd.parser.add_option(
- u'-S', u'--search-id', dest='search_ids', action='append',
+ '--pretend', dest='pretend', action='store_true',
+ help='just print the files to import'
+)
+import_cmd.parser.add_option(
+ '-S', '--search-id', dest='search_ids', action='append',
metavar='ID',
- help=u'restrict matching to a specific metadata backend ID'
+ help='restrict matching to a specific metadata backend ID'
+)
+import_cmd.parser.add_option(
+ '--set', dest='set_fields', action='callback',
+ callback=_store_dict,
+ metavar='FIELD=VALUE',
+ help='set the given fields to the supplied values'
)
import_cmd.func = import_func
default_commands.append(import_cmd)
@@ -1020,7 +1073,7 @@ default_commands.append(import_cmd)
# list: Query and show library contents.
-def list_items(lib, query, album, fmt=u''):
+def list_items(lib, query, album, fmt=''):
"""Print out items in lib matching query. If album, then search for
albums instead of single items.
"""
@@ -1036,9 +1089,9 @@ def list_func(lib, opts, args):
list_items(lib, decargs(args), opts.album)
-list_cmd = ui.Subcommand(u'list', help=u'query the library', aliases=(u'ls',))
-list_cmd.parser.usage += u"\n" \
- u'Example: %prog -f \'$album: $title\' artist:beatles'
+list_cmd = ui.Subcommand('list', help='query the library', aliases=('ls',))
+list_cmd.parser.usage += "\n" \
+ 'Example: %prog -f \'$album: $title\' artist:beatles'
list_cmd.parser.add_all_common_options()
list_cmd.func = list_func
default_commands.append(list_cmd)
@@ -1066,7 +1119,7 @@ def update_items(lib, query, album, move, pretend, fields):
# Item deleted?
if not os.path.exists(syspath(item.path)):
ui.print_(format(item))
- ui.print_(ui.colorize('text_error', u' deleted'))
+ ui.print_(ui.colorize('text_error', ' deleted'))
if not pretend:
item.remove(True)
affected_albums.add(item.album_id)
@@ -1074,7 +1127,7 @@ def update_items(lib, query, album, move, pretend, fields):
# Did the item change since last checked?
if item.current_mtime() <= item.mtime:
- log.debug(u'skipping {0} because mtime is up to date ({1})',
+ log.debug('skipping {0} because mtime is up to date ({1})',
displayable_path(item.path), item.mtime)
continue
@@ -1082,7 +1135,7 @@ def update_items(lib, query, album, move, pretend, fields):
try:
item.read()
except library.ReadError as exc:
- log.error(u'error reading {0}: {1}',
+ log.error('error reading {0}: {1}',
displayable_path(item.path), exc)
continue
@@ -1093,7 +1146,7 @@ def update_items(lib, query, album, move, pretend, fields):
old_item = lib.get_item(item.id)
if old_item.albumartist == old_item.artist == item.artist:
item.albumartist = old_item.albumartist
- item._dirty.discard(u'albumartist')
+ item._dirty.discard('albumartist')
# Check for and display changes.
changed = ui.show_model_changes(
@@ -1126,7 +1179,7 @@ def update_items(lib, query, album, move, pretend, fields):
continue
album = lib.get_album(album_id)
if not album: # Empty albums have already been removed.
- log.debug(u'emptied album {0}', album_id)
+ log.debug('emptied album {0}', album_id)
continue
first_item = album.items().get()
@@ -1137,42 +1190,48 @@ def update_items(lib, query, album, move, pretend, fields):
# Move album art (and any inconsistent items).
if move and lib.directory in ancestry(first_item.path):
- log.debug(u'moving album {0}', album_id)
+ log.debug('moving album {0}', album_id)
# Manually moving and storing the album.
items = list(album.items())
for item in items:
- item.move(store=False)
+ item.move(store=False, with_album=False)
item.store(fields=fields)
album.move(store=False)
album.store(fields=fields)
def update_func(lib, opts, args):
+ # Verify that the library folder exists to prevent accidental wipes.
+ if not os.path.isdir(lib.directory):
+ ui.print_("Library path is unavailable or does not exist.")
+ ui.print_(lib.directory)
+ if not ui.input_yn("Are you sure you want to continue (y/n)?", True):
+ return
update_items(lib, decargs(args), opts.album, ui.should_move(opts.move),
opts.pretend, opts.fields)
update_cmd = ui.Subcommand(
- u'update', help=u'update the library', aliases=(u'upd', u'up',)
+ 'update', help='update the library', aliases=('upd', 'up',)
)
update_cmd.parser.add_album_option()
update_cmd.parser.add_format_option()
update_cmd.parser.add_option(
- u'-m', u'--move', action='store_true', dest='move',
- help=u"move files in the library directory"
+ '-m', '--move', action='store_true', dest='move',
+ help="move files in the library directory"
)
update_cmd.parser.add_option(
- u'-M', u'--nomove', action='store_false', dest='move',
- help=u"don't move files in library"
+ '-M', '--nomove', action='store_false', dest='move',
+ help="don't move files in library"
)
update_cmd.parser.add_option(
- u'-p', u'--pretend', action='store_true',
- help=u"show all changes but do nothing"
+ '-p', '--pretend', action='store_true',
+ help="show all changes but do nothing"
)
update_cmd.parser.add_option(
- u'-F', u'--field', default=None, action='append', dest='fields',
- help=u'list of fields to update'
+ '-F', '--field', default=None, action='append', dest='fields',
+ help='list of fields to update'
)
update_cmd.func = update_func
default_commands.append(update_cmd)
@@ -1186,31 +1245,53 @@ def remove_items(lib, query, album, delete, force):
"""
# Get the matching items.
items, albums = _do_query(lib, query, album)
+ objs = albums if album else items
# Confirm file removal if not forcing removal.
if not force:
# Prepare confirmation with user.
- print_()
+ album_str = " in {} album{}".format(
+ len(albums), 's' if len(albums) > 1 else ''
+ ) if album else ""
+
if delete:
- fmt = u'$path - $title'
- prompt = u'Really DELETE %i file%s (y/n)?' % \
- (len(items), 's' if len(items) > 1 else '')
+ fmt = '$path - $title'
+ prompt = 'Really DELETE'
+ prompt_all = 'Really DELETE {} file{}{}'.format(
+ len(items), 's' if len(items) > 1 else '', album_str
+ )
else:
- fmt = u''
- prompt = u'Really remove %i item%s from the library (y/n)?' % \
- (len(items), 's' if len(items) > 1 else '')
+ fmt = ''
+ prompt = 'Really remove from the library?'
+ prompt_all = 'Really remove {} item{}{} from the library?'.format(
+ len(items), 's' if len(items) > 1 else '', album_str
+ )
+
+ # Helpers for printing affected items
+ def fmt_track(t):
+ ui.print_(format(t, fmt))
+
+ def fmt_album(a):
+ ui.print_()
+ for i in a.items():
+ fmt_track(i)
+
+ fmt_obj = fmt_album if album else fmt_track
# Show all the items.
- for item in items:
- ui.print_(format(item, fmt))
+ for o in objs:
+ fmt_obj(o)
# Confirm with user.
- if not ui.input_yn(prompt, True):
- return
+ objs = ui.input_select_objects(prompt, objs, fmt_obj,
+ prompt_all=prompt_all)
+
+ if not objs:
+ return
# Remove (and possibly delete) items.
with lib.transaction():
- for obj in (albums if album else items):
+ for obj in objs:
obj.remove(delete)
@@ -1219,15 +1300,15 @@ def remove_func(lib, opts, args):
remove_cmd = ui.Subcommand(
- u'remove', help=u'remove matching items from the library', aliases=(u'rm',)
+ 'remove', help='remove matching items from the library', aliases=('rm',)
)
remove_cmd.parser.add_option(
- u"-d", u"--delete", action="store_true",
- help=u"also remove files from disk"
+ "-d", "--delete", action="store_true",
+ help="also remove files from disk"
)
remove_cmd.parser.add_option(
- u"-f", u"--force", action="store_true",
- help=u"do not ask when removing items"
+ "-f", "--force", action="store_true",
+ help="do not ask when removing items"
)
remove_cmd.parser.add_album_option()
remove_cmd.func = remove_func
@@ -1252,7 +1333,7 @@ def show_stats(lib, query, exact):
try:
total_size += os.path.getsize(syspath(item.path))
except OSError as exc:
- log.info(u'could not get size of {}: {}', item.path, exc)
+ log.info('could not get size of {}: {}', item.path, exc)
else:
total_size += int(item.length * item.bitrate / 8)
total_time += item.length
@@ -1262,20 +1343,20 @@ def show_stats(lib, query, exact):
if item.album_id:
albums.add(item.album_id)
- size_str = u'' + ui.human_bytes(total_size)
+ size_str = '' + ui.human_bytes(total_size)
if exact:
- size_str += u' ({0} bytes)'.format(total_size)
+ size_str += f' ({total_size} bytes)'
- print_(u"""Tracks: {0}
-Total time: {1}{2}
-{3}: {4}
-Artists: {5}
-Albums: {6}
-Album artists: {7}""".format(
+ print_("""Tracks: {}
+Total time: {}{}
+{}: {}
+Artists: {}
+Albums: {}
+Album artists: {}""".format(
total_items,
ui.human_seconds(total_time),
- u' ({0:.2f} seconds)'.format(total_time) if exact else '',
- u'Total size' if exact else u'Approximate total size',
+ f' ({total_time:.2f} seconds)' if exact else '',
+ 'Total size' if exact else 'Approximate total size',
size_str,
len(artists),
len(albums),
@@ -1288,11 +1369,11 @@ def stats_func(lib, opts, args):
stats_cmd = ui.Subcommand(
- u'stats', help=u'show statistics about the library or a query'
+ 'stats', help='show statistics about the library or a query'
)
stats_cmd.parser.add_option(
- u'-e', u'--exact', action='store_true',
- help=u'exact size and time'
+ '-e', '--exact', action='store_true',
+ help='exact size and time'
)
stats_cmd.func = stats_func
default_commands.append(stats_cmd)
@@ -1301,18 +1382,18 @@ default_commands.append(stats_cmd)
# version: Show current beets version.
def show_version(lib, opts, args):
- print_(u'beets version %s' % beets.__version__)
- print_(u'Python version {}'.format(python_version()))
+ print_('beets version %s' % beets.__version__)
+ print_(f'Python version {python_version()}')
# Show plugins.
names = sorted(p.name for p in plugins.find_plugins())
if names:
- print_(u'plugins:', ', '.join(names))
+ print_('plugins:', ', '.join(names))
else:
- print_(u'no plugins loaded')
+ print_('no plugins loaded')
version_cmd = ui.Subcommand(
- u'version', help=u'output version information'
+ 'version', help='output version information'
)
version_cmd.func = show_version
default_commands.append(version_cmd)
@@ -1339,31 +1420,31 @@ def modify_items(lib, mods, dels, query, write, move, album, confirm):
# Apply changes *temporarily*, preview them, and collect modified
# objects.
- print_(u'Modifying {0} {1}s.'
- .format(len(objs), u'album' if album else u'item'))
- changed = set()
+ print_('Modifying {} {}s.'
+ .format(len(objs), 'album' if album else 'item'))
+ changed = []
for obj in objs:
- if print_and_modify(obj, mods, dels):
- changed.add(obj)
+ if print_and_modify(obj, mods, dels) and obj not in changed:
+ changed.append(obj)
# Still something to do?
if not changed:
- print_(u'No changes to make.')
+ print_('No changes to make.')
return
# Confirm action.
if confirm:
if write and move:
- extra = u', move and write tags'
+ extra = ', move and write tags'
elif write:
- extra = u' and write tags'
+ extra = ' and write tags'
elif move:
- extra = u' and move'
+ extra = ' and move'
else:
- extra = u''
+ extra = ''
changed = ui.input_select_objects(
- u'Really modify%s' % extra, changed,
+ 'Really modify%s' % extra, changed,
lambda o: print_and_modify(o, mods, dels)
)
@@ -1411,35 +1492,35 @@ def modify_parse_args(args):
def modify_func(lib, opts, args):
query, mods, dels = modify_parse_args(decargs(args))
if not mods and not dels:
- raise ui.UserError(u'no modifications specified')
+ raise ui.UserError('no modifications specified')
modify_items(lib, mods, dels, query, ui.should_write(opts.write),
ui.should_move(opts.move), opts.album, not opts.yes)
modify_cmd = ui.Subcommand(
- u'modify', help=u'change metadata fields', aliases=(u'mod',)
+ 'modify', help='change metadata fields', aliases=('mod',)
)
modify_cmd.parser.add_option(
- u'-m', u'--move', action='store_true', dest='move',
- help=u"move files in the library directory"
+ '-m', '--move', action='store_true', dest='move',
+ help="move files in the library directory"
)
modify_cmd.parser.add_option(
- u'-M', u'--nomove', action='store_false', dest='move',
- help=u"don't move files in library"
+ '-M', '--nomove', action='store_false', dest='move',
+ help="don't move files in library"
)
modify_cmd.parser.add_option(
- u'-w', u'--write', action='store_true', default=None,
- help=u"write new metadata to files' tags (default)"
+ '-w', '--write', action='store_true', default=None,
+ help="write new metadata to files' tags (default)"
)
modify_cmd.parser.add_option(
- u'-W', u'--nowrite', action='store_false', dest='write',
- help=u"don't write metadata (opposite of -w)"
+ '-W', '--nowrite', action='store_false', dest='write',
+ help="don't write metadata (opposite of -w)"
)
modify_cmd.parser.add_album_option()
modify_cmd.parser.add_format_option(target='item')
modify_cmd.parser.add_option(
- u'-y', u'--yes', action='store_true',
- help=u'skip confirmation'
+ '-y', '--yes', action='store_true',
+ help='skip confirmation'
)
modify_cmd.func = modify_func
default_commands.append(modify_cmd)
@@ -1447,24 +1528,36 @@ default_commands.append(modify_cmd)
# move: Move/copy files to the library or a new base directory.
-def move_items(lib, dest, query, copy, album, pretend, confirm=False):
+def move_items(lib, dest, query, copy, album, pretend, confirm=False,
+ export=False):
"""Moves or copies items to a new base directory, given by dest. If
dest is None, then the library's base directory is used, making the
command "consolidate" files.
"""
items, albums = _do_query(lib, query, album, False)
objs = albums if album else items
+ num_objs = len(objs)
# Filter out files that don't need to be moved.
- isitemmoved = lambda item: item.path != item.destination(basedir=dest)
- isalbummoved = lambda album: any(isitemmoved(i) for i in album.items())
- objs = [o for o in objs if (isalbummoved if album else isitemmoved)(o)]
+ def isitemmoved(item):
+ return item.path != item.destination(basedir=dest)
- action = u'Copying' if copy else u'Moving'
- act = u'copy' if copy else u'move'
- entity = u'album' if album else u'item'
- log.info(u'{0} {1} {2}{3}.', action, len(objs), entity,
- u's' if len(objs) != 1 else u'')
+ def isalbummoved(album):
+ return any(isitemmoved(i) for i in album.items())
+
+ objs = [o for o in objs if (isalbummoved if album else isitemmoved)(o)]
+ num_unmoved = num_objs - len(objs)
+ # Report unmoved files that match the query.
+ unmoved_msg = ''
+ if num_unmoved > 0:
+ unmoved_msg = f' ({num_unmoved} already in place)'
+
+ copy = copy or export # Exporting always copies.
+ action = 'Copying' if copy else 'Moving'
+ act = 'copy' if copy else 'move'
+ entity = 'album' if album else 'item'
+ log.info('{0} {1} {2}{3}{4}.', action, len(objs), entity,
+ 's' if len(objs) != 1 else '', unmoved_msg)
if not objs:
return
@@ -1478,15 +1571,23 @@ def move_items(lib, dest, query, copy, album, pretend, confirm=False):
else:
if confirm:
objs = ui.input_select_objects(
- u'Really %s' % act, objs,
+ 'Really %s' % act, objs,
lambda o: show_path_changes(
[(o.path, o.destination(basedir=dest))]))
for obj in objs:
- log.debug(u'moving: {0}', util.displayable_path(obj.path))
+ log.debug('moving: {0}', util.displayable_path(obj.path))
- obj.move(copy, basedir=dest)
- obj.store()
+ if export:
+ # Copy without affecting the database.
+ obj.move(operation=MoveOperation.COPY, basedir=dest,
+ store=False)
+ else:
+ # Ordinary move/copy: store the new path.
+ if copy:
+ obj.move(operation=MoveOperation.COPY, basedir=dest)
+ else:
+ obj.move(operation=MoveOperation.MOVE, basedir=dest)
def move_func(lib, opts, args):
@@ -1494,30 +1595,34 @@ def move_func(lib, opts, args):
if dest is not None:
dest = normpath(dest)
if not os.path.isdir(dest):
- raise ui.UserError(u'no such directory: %s' % dest)
+ raise ui.UserError('no such directory: %s' % dest)
move_items(lib, dest, decargs(args), opts.copy, opts.album, opts.pretend,
- opts.timid)
+ opts.timid, opts.export)
move_cmd = ui.Subcommand(
- u'move', help=u'move or copy items', aliases=(u'mv',)
+ 'move', help='move or copy items', aliases=('mv',)
)
move_cmd.parser.add_option(
- u'-d', u'--dest', metavar='DIR', dest='dest',
- help=u'destination directory'
+ '-d', '--dest', metavar='DIR', dest='dest',
+ help='destination directory'
)
move_cmd.parser.add_option(
- u'-c', u'--copy', default=False, action='store_true',
- help=u'copy instead of moving'
+ '-c', '--copy', default=False, action='store_true',
+ help='copy instead of moving'
)
move_cmd.parser.add_option(
- u'-p', u'--pretend', default=False, action='store_true',
- help=u'show how files would be moved, but don\'t touch anything'
+ '-p', '--pretend', default=False, action='store_true',
+ help='show how files would be moved, but don\'t touch anything'
)
move_cmd.parser.add_option(
- u'-t', u'--timid', dest='timid', action='store_true',
- help=u'always confirm all actions'
+ '-t', '--timid', dest='timid', action='store_true',
+ help='always confirm all actions'
+)
+move_cmd.parser.add_option(
+ '-e', '--export', default=False, action='store_true',
+ help='copy without changing the database path'
)
move_cmd.parser.add_album_option()
move_cmd.func = move_func
@@ -1535,14 +1640,14 @@ def write_items(lib, query, pretend, force):
for item in items:
# Item deleted?
if not os.path.exists(syspath(item.path)):
- log.info(u'missing file: {0}', util.displayable_path(item.path))
+ log.info('missing file: {0}', util.displayable_path(item.path))
continue
# Get an Item object reflecting the "clean" (on-disk) state.
try:
clean_item = library.Item.from_path(item.path)
except library.ReadError as exc:
- log.error(u'error reading {0}: {1}',
+ log.error('error reading {0}: {1}',
displayable_path(item.path), exc)
continue
@@ -1559,14 +1664,14 @@ def write_func(lib, opts, args):
write_items(lib, decargs(args), opts.pretend, opts.force)
-write_cmd = ui.Subcommand(u'write', help=u'write tag information to files')
+write_cmd = ui.Subcommand('write', help='write tag information to files')
write_cmd.parser.add_option(
- u'-p', u'--pretend', action='store_true',
- help=u"show all changes but do nothing"
+ '-p', '--pretend', action='store_true',
+ help="show all changes but do nothing"
)
write_cmd.parser.add_option(
- u'-f', u'--force', action='store_true',
- help=u"write tags even if the existing tags match the database"
+ '-f', '--force', action='store_true',
+ help="write tags even if the existing tags match the database"
)
write_cmd.func = write_func
default_commands.append(write_cmd)
@@ -1603,7 +1708,10 @@ def config_func(lib, opts, args):
# Dump configuration.
else:
config_out = config.dump(full=opts.defaults, redact=opts.redact)
- print_(util.text_string(config_out))
+ if config_out.strip() != '{}':
+ print_(util.text_string(config_out))
+ else:
+ print("Empty configuration")
def config_edit():
@@ -1617,29 +1725,30 @@ def config_edit():
open(path, 'w+').close()
util.interactive_open([path], editor)
except OSError as exc:
- message = u"Could not edit configuration: {0}".format(exc)
+ message = f"Could not edit configuration: {exc}"
if not editor:
- message += u". Please set the EDITOR environment variable"
+ message += ". Please set the EDITOR environment variable"
raise ui.UserError(message)
-config_cmd = ui.Subcommand(u'config',
- help=u'show or edit the user configuration')
+
+config_cmd = ui.Subcommand('config',
+ help='show or edit the user configuration')
config_cmd.parser.add_option(
- u'-p', u'--paths', action='store_true',
- help=u'show files that configuration was loaded from'
+ '-p', '--paths', action='store_true',
+ help='show files that configuration was loaded from'
)
config_cmd.parser.add_option(
- u'-e', u'--edit', action='store_true',
- help=u'edit user configuration with $EDITOR'
+ '-e', '--edit', action='store_true',
+ help='edit user configuration with $EDITOR'
)
config_cmd.parser.add_option(
- u'-d', u'--defaults', action='store_true',
- help=u'include the default configuration'
+ '-d', '--defaults', action='store_true',
+ help='include the default configuration'
)
config_cmd.parser.add_option(
- u'-c', u'--clear', action='store_false',
+ '-c', '--clear', action='store_false',
dest='redact', default=True,
- help=u'do not redact sensitive fields'
+ help='do not redact sensitive fields'
)
config_cmd.func = config_func
default_commands.append(config_cmd)
@@ -1649,19 +1758,20 @@ default_commands.append(config_cmd)
def print_completion(*args):
for line in completion_script(default_commands + plugins.commands()):
- print_(line, end=u'')
+ print_(line, end='')
if not any(map(os.path.isfile, BASH_COMPLETION_PATHS)):
- log.warning(u'Warning: Unable to find the bash-completion package. '
- u'Command line completion might not work.')
+ log.warning('Warning: Unable to find the bash-completion package. '
+ 'Command line completion might not work.')
+
BASH_COMPLETION_PATHS = map(syspath, [
- u'/etc/bash_completion',
- u'/usr/share/bash-completion/bash_completion',
- u'/usr/local/share/bash-completion/bash_completion',
+ '/etc/bash_completion',
+ '/usr/share/bash-completion/bash_completion',
+ '/usr/local/share/bash-completion/bash_completion',
# SmartOS
- u'/opt/local/share/bash-completion/bash_completion',
+ '/opt/local/share/bash-completion/bash_completion',
# Homebrew (before bash-completion2)
- u'/usr/local/etc/bash_completion',
+ '/usr/local/etc/bash_completion',
])
@@ -1671,8 +1781,8 @@ def completion_script(commands):
``commands`` is alist of ``ui.Subcommand`` instances to generate
completion data for.
"""
- base_script = os.path.join(_package_path('beets.ui'), 'completion_base.sh')
- with open(base_script, 'r') as base_script:
+ base_script = os.path.join(os.path.dirname(__file__), 'completion_base.sh')
+ with open(base_script) as base_script:
yield util.text_string(base_script.read())
options = {}
@@ -1688,12 +1798,12 @@ def completion_script(commands):
if re.match(r'^\w+$', alias):
aliases[alias] = name
- options[name] = {u'flags': [], u'opts': []}
+ options[name] = {'flags': [], 'opts': []}
for opts in cmd.parser._get_all_options()[1:]:
if opts.action in ('store_true', 'store_false'):
- option_type = u'flags'
+ option_type = 'flags'
else:
- option_type = u'opts'
+ option_type = 'opts'
options[name][option_type].extend(
opts._short_opts + opts._long_opts
@@ -1701,31 +1811,31 @@ def completion_script(commands):
# Add global options
options['_global'] = {
- u'flags': [u'-v', u'--verbose'],
- u'opts':
- u'-l --library -c --config -d --directory -h --help'.split(u' ')
+ 'flags': ['-v', '--verbose'],
+ 'opts':
+ '-l --library -c --config -d --directory -h --help'.split(' ')
}
# Add flags common to all commands
options['_common'] = {
- u'flags': [u'-h', u'--help']
+ 'flags': ['-h', '--help']
}
# Start generating the script
- yield u"_beet() {\n"
+ yield "_beet() {\n"
# Command names
- yield u" local commands='%s'\n" % ' '.join(command_names)
- yield u"\n"
+ yield " local commands='%s'\n" % ' '.join(command_names)
+ yield "\n"
# Command aliases
- yield u" local aliases='%s'\n" % ' '.join(aliases.keys())
+ yield " local aliases='%s'\n" % ' '.join(aliases.keys())
for alias, cmd in aliases.items():
- yield u" local alias__%s=%s\n" % (alias, cmd)
- yield u'\n'
+ yield " local alias__{}={}\n".format(alias.replace('-', '_'), cmd)
+ yield '\n'
# Fields
- yield u" fields='%s'\n" % ' '.join(
+ yield " fields='%s'\n" % ' '.join(
set(
list(library.Item._fields.keys()) +
list(library.Album._fields.keys())
@@ -1736,17 +1846,17 @@ def completion_script(commands):
for cmd, opts in options.items():
for option_type, option_list in opts.items():
if option_list:
- option_list = u' '.join(option_list)
- yield u" local %s__%s='%s'\n" % (
- option_type, cmd, option_list)
+ option_list = ' '.join(option_list)
+ yield " local {}__{}='{}'\n".format(
+ option_type, cmd.replace('-', '_'), option_list)
- yield u' _beet_dispatch\n'
- yield u'}\n'
+ yield ' _beet_dispatch\n'
+ yield '}\n'
completion_cmd = ui.Subcommand(
'completion',
- help=u'print shell script that provides command line completion'
+ help='print shell script that provides command line completion'
)
completion_cmd.func = print_completion
completion_cmd.hide = True
diff --git a/lib/beets/ui/completion_base.sh b/lib/beets/ui/completion_base.sh
old mode 100755
new mode 100644
index ce3fb6e2..1eaa4db3
--- a/lib/beets/ui/completion_base.sh
+++ b/lib/beets/ui/completion_base.sh
@@ -70,7 +70,7 @@ _beet_dispatch() {
# Replace command shortcuts
if [[ -n $cmd ]] && _list_include_item "$aliases" "$cmd"; then
- eval "cmd=\$alias__$cmd"
+ eval "cmd=\$alias__${cmd//-/_}"
fi
case $cmd in
@@ -94,8 +94,8 @@ _beet_dispatch() {
_beet_complete() {
if [[ $cur == -* ]]; then
local opts flags completions
- eval "opts=\$opts__$cmd"
- eval "flags=\$flags__$cmd"
+ eval "opts=\$opts__${cmd//-/_}"
+ eval "flags=\$flags__${cmd//-/_}"
completions="${flags___common} ${opts} ${flags}"
COMPREPLY+=( $(compgen -W "$completions" -- $cur) )
else
@@ -129,7 +129,7 @@ _beet_complete_global() {
COMPREPLY+=( $(compgen -W "$completions" -- $cur) )
elif [[ -n $cur ]] && _list_include_item "$aliases" "$cur"; then
local cmd
- eval "cmd=\$alias__$cur"
+ eval "cmd=\$alias__${cur//-/_}"
COMPREPLY+=( "$cmd" )
else
COMPREPLY+=( $(compgen -W "$commands" -- $cur) )
@@ -138,7 +138,7 @@ _beet_complete_global() {
_beet_complete_query() {
local opts
- eval "opts=\$opts__$cmd"
+ eval "opts=\$opts__${cmd//-/_}"
if [[ $cur == -* ]] || _list_include_item "$opts" "$prev"; then
_beet_complete
diff --git a/lib/beets/util/__init__.py b/lib/beets/util/__init__.py
old mode 100755
new mode 100644
index f6cd488d..d58bb28e
--- a/lib/beets/util/__init__.py
+++ b/lib/beets/util/__init__.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
# This file is part of beets.
# Copyright 2016, Adrian Sampson.
#
@@ -15,27 +14,28 @@
"""Miscellaneous utility functions."""
-from __future__ import division, absolute_import, print_function
import os
import sys
import errno
import locale
import re
+import tempfile
import shutil
import fnmatch
-from collections import Counter
+import functools
+from collections import Counter, namedtuple
+from multiprocessing.pool import ThreadPool
import traceback
import subprocess
import platform
import shlex
from beets.util import hidden
-import six
from unidecode import unidecode
+from enum import Enum
MAX_FILENAME_LENGTH = 200
-WINDOWS_MAGIC_PREFIX = u'\\\\?\\'
-SNI_SUPPORTED = sys.version_info >= (2, 7, 9)
+WINDOWS_MAGIC_PREFIX = '\\\\?\\'
class HumanReadableException(Exception):
@@ -57,27 +57,27 @@ class HumanReadableException(Exception):
self.reason = reason
self.verb = verb
self.tb = tb
- super(HumanReadableException, self).__init__(self.get_message())
+ super().__init__(self.get_message())
def _gerund(self):
"""Generate a (likely) gerund form of the English verb.
"""
- if u' ' in self.verb:
+ if ' ' in self.verb:
return self.verb
- gerund = self.verb[:-1] if self.verb.endswith(u'e') else self.verb
- gerund += u'ing'
+ gerund = self.verb[:-1] if self.verb.endswith('e') else self.verb
+ gerund += 'ing'
return gerund
def _reasonstr(self):
"""Get the reason as a string."""
- if isinstance(self.reason, six.text_type):
+ if isinstance(self.reason, str):
return self.reason
elif isinstance(self.reason, bytes):
return self.reason.decode('utf-8', 'ignore')
elif hasattr(self.reason, 'strerror'): # i.e., EnvironmentError
return self.reason.strerror
else:
- return u'"{0}"'.format(six.text_type(self.reason))
+ return '"{}"'.format(str(self.reason))
def get_message(self):
"""Create the human-readable description of the error, sans
@@ -91,7 +91,7 @@ class HumanReadableException(Exception):
"""
if self.tb:
logger.debug(self.tb)
- logger.error(u'{0}: {1}', self.error_kind, self.args[0])
+ logger.error('{0}: {1}', self.error_kind, self.args[0])
class FilesystemError(HumanReadableException):
@@ -99,29 +99,41 @@ class FilesystemError(HumanReadableException):
via a function in this module. The `paths` field is a sequence of
pathnames involved in the operation.
"""
+
def __init__(self, reason, verb, paths, tb=None):
self.paths = paths
- super(FilesystemError, self).__init__(reason, verb, tb)
+ super().__init__(reason, verb, tb)
def get_message(self):
# Use a nicer English phrasing for some specific verbs.
if self.verb in ('move', 'copy', 'rename'):
- clause = u'while {0} {1} to {2}'.format(
+ clause = 'while {} {} to {}'.format(
self._gerund(),
displayable_path(self.paths[0]),
displayable_path(self.paths[1])
)
elif self.verb in ('delete', 'write', 'create', 'read'):
- clause = u'while {0} {1}'.format(
+ clause = 'while {} {}'.format(
self._gerund(),
displayable_path(self.paths[0])
)
else:
- clause = u'during {0} of paths {1}'.format(
- self.verb, u', '.join(displayable_path(p) for p in self.paths)
+ clause = 'during {} of paths {}'.format(
+ self.verb, ', '.join(displayable_path(p) for p in self.paths)
)
- return u'{0} {1}'.format(self._reasonstr(), clause)
+ return f'{self._reasonstr()} {clause}'
+
+
+class MoveOperation(Enum):
+ """The file operations that e.g. various move functions can carry out.
+ """
+ MOVE = 0
+ COPY = 1
+ LINK = 2
+ HARDLINK = 3
+ REFLINK = 4
+ REFLINK_AUTO = 5
def normpath(path):
@@ -172,7 +184,7 @@ def sorted_walk(path, ignore=(), ignore_hidden=False, logger=None):
contents = os.listdir(syspath(path))
except OSError as exc:
if logger:
- logger.warning(u'could not list directory {0}: {1}'.format(
+ logger.warning('could not list directory {}: {}'.format(
displayable_path(path), exc.strerror
))
return
@@ -185,6 +197,10 @@ def sorted_walk(path, ignore=(), ignore_hidden=False, logger=None):
skip = False
for pat in ignore:
if fnmatch.fnmatch(base, pat):
+ if logger:
+ logger.debug('ignoring {} due to ignore rule {}'.format(
+ base, pat
+ ))
skip = True
break
if skip:
@@ -207,8 +223,14 @@ def sorted_walk(path, ignore=(), ignore_hidden=False, logger=None):
for base in dirs:
cur = os.path.join(path, base)
# yield from sorted_walk(...)
- for res in sorted_walk(cur, ignore, ignore_hidden, logger):
- yield res
+ yield from sorted_walk(cur, ignore, ignore_hidden, logger)
+
+
+def path_as_posix(path):
+ """Return the string representation of the path with forward (/)
+ slashes.
+ """
+ return path.replace(b'\\', b'/')
def mkdirall(path):
@@ -219,7 +241,7 @@ def mkdirall(path):
if not os.path.isdir(syspath(ancestor)):
try:
os.mkdir(syspath(ancestor))
- except (OSError, IOError) as exc:
+ except OSError as exc:
raise FilesystemError(exc, 'create', (ancestor,),
traceback.format_exc())
@@ -272,13 +294,13 @@ def prune_dirs(path, root=None, clutter=('.DS_Store', 'Thumbs.db')):
continue
clutter = [bytestring_path(c) for c in clutter]
match_paths = [bytestring_path(d) for d in os.listdir(directory)]
- if fnmatch_all(match_paths, clutter):
- # Directory contains only clutter (or nothing).
- try:
+ try:
+ if fnmatch_all(match_paths, clutter):
+ # Directory contains only clutter (or nothing).
shutil.rmtree(directory)
- except OSError:
+ else:
break
- else:
+ except OSError:
break
@@ -357,18 +379,18 @@ def bytestring_path(path):
PATH_SEP = bytestring_path(os.sep)
-def displayable_path(path, separator=u'; '):
+def displayable_path(path, separator='; '):
"""Attempts to decode a bytestring path to a unicode object for the
purpose of displaying it to the user. If the `path` argument is a
list or a tuple, the elements are joined with `separator`.
"""
if isinstance(path, (list, tuple)):
return separator.join(displayable_path(p) for p in path)
- elif isinstance(path, six.text_type):
+ elif isinstance(path, str):
return path
elif not isinstance(path, bytes):
# A non-string object: just get its unicode representation.
- return six.text_type(path)
+ return str(path)
try:
return path.decode(_fsencoding(), 'ignore')
@@ -387,7 +409,7 @@ def syspath(path, prefix=True):
if os.path.__name__ != 'ntpath':
return path
- if not isinstance(path, six.text_type):
+ if not isinstance(path, str):
# Beets currently represents Windows paths internally with UTF-8
# arbitrarily. But earlier versions used MBCS because it is
# reported as the FS encoding by Windows. Try both.
@@ -400,11 +422,11 @@ def syspath(path, prefix=True):
path = path.decode(encoding, 'replace')
# Add the magic prefix if it isn't already there.
- # http://msdn.microsoft.com/en-us/library/windows/desktop/aa365247.aspx
+ # https://msdn.microsoft.com/en-us/library/windows/desktop/aa365247.aspx
if prefix and not path.startswith(WINDOWS_MAGIC_PREFIX):
- if path.startswith(u'\\\\'):
+ if path.startswith('\\\\'):
# UNC path. Final path should look like \\?\UNC\...
- path = u'UNC' + path[1:]
+ path = 'UNC' + path[1:]
path = WINDOWS_MAGIC_PREFIX + path
return path
@@ -412,6 +434,8 @@ def syspath(path, prefix=True):
def samefile(p1, p2):
"""Safer equality for paths."""
+ if p1 == p2:
+ return True
return shutil._samefile(syspath(p1), syspath(p2))
@@ -424,7 +448,7 @@ def remove(path, soft=True):
return
try:
os.remove(path)
- except (OSError, IOError) as exc:
+ except OSError as exc:
raise FilesystemError(exc, 'delete', (path,), traceback.format_exc())
@@ -439,10 +463,10 @@ def copy(path, dest, replace=False):
path = syspath(path)
dest = syspath(dest)
if not replace and os.path.exists(dest):
- raise FilesystemError(u'file exists', 'copy', (path, dest))
+ raise FilesystemError('file exists', 'copy', (path, dest))
try:
shutil.copyfile(path, dest)
- except (OSError, IOError) as exc:
+ except OSError as exc:
raise FilesystemError(exc, 'copy', (path, dest),
traceback.format_exc())
@@ -455,24 +479,37 @@ def move(path, dest, replace=False):
instead, in which case metadata will *not* be preserved. Paths are
translated to system paths.
"""
+ if os.path.isdir(path):
+ raise FilesystemError(u'source is directory', 'move', (path, dest))
+ if os.path.isdir(dest):
+ raise FilesystemError(u'destination is directory', 'move',
+ (path, dest))
if samefile(path, dest):
return
path = syspath(path)
dest = syspath(dest)
if os.path.exists(dest) and not replace:
- raise FilesystemError(u'file exists', 'rename', (path, dest))
+ raise FilesystemError('file exists', 'rename', (path, dest))
# First, try renaming the file.
try:
- os.rename(path, dest)
+ os.replace(path, dest)
except OSError:
- # Otherwise, copy and delete the original.
+ tmp = tempfile.mktemp(suffix='.beets',
+ prefix=py3_path(b'.' + os.path.basename(dest)),
+ dir=py3_path(os.path.dirname(dest)))
+ tmp = syspath(tmp)
try:
- shutil.copyfile(path, dest)
+ shutil.copyfile(path, tmp)
+ os.replace(tmp, dest)
+ tmp = None
os.remove(path)
- except (OSError, IOError) as exc:
+ except OSError as exc:
raise FilesystemError(exc, 'move', (path, dest),
traceback.format_exc())
+ finally:
+ if tmp is not None:
+ os.remove(tmp)
def link(path, dest, replace=False):
@@ -484,18 +521,18 @@ def link(path, dest, replace=False):
return
if os.path.exists(syspath(dest)) and not replace:
- raise FilesystemError(u'file exists', 'rename', (path, dest))
+ raise FilesystemError('file exists', 'rename', (path, dest))
try:
os.symlink(syspath(path), syspath(dest))
except NotImplementedError:
# raised on python >= 3.2 and Windows versions before Vista
- raise FilesystemError(u'OS does not support symbolic links.'
+ raise FilesystemError('OS does not support symbolic links.'
'link', (path, dest), traceback.format_exc())
except OSError as exc:
# TODO: Windows version checks can be removed for python 3
if hasattr('sys', 'getwindowsversion'):
if sys.getwindowsversion()[0] < 6: # is before Vista
- exc = u'OS does not support symbolic links.'
+ exc = 'OS does not support symbolic links.'
raise FilesystemError(exc, 'link', (path, dest),
traceback.format_exc())
@@ -509,21 +546,50 @@ def hardlink(path, dest, replace=False):
return
if os.path.exists(syspath(dest)) and not replace:
- raise FilesystemError(u'file exists', 'rename', (path, dest))
+ raise FilesystemError('file exists', 'rename', (path, dest))
try:
os.link(syspath(path), syspath(dest))
except NotImplementedError:
- raise FilesystemError(u'OS does not support hard links.'
+ raise FilesystemError('OS does not support hard links.'
'link', (path, dest), traceback.format_exc())
except OSError as exc:
if exc.errno == errno.EXDEV:
- raise FilesystemError(u'Cannot hard link across devices.'
+ raise FilesystemError('Cannot hard link across devices.'
'link', (path, dest), traceback.format_exc())
else:
raise FilesystemError(exc, 'link', (path, dest),
traceback.format_exc())
+def reflink(path, dest, replace=False, fallback=False):
+ """Create a reflink from `dest` to `path`.
+
+ Raise an `OSError` if `dest` already exists, unless `replace` is
+ True. If `path` == `dest`, then do nothing.
+
+ If reflinking fails and `fallback` is enabled, try copying the file
+ instead. Otherwise, raise an error without trying a plain copy.
+
+ May raise an `ImportError` if the `reflink` module is not available.
+ """
+ import reflink as pyreflink
+
+ if samefile(path, dest):
+ return
+
+ if os.path.exists(syspath(dest)) and not replace:
+ raise FilesystemError('file exists', 'rename', (path, dest))
+
+ try:
+ pyreflink.reflink(path, dest)
+ except (NotImplementedError, pyreflink.ReflinkImpossibleError):
+ if fallback:
+ copy(path, dest, replace)
+ else:
+ raise FilesystemError('OS/filesystem does not support reflinks.',
+ 'link', (path, dest), traceback.format_exc())
+
+
def unique_path(path):
"""Returns a version of ``path`` that does not exist on the
filesystem. Specifically, if ``path` itself already exists, then
@@ -541,22 +607,23 @@ def unique_path(path):
num = 0
while True:
num += 1
- suffix = u'.{}'.format(num).encode() + ext
+ suffix = f'.{num}'.encode() + ext
new_path = base + suffix
if not os.path.exists(new_path):
return new_path
+
# Note: The Windows "reserved characters" are, of course, allowed on
# Unix. They are forbidden here because they cause problems on Samba
# shares, which are sufficiently common as to cause frequent problems.
-# http://msdn.microsoft.com/en-us/library/windows/desktop/aa365247.aspx
+# https://msdn.microsoft.com/en-us/library/windows/desktop/aa365247.aspx
CHAR_REPLACE = [
- (re.compile(r'[\\/]'), u'_'), # / and \ -- forbidden everywhere.
- (re.compile(r'^\.'), u'_'), # Leading dot (hidden files on Unix).
- (re.compile(r'[\x00-\x1f]'), u''), # Control characters.
- (re.compile(r'[<>:"\?\*\|]'), u'_'), # Windows "reserved characters".
- (re.compile(r'\.$'), u'_'), # Trailing dots.
- (re.compile(r'\s+$'), u''), # Trailing whitespace.
+ (re.compile(r'[\\/]'), '_'), # / and \ -- forbidden everywhere.
+ (re.compile(r'^\.'), '_'), # Leading dot (hidden files on Unix).
+ (re.compile(r'[\x00-\x1f]'), ''), # Control characters.
+ (re.compile(r'[<>:"\?\*\|]'), '_'), # Windows "reserved characters".
+ (re.compile(r'\.$'), '_'), # Trailing dots.
+ (re.compile(r'\s+$'), ''), # Trailing whitespace.
]
@@ -680,36 +747,29 @@ def py3_path(path):
it is. So this function helps us "smuggle" the true bytes data
through APIs that took Python 3's Unicode mandate too seriously.
"""
- if isinstance(path, six.text_type):
+ if isinstance(path, str):
return path
assert isinstance(path, bytes)
- if six.PY2:
- return path
return os.fsdecode(path)
def str2bool(value):
"""Returns a boolean reflecting a human-entered string."""
- return value.lower() in (u'yes', u'1', u'true', u't', u'y')
+ return value.lower() in ('yes', '1', 'true', 't', 'y')
def as_string(value):
"""Convert a value to a Unicode object for matching with a query.
None becomes the empty string. Bytestrings are silently decoded.
"""
- if six.PY2:
- buffer_types = buffer, memoryview # noqa: F821
- else:
- buffer_types = memoryview
-
if value is None:
- return u''
- elif isinstance(value, buffer_types):
+ return ''
+ elif isinstance(value, memoryview):
return bytes(value).decode('utf-8', 'ignore')
elif isinstance(value, bytes):
return value.decode('utf-8', 'ignore')
else:
- return six.text_type(value)
+ return str(value)
def text_string(value, encoding='utf-8'):
@@ -732,7 +792,7 @@ def plurality(objs):
"""
c = Counter(objs)
if not c:
- raise ValueError(u'sequence must be non-empty')
+ raise ValueError('sequence must be non-empty')
return c.most_common(1)[0]
@@ -749,7 +809,11 @@ def cpu_count():
num = 0
elif sys.platform == 'darwin':
try:
- num = int(command_output(['/usr/sbin/sysctl', '-n', 'hw.ncpu']))
+ num = int(command_output([
+ '/usr/sbin/sysctl',
+ '-n',
+ 'hw.ncpu',
+ ]).stdout)
except (ValueError, OSError, subprocess.CalledProcessError):
num = 0
else:
@@ -769,20 +833,23 @@ def convert_command_args(args):
assert isinstance(args, list)
def convert(arg):
- if six.PY2:
- if isinstance(arg, six.text_type):
- arg = arg.encode(arg_encoding())
- else:
- if isinstance(arg, bytes):
- arg = arg.decode(arg_encoding(), 'surrogateescape')
+ if isinstance(arg, bytes):
+ arg = arg.decode(arg_encoding(), 'surrogateescape')
return arg
return [convert(a) for a in args]
+# stdout and stderr as bytes
+CommandOutput = namedtuple("CommandOutput", ("stdout", "stderr"))
+
+
def command_output(cmd, shell=False):
"""Runs the command and returns its output after it has exited.
+ Returns a CommandOutput. The attributes ``stdout`` and ``stderr`` contain
+ byte strings of the respective output streams.
+
``cmd`` is a list of arguments starting with the command names. The
arguments are bytes on Unix and strings on Windows.
If ``shell`` is true, ``cmd`` is assumed to be a string and passed to a
@@ -797,10 +864,16 @@ def command_output(cmd, shell=False):
"""
cmd = convert_command_args(cmd)
+ try: # python >= 3.3
+ devnull = subprocess.DEVNULL
+ except AttributeError:
+ devnull = open(os.devnull, 'r+b')
+
proc = subprocess.Popen(
cmd,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
+ stdin=devnull,
close_fds=platform.system() != 'Windows',
shell=shell
)
@@ -811,7 +884,7 @@ def command_output(cmd, shell=False):
cmd=' '.join(cmd),
output=stdout + stderr,
)
- return stdout
+ return CommandOutput(stdout, stderr)
def max_filename_length(path, limit=MAX_FILENAME_LENGTH):
@@ -858,25 +931,6 @@ def editor_command():
return open_anything()
-def shlex_split(s):
- """Split a Unicode or bytes string according to shell lexing rules.
-
- Raise `ValueError` if the string is not a well-formed shell string.
- This is a workaround for a bug in some versions of Python.
- """
- if not six.PY2 or isinstance(s, bytes): # Shlex works fine.
- return shlex.split(s)
-
- elif isinstance(s, six.text_type):
- # Work around a Python bug.
- # http://bugs.python.org/issue6988
- bs = s.encode('utf-8')
- return [c.decode('utf-8') for c in shlex.split(bs)]
-
- else:
- raise TypeError(u'shlex_split called with non-string')
-
-
def interactive_open(targets, command):
"""Open the files in `targets` by `exec`ing a new `command`, given
as a Unicode string. (The new program takes over, and Python
@@ -888,7 +942,7 @@ def interactive_open(targets, command):
# Split the command string into its arguments.
try:
- args = shlex_split(command)
+ args = shlex.split(command)
except ValueError: # Malformed shell tokens.
args = [command]
@@ -903,7 +957,7 @@ def _windows_long_path_name(short_path):
"""Use Windows' `GetLongPathNameW` via ctypes to get the canonical,
long path given a short filename.
"""
- if not isinstance(short_path, six.text_type):
+ if not isinstance(short_path, str):
short_path = short_path.decode(_fsencoding())
import ctypes
@@ -964,7 +1018,7 @@ def raw_seconds_short(string):
"""
match = re.match(r'^(\d+):([0-5]\d)$', string)
if not match:
- raise ValueError(u'String not in M:SS format')
+ raise ValueError('String not in M:SS format')
minutes, seconds = map(int, match.groups())
return float(minutes * 60 + seconds)
@@ -991,3 +1045,59 @@ def asciify_path(path, sep_replace):
sep_replace
)
return os.sep.join(path_components)
+
+
+def par_map(transform, items):
+ """Apply the function `transform` to all the elements in the
+ iterable `items`, like `map(transform, items)` but with no return
+ value. The map *might* happen in parallel: it's parallel on Python 3
+ and sequential on Python 2.
+
+ The parallelism uses threads (not processes), so this is only useful
+ for IO-bound `transform`s.
+ """
+ pool = ThreadPool()
+ pool.map(transform, items)
+ pool.close()
+ pool.join()
+
+
+def lazy_property(func):
+ """A decorator that creates a lazily evaluated property. On first access,
+ the property is assigned the return value of `func`. This first value is
+ stored, so that future accesses do not have to evaluate `func` again.
+
+ This behaviour is useful when `func` is expensive to evaluate, and it is
+ not certain that the result will be needed.
+ """
+ field_name = '_' + func.__name__
+
+ @property
+ @functools.wraps(func)
+ def wrapper(self):
+ if hasattr(self, field_name):
+ return getattr(self, field_name)
+
+ value = func(self)
+ setattr(self, field_name, value)
+ return value
+
+ return wrapper
+
+
+def decode_commandline_path(path):
+ """Prepare a path for substitution into commandline template.
+
+ On Python 3, we need to construct the subprocess commands to invoke as a
+ Unicode string. On Unix, this is a little unfortunate---the OS is
+ expecting bytes---so we use surrogate escaping and decode with the
+ argument encoding, which is the same encoding that will then be
+ *reversed* to recover the same bytes before invoking the OS. On
+ Windows, we want to preserve the Unicode filename "as is."
+ """
+ # On Python 3, the template is a Unicode string, which only supports
+ # substitution of Unicode variables.
+ if platform.system() == 'Windows':
+ return path.decode(_fsencoding())
+ else:
+ return path.decode(arg_encoding(), 'surrogateescape')
diff --git a/lib/beets/util/artresizer.py b/lib/beets/util/artresizer.py
old mode 100755
new mode 100644
index e84b775d..8683e228
--- a/lib/beets/util/artresizer.py
+++ b/lib/beets/util/artresizer.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
# This file is part of beets.
# Copyright 2016, Fabrice Laporte
#
@@ -16,38 +15,39 @@
"""Abstraction layer to resize images using PIL, ImageMagick, or a
public resizing proxy if neither is available.
"""
-from __future__ import division, absolute_import, print_function
import subprocess
import os
+import os.path
import re
from tempfile import NamedTemporaryFile
-from six.moves.urllib.parse import urlencode
+from urllib.parse import urlencode
from beets import logging
from beets import util
-import six
# Resizing methods
PIL = 1
IMAGEMAGICK = 2
WEBPROXY = 3
-if util.SNI_SUPPORTED:
- PROXY_URL = 'https://images.weserv.nl/'
-else:
- PROXY_URL = 'http://images.weserv.nl/'
+PROXY_URL = 'https://images.weserv.nl/'
log = logging.getLogger('beets')
-def resize_url(url, maxwidth):
+def resize_url(url, maxwidth, quality=0):
"""Return a proxied image URL that resizes the original image to
maxwidth (preserving aspect ratio).
"""
- return '{0}?{1}'.format(PROXY_URL, urlencode({
+ params = {
'url': url.replace('http://', ''),
'w': maxwidth,
- }))
+ }
+
+ if quality > 0:
+ params['q'] = quality
+
+ return '{}?{}'.format(PROXY_URL, urlencode(params))
def temp_file_for(path):
@@ -59,49 +59,102 @@ def temp_file_for(path):
return util.bytestring_path(f.name)
-def pil_resize(maxwidth, path_in, path_out=None):
+def pil_resize(maxwidth, path_in, path_out=None, quality=0, max_filesize=0):
"""Resize using Python Imaging Library (PIL). Return the output path
of resized image.
"""
path_out = path_out or temp_file_for(path_in)
from PIL import Image
- log.debug(u'artresizer: PIL resizing {0} to {1}',
+
+ log.debug('artresizer: PIL resizing {0} to {1}',
util.displayable_path(path_in), util.displayable_path(path_out))
try:
im = Image.open(util.syspath(path_in))
size = maxwidth, maxwidth
im.thumbnail(size, Image.ANTIALIAS)
- im.save(path_out)
- return path_out
- except IOError:
- log.error(u"PIL cannot create thumbnail for '{0}'",
+
+ if quality == 0:
+ # Use PIL's default quality.
+ quality = -1
+
+ # progressive=False only affects JPEGs and is the default,
+ # but we include it here for explicitness.
+ im.save(util.py3_path(path_out), quality=quality, progressive=False)
+
+ if max_filesize > 0:
+ # If maximum filesize is set, we attempt to lower the quality of
+ # jpeg conversion by a proportional amount, up to 3 attempts
+ # First, set the maximum quality to either provided, or 95
+ if quality > 0:
+ lower_qual = quality
+ else:
+ lower_qual = 95
+ for i in range(5):
+ # 5 attempts is an abitrary choice
+ filesize = os.stat(util.syspath(path_out)).st_size
+ log.debug("PIL Pass {0} : Output size: {1}B", i, filesize)
+ if filesize <= max_filesize:
+ return path_out
+ # The relationship between filesize & quality will be
+ # image dependent.
+ lower_qual -= 10
+ # Restrict quality dropping below 10
+ if lower_qual < 10:
+ lower_qual = 10
+ # Use optimize flag to improve filesize decrease
+ im.save(util.py3_path(path_out), quality=lower_qual,
+ optimize=True, progressive=False)
+ log.warning("PIL Failed to resize file to below {0}B",
+ max_filesize)
+ return path_out
+
+ else:
+ return path_out
+ except OSError:
+ log.error("PIL cannot create thumbnail for '{0}'",
util.displayable_path(path_in))
return path_in
-def im_resize(maxwidth, path_in, path_out=None):
- """Resize using ImageMagick's ``convert`` tool.
- Return the output path of resized image.
+def im_resize(maxwidth, path_in, path_out=None, quality=0, max_filesize=0):
+ """Resize using ImageMagick.
+
+ Use the ``magick`` program or ``convert`` on older versions. Return
+ the output path of resized image.
"""
path_out = path_out or temp_file_for(path_in)
- log.debug(u'artresizer: ImageMagick resizing {0} to {1}',
+ log.debug('artresizer: ImageMagick resizing {0} to {1}',
util.displayable_path(path_in), util.displayable_path(path_out))
- # "-resize widthxheight>" shrinks images with dimension(s) larger
- # than the corresponding width and/or height dimension(s). The >
- # "only shrink" flag is prefixed by ^ escape char for Windows
- # compatibility.
+ # "-resize WIDTHx>" shrinks images with the width larger
+ # than the given width while maintaining the aspect ratio
+ # with regards to the height.
+ # ImageMagick already seems to default to no interlace, but we include it
+ # here for the sake of explicitness.
+ cmd = ArtResizer.shared.im_convert_cmd + [
+ util.syspath(path_in, prefix=False),
+ '-resize', f'{maxwidth}x>',
+ '-interlace', 'none',
+ ]
+
+ if quality > 0:
+ cmd += ['-quality', f'{quality}']
+
+ # "-define jpeg:extent=SIZEb" sets the target filesize for imagemagick to
+ # SIZE in bytes.
+ if max_filesize > 0:
+ cmd += ['-define', f'jpeg:extent={max_filesize}b']
+
+ cmd.append(util.syspath(path_out, prefix=False))
+
try:
- util.command_output([
- 'convert', util.syspath(path_in, prefix=False),
- '-resize', '{0}x^>'.format(maxwidth),
- util.syspath(path_out, prefix=False),
- ])
+ util.command_output(cmd)
except subprocess.CalledProcessError:
- log.warning(u'artresizer: IM convert failed for {0}',
+ log.warning('artresizer: IM convert failed for {0}',
util.displayable_path(path_in))
return path_in
+
return path_out
@@ -113,31 +166,33 @@ BACKEND_FUNCS = {
def pil_getsize(path_in):
from PIL import Image
+
try:
im = Image.open(util.syspath(path_in))
return im.size
- except IOError as exc:
- log.error(u"PIL could not read file {}: {}",
+ except OSError as exc:
+ log.error("PIL could not read file {}: {}",
util.displayable_path(path_in), exc)
def im_getsize(path_in):
- cmd = ['identify', '-format', '%w %h',
- util.syspath(path_in, prefix=False)]
+ cmd = ArtResizer.shared.im_identify_cmd + \
+ ['-format', '%w %h', util.syspath(path_in, prefix=False)]
+
try:
- out = util.command_output(cmd)
+ out = util.command_output(cmd).stdout
except subprocess.CalledProcessError as exc:
- log.warning(u'ImageMagick size query failed')
+ log.warning('ImageMagick size query failed')
log.debug(
- u'`convert` exited with (status {}) when '
- u'getting size with command {}:\n{}',
+ '`convert` exited with (status {}) when '
+ 'getting size with command {}:\n{}',
exc.returncode, cmd, exc.output.strip()
)
return
try:
return tuple(map(int, out.split(b' ')))
except IndexError:
- log.warning(u'Could not understand IM output: {0!r}', out)
+ log.warning('Could not understand IM output: {0!r}', out)
BACKEND_GET_SIZE = {
@@ -146,24 +201,125 @@ BACKEND_GET_SIZE = {
}
+def pil_deinterlace(path_in, path_out=None):
+ path_out = path_out or temp_file_for(path_in)
+ from PIL import Image
+
+ try:
+ im = Image.open(util.syspath(path_in))
+ im.save(util.py3_path(path_out), progressive=False)
+ return path_out
+ except IOError:
+ return path_in
+
+
+def im_deinterlace(path_in, path_out=None):
+ path_out = path_out or temp_file_for(path_in)
+
+ cmd = ArtResizer.shared.im_convert_cmd + [
+ util.syspath(path_in, prefix=False),
+ '-interlace', 'none',
+ util.syspath(path_out, prefix=False),
+ ]
+
+ try:
+ util.command_output(cmd)
+ return path_out
+ except subprocess.CalledProcessError:
+ return path_in
+
+
+DEINTERLACE_FUNCS = {
+ PIL: pil_deinterlace,
+ IMAGEMAGICK: im_deinterlace,
+}
+
+
+def im_get_format(filepath):
+ cmd = ArtResizer.shared.im_identify_cmd + [
+ '-format', '%[magick]',
+ util.syspath(filepath)
+ ]
+
+ try:
+ return util.command_output(cmd).stdout
+ except subprocess.CalledProcessError:
+ return None
+
+
+def pil_get_format(filepath):
+ from PIL import Image, UnidentifiedImageError
+
+ try:
+ with Image.open(util.syspath(filepath)) as im:
+ return im.format
+ except (ValueError, TypeError, UnidentifiedImageError, FileNotFoundError):
+ log.exception("failed to detect image format for {}", filepath)
+ return None
+
+
+BACKEND_GET_FORMAT = {
+ PIL: pil_get_format,
+ IMAGEMAGICK: im_get_format,
+}
+
+
+def im_convert_format(source, target, deinterlaced):
+ cmd = ArtResizer.shared.im_convert_cmd + [
+ util.syspath(source),
+ *(["-interlace", "none"] if deinterlaced else []),
+ util.syspath(target),
+ ]
+
+ try:
+ subprocess.check_call(
+ cmd,
+ stderr=subprocess.DEVNULL,
+ stdout=subprocess.DEVNULL
+ )
+ return target
+ except subprocess.CalledProcessError:
+ return source
+
+
+def pil_convert_format(source, target, deinterlaced):
+ from PIL import Image, UnidentifiedImageError
+
+ try:
+ with Image.open(util.syspath(source)) as im:
+ im.save(util.py3_path(target), progressive=not deinterlaced)
+ return target
+ except (ValueError, TypeError, UnidentifiedImageError, FileNotFoundError,
+ OSError):
+ log.exception("failed to convert image {} -> {}", source, target)
+ return source
+
+
+BACKEND_CONVERT_IMAGE_FORMAT = {
+ PIL: pil_convert_format,
+ IMAGEMAGICK: im_convert_format,
+}
+
+
class Shareable(type):
"""A pseudo-singleton metaclass that allows both shared and
non-shared instances. The ``MyClass.shared`` property holds a
lazily-created shared instance of ``MyClass`` while calling
``MyClass()`` to construct a new object works as usual.
"""
- def __init__(self, name, bases, dict):
- super(Shareable, self).__init__(name, bases, dict)
- self._instance = None
+
+ def __init__(cls, name, bases, dict):
+ super().__init__(name, bases, dict)
+ cls._instance = None
@property
- def shared(self):
- if self._instance is None:
- self._instance = self()
- return self._instance
+ def shared(cls):
+ if cls._instance is None:
+ cls._instance = cls()
+ return cls._instance
-class ArtResizer(six.with_metaclass(Shareable, object)):
+class ArtResizer(metaclass=Shareable):
"""A singleton class that performs image resizes.
"""
@@ -171,21 +327,44 @@ class ArtResizer(six.with_metaclass(Shareable, object)):
"""Create a resizer object with an inferred method.
"""
self.method = self._check_method()
- log.debug(u"artresizer: method is {0}", self.method)
+ log.debug("artresizer: method is {0}", self.method)
self.can_compare = self._can_compare()
- def resize(self, maxwidth, path_in, path_out=None):
+ # Use ImageMagick's magick binary when it's available. If it's
+ # not, fall back to the older, separate convert and identify
+ # commands.
+ if self.method[0] == IMAGEMAGICK:
+ self.im_legacy = self.method[2]
+ if self.im_legacy:
+ self.im_convert_cmd = ['convert']
+ self.im_identify_cmd = ['identify']
+ else:
+ self.im_convert_cmd = ['magick']
+ self.im_identify_cmd = ['magick', 'identify']
+
+ def resize(
+ self, maxwidth, path_in, path_out=None, quality=0, max_filesize=0
+ ):
"""Manipulate an image file according to the method, returning a
new path. For PIL or IMAGEMAGIC methods, resizes the image to a
- temporary file. For WEBPROXY, returns `path_in` unmodified.
+ temporary file and encodes with the specified quality level.
+ For WEBPROXY, returns `path_in` unmodified.
"""
if self.local:
func = BACKEND_FUNCS[self.method[0]]
- return func(maxwidth, path_in, path_out)
+ return func(maxwidth, path_in, path_out,
+ quality=quality, max_filesize=max_filesize)
else:
return path_in
- def proxy_url(self, maxwidth, url):
+ def deinterlace(self, path_in, path_out=None):
+ if self.local:
+ func = DEINTERLACE_FUNCS[self.method[0]]
+ return func(path_in, path_out)
+ else:
+ return path_in
+
+ def proxy_url(self, maxwidth, url, quality=0):
"""Modifies an image URL according the method, returning a new
URL. For WEBPROXY, a URL on the proxy server is returned.
Otherwise, the URL is returned unmodified.
@@ -193,7 +372,7 @@ class ArtResizer(six.with_metaclass(Shareable, object)):
if self.local:
return url
else:
- return resize_url(url, maxwidth)
+ return resize_url(url, maxwidth, quality)
@property
def local(self):
@@ -206,12 +385,50 @@ class ArtResizer(six.with_metaclass(Shareable, object)):
"""Return the size of an image file as an int couple (width, height)
in pixels.
- Only available locally
+ Only available locally.
"""
if self.local:
func = BACKEND_GET_SIZE[self.method[0]]
return func(path_in)
+ def get_format(self, path_in):
+ """Returns the format of the image as a string.
+
+ Only available locally.
+ """
+ if self.local:
+ func = BACKEND_GET_FORMAT[self.method[0]]
+ return func(path_in)
+
+ def reformat(self, path_in, new_format, deinterlaced=True):
+ """Converts image to desired format, updating its extension, but
+ keeping the same filename.
+
+ Only available locally.
+ """
+ if not self.local:
+ return path_in
+
+ new_format = new_format.lower()
+ # A nonexhaustive map of image "types" to extensions overrides
+ new_format = {
+ 'jpeg': 'jpg',
+ }.get(new_format, new_format)
+
+ fname, ext = os.path.splitext(path_in)
+ path_new = fname + b'.' + new_format.encode('utf8')
+ func = BACKEND_CONVERT_IMAGE_FORMAT[self.method[0]]
+
+ # allows the exception to propagate, while still making sure a changed
+ # file path was removed
+ result_path = path_in
+ try:
+ result_path = func(path_in, path_new, deinterlaced)
+ finally:
+ if result_path != path_in:
+ os.unlink(path_in)
+ return result_path
+
def _can_compare(self):
"""A boolean indicating whether image comparison is available"""
@@ -219,10 +436,20 @@ class ArtResizer(six.with_metaclass(Shareable, object)):
@staticmethod
def _check_method():
- """Return a tuple indicating an available method and its version."""
+ """Return a tuple indicating an available method and its version.
+
+ The result has at least two elements:
+ - The method, eitehr WEBPROXY, PIL, or IMAGEMAGICK.
+ - The version.
+
+ If the method is IMAGEMAGICK, there is also a third element: a
+ bool flag indicating whether to use the `magick` binary or
+ legacy single-purpose executables (`convert`, `identify`, etc.)
+ """
version = get_im_version()
if version:
- return IMAGEMAGICK, version
+ version, legacy = version
+ return IMAGEMAGICK, version, legacy
version = get_pil_version()
if version:
@@ -232,31 +459,34 @@ class ArtResizer(six.with_metaclass(Shareable, object)):
def get_im_version():
- """Return Image Magick version or None if it is unavailable
- Try invoking ImageMagick's "convert".
+ """Get the ImageMagick version and legacy flag as a pair. Or return
+ None if ImageMagick is not available.
"""
- try:
- out = util.command_output(['convert', '--version'])
+ for cmd_name, legacy in ((['magick'], False), (['convert'], True)):
+ cmd = cmd_name + ['--version']
- if b'imagemagick' in out.lower():
- pattern = br".+ (\d+)\.(\d+)\.(\d+).*"
- match = re.search(pattern, out)
- if match:
- return (int(match.group(1)),
- int(match.group(2)),
- int(match.group(3)))
- return (0,)
+ try:
+ out = util.command_output(cmd).stdout
+ except (subprocess.CalledProcessError, OSError) as exc:
+ log.debug('ImageMagick version check failed: {}', exc)
+ else:
+ if b'imagemagick' in out.lower():
+ pattern = br".+ (\d+)\.(\d+)\.(\d+).*"
+ match = re.search(pattern, out)
+ if match:
+ version = (int(match.group(1)),
+ int(match.group(2)),
+ int(match.group(3)))
+ return version, legacy
- except (subprocess.CalledProcessError, OSError) as exc:
- log.debug(u'ImageMagick check `convert --version` failed: {}', exc)
- return None
+ return None
def get_pil_version():
- """Return Image Magick version or None if it is unavailable
- Try importing PIL."""
+ """Get the PIL/Pillow version, or None if it is unavailable.
+ """
try:
- __import__('PIL', fromlist=[str('Image')])
+ __import__('PIL', fromlist=['Image'])
return (0,)
except ImportError:
return None
diff --git a/lib/beets/util/bluelet.py b/lib/beets/util/bluelet.py
old mode 100755
new mode 100644
index 48dd7bd9..a40f3b2f
--- a/lib/beets/util/bluelet.py
+++ b/lib/beets/util/bluelet.py
@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
"""Extremely simple pure-Python implementation of coroutine-style
asynchronous socket I/O. Inspired by, but inferior to, Eventlet.
Bluelet can also be thought of as a less-terrible replacement for
@@ -7,9 +5,7 @@ asyncore.
Bluelet: easy concurrency without all the messy parallelism.
"""
-from __future__ import division, absolute_import, print_function
-import six
import socket
import select
import sys
@@ -22,7 +18,7 @@ import collections
# Basic events used for thread scheduling.
-class Event(object):
+class Event:
"""Just a base class identifying Bluelet events. An event is an
object yielded from a Bluelet thread coroutine to suspend operation
and communicate with the scheduler.
@@ -201,7 +197,7 @@ class ThreadException(Exception):
self.exc_info = exc_info
def reraise(self):
- six.reraise(self.exc_info[0], self.exc_info[1], self.exc_info[2])
+ raise self.exc_info[1].with_traceback(self.exc_info[2])
SUSPENDED = Event() # Special sentinel placeholder for suspended threads.
@@ -269,7 +265,7 @@ def run(root_coro):
except StopIteration:
# Thread is done.
complete_thread(coro, None)
- except:
+ except BaseException:
# Thread raised some other exception.
del threads[coro]
raise ThreadException(coro, sys.exc_info())
@@ -336,16 +332,20 @@ def run(root_coro):
break
# Wait and fire.
- event2coro = dict((v, k) for k, v in threads.items())
+ event2coro = {v: k for k, v in threads.items()}
for event in _event_select(threads.values()):
# Run the IO operation, but catch socket errors.
try:
value = event.fire()
- except socket.error as exc:
+ except OSError as exc:
if isinstance(exc.args, tuple) and \
exc.args[0] == errno.EPIPE:
# Broken pipe. Remote host disconnected.
pass
+ elif isinstance(exc.args, tuple) and \
+ exc.args[0] == errno.ECONNRESET:
+ # Connection was reset by peer.
+ pass
else:
traceback.print_exc()
# Abort the coroutine.
@@ -366,7 +366,7 @@ def run(root_coro):
exit_te = te
break
- except:
+ except BaseException:
# For instance, KeyboardInterrupt during select(). Raise
# into root thread and terminate others.
threads = {root_coro: ExceptionEvent(sys.exc_info())}
@@ -386,7 +386,7 @@ class SocketClosedError(Exception):
pass
-class Listener(object):
+class Listener:
"""A socket wrapper object for listening sockets.
"""
def __init__(self, host, port):
@@ -416,7 +416,7 @@ class Listener(object):
self.sock.close()
-class Connection(object):
+class Connection:
"""A socket wrapper object for connected sockets.
"""
def __init__(self, sock, addr):
@@ -541,7 +541,7 @@ def spawn(coro):
and child coroutines run concurrently.
"""
if not isinstance(coro, types.GeneratorType):
- raise ValueError(u'%s is not a coroutine' % coro)
+ raise ValueError('%s is not a coroutine' % coro)
return SpawnEvent(coro)
@@ -551,7 +551,7 @@ def call(coro):
returns a value using end(), then this event returns that value.
"""
if not isinstance(coro, types.GeneratorType):
- raise ValueError(u'%s is not a coroutine' % coro)
+ raise ValueError('%s is not a coroutine' % coro)
return DelegationEvent(coro)
diff --git a/lib/beets/util/confit.py b/lib/beets/util/confit.py
old mode 100755
new mode 100644
index 373e05ff..dd912c44
--- a/lib/beets/util/confit.py
+++ b/lib/beets/util/confit.py
@@ -1,6 +1,5 @@
-# -*- coding: utf-8 -*-
-# This file is part of Confuse.
-# Copyright 2016, Adrian Sampson.
+# This file is part of beets.
+# Copyright 2016-2019, Adrian Sampson.
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
@@ -13,1447 +12,17 @@
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
-"""Worry-free YAML configuration files.
-"""
-from __future__ import division, absolute_import, print_function
-import platform
-import os
-import pkgutil
-import sys
-import yaml
-import collections
-import re
-from collections import OrderedDict
+import confuse
-UNIX_DIR_VAR = 'XDG_CONFIG_HOME'
-UNIX_DIR_FALLBACK = '~/.config'
-WINDOWS_DIR_VAR = 'APPDATA'
-WINDOWS_DIR_FALLBACK = '~\\AppData\\Roaming'
-MAC_DIR = '~/Library/Application Support'
+import warnings
+warnings.warn("beets.util.confit is deprecated; use confuse instead")
-CONFIG_FILENAME = 'config.yaml'
-DEFAULT_FILENAME = 'config_default.yaml'
-ROOT_NAME = 'root'
+# Import everything from the confuse module into this module.
+for key, value in confuse.__dict__.items():
+ if key not in ['__name__']:
+ globals()[key] = value
-YAML_TAB_PROBLEM = "found character '\\t' that cannot start any token"
-REDACTED_TOMBSTONE = 'REDACTED'
-
-
-# Utilities.
-
-PY3 = sys.version_info[0] == 3
-STRING = str if PY3 else unicode # noqa: F821
-BASESTRING = str if PY3 else basestring # noqa: F821
-NUMERIC_TYPES = (int, float) if PY3 else (int, float, long) # noqa: F821
-
-
-def iter_first(sequence):
- """Get the first element from an iterable or raise a ValueError if
- the iterator generates no values.
- """
- it = iter(sequence)
- try:
- return next(it)
- except StopIteration:
- raise ValueError()
-
-
-# Exceptions.
-
-class ConfigError(Exception):
- """Base class for exceptions raised when querying a configuration.
- """
-
-
-class NotFoundError(ConfigError):
- """A requested value could not be found in the configuration trees.
- """
-
-
-class ConfigValueError(ConfigError):
- """The value in the configuration is illegal."""
-
-
-class ConfigTypeError(ConfigValueError):
- """The value in the configuration did not match the expected type.
- """
-
-
-class ConfigTemplateError(ConfigError):
- """Base class for exceptions raised because of an invalid template.
- """
-
-
-class ConfigReadError(ConfigError):
- """A configuration file could not be read."""
- def __init__(self, filename, reason=None):
- self.filename = filename
- self.reason = reason
-
- message = u'file {0} could not be read'.format(filename)
- if isinstance(reason, yaml.scanner.ScannerError) and \
- reason.problem == YAML_TAB_PROBLEM:
- # Special-case error message for tab indentation in YAML markup.
- message += u': found tab character at line {0}, column {1}'.format(
- reason.problem_mark.line + 1,
- reason.problem_mark.column + 1,
- )
- elif reason:
- # Generic error message uses exception's message.
- message += u': {0}'.format(reason)
-
- super(ConfigReadError, self).__init__(message)
-
-
-# Views and sources.
-
-class ConfigSource(dict):
- """A dictionary augmented with metadata about the source of the
- configuration.
- """
- def __init__(self, value, filename=None, default=False):
- super(ConfigSource, self).__init__(value)
- if filename is not None and not isinstance(filename, BASESTRING):
- raise TypeError(u'filename must be a string or None')
- self.filename = filename
- self.default = default
-
- def __repr__(self):
- return 'ConfigSource({0!r}, {1!r}, {2!r})'.format(
- super(ConfigSource, self),
- self.filename,
- self.default,
- )
-
- @classmethod
- def of(cls, value):
- """Given either a dictionary or a `ConfigSource` object, return
- a `ConfigSource` object. This lets a function accept either type
- of object as an argument.
- """
- if isinstance(value, ConfigSource):
- return value
- elif isinstance(value, dict):
- return ConfigSource(value)
- else:
- raise TypeError(u'source value must be a dict')
-
-
-class ConfigView(object):
- """A configuration "view" is a query into a program's configuration
- data. A view represents a hypothetical location in the configuration
- tree; to extract the data from the location, a client typically
- calls the ``view.get()`` method. The client can access children in
- the tree (subviews) by subscripting the parent view (i.e.,
- ``view[key]``).
- """
-
- name = None
- """The name of the view, depicting the path taken through the
- configuration in Python-like syntax (e.g., ``foo['bar'][42]``).
- """
-
- def resolve(self):
- """The core (internal) data retrieval method. Generates (value,
- source) pairs for each source that contains a value for this
- view. May raise ConfigTypeError if a type error occurs while
- traversing a source.
- """
- raise NotImplementedError
-
- def first(self):
- """Return a (value, source) pair for the first object found for
- this view. This amounts to the first element returned by
- `resolve`. If no values are available, a NotFoundError is
- raised.
- """
- pairs = self.resolve()
- try:
- return iter_first(pairs)
- except ValueError:
- raise NotFoundError(u"{0} not found".format(self.name))
-
- def exists(self):
- """Determine whether the view has a setting in any source.
- """
- try:
- self.first()
- except NotFoundError:
- return False
- return True
-
- def add(self, value):
- """Set the *default* value for this configuration view. The
- specified value is added as the lowest-priority configuration
- data source.
- """
- raise NotImplementedError
-
- def set(self, value):
- """*Override* the value for this configuration view. The
- specified value is added as the highest-priority configuration
- data source.
- """
- raise NotImplementedError
-
- def root(self):
- """The RootView object from which this view is descended.
- """
- raise NotImplementedError
-
- def __repr__(self):
- return '<{}: {}>'.format(self.__class__.__name__, self.name)
-
- def __iter__(self):
- """Iterate over the keys of a dictionary view or the *subviews*
- of a list view.
- """
- # Try getting the keys, if this is a dictionary view.
- try:
- keys = self.keys()
- for key in keys:
- yield key
-
- except ConfigTypeError:
- # Otherwise, try iterating over a list.
- collection = self.get()
- if not isinstance(collection, (list, tuple)):
- raise ConfigTypeError(
- u'{0} must be a dictionary or a list, not {1}'.format(
- self.name, type(collection).__name__
- )
- )
-
- # Yield all the indices in the list.
- for index in range(len(collection)):
- yield self[index]
-
- def __getitem__(self, key):
- """Get a subview of this view."""
- return Subview(self, key)
-
- def __setitem__(self, key, value):
- """Create an overlay source to assign a given key under this
- view.
- """
- self.set({key: value})
-
- def __contains__(self, key):
- return self[key].exists()
-
- def set_args(self, namespace):
- """Overlay parsed command-line arguments, generated by a library
- like argparse or optparse, onto this view's value. ``namespace``
- can be a ``dict`` or namespace object.
- """
- args = {}
- if isinstance(namespace, dict):
- items = namespace.items()
- else:
- items = namespace.__dict__.items()
- for key, value in items:
- if value is not None: # Avoid unset options.
- args[key] = value
- self.set(args)
-
- # Magical conversions. These special methods make it possible to use
- # View objects somewhat transparently in certain circumstances. For
- # example, rather than using ``view.get(bool)``, it's possible to
- # just say ``bool(view)`` or use ``view`` in a conditional.
-
- def __str__(self):
- """Get the value for this view as a bytestring.
- """
- if PY3:
- return self.__unicode__()
- else:
- return bytes(self.get())
-
- def __unicode__(self):
- """Get the value for this view as a Unicode string.
- """
- return STRING(self.get())
-
- def __nonzero__(self):
- """Gets the value for this view as a boolean. (Python 2 only.)
- """
- return self.__bool__()
-
- def __bool__(self):
- """Gets the value for this view as a boolean. (Python 3 only.)
- """
- return bool(self.get())
-
- # Dictionary emulation methods.
-
- def keys(self):
- """Returns a list containing all the keys available as subviews
- of the current views. This enumerates all the keys in *all*
- dictionaries matching the current view, in contrast to
- ``view.get(dict).keys()``, which gets all the keys for the
- *first* dict matching the view. If the object for this view in
- any source is not a dict, then a ConfigTypeError is raised. The
- keys are ordered according to how they appear in each source.
- """
- keys = []
-
- for dic, _ in self.resolve():
- try:
- cur_keys = dic.keys()
- except AttributeError:
- raise ConfigTypeError(
- u'{0} must be a dict, not {1}'.format(
- self.name, type(dic).__name__
- )
- )
-
- for key in cur_keys:
- if key not in keys:
- keys.append(key)
-
- return keys
-
- def items(self):
- """Iterates over (key, subview) pairs contained in dictionaries
- from *all* sources at this view. If the object for this view in
- any source is not a dict, then a ConfigTypeError is raised.
- """
- for key in self.keys():
- yield key, self[key]
-
- def values(self):
- """Iterates over all the subviews contained in dictionaries from
- *all* sources at this view. If the object for this view in any
- source is not a dict, then a ConfigTypeError is raised.
- """
- for key in self.keys():
- yield self[key]
-
- # List/sequence emulation.
-
- def all_contents(self):
- """Iterates over all subviews from collections at this view from
- *all* sources. If the object for this view in any source is not
- iterable, then a ConfigTypeError is raised. This method is
- intended to be used when the view indicates a list; this method
- will concatenate the contents of the list from all sources.
- """
- for collection, _ in self.resolve():
- try:
- it = iter(collection)
- except TypeError:
- raise ConfigTypeError(
- u'{0} must be an iterable, not {1}'.format(
- self.name, type(collection).__name__
- )
- )
- for value in it:
- yield value
-
- # Validation and conversion.
-
- def flatten(self, redact=False):
- """Create a hierarchy of OrderedDicts containing the data from
- this view, recursively reifying all views to get their
- represented values.
-
- If `redact` is set, then sensitive values are replaced with
- the string "REDACTED".
- """
- od = OrderedDict()
- for key, view in self.items():
- if redact and view.redact:
- od[key] = REDACTED_TOMBSTONE
- else:
- try:
- od[key] = view.flatten(redact=redact)
- except ConfigTypeError:
- od[key] = view.get()
- return od
-
- def get(self, template=None):
- """Retrieve the value for this view according to the template.
-
- The `template` against which the values are checked can be
- anything convertible to a `Template` using `as_template`. This
- means you can pass in a default integer or string value, for
- example, or a type to just check that something matches the type
- you expect.
-
- May raise a `ConfigValueError` (or its subclass,
- `ConfigTypeError`) or a `NotFoundError` when the configuration
- doesn't satisfy the template.
- """
- return as_template(template).value(self, template)
-
- # Shortcuts for common templates.
-
- def as_filename(self):
- """Get the value as a path. Equivalent to `get(Filename())`.
- """
- return self.get(Filename())
-
- def as_choice(self, choices):
- """Get the value from a list of choices. Equivalent to
- `get(Choice(choices))`.
- """
- return self.get(Choice(choices))
-
- def as_number(self):
- """Get the value as any number type: int or float. Equivalent to
- `get(Number())`.
- """
- return self.get(Number())
-
- def as_str_seq(self, split=True):
- """Get the value as a sequence of strings. Equivalent to
- `get(StrSeq())`.
- """
- return self.get(StrSeq(split=split))
-
- def as_str(self):
- """Get the value as a (Unicode) string. Equivalent to
- `get(unicode)` on Python 2 and `get(str)` on Python 3.
- """
- return self.get(String())
-
- # Redaction.
-
- @property
- def redact(self):
- """Whether the view contains sensitive information and should be
- redacted from output.
- """
- return () in self.get_redactions()
-
- @redact.setter
- def redact(self, flag):
- self.set_redaction((), flag)
-
- def set_redaction(self, path, flag):
- """Add or remove a redaction for a key path, which should be an
- iterable of keys.
- """
- raise NotImplementedError()
-
- def get_redactions(self):
- """Get the set of currently-redacted sub-key-paths at this view.
- """
- raise NotImplementedError()
-
-
-class RootView(ConfigView):
- """The base of a view hierarchy. This view keeps track of the
- sources that may be accessed by subviews.
- """
- def __init__(self, sources):
- """Create a configuration hierarchy for a list of sources. At
- least one source must be provided. The first source in the list
- has the highest priority.
- """
- self.sources = list(sources)
- self.name = ROOT_NAME
- self.redactions = set()
-
- def add(self, obj):
- self.sources.append(ConfigSource.of(obj))
-
- def set(self, value):
- self.sources.insert(0, ConfigSource.of(value))
-
- def resolve(self):
- return ((dict(s), s) for s in self.sources)
-
- def clear(self):
- """Remove all sources (and redactions) from this
- configuration.
- """
- del self.sources[:]
- self.redactions.clear()
-
- def root(self):
- return self
-
- def set_redaction(self, path, flag):
- if flag:
- self.redactions.add(path)
- elif path in self.redactions:
- self.redactions.remove(path)
-
- def get_redactions(self):
- return self.redactions
-
-
-class Subview(ConfigView):
- """A subview accessed via a subscript of a parent view."""
- def __init__(self, parent, key):
- """Make a subview of a parent view for a given subscript key.
- """
- self.parent = parent
- self.key = key
-
- # Choose a human-readable name for this view.
- if isinstance(self.parent, RootView):
- self.name = ''
- else:
- self.name = self.parent.name
- if not isinstance(self.key, int):
- self.name += '.'
- if isinstance(self.key, int):
- self.name += u'#{0}'.format(self.key)
- elif isinstance(self.key, bytes):
- self.name += self.key.decode('utf-8')
- elif isinstance(self.key, STRING):
- self.name += self.key
- else:
- self.name += repr(self.key)
-
- def resolve(self):
- for collection, source in self.parent.resolve():
- try:
- value = collection[self.key]
- except IndexError:
- # List index out of bounds.
- continue
- except KeyError:
- # Dict key does not exist.
- continue
- except TypeError:
- # Not subscriptable.
- raise ConfigTypeError(
- u"{0} must be a collection, not {1}".format(
- self.parent.name, type(collection).__name__
- )
- )
- yield value, source
-
- def set(self, value):
- self.parent.set({self.key: value})
-
- def add(self, value):
- self.parent.add({self.key: value})
-
- def root(self):
- return self.parent.root()
-
- def set_redaction(self, path, flag):
- self.parent.set_redaction((self.key,) + path, flag)
-
- def get_redactions(self):
- return (kp[1:] for kp in self.parent.get_redactions()
- if kp and kp[0] == self.key)
-
-
-# Config file paths, including platform-specific paths and in-package
-# defaults.
-
-# Based on get_root_path from Flask by Armin Ronacher.
-def _package_path(name):
- """Returns the path to the package containing the named module or
- None if the path could not be identified (e.g., if
- ``name == "__main__"``).
- """
- loader = pkgutil.get_loader(name)
- if loader is None or name == '__main__':
- return None
-
- if hasattr(loader, 'get_filename'):
- filepath = loader.get_filename(name)
- else:
- # Fall back to importing the specified module.
- __import__(name)
- filepath = sys.modules[name].__file__
-
- return os.path.dirname(os.path.abspath(filepath))
-
-
-def config_dirs():
- """Return a platform-specific list of candidates for user
- configuration directories on the system.
-
- The candidates are in order of priority, from highest to lowest. The
- last element is the "fallback" location to be used when no
- higher-priority config file exists.
- """
- paths = []
-
- if platform.system() == 'Darwin':
- paths.append(MAC_DIR)
- paths.append(UNIX_DIR_FALLBACK)
- if UNIX_DIR_VAR in os.environ:
- paths.append(os.environ[UNIX_DIR_VAR])
-
- elif platform.system() == 'Windows':
- paths.append(WINDOWS_DIR_FALLBACK)
- if WINDOWS_DIR_VAR in os.environ:
- paths.append(os.environ[WINDOWS_DIR_VAR])
-
- else:
- # Assume Unix.
- paths.append(UNIX_DIR_FALLBACK)
- if UNIX_DIR_VAR in os.environ:
- paths.append(os.environ[UNIX_DIR_VAR])
-
- # Expand and deduplicate paths.
- out = []
- for path in paths:
- path = os.path.abspath(os.path.expanduser(path))
- if path not in out:
- out.append(path)
- return out
-
-
-# YAML loading.
-
-class Loader(yaml.SafeLoader):
- """A customized YAML loader. This loader deviates from the official
- YAML spec in a few convenient ways:
-
- - All strings as are Unicode objects.
- - All maps are OrderedDicts.
- - Strings can begin with % without quotation.
- """
- # All strings should be Unicode objects, regardless of contents.
- def _construct_unicode(self, node):
- return self.construct_scalar(node)
-
- # Use ordered dictionaries for every YAML map.
- # From https://gist.github.com/844388
- def construct_yaml_map(self, node):
- data = OrderedDict()
- yield data
- value = self.construct_mapping(node)
- data.update(value)
-
- def construct_mapping(self, node, deep=False):
- if isinstance(node, yaml.MappingNode):
- self.flatten_mapping(node)
- else:
- raise yaml.constructor.ConstructorError(
- None, None,
- u'expected a mapping node, but found %s' % node.id,
- node.start_mark
- )
-
- mapping = OrderedDict()
- for key_node, value_node in node.value:
- key = self.construct_object(key_node, deep=deep)
- try:
- hash(key)
- except TypeError as exc:
- raise yaml.constructor.ConstructorError(
- u'while constructing a mapping',
- node.start_mark, 'found unacceptable key (%s)' % exc,
- key_node.start_mark
- )
- value = self.construct_object(value_node, deep=deep)
- mapping[key] = value
- return mapping
-
- # Allow bare strings to begin with %. Directives are still detected.
- def check_plain(self):
- plain = super(Loader, self).check_plain()
- return plain or self.peek() == '%'
-
-
-Loader.add_constructor('tag:yaml.org,2002:str', Loader._construct_unicode)
-Loader.add_constructor('tag:yaml.org,2002:map', Loader.construct_yaml_map)
-Loader.add_constructor('tag:yaml.org,2002:omap', Loader.construct_yaml_map)
-
-
-def load_yaml(filename):
- """Read a YAML document from a file. If the file cannot be read or
- parsed, a ConfigReadError is raised.
- """
- try:
- with open(filename, 'r') as f:
- return yaml.load(f, Loader=Loader)
- except (IOError, yaml.error.YAMLError) as exc:
- raise ConfigReadError(filename, exc)
-
-
-# YAML dumping.
-
-class Dumper(yaml.SafeDumper):
- """A PyYAML Dumper that represents OrderedDicts as ordinary mappings
- (in order, of course).
- """
- # From http://pyyaml.org/attachment/ticket/161/use_ordered_dict.py
- def represent_mapping(self, tag, mapping, flow_style=None):
- value = []
- node = yaml.MappingNode(tag, value, flow_style=flow_style)
- if self.alias_key is not None:
- self.represented_objects[self.alias_key] = node
- best_style = False
- if hasattr(mapping, 'items'):
- mapping = list(mapping.items())
- for item_key, item_value in mapping:
- node_key = self.represent_data(item_key)
- node_value = self.represent_data(item_value)
- if not (isinstance(node_key, yaml.ScalarNode) and
- not node_key.style):
- best_style = False
- if not (isinstance(node_value, yaml.ScalarNode) and
- not node_value.style):
- best_style = False
- value.append((node_key, node_value))
- if flow_style is None:
- if self.default_flow_style is not None:
- node.flow_style = self.default_flow_style
- else:
- node.flow_style = best_style
- return node
-
- def represent_list(self, data):
- """If a list has less than 4 items, represent it in inline style
- (i.e. comma separated, within square brackets).
- """
- node = super(Dumper, self).represent_list(data)
- length = len(data)
- if self.default_flow_style is None and length < 4:
- node.flow_style = True
- elif self.default_flow_style is None:
- node.flow_style = False
- return node
-
- def represent_bool(self, data):
- """Represent bool as 'yes' or 'no' instead of 'true' or 'false'.
- """
- if data:
- value = u'yes'
- else:
- value = u'no'
- return self.represent_scalar('tag:yaml.org,2002:bool', value)
-
- def represent_none(self, data):
- """Represent a None value with nothing instead of 'none'.
- """
- return self.represent_scalar('tag:yaml.org,2002:null', '')
-
-
-Dumper.add_representer(OrderedDict, Dumper.represent_dict)
-Dumper.add_representer(bool, Dumper.represent_bool)
-Dumper.add_representer(type(None), Dumper.represent_none)
-Dumper.add_representer(list, Dumper.represent_list)
-
-
-def restore_yaml_comments(data, default_data):
- """Scan default_data for comments (we include empty lines in our
- definition of comments) and place them before the same keys in data.
- Only works with comments that are on one or more own lines, i.e.
- not next to a yaml mapping.
- """
- comment_map = dict()
- default_lines = iter(default_data.splitlines())
- for line in default_lines:
- if not line:
- comment = "\n"
- elif line.startswith("#"):
- comment = "{0}\n".format(line)
- else:
- continue
- while True:
- line = next(default_lines)
- if line and not line.startswith("#"):
- break
- comment += "{0}\n".format(line)
- key = line.split(':')[0].strip()
- comment_map[key] = comment
- out_lines = iter(data.splitlines())
- out_data = ""
- for line in out_lines:
- key = line.split(':')[0].strip()
- if key in comment_map:
- out_data += comment_map[key]
- out_data += "{0}\n".format(line)
- return out_data
-
-
-# Main interface.
-
-class Configuration(RootView):
- def __init__(self, appname, modname=None, read=True):
- """Create a configuration object by reading the
- automatically-discovered config files for the application for a
- given name. If `modname` is specified, it should be the import
- name of a module whose package will be searched for a default
- config file. (Otherwise, no defaults are used.) Pass `False` for
- `read` to disable automatic reading of all discovered
- configuration files. Use this when creating a configuration
- object at module load time and then call the `read` method
- later.
- """
- super(Configuration, self).__init__([])
- self.appname = appname
- self.modname = modname
-
- self._env_var = '{0}DIR'.format(self.appname.upper())
-
- if read:
- self.read()
-
- def user_config_path(self):
- """Points to the location of the user configuration.
-
- The file may not exist.
- """
- return os.path.join(self.config_dir(), CONFIG_FILENAME)
-
- def _add_user_source(self):
- """Add the configuration options from the YAML file in the
- user's configuration directory (given by `config_dir`) if it
- exists.
- """
- filename = self.user_config_path()
- if os.path.isfile(filename):
- self.add(ConfigSource(load_yaml(filename) or {}, filename))
-
- def _add_default_source(self):
- """Add the package's default configuration settings. This looks
- for a YAML file located inside the package for the module
- `modname` if it was given.
- """
- if self.modname:
- pkg_path = _package_path(self.modname)
- if pkg_path:
- filename = os.path.join(pkg_path, DEFAULT_FILENAME)
- if os.path.isfile(filename):
- self.add(ConfigSource(load_yaml(filename), filename, True))
-
- def read(self, user=True, defaults=True):
- """Find and read the files for this configuration and set them
- as the sources for this configuration. To disable either
- discovered user configuration files or the in-package defaults,
- set `user` or `defaults` to `False`.
- """
- if user:
- self._add_user_source()
- if defaults:
- self._add_default_source()
-
- def config_dir(self):
- """Get the path to the user configuration directory. The
- directory is guaranteed to exist as a postcondition (one may be
- created if none exist).
-
- If the application's ``...DIR`` environment variable is set, it
- is used as the configuration directory. Otherwise,
- platform-specific standard configuration locations are searched
- for a ``config.yaml`` file. If no configuration file is found, a
- fallback path is used.
- """
- # If environment variable is set, use it.
- if self._env_var in os.environ:
- appdir = os.environ[self._env_var]
- appdir = os.path.abspath(os.path.expanduser(appdir))
- if os.path.isfile(appdir):
- raise ConfigError(u'{0} must be a directory'.format(
- self._env_var
- ))
-
- else:
- # Search platform-specific locations. If no config file is
- # found, fall back to the final directory in the list.
- for confdir in config_dirs():
- appdir = os.path.join(confdir, self.appname)
- if os.path.isfile(os.path.join(appdir, CONFIG_FILENAME)):
- break
-
- # Ensure that the directory exists.
- if not os.path.isdir(appdir):
- os.makedirs(appdir)
- return appdir
-
- def set_file(self, filename):
- """Parses the file as YAML and inserts it into the configuration
- sources with highest priority.
- """
- filename = os.path.abspath(filename)
- self.set(ConfigSource(load_yaml(filename), filename))
-
- def dump(self, full=True, redact=False):
- """Dump the Configuration object to a YAML file.
-
- The order of the keys is determined from the default
- configuration file. All keys not in the default configuration
- will be appended to the end of the file.
-
- :param filename: The file to dump the configuration to, or None
- if the YAML string should be returned instead
- :type filename: unicode
- :param full: Dump settings that don't differ from the defaults
- as well
- :param redact: Remove sensitive information (views with the `redact`
- flag set) from the output
- """
- if full:
- out_dict = self.flatten(redact=redact)
- else:
- # Exclude defaults when flattening.
- sources = [s for s in self.sources if not s.default]
- temp_root = RootView(sources)
- temp_root.redactions = self.redactions
- out_dict = temp_root.flatten(redact=redact)
-
- yaml_out = yaml.dump(out_dict, Dumper=Dumper,
- default_flow_style=None, indent=4,
- width=1000)
-
- # Restore comments to the YAML text.
- default_source = None
- for source in self.sources:
- if source.default:
- default_source = source
- break
- if default_source and default_source.filename:
- with open(default_source.filename, 'r') as fp:
- default_data = fp.read()
- yaml_out = restore_yaml_comments(yaml_out, default_data)
-
- return yaml_out
-
-
-class LazyConfig(Configuration):
- """A Configuration at reads files on demand when it is first
- accessed. This is appropriate for using as a global config object at
- the module level.
- """
- def __init__(self, appname, modname=None):
- super(LazyConfig, self).__init__(appname, modname, False)
- self._materialized = False # Have we read the files yet?
- self._lazy_prefix = [] # Pre-materialization calls to set().
- self._lazy_suffix = [] # Calls to add().
-
- def read(self, user=True, defaults=True):
- self._materialized = True
- super(LazyConfig, self).read(user, defaults)
-
- def resolve(self):
- if not self._materialized:
- # Read files and unspool buffers.
- self.read()
- self.sources += self._lazy_suffix
- self.sources[:0] = self._lazy_prefix
- return super(LazyConfig, self).resolve()
-
- def add(self, value):
- super(LazyConfig, self).add(value)
- if not self._materialized:
- # Buffer additions to end.
- self._lazy_suffix += self.sources
- del self.sources[:]
-
- def set(self, value):
- super(LazyConfig, self).set(value)
- if not self._materialized:
- # Buffer additions to beginning.
- self._lazy_prefix[:0] = self.sources
- del self.sources[:]
-
- def clear(self):
- """Remove all sources from this configuration."""
- super(LazyConfig, self).clear()
- self._lazy_suffix = []
- self._lazy_prefix = []
-
-
-# "Validated" configuration views: experimental!
-
-
-REQUIRED = object()
-"""A sentinel indicating that there is no default value and an exception
-should be raised when the value is missing.
-"""
-
-
-class Template(object):
- """A value template for configuration fields.
-
- The template works like a type and instructs Confuse about how to
- interpret a deserialized YAML value. This includes type conversions,
- providing a default value, and validating for errors. For example, a
- filepath type might expand tildes and check that the file exists.
- """
- def __init__(self, default=REQUIRED):
- """Create a template with a given default value.
-
- If `default` is the sentinel `REQUIRED` (as it is by default),
- then an error will be raised when a value is missing. Otherwise,
- missing values will instead return `default`.
- """
- self.default = default
-
- def __call__(self, view):
- """Invoking a template on a view gets the view's value according
- to the template.
- """
- return self.value(view, self)
-
- def value(self, view, template=None):
- """Get the value for a `ConfigView`.
-
- May raise a `NotFoundError` if the value is missing (and the
- template requires it) or a `ConfigValueError` for invalid values.
- """
- if view.exists():
- value, _ = view.first()
- return self.convert(value, view)
- elif self.default is REQUIRED:
- # Missing required value. This is an error.
- raise NotFoundError(u"{0} not found".format(view.name))
- else:
- # Missing value, but not required.
- return self.default
-
- def convert(self, value, view):
- """Convert the YAML-deserialized value to a value of the desired
- type.
-
- Subclasses should override this to provide useful conversions.
- May raise a `ConfigValueError` when the configuration is wrong.
- """
- # Default implementation does no conversion.
- return value
-
- def fail(self, message, view, type_error=False):
- """Raise an exception indicating that a value cannot be
- accepted.
-
- `type_error` indicates whether the error is due to a type
- mismatch rather than a malformed value. In this case, a more
- specific exception is raised.
- """
- exc_class = ConfigTypeError if type_error else ConfigValueError
- raise exc_class(
- u'{0}: {1}'.format(view.name, message)
- )
-
- def __repr__(self):
- return '{0}({1})'.format(
- type(self).__name__,
- '' if self.default is REQUIRED else repr(self.default),
- )
-
-
-class Integer(Template):
- """An integer configuration value template.
- """
- def convert(self, value, view):
- """Check that the value is an integer. Floats are rounded.
- """
- if isinstance(value, int):
- return value
- elif isinstance(value, float):
- return int(value)
- else:
- self.fail(u'must be a number', view, True)
-
-
-class Number(Template):
- """A numeric type: either an integer or a floating-point number.
- """
- def convert(self, value, view):
- """Check that the value is an int or a float.
- """
- if isinstance(value, NUMERIC_TYPES):
- return value
- else:
- self.fail(
- u'must be numeric, not {0}'.format(type(value).__name__),
- view,
- True
- )
-
-
-class MappingTemplate(Template):
- """A template that uses a dictionary to specify other types for the
- values for a set of keys and produce a validated `AttrDict`.
- """
- def __init__(self, mapping):
- """Create a template according to a dict (mapping). The
- mapping's values should themselves either be Types or
- convertible to Types.
- """
- subtemplates = {}
- for key, typ in mapping.items():
- subtemplates[key] = as_template(typ)
- self.subtemplates = subtemplates
-
- def value(self, view, template=None):
- """Get a dict with the same keys as the template and values
- validated according to the value types.
- """
- out = AttrDict()
- for key, typ in self.subtemplates.items():
- out[key] = typ.value(view[key], self)
- return out
-
- def __repr__(self):
- return 'MappingTemplate({0})'.format(repr(self.subtemplates))
-
-
-class String(Template):
- """A string configuration value template.
- """
- def __init__(self, default=REQUIRED, pattern=None):
- """Create a template with the added optional `pattern` argument,
- a regular expression string that the value should match.
- """
- super(String, self).__init__(default)
- self.pattern = pattern
- if pattern:
- self.regex = re.compile(pattern)
-
- def __repr__(self):
- args = []
-
- if self.default is not REQUIRED:
- args.append(repr(self.default))
-
- if self.pattern is not None:
- args.append('pattern=' + repr(self.pattern))
-
- return 'String({0})'.format(', '.join(args))
-
- def convert(self, value, view):
- """Check that the value is a string and matches the pattern.
- """
- if isinstance(value, BASESTRING):
- if self.pattern and not self.regex.match(value):
- self.fail(
- u"must match the pattern {0}".format(self.pattern),
- view
- )
- return value
- else:
- self.fail(u'must be a string', view, True)
-
-
-class Choice(Template):
- """A template that permits values from a sequence of choices.
- """
- def __init__(self, choices):
- """Create a template that validates any of the values from the
- iterable `choices`.
-
- If `choices` is a map, then the corresponding value is emitted.
- Otherwise, the value itself is emitted.
- """
- self.choices = choices
-
- def convert(self, value, view):
- """Ensure that the value is among the choices (and remap if the
- choices are a mapping).
- """
- if value not in self.choices:
- self.fail(
- u'must be one of {0}, not {1}'.format(
- repr(list(self.choices)), repr(value)
- ),
- view
- )
-
- if isinstance(self.choices, collections.Mapping):
- return self.choices[value]
- else:
- return value
-
- def __repr__(self):
- return 'Choice({0!r})'.format(self.choices)
-
-
-class OneOf(Template):
- """A template that permits values complying to one of the given templates.
- """
- def __init__(self, allowed, default=REQUIRED):
- super(OneOf, self).__init__(default)
- self.allowed = list(allowed)
-
- def __repr__(self):
- args = []
-
- if self.allowed is not None:
- args.append('allowed=' + repr(self.allowed))
-
- if self.default is not REQUIRED:
- args.append(repr(self.default))
-
- return 'OneOf({0})'.format(', '.join(args))
-
- def value(self, view, template):
- self.template = template
- return super(OneOf, self).value(view, template)
-
- def convert(self, value, view):
- """Ensure that the value follows at least one template.
- """
- is_mapping = isinstance(self.template, MappingTemplate)
-
- for candidate in self.allowed:
- try:
- if is_mapping:
- if isinstance(candidate, Filename) and \
- candidate.relative_to:
- next_template = candidate.template_with_relatives(
- view,
- self.template
- )
-
- next_template.subtemplates[view.key] = as_template(
- candidate
- )
- else:
- next_template = MappingTemplate({view.key: candidate})
-
- return view.parent.get(next_template)[view.key]
- else:
- return view.get(candidate)
- except ConfigTemplateError:
- raise
- except ConfigError:
- pass
- except ValueError as exc:
- raise ConfigTemplateError(exc)
-
- self.fail(
- u'must be one of {0}, not {1}'.format(
- repr(self.allowed), repr(value)
- ),
- view
- )
-
-
-class StrSeq(Template):
- """A template for values that are lists of strings.
-
- Validates both actual YAML string lists and single strings. Strings
- can optionally be split on whitespace.
- """
- def __init__(self, split=True):
- """Create a new template.
-
- `split` indicates whether, when the underlying value is a single
- string, it should be split on whitespace. Otherwise, the
- resulting value is a list containing a single string.
- """
- super(StrSeq, self).__init__()
- self.split = split
-
- def convert(self, value, view):
- if isinstance(value, bytes):
- value = value.decode('utf-8', 'ignore')
-
- if isinstance(value, STRING):
- if self.split:
- return value.split()
- else:
- return [value]
-
- try:
- value = list(value)
- except TypeError:
- self.fail(u'must be a whitespace-separated string or a list',
- view, True)
-
- def convert(x):
- if isinstance(x, STRING):
- return x
- elif isinstance(x, bytes):
- return x.decode('utf-8', 'ignore')
- else:
- self.fail(u'must be a list of strings', view, True)
- return list(map(convert, value))
-
-
-class Filename(Template):
- """A template that validates strings as filenames.
-
- Filenames are returned as absolute, tilde-free paths.
-
- Relative paths are relative to the template's `cwd` argument
- when it is specified, then the configuration directory (see
- the `config_dir` method) if they come from a file. Otherwise,
- they are relative to the current working directory. This helps
- attain the expected behavior when using command-line options.
- """
- def __init__(self, default=REQUIRED, cwd=None, relative_to=None,
- in_app_dir=False):
- """`relative_to` is the name of a sibling value that is
- being validated at the same time.
-
- `in_app_dir` indicates whether the path should be resolved
- inside the application's config directory (even when the setting
- does not come from a file).
- """
- super(Filename, self).__init__(default)
- self.cwd = cwd
- self.relative_to = relative_to
- self.in_app_dir = in_app_dir
-
- def __repr__(self):
- args = []
-
- if self.default is not REQUIRED:
- args.append(repr(self.default))
-
- if self.cwd is not None:
- args.append('cwd=' + repr(self.cwd))
-
- if self.relative_to is not None:
- args.append('relative_to=' + repr(self.relative_to))
-
- if self.in_app_dir:
- args.append('in_app_dir=True')
-
- return 'Filename({0})'.format(', '.join(args))
-
- def resolve_relative_to(self, view, template):
- if not isinstance(template, (collections.Mapping, MappingTemplate)):
- # disallow config.get(Filename(relative_to='foo'))
- raise ConfigTemplateError(
- u'relative_to may only be used when getting multiple values.'
- )
-
- elif self.relative_to == view.key:
- raise ConfigTemplateError(
- u'{0} is relative to itself'.format(view.name)
- )
-
- elif self.relative_to not in view.parent.keys():
- # self.relative_to is not in the config
- self.fail(
- (
- u'needs sibling value "{0}" to expand relative path'
- ).format(self.relative_to),
- view
- )
-
- old_template = {}
- old_template.update(template.subtemplates)
-
- # save time by skipping MappingTemplate's init loop
- next_template = MappingTemplate({})
- next_relative = self.relative_to
-
- # gather all the needed templates and nothing else
- while next_relative is not None:
- try:
- # pop to avoid infinite loop because of recursive
- # relative paths
- rel_to_template = old_template.pop(next_relative)
- except KeyError:
- if next_relative in template.subtemplates:
- # we encountered this config key previously
- raise ConfigTemplateError((
- u'{0} and {1} are recursively relative'
- ).format(view.name, self.relative_to))
- else:
- raise ConfigTemplateError((
- u'missing template for {0}, needed to expand {1}\'s' +
- u'relative path'
- ).format(self.relative_to, view.name))
-
- next_template.subtemplates[next_relative] = rel_to_template
- next_relative = rel_to_template.relative_to
-
- return view.parent.get(next_template)[self.relative_to]
-
- def value(self, view, template=None):
- path, source = view.first()
- if not isinstance(path, BASESTRING):
- self.fail(
- u'must be a filename, not {0}'.format(type(path).__name__),
- view,
- True
- )
- path = os.path.expanduser(STRING(path))
-
- if not os.path.isabs(path):
- if self.cwd is not None:
- # relative to the template's argument
- path = os.path.join(self.cwd, path)
-
- elif self.relative_to is not None:
- path = os.path.join(
- self.resolve_relative_to(view, template),
- path,
- )
-
- elif source.filename or self.in_app_dir:
- # From defaults: relative to the app's directory.
- path = os.path.join(view.root().config_dir(), path)
-
- return os.path.abspath(path)
-
-
-class TypeTemplate(Template):
- """A simple template that checks that a value is an instance of a
- desired Python type.
- """
- def __init__(self, typ, default=REQUIRED):
- """Create a template that checks that the value is an instance
- of `typ`.
- """
- super(TypeTemplate, self).__init__(default)
- self.typ = typ
-
- def convert(self, value, view):
- if not isinstance(value, self.typ):
- self.fail(
- u'must be a {0}, not {1}'.format(
- self.typ.__name__,
- type(value).__name__,
- ),
- view,
- True
- )
- return value
-
-
-class AttrDict(dict):
- """A `dict` subclass that can be accessed via attributes (dot
- notation) for convenience.
- """
- def __getattr__(self, key):
- if key in self:
- return self[key]
- else:
- raise AttributeError(key)
-
-
-def as_template(value):
- """Convert a simple "shorthand" Python value to a `Template`.
- """
- if isinstance(value, Template):
- # If it's already a Template, pass it through.
- return value
- elif isinstance(value, collections.Mapping):
- # Dictionaries work as templates.
- return MappingTemplate(value)
- elif value is int:
- return Integer()
- elif isinstance(value, int):
- return Integer(value)
- elif isinstance(value, type) and issubclass(value, BASESTRING):
- return String()
- elif isinstance(value, BASESTRING):
- return String(value)
- elif isinstance(value, set):
- # convert to list to avoid hash related problems
- return Choice(list(value))
- elif isinstance(value, list):
- return OneOf(value)
- elif value is float:
- return Number()
- elif value is None:
- return Template()
- elif value is dict:
- return TypeTemplate(collections.Mapping)
- elif value is list:
- return TypeTemplate(collections.Sequence)
- elif isinstance(value, type):
- return TypeTemplate(value)
- else:
- raise ValueError(u'cannot convert to template: {0!r}'.format(value))
+# Cleanup namespace.
+del key, value, warnings, confuse
diff --git a/lib/beets/util/enumeration.py b/lib/beets/util/enumeration.py
old mode 100755
new mode 100644
index 3e946718..e49f6fdd
--- a/lib/beets/util/enumeration.py
+++ b/lib/beets/util/enumeration.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
# This file is part of beets.
# Copyright 2016, Adrian Sampson.
#
@@ -13,7 +12,6 @@
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
-from __future__ import division, absolute_import, print_function
from enum import Enum
diff --git a/lib/beets/util/functemplate.py b/lib/beets/util/functemplate.py
old mode 100755
new mode 100644
index 51716552..289a436d
--- a/lib/beets/util/functemplate.py
+++ b/lib/beets/util/functemplate.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
# This file is part of beets.
# Copyright 2016, Adrian Sampson.
#
@@ -27,30 +26,30 @@ This is sort of like a tiny, horrible degeneration of a real templating
engine like Jinja2 or Mustache.
"""
-from __future__ import division, absolute_import, print_function
import re
import ast
import dis
import types
import sys
-import six
+import functools
-SYMBOL_DELIM = u'$'
-FUNC_DELIM = u'%'
-GROUP_OPEN = u'{'
-GROUP_CLOSE = u'}'
-ARG_SEP = u','
-ESCAPE_CHAR = u'$'
+SYMBOL_DELIM = '$'
+FUNC_DELIM = '%'
+GROUP_OPEN = '{'
+GROUP_CLOSE = '}'
+ARG_SEP = ','
+ESCAPE_CHAR = '$'
VARIABLE_PREFIX = '__var_'
FUNCTION_PREFIX = '__func_'
-class Environment(object):
+class Environment:
"""Contains the values and functions to be substituted into a
template.
"""
+
def __init__(self, values, functions):
self.values = values
self.functions = functions
@@ -72,15 +71,7 @@ def ex_literal(val):
"""An int, float, long, bool, string, or None literal with the given
value.
"""
- if val is None:
- return ast.Name('None', ast.Load())
- elif isinstance(val, six.integer_types):
- return ast.Num(val)
- elif isinstance(val, bool):
- return ast.Name(bytes(val), ast.Load())
- elif isinstance(val, six.string_types):
- return ast.Str(val)
- raise TypeError(u'no literal for {0}'.format(type(val)))
+ return ast.Constant(val)
def ex_varassign(name, expr):
@@ -97,7 +88,7 @@ def ex_call(func, args):
function may be an expression or the name of a function. Each
argument may be an expression or a value to be used as a literal.
"""
- if isinstance(func, six.string_types):
+ if isinstance(func, str):
func = ex_rvalue(func)
args = list(args)
@@ -105,10 +96,7 @@ def ex_call(func, args):
if not isinstance(args[i], ast.expr):
args[i] = ex_literal(args[i])
- if sys.version_info[:2] < (3, 5):
- return ast.Call(func, args, [], None, None)
- else:
- return ast.Call(func, args, [])
+ return ast.Call(func, args, [])
def compile_func(arg_names, statements, name='_the_func', debug=False):
@@ -116,32 +104,30 @@ def compile_func(arg_names, statements, name='_the_func', debug=False):
the resulting Python function. If `debug`, then print out the
bytecode of the compiled function.
"""
- if six.PY2:
- func_def = ast.FunctionDef(
- name=name.encode('utf-8'),
- args=ast.arguments(
- args=[ast.Name(n, ast.Param()) for n in arg_names],
- vararg=None,
- kwarg=None,
- defaults=[ex_literal(None) for _ in arg_names],
- ),
- body=statements,
- decorator_list=[],
- )
- else:
- func_def = ast.FunctionDef(
- name=name,
- args=ast.arguments(
- args=[ast.arg(arg=n, annotation=None) for n in arg_names],
- kwonlyargs=[],
- kw_defaults=[],
- defaults=[ex_literal(None) for _ in arg_names],
- ),
- body=statements,
- decorator_list=[],
- )
+ args_fields = {
+ 'args': [ast.arg(arg=n, annotation=None) for n in arg_names],
+ 'kwonlyargs': [],
+ 'kw_defaults': [],
+ 'defaults': [ex_literal(None) for _ in arg_names],
+ }
+ if 'posonlyargs' in ast.arguments._fields: # Added in Python 3.8.
+ args_fields['posonlyargs'] = []
+ args = ast.arguments(**args_fields)
+
+ func_def = ast.FunctionDef(
+ name=name,
+ args=args,
+ body=statements,
+ decorator_list=[],
+ )
+
+ # The ast.Module signature changed in 3.8 to accept a list of types to
+ # ignore.
+ if sys.version_info >= (3, 8):
+ mod = ast.Module([func_def], [])
+ else:
+ mod = ast.Module([func_def])
- mod = ast.Module([func_def])
ast.fix_missing_locations(mod)
prog = compile(mod, '', 'exec')
@@ -160,14 +146,15 @@ def compile_func(arg_names, statements, name='_the_func', debug=False):
# AST nodes for the template language.
-class Symbol(object):
+class Symbol:
"""A variable-substitution symbol in a template."""
+
def __init__(self, ident, original):
self.ident = ident
self.original = original
def __repr__(self):
- return u'Symbol(%s)' % repr(self.ident)
+ return 'Symbol(%s)' % repr(self.ident)
def evaluate(self, env):
"""Evaluate the symbol in the environment, returning a Unicode
@@ -182,24 +169,22 @@ class Symbol(object):
def translate(self):
"""Compile the variable lookup."""
- if six.PY2:
- ident = self.ident.encode('utf-8')
- else:
- ident = self.ident
+ ident = self.ident
expr = ex_rvalue(VARIABLE_PREFIX + ident)
- return [expr], set([ident]), set()
+ return [expr], {ident}, set()
-class Call(object):
+class Call:
"""A function call in a template."""
+
def __init__(self, ident, args, original):
self.ident = ident
self.args = args
self.original = original
def __repr__(self):
- return u'Call(%s, %s, %s)' % (repr(self.ident), repr(self.args),
- repr(self.original))
+ return 'Call({}, {}, {})'.format(repr(self.ident), repr(self.args),
+ repr(self.original))
def evaluate(self, env):
"""Evaluate the function call in the environment, returning a
@@ -212,19 +197,15 @@ class Call(object):
except Exception as exc:
# Function raised exception! Maybe inlining the name of
# the exception will help debug.
- return u'<%s>' % six.text_type(exc)
- return six.text_type(out)
+ return '<%s>' % str(exc)
+ return str(out)
else:
return self.original
def translate(self):
"""Compile the function call."""
varnames = set()
- if six.PY2:
- ident = self.ident.encode('utf-8')
- else:
- ident = self.ident
- funcnames = set([ident])
+ funcnames = {self.ident}
arg_exprs = []
for arg in self.args:
@@ -235,32 +216,33 @@ class Call(object):
# Create a subexpression that joins the result components of
# the arguments.
arg_exprs.append(ex_call(
- ast.Attribute(ex_literal(u''), 'join', ast.Load()),
+ ast.Attribute(ex_literal(''), 'join', ast.Load()),
[ex_call(
'map',
[
- ex_rvalue(six.text_type.__name__),
+ ex_rvalue(str.__name__),
ast.List(subexprs, ast.Load()),
]
)],
))
subexpr_call = ex_call(
- FUNCTION_PREFIX + ident,
+ FUNCTION_PREFIX + self.ident,
arg_exprs
)
return [subexpr_call], varnames, funcnames
-class Expression(object):
+class Expression:
"""Top-level template construct: contains a list of text blobs,
Symbols, and Calls.
"""
+
def __init__(self, parts):
self.parts = parts
def __repr__(self):
- return u'Expression(%s)' % (repr(self.parts))
+ return 'Expression(%s)' % (repr(self.parts))
def evaluate(self, env):
"""Evaluate the entire expression in the environment, returning
@@ -268,11 +250,11 @@ class Expression(object):
"""
out = []
for part in self.parts:
- if isinstance(part, six.string_types):
+ if isinstance(part, str):
out.append(part)
else:
out.append(part.evaluate(env))
- return u''.join(map(six.text_type, out))
+ return ''.join(map(str, out))
def translate(self):
"""Compile the expression to a list of Python AST expressions, a
@@ -282,7 +264,7 @@ class Expression(object):
varnames = set()
funcnames = set()
for part in self.parts:
- if isinstance(part, six.string_types):
+ if isinstance(part, str):
expressions.append(ex_literal(part))
else:
e, v, f = part.translate()
@@ -298,7 +280,7 @@ class ParseError(Exception):
pass
-class Parser(object):
+class Parser:
"""Parses a template expression string. Instantiate the class with
the template source and call ``parse_expression``. The ``pos`` field
will indicate the character after the expression finished and
@@ -311,6 +293,7 @@ class Parser(object):
replaced with a real, accepted parsing technique (PEG, parser
generator, etc.).
"""
+
def __init__(self, string, in_argument=False):
""" Create a new parser.
:param in_arguments: boolean that indicates the parser is to be
@@ -325,8 +308,8 @@ class Parser(object):
# Common parsing resources.
special_chars = (SYMBOL_DELIM, FUNC_DELIM, GROUP_OPEN, GROUP_CLOSE,
ESCAPE_CHAR)
- special_char_re = re.compile(r'[%s]|$' %
- u''.join(re.escape(c) for c in special_chars))
+ special_char_re = re.compile(r'[%s]|\Z' %
+ ''.join(re.escape(c) for c in special_chars))
escapable_chars = (SYMBOL_DELIM, FUNC_DELIM, GROUP_CLOSE, ARG_SEP)
terminator_chars = (GROUP_CLOSE,)
@@ -343,8 +326,11 @@ class Parser(object):
if self.in_argument:
extra_special_chars = (ARG_SEP,)
special_char_re = re.compile(
- r'[%s]|$' % u''.join(re.escape(c) for c in
- self.special_chars + extra_special_chars))
+ r'[%s]|\Z' % ''.join(
+ re.escape(c) for c in
+ self.special_chars + extra_special_chars
+ )
+ )
text_parts = []
@@ -384,7 +370,7 @@ class Parser(object):
# Shift all characters collected so far into a single string.
if text_parts:
- self.parts.append(u''.join(text_parts))
+ self.parts.append(''.join(text_parts))
text_parts = []
if char == SYMBOL_DELIM:
@@ -406,7 +392,7 @@ class Parser(object):
# If any parsed characters remain, shift them into a string.
if text_parts:
- self.parts.append(u''.join(text_parts))
+ self.parts.append(''.join(text_parts))
def parse_symbol(self):
"""Parse a variable reference (like ``$foo`` or ``${foo}``)
@@ -544,11 +530,27 @@ def _parse(template):
return Expression(parts)
-# External interface.
+def cached(func):
+ """Like the `functools.lru_cache` decorator, but works (as a no-op)
+ on Python < 3.2.
+ """
+ if hasattr(functools, 'lru_cache'):
+ return functools.lru_cache(maxsize=128)(func)
+ else:
+ # Do nothing when lru_cache is not available.
+ return func
-class Template(object):
+
+@cached
+def template(fmt):
+ return Template(fmt)
+
+
+# External interface.
+class Template:
"""A string template, including text, Symbols, and Calls.
"""
+
def __init__(self, template):
self.expr = _parse(template)
self.original = template
@@ -570,7 +572,7 @@ class Template(object):
"""
try:
res = self.compiled(values, functions)
- except: # Handle any exceptions thrown by compiled version.
+ except Exception: # Handle any exceptions thrown by compiled version.
res = self.interpret(values, functions)
return res
@@ -597,7 +599,7 @@ class Template(object):
for funcname in funcnames:
args[FUNCTION_PREFIX + funcname] = functions[funcname]
parts = func(**args)
- return u''.join(parts)
+ return ''.join(parts)
return wrapper_func
@@ -606,9 +608,9 @@ class Template(object):
if __name__ == '__main__':
import timeit
- _tmpl = Template(u'foo $bar %baz{foozle $bar barzle} $bar')
+ _tmpl = Template('foo $bar %baz{foozle $bar barzle} $bar')
_vars = {'bar': 'qux'}
- _funcs = {'baz': six.text_type.upper}
+ _funcs = {'baz': str.upper}
interp_time = timeit.timeit('_tmpl.interpret(_vars, _funcs)',
'from __main__ import _tmpl, _vars, _funcs',
number=10000)
@@ -617,4 +619,4 @@ if __name__ == '__main__':
'from __main__ import _tmpl, _vars, _funcs',
number=10000)
print(comp_time)
- print(u'Speedup:', interp_time / comp_time)
+ print('Speedup:', interp_time / comp_time)
diff --git a/lib/beets/util/hidden.py b/lib/beets/util/hidden.py
old mode 100755
new mode 100644
index ed97f2bf..881de1ac
--- a/lib/beets/util/hidden.py
+++ b/lib/beets/util/hidden.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
# This file is part of beets.
# Copyright 2016, Adrian Sampson.
#
@@ -14,7 +13,6 @@
# included in all copies or substantial portions of the Software.
"""Simple library to work out if a file is hidden on different platforms."""
-from __future__ import division, absolute_import, print_function
import os
import stat
diff --git a/lib/beets/util/pipeline.py b/lib/beets/util/pipeline.py
old mode 100755
new mode 100644
index 367e5d98..d338cb51
--- a/lib/beets/util/pipeline.py
+++ b/lib/beets/util/pipeline.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
# This file is part of beets.
# Copyright 2016, Adrian Sampson.
#
@@ -32,12 +31,10 @@ To do so, pass an iterable of coroutines to the Pipeline constructor
in place of any single coroutine.
"""
-from __future__ import division, absolute_import, print_function
-from six.moves import queue
+import queue
from threading import Thread, Lock
import sys
-import six
BUBBLE = '__PIPELINE_BUBBLE__'
POISON = '__PIPELINE_POISON__'
@@ -91,6 +88,7 @@ class CountedQueue(queue.Queue):
still feeding into it. The queue is poisoned when all threads are
finished with the queue.
"""
+
def __init__(self, maxsize=0):
queue.Queue.__init__(self, maxsize)
self.nthreads = 0
@@ -135,10 +133,11 @@ class CountedQueue(queue.Queue):
_invalidate_queue(self, POISON, False)
-class MultiMessage(object):
+class MultiMessage:
"""A message yielded by a pipeline stage encapsulating multiple
values to be sent to the next stage.
"""
+
def __init__(self, messages):
self.messages = messages
@@ -210,8 +209,9 @@ def _allmsgs(obj):
class PipelineThread(Thread):
"""Abstract base class for pipeline-stage threads."""
+
def __init__(self, all_threads):
- super(PipelineThread, self).__init__()
+ super().__init__()
self.abort_lock = Lock()
self.abort_flag = False
self.all_threads = all_threads
@@ -241,15 +241,13 @@ class FirstPipelineThread(PipelineThread):
"""The thread running the first stage in a parallel pipeline setup.
The coroutine should just be a generator.
"""
+
def __init__(self, coro, out_queue, all_threads):
- super(FirstPipelineThread, self).__init__(all_threads)
+ super().__init__(all_threads)
self.coro = coro
self.out_queue = out_queue
self.out_queue.acquire()
- self.abort_lock = Lock()
- self.abort_flag = False
-
def run(self):
try:
while True:
@@ -270,7 +268,7 @@ class FirstPipelineThread(PipelineThread):
return
self.out_queue.put(msg)
- except:
+ except BaseException:
self.abort_all(sys.exc_info())
return
@@ -282,8 +280,9 @@ class MiddlePipelineThread(PipelineThread):
"""A thread running any stage in the pipeline except the first or
last.
"""
+
def __init__(self, coro, in_queue, out_queue, all_threads):
- super(MiddlePipelineThread, self).__init__(all_threads)
+ super().__init__(all_threads)
self.coro = coro
self.in_queue = in_queue
self.out_queue = out_queue
@@ -318,7 +317,7 @@ class MiddlePipelineThread(PipelineThread):
return
self.out_queue.put(msg)
- except:
+ except BaseException:
self.abort_all(sys.exc_info())
return
@@ -330,8 +329,9 @@ class LastPipelineThread(PipelineThread):
"""A thread running the last stage in a pipeline. The coroutine
should yield nothing.
"""
+
def __init__(self, coro, in_queue, all_threads):
- super(LastPipelineThread, self).__init__(all_threads)
+ super().__init__(all_threads)
self.coro = coro
self.in_queue = in_queue
@@ -357,22 +357,23 @@ class LastPipelineThread(PipelineThread):
# Send to consumer.
self.coro.send(msg)
- except:
+ except BaseException:
self.abort_all(sys.exc_info())
return
-class Pipeline(object):
+class Pipeline:
"""Represents a staged pattern of work. Each stage in the pipeline
is a coroutine that receives messages from the previous stage and
yields messages to be sent to the next stage.
"""
+
def __init__(self, stages):
"""Makes a new pipeline from a list of coroutines. There must
be at least two stages.
"""
if len(stages) < 2:
- raise ValueError(u'pipeline must have at least two stages')
+ raise ValueError('pipeline must have at least two stages')
self.stages = []
for stage in stages:
if isinstance(stage, (list, tuple)):
@@ -425,7 +426,7 @@ class Pipeline(object):
while threads[-1].is_alive():
threads[-1].join(1)
- except:
+ except BaseException:
# Stop all the threads immediately.
for thread in threads:
thread.abort()
@@ -442,7 +443,7 @@ class Pipeline(object):
exc_info = thread.exc_info
if exc_info:
# Make the exception appear as it was raised originally.
- six.reraise(exc_info[0], exc_info[1], exc_info[2])
+ raise exc_info[1].with_traceback(exc_info[2])
def pull(self):
"""Yield elements from the end of the pipeline. Runs the stages
@@ -469,6 +470,7 @@ class Pipeline(object):
for msg in msgs:
yield msg
+
# Smoke test.
if __name__ == '__main__':
import time
@@ -477,14 +479,14 @@ if __name__ == '__main__':
# in parallel.
def produce():
for i in range(5):
- print(u'generating %i' % i)
+ print('generating %i' % i)
time.sleep(1)
yield i
def work():
num = yield
while True:
- print(u'processing %i' % num)
+ print('processing %i' % num)
time.sleep(2)
num = yield num * 2
@@ -492,7 +494,7 @@ if __name__ == '__main__':
while True:
num = yield
time.sleep(1)
- print(u'received %i' % num)
+ print('received %i' % num)
ts_start = time.time()
Pipeline([produce(), work(), consume()]).run_sequential()
@@ -501,22 +503,22 @@ if __name__ == '__main__':
ts_par = time.time()
Pipeline([produce(), (work(), work()), consume()]).run_parallel()
ts_end = time.time()
- print(u'Sequential time:', ts_seq - ts_start)
- print(u'Parallel time:', ts_par - ts_seq)
- print(u'Multiply-parallel time:', ts_end - ts_par)
+ print('Sequential time:', ts_seq - ts_start)
+ print('Parallel time:', ts_par - ts_seq)
+ print('Multiply-parallel time:', ts_end - ts_par)
print()
# Test a pipeline that raises an exception.
def exc_produce():
for i in range(10):
- print(u'generating %i' % i)
+ print('generating %i' % i)
time.sleep(1)
yield i
def exc_work():
num = yield
while True:
- print(u'processing %i' % num)
+ print('processing %i' % num)
time.sleep(3)
if num == 3:
raise Exception()
@@ -525,6 +527,6 @@ if __name__ == '__main__':
def exc_consume():
while True:
num = yield
- print(u'received %i' % num)
+ print('received %i' % num)
Pipeline([exc_produce(), exc_work(), exc_consume()]).run_parallel(1)
diff --git a/lib/beets/vfs.py b/lib/beets/vfs.py
old mode 100755
new mode 100644
index 7f9a049e..aef69650
--- a/lib/beets/vfs.py
+++ b/lib/beets/vfs.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
# This file is part of beets.
# Copyright 2016, Adrian Sampson.
#
@@ -16,7 +15,6 @@
"""A simple utility for constructing filesystem-like trees from beets
libraries.
"""
-from __future__ import division, absolute_import, print_function
from collections import namedtuple
from beets import util
diff --git a/lib/beetsplug/__init__.py b/lib/beetsplug/__init__.py
index 98a7ffd5..da248491 100644
--- a/lib/beetsplug/__init__.py
+++ b/lib/beetsplug/__init__.py
@@ -1,5 +1,5 @@
# This file is part of beets.
-# Copyright 2013, Adrian Sampson.
+# Copyright 2016, Adrian Sampson.
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
@@ -14,6 +14,7 @@
"""A namespace package for beets plugins."""
+
# Make this a namespace package.
from pkgutil import extend_path
__path__ = extend_path(__path__, __name__)
diff --git a/lib/beetsplug/absubmit.py b/lib/beetsplug/absubmit.py
new file mode 100644
index 00000000..d1ea692f
--- /dev/null
+++ b/lib/beetsplug/absubmit.py
@@ -0,0 +1,196 @@
+# This file is part of beets.
+# Copyright 2016, Pieter Mulder.
+#
+# 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.
+
+"""Calculate acoustic information and submit to AcousticBrainz.
+"""
+
+
+import errno
+import hashlib
+import json
+import os
+import subprocess
+import tempfile
+
+from distutils.spawn import find_executable
+import requests
+
+from beets import plugins
+from beets import util
+from beets import ui
+
+# We use this field to check whether AcousticBrainz info is present.
+PROBE_FIELD = 'mood_acoustic'
+
+
+class ABSubmitError(Exception):
+ """Raised when failing to analyse file with extractor."""
+
+
+def call(args):
+ """Execute the command and return its output.
+
+ Raise a AnalysisABSubmitError on failure.
+ """
+ try:
+ return util.command_output(args).stdout
+ except subprocess.CalledProcessError as e:
+ raise ABSubmitError(
+ '{} exited with status {}'.format(args[0], e.returncode)
+ )
+
+
+class AcousticBrainzSubmitPlugin(plugins.BeetsPlugin):
+
+ def __init__(self):
+ super().__init__()
+
+ self.config.add({
+ 'extractor': '',
+ 'force': False,
+ 'pretend': False
+ })
+
+ self.extractor = self.config['extractor'].as_str()
+ if self.extractor:
+ self.extractor = util.normpath(self.extractor)
+ # Expicit path to extractor
+ if not os.path.isfile(self.extractor):
+ raise ui.UserError(
+ 'Extractor command does not exist: {0}.'.
+ format(self.extractor)
+ )
+ else:
+ # Implicit path to extractor, search for it in path
+ self.extractor = 'streaming_extractor_music'
+ try:
+ call([self.extractor])
+ except OSError:
+ raise ui.UserError(
+ 'No extractor command found: please install the extractor'
+ ' binary from https://acousticbrainz.org/download'
+ )
+ except ABSubmitError:
+ # Extractor found, will exit with an error if not called with
+ # the correct amount of arguments.
+ pass
+
+ # Get the executable location on the system, which we need
+ # to calculate the SHA-1 hash.
+ self.extractor = find_executable(self.extractor)
+
+ # Calculate extractor hash.
+ self.extractor_sha = hashlib.sha1()
+ with open(self.extractor, 'rb') as extractor:
+ self.extractor_sha.update(extractor.read())
+ self.extractor_sha = self.extractor_sha.hexdigest()
+
+ base_url = 'https://acousticbrainz.org/api/v1/{mbid}/low-level'
+
+ def commands(self):
+ cmd = ui.Subcommand(
+ 'absubmit',
+ help='calculate and submit AcousticBrainz analysis'
+ )
+ cmd.parser.add_option(
+ '-f', '--force', dest='force_refetch',
+ action='store_true', default=False,
+ help='re-download data when already present'
+ )
+ cmd.parser.add_option(
+ '-p', '--pretend', dest='pretend_fetch',
+ action='store_true', default=False,
+ help='pretend to perform action, but show \
+only files which would be processed'
+ )
+ cmd.func = self.command
+ return [cmd]
+
+ def command(self, lib, opts, args):
+ # Get items from arguments
+ items = lib.items(ui.decargs(args))
+ self.opts = opts
+ util.par_map(self.analyze_submit, items)
+
+ def analyze_submit(self, item):
+ analysis = self._get_analysis(item)
+ if analysis:
+ self._submit_data(item, analysis)
+
+ def _get_analysis(self, item):
+ mbid = item['mb_trackid']
+
+ # Avoid re-analyzing files that already have AB data.
+ if not self.opts.force_refetch and not self.config['force']:
+ if item.get(PROBE_FIELD):
+ return None
+
+ # If file has no MBID, skip it.
+ if not mbid:
+ self._log.info('Not analysing {}, missing '
+ 'musicbrainz track id.', item)
+ return None
+
+ if self.opts.pretend_fetch or self.config['pretend']:
+ self._log.info('pretend action - extract item: {}', item)
+ return None
+
+ # Temporary file to save extractor output to, extractor only works
+ # if an output file is given. Here we use a temporary file to copy
+ # the data into a python object and then remove the file from the
+ # system.
+ tmp_file, filename = tempfile.mkstemp(suffix='.json')
+ try:
+ # Close the file, so the extractor can overwrite it.
+ os.close(tmp_file)
+ try:
+ call([self.extractor, util.syspath(item.path), filename])
+ except ABSubmitError as e:
+ self._log.warning(
+ 'Failed to analyse {item} for AcousticBrainz: {error}',
+ item=item, error=e
+ )
+ return None
+ with open(filename) as tmp_file:
+ analysis = json.load(tmp_file)
+ # Add the hash to the output.
+ analysis['metadata']['version']['essentia_build_sha'] = \
+ self.extractor_sha
+ return analysis
+ finally:
+ try:
+ os.remove(filename)
+ except OSError as e:
+ # ENOENT means file does not exist, just ignore this error.
+ if e.errno != errno.ENOENT:
+ raise
+
+ def _submit_data(self, item, data):
+ mbid = item['mb_trackid']
+ headers = {'Content-Type': 'application/json'}
+ response = requests.post(self.base_url.format(mbid=mbid),
+ json=data, headers=headers)
+ # Test that request was successful and raise an error on failure.
+ if response.status_code != 200:
+ try:
+ message = response.json()['message']
+ except (ValueError, KeyError) as e:
+ message = f'unable to get error message: {e}'
+ self._log.error(
+ 'Failed to submit AcousticBrainz analysis of {item}: '
+ '{message}).', item=item, message=message
+ )
+ else:
+ self._log.debug('Successfully submitted AcousticBrainz analysis '
+ 'for {}.', item)
diff --git a/lib/beetsplug/acousticbrainz.py b/lib/beetsplug/acousticbrainz.py
new file mode 100644
index 00000000..eabc5849
--- /dev/null
+++ b/lib/beetsplug/acousticbrainz.py
@@ -0,0 +1,334 @@
+# This file is part of beets.
+# Copyright 2015-2016, Ohm Patel.
+#
+# 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.
+
+"""Fetch various AcousticBrainz metadata using MBID.
+"""
+
+from collections import defaultdict
+
+import requests
+
+from beets import plugins, ui
+from beets.dbcore import types
+
+ACOUSTIC_BASE = "https://acousticbrainz.org/"
+LEVELS = ["/low-level", "/high-level"]
+ABSCHEME = {
+ 'highlevel': {
+ 'danceability': {
+ 'all': {
+ 'danceable': 'danceable'
+ }
+ },
+ 'gender': {
+ 'value': 'gender'
+ },
+ 'genre_rosamerica': {
+ 'value': 'genre_rosamerica'
+ },
+ 'mood_acoustic': {
+ 'all': {
+ 'acoustic': 'mood_acoustic'
+ }
+ },
+ 'mood_aggressive': {
+ 'all': {
+ 'aggressive': 'mood_aggressive'
+ }
+ },
+ 'mood_electronic': {
+ 'all': {
+ 'electronic': 'mood_electronic'
+ }
+ },
+ 'mood_happy': {
+ 'all': {
+ 'happy': 'mood_happy'
+ }
+ },
+ 'mood_party': {
+ 'all': {
+ 'party': 'mood_party'
+ }
+ },
+ 'mood_relaxed': {
+ 'all': {
+ 'relaxed': 'mood_relaxed'
+ }
+ },
+ 'mood_sad': {
+ 'all': {
+ 'sad': 'mood_sad'
+ }
+ },
+ 'moods_mirex': {
+ 'value': 'moods_mirex'
+ },
+ 'ismir04_rhythm': {
+ 'value': 'rhythm'
+ },
+ 'tonal_atonal': {
+ 'all': {
+ 'tonal': 'tonal'
+ }
+ },
+ 'timbre': {
+ 'value': 'timbre'
+ },
+ 'voice_instrumental': {
+ 'value': 'voice_instrumental'
+ },
+ },
+ 'lowlevel': {
+ 'average_loudness': 'average_loudness'
+ },
+ 'rhythm': {
+ 'bpm': 'bpm'
+ },
+ 'tonal': {
+ 'chords_changes_rate': 'chords_changes_rate',
+ 'chords_key': 'chords_key',
+ 'chords_number_rate': 'chords_number_rate',
+ 'chords_scale': 'chords_scale',
+ 'key_key': ('initial_key', 0),
+ 'key_scale': ('initial_key', 1),
+ 'key_strength': 'key_strength'
+
+ }
+}
+
+
+class AcousticPlugin(plugins.BeetsPlugin):
+ item_types = {
+ 'average_loudness': types.Float(6),
+ 'chords_changes_rate': types.Float(6),
+ 'chords_key': types.STRING,
+ 'chords_number_rate': types.Float(6),
+ 'chords_scale': types.STRING,
+ 'danceable': types.Float(6),
+ 'gender': types.STRING,
+ 'genre_rosamerica': types.STRING,
+ 'initial_key': types.STRING,
+ 'key_strength': types.Float(6),
+ 'mood_acoustic': types.Float(6),
+ 'mood_aggressive': types.Float(6),
+ 'mood_electronic': types.Float(6),
+ 'mood_happy': types.Float(6),
+ 'mood_party': types.Float(6),
+ 'mood_relaxed': types.Float(6),
+ 'mood_sad': types.Float(6),
+ 'moods_mirex': types.STRING,
+ 'rhythm': types.Float(6),
+ 'timbre': types.STRING,
+ 'tonal': types.Float(6),
+ 'voice_instrumental': types.STRING,
+ }
+
+ def __init__(self):
+ super().__init__()
+
+ self.config.add({
+ 'auto': True,
+ 'force': False,
+ 'tags': []
+ })
+
+ if self.config['auto']:
+ self.register_listener('import_task_files',
+ self.import_task_files)
+
+ def commands(self):
+ cmd = ui.Subcommand('acousticbrainz',
+ help="fetch metadata from AcousticBrainz")
+ cmd.parser.add_option(
+ '-f', '--force', dest='force_refetch',
+ action='store_true', default=False,
+ help='re-download data when already present'
+ )
+
+ def func(lib, opts, args):
+ items = lib.items(ui.decargs(args))
+ self._fetch_info(items, ui.should_write(),
+ opts.force_refetch or self.config['force'])
+
+ cmd.func = func
+ return [cmd]
+
+ def import_task_files(self, session, task):
+ """Function is called upon beet import.
+ """
+ self._fetch_info(task.imported_items(), False, True)
+
+ def _get_data(self, mbid):
+ data = {}
+ for url in _generate_urls(mbid):
+ self._log.debug('fetching URL: {}', url)
+
+ try:
+ res = requests.get(url)
+ except requests.RequestException as exc:
+ self._log.info('request error: {}', exc)
+ return {}
+
+ if res.status_code == 404:
+ self._log.info('recording ID {} not found', mbid)
+ return {}
+
+ try:
+ data.update(res.json())
+ except ValueError:
+ self._log.debug('Invalid Response: {}', res.text)
+ return {}
+
+ return data
+
+ def _fetch_info(self, items, write, force):
+ """Fetch additional information from AcousticBrainz for the `item`s.
+ """
+ tags = self.config['tags'].as_str_seq()
+ for item in items:
+ # If we're not forcing re-downloading for all tracks, check
+ # whether the data is already present. We use one
+ # representative field name to check for previously fetched
+ # data.
+ if not force:
+ mood_str = item.get('mood_acoustic', '')
+ if mood_str:
+ self._log.info('data already present for: {}', item)
+ continue
+
+ # We can only fetch data for tracks with MBIDs.
+ if not item.mb_trackid:
+ continue
+
+ self._log.info('getting data for: {}', item)
+ data = self._get_data(item.mb_trackid)
+ if data:
+ for attr, val in self._map_data_to_scheme(data, ABSCHEME):
+ if not tags or attr in tags:
+ self._log.debug('attribute {} of {} set to {}',
+ attr,
+ item,
+ val)
+ setattr(item, attr, val)
+ else:
+ self._log.debug('skipping attribute {} of {}'
+ ' (value {}) due to config',
+ attr,
+ item,
+ val)
+ item.store()
+ if write:
+ item.try_write()
+
+ def _map_data_to_scheme(self, data, scheme):
+ """Given `data` as a structure of nested dictionaries, and `scheme` as a
+ structure of nested dictionaries , `yield` tuples `(attr, val)` where
+ `attr` and `val` are corresponding leaf nodes in `scheme` and `data`.
+
+ As its name indicates, `scheme` defines how the data is structured,
+ so this function tries to find leaf nodes in `data` that correspond
+ to the leafs nodes of `scheme`, and not the other way around.
+ Leaf nodes of `data` that do not exist in the `scheme` do not matter.
+ If a leaf node of `scheme` is not present in `data`,
+ no value is yielded for that attribute and a simple warning is issued.
+
+ Finally, to account for attributes of which the value is split between
+ several leaf nodes in `data`, leaf nodes of `scheme` can be tuples
+ `(attr, order)` where `attr` is the attribute to which the leaf node
+ belongs, and `order` is the place at which it should appear in the
+ value. The different `value`s belonging to the same `attr` are simply
+ joined with `' '`. This is hardcoded and not very flexible, but it gets
+ the job done.
+
+ For example:
+
+ >>> scheme = {
+ 'key1': 'attribute',
+ 'key group': {
+ 'subkey1': 'subattribute',
+ 'subkey2': ('composite attribute', 0)
+ },
+ 'key2': ('composite attribute', 1)
+ }
+ >>> data = {
+ 'key1': 'value',
+ 'key group': {
+ 'subkey1': 'subvalue',
+ 'subkey2': 'part 1 of composite attr'
+ },
+ 'key2': 'part 2'
+ }
+ >>> print(list(_map_data_to_scheme(data, scheme)))
+ [('subattribute', 'subvalue'),
+ ('attribute', 'value'),
+ ('composite attribute', 'part 1 of composite attr part 2')]
+ """
+ # First, we traverse `scheme` and `data`, `yield`ing all the non
+ # composites attributes straight away and populating the dictionary
+ # `composites` with the composite attributes.
+
+ # When we are finished traversing `scheme`, `composites` should
+ # map each composite attribute to an ordered list of the values
+ # belonging to the attribute, for example:
+ # `composites = {'initial_key': ['B', 'minor']}`.
+
+ # The recursive traversal.
+ composites = defaultdict(list)
+ yield from self._data_to_scheme_child(data,
+ scheme,
+ composites)
+
+ # When composites has been populated, yield the composite attributes
+ # by joining their parts.
+ for composite_attr, value_parts in composites.items():
+ yield composite_attr, ' '.join(value_parts)
+
+ def _data_to_scheme_child(self, subdata, subscheme, composites):
+ """The recursive business logic of :meth:`_map_data_to_scheme`:
+ Traverse two structures of nested dictionaries in parallel and `yield`
+ tuples of corresponding leaf nodes.
+
+ If a leaf node belongs to a composite attribute (is a `tuple`),
+ populate `composites` rather than yielding straight away.
+ All the child functions for a single traversal share the same
+ `composites` instance, which is passed along.
+ """
+ for k, v in subscheme.items():
+ if k in subdata:
+ if type(v) == dict:
+ yield from self._data_to_scheme_child(subdata[k],
+ v,
+ composites)
+ elif type(v) == tuple:
+ composite_attribute, part_number = v
+ attribute_parts = composites[composite_attribute]
+ # Parts are not guaranteed to be inserted in order
+ while len(attribute_parts) <= part_number:
+ attribute_parts.append('')
+ attribute_parts[part_number] = subdata[k]
+ else:
+ yield v, subdata[k]
+ else:
+ self._log.warning('Acousticbrainz did not provide info'
+ 'about {}', k)
+ self._log.debug('Data {} could not be mapped to scheme {} '
+ 'because key {} was not found', subdata, v, k)
+
+
+def _generate_urls(mbid):
+ """Generates AcousticBrainz end point urls for given `mbid`.
+ """
+ for level in LEVELS:
+ yield ACOUSTIC_BASE + mbid + level
diff --git a/lib/beetsplug/albumtypes.py b/lib/beetsplug/albumtypes.py
new file mode 100644
index 00000000..47f8dc64
--- /dev/null
+++ b/lib/beetsplug/albumtypes.py
@@ -0,0 +1,65 @@
+# This file is part of beets.
+# Copyright 2021, Edgars Supe.
+#
+# 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.
+
+"""Adds an album template field for formatted album types."""
+
+
+from beets.autotag.mb import VARIOUS_ARTISTS_ID
+from beets.library import Album
+from beets.plugins import BeetsPlugin
+
+
+class AlbumTypesPlugin(BeetsPlugin):
+ """Adds an album template field for formatted album types."""
+
+ def __init__(self):
+ """Init AlbumTypesPlugin."""
+ super().__init__()
+ self.album_template_fields['atypes'] = self._atypes
+ self.config.add({
+ 'types': [
+ ('ep', 'EP'),
+ ('single', 'Single'),
+ ('soundtrack', 'OST'),
+ ('live', 'Live'),
+ ('compilation', 'Anthology'),
+ ('remix', 'Remix')
+ ],
+ 'ignore_va': ['compilation'],
+ 'bracket': '[]'
+ })
+
+ def _atypes(self, item: Album):
+ """Returns a formatted string based on album's types."""
+ types = self.config['types'].as_pairs()
+ ignore_va = self.config['ignore_va'].as_str_seq()
+ bracket = self.config['bracket'].as_str()
+
+ # Assign a left and right bracket or leave blank if argument is empty.
+ if len(bracket) == 2:
+ bracket_l = bracket[0]
+ bracket_r = bracket[1]
+ else:
+ bracket_l = ''
+ bracket_r = ''
+
+ res = ''
+ albumtypes = item.albumtypes.split('; ')
+ is_va = item.mb_albumartistid == VARIOUS_ARTISTS_ID
+ for type in types:
+ if type[0] in albumtypes and type[1]:
+ if not is_va or (type[0] not in ignore_va and is_va):
+ res += f'{bracket_l}{type[1]}{bracket_r}'
+
+ return res
diff --git a/lib/beetsplug/aura.py b/lib/beetsplug/aura.py
new file mode 100644
index 00000000..f4ae5527
--- /dev/null
+++ b/lib/beetsplug/aura.py
@@ -0,0 +1,984 @@
+# This file is part of beets.
+# Copyright 2020, Callum Brown.
+#
+# 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.
+
+"""An AURA server using Flask."""
+
+
+from mimetypes import guess_type
+import re
+import os.path
+from os.path import isfile, getsize
+
+from beets.plugins import BeetsPlugin
+from beets.ui import Subcommand, _open_library
+from beets import config
+from beets.util import py3_path
+from beets.library import Item, Album
+from beets.dbcore.query import (
+ MatchQuery,
+ NotQuery,
+ RegexpQuery,
+ AndQuery,
+ FixedFieldSort,
+ SlowFieldSort,
+ MultipleSort,
+)
+
+from flask import (
+ Blueprint,
+ Flask,
+ current_app,
+ send_file,
+ make_response,
+ request,
+)
+
+
+# Constants
+
+# AURA server information
+# TODO: Add version information
+SERVER_INFO = {
+ "aura-version": "0",
+ "server": "beets-aura",
+ "server-version": "0.1",
+ "auth-required": False,
+ "features": ["albums", "artists", "images"],
+}
+
+# Maps AURA Track attribute to beets Item attribute
+TRACK_ATTR_MAP = {
+ # Required
+ "title": "title",
+ "artist": "artist",
+ # Optional
+ "album": "album",
+ "track": "track", # Track number on album
+ "tracktotal": "tracktotal",
+ "disc": "disc",
+ "disctotal": "disctotal",
+ "year": "year",
+ "month": "month",
+ "day": "day",
+ "bpm": "bpm",
+ "genre": "genre",
+ "recording-mbid": "mb_trackid", # beets trackid is MB recording
+ "track-mbid": "mb_releasetrackid",
+ "composer": "composer",
+ "albumartist": "albumartist",
+ "comments": "comments",
+ # Optional for Audio Metadata
+ # TODO: Support the mimetype attribute, format != mime type
+ # "mimetype": track.format,
+ "duration": "length",
+ "framerate": "samplerate",
+ # I don't think beets has a framecount field
+ # "framecount": ???,
+ "channels": "channels",
+ "bitrate": "bitrate",
+ "bitdepth": "bitdepth",
+ "size": "filesize",
+}
+
+# Maps AURA Album attribute to beets Album attribute
+ALBUM_ATTR_MAP = {
+ # Required
+ "title": "album",
+ "artist": "albumartist",
+ # Optional
+ "tracktotal": "albumtotal",
+ "disctotal": "disctotal",
+ "year": "year",
+ "month": "month",
+ "day": "day",
+ "genre": "genre",
+ "release-mbid": "mb_albumid",
+ "release-group-mbid": "mb_releasegroupid",
+}
+
+# Maps AURA Artist attribute to beets Item field
+# Artists are not first-class in beets, so information is extracted from
+# beets Items.
+ARTIST_ATTR_MAP = {
+ # Required
+ "name": "artist",
+ # Optional
+ "artist-mbid": "mb_artistid",
+}
+
+
+class AURADocument:
+ """Base class for building AURA documents."""
+
+ @staticmethod
+ def error(status, title, detail):
+ """Make a response for an error following the JSON:API spec.
+
+ Args:
+ status: An HTTP status code string, e.g. "404 Not Found".
+ title: A short, human-readable summary of the problem.
+ detail: A human-readable explanation specific to this
+ occurrence of the problem.
+ """
+ document = {
+ "errors": [{"status": status, "title": title, "detail": detail}]
+ }
+ return make_response(document, status)
+
+ def translate_filters(self):
+ """Translate filters from request arguments to a beets Query."""
+ # The format of each filter key in the request parameter is:
+ # filter[]. This regex extracts .
+ pattern = re.compile(r"filter\[(?P[a-zA-Z0-9_-]+)\]")
+ queries = []
+ for key, value in request.args.items():
+ match = pattern.match(key)
+ if match:
+ # Extract attribute name from key
+ aura_attr = match.group("attribute")
+ # Get the beets version of the attribute name
+ beets_attr = self.attribute_map.get(aura_attr, aura_attr)
+ converter = self.get_attribute_converter(beets_attr)
+ value = converter(value)
+ # Add exact match query to list
+ # Use a slow query so it works with all fields
+ queries.append(MatchQuery(beets_attr, value, fast=False))
+ # NOTE: AURA doesn't officially support multiple queries
+ return AndQuery(queries)
+
+ def translate_sorts(self, sort_arg):
+ """Translate an AURA sort parameter into a beets Sort.
+
+ Args:
+ sort_arg: The value of the 'sort' query parameter; a comma
+ separated list of fields to sort by, in order.
+ E.g. "-year,title".
+ """
+ # Change HTTP query parameter to a list
+ aura_sorts = sort_arg.strip(",").split(",")
+ sorts = []
+ for aura_attr in aura_sorts:
+ if aura_attr[0] == "-":
+ ascending = False
+ # Remove leading "-"
+ aura_attr = aura_attr[1:]
+ else:
+ # JSON:API default
+ ascending = True
+ # Get the beets version of the attribute name
+ beets_attr = self.attribute_map.get(aura_attr, aura_attr)
+ # Use slow sort so it works with all fields (inc. computed)
+ sorts.append(SlowFieldSort(beets_attr, ascending=ascending))
+ return MultipleSort(sorts)
+
+ def paginate(self, collection):
+ """Get a page of the collection and the URL to the next page.
+
+ Args:
+ collection: The raw data from which resource objects can be
+ built. Could be an sqlite3.Cursor object (tracks and
+ albums) or a list of strings (artists).
+ """
+ # Pages start from zero
+ page = request.args.get("page", 0, int)
+ # Use page limit defined in config by default.
+ default_limit = config["aura"]["page_limit"].get(int)
+ limit = request.args.get("limit", default_limit, int)
+ # start = offset of first item to return
+ start = page * limit
+ # end = offset of last item + 1
+ end = start + limit
+ if end > len(collection):
+ end = len(collection)
+ next_url = None
+ else:
+ # Not the last page so work out links.next url
+ if not request.args:
+ # No existing arguments, so current page is 0
+ next_url = request.url + "?page=1"
+ elif not request.args.get("page", None):
+ # No existing page argument, so add one to the end
+ next_url = request.url + "&page=1"
+ else:
+ # Increment page token by 1
+ next_url = request.url.replace(
+ f"page={page}", "page={}".format(page + 1)
+ )
+ # Get only the items in the page range
+ data = [self.resource_object(collection[i]) for i in range(start, end)]
+ return data, next_url
+
+ def get_included(self, data, include_str):
+ """Build a list of resource objects for inclusion.
+
+ Args:
+ data: An array of dicts in the form of resource objects.
+ include_str: A comma separated list of resource types to
+ include. E.g. "tracks,images".
+ """
+ # Change HTTP query parameter to a list
+ to_include = include_str.strip(",").split(",")
+ # Build a list of unique type and id combinations
+ # For each resource object in the primary data, iterate over it's
+ # relationships. If a relationship matches one of the types
+ # requested for inclusion (e.g. "albums") then add each type-id pair
+ # under the "data" key to unique_identifiers, checking first that
+ # it has not already been added. This ensures that no resources are
+ # included more than once.
+ unique_identifiers = []
+ for res_obj in data:
+ for rel_name, rel_obj in res_obj["relationships"].items():
+ if rel_name in to_include:
+ # NOTE: Assumes relationship is to-many
+ for identifier in rel_obj["data"]:
+ if identifier not in unique_identifiers:
+ unique_identifiers.append(identifier)
+ # TODO: I think this could be improved
+ included = []
+ for identifier in unique_identifiers:
+ res_type = identifier["type"]
+ if res_type == "track":
+ track_id = int(identifier["id"])
+ track = current_app.config["lib"].get_item(track_id)
+ included.append(TrackDocument.resource_object(track))
+ elif res_type == "album":
+ album_id = int(identifier["id"])
+ album = current_app.config["lib"].get_album(album_id)
+ included.append(AlbumDocument.resource_object(album))
+ elif res_type == "artist":
+ artist_id = identifier["id"]
+ included.append(ArtistDocument.resource_object(artist_id))
+ elif res_type == "image":
+ image_id = identifier["id"]
+ included.append(ImageDocument.resource_object(image_id))
+ else:
+ raise ValueError(f"Invalid resource type: {res_type}")
+ return included
+
+ def all_resources(self):
+ """Build document for /tracks, /albums or /artists."""
+ query = self.translate_filters()
+ sort_arg = request.args.get("sort", None)
+ if sort_arg:
+ sort = self.translate_sorts(sort_arg)
+ # For each sort field add a query which ensures all results
+ # have a non-empty, non-zero value for that field.
+ for s in sort.sorts:
+ query.subqueries.append(
+ NotQuery(
+ # Match empty fields (^$) or zero fields, (^0$)
+ RegexpQuery(s.field, "(^$|^0$)", fast=False)
+ )
+ )
+ else:
+ sort = None
+ # Get information from the library
+ collection = self.get_collection(query=query, sort=sort)
+ # Convert info to AURA form and paginate it
+ data, next_url = self.paginate(collection)
+ document = {"data": data}
+ # If there are more pages then provide a way to access them
+ if next_url:
+ document["links"] = {"next": next_url}
+ # Include related resources for each element in "data"
+ include_str = request.args.get("include", None)
+ if include_str:
+ document["included"] = self.get_included(data, include_str)
+ return document
+
+ def single_resource_document(self, resource_object):
+ """Build document for a specific requested resource.
+
+ Args:
+ resource_object: A dictionary in the form of a JSON:API
+ resource object.
+ """
+ document = {"data": resource_object}
+ include_str = request.args.get("include", None)
+ if include_str:
+ # [document["data"]] is because arg needs to be list
+ document["included"] = self.get_included(
+ [document["data"]], include_str
+ )
+ return document
+
+
+class TrackDocument(AURADocument):
+ """Class for building documents for /tracks endpoints."""
+
+ attribute_map = TRACK_ATTR_MAP
+
+ def get_collection(self, query=None, sort=None):
+ """Get Item objects from the library.
+
+ Args:
+ query: A beets Query object or a beets query string.
+ sort: A beets Sort object.
+ """
+ return current_app.config["lib"].items(query, sort)
+
+ def get_attribute_converter(self, beets_attr):
+ """Work out what data type an attribute should be for beets.
+
+ Args:
+ beets_attr: The name of the beets attribute, e.g. "title".
+ """
+ # filesize is a special field (read from disk not db?)
+ if beets_attr == "filesize":
+ converter = int
+ else:
+ try:
+ # Look for field in list of Item fields
+ # and get python type of database type.
+ # See beets.library.Item and beets.dbcore.types
+ converter = Item._fields[beets_attr].model_type
+ except KeyError:
+ # Fall back to string (NOTE: probably not good)
+ converter = str
+ return converter
+
+ @staticmethod
+ def resource_object(track):
+ """Construct a JSON:API resource object from a beets Item.
+
+ Args:
+ track: A beets Item object.
+ """
+ attributes = {}
+ # Use aura => beets attribute map, e.g. size => filesize
+ for aura_attr, beets_attr in TRACK_ATTR_MAP.items():
+ a = getattr(track, beets_attr)
+ # Only set attribute if it's not None, 0, "", etc.
+ # NOTE: This could result in required attributes not being set
+ if a:
+ attributes[aura_attr] = a
+
+ # JSON:API one-to-many relationship to parent album
+ relationships = {
+ "artists": {"data": [{"type": "artist", "id": track.artist}]}
+ }
+ # Only add album relationship if not singleton
+ if not track.singleton:
+ relationships["albums"] = {
+ "data": [{"type": "album", "id": str(track.album_id)}]
+ }
+
+ return {
+ "type": "track",
+ "id": str(track.id),
+ "attributes": attributes,
+ "relationships": relationships,
+ }
+
+ def single_resource(self, track_id):
+ """Get track from the library and build a document.
+
+ Args:
+ track_id: The beets id of the track (integer).
+ """
+ track = current_app.config["lib"].get_item(track_id)
+ if not track:
+ return self.error(
+ "404 Not Found",
+ "No track with the requested id.",
+ "There is no track with an id of {} in the library.".format(
+ track_id
+ ),
+ )
+ return self.single_resource_document(self.resource_object(track))
+
+
+class AlbumDocument(AURADocument):
+ """Class for building documents for /albums endpoints."""
+
+ attribute_map = ALBUM_ATTR_MAP
+
+ def get_collection(self, query=None, sort=None):
+ """Get Album objects from the library.
+
+ Args:
+ query: A beets Query object or a beets query string.
+ sort: A beets Sort object.
+ """
+ return current_app.config["lib"].albums(query, sort)
+
+ def get_attribute_converter(self, beets_attr):
+ """Work out what data type an attribute should be for beets.
+
+ Args:
+ beets_attr: The name of the beets attribute, e.g. "title".
+ """
+ try:
+ # Look for field in list of Album fields
+ # and get python type of database type.
+ # See beets.library.Album and beets.dbcore.types
+ converter = Album._fields[beets_attr].model_type
+ except KeyError:
+ # Fall back to string (NOTE: probably not good)
+ converter = str
+ return converter
+
+ @staticmethod
+ def resource_object(album):
+ """Construct a JSON:API resource object from a beets Album.
+
+ Args:
+ album: A beets Album object.
+ """
+ attributes = {}
+ # Use aura => beets attribute name map
+ for aura_attr, beets_attr in ALBUM_ATTR_MAP.items():
+ a = getattr(album, beets_attr)
+ # Only set attribute if it's not None, 0, "", etc.
+ # NOTE: This could mean required attributes are not set
+ if a:
+ attributes[aura_attr] = a
+
+ # Get beets Item objects for all tracks in the album sorted by
+ # track number. Sorting is not required but it's nice.
+ query = MatchQuery("album_id", album.id)
+ sort = FixedFieldSort("track", ascending=True)
+ tracks = current_app.config["lib"].items(query, sort)
+ # JSON:API one-to-many relationship to tracks on the album
+ relationships = {
+ "tracks": {
+ "data": [{"type": "track", "id": str(t.id)} for t in tracks]
+ }
+ }
+ # Add images relationship if album has associated images
+ if album.artpath:
+ path = py3_path(album.artpath)
+ filename = path.split("/")[-1]
+ image_id = f"album-{album.id}-{filename}"
+ relationships["images"] = {
+ "data": [{"type": "image", "id": image_id}]
+ }
+ # Add artist relationship if artist name is same on tracks
+ # Tracks are used to define artists so don't albumartist
+ # Check for all tracks in case some have featured artists
+ if album.albumartist in [t.artist for t in tracks]:
+ relationships["artists"] = {
+ "data": [{"type": "artist", "id": album.albumartist}]
+ }
+
+ return {
+ "type": "album",
+ "id": str(album.id),
+ "attributes": attributes,
+ "relationships": relationships,
+ }
+
+ def single_resource(self, album_id):
+ """Get album from the library and build a document.
+
+ Args:
+ album_id: The beets id of the album (integer).
+ """
+ album = current_app.config["lib"].get_album(album_id)
+ if not album:
+ return self.error(
+ "404 Not Found",
+ "No album with the requested id.",
+ "There is no album with an id of {} in the library.".format(
+ album_id
+ ),
+ )
+ return self.single_resource_document(self.resource_object(album))
+
+
+class ArtistDocument(AURADocument):
+ """Class for building documents for /artists endpoints."""
+
+ attribute_map = ARTIST_ATTR_MAP
+
+ def get_collection(self, query=None, sort=None):
+ """Get a list of artist names from the library.
+
+ Args:
+ query: A beets Query object or a beets query string.
+ sort: A beets Sort object.
+ """
+ # Gets only tracks with matching artist information
+ tracks = current_app.config["lib"].items(query, sort)
+ collection = []
+ for track in tracks:
+ # Do not add duplicates
+ if track.artist not in collection:
+ collection.append(track.artist)
+ return collection
+
+ def get_attribute_converter(self, beets_attr):
+ """Work out what data type an attribute should be for beets.
+
+ Args:
+ beets_attr: The name of the beets attribute, e.g. "artist".
+ """
+ try:
+ # Look for field in list of Item fields
+ # and get python type of database type.
+ # See beets.library.Item and beets.dbcore.types
+ converter = Item._fields[beets_attr].model_type
+ except KeyError:
+ # Fall back to string (NOTE: probably not good)
+ converter = str
+ return converter
+
+ @staticmethod
+ def resource_object(artist_id):
+ """Construct a JSON:API resource object for the given artist.
+
+ Args:
+ artist_id: A string which is the artist's name.
+ """
+ # Get tracks where artist field exactly matches artist_id
+ query = MatchQuery("artist", artist_id)
+ tracks = current_app.config["lib"].items(query)
+ if not tracks:
+ return None
+
+ # Get artist information from the first track
+ # NOTE: It could be that the first track doesn't have a
+ # MusicBrainz id but later tracks do, which isn't ideal.
+ attributes = {}
+ # Use aura => beets attribute map, e.g. artist => name
+ for aura_attr, beets_attr in ARTIST_ATTR_MAP.items():
+ a = getattr(tracks[0], beets_attr)
+ # Only set attribute if it's not None, 0, "", etc.
+ # NOTE: This could mean required attributes are not set
+ if a:
+ attributes[aura_attr] = a
+
+ relationships = {
+ "tracks": {
+ "data": [{"type": "track", "id": str(t.id)} for t in tracks]
+ }
+ }
+ album_query = MatchQuery("albumartist", artist_id)
+ albums = current_app.config["lib"].albums(query=album_query)
+ if len(albums) != 0:
+ relationships["albums"] = {
+ "data": [{"type": "album", "id": str(a.id)} for a in albums]
+ }
+
+ return {
+ "type": "artist",
+ "id": artist_id,
+ "attributes": attributes,
+ "relationships": relationships,
+ }
+
+ def single_resource(self, artist_id):
+ """Get info for the requested artist and build a document.
+
+ Args:
+ artist_id: A string which is the artist's name.
+ """
+ artist_resource = self.resource_object(artist_id)
+ if not artist_resource:
+ return self.error(
+ "404 Not Found",
+ "No artist with the requested id.",
+ "There is no artist with an id of {} in the library.".format(
+ artist_id
+ ),
+ )
+ return self.single_resource_document(artist_resource)
+
+
+def safe_filename(fn):
+ """Check whether a string is a simple (non-path) filename.
+
+ For example, `foo.txt` is safe because it is a "plain" filename. But
+ `foo/bar.txt` and `../foo.txt` and `.` are all non-safe because they
+ can traverse to other directories other than the current one.
+ """
+ # Rule out any directories.
+ if os.path.basename(fn) != fn:
+ return False
+
+ # In single names, rule out Unix directory traversal names.
+ if fn in ('.', '..'):
+ return False
+
+ return True
+
+
+class ImageDocument(AURADocument):
+ """Class for building documents for /images/(id) endpoints."""
+
+ @staticmethod
+ def get_image_path(image_id):
+ """Works out the full path to the image with the given id.
+
+ Returns None if there is no such image.
+
+ Args:
+ image_id: A string in the form
+ "--".
+ """
+ # Split image_id into its constituent parts
+ id_split = image_id.split("-")
+ if len(id_split) < 3:
+ # image_id is not in the required format
+ return None
+ parent_type = id_split[0]
+ parent_id = id_split[1]
+ img_filename = "-".join(id_split[2:])
+ if not safe_filename(img_filename):
+ return None
+
+ # Get the path to the directory parent's images are in
+ if parent_type == "album":
+ album = current_app.config["lib"].get_album(int(parent_id))
+ if not album or not album.artpath:
+ return None
+ # Cut the filename off of artpath
+ # This is in preparation for supporting images in the same
+ # directory that are not tracked by beets.
+ artpath = py3_path(album.artpath)
+ dir_path = "/".join(artpath.split("/")[:-1])
+ else:
+ # Images for other resource types are not supported
+ return None
+
+ img_path = os.path.join(dir_path, img_filename)
+ # Check the image actually exists
+ if isfile(img_path):
+ return img_path
+ else:
+ return None
+
+ @staticmethod
+ def resource_object(image_id):
+ """Construct a JSON:API resource object for the given image.
+
+ Args:
+ image_id: A string in the form
+ "--".
+ """
+ # Could be called as a static method, so can't use
+ # self.get_image_path()
+ image_path = ImageDocument.get_image_path(image_id)
+ if not image_path:
+ return None
+
+ attributes = {
+ "role": "cover",
+ "mimetype": guess_type(image_path)[0],
+ "size": getsize(image_path),
+ }
+ try:
+ from PIL import Image
+ except ImportError:
+ pass
+ else:
+ im = Image.open(image_path)
+ attributes["width"] = im.width
+ attributes["height"] = im.height
+
+ relationships = {}
+ # Split id into [parent_type, parent_id, filename]
+ id_split = image_id.split("-")
+ relationships[id_split[0] + "s"] = {
+ "data": [{"type": id_split[0], "id": id_split[1]}]
+ }
+
+ return {
+ "id": image_id,
+ "type": "image",
+ # Remove attributes that are None, 0, "", etc.
+ "attributes": {k: v for k, v in attributes.items() if v},
+ "relationships": relationships,
+ }
+
+ def single_resource(self, image_id):
+ """Get info for the requested image and build a document.
+
+ Args:
+ image_id: A string in the form
+ "--".
+ """
+ image_resource = self.resource_object(image_id)
+ if not image_resource:
+ return self.error(
+ "404 Not Found",
+ "No image with the requested id.",
+ "There is no image with an id of {} in the library.".format(
+ image_id
+ ),
+ )
+ return self.single_resource_document(image_resource)
+
+
+# Initialise flask blueprint
+aura_bp = Blueprint("aura_bp", __name__)
+
+
+@aura_bp.route("/server")
+def server_info():
+ """Respond with info about the server."""
+ return {"data": {"type": "server", "id": "0", "attributes": SERVER_INFO}}
+
+
+# Track endpoints
+
+
+@aura_bp.route("/tracks")
+def all_tracks():
+ """Respond with a list of all tracks and related information."""
+ doc = TrackDocument()
+ return doc.all_resources()
+
+
+@aura_bp.route("/tracks/")
+def single_track(track_id):
+ """Respond with info about the specified track.
+
+ Args:
+ track_id: The id of the track provided in the URL (integer).
+ """
+ doc = TrackDocument()
+ return doc.single_resource(track_id)
+
+
+@aura_bp.route("/tracks//audio")
+def audio_file(track_id):
+ """Supply an audio file for the specified track.
+
+ Args:
+ track_id: The id of the track provided in the URL (integer).
+ """
+ track = current_app.config["lib"].get_item(track_id)
+ if not track:
+ return AURADocument.error(
+ "404 Not Found",
+ "No track with the requested id.",
+ "There is no track with an id of {} in the library.".format(
+ track_id
+ ),
+ )
+
+ path = py3_path(track.path)
+ if not isfile(path):
+ return AURADocument.error(
+ "404 Not Found",
+ "No audio file for the requested track.",
+ (
+ "There is no audio file for track {} at the expected location"
+ ).format(track_id),
+ )
+
+ file_mimetype = guess_type(path)[0]
+ if not file_mimetype:
+ return AURADocument.error(
+ "500 Internal Server Error",
+ "Requested audio file has an unknown mimetype.",
+ (
+ "The audio file for track {} has an unknown mimetype. "
+ "Its file extension is {}."
+ ).format(track_id, path.split(".")[-1]),
+ )
+
+ # Check that the Accept header contains the file's mimetype
+ # Takes into account */* and audio/*
+ # Adding support for the bitrate parameter would require some effort so I
+ # left it out. This means the client could be sent an error even if the
+ # audio doesn't need transcoding.
+ if not request.accept_mimetypes.best_match([file_mimetype]):
+ return AURADocument.error(
+ "406 Not Acceptable",
+ "Unsupported MIME type or bitrate parameter in Accept header.",
+ (
+ "The audio file for track {} is only available as {} and "
+ "bitrate parameters are not supported."
+ ).format(track_id, file_mimetype),
+ )
+
+ return send_file(
+ path,
+ mimetype=file_mimetype,
+ # Handles filename in Content-Disposition header
+ as_attachment=True,
+ # Tries to upgrade the stream to support range requests
+ conditional=True,
+ )
+
+
+# Album endpoints
+
+
+@aura_bp.route("/albums")
+def all_albums():
+ """Respond with a list of all albums and related information."""
+ doc = AlbumDocument()
+ return doc.all_resources()
+
+
+@aura_bp.route("/albums/")
+def single_album(album_id):
+ """Respond with info about the specified album.
+
+ Args:
+ album_id: The id of the album provided in the URL (integer).
+ """
+ doc = AlbumDocument()
+ return doc.single_resource(album_id)
+
+
+# Artist endpoints
+# Artist ids are their names
+
+
+@aura_bp.route("/artists")
+def all_artists():
+ """Respond with a list of all artists and related information."""
+ doc = ArtistDocument()
+ return doc.all_resources()
+
+
+# Using the path converter allows slashes in artist_id
+@aura_bp.route("/artists/")
+def single_artist(artist_id):
+ """Respond with info about the specified artist.
+
+ Args:
+ artist_id: The id of the artist provided in the URL. A string
+ which is the artist's name.
+ """
+ doc = ArtistDocument()
+ return doc.single_resource(artist_id)
+
+
+# Image endpoints
+# Image ids are in the form --
+# For example: album-13-cover.jpg
+
+
+@aura_bp.route("/images/")
+def single_image(image_id):
+ """Respond with info about the specified image.
+
+ Args:
+ image_id: The id of the image provided in the URL. A string in
+ the form "--".
+ """
+ doc = ImageDocument()
+ return doc.single_resource(image_id)
+
+
+@aura_bp.route("/images//file")
+def image_file(image_id):
+ """Supply an image file for the specified image.
+
+ Args:
+ image_id: The id of the image provided in the URL. A string in
+ the form "--".
+ """
+ img_path = ImageDocument.get_image_path(image_id)
+ if not img_path:
+ return AURADocument.error(
+ "404 Not Found",
+ "No image with the requested id.",
+ "There is no image with an id of {} in the library".format(
+ image_id
+ ),
+ )
+ return send_file(img_path)
+
+
+# WSGI app
+
+
+def create_app():
+ """An application factory for use by a WSGI server."""
+ config["aura"].add(
+ {
+ "host": "127.0.0.1",
+ "port": 8337,
+ "cors": [],
+ "cors_supports_credentials": False,
+ "page_limit": 500,
+ }
+ )
+
+ app = Flask(__name__)
+ # Register AURA blueprint view functions under a URL prefix
+ app.register_blueprint(aura_bp, url_prefix="/aura")
+ # AURA specifies mimetype MUST be this
+ app.config["JSONIFY_MIMETYPE"] = "application/vnd.api+json"
+ # Disable auto-sorting of JSON keys
+ app.config["JSON_SORT_KEYS"] = False
+ # Provide a way to access the beets library
+ # The normal method of using the Library and config provided in the
+ # command function is not used because create_app() could be called
+ # by an external WSGI server.
+ # NOTE: this uses a 'private' function from beets.ui.__init__
+ app.config["lib"] = _open_library(config)
+
+ # Enable CORS if required
+ cors = config["aura"]["cors"].as_str_seq(list)
+ if cors:
+ from flask_cors import CORS
+
+ # "Accept" is the only header clients use
+ app.config["CORS_ALLOW_HEADERS"] = "Accept"
+ app.config["CORS_RESOURCES"] = {r"/aura/*": {"origins": cors}}
+ app.config["CORS_SUPPORTS_CREDENTIALS"] = config["aura"][
+ "cors_supports_credentials"
+ ].get(bool)
+ CORS(app)
+
+ return app
+
+
+# Beets Plugin Hook
+
+
+class AURAPlugin(BeetsPlugin):
+ """The BeetsPlugin subclass for the AURA server plugin."""
+
+ def __init__(self):
+ """Add configuration options for the AURA plugin."""
+ super().__init__()
+
+ def commands(self):
+ """Add subcommand used to run the AURA server."""
+
+ def run_aura(lib, opts, args):
+ """Run the application using Flask's built in-server.
+
+ Args:
+ lib: A beets Library object (not used).
+ opts: Command line options. An optparse.Values object.
+ args: The list of arguments to process (not used).
+ """
+ app = create_app()
+ # Start the built-in server (not intended for production)
+ app.run(
+ host=self.config["host"].get(str),
+ port=self.config["port"].get(int),
+ debug=opts.debug,
+ threaded=True,
+ )
+
+ run_aura_cmd = Subcommand("aura", help="run an AURA server")
+ run_aura_cmd.parser.add_option(
+ "-d",
+ "--debug",
+ action="store_true",
+ default=False,
+ help="use Flask debug mode",
+ )
+ run_aura_cmd.func = run_aura
+ return [run_aura_cmd]
diff --git a/lib/beetsplug/badfiles.py b/lib/beetsplug/badfiles.py
new file mode 100644
index 00000000..ec465895
--- /dev/null
+++ b/lib/beetsplug/badfiles.py
@@ -0,0 +1,215 @@
+# This file is part of beets.
+# Copyright 2016, François-Xavier Thomas.
+#
+# 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.
+
+"""Use command-line tools to check for audio file corruption.
+"""
+
+
+from subprocess import check_output, CalledProcessError, list2cmdline, STDOUT
+
+import shlex
+import os
+import errno
+import sys
+import confuse
+from beets.plugins import BeetsPlugin
+from beets.ui import Subcommand
+from beets.util import displayable_path, par_map
+from beets import ui
+from beets import importer
+
+
+class CheckerCommandException(Exception):
+ """Raised when running a checker failed.
+
+ Attributes:
+ checker: Checker command name.
+ path: Path to the file being validated.
+ errno: Error number from the checker execution error.
+ msg: Message from the checker execution error.
+ """
+
+ def __init__(self, cmd, oserror):
+ self.checker = cmd[0]
+ self.path = cmd[-1]
+ self.errno = oserror.errno
+ self.msg = str(oserror)
+
+
+class BadFiles(BeetsPlugin):
+ def __init__(self):
+ super().__init__()
+ self.verbose = False
+
+ self.register_listener('import_task_start',
+ self.on_import_task_start)
+ self.register_listener('import_task_before_choice',
+ self.on_import_task_before_choice)
+
+ def run_command(self, cmd):
+ self._log.debug("running command: {}",
+ displayable_path(list2cmdline(cmd)))
+ try:
+ output = check_output(cmd, stderr=STDOUT)
+ errors = 0
+ status = 0
+ except CalledProcessError as e:
+ output = e.output
+ errors = 1
+ status = e.returncode
+ except OSError as e:
+ raise CheckerCommandException(cmd, e)
+ output = output.decode(sys.getdefaultencoding(), 'replace')
+ return status, errors, [line for line in output.split("\n") if line]
+
+ def check_mp3val(self, path):
+ status, errors, output = self.run_command(["mp3val", path])
+ if status == 0:
+ output = [line for line in output if line.startswith("WARNING:")]
+ errors = len(output)
+ return status, errors, output
+
+ def check_flac(self, path):
+ return self.run_command(["flac", "-wst", path])
+
+ def check_custom(self, command):
+ def checker(path):
+ cmd = shlex.split(command)
+ cmd.append(path)
+ return self.run_command(cmd)
+ return checker
+
+ def get_checker(self, ext):
+ ext = ext.lower()
+ try:
+ command = self.config['commands'].get(dict).get(ext)
+ except confuse.NotFoundError:
+ command = None
+ if command:
+ return self.check_custom(command)
+ if ext == "mp3":
+ return self.check_mp3val
+ if ext == "flac":
+ return self.check_flac
+
+ def check_item(self, item):
+ # First, check whether the path exists. If not, the user
+ # should probably run `beet update` to cleanup your library.
+ dpath = displayable_path(item.path)
+ self._log.debug("checking path: {}", dpath)
+ if not os.path.exists(item.path):
+ ui.print_("{}: file does not exist".format(
+ ui.colorize('text_error', dpath)))
+
+ # Run the checker against the file if one is found
+ ext = os.path.splitext(item.path)[1][1:].decode('utf8', 'ignore')
+ checker = self.get_checker(ext)
+ if not checker:
+ self._log.error("no checker specified in the config for {}",
+ ext)
+ return []
+ path = item.path
+ if not isinstance(path, str):
+ path = item.path.decode(sys.getfilesystemencoding())
+ try:
+ status, errors, output = checker(path)
+ except CheckerCommandException as e:
+ if e.errno == errno.ENOENT:
+ self._log.error(
+ "command not found: {} when validating file: {}",
+ e.checker,
+ e.path
+ )
+ else:
+ self._log.error("error invoking {}: {}", e.checker, e.msg)
+ return []
+
+ error_lines = []
+
+ if status > 0:
+ error_lines.append(
+ "{}: checker exited with status {}"
+ .format(ui.colorize('text_error', dpath), status))
+ for line in output:
+ error_lines.append(f" {line}")
+
+ elif errors > 0:
+ error_lines.append(
+ "{}: checker found {} errors or warnings"
+ .format(ui.colorize('text_warning', dpath), errors))
+ for line in output:
+ error_lines.append(f" {line}")
+ elif self.verbose:
+ error_lines.append(
+ "{}: ok".format(ui.colorize('text_success', dpath)))
+
+ return error_lines
+
+ def on_import_task_start(self, task, session):
+ if not self.config['check_on_import'].get(False):
+ return
+
+ checks_failed = []
+
+ for item in task.items:
+ error_lines = self.check_item(item)
+ if error_lines:
+ checks_failed.append(error_lines)
+
+ if checks_failed:
+ task._badfiles_checks_failed = checks_failed
+
+ def on_import_task_before_choice(self, task, session):
+ if hasattr(task, '_badfiles_checks_failed'):
+ ui.print_('{} one or more files failed checks:'
+ .format(ui.colorize('text_warning', 'BAD')))
+ for error in task._badfiles_checks_failed:
+ for error_line in error:
+ ui.print_(error_line)
+
+ ui.print_()
+ ui.print_('What would you like to do?')
+
+ sel = ui.input_options(['aBort', 'skip', 'continue'])
+
+ if sel == 's':
+ return importer.action.SKIP
+ elif sel == 'c':
+ return None
+ elif sel == 'b':
+ raise importer.ImportAbort()
+ else:
+ raise Exception(f'Unexpected selection: {sel}')
+
+ def command(self, lib, opts, args):
+ # Get items from arguments
+ items = lib.items(ui.decargs(args))
+ self.verbose = opts.verbose
+
+ def check_and_print(item):
+ for error_line in self.check_item(item):
+ ui.print_(error_line)
+
+ par_map(check_and_print, items)
+
+ def commands(self):
+ bad_command = Subcommand('bad',
+ help='check for corrupt or missing files')
+ bad_command.parser.add_option(
+ '-v', '--verbose',
+ action='store_true', default=False, dest='verbose',
+ help='view results for both the bad and uncorrupted files'
+ )
+ bad_command.func = self.command
+ return [bad_command]
diff --git a/lib/beetsplug/bareasc.py b/lib/beetsplug/bareasc.py
new file mode 100644
index 00000000..21836936
--- /dev/null
+++ b/lib/beetsplug/bareasc.py
@@ -0,0 +1,82 @@
+# This file is part of beets.
+# Copyright 2016, Philippe Mongeau.
+# Copyright 2021, Graham R. Cobb.
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and ascociated 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.
+#
+# This module is adapted from Fuzzy in accordance to the licence of
+# that module
+
+"""Provides a bare-ASCII matching query."""
+
+
+from beets import ui
+from beets.ui import print_, decargs
+from beets.plugins import BeetsPlugin
+from beets.dbcore.query import StringFieldQuery
+from unidecode import unidecode
+
+
+class BareascQuery(StringFieldQuery):
+ """Compare items using bare ASCII, without accents etc."""
+ @classmethod
+ def string_match(cls, pattern, val):
+ """Convert both pattern and string to plain ASCII before matching.
+
+ If pattern is all lower case, also convert string to lower case so
+ match is also case insensitive
+ """
+ # smartcase
+ if pattern.islower():
+ val = val.lower()
+ pattern = unidecode(pattern)
+ val = unidecode(val)
+ return pattern in val
+
+
+class BareascPlugin(BeetsPlugin):
+ """Plugin to provide bare-ASCII option for beets matching."""
+ def __init__(self):
+ """Default prefix for selecting bare-ASCII matching is #."""
+ super().__init__()
+ self.config.add({
+ 'prefix': '#',
+ })
+
+ def queries(self):
+ """Register bare-ASCII matching."""
+ prefix = self.config['prefix'].as_str()
+ return {prefix: BareascQuery}
+
+ def commands(self):
+ """Add bareasc command as unidecode version of 'list'."""
+ cmd = ui.Subcommand('bareasc',
+ help='unidecode version of beet list command')
+ cmd.parser.usage += "\n" \
+ 'Example: %prog -f \'$album: $title\' artist:beatles'
+ cmd.parser.add_all_common_options()
+ cmd.func = self.unidecode_list
+ return [cmd]
+
+ def unidecode_list(self, lib, opts, args):
+ """Emulate normal 'list' command but with unidecode output."""
+ query = decargs(args)
+ album = opts.album
+ # Copied from commands.py - list_items
+ if album:
+ for album in lib.albums(query):
+ bare = unidecode(str(album))
+ print_(bare)
+ else:
+ for item in lib.items(query):
+ bare = unidecode(str(item))
+ print_(bare)
diff --git a/lib/beetsplug/beatport.py b/lib/beetsplug/beatport.py
new file mode 100644
index 00000000..133441d7
--- /dev/null
+++ b/lib/beetsplug/beatport.py
@@ -0,0 +1,470 @@
+# This file is part of beets.
+# Copyright 2016, Adrian Sampson.
+#
+# 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.
+
+"""Adds Beatport release and track search support to the autotagger
+"""
+
+import json
+import re
+from datetime import datetime, timedelta
+
+from requests_oauthlib import OAuth1Session
+from requests_oauthlib.oauth1_session import (TokenRequestDenied, TokenMissing,
+ VerifierMissing)
+
+import beets
+import beets.ui
+from beets.autotag.hooks import AlbumInfo, TrackInfo
+from beets.plugins import BeetsPlugin, MetadataSourcePlugin, get_distance
+import confuse
+
+
+AUTH_ERRORS = (TokenRequestDenied, TokenMissing, VerifierMissing)
+USER_AGENT = f'beets/{beets.__version__} +https://beets.io/'
+
+
+class BeatportAPIError(Exception):
+ pass
+
+
+class BeatportObject:
+ def __init__(self, data):
+ self.beatport_id = data['id']
+ self.name = str(data['name'])
+ if 'releaseDate' in data:
+ self.release_date = datetime.strptime(data['releaseDate'],
+ '%Y-%m-%d')
+ if 'artists' in data:
+ self.artists = [(x['id'], str(x['name']))
+ for x in data['artists']]
+ if 'genres' in data:
+ self.genres = [str(x['name'])
+ for x in data['genres']]
+
+
+class BeatportClient:
+ _api_base = 'https://oauth-api.beatport.com'
+
+ def __init__(self, c_key, c_secret, auth_key=None, auth_secret=None):
+ """ Initiate the client with OAuth information.
+
+ For the initial authentication with the backend `auth_key` and
+ `auth_secret` can be `None`. Use `get_authorize_url` and
+ `get_access_token` to obtain them for subsequent uses of the API.
+
+ :param c_key: OAuth1 client key
+ :param c_secret: OAuth1 client secret
+ :param auth_key: OAuth1 resource owner key
+ :param auth_secret: OAuth1 resource owner secret
+ """
+ self.api = OAuth1Session(
+ client_key=c_key, client_secret=c_secret,
+ resource_owner_key=auth_key,
+ resource_owner_secret=auth_secret,
+ callback_uri='oob')
+ self.api.headers = {'User-Agent': USER_AGENT}
+
+ def get_authorize_url(self):
+ """ Generate the URL for the user to authorize the application.
+
+ Retrieves a request token from the Beatport API and returns the
+ corresponding authorization URL on their end that the user has
+ to visit.
+
+ This is the first step of the initial authorization process with the
+ API. Once the user has visited the URL, call
+ :py:method:`get_access_token` with the displayed data to complete
+ the process.
+
+ :returns: Authorization URL for the user to visit
+ :rtype: unicode
+ """
+ self.api.fetch_request_token(
+ self._make_url('/identity/1/oauth/request-token'))
+ return self.api.authorization_url(
+ self._make_url('/identity/1/oauth/authorize'))
+
+ def get_access_token(self, auth_data):
+ """ Obtain the final access token and secret for the API.
+
+ :param auth_data: URL-encoded authorization data as displayed at
+ the authorization url (obtained via
+ :py:meth:`get_authorize_url`) after signing in
+ :type auth_data: unicode
+ :returns: OAuth resource owner key and secret
+ :rtype: (unicode, unicode) tuple
+ """
+ self.api.parse_authorization_response(
+ "https://beets.io/auth?" + auth_data)
+ access_data = self.api.fetch_access_token(
+ self._make_url('/identity/1/oauth/access-token'))
+ return access_data['oauth_token'], access_data['oauth_token_secret']
+
+ def search(self, query, release_type='release', details=True):
+ """ Perform a search of the Beatport catalogue.
+
+ :param query: Query string
+ :param release_type: Type of releases to search for, can be
+ 'release' or 'track'
+ :param details: Retrieve additional information about the
+ search results. Currently this will fetch
+ the tracklist for releases and do nothing for
+ tracks
+ :returns: Search results
+ :rtype: generator that yields
+ py:class:`BeatportRelease` or
+ :py:class:`BeatportTrack`
+ """
+ response = self._get('catalog/3/search',
+ query=query, perPage=5,
+ facets=[f'fieldType:{release_type}'])
+ for item in response:
+ if release_type == 'release':
+ if details:
+ release = self.get_release(item['id'])
+ else:
+ release = BeatportRelease(item)
+ yield release
+ elif release_type == 'track':
+ yield BeatportTrack(item)
+
+ def get_release(self, beatport_id):
+ """ Get information about a single release.
+
+ :param beatport_id: Beatport ID of the release
+ :returns: The matching release
+ :rtype: :py:class:`BeatportRelease`
+ """
+ response = self._get('/catalog/3/releases', id=beatport_id)
+ if response:
+ release = BeatportRelease(response[0])
+ release.tracks = self.get_release_tracks(beatport_id)
+ return release
+ return None
+
+ def get_release_tracks(self, beatport_id):
+ """ Get all tracks for a given release.
+
+ :param beatport_id: Beatport ID of the release
+ :returns: Tracks in the matching release
+ :rtype: list of :py:class:`BeatportTrack`
+ """
+ response = self._get('/catalog/3/tracks', releaseId=beatport_id,
+ perPage=100)
+ return [BeatportTrack(t) for t in response]
+
+ def get_track(self, beatport_id):
+ """ Get information about a single track.
+
+ :param beatport_id: Beatport ID of the track
+ :returns: The matching track
+ :rtype: :py:class:`BeatportTrack`
+ """
+ response = self._get('/catalog/3/tracks', id=beatport_id)
+ return BeatportTrack(response[0])
+
+ def _make_url(self, endpoint):
+ """ Get complete URL for a given API endpoint. """
+ if not endpoint.startswith('/'):
+ endpoint = '/' + endpoint
+ return self._api_base + endpoint
+
+ def _get(self, endpoint, **kwargs):
+ """ Perform a GET request on a given API endpoint.
+
+ Automatically extracts result data from the response and converts HTTP
+ exceptions into :py:class:`BeatportAPIError` objects.
+ """
+ try:
+ response = self.api.get(self._make_url(endpoint), params=kwargs)
+ except Exception as e:
+ raise BeatportAPIError("Error connecting to Beatport API: {}"
+ .format(e))
+ if not response:
+ raise BeatportAPIError(
+ "Error {0.status_code} for '{0.request.path_url}"
+ .format(response))
+ return response.json()['results']
+
+
+class BeatportRelease(BeatportObject):
+ def __str__(self):
+ if len(self.artists) < 4:
+ artist_str = ", ".join(x[1] for x in self.artists)
+ else:
+ artist_str = "Various Artists"
+ return "".format(
+ artist_str,
+ self.name,
+ self.catalog_number,
+ )
+
+ def __repr__(self):
+ return str(self).encode('utf-8')
+
+ def __init__(self, data):
+ BeatportObject.__init__(self, data)
+ if 'catalogNumber' in data:
+ self.catalog_number = data['catalogNumber']
+ if 'label' in data:
+ self.label_name = data['label']['name']
+ if 'category' in data:
+ self.category = data['category']
+ if 'slug' in data:
+ self.url = "https://beatport.com/release/{}/{}".format(
+ data['slug'], data['id'])
+ self.genre = data.get('genre')
+
+
+class BeatportTrack(BeatportObject):
+ def __str__(self):
+ artist_str = ", ".join(x[1] for x in self.artists)
+ return (""
+ .format(artist_str, self.name, self.mix_name))
+
+ def __repr__(self):
+ return str(self).encode('utf-8')
+
+ def __init__(self, data):
+ BeatportObject.__init__(self, data)
+ if 'title' in data:
+ self.title = str(data['title'])
+ if 'mixName' in data:
+ self.mix_name = str(data['mixName'])
+ self.length = timedelta(milliseconds=data.get('lengthMs', 0) or 0)
+ if not self.length:
+ try:
+ min, sec = data.get('length', '0:0').split(':')
+ self.length = timedelta(minutes=int(min), seconds=int(sec))
+ except ValueError:
+ pass
+ if 'slug' in data:
+ self.url = "https://beatport.com/track/{}/{}" \
+ .format(data['slug'], data['id'])
+ self.track_number = data.get('trackNumber')
+ self.bpm = data.get('bpm')
+ self.initial_key = str(
+ (data.get('key') or {}).get('shortName')
+ )
+
+ # Use 'subgenre' and if not present, 'genre' as a fallback.
+ if data.get('subGenres'):
+ self.genre = str(data['subGenres'][0].get('name'))
+ elif data.get('genres'):
+ self.genre = str(data['genres'][0].get('name'))
+
+
+class BeatportPlugin(BeetsPlugin):
+ data_source = 'Beatport'
+
+ def __init__(self):
+ super().__init__()
+ self.config.add({
+ 'apikey': '57713c3906af6f5def151b33601389176b37b429',
+ 'apisecret': 'b3fe08c93c80aefd749fe871a16cd2bb32e2b954',
+ 'tokenfile': 'beatport_token.json',
+ 'source_weight': 0.5,
+ })
+ self.config['apikey'].redact = True
+ self.config['apisecret'].redact = True
+ self.client = None
+ self.register_listener('import_begin', self.setup)
+
+ def setup(self, session=None):
+ c_key = self.config['apikey'].as_str()
+ c_secret = self.config['apisecret'].as_str()
+
+ # Get the OAuth token from a file or log in.
+ try:
+ with open(self._tokenfile()) as f:
+ tokendata = json.load(f)
+ except OSError:
+ # No token yet. Generate one.
+ token, secret = self.authenticate(c_key, c_secret)
+ else:
+ token = tokendata['token']
+ secret = tokendata['secret']
+
+ self.client = BeatportClient(c_key, c_secret, token, secret)
+
+ def authenticate(self, c_key, c_secret):
+ # Get the link for the OAuth page.
+ auth_client = BeatportClient(c_key, c_secret)
+ try:
+ url = auth_client.get_authorize_url()
+ except AUTH_ERRORS as e:
+ self._log.debug('authentication error: {0}', e)
+ raise beets.ui.UserError('communication with Beatport failed')
+
+ beets.ui.print_("To authenticate with Beatport, visit:")
+ beets.ui.print_(url)
+
+ # Ask for the verifier data and validate it.
+ data = beets.ui.input_("Enter the string displayed in your browser:")
+ try:
+ token, secret = auth_client.get_access_token(data)
+ except AUTH_ERRORS as e:
+ self._log.debug('authentication error: {0}', e)
+ raise beets.ui.UserError('Beatport token request failed')
+
+ # Save the token for later use.
+ self._log.debug('Beatport token {0}, secret {1}', token, secret)
+ with open(self._tokenfile(), 'w') as f:
+ json.dump({'token': token, 'secret': secret}, f)
+
+ return token, secret
+
+ def _tokenfile(self):
+ """Get the path to the JSON file for storing the OAuth token.
+ """
+ return self.config['tokenfile'].get(confuse.Filename(in_app_dir=True))
+
+ def album_distance(self, items, album_info, mapping):
+ """Returns the Beatport source weight and the maximum source weight
+ for albums.
+ """
+ return get_distance(
+ data_source=self.data_source,
+ info=album_info,
+ config=self.config
+ )
+
+ def track_distance(self, item, track_info):
+ """Returns the Beatport source weight and the maximum source weight
+ for individual tracks.
+ """
+ return get_distance(
+ data_source=self.data_source,
+ info=track_info,
+ config=self.config
+ )
+
+ def candidates(self, items, artist, release, va_likely, extra_tags=None):
+ """Returns a list of AlbumInfo objects for beatport search results
+ matching release and artist (if not various).
+ """
+ if va_likely:
+ query = release
+ else:
+ query = f'{artist} {release}'
+ try:
+ return self._get_releases(query)
+ except BeatportAPIError as e:
+ self._log.debug('API Error: {0} (query: {1})', e, query)
+ return []
+
+ def item_candidates(self, item, artist, title):
+ """Returns a list of TrackInfo objects for beatport search results
+ matching title and artist.
+ """
+ query = f'{artist} {title}'
+ try:
+ return self._get_tracks(query)
+ except BeatportAPIError as e:
+ self._log.debug('API Error: {0} (query: {1})', e, query)
+ return []
+
+ def album_for_id(self, release_id):
+ """Fetches a release by its Beatport ID and returns an AlbumInfo object
+ or None if the query is not a valid ID or release is not found.
+ """
+ self._log.debug('Searching for release {0}', release_id)
+ match = re.search(r'(^|beatport\.com/release/.+/)(\d+)$', release_id)
+ if not match:
+ self._log.debug('Not a valid Beatport release ID.')
+ return None
+ release = self.client.get_release(match.group(2))
+ if release:
+ return self._get_album_info(release)
+ return None
+
+ def track_for_id(self, track_id):
+ """Fetches a track by its Beatport ID and returns a TrackInfo object
+ or None if the track is not a valid Beatport ID or track is not found.
+ """
+ self._log.debug('Searching for track {0}', track_id)
+ match = re.search(r'(^|beatport\.com/track/.+/)(\d+)$', track_id)
+ if not match:
+ self._log.debug('Not a valid Beatport track ID.')
+ return None
+ bp_track = self.client.get_track(match.group(2))
+ if bp_track is not None:
+ return self._get_track_info(bp_track)
+ return None
+
+ def _get_releases(self, query):
+ """Returns a list of AlbumInfo objects for a beatport search query.
+ """
+ # Strip non-word characters from query. Things like "!" and "-" can
+ # cause a query to return no results, even if they match the artist or
+ # album title. Use `re.UNICODE` flag to avoid stripping non-english
+ # word characters.
+ query = re.sub(r'\W+', ' ', query, flags=re.UNICODE)
+ # Strip medium information from query, Things like "CD1" and "disk 1"
+ # can also negate an otherwise positive result.
+ query = re.sub(r'\b(CD|disc)\s*\d+', '', query, flags=re.I)
+ albums = [self._get_album_info(x)
+ for x in self.client.search(query)]
+ return albums
+
+ def _get_album_info(self, release):
+ """Returns an AlbumInfo object for a Beatport Release object.
+ """
+ va = len(release.artists) > 3
+ artist, artist_id = self._get_artist(release.artists)
+ if va:
+ artist = "Various Artists"
+ tracks = [self._get_track_info(x) for x in release.tracks]
+
+ return AlbumInfo(album=release.name, album_id=release.beatport_id,
+ artist=artist, artist_id=artist_id, tracks=tracks,
+ albumtype=release.category, va=va,
+ year=release.release_date.year,
+ month=release.release_date.month,
+ day=release.release_date.day,
+ label=release.label_name,
+ catalognum=release.catalog_number, media='Digital',
+ data_source=self.data_source, data_url=release.url,
+ genre=release.genre)
+
+ def _get_track_info(self, track):
+ """Returns a TrackInfo object for a Beatport Track object.
+ """
+ title = track.name
+ if track.mix_name != "Original Mix":
+ title += f" ({track.mix_name})"
+ artist, artist_id = self._get_artist(track.artists)
+ length = track.length.total_seconds()
+ return TrackInfo(title=title, track_id=track.beatport_id,
+ artist=artist, artist_id=artist_id,
+ length=length, index=track.track_number,
+ medium_index=track.track_number,
+ data_source=self.data_source, data_url=track.url,
+ bpm=track.bpm, initial_key=track.initial_key,
+ genre=track.genre)
+
+ def _get_artist(self, artists):
+ """Returns an artist string (all artists) and an artist_id (the main
+ artist) for a list of Beatport release or track artists.
+ """
+ return MetadataSourcePlugin.get_artist(
+ artists=artists, id_key=0, name_key=1
+ )
+
+ def _get_tracks(self, query):
+ """Returns a list of TrackInfo objects for a Beatport query.
+ """
+ bp_tracks = self.client.search(query, release_type='track')
+ tracks = [self._get_track_info(x) for x in bp_tracks]
+ return tracks
diff --git a/lib/beetsplug/bench.py b/lib/beetsplug/bench.py
new file mode 100644
index 00000000..6dffbdda
--- /dev/null
+++ b/lib/beetsplug/bench.py
@@ -0,0 +1,107 @@
+# This file is part of beets.
+# Copyright 2016, Adrian Sampson.
+#
+# 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.
+
+"""Some simple performance benchmarks for beets.
+"""
+
+
+from beets.plugins import BeetsPlugin
+from beets import ui
+from beets import vfs
+from beets import library
+from beets.util.functemplate import Template
+from beets.autotag import match
+from beets import plugins
+from beets import importer
+import cProfile
+import timeit
+
+
+def aunique_benchmark(lib, prof):
+ def _build_tree():
+ vfs.libtree(lib)
+
+ # Measure path generation performance with %aunique{} included.
+ lib.path_formats = [
+ (library.PF_KEY_DEFAULT,
+ Template('$albumartist/$album%aunique{}/$track $title')),
+ ]
+ if prof:
+ cProfile.runctx('_build_tree()', {}, {'_build_tree': _build_tree},
+ 'paths.withaunique.prof')
+ else:
+ interval = timeit.timeit(_build_tree, number=1)
+ print('With %aunique:', interval)
+
+ # And with %aunique replaceed with a "cheap" no-op function.
+ lib.path_formats = [
+ (library.PF_KEY_DEFAULT,
+ Template('$albumartist/$album%lower{}/$track $title')),
+ ]
+ if prof:
+ cProfile.runctx('_build_tree()', {}, {'_build_tree': _build_tree},
+ 'paths.withoutaunique.prof')
+ else:
+ interval = timeit.timeit(_build_tree, number=1)
+ print('Without %aunique:', interval)
+
+
+def match_benchmark(lib, prof, query=None, album_id=None):
+ # If no album ID is provided, we'll match against a suitably huge
+ # album.
+ if not album_id:
+ album_id = '9c5c043e-bc69-4edb-81a4-1aaf9c81e6dc'
+
+ # Get an album from the library to use as the source for the match.
+ items = lib.albums(query).get().items()
+
+ # Ensure fingerprinting is invoked (if enabled).
+ plugins.send('import_task_start',
+ task=importer.ImportTask(None, None, items),
+ session=importer.ImportSession(lib, None, None, None))
+
+ # Run the match.
+ def _run_match():
+ match.tag_album(items, search_ids=[album_id])
+ if prof:
+ cProfile.runctx('_run_match()', {}, {'_run_match': _run_match},
+ 'match.prof')
+ else:
+ interval = timeit.timeit(_run_match, number=1)
+ print('match duration:', interval)
+
+
+class BenchmarkPlugin(BeetsPlugin):
+ """A plugin for performing some simple performance benchmarks.
+ """
+ def commands(self):
+ aunique_bench_cmd = ui.Subcommand('bench_aunique',
+ help='benchmark for %aunique{}')
+ aunique_bench_cmd.parser.add_option('-p', '--profile',
+ action='store_true', default=False,
+ help='performance profiling')
+ aunique_bench_cmd.func = lambda lib, opts, args: \
+ aunique_benchmark(lib, opts.profile)
+
+ match_bench_cmd = ui.Subcommand('bench_match',
+ help='benchmark for track matching')
+ match_bench_cmd.parser.add_option('-p', '--profile',
+ action='store_true', default=False,
+ help='performance profiling')
+ match_bench_cmd.parser.add_option('-i', '--id', default=None,
+ help='album ID to match against')
+ match_bench_cmd.func = lambda lib, opts, args: \
+ match_benchmark(lib, opts.profile, ui.decargs(args), opts.id)
+
+ return [aunique_bench_cmd, match_bench_cmd]
diff --git a/lib/beetsplug/bpd/__init__.py b/lib/beetsplug/bpd/__init__.py
new file mode 100644
index 00000000..07198b1b
--- /dev/null
+++ b/lib/beetsplug/bpd/__init__.py
@@ -0,0 +1,1624 @@
+# This file is part of beets.
+# Copyright 2016, Adrian Sampson.
+#
+# 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.
+
+"""A clone of the Music Player Daemon (MPD) that plays music from a
+Beets library. Attempts to implement a compatible protocol to allow
+use of the wide range of MPD clients.
+"""
+
+
+import re
+import sys
+from string import Template
+import traceback
+import random
+import time
+import math
+import inspect
+import socket
+
+import beets
+from beets.plugins import BeetsPlugin
+import beets.ui
+from beets import vfs
+from beets.util import bluelet
+from beets.library import Item
+from beets import dbcore
+from mediafile import MediaFile
+
+PROTOCOL_VERSION = '0.16.0'
+BUFSIZE = 1024
+
+HELLO = 'OK MPD %s' % PROTOCOL_VERSION
+CLIST_BEGIN = 'command_list_begin'
+CLIST_VERBOSE_BEGIN = 'command_list_ok_begin'
+CLIST_END = 'command_list_end'
+RESP_OK = 'OK'
+RESP_CLIST_VERBOSE = 'list_OK'
+RESP_ERR = 'ACK'
+
+NEWLINE = "\n"
+
+ERROR_NOT_LIST = 1
+ERROR_ARG = 2
+ERROR_PASSWORD = 3
+ERROR_PERMISSION = 4
+ERROR_UNKNOWN = 5
+ERROR_NO_EXIST = 50
+ERROR_PLAYLIST_MAX = 51
+ERROR_SYSTEM = 52
+ERROR_PLAYLIST_LOAD = 53
+ERROR_UPDATE_ALREADY = 54
+ERROR_PLAYER_SYNC = 55
+ERROR_EXIST = 56
+
+VOLUME_MIN = 0
+VOLUME_MAX = 100
+
+SAFE_COMMANDS = (
+ # Commands that are available when unauthenticated.
+ 'close', 'commands', 'notcommands', 'password', 'ping',
+)
+
+# List of subsystems/events used by the `idle` command.
+SUBSYSTEMS = [
+ 'update', 'player', 'mixer', 'options', 'playlist', 'database',
+ # Related to unsupported commands:
+ 'stored_playlist', 'output', 'subscription', 'sticker', 'message',
+ 'partition',
+]
+
+ITEM_KEYS_WRITABLE = set(MediaFile.fields()).intersection(Item._fields.keys())
+
+
+# Gstreamer import error.
+class NoGstreamerError(Exception):
+ pass
+
+
+# Error-handling, exceptions, parameter parsing.
+
+class BPDError(Exception):
+ """An error that should be exposed to the client to the BPD
+ server.
+ """
+ def __init__(self, code, message, cmd_name='', index=0):
+ self.code = code
+ self.message = message
+ self.cmd_name = cmd_name
+ self.index = index
+
+ template = Template('$resp [$code@$index] {$cmd_name} $message')
+
+ def response(self):
+ """Returns a string to be used as the response code for the
+ erring command.
+ """
+ return self.template.substitute({
+ 'resp': RESP_ERR,
+ 'code': self.code,
+ 'index': self.index,
+ 'cmd_name': self.cmd_name,
+ 'message': self.message,
+ })
+
+
+def make_bpd_error(s_code, s_message):
+ """Create a BPDError subclass for a static code and message.
+ """
+
+ class NewBPDError(BPDError):
+ code = s_code
+ message = s_message
+ cmd_name = ''
+ index = 0
+
+ def __init__(self):
+ pass
+ return NewBPDError
+
+ArgumentTypeError = make_bpd_error(ERROR_ARG, 'invalid type for argument')
+ArgumentIndexError = make_bpd_error(ERROR_ARG, 'argument out of range')
+ArgumentNotFoundError = make_bpd_error(ERROR_NO_EXIST, 'argument not found')
+
+
+def cast_arg(t, val):
+ """Attempts to call t on val, raising a ArgumentTypeError
+ on ValueError.
+
+ If 't' is the special string 'intbool', attempts to cast first
+ to an int and then to a bool (i.e., 1=True, 0=False).
+ """
+ if t == 'intbool':
+ return cast_arg(bool, cast_arg(int, val))
+ else:
+ try:
+ return t(val)
+ except ValueError:
+ raise ArgumentTypeError()
+
+
+class BPDClose(Exception):
+ """Raised by a command invocation to indicate that the connection
+ should be closed.
+ """
+
+
+class BPDIdle(Exception):
+ """Raised by a command to indicate the client wants to enter the idle state
+ and should be notified when a relevant event happens.
+ """
+ def __init__(self, subsystems):
+ super().__init__()
+ self.subsystems = set(subsystems)
+
+
+# Generic server infrastructure, implementing the basic protocol.
+
+
+class BaseServer:
+ """A MPD-compatible music player server.
+
+ The functions with the `cmd_` prefix are invoked in response to
+ client commands. For instance, if the client says `status`,
+ `cmd_status` will be invoked. The arguments to the client's commands
+ are used as function arguments following the connection issuing the
+ command. The functions may send data on the connection. They may
+ also raise BPDError exceptions to report errors.
+
+ This is a generic superclass and doesn't support many commands.
+ """
+
+ def __init__(self, host, port, password, ctrl_port, log, ctrl_host=None):
+ """Create a new server bound to address `host` and listening
+ on port `port`. If `password` is given, it is required to do
+ anything significant on the server.
+ A separate control socket is established listening to `ctrl_host` on
+ port `ctrl_port` which is used to forward notifications from the player
+ and can be sent debug commands (e.g. using netcat).
+ """
+ self.host, self.port, self.password = host, port, password
+ self.ctrl_host, self.ctrl_port = ctrl_host or host, ctrl_port
+ self.ctrl_sock = None
+ self._log = log
+
+ # Default server values.
+ self.random = False
+ self.repeat = False
+ self.consume = False
+ self.single = False
+ self.volume = VOLUME_MAX
+ self.crossfade = 0
+ self.mixrampdb = 0.0
+ self.mixrampdelay = float('nan')
+ self.replay_gain_mode = 'off'
+ self.playlist = []
+ self.playlist_version = 0
+ self.current_index = -1
+ self.paused = False
+ self.error = None
+
+ # Current connections
+ self.connections = set()
+
+ # Object for random numbers generation
+ self.random_obj = random.Random()
+
+ def connect(self, conn):
+ """A new client has connected.
+ """
+ self.connections.add(conn)
+
+ def disconnect(self, conn):
+ """Client has disconnected; clean up residual state.
+ """
+ self.connections.remove(conn)
+
+ def run(self):
+ """Block and start listening for connections from clients. An
+ interrupt (^C) closes the server.
+ """
+ self.startup_time = time.time()
+
+ def start():
+ yield bluelet.spawn(
+ bluelet.server(self.ctrl_host, self.ctrl_port,
+ ControlConnection.handler(self)))
+ yield bluelet.server(self.host, self.port,
+ MPDConnection.handler(self))
+ bluelet.run(start())
+
+ def dispatch_events(self):
+ """If any clients have idle events ready, send them.
+ """
+ # We need a copy of `self.connections` here since clients might
+ # disconnect once we try and send to them, changing `self.connections`.
+ for conn in list(self.connections):
+ yield bluelet.spawn(conn.send_notifications())
+
+ def _ctrl_send(self, message):
+ """Send some data over the control socket.
+ If it's our first time, open the socket. The message should be a
+ string without a terminal newline.
+ """
+ if not self.ctrl_sock:
+ self.ctrl_sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+ self.ctrl_sock.connect((self.ctrl_host, self.ctrl_port))
+ self.ctrl_sock.sendall((message + '\n').encode('utf-8'))
+
+ def _send_event(self, event):
+ """Notify subscribed connections of an event."""
+ for conn in self.connections:
+ conn.notify(event)
+
+ def _item_info(self, item):
+ """An abstract method that should response lines containing a
+ single song's metadata.
+ """
+ raise NotImplementedError
+
+ def _item_id(self, item):
+ """An abstract method returning the integer id for an item.
+ """
+ raise NotImplementedError
+
+ def _id_to_index(self, track_id):
+ """Searches the playlist for a song with the given id and
+ returns its index in the playlist.
+ """
+ track_id = cast_arg(int, track_id)
+ for index, track in enumerate(self.playlist):
+ if self._item_id(track) == track_id:
+ return index
+ # Loop finished with no track found.
+ raise ArgumentNotFoundError()
+
+ def _random_idx(self):
+ """Returns a random index different from the current one.
+ If there are no songs in the playlist it returns -1.
+ If there is only one song in the playlist it returns 0.
+ """
+ if len(self.playlist) < 2:
+ return len(self.playlist) - 1
+ new_index = self.random_obj.randint(0, len(self.playlist) - 1)
+ while new_index == self.current_index:
+ new_index = self.random_obj.randint(0, len(self.playlist) - 1)
+ return new_index
+
+ def _succ_idx(self):
+ """Returns the index for the next song to play.
+ It also considers random, single and repeat flags.
+ No boundaries are checked.
+ """
+ if self.repeat and self.single:
+ return self.current_index
+ if self.random:
+ return self._random_idx()
+ return self.current_index + 1
+
+ def _prev_idx(self):
+ """Returns the index for the previous song to play.
+ It also considers random and repeat flags.
+ No boundaries are checked.
+ """
+ if self.repeat and self.single:
+ return self.current_index
+ if self.random:
+ return self._random_idx()
+ return self.current_index - 1
+
+ def cmd_ping(self, conn):
+ """Succeeds."""
+ pass
+
+ def cmd_idle(self, conn, *subsystems):
+ subsystems = subsystems or SUBSYSTEMS
+ for system in subsystems:
+ if system not in SUBSYSTEMS:
+ raise BPDError(ERROR_ARG,
+ f'Unrecognised idle event: {system}')
+ raise BPDIdle(subsystems) # put the connection into idle mode
+
+ def cmd_kill(self, conn):
+ """Exits the server process."""
+ sys.exit(0)
+
+ def cmd_close(self, conn):
+ """Closes the connection."""
+ raise BPDClose()
+
+ def cmd_password(self, conn, password):
+ """Attempts password authentication."""
+ if password == self.password:
+ conn.authenticated = True
+ else:
+ conn.authenticated = False
+ raise BPDError(ERROR_PASSWORD, 'incorrect password')
+
+ def cmd_commands(self, conn):
+ """Lists the commands available to the user."""
+ if self.password and not conn.authenticated:
+ # Not authenticated. Show limited list of commands.
+ for cmd in SAFE_COMMANDS:
+ yield 'command: ' + cmd
+
+ else:
+ # Authenticated. Show all commands.
+ for func in dir(self):
+ if func.startswith('cmd_'):
+ yield 'command: ' + func[4:]
+
+ def cmd_notcommands(self, conn):
+ """Lists all unavailable commands."""
+ if self.password and not conn.authenticated:
+ # Not authenticated. Show privileged commands.
+ for func in dir(self):
+ if func.startswith('cmd_'):
+ cmd = func[4:]
+ if cmd not in SAFE_COMMANDS:
+ yield 'command: ' + cmd
+
+ else:
+ # Authenticated. No commands are unavailable.
+ pass
+
+ def cmd_status(self, conn):
+ """Returns some status information for use with an
+ implementation of cmd_status.
+
+ Gives a list of response-lines for: volume, repeat, random,
+ playlist, playlistlength, and xfade.
+ """
+ yield (
+ 'repeat: ' + str(int(self.repeat)),
+ 'random: ' + str(int(self.random)),
+ 'consume: ' + str(int(self.consume)),
+ 'single: ' + str(int(self.single)),
+ 'playlist: ' + str(self.playlist_version),
+ 'playlistlength: ' + str(len(self.playlist)),
+ 'mixrampdb: ' + str(self.mixrampdb),
+ )
+
+ if self.volume > 0:
+ yield 'volume: ' + str(self.volume)
+
+ if not math.isnan(self.mixrampdelay):
+ yield 'mixrampdelay: ' + str(self.mixrampdelay)
+ if self.crossfade > 0:
+ yield 'xfade: ' + str(self.crossfade)
+
+ if self.current_index == -1:
+ state = 'stop'
+ elif self.paused:
+ state = 'pause'
+ else:
+ state = 'play'
+ yield 'state: ' + state
+
+ if self.current_index != -1: # i.e., paused or playing
+ current_id = self._item_id(self.playlist[self.current_index])
+ yield 'song: ' + str(self.current_index)
+ yield 'songid: ' + str(current_id)
+ if len(self.playlist) > self.current_index + 1:
+ # If there's a next song, report its index too.
+ next_id = self._item_id(self.playlist[self.current_index + 1])
+ yield 'nextsong: ' + str(self.current_index + 1)
+ yield 'nextsongid: ' + str(next_id)
+
+ if self.error:
+ yield 'error: ' + self.error
+
+ def cmd_clearerror(self, conn):
+ """Removes the persistent error state of the server. This
+ error is set when a problem arises not in response to a
+ command (for instance, when playing a file).
+ """
+ self.error = None
+
+ def cmd_random(self, conn, state):
+ """Set or unset random (shuffle) mode."""
+ self.random = cast_arg('intbool', state)
+ self._send_event('options')
+
+ def cmd_repeat(self, conn, state):
+ """Set or unset repeat mode."""
+ self.repeat = cast_arg('intbool', state)
+ self._send_event('options')
+
+ def cmd_consume(self, conn, state):
+ """Set or unset consume mode."""
+ self.consume = cast_arg('intbool', state)
+ self._send_event('options')
+
+ def cmd_single(self, conn, state):
+ """Set or unset single mode."""
+ # TODO support oneshot in addition to 0 and 1 [MPD 0.20]
+ self.single = cast_arg('intbool', state)
+ self._send_event('options')
+
+ def cmd_setvol(self, conn, vol):
+ """Set the player's volume level (0-100)."""
+ vol = cast_arg(int, vol)
+ if vol < VOLUME_MIN or vol > VOLUME_MAX:
+ raise BPDError(ERROR_ARG, 'volume out of range')
+ self.volume = vol
+ self._send_event('mixer')
+
+ def cmd_volume(self, conn, vol_delta):
+ """Deprecated command to change the volume by a relative amount."""
+ vol_delta = cast_arg(int, vol_delta)
+ return self.cmd_setvol(conn, self.volume + vol_delta)
+
+ def cmd_crossfade(self, conn, crossfade):
+ """Set the number of seconds of crossfading."""
+ crossfade = cast_arg(int, crossfade)
+ if crossfade < 0:
+ raise BPDError(ERROR_ARG, 'crossfade time must be nonnegative')
+ self._log.warning('crossfade is not implemented in bpd')
+ self.crossfade = crossfade
+ self._send_event('options')
+
+ def cmd_mixrampdb(self, conn, db):
+ """Set the mixramp normalised max volume in dB."""
+ db = cast_arg(float, db)
+ if db > 0:
+ raise BPDError(ERROR_ARG, 'mixrampdb time must be negative')
+ self._log.warning('mixramp is not implemented in bpd')
+ self.mixrampdb = db
+ self._send_event('options')
+
+ def cmd_mixrampdelay(self, conn, delay):
+ """Set the mixramp delay in seconds."""
+ delay = cast_arg(float, delay)
+ if delay < 0:
+ raise BPDError(ERROR_ARG, 'mixrampdelay time must be nonnegative')
+ self._log.warning('mixramp is not implemented in bpd')
+ self.mixrampdelay = delay
+ self._send_event('options')
+
+ def cmd_replay_gain_mode(self, conn, mode):
+ """Set the replay gain mode."""
+ if mode not in ['off', 'track', 'album', 'auto']:
+ raise BPDError(ERROR_ARG, 'Unrecognised replay gain mode')
+ self._log.warning('replay gain is not implemented in bpd')
+ self.replay_gain_mode = mode
+ self._send_event('options')
+
+ def cmd_replay_gain_status(self, conn):
+ """Get the replaygain mode."""
+ yield 'replay_gain_mode: ' + str(self.replay_gain_mode)
+
+ def cmd_clear(self, conn):
+ """Clear the playlist."""
+ self.playlist = []
+ self.playlist_version += 1
+ self.cmd_stop(conn)
+ self._send_event('playlist')
+
+ def cmd_delete(self, conn, index):
+ """Remove the song at index from the playlist."""
+ index = cast_arg(int, index)
+ try:
+ del(self.playlist[index])
+ except IndexError:
+ raise ArgumentIndexError()
+ self.playlist_version += 1
+
+ if self.current_index == index: # Deleted playing song.
+ self.cmd_stop(conn)
+ elif index < self.current_index: # Deleted before playing.
+ # Shift playing index down.
+ self.current_index -= 1
+ self._send_event('playlist')
+
+ def cmd_deleteid(self, conn, track_id):
+ self.cmd_delete(conn, self._id_to_index(track_id))
+
+ def cmd_move(self, conn, idx_from, idx_to):
+ """Move a track in the playlist."""
+ idx_from = cast_arg(int, idx_from)
+ idx_to = cast_arg(int, idx_to)
+ try:
+ track = self.playlist.pop(idx_from)
+ self.playlist.insert(idx_to, track)
+ except IndexError:
+ raise ArgumentIndexError()
+
+ # Update currently-playing song.
+ if idx_from == self.current_index:
+ self.current_index = idx_to
+ elif idx_from < self.current_index <= idx_to:
+ self.current_index -= 1
+ elif idx_from > self.current_index >= idx_to:
+ self.current_index += 1
+
+ self.playlist_version += 1
+ self._send_event('playlist')
+
+ def cmd_moveid(self, conn, idx_from, idx_to):
+ idx_from = self._id_to_index(idx_from)
+ return self.cmd_move(conn, idx_from, idx_to)
+
+ def cmd_swap(self, conn, i, j):
+ """Swaps two tracks in the playlist."""
+ i = cast_arg(int, i)
+ j = cast_arg(int, j)
+ try:
+ track_i = self.playlist[i]
+ track_j = self.playlist[j]
+ except IndexError:
+ raise ArgumentIndexError()
+
+ self.playlist[j] = track_i
+ self.playlist[i] = track_j
+
+ # Update currently-playing song.
+ if self.current_index == i:
+ self.current_index = j
+ elif self.current_index == j:
+ self.current_index = i
+
+ self.playlist_version += 1
+ self._send_event('playlist')
+
+ def cmd_swapid(self, conn, i_id, j_id):
+ i = self._id_to_index(i_id)
+ j = self._id_to_index(j_id)
+ return self.cmd_swap(conn, i, j)
+
+ def cmd_urlhandlers(self, conn):
+ """Indicates supported URL schemes. None by default."""
+ pass
+
+ def cmd_playlistinfo(self, conn, index=None):
+ """Gives metadata information about the entire playlist or a
+ single track, given by its index.
+ """
+ if index is None:
+ for track in self.playlist:
+ yield self._item_info(track)
+ else:
+ indices = self._parse_range(index, accept_single_number=True)
+ try:
+ tracks = [self.playlist[i] for i in indices]
+ except IndexError:
+ raise ArgumentIndexError()
+ for track in tracks:
+ yield self._item_info(track)
+
+ def cmd_playlistid(self, conn, track_id=None):
+ if track_id is not None:
+ track_id = cast_arg(int, track_id)
+ track_id = self._id_to_index(track_id)
+ return self.cmd_playlistinfo(conn, track_id)
+
+ def cmd_plchanges(self, conn, version):
+ """Sends playlist changes since the given version.
+
+ This is a "fake" implementation that ignores the version and
+ just returns the entire playlist (rather like version=0). This
+ seems to satisfy many clients.
+ """
+ return self.cmd_playlistinfo(conn)
+
+ def cmd_plchangesposid(self, conn, version):
+ """Like plchanges, but only sends position and id.
+
+ Also a dummy implementation.
+ """
+ for idx, track in enumerate(self.playlist):
+ yield 'cpos: ' + str(idx)
+ yield 'Id: ' + str(track.id)
+
+ def cmd_currentsong(self, conn):
+ """Sends information about the currently-playing song.
+ """
+ if self.current_index != -1: # -1 means stopped.
+ track = self.playlist[self.current_index]
+ yield self._item_info(track)
+
+ def cmd_next(self, conn):
+ """Advance to the next song in the playlist."""
+ old_index = self.current_index
+ self.current_index = self._succ_idx()
+ if self.consume:
+ # TODO how does consume interact with single+repeat?
+ self.playlist.pop(old_index)
+ if self.current_index > old_index:
+ self.current_index -= 1
+ self.playlist_version += 1
+ self._send_event("playlist")
+ if self.current_index >= len(self.playlist):
+ # Fallen off the end. Move to stopped state or loop.
+ if self.repeat:
+ self.current_index = -1
+ return self.cmd_play(conn)
+ return self.cmd_stop(conn)
+ elif self.single and not self.repeat:
+ return self.cmd_stop(conn)
+ else:
+ return self.cmd_play(conn)
+
+ def cmd_previous(self, conn):
+ """Step back to the last song."""
+ old_index = self.current_index
+ self.current_index = self._prev_idx()
+ if self.consume:
+ self.playlist.pop(old_index)
+ if self.current_index < 0:
+ if self.repeat:
+ self.current_index = len(self.playlist) - 1
+ else:
+ self.current_index = 0
+ return self.cmd_play(conn)
+
+ def cmd_pause(self, conn, state=None):
+ """Set the pause state playback."""
+ if state is None:
+ self.paused = not self.paused # Toggle.
+ else:
+ self.paused = cast_arg('intbool', state)
+ self._send_event('player')
+
+ def cmd_play(self, conn, index=-1):
+ """Begin playback, possibly at a specified playlist index."""
+ index = cast_arg(int, index)
+
+ if index < -1 or index >= len(self.playlist):
+ raise ArgumentIndexError()
+
+ if index == -1: # No index specified: start where we are.
+ if not self.playlist: # Empty playlist: stop immediately.
+ return self.cmd_stop(conn)
+ if self.current_index == -1: # No current song.
+ self.current_index = 0 # Start at the beginning.
+ # If we have a current song, just stay there.
+
+ else: # Start with the specified index.
+ self.current_index = index
+
+ self.paused = False
+ self._send_event('player')
+
+ def cmd_playid(self, conn, track_id=0):
+ track_id = cast_arg(int, track_id)
+ if track_id == -1:
+ index = -1
+ else:
+ index = self._id_to_index(track_id)
+ return self.cmd_play(conn, index)
+
+ def cmd_stop(self, conn):
+ """Stop playback."""
+ self.current_index = -1
+ self.paused = False
+ self._send_event('player')
+
+ def cmd_seek(self, conn, index, pos):
+ """Seek to a specified point in a specified song."""
+ index = cast_arg(int, index)
+ if index < 0 or index >= len(self.playlist):
+ raise ArgumentIndexError()
+ self.current_index = index
+ self._send_event('player')
+
+ def cmd_seekid(self, conn, track_id, pos):
+ index = self._id_to_index(track_id)
+ return self.cmd_seek(conn, index, pos)
+
+ # Additions to the MPD protocol.
+
+ def cmd_crash_TypeError(self, conn): # noqa: N802
+ """Deliberately trigger a TypeError for testing purposes.
+ We want to test that the server properly responds with ERROR_SYSTEM
+ without crashing, and that this is not treated as ERROR_ARG (since it
+ is caused by a programming error, not a protocol error).
+ """
+ 'a' + 2
+
+
+class Connection:
+ """A connection between a client and the server.
+ """
+ def __init__(self, server, sock):
+ """Create a new connection for the accepted socket `client`.
+ """
+ self.server = server
+ self.sock = sock
+ self.address = '{}:{}'.format(*sock.sock.getpeername())
+
+ def debug(self, message, kind=' '):
+ """Log a debug message about this connection.
+ """
+ self.server._log.debug('{}[{}]: {}', kind, self.address, message)
+
+ def run(self):
+ pass
+
+ def send(self, lines):
+ """Send lines, which which is either a single string or an
+ iterable consisting of strings, to the client. A newline is
+ added after every string. Returns a Bluelet event that sends
+ the data.
+ """
+ if isinstance(lines, str):
+ lines = [lines]
+ out = NEWLINE.join(lines) + NEWLINE
+ for l in out.split(NEWLINE)[:-1]:
+ self.debug(l, kind='>')
+ if isinstance(out, str):
+ out = out.encode('utf-8')
+ return self.sock.sendall(out)
+
+ @classmethod
+ def handler(cls, server):
+ def _handle(sock):
+ """Creates a new `Connection` and runs it.
+ """
+ return cls(server, sock).run()
+ return _handle
+
+
+class MPDConnection(Connection):
+ """A connection that receives commands from an MPD-compatible client.
+ """
+ def __init__(self, server, sock):
+ """Create a new connection for the accepted socket `client`.
+ """
+ super().__init__(server, sock)
+ self.authenticated = False
+ self.notifications = set()
+ self.idle_subscriptions = set()
+
+ def do_command(self, command):
+ """A coroutine that runs the given command and sends an
+ appropriate response."""
+ try:
+ yield bluelet.call(command.run(self))
+ except BPDError as e:
+ # Send the error.
+ yield self.send(e.response())
+ else:
+ # Send success code.
+ yield self.send(RESP_OK)
+
+ def disconnect(self):
+ """The connection has closed for any reason.
+ """
+ self.server.disconnect(self)
+ self.debug('disconnected', kind='*')
+
+ def notify(self, event):
+ """Queue up an event for sending to this client.
+ """
+ self.notifications.add(event)
+
+ def send_notifications(self, force_close_idle=False):
+ """Send the client any queued events now.
+ """
+ pending = self.notifications.intersection(self.idle_subscriptions)
+ try:
+ for event in pending:
+ yield self.send(f'changed: {event}')
+ if pending or force_close_idle:
+ self.idle_subscriptions = set()
+ self.notifications = self.notifications.difference(pending)
+ yield self.send(RESP_OK)
+ except bluelet.SocketClosedError:
+ self.disconnect() # Client disappeared.
+
+ def run(self):
+ """Send a greeting to the client and begin processing commands
+ as they arrive.
+ """
+ self.debug('connected', kind='*')
+ self.server.connect(self)
+ yield self.send(HELLO)
+
+ clist = None # Initially, no command list is being constructed.
+ while True:
+ line = yield self.sock.readline()
+ if not line:
+ self.disconnect() # Client disappeared.
+ break
+ line = line.strip()
+ if not line:
+ err = BPDError(ERROR_UNKNOWN, 'No command given')
+ yield self.send(err.response())
+ self.disconnect() # Client sent a blank line.
+ break
+ line = line.decode('utf8') # MPD protocol uses UTF-8.
+ for l in line.split(NEWLINE):
+ self.debug(l, kind='<')
+
+ if self.idle_subscriptions:
+ # The connection is in idle mode.
+ if line == 'noidle':
+ yield bluelet.call(self.send_notifications(True))
+ else:
+ err = BPDError(ERROR_UNKNOWN,
+ f'Got command while idle: {line}')
+ yield self.send(err.response())
+ break
+ continue
+ if line == 'noidle':
+ # When not in idle, this command sends no response.
+ continue
+
+ if clist is not None:
+ # Command list already opened.
+ if line == CLIST_END:
+ yield bluelet.call(self.do_command(clist))
+ clist = None # Clear the command list.
+ yield bluelet.call(self.server.dispatch_events())
+ else:
+ clist.append(Command(line))
+
+ elif line == CLIST_BEGIN or line == CLIST_VERBOSE_BEGIN:
+ # Begin a command list.
+ clist = CommandList([], line == CLIST_VERBOSE_BEGIN)
+
+ else:
+ # Ordinary command.
+ try:
+ yield bluelet.call(self.do_command(Command(line)))
+ except BPDClose:
+ # Command indicates that the conn should close.
+ self.sock.close()
+ self.disconnect() # Client explicitly closed.
+ return
+ except BPDIdle as e:
+ self.idle_subscriptions = e.subsystems
+ self.debug('awaiting: {}'.format(' '.join(e.subsystems)),
+ kind='z')
+ yield bluelet.call(self.server.dispatch_events())
+
+
+class ControlConnection(Connection):
+ """A connection used to control BPD for debugging and internal events.
+ """
+ def __init__(self, server, sock):
+ """Create a new connection for the accepted socket `client`.
+ """
+ super().__init__(server, sock)
+
+ def debug(self, message, kind=' '):
+ self.server._log.debug('CTRL {}[{}]: {}', kind, self.address, message)
+
+ def run(self):
+ """Listen for control commands and delegate to `ctrl_*` methods.
+ """
+ self.debug('connected', kind='*')
+ while True:
+ line = yield self.sock.readline()
+ if not line:
+ break # Client disappeared.
+ line = line.strip()
+ if not line:
+ break # Client sent a blank line.
+ line = line.decode('utf8') # Protocol uses UTF-8.
+ for l in line.split(NEWLINE):
+ self.debug(l, kind='<')
+ command = Command(line)
+ try:
+ func = command.delegate('ctrl_', self)
+ yield bluelet.call(func(*command.args))
+ except (AttributeError, TypeError) as e:
+ yield self.send('ERROR: {}'.format(e.args[0]))
+ except Exception:
+ yield self.send(['ERROR: server error',
+ traceback.format_exc().rstrip()])
+
+ def ctrl_play_finished(self):
+ """Callback from the player signalling a song finished playing.
+ """
+ yield bluelet.call(self.server.dispatch_events())
+
+ def ctrl_profile(self):
+ """Memory profiling for debugging.
+ """
+ from guppy import hpy
+ heap = hpy().heap()
+ yield self.send(heap)
+
+ def ctrl_nickname(self, oldlabel, newlabel):
+ """Rename a client in the log messages.
+ """
+ for c in self.server.connections:
+ if c.address == oldlabel:
+ c.address = newlabel
+ break
+ else:
+ yield self.send(f'ERROR: no such client: {oldlabel}')
+
+
+class Command:
+ """A command issued by the client for processing by the server.
+ """
+
+ command_re = re.compile(r'^([^ \t]+)[ \t]*')
+ arg_re = re.compile(r'"((?:\\"|[^"])+)"|([^ \t"]+)')
+
+ def __init__(self, s):
+ """Creates a new `Command` from the given string, `s`, parsing
+ the string for command name and arguments.
+ """
+ command_match = self.command_re.match(s)
+ self.name = command_match.group(1)
+
+ self.args = []
+ arg_matches = self.arg_re.findall(s[command_match.end():])
+ for match in arg_matches:
+ if match[0]:
+ # Quoted argument.
+ arg = match[0]
+ arg = arg.replace('\\"', '"').replace('\\\\', '\\')
+ else:
+ # Unquoted argument.
+ arg = match[1]
+ self.args.append(arg)
+
+ def delegate(self, prefix, target, extra_args=0):
+ """Get the target method that corresponds to this command.
+ The `prefix` is prepended to the command name and then the resulting
+ name is used to search `target` for a method with a compatible number
+ of arguments.
+ """
+ # Attempt to get correct command function.
+ func_name = prefix + self.name
+ if not hasattr(target, func_name):
+ raise AttributeError(f'unknown command "{self.name}"')
+ func = getattr(target, func_name)
+
+ argspec = inspect.getfullargspec(func)
+
+ # Check that `func` is able to handle the number of arguments sent
+ # by the client (so we can raise ERROR_ARG instead of ERROR_SYSTEM).
+ # Maximum accepted arguments: argspec includes "self".
+ max_args = len(argspec.args) - 1 - extra_args
+ # Minimum accepted arguments: some arguments might be optional.
+ min_args = max_args
+ if argspec.defaults:
+ min_args -= len(argspec.defaults)
+ wrong_num = (len(self.args) > max_args) or (len(self.args) < min_args)
+ # If the command accepts a variable number of arguments skip the check.
+ if wrong_num and not argspec.varargs:
+ raise TypeError('wrong number of arguments for "{}"'
+ .format(self.name), self.name)
+
+ return func
+
+ def run(self, conn):
+ """A coroutine that executes the command on the given
+ connection.
+ """
+ try:
+ # `conn` is an extra argument to all cmd handlers.
+ func = self.delegate('cmd_', conn.server, extra_args=1)
+ except AttributeError as e:
+ raise BPDError(ERROR_UNKNOWN, e.args[0])
+ except TypeError as e:
+ raise BPDError(ERROR_ARG, e.args[0], self.name)
+
+ # Ensure we have permission for this command.
+ if conn.server.password and \
+ not conn.authenticated and \
+ self.name not in SAFE_COMMANDS:
+ raise BPDError(ERROR_PERMISSION, 'insufficient privileges')
+
+ try:
+ args = [conn] + self.args
+ results = func(*args)
+ if results:
+ for data in results:
+ yield conn.send(data)
+
+ except BPDError as e:
+ # An exposed error. Set the command name and then let
+ # the Connection handle it.
+ e.cmd_name = self.name
+ raise e
+
+ except BPDClose:
+ # An indication that the connection should close. Send
+ # it on the Connection.
+ raise
+
+ except BPDIdle:
+ raise
+
+ except Exception:
+ # An "unintentional" error. Hide it from the client.
+ conn.server._log.error('{}', traceback.format_exc())
+ raise BPDError(ERROR_SYSTEM, 'server error', self.name)
+
+
+class CommandList(list):
+ """A list of commands issued by the client for processing by the
+ server. May be verbose, in which case the response is delimited, or
+ not. Should be a list of `Command` objects.
+ """
+
+ def __init__(self, sequence=None, verbose=False):
+ """Create a new `CommandList` from the given sequence of
+ `Command`s. If `verbose`, this is a verbose command list.
+ """
+ if sequence:
+ for item in sequence:
+ self.append(item)
+ self.verbose = verbose
+
+ def run(self, conn):
+ """Coroutine executing all the commands in this list.
+ """
+ for i, command in enumerate(self):
+ try:
+ yield bluelet.call(command.run(conn))
+ except BPDError as e:
+ # If the command failed, stop executing.
+ e.index = i # Give the error the correct index.
+ raise e
+
+ # Otherwise, possibly send the output delimiter if we're in a
+ # verbose ("OK") command list.
+ if self.verbose:
+ yield conn.send(RESP_CLIST_VERBOSE)
+
+
+# A subclass of the basic, protocol-handling server that actually plays
+# music.
+
+class Server(BaseServer):
+ """An MPD-compatible server using GStreamer to play audio and beets
+ to store its library.
+ """
+
+ def __init__(self, library, host, port, password, ctrl_port, log):
+ try:
+ from beetsplug.bpd import gstplayer
+ except ImportError as e:
+ # This is a little hacky, but it's the best I know for now.
+ if e.args[0].endswith(' gst'):
+ raise NoGstreamerError()
+ else:
+ raise
+ log.info('Starting server...')
+ super().__init__(host, port, password, ctrl_port, log)
+ self.lib = library
+ self.player = gstplayer.GstPlayer(self.play_finished)
+ self.cmd_update(None)
+ log.info('Server ready and listening on {}:{}'.format(
+ host, port))
+ log.debug('Listening for control signals on {}:{}'.format(
+ host, ctrl_port))
+
+ def run(self):
+ self.player.run()
+ super().run()
+
+ def play_finished(self):
+ """A callback invoked every time our player finishes a track.
+ """
+ self.cmd_next(None)
+ self._ctrl_send('play_finished')
+
+ # Metadata helper functions.
+
+ def _item_info(self, item):
+ info_lines = [
+ 'file: ' + item.destination(fragment=True),
+ 'Time: ' + str(int(item.length)),
+ 'duration: ' + f'{item.length:.3f}',
+ 'Id: ' + str(item.id),
+ ]
+
+ try:
+ pos = self._id_to_index(item.id)
+ info_lines.append('Pos: ' + str(pos))
+ except ArgumentNotFoundError:
+ # Don't include position if not in playlist.
+ pass
+
+ for tagtype, field in self.tagtype_map.items():
+ info_lines.append('{}: {}'.format(
+ tagtype, str(getattr(item, field))))
+
+ return info_lines
+
+ def _parse_range(self, items, accept_single_number=False):
+ """Convert a range of positions to a list of item info.
+ MPD specifies ranges as START:STOP (endpoint excluded) for some
+ commands. Sometimes a single number can be provided instead.
+ """
+ try:
+ start, stop = str(items).split(':', 1)
+ except ValueError:
+ if accept_single_number:
+ return [cast_arg(int, items)]
+ raise BPDError(ERROR_ARG, 'bad range syntax')
+ start = cast_arg(int, start)
+ stop = cast_arg(int, stop)
+ return range(start, stop)
+
+ def _item_id(self, item):
+ return item.id
+
+ # Database updating.
+
+ def cmd_update(self, conn, path='/'):
+ """Updates the catalog to reflect the current database state.
+ """
+ # Path is ignored. Also, the real MPD does this asynchronously;
+ # this is done inline.
+ self._log.debug('Building directory tree...')
+ self.tree = vfs.libtree(self.lib)
+ self._log.debug('Finished building directory tree.')
+ self.updated_time = time.time()
+ self._send_event('update')
+ self._send_event('database')
+
+ # Path (directory tree) browsing.
+
+ def _resolve_path(self, path):
+ """Returns a VFS node or an item ID located at the path given.
+ If the path does not exist, raises a
+ """
+ components = path.split('/')
+ node = self.tree
+
+ for component in components:
+ if not component:
+ continue
+
+ if isinstance(node, int):
+ # We're trying to descend into a file node.
+ raise ArgumentNotFoundError()
+
+ if component in node.files:
+ node = node.files[component]
+ elif component in node.dirs:
+ node = node.dirs[component]
+ else:
+ raise ArgumentNotFoundError()
+
+ return node
+
+ def _path_join(self, p1, p2):
+ """Smashes together two BPD paths."""
+ out = p1 + '/' + p2
+ return out.replace('//', '/').replace('//', '/')
+
+ def cmd_lsinfo(self, conn, path="/"):
+ """Sends info on all the items in the path."""
+ node = self._resolve_path(path)
+ if isinstance(node, int):
+ # Trying to list a track.
+ raise BPDError(ERROR_ARG, 'this is not a directory')
+ else:
+ for name, itemid in iter(sorted(node.files.items())):
+ item = self.lib.get_item(itemid)
+ yield self._item_info(item)
+ for name, _ in iter(sorted(node.dirs.items())):
+ dirpath = self._path_join(path, name)
+ if dirpath.startswith("/"):
+ # Strip leading slash (libmpc rejects this).
+ dirpath = dirpath[1:]
+ yield 'directory: %s' % dirpath
+
+ def _listall(self, basepath, node, info=False):
+ """Helper function for recursive listing. If info, show
+ tracks' complete info; otherwise, just show items' paths.
+ """
+ if isinstance(node, int):
+ # List a single file.
+ if info:
+ item = self.lib.get_item(node)
+ yield self._item_info(item)
+ else:
+ yield 'file: ' + basepath
+ else:
+ # List a directory. Recurse into both directories and files.
+ for name, itemid in sorted(node.files.items()):
+ newpath = self._path_join(basepath, name)
+ # "yield from"
+ yield from self._listall(newpath, itemid, info)
+ for name, subdir in sorted(node.dirs.items()):
+ newpath = self._path_join(basepath, name)
+ yield 'directory: ' + newpath
+ yield from self._listall(newpath, subdir, info)
+
+ def cmd_listall(self, conn, path="/"):
+ """Send the paths all items in the directory, recursively."""
+ return self._listall(path, self._resolve_path(path), False)
+
+ def cmd_listallinfo(self, conn, path="/"):
+ """Send info on all the items in the directory, recursively."""
+ return self._listall(path, self._resolve_path(path), True)
+
+ # Playlist manipulation.
+
+ def _all_items(self, node):
+ """Generator yielding all items under a VFS node.
+ """
+ if isinstance(node, int):
+ # Could be more efficient if we built up all the IDs and
+ # then issued a single SELECT.
+ yield self.lib.get_item(node)
+ else:
+ # Recurse into a directory.
+ for name, itemid in sorted(node.files.items()):
+ # "yield from"
+ yield from self._all_items(itemid)
+ for name, subdir in sorted(node.dirs.items()):
+ yield from self._all_items(subdir)
+
+ def _add(self, path, send_id=False):
+ """Adds a track or directory to the playlist, specified by the
+ path. If `send_id`, write each item's id to the client.
+ """
+ for item in self._all_items(self._resolve_path(path)):
+ self.playlist.append(item)
+ if send_id:
+ yield 'Id: ' + str(item.id)
+ self.playlist_version += 1
+ self._send_event('playlist')
+
+ def cmd_add(self, conn, path):
+ """Adds a track or directory to the playlist, specified by a
+ path.
+ """
+ return self._add(path, False)
+
+ def cmd_addid(self, conn, path):
+ """Same as `cmd_add` but sends an id back to the client."""
+ return self._add(path, True)
+
+ # Server info.
+
+ def cmd_status(self, conn):
+ yield from super().cmd_status(conn)
+ if self.current_index > -1:
+ item = self.playlist[self.current_index]
+
+ yield (
+ 'bitrate: ' + str(item.bitrate / 1000),
+ 'audio: {}:{}:{}'.format(
+ str(item.samplerate),
+ str(item.bitdepth),
+ str(item.channels),
+ ),
+ )
+
+ (pos, total) = self.player.time()
+ yield (
+ 'time: {}:{}'.format(
+ str(int(pos)),
+ str(int(total)),
+ ),
+ 'elapsed: ' + f'{pos:.3f}',
+ 'duration: ' + f'{total:.3f}',
+ )
+
+ # Also missing 'updating_db'.
+
+ def cmd_stats(self, conn):
+ """Sends some statistics about the library."""
+ with self.lib.transaction() as tx:
+ statement = 'SELECT COUNT(DISTINCT artist), ' \
+ 'COUNT(DISTINCT album), ' \
+ 'COUNT(id), ' \
+ 'SUM(length) ' \
+ 'FROM items'
+ artists, albums, songs, totaltime = tx.query(statement)[0]
+
+ yield (
+ 'artists: ' + str(artists),
+ 'albums: ' + str(albums),
+ 'songs: ' + str(songs),
+ 'uptime: ' + str(int(time.time() - self.startup_time)),
+ 'playtime: ' + '0', # Missing.
+ 'db_playtime: ' + str(int(totaltime)),
+ 'db_update: ' + str(int(self.updated_time)),
+ )
+
+ def cmd_decoders(self, conn):
+ """Send list of supported decoders and formats."""
+ decoders = self.player.get_decoders()
+ for name, (mimes, exts) in decoders.items():
+ yield f'plugin: {name}'
+ for ext in exts:
+ yield f'suffix: {ext}'
+ for mime in mimes:
+ yield f'mime_type: {mime}'
+
+ # Searching.
+
+ tagtype_map = {
+ 'Artist': 'artist',
+ 'ArtistSort': 'artist_sort',
+ 'Album': 'album',
+ 'Title': 'title',
+ 'Track': 'track',
+ 'AlbumArtist': 'albumartist',
+ 'AlbumArtistSort': 'albumartist_sort',
+ 'Label': 'label',
+ 'Genre': 'genre',
+ 'Date': 'year',
+ 'OriginalDate': 'original_year',
+ 'Composer': 'composer',
+ 'Disc': 'disc',
+ 'Comment': 'comments',
+ 'MUSICBRAINZ_TRACKID': 'mb_trackid',
+ 'MUSICBRAINZ_ALBUMID': 'mb_albumid',
+ 'MUSICBRAINZ_ARTISTID': 'mb_artistid',
+ 'MUSICBRAINZ_ALBUMARTISTID': 'mb_albumartistid',
+ 'MUSICBRAINZ_RELEASETRACKID': 'mb_releasetrackid',
+ }
+
+ def cmd_tagtypes(self, conn):
+ """Returns a list of the metadata (tag) fields available for
+ searching.
+ """
+ for tag in self.tagtype_map:
+ yield 'tagtype: ' + tag
+
+ def _tagtype_lookup(self, tag):
+ """Uses `tagtype_map` to look up the beets column name for an
+ MPD tagtype (or throw an appropriate exception). Returns both
+ the canonical name of the MPD tagtype and the beets column
+ name.
+ """
+ for test_tag, key in self.tagtype_map.items():
+ # Match case-insensitively.
+ if test_tag.lower() == tag.lower():
+ return test_tag, key
+ raise BPDError(ERROR_UNKNOWN, 'no such tagtype')
+
+ def _metadata_query(self, query_type, any_query_type, kv):
+ """Helper function returns a query object that will find items
+ according to the library query type provided and the key-value
+ pairs specified. The any_query_type is used for queries of
+ type "any"; if None, then an error is thrown.
+ """
+ if kv: # At least one key-value pair.
+ queries = []
+ # Iterate pairwise over the arguments.
+ it = iter(kv)
+ for tag, value in zip(it, it):
+ if tag.lower() == 'any':
+ if any_query_type:
+ queries.append(any_query_type(value,
+ ITEM_KEYS_WRITABLE,
+ query_type))
+ else:
+ raise BPDError(ERROR_UNKNOWN, 'no such tagtype')
+ else:
+ _, key = self._tagtype_lookup(tag)
+ queries.append(query_type(key, value))
+ return dbcore.query.AndQuery(queries)
+ else: # No key-value pairs.
+ return dbcore.query.TrueQuery()
+
+ def cmd_search(self, conn, *kv):
+ """Perform a substring match for items."""
+ query = self._metadata_query(dbcore.query.SubstringQuery,
+ dbcore.query.AnyFieldQuery,
+ kv)
+ for item in self.lib.items(query):
+ yield self._item_info(item)
+
+ def cmd_find(self, conn, *kv):
+ """Perform an exact match for items."""
+ query = self._metadata_query(dbcore.query.MatchQuery,
+ None,
+ kv)
+ for item in self.lib.items(query):
+ yield self._item_info(item)
+
+ def cmd_list(self, conn, show_tag, *kv):
+ """List distinct metadata values for show_tag, possibly
+ filtered by matching match_tag to match_term.
+ """
+ show_tag_canon, show_key = self._tagtype_lookup(show_tag)
+ if len(kv) == 1:
+ if show_tag_canon == 'Album':
+ # If no tag was given, assume artist. This is because MPD
+ # supports a short version of this command for fetching the
+ # albums belonging to a particular artist, and some clients
+ # rely on this behaviour (e.g. MPDroid, M.A.L.P.).
+ kv = ('Artist', kv[0])
+ else:
+ raise BPDError(ERROR_ARG, 'should be "Album" for 3 arguments')
+ elif len(kv) % 2 != 0:
+ raise BPDError(ERROR_ARG, 'Incorrect number of filter arguments')
+ query = self._metadata_query(dbcore.query.MatchQuery, None, kv)
+
+ clause, subvals = query.clause()
+ statement = 'SELECT DISTINCT ' + show_key + \
+ ' FROM items WHERE ' + clause + \
+ ' ORDER BY ' + show_key
+ self._log.debug(statement)
+ with self.lib.transaction() as tx:
+ rows = tx.query(statement, subvals)
+
+ for row in rows:
+ if not row[0]:
+ # Skip any empty values of the field.
+ continue
+ yield show_tag_canon + ': ' + str(row[0])
+
+ def cmd_count(self, conn, tag, value):
+ """Returns the number and total time of songs matching the
+ tag/value query.
+ """
+ _, key = self._tagtype_lookup(tag)
+ songs = 0
+ playtime = 0.0
+ for item in self.lib.items(dbcore.query.MatchQuery(key, value)):
+ songs += 1
+ playtime += item.length
+ yield 'songs: ' + str(songs)
+ yield 'playtime: ' + str(int(playtime))
+
+ # Persistent playlist manipulation. In MPD this is an optional feature so
+ # these dummy implementations match MPD's behaviour with the feature off.
+
+ def cmd_listplaylist(self, conn, playlist):
+ raise BPDError(ERROR_NO_EXIST, 'No such playlist')
+
+ def cmd_listplaylistinfo(self, conn, playlist):
+ raise BPDError(ERROR_NO_EXIST, 'No such playlist')
+
+ def cmd_listplaylists(self, conn):
+ raise BPDError(ERROR_UNKNOWN, 'Stored playlists are disabled')
+
+ def cmd_load(self, conn, playlist):
+ raise BPDError(ERROR_NO_EXIST, 'Stored playlists are disabled')
+
+ def cmd_playlistadd(self, conn, playlist, uri):
+ raise BPDError(ERROR_UNKNOWN, 'Stored playlists are disabled')
+
+ def cmd_playlistclear(self, conn, playlist):
+ raise BPDError(ERROR_UNKNOWN, 'Stored playlists are disabled')
+
+ def cmd_playlistdelete(self, conn, playlist, index):
+ raise BPDError(ERROR_UNKNOWN, 'Stored playlists are disabled')
+
+ def cmd_playlistmove(self, conn, playlist, from_index, to_index):
+ raise BPDError(ERROR_UNKNOWN, 'Stored playlists are disabled')
+
+ def cmd_rename(self, conn, playlist, new_name):
+ raise BPDError(ERROR_UNKNOWN, 'Stored playlists are disabled')
+
+ def cmd_rm(self, conn, playlist):
+ raise BPDError(ERROR_UNKNOWN, 'Stored playlists are disabled')
+
+ def cmd_save(self, conn, playlist):
+ raise BPDError(ERROR_UNKNOWN, 'Stored playlists are disabled')
+
+ # "Outputs." Just a dummy implementation because we don't control
+ # any outputs.
+
+ def cmd_outputs(self, conn):
+ """List the available outputs."""
+ yield (
+ 'outputid: 0',
+ 'outputname: gstreamer',
+ 'outputenabled: 1',
+ )
+
+ def cmd_enableoutput(self, conn, output_id):
+ output_id = cast_arg(int, output_id)
+ if output_id != 0:
+ raise ArgumentIndexError()
+
+ def cmd_disableoutput(self, conn, output_id):
+ output_id = cast_arg(int, output_id)
+ if output_id == 0:
+ raise BPDError(ERROR_ARG, 'cannot disable this output')
+ else:
+ raise ArgumentIndexError()
+
+ # Playback control. The functions below hook into the
+ # half-implementations provided by the base class. Together, they're
+ # enough to implement all normal playback functionality.
+
+ def cmd_play(self, conn, index=-1):
+ new_index = index != -1 and index != self.current_index
+ was_paused = self.paused
+ super().cmd_play(conn, index)
+
+ if self.current_index > -1: # Not stopped.
+ if was_paused and not new_index:
+ # Just unpause.
+ self.player.play()
+ else:
+ self.player.play_file(self.playlist[self.current_index].path)
+
+ def cmd_pause(self, conn, state=None):
+ super().cmd_pause(conn, state)
+ if self.paused:
+ self.player.pause()
+ elif self.player.playing:
+ self.player.play()
+
+ def cmd_stop(self, conn):
+ super().cmd_stop(conn)
+ self.player.stop()
+
+ def cmd_seek(self, conn, index, pos):
+ """Seeks to the specified position in the specified song."""
+ index = cast_arg(int, index)
+ pos = cast_arg(float, pos)
+ super().cmd_seek(conn, index, pos)
+ self.player.seek(pos)
+
+ # Volume control.
+
+ def cmd_setvol(self, conn, vol):
+ vol = cast_arg(int, vol)
+ super().cmd_setvol(conn, vol)
+ self.player.volume = float(vol) / 100
+
+
+# Beets plugin hooks.
+
+class BPDPlugin(BeetsPlugin):
+ """Provides the "beet bpd" command for running a music player
+ server.
+ """
+ def __init__(self):
+ super().__init__()
+ self.config.add({
+ 'host': '',
+ 'port': 6600,
+ 'control_port': 6601,
+ 'password': '',
+ 'volume': VOLUME_MAX,
+ })
+ self.config['password'].redact = True
+
+ def start_bpd(self, lib, host, port, password, volume, ctrl_port):
+ """Starts a BPD server."""
+ try:
+ server = Server(lib, host, port, password, ctrl_port, self._log)
+ server.cmd_setvol(None, volume)
+ server.run()
+ except NoGstreamerError:
+ self._log.error('Gstreamer Python bindings not found.')
+ self._log.error('Install "gstreamer1.0" and "python-gi"'
+ 'or similar package to use BPD.')
+
+ def commands(self):
+ cmd = beets.ui.Subcommand(
+ 'bpd', help='run an MPD-compatible music player server'
+ )
+
+ def func(lib, opts, args):
+ host = self.config['host'].as_str()
+ host = args.pop(0) if args else host
+ port = args.pop(0) if args else self.config['port'].get(int)
+ if args:
+ ctrl_port = args.pop(0)
+ else:
+ ctrl_port = self.config['control_port'].get(int)
+ if args:
+ raise beets.ui.UserError('too many arguments')
+ password = self.config['password'].as_str()
+ volume = self.config['volume'].get(int)
+ self.start_bpd(lib, host, int(port), password, volume,
+ int(ctrl_port))
+
+ cmd.func = func
+ return [cmd]
diff --git a/lib/beetsplug/bpd/gstplayer.py b/lib/beetsplug/bpd/gstplayer.py
new file mode 100644
index 00000000..64954b1c
--- /dev/null
+++ b/lib/beetsplug/bpd/gstplayer.py
@@ -0,0 +1,304 @@
+# This file is part of beets.
+# Copyright 2016, Adrian Sampson.
+#
+# 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.
+
+"""A wrapper for the GStreamer Python bindings that exposes a simple
+music player.
+"""
+
+
+import sys
+import time
+import _thread
+import os
+import copy
+import urllib
+from beets import ui
+
+import gi
+gi.require_version('Gst', '1.0')
+from gi.repository import GLib, Gst # noqa: E402
+
+
+Gst.init(None)
+
+
+class QueryError(Exception):
+ pass
+
+
+class GstPlayer:
+ """A music player abstracting GStreamer's Playbin element.
+
+ Create a player object, then call run() to start a thread with a
+ runloop. Then call play_file to play music. Use player.playing
+ to check whether music is currently playing.
+
+ A basic play queue is also implemented (just a Python list,
+ player.queue, whose last element is next to play). To use it,
+ just call enqueue() and then play(). When a track finishes and
+ another is available on the queue, it is played automatically.
+ """
+
+ def __init__(self, finished_callback=None):
+ """Initialize a player.
+
+ If a finished_callback is provided, it is called every time a
+ track started with play_file finishes.
+
+ Once the player has been created, call run() to begin the main
+ runloop in a separate thread.
+ """
+
+ # Set up the Gstreamer player. From the pygst tutorial:
+ # https://pygstdocs.berlios.de/pygst-tutorial/playbin.html (gone)
+ # https://brettviren.github.io/pygst-tutorial-org/pygst-tutorial.html
+ ####
+ # Updated to GStreamer 1.0 with:
+ # https://wiki.ubuntu.com/Novacut/GStreamer1.0
+ self.player = Gst.ElementFactory.make("playbin", "player")
+
+ if self.player is None:
+ raise ui.UserError("Could not create playbin")
+
+ fakesink = Gst.ElementFactory.make("fakesink", "fakesink")
+
+ if fakesink is None:
+ raise ui.UserError("Could not create fakesink")
+
+ self.player.set_property("video-sink", fakesink)
+ bus = self.player.get_bus()
+ bus.add_signal_watch()
+ bus.connect("message", self._handle_message)
+
+ # Set up our own stuff.
+ self.playing = False
+ self.finished_callback = finished_callback
+ self.cached_time = None
+ self._volume = 1.0
+
+ def _get_state(self):
+ """Returns the current state flag of the playbin."""
+ # gst's get_state function returns a 3-tuple; we just want the
+ # status flag in position 1.
+ return self.player.get_state(Gst.CLOCK_TIME_NONE)[1]
+
+ def _handle_message(self, bus, message):
+ """Callback for status updates from GStreamer."""
+ if message.type == Gst.MessageType.EOS:
+ # file finished playing
+ self.player.set_state(Gst.State.NULL)
+ self.playing = False
+ self.cached_time = None
+ if self.finished_callback:
+ self.finished_callback()
+
+ elif message.type == Gst.MessageType.ERROR:
+ # error
+ self.player.set_state(Gst.State.NULL)
+ err, debug = message.parse_error()
+ print(f"Error: {err}")
+ self.playing = False
+
+ def _set_volume(self, volume):
+ """Set the volume level to a value in the range [0, 1.5]."""
+ # And the volume for the playbin.
+ self._volume = volume
+ self.player.set_property("volume", volume)
+
+ def _get_volume(self):
+ """Get the volume as a float in the range [0, 1.5]."""
+ return self._volume
+
+ volume = property(_get_volume, _set_volume)
+
+ def play_file(self, path):
+ """Immediately begin playing the audio file at the given
+ path.
+ """
+ self.player.set_state(Gst.State.NULL)
+ if isinstance(path, str):
+ path = path.encode('utf-8')
+ uri = 'file://' + urllib.parse.quote(path)
+ self.player.set_property("uri", uri)
+ self.player.set_state(Gst.State.PLAYING)
+ self.playing = True
+
+ def play(self):
+ """If paused, resume playback."""
+ if self._get_state() == Gst.State.PAUSED:
+ self.player.set_state(Gst.State.PLAYING)
+ self.playing = True
+
+ def pause(self):
+ """Pause playback."""
+ self.player.set_state(Gst.State.PAUSED)
+
+ def stop(self):
+ """Halt playback."""
+ self.player.set_state(Gst.State.NULL)
+ self.playing = False
+ self.cached_time = None
+
+ def run(self):
+ """Start a new thread for the player.
+
+ Call this function before trying to play any music with
+ play_file() or play().
+ """
+
+ # If we don't use the MainLoop, messages are never sent.
+
+ def start():
+ loop = GLib.MainLoop()
+ loop.run()
+
+ _thread.start_new_thread(start, ())
+
+ def time(self):
+ """Returns a tuple containing (position, length) where both
+ values are integers in seconds. If no stream is available,
+ returns (0, 0).
+ """
+ fmt = Gst.Format(Gst.Format.TIME)
+ try:
+ posq = self.player.query_position(fmt)
+ if not posq[0]:
+ raise QueryError("query_position failed")
+ pos = posq[1] / (10 ** 9)
+
+ lengthq = self.player.query_duration(fmt)
+ if not lengthq[0]:
+ raise QueryError("query_duration failed")
+ length = lengthq[1] / (10 ** 9)
+
+ self.cached_time = (pos, length)
+ return (pos, length)
+
+ except QueryError:
+ # Stream not ready. For small gaps of time, for instance
+ # after seeking, the time values are unavailable. For this
+ # reason, we cache recent.
+ if self.playing and self.cached_time:
+ return self.cached_time
+ else:
+ return (0, 0)
+
+ def seek(self, position):
+ """Seeks to position (in seconds)."""
+ cur_pos, cur_len = self.time()
+ if position > cur_len:
+ self.stop()
+ return
+
+ fmt = Gst.Format(Gst.Format.TIME)
+ ns = position * 10 ** 9 # convert to nanoseconds
+ self.player.seek_simple(fmt, Gst.SeekFlags.FLUSH, ns)
+
+ # save new cached time
+ self.cached_time = (position, cur_len)
+
+ def block(self):
+ """Block until playing finishes."""
+ while self.playing:
+ time.sleep(1)
+
+ def get_decoders(self):
+ return get_decoders()
+
+
+def get_decoders():
+ """Get supported audio decoders from GStreamer.
+ Returns a dict mapping decoder element names to the associated media types
+ and file extensions.
+ """
+ # We only care about audio decoder elements.
+ filt = (Gst.ELEMENT_FACTORY_TYPE_DEPAYLOADER |
+ Gst.ELEMENT_FACTORY_TYPE_DEMUXER |
+ Gst.ELEMENT_FACTORY_TYPE_PARSER |
+ Gst.ELEMENT_FACTORY_TYPE_DECODER |
+ Gst.ELEMENT_FACTORY_TYPE_MEDIA_AUDIO)
+
+ decoders = {}
+ mime_types = set()
+ for f in Gst.ElementFactory.list_get_elements(filt, Gst.Rank.NONE):
+ for pad in f.get_static_pad_templates():
+ if pad.direction == Gst.PadDirection.SINK:
+ caps = pad.static_caps.get()
+ mimes = set()
+ for i in range(caps.get_size()):
+ struct = caps.get_structure(i)
+ mime = struct.get_name()
+ if mime == 'unknown/unknown':
+ continue
+ mimes.add(mime)
+ mime_types.add(mime)
+ if mimes:
+ decoders[f.get_name()] = (mimes, set())
+
+ # Check all the TypeFindFactory plugin features form the registry. If they
+ # are associated with an audio media type that we found above, get the list
+ # of corresponding file extensions.
+ mime_extensions = {mime: set() for mime in mime_types}
+ for feat in Gst.Registry.get().get_feature_list(Gst.TypeFindFactory):
+ caps = feat.get_caps()
+ if caps:
+ for i in range(caps.get_size()):
+ struct = caps.get_structure(i)
+ mime = struct.get_name()
+ if mime in mime_types:
+ mime_extensions[mime].update(feat.get_extensions())
+
+ # Fill in the slot we left for file extensions.
+ for name, (mimes, exts) in decoders.items():
+ for mime in mimes:
+ exts.update(mime_extensions[mime])
+
+ return decoders
+
+
+def play_simple(paths):
+ """Play the files in paths in a straightforward way, without
+ using the player's callback function.
+ """
+ p = GstPlayer()
+ p.run()
+ for path in paths:
+ p.play_file(path)
+ p.block()
+
+
+def play_complicated(paths):
+ """Play the files in the path one after the other by using the
+ callback function to advance to the next song.
+ """
+ my_paths = copy.copy(paths)
+
+ def next_song():
+ my_paths.pop(0)
+ p.play_file(my_paths[0])
+
+ p = GstPlayer(next_song)
+ p.run()
+ p.play_file(my_paths[0])
+ while my_paths:
+ time.sleep(1)
+
+
+if __name__ == '__main__':
+ # A very simple command-line player. Just give it names of audio
+ # files on the command line; these are all played in sequence.
+ paths = [os.path.abspath(os.path.expanduser(p))
+ for p in sys.argv[1:]]
+ # play_simple(paths)
+ play_complicated(paths)
diff --git a/lib/beetsplug/bpm.py b/lib/beetsplug/bpm.py
new file mode 100644
index 00000000..5aa2d95a
--- /dev/null
+++ b/lib/beetsplug/bpm.py
@@ -0,0 +1,87 @@
+# This file is part of beets.
+# Copyright 2016, aroquen
+#
+# 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.
+
+"""Determine BPM by pressing a key to the rhythm."""
+
+
+import time
+
+from beets import ui
+from beets.plugins import BeetsPlugin
+
+
+def bpm(max_strokes):
+ """Returns average BPM (possibly of a playing song)
+ listening to Enter keystrokes.
+ """
+ t0 = None
+ dt = []
+ for i in range(max_strokes):
+ # Press enter to the rhythm...
+ s = input()
+ if s == '':
+ t1 = time.time()
+ # Only start measuring at the second stroke
+ if t0:
+ dt.append(t1 - t0)
+ t0 = t1
+ else:
+ break
+
+ # Return average BPM
+ # bpm = (max_strokes-1) / sum(dt) * 60
+ ave = sum([1.0 / dti * 60 for dti in dt]) / len(dt)
+ return ave
+
+
+class BPMPlugin(BeetsPlugin):
+
+ def __init__(self):
+ super().__init__()
+ self.config.add({
+ 'max_strokes': 3,
+ 'overwrite': True,
+ })
+
+ def commands(self):
+ cmd = ui.Subcommand('bpm',
+ help='determine bpm of a song by pressing '
+ 'a key to the rhythm')
+ cmd.func = self.command
+ return [cmd]
+
+ def command(self, lib, opts, args):
+ items = lib.items(ui.decargs(args))
+ write = ui.should_write()
+ self.get_bpm(items, write)
+
+ def get_bpm(self, items, write=False):
+ overwrite = self.config['overwrite'].get(bool)
+ if len(items) > 1:
+ raise ValueError('Can only get bpm of one song at time')
+
+ item = items[0]
+ if item['bpm']:
+ self._log.info('Found bpm {0}', item['bpm'])
+ if not overwrite:
+ return
+
+ self._log.info('Press Enter {0} times to the rhythm or Ctrl-D '
+ 'to exit', self.config['max_strokes'].get(int))
+ new_bpm = bpm(self.config['max_strokes'].get(int))
+ item['bpm'] = int(new_bpm)
+ if write:
+ item.try_write()
+ item.store()
+ self._log.info('Added new bpm {0}', item['bpm'])
diff --git a/lib/beetsplug/bpsync.py b/lib/beetsplug/bpsync.py
new file mode 100644
index 00000000..5b28d6d2
--- /dev/null
+++ b/lib/beetsplug/bpsync.py
@@ -0,0 +1,186 @@
+# This file is part of beets.
+# Copyright 2019, Rahul Ahuja.
+#
+# 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.
+
+"""Update library's tags using Beatport.
+"""
+
+from beets.plugins import BeetsPlugin, apply_item_changes
+from beets import autotag, library, ui, util
+
+from .beatport import BeatportPlugin
+
+
+class BPSyncPlugin(BeetsPlugin):
+ def __init__(self):
+ super().__init__()
+ self.beatport_plugin = BeatportPlugin()
+ self.beatport_plugin.setup()
+
+ def commands(self):
+ cmd = ui.Subcommand('bpsync', help='update metadata from Beatport')
+ cmd.parser.add_option(
+ '-p',
+ '--pretend',
+ action='store_true',
+ help='show all changes but do nothing',
+ )
+ cmd.parser.add_option(
+ '-m',
+ '--move',
+ action='store_true',
+ dest='move',
+ help="move files in the library directory",
+ )
+ cmd.parser.add_option(
+ '-M',
+ '--nomove',
+ action='store_false',
+ dest='move',
+ help="don't move files in library",
+ )
+ cmd.parser.add_option(
+ '-W',
+ '--nowrite',
+ action='store_false',
+ default=None,
+ dest='write',
+ help="don't write updated metadata to files",
+ )
+ cmd.parser.add_format_option()
+ cmd.func = self.func
+ return [cmd]
+
+ def func(self, lib, opts, args):
+ """Command handler for the bpsync function.
+ """
+ move = ui.should_move(opts.move)
+ pretend = opts.pretend
+ write = ui.should_write(opts.write)
+ query = ui.decargs(args)
+
+ self.singletons(lib, query, move, pretend, write)
+ self.albums(lib, query, move, pretend, write)
+
+ def singletons(self, lib, query, move, pretend, write):
+ """Retrieve and apply info from the autotagger for items matched by
+ query.
+ """
+ for item in lib.items(query + ['singleton:true']):
+ if not item.mb_trackid:
+ self._log.info(
+ 'Skipping singleton with no mb_trackid: {}', item
+ )
+ continue
+
+ if not self.is_beatport_track(item):
+ self._log.info(
+ 'Skipping non-{} singleton: {}',
+ self.beatport_plugin.data_source,
+ item,
+ )
+ continue
+
+ # Apply.
+ trackinfo = self.beatport_plugin.track_for_id(item.mb_trackid)
+ with lib.transaction():
+ autotag.apply_item_metadata(item, trackinfo)
+ apply_item_changes(lib, item, move, pretend, write)
+
+ @staticmethod
+ def is_beatport_track(item):
+ return (
+ item.get('data_source') == BeatportPlugin.data_source
+ and item.mb_trackid.isnumeric()
+ )
+
+ def get_album_tracks(self, album):
+ if not album.mb_albumid:
+ self._log.info('Skipping album with no mb_albumid: {}', album)
+ return False
+ if not album.mb_albumid.isnumeric():
+ self._log.info(
+ 'Skipping album with invalid {} ID: {}',
+ self.beatport_plugin.data_source,
+ album,
+ )
+ return False
+ items = list(album.items())
+ if album.get('data_source') == self.beatport_plugin.data_source:
+ return items
+ if not all(self.is_beatport_track(item) for item in items):
+ self._log.info(
+ 'Skipping non-{} release: {}',
+ self.beatport_plugin.data_source,
+ album,
+ )
+ return False
+ return items
+
+ def albums(self, lib, query, move, pretend, write):
+ """Retrieve and apply info from the autotagger for albums matched by
+ query and their items.
+ """
+ # Process matching albums.
+ for album in lib.albums(query):
+ # Do we have a valid Beatport album?
+ items = self.get_album_tracks(album)
+ if not items:
+ continue
+
+ # Get the Beatport album information.
+ albuminfo = self.beatport_plugin.album_for_id(album.mb_albumid)
+ if not albuminfo:
+ self._log.info(
+ 'Release ID {} not found for album {}',
+ album.mb_albumid,
+ album,
+ )
+ continue
+
+ beatport_trackid_to_trackinfo = {
+ track.track_id: track for track in albuminfo.tracks
+ }
+ library_trackid_to_item = {
+ int(item.mb_trackid): item for item in items
+ }
+ item_to_trackinfo = {
+ item: beatport_trackid_to_trackinfo[track_id]
+ for track_id, item in library_trackid_to_item.items()
+ }
+
+ self._log.info('applying changes to {}', album)
+ with lib.transaction():
+ autotag.apply_metadata(albuminfo, item_to_trackinfo)
+ changed = False
+ # Find any changed item to apply Beatport changes to album.
+ any_changed_item = items[0]
+ for item in items:
+ item_changed = ui.show_model_changes(item)
+ changed |= item_changed
+ if item_changed:
+ any_changed_item = item
+ apply_item_changes(lib, item, move, pretend, write)
+
+ if pretend or not changed:
+ continue
+
+ # Update album structure to reflect an item in it.
+ for key in library.Album.item_keys:
+ album[key] = any_changed_item[key]
+ album.store()
+
+ # Move album art (and any inconsistent items).
+ if move and lib.directory in util.ancestry(items[0].path):
+ self._log.debug('moving album {}', album)
+ album.move()
diff --git a/lib/beetsplug/bucket.py b/lib/beetsplug/bucket.py
new file mode 100644
index 00000000..9ed50b45
--- /dev/null
+++ b/lib/beetsplug/bucket.py
@@ -0,0 +1,242 @@
+# This file is part of beets.
+# Copyright 2016, Fabrice Laporte.
+#
+# 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.
+
+"""Provides the %bucket{} function for path formatting.
+"""
+
+
+from datetime import datetime
+import re
+import string
+from itertools import tee
+
+from beets import plugins, ui
+
+
+ASCII_DIGITS = string.digits + string.ascii_lowercase
+
+
+class BucketError(Exception):
+ pass
+
+
+def pairwise(iterable):
+ "s -> (s0,s1), (s1,s2), (s2, s3), ..."
+ a, b = tee(iterable)
+ next(b, None)
+ return zip(a, b)
+
+
+def span_from_str(span_str):
+ """Build a span dict from the span string representation.
+ """
+
+ def normalize_year(d, yearfrom):
+ """Convert string to a 4 digits year
+ """
+ if yearfrom < 100:
+ raise BucketError("%d must be expressed on 4 digits" % yearfrom)
+
+ # if two digits only, pick closest year that ends by these two
+ # digits starting from yearfrom
+ if d < 100:
+ if (d % 100) < (yearfrom % 100):
+ d = (yearfrom - yearfrom % 100) + 100 + d
+ else:
+ d = (yearfrom - yearfrom % 100) + d
+ return d
+
+ years = [int(x) for x in re.findall(r'\d+', span_str)]
+ if not years:
+ raise ui.UserError("invalid range defined for year bucket '%s': no "
+ "year found" % span_str)
+ try:
+ years = [normalize_year(x, years[0]) for x in years]
+ except BucketError as exc:
+ raise ui.UserError("invalid range defined for year bucket '%s': %s" %
+ (span_str, exc))
+
+ res = {'from': years[0], 'str': span_str}
+ if len(years) > 1:
+ res['to'] = years[-1]
+ return res
+
+
+def complete_year_spans(spans):
+ """Set the `to` value of spans if empty and sort them chronologically.
+ """
+ spans.sort(key=lambda x: x['from'])
+ for (x, y) in pairwise(spans):
+ if 'to' not in x:
+ x['to'] = y['from'] - 1
+ if spans and 'to' not in spans[-1]:
+ spans[-1]['to'] = datetime.now().year
+
+
+def extend_year_spans(spans, spanlen, start=1900, end=2014):
+ """Add new spans to given spans list so that every year of [start,end]
+ belongs to a span.
+ """
+ extended_spans = spans[:]
+ for (x, y) in pairwise(spans):
+ # if a gap between two spans, fill the gap with as much spans of
+ # spanlen length as necessary
+ for span_from in range(x['to'] + 1, y['from'], spanlen):
+ extended_spans.append({'from': span_from})
+ # Create spans prior to declared ones
+ for span_from in range(spans[0]['from'] - spanlen, start, -spanlen):
+ extended_spans.append({'from': span_from})
+ # Create spans after the declared ones
+ for span_from in range(spans[-1]['to'] + 1, end, spanlen):
+ extended_spans.append({'from': span_from})
+
+ complete_year_spans(extended_spans)
+ return extended_spans
+
+
+def build_year_spans(year_spans_str):
+ """Build a chronologically ordered list of spans dict from unordered spans
+ stringlist.
+ """
+ spans = []
+ for elem in year_spans_str:
+ spans.append(span_from_str(elem))
+ complete_year_spans(spans)
+ return spans
+
+
+def str2fmt(s):
+ """Deduces formatting syntax from a span string.
+ """
+ regex = re.compile(r"(?P\D*)(?P\d+)(?P\D*)"
+ r"(?P\d*)(?P\D*)")
+ m = re.match(regex, s)
+
+ res = {'fromnchars': len(m.group('fromyear')),
+ 'tonchars': len(m.group('toyear'))}
+ res['fmt'] = "{}%s{}{}{}".format(m.group('bef'),
+ m.group('sep'),
+ '%s' if res['tonchars'] else '',
+ m.group('after'))
+ return res
+
+
+def format_span(fmt, yearfrom, yearto, fromnchars, tonchars):
+ """Return a span string representation.
+ """
+ args = (str(yearfrom)[-fromnchars:])
+ if tonchars:
+ args = (str(yearfrom)[-fromnchars:], str(yearto)[-tonchars:])
+
+ return fmt % args
+
+
+def extract_modes(spans):
+ """Extract the most common spans lengths and representation formats
+ """
+ rangelen = sorted([x['to'] - x['from'] + 1 for x in spans])
+ deflen = sorted(rangelen, key=rangelen.count)[-1]
+ reprs = [str2fmt(x['str']) for x in spans]
+ deffmt = sorted(reprs, key=reprs.count)[-1]
+ return deflen, deffmt
+
+
+def build_alpha_spans(alpha_spans_str, alpha_regexs):
+ """Extract alphanumerics from string and return sorted list of chars
+ [from...to]
+ """
+ spans = []
+
+ for elem in alpha_spans_str:
+ if elem in alpha_regexs:
+ spans.append(re.compile(alpha_regexs[elem]))
+ else:
+ bucket = sorted([x for x in elem.lower() if x.isalnum()])
+ if bucket:
+ begin_index = ASCII_DIGITS.index(bucket[0])
+ end_index = ASCII_DIGITS.index(bucket[-1])
+ else:
+ raise ui.UserError("invalid range defined for alpha bucket "
+ "'%s': no alphanumeric character found" %
+ elem)
+ spans.append(
+ re.compile(
+ "^[" + ASCII_DIGITS[begin_index:end_index + 1] +
+ ASCII_DIGITS[begin_index:end_index + 1].upper() + "]"
+ )
+ )
+ return spans
+
+
+class BucketPlugin(plugins.BeetsPlugin):
+ def __init__(self):
+ super().__init__()
+ self.template_funcs['bucket'] = self._tmpl_bucket
+
+ self.config.add({
+ 'bucket_year': [],
+ 'bucket_alpha': [],
+ 'bucket_alpha_regex': {},
+ 'extrapolate': False
+ })
+ self.setup()
+
+ def setup(self):
+ """Setup plugin from config options
+ """
+ self.year_spans = build_year_spans(self.config['bucket_year'].get())
+ if self.year_spans and self.config['extrapolate']:
+ [self.ys_len_mode,
+ self.ys_repr_mode] = extract_modes(self.year_spans)
+ self.year_spans = extend_year_spans(self.year_spans,
+ self.ys_len_mode)
+
+ self.alpha_spans = build_alpha_spans(
+ self.config['bucket_alpha'].get(),
+ self.config['bucket_alpha_regex'].get()
+ )
+
+ def find_bucket_year(self, year):
+ """Return bucket that matches given year or return the year
+ if no matching bucket.
+ """
+ for ys in self.year_spans:
+ if ys['from'] <= int(year) <= ys['to']:
+ if 'str' in ys:
+ return ys['str']
+ else:
+ return format_span(self.ys_repr_mode['fmt'],
+ ys['from'], ys['to'],
+ self.ys_repr_mode['fromnchars'],
+ self.ys_repr_mode['tonchars'])
+ return year
+
+ def find_bucket_alpha(self, s):
+ """Return alpha-range bucket that matches given string or return the
+ string initial if no matching bucket.
+ """
+ for (i, span) in enumerate(self.alpha_spans):
+ if span.match(s):
+ return self.config['bucket_alpha'].get()[i]
+ return s[0].upper()
+
+ def _tmpl_bucket(self, text, field=None):
+ if not field and len(text) == 4 and text.isdigit():
+ field = 'year'
+
+ if field == 'year':
+ func = self.find_bucket_year
+ else:
+ func = self.find_bucket_alpha
+ return func(text)
diff --git a/lib/beetsplug/chroma.py b/lib/beetsplug/chroma.py
new file mode 100644
index 00000000..353923aa
--- /dev/null
+++ b/lib/beetsplug/chroma.py
@@ -0,0 +1,345 @@
+# This file is part of beets.
+# Copyright 2016, Adrian Sampson.
+#
+# 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.
+
+"""Adds Chromaprint/Acoustid acoustic fingerprinting support to the
+autotagger. Requires the pyacoustid library.
+"""
+
+from beets import plugins
+from beets import ui
+from beets import util
+from beets import config
+from beets.autotag import hooks
+import confuse
+import acoustid
+from collections import defaultdict
+from functools import partial
+import re
+
+API_KEY = '1vOwZtEn'
+SCORE_THRESH = 0.5
+TRACK_ID_WEIGHT = 10.0
+COMMON_REL_THRESH = 0.6 # How many tracks must have an album in common?
+MAX_RECORDINGS = 5
+MAX_RELEASES = 5
+
+# Stores the Acoustid match information for each track. This is
+# populated when an import task begins and then used when searching for
+# candidates. It maps audio file paths to (recording_ids, release_ids)
+# pairs. If a given path is not present in the mapping, then no match
+# was found.
+_matches = {}
+
+# Stores the fingerprint and Acoustid ID for each track. This is stored
+# as metadata for each track for later use but is not relevant for
+# autotagging.
+_fingerprints = {}
+_acoustids = {}
+
+
+def prefix(it, count):
+ """Truncate an iterable to at most `count` items.
+ """
+ for i, v in enumerate(it):
+ if i >= count:
+ break
+ yield v
+
+
+def releases_key(release, countries, original_year):
+ """Used as a key to sort releases by date then preferred country
+ """
+ date = release.get('date')
+ if date and original_year:
+ year = date.get('year', 9999)
+ month = date.get('month', 99)
+ day = date.get('day', 99)
+ else:
+ year = 9999
+ month = 99
+ day = 99
+
+ # Uses index of preferred countries to sort
+ country_key = 99
+ if release.get('country'):
+ for i, country in enumerate(countries):
+ if country.match(release['country']):
+ country_key = i
+ break
+
+ return (year, month, day, country_key)
+
+
+def acoustid_match(log, path):
+ """Gets metadata for a file from Acoustid and populates the
+ _matches, _fingerprints, and _acoustids dictionaries accordingly.
+ """
+ try:
+ duration, fp = acoustid.fingerprint_file(util.syspath(path))
+ except acoustid.FingerprintGenerationError as exc:
+ log.error('fingerprinting of {0} failed: {1}',
+ util.displayable_path(repr(path)), exc)
+ return None
+ fp = fp.decode()
+ _fingerprints[path] = fp
+ try:
+ res = acoustid.lookup(API_KEY, fp, duration,
+ meta='recordings releases')
+ except acoustid.AcoustidError as exc:
+ log.debug('fingerprint matching {0} failed: {1}',
+ util.displayable_path(repr(path)), exc)
+ return None
+ log.debug('chroma: fingerprinted {0}',
+ util.displayable_path(repr(path)))
+
+ # Ensure the response is usable and parse it.
+ if res['status'] != 'ok' or not res.get('results'):
+ log.debug('no match found')
+ return None
+ result = res['results'][0] # Best match.
+ if result['score'] < SCORE_THRESH:
+ log.debug('no results above threshold')
+ return None
+ _acoustids[path] = result['id']
+
+ # Get recording and releases from the result
+ if not result.get('recordings'):
+ log.debug('no recordings found')
+ return None
+ recording_ids = []
+ releases = []
+ for recording in result['recordings']:
+ recording_ids.append(recording['id'])
+ if 'releases' in recording:
+ releases.extend(recording['releases'])
+
+ # The releases list is essentially in random order from the Acoustid lookup
+ # so we optionally sort it using the match.preferred configuration options.
+ # 'original_year' to sort the earliest first and
+ # 'countries' to then sort preferred countries first.
+ country_patterns = config['match']['preferred']['countries'].as_str_seq()
+ countries = [re.compile(pat, re.I) for pat in country_patterns]
+ original_year = config['match']['preferred']['original_year']
+ releases.sort(key=partial(releases_key,
+ countries=countries,
+ original_year=original_year))
+ release_ids = [rel['id'] for rel in releases]
+
+ log.debug('matched recordings {0} on releases {1}',
+ recording_ids, release_ids)
+ _matches[path] = recording_ids, release_ids
+
+
+# Plugin structure and autotagging logic.
+
+
+def _all_releases(items):
+ """Given an iterable of Items, determines (according to Acoustid)
+ which releases the items have in common. Generates release IDs.
+ """
+ # Count the number of "hits" for each release.
+ relcounts = defaultdict(int)
+ for item in items:
+ if item.path not in _matches:
+ continue
+
+ _, release_ids = _matches[item.path]
+ for release_id in release_ids:
+ relcounts[release_id] += 1
+
+ for release_id, count in relcounts.items():
+ if float(count) / len(items) > COMMON_REL_THRESH:
+ yield release_id
+
+
+class AcoustidPlugin(plugins.BeetsPlugin):
+ def __init__(self):
+ super().__init__()
+
+ self.config.add({
+ 'auto': True,
+ })
+ config['acoustid']['apikey'].redact = True
+
+ if self.config['auto']:
+ self.register_listener('import_task_start', self.fingerprint_task)
+ self.register_listener('import_task_apply', apply_acoustid_metadata)
+
+ def fingerprint_task(self, task, session):
+ return fingerprint_task(self._log, task, session)
+
+ def track_distance(self, item, info):
+ dist = hooks.Distance()
+ if item.path not in _matches or not info.track_id:
+ # Match failed or no track ID.
+ return dist
+
+ recording_ids, _ = _matches[item.path]
+ dist.add_expr('track_id', info.track_id not in recording_ids)
+ return dist
+
+ def candidates(self, items, artist, album, va_likely, extra_tags=None):
+ albums = []
+ for relid in prefix(_all_releases(items), MAX_RELEASES):
+ album = hooks.album_for_mbid(relid)
+ if album:
+ albums.append(album)
+
+ self._log.debug('acoustid album candidates: {0}', len(albums))
+ return albums
+
+ def item_candidates(self, item, artist, title):
+ if item.path not in _matches:
+ return []
+
+ recording_ids, _ = _matches[item.path]
+ tracks = []
+ for recording_id in prefix(recording_ids, MAX_RECORDINGS):
+ track = hooks.track_for_mbid(recording_id)
+ if track:
+ tracks.append(track)
+ self._log.debug('acoustid item candidates: {0}', len(tracks))
+ return tracks
+
+ def commands(self):
+ submit_cmd = ui.Subcommand('submit',
+ help='submit Acoustid fingerprints')
+
+ def submit_cmd_func(lib, opts, args):
+ try:
+ apikey = config['acoustid']['apikey'].as_str()
+ except confuse.NotFoundError:
+ raise ui.UserError('no Acoustid user API key provided')
+ submit_items(self._log, apikey, lib.items(ui.decargs(args)))
+ submit_cmd.func = submit_cmd_func
+
+ fingerprint_cmd = ui.Subcommand(
+ 'fingerprint',
+ help='generate fingerprints for items without them'
+ )
+
+ def fingerprint_cmd_func(lib, opts, args):
+ for item in lib.items(ui.decargs(args)):
+ fingerprint_item(self._log, item, write=ui.should_write())
+ fingerprint_cmd.func = fingerprint_cmd_func
+
+ return [submit_cmd, fingerprint_cmd]
+
+
+# Hooks into import process.
+
+
+def fingerprint_task(log, task, session):
+ """Fingerprint each item in the task for later use during the
+ autotagging candidate search.
+ """
+ items = task.items if task.is_album else [task.item]
+ for item in items:
+ acoustid_match(log, item.path)
+
+
+def apply_acoustid_metadata(task, session):
+ """Apply Acoustid metadata (fingerprint and ID) to the task's items.
+ """
+ for item in task.imported_items():
+ if item.path in _fingerprints:
+ item.acoustid_fingerprint = _fingerprints[item.path]
+ if item.path in _acoustids:
+ item.acoustid_id = _acoustids[item.path]
+
+
+# UI commands.
+
+
+def submit_items(log, userkey, items, chunksize=64):
+ """Submit fingerprints for the items to the Acoustid server.
+ """
+ data = [] # The running list of dictionaries to submit.
+
+ def submit_chunk():
+ """Submit the current accumulated fingerprint data."""
+ log.info('submitting {0} fingerprints', len(data))
+ try:
+ acoustid.submit(API_KEY, userkey, data)
+ except acoustid.AcoustidError as exc:
+ log.warning('acoustid submission error: {0}', exc)
+ del data[:]
+
+ for item in items:
+ fp = fingerprint_item(log, item, write=ui.should_write())
+
+ # Construct a submission dictionary for this item.
+ item_data = {
+ 'duration': int(item.length),
+ 'fingerprint': fp,
+ }
+ if item.mb_trackid:
+ item_data['mbid'] = item.mb_trackid
+ log.debug('submitting MBID')
+ else:
+ item_data.update({
+ 'track': item.title,
+ 'artist': item.artist,
+ 'album': item.album,
+ 'albumartist': item.albumartist,
+ 'year': item.year,
+ 'trackno': item.track,
+ 'discno': item.disc,
+ })
+ log.debug('submitting textual metadata')
+ data.append(item_data)
+
+ # If we have enough data, submit a chunk.
+ if len(data) >= chunksize:
+ submit_chunk()
+
+ # Submit remaining data in a final chunk.
+ if data:
+ submit_chunk()
+
+
+def fingerprint_item(log, item, write=False):
+ """Get the fingerprint for an Item. If the item already has a
+ fingerprint, it is not regenerated. If fingerprint generation fails,
+ return None. If the items are associated with a library, they are
+ saved to the database. If `write` is set, then the new fingerprints
+ are also written to files' metadata.
+ """
+ # Get a fingerprint and length for this track.
+ if not item.length:
+ log.info('{0}: no duration available',
+ util.displayable_path(item.path))
+ elif item.acoustid_fingerprint:
+ if write:
+ log.info('{0}: fingerprint exists, skipping',
+ util.displayable_path(item.path))
+ else:
+ log.info('{0}: using existing fingerprint',
+ util.displayable_path(item.path))
+ return item.acoustid_fingerprint
+ else:
+ log.info('{0}: fingerprinting',
+ util.displayable_path(item.path))
+ try:
+ _, fp = acoustid.fingerprint_file(util.syspath(item.path))
+ item.acoustid_fingerprint = fp.decode()
+ if write:
+ log.info('{0}: writing fingerprint',
+ util.displayable_path(item.path))
+ item.try_write()
+ if item._db:
+ item.store()
+ return item.acoustid_fingerprint
+ except acoustid.FingerprintGenerationError as exc:
+ log.info('fingerprint generation failed: {0}', exc)
diff --git a/lib/beetsplug/convert.py b/lib/beetsplug/convert.py
new file mode 100644
index 00000000..6bc07c28
--- /dev/null
+++ b/lib/beetsplug/convert.py
@@ -0,0 +1,534 @@
+# This file is part of beets.
+# Copyright 2016, Jakob Schnitzer.
+#
+# 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.
+
+"""Converts tracks or albums to external directory
+"""
+from beets.util import par_map, decode_commandline_path, arg_encoding
+
+import os
+import threading
+import subprocess
+import tempfile
+import shlex
+from string import Template
+
+from beets import ui, util, plugins, config
+from beets.plugins import BeetsPlugin
+from confuse import ConfigTypeError
+from beets import art
+from beets.util.artresizer import ArtResizer
+from beets.library import parse_query_string
+from beets.library import Item
+
+_fs_lock = threading.Lock()
+_temp_files = [] # Keep track of temporary transcoded files for deletion.
+
+# Some convenient alternate names for formats.
+ALIASES = {
+ 'wma': 'windows media',
+ 'vorbis': 'ogg',
+}
+
+LOSSLESS_FORMATS = ['ape', 'flac', 'alac', 'wav', 'aiff']
+
+
+def replace_ext(path, ext):
+ """Return the path with its extension replaced by `ext`.
+
+ The new extension must not contain a leading dot.
+ """
+ ext_dot = b'.' + ext
+ return os.path.splitext(path)[0] + ext_dot
+
+
+def get_format(fmt=None):
+ """Return the command template and the extension from the config.
+ """
+ if not fmt:
+ fmt = config['convert']['format'].as_str().lower()
+ fmt = ALIASES.get(fmt, fmt)
+
+ try:
+ format_info = config['convert']['formats'][fmt].get(dict)
+ command = format_info['command']
+ extension = format_info.get('extension', fmt)
+ except KeyError:
+ raise ui.UserError(
+ 'convert: format {} needs the "command" field'
+ .format(fmt)
+ )
+ except ConfigTypeError:
+ command = config['convert']['formats'][fmt].get(str)
+ extension = fmt
+
+ # Convenience and backwards-compatibility shortcuts.
+ keys = config['convert'].keys()
+ if 'command' in keys:
+ command = config['convert']['command'].as_str()
+ elif 'opts' in keys:
+ # Undocumented option for backwards compatibility with < 1.3.1.
+ command = 'ffmpeg -i $source -y {} $dest'.format(
+ config['convert']['opts'].as_str()
+ )
+ if 'extension' in keys:
+ extension = config['convert']['extension'].as_str()
+
+ return (command.encode('utf-8'), extension.encode('utf-8'))
+
+
+def should_transcode(item, fmt):
+ """Determine whether the item should be transcoded as part of
+ conversion (i.e., its bitrate is high or it has the wrong format).
+ """
+ no_convert_queries = config['convert']['no_convert'].as_str_seq()
+ if no_convert_queries:
+ for query_string in no_convert_queries:
+ query, _ = parse_query_string(query_string, Item)
+ if query.match(item):
+ return False
+ if config['convert']['never_convert_lossy_files'] and \
+ not (item.format.lower() in LOSSLESS_FORMATS):
+ return False
+ maxbr = config['convert']['max_bitrate'].get(int)
+ return fmt.lower() != item.format.lower() or \
+ item.bitrate >= 1000 * maxbr
+
+
+class ConvertPlugin(BeetsPlugin):
+ def __init__(self):
+ super().__init__()
+ self.config.add({
+ 'dest': None,
+ 'pretend': False,
+ 'link': False,
+ 'hardlink': False,
+ 'threads': util.cpu_count(),
+ 'format': 'mp3',
+ 'id3v23': 'inherit',
+ 'formats': {
+ 'aac': {
+ 'command': 'ffmpeg -i $source -y -vn -acodec aac '
+ '-aq 1 $dest',
+ 'extension': 'm4a',
+ },
+ 'alac': {
+ 'command': 'ffmpeg -i $source -y -vn -acodec alac $dest',
+ 'extension': 'm4a',
+ },
+ 'flac': 'ffmpeg -i $source -y -vn -acodec flac $dest',
+ 'mp3': 'ffmpeg -i $source -y -vn -aq 2 $dest',
+ 'opus':
+ 'ffmpeg -i $source -y -vn -acodec libopus -ab 96k $dest',
+ 'ogg':
+ 'ffmpeg -i $source -y -vn -acodec libvorbis -aq 3 $dest',
+ 'wma':
+ 'ffmpeg -i $source -y -vn -acodec wmav2 -vn $dest',
+ },
+ 'max_bitrate': 500,
+ 'auto': False,
+ 'tmpdir': None,
+ 'quiet': False,
+ 'embed': True,
+ 'paths': {},
+ 'no_convert': '',
+ 'never_convert_lossy_files': False,
+ 'copy_album_art': False,
+ 'album_art_maxwidth': 0,
+ 'delete_originals': False,
+ })
+ self.early_import_stages = [self.auto_convert]
+
+ self.register_listener('import_task_files', self._cleanup)
+
+ def commands(self):
+ cmd = ui.Subcommand('convert', help='convert to external location')
+ cmd.parser.add_option('-p', '--pretend', action='store_true',
+ help='show actions but do nothing')
+ cmd.parser.add_option('-t', '--threads', action='store', type='int',
+ help='change the number of threads, \
+ defaults to maximum available processors')
+ cmd.parser.add_option('-k', '--keep-new', action='store_true',
+ dest='keep_new', help='keep only the converted \
+ and move the old files')
+ cmd.parser.add_option('-d', '--dest', action='store',
+ help='set the destination directory')
+ cmd.parser.add_option('-f', '--format', action='store', dest='format',
+ help='set the target format of the tracks')
+ cmd.parser.add_option('-y', '--yes', action='store_true', dest='yes',
+ help='do not ask for confirmation')
+ cmd.parser.add_option('-l', '--link', action='store_true', dest='link',
+ help='symlink files that do not \
+ need transcoding.')
+ cmd.parser.add_option('-H', '--hardlink', action='store_true',
+ dest='hardlink',
+ help='hardlink files that do not \
+ need transcoding. Overrides --link.')
+ cmd.parser.add_album_option()
+ cmd.func = self.convert_func
+ return [cmd]
+
+ def auto_convert(self, config, task):
+ if self.config['auto']:
+ par_map(lambda item: self.convert_on_import(config.lib, item),
+ task.imported_items())
+
+ # Utilities converted from functions to methods on logging overhaul
+
+ def encode(self, command, source, dest, pretend=False):
+ """Encode `source` to `dest` using command template `command`.
+
+ Raises `subprocess.CalledProcessError` if the command exited with a
+ non-zero status code.
+ """
+ # The paths and arguments must be bytes.
+ assert isinstance(command, bytes)
+ assert isinstance(source, bytes)
+ assert isinstance(dest, bytes)
+
+ quiet = self.config['quiet'].get(bool)
+
+ if not quiet and not pretend:
+ self._log.info('Encoding {0}', util.displayable_path(source))
+
+ command = command.decode(arg_encoding(), 'surrogateescape')
+ source = decode_commandline_path(source)
+ dest = decode_commandline_path(dest)
+
+ # Substitute $source and $dest in the argument list.
+ args = shlex.split(command)
+ encode_cmd = []
+ for i, arg in enumerate(args):
+ args[i] = Template(arg).safe_substitute({
+ 'source': source,
+ 'dest': dest,
+ })
+ encode_cmd.append(args[i].encode(util.arg_encoding()))
+
+ if pretend:
+ self._log.info('{0}', ' '.join(ui.decargs(args)))
+ return
+
+ try:
+ util.command_output(encode_cmd)
+ except subprocess.CalledProcessError as exc:
+ # Something went wrong (probably Ctrl+C), remove temporary files
+ self._log.info('Encoding {0} failed. Cleaning up...',
+ util.displayable_path(source))
+ self._log.debug('Command {0} exited with status {1}: {2}',
+ args,
+ exc.returncode,
+ exc.output)
+ util.remove(dest)
+ util.prune_dirs(os.path.dirname(dest))
+ raise
+ except OSError as exc:
+ raise ui.UserError(
+ "convert: couldn't invoke '{}': {}".format(
+ ' '.join(ui.decargs(args)), exc
+ )
+ )
+
+ if not quiet and not pretend:
+ self._log.info('Finished encoding {0}',
+ util.displayable_path(source))
+
+ def convert_item(self, dest_dir, keep_new, path_formats, fmt,
+ pretend=False, link=False, hardlink=False):
+ """A pipeline thread that converts `Item` objects from a
+ library.
+ """
+ command, ext = get_format(fmt)
+ item, original, converted = None, None, None
+ while True:
+ item = yield (item, original, converted)
+ dest = item.destination(basedir=dest_dir,
+ path_formats=path_formats)
+
+ # When keeping the new file in the library, we first move the
+ # current (pristine) file to the destination. We'll then copy it
+ # back to its old path or transcode it to a new path.
+ if keep_new:
+ original = dest
+ converted = item.path
+ if should_transcode(item, fmt):
+ converted = replace_ext(converted, ext)
+ else:
+ original = item.path
+ if should_transcode(item, fmt):
+ dest = replace_ext(dest, ext)
+ converted = dest
+
+ # Ensure that only one thread tries to create directories at a
+ # time. (The existence check is not atomic with the directory
+ # creation inside this function.)
+ if not pretend:
+ with _fs_lock:
+ util.mkdirall(dest)
+
+ if os.path.exists(util.syspath(dest)):
+ self._log.info('Skipping {0} (target file exists)',
+ util.displayable_path(item.path))
+ continue
+
+ if keep_new:
+ if pretend:
+ self._log.info('mv {0} {1}',
+ util.displayable_path(item.path),
+ util.displayable_path(original))
+ else:
+ self._log.info('Moving to {0}',
+ util.displayable_path(original))
+ util.move(item.path, original)
+
+ if should_transcode(item, fmt):
+ linked = False
+ try:
+ self.encode(command, original, converted, pretend)
+ except subprocess.CalledProcessError:
+ continue
+ else:
+ linked = link or hardlink
+ if pretend:
+ msg = 'ln' if hardlink else ('ln -s' if link else 'cp')
+
+ self._log.info('{2} {0} {1}',
+ util.displayable_path(original),
+ util.displayable_path(converted),
+ msg)
+ else:
+ # No transcoding necessary.
+ msg = 'Hardlinking' if hardlink \
+ else ('Linking' if link else 'Copying')
+
+ self._log.info('{1} {0}',
+ util.displayable_path(item.path),
+ msg)
+
+ if hardlink:
+ util.hardlink(original, converted)
+ elif link:
+ util.link(original, converted)
+ else:
+ util.copy(original, converted)
+
+ if pretend:
+ continue
+
+ id3v23 = self.config['id3v23'].as_choice([True, False, 'inherit'])
+ if id3v23 == 'inherit':
+ id3v23 = None
+
+ # Write tags from the database to the converted file.
+ item.try_write(path=converted, id3v23=id3v23)
+
+ if keep_new:
+ # If we're keeping the transcoded file, read it again (after
+ # writing) to get new bitrate, duration, etc.
+ item.path = converted
+ item.read()
+ item.store() # Store new path and audio data.
+
+ if self.config['embed'] and not linked:
+ album = item._cached_album
+ if album and album.artpath:
+ self._log.debug('embedding album art from {}',
+ util.displayable_path(album.artpath))
+ art.embed_item(self._log, item, album.artpath,
+ itempath=converted, id3v23=id3v23)
+
+ if keep_new:
+ plugins.send('after_convert', item=item,
+ dest=dest, keepnew=True)
+ else:
+ plugins.send('after_convert', item=item,
+ dest=converted, keepnew=False)
+
+ def copy_album_art(self, album, dest_dir, path_formats, pretend=False,
+ link=False, hardlink=False):
+ """Copies or converts the associated cover art of the album. Album must
+ have at least one track.
+ """
+ if not album or not album.artpath:
+ return
+
+ album_item = album.items().get()
+ # Album shouldn't be empty.
+ if not album_item:
+ return
+
+ # Get the destination of the first item (track) of the album, we use
+ # this function to format the path accordingly to path_formats.
+ dest = album_item.destination(basedir=dest_dir,
+ path_formats=path_formats)
+
+ # Remove item from the path.
+ dest = os.path.join(*util.components(dest)[:-1])
+
+ dest = album.art_destination(album.artpath, item_dir=dest)
+ if album.artpath == dest:
+ return
+
+ if not pretend:
+ util.mkdirall(dest)
+
+ if os.path.exists(util.syspath(dest)):
+ self._log.info('Skipping {0} (target file exists)',
+ util.displayable_path(album.artpath))
+ return
+
+ # Decide whether we need to resize the cover-art image.
+ resize = False
+ maxwidth = None
+ if self.config['album_art_maxwidth']:
+ maxwidth = self.config['album_art_maxwidth'].get(int)
+ size = ArtResizer.shared.get_size(album.artpath)
+ self._log.debug('image size: {}', size)
+ if size:
+ resize = size[0] > maxwidth
+ else:
+ self._log.warning('Could not get size of image (please see '
+ 'documentation for dependencies).')
+
+ # Either copy or resize (while copying) the image.
+ if resize:
+ self._log.info('Resizing cover art from {0} to {1}',
+ util.displayable_path(album.artpath),
+ util.displayable_path(dest))
+ if not pretend:
+ ArtResizer.shared.resize(maxwidth, album.artpath, dest)
+ else:
+ if pretend:
+ msg = 'ln' if hardlink else ('ln -s' if link else 'cp')
+
+ self._log.info('{2} {0} {1}',
+ util.displayable_path(album.artpath),
+ util.displayable_path(dest),
+ msg)
+ else:
+ msg = 'Hardlinking' if hardlink \
+ else ('Linking' if link else 'Copying')
+
+ self._log.info('{2} cover art from {0} to {1}',
+ util.displayable_path(album.artpath),
+ util.displayable_path(dest),
+ msg)
+ if hardlink:
+ util.hardlink(album.artpath, dest)
+ elif link:
+ util.link(album.artpath, dest)
+ else:
+ util.copy(album.artpath, dest)
+
+ def convert_func(self, lib, opts, args):
+ dest = opts.dest or self.config['dest'].get()
+ if not dest:
+ raise ui.UserError('no convert destination set')
+ dest = util.bytestring_path(dest)
+
+ threads = opts.threads or self.config['threads'].get(int)
+
+ path_formats = ui.get_path_formats(self.config['paths'] or None)
+
+ fmt = opts.format or self.config['format'].as_str().lower()
+
+ if opts.pretend is not None:
+ pretend = opts.pretend
+ else:
+ pretend = self.config['pretend'].get(bool)
+
+ if opts.hardlink is not None:
+ hardlink = opts.hardlink
+ link = False
+ elif opts.link is not None:
+ hardlink = False
+ link = opts.link
+ else:
+ hardlink = self.config['hardlink'].get(bool)
+ link = self.config['link'].get(bool)
+
+ if opts.album:
+ albums = lib.albums(ui.decargs(args))
+ items = [i for a in albums for i in a.items()]
+ if not pretend:
+ for a in albums:
+ ui.print_(format(a, ''))
+ else:
+ items = list(lib.items(ui.decargs(args)))
+ if not pretend:
+ for i in items:
+ ui.print_(format(i, ''))
+
+ if not items:
+ self._log.error('Empty query result.')
+ return
+ if not (pretend or opts.yes or ui.input_yn("Convert? (Y/n)")):
+ return
+
+ if opts.album and self.config['copy_album_art']:
+ for album in albums:
+ self.copy_album_art(album, dest, path_formats, pretend,
+ link, hardlink)
+
+ convert = [self.convert_item(dest,
+ opts.keep_new,
+ path_formats,
+ fmt,
+ pretend,
+ link,
+ hardlink)
+ for _ in range(threads)]
+ pipe = util.pipeline.Pipeline([iter(items), convert])
+ pipe.run_parallel()
+
+ def convert_on_import(self, lib, item):
+ """Transcode a file automatically after it is imported into the
+ library.
+ """
+ fmt = self.config['format'].as_str().lower()
+ if should_transcode(item, fmt):
+ command, ext = get_format()
+
+ # Create a temporary file for the conversion.
+ tmpdir = self.config['tmpdir'].get()
+ if tmpdir:
+ tmpdir = util.py3_path(util.bytestring_path(tmpdir))
+ fd, dest = tempfile.mkstemp(util.py3_path(b'.' + ext), dir=tmpdir)
+ os.close(fd)
+ dest = util.bytestring_path(dest)
+ _temp_files.append(dest) # Delete the transcode later.
+
+ # Convert.
+ try:
+ self.encode(command, item.path, dest)
+ except subprocess.CalledProcessError:
+ return
+
+ # Change the newly-imported database entry to point to the
+ # converted file.
+ source_path = item.path
+ item.path = dest
+ item.write()
+ item.read() # Load new audio information data.
+ item.store()
+
+ if self.config['delete_originals']:
+ self._log.info('Removing original file {0}', source_path)
+ util.remove(source_path, False)
+
+ def _cleanup(self, task, session):
+ for path in task.old_paths:
+ if path in _temp_files:
+ if os.path.isfile(path):
+ util.remove(path)
+ _temp_files.remove(path)
diff --git a/lib/beetsplug/deezer.py b/lib/beetsplug/deezer.py
new file mode 100644
index 00000000..5f158f93
--- /dev/null
+++ b/lib/beetsplug/deezer.py
@@ -0,0 +1,230 @@
+# This file is part of beets.
+# Copyright 2019, Rahul Ahuja.
+#
+# 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.
+
+"""Adds Deezer release and track search support to the autotagger
+"""
+
+import collections
+
+import unidecode
+import requests
+
+from beets import ui
+from beets.autotag import AlbumInfo, TrackInfo
+from beets.plugins import MetadataSourcePlugin, BeetsPlugin
+
+
+class DeezerPlugin(MetadataSourcePlugin, BeetsPlugin):
+ data_source = 'Deezer'
+
+ # Base URLs for the Deezer API
+ # Documentation: https://developers.deezer.com/api/
+ search_url = 'https://api.deezer.com/search/'
+ album_url = 'https://api.deezer.com/album/'
+ track_url = 'https://api.deezer.com/track/'
+
+ id_regex = {
+ 'pattern': r'(^|deezer\.com/)([a-z]*/)?({}/)?(\d+)',
+ 'match_group': 4,
+ }
+
+ def __init__(self):
+ super().__init__()
+
+ def album_for_id(self, album_id):
+ """Fetch an album by its Deezer ID or URL and return an
+ AlbumInfo object or None if the album is not found.
+
+ :param album_id: Deezer ID or URL for the album.
+ :type album_id: str
+ :return: AlbumInfo object for album.
+ :rtype: beets.autotag.hooks.AlbumInfo or None
+ """
+ deezer_id = self._get_id('album', album_id)
+ if deezer_id is None:
+ return None
+
+ album_data = requests.get(self.album_url + deezer_id).json()
+ artist, artist_id = self.get_artist(album_data['contributors'])
+
+ release_date = album_data['release_date']
+ date_parts = [int(part) for part in release_date.split('-')]
+ num_date_parts = len(date_parts)
+
+ if num_date_parts == 3:
+ year, month, day = date_parts
+ elif num_date_parts == 2:
+ year, month = date_parts
+ day = None
+ elif num_date_parts == 1:
+ year = date_parts[0]
+ month = None
+ day = None
+ else:
+ raise ui.UserError(
+ "Invalid `release_date` returned "
+ "by {} API: '{}'".format(self.data_source, release_date)
+ )
+
+ tracks_data = requests.get(
+ self.album_url + deezer_id + '/tracks'
+ ).json()['data']
+ if not tracks_data:
+ return None
+ tracks = []
+ medium_totals = collections.defaultdict(int)
+ for i, track_data in enumerate(tracks_data, start=1):
+ track = self._get_track(track_data)
+ track.index = i
+ medium_totals[track.medium] += 1
+ tracks.append(track)
+ for track in tracks:
+ track.medium_total = medium_totals[track.medium]
+
+ return AlbumInfo(
+ album=album_data['title'],
+ album_id=deezer_id,
+ artist=artist,
+ artist_credit=self.get_artist([album_data['artist']])[0],
+ artist_id=artist_id,
+ tracks=tracks,
+ albumtype=album_data['record_type'],
+ va=len(album_data['contributors']) == 1
+ and artist.lower() == 'various artists',
+ year=year,
+ month=month,
+ day=day,
+ label=album_data['label'],
+ mediums=max(medium_totals.keys()),
+ data_source=self.data_source,
+ data_url=album_data['link'],
+ )
+
+ def _get_track(self, track_data):
+ """Convert a Deezer track object dict to a TrackInfo object.
+
+ :param track_data: Deezer Track object dict
+ :type track_data: dict
+ :return: TrackInfo object for track
+ :rtype: beets.autotag.hooks.TrackInfo
+ """
+ artist, artist_id = self.get_artist(
+ track_data.get('contributors', [track_data['artist']])
+ )
+ return TrackInfo(
+ title=track_data['title'],
+ track_id=track_data['id'],
+ artist=artist,
+ artist_id=artist_id,
+ length=track_data['duration'],
+ index=track_data['track_position'],
+ medium=track_data['disk_number'],
+ medium_index=track_data['track_position'],
+ data_source=self.data_source,
+ data_url=track_data['link'],
+ )
+
+ def track_for_id(self, track_id=None, track_data=None):
+ """Fetch a track by its Deezer ID or URL and return a
+ TrackInfo object or None if the track is not found.
+
+ :param track_id: (Optional) Deezer ID or URL for the track. Either
+ ``track_id`` or ``track_data`` must be provided.
+ :type track_id: str
+ :param track_data: (Optional) Simplified track object dict. May be
+ provided instead of ``track_id`` to avoid unnecessary API calls.
+ :type track_data: dict
+ :return: TrackInfo object for track
+ :rtype: beets.autotag.hooks.TrackInfo or None
+ """
+ if track_data is None:
+ deezer_id = self._get_id('track', track_id)
+ if deezer_id is None:
+ return None
+ track_data = requests.get(self.track_url + deezer_id).json()
+ track = self._get_track(track_data)
+
+ # Get album's tracks to set `track.index` (position on the entire
+ # release) and `track.medium_total` (total number of tracks on
+ # the track's disc).
+ album_tracks_data = requests.get(
+ self.album_url + str(track_data['album']['id']) + '/tracks'
+ ).json()['data']
+ medium_total = 0
+ for i, track_data in enumerate(album_tracks_data, start=1):
+ if track_data['disk_number'] == track.medium:
+ medium_total += 1
+ if track_data['id'] == track.track_id:
+ track.index = i
+ track.medium_total = medium_total
+ return track
+
+ @staticmethod
+ def _construct_search_query(filters=None, keywords=''):
+ """Construct a query string with the specified filters and keywords to
+ be provided to the Deezer Search API
+ (https://developers.deezer.com/api/search).
+
+ :param filters: (Optional) Field filters to apply.
+ :type filters: dict
+ :param keywords: (Optional) Query keywords to use.
+ :type keywords: str
+ :return: Query string to be provided to the Search API.
+ :rtype: str
+ """
+ query_components = [
+ keywords,
+ ' '.join(f'{k}:"{v}"' for k, v in filters.items()),
+ ]
+ query = ' '.join([q for q in query_components if q])
+ if not isinstance(query, str):
+ query = query.decode('utf8')
+ return unidecode.unidecode(query)
+
+ def _search_api(self, query_type, filters=None, keywords=''):
+ """Query the Deezer Search API for the specified ``keywords``, applying
+ the provided ``filters``.
+
+ :param query_type: The Deezer Search API method to use. Valid types
+ are: 'album', 'artist', 'history', 'playlist', 'podcast',
+ 'radio', 'track', 'user', and 'track'.
+ :type query_type: str
+ :param filters: (Optional) Field filters to apply.
+ :type filters: dict
+ :param keywords: (Optional) Query keywords to use.
+ :type keywords: str
+ :return: JSON data for the class:`Response ` object or None
+ if no search results are returned.
+ :rtype: dict or None
+ """
+ query = self._construct_search_query(
+ keywords=keywords, filters=filters
+ )
+ if not query:
+ return None
+ self._log.debug(
+ f"Searching {self.data_source} for '{query}'"
+ )
+ response = requests.get(
+ self.search_url + query_type, params={'q': query}
+ )
+ response.raise_for_status()
+ response_data = response.json().get('data', [])
+ self._log.debug(
+ "Found {} result(s) from {} for '{}'",
+ len(response_data),
+ self.data_source,
+ query,
+ )
+ return response_data
diff --git a/lib/beetsplug/discogs.py b/lib/beetsplug/discogs.py
new file mode 100644
index 00000000..d015e420
--- /dev/null
+++ b/lib/beetsplug/discogs.py
@@ -0,0 +1,606 @@
+# This file is part of beets.
+# Copyright 2016, Adrian Sampson.
+#
+# 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.
+
+"""Adds Discogs album search support to the autotagger. Requires the
+python3-discogs-client library.
+"""
+
+import beets.ui
+from beets import config
+from beets.autotag.hooks import AlbumInfo, TrackInfo
+from beets.plugins import MetadataSourcePlugin, BeetsPlugin, get_distance
+import confuse
+from discogs_client import Release, Master, Client
+from discogs_client.exceptions import DiscogsAPIError
+from requests.exceptions import ConnectionError
+import http.client
+import beets
+import re
+import time
+import json
+import socket
+import os
+import traceback
+from string import ascii_lowercase
+
+
+USER_AGENT = f'beets/{beets.__version__} +https://beets.io/'
+API_KEY = 'rAzVUQYRaoFjeBjyWuWZ'
+API_SECRET = 'plxtUTqoCzwxZpqdPysCwGuBSmZNdZVy'
+
+# Exceptions that discogs_client should really handle but does not.
+CONNECTION_ERRORS = (ConnectionError, socket.error, http.client.HTTPException,
+ ValueError, # JSON decoding raises a ValueError.
+ DiscogsAPIError)
+
+
+class DiscogsPlugin(BeetsPlugin):
+
+ def __init__(self):
+ super().__init__()
+ self.config.add({
+ 'apikey': API_KEY,
+ 'apisecret': API_SECRET,
+ 'tokenfile': 'discogs_token.json',
+ 'source_weight': 0.5,
+ 'user_token': '',
+ 'separator': ', ',
+ 'index_tracks': False,
+ })
+ self.config['apikey'].redact = True
+ self.config['apisecret'].redact = True
+ self.config['user_token'].redact = True
+ self.discogs_client = None
+ self.register_listener('import_begin', self.setup)
+
+ def setup(self, session=None):
+ """Create the `discogs_client` field. Authenticate if necessary.
+ """
+ c_key = self.config['apikey'].as_str()
+ c_secret = self.config['apisecret'].as_str()
+
+ # Try using a configured user token (bypassing OAuth login).
+ user_token = self.config['user_token'].as_str()
+ if user_token:
+ # The rate limit for authenticated users goes up to 60
+ # requests per minute.
+ self.discogs_client = Client(USER_AGENT, user_token=user_token)
+ return
+
+ # Get the OAuth token from a file or log in.
+ try:
+ with open(self._tokenfile()) as f:
+ tokendata = json.load(f)
+ except OSError:
+ # No token yet. Generate one.
+ token, secret = self.authenticate(c_key, c_secret)
+ else:
+ token = tokendata['token']
+ secret = tokendata['secret']
+
+ self.discogs_client = Client(USER_AGENT, c_key, c_secret,
+ token, secret)
+
+ def reset_auth(self):
+ """Delete token file & redo the auth steps.
+ """
+ os.remove(self._tokenfile())
+ self.setup()
+
+ def _tokenfile(self):
+ """Get the path to the JSON file for storing the OAuth token.
+ """
+ return self.config['tokenfile'].get(confuse.Filename(in_app_dir=True))
+
+ def authenticate(self, c_key, c_secret):
+ # Get the link for the OAuth page.
+ auth_client = Client(USER_AGENT, c_key, c_secret)
+ try:
+ _, _, url = auth_client.get_authorize_url()
+ except CONNECTION_ERRORS as e:
+ self._log.debug('connection error: {0}', e)
+ raise beets.ui.UserError('communication with Discogs failed')
+
+ beets.ui.print_("To authenticate with Discogs, visit:")
+ beets.ui.print_(url)
+
+ # Ask for the code and validate it.
+ code = beets.ui.input_("Enter the code:")
+ try:
+ token, secret = auth_client.get_access_token(code)
+ except DiscogsAPIError:
+ raise beets.ui.UserError('Discogs authorization failed')
+ except CONNECTION_ERRORS as e:
+ self._log.debug('connection error: {0}', e)
+ raise beets.ui.UserError('Discogs token request failed')
+
+ # Save the token for later use.
+ self._log.debug('Discogs token {0}, secret {1}', token, secret)
+ with open(self._tokenfile(), 'w') as f:
+ json.dump({'token': token, 'secret': secret}, f)
+
+ return token, secret
+
+ def album_distance(self, items, album_info, mapping):
+ """Returns the album distance.
+ """
+ return get_distance(
+ data_source='Discogs',
+ info=album_info,
+ config=self.config
+ )
+
+ def track_distance(self, item, track_info):
+ """Returns the track distance.
+ """
+ return get_distance(
+ data_source='Discogs',
+ info=track_info,
+ config=self.config
+ )
+
+ def candidates(self, items, artist, album, va_likely, extra_tags=None):
+ """Returns a list of AlbumInfo objects for discogs search results
+ matching an album and artist (if not various).
+ """
+ if not self.discogs_client:
+ return
+
+ if va_likely:
+ query = album
+ else:
+ query = f'{artist} {album}'
+ try:
+ return self.get_albums(query)
+ except DiscogsAPIError as e:
+ self._log.debug('API Error: {0} (query: {1})', e, query)
+ if e.status_code == 401:
+ self.reset_auth()
+ return self.candidates(items, artist, album, va_likely)
+ else:
+ return []
+ except CONNECTION_ERRORS:
+ self._log.debug('Connection error in album search', exc_info=True)
+ return []
+
+ @staticmethod
+ def extract_release_id_regex(album_id):
+ """Returns the Discogs_id or None."""
+ # Discogs-IDs are simple integers. In order to avoid confusion with
+ # other metadata plugins, we only look for very specific formats of the
+ # input string:
+ # - plain integer, optionally wrapped in brackets and prefixed by an
+ # 'r', as this is how discogs displays the release ID on its webpage.
+ # - legacy url format: discogs.com//release/
+ # - current url format: discogs.com/release/-
+ # See #291, #4080 and #4085 for the discussions leading up to these
+ # patterns.
+ # Regex has been tested here https://regex101.com/r/wyLdB4/2
+
+ for pattern in [
+ r'^\[?r?(?P\d+)\]?$',
+ r'discogs\.com/release/(?P\d+)-',
+ r'discogs\.com/[^/]+/release/(?P\d+)',
+ ]:
+ match = re.search(pattern, album_id)
+ if match:
+ return int(match.group('id'))
+
+ return None
+
+ def album_for_id(self, album_id):
+ """Fetches an album by its Discogs ID and returns an AlbumInfo object
+ or None if the album is not found.
+ """
+ if not self.discogs_client:
+ return
+
+ self._log.debug('Searching for release {0}', album_id)
+
+ discogs_id = self.extract_release_id_regex(album_id)
+
+ if not discogs_id:
+ return None
+
+ result = Release(self.discogs_client, {'id': discogs_id})
+ # Try to obtain title to verify that we indeed have a valid Release
+ try:
+ getattr(result, 'title')
+ except DiscogsAPIError as e:
+ if e.status_code != 404:
+ self._log.debug('API Error: {0} (query: {1})', e,
+ result.data['resource_url'])
+ if e.status_code == 401:
+ self.reset_auth()
+ return self.album_for_id(album_id)
+ return None
+ except CONNECTION_ERRORS:
+ self._log.debug('Connection error in album lookup',
+ exc_info=True)
+ return None
+ return self.get_album_info(result)
+
+ def get_albums(self, query):
+ """Returns a list of AlbumInfo objects for a discogs search query.
+ """
+ # Strip non-word characters from query. Things like "!" and "-" can
+ # cause a query to return no results, even if they match the artist or
+ # album title. Use `re.UNICODE` flag to avoid stripping non-english
+ # word characters.
+ query = re.sub(r'(?u)\W+', ' ', query)
+ # Strip medium information from query, Things like "CD1" and "disk 1"
+ # can also negate an otherwise positive result.
+ query = re.sub(r'(?i)\b(CD|disc)\s*\d+', '', query)
+
+ try:
+ releases = self.discogs_client.search(query,
+ type='release').page(1)
+
+ except CONNECTION_ERRORS:
+ self._log.debug("Communication error while searching for {0!r}",
+ query, exc_info=True)
+ return []
+ return [album for album in map(self.get_album_info, releases[:5])
+ if album]
+
+ def get_master_year(self, master_id):
+ """Fetches a master release given its Discogs ID and returns its year
+ or None if the master release is not found.
+ """
+ self._log.debug('Searching for master release {0}', master_id)
+ result = Master(self.discogs_client, {'id': master_id})
+
+ try:
+ year = result.fetch('year')
+ return year
+ except DiscogsAPIError as e:
+ if e.status_code != 404:
+ self._log.debug('API Error: {0} (query: {1})', e,
+ result.data['resource_url'])
+ if e.status_code == 401:
+ self.reset_auth()
+ return self.get_master_year(master_id)
+ return None
+ except CONNECTION_ERRORS:
+ self._log.debug('Connection error in master release lookup',
+ exc_info=True)
+ return None
+
+ def get_album_info(self, result):
+ """Returns an AlbumInfo object for a discogs Release object.
+ """
+ # Explicitly reload the `Release` fields, as they might not be yet
+ # present if the result is from a `discogs_client.search()`.
+ if not result.data.get('artists'):
+ result.refresh()
+
+ # Sanity check for required fields. The list of required fields is
+ # defined at Guideline 1.3.1.a, but in practice some releases might be
+ # lacking some of these fields. This function expects at least:
+ # `artists` (>0), `title`, `id`, `tracklist` (>0)
+ # https://www.discogs.com/help/doc/submission-guidelines-general-rules
+ if not all([result.data.get(k) for k in ['artists', 'title', 'id',
+ 'tracklist']]):
+ self._log.warning("Release does not contain the required fields")
+ return None
+
+ artist, artist_id = MetadataSourcePlugin.get_artist(
+ [a.data for a in result.artists]
+ )
+ album = re.sub(r' +', ' ', result.title)
+ album_id = result.data['id']
+ # Use `.data` to access the tracklist directly instead of the
+ # convenient `.tracklist` property, which will strip out useful artist
+ # information and leave us with skeleton `Artist` objects that will
+ # each make an API call just to get the same data back.
+ tracks = self.get_tracks(result.data['tracklist'])
+
+ # Extract information for the optional AlbumInfo fields, if possible.
+ va = result.data['artists'][0].get('name', '').lower() == 'various'
+ year = result.data.get('year')
+ mediums = [t.medium for t in tracks]
+ country = result.data.get('country')
+ data_url = result.data.get('uri')
+ style = self.format(result.data.get('styles'))
+ genre = self.format(result.data.get('genres'))
+ discogs_albumid = self.extract_release_id(result.data.get('uri'))
+
+ # Extract information for the optional AlbumInfo fields that are
+ # contained on nested discogs fields.
+ albumtype = media = label = catalogno = labelid = None
+ if result.data.get('formats'):
+ albumtype = ', '.join(
+ result.data['formats'][0].get('descriptions', [])) or None
+ media = result.data['formats'][0]['name']
+ if result.data.get('labels'):
+ label = result.data['labels'][0].get('name')
+ catalogno = result.data['labels'][0].get('catno')
+ labelid = result.data['labels'][0].get('id')
+
+ # Additional cleanups (various artists name, catalog number, media).
+ if va:
+ artist = config['va_name'].as_str()
+ if catalogno == 'none':
+ catalogno = None
+ # Explicitly set the `media` for the tracks, since it is expected by
+ # `autotag.apply_metadata`, and set `medium_total`.
+ for track in tracks:
+ track.media = media
+ track.medium_total = mediums.count(track.medium)
+ # Discogs does not have track IDs. Invent our own IDs as proposed
+ # in #2336.
+ track.track_id = str(album_id) + "-" + track.track_alt
+
+ # Retrieve master release id (returns None if there isn't one).
+ master_id = result.data.get('master_id')
+ # Assume `original_year` is equal to `year` for releases without
+ # a master release, otherwise fetch the master release.
+ original_year = self.get_master_year(master_id) if master_id else year
+
+ return AlbumInfo(album=album, album_id=album_id, artist=artist,
+ artist_id=artist_id, tracks=tracks,
+ albumtype=albumtype, va=va, year=year,
+ label=label, mediums=len(set(mediums)),
+ releasegroup_id=master_id, catalognum=catalogno,
+ country=country, style=style, genre=genre,
+ media=media, original_year=original_year,
+ data_source='Discogs', data_url=data_url,
+ discogs_albumid=discogs_albumid,
+ discogs_labelid=labelid, discogs_artistid=artist_id)
+
+ def format(self, classification):
+ if classification:
+ return self.config['separator'].as_str() \
+ .join(sorted(classification))
+ else:
+ return None
+
+ def extract_release_id(self, uri):
+ if uri:
+ return uri.split("/")[-1]
+ else:
+ return None
+
+ def get_tracks(self, tracklist):
+ """Returns a list of TrackInfo objects for a discogs tracklist.
+ """
+ try:
+ clean_tracklist = self.coalesce_tracks(tracklist)
+ except Exception as exc:
+ # FIXME: this is an extra precaution for making sure there are no
+ # side effects after #2222. It should be removed after further
+ # testing.
+ self._log.debug('{}', traceback.format_exc())
+ self._log.error('uncaught exception in coalesce_tracks: {}', exc)
+ clean_tracklist = tracklist
+ tracks = []
+ index_tracks = {}
+ index = 0
+ # Distinct works and intra-work divisions, as defined by index tracks.
+ divisions, next_divisions = [], []
+ for track in clean_tracklist:
+ # Only real tracks have `position`. Otherwise, it's an index track.
+ if track['position']:
+ index += 1
+ if next_divisions:
+ # End of a block of index tracks: update the current
+ # divisions.
+ divisions += next_divisions
+ del next_divisions[:]
+ track_info = self.get_track_info(track, index, divisions)
+ track_info.track_alt = track['position']
+ tracks.append(track_info)
+ else:
+ next_divisions.append(track['title'])
+ # We expect new levels of division at the beginning of the
+ # tracklist (and possibly elsewhere).
+ try:
+ divisions.pop()
+ except IndexError:
+ pass
+ index_tracks[index + 1] = track['title']
+
+ # Fix up medium and medium_index for each track. Discogs position is
+ # unreliable, but tracks are in order.
+ medium = None
+ medium_count, index_count, side_count = 0, 0, 0
+ sides_per_medium = 1
+
+ # If a medium has two sides (ie. vinyl or cassette), each pair of
+ # consecutive sides should belong to the same medium.
+ if all([track.medium is not None for track in tracks]):
+ m = sorted({track.medium.lower() for track in tracks})
+ # If all track.medium are single consecutive letters, assume it is
+ # a 2-sided medium.
+ if ''.join(m) in ascii_lowercase:
+ sides_per_medium = 2
+
+ for track in tracks:
+ # Handle special case where a different medium does not indicate a
+ # new disc, when there is no medium_index and the ordinal of medium
+ # is not sequential. For example, I, II, III, IV, V. Assume these
+ # are the track index, not the medium.
+ # side_count is the number of mediums or medium sides (in the case
+ # of two-sided mediums) that were seen before.
+ medium_is_index = track.medium and not track.medium_index and (
+ len(track.medium) != 1 or
+ # Not within standard incremental medium values (A, B, C, ...).
+ ord(track.medium) - 64 != side_count + 1
+ )
+
+ if not medium_is_index and medium != track.medium:
+ side_count += 1
+ if sides_per_medium == 2:
+ if side_count % sides_per_medium:
+ # Two-sided medium changed. Reset index_count.
+ index_count = 0
+ medium_count += 1
+ else:
+ # Medium changed. Reset index_count.
+ medium_count += 1
+ index_count = 0
+ medium = track.medium
+
+ index_count += 1
+ medium_count = 1 if medium_count == 0 else medium_count
+ track.medium, track.medium_index = medium_count, index_count
+
+ # Get `disctitle` from Discogs index tracks. Assume that an index track
+ # before the first track of each medium is a disc title.
+ for track in tracks:
+ if track.medium_index == 1:
+ if track.index in index_tracks:
+ disctitle = index_tracks[track.index]
+ else:
+ disctitle = None
+ track.disctitle = disctitle
+
+ return tracks
+
+ def coalesce_tracks(self, raw_tracklist):
+ """Pre-process a tracklist, merging subtracks into a single track. The
+ title for the merged track is the one from the previous index track,
+ if present; otherwise it is a combination of the subtracks titles.
+ """
+ def add_merged_subtracks(tracklist, subtracks):
+ """Modify `tracklist` in place, merging a list of `subtracks` into
+ a single track into `tracklist`."""
+ # Calculate position based on first subtrack, without subindex.
+ idx, medium_idx, sub_idx = \
+ self.get_track_index(subtracks[0]['position'])
+ position = '{}{}'.format(idx or '', medium_idx or '')
+
+ if tracklist and not tracklist[-1]['position']:
+ # Assume the previous index track contains the track title.
+ if sub_idx:
+ # "Convert" the track title to a real track, discarding the
+ # subtracks assuming they are logical divisions of a
+ # physical track (12.2.9 Subtracks).
+ tracklist[-1]['position'] = position
+ else:
+ # Promote the subtracks to real tracks, discarding the
+ # index track, assuming the subtracks are physical tracks.
+ index_track = tracklist.pop()
+ # Fix artists when they are specified on the index track.
+ if index_track.get('artists'):
+ for subtrack in subtracks:
+ if not subtrack.get('artists'):
+ subtrack['artists'] = index_track['artists']
+ # Concatenate index with track title when index_tracks
+ # option is set
+ if self.config['index_tracks']:
+ for subtrack in subtracks:
+ subtrack['title'] = '{}: {}'.format(
+ index_track['title'], subtrack['title'])
+ tracklist.extend(subtracks)
+ else:
+ # Merge the subtracks, pick a title, and append the new track.
+ track = subtracks[0].copy()
+ track['title'] = ' / '.join([t['title'] for t in subtracks])
+ tracklist.append(track)
+
+ # Pre-process the tracklist, trying to identify subtracks.
+ subtracks = []
+ tracklist = []
+ prev_subindex = ''
+ for track in raw_tracklist:
+ # Regular subtrack (track with subindex).
+ if track['position']:
+ _, _, subindex = self.get_track_index(track['position'])
+ if subindex:
+ if subindex.rjust(len(raw_tracklist)) > prev_subindex:
+ # Subtrack still part of the current main track.
+ subtracks.append(track)
+ else:
+ # Subtrack part of a new group (..., 1.3, *2.1*, ...).
+ add_merged_subtracks(tracklist, subtracks)
+ subtracks = [track]
+ prev_subindex = subindex.rjust(len(raw_tracklist))
+ continue
+
+ # Index track with nested sub_tracks.
+ if not track['position'] and 'sub_tracks' in track:
+ # Append the index track, assuming it contains the track title.
+ tracklist.append(track)
+ add_merged_subtracks(tracklist, track['sub_tracks'])
+ continue
+
+ # Regular track or index track without nested sub_tracks.
+ if subtracks:
+ add_merged_subtracks(tracklist, subtracks)
+ subtracks = []
+ prev_subindex = ''
+ tracklist.append(track)
+
+ # Merge and add the remaining subtracks, if any.
+ if subtracks:
+ add_merged_subtracks(tracklist, subtracks)
+
+ return tracklist
+
+ def get_track_info(self, track, index, divisions):
+ """Returns a TrackInfo object for a discogs track.
+ """
+ title = track['title']
+ if self.config['index_tracks']:
+ prefix = ', '.join(divisions)
+ if prefix:
+ title = f'{prefix}: {title}'
+ track_id = None
+ medium, medium_index, _ = self.get_track_index(track['position'])
+ artist, artist_id = MetadataSourcePlugin.get_artist(
+ track.get('artists', [])
+ )
+ length = self.get_track_length(track['duration'])
+ return TrackInfo(title=title, track_id=track_id, artist=artist,
+ artist_id=artist_id, length=length, index=index,
+ medium=medium, medium_index=medium_index)
+
+ def get_track_index(self, position):
+ """Returns the medium, medium index and subtrack index for a discogs
+ track position."""
+ # Match the standard Discogs positions (12.2.9), which can have several
+ # forms (1, 1-1, A1, A1.1, A1a, ...).
+ match = re.match(
+ r'^(.*?)' # medium: everything before medium_index.
+ r'(\d*?)' # medium_index: a number at the end of
+ # `position`, except if followed by a subtrack
+ # index.
+ # subtrack_index: can only be matched if medium
+ # or medium_index have been matched, and can be
+ r'((?<=\w)\.[\w]+' # - a dot followed by a string (A.1, 2.A)
+ r'|(?<=\d)[A-Z]+' # - a string that follows a number (1A, B2a)
+ r')?'
+ r'$',
+ position.upper()
+ )
+
+ if match:
+ medium, index, subindex = match.groups()
+
+ if subindex and subindex.startswith('.'):
+ subindex = subindex[1:]
+ else:
+ self._log.debug('Invalid position: {0}', position)
+ medium = index = subindex = None
+ return medium or None, index or None, subindex or None
+
+ def get_track_length(self, duration):
+ """Returns the track length in seconds for a discogs duration.
+ """
+ try:
+ length = time.strptime(duration, '%M:%S')
+ except ValueError:
+ return None
+ return length.tm_min * 60 + length.tm_sec
diff --git a/lib/beetsplug/duplicates.py b/lib/beetsplug/duplicates.py
new file mode 100644
index 00000000..fdd5c175
--- /dev/null
+++ b/lib/beetsplug/duplicates.py
@@ -0,0 +1,341 @@
+# This file is part of beets.
+# Copyright 2016, Pedro Silva.
+#
+# 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.
+
+"""List duplicate tracks or albums.
+"""
+
+import shlex
+
+from beets.plugins import BeetsPlugin
+from beets.ui import decargs, print_, Subcommand, UserError
+from beets.util import command_output, displayable_path, subprocess, \
+ bytestring_path, MoveOperation, decode_commandline_path
+from beets.library import Item, Album
+
+
+PLUGIN = 'duplicates'
+
+
+class DuplicatesPlugin(BeetsPlugin):
+ """List duplicate tracks or albums
+ """
+ def __init__(self):
+ super().__init__()
+
+ self.config.add({
+ 'album': False,
+ 'checksum': '',
+ 'copy': '',
+ 'count': False,
+ 'delete': False,
+ 'format': '',
+ 'full': False,
+ 'keys': [],
+ 'merge': False,
+ 'move': '',
+ 'path': False,
+ 'tiebreak': {},
+ 'strict': False,
+ 'tag': '',
+ })
+
+ self._command = Subcommand('duplicates',
+ help=__doc__,
+ aliases=['dup'])
+ self._command.parser.add_option(
+ '-c', '--count', dest='count',
+ action='store_true',
+ help='show duplicate counts',
+ )
+ self._command.parser.add_option(
+ '-C', '--checksum', dest='checksum',
+ action='store', metavar='PROG',
+ help='report duplicates based on arbitrary command',
+ )
+ self._command.parser.add_option(
+ '-d', '--delete', dest='delete',
+ action='store_true',
+ help='delete items from library and disk',
+ )
+ self._command.parser.add_option(
+ '-F', '--full', dest='full',
+ action='store_true',
+ help='show all versions of duplicate tracks or albums',
+ )
+ self._command.parser.add_option(
+ '-s', '--strict', dest='strict',
+ action='store_true',
+ help='report duplicates only if all attributes are set',
+ )
+ self._command.parser.add_option(
+ '-k', '--key', dest='keys',
+ action='append', metavar='KEY',
+ help='report duplicates based on keys (use multiple times)',
+ )
+ self._command.parser.add_option(
+ '-M', '--merge', dest='merge',
+ action='store_true',
+ help='merge duplicate items',
+ )
+ self._command.parser.add_option(
+ '-m', '--move', dest='move',
+ action='store', metavar='DEST',
+ help='move items to dest',
+ )
+ self._command.parser.add_option(
+ '-o', '--copy', dest='copy',
+ action='store', metavar='DEST',
+ help='copy items to dest',
+ )
+ self._command.parser.add_option(
+ '-t', '--tag', dest='tag',
+ action='store',
+ help='tag matched items with \'k=v\' attribute',
+ )
+ self._command.parser.add_all_common_options()
+
+ def commands(self):
+
+ def _dup(lib, opts, args):
+ self.config.set_args(opts)
+ album = self.config['album'].get(bool)
+ checksum = self.config['checksum'].get(str)
+ copy = bytestring_path(self.config['copy'].as_str())
+ count = self.config['count'].get(bool)
+ delete = self.config['delete'].get(bool)
+ fmt = self.config['format'].get(str)
+ full = self.config['full'].get(bool)
+ keys = self.config['keys'].as_str_seq()
+ merge = self.config['merge'].get(bool)
+ move = bytestring_path(self.config['move'].as_str())
+ path = self.config['path'].get(bool)
+ tiebreak = self.config['tiebreak'].get(dict)
+ strict = self.config['strict'].get(bool)
+ tag = self.config['tag'].get(str)
+
+ if album:
+ if not keys:
+ keys = ['mb_albumid']
+ items = lib.albums(decargs(args))
+ else:
+ if not keys:
+ keys = ['mb_trackid', 'mb_albumid']
+ items = lib.items(decargs(args))
+
+ # If there's nothing to do, return early. The code below assumes
+ # `items` to be non-empty.
+ if not items:
+ return
+
+ if path:
+ fmt = '$path'
+
+ # Default format string for count mode.
+ if count and not fmt:
+ if album:
+ fmt = '$albumartist - $album'
+ else:
+ fmt = '$albumartist - $album - $title'
+ fmt += ': {0}'
+
+ if checksum:
+ for i in items:
+ k, _ = self._checksum(i, checksum)
+ keys = [k]
+
+ for obj_id, obj_count, objs in self._duplicates(items,
+ keys=keys,
+ full=full,
+ strict=strict,
+ tiebreak=tiebreak,
+ merge=merge):
+ if obj_id: # Skip empty IDs.
+ for o in objs:
+ self._process_item(o,
+ copy=copy,
+ move=move,
+ delete=delete,
+ tag=tag,
+ fmt=fmt.format(obj_count))
+
+ self._command.func = _dup
+ return [self._command]
+
+ def _process_item(self, item, copy=False, move=False, delete=False,
+ tag=False, fmt=''):
+ """Process Item `item`.
+ """
+ print_(format(item, fmt))
+ if copy:
+ item.move(basedir=copy, operation=MoveOperation.COPY)
+ item.store()
+ if move:
+ item.move(basedir=move)
+ item.store()
+ if delete:
+ item.remove(delete=True)
+ if tag:
+ try:
+ k, v = tag.split('=')
+ except Exception:
+ raise UserError(
+ f"{PLUGIN}: can't parse k=v tag: {tag}"
+ )
+ setattr(item, k, v)
+ item.store()
+
+ def _checksum(self, item, prog):
+ """Run external `prog` on file path associated with `item`, cache
+ output as flexattr on a key that is the name of the program, and
+ return the key, checksum tuple.
+ """
+ args = [p.format(file=decode_commandline_path(item.path))
+ for p in shlex.split(prog)]
+ key = args[0]
+ checksum = getattr(item, key, False)
+ if not checksum:
+ self._log.debug('key {0} on item {1} not cached:'
+ 'computing checksum',
+ key, displayable_path(item.path))
+ try:
+ checksum = command_output(args).stdout
+ setattr(item, key, checksum)
+ item.store()
+ self._log.debug('computed checksum for {0} using {1}',
+ item.title, key)
+ except subprocess.CalledProcessError as e:
+ self._log.debug('failed to checksum {0}: {1}',
+ displayable_path(item.path), e)
+ else:
+ self._log.debug('key {0} on item {1} cached:'
+ 'not computing checksum',
+ key, displayable_path(item.path))
+ return key, checksum
+
+ def _group_by(self, objs, keys, strict):
+ """Return a dictionary with keys arbitrary concatenations of attributes
+ and values lists of objects (Albums or Items) with those keys.
+
+ If strict, all attributes must be defined for a duplicate match.
+ """
+ import collections
+ counts = collections.defaultdict(list)
+ for obj in objs:
+ values = [getattr(obj, k, None) for k in keys]
+ values = [v for v in values if v not in (None, '')]
+ if strict and len(values) < len(keys):
+ self._log.debug('some keys {0} on item {1} are null or empty:'
+ ' skipping',
+ keys, displayable_path(obj.path))
+ elif (not strict and not len(values)):
+ self._log.debug('all keys {0} on item {1} are null or empty:'
+ ' skipping',
+ keys, displayable_path(obj.path))
+ else:
+ key = tuple(values)
+ counts[key].append(obj)
+
+ return counts
+
+ def _order(self, objs, tiebreak=None):
+ """Return the objects (Items or Albums) sorted by descending
+ order of priority.
+
+ If provided, the `tiebreak` dict indicates the field to use to
+ prioritize the objects. Otherwise, Items are placed in order of
+ "completeness" (objects with more non-null fields come first)
+ and Albums are ordered by their track count.
+ """
+ kind = 'items' if all(isinstance(o, Item) for o in objs) else 'albums'
+
+ if tiebreak and kind in tiebreak.keys():
+ key = lambda x: tuple(getattr(x, k) for k in tiebreak[kind])
+ else:
+ if kind == 'items':
+ def truthy(v):
+ # Avoid a Unicode warning by avoiding comparison
+ # between a bytes object and the empty Unicode
+ # string ''.
+ return v is not None and \
+ (v != '' if isinstance(v, str) else True)
+ fields = Item.all_keys()
+ key = lambda x: sum(1 for f in fields if truthy(getattr(x, f)))
+ else:
+ key = lambda x: len(x.items())
+
+ return sorted(objs, key=key, reverse=True)
+
+ def _merge_items(self, objs):
+ """Merge Item objs by copying missing fields from items in the tail to
+ the head item.
+
+ Return same number of items, with the head item modified.
+ """
+ fields = Item.all_keys()
+ for f in fields:
+ for o in objs[1:]:
+ if getattr(objs[0], f, None) in (None, ''):
+ value = getattr(o, f, None)
+ if value:
+ self._log.debug('key {0} on item {1} is null '
+ 'or empty: setting from item {2}',
+ f, displayable_path(objs[0].path),
+ displayable_path(o.path))
+ setattr(objs[0], f, value)
+ objs[0].store()
+ break
+ return objs
+
+ def _merge_albums(self, objs):
+ """Merge Album objs by copying missing items from albums in the tail
+ to the head album.
+
+ Return same number of albums, with the head album modified."""
+ ids = [i.mb_trackid for i in objs[0].items()]
+ for o in objs[1:]:
+ for i in o.items():
+ if i.mb_trackid not in ids:
+ missing = Item.from_path(i.path)
+ missing.album_id = objs[0].id
+ missing.add(i._db)
+ self._log.debug('item {0} missing from album {1}:'
+ ' merging from {2} into {3}',
+ missing,
+ objs[0],
+ displayable_path(o.path),
+ displayable_path(missing.destination()))
+ missing.move(operation=MoveOperation.COPY)
+ return objs
+
+ def _merge(self, objs):
+ """Merge duplicate items. See ``_merge_items`` and ``_merge_albums``
+ for the relevant strategies.
+ """
+ kind = Item if all(isinstance(o, Item) for o in objs) else Album
+ if kind is Item:
+ objs = self._merge_items(objs)
+ else:
+ objs = self._merge_albums(objs)
+ return objs
+
+ def _duplicates(self, objs, keys, full, strict, tiebreak, merge):
+ """Generate triples of keys, duplicate counts, and constituent objects.
+ """
+ offset = 0 if full else 1
+ for k, objs in self._group_by(objs, keys, strict).items():
+ if len(objs) > 1:
+ objs = self._order(objs, tiebreak)
+ if merge:
+ objs = self._merge(objs)
+ yield (k, len(objs) - offset, objs[offset:])
diff --git a/lib/beetsplug/edit.py b/lib/beetsplug/edit.py
new file mode 100644
index 00000000..6f03fa4d
--- /dev/null
+++ b/lib/beetsplug/edit.py
@@ -0,0 +1,402 @@
+# This file is part of beets.
+# Copyright 2016
+#
+# 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.
+
+"""Open metadata information in a text editor to let the user edit it.
+"""
+
+from beets import plugins
+from beets import util
+from beets import ui
+from beets.dbcore import types
+from beets.importer import action
+from beets.ui.commands import _do_query, PromptChoice
+import codecs
+import subprocess
+import yaml
+from tempfile import NamedTemporaryFile
+import os
+import shlex
+
+
+# These "safe" types can avoid the format/parse cycle that most fields go
+# through: they are safe to edit with native YAML types.
+SAFE_TYPES = (types.Float, types.Integer, types.Boolean)
+
+
+class ParseError(Exception):
+ """The modified file is unreadable. The user should be offered a chance to
+ fix the error.
+ """
+
+
+def edit(filename, log):
+ """Open `filename` in a text editor.
+ """
+ cmd = shlex.split(util.editor_command())
+ cmd.append(filename)
+ log.debug('invoking editor command: {!r}', cmd)
+ try:
+ subprocess.call(cmd)
+ except OSError as exc:
+ raise ui.UserError('could not run editor command {!r}: {}'.format(
+ cmd[0], exc
+ ))
+
+
+def dump(arg):
+ """Dump a sequence of dictionaries as YAML for editing.
+ """
+ return yaml.safe_dump_all(
+ arg,
+ allow_unicode=True,
+ default_flow_style=False,
+ )
+
+
+def load(s):
+ """Read a sequence of YAML documents back to a list of dictionaries
+ with string keys.
+
+ Can raise a `ParseError`.
+ """
+ try:
+ out = []
+ for d in yaml.safe_load_all(s):
+ if not isinstance(d, dict):
+ raise ParseError(
+ 'each entry must be a dictionary; found {}'.format(
+ type(d).__name__
+ )
+ )
+
+ # Convert all keys to strings. They started out as strings,
+ # but the user may have inadvertently messed this up.
+ out.append({str(k): v for k, v in d.items()})
+
+ except yaml.YAMLError as e:
+ raise ParseError(f'invalid YAML: {e}')
+ return out
+
+
+def _safe_value(obj, key, value):
+ """Check whether the `value` is safe to represent in YAML and trust as
+ returned from parsed YAML.
+
+ This ensures that values do not change their type when the user edits their
+ YAML representation.
+ """
+ typ = obj._type(key)
+ return isinstance(typ, SAFE_TYPES) and isinstance(value, typ.model_type)
+
+
+def flatten(obj, fields):
+ """Represent `obj`, a `dbcore.Model` object, as a dictionary for
+ serialization. Only include the given `fields` if provided;
+ otherwise, include everything.
+
+ The resulting dictionary's keys are strings and the values are
+ safely YAML-serializable types.
+ """
+ # Format each value.
+ d = {}
+ for key in obj.keys():
+ value = obj[key]
+ if _safe_value(obj, key, value):
+ # A safe value that is faithfully representable in YAML.
+ d[key] = value
+ else:
+ # A value that should be edited as a string.
+ d[key] = obj.formatted()[key]
+
+ # Possibly filter field names.
+ if fields:
+ return {k: v for k, v in d.items() if k in fields}
+ else:
+ return d
+
+
+def apply_(obj, data):
+ """Set the fields of a `dbcore.Model` object according to a
+ dictionary.
+
+ This is the opposite of `flatten`. The `data` dictionary should have
+ strings as values.
+ """
+ for key, value in data.items():
+ if _safe_value(obj, key, value):
+ # A safe value *stayed* represented as a safe type. Assign it
+ # directly.
+ obj[key] = value
+ else:
+ # Either the field was stringified originally or the user changed
+ # it from a safe type to an unsafe one. Parse it as a string.
+ obj.set_parse(key, str(value))
+
+
+class EditPlugin(plugins.BeetsPlugin):
+
+ def __init__(self):
+ super().__init__()
+
+ self.config.add({
+ # The default fields to edit.
+ 'albumfields': 'album albumartist',
+ 'itemfields': 'track title artist album',
+
+ # Silently ignore any changes to these fields.
+ 'ignore_fields': 'id path',
+ })
+
+ self.register_listener('before_choose_candidate',
+ self.before_choose_candidate_listener)
+
+ def commands(self):
+ edit_command = ui.Subcommand(
+ 'edit',
+ help='interactively edit metadata'
+ )
+ edit_command.parser.add_option(
+ '-f', '--field',
+ metavar='FIELD',
+ action='append',
+ help='edit this field also',
+ )
+ edit_command.parser.add_option(
+ '--all',
+ action='store_true', dest='all',
+ help='edit all fields',
+ )
+ edit_command.parser.add_album_option()
+ edit_command.func = self._edit_command
+ return [edit_command]
+
+ def _edit_command(self, lib, opts, args):
+ """The CLI command function for the `beet edit` command.
+ """
+ # Get the objects to edit.
+ query = ui.decargs(args)
+ items, albums = _do_query(lib, query, opts.album, False)
+ objs = albums if opts.album else items
+ if not objs:
+ ui.print_('Nothing to edit.')
+ return
+
+ # Get the fields to edit.
+ if opts.all:
+ fields = None
+ else:
+ fields = self._get_fields(opts.album, opts.field)
+ self.edit(opts.album, objs, fields)
+
+ def _get_fields(self, album, extra):
+ """Get the set of fields to edit.
+ """
+ # Start with the configured base fields.
+ if album:
+ fields = self.config['albumfields'].as_str_seq()
+ else:
+ fields = self.config['itemfields'].as_str_seq()
+
+ # Add the requested extra fields.
+ if extra:
+ fields += extra
+
+ # Ensure we always have the `id` field for identification.
+ fields.append('id')
+
+ return set(fields)
+
+ def edit(self, album, objs, fields):
+ """The core editor function.
+
+ - `album`: A flag indicating whether we're editing Items or Albums.
+ - `objs`: The `Item`s or `Album`s to edit.
+ - `fields`: The set of field names to edit (or None to edit
+ everything).
+ """
+ # Present the YAML to the user and let her change it.
+ success = self.edit_objects(objs, fields)
+
+ # Save the new data.
+ if success:
+ self.save_changes(objs)
+
+ def edit_objects(self, objs, fields):
+ """Dump a set of Model objects to a file as text, ask the user
+ to edit it, and apply any changes to the objects.
+
+ Return a boolean indicating whether the edit succeeded.
+ """
+ # Get the content to edit as raw data structures.
+ old_data = [flatten(o, fields) for o in objs]
+
+ # Set up a temporary file with the initial data for editing.
+ new = NamedTemporaryFile(mode='w', suffix='.yaml', delete=False,
+ encoding='utf-8')
+ old_str = dump(old_data)
+ new.write(old_str)
+ new.close()
+
+ # Loop until we have parseable data and the user confirms.
+ try:
+ while True:
+ # Ask the user to edit the data.
+ edit(new.name, self._log)
+
+ # Read the data back after editing and check whether anything
+ # changed.
+ with codecs.open(new.name, encoding='utf-8') as f:
+ new_str = f.read()
+ if new_str == old_str:
+ ui.print_("No changes; aborting.")
+ return False
+
+ # Parse the updated data.
+ try:
+ new_data = load(new_str)
+ except ParseError as e:
+ ui.print_(f"Could not read data: {e}")
+ if ui.input_yn("Edit again to fix? (Y/n)", True):
+ continue
+ else:
+ return False
+
+ # Show the changes.
+ # If the objects are not on the DB yet, we need a copy of their
+ # original state for show_model_changes.
+ objs_old = [obj.copy() if obj.id < 0 else None
+ for obj in objs]
+ self.apply_data(objs, old_data, new_data)
+ changed = False
+ for obj, obj_old in zip(objs, objs_old):
+ changed |= ui.show_model_changes(obj, obj_old)
+ if not changed:
+ ui.print_('No changes to apply.')
+ return False
+
+ # Confirm the changes.
+ choice = ui.input_options(
+ ('continue Editing', 'apply', 'cancel')
+ )
+ if choice == 'a': # Apply.
+ return True
+ elif choice == 'c': # Cancel.
+ return False
+ elif choice == 'e': # Keep editing.
+ # Reset the temporary changes to the objects. I we have a
+ # copy from above, use that, else reload from the database.
+ objs = [(old_obj or obj)
+ for old_obj, obj in zip(objs_old, objs)]
+ for obj in objs:
+ if not obj.id < 0:
+ obj.load()
+ continue
+
+ # Remove the temporary file before returning.
+ finally:
+ os.remove(new.name)
+
+ def apply_data(self, objs, old_data, new_data):
+ """Take potentially-updated data and apply it to a set of Model
+ objects.
+
+ The objects are not written back to the database, so the changes
+ are temporary.
+ """
+ if len(old_data) != len(new_data):
+ self._log.warning('number of objects changed from {} to {}',
+ len(old_data), len(new_data))
+
+ obj_by_id = {o.id: o for o in objs}
+ ignore_fields = self.config['ignore_fields'].as_str_seq()
+ for old_dict, new_dict in zip(old_data, new_data):
+ # Prohibit any changes to forbidden fields to avoid
+ # clobbering `id` and such by mistake.
+ forbidden = False
+ for key in ignore_fields:
+ if old_dict.get(key) != new_dict.get(key):
+ self._log.warning('ignoring object whose {} changed', key)
+ forbidden = True
+ break
+ if forbidden:
+ continue
+
+ id_ = int(old_dict['id'])
+ apply_(obj_by_id[id_], new_dict)
+
+ def save_changes(self, objs):
+ """Save a list of updated Model objects to the database.
+ """
+ # Save to the database and possibly write tags.
+ for ob in objs:
+ if ob._dirty:
+ self._log.debug('saving changes to {}', ob)
+ ob.try_sync(ui.should_write(), ui.should_move())
+
+ # Methods for interactive importer execution.
+
+ def before_choose_candidate_listener(self, session, task):
+ """Append an "Edit" choice and an "edit Candidates" choice (if
+ there are candidates) to the interactive importer prompt.
+ """
+ choices = [PromptChoice('d', 'eDit', self.importer_edit)]
+ if task.candidates:
+ choices.append(PromptChoice('c', 'edit Candidates',
+ self.importer_edit_candidate))
+
+ return choices
+
+ def importer_edit(self, session, task):
+ """Callback for invoking the functionality during an interactive
+ import session on the *original* item tags.
+ """
+ # Assign negative temporary ids to Items that are not in the database
+ # yet. By using negative values, no clash with items in the database
+ # can occur.
+ for i, obj in enumerate(task.items, start=1):
+ # The importer may set the id to None when re-importing albums.
+ if not obj._db or obj.id is None:
+ obj.id = -i
+
+ # Present the YAML to the user and let her change it.
+ fields = self._get_fields(album=False, extra=[])
+ success = self.edit_objects(task.items, fields)
+
+ # Remove temporary ids.
+ for obj in task.items:
+ if obj.id < 0:
+ obj.id = None
+
+ # Save the new data.
+ if success:
+ # Return action.RETAG, which makes the importer write the tags
+ # to the files if needed without re-applying metadata.
+ return action.RETAG
+ else:
+ # Edit cancelled / no edits made. Revert changes.
+ for obj in task.items:
+ obj.read()
+
+ def importer_edit_candidate(self, session, task):
+ """Callback for invoking the functionality during an interactive
+ import session on a *candidate*. The candidate's metadata is
+ applied to the original items.
+ """
+ # Prompt the user for a candidate.
+ sel = ui.input_options([], numrange=(1, len(task.candidates)))
+ # Force applying the candidate on the items.
+ task.match = task.candidates[sel - 1]
+ task.apply_metadata()
+
+ return self.importer_edit(session, task)
diff --git a/lib/beetsplug/embedart.py b/lib/beetsplug/embedart.py
index 49ed4792..6db46f8c 100644
--- a/lib/beetsplug/embedart.py
+++ b/lib/beetsplug/embedart.py
@@ -1,5 +1,5 @@
# This file is part of beets.
-# Copyright 2014, Adrian Sampson.
+# Copyright 2016, Adrian Sampson.
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
@@ -13,46 +13,65 @@
# included in all copies or substantial portions of the Software.
"""Allows beets to embed album art into file metadata."""
+
import os.path
-import logging
-import imghdr
-import subprocess
-import platform
-from tempfile import NamedTemporaryFile
from beets.plugins import BeetsPlugin
-from beets import mediafile
from beets import ui
-from beets.ui import decargs
-from beets.util import syspath, normpath, displayable_path
+from beets.ui import print_, decargs
+from beets.util import syspath, normpath, displayable_path, bytestring_path
from beets.util.artresizer import ArtResizer
from beets import config
+from beets import art
-log = logging.getLogger('beets')
+def _confirm(objs, album):
+ """Show the list of affected objects (items or albums) and confirm
+ that the user wants to modify their artwork.
+
+ `album` is a Boolean indicating whether these are albums (as opposed
+ to items).
+ """
+ noun = 'album' if album else 'file'
+ prompt = 'Modify artwork for {} {}{} (Y/n)?'.format(
+ len(objs),
+ noun,
+ 's' if len(objs) > 1 else ''
+ )
+
+ # Show all the items or albums.
+ for obj in objs:
+ print_(format(obj))
+
+ # Confirm with user.
+ return ui.input_yn(prompt)
class EmbedCoverArtPlugin(BeetsPlugin):
"""Allows albumart to be embedded into the actual files.
"""
def __init__(self):
- super(EmbedCoverArtPlugin, self).__init__()
+ super().__init__()
self.config.add({
'maxwidth': 0,
'auto': True,
'compare_threshold': 0,
'ifempty': False,
+ 'remove_art_file': False,
+ 'quality': 0,
})
if self.config['maxwidth'].get(int) and not ArtResizer.shared.local:
self.config['maxwidth'] = 0
- log.warn(u"embedart: ImageMagick or PIL not found; "
- u"'maxwidth' option ignored")
+ self._log.warning("ImageMagick or PIL not found; "
+ "'maxwidth' option ignored")
if self.config['compare_threshold'].get(int) and not \
ArtResizer.shared.can_compare:
self.config['compare_threshold'] = 0
- log.warn(u"embedart: ImageMagick 6.8.7 or higher not installed; "
- u"'compare_threshold' option ignored")
+ self._log.warning("ImageMagick 6.8.7 or higher not installed; "
+ "'compare_threshold' option ignored")
+
+ self.register_listener('art_set', self.process_album)
def commands(self):
# Embed command.
@@ -62,219 +81,121 @@ class EmbedCoverArtPlugin(BeetsPlugin):
embed_cmd.parser.add_option(
'-f', '--file', metavar='PATH', help='the image file to embed'
)
- maxwidth = config['embedart']['maxwidth'].get(int)
- compare_threshold = config['embedart']['compare_threshold'].get(int)
- ifempty = config['embedart']['ifempty'].get(bool)
+ embed_cmd.parser.add_option(
+ "-y", "--yes", action="store_true", help="skip confirmation"
+ )
+ maxwidth = self.config['maxwidth'].get(int)
+ quality = self.config['quality'].get(int)
+ compare_threshold = self.config['compare_threshold'].get(int)
+ ifempty = self.config['ifempty'].get(bool)
def embed_func(lib, opts, args):
if opts.file:
imagepath = normpath(opts.file)
- for item in lib.items(decargs(args)):
- embed_item(item, imagepath, maxwidth, None,
- compare_threshold, ifempty)
+ if not os.path.isfile(syspath(imagepath)):
+ raise ui.UserError('image file {} not found'.format(
+ displayable_path(imagepath)
+ ))
+
+ items = lib.items(decargs(args))
+
+ # Confirm with user.
+ if not opts.yes and not _confirm(items, not opts.file):
+ return
+
+ for item in items:
+ art.embed_item(self._log, item, imagepath, maxwidth,
+ None, compare_threshold, ifempty,
+ quality=quality)
else:
- for album in lib.albums(decargs(args)):
- embed_album(album, maxwidth)
+ albums = lib.albums(decargs(args))
+
+ # Confirm with user.
+ if not opts.yes and not _confirm(albums, not opts.file):
+ return
+
+ for album in albums:
+ art.embed_album(self._log, album, maxwidth,
+ False, compare_threshold, ifempty,
+ quality=quality)
+ self.remove_artfile(album)
embed_cmd.func = embed_func
# Extract command.
- extract_cmd = ui.Subcommand('extractart',
- help='extract an image from file metadata')
- extract_cmd.parser.add_option('-o', dest='outpath',
- help='image output file')
+ extract_cmd = ui.Subcommand(
+ 'extractart',
+ help='extract an image from file metadata',
+ )
+ extract_cmd.parser.add_option(
+ '-o', dest='outpath',
+ help='image output file',
+ )
+ extract_cmd.parser.add_option(
+ '-n', dest='filename',
+ help='image filename to create for all matched albums',
+ )
+ extract_cmd.parser.add_option(
+ '-a', dest='associate', action='store_true',
+ help='associate the extracted images with the album',
+ )
def extract_func(lib, opts, args):
- outpath = normpath(opts.outpath or 'cover')
- item = lib.items(decargs(args)).get()
- extract(outpath, item)
+ if opts.outpath:
+ art.extract_first(self._log, normpath(opts.outpath),
+ lib.items(decargs(args)))
+ else:
+ filename = bytestring_path(opts.filename or
+ config['art_filename'].get())
+ if os.path.dirname(filename) != b'':
+ self._log.error(
+ "Only specify a name rather than a path for -n")
+ return
+ for album in lib.albums(decargs(args)):
+ artpath = normpath(os.path.join(album.path, filename))
+ artpath = art.extract_first(self._log, artpath,
+ album.items())
+ if artpath and opts.associate:
+ album.set_art(artpath)
+ album.store()
extract_cmd.func = extract_func
# Clear command.
- clear_cmd = ui.Subcommand('clearart',
- help='remove images from file metadata')
+ clear_cmd = ui.Subcommand(
+ 'clearart',
+ help='remove images from file metadata',
+ )
+ clear_cmd.parser.add_option(
+ "-y", "--yes", action="store_true", help="skip confirmation"
+ )
def clear_func(lib, opts, args):
- clear(lib, decargs(args))
+ items = lib.items(decargs(args))
+ # Confirm with user.
+ if not opts.yes and not _confirm(items, False):
+ return
+ art.clear(self._log, lib, decargs(args))
clear_cmd.func = clear_func
return [embed_cmd, extract_cmd, clear_cmd]
+ def process_album(self, album):
+ """Automatically embed art after art has been set
+ """
+ if self.config['auto'] and ui.should_write():
+ max_width = self.config['maxwidth'].get(int)
+ art.embed_album(self._log, album, max_width, True,
+ self.config['compare_threshold'].get(int),
+ self.config['ifempty'].get(bool))
+ self.remove_artfile(album)
-@EmbedCoverArtPlugin.listen('album_imported')
-def album_imported(lib, album):
- """Automatically embed art into imported albums.
- """
- if album.artpath and config['embedart']['auto']:
- embed_album(album, config['embedart']['maxwidth'].get(int), True)
-
-
-def embed_item(item, imagepath, maxwidth=None, itempath=None,
- compare_threshold=0, ifempty=False, as_album=False):
- """Embed an image into the item's media file.
- """
- if compare_threshold:
- if not check_art_similarity(item, imagepath, compare_threshold):
- log.warn(u'Image not similar; skipping.')
- return
- if ifempty:
- art = get_art(item)
- if not art:
- pass
- else:
- log.debug(u'embedart: media file contained art already {0}'.format(
- displayable_path(imagepath)
- ))
- return
- if maxwidth and not as_album:
- imagepath = resize_image(imagepath, maxwidth)
-
- try:
- log.debug(u'embedart: embedding {0}'.format(
- displayable_path(imagepath)
- ))
- item['images'] = [_mediafile_image(imagepath, maxwidth)]
- except IOError as exc:
- log.error(u'embedart: could not read image file: {0}'.format(exc))
- else:
- # We don't want to store the image in the database.
- item.try_write(itempath)
- del item['images']
-
-
-def embed_album(album, maxwidth=None, quiet=False):
- """Embed album art into all of the album's items.
- """
- imagepath = album.artpath
- if not imagepath:
- log.info(u'No album art present: {0} - {1}'.
- format(album.albumartist, album.album))
- return
- if not os.path.isfile(syspath(imagepath)):
- log.error(u'Album art not found at {0}'
- .format(displayable_path(imagepath)))
- return
- if maxwidth:
- imagepath = resize_image(imagepath, maxwidth)
-
- log.log(
- logging.DEBUG if quiet else logging.INFO,
- u'Embedding album art into {0.albumartist} - {0.album}.'.format(album),
- )
-
- for item in album.items():
- embed_item(item, imagepath, maxwidth, None,
- config['embedart']['compare_threshold'].get(int),
- config['embedart']['ifempty'].get(bool), as_album=True)
-
-
-def resize_image(imagepath, maxwidth):
- """Returns path to an image resized to maxwidth.
- """
- log.info(u'Resizing album art to {0} pixels wide'
- .format(maxwidth))
- imagepath = ArtResizer.shared.resize(maxwidth, syspath(imagepath))
- return imagepath
-
-
-def check_art_similarity(item, imagepath, compare_threshold):
- """A boolean indicating if an image is similar to embedded item art.
- """
- with NamedTemporaryFile(delete=True) as f:
- art = extract(f.name, item)
-
- if art:
- # Converting images to grayscale tends to minimize the weight
- # of colors in the diff score
- cmd = 'convert {0} {1} -colorspace gray MIFF:- | ' \
- 'compare -metric PHASH - null:'.format(syspath(imagepath),
- syspath(art))
-
- proc = subprocess.Popen(cmd, stdout=subprocess.PIPE,
- stderr=subprocess.PIPE,
- close_fds=platform.system() != 'Windows',
- shell=True)
- stdout, stderr = proc.communicate()
- if proc.returncode:
- if proc.returncode != 1:
- log.warn(u'embedart: IM phashes compare failed for {0}, \
- {1}'.format(displayable_path(imagepath),
- displayable_path(art)))
- return
- phashDiff = float(stderr)
- else:
- phashDiff = float(stdout)
-
- log.info(u'embedart: compare PHASH score is {0}'.format(phashDiff))
- if phashDiff > compare_threshold:
- return False
-
- return True
-
-
-def _mediafile_image(image_path, maxwidth=None):
- """Return a `mediafile.Image` object for the path.
- """
-
- with open(syspath(image_path), 'rb') as f:
- data = f.read()
- return mediafile.Image(data, type=mediafile.ImageType.front)
-
-
-def get_art(item):
- # Extract the art.
- try:
- mf = mediafile.MediaFile(syspath(item.path))
- except mediafile.UnreadableFileError as exc:
- log.error(u'Could not extract art from {0}: {1}'.format(
- displayable_path(item.path), exc
- ))
- return
-
- return mf.art
-
-# 'extractart' command.
-
-
-def extract(outpath, item):
- if not item:
- log.error(u'No item matches query.')
- return
-
- art = get_art(item)
-
- if not art:
- log.error(u'No album art present in {0} - {1}.'
- .format(item.artist, item.title))
- return
-
- # Add an extension to the filename.
- ext = imghdr.what(None, h=art)
- if not ext:
- log.error(u'Unknown image type.')
- return
- outpath += '.' + ext
-
- log.info(u'Extracting album art from: {0.artist} - {0.title} '
- u'to: {1}'.format(item, displayable_path(outpath)))
- with open(syspath(outpath), 'wb') as f:
- f.write(art)
- return outpath
-
-
-# 'clearart' command.
-
-def clear(lib, query):
- log.info(u'Clearing album art from items:')
- for item in lib.items(query):
- log.info(u'{0} - {1}'.format(item.artist, item.title))
- try:
- mf = mediafile.MediaFile(syspath(item.path),
- config['id3v23'].get(bool))
- except mediafile.UnreadableFileError as exc:
- log.error(u'Could not clear art from {0}: {1}'.format(
- displayable_path(item.path), exc
- ))
- continue
- del mf.art
- mf.save()
+ def remove_artfile(self, album):
+ """Possibly delete the album art file for an album (if the
+ appropriate configuration option is enabled).
+ """
+ if self.config['remove_art_file'] and album.artpath:
+ if os.path.isfile(album.artpath):
+ self._log.debug('Removing album art file for {0}', album)
+ os.remove(album.artpath)
+ album.artpath = None
+ album.store()
diff --git a/lib/beetsplug/embyupdate.py b/lib/beetsplug/embyupdate.py
new file mode 100644
index 00000000..c17fabad
--- /dev/null
+++ b/lib/beetsplug/embyupdate.py
@@ -0,0 +1,205 @@
+"""Updates the Emby Library whenever the beets library is changed.
+
+ emby:
+ host: localhost
+ port: 8096
+ username: user
+ apikey: apikey
+ password: password
+"""
+
+import hashlib
+import requests
+
+from urllib.parse import urlencode, urljoin, parse_qs, urlsplit, urlunsplit
+from beets import config
+from beets.plugins import BeetsPlugin
+
+
+def api_url(host, port, endpoint):
+ """Returns a joined url.
+
+ Takes host, port and endpoint and generates a valid emby API url.
+
+ :param host: Hostname of the emby server
+ :param port: Portnumber of the emby server
+ :param endpoint: API endpoint
+ :type host: str
+ :type port: int
+ :type endpoint: str
+ :returns: Full API url
+ :rtype: str
+ """
+ # check if http or https is defined as host and create hostname
+ hostname_list = [host]
+ if host.startswith('http://') or host.startswith('https://'):
+ hostname = ''.join(hostname_list)
+ else:
+ hostname_list.insert(0, 'http://')
+ hostname = ''.join(hostname_list)
+
+ joined = urljoin(
+ '{hostname}:{port}'.format(
+ hostname=hostname,
+ port=port
+ ),
+ endpoint
+ )
+
+ scheme, netloc, path, query_string, fragment = urlsplit(joined)
+ query_params = parse_qs(query_string)
+
+ query_params['format'] = ['json']
+ new_query_string = urlencode(query_params, doseq=True)
+
+ return urlunsplit((scheme, netloc, path, new_query_string, fragment))
+
+
+def password_data(username, password):
+ """Returns a dict with username and its encoded password.
+
+ :param username: Emby username
+ :param password: Emby password
+ :type username: str
+ :type password: str
+ :returns: Dictionary with username and encoded password
+ :rtype: dict
+ """
+ return {
+ 'username': username,
+ 'password': hashlib.sha1(password.encode('utf-8')).hexdigest(),
+ 'passwordMd5': hashlib.md5(password.encode('utf-8')).hexdigest()
+ }
+
+
+def create_headers(user_id, token=None):
+ """Return header dict that is needed to talk to the Emby API.
+
+ :param user_id: Emby user ID
+ :param token: Authentication token for Emby
+ :type user_id: str
+ :type token: str
+ :returns: Headers for requests
+ :rtype: dict
+ """
+ headers = {}
+
+ authorization = (
+ 'MediaBrowser UserId="{user_id}", '
+ 'Client="other", '
+ 'Device="beets", '
+ 'DeviceId="beets", '
+ 'Version="0.0.0"'
+ ).format(user_id=user_id)
+
+ headers['x-emby-authorization'] = authorization
+
+ if token:
+ headers['x-mediabrowser-token'] = token
+
+ return headers
+
+
+def get_token(host, port, headers, auth_data):
+ """Return token for a user.
+
+ :param host: Emby host
+ :param port: Emby port
+ :param headers: Headers for requests
+ :param auth_data: Username and encoded password for authentication
+ :type host: str
+ :type port: int
+ :type headers: dict
+ :type auth_data: dict
+ :returns: Access Token
+ :rtype: str
+ """
+ url = api_url(host, port, '/Users/AuthenticateByName')
+ r = requests.post(url, headers=headers, data=auth_data)
+
+ return r.json().get('AccessToken')
+
+
+def get_user(host, port, username):
+ """Return user dict from server or None if there is no user.
+
+ :param host: Emby host
+ :param port: Emby port
+ :username: Username
+ :type host: str
+ :type port: int
+ :type username: str
+ :returns: Matched Users
+ :rtype: list
+ """
+ url = api_url(host, port, '/Users/Public')
+ r = requests.get(url)
+ user = [i for i in r.json() if i['Name'] == username]
+
+ return user
+
+
+class EmbyUpdate(BeetsPlugin):
+ def __init__(self):
+ super().__init__()
+
+ # Adding defaults.
+ config['emby'].add({
+ 'host': 'http://localhost',
+ 'port': 8096,
+ 'apikey': None,
+ 'password': None,
+ })
+
+ 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 Emby.
+ """
+ self._log.info('Updating Emby library...')
+
+ host = config['emby']['host'].get()
+ port = config['emby']['port'].get()
+ username = config['emby']['username'].get()
+ password = config['emby']['password'].get()
+ token = config['emby']['apikey'].get()
+
+ # Check if at least a apikey or password is given.
+ if not any([password, token]):
+ self._log.warning('Provide at least Emby password or apikey.')
+ return
+
+ # Get user information from the Emby API.
+ user = get_user(host, port, username)
+ if not user:
+ self._log.warning(f'User {username} could not be found.')
+ return
+
+ if not token:
+ # Create Authentication data and headers.
+ auth_data = password_data(username, password)
+ headers = create_headers(user[0]['Id'])
+
+ # Get authentication token.
+ token = get_token(host, port, headers, auth_data)
+ if not token:
+ self._log.warning(
+ 'Could not get token for user {0}', username
+ )
+ return
+
+ # Recreate headers with a token.
+ headers = create_headers(user[0]['Id'], token=token)
+
+ # Trigger the Update.
+ url = api_url(host, port, '/Library/Refresh')
+ r = requests.post(url, headers=headers)
+ if r.status_code != 204:
+ self._log.warning('Update could not be triggered')
+ else:
+ self._log.info('Update triggered.')
diff --git a/lib/beetsplug/export.py b/lib/beetsplug/export.py
new file mode 100644
index 00000000..99f6d706
--- /dev/null
+++ b/lib/beetsplug/export.py
@@ -0,0 +1,227 @@
+# This file is part of beets.
+#
+# 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.
+
+"""Exports data from beets
+"""
+
+
+import sys
+import codecs
+import json
+import csv
+from xml.etree import ElementTree
+
+from datetime import datetime, date
+from beets.plugins import BeetsPlugin
+from beets import ui
+from beets import util
+import mediafile
+from beetsplug.info import library_data, tag_data
+
+
+class ExportEncoder(json.JSONEncoder):
+ """Deals with dates because JSON doesn't have a standard"""
+ def default(self, o):
+ if isinstance(o, (datetime, date)):
+ return o.isoformat()
+ return json.JSONEncoder.default(self, o)
+
+
+class ExportPlugin(BeetsPlugin):
+
+ def __init__(self):
+ super().__init__()
+
+ self.config.add({
+ 'default_format': 'json',
+ 'json': {
+ # JSON module formatting options.
+ 'formatting': {
+ 'ensure_ascii': False,
+ 'indent': 4,
+ 'separators': (',', ': '),
+ 'sort_keys': True
+ }
+ },
+ 'jsonlines': {
+ # JSON Lines formatting options.
+ 'formatting': {
+ 'ensure_ascii': False,
+ 'separators': (',', ': '),
+ 'sort_keys': True
+ }
+ },
+ 'csv': {
+ # CSV module formatting options.
+ 'formatting': {
+ # The delimiter used to seperate columns.
+ 'delimiter': ',',
+ # The dialect to use when formating the file output.
+ 'dialect': 'excel'
+ }
+ },
+ 'xml': {
+ # XML module formatting options.
+ 'formatting': {}
+ }
+ # TODO: Use something like the edit plugin
+ # 'item_fields': []
+ })
+
+ def commands(self):
+ cmd = ui.Subcommand('export', help='export data from beets')
+ cmd.func = self.run
+ cmd.parser.add_option(
+ '-l', '--library', action='store_true',
+ help='show library fields instead of tags',
+ )
+ cmd.parser.add_option(
+ '-a', '--album', action='store_true',
+ help='show album fields instead of tracks (implies "--library")',
+ )
+ cmd.parser.add_option(
+ '--append', action='store_true', default=False,
+ help='if should append data to the file',
+ )
+ cmd.parser.add_option(
+ '-i', '--include-keys', default=[],
+ action='append', dest='included_keys',
+ help='comma separated list of keys to show',
+ )
+ cmd.parser.add_option(
+ '-o', '--output',
+ help='path for the output file. If not given, will print the data'
+ )
+ cmd.parser.add_option(
+ '-f', '--format', default='json',
+ help="the output format: json (default), jsonlines, csv, or xml"
+ )
+ return [cmd]
+
+ def run(self, lib, opts, args):
+ file_path = opts.output
+ file_mode = 'a' if opts.append else 'w'
+ file_format = opts.format or self.config['default_format'].get(str)
+ file_format_is_line_based = (file_format == 'jsonlines')
+ format_options = self.config[file_format]['formatting'].get(dict)
+
+ export_format = ExportFormat.factory(
+ file_type=file_format,
+ **{
+ 'file_path': file_path,
+ 'file_mode': file_mode
+ }
+ )
+
+ if opts.library or opts.album:
+ data_collector = library_data
+ else:
+ data_collector = tag_data
+
+ included_keys = []
+ for keys in opts.included_keys:
+ included_keys.extend(keys.split(','))
+
+ items = []
+ for data_emitter in data_collector(
+ lib, ui.decargs(args),
+ album=opts.album,
+ ):
+ try:
+ data, item = data_emitter(included_keys or '*')
+ except (mediafile.UnreadableFileError, OSError) as ex:
+ self._log.error('cannot read file: {0}', ex)
+ continue
+
+ for key, value in data.items():
+ if isinstance(value, bytes):
+ data[key] = util.displayable_path(value)
+
+ if file_format_is_line_based:
+ export_format.export(data, **format_options)
+ else:
+ items += [data]
+
+ if not file_format_is_line_based:
+ export_format.export(items, **format_options)
+
+
+class ExportFormat:
+ """The output format type"""
+ def __init__(self, file_path, file_mode='w', encoding='utf-8'):
+ self.path = file_path
+ self.mode = file_mode
+ self.encoding = encoding
+ # creates a file object to write/append or sets to stdout
+ self.out_stream = codecs.open(self.path, self.mode, self.encoding) \
+ if self.path else sys.stdout
+
+ @classmethod
+ def factory(cls, file_type, **kwargs):
+ if file_type in ["json", "jsonlines"]:
+ return JsonFormat(**kwargs)
+ elif file_type == "csv":
+ return CSVFormat(**kwargs)
+ elif file_type == "xml":
+ return XMLFormat(**kwargs)
+ else:
+ raise NotImplementedError()
+
+ def export(self, data, **kwargs):
+ raise NotImplementedError()
+
+
+class JsonFormat(ExportFormat):
+ """Saves in a json file"""
+ def __init__(self, file_path, file_mode='w', encoding='utf-8'):
+ super().__init__(file_path, file_mode, encoding)
+
+ def export(self, data, **kwargs):
+ json.dump(data, self.out_stream, cls=ExportEncoder, **kwargs)
+ self.out_stream.write('\n')
+
+
+class CSVFormat(ExportFormat):
+ """Saves in a csv file"""
+ def __init__(self, file_path, file_mode='w', encoding='utf-8'):
+ super().__init__(file_path, file_mode, encoding)
+
+ def export(self, data, **kwargs):
+ header = list(data[0].keys()) if data else []
+ writer = csv.DictWriter(self.out_stream, fieldnames=header, **kwargs)
+ writer.writeheader()
+ writer.writerows(data)
+
+
+class XMLFormat(ExportFormat):
+ """Saves in a xml file"""
+ def __init__(self, file_path, file_mode='w', encoding='utf-8'):
+ super().__init__(file_path, file_mode, encoding)
+
+ def export(self, data, **kwargs):
+ # Creates the XML file structure.
+ library = ElementTree.Element('library')
+ tracks = ElementTree.SubElement(library, 'tracks')
+ if data and isinstance(data[0], dict):
+ for index, item in enumerate(data):
+ track = ElementTree.SubElement(tracks, 'track')
+ for key, value in item.items():
+ track_details = ElementTree.SubElement(track, key)
+ track_details.text = value
+ # Depending on the version of python the encoding needs to change
+ try:
+ data = ElementTree.tostring(library, encoding='unicode', **kwargs)
+ except LookupError:
+ data = ElementTree.tostring(library, encoding='utf-8', **kwargs)
+
+ self.out_stream.write(data)
diff --git a/lib/beetsplug/fetchart.py b/lib/beetsplug/fetchart.py
index b2a4620b..f2c1e5a7 100644
--- a/lib/beetsplug/fetchart.py
+++ b/lib/beetsplug/fetchart.py
@@ -1,5 +1,5 @@
# This file is part of beets.
-# Copyright 2014, Adrian Sampson.
+# Copyright 2016, Adrian Sampson.
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
@@ -14,11 +14,12 @@
"""Fetches album art.
"""
+
from contextlib import closing
-import logging
import os
import re
from tempfile import NamedTemporaryFile
+from collections import OrderedDict
import requests
@@ -27,370 +28,1122 @@ from beets import importer
from beets import ui
from beets import util
from beets import config
+from mediafile import image_mime_type
from beets.util.artresizer import ArtResizer
+from beets.util import sorted_walk
+from beets.util import syspath, bytestring_path, py3_path
+import confuse
-try:
- import itunes
- HAVE_ITUNES = True
-except ImportError:
- HAVE_ITUNES = False
-
-IMAGE_EXTENSIONS = ['png', 'jpg', 'jpeg']
-CONTENT_TYPES = ('image/jpeg',)
-DOWNLOAD_EXTENSION = '.jpg'
-
-log = logging.getLogger('beets')
-
-requests_session = requests.Session()
-requests_session.headers = {'User-Agent': 'beets'}
+CONTENT_TYPES = {
+ 'image/jpeg': [b'jpg', b'jpeg'],
+ 'image/png': [b'png']
+}
+IMAGE_EXTENSIONS = [ext for exts in CONTENT_TYPES.values() for ext in exts]
-def _fetch_image(url):
- """Downloads an image from a URL and checks whether it seems to
- actually be an image. If so, returns a path to the downloaded image.
- Otherwise, returns None.
+class Candidate:
+ """Holds information about a matching artwork, deals with validation of
+ dimension restrictions and resizing.
"""
- log.debug(u'fetchart: downloading art: {0}'.format(url))
- try:
- with closing(requests_session.get(url, stream=True)) as resp:
- if 'Content-Type' not in resp.headers \
- or resp.headers['Content-Type'] not in CONTENT_TYPES:
- log.debug(u'fetchart: not an image')
- return
+ CANDIDATE_BAD = 0
+ CANDIDATE_EXACT = 1
+ CANDIDATE_DOWNSCALE = 2
+ CANDIDATE_DOWNSIZE = 3
+ CANDIDATE_DEINTERLACE = 4
+ CANDIDATE_REFORMAT = 5
- # Generate a temporary file with the correct extension.
- with NamedTemporaryFile(suffix=DOWNLOAD_EXTENSION, delete=False) \
- as fh:
- for chunk in resp.iter_content():
- fh.write(chunk)
- log.debug(u'fetchart: downloaded art to: {0}'.format(
- util.displayable_path(fh.name)
- ))
- return fh.name
- except (IOError, requests.RequestException):
- log.debug(u'fetchart: error fetching art')
+ MATCH_EXACT = 0
+ MATCH_FALLBACK = 1
+
+ def __init__(self, log, path=None, url=None, source='',
+ match=None, size=None):
+ self._log = log
+ self.path = path
+ self.url = url
+ self.source = source
+ self.check = None
+ self.match = match
+ self.size = size
+
+ def _validate(self, plugin):
+ """Determine whether the candidate artwork is valid based on
+ its dimensions (width and ratio).
+
+ Return `CANDIDATE_BAD` if the file is unusable.
+ Return `CANDIDATE_EXACT` if the file is usable as-is.
+ Return `CANDIDATE_DOWNSCALE` if the file must be rescaled.
+ Return `CANDIDATE_DOWNSIZE` if the file must be resized, and possibly
+ also rescaled.
+ Return `CANDIDATE_DEINTERLACE` if the file must be deinterlaced.
+ Return `CANDIDATE_REFORMAT` if the file has to be converted.
+ """
+ if not self.path:
+ return self.CANDIDATE_BAD
+
+ if (not (plugin.enforce_ratio or plugin.minwidth or plugin.maxwidth
+ or plugin.max_filesize or plugin.deinterlace
+ or plugin.cover_format)):
+ return self.CANDIDATE_EXACT
+
+ # get_size returns None if no local imaging backend is available
+ if not self.size:
+ self.size = ArtResizer.shared.get_size(self.path)
+ self._log.debug('image size: {}', self.size)
+
+ if not self.size:
+ self._log.warning('Could not get size of image (please see '
+ 'documentation for dependencies). '
+ 'The configuration options `minwidth`, '
+ '`enforce_ratio` and `max_filesize` '
+ 'may be violated.')
+ return self.CANDIDATE_EXACT
+
+ short_edge = min(self.size)
+ long_edge = max(self.size)
+
+ # Check minimum dimension.
+ if plugin.minwidth and self.size[0] < plugin.minwidth:
+ self._log.debug('image too small ({} < {})',
+ self.size[0], plugin.minwidth)
+ return self.CANDIDATE_BAD
+
+ # Check aspect ratio.
+ edge_diff = long_edge - short_edge
+ if plugin.enforce_ratio:
+ if plugin.margin_px:
+ if edge_diff > plugin.margin_px:
+ self._log.debug('image is not close enough to being '
+ 'square, ({} - {} > {})',
+ long_edge, short_edge, plugin.margin_px)
+ return self.CANDIDATE_BAD
+ elif plugin.margin_percent:
+ margin_px = plugin.margin_percent * long_edge
+ if edge_diff > margin_px:
+ self._log.debug('image is not close enough to being '
+ 'square, ({} - {} > {})',
+ long_edge, short_edge, margin_px)
+ return self.CANDIDATE_BAD
+ elif edge_diff:
+ # also reached for margin_px == 0 and margin_percent == 0.0
+ self._log.debug('image is not square ({} != {})',
+ self.size[0], self.size[1])
+ return self.CANDIDATE_BAD
+
+ # Check maximum dimension.
+ downscale = False
+ if plugin.maxwidth and self.size[0] > plugin.maxwidth:
+ self._log.debug('image needs rescaling ({} > {})',
+ self.size[0], plugin.maxwidth)
+ downscale = True
+
+ # Check filesize.
+ downsize = False
+ if plugin.max_filesize:
+ filesize = os.stat(syspath(self.path)).st_size
+ if filesize > plugin.max_filesize:
+ self._log.debug('image needs resizing ({}B > {}B)',
+ filesize, plugin.max_filesize)
+ downsize = True
+
+ # Check image format
+ reformat = False
+ if plugin.cover_format:
+ fmt = ArtResizer.shared.get_format(self.path)
+ reformat = fmt != plugin.cover_format
+ if reformat:
+ self._log.debug('image needs reformatting: {} -> {}',
+ fmt, plugin.cover_format)
+
+ if downscale:
+ return self.CANDIDATE_DOWNSCALE
+ elif downsize:
+ return self.CANDIDATE_DOWNSIZE
+ elif plugin.deinterlace:
+ return self.CANDIDATE_DEINTERLACE
+ elif reformat:
+ return self.CANDIDATE_REFORMAT
+ else:
+ return self.CANDIDATE_EXACT
+
+ def validate(self, plugin):
+ self.check = self._validate(plugin)
+ return self.check
+
+ def resize(self, plugin):
+ if self.check == self.CANDIDATE_DOWNSCALE:
+ self.path = \
+ ArtResizer.shared.resize(plugin.maxwidth, self.path,
+ quality=plugin.quality,
+ max_filesize=plugin.max_filesize)
+ elif self.check == self.CANDIDATE_DOWNSIZE:
+ # dimensions are correct, so maxwidth is set to maximum dimension
+ self.path = \
+ ArtResizer.shared.resize(max(self.size), self.path,
+ quality=plugin.quality,
+ max_filesize=plugin.max_filesize)
+ elif self.check == self.CANDIDATE_DEINTERLACE:
+ self.path = ArtResizer.shared.deinterlace(self.path)
+ elif self.check == self.CANDIDATE_REFORMAT:
+ self.path = ArtResizer.shared.reformat(
+ self.path,
+ plugin.cover_format,
+ deinterlaced=plugin.deinterlace,
+ )
+
+
+def _logged_get(log, *args, **kwargs):
+ """Like `requests.get`, but logs the effective URL to the specified
+ `log` at the `DEBUG` level.
+
+ Use the optional `message` parameter to specify what to log before
+ the URL. By default, the string is "getting URL".
+
+ Also sets the User-Agent header to indicate beets.
+ """
+ # Use some arguments with the `send` call but most with the
+ # `Request` construction. This is a cheap, magic-filled way to
+ # emulate `requests.get` or, more pertinently,
+ # `requests.Session.request`.
+ req_kwargs = kwargs
+ send_kwargs = {}
+ for arg in ('stream', 'verify', 'proxies', 'cert', 'timeout'):
+ if arg in kwargs:
+ send_kwargs[arg] = req_kwargs.pop(arg)
+
+ # Our special logging message parameter.
+ if 'message' in kwargs:
+ message = kwargs.pop('message')
+ else:
+ message = 'getting URL'
+
+ req = requests.Request('GET', *args, **req_kwargs)
+
+ with requests.Session() as s:
+ s.headers = {'User-Agent': 'beets'}
+ prepped = s.prepare_request(req)
+ settings = s.merge_environment_settings(
+ prepped.url, {}, None, None, None
+ )
+ send_kwargs.update(settings)
+ log.debug('{}: {}', message, prepped.url)
+ return s.send(prepped, **send_kwargs)
+
+
+class RequestMixin:
+ """Adds a Requests wrapper to the class that uses the logger, which
+ must be named `self._log`.
+ """
+
+ def request(self, *args, **kwargs):
+ """Like `requests.get`, but uses the logger `self._log`.
+
+ See also `_logged_get`.
+ """
+ return _logged_get(self._log, *args, **kwargs)
# ART SOURCES ################################################################
-# Cover Art Archive.
+class ArtSource(RequestMixin):
+ VALID_MATCHING_CRITERIA = ['default']
-CAA_URL = 'http://coverartarchive.org/release/{mbid}/front-500.jpg'
-CAA_GROUP_URL = 'http://coverartarchive.org/release-group/{mbid}/front-500.jpg'
+ def __init__(self, log, config, match_by=None):
+ self._log = log
+ self._config = config
+ self.match_by = match_by or self.VALID_MATCHING_CRITERIA
+
+ def get(self, album, plugin, paths):
+ raise NotImplementedError()
+
+ def _candidate(self, **kwargs):
+ return Candidate(source=self, log=self._log, **kwargs)
+
+ def fetch_image(self, candidate, plugin):
+ raise NotImplementedError()
+
+ def cleanup(self, candidate):
+ pass
-def caa_art(album):
- """Return the Cover Art Archive and Cover Art Archive release group URLs
- using album MusicBrainz release ID and release group ID.
- """
- if album.mb_albumid:
- yield CAA_URL.format(mbid=album.mb_albumid)
- if album.mb_releasegroupid:
- yield CAA_GROUP_URL.format(mbid=album.mb_releasegroupid)
+class LocalArtSource(ArtSource):
+ IS_LOCAL = True
+ LOC_STR = 'local'
+
+ def fetch_image(self, candidate, plugin):
+ pass
-# Art from Amazon.
+class RemoteArtSource(ArtSource):
+ IS_LOCAL = False
+ LOC_STR = 'remote'
-AMAZON_URL = 'http://images.amazon.com/images/P/%s.%02i.LZZZZZZZ.jpg'
-AMAZON_INDICES = (1, 2)
-
-
-def art_for_asin(album):
- """Generate URLs using Amazon ID (ASIN) string.
- """
- if album.asin:
- for index in AMAZON_INDICES:
- yield AMAZON_URL % (album.asin, index)
-
-
-# AlbumArt.org scraper.
-
-AAO_URL = 'http://www.albumart.org/index_detail.php'
-AAO_PAT = r'href\s*=\s*"([^>"]*)"[^>]*title\s*=\s*"View larger image"'
-
-
-def aao_art(album):
- """Return art URL from AlbumArt.org using album ASIN.
- """
- if not album.asin:
- return
- # Get the page from albumart.org.
- try:
- resp = requests_session.get(AAO_URL, params={'asin': album.asin})
- log.debug(u'fetchart: scraped art URL: {0}'.format(resp.url))
- except requests.RequestException:
- log.debug(u'fetchart: error scraping art page')
- return
-
- # Search the page for the image URL.
- m = re.search(AAO_PAT, resp.text)
- if m:
- image_url = m.group(1)
- yield image_url
- else:
- log.debug(u'fetchart: no image found on page')
-
-
-# Google Images scraper.
-
-GOOGLE_URL = 'https://ajax.googleapis.com/ajax/services/search/images'
-
-
-def google_art(album):
- """Return art URL from google.org given an album title and
- interpreter.
- """
- if not (album.albumartist and album.album):
- return
- search_string = (album.albumartist + ',' + album.album).encode('utf-8')
- response = requests_session.get(GOOGLE_URL, params={
- 'v': '1.0',
- 'q': search_string,
- 'start': '0',
- })
-
- # Get results using JSON.
- try:
- results = response.json()
- data = results['responseData']
- dataInfo = data['results']
- for myUrl in dataInfo:
- yield myUrl['unescapedUrl']
- except:
- log.debug(u'fetchart: error scraping art page')
- return
-
-
-# Art from the iTunes Store.
-
-def itunes_art(album):
- """Return art URL from iTunes Store given an album title.
- """
- search_string = (album.albumartist + ' ' + album.album).encode('utf-8')
- try:
- # Isolate bugs in the iTunes library while searching.
+ def fetch_image(self, candidate, plugin):
+ """Downloads an image from a URL and checks whether it seems to
+ actually be an image. If so, returns a path to the downloaded image.
+ Otherwise, returns None.
+ """
+ if plugin.maxwidth:
+ candidate.url = ArtResizer.shared.proxy_url(plugin.maxwidth,
+ candidate.url)
try:
- itunes_album = itunes.search_album(search_string)[0]
- except Exception as exc:
- log.debug('fetchart: iTunes search failed: {0}'.format(exc))
+ with closing(self.request(candidate.url, stream=True,
+ message='downloading image')) as resp:
+ ct = resp.headers.get('Content-Type', None)
+
+ # Download the image to a temporary file. As some servers
+ # (notably fanart.tv) have proven to return wrong Content-Types
+ # when images were uploaded with a bad file extension, do not
+ # rely on it. Instead validate the type using the file magic
+ # and only then determine the extension.
+ data = resp.iter_content(chunk_size=1024)
+ header = b''
+ for chunk in data:
+ header += chunk
+ if len(header) >= 32:
+ # The imghdr module will only read 32 bytes, and our
+ # own additions in mediafile even less.
+ break
+ else:
+ # server didn't return enough data, i.e. corrupt image
+ return
+
+ real_ct = image_mime_type(header)
+ if real_ct is None:
+ # detection by file magic failed, fall back to the
+ # server-supplied Content-Type
+ # Is our type detection failsafe enough to drop this?
+ real_ct = ct
+
+ if real_ct not in CONTENT_TYPES:
+ self._log.debug('not a supported image: {}',
+ real_ct or 'unknown content type')
+ return
+
+ ext = b'.' + CONTENT_TYPES[real_ct][0]
+
+ if real_ct != ct:
+ self._log.warning('Server specified {}, but returned a '
+ '{} image. Correcting the extension '
+ 'to {}',
+ ct, real_ct, ext)
+
+ suffix = py3_path(ext)
+ with NamedTemporaryFile(suffix=suffix, delete=False) as fh:
+ # write the first already loaded part of the image
+ fh.write(header)
+ # download the remaining part of the image
+ for chunk in data:
+ fh.write(chunk)
+ self._log.debug('downloaded art to: {0}',
+ util.displayable_path(fh.name))
+ candidate.path = util.bytestring_path(fh.name)
+ return
+
+ except (OSError, requests.RequestException, TypeError) as exc:
+ # Handling TypeError works around a urllib3 bug:
+ # https://github.com/shazow/urllib3/issues/556
+ self._log.debug('error fetching art: {}', exc)
return
- if itunes_album.get_artwork()['100']:
- small_url = itunes_album.get_artwork()['100']
- big_url = small_url.replace('100x100', '1200x1200')
- yield big_url
+ def cleanup(self, candidate):
+ if candidate.path:
+ try:
+ util.remove(path=candidate.path)
+ except util.FilesystemError as exc:
+ self._log.debug('error cleaning up tmp art: {}', exc)
+
+
+class CoverArtArchive(RemoteArtSource):
+ NAME = "Cover Art Archive"
+ VALID_MATCHING_CRITERIA = ['release', 'releasegroup']
+ VALID_THUMBNAIL_SIZES = [250, 500, 1200]
+
+ URL = 'https://coverartarchive.org/release/{mbid}'
+ GROUP_URL = 'https://coverartarchive.org/release-group/{mbid}'
+
+ def get(self, album, plugin, paths):
+ """Return the Cover Art Archive and Cover Art Archive release group URLs
+ using album MusicBrainz release ID and release group ID.
+ """
+
+ def get_image_urls(url, size_suffix=None):
+ try:
+ response = self.request(url)
+ except requests.RequestException:
+ self._log.debug('{}: error receiving response'
+ .format(self.NAME))
+ return
+
+ try:
+ data = response.json()
+ except ValueError:
+ self._log.debug('{}: error loading response: {}'
+ .format(self.NAME, response.text))
+ return
+
+ for item in data.get('images', []):
+ try:
+ if 'Front' not in item['types']:
+ continue
+
+ if size_suffix:
+ yield item['thumbnails'][size_suffix]
+ else:
+ yield item['image']
+ except KeyError:
+ pass
+
+ release_url = self.URL.format(mbid=album.mb_albumid)
+ release_group_url = self.GROUP_URL.format(mbid=album.mb_releasegroupid)
+
+ # Cover Art Archive API offers pre-resized thumbnails at several sizes.
+ # If the maxwidth config matches one of the already available sizes
+ # fetch it directly intead of fetching the full sized image and
+ # resizing it.
+ size_suffix = None
+ if plugin.maxwidth in self.VALID_THUMBNAIL_SIZES:
+ size_suffix = "-" + str(plugin.maxwidth)
+
+ if 'release' in self.match_by and album.mb_albumid:
+ for url in get_image_urls(release_url, size_suffix):
+ yield self._candidate(url=url, match=Candidate.MATCH_EXACT)
+
+ if 'releasegroup' in self.match_by and album.mb_releasegroupid:
+ for url in get_image_urls(release_group_url):
+ yield self._candidate(url=url, match=Candidate.MATCH_FALLBACK)
+
+
+class Amazon(RemoteArtSource):
+ NAME = "Amazon"
+ URL = 'https://images.amazon.com/images/P/%s.%02i.LZZZZZZZ.jpg'
+ INDICES = (1, 2)
+
+ def get(self, album, plugin, paths):
+ """Generate URLs using Amazon ID (ASIN) string.
+ """
+ if album.asin:
+ for index in self.INDICES:
+ yield self._candidate(url=self.URL % (album.asin, index),
+ match=Candidate.MATCH_EXACT)
+
+
+class AlbumArtOrg(RemoteArtSource):
+ NAME = "AlbumArt.org scraper"
+ URL = 'https://www.albumart.org/index_detail.php'
+ PAT = r'href\s*=\s*"([^>"]*)"[^>]*title\s*=\s*"View larger image"'
+
+ def get(self, album, plugin, paths):
+ """Return art URL from AlbumArt.org using album ASIN.
+ """
+ if not album.asin:
+ return
+ # Get the page from albumart.org.
+ try:
+ resp = self.request(self.URL, params={'asin': album.asin})
+ self._log.debug('scraped art URL: {0}', resp.url)
+ except requests.RequestException:
+ self._log.debug('error scraping art page')
+ return
+
+ # Search the page for the image URL.
+ m = re.search(self.PAT, resp.text)
+ if m:
+ image_url = m.group(1)
+ yield self._candidate(url=image_url, match=Candidate.MATCH_EXACT)
else:
- log.debug(u'fetchart: album has no artwork in iTunes Store')
- except IndexError:
- log.debug(u'fetchart: album not found in iTunes Store')
+ self._log.debug('no image found on page')
-# Art from the filesystem.
+class GoogleImages(RemoteArtSource):
+ NAME = "Google Images"
+ URL = 'https://www.googleapis.com/customsearch/v1'
+
+ def __init__(self, *args, **kwargs):
+ super().__init__(*args, **kwargs)
+ self.key = self._config['google_key'].get(),
+ self.cx = self._config['google_engine'].get(),
+
+ def get(self, album, plugin, paths):
+ """Return art URL from google custom search engine
+ given an album title and interpreter.
+ """
+ if not (album.albumartist and album.album):
+ return
+ search_string = (album.albumartist + ',' + album.album).encode('utf-8')
+
+ try:
+ response = self.request(self.URL, params={
+ 'key': self.key,
+ 'cx': self.cx,
+ 'q': search_string,
+ 'searchType': 'image'
+ })
+ except requests.RequestException:
+ self._log.debug('google: error receiving response')
+ return
+
+ # Get results using JSON.
+ try:
+ data = response.json()
+ except ValueError:
+ self._log.debug('google: error loading response: {}'
+ .format(response.text))
+ return
+
+ if 'error' in data:
+ reason = data['error']['errors'][0]['reason']
+ self._log.debug('google fetchart error: {0}', reason)
+ return
+
+ if 'items' in data.keys():
+ for item in data['items']:
+ yield self._candidate(url=item['link'],
+ match=Candidate.MATCH_EXACT)
-def filename_priority(filename, cover_names):
- """Sort order for image names.
+class FanartTV(RemoteArtSource):
+ """Art from fanart.tv requested using their API"""
+ NAME = "fanart.tv"
+ API_URL = 'https://webservice.fanart.tv/v3/'
+ API_ALBUMS = API_URL + 'music/albums/'
+ PROJECT_KEY = '61a7d0ab4e67162b7a0c7c35915cd48e'
- Return indexes of cover names found in the image filename. This
- means that images with lower-numbered and more keywords will have higher
- priority.
- """
- return [idx for (idx, x) in enumerate(cover_names) if x in filename]
+ def __init__(self, *args, **kwargs):
+ super().__init__(*args, **kwargs)
+ self.client_key = self._config['fanarttv_key'].get()
+
+ def get(self, album, plugin, paths):
+ if not album.mb_releasegroupid:
+ return
+
+ try:
+ response = self.request(
+ self.API_ALBUMS + album.mb_releasegroupid,
+ headers={'api-key': self.PROJECT_KEY,
+ 'client-key': self.client_key})
+ except requests.RequestException:
+ self._log.debug('fanart.tv: error receiving response')
+ return
+
+ try:
+ data = response.json()
+ except ValueError:
+ self._log.debug('fanart.tv: error loading response: {}',
+ response.text)
+ return
+
+ if 'status' in data and data['status'] == 'error':
+ if 'not found' in data['error message'].lower():
+ self._log.debug('fanart.tv: no image found')
+ elif 'api key' in data['error message'].lower():
+ self._log.warning('fanart.tv: Invalid API key given, please '
+ 'enter a valid one in your config file.')
+ else:
+ self._log.debug('fanart.tv: error on request: {}',
+ data['error message'])
+ return
+
+ matches = []
+ # can there be more than one releasegroupid per response?
+ for mbid, art in data.get('albums', {}).items():
+ # there might be more art referenced, e.g. cdart, and an albumcover
+ # might not be present, even if the request was successful
+ if album.mb_releasegroupid == mbid and 'albumcover' in art:
+ matches.extend(art['albumcover'])
+ # can this actually occur?
+ else:
+ self._log.debug('fanart.tv: unexpected mb_releasegroupid in '
+ 'response!')
+
+ matches.sort(key=lambda x: x['likes'], reverse=True)
+ for item in matches:
+ # fanart.tv has a strict size requirement for album art to be
+ # uploaded
+ yield self._candidate(url=item['url'],
+ match=Candidate.MATCH_EXACT,
+ size=(1000, 1000))
-def art_in_path(path, cover_names, cautious):
- """Look for album art files in a specified directory.
- """
- if not os.path.isdir(path):
- return
+class ITunesStore(RemoteArtSource):
+ NAME = "iTunes Store"
+ API_URL = 'https://itunes.apple.com/search'
- # Find all files that look like images in the directory.
- images = []
- for fn in os.listdir(path):
- for ext in IMAGE_EXTENSIONS:
- if fn.lower().endswith('.' + ext):
- images.append(fn)
+ def get(self, album, plugin, paths):
+ """Return art URL from iTunes Store given an album title.
+ """
+ if not (album.albumartist and album.album):
+ return
- # Look for "preferred" filenames.
- images = sorted(images, key=lambda x: filename_priority(x, cover_names))
- cover_pat = r"(\b|_)({0})(\b|_)".format('|'.join(cover_names))
- for fn in images:
- if re.search(cover_pat, os.path.splitext(fn)[0], re.I):
- log.debug(u'fetchart: using well-named art file {0}'.format(
- util.displayable_path(fn)
- ))
- return os.path.join(path, fn)
+ payload = {
+ 'term': album.albumartist + ' ' + album.album,
+ 'entity': 'album',
+ 'media': 'music',
+ 'limit': 200
+ }
+ try:
+ r = self.request(self.API_URL, params=payload)
+ r.raise_for_status()
+ except requests.RequestException as e:
+ self._log.debug('iTunes search failed: {0}', e)
+ return
- # Fall back to any image in the folder.
- if images and not cautious:
- log.debug(u'fetchart: using fallback art file {0}'.format(
- util.displayable_path(images[0])
- ))
- return os.path.join(path, images[0])
+ try:
+ candidates = r.json()['results']
+ except ValueError as e:
+ self._log.debug('Could not decode json response: {0}', e)
+ return
+ except KeyError as e:
+ self._log.debug('{} not found in json. Fields are {} ',
+ e,
+ list(r.json().keys()))
+ return
+ if not candidates:
+ self._log.debug('iTunes search for {!r} got no results',
+ payload['term'])
+ return
+
+ if self._config['high_resolution']:
+ image_suffix = '100000x100000-999'
+ else:
+ image_suffix = '1200x1200bb'
+
+ for c in candidates:
+ try:
+ if (c['artistName'] == album.albumartist
+ and c['collectionName'] == album.album):
+ art_url = c['artworkUrl100']
+ art_url = art_url.replace('100x100bb',
+ image_suffix)
+ yield self._candidate(url=art_url,
+ match=Candidate.MATCH_EXACT)
+ except KeyError as e:
+ self._log.debug('Malformed itunes candidate: {} not found in {}', # NOQA E501
+ e,
+ list(c.keys()))
+
+ try:
+ fallback_art_url = candidates[0]['artworkUrl100']
+ fallback_art_url = fallback_art_url.replace('100x100bb',
+ image_suffix)
+ yield self._candidate(url=fallback_art_url,
+ match=Candidate.MATCH_FALLBACK)
+ except KeyError as e:
+ self._log.debug('Malformed itunes candidate: {} not found in {}',
+ e,
+ list(c.keys()))
+
+
+class Wikipedia(RemoteArtSource):
+ NAME = "Wikipedia (queried through DBpedia)"
+ DBPEDIA_URL = 'https://dbpedia.org/sparql'
+ WIKIPEDIA_URL = 'https://en.wikipedia.org/w/api.php'
+ SPARQL_QUERY = '''PREFIX rdf:
+ PREFIX dbpprop:
+ PREFIX owl:
+ PREFIX rdfs:
+ PREFIX foaf:
+
+ SELECT DISTINCT ?pageId ?coverFilename WHERE {{
+ ?subject owl:wikiPageID ?pageId .
+ ?subject dbpprop:name ?name .
+ ?subject rdfs:label ?label .
+ {{ ?subject dbpprop:artist ?artist }}
+ UNION
+ {{ ?subject owl:artist ?artist }}
+ {{ ?artist foaf:name "{artist}"@en }}
+ UNION
+ {{ ?artist dbpprop:name "{artist}"@en }}
+ ?subject rdf:type .
+ ?subject dbpprop:cover ?coverFilename .
+ FILTER ( regex(?name, "{album}", "i") )
+ }}
+ Limit 1'''
+
+ def get(self, album, plugin, paths):
+ if not (album.albumartist and album.album):
+ return
+
+ # Find the name of the cover art filename on DBpedia
+ cover_filename, page_id = None, None
+
+ try:
+ dbpedia_response = self.request(
+ self.DBPEDIA_URL,
+ params={
+ 'format': 'application/sparql-results+json',
+ 'timeout': 2500,
+ 'query': self.SPARQL_QUERY.format(
+ artist=album.albumartist.title(), album=album.album)
+ },
+ headers={'content-type': 'application/json'},
+ )
+ except requests.RequestException:
+ self._log.debug('dbpedia: error receiving response')
+ return
+
+ try:
+ data = dbpedia_response.json()
+ results = data['results']['bindings']
+ if results:
+ cover_filename = 'File:' + results[0]['coverFilename']['value']
+ page_id = results[0]['pageId']['value']
+ else:
+ self._log.debug('wikipedia: album not found on dbpedia')
+ except (ValueError, KeyError, IndexError):
+ self._log.debug('wikipedia: error scraping dbpedia response: {}',
+ dbpedia_response.text)
+
+ # Ensure we have a filename before attempting to query wikipedia
+ if not (cover_filename and page_id):
+ return
+
+ # DBPedia sometimes provides an incomplete cover_filename, indicated
+ # by the filename having a space before the extension, e.g., 'foo .bar'
+ # An additional Wikipedia call can help to find the real filename.
+ # This may be removed once the DBPedia issue is resolved, see:
+ # https://github.com/dbpedia/extraction-framework/issues/396
+ if ' .' in cover_filename and \
+ '.' not in cover_filename.split(' .')[-1]:
+ self._log.debug(
+ 'wikipedia: dbpedia provided incomplete cover_filename'
+ )
+ lpart, rpart = cover_filename.rsplit(' .', 1)
+
+ # Query all the images in the page
+ try:
+ wikipedia_response = self.request(
+ self.WIKIPEDIA_URL,
+ params={
+ 'format': 'json',
+ 'action': 'query',
+ 'continue': '',
+ 'prop': 'images',
+ 'pageids': page_id,
+ },
+ headers={'content-type': 'application/json'},
+ )
+ except requests.RequestException:
+ self._log.debug('wikipedia: error receiving response')
+ return
+
+ # Try to see if one of the images on the pages matches our
+ # incomplete cover_filename
+ try:
+ data = wikipedia_response.json()
+ results = data['query']['pages'][page_id]['images']
+ for result in results:
+ if re.match(re.escape(lpart) + r'.*?\.' + re.escape(rpart),
+ result['title']):
+ cover_filename = result['title']
+ break
+ except (ValueError, KeyError):
+ self._log.debug(
+ 'wikipedia: failed to retrieve a cover_filename'
+ )
+ return
+
+ # Find the absolute url of the cover art on Wikipedia
+ try:
+ wikipedia_response = self.request(
+ self.WIKIPEDIA_URL,
+ params={
+ 'format': 'json',
+ 'action': 'query',
+ 'continue': '',
+ 'prop': 'imageinfo',
+ 'iiprop': 'url',
+ 'titles': cover_filename.encode('utf-8'),
+ },
+ headers={'content-type': 'application/json'},
+ )
+ except requests.RequestException:
+ self._log.debug('wikipedia: error receiving response')
+ return
+
+ try:
+ data = wikipedia_response.json()
+ results = data['query']['pages']
+ for _, result in results.items():
+ image_url = result['imageinfo'][0]['url']
+ yield self._candidate(url=image_url,
+ match=Candidate.MATCH_EXACT)
+ except (ValueError, KeyError, IndexError):
+ self._log.debug('wikipedia: error scraping imageinfo')
+ return
+
+
+class FileSystem(LocalArtSource):
+ NAME = "Filesystem"
+
+ @staticmethod
+ def filename_priority(filename, cover_names):
+ """Sort order for image names.
+
+ Return indexes of cover names found in the image filename. This
+ means that images with lower-numbered and more keywords will have
+ higher priority.
+ """
+ return [idx for (idx, x) in enumerate(cover_names) if x in filename]
+
+ def get(self, album, plugin, paths):
+ """Look for album art files in the specified directories.
+ """
+ if not paths:
+ return
+ cover_names = list(map(util.bytestring_path, plugin.cover_names))
+ cover_names_str = b'|'.join(cover_names)
+ cover_pat = br''.join([br"(\b|_)(", cover_names_str, br")(\b|_)"])
+
+ for path in paths:
+ if not os.path.isdir(syspath(path)):
+ continue
+
+ # Find all files that look like images in the directory.
+ images = []
+ ignore = config['ignore'].as_str_seq()
+ ignore_hidden = config['ignore_hidden'].get(bool)
+ for _, _, files in sorted_walk(path, ignore=ignore,
+ ignore_hidden=ignore_hidden):
+ for fn in files:
+ fn = bytestring_path(fn)
+ for ext in IMAGE_EXTENSIONS:
+ if fn.lower().endswith(b'.' + ext) and \
+ os.path.isfile(syspath(os.path.join(path, fn))):
+ images.append(fn)
+
+ # Look for "preferred" filenames.
+ images = sorted(images,
+ key=lambda x:
+ self.filename_priority(x, cover_names))
+ remaining = []
+ for fn in images:
+ if re.search(cover_pat, os.path.splitext(fn)[0], re.I):
+ self._log.debug('using well-named art file {0}',
+ util.displayable_path(fn))
+ yield self._candidate(path=os.path.join(path, fn),
+ match=Candidate.MATCH_EXACT)
+ else:
+ remaining.append(fn)
+
+ # Fall back to any image in the folder.
+ if remaining and not plugin.cautious:
+ self._log.debug('using fallback art file {0}',
+ util.displayable_path(remaining[0]))
+ yield self._candidate(path=os.path.join(path, remaining[0]),
+ match=Candidate.MATCH_FALLBACK)
+
+
+class LastFM(RemoteArtSource):
+ NAME = "Last.fm"
+
+ # Sizes in priority order.
+ SIZES = OrderedDict([
+ ('mega', (300, 300)),
+ ('extralarge', (300, 300)),
+ ('large', (174, 174)),
+ ('medium', (64, 64)),
+ ('small', (34, 34)),
+ ])
+
+ API_URL = 'https://ws.audioscrobbler.com/2.0'
+
+ def __init__(self, *args, **kwargs):
+ super().__init__(*args, **kwargs)
+ self.key = self._config['lastfm_key'].get(),
+
+ def get(self, album, plugin, paths):
+ if not album.mb_albumid:
+ return
+
+ try:
+ response = self.request(self.API_URL, params={
+ 'method': 'album.getinfo',
+ 'api_key': self.key,
+ 'mbid': album.mb_albumid,
+ 'format': 'json',
+ })
+ except requests.RequestException:
+ self._log.debug('lastfm: error receiving response')
+ return
+
+ try:
+ data = response.json()
+
+ if 'error' in data:
+ if data['error'] == 6:
+ self._log.debug('lastfm: no results for {}',
+ album.mb_albumid)
+ else:
+ self._log.error(
+ 'lastfm: failed to get album info: {} ({})',
+ data['message'], data['error'])
+ else:
+ images = {image['size']: image['#text']
+ for image in data['album']['image']}
+
+ # Provide candidates in order of size.
+ for size in self.SIZES.keys():
+ if size in images:
+ yield self._candidate(url=images[size],
+ size=self.SIZES[size])
+ except ValueError:
+ self._log.debug('lastfm: error loading response: {}'
+ .format(response.text))
+ return
# Try each source in turn.
-SOURCES_ALL = [u'coverart', u'itunes', u'amazon', u'albumart', u'google']
+SOURCES_ALL = ['filesystem',
+ 'coverart', 'itunes', 'amazon', 'albumart',
+ 'wikipedia', 'google', 'fanarttv', 'lastfm']
-ART_FUNCS = {
- u'coverart': caa_art,
- u'itunes': itunes_art,
- u'albumart': aao_art,
- u'amazon': art_for_asin,
- u'google': google_art,
+ART_SOURCES = {
+ 'filesystem': FileSystem,
+ 'coverart': CoverArtArchive,
+ 'itunes': ITunesStore,
+ 'albumart': AlbumArtOrg,
+ 'amazon': Amazon,
+ 'wikipedia': Wikipedia,
+ 'google': GoogleImages,
+ 'fanarttv': FanartTV,
+ 'lastfm': LastFM,
}
-
-
-def _source_urls(album, sources=SOURCES_ALL):
- """Generate possible source URLs for an album's art. The URLs are
- not guaranteed to work so they each need to be attempted in turn.
- This allows the main `art_for_album` function to abort iteration
- through this sequence early to avoid the cost of scraping when not
- necessary.
- """
- for s in sources:
- urls = ART_FUNCS[s](album)
- for url in urls:
- yield url
-
-
-def art_for_album(album, paths, maxwidth=None, local_only=False):
- """Given an Album object, returns a path to downloaded art for the
- album (or None if no art is found). If `maxwidth`, then images are
- resized to this maximum pixel size. If `local_only`, then only local
- image files from the filesystem are returned; no network requests
- are made.
- """
- out = None
-
- # Local art.
- cover_names = config['fetchart']['cover_names'].as_str_seq()
- cover_names = map(util.bytestring_path, cover_names)
- cautious = config['fetchart']['cautious'].get(bool)
- if paths:
- for path in paths:
- out = art_in_path(path, cover_names, cautious)
- if out:
- break
-
- # Web art sources.
- remote_priority = config['fetchart']['remote_priority'].get(bool)
- if not local_only and (remote_priority or not out):
- for url in _source_urls(album,
- config['fetchart']['sources'].as_str_seq()):
- if maxwidth:
- url = ArtResizer.shared.proxy_url(maxwidth, url)
- candidate = _fetch_image(url)
- if candidate:
- out = candidate
- break
-
- if maxwidth and out:
- out = ArtResizer.shared.resize(maxwidth, out)
- return out
-
+SOURCE_NAMES = {v: k for k, v in ART_SOURCES.items()}
# PLUGIN LOGIC ###############################################################
-def batch_fetch_art(lib, albums, force, maxwidth=None):
- """Fetch album art for each of the albums. This implements the manual
- fetchart CLI command.
- """
- for album in albums:
- if album.artpath and not force:
- message = 'has album art'
- else:
- # In ordinary invocations, look for images on the
- # filesystem. When forcing, however, always go to the Web
- # sources.
- local_paths = None if force else [album.path]
+class FetchArtPlugin(plugins.BeetsPlugin, RequestMixin):
+ PAT_PX = r"(0|[1-9][0-9]*)px"
+ PAT_PERCENT = r"(100(\.00?)?|[1-9]?[0-9](\.[0-9]{1,2})?)%"
- path = art_for_album(album, local_paths, maxwidth)
- if path:
- album.set_art(path, False)
- album.store()
- message = ui.colorize('green', 'found album art')
- else:
- message = ui.colorize('red', 'no art found')
-
- log.info(u'{0} - {1}: {2}'.format(album.albumartist, album.album,
- message))
-
-
-class FetchArtPlugin(plugins.BeetsPlugin):
def __init__(self):
- super(FetchArtPlugin, self).__init__()
+ super().__init__()
+
+ # Holds candidates corresponding to downloaded images between
+ # fetching them and placing them in the filesystem.
+ self.art_candidates = {}
self.config.add({
'auto': True,
+ 'minwidth': 0,
'maxwidth': 0,
- 'remote_priority': False,
+ 'quality': 0,
+ 'max_filesize': 0,
+ 'enforce_ratio': False,
'cautious': False,
- 'google_search': False,
'cover_names': ['cover', 'front', 'art', 'album', 'folder'],
- 'sources': SOURCES_ALL,
+ 'sources': ['filesystem',
+ 'coverart', 'itunes', 'amazon', 'albumart'],
+ 'google_key': None,
+ 'google_engine': '001442825323518660753:hrh5ch1gjzm',
+ 'fanarttv_key': None,
+ 'lastfm_key': None,
+ 'store_source': False,
+ 'high_resolution': False,
+ 'deinterlace': False,
+ 'cover_format': None,
})
+ self.config['google_key'].redact = True
+ self.config['fanarttv_key'].redact = True
+ self.config['lastfm_key'].redact = True
- # Holds paths to downloaded images between fetching them and
- # placing them in the filesystem.
- self.art_paths = {}
-
+ self.minwidth = self.config['minwidth'].get(int)
self.maxwidth = self.config['maxwidth'].get(int)
+ self.max_filesize = self.config['max_filesize'].get(int)
+ self.quality = self.config['quality'].get(int)
+
+ # allow both pixel and percentage-based margin specifications
+ self.enforce_ratio = self.config['enforce_ratio'].get(
+ confuse.OneOf([bool,
+ confuse.String(pattern=self.PAT_PX),
+ confuse.String(pattern=self.PAT_PERCENT)]))
+ self.margin_px = None
+ self.margin_percent = None
+ self.deinterlace = self.config['deinterlace'].get(bool)
+ if type(self.enforce_ratio) is str:
+ if self.enforce_ratio[-1] == '%':
+ self.margin_percent = float(self.enforce_ratio[:-1]) / 100
+ elif self.enforce_ratio[-2:] == 'px':
+ self.margin_px = int(self.enforce_ratio[:-2])
+ else:
+ # shouldn't happen
+ raise confuse.ConfigValueError()
+ self.enforce_ratio = True
+
+ cover_names = self.config['cover_names'].as_str_seq()
+ self.cover_names = list(map(util.bytestring_path, cover_names))
+ self.cautious = self.config['cautious'].get(bool)
+ self.store_source = self.config['store_source'].get(bool)
+
+ self.src_removed = (config['import']['delete'].get(bool) or
+ config['import']['move'].get(bool))
+
+ self.cover_format = self.config['cover_format'].get(
+ confuse.Optional(str)
+ )
+
if self.config['auto']:
# Enable two import hooks when fetching is enabled.
self.import_stages = [self.fetch_art]
self.register_listener('import_task_files', self.assign_art)
available_sources = list(SOURCES_ALL)
- if not HAVE_ITUNES and u'itunes' in available_sources:
- available_sources.remove(u'itunes')
- self.config['sources'] = plugins.sanitize_choices(
- self.config['sources'].as_str_seq(), available_sources)
+ if not self.config['google_key'].get() and \
+ 'google' in available_sources:
+ available_sources.remove('google')
+ if not self.config['lastfm_key'].get() and \
+ 'lastfm' in available_sources:
+ available_sources.remove('lastfm')
+ available_sources = [(s, c)
+ for s in available_sources
+ for c in ART_SOURCES[s].VALID_MATCHING_CRITERIA]
+ sources = plugins.sanitize_pairs(
+ self.config['sources'].as_pairs(default_value='*'),
+ available_sources)
+
+ if 'remote_priority' in self.config:
+ self._log.warning(
+ 'The `fetch_art.remote_priority` configuration option has '
+ 'been deprecated. Instead, place `filesystem` at the end of '
+ 'your `sources` list.')
+ if self.config['remote_priority'].get(bool):
+ fs = []
+ others = []
+ for s, c in sources:
+ if s == 'filesystem':
+ fs.append((s, c))
+ else:
+ others.append((s, c))
+ sources = others + fs
+
+ self.sources = [ART_SOURCES[s](self._log, self.config, match_by=[c])
+ for s, c in sources]
# Asynchronous; after music is added to the library.
def fetch_art(self, session, task):
"""Find art for the album being imported."""
if task.is_album: # Only fetch art for full albums.
+ if task.album.artpath and os.path.isfile(task.album.artpath):
+ # Album already has art (probably a re-import); skip it.
+ return
if task.choice_flag == importer.action.ASIS:
# For as-is imports, don't search Web sources for art.
local = True
- elif task.choice_flag == importer.action.APPLY:
+ elif task.choice_flag in (importer.action.APPLY,
+ importer.action.RETAG):
# Search everywhere for art.
local = False
else:
# For any other choices (e.g., TRACKS), do nothing.
return
- path = art_for_album(task.album, task.paths, self.maxwidth, local)
+ candidate = self.art_for_album(task.album, task.paths, local)
- if path:
- self.art_paths[task] = path
+ if candidate:
+ self.art_candidates[task] = candidate
+
+ def _set_art(self, album, candidate, delete=False):
+ album.set_art(candidate.path, delete)
+ if self.store_source:
+ # store the source of the chosen artwork in a flexible field
+ self._log.debug(
+ "Storing art_source for {0.albumartist} - {0.album}",
+ album)
+ album.art_source = SOURCE_NAMES[type(candidate.source)]
+ album.store()
# Synchronous; after music files are put in place.
def assign_art(self, session, task):
"""Place the discovered art in the filesystem."""
- if task in self.art_paths:
- path = self.art_paths.pop(task)
+ if task in self.art_candidates:
+ candidate = self.art_candidates.pop(task)
- album = task.album
- src_removed = (config['import']['delete'].get(bool) or
- config['import']['move'].get(bool))
- album.set_art(path, not src_removed)
- album.store()
- if src_removed:
- task.prune(path)
+ self._set_art(task.album, candidate, not self.src_removed)
+
+ if self.src_removed:
+ task.prune(candidate.path)
# Manual album art fetching.
def commands(self):
cmd = ui.Subcommand('fetchart', help='download album art')
- cmd.parser.add_option('-f', '--force', dest='force',
- action='store_true', default=False,
- help='re-download art when already present')
+ cmd.parser.add_option(
+ '-f', '--force', dest='force',
+ action='store_true', default=False,
+ help='re-download art when already present'
+ )
+ cmd.parser.add_option(
+ '-q', '--quiet', dest='quiet',
+ action='store_true', default=False,
+ help='quiet mode: do not output albums that already have artwork'
+ )
def func(lib, opts, args):
- batch_fetch_art(lib, lib.albums(ui.decargs(args)), opts.force,
- self.maxwidth)
+ self.batch_fetch_art(lib, lib.albums(ui.decargs(args)), opts.force,
+ opts.quiet)
cmd.func = func
return [cmd]
+
+ # Utilities converted from functions to methods on logging overhaul
+
+ def art_for_album(self, album, paths, local_only=False):
+ """Given an Album object, returns a path to downloaded art for the
+ album (or None if no art is found). If `maxwidth`, then images are
+ resized to this maximum pixel size. If `quality` then resized images
+ are saved at the specified quality level. If `local_only`, then only
+ local image files from the filesystem are returned; no network
+ requests are made.
+ """
+ out = None
+
+ for source in self.sources:
+ if source.IS_LOCAL or not local_only:
+ self._log.debug(
+ 'trying source {0} for album {1.albumartist} - {1.album}',
+ SOURCE_NAMES[type(source)],
+ album,
+ )
+ # URLs might be invalid at this point, or the image may not
+ # fulfill the requirements
+ for candidate in source.get(album, self, paths):
+ source.fetch_image(candidate, self)
+ if candidate.validate(self):
+ out = candidate
+ self._log.debug(
+ 'using {0.LOC_STR} image {1}'.format(
+ source, util.displayable_path(out.path)))
+ break
+ # Remove temporary files for invalid candidates.
+ source.cleanup(candidate)
+ if out:
+ break
+
+ if out:
+ out.resize(self)
+
+ return out
+
+ def batch_fetch_art(self, lib, albums, force, quiet):
+ """Fetch album art for each of the albums. This implements the manual
+ fetchart CLI command.
+ """
+ for album in albums:
+ if album.artpath and not force and os.path.isfile(album.artpath):
+ if not quiet:
+ message = ui.colorize('text_highlight_minor',
+ 'has album art')
+ self._log.info('{0}: {1}', album, message)
+ else:
+ # In ordinary invocations, look for images on the
+ # filesystem. When forcing, however, always go to the Web
+ # sources.
+ local_paths = None if force else [album.path]
+
+ candidate = self.art_for_album(album, local_paths)
+ if candidate:
+ self._set_art(album, candidate)
+ message = ui.colorize('text_success', 'found album art')
+ else:
+ message = ui.colorize('text_error', 'no art found')
+ self._log.info('{0}: {1}', album, message)
diff --git a/lib/beetsplug/filefilter.py b/lib/beetsplug/filefilter.py
new file mode 100644
index 00000000..ec8fddb4
--- /dev/null
+++ b/lib/beetsplug/filefilter.py
@@ -0,0 +1,79 @@
+# This file is part of beets.
+# Copyright 2016, Malte Ried.
+#
+# 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.
+
+"""Filter imported files using a regular expression.
+"""
+
+
+import re
+from beets import config
+from beets.util import bytestring_path
+from beets.plugins import BeetsPlugin
+from beets.importer import SingletonImportTask
+
+
+class FileFilterPlugin(BeetsPlugin):
+ def __init__(self):
+ super().__init__()
+ self.register_listener('import_task_created',
+ self.import_task_created_event)
+ self.config.add({
+ 'path': '.*'
+ })
+
+ self.path_album_regex = \
+ self.path_singleton_regex = \
+ re.compile(bytestring_path(self.config['path'].get()))
+
+ if 'album_path' in self.config:
+ self.path_album_regex = re.compile(
+ bytestring_path(self.config['album_path'].get()))
+
+ if 'singleton_path' in self.config:
+ self.path_singleton_regex = re.compile(
+ bytestring_path(self.config['singleton_path'].get()))
+
+ def import_task_created_event(self, session, task):
+ if task.items and len(task.items) > 0:
+ items_to_import = []
+ for item in task.items:
+ if self.file_filter(item['path']):
+ items_to_import.append(item)
+ if len(items_to_import) > 0:
+ task.items = items_to_import
+ else:
+ # Returning an empty list of tasks from the handler
+ # drops the task from the rest of the importer pipeline.
+ return []
+
+ elif isinstance(task, SingletonImportTask):
+ if not self.file_filter(task.item['path']):
+ return []
+
+ # If not filtered, return the original task unchanged.
+ return [task]
+
+ def file_filter(self, full_path):
+ """Checks if the configured regular expressions allow the import
+ of the file given in full_path.
+ """
+ import_config = dict(config['import'])
+ full_path = bytestring_path(full_path)
+ if 'singletons' not in import_config or not import_config[
+ 'singletons']:
+ # Album
+ return self.path_album_regex.match(full_path) is not None
+ else:
+ # Singleton
+ return self.path_singleton_regex.match(full_path) is not None
diff --git a/lib/beetsplug/fish.py b/lib/beetsplug/fish.py
new file mode 100644
index 00000000..21fd67f6
--- /dev/null
+++ b/lib/beetsplug/fish.py
@@ -0,0 +1,285 @@
+# This file is part of beets.
+# Copyright 2015, winters jean-marie.
+# Copyright 2020, Justin Mayer
+#
+# 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.
+
+"""This plugin generates tab completions for Beets commands for the Fish shell
+, including completions for Beets commands, plugin
+commands, and option flags. Also generated are completions for all the album
+and track fields, suggesting for example `genre:` or `album:` when querying the
+Beets database. Completions for the *values* of those fields are not generated
+by default but can be added via the `-e` / `--extravalues` flag. For example:
+`beet fish -e genre -e albumartist`
+"""
+
+
+from beets.plugins import BeetsPlugin
+from beets import library, ui
+from beets.ui import commands
+from operator import attrgetter
+import os
+BL_NEED2 = """complete -c beet -n '__fish_beet_needs_command' {} {}\n"""
+BL_USE3 = """complete -c beet -n '__fish_beet_using_command {}' {} {}\n"""
+BL_SUBS = """complete -c beet -n '__fish_at_level {} ""' {} {}\n"""
+BL_EXTRA3 = """complete -c beet -n '__fish_beet_use_extra {}' {} {}\n"""
+
+HEAD = '''
+function __fish_beet_needs_command
+ set cmd (commandline -opc)
+ if test (count $cmd) -eq 1
+ return 0
+ end
+ return 1
+end
+
+function __fish_beet_using_command
+ set cmd (commandline -opc)
+ set needle (count $cmd)
+ if test $needle -gt 1
+ if begin test $argv[1] = $cmd[2];
+ and not contains -- $cmd[$needle] $FIELDS; end
+ return 0
+ end
+ end
+ return 1
+end
+
+function __fish_beet_use_extra
+ set cmd (commandline -opc)
+ set needle (count $cmd)
+ if test $argv[2] = $cmd[$needle]
+ return 0
+ end
+ return 1
+end
+'''
+
+
+class FishPlugin(BeetsPlugin):
+
+ def commands(self):
+ cmd = ui.Subcommand('fish', help='generate Fish shell tab completions')
+ cmd.func = self.run
+ cmd.parser.add_option('-f', '--noFields', action='store_true',
+ default=False,
+ help='omit album/track field completions')
+ cmd.parser.add_option(
+ '-e',
+ '--extravalues',
+ action='append',
+ type='choice',
+ choices=library.Item.all_keys() +
+ library.Album.all_keys(),
+ help='include specified field *values* in completions')
+ return [cmd]
+
+ def run(self, lib, opts, args):
+ # Gather the commands from Beets core and its plugins.
+ # Collect the album and track fields.
+ # If specified, also collect the values for these fields.
+ # Make a giant string of all the above, formatted in a way that
+ # allows Fish to do tab completion for the `beet` command.
+ home_dir = os.path.expanduser("~")
+ completion_dir = os.path.join(home_dir, '.config/fish/completions')
+ try:
+ os.makedirs(completion_dir)
+ except OSError:
+ if not os.path.isdir(completion_dir):
+ raise
+ completion_file_path = os.path.join(completion_dir, 'beet.fish')
+ nobasicfields = opts.noFields # Do not complete for album/track fields
+ extravalues = opts.extravalues # e.g., Also complete artists names
+ beetcmds = sorted(
+ (commands.default_commands +
+ commands.plugins.commands()),
+ key=attrgetter('name'))
+ fields = sorted(set(
+ library.Album.all_keys() + library.Item.all_keys()))
+ # Collect commands, their aliases, and their help text
+ cmd_names_help = []
+ for cmd in beetcmds:
+ names = list(cmd.aliases)
+ names.append(cmd.name)
+ for name in names:
+ cmd_names_help.append((name, cmd.help))
+ # Concatenate the string
+ totstring = HEAD + "\n"
+ totstring += get_cmds_list([name[0] for name in cmd_names_help])
+ totstring += '' if nobasicfields else get_standard_fields(fields)
+ totstring += get_extravalues(lib, extravalues) if extravalues else ''
+ totstring += "\n" + "# ====== {} =====".format(
+ "setup basic beet completion") + "\n" * 2
+ totstring += get_basic_beet_options()
+ totstring += "\n" + "# ====== {} =====".format(
+ "setup field completion for subcommands") + "\n"
+ totstring += get_subcommands(
+ cmd_names_help, nobasicfields, extravalues)
+ # Set up completion for all the command options
+ totstring += get_all_commands(beetcmds)
+
+ with open(completion_file_path, 'w') as fish_file:
+ fish_file.write(totstring)
+
+
+def _escape(name):
+ # Escape ? in fish
+ if name == "?":
+ name = "\\" + name
+ return name
+
+
+def get_cmds_list(cmds_names):
+ # Make a list of all Beets core & plugin commands
+ substr = ''
+ substr += (
+ "set CMDS " + " ".join(cmds_names) + ("\n" * 2)
+ )
+ return substr
+
+
+def get_standard_fields(fields):
+ # Make a list of album/track fields and append with ':'
+ fields = (field + ":" for field in fields)
+ substr = ''
+ substr += (
+ "set FIELDS " + " ".join(fields) + ("\n" * 2)
+ )
+ return substr
+
+
+def get_extravalues(lib, extravalues):
+ # Make a list of all values from an album/track field.
+ # 'beet ls albumartist: ' yields completions for ABBA, Beatles, etc.
+ word = ''
+ values_set = get_set_of_values_for_field(lib, extravalues)
+ for fld in extravalues:
+ extraname = fld.upper() + 'S'
+ word += (
+ "set " + extraname + " " + " ".join(sorted(values_set[fld]))
+ + ("\n" * 2)
+ )
+ return word
+
+
+def get_set_of_values_for_field(lib, fields):
+ # Get unique values from a specified album/track field
+ fields_dict = {}
+ for each in fields:
+ fields_dict[each] = set()
+ for item in lib.items():
+ for field in fields:
+ fields_dict[field].add(wrap(item[field]))
+ return fields_dict
+
+
+def get_basic_beet_options():
+ word = (
+ BL_NEED2.format("-l format-item",
+ "-f -d 'print with custom format'") +
+ BL_NEED2.format("-l format-album",
+ "-f -d 'print with custom format'") +
+ BL_NEED2.format("-s l -l library",
+ "-f -r -d 'library database file to use'") +
+ BL_NEED2.format("-s d -l directory",
+ "-f -r -d 'destination music directory'") +
+ BL_NEED2.format("-s v -l verbose",
+ "-f -d 'print debugging information'") +
+
+ BL_NEED2.format("-s c -l config",
+ "-f -r -d 'path to configuration file'") +
+ BL_NEED2.format("-s h -l help",
+ "-f -d 'print this help message and exit'"))
+ return word
+
+
+def get_subcommands(cmd_name_and_help, nobasicfields, extravalues):
+ # Formatting for Fish to complete our fields/values
+ word = ""
+ for cmdname, cmdhelp in cmd_name_and_help:
+ cmdname = _escape(cmdname)
+
+ word += "\n" + "# ------ {} -------".format(
+ "fieldsetups for " + cmdname) + "\n"
+ word += (
+ BL_NEED2.format(
+ ("-a " + cmdname),
+ ("-f " + "-d " + wrap(clean_whitespace(cmdhelp)))))
+
+ if nobasicfields is False:
+ word += (
+ BL_USE3.format(
+ cmdname,
+ ("-a " + wrap("$FIELDS")),
+ ("-f " + "-d " + wrap("fieldname"))))
+
+ if extravalues:
+ for f in extravalues:
+ setvar = wrap("$" + f.upper() + "S")
+ word += " ".join(BL_EXTRA3.format(
+ (cmdname + " " + f + ":"),
+ ('-f ' + '-A ' + '-a ' + setvar),
+ ('-d ' + wrap(f))).split()) + "\n"
+ return word
+
+
+def get_all_commands(beetcmds):
+ # Formatting for Fish to complete command options
+ word = ""
+ for cmd in beetcmds:
+ names = list(cmd.aliases)
+ names.append(cmd.name)
+ for name in names:
+ name = _escape(name)
+
+ word += "\n"
+ word += ("\n" * 2) + "# ====== {} =====".format(
+ "completions for " + name) + "\n"
+
+ for option in cmd.parser._get_all_options()[1:]:
+ cmd_l = (" -l " + option._long_opts[0].replace('--', '')
+ )if option._long_opts else ''
+ cmd_s = (" -s " + option._short_opts[0].replace('-', '')
+ ) if option._short_opts else ''
+ cmd_need_arg = ' -r ' if option.nargs in [1] else ''
+ cmd_helpstr = (" -d " + wrap(' '.join(option.help.split()))
+ ) if option.help else ''
+ cmd_arglist = (' -a ' + wrap(" ".join(option.choices))
+ ) if option.choices else ''
+
+ word += " ".join(BL_USE3.format(
+ name,
+ (cmd_need_arg + cmd_s + cmd_l + " -f " + cmd_arglist),
+ cmd_helpstr).split()) + "\n"
+
+ word = (word + " ".join(BL_USE3.format(
+ name,
+ ("-s " + "h " + "-l " + "help" + " -f "),
+ ('-d ' + wrap("print help") + "\n")
+ ).split()))
+ return word
+
+
+def clean_whitespace(word):
+ # Remove excess whitespace and tabs in a string
+ return " ".join(word.split())
+
+
+def wrap(word):
+ # Need " or ' around strings but watch out if they're in the string
+ sptoken = '\"'
+ if ('"') in word and ("'") in word:
+ word.replace('"', sptoken)
+ return '"' + word + '"'
+
+ tok = '"' if "'" in word else "'"
+ return tok + word + tok
diff --git a/lib/beetsplug/freedesktop.py b/lib/beetsplug/freedesktop.py
new file mode 100644
index 00000000..ba4d5879
--- /dev/null
+++ b/lib/beetsplug/freedesktop.py
@@ -0,0 +1,35 @@
+# This file is part of beets.
+# Copyright 2016, Matt Lichtenberg.
+#
+# 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.
+
+"""Creates freedesktop.org-compliant .directory files on an album level.
+"""
+
+
+from beets.plugins import BeetsPlugin
+from beets import ui
+
+
+class FreedesktopPlugin(BeetsPlugin):
+ def commands(self):
+ deprecated = ui.Subcommand(
+ "freedesktop",
+ help="Print a message to redirect to thumbnails --dolphin")
+ deprecated.func = self.deprecation_message
+ return [deprecated]
+
+ def deprecation_message(self, lib, opts, args):
+ ui.print_("This plugin is deprecated. Its functionality is "
+ "superseded by the 'thumbnails' plugin")
+ ui.print_("'thumbnails --dolphin' replaces freedesktop. See doc & "
+ "changelog for more information")
diff --git a/lib/beetsplug/fromfilename.py b/lib/beetsplug/fromfilename.py
new file mode 100644
index 00000000..55684a27
--- /dev/null
+++ b/lib/beetsplug/fromfilename.py
@@ -0,0 +1,162 @@
+# This file is part of beets.
+# Copyright 2016, Jan-Erik Dahlin
+#
+# 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.
+
+"""If the title is empty, try to extract track and title from the
+filename.
+"""
+
+from beets import plugins
+from beets.util import displayable_path
+import os
+import re
+
+
+# Filename field extraction patterns.
+PATTERNS = [
+ # Useful patterns.
+ r'^(?P.+)[\-_](?P.+)[\-_](?P<tag>.*)$',
+ r'^(?P<track>\d+)[\s.\-_]+(?P<artist>.+)[\-_](?P<title>.+)[\-_](?P<tag>.*)$',
+ r'^(?P<artist>.+)[\-_](?P<title>.+)$',
+ r'^(?P<track>\d+)[\s.\-_]+(?P<artist>.+)[\-_](?P<title>.+)$',
+ r'^(?P<title>.+)$',
+ r'^(?P<track>\d+)[\s.\-_]+(?P<title>.+)$',
+ r'^(?P<track>\d+)\s+(?P<title>.+)$',
+ r'^(?P<title>.+) by (?P<artist>.+)$',
+ r'^(?P<track>\d+).*$',
+]
+
+# Titles considered "empty" and in need of replacement.
+BAD_TITLE_PATTERNS = [
+ r'^$',
+]
+
+
+def equal(seq):
+ """Determine whether a sequence holds identical elements.
+ """
+ return len(set(seq)) <= 1
+
+
+def equal_fields(matchdict, field):
+ """Do all items in `matchdict`, whose values are dictionaries, have
+ the same value for `field`? (If they do, the field is probably not
+ the title.)
+ """
+ return equal(m[field] for m in matchdict.values())
+
+
+def all_matches(names, pattern):
+ """If all the filenames in the item/filename mapping match the
+ pattern, return a dictionary mapping the items to dictionaries
+ giving the value for each named subpattern in the match. Otherwise,
+ return None.
+ """
+ matches = {}
+ for item, name in names.items():
+ m = re.match(pattern, name, re.IGNORECASE)
+ if m and m.groupdict():
+ # Only yield a match when the regex applies *and* has
+ # capture groups. Otherwise, no information can be extracted
+ # from the filename.
+ matches[item] = m.groupdict()
+ else:
+ return None
+ return matches
+
+
+def bad_title(title):
+ """Determine whether a given title is "bad" (empty or otherwise
+ meaningless) and in need of replacement.
+ """
+ for pat in BAD_TITLE_PATTERNS:
+ if re.match(pat, title, re.IGNORECASE):
+ return True
+ return False
+
+
+def apply_matches(d):
+ """Given a mapping from items to field dicts, apply the fields to
+ the objects.
+ """
+ some_map = list(d.values())[0]
+ keys = some_map.keys()
+
+ # Only proceed if the "tag" field is equal across all filenames.
+ if 'tag' in keys and not equal_fields(d, 'tag'):
+ return
+
+ # Given both an "artist" and "title" field, assume that one is
+ # *actually* the artist, which must be uniform, and use the other
+ # for the title. This, of course, won't work for VA albums.
+ if 'artist' in keys:
+ if equal_fields(d, 'artist'):
+ artist = some_map['artist']
+ title_field = 'title'
+ elif equal_fields(d, 'title'):
+ artist = some_map['title']
+ title_field = 'artist'
+ else:
+ # Both vary. Abort.
+ return
+
+ for item in d:
+ if not item.artist:
+ item.artist = artist
+
+ # No artist field: remaining field is the title.
+ else:
+ title_field = 'title'
+
+ # Apply the title and track.
+ for item in d:
+ if bad_title(item.title):
+ item.title = str(d[item][title_field])
+ if 'track' in d[item] and item.track == 0:
+ item.track = int(d[item]['track'])
+
+
+# Plugin structure and hook into import process.
+
+class FromFilenamePlugin(plugins.BeetsPlugin):
+ def __init__(self):
+ super().__init__()
+ self.register_listener('import_task_start', filename_task)
+
+
+def filename_task(task, session):
+ """Examine each item in the task to see if we can extract a title
+ from the filename. Try to match all filenames to a number of
+ regexps, starting with the most complex patterns and successively
+ trying less complex patterns. As soon as all filenames match the
+ same regex we can make an educated guess of which part of the
+ regex that contains the title.
+ """
+ items = task.items if task.is_album else [task.item]
+
+ # Look for suspicious (empty or meaningless) titles.
+ missing_titles = sum(bad_title(i.title) for i in items)
+
+ if missing_titles:
+ # Get the base filenames (no path or extension).
+ names = {}
+ for item in items:
+ path = displayable_path(item.path)
+ name, _ = os.path.splitext(os.path.basename(path))
+ names[item] = name
+
+ # Look for useful information in the filenames.
+ for pattern in PATTERNS:
+ d = all_matches(names, pattern)
+ if d:
+ apply_matches(d)
diff --git a/lib/beetsplug/ftintitle.py b/lib/beetsplug/ftintitle.py
new file mode 100644
index 00000000..57863d2b
--- /dev/null
+++ b/lib/beetsplug/ftintitle.py
@@ -0,0 +1,166 @@
+# This file is part of beets.
+# Copyright 2016, Verrus, <github.com/Verrus/beets-plugin-featInTitle>
+#
+# 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.
+
+"""Moves "featured" artists to the title from the artist field.
+"""
+
+import re
+
+from beets import plugins
+from beets import ui
+from beets.util import displayable_path
+
+
+def split_on_feat(artist):
+ """Given an artist string, split the "main" artist from any artist
+ on the right-hand side of a string like "feat". Return the main
+ artist, which is always a string, and the featuring artist, which
+ may be a string or None if none is present.
+ """
+ # split on the first "feat".
+ regex = re.compile(plugins.feat_tokens(), re.IGNORECASE)
+ parts = [s.strip() for s in regex.split(artist, 1)]
+ if len(parts) == 1:
+ return parts[0], None
+ else:
+ return tuple(parts)
+
+
+def contains_feat(title):
+ """Determine whether the title contains a "featured" marker.
+ """
+ return bool(re.search(plugins.feat_tokens(), title, flags=re.IGNORECASE))
+
+
+def find_feat_part(artist, albumartist):
+ """Attempt to find featured artists in the item's artist fields and
+ return the results. Returns None if no featured artist found.
+ """
+ # Look for the album artist in the artist field. If it's not
+ # present, give up.
+ albumartist_split = artist.split(albumartist, 1)
+ if len(albumartist_split) <= 1:
+ return None
+
+ # If the last element of the split (the right-hand side of the
+ # album artist) is nonempty, then it probably contains the
+ # featured artist.
+ elif albumartist_split[1] != '':
+ # Extract the featured artist from the right-hand side.
+ _, feat_part = split_on_feat(albumartist_split[1])
+ return feat_part
+
+ # Otherwise, if there's nothing on the right-hand side, look for a
+ # featuring artist on the left-hand side.
+ else:
+ lhs, rhs = split_on_feat(albumartist_split[0])
+ if lhs:
+ return lhs
+
+ return None
+
+
+class FtInTitlePlugin(plugins.BeetsPlugin):
+ def __init__(self):
+ super().__init__()
+
+ self.config.add({
+ 'auto': True,
+ 'drop': False,
+ 'format': 'feat. {0}',
+ })
+
+ self._command = ui.Subcommand(
+ 'ftintitle',
+ help='move featured artists to the title field')
+
+ self._command.parser.add_option(
+ '-d', '--drop', dest='drop',
+ action='store_true', default=None,
+ help='drop featuring from artists and ignore title update')
+
+ if self.config['auto']:
+ self.import_stages = [self.imported]
+
+ def commands(self):
+
+ def func(lib, opts, args):
+ self.config.set_args(opts)
+ drop_feat = self.config['drop'].get(bool)
+ write = ui.should_write()
+
+ for item in lib.items(ui.decargs(args)):
+ self.ft_in_title(item, drop_feat)
+ item.store()
+ if write:
+ item.try_write()
+
+ self._command.func = func
+ return [self._command]
+
+ def imported(self, session, task):
+ """Import hook for moving featuring artist automatically.
+ """
+ drop_feat = self.config['drop'].get(bool)
+
+ for item in task.imported_items():
+ self.ft_in_title(item, drop_feat)
+ item.store()
+
+ def update_metadata(self, item, feat_part, drop_feat):
+ """Choose how to add new artists to the title and set the new
+ metadata. Also, print out messages about any changes that are made.
+ If `drop_feat` is set, then do not add the artist to the title; just
+ remove it from the artist field.
+ """
+ # In all cases, update the artist fields.
+ self._log.info('artist: {0} -> {1}', item.artist, item.albumartist)
+ item.artist = item.albumartist
+ if item.artist_sort:
+ # Just strip the featured artist from the sort name.
+ item.artist_sort, _ = split_on_feat(item.artist_sort)
+
+ # Only update the title if it does not already contain a featured
+ # artist and if we do not drop featuring information.
+ if not drop_feat and not contains_feat(item.title):
+ feat_format = self.config['format'].as_str()
+ new_format = feat_format.format(feat_part)
+ new_title = f"{item.title} {new_format}"
+ self._log.info('title: {0} -> {1}', item.title, new_title)
+ item.title = new_title
+
+ def ft_in_title(self, item, drop_feat):
+ """Look for featured artists in the item's artist fields and move
+ them to the title.
+ """
+ artist = item.artist.strip()
+ albumartist = item.albumartist.strip()
+
+ # Check whether there is a featured artist on this track and the
+ # artist field does not exactly match the album artist field. In
+ # that case, we attempt to move the featured artist to the title.
+ _, featured = split_on_feat(artist)
+ if featured and albumartist != artist and albumartist:
+ self._log.info('{}', displayable_path(item.path))
+
+ feat_part = None
+
+ # Attempt to find the featured artist.
+ feat_part = find_feat_part(artist, albumartist)
+
+ # If we have a featuring artist, move it to the title.
+ if feat_part:
+ self.update_metadata(item, feat_part, drop_feat)
+ else:
+ self._log.info('no featuring artists found')
diff --git a/lib/beetsplug/fuzzy.py b/lib/beetsplug/fuzzy.py
new file mode 100644
index 00000000..41829639
--- /dev/null
+++ b/lib/beetsplug/fuzzy.py
@@ -0,0 +1,46 @@
+# This file is part of beets.
+# Copyright 2016, Philippe Mongeau.
+#
+# 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.
+
+"""Provides a fuzzy matching query.
+"""
+
+
+from beets.plugins import BeetsPlugin
+from beets.dbcore.query import StringFieldQuery
+from beets import config
+import difflib
+
+
+class FuzzyQuery(StringFieldQuery):
+ @classmethod
+ def string_match(cls, pattern, val):
+ # smartcase
+ if pattern.islower():
+ val = val.lower()
+ query_matcher = difflib.SequenceMatcher(None, pattern, val)
+ threshold = config['fuzzy']['threshold'].as_number()
+ return query_matcher.quick_ratio() >= threshold
+
+
+class FuzzyPlugin(BeetsPlugin):
+ def __init__(self):
+ super().__init__()
+ self.config.add({
+ 'prefix': '~',
+ 'threshold': 0.7,
+ })
+
+ def queries(self):
+ prefix = self.config['prefix'].as_str()
+ return {prefix: FuzzyQuery}
diff --git a/lib/beetsplug/gmusic.py b/lib/beetsplug/gmusic.py
new file mode 100644
index 00000000..844234f9
--- /dev/null
+++ b/lib/beetsplug/gmusic.py
@@ -0,0 +1,25 @@
+# This file is part of beets.
+#
+# 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.
+
+"""Deprecation warning for the removed gmusic plugin."""
+
+from beets.plugins import BeetsPlugin
+
+
+class Gmusic(BeetsPlugin):
+ def __init__(self):
+ super().__init__()
+
+ self._log.warning("The 'gmusic' plugin has been removed following the"
+ " shutdown of Google Play Music. Remove the plugin"
+ " from your configuration to silence this warning.")
diff --git a/lib/beetsplug/hook.py b/lib/beetsplug/hook.py
new file mode 100644
index 00000000..0fe3bffc
--- /dev/null
+++ b/lib/beetsplug/hook.py
@@ -0,0 +1,115 @@
+# This file is part of beets.
+# Copyright 2015, Adrian Sampson.
+#
+# 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.
+
+"""Allows custom commands to be run when an event is emitted by beets"""
+
+import string
+import subprocess
+import shlex
+
+from beets.plugins import BeetsPlugin
+from beets.util import arg_encoding
+
+
+class CodingFormatter(string.Formatter):
+ """A variant of `string.Formatter` that converts everything to `unicode`
+ strings.
+
+ This is necessary on Python 2, where formatting otherwise occurs on
+ bytestrings. It intercepts two points in the formatting process to decode
+ the format string and all fields using the specified encoding. If decoding
+ fails, the values are used as-is.
+ """
+
+ def __init__(self, coding):
+ """Creates a new coding formatter with the provided coding."""
+ self._coding = coding
+
+ def format(self, format_string, *args, **kwargs):
+ """Formats the provided string using the provided arguments and keyword
+ arguments.
+
+ This method decodes the format string using the formatter's coding.
+
+ See str.format and string.Formatter.format.
+ """
+ if isinstance(format_string, bytes):
+ format_string = format_string.decode(self._coding)
+
+ return super().format(format_string, *args,
+ **kwargs)
+
+ def convert_field(self, value, conversion):
+ """Converts the provided value given a conversion type.
+
+ This method decodes the converted value using the formatter's coding.
+
+ See string.Formatter.convert_field.
+ """
+ converted = super().convert_field(value,
+ conversion)
+
+ if isinstance(converted, bytes):
+ return converted.decode(self._coding)
+
+ return converted
+
+
+class HookPlugin(BeetsPlugin):
+ """Allows custom commands to be run when an event is emitted by beets"""
+
+ def __init__(self):
+ super().__init__()
+
+ self.config.add({
+ 'hooks': []
+ })
+
+ hooks = self.config['hooks'].get(list)
+
+ for hook_index in range(len(hooks)):
+ hook = self.config['hooks'][hook_index]
+
+ hook_event = hook['event'].as_str()
+ hook_command = hook['command'].as_str()
+
+ self.create_and_register_hook(hook_event, hook_command)
+
+ def create_and_register_hook(self, event, command):
+ def hook_function(**kwargs):
+ if command is None or len(command) == 0:
+ self._log.error('invalid command "{0}"', command)
+ return
+
+ # Use a string formatter that works on Unicode strings.
+ formatter = CodingFormatter(arg_encoding())
+
+ command_pieces = shlex.split(command)
+
+ for i, piece in enumerate(command_pieces):
+ command_pieces[i] = formatter.format(piece, event=event,
+ **kwargs)
+
+ self._log.debug('running command "{0}" for event {1}',
+ ' '.join(command_pieces), event)
+
+ try:
+ subprocess.check_call(command_pieces)
+ except subprocess.CalledProcessError as exc:
+ self._log.error('hook for {0} exited with status {1}',
+ event, exc.returncode)
+ except OSError as exc:
+ self._log.error('hook for {0} failed: {1}', event, exc)
+
+ self.register_listener(event, hook_function)
diff --git a/lib/beetsplug/ihate.py b/lib/beetsplug/ihate.py
new file mode 100644
index 00000000..91850e09
--- /dev/null
+++ b/lib/beetsplug/ihate.py
@@ -0,0 +1,80 @@
+# This file is part of beets.
+# Copyright 2016, Blemjhoo Tezoulbr <baobab@heresiarch.info>.
+#
+# 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.
+
+
+"""Warns you about things you hate (or even blocks import)."""
+
+from beets.plugins import BeetsPlugin
+from beets.importer import action
+from beets.library import parse_query_string
+from beets.library import Item
+from beets.library import Album
+
+
+__author__ = 'baobab@heresiarch.info'
+__version__ = '2.0'
+
+
+def summary(task):
+ """Given an ImportTask, produce a short string identifying the
+ object.
+ """
+ if task.is_album:
+ return f'{task.cur_artist} - {task.cur_album}'
+ else:
+ return f'{task.item.artist} - {task.item.title}'
+
+
+class IHatePlugin(BeetsPlugin):
+ def __init__(self):
+ super().__init__()
+ self.register_listener('import_task_choice',
+ self.import_task_choice_event)
+ self.config.add({
+ 'warn': [],
+ 'skip': [],
+ })
+
+ @classmethod
+ def do_i_hate_this(cls, task, action_patterns):
+ """Process group of patterns (warn or skip) and returns True if
+ task is hated and not whitelisted.
+ """
+ if action_patterns:
+ for query_string in action_patterns:
+ query, _ = parse_query_string(
+ query_string,
+ Album if task.is_album else Item,
+ )
+ if any(query.match(item) for item in task.imported_items()):
+ return True
+ return False
+
+ def import_task_choice_event(self, session, task):
+ skip_queries = self.config['skip'].as_str_seq()
+ warn_queries = self.config['warn'].as_str_seq()
+
+ if task.choice_flag == action.APPLY:
+ if skip_queries or warn_queries:
+ self._log.debug('processing your hate')
+ if self.do_i_hate_this(task, skip_queries):
+ task.choice_flag = action.SKIP
+ self._log.info('skipped: {0}', summary(task))
+ return
+ if self.do_i_hate_this(task, warn_queries):
+ self._log.info('you may hate this: {0}', summary(task))
+ else:
+ self._log.debug('nothing to do')
+ else:
+ self._log.debug('user made a decision, nothing to do')
diff --git a/lib/beetsplug/importadded.py b/lib/beetsplug/importadded.py
new file mode 100644
index 00000000..e6665e0f
--- /dev/null
+++ b/lib/beetsplug/importadded.py
@@ -0,0 +1,132 @@
+"""Populate an item's `added` and `mtime` fields by using the file
+modification time (mtime) of the item's source file before import.
+
+Reimported albums and items are skipped.
+"""
+
+import os
+
+from beets import util
+from beets import importer
+from beets.plugins import BeetsPlugin
+
+
+class ImportAddedPlugin(BeetsPlugin):
+ def __init__(self):
+ super().__init__()
+ self.config.add({
+ 'preserve_mtimes': False,
+ 'preserve_write_mtimes': False,
+ })
+
+ # item.id for new items that were reimported
+ self.reimported_item_ids = None
+ # album.path for old albums that were replaced by a reimported album
+ self.replaced_album_paths = None
+ # item path in the library to the mtime of the source file
+ self.item_mtime = {}
+
+ register = self.register_listener
+ register('import_task_created', self.check_config)
+ register('import_task_created', self.record_if_inplace)
+ register('import_task_files', self.record_reimported)
+ register('before_item_moved', self.record_import_mtime)
+ register('item_copied', self.record_import_mtime)
+ register('item_linked', self.record_import_mtime)
+ register('item_hardlinked', self.record_import_mtime)
+ register('album_imported', self.update_album_times)
+ register('item_imported', self.update_item_times)
+ register('after_write', self.update_after_write_time)
+
+ def check_config(self, task, session):
+ self.config['preserve_mtimes'].get(bool)
+
+ def reimported_item(self, item):
+ return item.id in self.reimported_item_ids
+
+ def reimported_album(self, album):
+ return album.path in self.replaced_album_paths
+
+ def record_if_inplace(self, task, session):
+ if not (session.config['copy'] or session.config['move'] or
+ session.config['link'] or session.config['hardlink']):
+ self._log.debug("In place import detected, recording mtimes from "
+ "source paths")
+ items = [task.item] \
+ if isinstance(task, importer.SingletonImportTask) \
+ else task.items
+ for item in items:
+ self.record_import_mtime(item, item.path, item.path)
+
+ def record_reimported(self, task, session):
+ self.reimported_item_ids = {item.id for item, replaced_items
+ in task.replaced_items.items()
+ if replaced_items}
+ self.replaced_album_paths = set(task.replaced_albums.keys())
+
+ def write_file_mtime(self, path, mtime):
+ """Write the given mtime to the destination path.
+ """
+ stat = os.stat(util.syspath(path))
+ os.utime(util.syspath(path), (stat.st_atime, mtime))
+
+ def write_item_mtime(self, item, mtime):
+ """Write the given mtime to an item's `mtime` field and to the mtime
+ of the item's file.
+ """
+ # The file's mtime on disk must be in sync with the item's mtime
+ self.write_file_mtime(util.syspath(item.path), mtime)
+ item.mtime = mtime
+
+ def record_import_mtime(self, item, source, destination):
+ """Record the file mtime of an item's path before its import.
+ """
+ mtime = os.stat(util.syspath(source)).st_mtime
+ self.item_mtime[destination] = mtime
+ self._log.debug("Recorded mtime {0} for item '{1}' imported from "
+ "'{2}'", mtime, util.displayable_path(destination),
+ util.displayable_path(source))
+
+ def update_album_times(self, lib, album):
+ if self.reimported_album(album):
+ self._log.debug("Album '{0}' is reimported, skipping import of "
+ "added dates for the album and its items.",
+ util.displayable_path(album.path))
+ return
+
+ album_mtimes = []
+ for item in album.items():
+ mtime = self.item_mtime.pop(item.path, None)
+ if mtime:
+ album_mtimes.append(mtime)
+ if self.config['preserve_mtimes'].get(bool):
+ self.write_item_mtime(item, mtime)
+ item.store()
+ album.added = min(album_mtimes)
+ self._log.debug("Import of album '{0}', selected album.added={1} "
+ "from item file mtimes.", album.album, album.added)
+ album.store()
+
+ def update_item_times(self, lib, item):
+ if self.reimported_item(item):
+ self._log.debug("Item '{0}' is reimported, skipping import of "
+ "added date.", util.displayable_path(item.path))
+ return
+ mtime = self.item_mtime.pop(item.path, None)
+ if mtime:
+ item.added = mtime
+ if self.config['preserve_mtimes'].get(bool):
+ self.write_item_mtime(item, mtime)
+ self._log.debug("Import of item '{0}', selected item.added={1}",
+ util.displayable_path(item.path), item.added)
+ item.store()
+
+ def update_after_write_time(self, item, path):
+ """Update the mtime of the item's file with the item.added value
+ after each write of the item if `preserve_write_mtimes` is enabled.
+ """
+ if item.added:
+ if self.config['preserve_write_mtimes'].get(bool):
+ self.write_item_mtime(item, item.added)
+ self._log.debug("Write of item '{0}', selected item.added={1}",
+ util.displayable_path(item.path), item.added)
diff --git a/lib/beetsplug/importfeeds.py b/lib/beetsplug/importfeeds.py
new file mode 100644
index 00000000..ad6d8415
--- /dev/null
+++ b/lib/beetsplug/importfeeds.py
@@ -0,0 +1,127 @@
+# This file is part of beets.
+# Copyright 2016, Fabrice Laporte.
+#
+# 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.
+
+
+"""Write paths of imported files in various formats to ease later import in a
+music player. Also allow printing the new file locations to stdout in case
+one wants to manually add music to a player by its path.
+"""
+import datetime
+import os
+import re
+
+from beets.plugins import BeetsPlugin
+from beets.util import mkdirall, normpath, syspath, bytestring_path, link
+from beets import config
+
+M3U_DEFAULT_NAME = 'imported.m3u'
+
+
+def _build_m3u_filename(basename):
+ """Builds unique m3u filename by appending given basename to current
+ date."""
+
+ basename = re.sub(r"[\s,/\\'\"]", '_', basename)
+ date = datetime.datetime.now().strftime("%Y%m%d_%Hh%M")
+ path = normpath(os.path.join(
+ config['importfeeds']['dir'].as_filename(),
+ date + '_' + basename + '.m3u'
+ ))
+ return path
+
+
+def _write_m3u(m3u_path, items_paths):
+ """Append relative paths to items into m3u file.
+ """
+ mkdirall(m3u_path)
+ with open(syspath(m3u_path), 'ab') as f:
+ for path in items_paths:
+ f.write(path + b'\n')
+
+
+class ImportFeedsPlugin(BeetsPlugin):
+ def __init__(self):
+ super().__init__()
+
+ self.config.add({
+ 'formats': [],
+ 'm3u_name': 'imported.m3u',
+ 'dir': None,
+ 'relative_to': None,
+ 'absolute_path': False,
+ })
+
+ relative_to = self.config['relative_to'].get()
+ if relative_to:
+ self.config['relative_to'] = normpath(relative_to)
+ else:
+ self.config['relative_to'] = self.get_feeds_dir()
+
+ self.register_listener('album_imported', self.album_imported)
+ self.register_listener('item_imported', self.item_imported)
+
+ def get_feeds_dir(self):
+ feeds_dir = self.config['dir'].get()
+ if feeds_dir:
+ return os.path.expanduser(bytestring_path(feeds_dir))
+ return config['directory'].as_filename()
+
+ def _record_items(self, lib, basename, items):
+ """Records relative paths to the given items for each feed format
+ """
+ feedsdir = bytestring_path(self.get_feeds_dir())
+ formats = self.config['formats'].as_str_seq()
+ relative_to = self.config['relative_to'].get() \
+ or self.get_feeds_dir()
+ relative_to = bytestring_path(relative_to)
+
+ paths = []
+ for item in items:
+ if self.config['absolute_path']:
+ paths.append(item.path)
+ else:
+ try:
+ relpath = os.path.relpath(item.path, relative_to)
+ except ValueError:
+ # On Windows, it is sometimes not possible to construct a
+ # relative path (if the files are on different disks).
+ relpath = item.path
+ paths.append(relpath)
+
+ if 'm3u' in formats:
+ m3u_basename = bytestring_path(
+ self.config['m3u_name'].as_str())
+ m3u_path = os.path.join(feedsdir, m3u_basename)
+ _write_m3u(m3u_path, paths)
+
+ if 'm3u_multi' in formats:
+ m3u_path = _build_m3u_filename(basename)
+ _write_m3u(m3u_path, paths)
+
+ if 'link' in formats:
+ for path in paths:
+ dest = os.path.join(feedsdir, os.path.basename(path))
+ if not os.path.exists(syspath(dest)):
+ link(path, dest)
+
+ if 'echo' in formats:
+ self._log.info("Location of imported music:")
+ for path in paths:
+ self._log.info(" {0}", path)
+
+ def album_imported(self, lib, album):
+ self._record_items(lib, album.album, album.items())
+
+ def item_imported(self, lib, item):
+ self._record_items(lib, item.title, [item])
diff --git a/lib/beetsplug/info.py b/lib/beetsplug/info.py
new file mode 100644
index 00000000..1e6d4b32
--- /dev/null
+++ b/lib/beetsplug/info.py
@@ -0,0 +1,229 @@
+# This file is part of beets.
+# Copyright 2016, Adrian Sampson.
+#
+# 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.
+
+"""Shows file metadata.
+"""
+
+
+import os
+
+from beets.plugins import BeetsPlugin
+from beets import ui
+import mediafile
+from beets.library import Item
+from beets.util import displayable_path, normpath, syspath
+
+
+def tag_data(lib, args, album=False):
+ query = []
+ for arg in args:
+ path = normpath(arg)
+ if os.path.isfile(syspath(path)):
+ yield tag_data_emitter(path)
+ else:
+ query.append(arg)
+
+ if query:
+ for item in lib.items(query):
+ yield tag_data_emitter(item.path)
+
+
+def tag_fields():
+ fields = set(mediafile.MediaFile.readable_fields())
+ fields.add('art')
+ return fields
+
+
+def tag_data_emitter(path):
+ def emitter(included_keys):
+ if included_keys == '*':
+ fields = tag_fields()
+ else:
+ fields = included_keys
+ if 'images' in fields:
+ # We can't serialize the image data.
+ fields.remove('images')
+ mf = mediafile.MediaFile(syspath(path))
+ tags = {}
+ for field in fields:
+ if field == 'art':
+ tags[field] = mf.art is not None
+ else:
+ tags[field] = getattr(mf, field, None)
+
+ # create a temporary Item to take advantage of __format__
+ item = Item.from_path(syspath(path))
+
+ return tags, item
+ return emitter
+
+
+def library_data(lib, args, album=False):
+ for item in lib.albums(args) if album else lib.items(args):
+ yield library_data_emitter(item)
+
+
+def library_data_emitter(item):
+ def emitter(included_keys):
+ data = dict(item.formatted(included_keys=included_keys))
+
+ return data, item
+ return emitter
+
+
+def update_summary(summary, tags):
+ for key, value in tags.items():
+ if key not in summary:
+ summary[key] = value
+ elif summary[key] != value:
+ summary[key] = '[various]'
+ return summary
+
+
+def print_data(data, item=None, fmt=None):
+ """Print, with optional formatting, the fields of a single element.
+
+ If no format string `fmt` is passed, the entries on `data` are printed one
+ in each line, with the format 'field: value'. If `fmt` is not `None`, the
+ `item` is printed according to `fmt`, using the `Item.__format__`
+ machinery.
+ """
+ if fmt:
+ # use fmt specified by the user
+ ui.print_(format(item, fmt))
+ return
+
+ path = displayable_path(item.path) if item else None
+ formatted = {}
+ for key, value in data.items():
+ if isinstance(value, list):
+ formatted[key] = '; '.join(value)
+ if value is not None:
+ formatted[key] = value
+
+ if len(formatted) == 0:
+ return
+
+ maxwidth = max(len(key) for key in formatted)
+ lineformat = f'{{0:>{maxwidth}}}: {{1}}'
+
+ if path:
+ ui.print_(displayable_path(path))
+
+ for field in sorted(formatted):
+ value = formatted[field]
+ if isinstance(value, list):
+ value = '; '.join(value)
+ ui.print_(lineformat.format(field, value))
+
+
+def print_data_keys(data, item=None):
+ """Print only the keys (field names) for an item.
+ """
+ path = displayable_path(item.path) if item else None
+ formatted = []
+ for key, value in data.items():
+ formatted.append(key)
+
+ if len(formatted) == 0:
+ return
+
+ line_format = '{0}{{0}}'.format(' ' * 4)
+ if path:
+ ui.print_(displayable_path(path))
+
+ for field in sorted(formatted):
+ ui.print_(line_format.format(field))
+
+
+class InfoPlugin(BeetsPlugin):
+
+ def commands(self):
+ cmd = ui.Subcommand('info', help='show file metadata')
+ cmd.func = self.run
+ cmd.parser.add_option(
+ '-l', '--library', action='store_true',
+ help='show library fields instead of tags',
+ )
+ cmd.parser.add_option(
+ '-a', '--album', action='store_true',
+ help='show album fields instead of tracks (implies "--library")',
+ )
+ cmd.parser.add_option(
+ '-s', '--summarize', action='store_true',
+ help='summarize the tags of all files',
+ )
+ cmd.parser.add_option(
+ '-i', '--include-keys', default=[],
+ action='append', dest='included_keys',
+ help='comma separated list of keys to show',
+ )
+ cmd.parser.add_option(
+ '-k', '--keys-only', action='store_true',
+ help='show only the keys',
+ )
+ cmd.parser.add_format_option(target='item')
+ return [cmd]
+
+ def run(self, lib, opts, args):
+ """Print tag info or library data for each file referenced by args.
+
+ Main entry point for the `beet info ARGS...` command.
+
+ If an argument is a path pointing to an existing file, then the tags
+ of that file are printed. All other arguments are considered
+ queries, and for each item matching all those queries the tags from
+ the file are printed.
+
+ If `opts.summarize` is true, the function merges all tags into one
+ dictionary and only prints that. If two files have different values
+ for the same tag, the value is set to '[various]'
+ """
+ if opts.library or opts.album:
+ data_collector = library_data
+ else:
+ data_collector = tag_data
+
+ included_keys = []
+ for keys in opts.included_keys:
+ included_keys.extend(keys.split(','))
+ # Drop path even if user provides it multiple times
+ included_keys = [k for k in included_keys if k != 'path']
+
+ first = True
+ summary = {}
+ for data_emitter in data_collector(
+ lib, ui.decargs(args),
+ album=opts.album,
+ ):
+ try:
+ data, item = data_emitter(included_keys or '*')
+ except (mediafile.UnreadableFileError, OSError) as ex:
+ self._log.error('cannot read file: {0}', ex)
+ continue
+
+ if opts.summarize:
+ update_summary(summary, data)
+ else:
+ if not first:
+ ui.print_()
+ if opts.keys_only:
+ print_data_keys(data, item)
+ else:
+ fmt = ui.decargs([opts.format])[0] if opts.format else None
+ print_data(data, item, fmt)
+ first = False
+
+ if opts.summarize:
+ print_data(summary)
diff --git a/lib/beetsplug/inline.py b/lib/beetsplug/inline.py
new file mode 100644
index 00000000..e19eaa9d
--- /dev/null
+++ b/lib/beetsplug/inline.py
@@ -0,0 +1,126 @@
+# This file is part of beets.
+# Copyright 2016, Adrian Sampson.
+#
+# 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.
+
+"""Allows inline path template customization code in the config file.
+"""
+
+import traceback
+import itertools
+
+from beets.plugins import BeetsPlugin
+from beets import config
+
+FUNC_NAME = '__INLINE_FUNC__'
+
+
+class InlineError(Exception):
+ """Raised when a runtime error occurs in an inline expression.
+ """
+ def __init__(self, code, exc):
+ super().__init__(
+ ("error in inline path field code:\n"
+ "%s\n%s: %s") % (code, type(exc).__name__, str(exc))
+ )
+
+
+def _compile_func(body):
+ """Given Python code for a function body, return a compiled
+ callable that invokes that code.
+ """
+ body = 'def {}():\n {}'.format(
+ FUNC_NAME,
+ body.replace('\n', '\n ')
+ )
+ code = compile(body, 'inline', 'exec')
+ env = {}
+ eval(code, env)
+ return env[FUNC_NAME]
+
+
+class InlinePlugin(BeetsPlugin):
+ def __init__(self):
+ super().__init__()
+
+ config.add({
+ 'pathfields': {}, # Legacy name.
+ 'item_fields': {},
+ 'album_fields': {},
+ })
+
+ # Item fields.
+ for key, view in itertools.chain(config['item_fields'].items(),
+ config['pathfields'].items()):
+ self._log.debug('adding item field {0}', key)
+ func = self.compile_inline(view.as_str(), False)
+ if func is not None:
+ self.template_fields[key] = func
+
+ # Album fields.
+ for key, view in config['album_fields'].items():
+ self._log.debug('adding album field {0}', key)
+ func = self.compile_inline(view.as_str(), True)
+ if func is not None:
+ self.album_template_fields[key] = func
+
+ def compile_inline(self, python_code, album):
+ """Given a Python expression or function body, compile it as a path
+ field function. The returned function takes a single argument, an
+ Item, and returns a Unicode string. If the expression cannot be
+ compiled, then an error is logged and this function returns None.
+ """
+ # First, try compiling as a single function.
+ try:
+ code = compile(f'({python_code})', 'inline', 'eval')
+ except SyntaxError:
+ # Fall back to a function body.
+ try:
+ func = _compile_func(python_code)
+ except SyntaxError:
+ self._log.error('syntax error in inline field definition:\n'
+ '{0}', traceback.format_exc())
+ return
+ else:
+ is_expr = False
+ else:
+ is_expr = True
+
+ def _dict_for(obj):
+ out = dict(obj)
+ if album:
+ out['items'] = list(obj.items())
+ return out
+
+ if is_expr:
+ # For expressions, just evaluate and return the result.
+ def _expr_func(obj):
+ values = _dict_for(obj)
+ try:
+ return eval(code, values)
+ except Exception as exc:
+ raise InlineError(python_code, exc)
+ return _expr_func
+ else:
+ # For function bodies, invoke the function with values as global
+ # variables.
+ def _func_func(obj):
+ old_globals = dict(func.__globals__)
+ func.__globals__.update(_dict_for(obj))
+ try:
+ return func()
+ except Exception as exc:
+ raise InlineError(python_code, exc)
+ finally:
+ func.__globals__.clear()
+ func.__globals__.update(old_globals)
+ return _func_func
diff --git a/lib/beetsplug/ipfs.py b/lib/beetsplug/ipfs.py
new file mode 100644
index 00000000..3c42e7c8
--- /dev/null
+++ b/lib/beetsplug/ipfs.py
@@ -0,0 +1,295 @@
+# This file is part of beets.
+#
+# 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.
+
+"""Adds support for ipfs. Requires go-ipfs and a running ipfs daemon
+"""
+
+
+from beets import ui, util, library, config
+from beets.plugins import BeetsPlugin
+
+import subprocess
+import shutil
+import os
+import tempfile
+
+
+class IPFSPlugin(BeetsPlugin):
+
+ def __init__(self):
+ super().__init__()
+ self.config.add({
+ 'auto': True,
+ 'nocopy': False,
+ })
+
+ if self.config['auto']:
+ self.import_stages = [self.auto_add]
+
+ def commands(self):
+ cmd = ui.Subcommand('ipfs',
+ help='interact with ipfs')
+ cmd.parser.add_option('-a', '--add', dest='add',
+ action='store_true',
+ help='Add to ipfs')
+ cmd.parser.add_option('-g', '--get', dest='get',
+ action='store_true',
+ help='Get from ipfs')
+ cmd.parser.add_option('-p', '--publish', dest='publish',
+ action='store_true',
+ help='Publish local library to ipfs')
+ cmd.parser.add_option('-i', '--import', dest='_import',
+ action='store_true',
+ help='Import remote library from ipfs')
+ cmd.parser.add_option('-l', '--list', dest='_list',
+ action='store_true',
+ help='Query imported libraries')
+ cmd.parser.add_option('-m', '--play', dest='play',
+ action='store_true',
+ help='Play music from remote libraries')
+
+ def func(lib, opts, args):
+ if opts.add:
+ for album in lib.albums(ui.decargs(args)):
+ if len(album.items()) == 0:
+ self._log.info('{0} does not contain items, aborting',
+ album)
+
+ self.ipfs_add(album)
+ album.store()
+
+ if opts.get:
+ self.ipfs_get(lib, ui.decargs(args))
+
+ if opts.publish:
+ self.ipfs_publish(lib)
+
+ if opts._import:
+ self.ipfs_import(lib, ui.decargs(args))
+
+ if opts._list:
+ self.ipfs_list(lib, ui.decargs(args))
+
+ if opts.play:
+ self.ipfs_play(lib, opts, ui.decargs(args))
+
+ cmd.func = func
+ return [cmd]
+
+ def auto_add(self, session, task):
+ if task.is_album:
+ if self.ipfs_add(task.album):
+ task.album.store()
+
+ def ipfs_play(self, lib, opts, args):
+ from beetsplug.play import PlayPlugin
+
+ jlib = self.get_remote_lib(lib)
+ player = PlayPlugin()
+ config['play']['relative_to'] = None
+ player.album = True
+ player.play_music(jlib, player, args)
+
+ def ipfs_add(self, album):
+ try:
+ album_dir = album.item_dir()
+ except AttributeError:
+ return False
+ try:
+ if album.ipfs:
+ self._log.debug('{0} already added', album_dir)
+ # Already added to ipfs
+ return False
+ except AttributeError:
+ pass
+
+ self._log.info('Adding {0} to ipfs', album_dir)
+
+ if self.config['nocopy']:
+ cmd = "ipfs add --nocopy -q -r".split()
+ else:
+ cmd = "ipfs add -q -r".split()
+ cmd.append(album_dir)
+ try:
+ output = util.command_output(cmd).stdout.split()
+ except (OSError, subprocess.CalledProcessError) as exc:
+ self._log.error('Failed to add {0}, error: {1}', album_dir, exc)
+ return False
+ length = len(output)
+
+ for linenr, line in enumerate(output):
+ line = line.strip()
+ if linenr == length - 1:
+ # last printed line is the album hash
+ self._log.info("album: {0}", line)
+ album.ipfs = line
+ else:
+ try:
+ item = album.items()[linenr]
+ self._log.info("item: {0}", line)
+ item.ipfs = line
+ item.store()
+ except IndexError:
+ # if there's non music files in the to-add folder they'll
+ # get ignored here
+ pass
+
+ return True
+
+ def ipfs_get(self, lib, query):
+ query = query[0]
+ # Check if query is a hash
+ # TODO: generalize to other hashes; probably use a multihash
+ # implementation
+ if query.startswith("Qm") and len(query) == 46:
+ self.ipfs_get_from_hash(lib, query)
+ else:
+ albums = self.query(lib, query)
+ for album in albums:
+ self.ipfs_get_from_hash(lib, album.ipfs)
+
+ def ipfs_get_from_hash(self, lib, _hash):
+ try:
+ cmd = "ipfs get".split()
+ cmd.append(_hash)
+ util.command_output(cmd)
+ except (OSError, subprocess.CalledProcessError) as err:
+ self._log.error('Failed to get {0} from ipfs.\n{1}',
+ _hash, err.output)
+ return False
+
+ self._log.info('Getting {0} from ipfs', _hash)
+ imp = ui.commands.TerminalImportSession(lib, loghandler=None,
+ query=None, paths=[_hash])
+ imp.run()
+ shutil.rmtree(_hash)
+
+ def ipfs_publish(self, lib):
+ with tempfile.NamedTemporaryFile() as tmp:
+ self.ipfs_added_albums(lib, tmp.name)
+ try:
+ if self.config['nocopy']:
+ cmd = "ipfs add --nocopy -q ".split()
+ else:
+ cmd = "ipfs add -q ".split()
+ cmd.append(tmp.name)
+ output = util.command_output(cmd).stdout
+ except (OSError, subprocess.CalledProcessError) as err:
+ msg = f"Failed to publish library. Error: {err}"
+ self._log.error(msg)
+ return False
+ self._log.info("hash of library: {0}", output)
+
+ def ipfs_import(self, lib, args):
+ _hash = args[0]
+ if len(args) > 1:
+ lib_name = args[1]
+ else:
+ lib_name = _hash
+ lib_root = os.path.dirname(lib.path)
+ remote_libs = os.path.join(lib_root, b"remotes")
+ if not os.path.exists(remote_libs):
+ try:
+ os.makedirs(remote_libs)
+ except OSError as e:
+ msg = f"Could not create {remote_libs}. Error: {e}"
+ self._log.error(msg)
+ return False
+ path = os.path.join(remote_libs, lib_name.encode() + b".db")
+ if not os.path.exists(path):
+ cmd = f"ipfs get {_hash} -o".split()
+ cmd.append(path)
+ try:
+ util.command_output(cmd)
+ except (OSError, subprocess.CalledProcessError):
+ self._log.error(f"Could not import {_hash}")
+ return False
+
+ # add all albums from remotes into a combined library
+ jpath = os.path.join(remote_libs, b"joined.db")
+ jlib = library.Library(jpath)
+ nlib = library.Library(path)
+ for album in nlib.albums():
+ if not self.already_added(album, jlib):
+ new_album = []
+ for item in album.items():
+ item.id = None
+ new_album.append(item)
+ added_album = jlib.add_album(new_album)
+ added_album.ipfs = album.ipfs
+ added_album.store()
+
+ def already_added(self, check, jlib):
+ for jalbum in jlib.albums():
+ if jalbum.mb_albumid == check.mb_albumid:
+ return True
+ return False
+
+ def ipfs_list(self, lib, args):
+ fmt = config['format_album'].get()
+ try:
+ albums = self.query(lib, args)
+ except OSError:
+ ui.print_("No imported libraries yet.")
+ return
+
+ for album in albums:
+ ui.print_(format(album, fmt), " : ", album.ipfs.decode())
+
+ def query(self, lib, args):
+ rlib = self.get_remote_lib(lib)
+ albums = rlib.albums(args)
+ return albums
+
+ def get_remote_lib(self, lib):
+ lib_root = os.path.dirname(lib.path)
+ remote_libs = os.path.join(lib_root, b"remotes")
+ path = os.path.join(remote_libs, b"joined.db")
+ if not os.path.isfile(path):
+ raise OSError
+ return library.Library(path)
+
+ def ipfs_added_albums(self, rlib, tmpname):
+ """ Returns a new library with only albums/items added to ipfs
+ """
+ tmplib = library.Library(tmpname)
+ for album in rlib.albums():
+ try:
+ if album.ipfs:
+ self.create_new_album(album, tmplib)
+ except AttributeError:
+ pass
+ return tmplib
+
+ def create_new_album(self, album, tmplib):
+ items = []
+ for item in album.items():
+ try:
+ if not item.ipfs:
+ break
+ except AttributeError:
+ pass
+ item_path = os.path.basename(item.path).decode(
+ util._fsencoding(), 'ignore'
+ )
+ # Clear current path from item
+ item.path = f'/ipfs/{album.ipfs}/{item_path}'
+
+ item.id = None
+ items.append(item)
+ if len(items) < 1:
+ return False
+ self._log.info("Adding '{0}' to temporary library", album)
+ new_album = tmplib.add_album(items)
+ new_album.ipfs = album.ipfs
+ new_album.store()
diff --git a/lib/beetsplug/keyfinder.py b/lib/beetsplug/keyfinder.py
new file mode 100644
index 00000000..b695ab54
--- /dev/null
+++ b/lib/beetsplug/keyfinder.py
@@ -0,0 +1,97 @@
+# This file is part of beets.
+# Copyright 2016, Thomas Scholtes.
+#
+# 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.
+
+"""Uses the `KeyFinder` program to add the `initial_key` field.
+"""
+
+
+import os.path
+import subprocess
+
+from beets import ui
+from beets import util
+from beets.plugins import BeetsPlugin
+
+
+class KeyFinderPlugin(BeetsPlugin):
+
+ def __init__(self):
+ super().__init__()
+ self.config.add({
+ 'bin': 'KeyFinder',
+ 'auto': True,
+ 'overwrite': False,
+ })
+
+ if self.config['auto'].get(bool):
+ self.import_stages = [self.imported]
+
+ def commands(self):
+ cmd = ui.Subcommand('keyfinder',
+ help='detect and add initial key from audio')
+ cmd.func = self.command
+ return [cmd]
+
+ def command(self, lib, opts, args):
+ self.find_key(lib.items(ui.decargs(args)), write=ui.should_write())
+
+ def imported(self, session, task):
+ self.find_key(task.imported_items())
+
+ def find_key(self, items, write=False):
+ overwrite = self.config['overwrite'].get(bool)
+ command = [self.config['bin'].as_str()]
+ # The KeyFinder GUI program needs the -f flag before the path.
+ # keyfinder-cli is similar, but just wants the path with no flag.
+ if 'keyfinder-cli' not in os.path.basename(command[0]).lower():
+ command.append('-f')
+
+ for item in items:
+ if item['initial_key'] and not overwrite:
+ continue
+
+ try:
+ output = util.command_output(command + [util.syspath(
+ item.path)]).stdout
+ except (subprocess.CalledProcessError, OSError) as exc:
+ self._log.error('execution failed: {0}', exc)
+ continue
+ except UnicodeEncodeError:
+ # Workaround for Python 2 Windows bug.
+ # https://bugs.python.org/issue1759845
+ self._log.error('execution failed for Unicode path: {0!r}',
+ item.path)
+ continue
+
+ try:
+ key_raw = output.rsplit(None, 1)[-1]
+ except IndexError:
+ # Sometimes keyfinder-cli returns 0 but with no key, usually
+ # when the file is silent or corrupt, so we log and skip.
+ self._log.error('no key returned for path: {0}', item.path)
+ continue
+
+ try:
+ key = util.text_string(key_raw)
+ except UnicodeDecodeError:
+ self._log.error('output is invalid UTF-8')
+ continue
+
+ item['initial_key'] = key
+ self._log.info('added computed initial key {0} for {1}',
+ key, util.displayable_path(item.path))
+
+ if write:
+ item.try_write()
+ item.store()
diff --git a/lib/beetsplug/kodiupdate.py b/lib/beetsplug/kodiupdate.py
new file mode 100644
index 00000000..2a885d2c
--- /dev/null
+++ b/lib/beetsplug/kodiupdate.py
@@ -0,0 +1,95 @@
+# This file is part of beets.
+# Copyright 2017, Pauli Kettunen.
+#
+# 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.
+
+"""Updates a Kodi library whenever the beets library is changed.
+This is based on the Plex Update plugin.
+
+Put something like the following in your config.yaml to configure:
+ kodi:
+ host: localhost
+ port: 8080
+ user: user
+ pwd: secret
+"""
+
+import requests
+from beets import config
+from beets.plugins import BeetsPlugin
+
+
+def update_kodi(host, port, user, password):
+ """Sends request to the Kodi api to start a library refresh.
+ """
+ url = f"http://{host}:{port}/jsonrpc"
+
+ """Content-Type: application/json is mandatory
+ according to the kodi jsonrpc documentation"""
+
+ headers = {'Content-Type': 'application/json'}
+
+ # Create the payload. Id seems to be mandatory.
+ payload = {'jsonrpc': '2.0', 'method': 'AudioLibrary.Scan', 'id': 1}
+ r = requests.post(
+ url,
+ auth=(user, password),
+ json=payload,
+ headers=headers)
+
+ return r
+
+
+class KodiUpdate(BeetsPlugin):
+ def __init__(self):
+ super().__init__()
+
+ # Adding defaults.
+ config['kodi'].add({
+ 'host': 'localhost',
+ 'port': 8080,
+ 'user': 'kodi',
+ 'pwd': 'kodi'})
+
+ config['kodi']['pwd'].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"""
+ self.register_listener('cli_exit', self.update)
+
+ def update(self, lib):
+ """When the client exists try to send refresh request to Kodi server.
+ """
+ self._log.info('Requesting a Kodi library update...')
+
+ # Try to send update request.
+ try:
+ r = update_kodi(
+ config['kodi']['host'].get(),
+ config['kodi']['port'].get(),
+ config['kodi']['user'].get(),
+ config['kodi']['pwd'].get())
+ r.raise_for_status()
+
+ except requests.exceptions.RequestException as e:
+ self._log.warning('Kodi update failed: {0}',
+ str(e))
+ return
+
+ json = r.json()
+ if json.get('result') != 'OK':
+ self._log.warning('Kodi update failed: JSON response was {0!r}',
+ json)
+ return
+
+ self._log.info('Kodi update triggered')
diff --git a/lib/beetsplug/lastgenre/__init__.py b/lib/beetsplug/lastgenre/__init__.py
new file mode 100644
index 00000000..05412308
--- /dev/null
+++ b/lib/beetsplug/lastgenre/__init__.py
@@ -0,0 +1,486 @@
+# This file is part of beets.
+# Copyright 2016, Adrian Sampson.
+#
+# 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.
+
+
+"""Gets genres for imported music based on Last.fm tags.
+
+Uses a provided whitelist file to determine which tags are valid genres.
+The included (default) genre list was originally produced by scraping Wikipedia
+and has been edited to remove some questionable entries.
+The scraper script used is available here:
+https://gist.github.com/1241307
+"""
+import pylast
+import codecs
+import os
+import yaml
+import traceback
+
+from beets import plugins
+from beets import ui
+from beets import config
+from beets.util import normpath, plurality
+from beets import library
+
+
+LASTFM = pylast.LastFMNetwork(api_key=plugins.LASTFM_KEY)
+
+PYLAST_EXCEPTIONS = (
+ pylast.WSError,
+ pylast.MalformedResponseError,
+ pylast.NetworkError,
+)
+
+REPLACE = {
+ '\u2010': '-',
+}
+
+
+def deduplicate(seq):
+ """Remove duplicates from sequence wile preserving order.
+ """
+ seen = set()
+ return [x for x in seq if x not in seen and not seen.add(x)]
+
+
+# Canonicalization tree processing.
+
+def flatten_tree(elem, path, branches):
+ """Flatten nested lists/dictionaries into lists of strings
+ (branches).
+ """
+ if not path:
+ path = []
+
+ if isinstance(elem, dict):
+ for (k, v) in elem.items():
+ flatten_tree(v, path + [k], branches)
+ elif isinstance(elem, list):
+ for sub in elem:
+ flatten_tree(sub, path, branches)
+ else:
+ branches.append(path + [str(elem)])
+
+
+def find_parents(candidate, branches):
+ """Find parents genre of a given genre, ordered from the closest to
+ the further parent.
+ """
+ for branch in branches:
+ try:
+ idx = branch.index(candidate.lower())
+ return list(reversed(branch[:idx + 1]))
+ except ValueError:
+ continue
+ return [candidate]
+
+
+# Main plugin logic.
+
+WHITELIST = os.path.join(os.path.dirname(__file__), 'genres.txt')
+C14N_TREE = os.path.join(os.path.dirname(__file__), 'genres-tree.yaml')
+
+
+class LastGenrePlugin(plugins.BeetsPlugin):
+ def __init__(self):
+ super().__init__()
+
+ self.config.add({
+ 'whitelist': True,
+ 'min_weight': 10,
+ 'count': 1,
+ 'fallback': None,
+ 'canonical': False,
+ 'source': 'album',
+ 'force': True,
+ 'auto': True,
+ 'separator': ', ',
+ 'prefer_specific': False,
+ 'title_case': True,
+ })
+
+ self.setup()
+
+ def setup(self):
+ """Setup plugin from config options
+ """
+ if self.config['auto']:
+ self.import_stages = [self.imported]
+
+ self._genre_cache = {}
+
+ # Read the whitelist file if enabled.
+ self.whitelist = set()
+ wl_filename = self.config['whitelist'].get()
+ if wl_filename in (True, ''): # Indicates the default whitelist.
+ wl_filename = WHITELIST
+ if wl_filename:
+ wl_filename = normpath(wl_filename)
+ with open(wl_filename, 'rb') as f:
+ for line in f:
+ line = line.decode('utf-8').strip().lower()
+ if line and not line.startswith('#'):
+ self.whitelist.add(line)
+
+ # Read the genres tree for canonicalization if enabled.
+ self.c14n_branches = []
+ c14n_filename = self.config['canonical'].get()
+ self.canonicalize = c14n_filename is not False
+
+ # Default tree
+ if c14n_filename in (True, ''):
+ c14n_filename = C14N_TREE
+ elif not self.canonicalize and self.config['prefer_specific'].get():
+ # prefer_specific requires a tree, load default tree
+ c14n_filename = C14N_TREE
+
+ # Read the tree
+ if c14n_filename:
+ self._log.debug('Loading canonicalization tree {0}', c14n_filename)
+ c14n_filename = normpath(c14n_filename)
+ with codecs.open(c14n_filename, 'r', encoding='utf-8') as f:
+ genres_tree = yaml.safe_load(f)
+ flatten_tree(genres_tree, [], self.c14n_branches)
+
+ @property
+ def sources(self):
+ """A tuple of allowed genre sources. May contain 'track',
+ 'album', or 'artist.'
+ """
+ source = self.config['source'].as_choice(('track', 'album', 'artist'))
+ if source == 'track':
+ return 'track', 'album', 'artist'
+ elif source == 'album':
+ return 'album', 'artist'
+ elif source == 'artist':
+ return 'artist',
+
+ def _get_depth(self, tag):
+ """Find the depth of a tag in the genres tree.
+ """
+ depth = None
+ for key, value in enumerate(self.c14n_branches):
+ if tag in value:
+ depth = value.index(tag)
+ break
+ return depth
+
+ def _sort_by_depth(self, tags):
+ """Given a list of tags, sort the tags by their depths in the
+ genre tree.
+ """
+ depth_tag_pairs = [(self._get_depth(t), t) for t in tags]
+ depth_tag_pairs = [e for e in depth_tag_pairs if e[0] is not None]
+ depth_tag_pairs.sort(reverse=True)
+ return [p[1] for p in depth_tag_pairs]
+
+ def _resolve_genres(self, tags):
+ """Given a list of strings, return a genre by joining them into a
+ single string and (optionally) canonicalizing each.
+ """
+ if not tags:
+ return None
+
+ count = self.config['count'].get(int)
+ if self.canonicalize:
+ # Extend the list to consider tags parents in the c14n tree
+ tags_all = []
+ for tag in tags:
+ # Add parents that are in the whitelist, or add the oldest
+ # ancestor if no whitelist
+ if self.whitelist:
+ parents = [x for x in find_parents(tag, self.c14n_branches)
+ if self._is_allowed(x)]
+ else:
+ parents = [find_parents(tag, self.c14n_branches)[-1]]
+
+ tags_all += parents
+ # Stop if we have enough tags already, unless we need to find
+ # the most specific tag (instead of the most popular).
+ if (not self.config['prefer_specific'] and
+ len(tags_all) >= count):
+ break
+ tags = tags_all
+
+ tags = deduplicate(tags)
+
+ # Sort the tags by specificity.
+ if self.config['prefer_specific']:
+ tags = self._sort_by_depth(tags)
+
+ # c14n only adds allowed genres but we may have had forbidden genres in
+ # the original tags list
+ tags = [self._format_tag(x) for x in tags if self._is_allowed(x)]
+
+ return self.config['separator'].as_str().join(
+ tags[:self.config['count'].get(int)]
+ )
+
+ def _format_tag(self, tag):
+ if self.config["title_case"]:
+ return tag.title()
+ return tag
+
+ def fetch_genre(self, lastfm_obj):
+ """Return the genre for a pylast entity or None if no suitable genre
+ can be found. Ex. 'Electronic, House, Dance'
+ """
+ min_weight = self.config['min_weight'].get(int)
+ return self._resolve_genres(self._tags_for(lastfm_obj, min_weight))
+
+ def _is_allowed(self, genre):
+ """Determine whether the genre is present in the whitelist,
+ returning a boolean.
+ """
+ if genre is None:
+ return False
+ if not self.whitelist or genre in self.whitelist:
+ return True
+ return False
+
+ # Cached entity lookups.
+
+ def _last_lookup(self, entity, method, *args):
+ """Get a genre based on the named entity using the callable `method`
+ whose arguments are given in the sequence `args`. The genre lookup
+ is cached based on the entity name and the arguments. Before the
+ lookup, each argument is has some Unicode characters replaced with
+ rough ASCII equivalents in order to return better results from the
+ Last.fm database.
+ """
+ # Shortcut if we're missing metadata.
+ if any(not s for s in args):
+ return None
+
+ key = '{}.{}'.format(entity,
+ '-'.join(str(a) for a in args))
+ if key in self._genre_cache:
+ return self._genre_cache[key]
+ else:
+ args_replaced = []
+ for arg in args:
+ for k, v in REPLACE.items():
+ arg = arg.replace(k, v)
+ args_replaced.append(arg)
+
+ genre = self.fetch_genre(method(*args_replaced))
+ self._genre_cache[key] = genre
+ return genre
+
+ def fetch_album_genre(self, obj):
+ """Return the album genre for this Item or Album.
+ """
+ return self._last_lookup(
+ 'album', LASTFM.get_album, obj.albumartist, obj.album
+ )
+
+ def fetch_album_artist_genre(self, obj):
+ """Return the album artist genre for this Item or Album.
+ """
+ return self._last_lookup(
+ 'artist', LASTFM.get_artist, obj.albumartist
+ )
+
+ def fetch_artist_genre(self, item):
+ """Returns the track artist genre for this Item.
+ """
+ return self._last_lookup(
+ 'artist', LASTFM.get_artist, item.artist
+ )
+
+ def fetch_track_genre(self, obj):
+ """Returns the track genre for this Item.
+ """
+ return self._last_lookup(
+ 'track', LASTFM.get_track, obj.artist, obj.title
+ )
+
+ def _get_genre(self, obj):
+ """Get the genre string for an Album or Item object based on
+ self.sources. Return a `(genre, source)` pair. The
+ prioritization order is:
+ - track (for Items only)
+ - album
+ - artist
+ - original
+ - fallback
+ - None
+ """
+
+ # Shortcut to existing genre if not forcing.
+ if not self.config['force'] and self._is_allowed(obj.genre):
+ return obj.genre, 'keep'
+
+ # Track genre (for Items only).
+ if isinstance(obj, library.Item):
+ if 'track' in self.sources:
+ result = self.fetch_track_genre(obj)
+ if result:
+ return result, 'track'
+
+ # Album genre.
+ if 'album' in self.sources:
+ result = self.fetch_album_genre(obj)
+ if result:
+ return result, 'album'
+
+ # Artist (or album artist) genre.
+ if 'artist' in self.sources:
+ result = None
+ if isinstance(obj, library.Item):
+ result = self.fetch_artist_genre(obj)
+ elif obj.albumartist != config['va_name'].as_str():
+ result = self.fetch_album_artist_genre(obj)
+ else:
+ # For "Various Artists", pick the most popular track genre.
+ item_genres = []
+ for item in obj.items():
+ item_genre = None
+ if 'track' in self.sources:
+ item_genre = self.fetch_track_genre(item)
+ if not item_genre:
+ item_genre = self.fetch_artist_genre(item)
+ if item_genre:
+ item_genres.append(item_genre)
+ if item_genres:
+ result, _ = plurality(item_genres)
+
+ if result:
+ return result, 'artist'
+
+ # Filter the existing genre.
+ if obj.genre:
+ result = self._resolve_genres([obj.genre])
+ if result:
+ return result, 'original'
+
+ # Fallback string.
+ fallback = self.config['fallback'].get()
+ if fallback:
+ return fallback, 'fallback'
+
+ return None, None
+
+ def commands(self):
+ lastgenre_cmd = ui.Subcommand('lastgenre', help='fetch genres')
+ lastgenre_cmd.parser.add_option(
+ '-f', '--force', dest='force',
+ action='store_true',
+ help='re-download genre when already present'
+ )
+ lastgenre_cmd.parser.add_option(
+ '-s', '--source', dest='source', type='string',
+ help='genre source: artist, album, or track'
+ )
+ lastgenre_cmd.parser.add_option(
+ '-A', '--items', action='store_false', dest='album',
+ help='match items instead of albums')
+ lastgenre_cmd.parser.add_option(
+ '-a', '--albums', action='store_true', dest='album',
+ help='match albums instead of items')
+ lastgenre_cmd.parser.set_defaults(album=True)
+
+ def lastgenre_func(lib, opts, args):
+ write = ui.should_write()
+ self.config.set_args(opts)
+
+ if opts.album:
+ # Fetch genres for whole albums
+ for album in lib.albums(ui.decargs(args)):
+ album.genre, src = self._get_genre(album)
+ self._log.info('genre for album {0} ({1}): {0.genre}',
+ album, src)
+ album.store()
+
+ for item in album.items():
+ # If we're using track-level sources, also look up each
+ # track on the album.
+ if 'track' in self.sources:
+ item.genre, src = self._get_genre(item)
+ item.store()
+ self._log.info(
+ 'genre for track {0} ({1}): {0.genre}',
+ item, src)
+
+ if write:
+ item.try_write()
+ else:
+ # Just query singletons, i.e. items that are not part of
+ # an album
+ for item in lib.items(ui.decargs(args)):
+ item.genre, src = self._get_genre(item)
+ self._log.debug('added last.fm item genre ({0}): {1}',
+ src, item.genre)
+ item.store()
+
+ lastgenre_cmd.func = lastgenre_func
+ return [lastgenre_cmd]
+
+ def imported(self, session, task):
+ """Event hook called when an import task finishes."""
+ if task.is_album:
+ album = task.album
+ album.genre, src = self._get_genre(album)
+ self._log.debug('added last.fm album genre ({0}): {1}',
+ src, album.genre)
+ album.store()
+
+ if 'track' in self.sources:
+ for item in album.items():
+ item.genre, src = self._get_genre(item)
+ self._log.debug('added last.fm item genre ({0}): {1}',
+ src, item.genre)
+ item.store()
+
+ else:
+ item = task.item
+ item.genre, src = self._get_genre(item)
+ self._log.debug('added last.fm item genre ({0}): {1}',
+ src, item.genre)
+ item.store()
+
+ def _tags_for(self, obj, min_weight=None):
+ """Core genre identification routine.
+
+ Given a pylast entity (album or track), return a list of
+ tag names for that entity. Return an empty list if the entity is
+ not found or another error occurs.
+
+ If `min_weight` is specified, tags are filtered by weight.
+ """
+ # Work around an inconsistency in pylast where
+ # Album.get_top_tags() does not return TopItem instances.
+ # https://github.com/pylast/pylast/issues/86
+ if isinstance(obj, pylast.Album):
+ obj = super(pylast.Album, obj)
+
+ try:
+ res = obj.get_top_tags()
+ except PYLAST_EXCEPTIONS as exc:
+ self._log.debug('last.fm error: {0}', exc)
+ return []
+ except Exception as exc:
+ # Isolate bugs in pylast.
+ self._log.debug('{}', traceback.format_exc())
+ self._log.error('error in pylast library: {0}', exc)
+ return []
+
+ # Filter by weight (optionally).
+ if min_weight:
+ res = [el for el in res if (int(el.weight or 0)) >= min_weight]
+
+ # Get strings from tags.
+ res = [el.item.get_name().lower() for el in res]
+
+ return res
diff --git a/lib/beetsplug/lastgenre/genres-tree.yaml b/lib/beetsplug/lastgenre/genres-tree.yaml
new file mode 100644
index 00000000..c8ae4247
--- /dev/null
+++ b/lib/beetsplug/lastgenre/genres-tree.yaml
@@ -0,0 +1,766 @@
+- african:
+ - african heavy metal
+ - african hip hop
+ - afrobeat
+ - apala
+ - benga
+ - bikutsi
+ - bongo flava
+ - cape jazz
+ - chimurenga
+ - coupé-décalé
+ - fuji music
+ - genge
+ - highlife
+ - hiplife
+ - isicathamiya
+ - jit
+ - jùjú
+ - kapuka
+ - kizomba
+ - kuduro
+ - kwaito
+ - kwela
+ - makossa
+ - maloya
+ - marrabenta
+ - mbalax
+ - mbaqanga
+ - mbube
+ - morna
+ - museve
+ - palm-wine
+ - raï
+ - sakara
+ - sega
+ - seggae
+ - semba
+ - soukous
+ - taarab
+ - zouglou
+- asian:
+ - east asian:
+ - anison
+ - c-pop
+ - cantopop
+ - enka
+ - hong kong english pop
+ - j-pop
+ - k-pop
+ - kayōkyoku
+ - korean pop
+ - mandopop
+ - onkyokei
+ - taiwanese pop
+ - fann at-tanbura
+ - fijiri
+ - khaliji
+ - liwa
+ - sawt
+ - south and southeast asian:
+ - baila
+ - bhangra
+ - bhojpuri
+ - dangdut
+ - filmi
+ - indian pop
+ - lavani
+ - luk thung:
+ - luk krung
+ - manila sound
+ - morlam
+ - pinoy pop
+ - pop sunda
+ - ragini
+ - thai pop
+- avant-garde:
+ - experimental music
+ - lo-fi
+ - musique concrète
+- blues:
+ - african blues
+ - blues rock
+ - blues shouter
+ - british blues
+ - canadian blues
+ - chicago blues
+ - classic female blues
+ - contemporary r&b
+ - country blues
+ - delta blues
+ - detroit blues
+ - electric blues
+ - gospel blues
+ - hill country blues
+ - hokum blues
+ - jazz blues
+ - jump blues
+ - kansas city blues
+ - louisiana blues
+ - memphis blues
+ - piano blues
+ - piedmont blues
+ - punk blues
+ - soul blues
+ - st. louis blues
+ - swamp blues
+ - texas blues
+ - west coast blues
+- caribbean and latin american:
+ - bachata
+ - baithak gana
+ - bolero
+ - brazilian:
+ - axé
+ - bossa nova
+ - brazilian rock
+ - brega
+ - choro
+ - forró
+ - frevo
+ - funk carioca
+ - lambada
+ - maracatu
+ - música popular brasileira
+ - música sertaneja
+ - pagode
+ - samba
+ - samba rock
+ - tecnobrega
+ - tropicalia
+ - zouk-lambada
+ - calypso
+ - chutney
+ - chutney soca
+ - compas
+ - mambo
+ - merengue
+ - méringue
+ - other latin:
+ - chicha
+ - criolla
+ - cumbia
+ - huayno
+ - mariachi
+ - ranchera
+ - tejano
+ - punta
+ - punta rock
+ - rasin
+ - reggaeton
+ - salsa
+ - soca
+ - son
+ - timba
+ - twoubadou
+ - zouk
+- classical:
+ - ballet
+ - baroque:
+ - baroque music
+ - cantata
+ - chamber music:
+ - string quartet
+ - classical music
+ - concerto:
+ - concerto grosso
+ - contemporary classical
+ - modern classical
+ - opera
+ - oratorio
+ - orchestra:
+ - orchestral
+ - symphonic
+ - symphony
+ - organum
+ - mass:
+ - requiem
+ - sacred music:
+ - cantique
+ - gregorian chant
+ - sonata
+- comedy:
+ - comedy music
+ - comedy rock
+ - humor
+ - parody music
+ - stand-up
+- country:
+ - alternative country:
+ - cowpunk
+ - americana
+ - australian country music
+ - bakersfield sound
+ - bluegrass:
+ - progressive bluegrass
+ - reactionary bluegrass
+ - blues country
+ - cajun:
+ - cajun fiddle tunes
+ - christian country music
+ - classic country
+ - close harmony
+ - country pop
+ - country rap
+ - country rock
+ - country soul
+ - cowboy/western music
+ - dansband music
+ - franco-country
+ - gulf and western
+ - hellbilly music
+ - hokum
+ - honky tonk
+ - instrumental country
+ - lubbock sound
+ - nashville sound
+ - neotraditional country
+ - outlaw country
+ - progressive country
+ - psychobilly/punkabilly
+ - red dirt
+ - rockabilly
+ - sertanejo
+ - texas country
+ - traditional country music
+ - truck-driving country
+ - western swing
+ - zydeco
+- easy listening:
+ - background music
+ - beautiful music
+ - elevator music
+ - furniture music
+ - lounge music
+ - middle of the road
+ - new-age music
+- electronic:
+ - ambient:
+ - ambient dub
+ - ambient house
+ - ambient techno
+ - dark ambient
+ - drone music
+ - illbient
+ - isolationism
+ - lowercase
+ - asian underground
+ - breakbeat:
+ - 4-beat
+ - acid breaks
+ - baltimore club
+ - big beat
+ - breakbeat hardcore
+ - broken beat
+ - florida breaks
+ - nu skool breaks
+ - chiptune:
+ - bitpop
+ - game boy music
+ - nintendocore
+ - video game music
+ - yorkshire bleeps and bass
+ - disco:
+ - cosmic disco
+ - disco polo
+ - euro disco
+ - italo disco
+ - nu-disco
+ - space disco
+ - downtempo:
+ - acid jazz
+ - balearic beat
+ - chill out
+ - dub music
+ - dubtronica
+ - ethnic electronica
+ - moombahton
+ - nu jazz
+ - trip hop
+ - drum and bass:
+ - darkcore
+ - darkstep
+ - drumfunk
+ - drumstep
+ - hardstep
+ - intelligent drum and bass
+ - jump-up
+ - liquid funk
+ - neurofunk
+ - oldschool jungle:
+ - darkside jungle
+ - ragga jungle
+ - raggacore
+ - sambass
+ - techstep
+ - electro:
+ - crunk
+ - electro backbeat
+ - electro-grime
+ - electropop
+ - electroacoustic:
+ - acousmatic music
+ - computer music
+ - electroacoustic improvisation
+ - field recording
+ - live coding
+ - live electronics
+ - soundscape composition
+ - tape music
+ - electronic rock:
+ - alternative dance:
+ - baggy
+ - madchester
+ - dance-punk
+ - dance-rock
+ - dark wave
+ - electroclash
+ - electronicore
+ - electropunk
+ - ethereal wave
+ - indietronica
+ - new rave
+ - space rock
+ - synthpop
+ - synthpunk
+ - electronica:
+ - berlin school
+ - chillwave
+ - electronic art music
+ - electronic dance music
+ - folktronica
+ - freestyle music
+ - glitch
+ - idm
+ - laptronica
+ - skweee
+ - sound art
+ - synthcore
+ - eurodance:
+ - bubblegum dance
+ - italo dance
+ - turbofolk
+ - hardcore:
+ - bouncy house
+ - bouncy techno
+ - breakcore
+ - digital hardcore
+ - doomcore
+ - dubstyle
+ - gabber
+ - happy hardcore
+ - hardstyle
+ - jumpstyle
+ - makina
+ - speedcore
+ - terrorcore
+ - uk hardcore
+ - hi-nrg:
+ - eurobeat
+ - hard nrg
+ - new beat
+ - house:
+ - acid house
+ - chicago house
+ - deep house
+ - diva house
+ - dutch house
+ - electro house
+ - freestyle house
+ - french house
+ - funky house
+ - ghetto house
+ - hardbag
+ - hip house
+ - italo house
+ - latin house
+ - minimal house
+ - progressive house
+ - rave music
+ - swing house
+ - tech house
+ - tribal house
+ - uk hard house
+ - us garage
+ - vocal house
+ - industrial:
+ - aggrotech
+ - coldwave
+ - cybergrind
+ - dark electro
+ - death industrial
+ - electro-industrial
+ - electronic body music:
+ - futurepop
+ - industrial metal:
+ - neue deutsche härte
+ - industrial rock
+ - noise:
+ - japanoise
+ - power electronics
+ - power noise
+ - witch house
+ - post-disco:
+ - boogie
+ - dance-pop
+ - progressive:
+ - progressive house/trance:
+ - disco house
+ - dream house
+ - space house
+ - progressive breaks
+ - progressive drum & bass
+ - progressive techno
+ - techno:
+ - acid techno
+ - detroit techno
+ - free tekno
+ - ghettotech
+ - minimal
+ - nortec
+ - schranz
+ - techno-dnb
+ - technopop
+ - tecno brega
+ - toytown techno
+ - trance:
+ - acid trance
+ - classic trance
+ - dream trance
+ - goa trance:
+ - dark psytrance
+ - full on
+ - psybreaks
+ - psyprog
+ - suomisaundi
+ - hard trance
+ - tech trance
+ - uplifting trance:
+ - orchestral uplifting
+ - vocal trance
+ - uk garage:
+ - 2-step
+ - 4x4
+ - bassline
+ - breakstep
+ - dubstep
+ - funky
+ - grime
+ - speed garage
+ - trap
+- folk:
+ - american folk revival
+ - anti-folk
+ - british folk revival
+ - celtic music
+ - contemporary folk
+ - filk music
+ - freak folk
+ - indie folk
+ - industrial folk
+ - neofolk
+ - progressive folk
+ - psychedelic folk
+ - sung poetry
+ - techno-folk
+- hip hop:
+ - alternative hip hop
+ - avant-garde hip hop
+ - chap hop
+ - christian hip hop
+ - conscious hip hop
+ - country-rap
+ - crunkcore
+ - cumbia rap
+ - east coast hip hop:
+ - brick city club
+ - hardcore hip hop
+ - mafioso rap
+ - new jersey hip hop
+ - electro music
+ - freestyle rap
+ - g-funk
+ - gangsta rap
+ - golden age hip hop
+ - hip hop soul
+ - hip pop
+ - hyphy
+ - industrial hip hop
+ - instrumental hip hop
+ - jazz rap
+ - low bap
+ - lyrical hip hop
+ - merenrap
+ - midwest hip hop:
+ - chicago hip hop
+ - detroit hip hop
+ - horrorcore
+ - st. louis hip hop
+ - twin cities hip hop
+ - motswako
+ - nerdcore
+ - new jack swing
+ - new school hip hop
+ - old school hip hop
+ - political hip hop
+ - rap opera
+ - rap rock:
+ - rap metal
+ - rapcore
+ - songo-salsa
+ - southern hip hop:
+ - atlanta hip hop:
+ - snap music
+ - bounce music
+ - houston hip hop:
+ - chopped and screwed
+ - miami bass
+ - turntablism
+ - underground hip hop
+ - urban pasifika
+ - west coast hip hop:
+ - chicano rap
+ - jerkin'
+- jazz:
+ - asian american jazz
+ - avant-garde jazz
+ - bebop
+ - boogie-woogie
+ - british dance band
+ - chamber jazz
+ - continental jazz
+ - cool jazz
+ - crossover jazz
+ - cubop
+ - dixieland
+ - ethno jazz
+ - european free jazz
+ - free funk
+ - free improvisation
+ - free jazz
+ - gypsy jazz
+ - hard bop
+ - jazz fusion
+ - jazz rock
+ - jazz-funk
+ - kansas city jazz
+ - latin jazz
+ - livetronica
+ - m-base
+ - mainstream jazz
+ - modal jazz
+ - neo-bop jazz
+ - neo-swing
+ - novelty ragtime
+ - orchestral jazz
+ - post-bop
+ - punk jazz
+ - ragtime
+ - shibuya-kei
+ - ska jazz
+ - smooth jazz
+ - soul jazz
+ - straight-ahead jazz
+ - stride jazz
+ - swing
+ - third stream
+ - trad jazz
+ - vocal jazz
+ - west coast gypsy jazz
+ - west coast jazz
+- other:
+ - worldbeat
+- pop:
+ - adult contemporary
+ - arab pop
+ - baroque pop
+ - bubblegum pop
+ - chanson
+ - christian pop
+ - classical crossover
+ - europop:
+ - austropop
+ - balkan pop
+ - french pop
+ - latin pop
+ - laïkó
+ - nederpop
+ - russian pop
+ - iranian pop
+ - jangle pop
+ - latin ballad
+ - levenslied
+ - louisiana swamp pop
+ - mexican pop
+ - motorpop
+ - new romanticism
+ - pop rap
+ - popera
+ - psychedelic pop
+ - schlager
+ - soft rock
+ - sophisti-pop
+ - space age pop
+ - sunshine pop
+ - surf pop
+ - teen pop
+ - traditional pop music
+ - turkish pop
+ - vispop
+ - wonky pop
+- rhythm and blues:
+ - funk:
+ - deep funk
+ - go-go
+ - p-funk
+ - soul:
+ - blue-eyed soul
+ - neo soul
+ - northern soul
+- rock:
+ - alternative rock:
+ - britpop:
+ - post-britpop
+ - dream pop
+ - grunge:
+ - post-grunge
+ - indie pop:
+ - dunedin sound
+ - twee pop
+ - indie rock
+ - noise pop
+ - nu metal
+ - post-punk revival
+ - post-rock:
+ - post-metal
+ - sadcore
+ - shoegaze
+ - slowcore
+ - art rock
+ - beat music
+ - chinese rock
+ - christian rock
+ - dark cabaret
+ - desert rock
+ - experimental rock
+ - folk rock
+ - garage rock
+ - glam rock
+ - hard rock
+ - heavy metal:
+ - alternative metal:
+ - funk metal
+ - black metal:
+ - viking metal
+ - christian metal
+ - death metal:
+ - death/doom
+ - goregrind
+ - melodic death metal
+ - technical death metal
+ - doom metal:
+ - epic doom metal
+ - funeral doom
+ - drone metal
+ - epic metal
+ - folk metal:
+ - celtic metal
+ - medieval metal
+ - pagan metal
+ - funk metal
+ - glam metal
+ - gothic metal
+ - industrial metal:
+ - industrial death metal
+ - metalcore:
+ - deathcore
+ - mathcore:
+ - djent
+ - synthcore
+ - neoclassical metal
+ - post-metal
+ - power metal:
+ - progressive power metal
+ - progressive metal
+ - sludge metal
+ - speed metal
+ - stoner rock:
+ - stoner metal
+ - symphonic metal
+ - thrash metal:
+ - crossover thrash
+ - groove metal
+ - progressive thrash metal
+ - teutonic thrash metal
+ - traditional heavy metal
+ - math rock
+ - new wave:
+ - world fusion
+ - paisley underground
+ - pop rock
+ - post-punk:
+ - gothic rock
+ - no wave
+ - noise rock
+ - power pop
+ - progressive rock:
+ - canterbury scene
+ - krautrock
+ - new prog
+ - rock in opposition
+ - psychedelic rock:
+ - acid rock
+ - freakbeat
+ - neo-psychedelia
+ - raga rock
+ - punk rock:
+ - anarcho punk:
+ - crust punk:
+ - d-beat
+ - art punk
+ - christian punk
+ - deathrock
+ - folk punk:
+ - celtic punk
+ - gypsy punk
+ - garage punk
+ - grindcore:
+ - crustgrind
+ - noisegrind
+ - hardcore punk:
+ - post-hardcore:
+ - emo:
+ - screamo
+ - powerviolence
+ - street punk
+ - thrashcore
+ - horror punk
+ - oi!
+ - pop punk
+ - psychobilly
+ - riot grrrl
+ - ska punk:
+ - ska-core
+ - skate punk
+ - rock and roll
+ - southern rock
+ - sufi rock
+ - surf rock
+ - visual kei:
+ - nagoya kei
+- reggae:
+ - roots reggae
+ - reggae fusion
+ - reggae en español:
+ - spanish reggae
+ - reggae 110
+ - reggae bultrón
+ - romantic flow
+ - lovers rock
+ - raggamuffin:
+ - ragga
+ - dancehall
+ - ska:
+ - 2 tone
+ - dub
+ - rocksteady
diff --git a/lib/beetsplug/lastgenre/genres.txt b/lib/beetsplug/lastgenre/genres.txt
new file mode 100644
index 00000000..7ccd7ad3
--- /dev/null
+++ b/lib/beetsplug/lastgenre/genres.txt
@@ -0,0 +1,1542 @@
+2 tone
+2-step garage
+4-beat
+4x4 garage
+8-bit
+acapella
+acid
+acid breaks
+acid house
+acid jazz
+acid rock
+acoustic music
+acousticana
+adult contemporary music
+african popular music
+african rumba
+afrobeat
+aleatoric music
+alternative country
+alternative dance
+alternative hip hop
+alternative metal
+alternative rock
+ambient
+ambient house
+ambient music
+americana
+anarcho punk
+anti-folk
+apala
+ape haters
+arab pop
+arabesque
+arabic pop
+argentine rock
+ars antiqua
+ars nova
+art punk
+art rock
+ashiq
+asian american jazz
+australian country music
+australian hip hop
+australian pub rock
+austropop
+avant-garde
+avant-garde jazz
+avant-garde metal
+avant-garde music
+axé
+bac-bal
+bachata
+baggy
+baila
+baile funk
+baisha xiyue
+baithak gana
+baião
+bajourou
+bakersfield sound
+bakou
+bakshy
+bal-musette
+balakadri
+balinese gamelan
+balkan pop
+ballad
+ballata
+ballet
+bamboo band
+bambuco
+banda
+bangsawan
+bantowbol
+barbershop music
+barndance
+baroque
+baroque music
+baroque pop
+bass music
+batcave
+batucada
+batuco
+batá-rumba
+beach music
+beat
+beatboxing
+beautiful music
+bebop
+beiguan
+bel canto
+bend-skin
+benga
+berlin school of electronic music
+bhajan
+bhangra
+bhangra-wine
+bhangragga
+bhangramuffin
+big band
+big band music
+big beat
+biguine
+bihu
+bikutsi
+biomusic
+bitcore
+bitpop
+black metal
+blackened death metal
+blue-eyed soul
+bluegrass
+blues
+blues ballad
+blues-rock
+boogie
+boogie woogie
+boogie-woogie
+bossa nova
+brass band
+brazilian funk
+brazilian jazz
+breakbeat
+breakbeat hardcore
+breakcore
+breton music
+brill building pop
+britfunk
+british blues
+british invasion
+britpop
+broken beat
+brown-eyed soul
+brukdown
+brutal death metal
+bubblegum dance
+bubblegum pop
+bulerias
+bumba-meu-boi
+bunraku
+burger-highlife
+burgundian school
+byzantine chant
+ca din tulnic
+ca pe lunca
+ca trù
+cabaret
+cadence
+cadence rampa
+cadence-lypso
+café-aman
+cai luong
+cajun music
+cakewalk
+calenda
+calentanos
+calgia
+calypso
+calypso jazz
+calypso-style baila
+campursari
+canatronic
+candombe
+canon
+canrock
+cantata
+cante chico
+cante jondo
+canterbury scene
+cantiga
+cantique
+cantiñas
+canto livre
+canto nuevo
+canto popular
+cantopop
+canzone napoletana
+cape jazz
+capoeira music
+caracoles
+carceleras
+cardas
+cardiowave
+carimbó
+cariso
+carnatic music
+carol
+cartageneras
+cassette culture
+casséy-co
+cavacha
+caveman
+caña
+celempungan
+cello rock
+celtic
+celtic fusion
+celtic metal
+celtic punk
+celtic reggae
+celtic rock
+cha-cha-cha
+chakacha
+chalga
+chamamé
+chamber jazz
+chamber music
+chamber pop
+champeta
+changuí
+chanson
+chant
+charanga
+charanga-vallenata
+charikawi
+chastushki
+chau van
+chemical breaks
+chicago blues
+chicago house
+chicago soul
+chicano rap
+chicha
+chicken scratch
+children's music
+chillout
+chillwave
+chimurenga
+chinese music
+chinese pop
+chinese rock
+chip music
+cho-kantrum
+chongak
+chopera
+chorinho
+choro
+chouval bwa
+chowtal
+christian alternative
+christian black metal
+christian electronic music
+christian hardcore
+christian hip hop
+christian industrial
+christian metal
+christian music
+christian punk
+christian r&b
+christian rock
+christian ska
+christmas carol
+christmas music
+chumba
+chut-kai-pang
+chutney
+chutney soca
+chutney-bhangra
+chutney-hip hop
+chutney-soca
+chylandyk
+chzalni
+chèo
+cigányzene
+classic
+classic country
+classic female blues
+classic rock
+classical
+classical music
+classical music era
+clicks n cuts
+close harmony
+club music
+cocobale
+coimbra fado
+coladeira
+colombianas
+combined rhythm
+comedy
+comedy rap
+comedy rock
+comic opera
+comparsa
+compas direct
+compas meringue
+concert overture
+concerto
+concerto grosso
+congo
+conjunto
+contemporary christian
+contemporary christian music
+contemporary classical
+contemporary r&b
+contonbley
+contradanza
+cool jazz
+corrido
+corsican polyphonic song
+cothoza mfana
+country
+country blues
+country gospel
+country music
+country pop
+country r&b
+country rock
+country-rap
+countrypolitan
+couple de sonneurs
+coupé-décalé
+cowpunk
+cretan music
+crossover jazz
+crossover music
+crossover thrash
+crossover thrash metal
+crunk
+crunk&b
+crunkcore
+crust punk
+csárdás
+cuarteto
+cuban rumba
+cuddlecore
+cueca
+cumbia
+cumbia villera
+cybergrind
+dabka
+dadra
+daina
+dalauna
+dance
+dance music
+dance-pop
+dance-punk
+dance-rock
+dancehall
+dangdut
+danger music
+dansband
+danza
+danzón
+dark ambient
+dark cabaret
+dark pop
+darkcore
+darkstep
+darkwave
+de ascultat la servici
+de codru
+de dragoste
+de jale
+de pahar
+death industrial
+death metal
+death rock
+death/doom
+deathcore
+deathgrind
+deathrock
+deep funk
+deep house
+deep soul
+degung
+delta blues
+dementia
+desert rock
+desi
+detroit blues
+detroit techno
+dhamar
+dhimotiká
+dhrupad
+dhun
+digital hardcore
+dirge
+dirty dutch
+dirty rap
+dirty rap/pornocore
+dirty south
+disco
+disco house
+disco polo
+disney
+disney hardcore
+disney pop
+diva house
+divine rock
+dixieland
+dixieland jazz
+djambadon
+djent
+dodompa
+doina
+dombola
+dondang sayang
+donegal fiddle tradition
+dongjing
+doo wop
+doom metal
+doomcore
+downtempo
+drag
+dream pop
+drone doom
+drone metal
+drone music
+dronology
+drum and bass
+dub
+dub house
+dubanguthu
+dubstep
+dubtronica
+dunedin sound
+dunun
+dutch jazz
+décima
+early music
+east coast blues
+east coast hip hop
+easy listening
+electric blues
+electric folk
+electro
+electro backbeat
+electro hop
+electro house
+electro punk
+electro-industrial
+electro-swing
+electroclash
+electrofunk
+electronic
+electronic art music
+electronic body music
+electronic dance
+electronic luk thung
+electronic music
+electronic rock
+electronica
+electropop
+elevator music
+emo
+emo pop
+emo rap
+emocore
+emotronic
+enka
+epic doom metal
+epic metal
+eremwu eu
+ethereal pop
+ethereal wave
+euro
+euro disco
+eurobeat
+eurodance
+europop
+eurotrance
+eurourban
+exotica
+experimental music
+experimental noise
+experimental pop
+experimental rock
+extreme metal
+ezengileer
+fado
+falak
+fandango
+farruca
+fife and drum blues
+filk
+film score
+filmi
+filmi-ghazal
+finger-style
+fjatpangarri
+flamenco
+flamenco rumba
+flower power
+foaie verde
+fofa
+folk hop
+folk metal
+folk music
+folk pop
+folk punk
+folk rock
+folktronica
+forró
+franco-country
+freak-folk
+freakbeat
+free improvisation
+free jazz
+free music
+freestyle
+freestyle house
+freetekno
+french pop
+frenchcore
+frevo
+fricote
+fuji
+fuji music
+fulia
+full on
+funaná
+funeral doom
+funk
+funk metal
+funk rock
+funkcore
+funky house
+furniture music
+fusion jazz
+g-funk
+gaana
+gabba
+gabber
+gagaku
+gaikyoku
+gaita
+galant
+gamad
+gambang kromong
+gamelan
+gamelan angklung
+gamelan bang
+gamelan bebonangan
+gamelan buh
+gamelan degung
+gamelan gede
+gamelan kebyar
+gamelan salendro
+gamelan selunding
+gamelan semar pegulingan
+gamewave
+gammeldans
+gandrung
+gangsta rap
+gar
+garage rock
+garrotin
+gavotte
+gelugpa chanting
+gender wayang
+gending
+german folk music
+gharbi
+gharnati
+ghazal
+ghazal-song
+ghetto house
+ghettotech
+girl group
+glam metal
+glam punk
+glam rock
+glitch
+gnawa
+go-go
+goa
+goa trance
+gong-chime music
+goombay
+goregrind
+goshu ondo
+gospel music
+gothic metal
+gothic rock
+granadinas
+grebo
+gregorian chant
+grime
+grindcore
+groove metal
+group sounds
+grunge
+grupera
+guaguanbo
+guajira
+guasca
+guitarra baiana
+guitarradas
+gumbe
+gunchei
+gunka
+guoyue
+gwo ka
+gwo ka moderne
+gypsy jazz
+gypsy punk
+gypsybilly
+gyu ke
+habanera
+hajnali
+hakka
+halling
+hambo
+hands up
+hapa haole
+happy hardcore
+haqibah
+hard
+hard bop
+hard house
+hard rock
+hard trance
+hardcore hip hop
+hardcore metal
+hardcore punk
+hardcore techno
+hardstyle
+harepa
+harmonica blues
+hasaposérviko
+heart attack
+heartland rock
+heavy beat
+heavy metal
+hesher
+hi-nrg
+highlands
+highlife
+highlife fusion
+hillybilly music
+hindustani classical music
+hip hop
+hip hop & rap
+hip hop soul
+hip house
+hiplife
+hiragasy
+hiva usu
+hong kong and cantonese pop
+hong kong english pop
+honky tonk
+honkyoku
+hora lunga
+hornpipe
+horror punk
+horrorcore
+horrorcore rap
+house
+house music
+hua'er
+huasteco
+huayno
+hula
+humor
+humppa
+hunguhungu
+hyangak
+hymn
+hyphy
+hát chau van
+hát chèo
+hát cãi luong
+hát tuồng
+ibiza music
+icaro
+idm
+igbo music
+ijexá
+ilahije
+illbient
+impressionist music
+improvisational
+incidental music
+indian pop
+indie folk
+indie music
+indie pop
+indie rock
+indietronica
+indo jazz
+indo rock
+indonesian pop
+indoyíftika
+industrial death metal
+industrial hip-hop
+industrial metal
+industrial music
+industrial musical
+industrial rock
+instrumental rock
+intelligent dance music
+international latin
+inuit music
+iranian pop
+irish folk
+irish rebel music
+iscathamiya
+isicathamiya
+isikhwela jo
+island
+isolationist
+italo dance
+italo disco
+italo house
+itsmeños
+izvorna bosanska muzika
+j'ouvert
+j-fusion
+j-pop
+j-rock
+jaipongan
+jaliscienses
+jam band
+jam rock
+jamana kura
+jamrieng samai
+jangle pop
+japanese pop
+jarana
+jariang
+jarochos
+jawaiian
+jazz
+jazz blues
+jazz fusion
+jazz metal
+jazz rap
+jazz-funk
+jazz-rock
+jegog
+jenkka
+jesus music
+jibaro
+jig
+jig punk
+jing ping
+jingle
+jit
+jitterbug
+jive
+joged
+joged bumbung
+joik
+jonnycore
+joropo
+jota
+jtek
+jug band
+jujitsu
+juju
+juke joint blues
+jump blues
+jumpstyle
+jungle
+junkanoo
+juré
+jùjú
+k-pop
+kaba
+kabuki
+kachāshī
+kadans
+kagok
+kagyupa chanting
+kaiso
+kalamatianó
+kalattuut
+kalinda
+kamba pop
+kan ha diskan
+kansas city blues
+kantrum
+kantádhes
+kargyraa
+karma
+kaseko
+katajjaq
+kawachi ondo
+kayōkyoku
+ke-kwe
+kebyar
+kecak
+kecapi suling
+kertok
+khaleeji
+khap
+khelimaski djili
+khene
+khoomei
+khorovodi
+khplam wai
+khrung sai
+khyal
+kilapanda
+kinko
+kirtan
+kiwi rock
+kizomba
+klape
+klasik
+klezmer
+kliningan
+kléftiko
+kochare
+kolomyjka
+komagaku
+kompa
+konpa
+korean pop
+koumpaneia
+kpanlogo
+krakowiak
+krautrock
+kriti
+kroncong
+krump
+krzesany
+kuduro
+kulintang
+kulning
+kumina
+kun-borrk
+kundere
+kundiman
+kussundé
+kutumba wake
+kveding
+kvæði
+kwaito
+kwassa kwassa
+kwela
+käng
+kélé
+kĩkũyũ pop
+la la
+latin american
+latin jazz
+latin pop
+latin rap
+lavway
+laïko
+laïkó
+le leagan
+legényes
+lelio
+letkajenkka
+levenslied
+lhamo
+lieder
+light music
+light rock
+likanos
+liquid drum&bass
+liquid funk
+liquindi
+llanera
+llanto
+lo-fi
+lo-fi music
+loki djili
+long-song
+louisiana blues
+louisiana swamp pop
+lounge music
+lovers rock
+lowercase
+lubbock sound
+lucknavi thumri
+luhya omutibo
+luk grung
+lullaby
+lundu
+lundum
+m-base
+madchester
+madrigal
+mafioso rap
+maglaal
+magnificat
+mahori
+mainstream jazz
+makossa
+makossa-soukous
+malagueñas
+malawian jazz
+malhun
+maloya
+maluf
+maluka
+mambo
+manaschi
+mandarin pop
+manding swing
+mango
+mangue bit
+mangulina
+manikay
+manila sound
+manouche
+manzuma
+mapouka
+mapouka-serré
+marabi
+maracatu
+marga
+mariachi
+marimba
+marinera
+marrabenta
+martial industrial
+martinetes
+maskanda
+mass
+matamuerte
+math rock
+mathcore
+matt bello
+maxixe
+mazurka
+mbalax
+mbaqanga
+mbube
+mbumba
+medh
+medieval folk rock
+medieval metal
+medieval music
+meditation
+mejorana
+melhoun
+melhûn
+melodic black metal
+melodic death metal
+melodic hardcore
+melodic metalcore
+melodic music
+melodic trance
+memphis blues
+memphis rap
+memphis soul
+mento
+merengue
+merengue típico moderno
+merengue-bomba
+meringue
+merseybeat
+metal
+metalcore
+metallic hardcore
+mexican pop
+mexican rock
+mexican son
+meykhana
+mezwed
+miami bass
+microhouse
+middle of the road
+midwest hip hop
+milonga
+min'yo
+mineras
+mini compas
+mini-jazz
+minimal techno
+minimalist music
+minimalist trance
+minneapolis sound
+minstrel show
+minuet
+mirolóyia
+modal jazz
+modern classical
+modern classical music
+modern laika
+modern rock
+modinha
+mohabelo
+montuno
+monumental dance
+mor lam
+mor lam sing
+morna
+motorpop
+motown
+mozambique
+mpb
+mugam
+multicultural
+murga
+musette
+museve
+mushroom jazz
+music drama
+music hall
+musiqi-e assil
+musique concrète
+mutuashi
+muwashshah
+muzak
+méringue
+música campesina
+música criolla
+música de la interior
+música llanera
+música nordestina
+música popular brasileira
+música tropical
+nagauta
+nakasi
+nangma
+nanguan
+narcocorrido
+nardcore
+narodna muzika
+nasheed
+nashville sound
+nashville sound/countrypolitan
+national socialist black metal
+naturalismo
+nederpop
+neo soul
+neo-classical metal
+neo-medieval
+neo-prog
+neo-psychedelia
+neoclassical
+neoclassical metal
+neoclassical music
+neofolk
+neotraditional country
+nerdcore
+neue deutsche härte
+neue deutsche welle
+new age music
+new beat
+new instrumental
+new jack swing
+new orleans blues
+new orleans jazz
+new pop
+new prog
+new rave
+new romantic
+new school hip hop
+new taiwanese song
+new wave
+new wave of british heavy metal
+new wave of new wave
+new weird america
+new york blues
+new york house
+newgrass
+nganja
+nightcore
+nintendocore
+nisiótika
+no wave
+noh
+noise music
+noise pop
+noise rock
+nongak
+norae undong
+nordic folk dance music
+nordic folk music
+nortec
+norteño
+northern soul
+nota
+nu breaks
+nu jazz
+nu metal
+nu soul
+nueva canción
+nyatiti
+néo kýma
+obscuro
+oi!
+old school hip hop
+old-time
+oldies
+olonkho
+oltului
+ondo
+opera
+operatic pop
+oratorio
+orchestra
+orchestral
+organ trio
+organic ambient
+organum
+orgel
+oriental metal
+ottava rima
+outlaw country
+outsider music
+p-funk
+pagan metal
+pagan rock
+pagode
+paisley underground
+palm wine
+palm-wine
+pambiche
+panambih
+panchai baja
+panchavadyam
+pansori
+paranda
+parang
+parody
+parranda
+partido alto
+pasillo
+patriotic
+peace punk
+pelimanni music
+petenera
+peyote song
+philadelphia soul
+piano blues
+piano rock
+piedmont blues
+pimba
+pinoy pop
+pinoy rock
+pinpeat orchestra
+piphat
+piyyutim
+plainchant
+plena
+pleng phua cheewit
+pleng thai sakorn
+political hip hop
+polka
+polo
+polonaise
+pols
+polska
+pong lang
+pop
+pop folk
+pop music
+pop punk
+pop rap
+pop rock
+pop sunda
+pornocore
+porro
+post disco
+post-britpop
+post-disco
+post-grunge
+post-hardcore
+post-industrial
+post-metal
+post-minimalism
+post-punk
+post-rock
+post-romanticism
+pow-wow
+power electronics
+power metal
+power noise
+power pop
+powerviolence
+ppongtchak
+praise song
+program symphony
+progressive bluegrass
+progressive country
+progressive death metal
+progressive electronic
+progressive electronic music
+progressive folk
+progressive folk music
+progressive house
+progressive metal
+progressive power metal
+progressive rock
+progressive trance
+progressive thrash metal
+protopunk
+psych folk
+psychedelic music
+psychedelic pop
+psychedelic rock
+psychedelic trance
+psychobilly
+punk blues
+punk cabaret
+punk jazz
+punk rock
+punta
+punta rock
+qasidah
+qasidah modern
+qawwali
+quadrille
+quan ho
+queercore
+quiet storm
+rada
+raga
+raga rock
+ragga
+ragga jungle
+raggamuffin
+ragtime
+rai
+rake-and-scrape
+ramkbach
+ramvong
+ranchera
+rap
+rap metal
+rap rock
+rapcore
+rara
+rare groove
+rasiya
+rave
+raw rock
+raï
+rebetiko
+red dirt
+reel
+reggae
+reggae 110
+reggae bultrón
+reggae en español
+reggae fusion
+reggae highlife
+reggaefusion
+reggaeton
+rekilaulu
+relax music
+religious
+rembetiko
+renaissance music
+requiem
+rhapsody
+rhyming spiritual
+rhythm & blues
+rhythm and blues
+ricercar
+riot grrrl
+rock
+rock and roll
+rock en español
+rock opera
+rockabilly
+rocksteady
+rococo
+romantic flow
+romantic period in music
+rondeaux
+ronggeng
+roots reggae
+roots rock
+roots rock reggae
+rumba
+russian pop
+rímur
+sabar
+sacred harp
+sacred music
+sadcore
+saibara
+sakara
+salegy
+salsa
+salsa erotica
+salsa romantica
+saltarello
+samba
+samba-canção
+samba-reggae
+samba-rock
+sambai
+sanjo
+sato kagura
+sawt
+saya
+scat
+schlager
+schottisch
+schranz
+scottish baroque music
+screamo
+scrumpy and western
+sea shanty
+sean nós
+second viennese school
+sega music
+seggae
+seis
+semba
+sephardic music
+serialism
+set dance
+sevdalinka
+sevillana
+shabab
+shabad
+shalako
+shan'ge
+shango
+shape note
+shibuya-kei
+shidaiqu
+shima uta
+shock rock
+shoegaze
+shoegazer
+shoka
+shomyo
+show tune
+sica
+siguiriyas
+silat
+sinawi
+situational
+ska
+ska punk
+skacore
+skald
+skate punk
+skiffle
+slack-key guitar
+slide
+slowcore
+sludge metal
+slängpolska
+smooth jazz
+soca
+soft rock
+son
+son montuno
+son-batá
+sonata
+songo
+songo-salsa
+sophisti-pop
+soukous
+soul
+soul blues
+soul jazz
+soul music
+southern gospel
+southern harmony
+southern hip hop
+southern metal
+southern rock
+southern soul
+space age pop
+space music
+space rock
+spectralism
+speed garage
+speed metal
+speedcore
+spirituals
+spouge
+sprechgesang
+square dance
+squee
+st. louis blues
+stand-up
+steelband
+stoner metal
+stoner rock
+straight edge
+strathspeys
+stride
+string
+string quartet
+sufi music
+suite
+sunshine pop
+suomirock
+super eurobeat
+surf ballad
+surf instrumental
+surf music
+surf pop
+surf rock
+swamp blues
+swamp pop
+swamp rock
+swing
+swing music
+swingbeat
+sygyt
+symphonic
+symphonic black metal
+symphonic metal
+symphonic poem
+symphonic rock
+symphony
+synthcore
+synthpop
+synthpunk
+t'ong guitar
+taarab
+tai tu
+taiwanese pop
+tala
+talempong
+tambu
+tamburitza
+tamil christian keerthanai
+tango
+tanguk
+tappa
+tarana
+tarantella
+taranto
+tech
+tech house
+tech trance
+technical death metal
+technical metal
+techno
+technoid
+technopop
+techstep
+techtonik
+teen pop
+tejano
+tejano music
+tekno
+tembang sunda
+teutonic thrash metal
+texas blues
+thai pop
+thillana
+thrash metal
+thrashcore
+thumri
+tibetan pop
+tiento
+timbila
+tin pan alley
+tinga
+tinku
+toeshey
+togaku
+trad jazz
+traditional bluegrass
+traditional heavy metal
+traditional pop music
+trallalero
+trance
+tribal house
+trikitixa
+trip hop
+trip rock
+trip-hop
+tropicalia
+tropicalismo
+tropipop
+truck-driving country
+tumba
+turbo-folk
+turkish music
+turkish pop
+turntablism
+tuvan throat-singing
+twee pop
+twist
+two tone
+táncház
+uk garage
+uk pub rock
+unblack metal
+underground music
+uplifting
+uplifting trance
+urban cowboy
+urban folk
+urban jazz
+vallenato
+vaudeville
+venezuela
+verbunkos
+verismo
+viking metal
+villanella
+virelai
+vispop
+visual kei
+visual music
+vocal
+vocal house
+vocal jazz
+vocal music
+volksmusik
+waila
+waltz
+wangga
+warabe uta
+wassoulou
+weld
+were music
+west coast hip hop
+west coast jazz
+western
+western blues
+western swing
+witch house
+wizard rock
+women's music
+wong shadow
+wonky pop
+wood
+work song
+world fusion
+world fusion music
+world music
+worldbeat
+xhosa music
+xoomii
+yo-pop
+yodeling
+yukar
+yé-yé
+zajal
+zapin
+zarzuela
+zeibekiko
+zeuhl
+ziglibithy
+zouglou
+zouk
+zouk chouv
+zouklove
+zulu music
+zydeco
diff --git a/lib/beetsplug/lastimport.py b/lib/beetsplug/lastimport.py
new file mode 100644
index 00000000..16d53302
--- /dev/null
+++ b/lib/beetsplug/lastimport.py
@@ -0,0 +1,247 @@
+# This file is part of beets.
+# Copyright 2016, Rafael Bodill https://github.com/rafi
+#
+# 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.
+
+
+import pylast
+from pylast import TopItem, _extract, _number
+from beets import ui
+from beets import dbcore
+from beets import config
+from beets import plugins
+from beets.dbcore import types
+
+API_URL = 'https://ws.audioscrobbler.com/2.0/'
+
+
+class LastImportPlugin(plugins.BeetsPlugin):
+ def __init__(self):
+ super().__init__()
+ config['lastfm'].add({
+ 'user': '',
+ 'api_key': plugins.LASTFM_KEY,
+ })
+ config['lastfm']['api_key'].redact = True
+ self.config.add({
+ 'per_page': 500,
+ 'retry_limit': 3,
+ })
+ self.item_types = {
+ 'play_count': types.INTEGER,
+ }
+
+ def commands(self):
+ cmd = ui.Subcommand('lastimport', help='import last.fm play-count')
+
+ def func(lib, opts, args):
+ import_lastfm(lib, self._log)
+
+ cmd.func = func
+ return [cmd]
+
+
+class CustomUser(pylast.User):
+ """ Custom user class derived from pylast.User, and overriding the
+ _get_things method to return MBID and album. Also introduces new
+ get_top_tracks_by_page method to allow access to more than one page of top
+ tracks.
+ """
+ def __init__(self, *args, **kwargs):
+ super().__init__(*args, **kwargs)
+
+ def _get_things(self, method, thing, thing_type, params=None,
+ cacheable=True):
+ """Returns a list of the most played thing_types by this thing, in a
+ tuple with the total number of pages of results. Includes an MBID, if
+ found.
+ """
+ doc = self._request(
+ self.ws_prefix + "." + method, cacheable, params)
+
+ toptracks_node = doc.getElementsByTagName('toptracks')[0]
+ total_pages = int(toptracks_node.getAttribute('totalPages'))
+
+ seq = []
+ for node in doc.getElementsByTagName(thing):
+ title = _extract(node, "name")
+ artist = _extract(node, "name", 1)
+ mbid = _extract(node, "mbid")
+ playcount = _number(_extract(node, "playcount"))
+
+ thing = thing_type(artist, title, self.network)
+ thing.mbid = mbid
+ seq.append(TopItem(thing, playcount))
+
+ return seq, total_pages
+
+ def get_top_tracks_by_page(self, period=pylast.PERIOD_OVERALL, limit=None,
+ page=1, cacheable=True):
+ """Returns the top tracks played by a user, in a tuple with the total
+ number of pages of results.
+ * period: The period of time. Possible values:
+ o PERIOD_OVERALL
+ o PERIOD_7DAYS
+ o PERIOD_1MONTH
+ o PERIOD_3MONTHS
+ o PERIOD_6MONTHS
+ o PERIOD_12MONTHS
+ """
+
+ params = self._get_params()
+ params['period'] = period
+ params['page'] = page
+ if limit:
+ params['limit'] = limit
+
+ return self._get_things(
+ "getTopTracks", "track", pylast.Track, params, cacheable)
+
+
+def import_lastfm(lib, log):
+ user = config['lastfm']['user'].as_str()
+ per_page = config['lastimport']['per_page'].get(int)
+
+ if not user:
+ raise ui.UserError('You must specify a user name for lastimport')
+
+ log.info('Fetching last.fm library for @{0}', user)
+
+ page_total = 1
+ page_current = 0
+ found_total = 0
+ unknown_total = 0
+ retry_limit = config['lastimport']['retry_limit'].get(int)
+ # Iterate through a yet to be known page total count
+ while page_current < page_total:
+ log.info('Querying page #{0}{1}...',
+ page_current + 1,
+ f'/{page_total}' if page_total > 1 else '')
+
+ for retry in range(0, retry_limit):
+ tracks, page_total = fetch_tracks(user, page_current + 1, per_page)
+ if page_total < 1:
+ # It means nothing to us!
+ raise ui.UserError('Last.fm reported no data.')
+
+ if tracks:
+ found, unknown = process_tracks(lib, tracks, log)
+ found_total += found
+ unknown_total += unknown
+ break
+ else:
+ log.error('ERROR: unable to read page #{0}',
+ page_current + 1)
+ if retry < retry_limit:
+ log.info(
+ 'Retrying page #{0}... ({1}/{2} retry)',
+ page_current + 1, retry + 1, retry_limit
+ )
+ else:
+ log.error('FAIL: unable to fetch page #{0}, ',
+ 'tried {1} times', page_current, retry + 1)
+ page_current += 1
+
+ log.info('... done!')
+ log.info('finished processing {0} song pages', page_total)
+ log.info('{0} unknown play-counts', unknown_total)
+ log.info('{0} play-counts imported', found_total)
+
+
+def fetch_tracks(user, page, limit):
+ """ JSON format:
+ [
+ {
+ "mbid": "...",
+ "artist": "...",
+ "title": "...",
+ "playcount": "..."
+ }
+ ]
+ """
+ network = pylast.LastFMNetwork(api_key=config['lastfm']['api_key'])
+ user_obj = CustomUser(user, network)
+ results, total_pages =\
+ user_obj.get_top_tracks_by_page(limit=limit, page=page)
+ return [
+ {
+ "mbid": track.item.mbid if track.item.mbid else '',
+ "artist": {
+ "name": track.item.artist.name
+ },
+ "name": track.item.title,
+ "playcount": track.weight
+ } for track in results
+ ], total_pages
+
+
+def process_tracks(lib, tracks, log):
+ total = len(tracks)
+ total_found = 0
+ total_fails = 0
+ log.info('Received {0} tracks in this page, processing...', total)
+
+ for num in range(0, total):
+ song = None
+ trackid = tracks[num]['mbid'].strip()
+ artist = tracks[num]['artist'].get('name', '').strip()
+ title = tracks[num]['name'].strip()
+ album = ''
+ if 'album' in tracks[num]:
+ album = tracks[num]['album'].get('name', '').strip()
+
+ log.debug('query: {0} - {1} ({2})', artist, title, album)
+
+ # First try to query by musicbrainz's trackid
+ if trackid:
+ song = lib.items(
+ dbcore.query.MatchQuery('mb_trackid', trackid)
+ ).get()
+
+ # If not, try just artist/title
+ if song is None:
+ log.debug('no album match, trying by artist/title')
+ query = dbcore.AndQuery([
+ dbcore.query.SubstringQuery('artist', artist),
+ dbcore.query.SubstringQuery('title', title)
+ ])
+ song = lib.items(query).get()
+
+ # Last resort, try just replacing to utf-8 quote
+ if song is None:
+ title = title.replace("'", '\u2019')
+ log.debug('no title match, trying utf-8 single quote')
+ query = dbcore.AndQuery([
+ dbcore.query.SubstringQuery('artist', artist),
+ dbcore.query.SubstringQuery('title', title)
+ ])
+ song = lib.items(query).get()
+
+ if song is not None:
+ count = int(song.get('play_count', 0))
+ new_count = int(tracks[num]['playcount'])
+ log.debug('match: {0} - {1} ({2}) '
+ 'updating: play_count {3} => {4}',
+ song.artist, song.title, song.album, count, new_count)
+ song['play_count'] = new_count
+ song.store()
+ total_found += 1
+ else:
+ total_fails += 1
+ log.info(' - No match: {0} - {1} ({2})',
+ artist, title, album)
+
+ if total_fails > 0:
+ log.info('Acquired {0}/{1} play-counts ({2} unknown)',
+ total_found, total, total_fails)
+
+ return total_found, total_fails
diff --git a/lib/beetsplug/loadext.py b/lib/beetsplug/loadext.py
new file mode 100644
index 00000000..191b97a2
--- /dev/null
+++ b/lib/beetsplug/loadext.py
@@ -0,0 +1,44 @@
+# This file is part of beets.
+# Copyright 2019, Jack Wilsdon <jack.wilsdon@gmail.com>
+#
+# 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.
+
+"""Load SQLite extensions.
+"""
+
+
+from beets.dbcore import Database
+from beets.plugins import BeetsPlugin
+import sqlite3
+
+
+class LoadExtPlugin(BeetsPlugin):
+ def __init__(self):
+ super().__init__()
+
+ if not Database.supports_extensions:
+ self._log.warn('loadext is enabled but the current SQLite '
+ 'installation does not support extensions')
+ return
+
+ self.register_listener('library_opened', self.library_opened)
+
+ def library_opened(self, lib):
+ for v in self.config:
+ ext = v.as_filename()
+
+ self._log.debug('loading extension {}', ext)
+
+ try:
+ lib.load_extension(ext)
+ except sqlite3.OperationalError as e:
+ self._log.error('failed to load extension {}: {}', ext, e)
diff --git a/lib/beetsplug/lyrics.py b/lib/beetsplug/lyrics.py
index a2ebe7c3..2cb50ca5 100644
--- a/lib/beetsplug/lyrics.py
+++ b/lib/beetsplug/lyrics.py
@@ -1,5 +1,5 @@
# This file is part of beets.
-# Copyright 2014, Adrian Sampson.
+# Copyright 2016, Adrian Sampson.
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
@@ -14,73 +14,122 @@
"""Fetches, embeds, and displays lyrics.
"""
-from __future__ import print_function
-import re
-import logging
-import requests
-import json
-import unicodedata
-import urllib
+
import difflib
+import errno
import itertools
-from HTMLParser import HTMLParseError
+import json
+import struct
+import os.path
+import re
+import requests
+import unicodedata
+from unidecode import unidecode
+import warnings
+import urllib
+
+try:
+ import bs4
+ from bs4 import SoupStrainer
+ HAS_BEAUTIFUL_SOUP = True
+except ImportError:
+ HAS_BEAUTIFUL_SOUP = False
+
+try:
+ import langdetect
+ HAS_LANGDETECT = True
+except ImportError:
+ HAS_LANGDETECT = False
+
+try:
+ # PY3: HTMLParseError was removed in 3.5 as strict mode
+ # was deprecated in 3.3.
+ # https://docs.python.org/3.3/library/html.parser.html
+ from html.parser import HTMLParseError
+except ImportError:
+ class HTMLParseError(Exception):
+ pass
from beets import plugins
-from beets import config, ui
-
-
-# Global logger.
-
-log = logging.getLogger('beets')
+from beets import ui
+import beets
DIV_RE = re.compile(r'<(/?)div>?', re.I)
COMMENT_RE = re.compile(r'<!--.*-->', re.S)
TAG_RE = re.compile(r'<[^>]*>')
BREAK_RE = re.compile(r'\n?\s*<br([\s|/][^>]*)*>\s*\n?', re.I)
URL_CHARACTERS = {
- u'\u2018': u"'",
- u'\u2019': u"'",
- u'\u201c': u'"',
- u'\u201d': u'"',
- u'\u2010': u'-',
- u'\u2011': u'-',
- u'\u2012': u'-',
- u'\u2013': u'-',
- u'\u2014': u'-',
- u'\u2015': u'-',
- u'\u2016': u'-',
- u'\u2026': u'...',
+ '\u2018': "'",
+ '\u2019': "'",
+ '\u201c': '"',
+ '\u201d': '"',
+ '\u2010': '-',
+ '\u2011': '-',
+ '\u2012': '-',
+ '\u2013': '-',
+ '\u2014': '-',
+ '\u2015': '-',
+ '\u2016': '-',
+ '\u2026': '...',
}
+USER_AGENT = f'beets/{beets.__version__}'
+
+# The content for the base index.rst generated in ReST mode.
+REST_INDEX_TEMPLATE = '''Lyrics
+======
+
+* :ref:`Song index <genindex>`
+* :ref:`search`
+
+Artist index:
+
+.. toctree::
+ :maxdepth: 1
+ :glob:
+
+ artists/*
+'''
+
+# The content for the base conf.py generated.
+REST_CONF_TEMPLATE = '''# -*- coding: utf-8 -*-
+master_doc = 'index'
+project = 'Lyrics'
+copyright = 'none'
+author = 'Various Authors'
+latex_documents = [
+ (master_doc, 'Lyrics.tex', project,
+ author, 'manual'),
+]
+epub_title = project
+epub_author = author
+epub_publisher = author
+epub_copyright = copyright
+epub_exclude_files = ['search.html']
+epub_tocdepth = 1
+epub_tocdup = False
+'''
# Utilities.
-def fetch_url(url):
- """Retrieve the content at a given URL, or return None if the source
- is unreachable.
- """
+def unichar(i):
try:
- r = requests.get(url, verify=False)
- except requests.RequestException as exc:
- log.debug(u'lyrics request failed: {0}'.format(exc))
- return
- if r.status_code == requests.codes.ok:
- return r.text
- else:
- log.debug(u'failed to fetch: {0} ({1})'.format(url, r.status_code))
+ return chr(i)
+ except ValueError:
+ return struct.pack('i', i).decode('utf-32')
def unescape(text):
- """Resolves &#xxx; HTML entities (and some others)."""
- if isinstance(text, str):
- text = text.decode('utf8', 'ignore')
- out = text.replace(u' ', u' ')
+ """Resolve &#xxx; HTML entities (and some others)."""
+ if isinstance(text, bytes):
+ text = text.decode('utf-8', 'ignore')
+ out = text.replace(' ', ' ')
def replchar(m):
num = m.group(1)
- return unichr(int(num))
- out = re.sub(u"&#(\d+);", replchar, out)
+ return unichar(int(num))
+ out = re.sub("&#(\\d+);", replchar, out)
return out
@@ -89,44 +138,10 @@ def extract_text_between(html, start_marker, end_marker):
_, html = html.split(start_marker, 1)
html, _ = html.split(end_marker, 1)
except ValueError:
- return u''
+ return ''
return html
-def extract_text_in(html, starttag):
- """Extract the text from a <DIV> tag in the HTML starting with
- ``starttag``. Returns None if parsing fails.
- """
-
- # Strip off the leading text before opening tag.
- try:
- _, html = html.split(starttag, 1)
- except ValueError:
- return
-
- # Walk through balanced DIV tags.
- level = 0
- parts = []
- pos = 0
- for match in DIV_RE.finditer(html):
- if match.group(1): # Closing tag.
- level -= 1
- if level == 0:
- pos = match.end()
- else: # Opening tag.
- if level == 0:
- parts.append(html[pos:match.start()])
- level += 1
-
- if level == -1:
- parts.append(html[pos:match.start()])
- break
- else:
- print('no closing tag found!')
- return
- return u''.join(parts)
-
-
def search_pairs(item):
"""Yield a pairs of artists and titles to search for.
@@ -136,32 +151,42 @@ def search_pairs(item):
In addition to the artist and title obtained from the `item` the
method tries to strip extra information like paranthesized suffixes
and featured artists from the strings and add them as candidates.
+ The artist sort name is added as a fallback candidate to help in
+ cases where artist name includes special characters or is in a
+ non-latin script.
The method also tries to split multiple titles separated with `/`.
"""
+ def generate_alternatives(string, patterns):
+ """Generate string alternatives by extracting first matching group for
+ each given pattern.
+ """
+ alternatives = [string]
+ for pattern in patterns:
+ match = re.search(pattern, string, re.IGNORECASE)
+ if match:
+ alternatives.append(match.group(1))
+ return alternatives
- title, artist = item.title, item.artist
- titles = [title]
- artists = [artist]
+ title, artist, artist_sort = item.title, item.artist, item.artist_sort
- # Remove any featuring artists from the artists name
- pattern = r"(.*?) {0}".format(plugins.feat_tokens())
- match = re.search(pattern, artist, re.IGNORECASE)
- if match:
- artists.append(match.group(1))
+ patterns = [
+ # Remove any featuring artists from the artists name
+ fr"(.*?) {plugins.feat_tokens()}"]
+ artists = generate_alternatives(artist, patterns)
+ # Use the artist_sort as fallback only if it differs from artist to avoid
+ # repeated remote requests with the same search terms
+ if artist != artist_sort:
+ artists.append(artist_sort)
- # Remove a parenthesized suffix from a title string. Common
- # examples include (live), (remix), and (acoustic).
- pattern = r"(.+?)\s+[(].*[)]$"
- match = re.search(pattern, title, re.IGNORECASE)
- if match:
- titles.append(match.group(1))
-
- # Remove any featuring artists from the title
- pattern = r"(.*?) {0}".format(plugins.feat_tokens(for_artist=False))
- for title in titles[:]:
- match = re.search(pattern, title, re.IGNORECASE)
- if match:
- titles.append(match.group(1))
+ patterns = [
+ # Remove a parenthesized suffix from a title string. Common
+ # examples include (live), (remix), and (acoustic).
+ r"(.+?)\s+[(].*[)]$",
+ # Remove any featuring artists from the title
+ r"(.*?) {}".format(plugins.feat_tokens(for_artist=False)),
+ # Remove part of title after colon ':' for songs with subtitles
+ r"(.+?)\s*:.*"]
+ titles = generate_alternatives(title, patterns)
# Check for a dual song (e.g. Pink Floyd - Speak to Me / Breathe)
# and each of them.
@@ -174,131 +199,300 @@ def search_pairs(item):
return itertools.product(artists, multi_titles)
-def _encode(s):
- """Encode the string for inclusion in a URL (common to both
- LyricsWiki and Lyrics.com).
+def slug(text):
+ """Make a URL-safe, human-readable version of the given text
+
+ This will do the following:
+
+ 1. decode unicode characters into ASCII
+ 2. shift everything to lowercase
+ 3. strip whitespace
+ 4. replace other non-word characters with dashes
+ 5. strip extra dashes
+
+ This somewhat duplicates the :func:`Google.slugify` function but
+ slugify is not as generic as this one, which can be reused
+ elsewhere.
"""
- if isinstance(s, unicode):
- for char, repl in URL_CHARACTERS.items():
- s = s.replace(char, repl)
- s = s.encode('utf8', 'ignore')
- return urllib.quote(s)
-
-# Musixmatch
-
-MUSIXMATCH_URL_PATTERN = 'https://www.musixmatch.com/lyrics/%s/%s'
+ return re.sub(r'\W+', '-', unidecode(text).lower().strip()).strip('-')
-def fetch_musixmatch(artist, title):
- url = MUSIXMATCH_URL_PATTERN % (_lw_encode(artist.title()),
- _lw_encode(title.title()))
- html = fetch_url(url)
- if not html:
- return
- lyrics = extract_text_between(html, '"lyrics_body":', '"lyrics_language":')
- return lyrics.strip(',"').replace('\\n', '\n')
-
-# LyricsWiki.
-
-LYRICSWIKI_URL_PATTERN = 'http://lyrics.wikia.com/%s:%s'
+if HAS_BEAUTIFUL_SOUP:
+ def try_parse_html(html, **kwargs):
+ try:
+ return bs4.BeautifulSoup(html, 'html.parser', **kwargs)
+ except HTMLParseError:
+ return None
+else:
+ def try_parse_html(html, **kwargs):
+ return None
-def _lw_encode(s):
- s = re.sub(r'\s+', '_', s)
- s = s.replace("<", "Less_Than")
- s = s.replace(">", "Greater_Than")
- s = s.replace("#", "Number_")
- s = re.sub(r'[\[\{]', '(', s)
- s = re.sub(r'[\]\}]', ')', s)
- return _encode(s)
+class Backend:
+ REQUIRES_BS = False
+
+ def __init__(self, config, log):
+ self._log = log
+
+ @staticmethod
+ def _encode(s):
+ """Encode the string for inclusion in a URL"""
+ if isinstance(s, str):
+ for char, repl in URL_CHARACTERS.items():
+ s = s.replace(char, repl)
+ s = s.encode('utf-8', 'ignore')
+ return urllib.parse.quote(s)
+
+ def build_url(self, artist, title):
+ return self.URL_PATTERN % (self._encode(artist.title()),
+ self._encode(title.title()))
+
+ def fetch_url(self, url):
+ """Retrieve the content at a given URL, or return None if the source
+ is unreachable.
+ """
+ try:
+ # Disable the InsecureRequestWarning that comes from using
+ # `verify=false`.
+ # https://github.com/kennethreitz/requests/issues/2214
+ # We're not overly worried about the NSA MITMing our lyrics scraper
+ with warnings.catch_warnings():
+ warnings.simplefilter('ignore')
+ r = requests.get(url, verify=False, headers={
+ 'User-Agent': USER_AGENT,
+ })
+ except requests.RequestException as exc:
+ self._log.debug('lyrics request failed: {0}', exc)
+ return
+ if r.status_code == requests.codes.ok:
+ return r.text
+ else:
+ self._log.debug('failed to fetch: {0} ({1})', url, r.status_code)
+ return None
+
+ def fetch(self, artist, title):
+ raise NotImplementedError()
-def fetch_lyricswiki(artist, title):
- """Fetch lyrics from LyricsWiki."""
- url = LYRICSWIKI_URL_PATTERN % (_lw_encode(artist), _lw_encode(title))
- html = fetch_url(url)
- if not html:
- return
+class MusiXmatch(Backend):
+ REPLACEMENTS = {
+ r'\s+': '-',
+ '<': 'Less_Than',
+ '>': 'Greater_Than',
+ '#': 'Number_',
+ r'[\[\{]': '(',
+ r'[\]\}]': ')',
+ }
- lyrics = extract_text_in(html, u"<div class='lyricbox'>")
- if lyrics and 'Unfortunately, we are not licensed' not in lyrics:
+ URL_PATTERN = 'https://www.musixmatch.com/lyrics/%s/%s'
+
+ @classmethod
+ def _encode(cls, s):
+ for old, new in cls.REPLACEMENTS.items():
+ s = re.sub(old, new, s)
+
+ return super()._encode(s)
+
+ def fetch(self, artist, title):
+ url = self.build_url(artist, title)
+
+ html = self.fetch_url(url)
+ if not html:
+ return None
+ if "We detected that your IP is blocked" in html:
+ self._log.warning('we are blocked at MusixMatch: url %s failed'
+ % url)
+ return None
+ html_parts = html.split('<p class="mxm-lyrics__content')
+ # Sometimes lyrics come in 2 or more parts
+ lyrics_parts = []
+ for html_part in html_parts:
+ lyrics_parts.append(extract_text_between(html_part, '>', '</p>'))
+ lyrics = '\n'.join(lyrics_parts)
+ lyrics = lyrics.strip(',"').replace('\\n', '\n')
+ # another odd case: sometimes only that string remains, for
+ # missing songs. this seems to happen after being blocked
+ # above, when filling in the CAPTCHA.
+ if "Instant lyrics for all your music." in lyrics:
+ return None
+ # sometimes there are non-existent lyrics with some content
+ if 'Lyrics | Musixmatch' in lyrics:
+ return None
return lyrics
-# Lyrics.com.
+class Genius(Backend):
+ """Fetch lyrics from Genius via genius-api.
-LYRICSCOM_URL_PATTERN = 'http://www.lyrics.com/%s-lyrics-%s.html'
-LYRICSCOM_NOT_FOUND = (
- 'Sorry, we do not have the lyric',
- 'Submit Lyrics',
-)
+ Simply adapted from
+ bigishdata.com/2016/09/27/getting-song-lyrics-from-geniuss-api-scraping/
+ """
+ REQUIRES_BS = True
-def _lc_encode(s):
- s = re.sub(r'[^\w\s-]', '', s)
- s = re.sub(r'\s+', '-', s)
- return _encode(s).lower()
+ base_url = "https://api.genius.com"
+ def __init__(self, config, log):
+ super().__init__(config, log)
+ self.api_key = config['genius_api_key'].as_str()
+ self.headers = {
+ 'Authorization': "Bearer %s" % self.api_key,
+ 'User-Agent': USER_AGENT,
+ }
-def fetch_lyricscom(artist, title):
- """Fetch lyrics from Lyrics.com."""
- url = LYRICSCOM_URL_PATTERN % (_lc_encode(title), _lc_encode(artist))
- html = fetch_url(url)
- if not html:
- return
- lyrics = extract_text_between(html, '<div id="lyrics" class="SCREENONLY" '
- 'itemprop="description">', '</div>')
- if not lyrics:
- return
- for not_found_str in LYRICSCOM_NOT_FOUND:
- if not_found_str in lyrics:
+ def fetch(self, artist, title):
+ """Fetch lyrics from genius.com
+
+ Because genius doesn't allow accesssing lyrics via the api,
+ we first query the api for a url matching our artist & title,
+ then attempt to scrape that url for the lyrics.
+ """
+ json = self._search(artist, title)
+ if not json:
+ self._log.debug('Genius API request returned invalid JSON')
+ return None
+
+ # find a matching artist in the json
+ for hit in json["response"]["hits"]:
+ hit_artist = hit["result"]["primary_artist"]["name"]
+
+ if slug(hit_artist) == slug(artist):
+ html = self.fetch_url(hit["result"]["url"])
+ if not html:
+ return None
+ return self._scrape_lyrics_from_html(html)
+
+ self._log.debug('Genius failed to find a matching artist for \'{0}\'',
+ artist)
+ return None
+
+ def _search(self, artist, title):
+ """Searches the genius api for a given artist and title
+
+ https://docs.genius.com/#search-h2
+
+ :returns: json response
+ """
+ search_url = self.base_url + "/search"
+ data = {'q': title + " " + artist.lower()}
+ try:
+ response = requests.get(
+ search_url, data=data, headers=self.headers)
+ except requests.RequestException as exc:
+ self._log.debug('Genius API request failed: {0}', exc)
+ return None
+
+ try:
+ return response.json()
+ except ValueError:
+ return None
+
+ def _scrape_lyrics_from_html(self, html):
+ """Scrape lyrics from a given genius.com html"""
+
+ soup = try_parse_html(html)
+ if not soup:
return
- parts = lyrics.split('\n---\nLyrics powered by', 1)
- if parts:
- return parts[0]
+ # Remove script tags that they put in the middle of the lyrics.
+ [h.extract() for h in soup('script')]
+
+ # Most of the time, the page contains a div with class="lyrics" where
+ # all of the lyrics can be found already correctly formatted
+ # Sometimes, though, it packages the lyrics into separate divs, most
+ # likely for easier ad placement
+ lyrics_div = soup.find("div", class_="lyrics")
+ if not lyrics_div:
+ self._log.debug('Received unusual song page html')
+ verse_div = soup.find("div",
+ class_=re.compile("Lyrics__Container"))
+ if not verse_div:
+ if soup.find("div",
+ class_=re.compile("LyricsPlaceholder__Message"),
+ string="This song is an instrumental"):
+ self._log.debug('Detected instrumental')
+ return "[Instrumental]"
+ else:
+ self._log.debug("Couldn't scrape page using known layouts")
+ return None
+
+ lyrics_div = verse_div.parent
+ for br in lyrics_div.find_all("br"):
+ br.replace_with("\n")
+ ads = lyrics_div.find_all("div",
+ class_=re.compile("InreadAd__Container"))
+ for ad in ads:
+ ad.replace_with("\n")
+
+ return lyrics_div.get_text()
-# Optional Google custom search API backend.
+class Tekstowo(Backend):
+ # Fetch lyrics from Tekstowo.pl.
+ REQUIRES_BS = True
-def slugify(text):
- """Normalize a string and remove non-alphanumeric characters.
- """
- text = re.sub(r"[-'_\s]", '_', text)
- text = re.sub(r"_+", '_', text).strip('_')
- pat = "([^,\(]*)\((.*?)\)" # Remove content within parentheses
- text = re.sub(pat, '\g<1>', text).strip()
- try:
- text = unicodedata.normalize('NFKD', text).encode('ascii', 'ignore')
- text = unicode(re.sub('[-\s]+', ' ', text))
- except UnicodeDecodeError:
- log.exception(u"Failing to normalize '{0}'".format(text))
- return text
+ BASE_URL = 'http://www.tekstowo.pl'
+ URL_PATTERN = BASE_URL + '/wyszukaj.html?search-title=%s&search-artist=%s'
+ def fetch(self, artist, title):
+ url = self.build_url(title, artist)
+ search_results = self.fetch_url(url)
+ if not search_results:
+ return None
-BY_TRANS = ['by', 'par', 'de', 'von']
-LYRICS_TRANS = ['lyrics', 'paroles', 'letras', 'liedtexte']
+ song_page_url = self.parse_search_results(search_results)
+ if not song_page_url:
+ return None
+ song_page_html = self.fetch_url(song_page_url)
+ if not song_page_html:
+ return None
-def is_page_candidate(urlLink, urlTitle, title, artist):
- """Return True if the URL title makes it a good candidate to be a
- page that contains lyrics of title by artist.
- """
- title = slugify(title.lower())
- artist = slugify(artist.lower())
- sitename = re.search(u"//([^/]+)/.*", slugify(urlLink.lower())).group(1)
- urlTitle = slugify(urlTitle.lower())
- # Check if URL title contains song title (exact match)
- if urlTitle.find(title) != -1:
- return True
- # or try extracting song title from URL title and check if
- # they are close enough
- tokens = [by + '_' + artist for by in BY_TRANS] + \
- [artist, sitename, sitename.replace('www.', '')] + LYRICS_TRANS
- songTitle = re.sub(u'(%s)' % u'|'.join(tokens), u'', urlTitle)
- songTitle = songTitle.strip('_|')
- typoRatio = .9
- return difflib.SequenceMatcher(None, songTitle, title).ratio() >= typoRatio
+ return self.extract_lyrics(song_page_html)
+
+ def parse_search_results(self, html):
+ html = _scrape_strip_cruft(html)
+ html = _scrape_merge_paragraphs(html)
+
+ soup = try_parse_html(html)
+ if not soup:
+ return None
+
+ content_div = soup.find("div", class_="content")
+ if not content_div:
+ return None
+
+ card_div = content_div.find("div", class_="card")
+ if not card_div:
+ return None
+
+ song_rows = card_div.find_all("div", class_="box-przeboje")
+ if not song_rows:
+ return None
+
+ song_row = song_rows[0]
+ if not song_row:
+ return None
+
+ link = song_row.find('a')
+ if not link:
+ return None
+
+ return self.BASE_URL + link.get('href')
+
+ def extract_lyrics(self, html):
+ html = _scrape_strip_cruft(html)
+ html = _scrape_merge_paragraphs(html)
+
+ soup = try_parse_html(html)
+ if not soup:
+ return None
+
+ lyrics_div = soup.find("div", class_="song-text")
+ if not lyrics_div:
+ return None
+
+ return lyrics_div.get_text()
def remove_credits(text):
@@ -315,36 +509,6 @@ def remove_credits(text):
return text
-def is_lyrics(text, artist=None):
- """Determine whether the text seems to be valid lyrics.
- """
- if not text:
- return False
- badTriggersOcc = []
- nbLines = text.count('\n')
- if nbLines <= 1:
- log.debug(u"Ignoring too short lyrics '{0}'".format(text))
- return False
- elif nbLines < 5:
- badTriggersOcc.append('too_short')
- else:
- # Lyrics look legit, remove credits to avoid being penalized further
- # down
- text = remove_credits(text)
-
- badTriggers = ['lyrics', 'copyright', 'property', 'links']
- if artist:
- badTriggersOcc += [artist]
-
- for item in badTriggers:
- badTriggersOcc += [item] * len(re.findall(r'\W%s\W' % item,
- text, re.I))
-
- if badTriggersOcc:
- log.debug(u'Bad triggers detected: {0}'.format(badTriggersOcc))
- return len(badTriggersOcc) < 2
-
-
def _scrape_strip_cruft(html, plain_text_out=False):
"""Clean up HTML
"""
@@ -353,7 +517,8 @@ def _scrape_strip_cruft(html, plain_text_out=False):
html = html.replace('\r', '\n') # Normalize EOL.
html = re.sub(r' +', ' ', html) # Whitespaces collapse.
html = BREAK_RE.sub('\n', html) # <br> eats up surrounding '\n'.
- html = re.sub(r'<(script).*?</\1>(?s)', '', html) # Strip script tags.
+ html = re.sub(r'(?s)<(script).*?</\1>', '', html) # Strip script tags.
+ html = re.sub('\u2005', " ", html) # replace unicode with regular space
if plain_text_out: # Strip remaining HTML tags
html = COMMENT_RE.sub('', html)
@@ -373,11 +538,6 @@ def scrape_lyrics_from_html(html):
"""Scrape lyrics from a URL. If no lyrics can be found, return None
instead.
"""
- from bs4 import SoupStrainer, BeautifulSoup
-
- if not html:
- return None
-
def is_text_notcode(text):
length = len(text)
return (length > 20 and
@@ -387,123 +547,371 @@ def scrape_lyrics_from_html(html):
html = _scrape_merge_paragraphs(html)
# extract all long text blocks that are not code
- try:
- soup = BeautifulSoup(html, "html.parser",
- parse_only=SoupStrainer(text=is_text_notcode))
- except HTMLParseError:
+ soup = try_parse_html(html, parse_only=SoupStrainer(text=is_text_notcode))
+ if not soup:
+ return None
+
+ # Get the longest text element (if any).
+ strings = sorted(soup.stripped_strings, key=len, reverse=True)
+ if strings:
+ return strings[0]
+ else:
return None
- soup = sorted(soup.stripped_strings, key=len)[-1]
- return soup
-def fetch_google(artist, title):
- """Fetch lyrics from Google search results.
- """
- query = u"%s %s" % (artist, title)
- api_key = config['lyrics']['google_API_key'].get(unicode)
- engine_id = config['lyrics']['google_engine_ID'].get(unicode)
- url = u'https://www.googleapis.com/customsearch/v1?key=%s&cx=%s&q=%s' % \
- (api_key, engine_id, urllib.quote(query.encode('utf8')))
+class Google(Backend):
+ """Fetch lyrics from Google search results."""
- data = urllib.urlopen(url)
- data = json.load(data)
- if 'error' in data:
- reason = data['error']['errors'][0]['reason']
- log.debug(u'google lyrics backend error: {0}'.format(reason))
- return
+ REQUIRES_BS = True
- if 'items' in data.keys():
- for item in data['items']:
- urlLink = item['link']
- urlTitle = item.get('title', u'')
- if not is_page_candidate(urlLink, urlTitle, title, artist):
- continue
- html = fetch_url(urlLink)
- lyrics = scrape_lyrics_from_html(html)
- if not lyrics:
- continue
+ def __init__(self, config, log):
+ super().__init__(config, log)
+ self.api_key = config['google_API_key'].as_str()
+ self.engine_id = config['google_engine_ID'].as_str()
- if is_lyrics(lyrics, artist):
- log.debug(u'got lyrics from {0}'.format(item['displayLink']))
- return lyrics
+ def is_lyrics(self, text, artist=None):
+ """Determine whether the text seems to be valid lyrics.
+ """
+ if not text:
+ return False
+ bad_triggers_occ = []
+ nb_lines = text.count('\n')
+ if nb_lines <= 1:
+ self._log.debug("Ignoring too short lyrics '{0}'", text)
+ return False
+ elif nb_lines < 5:
+ bad_triggers_occ.append('too_short')
+ else:
+ # Lyrics look legit, remove credits to avoid being penalized
+ # further down
+ text = remove_credits(text)
+ bad_triggers = ['lyrics', 'copyright', 'property', 'links']
+ if artist:
+ bad_triggers += [artist]
-# Plugin logic.
+ for item in bad_triggers:
+ bad_triggers_occ += [item] * len(re.findall(r'\W%s\W' % item,
+ text, re.I))
-SOURCES = ['google', 'lyricwiki', 'lyrics.com', 'musixmatch']
-SOURCE_BACKENDS = {
- 'google': fetch_google,
- 'lyricwiki': fetch_lyricswiki,
- 'lyrics.com': fetch_lyricscom,
- 'musixmatch': fetch_musixmatch,
-}
+ if bad_triggers_occ:
+ self._log.debug('Bad triggers detected: {0}', bad_triggers_occ)
+ return len(bad_triggers_occ) < 2
+
+ def slugify(self, text):
+ """Normalize a string and remove non-alphanumeric characters.
+ """
+ text = re.sub(r"[-'_\s]", '_', text)
+ text = re.sub(r"_+", '_', text).strip('_')
+ pat = r"([^,\(]*)\((.*?)\)" # Remove content within parentheses
+ text = re.sub(pat, r'\g<1>', text).strip()
+ try:
+ text = unicodedata.normalize('NFKD', text).encode('ascii',
+ 'ignore')
+ text = str(re.sub(r'[-\s]+', ' ', text.decode('utf-8')))
+ except UnicodeDecodeError:
+ self._log.exception("Failing to normalize '{0}'", text)
+ return text
+
+ BY_TRANS = ['by', 'par', 'de', 'von']
+ LYRICS_TRANS = ['lyrics', 'paroles', 'letras', 'liedtexte']
+
+ def is_page_candidate(self, url_link, url_title, title, artist):
+ """Return True if the URL title makes it a good candidate to be a
+ page that contains lyrics of title by artist.
+ """
+ title = self.slugify(title.lower())
+ artist = self.slugify(artist.lower())
+ sitename = re.search("//([^/]+)/.*",
+ self.slugify(url_link.lower())).group(1)
+ url_title = self.slugify(url_title.lower())
+
+ # Check if URL title contains song title (exact match)
+ if url_title.find(title) != -1:
+ return True
+
+ # or try extracting song title from URL title and check if
+ # they are close enough
+ tokens = [by + '_' + artist for by in self.BY_TRANS] + \
+ [artist, sitename, sitename.replace('www.', '')] + \
+ self.LYRICS_TRANS
+ tokens = [re.escape(t) for t in tokens]
+ song_title = re.sub('(%s)' % '|'.join(tokens), '', url_title)
+
+ song_title = song_title.strip('_|')
+ typo_ratio = .9
+ ratio = difflib.SequenceMatcher(None, song_title, title).ratio()
+ return ratio >= typo_ratio
+
+ def fetch(self, artist, title):
+ query = f"{artist} {title}"
+ url = 'https://www.googleapis.com/customsearch/v1?key=%s&cx=%s&q=%s' \
+ % (self.api_key, self.engine_id,
+ urllib.parse.quote(query.encode('utf-8')))
+
+ data = self.fetch_url(url)
+ if not data:
+ self._log.debug('google backend returned no data')
+ return None
+ try:
+ data = json.loads(data)
+ except ValueError as exc:
+ self._log.debug('google backend returned malformed JSON: {}', exc)
+ if 'error' in data:
+ reason = data['error']['errors'][0]['reason']
+ self._log.debug('google backend error: {0}', reason)
+ return None
+
+ if 'items' in data.keys():
+ for item in data['items']:
+ url_link = item['link']
+ url_title = item.get('title', '')
+ if not self.is_page_candidate(url_link, url_title,
+ title, artist):
+ continue
+ html = self.fetch_url(url_link)
+ if not html:
+ continue
+ lyrics = scrape_lyrics_from_html(html)
+ if not lyrics:
+ continue
+
+ if self.is_lyrics(lyrics, artist):
+ self._log.debug('got lyrics from {0}',
+ item['displayLink'])
+ return lyrics
+
+ return None
class LyricsPlugin(plugins.BeetsPlugin):
+ SOURCES = ['google', 'musixmatch', 'genius', 'tekstowo']
+ SOURCE_BACKENDS = {
+ 'google': Google,
+ 'musixmatch': MusiXmatch,
+ 'genius': Genius,
+ 'tekstowo': Tekstowo,
+ }
+
def __init__(self):
- super(LyricsPlugin, self).__init__()
+ super().__init__()
self.import_stages = [self.imported]
self.config.add({
'auto': True,
+ 'bing_client_secret': None,
+ 'bing_lang_from': [],
+ 'bing_lang_to': None,
'google_API_key': None,
- 'google_engine_ID': u'009217259823014548361:lndtuqkycfu',
+ 'google_engine_ID': '009217259823014548361:lndtuqkycfu',
+ 'genius_api_key':
+ "Ryq93pUGm8bM6eUWwD_M3NOFFDAtp2yEE7W"
+ "76V-uFL5jks5dNvcGCdarqFjDhP9c",
'fallback': None,
'force': False,
- 'sources': SOURCES,
+ 'local': False,
+ 'sources': self.SOURCES,
})
+ self.config['bing_client_secret'].redact = True
+ self.config['google_API_key'].redact = True
+ self.config['google_engine_ID'].redact = True
+ self.config['genius_api_key'].redact = True
- available_sources = list(SOURCES)
- if not self.config['google_API_key'].get() and \
- 'google' in SOURCES:
- available_sources.remove('google')
- self.config['sources'] = plugins.sanitize_choices(
+ # State information for the ReST writer.
+ # First, the current artist we're writing.
+ self.artist = 'Unknown artist'
+ # The current album: False means no album yet.
+ self.album = False
+ # The current rest file content. None means the file is not
+ # open yet.
+ self.rest = None
+
+ available_sources = list(self.SOURCES)
+ sources = plugins.sanitize_choices(
self.config['sources'].as_str_seq(), available_sources)
- self.backends = []
- for key in self.config['sources'].as_str_seq():
- self.backends.append(SOURCE_BACKENDS[key])
+
+ if not HAS_BEAUTIFUL_SOUP:
+ sources = self.sanitize_bs_sources(sources)
+
+ if 'google' in sources:
+ if not self.config['google_API_key'].get():
+ # We log a *debug* message here because the default
+ # configuration includes `google`. This way, the source
+ # is silent by default but can be enabled just by
+ # setting an API key.
+ self._log.debug('Disabling google source: '
+ 'no API key configured.')
+ sources.remove('google')
+
+ self.config['bing_lang_from'] = [
+ x.lower() for x in self.config['bing_lang_from'].as_str_seq()]
+ self.bing_auth_token = None
+
+ if not HAS_LANGDETECT and self.config['bing_client_secret'].get():
+ self._log.warning('To use bing translations, you need to '
+ 'install the langdetect module. See the '
+ 'documentation for further details.')
+
+ self.backends = [self.SOURCE_BACKENDS[source](self.config, self._log)
+ for source in sources]
+
+ def sanitize_bs_sources(self, sources):
+ enabled_sources = []
+ for source in sources:
+ if self.SOURCE_BACKENDS[source].REQUIRES_BS:
+ self._log.debug('To use the %s lyrics source, you must '
+ 'install the beautifulsoup4 module. See '
+ 'the documentation for further details.'
+ % source)
+ else:
+ enabled_sources.append(source)
+
+ return enabled_sources
+
+ def get_bing_access_token(self):
+ params = {
+ 'client_id': 'beets',
+ 'client_secret': self.config['bing_client_secret'],
+ 'scope': "https://api.microsofttranslator.com",
+ 'grant_type': 'client_credentials',
+ }
+
+ oauth_url = 'https://datamarket.accesscontrol.windows.net/v2/OAuth2-13'
+ oauth_token = json.loads(requests.post(
+ oauth_url,
+ data=urllib.parse.urlencode(params)).content)
+ if 'access_token' in oauth_token:
+ return "Bearer " + oauth_token['access_token']
+ else:
+ self._log.warning('Could not get Bing Translate API access token.'
+ ' Check your "bing_client_secret" password')
def commands(self):
cmd = ui.Subcommand('lyrics', help='fetch song lyrics')
- cmd.parser.add_option('-p', '--print', dest='printlyr',
- action='store_true', default=False,
- help='print lyrics to console')
- cmd.parser.add_option('-f', '--force', dest='force_refetch',
- action='store_true', default=False,
- help='always re-download lyrics')
+ cmd.parser.add_option(
+ '-p', '--print', dest='printlyr',
+ action='store_true', default=False,
+ help='print lyrics to console',
+ )
+ cmd.parser.add_option(
+ '-r', '--write-rest', dest='writerest',
+ action='store', default=None, metavar='dir',
+ help='write lyrics to given directory as ReST files',
+ )
+ cmd.parser.add_option(
+ '-f', '--force', dest='force_refetch',
+ action='store_true', default=False,
+ help='always re-download lyrics',
+ )
+ cmd.parser.add_option(
+ '-l', '--local', dest='local_only',
+ action='store_true', default=False,
+ help='do not fetch missing lyrics',
+ )
def func(lib, opts, args):
# The "write to files" option corresponds to the
# import_write config value.
- write = config['import']['write'].get(bool)
- for item in lib.items(ui.decargs(args)):
- self.fetch_item_lyrics(
- lib, logging.INFO, item, write,
- opts.force_refetch or self.config['force'],
- )
- if opts.printlyr and item.lyrics:
- ui.print_(item.lyrics)
-
+ write = ui.should_write()
+ if opts.writerest:
+ self.writerest_indexes(opts.writerest)
+ items = lib.items(ui.decargs(args))
+ for item in items:
+ if not opts.local_only and not self.config['local']:
+ self.fetch_item_lyrics(
+ lib, item, write,
+ opts.force_refetch or self.config['force'],
+ )
+ if item.lyrics:
+ if opts.printlyr:
+ ui.print_(item.lyrics)
+ if opts.writerest:
+ self.appendrest(opts.writerest, item)
+ if opts.writerest and items:
+ # flush last artist & write to ReST
+ self.writerest(opts.writerest)
+ ui.print_('ReST files generated. to build, use one of:')
+ ui.print_(' sphinx-build -b html %s _build/html'
+ % opts.writerest)
+ ui.print_(' sphinx-build -b epub %s _build/epub'
+ % opts.writerest)
+ ui.print_((' sphinx-build -b latex %s _build/latex '
+ '&& make -C _build/latex all-pdf')
+ % opts.writerest)
cmd.func = func
return [cmd]
+ def appendrest(self, directory, item):
+ """Append the item to an ReST file
+
+ This will keep state (in the `rest` variable) in order to avoid
+ writing continuously to the same files.
+ """
+
+ if slug(self.artist) != slug(item.albumartist):
+ # Write current file and start a new one ~ item.albumartist
+ self.writerest(directory)
+ self.artist = item.albumartist.strip()
+ self.rest = "%s\n%s\n\n.. contents::\n :local:\n\n" \
+ % (self.artist,
+ '=' * len(self.artist))
+
+ if self.album != item.album:
+ tmpalbum = self.album = item.album.strip()
+ if self.album == '':
+ tmpalbum = 'Unknown album'
+ self.rest += "{}\n{}\n\n".format(tmpalbum, '-' * len(tmpalbum))
+ title_str = ":index:`%s`" % item.title.strip()
+ block = '| ' + item.lyrics.replace('\n', '\n| ')
+ self.rest += "{}\n{}\n\n{}\n\n".format(title_str,
+ '~' * len(title_str),
+ block)
+
+ def writerest(self, directory):
+ """Write self.rest to a ReST file
+ """
+ if self.rest is not None and self.artist is not None:
+ path = os.path.join(directory, 'artists',
+ slug(self.artist) + '.rst')
+ with open(path, 'wb') as output:
+ output.write(self.rest.encode('utf-8'))
+
+ def writerest_indexes(self, directory):
+ """Write conf.py and index.rst files necessary for Sphinx
+
+ We write minimal configurations that are necessary for Sphinx
+ to operate. We do not overwrite existing files so that
+ customizations are respected."""
+ try:
+ os.makedirs(os.path.join(directory, 'artists'))
+ except OSError as e:
+ if e.errno == errno.EEXIST:
+ pass
+ else:
+ raise
+ indexfile = os.path.join(directory, 'index.rst')
+ if not os.path.exists(indexfile):
+ with open(indexfile, 'w') as output:
+ output.write(REST_INDEX_TEMPLATE)
+ conffile = os.path.join(directory, 'conf.py')
+ if not os.path.exists(conffile):
+ with open(conffile, 'w') as output:
+ output.write(REST_CONF_TEMPLATE)
+
def imported(self, session, task):
"""Import hook for fetching lyrics automatically.
"""
if self.config['auto']:
for item in task.imported_items():
- self.fetch_item_lyrics(session.lib, logging.DEBUG, item,
+ self.fetch_item_lyrics(session.lib, item,
False, self.config['force'])
- def fetch_item_lyrics(self, lib, loglevel, item, write, force):
+ def fetch_item_lyrics(self, lib, item, write, force):
"""Fetch and store lyrics for a single item. If ``write``, then the
- lyrics will also be written to the file itself. The ``loglevel``
- parameter controls the visibility of the function's status log
- messages.
+ lyrics will also be written to the file itself.
"""
# Skip if the item already has lyrics.
if not force and item.lyrics:
- log.log(loglevel, u'lyrics already present: {0} - {1}'
- .format(item.artist, item.title))
+ self._log.info('lyrics already present: {0}', item)
return
lyrics = None
@@ -512,22 +920,26 @@ class LyricsPlugin(plugins.BeetsPlugin):
if any(lyrics):
break
- lyrics = u"\n\n---\n\n".join([l for l in lyrics if l])
+ lyrics = "\n\n---\n\n".join([l for l in lyrics if l])
if lyrics:
- log.log(loglevel, u'fetched lyrics: {0} - {1}'
- .format(item.artist, item.title))
+ self._log.info('fetched lyrics: {0}', item)
+ if HAS_LANGDETECT and self.config['bing_client_secret'].get():
+ lang_from = langdetect.detect(lyrics)
+ if self.config['bing_lang_to'].get() != lang_from and (
+ not self.config['bing_lang_from'] or (
+ lang_from in self.config[
+ 'bing_lang_from'].as_str_seq())):
+ lyrics = self.append_translation(
+ lyrics, self.config['bing_lang_to'])
else:
- log.log(loglevel, u'lyrics not found: {0} - {1}'
- .format(item.artist, item.title))
+ self._log.info('lyrics not found: {0}', item)
fallback = self.config['fallback'].get()
if fallback:
lyrics = fallback
else:
return
-
item.lyrics = lyrics
-
if write:
item.try_write()
item.store()
@@ -537,8 +949,36 @@ class LyricsPlugin(plugins.BeetsPlugin):
None if no lyrics were found.
"""
for backend in self.backends:
- lyrics = backend(artist, title)
+ lyrics = backend.fetch(artist, title)
if lyrics:
- log.debug(u'got lyrics from backend: {0}'
- .format(backend.__name__))
+ self._log.debug('got lyrics from backend: {0}',
+ backend.__class__.__name__)
return _scrape_strip_cruft(lyrics, True)
+
+ def append_translation(self, text, to_lang):
+ from xml.etree import ElementTree
+
+ if not self.bing_auth_token:
+ self.bing_auth_token = self.get_bing_access_token()
+ if self.bing_auth_token:
+ # Extract unique lines to limit API request size per song
+ text_lines = set(text.split('\n'))
+ url = ('https://api.microsofttranslator.com/v2/Http.svc/'
+ 'Translate?text=%s&to=%s' % ('|'.join(text_lines), to_lang))
+ r = requests.get(url,
+ headers={"Authorization ": self.bing_auth_token})
+ if r.status_code != 200:
+ self._log.debug('translation API error {}: {}', r.status_code,
+ r.text)
+ if 'token has expired' in r.text:
+ self.bing_auth_token = None
+ return self.append_translation(text, to_lang)
+ return text
+ lines_translated = ElementTree.fromstring(
+ r.text.encode('utf-8')).text
+ # Use a translation mapping dict to build resulting lyrics
+ translations = dict(zip(text_lines, lines_translated.split('|')))
+ result = ''
+ for line in text.split('\n'):
+ result += '{} / {}\n'.format(line, translations[line])
+ return result
diff --git a/lib/beetsplug/mbcollection.py b/lib/beetsplug/mbcollection.py
new file mode 100644
index 00000000..f4a0d161
--- /dev/null
+++ b/lib/beetsplug/mbcollection.py
@@ -0,0 +1,164 @@
+# This file is part of beets.
+# Copyright (c) 2011, Jeffrey Aylesworth <mail@jeffrey.red>
+#
+# 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.
+
+
+from beets.plugins import BeetsPlugin
+from beets.ui import Subcommand
+from beets import ui
+from beets import config
+import musicbrainzngs
+
+import re
+
+SUBMISSION_CHUNK_SIZE = 200
+FETCH_CHUNK_SIZE = 100
+UUID_REGEX = r'^[a-f0-9]{8}(-[a-f0-9]{4}){3}-[a-f0-9]{12}$'
+
+
+def mb_call(func, *args, **kwargs):
+ """Call a MusicBrainz API function and catch exceptions.
+ """
+ try:
+ return func(*args, **kwargs)
+ except musicbrainzngs.AuthenticationError:
+ raise ui.UserError('authentication with MusicBrainz failed')
+ except (musicbrainzngs.ResponseError, musicbrainzngs.NetworkError) as exc:
+ raise ui.UserError(f'MusicBrainz API error: {exc}')
+ except musicbrainzngs.UsageError:
+ raise ui.UserError('MusicBrainz credentials missing')
+
+
+def submit_albums(collection_id, release_ids):
+ """Add all of the release IDs to the indicated collection. Multiple
+ requests are made if there are many release IDs to submit.
+ """
+ for i in range(0, len(release_ids), SUBMISSION_CHUNK_SIZE):
+ chunk = release_ids[i:i + SUBMISSION_CHUNK_SIZE]
+ mb_call(
+ musicbrainzngs.add_releases_to_collection,
+ collection_id, chunk
+ )
+
+
+class MusicBrainzCollectionPlugin(BeetsPlugin):
+ def __init__(self):
+ super().__init__()
+ config['musicbrainz']['pass'].redact = True
+ musicbrainzngs.auth(
+ config['musicbrainz']['user'].as_str(),
+ config['musicbrainz']['pass'].as_str(),
+ )
+ self.config.add({
+ 'auto': False,
+ 'collection': '',
+ 'remove': False,
+ })
+ if self.config['auto']:
+ self.import_stages = [self.imported]
+
+ def _get_collection(self):
+ collections = mb_call(musicbrainzngs.get_collections)
+ if not collections['collection-list']:
+ raise ui.UserError('no collections exist for user')
+
+ # Get all collection IDs, avoiding event collections
+ collection_ids = [x['id'] for x in collections['collection-list']]
+ if not collection_ids:
+ raise ui.UserError('No collection found.')
+
+ # Check that the collection exists so we can present a nice error
+ collection = self.config['collection'].as_str()
+ if collection:
+ if collection not in collection_ids:
+ raise ui.UserError('invalid collection ID: {}'
+ .format(collection))
+ return collection
+
+ # No specified collection. Just return the first collection ID
+ return collection_ids[0]
+
+ def _get_albums_in_collection(self, id):
+ def _fetch(offset):
+ res = mb_call(
+ musicbrainzngs.get_releases_in_collection,
+ id,
+ limit=FETCH_CHUNK_SIZE,
+ offset=offset
+ )['collection']
+ return [x['id'] for x in res['release-list']], res['release-count']
+
+ offset = 0
+ albums_in_collection, release_count = _fetch(offset)
+ for i in range(0, release_count, FETCH_CHUNK_SIZE):
+ albums_in_collection += _fetch(offset)[0]
+ offset += FETCH_CHUNK_SIZE
+
+ return albums_in_collection
+
+ def commands(self):
+ mbupdate = Subcommand('mbupdate',
+ help='Update MusicBrainz collection')
+ mbupdate.parser.add_option('-r', '--remove',
+ action='store_true',
+ default=None,
+ dest='remove',
+ help='Remove albums not in beets library')
+ mbupdate.func = self.update_collection
+ return [mbupdate]
+
+ def remove_missing(self, collection_id, lib_albums):
+ lib_ids = {x.mb_albumid for x in lib_albums}
+ albums_in_collection = self._get_albums_in_collection(collection_id)
+ remove_me = list(set(albums_in_collection) - lib_ids)
+ for i in range(0, len(remove_me), FETCH_CHUNK_SIZE):
+ chunk = remove_me[i:i + FETCH_CHUNK_SIZE]
+ mb_call(
+ musicbrainzngs.remove_releases_from_collection,
+ collection_id, chunk
+ )
+
+ def update_collection(self, lib, opts, args):
+ self.config.set_args(opts)
+ remove_missing = self.config['remove'].get(bool)
+ self.update_album_list(lib, lib.albums(), remove_missing)
+
+ def imported(self, session, task):
+ """Add each imported album to the collection.
+ """
+ if task.is_album:
+ self.update_album_list(session.lib, [task.album])
+
+ def update_album_list(self, lib, album_list, remove_missing=False):
+ """Update the MusicBrainz collection from a list of Beets albums
+ """
+ collection_id = self._get_collection()
+
+ # Get a list of all the album IDs.
+ album_ids = []
+ for album in album_list:
+ aid = album.mb_albumid
+ if aid:
+ if re.match(UUID_REGEX, aid):
+ album_ids.append(aid)
+ else:
+ self._log.info('skipping invalid MBID: {0}', aid)
+
+ # Submit to MusicBrainz.
+ self._log.info(
+ 'Updating MusicBrainz collection {0}...', collection_id
+ )
+ submit_albums(collection_id, album_ids)
+ if remove_missing:
+ self.remove_missing(collection_id, lib.albums())
+ self._log.info('...MusicBrainz collection updated.')
diff --git a/lib/beetsplug/mbsubmit.py b/lib/beetsplug/mbsubmit.py
new file mode 100644
index 00000000..3ede0125
--- /dev/null
+++ b/lib/beetsplug/mbsubmit.py
@@ -0,0 +1,57 @@
+# This file is part of beets.
+# Copyright 2016, Adrian Sampson and Diego Moreda.
+#
+# 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.
+
+"""Aid in submitting information to MusicBrainz.
+
+This plugin allows the user to print track information in a format that is
+parseable by the MusicBrainz track parser [1]. Programmatic submitting is not
+implemented by MusicBrainz yet.
+
+[1] https://wiki.musicbrainz.org/History:How_To_Parse_Track_Listings
+"""
+
+
+from beets.autotag import Recommendation
+from beets.plugins import BeetsPlugin
+from beets.ui.commands import PromptChoice
+from beetsplug.info import print_data
+
+
+class MBSubmitPlugin(BeetsPlugin):
+ def __init__(self):
+ super().__init__()
+
+ self.config.add({
+ 'format': '$track. $title - $artist ($length)',
+ 'threshold': 'medium',
+ })
+
+ # Validate and store threshold.
+ self.threshold = self.config['threshold'].as_choice({
+ 'none': Recommendation.none,
+ 'low': Recommendation.low,
+ 'medium': Recommendation.medium,
+ 'strong': Recommendation.strong
+ })
+
+ self.register_listener('before_choose_candidate',
+ self.before_choose_candidate_event)
+
+ def before_choose_candidate_event(self, session, task):
+ if task.rec <= self.threshold:
+ return [PromptChoice('p', 'Print tracks', self.print_tracks)]
+
+ def print_tracks(self, session, task):
+ for i in sorted(task.items, key=lambda i: i.track):
+ print_data(None, i, self.config['format'].as_str())
diff --git a/lib/beetsplug/mbsync.py b/lib/beetsplug/mbsync.py
new file mode 100644
index 00000000..26778830
--- /dev/null
+++ b/lib/beetsplug/mbsync.py
@@ -0,0 +1,178 @@
+# This file is part of beets.
+# Copyright 2016, Jakob Schnitzer.
+#
+# 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.
+
+"""Update library's tags using MusicBrainz.
+"""
+
+from beets.plugins import BeetsPlugin, apply_item_changes
+from beets import autotag, library, ui, util
+from beets.autotag import hooks
+from collections import defaultdict
+
+import re
+
+MBID_REGEX = r"(\d|\w){8}-(\d|\w){4}-(\d|\w){4}-(\d|\w){4}-(\d|\w){12}"
+
+
+class MBSyncPlugin(BeetsPlugin):
+ def __init__(self):
+ super().__init__()
+
+ def commands(self):
+ cmd = ui.Subcommand('mbsync',
+ help='update metadata from musicbrainz')
+ cmd.parser.add_option(
+ '-p', '--pretend', action='store_true',
+ help='show all changes but do nothing')
+ cmd.parser.add_option(
+ '-m', '--move', action='store_true', dest='move',
+ help="move files in the library directory")
+ cmd.parser.add_option(
+ '-M', '--nomove', action='store_false', dest='move',
+ help="don't move files in library")
+ cmd.parser.add_option(
+ '-W', '--nowrite', action='store_false',
+ default=None, dest='write',
+ help="don't write updated metadata to files")
+ cmd.parser.add_format_option()
+ cmd.func = self.func
+ return [cmd]
+
+ def func(self, lib, opts, args):
+ """Command handler for the mbsync function.
+ """
+ move = ui.should_move(opts.move)
+ pretend = opts.pretend
+ write = ui.should_write(opts.write)
+ query = ui.decargs(args)
+
+ self.singletons(lib, query, move, pretend, write)
+ self.albums(lib, query, move, pretend, write)
+
+ def singletons(self, lib, query, move, pretend, write):
+ """Retrieve and apply info from the autotagger for items matched by
+ query.
+ """
+ for item in lib.items(query + ['singleton:true']):
+ item_formatted = format(item)
+ if not item.mb_trackid:
+ self._log.info('Skipping singleton with no mb_trackid: {0}',
+ item_formatted)
+ continue
+
+ # Do we have a valid MusicBrainz track ID?
+ if not re.match(MBID_REGEX, item.mb_trackid):
+ self._log.info('Skipping singleton with invalid mb_trackid:' +
+ ' {0}', item_formatted)
+ continue
+
+ # Get the MusicBrainz recording info.
+ track_info = hooks.track_for_mbid(item.mb_trackid)
+ if not track_info:
+ self._log.info('Recording ID not found: {0} for track {0}',
+ item.mb_trackid,
+ item_formatted)
+ continue
+
+ # Apply.
+ with lib.transaction():
+ autotag.apply_item_metadata(item, track_info)
+ apply_item_changes(lib, item, move, pretend, write)
+
+ def albums(self, lib, query, move, pretend, write):
+ """Retrieve and apply info from the autotagger for albums matched by
+ query and their items.
+ """
+ # Process matching albums.
+ for a in lib.albums(query):
+ album_formatted = format(a)
+ if not a.mb_albumid:
+ self._log.info('Skipping album with no mb_albumid: {0}',
+ album_formatted)
+ continue
+
+ items = list(a.items())
+
+ # Do we have a valid MusicBrainz album ID?
+ if not re.match(MBID_REGEX, a.mb_albumid):
+ self._log.info('Skipping album with invalid mb_albumid: {0}',
+ album_formatted)
+ continue
+
+ # Get the MusicBrainz album information.
+ album_info = hooks.album_for_mbid(a.mb_albumid)
+ if not album_info:
+ self._log.info('Release ID {0} not found for album {1}',
+ a.mb_albumid,
+ album_formatted)
+ continue
+
+ # Map release track and recording MBIDs to their information.
+ # Recordings can appear multiple times on a release, so each MBID
+ # maps to a list of TrackInfo objects.
+ releasetrack_index = {}
+ track_index = defaultdict(list)
+ for track_info in album_info.tracks:
+ releasetrack_index[track_info.release_track_id] = track_info
+ track_index[track_info.track_id].append(track_info)
+
+ # Construct a track mapping according to MBIDs (release track MBIDs
+ # first, if available, and recording MBIDs otherwise). This should
+ # work for albums that have missing or extra tracks.
+ mapping = {}
+ for item in items:
+ if item.mb_releasetrackid and \
+ item.mb_releasetrackid in releasetrack_index:
+ mapping[item] = releasetrack_index[item.mb_releasetrackid]
+ else:
+ candidates = track_index[item.mb_trackid]
+ if len(candidates) == 1:
+ mapping[item] = candidates[0]
+ else:
+ # If there are multiple copies of a recording, they are
+ # disambiguated using their disc and track number.
+ for c in candidates:
+ if (c.medium_index == item.track and
+ c.medium == item.disc):
+ mapping[item] = c
+ break
+
+ # Apply.
+ self._log.debug('applying changes to {}', album_formatted)
+ with lib.transaction():
+ autotag.apply_metadata(album_info, mapping)
+ changed = False
+ # Find any changed item to apply MusicBrainz changes to album.
+ any_changed_item = items[0]
+ for item in items:
+ item_changed = ui.show_model_changes(item)
+ changed |= item_changed
+ if item_changed:
+ any_changed_item = item
+ apply_item_changes(lib, item, move, pretend, write)
+
+ if not changed:
+ # No change to any item.
+ continue
+
+ if not pretend:
+ # Update album structure to reflect an item in it.
+ for key in library.Album.item_keys:
+ a[key] = any_changed_item[key]
+ a.store()
+
+ # Move album art (and any inconsistent items).
+ if move and lib.directory in util.ancestry(items[0].path):
+ self._log.debug('moving album {0}', album_formatted)
+ a.move()
diff --git a/lib/beetsplug/metasync/__init__.py b/lib/beetsplug/metasync/__init__.py
new file mode 100644
index 00000000..361071fb
--- /dev/null
+++ b/lib/beetsplug/metasync/__init__.py
@@ -0,0 +1,138 @@
+# This file is part of beets.
+# Copyright 2016, Heinz Wiesinger.
+#
+# 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 music player libraries
+"""
+
+
+from abc import abstractmethod, ABCMeta
+from importlib import import_module
+
+from confuse import ConfigValueError
+from beets import ui
+from beets.plugins import BeetsPlugin
+
+
+METASYNC_MODULE = 'beetsplug.metasync'
+
+# Dictionary to map the MODULE and the CLASS NAME of meta sources
+SOURCES = {
+ 'amarok': 'Amarok',
+ 'itunes': 'Itunes',
+}
+
+
+class MetaSource(metaclass=ABCMeta):
+ def __init__(self, config, log):
+ self.item_types = {}
+ self.config = config
+ self._log = log
+
+ @abstractmethod
+ def sync_from_source(self, item):
+ pass
+
+
+def load_meta_sources():
+ """ Returns a dictionary of all the MetaSources
+ E.g., {'itunes': Itunes} with isinstance(Itunes, MetaSource) true
+ """
+ meta_sources = {}
+
+ for module_path, class_name in SOURCES.items():
+ module = import_module(METASYNC_MODULE + '.' + module_path)
+ meta_sources[class_name.lower()] = getattr(module, class_name)
+
+ return meta_sources
+
+
+META_SOURCES = load_meta_sources()
+
+
+def load_item_types():
+ """ Returns a dictionary containing the item_types of all the MetaSources
+ """
+ item_types = {}
+ for meta_source in META_SOURCES.values():
+ item_types.update(meta_source.item_types)
+ return item_types
+
+
+class MetaSyncPlugin(BeetsPlugin):
+
+ item_types = load_item_types()
+
+ def __init__(self):
+ super().__init__()
+
+ def commands(self):
+ cmd = ui.Subcommand('metasync',
+ help='update metadata from music player libraries')
+ cmd.parser.add_option('-p', '--pretend', action='store_true',
+ help='show all changes but do nothing')
+ cmd.parser.add_option('-s', '--source', default=[],
+ action='append', dest='sources',
+ help='comma-separated list of sources to sync')
+ cmd.parser.add_format_option()
+ cmd.func = self.func
+ return [cmd]
+
+ def func(self, lib, opts, args):
+ """Command handler for the metasync function.
+ """
+ pretend = opts.pretend
+ query = ui.decargs(args)
+
+ sources = []
+ for source in opts.sources:
+ sources.extend(source.split(','))
+
+ sources = sources or self.config['source'].as_str_seq()
+
+ meta_source_instances = {}
+ items = lib.items(query)
+
+ # Avoid needlessly instantiating meta sources (can be expensive)
+ if not items:
+ self._log.info('No items found matching query')
+ return
+
+ # Instantiate the meta sources
+ for player in sources:
+ try:
+ cls = META_SOURCES[player]
+ except KeyError:
+ self._log.error('Unknown metadata source \'{}\''.format(
+ player))
+
+ try:
+ meta_source_instances[player] = cls(self.config, self._log)
+ except (ImportError, ConfigValueError) as e:
+ self._log.error('Failed to instantiate metadata source '
+ '\'{}\': {}'.format(player, e))
+
+ # Avoid needlessly iterating over items
+ if not meta_source_instances:
+ self._log.error('No valid metadata sources found')
+ return
+
+ # Sync the items with all of the meta sources
+ for item in items:
+ for meta_source in meta_source_instances.values():
+ meta_source.sync_from_source(item)
+
+ changed = ui.show_model_changes(item)
+
+ if changed and not pretend:
+ item.store()
diff --git a/lib/beetsplug/metasync/amarok.py b/lib/beetsplug/metasync/amarok.py
new file mode 100644
index 00000000..a49eecc3
--- /dev/null
+++ b/lib/beetsplug/metasync/amarok.py
@@ -0,0 +1,110 @@
+# This file is part of beets.
+# Copyright 2016, Heinz Wiesinger.
+#
+# 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 amarok's library via dbus
+"""
+
+
+from os.path import basename
+from datetime import datetime
+from time import mktime
+from xml.sax.saxutils import quoteattr
+
+from beets.util import displayable_path
+from beets.dbcore import types
+from beets.library import DateType
+from beetsplug.metasync import MetaSource
+
+
+def import_dbus():
+ try:
+ return __import__('dbus')
+ except ImportError:
+ return None
+
+dbus = import_dbus()
+
+
+class Amarok(MetaSource):
+
+ item_types = {
+ 'amarok_rating': types.INTEGER,
+ 'amarok_score': types.FLOAT,
+ 'amarok_uid': types.STRING,
+ 'amarok_playcount': types.INTEGER,
+ 'amarok_firstplayed': DateType(),
+ 'amarok_lastplayed': DateType(),
+ }
+
+ query_xml = '<query version="1.0"> \
+ <filters> \
+ <and><include field="filename" value=%s /></and> \
+ </filters> \
+ </query>'
+
+ def __init__(self, config, log):
+ super().__init__(config, log)
+
+ if not dbus:
+ raise ImportError('failed to import dbus')
+
+ self.collection = \
+ dbus.SessionBus().get_object('org.kde.amarok', '/Collection')
+
+ def sync_from_source(self, item):
+ path = displayable_path(item.path)
+
+ # amarok unfortunately doesn't allow searching for the full path, only
+ # for the patch relative to the mount point. But the full path is part
+ # of the result set. So query for the filename and then try to match
+ # the correct item from the results we get back
+ results = self.collection.Query(
+ self.query_xml % quoteattr(basename(path))
+ )
+ for result in results:
+ if result['xesam:url'] != path:
+ continue
+
+ item.amarok_rating = result['xesam:userRating']
+ item.amarok_score = result['xesam:autoRating']
+ item.amarok_playcount = result['xesam:useCount']
+ item.amarok_uid = \
+ result['xesam:id'].replace('amarok-sqltrackuid://', '')
+
+ if result['xesam:firstUsed'][0][0] != 0:
+ # These dates are stored as timestamps in amarok's db, but
+ # exposed over dbus as fixed integers in the current timezone.
+ first_played = datetime(
+ result['xesam:firstUsed'][0][0],
+ result['xesam:firstUsed'][0][1],
+ result['xesam:firstUsed'][0][2],
+ result['xesam:firstUsed'][1][0],
+ result['xesam:firstUsed'][1][1],
+ result['xesam:firstUsed'][1][2]
+ )
+
+ if result['xesam:lastUsed'][0][0] != 0:
+ last_played = datetime(
+ result['xesam:lastUsed'][0][0],
+ result['xesam:lastUsed'][0][1],
+ result['xesam:lastUsed'][0][2],
+ result['xesam:lastUsed'][1][0],
+ result['xesam:lastUsed'][1][1],
+ result['xesam:lastUsed'][1][2]
+ )
+ else:
+ last_played = first_played
+
+ item.amarok_firstplayed = mktime(first_played.timetuple())
+ item.amarok_lastplayed = mktime(last_played.timetuple())
diff --git a/lib/beetsplug/metasync/itunes.py b/lib/beetsplug/metasync/itunes.py
new file mode 100644
index 00000000..e50a5713
--- /dev/null
+++ b/lib/beetsplug/metasync/itunes.py
@@ -0,0 +1,125 @@
+# This file is part of beets.
+# Copyright 2016, 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 urllib.parse import urlparse, unquote
+from time import mktime
+
+from beets import util
+from beets.dbcore import types
+from beets.library import DateType
+from confuse import ConfigValueError
+from beetsplug.metasync import MetaSource
+
+
+@contextmanager
+def create_temporary_copy(path):
+ temp_dir = tempfile.mkdtemp()
+ temp_path = os.path.join(temp_dir, 'temp_itunes_lib')
+ shutil.copyfile(path, temp_path)
+ try:
+ yield temp_path
+ finally:
+ shutil.rmtree(temp_dir)
+
+
+def _norm_itunes_path(path):
+ # Itunes prepends the location with 'file://' on posix systems,
+ # and with 'file://localhost/' on Windows systems.
+ # The actual path to the file is always saved as posix form
+ # E.g., 'file://Users/Music/bar' or 'file://localhost/G:/Music/bar'
+
+ # The entire path will also be capitalized (e.g., '/Music/Alt-J')
+ # Note that this means the path will always have a leading separator,
+ # which is unwanted in the case of Windows systems.
+ # E.g., '\\G:\\Music\\bar' needs to be stripped to 'G:\\Music\\bar'
+
+ return util.bytestring_path(os.path.normpath(
+ unquote(urlparse(path).path)).lstrip('\\')).lower()
+
+
+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(),
+ 'itunes_dateadded': DateType(),
+ }
+
+ def __init__(self, config, log):
+ super().__init__(config, log)
+
+ config.add({'itunes': {
+ 'library': '~/Music/iTunes/iTunes Library.xml'
+ }})
+
+ # Load the iTunes library, which has to be the .xml one (not the .itl)
+ library_path = config['itunes']['library'].as_filename()
+
+ try:
+ self._log.debug(
+ f'loading iTunes library from {library_path}')
+ with create_temporary_copy(library_path) as library_copy:
+ with open(library_copy, 'rb') as library_copy_f:
+ raw_library = plistlib.load(library_copy_f)
+ except OSError as e:
+ raise ConfigValueError('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 = ': please ensure that the configured path' \
+ ' points to the .XML library'
+ else:
+ hint = ''
+ raise ConfigValueError('invalid iTunes library' + hint)
+
+ # Make the iTunes library queryable using the path
+ self.collection = {_norm_itunes_path(track['Location']): track
+ for track in raw_library['Tracks'].values()
+ if 'Location' in track}
+
+ def sync_from_source(self, item):
+ result = self.collection.get(util.bytestring_path(item.path).lower())
+
+ if not result:
+ self._log.warning(f'no iTunes match found for {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())
+
+ if result.get('Date Added'):
+ item.itunes_dateadded = mktime(
+ result.get('Date Added').timetuple())
diff --git a/lib/beetsplug/missing.py b/lib/beetsplug/missing.py
new file mode 100644
index 00000000..771978c1
--- /dev/null
+++ b/lib/beetsplug/missing.py
@@ -0,0 +1,226 @@
+# This file is part of beets.
+# Copyright 2016, Pedro Silva.
+# Copyright 2017, Quentin Young.
+#
+# 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.
+
+"""List missing tracks.
+"""
+
+import musicbrainzngs
+
+from musicbrainzngs.musicbrainz import MusicBrainzError
+from collections import defaultdict
+from beets.autotag import hooks
+from beets.library import Item
+from beets.plugins import BeetsPlugin
+from beets.ui import decargs, print_, Subcommand
+from beets import config
+from beets.dbcore import types
+
+
+def _missing_count(album):
+ """Return number of missing items in `album`.
+ """
+ return (album.albumtotal or 0) - len(album.items())
+
+
+def _item(track_info, album_info, album_id):
+ """Build and return `item` from `track_info` and `album info`
+ objects. `item` is missing what fields cannot be obtained from
+ MusicBrainz alone (encoder, rg_track_gain, rg_track_peak,
+ rg_album_gain, rg_album_peak, original_year, original_month,
+ original_day, length, bitrate, format, samplerate, bitdepth,
+ channels, mtime.)
+ """
+ t = track_info
+ a = album_info
+
+ return Item(**{
+ 'album_id': album_id,
+ 'album': a.album,
+ 'albumartist': a.artist,
+ 'albumartist_credit': a.artist_credit,
+ 'albumartist_sort': a.artist_sort,
+ 'albumdisambig': a.albumdisambig,
+ 'albumstatus': a.albumstatus,
+ 'albumtype': a.albumtype,
+ 'artist': t.artist,
+ 'artist_credit': t.artist_credit,
+ 'artist_sort': t.artist_sort,
+ 'asin': a.asin,
+ 'catalognum': a.catalognum,
+ 'comp': a.va,
+ 'country': a.country,
+ 'day': a.day,
+ 'disc': t.medium,
+ 'disctitle': t.disctitle,
+ 'disctotal': a.mediums,
+ 'label': a.label,
+ 'language': a.language,
+ 'length': t.length,
+ 'mb_albumid': a.album_id,
+ 'mb_artistid': t.artist_id,
+ 'mb_releasegroupid': a.releasegroup_id,
+ 'mb_trackid': t.track_id,
+ 'media': t.media,
+ 'month': a.month,
+ 'script': a.script,
+ 'title': t.title,
+ 'track': t.index,
+ 'tracktotal': len(a.tracks),
+ 'year': a.year,
+ })
+
+
+class MissingPlugin(BeetsPlugin):
+ """List missing tracks
+ """
+
+ album_types = {
+ 'missing': types.INTEGER,
+ }
+
+ def __init__(self):
+ super().__init__()
+
+ self.config.add({
+ 'count': False,
+ 'total': False,
+ 'album': False,
+ })
+
+ self.album_template_fields['missing'] = _missing_count
+
+ self._command = Subcommand('missing',
+ help=__doc__,
+ aliases=['miss'])
+ self._command.parser.add_option(
+ '-c', '--count', dest='count', action='store_true',
+ help='count missing tracks per album')
+ self._command.parser.add_option(
+ '-t', '--total', dest='total', action='store_true',
+ help='count total of missing tracks')
+ self._command.parser.add_option(
+ '-a', '--album', dest='album', action='store_true',
+ help='show missing albums for artist instead of tracks')
+ self._command.parser.add_format_option()
+
+ def commands(self):
+ def _miss(lib, opts, args):
+ self.config.set_args(opts)
+ albms = self.config['album'].get()
+
+ helper = self._missing_albums if albms else self._missing_tracks
+ helper(lib, decargs(args))
+
+ self._command.func = _miss
+ return [self._command]
+
+ def _missing_tracks(self, lib, query):
+ """Print a listing of tracks missing from each album in the library
+ matching query.
+ """
+ albums = lib.albums(query)
+
+ count = self.config['count'].get()
+ total = self.config['total'].get()
+ fmt = config['format_album' if count else 'format_item'].get()
+
+ if total:
+ print(sum([_missing_count(a) for a in albums]))
+ return
+
+ # Default format string for count mode.
+ if count:
+ fmt += ': $missing'
+
+ for album in albums:
+ if count:
+ if _missing_count(album):
+ print_(format(album, fmt))
+
+ else:
+ for item in self._missing(album):
+ print_(format(item, fmt))
+
+ def _missing_albums(self, lib, query):
+ """Print a listing of albums missing from each artist in the library
+ matching query.
+ """
+ total = self.config['total'].get()
+
+ albums = lib.albums(query)
+ # build dict mapping artist to list of their albums in library
+ albums_by_artist = defaultdict(list)
+ for alb in albums:
+ artist = (alb['albumartist'], alb['mb_albumartistid'])
+ albums_by_artist[artist].append(alb)
+
+ total_missing = 0
+
+ # build dict mapping artist to list of all albums
+ for artist, albums in albums_by_artist.items():
+ if artist[1] is None or artist[1] == "":
+ albs_no_mbid = ["'" + a['album'] + "'" for a in albums]
+ self._log.info(
+ "No musicbrainz ID for artist '{}' found in album(s) {}; "
+ "skipping", artist[0], ", ".join(albs_no_mbid)
+ )
+ continue
+
+ try:
+ resp = musicbrainzngs.browse_release_groups(artist=artist[1])
+ release_groups = resp['release-group-list']
+ except MusicBrainzError as err:
+ self._log.info(
+ "Couldn't fetch info for artist '{}' ({}) - '{}'",
+ artist[0], artist[1], err
+ )
+ continue
+
+ missing = []
+ present = []
+ for rg in release_groups:
+ missing.append(rg)
+ for alb in albums:
+ if alb['mb_releasegroupid'] == rg['id']:
+ missing.remove(rg)
+ present.append(rg)
+ break
+
+ total_missing += len(missing)
+ if total:
+ continue
+
+ missing_titles = {rg['title'] for rg in missing}
+
+ for release_title in missing_titles:
+ print_("{} - {}".format(artist[0], release_title))
+
+ if total:
+ print(total_missing)
+
+ def _missing(self, album):
+ """Query MusicBrainz to determine items missing from `album`.
+ """
+ item_mbids = [x.mb_trackid for x in album.items()]
+ if len(list(album.items())) < album.albumtotal:
+ # fetch missing items
+ # TODO: Implement caching that without breaking other stuff
+ album_info = hooks.album_for_mbid(album.mb_albumid)
+ for track_info in getattr(album_info, 'tracks', []):
+ if track_info.track_id not in item_mbids:
+ item = _item(track_info, album_info, album.id)
+ self._log.debug('track {0} in album {1}',
+ track_info.track_id, album_info.album_id)
+ yield item
diff --git a/lib/beetsplug/mpdstats.py b/lib/beetsplug/mpdstats.py
new file mode 100644
index 00000000..96291cf4
--- /dev/null
+++ b/lib/beetsplug/mpdstats.py
@@ -0,0 +1,380 @@
+# This file is part of beets.
+# Copyright 2016, Peter Schnebel and Johann Klähn.
+#
+# 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.
+
+
+import mpd
+import time
+import os
+
+from beets import ui
+from beets import config
+from beets import plugins
+from beets import library
+from beets.util import displayable_path
+from beets.dbcore import types
+
+# If we lose the connection, how many times do we want to retry and how
+# much time should we wait between retries?
+RETRIES = 10
+RETRY_INTERVAL = 5
+
+
+mpd_config = config['mpd']
+
+
+def is_url(path):
+ """Try to determine if the path is an URL.
+ """
+ if isinstance(path, bytes): # if it's bytes, then it's a path
+ return False
+ return path.split('://', 1)[0] in ['http', 'https']
+
+
+class MPDClientWrapper:
+ def __init__(self, log):
+ self._log = log
+
+ self.music_directory = mpd_config['music_directory'].as_str()
+ self.strip_path = mpd_config['strip_path'].as_str()
+
+ # Ensure strip_path end with '/'
+ if not self.strip_path.endswith('/'):
+ self.strip_path += '/'
+
+ self._log.debug('music_directory: {0}', self.music_directory)
+ self._log.debug('strip_path: {0}', self.strip_path)
+
+ self.client = mpd.MPDClient()
+
+ def connect(self):
+ """Connect to the MPD.
+ """
+ host = mpd_config['host'].as_str()
+ port = mpd_config['port'].get(int)
+
+ if host[0] in ['/', '~']:
+ host = os.path.expanduser(host)
+
+ self._log.info('connecting to {0}:{1}', host, port)
+ try:
+ self.client.connect(host, port)
+ except OSError as e:
+ raise ui.UserError(f'could not connect to MPD: {e}')
+
+ password = mpd_config['password'].as_str()
+ if password:
+ try:
+ self.client.password(password)
+ except mpd.CommandError as e:
+ raise ui.UserError(
+ f'could not authenticate to MPD: {e}'
+ )
+
+ def disconnect(self):
+ """Disconnect from the MPD.
+ """
+ self.client.close()
+ self.client.disconnect()
+
+ def get(self, command, retries=RETRIES):
+ """Wrapper for requests to the MPD server. Tries to re-connect if the
+ connection was lost (f.ex. during MPD's library refresh).
+ """
+ try:
+ return getattr(self.client, command)()
+ except (OSError, mpd.ConnectionError) as err:
+ self._log.error('{0}', err)
+
+ if retries <= 0:
+ # if we exited without breaking, we couldn't reconnect in time :(
+ raise ui.UserError('communication with MPD server failed')
+
+ time.sleep(RETRY_INTERVAL)
+
+ try:
+ self.disconnect()
+ except mpd.ConnectionError:
+ pass
+
+ self.connect()
+ return self.get(command, retries=retries - 1)
+
+ def currentsong(self):
+ """Return the path to the currently playing song, along with its
+ songid. Prefixes paths with the music_directory, to get the absolute
+ path.
+ In some cases, we need to remove the local path from MPD server,
+ we replace 'strip_path' with ''.
+ `strip_path` defaults to ''.
+ """
+ result = None
+ entry = self.get('currentsong')
+ if 'file' in entry:
+ if not is_url(entry['file']):
+ file = entry['file']
+ if file.startswith(self.strip_path):
+ file = file[len(self.strip_path):]
+ result = os.path.join(self.music_directory, file)
+ else:
+ result = entry['file']
+ self._log.debug('returning: {0}', result)
+ return result, entry.get('id')
+
+ def status(self):
+ """Return the current status of the MPD.
+ """
+ return self.get('status')
+
+ def events(self):
+ """Return list of events. This may block a long time while waiting for
+ an answer from MPD.
+ """
+ return self.get('idle')
+
+
+class MPDStats:
+ def __init__(self, lib, log):
+ self.lib = lib
+ self._log = log
+
+ self.do_rating = mpd_config['rating'].get(bool)
+ self.rating_mix = mpd_config['rating_mix'].get(float)
+ self.time_threshold = 10.0 # TODO: maybe add config option?
+
+ self.now_playing = None
+ self.mpd = MPDClientWrapper(log)
+
+ def rating(self, play_count, skip_count, rating, skipped):
+ """Calculate a new rating for a song based on play count, skip count,
+ old rating and the fact if it was skipped or not.
+ """
+ if skipped:
+ rolling = (rating - rating / 2.0)
+ else:
+ rolling = (rating + (1.0 - rating) / 2.0)
+ stable = (play_count + 1.0) / (play_count + skip_count + 2.0)
+ return (self.rating_mix * stable +
+ (1.0 - self.rating_mix) * rolling)
+
+ def get_item(self, path):
+ """Return the beets item related to path.
+ """
+ query = library.PathQuery('path', path)
+ item = self.lib.items(query).get()
+ if item:
+ return item
+ else:
+ self._log.info('item not found: {0}', displayable_path(path))
+
+ def update_item(self, item, attribute, value=None, increment=None):
+ """Update the beets item. Set attribute to value or increment the value
+ of attribute. If the increment argument is used the value is cast to
+ the corresponding type.
+ """
+ if item is None:
+ return
+
+ if increment is not None:
+ item.load()
+ value = type(increment)(item.get(attribute, 0)) + increment
+
+ if value is not None:
+ item[attribute] = value
+ item.store()
+
+ self._log.debug('updated: {0} = {1} [{2}]',
+ attribute,
+ item[attribute],
+ displayable_path(item.path))
+
+ def update_rating(self, item, skipped):
+ """Update the rating for a beets item. The `item` can either be a
+ beets `Item` or None. If the item is None, nothing changes.
+ """
+ if item is None:
+ return
+
+ item.load()
+ rating = self.rating(
+ int(item.get('play_count', 0)),
+ int(item.get('skip_count', 0)),
+ float(item.get('rating', 0.5)),
+ skipped)
+
+ self.update_item(item, 'rating', rating)
+
+ def handle_song_change(self, song):
+ """Determine if a song was skipped or not and update its attributes.
+ To this end the difference between the song's supposed end time
+ and the current time is calculated. If it's greater than a threshold,
+ the song is considered skipped.
+
+ Returns whether the change was manual (skipped previous song or not)
+ """
+ diff = abs(song['remaining'] - (time.time() - song['started']))
+
+ skipped = diff >= self.time_threshold
+
+ if skipped:
+ self.handle_skipped(song)
+ else:
+ self.handle_played(song)
+
+ if self.do_rating:
+ self.update_rating(song['beets_item'], skipped)
+
+ return skipped
+
+ def handle_played(self, song):
+ """Updates the play count of a song.
+ """
+ self.update_item(song['beets_item'], 'play_count', increment=1)
+ self._log.info('played {0}', displayable_path(song['path']))
+
+ def handle_skipped(self, song):
+ """Updates the skip count of a song.
+ """
+ self.update_item(song['beets_item'], 'skip_count', increment=1)
+ self._log.info('skipped {0}', displayable_path(song['path']))
+
+ def on_stop(self, status):
+ self._log.info('stop')
+
+ # if the current song stays the same it means that we stopped on the
+ # current track and should not record a skip.
+ if self.now_playing and self.now_playing['id'] != status.get('songid'):
+ self.handle_song_change(self.now_playing)
+
+ self.now_playing = None
+
+ def on_pause(self, status):
+ self._log.info('pause')
+ self.now_playing = None
+
+ def on_play(self, status):
+
+ path, songid = self.mpd.currentsong()
+
+ if not path:
+ return
+
+ played, duration = map(int, status['time'].split(':', 1))
+ remaining = duration - played
+
+ if self.now_playing:
+ if self.now_playing['path'] != path:
+ self.handle_song_change(self.now_playing)
+ else:
+ # In case we got mpd play event with same song playing
+ # multiple times,
+ # assume low diff means redundant second play event
+ # after natural song start.
+ diff = abs(time.time() - self.now_playing['started'])
+
+ if diff <= self.time_threshold:
+ return
+
+ if self.now_playing['path'] == path and played == 0:
+ self.handle_song_change(self.now_playing)
+
+ if is_url(path):
+ self._log.info('playing stream {0}', displayable_path(path))
+ self.now_playing = None
+ return
+
+ self._log.info('playing {0}', displayable_path(path))
+
+ self.now_playing = {
+ 'started': time.time(),
+ 'remaining': remaining,
+ 'path': path,
+ 'id': songid,
+ 'beets_item': self.get_item(path),
+ }
+
+ self.update_item(self.now_playing['beets_item'],
+ 'last_played', value=int(time.time()))
+
+ def run(self):
+ self.mpd.connect()
+ events = ['player']
+
+ while True:
+ if 'player' in events:
+ status = self.mpd.status()
+
+ handler = getattr(self, 'on_' + status['state'], None)
+
+ if handler:
+ handler(status)
+ else:
+ self._log.debug('unhandled status "{0}"', status)
+
+ events = self.mpd.events()
+
+
+class MPDStatsPlugin(plugins.BeetsPlugin):
+
+ item_types = {
+ 'play_count': types.INTEGER,
+ 'skip_count': types.INTEGER,
+ 'last_played': library.DateType(),
+ 'rating': types.FLOAT,
+ }
+
+ def __init__(self):
+ super().__init__()
+ mpd_config.add({
+ 'music_directory': config['directory'].as_filename(),
+ 'strip_path': '',
+ 'rating': True,
+ 'rating_mix': 0.75,
+ 'host': os.environ.get('MPD_HOST', 'localhost'),
+ 'port': int(os.environ.get('MPD_PORT', 6600)),
+ 'password': '',
+ })
+ mpd_config['password'].redact = True
+
+ def commands(self):
+ cmd = ui.Subcommand(
+ 'mpdstats',
+ help='run a MPD client to gather play statistics')
+ cmd.parser.add_option(
+ '--host', dest='host', type='string',
+ help='set the hostname of the server to connect to')
+ cmd.parser.add_option(
+ '--port', dest='port', type='int',
+ help='set the port of the MPD server to connect to')
+ cmd.parser.add_option(
+ '--password', dest='password', type='string',
+ help='set the password of the MPD server to connect to')
+
+ def func(lib, opts, args):
+ mpd_config.set_args(opts)
+
+ # Overrides for MPD settings.
+ if opts.host:
+ mpd_config['host'] = opts.host.decode('utf-8')
+ if opts.port:
+ mpd_config['host'] = int(opts.port)
+ if opts.password:
+ mpd_config['password'] = opts.password.decode('utf-8')
+
+ try:
+ MPDStats(lib, self._log).run()
+ except KeyboardInterrupt:
+ pass
+
+ cmd.func = func
+ return [cmd]
diff --git a/lib/beetsplug/mpdupdate.py b/lib/beetsplug/mpdupdate.py
new file mode 100644
index 00000000..e5264e18
--- /dev/null
+++ b/lib/beetsplug/mpdupdate.py
@@ -0,0 +1,126 @@
+# This file is part of beets.
+# Copyright 2016, Adrian Sampson.
+#
+# 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.
+
+"""Updates an MPD index whenever the library is changed.
+
+Put something like the following in your config.yaml to configure:
+ mpd:
+ host: localhost
+ port: 6600
+ password: seekrit
+"""
+
+from beets.plugins import BeetsPlugin
+import os
+import socket
+from beets import config
+
+
+# No need to introduce a dependency on an MPD library for such a
+# simple use case. Here's a simple socket abstraction to make things
+# easier.
+class BufferedSocket:
+ """Socket abstraction that allows reading by line."""
+ def __init__(self, host, port, sep=b'\n'):
+ if host[0] in ['/', '~']:
+ self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
+ self.sock.connect(os.path.expanduser(host))
+ else:
+ self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+ self.sock.connect((host, port))
+ self.buf = b''
+ self.sep = sep
+
+ def readline(self):
+ while self.sep not in self.buf:
+ data = self.sock.recv(1024)
+ if not data:
+ break
+ self.buf += data
+ if self.sep in self.buf:
+ res, self.buf = self.buf.split(self.sep, 1)
+ return res + self.sep
+ else:
+ return b''
+
+ def send(self, data):
+ self.sock.send(data)
+
+ def close(self):
+ self.sock.close()
+
+
+class MPDUpdatePlugin(BeetsPlugin):
+ def __init__(self):
+ super().__init__()
+ config['mpd'].add({
+ 'host': os.environ.get('MPD_HOST', 'localhost'),
+ 'port': int(os.environ.get('MPD_PORT', 6600)),
+ 'password': '',
+ })
+ config['mpd']['password'].redact = True
+
+ # For backwards compatibility, use any values from the
+ # plugin-specific "mpdupdate" section.
+ for key in config['mpd'].keys():
+ if self.config[key].exists():
+ config['mpd'][key] = self.config[key].get()
+
+ self.register_listener('database_change', self.db_change)
+
+ def db_change(self, lib, model):
+ self.register_listener('cli_exit', self.update)
+
+ def update(self, lib):
+ self.update_mpd(
+ config['mpd']['host'].as_str(),
+ config['mpd']['port'].get(int),
+ config['mpd']['password'].as_str(),
+ )
+
+ def update_mpd(self, host='localhost', port=6600, password=None):
+ """Sends the "update" command to the MPD server indicated,
+ possibly authenticating with a password first.
+ """
+ self._log.info('Updating MPD database...')
+
+ try:
+ s = BufferedSocket(host, port)
+ except OSError as e:
+ self._log.warning('MPD connection failed: {0}',
+ str(e.strerror))
+ return
+
+ resp = s.readline()
+ if b'OK MPD' not in resp:
+ self._log.warning('MPD connection failed: {0!r}', resp)
+ return
+
+ if password:
+ s.send(b'password "%s"\n' % password.encode('utf8'))
+ resp = s.readline()
+ if b'OK' not in resp:
+ self._log.warning('Authentication failed: {0!r}', resp)
+ s.send(b'close\n')
+ s.close()
+ return
+
+ s.send(b'update\n')
+ resp = s.readline()
+ if b'updating_db' not in resp:
+ self._log.warning('Update failed: {0!r}', resp)
+
+ s.send(b'close\n')
+ s.close()
+ self._log.info('Database updated.')
diff --git a/lib/beetsplug/parentwork.py b/lib/beetsplug/parentwork.py
new file mode 100644
index 00000000..75307b8f
--- /dev/null
+++ b/lib/beetsplug/parentwork.py
@@ -0,0 +1,211 @@
+# This file is part of beets.
+# Copyright 2017, Dorian Soergel.
+#
+# 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.
+
+"""Gets parent work, its disambiguation and id, composer, composer sort name
+and work composition date
+"""
+
+
+from beets import ui
+from beets.plugins import BeetsPlugin
+
+import musicbrainzngs
+
+
+def direct_parent_id(mb_workid, work_date=None):
+ """Given a Musicbrainz work id, find the id one of the works the work is
+ part of and the first composition date it encounters.
+ """
+ work_info = musicbrainzngs.get_work_by_id(mb_workid,
+ includes=["work-rels",
+ "artist-rels"])
+ if 'artist-relation-list' in work_info['work'] and work_date is None:
+ for artist in work_info['work']['artist-relation-list']:
+ if artist['type'] == 'composer':
+ if 'end' in artist.keys():
+ work_date = artist['end']
+
+ if 'work-relation-list' in work_info['work']:
+ for direct_parent in work_info['work']['work-relation-list']:
+ if direct_parent['type'] == 'parts' \
+ and direct_parent.get('direction') == 'backward':
+ direct_id = direct_parent['work']['id']
+ return direct_id, work_date
+ return None, work_date
+
+
+def work_parent_id(mb_workid):
+ """Find the parent work id and composition date of a work given its id.
+ """
+ work_date = None
+ while True:
+ new_mb_workid, work_date = direct_parent_id(mb_workid, work_date)
+ if not new_mb_workid:
+ return mb_workid, work_date
+ mb_workid = new_mb_workid
+ return mb_workid, work_date
+
+
+def find_parentwork_info(mb_workid):
+ """Get the MusicBrainz information dict about a parent work, including
+ the artist relations, and the composition date for a work's parent work.
+ """
+ parent_id, work_date = work_parent_id(mb_workid)
+ work_info = musicbrainzngs.get_work_by_id(parent_id,
+ includes=["artist-rels"])
+ return work_info, work_date
+
+
+class ParentWorkPlugin(BeetsPlugin):
+ def __init__(self):
+ super().__init__()
+
+ self.config.add({
+ 'auto': False,
+ 'force': False,
+ })
+
+ if self.config['auto']:
+ self.import_stages = [self.imported]
+
+ def commands(self):
+
+ def func(lib, opts, args):
+ self.config.set_args(opts)
+ force_parent = self.config['force'].get(bool)
+ write = ui.should_write()
+
+ for item in lib.items(ui.decargs(args)):
+ changed = self.find_work(item, force_parent)
+ if changed:
+ item.store()
+ if write:
+ item.try_write()
+ command = ui.Subcommand(
+ 'parentwork',
+ help='fetch parent works, composers and dates')
+
+ command.parser.add_option(
+ '-f', '--force', dest='force',
+ action='store_true', default=None,
+ help='re-fetch when parent work is already present')
+
+ command.func = func
+ return [command]
+
+ def imported(self, session, task):
+ """Import hook for fetching parent works automatically.
+ """
+ force_parent = self.config['force'].get(bool)
+
+ for item in task.imported_items():
+ self.find_work(item, force_parent)
+ item.store()
+
+ def get_info(self, item, work_info):
+ """Given the parent work info dict, fetch parent_composer,
+ parent_composer_sort, parentwork, parentwork_disambig, mb_workid and
+ composer_ids.
+ """
+
+ parent_composer = []
+ parent_composer_sort = []
+ parentwork_info = {}
+
+ composer_exists = False
+ if 'artist-relation-list' in work_info['work']:
+ for artist in work_info['work']['artist-relation-list']:
+ if artist['type'] == 'composer':
+ composer_exists = True
+ parent_composer.append(artist['artist']['name'])
+ parent_composer_sort.append(artist['artist']['sort-name'])
+ if 'end' in artist.keys():
+ parentwork_info["parentwork_date"] = artist['end']
+
+ parentwork_info['parent_composer'] = ', '.join(parent_composer)
+ parentwork_info['parent_composer_sort'] = ', '.join(
+ parent_composer_sort)
+
+ if not composer_exists:
+ self._log.debug(
+ 'no composer for {}; add one at '
+ 'https://musicbrainz.org/work/{}',
+ item, work_info['work']['id'],
+ )
+
+ parentwork_info['parentwork'] = work_info['work']['title']
+ parentwork_info['mb_parentworkid'] = work_info['work']['id']
+
+ if 'disambiguation' in work_info['work']:
+ parentwork_info['parentwork_disambig'] = work_info[
+ 'work']['disambiguation']
+
+ else:
+ parentwork_info['parentwork_disambig'] = None
+
+ return parentwork_info
+
+ def find_work(self, item, force):
+ """Finds the parent work of a recording and populates the tags
+ accordingly.
+
+ The parent work is found recursively, by finding the direct parent
+ repeatedly until there are no more links in the chain. We return the
+ final, topmost work in the chain.
+
+ Namely, the tags parentwork, parentwork_disambig, mb_parentworkid,
+ parent_composer, parent_composer_sort and work_date are populated.
+ """
+
+ if not item.mb_workid:
+ self._log.info('No work for {}, \
+add one at https://musicbrainz.org/recording/{}', item, item.mb_trackid)
+ return
+
+ hasparent = hasattr(item, 'parentwork')
+ work_changed = True
+ if hasattr(item, 'parentwork_workid_current'):
+ work_changed = item.parentwork_workid_current != item.mb_workid
+ if force or not hasparent or work_changed:
+ try:
+ work_info, work_date = find_parentwork_info(item.mb_workid)
+ except musicbrainzngs.musicbrainz.WebServiceError as e:
+ self._log.debug("error fetching work: {}", e)
+ return
+ parent_info = self.get_info(item, work_info)
+ parent_info['parentwork_workid_current'] = item.mb_workid
+ if 'parent_composer' in parent_info:
+ self._log.debug("Work fetched: {} - {}",
+ parent_info['parentwork'],
+ parent_info['parent_composer'])
+ else:
+ self._log.debug("Work fetched: {} - no parent composer",
+ parent_info['parentwork'])
+
+ elif hasparent:
+ self._log.debug("{}: Work present, skipping", item)
+ return
+
+ # apply all non-null values to the item
+ for key, value in parent_info.items():
+ if value:
+ item[key] = value
+
+ if work_date:
+ item['work_date'] = work_date
+ return ui.show_model_changes(
+ item, fields=['parentwork', 'parentwork_disambig',
+ 'mb_parentworkid', 'parent_composer',
+ 'parent_composer_sort', 'work_date',
+ 'parentwork_workid_current', 'parentwork_date'])
diff --git a/lib/beetsplug/permissions.py b/lib/beetsplug/permissions.py
new file mode 100644
index 00000000..f5aab056
--- /dev/null
+++ b/lib/beetsplug/permissions.py
@@ -0,0 +1,121 @@
+"""Fixes file permissions after the file gets written on import. Put something
+like the following in your config.yaml to configure:
+
+ permissions:
+ file: 644
+ dir: 755
+"""
+import os
+from beets import config, util
+from beets.plugins import BeetsPlugin
+from beets.util import ancestry
+
+
+def convert_perm(perm):
+ """Convert a string to an integer, interpreting the text as octal.
+ Or, if `perm` is an integer, reinterpret it as an octal number that
+ has been "misinterpreted" as decimal.
+ """
+ if isinstance(perm, int):
+ perm = str(perm)
+ return int(perm, 8)
+
+
+def check_permissions(path, permission):
+ """Check whether the file's permissions equal the given vector.
+ Return a boolean.
+ """
+ return oct(os.stat(path).st_mode & 0o777) == oct(permission)
+
+
+def assert_permissions(path, permission, log):
+ """Check whether the file's permissions are as expected, otherwise,
+ log a warning message. Return a boolean indicating the match, like
+ `check_permissions`.
+ """
+ if not check_permissions(util.syspath(path), permission):
+ log.warning(
+ 'could not set permissions on {}',
+ util.displayable_path(path),
+ )
+ log.debug(
+ 'set permissions to {}, but permissions are now {}',
+ permission,
+ os.stat(util.syspath(path)).st_mode & 0o777,
+ )
+
+
+def dirs_in_library(library, item):
+ """Creates a list of ancestor directories in the beets library path.
+ """
+ return [ancestor
+ for ancestor in ancestry(item)
+ if ancestor.startswith(library)][1:]
+
+
+class Permissions(BeetsPlugin):
+ def __init__(self):
+ super().__init__()
+
+ # Adding defaults.
+ self.config.add({
+ 'file': '644',
+ 'dir': '755',
+ })
+
+ self.register_listener('item_imported', self.fix)
+ self.register_listener('album_imported', self.fix)
+ self.register_listener('art_set', self.fix_art)
+
+ def fix(self, lib, item=None, album=None):
+ """Fix the permissions for an imported Item or Album.
+ """
+ files = []
+ dirs = set()
+ if item:
+ files.append(item.path)
+ dirs.update(dirs_in_library(lib.directory, item.path))
+ elif album:
+ for album_item in album.items():
+ files.append(album_item.path)
+ dirs.update(dirs_in_library(lib.directory, album_item.path))
+ self.set_permissions(files=files, dirs=dirs)
+
+ def fix_art(self, album):
+ """Fix the permission for Album art file.
+ """
+ if album.artpath:
+ self.set_permissions(files=[album.artpath])
+
+ def set_permissions(self, files=[], dirs=[]):
+ # Get the configured permissions. The user can specify this either a
+ # string (in YAML quotes) or, for convenience, as an integer so the
+ # quotes can be omitted. In the latter case, we need to reinterpret the
+ # integer as octal, not decimal.
+ file_perm = config['permissions']['file'].get()
+ dir_perm = config['permissions']['dir'].get()
+ file_perm = convert_perm(file_perm)
+ dir_perm = convert_perm(dir_perm)
+
+ for path in files:
+ # Changing permissions on the destination file.
+ self._log.debug(
+ 'setting file permissions on {}',
+ util.displayable_path(path),
+ )
+ os.chmod(util.syspath(path), file_perm)
+
+ # Checks if the destination path has the permissions configured.
+ assert_permissions(path, file_perm, self._log)
+
+ # Change permissions for the directories.
+ for path in dirs:
+ # Changing permissions on the destination directory.
+ self._log.debug(
+ 'setting directory permissions on {}',
+ util.displayable_path(path),
+ )
+ os.chmod(util.syspath(path), dir_perm)
+
+ # Checks if the destination path has the permissions configured.
+ assert_permissions(path, dir_perm, self._log)
diff --git a/lib/beetsplug/play.py b/lib/beetsplug/play.py
new file mode 100644
index 00000000..f4233490
--- /dev/null
+++ b/lib/beetsplug/play.py
@@ -0,0 +1,215 @@
+# This file is part of beets.
+# Copyright 2016, David Hamp-Gonsalves
+#
+# 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.
+
+"""Send the results of a query to the configured music player as a playlist.
+"""
+
+from beets.plugins import BeetsPlugin
+from beets.ui import Subcommand
+from beets.ui.commands import PromptChoice
+from beets import config
+from beets import ui
+from beets import util
+from os.path import relpath
+from tempfile import NamedTemporaryFile
+import subprocess
+import shlex
+
+# Indicate where arguments should be inserted into the command string.
+# If this is missing, they're placed at the end.
+ARGS_MARKER = '$args'
+
+
+def play(command_str, selection, paths, open_args, log, item_type='track',
+ keep_open=False):
+ """Play items in paths with command_str and optional arguments. If
+ keep_open, return to beets, otherwise exit once command runs.
+ """
+ # Print number of tracks or albums to be played, log command to be run.
+ item_type += 's' if len(selection) > 1 else ''
+ ui.print_('Playing {} {}.'.format(len(selection), item_type))
+ log.debug('executing command: {} {!r}', command_str, open_args)
+
+ try:
+ if keep_open:
+ command = shlex.split(command_str)
+ command = command + open_args
+ subprocess.call(command)
+ else:
+ util.interactive_open(open_args, command_str)
+ except OSError as exc:
+ raise ui.UserError(
+ f"Could not play the query: {exc}")
+
+
+class PlayPlugin(BeetsPlugin):
+
+ def __init__(self):
+ super().__init__()
+
+ config['play'].add({
+ 'command': None,
+ 'use_folders': False,
+ 'relative_to': None,
+ 'raw': False,
+ 'warning_threshold': 100,
+ 'bom': False,
+ })
+
+ self.register_listener('before_choose_candidate',
+ self.before_choose_candidate_listener)
+
+ def commands(self):
+ play_command = Subcommand(
+ 'play',
+ help='send music to a player as a playlist'
+ )
+ play_command.parser.add_album_option()
+ play_command.parser.add_option(
+ '-A', '--args',
+ action='store',
+ help='add additional arguments to the command',
+ )
+ play_command.parser.add_option(
+ '-y', '--yes',
+ action="store_true",
+ help='skip the warning threshold',
+ )
+ play_command.func = self._play_command
+ return [play_command]
+
+ def _play_command(self, lib, opts, args):
+ """The CLI command function for `beet play`. Create a list of paths
+ from query, determine if tracks or albums are to be played.
+ """
+ use_folders = config['play']['use_folders'].get(bool)
+ relative_to = config['play']['relative_to'].get()
+ if relative_to:
+ relative_to = util.normpath(relative_to)
+ # Perform search by album and add folders rather than tracks to
+ # playlist.
+ if opts.album:
+ selection = lib.albums(ui.decargs(args))
+ paths = []
+
+ sort = lib.get_default_album_sort()
+ for album in selection:
+ if use_folders:
+ paths.append(album.item_dir())
+ else:
+ paths.extend(item.path
+ for item in sort.sort(album.items()))
+ item_type = 'album'
+
+ # Perform item query and add tracks to playlist.
+ else:
+ selection = lib.items(ui.decargs(args))
+ paths = [item.path for item in selection]
+ item_type = 'track'
+
+ if relative_to:
+ paths = [relpath(path, relative_to) for path in paths]
+
+ if not selection:
+ ui.print_(ui.colorize('text_warning',
+ f'No {item_type} to play.'))
+ return
+
+ open_args = self._playlist_or_paths(paths)
+ command_str = self._command_str(opts.args)
+
+ # Check if the selection exceeds configured threshold. If True,
+ # cancel, otherwise proceed with play command.
+ if opts.yes or not self._exceeds_threshold(
+ selection, command_str, open_args, item_type):
+ play(command_str, selection, paths, open_args, self._log,
+ item_type)
+
+ def _command_str(self, args=None):
+ """Create a command string from the config command and optional args.
+ """
+ command_str = config['play']['command'].get()
+ if not command_str:
+ return util.open_anything()
+ # Add optional arguments to the player command.
+ if args:
+ if ARGS_MARKER in command_str:
+ return command_str.replace(ARGS_MARKER, args)
+ else:
+ return f"{command_str} {args}"
+ else:
+ # Don't include the marker in the command.
+ return command_str.replace(" " + ARGS_MARKER, "")
+
+ def _playlist_or_paths(self, paths):
+ """Return either the raw paths of items or a playlist of the items.
+ """
+ if config['play']['raw']:
+ return paths
+ else:
+ return [self._create_tmp_playlist(paths)]
+
+ def _exceeds_threshold(self, selection, command_str, open_args,
+ item_type='track'):
+ """Prompt user whether to abort if playlist exceeds threshold. If
+ True, cancel playback. If False, execute play command.
+ """
+ warning_threshold = config['play']['warning_threshold'].get(int)
+
+ # Warn user before playing any huge playlists.
+ if warning_threshold and len(selection) > warning_threshold:
+ if len(selection) > 1:
+ item_type += 's'
+
+ ui.print_(ui.colorize(
+ 'text_warning',
+ 'You are about to queue {} {}.'.format(
+ len(selection), item_type)))
+
+ if ui.input_options(('Continue', 'Abort')) == 'a':
+ return True
+
+ return False
+
+ def _create_tmp_playlist(self, paths_list):
+ """Create a temporary .m3u file. Return the filename.
+ """
+ utf8_bom = config['play']['bom'].get(bool)
+ m3u = NamedTemporaryFile('wb', suffix='.m3u', delete=False)
+
+ if utf8_bom:
+ m3u.write(b'\xEF\xBB\xBF')
+
+ for item in paths_list:
+ m3u.write(item + b'\n')
+ m3u.close()
+ return m3u.name
+
+ def before_choose_candidate_listener(self, session, task):
+ """Append a "Play" choice to the interactive importer prompt.
+ """
+ return [PromptChoice('y', 'plaY', self.importer_play)]
+
+ def importer_play(self, session, task):
+ """Get items from current import task and send to play function.
+ """
+ selection = task.items
+ paths = [item.path for item in selection]
+
+ open_args = self._playlist_or_paths(paths)
+ command_str = self._command_str()
+
+ if not self._exceeds_threshold(selection, command_str, open_args):
+ play(command_str, selection, paths, open_args, self._log,
+ keep_open=True)
diff --git a/lib/beetsplug/playlist.py b/lib/beetsplug/playlist.py
new file mode 100644
index 00000000..265b8bad
--- /dev/null
+++ b/lib/beetsplug/playlist.py
@@ -0,0 +1,185 @@
+# This file is part of beets.
+#
+# 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.
+
+
+import os
+import fnmatch
+import tempfile
+import beets
+from beets.util import path_as_posix
+
+
+class PlaylistQuery(beets.dbcore.Query):
+ """Matches files listed by a playlist file.
+ """
+ def __init__(self, pattern):
+ self.pattern = pattern
+ config = beets.config['playlist']
+
+ # Get the full path to the playlist
+ playlist_paths = (
+ pattern,
+ os.path.abspath(os.path.join(
+ config['playlist_dir'].as_filename(),
+ f'{pattern}.m3u',
+ )),
+ )
+
+ self.paths = []
+ for playlist_path in playlist_paths:
+ if not fnmatch.fnmatch(playlist_path, '*.[mM]3[uU]'):
+ # This is not am M3U playlist, skip this candidate
+ continue
+
+ try:
+ f = open(beets.util.syspath(playlist_path), mode='rb')
+ except OSError:
+ continue
+
+ if config['relative_to'].get() == 'library':
+ relative_to = beets.config['directory'].as_filename()
+ elif config['relative_to'].get() == 'playlist':
+ relative_to = os.path.dirname(playlist_path)
+ else:
+ relative_to = config['relative_to'].as_filename()
+ relative_to = beets.util.bytestring_path(relative_to)
+
+ for line in f:
+ if line[0] == '#':
+ # ignore comments, and extm3u extension
+ continue
+
+ self.paths.append(beets.util.normpath(
+ os.path.join(relative_to, line.rstrip())
+ ))
+ f.close()
+ break
+
+ def col_clause(self):
+ if not self.paths:
+ # Playlist is empty
+ return '0', ()
+ clause = 'path IN ({})'.format(', '.join('?' for path in self.paths))
+ return clause, (beets.library.BLOB_TYPE(p) for p in self.paths)
+
+ def match(self, item):
+ return item.path in self.paths
+
+
+class PlaylistPlugin(beets.plugins.BeetsPlugin):
+ item_queries = {'playlist': PlaylistQuery}
+
+ def __init__(self):
+ super().__init__()
+ self.config.add({
+ 'auto': False,
+ 'playlist_dir': '.',
+ 'relative_to': 'library',
+ 'forward_slash': False,
+ })
+
+ self.playlist_dir = self.config['playlist_dir'].as_filename()
+ self.changes = {}
+
+ if self.config['relative_to'].get() == 'library':
+ self.relative_to = beets.util.bytestring_path(
+ beets.config['directory'].as_filename())
+ elif self.config['relative_to'].get() != 'playlist':
+ self.relative_to = beets.util.bytestring_path(
+ self.config['relative_to'].as_filename())
+ else:
+ self.relative_to = None
+
+ if self.config['auto']:
+ self.register_listener('item_moved', self.item_moved)
+ self.register_listener('item_removed', self.item_removed)
+ self.register_listener('cli_exit', self.cli_exit)
+
+ def item_moved(self, item, source, destination):
+ self.changes[source] = destination
+
+ def item_removed(self, item):
+ if not os.path.exists(beets.util.syspath(item.path)):
+ self.changes[item.path] = None
+
+ def cli_exit(self, lib):
+ for playlist in self.find_playlists():
+ self._log.info(f'Updating playlist: {playlist}')
+ base_dir = beets.util.bytestring_path(
+ self.relative_to if self.relative_to
+ else os.path.dirname(playlist)
+ )
+
+ try:
+ self.update_playlist(playlist, base_dir)
+ except beets.util.FilesystemError:
+ self._log.error('Failed to update playlist: {}'.format(
+ beets.util.displayable_path(playlist)))
+
+ def find_playlists(self):
+ """Find M3U playlists in the playlist directory."""
+ try:
+ dir_contents = os.listdir(beets.util.syspath(self.playlist_dir))
+ except OSError:
+ self._log.warning('Unable to open playlist directory {}'.format(
+ beets.util.displayable_path(self.playlist_dir)))
+ return
+
+ for filename in dir_contents:
+ if fnmatch.fnmatch(filename, '*.[mM]3[uU]'):
+ yield os.path.join(self.playlist_dir, filename)
+
+ def update_playlist(self, filename, base_dir):
+ """Find M3U playlists in the specified directory."""
+ changes = 0
+ deletions = 0
+
+ with tempfile.NamedTemporaryFile(mode='w+b', delete=False) as tempfp:
+ new_playlist = tempfp.name
+ with open(filename, mode='rb') as fp:
+ for line in fp:
+ original_path = line.rstrip(b'\r\n')
+
+ # Ensure that path from playlist is absolute
+ is_relative = not os.path.isabs(line)
+ if is_relative:
+ lookup = os.path.join(base_dir, original_path)
+ else:
+ lookup = original_path
+
+ try:
+ new_path = self.changes[beets.util.normpath(lookup)]
+ except KeyError:
+ if self.config['forward_slash']:
+ line = path_as_posix(line)
+ tempfp.write(line)
+ else:
+ if new_path is None:
+ # Item has been deleted
+ deletions += 1
+ continue
+
+ changes += 1
+ if is_relative:
+ new_path = os.path.relpath(new_path, base_dir)
+ line = line.replace(original_path, new_path)
+ if self.config['forward_slash']:
+ line = path_as_posix(line)
+ tempfp.write(line)
+
+ if changes or deletions:
+ self._log.info(
+ 'Updated playlist {} ({} changes, {} deletions)'.format(
+ filename, changes, deletions))
+ beets.util.copy(new_playlist, filename, replace=True)
+ beets.util.remove(new_playlist)
diff --git a/lib/beetsplug/plexupdate.py b/lib/beetsplug/plexupdate.py
new file mode 100644
index 00000000..2261a55f
--- /dev/null
+++ b/lib/beetsplug/plexupdate.py
@@ -0,0 +1,110 @@
+"""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
+"""
+
+import requests
+from xml.etree import ElementTree
+from urllib.parse import urljoin, urlencode
+from beets import config
+from beets.plugins import BeetsPlugin
+
+
+def get_music_section(host, port, token, library_name, secure,
+ ignore_cert_errors):
+ """Getting the section key for the music library in Plex.
+ """
+ api_endpoint = append_token('library/sections', token)
+ url = urljoin('{}://{}:{}'.format(get_protocol(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, 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,
+ secure, ignore_cert_errors)
+ api_endpoint = f'library/sections/{section_key}/refresh'
+ api_endpoint = append_token(api_endpoint, token)
+ url = urljoin('{}://{}:{}'.format(get_protocol(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(secure):
+ if secure:
+ return 'https'
+ else:
+ return 'http'
+
+
+class PlexUpdate(BeetsPlugin):
+ def __init__(self):
+ super().__init__()
+
+ # Adding defaults.
+ config['plex'].add({
+ 'host': 'localhost',
+ 'port': 32400,
+ 'token': '',
+ 'library_name': 'Music',
+ 'secure': False,
+ '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('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']['secure'].get(bool),
+ config['plex']['ignore_cert_errors'].get(bool))
+ self._log.info('... started.')
+
+ except requests.exceptions.RequestException:
+ self._log.warning('Update failed.')
diff --git a/lib/beetsplug/random.py b/lib/beetsplug/random.py
new file mode 100644
index 00000000..ea9b7b98
--- /dev/null
+++ b/lib/beetsplug/random.py
@@ -0,0 +1,57 @@
+# This file is part of beets.
+# Copyright 2016, Philippe Mongeau.
+#
+# 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.
+
+"""Get a random song or album from the library.
+"""
+
+from beets.plugins import BeetsPlugin
+from beets.ui import Subcommand, decargs, print_
+from beets.random import random_objs
+
+
+def random_func(lib, opts, args):
+ """Select some random items or albums and print the results.
+ """
+ # Fetch all the objects matching the query into a list.
+ query = decargs(args)
+ if opts.album:
+ objs = list(lib.albums(query))
+ else:
+ objs = list(lib.items(query))
+
+ # Print a random subset.
+ objs = random_objs(objs, opts.album, opts.number, opts.time,
+ opts.equal_chance)
+ for obj in objs:
+ print_(format(obj))
+
+
+random_cmd = Subcommand('random',
+ help='choose a random track or album')
+random_cmd.parser.add_option(
+ '-n', '--number', action='store', type="int",
+ help='number of objects to choose', default=1)
+random_cmd.parser.add_option(
+ '-e', '--equal-chance', action='store_true',
+ help='each artist has the same chance')
+random_cmd.parser.add_option(
+ '-t', '--time', action='store', type="float",
+ help='total length in minutes of objects to choose')
+random_cmd.parser.add_all_common_options()
+random_cmd.func = random_func
+
+
+class Random(BeetsPlugin):
+ def commands(self):
+ return [random_cmd]
diff --git a/lib/beetsplug/replaygain.py b/lib/beetsplug/replaygain.py
new file mode 100644
index 00000000..b6297d93
--- /dev/null
+++ b/lib/beetsplug/replaygain.py
@@ -0,0 +1,1368 @@
+# This file is part of beets.
+# Copyright 2016, Fabrice Laporte, Yevgeny Bezman, and Adrian Sampson.
+#
+# 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.
+
+
+import collections
+import enum
+import math
+import os
+import signal
+import subprocess
+import sys
+import warnings
+from multiprocessing.pool import ThreadPool, RUN
+from six.moves import queue
+from threading import Thread, Event
+
+from beets import ui
+from beets.plugins import BeetsPlugin
+from beets.util import (syspath, command_output, displayable_path,
+ py3_path, cpu_count)
+
+
+# Utilities.
+
+class ReplayGainError(Exception):
+ """Raised when a local (to a track or an album) error occurs in one
+ of the backends.
+ """
+
+
+class FatalReplayGainError(Exception):
+ """Raised when a fatal error occurs in one of the backends.
+ """
+
+
+class FatalGstreamerPluginReplayGainError(FatalReplayGainError):
+ """Raised when a fatal error occurs in the GStreamerBackend when
+ loading the required plugins."""
+
+
+def call(args, **kwargs):
+ """Execute the command and return its output or raise a
+ ReplayGainError on failure.
+ """
+ try:
+ return command_output(args, **kwargs)
+ except subprocess.CalledProcessError as e:
+ raise ReplayGainError(
+ "{} exited with status {}".format(args[0], e.returncode)
+ )
+ except UnicodeEncodeError:
+ # Due to a bug in Python 2's subprocess on Windows, Unicode
+ # filenames can fail to encode on that platform. See:
+ # https://github.com/google-code-export/beets/issues/499
+ raise ReplayGainError("argument encoding failed")
+
+
+def after_version(version_a, version_b):
+ return tuple(int(s) for s in version_a.split('.')) \
+ >= tuple(int(s) for s in version_b.split('.'))
+
+
+def db_to_lufs(db):
+ """Convert db to LUFS.
+
+ According to https://wiki.hydrogenaud.io/index.php?title=
+ ReplayGain_2.0_specification#Reference_level
+ """
+ return db - 107
+
+
+def lufs_to_db(db):
+ """Convert LUFS to db.
+
+ According to https://wiki.hydrogenaud.io/index.php?title=
+ ReplayGain_2.0_specification#Reference_level
+ """
+ return db + 107
+
+
+# Backend base and plumbing classes.
+
+# gain: in LU to reference level
+# peak: part of full scale (FS is 1.0)
+Gain = collections.namedtuple("Gain", "gain peak")
+# album_gain: Gain object
+# track_gains: list of Gain objects
+AlbumGain = collections.namedtuple("AlbumGain", "album_gain track_gains")
+
+
+class Peak(enum.Enum):
+ none = 0
+ true = 1
+ sample = 2
+
+
+class Backend:
+ """An abstract class representing engine for calculating RG values.
+ """
+
+ do_parallel = False
+
+ def __init__(self, config, log):
+ """Initialize the backend with the configuration view for the
+ plugin.
+ """
+ self._log = log
+
+ def compute_track_gain(self, items, target_level, peak):
+ """Computes the track gain of the given tracks, returns a list
+ of Gain objects.
+ """
+ raise NotImplementedError()
+
+ def compute_album_gain(self, items, target_level, peak):
+ """Computes the album gain of the given album, returns an
+ AlbumGain object.
+ """
+ raise NotImplementedError()
+
+
+# ffmpeg backend
+class FfmpegBackend(Backend):
+ """A replaygain backend using ffmpeg's ebur128 filter.
+ """
+
+ do_parallel = True
+
+ def __init__(self, config, log):
+ super().__init__(config, log)
+ self._ffmpeg_path = "ffmpeg"
+
+ # check that ffmpeg is installed
+ try:
+ ffmpeg_version_out = call([self._ffmpeg_path, "-version"])
+ except OSError:
+ raise FatalReplayGainError(
+ f"could not find ffmpeg at {self._ffmpeg_path}"
+ )
+ incompatible_ffmpeg = True
+ for line in ffmpeg_version_out.stdout.splitlines():
+ if line.startswith(b"configuration:"):
+ if b"--enable-libebur128" in line:
+ incompatible_ffmpeg = False
+ if line.startswith(b"libavfilter"):
+ version = line.split(b" ", 1)[1].split(b"/", 1)[0].split(b".")
+ version = tuple(map(int, version))
+ if version >= (6, 67, 100):
+ incompatible_ffmpeg = False
+ if incompatible_ffmpeg:
+ raise FatalReplayGainError(
+ "Installed FFmpeg version does not support ReplayGain."
+ "calculation. Either libavfilter version 6.67.100 or above or"
+ "the --enable-libebur128 configuration option is required."
+ )
+
+ def compute_track_gain(self, items, target_level, peak):
+ """Computes the track gain of the given tracks, returns a list
+ of Gain objects (the track gains).
+ """
+ gains = []
+ for item in items:
+ gains.append(
+ self._analyse_item(
+ item,
+ target_level,
+ peak,
+ count_blocks=False,
+ )[0] # take only the gain, discarding number of gating blocks
+ )
+ return gains
+
+ def compute_album_gain(self, items, target_level, peak):
+ """Computes the album gain of the given album, returns an
+ AlbumGain object.
+ """
+ target_level_lufs = db_to_lufs(target_level)
+
+ # analyse tracks
+ # list of track Gain objects
+ track_gains = []
+ # maximum peak
+ album_peak = 0
+ # sum of BS.1770 gating block powers
+ sum_powers = 0
+ # total number of BS.1770 gating blocks
+ n_blocks = 0
+
+ for item in items:
+ track_gain, track_n_blocks = self._analyse_item(
+ item, target_level, peak
+ )
+ track_gains.append(track_gain)
+
+ # album peak is maximum track peak
+ album_peak = max(album_peak, track_gain.peak)
+
+ # prepare album_gain calculation
+ # total number of blocks is sum of track blocks
+ n_blocks += track_n_blocks
+
+ # convert `LU to target_level` -> LUFS
+ track_loudness = target_level_lufs - track_gain.gain
+ # This reverses ITU-R BS.1770-4 p. 6 equation (5) to convert
+ # from loudness to power. The result is the average gating
+ # block power.
+ track_power = 10**((track_loudness + 0.691) / 10)
+
+ # Weight that average power by the number of gating blocks to
+ # get the sum of all their powers. Add that to the sum of all
+ # block powers in this album.
+ sum_powers += track_power * track_n_blocks
+
+ # calculate album gain
+ if n_blocks > 0:
+ # compare ITU-R BS.1770-4 p. 6 equation (5)
+ # Album gain is the replaygain of the concatenation of all tracks.
+ album_gain = -0.691 + 10 * math.log10(sum_powers / n_blocks)
+ else:
+ album_gain = -70
+ # convert LUFS -> `LU to target_level`
+ album_gain = target_level_lufs - album_gain
+
+ self._log.debug(
+ "{}: gain {} LU, peak {}"
+ .format(items, album_gain, album_peak)
+ )
+
+ return AlbumGain(Gain(album_gain, album_peak), track_gains)
+
+ def _construct_cmd(self, item, peak_method):
+ """Construct the shell command to analyse items."""
+ return [
+ self._ffmpeg_path,
+ "-nostats",
+ "-hide_banner",
+ "-i",
+ item.path,
+ "-map",
+ "a:0",
+ "-filter",
+ f"ebur128=peak={peak_method}",
+ "-f",
+ "null",
+ "-",
+ ]
+
+ def _analyse_item(self, item, target_level, peak, count_blocks=True):
+ """Analyse item. Return a pair of a Gain object and the number
+ of gating blocks above the threshold.
+
+ If `count_blocks` is False, the number of gating blocks returned
+ will be 0.
+ """
+ target_level_lufs = db_to_lufs(target_level)
+ peak_method = peak.name
+
+ # call ffmpeg
+ self._log.debug(f"analyzing {item}")
+ cmd = self._construct_cmd(item, peak_method)
+ self._log.debug(
+ 'executing {0}', ' '.join(map(displayable_path, cmd))
+ )
+ output = call(cmd).stderr.splitlines()
+
+ # parse output
+
+ if peak == Peak.none:
+ peak = 0
+ else:
+ line_peak = self._find_line(
+ output,
+ f" {peak_method.capitalize()} peak:".encode(),
+ start_line=len(output) - 1, step_size=-1,
+ )
+ peak = self._parse_float(
+ output[self._find_line(
+ output, b" Peak:",
+ line_peak,
+ )]
+ )
+ # convert TPFS -> part of FS
+ peak = 10**(peak / 20)
+
+ line_integrated_loudness = self._find_line(
+ output, b" Integrated loudness:",
+ start_line=len(output) - 1, step_size=-1,
+ )
+ gain = self._parse_float(
+ output[self._find_line(
+ output, b" I:",
+ line_integrated_loudness,
+ )]
+ )
+ # convert LUFS -> LU from target level
+ gain = target_level_lufs - gain
+
+ # count BS.1770 gating blocks
+ n_blocks = 0
+ if count_blocks:
+ gating_threshold = self._parse_float(
+ output[self._find_line(
+ output, b" Threshold:",
+ start_line=line_integrated_loudness,
+ )]
+ )
+ for line in output:
+ if not line.startswith(b"[Parsed_ebur128"):
+ continue
+ if line.endswith(b"Summary:"):
+ continue
+ line = line.split(b"M:", 1)
+ if len(line) < 2:
+ continue
+ if self._parse_float(b"M: " + line[1]) >= gating_threshold:
+ n_blocks += 1
+ self._log.debug(
+ "{}: {} blocks over {} LUFS"
+ .format(item, n_blocks, gating_threshold)
+ )
+
+ self._log.debug(
+ "{}: gain {} LU, peak {}"
+ .format(item, gain, peak)
+ )
+
+ return Gain(gain, peak), n_blocks
+
+ def _find_line(self, output, search, start_line=0, step_size=1):
+ """Return index of line beginning with `search`.
+
+ Begins searching at index `start_line` in `output`.
+ """
+ end_index = len(output) if step_size > 0 else -1
+ for i in range(start_line, end_index, step_size):
+ if output[i].startswith(search):
+ return i
+ raise ReplayGainError(
+ "ffmpeg output: missing {} after line {}"
+ .format(repr(search), start_line)
+ )
+
+ def _parse_float(self, line):
+ """Extract a float from a key value pair in `line`.
+
+ This format is expected: /[^:]:[[:space:]]*value.*/, where `value` is
+ the float.
+ """
+ # extract value
+ value = line.split(b":", 1)
+ if len(value) < 2:
+ raise ReplayGainError(
+ "ffmpeg output: expected key value pair, found {}"
+ .format(line)
+ )
+ value = value[1].lstrip()
+ # strip unit
+ value = value.split(b" ", 1)[0]
+ # cast value to float
+ try:
+ return float(value)
+ except ValueError:
+ raise ReplayGainError(
+ "ffmpeg output: expected float value, found {}"
+ .format(value)
+ )
+
+
+# mpgain/aacgain CLI tool backend.
+class CommandBackend(Backend):
+ do_parallel = True
+
+ def __init__(self, config, log):
+ super().__init__(config, log)
+ config.add({
+ 'command': "",
+ 'noclip': True,
+ })
+
+ self.command = config["command"].as_str()
+
+ if self.command:
+ # Explicit executable path.
+ if not os.path.isfile(self.command):
+ raise FatalReplayGainError(
+ 'replaygain command does not exist: {}'.format(
+ self.command)
+ )
+ else:
+ # Check whether the program is in $PATH.
+ for cmd in ('mp3gain', 'aacgain'):
+ try:
+ call([cmd, '-v'])
+ self.command = cmd
+ except OSError:
+ pass
+ if not self.command:
+ raise FatalReplayGainError(
+ 'no replaygain command found: install mp3gain or aacgain'
+ )
+
+ self.noclip = config['noclip'].get(bool)
+
+ def compute_track_gain(self, items, target_level, peak):
+ """Computes the track gain of the given tracks, returns a list
+ of TrackGain objects.
+ """
+ supported_items = list(filter(self.format_supported, items))
+ output = self.compute_gain(supported_items, target_level, False)
+ return output
+
+ def compute_album_gain(self, items, target_level, peak):
+ """Computes the album gain of the given album, returns an
+ AlbumGain object.
+ """
+ # TODO: What should be done when not all tracks in the album are
+ # supported?
+
+ supported_items = list(filter(self.format_supported, items))
+ if len(supported_items) != len(items):
+ self._log.debug('tracks are of unsupported format')
+ return AlbumGain(None, [])
+
+ output = self.compute_gain(supported_items, target_level, True)
+ return AlbumGain(output[-1], output[:-1])
+
+ def format_supported(self, item):
+ """Checks whether the given item is supported by the selected tool.
+ """
+ if 'mp3gain' in self.command and item.format != 'MP3':
+ return False
+ elif 'aacgain' in self.command and item.format not in ('MP3', 'AAC'):
+ return False
+ return True
+
+ def compute_gain(self, items, target_level, is_album):
+ """Computes the track or album gain of a list of items, returns
+ a list of TrackGain objects.
+
+ When computing album gain, the last TrackGain object returned is
+ the album gain
+ """
+ if len(items) == 0:
+ self._log.debug('no supported tracks to analyze')
+ return []
+
+ """Compute ReplayGain values and return a list of results
+ dictionaries as given by `parse_tool_output`.
+ """
+ # Construct shell command. The "-o" option makes the output
+ # easily parseable (tab-delimited). "-s s" forces gain
+ # recalculation even if tags are already present and disables
+ # tag-writing; this turns the mp3gain/aacgain tool into a gain
+ # calculator rather than a tag manipulator because we take care
+ # of changing tags ourselves.
+ cmd = [self.command, '-o', '-s', 's']
+ if self.noclip:
+ # Adjust to avoid clipping.
+ cmd = cmd + ['-k']
+ else:
+ # Disable clipping warning.
+ cmd = cmd + ['-c']
+ cmd = cmd + ['-d', str(int(target_level - 89))]
+ cmd = cmd + [syspath(i.path) for i in items]
+
+ self._log.debug('analyzing {0} files', len(items))
+ self._log.debug("executing {0}", " ".join(map(displayable_path, cmd)))
+ output = call(cmd).stdout
+ self._log.debug('analysis finished')
+ return self.parse_tool_output(output,
+ len(items) + (1 if is_album else 0))
+
+ def parse_tool_output(self, text, num_lines):
+ """Given the tab-delimited output from an invocation of mp3gain
+ or aacgain, parse the text and return a list of dictionaries
+ containing information about each analyzed file.
+ """
+ out = []
+ for line in text.split(b'\n')[1:num_lines + 1]:
+ parts = line.split(b'\t')
+ if len(parts) != 6 or parts[0] == b'File':
+ self._log.debug('bad tool output: {0}', text)
+ raise ReplayGainError('mp3gain failed')
+ d = {
+ 'file': parts[0],
+ 'mp3gain': int(parts[1]),
+ 'gain': float(parts[2]),
+ 'peak': float(parts[3]) / (1 << 15),
+ 'maxgain': int(parts[4]),
+ 'mingain': int(parts[5]),
+
+ }
+ out.append(Gain(d['gain'], d['peak']))
+ return out
+
+
+# GStreamer-based backend.
+
+class GStreamerBackend(Backend):
+ def __init__(self, config, log):
+ super().__init__(config, log)
+ self._import_gst()
+
+ # Initialized a GStreamer pipeline of the form filesrc ->
+ # decodebin -> audioconvert -> audioresample -> rganalysis ->
+ # fakesink The connection between decodebin and audioconvert is
+ # handled dynamically after decodebin figures out the type of
+ # the input file.
+ self._src = self.Gst.ElementFactory.make("filesrc", "src")
+ self._decbin = self.Gst.ElementFactory.make("decodebin", "decbin")
+ self._conv = self.Gst.ElementFactory.make("audioconvert", "conv")
+ self._res = self.Gst.ElementFactory.make("audioresample", "res")
+ self._rg = self.Gst.ElementFactory.make("rganalysis", "rg")
+
+ if self._src is None or self._decbin is None or self._conv is None \
+ or self._res is None or self._rg is None:
+ raise FatalGstreamerPluginReplayGainError(
+ "Failed to load required GStreamer plugins"
+ )
+
+ # We check which files need gain ourselves, so all files given
+ # to rganalsys should have their gain computed, even if it
+ # already exists.
+ self._rg.set_property("forced", True)
+ self._sink = self.Gst.ElementFactory.make("fakesink", "sink")
+
+ self._pipe = self.Gst.Pipeline()
+ self._pipe.add(self._src)
+ self._pipe.add(self._decbin)
+ self._pipe.add(self._conv)
+ self._pipe.add(self._res)
+ self._pipe.add(self._rg)
+ self._pipe.add(self._sink)
+
+ self._src.link(self._decbin)
+ self._conv.link(self._res)
+ self._res.link(self._rg)
+ self._rg.link(self._sink)
+
+ self._bus = self._pipe.get_bus()
+ self._bus.add_signal_watch()
+ self._bus.connect("message::eos", self._on_eos)
+ self._bus.connect("message::error", self._on_error)
+ self._bus.connect("message::tag", self._on_tag)
+ # Needed for handling the dynamic connection between decodebin
+ # and audioconvert
+ self._decbin.connect("pad-added", self._on_pad_added)
+ self._decbin.connect("pad-removed", self._on_pad_removed)
+
+ self._main_loop = self.GLib.MainLoop()
+
+ self._files = []
+
+ def _import_gst(self):
+ """Import the necessary GObject-related modules and assign `Gst`
+ and `GObject` fields on this object.
+ """
+
+ try:
+ import gi
+ except ImportError:
+ raise FatalReplayGainError(
+ "Failed to load GStreamer: python-gi not found"
+ )
+
+ try:
+ gi.require_version('Gst', '1.0')
+ except ValueError as e:
+ raise FatalReplayGainError(
+ f"Failed to load GStreamer 1.0: {e}"
+ )
+
+ from gi.repository import GObject, Gst, GLib
+ # Calling GObject.threads_init() is not needed for
+ # PyGObject 3.10.2+
+ with warnings.catch_warnings():
+ warnings.simplefilter("ignore")
+ GObject.threads_init()
+ Gst.init([sys.argv[0]])
+
+ self.GObject = GObject
+ self.GLib = GLib
+ self.Gst = Gst
+
+ def compute(self, files, target_level, album):
+ self._error = None
+ self._files = list(files)
+
+ if len(self._files) == 0:
+ return
+
+ self._file_tags = collections.defaultdict(dict)
+
+ self._rg.set_property("reference-level", target_level)
+
+ if album:
+ self._rg.set_property("num-tracks", len(self._files))
+
+ if self._set_first_file():
+ self._main_loop.run()
+ if self._error is not None:
+ raise self._error
+
+ def compute_track_gain(self, items, target_level, peak):
+ self.compute(items, target_level, False)
+ if len(self._file_tags) != len(items):
+ raise ReplayGainError("Some tracks did not receive tags")
+
+ ret = []
+ for item in items:
+ ret.append(Gain(self._file_tags[item]["TRACK_GAIN"],
+ self._file_tags[item]["TRACK_PEAK"]))
+
+ return ret
+
+ def compute_album_gain(self, items, target_level, peak):
+ items = list(items)
+ self.compute(items, target_level, True)
+ if len(self._file_tags) != len(items):
+ raise ReplayGainError("Some items in album did not receive tags")
+
+ # Collect track gains.
+ track_gains = []
+ for item in items:
+ try:
+ gain = self._file_tags[item]["TRACK_GAIN"]
+ peak = self._file_tags[item]["TRACK_PEAK"]
+ except KeyError:
+ raise ReplayGainError("results missing for track")
+ track_gains.append(Gain(gain, peak))
+
+ # Get album gain information from the last track.
+ last_tags = self._file_tags[items[-1]]
+ try:
+ gain = last_tags["ALBUM_GAIN"]
+ peak = last_tags["ALBUM_PEAK"]
+ except KeyError:
+ raise ReplayGainError("results missing for album")
+
+ return AlbumGain(Gain(gain, peak), track_gains)
+
+ def close(self):
+ self._bus.remove_signal_watch()
+
+ def _on_eos(self, bus, message):
+ # A file finished playing in all elements of the pipeline. The
+ # RG tags have already been propagated. If we don't have a next
+ # file, we stop processing.
+ if not self._set_next_file():
+ self._pipe.set_state(self.Gst.State.NULL)
+ self._main_loop.quit()
+
+ def _on_error(self, bus, message):
+ self._pipe.set_state(self.Gst.State.NULL)
+ self._main_loop.quit()
+ err, debug = message.parse_error()
+ f = self._src.get_property("location")
+ # A GStreamer error, either an unsupported format or a bug.
+ self._error = ReplayGainError(
+ f"Error {err!r} - {debug!r} on file {f!r}"
+ )
+
+ def _on_tag(self, bus, message):
+ tags = message.parse_tag()
+
+ def handle_tag(taglist, tag, userdata):
+ # The rganalysis element provides both the existing tags for
+ # files and the new computes tags. In order to ensure we
+ # store the computed tags, we overwrite the RG values of
+ # received a second time.
+ if tag == self.Gst.TAG_TRACK_GAIN:
+ self._file_tags[self._file]["TRACK_GAIN"] = \
+ taglist.get_double(tag)[1]
+ elif tag == self.Gst.TAG_TRACK_PEAK:
+ self._file_tags[self._file]["TRACK_PEAK"] = \
+ taglist.get_double(tag)[1]
+ elif tag == self.Gst.TAG_ALBUM_GAIN:
+ self._file_tags[self._file]["ALBUM_GAIN"] = \
+ taglist.get_double(tag)[1]
+ elif tag == self.Gst.TAG_ALBUM_PEAK:
+ self._file_tags[self._file]["ALBUM_PEAK"] = \
+ taglist.get_double(tag)[1]
+ elif tag == self.Gst.TAG_REFERENCE_LEVEL:
+ self._file_tags[self._file]["REFERENCE_LEVEL"] = \
+ taglist.get_double(tag)[1]
+
+ tags.foreach(handle_tag, None)
+
+ def _set_first_file(self):
+ if len(self._files) == 0:
+ return False
+
+ self._file = self._files.pop(0)
+ self._pipe.set_state(self.Gst.State.NULL)
+ self._src.set_property("location", py3_path(syspath(self._file.path)))
+ self._pipe.set_state(self.Gst.State.PLAYING)
+ return True
+
+ def _set_file(self):
+ """Initialize the filesrc element with the next file to be analyzed.
+ """
+ # No more files, we're done
+ if len(self._files) == 0:
+ return False
+
+ self._file = self._files.pop(0)
+
+ # Ensure the filesrc element received the paused state of the
+ # pipeline in a blocking manner
+ self._src.sync_state_with_parent()
+ self._src.get_state(self.Gst.CLOCK_TIME_NONE)
+
+ # Ensure the decodebin element receives the paused state of the
+ # pipeline in a blocking manner
+ self._decbin.sync_state_with_parent()
+ self._decbin.get_state(self.Gst.CLOCK_TIME_NONE)
+
+ # Disconnect the decodebin element from the pipeline, set its
+ # state to READY to to clear it.
+ self._decbin.unlink(self._conv)
+ self._decbin.set_state(self.Gst.State.READY)
+
+ # Set a new file on the filesrc element, can only be done in the
+ # READY state
+ self._src.set_state(self.Gst.State.READY)
+ self._src.set_property("location", py3_path(syspath(self._file.path)))
+
+ self._decbin.link(self._conv)
+ self._pipe.set_state(self.Gst.State.READY)
+
+ return True
+
+ def _set_next_file(self):
+ """Set the next file to be analyzed while keeping the pipeline
+ in the PAUSED state so that the rganalysis element can correctly
+ handle album gain.
+ """
+ # A blocking pause
+ self._pipe.set_state(self.Gst.State.PAUSED)
+ self._pipe.get_state(self.Gst.CLOCK_TIME_NONE)
+
+ # Try setting the next file
+ ret = self._set_file()
+ if ret:
+ # Seek to the beginning in order to clear the EOS state of the
+ # various elements of the pipeline
+ self._pipe.seek_simple(self.Gst.Format.TIME,
+ self.Gst.SeekFlags.FLUSH,
+ 0)
+ self._pipe.set_state(self.Gst.State.PLAYING)
+
+ return ret
+
+ def _on_pad_added(self, decbin, pad):
+ sink_pad = self._conv.get_compatible_pad(pad, None)
+ assert(sink_pad is not None)
+ pad.link(sink_pad)
+
+ def _on_pad_removed(self, decbin, pad):
+ # Called when the decodebin element is disconnected from the
+ # rest of the pipeline while switching input files
+ peer = pad.get_peer()
+ assert(peer is None)
+
+
+class AudioToolsBackend(Backend):
+ """ReplayGain backend that uses `Python Audio Tools
+ <http://audiotools.sourceforge.net/>`_ and its capabilities to read more
+ file formats and compute ReplayGain values using it replaygain module.
+ """
+
+ def __init__(self, config, log):
+ super().__init__(config, log)
+ self._import_audiotools()
+
+ def _import_audiotools(self):
+ """Check whether it's possible to import the necessary modules.
+ There is no check on the file formats at runtime.
+
+ :raises :exc:`ReplayGainError`: if the modules cannot be imported
+ """
+ try:
+ import audiotools
+ import audiotools.replaygain
+ except ImportError:
+ raise FatalReplayGainError(
+ "Failed to load audiotools: audiotools not found"
+ )
+ self._mod_audiotools = audiotools
+ self._mod_replaygain = audiotools.replaygain
+
+ def open_audio_file(self, item):
+ """Open the file to read the PCM stream from the using
+ ``item.path``.
+
+ :return: the audiofile instance
+ :rtype: :class:`audiotools.AudioFile`
+ :raises :exc:`ReplayGainError`: if the file is not found or the
+ file format is not supported
+ """
+ try:
+ audiofile = self._mod_audiotools.open(py3_path(syspath(item.path)))
+ except OSError:
+ raise ReplayGainError(
+ f"File {item.path} was not found"
+ )
+ except self._mod_audiotools.UnsupportedFile:
+ raise ReplayGainError(
+ f"Unsupported file type {item.format}"
+ )
+
+ return audiofile
+
+ def init_replaygain(self, audiofile, item):
+ """Return an initialized :class:`audiotools.replaygain.ReplayGain`
+ instance, which requires the sample rate of the song(s) on which
+ the ReplayGain values will be computed. The item is passed in case
+ the sample rate is invalid to log the stored item sample rate.
+
+ :return: initialized replagain object
+ :rtype: :class:`audiotools.replaygain.ReplayGain`
+ :raises: :exc:`ReplayGainError` if the sample rate is invalid
+ """
+ try:
+ rg = self._mod_replaygain.ReplayGain(audiofile.sample_rate())
+ except ValueError:
+ raise ReplayGainError(
+ f"Unsupported sample rate {item.samplerate}")
+ return
+ return rg
+
+ def compute_track_gain(self, items, target_level, peak):
+ """Compute ReplayGain values for the requested items.
+
+ :return list: list of :class:`Gain` objects
+ """
+ return [self._compute_track_gain(item, target_level) for item in items]
+
+ def _with_target_level(self, gain, target_level):
+ """Return `gain` relative to `target_level`.
+
+ Assumes `gain` is relative to 89 db.
+ """
+ return gain + (target_level - 89)
+
+ def _title_gain(self, rg, audiofile, target_level):
+ """Get the gain result pair from PyAudioTools using the `ReplayGain`
+ instance `rg` for the given `audiofile`.
+
+ Wraps `rg.title_gain(audiofile.to_pcm())` and throws a
+ `ReplayGainError` when the library fails.
+ """
+ try:
+ # The method needs an audiotools.PCMReader instance that can
+ # be obtained from an audiofile instance.
+ gain, peak = rg.title_gain(audiofile.to_pcm())
+ except ValueError as exc:
+ # `audiotools.replaygain` can raise a `ValueError` if the sample
+ # rate is incorrect.
+ self._log.debug('error in rg.title_gain() call: {}', exc)
+ raise ReplayGainError('audiotools audio data error')
+ return self._with_target_level(gain, target_level), peak
+
+ def _compute_track_gain(self, item, target_level):
+ """Compute ReplayGain value for the requested item.
+
+ :rtype: :class:`Gain`
+ """
+ audiofile = self.open_audio_file(item)
+ rg = self.init_replaygain(audiofile, item)
+
+ # Each call to title_gain on a ReplayGain object returns peak and gain
+ # of the track.
+ rg_track_gain, rg_track_peak = self._title_gain(
+ rg, audiofile, target_level
+ )
+
+ self._log.debug('ReplayGain for track {0} - {1}: {2:.2f}, {3:.2f}',
+ item.artist, item.title, rg_track_gain, rg_track_peak)
+ return Gain(gain=rg_track_gain, peak=rg_track_peak)
+
+ def compute_album_gain(self, items, target_level, peak):
+ """Compute ReplayGain values for the requested album and its items.
+
+ :rtype: :class:`AlbumGain`
+ """
+ # The first item is taken and opened to get the sample rate to
+ # initialize the replaygain object. The object is used for all the
+ # tracks in the album to get the album values.
+ item = list(items)[0]
+ audiofile = self.open_audio_file(item)
+ rg = self.init_replaygain(audiofile, item)
+
+ track_gains = []
+ for item in items:
+ audiofile = self.open_audio_file(item)
+ rg_track_gain, rg_track_peak = self._title_gain(
+ rg, audiofile, target_level
+ )
+ track_gains.append(
+ Gain(gain=rg_track_gain, peak=rg_track_peak)
+ )
+ self._log.debug('ReplayGain for track {0}: {1:.2f}, {2:.2f}',
+ item, rg_track_gain, rg_track_peak)
+
+ # After getting the values for all tracks, it's possible to get the
+ # album values.
+ rg_album_gain, rg_album_peak = rg.album_gain()
+ rg_album_gain = self._with_target_level(rg_album_gain, target_level)
+ self._log.debug('ReplayGain for album {0}: {1:.2f}, {2:.2f}',
+ items[0].album, rg_album_gain, rg_album_peak)
+
+ return AlbumGain(
+ Gain(gain=rg_album_gain, peak=rg_album_peak),
+ track_gains=track_gains
+ )
+
+
+class ExceptionWatcher(Thread):
+ """Monitors a queue for exceptions asynchronously.
+ Once an exception occurs, raise it and execute a callback.
+ """
+
+ def __init__(self, queue, callback):
+ self._queue = queue
+ self._callback = callback
+ self._stopevent = Event()
+ Thread.__init__(self)
+
+ def run(self):
+ while not self._stopevent.is_set():
+ try:
+ exc = self._queue.get_nowait()
+ self._callback()
+ raise exc[1].with_traceback(exc[2])
+ except queue.Empty:
+ # No exceptions yet, loop back to check
+ # whether `_stopevent` is set
+ pass
+
+ def join(self, timeout=None):
+ self._stopevent.set()
+ Thread.join(self, timeout)
+
+
+# Main plugin logic.
+
+class ReplayGainPlugin(BeetsPlugin):
+ """Provides ReplayGain analysis.
+ """
+
+ backends = {
+ "command": CommandBackend,
+ "gstreamer": GStreamerBackend,
+ "audiotools": AudioToolsBackend,
+ "ffmpeg": FfmpegBackend,
+ }
+
+ peak_methods = {
+ "true": Peak.true,
+ "sample": Peak.sample,
+ }
+
+ def __init__(self):
+ super().__init__()
+
+ # default backend is 'command' for backward-compatibility.
+ self.config.add({
+ 'overwrite': False,
+ 'auto': True,
+ 'backend': 'command',
+ 'threads': cpu_count(),
+ 'parallel_on_import': False,
+ 'per_disc': False,
+ 'peak': 'true',
+ 'targetlevel': 89,
+ 'r128': ['Opus'],
+ 'r128_targetlevel': lufs_to_db(-23),
+ })
+
+ self.overwrite = self.config['overwrite'].get(bool)
+ self.per_disc = self.config['per_disc'].get(bool)
+
+ # Remember which backend is used for CLI feedback
+ self.backend_name = self.config['backend'].as_str()
+
+ if self.backend_name not in self.backends:
+ raise ui.UserError(
+ "Selected ReplayGain backend {} is not supported. "
+ "Please select one of: {}".format(
+ self.backend_name,
+ ', '.join(self.backends.keys())
+ )
+ )
+ peak_method = self.config["peak"].as_str()
+ if peak_method not in self.peak_methods:
+ raise ui.UserError(
+ "Selected ReplayGain peak method {} is not supported. "
+ "Please select one of: {}".format(
+ peak_method,
+ ', '.join(self.peak_methods.keys())
+ )
+ )
+ self._peak_method = self.peak_methods[peak_method]
+
+ # On-import analysis.
+ if self.config['auto']:
+ self.register_listener('import_begin', self.import_begin)
+ self.register_listener('import', self.import_end)
+ self.import_stages = [self.imported]
+
+ # Formats to use R128.
+ self.r128_whitelist = self.config['r128'].as_str_seq()
+
+ try:
+ self.backend_instance = self.backends[self.backend_name](
+ self.config, self._log
+ )
+ except (ReplayGainError, FatalReplayGainError) as e:
+ raise ui.UserError(
+ f'replaygain initialization failed: {e}')
+
+ def should_use_r128(self, item):
+ """Checks the plugin setting to decide whether the calculation
+ should be done using the EBU R128 standard and use R128_ tags instead.
+ """
+ return item.format in self.r128_whitelist
+
+ def track_requires_gain(self, item):
+ return self.overwrite or \
+ (self.should_use_r128(item) and not item.r128_track_gain) or \
+ (not self.should_use_r128(item) and
+ (not item.rg_track_gain or not item.rg_track_peak))
+
+ def album_requires_gain(self, album):
+ # Skip calculating gain only when *all* files don't need
+ # recalculation. This way, if any file among an album's tracks
+ # needs recalculation, we still get an accurate album gain
+ # value.
+ return self.overwrite or \
+ any([self.should_use_r128(item) and
+ (not item.r128_track_gain or not item.r128_album_gain)
+ for item in album.items()]) or \
+ any([not self.should_use_r128(item) and
+ (not item.rg_album_gain or not item.rg_album_peak)
+ for item in album.items()])
+
+ def store_track_gain(self, item, track_gain):
+ item.rg_track_gain = track_gain.gain
+ item.rg_track_peak = track_gain.peak
+ item.store()
+ self._log.debug('applied track gain {0} LU, peak {1} of FS',
+ item.rg_track_gain, item.rg_track_peak)
+
+ def store_album_gain(self, item, album_gain):
+ item.rg_album_gain = album_gain.gain
+ item.rg_album_peak = album_gain.peak
+ item.store()
+ self._log.debug('applied album gain {0} LU, peak {1} of FS',
+ item.rg_album_gain, item.rg_album_peak)
+
+ def store_track_r128_gain(self, item, track_gain):
+ item.r128_track_gain = track_gain.gain
+ item.store()
+
+ self._log.debug('applied r128 track gain {0} LU',
+ item.r128_track_gain)
+
+ def store_album_r128_gain(self, item, album_gain):
+ item.r128_album_gain = album_gain.gain
+ item.store()
+ self._log.debug('applied r128 album gain {0} LU',
+ item.r128_album_gain)
+
+ def tag_specific_values(self, items):
+ """Return some tag specific values.
+
+ Returns a tuple (store_track_gain, store_album_gain, target_level,
+ peak_method).
+ """
+ if any([self.should_use_r128(item) for item in items]):
+ store_track_gain = self.store_track_r128_gain
+ store_album_gain = self.store_album_r128_gain
+ target_level = self.config['r128_targetlevel'].as_number()
+ peak = Peak.none # R128_* tags do not store the track/album peak
+ else:
+ store_track_gain = self.store_track_gain
+ store_album_gain = self.store_album_gain
+ target_level = self.config['targetlevel'].as_number()
+ peak = self._peak_method
+
+ return store_track_gain, store_album_gain, target_level, peak
+
+ def handle_album(self, album, write, force=False):
+ """Compute album and track replay gain store it in all of the
+ album's items.
+
+ If ``write`` is truthy then ``item.write()`` is called for each
+ item. If replay gain information is already present in all
+ items, nothing is done.
+ """
+ if not force and not self.album_requires_gain(album):
+ self._log.info('Skipping album {0}', album)
+ return
+
+ if (any([self.should_use_r128(item) for item in album.items()]) and not
+ all([self.should_use_r128(item) for item in album.items()])):
+ self._log.error(
+ "Cannot calculate gain for album {0} (incompatible formats)",
+ album)
+ return
+
+ self._log.info('analyzing {0}', album)
+
+ tag_vals = self.tag_specific_values(album.items())
+ store_track_gain, store_album_gain, target_level, peak = tag_vals
+
+ discs = {}
+ if self.per_disc:
+ for item in album.items():
+ if discs.get(item.disc) is None:
+ discs[item.disc] = []
+ discs[item.disc].append(item)
+ else:
+ discs[1] = album.items()
+
+ for discnumber, items in discs.items():
+ def _store_album(album_gain):
+ if not album_gain or not album_gain.album_gain \
+ or len(album_gain.track_gains) != len(items):
+ # In some cases, backends fail to produce a valid
+ # `album_gain` without throwing FatalReplayGainError
+ # => raise non-fatal exception & continue
+ raise ReplayGainError(
+ "ReplayGain backend `{}` failed "
+ "for some tracks in album {}"
+ .format(self.backend_name, album)
+ )
+ for item, track_gain in zip(items,
+ album_gain.track_gains):
+ store_track_gain(item, track_gain)
+ store_album_gain(item, album_gain.album_gain)
+ if write:
+ item.try_write()
+ self._log.debug('done analyzing {0}', item)
+
+ try:
+ self._apply(
+ self.backend_instance.compute_album_gain, args=(),
+ kwds={
+ "items": list(items),
+ "target_level": target_level,
+ "peak": peak
+ },
+ callback=_store_album
+ )
+ except ReplayGainError as e:
+ self._log.info("ReplayGain error: {0}", e)
+ except FatalReplayGainError as e:
+ raise ui.UserError(
+ f"Fatal replay gain error: {e}")
+
+ def handle_track(self, item, write, force=False):
+ """Compute track replay gain and store it in the item.
+
+ If ``write`` is truthy then ``item.write()`` is called to write
+ the data to disk. If replay gain information is already present
+ in the item, nothing is done.
+ """
+ if not force and not self.track_requires_gain(item):
+ self._log.info('Skipping track {0}', item)
+ return
+
+ tag_vals = self.tag_specific_values([item])
+ store_track_gain, store_album_gain, target_level, peak = tag_vals
+
+ def _store_track(track_gains):
+ if not track_gains or len(track_gains) != 1:
+ # In some cases, backends fail to produce a valid
+ # `track_gains` without throwing FatalReplayGainError
+ # => raise non-fatal exception & continue
+ raise ReplayGainError(
+ "ReplayGain backend `{}` failed for track {}"
+ .format(self.backend_name, item)
+ )
+
+ store_track_gain(item, track_gains[0])
+ if write:
+ item.try_write()
+ self._log.debug('done analyzing {0}', item)
+
+ try:
+ self._apply(
+ self.backend_instance.compute_track_gain, args=(),
+ kwds={
+ "items": [item],
+ "target_level": target_level,
+ "peak": peak,
+ },
+ callback=_store_track
+ )
+ except ReplayGainError as e:
+ self._log.info("ReplayGain error: {0}", e)
+ except FatalReplayGainError as e:
+ raise ui.UserError(f"Fatal replay gain error: {e}")
+
+ def _has_pool(self):
+ """Check whether a `ThreadPool` is running instance in `self.pool`
+ """
+ if hasattr(self, 'pool'):
+ if isinstance(self.pool, ThreadPool) and self.pool._state == RUN:
+ return True
+ return False
+
+ def open_pool(self, threads):
+ """Open a `ThreadPool` instance in `self.pool`
+ """
+ if not self._has_pool() and self.backend_instance.do_parallel:
+ self.pool = ThreadPool(threads)
+ self.exc_queue = queue.Queue()
+
+ signal.signal(signal.SIGINT, self._interrupt)
+
+ self.exc_watcher = ExceptionWatcher(
+ self.exc_queue, # threads push exceptions here
+ self.terminate_pool # abort once an exception occurs
+ )
+ self.exc_watcher.start()
+
+ def _apply(self, func, args, kwds, callback):
+ if self._has_pool():
+ def catch_exc(func, exc_queue, log):
+ """Wrapper to catch raised exceptions in threads
+ """
+ def wfunc(*args, **kwargs):
+ try:
+ return func(*args, **kwargs)
+ except ReplayGainError as e:
+ log.info(e.args[0]) # log non-fatal exceptions
+ except Exception:
+ exc_queue.put(sys.exc_info())
+ return wfunc
+
+ # Wrap function and callback to catch exceptions
+ func = catch_exc(func, self.exc_queue, self._log)
+ callback = catch_exc(callback, self.exc_queue, self._log)
+
+ self.pool.apply_async(func, args, kwds, callback)
+ else:
+ callback(func(*args, **kwds))
+
+ def terminate_pool(self):
+ """Terminate the `ThreadPool` instance in `self.pool`
+ (e.g. stop execution in case of exception)
+ """
+ # Don't call self._as_pool() here,
+ # self.pool._state may not be == RUN
+ if hasattr(self, 'pool') and isinstance(self.pool, ThreadPool):
+ self.pool.terminate()
+ self.pool.join()
+ # self.exc_watcher.join()
+
+ def _interrupt(self, signal, frame):
+ try:
+ self._log.info('interrupted')
+ self.terminate_pool()
+ sys.exit(0)
+ except SystemExit:
+ # Silence raised SystemExit ~ exit(0)
+ pass
+
+ def close_pool(self):
+ """Close the `ThreadPool` instance in `self.pool` (if there is one)
+ """
+ if self._has_pool():
+ self.pool.close()
+ self.pool.join()
+ self.exc_watcher.join()
+
+ def import_begin(self, session):
+ """Handle `import_begin` event -> open pool
+ """
+ threads = self.config['threads'].get(int)
+
+ if self.config['parallel_on_import'] \
+ and self.config['auto'] \
+ and threads:
+ self.open_pool(threads)
+
+ def import_end(self, paths):
+ """Handle `import` event -> close pool
+ """
+ self.close_pool()
+
+ def imported(self, session, task):
+ """Add replay gain info to items or albums of ``task``.
+ """
+ if self.config['auto']:
+ if task.is_album:
+ self.handle_album(task.album, False)
+ else:
+ self.handle_track(task.item, False)
+
+ def command_func(self, lib, opts, args):
+ try:
+ write = ui.should_write(opts.write)
+ force = opts.force
+
+ # Bypass self.open_pool() if called with `--threads 0`
+ if opts.threads != 0:
+ threads = opts.threads or self.config['threads'].get(int)
+ self.open_pool(threads)
+
+ if opts.album:
+ albums = lib.albums(ui.decargs(args))
+ self._log.info(
+ "Analyzing {} albums ~ {} backend..."
+ .format(len(albums), self.backend_name)
+ )
+ for album in albums:
+ self.handle_album(album, write, force)
+ else:
+ items = lib.items(ui.decargs(args))
+ self._log.info(
+ "Analyzing {} tracks ~ {} backend..."
+ .format(len(items), self.backend_name)
+ )
+ for item in items:
+ self.handle_track(item, write, force)
+
+ self.close_pool()
+ except (SystemExit, KeyboardInterrupt):
+ # Silence interrupt exceptions
+ pass
+
+ def commands(self):
+ """Return the "replaygain" ui subcommand.
+ """
+ cmd = ui.Subcommand('replaygain', help='analyze for ReplayGain')
+ cmd.parser.add_album_option()
+ cmd.parser.add_option(
+ "-t", "--threads", dest="threads", type=int,
+ help='change the number of threads, \
+ defaults to maximum available processors'
+ )
+ cmd.parser.add_option(
+ "-f", "--force", dest="force", action="store_true", default=False,
+ help="analyze all files, including those that "
+ "already have ReplayGain metadata")
+ cmd.parser.add_option(
+ "-w", "--write", default=None, action="store_true",
+ help="write new metadata to files' tags")
+ cmd.parser.add_option(
+ "-W", "--nowrite", dest="write", action="store_false",
+ help="don't write metadata (opposite of -w)")
+ cmd.func = self.command_func
+ return [cmd]
diff --git a/lib/beetsplug/rewrite.py b/lib/beetsplug/rewrite.py
new file mode 100644
index 00000000..e02e4080
--- /dev/null
+++ b/lib/beetsplug/rewrite.py
@@ -0,0 +1,73 @@
+# This file is part of beets.
+# Copyright 2016, Adrian Sampson.
+#
+# 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.
+
+"""Uses user-specified rewriting rules to canonicalize names for path
+formats.
+"""
+
+import re
+from collections import defaultdict
+
+from beets.plugins import BeetsPlugin
+from beets import ui
+from beets import library
+
+
+def rewriter(field, rules):
+ """Create a template field function that rewrites the given field
+ with the given rewriting rules. ``rules`` must be a list of
+ (pattern, replacement) pairs.
+ """
+ def fieldfunc(item):
+ value = item._values_fixed[field]
+ for pattern, replacement in rules:
+ if pattern.match(value.lower()):
+ # Rewrite activated.
+ return replacement
+ # Not activated; return original value.
+ return value
+ return fieldfunc
+
+
+class RewritePlugin(BeetsPlugin):
+ def __init__(self):
+ super().__init__()
+
+ self.config.add({})
+
+ # Gather all the rewrite rules for each field.
+ rules = defaultdict(list)
+ for key, view in self.config.items():
+ value = view.as_str()
+ try:
+ fieldname, pattern = key.split(None, 1)
+ except ValueError:
+ raise ui.UserError("invalid rewrite specification")
+ if fieldname not in library.Item._fields:
+ raise ui.UserError("invalid field name (%s) in rewriter" %
+ fieldname)
+ self._log.debug('adding template field {0}', key)
+ pattern = re.compile(pattern.lower())
+ rules[fieldname].append((pattern, value))
+ if fieldname == 'artist':
+ # Special case for the artist field: apply the same
+ # rewrite for "albumartist" as well.
+ rules['albumartist'].append((pattern, value))
+
+ # Replace each template field with the new rewriter function.
+ for fieldname, fieldrules in rules.items():
+ getter = rewriter(fieldname, fieldrules)
+ self.template_fields[fieldname] = getter
+ if fieldname in library.Album._fields:
+ self.album_template_fields[fieldname] = getter
diff --git a/lib/beetsplug/scrub.py b/lib/beetsplug/scrub.py
new file mode 100644
index 00000000..d8044668
--- /dev/null
+++ b/lib/beetsplug/scrub.py
@@ -0,0 +1,149 @@
+# This file is part of beets.
+# Copyright 2016, Adrian Sampson.
+#
+# 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.
+
+"""Cleans extraneous metadata from files' tags via a command or
+automatically whenever tags are written.
+"""
+
+
+from beets.plugins import BeetsPlugin
+from beets import ui
+from beets import util
+from beets import config
+import mediafile
+import mutagen
+
+_MUTAGEN_FORMATS = {
+ 'asf': 'ASF',
+ 'apev2': 'APEv2File',
+ 'flac': 'FLAC',
+ 'id3': 'ID3FileType',
+ 'mp3': 'MP3',
+ 'mp4': 'MP4',
+ 'oggflac': 'OggFLAC',
+ 'oggspeex': 'OggSpeex',
+ 'oggtheora': 'OggTheora',
+ 'oggvorbis': 'OggVorbis',
+ 'oggopus': 'OggOpus',
+ 'trueaudio': 'TrueAudio',
+ 'wavpack': 'WavPack',
+ 'monkeysaudio': 'MonkeysAudio',
+ 'optimfrog': 'OptimFROG',
+}
+
+
+class ScrubPlugin(BeetsPlugin):
+ """Removes extraneous metadata from files' tags."""
+ def __init__(self):
+ super().__init__()
+ self.config.add({
+ 'auto': True,
+ })
+
+ if self.config['auto']:
+ self.register_listener("import_task_files", self.import_task_files)
+
+ def commands(self):
+ def scrub_func(lib, opts, args):
+ # Walk through matching files and remove tags.
+ for item in lib.items(ui.decargs(args)):
+ self._log.info('scrubbing: {0}',
+ util.displayable_path(item.path))
+ self._scrub_item(item, opts.write)
+
+ scrub_cmd = ui.Subcommand('scrub', help='clean audio tags')
+ scrub_cmd.parser.add_option(
+ '-W', '--nowrite', dest='write',
+ action='store_false', default=True,
+ help='leave tags empty')
+ scrub_cmd.func = scrub_func
+
+ return [scrub_cmd]
+
+ @staticmethod
+ def _mutagen_classes():
+ """Get a list of file type classes from the Mutagen module.
+ """
+ classes = []
+ for modname, clsname in _MUTAGEN_FORMATS.items():
+ mod = __import__(f'mutagen.{modname}',
+ fromlist=[clsname])
+ classes.append(getattr(mod, clsname))
+ return classes
+
+ def _scrub(self, path):
+ """Remove all tags from a file.
+ """
+ for cls in self._mutagen_classes():
+ # Try opening the file with this type, but just skip in the
+ # event of any error.
+ try:
+ f = cls(util.syspath(path))
+ except Exception:
+ continue
+ if f.tags is None:
+ continue
+
+ # Remove the tag for this type.
+ try:
+ f.delete()
+ except NotImplementedError:
+ # Some Mutagen metadata subclasses (namely, ASFTag) do not
+ # support .delete(), presumably because it is impossible to
+ # remove them. In this case, we just remove all the tags.
+ for tag in f.keys():
+ del f[tag]
+ f.save()
+ except (OSError, mutagen.MutagenError) as exc:
+ self._log.error('could not scrub {0}: {1}',
+ util.displayable_path(path), exc)
+
+ def _scrub_item(self, item, restore=True):
+ """Remove tags from an Item's associated file and, if `restore`
+ is enabled, write the database's tags back to the file.
+ """
+ # Get album art if we need to restore it.
+ if restore:
+ try:
+ mf = mediafile.MediaFile(util.syspath(item.path),
+ config['id3v23'].get(bool))
+ except mediafile.UnreadableFileError as exc:
+ self._log.error('could not open file to scrub: {0}',
+ exc)
+ return
+ images = mf.images
+
+ # Remove all tags.
+ self._scrub(item.path)
+
+ # Restore tags, if enabled.
+ if restore:
+ self._log.debug('writing new tags after scrub')
+ item.try_write()
+ if images:
+ self._log.debug('restoring art')
+ try:
+ mf = mediafile.MediaFile(util.syspath(item.path),
+ config['id3v23'].get(bool))
+ mf.images = images
+ mf.save()
+ except mediafile.UnreadableFileError as exc:
+ self._log.error('could not write tags: {0}', exc)
+
+ def import_task_files(self, session, task):
+ """Automatically scrub imported files."""
+ for item in task.imported_items():
+ self._log.debug('auto-scrubbing {0}',
+ util.displayable_path(item.path))
+ self._scrub_item(item)
diff --git a/lib/beetsplug/smartplaylist.py b/lib/beetsplug/smartplaylist.py
new file mode 100644
index 00000000..4c921ecc
--- /dev/null
+++ b/lib/beetsplug/smartplaylist.py
@@ -0,0 +1,224 @@
+# This file is part of beets.
+# Copyright 2016, Dang Mai <contact@dangmai.net>.
+#
+# 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.
+
+"""Generates smart playlists based on beets queries.
+"""
+
+
+from beets.plugins import BeetsPlugin
+from beets import ui
+from beets.util import (mkdirall, normpath, sanitize_path, syspath,
+ bytestring_path, path_as_posix)
+from beets.library import Item, Album, parse_query_string
+from beets.dbcore import OrQuery
+from beets.dbcore.query import MultipleSort, ParsingError
+import os
+
+try:
+ from urllib.request import pathname2url
+except ImportError:
+ # python2 is a bit different
+ from urllib import pathname2url
+
+
+class SmartPlaylistPlugin(BeetsPlugin):
+
+ def __init__(self):
+ super().__init__()
+ self.config.add({
+ 'relative_to': None,
+ 'playlist_dir': '.',
+ 'auto': True,
+ 'playlists': [],
+ 'forward_slash': False,
+ 'prefix': '',
+ 'urlencode': False,
+ })
+
+ self.config['prefix'].redact = True # May contain username/password.
+ self._matched_playlists = None
+ self._unmatched_playlists = None
+
+ if self.config['auto']:
+ self.register_listener('database_change', self.db_change)
+
+ def commands(self):
+ spl_update = ui.Subcommand(
+ 'splupdate',
+ help='update the smart playlists. Playlist names may be '
+ 'passed as arguments.'
+ )
+ spl_update.func = self.update_cmd
+ return [spl_update]
+
+ def update_cmd(self, lib, opts, args):
+ self.build_queries()
+ if args:
+ args = set(ui.decargs(args))
+ for a in list(args):
+ if not a.endswith(".m3u"):
+ args.add(f"{a}.m3u")
+
+ playlists = {(name, q, a_q)
+ for name, q, a_q in self._unmatched_playlists
+ if name in args}
+ if not playlists:
+ raise ui.UserError(
+ 'No playlist matching any of {} found'.format(
+ [name for name, _, _ in self._unmatched_playlists])
+ )
+
+ self._matched_playlists = playlists
+ self._unmatched_playlists -= playlists
+ else:
+ self._matched_playlists = self._unmatched_playlists
+
+ self.update_playlists(lib)
+
+ def build_queries(self):
+ """
+ Instantiate queries for the playlists.
+
+ Each playlist has 2 queries: one or items one for albums, each with a
+ sort. We must also remember its name. _unmatched_playlists is a set of
+ tuples (name, (q, q_sort), (album_q, album_q_sort)).
+
+ sort may be any sort, or NullSort, or None. None and NullSort are
+ equivalent and both eval to False.
+ More precisely
+ - it will be NullSort when a playlist query ('query' or 'album_query')
+ is a single item or a list with 1 element
+ - it will be None when there are multiple items i a query
+ """
+ self._unmatched_playlists = set()
+ self._matched_playlists = set()
+
+ for playlist in self.config['playlists'].get(list):
+ if 'name' not in playlist:
+ self._log.warning("playlist configuration is missing name")
+ continue
+
+ playlist_data = (playlist['name'],)
+ try:
+ for key, model_cls in (('query', Item),
+ ('album_query', Album)):
+ qs = playlist.get(key)
+ if qs is None:
+ query_and_sort = None, None
+ elif isinstance(qs, str):
+ query_and_sort = parse_query_string(qs, model_cls)
+ elif len(qs) == 1:
+ query_and_sort = parse_query_string(qs[0], model_cls)
+ else:
+ # multiple queries and sorts
+ queries, sorts = zip(*(parse_query_string(q, model_cls)
+ for q in qs))
+ query = OrQuery(queries)
+ final_sorts = []
+ for s in sorts:
+ if s:
+ if isinstance(s, MultipleSort):
+ final_sorts += s.sorts
+ else:
+ final_sorts.append(s)
+ if not final_sorts:
+ sort = None
+ elif len(final_sorts) == 1:
+ sort, = final_sorts
+ else:
+ sort = MultipleSort(final_sorts)
+ query_and_sort = query, sort
+
+ playlist_data += (query_and_sort,)
+
+ except ParsingError as exc:
+ self._log.warning("invalid query in playlist {}: {}",
+ playlist['name'], exc)
+ continue
+
+ self._unmatched_playlists.add(playlist_data)
+
+ def matches(self, model, query, album_query):
+ if album_query and isinstance(model, Album):
+ return album_query.match(model)
+ if query and isinstance(model, Item):
+ return query.match(model)
+ return False
+
+ def db_change(self, lib, model):
+ if self._unmatched_playlists is None:
+ self.build_queries()
+
+ for playlist in self._unmatched_playlists:
+ n, (q, _), (a_q, _) = playlist
+ if self.matches(model, q, a_q):
+ self._log.debug(
+ "{0} will be updated because of {1}", n, model)
+ self._matched_playlists.add(playlist)
+ self.register_listener('cli_exit', self.update_playlists)
+
+ self._unmatched_playlists -= self._matched_playlists
+
+ def update_playlists(self, lib):
+ self._log.info("Updating {0} smart playlists...",
+ len(self._matched_playlists))
+
+ playlist_dir = self.config['playlist_dir'].as_filename()
+ playlist_dir = bytestring_path(playlist_dir)
+ relative_to = self.config['relative_to'].get()
+ if relative_to:
+ relative_to = normpath(relative_to)
+
+ # Maps playlist filenames to lists of track filenames.
+ m3us = {}
+
+ for playlist in self._matched_playlists:
+ name, (query, q_sort), (album_query, a_q_sort) = playlist
+ self._log.debug("Creating playlist {0}", name)
+ items = []
+
+ if query:
+ items.extend(lib.items(query, q_sort))
+ if album_query:
+ for album in lib.albums(album_query, a_q_sort):
+ items.extend(album.items())
+
+ # As we allow tags in the m3u names, we'll need to iterate through
+ # the items and generate the correct m3u file names.
+ for item in items:
+ m3u_name = item.evaluate_template(name, True)
+ m3u_name = sanitize_path(m3u_name, lib.replacements)
+ if m3u_name not in m3us:
+ m3us[m3u_name] = []
+ item_path = item.path
+ if relative_to:
+ item_path = os.path.relpath(item.path, relative_to)
+ if item_path not in m3us[m3u_name]:
+ m3us[m3u_name].append(item_path)
+
+ prefix = bytestring_path(self.config['prefix'].as_str())
+ # Write all of the accumulated track lists to files.
+ for m3u in m3us:
+ m3u_path = normpath(os.path.join(playlist_dir,
+ bytestring_path(m3u)))
+ mkdirall(m3u_path)
+ with open(syspath(m3u_path), 'wb') as f:
+ for path in m3us[m3u]:
+ if self.config['forward_slash'].get():
+ path = path_as_posix(path)
+ if self.config['urlencode']:
+ path = bytestring_path(pathname2url(path))
+ f.write(prefix + path + b'\n')
+
+ self._log.info("{0} playlists updated", len(self._matched_playlists))
diff --git a/lib/beetsplug/sonosupdate.py b/lib/beetsplug/sonosupdate.py
new file mode 100644
index 00000000..aeb211d8
--- /dev/null
+++ b/lib/beetsplug/sonosupdate.py
@@ -0,0 +1,46 @@
+# This file is part of beets.
+# Copyright 2018, Tobias Sauerwein.
+#
+# 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.
+
+"""Updates a Sonos library whenever the beets library is changed.
+This is based on the Kodi Update plugin.
+"""
+
+from beets.plugins import BeetsPlugin
+import soco
+
+
+class SonosUpdate(BeetsPlugin):
+ def __init__(self):
+ super().__init__()
+ 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"""
+ self.register_listener('cli_exit', self.update)
+
+ def update(self, lib):
+ """When the client exists try to send refresh request to a Sonos
+ controler.
+ """
+ self._log.info('Requesting a Sonos library update...')
+
+ device = soco.discovery.any_soco()
+
+ if device:
+ device.music_library.start_library_update()
+ else:
+ self._log.warning('Could not find a Sonos device.')
+ return
+
+ self._log.info('Sonos update triggered')
diff --git a/lib/beetsplug/spotify.py b/lib/beetsplug/spotify.py
new file mode 100644
index 00000000..2529160d
--- /dev/null
+++ b/lib/beetsplug/spotify.py
@@ -0,0 +1,527 @@
+# This file is part of beets.
+# Copyright 2019, Rahul Ahuja.
+#
+# 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.
+
+"""Adds Spotify release and track search support to the autotagger, along with
+Spotify playlist construction.
+"""
+
+import re
+import json
+import base64
+import webbrowser
+import collections
+
+import unidecode
+import requests
+import confuse
+
+from beets import ui
+from beets.autotag.hooks import AlbumInfo, TrackInfo
+from beets.plugins import MetadataSourcePlugin, BeetsPlugin
+
+
+class SpotifyPlugin(MetadataSourcePlugin, BeetsPlugin):
+ data_source = 'Spotify'
+
+ # Base URLs for the Spotify API
+ # Documentation: https://developer.spotify.com/web-api
+ oauth_token_url = 'https://accounts.spotify.com/api/token'
+ open_track_url = 'https://open.spotify.com/track/'
+ search_url = 'https://api.spotify.com/v1/search'
+ album_url = 'https://api.spotify.com/v1/albums/'
+ track_url = 'https://api.spotify.com/v1/tracks/'
+
+ # Spotify IDs consist of 22 alphanumeric characters
+ # (zero-left-padded base62 representation of randomly generated UUID4)
+ id_regex = {
+ 'pattern': r'(^|open\.spotify\.com/{}/)([0-9A-Za-z]{{22}})',
+ 'match_group': 2,
+ }
+
+ def __init__(self):
+ super().__init__()
+ self.config.add(
+ {
+ 'mode': 'list',
+ 'tiebreak': 'popularity',
+ 'show_failures': False,
+ 'artist_field': 'albumartist',
+ 'album_field': 'album',
+ 'track_field': 'title',
+ 'region_filter': None,
+ 'regex': [],
+ 'client_id': '4e414367a1d14c75a5c5129a627fcab8',
+ 'client_secret': 'f82bdc09b2254f1a8286815d02fd46dc',
+ 'tokenfile': 'spotify_token.json',
+ }
+ )
+ self.config['client_secret'].redact = True
+
+ self.tokenfile = self.config['tokenfile'].get(
+ confuse.Filename(in_app_dir=True)
+ ) # Path to the JSON file for storing the OAuth access token.
+ self.setup()
+
+ def setup(self):
+ """Retrieve previously saved OAuth token or generate a new one."""
+ try:
+ with open(self.tokenfile) as f:
+ token_data = json.load(f)
+ except OSError:
+ self._authenticate()
+ else:
+ self.access_token = token_data['access_token']
+
+ def _authenticate(self):
+ """Request an access token via the Client Credentials Flow:
+ https://developer.spotify.com/documentation/general/guides/authorization-guide/#client-credentials-flow
+ """
+ headers = {
+ 'Authorization': 'Basic {}'.format(
+ base64.b64encode(
+ ':'.join(
+ self.config[k].as_str()
+ for k in ('client_id', 'client_secret')
+ ).encode()
+ ).decode()
+ )
+ }
+ response = requests.post(
+ self.oauth_token_url,
+ data={'grant_type': 'client_credentials'},
+ headers=headers,
+ )
+ try:
+ response.raise_for_status()
+ except requests.exceptions.HTTPError as e:
+ raise ui.UserError(
+ 'Spotify authorization failed: {}\n{}'.format(
+ e, response.text
+ )
+ )
+ self.access_token = response.json()['access_token']
+
+ # Save the token for later use.
+ self._log.debug(
+ '{} access token: {}', self.data_source, self.access_token
+ )
+ with open(self.tokenfile, 'w') as f:
+ json.dump({'access_token': self.access_token}, f)
+
+ def _handle_response(self, request_type, url, params=None):
+ """Send a request, reauthenticating if necessary.
+
+ :param request_type: Type of :class:`Request` constructor,
+ e.g. ``requests.get``, ``requests.post``, etc.
+ :type request_type: function
+ :param url: URL for the new :class:`Request` object.
+ :type url: str
+ :param params: (optional) list of tuples or bytes to send
+ in the query string for the :class:`Request`.
+ :type params: dict
+ :return: JSON data for the class:`Response <Response>` object.
+ :rtype: dict
+ """
+ response = request_type(
+ url,
+ headers={'Authorization': f'Bearer {self.access_token}'},
+ params=params,
+ )
+ if response.status_code != 200:
+ if 'token expired' in response.text:
+ self._log.debug(
+ '{} access token has expired. Reauthenticating.',
+ self.data_source,
+ )
+ self._authenticate()
+ return self._handle_response(request_type, url, params=params)
+ else:
+ raise ui.UserError(
+ '{} API error:\n{}\nURL:\n{}\nparams:\n{}'.format(
+ self.data_source, response.text, url, params
+ )
+ )
+ return response.json()
+
+ def album_for_id(self, album_id):
+ """Fetch an album by its Spotify ID or URL and return an
+ AlbumInfo object or None if the album is not found.
+
+ :param album_id: Spotify ID or URL for the album
+ :type album_id: str
+ :return: AlbumInfo object for album
+ :rtype: beets.autotag.hooks.AlbumInfo or None
+ """
+ spotify_id = self._get_id('album', album_id)
+ if spotify_id is None:
+ return None
+
+ album_data = self._handle_response(
+ requests.get, self.album_url + spotify_id
+ )
+ artist, artist_id = self.get_artist(album_data['artists'])
+
+ date_parts = [
+ int(part) for part in album_data['release_date'].split('-')
+ ]
+
+ release_date_precision = album_data['release_date_precision']
+ if release_date_precision == 'day':
+ year, month, day = date_parts
+ elif release_date_precision == 'month':
+ year, month = date_parts
+ day = None
+ elif release_date_precision == 'year':
+ year = date_parts[0]
+ month = None
+ day = None
+ else:
+ raise ui.UserError(
+ "Invalid `release_date_precision` returned "
+ "by {} API: '{}'".format(
+ self.data_source, release_date_precision
+ )
+ )
+
+ tracks = []
+ medium_totals = collections.defaultdict(int)
+ for i, track_data in enumerate(album_data['tracks']['items'], start=1):
+ track = self._get_track(track_data)
+ track.index = i
+ medium_totals[track.medium] += 1
+ tracks.append(track)
+ for track in tracks:
+ track.medium_total = medium_totals[track.medium]
+
+ return AlbumInfo(
+ album=album_data['name'],
+ album_id=spotify_id,
+ artist=artist,
+ artist_id=artist_id,
+ tracks=tracks,
+ albumtype=album_data['album_type'],
+ va=len(album_data['artists']) == 1
+ and artist.lower() == 'various artists',
+ year=year,
+ month=month,
+ day=day,
+ label=album_data['label'],
+ mediums=max(medium_totals.keys()),
+ data_source=self.data_source,
+ data_url=album_data['external_urls']['spotify'],
+ )
+
+ def _get_track(self, track_data):
+ """Convert a Spotify track object dict to a TrackInfo object.
+
+ :param track_data: Simplified track object
+ (https://developer.spotify.com/documentation/web-api/reference/object-model/#track-object-simplified)
+ :type track_data: dict
+ :return: TrackInfo object for track
+ :rtype: beets.autotag.hooks.TrackInfo
+ """
+ artist, artist_id = self.get_artist(track_data['artists'])
+ return TrackInfo(
+ title=track_data['name'],
+ track_id=track_data['id'],
+ artist=artist,
+ artist_id=artist_id,
+ length=track_data['duration_ms'] / 1000,
+ index=track_data['track_number'],
+ medium=track_data['disc_number'],
+ medium_index=track_data['track_number'],
+ data_source=self.data_source,
+ data_url=track_data['external_urls']['spotify'],
+ )
+
+ def track_for_id(self, track_id=None, track_data=None):
+ """Fetch a track by its Spotify ID or URL and return a
+ TrackInfo object or None if the track is not found.
+
+ :param track_id: (Optional) Spotify ID or URL for the track. Either
+ ``track_id`` or ``track_data`` must be provided.
+ :type track_id: str
+ :param track_data: (Optional) Simplified track object dict. May be
+ provided instead of ``track_id`` to avoid unnecessary API calls.
+ :type track_data: dict
+ :return: TrackInfo object for track
+ :rtype: beets.autotag.hooks.TrackInfo or None
+ """
+ if track_data is None:
+ spotify_id = self._get_id('track', track_id)
+ if spotify_id is None:
+ return None
+ track_data = self._handle_response(
+ requests.get, self.track_url + spotify_id
+ )
+ track = self._get_track(track_data)
+
+ # Get album's tracks to set `track.index` (position on the entire
+ # release) and `track.medium_total` (total number of tracks on
+ # the track's disc).
+ album_data = self._handle_response(
+ requests.get, self.album_url + track_data['album']['id']
+ )
+ medium_total = 0
+ for i, track_data in enumerate(album_data['tracks']['items'], start=1):
+ if track_data['disc_number'] == track.medium:
+ medium_total += 1
+ if track_data['id'] == track.track_id:
+ track.index = i
+ track.medium_total = medium_total
+ return track
+
+ @staticmethod
+ def _construct_search_query(filters=None, keywords=''):
+ """Construct a query string with the specified filters and keywords to
+ be provided to the Spotify Search API
+ (https://developer.spotify.com/documentation/web-api/reference/search/search/#writing-a-query---guidelines).
+
+ :param filters: (Optional) Field filters to apply.
+ :type filters: dict
+ :param keywords: (Optional) Query keywords to use.
+ :type keywords: str
+ :return: Query string to be provided to the Search API.
+ :rtype: str
+ """
+ query_components = [
+ keywords,
+ ' '.join(':'.join((k, v)) for k, v in filters.items()),
+ ]
+ query = ' '.join([q for q in query_components if q])
+ if not isinstance(query, str):
+ query = query.decode('utf8')
+ return unidecode.unidecode(query)
+
+ def _search_api(self, query_type, filters=None, keywords=''):
+ """Query the Spotify Search API for the specified ``keywords``, applying
+ the provided ``filters``.
+
+ :param query_type: Item type to search across. Valid types are:
+ 'album', 'artist', 'playlist', and 'track'.
+ :type query_type: str
+ :param filters: (Optional) Field filters to apply.
+ :type filters: dict
+ :param keywords: (Optional) Query keywords to use.
+ :type keywords: str
+ :return: JSON data for the class:`Response <Response>` object or None
+ if no search results are returned.
+ :rtype: dict or None
+ """
+ query = self._construct_search_query(
+ keywords=keywords, filters=filters
+ )
+ if not query:
+ return None
+ self._log.debug(
+ f"Searching {self.data_source} for '{query}'"
+ )
+ response_data = (
+ self._handle_response(
+ requests.get,
+ self.search_url,
+ params={'q': query, 'type': query_type},
+ )
+ .get(query_type + 's', {})
+ .get('items', [])
+ )
+ self._log.debug(
+ "Found {} result(s) from {} for '{}'",
+ len(response_data),
+ self.data_source,
+ query,
+ )
+ return response_data
+
+ def commands(self):
+ def queries(lib, opts, args):
+ success = self._parse_opts(opts)
+ if success:
+ results = self._match_library_tracks(lib, ui.decargs(args))
+ self._output_match_results(results)
+
+ spotify_cmd = ui.Subcommand(
+ 'spotify', help=f'build a {self.data_source} playlist'
+ )
+ spotify_cmd.parser.add_option(
+ '-m',
+ '--mode',
+ action='store',
+ help='"open" to open {} with playlist, '
+ '"list" to print (default)'.format(self.data_source),
+ )
+ spotify_cmd.parser.add_option(
+ '-f',
+ '--show-failures',
+ action='store_true',
+ dest='show_failures',
+ help='list tracks that did not match a {} ID'.format(
+ self.data_source
+ ),
+ )
+ spotify_cmd.func = queries
+ return [spotify_cmd]
+
+ def _parse_opts(self, opts):
+ if opts.mode:
+ self.config['mode'].set(opts.mode)
+
+ if opts.show_failures:
+ self.config['show_failures'].set(True)
+
+ if self.config['mode'].get() not in ['list', 'open']:
+ self._log.warning(
+ '{0} is not a valid mode', self.config['mode'].get()
+ )
+ return False
+
+ self.opts = opts
+ return True
+
+ def _match_library_tracks(self, library, keywords):
+ """Get a list of simplified track object dicts for library tracks
+ matching the specified ``keywords``.
+
+ :param library: beets library object to query.
+ :type library: beets.library.Library
+ :param keywords: Query to match library items against.
+ :type keywords: str
+ :return: List of simplified track object dicts for library items
+ matching the specified query.
+ :rtype: list[dict]
+ """
+ results = []
+ failures = []
+
+ items = library.items(keywords)
+
+ if not items:
+ self._log.debug(
+ 'Your beets query returned no items, skipping {}.',
+ self.data_source,
+ )
+ return
+
+ self._log.info('Processing {} tracks...', len(items))
+
+ for item in items:
+ # Apply regex transformations if provided
+ for regex in self.config['regex'].get():
+ if (
+ not regex['field']
+ or not regex['search']
+ or not regex['replace']
+ ):
+ continue
+
+ value = item[regex['field']]
+ item[regex['field']] = re.sub(
+ regex['search'], regex['replace'], value
+ )
+
+ # Custom values can be passed in the config (just in case)
+ artist = item[self.config['artist_field'].get()]
+ album = item[self.config['album_field'].get()]
+ keywords = item[self.config['track_field'].get()]
+
+ # Query the Web API for each track, look for the items' JSON data
+ query_filters = {'artist': artist, 'album': album}
+ response_data_tracks = self._search_api(
+ query_type='track', keywords=keywords, filters=query_filters
+ )
+ if not response_data_tracks:
+ query = self._construct_search_query(
+ keywords=keywords, filters=query_filters
+ )
+ failures.append(query)
+ continue
+
+ # Apply market filter if requested
+ region_filter = self.config['region_filter'].get()
+ if region_filter:
+ response_data_tracks = [
+ track_data
+ for track_data in response_data_tracks
+ if region_filter in track_data['available_markets']
+ ]
+
+ if (
+ len(response_data_tracks) == 1
+ or self.config['tiebreak'].get() == 'first'
+ ):
+ self._log.debug(
+ '{} track(s) found, count: {}',
+ self.data_source,
+ len(response_data_tracks),
+ )
+ chosen_result = response_data_tracks[0]
+ else:
+ # Use the popularity filter
+ self._log.debug(
+ 'Most popular track chosen, count: {}',
+ len(response_data_tracks),
+ )
+ chosen_result = max(
+ response_data_tracks, key=lambda x: x['popularity']
+ )
+ results.append(chosen_result)
+
+ failure_count = len(failures)
+ if failure_count > 0:
+ if self.config['show_failures'].get():
+ self._log.info(
+ '{} track(s) did not match a {} ID:',
+ failure_count,
+ self.data_source,
+ )
+ for track in failures:
+ self._log.info('track: {}', track)
+ self._log.info('')
+ else:
+ self._log.warning(
+ '{} track(s) did not match a {} ID:\n'
+ 'use --show-failures to display',
+ failure_count,
+ self.data_source,
+ )
+
+ return results
+
+ def _output_match_results(self, results):
+ """Open a playlist or print Spotify URLs for the provided track
+ object dicts.
+
+ :param results: List of simplified track object dicts
+ (https://developer.spotify.com/documentation/web-api/reference/object-model/#track-object-simplified)
+ :type results: list[dict]
+ """
+ if results:
+ spotify_ids = [track_data['id'] for track_data in results]
+ if self.config['mode'].get() == 'open':
+ self._log.info(
+ 'Attempting to open {} with playlist'.format(
+ self.data_source
+ )
+ )
+ spotify_url = 'spotify:trackset:Playlist:' + ','.join(
+ spotify_ids
+ )
+ webbrowser.open(spotify_url)
+ else:
+ for spotify_id in spotify_ids:
+ print(self.open_track_url + spotify_id)
+ else:
+ self._log.warning(
+ f'No {self.data_source} tracks found from beets query'
+ )
diff --git a/lib/beetsplug/subsonicplaylist.py b/lib/beetsplug/subsonicplaylist.py
new file mode 100644
index 00000000..ead78919
--- /dev/null
+++ b/lib/beetsplug/subsonicplaylist.py
@@ -0,0 +1,171 @@
+# This file is part of beets.
+# Copyright 2019, Joris Jensen
+#
+# 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.
+
+
+import random
+import string
+from xml.etree import ElementTree
+from hashlib import md5
+from urllib.parse import urlencode
+
+import requests
+
+from beets.dbcore import AndQuery
+from beets.dbcore.query import MatchQuery
+from beets.plugins import BeetsPlugin
+from beets.ui import Subcommand
+
+__author__ = 'https://github.com/MrNuggelz'
+
+
+def filter_to_be_removed(items, keys):
+ if len(items) > len(keys):
+ dont_remove = []
+ for artist, album, title in keys:
+ for item in items:
+ if artist == item['artist'] and \
+ album == item['album'] and \
+ title == item['title']:
+ dont_remove.append(item)
+ return [item for item in items if item not in dont_remove]
+ else:
+ def to_be_removed(item):
+ for artist, album, title in keys:
+ if artist == item['artist'] and\
+ album == item['album'] and\
+ title == item['title']:
+ return False
+ return True
+
+ return [item for item in items if to_be_removed(item)]
+
+
+class SubsonicPlaylistPlugin(BeetsPlugin):
+
+ def __init__(self):
+ super().__init__()
+ self.config.add(
+ {
+ 'delete': False,
+ 'playlist_ids': [],
+ 'playlist_names': [],
+ 'username': '',
+ 'password': ''
+ }
+ )
+ self.config['password'].redact = True
+
+ def update_tags(self, playlist_dict, lib):
+ with lib.transaction():
+ for query, playlist_tag in playlist_dict.items():
+ query = AndQuery([MatchQuery("artist", query[0]),
+ MatchQuery("album", query[1]),
+ MatchQuery("title", query[2])])
+ items = lib.items(query)
+ if not items:
+ self._log.warn("{} | track not found ({})", playlist_tag,
+ query)
+ continue
+ for item in items:
+ item.subsonic_playlist = playlist_tag
+ item.try_sync(write=True, move=False)
+
+ def get_playlist(self, playlist_id):
+ xml = self.send('getPlaylist', {'id': playlist_id}).text
+ playlist = ElementTree.fromstring(xml)[0]
+ if playlist.attrib.get('code', '200') != '200':
+ alt_error = 'error getting playlist, but no error message found'
+ self._log.warn(playlist.attrib.get('message', alt_error))
+ return
+
+ name = playlist.attrib.get('name', 'undefined')
+ tracks = [(t.attrib['artist'], t.attrib['album'], t.attrib['title'])
+ for t in playlist]
+ return name, tracks
+
+ def commands(self):
+ def build_playlist(lib, opts, args):
+ self.config.set_args(opts)
+ ids = self.config['playlist_ids'].as_str_seq()
+ if self.config['playlist_names'].as_str_seq():
+ playlists = ElementTree.fromstring(
+ self.send('getPlaylists').text)[0]
+ if playlists.attrib.get('code', '200') != '200':
+ alt_error = 'error getting playlists,' \
+ ' but no error message found'
+ self._log.warn(
+ playlists.attrib.get('message', alt_error))
+ return
+ for name in self.config['playlist_names'].as_str_seq():
+ for playlist in playlists:
+ if name == playlist.attrib['name']:
+ ids.append(playlist.attrib['id'])
+
+ playlist_dict = self.get_playlists(ids)
+
+ # delete old tags
+ if self.config['delete']:
+ existing = list(lib.items('subsonic_playlist:";"'))
+ to_be_removed = filter_to_be_removed(
+ existing,
+ playlist_dict.keys())
+ for item in to_be_removed:
+ item['subsonic_playlist'] = ''
+ with lib.transaction():
+ item.try_sync(write=True, move=False)
+
+ self.update_tags(playlist_dict, lib)
+
+ subsonicplaylist_cmds = Subcommand(
+ 'subsonicplaylist', help='import a subsonic playlist'
+ )
+ subsonicplaylist_cmds.parser.add_option(
+ '-d',
+ '--delete',
+ action='store_true',
+ help='delete tag from items not in any playlist anymore',
+ )
+ subsonicplaylist_cmds.func = build_playlist
+ return [subsonicplaylist_cmds]
+
+ def generate_token(self):
+ salt = ''.join(random.choices(string.ascii_lowercase + string.digits))
+ return md5(
+ (self.config['password'].get() + salt).encode()).hexdigest(), salt
+
+ def send(self, endpoint, params=None):
+ if params is None:
+ params = {}
+ a, b = self.generate_token()
+ params['u'] = self.config['username']
+ params['t'] = a
+ params['s'] = b
+ params['v'] = '1.12.0'
+ params['c'] = 'beets'
+ resp = requests.get('{}/rest/{}?{}'.format(
+ self.config['base_url'].get(),
+ endpoint,
+ urlencode(params))
+ )
+ return resp
+
+ def get_playlists(self, ids):
+ output = {}
+ for playlist_id in ids:
+ name, tracks = self.get_playlist(playlist_id)
+ for track in tracks:
+ if track not in output:
+ output[track] = ';'
+ output[track] += name + ';'
+ return output
diff --git a/lib/beetsplug/subsonicupdate.py b/lib/beetsplug/subsonicupdate.py
new file mode 100644
index 00000000..9480bcb4
--- /dev/null
+++ b/lib/beetsplug/subsonicupdate.py
@@ -0,0 +1,144 @@
+# This file is part of beets.
+# Copyright 2016, Adrian Sampson.
+#
+# 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.
+
+"""Updates Subsonic library on Beets import
+Your Beets configuration file should contain
+a "subsonic" section like the following:
+ subsonic:
+ url: https://mydomain.com:443/subsonic
+ user: username
+ pass: password
+ auth: token
+For older Subsonic versions, token authentication
+is not supported, use password instead:
+ subsonic:
+ url: https://mydomain.com:443/subsonic
+ user: username
+ pass: password
+ auth: pass
+"""
+
+import hashlib
+import random
+import string
+
+import requests
+
+from binascii import hexlify
+from beets import config
+from beets.plugins import BeetsPlugin
+
+__author__ = 'https://github.com/maffo999'
+
+
+class SubsonicUpdate(BeetsPlugin):
+ def __init__(self):
+ super().__init__()
+ # Set default configuration values
+ config['subsonic'].add({
+ 'user': 'admin',
+ 'pass': 'admin',
+ 'url': 'http://localhost:4040',
+ 'auth': 'token',
+ })
+ config['subsonic']['pass'].redact = True
+ self.register_listener('import', self.start_scan)
+
+ @staticmethod
+ def __create_token():
+ """Create salt and token from given password.
+
+ :return: The generated salt and hashed token
+ """
+ password = config['subsonic']['pass'].as_str()
+
+ # Pick the random sequence and salt the password
+ r = string.ascii_letters + string.digits
+ salt = "".join([random.choice(r) for _ in range(6)])
+ salted_password = password + salt
+ token = hashlib.md5(salted_password.encode('utf-8')).hexdigest()
+
+ # Put together the payload of the request to the server and the URL
+ return salt, token
+
+ @staticmethod
+ def __format_url(endpoint):
+ """Get the Subsonic URL to trigger the given endpoint.
+ Uses either the url config option or the deprecated host, port,
+ and context_path config options together.
+
+ :return: Endpoint for updating Subsonic
+ """
+
+ url = config['subsonic']['url'].as_str()
+ if url and url.endswith('/'):
+ url = url[:-1]
+
+ # @deprecated("Use url config option instead")
+ if not url:
+ host = config['subsonic']['host'].as_str()
+ port = config['subsonic']['port'].get(int)
+ context_path = config['subsonic']['contextpath'].as_str()
+ if context_path == '/':
+ context_path = ''
+ url = f"http://{host}:{port}{context_path}"
+
+ return url + f'/rest/{endpoint}'
+
+ def start_scan(self):
+ user = config['subsonic']['user'].as_str()
+ auth = config['subsonic']['auth'].as_str()
+ url = self.__format_url("startScan")
+ self._log.debug('URL is {0}', url)
+ self._log.debug('auth type is {0}', config['subsonic']['auth'])
+
+ if auth == "token":
+ salt, token = self.__create_token()
+ payload = {
+ 'u': user,
+ 't': token,
+ 's': salt,
+ 'v': '1.13.0', # Subsonic 5.3 and newer
+ 'c': 'beets',
+ 'f': 'json'
+ }
+ elif auth == "password":
+ password = config['subsonic']['pass'].as_str()
+ encpass = hexlify(password.encode()).decode()
+ payload = {
+ 'u': user,
+ 'p': f'enc:{encpass}',
+ 'v': '1.12.0',
+ 'c': 'beets',
+ 'f': 'json'
+ }
+ else:
+ return
+ try:
+ response = requests.get(url, params=payload)
+ json = response.json()
+
+ if response.status_code == 200 and \
+ json['subsonic-response']['status'] == "ok":
+ count = json['subsonic-response']['scanStatus']['count']
+ self._log.info(
+ f'Updating Subsonic; scanning {count} tracks')
+ elif response.status_code == 200 and \
+ json['subsonic-response']['status'] == "failed":
+ error_message = json['subsonic-response']['error']['message']
+ self._log.error(f'Error: {error_message}')
+ else:
+ self._log.error('Error: {0}', json)
+ except Exception as error:
+ self._log.error(f'Error: {error}')
diff --git a/lib/beetsplug/the.py b/lib/beetsplug/the.py
new file mode 100644
index 00000000..e6626d2b
--- /dev/null
+++ b/lib/beetsplug/the.py
@@ -0,0 +1,98 @@
+# This file is part of beets.
+# Copyright 2016, Blemjhoo Tezoulbr <baobab@heresiarch.info>.
+#
+# 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.
+
+"""Moves patterns in path formats (suitable for moving articles)."""
+
+
+import re
+from beets.plugins import BeetsPlugin
+
+__author__ = 'baobab@heresiarch.info'
+__version__ = '1.1'
+
+PATTERN_THE = '^the\\s'
+PATTERN_A = '^[a][n]?\\s'
+FORMAT = '{0}, {1}'
+
+
+class ThePlugin(BeetsPlugin):
+
+ patterns = []
+
+ def __init__(self):
+ super().__init__()
+
+ self.template_funcs['the'] = self.the_template_func
+
+ self.config.add({
+ 'the': True,
+ 'a': True,
+ 'format': '{0}, {1}',
+ 'strip': False,
+ 'patterns': [],
+ })
+
+ self.patterns = self.config['patterns'].as_str_seq()
+ for p in self.patterns:
+ if p:
+ try:
+ re.compile(p)
+ except re.error:
+ self._log.error('invalid pattern: {0}', p)
+ else:
+ if not (p.startswith('^') or p.endswith('$')):
+ self._log.warning('warning: \"{0}\" will not '
+ 'match string start/end', p)
+ if self.config['a']:
+ self.patterns = [PATTERN_A] + self.patterns
+ if self.config['the']:
+ self.patterns = [PATTERN_THE] + self.patterns
+ if not self.patterns:
+ self._log.warning('no patterns defined!')
+
+ def unthe(self, text, pattern):
+ """Moves pattern in the path format string or strips it
+
+ text -- text to handle
+ pattern -- regexp pattern (case ignore is already on)
+ strip -- if True, pattern will be removed
+ """
+ if text:
+ r = re.compile(pattern, flags=re.IGNORECASE)
+ try:
+ t = r.findall(text)[0]
+ except IndexError:
+ return text
+ else:
+ r = re.sub(r, '', text).strip()
+ if self.config['strip']:
+ return r
+ else:
+ fmt = self.config['format'].as_str()
+ return fmt.format(r, t.strip()).strip()
+ else:
+ return ''
+
+ def the_template_func(self, text):
+ if not self.patterns:
+ return text
+ if text:
+ for p in self.patterns:
+ r = self.unthe(text, p)
+ if r != text:
+ self._log.debug('\"{0}\" -> \"{1}\"', text, r)
+ break
+ return r
+ else:
+ return ''
diff --git a/lib/beetsplug/thumbnails.py b/lib/beetsplug/thumbnails.py
new file mode 100644
index 00000000..6bd9cbac
--- /dev/null
+++ b/lib/beetsplug/thumbnails.py
@@ -0,0 +1,291 @@
+# This file is part of beets.
+# Copyright 2016, Bruno Cauet
+#
+# 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.
+
+"""Create freedesktop.org-compliant thumbnails for album folders
+
+This plugin is POSIX-only.
+Spec: standards.freedesktop.org/thumbnail-spec/latest/index.html
+"""
+
+
+from hashlib import md5
+import os
+import shutil
+from itertools import chain
+from pathlib import PurePosixPath
+import ctypes
+import ctypes.util
+
+from xdg import BaseDirectory
+
+from beets.plugins import BeetsPlugin
+from beets.ui import Subcommand, decargs
+from beets import util
+from beets.util.artresizer import ArtResizer, get_im_version, get_pil_version
+
+
+BASE_DIR = os.path.join(BaseDirectory.xdg_cache_home, "thumbnails")
+NORMAL_DIR = util.bytestring_path(os.path.join(BASE_DIR, "normal"))
+LARGE_DIR = util.bytestring_path(os.path.join(BASE_DIR, "large"))
+
+
+class ThumbnailsPlugin(BeetsPlugin):
+ def __init__(self):
+ super().__init__()
+ self.config.add({
+ 'auto': True,
+ 'force': False,
+ 'dolphin': False,
+ })
+
+ self.write_metadata = None
+ if self.config['auto'] and self._check_local_ok():
+ self.register_listener('art_set', self.process_album)
+
+ def commands(self):
+ thumbnails_command = Subcommand("thumbnails",
+ help="Create album thumbnails")
+ thumbnails_command.parser.add_option(
+ '-f', '--force',
+ dest='force', action='store_true', default=False,
+ help='force regeneration of thumbnails deemed fine (existing & '
+ 'recent enough)')
+ thumbnails_command.parser.add_option(
+ '--dolphin', dest='dolphin', action='store_true', default=False,
+ help="create Dolphin-compatible thumbnail information (for KDE)")
+ thumbnails_command.func = self.process_query
+
+ return [thumbnails_command]
+
+ def process_query(self, lib, opts, args):
+ self.config.set_args(opts)
+ if self._check_local_ok():
+ for album in lib.albums(decargs(args)):
+ self.process_album(album)
+
+ def _check_local_ok(self):
+ """Check that's everythings ready:
+ - local capability to resize images
+ - thumbnail dirs exist (create them if needed)
+ - detect whether we'll use PIL or IM
+ - detect whether we'll use GIO or Python to get URIs
+ """
+ if not ArtResizer.shared.local:
+ self._log.warning("No local image resizing capabilities, "
+ "cannot generate thumbnails")
+ return False
+
+ for dir in (NORMAL_DIR, LARGE_DIR):
+ if not os.path.exists(dir):
+ os.makedirs(dir)
+
+ if get_im_version():
+ self.write_metadata = write_metadata_im
+ tool = "IM"
+ else:
+ assert get_pil_version() # since we're local
+ self.write_metadata = write_metadata_pil
+ tool = "PIL"
+ self._log.debug("using {0} to write metadata", tool)
+
+ uri_getter = GioURI()
+ if not uri_getter.available:
+ uri_getter = PathlibURI()
+ self._log.debug("using {0.name} to compute URIs", uri_getter)
+ self.get_uri = uri_getter.uri
+
+ return True
+
+ def process_album(self, album):
+ """Produce thumbnails for the album folder.
+ """
+ self._log.debug('generating thumbnail for {0}', album)
+ if not album.artpath:
+ self._log.info('album {0} has no art', album)
+ return
+
+ if self.config['dolphin']:
+ self.make_dolphin_cover_thumbnail(album)
+
+ size = ArtResizer.shared.get_size(album.artpath)
+ if not size:
+ self._log.warning('problem getting the picture size for {0}',
+ album.artpath)
+ return
+
+ wrote = True
+ if max(size) >= 256:
+ wrote &= self.make_cover_thumbnail(album, 256, LARGE_DIR)
+ wrote &= self.make_cover_thumbnail(album, 128, NORMAL_DIR)
+
+ if wrote:
+ self._log.info('wrote thumbnail for {0}', album)
+ else:
+ self._log.info('nothing to do for {0}', album)
+
+ def make_cover_thumbnail(self, album, size, target_dir):
+ """Make a thumbnail of given size for `album` and put it in
+ `target_dir`.
+ """
+ target = os.path.join(target_dir, self.thumbnail_file_name(album.path))
+
+ if os.path.exists(target) and \
+ os.stat(target).st_mtime > os.stat(album.artpath).st_mtime:
+ if self.config['force']:
+ self._log.debug("found a suitable {1}x{1} thumbnail for {0}, "
+ "forcing regeneration", album, size)
+ else:
+ self._log.debug("{1}x{1} thumbnail for {0} exists and is "
+ "recent enough", album, size)
+ return False
+ resized = ArtResizer.shared.resize(size, album.artpath,
+ util.syspath(target))
+ self.add_tags(album, util.syspath(resized))
+ shutil.move(resized, target)
+ return True
+
+ def thumbnail_file_name(self, path):
+ """Compute the thumbnail file name
+ See https://standards.freedesktop.org/thumbnail-spec/latest/x227.html
+ """
+ uri = self.get_uri(path)
+ hash = md5(uri.encode('utf-8')).hexdigest()
+ return util.bytestring_path(f"{hash}.png")
+
+ def add_tags(self, album, image_path):
+ """Write required metadata to the thumbnail
+ See https://standards.freedesktop.org/thumbnail-spec/latest/x142.html
+ """
+ mtime = os.stat(album.artpath).st_mtime
+ metadata = {"Thumb::URI": self.get_uri(album.artpath),
+ "Thumb::MTime": str(mtime)}
+ try:
+ self.write_metadata(image_path, metadata)
+ except Exception:
+ self._log.exception("could not write metadata to {0}",
+ util.displayable_path(image_path))
+
+ def make_dolphin_cover_thumbnail(self, album):
+ outfilename = os.path.join(album.path, b".directory")
+ if os.path.exists(outfilename):
+ return
+ artfile = os.path.split(album.artpath)[1]
+ with open(outfilename, 'w') as f:
+ f.write('[Desktop Entry]\n')
+ f.write('Icon=./{}'.format(artfile.decode('utf-8')))
+ f.close()
+ self._log.debug("Wrote file {0}", util.displayable_path(outfilename))
+
+
+def write_metadata_im(file, metadata):
+ """Enrich the file metadata with `metadata` dict thanks to IM."""
+ command = ['convert', file] + \
+ list(chain.from_iterable(('-set', k, v)
+ for k, v in metadata.items())) + [file]
+ util.command_output(command)
+ return True
+
+
+def write_metadata_pil(file, metadata):
+ """Enrich the file metadata with `metadata` dict thanks to PIL."""
+ from PIL import Image, PngImagePlugin
+ im = Image.open(file)
+ meta = PngImagePlugin.PngInfo()
+ for k, v in metadata.items():
+ meta.add_text(k, v, 0)
+ im.save(file, "PNG", pnginfo=meta)
+ return True
+
+
+class URIGetter:
+ available = False
+ name = "Abstract base"
+
+ def uri(self, path):
+ raise NotImplementedError()
+
+
+class PathlibURI(URIGetter):
+ available = True
+ name = "Python Pathlib"
+
+ def uri(self, path):
+ return PurePosixPath(util.py3_path(path)).as_uri()
+
+
+def copy_c_string(c_string):
+ """Copy a `ctypes.POINTER(ctypes.c_char)` value into a new Python
+ string and return it. The old memory is then safe to free.
+ """
+ # This is a pretty dumb way to get a string copy, but it seems to
+ # work. A more surefire way would be to allocate a ctypes buffer and copy
+ # the data with `memcpy` or somesuch.
+ s = ctypes.cast(c_string, ctypes.c_char_p).value
+ return b'' + s
+
+
+class GioURI(URIGetter):
+ """Use gio URI function g_file_get_uri. Paths must be utf-8 encoded.
+ """
+ name = "GIO"
+
+ def __init__(self):
+ self.libgio = self.get_library()
+ self.available = bool(self.libgio)
+ if self.available:
+ self.libgio.g_type_init() # for glib < 2.36
+
+ self.libgio.g_file_get_uri.argtypes = [ctypes.c_char_p]
+ self.libgio.g_file_new_for_path.restype = ctypes.c_void_p
+
+ self.libgio.g_file_get_uri.argtypes = [ctypes.c_void_p]
+ self.libgio.g_file_get_uri.restype = ctypes.POINTER(ctypes.c_char)
+
+ self.libgio.g_object_unref.argtypes = [ctypes.c_void_p]
+
+ def get_library(self):
+ lib_name = ctypes.util.find_library("gio-2")
+ try:
+ if not lib_name:
+ return False
+ return ctypes.cdll.LoadLibrary(lib_name)
+ except OSError:
+ return False
+
+ def uri(self, path):
+ g_file_ptr = self.libgio.g_file_new_for_path(path)
+ if not g_file_ptr:
+ raise RuntimeError("No gfile pointer received for {}".format(
+ util.displayable_path(path)))
+
+ try:
+ uri_ptr = self.libgio.g_file_get_uri(g_file_ptr)
+ finally:
+ self.libgio.g_object_unref(g_file_ptr)
+ if not uri_ptr:
+ self.libgio.g_free(uri_ptr)
+ raise RuntimeError("No URI received from the gfile pointer for "
+ "{}".format(util.displayable_path(path)))
+
+ try:
+ uri = copy_c_string(uri_ptr)
+ finally:
+ self.libgio.g_free(uri_ptr)
+
+ try:
+ return uri.decode(util._fsencoding())
+ except UnicodeDecodeError:
+ raise RuntimeError(
+ f"Could not decode filename from GIO: {uri!r}"
+ )
diff --git a/lib/beetsplug/types.py b/lib/beetsplug/types.py
new file mode 100644
index 00000000..930d5e86
--- /dev/null
+++ b/lib/beetsplug/types.py
@@ -0,0 +1,50 @@
+# This file is part of beets.
+# Copyright 2016, Thomas Scholtes.
+#
+# 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.
+
+
+from beets.plugins import BeetsPlugin
+from beets.dbcore import types
+from confuse import ConfigValueError
+from beets import library
+
+
+class TypesPlugin(BeetsPlugin):
+
+ @property
+ def item_types(self):
+ return self._types()
+
+ @property
+ def album_types(self):
+ return self._types()
+
+ def _types(self):
+ if not self.config.exists():
+ return {}
+
+ mytypes = {}
+ for key, value in self.config.items():
+ if value.get() == 'int':
+ mytypes[key] = types.INTEGER
+ elif value.get() == 'float':
+ mytypes[key] = types.FLOAT
+ elif value.get() == 'bool':
+ mytypes[key] = types.BOOLEAN
+ elif value.get() == 'date':
+ mytypes[key] = library.DateType()
+ else:
+ raise ConfigValueError(
+ "unknown type '{}' for the '{}' field"
+ .format(value, key))
+ return mytypes
diff --git a/lib/beetsplug/unimported.py b/lib/beetsplug/unimported.py
new file mode 100644
index 00000000..7714ec83
--- /dev/null
+++ b/lib/beetsplug/unimported.py
@@ -0,0 +1,68 @@
+# This file is part of beets.
+# Copyright 2019, Joris Jensen
+#
+# 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.
+
+"""
+List all files in the library folder which are not listed in the
+ beets library database, including art files
+"""
+
+import os
+
+from beets import util
+from beets.plugins import BeetsPlugin
+from beets.ui import Subcommand, print_
+
+__author__ = 'https://github.com/MrNuggelz'
+
+
+class Unimported(BeetsPlugin):
+
+ def __init__(self):
+ super().__init__()
+ self.config.add(
+ {
+ 'ignore_extensions': []
+ }
+ )
+
+ def commands(self):
+ def print_unimported(lib, opts, args):
+ ignore_exts = [
+ ('.' + x).encode()
+ for x in self.config["ignore_extensions"].as_str_seq()
+ ]
+ ignore_dirs = [
+ os.path.join(lib.directory, x.encode())
+ for x in self.config["ignore_subdirectories"].as_str_seq()
+ ]
+ in_folder = {
+ os.path.join(r, file)
+ for r, d, f in os.walk(lib.directory)
+ for file in f
+ if not any(
+ [file.endswith(ext) for ext in ignore_exts]
+ + [r in ignore_dirs]
+ )
+ }
+ in_library = {x.path for x in lib.items()}
+ art_files = {x.artpath for x in lib.albums()}
+ for f in in_folder - in_library - art_files:
+ print_(util.displayable_path(f))
+
+ unimported = Subcommand(
+ 'unimported',
+ help='list all files in the library folder which are not listed'
+ ' in the beets library database')
+ unimported.func = print_unimported
+ return [unimported]
diff --git a/lib/beetsplug/web/__init__.py b/lib/beetsplug/web/__init__.py
new file mode 100644
index 00000000..240126e9
--- /dev/null
+++ b/lib/beetsplug/web/__init__.py
@@ -0,0 +1,526 @@
+# This file is part of beets.
+# Copyright 2016, Adrian Sampson.
+#
+# 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.
+
+"""A Web interface to beets."""
+
+from beets.plugins import BeetsPlugin
+from beets import ui
+from beets import util
+import beets.library
+import flask
+from flask import g, jsonify
+from werkzeug.routing import BaseConverter, PathConverter
+import os
+from unidecode import unidecode
+import json
+import base64
+
+
+# Utilities.
+
+def _rep(obj, expand=False):
+ """Get a flat -- i.e., JSON-ish -- representation of a beets Item or
+ Album object. For Albums, `expand` dictates whether tracks are
+ included.
+ """
+ out = dict(obj)
+
+ if isinstance(obj, beets.library.Item):
+ if app.config.get('INCLUDE_PATHS', False):
+ out['path'] = util.displayable_path(out['path'])
+ else:
+ del out['path']
+
+ # Filter all bytes attributes and convert them to strings.
+ for key, value in out.items():
+ if isinstance(out[key], bytes):
+ out[key] = base64.b64encode(value).decode('ascii')
+
+ # Get the size (in bytes) of the backing file. This is useful
+ # for the Tomahawk resolver API.
+ try:
+ out['size'] = os.path.getsize(util.syspath(obj.path))
+ except OSError:
+ out['size'] = 0
+
+ return out
+
+ elif isinstance(obj, beets.library.Album):
+ if app.config.get('INCLUDE_PATHS', False):
+ out['artpath'] = util.displayable_path(out['artpath'])
+ else:
+ del out['artpath']
+ if expand:
+ out['items'] = [_rep(item) for item in obj.items()]
+ return out
+
+
+def json_generator(items, root, expand=False):
+ """Generator that dumps list of beets Items or Albums as JSON
+
+ :param root: root key for JSON
+ :param items: list of :class:`Item` or :class:`Album` to dump
+ :param expand: If true every :class:`Album` contains its items in the json
+ representation
+ :returns: generator that yields strings
+ """
+ yield '{"%s":[' % root
+ first = True
+ for item in items:
+ if first:
+ first = False
+ else:
+ yield ','
+ yield json.dumps(_rep(item, expand=expand))
+ yield ']}'
+
+
+def is_expand():
+ """Returns whether the current request is for an expanded response."""
+
+ return flask.request.args.get('expand') is not None
+
+
+def is_delete():
+ """Returns whether the current delete request should remove the selected
+ files.
+ """
+
+ return flask.request.args.get('delete') is not None
+
+
+def get_method():
+ """Returns the HTTP method of the current request."""
+ return flask.request.method
+
+
+def resource(name, patchable=False):
+ """Decorates a function to handle RESTful HTTP requests for a resource.
+ """
+ def make_responder(retriever):
+ def responder(ids):
+ entities = [retriever(id) for id in ids]
+ entities = [entity for entity in entities if entity]
+
+ if get_method() == "DELETE":
+
+ if app.config.get('READONLY', True):
+ return flask.abort(405)
+
+ for entity in entities:
+ entity.remove(delete=is_delete())
+
+ return flask.make_response(jsonify({'deleted': True}), 200)
+
+ elif get_method() == "PATCH" and patchable:
+ if app.config.get('READONLY', True):
+ return flask.abort(405)
+
+ for entity in entities:
+ entity.update(flask.request.get_json())
+ entity.try_sync(True, False) # write, don't move
+
+ if len(entities) == 1:
+ return flask.jsonify(_rep(entities[0], expand=is_expand()))
+ elif entities:
+ return app.response_class(
+ json_generator(entities, root=name),
+ mimetype='application/json'
+ )
+
+ elif get_method() == "GET":
+ if len(entities) == 1:
+ return flask.jsonify(_rep(entities[0], expand=is_expand()))
+ elif entities:
+ return app.response_class(
+ json_generator(entities, root=name),
+ mimetype='application/json'
+ )
+ else:
+ return flask.abort(404)
+
+ else:
+ return flask.abort(405)
+
+ responder.__name__ = f'get_{name}'
+
+ return responder
+ return make_responder
+
+
+def resource_query(name, patchable=False):
+ """Decorates a function to handle RESTful HTTP queries for resources.
+ """
+ def make_responder(query_func):
+ def responder(queries):
+ entities = query_func(queries)
+
+ if get_method() == "DELETE":
+
+ if app.config.get('READONLY', True):
+ return flask.abort(405)
+
+ for entity in entities:
+ entity.remove(delete=is_delete())
+
+ return flask.make_response(jsonify({'deleted': True}), 200)
+
+ elif get_method() == "PATCH" and patchable:
+ if app.config.get('READONLY', True):
+ return flask.abort(405)
+
+ for entity in entities:
+ entity.update(flask.request.get_json())
+ entity.try_sync(True, False) # write, don't move
+
+ return app.response_class(
+ json_generator(entities, root=name),
+ mimetype='application/json'
+ )
+
+ elif get_method() == "GET":
+ return app.response_class(
+ json_generator(
+ entities,
+ root='results', expand=is_expand()
+ ),
+ mimetype='application/json'
+ )
+
+ else:
+ return flask.abort(405)
+
+ responder.__name__ = f'query_{name}'
+
+ return responder
+
+ return make_responder
+
+
+def resource_list(name):
+ """Decorates a function to handle RESTful HTTP request for a list of
+ resources.
+ """
+ def make_responder(list_all):
+ def responder():
+ return app.response_class(
+ json_generator(list_all(), root=name, expand=is_expand()),
+ mimetype='application/json'
+ )
+ responder.__name__ = f'all_{name}'
+ return responder
+ return make_responder
+
+
+def _get_unique_table_field_values(model, field, sort_field):
+ """ retrieve all unique values belonging to a key from a model """
+ if field not in model.all_keys() or sort_field not in model.all_keys():
+ raise KeyError
+ with g.lib.transaction() as tx:
+ rows = tx.query('SELECT DISTINCT "{}" FROM "{}" ORDER BY "{}"'
+ .format(field, model._table, sort_field))
+ return [row[0] for row in rows]
+
+
+class IdListConverter(BaseConverter):
+ """Converts comma separated lists of ids in urls to integer lists.
+ """
+
+ def to_python(self, value):
+ ids = []
+ for id in value.split(','):
+ try:
+ ids.append(int(id))
+ except ValueError:
+ pass
+ return ids
+
+ def to_url(self, value):
+ return ','.join(str(v) for v in value)
+
+
+class QueryConverter(PathConverter):
+ """Converts slash separated lists of queries in the url to string list.
+ """
+
+ def to_python(self, value):
+ queries = value.split('/')
+ """Do not do path substitution on regex value tests"""
+ return [query if '::' in query else query.replace('\\', os.sep)
+ for query in queries]
+
+ def to_url(self, value):
+ return ','.join([v.replace(os.sep, '\\') for v in value])
+
+
+class EverythingConverter(PathConverter):
+ regex = '.*?'
+
+
+# Flask setup.
+
+app = flask.Flask(__name__)
+app.url_map.converters['idlist'] = IdListConverter
+app.url_map.converters['query'] = QueryConverter
+app.url_map.converters['everything'] = EverythingConverter
+
+
+@app.before_request
+def before_request():
+ g.lib = app.config['lib']
+
+
+# Items.
+
+@app.route('/item/<idlist:ids>', methods=["GET", "DELETE", "PATCH"])
+@resource('items', patchable=True)
+def get_item(id):
+ return g.lib.get_item(id)
+
+
+@app.route('/item/')
+@app.route('/item/query/')
+@resource_list('items')
+def all_items():
+ return g.lib.items()
+
+
+@app.route('/item/<int:item_id>/file')
+def item_file(item_id):
+ item = g.lib.get_item(item_id)
+
+ # On Windows under Python 2, Flask wants a Unicode path. On Python 3, it
+ # *always* wants a Unicode path.
+ if os.name == 'nt':
+ item_path = util.syspath(item.path)
+ else:
+ item_path = util.py3_path(item.path)
+
+ try:
+ unicode_item_path = util.text_string(item.path)
+ except (UnicodeDecodeError, UnicodeEncodeError):
+ unicode_item_path = util.displayable_path(item.path)
+
+ base_filename = os.path.basename(unicode_item_path)
+ try:
+ # Imitate http.server behaviour
+ base_filename.encode("latin-1", "strict")
+ except UnicodeEncodeError:
+ safe_filename = unidecode(base_filename)
+ else:
+ safe_filename = base_filename
+
+ response = flask.send_file(
+ item_path,
+ as_attachment=True,
+ attachment_filename=safe_filename
+ )
+ response.headers['Content-Length'] = os.path.getsize(item_path)
+ return response
+
+
+@app.route('/item/query/<query:queries>', methods=["GET", "DELETE", "PATCH"])
+@resource_query('items', patchable=True)
+def item_query(queries):
+ return g.lib.items(queries)
+
+
+@app.route('/item/path/<everything:path>')
+def item_at_path(path):
+ query = beets.library.PathQuery('path', path.encode('utf-8'))
+ item = g.lib.items(query).get()
+ if item:
+ return flask.jsonify(_rep(item))
+ else:
+ return flask.abort(404)
+
+
+@app.route('/item/values/<string:key>')
+def item_unique_field_values(key):
+ sort_key = flask.request.args.get('sort_key', key)
+ try:
+ values = _get_unique_table_field_values(beets.library.Item, key,
+ sort_key)
+ except KeyError:
+ return flask.abort(404)
+ return flask.jsonify(values=values)
+
+
+# Albums.
+
+@app.route('/album/<idlist:ids>', methods=["GET", "DELETE"])
+@resource('albums')
+def get_album(id):
+ return g.lib.get_album(id)
+
+
+@app.route('/album/')
+@app.route('/album/query/')
+@resource_list('albums')
+def all_albums():
+ return g.lib.albums()
+
+
+@app.route('/album/query/<query:queries>', methods=["GET", "DELETE"])
+@resource_query('albums')
+def album_query(queries):
+ return g.lib.albums(queries)
+
+
+@app.route('/album/<int:album_id>/art')
+def album_art(album_id):
+ album = g.lib.get_album(album_id)
+ if album and album.artpath:
+ return flask.send_file(album.artpath.decode())
+ else:
+ return flask.abort(404)
+
+
+@app.route('/album/values/<string:key>')
+def album_unique_field_values(key):
+ sort_key = flask.request.args.get('sort_key', key)
+ try:
+ values = _get_unique_table_field_values(beets.library.Album, key,
+ sort_key)
+ except KeyError:
+ return flask.abort(404)
+ return flask.jsonify(values=values)
+
+
+# Artists.
+
+@app.route('/artist/')
+def all_artists():
+ with g.lib.transaction() as tx:
+ rows = tx.query("SELECT DISTINCT albumartist FROM albums")
+ all_artists = [row[0] for row in rows]
+ return flask.jsonify(artist_names=all_artists)
+
+
+# Library information.
+
+@app.route('/stats')
+def stats():
+ with g.lib.transaction() as tx:
+ item_rows = tx.query("SELECT COUNT(*) FROM items")
+ album_rows = tx.query("SELECT COUNT(*) FROM albums")
+ return flask.jsonify({
+ 'items': item_rows[0][0],
+ 'albums': album_rows[0][0],
+ })
+
+
+# UI.
+
+@app.route('/')
+def home():
+ return flask.render_template('index.html')
+
+
+# Plugin hook.
+
+class WebPlugin(BeetsPlugin):
+ def __init__(self):
+ super().__init__()
+ self.config.add({
+ 'host': '127.0.0.1',
+ 'port': 8337,
+ 'cors': '',
+ 'cors_supports_credentials': False,
+ 'reverse_proxy': False,
+ 'include_paths': False,
+ 'readonly': True,
+ })
+
+ def commands(self):
+ cmd = ui.Subcommand('web', help='start a Web interface')
+ cmd.parser.add_option('-d', '--debug', action='store_true',
+ default=False, help='debug mode')
+
+ def func(lib, opts, args):
+ args = ui.decargs(args)
+ if args:
+ self.config['host'] = args.pop(0)
+ if args:
+ self.config['port'] = int(args.pop(0))
+
+ app.config['lib'] = lib
+ # Normalizes json output
+ app.config['JSONIFY_PRETTYPRINT_REGULAR'] = False
+
+ app.config['INCLUDE_PATHS'] = self.config['include_paths']
+ app.config['READONLY'] = self.config['readonly']
+
+ # Enable CORS if required.
+ if self.config['cors']:
+ self._log.info('Enabling CORS with origin: {0}',
+ self.config['cors'])
+ from flask_cors import CORS
+ app.config['CORS_ALLOW_HEADERS'] = "Content-Type"
+ app.config['CORS_RESOURCES'] = {
+ r"/*": {"origins": self.config['cors'].get(str)}
+ }
+ CORS(
+ app,
+ supports_credentials=self.config[
+ 'cors_supports_credentials'
+ ].get(bool)
+ )
+
+ # Allow serving behind a reverse proxy
+ if self.config['reverse_proxy']:
+ app.wsgi_app = ReverseProxied(app.wsgi_app)
+
+ # Start the web application.
+ app.run(host=self.config['host'].as_str(),
+ port=self.config['port'].get(int),
+ debug=opts.debug, threaded=True)
+ cmd.func = func
+ return [cmd]
+
+
+class ReverseProxied:
+ '''Wrap the application in this middleware and configure the
+ front-end server to add these headers, to let you quietly bind
+ this to a URL other than / and to an HTTP scheme that is
+ different than what is used locally.
+
+ In nginx:
+ location /myprefix {
+ proxy_pass http://192.168.0.1:5001;
+ proxy_set_header Host $host;
+ proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+ proxy_set_header X-Scheme $scheme;
+ proxy_set_header X-Script-Name /myprefix;
+ }
+
+ From: http://flask.pocoo.org/snippets/35/
+
+ :param app: the WSGI application
+ '''
+ def __init__(self, app):
+ self.app = app
+
+ def __call__(self, environ, start_response):
+ script_name = environ.get('HTTP_X_SCRIPT_NAME', '')
+ if script_name:
+ environ['SCRIPT_NAME'] = script_name
+ path_info = environ['PATH_INFO']
+ if path_info.startswith(script_name):
+ environ['PATH_INFO'] = path_info[len(script_name):]
+
+ scheme = environ.get('HTTP_X_SCHEME', '')
+ if scheme:
+ environ['wsgi.url_scheme'] = scheme
+ return self.app(environ, start_response)
diff --git a/lib/beetsplug/web/static/backbone.js b/lib/beetsplug/web/static/backbone.js
new file mode 100644
index 00000000..b2e49322
--- /dev/null
+++ b/lib/beetsplug/web/static/backbone.js
@@ -0,0 +1,1158 @@
+// Backbone.js 0.5.3
+// (c) 2010 Jeremy Ashkenas, DocumentCloud Inc.
+// Backbone may be freely distributed under the MIT license.
+// For all details and documentation:
+// http://documentcloud.github.com/backbone
+
+(function(){
+
+ // Initial Setup
+ // -------------
+
+ // Save a reference to the global object.
+ var root = this;
+
+ // Save the previous value of the `Backbone` variable.
+ var previousBackbone = root.Backbone;
+
+ // The top-level namespace. All public Backbone classes and modules will
+ // be attached to this. Exported for both CommonJS and the browser.
+ var Backbone;
+ if (typeof exports !== 'undefined') {
+ Backbone = exports;
+ } else {
+ Backbone = root.Backbone = {};
+ }
+
+ // Current version of the library. Keep in sync with `package.json`.
+ Backbone.VERSION = '0.5.3';
+
+ // Require Underscore, if we're on the server, and it's not already present.
+ var _ = root._;
+ if (!_ && (typeof require !== 'undefined')) _ = require('underscore')._;
+
+ // For Backbone's purposes, jQuery or Zepto owns the `$` variable.
+ var $ = root.jQuery || root.Zepto;
+
+ // Runs Backbone.js in *noConflict* mode, returning the `Backbone` variable
+ // to its previous owner. Returns a reference to this Backbone object.
+ Backbone.noConflict = function() {
+ root.Backbone = previousBackbone;
+ return this;
+ };
+
+ // Turn on `emulateHTTP` to support legacy HTTP servers. Setting this option will
+ // fake `"PUT"` and `"DELETE"` requests via the `_method` parameter and set a
+ // `X-Http-Method-Override` header.
+ Backbone.emulateHTTP = false;
+
+ // Turn on `emulateJSON` to support legacy servers that can't deal with direct
+ // `application/json` requests ... will encode the body as
+ // `application/x-www-form-urlencoded` instead and will send the model in a
+ // form param named `model`.
+ Backbone.emulateJSON = false;
+
+ // Backbone.Events
+ // -----------------
+
+ // A module that can be mixed in to *any object* in order to provide it with
+ // custom events. You may `bind` or `unbind` a callback function to an event;
+ // `trigger`-ing an event fires all callbacks in succession.
+ //
+ // var object = {};
+ // _.extend(object, Backbone.Events);
+ // object.bind('expand', function(){ alert('expanded'); });
+ // object.trigger('expand');
+ //
+ Backbone.Events = {
+
+ // Bind an event, specified by a string name, `ev`, to a `callback` function.
+ // Passing `"all"` will bind the callback to all events fired.
+ bind : function(ev, callback, context) {
+ var calls = this._callbacks || (this._callbacks = {});
+ var list = calls[ev] || (calls[ev] = []);
+ list.push([callback, context]);
+ return this;
+ },
+
+ // Remove one or many callbacks. If `callback` is null, removes all
+ // callbacks for the event. If `ev` is null, removes all bound callbacks
+ // for all events.
+ unbind : function(ev, callback) {
+ var calls;
+ if (!ev) {
+ this._callbacks = {};
+ } else if (calls = this._callbacks) {
+ if (!callback) {
+ calls[ev] = [];
+ } else {
+ var list = calls[ev];
+ if (!list) return this;
+ for (var i = 0, l = list.length; i < l; i++) {
+ if (list[i] && callback === list[i][0]) {
+ list[i] = null;
+ break;
+ }
+ }
+ }
+ }
+ return this;
+ },
+
+ // Trigger an event, firing all bound callbacks. Callbacks are passed the
+ // same arguments as `trigger` is, apart from the event name.
+ // Listening for `"all"` passes the true event name as the first argument.
+ trigger : function(eventName) {
+ var list, calls, ev, callback, args;
+ var both = 2;
+ if (!(calls = this._callbacks)) return this;
+ while (both--) {
+ ev = both ? eventName : 'all';
+ if (list = calls[ev]) {
+ for (var i = 0, l = list.length; i < l; i++) {
+ if (!(callback = list[i])) {
+ list.splice(i, 1); i--; l--;
+ } else {
+ args = both ? Array.prototype.slice.call(arguments, 1) : arguments;
+ callback[0].apply(callback[1] || this, args);
+ }
+ }
+ }
+ }
+ return this;
+ }
+
+ };
+
+ // Backbone.Model
+ // --------------
+
+ // Create a new model, with defined attributes. A client id (`cid`)
+ // is automatically generated and assigned for you.
+ Backbone.Model = function(attributes, options) {
+ var defaults;
+ attributes || (attributes = {});
+ if (defaults = this.defaults) {
+ if (_.isFunction(defaults)) defaults = defaults.call(this);
+ attributes = _.extend({}, defaults, attributes);
+ }
+ this.attributes = {};
+ this._escapedAttributes = {};
+ this.cid = _.uniqueId('c');
+ this.set(attributes, {silent : true});
+ this._changed = false;
+ this._previousAttributes = _.clone(this.attributes);
+ if (options && options.collection) this.collection = options.collection;
+ this.initialize(attributes, options);
+ };
+
+ // Attach all inheritable methods to the Model prototype.
+ _.extend(Backbone.Model.prototype, Backbone.Events, {
+
+ // A snapshot of the model's previous attributes, taken immediately
+ // after the last `"change"` event was fired.
+ _previousAttributes : null,
+
+ // Has the item been changed since the last `"change"` event?
+ _changed : false,
+
+ // The default name for the JSON `id` attribute is `"id"`. MongoDB and
+ // CouchDB users may want to set this to `"_id"`.
+ idAttribute : 'id',
+
+ // Initialize is an empty function by default. Override it with your own
+ // initialization logic.
+ initialize : function(){},
+
+ // Return a copy of the model's `attributes` object.
+ toJSON : function() {
+ return _.clone(this.attributes);
+ },
+
+ // Get the value of an attribute.
+ get : function(attr) {
+ return this.attributes[attr];
+ },
+
+ // Get the HTML-escaped value of an attribute.
+ escape : function(attr) {
+ var html;
+ if (html = this._escapedAttributes[attr]) return html;
+ var val = this.attributes[attr];
+ return this._escapedAttributes[attr] = escapeHTML(val == null ? '' : '' + val);
+ },
+
+ // Returns `true` if the attribute contains a value that is not null
+ // or undefined.
+ has : function(attr) {
+ return this.attributes[attr] != null;
+ },
+
+ // Set a hash of model attributes on the object, firing `"change"` unless you
+ // choose to silence it.
+ set : function(attrs, options) {
+
+ // Extract attributes and options.
+ options || (options = {});
+ if (!attrs) return this;
+ if (attrs.attributes) attrs = attrs.attributes;
+ var now = this.attributes, escaped = this._escapedAttributes;
+
+ // Run validation.
+ if (!options.silent && this.validate && !this._performValidation(attrs, options)) return false;
+
+ // Check for changes of `id`.
+ if (this.idAttribute in attrs) this.id = attrs[this.idAttribute];
+
+ // We're about to start triggering change events.
+ var alreadyChanging = this._changing;
+ this._changing = true;
+
+ // Update attributes.
+ for (var attr in attrs) {
+ var val = attrs[attr];
+ if (!_.isEqual(now[attr], val)) {
+ now[attr] = val;
+ delete escaped[attr];
+ this._changed = true;
+ if (!options.silent) this.trigger('change:' + attr, this, val, options);
+ }
+ }
+
+ // Fire the `"change"` event, if the model has been changed.
+ if (!alreadyChanging && !options.silent && this._changed) this.change(options);
+ this._changing = false;
+ return this;
+ },
+
+ // Remove an attribute from the model, firing `"change"` unless you choose
+ // to silence it. `unset` is a noop if the attribute doesn't exist.
+ unset : function(attr, options) {
+ if (!(attr in this.attributes)) return this;
+ options || (options = {});
+ var value = this.attributes[attr];
+
+ // Run validation.
+ var validObj = {};
+ validObj[attr] = void 0;
+ if (!options.silent && this.validate && !this._performValidation(validObj, options)) return false;
+
+ // Remove the attribute.
+ delete this.attributes[attr];
+ delete this._escapedAttributes[attr];
+ if (attr == this.idAttribute) delete this.id;
+ this._changed = true;
+ if (!options.silent) {
+ this.trigger('change:' + attr, this, void 0, options);
+ this.change(options);
+ }
+ return this;
+ },
+
+ // Clear all attributes on the model, firing `"change"` unless you choose
+ // to silence it.
+ clear : function(options) {
+ options || (options = {});
+ var attr;
+ var old = this.attributes;
+
+ // Run validation.
+ var validObj = {};
+ for (attr in old) validObj[attr] = void 0;
+ if (!options.silent && this.validate && !this._performValidation(validObj, options)) return false;
+
+ this.attributes = {};
+ this._escapedAttributes = {};
+ this._changed = true;
+ if (!options.silent) {
+ for (attr in old) {
+ this.trigger('change:' + attr, this, void 0, options);
+ }
+ this.change(options);
+ }
+ return this;
+ },
+
+ // Fetch the model from the server. If the server's representation of the
+ // model differs from its current attributes, they will be overriden,
+ // triggering a `"change"` event.
+ fetch : function(options) {
+ options || (options = {});
+ var model = this;
+ var success = options.success;
+ options.success = function(resp, status, xhr) {
+ if (!model.set(model.parse(resp, xhr), options)) return false;
+ if (success) success(model, resp);
+ };
+ options.error = wrapError(options.error, model, options);
+ return (this.sync || Backbone.sync).call(this, 'read', this, options);
+ },
+
+ // Set a hash of model attributes, and sync the model to the server.
+ // If the server returns an attributes hash that differs, the model's
+ // state will be `set` again.
+ save : function(attrs, options) {
+ options || (options = {});
+ if (attrs && !this.set(attrs, options)) return false;
+ var model = this;
+ var success = options.success;
+ options.success = function(resp, status, xhr) {
+ if (!model.set(model.parse(resp, xhr), options)) return false;
+ if (success) success(model, resp, xhr);
+ };
+ options.error = wrapError(options.error, model, options);
+ var method = this.isNew() ? 'create' : 'update';
+ return (this.sync || Backbone.sync).call(this, method, this, options);
+ },
+
+ // Destroy this model on the server if it was already persisted. Upon success, the model is removed
+ // from its collection, if it has one.
+ destroy : function(options) {
+ options || (options = {});
+ if (this.isNew()) return this.trigger('destroy', this, this.collection, options);
+ var model = this;
+ var success = options.success;
+ options.success = function(resp) {
+ model.trigger('destroy', model, model.collection, options);
+ if (success) success(model, resp);
+ };
+ options.error = wrapError(options.error, model, options);
+ return (this.sync || Backbone.sync).call(this, 'delete', this, options);
+ },
+
+ // Default URL for the model's representation on the server -- if you're
+ // using Backbone's restful methods, override this to change the endpoint
+ // that will be called.
+ url : function() {
+ var base = getUrl(this.collection) || this.urlRoot || urlError();
+ if (this.isNew()) return base;
+ return base + (base.charAt(base.length - 1) == '/' ? '' : '/') + encodeURIComponent(this.id);
+ },
+
+ // **parse** converts a response into the hash of attributes to be `set` on
+ // the model. The default implementation is just to pass the response along.
+ parse : function(resp, xhr) {
+ return resp;
+ },
+
+ // Create a new model with identical attributes to this one.
+ clone : function() {
+ return new this.constructor(this);
+ },
+
+ // A model is new if it has never been saved to the server, and lacks an id.
+ isNew : function() {
+ return this.id == null;
+ },
+
+ // Call this method to manually fire a `change` event for this model.
+ // Calling this will cause all objects observing the model to update.
+ change : function(options) {
+ this.trigger('change', this, options);
+ this._previousAttributes = _.clone(this.attributes);
+ this._changed = false;
+ },
+
+ // Determine if the model has changed since the last `"change"` event.
+ // If you specify an attribute name, determine if that attribute has changed.
+ hasChanged : function(attr) {
+ if (attr) return this._previousAttributes[attr] != this.attributes[attr];
+ return this._changed;
+ },
+
+ // Return an object containing all the attributes that have changed, or false
+ // if there are no changed attributes. Useful for determining what parts of a
+ // view need to be updated and/or what attributes need to be persisted to
+ // the server.
+ changedAttributes : function(now) {
+ now || (now = this.attributes);
+ var old = this._previousAttributes;
+ var changed = false;
+ for (var attr in now) {
+ if (!_.isEqual(old[attr], now[attr])) {
+ changed = changed || {};
+ changed[attr] = now[attr];
+ }
+ }
+ return changed;
+ },
+
+ // Get the previous value of an attribute, recorded at the time the last
+ // `"change"` event was fired.
+ previous : function(attr) {
+ if (!attr || !this._previousAttributes) return null;
+ return this._previousAttributes[attr];
+ },
+
+ // Get all of the attributes of the model at the time of the previous
+ // `"change"` event.
+ previousAttributes : function() {
+ return _.clone(this._previousAttributes);
+ },
+
+ // Run validation against a set of incoming attributes, returning `true`
+ // if all is well. If a specific `error` callback has been passed,
+ // call that instead of firing the general `"error"` event.
+ _performValidation : function(attrs, options) {
+ var error = this.validate(attrs);
+ if (error) {
+ if (options.error) {
+ options.error(this, error, options);
+ } else {
+ this.trigger('error', this, error, options);
+ }
+ return false;
+ }
+ return true;
+ }
+
+ });
+
+ // Backbone.Collection
+ // -------------------
+
+ // Provides a standard collection class for our sets of models, ordered
+ // or unordered. If a `comparator` is specified, the Collection will maintain
+ // its models in sort order, as they're added and removed.
+ Backbone.Collection = function(models, options) {
+ options || (options = {});
+ if (options.comparator) this.comparator = options.comparator;
+ _.bindAll(this, '_onModelEvent', '_removeReference');
+ this._reset();
+ if (models) this.reset(models, {silent: true});
+ this.initialize.apply(this, arguments);
+ };
+
+ // Define the Collection's inheritable methods.
+ _.extend(Backbone.Collection.prototype, Backbone.Events, {
+
+ // The default model for a collection is just a **Backbone.Model**.
+ // This should be overridden in most cases.
+ model : Backbone.Model,
+
+ // Initialize is an empty function by default. Override it with your own
+ // initialization logic.
+ initialize : function(){},
+
+ // The JSON representation of a Collection is an array of the
+ // models' attributes.
+ toJSON : function() {
+ return this.map(function(model){ return model.toJSON(); });
+ },
+
+ // Add a model, or list of models to the set. Pass **silent** to avoid
+ // firing the `added` event for every new model.
+ add : function(models, options) {
+ if (_.isArray(models)) {
+ for (var i = 0, l = models.length; i < l; i++) {
+ this._add(models[i], options);
+ }
+ } else {
+ this._add(models, options);
+ }
+ return this;
+ },
+
+ // Remove a model, or a list of models from the set. Pass silent to avoid
+ // firing the `removed` event for every model removed.
+ remove : function(models, options) {
+ if (_.isArray(models)) {
+ for (var i = 0, l = models.length; i < l; i++) {
+ this._remove(models[i], options);
+ }
+ } else {
+ this._remove(models, options);
+ }
+ return this;
+ },
+
+ // Get a model from the set by id.
+ get : function(id) {
+ if (id == null) return null;
+ return this._byId[id.id != null ? id.id : id];
+ },
+
+ // Get a model from the set by client id.
+ getByCid : function(cid) {
+ return cid && this._byCid[cid.cid || cid];
+ },
+
+ // Get the model at the given index.
+ at: function(index) {
+ return this.models[index];
+ },
+
+ // Force the collection to re-sort itself. You don't need to call this under normal
+ // circumstances, as the set will maintain sort order as each item is added.
+ sort : function(options) {
+ options || (options = {});
+ if (!this.comparator) throw new Error('Cannot sort a set without a comparator');
+ this.models = this.sortBy(this.comparator);
+ if (!options.silent) this.trigger('reset', this, options);
+ return this;
+ },
+
+ // Pluck an attribute from each model in the collection.
+ pluck : function(attr) {
+ return _.map(this.models, function(model){ return model.get(attr); });
+ },
+
+ // When you have more items than you want to add or remove individually,
+ // you can reset the entire set with a new list of models, without firing
+ // any `added` or `removed` events. Fires `reset` when finished.
+ reset : function(models, options) {
+ models || (models = []);
+ options || (options = {});
+ this.each(this._removeReference);
+ this._reset();
+ this.add(models, {silent: true});
+ if (!options.silent) this.trigger('reset', this, options);
+ return this;
+ },
+
+ // Fetch the default set of models for this collection, resetting the
+ // collection when they arrive. If `add: true` is passed, appends the
+ // models to the collection instead of resetting.
+ fetch : function(options) {
+ options || (options = {});
+ var collection = this;
+ var success = options.success;
+ options.success = function(resp, status, xhr) {
+ collection[options.add ? 'add' : 'reset'](collection.parse(resp, xhr), options);
+ if (success) success(collection, resp);
+ };
+ options.error = wrapError(options.error, collection, options);
+ return (this.sync || Backbone.sync).call(this, 'read', this, options);
+ },
+
+ // Create a new instance of a model in this collection. After the model
+ // has been created on the server, it will be added to the collection.
+ // Returns the model, or 'false' if validation on a new model fails.
+ create : function(model, options) {
+ var coll = this;
+ options || (options = {});
+ model = this._prepareModel(model, options);
+ if (!model) return false;
+ var success = options.success;
+ options.success = function(nextModel, resp, xhr) {
+ coll.add(nextModel, options);
+ if (success) success(nextModel, resp, xhr);
+ };
+ model.save(null, options);
+ return model;
+ },
+
+ // **parse** converts a response into a list of models to be added to the
+ // collection. The default implementation is just to pass it through.
+ parse : function(resp, xhr) {
+ return resp;
+ },
+
+ // Proxy to _'s chain. Can't be proxied the same way the rest of the
+ // underscore methods are proxied because it relies on the underscore
+ // constructor.
+ chain: function () {
+ return _(this.models).chain();
+ },
+
+ // Reset all internal state. Called when the collection is reset.
+ _reset : function(options) {
+ this.length = 0;
+ this.models = [];
+ this._byId = {};
+ this._byCid = {};
+ },
+
+ // Prepare a model to be added to this collection
+ _prepareModel: function(model, options) {
+ if (!(model instanceof Backbone.Model)) {
+ var attrs = model;
+ model = new this.model(attrs, {collection: this});
+ if (model.validate && !model._performValidation(attrs, options)) model = false;
+ } else if (!model.collection) {
+ model.collection = this;
+ }
+ return model;
+ },
+
+ // Internal implementation of adding a single model to the set, updating
+ // hash indexes for `id` and `cid` lookups.
+ // Returns the model, or 'false' if validation on a new model fails.
+ _add : function(model, options) {
+ options || (options = {});
+ model = this._prepareModel(model, options);
+ if (!model) return false;
+ var already = this.getByCid(model);
+ if (already) throw new Error(["Can't add the same model to a set twice", already.id]);
+ this._byId[model.id] = model;
+ this._byCid[model.cid] = model;
+ var index = options.at != null ? options.at :
+ this.comparator ? this.sortedIndex(model, this.comparator) :
+ this.length;
+ this.models.splice(index, 0, model);
+ model.bind('all', this._onModelEvent);
+ this.length++;
+ if (!options.silent) model.trigger('add', model, this, options);
+ return model;
+ },
+
+ // Internal implementation of removing a single model from the set, updating
+ // hash indexes for `id` and `cid` lookups.
+ _remove : function(model, options) {
+ options || (options = {});
+ model = this.getByCid(model) || this.get(model);
+ if (!model) return null;
+ delete this._byId[model.id];
+ delete this._byCid[model.cid];
+ this.models.splice(this.indexOf(model), 1);
+ this.length--;
+ if (!options.silent) model.trigger('remove', model, this, options);
+ this._removeReference(model);
+ return model;
+ },
+
+ // Internal method to remove a model's ties to a collection.
+ _removeReference : function(model) {
+ if (this == model.collection) {
+ delete model.collection;
+ }
+ model.unbind('all', this._onModelEvent);
+ },
+
+ // Internal method called every time a model in the set fires an event.
+ // Sets need to update their indexes when models change ids. All other
+ // events simply proxy through. "add" and "remove" events that originate
+ // in other collections are ignored.
+ _onModelEvent : function(ev, model, collection, options) {
+ if ((ev == 'add' || ev == 'remove') && collection != this) return;
+ if (ev == 'destroy') {
+ this._remove(model, options);
+ }
+ if (model && ev === 'change:' + model.idAttribute) {
+ delete this._byId[model.previous(model.idAttribute)];
+ this._byId[model.id] = model;
+ }
+ this.trigger.apply(this, arguments);
+ }
+
+ });
+
+ // Underscore methods that we want to implement on the Collection.
+ var methods = ['forEach', 'each', 'map', 'reduce', 'reduceRight', 'find', 'detect',
+ 'filter', 'select', 'reject', 'every', 'all', 'some', 'any', 'include',
+ 'contains', 'invoke', 'max', 'min', 'sortBy', 'sortedIndex', 'toArray', 'size',
+ 'first', 'rest', 'last', 'without', 'indexOf', 'lastIndexOf', 'isEmpty', 'groupBy'];
+
+ // Mix in each Underscore method as a proxy to `Collection#models`.
+ _.each(methods, function(method) {
+ Backbone.Collection.prototype[method] = function() {
+ return _[method].apply(_, [this.models].concat(_.toArray(arguments)));
+ };
+ });
+
+ // Backbone.Router
+ // -------------------
+
+ // Routers map faux-URLs to actions, and fire events when routes are
+ // matched. Creating a new one sets its `routes` hash, if not set statically.
+ Backbone.Router = function(options) {
+ options || (options = {});
+ if (options.routes) this.routes = options.routes;
+ this._bindRoutes();
+ this.initialize.apply(this, arguments);
+ };
+
+ // Cached regular expressions for matching named param parts and splatted
+ // parts of route strings.
+ var namedParam = /:([\w\d]+)/g;
+ var splatParam = /\*([\w\d]+)/g;
+ var escapeRegExp = /[-[\]{}()+?.,\\^$|#\s]/g;
+
+ // Set up all inheritable **Backbone.Router** properties and methods.
+ _.extend(Backbone.Router.prototype, Backbone.Events, {
+
+ // Initialize is an empty function by default. Override it with your own
+ // initialization logic.
+ initialize : function(){},
+
+ // Manually bind a single named route to a callback. For example:
+ //
+ // this.route('search/:query/p:num', 'search', function(query, num) {
+ // ...
+ // });
+ //
+ route : function(route, name, callback) {
+ Backbone.history || (Backbone.history = new Backbone.History);
+ if (!_.isRegExp(route)) route = this._routeToRegExp(route);
+ Backbone.history.route(route, _.bind(function(fragment) {
+ var args = this._extractParameters(route, fragment);
+ callback.apply(this, args);
+ this.trigger.apply(this, ['route:' + name].concat(args));
+ }, this));
+ },
+
+ // Simple proxy to `Backbone.history` to save a fragment into the history.
+ navigate : function(fragment, triggerRoute) {
+ Backbone.history.navigate(fragment, triggerRoute);
+ },
+
+ // Bind all defined routes to `Backbone.history`. We have to reverse the
+ // order of the routes here to support behavior where the most general
+ // routes can be defined at the bottom of the route map.
+ _bindRoutes : function() {
+ if (!this.routes) return;
+ var routes = [];
+ for (var route in this.routes) {
+ routes.unshift([route, this.routes[route]]);
+ }
+ for (var i = 0, l = routes.length; i < l; i++) {
+ this.route(routes[i][0], routes[i][1], this[routes[i][1]]);
+ }
+ },
+
+ // Convert a route string into a regular expression, suitable for matching
+ // against the current location hash.
+ _routeToRegExp : function(route) {
+ route = route.replace(escapeRegExp, "\\$&")
+ .replace(namedParam, "([^\/]*)")
+ .replace(splatParam, "(.*?)");
+ return new RegExp('^' + route + '$');
+ },
+
+ // Given a route, and a URL fragment that it matches, return the array of
+ // extracted parameters.
+ _extractParameters : function(route, fragment) {
+ return route.exec(fragment).slice(1);
+ }
+
+ });
+
+ // Backbone.History
+ // ----------------
+
+ // Handles cross-browser history management, based on URL fragments. If the
+ // browser does not support `onhashchange`, falls back to polling.
+ Backbone.History = function() {
+ this.handlers = [];
+ _.bindAll(this, 'checkUrl');
+ };
+
+ // Cached regex for cleaning hashes.
+ var hashStrip = /^#*/;
+
+ // Cached regex for detecting MSIE.
+ var isExplorer = /msie [\w.]+/;
+
+ // Has the history handling already been started?
+ var historyStarted = false;
+
+ // Set up all inheritable **Backbone.History** properties and methods.
+ _.extend(Backbone.History.prototype, {
+
+ // The default interval to poll for hash changes, if necessary, is
+ // twenty times a second.
+ interval: 50,
+
+ // Get the cross-browser normalized URL fragment, either from the URL,
+ // the hash, or the override.
+ getFragment : function(fragment, forcePushState) {
+ if (fragment == null) {
+ if (this._hasPushState || forcePushState) {
+ fragment = window.location.pathname;
+ var search = window.location.search;
+ if (search) fragment += search;
+ if (fragment.indexOf(this.options.root) == 0) fragment = fragment.substr(this.options.root.length);
+ } else {
+ fragment = window.location.hash;
+ }
+ }
+ return decodeURIComponent(fragment.replace(hashStrip, ''));
+ },
+
+ // Start the hash change handling, returning `true` if the current URL matches
+ // an existing route, and `false` otherwise.
+ start : function(options) {
+
+ // Figure out the initial configuration. Do we need an iframe?
+ // Is pushState desired ... is it available?
+ if (historyStarted) throw new Error("Backbone.history has already been started");
+ this.options = _.extend({}, {root: '/'}, this.options, options);
+ this._wantsPushState = !!this.options.pushState;
+ this._hasPushState = !!(this.options.pushState && window.history && window.history.pushState);
+ var fragment = this.getFragment();
+ var docMode = document.documentMode;
+ var oldIE = (isExplorer.exec(navigator.userAgent.toLowerCase()) && (!docMode || docMode <= 7));
+ if (oldIE) {
+ this.iframe = $('<iframe src="javascript:0" tabindex="-1" />').hide().appendTo('body')[0].contentWindow;
+ this.navigate(fragment);
+ }
+
+ // Depending on whether we're using pushState or hashes, and whether
+ // 'onhashchange' is supported, determine how we check the URL state.
+ if (this._hasPushState) {
+ $(window).bind('popstate', this.checkUrl);
+ } else if ('onhashchange' in window && !oldIE) {
+ $(window).bind('hashchange', this.checkUrl);
+ } else {
+ setInterval(this.checkUrl, this.interval);
+ }
+
+ // Determine if we need to change the base url, for a pushState link
+ // opened by a non-pushState browser.
+ this.fragment = fragment;
+ historyStarted = true;
+ var loc = window.location;
+ var atRoot = loc.pathname == this.options.root;
+ if (this._wantsPushState && !this._hasPushState && !atRoot) {
+ this.fragment = this.getFragment(null, true);
+ window.location.replace(this.options.root + '#' + this.fragment);
+ // Return immediately as browser will do redirect to new url
+ return true;
+ } else if (this._wantsPushState && this._hasPushState && atRoot && loc.hash) {
+ this.fragment = loc.hash.replace(hashStrip, '');
+ window.history.replaceState({}, document.title, loc.protocol + '//' + loc.host + this.options.root + this.fragment);
+ }
+
+ if (!this.options.silent) {
+ return this.loadUrl();
+ }
+ },
+
+ // Add a route to be tested when the fragment changes. Routes added later may
+ // override previous routes.
+ route : function(route, callback) {
+ this.handlers.unshift({route : route, callback : callback});
+ },
+
+ // Checks the current URL to see if it has changed, and if it has,
+ // calls `loadUrl`, normalizing across the hidden iframe.
+ checkUrl : function(e) {
+ var current = this.getFragment();
+ if (current == this.fragment && this.iframe) current = this.getFragment(this.iframe.location.hash);
+ if (current == this.fragment || current == decodeURIComponent(this.fragment)) return false;
+ if (this.iframe) this.navigate(current);
+ this.loadUrl() || this.loadUrl(window.location.hash);
+ },
+
+ // Attempt to load the current URL fragment. If a route succeeds with a
+ // match, returns `true`. If no defined routes matches the fragment,
+ // returns `false`.
+ loadUrl : function(fragmentOverride) {
+ var fragment = this.fragment = this.getFragment(fragmentOverride);
+ var matched = _.any(this.handlers, function(handler) {
+ if (handler.route.test(fragment)) {
+ handler.callback(fragment);
+ return true;
+ }
+ });
+ return matched;
+ },
+
+ // Save a fragment into the hash history. You are responsible for properly
+ // URL-encoding the fragment in advance. This does not trigger
+ // a `hashchange` event.
+ navigate : function(fragment, triggerRoute) {
+ var frag = (fragment || '').replace(hashStrip, '');
+ if (this.fragment == frag || this.fragment == decodeURIComponent(frag)) return;
+ if (this._hasPushState) {
+ var loc = window.location;
+ if (frag.indexOf(this.options.root) != 0) frag = this.options.root + frag;
+ this.fragment = frag;
+ window.history.pushState({}, document.title, loc.protocol + '//' + loc.host + frag);
+ } else {
+ window.location.hash = this.fragment = frag;
+ if (this.iframe && (frag != this.getFragment(this.iframe.location.hash))) {
+ this.iframe.document.open().close();
+ this.iframe.location.hash = frag;
+ }
+ }
+ if (triggerRoute) this.loadUrl(fragment);
+ }
+
+ });
+
+ // Backbone.View
+ // -------------
+
+ // Creating a Backbone.View creates its initial element outside of the DOM,
+ // if an existing element is not provided...
+ Backbone.View = function(options) {
+ this.cid = _.uniqueId('view');
+ this._configure(options || {});
+ this._ensureElement();
+ this.delegateEvents();
+ this.initialize.apply(this, arguments);
+ };
+
+ // Element lookup, scoped to DOM elements within the current view.
+ // This should be prefered to global lookups, if you're dealing with
+ // a specific view.
+ var selectorDelegate = function(selector) {
+ return $(selector, this.el);
+ };
+
+ // Cached regex to split keys for `delegate`.
+ var eventSplitter = /^(\S+)\s*(.*)$/;
+
+ // List of view options to be merged as properties.
+ var viewOptions = ['model', 'collection', 'el', 'id', 'attributes', 'className', 'tagName'];
+
+ // Set up all inheritable **Backbone.View** properties and methods.
+ _.extend(Backbone.View.prototype, Backbone.Events, {
+
+ // The default `tagName` of a View's element is `"div"`.
+ tagName : 'div',
+
+ // Attach the `selectorDelegate` function as the `$` property.
+ $ : selectorDelegate,
+
+ // Initialize is an empty function by default. Override it with your own
+ // initialization logic.
+ initialize : function(){},
+
+ // **render** is the core function that your view should override, in order
+ // to populate its element (`this.el`), with the appropriate HTML. The
+ // convention is for **render** to always return `this`.
+ render : function() {
+ return this;
+ },
+
+ // Remove this view from the DOM. Note that the view isn't present in the
+ // DOM by default, so calling this method may be a no-op.
+ remove : function() {
+ $(this.el).remove();
+ return this;
+ },
+
+ // For small amounts of DOM Elements, where a full-blown template isn't
+ // needed, use **make** to manufacture elements, one at a time.
+ //
+ // var el = this.make('li', {'class': 'row'}, this.model.escape('title'));
+ //
+ make : function(tagName, attributes, content) {
+ var el = document.createElement(tagName);
+ if (attributes) $(el).attr(attributes);
+ if (content) $(el).html(content);
+ return el;
+ },
+
+ // Set callbacks, where `this.callbacks` is a hash of
+ //
+ // *{"event selector": "callback"}*
+ //
+ // {
+ // 'mousedown .title': 'edit',
+ // 'click .button': 'save'
+ // }
+ //
+ // pairs. Callbacks will be bound to the view, with `this` set properly.
+ // Uses event delegation for efficiency.
+ // Omitting the selector binds the event to `this.el`.
+ // This only works for delegate-able events: not `focus`, `blur`, and
+ // not `change`, `submit`, and `reset` in Internet Explorer.
+ delegateEvents : function(events) {
+ if (!(events || (events = this.events))) return;
+ if (_.isFunction(events)) events = events.call(this);
+ $(this.el).unbind('.delegateEvents' + this.cid);
+ for (var key in events) {
+ var method = this[events[key]];
+ if (!method) throw new Error('Event "' + events[key] + '" does not exist');
+ var match = key.match(eventSplitter);
+ var eventName = match[1], selector = match[2];
+ method = _.bind(method, this);
+ eventName += '.delegateEvents' + this.cid;
+ if (selector === '') {
+ $(this.el).bind(eventName, method);
+ } else {
+ $(this.el).delegate(selector, eventName, method);
+ }
+ }
+ },
+
+ // Performs the initial configuration of a View with a set of options.
+ // Keys with special meaning *(model, collection, id, className)*, are
+ // attached directly to the view.
+ _configure : function(options) {
+ if (this.options) options = _.extend({}, this.options, options);
+ for (var i = 0, l = viewOptions.length; i < l; i++) {
+ var attr = viewOptions[i];
+ if (options[attr]) this[attr] = options[attr];
+ }
+ this.options = options;
+ },
+
+ // Ensure that the View has a DOM element to render into.
+ // If `this.el` is a string, pass it through `$()`, take the first
+ // matching element, and re-assign it to `el`. Otherwise, create
+ // an element from the `id`, `className` and `tagName` proeprties.
+ _ensureElement : function() {
+ if (!this.el) {
+ var attrs = this.attributes || {};
+ if (this.id) attrs.id = this.id;
+ if (this.className) attrs['class'] = this.className;
+ this.el = this.make(this.tagName, attrs);
+ } else if (_.isString(this.el)) {
+ this.el = $(this.el).get(0);
+ }
+ }
+
+ });
+
+ // The self-propagating extend function that Backbone classes use.
+ var extend = function (protoProps, classProps) {
+ var child = inherits(this, protoProps, classProps);
+ child.extend = this.extend;
+ return child;
+ };
+
+ // Set up inheritance for the model, collection, and view.
+ Backbone.Model.extend = Backbone.Collection.extend =
+ Backbone.Router.extend = Backbone.View.extend = extend;
+
+ // Map from CRUD to HTTP for our default `Backbone.sync` implementation.
+ var methodMap = {
+ 'create': 'POST',
+ 'update': 'PUT',
+ 'delete': 'DELETE',
+ 'read' : 'GET'
+ };
+
+ // Backbone.sync
+ // -------------
+
+ // Override this function to change the manner in which Backbone persists
+ // models to the server. You will be passed the type of request, and the
+ // model in question. By default, uses makes a RESTful Ajax request
+ // to the model's `url()`. Some possible customizations could be:
+ //
+ // * Use `setTimeout` to batch rapid-fire updates into a single request.
+ // * Send up the models as XML instead of JSON.
+ // * Persist models via WebSockets instead of Ajax.
+ //
+ // Turn on `Backbone.emulateHTTP` in order to send `PUT` and `DELETE` requests
+ // as `POST`, with a `_method` parameter containing the true HTTP method,
+ // as well as all requests with the body as `application/x-www-form-urlencoded` instead of
+ // `application/json` with the model in a param named `model`.
+ // Useful when interfacing with server-side languages like **PHP** that make
+ // it difficult to read the body of `PUT` requests.
+ Backbone.sync = function(method, model, options) {
+ var type = methodMap[method];
+
+ // Default JSON-request options.
+ var params = _.extend({
+ type: type,
+ dataType: 'json'
+ }, options);
+
+ // Ensure that we have a URL.
+ if (!params.url) {
+ params.url = getUrl(model) || urlError();
+ }
+
+ // Ensure that we have the appropriate request data.
+ if (!params.data && model && (method == 'create' || method == 'update')) {
+ params.contentType = 'application/json';
+ params.data = JSON.stringify(model.toJSON());
+ }
+
+ // For older servers, emulate JSON by encoding the request into an HTML-form.
+ if (Backbone.emulateJSON) {
+ params.contentType = 'application/x-www-form-urlencoded';
+ params.data = params.data ? {model : params.data} : {};
+ }
+
+ // For older servers, emulate HTTP by mimicking the HTTP method with `_method`
+ // And an `X-HTTP-Method-Override` header.
+ if (Backbone.emulateHTTP) {
+ if (type === 'PUT' || type === 'DELETE') {
+ if (Backbone.emulateJSON) params.data._method = type;
+ params.type = 'POST';
+ params.beforeSend = function(xhr) {
+ xhr.setRequestHeader('X-HTTP-Method-Override', type);
+ };
+ }
+ }
+
+ // Don't process data on a non-GET request.
+ if (params.type !== 'GET' && !Backbone.emulateJSON) {
+ params.processData = false;
+ }
+
+ // Make the request.
+ return $.ajax(params);
+ };
+
+ // Helpers
+ // -------
+
+ // Shared empty constructor function to aid in prototype-chain creation.
+ var ctor = function(){};
+
+ // Helper function to correctly set up the prototype chain, for subclasses.
+ // Similar to `goog.inherits`, but uses a hash of prototype properties and
+ // class properties to be extended.
+ var inherits = function(parent, protoProps, staticProps) {
+ var child;
+
+ // The constructor function for the new subclass is either defined by you
+ // (the "constructor" property in your `extend` definition), or defaulted
+ // by us to simply call `super()`.
+ if (protoProps && protoProps.hasOwnProperty('constructor')) {
+ child = protoProps.constructor;
+ } else {
+ child = function(){ return parent.apply(this, arguments); };
+ }
+
+ // Inherit class (static) properties from parent.
+ _.extend(child, parent);
+
+ // Set the prototype chain to inherit from `parent`, without calling
+ // `parent`'s constructor function.
+ ctor.prototype = parent.prototype;
+ child.prototype = new ctor();
+
+ // Add prototype properties (instance properties) to the subclass,
+ // if supplied.
+ if (protoProps) _.extend(child.prototype, protoProps);
+
+ // Add static properties to the constructor function, if supplied.
+ if (staticProps) _.extend(child, staticProps);
+
+ // Correctly set child's `prototype.constructor`.
+ child.prototype.constructor = child;
+
+ // Set a convenience property in case the parent's prototype is needed later.
+ child.__super__ = parent.prototype;
+
+ return child;
+ };
+
+ // Helper function to get a URL from a Model or Collection as a property
+ // or as a function.
+ var getUrl = function(object) {
+ if (!(object && object.url)) return null;
+ return _.isFunction(object.url) ? object.url() : object.url;
+ };
+
+ // Throw an error when a URL is needed, and none is supplied.
+ var urlError = function() {
+ throw new Error('A "url" property or function must be specified');
+ };
+
+ // Wrap an optional error callback with a fallback error event.
+ var wrapError = function(onError, model, options) {
+ return function(resp) {
+ if (onError) {
+ onError(model, resp, options);
+ } else {
+ model.trigger('error', model, resp, options);
+ }
+ };
+ };
+
+ // Helper function to escape a string for HTML rendering.
+ var escapeHTML = function(string) {
+ return string.replace(/&(?!\w+;|#\d+;|#x[\da-f]+;)/gi, '&').replace(/</g, '<').replace(/>/g, '>').replace(/"/g, '"').replace(/'/g, ''').replace(/\//g,'/');
+ };
+
+}).call(this);
diff --git a/lib/beetsplug/web/static/beets.css b/lib/beetsplug/web/static/beets.css
new file mode 100644
index 00000000..2ca7fc83
--- /dev/null
+++ b/lib/beetsplug/web/static/beets.css
@@ -0,0 +1,160 @@
+body {
+ font-family: Helvetica, Arial, sans-serif;
+}
+
+#header {
+ position: fixed;
+ left: 0;
+ right: 0;
+ top: 0;
+ height: 36px;
+
+ color: white;
+
+ cursor: default;
+
+ /* shadowy border */
+ box-shadow: 0 0 20px #999;
+ -webkit-box-shadow: 0 0 20px #999;
+ -moz-box-shadow: 0 0 20px #999;
+
+ /* background gradient */
+ background: #0e0e0e;
+ background: -moz-linear-gradient(top, #6b6b6b 0%, #0e0e0e 100%);
+ background: -webkit-linear-gradient(top, #6b6b6b 0%,#0e0e0e 100%);
+}
+#header h1 {
+ font-size: 1.1em;
+ font-weight: bold;
+ color: white;
+ margin: 0.35em;
+ float: left;
+}
+
+#entities {
+ width: 17em;
+
+ position: fixed;
+ top: 36px;
+ left: 0;
+ bottom: 0;
+ margin: 0;
+
+ z-index: 1;
+ background: #dde4eb;
+
+ /* shadowy border */
+ box-shadow: 0 0 20px #666;
+ -webkit-box-shadow: 0 0 20px #666;
+ -moz-box-shadow: 0 0 20px #666;
+}
+#queryForm {
+ display: block;
+ text-align: center;
+ margin: 0.25em 0;
+}
+#query {
+ width: 95%;
+ font-size: 1em;
+}
+#entities ul {
+ width: 17em;
+
+ position: fixed;
+ top: 36px;
+ left: 0;
+ bottom: 0;
+ margin: 2.2em 0 0 0;
+ padding: 0;
+
+ overflow-y: auto;
+ overflow-x: hidden;
+}
+#entities ul li {
+ list-style: none;
+ padding: 4px 8px;
+ margin: 0;
+ cursor: default;
+}
+#entities ul li.selected {
+ background: #7abcff;
+ background: -moz-linear-gradient(top, #7abcff 0%, #60abf8 44%, #4096ee 100%);
+ background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#7abcff), color-stop(44%,#60abf8), color-stop(100%,#4096ee));
+ color: white;
+}
+#entities ul li .playing {
+ margin-left: 5px;
+ font-size: 0.9em;
+}
+
+
+#main-detail, #extra-detail {
+ position: fixed;
+ left: 17em;
+ margin: 1.0em 0 0 1.5em;
+}
+#main-detail {
+ top: 36px;
+ height: 98px;
+}
+#main-detail .artist, #main-detail .album, #main-detail .title {
+ display: block;
+}
+#main-detail .title {
+ font-size: 1.3em;
+ font-weight: bold;
+}
+#main-detail .albumtitle {
+ font-style: italic;
+}
+
+#extra-detail {
+ overflow-x: hidden;
+ overflow-y: auto;
+ top: 134px;
+ bottom: 0;
+ right: 0;
+}
+/*Fix for correctly displaying line breaks in lyrics*/
+#extra-detail .lyrics {
+ white-space: pre-wrap;
+}
+#extra-detail dl dt, #extra-detail dl dd {
+ list-style: none;
+ margin: 0;
+ padding: 0;
+}
+#extra-detail dl dt {
+ width: 10em;
+ float: left;
+ text-align: right;
+ font-weight: bold;
+ clear: both;
+}
+#extra-detail dl dd {
+ margin-left: 10.5em;
+}
+
+
+#player {
+ float: left;
+ width: 150px;
+ height: 36px;
+}
+#player .play, #player .pause, #player .disabled {
+ -webkit-appearance: none;
+ font-size: 1em;
+ font-family: Helvetica, Arial, sans-serif;
+ background: none;
+ border: none;
+ color: white;
+ padding: 5px;
+ margin: 0;
+ text-align: center;
+
+ width: 36px;
+ height: 36px;
+}
+#player .disabled {
+ color: #666;
+}
diff --git a/lib/beetsplug/web/static/beets.js b/lib/beetsplug/web/static/beets.js
new file mode 100644
index 00000000..97af7011
--- /dev/null
+++ b/lib/beetsplug/web/static/beets.js
@@ -0,0 +1,314 @@
+// Format times as minutes and seconds.
+var timeFormat = function(secs) {
+ if (secs == undefined || isNaN(secs)) {
+ return '0:00';
+ }
+ secs = Math.round(secs);
+ var mins = '' + Math.floor(secs / 60);
+ secs = '' + (secs % 60);
+ if (secs.length < 2) {
+ secs = '0' + secs;
+ }
+ return mins + ':' + secs;
+}
+
+// jQuery extension encapsulating event hookups for audio element controls.
+$.fn.player = function(debug) {
+ // Selected element should contain an HTML5 Audio element.
+ var audio = $('audio', this).get(0);
+
+ // Control elements that may be present, identified by class.
+ var playBtn = $('.play', this);
+ var pauseBtn = $('.pause', this);
+ var disabledInd = $('.disabled', this);
+ var timesEl = $('.times', this);
+ var curTimeEl = $('.currentTime', this);
+ var totalTimeEl = $('.totalTime', this);
+ var sliderPlayedEl = $('.slider .played', this);
+ var sliderLoadedEl = $('.slider .loaded', this);
+
+ // Button events.
+ playBtn.click(function() {
+ audio.play();
+ });
+ pauseBtn.click(function(ev) {
+ audio.pause();
+ });
+
+ // Utilities.
+ var timePercent = function(cur, total) {
+ if (cur == undefined || isNaN(cur) ||
+ total == undefined || isNaN(total) || total == 0) {
+ return 0;
+ }
+ var ratio = cur / total;
+ if (ratio > 1.0) {
+ ratio = 1.0;
+ }
+ return (Math.round(ratio * 10000) / 100) + '%';
+ }
+
+ // Event helpers.
+ var dbg = function(msg) {
+ if (debug)
+ console.log(msg);
+ }
+ var showState = function() {
+ if (audio.duration == undefined || isNaN(audio.duration)) {
+ playBtn.hide();
+ pauseBtn.hide();
+ disabledInd.show();
+ timesEl.hide();
+ } else if (audio.paused) {
+ playBtn.show();
+ pauseBtn.hide();
+ disabledInd.hide();
+ timesEl.show();
+ } else {
+ playBtn.hide();
+ pauseBtn.show();
+ disabledInd.hide();
+ timesEl.show();
+ }
+ }
+ var showTimes = function() {
+ curTimeEl.text(timeFormat(audio.currentTime));
+ totalTimeEl.text(timeFormat(audio.duration));
+
+ sliderPlayedEl.css('width',
+ timePercent(audio.currentTime, audio.duration));
+
+ // last time buffered
+ var bufferEnd = 0;
+ for (var i = 0; i < audio.buffered.length; ++i) {
+ if (audio.buffered.end(i) > bufferEnd)
+ bufferEnd = audio.buffered.end(i);
+ }
+ sliderLoadedEl.css('width',
+ timePercent(bufferEnd, audio.duration));
+ }
+
+ // Initialize controls.
+ showState();
+ showTimes();
+
+ // Bind events.
+ $('audio', this).bind({
+ playing: function() {
+ dbg('playing');
+ showState();
+ },
+ pause: function() {
+ dbg('pause');
+ showState();
+ },
+ ended: function() {
+ dbg('ended');
+ showState();
+ },
+ progress: function() {
+ dbg('progress ' + audio.buffered);
+ },
+ timeupdate: function() {
+ dbg('timeupdate ' + audio.currentTime);
+ showTimes();
+ },
+ durationchange: function() {
+ dbg('durationchange ' + audio.duration);
+ showState();
+ showTimes();
+ },
+ loadeddata: function() {
+ dbg('loadeddata');
+ },
+ loadedmetadata: function() {
+ dbg('loadedmetadata');
+ }
+ });
+}
+
+// Simple selection disable for jQuery.
+// Cut-and-paste from:
+// https://stackoverflow.com/questions/2700000
+$.fn.disableSelection = function() {
+ $(this).attr('unselectable', 'on')
+ .css('-moz-user-select', 'none')
+ .each(function() {
+ this.onselectstart = function() { return false; };
+ });
+};
+
+$(function() {
+
+// Routes.
+var BeetsRouter = Backbone.Router.extend({
+ routes: {
+ "item/query/:query": "itemQuery",
+ },
+ itemQuery: function(query) {
+ var queryURL = query.split(/\s+/).map(encodeURIComponent).join('/');
+ $.getJSON('item/query/' + queryURL, function(data) {
+ var models = _.map(
+ data['results'],
+ function(d) { return new Item(d); }
+ );
+ var results = new Items(models);
+ app.showItems(results);
+ });
+ }
+});
+var router = new BeetsRouter();
+
+// Model.
+var Item = Backbone.Model.extend({
+ urlRoot: 'item'
+});
+var Items = Backbone.Collection.extend({
+ model: Item
+});
+
+// Item views.
+var ItemEntryView = Backbone.View.extend({
+ tagName: "li",
+ template: _.template($('#item-entry-template').html()),
+ events: {
+ 'click': 'select',
+ 'dblclick': 'play'
+ },
+ initialize: function() {
+ this.playing = false;
+ },
+ render: function() {
+ $(this.el).html(this.template(this.model.toJSON()));
+ this.setPlaying(this.playing);
+ return this;
+ },
+ select: function() {
+ app.selectItem(this);
+ },
+ play: function() {
+ app.playItem(this.model);
+ },
+ setPlaying: function(val) {
+ this.playing = val;
+ if (val)
+ this.$('.playing').show();
+ else
+ this.$('.playing').hide();
+ }
+});
+//Holds Title, Artist, Album etc.
+var ItemMainDetailView = Backbone.View.extend({
+ tagName: "div",
+ template: _.template($('#item-main-detail-template').html()),
+ events: {
+ 'click .play': 'play',
+ },
+ render: function() {
+ $(this.el).html(this.template(this.model.toJSON()));
+ return this;
+ },
+ play: function() {
+ app.playItem(this.model);
+ }
+});
+// Holds Track no., Format, MusicBrainz link, Lyrics, Comments etc.
+var ItemExtraDetailView = Backbone.View.extend({
+ tagName: "div",
+ template: _.template($('#item-extra-detail-template').html()),
+ render: function() {
+ $(this.el).html(this.template(this.model.toJSON()));
+ return this;
+ }
+});
+// Main app view.
+var AppView = Backbone.View.extend({
+ el: $('body'),
+ events: {
+ 'submit #queryForm': 'querySubmit',
+ },
+ querySubmit: function(ev) {
+ ev.preventDefault();
+ router.navigate('item/query/' + encodeURIComponent($('#query').val()), true);
+ },
+ initialize: function() {
+ this.playingItem = null;
+ this.shownItems = null;
+
+ // Not sure why these events won't bind automatically.
+ this.$('audio').bind({
+ 'play': _.bind(this.audioPlay, this),
+ 'pause': _.bind(this.audioPause, this),
+ 'ended': _.bind(this.audioEnded, this)
+ });
+ },
+ showItems: function(items) {
+ this.shownItems = items;
+ $('#results').empty();
+ items.each(function(item) {
+ var view = new ItemEntryView({model: item});
+ item.entryView = view;
+ $('#results').append(view.render().el);
+ });
+ },
+ selectItem: function(view) {
+ // Mark row as selected.
+ $('#results li').removeClass("selected");
+ $(view.el).addClass("selected");
+
+ // Show main and extra detail.
+ var mainDetailView = new ItemMainDetailView({model: view.model});
+ $('#main-detail').empty().append(mainDetailView.render().el);
+
+ var extraDetailView = new ItemExtraDetailView({model: view.model});
+ $('#extra-detail').empty().append(extraDetailView.render().el);
+ },
+ playItem: function(item) {
+ var url = 'item/' + item.get('id') + '/file';
+ $('#player audio').attr('src', url);
+ $('#player audio').get(0).play();
+
+ if (this.playingItem != null) {
+ this.playingItem.entryView.setPlaying(false);
+ }
+ item.entryView.setPlaying(true);
+ this.playingItem = item;
+ },
+
+ audioPause: function() {
+ this.playingItem.entryView.setPlaying(false);
+ },
+ audioPlay: function() {
+ if (this.playingItem != null)
+ this.playingItem.entryView.setPlaying(true);
+ },
+ audioEnded: function() {
+ this.playingItem.entryView.setPlaying(false);
+
+ // Try to play the next track.
+ var idx = this.shownItems.indexOf(this.playingItem);
+ if (idx == -1) {
+ // Not in current list.
+ return;
+ }
+ var nextIdx = idx + 1;
+ if (nextIdx >= this.shownItems.size()) {
+ // End of list.
+ return;
+ }
+ this.playItem(this.shownItems.at(nextIdx));
+ }
+});
+var app = new AppView();
+
+// App setup.
+Backbone.history.start({pushState: false});
+
+// Disable selection on UI elements.
+$('#entities ul').disableSelection();
+$('#header').disableSelection();
+
+// Audio player setup.
+$('#player').player();
+
+});
diff --git a/lib/beetsplug/web/static/jquery.js b/lib/beetsplug/web/static/jquery.js
new file mode 100644
index 00000000..e1414212
--- /dev/null
+++ b/lib/beetsplug/web/static/jquery.js
@@ -0,0 +1,9266 @@
+/*!
+ * jQuery JavaScript Library v1.7.1
+ * http://jquery.com/
+ *
+ * Copyright 2016, John Resig
+ * Dual licensed under the MIT or GPL Version 2 licenses.
+ * http://jquery.org/license
+ *
+ * Includes Sizzle.js
+ * http://sizzlejs.com/
+ * Copyright 2016, The Dojo Foundation
+ * Released under the MIT, BSD, and GPL Licenses.
+ *
+ * Date: Mon Nov 21 21:11:03 2011 -0500
+ */
+(function( window, undefined ) {
+
+// Use the correct document accordingly with window argument (sandbox)
+var document = window.document,
+ navigator = window.navigator,
+ location = window.location;
+var jQuery = (function() {
+
+// Define a local copy of jQuery
+var jQuery = function( selector, context ) {
+ // The jQuery object is actually just the init constructor 'enhanced'
+ return new jQuery.fn.init( selector, context, rootjQuery );
+ },
+
+ // Map over jQuery in case of overwrite
+ _jQuery = window.jQuery,
+
+ // Map over the $ in case of overwrite
+ _$ = window.$,
+
+ // A central reference to the root jQuery(document)
+ rootjQuery,
+
+ // A simple way to check for HTML strings or ID strings
+ // Prioritize #id over <tag> to avoid XSS via location.hash (#9521)
+ quickExpr = /^(?:[^#<]*(<[\w\W]+>)[^>]*$|#([\w\-]*)$)/,
+
+ // Check if a string has a non-whitespace character in it
+ rnotwhite = /\S/,
+
+ // Used for trimming whitespace
+ trimLeft = /^\s+/,
+ trimRight = /\s+$/,
+
+ // Match a standalone tag
+ rsingleTag = /^<(\w+)\s*\/?>(?:<\/\1>)?$/,
+
+ // JSON RegExp
+ rvalidchars = /^[\],:{}\s]*$/,
+ rvalidescape = /\\(?:["\\\/bfnrt]|u[0-9a-fA-F]{4})/g,
+ rvalidtokens = /"[^"\\\n\r]*"|true|false|null|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/g,
+ rvalidbraces = /(?:^|:|,)(?:\s*\[)+/g,
+
+ // Useragent RegExp
+ rwebkit = /(webkit)[ \/]([\w.]+)/,
+ ropera = /(opera)(?:.*version)?[ \/]([\w.]+)/,
+ rmsie = /(msie) ([\w.]+)/,
+ rmozilla = /(mozilla)(?:.*? rv:([\w.]+))?/,
+
+ // Matches dashed string for camelizing
+ rdashAlpha = /-([a-z]|[0-9])/ig,
+ rmsPrefix = /^-ms-/,
+
+ // Used by jQuery.camelCase as callback to replace()
+ fcamelCase = function( all, letter ) {
+ return ( letter + "" ).toUpperCase();
+ },
+
+ // Keep a UserAgent string for use with jQuery.browser
+ userAgent = navigator.userAgent,
+
+ // For matching the engine and version of the browser
+ browserMatch,
+
+ // The deferred used on DOM ready
+ readyList,
+
+ // The ready event handler
+ DOMContentLoaded,
+
+ // Save a reference to some core methods
+ toString = Object.prototype.toString,
+ hasOwn = Object.prototype.hasOwnProperty,
+ push = Array.prototype.push,
+ slice = Array.prototype.slice,
+ trim = String.prototype.trim,
+ indexOf = Array.prototype.indexOf,
+
+ // [[Class]] -> type pairs
+ class2type = {};
+
+jQuery.fn = jQuery.prototype = {
+ constructor: jQuery,
+ init: function( selector, context, rootjQuery ) {
+ var match, elem, ret, doc;
+
+ // Handle $(""), $(null), or $(undefined)
+ if ( !selector ) {
+ return this;
+ }
+
+ // Handle $(DOMElement)
+ if ( selector.nodeType ) {
+ this.context = this[0] = selector;
+ this.length = 1;
+ return this;
+ }
+
+ // The body element only exists once, optimize finding it
+ if ( selector === "body" && !context && document.body ) {
+ this.context = document;
+ this[0] = document.body;
+ this.selector = selector;
+ this.length = 1;
+ return this;
+ }
+
+ // Handle HTML strings
+ if ( typeof selector === "string" ) {
+ // Are we dealing with HTML string or an ID?
+ if ( selector.charAt(0) === "<" && selector.charAt( selector.length - 1 ) === ">" && selector.length >= 3 ) {
+ // Assume that strings that start and end with <> are HTML and skip the regex check
+ match = [ null, selector, null ];
+
+ } else {
+ match = quickExpr.exec( selector );
+ }
+
+ // Verify a match, and that no context was specified for #id
+ if ( match && (match[1] || !context) ) {
+
+ // HANDLE: $(html) -> $(array)
+ if ( match[1] ) {
+ context = context instanceof jQuery ? context[0] : context;
+ doc = ( context ? context.ownerDocument || context : document );
+
+ // If a single string is passed in and it's a single tag
+ // just do a createElement and skip the rest
+ ret = rsingleTag.exec( selector );
+
+ if ( ret ) {
+ if ( jQuery.isPlainObject( context ) ) {
+ selector = [ document.createElement( ret[1] ) ];
+ jQuery.fn.attr.call( selector, context, true );
+
+ } else {
+ selector = [ doc.createElement( ret[1] ) ];
+ }
+
+ } else {
+ ret = jQuery.buildFragment( [ match[1] ], [ doc ] );
+ selector = ( ret.cacheable ? jQuery.clone(ret.fragment) : ret.fragment ).childNodes;
+ }
+
+ return jQuery.merge( this, selector );
+
+ // HANDLE: $("#id")
+ } else {
+ elem = document.getElementById( match[2] );
+
+ // Check parentNode to catch when Blackberry 4.6 returns
+ // nodes that are no longer in the document #6963
+ if ( elem && elem.parentNode ) {
+ // Handle the case where IE and Opera return items
+ // by name instead of ID
+ if ( elem.id !== match[2] ) {
+ return rootjQuery.find( selector );
+ }
+
+ // Otherwise, we inject the element directly into the jQuery object
+ this.length = 1;
+ this[0] = elem;
+ }
+
+ this.context = document;
+ this.selector = selector;
+ return this;
+ }
+
+ // HANDLE: $(expr, $(...))
+ } else if ( !context || context.jquery ) {
+ return ( context || rootjQuery ).find( selector );
+
+ // HANDLE: $(expr, context)
+ // (which is just equivalent to: $(context).find(expr)
+ } else {
+ return this.constructor( context ).find( selector );
+ }
+
+ // HANDLE: $(function)
+ // Shortcut for document ready
+ } else if ( jQuery.isFunction( selector ) ) {
+ return rootjQuery.ready( selector );
+ }
+
+ if ( selector.selector !== undefined ) {
+ this.selector = selector.selector;
+ this.context = selector.context;
+ }
+
+ return jQuery.makeArray( selector, this );
+ },
+
+ // Start with an empty selector
+ selector: "",
+
+ // The current version of jQuery being used
+ jquery: "1.7.1",
+
+ // The default length of a jQuery object is 0
+ length: 0,
+
+ // The number of elements contained in the matched element set
+ size: function() {
+ return this.length;
+ },
+
+ toArray: function() {
+ return slice.call( this, 0 );
+ },
+
+ // Get the Nth element in the matched element set OR
+ // Get the whole matched element set as a clean array
+ get: function( num ) {
+ return num == null ?
+
+ // Return a 'clean' array
+ this.toArray() :
+
+ // Return just the object
+ ( num < 0 ? this[ this.length + num ] : this[ num ] );
+ },
+
+ // Take an array of elements and push it onto the stack
+ // (returning the new matched element set)
+ pushStack: function( elems, name, selector ) {
+ // Build a new jQuery matched element set
+ var ret = this.constructor();
+
+ if ( jQuery.isArray( elems ) ) {
+ push.apply( ret, elems );
+
+ } else {
+ jQuery.merge( ret, elems );
+ }
+
+ // Add the old object onto the stack (as a reference)
+ ret.prevObject = this;
+
+ ret.context = this.context;
+
+ if ( name === "find" ) {
+ ret.selector = this.selector + ( this.selector ? " " : "" ) + selector;
+ } else if ( name ) {
+ ret.selector = this.selector + "." + name + "(" + selector + ")";
+ }
+
+ // Return the newly-formed element set
+ return ret;
+ },
+
+ // Execute a callback for every element in the matched set.
+ // (You can seed the arguments with an array of args, but this is
+ // only used internally.)
+ each: function( callback, args ) {
+ return jQuery.each( this, callback, args );
+ },
+
+ ready: function( fn ) {
+ // Attach the listeners
+ jQuery.bindReady();
+
+ // Add the callback
+ readyList.add( fn );
+
+ return this;
+ },
+
+ eq: function( i ) {
+ i = +i;
+ return i === -1 ?
+ this.slice( i ) :
+ this.slice( i, i + 1 );
+ },
+
+ first: function() {
+ return this.eq( 0 );
+ },
+
+ last: function() {
+ return this.eq( -1 );
+ },
+
+ slice: function() {
+ return this.pushStack( slice.apply( this, arguments ),
+ "slice", slice.call(arguments).join(",") );
+ },
+
+ map: function( callback ) {
+ return this.pushStack( jQuery.map(this, function( elem, i ) {
+ return callback.call( elem, i, elem );
+ }));
+ },
+
+ end: function() {
+ return this.prevObject || this.constructor(null);
+ },
+
+ // For internal use only.
+ // Behaves like an Array's method, not like a jQuery method.
+ push: push,
+ sort: [].sort,
+ splice: [].splice
+};
+
+// Give the init function the jQuery prototype for later instantiation
+jQuery.fn.init.prototype = jQuery.fn;
+
+jQuery.extend = jQuery.fn.extend = function() {
+ var options, name, src, copy, copyIsArray, clone,
+ target = arguments[0] || {},
+ i = 1,
+ length = arguments.length,
+ deep = false;
+
+ // Handle a deep copy situation
+ if ( typeof target === "boolean" ) {
+ deep = target;
+ target = arguments[1] || {};
+ // skip the boolean and the target
+ i = 2;
+ }
+
+ // Handle case when target is a string or something (possible in deep copy)
+ if ( typeof target !== "object" && !jQuery.isFunction(target) ) {
+ target = {};
+ }
+
+ // extend jQuery itself if only one argument is passed
+ if ( length === i ) {
+ target = this;
+ --i;
+ }
+
+ for ( ; i < length; i++ ) {
+ // Only deal with non-null/undefined values
+ if ( (options = arguments[ i ]) != null ) {
+ // Extend the base object
+ for ( name in options ) {
+ src = target[ name ];
+ copy = options[ name ];
+
+ // Prevent never-ending loop
+ if ( target === copy ) {
+ continue;
+ }
+
+ // Recurse if we're merging plain objects or arrays
+ if ( deep && copy && ( jQuery.isPlainObject(copy) || (copyIsArray = jQuery.isArray(copy)) ) ) {
+ if ( copyIsArray ) {
+ copyIsArray = false;
+ clone = src && jQuery.isArray(src) ? src : [];
+
+ } else {
+ clone = src && jQuery.isPlainObject(src) ? src : {};
+ }
+
+ // Never move original objects, clone them
+ target[ name ] = jQuery.extend( deep, clone, copy );
+
+ // Don't bring in undefined values
+ } else if ( copy !== undefined ) {
+ target[ name ] = copy;
+ }
+ }
+ }
+ }
+
+ // Return the modified object
+ return target;
+};
+
+jQuery.extend({
+ noConflict: function( deep ) {
+ if ( window.$ === jQuery ) {
+ window.$ = _$;
+ }
+
+ if ( deep && window.jQuery === jQuery ) {
+ window.jQuery = _jQuery;
+ }
+
+ return jQuery;
+ },
+
+ // Is the DOM ready to be used? Set to true once it occurs.
+ isReady: false,
+
+ // A counter to track how many items to wait for before
+ // the ready event fires. See #6781
+ readyWait: 1,
+
+ // Hold (or release) the ready event
+ holdReady: function( hold ) {
+ if ( hold ) {
+ jQuery.readyWait++;
+ } else {
+ jQuery.ready( true );
+ }
+ },
+
+ // Handle when the DOM is ready
+ ready: function( wait ) {
+ // Either a released hold or an DOMready/load event and not yet ready
+ if ( (wait === true && !--jQuery.readyWait) || (wait !== true && !jQuery.isReady) ) {
+ // Make sure body exists, at least, in case IE gets a little overzealous (ticket #5443).
+ if ( !document.body ) {
+ return setTimeout( jQuery.ready, 1 );
+ }
+
+ // Remember that the DOM is ready
+ jQuery.isReady = true;
+
+ // If a normal DOM Ready event fired, decrement, and wait if need be
+ if ( wait !== true && --jQuery.readyWait > 0 ) {
+ return;
+ }
+
+ // If there are functions bound, to execute
+ readyList.fireWith( document, [ jQuery ] );
+
+ // Trigger any bound ready events
+ if ( jQuery.fn.trigger ) {
+ jQuery( document ).trigger( "ready" ).off( "ready" );
+ }
+ }
+ },
+
+ bindReady: function() {
+ if ( readyList ) {
+ return;
+ }
+
+ readyList = jQuery.Callbacks( "once memory" );
+
+ // Catch cases where $(document).ready() is called after the
+ // browser event has already occurred.
+ if ( document.readyState === "complete" ) {
+ // Handle it asynchronously to allow scripts the opportunity to delay ready
+ return setTimeout( jQuery.ready, 1 );
+ }
+
+ // Mozilla, Opera and webkit nightlies currently support this event
+ if ( document.addEventListener ) {
+ // Use the handy event callback
+ document.addEventListener( "DOMContentLoaded", DOMContentLoaded, false );
+
+ // A fallback to window.onload, that will always work
+ window.addEventListener( "load", jQuery.ready, false );
+
+ // If IE event model is used
+ } else if ( document.attachEvent ) {
+ // ensure firing before onload,
+ // maybe late but safe also for iframes
+ document.attachEvent( "onreadystatechange", DOMContentLoaded );
+
+ // A fallback to window.onload, that will always work
+ window.attachEvent( "onload", jQuery.ready );
+
+ // If IE and not a frame
+ // continually check to see if the document is ready
+ var toplevel = false;
+
+ try {
+ toplevel = window.frameElement == null;
+ } catch(e) {}
+
+ if ( document.documentElement.doScroll && toplevel ) {
+ doScrollCheck();
+ }
+ }
+ },
+
+ // See test/unit/core.js for details concerning isFunction.
+ // Since version 1.3, DOM methods and functions like alert
+ // aren't supported. They return false on IE (#2968).
+ isFunction: function( obj ) {
+ return jQuery.type(obj) === "function";
+ },
+
+ isArray: Array.isArray || function( obj ) {
+ return jQuery.type(obj) === "array";
+ },
+
+ // A crude way of determining if an object is a window
+ isWindow: function( obj ) {
+ return obj && typeof obj === "object" && "setInterval" in obj;
+ },
+
+ isNumeric: function( obj ) {
+ return !isNaN( parseFloat(obj) ) && isFinite( obj );
+ },
+
+ type: function( obj ) {
+ return obj == null ?
+ String( obj ) :
+ class2type[ toString.call(obj) ] || "object";
+ },
+
+ isPlainObject: function( obj ) {
+ // Must be an Object.
+ // Because of IE, we also have to check the presence of the constructor property.
+ // Make sure that DOM nodes and window objects don't pass through, as well
+ if ( !obj || jQuery.type(obj) !== "object" || obj.nodeType || jQuery.isWindow( obj ) ) {
+ return false;
+ }
+
+ try {
+ // Not own constructor property must be Object
+ if ( obj.constructor &&
+ !hasOwn.call(obj, "constructor") &&
+ !hasOwn.call(obj.constructor.prototype, "isPrototypeOf") ) {
+ return false;
+ }
+ } catch ( e ) {
+ // IE8,9 Will throw exceptions on certain host objects #9897
+ return false;
+ }
+
+ // Own properties are enumerated firstly, so to speed up,
+ // if last one is own, then all properties are own.
+
+ var key;
+ for ( key in obj ) {}
+
+ return key === undefined || hasOwn.call( obj, key );
+ },
+
+ isEmptyObject: function( obj ) {
+ for ( var name in obj ) {
+ return false;
+ }
+ return true;
+ },
+
+ error: function( msg ) {
+ throw new Error( msg );
+ },
+
+ parseJSON: function( data ) {
+ if ( typeof data !== "string" || !data ) {
+ return null;
+ }
+
+ // Make sure leading/trailing whitespace is removed (IE can't handle it)
+ data = jQuery.trim( data );
+
+ // Attempt to parse using the native JSON parser first
+ if ( window.JSON && window.JSON.parse ) {
+ return window.JSON.parse( data );
+ }
+
+ // Make sure the incoming data is actual JSON
+ // Logic borrowed from http://json.org/json2.js
+ if ( rvalidchars.test( data.replace( rvalidescape, "@" )
+ .replace( rvalidtokens, "]" )
+ .replace( rvalidbraces, "")) ) {
+
+ return ( new Function( "return " + data ) )();
+
+ }
+ jQuery.error( "Invalid JSON: " + data );
+ },
+
+ // Cross-browser xml parsing
+ parseXML: function( data ) {
+ var xml, tmp;
+ try {
+ if ( window.DOMParser ) { // Standard
+ tmp = new DOMParser();
+ xml = tmp.parseFromString( data , "text/xml" );
+ } else { // IE
+ xml = new ActiveXObject( "Microsoft.XMLDOM" );
+ xml.async = "false";
+ xml.loadXML( data );
+ }
+ } catch( e ) {
+ xml = undefined;
+ }
+ if ( !xml || !xml.documentElement || xml.getElementsByTagName( "parsererror" ).length ) {
+ jQuery.error( "Invalid XML: " + data );
+ }
+ return xml;
+ },
+
+ noop: function() {},
+
+ // Evaluates a script in a global context
+ // Workarounds based on findings by Jim Driscoll
+ // http://weblogs.java.net/blog/driscoll/archive/2009/09/08/eval-javascript-global-context
+ globalEval: function( data ) {
+ if ( data && rnotwhite.test( data ) ) {
+ // We use execScript on Internet Explorer
+ // We use an anonymous function so that context is window
+ // rather than jQuery in Firefox
+ ( window.execScript || function( data ) {
+ window[ "eval" ].call( window, data );
+ } )( data );
+ }
+ },
+
+ // Convert dashed to camelCase; used by the css and data modules
+ // Microsoft forgot to hump their vendor prefix (#9572)
+ camelCase: function( string ) {
+ return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase );
+ },
+
+ nodeName: function( elem, name ) {
+ return elem.nodeName && elem.nodeName.toUpperCase() === name.toUpperCase();
+ },
+
+ // args is for internal usage only
+ each: function( object, callback, args ) {
+ var name, i = 0,
+ length = object.length,
+ isObj = length === undefined || jQuery.isFunction( object );
+
+ if ( args ) {
+ if ( isObj ) {
+ for ( name in object ) {
+ if ( callback.apply( object[ name ], args ) === false ) {
+ break;
+ }
+ }
+ } else {
+ for ( ; i < length; ) {
+ if ( callback.apply( object[ i++ ], args ) === false ) {
+ break;
+ }
+ }
+ }
+
+ // A special, fast, case for the most common use of each
+ } else {
+ if ( isObj ) {
+ for ( name in object ) {
+ if ( callback.call( object[ name ], name, object[ name ] ) === false ) {
+ break;
+ }
+ }
+ } else {
+ for ( ; i < length; ) {
+ if ( callback.call( object[ i ], i, object[ i++ ] ) === false ) {
+ break;
+ }
+ }
+ }
+ }
+
+ return object;
+ },
+
+ // Use native String.trim function wherever possible
+ trim: trim ?
+ function( text ) {
+ return text == null ?
+ "" :
+ trim.call( text );
+ } :
+
+ // Otherwise use our own trimming functionality
+ function( text ) {
+ return text == null ?
+ "" :
+ text.toString().replace( trimLeft, "" ).replace( trimRight, "" );
+ },
+
+ // results is for internal usage only
+ makeArray: function( array, results ) {
+ var ret = results || [];
+
+ if ( array != null ) {
+ // The window, strings (and functions) also have 'length'
+ // Tweaked logic slightly to handle Blackberry 4.7 RegExp issues #6930
+ var type = jQuery.type( array );
+
+ if ( array.length == null || type === "string" || type === "function" || type === "regexp" || jQuery.isWindow( array ) ) {
+ push.call( ret, array );
+ } else {
+ jQuery.merge( ret, array );
+ }
+ }
+
+ return ret;
+ },
+
+ inArray: function( elem, array, i ) {
+ var len;
+
+ if ( array ) {
+ if ( indexOf ) {
+ return indexOf.call( array, elem, i );
+ }
+
+ len = array.length;
+ i = i ? i < 0 ? Math.max( 0, len + i ) : i : 0;
+
+ for ( ; i < len; i++ ) {
+ // Skip accessing in sparse arrays
+ if ( i in array && array[ i ] === elem ) {
+ return i;
+ }
+ }
+ }
+
+ return -1;
+ },
+
+ merge: function( first, second ) {
+ var i = first.length,
+ j = 0;
+
+ if ( typeof second.length === "number" ) {
+ for ( var l = second.length; j < l; j++ ) {
+ first[ i++ ] = second[ j ];
+ }
+
+ } else {
+ while ( second[j] !== undefined ) {
+ first[ i++ ] = second[ j++ ];
+ }
+ }
+
+ first.length = i;
+
+ return first;
+ },
+
+ grep: function( elems, callback, inv ) {
+ var ret = [], retVal;
+ inv = !!inv;
+
+ // Go through the array, only saving the items
+ // that pass the validator function
+ for ( var i = 0, length = elems.length; i < length; i++ ) {
+ retVal = !!callback( elems[ i ], i );
+ if ( inv !== retVal ) {
+ ret.push( elems[ i ] );
+ }
+ }
+
+ return ret;
+ },
+
+ // arg is for internal usage only
+ map: function( elems, callback, arg ) {
+ var value, key, ret = [],
+ i = 0,
+ length = elems.length,
+ // jquery objects are treated as arrays
+ isArray = elems instanceof jQuery || length !== undefined && typeof length === "number" && ( ( length > 0 && elems[ 0 ] && elems[ length -1 ] ) || length === 0 || jQuery.isArray( elems ) ) ;
+
+ // Go through the array, translating each of the items to their
+ if ( isArray ) {
+ for ( ; i < length; i++ ) {
+ value = callback( elems[ i ], i, arg );
+
+ if ( value != null ) {
+ ret[ ret.length ] = value;
+ }
+ }
+
+ // Go through every key on the object,
+ } else {
+ for ( key in elems ) {
+ value = callback( elems[ key ], key, arg );
+
+ if ( value != null ) {
+ ret[ ret.length ] = value;
+ }
+ }
+ }
+
+ // Flatten any nested arrays
+ return ret.concat.apply( [], ret );
+ },
+
+ // A global GUID counter for objects
+ guid: 1,
+
+ // Bind a function to a context, optionally partially applying any
+ // arguments.
+ proxy: function( fn, context ) {
+ if ( typeof context === "string" ) {
+ var tmp = fn[ context ];
+ context = fn;
+ fn = tmp;
+ }
+
+ // Quick check to determine if target is callable, in the spec
+ // this throws a TypeError, but we will just return undefined.
+ if ( !jQuery.isFunction( fn ) ) {
+ return undefined;
+ }
+
+ // Simulated bind
+ var args = slice.call( arguments, 2 ),
+ proxy = function() {
+ return fn.apply( context, args.concat( slice.call( arguments ) ) );
+ };
+
+ // Set the guid of unique handler to the same of original handler, so it can be removed
+ proxy.guid = fn.guid = fn.guid || proxy.guid || jQuery.guid++;
+
+ return proxy;
+ },
+
+ // Mutifunctional method to get and set values to a collection
+ // The value/s can optionally be executed if it's a function
+ access: function( elems, key, value, exec, fn, pass ) {
+ var length = elems.length;
+
+ // Setting many attributes
+ if ( typeof key === "object" ) {
+ for ( var k in key ) {
+ jQuery.access( elems, k, key[k], exec, fn, value );
+ }
+ return elems;
+ }
+
+ // Setting one attribute
+ if ( value !== undefined ) {
+ // Optionally, function values get executed if exec is true
+ exec = !pass && exec && jQuery.isFunction(value);
+
+ for ( var i = 0; i < length; i++ ) {
+ fn( elems[i], key, exec ? value.call( elems[i], i, fn( elems[i], key ) ) : value, pass );
+ }
+
+ return elems;
+ }
+
+ // Getting an attribute
+ return length ? fn( elems[0], key ) : undefined;
+ },
+
+ now: function() {
+ return ( new Date() ).getTime();
+ },
+
+ // Use of jQuery.browser is frowned upon.
+ // More details: http://docs.jquery.com/Utilities/jQuery.browser
+ uaMatch: function( ua ) {
+ ua = ua.toLowerCase();
+
+ var match = rwebkit.exec( ua ) ||
+ ropera.exec( ua ) ||
+ rmsie.exec( ua ) ||
+ ua.indexOf("compatible") < 0 && rmozilla.exec( ua ) ||
+ [];
+
+ return { browser: match[1] || "", version: match[2] || "0" };
+ },
+
+ sub: function() {
+ function jQuerySub( selector, context ) {
+ return new jQuerySub.fn.init( selector, context );
+ }
+ jQuery.extend( true, jQuerySub, this );
+ jQuerySub.superclass = this;
+ jQuerySub.fn = jQuerySub.prototype = this();
+ jQuerySub.fn.constructor = jQuerySub;
+ jQuerySub.sub = this.sub;
+ jQuerySub.fn.init = function init( selector, context ) {
+ if ( context && context instanceof jQuery && !(context instanceof jQuerySub) ) {
+ context = jQuerySub( context );
+ }
+
+ return jQuery.fn.init.call( this, selector, context, rootjQuerySub );
+ };
+ jQuerySub.fn.init.prototype = jQuerySub.fn;
+ var rootjQuerySub = jQuerySub(document);
+ return jQuerySub;
+ },
+
+ browser: {}
+});
+
+// Populate the class2type map
+jQuery.each("Boolean Number String Function Array Date RegExp Object".split(" "), function(i, name) {
+ class2type[ "[object " + name + "]" ] = name.toLowerCase();
+});
+
+browserMatch = jQuery.uaMatch( userAgent );
+if ( browserMatch.browser ) {
+ jQuery.browser[ browserMatch.browser ] = true;
+ jQuery.browser.version = browserMatch.version;
+}
+
+// Deprecated, use jQuery.browser.webkit instead
+if ( jQuery.browser.webkit ) {
+ jQuery.browser.safari = true;
+}
+
+// IE doesn't match non-breaking spaces with \s
+if ( rnotwhite.test( "\xA0" ) ) {
+ trimLeft = /^[\s\xA0]+/;
+ trimRight = /[\s\xA0]+$/;
+}
+
+// All jQuery objects should point back to these
+rootjQuery = jQuery(document);
+
+// Cleanup functions for the document ready method
+if ( document.addEventListener ) {
+ DOMContentLoaded = function() {
+ document.removeEventListener( "DOMContentLoaded", DOMContentLoaded, false );
+ jQuery.ready();
+ };
+
+} else if ( document.attachEvent ) {
+ DOMContentLoaded = function() {
+ // Make sure body exists, at least, in case IE gets a little overzealous (ticket #5443).
+ if ( document.readyState === "complete" ) {
+ document.detachEvent( "onreadystatechange", DOMContentLoaded );
+ jQuery.ready();
+ }
+ };
+}
+
+// The DOM ready check for Internet Explorer
+function doScrollCheck() {
+ if ( jQuery.isReady ) {
+ return;
+ }
+
+ try {
+ // If IE is used, use the trick by Diego Perini
+ // http://javascript.nwbox.com/IEContentLoaded/
+ document.documentElement.doScroll("left");
+ } catch(e) {
+ setTimeout( doScrollCheck, 1 );
+ return;
+ }
+
+ // and execute any waiting functions
+ jQuery.ready();
+}
+
+return jQuery;
+
+})();
+
+
+// String to Object flags format cache
+var flagsCache = {};
+
+// Convert String-formatted flags into Object-formatted ones and store in cache
+function createFlags( flags ) {
+ var object = flagsCache[ flags ] = {},
+ i, length;
+ flags = flags.split( /\s+/ );
+ for ( i = 0, length = flags.length; i < length; i++ ) {
+ object[ flags[i] ] = true;
+ }
+ return object;
+}
+
+/*
+ * Create a callback list using the following parameters:
+ *
+ * flags: an optional list of space-separated flags that will change how
+ * the callback list behaves
+ *
+ * By default a callback list will act like an event callback list and can be
+ * "fired" multiple times.
+ *
+ * Possible flags:
+ *
+ * once: will ensure the callback list can only be fired once (like a Deferred)
+ *
+ * memory: will keep track of previous values and will call any callback added
+ * after the list has been fired right away with the latest "memorized"
+ * values (like a Deferred)
+ *
+ * unique: will ensure a callback can only be added once (no duplicate in the list)
+ *
+ * stopOnFalse: interrupt callings when a callback returns false
+ *
+ */
+jQuery.Callbacks = function( flags ) {
+
+ // Convert flags from String-formatted to Object-formatted
+ // (we check in cache first)
+ flags = flags ? ( flagsCache[ flags ] || createFlags( flags ) ) : {};
+
+ var // Actual callback list
+ list = [],
+ // Stack of fire calls for repeatable lists
+ stack = [],
+ // Last fire value (for non-forgettable lists)
+ memory,
+ // Flag to know if list is currently firing
+ firing,
+ // First callback to fire (used internally by add and fireWith)
+ firingStart,
+ // End of the loop when firing
+ firingLength,
+ // Index of currently firing callback (modified by remove if needed)
+ firingIndex,
+ // Add one or several callbacks to the list
+ add = function( args ) {
+ var i,
+ length,
+ elem,
+ type,
+ actual;
+ for ( i = 0, length = args.length; i < length; i++ ) {
+ elem = args[ i ];
+ type = jQuery.type( elem );
+ if ( type === "array" ) {
+ // Inspect recursively
+ add( elem );
+ } else if ( type === "function" ) {
+ // Add if not in unique mode and callback is not in
+ if ( !flags.unique || !self.has( elem ) ) {
+ list.push( elem );
+ }
+ }
+ }
+ },
+ // Fire callbacks
+ fire = function( context, args ) {
+ args = args || [];
+ memory = !flags.memory || [ context, args ];
+ firing = true;
+ firingIndex = firingStart || 0;
+ firingStart = 0;
+ firingLength = list.length;
+ for ( ; list && firingIndex < firingLength; firingIndex++ ) {
+ if ( list[ firingIndex ].apply( context, args ) === false && flags.stopOnFalse ) {
+ memory = true; // Mark as halted
+ break;
+ }
+ }
+ firing = false;
+ if ( list ) {
+ if ( !flags.once ) {
+ if ( stack && stack.length ) {
+ memory = stack.shift();
+ self.fireWith( memory[ 0 ], memory[ 1 ] );
+ }
+ } else if ( memory === true ) {
+ self.disable();
+ } else {
+ list = [];
+ }
+ }
+ },
+ // Actual Callbacks object
+ self = {
+ // Add a callback or a collection of callbacks to the list
+ add: function() {
+ if ( list ) {
+ var length = list.length;
+ add( arguments );
+ // Do we need to add the callbacks to the
+ // current firing batch?
+ if ( firing ) {
+ firingLength = list.length;
+ // With memory, if we're not firing then
+ // we should call right away, unless previous
+ // firing was halted (stopOnFalse)
+ } else if ( memory && memory !== true ) {
+ firingStart = length;
+ fire( memory[ 0 ], memory[ 1 ] );
+ }
+ }
+ return this;
+ },
+ // Remove a callback from the list
+ remove: function() {
+ if ( list ) {
+ var args = arguments,
+ argIndex = 0,
+ argLength = args.length;
+ for ( ; argIndex < argLength ; argIndex++ ) {
+ for ( var i = 0; i < list.length; i++ ) {
+ if ( args[ argIndex ] === list[ i ] ) {
+ // Handle firingIndex and firingLength
+ if ( firing ) {
+ if ( i <= firingLength ) {
+ firingLength--;
+ if ( i <= firingIndex ) {
+ firingIndex--;
+ }
+ }
+ }
+ // Remove the element
+ list.splice( i--, 1 );
+ // If we have some unicity property then
+ // we only need to do this once
+ if ( flags.unique ) {
+ break;
+ }
+ }
+ }
+ }
+ }
+ return this;
+ },
+ // Control if a given callback is in the list
+ has: function( fn ) {
+ if ( list ) {
+ var i = 0,
+ length = list.length;
+ for ( ; i < length; i++ ) {
+ if ( fn === list[ i ] ) {
+ return true;
+ }
+ }
+ }
+ return false;
+ },
+ // Remove all callbacks from the list
+ empty: function() {
+ list = [];
+ return this;
+ },
+ // Have the list do nothing anymore
+ disable: function() {
+ list = stack = memory = undefined;
+ return this;
+ },
+ // Is it disabled?
+ disabled: function() {
+ return !list;
+ },
+ // Lock the list in its current state
+ lock: function() {
+ stack = undefined;
+ if ( !memory || memory === true ) {
+ self.disable();
+ }
+ return this;
+ },
+ // Is it locked?
+ locked: function() {
+ return !stack;
+ },
+ // Call all callbacks with the given context and arguments
+ fireWith: function( context, args ) {
+ if ( stack ) {
+ if ( firing ) {
+ if ( !flags.once ) {
+ stack.push( [ context, args ] );
+ }
+ } else if ( !( flags.once && memory ) ) {
+ fire( context, args );
+ }
+ }
+ return this;
+ },
+ // Call all the callbacks with the given arguments
+ fire: function() {
+ self.fireWith( this, arguments );
+ return this;
+ },
+ // To know if the callbacks have already been called at least once
+ fired: function() {
+ return !!memory;
+ }
+ };
+
+ return self;
+};
+
+
+
+
+var // Static reference to slice
+ sliceDeferred = [].slice;
+
+jQuery.extend({
+
+ Deferred: function( func ) {
+ var doneList = jQuery.Callbacks( "once memory" ),
+ failList = jQuery.Callbacks( "once memory" ),
+ progressList = jQuery.Callbacks( "memory" ),
+ state = "pending",
+ lists = {
+ resolve: doneList,
+ reject: failList,
+ notify: progressList
+ },
+ promise = {
+ done: doneList.add,
+ fail: failList.add,
+ progress: progressList.add,
+
+ state: function() {
+ return state;
+ },
+
+ // Deprecated
+ isResolved: doneList.fired,
+ isRejected: failList.fired,
+
+ then: function( doneCallbacks, failCallbacks, progressCallbacks ) {
+ deferred.done( doneCallbacks ).fail( failCallbacks ).progress( progressCallbacks );
+ return this;
+ },
+ always: function() {
+ deferred.done.apply( deferred, arguments ).fail.apply( deferred, arguments );
+ return this;
+ },
+ pipe: function( fnDone, fnFail, fnProgress ) {
+ return jQuery.Deferred(function( newDefer ) {
+ jQuery.each( {
+ done: [ fnDone, "resolve" ],
+ fail: [ fnFail, "reject" ],
+ progress: [ fnProgress, "notify" ]
+ }, function( handler, data ) {
+ var fn = data[ 0 ],
+ action = data[ 1 ],
+ returned;
+ if ( jQuery.isFunction( fn ) ) {
+ deferred[ handler ](function() {
+ returned = fn.apply( this, arguments );
+ if ( returned && jQuery.isFunction( returned.promise ) ) {
+ returned.promise().then( newDefer.resolve, newDefer.reject, newDefer.notify );
+ } else {
+ newDefer[ action + "With" ]( this === deferred ? newDefer : this, [ returned ] );
+ }
+ });
+ } else {
+ deferred[ handler ]( newDefer[ action ] );
+ }
+ });
+ }).promise();
+ },
+ // Get a promise for this deferred
+ // If obj is provided, the promise aspect is added to the object
+ promise: function( obj ) {
+ if ( obj == null ) {
+ obj = promise;
+ } else {
+ for ( var key in promise ) {
+ obj[ key ] = promise[ key ];
+ }
+ }
+ return obj;
+ }
+ },
+ deferred = promise.promise({}),
+ key;
+
+ for ( key in lists ) {
+ deferred[ key ] = lists[ key ].fire;
+ deferred[ key + "With" ] = lists[ key ].fireWith;
+ }
+
+ // Handle state
+ deferred.done( function() {
+ state = "resolved";
+ }, failList.disable, progressList.lock ).fail( function() {
+ state = "rejected";
+ }, doneList.disable, progressList.lock );
+
+ // Call given func if any
+ if ( func ) {
+ func.call( deferred, deferred );
+ }
+
+ // All done!
+ return deferred;
+ },
+
+ // Deferred helper
+ when: function( firstParam ) {
+ var args = sliceDeferred.call( arguments, 0 ),
+ i = 0,
+ length = args.length,
+ pValues = new Array( length ),
+ count = length,
+ pCount = length,
+ deferred = length <= 1 && firstParam && jQuery.isFunction( firstParam.promise ) ?
+ firstParam :
+ jQuery.Deferred(),
+ promise = deferred.promise();
+ function resolveFunc( i ) {
+ return function( value ) {
+ args[ i ] = arguments.length > 1 ? sliceDeferred.call( arguments, 0 ) : value;
+ if ( !( --count ) ) {
+ deferred.resolveWith( deferred, args );
+ }
+ };
+ }
+ function progressFunc( i ) {
+ return function( value ) {
+ pValues[ i ] = arguments.length > 1 ? sliceDeferred.call( arguments, 0 ) : value;
+ deferred.notifyWith( promise, pValues );
+ };
+ }
+ if ( length > 1 ) {
+ for ( ; i < length; i++ ) {
+ if ( args[ i ] && args[ i ].promise && jQuery.isFunction( args[ i ].promise ) ) {
+ args[ i ].promise().then( resolveFunc(i), deferred.reject, progressFunc(i) );
+ } else {
+ --count;
+ }
+ }
+ if ( !count ) {
+ deferred.resolveWith( deferred, args );
+ }
+ } else if ( deferred !== firstParam ) {
+ deferred.resolveWith( deferred, length ? [ firstParam ] : [] );
+ }
+ return promise;
+ }
+});
+
+
+
+
+jQuery.support = (function() {
+
+ var support,
+ all,
+ a,
+ select,
+ opt,
+ input,
+ marginDiv,
+ fragment,
+ tds,
+ events,
+ eventName,
+ i,
+ isSupported,
+ div = document.createElement( "div" ),
+ documentElement = document.documentElement;
+
+ // Preliminary tests
+ div.setAttribute("className", "t");
+ div.innerHTML = " <link/><table></table><a href='/a' style='top:1px;float:left;opacity:.55;'>a</a><input type='checkbox'/>";
+
+ all = div.getElementsByTagName( "*" );
+ a = div.getElementsByTagName( "a" )[ 0 ];
+
+ // Can't get basic test support
+ if ( !all || !all.length || !a ) {
+ return {};
+ }
+
+ // First batch of supports tests
+ select = document.createElement( "select" );
+ opt = select.appendChild( document.createElement("option") );
+ input = div.getElementsByTagName( "input" )[ 0 ];
+
+ support = {
+ // IE strips leading whitespace when .innerHTML is used
+ leadingWhitespace: ( div.firstChild.nodeType === 3 ),
+
+ // Make sure that tbody elements aren't automatically inserted
+ // IE will insert them into empty tables
+ tbody: !div.getElementsByTagName("tbody").length,
+
+ // Make sure that link elements get serialized correctly by innerHTML
+ // This requires a wrapper element in IE
+ htmlSerialize: !!div.getElementsByTagName("link").length,
+
+ // Get the style information from getAttribute
+ // (IE uses .cssText instead)
+ style: /top/.test( a.getAttribute("style") ),
+
+ // Make sure that URLs aren't manipulated
+ // (IE normalizes it by default)
+ hrefNormalized: ( a.getAttribute("href") === "/a" ),
+
+ // Make sure that element opacity exists
+ // (IE uses filter instead)
+ // Use a regex to work around a WebKit issue. See #5145
+ opacity: /^0.55/.test( a.style.opacity ),
+
+ // Verify style float existence
+ // (IE uses styleFloat instead of cssFloat)
+ cssFloat: !!a.style.cssFloat,
+
+ // Make sure that if no value is specified for a checkbox
+ // that it defaults to "on".
+ // (WebKit defaults to "" instead)
+ checkOn: ( input.value === "on" ),
+
+ // Make sure that a selected-by-default option has a working selected property.
+ // (WebKit defaults to false instead of true, IE too, if it's in an optgroup)
+ optSelected: opt.selected,
+
+ // Test setAttribute on camelCase class. If it works, we need attrFixes when doing get/setAttribute (ie6/7)
+ getSetAttribute: div.className !== "t",
+
+ // Tests for enctype support on a form(#6743)
+ enctype: !!document.createElement("form").enctype,
+
+ // Makes sure cloning an html5 element does not cause problems
+ // Where outerHTML is undefined, this still works
+ html5Clone: document.createElement("nav").cloneNode( true ).outerHTML !== "<:nav></:nav>",
+
+ // Will be defined later
+ submitBubbles: true,
+ changeBubbles: true,
+ focusinBubbles: false,
+ deleteExpando: true,
+ noCloneEvent: true,
+ inlineBlockNeedsLayout: false,
+ shrinkWrapBlocks: false,
+ reliableMarginRight: true
+ };
+
+ // Make sure checked status is properly cloned
+ input.checked = true;
+ support.noCloneChecked = input.cloneNode( true ).checked;
+
+ // Make sure that the options inside disabled selects aren't marked as disabled
+ // (WebKit marks them as disabled)
+ select.disabled = true;
+ support.optDisabled = !opt.disabled;
+
+ // Test to see if it's possible to delete an expando from an element
+ // Fails in Internet Explorer
+ try {
+ delete div.test;
+ } catch( e ) {
+ support.deleteExpando = false;
+ }
+
+ if ( !div.addEventListener && div.attachEvent && div.fireEvent ) {
+ div.attachEvent( "onclick", function() {
+ // Cloning a node shouldn't copy over any
+ // bound event handlers (IE does this)
+ support.noCloneEvent = false;
+ });
+ div.cloneNode( true ).fireEvent( "onclick" );
+ }
+
+ // Check if a radio maintains its value
+ // after being appended to the DOM
+ input = document.createElement("input");
+ input.value = "t";
+ input.setAttribute("type", "radio");
+ support.radioValue = input.value === "t";
+
+ input.setAttribute("checked", "checked");
+ div.appendChild( input );
+ fragment = document.createDocumentFragment();
+ fragment.appendChild( div.lastChild );
+
+ // WebKit doesn't clone checked state correctly in fragments
+ support.checkClone = fragment.cloneNode( true ).cloneNode( true ).lastChild.checked;
+
+ // Check if a disconnected checkbox will retain its checked
+ // value of true after appended to the DOM (IE6/7)
+ support.appendChecked = input.checked;
+
+ fragment.removeChild( input );
+ fragment.appendChild( div );
+
+ div.innerHTML = "";
+
+ // Check if div with explicit width and no margin-right incorrectly
+ // gets computed margin-right based on width of container. For more
+ // info see bug #3333
+ // Fails in WebKit before Feb 2011 nightlies
+ // WebKit Bug 13343 - getComputedStyle returns wrong value for margin-right
+ if ( window.getComputedStyle ) {
+ marginDiv = document.createElement( "div" );
+ marginDiv.style.width = "0";
+ marginDiv.style.marginRight = "0";
+ div.style.width = "2px";
+ div.appendChild( marginDiv );
+ support.reliableMarginRight =
+ ( parseInt( ( window.getComputedStyle( marginDiv, null ) || { marginRight: 0 } ).marginRight, 10 ) || 0 ) === 0;
+ }
+
+ // Technique from Juriy Zaytsev
+ // http://perfectionkills.com/detecting-event-support-without-browser-sniffing/
+ // We only care about the case where non-standard event systems
+ // are used, namely in IE. Short-circuiting here helps us to
+ // avoid an eval call (in setAttribute) which can cause CSP
+ // to go haywire. See: https://developer.mozilla.org/en/Security/CSP
+ if ( div.attachEvent ) {
+ for( i in {
+ submit: 1,
+ change: 1,
+ focusin: 1
+ }) {
+ eventName = "on" + i;
+ isSupported = ( eventName in div );
+ if ( !isSupported ) {
+ div.setAttribute( eventName, "return;" );
+ isSupported = ( typeof div[ eventName ] === "function" );
+ }
+ support[ i + "Bubbles" ] = isSupported;
+ }
+ }
+
+ fragment.removeChild( div );
+
+ // Null elements to avoid leaks in IE
+ fragment = select = opt = marginDiv = div = input = null;
+
+ // Run tests that need a body at doc ready
+ jQuery(function() {
+ var container, outer, inner, table, td, offsetSupport,
+ conMarginTop, ptlm, vb, style, html,
+ body = document.getElementsByTagName("body")[0];
+
+ if ( !body ) {
+ // Return for frameset docs that don't have a body
+ return;
+ }
+
+ conMarginTop = 1;
+ ptlm = "position:absolute;top:0;left:0;width:1px;height:1px;margin:0;";
+ vb = "visibility:hidden;border:0;";
+ style = "style='" + ptlm + "border:5px solid #000;padding:0;'";
+ html = "<div " + style + "><div></div></div>" +
+ "<table " + style + " cellpadding='0' cellspacing='0'>" +
+ "<tr><td></td></tr></table>";
+
+ container = document.createElement("div");
+ container.style.cssText = vb + "width:0;height:0;position:static;top:0;margin-top:" + conMarginTop + "px";
+ body.insertBefore( container, body.firstChild );
+
+ // Construct the test element
+ div = document.createElement("div");
+ container.appendChild( div );
+
+ // Check if table cells still have offsetWidth/Height when they are set
+ // to display:none and there are still other visible table cells in a
+ // table row; if so, offsetWidth/Height are not reliable for use when
+ // determining if an element has been hidden directly using
+ // display:none (it is still safe to use offsets if a parent element is
+ // hidden; don safety goggles and see bug #4512 for more information).
+ // (only IE 8 fails this test)
+ div.innerHTML = "<table><tr><td style='padding:0;border:0;display:none'></td><td>t</td></tr></table>";
+ tds = div.getElementsByTagName( "td" );
+ isSupported = ( tds[ 0 ].offsetHeight === 0 );
+
+ tds[ 0 ].style.display = "";
+ tds[ 1 ].style.display = "none";
+
+ // Check if empty table cells still have offsetWidth/Height
+ // (IE <= 8 fail this test)
+ support.reliableHiddenOffsets = isSupported && ( tds[ 0 ].offsetHeight === 0 );
+
+ // Figure out if the W3C box model works as expected
+ div.innerHTML = "";
+ div.style.width = div.style.paddingLeft = "1px";
+ jQuery.boxModel = support.boxModel = div.offsetWidth === 2;
+
+ if ( typeof div.style.zoom !== "undefined" ) {
+ // Check if natively block-level elements act like inline-block
+ // elements when setting their display to 'inline' and giving
+ // them layout
+ // (IE < 8 does this)
+ div.style.display = "inline";
+ div.style.zoom = 1;
+ support.inlineBlockNeedsLayout = ( div.offsetWidth === 2 );
+
+ // Check if elements with layout shrink-wrap their children
+ // (IE 6 does this)
+ div.style.display = "";
+ div.innerHTML = "<div style='width:4px;'></div>";
+ support.shrinkWrapBlocks = ( div.offsetWidth !== 2 );
+ }
+
+ div.style.cssText = ptlm + vb;
+ div.innerHTML = html;
+
+ outer = div.firstChild;
+ inner = outer.firstChild;
+ td = outer.nextSibling.firstChild.firstChild;
+
+ offsetSupport = {
+ doesNotAddBorder: ( inner.offsetTop !== 5 ),
+ doesAddBorderForTableAndCells: ( td.offsetTop === 5 )
+ };
+
+ inner.style.position = "fixed";
+ inner.style.top = "20px";
+
+ // safari subtracts parent border width here which is 5px
+ offsetSupport.fixedPosition = ( inner.offsetTop === 20 || inner.offsetTop === 15 );
+ inner.style.position = inner.style.top = "";
+
+ outer.style.overflow = "hidden";
+ outer.style.position = "relative";
+
+ offsetSupport.subtractsBorderForOverflowNotVisible = ( inner.offsetTop === -5 );
+ offsetSupport.doesNotIncludeMarginInBodyOffset = ( body.offsetTop !== conMarginTop );
+
+ body.removeChild( container );
+ div = container = null;
+
+ jQuery.extend( support, offsetSupport );
+ });
+
+ return support;
+})();
+
+
+
+
+var rbrace = /^(?:\{.*\}|\[.*\])$/,
+ rmultiDash = /([A-Z])/g;
+
+jQuery.extend({
+ cache: {},
+
+ // Please use with caution
+ uuid: 0,
+
+ // Unique for each copy of jQuery on the page
+ // Non-digits removed to match rinlinejQuery
+ expando: "jQuery" + ( jQuery.fn.jquery + Math.random() ).replace( /\D/g, "" ),
+
+ // The following elements throw uncatchable exceptions if you
+ // attempt to add expando properties to them.
+ noData: {
+ "embed": true,
+ // Ban all objects except for Flash (which handle expandos)
+ "object": "clsid:D27CDB6E-AE6D-11cf-96B8-444553540000",
+ "applet": true
+ },
+
+ hasData: function( elem ) {
+ elem = elem.nodeType ? jQuery.cache[ elem[jQuery.expando] ] : elem[ jQuery.expando ];
+ return !!elem && !isEmptyDataObject( elem );
+ },
+
+ data: function( elem, name, data, pvt /* Internal Use Only */ ) {
+ if ( !jQuery.acceptData( elem ) ) {
+ return;
+ }
+
+ var privateCache, thisCache, ret,
+ internalKey = jQuery.expando,
+ getByName = typeof name === "string",
+
+ // We have to handle DOM nodes and JS objects differently because IE6-7
+ // can't GC object references properly across the DOM-JS boundary
+ isNode = elem.nodeType,
+
+ // Only DOM nodes need the global jQuery cache; JS object data is
+ // attached directly to the object so GC can occur automatically
+ cache = isNode ? jQuery.cache : elem,
+
+ // Only defining an ID for JS objects if its cache already exists allows
+ // the code to shortcut on the same path as a DOM node with no cache
+ id = isNode ? elem[ internalKey ] : elem[ internalKey ] && internalKey,
+ isEvents = name === "events";
+
+ // Avoid doing any more work than we need to when trying to get data on an
+ // object that has no data at all
+ if ( (!id || !cache[id] || (!isEvents && !pvt && !cache[id].data)) && getByName && data === undefined ) {
+ return;
+ }
+
+ if ( !id ) {
+ // Only DOM nodes need a new unique ID for each element since their data
+ // ends up in the global cache
+ if ( isNode ) {
+ elem[ internalKey ] = id = ++jQuery.uuid;
+ } else {
+ id = internalKey;
+ }
+ }
+
+ if ( !cache[ id ] ) {
+ cache[ id ] = {};
+
+ // Avoids exposing jQuery metadata on plain JS objects when the object
+ // is serialized using JSON.stringify
+ if ( !isNode ) {
+ cache[ id ].toJSON = jQuery.noop;
+ }
+ }
+
+ // An object can be passed to jQuery.data instead of a key/value pair; this gets
+ // shallow copied over onto the existing cache
+ if ( typeof name === "object" || typeof name === "function" ) {
+ if ( pvt ) {
+ cache[ id ] = jQuery.extend( cache[ id ], name );
+ } else {
+ cache[ id ].data = jQuery.extend( cache[ id ].data, name );
+ }
+ }
+
+ privateCache = thisCache = cache[ id ];
+
+ // jQuery data() is stored in a separate object inside the object's internal data
+ // cache in order to avoid key collisions between internal data and user-defined
+ // data.
+ if ( !pvt ) {
+ if ( !thisCache.data ) {
+ thisCache.data = {};
+ }
+
+ thisCache = thisCache.data;
+ }
+
+ if ( data !== undefined ) {
+ thisCache[ jQuery.camelCase( name ) ] = data;
+ }
+
+ // Users should not attempt to inspect the internal events object using jQuery.data,
+ // it is undocumented and subject to change. But does anyone listen? No.
+ if ( isEvents && !thisCache[ name ] ) {
+ return privateCache.events;
+ }
+
+ // Check for both converted-to-camel and non-converted data property names
+ // If a data property was specified
+ if ( getByName ) {
+
+ // First Try to find as-is property data
+ ret = thisCache[ name ];
+
+ // Test for null|undefined property data
+ if ( ret == null ) {
+
+ // Try to find the camelCased property
+ ret = thisCache[ jQuery.camelCase( name ) ];
+ }
+ } else {
+ ret = thisCache;
+ }
+
+ return ret;
+ },
+
+ removeData: function( elem, name, pvt /* Internal Use Only */ ) {
+ if ( !jQuery.acceptData( elem ) ) {
+ return;
+ }
+
+ var thisCache, i, l,
+
+ // Reference to internal data cache key
+ internalKey = jQuery.expando,
+
+ isNode = elem.nodeType,
+
+ // See jQuery.data for more information
+ cache = isNode ? jQuery.cache : elem,
+
+ // See jQuery.data for more information
+ id = isNode ? elem[ internalKey ] : internalKey;
+
+ // If there is already no cache entry for this object, there is no
+ // purpose in continuing
+ if ( !cache[ id ] ) {
+ return;
+ }
+
+ if ( name ) {
+
+ thisCache = pvt ? cache[ id ] : cache[ id ].data;
+
+ if ( thisCache ) {
+
+ // Support array or space separated string names for data keys
+ if ( !jQuery.isArray( name ) ) {
+
+ // try the string as a key before any manipulation
+ if ( name in thisCache ) {
+ name = [ name ];
+ } else {
+
+ // split the camel cased version by spaces unless a key with the spaces exists
+ name = jQuery.camelCase( name );
+ if ( name in thisCache ) {
+ name = [ name ];
+ } else {
+ name = name.split( " " );
+ }
+ }
+ }
+
+ for ( i = 0, l = name.length; i < l; i++ ) {
+ delete thisCache[ name[i] ];
+ }
+
+ // If there is no data left in the cache, we want to continue
+ // and let the cache object itself get destroyed
+ if ( !( pvt ? isEmptyDataObject : jQuery.isEmptyObject )( thisCache ) ) {
+ return;
+ }
+ }
+ }
+
+ // See jQuery.data for more information
+ if ( !pvt ) {
+ delete cache[ id ].data;
+
+ // Don't destroy the parent cache unless the internal data object
+ // had been the only thing left in it
+ if ( !isEmptyDataObject(cache[ id ]) ) {
+ return;
+ }
+ }
+
+ // Browsers that fail expando deletion also refuse to delete expandos on
+ // the window, but it will allow it on all other JS objects; other browsers
+ // don't care
+ // Ensure that `cache` is not a window object #10080
+ if ( jQuery.support.deleteExpando || !cache.setInterval ) {
+ delete cache[ id ];
+ } else {
+ cache[ id ] = null;
+ }
+
+ // We destroyed the cache and need to eliminate the expando on the node to avoid
+ // false lookups in the cache for entries that no longer exist
+ if ( isNode ) {
+ // IE does not allow us to delete expando properties from nodes,
+ // nor does it have a removeAttribute function on Document nodes;
+ // we must handle all of these cases
+ if ( jQuery.support.deleteExpando ) {
+ delete elem[ internalKey ];
+ } else if ( elem.removeAttribute ) {
+ elem.removeAttribute( internalKey );
+ } else {
+ elem[ internalKey ] = null;
+ }
+ }
+ },
+
+ // For internal use only.
+ _data: function( elem, name, data ) {
+ return jQuery.data( elem, name, data, true );
+ },
+
+ // A method for determining if a DOM node can handle the data expando
+ acceptData: function( elem ) {
+ if ( elem.nodeName ) {
+ var match = jQuery.noData[ elem.nodeName.toLowerCase() ];
+
+ if ( match ) {
+ return !(match === true || elem.getAttribute("classid") !== match);
+ }
+ }
+
+ return true;
+ }
+});
+
+jQuery.fn.extend({
+ data: function( key, value ) {
+ var parts, attr, name,
+ data = null;
+
+ if ( typeof key === "undefined" ) {
+ if ( this.length ) {
+ data = jQuery.data( this[0] );
+
+ if ( this[0].nodeType === 1 && !jQuery._data( this[0], "parsedAttrs" ) ) {
+ attr = this[0].attributes;
+ for ( var i = 0, l = attr.length; i < l; i++ ) {
+ name = attr[i].name;
+
+ if ( name.indexOf( "data-" ) === 0 ) {
+ name = jQuery.camelCase( name.substring(5) );
+
+ dataAttr( this[0], name, data[ name ] );
+ }
+ }
+ jQuery._data( this[0], "parsedAttrs", true );
+ }
+ }
+
+ return data;
+
+ } else if ( typeof key === "object" ) {
+ return this.each(function() {
+ jQuery.data( this, key );
+ });
+ }
+
+ parts = key.split(".");
+ parts[1] = parts[1] ? "." + parts[1] : "";
+
+ if ( value === undefined ) {
+ data = this.triggerHandler("getData" + parts[1] + "!", [parts[0]]);
+
+ // Try to fetch any internally stored data first
+ if ( data === undefined && this.length ) {
+ data = jQuery.data( this[0], key );
+ data = dataAttr( this[0], key, data );
+ }
+
+ return data === undefined && parts[1] ?
+ this.data( parts[0] ) :
+ data;
+
+ } else {
+ return this.each(function() {
+ var self = jQuery( this ),
+ args = [ parts[0], value ];
+
+ self.triggerHandler( "setData" + parts[1] + "!", args );
+ jQuery.data( this, key, value );
+ self.triggerHandler( "changeData" + parts[1] + "!", args );
+ });
+ }
+ },
+
+ removeData: function( key ) {
+ return this.each(function() {
+ jQuery.removeData( this, key );
+ });
+ }
+});
+
+function dataAttr( elem, key, data ) {
+ // If nothing was found internally, try to fetch any
+ // data from the HTML5 data-* attribute
+ if ( data === undefined && elem.nodeType === 1 ) {
+
+ var name = "data-" + key.replace( rmultiDash, "-$1" ).toLowerCase();
+
+ data = elem.getAttribute( name );
+
+ if ( typeof data === "string" ) {
+ try {
+ data = data === "true" ? true :
+ data === "false" ? false :
+ data === "null" ? null :
+ jQuery.isNumeric( data ) ? parseFloat( data ) :
+ rbrace.test( data ) ? jQuery.parseJSON( data ) :
+ data;
+ } catch( e ) {}
+
+ // Make sure we set the data so it isn't changed later
+ jQuery.data( elem, key, data );
+
+ } else {
+ data = undefined;
+ }
+ }
+
+ return data;
+}
+
+// checks a cache object for emptiness
+function isEmptyDataObject( obj ) {
+ for ( var name in obj ) {
+
+ // if the public data object is empty, the private is still empty
+ if ( name === "data" && jQuery.isEmptyObject( obj[name] ) ) {
+ continue;
+ }
+ if ( name !== "toJSON" ) {
+ return false;
+ }
+ }
+
+ return true;
+}
+
+
+
+
+function handleQueueMarkDefer( elem, type, src ) {
+ var deferDataKey = type + "defer",
+ queueDataKey = type + "queue",
+ markDataKey = type + "mark",
+ defer = jQuery._data( elem, deferDataKey );
+ if ( defer &&
+ ( src === "queue" || !jQuery._data(elem, queueDataKey) ) &&
+ ( src === "mark" || !jQuery._data(elem, markDataKey) ) ) {
+ // Give room for hard-coded callbacks to fire first
+ // and eventually mark/queue something else on the element
+ setTimeout( function() {
+ if ( !jQuery._data( elem, queueDataKey ) &&
+ !jQuery._data( elem, markDataKey ) ) {
+ jQuery.removeData( elem, deferDataKey, true );
+ defer.fire();
+ }
+ }, 0 );
+ }
+}
+
+jQuery.extend({
+
+ _mark: function( elem, type ) {
+ if ( elem ) {
+ type = ( type || "fx" ) + "mark";
+ jQuery._data( elem, type, (jQuery._data( elem, type ) || 0) + 1 );
+ }
+ },
+
+ _unmark: function( force, elem, type ) {
+ if ( force !== true ) {
+ type = elem;
+ elem = force;
+ force = false;
+ }
+ if ( elem ) {
+ type = type || "fx";
+ var key = type + "mark",
+ count = force ? 0 : ( (jQuery._data( elem, key ) || 1) - 1 );
+ if ( count ) {
+ jQuery._data( elem, key, count );
+ } else {
+ jQuery.removeData( elem, key, true );
+ handleQueueMarkDefer( elem, type, "mark" );
+ }
+ }
+ },
+
+ queue: function( elem, type, data ) {
+ var q;
+ if ( elem ) {
+ type = ( type || "fx" ) + "queue";
+ q = jQuery._data( elem, type );
+
+ // Speed up dequeue by getting out quickly if this is just a lookup
+ if ( data ) {
+ if ( !q || jQuery.isArray(data) ) {
+ q = jQuery._data( elem, type, jQuery.makeArray(data) );
+ } else {
+ q.push( data );
+ }
+ }
+ return q || [];
+ }
+ },
+
+ dequeue: function( elem, type ) {
+ type = type || "fx";
+
+ var queue = jQuery.queue( elem, type ),
+ fn = queue.shift(),
+ hooks = {};
+
+ // If the fx queue is dequeued, always remove the progress sentinel
+ if ( fn === "inprogress" ) {
+ fn = queue.shift();
+ }
+
+ if ( fn ) {
+ // Add a progress sentinel to prevent the fx queue from being
+ // automatically dequeued
+ if ( type === "fx" ) {
+ queue.unshift( "inprogress" );
+ }
+
+ jQuery._data( elem, type + ".run", hooks );
+ fn.call( elem, function() {
+ jQuery.dequeue( elem, type );
+ }, hooks );
+ }
+
+ if ( !queue.length ) {
+ jQuery.removeData( elem, type + "queue " + type + ".run", true );
+ handleQueueMarkDefer( elem, type, "queue" );
+ }
+ }
+});
+
+jQuery.fn.extend({
+ queue: function( type, data ) {
+ if ( typeof type !== "string" ) {
+ data = type;
+ type = "fx";
+ }
+
+ if ( data === undefined ) {
+ return jQuery.queue( this[0], type );
+ }
+ return this.each(function() {
+ var queue = jQuery.queue( this, type, data );
+
+ if ( type === "fx" && queue[0] !== "inprogress" ) {
+ jQuery.dequeue( this, type );
+ }
+ });
+ },
+ dequeue: function( type ) {
+ return this.each(function() {
+ jQuery.dequeue( this, type );
+ });
+ },
+ // Based off of the plugin by Clint Helfers, with permission.
+ // http://blindsignals.com/index.php/2009/07/jquery-delay/
+ delay: function( time, type ) {
+ time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time;
+ type = type || "fx";
+
+ return this.queue( type, function( next, hooks ) {
+ var timeout = setTimeout( next, time );
+ hooks.stop = function() {
+ clearTimeout( timeout );
+ };
+ });
+ },
+ clearQueue: function( type ) {
+ return this.queue( type || "fx", [] );
+ },
+ // Get a promise resolved when queues of a certain type
+ // are emptied (fx is the type by default)
+ promise: function( type, object ) {
+ if ( typeof type !== "string" ) {
+ object = type;
+ type = undefined;
+ }
+ type = type || "fx";
+ var defer = jQuery.Deferred(),
+ elements = this,
+ i = elements.length,
+ count = 1,
+ deferDataKey = type + "defer",
+ queueDataKey = type + "queue",
+ markDataKey = type + "mark",
+ tmp;
+ function resolve() {
+ if ( !( --count ) ) {
+ defer.resolveWith( elements, [ elements ] );
+ }
+ }
+ while( i-- ) {
+ if (( tmp = jQuery.data( elements[ i ], deferDataKey, undefined, true ) ||
+ ( jQuery.data( elements[ i ], queueDataKey, undefined, true ) ||
+ jQuery.data( elements[ i ], markDataKey, undefined, true ) ) &&
+ jQuery.data( elements[ i ], deferDataKey, jQuery.Callbacks( "once memory" ), true ) )) {
+ count++;
+ tmp.add( resolve );
+ }
+ }
+ resolve();
+ return defer.promise();
+ }
+});
+
+
+
+
+var rclass = /[\n\t\r]/g,
+ rspace = /\s+/,
+ rreturn = /\r/g,
+ rtype = /^(?:button|input)$/i,
+ rfocusable = /^(?:button|input|object|select|textarea)$/i,
+ rclickable = /^a(?:rea)?$/i,
+ rboolean = /^(?:autofocus|autoplay|async|checked|controls|defer|disabled|hidden|loop|multiple|open|readonly|required|scoped|selected)$/i,
+ getSetAttribute = jQuery.support.getSetAttribute,
+ nodeHook, boolHook, fixSpecified;
+
+jQuery.fn.extend({
+ attr: function( name, value ) {
+ return jQuery.access( this, name, value, true, jQuery.attr );
+ },
+
+ removeAttr: function( name ) {
+ return this.each(function() {
+ jQuery.removeAttr( this, name );
+ });
+ },
+
+ prop: function( name, value ) {
+ return jQuery.access( this, name, value, true, jQuery.prop );
+ },
+
+ removeProp: function( name ) {
+ name = jQuery.propFix[ name ] || name;
+ return this.each(function() {
+ // try/catch handles cases where IE balks (such as removing a property on window)
+ try {
+ this[ name ] = undefined;
+ delete this[ name ];
+ } catch( e ) {}
+ });
+ },
+
+ addClass: function( value ) {
+ var classNames, i, l, elem,
+ setClass, c, cl;
+
+ if ( jQuery.isFunction( value ) ) {
+ return this.each(function( j ) {
+ jQuery( this ).addClass( value.call(this, j, this.className) );
+ });
+ }
+
+ if ( value && typeof value === "string" ) {
+ classNames = value.split( rspace );
+
+ for ( i = 0, l = this.length; i < l; i++ ) {
+ elem = this[ i ];
+
+ if ( elem.nodeType === 1 ) {
+ if ( !elem.className && classNames.length === 1 ) {
+ elem.className = value;
+
+ } else {
+ setClass = " " + elem.className + " ";
+
+ for ( c = 0, cl = classNames.length; c < cl; c++ ) {
+ if ( !~setClass.indexOf( " " + classNames[ c ] + " " ) ) {
+ setClass += classNames[ c ] + " ";
+ }
+ }
+ elem.className = jQuery.trim( setClass );
+ }
+ }
+ }
+ }
+
+ return this;
+ },
+
+ removeClass: function( value ) {
+ var classNames, i, l, elem, className, c, cl;
+
+ if ( jQuery.isFunction( value ) ) {
+ return this.each(function( j ) {
+ jQuery( this ).removeClass( value.call(this, j, this.className) );
+ });
+ }
+
+ if ( (value && typeof value === "string") || value === undefined ) {
+ classNames = ( value || "" ).split( rspace );
+
+ for ( i = 0, l = this.length; i < l; i++ ) {
+ elem = this[ i ];
+
+ if ( elem.nodeType === 1 && elem.className ) {
+ if ( value ) {
+ className = (" " + elem.className + " ").replace( rclass, " " );
+ for ( c = 0, cl = classNames.length; c < cl; c++ ) {
+ className = className.replace(" " + classNames[ c ] + " ", " ");
+ }
+ elem.className = jQuery.trim( className );
+
+ } else {
+ elem.className = "";
+ }
+ }
+ }
+ }
+
+ return this;
+ },
+
+ toggleClass: function( value, stateVal ) {
+ var type = typeof value,
+ isBool = typeof stateVal === "boolean";
+
+ if ( jQuery.isFunction( value ) ) {
+ return this.each(function( i ) {
+ jQuery( this ).toggleClass( value.call(this, i, this.className, stateVal), stateVal );
+ });
+ }
+
+ return this.each(function() {
+ if ( type === "string" ) {
+ // toggle individual class names
+ var className,
+ i = 0,
+ self = jQuery( this ),
+ state = stateVal,
+ classNames = value.split( rspace );
+
+ while ( (className = classNames[ i++ ]) ) {
+ // check each className given, space seperated list
+ state = isBool ? state : !self.hasClass( className );
+ self[ state ? "addClass" : "removeClass" ]( className );
+ }
+
+ } else if ( type === "undefined" || type === "boolean" ) {
+ if ( this.className ) {
+ // store className if set
+ jQuery._data( this, "__className__", this.className );
+ }
+
+ // toggle whole className
+ this.className = this.className || value === false ? "" : jQuery._data( this, "__className__" ) || "";
+ }
+ });
+ },
+
+ hasClass: function( selector ) {
+ var className = " " + selector + " ",
+ i = 0,
+ l = this.length;
+ for ( ; i < l; i++ ) {
+ if ( this[i].nodeType === 1 && (" " + this[i].className + " ").replace(rclass, " ").indexOf( className ) > -1 ) {
+ return true;
+ }
+ }
+
+ return false;
+ },
+
+ val: function( value ) {
+ var hooks, ret, isFunction,
+ elem = this[0];
+
+ if ( !arguments.length ) {
+ if ( elem ) {
+ hooks = jQuery.valHooks[ elem.nodeName.toLowerCase() ] || jQuery.valHooks[ elem.type ];
+
+ if ( hooks && "get" in hooks && (ret = hooks.get( elem, "value" )) !== undefined ) {
+ return ret;
+ }
+
+ ret = elem.value;
+
+ return typeof ret === "string" ?
+ // handle most common string cases
+ ret.replace(rreturn, "") :
+ // handle cases where value is null/undef or number
+ ret == null ? "" : ret;
+ }
+
+ return;
+ }
+
+ isFunction = jQuery.isFunction( value );
+
+ return this.each(function( i ) {
+ var self = jQuery(this), val;
+
+ if ( this.nodeType !== 1 ) {
+ return;
+ }
+
+ if ( isFunction ) {
+ val = value.call( this, i, self.val() );
+ } else {
+ val = value;
+ }
+
+ // Treat null/undefined as ""; convert numbers to string
+ if ( val == null ) {
+ val = "";
+ } else if ( typeof val === "number" ) {
+ val += "";
+ } else if ( jQuery.isArray( val ) ) {
+ val = jQuery.map(val, function ( value ) {
+ return value == null ? "" : value + "";
+ });
+ }
+
+ hooks = jQuery.valHooks[ this.nodeName.toLowerCase() ] || jQuery.valHooks[ this.type ];
+
+ // If set returns undefined, fall back to normal setting
+ if ( !hooks || !("set" in hooks) || hooks.set( this, val, "value" ) === undefined ) {
+ this.value = val;
+ }
+ });
+ }
+});
+
+jQuery.extend({
+ valHooks: {
+ option: {
+ get: function( elem ) {
+ // attributes.value is undefined in Blackberry 4.7 but
+ // uses .value. See #6932
+ var val = elem.attributes.value;
+ return !val || val.specified ? elem.value : elem.text;
+ }
+ },
+ select: {
+ get: function( elem ) {
+ var value, i, max, option,
+ index = elem.selectedIndex,
+ values = [],
+ options = elem.options,
+ one = elem.type === "select-one";
+
+ // Nothing was selected
+ if ( index < 0 ) {
+ return null;
+ }
+
+ // Loop through all the selected options
+ i = one ? index : 0;
+ max = one ? index + 1 : options.length;
+ for ( ; i < max; i++ ) {
+ option = options[ i ];
+
+ // Don't return options that are disabled or in a disabled optgroup
+ if ( option.selected && (jQuery.support.optDisabled ? !option.disabled : option.getAttribute("disabled") === null) &&
+ (!option.parentNode.disabled || !jQuery.nodeName( option.parentNode, "optgroup" )) ) {
+
+ // Get the specific value for the option
+ value = jQuery( option ).val();
+
+ // We don't need an array for one selects
+ if ( one ) {
+ return value;
+ }
+
+ // Multi-Selects return an array
+ values.push( value );
+ }
+ }
+
+ // Fixes Bug #2551 -- select.val() broken in IE after form.reset()
+ if ( one && !values.length && options.length ) {
+ return jQuery( options[ index ] ).val();
+ }
+
+ return values;
+ },
+
+ set: function( elem, value ) {
+ var values = jQuery.makeArray( value );
+
+ jQuery(elem).find("option").each(function() {
+ this.selected = jQuery.inArray( jQuery(this).val(), values ) >= 0;
+ });
+
+ if ( !values.length ) {
+ elem.selectedIndex = -1;
+ }
+ return values;
+ }
+ }
+ },
+
+ attrFn: {
+ val: true,
+ css: true,
+ html: true,
+ text: true,
+ data: true,
+ width: true,
+ height: true,
+ offset: true
+ },
+
+ attr: function( elem, name, value, pass ) {
+ var ret, hooks, notxml,
+ nType = elem.nodeType;
+
+ // don't get/set attributes on text, comment and attribute nodes
+ if ( !elem || nType === 3 || nType === 8 || nType === 2 ) {
+ return;
+ }
+
+ if ( pass && name in jQuery.attrFn ) {
+ return jQuery( elem )[ name ]( value );
+ }
+
+ // Fallback to prop when attributes are not supported
+ if ( typeof elem.getAttribute === "undefined" ) {
+ return jQuery.prop( elem, name, value );
+ }
+
+ notxml = nType !== 1 || !jQuery.isXMLDoc( elem );
+
+ // All attributes are lowercase
+ // Grab necessary hook if one is defined
+ if ( notxml ) {
+ name = name.toLowerCase();
+ hooks = jQuery.attrHooks[ name ] || ( rboolean.test( name ) ? boolHook : nodeHook );
+ }
+
+ if ( value !== undefined ) {
+
+ if ( value === null ) {
+ jQuery.removeAttr( elem, name );
+ return;
+
+ } else if ( hooks && "set" in hooks && notxml && (ret = hooks.set( elem, value, name )) !== undefined ) {
+ return ret;
+
+ } else {
+ elem.setAttribute( name, "" + value );
+ return value;
+ }
+
+ } else if ( hooks && "get" in hooks && notxml && (ret = hooks.get( elem, name )) !== null ) {
+ return ret;
+
+ } else {
+
+ ret = elem.getAttribute( name );
+
+ // Non-existent attributes return null, we normalize to undefined
+ return ret === null ?
+ undefined :
+ ret;
+ }
+ },
+
+ removeAttr: function( elem, value ) {
+ var propName, attrNames, name, l,
+ i = 0;
+
+ if ( value && elem.nodeType === 1 ) {
+ attrNames = value.toLowerCase().split( rspace );
+ l = attrNames.length;
+
+ for ( ; i < l; i++ ) {
+ name = attrNames[ i ];
+
+ if ( name ) {
+ propName = jQuery.propFix[ name ] || name;
+
+ // See #9699 for explanation of this approach (setting first, then removal)
+ jQuery.attr( elem, name, "" );
+ elem.removeAttribute( getSetAttribute ? name : propName );
+
+ // Set corresponding property to false for boolean attributes
+ if ( rboolean.test( name ) && propName in elem ) {
+ elem[ propName ] = false;
+ }
+ }
+ }
+ }
+ },
+
+ attrHooks: {
+ type: {
+ set: function( elem, value ) {
+ // We can't allow the type property to be changed (since it causes problems in IE)
+ if ( rtype.test( elem.nodeName ) && elem.parentNode ) {
+ jQuery.error( "type property can't be changed" );
+ } else if ( !jQuery.support.radioValue && value === "radio" && jQuery.nodeName(elem, "input") ) {
+ // Setting the type on a radio button after the value resets the value in IE6-9
+ // Reset value to it's default in case type is set after value
+ // This is for element creation
+ var val = elem.value;
+ elem.setAttribute( "type", value );
+ if ( val ) {
+ elem.value = val;
+ }
+ return value;
+ }
+ }
+ },
+ // Use the value property for back compat
+ // Use the nodeHook for button elements in IE6/7 (#1954)
+ value: {
+ get: function( elem, name ) {
+ if ( nodeHook && jQuery.nodeName( elem, "button" ) ) {
+ return nodeHook.get( elem, name );
+ }
+ return name in elem ?
+ elem.value :
+ null;
+ },
+ set: function( elem, value, name ) {
+ if ( nodeHook && jQuery.nodeName( elem, "button" ) ) {
+ return nodeHook.set( elem, value, name );
+ }
+ // Does not return so that setAttribute is also used
+ elem.value = value;
+ }
+ }
+ },
+
+ propFix: {
+ tabindex: "tabIndex",
+ readonly: "readOnly",
+ "for": "htmlFor",
+ "class": "className",
+ maxlength: "maxLength",
+ cellspacing: "cellSpacing",
+ cellpadding: "cellPadding",
+ rowspan: "rowSpan",
+ colspan: "colSpan",
+ usemap: "useMap",
+ frameborder: "frameBorder",
+ contenteditable: "contentEditable"
+ },
+
+ prop: function( elem, name, value ) {
+ var ret, hooks, notxml,
+ nType = elem.nodeType;
+
+ // don't get/set properties on text, comment and attribute nodes
+ if ( !elem || nType === 3 || nType === 8 || nType === 2 ) {
+ return;
+ }
+
+ notxml = nType !== 1 || !jQuery.isXMLDoc( elem );
+
+ if ( notxml ) {
+ // Fix name and attach hooks
+ name = jQuery.propFix[ name ] || name;
+ hooks = jQuery.propHooks[ name ];
+ }
+
+ if ( value !== undefined ) {
+ if ( hooks && "set" in hooks && (ret = hooks.set( elem, value, name )) !== undefined ) {
+ return ret;
+
+ } else {
+ return ( elem[ name ] = value );
+ }
+
+ } else {
+ if ( hooks && "get" in hooks && (ret = hooks.get( elem, name )) !== null ) {
+ return ret;
+
+ } else {
+ return elem[ name ];
+ }
+ }
+ },
+
+ propHooks: {
+ tabIndex: {
+ get: function( elem ) {
+ // elem.tabIndex doesn't always return the correct value when it hasn't been explicitly set
+ // http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/
+ var attributeNode = elem.getAttributeNode("tabindex");
+
+ return attributeNode && attributeNode.specified ?
+ parseInt( attributeNode.value, 10 ) :
+ rfocusable.test( elem.nodeName ) || rclickable.test( elem.nodeName ) && elem.href ?
+ 0 :
+ undefined;
+ }
+ }
+ }
+});
+
+// Add the tabIndex propHook to attrHooks for back-compat (different case is intentional)
+jQuery.attrHooks.tabindex = jQuery.propHooks.tabIndex;
+
+// Hook for boolean attributes
+boolHook = {
+ get: function( elem, name ) {
+ // Align boolean attributes with corresponding properties
+ // Fall back to attribute presence where some booleans are not supported
+ var attrNode,
+ property = jQuery.prop( elem, name );
+ return property === true || typeof property !== "boolean" && ( attrNode = elem.getAttributeNode(name) ) && attrNode.nodeValue !== false ?
+ name.toLowerCase() :
+ undefined;
+ },
+ set: function( elem, value, name ) {
+ var propName;
+ if ( value === false ) {
+ // Remove boolean attributes when set to false
+ jQuery.removeAttr( elem, name );
+ } else {
+ // value is true since we know at this point it's type boolean and not false
+ // Set boolean attributes to the same name and set the DOM property
+ propName = jQuery.propFix[ name ] || name;
+ if ( propName in elem ) {
+ // Only set the IDL specifically if it already exists on the element
+ elem[ propName ] = true;
+ }
+
+ elem.setAttribute( name, name.toLowerCase() );
+ }
+ return name;
+ }
+};
+
+// IE6/7 do not support getting/setting some attributes with get/setAttribute
+if ( !getSetAttribute ) {
+
+ fixSpecified = {
+ name: true,
+ id: true
+ };
+
+ // Use this for any attribute in IE6/7
+ // This fixes almost every IE6/7 issue
+ nodeHook = jQuery.valHooks.button = {
+ get: function( elem, name ) {
+ var ret;
+ ret = elem.getAttributeNode( name );
+ return ret && ( fixSpecified[ name ] ? ret.nodeValue !== "" : ret.specified ) ?
+ ret.nodeValue :
+ undefined;
+ },
+ set: function( elem, value, name ) {
+ // Set the existing or create a new attribute node
+ var ret = elem.getAttributeNode( name );
+ if ( !ret ) {
+ ret = document.createAttribute( name );
+ elem.setAttributeNode( ret );
+ }
+ return ( ret.nodeValue = value + "" );
+ }
+ };
+
+ // Apply the nodeHook to tabindex
+ jQuery.attrHooks.tabindex.set = nodeHook.set;
+
+ // Set width and height to auto instead of 0 on empty string( Bug #8150 )
+ // This is for removals
+ jQuery.each([ "width", "height" ], function( i, name ) {
+ jQuery.attrHooks[ name ] = jQuery.extend( jQuery.attrHooks[ name ], {
+ set: function( elem, value ) {
+ if ( value === "" ) {
+ elem.setAttribute( name, "auto" );
+ return value;
+ }
+ }
+ });
+ });
+
+ // Set contenteditable to false on removals(#10429)
+ // Setting to empty string throws an error as an invalid value
+ jQuery.attrHooks.contenteditable = {
+ get: nodeHook.get,
+ set: function( elem, value, name ) {
+ if ( value === "" ) {
+ value = "false";
+ }
+ nodeHook.set( elem, value, name );
+ }
+ };
+}
+
+
+// Some attributes require a special call on IE
+if ( !jQuery.support.hrefNormalized ) {
+ jQuery.each([ "href", "src", "width", "height" ], function( i, name ) {
+ jQuery.attrHooks[ name ] = jQuery.extend( jQuery.attrHooks[ name ], {
+ get: function( elem ) {
+ var ret = elem.getAttribute( name, 2 );
+ return ret === null ? undefined : ret;
+ }
+ });
+ });
+}
+
+if ( !jQuery.support.style ) {
+ jQuery.attrHooks.style = {
+ get: function( elem ) {
+ // Return undefined in the case of empty string
+ // Normalize to lowercase since IE uppercases css property names
+ return elem.style.cssText.toLowerCase() || undefined;
+ },
+ set: function( elem, value ) {
+ return ( elem.style.cssText = "" + value );
+ }
+ };
+}
+
+// Safari mis-reports the default selected property of an option
+// Accessing the parent's selectedIndex property fixes it
+if ( !jQuery.support.optSelected ) {
+ jQuery.propHooks.selected = jQuery.extend( jQuery.propHooks.selected, {
+ get: function( elem ) {
+ var parent = elem.parentNode;
+
+ if ( parent ) {
+ parent.selectedIndex;
+
+ // Make sure that it also works with optgroups, see #5701
+ if ( parent.parentNode ) {
+ parent.parentNode.selectedIndex;
+ }
+ }
+ return null;
+ }
+ });
+}
+
+// IE6/7 call enctype encoding
+if ( !jQuery.support.enctype ) {
+ jQuery.propFix.enctype = "encoding";
+}
+
+// Radios and checkboxes getter/setter
+if ( !jQuery.support.checkOn ) {
+ jQuery.each([ "radio", "checkbox" ], function() {
+ jQuery.valHooks[ this ] = {
+ get: function( elem ) {
+ // Handle the case where in Webkit "" is returned instead of "on" if a value isn't specified
+ return elem.getAttribute("value") === null ? "on" : elem.value;
+ }
+ };
+ });
+}
+jQuery.each([ "radio", "checkbox" ], function() {
+ jQuery.valHooks[ this ] = jQuery.extend( jQuery.valHooks[ this ], {
+ set: function( elem, value ) {
+ if ( jQuery.isArray( value ) ) {
+ return ( elem.checked = jQuery.inArray( jQuery(elem).val(), value ) >= 0 );
+ }
+ }
+ });
+});
+
+
+
+
+var rformElems = /^(?:textarea|input|select)$/i,
+ rtypenamespace = /^([^\.]*)?(?:\.(.+))?$/,
+ rhoverHack = /\bhover(\.\S+)?\b/,
+ rkeyEvent = /^key/,
+ rmouseEvent = /^(?:mouse|contextmenu)|click/,
+ rfocusMorph = /^(?:focusinfocus|focusoutblur)$/,
+ rquickIs = /^(\w*)(?:#([\w\-]+))?(?:\.([\w\-]+))?$/,
+ quickParse = function( selector ) {
+ var quick = rquickIs.exec( selector );
+ if ( quick ) {
+ // 0 1 2 3
+ // [ _, tag, id, class ]
+ quick[1] = ( quick[1] || "" ).toLowerCase();
+ quick[3] = quick[3] && new RegExp( "(?:^|\\s)" + quick[3] + "(?:\\s|$)" );
+ }
+ return quick;
+ },
+ quickIs = function( elem, m ) {
+ var attrs = elem.attributes || {};
+ return (
+ (!m[1] || elem.nodeName.toLowerCase() === m[1]) &&
+ (!m[2] || (attrs.id || {}).value === m[2]) &&
+ (!m[3] || m[3].test( (attrs[ "class" ] || {}).value ))
+ );
+ },
+ hoverHack = function( events ) {
+ return jQuery.event.special.hover ? events : events.replace( rhoverHack, "mouseenter$1 mouseleave$1" );
+ };
+
+/*
+ * Helper functions for managing events -- not part of the public interface.
+ * Props to Dean Edwards' addEvent library for many of the ideas.
+ */
+jQuery.event = {
+
+ add: function( elem, types, handler, data, selector ) {
+
+ var elemData, eventHandle, events,
+ t, tns, type, namespaces, handleObj,
+ handleObjIn, quick, handlers, special;
+
+ // Don't attach events to noData or text/comment nodes (allow plain objects tho)
+ if ( elem.nodeType === 3 || elem.nodeType === 8 || !types || !handler || !(elemData = jQuery._data( elem )) ) {
+ return;
+ }
+
+ // Caller can pass in an object of custom data in lieu of the handler
+ if ( handler.handler ) {
+ handleObjIn = handler;
+ handler = handleObjIn.handler;
+ }
+
+ // Make sure that the handler has a unique ID, used to find/remove it later
+ if ( !handler.guid ) {
+ handler.guid = jQuery.guid++;
+ }
+
+ // Init the element's event structure and main handler, if this is the first
+ events = elemData.events;
+ if ( !events ) {
+ elemData.events = events = {};
+ }
+ eventHandle = elemData.handle;
+ if ( !eventHandle ) {
+ elemData.handle = eventHandle = function( e ) {
+ // Discard the second event of a jQuery.event.trigger() and
+ // when an event is called after a page has unloaded
+ return typeof jQuery !== "undefined" && (!e || jQuery.event.triggered !== e.type) ?
+ jQuery.event.dispatch.apply( eventHandle.elem, arguments ) :
+ undefined;
+ };
+ // Add elem as a property of the handle fn to prevent a memory leak with IE non-native events
+ eventHandle.elem = elem;
+ }
+
+ // Handle multiple events separated by a space
+ // jQuery(...).bind("mouseover mouseout", fn);
+ types = jQuery.trim( hoverHack(types) ).split( " " );
+ for ( t = 0; t < types.length; t++ ) {
+
+ tns = rtypenamespace.exec( types[t] ) || [];
+ type = tns[1];
+ namespaces = ( tns[2] || "" ).split( "." ).sort();
+
+ // If event changes its type, use the special event handlers for the changed type
+ special = jQuery.event.special[ type ] || {};
+
+ // If selector defined, determine special event api type, otherwise given type
+ type = ( selector ? special.delegateType : special.bindType ) || type;
+
+ // Update special based on newly reset type
+ special = jQuery.event.special[ type ] || {};
+
+ // handleObj is passed to all event handlers
+ handleObj = jQuery.extend({
+ type: type,
+ origType: tns[1],
+ data: data,
+ handler: handler,
+ guid: handler.guid,
+ selector: selector,
+ quick: quickParse( selector ),
+ namespace: namespaces.join(".")
+ }, handleObjIn );
+
+ // Init the event handler queue if we're the first
+ handlers = events[ type ];
+ if ( !handlers ) {
+ handlers = events[ type ] = [];
+ handlers.delegateCount = 0;
+
+ // Only use addEventListener/attachEvent if the special events handler returns false
+ if ( !special.setup || special.setup.call( elem, data, namespaces, eventHandle ) === false ) {
+ // Bind the global event handler to the element
+ if ( elem.addEventListener ) {
+ elem.addEventListener( type, eventHandle, false );
+
+ } else if ( elem.attachEvent ) {
+ elem.attachEvent( "on" + type, eventHandle );
+ }
+ }
+ }
+
+ if ( special.add ) {
+ special.add.call( elem, handleObj );
+
+ if ( !handleObj.handler.guid ) {
+ handleObj.handler.guid = handler.guid;
+ }
+ }
+
+ // Add to the element's handler list, delegates in front
+ if ( selector ) {
+ handlers.splice( handlers.delegateCount++, 0, handleObj );
+ } else {
+ handlers.push( handleObj );
+ }
+
+ // Keep track of which events have ever been used, for event optimization
+ jQuery.event.global[ type ] = true;
+ }
+
+ // Nullify elem to prevent memory leaks in IE
+ elem = null;
+ },
+
+ global: {},
+
+ // Detach an event or set of events from an element
+ remove: function( elem, types, handler, selector, mappedTypes ) {
+
+ var elemData = jQuery.hasData( elem ) && jQuery._data( elem ),
+ t, tns, type, origType, namespaces, origCount,
+ j, events, special, handle, eventType, handleObj;
+
+ if ( !elemData || !(events = elemData.events) ) {
+ return;
+ }
+
+ // Once for each type.namespace in types; type may be omitted
+ types = jQuery.trim( hoverHack( types || "" ) ).split(" ");
+ for ( t = 0; t < types.length; t++ ) {
+ tns = rtypenamespace.exec( types[t] ) || [];
+ type = origType = tns[1];
+ namespaces = tns[2];
+
+ // Unbind all events (on this namespace, if provided) for the element
+ if ( !type ) {
+ for ( type in events ) {
+ jQuery.event.remove( elem, type + types[ t ], handler, selector, true );
+ }
+ continue;
+ }
+
+ special = jQuery.event.special[ type ] || {};
+ type = ( selector? special.delegateType : special.bindType ) || type;
+ eventType = events[ type ] || [];
+ origCount = eventType.length;
+ namespaces = namespaces ? new RegExp("(^|\\.)" + namespaces.split(".").sort().join("\\.(?:.*\\.)?") + "(\\.|$)") : null;
+
+ // Remove matching events
+ for ( j = 0; j < eventType.length; j++ ) {
+ handleObj = eventType[ j ];
+
+ if ( ( mappedTypes || origType === handleObj.origType ) &&
+ ( !handler || handler.guid === handleObj.guid ) &&
+ ( !namespaces || namespaces.test( handleObj.namespace ) ) &&
+ ( !selector || selector === handleObj.selector || selector === "**" && handleObj.selector ) ) {
+ eventType.splice( j--, 1 );
+
+ if ( handleObj.selector ) {
+ eventType.delegateCount--;
+ }
+ if ( special.remove ) {
+ special.remove.call( elem, handleObj );
+ }
+ }
+ }
+
+ // Remove generic event handler if we removed something and no more handlers exist
+ // (avoids potential for endless recursion during removal of special event handlers)
+ if ( eventType.length === 0 && origCount !== eventType.length ) {
+ if ( !special.teardown || special.teardown.call( elem, namespaces ) === false ) {
+ jQuery.removeEvent( elem, type, elemData.handle );
+ }
+
+ delete events[ type ];
+ }
+ }
+
+ // Remove the expando if it's no longer used
+ if ( jQuery.isEmptyObject( events ) ) {
+ handle = elemData.handle;
+ if ( handle ) {
+ handle.elem = null;
+ }
+
+ // removeData also checks for emptiness and clears the expando if empty
+ // so use it instead of delete
+ jQuery.removeData( elem, [ "events", "handle" ], true );
+ }
+ },
+
+ // Events that are safe to short-circuit if no handlers are attached.
+ // Native DOM events should not be added, they may have inline handlers.
+ customEvent: {
+ "getData": true,
+ "setData": true,
+ "changeData": true
+ },
+
+ trigger: function( event, data, elem, onlyHandlers ) {
+ // Don't do events on text and comment nodes
+ if ( elem && (elem.nodeType === 3 || elem.nodeType === 8) ) {
+ return;
+ }
+
+ // Event object or event type
+ var type = event.type || event,
+ namespaces = [],
+ cache, exclusive, i, cur, old, ontype, special, handle, eventPath, bubbleType;
+
+ // focus/blur morphs to focusin/out; ensure we're not firing them right now
+ if ( rfocusMorph.test( type + jQuery.event.triggered ) ) {
+ return;
+ }
+
+ if ( type.indexOf( "!" ) >= 0 ) {
+ // Exclusive events trigger only for the exact event (no namespaces)
+ type = type.slice(0, -1);
+ exclusive = true;
+ }
+
+ if ( type.indexOf( "." ) >= 0 ) {
+ // Namespaced trigger; create a regexp to match event type in handle()
+ namespaces = type.split(".");
+ type = namespaces.shift();
+ namespaces.sort();
+ }
+
+ if ( (!elem || jQuery.event.customEvent[ type ]) && !jQuery.event.global[ type ] ) {
+ // No jQuery handlers for this event type, and it can't have inline handlers
+ return;
+ }
+
+ // Caller can pass in an Event, Object, or just an event type string
+ event = typeof event === "object" ?
+ // jQuery.Event object
+ event[ jQuery.expando ] ? event :
+ // Object literal
+ new jQuery.Event( type, event ) :
+ // Just the event type (string)
+ new jQuery.Event( type );
+
+ event.type = type;
+ event.isTrigger = true;
+ event.exclusive = exclusive;
+ event.namespace = namespaces.join( "." );
+ event.namespace_re = event.namespace? new RegExp("(^|\\.)" + namespaces.join("\\.(?:.*\\.)?") + "(\\.|$)") : null;
+ ontype = type.indexOf( ":" ) < 0 ? "on" + type : "";
+
+ // Handle a global trigger
+ if ( !elem ) {
+
+ // TODO: Stop taunting the data cache; remove global events and always attach to document
+ cache = jQuery.cache;
+ for ( i in cache ) {
+ if ( cache[ i ].events && cache[ i ].events[ type ] ) {
+ jQuery.event.trigger( event, data, cache[ i ].handle.elem, true );
+ }
+ }
+ return;
+ }
+
+ // Clean up the event in case it is being reused
+ event.result = undefined;
+ if ( !event.target ) {
+ event.target = elem;
+ }
+
+ // Clone any incoming data and prepend the event, creating the handler arg list
+ data = data != null ? jQuery.makeArray( data ) : [];
+ data.unshift( event );
+
+ // Allow special events to draw outside the lines
+ special = jQuery.event.special[ type ] || {};
+ if ( special.trigger && special.trigger.apply( elem, data ) === false ) {
+ return;
+ }
+
+ // Determine event propagation path in advance, per W3C events spec (#9951)
+ // Bubble up to document, then to window; watch for a global ownerDocument var (#9724)
+ eventPath = [[ elem, special.bindType || type ]];
+ if ( !onlyHandlers && !special.noBubble && !jQuery.isWindow( elem ) ) {
+
+ bubbleType = special.delegateType || type;
+ cur = rfocusMorph.test( bubbleType + type ) ? elem : elem.parentNode;
+ old = null;
+ for ( ; cur; cur = cur.parentNode ) {
+ eventPath.push([ cur, bubbleType ]);
+ old = cur;
+ }
+
+ // Only add window if we got to document (e.g., not plain obj or detached DOM)
+ if ( old && old === elem.ownerDocument ) {
+ eventPath.push([ old.defaultView || old.parentWindow || window, bubbleType ]);
+ }
+ }
+
+ // Fire handlers on the event path
+ for ( i = 0; i < eventPath.length && !event.isPropagationStopped(); i++ ) {
+
+ cur = eventPath[i][0];
+ event.type = eventPath[i][1];
+
+ handle = ( jQuery._data( cur, "events" ) || {} )[ event.type ] && jQuery._data( cur, "handle" );
+ if ( handle ) {
+ handle.apply( cur, data );
+ }
+ // Note that this is a bare JS function and not a jQuery handler
+ handle = ontype && cur[ ontype ];
+ if ( handle && jQuery.acceptData( cur ) && handle.apply( cur, data ) === false ) {
+ event.preventDefault();
+ }
+ }
+ event.type = type;
+
+ // If nobody prevented the default action, do it now
+ if ( !onlyHandlers && !event.isDefaultPrevented() ) {
+
+ if ( (!special._default || special._default.apply( elem.ownerDocument, data ) === false) &&
+ !(type === "click" && jQuery.nodeName( elem, "a" )) && jQuery.acceptData( elem ) ) {
+
+ // Call a native DOM method on the target with the same name name as the event.
+ // Can't use an .isFunction() check here because IE6/7 fails that test.
+ // Don't do default actions on window, that's where global variables be (#6170)
+ // IE<9 dies on focus/blur to hidden element (#1486)
+ if ( ontype && elem[ type ] && ((type !== "focus" && type !== "blur") || event.target.offsetWidth !== 0) && !jQuery.isWindow( elem ) ) {
+
+ // Don't re-trigger an onFOO event when we call its FOO() method
+ old = elem[ ontype ];
+
+ if ( old ) {
+ elem[ ontype ] = null;
+ }
+
+ // Prevent re-triggering of the same event, since we already bubbled it above
+ jQuery.event.triggered = type;
+ elem[ type ]();
+ jQuery.event.triggered = undefined;
+
+ if ( old ) {
+ elem[ ontype ] = old;
+ }
+ }
+ }
+ }
+
+ return event.result;
+ },
+
+ dispatch: function( event ) {
+
+ // Make a writable jQuery.Event from the native event object
+ event = jQuery.event.fix( event || window.event );
+
+ var handlers = ( (jQuery._data( this, "events" ) || {} )[ event.type ] || []),
+ delegateCount = handlers.delegateCount,
+ args = [].slice.call( arguments, 0 ),
+ run_all = !event.exclusive && !event.namespace,
+ handlerQueue = [],
+ i, j, cur, jqcur, ret, selMatch, matched, matches, handleObj, sel, related;
+
+ // Use the fix-ed jQuery.Event rather than the (read-only) native event
+ args[0] = event;
+ event.delegateTarget = this;
+
+ // Determine handlers that should run if there are delegated events
+ // Avoid disabled elements in IE (#6911) and non-left-click bubbling in Firefox (#3861)
+ if ( delegateCount && !event.target.disabled && !(event.button && event.type === "click") ) {
+
+ // Pregenerate a single jQuery object for reuse with .is()
+ jqcur = jQuery(this);
+ jqcur.context = this.ownerDocument || this;
+
+ for ( cur = event.target; cur != this; cur = cur.parentNode || this ) {
+ selMatch = {};
+ matches = [];
+ jqcur[0] = cur;
+ for ( i = 0; i < delegateCount; i++ ) {
+ handleObj = handlers[ i ];
+ sel = handleObj.selector;
+
+ if ( selMatch[ sel ] === undefined ) {
+ selMatch[ sel ] = (
+ handleObj.quick ? quickIs( cur, handleObj.quick ) : jqcur.is( sel )
+ );
+ }
+ if ( selMatch[ sel ] ) {
+ matches.push( handleObj );
+ }
+ }
+ if ( matches.length ) {
+ handlerQueue.push({ elem: cur, matches: matches });
+ }
+ }
+ }
+
+ // Add the remaining (directly-bound) handlers
+ if ( handlers.length > delegateCount ) {
+ handlerQueue.push({ elem: this, matches: handlers.slice( delegateCount ) });
+ }
+
+ // Run delegates first; they may want to stop propagation beneath us
+ for ( i = 0; i < handlerQueue.length && !event.isPropagationStopped(); i++ ) {
+ matched = handlerQueue[ i ];
+ event.currentTarget = matched.elem;
+
+ for ( j = 0; j < matched.matches.length && !event.isImmediatePropagationStopped(); j++ ) {
+ handleObj = matched.matches[ j ];
+
+ // Triggered event must either 1) be non-exclusive and have no namespace, or
+ // 2) have namespace(s) a subset or equal to those in the bound event (both can have no namespace).
+ if ( run_all || (!event.namespace && !handleObj.namespace) || event.namespace_re && event.namespace_re.test( handleObj.namespace ) ) {
+
+ event.data = handleObj.data;
+ event.handleObj = handleObj;
+
+ ret = ( (jQuery.event.special[ handleObj.origType ] || {}).handle || handleObj.handler )
+ .apply( matched.elem, args );
+
+ if ( ret !== undefined ) {
+ event.result = ret;
+ if ( ret === false ) {
+ event.preventDefault();
+ event.stopPropagation();
+ }
+ }
+ }
+ }
+ }
+
+ return event.result;
+ },
+
+ // Includes some event props shared by KeyEvent and MouseEvent
+ // *** attrChange attrName relatedNode srcElement are not normalized, non-W3C, deprecated, will be removed in 1.8 ***
+ props: "attrChange attrName relatedNode srcElement altKey bubbles cancelable ctrlKey currentTarget eventPhase metaKey relatedTarget shiftKey target timeStamp view which".split(" "),
+
+ fixHooks: {},
+
+ keyHooks: {
+ props: "char charCode key keyCode".split(" "),
+ filter: function( event, original ) {
+
+ // Add which for key events
+ if ( event.which == null ) {
+ event.which = original.charCode != null ? original.charCode : original.keyCode;
+ }
+
+ return event;
+ }
+ },
+
+ mouseHooks: {
+ props: "button buttons clientX clientY fromElement offsetX offsetY pageX pageY screenX screenY toElement".split(" "),
+ filter: function( event, original ) {
+ var eventDoc, doc, body,
+ button = original.button,
+ fromElement = original.fromElement;
+
+ // Calculate pageX/Y if missing and clientX/Y available
+ if ( event.pageX == null && original.clientX != null ) {
+ eventDoc = event.target.ownerDocument || document;
+ doc = eventDoc.documentElement;
+ body = eventDoc.body;
+
+ event.pageX = original.clientX + ( doc && doc.scrollLeft || body && body.scrollLeft || 0 ) - ( doc && doc.clientLeft || body && body.clientLeft || 0 );
+ event.pageY = original.clientY + ( doc && doc.scrollTop || body && body.scrollTop || 0 ) - ( doc && doc.clientTop || body && body.clientTop || 0 );
+ }
+
+ // Add relatedTarget, if necessary
+ if ( !event.relatedTarget && fromElement ) {
+ event.relatedTarget = fromElement === event.target ? original.toElement : fromElement;
+ }
+
+ // Add which for click: 1 === left; 2 === middle; 3 === right
+ // Note: button is not normalized, so don't use it
+ if ( !event.which && button !== undefined ) {
+ event.which = ( button & 1 ? 1 : ( button & 2 ? 3 : ( button & 4 ? 2 : 0 ) ) );
+ }
+
+ return event;
+ }
+ },
+
+ fix: function( event ) {
+ if ( event[ jQuery.expando ] ) {
+ return event;
+ }
+
+ // Create a writable copy of the event object and normalize some properties
+ var i, prop,
+ originalEvent = event,
+ fixHook = jQuery.event.fixHooks[ event.type ] || {},
+ copy = fixHook.props ? this.props.concat( fixHook.props ) : this.props;
+
+ event = jQuery.Event( originalEvent );
+
+ for ( i = copy.length; i; ) {
+ prop = copy[ --i ];
+ event[ prop ] = originalEvent[ prop ];
+ }
+
+ // Fix target property, if necessary (#1925, IE 6/7/8 & Safari2)
+ if ( !event.target ) {
+ event.target = originalEvent.srcElement || document;
+ }
+
+ // Target should not be a text node (#504, Safari)
+ if ( event.target.nodeType === 3 ) {
+ event.target = event.target.parentNode;
+ }
+
+ // For mouse/key events; add metaKey if it's not there (#3368, IE6/7/8)
+ if ( event.metaKey === undefined ) {
+ event.metaKey = event.ctrlKey;
+ }
+
+ return fixHook.filter? fixHook.filter( event, originalEvent ) : event;
+ },
+
+ special: {
+ ready: {
+ // Make sure the ready event is setup
+ setup: jQuery.bindReady
+ },
+
+ load: {
+ // Prevent triggered image.load events from bubbling to window.load
+ noBubble: true
+ },
+
+ focus: {
+ delegateType: "focusin"
+ },
+ blur: {
+ delegateType: "focusout"
+ },
+
+ beforeunload: {
+ setup: function( data, namespaces, eventHandle ) {
+ // We only want to do this special case on windows
+ if ( jQuery.isWindow( this ) ) {
+ this.onbeforeunload = eventHandle;
+ }
+ },
+
+ teardown: function( namespaces, eventHandle ) {
+ if ( this.onbeforeunload === eventHandle ) {
+ this.onbeforeunload = null;
+ }
+ }
+ }
+ },
+
+ simulate: function( type, elem, event, bubble ) {
+ // Piggyback on a donor event to simulate a different one.
+ // Fake originalEvent to avoid donor's stopPropagation, but if the
+ // simulated event prevents default then we do the same on the donor.
+ var e = jQuery.extend(
+ new jQuery.Event(),
+ event,
+ { type: type,
+ isSimulated: true,
+ originalEvent: {}
+ }
+ );
+ if ( bubble ) {
+ jQuery.event.trigger( e, null, elem );
+ } else {
+ jQuery.event.dispatch.call( elem, e );
+ }
+ if ( e.isDefaultPrevented() ) {
+ event.preventDefault();
+ }
+ }
+};
+
+// Some plugins are using, but it's undocumented/deprecated and will be removed.
+// The 1.7 special event interface should provide all the hooks needed now.
+jQuery.event.handle = jQuery.event.dispatch;
+
+jQuery.removeEvent = document.removeEventListener ?
+ function( elem, type, handle ) {
+ if ( elem.removeEventListener ) {
+ elem.removeEventListener( type, handle, false );
+ }
+ } :
+ function( elem, type, handle ) {
+ if ( elem.detachEvent ) {
+ elem.detachEvent( "on" + type, handle );
+ }
+ };
+
+jQuery.Event = function( src, props ) {
+ // Allow instantiation without the 'new' keyword
+ if ( !(this instanceof jQuery.Event) ) {
+ return new jQuery.Event( src, props );
+ }
+
+ // Event object
+ if ( src && src.type ) {
+ this.originalEvent = src;
+ this.type = src.type;
+
+ // Events bubbling up the document may have been marked as prevented
+ // by a handler lower down the tree; reflect the correct value.
+ this.isDefaultPrevented = ( src.defaultPrevented || src.returnValue === false ||
+ src.getPreventDefault && src.getPreventDefault() ) ? returnTrue : returnFalse;
+
+ // Event type
+ } else {
+ this.type = src;
+ }
+
+ // Put explicitly provided properties onto the event object
+ if ( props ) {
+ jQuery.extend( this, props );
+ }
+
+ // Create a timestamp if incoming event doesn't have one
+ this.timeStamp = src && src.timeStamp || jQuery.now();
+
+ // Mark it as fixed
+ this[ jQuery.expando ] = true;
+};
+
+function returnFalse() {
+ return false;
+}
+function returnTrue() {
+ return true;
+}
+
+// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding
+// http://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html
+jQuery.Event.prototype = {
+ preventDefault: function() {
+ this.isDefaultPrevented = returnTrue;
+
+ var e = this.originalEvent;
+ if ( !e ) {
+ return;
+ }
+
+ // if preventDefault exists run it on the original event
+ if ( e.preventDefault ) {
+ e.preventDefault();
+
+ // otherwise set the returnValue property of the original event to false (IE)
+ } else {
+ e.returnValue = false;
+ }
+ },
+ stopPropagation: function() {
+ this.isPropagationStopped = returnTrue;
+
+ var e = this.originalEvent;
+ if ( !e ) {
+ return;
+ }
+ // if stopPropagation exists run it on the original event
+ if ( e.stopPropagation ) {
+ e.stopPropagation();
+ }
+ // otherwise set the cancelBubble property of the original event to true (IE)
+ e.cancelBubble = true;
+ },
+ stopImmediatePropagation: function() {
+ this.isImmediatePropagationStopped = returnTrue;
+ this.stopPropagation();
+ },
+ isDefaultPrevented: returnFalse,
+ isPropagationStopped: returnFalse,
+ isImmediatePropagationStopped: returnFalse
+};
+
+// Create mouseenter/leave events using mouseover/out and event-time checks
+jQuery.each({
+ mouseenter: "mouseover",
+ mouseleave: "mouseout"
+}, function( orig, fix ) {
+ jQuery.event.special[ orig ] = {
+ delegateType: fix,
+ bindType: fix,
+
+ handle: function( event ) {
+ var target = this,
+ related = event.relatedTarget,
+ handleObj = event.handleObj,
+ selector = handleObj.selector,
+ ret;
+
+ // For mousenter/leave call the handler if related is outside the target.
+ // NB: No relatedTarget if the mouse left/entered the browser window
+ if ( !related || (related !== target && !jQuery.contains( target, related )) ) {
+ event.type = handleObj.origType;
+ ret = handleObj.handler.apply( this, arguments );
+ event.type = fix;
+ }
+ return ret;
+ }
+ };
+});
+
+// IE submit delegation
+if ( !jQuery.support.submitBubbles ) {
+
+ jQuery.event.special.submit = {
+ setup: function() {
+ // Only need this for delegated form submit events
+ if ( jQuery.nodeName( this, "form" ) ) {
+ return false;
+ }
+
+ // Lazy-add a submit handler when a descendant form may potentially be submitted
+ jQuery.event.add( this, "click._submit keypress._submit", function( e ) {
+ // Node name check avoids a VML-related crash in IE (#9807)
+ var elem = e.target,
+ form = jQuery.nodeName( elem, "input" ) || jQuery.nodeName( elem, "button" ) ? elem.form : undefined;
+ if ( form && !form._submit_attached ) {
+ jQuery.event.add( form, "submit._submit", function( event ) {
+ // If form was submitted by the user, bubble the event up the tree
+ if ( this.parentNode && !event.isTrigger ) {
+ jQuery.event.simulate( "submit", this.parentNode, event, true );
+ }
+ });
+ form._submit_attached = true;
+ }
+ });
+ // return undefined since we don't need an event listener
+ },
+
+ teardown: function() {
+ // Only need this for delegated form submit events
+ if ( jQuery.nodeName( this, "form" ) ) {
+ return false;
+ }
+
+ // Remove delegated handlers; cleanData eventually reaps submit handlers attached above
+ jQuery.event.remove( this, "._submit" );
+ }
+ };
+}
+
+// IE change delegation and checkbox/radio fix
+if ( !jQuery.support.changeBubbles ) {
+
+ jQuery.event.special.change = {
+
+ setup: function() {
+
+ if ( rformElems.test( this.nodeName ) ) {
+ // IE doesn't fire change on a check/radio until blur; trigger it on click
+ // after a propertychange. Eat the blur-change in special.change.handle.
+ // This still fires onchange a second time for check/radio after blur.
+ if ( this.type === "checkbox" || this.type === "radio" ) {
+ jQuery.event.add( this, "propertychange._change", function( event ) {
+ if ( event.originalEvent.propertyName === "checked" ) {
+ this._just_changed = true;
+ }
+ });
+ jQuery.event.add( this, "click._change", function( event ) {
+ if ( this._just_changed && !event.isTrigger ) {
+ this._just_changed = false;
+ jQuery.event.simulate( "change", this, event, true );
+ }
+ });
+ }
+ return false;
+ }
+ // Delegated event; lazy-add a change handler on descendant inputs
+ jQuery.event.add( this, "beforeactivate._change", function( e ) {
+ var elem = e.target;
+
+ if ( rformElems.test( elem.nodeName ) && !elem._change_attached ) {
+ jQuery.event.add( elem, "change._change", function( event ) {
+ if ( this.parentNode && !event.isSimulated && !event.isTrigger ) {
+ jQuery.event.simulate( "change", this.parentNode, event, true );
+ }
+ });
+ elem._change_attached = true;
+ }
+ });
+ },
+
+ handle: function( event ) {
+ var elem = event.target;
+
+ // Swallow native change events from checkbox/radio, we already triggered them above
+ if ( this !== elem || event.isSimulated || event.isTrigger || (elem.type !== "radio" && elem.type !== "checkbox") ) {
+ return event.handleObj.handler.apply( this, arguments );
+ }
+ },
+
+ teardown: function() {
+ jQuery.event.remove( this, "._change" );
+
+ return rformElems.test( this.nodeName );
+ }
+ };
+}
+
+// Create "bubbling" focus and blur events
+if ( !jQuery.support.focusinBubbles ) {
+ jQuery.each({ focus: "focusin", blur: "focusout" }, function( orig, fix ) {
+
+ // Attach a single capturing handler while someone wants focusin/focusout
+ var attaches = 0,
+ handler = function( event ) {
+ jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ), true );
+ };
+
+ jQuery.event.special[ fix ] = {
+ setup: function() {
+ if ( attaches++ === 0 ) {
+ document.addEventListener( orig, handler, true );
+ }
+ },
+ teardown: function() {
+ if ( --attaches === 0 ) {
+ document.removeEventListener( orig, handler, true );
+ }
+ }
+ };
+ });
+}
+
+jQuery.fn.extend({
+
+ on: function( types, selector, data, fn, /*INTERNAL*/ one ) {
+ var origFn, type;
+
+ // Types can be a map of types/handlers
+ if ( typeof types === "object" ) {
+ // ( types-Object, selector, data )
+ if ( typeof selector !== "string" ) {
+ // ( types-Object, data )
+ data = selector;
+ selector = undefined;
+ }
+ for ( type in types ) {
+ this.on( type, selector, data, types[ type ], one );
+ }
+ return this;
+ }
+
+ if ( data == null && fn == null ) {
+ // ( types, fn )
+ fn = selector;
+ data = selector = undefined;
+ } else if ( fn == null ) {
+ if ( typeof selector === "string" ) {
+ // ( types, selector, fn )
+ fn = data;
+ data = undefined;
+ } else {
+ // ( types, data, fn )
+ fn = data;
+ data = selector;
+ selector = undefined;
+ }
+ }
+ if ( fn === false ) {
+ fn = returnFalse;
+ } else if ( !fn ) {
+ return this;
+ }
+
+ if ( one === 1 ) {
+ origFn = fn;
+ fn = function( event ) {
+ // Can use an empty set, since event contains the info
+ jQuery().off( event );
+ return origFn.apply( this, arguments );
+ };
+ // Use same guid so caller can remove using origFn
+ fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ );
+ }
+ return this.each( function() {
+ jQuery.event.add( this, types, fn, data, selector );
+ });
+ },
+ one: function( types, selector, data, fn ) {
+ return this.on.call( this, types, selector, data, fn, 1 );
+ },
+ off: function( types, selector, fn ) {
+ if ( types && types.preventDefault && types.handleObj ) {
+ // ( event ) dispatched jQuery.Event
+ var handleObj = types.handleObj;
+ jQuery( types.delegateTarget ).off(
+ handleObj.namespace? handleObj.type + "." + handleObj.namespace : handleObj.type,
+ handleObj.selector,
+ handleObj.handler
+ );
+ return this;
+ }
+ if ( typeof types === "object" ) {
+ // ( types-object [, selector] )
+ for ( var type in types ) {
+ this.off( type, selector, types[ type ] );
+ }
+ return this;
+ }
+ if ( selector === false || typeof selector === "function" ) {
+ // ( types [, fn] )
+ fn = selector;
+ selector = undefined;
+ }
+ if ( fn === false ) {
+ fn = returnFalse;
+ }
+ return this.each(function() {
+ jQuery.event.remove( this, types, fn, selector );
+ });
+ },
+
+ bind: function( types, data, fn ) {
+ return this.on( types, null, data, fn );
+ },
+ unbind: function( types, fn ) {
+ return this.off( types, null, fn );
+ },
+
+ live: function( types, data, fn ) {
+ jQuery( this.context ).on( types, this.selector, data, fn );
+ return this;
+ },
+ die: function( types, fn ) {
+ jQuery( this.context ).off( types, this.selector || "**", fn );
+ return this;
+ },
+
+ delegate: function( selector, types, data, fn ) {
+ return this.on( types, selector, data, fn );
+ },
+ undelegate: function( selector, types, fn ) {
+ // ( namespace ) or ( selector, types [, fn] )
+ return arguments.length == 1? this.off( selector, "**" ) : this.off( types, selector, fn );
+ },
+
+ trigger: function( type, data ) {
+ return this.each(function() {
+ jQuery.event.trigger( type, data, this );
+ });
+ },
+ triggerHandler: function( type, data ) {
+ if ( this[0] ) {
+ return jQuery.event.trigger( type, data, this[0], true );
+ }
+ },
+
+ toggle: function( fn ) {
+ // Save reference to arguments for access in closure
+ var args = arguments,
+ guid = fn.guid || jQuery.guid++,
+ i = 0,
+ toggler = function( event ) {
+ // Figure out which function to execute
+ var lastToggle = ( jQuery._data( this, "lastToggle" + fn.guid ) || 0 ) % i;
+ jQuery._data( this, "lastToggle" + fn.guid, lastToggle + 1 );
+
+ // Make sure that clicks stop
+ event.preventDefault();
+
+ // and execute the function
+ return args[ lastToggle ].apply( this, arguments ) || false;
+ };
+
+ // link all the functions, so any of them can unbind this click handler
+ toggler.guid = guid;
+ while ( i < args.length ) {
+ args[ i++ ].guid = guid;
+ }
+
+ return this.click( toggler );
+ },
+
+ hover: function( fnOver, fnOut ) {
+ return this.mouseenter( fnOver ).mouseleave( fnOut || fnOver );
+ }
+});
+
+jQuery.each( ("blur focus focusin focusout load resize scroll unload click dblclick " +
+ "mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave " +
+ "change select submit keydown keypress keyup error contextmenu").split(" "), function( i, name ) {
+
+ // Handle event binding
+ jQuery.fn[ name ] = function( data, fn ) {
+ if ( fn == null ) {
+ fn = data;
+ data = null;
+ }
+
+ return arguments.length > 0 ?
+ this.on( name, null, data, fn ) :
+ this.trigger( name );
+ };
+
+ if ( jQuery.attrFn ) {
+ jQuery.attrFn[ name ] = true;
+ }
+
+ if ( rkeyEvent.test( name ) ) {
+ jQuery.event.fixHooks[ name ] = jQuery.event.keyHooks;
+ }
+
+ if ( rmouseEvent.test( name ) ) {
+ jQuery.event.fixHooks[ name ] = jQuery.event.mouseHooks;
+ }
+});
+
+
+
+/*!
+ * Sizzle CSS Selector Engine
+ * Copyright 2016, The Dojo Foundation
+ * Released under the MIT, BSD, and GPL Licenses.
+ * More information: http://sizzlejs.com/
+ */
+(function(){
+
+var chunker = /((?:\((?:\([^()]+\)|[^()]+)+\)|\[(?:\[[^\[\]]*\]|['"][^'"]*['"]|[^\[\]'"]+)+\]|\\.|[^ >+~,(\[\\]+)+|[>+~])(\s*,\s*)?((?:.|\r|\n)*)/g,
+ expando = "sizcache" + (Math.random() + '').replace('.', ''),
+ done = 0,
+ toString = Object.prototype.toString,
+ hasDuplicate = false,
+ baseHasDuplicate = true,
+ rBackslash = /\\/g,
+ rReturn = /\r\n/g,
+ rNonWord = /\W/;
+
+// Here we check if the JavaScript engine is using some sort of
+// optimization where it does not always call our comparision
+// function. If that is the case, discard the hasDuplicate value.
+// Thus far that includes Google Chrome.
+[0, 0].sort(function() {
+ baseHasDuplicate = false;
+ return 0;
+});
+
+var Sizzle = function( selector, context, results, seed ) {
+ results = results || [];
+ context = context || document;
+
+ var origContext = context;
+
+ if ( context.nodeType !== 1 && context.nodeType !== 9 ) {
+ return [];
+ }
+
+ if ( !selector || typeof selector !== "string" ) {
+ return results;
+ }
+
+ var m, set, checkSet, extra, ret, cur, pop, i,
+ prune = true,
+ contextXML = Sizzle.isXML( context ),
+ parts = [],
+ soFar = selector;
+
+ // Reset the position of the chunker regexp (start from head)
+ do {
+ chunker.exec( "" );
+ m = chunker.exec( soFar );
+
+ if ( m ) {
+ soFar = m[3];
+
+ parts.push( m[1] );
+
+ if ( m[2] ) {
+ extra = m[3];
+ break;
+ }
+ }
+ } while ( m );
+
+ if ( parts.length > 1 && origPOS.exec( selector ) ) {
+
+ if ( parts.length === 2 && Expr.relative[ parts[0] ] ) {
+ set = posProcess( parts[0] + parts[1], context, seed );
+
+ } else {
+ set = Expr.relative[ parts[0] ] ?
+ [ context ] :
+ Sizzle( parts.shift(), context );
+
+ while ( parts.length ) {
+ selector = parts.shift();
+
+ if ( Expr.relative[ selector ] ) {
+ selector += parts.shift();
+ }
+
+ set = posProcess( selector, set, seed );
+ }
+ }
+
+ } else {
+ // Take a shortcut and set the context if the root selector is an ID
+ // (but not if it'll be faster if the inner selector is an ID)
+ if ( !seed && parts.length > 1 && context.nodeType === 9 && !contextXML &&
+ Expr.match.ID.test(parts[0]) && !Expr.match.ID.test(parts[parts.length - 1]) ) {
+
+ ret = Sizzle.find( parts.shift(), context, contextXML );
+ context = ret.expr ?
+ Sizzle.filter( ret.expr, ret.set )[0] :
+ ret.set[0];
+ }
+
+ if ( context ) {
+ ret = seed ?
+ { expr: parts.pop(), set: makeArray(seed) } :
+ Sizzle.find( parts.pop(), parts.length === 1 && (parts[0] === "~" || parts[0] === "+") && context.parentNode ? context.parentNode : context, contextXML );
+
+ set = ret.expr ?
+ Sizzle.filter( ret.expr, ret.set ) :
+ ret.set;
+
+ if ( parts.length > 0 ) {
+ checkSet = makeArray( set );
+
+ } else {
+ prune = false;
+ }
+
+ while ( parts.length ) {
+ cur = parts.pop();
+ pop = cur;
+
+ if ( !Expr.relative[ cur ] ) {
+ cur = "";
+ } else {
+ pop = parts.pop();
+ }
+
+ if ( pop == null ) {
+ pop = context;
+ }
+
+ Expr.relative[ cur ]( checkSet, pop, contextXML );
+ }
+
+ } else {
+ checkSet = parts = [];
+ }
+ }
+
+ if ( !checkSet ) {
+ checkSet = set;
+ }
+
+ if ( !checkSet ) {
+ Sizzle.error( cur || selector );
+ }
+
+ if ( toString.call(checkSet) === "[object Array]" ) {
+ if ( !prune ) {
+ results.push.apply( results, checkSet );
+
+ } else if ( context && context.nodeType === 1 ) {
+ for ( i = 0; checkSet[i] != null; i++ ) {
+ if ( checkSet[i] && (checkSet[i] === true || checkSet[i].nodeType === 1 && Sizzle.contains(context, checkSet[i])) ) {
+ results.push( set[i] );
+ }
+ }
+
+ } else {
+ for ( i = 0; checkSet[i] != null; i++ ) {
+ if ( checkSet[i] && checkSet[i].nodeType === 1 ) {
+ results.push( set[i] );
+ }
+ }
+ }
+
+ } else {
+ makeArray( checkSet, results );
+ }
+
+ if ( extra ) {
+ Sizzle( extra, origContext, results, seed );
+ Sizzle.uniqueSort( results );
+ }
+
+ return results;
+};
+
+Sizzle.uniqueSort = function( results ) {
+ if ( sortOrder ) {
+ hasDuplicate = baseHasDuplicate;
+ results.sort( sortOrder );
+
+ if ( hasDuplicate ) {
+ for ( var i = 1; i < results.length; i++ ) {
+ if ( results[i] === results[ i - 1 ] ) {
+ results.splice( i--, 1 );
+ }
+ }
+ }
+ }
+
+ return results;
+};
+
+Sizzle.matches = function( expr, set ) {
+ return Sizzle( expr, null, null, set );
+};
+
+Sizzle.matchesSelector = function( node, expr ) {
+ return Sizzle( expr, null, null, [node] ).length > 0;
+};
+
+Sizzle.find = function( expr, context, isXML ) {
+ var set, i, len, match, type, left;
+
+ if ( !expr ) {
+ return [];
+ }
+
+ for ( i = 0, len = Expr.order.length; i < len; i++ ) {
+ type = Expr.order[i];
+
+ if ( (match = Expr.leftMatch[ type ].exec( expr )) ) {
+ left = match[1];
+ match.splice( 1, 1 );
+
+ if ( left.substr( left.length - 1 ) !== "\\" ) {
+ match[1] = (match[1] || "").replace( rBackslash, "" );
+ set = Expr.find[ type ]( match, context, isXML );
+
+ if ( set != null ) {
+ expr = expr.replace( Expr.match[ type ], "" );
+ break;
+ }
+ }
+ }
+ }
+
+ if ( !set ) {
+ set = typeof context.getElementsByTagName !== "undefined" ?
+ context.getElementsByTagName( "*" ) :
+ [];
+ }
+
+ return { set: set, expr: expr };
+};
+
+Sizzle.filter = function( expr, set, inplace, not ) {
+ var match, anyFound,
+ type, found, item, filter, left,
+ i, pass,
+ old = expr,
+ result = [],
+ curLoop = set,
+ isXMLFilter = set && set[0] && Sizzle.isXML( set[0] );
+
+ while ( expr && set.length ) {
+ for ( type in Expr.filter ) {
+ if ( (match = Expr.leftMatch[ type ].exec( expr )) != null && match[2] ) {
+ filter = Expr.filter[ type ];
+ left = match[1];
+
+ anyFound = false;
+
+ match.splice(1,1);
+
+ if ( left.substr( left.length - 1 ) === "\\" ) {
+ continue;
+ }
+
+ if ( curLoop === result ) {
+ result = [];
+ }
+
+ if ( Expr.preFilter[ type ] ) {
+ match = Expr.preFilter[ type ]( match, curLoop, inplace, result, not, isXMLFilter );
+
+ if ( !match ) {
+ anyFound = found = true;
+
+ } else if ( match === true ) {
+ continue;
+ }
+ }
+
+ if ( match ) {
+ for ( i = 0; (item = curLoop[i]) != null; i++ ) {
+ if ( item ) {
+ found = filter( item, match, i, curLoop );
+ pass = not ^ found;
+
+ if ( inplace && found != null ) {
+ if ( pass ) {
+ anyFound = true;
+
+ } else {
+ curLoop[i] = false;
+ }
+
+ } else if ( pass ) {
+ result.push( item );
+ anyFound = true;
+ }
+ }
+ }
+ }
+
+ if ( found !== undefined ) {
+ if ( !inplace ) {
+ curLoop = result;
+ }
+
+ expr = expr.replace( Expr.match[ type ], "" );
+
+ if ( !anyFound ) {
+ return [];
+ }
+
+ break;
+ }
+ }
+ }
+
+ // Improper expression
+ if ( expr === old ) {
+ if ( anyFound == null ) {
+ Sizzle.error( expr );
+
+ } else {
+ break;
+ }
+ }
+
+ old = expr;
+ }
+
+ return curLoop;
+};
+
+Sizzle.error = function( msg ) {
+ throw new Error( "Syntax error, unrecognized expression: " + msg );
+};
+
+/**
+ * Utility function for retreiving the text value of an array of DOM nodes
+ * @param {Array|Element} elem
+ */
+var getText = Sizzle.getText = function( elem ) {
+ var i, node,
+ nodeType = elem.nodeType,
+ ret = "";
+
+ if ( nodeType ) {
+ if ( nodeType === 1 || nodeType === 9 ) {
+ // Use textContent || innerText for elements
+ if ( typeof elem.textContent === 'string' ) {
+ return elem.textContent;
+ } else if ( typeof elem.innerText === 'string' ) {
+ // Replace IE's carriage returns
+ return elem.innerText.replace( rReturn, '' );
+ } else {
+ // Traverse it's children
+ for ( elem = elem.firstChild; elem; elem = elem.nextSibling) {
+ ret += getText( elem );
+ }
+ }
+ } else if ( nodeType === 3 || nodeType === 4 ) {
+ return elem.nodeValue;
+ }
+ } else {
+
+ // If no nodeType, this is expected to be an array
+ for ( i = 0; (node = elem[i]); i++ ) {
+ // Do not traverse comment nodes
+ if ( node.nodeType !== 8 ) {
+ ret += getText( node );
+ }
+ }
+ }
+ return ret;
+};
+
+var Expr = Sizzle.selectors = {
+ order: [ "ID", "NAME", "TAG" ],
+
+ match: {
+ ID: /#((?:[\w\u00c0-\uFFFF\-]|\\.)+)/,
+ CLASS: /\.((?:[\w\u00c0-\uFFFF\-]|\\.)+)/,
+ NAME: /\[name=['"]*((?:[\w\u00c0-\uFFFF\-]|\\.)+)['"]*\]/,
+ ATTR: /\[\s*((?:[\w\u00c0-\uFFFF\-]|\\.)+)\s*(?:(\S?=)\s*(?:(['"])(.*?)\3|(#?(?:[\w\u00c0-\uFFFF\-]|\\.)*)|)|)\s*\]/,
+ TAG: /^((?:[\w\u00c0-\uFFFF\*\-]|\\.)+)/,
+ CHILD: /:(only|nth|last|first)-child(?:\(\s*(even|odd|(?:[+\-]?\d+|(?:[+\-]?\d*)?n\s*(?:[+\-]\s*\d+)?))\s*\))?/,
+ POS: /:(nth|eq|gt|lt|first|last|even|odd)(?:\((\d*)\))?(?=[^\-]|$)/,
+ PSEUDO: /:((?:[\w\u00c0-\uFFFF\-]|\\.)+)(?:\((['"]?)((?:\([^\)]+\)|[^\(\)]*)+)\2\))?/
+ },
+
+ leftMatch: {},
+
+ attrMap: {
+ "class": "className",
+ "for": "htmlFor"
+ },
+
+ attrHandle: {
+ href: function( elem ) {
+ return elem.getAttribute( "href" );
+ },
+ type: function( elem ) {
+ return elem.getAttribute( "type" );
+ }
+ },
+
+ relative: {
+ "+": function(checkSet, part){
+ var isPartStr = typeof part === "string",
+ isTag = isPartStr && !rNonWord.test( part ),
+ isPartStrNotTag = isPartStr && !isTag;
+
+ if ( isTag ) {
+ part = part.toLowerCase();
+ }
+
+ for ( var i = 0, l = checkSet.length, elem; i < l; i++ ) {
+ if ( (elem = checkSet[i]) ) {
+ while ( (elem = elem.previousSibling) && elem.nodeType !== 1 ) {}
+
+ checkSet[i] = isPartStrNotTag || elem && elem.nodeName.toLowerCase() === part ?
+ elem || false :
+ elem === part;
+ }
+ }
+
+ if ( isPartStrNotTag ) {
+ Sizzle.filter( part, checkSet, true );
+ }
+ },
+
+ ">": function( checkSet, part ) {
+ var elem,
+ isPartStr = typeof part === "string",
+ i = 0,
+ l = checkSet.length;
+
+ if ( isPartStr && !rNonWord.test( part ) ) {
+ part = part.toLowerCase();
+
+ for ( ; i < l; i++ ) {
+ elem = checkSet[i];
+
+ if ( elem ) {
+ var parent = elem.parentNode;
+ checkSet[i] = parent.nodeName.toLowerCase() === part ? parent : false;
+ }
+ }
+
+ } else {
+ for ( ; i < l; i++ ) {
+ elem = checkSet[i];
+
+ if ( elem ) {
+ checkSet[i] = isPartStr ?
+ elem.parentNode :
+ elem.parentNode === part;
+ }
+ }
+
+ if ( isPartStr ) {
+ Sizzle.filter( part, checkSet, true );
+ }
+ }
+ },
+
+ "": function(checkSet, part, isXML){
+ var nodeCheck,
+ doneName = done++,
+ checkFn = dirCheck;
+
+ if ( typeof part === "string" && !rNonWord.test( part ) ) {
+ part = part.toLowerCase();
+ nodeCheck = part;
+ checkFn = dirNodeCheck;
+ }
+
+ checkFn( "parentNode", part, doneName, checkSet, nodeCheck, isXML );
+ },
+
+ "~": function( checkSet, part, isXML ) {
+ var nodeCheck,
+ doneName = done++,
+ checkFn = dirCheck;
+
+ if ( typeof part === "string" && !rNonWord.test( part ) ) {
+ part = part.toLowerCase();
+ nodeCheck = part;
+ checkFn = dirNodeCheck;
+ }
+
+ checkFn( "previousSibling", part, doneName, checkSet, nodeCheck, isXML );
+ }
+ },
+
+ find: {
+ ID: function( match, context, isXML ) {
+ if ( typeof context.getElementById !== "undefined" && !isXML ) {
+ var m = context.getElementById(match[1]);
+ // Check parentNode to catch when Blackberry 4.6 returns
+ // nodes that are no longer in the document #6963
+ return m && m.parentNode ? [m] : [];
+ }
+ },
+
+ NAME: function( match, context ) {
+ if ( typeof context.getElementsByName !== "undefined" ) {
+ var ret = [],
+ results = context.getElementsByName( match[1] );
+
+ for ( var i = 0, l = results.length; i < l; i++ ) {
+ if ( results[i].getAttribute("name") === match[1] ) {
+ ret.push( results[i] );
+ }
+ }
+
+ return ret.length === 0 ? null : ret;
+ }
+ },
+
+ TAG: function( match, context ) {
+ if ( typeof context.getElementsByTagName !== "undefined" ) {
+ return context.getElementsByTagName( match[1] );
+ }
+ }
+ },
+ preFilter: {
+ CLASS: function( match, curLoop, inplace, result, not, isXML ) {
+ match = " " + match[1].replace( rBackslash, "" ) + " ";
+
+ if ( isXML ) {
+ return match;
+ }
+
+ for ( var i = 0, elem; (elem = curLoop[i]) != null; i++ ) {
+ if ( elem ) {
+ if ( not ^ (elem.className && (" " + elem.className + " ").replace(/[\t\n\r]/g, " ").indexOf(match) >= 0) ) {
+ if ( !inplace ) {
+ result.push( elem );
+ }
+
+ } else if ( inplace ) {
+ curLoop[i] = false;
+ }
+ }
+ }
+
+ return false;
+ },
+
+ ID: function( match ) {
+ return match[1].replace( rBackslash, "" );
+ },
+
+ TAG: function( match, curLoop ) {
+ return match[1].replace( rBackslash, "" ).toLowerCase();
+ },
+
+ CHILD: function( match ) {
+ if ( match[1] === "nth" ) {
+ if ( !match[2] ) {
+ Sizzle.error( match[0] );
+ }
+
+ match[2] = match[2].replace(/^\+|\s*/g, '');
+
+ // parse equations like 'even', 'odd', '5', '2n', '3n+2', '4n-1', '-n+6'
+ var test = /(-?)(\d*)(?:n([+\-]?\d*))?/.exec(
+ match[2] === "even" && "2n" || match[2] === "odd" && "2n+1" ||
+ !/\D/.test( match[2] ) && "0n+" + match[2] || match[2]);
+
+ // calculate the numbers (first)n+(last) including if they are negative
+ match[2] = (test[1] + (test[2] || 1)) - 0;
+ match[3] = test[3] - 0;
+ }
+ else if ( match[2] ) {
+ Sizzle.error( match[0] );
+ }
+
+ // TODO: Move to normal caching system
+ match[0] = done++;
+
+ return match;
+ },
+
+ ATTR: function( match, curLoop, inplace, result, not, isXML ) {
+ var name = match[1] = match[1].replace( rBackslash, "" );
+
+ if ( !isXML && Expr.attrMap[name] ) {
+ match[1] = Expr.attrMap[name];
+ }
+
+ // Handle if an un-quoted value was used
+ match[4] = ( match[4] || match[5] || "" ).replace( rBackslash, "" );
+
+ if ( match[2] === "~=" ) {
+ match[4] = " " + match[4] + " ";
+ }
+
+ return match;
+ },
+
+ PSEUDO: function( match, curLoop, inplace, result, not ) {
+ if ( match[1] === "not" ) {
+ // If we're dealing with a complex expression, or a simple one
+ if ( ( chunker.exec(match[3]) || "" ).length > 1 || /^\w/.test(match[3]) ) {
+ match[3] = Sizzle(match[3], null, null, curLoop);
+
+ } else {
+ var ret = Sizzle.filter(match[3], curLoop, inplace, true ^ not);
+
+ if ( !inplace ) {
+ result.push.apply( result, ret );
+ }
+
+ return false;
+ }
+
+ } else if ( Expr.match.POS.test( match[0] ) || Expr.match.CHILD.test( match[0] ) ) {
+ return true;
+ }
+
+ return match;
+ },
+
+ POS: function( match ) {
+ match.unshift( true );
+
+ return match;
+ }
+ },
+
+ filters: {
+ enabled: function( elem ) {
+ return elem.disabled === false && elem.type !== "hidden";
+ },
+
+ disabled: function( elem ) {
+ return elem.disabled === true;
+ },
+
+ checked: function( elem ) {
+ return elem.checked === true;
+ },
+
+ selected: function( elem ) {
+ // Accessing this property makes selected-by-default
+ // options in Safari work properly
+ if ( elem.parentNode ) {
+ elem.parentNode.selectedIndex;
+ }
+
+ return elem.selected === true;
+ },
+
+ parent: function( elem ) {
+ return !!elem.firstChild;
+ },
+
+ empty: function( elem ) {
+ return !elem.firstChild;
+ },
+
+ has: function( elem, i, match ) {
+ return !!Sizzle( match[3], elem ).length;
+ },
+
+ header: function( elem ) {
+ return (/h\d/i).test( elem.nodeName );
+ },
+
+ text: function( elem ) {
+ var attr = elem.getAttribute( "type" ), type = elem.type;
+ // IE6 and 7 will map elem.type to 'text' for new HTML5 types (search, etc)
+ // use getAttribute instead to test this case
+ return elem.nodeName.toLowerCase() === "input" && "text" === type && ( attr === type || attr === null );
+ },
+
+ radio: function( elem ) {
+ return elem.nodeName.toLowerCase() === "input" && "radio" === elem.type;
+ },
+
+ checkbox: function( elem ) {
+ return elem.nodeName.toLowerCase() === "input" && "checkbox" === elem.type;
+ },
+
+ file: function( elem ) {
+ return elem.nodeName.toLowerCase() === "input" && "file" === elem.type;
+ },
+
+ password: function( elem ) {
+ return elem.nodeName.toLowerCase() === "input" && "password" === elem.type;
+ },
+
+ submit: function( elem ) {
+ var name = elem.nodeName.toLowerCase();
+ return (name === "input" || name === "button") && "submit" === elem.type;
+ },
+
+ image: function( elem ) {
+ return elem.nodeName.toLowerCase() === "input" && "image" === elem.type;
+ },
+
+ reset: function( elem ) {
+ var name = elem.nodeName.toLowerCase();
+ return (name === "input" || name === "button") && "reset" === elem.type;
+ },
+
+ button: function( elem ) {
+ var name = elem.nodeName.toLowerCase();
+ return name === "input" && "button" === elem.type || name === "button";
+ },
+
+ input: function( elem ) {
+ return (/input|select|textarea|button/i).test( elem.nodeName );
+ },
+
+ focus: function( elem ) {
+ return elem === elem.ownerDocument.activeElement;
+ }
+ },
+ setFilters: {
+ first: function( elem, i ) {
+ return i === 0;
+ },
+
+ last: function( elem, i, match, array ) {
+ return i === array.length - 1;
+ },
+
+ even: function( elem, i ) {
+ return i % 2 === 0;
+ },
+
+ odd: function( elem, i ) {
+ return i % 2 === 1;
+ },
+
+ lt: function( elem, i, match ) {
+ return i < match[3] - 0;
+ },
+
+ gt: function( elem, i, match ) {
+ return i > match[3] - 0;
+ },
+
+ nth: function( elem, i, match ) {
+ return match[3] - 0 === i;
+ },
+
+ eq: function( elem, i, match ) {
+ return match[3] - 0 === i;
+ }
+ },
+ filter: {
+ PSEUDO: function( elem, match, i, array ) {
+ var name = match[1],
+ filter = Expr.filters[ name ];
+
+ if ( filter ) {
+ return filter( elem, i, match, array );
+
+ } else if ( name === "contains" ) {
+ return (elem.textContent || elem.innerText || getText([ elem ]) || "").indexOf(match[3]) >= 0;
+
+ } else if ( name === "not" ) {
+ var not = match[3];
+
+ for ( var j = 0, l = not.length; j < l; j++ ) {
+ if ( not[j] === elem ) {
+ return false;
+ }
+ }
+
+ return true;
+
+ } else {
+ Sizzle.error( name );
+ }
+ },
+
+ CHILD: function( elem, match ) {
+ var first, last,
+ doneName, parent, cache,
+ count, diff,
+ type = match[1],
+ node = elem;
+
+ switch ( type ) {
+ case "only":
+ case "first":
+ while ( (node = node.previousSibling) ) {
+ if ( node.nodeType === 1 ) {
+ return false;
+ }
+ }
+
+ if ( type === "first" ) {
+ return true;
+ }
+
+ node = elem;
+
+ case "last":
+ while ( (node = node.nextSibling) ) {
+ if ( node.nodeType === 1 ) {
+ return false;
+ }
+ }
+
+ return true;
+
+ case "nth":
+ first = match[2];
+ last = match[3];
+
+ if ( first === 1 && last === 0 ) {
+ return true;
+ }
+
+ doneName = match[0];
+ parent = elem.parentNode;
+
+ if ( parent && (parent[ expando ] !== doneName || !elem.nodeIndex) ) {
+ count = 0;
+
+ for ( node = parent.firstChild; node; node = node.nextSibling ) {
+ if ( node.nodeType === 1 ) {
+ node.nodeIndex = ++count;
+ }
+ }
+
+ parent[ expando ] = doneName;
+ }
+
+ diff = elem.nodeIndex - last;
+
+ if ( first === 0 ) {
+ return diff === 0;
+
+ } else {
+ return ( diff % first === 0 && diff / first >= 0 );
+ }
+ }
+ },
+
+ ID: function( elem, match ) {
+ return elem.nodeType === 1 && elem.getAttribute("id") === match;
+ },
+
+ TAG: function( elem, match ) {
+ return (match === "*" && elem.nodeType === 1) || !!elem.nodeName && elem.nodeName.toLowerCase() === match;
+ },
+
+ CLASS: function( elem, match ) {
+ return (" " + (elem.className || elem.getAttribute("class")) + " ")
+ .indexOf( match ) > -1;
+ },
+
+ ATTR: function( elem, match ) {
+ var name = match[1],
+ result = Sizzle.attr ?
+ Sizzle.attr( elem, name ) :
+ Expr.attrHandle[ name ] ?
+ Expr.attrHandle[ name ]( elem ) :
+ elem[ name ] != null ?
+ elem[ name ] :
+ elem.getAttribute( name ),
+ value = result + "",
+ type = match[2],
+ check = match[4];
+
+ return result == null ?
+ type === "!=" :
+ !type && Sizzle.attr ?
+ result != null :
+ type === "=" ?
+ value === check :
+ type === "*=" ?
+ value.indexOf(check) >= 0 :
+ type === "~=" ?
+ (" " + value + " ").indexOf(check) >= 0 :
+ !check ?
+ value && result !== false :
+ type === "!=" ?
+ value !== check :
+ type === "^=" ?
+ value.indexOf(check) === 0 :
+ type === "$=" ?
+ value.substr(value.length - check.length) === check :
+ type === "|=" ?
+ value === check || value.substr(0, check.length + 1) === check + "-" :
+ false;
+ },
+
+ POS: function( elem, match, i, array ) {
+ var name = match[2],
+ filter = Expr.setFilters[ name ];
+
+ if ( filter ) {
+ return filter( elem, i, match, array );
+ }
+ }
+ }
+};
+
+var origPOS = Expr.match.POS,
+ fescape = function(all, num){
+ return "\\" + (num - 0 + 1);
+ };
+
+for ( var type in Expr.match ) {
+ Expr.match[ type ] = new RegExp( Expr.match[ type ].source + (/(?![^\[]*\])(?![^\(]*\))/.source) );
+ Expr.leftMatch[ type ] = new RegExp( /(^(?:.|\r|\n)*?)/.source + Expr.match[ type ].source.replace(/\\(\d+)/g, fescape) );
+}
+
+var makeArray = function( array, results ) {
+ array = Array.prototype.slice.call( array, 0 );
+
+ if ( results ) {
+ results.push.apply( results, array );
+ return results;
+ }
+
+ return array;
+};
+
+// Perform a simple check to determine if the browser is capable of
+// converting a NodeList to an array using builtin methods.
+// Also verifies that the returned array holds DOM nodes
+// (which is not the case in the Blackberry browser)
+try {
+ Array.prototype.slice.call( document.documentElement.childNodes, 0 )[0].nodeType;
+
+// Provide a fallback method if it does not work
+} catch( e ) {
+ makeArray = function( array, results ) {
+ var i = 0,
+ ret = results || [];
+
+ if ( toString.call(array) === "[object Array]" ) {
+ Array.prototype.push.apply( ret, array );
+
+ } else {
+ if ( typeof array.length === "number" ) {
+ for ( var l = array.length; i < l; i++ ) {
+ ret.push( array[i] );
+ }
+
+ } else {
+ for ( ; array[i]; i++ ) {
+ ret.push( array[i] );
+ }
+ }
+ }
+
+ return ret;
+ };
+}
+
+var sortOrder, siblingCheck;
+
+if ( document.documentElement.compareDocumentPosition ) {
+ sortOrder = function( a, b ) {
+ if ( a === b ) {
+ hasDuplicate = true;
+ return 0;
+ }
+
+ if ( !a.compareDocumentPosition || !b.compareDocumentPosition ) {
+ return a.compareDocumentPosition ? -1 : 1;
+ }
+
+ return a.compareDocumentPosition(b) & 4 ? -1 : 1;
+ };
+
+} else {
+ sortOrder = function( a, b ) {
+ // The nodes are identical, we can exit early
+ if ( a === b ) {
+ hasDuplicate = true;
+ return 0;
+
+ // Fallback to using sourceIndex (in IE) if it's available on both nodes
+ } else if ( a.sourceIndex && b.sourceIndex ) {
+ return a.sourceIndex - b.sourceIndex;
+ }
+
+ var al, bl,
+ ap = [],
+ bp = [],
+ aup = a.parentNode,
+ bup = b.parentNode,
+ cur = aup;
+
+ // If the nodes are siblings (or identical) we can do a quick check
+ if ( aup === bup ) {
+ return siblingCheck( a, b );
+
+ // If no parents were found then the nodes are disconnected
+ } else if ( !aup ) {
+ return -1;
+
+ } else if ( !bup ) {
+ return 1;
+ }
+
+ // Otherwise they're somewhere else in the tree so we need
+ // to build up a full list of the parentNodes for comparison
+ while ( cur ) {
+ ap.unshift( cur );
+ cur = cur.parentNode;
+ }
+
+ cur = bup;
+
+ while ( cur ) {
+ bp.unshift( cur );
+ cur = cur.parentNode;
+ }
+
+ al = ap.length;
+ bl = bp.length;
+
+ // Start walking down the tree looking for a discrepancy
+ for ( var i = 0; i < al && i < bl; i++ ) {
+ if ( ap[i] !== bp[i] ) {
+ return siblingCheck( ap[i], bp[i] );
+ }
+ }
+
+ // We ended someplace up the tree so do a sibling check
+ return i === al ?
+ siblingCheck( a, bp[i], -1 ) :
+ siblingCheck( ap[i], b, 1 );
+ };
+
+ siblingCheck = function( a, b, ret ) {
+ if ( a === b ) {
+ return ret;
+ }
+
+ var cur = a.nextSibling;
+
+ while ( cur ) {
+ if ( cur === b ) {
+ return -1;
+ }
+
+ cur = cur.nextSibling;
+ }
+
+ return 1;
+ };
+}
+
+// Check to see if the browser returns elements by name when
+// querying by getElementById (and provide a workaround)
+(function(){
+ // We're going to inject a fake input element with a specified name
+ var form = document.createElement("div"),
+ id = "script" + (new Date()).getTime(),
+ root = document.documentElement;
+
+ form.innerHTML = "<a name='" + id + "'/>";
+
+ // Inject it into the root element, check its status, and remove it quickly
+ root.insertBefore( form, root.firstChild );
+
+ // The workaround has to do additional checks after a getElementById
+ // Which slows things down for other browsers (hence the branching)
+ if ( document.getElementById( id ) ) {
+ Expr.find.ID = function( match, context, isXML ) {
+ if ( typeof context.getElementById !== "undefined" && !isXML ) {
+ var m = context.getElementById(match[1]);
+
+ return m ?
+ m.id === match[1] || typeof m.getAttributeNode !== "undefined" && m.getAttributeNode("id").nodeValue === match[1] ?
+ [m] :
+ undefined :
+ [];
+ }
+ };
+
+ Expr.filter.ID = function( elem, match ) {
+ var node = typeof elem.getAttributeNode !== "undefined" && elem.getAttributeNode("id");
+
+ return elem.nodeType === 1 && node && node.nodeValue === match;
+ };
+ }
+
+ root.removeChild( form );
+
+ // release memory in IE
+ root = form = null;
+})();
+
+(function(){
+ // Check to see if the browser returns only elements
+ // when doing getElementsByTagName("*")
+
+ // Create a fake element
+ var div = document.createElement("div");
+ div.appendChild( document.createComment("") );
+
+ // Make sure no comments are found
+ if ( div.getElementsByTagName("*").length > 0 ) {
+ Expr.find.TAG = function( match, context ) {
+ var results = context.getElementsByTagName( match[1] );
+
+ // Filter out possible comments
+ if ( match[1] === "*" ) {
+ var tmp = [];
+
+ for ( var i = 0; results[i]; i++ ) {
+ if ( results[i].nodeType === 1 ) {
+ tmp.push( results[i] );
+ }
+ }
+
+ results = tmp;
+ }
+
+ return results;
+ };
+ }
+
+ // Check to see if an attribute returns normalized href attributes
+ div.innerHTML = "<a href='#'></a>";
+
+ if ( div.firstChild && typeof div.firstChild.getAttribute !== "undefined" &&
+ div.firstChild.getAttribute("href") !== "#" ) {
+
+ Expr.attrHandle.href = function( elem ) {
+ return elem.getAttribute( "href", 2 );
+ };
+ }
+
+ // release memory in IE
+ div = null;
+})();
+
+if ( document.querySelectorAll ) {
+ (function(){
+ var oldSizzle = Sizzle,
+ div = document.createElement("div"),
+ id = "__sizzle__";
+
+ div.innerHTML = "<p class='TEST'></p>";
+
+ // Safari can't handle uppercase or unicode characters when
+ // in quirks mode.
+ if ( div.querySelectorAll && div.querySelectorAll(".TEST").length === 0 ) {
+ return;
+ }
+
+ Sizzle = function( query, context, extra, seed ) {
+ context = context || document;
+
+ // Only use querySelectorAll on non-XML documents
+ // (ID selectors don't work in non-HTML documents)
+ if ( !seed && !Sizzle.isXML(context) ) {
+ // See if we find a selector to speed up
+ var match = /^(\w+$)|^\.([\w\-]+$)|^#([\w\-]+$)/.exec( query );
+
+ if ( match && (context.nodeType === 1 || context.nodeType === 9) ) {
+ // Speed-up: Sizzle("TAG")
+ if ( match[1] ) {
+ return makeArray( context.getElementsByTagName( query ), extra );
+
+ // Speed-up: Sizzle(".CLASS")
+ } else if ( match[2] && Expr.find.CLASS && context.getElementsByClassName ) {
+ return makeArray( context.getElementsByClassName( match[2] ), extra );
+ }
+ }
+
+ if ( context.nodeType === 9 ) {
+ // Speed-up: Sizzle("body")
+ // The body element only exists once, optimize finding it
+ if ( query === "body" && context.body ) {
+ return makeArray( [ context.body ], extra );
+
+ // Speed-up: Sizzle("#ID")
+ } else if ( match && match[3] ) {
+ var elem = context.getElementById( match[3] );
+
+ // Check parentNode to catch when Blackberry 4.6 returns
+ // nodes that are no longer in the document #6963
+ if ( elem && elem.parentNode ) {
+ // Handle the case where IE and Opera return items
+ // by name instead of ID
+ if ( elem.id === match[3] ) {
+ return makeArray( [ elem ], extra );
+ }
+
+ } else {
+ return makeArray( [], extra );
+ }
+ }
+
+ try {
+ return makeArray( context.querySelectorAll(query), extra );
+ } catch(qsaError) {}
+
+ // qSA works strangely on Element-rooted queries
+ // We can work around this by specifying an extra ID on the root
+ // and working up from there (Thanks to Andrew Dupont for the technique)
+ // IE 8 doesn't work on object elements
+ } else if ( context.nodeType === 1 && context.nodeName.toLowerCase() !== "object" ) {
+ var oldContext = context,
+ old = context.getAttribute( "id" ),
+ nid = old || id,
+ hasParent = context.parentNode,
+ relativeHierarchySelector = /^\s*[+~]/.test( query );
+
+ if ( !old ) {
+ context.setAttribute( "id", nid );
+ } else {
+ nid = nid.replace( /'/g, "\\$&" );
+ }
+ if ( relativeHierarchySelector && hasParent ) {
+ context = context.parentNode;
+ }
+
+ try {
+ if ( !relativeHierarchySelector || hasParent ) {
+ return makeArray( context.querySelectorAll( "[id='" + nid + "'] " + query ), extra );
+ }
+
+ } catch(pseudoError) {
+ } finally {
+ if ( !old ) {
+ oldContext.removeAttribute( "id" );
+ }
+ }
+ }
+ }
+
+ return oldSizzle(query, context, extra, seed);
+ };
+
+ for ( var prop in oldSizzle ) {
+ Sizzle[ prop ] = oldSizzle[ prop ];
+ }
+
+ // release memory in IE
+ div = null;
+ })();
+}
+
+(function(){
+ var html = document.documentElement,
+ matches = html.matchesSelector || html.mozMatchesSelector || html.webkitMatchesSelector || html.msMatchesSelector;
+
+ if ( matches ) {
+ // Check to see if it's possible to do matchesSelector
+ // on a disconnected node (IE 9 fails this)
+ var disconnectedMatch = !matches.call( document.createElement( "div" ), "div" ),
+ pseudoWorks = false;
+
+ try {
+ // This should fail with an exception
+ // Gecko does not error, returns false instead
+ matches.call( document.documentElement, "[test!='']:sizzle" );
+
+ } catch( pseudoError ) {
+ pseudoWorks = true;
+ }
+
+ Sizzle.matchesSelector = function( node, expr ) {
+ // Make sure that attribute selectors are quoted
+ expr = expr.replace(/\=\s*([^'"\]]*)\s*\]/g, "='$1']");
+
+ if ( !Sizzle.isXML( node ) ) {
+ try {
+ if ( pseudoWorks || !Expr.match.PSEUDO.test( expr ) && !/!=/.test( expr ) ) {
+ var ret = matches.call( node, expr );
+
+ // IE 9's matchesSelector returns false on disconnected nodes
+ if ( ret || !disconnectedMatch ||
+ // As well, disconnected nodes are said to be in a document
+ // fragment in IE 9, so check for that
+ node.document && node.document.nodeType !== 11 ) {
+ return ret;
+ }
+ }
+ } catch(e) {}
+ }
+
+ return Sizzle(expr, null, null, [node]).length > 0;
+ };
+ }
+})();
+
+(function(){
+ var div = document.createElement("div");
+
+ div.innerHTML = "<div class='test e'></div><div class='test'></div>";
+
+ // Opera can't find a second classname (in 9.6)
+ // Also, make sure that getElementsByClassName actually exists
+ if ( !div.getElementsByClassName || div.getElementsByClassName("e").length === 0 ) {
+ return;
+ }
+
+ // Safari caches class attributes, doesn't catch changes (in 3.2)
+ div.lastChild.className = "e";
+
+ if ( div.getElementsByClassName("e").length === 1 ) {
+ return;
+ }
+
+ Expr.order.splice(1, 0, "CLASS");
+ Expr.find.CLASS = function( match, context, isXML ) {
+ if ( typeof context.getElementsByClassName !== "undefined" && !isXML ) {
+ return context.getElementsByClassName(match[1]);
+ }
+ };
+
+ // release memory in IE
+ div = null;
+})();
+
+function dirNodeCheck( dir, cur, doneName, checkSet, nodeCheck, isXML ) {
+ for ( var i = 0, l = checkSet.length; i < l; i++ ) {
+ var elem = checkSet[i];
+
+ if ( elem ) {
+ var match = false;
+
+ elem = elem[dir];
+
+ while ( elem ) {
+ if ( elem[ expando ] === doneName ) {
+ match = checkSet[elem.sizset];
+ break;
+ }
+
+ if ( elem.nodeType === 1 && !isXML ){
+ elem[ expando ] = doneName;
+ elem.sizset = i;
+ }
+
+ if ( elem.nodeName.toLowerCase() === cur ) {
+ match = elem;
+ break;
+ }
+
+ elem = elem[dir];
+ }
+
+ checkSet[i] = match;
+ }
+ }
+}
+
+function dirCheck( dir, cur, doneName, checkSet, nodeCheck, isXML ) {
+ for ( var i = 0, l = checkSet.length; i < l; i++ ) {
+ var elem = checkSet[i];
+
+ if ( elem ) {
+ var match = false;
+
+ elem = elem[dir];
+
+ while ( elem ) {
+ if ( elem[ expando ] === doneName ) {
+ match = checkSet[elem.sizset];
+ break;
+ }
+
+ if ( elem.nodeType === 1 ) {
+ if ( !isXML ) {
+ elem[ expando ] = doneName;
+ elem.sizset = i;
+ }
+
+ if ( typeof cur !== "string" ) {
+ if ( elem === cur ) {
+ match = true;
+ break;
+ }
+
+ } else if ( Sizzle.filter( cur, [elem] ).length > 0 ) {
+ match = elem;
+ break;
+ }
+ }
+
+ elem = elem[dir];
+ }
+
+ checkSet[i] = match;
+ }
+ }
+}
+
+if ( document.documentElement.contains ) {
+ Sizzle.contains = function( a, b ) {
+ return a !== b && (a.contains ? a.contains(b) : true);
+ };
+
+} else if ( document.documentElement.compareDocumentPosition ) {
+ Sizzle.contains = function( a, b ) {
+ return !!(a.compareDocumentPosition(b) & 16);
+ };
+
+} else {
+ Sizzle.contains = function() {
+ return false;
+ };
+}
+
+Sizzle.isXML = function( elem ) {
+ // documentElement is verified for cases where it doesn't yet exist
+ // (such as loading iframes in IE - #4833)
+ var documentElement = (elem ? elem.ownerDocument || elem : 0).documentElement;
+
+ return documentElement ? documentElement.nodeName !== "HTML" : false;
+};
+
+var posProcess = function( selector, context, seed ) {
+ var match,
+ tmpSet = [],
+ later = "",
+ root = context.nodeType ? [context] : context;
+
+ // Position selectors must be done after the filter
+ // And so must :not(positional) so we move all PSEUDOs to the end
+ while ( (match = Expr.match.PSEUDO.exec( selector )) ) {
+ later += match[0];
+ selector = selector.replace( Expr.match.PSEUDO, "" );
+ }
+
+ selector = Expr.relative[selector] ? selector + "*" : selector;
+
+ for ( var i = 0, l = root.length; i < l; i++ ) {
+ Sizzle( selector, root[i], tmpSet, seed );
+ }
+
+ return Sizzle.filter( later, tmpSet );
+};
+
+// EXPOSE
+// Override sizzle attribute retrieval
+Sizzle.attr = jQuery.attr;
+Sizzle.selectors.attrMap = {};
+jQuery.find = Sizzle;
+jQuery.expr = Sizzle.selectors;
+jQuery.expr[":"] = jQuery.expr.filters;
+jQuery.unique = Sizzle.uniqueSort;
+jQuery.text = Sizzle.getText;
+jQuery.isXMLDoc = Sizzle.isXML;
+jQuery.contains = Sizzle.contains;
+
+
+})();
+
+
+var runtil = /Until$/,
+ rparentsprev = /^(?:parents|prevUntil|prevAll)/,
+ // Note: This RegExp should be improved, or likely pulled from Sizzle
+ rmultiselector = /,/,
+ isSimple = /^.[^:#\[\.,]*$/,
+ slice = Array.prototype.slice,
+ POS = jQuery.expr.match.POS,
+ // methods guaranteed to produce a unique set when starting from a unique set
+ guaranteedUnique = {
+ children: true,
+ contents: true,
+ next: true,
+ prev: true
+ };
+
+jQuery.fn.extend({
+ find: function( selector ) {
+ var self = this,
+ i, l;
+
+ if ( typeof selector !== "string" ) {
+ return jQuery( selector ).filter(function() {
+ for ( i = 0, l = self.length; i < l; i++ ) {
+ if ( jQuery.contains( self[ i ], this ) ) {
+ return true;
+ }
+ }
+ });
+ }
+
+ var ret = this.pushStack( "", "find", selector ),
+ length, n, r;
+
+ for ( i = 0, l = this.length; i < l; i++ ) {
+ length = ret.length;
+ jQuery.find( selector, this[i], ret );
+
+ if ( i > 0 ) {
+ // Make sure that the results are unique
+ for ( n = length; n < ret.length; n++ ) {
+ for ( r = 0; r < length; r++ ) {
+ if ( ret[r] === ret[n] ) {
+ ret.splice(n--, 1);
+ break;
+ }
+ }
+ }
+ }
+ }
+
+ return ret;
+ },
+
+ has: function( target ) {
+ var targets = jQuery( target );
+ return this.filter(function() {
+ for ( var i = 0, l = targets.length; i < l; i++ ) {
+ if ( jQuery.contains( this, targets[i] ) ) {
+ return true;
+ }
+ }
+ });
+ },
+
+ not: function( selector ) {
+ return this.pushStack( winnow(this, selector, false), "not", selector);
+ },
+
+ filter: function( selector ) {
+ return this.pushStack( winnow(this, selector, true), "filter", selector );
+ },
+
+ is: function( selector ) {
+ return !!selector && (
+ typeof selector === "string" ?
+ // If this is a positional selector, check membership in the returned set
+ // so $("p:first").is("p:last") won't return true for a doc with two "p".
+ POS.test( selector ) ?
+ jQuery( selector, this.context ).index( this[0] ) >= 0 :
+ jQuery.filter( selector, this ).length > 0 :
+ this.filter( selector ).length > 0 );
+ },
+
+ closest: function( selectors, context ) {
+ var ret = [], i, l, cur = this[0];
+
+ // Array (deprecated as of jQuery 1.7)
+ if ( jQuery.isArray( selectors ) ) {
+ var level = 1;
+
+ while ( cur && cur.ownerDocument && cur !== context ) {
+ for ( i = 0; i < selectors.length; i++ ) {
+
+ if ( jQuery( cur ).is( selectors[ i ] ) ) {
+ ret.push({ selector: selectors[ i ], elem: cur, level: level });
+ }
+ }
+
+ cur = cur.parentNode;
+ level++;
+ }
+
+ return ret;
+ }
+
+ // String
+ var pos = POS.test( selectors ) || typeof selectors !== "string" ?
+ jQuery( selectors, context || this.context ) :
+ 0;
+
+ for ( i = 0, l = this.length; i < l; i++ ) {
+ cur = this[i];
+
+ while ( cur ) {
+ if ( pos ? pos.index(cur) > -1 : jQuery.find.matchesSelector(cur, selectors) ) {
+ ret.push( cur );
+ break;
+
+ } else {
+ cur = cur.parentNode;
+ if ( !cur || !cur.ownerDocument || cur === context || cur.nodeType === 11 ) {
+ break;
+ }
+ }
+ }
+ }
+
+ ret = ret.length > 1 ? jQuery.unique( ret ) : ret;
+
+ return this.pushStack( ret, "closest", selectors );
+ },
+
+ // Determine the position of an element within
+ // the matched set of elements
+ index: function( elem ) {
+
+ // No argument, return index in parent
+ if ( !elem ) {
+ return ( this[0] && this[0].parentNode ) ? this.prevAll().length : -1;
+ }
+
+ // index in selector
+ if ( typeof elem === "string" ) {
+ return jQuery.inArray( this[0], jQuery( elem ) );
+ }
+
+ // Locate the position of the desired element
+ return jQuery.inArray(
+ // If it receives a jQuery object, the first element is used
+ elem.jquery ? elem[0] : elem, this );
+ },
+
+ add: function( selector, context ) {
+ var set = typeof selector === "string" ?
+ jQuery( selector, context ) :
+ jQuery.makeArray( selector && selector.nodeType ? [ selector ] : selector ),
+ all = jQuery.merge( this.get(), set );
+
+ return this.pushStack( isDisconnected( set[0] ) || isDisconnected( all[0] ) ?
+ all :
+ jQuery.unique( all ) );
+ },
+
+ andSelf: function() {
+ return this.add( this.prevObject );
+ }
+});
+
+// A painfully simple check to see if an element is disconnected
+// from a document (should be improved, where feasible).
+function isDisconnected( node ) {
+ return !node || !node.parentNode || node.parentNode.nodeType === 11;
+}
+
+jQuery.each({
+ parent: function( elem ) {
+ var parent = elem.parentNode;
+ return parent && parent.nodeType !== 11 ? parent : null;
+ },
+ parents: function( elem ) {
+ return jQuery.dir( elem, "parentNode" );
+ },
+ parentsUntil: function( elem, i, until ) {
+ return jQuery.dir( elem, "parentNode", until );
+ },
+ next: function( elem ) {
+ return jQuery.nth( elem, 2, "nextSibling" );
+ },
+ prev: function( elem ) {
+ return jQuery.nth( elem, 2, "previousSibling" );
+ },
+ nextAll: function( elem ) {
+ return jQuery.dir( elem, "nextSibling" );
+ },
+ prevAll: function( elem ) {
+ return jQuery.dir( elem, "previousSibling" );
+ },
+ nextUntil: function( elem, i, until ) {
+ return jQuery.dir( elem, "nextSibling", until );
+ },
+ prevUntil: function( elem, i, until ) {
+ return jQuery.dir( elem, "previousSibling", until );
+ },
+ siblings: function( elem ) {
+ return jQuery.sibling( elem.parentNode.firstChild, elem );
+ },
+ children: function( elem ) {
+ return jQuery.sibling( elem.firstChild );
+ },
+ contents: function( elem ) {
+ return jQuery.nodeName( elem, "iframe" ) ?
+ elem.contentDocument || elem.contentWindow.document :
+ jQuery.makeArray( elem.childNodes );
+ }
+}, function( name, fn ) {
+ jQuery.fn[ name ] = function( until, selector ) {
+ var ret = jQuery.map( this, fn, until );
+
+ if ( !runtil.test( name ) ) {
+ selector = until;
+ }
+
+ if ( selector && typeof selector === "string" ) {
+ ret = jQuery.filter( selector, ret );
+ }
+
+ ret = this.length > 1 && !guaranteedUnique[ name ] ? jQuery.unique( ret ) : ret;
+
+ if ( (this.length > 1 || rmultiselector.test( selector )) && rparentsprev.test( name ) ) {
+ ret = ret.reverse();
+ }
+
+ return this.pushStack( ret, name, slice.call( arguments ).join(",") );
+ };
+});
+
+jQuery.extend({
+ filter: function( expr, elems, not ) {
+ if ( not ) {
+ expr = ":not(" + expr + ")";
+ }
+
+ return elems.length === 1 ?
+ jQuery.find.matchesSelector(elems[0], expr) ? [ elems[0] ] : [] :
+ jQuery.find.matches(expr, elems);
+ },
+
+ dir: function( elem, dir, until ) {
+ var matched = [],
+ cur = elem[ dir ];
+
+ while ( cur && cur.nodeType !== 9 && (until === undefined || cur.nodeType !== 1 || !jQuery( cur ).is( until )) ) {
+ if ( cur.nodeType === 1 ) {
+ matched.push( cur );
+ }
+ cur = cur[dir];
+ }
+ return matched;
+ },
+
+ nth: function( cur, result, dir, elem ) {
+ result = result || 1;
+ var num = 0;
+
+ for ( ; cur; cur = cur[dir] ) {
+ if ( cur.nodeType === 1 && ++num === result ) {
+ break;
+ }
+ }
+
+ return cur;
+ },
+
+ sibling: function( n, elem ) {
+ var r = [];
+
+ for ( ; n; n = n.nextSibling ) {
+ if ( n.nodeType === 1 && n !== elem ) {
+ r.push( n );
+ }
+ }
+
+ return r;
+ }
+});
+
+// Implement the identical functionality for filter and not
+function winnow( elements, qualifier, keep ) {
+
+ // Can't pass null or undefined to indexOf in Firefox 4
+ // Set to 0 to skip string check
+ qualifier = qualifier || 0;
+
+ if ( jQuery.isFunction( qualifier ) ) {
+ return jQuery.grep(elements, function( elem, i ) {
+ var retVal = !!qualifier.call( elem, i, elem );
+ return retVal === keep;
+ });
+
+ } else if ( qualifier.nodeType ) {
+ return jQuery.grep(elements, function( elem, i ) {
+ return ( elem === qualifier ) === keep;
+ });
+
+ } else if ( typeof qualifier === "string" ) {
+ var filtered = jQuery.grep(elements, function( elem ) {
+ return elem.nodeType === 1;
+ });
+
+ if ( isSimple.test( qualifier ) ) {
+ return jQuery.filter(qualifier, filtered, !keep);
+ } else {
+ qualifier = jQuery.filter( qualifier, filtered );
+ }
+ }
+
+ return jQuery.grep(elements, function( elem, i ) {
+ return ( jQuery.inArray( elem, qualifier ) >= 0 ) === keep;
+ });
+}
+
+
+
+
+function createSafeFragment( document ) {
+ var list = nodeNames.split( "|" ),
+ safeFrag = document.createDocumentFragment();
+
+ if ( safeFrag.createElement ) {
+ while ( list.length ) {
+ safeFrag.createElement(
+ list.pop()
+ );
+ }
+ }
+ return safeFrag;
+}
+
+var nodeNames = "abbr|article|aside|audio|canvas|datalist|details|figcaption|figure|footer|" +
+ "header|hgroup|mark|meter|nav|output|progress|section|summary|time|video",
+ rinlinejQuery = / jQuery\d+="(?:\d+|null)"/g,
+ rleadingWhitespace = /^\s+/,
+ rxhtmlTag = /<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/ig,
+ rtagName = /<([\w:]+)/,
+ rtbody = /<tbody/i,
+ rhtml = /<|&#?\w+;/,
+ rnoInnerhtml = /<(?:script|style)/i,
+ rnocache = /<(?:script|object|embed|option|style)/i,
+ rnoshimcache = new RegExp("<(?:" + nodeNames + ")", "i"),
+ // checked="checked" or checked
+ rchecked = /checked\s*(?:[^=]|=\s*.checked.)/i,
+ rscriptType = /\/(java|ecma)script/i,
+ rcleanScript = /^\s*<!(?:\[CDATA\[|\-\-)/,
+ wrapMap = {
+ option: [ 1, "<select multiple='multiple'>", "</select>" ],
+ legend: [ 1, "<fieldset>", "</fieldset>" ],
+ thead: [ 1, "<table>", "</table>" ],
+ tr: [ 2, "<table><tbody>", "</tbody></table>" ],
+ td: [ 3, "<table><tbody><tr>", "</tr></tbody></table>" ],
+ col: [ 2, "<table><tbody></tbody><colgroup>", "</colgroup></table>" ],
+ area: [ 1, "<map>", "</map>" ],
+ _default: [ 0, "", "" ]
+ },
+ safeFragment = createSafeFragment( document );
+
+wrapMap.optgroup = wrapMap.option;
+wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead;
+wrapMap.th = wrapMap.td;
+
+// IE can't serialize <link> and <script> tags normally
+if ( !jQuery.support.htmlSerialize ) {
+ wrapMap._default = [ 1, "div<div>", "</div>" ];
+}
+
+jQuery.fn.extend({
+ text: function( text ) {
+ if ( jQuery.isFunction(text) ) {
+ return this.each(function(i) {
+ var self = jQuery( this );
+
+ self.text( text.call(this, i, self.text()) );
+ });
+ }
+
+ if ( typeof text !== "object" && text !== undefined ) {
+ return this.empty().append( (this[0] && this[0].ownerDocument || document).createTextNode( text ) );
+ }
+
+ return jQuery.text( this );
+ },
+
+ wrapAll: function( html ) {
+ if ( jQuery.isFunction( html ) ) {
+ return this.each(function(i) {
+ jQuery(this).wrapAll( html.call(this, i) );
+ });
+ }
+
+ if ( this[0] ) {
+ // The elements to wrap the target around
+ var wrap = jQuery( html, this[0].ownerDocument ).eq(0).clone(true);
+
+ if ( this[0].parentNode ) {
+ wrap.insertBefore( this[0] );
+ }
+
+ wrap.map(function() {
+ var elem = this;
+
+ while ( elem.firstChild && elem.firstChild.nodeType === 1 ) {
+ elem = elem.firstChild;
+ }
+
+ return elem;
+ }).append( this );
+ }
+
+ return this;
+ },
+
+ wrapInner: function( html ) {
+ if ( jQuery.isFunction( html ) ) {
+ return this.each(function(i) {
+ jQuery(this).wrapInner( html.call(this, i) );
+ });
+ }
+
+ return this.each(function() {
+ var self = jQuery( this ),
+ contents = self.contents();
+
+ if ( contents.length ) {
+ contents.wrapAll( html );
+
+ } else {
+ self.append( html );
+ }
+ });
+ },
+
+ wrap: function( html ) {
+ var isFunction = jQuery.isFunction( html );
+
+ return this.each(function(i) {
+ jQuery( this ).wrapAll( isFunction ? html.call(this, i) : html );
+ });
+ },
+
+ unwrap: function() {
+ return this.parent().each(function() {
+ if ( !jQuery.nodeName( this, "body" ) ) {
+ jQuery( this ).replaceWith( this.childNodes );
+ }
+ }).end();
+ },
+
+ append: function() {
+ return this.domManip(arguments, true, function( elem ) {
+ if ( this.nodeType === 1 ) {
+ this.appendChild( elem );
+ }
+ });
+ },
+
+ prepend: function() {
+ return this.domManip(arguments, true, function( elem ) {
+ if ( this.nodeType === 1 ) {
+ this.insertBefore( elem, this.firstChild );
+ }
+ });
+ },
+
+ before: function() {
+ if ( this[0] && this[0].parentNode ) {
+ return this.domManip(arguments, false, function( elem ) {
+ this.parentNode.insertBefore( elem, this );
+ });
+ } else if ( arguments.length ) {
+ var set = jQuery.clean( arguments );
+ set.push.apply( set, this.toArray() );
+ return this.pushStack( set, "before", arguments );
+ }
+ },
+
+ after: function() {
+ if ( this[0] && this[0].parentNode ) {
+ return this.domManip(arguments, false, function( elem ) {
+ this.parentNode.insertBefore( elem, this.nextSibling );
+ });
+ } else if ( arguments.length ) {
+ var set = this.pushStack( this, "after", arguments );
+ set.push.apply( set, jQuery.clean(arguments) );
+ return set;
+ }
+ },
+
+ // keepData is for internal use only--do not document
+ remove: function( selector, keepData ) {
+ for ( var i = 0, elem; (elem = this[i]) != null; i++ ) {
+ if ( !selector || jQuery.filter( selector, [ elem ] ).length ) {
+ if ( !keepData && elem.nodeType === 1 ) {
+ jQuery.cleanData( elem.getElementsByTagName("*") );
+ jQuery.cleanData( [ elem ] );
+ }
+
+ if ( elem.parentNode ) {
+ elem.parentNode.removeChild( elem );
+ }
+ }
+ }
+
+ return this;
+ },
+
+ empty: function() {
+ for ( var i = 0, elem; (elem = this[i]) != null; i++ ) {
+ // Remove element nodes and prevent memory leaks
+ if ( elem.nodeType === 1 ) {
+ jQuery.cleanData( elem.getElementsByTagName("*") );
+ }
+
+ // Remove any remaining nodes
+ while ( elem.firstChild ) {
+ elem.removeChild( elem.firstChild );
+ }
+ }
+
+ return this;
+ },
+
+ clone: function( dataAndEvents, deepDataAndEvents ) {
+ dataAndEvents = dataAndEvents == null ? false : dataAndEvents;
+ deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents;
+
+ return this.map( function () {
+ return jQuery.clone( this, dataAndEvents, deepDataAndEvents );
+ });
+ },
+
+ html: function( value ) {
+ if ( value === undefined ) {
+ return this[0] && this[0].nodeType === 1 ?
+ this[0].innerHTML.replace(rinlinejQuery, "") :
+ null;
+
+ // See if we can take a shortcut and just use innerHTML
+ } else if ( typeof value === "string" && !rnoInnerhtml.test( value ) &&
+ (jQuery.support.leadingWhitespace || !rleadingWhitespace.test( value )) &&
+ !wrapMap[ (rtagName.exec( value ) || ["", ""])[1].toLowerCase() ] ) {
+
+ value = value.replace(rxhtmlTag, "<$1></$2>");
+
+ try {
+ for ( var i = 0, l = this.length; i < l; i++ ) {
+ // Remove element nodes and prevent memory leaks
+ if ( this[i].nodeType === 1 ) {
+ jQuery.cleanData( this[i].getElementsByTagName("*") );
+ this[i].innerHTML = value;
+ }
+ }
+
+ // If using innerHTML throws an exception, use the fallback method
+ } catch(e) {
+ this.empty().append( value );
+ }
+
+ } else if ( jQuery.isFunction( value ) ) {
+ this.each(function(i){
+ var self = jQuery( this );
+
+ self.html( value.call(this, i, self.html()) );
+ });
+
+ } else {
+ this.empty().append( value );
+ }
+
+ return this;
+ },
+
+ replaceWith: function( value ) {
+ if ( this[0] && this[0].parentNode ) {
+ // Make sure that the elements are removed from the DOM before they are inserted
+ // this can help fix replacing a parent with child elements
+ if ( jQuery.isFunction( value ) ) {
+ return this.each(function(i) {
+ var self = jQuery(this), old = self.html();
+ self.replaceWith( value.call( this, i, old ) );
+ });
+ }
+
+ if ( typeof value !== "string" ) {
+ value = jQuery( value ).detach();
+ }
+
+ return this.each(function() {
+ var next = this.nextSibling,
+ parent = this.parentNode;
+
+ jQuery( this ).remove();
+
+ if ( next ) {
+ jQuery(next).before( value );
+ } else {
+ jQuery(parent).append( value );
+ }
+ });
+ } else {
+ return this.length ?
+ this.pushStack( jQuery(jQuery.isFunction(value) ? value() : value), "replaceWith", value ) :
+ this;
+ }
+ },
+
+ detach: function( selector ) {
+ return this.remove( selector, true );
+ },
+
+ domManip: function( args, table, callback ) {
+ var results, first, fragment, parent,
+ value = args[0],
+ scripts = [];
+
+ // We can't cloneNode fragments that contain checked, in WebKit
+ if ( !jQuery.support.checkClone && arguments.length === 3 && typeof value === "string" && rchecked.test( value ) ) {
+ return this.each(function() {
+ jQuery(this).domManip( args, table, callback, true );
+ });
+ }
+
+ if ( jQuery.isFunction(value) ) {
+ return this.each(function(i) {
+ var self = jQuery(this);
+ args[0] = value.call(this, i, table ? self.html() : undefined);
+ self.domManip( args, table, callback );
+ });
+ }
+
+ if ( this[0] ) {
+ parent = value && value.parentNode;
+
+ // If we're in a fragment, just use that instead of building a new one
+ if ( jQuery.support.parentNode && parent && parent.nodeType === 11 && parent.childNodes.length === this.length ) {
+ results = { fragment: parent };
+
+ } else {
+ results = jQuery.buildFragment( args, this, scripts );
+ }
+
+ fragment = results.fragment;
+
+ if ( fragment.childNodes.length === 1 ) {
+ first = fragment = fragment.firstChild;
+ } else {
+ first = fragment.firstChild;
+ }
+
+ if ( first ) {
+ table = table && jQuery.nodeName( first, "tr" );
+
+ for ( var i = 0, l = this.length, lastIndex = l - 1; i < l; i++ ) {
+ callback.call(
+ table ?
+ root(this[i], first) :
+ this[i],
+ // Make sure that we do not leak memory by inadvertently discarding
+ // the original fragment (which might have attached data) instead of
+ // using it; in addition, use the original fragment object for the last
+ // item instead of first because it can end up being emptied incorrectly
+ // in certain situations (Bug #8070).
+ // Fragments from the fragment cache must always be cloned and never used
+ // in place.
+ results.cacheable || ( l > 1 && i < lastIndex ) ?
+ jQuery.clone( fragment, true, true ) :
+ fragment
+ );
+ }
+ }
+
+ if ( scripts.length ) {
+ jQuery.each( scripts, evalScript );
+ }
+ }
+
+ return this;
+ }
+});
+
+function root( elem, cur ) {
+ return jQuery.nodeName(elem, "table") ?
+ (elem.getElementsByTagName("tbody")[0] ||
+ elem.appendChild(elem.ownerDocument.createElement("tbody"))) :
+ elem;
+}
+
+function cloneCopyEvent( src, dest ) {
+
+ if ( dest.nodeType !== 1 || !jQuery.hasData( src ) ) {
+ return;
+ }
+
+ var type, i, l,
+ oldData = jQuery._data( src ),
+ curData = jQuery._data( dest, oldData ),
+ events = oldData.events;
+
+ if ( events ) {
+ delete curData.handle;
+ curData.events = {};
+
+ for ( type in events ) {
+ for ( i = 0, l = events[ type ].length; i < l; i++ ) {
+ jQuery.event.add( dest, type + ( events[ type ][ i ].namespace ? "." : "" ) + events[ type ][ i ].namespace, events[ type ][ i ], events[ type ][ i ].data );
+ }
+ }
+ }
+
+ // make the cloned public data object a copy from the original
+ if ( curData.data ) {
+ curData.data = jQuery.extend( {}, curData.data );
+ }
+}
+
+function cloneFixAttributes( src, dest ) {
+ var nodeName;
+
+ // We do not need to do anything for non-Elements
+ if ( dest.nodeType !== 1 ) {
+ return;
+ }
+
+ // clearAttributes removes the attributes, which we don't want,
+ // but also removes the attachEvent events, which we *do* want
+ if ( dest.clearAttributes ) {
+ dest.clearAttributes();
+ }
+
+ // mergeAttributes, in contrast, only merges back on the
+ // original attributes, not the events
+ if ( dest.mergeAttributes ) {
+ dest.mergeAttributes( src );
+ }
+
+ nodeName = dest.nodeName.toLowerCase();
+
+ // IE6-8 fail to clone children inside object elements that use
+ // the proprietary classid attribute value (rather than the type
+ // attribute) to identify the type of content to display
+ if ( nodeName === "object" ) {
+ dest.outerHTML = src.outerHTML;
+
+ } else if ( nodeName === "input" && (src.type === "checkbox" || src.type === "radio") ) {
+ // IE6-8 fails to persist the checked state of a cloned checkbox
+ // or radio button. Worse, IE6-7 fail to give the cloned element
+ // a checked appearance if the defaultChecked value isn't also set
+ if ( src.checked ) {
+ dest.defaultChecked = dest.checked = src.checked;
+ }
+
+ // IE6-7 get confused and end up setting the value of a cloned
+ // checkbox/radio button to an empty string instead of "on"
+ if ( dest.value !== src.value ) {
+ dest.value = src.value;
+ }
+
+ // IE6-8 fails to return the selected option to the default selected
+ // state when cloning options
+ } else if ( nodeName === "option" ) {
+ dest.selected = src.defaultSelected;
+
+ // IE6-8 fails to set the defaultValue to the correct value when
+ // cloning other types of input fields
+ } else if ( nodeName === "input" || nodeName === "textarea" ) {
+ dest.defaultValue = src.defaultValue;
+ }
+
+ // Event data gets referenced instead of copied if the expando
+ // gets copied too
+ dest.removeAttribute( jQuery.expando );
+}
+
+jQuery.buildFragment = function( args, nodes, scripts ) {
+ var fragment, cacheable, cacheresults, doc,
+ first = args[ 0 ];
+
+ // nodes may contain either an explicit document object,
+ // a jQuery collection or context object.
+ // If nodes[0] contains a valid object to assign to doc
+ if ( nodes && nodes[0] ) {
+ doc = nodes[0].ownerDocument || nodes[0];
+ }
+
+ // Ensure that an attr object doesn't incorrectly stand in as a document object
+ // Chrome and Firefox seem to allow this to occur and will throw exception
+ // Fixes #8950
+ if ( !doc.createDocumentFragment ) {
+ doc = document;
+ }
+
+ // Only cache "small" (1/2 KB) HTML strings that are associated with the main document
+ // Cloning options loses the selected state, so don't cache them
+ // IE 6 doesn't like it when you put <object> or <embed> elements in a fragment
+ // Also, WebKit does not clone 'checked' attributes on cloneNode, so don't cache
+ // Lastly, IE6,7,8 will not correctly reuse cached fragments that were created from unknown elems #10501
+ if ( args.length === 1 && typeof first === "string" && first.length < 512 && doc === document &&
+ first.charAt(0) === "<" && !rnocache.test( first ) &&
+ (jQuery.support.checkClone || !rchecked.test( first )) &&
+ (jQuery.support.html5Clone || !rnoshimcache.test( first )) ) {
+
+ cacheable = true;
+
+ cacheresults = jQuery.fragments[ first ];
+ if ( cacheresults && cacheresults !== 1 ) {
+ fragment = cacheresults;
+ }
+ }
+
+ if ( !fragment ) {
+ fragment = doc.createDocumentFragment();
+ jQuery.clean( args, doc, fragment, scripts );
+ }
+
+ if ( cacheable ) {
+ jQuery.fragments[ first ] = cacheresults ? fragment : 1;
+ }
+
+ return { fragment: fragment, cacheable: cacheable };
+};
+
+jQuery.fragments = {};
+
+jQuery.each({
+ appendTo: "append",
+ prependTo: "prepend",
+ insertBefore: "before",
+ insertAfter: "after",
+ replaceAll: "replaceWith"
+}, function( name, original ) {
+ jQuery.fn[ name ] = function( selector ) {
+ var ret = [],
+ insert = jQuery( selector ),
+ parent = this.length === 1 && this[0].parentNode;
+
+ if ( parent && parent.nodeType === 11 && parent.childNodes.length === 1 && insert.length === 1 ) {
+ insert[ original ]( this[0] );
+ return this;
+
+ } else {
+ for ( var i = 0, l = insert.length; i < l; i++ ) {
+ var elems = ( i > 0 ? this.clone(true) : this ).get();
+ jQuery( insert[i] )[ original ]( elems );
+ ret = ret.concat( elems );
+ }
+
+ return this.pushStack( ret, name, insert.selector );
+ }
+ };
+});
+
+function getAll( elem ) {
+ if ( typeof elem.getElementsByTagName !== "undefined" ) {
+ return elem.getElementsByTagName( "*" );
+
+ } else if ( typeof elem.querySelectorAll !== "undefined" ) {
+ return elem.querySelectorAll( "*" );
+
+ } else {
+ return [];
+ }
+}
+
+// Used in clean, fixes the defaultChecked property
+function fixDefaultChecked( elem ) {
+ if ( elem.type === "checkbox" || elem.type === "radio" ) {
+ elem.defaultChecked = elem.checked;
+ }
+}
+// Finds all inputs and passes them to fixDefaultChecked
+function findInputs( elem ) {
+ var nodeName = ( elem.nodeName || "" ).toLowerCase();
+ if ( nodeName === "input" ) {
+ fixDefaultChecked( elem );
+ // Skip scripts, get other children
+ } else if ( nodeName !== "script" && typeof elem.getElementsByTagName !== "undefined" ) {
+ jQuery.grep( elem.getElementsByTagName("input"), fixDefaultChecked );
+ }
+}
+
+// Derived From: http://www.iecss.com/shimprove/javascript/shimprove.1-0-1.js
+function shimCloneNode( elem ) {
+ var div = document.createElement( "div" );
+ safeFragment.appendChild( div );
+
+ div.innerHTML = elem.outerHTML;
+ return div.firstChild;
+}
+
+jQuery.extend({
+ clone: function( elem, dataAndEvents, deepDataAndEvents ) {
+ var srcElements,
+ destElements,
+ i,
+ // IE<=8 does not properly clone detached, unknown element nodes
+ clone = jQuery.support.html5Clone || !rnoshimcache.test( "<" + elem.nodeName ) ?
+ elem.cloneNode( true ) :
+ shimCloneNode( elem );
+
+ if ( (!jQuery.support.noCloneEvent || !jQuery.support.noCloneChecked) &&
+ (elem.nodeType === 1 || elem.nodeType === 11) && !jQuery.isXMLDoc(elem) ) {
+ // IE copies events bound via attachEvent when using cloneNode.
+ // Calling detachEvent on the clone will also remove the events
+ // from the original. In order to get around this, we use some
+ // proprietary methods to clear the events. Thanks to MooTools
+ // guys for this hotness.
+
+ cloneFixAttributes( elem, clone );
+
+ // Using Sizzle here is crazy slow, so we use getElementsByTagName instead
+ srcElements = getAll( elem );
+ destElements = getAll( clone );
+
+ // Weird iteration because IE will replace the length property
+ // with an element if you are cloning the body and one of the
+ // elements on the page has a name or id of "length"
+ for ( i = 0; srcElements[i]; ++i ) {
+ // Ensure that the destination node is not null; Fixes #9587
+ if ( destElements[i] ) {
+ cloneFixAttributes( srcElements[i], destElements[i] );
+ }
+ }
+ }
+
+ // Copy the events from the original to the clone
+ if ( dataAndEvents ) {
+ cloneCopyEvent( elem, clone );
+
+ if ( deepDataAndEvents ) {
+ srcElements = getAll( elem );
+ destElements = getAll( clone );
+
+ for ( i = 0; srcElements[i]; ++i ) {
+ cloneCopyEvent( srcElements[i], destElements[i] );
+ }
+ }
+ }
+
+ srcElements = destElements = null;
+
+ // Return the cloned set
+ return clone;
+ },
+
+ clean: function( elems, context, fragment, scripts ) {
+ var checkScriptType;
+
+ context = context || document;
+
+ // !context.createElement fails in IE with an error but returns typeof 'object'
+ if ( typeof context.createElement === "undefined" ) {
+ context = context.ownerDocument || context[0] && context[0].ownerDocument || document;
+ }
+
+ var ret = [], j;
+
+ for ( var i = 0, elem; (elem = elems[i]) != null; i++ ) {
+ if ( typeof elem === "number" ) {
+ elem += "";
+ }
+
+ if ( !elem ) {
+ continue;
+ }
+
+ // Convert html string into DOM nodes
+ if ( typeof elem === "string" ) {
+ if ( !rhtml.test( elem ) ) {
+ elem = context.createTextNode( elem );
+ } else {
+ // Fix "XHTML"-style tags in all browsers
+ elem = elem.replace(rxhtmlTag, "<$1></$2>");
+
+ // Trim whitespace, otherwise indexOf won't work as expected
+ var tag = ( rtagName.exec( elem ) || ["", ""] )[1].toLowerCase(),
+ wrap = wrapMap[ tag ] || wrapMap._default,
+ depth = wrap[0],
+ div = context.createElement("div");
+
+ // Append wrapper element to unknown element safe doc fragment
+ if ( context === document ) {
+ // Use the fragment we've already created for this document
+ safeFragment.appendChild( div );
+ } else {
+ // Use a fragment created with the owner document
+ createSafeFragment( context ).appendChild( div );
+ }
+
+ // Go to html and back, then peel off extra wrappers
+ div.innerHTML = wrap[1] + elem + wrap[2];
+
+ // Move to the right depth
+ while ( depth-- ) {
+ div = div.lastChild;
+ }
+
+ // Remove IE's autoinserted <tbody> from table fragments
+ if ( !jQuery.support.tbody ) {
+
+ // String was a <table>, *may* have spurious <tbody>
+ var hasBody = rtbody.test(elem),
+ tbody = tag === "table" && !hasBody ?
+ div.firstChild && div.firstChild.childNodes :
+
+ // String was a bare <thead> or <tfoot>
+ wrap[1] === "<table>" && !hasBody ?
+ div.childNodes :
+ [];
+
+ for ( j = tbody.length - 1; j >= 0 ; --j ) {
+ if ( jQuery.nodeName( tbody[ j ], "tbody" ) && !tbody[ j ].childNodes.length ) {
+ tbody[ j ].parentNode.removeChild( tbody[ j ] );
+ }
+ }
+ }
+
+ // IE completely kills leading whitespace when innerHTML is used
+ if ( !jQuery.support.leadingWhitespace && rleadingWhitespace.test( elem ) ) {
+ div.insertBefore( context.createTextNode( rleadingWhitespace.exec(elem)[0] ), div.firstChild );
+ }
+
+ elem = div.childNodes;
+ }
+ }
+
+ // Resets defaultChecked for any radios and checkboxes
+ // about to be appended to the DOM in IE 6/7 (#8060)
+ var len;
+ if ( !jQuery.support.appendChecked ) {
+ if ( elem[0] && typeof (len = elem.length) === "number" ) {
+ for ( j = 0; j < len; j++ ) {
+ findInputs( elem[j] );
+ }
+ } else {
+ findInputs( elem );
+ }
+ }
+
+ if ( elem.nodeType ) {
+ ret.push( elem );
+ } else {
+ ret = jQuery.merge( ret, elem );
+ }
+ }
+
+ if ( fragment ) {
+ checkScriptType = function( elem ) {
+ return !elem.type || rscriptType.test( elem.type );
+ };
+ for ( i = 0; ret[i]; i++ ) {
+ if ( scripts && jQuery.nodeName( ret[i], "script" ) && (!ret[i].type || ret[i].type.toLowerCase() === "text/javascript") ) {
+ scripts.push( ret[i].parentNode ? ret[i].parentNode.removeChild( ret[i] ) : ret[i] );
+
+ } else {
+ if ( ret[i].nodeType === 1 ) {
+ var jsTags = jQuery.grep( ret[i].getElementsByTagName( "script" ), checkScriptType );
+
+ ret.splice.apply( ret, [i + 1, 0].concat( jsTags ) );
+ }
+ fragment.appendChild( ret[i] );
+ }
+ }
+ }
+
+ return ret;
+ },
+
+ cleanData: function( elems ) {
+ var data, id,
+ cache = jQuery.cache,
+ special = jQuery.event.special,
+ deleteExpando = jQuery.support.deleteExpando;
+
+ for ( var i = 0, elem; (elem = elems[i]) != null; i++ ) {
+ if ( elem.nodeName && jQuery.noData[elem.nodeName.toLowerCase()] ) {
+ continue;
+ }
+
+ id = elem[ jQuery.expando ];
+
+ if ( id ) {
+ data = cache[ id ];
+
+ if ( data && data.events ) {
+ for ( var type in data.events ) {
+ if ( special[ type ] ) {
+ jQuery.event.remove( elem, type );
+
+ // This is a shortcut to avoid jQuery.event.remove's overhead
+ } else {
+ jQuery.removeEvent( elem, type, data.handle );
+ }
+ }
+
+ // Null the DOM reference to avoid IE6/7/8 leak (#7054)
+ if ( data.handle ) {
+ data.handle.elem = null;
+ }
+ }
+
+ if ( deleteExpando ) {
+ delete elem[ jQuery.expando ];
+
+ } else if ( elem.removeAttribute ) {
+ elem.removeAttribute( jQuery.expando );
+ }
+
+ delete cache[ id ];
+ }
+ }
+ }
+});
+
+function evalScript( i, elem ) {
+ if ( elem.src ) {
+ jQuery.ajax({
+ url: elem.src,
+ async: false,
+ dataType: "script"
+ });
+ } else {
+ jQuery.globalEval( ( elem.text || elem.textContent || elem.innerHTML || "" ).replace( rcleanScript, "/*$0*/" ) );
+ }
+
+ if ( elem.parentNode ) {
+ elem.parentNode.removeChild( elem );
+ }
+}
+
+
+
+
+var ralpha = /alpha\([^)]*\)/i,
+ ropacity = /opacity=([^)]*)/,
+ // fixed for IE9, see #8346
+ rupper = /([A-Z]|^ms)/g,
+ rnumpx = /^-?\d+(?:px)?$/i,
+ rnum = /^-?\d/,
+ rrelNum = /^([\-+])=([\-+.\de]+)/,
+
+ cssShow = { position: "absolute", visibility: "hidden", display: "block" },
+ cssWidth = [ "Left", "Right" ],
+ cssHeight = [ "Top", "Bottom" ],
+ curCSS,
+
+ getComputedStyle,
+ currentStyle;
+
+jQuery.fn.css = function( name, value ) {
+ // Setting 'undefined' is a no-op
+ if ( arguments.length === 2 && value === undefined ) {
+ return this;
+ }
+
+ return jQuery.access( this, name, value, true, function( elem, name, value ) {
+ return value !== undefined ?
+ jQuery.style( elem, name, value ) :
+ jQuery.css( elem, name );
+ });
+};
+
+jQuery.extend({
+ // Add in style property hooks for overriding the default
+ // behavior of getting and setting a style property
+ cssHooks: {
+ opacity: {
+ get: function( elem, computed ) {
+ if ( computed ) {
+ // We should always get a number back from opacity
+ var ret = curCSS( elem, "opacity", "opacity" );
+ return ret === "" ? "1" : ret;
+
+ } else {
+ return elem.style.opacity;
+ }
+ }
+ }
+ },
+
+ // Exclude the following css properties to add px
+ cssNumber: {
+ "fillOpacity": true,
+ "fontWeight": true,
+ "lineHeight": true,
+ "opacity": true,
+ "orphans": true,
+ "widows": true,
+ "zIndex": true,
+ "zoom": true
+ },
+
+ // Add in properties whose names you wish to fix before
+ // setting or getting the value
+ cssProps: {
+ // normalize float css property
+ "float": jQuery.support.cssFloat ? "cssFloat" : "styleFloat"
+ },
+
+ // Get and set the style property on a DOM Node
+ style: function( elem, name, value, extra ) {
+ // Don't set styles on text and comment nodes
+ if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) {
+ return;
+ }
+
+ // Make sure that we're working with the right name
+ var ret, type, origName = jQuery.camelCase( name ),
+ style = elem.style, hooks = jQuery.cssHooks[ origName ];
+
+ name = jQuery.cssProps[ origName ] || origName;
+
+ // Check if we're setting a value
+ if ( value !== undefined ) {
+ type = typeof value;
+
+ // convert relative number strings (+= or -=) to relative numbers. #7345
+ if ( type === "string" && (ret = rrelNum.exec( value )) ) {
+ value = ( +( ret[1] + 1) * +ret[2] ) + parseFloat( jQuery.css( elem, name ) );
+ // Fixes bug #9237
+ type = "number";
+ }
+
+ // Make sure that NaN and null values aren't set. See: #7116
+ if ( value == null || type === "number" && isNaN( value ) ) {
+ return;
+ }
+
+ // If a number was passed in, add 'px' to the (except for certain CSS properties)
+ if ( type === "number" && !jQuery.cssNumber[ origName ] ) {
+ value += "px";
+ }
+
+ // If a hook was provided, use that value, otherwise just set the specified value
+ if ( !hooks || !("set" in hooks) || (value = hooks.set( elem, value )) !== undefined ) {
+ // Wrapped to prevent IE from throwing errors when 'invalid' values are provided
+ // Fixes bug #5509
+ try {
+ style[ name ] = value;
+ } catch(e) {}
+ }
+
+ } else {
+ // If a hook was provided get the non-computed value from there
+ if ( hooks && "get" in hooks && (ret = hooks.get( elem, false, extra )) !== undefined ) {
+ return ret;
+ }
+
+ // Otherwise just get the value from the style object
+ return style[ name ];
+ }
+ },
+
+ css: function( elem, name, extra ) {
+ var ret, hooks;
+
+ // Make sure that we're working with the right name
+ name = jQuery.camelCase( name );
+ hooks = jQuery.cssHooks[ name ];
+ name = jQuery.cssProps[ name ] || name;
+
+ // cssFloat needs a special treatment
+ if ( name === "cssFloat" ) {
+ name = "float";
+ }
+
+ // If a hook was provided get the computed value from there
+ if ( hooks && "get" in hooks && (ret = hooks.get( elem, true, extra )) !== undefined ) {
+ return ret;
+
+ // Otherwise, if a way to get the computed value exists, use that
+ } else if ( curCSS ) {
+ return curCSS( elem, name );
+ }
+ },
+
+ // A method for quickly swapping in/out CSS properties to get correct calculations
+ swap: function( elem, options, callback ) {
+ var old = {};
+
+ // Remember the old values, and insert the new ones
+ for ( var name in options ) {
+ old[ name ] = elem.style[ name ];
+ elem.style[ name ] = options[ name ];
+ }
+
+ callback.call( elem );
+
+ // Revert the old values
+ for ( name in options ) {
+ elem.style[ name ] = old[ name ];
+ }
+ }
+});
+
+// DEPRECATED, Use jQuery.css() instead
+jQuery.curCSS = jQuery.css;
+
+jQuery.each(["height", "width"], function( i, name ) {
+ jQuery.cssHooks[ name ] = {
+ get: function( elem, computed, extra ) {
+ var val;
+
+ if ( computed ) {
+ if ( elem.offsetWidth !== 0 ) {
+ return getWH( elem, name, extra );
+ } else {
+ jQuery.swap( elem, cssShow, function() {
+ val = getWH( elem, name, extra );
+ });
+ }
+
+ return val;
+ }
+ },
+
+ set: function( elem, value ) {
+ if ( rnumpx.test( value ) ) {
+ // ignore negative width and height values #1599
+ value = parseFloat( value );
+
+ if ( value >= 0 ) {
+ return value + "px";
+ }
+
+ } else {
+ return value;
+ }
+ }
+ };
+});
+
+if ( !jQuery.support.opacity ) {
+ jQuery.cssHooks.opacity = {
+ get: function( elem, computed ) {
+ // IE uses filters for opacity
+ return ropacity.test( (computed && elem.currentStyle ? elem.currentStyle.filter : elem.style.filter) || "" ) ?
+ ( parseFloat( RegExp.$1 ) / 100 ) + "" :
+ computed ? "1" : "";
+ },
+
+ set: function( elem, value ) {
+ var style = elem.style,
+ currentStyle = elem.currentStyle,
+ opacity = jQuery.isNumeric( value ) ? "alpha(opacity=" + value * 100 + ")" : "",
+ filter = currentStyle && currentStyle.filter || style.filter || "";
+
+ // IE has trouble with opacity if it does not have layout
+ // Force it by setting the zoom level
+ style.zoom = 1;
+
+ // if setting opacity to 1, and no other filters exist - attempt to remove filter attribute #6652
+ if ( value >= 1 && jQuery.trim( filter.replace( ralpha, "" ) ) === "" ) {
+
+ // Setting style.filter to null, "" & " " still leave "filter:" in the cssText
+ // if "filter:" is present at all, clearType is disabled, we want to avoid this
+ // style.removeAttribute is IE Only, but so apparently is this code path...
+ style.removeAttribute( "filter" );
+
+ // if there there is no filter style applied in a css rule, we are done
+ if ( currentStyle && !currentStyle.filter ) {
+ return;
+ }
+ }
+
+ // otherwise, set new filter values
+ style.filter = ralpha.test( filter ) ?
+ filter.replace( ralpha, opacity ) :
+ filter + " " + opacity;
+ }
+ };
+}
+
+jQuery(function() {
+ // This hook cannot be added until DOM ready because the support test
+ // for it is not run until after DOM ready
+ if ( !jQuery.support.reliableMarginRight ) {
+ jQuery.cssHooks.marginRight = {
+ get: function( elem, computed ) {
+ // WebKit Bug 13343 - getComputedStyle returns wrong value for margin-right
+ // Work around by temporarily setting element display to inline-block
+ var ret;
+ jQuery.swap( elem, { "display": "inline-block" }, function() {
+ if ( computed ) {
+ ret = curCSS( elem, "margin-right", "marginRight" );
+ } else {
+ ret = elem.style.marginRight;
+ }
+ });
+ return ret;
+ }
+ };
+ }
+});
+
+if ( document.defaultView && document.defaultView.getComputedStyle ) {
+ getComputedStyle = function( elem, name ) {
+ var ret, defaultView, computedStyle;
+
+ name = name.replace( rupper, "-$1" ).toLowerCase();
+
+ if ( (defaultView = elem.ownerDocument.defaultView) &&
+ (computedStyle = defaultView.getComputedStyle( elem, null )) ) {
+ ret = computedStyle.getPropertyValue( name );
+ if ( ret === "" && !jQuery.contains( elem.ownerDocument.documentElement, elem ) ) {
+ ret = jQuery.style( elem, name );
+ }
+ }
+
+ return ret;
+ };
+}
+
+if ( document.documentElement.currentStyle ) {
+ currentStyle = function( elem, name ) {
+ var left, rsLeft, uncomputed,
+ ret = elem.currentStyle && elem.currentStyle[ name ],
+ style = elem.style;
+
+ // Avoid setting ret to empty string here
+ // so we don't default to auto
+ if ( ret === null && style && (uncomputed = style[ name ]) ) {
+ ret = uncomputed;
+ }
+
+ // From the awesome hack by Dean Edwards
+ // http://erik.eae.net/archives/2007/07/27/18.54.15/#comment-102291
+
+ // If we're not dealing with a regular pixel number
+ // but a number that has a weird ending, we need to convert it to pixels
+ if ( !rnumpx.test( ret ) && rnum.test( ret ) ) {
+
+ // Remember the original values
+ left = style.left;
+ rsLeft = elem.runtimeStyle && elem.runtimeStyle.left;
+
+ // Put in the new values to get a computed value out
+ if ( rsLeft ) {
+ elem.runtimeStyle.left = elem.currentStyle.left;
+ }
+ style.left = name === "fontSize" ? "1em" : ( ret || 0 );
+ ret = style.pixelLeft + "px";
+
+ // Revert the changed values
+ style.left = left;
+ if ( rsLeft ) {
+ elem.runtimeStyle.left = rsLeft;
+ }
+ }
+
+ return ret === "" ? "auto" : ret;
+ };
+}
+
+curCSS = getComputedStyle || currentStyle;
+
+function getWH( elem, name, extra ) {
+
+ // Start with offset property
+ var val = name === "width" ? elem.offsetWidth : elem.offsetHeight,
+ which = name === "width" ? cssWidth : cssHeight,
+ i = 0,
+ len = which.length;
+
+ if ( val > 0 ) {
+ if ( extra !== "border" ) {
+ for ( ; i < len; i++ ) {
+ if ( !extra ) {
+ val -= parseFloat( jQuery.css( elem, "padding" + which[ i ] ) ) || 0;
+ }
+ if ( extra === "margin" ) {
+ val += parseFloat( jQuery.css( elem, extra + which[ i ] ) ) || 0;
+ } else {
+ val -= parseFloat( jQuery.css( elem, "border" + which[ i ] + "Width" ) ) || 0;
+ }
+ }
+ }
+
+ return val + "px";
+ }
+
+ // Fall back to computed then uncomputed css if necessary
+ val = curCSS( elem, name, name );
+ if ( val < 0 || val == null ) {
+ val = elem.style[ name ] || 0;
+ }
+ // Normalize "", auto, and prepare for extra
+ val = parseFloat( val ) || 0;
+
+ // Add padding, border, margin
+ if ( extra ) {
+ for ( ; i < len; i++ ) {
+ val += parseFloat( jQuery.css( elem, "padding" + which[ i ] ) ) || 0;
+ if ( extra !== "padding" ) {
+ val += parseFloat( jQuery.css( elem, "border" + which[ i ] + "Width" ) ) || 0;
+ }
+ if ( extra === "margin" ) {
+ val += parseFloat( jQuery.css( elem, extra + which[ i ] ) ) || 0;
+ }
+ }
+ }
+
+ return val + "px";
+}
+
+if ( jQuery.expr && jQuery.expr.filters ) {
+ jQuery.expr.filters.hidden = function( elem ) {
+ var width = elem.offsetWidth,
+ height = elem.offsetHeight;
+
+ return ( width === 0 && height === 0 ) || (!jQuery.support.reliableHiddenOffsets && ((elem.style && elem.style.display) || jQuery.css( elem, "display" )) === "none");
+ };
+
+ jQuery.expr.filters.visible = function( elem ) {
+ return !jQuery.expr.filters.hidden( elem );
+ };
+}
+
+
+
+
+var r20 = /%20/g,
+ rbracket = /\[\]$/,
+ rCRLF = /\r?\n/g,
+ rhash = /#.*$/,
+ rheaders = /^(.*?):[ \t]*([^\r\n]*)\r?$/mg, // IE leaves an \r character at EOL
+ rinput = /^(?:color|date|datetime|datetime-local|email|hidden|month|number|password|range|search|tel|text|time|url|week)$/i,
+ // #7653, #8125, #8152: local protocol detection
+ rlocalProtocol = /^(?:about|app|app\-storage|.+\-extension|file|res|widget):$/,
+ rnoContent = /^(?:GET|HEAD)$/,
+ rprotocol = /^\/\//,
+ rquery = /\?/,
+ rscript = /<script\b[^<]*(?:(?!<\/script>)<[^<]*)*<\/script>/gi,
+ rselectTextarea = /^(?:select|textarea)/i,
+ rspacesAjax = /\s+/,
+ rts = /([?&])_=[^&]*/,
+ rurl = /^([\w\+\.\-]+:)(?:\/\/([^\/?#:]*)(?::(\d+))?)?/,
+
+ // Keep a copy of the old load method
+ _load = jQuery.fn.load,
+
+ /* Prefilters
+ * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example)
+ * 2) These are called:
+ * - BEFORE asking for a transport
+ * - AFTER param serialization (s.data is a string if s.processData is true)
+ * 3) key is the dataType
+ * 4) the catchall symbol "*" can be used
+ * 5) execution will start with transport dataType and THEN continue down to "*" if needed
+ */
+ prefilters = {},
+
+ /* Transports bindings
+ * 1) key is the dataType
+ * 2) the catchall symbol "*" can be used
+ * 3) selection will start with transport dataType and THEN go to "*" if needed
+ */
+ transports = {},
+
+ // Document location
+ ajaxLocation,
+
+ // Document location segments
+ ajaxLocParts,
+
+ // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression
+ allTypes = ["*/"] + ["*"];
+
+// #8138, IE may throw an exception when accessing
+// a field from window.location if document.domain has been set
+try {
+ ajaxLocation = location.href;
+} catch( e ) {
+ // Use the href attribute of an A element
+ // since IE will modify it given document.location
+ ajaxLocation = document.createElement( "a" );
+ ajaxLocation.href = "";
+ ajaxLocation = ajaxLocation.href;
+}
+
+// Segment location into parts
+ajaxLocParts = rurl.exec( ajaxLocation.toLowerCase() ) || [];
+
+// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport
+function addToPrefiltersOrTransports( structure ) {
+
+ // dataTypeExpression is optional and defaults to "*"
+ return function( dataTypeExpression, func ) {
+
+ if ( typeof dataTypeExpression !== "string" ) {
+ func = dataTypeExpression;
+ dataTypeExpression = "*";
+ }
+
+ if ( jQuery.isFunction( func ) ) {
+ var dataTypes = dataTypeExpression.toLowerCase().split( rspacesAjax ),
+ i = 0,
+ length = dataTypes.length,
+ dataType,
+ list,
+ placeBefore;
+
+ // For each dataType in the dataTypeExpression
+ for ( ; i < length; i++ ) {
+ dataType = dataTypes[ i ];
+ // We control if we're asked to add before
+ // any existing element
+ placeBefore = /^\+/.test( dataType );
+ if ( placeBefore ) {
+ dataType = dataType.substr( 1 ) || "*";
+ }
+ list = structure[ dataType ] = structure[ dataType ] || [];
+ // then we add to the structure accordingly
+ list[ placeBefore ? "unshift" : "push" ]( func );
+ }
+ }
+ };
+}
+
+// Base inspection function for prefilters and transports
+function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR,
+ dataType /* internal */, inspected /* internal */ ) {
+
+ dataType = dataType || options.dataTypes[ 0 ];
+ inspected = inspected || {};
+
+ inspected[ dataType ] = true;
+
+ var list = structure[ dataType ],
+ i = 0,
+ length = list ? list.length : 0,
+ executeOnly = ( structure === prefilters ),
+ selection;
+
+ for ( ; i < length && ( executeOnly || !selection ); i++ ) {
+ selection = list[ i ]( options, originalOptions, jqXHR );
+ // If we got redirected to another dataType
+ // we try there if executing only and not done already
+ if ( typeof selection === "string" ) {
+ if ( !executeOnly || inspected[ selection ] ) {
+ selection = undefined;
+ } else {
+ options.dataTypes.unshift( selection );
+ selection = inspectPrefiltersOrTransports(
+ structure, options, originalOptions, jqXHR, selection, inspected );
+ }
+ }
+ }
+ // If we're only executing or nothing was selected
+ // we try the catchall dataType if not done already
+ if ( ( executeOnly || !selection ) && !inspected[ "*" ] ) {
+ selection = inspectPrefiltersOrTransports(
+ structure, options, originalOptions, jqXHR, "*", inspected );
+ }
+ // unnecessary when only executing (prefilters)
+ // but it'll be ignored by the caller in that case
+ return selection;
+}
+
+// A special extend for ajax options
+// that takes "flat" options (not to be deep extended)
+// Fixes #9887
+function ajaxExtend( target, src ) {
+ var key, deep,
+ flatOptions = jQuery.ajaxSettings.flatOptions || {};
+ for ( key in src ) {
+ if ( src[ key ] !== undefined ) {
+ ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ];
+ }
+ }
+ if ( deep ) {
+ jQuery.extend( true, target, deep );
+ }
+}
+
+jQuery.fn.extend({
+ load: function( url, params, callback ) {
+ if ( typeof url !== "string" && _load ) {
+ return _load.apply( this, arguments );
+
+ // Don't do a request if no elements are being requested
+ } else if ( !this.length ) {
+ return this;
+ }
+
+ var off = url.indexOf( " " );
+ if ( off >= 0 ) {
+ var selector = url.slice( off, url.length );
+ url = url.slice( 0, off );
+ }
+
+ // Default to a GET request
+ var type = "GET";
+
+ // If the second parameter was provided
+ if ( params ) {
+ // If it's a function
+ if ( jQuery.isFunction( params ) ) {
+ // We assume that it's the callback
+ callback = params;
+ params = undefined;
+
+ // Otherwise, build a param string
+ } else if ( typeof params === "object" ) {
+ params = jQuery.param( params, jQuery.ajaxSettings.traditional );
+ type = "POST";
+ }
+ }
+
+ var self = this;
+
+ // Request the remote document
+ jQuery.ajax({
+ url: url,
+ type: type,
+ dataType: "html",
+ data: params,
+ // Complete callback (responseText is used internally)
+ complete: function( jqXHR, status, responseText ) {
+ // Store the response as specified by the jqXHR object
+ responseText = jqXHR.responseText;
+ // If successful, inject the HTML into all the matched elements
+ if ( jqXHR.isResolved() ) {
+ // #4825: Get the actual response in case
+ // a dataFilter is present in ajaxSettings
+ jqXHR.done(function( r ) {
+ responseText = r;
+ });
+ // See if a selector was specified
+ self.html( selector ?
+ // Create a dummy div to hold the results
+ jQuery("<div>")
+ // inject the contents of the document in, removing the scripts
+ // to avoid any 'Permission Denied' errors in IE
+ .append(responseText.replace(rscript, ""))
+
+ // Locate the specified elements
+ .find(selector) :
+
+ // If not, just inject the full result
+ responseText );
+ }
+
+ if ( callback ) {
+ self.each( callback, [ responseText, status, jqXHR ] );
+ }
+ }
+ });
+
+ return this;
+ },
+
+ serialize: function() {
+ return jQuery.param( this.serializeArray() );
+ },
+
+ serializeArray: function() {
+ return this.map(function(){
+ return this.elements ? jQuery.makeArray( this.elements ) : this;
+ })
+ .filter(function(){
+ return this.name && !this.disabled &&
+ ( this.checked || rselectTextarea.test( this.nodeName ) ||
+ rinput.test( this.type ) );
+ })
+ .map(function( i, elem ){
+ var val = jQuery( this ).val();
+
+ return val == null ?
+ null :
+ jQuery.isArray( val ) ?
+ jQuery.map( val, function( val, i ){
+ return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) };
+ }) :
+ { name: elem.name, value: val.replace( rCRLF, "\r\n" ) };
+ }).get();
+ }
+});
+
+// Attach a bunch of functions for handling common AJAX events
+jQuery.each( "ajaxStart ajaxStop ajaxComplete ajaxError ajaxSuccess ajaxSend".split( " " ), function( i, o ){
+ jQuery.fn[ o ] = function( f ){
+ return this.on( o, f );
+ };
+});
+
+jQuery.each( [ "get", "post" ], function( i, method ) {
+ jQuery[ method ] = function( url, data, callback, type ) {
+ // shift arguments if data argument was omitted
+ if ( jQuery.isFunction( data ) ) {
+ type = type || callback;
+ callback = data;
+ data = undefined;
+ }
+
+ return jQuery.ajax({
+ type: method,
+ url: url,
+ data: data,
+ success: callback,
+ dataType: type
+ });
+ };
+});
+
+jQuery.extend({
+
+ getScript: function( url, callback ) {
+ return jQuery.get( url, undefined, callback, "script" );
+ },
+
+ getJSON: function( url, data, callback ) {
+ return jQuery.get( url, data, callback, "json" );
+ },
+
+ // Creates a full fledged settings object into target
+ // with both ajaxSettings and settings fields.
+ // If target is omitted, writes into ajaxSettings.
+ ajaxSetup: function( target, settings ) {
+ if ( settings ) {
+ // Building a settings object
+ ajaxExtend( target, jQuery.ajaxSettings );
+ } else {
+ // Extending ajaxSettings
+ settings = target;
+ target = jQuery.ajaxSettings;
+ }
+ ajaxExtend( target, settings );
+ return target;
+ },
+
+ ajaxSettings: {
+ url: ajaxLocation,
+ isLocal: rlocalProtocol.test( ajaxLocParts[ 1 ] ),
+ global: true,
+ type: "GET",
+ contentType: "application/x-www-form-urlencoded",
+ processData: true,
+ async: true,
+ /*
+ timeout: 0,
+ data: null,
+ dataType: null,
+ username: null,
+ password: null,
+ cache: null,
+ traditional: false,
+ headers: {},
+ */
+
+ accepts: {
+ xml: "application/xml, text/xml",
+ html: "text/html",
+ text: "text/plain",
+ json: "application/json, text/javascript",
+ "*": allTypes
+ },
+
+ contents: {
+ xml: /xml/,
+ html: /html/,
+ json: /json/
+ },
+
+ responseFields: {
+ xml: "responseXML",
+ text: "responseText"
+ },
+
+ // List of data converters
+ // 1) key format is "source_type destination_type" (a single space in-between)
+ // 2) the catchall symbol "*" can be used for source_type
+ converters: {
+
+ // Convert anything to text
+ "* text": window.String,
+
+ // Text to html (true = no transformation)
+ "text html": true,
+
+ // Evaluate text as a json expression
+ "text json": jQuery.parseJSON,
+
+ // Parse text as xml
+ "text xml": jQuery.parseXML
+ },
+
+ // For options that shouldn't be deep extended:
+ // you can add your own custom options here if
+ // and when you create one that shouldn't be
+ // deep extended (see ajaxExtend)
+ flatOptions: {
+ context: true,
+ url: true
+ }
+ },
+
+ ajaxPrefilter: addToPrefiltersOrTransports( prefilters ),
+ ajaxTransport: addToPrefiltersOrTransports( transports ),
+
+ // Main method
+ ajax: function( url, options ) {
+
+ // If url is an object, simulate pre-1.5 signature
+ if ( typeof url === "object" ) {
+ options = url;
+ url = undefined;
+ }
+
+ // Force options to be an object
+ options = options || {};
+
+ var // Create the final options object
+ s = jQuery.ajaxSetup( {}, options ),
+ // Callbacks context
+ callbackContext = s.context || s,
+ // Context for global events
+ // It's the callbackContext if one was provided in the options
+ // and if it's a DOM node or a jQuery collection
+ globalEventContext = callbackContext !== s &&
+ ( callbackContext.nodeType || callbackContext instanceof jQuery ) ?
+ jQuery( callbackContext ) : jQuery.event,
+ // Deferreds
+ deferred = jQuery.Deferred(),
+ completeDeferred = jQuery.Callbacks( "once memory" ),
+ // Status-dependent callbacks
+ statusCode = s.statusCode || {},
+ // ifModified key
+ ifModifiedKey,
+ // Headers (they are sent all at once)
+ requestHeaders = {},
+ requestHeadersNames = {},
+ // Response headers
+ responseHeadersString,
+ responseHeaders,
+ // transport
+ transport,
+ // timeout handle
+ timeoutTimer,
+ // Cross-domain detection vars
+ parts,
+ // The jqXHR state
+ state = 0,
+ // To know if global events are to be dispatched
+ fireGlobals,
+ // Loop variable
+ i,
+ // Fake xhr
+ jqXHR = {
+
+ readyState: 0,
+
+ // Caches the header
+ setRequestHeader: function( name, value ) {
+ if ( !state ) {
+ var lname = name.toLowerCase();
+ name = requestHeadersNames[ lname ] = requestHeadersNames[ lname ] || name;
+ requestHeaders[ name ] = value;
+ }
+ return this;
+ },
+
+ // Raw string
+ getAllResponseHeaders: function() {
+ return state === 2 ? responseHeadersString : null;
+ },
+
+ // Builds headers hashtable if needed
+ getResponseHeader: function( key ) {
+ var match;
+ if ( state === 2 ) {
+ if ( !responseHeaders ) {
+ responseHeaders = {};
+ while( ( match = rheaders.exec( responseHeadersString ) ) ) {
+ responseHeaders[ match[1].toLowerCase() ] = match[ 2 ];
+ }
+ }
+ match = responseHeaders[ key.toLowerCase() ];
+ }
+ return match === undefined ? null : match;
+ },
+
+ // Overrides response content-type header
+ overrideMimeType: function( type ) {
+ if ( !state ) {
+ s.mimeType = type;
+ }
+ return this;
+ },
+
+ // Cancel the request
+ abort: function( statusText ) {
+ statusText = statusText || "abort";
+ if ( transport ) {
+ transport.abort( statusText );
+ }
+ done( 0, statusText );
+ return this;
+ }
+ };
+
+ // Callback for when everything is done
+ // It is defined here because jslint complains if it is declared
+ // at the end of the function (which would be more logical and readable)
+ function done( status, nativeStatusText, responses, headers ) {
+
+ // Called once
+ if ( state === 2 ) {
+ return;
+ }
+
+ // State is "done" now
+ state = 2;
+
+ // Clear timeout if it exists
+ if ( timeoutTimer ) {
+ clearTimeout( timeoutTimer );
+ }
+
+ // Dereference transport for early garbage collection
+ // (no matter how long the jqXHR object will be used)
+ transport = undefined;
+
+ // Cache response headers
+ responseHeadersString = headers || "";
+
+ // Set readyState
+ jqXHR.readyState = status > 0 ? 4 : 0;
+
+ var isSuccess,
+ success,
+ error,
+ statusText = nativeStatusText,
+ response = responses ? ajaxHandleResponses( s, jqXHR, responses ) : undefined,
+ lastModified,
+ etag;
+
+ // If successful, handle type chaining
+ if ( status >= 200 && status < 300 || status === 304 ) {
+
+ // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode.
+ if ( s.ifModified ) {
+
+ if ( ( lastModified = jqXHR.getResponseHeader( "Last-Modified" ) ) ) {
+ jQuery.lastModified[ ifModifiedKey ] = lastModified;
+ }
+ if ( ( etag = jqXHR.getResponseHeader( "Etag" ) ) ) {
+ jQuery.etag[ ifModifiedKey ] = etag;
+ }
+ }
+
+ // If not modified
+ if ( status === 304 ) {
+
+ statusText = "notmodified";
+ isSuccess = true;
+
+ // If we have data
+ } else {
+
+ try {
+ success = ajaxConvert( s, response );
+ statusText = "success";
+ isSuccess = true;
+ } catch(e) {
+ // We have a parsererror
+ statusText = "parsererror";
+ error = e;
+ }
+ }
+ } else {
+ // We extract error from statusText
+ // then normalize statusText and status for non-aborts
+ error = statusText;
+ if ( !statusText || status ) {
+ statusText = "error";
+ if ( status < 0 ) {
+ status = 0;
+ }
+ }
+ }
+
+ // Set data for the fake xhr object
+ jqXHR.status = status;
+ jqXHR.statusText = "" + ( nativeStatusText || statusText );
+
+ // Success/Error
+ if ( isSuccess ) {
+ deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] );
+ } else {
+ deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] );
+ }
+
+ // Status-dependent callbacks
+ jqXHR.statusCode( statusCode );
+ statusCode = undefined;
+
+ if ( fireGlobals ) {
+ globalEventContext.trigger( "ajax" + ( isSuccess ? "Success" : "Error" ),
+ [ jqXHR, s, isSuccess ? success : error ] );
+ }
+
+ // Complete
+ completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] );
+
+ if ( fireGlobals ) {
+ globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] );
+ // Handle the global AJAX counter
+ if ( !( --jQuery.active ) ) {
+ jQuery.event.trigger( "ajaxStop" );
+ }
+ }
+ }
+
+ // Attach deferreds
+ deferred.promise( jqXHR );
+ jqXHR.success = jqXHR.done;
+ jqXHR.error = jqXHR.fail;
+ jqXHR.complete = completeDeferred.add;
+
+ // Status-dependent callbacks
+ jqXHR.statusCode = function( map ) {
+ if ( map ) {
+ var tmp;
+ if ( state < 2 ) {
+ for ( tmp in map ) {
+ statusCode[ tmp ] = [ statusCode[tmp], map[tmp] ];
+ }
+ } else {
+ tmp = map[ jqXHR.status ];
+ jqXHR.then( tmp, tmp );
+ }
+ }
+ return this;
+ };
+
+ // Remove hash character (#7531: and string promotion)
+ // Add protocol if not provided (#5866: IE7 issue with protocol-less urls)
+ // We also use the url parameter if available
+ s.url = ( ( url || s.url ) + "" ).replace( rhash, "" ).replace( rprotocol, ajaxLocParts[ 1 ] + "//" );
+
+ // Extract dataTypes list
+ s.dataTypes = jQuery.trim( s.dataType || "*" ).toLowerCase().split( rspacesAjax );
+
+ // Determine if a cross-domain request is in order
+ if ( s.crossDomain == null ) {
+ parts = rurl.exec( s.url.toLowerCase() );
+ s.crossDomain = !!( parts &&
+ ( parts[ 1 ] != ajaxLocParts[ 1 ] || parts[ 2 ] != ajaxLocParts[ 2 ] ||
+ ( parts[ 3 ] || ( parts[ 1 ] === "http:" ? 80 : 443 ) ) !=
+ ( ajaxLocParts[ 3 ] || ( ajaxLocParts[ 1 ] === "http:" ? 80 : 443 ) ) )
+ );
+ }
+
+ // Convert data if not already a string
+ if ( s.data && s.processData && typeof s.data !== "string" ) {
+ s.data = jQuery.param( s.data, s.traditional );
+ }
+
+ // Apply prefilters
+ inspectPrefiltersOrTransports( prefilters, s, options, jqXHR );
+
+ // If request was aborted inside a prefiler, stop there
+ if ( state === 2 ) {
+ return false;
+ }
+
+ // We can fire global events as of now if asked to
+ fireGlobals = s.global;
+
+ // Uppercase the type
+ s.type = s.type.toUpperCase();
+
+ // Determine if request has content
+ s.hasContent = !rnoContent.test( s.type );
+
+ // Watch for a new set of requests
+ if ( fireGlobals && jQuery.active++ === 0 ) {
+ jQuery.event.trigger( "ajaxStart" );
+ }
+
+ // More options handling for requests with no content
+ if ( !s.hasContent ) {
+
+ // If data is available, append data to url
+ if ( s.data ) {
+ s.url += ( rquery.test( s.url ) ? "&" : "?" ) + s.data;
+ // #9682: remove data so that it's not used in an eventual retry
+ delete s.data;
+ }
+
+ // Get ifModifiedKey before adding the anti-cache parameter
+ ifModifiedKey = s.url;
+
+ // Add anti-cache in url if needed
+ if ( s.cache === false ) {
+
+ var ts = jQuery.now(),
+ // try replacing _= if it is there
+ ret = s.url.replace( rts, "$1_=" + ts );
+
+ // if nothing was replaced, add timestamp to the end
+ s.url = ret + ( ( ret === s.url ) ? ( rquery.test( s.url ) ? "&" : "?" ) + "_=" + ts : "" );
+ }
+ }
+
+ // Set the correct header, if data is being sent
+ if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) {
+ jqXHR.setRequestHeader( "Content-Type", s.contentType );
+ }
+
+ // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode.
+ if ( s.ifModified ) {
+ ifModifiedKey = ifModifiedKey || s.url;
+ if ( jQuery.lastModified[ ifModifiedKey ] ) {
+ jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ ifModifiedKey ] );
+ }
+ if ( jQuery.etag[ ifModifiedKey ] ) {
+ jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ ifModifiedKey ] );
+ }
+ }
+
+ // Set the Accepts header for the server, depending on the dataType
+ jqXHR.setRequestHeader(
+ "Accept",
+ s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[0] ] ?
+ s.accepts[ s.dataTypes[0] ] + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) :
+ s.accepts[ "*" ]
+ );
+
+ // Check for headers option
+ for ( i in s.headers ) {
+ jqXHR.setRequestHeader( i, s.headers[ i ] );
+ }
+
+ // Allow custom headers/mimetypes and early abort
+ if ( s.beforeSend && ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || state === 2 ) ) {
+ // Abort if not done already
+ jqXHR.abort();
+ return false;
+
+ }
+
+ // Install callbacks on deferreds
+ for ( i in { success: 1, error: 1, complete: 1 } ) {
+ jqXHR[ i ]( s[ i ] );
+ }
+
+ // Get transport
+ transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR );
+
+ // If no transport, we auto-abort
+ if ( !transport ) {
+ done( -1, "No Transport" );
+ } else {
+ jqXHR.readyState = 1;
+ // Send global event
+ if ( fireGlobals ) {
+ globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] );
+ }
+ // Timeout
+ if ( s.async && s.timeout > 0 ) {
+ timeoutTimer = setTimeout( function(){
+ jqXHR.abort( "timeout" );
+ }, s.timeout );
+ }
+
+ try {
+ state = 1;
+ transport.send( requestHeaders, done );
+ } catch (e) {
+ // Propagate exception as error if not done
+ if ( state < 2 ) {
+ done( -1, e );
+ // Simply rethrow otherwise
+ } else {
+ throw e;
+ }
+ }
+ }
+
+ return jqXHR;
+ },
+
+ // Serialize an array of form elements or a set of
+ // key/values into a query string
+ param: function( a, traditional ) {
+ var s = [],
+ add = function( key, value ) {
+ // If value is a function, invoke it and return its value
+ value = jQuery.isFunction( value ) ? value() : value;
+ s[ s.length ] = encodeURIComponent( key ) + "=" + encodeURIComponent( value );
+ };
+
+ // Set traditional to true for jQuery <= 1.3.2 behavior.
+ if ( traditional === undefined ) {
+ traditional = jQuery.ajaxSettings.traditional;
+ }
+
+ // If an array was passed in, assume that it is an array of form elements.
+ if ( jQuery.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) {
+ // Serialize the form elements
+ jQuery.each( a, function() {
+ add( this.name, this.value );
+ });
+
+ } else {
+ // If traditional, encode the "old" way (the way 1.3.2 or older
+ // did it), otherwise encode params recursively.
+ for ( var prefix in a ) {
+ buildParams( prefix, a[ prefix ], traditional, add );
+ }
+ }
+
+ // Return the resulting serialization
+ return s.join( "&" ).replace( r20, "+" );
+ }
+});
+
+function buildParams( prefix, obj, traditional, add ) {
+ if ( jQuery.isArray( obj ) ) {
+ // Serialize array item.
+ jQuery.each( obj, function( i, v ) {
+ if ( traditional || rbracket.test( prefix ) ) {
+ // Treat each array item as a scalar.
+ add( prefix, v );
+
+ } else {
+ // If array item is non-scalar (array or object), encode its
+ // numeric index to resolve deserialization ambiguity issues.
+ // Note that rack (as of 1.0.0) can't currently deserialize
+ // nested arrays properly, and attempting to do so may cause
+ // a server error. Possible fixes are to modify rack's
+ // deserialization algorithm or to provide an option or flag
+ // to force array serialization to be shallow.
+ buildParams( prefix + "[" + ( typeof v === "object" || jQuery.isArray(v) ? i : "" ) + "]", v, traditional, add );
+ }
+ });
+
+ } else if ( !traditional && obj != null && typeof obj === "object" ) {
+ // Serialize object item.
+ for ( var name in obj ) {
+ buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add );
+ }
+
+ } else {
+ // Serialize scalar item.
+ add( prefix, obj );
+ }
+}
+
+// This is still on the jQuery object... for now
+// Want to move this to jQuery.ajax some day
+jQuery.extend({
+
+ // Counter for holding the number of active queries
+ active: 0,
+
+ // Last-Modified header cache for next request
+ lastModified: {},
+ etag: {}
+
+});
+
+/* Handles responses to an ajax request:
+ * - sets all responseXXX fields accordingly
+ * - finds the right dataType (mediates between content-type and expected dataType)
+ * - returns the corresponding response
+ */
+function ajaxHandleResponses( s, jqXHR, responses ) {
+
+ var contents = s.contents,
+ dataTypes = s.dataTypes,
+ responseFields = s.responseFields,
+ ct,
+ type,
+ finalDataType,
+ firstDataType;
+
+ // Fill responseXXX fields
+ for ( type in responseFields ) {
+ if ( type in responses ) {
+ jqXHR[ responseFields[type] ] = responses[ type ];
+ }
+ }
+
+ // Remove auto dataType and get content-type in the process
+ while( dataTypes[ 0 ] === "*" ) {
+ dataTypes.shift();
+ if ( ct === undefined ) {
+ ct = s.mimeType || jqXHR.getResponseHeader( "content-type" );
+ }
+ }
+
+ // Check if we're dealing with a known content-type
+ if ( ct ) {
+ for ( type in contents ) {
+ if ( contents[ type ] && contents[ type ].test( ct ) ) {
+ dataTypes.unshift( type );
+ break;
+ }
+ }
+ }
+
+ // Check to see if we have a response for the expected dataType
+ if ( dataTypes[ 0 ] in responses ) {
+ finalDataType = dataTypes[ 0 ];
+ } else {
+ // Try convertible dataTypes
+ for ( type in responses ) {
+ if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[0] ] ) {
+ finalDataType = type;
+ break;
+ }
+ if ( !firstDataType ) {
+ firstDataType = type;
+ }
+ }
+ // Or just use first one
+ finalDataType = finalDataType || firstDataType;
+ }
+
+ // If we found a dataType
+ // We add the dataType to the list if needed
+ // and return the corresponding response
+ if ( finalDataType ) {
+ if ( finalDataType !== dataTypes[ 0 ] ) {
+ dataTypes.unshift( finalDataType );
+ }
+ return responses[ finalDataType ];
+ }
+}
+
+// Chain conversions given the request and the original response
+function ajaxConvert( s, response ) {
+
+ // Apply the dataFilter if provided
+ if ( s.dataFilter ) {
+ response = s.dataFilter( response, s.dataType );
+ }
+
+ var dataTypes = s.dataTypes,
+ converters = {},
+ i,
+ key,
+ length = dataTypes.length,
+ tmp,
+ // Current and previous dataTypes
+ current = dataTypes[ 0 ],
+ prev,
+ // Conversion expression
+ conversion,
+ // Conversion function
+ conv,
+ // Conversion functions (transitive conversion)
+ conv1,
+ conv2;
+
+ // For each dataType in the chain
+ for ( i = 1; i < length; i++ ) {
+
+ // Create converters map
+ // with lowercased keys
+ if ( i === 1 ) {
+ for ( key in s.converters ) {
+ if ( typeof key === "string" ) {
+ converters[ key.toLowerCase() ] = s.converters[ key ];
+ }
+ }
+ }
+
+ // Get the dataTypes
+ prev = current;
+ current = dataTypes[ i ];
+
+ // If current is auto dataType, update it to prev
+ if ( current === "*" ) {
+ current = prev;
+ // If no auto and dataTypes are actually different
+ } else if ( prev !== "*" && prev !== current ) {
+
+ // Get the converter
+ conversion = prev + " " + current;
+ conv = converters[ conversion ] || converters[ "* " + current ];
+
+ // If there is no direct converter, search transitively
+ if ( !conv ) {
+ conv2 = undefined;
+ for ( conv1 in converters ) {
+ tmp = conv1.split( " " );
+ if ( tmp[ 0 ] === prev || tmp[ 0 ] === "*" ) {
+ conv2 = converters[ tmp[1] + " " + current ];
+ if ( conv2 ) {
+ conv1 = converters[ conv1 ];
+ if ( conv1 === true ) {
+ conv = conv2;
+ } else if ( conv2 === true ) {
+ conv = conv1;
+ }
+ break;
+ }
+ }
+ }
+ }
+ // If we found no converter, dispatch an error
+ if ( !( conv || conv2 ) ) {
+ jQuery.error( "No conversion from " + conversion.replace(" "," to ") );
+ }
+ // If found converter is not an equivalence
+ if ( conv !== true ) {
+ // Convert with 1 or 2 converters accordingly
+ response = conv ? conv( response ) : conv2( conv1(response) );
+ }
+ }
+ }
+ return response;
+}
+
+
+
+
+var jsc = jQuery.now(),
+ jsre = /(\=)\?(&|$)|\?\?/i;
+
+// Default jsonp settings
+jQuery.ajaxSetup({
+ jsonp: "callback",
+ jsonpCallback: function() {
+ return jQuery.expando + "_" + ( jsc++ );
+ }
+});
+
+// Detect, normalize options and install callbacks for jsonp requests
+jQuery.ajaxPrefilter( "json jsonp", function( s, originalSettings, jqXHR ) {
+
+ var inspectData = s.contentType === "application/x-www-form-urlencoded" &&
+ ( typeof s.data === "string" );
+
+ if ( s.dataTypes[ 0 ] === "jsonp" ||
+ s.jsonp !== false && ( jsre.test( s.url ) ||
+ inspectData && jsre.test( s.data ) ) ) {
+
+ var responseContainer,
+ jsonpCallback = s.jsonpCallback =
+ jQuery.isFunction( s.jsonpCallback ) ? s.jsonpCallback() : s.jsonpCallback,
+ previous = window[ jsonpCallback ],
+ url = s.url,
+ data = s.data,
+ replace = "$1" + jsonpCallback + "$2";
+
+ if ( s.jsonp !== false ) {
+ url = url.replace( jsre, replace );
+ if ( s.url === url ) {
+ if ( inspectData ) {
+ data = data.replace( jsre, replace );
+ }
+ if ( s.data === data ) {
+ // Add callback manually
+ url += (/\?/.test( url ) ? "&" : "?") + s.jsonp + "=" + jsonpCallback;
+ }
+ }
+ }
+
+ s.url = url;
+ s.data = data;
+
+ // Install callback
+ window[ jsonpCallback ] = function( response ) {
+ responseContainer = [ response ];
+ };
+
+ // Clean-up function
+ jqXHR.always(function() {
+ // Set callback back to previous value
+ window[ jsonpCallback ] = previous;
+ // Call if it was a function and we have a response
+ if ( responseContainer && jQuery.isFunction( previous ) ) {
+ window[ jsonpCallback ]( responseContainer[ 0 ] );
+ }
+ });
+
+ // Use data converter to retrieve json after script execution
+ s.converters["script json"] = function() {
+ if ( !responseContainer ) {
+ jQuery.error( jsonpCallback + " was not called" );
+ }
+ return responseContainer[ 0 ];
+ };
+
+ // force json dataType
+ s.dataTypes[ 0 ] = "json";
+
+ // Delegate to script
+ return "script";
+ }
+});
+
+
+
+
+// Install script dataType
+jQuery.ajaxSetup({
+ accepts: {
+ script: "text/javascript, application/javascript, application/ecmascript, application/x-ecmascript"
+ },
+ contents: {
+ script: /javascript|ecmascript/
+ },
+ converters: {
+ "text script": function( text ) {
+ jQuery.globalEval( text );
+ return text;
+ }
+ }
+});
+
+// Handle cache's special case and global
+jQuery.ajaxPrefilter( "script", function( s ) {
+ if ( s.cache === undefined ) {
+ s.cache = false;
+ }
+ if ( s.crossDomain ) {
+ s.type = "GET";
+ s.global = false;
+ }
+});
+
+// Bind script tag hack transport
+jQuery.ajaxTransport( "script", function(s) {
+
+ // This transport only deals with cross domain requests
+ if ( s.crossDomain ) {
+
+ var script,
+ head = document.head || document.getElementsByTagName( "head" )[0] || document.documentElement;
+
+ return {
+
+ send: function( _, callback ) {
+
+ script = document.createElement( "script" );
+
+ script.async = "async";
+
+ if ( s.scriptCharset ) {
+ script.charset = s.scriptCharset;
+ }
+
+ script.src = s.url;
+
+ // Attach handlers for all browsers
+ script.onload = script.onreadystatechange = function( _, isAbort ) {
+
+ if ( isAbort || !script.readyState || /loaded|complete/.test( script.readyState ) ) {
+
+ // Handle memory leak in IE
+ script.onload = script.onreadystatechange = null;
+
+ // Remove the script
+ if ( head && script.parentNode ) {
+ head.removeChild( script );
+ }
+
+ // Dereference the script
+ script = undefined;
+
+ // Callback if not abort
+ if ( !isAbort ) {
+ callback( 200, "success" );
+ }
+ }
+ };
+ // Use insertBefore instead of appendChild to circumvent an IE6 bug.
+ // This arises when a base node is used (#2709 and #4378).
+ head.insertBefore( script, head.firstChild );
+ },
+
+ abort: function() {
+ if ( script ) {
+ script.onload( 0, 1 );
+ }
+ }
+ };
+ }
+});
+
+
+
+
+var // #5280: Internet Explorer will keep connections alive if we don't abort on unload
+ xhrOnUnloadAbort = window.ActiveXObject ? function() {
+ // Abort all pending requests
+ for ( var key in xhrCallbacks ) {
+ xhrCallbacks[ key ]( 0, 1 );
+ }
+ } : false,
+ xhrId = 0,
+ xhrCallbacks;
+
+// Functions to create xhrs
+function createStandardXHR() {
+ try {
+ return new window.XMLHttpRequest();
+ } catch( e ) {}
+}
+
+function createActiveXHR() {
+ try {
+ return new window.ActiveXObject( "Microsoft.XMLHTTP" );
+ } catch( e ) {}
+}
+
+// Create the request object
+// (This is still attached to ajaxSettings for backward compatibility)
+jQuery.ajaxSettings.xhr = window.ActiveXObject ?
+ /* Microsoft failed to properly
+ * implement the XMLHttpRequest in IE7 (can't request local files),
+ * so we use the ActiveXObject when it is available
+ * Additionally XMLHttpRequest can be disabled in IE7/IE8 so
+ * we need a fallback.
+ */
+ function() {
+ return !this.isLocal && createStandardXHR() || createActiveXHR();
+ } :
+ // For all other browsers, use the standard XMLHttpRequest object
+ createStandardXHR;
+
+// Determine support properties
+(function( xhr ) {
+ jQuery.extend( jQuery.support, {
+ ajax: !!xhr,
+ cors: !!xhr && ( "withCredentials" in xhr )
+ });
+})( jQuery.ajaxSettings.xhr() );
+
+// Create transport if the browser can provide an xhr
+if ( jQuery.support.ajax ) {
+
+ jQuery.ajaxTransport(function( s ) {
+ // Cross domain only allowed if supported through XMLHttpRequest
+ if ( !s.crossDomain || jQuery.support.cors ) {
+
+ var callback;
+
+ return {
+ send: function( headers, complete ) {
+
+ // Get a new xhr
+ var xhr = s.xhr(),
+ handle,
+ i;
+
+ // Open the socket
+ // Passing null username, generates a login popup on Opera (#2865)
+ if ( s.username ) {
+ xhr.open( s.type, s.url, s.async, s.username, s.password );
+ } else {
+ xhr.open( s.type, s.url, s.async );
+ }
+
+ // Apply custom fields if provided
+ if ( s.xhrFields ) {
+ for ( i in s.xhrFields ) {
+ xhr[ i ] = s.xhrFields[ i ];
+ }
+ }
+
+ // Override mime type if needed
+ if ( s.mimeType && xhr.overrideMimeType ) {
+ xhr.overrideMimeType( s.mimeType );
+ }
+
+ // X-Requested-With header
+ // For cross-domain requests, seeing as conditions for a preflight are
+ // akin to a jigsaw puzzle, we simply never set it to be sure.
+ // (it can always be set on a per-request basis or even using ajaxSetup)
+ // For same-domain requests, won't change header if already provided.
+ if ( !s.crossDomain && !headers["X-Requested-With"] ) {
+ headers[ "X-Requested-With" ] = "XMLHttpRequest";
+ }
+
+ // Need an extra try/catch for cross domain requests in Firefox 3
+ try {
+ for ( i in headers ) {
+ xhr.setRequestHeader( i, headers[ i ] );
+ }
+ } catch( _ ) {}
+
+ // Do send the request
+ // This may raise an exception which is actually
+ // handled in jQuery.ajax (so no try/catch here)
+ xhr.send( ( s.hasContent && s.data ) || null );
+
+ // Listener
+ callback = function( _, isAbort ) {
+
+ var status,
+ statusText,
+ responseHeaders,
+ responses,
+ xml;
+
+ // Firefox throws exceptions when accessing properties
+ // of an xhr when a network error occured
+ // http://helpful.knobs-dials.com/index.php/Component_returned_failure_code:_0x80040111_(NS_ERROR_NOT_AVAILABLE)
+ try {
+
+ // Was never called and is aborted or complete
+ if ( callback && ( isAbort || xhr.readyState === 4 ) ) {
+
+ // Only called once
+ callback = undefined;
+
+ // Do not keep as active anymore
+ if ( handle ) {
+ xhr.onreadystatechange = jQuery.noop;
+ if ( xhrOnUnloadAbort ) {
+ delete xhrCallbacks[ handle ];
+ }
+ }
+
+ // If it's an abort
+ if ( isAbort ) {
+ // Abort it manually if needed
+ if ( xhr.readyState !== 4 ) {
+ xhr.abort();
+ }
+ } else {
+ status = xhr.status;
+ responseHeaders = xhr.getAllResponseHeaders();
+ responses = {};
+ xml = xhr.responseXML;
+
+ // Construct response list
+ if ( xml && xml.documentElement /* #4958 */ ) {
+ responses.xml = xml;
+ }
+ responses.text = xhr.responseText;
+
+ // Firefox throws an exception when accessing
+ // statusText for faulty cross-domain requests
+ try {
+ statusText = xhr.statusText;
+ } catch( e ) {
+ // We normalize with Webkit giving an empty statusText
+ statusText = "";
+ }
+
+ // Filter status for non standard behaviors
+
+ // If the request is local and we have data: assume a success
+ // (success with no data won't get notified, that's the best we
+ // can do given current implementations)
+ if ( !status && s.isLocal && !s.crossDomain ) {
+ status = responses.text ? 200 : 404;
+ // IE - #1450: sometimes returns 1223 when it should be 204
+ } else if ( status === 1223 ) {
+ status = 204;
+ }
+ }
+ }
+ } catch( firefoxAccessException ) {
+ if ( !isAbort ) {
+ complete( -1, firefoxAccessException );
+ }
+ }
+
+ // Call complete if needed
+ if ( responses ) {
+ complete( status, statusText, responses, responseHeaders );
+ }
+ };
+
+ // if we're in sync mode or it's in cache
+ // and has been retrieved directly (IE6 & IE7)
+ // we need to manually fire the callback
+ if ( !s.async || xhr.readyState === 4 ) {
+ callback();
+ } else {
+ handle = ++xhrId;
+ if ( xhrOnUnloadAbort ) {
+ // Create the active xhrs callbacks list if needed
+ // and attach the unload handler
+ if ( !xhrCallbacks ) {
+ xhrCallbacks = {};
+ jQuery( window ).unload( xhrOnUnloadAbort );
+ }
+ // Add to list of active xhrs callbacks
+ xhrCallbacks[ handle ] = callback;
+ }
+ xhr.onreadystatechange = callback;
+ }
+ },
+
+ abort: function() {
+ if ( callback ) {
+ callback(0,1);
+ }
+ }
+ };
+ }
+ });
+}
+
+
+
+
+var elemdisplay = {},
+ iframe, iframeDoc,
+ rfxtypes = /^(?:toggle|show|hide)$/,
+ rfxnum = /^([+\-]=)?([\d+.\-]+)([a-z%]*)$/i,
+ timerId,
+ fxAttrs = [
+ // height animations
+ [ "height", "marginTop", "marginBottom", "paddingTop", "paddingBottom" ],
+ // width animations
+ [ "width", "marginLeft", "marginRight", "paddingLeft", "paddingRight" ],
+ // opacity animations
+ [ "opacity" ]
+ ],
+ fxNow;
+
+jQuery.fn.extend({
+ show: function( speed, easing, callback ) {
+ var elem, display;
+
+ if ( speed || speed === 0 ) {
+ return this.animate( genFx("show", 3), speed, easing, callback );
+
+ } else {
+ for ( var i = 0, j = this.length; i < j; i++ ) {
+ elem = this[ i ];
+
+ if ( elem.style ) {
+ display = elem.style.display;
+
+ // Reset the inline display of this element to learn if it is
+ // being hidden by cascaded rules or not
+ if ( !jQuery._data(elem, "olddisplay") && display === "none" ) {
+ display = elem.style.display = "";
+ }
+
+ // Set elements which have been overridden with display: none
+ // in a stylesheet to whatever the default browser style is
+ // for such an element
+ if ( display === "" && jQuery.css(elem, "display") === "none" ) {
+ jQuery._data( elem, "olddisplay", defaultDisplay(elem.nodeName) );
+ }
+ }
+ }
+
+ // Set the display of most of the elements in a second loop
+ // to avoid the constant reflow
+ for ( i = 0; i < j; i++ ) {
+ elem = this[ i ];
+
+ if ( elem.style ) {
+ display = elem.style.display;
+
+ if ( display === "" || display === "none" ) {
+ elem.style.display = jQuery._data( elem, "olddisplay" ) || "";
+ }
+ }
+ }
+
+ return this;
+ }
+ },
+
+ hide: function( speed, easing, callback ) {
+ if ( speed || speed === 0 ) {
+ return this.animate( genFx("hide", 3), speed, easing, callback);
+
+ } else {
+ var elem, display,
+ i = 0,
+ j = this.length;
+
+ for ( ; i < j; i++ ) {
+ elem = this[i];
+ if ( elem.style ) {
+ display = jQuery.css( elem, "display" );
+
+ if ( display !== "none" && !jQuery._data( elem, "olddisplay" ) ) {
+ jQuery._data( elem, "olddisplay", display );
+ }
+ }
+ }
+
+ // Set the display of the elements in a second loop
+ // to avoid the constant reflow
+ for ( i = 0; i < j; i++ ) {
+ if ( this[i].style ) {
+ this[i].style.display = "none";
+ }
+ }
+
+ return this;
+ }
+ },
+
+ // Save the old toggle function
+ _toggle: jQuery.fn.toggle,
+
+ toggle: function( fn, fn2, callback ) {
+ var bool = typeof fn === "boolean";
+
+ if ( jQuery.isFunction(fn) && jQuery.isFunction(fn2) ) {
+ this._toggle.apply( this, arguments );
+
+ } else if ( fn == null || bool ) {
+ this.each(function() {
+ var state = bool ? fn : jQuery(this).is(":hidden");
+ jQuery(this)[ state ? "show" : "hide" ]();
+ });
+
+ } else {
+ this.animate(genFx("toggle", 3), fn, fn2, callback);
+ }
+
+ return this;
+ },
+
+ fadeTo: function( speed, to, easing, callback ) {
+ return this.filter(":hidden").css("opacity", 0).show().end()
+ .animate({opacity: to}, speed, easing, callback);
+ },
+
+ animate: function( prop, speed, easing, callback ) {
+ var optall = jQuery.speed( speed, easing, callback );
+
+ if ( jQuery.isEmptyObject( prop ) ) {
+ return this.each( optall.complete, [ false ] );
+ }
+
+ // Do not change referenced properties as per-property easing will be lost
+ prop = jQuery.extend( {}, prop );
+
+ function doAnimation() {
+ // XXX 'this' does not always have a nodeName when running the
+ // test suite
+
+ if ( optall.queue === false ) {
+ jQuery._mark( this );
+ }
+
+ var opt = jQuery.extend( {}, optall ),
+ isElement = this.nodeType === 1,
+ hidden = isElement && jQuery(this).is(":hidden"),
+ name, val, p, e,
+ parts, start, end, unit,
+ method;
+
+ // will store per property easing and be used to determine when an animation is complete
+ opt.animatedProperties = {};
+
+ for ( p in prop ) {
+
+ // property name normalization
+ name = jQuery.camelCase( p );
+ if ( p !== name ) {
+ prop[ name ] = prop[ p ];
+ delete prop[ p ];
+ }
+
+ val = prop[ name ];
+
+ // easing resolution: per property > opt.specialEasing > opt.easing > 'swing' (default)
+ if ( jQuery.isArray( val ) ) {
+ opt.animatedProperties[ name ] = val[ 1 ];
+ val = prop[ name ] = val[ 0 ];
+ } else {
+ opt.animatedProperties[ name ] = opt.specialEasing && opt.specialEasing[ name ] || opt.easing || 'swing';
+ }
+
+ if ( val === "hide" && hidden || val === "show" && !hidden ) {
+ return opt.complete.call( this );
+ }
+
+ if ( isElement && ( name === "height" || name === "width" ) ) {
+ // Make sure that nothing sneaks out
+ // Record all 3 overflow attributes because IE does not
+ // change the overflow attribute when overflowX and
+ // overflowY are set to the same value
+ opt.overflow = [ this.style.overflow, this.style.overflowX, this.style.overflowY ];
+
+ // Set display property to inline-block for height/width
+ // animations on inline elements that are having width/height animated
+ if ( jQuery.css( this, "display" ) === "inline" &&
+ jQuery.css( this, "float" ) === "none" ) {
+
+ // inline-level elements accept inline-block;
+ // block-level elements need to be inline with layout
+ if ( !jQuery.support.inlineBlockNeedsLayout || defaultDisplay( this.nodeName ) === "inline" ) {
+ this.style.display = "inline-block";
+
+ } else {
+ this.style.zoom = 1;
+ }
+ }
+ }
+ }
+
+ if ( opt.overflow != null ) {
+ this.style.overflow = "hidden";
+ }
+
+ for ( p in prop ) {
+ e = new jQuery.fx( this, opt, p );
+ val = prop[ p ];
+
+ if ( rfxtypes.test( val ) ) {
+
+ // Tracks whether to show or hide based on private
+ // data attached to the element
+ method = jQuery._data( this, "toggle" + p ) || ( val === "toggle" ? hidden ? "show" : "hide" : 0 );
+ if ( method ) {
+ jQuery._data( this, "toggle" + p, method === "show" ? "hide" : "show" );
+ e[ method ]();
+ } else {
+ e[ val ]();
+ }
+
+ } else {
+ parts = rfxnum.exec( val );
+ start = e.cur();
+
+ if ( parts ) {
+ end = parseFloat( parts[2] );
+ unit = parts[3] || ( jQuery.cssNumber[ p ] ? "" : "px" );
+
+ // We need to compute starting value
+ if ( unit !== "px" ) {
+ jQuery.style( this, p, (end || 1) + unit);
+ start = ( (end || 1) / e.cur() ) * start;
+ jQuery.style( this, p, start + unit);
+ }
+
+ // If a +=/-= token was provided, we're doing a relative animation
+ if ( parts[1] ) {
+ end = ( (parts[ 1 ] === "-=" ? -1 : 1) * end ) + start;
+ }
+
+ e.custom( start, end, unit );
+
+ } else {
+ e.custom( start, val, "" );
+ }
+ }
+ }
+
+ // For JS strict compliance
+ return true;
+ }
+
+ return optall.queue === false ?
+ this.each( doAnimation ) :
+ this.queue( optall.queue, doAnimation );
+ },
+
+ stop: function( type, clearQueue, gotoEnd ) {
+ if ( typeof type !== "string" ) {
+ gotoEnd = clearQueue;
+ clearQueue = type;
+ type = undefined;
+ }
+ if ( clearQueue && type !== false ) {
+ this.queue( type || "fx", [] );
+ }
+
+ return this.each(function() {
+ var index,
+ hadTimers = false,
+ timers = jQuery.timers,
+ data = jQuery._data( this );
+
+ // clear marker counters if we know they won't be
+ if ( !gotoEnd ) {
+ jQuery._unmark( true, this );
+ }
+
+ function stopQueue( elem, data, index ) {
+ var hooks = data[ index ];
+ jQuery.removeData( elem, index, true );
+ hooks.stop( gotoEnd );
+ }
+
+ if ( type == null ) {
+ for ( index in data ) {
+ if ( data[ index ] && data[ index ].stop && index.indexOf(".run") === index.length - 4 ) {
+ stopQueue( this, data, index );
+ }
+ }
+ } else if ( data[ index = type + ".run" ] && data[ index ].stop ){
+ stopQueue( this, data, index );
+ }
+
+ for ( index = timers.length; index--; ) {
+ if ( timers[ index ].elem === this && (type == null || timers[ index ].queue === type) ) {
+ if ( gotoEnd ) {
+
+ // force the next step to be the last
+ timers[ index ]( true );
+ } else {
+ timers[ index ].saveState();
+ }
+ hadTimers = true;
+ timers.splice( index, 1 );
+ }
+ }
+
+ // start the next in the queue if the last step wasn't forced
+ // timers currently will call their complete callbacks, which will dequeue
+ // but only if they were gotoEnd
+ if ( !( gotoEnd && hadTimers ) ) {
+ jQuery.dequeue( this, type );
+ }
+ });
+ }
+
+});
+
+// Animations created synchronously will run synchronously
+function createFxNow() {
+ setTimeout( clearFxNow, 0 );
+ return ( fxNow = jQuery.now() );
+}
+
+function clearFxNow() {
+ fxNow = undefined;
+}
+
+// Generate parameters to create a standard animation
+function genFx( type, num ) {
+ var obj = {};
+
+ jQuery.each( fxAttrs.concat.apply([], fxAttrs.slice( 0, num )), function() {
+ obj[ this ] = type;
+ });
+
+ return obj;
+}
+
+// Generate shortcuts for custom animations
+jQuery.each({
+ slideDown: genFx( "show", 1 ),
+ slideUp: genFx( "hide", 1 ),
+ slideToggle: genFx( "toggle", 1 ),
+ fadeIn: { opacity: "show" },
+ fadeOut: { opacity: "hide" },
+ fadeToggle: { opacity: "toggle" }
+}, function( name, props ) {
+ jQuery.fn[ name ] = function( speed, easing, callback ) {
+ return this.animate( props, speed, easing, callback );
+ };
+});
+
+jQuery.extend({
+ speed: function( speed, easing, fn ) {
+ var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : {
+ complete: fn || !fn && easing ||
+ jQuery.isFunction( speed ) && speed,
+ duration: speed,
+ easing: fn && easing || easing && !jQuery.isFunction( easing ) && easing
+ };
+
+ opt.duration = jQuery.fx.off ? 0 : typeof opt.duration === "number" ? opt.duration :
+ opt.duration in jQuery.fx.speeds ? jQuery.fx.speeds[ opt.duration ] : jQuery.fx.speeds._default;
+
+ // normalize opt.queue - true/undefined/null -> "fx"
+ if ( opt.queue == null || opt.queue === true ) {
+ opt.queue = "fx";
+ }
+
+ // Queueing
+ opt.old = opt.complete;
+
+ opt.complete = function( noUnmark ) {
+ if ( jQuery.isFunction( opt.old ) ) {
+ opt.old.call( this );
+ }
+
+ if ( opt.queue ) {
+ jQuery.dequeue( this, opt.queue );
+ } else if ( noUnmark !== false ) {
+ jQuery._unmark( this );
+ }
+ };
+
+ return opt;
+ },
+
+ easing: {
+ linear: function( p, n, firstNum, diff ) {
+ return firstNum + diff * p;
+ },
+ swing: function( p, n, firstNum, diff ) {
+ return ( ( -Math.cos( p*Math.PI ) / 2 ) + 0.5 ) * diff + firstNum;
+ }
+ },
+
+ timers: [],
+
+ fx: function( elem, options, prop ) {
+ this.options = options;
+ this.elem = elem;
+ this.prop = prop;
+
+ options.orig = options.orig || {};
+ }
+
+});
+
+jQuery.fx.prototype = {
+ // Simple function for setting a style value
+ update: function() {
+ if ( this.options.step ) {
+ this.options.step.call( this.elem, this.now, this );
+ }
+
+ ( jQuery.fx.step[ this.prop ] || jQuery.fx.step._default )( this );
+ },
+
+ // Get the current size
+ cur: function() {
+ if ( this.elem[ this.prop ] != null && (!this.elem.style || this.elem.style[ this.prop ] == null) ) {
+ return this.elem[ this.prop ];
+ }
+
+ var parsed,
+ r = jQuery.css( this.elem, this.prop );
+ // Empty strings, null, undefined and "auto" are converted to 0,
+ // complex values such as "rotate(1rad)" are returned as is,
+ // simple values such as "10px" are parsed to Float.
+ return isNaN( parsed = parseFloat( r ) ) ? !r || r === "auto" ? 0 : r : parsed;
+ },
+
+ // Start an animation from one number to another
+ custom: function( from, to, unit ) {
+ var self = this,
+ fx = jQuery.fx;
+
+ this.startTime = fxNow || createFxNow();
+ this.end = to;
+ this.now = this.start = from;
+ this.pos = this.state = 0;
+ this.unit = unit || this.unit || ( jQuery.cssNumber[ this.prop ] ? "" : "px" );
+
+ function t( gotoEnd ) {
+ return self.step( gotoEnd );
+ }
+
+ t.queue = this.options.queue;
+ t.elem = this.elem;
+ t.saveState = function() {
+ if ( self.options.hide && jQuery._data( self.elem, "fxshow" + self.prop ) === undefined ) {
+ jQuery._data( self.elem, "fxshow" + self.prop, self.start );
+ }
+ };
+
+ if ( t() && jQuery.timers.push(t) && !timerId ) {
+ timerId = setInterval( fx.tick, fx.interval );
+ }
+ },
+
+ // Simple 'show' function
+ show: function() {
+ var dataShow = jQuery._data( this.elem, "fxshow" + this.prop );
+
+ // Remember where we started, so that we can go back to it later
+ this.options.orig[ this.prop ] = dataShow || jQuery.style( this.elem, this.prop );
+ this.options.show = true;
+
+ // Begin the animation
+ // Make sure that we start at a small width/height to avoid any flash of content
+ if ( dataShow !== undefined ) {
+ // This show is picking up where a previous hide or show left off
+ this.custom( this.cur(), dataShow );
+ } else {
+ this.custom( this.prop === "width" || this.prop === "height" ? 1 : 0, this.cur() );
+ }
+
+ // Start by showing the element
+ jQuery( this.elem ).show();
+ },
+
+ // Simple 'hide' function
+ hide: function() {
+ // Remember where we started, so that we can go back to it later
+ this.options.orig[ this.prop ] = jQuery._data( this.elem, "fxshow" + this.prop ) || jQuery.style( this.elem, this.prop );
+ this.options.hide = true;
+
+ // Begin the animation
+ this.custom( this.cur(), 0 );
+ },
+
+ // Each step of an animation
+ step: function( gotoEnd ) {
+ var p, n, complete,
+ t = fxNow || createFxNow(),
+ done = true,
+ elem = this.elem,
+ options = this.options;
+
+ if ( gotoEnd || t >= options.duration + this.startTime ) {
+ this.now = this.end;
+ this.pos = this.state = 1;
+ this.update();
+
+ options.animatedProperties[ this.prop ] = true;
+
+ for ( p in options.animatedProperties ) {
+ if ( options.animatedProperties[ p ] !== true ) {
+ done = false;
+ }
+ }
+
+ if ( done ) {
+ // Reset the overflow
+ if ( options.overflow != null && !jQuery.support.shrinkWrapBlocks ) {
+
+ jQuery.each( [ "", "X", "Y" ], function( index, value ) {
+ elem.style[ "overflow" + value ] = options.overflow[ index ];
+ });
+ }
+
+ // Hide the element if the "hide" operation was done
+ if ( options.hide ) {
+ jQuery( elem ).hide();
+ }
+
+ // Reset the properties, if the item has been hidden or shown
+ if ( options.hide || options.show ) {
+ for ( p in options.animatedProperties ) {
+ jQuery.style( elem, p, options.orig[ p ] );
+ jQuery.removeData( elem, "fxshow" + p, true );
+ // Toggle data is no longer needed
+ jQuery.removeData( elem, "toggle" + p, true );
+ }
+ }
+
+ // Execute the complete function
+ // in the event that the complete function throws an exception
+ // we must ensure it won't be called twice. #5684
+
+ complete = options.complete;
+ if ( complete ) {
+
+ options.complete = false;
+ complete.call( elem );
+ }
+ }
+
+ return false;
+
+ } else {
+ // classical easing cannot be used with an Infinity duration
+ if ( options.duration == Infinity ) {
+ this.now = t;
+ } else {
+ n = t - this.startTime;
+ this.state = n / options.duration;
+
+ // Perform the easing function, defaults to swing
+ this.pos = jQuery.easing[ options.animatedProperties[this.prop] ]( this.state, n, 0, 1, options.duration );
+ this.now = this.start + ( (this.end - this.start) * this.pos );
+ }
+ // Perform the next step of the animation
+ this.update();
+ }
+
+ return true;
+ }
+};
+
+jQuery.extend( jQuery.fx, {
+ tick: function() {
+ var timer,
+ timers = jQuery.timers,
+ i = 0;
+
+ for ( ; i < timers.length; i++ ) {
+ timer = timers[ i ];
+ // Checks the timer has not already been removed
+ if ( !timer() && timers[ i ] === timer ) {
+ timers.splice( i--, 1 );
+ }
+ }
+
+ if ( !timers.length ) {
+ jQuery.fx.stop();
+ }
+ },
+
+ interval: 13,
+
+ stop: function() {
+ clearInterval( timerId );
+ timerId = null;
+ },
+
+ speeds: {
+ slow: 600,
+ fast: 200,
+ // Default speed
+ _default: 400
+ },
+
+ step: {
+ opacity: function( fx ) {
+ jQuery.style( fx.elem, "opacity", fx.now );
+ },
+
+ _default: function( fx ) {
+ if ( fx.elem.style && fx.elem.style[ fx.prop ] != null ) {
+ fx.elem.style[ fx.prop ] = fx.now + fx.unit;
+ } else {
+ fx.elem[ fx.prop ] = fx.now;
+ }
+ }
+ }
+});
+
+// Adds width/height step functions
+// Do not set anything below 0
+jQuery.each([ "width", "height" ], function( i, prop ) {
+ jQuery.fx.step[ prop ] = function( fx ) {
+ jQuery.style( fx.elem, prop, Math.max(0, fx.now) + fx.unit );
+ };
+});
+
+if ( jQuery.expr && jQuery.expr.filters ) {
+ jQuery.expr.filters.animated = function( elem ) {
+ return jQuery.grep(jQuery.timers, function( fn ) {
+ return elem === fn.elem;
+ }).length;
+ };
+}
+
+// Try to restore the default display value of an element
+function defaultDisplay( nodeName ) {
+
+ if ( !elemdisplay[ nodeName ] ) {
+
+ var body = document.body,
+ elem = jQuery( "<" + nodeName + ">" ).appendTo( body ),
+ display = elem.css( "display" );
+ elem.remove();
+
+ // If the simple way fails,
+ // get element's real default display by attaching it to a temp iframe
+ if ( display === "none" || display === "" ) {
+ // No iframe to use yet, so create it
+ if ( !iframe ) {
+ iframe = document.createElement( "iframe" );
+ iframe.frameBorder = iframe.width = iframe.height = 0;
+ }
+
+ body.appendChild( iframe );
+
+ // Create a cacheable copy of the iframe document on first call.
+ // IE and Opera will allow us to reuse the iframeDoc without re-writing the fake HTML
+ // document to it; WebKit & Firefox won't allow reusing the iframe document.
+ if ( !iframeDoc || !iframe.createElement ) {
+ iframeDoc = ( iframe.contentWindow || iframe.contentDocument ).document;
+ iframeDoc.write( ( document.compatMode === "CSS1Compat" ? "<!doctype html>" : "" ) + "<html><body>" );
+ iframeDoc.close();
+ }
+
+ elem = iframeDoc.createElement( nodeName );
+
+ iframeDoc.body.appendChild( elem );
+
+ display = jQuery.css( elem, "display" );
+ body.removeChild( iframe );
+ }
+
+ // Store the correct default display
+ elemdisplay[ nodeName ] = display;
+ }
+
+ return elemdisplay[ nodeName ];
+}
+
+
+
+
+var rtable = /^t(?:able|d|h)$/i,
+ rroot = /^(?:body|html)$/i;
+
+if ( "getBoundingClientRect" in document.documentElement ) {
+ jQuery.fn.offset = function( options ) {
+ var elem = this[0], box;
+
+ if ( options ) {
+ return this.each(function( i ) {
+ jQuery.offset.setOffset( this, options, i );
+ });
+ }
+
+ if ( !elem || !elem.ownerDocument ) {
+ return null;
+ }
+
+ if ( elem === elem.ownerDocument.body ) {
+ return jQuery.offset.bodyOffset( elem );
+ }
+
+ try {
+ box = elem.getBoundingClientRect();
+ } catch(e) {}
+
+ var doc = elem.ownerDocument,
+ docElem = doc.documentElement;
+
+ // Make sure we're not dealing with a disconnected DOM node
+ if ( !box || !jQuery.contains( docElem, elem ) ) {
+ return box ? { top: box.top, left: box.left } : { top: 0, left: 0 };
+ }
+
+ var body = doc.body,
+ win = getWindow(doc),
+ clientTop = docElem.clientTop || body.clientTop || 0,
+ clientLeft = docElem.clientLeft || body.clientLeft || 0,
+ scrollTop = win.pageYOffset || jQuery.support.boxModel && docElem.scrollTop || body.scrollTop,
+ scrollLeft = win.pageXOffset || jQuery.support.boxModel && docElem.scrollLeft || body.scrollLeft,
+ top = box.top + scrollTop - clientTop,
+ left = box.left + scrollLeft - clientLeft;
+
+ return { top: top, left: left };
+ };
+
+} else {
+ jQuery.fn.offset = function( options ) {
+ var elem = this[0];
+
+ if ( options ) {
+ return this.each(function( i ) {
+ jQuery.offset.setOffset( this, options, i );
+ });
+ }
+
+ if ( !elem || !elem.ownerDocument ) {
+ return null;
+ }
+
+ if ( elem === elem.ownerDocument.body ) {
+ return jQuery.offset.bodyOffset( elem );
+ }
+
+ var computedStyle,
+ offsetParent = elem.offsetParent,
+ prevOffsetParent = elem,
+ doc = elem.ownerDocument,
+ docElem = doc.documentElement,
+ body = doc.body,
+ defaultView = doc.defaultView,
+ prevComputedStyle = defaultView ? defaultView.getComputedStyle( elem, null ) : elem.currentStyle,
+ top = elem.offsetTop,
+ left = elem.offsetLeft;
+
+ while ( (elem = elem.parentNode) && elem !== body && elem !== docElem ) {
+ if ( jQuery.support.fixedPosition && prevComputedStyle.position === "fixed" ) {
+ break;
+ }
+
+ computedStyle = defaultView ? defaultView.getComputedStyle(elem, null) : elem.currentStyle;
+ top -= elem.scrollTop;
+ left -= elem.scrollLeft;
+
+ if ( elem === offsetParent ) {
+ top += elem.offsetTop;
+ left += elem.offsetLeft;
+
+ if ( jQuery.support.doesNotAddBorder && !(jQuery.support.doesAddBorderForTableAndCells && rtable.test(elem.nodeName)) ) {
+ top += parseFloat( computedStyle.borderTopWidth ) || 0;
+ left += parseFloat( computedStyle.borderLeftWidth ) || 0;
+ }
+
+ prevOffsetParent = offsetParent;
+ offsetParent = elem.offsetParent;
+ }
+
+ if ( jQuery.support.subtractsBorderForOverflowNotVisible && computedStyle.overflow !== "visible" ) {
+ top += parseFloat( computedStyle.borderTopWidth ) || 0;
+ left += parseFloat( computedStyle.borderLeftWidth ) || 0;
+ }
+
+ prevComputedStyle = computedStyle;
+ }
+
+ if ( prevComputedStyle.position === "relative" || prevComputedStyle.position === "static" ) {
+ top += body.offsetTop;
+ left += body.offsetLeft;
+ }
+
+ if ( jQuery.support.fixedPosition && prevComputedStyle.position === "fixed" ) {
+ top += Math.max( docElem.scrollTop, body.scrollTop );
+ left += Math.max( docElem.scrollLeft, body.scrollLeft );
+ }
+
+ return { top: top, left: left };
+ };
+}
+
+jQuery.offset = {
+
+ bodyOffset: function( body ) {
+ var top = body.offsetTop,
+ left = body.offsetLeft;
+
+ if ( jQuery.support.doesNotIncludeMarginInBodyOffset ) {
+ top += parseFloat( jQuery.css(body, "marginTop") ) || 0;
+ left += parseFloat( jQuery.css(body, "marginLeft") ) || 0;
+ }
+
+ return { top: top, left: left };
+ },
+
+ setOffset: function( elem, options, i ) {
+ var position = jQuery.css( elem, "position" );
+
+ // set position first, in-case top/left are set even on static elem
+ if ( position === "static" ) {
+ elem.style.position = "relative";
+ }
+
+ var curElem = jQuery( elem ),
+ curOffset = curElem.offset(),
+ curCSSTop = jQuery.css( elem, "top" ),
+ curCSSLeft = jQuery.css( elem, "left" ),
+ calculatePosition = ( position === "absolute" || position === "fixed" ) && jQuery.inArray("auto", [curCSSTop, curCSSLeft]) > -1,
+ props = {}, curPosition = {}, curTop, curLeft;
+
+ // need to be able to calculate position if either top or left is auto and position is either absolute or fixed
+ if ( calculatePosition ) {
+ curPosition = curElem.position();
+ curTop = curPosition.top;
+ curLeft = curPosition.left;
+ } else {
+ curTop = parseFloat( curCSSTop ) || 0;
+ curLeft = parseFloat( curCSSLeft ) || 0;
+ }
+
+ if ( jQuery.isFunction( options ) ) {
+ options = options.call( elem, i, curOffset );
+ }
+
+ if ( options.top != null ) {
+ props.top = ( options.top - curOffset.top ) + curTop;
+ }
+ if ( options.left != null ) {
+ props.left = ( options.left - curOffset.left ) + curLeft;
+ }
+
+ if ( "using" in options ) {
+ options.using.call( elem, props );
+ } else {
+ curElem.css( props );
+ }
+ }
+};
+
+
+jQuery.fn.extend({
+
+ position: function() {
+ if ( !this[0] ) {
+ return null;
+ }
+
+ var elem = this[0],
+
+ // Get *real* offsetParent
+ offsetParent = this.offsetParent(),
+
+ // Get correct offsets
+ offset = this.offset(),
+ parentOffset = rroot.test(offsetParent[0].nodeName) ? { top: 0, left: 0 } : offsetParent.offset();
+
+ // Subtract element margins
+ // note: when an element has margin: auto the offsetLeft and marginLeft
+ // are the same in Safari causing offset.left to incorrectly be 0
+ offset.top -= parseFloat( jQuery.css(elem, "marginTop") ) || 0;
+ offset.left -= parseFloat( jQuery.css(elem, "marginLeft") ) || 0;
+
+ // Add offsetParent borders
+ parentOffset.top += parseFloat( jQuery.css(offsetParent[0], "borderTopWidth") ) || 0;
+ parentOffset.left += parseFloat( jQuery.css(offsetParent[0], "borderLeftWidth") ) || 0;
+
+ // Subtract the two offsets
+ return {
+ top: offset.top - parentOffset.top,
+ left: offset.left - parentOffset.left
+ };
+ },
+
+ offsetParent: function() {
+ return this.map(function() {
+ var offsetParent = this.offsetParent || document.body;
+ while ( offsetParent && (!rroot.test(offsetParent.nodeName) && jQuery.css(offsetParent, "position") === "static") ) {
+ offsetParent = offsetParent.offsetParent;
+ }
+ return offsetParent;
+ });
+ }
+});
+
+
+// Create scrollLeft and scrollTop methods
+jQuery.each( ["Left", "Top"], function( i, name ) {
+ var method = "scroll" + name;
+
+ jQuery.fn[ method ] = function( val ) {
+ var elem, win;
+
+ if ( val === undefined ) {
+ elem = this[ 0 ];
+
+ if ( !elem ) {
+ return null;
+ }
+
+ win = getWindow( elem );
+
+ // Return the scroll offset
+ return win ? ("pageXOffset" in win) ? win[ i ? "pageYOffset" : "pageXOffset" ] :
+ jQuery.support.boxModel && win.document.documentElement[ method ] ||
+ win.document.body[ method ] :
+ elem[ method ];
+ }
+
+ // Set the scroll offset
+ return this.each(function() {
+ win = getWindow( this );
+
+ if ( win ) {
+ win.scrollTo(
+ !i ? val : jQuery( win ).scrollLeft(),
+ i ? val : jQuery( win ).scrollTop()
+ );
+
+ } else {
+ this[ method ] = val;
+ }
+ });
+ };
+});
+
+function getWindow( elem ) {
+ return jQuery.isWindow( elem ) ?
+ elem :
+ elem.nodeType === 9 ?
+ elem.defaultView || elem.parentWindow :
+ false;
+}
+
+
+
+
+// Create width, height, innerHeight, innerWidth, outerHeight and outerWidth methods
+jQuery.each([ "Height", "Width" ], function( i, name ) {
+
+ var type = name.toLowerCase();
+
+ // innerHeight and innerWidth
+ jQuery.fn[ "inner" + name ] = function() {
+ var elem = this[0];
+ return elem ?
+ elem.style ?
+ parseFloat( jQuery.css( elem, type, "padding" ) ) :
+ this[ type ]() :
+ null;
+ };
+
+ // outerHeight and outerWidth
+ jQuery.fn[ "outer" + name ] = function( margin ) {
+ var elem = this[0];
+ return elem ?
+ elem.style ?
+ parseFloat( jQuery.css( elem, type, margin ? "margin" : "border" ) ) :
+ this[ type ]() :
+ null;
+ };
+
+ jQuery.fn[ type ] = function( size ) {
+ // Get window width or height
+ var elem = this[0];
+ if ( !elem ) {
+ return size == null ? null : this;
+ }
+
+ if ( jQuery.isFunction( size ) ) {
+ return this.each(function( i ) {
+ var self = jQuery( this );
+ self[ type ]( size.call( this, i, self[ type ]() ) );
+ });
+ }
+
+ if ( jQuery.isWindow( elem ) ) {
+ // Everyone else use document.documentElement or document.body depending on Quirks vs Standards mode
+ // 3rd condition allows Nokia support, as it supports the docElem prop but not CSS1Compat
+ var docElemProp = elem.document.documentElement[ "client" + name ],
+ body = elem.document.body;
+ return elem.document.compatMode === "CSS1Compat" && docElemProp ||
+ body && body[ "client" + name ] || docElemProp;
+
+ // Get document width or height
+ } else if ( elem.nodeType === 9 ) {
+ // Either scroll[Width/Height] or offset[Width/Height], whichever is greater
+ return Math.max(
+ elem.documentElement["client" + name],
+ elem.body["scroll" + name], elem.documentElement["scroll" + name],
+ elem.body["offset" + name], elem.documentElement["offset" + name]
+ );
+
+ // Get or set width or height on the element
+ } else if ( size === undefined ) {
+ var orig = jQuery.css( elem, type ),
+ ret = parseFloat( orig );
+
+ return jQuery.isNumeric( ret ) ? ret : orig;
+
+ // Set the width or height on the element (default to pixels if value is unitless)
+ } else {
+ return this.css( type, typeof size === "string" ? size : size + "px" );
+ }
+ };
+
+});
+
+
+
+
+// Expose jQuery to the global object
+window.jQuery = window.$ = jQuery;
+
+// Expose jQuery as an AMD module, but only for AMD loaders that
+// understand the issues with loading multiple versions of jQuery
+// in a page that all might call define(). The loader will indicate
+// they have special allowances for multiple jQuery versions by
+// specifying define.amd.jQuery = true. Register as a named module,
+// since jQuery can be concatenated with other files that may use define,
+// but not use a proper concatenation script that understands anonymous
+// AMD modules. A named AMD is safest and most robust way to register.
+// Lowercase jquery is used because AMD module names are derived from
+// file names, and jQuery is normally delivered in a lowercase file name.
+// Do this after creating the global so that if an AMD module wants to call
+// noConflict to hide this version of jQuery, it will work.
+if ( typeof define === "function" && define.amd && define.amd.jQuery ) {
+ define( "jquery", [], function () { return jQuery; } );
+}
+
+
+
+})( window );
diff --git a/lib/beetsplug/web/static/underscore.js b/lib/beetsplug/web/static/underscore.js
new file mode 100644
index 00000000..5579c07d
--- /dev/null
+++ b/lib/beetsplug/web/static/underscore.js
@@ -0,0 +1,977 @@
+// Underscore.js 1.2.2
+// (c) 2011 Jeremy Ashkenas, DocumentCloud Inc.
+// Underscore is freely distributable under the MIT license.
+// Portions of Underscore are inspired or borrowed from Prototype,
+// Oliver Steele's Functional, and John Resig's Micro-Templating.
+// For all details and documentation:
+// http://documentcloud.github.com/underscore
+
+(function() {
+
+ // Baseline setup
+ // --------------
+
+ // Establish the root object, `window` in the browser, or `global` on the server.
+ var root = this;
+
+ // Save the previous value of the `_` variable.
+ var previousUnderscore = root._;
+
+ // Establish the object that gets returned to break out of a loop iteration.
+ var breaker = {};
+
+ // Save bytes in the minified (but not gzipped) version:
+ var ArrayProto = Array.prototype, ObjProto = Object.prototype, FuncProto = Function.prototype;
+
+ // Create quick reference variables for speed access to core prototypes.
+ var slice = ArrayProto.slice,
+ unshift = ArrayProto.unshift,
+ toString = ObjProto.toString,
+ hasOwnProperty = ObjProto.hasOwnProperty;
+
+ // All **ECMAScript 5** native function implementations that we hope to use
+ // are declared here.
+ var
+ nativeForEach = ArrayProto.forEach,
+ nativeMap = ArrayProto.map,
+ nativeReduce = ArrayProto.reduce,
+ nativeReduceRight = ArrayProto.reduceRight,
+ nativeFilter = ArrayProto.filter,
+ nativeEvery = ArrayProto.every,
+ nativeSome = ArrayProto.some,
+ nativeIndexOf = ArrayProto.indexOf,
+ nativeLastIndexOf = ArrayProto.lastIndexOf,
+ nativeIsArray = Array.isArray,
+ nativeKeys = Object.keys,
+ nativeBind = FuncProto.bind;
+
+ // Create a safe reference to the Underscore object for use below.
+ var _ = function(obj) { return new wrapper(obj); };
+
+ // Export the Underscore object for **Node.js** and **"CommonJS"**, with
+ // backwards-compatibility for the old `require()` API. If we're not in
+ // CommonJS, add `_` to the global object.
+ if (typeof exports !== 'undefined') {
+ if (typeof module !== 'undefined' && module.exports) {
+ exports = module.exports = _;
+ }
+ exports._ = _;
+ } else if (typeof define === 'function' && define.amd) {
+ // Register as a named module with AMD.
+ define('underscore', function() {
+ return _;
+ });
+ } else {
+ // Exported as a string, for Closure Compiler "advanced" mode.
+ root['_'] = _;
+ }
+
+ // Current version.
+ _.VERSION = '1.2.2';
+
+ // Collection Functions
+ // --------------------
+
+ // The cornerstone, an `each` implementation, aka `forEach`.
+ // Handles objects with the built-in `forEach`, arrays, and raw objects.
+ // Delegates to **ECMAScript 5**'s native `forEach` if available.
+ var each = _.each = _.forEach = function(obj, iterator, context) {
+ if (obj == null) return;
+ if (nativeForEach && obj.forEach === nativeForEach) {
+ obj.forEach(iterator, context);
+ } else if (obj.length === +obj.length) {
+ for (var i = 0, l = obj.length; i < l; i++) {
+ if (i in obj && iterator.call(context, obj[i], i, obj) === breaker) return;
+ }
+ } else {
+ for (var key in obj) {
+ if (hasOwnProperty.call(obj, key)) {
+ if (iterator.call(context, obj[key], key, obj) === breaker) return;
+ }
+ }
+ }
+ };
+
+ // Return the results of applying the iterator to each element.
+ // Delegates to **ECMAScript 5**'s native `map` if available.
+ _.map = function(obj, iterator, context) {
+ var results = [];
+ if (obj == null) return results;
+ if (nativeMap && obj.map === nativeMap) return obj.map(iterator, context);
+ each(obj, function(value, index, list) {
+ results[results.length] = iterator.call(context, value, index, list);
+ });
+ return results;
+ };
+
+ // **Reduce** builds up a single result from a list of values, aka `inject`,
+ // or `foldl`. Delegates to **ECMAScript 5**'s native `reduce` if available.
+ _.reduce = _.foldl = _.inject = function(obj, iterator, memo, context) {
+ var initial = memo !== void 0;
+ if (obj == null) obj = [];
+ if (nativeReduce && obj.reduce === nativeReduce) {
+ if (context) iterator = _.bind(iterator, context);
+ return initial ? obj.reduce(iterator, memo) : obj.reduce(iterator);
+ }
+ each(obj, function(value, index, list) {
+ if (!initial) {
+ memo = value;
+ initial = true;
+ } else {
+ memo = iterator.call(context, memo, value, index, list);
+ }
+ });
+ if (!initial) throw new TypeError("Reduce of empty array with no initial value");
+ return memo;
+ };
+
+ // The right-associative version of reduce, also known as `foldr`.
+ // Delegates to **ECMAScript 5**'s native `reduceRight` if available.
+ _.reduceRight = _.foldr = function(obj, iterator, memo, context) {
+ if (obj == null) obj = [];
+ if (nativeReduceRight && obj.reduceRight === nativeReduceRight) {
+ if (context) iterator = _.bind(iterator, context);
+ return memo !== void 0 ? obj.reduceRight(iterator, memo) : obj.reduceRight(iterator);
+ }
+ var reversed = (_.isArray(obj) ? obj.slice() : _.toArray(obj)).reverse();
+ return _.reduce(reversed, iterator, memo, context);
+ };
+
+ // Return the first value which passes a truth test. Aliased as `detect`.
+ _.find = _.detect = function(obj, iterator, context) {
+ var result;
+ any(obj, function(value, index, list) {
+ if (iterator.call(context, value, index, list)) {
+ result = value;
+ return true;
+ }
+ });
+ return result;
+ };
+
+ // Return all the elements that pass a truth test.
+ // Delegates to **ECMAScript 5**'s native `filter` if available.
+ // Aliased as `select`.
+ _.filter = _.select = function(obj, iterator, context) {
+ var results = [];
+ if (obj == null) return results;
+ if (nativeFilter && obj.filter === nativeFilter) return obj.filter(iterator, context);
+ each(obj, function(value, index, list) {
+ if (iterator.call(context, value, index, list)) results[results.length] = value;
+ });
+ return results;
+ };
+
+ // Return all the elements for which a truth test fails.
+ _.reject = function(obj, iterator, context) {
+ var results = [];
+ if (obj == null) return results;
+ each(obj, function(value, index, list) {
+ if (!iterator.call(context, value, index, list)) results[results.length] = value;
+ });
+ return results;
+ };
+
+ // Determine whether all of the elements match a truth test.
+ // Delegates to **ECMAScript 5**'s native `every` if available.
+ // Aliased as `all`.
+ _.every = _.all = function(obj, iterator, context) {
+ var result = true;
+ if (obj == null) return result;
+ if (nativeEvery && obj.every === nativeEvery) return obj.every(iterator, context);
+ each(obj, function(value, index, list) {
+ if (!(result = result && iterator.call(context, value, index, list))) return breaker;
+ });
+ return result;
+ };
+
+ // Determine if at least one element in the object matches a truth test.
+ // Delegates to **ECMAScript 5**'s native `some` if available.
+ // Aliased as `any`.
+ var any = _.some = _.any = function(obj, iterator, context) {
+ iterator = iterator || _.identity;
+ var result = false;
+ if (obj == null) return result;
+ if (nativeSome && obj.some === nativeSome) return obj.some(iterator, context);
+ each(obj, function(value, index, list) {
+ if (result || (result = iterator.call(context, value, index, list))) return breaker;
+ });
+ return !!result;
+ };
+
+ // Determine if a given value is included in the array or object using `===`.
+ // Aliased as `contains`.
+ _.include = _.contains = function(obj, target) {
+ var found = false;
+ if (obj == null) return found;
+ if (nativeIndexOf && obj.indexOf === nativeIndexOf) return obj.indexOf(target) != -1;
+ found = any(obj, function(value) {
+ return value === target;
+ });
+ return found;
+ };
+
+ // Invoke a method (with arguments) on every item in a collection.
+ _.invoke = function(obj, method) {
+ var args = slice.call(arguments, 2);
+ return _.map(obj, function(value) {
+ return (method.call ? method || value : value[method]).apply(value, args);
+ });
+ };
+
+ // Convenience version of a common use case of `map`: fetching a property.
+ _.pluck = function(obj, key) {
+ return _.map(obj, function(value){ return value[key]; });
+ };
+
+ // Return the maximum element or (element-based computation).
+ _.max = function(obj, iterator, context) {
+ if (!iterator && _.isArray(obj)) return Math.max.apply(Math, obj);
+ if (!iterator && _.isEmpty(obj)) return -Infinity;
+ var result = {computed : -Infinity};
+ each(obj, function(value, index, list) {
+ var computed = iterator ? iterator.call(context, value, index, list) : value;
+ computed >= result.computed && (result = {value : value, computed : computed});
+ });
+ return result.value;
+ };
+
+ // Return the minimum element (or element-based computation).
+ _.min = function(obj, iterator, context) {
+ if (!iterator && _.isArray(obj)) return Math.min.apply(Math, obj);
+ if (!iterator && _.isEmpty(obj)) return Infinity;
+ var result = {computed : Infinity};
+ each(obj, function(value, index, list) {
+ var computed = iterator ? iterator.call(context, value, index, list) : value;
+ computed < result.computed && (result = {value : value, computed : computed});
+ });
+ return result.value;
+ };
+
+ // Shuffle an array.
+ _.shuffle = function(obj) {
+ var shuffled = [], rand;
+ each(obj, function(value, index, list) {
+ if (index == 0) {
+ shuffled[0] = value;
+ } else {
+ rand = Math.floor(Math.random() * (index + 1));
+ shuffled[index] = shuffled[rand];
+ shuffled[rand] = value;
+ }
+ });
+ return shuffled;
+ };
+
+ // Sort the object's values by a criterion produced by an iterator.
+ _.sortBy = function(obj, iterator, context) {
+ return _.pluck(_.map(obj, function(value, index, list) {
+ return {
+ value : value,
+ criteria : iterator.call(context, value, index, list)
+ };
+ }).sort(function(left, right) {
+ var a = left.criteria, b = right.criteria;
+ return a < b ? -1 : a > b ? 1 : 0;
+ }), 'value');
+ };
+
+ // Groups the object's values by a criterion. Pass either a string attribute
+ // to group by, or a function that returns the criterion.
+ _.groupBy = function(obj, val) {
+ var result = {};
+ var iterator = _.isFunction(val) ? val : function(obj) { return obj[val]; };
+ each(obj, function(value, index) {
+ var key = iterator(value, index);
+ (result[key] || (result[key] = [])).push(value);
+ });
+ return result;
+ };
+
+ // Use a comparator function to figure out at what index an object should
+ // be inserted so as to maintain order. Uses binary search.
+ _.sortedIndex = function(array, obj, iterator) {
+ iterator || (iterator = _.identity);
+ var low = 0, high = array.length;
+ while (low < high) {
+ var mid = (low + high) >> 1;
+ iterator(array[mid]) < iterator(obj) ? low = mid + 1 : high = mid;
+ }
+ return low;
+ };
+
+ // Safely convert anything iterable into a real, live array.
+ _.toArray = function(iterable) {
+ if (!iterable) return [];
+ if (iterable.toArray) return iterable.toArray();
+ if (_.isArray(iterable)) return slice.call(iterable);
+ if (_.isArguments(iterable)) return slice.call(iterable);
+ return _.values(iterable);
+ };
+
+ // Return the number of elements in an object.
+ _.size = function(obj) {
+ return _.toArray(obj).length;
+ };
+
+ // Array Functions
+ // ---------------
+
+ // Get the first element of an array. Passing **n** will return the first N
+ // values in the array. Aliased as `head`. The **guard** check allows it to work
+ // with `_.map`.
+ _.first = _.head = function(array, n, guard) {
+ return (n != null) && !guard ? slice.call(array, 0, n) : array[0];
+ };
+
+ // Returns everything but the last entry of the array. Especcialy useful on
+ // the arguments object. Passing **n** will return all the values in
+ // the array, excluding the last N. The **guard** check allows it to work with
+ // `_.map`.
+ _.initial = function(array, n, guard) {
+ return slice.call(array, 0, array.length - ((n == null) || guard ? 1 : n));
+ };
+
+ // Get the last element of an array. Passing **n** will return the last N
+ // values in the array. The **guard** check allows it to work with `_.map`.
+ _.last = function(array, n, guard) {
+ if ((n != null) && !guard) {
+ return slice.call(array, Math.max(array.length - n, 0));
+ } else {
+ return array[array.length - 1];
+ }
+ };
+
+ // Returns everything but the first entry of the array. Aliased as `tail`.
+ // Especially useful on the arguments object. Passing an **index** will return
+ // the rest of the values in the array from that index onward. The **guard**
+ // check allows it to work with `_.map`.
+ _.rest = _.tail = function(array, index, guard) {
+ return slice.call(array, (index == null) || guard ? 1 : index);
+ };
+
+ // Trim out all falsy values from an array.
+ _.compact = function(array) {
+ return _.filter(array, function(value){ return !!value; });
+ };
+
+ // Return a completely flattened version of an array.
+ _.flatten = function(array, shallow) {
+ return _.reduce(array, function(memo, value) {
+ if (_.isArray(value)) return memo.concat(shallow ? value : _.flatten(value));
+ memo[memo.length] = value;
+ return memo;
+ }, []);
+ };
+
+ // Return a version of the array that does not contain the specified value(s).
+ _.without = function(array) {
+ return _.difference(array, slice.call(arguments, 1));
+ };
+
+ // Produce a duplicate-free version of the array. If the array has already
+ // been sorted, you have the option of using a faster algorithm.
+ // Aliased as `unique`.
+ _.uniq = _.unique = function(array, isSorted, iterator) {
+ var initial = iterator ? _.map(array, iterator) : array;
+ var result = [];
+ _.reduce(initial, function(memo, el, i) {
+ if (0 == i || (isSorted === true ? _.last(memo) != el : !_.include(memo, el))) {
+ memo[memo.length] = el;
+ result[result.length] = array[i];
+ }
+ return memo;
+ }, []);
+ return result;
+ };
+
+ // Produce an array that contains the union: each distinct element from all of
+ // the passed-in arrays.
+ _.union = function() {
+ return _.uniq(_.flatten(arguments, true));
+ };
+
+ // Produce an array that contains every item shared between all the
+ // passed-in arrays. (Aliased as "intersect" for back-compat.)
+ _.intersection = _.intersect = function(array) {
+ var rest = slice.call(arguments, 1);
+ return _.filter(_.uniq(array), function(item) {
+ return _.every(rest, function(other) {
+ return _.indexOf(other, item) >= 0;
+ });
+ });
+ };
+
+ // Take the difference between one array and another.
+ // Only the elements present in just the first array will remain.
+ _.difference = function(array, other) {
+ return _.filter(array, function(value){ return !_.include(other, value); });
+ };
+
+ // Zip together multiple lists into a single array -- elements that share
+ // an index go together.
+ _.zip = function() {
+ var args = slice.call(arguments);
+ var length = _.max(_.pluck(args, 'length'));
+ var results = new Array(length);
+ for (var i = 0; i < length; i++) results[i] = _.pluck(args, "" + i);
+ return results;
+ };
+
+ // If the browser doesn't supply us with indexOf (I'm looking at you, **MSIE**),
+ // we need this function. Return the position of the first occurrence of an
+ // item in an array, or -1 if the item is not included in the array.
+ // Delegates to **ECMAScript 5**'s native `indexOf` if available.
+ // If the array is large and already in sort order, pass `true`
+ // for **isSorted** to use binary search.
+ _.indexOf = function(array, item, isSorted) {
+ if (array == null) return -1;
+ var i, l;
+ if (isSorted) {
+ i = _.sortedIndex(array, item);
+ return array[i] === item ? i : -1;
+ }
+ if (nativeIndexOf && array.indexOf === nativeIndexOf) return array.indexOf(item);
+ for (i = 0, l = array.length; i < l; i++) if (array[i] === item) return i;
+ return -1;
+ };
+
+ // Delegates to **ECMAScript 5**'s native `lastIndexOf` if available.
+ _.lastIndexOf = function(array, item) {
+ if (array == null) return -1;
+ if (nativeLastIndexOf && array.lastIndexOf === nativeLastIndexOf) return array.lastIndexOf(item);
+ var i = array.length;
+ while (i--) if (array[i] === item) return i;
+ return -1;
+ };
+
+ // Generate an integer Array containing an arithmetic progression. A port of
+ // the native Python `range()` function. See
+ // [the Python documentation](http://docs.python.org/library/functions.html#range).
+ _.range = function(start, stop, step) {
+ if (arguments.length <= 1) {
+ stop = start || 0;
+ start = 0;
+ }
+ step = arguments[2] || 1;
+
+ var len = Math.max(Math.ceil((stop - start) / step), 0);
+ var idx = 0;
+ var range = new Array(len);
+
+ while(idx < len) {
+ range[idx++] = start;
+ start += step;
+ }
+
+ return range;
+ };
+
+ // Function (ahem) Functions
+ // ------------------
+
+ // Reusable constructor function for prototype setting.
+ var ctor = function(){};
+
+ // Create a function bound to a given object (assigning `this`, and arguments,
+ // optionally). Binding with arguments is also known as `curry`.
+ // Delegates to **ECMAScript 5**'s native `Function.bind` if available.
+ // We check for `func.bind` first, to fail fast when `func` is undefined.
+ _.bind = function bind(func, context) {
+ var bound, args;
+ if (func.bind === nativeBind && nativeBind) return nativeBind.apply(func, slice.call(arguments, 1));
+ if (!_.isFunction(func)) throw new TypeError;
+ args = slice.call(arguments, 2);
+ return bound = function() {
+ if (!(this instanceof bound)) return func.apply(context, args.concat(slice.call(arguments)));
+ ctor.prototype = func.prototype;
+ var self = new ctor;
+ var result = func.apply(self, args.concat(slice.call(arguments)));
+ if (Object(result) === result) return result;
+ return self;
+ };
+ };
+
+ // Bind all of an object's methods to that object. Useful for ensuring that
+ // all callbacks defined on an object belong to it.
+ _.bindAll = function(obj) {
+ var funcs = slice.call(arguments, 1);
+ if (funcs.length == 0) funcs = _.functions(obj);
+ each(funcs, function(f) { obj[f] = _.bind(obj[f], obj); });
+ return obj;
+ };
+
+ // Memoize an expensive function by storing its results.
+ _.memoize = function(func, hasher) {
+ var memo = {};
+ hasher || (hasher = _.identity);
+ return function() {
+ var key = hasher.apply(this, arguments);
+ return hasOwnProperty.call(memo, key) ? memo[key] : (memo[key] = func.apply(this, arguments));
+ };
+ };
+
+ // Delays a function for the given number of milliseconds, and then calls
+ // it with the arguments supplied.
+ _.delay = function(func, wait) {
+ var args = slice.call(arguments, 2);
+ return setTimeout(function(){ return func.apply(func, args); }, wait);
+ };
+
+ // Defers a function, scheduling it to run after the current call stack has
+ // cleared.
+ _.defer = function(func) {
+ return _.delay.apply(_, [func, 1].concat(slice.call(arguments, 1)));
+ };
+
+ // Returns a function, that, when invoked, will only be triggered at most once
+ // during a given window of time.
+ _.throttle = function(func, wait) {
+ var context, args, timeout, throttling, more;
+ var whenDone = _.debounce(function(){ more = throttling = false; }, wait);
+ return function() {
+ context = this; args = arguments;
+ var later = function() {
+ timeout = null;
+ if (more) func.apply(context, args);
+ whenDone();
+ };
+ if (!timeout) timeout = setTimeout(later, wait);
+ if (throttling) {
+ more = true;
+ } else {
+ func.apply(context, args);
+ }
+ whenDone();
+ throttling = true;
+ };
+ };
+
+ // Returns a function, that, as long as it continues to be invoked, will not
+ // be triggered. The function will be called after it stops being called for
+ // N milliseconds.
+ _.debounce = function(func, wait) {
+ var timeout;
+ return function() {
+ var context = this, args = arguments;
+ var later = function() {
+ timeout = null;
+ func.apply(context, args);
+ };
+ clearTimeout(timeout);
+ timeout = setTimeout(later, wait);
+ };
+ };
+
+ // Returns a function that will be executed at most one time, no matter how
+ // often you call it. Useful for lazy initialization.
+ _.once = function(func) {
+ var ran = false, memo;
+ return function() {
+ if (ran) return memo;
+ ran = true;
+ return memo = func.apply(this, arguments);
+ };
+ };
+
+ // Returns the first function passed as an argument to the second,
+ // allowing you to adjust arguments, run code before and after, and
+ // conditionally execute the original function.
+ _.wrap = function(func, wrapper) {
+ return function() {
+ var args = [func].concat(slice.call(arguments));
+ return wrapper.apply(this, args);
+ };
+ };
+
+ // Returns a function that is the composition of a list of functions, each
+ // consuming the return value of the function that follows.
+ _.compose = function() {
+ var funcs = slice.call(arguments);
+ return function() {
+ var args = slice.call(arguments);
+ for (var i = funcs.length - 1; i >= 0; i--) {
+ args = [funcs[i].apply(this, args)];
+ }
+ return args[0];
+ };
+ };
+
+ // Returns a function that will only be executed after being called N times.
+ _.after = function(times, func) {
+ if (times <= 0) return func();
+ return function() {
+ if (--times < 1) { return func.apply(this, arguments); }
+ };
+ };
+
+ // Object Functions
+ // ----------------
+
+ // Retrieve the names of an object's properties.
+ // Delegates to **ECMAScript 5**'s native `Object.keys`
+ _.keys = nativeKeys || function(obj) {
+ if (obj !== Object(obj)) throw new TypeError('Invalid object');
+ var keys = [];
+ for (var key in obj) if (hasOwnProperty.call(obj, key)) keys[keys.length] = key;
+ return keys;
+ };
+
+ // Retrieve the values of an object's properties.
+ _.values = function(obj) {
+ return _.map(obj, _.identity);
+ };
+
+ // Return a sorted list of the function names available on the object.
+ // Aliased as `methods`
+ _.functions = _.methods = function(obj) {
+ var names = [];
+ for (var key in obj) {
+ if (_.isFunction(obj[key])) names.push(key);
+ }
+ return names.sort();
+ };
+
+ // Extend a given object with all the properties in passed-in object(s).
+ _.extend = function(obj) {
+ each(slice.call(arguments, 1), function(source) {
+ for (var prop in source) {
+ if (source[prop] !== void 0) obj[prop] = source[prop];
+ }
+ });
+ return obj;
+ };
+
+ // Fill in a given object with default properties.
+ _.defaults = function(obj) {
+ each(slice.call(arguments, 1), function(source) {
+ for (var prop in source) {
+ if (obj[prop] == null) obj[prop] = source[prop];
+ }
+ });
+ return obj;
+ };
+
+ // Create a (shallow-cloned) duplicate of an object.
+ _.clone = function(obj) {
+ if (!_.isObject(obj)) return obj;
+ return _.isArray(obj) ? obj.slice() : _.extend({}, obj);
+ };
+
+ // Invokes interceptor with the obj, and then returns obj.
+ // The primary purpose of this method is to "tap into" a method chain, in
+ // order to perform operations on intermediate results within the chain.
+ _.tap = function(obj, interceptor) {
+ interceptor(obj);
+ return obj;
+ };
+
+ // Internal recursive comparison function.
+ function eq(a, b, stack) {
+ // Identical objects are equal. `0 === -0`, but they aren't identical.
+ // See the Harmony `egal` proposal: http://wiki.ecmascript.org/doku.php?id=harmony:egal.
+ if (a === b) return a !== 0 || 1 / a == 1 / b;
+ // A strict comparison is necessary because `null == undefined`.
+ if (a == null || b == null) return a === b;
+ // Unwrap any wrapped objects.
+ if (a._chain) a = a._wrapped;
+ if (b._chain) b = b._wrapped;
+ // Invoke a custom `isEqual` method if one is provided.
+ if (_.isFunction(a.isEqual)) return a.isEqual(b);
+ if (_.isFunction(b.isEqual)) return b.isEqual(a);
+ // Compare `[[Class]]` names.
+ var className = toString.call(a);
+ if (className != toString.call(b)) return false;
+ switch (className) {
+ // Strings, numbers, dates, and booleans are compared by value.
+ case '[object String]':
+ // Primitives and their corresponding object wrappers are equivalent; thus, `"5"` is
+ // equivalent to `new String("5")`.
+ return String(a) == String(b);
+ case '[object Number]':
+ a = +a;
+ b = +b;
+ // `NaN`s are equivalent, but non-reflexive. An `egal` comparison is performed for
+ // other numeric values.
+ return a != a ? b != b : (a == 0 ? 1 / a == 1 / b : a == b);
+ case '[object Date]':
+ case '[object Boolean]':
+ // Coerce dates and booleans to numeric primitive values. Dates are compared by their
+ // millisecond representations. Note that invalid dates with millisecond representations
+ // of `NaN` are not equivalent.
+ return +a == +b;
+ // RegExps are compared by their source patterns and flags.
+ case '[object RegExp]':
+ return a.source == b.source &&
+ a.global == b.global &&
+ a.multiline == b.multiline &&
+ a.ignoreCase == b.ignoreCase;
+ }
+ if (typeof a != 'object' || typeof b != 'object') return false;
+ // Assume equality for cyclic structures. The algorithm for detecting cyclic
+ // structures is adapted from ES 5.1 section 15.12.3, abstract operation `JO`.
+ var length = stack.length;
+ while (length--) {
+ // Linear search. Performance is inversely proportional to the number of
+ // unique nested structures.
+ if (stack[length] == a) return true;
+ }
+ // Add the first object to the stack of traversed objects.
+ stack.push(a);
+ var size = 0, result = true;
+ // Recursively compare objects and arrays.
+ if (className == '[object Array]') {
+ // Compare array lengths to determine if a deep comparison is necessary.
+ size = a.length;
+ result = size == b.length;
+ if (result) {
+ // Deep compare the contents, ignoring non-numeric properties.
+ while (size--) {
+ // Ensure commutative equality for sparse arrays.
+ if (!(result = size in a == size in b && eq(a[size], b[size], stack))) break;
+ }
+ }
+ } else {
+ // Objects with different constructors are not equivalent.
+ if ("constructor" in a != "constructor" in b || a.constructor != b.constructor) return false;
+ // Deep compare objects.
+ for (var key in a) {
+ if (hasOwnProperty.call(a, key)) {
+ // Count the expected number of properties.
+ size++;
+ // Deep compare each member.
+ if (!(result = hasOwnProperty.call(b, key) && eq(a[key], b[key], stack))) break;
+ }
+ }
+ // Ensure that both objects contain the same number of properties.
+ if (result) {
+ for (key in b) {
+ if (hasOwnProperty.call(b, key) && !(size--)) break;
+ }
+ result = !size;
+ }
+ }
+ // Remove the first object from the stack of traversed objects.
+ stack.pop();
+ return result;
+ }
+
+ // Perform a deep comparison to check if two objects are equal.
+ _.isEqual = function(a, b) {
+ return eq(a, b, []);
+ };
+
+ // Is a given array, string, or object empty?
+ // An "empty" object has no enumerable own-properties.
+ _.isEmpty = function(obj) {
+ if (_.isArray(obj) || _.isString(obj)) return obj.length === 0;
+ for (var key in obj) if (hasOwnProperty.call(obj, key)) return false;
+ return true;
+ };
+
+ // Is a given value a DOM element?
+ _.isElement = function(obj) {
+ return !!(obj && obj.nodeType == 1);
+ };
+
+ // Is a given value an array?
+ // Delegates to ECMA5's native Array.isArray
+ _.isArray = nativeIsArray || function(obj) {
+ return toString.call(obj) == '[object Array]';
+ };
+
+ // Is a given variable an object?
+ _.isObject = function(obj) {
+ return obj === Object(obj);
+ };
+
+ // Is a given variable an arguments object?
+ if (toString.call(arguments) == '[object Arguments]') {
+ _.isArguments = function(obj) {
+ return toString.call(obj) == '[object Arguments]';
+ };
+ } else {
+ _.isArguments = function(obj) {
+ return !!(obj && hasOwnProperty.call(obj, 'callee'));
+ };
+ }
+
+ // Is a given value a function?
+ _.isFunction = function(obj) {
+ return toString.call(obj) == '[object Function]';
+ };
+
+ // Is a given value a string?
+ _.isString = function(obj) {
+ return toString.call(obj) == '[object String]';
+ };
+
+ // Is a given value a number?
+ _.isNumber = function(obj) {
+ return toString.call(obj) == '[object Number]';
+ };
+
+ // Is the given value `NaN`?
+ _.isNaN = function(obj) {
+ // `NaN` is the only value for which `===` is not reflexive.
+ return obj !== obj;
+ };
+
+ // Is a given value a boolean?
+ _.isBoolean = function(obj) {
+ return obj === true || obj === false || toString.call(obj) == '[object Boolean]';
+ };
+
+ // Is a given value a date?
+ _.isDate = function(obj) {
+ return toString.call(obj) == '[object Date]';
+ };
+
+ // Is the given value a regular expression?
+ _.isRegExp = function(obj) {
+ return toString.call(obj) == '[object RegExp]';
+ };
+
+ // Is a given value equal to null?
+ _.isNull = function(obj) {
+ return obj === null;
+ };
+
+ // Is a given variable undefined?
+ _.isUndefined = function(obj) {
+ return obj === void 0;
+ };
+
+ // Utility Functions
+ // -----------------
+
+ // Run Underscore.js in *noConflict* mode, returning the `_` variable to its
+ // previous owner. Returns a reference to the Underscore object.
+ _.noConflict = function() {
+ root._ = previousUnderscore;
+ return this;
+ };
+
+ // Keep the identity function around for default iterators.
+ _.identity = function(value) {
+ return value;
+ };
+
+ // Run a function **n** times.
+ _.times = function (n, iterator, context) {
+ for (var i = 0; i < n; i++) iterator.call(context, i);
+ };
+
+ // Escape a string for HTML interpolation.
+ _.escape = function(string) {
+ return (''+string).replace(/&/g, '&').replace(/</g, '<').replace(/>/g, '>').replace(/"/g, '"').replace(/'/g, ''').replace(/\//g,'/');
+ };
+
+ // Add your own custom functions to the Underscore object, ensuring that
+ // they're correctly added to the OOP wrapper as well.
+ _.mixin = function(obj) {
+ each(_.functions(obj), function(name){
+ addToWrapper(name, _[name] = obj[name]);
+ });
+ };
+
+ // Generate a unique integer id (unique within the entire client session).
+ // Useful for temporary DOM ids.
+ var idCounter = 0;
+ _.uniqueId = function(prefix) {
+ var id = idCounter++;
+ return prefix ? prefix + id : id;
+ };
+
+ // By default, Underscore uses ERB-style template delimiters, change the
+ // following template settings to use alternative delimiters.
+ _.templateSettings = {
+ evaluate : /<%([\s\S]+?)%>/g,
+ interpolate : /<%=([\s\S]+?)%>/g,
+ escape : /<%-([\s\S]+?)%>/g
+ };
+
+ // JavaScript micro-templating, similar to John Resig's implementation.
+ // Underscore templating handles arbitrary delimiters, preserves whitespace,
+ // and correctly escapes quotes within interpolated code.
+ _.template = function(str, data) {
+ var c = _.templateSettings;
+ var tmpl = 'var __p=[],print=function(){__p.push.apply(__p,arguments);};' +
+ 'with(obj||{}){__p.push(\'' +
+ str.replace(/\\/g, '\\\\')
+ .replace(/'/g, "\\'")
+ .replace(c.escape, function(match, code) {
+ return "',_.escape(" + code.replace(/\\'/g, "'") + "),'";
+ })
+ .replace(c.interpolate, function(match, code) {
+ return "'," + code.replace(/\\'/g, "'") + ",'";
+ })
+ .replace(c.evaluate || null, function(match, code) {
+ return "');" + code.replace(/\\'/g, "'")
+ .replace(/[\r\n\t]/g, ' ') + ";__p.push('";
+ })
+ .replace(/\r/g, '\\r')
+ .replace(/\n/g, '\\n')
+ .replace(/\t/g, '\\t')
+ + "');}return __p.join('');";
+ var func = new Function('obj', '_', tmpl);
+ return data ? func(data, _) : function(data) { return func(data, _) };
+ };
+
+ // The OOP Wrapper
+ // ---------------
+
+ // If Underscore is called as a function, it returns a wrapped object that
+ // can be used OO-style. This wrapper holds altered versions of all the
+ // underscore functions. Wrapped objects may be chained.
+ var wrapper = function(obj) { this._wrapped = obj; };
+
+ // Expose `wrapper.prototype` as `_.prototype`
+ _.prototype = wrapper.prototype;
+
+ // Helper function to continue chaining intermediate results.
+ var result = function(obj, chain) {
+ return chain ? _(obj).chain() : obj;
+ };
+
+ // A method to easily add functions to the OOP wrapper.
+ var addToWrapper = function(name, func) {
+ wrapper.prototype[name] = function() {
+ var args = slice.call(arguments);
+ unshift.call(args, this._wrapped);
+ return result(func.apply(_, args), this._chain);
+ };
+ };
+
+ // Add all of the Underscore functions to the wrapper object.
+ _.mixin(_);
+
+ // Add all mutator Array functions to the wrapper.
+ each(['pop', 'push', 'reverse', 'shift', 'sort', 'splice', 'unshift'], function(name) {
+ var method = ArrayProto[name];
+ wrapper.prototype[name] = function() {
+ method.apply(this._wrapped, arguments);
+ return result(this._wrapped, this._chain);
+ };
+ });
+
+ // Add all accessor Array functions to the wrapper.
+ each(['concat', 'join', 'slice'], function(name) {
+ var method = ArrayProto[name];
+ wrapper.prototype[name] = function() {
+ return result(method.apply(this._wrapped, arguments), this._chain);
+ };
+ });
+
+ // Start chaining a wrapped Underscore object.
+ wrapper.prototype.chain = function() {
+ this._chain = true;
+ return this;
+ };
+
+ // Extracts the result from a wrapped and chained object.
+ wrapper.prototype.value = function() {
+ return this._wrapped;
+ };
+
+}).call(this);
diff --git a/lib/beetsplug/web/templates/index.html b/lib/beetsplug/web/templates/index.html
new file mode 100644
index 00000000..0fdd46d1
--- /dev/null
+++ b/lib/beetsplug/web/templates/index.html
@@ -0,0 +1,98 @@
+<!DOCTYPE html>
+<html>
+ <head>
+ <title>beets
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+