From 72515448ad505ef0b73c0d0aa4aa424419b55755 Mon Sep 17 00:00:00 2001 From: FichteFoll Date: Wed, 5 Jun 2019 02:38:46 +0200 Subject: [PATCH 01/26] Add fallback for item access to album's attributes Allows queries (especially for pathspecs) based on an album's flexattrs while operating on items. Fixes #2797. --- beets/dbcore/db.py | 29 +++++++++++++++-------------- beets/library.py | 37 ++++++++++++++++++++++++++++++++++++- test/test_ipfs.py | 5 +++-- test/test_library.py | 33 +++++++++++++++++++++++++++++++++ test/test_query.py | 13 ++++++++++++- 5 files changed, 99 insertions(+), 18 deletions(-) diff --git a/beets/dbcore/db.py b/beets/dbcore/db.py index 3195b52c9..5aa418632 100755 --- a/beets/dbcore/db.py +++ b/beets/dbcore/db.py @@ -345,9 +345,9 @@ 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. @@ -359,8 +359,18 @@ class Model(object): 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 + + 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 @@ -435,19 +445,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 diff --git a/beets/library.py b/beets/library.py index bb49d0e99..5740f20ee 100644 --- a/beets/library.py +++ b/beets/library.py @@ -386,7 +386,7 @@ class FormattedItemMapping(dbcore.db.FormattedMapping): def album_keys(self): album_keys = [] if self.album: - for key in self.album.keys(True): + 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) @@ -571,6 +571,41 @@ class Item(LibModel): if changed and key in MediaFile.fields(): self.mtime = 0 # Reset mtime on dirty. + 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(Item, self).__getitem__(key) + except KeyError: + album = self.get_album() + if album: + return album[key] + raise + + 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(Item, self).keys(computed=computed) + if with_album: + album = self.get_album() + if album: + keys += album.keys(computed=computed) + 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: + album = self.get_album() + if album: + return 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). diff --git a/test/test_ipfs.py b/test/test_ipfs.py index d670bfc25..2fe89e7e5 100644 --- a/test/test_ipfs.py +++ b/test/test_ipfs.py @@ -49,7 +49,7 @@ class IPFSPluginTest(unittest.TestCase, TestHelper): want_item = test_album.items()[2] for check_item in added_album.items(): try: - if check_item.ipfs: + if check_item.get('ipfs', with_album=False): ipfs_item = os.path.basename(want_item.path).decode( _fsencoding(), ) @@ -57,7 +57,8 @@ class IPFSPluginTest(unittest.TestCase, TestHelper): ipfs_item) want_path = bytestring_path(want_path) self.assertEqual(check_item.path, want_path) - self.assertEqual(check_item.ipfs, want_item.ipfs) + self.assertEqual(check_item.get('ipfs', with_album=False), + want_item.ipfs) self.assertEqual(check_item.title, want_item.title) found = True except AttributeError: diff --git a/test/test_library.py b/test/test_library.py index 4e3be878c..51171b1f8 100644 --- a/test/test_library.py +++ b/test/test_library.py @@ -132,6 +132,21 @@ class GetSetTest(_common.TestCase): def test_invalid_field_raises_attributeerror(self): self.assertRaises(AttributeError, getattr, self.i, u'xyzzy') + def test_album_fallback(self): + # integration test of item-album fallback + lib = beets.library.Library(':memory:') + i = item(lib) + album = lib.add_album([i]) + album['flex'] = u'foo' + album.store() + + self.assertTrue('flex' in i) + self.assertFalse('flex' in i.keys(with_album=False)) + self.assertEqual(i['flex'], u'foo') + self.assertEqual(i.get('flex'), u'foo') + self.assertEqual(i.get('flex', with_album=False), None) + self.assertEqual(i.get('flexx'), None) + class DestinationTest(_common.TestCase): def setUp(self): @@ -491,6 +506,24 @@ class DestinationTest(_common.TestCase): dest = self.i.destination() self.assertEqual(dest[-2:], b'XX') + def test_album_field_query(self): + self.lib.directory = b'one' + self.lib.path_formats = [(u'default', u'two'), + (u'flex:foo', u'three')] + album = self.lib.add_album([self.i]) + self.assertEqual(self.i.destination(), np('one/two')) + album['flex'] = u'foo' + album.store() + self.assertEqual(self.i.destination(), np('one/three')) + + def test_album_field_in_template(self): + self.lib.directory = b'one' + self.lib.path_formats = [(u'default', u'$flex/two')] + album = self.lib.add_album([self.i]) + album['flex'] = u'foo' + album.store() + self.assertEqual(self.i.destination(), np('one/foo/two')) + class ItemFormattedMappingTest(_common.LibTestCase): def test_formatted_item_value(self): diff --git a/test/test_query.py b/test/test_query.py index c0ab2a171..56134da7b 100644 --- a/test/test_query.py +++ b/test/test_query.py @@ -109,7 +109,7 @@ class DummyDataTestCase(_common.TestCase, AssertsMixin): items[2].comp = False for item in items: self.lib.add(item) - self.lib.add_album(items[:2]) + self.album = self.lib.add_album(items[:2]) def assert_items_matched_all(self, results): self.assert_items_matched(results, [ @@ -300,6 +300,17 @@ class GetTest(DummyDataTestCase): results = self.lib.items(q) self.assertFalse(results) + def test_album_field_fallback(self): + self.album['albumflex'] = u'foo' + self.album.store() + + q = u'albumflex:foo' + results = self.lib.items(q) + self.assert_items_matched(results, [ + u'foo bar', + u'baz qux', + ]) + def test_invalid_query(self): with self.assertRaises(InvalidQueryArgumentValueError) as raised: dbcore.query.NumericQuery('year', u'199a') From a112358f766260298e4b9d8be9661e85df3a7576 Mon Sep 17 00:00:00 2001 From: FichteFoll Date: Sun, 22 Jul 2018 20:26:23 +0200 Subject: [PATCH 02/26] Override FormattedItemMapping.model_keys model_keys was inferred from `self.keys(True)`, which would include the fallback album keys. Since FormattedItemMapping has its own algorithm for album attributes, we only care about the item's *actual* keys. --- beets/library.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/beets/library.py b/beets/library.py index 5740f20ee..ba822c513 100644 --- a/beets/library.py +++ b/beets/library.py @@ -376,6 +376,9 @@ class FormattedItemMapping(dbcore.db.FormattedMapping): def __init__(self, item, for_path=False): super(FormattedItemMapping, self).__init__(item, for_path) + # We treat album and item keys specially here, + # so exclude transitive album keys from the model's keys. + self.model_keys = item.keys(computed=True, with_album=False) self.item = item @lazy_property From e17c478f74f3331a465af851d5f995c74db62ca6 Mon Sep 17 00:00:00 2001 From: FichteFoll Date: Wed, 5 Jun 2019 02:39:22 +0200 Subject: [PATCH 03/26] Cache an item's album with a property Use Album.load() whenever the album is requested, which causes it to be reloaded from the database. Drawback: This adds a slowdown of 100% (6.2s to 12.6s) to `beet list` on my setup. --- beets/importer.py | 2 +- beets/library.py | 45 ++++++++++++++++++++++++++++++++------------ beetsplug/convert.py | 2 +- 3 files changed, 35 insertions(+), 14 deletions(-) diff --git a/beets/importer.py b/beets/importer.py index d2943b511..4c4316a8e 100644 --- a/beets/importer.py +++ b/beets/importer.py @@ -772,7 +772,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 diff --git a/beets/library.py b/beets/library.py index ba822c513..87bbcd134 100644 --- a/beets/library.py +++ b/beets/library.py @@ -395,9 +395,9 @@ class FormattedItemMapping(dbcore.db.FormattedMapping): album_keys.append(key) return album_keys - @lazy_property + @property def album(self): - return self.item.get_album() + return self.item._cached_album def _get(self, key): """Get the value for a key, either from the album or the item. @@ -542,6 +542,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() @@ -568,6 +591,8 @@ class Item(LibModel): value = bytestring_path(value) elif isinstance(value, BLOB_TYPE): value = bytes(value) + elif key == 'album_id': + self._cached_album = None changed = super(Item, self)._setitem(key, value) @@ -581,9 +606,8 @@ class Item(LibModel): try: return super(Item, self).__getitem__(key) except KeyError: - album = self.get_album() - if album: - return album[key] + if self._cached_album: + return self._cached_album[key] raise def keys(self, computed=False, with_album=True): @@ -591,10 +615,8 @@ class Item(LibModel): controls whether the album's fields are included. """ keys = super(Item, self).keys(computed=computed) - if with_album: - album = self.get_album() - if album: - keys += album.keys(computed=computed) + if with_album and self._cached_album: + keys += self._cached_album.keys(computed=computed) return keys def get(self, key, default=None, with_album=True): @@ -604,9 +626,8 @@ class Item(LibModel): try: return self._get(key, default, raise_=with_album) except KeyError: - album = self.get_album() - if album: - return album.get(key, default) + if self._cached_album: + return self._cached_album.get(key, default) return default def update(self, values): diff --git a/beetsplug/convert.py b/beetsplug/convert.py index 6ed139da0..c873ec7c1 100644 --- a/beetsplug/convert.py +++ b/beetsplug/convert.py @@ -332,7 +332,7 @@ class ConvertPlugin(BeetsPlugin): item.store() # Store new path and audio data. if self.config['embed']: - album = item.get_album() + album = item._cached_album if album and album.artpath: self._log.debug(u'embedding album art from {}', util.displayable_path(album.artpath)) From dfc23e8efe23d4e9b4092c0cdad0c6eba639bf0f Mon Sep 17 00:00:00 2001 From: FichteFoll Date: Fri, 14 Sep 2018 02:43:38 +0200 Subject: [PATCH 04/26] Implement database and model revision checking Prevents reloading a model from the database when it hasn't changed. Now we're back to almost the same speed as before the addition of album field fallbacks. --- beets/dbcore/db.py | 35 ++++++++++++++++++++++++++++++-- test/test_dbcore.py | 49 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 82 insertions(+), 2 deletions(-) diff --git a/beets/dbcore/db.py b/beets/dbcore/db.py index 5aa418632..3786bbbd2 100755 --- a/beets/dbcore/db.py +++ b/beets/dbcore/db.py @@ -251,6 +251,11 @@ class Model(object): 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. @@ -303,9 +308,11 @@ class Model(object): 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 @@ -533,8 +540,14 @@ 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 = LazyConvertDict(self) @@ -789,6 +802,12 @@ class Transaction(object): """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 @@ -810,12 +829,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=()): @@ -831,7 +853,6 @@ class Transaction(object): """ try: cursor = self.db._connection().execute(statement, subvals) - return cursor.lastrowid except sqlite3.OperationalError as e: # In two specific cases, SQLite reports an error while accessing # the underlying database file. We surface these exceptions as @@ -841,9 +862,14 @@ class Transaction(object): 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) @@ -859,6 +885,11 @@ class Database(object): 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 diff --git a/test/test_dbcore.py b/test/test_dbcore.py index 9bf78de67..c3a8a60ee 100644 --- a/test/test_dbcore.py +++ b/test/test_dbcore.py @@ -224,6 +224,31 @@ class MigrationTest(unittest.TestCase): self.fail("select failed") +class TransactionTest(unittest.TestCase): + def setUp(self): + self.db = DatabaseFixture1(':memory:') + + def tearDown(self): + self.db._connection().close() + + def test_mutate_increase_revision(self): + old_rev = self.db.revision + with self.db.transaction() as tx: + tx.mutate( + 'INSERT INTO {0} ' + '(field_one) ' + 'VALUES (?);'.format(ModelFixture1._table), + (111,), + ) + self.assertGreater(self.db.revision, old_rev) + + def test_query_no_increase_revision(self): + old_rev = self.db.revision + with self.db.transaction() as tx: + tx.query('PRAGMA table_info(%s)' % ModelFixture1._table) + self.assertEqual(self.db.revision, old_rev) + + class ModelTest(unittest.TestCase): def setUp(self): self.db = DatabaseFixture1(':memory:') @@ -245,6 +270,30 @@ class ModelTest(unittest.TestCase): row = self.db._connection().execute('select * from test').fetchone() self.assertEqual(row['field_one'], 123) + def test_revision(self): + old_rev = self.db.revision + model = ModelFixture1() + model.add(self.db) + model.store() + self.assertEqual(model._revision, self.db.revision) + self.assertGreater(self.db.revision, old_rev) + + mid_rev = self.db.revision + model2 = ModelFixture1() + model2.add(self.db) + model2.store() + self.assertGreater(model2._revision, mid_rev) + self.assertGreater(self.db.revision, model._revision) + + # revision changed, so the model should be re-loaded + model.load() + self.assertEqual(model._revision, self.db.revision) + + # revision did not change, so no reload + mod2_old_rev = model2._revision + model2.load() + self.assertEqual(model2._revision, mod2_old_rev) + def test_retrieve_by_id(self): model = ModelFixture1() model.add(self.db) From 26b1aa990e9b9dc5810097437eece16b81fccb0e Mon Sep 17 00:00:00 2001 From: FichteFoll Date: Fri, 14 Sep 2018 02:52:53 +0200 Subject: [PATCH 05/26] Add changelog for #2797 --- docs/changelog.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/changelog.rst b/docs/changelog.rst index e58325482..862074124 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -17,6 +17,11 @@ New features: to MPD commands we don't support yet. Let us know if you find an MPD client that doesn't get along with BPD! :bug:`3214` :bug:`800` +* Fields in queries now fall back to an item's album and check its fields too. + Notably, this allows querying items by an album flex attribute (also in path + configuration). Plugins: Also applies to normal item access. + Thanks to :user:`FichteFoll`. + :bug:`2797` :bug:`2988` Fixes: From ed76da57e53dcc8be96eac8cd5e11f1103f48a9a Mon Sep 17 00:00:00 2001 From: FichteFoll Date: Mon, 17 Sep 2018 23:51:38 +0200 Subject: [PATCH 06/26] Add changelog section for developers --- docs/changelog.rst | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index 862074124..dd1e265c3 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -18,8 +18,8 @@ New features: that doesn't get along with BPD! :bug:`3214` :bug:`800` * Fields in queries now fall back to an item's album and check its fields too. - Notably, this allows querying items by an album flex attribute (also in path - configuration). Plugins: Also applies to normal item access. + Notably, this allows querying items by an album flex attribute, also in path + configuration. Thanks to :user:`FichteFoll`. :bug:`2797` :bug:`2988` @@ -49,6 +49,12 @@ For plugin developers: is almost identical apart from the name change. Again, we'll re-export at the old location (with a deprecation warning) for backwards compatibility, but might stop doing this in a future release. +* Item (and attribute) access on an item now falls back to the album's + attributes as well. If you specifically want to access an item's attributes, + use ``Item.get(key, with_album=False)``. :bug:`2988` +* ``Item.keys`` also has a ``with_album`` argument now, defaulting to ``True``. +* A ``revision`` attribute has been added to ``Database``. It is increased on + every transaction that mutates it. :bug:`2988` For packagers: From 9c35da69bab1c18f3828aa562e97e2a299272629 Mon Sep 17 00:00:00 2001 From: FichteFoll Date: Wed, 5 Jun 2019 02:13:25 +0200 Subject: [PATCH 07/26] Update the items' type information from plugins Plugins can provide item and album attributes. We need to carry over the type information of album attributes so that our item-to-album fallback has these and allows for e.g. range queries. Courtesy of @arcresu (via https://github.com/beetbox/beets/pull/2988#issuecomment-492444925). --- beets/ui/__init__.py | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/beets/ui/__init__.py b/beets/ui/__init__.py index a88ed9aef..d798f5134 100644 --- a/beets/ui/__init__.py +++ b/beets/ui/__init__.py @@ -1146,8 +1146,13 @@ def _setup(options, lib=None): plugins.send("library_opened", lib=lib) # Add types and queries defined by plugins. - library.Item._types.update(plugins.types(library.Item)) - library.Album._types.update(plugins.types(library.Album)) + 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)) From 5c875c50de462b5c92af84efbe1db6f848bfa4bb Mon Sep 17 00:00:00 2001 From: Callum Brown Date: Mon, 21 Sep 2020 20:24:41 +0100 Subject: [PATCH 08/26] AURA: Add aura plugin and docs --- beetsplug/aura.py | 847 +++++++++++++++++++++++++++++++++++++++++ docs/plugins/aura.rst | 195 ++++++++++ docs/plugins/index.rst | 3 + 3 files changed, 1045 insertions(+) create mode 100644 beetsplug/aura.py create mode 100644 docs/plugins/aura.rst diff --git a/beetsplug/aura.py b/beetsplug/aura.py new file mode 100644 index 000000000..4269a4df8 --- /dev/null +++ b/beetsplug/aura.py @@ -0,0 +1,847 @@ +# -*- coding: utf-8 -*- + +# 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 __future__ import division, absolute_import, print_function + +from mimetypes import guess_type +import re +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 displayable_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", + "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.""" + document = { + "errors": [{"status": status, "title": title, "detail": detail}] + } + return make_response(document, status) + + def translate_attribute(self, aura_attr): + """Translate AURA attribute name to beets attribute name.""" + try: + return self.attribute_map[aura_attr] + except KeyError: + # Assume native beets attribute + return aura_attr + + 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\w+)\]") + queries = [] + for key, value in request.args.items(): + match = pattern.match(key) + if match is not None: + # Extract attribute name from key + aura_attr = match.group("attribute") + # Get the beets version of the attribute name + beets_attr = self.translate_attribute(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.""" + # 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.translate_attribute(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.""" + # 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 len(request.args) == 0: + # No existing arguments, so current page is 0 + next_url = request.url + "?page=1" + elif request.args.get("page", None) is 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( + "page={}".format(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. + + :param data: Array of dicts in the form of resource objects + :param include_str: Comma separated list of resources to include + """ + # 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("Invalid resource type: {}".format(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 is not None: + 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 is not None: + document["links"] = {"next": next_url} + # Include related resources for each element in "data" + include_str = request.args.get("include", None) + if include_str is not None: + document["included"] = self.get_included(data, include_str) + return document + + def single_resource_document(self, resource_object): + """Build document for a specific requested resource.""" + document = {"data": resource_object} + include_str = request.args.get("include", None) + if include_str is not None: + # [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.""" + 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.""" + # 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.""" + 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.""" + track = current_app.config["lib"].get_item(track_id) + if track is None: + 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.""" + 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.""" + # filesize is a special field (read from disk not db?) + 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.""" + 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 is not None: + path = displayable_path(album.artpath) + filename = path.split("/")[-1] + image_id = "album-{}-{}".format(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.""" + album = current_app.config["lib"].get_album(album_id) + if album is None: + 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.""" + # 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.""" + 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.""" + # Get tracks where artist field exactly matches artist_id + query = MatchQuery("artist", artist_id) + tracks = current_app.config["lib"].items(query) + if len(tracks) == 0: + 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.""" + artist_resource = self.resource_object(artist_id) + if artist_resource is None: + 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) + + +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. + image_id is 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:]) + + # 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 album is None or album.artpath is None: + 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 = displayable_path(album.artpath) + dir_path = "/".join(artpath.split("/")[:-1]) + else: + # Images for other resource types are not supported + return None + + img_path = 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.""" + # Could be called as a static method, so can't use + # self.get_image_path() + image_path = ImageDocument.get_image_path(image_id) + if image_path is None: + 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.""" + image_resource = self.resource_object(image_id) + if image_resource is None: + 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.""" + 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.""" + track = current_app.config["lib"].get_item(track_id) + if track is None: + 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 = displayable_path(track.destination()) + 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 file_mimetype is None: + return AURADocument.error( + "500 Internal Server Error", + "Requested audio file has an unknown mimetype.", + ( + "The audio file for track {} has an unknown mimetype. " + "It's 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 request.accept_mimetypes.best_match([file_mimetype]) is None: + 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.""" + 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.""" + 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.""" + 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.""" + img_path = ImageDocument.get_image_path(image_id) + if img_path is None: + 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.""" + 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"].get(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): + def __init__(self): + super(AURAPlugin, self).__init__() + self.config.add( + { + "host": u"127.0.0.1", + "port": 8337, + "cors": [], + "cors_supports_credentials": False, + "page_limit": 500, + } + ) + + def commands(self): + def run_aura(lib, opts, args): + """Run the application using Flask's built in-server.""" + 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=u"run an AURA server") + run_aura_cmd.parser.add_option( + u"-d", + u"--debug", + action="store_true", + default=False, + help=u"use Flask debug mode", + ) + run_aura_cmd.func = run_aura + return [run_aura_cmd] diff --git a/docs/plugins/aura.rst b/docs/plugins/aura.rst new file mode 100644 index 000000000..2891d25e1 --- /dev/null +++ b/docs/plugins/aura.rst @@ -0,0 +1,195 @@ +AURA Plugin +=========== + +This plugin is a server implementation of the `AURA`_ specification using the +`Flask`_ framework. AURA is still a work in progress and doesn't yet have a +stable version, but this server should be kept up to date. You are advised to +read the :ref:`aura-issues` section. + +.. _AURA: https://auraspec.readthedocs.io +.. _Flask: https://palletsprojects.com/p/flask/ + +Install +------- + +The ``aura`` plugin depends on `Flask`_, which can be installed using +``python -m pip install flask``. Then you can enable the ``aura`` plugin in +your configuration (see :ref:`using-plugins`). + +It is likely that you will need to enable :ref:`aura-cors`, which introduces +an additional dependency: `flask-cors`_. This can be installed with +``python -m pip install flask-cors``. + +If `Pillow`_ is installed (``python -m pip install Pillow``) then the optional +``width`` and ``height`` attributes are included in image resource objects. + +.. _flask-cors: https://flask-cors.readthedocs.io +.. _Pillow: https://pillow.readthedocs.io + + +Usage +----- + +Use ``beet aura`` to start the AURA server. +By default Flask's built-in server is used, which will give a warning about +using it in a production environment. It is safe to ignore this warning if the +server will have only a few users. + +Alternatively, you can use ``beet aura -d`` to start the server in +`development mode`_, which will reload the server every time the AURA plugin +file is changed. + +You can specify the hostname and port number used by the server in your +:doc:`configuration file `. For more detail see the +:ref:`configuration` section below. + +If you would prefer to use a different WSGI server, such as gunicorn or uWSGI, +then see :ref:`aura-external-server`. + +AURA is designed to separate the client and server functionality. This plugin +provides the server but not the client, so unless you like looking at JSON you +will need a separate client. Unfortunately there are no AURA clients yet +(discounting the broken and outdated reference implementation). + +By default the API is served under http://127.0.0.1:8337/aura/. For example +information about the track with an id of 3 can be obtained at +http://127.0.0.1:8337/aura/tracks/3. + +**Note the absence of a trailing slash**: +http://127.0.0.1:8337/aura/tracks/3/ returns a ``404 Not Found`` error. + +.. _development mode: https://flask.palletsprojects.com/en/1.1.x/server + + +.. _configuration: + +Configuration +------------- + +To configure the plugin, make an ``aura:`` section in your +configuration file. The available options are: + +- **host**: The server hostname. Set this to 0.0.0.0 to bind to all interfaces. + Default: ``127.0.0.1``. +- **port**: The server port. + Default: ``8337``. +- **cors**: A YAML list of origins to allow CORS requests from (see + :ref:`aura-cors`, below). + Default: disabled. +- **cors_supports_credentials**: Allow authenticated requests when using CORS. + Default: disabled. +- **page_limit**: The number of items responses should be truncated to if the + client does not specify. Default ``500``. + + +.. _aura-cors: + +Cross-Origin Resource Sharing (CORS) +------------------------------------ + +`CORS`_ allows browser clients to make requests to the AURA server. You should +set the ``cors`` configuration option to a YAML list of allowed origins. + +For example:: + + aura: + cors: + - http://www.example.com + - https://aura.example.org + +Alternatively you can set it to ``'*'`` to enable access from all origins. +Note that there are security implications if you set the origin to ``'*'``, +so please research this before using it. Note the use of quote marks when +allowing all origins. Quote marks are also required when the origin is +``null``, for example when using ``file:///``. + +If the server is behind a proxy that uses credentials, you might want to set +the ``cors_supports_credentials`` configuration option to true to let +in-browser clients log in. Note that this option has not been tested, so it +may not work. + +.. _CORS: https://en.wikipedia.org/wiki/Cross-origin_resource_sharing + + +.. _aura-external-server: + +Using an External WSGI Server +----------------------------- + +If you would like to use a different WSGI server (not Flask's built-in one), +then you can! The ``beetsplug.aura`` module provides a WSGI callable called +``create_app()`` which can be used by many WSGI servers. + +For example to run the AURA server using `gunicorn`_ use +``gunicorn 'beetsplug.aura:create_app()'``, or for `uWSGI`_ use +``uwsgi --http :9090 --module 'beetsplug.aura:create_app()'``. +Note that these commands just show how to use the AURA app and you would +probably use something a bit different in a production environment. Read the +relevant server's documentation to figure out what you need. + +.. _gunicorn: https://gunicorn.org +.. _uWSGI: https://uwsgi-docs.readthedocs.io + + +Reverse Proxy Support +--------------------- + +The plugin should work behind a reverse proxy without further configuration, +however this has not been tested extensively. For details of what headers must +be rewritten and a sample NGINX configuration see `Flask proxy setups`_. + +It may be possibly to run the application under a URL prefix (for example so +you could have ``/foo/aura/server`` rather than ``/aura/server``), but it is +likely this would require changes in the code. + +Do not add a trailing slash (``/``) to the URL where the application is +running, otherwise you will get a 404. For example with NGINX you should use +``proxy_pass http://127.0.0.1:8000;`` rather than +``proxy_pass http://127.0.0.1:8000/;``. + +.. _Flask proxy setups: https://flask.palletsprojects.com/en/1.1.x/deploying/wsgi-standalone/#proxy-setups + + +.. _aura-issues: + +Issues +------ + +As of writing there are some differences between the specification and this +implementation: + +- Compound filters are not specified in AURA, but this server interprets + multiple ``filter`` parameters as AND. See `issue #19`_ for discussion. +- The ``bitrate`` parameter used for content negotiation is not supported. + Adding support for this is doable, but the way Flask handles acceptable MIME + types means it's a lot easier not to bother with it. This means an error + could be returned even if no transcoding was required. + +It is possible that some attributes required by AURA could be absent from the +server's response if beets does not have a saved value for them. However, this +has not happened so far. + +The ``mimetype`` and ``framecount`` attributes for track resources are not +supported. The first is due to beets storing the file type (e.g. ``MP3``), so +it is hard to filter by MIME type. The second is because there is no +corresponding beets field. + +Artists are defined by the ``artist`` field on beets Items, which means some +albums have no ``artists`` relationship. Albums only have related artists +when their beets ``albumartist`` field is the same as the ``artist`` field on +at least one of it's constituent tracks. + +The only art tracked by beets is a single cover image, so only albums have +related images at the moment. This could be expanded to looking in the same +directory for other images, and relating tracks to their album's image. + +There are likely to be some performance issues, especially with larger +libraries. Pagination and inclusion (most notably of images) are probably two +of the main offenders. On a related note, the program attempts to import Pillow +every time it constructs an image resource object, which is not very good. + +The beets library is accessed using a so called private function (with a single +leading underscore) ``beets.ui.__init__._open_library()``. This shouldn't cause +any issues but it is probably not best practice. + +.. _issue #19: https://github.com/beetbox/aura/issues/19 diff --git a/docs/plugins/index.rst b/docs/plugins/index.rst index aab922fcd..e28e2a2cf 100644 --- a/docs/plugins/index.rst +++ b/docs/plugins/index.rst @@ -61,6 +61,7 @@ following to your configuration:: absubmit acousticbrainz + aura badfiles beatport bpd @@ -184,6 +185,7 @@ Path Formats Interoperability ---------------- +* :doc:`aura`: A server implementation of the `AURA`_ specification. * :doc:`badfiles`: Check audio file integrity. * :doc:`embyupdate`: Automatically notifies `Emby`_ whenever the beets library changes. * :doc:`fish`: Adds `Fish shell`_ tab autocompletion to ``beet`` commands. @@ -205,6 +207,7 @@ Interoperability library changes. +.. _AURA: https://auraspec.readthedocs.io .. _Emby: https://emby.media .. _Fish shell: https://fishshell.com/ .. _Plex: https://plex.tv From 51c3f310e91afb275de818d8f63c0563aef9a174 Mon Sep 17 00:00:00 2001 From: Callum Brown Date: Sun, 27 Sep 2020 18:09:16 +0100 Subject: [PATCH 09/26] AURA: Fix docstrings for tox -e lint --- beetsplug/aura.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/beetsplug/aura.py b/beetsplug/aura.py index 4269a4df8..8050cc621 100644 --- a/beetsplug/aura.py +++ b/beetsplug/aura.py @@ -14,8 +14,7 @@ # 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. -""" +"""An AURA server using Flask.""" from __future__ import division, absolute_import, print_function @@ -811,7 +810,10 @@ def create_app(): class AURAPlugin(BeetsPlugin): + """The BeetsPlugin subclass for the AURA server plugin.""" + def __init__(self): + """Add configuration options for the AURA plugin.""" super(AURAPlugin, self).__init__() self.config.add( { @@ -824,6 +826,8 @@ class AURAPlugin(BeetsPlugin): ) 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.""" app = create_app() From e8aa96ef72edd8e9a8ff3f0967fd0d0c1caabb8e Mon Sep 17 00:00:00 2001 From: Callum Brown Date: Sun, 27 Sep 2020 18:58:39 +0100 Subject: [PATCH 10/26] AURA: Add argument info to docstrings Follows the google docstring style: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings --- beetsplug/aura.py | 188 ++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 157 insertions(+), 31 deletions(-) diff --git a/beetsplug/aura.py b/beetsplug/aura.py index 8050cc621..f62dc2987 100644 --- a/beetsplug/aura.py +++ b/beetsplug/aura.py @@ -125,14 +125,25 @@ class AURADocument: @staticmethod def error(status, title, detail): - """Make a response for an error following the JSON:API spec.""" + """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_attribute(self, aura_attr): - """Translate AURA attribute name to beets attribute name.""" + """Translate AURA attribute name to beets attribute name. + + Args: + aura_attr: The attribute name to convert, e.g. "title". + """ try: return self.attribute_map[aura_attr] except KeyError: @@ -161,7 +172,13 @@ class AURADocument: return AndQuery(queries) def translate_sorts(self, sort_arg): - """Translate an AURA sort parameter into a beets Sort.""" + """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 = [] @@ -180,7 +197,13 @@ class AURADocument: return MultipleSort(sorts) def paginate(self, collection): - """Get a page of the collection and the URL to the next page.""" + """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. @@ -213,8 +236,10 @@ class AURADocument: def get_included(self, data, include_str): """Build a list of resource objects for inclusion. - :param data: Array of dicts in the form of resource objects - :param include_str: Comma separated list of resources to include + 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(",") @@ -287,7 +312,12 @@ class AURADocument: return document def single_resource_document(self, resource_object): - """Build document for a specific requested resource.""" + """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 is not None: @@ -304,11 +334,20 @@ class TrackDocument(AURADocument): attribute_map = TRACK_ATTR_MAP def get_collection(self, query=None, sort=None): - """Get Item objects from the library.""" + """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.""" + """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 @@ -325,7 +364,11 @@ class TrackDocument(AURADocument): @staticmethod def resource_object(track): - """Construct a JSON:API resource object from a beets Item.""" + """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(): @@ -353,7 +396,11 @@ class TrackDocument(AURADocument): } def single_resource(self, track_id): - """Get track from the library and build a document.""" + """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 track is None: return self.error( @@ -372,12 +419,20 @@ class AlbumDocument(AURADocument): attribute_map = ALBUM_ATTR_MAP def get_collection(self, query=None, sort=None): - """Get Album objects from the library.""" + """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.""" - # filesize is a special field (read from disk not db?) + """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. @@ -390,7 +445,11 @@ class AlbumDocument(AURADocument): @staticmethod def resource_object(album): - """Construct a JSON:API resource object from a beets 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(): @@ -435,7 +494,11 @@ class AlbumDocument(AURADocument): } def single_resource(self, album_id): - """Get album from the library and build a document.""" + """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 album is None: return self.error( @@ -454,7 +517,12 @@ class ArtistDocument(AURADocument): attribute_map = ARTIST_ATTR_MAP def get_collection(self, query=None, sort=None): - """Get a list of artist names from the library.""" + """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 = [] @@ -465,7 +533,11 @@ class ArtistDocument(AURADocument): return collection def get_attribute_converter(self, beets_attr): - """Work out what data type an attribute should be for beets.""" + """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. @@ -478,7 +550,11 @@ class ArtistDocument(AURADocument): @staticmethod def resource_object(artist_id): - """Construct a JSON:API resource object for the given artist.""" + """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) @@ -517,7 +593,11 @@ class ArtistDocument(AURADocument): } def single_resource(self, artist_id): - """Get info for the requested artist and build a document.""" + """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 artist_resource is None: return self.error( @@ -538,7 +618,10 @@ class ImageDocument(AURADocument): """Works out the full path to the image with the given id. Returns None if there is no such image. - image_id is in the form -- + + Args: + image_id: A string in the form + "--". """ # Split image_id into its constituent parts id_split = image_id.split("-") @@ -572,7 +655,12 @@ class ImageDocument(AURADocument): @staticmethod def resource_object(image_id): - """Construct a JSON:API resource object for the given image.""" + """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) @@ -609,7 +697,12 @@ class ImageDocument(AURADocument): } def single_resource(self, image_id): - """Get info for the requested image and build a document.""" + """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 image_resource is None: return self.error( @@ -644,14 +737,22 @@ def all_tracks(): @aura_bp.route("/tracks/") def single_track(track_id): - """Respond with info about the specified track.""" + """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") +@aura_bp.route("/tracks//audio") def audio_file(track_id): - """Supply an audio file for the specified track.""" + """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 track is None: return AURADocument.error( @@ -720,7 +821,11 @@ def all_albums(): @aura_bp.route("/albums/") def single_album(album_id): - """Respond with info about the specified album.""" + """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) @@ -739,7 +844,12 @@ def all_artists(): # 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.""" + """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) @@ -751,14 +861,24 @@ def single_artist(artist_id): @aura_bp.route("/images/") def single_image(image_id): - """Respond with info about the specified image.""" + """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.""" + """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 img_path is None: return AURADocument.error( @@ -829,7 +949,13 @@ class AURAPlugin(BeetsPlugin): """Add subcommand used to run the AURA server.""" def run_aura(lib, opts, args): - """Run the application using Flask's built in-server.""" + """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( From e067298224fa983b0bf957bbb8595c9746f7f7ae Mon Sep 17 00:00:00 2001 From: Callum Brown Date: Wed, 28 Oct 2020 18:53:39 +0000 Subject: [PATCH 11/26] Add default config values in create_app() So if not run through beet aura then default values will be available --- beetsplug/aura.py | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/beetsplug/aura.py b/beetsplug/aura.py index f62dc2987..6cc965b21 100644 --- a/beetsplug/aura.py +++ b/beetsplug/aura.py @@ -896,6 +896,16 @@ def image_file(image_id): def create_app(): """An application factory for use by a WSGI server.""" + config["aura"].add( + { + "host": u"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") @@ -935,15 +945,6 @@ class AURAPlugin(BeetsPlugin): def __init__(self): """Add configuration options for the AURA plugin.""" super(AURAPlugin, self).__init__() - self.config.add( - { - "host": u"127.0.0.1", - "port": 8337, - "cors": [], - "cors_supports_credentials": False, - "page_limit": 500, - } - ) def commands(self): """Add subcommand used to run the AURA server.""" From 72c041255244b8fc767f30079ae643a881e4e618 Mon Sep 17 00:00:00 2001 From: Callum Brown Date: Fri, 30 Oct 2020 12:27:22 +0000 Subject: [PATCH 12/26] AURA: Small updates to documentation --- docs/plugins/aura.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/plugins/aura.rst b/docs/plugins/aura.rst index 2891d25e1..1cadb45db 100644 --- a/docs/plugins/aura.rst +++ b/docs/plugins/aura.rst @@ -69,8 +69,8 @@ Configuration To configure the plugin, make an ``aura:`` section in your configuration file. The available options are: -- **host**: The server hostname. Set this to 0.0.0.0 to bind to all interfaces. - Default: ``127.0.0.1``. +- **host**: The server hostname. Set this to ``0.0.0.0`` to bind to all + interfaces. Default: ``127.0.0.1``. - **port**: The server port. Default: ``8337``. - **cors**: A YAML list of origins to allow CORS requests from (see @@ -122,7 +122,7 @@ then you can! The ``beetsplug.aura`` module provides a WSGI callable called For example to run the AURA server using `gunicorn`_ use ``gunicorn 'beetsplug.aura:create_app()'``, or for `uWSGI`_ use -``uwsgi --http :9090 --module 'beetsplug.aura:create_app()'``. +``uwsgi --http :8337 --module 'beetsplug.aura:create_app()'``. Note that these commands just show how to use the AURA app and you would probably use something a bit different in a production environment. Read the relevant server's documentation to figure out what you need. @@ -144,8 +144,8 @@ likely this would require changes in the code. Do not add a trailing slash (``/``) to the URL where the application is running, otherwise you will get a 404. For example with NGINX you should use -``proxy_pass http://127.0.0.1:8000;`` rather than -``proxy_pass http://127.0.0.1:8000/;``. +``proxy_pass http://127.0.0.1:8337;`` rather than +``proxy_pass http://127.0.0.1:8337/;``. .. _Flask proxy setups: https://flask.palletsprojects.com/en/1.1.x/deploying/wsgi-standalone/#proxy-setups @@ -184,9 +184,9 @@ related images at the moment. This could be expanded to looking in the same directory for other images, and relating tracks to their album's image. There are likely to be some performance issues, especially with larger -libraries. Pagination and inclusion (most notably of images) are probably two -of the main offenders. On a related note, the program attempts to import Pillow -every time it constructs an image resource object, which is not very good. +libraries. Sorting, pagination and inclusion (most notably of images) are +probably the main offenders. On a related note, the program attempts to import +Pillow every time it constructs an image resource object, which is not good. The beets library is accessed using a so called private function (with a single leading underscore) ``beets.ui.__init__._open_library()``. This shouldn't cause From 2d024d2f38fcc8ac7a134ec290cb6a6b9f3b5ca4 Mon Sep 17 00:00:00 2001 From: FichteFoll Date: Mon, 2 Nov 2020 01:06:05 +0100 Subject: [PATCH 13/26] Avoid overeager inclusion of album attributes Co-Authored-By: Curtis Rueden --- beets/dbcore/db.py | 5 +++-- beets/library.py | 3 ++- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/beets/dbcore/db.py b/beets/dbcore/db.py index 524ee0b00..409ecc9af 100755 --- a/beets/dbcore/db.py +++ b/beets/dbcore/db.py @@ -56,10 +56,11 @@ class FormattedMapping(Mapping): are replaced. """ - def __init__(self, model, for_path=False): + def __init__(self, model, for_path=False, compute_keys=True): self.for_path = for_path self.model = model - self.model_keys = model.keys(True) + if compute_keys: + self.model_keys = model.keys(True) def __getitem__(self, key): if key in self.model_keys: diff --git a/beets/library.py b/beets/library.py index 5e6a0ec8a..f9b5a2ab4 100644 --- a/beets/library.py +++ b/beets/library.py @@ -375,9 +375,10 @@ class FormattedItemMapping(dbcore.db.FormattedMapping): """ def __init__(self, item, for_path=False): - super(FormattedItemMapping, self).__init__(item, for_path) # We treat album and item keys specially here, # so exclude transitive album keys from the model's keys. + super(FormattedItemMapping, self).__init__(item, for_path, + compute_keys=False) self.model_keys = item.keys(computed=True, with_album=False) self.item = item From c2a92fdbf8849fdd558afb8c5df9c5f13d94333c Mon Sep 17 00:00:00 2001 From: Callum Brown Date: Sat, 21 Nov 2020 18:40:44 +0000 Subject: [PATCH 14/26] AURA: Update reverse proxy docs --- docs/plugins/aura.rst | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/plugins/aura.rst b/docs/plugins/aura.rst index 1cadb45db..7af8b19e6 100644 --- a/docs/plugins/aura.rst +++ b/docs/plugins/aura.rst @@ -138,14 +138,13 @@ The plugin should work behind a reverse proxy without further configuration, however this has not been tested extensively. For details of what headers must be rewritten and a sample NGINX configuration see `Flask proxy setups`_. -It may be possibly to run the application under a URL prefix (for example so -you could have ``/foo/aura/server`` rather than ``/aura/server``), but it is -likely this would require changes in the code. +It is (reportedly) possible to run the application under a URL prefix (for +example so you could have ``/foo/aura/server`` rather than ``/aura/server``), +but you'll have to work it out for yourself :-) -Do not add a trailing slash (``/``) to the URL where the application is -running, otherwise you will get a 404. For example with NGINX you should use -``proxy_pass http://127.0.0.1:8337;`` rather than -``proxy_pass http://127.0.0.1:8337/;``. +If using NGINX, do **not** add a trailing slash (``/``) to the URL where the +application is running, otherwise you will get a 404. However if you are using +Apache then you **should** add a trailing slash. .. _Flask proxy setups: https://flask.palletsprojects.com/en/1.1.x/deploying/wsgi-standalone/#proxy-setups From 7e819d2a2eb06c7142622b29109c7593dbcbe90a Mon Sep 17 00:00:00 2001 From: Callum Brown Date: Sat, 6 Mar 2021 12:01:02 +0000 Subject: [PATCH 15/26] AURA: Update artist-mbid attribute to use '-' --- beetsplug/aura.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/beetsplug/aura.py b/beetsplug/aura.py index 6cc965b21..60507b78f 100644 --- a/beetsplug/aura.py +++ b/beetsplug/aura.py @@ -116,7 +116,7 @@ ARTIST_ATTR_MAP = { # Required "name": "artist", # Optional - "artist_mbid": "mb_artistid", + "artist-mbid": "mb_artistid", } From b1baeb37f1d3e563b5de6f0f8ea068768fa4d797 Mon Sep 17 00:00:00 2001 From: Callum Brown Date: Sat, 6 Mar 2021 12:08:35 +0000 Subject: [PATCH 16/26] AURA: replace translate_attribute with a dict.get --- beetsplug/aura.py | 16 ++-------------- 1 file changed, 2 insertions(+), 14 deletions(-) diff --git a/beetsplug/aura.py b/beetsplug/aura.py index 60507b78f..536448d58 100644 --- a/beetsplug/aura.py +++ b/beetsplug/aura.py @@ -138,18 +138,6 @@ class AURADocument: } return make_response(document, status) - def translate_attribute(self, aura_attr): - """Translate AURA attribute name to beets attribute name. - - Args: - aura_attr: The attribute name to convert, e.g. "title". - """ - try: - return self.attribute_map[aura_attr] - except KeyError: - # Assume native beets attribute - return aura_attr - def translate_filters(self): """Translate filters from request arguments to a beets Query.""" # The format of each filter key in the request parameter is: @@ -162,7 +150,7 @@ class AURADocument: # Extract attribute name from key aura_attr = match.group("attribute") # Get the beets version of the attribute name - beets_attr = self.translate_attribute(aura_attr) + 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 @@ -191,7 +179,7 @@ class AURADocument: # JSON:API default ascending = True # Get the beets version of the attribute name - beets_attr = self.translate_attribute(aura_attr) + 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) From 07cfaaa3b378afa1f8be43a91ebccad29e1650e2 Mon Sep 17 00:00:00 2001 From: Callum Brown Date: Sat, 6 Mar 2021 12:25:33 +0000 Subject: [PATCH 17/26] AURA: Simplify if statements Get rid of ` is not None` Change `len(x) == 0` to `not x` Change `x is None` to `not x` --- beetsplug/aura.py | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/beetsplug/aura.py b/beetsplug/aura.py index 536448d58..5a949dcf6 100644 --- a/beetsplug/aura.py +++ b/beetsplug/aura.py @@ -146,7 +146,7 @@ class AURADocument: queries = [] for key, value in request.args.items(): match = pattern.match(key) - if match is not None: + if match: # Extract attribute name from key aura_attr = match.group("attribute") # Get the beets version of the attribute name @@ -206,10 +206,10 @@ class AURADocument: next_url = None else: # Not the last page so work out links.next url - if len(request.args) == 0: + if not request.args: # No existing arguments, so current page is 0 next_url = request.url + "?page=1" - elif request.args.get("page", None) is None: + elif not request.args.get("page", None): # No existing page argument, so add one to the end next_url = request.url + "&page=1" else: @@ -272,7 +272,7 @@ class AURADocument: """Build document for /tracks, /albums or /artists.""" query = self.translate_filters() sort_arg = request.args.get("sort", None) - if sort_arg is not 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. @@ -291,11 +291,11 @@ class AURADocument: data, next_url = self.paginate(collection) document = {"data": data} # If there are more pages then provide a way to access them - if next_url is not None: + 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 is not None: + if include_str: document["included"] = self.get_included(data, include_str) return document @@ -308,7 +308,7 @@ class AURADocument: """ document = {"data": resource_object} include_str = request.args.get("include", None) - if include_str is not None: + if include_str: # [document["data"]] is because arg needs to be list document["included"] = self.get_included( [document["data"]], include_str @@ -390,7 +390,7 @@ class TrackDocument(AURADocument): track_id: The beets id of the track (integer). """ track = current_app.config["lib"].get_item(track_id) - if track is None: + if not track: return self.error( "404 Not Found", "No track with the requested id.", @@ -459,7 +459,7 @@ class AlbumDocument(AURADocument): } } # Add images relationship if album has associated images - if album.artpath is not None: + if album.artpath: path = displayable_path(album.artpath) filename = path.split("/")[-1] image_id = "album-{}-{}".format(album.id, filename) @@ -488,7 +488,7 @@ class AlbumDocument(AURADocument): album_id: The beets id of the album (integer). """ album = current_app.config["lib"].get_album(album_id) - if album is None: + if not album: return self.error( "404 Not Found", "No album with the requested id.", @@ -546,7 +546,7 @@ class ArtistDocument(AURADocument): # Get tracks where artist field exactly matches artist_id query = MatchQuery("artist", artist_id) tracks = current_app.config["lib"].items(query) - if len(tracks) == 0: + if not tracks: return None # Get artist information from the first track @@ -587,7 +587,7 @@ class ArtistDocument(AURADocument): artist_id: A string which is the artist's name. """ artist_resource = self.resource_object(artist_id) - if artist_resource is None: + if not artist_resource: return self.error( "404 Not Found", "No artist with the requested id.", @@ -623,7 +623,7 @@ class ImageDocument(AURADocument): # 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 album is None or album.artpath is None: + 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 @@ -652,7 +652,7 @@ class ImageDocument(AURADocument): # Could be called as a static method, so can't use # self.get_image_path() image_path = ImageDocument.get_image_path(image_id) - if image_path is None: + if not image_path: return None attributes = { @@ -692,7 +692,7 @@ class ImageDocument(AURADocument): "--". """ image_resource = self.resource_object(image_id) - if image_resource is None: + if not image_resource: return self.error( "404 Not Found", "No image with the requested id.", @@ -742,7 +742,7 @@ def audio_file(track_id): track_id: The id of the track provided in the URL (integer). """ track = current_app.config["lib"].get_item(track_id) - if track is None: + if not track: return AURADocument.error( "404 Not Found", "No track with the requested id.", @@ -762,7 +762,7 @@ def audio_file(track_id): ) file_mimetype = guess_type(path)[0] - if file_mimetype is None: + if not file_mimetype: return AURADocument.error( "500 Internal Server Error", "Requested audio file has an unknown mimetype.", @@ -777,7 +777,7 @@ def audio_file(track_id): # 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 request.accept_mimetypes.best_match([file_mimetype]) is None: + if not request.accept_mimetypes.best_match([file_mimetype]): return AURADocument.error( "406 Not Acceptable", "Unsupported MIME type or bitrate parameter in Accept header.", @@ -868,7 +868,7 @@ def image_file(image_id): the form "--". """ img_path = ImageDocument.get_image_path(image_id) - if img_path is None: + if not img_path: return AURADocument.error( "404 Not Found", "No image with the requested id.", From fbc76887ad11d67c7a0262f8626c094eca62ff4b Mon Sep 17 00:00:00 2001 From: Callum Brown Date: Sat, 6 Mar 2021 13:22:28 +0000 Subject: [PATCH 18/26] AURA: Fix styling when formatting error strings --- beetsplug/aura.py | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/beetsplug/aura.py b/beetsplug/aura.py index 5a949dcf6..8980885fd 100644 --- a/beetsplug/aura.py +++ b/beetsplug/aura.py @@ -394,7 +394,7 @@ class TrackDocument(AURADocument): return self.error( "404 Not Found", "No track with the requested id.", - ("There is no track with an id of {} in the library.").format( + "There is no track with an id of {} in the library.".format( track_id ), ) @@ -492,7 +492,7 @@ class AlbumDocument(AURADocument): return self.error( "404 Not Found", "No album with the requested id.", - ("There is no album with an id of {} in the library.").format( + "There is no album with an id of {} in the library.".format( album_id ), ) @@ -591,7 +591,7 @@ class ArtistDocument(AURADocument): return self.error( "404 Not Found", "No artist with the requested id.", - ("There is no artist with an id of {} in the library.").format( + "There is no artist with an id of {} in the library.".format( artist_id ), ) @@ -696,7 +696,7 @@ class ImageDocument(AURADocument): return self.error( "404 Not Found", "No image with the requested id.", - ("There is no image with an id of {} in the library.").format( + "There is no image with an id of {} in the library.".format( image_id ), ) @@ -746,7 +746,7 @@ def audio_file(track_id): return AURADocument.error( "404 Not Found", "No track with the requested id.", - ("There is no track with an id of {} in the library.").format( + "There is no track with an id of {} in the library.".format( track_id ), ) @@ -768,7 +768,7 @@ def audio_file(track_id): "Requested audio file has an unknown mimetype.", ( "The audio file for track {} has an unknown mimetype. " - "It's file extension is {}." + "Its file extension is {}." ).format(track_id, path.split(".")[-1]), ) @@ -872,7 +872,7 @@ def image_file(image_id): return AURADocument.error( "404 Not Found", "No image with the requested id.", - ("There is no image with an id of {} in the library").format( + "There is no image with an id of {} in the library".format( image_id ), ) From 2fe2f4f31eb2ca70128e4739bb849847c1bebea4 Mon Sep 17 00:00:00 2001 From: Callum Brown Date: Sat, 6 Mar 2021 13:30:31 +0000 Subject: [PATCH 19/26] AURA: Ensure CORS allowed origins are strings --- beetsplug/aura.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/beetsplug/aura.py b/beetsplug/aura.py index 8980885fd..201e099e3 100644 --- a/beetsplug/aura.py +++ b/beetsplug/aura.py @@ -909,7 +909,7 @@ def create_app(): app.config["lib"] = _open_library(config) # Enable CORS if required - cors = config["aura"]["cors"].get(list) + cors = config["aura"]["cors"].as_str_seq(list) if cors: from flask_cors import CORS From 477eed3b25c8983b77e59f259891dd536289a378 Mon Sep 17 00:00:00 2001 From: Callum Brown Date: Sun, 7 Mar 2021 10:25:20 +0000 Subject: [PATCH 20/26] AURA: Use py3_path rather than displayable_path displayable_path may remove 'bad' characters, yielding a wrong path. Also use track.path rather than track.destination() as that is where the file is actually located rather than where it should be located according to the beets path system. --- beetsplug/aura.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/beetsplug/aura.py b/beetsplug/aura.py index 201e099e3..f3f8980ae 100644 --- a/beetsplug/aura.py +++ b/beetsplug/aura.py @@ -25,7 +25,7 @@ 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 displayable_path +from beets.util import py3_path from beets.library import Item, Album from beets.dbcore.query import ( MatchQuery, @@ -460,7 +460,7 @@ class AlbumDocument(AURADocument): } # Add images relationship if album has associated images if album.artpath: - path = displayable_path(album.artpath) + path = py3_path(album.artpath) filename = path.split("/")[-1] image_id = "album-{}-{}".format(album.id, filename) relationships["images"] = { @@ -628,7 +628,7 @@ class ImageDocument(AURADocument): # Cut the filename off of artpath # This is in preparation for supporting images in the same # directory that are not tracked by beets. - artpath = displayable_path(album.artpath) + artpath = py3_path(album.artpath) dir_path = "/".join(artpath.split("/")[:-1]) else: # Images for other resource types are not supported @@ -751,7 +751,7 @@ def audio_file(track_id): ), ) - path = displayable_path(track.destination()) + path = py3_path(track.path) if not isfile(path): return AURADocument.error( "404 Not Found", From a54ee43d57a2b3b6913bb8827b3fda8b63449d61 Mon Sep 17 00:00:00 2001 From: Callum Brown Date: Sun, 7 Mar 2021 14:23:17 +0000 Subject: [PATCH 21/26] AURA: Allow '-' character in filter attribute --- beetsplug/aura.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/beetsplug/aura.py b/beetsplug/aura.py index f3f8980ae..f0cda3688 100644 --- a/beetsplug/aura.py +++ b/beetsplug/aura.py @@ -142,7 +142,7 @@ class AURADocument: """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\w+)\]") + pattern = re.compile(r"filter\[(?P[a-zA-Z0-9_-]+)\]") queries = [] for key, value in request.args.items(): match = pattern.match(key) From a24a094562960b952edff464406e26e50d436421 Mon Sep 17 00:00:00 2001 From: Callum Brown Date: Sun, 7 Mar 2021 18:24:57 +0000 Subject: [PATCH 22/26] AURA: Small updates to docs and set server version --- beetsplug/aura.py | 2 +- docs/changelog.rst | 1 + docs/plugins/aura.rst | 8 ++++++-- 3 files changed, 8 insertions(+), 3 deletions(-) diff --git a/beetsplug/aura.py b/beetsplug/aura.py index f0cda3688..df76ca856 100644 --- a/beetsplug/aura.py +++ b/beetsplug/aura.py @@ -54,7 +54,7 @@ from flask import ( SERVER_INFO = { "aura-version": "0", "server": "beets-aura", - "server-version": "0", + "server-version": "0.1", "auth-required": False, "features": ["albums", "artists", "images"], } diff --git a/docs/changelog.rst b/docs/changelog.rst index 2f31ecfe3..090c5b6f7 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -183,6 +183,7 @@ New features: * Added ``trackdisambig`` which stores the recording disambiguation from MusicBrainz for each track. :bug:`1904` +* The :doc:`/plugins/aura` has arrived! Fixes: diff --git a/docs/plugins/aura.rst b/docs/plugins/aura.rst index 7af8b19e6..83c186249 100644 --- a/docs/plugins/aura.rst +++ b/docs/plugins/aura.rst @@ -48,8 +48,7 @@ then see :ref:`aura-external-server`. AURA is designed to separate the client and server functionality. This plugin provides the server but not the client, so unless you like looking at JSON you -will need a separate client. Unfortunately there are no AURA clients yet -(discounting the broken and outdated reference implementation). +will need a separate client. Currently the only client is `AURA Web Client`_. By default the API is served under http://127.0.0.1:8337/aura/. For example information about the track with an id of 3 can be obtained at @@ -59,6 +58,7 @@ http://127.0.0.1:8337/aura/tracks/3. http://127.0.0.1:8337/aura/tracks/3/ returns a ``404 Not Found`` error. .. _development mode: https://flask.palletsprojects.com/en/1.1.x/server +.. _AURA Web Client: https://sr.ht/~callum/aura-web-client/ .. _configuration: @@ -168,6 +168,10 @@ It is possible that some attributes required by AURA could be absent from the server's response if beets does not have a saved value for them. However, this has not happened so far. +Beets fields (including flexible fields) that do not have an AURA equivalent +are not provided in any resource's attributes section, however these fields may +be used for filtering. + The ``mimetype`` and ``framecount`` attributes for track resources are not supported. The first is due to beets storing the file type (e.g. ``MP3``), so it is hard to filter by MIME type. The second is because there is no From 3d1b421b97d6357648e8f8147bfe7372141a0e0b Mon Sep 17 00:00:00 2001 From: Adrian Sampson Date: Sun, 7 Mar 2021 19:50:31 -0500 Subject: [PATCH 23/26] Cursory changelog summary --- docs/changelog.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/changelog.rst b/docs/changelog.rst index df286a10a..251328ea6 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -4,6 +4,14 @@ Changelog 1.5.0 (in development) ---------------------- +This long overdue release of beets includes far too many exciting and useful +features than could ever be satisfactorily enumerated. +As a technical detail, it also introduces two new external libraries: +`MediaFile`_ and `Confuse`_ used to be part of beets but are now reusable +dependencies---packagers, please take note. +Finally, this is the last version of beets where we intend to support Python +2.x; future releases will soon require Python 3.5. + New features: * :doc:`/plugins/mpdstats`: Add strip_path option to help build the right local path From 39e597240728e83af43e1aecdc686debd232f8e5 Mon Sep 17 00:00:00 2001 From: Adrian Sampson Date: Sun, 7 Mar 2021 19:54:42 -0500 Subject: [PATCH 24/26] A little changelog editing --- docs/changelog.rst | 27 +++++++++++++++++---------- 1 file changed, 17 insertions(+), 10 deletions(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index 251328ea6..7e6509e05 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -14,18 +14,22 @@ Finally, this is the last version of beets where we intend to support Python New features: -* :doc:`/plugins/mpdstats`: Add strip_path option to help build the right local path - from MPD information -* Submitting acoustID information on tracks which already have a fingerprint - :bug:`3834` -* conversion uses par_map to parallelize conversion jobs in python3 -* Add ``title_case`` config option to lastgenre to make TitleCasing optional. -* When config is printed with no available configuration a new message is printed. +* :doc:`/plugins/mpdstats`: Add a new `strip_path` option to help build the + right local path from MPD information. +* :doc:`/plugins/convert`: Conversion can now parallelize conversion jobs on + Python 3. +* :doc:`/plugins/lastgenre`: Add a new `title_case` config option to make + title-case formatting optional. +* There's a new message when running ``beet config`` when there's no available + configuration file. :bug:`3779` -* When importing a duplicate album it ask if it should "Keep all" instead of "Keep both". +* When importing a duplicate album, the prompt now says "keep all" instead of + "keep both" to reflect that there may be more than two albums involved. :bug:`3569` -* :doc:`/plugins/chroma`: Update file metadata after generating fingerprints through the `submit` command. -* :doc:`/plugins/lastgenre`: Added more heavy metal genres: https://en.wikipedia.org/wiki/Heavy_metal_genres to genres.txt and genres-tree.yaml +* :doc:`/plugins/chroma`: The plugin now updates file metadata after + generating fingerprints through the `submit` command. +* :doc:`/plugins/lastgenre`: Added more heavy metal genres to the built-in + genre filter lists. * :doc:`/plugins/subsonicplaylist`: import playlist from a subsonic server. * :doc:`/plugins/subsonicupdate`: Automatically choose between token and password-based authentication based on server version @@ -323,6 +327,9 @@ Fixes: information. Thanks to :user:`dosoe`. * :doc:`/plugins/discogs`: Replace deprecated discogs-client library with community supported python3-discogs-client library. :bug:`3608` +* :doc:`/plugins/chroma`: Fixed submitting AcoustID information for tracks + that already have a fingerprint. + :bug:`3834` For plugin developers: From 8cf46bce6d6448331365d04e73c583ad1f063e75 Mon Sep 17 00:00:00 2001 From: Adrian Sampson Date: Sun, 7 Mar 2021 21:14:53 -0500 Subject: [PATCH 25/26] A little more changelog stuff --- docs/changelog.rst | 55 +++++++++++++++++++++++++--------------------- 1 file changed, 30 insertions(+), 25 deletions(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index 7e6509e05..48179bd72 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -12,7 +12,20 @@ dependencies---packagers, please take note. Finally, this is the last version of beets where we intend to support Python 2.x; future releases will soon require Python 3.5. -New features: +Major new features: + +* A new :ref:`reflink` config option instructs the importer to create fast, + copy-on-write file clones on filesystems that support them. Thanks to + :user:`rubdos`. +* A new :doc:`/plugins/unimported` lets you find untracked files in your + library directory. +* We now fetch information about `works`_ from MusicBrainz. + MusicBrainz matches provide the fields ``work`` (the title), ``mb_workid`` + (the MBID), and ``work_disambig`` (the disambiguation string). + Thanks to :user:`dosoe`. + :bug:`2580` :bug:`3272` + +Other new things: * :doc:`/plugins/mpdstats`: Add a new `strip_path` option to help build the right local path from MPD information. @@ -30,15 +43,13 @@ New features: generating fingerprints through the `submit` command. * :doc:`/plugins/lastgenre`: Added more heavy metal genres to the built-in genre filter lists. -* :doc:`/plugins/subsonicplaylist`: import playlist from a subsonic server. -* :doc:`/plugins/subsonicupdate`: Automatically choose between token and - password-based authentication based on server version -* A new :ref:`reflink` config option instructs the importer to create fast, - copy-on-write file clones on filesystems that support them. Thanks to - :user:`rubdos`. +* A new :doc:`/plugins/subsonicplaylist` can import playlists from a Subsonic + server. +* :doc:`/plugins/subsonicupdate`: The plugin now automatically chooses between + token and password-based authentication based on server version * A new :ref:`extra_tags` configuration option allows more tagged metadata to be included in MusicBrainz queries. -* A new :doc:`/plugins/fish` adds `Fish shell`_ tab autocompletion to beets +* A new :doc:`/plugins/fish` adds `Fish shell`_ tab autocompletion to beets. * :doc:`plugins/fetchart` and :doc:`plugins/embedart`: Added a new ``quality`` option that controls the quality of the image output when the image is resized. @@ -48,34 +59,28 @@ New features: allow downloading of higher resolution iTunes artwork (at the expense of file size). :bug:`3391` -* :doc:`plugins/discogs` now adds two extra fields: `discogs_labelid` and - `discogs_artistid` +* :doc:`plugins/discogs`: The plugin applies two new fields: `discogs_labelid` + and `discogs_artistid`. :bug:`3413` -* :doc:`/plugins/export`: Added new ``-f`` (``--format``) flag; - which allows for the ability to export in json, jsonlines, csv and xml. +* :doc:`/plugins/export`: Added a new ``-f`` (``--format``) flag, + which can export your data as JSON, JSON lines, CSV, or XML. Thanks to :user:`austinmm`. :bug:`3402` -* :doc:`/plugins/unimported`: lets you find untracked files in your library directory. -* We now fetch information about `works`_ from MusicBrainz. - MusicBrainz matches provide the fields ``work`` (the title), ``mb_workid`` - (the MBID), and ``work_disambig`` (the disambiguation string). - Thanks to :user:`dosoe`. - :bug:`2580` :bug:`3272` -* :doc:`/plugins/convert`: Added new ``-l`` (``--link``) flag and ``link`` +* :doc:`/plugins/convert`: Added a new ``-l`` (``--link``) flag and ``link`` option as well as the ``-H`` (``--hardlink``) flag and ``hardlink`` - option which symlinks or hardlinks files that do not need to - be converted instead of copying them. + option, which symlink or hardlink files that do not need to + be converted (instead of copying them). :bug:`2324` * :doc:`/plugins/bpd`: BPD now supports most of the features of version 0.16 of the MPD protocol. This is enough to get it talking to more complicated clients like ncmpcpp, but there are still some incompatibilities, largely due - to MPD commands we don't support yet. Let us know if you find an MPD client - that doesn't get along with BPD! + to MPD commands we don't support yet. (Let us know if you find an MPD client + that doesn't get along with BPD!) :bug:`3214` :bug:`800` * :doc:`/plugins/replaygain`: The plugin now supports a ``per_disc`` option - which enables calculation of album ReplayGain on disc level instead of album + that enables calculation of album ReplayGain on disc level instead of album level. - Thanks to :user:`samuelnilsson` + Thanks to :user:`samuelnilsson`. :bug:`293` * :doc:`/plugins/replaygain`: The new ``ffmpeg`` ReplayGain backend supports ``R128_`` tags. From 1a2724c32768048254172416279bd27215515dfb Mon Sep 17 00:00:00 2001 From: Adrian Sampson Date: Sun, 7 Mar 2021 21:30:32 -0500 Subject: [PATCH 26/26] More changelog editing --- docs/changelog.rst | 75 +++++++++++++++++++++++----------------------- 1 file changed, 38 insertions(+), 37 deletions(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index 48179bd72..5d9aadfb1 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -24,6 +24,20 @@ Major new features: (the MBID), and ``work_disambig`` (the disambiguation string). Thanks to :user:`dosoe`. :bug:`2580` :bug:`3272` +* A new :doc:`/plugins/parentwork` gets information about the original work, + which is useful for classical music. + Thanks to :user:`dosoe`. + :bug:`2580` :bug:`3279` +* :doc:`/plugins/bpd`: BPD now supports most of the features of version 0.16 + of the MPD protocol. This is enough to get it talking to more complicated + clients like ncmpcpp, but there are still some incompatibilities, largely due + to MPD commands we don't support yet. (Let us know if you find an MPD client + that doesn't get along with BPD!) + :bug:`3214` :bug:`800` +* A new :doc:`/plugins/deezer` can autotag tracks and albums using the + `Deezer`_ database. + Thanks to :user:`rhlahuja`. + :bug:`3355` Other new things: @@ -46,14 +60,14 @@ Other new things: * A new :doc:`/plugins/subsonicplaylist` can import playlists from a Subsonic server. * :doc:`/plugins/subsonicupdate`: The plugin now automatically chooses between - token and password-based authentication based on server version -* A new :ref:`extra_tags` configuration option allows more tagged metadata - to be included in MusicBrainz queries. + token- and password-based authentication based on server version +* A new :ref:`extra_tags` configuration option lets you use more metadata in + MusicBrainz queries to further narrow the search. * A new :doc:`/plugins/fish` adds `Fish shell`_ tab autocompletion to beets. * :doc:`plugins/fetchart` and :doc:`plugins/embedart`: Added a new ``quality`` option that controls the quality of the image output when the image is resized. -* :doc:`plugins/keyfinder`: Added support for `keyfinder-cli`_ +* :doc:`plugins/keyfinder`: Added support for `keyfinder-cli`_. Thanks to :user:`BrainDamage`. * :doc:`plugins/fetchart`: Added a new ``high_resolution`` config option to allow downloading of higher resolution iTunes artwork (at the expense of @@ -71,12 +85,6 @@ Other new things: option, which symlink or hardlink files that do not need to be converted (instead of copying them). :bug:`2324` -* :doc:`/plugins/bpd`: BPD now supports most of the features of version 0.16 - of the MPD protocol. This is enough to get it talking to more complicated - clients like ncmpcpp, but there are still some incompatibilities, largely due - to MPD commands we don't support yet. (Let us know if you find an MPD client - that doesn't get along with BPD!) - :bug:`3214` :bug:`800` * :doc:`/plugins/replaygain`: The plugin now supports a ``per_disc`` option that enables calculation of album ReplayGain on disc level instead of album level. @@ -85,20 +93,15 @@ Other new things: * :doc:`/plugins/replaygain`: The new ``ffmpeg`` ReplayGain backend supports ``R128_`` tags. :bug:`3056` -* :doc:`plugins/replaygain`: ``r128_targetlevel`` is a new configuration option - for the ReplayGain plugin: It defines the reference volume for files using - ``R128_`` tags. ``targetlevel`` only configures the reference volume for - ``REPLAYGAIN_`` files. +* :doc:`plugins/replaygain`: A new ``r128_targetlevel`` configuration option + defines the reference volume for files using ``R128_`` tags. ``targetlevel`` + only configures the reference volume for ``REPLAYGAIN_`` files. :bug:`3065` -* A new :doc:`/plugins/parentwork` gets information about the original work, - which is useful for classical music. - Thanks to :user:`dosoe`. - :bug:`2580` :bug:`3279` -* :doc:`/plugins/discogs`: The field now collects the "style" field. +* :doc:`/plugins/discogs`: The plugin now collects the "style" field. Thanks to :user:`thedevilisinthedetails`. :bug:`2579` :bug:`3251` * :doc:`/plugins/absubmit`: By default, the plugin now avoids re-analyzing - files that already have AB data. + files that already have AcousticBrainz data. There are new ``force`` and ``pretend`` options to help control this new behavior. Thanks to :user:`SusannaMaria`. @@ -116,24 +119,21 @@ Other new things: Windows. Thanks to :user:`MartyLake`. :bug:`3331` :bug:`3334` -* The 'data_source' field is now also applied as an album-level flexible - attribute during imports, allowing for more refined album level searches. +* The `data_source` field, which indicates which metadata source was used + during an autotagging import, is now also applied as an album-level flexible + attribute. :bug:`3350` :bug:`1693` -* :doc:`/plugins/deezer`: Added Deezer plugin as an import metadata provider: - you can now match tracks and albums using the `Deezer`_ database. - Thanks to :user:`rhlahuja`. - :bug:`3355` -* :doc:`/plugins/beatport`: The plugin now gets the musical key, BPM and the +* :doc:`/plugins/beatport`: The plugin now gets the musical key, BPM, and genre for each track. :bug:`2080` -* :doc:`/plugins/beatport`: Fix default assignment of the musical key. +* :doc:`/plugins/beatport`: Fix the default assignment of the musical key. :bug:`3377` * :doc:`/plugins/bpsync`: Add `bpsync` plugin to sync metadata changes from the Beatport database. * :doc:`/plugins/beatport`: Fix assignment of `genre` and rename `musical_key` to `initial_key`. :bug:`3387` -* :doc:`/plugins/hook` now treats non-zero exit codes as errors. +* :doc:`/plugins/hook`: The plugin now treats non-zero exit codes as errors. :bug:`3409` * :doc:`/plugins/subsonicupdate`: A new ``url`` configuration replaces the older (and now deprecated) separate ``host``, ``port``, and ``contextpath`` @@ -148,27 +148,24 @@ Other new things: :bug:`3459` * :doc:`/plugins/fetchart`: Album art can now be fetched from `last.fm`_. :bug:`3530` -* The classes ``AlbumInfo`` and ``TrackInfo`` now have flexible attributes, - allowing to solve :bug:`1547`. - Thanks to :user:`dosoe`. * :doc:`/plugins/web`: The query API now interprets backslashes as path separators to support path queries. Thanks to :user:`nmeum`. :bug:`3567` * ``beet import`` now handles tar archives with bzip2 or gzip compression. :bug:`3606` -* :doc:`/plugins/plexupdate`: Add option to use secure connection to Plex - server, and to ignore certificate validation errors if necessary. +* :doc:`/plugins/plexupdate`: Added an option to use a secure connection to + Plex server, and to ignore certificate validation errors if necessary. :bug:`2871` -* :doc:`/plugins/lyrics`: Improved searching Genius backend when artist - contained special characters. +* :doc:`/plugins/lyrics`: Improved searching on the Genius backend when the + artist contains special characters. :bug:`3634` * :doc:`/plugins/parentwork`: Also get the composition date of the parent work, instead of just the child work. Thanks to :user:`aereaux`. :bug:`3650` * :doc:`/plugins/lyrics`: Fix a bug in the heuristic for detecting valid - lyrics in the Google source of the lyrics plugin + lyrics in the Google source. :bug:`2969` * :doc:`/plugins/thumbnails`: Fix a bug where pathlib expected a string instead of bytes for a path. @@ -375,6 +372,10 @@ For plugin developers: * ``Item.keys`` also has a ``with_album`` argument now, defaulting to ``True``. * A ``revision`` attribute has been added to ``Database``. It is increased on every transaction that mutates it. :bug:`2988` +* The classes ``AlbumInfo`` and ``TrackInfo`` now convey arbitrary attributes + instead of a fixed, built-in set of field names (which was important to + address :bug:`1547`). + Thanks to :user:`dosoe`. For packagers: