diff --git a/.bzrignore b/.bzrignore index b7dffe4fb..97af7bea6 100644 --- a/.bzrignore +++ b/.bzrignore @@ -45,3 +45,4 @@ cover *.kdev4 coverage tags +output diff --git a/openlp/core/common/__init__.py b/openlp/core/common/__init__.py index b8a1a4d2e..f3076a86f 100644 --- a/openlp/core/common/__init__.py +++ b/openlp/core/common/__init__.py @@ -24,6 +24,7 @@ The :mod:`common` module contains most of the components and libraries that make OpenLP work. """ import hashlib + import logging import os import re @@ -31,6 +32,7 @@ import sys import traceback from ipaddress import IPv4Address, IPv6Address, AddressValueError from shutil import which +from subprocess import check_output, CalledProcessError, STDOUT from PyQt5 import QtCore, QtGui from PyQt5.QtCore import QCryptographicHash as QHash @@ -247,6 +249,9 @@ from .applocation import AppLocation from .actions import ActionList from .languagemanager import LanguageManager +if is_win(): + from subprocess import STARTUPINFO, STARTF_USESHOWWINDOW + def add_actions(target, actions): """ @@ -371,3 +376,28 @@ def clean_filename(filename): if not isinstance(filename, str): filename = str(filename, 'utf-8') return INVALID_FILE_CHARS.sub('_', CONTROL_CHARS.sub('', filename)) + + +def check_binary_exists(program_path): + """ + Function that checks whether a binary exists. + + :param program_path:The full path to the binary to check. + :return: program output to be parsed + """ + log.debug('testing program_path: %s', program_path) + try: + # Setup startupinfo options for check_output to avoid console popping up on windows + if is_win(): + startupinfo = STARTUPINFO() + startupinfo.dwFlags |= STARTF_USESHOWWINDOW + else: + startupinfo = None + runlog = check_output([program_path, '--help'], stderr=STDOUT, startupinfo=startupinfo) + except CalledProcessError as e: + runlog = e.output + except Exception: + trace_error_handler(log) + runlog = '' + log.debug('check_output returned: %s' % runlog) + return runlog diff --git a/openlp/core/common/settings.py b/openlp/core/common/settings.py index 8b7e0afb4..84fc6db96 100644 --- a/openlp/core/common/settings.py +++ b/openlp/core/common/settings.py @@ -182,13 +182,15 @@ class Settings(QtCore.QSettings): 'themes/wrap footer': False, 'user interface/live panel': True, 'user interface/live splitter geometry': QtCore.QByteArray(), - 'user interface/lock panel': False, + 'user interface/lock panel': True, 'user interface/main window geometry': QtCore.QByteArray(), 'user interface/main window position': QtCore.QPoint(0, 0), 'user interface/main window splitter geometry': QtCore.QByteArray(), 'user interface/main window state': QtCore.QByteArray(), 'user interface/preview panel': True, 'user interface/preview splitter geometry': QtCore.QByteArray(), + 'user interface/is preset layout': False, + 'projector/show after wizard': False, 'projector/db type': 'sqlite', 'projector/db username': '', 'projector/db password': '', diff --git a/openlp/core/ui/firsttimewizard.py b/openlp/core/ui/firsttimewizard.py index 61b82780b..9f740e5cf 100644 --- a/openlp/core/ui/firsttimewizard.py +++ b/openlp/core/ui/firsttimewizard.py @@ -24,7 +24,7 @@ The UI widgets for the first time wizard. """ from PyQt5 import QtCore, QtGui, QtWidgets -from openlp.core.common import translate, is_macosx, clean_button_text +from openlp.core.common import translate, is_macosx, clean_button_text, Settings from openlp.core.lib import build_icon from openlp.core.lib.ui import add_welcome_page @@ -136,6 +136,13 @@ class UiFirstTimeWizard(object): self.alert_check_box.setChecked(True) self.alert_check_box.setObjectName('alert_check_box') self.plugin_layout.addWidget(self.alert_check_box) + self.projectors_check_box = QtWidgets.QCheckBox(self.plugin_page) + # If visibility setting for projector panel is True, check the box. + if Settings().value('projector/show after wizard'): + self.projectors_check_box.setChecked(True) + self.projectors_check_box.setObjectName('projectors_check_box') + self.projectors_check_box.clicked.connect(self.on_projectors_check_box_clicked) + self.plugin_layout.addWidget(self.projectors_check_box) first_time_wizard.setPage(FirstTimePage.Plugins, self.plugin_page) # The song samples page self.songs_page = QtWidgets.QWizardPage() @@ -232,17 +239,28 @@ class UiFirstTimeWizard(object): 'downloaded.')) self.download_label.setText(translate('OpenLP.FirstTimeWizard', 'Please wait while OpenLP downloads the ' 'resource index file...')) - self.plugin_page.setTitle(translate('OpenLP.FirstTimeWizard', 'Activate required Plugins')) - self.plugin_page.setSubTitle(translate('OpenLP.FirstTimeWizard', 'Select the Plugins you wish to use. ')) + self.plugin_page.setTitle(translate('OpenLP.FirstTimeWizard', 'Select parts of the program you wish to use')) + self.plugin_page.setSubTitle(translate('OpenLP.FirstTimeWizard', + 'You can also change these settings after the Wizard.')) self.songs_check_box.setText(translate('OpenLP.FirstTimeWizard', 'Songs')) - self.custom_check_box.setText(translate('OpenLP.FirstTimeWizard', 'Custom Slides')) - self.bible_check_box.setText(translate('OpenLP.FirstTimeWizard', 'Bible')) - self.image_check_box.setText(translate('OpenLP.FirstTimeWizard', 'Images')) - self.presentation_check_box.setText(translate('OpenLP.FirstTimeWizard', 'Presentations')) - self.media_check_box.setText(translate('OpenLP.FirstTimeWizard', 'Media (Audio and Video)')) - self.remote_check_box.setText(translate('OpenLP.FirstTimeWizard', 'Allow remote access')) - self.song_usage_check_box.setText(translate('OpenLP.FirstTimeWizard', 'Monitor Song Usage')) - self.alert_check_box.setText(translate('OpenLP.FirstTimeWizard', 'Allow Alerts')) + self.custom_check_box.setText(translate('OpenLP.FirstTimeWizard', + 'Custom Slides – Easier to manage than songs and they have their own' + ' list of slides')) + self.bible_check_box.setText(translate('OpenLP.FirstTimeWizard', + 'Bibles – Import and show Bibles')) + self.image_check_box.setText(translate('OpenLP.FirstTimeWizard', + 'Images – Show images or replace background with them')) + self.presentation_check_box.setText(translate('OpenLP.FirstTimeWizard', + 'Presentations – Show .ppt, .odp and .pdf files')) + self.media_check_box.setText(translate('OpenLP.FirstTimeWizard', 'Media – Playback of Audio and Video files')) + self.remote_check_box.setText(translate('OpenLP.FirstTimeWizard', 'Remote – Control OpenLP via browser or smart' + 'phone app')) + self.song_usage_check_box.setText(translate('OpenLP.FirstTimeWizard', 'Song Usage Monitor')) + self.alert_check_box.setText(translate('OpenLP.FirstTimeWizard', + 'Alerts – Display informative messages while showing other slides')) + self.projectors_check_box.setText(translate('OpenLP.FirstTimeWizard', + 'Projectors – Control PJLink compatible projects on your network' + ' from OpenLP')) self.no_internet_page.setTitle(translate('OpenLP.FirstTimeWizard', 'No Internet Connection')) self.no_internet_page.setSubTitle( translate('OpenLP.FirstTimeWizard', 'Unable to detect an Internet connection.')) @@ -277,3 +295,10 @@ class UiFirstTimeWizard(object): clean_button_text(first_time_wizard.buttonText(QtWidgets.QWizard.FinishButton))) first_time_wizard.setButtonText(QtWidgets.QWizard.CustomButton2, clean_button_text(first_time_wizard.buttonText(QtWidgets.QWizard.CancelButton))) + + def on_projectors_check_box_clicked(self): + # When clicking projectors_check box, change the visibility setting for Projectors panel. + if Settings().value('projector/show after wizard'): + Settings().setValue('projector/show after wizard', False) + else: + Settings().setValue('projector/show after wizard', True) diff --git a/openlp/core/ui/lib/wizard.py b/openlp/core/ui/lib/wizard.py index 3835056fb..5f2321f48 100644 --- a/openlp/core/ui/lib/wizard.py +++ b/openlp/core/ui/lib/wizard.py @@ -45,6 +45,7 @@ class WizardStrings(object): OS = 'OpenSong' OSIS = 'OSIS' ZEF = 'Zefania' + SWORD = 'Sword' # These strings should need a good reason to be retranslated elsewhere. FinishedImport = translate('OpenLP.Ui', 'Finished import.') FormatLabel = translate('OpenLP.Ui', 'Format:') @@ -113,7 +114,7 @@ class OpenLPWizard(QtWidgets.QWizard, RegistryProperties): Set up the wizard UI. :param image: path to start up image """ - self.setWindowIcon(build_icon(u':/icon/openlp-logo.svg')) + self.setWindowIcon(build_icon(':/icon/openlp-logo.svg')) self.setModal(True) self.setOptions(QtWidgets.QWizard.IndependentPages | QtWidgets.QWizard.NoBackButtonOnStartPage | QtWidgets.QWizard.NoBackButtonOnLastPage) diff --git a/openlp/core/ui/mainwindow.py b/openlp/core/ui/mainwindow.py index b13f1c187..39e0ac518 100644 --- a/openlp/core/ui/mainwindow.py +++ b/openlp/core/ui/mainwindow.py @@ -640,13 +640,15 @@ class MainWindow(QtWidgets.QMainWindow, Ui_MainWindow, RegistryProperties): self.open_cmd_line_files(self.arguments) elif Settings().value(self.general_settings_section + '/auto open'): self.service_manager_contents.load_last_file() + # This will store currently used layout preset so it remains enabled on next startup. + # If any panel is enabled/disabled after preset is set, this setting is not saved. view_mode = Settings().value('%s/view mode' % self.general_settings_section) - if view_mode == 'default': + if view_mode == 'default' and Settings().value('user interface/is preset layout'): self.mode_default_item.setChecked(True) - elif view_mode == 'setup': + elif view_mode == 'setup' and Settings().value('user interface/is preset layout'): self.set_view_mode(True, True, False, True, False, True) self.mode_setup_item.setChecked(True) - elif view_mode == 'live': + elif view_mode == 'live' and Settings().value('user interface/is preset layout'): self.set_view_mode(False, True, False, False, True, True) self.mode_live_item.setChecked(True) @@ -698,6 +700,11 @@ class MainWindow(QtWidgets.QMainWindow, Ui_MainWindow, RegistryProperties): return self.application.set_busy_cursor() self.first_time() + # Check if Projectors panel should be visible or not after wizard. + if Settings().value('projector/show after wizard'): + self.projector_manager_dock.setVisible(True) + else: + self.projector_manager_dock.setVisible(False) for plugin in self.plugin_manager.plugins: self.active_plugin = plugin old_status = self.active_plugin.status @@ -1029,18 +1036,24 @@ class MainWindow(QtWidgets.QMainWindow, Ui_MainWindow, RegistryProperties): Put OpenLP into "Default" view mode. """ self.set_view_mode(True, True, True, True, True, True, 'default') + Settings().setValue('user interface/is preset layout', True) + Settings().setValue('projector/show after wizard', True) def on_mode_setup_item_clicked(self): """ Put OpenLP into "Setup" view mode. """ self.set_view_mode(True, True, False, True, False, True, 'setup') + Settings().setValue('user interface/is preset layout', True) + Settings().setValue('projector/show after wizard', True) def on_mode_live_item_clicked(self): """ Put OpenLP into "Live" view mode. """ self.set_view_mode(False, True, False, False, True, True, 'live') + Settings().setValue('user interface/is preset layout', True) + Settings().setValue('projector/show after wizard', True) def set_view_mode(self, media=True, service=True, theme=True, preview=True, live=True, projector=True, mode=''): """ @@ -1178,24 +1191,33 @@ class MainWindow(QtWidgets.QMainWindow, Ui_MainWindow, RegistryProperties): Toggle the visibility of the media manager """ self.media_manager_dock.setVisible(not self.media_manager_dock.isVisible()) + Settings().setValue('user interface/is preset layout', False) def toggle_projector_manager(self): """ Toggle visibility of the projector manager """ self.projector_manager_dock.setVisible(not self.projector_manager_dock.isVisible()) + Settings().setValue('user interface/is preset layout', False) + # Check/uncheck checkbox on First time wizard based on visibility of this panel. + if not Settings().value('projector/show after wizard'): + Settings().setValue('projector/show after wizard', True) + else: + Settings().setValue('projector/show after wizard', False) def toggle_service_manager(self): """ Toggle the visibility of the service manager """ self.service_manager_dock.setVisible(not self.service_manager_dock.isVisible()) + Settings().setValue('user interface/is preset layout', False) def toggle_theme_manager(self): """ Toggle the visibility of the theme manager """ self.theme_manager_dock.setVisible(not self.theme_manager_dock.isVisible()) + Settings().setValue('user interface/is preset layout', False) def set_preview_panel_visibility(self, visible): """ @@ -1209,6 +1231,7 @@ class MainWindow(QtWidgets.QMainWindow, Ui_MainWindow, RegistryProperties): self.preview_controller.panel.setVisible(visible) Settings().setValue('user interface/preview panel', visible) self.view_preview_panel.setChecked(visible) + Settings().setValue('user interface/is preset layout', False) def set_lock_panel(self, lock): """ @@ -1219,6 +1242,7 @@ class MainWindow(QtWidgets.QMainWindow, Ui_MainWindow, RegistryProperties): self.service_manager_dock.setFeatures(QtWidgets.QDockWidget.NoDockWidgetFeatures) self.media_manager_dock.setFeatures(QtWidgets.QDockWidget.NoDockWidgetFeatures) self.projector_manager_dock.setFeatures(QtWidgets.QDockWidget.NoDockWidgetFeatures) + self.view_mode_menu.setEnabled(False) self.view_media_manager_item.setEnabled(False) self.view_service_manager_item.setEnabled(False) self.view_theme_manager_item.setEnabled(False) @@ -1230,6 +1254,7 @@ class MainWindow(QtWidgets.QMainWindow, Ui_MainWindow, RegistryProperties): self.service_manager_dock.setFeatures(QtWidgets.QDockWidget.AllDockWidgetFeatures) self.media_manager_dock.setFeatures(QtWidgets.QDockWidget.AllDockWidgetFeatures) self.projector_manager_dock.setFeatures(QtWidgets.QDockWidget.AllDockWidgetFeatures) + self.view_mode_menu.setEnabled(True) self.view_media_manager_item.setEnabled(True) self.view_service_manager_item.setEnabled(True) self.view_theme_manager_item.setEnabled(True) @@ -1250,6 +1275,7 @@ class MainWindow(QtWidgets.QMainWindow, Ui_MainWindow, RegistryProperties): self.live_controller.panel.setVisible(visible) Settings().setValue('user interface/live panel', visible) self.view_live_panel.setChecked(visible) + Settings().setValue('user interface/is preset layout', False) def load_settings(self): """ diff --git a/openlp/core/ui/media/mediacontroller.py b/openlp/core/ui/media/mediacontroller.py index d95c51531..021ea5281 100644 --- a/openlp/core/ui/media/mediacontroller.py +++ b/openlp/core/ui/media/mediacontroller.py @@ -298,7 +298,7 @@ class MediaController(RegistryMixin, OpenLPMixin, RegistryProperties): tooltip=translate('OpenLP.SlideController', 'Stop playing media.'), triggers=controller.send_to_plugins) controller.mediabar.add_toolbar_action('playbackLoop', text='media_playback_loop', - icon=':/slides/media_playback_stop.png', checked=False, + icon=':/media/media_repeat.png', checked=False, tooltip=translate('OpenLP.SlideController', 'Loop playing media.'), triggers=controller.send_to_plugins) controller.position_label = QtWidgets.QLabel() diff --git a/openlp/core/ui/projector/editform.py b/openlp/core/ui/projector/editform.py index 4b06f486f..4996cc75f 100644 --- a/openlp/core/ui/projector/editform.py +++ b/openlp/core/ui/projector/editform.py @@ -182,9 +182,10 @@ class ProjectorEditForm(QDialog, Ui_ProjectorEditForm): QtWidgets.QMessageBox.warning(self, translate('OpenLP.ProjectorEdit', 'Duplicate Name'), translate('OpenLP.ProjectorEdit', - 'There is already an entry with name "%s" in ' - 'the database as ID "%s".
' - 'Please enter a different name.' % (name, record.id))) + 'There is already an entry with name "{name}" in ' + 'the database as ID "{record}".
' + 'Please enter a different name.'.format(name=name, + record=record.id))) valid = False return adx = self.ip_text.text() @@ -198,17 +199,17 @@ class ProjectorEditForm(QDialog, Ui_ProjectorEditForm): QtWidgets.QMessageBox.warning(self, translate('OpenLP.ProjectorWizard', 'Duplicate IP Address'), translate('OpenLP.ProjectorWizard', - 'IP address "%s"
is already in the database as ID %s.' - '

