mirror of
https://github.com/beetbox/beets.git
synced 2025-12-06 08:39:17 +01:00
5d96509cfe
URL-encode additional item `fields` within generated EXTM3U playlists instead of JSON-encoding them. This is because JSON-encoding additional fields/attributes made it difficult to parse the `EXTINF` line but using URL-encoding for these values makes parsing easy (because URL-encoded values cannot contain commas, quotation marks and spaces). I introduced the generation of additional EXTM3U item fields earlier this year and I want to correct that now. **Design/definition background:** Unfortunately, I didn't find a clear definition of how additional playlist item attributes should be encoded - apparently there is none. Given that item URIs within an M3U playlist can be URL-encoded already, defining the values of additional attributes to be URL-encoded is consistent design. I didn't find examples of additional EXTM3U item attributes in the web where the attribute value contains a comma, space or quotation mark but examples that specified numeric IDs and URLs as attribute values. Because the URL attribute examples I found didn't contain URL-encoded characters and because it is more readable and unproblematic for parsing, I've let the attribute URL encoding treat `:` and `/` as safe characters. **Breaking change:** While this is a breaking change in theory, in practice it is not since afaik all integrations of the smartplaylist plugin's additional EXTM3U item attribute generation feature (beets-webm3u) work with simple attribute values such as the item ID (numeric) whose formatting/encoding is not affected when changing from JSON to URL-encoding. In other words the change is backward-compatible with the beets-webm3u plugin (which I'll adjust correspondingly after this beets PR was merged).
370 lines
13 KiB
Python
370 lines
13 KiB
Python
# This file is part of beets.
|
|
# Copyright 2016, Bruno Cauet.
|
|
#
|
|
# Permission is hereby granted, free of charge, to any person obtaining
|
|
# a copy of this software and associated documentation files (the
|
|
# "Software"), to deal in the Software without restriction, including
|
|
# without limitation the rights to use, copy, modify, merge, publish,
|
|
# distribute, sublicense, and/or sell copies of the Software, and to
|
|
# permit persons to whom the Software is furnished to do so, subject to
|
|
# the following conditions:
|
|
#
|
|
# The above copyright notice and this permission notice shall be
|
|
# included in all copies or substantial portions of the Software.
|
|
|
|
|
|
from os import fsdecode, path, remove
|
|
from shutil import rmtree
|
|
from tempfile import mkdtemp
|
|
from unittest.mock import MagicMock, Mock, PropertyMock
|
|
|
|
import pytest
|
|
|
|
from beets import config
|
|
from beets.dbcore import OrQuery
|
|
from beets.dbcore.query import FixedFieldSort, MultipleSort, NullSort
|
|
from beets.library import Album, Item, parse_query_string
|
|
from beets.test.helper import BeetsTestCase, PluginTestCase
|
|
from beets.ui import UserError
|
|
from beets.util import CHAR_REPLACE, bytestring_path, syspath
|
|
from beetsplug.smartplaylist import SmartPlaylistPlugin
|
|
|
|
|
|
class SmartPlaylistTest(BeetsTestCase):
|
|
def test_build_queries(self):
|
|
spl = SmartPlaylistPlugin()
|
|
assert spl._matched_playlists is None
|
|
assert spl._unmatched_playlists is None
|
|
|
|
config["smartplaylist"]["playlists"].set([])
|
|
spl.build_queries()
|
|
assert spl._matched_playlists == set()
|
|
assert spl._unmatched_playlists == set()
|
|
|
|
config["smartplaylist"]["playlists"].set(
|
|
[
|
|
{"name": "foo", "query": "FOO foo"},
|
|
{"name": "bar", "album_query": ["BAR bar1", "BAR bar2"]},
|
|
{"name": "baz", "query": "BAZ baz", "album_query": "BAZ baz"},
|
|
]
|
|
)
|
|
spl.build_queries()
|
|
assert spl._matched_playlists == set()
|
|
foo_foo = parse_query_string("FOO foo", Item)
|
|
baz_baz = parse_query_string("BAZ baz", Item)
|
|
baz_baz2 = parse_query_string("BAZ baz", Album)
|
|
bar_bar = OrQuery(
|
|
(
|
|
parse_query_string("BAR bar1", Album)[0],
|
|
parse_query_string("BAR bar2", Album)[0],
|
|
)
|
|
)
|
|
assert spl._unmatched_playlists == {
|
|
("foo", foo_foo, (None, None)),
|
|
("baz", baz_baz, baz_baz2),
|
|
("bar", (None, None), (bar_bar, None)),
|
|
}
|
|
|
|
def test_build_queries_with_sorts(self):
|
|
spl = SmartPlaylistPlugin()
|
|
config["smartplaylist"]["playlists"].set(
|
|
[
|
|
{"name": "no_sort", "query": "foo"},
|
|
{"name": "one_sort", "query": "foo year+"},
|
|
{"name": "only_empty_sorts", "query": ["foo", "bar"]},
|
|
{"name": "one_non_empty_sort", "query": ["foo year+", "bar"]},
|
|
{
|
|
"name": "multiple_sorts",
|
|
"query": ["foo year+", "bar genre-"],
|
|
},
|
|
{
|
|
"name": "mixed",
|
|
"query": ["foo year+", "bar", "baz genre+ id-"],
|
|
},
|
|
]
|
|
)
|
|
|
|
spl.build_queries()
|
|
sorts = {name: sort for name, (_, sort), _ in spl._unmatched_playlists}
|
|
|
|
sort = FixedFieldSort # short cut since we're only dealing with this
|
|
assert sorts["no_sort"] == NullSort()
|
|
assert sorts["one_sort"] == sort("year")
|
|
assert sorts["only_empty_sorts"] is None
|
|
assert sorts["one_non_empty_sort"] == sort("year")
|
|
assert sorts["multiple_sorts"] == MultipleSort(
|
|
[sort("year"), sort("genre", False)]
|
|
)
|
|
assert sorts["mixed"] == MultipleSort(
|
|
[sort("year"), sort("genre"), sort("id", False)]
|
|
)
|
|
|
|
def test_matches(self):
|
|
spl = SmartPlaylistPlugin()
|
|
|
|
a = MagicMock(Album)
|
|
i = MagicMock(Item)
|
|
|
|
assert not spl.matches(i, None, None)
|
|
assert not spl.matches(a, None, None)
|
|
|
|
query = Mock()
|
|
query.match.side_effect = {i: True}.__getitem__
|
|
assert spl.matches(i, query, None)
|
|
assert not spl.matches(a, query, None)
|
|
|
|
a_query = Mock()
|
|
a_query.match.side_effect = {a: True}.__getitem__
|
|
assert not spl.matches(i, None, a_query)
|
|
assert spl.matches(a, None, a_query)
|
|
|
|
assert spl.matches(i, query, a_query)
|
|
assert spl.matches(a, query, a_query)
|
|
|
|
def test_db_changes(self):
|
|
spl = SmartPlaylistPlugin()
|
|
|
|
nones = None, None
|
|
pl1 = "1", ("q1", None), nones
|
|
pl2 = "2", ("q2", None), nones
|
|
pl3 = "3", ("q3", None), nones
|
|
|
|
spl._unmatched_playlists = {pl1, pl2, pl3}
|
|
spl._matched_playlists = set()
|
|
|
|
spl.matches = Mock(return_value=False)
|
|
spl.db_change(None, "nothing")
|
|
assert spl._unmatched_playlists == {pl1, pl2, pl3}
|
|
assert spl._matched_playlists == set()
|
|
|
|
spl.matches.side_effect = lambda _, q, __: q == "q3"
|
|
spl.db_change(None, "matches 3")
|
|
assert spl._unmatched_playlists == {pl1, pl2}
|
|
assert spl._matched_playlists == {pl3}
|
|
|
|
spl.matches.side_effect = lambda _, q, __: q == "q1"
|
|
spl.db_change(None, "matches 3")
|
|
assert spl._matched_playlists == {pl1, pl3}
|
|
assert spl._unmatched_playlists == {pl2}
|
|
|
|
def test_playlist_update(self):
|
|
spl = SmartPlaylistPlugin()
|
|
|
|
i = Mock(path=b"/tagada.mp3")
|
|
i.evaluate_template.side_effect = lambda pl, _: pl.replace(
|
|
b"$title", b"ta:ga:da"
|
|
).decode()
|
|
|
|
lib = Mock()
|
|
lib.replacements = CHAR_REPLACE
|
|
lib.items.return_value = [i]
|
|
lib.albums.return_value = []
|
|
|
|
q = Mock()
|
|
a_q = Mock()
|
|
pl = b"$title-my<playlist>.m3u", (q, None), (a_q, None)
|
|
spl._matched_playlists = [pl]
|
|
|
|
dir = bytestring_path(mkdtemp())
|
|
config["smartplaylist"]["relative_to"] = False
|
|
config["smartplaylist"]["playlist_dir"] = fsdecode(dir)
|
|
try:
|
|
spl.update_playlists(lib)
|
|
except Exception:
|
|
rmtree(syspath(dir))
|
|
raise
|
|
|
|
lib.items.assert_called_once_with(q, None)
|
|
lib.albums.assert_called_once_with(a_q, None)
|
|
|
|
m3u_filepath = path.join(dir, b"ta_ga_da-my_playlist_.m3u")
|
|
self.assertExists(m3u_filepath)
|
|
with open(syspath(m3u_filepath), "rb") as f:
|
|
content = f.read()
|
|
rmtree(syspath(dir))
|
|
|
|
assert content == b"/tagada.mp3\n"
|
|
|
|
def test_playlist_update_output_extm3u(self):
|
|
spl = SmartPlaylistPlugin()
|
|
|
|
i = MagicMock()
|
|
type(i).artist = PropertyMock(return_value="fake artist")
|
|
type(i).title = PropertyMock(return_value="fake title")
|
|
type(i).length = PropertyMock(return_value=300.123)
|
|
type(i).path = PropertyMock(return_value=b"/tagada.mp3")
|
|
i.evaluate_template.side_effect = lambda pl, _: pl.replace(
|
|
b"$title",
|
|
b"ta:ga:da",
|
|
).decode()
|
|
|
|
lib = Mock()
|
|
lib.replacements = CHAR_REPLACE
|
|
lib.items.return_value = [i]
|
|
lib.albums.return_value = []
|
|
|
|
q = Mock()
|
|
a_q = Mock()
|
|
pl = b"$title-my<playlist>.m3u", (q, None), (a_q, None)
|
|
spl._matched_playlists = [pl]
|
|
|
|
dir = bytestring_path(mkdtemp())
|
|
config["smartplaylist"]["output"] = "extm3u"
|
|
config["smartplaylist"]["prefix"] = "http://beets:8337/files"
|
|
config["smartplaylist"]["relative_to"] = False
|
|
config["smartplaylist"]["playlist_dir"] = fsdecode(dir)
|
|
try:
|
|
spl.update_playlists(lib)
|
|
except Exception:
|
|
rmtree(syspath(dir))
|
|
raise
|
|
|
|
lib.items.assert_called_once_with(q, None)
|
|
lib.albums.assert_called_once_with(a_q, None)
|
|
|
|
m3u_filepath = path.join(dir, b"ta_ga_da-my_playlist_.m3u")
|
|
self.assertExists(m3u_filepath)
|
|
with open(syspath(m3u_filepath), "rb") as f:
|
|
content = f.read()
|
|
rmtree(syspath(dir))
|
|
|
|
assert (
|
|
content
|
|
== b"#EXTM3U\n"
|
|
+ b"#EXTINF:300,fake artist - fake title\n"
|
|
+ b"http://beets:8337/files/tagada.mp3\n"
|
|
)
|
|
|
|
def test_playlist_update_output_extm3u_fields(self):
|
|
spl = SmartPlaylistPlugin()
|
|
|
|
i = MagicMock()
|
|
type(i).artist = PropertyMock(return_value="Fake Artist")
|
|
type(i).title = PropertyMock(return_value="fake Title")
|
|
type(i).length = PropertyMock(return_value=300.123)
|
|
type(i).path = PropertyMock(return_value=b"/tagada.mp3")
|
|
a = {"id": 456, "genre": "Fake Genre"}
|
|
i.__getitem__.side_effect = a.__getitem__
|
|
i.evaluate_template.side_effect = lambda pl, _: pl.replace(
|
|
b"$title",
|
|
b"ta:ga:da",
|
|
).decode()
|
|
|
|
lib = Mock()
|
|
lib.replacements = CHAR_REPLACE
|
|
lib.items.return_value = [i]
|
|
lib.albums.return_value = []
|
|
|
|
q = Mock()
|
|
a_q = Mock()
|
|
pl = b"$title-my<playlist>.m3u", (q, None), (a_q, None)
|
|
spl._matched_playlists = [pl]
|
|
|
|
dir = bytestring_path(mkdtemp())
|
|
config["smartplaylist"]["output"] = "extm3u"
|
|
config["smartplaylist"]["relative_to"] = False
|
|
config["smartplaylist"]["playlist_dir"] = fsdecode(dir)
|
|
config["smartplaylist"]["fields"] = ["id", "genre"]
|
|
try:
|
|
spl.update_playlists(lib)
|
|
except Exception:
|
|
rmtree(syspath(dir))
|
|
raise
|
|
|
|
lib.items.assert_called_once_with(q, None)
|
|
lib.albums.assert_called_once_with(a_q, None)
|
|
|
|
m3u_filepath = path.join(dir, b"ta_ga_da-my_playlist_.m3u")
|
|
self.assertExists(m3u_filepath)
|
|
with open(syspath(m3u_filepath), "rb") as f:
|
|
content = f.read()
|
|
rmtree(syspath(dir))
|
|
|
|
assert (
|
|
content
|
|
== b"#EXTM3U\n"
|
|
+ b'#EXTINF:300 id="456" genre="Fake%20Genre",Fake Artist - fake Title\n'
|
|
+ b"/tagada.mp3\n"
|
|
)
|
|
|
|
def test_playlist_update_uri_format(self):
|
|
spl = SmartPlaylistPlugin()
|
|
|
|
i = MagicMock()
|
|
type(i).id = PropertyMock(return_value=3)
|
|
type(i).path = PropertyMock(return_value=b"/tagada.mp3")
|
|
i.evaluate_template.side_effect = lambda pl, _: pl.replace(
|
|
b"$title", b"ta:ga:da"
|
|
).decode()
|
|
|
|
lib = Mock()
|
|
lib.replacements = CHAR_REPLACE
|
|
lib.items.return_value = [i]
|
|
lib.albums.return_value = []
|
|
|
|
q = Mock()
|
|
a_q = Mock()
|
|
pl = b"$title-my<playlist>.m3u", (q, None), (a_q, None)
|
|
spl._matched_playlists = [pl]
|
|
|
|
dir = bytestring_path(mkdtemp())
|
|
tpl = "http://beets:8337/item/$id/file"
|
|
config["smartplaylist"]["uri_format"] = tpl
|
|
config["smartplaylist"]["playlist_dir"] = fsdecode(dir)
|
|
# The following options should be ignored when uri_format is set
|
|
config["smartplaylist"]["relative_to"] = "/data"
|
|
config["smartplaylist"]["prefix"] = "/prefix"
|
|
config["smartplaylist"]["urlencode"] = True
|
|
try:
|
|
spl.update_playlists(lib)
|
|
except Exception:
|
|
rmtree(syspath(dir))
|
|
raise
|
|
|
|
lib.items.assert_called_once_with(q, None)
|
|
lib.albums.assert_called_once_with(a_q, None)
|
|
|
|
m3u_filepath = path.join(dir, b"ta_ga_da-my_playlist_.m3u")
|
|
self.assertExists(m3u_filepath)
|
|
with open(syspath(m3u_filepath), "rb") as f:
|
|
content = f.read()
|
|
rmtree(syspath(dir))
|
|
|
|
assert content == b"http://beets:8337/item/3/file\n"
|
|
|
|
|
|
class SmartPlaylistCLITest(PluginTestCase):
|
|
plugin = "smartplaylist"
|
|
|
|
def setUp(self):
|
|
super().setUp()
|
|
|
|
self.item = self.add_item()
|
|
config["smartplaylist"]["playlists"].set(
|
|
[
|
|
{"name": "my_playlist.m3u", "query": self.item.title},
|
|
{"name": "all.m3u", "query": ""},
|
|
]
|
|
)
|
|
config["smartplaylist"]["playlist_dir"].set(fsdecode(self.temp_dir))
|
|
|
|
def test_splupdate(self):
|
|
with pytest.raises(UserError):
|
|
self.run_with_output("splupdate", "tagada")
|
|
|
|
self.run_with_output("splupdate", "my_playlist")
|
|
m3u_path = path.join(self.temp_dir, b"my_playlist.m3u")
|
|
self.assertExists(m3u_path)
|
|
with open(syspath(m3u_path), "rb") as f:
|
|
assert f.read() == self.item.path + b"\n"
|
|
remove(syspath(m3u_path))
|
|
|
|
self.run_with_output("splupdate", "my_playlist.m3u")
|
|
with open(syspath(m3u_path), "rb") as f:
|
|
assert f.read() == self.item.path + b"\n"
|
|
remove(syspath(m3u_path))
|
|
|
|
self.run_with_output("splupdate")
|
|
for name in (b"my_playlist.m3u", b"all.m3u"):
|
|
with open(path.join(self.temp_dir, name), "rb") as f:
|
|
assert f.read() == self.item.path + b"\n"
|