From aa252cf3e1518279db8c104c8dc86a4cf24181c6 Mon Sep 17 00:00:00 2001 From: ShubhamBhut Date: Sun, 7 Apr 2024 07:48:44 +0530 Subject: [PATCH] PICARD-2729: Allow disabling date sanitazation for APE and Vorbis tags --- picard/formats/apev2.py | 6 ++- picard/formats/id3.py | 11 ++-- picard/formats/util.py | 6 +++ picard/formats/vorbis.py | 9 +++- picard/profile.py | 1 + picard/ui/options/metadata.py | 6 +++ picard/ui/widgets/multicombobox.py | 80 ++++++++++++++++++++++++++++++ test/formats/common.py | 1 + ui/options_metadata.ui | 5 ++ 9 files changed, 119 insertions(+), 6 deletions(-) create mode 100644 picard/ui/widgets/multicombobox.py diff --git a/picard/formats/apev2.py b/picard/formats/apev2.py index 777fd7c0f28..0b4edb997ba 100644 --- a/picard/formats/apev2.py +++ b/picard/formats/apev2.py @@ -125,6 +125,7 @@ class APEv2File(File): 'replaygain_reference_loudness': 'REPLAYGAIN_REFERENCE_LOUDNESS', } __rtranslate = {v.lower(): k for k, v in __translate.items()} + sanitize_date = sanitize_date def __init__(self, filename): super().__init__(filename) @@ -136,6 +137,8 @@ def _load(self, filename): file = self._File(encode_filename(filename)) metadata = Metadata() if file.tags: + config = get_config() + date_sanitize = self.NAME not in config.setting['formats_to_disable_date_sanitize'] for origname, values in file.tags.items(): name_lower = origname.lower() if (values.kind == mutagen.apev2.BINARY @@ -160,7 +163,8 @@ def _load(self, filename): name = name_lower if name == 'year': name = 'date' - value = sanitize_date(value) + if date_sanitize: + value = sanitize_date(value) elif name == 'track': name = 'tracknumber' track = value.split('/') diff --git a/picard/formats/id3.py b/picard/formats/id3.py index 94a5b7b67e7..fcc8c5a4eac 100644 --- a/picard/formats/id3.py +++ b/picard/formats/id3.py @@ -248,6 +248,7 @@ class ID3File(File): __lrc_line_re_parse = re.compile(r'(\[\d\d:\d\d\.\d\d\d\])') __lrc_syllable_re_parse = re.compile(r'(<\d\d:\d\d\.\d\d\d>)') __lrc_both_re_parse = re.compile(r'(\[\d\d:\d\d\.\d\d\d\]|<\d\d:\d\d\.\d\d\d>)') + sanitize_date = sanitize_date def __init__(self, filename): super().__init__(filename) @@ -278,6 +279,7 @@ def _load(self, filename): f = tags.pop(old) tags.add(getattr(id3, new)(encoding=f.encoding, text=f.text)) metadata = Metadata() + date_sanitize = self.NAME not in config.setting['formats_to_disable_date_sanitize'] for frame in tags.values(): frameid = frame.FrameID if frameid in self.__translate: @@ -395,9 +397,12 @@ def _load(self, filename): metadata.add('~rating', rating) if 'date' in metadata: - sanitized = sanitize_date(metadata.getall('date')[0]) - if sanitized: - metadata['date'] = sanitized + if date_sanitize: + sanitized = sanitize_date(metadata.getall('date')[0]) + if sanitized: + metadata['date'] = sanitized + else: + metadata['date'] = metadata.getall('date')[0] self._info(metadata, file) return metadata diff --git a/picard/formats/util.py b/picard/formats/util.py index f4cca633fbe..2e6801a5b68 100644 --- a/picard/formats/util.py +++ b/picard/formats/util.py @@ -45,6 +45,12 @@ def supported_formats(): return [(file_format.EXTENSIONS, file_format.NAME) for file_format in _formats] +def formats_with_sanitize_date(): + for fmt in _formats: + if hasattr(fmt, 'sanitize_date'): + yield fmt + + def supported_extensions(): """Returns list of supported extensions.""" return [ext for exts, name in supported_formats() for ext in exts] diff --git a/picard/formats/vorbis.py b/picard/formats/vorbis.py index 25ac86d5175..01927ef4d2c 100644 --- a/picard/formats/vorbis.py +++ b/picard/formats/vorbis.py @@ -129,6 +129,7 @@ class VCommentFile(File): 'waveformatextensible_channel_mask': '~waveformatextensible_channel_mask', } __rtranslate = {v: k for k, v in __translate.items()} + sanitize_date = sanitize_date def _load(self, filename): log.debug("Loading file %r", filename) @@ -136,13 +137,16 @@ def _load(self, filename): file = self._File(encode_filename(filename)) file.tags = file.tags or {} metadata = Metadata() + config = get_config() + date_sanitize = self.NAME not in config.setting['formats_to_disable_date_sanitize'] for origname, values in file.tags.items(): for value in values: value = value.rstrip('\0') name = origname if name in {'date', 'originaldate', 'releasedate'}: # YYYY-00-00 => YYYY - value = sanitize_date(value) + if date_sanitize: + value = sanitize_date(value) elif name == 'performer' or name == 'comment': # transform "performer=Joe Barr (Piano)" to "performer:Piano=Joe Barr" name += ':' @@ -280,7 +284,8 @@ def _save(self, filename, metadata): name = 'lyrics' elif name in {'date', 'originaldate', 'releasedate'}: # YYYY-00-00 => YYYY - value = sanitize_date(value) + if self.NAME not in config.setting['formats_to_disable_date_sanitize']: + value = sanitize_date(value) elif name.startswith('performer:') or name.startswith('comment:'): # transform "performer:Piano=Joe Barr" to "performer=Joe Barr (Piano)" name, desc = name.split(':', 1) diff --git a/picard/profile.py b/picard/profile.py index 63ca5eeb3c2..7cb564cbf9b 100644 --- a/picard/profile.py +++ b/picard/profile.py @@ -69,6 +69,7 @@ class UserProfileGroups(): SettingDesc('convert_punctuation', ['convert_punctuation']), SettingDesc('release_ars', ['release_ars']), SettingDesc('track_ars', ['track_ars']), + SettingDesc('formats_to_disable_date_sanitize', ['selected_formats']), SettingDesc('guess_tracknumber_and_title', ['guess_tracknumber_and_title']), SettingDesc('va_name', ['va_name']), SettingDesc('nat_name', ['nat_name']), diff --git a/picard/ui/options/metadata.py b/picard/ui/options/metadata.py index 78090a7fa92..ed164e024c2 100644 --- a/picard/ui/options/metadata.py +++ b/picard/ui/options/metadata.py @@ -44,6 +44,7 @@ SCRIPTS, scripts_sorted_by_localized_name, ) +from picard.formats.util import formats_with_sanitize_date from picard.i18n import ( N_, gettext as _, @@ -97,6 +98,7 @@ class MetadataOptionsPage(OptionsPage): ListOption('setting', 'script_exceptions', [], title=N_("Translation script exceptions")), BoolOption('setting', 'release_ars', True, title=N_("Use release relationships")), BoolOption('setting', 'track_ars', False, title=N_("Use track and release relationships")), + Option('setting', 'formats_to_disable_date_sanitize', set(), title=N_("Formats to disable date sanitize")), BoolOption('setting', 'convert_punctuation', False, title=N_("Convert Unicode punctuation characters to ASCII")), BoolOption('setting', 'standardize_artists', False, title=N_("Use standardized artist names")), BoolOption('setting', 'standardize_instruments', True, title=N_("Use standardized instrument and vocal credits")), @@ -122,6 +124,9 @@ def load(self): self.current_scripts = config.setting['script_exceptions'] self.make_scripts_text() self.ui.translate_artist_names_script_exception.setChecked(config.setting['translate_artist_names_script_exception']) + self.current_formats = config.setting['formats_to_disable_date_sanitize'] + fmt_names = sorted(fmt.NAME for fmt in formats_with_sanitize_date()) + self.ui.selected_formats.addItems(fmt_names) self.ui.convert_punctuation.setChecked(config.setting['convert_punctuation']) self.ui.release_ars.setChecked(config.setting['release_ars']) @@ -157,6 +162,7 @@ def save(self): config.setting['convert_punctuation'] = self.ui.convert_punctuation.isChecked() config.setting['release_ars'] = self.ui.release_ars.isChecked() config.setting['track_ars'] = self.ui.track_ars.isChecked() + config.setting['formats_to_disable_date_sanitize'] = self.current_formats config.setting['va_name'] = self.ui.va_name.text() nat_name = self.ui.nat_name.text() if nat_name != config.setting['nat_name']: diff --git a/picard/ui/widgets/multicombobox.py b/picard/ui/widgets/multicombobox.py new file mode 100644 index 00000000000..bbdb8710233 --- /dev/null +++ b/picard/ui/widgets/multicombobox.py @@ -0,0 +1,80 @@ +# -*- coding: utf-8 -*- +# +# Picard, the next-generation MusicBrainz tagger +# +# Copyright (C) 2024 Shubham Patel +# +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License +# as published by the Free Software Foundation; either version 2 +# of the License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + + +from PyQt6.QtCore import Qt +from PyQt6.QtGui import ( + QStandardItem, + QStandardItemModel, +) +from PyQt6.QtWidgets import QComboBox + + +class MultiComboBox(QComboBox): + def __init__(self, parent=None): + super().__init__(parent) + self.setEditable(True) + self.lineEdit().setReadOnly(True) + self.setModel(QStandardItemModel(self)) + + # Connect to the dataChanged signal to update the text + self.model().dataChanged.connect(self.updateText) + + def addItem(self, text: str, data=None): + item = QStandardItem() + item.setText(text) + item.setFlags(Qt.ItemFlag.ItemIsEnabled | Qt.ItemFlag.ItemIsUserCheckable) + item.setData(Qt.CheckState.Unchecked, Qt.ItemDataRole.CheckStateRole) + self.model().appendRow(item) + + def addItems(self, items_list: list): + for text in items_list: + self.addItem(text) + + def updateText(self): + selected_items = [self.model().item(i).text() for i in range(self.model().rowCount()) + if self.model().item(i).checkState() == Qt.CheckState.Checked] + self.lineEdit().setText(", ".join(selected_items)) + + def show_selected_items(self): + selected_items = [self.model().item(i).text() for i in range(self.model().rowCount()) + if self.model().item(i).checkState() == Qt.CheckState.Checked] + return selected_items + + def showPopup(self): + super().showPopup() + # Set the state of each item in the dropdown + for i in range(self.model().rowCount()): + item = self.model().item(i) + combo_box_view = self.view() + combo_box_view.setRowHidden(i, False) + check_box = combo_box_view.indexWidget(item.index()) + if check_box: + check_box.setChecked(item.checkState() == Qt.CheckState.Checked) + + def hidePopup(self): + # Update the check state of each item based on the checkbox state + for i in range(self.model().rowCount()): + item = self.model().item(i) + combo_box_view = self.view() + check_box = combo_box_view.indexWidget(item.index()) + if check_box: + item.setCheckState(Qt.CheckState.Checked if check_box.isChecked() else Qt.CheckState.Unchecked) + super().hidePopup() diff --git a/test/formats/common.py b/test/formats/common.py index b4459e88f0b..24655377928 100644 --- a/test/formats/common.py +++ b/test/formats/common.py @@ -65,6 +65,7 @@ 'replace_spaces_with_underscores': False, 'replace_dir_separator': '_', 'win_compat_replacements': {}, + 'formats_to_disable_date_sanitize': [], } diff --git a/ui/options_metadata.ui b/ui/options_metadata.ui index e92a3332d1a..b24c57ec933 100644 --- a/ui/options_metadata.ui +++ b/ui/options_metadata.ui @@ -130,6 +130,10 @@ + + + + @@ -225,6 +229,7 @@ release_ars track_ars guess_tracknumber_and_title + selected_formats va_name va_name_default nat_name