mirror of
https://github.com/beetbox/beets.git
synced 2026-01-11 10:26:36 +01:00
fetch series info from MusicBrainz
This commit is contained in:
Guilherme Danno
parent
21e11f5bb3
commit
4d333432ff
1 changed files with 276 additions and 0 deletions
276
beetsplug/series.py
Normal file
276
beetsplug/series.py
Normal file
|
|
@ -0,0 +1,276 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
# This file is part of beets.
|
||||
# Copyright 2019, Guilherme Danno.
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining
|
||||
# a copy of this software and associated documentation files (the
|
||||
# "Software"), to deal in the Software without restriction, including
|
||||
# without limitation the rights to use, copy, modify, merge, publish,
|
||||
# distribute, sublicense, and/or sell copies of the Software, and to
|
||||
# permit persons to whom the Software is furnished to do so, subject to
|
||||
# the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be
|
||||
# included in all copies or substantial portions of the Software.
|
||||
|
||||
"""Update library's tags using MusicBrainz.
|
||||
"""
|
||||
from __future__ import division, absolute_import, print_function
|
||||
|
||||
from beets.plugins import BeetsPlugin
|
||||
from beets import ui, util
|
||||
from beets.autotag.mb import _parse_id, musicbrainzngs
|
||||
from collections import defaultdict, namedtuple
|
||||
|
||||
import re
|
||||
|
||||
MUSICBRAINZ_URL = 'https://musicbrainz.org/mbid/'
|
||||
ORDER_ATTR_ID = 'a59c5830-5ec7-38fe-9a21-c7ea54f6650a'
|
||||
|
||||
SeriesType = namedtuple('SeriesType', [
|
||||
'name',
|
||||
'relation',
|
||||
'relation_list',
|
||||
'get_field'
|
||||
])
|
||||
|
||||
TYPES = [
|
||||
SeriesType(
|
||||
name='Release series',
|
||||
relation='release-rels',
|
||||
relation_list='release-relation-list',
|
||||
get_field=lambda a: a.mb_albumid
|
||||
),
|
||||
SeriesType(
|
||||
name='Release group series',
|
||||
relation='release-group-rels',
|
||||
relation_list='release_group-relation-list',
|
||||
get_field=lambda a: a.mb_releasegroupid
|
||||
),
|
||||
]
|
||||
|
||||
SERIES_RELS = [t.relation for t in TYPES]
|
||||
|
||||
|
||||
def apply_item_changes(lib, item, move, pretend, write):
|
||||
"""Store, move and write the item according to the arguments.
|
||||
"""
|
||||
if not pretend:
|
||||
# Move the item if it's in the library.
|
||||
if move and lib.directory in util.ancestry(item.path):
|
||||
item.move(with_album=False)
|
||||
|
||||
if write:
|
||||
item.try_write()
|
||||
item.store()
|
||||
|
||||
|
||||
def get_series_type(name):
|
||||
return next((t for t in TYPES if t.name == name), None)
|
||||
|
||||
|
||||
def get_attribute(item, attr):
|
||||
try:
|
||||
return [x['value'] for x in item['attributes']
|
||||
if x['type-id'] == attr][0]
|
||||
except KeyError:
|
||||
return None
|
||||
|
||||
|
||||
class SeriesProvider:
|
||||
|
||||
@property
|
||||
def item_limit(self):
|
||||
return None
|
||||
|
||||
def _build_series(self, series):
|
||||
data = {
|
||||
'id': series['series']['id'],
|
||||
'name': series['series']['name'],
|
||||
'type': get_series_type(series['series']['type']),
|
||||
'items': defaultdict(dict),
|
||||
}
|
||||
|
||||
for item in series['series'][data['type'].relation_list]:
|
||||
data['items'][item['target']] = {
|
||||
'order': get_attribute(item, ORDER_ATTR_ID),
|
||||
'name': data['name'],
|
||||
'id': data['id'],
|
||||
}
|
||||
|
||||
return data
|
||||
|
||||
def get_by_id(self, series_id):
|
||||
try:
|
||||
series = musicbrainzngs.get_series_by_id(series_id, SERIES_RELS)
|
||||
return self._build_series(series)
|
||||
except Exception:
|
||||
return
|
||||
|
||||
def search(self, query):
|
||||
# TODO: Pagination
|
||||
result = musicbrainzngs.search_series(
|
||||
query,
|
||||
limit=self.item_limit)
|
||||
|
||||
if result['series-count'] == 0:
|
||||
print(u'No results for {}'.format(query))
|
||||
return
|
||||
|
||||
print(u"Found {} results for '{}'".format(
|
||||
result['series-count'],
|
||||
query
|
||||
))
|
||||
|
||||
# TODO: move function
|
||||
def group_by_type(items, key='type'):
|
||||
from itertools import groupby
|
||||
|
||||
supported_series = [t.name for t in TYPES]
|
||||
keyfunc = lambda x: x[key]
|
||||
|
||||
for k, item in groupby(sorted(items, key=keyfunc), keyfunc):
|
||||
if k in supported_series:
|
||||
yield (k, item)
|
||||
|
||||
i = 0
|
||||
available_items = {}
|
||||
# TODO: Extract choosing method
|
||||
for key, items in group_by_type(result['series-list']):
|
||||
ui.print_(f"\n{ui.colorize('text_highlight_minor', key)}:\n")
|
||||
|
||||
for item in items:
|
||||
i += 1
|
||||
available_items[i] = item['id']
|
||||
|
||||
try:
|
||||
text = "{} ({})".format(
|
||||
ui.colordiff(query, item['name'])[1],
|
||||
ui.colorize('text_highlight_minor',
|
||||
item['disambiguation']),
|
||||
)
|
||||
except KeyError:
|
||||
text = ui.colordiff(query, item['name'])[1]
|
||||
ui.print_(f" {i}. {text}\n {MUSICBRAINZ_URL}{item['id']}\n")
|
||||
|
||||
def parse_items():
|
||||
while True:
|
||||
choices = []
|
||||
response = ui.input_options(
|
||||
choices,
|
||||
prompt='Choose a number',
|
||||
numrange=(1, len(available_items)))
|
||||
|
||||
try:
|
||||
return available_items[response]
|
||||
except KeyError:
|
||||
pass
|
||||
return parse_items()
|
||||
|
||||
|
||||
class MbSeriesPlugin(BeetsPlugin):
|
||||
|
||||
mapping = {
|
||||
'id': 'id',
|
||||
'name': 'name',
|
||||
'volume': 'order',
|
||||
}
|
||||
|
||||
def __init__(self):
|
||||
super(MbSeriesPlugin, self).__init__()
|
||||
|
||||
self.config.add({
|
||||
'auto': True,
|
||||
'fields': {
|
||||
'id': {
|
||||
'field_name': 'mb_seriesid',
|
||||
'write': True,
|
||||
},
|
||||
'name': {
|
||||
'field_name': 'series',
|
||||
'write': True,
|
||||
},
|
||||
'volume': {
|
||||
'field_name': 'volume',
|
||||
'write': True,
|
||||
},
|
||||
}
|
||||
})
|
||||
|
||||
def commands(self):
|
||||
def func(lib, opts, args):
|
||||
"""
|
||||
Command handler for the series function.
|
||||
"""
|
||||
move = ui.should_move(opts.move)
|
||||
pretend = opts.pretend
|
||||
write = ui.should_write(opts.write)
|
||||
query = ui.decargs(args)
|
||||
mb_query = opts.mb_query
|
||||
series_id = _parse_id(opts.id or '')
|
||||
series = SeriesProvider()
|
||||
|
||||
if series_id:
|
||||
self._log.info(u'Updating series {0}'.format(series_id))
|
||||
self.albums(lib, query, series_id, move, pretend, write)
|
||||
elif mb_query:
|
||||
series_id = series.search(mb_query)
|
||||
self.albums(lib, query, series_id, move, pretend, write)
|
||||
else:
|
||||
self._log.info('update all')
|
||||
|
||||
cmd = ui.Subcommand('series', help=u'Fetch series from MusicBrainz')
|
||||
cmd.parser.add_option(
|
||||
u'-S', u'--id', action='store',
|
||||
help=u'Series id')
|
||||
cmd.parser.add_option(
|
||||
u'-q', u'--mb-query', action='store',
|
||||
help=u'MusicBrainz query')
|
||||
cmd.parser.add_option(
|
||||
u'-p', u'--pretend', action='store_true',
|
||||
help=u'show all changes but do nothing')
|
||||
cmd.parser.add_option(
|
||||
u'-m', u'--move', action='store_true', dest='move',
|
||||
help=u"move files in the library directory")
|
||||
cmd.parser.add_option(
|
||||
u'-M', u'--nomove', action='store_false', dest='move',
|
||||
help=u"don't move files in library")
|
||||
cmd.parser.add_option(
|
||||
u'-W', u'--nowrite', action='store_false',
|
||||
default=None, dest='write',
|
||||
help=u"don't write updated metadata to files")
|
||||
cmd.func = func
|
||||
return [cmd]
|
||||
|
||||
def is_mb_release(self, a):
|
||||
return a.mb_albumid and _parse_id(a.mb_albumid)
|
||||
|
||||
def albums(self, lib, query, series_id, move, pretend, write):
|
||||
"""Retrieve and apply info from the autotagger for albums matched by
|
||||
query and their items.
|
||||
"""
|
||||
provider = SeriesProvider()
|
||||
series = provider.get_by_id(series_id)
|
||||
|
||||
if not series:
|
||||
return
|
||||
|
||||
fields = []
|
||||
for key, field in self.config['fields'].items():
|
||||
if field['write']:
|
||||
field['attr'] = self.mapping[key]
|
||||
fields.append(field)
|
||||
|
||||
for a in [a for a in lib.albums(query) if self.is_mb_release(a)]:
|
||||
mbid = series['type'].get_field(a)
|
||||
if not series['items'][mbid]:
|
||||
continue
|
||||
|
||||
item = series['items'][mbid]
|
||||
|
||||
for f in fields:
|
||||
if item[f['attr'].get()]:
|
||||
a[f['field_name'].get()] = item[f['attr'].get()]
|
||||
|
||||
ui.show_model_changes(a)
|
||||
apply_item_changes(lib, a, move, pretend, write)
|
||||
Loading…
Reference in a new issue