Please Enter a different IP address.' % - (adx, ip.id))) + 'IP address "{ip}"
is already in the database ' + 'as ID {data}.

Please Enter a different ' + 'IP address.'.format(ip=adx, data=ip.id))) valid = False return else: QtWidgets.QMessageBox.warning(self, translate('OpenLP.ProjectorWizard', 'Invalid IP Address'), translate('OpenLP.ProjectorWizard', - 'IP address "%s"
is not a valid IP address.' - '

Please enter a valid IP address.' % adx)) + 'IP address "{ip}"
is not a valid IP address.' + '

Please enter a valid IP address.'.format(ip=adx))) valid = False return port = int(self.port_text.text()) @@ -219,8 +220,8 @@ class ProjectorEditForm(QDialog, Ui_ProjectorEditForm): 'Port numbers below 1000 are reserved for admin use only, ' '
and port numbers above 32767 are not currently usable.' '

Please enter a valid port number between ' - ' 1000 and 32767.' - '

Default PJLink port is %s' % PJLINK_PORT)) + '1000 and 32767.

' + 'Default PJLink port is {port}'.format(port=PJLINK_PORT))) valid = False if valid: self.projector.ip = self.ip_text.text() diff --git a/openlp/core/ui/projector/manager.py b/openlp/core/ui/projector/manager.py index 8efe34b10..7c56c2916 100644 --- a/openlp/core/ui/projector/manager.py +++ b/openlp/core/ui/projector/manager.py @@ -344,7 +344,7 @@ class ProjectorManager(OpenLPMixin, RegistryMixin, QWidget, Ui_ProjectorManager, real_projector = item.data(QtCore.Qt.UserRole) projector_name = str(item.text()) visible = real_projector.link.status_connect >= S_CONNECTED - log.debug('(%s) Building menu - visible = %s' % (projector_name, visible)) + log.debug('({name}) Building menu - visible = {visible}'.format(name=projector_name, visible=visible)) self.delete_action.setVisible(True) self.edit_action.setVisible(True) self.connect_action.setVisible(not visible) @@ -394,7 +394,7 @@ class ProjectorManager(OpenLPMixin, RegistryMixin, QWidget, Ui_ProjectorManager, projectordb=self.projectordb, edit=edit) source = source_select_form.exec(projector.link) - log.debug('(%s) source_select_form() returned %s' % (projector.link.ip, source)) + log.debug('({ip}) source_select_form() returned {data}'.format(ip=projector.link.ip, data=source)) if source is not None and source > 0: projector.link.set_input_source(str(source)) return @@ -473,8 +473,9 @@ class ProjectorManager(OpenLPMixin, RegistryMixin, QWidget, Ui_ProjectorManager, return projector = list_item.data(QtCore.Qt.UserRole) msg = QtWidgets.QMessageBox() - msg.setText(translate('OpenLP.ProjectorManager', 'Delete projector (%s) %s?') % (projector.link.ip, - projector.link.name)) + msg.setText(translate('OpenLP.ProjectorManager', + 'Delete projector ({ip}) {name}?'.format(ip=projector.link.ip, + name=projector.link.name))) msg.setInformativeText(translate('OpenLP.ProjectorManager', 'Are you sure you want to delete this projector?')) msg.setStandardButtons(msg.Cancel | msg.Ok) msg.setDefaultButton(msg.Cancel) @@ -522,7 +523,7 @@ class ProjectorManager(OpenLPMixin, RegistryMixin, QWidget, Ui_ProjectorManager, list_item = None deleted = self.projectordb.delete_projector(projector.db_item) for item in self.projector_list: - log.debug('New projector list - item: %s %s' % (item.link.ip, item.link.name)) + log.debug('New projector list - item: {ip} {name}'.format(ip=item.link.ip, name=item.link.name)) def on_disconnect_projector(self, opt=None): """ @@ -627,53 +628,58 @@ class ProjectorManager(OpenLPMixin, RegistryMixin, QWidget, Ui_ProjectorManager, """ lwi = self.projector_list_widget.item(self.projector_list_widget.currentRow()) projector = lwi.data(QtCore.Qt.UserRole) - message = '%s: %s
' % (translate('OpenLP.ProjectorManager', 'Name'), - projector.link.name) - message = '%s%s: %s
' % (message, translate('OpenLP.ProjectorManager', 'IP'), - projector.link.ip) - message = '%s%s: %s
' % (message, translate('OpenLP.ProjectorManager', 'Port'), - projector.link.port) - message = '%s%s: %s
' % (message, translate('OpenLP.ProjectorManager', 'Notes'), - projector.link.notes) - message = '%s

' % message + message = '{title}: {data}
'.format(title=translate('OpenLP.ProjectorManager', 'Name'), + data=projector.link.name) + message += '{title}: {data}
'.format(title=translate('OpenLP.ProjectorManager', 'IP'), + data=projector.link.ip) + message += '{title}: {data}
'.format(title=translate('OpenLP.ProjectorManager', 'Port'), + data=projector.link.port) + message += '{title}: {data}
'.format(title=translate('OpenLP.ProjectorManager', 'Notes'), + data=projector.link.notes) + message += '

' if projector.link.manufacturer is None: - message = '%s%s' % (message, translate('OpenLP.ProjectorManager', - 'Projector information not available at this time.')) + message += translate('OpenLP.ProjectorManager', 'Projector information not available at this time.') else: - message = '%s%s: %s
' % (message, translate('OpenLP.ProjectorManager', 'Projector Name'), - projector.link.pjlink_name) - message = '%s%s: %s
' % (message, translate('OpenLP.ProjectorManager', 'Manufacturer'), - projector.link.manufacturer) - message = '%s%s: %s
' % (message, translate('OpenLP.ProjectorManager', 'Model'), - projector.link.model) - message = '%s%s: %s

' % (message, translate('OpenLP.ProjectorManager', 'Other info'), - projector.link.other_info) - message = '%s%s: %s
' % (message, translate('OpenLP.ProjectorManager', 'Power status'), - ERROR_MSG[projector.link.power]) - message = '%s%s: %s
' % (message, translate('OpenLP.ProjectorManager', 'Shutter is'), - translate('OpenLP.ProjectorManager', 'Closed') - if projector.link.shutter else translate('OpenLP', 'Open')) + message += '{title}: {data}
'.format(title=translate('OpenLP.ProjectorManager', + 'Projector Name'), + data=projector.link.pjlink_name) + message += '{title}: {data}
'.format(title=translate('OpenLP.ProjectorManager', 'Manufacturer'), + data=projector.link.manufacturer) + message += '{title}: {data}
'.format(title=translate('OpenLP.ProjectorManager', 'Model'), + data=projector.link.model) + message += '{title}: {data}

'.format(title=translate('OpenLP.ProjectorManager', + 'Other info'), + data=projector.link.other_info) + message += '{title}: {data}
'.format(title=translate('OpenLP.ProjectorManager', 'Power status'), + data=ERROR_MSG[projector.link.power]) + message += '{title}: {data}
'.format(title=translate('OpenLP.ProjectorManager', 'Shutter is'), + data=translate('OpenLP.ProjectorManager', 'Closed') + if projector.link.shutter + else translate('OpenLP', 'Open')) message = '%s%s: %s
' % (message, translate('OpenLP.ProjectorManager', 'Current source input is'), projector.link.source) count = 1 for item in projector.link.lamp: - message = '%s %s %s (%s) %s: %s
' % (message, - translate('OpenLP.ProjectorManager', 'Lamp'), - count, - translate('OpenLP.ProjectorManager', 'On') - if item['On'] - else translate('OpenLP.ProjectorManager', 'Off'), - translate('OpenLP.ProjectorManager', 'Hours'), - item['Hours']) - count = count + 1 - message = '%s

' % message + message += '{title} {count} {status} '.format(title=translate('OpenLP.ProjectorManager', + 'Lamp'), + count=count, + status=translate('OpenLP.ProjectorManager', + ' is on') + if item['On'] + else translate('OpenLP.ProjectorManager', + 'is off')) + + message += '{title}: {hours}
'.format(title=translate('OpenLP.ProjectorManager', 'Hours'), + hours=item['Hours']) + count += 1 + message += '

' if projector.link.projector_errors is None: - message = '%s%s' % (message, translate('OpenLP.ProjectorManager', 'No current errors or warnings')) + message += translate('OpenLP.ProjectorManager', 'No current errors or warnings') else: - message = '%s%s' % (message, translate('OpenLP.ProjectorManager', 'Current errors/warnings')) + message += '{data}'.format(data=translate('OpenLP.ProjectorManager', 'Current errors/warnings')) for (key, val) in projector.link.projector_errors.items(): - message = '%s%s: %s
' % (message, key, ERROR_MSG[val]) + message += '{key}: {data}
'.format(key=key, data=ERROR_MSG[val]) QtWidgets.QMessageBox.information(self, translate('OpenLP.ProjectorManager', 'Projector Information'), message) def _add_projector(self, projector): @@ -743,7 +749,7 @@ class ProjectorManager(OpenLPMixin, RegistryMixin, QWidget, Ui_ProjectorManager, if start: item.link.connect_to_host() for item in self.projector_list: - log.debug('New projector list - item: (%s) %s' % (item.link.ip, item.link.name)) + log.debug('New projector list - item: ({ip}) {name}'.format(ip=item.link.ip, name=item.link.name)) @pyqtSlot(str) def add_projector_from_wizard(self, ip, opts=None): @@ -753,7 +759,7 @@ class ProjectorManager(OpenLPMixin, RegistryMixin, QWidget, Ui_ProjectorManager, :param ip: IP address of new record item to find :param opts: Needed by PyQt5 """ - log.debug('add_projector_from_wizard(ip=%s)' % ip) + log.debug('add_projector_from_wizard(ip={ip})'.format(ip=ip)) item = self.projectordb.get_projector_by_ip(ip) self.add_projector(item) @@ -764,7 +770,7 @@ class ProjectorManager(OpenLPMixin, RegistryMixin, QWidget, Ui_ProjectorManager, :param projector: Projector() instance of projector with updated information """ - log.debug('edit_projector_from_wizard(ip=%s)' % projector.ip) + log.debug('edit_projector_from_wizard(ip={ip})'.format(ip=projector.ip)) self.old_projector.link.name = projector.name self.old_projector.link.ip = projector.ip self.old_projector.link.pin = None if projector.pin == '' else projector.pin @@ -816,7 +822,9 @@ class ProjectorManager(OpenLPMixin, RegistryMixin, QWidget, Ui_ProjectorManager, else: status_code = status message = ERROR_MSG[status] if msg is None else msg - log.debug('(%s) updateStatus(status=%s) message: "%s"' % (item.link.name, status_code, message)) + log.debug('({name}) updateStatus(status={status}) message: "{message}"'.format(name=item.link.name, + status=status_code, + message=message)) if status in STATUS_ICONS: if item.status == status: return @@ -826,14 +834,14 @@ class ProjectorManager(OpenLPMixin, RegistryMixin, QWidget, Ui_ProjectorManager, status_code = ERROR_STRING[status] elif status in STATUS_STRING: status_code = STATUS_STRING[status] - log.debug('(%s) Updating icon with %s' % (item.link.name, status_code)) + log.debug('({name}) Updating icon with {code}'.format(name=item.link.name, code=status_code)) item.widget.setIcon(item.icon) self.update_icons() def get_toolbar_item(self, name, enabled=False, hidden=False): item = self.one_toolbar.findChild(QtWidgets.QAction, name) if item == 0: - log.debug('No item found with name "%s"' % name) + log.debug('No item found with name "{name}"'.format(name=name)) return item.setVisible(False if hidden else True) item.setEnabled(True if enabled else False) @@ -918,11 +926,12 @@ class ProjectorManager(OpenLPMixin, RegistryMixin, QWidget, Ui_ProjectorManager, :param name: Name from QListWidgetItem """ - QtWidgets.QMessageBox.warning(self, translate('OpenLP.ProjectorManager', - '"%s" Authentication Error' % name), + title = '"{name} {message}" '.format(name=name, + message=translate('OpenLP.ProjectorManager', 'Authentication Error')) + QtWidgets.QMessageBox.warning(self, title, '
There was an authentication error while trying to connect.' '

