raoul/openlp
1
0
Fork 0
forked from openlp/openlp
Code Issues Pull Requests Projects Releases Wiki Activity

centralize warning message

Browse Source
This commit is contained in:
STEPHANVS 2022-02-16 19:37:18 +01:00
parent b0d34f3f19
commit 35952e587c
No known key found for this signature in database
GPG Key ID: 4EFE47E471FD62A9
3 changed files with 28 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
openlp/plugins/songs/forms/editsongform.py
View File

@ -28,15 +28,16 @@ from shutil import copyfile
from PyQt5 import QtCore, QtWidgets, QtGui
from openlp.core.state import State
from openlp.core.common.applocation import AppLocation
from openlp.core.common.i18n import UiStrings, get_natural_key, translate
from openlp.core.common.mixins import RegistryProperties
from openlp.core.common.path import create_paths
from openlp.core.common.registry import Registry
from openlp.core.lib import MediaType, create_separated_list
from openlp.core.lib.formattingtags import FormattingTags
from openlp.core.lib.plugin import PluginStatus
from openlp.core.lib.ui import critical_error_message_box, find_and_set_in_combo_box, set_case_insensitive_completer
from openlp.core.state import State
from openlp.core.widgets.dialogs import FileDialog
from openlp.plugins.songs.forms.editsongdialog import Ui_EditSongDialog
from openlp.plugins.songs.forms.editverseform import EditVerseForm
@ -44,8 +45,7 @@ from openlp.plugins.songs.forms.mediafilesform import MediaFilesForm
from openlp.plugins.songs.lib import VerseType, clean_song
from openlp.plugins.songs.lib.db import Author, AuthorType, Book, MediaFile, Song, SongBookEntry, Topic
from openlp.plugins.songs.lib.openlyricsxml import SongXML
from openlp.plugins.songs.lib.ui import SongStrings
from openlp.core.lib.formattingtags import FormattingTags
from openlp.plugins.songs.lib.ui import SongStrings, show_key_warning
log = logging.getLogger(__name__)
@ -258,14 +258,8 @@ class EditSongForm(QtWidgets.QDialog, Ui_EditSongDialog, RegistryProperties):
if not self._validate_tags(tags):
misplaced_tags.append('{field1} {field2}'.format(field1=VerseType.translated_name(field[0]),
field2=field[1:]))
if Registry().get('settings').value('songs/enable chords') and \
Registry().get('settings').value('songs/warn about missing song key') and len(chords) > 0 and \
not chords[0].startswith("="):
QtWidgets.QMessageBox.warning(self, translate('SongsPlugin.EditVerseForm', 'Song key warning'),
translate('SongsPlugin.EditVerseForm', 'No song key is present or song key '
'is not the first chord.\nFor optimal chord experience, please, '
'include a song key\nbefore any chord. Ex.: [=G]'
'You can disable this warning message in songs settings.'))
if chords and not chords[0].startswith("="):
show_key_warning(self)
if misplaced_tags:
critical_error_message_box(
message=translate('SongsPlugin.EditSongForm',

21
openlp/plugins/songs/forms/editverseform.py
View File

@ -29,6 +29,7 @@ from openlp.core.common.registry import Registry
from openlp.core.lib.ui import critical_error_message_box
from openlp.plugins.songs.forms.editversedialog import Ui_EditVerseDialog
from openlp.plugins.songs.lib import VerseType, transpose_lyrics
from openlp.plugins.songs.ui import show_key_warning
log = logging.getLogger(__name__)
@ -125,14 +126,8 @@ class EditVerseForm(QtWidgets.QDialog, Ui_EditVerseDialog):
lyrics_stripped = re.sub(r'\[---\]', "\n", re.sub(r'---\[.*?\]---', "\n", re.sub(r'\[--}{--\]', "\n",
self.verse_text_edit.toPlainText())))
chords = re.findall(r'\[(.*?)\]', lyrics_stripped)
if Registry().get('settings').value('songs/warn about missing song key') and chords and len(chords) > 0 and\
not chords[0].startswith("="):
QtWidgets.QMessageBox.warning(self, translate('SongsPlugin.EditVerseForm', 'Song key warning'),
translate('SongsPlugin.EditVerseForm',
'No song key is present or song key is not the first '
'chord.\nFor optimal chord experience, please, include a '
'song key\nbefore any chord. Ex.: [=G]\n'
'You can disable this warning message in songs settings.'))
if chords and not chords[0].startswith("="):
show_key_warning(self)
transposed_lyrics = transpose_lyrics(self.verse_text_edit.toPlainText(), 1)
self.verse_text_edit.setPlainText(transposed_lyrics)
except KeyError as ke:
@ -153,14 +148,8 @@ class EditVerseForm(QtWidgets.QDialog, Ui_EditVerseDialog):
lyrics_stripped = re.sub(r'\[---\]', "\n", re.sub(r'---\[.*?\]---', "\n", re.sub(r'\[--}{--\]', "\n",
self.verse_text_edit.toPlainText())))
chords = re.findall(r'\[(.*?)\]', lyrics_stripped)
if Registry().get('settings').value('songs/warn about missing song key') and chords and len(chords) > 0 and\
not chords[0].startswith("="):
QtWidgets.QMessageBox.warning(self, translate('SongsPlugin.EditVerseForm', 'Song key warning'),
translate('SongsPlugin.EditVerseForm',
'No song key is present or song key is not the first '
'chord.\nFor optimal chord experience, please, include a '
'song key\nbefore any chord. Ex.: [=G]\n'
'You can disable this warning message in songs settings.'))
if chords and not chords[0].startswith("="):
show_key_warning(self)
transposed_lyrics = transpose_lyrics(self.verse_text_edit.toPlainText(), -1)
self.verse_text_edit.setPlainText(transposed_lyrics)
except KeyError as ke:

18
openlp/plugins/songs/lib/ui.py
View File

@ -22,7 +22,10 @@
The :mod:`openlp.plugins.songs.lib.ui` module provides standard UI components
for the songs plugin.
"""
from PyQt5 import QtWidgets
from openlp.core.common.i18n import translate
from openlp.core.common.registry import Registry
class SongStrings(object):
@ -41,3 +44,18 @@ class SongStrings(object):
Topic = translate('OpenLP.Ui', 'Topic', 'Singular')
Topics = translate('OpenLP.Ui', 'Topics', 'Plural')
XMLSyntaxError = translate('OpenLP.Ui', 'XML syntax error')
def show_key_warning(parent):
"""
Check the settings to see if we need to show the warning message, and then show a warning about the key of the song
"""
if Registry().get('settings').value('songs/enable chords') and \
Registry().get('settings').value('songs/warn about missing song key'):
QtWidgets.QMessageBox.warning(
parent,
translate('SongsPlugin.UI', 'Song key warning'),
translate('SongsPlugin.UI', 'No musical key has been detected for this song, it should be placed before '
'the first chord.\nFor an optimal chord experience, please include a song key at the beginning '
'of the song. For example: [=G]\n\nYou can disable this warning message in songs settings.')
)