mirror of
https://github.com/beetbox/beets.git
synced 2025-12-06 08:39:17 +01:00
3176b83cd7
All editable values are now strings and are parsed from strings. This closely matches the behavior of the `modify` command, for example.
265 lines
8.4 KiB
Python
265 lines
8.4 KiB
Python
# This file is part of beets.
|
|
# Copyright 2015
|
|
#
|
|
# Permission is hereby granted, free of charge, to any person obtaining
|
|
# a copy of this software and associated documentation files (the
|
|
# "Software"), to deal in the Software without restriction, including
|
|
# without limitation the rights to use, copy, modify, merge, publish,
|
|
# distribute, sublicense, and/or sell copies of the Software, and to
|
|
# permit persons to whom the Software is furnished to do so, subject to
|
|
# the following conditions:
|
|
#
|
|
# The above copyright notice and this permission notice shall be
|
|
# included in all copies or substantial portions of the Software.
|
|
|
|
"""Open metadata information in a text editor to let the user edit it.
|
|
"""
|
|
from __future__ import (division, absolute_import, print_function,
|
|
unicode_literals)
|
|
|
|
from beets import plugins
|
|
from beets import util
|
|
from beets import ui
|
|
from beets.ui.commands import _do_query
|
|
import subprocess
|
|
import yaml
|
|
from tempfile import NamedTemporaryFile
|
|
import os
|
|
|
|
|
|
def edit(filename):
|
|
"""Open `filename` in a text editor.
|
|
"""
|
|
cmd = util.shlex_split(util.editor_command())
|
|
cmd.append(filename)
|
|
subprocess.call(cmd)
|
|
|
|
|
|
def dump(arg):
|
|
"""Dump an object as YAML for editing.
|
|
"""
|
|
return yaml.safe_dump_all(
|
|
arg,
|
|
allow_unicode=True,
|
|
default_flow_style=False,
|
|
)
|
|
|
|
|
|
def load(s):
|
|
"""Read a YAML string back to an object.
|
|
"""
|
|
return list(yaml.load_all(s))
|
|
|
|
|
|
def flatten(obj, fields):
|
|
"""Represent `obj`, a `dbcore.Model` object, as a dictionary for
|
|
serialization. Only include the given `fields` if provided;
|
|
otherwise, include everything.
|
|
|
|
The resulting dictionary's keys are all human-readable strings.
|
|
"""
|
|
d = dict(obj.formatted())
|
|
if fields:
|
|
return {k: v for k, v in d.items() if k in fields}
|
|
else:
|
|
return d
|
|
|
|
|
|
def apply(obj, data):
|
|
"""Set the fields of a `dbcore.Model` object according to a
|
|
dictionary.
|
|
|
|
This is the opposite of `flatten`. The `data` dictionary should have
|
|
strings as values.
|
|
"""
|
|
for key, value in data.items():
|
|
obj.set_parse(key, value)
|
|
|
|
|
|
class EditPlugin(plugins.BeetsPlugin):
|
|
|
|
def __init__(self):
|
|
super(EditPlugin, self).__init__()
|
|
|
|
self.config.add({
|
|
# The default fields to edit.
|
|
'albumfields': 'album albumartist',
|
|
'itemfields': 'track title artist album',
|
|
|
|
# Silently ignore any changes to these fields.
|
|
'ignore_fields': 'id path',
|
|
})
|
|
|
|
def commands(self):
|
|
edit_command = ui.Subcommand(
|
|
'edit',
|
|
help='interactively edit metadata'
|
|
)
|
|
edit_command.parser.add_option(
|
|
'-f', '--field',
|
|
metavar='FIELD',
|
|
action='append',
|
|
help='edit this field also',
|
|
)
|
|
edit_command.parser.add_option(
|
|
'--all',
|
|
action='store_true', dest='all',
|
|
help='edit all fields',
|
|
)
|
|
edit_command.parser.add_album_option()
|
|
edit_command.func = self._edit_command
|
|
return [edit_command]
|
|
|
|
def _edit_command(self, lib, opts, args):
|
|
"""The CLI command function for the `beet edit` command.
|
|
"""
|
|
# Get the objects to edit.
|
|
query = ui.decargs(args)
|
|
items, albums = _do_query(lib, query, opts.album, False)
|
|
objs = albums if opts.album else items
|
|
if not objs:
|
|
ui.print_('Nothing to edit.')
|
|
return
|
|
|
|
# Get the fields to edit.
|
|
if opts.all:
|
|
fields = None
|
|
else:
|
|
fields = self._get_fields(opts.album, opts.field)
|
|
self.edit(opts.album, objs, fields)
|
|
|
|
def _get_fields(self, album, extra):
|
|
"""Get the set of fields to edit.
|
|
"""
|
|
# Start with the configured base fields.
|
|
if album:
|
|
fields = self.config['albumfields'].as_str_seq()
|
|
else:
|
|
fields = self.config['itemfields'].as_str_seq()
|
|
|
|
# Add the requested extra fields.
|
|
if extra:
|
|
fields += extra
|
|
|
|
# Ensure we always have the `id` field for identification.
|
|
fields.append('id')
|
|
|
|
return set(fields)
|
|
|
|
def edit(self, album, objs, fields):
|
|
"""The core editor function.
|
|
|
|
- `album`: A flag indicating whether we're editing Items or Albums.
|
|
- `objs`: The `Item`s or `Album`s to edit.
|
|
- `fields`: The set of field names to edit (or None to edit
|
|
everything).
|
|
"""
|
|
# Present the YAML to the user and let her change it.
|
|
success = self.edit_objects(objs, fields)
|
|
|
|
# Save the new data.
|
|
if success:
|
|
self.save_write(objs)
|
|
|
|
def edit_objects(self, objs, fields):
|
|
"""Dump a set of Model objects to a file as text, ask the user
|
|
to edit it, and apply any changes to the objects.
|
|
|
|
Return a boolean indicating whether the edit succeeded.
|
|
"""
|
|
# Get the content to edit as raw data structures.
|
|
old_data = [flatten(o, fields) for o in objs]
|
|
|
|
# Set up a temporary file with the initial data for editing.
|
|
new = NamedTemporaryFile(suffix='.yaml', delete=False)
|
|
old_str = dump(old_data)
|
|
new.write(old_str)
|
|
new.close()
|
|
|
|
# Loop until we have parseable data and the user confirms.
|
|
try:
|
|
while True:
|
|
# Ask the user to edit the data.
|
|
edit(new.name)
|
|
|
|
# Read the data back after editing and check whether anything
|
|
# changed.
|
|
with open(new.name) as f:
|
|
new_str = f.read()
|
|
if new_str == old_str:
|
|
ui.print_("No changes; aborting.")
|
|
return False
|
|
|
|
# Parse the updated data.
|
|
try:
|
|
new_data = load(new_str)
|
|
except yaml.YAMLError as e:
|
|
ui.print_("Invalid YAML: {}".format(e))
|
|
if ui.input_yn("Edit again to fix? (Y/n)", True):
|
|
continue
|
|
else:
|
|
return False
|
|
|
|
# Show the changes.
|
|
self.apply_data(objs, old_data, new_data)
|
|
changed = False
|
|
for obj in objs:
|
|
changed |= ui.show_model_changes(obj)
|
|
if not changed:
|
|
ui.print_('No changes to apply.')
|
|
return False
|
|
|
|
# Confirm the changes.
|
|
choice = ui.input_options(
|
|
('continue Editing', 'apply', 'cancel')
|
|
)
|
|
if choice == 'a': # Apply.
|
|
return True
|
|
elif choice == 'c': # Cancel.
|
|
return False
|
|
elif choice == 'e': # Keep editing.
|
|
# Reset the temporary changes to the objects.
|
|
for obj in objs:
|
|
obj.read()
|
|
continue
|
|
|
|
# Remove the temporary file before returning.
|
|
finally:
|
|
os.remove(new.name)
|
|
|
|
def apply_data(self, objs, old_data, new_data):
|
|
"""Take potentially-updated data and apply it to a set of Model
|
|
objects.
|
|
|
|
The objects are not written back to the database, so the changes
|
|
are temporary.
|
|
"""
|
|
if len(old_data) != len(new_data):
|
|
self._log.warn('number of objects changed from {} to {}',
|
|
len(old_data), len(new_data))
|
|
|
|
obj_by_id = {o.id: o for o in objs}
|
|
ignore_fields = self.config['ignore_fields'].as_str_seq()
|
|
for old_dict, new_dict in zip(old_data, new_data):
|
|
# Prohibit any changes to forbidden fields to avoid
|
|
# clobbering `id` and such by mistake.
|
|
forbidden = False
|
|
for key in ignore_fields:
|
|
if old_dict.get(key) != new_dict.get(key):
|
|
self._log.warn('ignoring object whose {} changed', key)
|
|
forbidden = True
|
|
break
|
|
if forbidden:
|
|
continue
|
|
|
|
id = int(old_dict['id'])
|
|
apply(obj_by_id[id], new_dict)
|
|
|
|
def save_write(self, objs):
|
|
"""Save a list of updated Model objects to the database.
|
|
"""
|
|
# Save to the database and possibly write tags.
|
|
for ob in objs:
|
|
if ob._dirty:
|
|
self._log.debug('saving changes to {}', ob)
|
|
ob.try_sync(ui.should_write())
|