Please verify your PIN setting ' - 'for projector item "%s"' % name) + 'for projector item "{name}"'.format(name=name)) @pyqtSlot(str) def no_authentication_error(self, name): @@ -932,11 +941,12 @@ class ProjectorManager(OpenLPMixin, RegistryMixin, QWidget, Ui_ProjectorManager, :param name: Name from QListWidgetItem """ - QtWidgets.QMessageBox.warning(self, translate('OpenLP.ProjectorManager', - '"%s" No Authentication Error' % name), + title = '"{name} {message}" '.format(name=name, + message=translate('OpenLP.ProjectorManager', 'No Authentication Error')) + QtWidgets.QMessageBox.warning(self, title, '
PIN is set and projector does not require authentication.' '

Please verify your PIN setting ' - 'for projector item "%s"' % name) + 'for projector item "{name}"'.format(name=name)) class ProjectorItem(QObject): @@ -972,5 +982,5 @@ def not_implemented(function): QtWidgets.QMessageBox.information(None, translate('OpenLP.ProjectorManager', 'Not Implemented Yet'), translate('OpenLP.ProjectorManager', - 'Function "%s"
has not been implemented yet.' - '
Please check back again later.' % function)) + 'Function "{function}"
has not been implemented yet.' + '
Please check back again later.'.format(function=function))) diff --git a/openlp/core/ui/projector/sourceselectform.py b/openlp/core/ui/projector/sourceselectform.py index 11efcdb08..7d73f6a5a 100644 --- a/openlp/core/ui/projector/sourceselectform.py +++ b/openlp/core/ui/projector/sourceselectform.py @@ -115,7 +115,7 @@ def Build_Tab(group, source_key, default, projector, projectordb, edit=False): if edit: for key in sourcelist: item = QLineEdit() - item.setObjectName('source_key_%s' % key) + item.setObjectName('source_key_{key}'.format(key=key)) source_item = projectordb.get_source_by_code(code=key, projector_id=projector.db_item.id) if source_item is None: item.setText(PJLINK_DEFAULT_CODES[key]) @@ -161,7 +161,7 @@ def set_button_tooltip(bar): button.setToolTip(translate('OpenLP.SourceSelectForm', 'Save changes and return to OpenLP')) else: - log.debug('No tooltip for button {}'.format(button.text())) + log.debug('No tooltip for button {text}'.format(text=button.text())) class FingerTabBarWidget(QTabBar): @@ -359,16 +359,20 @@ class SourceSelectTabs(QDialog): continue item = self.projectordb.get_source_by_code(code=code, projector_id=projector.id) if item is None: - log.debug("(%s) Adding new source text %s: %s" % (projector.ip, code, text)) + log.debug("({ip}) Adding new source text {code}: {text}".format(ip=projector.ip, + code=code, + text=text)) item = ProjectorSource(projector_id=projector.id, code=code, text=text) else: item.text = text - log.debug('(%s) Updating source code %s with text="%s"' % (projector.ip, item.code, item.text)) + log.debug('({ip}) Updating source code {code} with text="{text}"'.format(ip=projector.ip, + code=item.code, + text=item.text)) self.projectordb.add_source(item) selected = 0 else: selected = self.button_group.checkedId() - log.debug('SourceSelectTabs().accepted() Setting source to %s' % selected) + log.debug('SourceSelectTabs().accepted() Setting source to {selected}'.format(selected=selected)) self.done(selected) @@ -417,7 +421,7 @@ class SourceSelectSingle(QDialog): if self.edit: for key in keys: item = QLineEdit() - item.setObjectName('source_key_%s' % key) + item.setObjectName('source_key_{key}'.format(key=key)) source_item = self.projectordb.get_source_by_code(code=key, projector_id=self.projector.db_item.id) if source_item is None: item.setText(PJLINK_DEFAULT_CODES[key]) @@ -498,14 +502,18 @@ class SourceSelectSingle(QDialog): continue item = self.projectordb.get_source_by_code(code=code, projector_id=projector.id) if item is None: - log.debug("(%s) Adding new source text %s: %s" % (projector.ip, code, text)) + log.debug("({ip}) Adding new source text {code}: {text}".format(ip=projector.ip, + code=code, + text=text)) item = ProjectorSource(projector_id=projector.id, code=code, text=text) else: item.text = text - log.debug('(%s) Updating source code %s with text="%s"' % (projector.ip, item.code, item.text)) + log.debug('({ip}) Updating source code {code} with text="{text}"'.format(ip=projector.ip, + code=item.code, + text=item.text)) self.projectordb.add_source(item) selected = 0 else: selected = self.button_group.checkedId() - log.debug('SourceSelectDialog().accepted() Setting source to %s' % selected) + log.debug('SourceSelectDialog().accepted() Setting source to {selected}'.format(selected=selected)) self.done(selected) diff --git a/openlp/plugins/bibles/forms/bibleimportform.py b/openlp/plugins/bibles/forms/bibleimportform.py index 45efe0e5f..66ba252fc 100644 --- a/openlp/plugins/bibles/forms/bibleimportform.py +++ b/openlp/plugins/bibles/forms/bibleimportform.py @@ -27,6 +27,11 @@ import os import urllib.error from PyQt5 import QtWidgets +try: + from pysword import modules + PYSWORD_AVAILABLE = True +except: + PYSWORD_AVAILABLE = False from openlp.core.common import AppLocation, Settings, UiStrings, translate, clean_filename from openlp.core.lib.db import delete_database @@ -34,7 +39,7 @@ from openlp.core.lib.ui import critical_error_message_box from openlp.core.ui.lib.wizard import OpenLPWizard, WizardStrings from openlp.core.common.languagemanager import get_locale_key from openlp.plugins.bibles.lib.manager import BibleFormat -from openlp.plugins.bibles.lib.db import BiblesResourcesDB, clean_filename +from openlp.plugins.bibles.lib.db import clean_filename from openlp.plugins.bibles.lib.http import CWExtract, BGExtract, BSExtract log = logging.getLogger(__name__) @@ -94,6 +99,19 @@ class BibleImportForm(OpenLPWizard): self.manager.set_process_dialog(self) self.restart() self.select_stack.setCurrentIndex(0) + if PYSWORD_AVAILABLE: + self.pysword_folder_modules = modules.SwordModules() + try: + self.pysword_folder_modules_json = self.pysword_folder_modules.parse_modules() + except FileNotFoundError: + log.debug('No installed SWORD modules found in the default location') + self.sword_bible_combo_box.clear() + return + bible_keys = self.pysword_folder_modules_json.keys() + for key in bible_keys: + self.sword_bible_combo_box.addItem(self.pysword_folder_modules_json[key]['description'], key) + else: + self.sword_tab_widget.setDisabled(True) def custom_signals(self): """ @@ -106,6 +124,8 @@ class BibleImportForm(OpenLPWizard): self.open_song_browse_button.clicked.connect(self.on_open_song_browse_button_clicked) self.zefania_browse_button.clicked.connect(self.on_zefania_browse_button_clicked) self.web_update_button.clicked.connect(self.on_web_update_button_clicked) + self.sword_browse_button.clicked.connect(self.on_sword_browse_button_clicked) + self.sword_zipbrowse_button.clicked.connect(self.on_sword_zipbrowse_button_clicked) def add_custom_pages(self): """ @@ -121,7 +141,7 @@ class BibleImportForm(OpenLPWizard): self.format_label = QtWidgets.QLabel(self.select_page) self.format_label.setObjectName('FormatLabel') self.format_combo_box = QtWidgets.QComboBox(self.select_page) - self.format_combo_box.addItems(['', '', '', '', '']) + self.format_combo_box.addItems(['', '', '', '', '', '']) self.format_combo_box.setObjectName('FormatComboBox') self.format_layout.addRow(self.format_label, self.format_combo_box) self.spacer = QtWidgets.QSpacerItem(10, 0, QtWidgets.QSizePolicy.Fixed, QtWidgets.QSizePolicy.Minimum) @@ -275,6 +295,64 @@ class BibleImportForm(OpenLPWizard): self.zefania_layout.addRow(self.zefania_file_label, self.zefania_file_layout) self.zefania_layout.setItem(5, QtWidgets.QFormLayout.LabelRole, self.spacer) self.select_stack.addWidget(self.zefania_widget) + self.sword_widget = QtWidgets.QWidget(self.select_page) + self.sword_widget.setObjectName('SwordWidget') + self.sword_layout = QtWidgets.QVBoxLayout(self.sword_widget) + self.sword_layout.setObjectName('SwordLayout') + self.sword_tab_widget = QtWidgets.QTabWidget(self.sword_widget) + self.sword_tab_widget.setObjectName('SwordTabWidget') + self.sword_folder_tab = QtWidgets.QWidget(self.sword_tab_widget) + self.sword_folder_tab.setObjectName('SwordFolderTab') + self.sword_folder_tab_layout = QtWidgets.QGridLayout(self.sword_folder_tab) + self.sword_folder_tab_layout.setObjectName('SwordTabFolderLayout') + self.sword_folder_label = QtWidgets.QLabel(self.sword_folder_tab) + self.sword_folder_label.setObjectName('SwordSourceLabel') + self.sword_folder_tab_layout.addWidget(self.sword_folder_label, 0, 0) + self.sword_folder_label.setObjectName('SwordFolderLabel') + self.sword_folder_edit = QtWidgets.QLineEdit(self.sword_folder_tab) + self.sword_folder_edit.setObjectName('SwordFolderEdit') + self.sword_browse_button = QtWidgets.QToolButton(self.sword_folder_tab) + self.sword_browse_button.setIcon(self.open_icon) + self.sword_browse_button.setObjectName('SwordBrowseButton') + self.sword_folder_tab_layout.addWidget(self.sword_folder_edit, 0, 1) + self.sword_folder_tab_layout.addWidget(self.sword_browse_button, 0, 2) + self.sword_bible_label = QtWidgets.QLabel(self.sword_folder_tab) + self.sword_bible_label.setObjectName('SwordBibleLabel') + self.sword_folder_tab_layout.addWidget(self.sword_bible_label, 1, 0) + self.sword_bible_combo_box = QtWidgets.QComboBox(self.sword_folder_tab) + self.sword_bible_combo_box.setSizeAdjustPolicy(QtWidgets.QComboBox.AdjustToContents) + self.sword_bible_combo_box.setInsertPolicy(QtWidgets.QComboBox.InsertAlphabetically) + self.sword_bible_combo_box.setObjectName('SwordBibleComboBox') + self.sword_folder_tab_layout.addWidget(self.sword_bible_combo_box, 1, 1) + self.sword_tab_widget.addTab(self.sword_folder_tab, '') + self.sword_zip_tab = QtWidgets.QWidget(self.sword_tab_widget) + self.sword_zip_tab.setObjectName('SwordZipTab') + self.sword_zip_layout = QtWidgets.QGridLayout(self.sword_zip_tab) + self.sword_zip_layout.setObjectName('SwordZipLayout') + self.sword_zipfile_label = QtWidgets.QLabel(self.sword_zip_tab) + self.sword_zipfile_label.setObjectName('SwordZipFileLabel') + self.sword_zipfile_edit = QtWidgets.QLineEdit(self.sword_zip_tab) + self.sword_zipfile_edit.setObjectName('SwordZipFileEdit') + self.sword_zipbrowse_button = QtWidgets.QToolButton(self.sword_zip_tab) + self.sword_zipbrowse_button.setIcon(self.open_icon) + self.sword_zipbrowse_button.setObjectName('SwordZipBrowseButton') + self.sword_zipbible_label = QtWidgets.QLabel(self.sword_folder_tab) + self.sword_zipbible_label.setObjectName('SwordZipBibleLabel') + self.sword_zipbible_combo_box = QtWidgets.QComboBox(self.sword_zip_tab) + self.sword_zipbible_combo_box.setSizeAdjustPolicy(QtWidgets.QComboBox.AdjustToContents) + self.sword_zipbible_combo_box.setInsertPolicy(QtWidgets.QComboBox.InsertAlphabetically) + self.sword_zipbible_combo_box.setObjectName('SwordZipBibleComboBox') + self.sword_zip_layout.addWidget(self.sword_zipfile_label, 0, 0) + self.sword_zip_layout.addWidget(self.sword_zipfile_edit, 0, 1) + self.sword_zip_layout.addWidget(self.sword_zipbrowse_button, 0, 2) + self.sword_zip_layout.addWidget(self.sword_zipbible_label, 1, 0) + self.sword_zip_layout.addWidget(self.sword_zipbible_combo_box, 1, 1) + self.sword_tab_widget.addTab(self.sword_zip_tab, '') + self.sword_layout.addWidget(self.sword_tab_widget) + self.sword_disabled_label = QtWidgets.QLabel(self.sword_widget) + self.sword_disabled_label.setObjectName('SwordDisabledLabel') + self.sword_layout.addWidget(self.sword_disabled_label) + self.select_stack.addWidget(self.sword_widget) self.select_page_layout.addLayout(self.select_stack) self.addPage(self.select_page) # License Page @@ -323,6 +401,7 @@ class BibleImportForm(OpenLPWizard): self.format_combo_box.setItemText(BibleFormat.WebDownload, translate('BiblesPlugin.ImportWizardForm', 'Web Download')) self.format_combo_box.setItemText(BibleFormat.Zefania, WizardStrings.ZEF) + self.format_combo_box.setItemText(BibleFormat.SWORD, WizardStrings.SWORD) self.osis_file_label.setText(translate('BiblesPlugin.ImportWizardForm', 'Bible file:')) self.csv_books_label.setText(translate('BiblesPlugin.ImportWizardForm', 'Books file:')) self.csv_verses_label.setText(translate('BiblesPlugin.ImportWizardForm', 'Verses file:')) @@ -346,6 +425,22 @@ class BibleImportForm(OpenLPWizard): self.web_tab_widget.setTabText( self.web_tab_widget.indexOf(self.web_proxy_tab), translate('BiblesPlugin.ImportWizardForm', 'Proxy Server (Optional)')) + self.sword_bible_label.setText(translate('BiblesPlugin.ImportWizardForm', 'Bibles:')) + self.sword_folder_label.setText(translate('BiblesPlugin.ImportWizardForm', 'SWORD data folder:')) + self.sword_zipfile_label.setText(translate('BiblesPlugin.ImportWizardForm', 'SWORD zip-file:')) + self.sword_folder_edit.setPlaceholderText(translate('BiblesPlugin.ImportWizardForm', + 'Defaults to the standard SWORD data folder')) + self.sword_zipbible_label.setText(translate('BiblesPlugin.ImportWizardForm', 'Bibles:')) + self.sword_tab_widget.setTabText(self.sword_tab_widget.indexOf(self.sword_folder_tab), + translate('BiblesPlugin.ImportWizardForm', 'Import from folder')) + self.sword_tab_widget.setTabText(self.sword_tab_widget.indexOf(self.sword_zip_tab), + translate('BiblesPlugin.ImportWizardForm', 'Import from Zip-file')) + if PYSWORD_AVAILABLE: + self.sword_disabled_label.setText('') + else: + self.sword_disabled_label.setText(translate('BiblesPlugin.ImportWizardForm', + 'To import SWORD bibles the pysword python module must be ' + 'installed. Please read the manual for instructions.')) self.license_details_page.setTitle( translate('BiblesPlugin.ImportWizardForm', 'License Details')) self.license_details_page.setSubTitle(translate('BiblesPlugin.ImportWizardForm', @@ -374,6 +469,9 @@ class BibleImportForm(OpenLPWizard): if self.currentPage() == self.welcome_page: return True elif self.currentPage() == self.select_page: + self.version_name_edit.clear() + self.permissions_edit.clear() + self.copyright_edit.clear() if self.field('source_format') == BibleFormat.OSIS: if not self.field('osis_location'): critical_error_message_box(UiStrings().NFSs, WizardStrings.YouSpecifyFile % WizardStrings.OSIS) @@ -410,6 +508,31 @@ class BibleImportForm(OpenLPWizard): return False else: self.version_name_edit.setText(self.web_translation_combo_box.currentText()) + elif self.field('source_format') == BibleFormat.SWORD: + # Test the SWORD tab that is currently active + if self.sword_tab_widget.currentIndex() == self.sword_tab_widget.indexOf(self.sword_folder_tab): + if not self.field('sword_folder_path') and self.sword_bible_combo_box.count() == 0: + critical_error_message_box(UiStrings().NFSs, + WizardStrings.YouSpecifyFolder % WizardStrings.SWORD) + self.sword_folder_edit.setFocus() + return False + key = self.sword_bible_combo_box.itemData(self.sword_bible_combo_box.currentIndex()) + if 'description' in self.pysword_folder_modules_json[key]: + self.version_name_edit.setText(self.pysword_folder_modules_json[key]['description']) + if 'distributionlicense' in self.pysword_folder_modules_json[key]: + self.permissions_edit.setText(self.pysword_folder_modules_json[key]['distributionlicense']) + if 'copyright' in self.pysword_folder_modules_json[key]: + self.copyright_edit.setText(self.pysword_folder_modules_json[key]['copyright']) + elif self.sword_tab_widget.currentIndex() == self.sword_tab_widget.indexOf(self.sword_zip_tab): + if not self.field('sword_zip_path'): + critical_error_message_box(UiStrings().NFSs, WizardStrings.YouSpecifyFile % WizardStrings.SWORD) + self.sword_zipfile_edit.setFocus() + return False + key = self.sword_zipbible_combo_box.itemData(self.sword_zipbible_combo_box.currentIndex()) + if 'description' in self.pysword_zip_modules_json[key]: + self.version_name_edit.setText(self.pysword_zip_modules_json[key]['description']) + if 'distributionlicense' in self.pysword_zip_modules_json[key]: + self.permissions_edit.setText(self.pysword_zip_modules_json[key]['distributionlicense']) return True elif self.currentPage() == self.license_details_page: license_version = self.field('license_version') @@ -531,6 +654,40 @@ class BibleImportForm(OpenLPWizard): self.web_update_button.setEnabled(True) self.web_progress_bar.setVisible(False) + def on_sword_browse_button_clicked(self): + """ + Show the file open dialog for the SWORD folder. + """ + self.get_folder(WizardStrings.OpenTypeFolder % WizardStrings.SWORD, self.sword_folder_edit, + 'last directory import') + if self.sword_folder_edit.text(): + try: + self.pysword_folder_modules = modules.SwordModules(self.sword_folder_edit.text()) + self.pysword_folder_modules_json = self.pysword_folder_modules.parse_modules() + bible_keys = self.pysword_folder_modules_json.keys() + self.sword_bible_combo_box.clear() + for key in bible_keys: + self.sword_bible_combo_box.addItem(self.pysword_folder_modules_json[key]['description'], key) + except: + self.sword_bible_combo_box.clear() + + def on_sword_zipbrowse_button_clicked(self): + """ + Show the file open dialog for a SWORD zip-file. + """ + self.get_file_name(WizardStrings.OpenTypeFile % WizardStrings.SWORD, self.sword_zipfile_edit, + 'last directory import') + if self.sword_zipfile_edit.text(): + try: + self.pysword_zip_modules = modules.SwordModules(self.sword_zipfile_edit.text()) + self.pysword_zip_modules_json = self.pysword_zip_modules.parse_modules() + bible_keys = self.pysword_zip_modules_json.keys() + self.sword_zipbible_combo_box.clear() + for key in bible_keys: + self.sword_zipbible_combo_box.addItem(self.pysword_zip_modules_json[key]['description'], key) + except: + self.sword_zipbible_combo_box.clear() + def register_fields(self): """ Register the bible import wizard fields. @@ -543,6 +700,8 @@ class BibleImportForm(OpenLPWizard): self.select_page.registerField('zefania_file', self.zefania_file_edit) self.select_page.registerField('web_location', self.web_source_combo_box) self.select_page.registerField('web_biblename', self.web_translation_combo_box) + self.select_page.registerField('sword_folder_path', self.sword_folder_edit) + self.select_page.registerField('sword_zip_path', self.sword_zipfile_edit) self.select_page.registerField('proxy_server', self.web_server_edit) self.select_page.registerField('proxy_username', self.web_user_edit) self.select_page.registerField('proxy_password', self.web_password_edit) @@ -565,6 +724,8 @@ class BibleImportForm(OpenLPWizard): self.setField('csv_versefile', '') self.setField('opensong_file', '') self.setField('zefania_file', '') + self.setField('sword_folder_path', '') + self.setField('sword_zip_path', '') self.setField('web_location', WebDownload.Crosswalk) self.setField('web_biblename', self.web_translation_combo_box.currentIndex()) self.setField('proxy_server', settings.value('proxy address')) @@ -626,9 +787,21 @@ class BibleImportForm(OpenLPWizard): language_id=language_id ) elif bible_type == BibleFormat.Zefania: - # Import an Zefania bible. + # Import a Zefania bible. importer = self.manager.import_bible(BibleFormat.Zefania, name=license_version, filename=self.field('zefania_file')) + elif bible_type == BibleFormat.SWORD: + # Import a SWORD bible. + if self.sword_tab_widget.currentIndex() == self.sword_tab_widget.indexOf(self.sword_folder_tab): + importer = self.manager.import_bible(BibleFormat.SWORD, name=license_version, + sword_path=self.field('sword_folder_path'), + sword_key=self.sword_bible_combo_box.itemData( + self.sword_bible_combo_box.currentIndex())) + else: + importer = self.manager.import_bible(BibleFormat.SWORD, name=license_version, + sword_path=self.field('sword_zip_path'), + sword_key=self.sword_zipbible_combo_box.itemData( + self.sword_zipbible_combo_box.currentIndex())) if importer.do_import(license_version): self.manager.save_meta_data(license_version, license_version, license_copyright, license_permissions) self.manager.reload_bibles() diff --git a/openlp/plugins/bibles/lib/manager.py b/openlp/plugins/bibles/lib/manager.py index b8b7ee56f..85521402c 100644 --- a/openlp/plugins/bibles/lib/manager.py +++ b/openlp/plugins/bibles/lib/manager.py @@ -31,7 +31,10 @@ from .http import HTTPBible from .opensong import OpenSongBible from .osis import OSISBible from .zefania import ZefaniaBible - +try: + from .sword import SwordBible +except: + pass log = logging.getLogger(__name__) @@ -46,6 +49,7 @@ class BibleFormat(object): OpenSong = 2 WebDownload = 3 Zefania = 4 + SWORD = 5 @staticmethod def get_class(bible_format): @@ -64,6 +68,8 @@ class BibleFormat(object): return HTTPBible elif bible_format == BibleFormat.Zefania: return ZefaniaBible + elif bible_format == BibleFormat.SWORD: + return SwordBible else: return None @@ -78,6 +84,7 @@ class BibleFormat(object): BibleFormat.OpenSong, BibleFormat.WebDownload, BibleFormat.Zefania, + BibleFormat.SWORD ] diff --git a/openlp/plugins/bibles/lib/sword.py b/openlp/plugins/bibles/lib/sword.py new file mode 100644 index 000000000..6f91803a6 --- /dev/null +++ b/openlp/plugins/bibles/lib/sword.py @@ -0,0 +1,100 @@ +# -*- coding: utf-8 -*- +# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4 + +############################################################################### +# OpenLP - Open Source Lyrics Projection # +# --------------------------------------------------------------------------- # +# Copyright (c) 2008-2016 OpenLP Developers # +# --------------------------------------------------------------------------- # +# 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; version 2 of the License. # +# # +# 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., 59 # +# Temple Place, Suite 330, Boston, MA 02111-1307 USA # +############################################################################### + +import logging +from pysword import modules + +from openlp.core.common import translate +from openlp.core.lib.ui import critical_error_message_box +from openlp.plugins.bibles.lib.db import BibleDB, BiblesResourcesDB + + +log = logging.getLogger(__name__) + + +class SwordBible(BibleDB): + """ + SWORD Bible format importer class. + """ + def __init__(self, parent, **kwargs): + """ + Constructor to create and set up an instance of the SwordBible class. This class is used to import Bibles + from SWORD bible modules. + """ + log.debug(self.__class__.__name__) + BibleDB.__init__(self, parent, **kwargs) + self.sword_key = kwargs['sword_key'] + self.sword_path = kwargs['sword_path'] + if self.sword_path == '': + self.sword_path = None + + def do_import(self, bible_name=None): + """ + Loads a Bible from SWORD module. + """ + log.debug('Starting SWORD import from "%s"' % self.sword_key) + success = True + try: + pysword_modules = modules.SwordModules(self.sword_path) + pysword_module_json = pysword_modules.parse_modules()[self.sword_key] + bible = pysword_modules.get_bible_from_module(self.sword_key) + language = pysword_module_json['lang'] + language = language[language.find('.') + 1:] + language_id = BiblesResourcesDB.get_language(language)['id'] + self.save_meta('language_id', language_id) + books = bible.get_structure().get_books() + # Count number of books + num_books = 0 + if 'ot' in books: + num_books += len(books['ot']) + if 'nt' in books: + num_books += len(books['nt']) + self.wizard.progress_bar.setMaximum(num_books) + # Import the bible + for testament in books.keys(): + for book in books[testament]: + book_ref_id = self.get_book_ref_id_by_name(book.name, num_books, language_id) + book_details = BiblesResourcesDB.get_book_by_id(book_ref_id) + db_book = self.create_book(book_details['name'], book_ref_id, book_details['testament_id']) + for chapter_number in range(1, book.num_chapters + 1): + if self.stop_import_flag: + break + verses = bible.get_iter(book.name, chapter_number) + verse_number = 0 + for verse in verses: + verse_number += 1 + self.create_verse(db_book.id, chapter_number, verse_number, verse) + self.wizard.increment_progress_bar( + translate('BiblesPlugin.Sword', 'Importing %s...') % db_book.name) + self.session.commit() + self.application.process_events() + except Exception as e: + critical_error_message_box( + message=translate('BiblesPlugin.SwordImport', 'An unexpected error happened while importing the SWORD ' + 'bible, please report this to the OpenLP developers.\n' + '%s' % e)) + log.exception(str(e)) + success = False + if self.stop_import_flag: + return False + else: + return success diff --git a/openlp/plugins/media/mediaplugin.py b/openlp/plugins/media/mediaplugin.py index daeb4dc2c..1d5529084 100644 --- a/openlp/plugins/media/mediaplugin.py +++ b/openlp/plugins/media/mediaplugin.py @@ -24,10 +24,13 @@ The Media plugin """ import logging +import os +import re +from shutil import which from PyQt5 import QtCore -from openlp.core.common import Settings, translate +from openlp.core.common import AppLocation, Settings, translate, check_binary_exists, is_win from openlp.core.lib import Plugin, StringContent, build_icon from openlp.plugins.media.lib import MediaMediaItem, MediaTab @@ -62,6 +65,15 @@ class MediaPlugin(Plugin): """ super().initialise() + def check_pre_conditions(self): + """ + Check it we have a valid environment. + :return: true or false + """ + log.debug('check_installed Mediainfo') + # Use the user defined program if given + return process_check_binary('mediainfo') + def app_startup(self): """ Override app_startup() in order to do nothing @@ -137,3 +149,21 @@ class MediaPlugin(Plugin): Add html code to htmlbuilder. """ return self.media_controller.get_media_display_html() + + +def process_check_binary(program_path): + """ + Function that checks whether a binary MediaInfo is present + + :param program_path:The full path to the binary to check. + :return: If exists or not + """ + program_type = None + runlog = check_binary_exists(program_path) + print(runlog, type(runlog)) + # Analyse the output to see it the program is mediainfo + for line in runlog.splitlines(): + decoded_line = line.decode() + if re.search('MediaInfo Command line', decoded_line, re.IGNORECASE): + return True + return False diff --git a/openlp/plugins/presentations/lib/pdfcontroller.py b/openlp/plugins/presentations/lib/pdfcontroller.py index dbea84327..48150a9f2 100644 --- a/openlp/plugins/presentations/lib/pdfcontroller.py +++ b/openlp/plugins/presentations/lib/pdfcontroller.py @@ -22,13 +22,12 @@ import os import logging -from tempfile import NamedTemporaryFile import re from shutil import which -from subprocess import check_output, CalledProcessError, STDOUT +from subprocess import check_output, CalledProcessError -from openlp.core.common import AppLocation -from openlp.core.common import Settings, is_win, trace_error_handler +from openlp.core.common import AppLocation, check_binary_exists +from openlp.core.common import Settings, is_win from openlp.core.lib import ScreenList from .presentationcontroller import PresentationController, PresentationDocument @@ -61,7 +60,7 @@ class PdfController(PresentationController): self.check_installed() @staticmethod - def check_binary(program_path): + def process_check_binary(program_path): """ Function that checks whether a binary is either ghostscript or mudraw or neither. Is also used from presentationtab.py @@ -70,22 +69,7 @@ class PdfController(PresentationController): :return: Type of the binary, 'gs' if ghostscript, 'mudraw' if mudraw, None if invalid. """ program_type = None - runlog = '' - log.debug('testing program_path: %s', program_path) - try: - # Setup startupinfo options for check_output to avoid console popping up on windows - if is_win(): - startupinfo = STARTUPINFO() - startupinfo.dwFlags |= STARTF_USESHOWWINDOW - else: - startupinfo = None - runlog = check_output([program_path, '--help'], stderr=STDOUT, startupinfo=startupinfo) - except CalledProcessError as e: - runlog = e.output - except Exception: - trace_error_handler(log) - runlog = '' - log.debug('check_output returned: %s' % runlog) + runlog = check_binary_exists(program_path) # Analyse the output to see it the program is mudraw, ghostscript or neither for line in runlog.splitlines(): decoded_line = line.decode() @@ -122,7 +106,7 @@ class PdfController(PresentationController): # Use the user defined program if given if Settings().value('presentations/enable_pdf_program'): pdf_program = Settings().value('presentations/pdf_program') - program_type = self.check_binary(pdf_program) + program_type = self.process_check_binary(pdf_program) if program_type == 'gs': self.gsbin = pdf_program elif program_type == 'mudraw': diff --git a/openlp/plugins/remotes/lib/remotetab.py b/openlp/plugins/remotes/lib/remotetab.py index 76ee65571..af64e401f 100644 --- a/openlp/plugins/remotes/lib/remotetab.py +++ b/openlp/plugins/remotes/lib/remotetab.py @@ -144,18 +144,33 @@ class RemoteTab(SettingsTab): self.android_app_group_box = QtWidgets.QGroupBox(self.right_column) self.android_app_group_box.setObjectName('android_app_group_box') self.right_layout.addWidget(self.android_app_group_box) - self.qr_layout = QtWidgets.QVBoxLayout(self.android_app_group_box) - self.qr_layout.setObjectName('qr_layout') - self.qr_code_label = QtWidgets.QLabel(self.android_app_group_box) - self.qr_code_label.setPixmap(QtGui.QPixmap(':/remotes/android_app_qr.png')) - self.qr_code_label.setAlignment(QtCore.Qt.AlignCenter) - self.qr_code_label.setObjectName('qr_code_label') - self.qr_layout.addWidget(self.qr_code_label) - self.qr_description_label = QtWidgets.QLabel(self.android_app_group_box) - self.qr_description_label.setObjectName('qr_description_label') - self.qr_description_label.setOpenExternalLinks(True) - self.qr_description_label.setWordWrap(True) - self.qr_layout.addWidget(self.qr_description_label) + self.android_qr_layout = QtWidgets.QVBoxLayout(self.android_app_group_box) + self.android_qr_layout.setObjectName('android_qr_layout') + self.android_qr_code_label = QtWidgets.QLabel(self.android_app_group_box) + self.android_qr_code_label.setPixmap(QtGui.QPixmap(':/remotes/android_app_qr.png')) + self.android_qr_code_label.setAlignment(QtCore.Qt.AlignCenter) + self.android_qr_code_label.setObjectName('android_qr_code_label') + self.android_qr_layout.addWidget(self.android_qr_code_label) + self.android_qr_description_label = QtWidgets.QLabel(self.android_app_group_box) + self.android_qr_description_label.setObjectName('android_qr_description_label') + self.android_qr_description_label.setOpenExternalLinks(True) + self.android_qr_description_label.setWordWrap(True) + self.android_qr_layout.addWidget(self.android_qr_description_label) + self.ios_app_group_box = QtWidgets.QGroupBox(self.right_column) + self.ios_app_group_box.setObjectName('ios_app_group_box') + self.right_layout.addWidget(self.ios_app_group_box) + self.ios_qr_layout = QtWidgets.QVBoxLayout(self.ios_app_group_box) + self.ios_qr_layout.setObjectName('ios_qr_layout') + self.ios_qr_code_label = QtWidgets.QLabel(self.ios_app_group_box) + self.ios_qr_code_label.setPixmap(QtGui.QPixmap(':/remotes/ios_app_qr.png')) + self.ios_qr_code_label.setAlignment(QtCore.Qt.AlignCenter) + self.ios_qr_code_label.setObjectName('ios_qr_code_label') + self.ios_qr_layout.addWidget(self.ios_qr_code_label) + self.ios_qr_description_label = QtWidgets.QLabel(self.ios_app_group_box) + self.ios_qr_description_label.setObjectName('ios_qr_description_label') + self.ios_qr_description_label.setOpenExternalLinks(True) + self.ios_qr_description_label.setWordWrap(True) + self.ios_qr_layout.addWidget(self.ios_qr_description_label) self.left_layout.addStretch() self.right_layout.addStretch() self.twelve_hour_check_box.stateChanged.connect(self.on_twelve_hour_check_box_changed) @@ -176,10 +191,15 @@ class RemoteTab(SettingsTab): self.thumbnails_check_box.setText(translate('RemotePlugin.RemoteTab', 'Show thumbnails of non-text slides in remote and stage view.')) self.android_app_group_box.setTitle(translate('RemotePlugin.RemoteTab', 'Android App')) - self.qr_description_label.setText( + self.android_qr_description_label.setText( translate('RemotePlugin.RemoteTab', 'Scan the QR code or click download to install the ' 'Android app from Google Play.') % 'https://play.google.com/store/apps/details?id=org.openlp.android2') + self.ios_app_group_box.setTitle(translate('RemotePlugin.RemoteTab', 'iOS App')) + self.ios_qr_description_label.setText( + translate('RemotePlugin.RemoteTab', 'Scan the QR code or click download to install the ' + 'iOS app from the App Store.') % + 'https://itunes.apple.com/app/id1096218725') self.https_settings_group_box.setTitle(translate('RemotePlugin.RemoteTab', 'HTTPS Server')) self.https_error_label.setText( translate('RemotePlugin.RemoteTab', 'Could not find an SSL certificate. The HTTPS server will not be ' diff --git a/openlp/plugins/songs/forms/editsongform.py b/openlp/plugins/songs/forms/editsongform.py index 678169e64..b33788a4c 100644 --- a/openlp/plugins/songs/forms/editsongform.py +++ b/openlp/plugins/songs/forms/editsongform.py @@ -34,6 +34,7 @@ from PyQt5 import QtCore, QtWidgets from openlp.core.common import Registry, RegistryProperties, AppLocation, UiStrings, check_directory_exists, translate from openlp.core.lib import FileDialog, PluginStatus, MediaType, create_separated_list from openlp.core.lib.ui import set_case_insensitive_completer, critical_error_message_box, find_and_set_in_combo_box +from openlp.core.common.languagemanager import get_natural_key from openlp.plugins.songs.lib import VerseType, clean_song from openlp.plugins.songs.lib.db import Book, Song, Author, AuthorType, Topic, MediaFile, SongBookEntry from openlp.plugins.songs.lib.ui import SongStrings @@ -110,7 +111,12 @@ class EditSongForm(QtWidgets.QDialog, Ui_EditSongDialog, RegistryProperties): """ Generically load a set of objects into a cache and a combobox. """ - objects = self.manager.get_all_objects(cls, order_by_ref=cls.name) + def get_key(obj): + """Get the key to sort by""" + return get_natural_key(obj.name) + + objects = self.manager.get_all_objects(cls) + objects.sort(key=get_key) combo.clear() combo.addItem('') for obj in objects: @@ -343,7 +349,12 @@ class EditSongForm(QtWidgets.QDialog, Ui_EditSongDialog, RegistryProperties): """ Load the authors from the database into the combobox. """ - authors = self.manager.get_all_objects(Author, order_by_ref=Author.display_name) + def get_author_key(author): + """Get the key to sort by""" + return get_natural_key(author.display_name) + + authors = self.manager.get_all_objects(Author) + authors.sort(key=get_author_key) self.authors_combo_box.clear() self.authors_combo_box.addItem('') self.authors = [] @@ -378,9 +389,14 @@ class EditSongForm(QtWidgets.QDialog, Ui_EditSongDialog, RegistryProperties): """ Load the themes into a combobox. """ + def get_theme_key(theme): + """Get the key to sort by""" + return get_natural_key(theme) + self.theme_combo_box.clear() self.theme_combo_box.addItem('') self.themes = theme_list + self.themes.sort(key=get_theme_key) self.theme_combo_box.addItems(theme_list) set_case_insensitive_completer(self.themes, self.theme_combo_box) diff --git a/openlp/plugins/songs/forms/songexportform.py b/openlp/plugins/songs/forms/songexportform.py index ba8e2738a..e8a559c44 100644 --- a/openlp/plugins/songs/forms/songexportform.py +++ b/openlp/plugins/songs/forms/songexportform.py @@ -203,6 +203,10 @@ class SongExportForm(OpenLPWizard): """ Set default form values for the song export wizard. """ + def get_song_key(song): + """Get the key to sort by""" + return song.sort_key + self.restart() self.finish_button.setVisible(False) self.cancel_button.setVisible(True) @@ -213,7 +217,7 @@ class SongExportForm(OpenLPWizard): # Load the list of songs. self.application.set_busy_cursor() songs = self.plugin.manager.get_all_objects(Song) - songs.sort(key=lambda song: song.sort_key) + songs.sort(key=get_song_key) for song in songs: # No need to export temporary songs. if song.temporary: diff --git a/openlp/plugins/songs/forms/songmaintenanceform.py b/openlp/plugins/songs/forms/songmaintenanceform.py index 1fdfb74d4..74462e6d0 100644 --- a/openlp/plugins/songs/forms/songmaintenanceform.py +++ b/openlp/plugins/songs/forms/songmaintenanceform.py @@ -27,6 +27,7 @@ from sqlalchemy.sql import and_ from openlp.core.common import Registry, RegistryProperties, UiStrings, translate from openlp.core.lib.ui import critical_error_message_box +from openlp.core.common.languagemanager import get_natural_key from openlp.plugins.songs.forms.authorsform import AuthorsForm from openlp.plugins.songs.forms.topicsform import TopicsForm from openlp.plugins.songs.forms.songbookform import SongBookForm @@ -120,8 +121,13 @@ class SongMaintenanceForm(QtWidgets.QDialog, Ui_SongMaintenanceDialog, RegistryP """ Reloads the Authors list. """ + def get_author_key(author): + """Get the key to sort by""" + return get_natural_key(author.display_name) + self.authors_list_widget.clear() - authors = self.manager.get_all_objects(Author, order_by_ref=Author.display_name) + authors = self.manager.get_all_objects(Author) + authors.sort(key=get_author_key) for author in authors: if author.display_name: author_name = QtWidgets.QListWidgetItem(author.display_name) @@ -134,8 +140,13 @@ class SongMaintenanceForm(QtWidgets.QDialog, Ui_SongMaintenanceDialog, RegistryP """ Reloads the Topics list. """ + def get_topic_key(topic): + """Get the key to sort by""" + return get_natural_key(topic.name) + self.topics_list_widget.clear() - topics = self.manager.get_all_objects(Topic, order_by_ref=Topic.name) + topics = self.manager.get_all_objects(Topic) + topics.sort(key=get_topic_key) for topic in topics: topic_name = QtWidgets.QListWidgetItem(topic.name) topic_name.setData(QtCore.Qt.UserRole, topic.id) @@ -145,8 +156,13 @@ class SongMaintenanceForm(QtWidgets.QDialog, Ui_SongMaintenanceDialog, RegistryP """ Reloads the Books list. """ + def get_book_key(book): + """Get the key to sort by""" + return get_natural_key(book.name) + self.song_books_list_widget.clear() - books = self.manager.get_all_objects(Book, order_by_ref=Book.name) + books = self.manager.get_all_objects(Book) + books.sort(key=get_book_key) for book in books: book_name = QtWidgets.QListWidgetItem('%s (%s)' % (book.name, book.publisher)) book_name.setData(QtCore.Qt.UserRole, book.id) diff --git a/openlp/plugins/songs/forms/songselectform.py b/openlp/plugins/songs/forms/songselectform.py index c5398fc0d..84ced5383 100755 --- a/openlp/plugins/songs/forms/songselectform.py +++ b/openlp/plugins/songs/forms/songselectform.py @@ -299,6 +299,7 @@ class SongSelectForm(QtWidgets.QDialog, Ui_SongSelectDialog): # Set up UI components self.view_button.setEnabled(False) self.search_button.setEnabled(False) + self.search_combobox.setEnabled(False) self.search_progress_bar.setMinimum(0) self.search_progress_bar.setMaximum(0) self.search_progress_bar.setValue(0) @@ -354,6 +355,7 @@ class SongSelectForm(QtWidgets.QDialog, Ui_SongSelectDialog): self.application.process_events() self.set_progress_visible(False) self.search_button.setEnabled(True) + self.search_combobox.setEnabled(True) self.application.process_events() def on_search_results_widget_selection_changed(self): diff --git a/openlp/plugins/songs/lib/db.py b/openlp/plugins/songs/lib/db.py index 5ea35d6b6..3026915e4 100644 --- a/openlp/plugins/songs/lib/db.py +++ b/openlp/plugins/songs/lib/db.py @@ -383,7 +383,7 @@ def init_schema(url): # Use lazy='joined' to always load authors when the song is fetched from the database (bug 1366198) 'authors': relation(Author, secondary=authors_songs_table, viewonly=True, lazy='joined'), 'media_files': relation(MediaFile, backref='songs', order_by=media_files_table.c.weight), - 'songbook_entries': relation(SongBookEntry, backref='song', cascade="all, delete-orphan"), + 'songbook_entries': relation(SongBookEntry, backref='song', cascade='all, delete-orphan'), 'topics': relation(Topic, backref='songs', secondary=songs_topics_table) }) mapper(Topic, topics_table) diff --git a/openlp/plugins/songs/lib/importers/openlp.py b/openlp/plugins/songs/lib/importers/openlp.py index e17fe138f..20c603e28 100644 --- a/openlp/plugins/songs/lib/importers/openlp.py +++ b/openlp/plugins/songs/lib/importers/openlp.py @@ -51,7 +51,7 @@ class OpenLPSongImport(SongImport): :param manager: The song manager for the running OpenLP installation. :param kwargs: The database providing the data to import. """ - SongImport.__init__(self, manager, **kwargs) + super(OpenLPSongImport, self).__init__(manager, **kwargs) self.source_session = None def do_import(self, progress_dialog=None): @@ -63,49 +63,61 @@ class OpenLPSongImport(SongImport): class OldAuthor(BaseModel): """ - Author model + Maps to the authors table """ pass class OldBook(BaseModel): """ - Book model + Maps to the songbooks table """ pass class OldMediaFile(BaseModel): """ - MediaFile model + Maps to the media_files table """ pass class OldSong(BaseModel): """ - Song model + Maps to the songs table """ pass class OldTopic(BaseModel): """ - Topic model + Maps to the topics table + """ + pass + + class OldSongBookEntry(BaseModel): + """ + Maps to the songs_songbooks table """ pass # Check the file type - if not self.import_source.endswith('.sqlite'): + if not isinstance(self.import_source, str) or not self.import_source.endswith('.sqlite'): self.log_error(self.import_source, translate('SongsPlugin.OpenLPSongImport', 'Not a valid OpenLP 2 song database.')) return self.import_source = 'sqlite:///%s' % self.import_source - # Load the db file + # Load the db file and reflect it engine = create_engine(self.import_source) source_meta = MetaData() source_meta.reflect(engine) self.source_session = scoped_session(sessionmaker(bind=engine)) + # Run some checks to see which version of the database we have if 'media_files' in list(source_meta.tables.keys()): has_media_files = True else: has_media_files = False + if 'songs_songbooks' in list(source_meta.tables.keys()): + has_songs_books = True + else: + has_songs_books = False + # Load up the tabls and map them out source_authors_table = source_meta.tables['authors'] source_song_books_table = source_meta.tables['song_books'] source_songs_table = source_meta.tables['songs'] @@ -113,6 +125,7 @@ class OpenLPSongImport(SongImport): source_authors_songs_table = source_meta.tables['authors_songs'] source_songs_topics_table = source_meta.tables['songs_topics'] source_media_files_songs_table = None + # Set up media_files relations if has_media_files: source_media_files_table = source_meta.tables['media_files'] source_media_files_songs_table = source_meta.tables.get('media_files_songs') @@ -120,9 +133,15 @@ class OpenLPSongImport(SongImport): class_mapper(OldMediaFile) except UnmappedClassError: mapper(OldMediaFile, source_media_files_table) + if has_songs_books: + source_songs_songbooks_table = source_meta.tables['songs_songbooks'] + try: + class_mapper(OldSongBookEntry) + except UnmappedClassError: + mapper(OldSongBookEntry, source_songs_songbooks_table, properties={'songbook': relation(OldBook)}) + # Set up the songs relationships song_props = { 'authors': relation(OldAuthor, backref='songs', secondary=source_authors_songs_table), - 'book': relation(OldBook, backref='songs'), 'topics': relation(OldTopic, backref='songs', secondary=source_songs_topics_table) } if has_media_files: @@ -134,6 +153,11 @@ class OpenLPSongImport(SongImport): relation(OldMediaFile, backref='songs', foreign_keys=[source_media_files_table.c.song_id], primaryjoin=source_songs_table.c.id == source_media_files_table.c.song_id) + if has_songs_books: + song_props['songbook_entries'] = relation(OldSongBookEntry, backref='song', cascade='all, delete-orphan') + else: + song_props['book'] = relation(OldBook, backref='songs') + # Map the rest of the tables try: class_mapper(OldAuthor) except UnmappedClassError: @@ -163,44 +187,54 @@ class OpenLPSongImport(SongImport): old_titles = song.search_title.split('@') if len(old_titles) > 1: new_song.alternate_title = old_titles[1] - # Values will be set when cleaning the song. + # Transfer the values to the new song object new_song.search_title = '' new_song.search_lyrics = '' - new_song.song_number = song.song_number new_song.lyrics = song.lyrics new_song.verse_order = song.verse_order new_song.copyright = song.copyright new_song.comments = song.comments new_song.theme_name = song.theme_name new_song.ccli_number = song.ccli_number + if hasattr(song, 'song_number') and song.song_number: + new_song.song_number = song.song_number + # Find or create all the authors and add them to the new song object for author in song.authors: existing_author = self.manager.get_object_filtered(Author, Author.display_name == author.display_name) - if existing_author is None: + if not existing_author: existing_author = Author.populate( first_name=author.first_name, last_name=author.last_name, display_name=author.display_name) new_song.add_author(existing_author) - if song.book: - existing_song_book = self.manager.get_object_filtered(Book, Book.name == song.book.name) - if existing_song_book is None: - existing_song_book = Book.populate(name=song.book.name, publisher=song.book.publisher) - new_song.book = existing_song_book + # Find or create all the topics and add them to the new song object if song.topics: for topic in song.topics: existing_topic = self.manager.get_object_filtered(Topic, Topic.name == topic.name) - if existing_topic is None: + if not existing_topic: existing_topic = Topic.populate(name=topic.name) new_song.topics.append(existing_topic) - if has_media_files: - if song.media_files: - for media_file in song.media_files: - existing_media_file = self.manager.get_object_filtered( - MediaFile, MediaFile.file_name == media_file.file_name) - if existing_media_file: - new_song.media_files.append(existing_media_file) - else: - new_song.media_files.append(MediaFile.populate(file_name=media_file.file_name)) + # Find or create all the songbooks and add them to the new song object + if has_songs_books and song.songbook_entries: + for entry in song.songbook_entries: + existing_book = self.manager.get_object_filtered(Book, Book.name == entry.songbook.name) + if not existing_book: + existing_book = Book.populate(name=entry.songbook.name, publisher=entry.songbook.publisher) + new_song.add_songbook_entry(existing_book, entry.entry) + elif song.book: + existing_book = self.manager.get_object_filtered(Book, Book.name == song.book.name) + if not existing_book: + existing_book = Book.populate(name=song.book.name, publisher=song.book.publisher) + new_song.add_songbook_entry(existing_book, '') + # Find or create all the media files and add them to the new song object + if has_media_files and song.media_files: + for media_file in song.media_files: + existing_media_file = self.manager.get_object_filtered( + MediaFile, MediaFile.file_name == media_file.file_name) + if existing_media_file: + new_song.media_files.append(existing_media_file) + else: + new_song.media_files.append(MediaFile.populate(file_name=media_file.file_name)) clean_song(self.manager, new_song) self.manager.save_object(new_song) if progress_dialog: diff --git a/openlp/plugins/songs/lib/mediaitem.py b/openlp/plugins/songs/lib/mediaitem.py index d724bfaf2..11deeb31d 100644 --- a/openlp/plugins/songs/lib/mediaitem.py +++ b/openlp/plugins/songs/lib/mediaitem.py @@ -21,7 +21,6 @@ ############################################################################### import logging -import re import os import shutil @@ -194,28 +193,30 @@ class SongMediaItem(MediaManagerItem): log.debug('Authors Search') search_string = '%' + search_keywords + '%' search_results = self.plugin.manager.get_all_objects( - Author, Author.display_name.like(search_string), Author.display_name.asc()) + Author, Author.display_name.like(search_string)) self.display_results_author(search_results) elif search_type == SongSearch.Topics: log.debug('Topics Search') search_string = '%' + search_keywords + '%' search_results = self.plugin.manager.get_all_objects( - Topic, Topic.name.like(search_string), Topic.name.asc()) + Topic, Topic.name.like(search_string)) self.display_results_topic(search_results) elif search_type == SongSearch.Books: log.debug('Songbook Search') search_keywords = search_keywords.rpartition(' ') search_book = search_keywords[0] + '%' search_entry = search_keywords[2] + '%' - search_results = (self.plugin.manager.session.query(SongBookEntry) + search_results = (self.plugin.manager.session.query(SongBookEntry.entry, Book.name, Song.title, Song.id) + .join(Song) .join(Book) - .filter(Book.name.like(search_book), SongBookEntry.entry.like(search_entry)).all()) + .filter(Book.name.like(search_book), SongBookEntry.entry.like(search_entry), + Song.temporary.is_(False)).all()) self.display_results_book(search_results) elif search_type == SongSearch.Themes: log.debug('Theme Search') search_string = '%' + search_keywords + '%' search_results = self.plugin.manager.get_all_objects( - Song, Song.theme_name.like(search_string), Song.theme_name.asc()) + Song, Song.theme_name.like(search_string)) self.display_results_themes(search_results) elif search_type == SongSearch.Copyright: log.debug('Copyright Search') @@ -258,10 +259,14 @@ class SongMediaItem(MediaManagerItem): :param search_results: A list of db Song objects :return: None """ + def get_song_key(song): + """Get the key to sort by""" + return song.sort_key + log.debug('display results Song') self.save_auto_select_id() self.list_view.clear() - search_results.sort(key=lambda song: song.sort_key) + search_results.sort(key=get_song_key) for song in search_results: # Do not display temporary songs if song.temporary: @@ -283,12 +288,20 @@ class SongMediaItem(MediaManagerItem): :param search_results: A list of db Author objects :return: None """ + def get_author_key(author): + """Get the key to sort by""" + return get_natural_key(author.display_name) + + def get_song_key(song): + """Get the key to sort by""" + return song.sort_key + log.debug('display results Author') self.list_view.clear() - search_results = sorted(search_results, key=lambda author: get_natural_key(author.display_name)) + search_results.sort(key=get_author_key) for author in search_results: - songs = sorted(author.songs, key=lambda song: song.sort_key) - for song in songs: + author.songs.sort(key=get_song_key) + for song in author.songs: # Do not display temporary songs if song.temporary: continue @@ -301,19 +314,20 @@ class SongMediaItem(MediaManagerItem): """ Display the song search results in the media manager list, grouped by book and entry - :param search_results: A list of db SongBookEntry objects + :param search_results: A tuple containing (songbook entry, book name, song title, song id) :return: None """ + def get_songbook_key(result): + """Get the key to sort by""" + return (get_natural_key(result[1]), get_natural_key(result[0]), get_natural_key(result[2])) + log.debug('display results Book') self.list_view.clear() - search_results = sorted(search_results, key=lambda songbook_entry: - (get_natural_key(songbook_entry.songbook.name), get_natural_key(songbook_entry.entry))) - for songbook_entry in search_results: - if songbook_entry.song.temporary: - continue - song_detail = '%s #%s: %s' % (songbook_entry.songbook.name, songbook_entry.entry, songbook_entry.song.title) + search_results.sort(key=get_songbook_key) + for result in search_results: + song_detail = '%s #%s: %s' % (result[1], result[0], result[2]) song_name = QtWidgets.QListWidgetItem(song_detail) - song_name.setData(QtCore.Qt.UserRole, songbook_entry.song.id) + song_name.setData(QtCore.Qt.UserRole, result[3]) self.list_view.addItem(song_name) def display_results_topic(self, search_results): @@ -323,12 +337,20 @@ class SongMediaItem(MediaManagerItem): :param search_results: A list of db Topic objects :return: None """ + def get_topic_key(topic): + """Get the key to sort by""" + return get_natural_key(topic.name) + + def get_song_key(song): + """Get the key to sort by""" + return song.sort_key + log.debug('display results Topic') self.list_view.clear() - search_results = sorted(search_results, key=lambda topic: get_natural_key(topic.name)) + search_results.sort(key=get_topic_key) for topic in search_results: - songs = sorted(topic.songs, key=lambda song: song.sort_key) - for song in songs: + topic.songs.sort(key=get_song_key) + for song in topic.songs: # Do not display temporary songs if song.temporary: continue @@ -344,10 +366,13 @@ class SongMediaItem(MediaManagerItem): :param search_results: A list of db Song objects :return: None """ + def get_theme_key(song): + """Get the key to sort by""" + return (get_natural_key(song.theme_name), song.sort_key) + log.debug('display results Themes') self.list_view.clear() - search_results = sorted(search_results, key=lambda song: (get_natural_key(song.theme_name), - song.sort_key)) + search_results.sort(key=get_theme_key) for song in search_results: # Do not display temporary songs if song.temporary: @@ -364,11 +389,14 @@ class SongMediaItem(MediaManagerItem): :param search_results: A list of db Song objects :return: None """ + def get_cclinumber_key(song): + """Get the key to sort by""" + return (get_natural_key(song.ccli_number), song.sort_key) + log.debug('display results CCLI number') self.list_view.clear() - songs = sorted(search_results, key=lambda song: (get_natural_key(song.ccli_number), - song.sort_key)) - for song in songs: + search_results.sort(key=get_cclinumber_key) + for song in search_results: # Do not display temporary songs if song.temporary: continue diff --git a/resources/images/ios_app_qr.png b/resources/images/ios_app_qr.png new file mode 100644 index 000000000..c7244fc33 Binary files /dev/null and b/resources/images/ios_app_qr.png differ diff --git a/resources/images/openlp-2.qrc b/resources/images/openlp-2.qrc index 370473673..f2619b0c7 100644 --- a/resources/images/openlp-2.qrc +++ b/resources/images/openlp-2.qrc @@ -206,5 +206,6 @@ android_app_qr.png + ios_app_qr.png diff --git a/scripts/check_dependencies.py b/scripts/check_dependencies.py index a37ba5374..e6f7d2c37 100755 --- a/scripts/check_dependencies.py +++ b/scripts/check_dependencies.py @@ -102,6 +102,7 @@ OPTIONAL_MODULES = [ ('nose', '(testing framework)', True), ('mock', '(testing module)', sys.version_info[1] < 3), ('jenkins', '(access jenkins api - package name: jenkins-webapi)', True), + ('pysword', '(import SWORD bibles)', True), ] w = sys.stdout.write diff --git a/tests/functional/openlp_core_lib/test_htmlbuilder.py b/tests/functional/openlp_core_lib/test_htmlbuilder.py index 8ca98060d..58841eb90 100644 --- a/tests/functional/openlp_core_lib/test_htmlbuilder.py +++ b/tests/functional/openlp_core_lib/test_htmlbuilder.py @@ -197,6 +197,7 @@ FOOTER_CSS_BASE = """ """ FOOTER_CSS = FOOTER_CSS_BASE % ('nowrap') FOOTER_CSS_WRAP = FOOTER_CSS_BASE % ('normal') +FOOTER_CSS_INVALID = '' class Htmbuilder(TestCase, TestMixin): @@ -359,6 +360,27 @@ class Htmbuilder(TestCase, TestMixin): # THEN: Footer should wrap self.assertEqual(FOOTER_CSS_WRAP, css, 'The footer strings should be equal.') + def build_footer_invalid_test(self): + """ + Test the build_footer_css() function + """ + # GIVEN: Create a theme. + css = [] + item = MagicMock() + item.theme_data = None + item.footer = 'FAIL' + height = 1024 + + # WHEN: Settings say that footer should wrap + css.append(build_footer_css(item, height)) + item.theme_data = 'TEST' + item.footer = None + css.append(build_footer_css(item, height)) + + # THEN: Footer should wrap + self.assertEqual(FOOTER_CSS_INVALID, css[0], 'The footer strings should be blank.') + self.assertEqual(FOOTER_CSS_INVALID, css[1], 'The footer strings should be blank.') + def webkit_version_test(self): """ Test the webkit_version() function diff --git a/tests/functional/openlp_core_lib/test_projector_pjlink1.py b/tests/functional/openlp_core_lib/test_projector_pjlink1.py index 5cd032314..5d0d26ceb 100644 --- a/tests/functional/openlp_core_lib/test_projector_pjlink1.py +++ b/tests/functional/openlp_core_lib/test_projector_pjlink1.py @@ -124,3 +124,30 @@ class TestPJLink(TestCase): 'Lamp power status should have been set to TRUE') self.assertEquals(pjlink.lamp[0]['Hours'], 22222, 'Lamp hours should have been set to 22222') + + @patch.object(pjlink_test, 'projectorReceivedData') + def projector_process_multiple_lamp_test(self, mock_projectorReceivedData): + """ + Test setting multiple lamp on/off and hours + """ + # GIVEN: Test object + pjlink = pjlink_test + + # WHEN: Call process_command with lamp data + pjlink.process_command('LAMP', '11111 1 22222 0 33333 1') + + # THEN: Lamp should have been set with proper lamp status + self.assertEquals(len(pjlink.lamp), 3, + 'Projector should have 3 lamps specified') + self.assertEquals(pjlink.lamp[0]['On'], True, + 'Lamp 1 power status should have been set to TRUE') + self.assertEquals(pjlink.lamp[0]['Hours'], 11111, + 'Lamp 1 hours should have been set to 11111') + self.assertEquals(pjlink.lamp[1]['On'], False, + 'Lamp 2 power status should have been set to FALSE') + self.assertEquals(pjlink.lamp[1]['Hours'], 22222, + 'Lamp 2 hours should have been set to 22222') + self.assertEquals(pjlink.lamp[2]['On'], True, + 'Lamp 3 power status should have been set to TRUE') + self.assertEquals(pjlink.lamp[2]['Hours'], 33333, + 'Lamp 3 hours should have been set to 33333') diff --git a/tests/functional/openlp_core_ui/test_mainwindow.py b/tests/functional/openlp_core_ui/test_mainwindow.py index 8dcfd0518..8a8b2516c 100644 --- a/tests/functional/openlp_core_ui/test_mainwindow.py +++ b/tests/functional/openlp_core_ui/test_mainwindow.py @@ -26,6 +26,8 @@ import os from unittest import TestCase +from PyQt5 import QtWidgets + from openlp.core.ui.mainwindow import MainWindow from openlp.core.lib.ui import UiStrings from openlp.core.common.registry import Registry @@ -189,3 +191,57 @@ class TestMainWindow(TestCase, TestMixin): # THEN: The media manager dock is made visible self.assertEqual(0, mocked_media_manager_dock.setVisible.call_count) mocked_widget.on_focus.assert_called_with() + + @patch('openlp.core.ui.mainwindow.MainWindow.plugin_manager') + @patch('openlp.core.ui.mainwindow.MainWindow.first_time') + @patch('openlp.core.ui.mainwindow.MainWindow.application') + @patch('openlp.core.ui.mainwindow.FirstTimeForm') + @patch('openlp.core.ui.mainwindow.QtWidgets.QMessageBox.warning') + @patch('openlp.core.ui.mainwindow.Settings') + def on_first_time_wizard_clicked_show_projectors_after_test(self, mocked_Settings, mocked_warning, + mocked_FirstTimeForm, mocked_application, + mocked_first_time, + mocked_plugin_manager): + # GIVEN: Main_window, patched things, patched "Yes" as confirmation to re-run wizard, settings to True. + mocked_Settings_obj = MagicMock() + mocked_Settings_obj.value.return_value = True + mocked_Settings.return_value = mocked_Settings_obj + mocked_warning.return_value = QtWidgets.QMessageBox.Yes + mocked_FirstTimeForm_obj = MagicMock() + mocked_FirstTimeForm_obj.was_cancelled = False + mocked_FirstTimeForm.return_value = mocked_FirstTimeForm_obj + mocked_plugin_manager.plugins = [] + self.main_window.projector_manager_dock = MagicMock() + + # WHEN: on_first_time_wizard_clicked is called + self.main_window.on_first_time_wizard_clicked() + + # THEN: projector_manager_dock.setVisible should had been called once + self.main_window.projector_manager_dock.setVisible.assert_called_once_with(True) + + @patch('openlp.core.ui.mainwindow.MainWindow.plugin_manager') + @patch('openlp.core.ui.mainwindow.MainWindow.first_time') + @patch('openlp.core.ui.mainwindow.MainWindow.application') + @patch('openlp.core.ui.mainwindow.FirstTimeForm') + @patch('openlp.core.ui.mainwindow.QtWidgets.QMessageBox.warning') + @patch('openlp.core.ui.mainwindow.Settings') + def on_first_time_wizard_clicked_hide_projectors_after_test(self, mocked_Settings, mocked_warning, + mocked_FirstTimeForm, mocked_application, + mocked_first_time, + mocked_plugin_manager): + # GIVEN: Main_window, patched things, patched "Yes" as confirmation to re-run wizard, settings to False. + mocked_Settings_obj = MagicMock() + mocked_Settings_obj.value.return_value = False + mocked_Settings.return_value = mocked_Settings_obj + mocked_warning.return_value = QtWidgets.QMessageBox.Yes + mocked_FirstTimeForm_obj = MagicMock() + mocked_FirstTimeForm_obj.was_cancelled = False + mocked_FirstTimeForm.return_value = mocked_FirstTimeForm_obj + mocked_plugin_manager.plugins = [] + self.main_window.projector_manager_dock = MagicMock() + + # WHEN: on_first_time_wizard_clicked is called + self.main_window.on_first_time_wizard_clicked() + + # THEN: projector_manager_dock.setVisible should had been called once + self.main_window.projector_manager_dock.setVisible.assert_called_once_with(False) diff --git a/tests/functional/openlp_plugins/bibles/test_swordimport.py b/tests/functional/openlp_plugins/bibles/test_swordimport.py new file mode 100644 index 000000000..ae4d9cdf9 --- /dev/null +++ b/tests/functional/openlp_plugins/bibles/test_swordimport.py @@ -0,0 +1,109 @@ +# -*- coding: utf-8 -*- +# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4 + +############################################################################### +# OpenLP - Open Source Lyrics Projection # +# --------------------------------------------------------------------------- # +# Copyright (c) 2008-2016 OpenLP Developers # +# --------------------------------------------------------------------------- # +# 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; version 2 of the License. # +# # +# 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., 59 # +# Temple Place, Suite 330, Boston, MA 02111-1307 USA # +############################################################################### +""" +This module contains tests for the SWORD Bible importer. +""" + +import os +import json +from unittest import TestCase, SkipTest + +from tests.functional import MagicMock, patch +try: + from openlp.plugins.bibles.lib.sword import SwordBible +except ImportError: + raise SkipTest('PySword is not installed, skipping SWORD test.') +from openlp.plugins.bibles.lib.db import BibleDB + +TEST_PATH = os.path.abspath(os.path.join(os.path.dirname(__file__), + '..', '..', '..', 'resources', 'bibles')) + + +class TestSwordImport(TestCase): + """ + Test the functions in the :mod:`swordimport` module. + """ + + def setUp(self): + self.registry_patcher = patch('openlp.plugins.bibles.lib.db.Registry') + self.registry_patcher.start() + self.manager_patcher = patch('openlp.plugins.bibles.lib.db.Manager') + self.manager_patcher.start() + + def tearDown(self): + self.registry_patcher.stop() + self.manager_patcher.stop() + + def create_importer_test(self): + """ + Test creating an instance of the Sword file importer + """ + # GIVEN: A mocked out "manager" + mocked_manager = MagicMock() + + # WHEN: An importer object is created + importer = SwordBible(mocked_manager, path='.', name='.', filename='', sword_key='', sword_path='') + + # THEN: The importer should be an instance of BibleDB + self.assertIsInstance(importer, BibleDB) + + @patch('openlp.plugins.bibles.lib.sword.SwordBible.application') + @patch('openlp.plugins.bibles.lib.sword.modules') + @patch('openlp.plugins.bibles.lib.db.BiblesResourcesDB') + def simple_import_test(self, mocked_bible_res_db, mocked_pysword_modules, mocked_application): + """ + Test that a simple SWORD import works + """ + # GIVEN: Test files with a mocked out "manager", "import_wizard", and mocked functions + # get_book_ref_id_by_name, create_verse, create_book, session and get_language. + # Also mocked pysword structures + mocked_manager = MagicMock() + mocked_import_wizard = MagicMock() + importer = SwordBible(mocked_manager, path='.', name='.', filename='', sword_key='', sword_path='') + result_file = open(os.path.join(TEST_PATH, 'dk1933.json'), 'rb') + test_data = json.loads(result_file.read().decode()) + importer.wizard = mocked_import_wizard + importer.get_book_ref_id_by_name = MagicMock() + importer.create_verse = MagicMock() + importer.create_book = MagicMock() + importer.session = MagicMock() + mocked_bible_res_db.get_language.return_value = 'Danish' + mocked_bible = MagicMock() + mocked_genesis = MagicMock() + mocked_genesis.name = 'Genesis' + mocked_genesis.num_chapters = 1 + books = {'ot': [mocked_genesis]} + mocked_structure = MagicMock() + mocked_structure.get_books.return_value = books + mocked_bible.get_structure.return_value = mocked_structure + mocked_bible.get_iter.return_value = [verse[1] for verse in test_data['verses']] + mocked_module = MagicMock() + mocked_module.get_bible_from_module.return_value = mocked_bible + mocked_pysword_modules.SwordModules.return_value = mocked_module + + # WHEN: Importing bible file + importer.do_import() + + # THEN: The create_verse() method should have been called with each verse in the file. + self.assertTrue(importer.create_verse.called) + for verse_tag, verse_text in test_data['verses']: + importer.create_verse.assert_any_call(importer.create_book().id, 1, int(verse_tag), verse_text) diff --git a/tests/functional/openlp_plugins/media/test_mediaplugin.py b/tests/functional/openlp_plugins/media/test_mediaplugin.py index 1e11de4fa..c49cdbaa4 100644 --- a/tests/functional/openlp_plugins/media/test_mediaplugin.py +++ b/tests/functional/openlp_plugins/media/test_mediaplugin.py @@ -25,7 +25,7 @@ Test the media plugin from unittest import TestCase from openlp.core import Registry -from openlp.plugins.media.mediaplugin import MediaPlugin +from openlp.plugins.media.mediaplugin import MediaPlugin, process_check_binary from tests.functional import MagicMock, patch from tests.helpers.testmixin import TestMixin @@ -63,3 +63,29 @@ class MediaPluginTest(TestCase, TestMixin): self.assertIsInstance(MediaPlugin.about(), str) # THEN: about() should return a non-empty string self.assertNotEquals(len(MediaPlugin.about()), 0) + + @patch('openlp.plugins.media.mediaplugin.check_binary_exists') + def process_check_binary_pass_test(self, mocked_checked_binary_exists): + """ + Test that the Process check returns true if found + """ + # GIVEN: A media plugin instance + # WHEN: function is called with the correct name + mocked_checked_binary_exists.return_value = str.encode('MediaInfo Command line') + result = process_check_binary('MediaInfo') + + # THEN: The the result should be True + self.assertTrue(result, 'Mediainfo should have been found') + + @patch('openlp.plugins.media.mediaplugin.check_binary_exists') + def process_check_binary_fail_test(self, mocked_checked_binary_exists): + """ + Test that the Process check returns false if not found + """ + # GIVEN: A media plugin instance + # WHEN: function is called with the wrong name + mocked_checked_binary_exists.return_value = str.encode('MediaInfo1 Command line') + result = process_check_binary("MediaInfo1") + + # THEN: The the result should be True + self.assertFalse(result, "Mediainfo should not have been found") diff --git a/tests/functional/openlp_plugins/songs/test_mediaitem.py b/tests/functional/openlp_plugins/songs/test_mediaitem.py index 3cd5f97ba..12447368b 100644 --- a/tests/functional/openlp_plugins/songs/test_mediaitem.py +++ b/tests/functional/openlp_plugins/songs/test_mediaitem.py @@ -23,6 +23,7 @@ This module contains tests for the lib submodule of the Songs plugin. """ from unittest import TestCase +from unittest.mock import call from PyQt5 import QtCore @@ -53,6 +54,7 @@ class TestMediaItem(TestCase, TestMixin): self.media_item.list_view.save_auto_select_id = MagicMock() self.media_item.list_view.clear = MagicMock() self.media_item.list_view.addItem = MagicMock() + self.media_item.list_view.setCurrentItem = MagicMock() self.media_item.auto_select_id = -1 self.media_item.display_songbook = False self.media_item.display_copyright_symbol = False @@ -79,13 +81,22 @@ class TestMediaItem(TestCase, TestMixin): mock_song.title = 'My Song' mock_song.sort_key = 'My Song' mock_song.authors = [] + mock_song_temp = MagicMock() + mock_song_temp.id = 2 + mock_song_temp.title = 'My Temporary' + mock_song_temp.sort_key = 'My Temporary' + mock_song_temp.authors = [] mock_author = MagicMock() mock_author.display_name = 'My Author' mock_song.authors.append(mock_author) + mock_song_temp.authors.append(mock_author) mock_song.temporary = False + mock_song_temp.temporary = True mock_search_results.append(mock_song) + mock_search_results.append(mock_song_temp) mock_qlist_widget = MagicMock() MockedQListWidgetItem.return_value = mock_qlist_widget + self.media_item.auto_select_id = 1 # WHEN: I display song search results self.media_item.display_results_song(mock_search_results) @@ -93,9 +104,10 @@ class TestMediaItem(TestCase, TestMixin): # THEN: The current list view is cleared, the widget is created, and the relevant attributes set self.media_item.list_view.clear.assert_called_with() self.media_item.save_auto_select_id.assert_called_with() - MockedQListWidgetItem.assert_called_with('My Song (My Author)') - mock_qlist_widget.setData.assert_called_with(MockedUserRole, mock_song.id) - self.media_item.list_view.addItem.assert_called_with(mock_qlist_widget) + MockedQListWidgetItem.assert_called_once_with('My Song (My Author)') + mock_qlist_widget.setData.assert_called_once_with(MockedUserRole, mock_song.id) + self.media_item.list_view.addItem.assert_called_once_with(mock_qlist_widget) + self.media_item.list_view.setCurrentItem.assert_called_with(mock_qlist_widget) def display_results_author_test(self): """ @@ -107,13 +119,19 @@ class TestMediaItem(TestCase, TestMixin): mock_search_results = [] mock_author = MagicMock() mock_song = MagicMock() + mock_song_temp = MagicMock() mock_author.display_name = 'My Author' mock_author.songs = [] mock_song.id = 1 mock_song.title = 'My Song' mock_song.sort_key = 'My Song' mock_song.temporary = False + mock_song_temp.id = 2 + mock_song_temp.title = 'My Temporary' + mock_song_temp.sort_key = 'My Temporary' + mock_song_temp.temporary = True mock_author.songs.append(mock_song) + mock_author.songs.append(mock_song_temp) mock_search_results.append(mock_author) mock_qlist_widget = MagicMock() MockedQListWidgetItem.return_value = mock_qlist_widget @@ -123,9 +141,9 @@ class TestMediaItem(TestCase, TestMixin): # THEN: The current list view is cleared, the widget is created, and the relevant attributes set self.media_item.list_view.clear.assert_called_with() - MockedQListWidgetItem.assert_called_with('My Author (My Song)') - mock_qlist_widget.setData.assert_called_with(MockedUserRole, mock_song.id) - self.media_item.list_view.addItem.assert_called_with(mock_qlist_widget) + MockedQListWidgetItem.assert_called_once_with('My Author (My Song)') + mock_qlist_widget.setData.assert_called_once_with(MockedUserRole, mock_song.id) + self.media_item.list_view.addItem.assert_called_once_with(mock_qlist_widget) def display_results_book_test(self): """ @@ -134,19 +152,7 @@ class TestMediaItem(TestCase, TestMixin): # GIVEN: Search results grouped by book and entry, plus a mocked QtListWidgetItem with patch('openlp.core.lib.QtWidgets.QListWidgetItem') as MockedQListWidgetItem, \ patch('openlp.core.lib.QtCore.Qt.UserRole') as MockedUserRole: - mock_search_results = [] - mock_songbook_entry = MagicMock() - mock_songbook = MagicMock() - mock_song = MagicMock() - mock_songbook_entry.entry = '1' - mock_songbook.name = 'My Book' - mock_song.id = 1 - mock_song.title = 'My Song' - mock_song.sort_key = 'My Song' - mock_song.temporary = False - mock_songbook_entry.song = mock_song - mock_songbook_entry.songbook = mock_songbook - mock_search_results.append(mock_songbook_entry) + mock_search_results = [('1', 'My Book', 'My Song', 1)] mock_qlist_widget = MagicMock() MockedQListWidgetItem.return_value = mock_qlist_widget @@ -155,9 +161,35 @@ class TestMediaItem(TestCase, TestMixin): # THEN: The current list view is cleared, the widget is created, and the relevant attributes set self.media_item.list_view.clear.assert_called_with() - MockedQListWidgetItem.assert_called_with('My Book #1: My Song') - mock_qlist_widget.setData.assert_called_with(MockedUserRole, mock_songbook_entry.song.id) - self.media_item.list_view.addItem.assert_called_with(mock_qlist_widget) + MockedQListWidgetItem.assert_called_once_with('My Book #1: My Song') + mock_qlist_widget.setData.assert_called_once_with(MockedUserRole, 1) + self.media_item.list_view.addItem.assert_called_once_with(mock_qlist_widget) + + def songbook_natural_sorting_test(self): + """ + Test that songbooks are sorted naturally + """ + # GIVEN: Search results grouped by book and entry, plus a mocked QtListWidgetItem + with patch('openlp.core.lib.QtWidgets.QListWidgetItem') as MockedQListWidgetItem: + mock_search_results = [('2', 'Thy Book', 'Thy Song', 50), + ('2', 'My Book', 'Your Song', 7), + ('10', 'My Book', 'Our Song', 12), + ('1', 'My Book', 'My Song', 1), + ('2', 'Thy Book', 'A Song', 8)] + mock_qlist_widget = MagicMock() + MockedQListWidgetItem.return_value = mock_qlist_widget + + # WHEN: I display song search results grouped by book + self.media_item.display_results_book(mock_search_results) + + # THEN: The songbooks are inserted in the right (natural) order, + # grouped first by book, then by number, then by song title + calls = [call('My Book #1: My Song'), call().setData(QtCore.Qt.UserRole, 1), + call('My Book #2: Your Song'), call().setData(QtCore.Qt.UserRole, 7), + call('My Book #10: Our Song'), call().setData(QtCore.Qt.UserRole, 12), + call('Thy Book #2: A Song'), call().setData(QtCore.Qt.UserRole, 8), + call('Thy Book #2: Thy Song'), call().setData(QtCore.Qt.UserRole, 50)] + MockedQListWidgetItem.assert_has_calls(calls) def display_results_topic_test(self): """ @@ -169,13 +201,19 @@ class TestMediaItem(TestCase, TestMixin): mock_search_results = [] mock_topic = MagicMock() mock_song = MagicMock() + mock_song_temp = MagicMock() mock_topic.name = 'My Topic' mock_topic.songs = [] mock_song.id = 1 mock_song.title = 'My Song' mock_song.sort_key = 'My Song' mock_song.temporary = False + mock_song_temp.id = 2 + mock_song_temp.title = 'My Temporary' + mock_song_temp.sort_key = 'My Temporary' + mock_song_temp.temporary = True mock_topic.songs.append(mock_song) + mock_topic.songs.append(mock_song_temp) mock_search_results.append(mock_topic) mock_qlist_widget = MagicMock() MockedQListWidgetItem.return_value = mock_qlist_widget @@ -185,9 +223,9 @@ class TestMediaItem(TestCase, TestMixin): # THEN: The current list view is cleared, the widget is created, and the relevant attributes set self.media_item.list_view.clear.assert_called_with() - MockedQListWidgetItem.assert_called_with('My Topic (My Song)') - mock_qlist_widget.setData.assert_called_with(MockedUserRole, mock_song.id) - self.media_item.list_view.addItem.assert_called_with(mock_qlist_widget) + MockedQListWidgetItem.assert_called_once_with('My Topic (My Song)') + mock_qlist_widget.setData.assert_called_once_with(MockedUserRole, mock_song.id) + self.media_item.list_view.addItem.assert_called_once_with(mock_qlist_widget) def display_results_themes_test(self): """ @@ -198,12 +236,19 @@ class TestMediaItem(TestCase, TestMixin): patch('openlp.core.lib.QtCore.Qt.UserRole') as MockedUserRole: mock_search_results = [] mock_song = MagicMock() + mock_song_temp = MagicMock() mock_song.id = 1 mock_song.title = 'My Song' mock_song.sort_key = 'My Song' mock_song.theme_name = 'My Theme' mock_song.temporary = False + mock_song_temp.id = 2 + mock_song_temp.title = 'My Temporary' + mock_song_temp.sort_key = 'My Temporary' + mock_song_temp.theme_name = 'My Theme' + mock_song_temp.temporary = True mock_search_results.append(mock_song) + mock_search_results.append(mock_song_temp) mock_qlist_widget = MagicMock() MockedQListWidgetItem.return_value = mock_qlist_widget @@ -212,9 +257,9 @@ class TestMediaItem(TestCase, TestMixin): # THEN: The current list view is cleared, the widget is created, and the relevant attributes set self.media_item.list_view.clear.assert_called_with() - MockedQListWidgetItem.assert_called_with('My Theme (My Song)') - mock_qlist_widget.setData.assert_called_with(MockedUserRole, mock_song.id) - self.media_item.list_view.addItem.assert_called_with(mock_qlist_widget) + MockedQListWidgetItem.assert_called_once_with('My Theme (My Song)') + mock_qlist_widget.setData.assert_called_once_with(MockedUserRole, mock_song.id) + self.media_item.list_view.addItem.assert_called_once_with(mock_qlist_widget) def display_results_cclinumber_test(self): """ @@ -225,12 +270,19 @@ class TestMediaItem(TestCase, TestMixin): patch('openlp.core.lib.QtCore.Qt.UserRole') as MockedUserRole: mock_search_results = [] mock_song = MagicMock() + mock_song_temp = MagicMock() mock_song.id = 1 mock_song.title = 'My Song' mock_song.sort_key = 'My Song' mock_song.ccli_number = '12345' mock_song.temporary = False + mock_song_temp.id = 2 + mock_song_temp.title = 'My Temporary' + mock_song_temp.sort_key = 'My Temporary' + mock_song_temp.ccli_number = '12346' + mock_song_temp.temporary = True mock_search_results.append(mock_song) + mock_search_results.append(mock_song_temp) mock_qlist_widget = MagicMock() MockedQListWidgetItem.return_value = mock_qlist_widget @@ -239,9 +291,9 @@ class TestMediaItem(TestCase, TestMixin): # THEN: The current list view is cleared, the widget is created, and the relevant attributes set self.media_item.list_view.clear.assert_called_with() - MockedQListWidgetItem.assert_called_with('12345 (My Song)') - mock_qlist_widget.setData.assert_called_with(MockedUserRole, mock_song.id) - self.media_item.list_view.addItem.assert_called_with(mock_qlist_widget) + MockedQListWidgetItem.assert_called_once_with('12345 (My Song)') + mock_qlist_widget.setData.assert_called_once_with(MockedUserRole, mock_song.id) + self.media_item.list_view.addItem.assert_called_once_with(mock_qlist_widget) def build_song_footer_one_author_test(self): """ diff --git a/tests/functional/openlp_plugins/songs/test_openlpimporter.py b/tests/functional/openlp_plugins/songs/test_openlpimporter.py new file mode 100644 index 000000000..b78d5c43b --- /dev/null +++ b/tests/functional/openlp_plugins/songs/test_openlpimporter.py @@ -0,0 +1,75 @@ +# -*- coding: utf-8 -*- +# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4 + +############################################################################### +# OpenLP - Open Source Lyrics Projection # +# --------------------------------------------------------------------------- # +# Copyright (c) 2008-2016 OpenLP Developers # +# --------------------------------------------------------------------------- # +# 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; version 2 of the License. # +# # +# 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., 59 # +# Temple Place, Suite 330, Boston, MA 02111-1307 USA # +############################################################################### +""" +This module contains tests for the OpenLP song importer. +""" +from unittest import TestCase + +from openlp.plugins.songs.lib.importers.openlp import OpenLPSongImport +from openlp.core.common import Registry +from tests.functional import patch, MagicMock + + +class TestOpenLPImport(TestCase): + """ + Test the functions in the :mod:`openlp` importer module. + """ + def setUp(self): + """ + Create the registry + """ + Registry.create() + + def create_importer_test(self): + """ + Test creating an instance of the OpenLP database importer + """ + # GIVEN: A mocked out SongImport class, and a mocked out "manager" + with patch('openlp.plugins.songs.lib.importers.openlp.SongImport'): + mocked_manager = MagicMock() + + # WHEN: An importer object is created + importer = OpenLPSongImport(mocked_manager, filenames=[]) + + # THEN: The importer object should not be None + self.assertIsNotNone(importer, 'Import should not be none') + + def invalid_import_source_test(self): + """ + Test OpenLPSongImport.do_import handles different invalid import_source values + """ + # GIVEN: A mocked out SongImport class, and a mocked out "manager" + with patch('openlp.plugins.songs.lib.importers.openlp.SongImport'): + mocked_manager = MagicMock() + mocked_import_wizard = MagicMock() + importer = OpenLPSongImport(mocked_manager, filenames=[]) + importer.import_wizard = mocked_import_wizard + importer.stop_import_flag = True + + # WHEN: Import source is not a list + for source in ['not a list', 0]: + importer.import_source = source + + # THEN: do_import should return none and the progress bar maximum should not be set. + self.assertIsNone(importer.do_import(), 'do_import should return None when import_source is not a list') + self.assertEqual(mocked_import_wizard.progress_bar.setMaximum.called, False, + 'setMaximum on import_wizard.progress_bar should not have been called') diff --git a/tests/functional/openlp_plugins/songs/test_songselect.py b/tests/functional/openlp_plugins/songs/test_songselect.py index 5a94ee1ac..18ada0338 100644 --- a/tests/functional/openlp_plugins/songs/test_songselect.py +++ b/tests/functional/openlp_plugins/songs/test_songselect.py @@ -716,8 +716,43 @@ class TestSongSelectForm(TestCase, TestMixin): # WHEN: The stop button is clicked ssform.on_stop_button_clicked() - # THEN: The view button should be enabled + # THEN: The view button, search box and search button should be enabled mocked_song_select_importer.stop.assert_called_with() + self.assertTrue(ssform.search_button.isEnabled()) + self.assertTrue(ssform.search_combobox.isEnabled()) + + @patch('openlp.plugins.songs.forms.songselectform.Settings') + @patch('openlp.plugins.songs.forms.songselectform.QtCore.QThread') + @patch('openlp.plugins.songs.forms.songselectform.SearchWorker') + def on_search_button_clicked_test(self, MockedSearchWorker, MockedQtThread, MockedSettings): + """ + Test that search fields are disabled when search button is clicked. + """ + # GIVEN: A mocked SongSelect form + ssform = SongSelectForm(None, MagicMock(), MagicMock()) + ssform.initialise() + + # WHEN: The search button is clicked + ssform.on_search_button_clicked() + + # THEN: The search box and search button should be disabled + self.assertFalse(ssform.search_button.isEnabled()) + self.assertFalse(ssform.search_combobox.isEnabled()) + + def on_search_finished_test(self): + """ + Test that search fields are enabled when search is finished. + """ + # GIVEN: A mocked SongSelect form + ssform = SongSelectForm(None, MagicMock(), MagicMock()) + ssform.initialise() + + # WHEN: The search is finished + ssform.on_search_finished() + + # THEN: The search box and search button should be enabled + self.assertTrue(ssform.search_button.isEnabled()) + self.assertTrue(ssform.search_combobox.isEnabled()) class TestSongSelectFileImport(SongImportTestHelper): diff --git a/tests/interfaces/openlp_plugins/bibles/forms/test_bibleimportform.py b/tests/interfaces/openlp_plugins/bibles/forms/test_bibleimportform.py index 76d0195f5..25dcb9d45 100644 --- a/tests/interfaces/openlp_plugins/bibles/forms/test_bibleimportform.py +++ b/tests/interfaces/openlp_plugins/bibles/forms/test_bibleimportform.py @@ -27,7 +27,7 @@ from unittest import TestCase from PyQt5 import QtWidgets from openlp.core.common import Registry -from openlp.plugins.bibles.forms.bibleimportform import BibleImportForm, WebDownload +import openlp.plugins.bibles.forms.bibleimportform as bibleimportform from tests.helpers.testmixin import TestMixin from tests.functional import MagicMock, patch @@ -46,7 +46,8 @@ class TestBibleImportForm(TestCase, TestMixin): self.setup_application() self.main_window = QtWidgets.QMainWindow() Registry().register('main_window', self.main_window) - self.form = BibleImportForm(self.main_window, MagicMock(), MagicMock()) + bibleimportform.PYSWORD_AVAILABLE = False + self.form = bibleimportform.BibleImportForm(self.main_window, MagicMock(), MagicMock()) def tearDown(self): """ @@ -76,3 +77,16 @@ class TestBibleImportForm(TestCase, TestMixin): # THEN: The webbible list should still be empty self.assertEqual(self.form.web_bible_list, {}, 'The webbible list should be empty') + + def custom_init_test(self): + """ + Test that custom_init works as expected if pysword is unavailable + """ + # GIVEN: A mocked sword_tab_widget + self.form.sword_tab_widget = MagicMock() + + # WHEN: Running custom_init + self.form.custom_init() + + # THEN: sword_tab_widget.setDisabled(True) should have been called + self.form.sword_tab_widget.setDisabled.assert_called_with(True)