1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
# This file is part of beets.
# Copyright 2016, Blemjhoo Tezoulbr <baobab@heresiarch.info>.
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
"""Clears tag fields in media files."""
import re
import confuse
from mediafile import MediaFile
from beets.importer import Action
from beets.plugins import BeetsPlugin
from beets.ui import Subcommand, input_yn
__author__ = "baobab@heresiarch.info"
class ZeroPlugin(BeetsPlugin):
def __init__(self):
super().__init__()
self.register_listener("write", self.write_event)
self.register_listener(
"import_task_choice", self.import_task_choice_event
)
self.config.add(
{
"auto": True,
"fields": [],
"keep_fields": [],
"update_database": False,
"omit_single_disc": False,
}
)
self.fields_to_progs = {}
self.warned = False
"""Read the bulk of the config into `self.fields_to_progs`.
After construction, `fields_to_progs` contains all the fields that
should be zeroed as keys and maps each of those to a list of compiled
regexes (progs) as values.
A field is zeroed if its value matches one of the associated progs. If
progs is empty, then the associated field is always zeroed.
"""
if self.config["fields"] and self.config["keep_fields"]:
self._log.warning("cannot blacklist and whitelist at the same time")
# Blacklist mode.
elif self.config["fields"]:
for field in self.config["fields"].as_str_seq():
self._set_pattern(field)
# Whitelist mode.
elif self.config["keep_fields"]:
for field in MediaFile.fields():
if (
field not in self.config["keep_fields"].as_str_seq()
and
# These fields should always be preserved.
field not in ("id", "path", "album_id")
):
self._set_pattern(field)
def commands(self):
zero_command = Subcommand("zero", help="set fields to null")
def zero_fields(lib, opts, args):
if not args and not input_yn(
"Remove fields for all items? (Y/n)", True
):
return
for item in lib.items(args):
self.process_item(item)
zero_command.func = zero_fields
return [zero_command]
def _set_pattern(self, field):
"""Populate `self.fields_to_progs` for a given field.
Do some sanity checks then compile the regexes.
"""
if field not in MediaFile.fields():
self._log.error("invalid field: {}", field)
elif field in ("id", "path", "album_id"):
self._log.warning(
"field '{}' ignored, zeroing it would be dangerous", field
)
else:
try:
for pattern in self.config[field].as_str_seq():
prog = re.compile(pattern, re.IGNORECASE)
self.fields_to_progs.setdefault(field, []).append(prog)
except confuse.NotFoundError:
# Matches everything
self.fields_to_progs[field] = []
def import_task_choice_event(self, session, task):
if task.choice_flag == Action.ASIS and not self.warned:
self._log.warning('cannot zero in "as-is" mode')
self.warned = True
# TODO request write in as-is mode
def write_event(self, item, path, tags):
if self.config["auto"]:
self.set_fields(item, tags)
def set_fields(self, item, tags):
"""Set values in `tags` to `None` if the field is in
`self.fields_to_progs` and any of the corresponding `progs` matches the
field value.
Also update the `item` itself if `update_database` is set in the
config.
"""
fields_set = False
if "disc" in tags and self.config["omit_single_disc"].get(bool):
if item.disctotal == 1:
fields_set = True
self._log.debug("disc: {.disc} -> None", item)
tags["disc"] = None
if not self.fields_to_progs:
self._log.warning("no fields list to remove")
for field, progs in self.fields_to_progs.items():
if field in tags:
value = tags[field]
match = _match_progs(tags[field], progs)
else:
value = ""
match = not progs
if match:
fields_set = True
self._log.debug("{}: {} -> None", field, value)
tags[field] = None
if self.config["update_database"]:
item[field] = None
return fields_set
def process_item(self, item):
tags = dict(item)
if self.set_fields(item, tags):
item.write(tags=tags)
if self.config["update_database"]:
item.store(fields=tags)
def _match_progs(value, progs):
"""Check if `value` (as string) is matching any of the compiled regexes in
the `progs` list.
"""
if not progs:
return True
for prog in progs:
if prog.search(str(value)):
return True
return False
|
