diff --git a/.bzrignore b/.bzrignore
index b91d4fc93..a0c3f0b4f 100644
--- a/.bzrignore
+++ b/.bzrignore
@@ -6,6 +6,8 @@
*.ropeproject
*.e4*
.eric4project
+.komodotools
+*.komodoproject
list
openlp.org 2.0.e4*
documentation/build/html
@@ -30,3 +32,4 @@ tests.kdev4
*.orig
__pycache__
*.dll
+.directory
diff --git a/MANIFEST.in b/MANIFEST.in
index 35e83e30f..be81efb23 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -5,6 +5,8 @@ recursive-include openlp *.html
recursive-include openlp *.js
recursive-include openlp *.css
recursive-include openlp *.png
+recursive-include openlp *.ps
+recursive-include openlp *.json
recursive-include documentation *
recursive-include resources *
recursive-include scripts *
diff --git a/README.txt b/README.txt
index b937e1d5f..04294b1b8 100644
--- a/README.txt
+++ b/README.txt
@@ -1,16 +1,15 @@
-OpenLP 2.0
-==========
+OpenLP
+======
You're probably reading this because you've just downloaded the source code for
-OpenLP 2.0. If you are looking for the installer file, please go to the download
+OpenLP. If you are looking for the installer file, please go to the download
page on the web site::
- http://openlp.org/en/download.html
+ http://openlp.org/download
If you're looking for how to contribute to OpenLP, then please look at the
OpenLP wiki::
http://wiki.openlp.org/
-Thanks for downloading OpenLP 2.0!
-
+Thanks for downloading OpenLP!
diff --git a/openlp/core/common/applocation.py b/openlp/core/common/applocation.py
index 1fce25000..073d3c7f7 100644
--- a/openlp/core/common/applocation.py
+++ b/openlp/core/common/applocation.py
@@ -72,15 +72,15 @@ class AppLocation(object):
:param dir_type: The directory type you want, for instance the data directory. Default *AppLocation.AppDir*
"""
if dir_type == AppLocation.AppDir:
- return get_frozen_path(os.path.abspath(os.path.split(sys.argv[0])[0]), os.path.split(openlp.__file__)[0])
+ return get_frozen_path(os.path.abspath(os.path.dirname(sys.argv[0])), os.path.dirname(openlp.__file__))
elif dir_type == AppLocation.PluginsDir:
- app_path = os.path.abspath(os.path.split(sys.argv[0])[0])
+ app_path = os.path.abspath(os.path.dirname(sys.argv[0]))
return get_frozen_path(os.path.join(app_path, 'plugins'),
- os.path.join(os.path.split(openlp.__file__)[0], 'plugins'))
+ os.path.join(os.path.dirname(openlp.__file__), 'plugins'))
elif dir_type == AppLocation.VersionDir:
- return get_frozen_path(os.path.abspath(os.path.split(sys.argv[0])[0]), os.path.split(openlp.__file__)[0])
+ return get_frozen_path(os.path.abspath(os.path.dirname(sys.argv[0])), os.path.dirname(openlp.__file__))
elif dir_type == AppLocation.LanguageDir:
- app_path = get_frozen_path(os.path.abspath(os.path.split(sys.argv[0])[0]), _get_os_dir_path(dir_type))
+ app_path = get_frozen_path(os.path.abspath(os.path.dirname(sys.argv[0])), _get_os_dir_path(dir_type))
return os.path.join(app_path, 'i18n')
elif dir_type == AppLocation.DataDir and AppLocation.BaseDir:
return os.path.join(AppLocation.BaseDir, 'data')
@@ -110,7 +110,7 @@ class AppLocation(object):
:param extension:
Defaults to *None*. The extension to search for. For example::
- u'.png'
+ '.png'
"""
path = AppLocation.get_data_path()
if section:
@@ -140,18 +140,22 @@ def _get_os_dir_path(dir_type):
"""
Return a path based on which OS and environment we are running in.
"""
+ # If running from source, return the language directory from the source directory
+ if dir_type == AppLocation.LanguageDir:
+ directory = os.path.abspath(os.path.join(os.path.dirname(openlp.__file__), '..', 'resources'))
+ if os.path.exists(directory):
+ return directory
if sys.platform == 'win32':
if dir_type == AppLocation.DataDir:
return os.path.join(str(os.getenv('APPDATA')), 'openlp', 'data')
elif dir_type == AppLocation.LanguageDir:
- return os.path.split(openlp.__file__)[0]
+ return os.path.dirname(openlp.__file__)
return os.path.join(str(os.getenv('APPDATA')), 'openlp')
elif sys.platform == 'darwin':
if dir_type == AppLocation.DataDir:
- return os.path.join(str(os.getenv('HOME')),
- 'Library', 'Application Support', 'openlp', 'Data')
+ return os.path.join(str(os.getenv('HOME')), 'Library', 'Application Support', 'openlp', 'Data')
elif dir_type == AppLocation.LanguageDir:
- return os.path.split(openlp.__file__)[0]
+ return os.path.dirname(openlp.__file__)
return os.path.join(str(os.getenv('HOME')), 'Library', 'Application Support', 'openlp')
else:
if dir_type == AppLocation.LanguageDir:
diff --git a/openlp/core/common/settings.py b/openlp/core/common/settings.py
index 590452f73..3b7b31ca1 100644
--- a/openlp/core/common/settings.py
+++ b/openlp/core/common/settings.py
@@ -68,8 +68,7 @@ class Settings(QtCore.QSettings):
``__obsolete_settings__``
Each entry is structured in the following way::
- (u'general/enable slide loop', u'advanced/slide limits',
- [(SlideLimits.Wrap, True), (SlideLimits.End, False)])
+ ('general/enable slide loop', 'advanced/slide limits', [(SlideLimits.Wrap, True), (SlideLimits.End, False)])
The first entry is the *old key*; it will be removed.
diff --git a/openlp/core/lib/__init__.py b/openlp/core/lib/__init__.py
index 5c7705965..b85070445 100644
--- a/openlp/core/lib/__init__.py
+++ b/openlp/core/lib/__init__.py
@@ -300,8 +300,7 @@ def create_separated_list(string_list):
:param string_list: List of unicode strings
"""
- if LooseVersion(Qt.PYQT_VERSION_STR) >= LooseVersion('4.9') and \
- LooseVersion(Qt.qVersion()) >= LooseVersion('4.8'):
+ if LooseVersion(Qt.PYQT_VERSION_STR) >= LooseVersion('4.9') and LooseVersion(Qt.qVersion()) >= LooseVersion('4.8'):
return QtCore.QLocale().createSeparatedList(string_list)
if not string_list:
return ''
diff --git a/openlp/core/lib/db.py b/openlp/core/lib/db.py
index 1014c994d..d67c05c42 100644
--- a/openlp/core/lib/db.py
+++ b/openlp/core/lib/db.py
@@ -194,6 +194,7 @@ class Manager(object):
db_ver, up_ver = upgrade_db(self.db_url, upgrade_mod)
except (SQLAlchemyError, DBAPIError):
log.exception('Error loading database: %s', self.db_url)
+ return
if db_ver > up_ver:
critical_error_message_box(
translate('OpenLP.Manager', 'Database Error'),
@@ -215,7 +216,7 @@ class Manager(object):
Save an object to the database
:param object_instance: The object to save
- :param commit: Commit the session with this object
+ :param commit: Commit the session with this object
"""
for try_count in range(3):
try:
diff --git a/openlp/core/lib/filedialog.py b/openlp/core/lib/filedialog.py
index 5bf012ee5..3d1970dd5 100644
--- a/openlp/core/lib/filedialog.py
+++ b/openlp/core/lib/filedialog.py
@@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
-# vim: autoindent shiftwidth=4 expandtab textwidth=80 tabstop=4 softtabstop=4
+# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
###############################################################################
# OpenLP - Open Source Lyrics Projection #
diff --git a/openlp/core/lib/mediamanageritem.py b/openlp/core/lib/mediamanageritem.py
index 4d7676ad6..5893e8c38 100644
--- a/openlp/core/lib/mediamanageritem.py
+++ b/openlp/core/lib/mediamanageritem.py
@@ -495,8 +495,8 @@ s
if service_item:
service_item.from_plugin = True
self.preview_controller.add_service_item(service_item)
- if keep_focus:
- self.list_view.setFocus()
+ if not keep_focus:
+ self.preview_controller.preview_widget.setFocus()
def on_live_click(self):
"""
@@ -535,6 +535,7 @@ s
if remote:
service_item.will_auto_start = True
self.live_controller.add_service_item(service_item)
+ self.live_controller.preview_widget.setFocus()
def create_item_from_id(self, item_id):
"""
diff --git a/openlp/core/lib/plugin.py b/openlp/core/lib/plugin.py
index 1f459524c..8cd13088d 100644
--- a/openlp/core/lib/plugin.py
+++ b/openlp/core/lib/plugin.py
@@ -129,7 +129,7 @@ class Plugin(QtCore.QObject, RegistryProperties):
class MyPlugin(Plugin):
def __init__(self):
- super(MyPlugin, self).__init__('MyPlugin', version=u'0.1')
+ super(MyPlugin, self).__init__('MyPlugin', version='0.1')
:param name: Defaults to *None*. The name of the plugin.
:param default_settings: A dict containing the plugin's settings. The value to each key is the default value
diff --git a/openlp/core/lib/pluginmanager.py b/openlp/core/lib/pluginmanager.py
index 474113c98..822d510b2 100644
--- a/openlp/core/lib/pluginmanager.py
+++ b/openlp/core/lib/pluginmanager.py
@@ -82,11 +82,6 @@ class PluginManager(RegistryMixin, OpenLPMixin, RegistryProperties):
present_plugin_dir = os.path.join(self.base_path, 'presentations')
self.log_debug('finding plugins in %s at depth %d' % (self.base_path, start_depth))
for root, dirs, files in os.walk(self.base_path):
- if sys.platform == 'darwin' and root.startswith(present_plugin_dir):
- # TODO Presentation plugin is not yet working on Mac OS X.
- # For now just ignore it. The following code will ignore files from the presentation plugin directory
- # and thereby never import the plugin.
- continue
for name in files:
if name.endswith('.py') and not name.startswith('__'):
path = os.path.abspath(os.path.join(root, name))
diff --git a/openlp/core/lib/renderer.py b/openlp/core/lib/renderer.py
index 233af3784..ab4a5a4df 100644
--- a/openlp/core/lib/renderer.py
+++ b/openlp/core/lib/renderer.py
@@ -59,7 +59,6 @@ class Renderer(OpenLPMixin, RegistryMixin, RegistryProperties):
"""
super(Renderer, self).__init__(None)
# Need live behaviour if this is also working as a pseudo MainDisplay.
- self.is_live = True
self.screens = ScreenList()
self.theme_level = ThemeLevel.Global
self.global_theme_name = ''
@@ -248,6 +247,9 @@ class Renderer(OpenLPMixin, RegistryMixin, RegistryProperties):
elif item.is_capable(ItemCapabilities.CanSoftBreak):
pages = []
if '[---]' in text:
+ # Remove two or more option slide breaks next to each other (causing infinite loop).
+ while '\n[---]\n[---]\n' in text:
+ text = text.replace('\n[---]\n[---]\n', '\n[---]\n')
while True:
slides = text.split('\n[---]\n', 2)
# If there are (at least) two occurrences of [---] we use the first two slides (and neglect the last
@@ -392,7 +394,7 @@ class Renderer(OpenLPMixin, RegistryMixin, RegistryProperties):
off when displayed.
:param lines: The text to be fitted on the slide split into lines.
- :param line_end: The text added after each line. Either ``u' '`` or ``u' ``.
+ :param line_end: The text added after each line. Either ``' '`` or ``' ``.
"""
formatted = []
previous_html = ''
@@ -416,7 +418,7 @@ class Renderer(OpenLPMixin, RegistryMixin, RegistryProperties):
processed word by word. This is sometimes need for **bible** verses.
:param lines: The text to be fitted on the slide split into lines.
- :param line_end: The text added after each line. Either ``u' '`` or ``u' ``. This is needed for **bibles**.
+ :param line_end: The text added after each line. Either ``' '`` or ``' ``. This is needed for **bibles**.
"""
formatted = []
previous_html = ''
@@ -453,7 +455,7 @@ class Renderer(OpenLPMixin, RegistryMixin, RegistryProperties):
"""
Tests the given text for not closed formatting tags and returns a tuple consisting of three unicode strings::
- (u'{st}{r}Text text text{/r}{/st}', u'{st}{r}', u'')
+ ('{st}{r}Text text text{/r}{/st}', '{st}{r}', '')
The first unicode string is the text, with correct closing tags. The second unicode string are OpenLP's opening
formatting tags and the third unicode string the html opening formatting tags.
@@ -500,8 +502,8 @@ class Renderer(OpenLPMixin, RegistryMixin, RegistryProperties):
The text contains html.
:param raw_list: The elements which do not fit on a slide and needs to be processed using the binary chop.
The elements can contain formatting tags.
- :param separator: The separator for the elements. For lines this is ``u' '`` and for words this is ``u' '``.
- :param line_end: The text added after each "element line". Either ``u' '`` or ``u' ``. This is needed for
+ :param separator: The separator for the elements. For lines this is ``' '`` and for words this is ``' '``.
+ :param line_end: The text added after each "element line". Either ``' '`` or ``' ``. This is needed for
bibles.
"""
smallest_index = 0
diff --git a/openlp/core/lib/screen.py b/openlp/core/lib/screen.py
index 17ead5346..d05200f2f 100644
--- a/openlp/core/lib/screen.py
+++ b/openlp/core/lib/screen.py
@@ -63,8 +63,7 @@ class ScreenList(object):
"""
Initialise the screen list.
- ``desktop``
- A ``QDesktopWidget`` object.
+ :param desktop: A QDesktopWidget object.
"""
screen_list = cls()
screen_list.desktop = desktop
@@ -136,7 +135,7 @@ class ScreenList(object):
Returns a list with the screens. This should only be used to display
available screens to the user::
- [u'Screen 1 (primary)', u'Screen 2']
+ ['Screen 1 (primary)', 'Screen 2']
"""
screen_list = []
for screen in self.screen_list:
@@ -153,9 +152,9 @@ class ScreenList(object):
:param screen: A dict with the screen properties::
{
- u'primary': True,
- u'number': 0,
- u'size': PyQt4.QtCore.QRect(0, 0, 1024, 768)
+ 'primary': True,
+ 'number': 0,
+ 'size': PyQt4.QtCore.QRect(0, 0, 1024, 768)
}
"""
log.info('Screen %d found with resolution %s' % (screen['number'], screen['size']))
diff --git a/openlp/core/lib/ui.py b/openlp/core/lib/ui.py
index 965adb053..a1e37abcf 100644
--- a/openlp/core/lib/ui.py
+++ b/openlp/core/lib/ui.py
@@ -295,7 +295,7 @@ def set_case_insensitive_completer(cache, widget):
Sets a case insensitive text completer for a widget.
:param cache: The list of items to use as suggestions.
- :param widget: A widget to set the completer (QComboBox or QTextEdit instance)
+ :param widget: A widget to set the completer (QComboBox or QLineEdit instance)
"""
completer = QtGui.QCompleter(cache)
completer.setCaseSensitivity(QtCore.Qt.CaseInsensitive)
diff --git a/openlp/core/ui/aboutdialog.py b/openlp/core/ui/aboutdialog.py
index 276a073bb..251e0657c 100644
--- a/openlp/core/ui/aboutdialog.py
+++ b/openlp/core/ui/aboutdialog.py
@@ -44,7 +44,7 @@ class Ui_AboutDialog(object):
Set up the UI for the dialog.
"""
about_dialog.setObjectName('about_dialog')
- about_dialog.setWindowIcon(build_icon(':/icon/openlp-logo-16x16.png'))
+ about_dialog.setWindowIcon(build_icon(':/icon/openlp-logo.svg'))
self.about_dialog_layout = QtGui.QVBoxLayout(about_dialog)
self.about_dialog_layout.setObjectName('about_dialog_layout')
self.logo_label = QtGui.QLabel(about_dialog)
diff --git a/openlp/core/ui/aboutform.py b/openlp/core/ui/aboutform.py
index e971bbec4..3825312bd 100644
--- a/openlp/core/ui/aboutform.py
+++ b/openlp/core/ui/aboutform.py
@@ -30,7 +30,7 @@
The About dialog.
"""
-from PyQt4 import QtCore, QtGui
+from PyQt4 import QtGui
from .aboutdialog import Ui_AboutDialog
from openlp.core.lib import translate
diff --git a/openlp/core/ui/exceptiondialog.py b/openlp/core/ui/exceptiondialog.py
index 212fee4cd..329ed7797 100644
--- a/openlp/core/ui/exceptiondialog.py
+++ b/openlp/core/ui/exceptiondialog.py
@@ -30,9 +30,9 @@
The GUI widgets of the exception dialog.
"""
-from PyQt4 import QtCore, QtGui
+from PyQt4 import QtGui
-from openlp.core.lib import translate
+from openlp.core.lib import translate, build_icon
from openlp.core.lib.ui import create_button, create_button_box
@@ -45,6 +45,7 @@ class Ui_ExceptionDialog(object):
Set up the UI.
"""
exception_dialog.setObjectName('exception_dialog')
+ exception_dialog.setWindowIcon(build_icon(u':/icon/openlp-logo.svg'))
self.exception_layout = QtGui.QVBoxLayout(exception_dialog)
self.exception_layout.setObjectName('exception_layout')
self.message_layout = QtGui.QHBoxLayout()
diff --git a/openlp/core/ui/filerenamedialog.py b/openlp/core/ui/filerenamedialog.py
index 0900b82c3..4a316aece 100644
--- a/openlp/core/ui/filerenamedialog.py
+++ b/openlp/core/ui/filerenamedialog.py
@@ -31,7 +31,7 @@ The UI widgets for the rename dialog
"""
from PyQt4 import QtCore, QtGui
-from openlp.core.lib import translate
+from openlp.core.lib import translate, build_icon
from openlp.core.lib.ui import create_button_box
@@ -44,6 +44,7 @@ class Ui_FileRenameDialog(object):
Set up the UI
"""
file_rename_dialog.setObjectName('file_rename_dialog')
+ file_rename_dialog.setWindowIcon(build_icon(u':/icon/openlp-logo.svg'))
file_rename_dialog.resize(300, 10)
self.dialog_layout = QtGui.QGridLayout(file_rename_dialog)
self.dialog_layout.setObjectName('dialog_layout')
diff --git a/openlp/core/ui/firsttimeform.py b/openlp/core/ui/firsttimeform.py
index f1b875e6b..d7c16f0d3 100644
--- a/openlp/core/ui/firsttimeform.py
+++ b/openlp/core/ui/firsttimeform.py
@@ -114,10 +114,10 @@ class FirstTimeForm(QtGui.QWizard, Ui_FirstTimeWizard, RegistryProperties):
"""
Run the wizard.
"""
- self.setDefaults()
+ self.set_defaults()
return QtGui.QWizard.exec_(self)
- def setDefaults(self):
+ def set_defaults(self):
"""
Set up display at start of theme edit.
"""
@@ -199,8 +199,8 @@ class FirstTimeForm(QtGui.QWizard, Ui_FirstTimeWizard, RegistryProperties):
self.no_internet_label.setText(self.no_internet_text + self.cancelWizardText)
elif page_id == FirstTimePage.Defaults:
self.theme_combo_box.clear()
- for iter in range(self.themes_list_widget.count()):
- item = self.themes_list_widget.item(iter)
+ for index in range(self.themes_list_widget.count()):
+ item = self.themes_list_widget.item(index)
if item.checkState() == QtCore.Qt.Checked:
self.theme_combo_box.addItem(item.text())
if self.has_run_wizard:
@@ -292,13 +292,9 @@ class FirstTimeForm(QtGui.QWizard, Ui_FirstTimeWizard, RegistryProperties):
"""
themes = self.config.get('themes', 'files')
themes = themes.split(',')
- for theme in themes:
- filename = self.config.get('theme_%s' % theme, 'filename')
+ for index, theme in enumerate(themes):
screenshot = self.config.get('theme_%s' % theme, 'screenshot')
- for index in range(self.themes_list_widget.count()):
- item = self.themes_list_widget.item(index)
- if item.data(QtCore.Qt.UserRole) == filename:
- break
+ item = self.themes_list_widget.item(index)
item.setIcon(build_icon(os.path.join(gettempdir(), 'openlp', screenshot)))
def _get_file_size(self, url):
@@ -416,10 +412,7 @@ class FirstTimeForm(QtGui.QWizard, Ui_FirstTimeWizard, RegistryProperties):
self._increment_progress_bar(translate('OpenLP.FirstTimeWizard', 'Enabling selected plugins...'))
self._set_plugin_status(self.songs_check_box, 'songs/status')
self._set_plugin_status(self.bible_check_box, 'bibles/status')
- # TODO Presentation plugin is not yet working on Mac OS X.
- # For now just ignore it.
- if sys.platform != 'darwin':
- self._set_plugin_status(self.presentation_check_box, 'presentations/status')
+ self._set_plugin_status(self.presentation_check_box, 'presentations/status')
self._set_plugin_status(self.image_check_box, 'images/status')
self._set_plugin_status(self.media_check_box, 'media/status')
self._set_plugin_status(self.remote_check_box, 'remotes/status')
diff --git a/openlp/core/ui/firsttimelanguagedialog.py b/openlp/core/ui/firsttimelanguagedialog.py
index 10b341c2c..b4263e498 100644
--- a/openlp/core/ui/firsttimelanguagedialog.py
+++ b/openlp/core/ui/firsttimelanguagedialog.py
@@ -32,6 +32,7 @@ The UI widgets of the language selection dialog.
from PyQt4 import QtGui
from openlp.core.common import translate
+from openlp.core.lib import build_icon
from openlp.core.lib.ui import create_button_box
@@ -44,6 +45,7 @@ class Ui_FirstTimeLanguageDialog(object):
Set up the UI.
"""
language_dialog.setObjectName('language_dialog')
+ language_dialog.setWindowIcon(build_icon(u':/icon/openlp-logo.svg'))
language_dialog.resize(300, 50)
self.dialog_layout = QtGui.QVBoxLayout(language_dialog)
self.dialog_layout.setContentsMargins(8, 8, 8, 8)
diff --git a/openlp/core/ui/firsttimewizard.py b/openlp/core/ui/firsttimewizard.py
index 1a270f931..ff1675ff5 100644
--- a/openlp/core/ui/firsttimewizard.py
+++ b/openlp/core/ui/firsttimewizard.py
@@ -34,6 +34,7 @@ from PyQt4 import QtCore, QtGui
import sys
from openlp.core.common import translate
+from openlp.core.lib import build_icon
from openlp.core.lib.ui import add_welcome_page
@@ -60,6 +61,7 @@ class Ui_FirstTimeWizard(object):
Set up the UI.
"""
first_time_wizard.setObjectName('first_time_wizard')
+ first_time_wizard.setWindowIcon(build_icon(u':/icon/openlp-logo.svg'))
first_time_wizard.resize(550, 386)
first_time_wizard.setModal(True)
first_time_wizard.setWizardStyle(QtGui.QWizard.ModernStyle)
@@ -93,13 +95,10 @@ class Ui_FirstTimeWizard(object):
self.image_check_box.setChecked(True)
self.image_check_box.setObjectName('image_check_box')
self.plugin_layout.addWidget(self.image_check_box)
- # TODO Presentation plugin is not yet working on Mac OS X.
- # For now just ignore it.
- if sys.platform != 'darwin':
- self.presentation_check_box = QtGui.QCheckBox(self.plugin_page)
- self.presentation_check_box.setChecked(True)
- self.presentation_check_box.setObjectName('presentation_check_box')
- self.plugin_layout.addWidget(self.presentation_check_box)
+ self.presentation_check_box = QtGui.QCheckBox(self.plugin_page)
+ self.presentation_check_box.setChecked(True)
+ self.presentation_check_box.setObjectName('presentation_check_box')
+ self.plugin_layout.addWidget(self.presentation_check_box)
self.media_check_box = QtGui.QCheckBox(self.plugin_page)
self.media_check_box.setChecked(True)
self.media_check_box.setObjectName('media_check_box')
@@ -220,10 +219,7 @@ class Ui_FirstTimeWizard(object):
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'))
- # TODO Presentation plugin is not yet working on Mac OS X.
- # For now just ignore it.
- if sys.platform != 'darwin':
- self.presentation_check_box.setText(translate('OpenLP.FirstTimeWizard', 'Presentations'))
+ 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'))
diff --git a/openlp/core/ui/formattingtagdialog.py b/openlp/core/ui/formattingtagdialog.py
index 387bca0a7..569405a05 100644
--- a/openlp/core/ui/formattingtagdialog.py
+++ b/openlp/core/ui/formattingtagdialog.py
@@ -45,6 +45,7 @@ class Ui_FormattingTagDialog(object):
Set up the UI
"""
formatting_tag_dialog.setObjectName('formatting_tag_dialog')
+ formatting_tag_dialog.setWindowIcon(build_icon(u':/icon/openlp-logo.svg'))
formatting_tag_dialog.resize(725, 548)
self.list_data_grid_layout = QtGui.QVBoxLayout(formatting_tag_dialog)
self.list_data_grid_layout.setMargin(8)
diff --git a/openlp/core/ui/formattingtagform.py b/openlp/core/ui/formattingtagform.py
index be4247bc1..4f3d5d251 100644
--- a/openlp/core/ui/formattingtagform.py
+++ b/openlp/core/ui/formattingtagform.py
@@ -91,10 +91,9 @@ class FormattingTagForm(QtGui.QDialog, Ui_FormattingTagDialog, FormattingTagCont
"""
new_row = self.tag_table_widget.rowCount()
self.tag_table_widget.insertRow(new_row)
- self.tag_table_widget.setItem(new_row, 0,
- QtGui.QTableWidgetItem(translate('OpenLP.FormattingTagForm', 'New Tag%s')
- % str(new_row)))
- self.tag_table_widget.setItem(new_row, 1, QtGui.QTableWidgetItem('n%s' % str(new_row)))
+ self.tag_table_widget.setItem(new_row, 0, QtGui.QTableWidgetItem(translate('OpenLP.FormattingTagForm',
+ 'New Tag %d' % new_row)))
+ self.tag_table_widget.setItem(new_row, 1, QtGui.QTableWidgetItem('n%d' % new_row))
self.tag_table_widget.setItem(new_row, 2,
QtGui.QTableWidgetItem(translate('OpenLP.FormattingTagForm', '')))
self.tag_table_widget.setItem(new_row, 3, QtGui.QTableWidgetItem(''))
diff --git a/openlp/core/ui/listpreviewwidget.py b/openlp/core/ui/listpreviewwidget.py
index 5a7420324..3909c6a31 100644
--- a/openlp/core/ui/listpreviewwidget.py
+++ b/openlp/core/ui/listpreviewwidget.py
@@ -136,7 +136,6 @@ class ListPreviewWidget(QtGui.QTableWidget, RegistryProperties):
if self.service_item.is_text():
self.resizeRowsToContents()
self.setColumnWidth(0, self.viewport().width())
- self.setFocus()
self.change_slide(slide_number)
def change_slide(self, slide):
diff --git a/openlp/core/ui/maindisplay.py b/openlp/core/ui/maindisplay.py
index 946299aca..5c905c972 100644
--- a/openlp/core/ui/maindisplay.py
+++ b/openlp/core/ui/maindisplay.py
@@ -66,11 +66,8 @@ class Display(QtGui.QGraphicsView):
if hasattr(parent, 'is_live') and parent.is_live:
self.is_live = True
if self.is_live:
- super(Display, self).__init__()
- # Overwrite the parent() method.
self.parent = lambda: parent
- else:
- super(Display, self).__init__(parent)
+ super(Display, self).__init__()
self.controller = parent
self.screen = {}
# FIXME: On Mac OS X (tested on 10.7) the display screen is corrupt with
diff --git a/openlp/core/ui/mainwindow.py b/openlp/core/ui/mainwindow.py
index 81e822c16..6894293ce 100644
--- a/openlp/core/ui/mainwindow.py
+++ b/openlp/core/ui/mainwindow.py
@@ -89,7 +89,7 @@ class Ui_MainWindow(object):
Set up the user interface
"""
main_window.setObjectName('MainWindow')
- main_window.setWindowIcon(build_icon(':/icon/openlp-logo-64x64.png'))
+ main_window.setWindowIcon(build_icon(':/icon/openlp-logo.svg'))
main_window.setDockNestingEnabled(True)
# Set up the main container, which contains all the other form widgets.
self.main_content = QtGui.QWidget(main_window)
@@ -320,14 +320,14 @@ class Ui_MainWindow(object):
# i18n add Language Actions
add_actions(self.settings_language_menu, (self.auto_language_item, None))
add_actions(self.settings_language_menu, self.language_group.actions())
- # Order things differently in OS X so that Preferences menu item in the
- # app menu is correct (this gets picked up automatically by Qt).
+ # Qt on OS X looks for keywords in the menu items title to determine which menu items get added to the main
+ # menu. If we are running on Mac OS X the menu items whose title contains those keywords but don't belong in the
+ # main menu need to be marked as such with QAction.NoRole.
if sys.platform == 'darwin':
- add_actions(self.settings_menu, (self.settings_plugin_list_item, self.settings_language_menu.menuAction(),
- None, self.settings_configure_item, self.settings_shortcuts_item, self.formatting_tag_item))
- else:
- add_actions(self.settings_menu, (self.settings_plugin_list_item, self.settings_language_menu.menuAction(),
- None, self.formatting_tag_item, self.settings_shortcuts_item, self.settings_configure_item))
+ self.settings_shortcuts_item.setMenuRole(QtGui.QAction.NoRole)
+ self.formatting_tag_item.setMenuRole(QtGui.QAction.NoRole)
+ add_actions(self.settings_menu, (self.settings_plugin_list_item, self.settings_language_menu.menuAction(),
+ None, self.formatting_tag_item, self.settings_shortcuts_item, self.settings_configure_item))
add_actions(self.tools_menu, (self.tools_add_tool_item, None))
add_actions(self.tools_menu, (self.tools_open_data_folder, None))
add_actions(self.tools_menu, (self.tools_first_time_wizard, None))
@@ -598,7 +598,7 @@ class MainWindow(QtGui.QMainWindow, Ui_MainWindow, RegistryProperties):
if self.arguments:
self.open_cmd_line_files()
elif Settings().value(self.general_settings_section + '/auto open'):
- self.service_manager_contents.load_Last_file()
+ self.service_manager_contents.load_last_file()
self.timer_version_id = self.startTimer(1000)
view_mode = Settings().value('%s/view mode' % self.general_settings_section)
if view_mode == 'default':
@@ -1334,7 +1334,7 @@ class MainWindow(QtGui.QMainWindow, Ui_MainWindow, RegistryProperties):
if self.copy_data:
log.info('Copying data to new path')
try:
- self.showStatusMessage(
+ self.show_status_message(
translate('OpenLP.MainWindow', 'Copying OpenLP data to new data directory location - %s '
'- Please wait for copy to finish').replace('%s', self.new_data_path))
dir_util.copy_tree(old_data_path, self.new_data_path)
@@ -1364,8 +1364,7 @@ class MainWindow(QtGui.QMainWindow, Ui_MainWindow, RegistryProperties):
args = []
for a in self.arguments:
args.extend([a])
- for arg in args:
- filename = arg
+ for filename in args:
if not isinstance(filename, str):
filename = str(filename, sys.getfilesystemencoding())
if filename.endswith(('.osz', '.oszl')):
diff --git a/openlp/core/ui/media/mediaplayer.py b/openlp/core/ui/media/mediaplayer.py
index 3246d58c4..22ea7ecfc 100644
--- a/openlp/core/ui/media/mediaplayer.py
+++ b/openlp/core/ui/media/mediaplayer.py
@@ -29,8 +29,6 @@
"""
The :mod:`~openlp.core.ui.media.mediaplayer` module contains the MediaPlayer class.
"""
-import os
-
from openlp.core.common import RegistryProperties
from openlp.core.ui.media import MediaState
diff --git a/openlp/core/ui/media/phononplayer.py b/openlp/core/ui/media/phononplayer.py
index 5e94dbd0e..b343755a0 100644
--- a/openlp/core/ui/media/phononplayer.py
+++ b/openlp/core/ui/media/phononplayer.py
@@ -33,10 +33,8 @@ import logging
import mimetypes
from datetime import datetime
-from PyQt4 import QtGui
from PyQt4.phonon import Phonon
-from openlp.core.common import Settings
from openlp.core.lib import translate
from openlp.core.ui.media import MediaState
diff --git a/openlp/core/ui/media/vendor/vlc.py b/openlp/core/ui/media/vendor/vlc.py
index 0326e4104..95f12ec85 100644
--- a/openlp/core/ui/media/vendor/vlc.py
+++ b/openlp/core/ui/media/vendor/vlc.py
@@ -48,7 +48,7 @@ import sys
from inspect import getargspec
__version__ = "N/A"
-build_date = "Tue Jul 2 10:35:53 2013"
+build_date = "Wed Jun 25 13:46:01 2014"
if sys.version_info[0] > 2:
str = str
@@ -110,7 +110,11 @@ def find_lib():
p = find_library('libvlc.dll')
if p is None:
try: # some registry settings
- import _winreg as w # leaner than win32api, win32con
+ # leaner than win32api, win32con
+ if PYTHON3:
+ import winreg as w
+ else:
+ import _winreg as w
for r in w.HKEY_LOCAL_MACHINE, w.HKEY_CURRENT_USER:
try:
r = w.OpenKey(r, 'Software\\VideoLAN\\VLC')
@@ -365,6 +369,7 @@ class EventType(_Enum):
3: 'MediaParsedChanged',
4: 'MediaFreed',
5: 'MediaStateChanged',
+ 6: 'MediaSubItemTreeAdded',
0x100: 'MediaPlayerMediaChanged',
257: 'MediaPlayerNothingSpecial',
258: 'MediaPlayerOpening',
@@ -384,6 +389,7 @@ class EventType(_Enum):
272: 'MediaPlayerSnapshotTaken',
273: 'MediaPlayerLengthChanged',
274: 'MediaPlayerVout',
+ 275: 'MediaPlayerScrambledChanged',
0x200: 'MediaListItemAdded',
513: 'MediaListWillAddItem',
514: 'MediaListItemDeleted',
@@ -439,6 +445,7 @@ EventType.MediaPlayerPausableChanged = EventType(270)
EventType.MediaPlayerPaused = EventType(261)
EventType.MediaPlayerPlaying = EventType(260)
EventType.MediaPlayerPositionChanged = EventType(268)
+EventType.MediaPlayerScrambledChanged = EventType(275)
EventType.MediaPlayerSeekableChanged = EventType(269)
EventType.MediaPlayerSnapshotTaken = EventType(272)
EventType.MediaPlayerStopped = EventType(262)
@@ -447,6 +454,7 @@ EventType.MediaPlayerTitleChanged = EventType(271)
EventType.MediaPlayerVout = EventType(274)
EventType.MediaStateChanged = EventType(5)
EventType.MediaSubItemAdded = EventType(1)
+EventType.MediaSubItemTreeAdded = EventType(6)
EventType.VlmMediaAdded = EventType(0x600)
EventType.VlmMediaChanged = EventType(1538)
EventType.VlmMediaInstanceStarted = EventType(1539)
@@ -480,23 +488,35 @@ class Meta(_Enum):
14: 'EncodedBy',
15: 'ArtworkURL',
16: 'TrackID',
+ 17: 'TrackTotal',
+ 18: 'Director',
+ 19: 'Season',
+ 20: 'Episode',
+ 21: 'ShowName',
+ 22: 'Actors',
}
+Meta.Actors = Meta(22)
Meta.Album = Meta(4)
Meta.Artist = Meta(1)
Meta.ArtworkURL = Meta(15)
Meta.Copyright = Meta(3)
Meta.Date = Meta(8)
Meta.Description = Meta(6)
+Meta.Director = Meta(18)
Meta.EncodedBy = Meta(14)
+Meta.Episode = Meta(20)
Meta.Genre = Meta(2)
Meta.Language = Meta(11)
Meta.NowPlaying = Meta(12)
Meta.Publisher = Meta(13)
Meta.Rating = Meta(7)
+Meta.Season = Meta(19)
Meta.Setting = Meta(9)
+Meta.ShowName = Meta(21)
Meta.Title = Meta(0)
Meta.TrackID = Meta(16)
Meta.TrackNumber = Meta(5)
+Meta.TrackTotal = Meta(17)
Meta.URL = Meta(10)
class State(_Enum):
@@ -594,6 +614,32 @@ NavigateMode.left = NavigateMode(3)
NavigateMode.right = NavigateMode(4)
NavigateMode.up = NavigateMode(1)
+class Position(_Enum):
+ '''Enumeration of values used to set position (e.g. of video title).
+ '''
+ _enum_names_ = {
+ -1: 'disable',
+ 0: 'center',
+ 1: 'left',
+ 2: 'right',
+ 3: 'top',
+ 4: 'left',
+ 5: 'right',
+ 6: 'bottom',
+ 7: 'left',
+ 8: 'right',
+ }
+Position.bottom = Position(6)
+Position.center = Position(0)
+Position.disable = Position(-1)
+Position.left = Position(1)
+Position.left = Position(4)
+Position.left = Position(7)
+Position.right = Position(2)
+Position.right = Position(5)
+Position.right = Position(8)
+Position.top = Position(3)
+
class VideoLogoOption(_Enum):
'''Option values for libvlc_video_{get,set}_logo_{int,string}.
'''
@@ -685,7 +731,7 @@ class LogCb(ctypes.c_void_p):
"""Callback prototype for LibVLC log message handler.
\param data data pointer as given to L{libvlc_log_set}()
\param level message level (@ref enum libvlc_log_level)
-\param ctx message context (meta-informations about the message)
+\param ctx message context (meta-information about the message)
\param fmt printf() format string (as defined by ISO C11)
\param args variable argument list for the format
\note Log message handlers must be thread-safe.
@@ -823,18 +869,18 @@ class CallbackDecorators(object):
Callback = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p)
Callback.__doc__ = '''Callback function notification
\param p_event the event triggering the callback
- '''
+ '''
LogCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_int, Log_ptr, ctypes.c_char_p, ctypes.c_void_p)
LogCb.__doc__ = '''Callback prototype for LibVLC log message handler.
\param data data pointer as given to L{libvlc_log_set}()
\param level message level (@ref enum libvlc_log_level)
-\param ctx message context (meta-informations about the message)
+\param ctx message context (meta-information about the message)
\param fmt printf() format string (as defined by ISO C11)
\param args variable argument list for the format
\note Log message handlers must be thread-safe.
\warning The message context pointer, the format string parameters and the
variable arguments are only valid until the callback returns.
- '''
+ '''
VideoLockCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ListPOINTER(ctypes.c_void_p))
VideoLockCb.__doc__ = '''Callback prototype to allocate and lock a picture buffer.
Whenever a new video frame needs to be decoded, the lock callback is
@@ -846,7 +892,7 @@ planes must be aligned on 32-bytes boundaries.
of void pointers, this callback must initialize the array) [OUT]
\return a private pointer for the display and unlock callbacks to identify
the picture buffers
- '''
+ '''
VideoUnlockCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p, ListPOINTER(ctypes.c_void_p))
VideoUnlockCb.__doc__ = '''Callback prototype to unlock a picture buffer.
When the video frame decoding is complete, the unlock callback is invoked.
@@ -859,7 +905,7 @@ but before the picture is displayed.
callback [IN]
\param planes pixel planes as defined by the @ref libvlc_video_lock_cb
callback (this parameter is only for convenience) [IN]
- '''
+ '''
VideoDisplayCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p)
VideoDisplayCb.__doc__ = '''Callback prototype to display a picture.
When the video frame needs to be shown, as determined by the media playback
@@ -867,7 +913,7 @@ clock, the display callback is invoked.
\param opaque private pointer as passed to L{libvlc_video_set_callbacks}() [IN]
\param picture private pointer returned from the @ref libvlc_video_lock_cb
callback [IN]
- '''
+ '''
VideoFormatCb = ctypes.CFUNCTYPE(ctypes.POINTER(ctypes.c_uint), ListPOINTER(ctypes.c_void_p), ctypes.c_char_p, ctypes.POINTER(ctypes.c_uint), ctypes.POINTER(ctypes.c_uint), ctypes.POINTER(ctypes.c_uint), ctypes.POINTER(ctypes.c_uint))
VideoFormatCb.__doc__ = '''Callback prototype to configure picture buffers format.
This callback gets the format of the video as output by the video decoder
@@ -891,47 +937,47 @@ the pixel height.
Furthermore, we recommend that pitches and lines be multiple of 32
to not break assumption that might be made by various optimizations
in the video decoders, video filters and/or video converters.
- '''
+ '''
VideoCleanupCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p)
VideoCleanupCb.__doc__ = '''Callback prototype to configure picture buffers format.
\param opaque private pointer as passed to L{libvlc_video_set_callbacks}()
(and possibly modified by @ref libvlc_video_format_cb) [IN]
- '''
+ '''
AudioPlayCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p, ctypes.c_uint, ctypes.c_int64)
AudioPlayCb.__doc__ = '''Callback prototype for audio playback.
\param data data pointer as passed to L{libvlc_audio_set_callbacks}() [IN]
\param samples pointer to the first audio sample to play back [IN]
\param count number of audio samples to play back
\param pts expected play time stamp (see libvlc_delay())
- '''
+ '''
AudioPauseCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_int64)
AudioPauseCb.__doc__ = '''Callback prototype for audio pause.
\note The pause callback is never called if the audio is already paused.
\param data data pointer as passed to L{libvlc_audio_set_callbacks}() [IN]
\param pts time stamp of the pause request (should be elapsed already)
- '''
+ '''
AudioResumeCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_int64)
AudioResumeCb.__doc__ = '''Callback prototype for audio resumption (i.e. restart from pause).
\note The resume callback is never called if the audio is not paused.
\param data data pointer as passed to L{libvlc_audio_set_callbacks}() [IN]
\param pts time stamp of the resumption request (should be elapsed already)
- '''
+ '''
AudioFlushCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_int64)
AudioFlushCb.__doc__ = '''Callback prototype for audio buffer flush
(i.e. discard all pending buffers and stop playback as soon as possible).
\param data data pointer as passed to L{libvlc_audio_set_callbacks}() [IN]
- '''
+ '''
AudioDrainCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p)
AudioDrainCb.__doc__ = '''Callback prototype for audio buffer drain
(i.e. wait for pending buffers to be played).
\param data data pointer as passed to L{libvlc_audio_set_callbacks}() [IN]
- '''
+ '''
AudioSetVolumeCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_float, ctypes.c_bool)
AudioSetVolumeCb.__doc__ = '''Callback prototype for audio volume change.
\param data data pointer as passed to L{libvlc_audio_set_callbacks}() [IN]
\param volume software volume (1. = nominal, 0. = mute)
\param mute muted flag
- '''
+ '''
AudioSetupCb = ctypes.CFUNCTYPE(ctypes.POINTER(ctypes.c_int), ListPOINTER(ctypes.c_void_p), ctypes.c_char_p, ctypes.POINTER(ctypes.c_uint), ctypes.POINTER(ctypes.c_uint))
AudioSetupCb.__doc__ = '''Callback prototype to setup the audio playback.
This is called when the media player needs to create a new audio output.
@@ -941,12 +987,12 @@ This is called when the media player needs to create a new audio output.
\param rate sample rate [IN/OUT]
\param channels channels count [IN/OUT]
\return 0 on success, anything else to skip audio playback
- '''
+ '''
AudioCleanupCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p)
AudioCleanupCb.__doc__ = '''Callback prototype for audio playback cleanup.
This is called when the media player no longer needs an audio output.
\param opaque data pointer as passed to L{libvlc_audio_set_callbacks}() [IN]
- '''
+ '''
cb = CallbackDecorators
# End of generated enum types #
@@ -1210,7 +1256,7 @@ class EventManager(_Ctype):
@note: Only a single notification can be registered
for each event type in an EventManager instance.
-
+
'''
_callback_handler = None
@@ -1287,7 +1333,7 @@ class Instance(_Ctype):
- a string
- a list of strings as first parameters
- the parameters given as the constructor parameters (must be strings)
-
+
'''
def __new__(cls, *args):
@@ -1432,6 +1478,16 @@ class Instance(_Ctype):
'''
return libvlc_set_user_agent(self, str_to_bytes(name), str_to_bytes(http))
+ def set_app_id(self, id, version, icon):
+ '''Sets some meta-information about the application.
+ See also L{set_user_agent}().
+ @param id: Java-style application identifier, e.g. "com.acme.foobar".
+ @param version: application version numbers, e.g. "1.2.3".
+ @param icon: application icon name, e.g. "foobar".
+ @version: LibVLC 2.1.0 or later.
+ '''
+ return libvlc_set_app_id(self, str_to_bytes(id), str_to_bytes(version), str_to_bytes(icon))
+
def log_unset(self):
'''Unsets the logging callback for a LibVLC instance. This is rarely needed:
the callback is implicitly unset when the instance is destroyed.
@@ -1521,13 +1577,13 @@ class Instance(_Ctype):
return libvlc_media_library_new(self)
def audio_output_list_get(self):
- '''Gets the list of available audio outputs.
+ '''Gets the list of available audio output modules.
@return: list of available audio outputs. It must be freed it with In case of error, NULL is returned.
'''
return libvlc_audio_output_list_get(self)
def audio_output_device_list_get(self, aout):
- '''Gets a list of audio output devices for a given audio output.
+ '''Gets a list of audio output devices for a given audio output module,
See L{audio_output_device_set}().
@note: Not all audio outputs support this. In particular, an empty (NULL)
list of devices does B{not} imply that the specified audio output does
@@ -1753,11 +1809,11 @@ class Instance(_Ctype):
class Media(_Ctype):
'''Create a new Media instance.
-
+
Usage: Media(MRL, *options)
See vlc.Instance.media_new documentation for details.
-
+
'''
def __new__(cls, *args):
@@ -1790,6 +1846,19 @@ class Media(_Ctype):
for o in options:
self.add_option(o)
+ def tracks_get(self):
+ """Get media descriptor's elementary streams description
+ Note, you need to call L{parse}() or play the media at least once
+ before calling this function.
+ Not doing this will result in an empty array.
+ The result must be freed with L{tracks_release}.
+ @version: LibVLC 2.1.0 and later.
+ """
+ mediaTrack_pp = ctypes.POINTER(MediaTrack)()
+ n = libvlc_media_tracks_get(self, byref(mediaTrack_pp))
+ info = cast(ctypes.mediaTrack_pp, ctypes.POINTER(ctypes.POINTER(MediaTrack) * n))
+ return info
+
def add_option(self, psz_options):
'''Add an option to the media.
@@ -1962,17 +2031,6 @@ class Media(_Ctype):
'''
return libvlc_media_get_user_data(self)
- def tracks_get(self, tracks):
- '''Get media descriptor's elementary streams description
- Note, you need to call L{parse}() or play the media at least once
- before calling this function.
- Not doing this will result in an empty array.
- @param tracks: address to store an allocated array of Elementary Streams descriptions (must be freed with L{tracks_release}.
- @return: the number of Elementary Streams (zero on error).
- @version: LibVLC 2.1.0 and later.
- '''
- return libvlc_media_tracks_get(self, tracks)
-
def player_new_from_media(self):
'''Create a Media Player object from a Media.
@return: a new media player object, or NULL on error.
@@ -2053,11 +2111,11 @@ class MediaLibrary(_Ctype):
class MediaList(_Ctype):
'''Create a new MediaList instance.
-
+
Usage: MediaList(list_of_MRLs)
See vlc.Instance.media_list_new documentation for details.
-
+
'''
def __new__(cls, *args):
@@ -2073,10 +2131,10 @@ class MediaList(_Ctype):
def get_instance(self):
return getattr(self, '_instance', None)
-
+
def add_media(self, mrl):
"""Add media instance to media list.
-
+
The L{lock} should be held upon entering this function.
@param mrl: a media instance or a MRL.
@return: 0 on success, -1 if the media list is read-only.
@@ -2193,7 +2251,7 @@ class MediaListPlayer(_Ctype):
It may take as parameter either:
- a vlc.Instance
- nothing
-
+
'''
def __new__(cls, arg=None):
@@ -2319,13 +2377,13 @@ class MediaPlayer(_Ctype):
It may take as parameter either:
- a string (media URI), options... In this case, a vlc.Instance will be created.
- a vlc.Instance, a string (media URI), options...
-
+
'''
def __new__(cls, *args):
if len(args) == 1 and isinstance(args[0], _Ints):
return _Constructor(cls, args[0])
-
+
if args and isinstance(args[0], Instance):
instance = args[0]
args = args[1:]
@@ -2397,13 +2455,13 @@ class MediaPlayer(_Ctype):
Specify where the media player should render its video
output. If LibVLC was built without Win32/Win64 API output
support, then this has no effects.
-
+
@param drawable: windows handle of the drawable.
"""
if not isinstance(drawable, ctypes.c_void_p):
drawable = ctypes.c_void_p(int(drawable))
libvlc_media_player_set_hwnd(self, drawable)
-
+
def video_get_width(self, num=0):
"""Get the width of a video in pixels.
@@ -2556,12 +2614,12 @@ class MediaPlayer(_Ctype):
If you want to use it along with Qt4 see the QMacCocoaViewContainer. Then
the following code should work:
@begincode
-
+
NSView *video = [[NSView alloc] init];
QMacCocoaViewContainer *container = new QMacCocoaViewContainer(video, parent);
L{set_nsobject}(mp, video);
[video release];
-
+
@endcode
You can find a live example in VLCVideoView in VLCKit.framework.
@param drawable: the drawable that is either an NSView or an object following the VLCOpenGLVideoViewEmbedding protocol.
@@ -2796,6 +2854,13 @@ class MediaPlayer(_Ctype):
'''
return libvlc_media_player_can_pause(self)
+ def program_scrambled(self):
+ '''Check if the current program is scrambled.
+ @return: true if the current program is scrambled \libvlc_return_bool.
+ @version: LibVLC 2.2.0 or later.
+ '''
+ return libvlc_media_player_program_scrambled(self)
+
def next_frame(self):
'''Display the next frame (if supported).
'''
@@ -2808,6 +2873,14 @@ class MediaPlayer(_Ctype):
'''
return libvlc_media_player_navigate(self, navigate)
+ def set_video_title_display(self, position, timeout):
+ '''Set if, and how, the video title will be shown when media is played.
+ @param position: position at which to display the title, or libvlc_position_disable to prevent the title from being displayed.
+ @param timeout: title display timeout in milliseconds (ignored if libvlc_position_disable).
+ @version: libVLC 2.1.0 or later.
+ '''
+ return libvlc_media_player_set_video_title_display(self, position, timeout)
+
def toggle_fullscreen(self):
'''Toggle fullscreen status on non-embedded video outputs.
@warning: The same limitations applies to this function
@@ -3083,7 +3156,7 @@ class MediaPlayer(_Ctype):
return libvlc_video_set_adjust_float(self, option, value)
def audio_output_set(self, psz_name):
- '''Sets the audio output.
+ '''Selects an audio output module.
@note: Any change will take be effect only after playback is stopped and
restarted. Audio output cannot be changed while playing.
@param psz_name: name of audio output, use psz_name of See L{AudioOutput}.
@@ -3091,21 +3164,46 @@ class MediaPlayer(_Ctype):
'''
return libvlc_audio_output_set(self, str_to_bytes(psz_name))
- def audio_output_device_set(self, psz_audio_output, psz_device_id):
- '''Configures an explicit audio output device for a given audio output plugin.
- A list of possible devices can be obtained with
+ def audio_output_device_enum(self):
+ '''Gets a list of potential audio output devices,
+ See L{audio_output_device_set}().
+ @note: Not all audio outputs support enumerating devices.
+ The audio output may be functional even if the list is empty (NULL).
+ @note: The list may not be exhaustive.
+ @warning: Some audio output devices in the list might not actually work in
+ some circumstances. By default, it is recommended to not specify any
+ explicit audio device.
+ @return: A NULL-terminated linked list of potential audio output devices. It must be freed it with L{audio_output_device_list_release}().
+ @version: LibVLC 2.2.0 or later.
+ '''
+ return libvlc_audio_output_device_enum(self)
+
+ def audio_output_device_set(self, module, device_id):
+ '''Configures an explicit audio output device.
+ If the module paramater is NULL, audio output will be moved to the device
+ specified by the device identifier string immediately. This is the
+ recommended usage.
+ A list of adequate potential device strings can be obtained with
+ L{audio_output_device_enum}().
+ However passing NULL is supported in LibVLC version 2.2.0 and later only;
+ in earlier versions, this function would have no effects when the module
+ parameter was NULL.
+ If the module parameter is not NULL, the device parameter of the
+ corresponding audio output, if it exists, will be set to the specified
+ string. Note that some audio output modules do not have such a parameter
+ (notably MMDevice and PulseAudio).
+ A list of adequate potential device strings can be obtained with
L{audio_output_device_list_get}().
@note: This function does not select the specified audio output plugin.
L{audio_output_set}() is used for that purpose.
@warning: The syntax for the device parameter depends on the audio output.
- This is not portable. Only use this function if you know what you are doing.
- Some audio outputs do not support this function (e.g. PulseAudio, WASAPI).
- Some audio outputs require further parameters (e.g. ALSA: channels map).
- @param psz_audio_output: - name of audio output, See L{AudioOutput}.
- @param psz_device_id: device.
- @return: Nothing. Errors are ignored.
+ Some audio output modules require further parameters (e.g. a channels map
+ in the case of ALSA).
+ @param module: If NULL, current audio output module. if non-NULL, name of audio output module.
+ @param device_id: device identifier string.
+ @return: Nothing. Errors are ignored (this is a design bug).
'''
- return libvlc_audio_output_device_set(self, str_to_bytes(psz_audio_output), str_to_bytes(psz_device_id))
+ return libvlc_audio_output_device_set(self, str_to_bytes(module), str_to_bytes(device_id))
def audio_toggle_mute(self):
'''Toggle mute status.
@@ -3184,6 +3282,28 @@ class MediaPlayer(_Ctype):
'''
return libvlc_audio_set_delay(self, i_delay)
+ def set_equalizer(self, p_equalizer):
+ '''Apply new equalizer settings to a media player.
+ The equalizer is first created by invoking L{audio_equalizer_new}() or
+ L{audio_equalizer_new_from_preset}().
+ It is possible to apply new equalizer settings to a media player whether the media
+ player is currently playing media or not.
+ Invoking this method will immediately apply the new equalizer settings to the audio
+ output of the currently playing media if there is any.
+ If there is no currently playing media, the new equalizer settings will be applied
+ later if and when new media is played.
+ Equalizer settings will automatically be applied to subsequently played media.
+ To disable the equalizer for a media player invoke this method passing NULL for the
+ p_equalizer parameter.
+ The media player does not keep a reference to the supplied equalizer so it is safe
+ for an application to release the equalizer reference any time after this method
+ returns.
+ @param p_equalizer: opaque equalizer handle, or NULL to disable the equalizer for this media player.
+ @return: zero on success, -1 on error.
+ @version: LibVLC 2.2.0 or later.
+ '''
+ return libvlc_media_player_set_equalizer(self, p_equalizer)
+
# LibVLC __version__ functions #
@@ -3279,6 +3399,20 @@ def libvlc_set_user_agent(p_instance, name, http):
None, Instance, ctypes.c_char_p, ctypes.c_char_p)
return f(p_instance, name, http)
+def libvlc_set_app_id(p_instance, id, version, icon):
+ '''Sets some meta-information about the application.
+ See also L{libvlc_set_user_agent}().
+ @param p_instance: LibVLC instance.
+ @param id: Java-style application identifier, e.g. "com.acme.foobar".
+ @param version: application version numbers, e.g. "1.2.3".
+ @param icon: application icon name, e.g. "foobar".
+ @version: LibVLC 2.1.0 or later.
+ '''
+ f = _Cfunctions.get('libvlc_set_app_id', None) or \
+ _Cfunction('libvlc_set_app_id', ((1,), (1,), (1,), (1,),), None,
+ None, Instance, ctypes.c_char_p, ctypes.c_char_p, ctypes.c_char_p)
+ return f(p_instance, id, version, icon)
+
def libvlc_get_version():
'''Retrieve libvlc version.
Example: "1.1.0-git The Luggage".
@@ -3355,7 +3489,7 @@ def libvlc_event_type_name(event_type):
return f(event_type)
def libvlc_log_get_context(ctx):
- '''Gets debugging informations about a log message: the name of the VLC module
+ '''Gets debugging information about a log message: the name of the VLC module
emitting the message and the message location within the source code.
The returned module name and file name will be NULL if unknown.
The returned line number will similarly be zero if unknown.
@@ -3369,9 +3503,9 @@ def libvlc_log_get_context(ctx):
return f(ctx)
def libvlc_log_get_object(ctx, id):
- '''Gets VLC object informations about a log message: the type name of the VLC
+ '''Gets VLC object information about a log message: the type name of the VLC
object emitting the message, the object header if any and a temporaly-unique
- object identifier. These informations are mainly meant for B{manual}
+ object identifier. This information is mainly meant for B{manual}
troubleshooting.
The returned type name may be "generic" if unknown, but it cannot be NULL.
The returned header will be NULL if unset; in current versions, the header
@@ -4430,12 +4564,12 @@ def libvlc_media_player_set_nsobject(p_mi, drawable):
If you want to use it along with Qt4 see the QMacCocoaViewContainer. Then
the following code should work:
@begincode
-
+
NSView *video = [[NSView alloc] init];
QMacCocoaViewContainer *container = new QMacCocoaViewContainer(video, parent);
L{libvlc_media_player_set_nsobject}(mp, video);
[video release];
-
+
@endcode
You can find a live example in VLCVideoView in VLCKit.framework.
@param p_mi: the Media Player.
@@ -4814,6 +4948,17 @@ def libvlc_media_player_can_pause(p_mi):
ctypes.c_int, MediaPlayer)
return f(p_mi)
+def libvlc_media_player_program_scrambled(p_mi):
+ '''Check if the current program is scrambled.
+ @param p_mi: the media player.
+ @return: true if the current program is scrambled \libvlc_return_bool.
+ @version: LibVLC 2.2.0 or later.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_program_scrambled', None) or \
+ _Cfunction('libvlc_media_player_program_scrambled', ((1,),), None,
+ ctypes.c_int, MediaPlayer)
+ return f(p_mi)
+
def libvlc_media_player_next_frame(p_mi):
'''Display the next frame (if supported).
@param p_mi: the media player.
@@ -4834,6 +4979,18 @@ def libvlc_media_player_navigate(p_mi, navigate):
None, MediaPlayer, ctypes.c_uint)
return f(p_mi, navigate)
+def libvlc_media_player_set_video_title_display(p_mi, position, timeout):
+ '''Set if, and how, the video title will be shown when media is played.
+ @param p_mi: the media player.
+ @param position: position at which to display the title, or libvlc_position_disable to prevent the title from being displayed.
+ @param timeout: title display timeout in milliseconds (ignored if libvlc_position_disable).
+ @version: libVLC 2.1.0 or later.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_set_video_title_display', None) or \
+ _Cfunction('libvlc_media_player_set_video_title_display', ((1,), (1,), (1,),), None,
+ None, MediaPlayer, Position, ctypes.c_int)
+ return f(p_mi, position, timeout)
+
def libvlc_track_description_list_release(p_track_description):
'''Release (free) L{TrackDescription}.
@param p_track_description: the structure to release.
@@ -5335,7 +5492,7 @@ def libvlc_video_set_adjust_float(p_mi, option, value):
return f(p_mi, option, value)
def libvlc_audio_output_list_get(p_instance):
- '''Gets the list of available audio outputs.
+ '''Gets the list of available audio output modules.
@param p_instance: libvlc instance.
@return: list of available audio outputs. It must be freed it with In case of error, NULL is returned.
'''
@@ -5345,7 +5502,7 @@ def libvlc_audio_output_list_get(p_instance):
return f(p_instance)
def libvlc_audio_output_list_release(p_list):
- '''Frees the list of available audio outputs.
+ '''Frees the list of available audio output modules.
@param p_list: list with audio outputs for release.
'''
f = _Cfunctions.get('libvlc_audio_output_list_release', None) or \
@@ -5354,7 +5511,7 @@ def libvlc_audio_output_list_release(p_list):
return f(p_list)
def libvlc_audio_output_set(p_mi, psz_name):
- '''Sets the audio output.
+ '''Selects an audio output module.
@note: Any change will take be effect only after playback is stopped and
restarted. Audio output cannot be changed while playing.
@param p_mi: media player.
@@ -5366,8 +5523,26 @@ def libvlc_audio_output_set(p_mi, psz_name):
ctypes.c_int, MediaPlayer, ctypes.c_char_p)
return f(p_mi, psz_name)
+def libvlc_audio_output_device_enum(mp):
+ '''Gets a list of potential audio output devices,
+ See L{libvlc_audio_output_device_set}().
+ @note: Not all audio outputs support enumerating devices.
+ The audio output may be functional even if the list is empty (NULL).
+ @note: The list may not be exhaustive.
+ @warning: Some audio output devices in the list might not actually work in
+ some circumstances. By default, it is recommended to not specify any
+ explicit audio device.
+ @param mp: media player.
+ @return: A NULL-terminated linked list of potential audio output devices. It must be freed it with L{libvlc_audio_output_device_list_release}().
+ @version: LibVLC 2.2.0 or later.
+ '''
+ f = _Cfunctions.get('libvlc_audio_output_device_enum', None) or \
+ _Cfunction('libvlc_audio_output_device_enum', ((1,),), None,
+ ctypes.POINTER(AudioOutputDevice), MediaPlayer)
+ return f(mp)
+
def libvlc_audio_output_device_list_get(p_instance, aout):
- '''Gets a list of audio output devices for a given audio output.
+ '''Gets a list of audio output devices for a given audio output module,
See L{libvlc_audio_output_device_set}().
@note: Not all audio outputs support this. In particular, an empty (NULL)
list of devices does B{not} imply that the specified audio output does
@@ -5396,25 +5571,36 @@ def libvlc_audio_output_device_list_release(p_list):
None, ctypes.POINTER(AudioOutputDevice))
return f(p_list)
-def libvlc_audio_output_device_set(p_mi, psz_audio_output, psz_device_id):
- '''Configures an explicit audio output device for a given audio output plugin.
- A list of possible devices can be obtained with
+def libvlc_audio_output_device_set(mp, module, device_id):
+ '''Configures an explicit audio output device.
+ If the module paramater is NULL, audio output will be moved to the device
+ specified by the device identifier string immediately. This is the
+ recommended usage.
+ A list of adequate potential device strings can be obtained with
+ L{libvlc_audio_output_device_enum}().
+ However passing NULL is supported in LibVLC version 2.2.0 and later only;
+ in earlier versions, this function would have no effects when the module
+ parameter was NULL.
+ If the module parameter is not NULL, the device parameter of the
+ corresponding audio output, if it exists, will be set to the specified
+ string. Note that some audio output modules do not have such a parameter
+ (notably MMDevice and PulseAudio).
+ A list of adequate potential device strings can be obtained with
L{libvlc_audio_output_device_list_get}().
@note: This function does not select the specified audio output plugin.
L{libvlc_audio_output_set}() is used for that purpose.
@warning: The syntax for the device parameter depends on the audio output.
- This is not portable. Only use this function if you know what you are doing.
- Some audio outputs do not support this function (e.g. PulseAudio, WASAPI).
- Some audio outputs require further parameters (e.g. ALSA: channels map).
- @param p_mi: media player.
- @param psz_audio_output: - name of audio output, See L{AudioOutput}.
- @param psz_device_id: device.
- @return: Nothing. Errors are ignored.
+ Some audio output modules require further parameters (e.g. a channels map
+ in the case of ALSA).
+ @param mp: media player.
+ @param module: If NULL, current audio output module. if non-NULL, name of audio output module.
+ @param device_id: device identifier string.
+ @return: Nothing. Errors are ignored (this is a design bug).
'''
f = _Cfunctions.get('libvlc_audio_output_device_set', None) or \
_Cfunction('libvlc_audio_output_device_set', ((1,), (1,), (1,),), None,
None, MediaPlayer, ctypes.c_char_p, ctypes.c_char_p)
- return f(p_mi, psz_audio_output, psz_device_id)
+ return f(mp, module, device_id)
def libvlc_audio_toggle_mute(p_mi):
'''Toggle mute status.
@@ -5551,6 +5737,175 @@ def libvlc_audio_set_delay(p_mi, i_delay):
ctypes.c_int, MediaPlayer, ctypes.c_int64)
return f(p_mi, i_delay)
+def libvlc_audio_equalizer_get_preset_count():
+ '''Get the number of equalizer presets.
+ @return: number of presets.
+ @version: LibVLC 2.2.0 or later.
+ '''
+ f = _Cfunctions.get('libvlc_audio_equalizer_get_preset_count', None) or \
+ _Cfunction('libvlc_audio_equalizer_get_preset_count', (), None,
+ ctypes.c_uint)
+ return f()
+
+def libvlc_audio_equalizer_get_preset_name(u_index):
+ '''Get the name of a particular equalizer preset.
+ This name can be used, for example, to prepare a preset label or menu in a user
+ interface.
+ @param u_index: index of the preset, counting from zero.
+ @return: preset name, or NULL if there is no such preset.
+ @version: LibVLC 2.2.0 or later.
+ '''
+ f = _Cfunctions.get('libvlc_audio_equalizer_get_preset_name', None) or \
+ _Cfunction('libvlc_audio_equalizer_get_preset_name', ((1,),), None,
+ ctypes.c_char_p, ctypes.c_uint)
+ return f(u_index)
+
+def libvlc_audio_equalizer_get_band_count():
+ '''Get the number of distinct frequency bands for an equalizer.
+ @return: number of frequency bands.
+ @version: LibVLC 2.2.0 or later.
+ '''
+ f = _Cfunctions.get('libvlc_audio_equalizer_get_band_count', None) or \
+ _Cfunction('libvlc_audio_equalizer_get_band_count', (), None,
+ ctypes.c_uint)
+ return f()
+
+def libvlc_audio_equalizer_get_band_frequency(u_index):
+ '''Get a particular equalizer band frequency.
+ This value can be used, for example, to create a label for an equalizer band control
+ in a user interface.
+ @param u_index: index of the band, counting from zero.
+ @return: equalizer band frequency (Hz), or -1 if there is no such band.
+ @version: LibVLC 2.2.0 or later.
+ '''
+ f = _Cfunctions.get('libvlc_audio_equalizer_get_band_frequency', None) or \
+ _Cfunction('libvlc_audio_equalizer_get_band_frequency', ((1,),), None,
+ ctypes.c_float, ctypes.c_uint)
+ return f(u_index)
+
+def libvlc_audio_equalizer_new():
+ '''Create a new default equalizer, with all frequency values zeroed.
+ The new equalizer can subsequently be applied to a media player by invoking
+ L{libvlc_media_player_set_equalizer}().
+ The returned handle should be freed via L{libvlc_audio_equalizer_release}() when
+ it is no longer needed.
+ @return: opaque equalizer handle, or NULL on error.
+ @version: LibVLC 2.2.0 or later.
+ '''
+ f = _Cfunctions.get('libvlc_audio_equalizer_new', None) or \
+ _Cfunction('libvlc_audio_equalizer_new', (), None,
+ ctypes.c_void_p)
+ return f()
+
+def libvlc_audio_equalizer_new_from_preset(u_index):
+ '''Create a new equalizer, with initial frequency values copied from an existing
+ preset.
+ The new equalizer can subsequently be applied to a media player by invoking
+ L{libvlc_media_player_set_equalizer}().
+ The returned handle should be freed via L{libvlc_audio_equalizer_release}() when
+ it is no longer needed.
+ @param u_index: index of the preset, counting from zero.
+ @return: opaque equalizer handle, or NULL on error.
+ @version: LibVLC 2.2.0 or later.
+ '''
+ f = _Cfunctions.get('libvlc_audio_equalizer_new_from_preset', None) or \
+ _Cfunction('libvlc_audio_equalizer_new_from_preset', ((1,),), None,
+ ctypes.c_void_p, ctypes.c_uint)
+ return f(u_index)
+
+def libvlc_audio_equalizer_release(p_equalizer):
+ '''Release a previously created equalizer instance.
+ The equalizer was previously created by using L{libvlc_audio_equalizer_new}() or
+ L{libvlc_audio_equalizer_new_from_preset}().
+ It is safe to invoke this method with a NULL p_equalizer parameter for no effect.
+ @param p_equalizer: opaque equalizer handle, or NULL.
+ @version: LibVLC 2.2.0 or later.
+ '''
+ f = _Cfunctions.get('libvlc_audio_equalizer_release', None) or \
+ _Cfunction('libvlc_audio_equalizer_release', ((1,),), None,
+ None, ctypes.c_void_p)
+ return f(p_equalizer)
+
+def libvlc_audio_equalizer_set_preamp(p_equalizer, f_preamp):
+ '''Set a new pre-amplification value for an equalizer.
+ The new equalizer settings are subsequently applied to a media player by invoking
+ L{libvlc_media_player_set_equalizer}().
+ The supplied amplification value will be clamped to the -20.0 to +20.0 range.
+ @param p_equalizer: valid equalizer handle, must not be NULL.
+ @param f_preamp: preamp value (-20.0 to 20.0 Hz).
+ @return: zero on success, -1 on error.
+ @version: LibVLC 2.2.0 or later.
+ '''
+ f = _Cfunctions.get('libvlc_audio_equalizer_set_preamp', None) or \
+ _Cfunction('libvlc_audio_equalizer_set_preamp', ((1,), (1,),), None,
+ ctypes.c_int, ctypes.c_void_p, ctypes.c_float)
+ return f(p_equalizer, f_preamp)
+
+def libvlc_audio_equalizer_get_preamp(p_equalizer):
+ '''Get the current pre-amplification value from an equalizer.
+ @param p_equalizer: valid equalizer handle, must not be NULL.
+ @return: preamp value (Hz).
+ @version: LibVLC 2.2.0 or later.
+ '''
+ f = _Cfunctions.get('libvlc_audio_equalizer_get_preamp', None) or \
+ _Cfunction('libvlc_audio_equalizer_get_preamp', ((1,),), None,
+ ctypes.c_float, ctypes.c_void_p)
+ return f(p_equalizer)
+
+def libvlc_audio_equalizer_set_amp_at_index(p_equalizer, f_amp, u_band):
+ '''Set a new amplification value for a particular equalizer frequency band.
+ The new equalizer settings are subsequently applied to a media player by invoking
+ L{libvlc_media_player_set_equalizer}().
+ The supplied amplification value will be clamped to the -20.0 to +20.0 range.
+ @param p_equalizer: valid equalizer handle, must not be NULL.
+ @param f_amp: amplification value (-20.0 to 20.0 Hz).
+ @param u_band: index, counting from zero, of the frequency band to set.
+ @return: zero on success, -1 on error.
+ @version: LibVLC 2.2.0 or later.
+ '''
+ f = _Cfunctions.get('libvlc_audio_equalizer_set_amp_at_index', None) or \
+ _Cfunction('libvlc_audio_equalizer_set_amp_at_index', ((1,), (1,), (1,),), None,
+ ctypes.c_int, ctypes.c_void_p, ctypes.c_float, ctypes.c_uint)
+ return f(p_equalizer, f_amp, u_band)
+
+def libvlc_audio_equalizer_get_amp_at_index(p_equalizer, u_band):
+ '''Get the amplification value for a particular equalizer frequency band.
+ @param p_equalizer: valid equalizer handle, must not be NULL.
+ @param u_band: index, counting from zero, of the frequency band to get.
+ @return: amplification value (Hz); NaN if there is no such frequency band.
+ @version: LibVLC 2.2.0 or later.
+ '''
+ f = _Cfunctions.get('libvlc_audio_equalizer_get_amp_at_index', None) or \
+ _Cfunction('libvlc_audio_equalizer_get_amp_at_index', ((1,), (1,),), None,
+ ctypes.c_float, ctypes.c_void_p, ctypes.c_uint)
+ return f(p_equalizer, u_band)
+
+def libvlc_media_player_set_equalizer(p_mi, p_equalizer):
+ '''Apply new equalizer settings to a media player.
+ The equalizer is first created by invoking L{libvlc_audio_equalizer_new}() or
+ L{libvlc_audio_equalizer_new_from_preset}().
+ It is possible to apply new equalizer settings to a media player whether the media
+ player is currently playing media or not.
+ Invoking this method will immediately apply the new equalizer settings to the audio
+ output of the currently playing media if there is any.
+ If there is no currently playing media, the new equalizer settings will be applied
+ later if and when new media is played.
+ Equalizer settings will automatically be applied to subsequently played media.
+ To disable the equalizer for a media player invoke this method passing NULL for the
+ p_equalizer parameter.
+ The media player does not keep a reference to the supplied equalizer so it is safe
+ for an application to release the equalizer reference any time after this method
+ returns.
+ @param p_mi: opaque media player handle.
+ @param p_equalizer: opaque equalizer handle, or NULL to disable the equalizer for this media player.
+ @return: zero on success, -1 on error.
+ @version: LibVLC 2.2.0 or later.
+ '''
+ f = _Cfunctions.get('libvlc_media_player_set_equalizer', None) or \
+ _Cfunction('libvlc_media_player_set_equalizer', ((1,), (1,),), None,
+ ctypes.c_int, MediaPlayer, ctypes.c_void_p)
+ return f(p_mi, p_equalizer)
+
def libvlc_vlm_release(p_instance):
'''Release the vlm instance related to the given L{Instance}.
@param p_instance: the instance.
@@ -5863,7 +6218,18 @@ def libvlc_vlm_get_event_manager(p_instance):
# libvlc_printerr
# libvlc_set_exit_handler
-# 17 function(s) not wrapped as methods:
+# 28 function(s) not wrapped as methods:
+# libvlc_audio_equalizer_get_amp_at_index
+# libvlc_audio_equalizer_get_band_count
+# libvlc_audio_equalizer_get_band_frequency
+# libvlc_audio_equalizer_get_preamp
+# libvlc_audio_equalizer_get_preset_count
+# libvlc_audio_equalizer_get_preset_name
+# libvlc_audio_equalizer_new
+# libvlc_audio_equalizer_new_from_preset
+# libvlc_audio_equalizer_release
+# libvlc_audio_equalizer_set_amp_at_index
+# libvlc_audio_equalizer_set_preamp
# libvlc_audio_output_device_list_release
# libvlc_audio_output_list_release
# libvlc_clearerr
diff --git a/openlp/core/ui/media/vlcplayer.py b/openlp/core/ui/media/vlcplayer.py
index c80bb6218..d02526b0e 100644
--- a/openlp/core/ui/media/vlcplayer.py
+++ b/openlp/core/ui/media/vlcplayer.py
@@ -34,6 +34,7 @@ from distutils.version import LooseVersion
import logging
import os
import sys
+import threading
from PyQt4 import QtGui
@@ -207,7 +208,7 @@ class VlcPlayer(MediaPlayer):
start_time = 0
if self.state != MediaState.Paused and controller.media_info.start_time > 0:
start_time = controller.media_info.start_time
- display.vlc_media_player.play()
+ threading.Thread(target=display.vlc_media_player.play).start()
if not self.media_state_wait(display, vlc.State.Playing):
return False
self.volume(display, controller.media_info.volume)
@@ -233,7 +234,7 @@ class VlcPlayer(MediaPlayer):
"""
Stop the current item
"""
- display.vlc_media_player.stop()
+ threading.Thread(target=display.vlc_media_player.stop).start()
self.state = MediaState.Stopped
def volume(self, display, vol):
diff --git a/openlp/core/ui/plugindialog.py b/openlp/core/ui/plugindialog.py
index f4d2d991b..40311677e 100644
--- a/openlp/core/ui/plugindialog.py
+++ b/openlp/core/ui/plugindialog.py
@@ -32,6 +32,7 @@ The UI widgets of the plugin view dialog
from PyQt4 import QtCore, QtGui
from openlp.core.common import UiStrings, translate
+from openlp.core.lib import build_icon
from openlp.core.lib.ui import create_button_box
@@ -44,6 +45,7 @@ class Ui_PluginViewDialog(object):
Set up the UI
"""
pluginViewDialog.setObjectName('pluginViewDialog')
+ pluginViewDialog.setWindowIcon(build_icon(u':/icon/openlp-logo.svg'))
pluginViewDialog.setWindowModality(QtCore.Qt.ApplicationModal)
self.plugin_layout = QtGui.QVBoxLayout(pluginViewDialog)
self.plugin_layout.setObjectName('plugin_layout')
diff --git a/openlp/core/ui/pluginform.py b/openlp/core/ui/pluginform.py
index 91b98b97a..78bdee4a5 100644
--- a/openlp/core/ui/pluginform.py
+++ b/openlp/core/ui/pluginform.py
@@ -30,7 +30,6 @@
The actual plugin view form
"""
import logging
-import os
from PyQt4 import QtGui
diff --git a/openlp/core/ui/printservicedialog.py b/openlp/core/ui/printservicedialog.py
index f59dcb044..0873a0b4a 100644
--- a/openlp/core/ui/printservicedialog.py
+++ b/openlp/core/ui/printservicedialog.py
@@ -56,6 +56,7 @@ class Ui_PrintServiceDialog(object):
Set up the UI
"""
print_service_dialog.setObjectName('print_service_dialog')
+ print_service_dialog.setWindowIcon(build_icon(u':/icon/openlp-logo.svg'))
print_service_dialog.resize(664, 594)
self.main_layout = QtGui.QVBoxLayout(print_service_dialog)
self.main_layout.setSpacing(0)
diff --git a/openlp/core/ui/printserviceform.py b/openlp/core/ui/printserviceform.py
index 489eefa78..41caaab52 100644
--- a/openlp/core/ui/printserviceform.py
+++ b/openlp/core/ui/printserviceform.py
@@ -242,7 +242,7 @@ class PrintServiceForm(QtGui.QDialog, Ui_PrintServiceDialog, RegistryProperties)
Creates a html element. If ``text`` is given, the element's text will set and if a ``parent`` is given,
the element is appended.
- :param tag: The html tag, e. g. ``u'span'``. Defaults to ``None``.
+ :param tag: The html tag, e. g. ``'span'``. Defaults to ``None``.
:param text: The text for the tag. Defaults to ``None``.
:param parent: The parent element. Defaults to ``None``.
:param classId: Value for the class attribute
diff --git a/openlp/core/ui/serviceitemeditdialog.py b/openlp/core/ui/serviceitemeditdialog.py
index 76139c875..1fa19eb31 100644
--- a/openlp/core/ui/serviceitemeditdialog.py
+++ b/openlp/core/ui/serviceitemeditdialog.py
@@ -32,6 +32,7 @@ The UI widgets for the service item edit dialog
from PyQt4 import QtGui
from openlp.core.common import translate
+from openlp.core.lib import build_icon
from openlp.core.lib.ui import create_button_box, create_button
@@ -44,6 +45,7 @@ class Ui_ServiceItemEditDialog(object):
Set up the UI
"""
serviceItemEditDialog.setObjectName('serviceItemEditDialog')
+ serviceItemEditDialog.setWindowIcon(build_icon(u':/icon/openlp-logo.svg'))
self.dialog_layout = QtGui.QGridLayout(serviceItemEditDialog)
self.dialog_layout.setContentsMargins(8, 8, 8, 8)
self.dialog_layout.setSpacing(8)
diff --git a/openlp/core/ui/servicemanager.py b/openlp/core/ui/servicemanager.py
index a938b52a2..0ba59aaa0 100644
--- a/openlp/core/ui/servicemanager.py
+++ b/openlp/core/ui/servicemanager.py
@@ -401,9 +401,12 @@ class ServiceManager(OpenLPMixin, RegistryMixin, QtGui.QWidget, Ui_ServiceManage
:param suffix_list: New Suffix's to be supported
"""
- for suffix in suffix_list:
- if suffix not in self.suffixes:
- self.suffixes.append(suffix)
+ if isinstance(suffix_list, str):
+ self.suffixes.append(suffix_list)
+ else:
+ for suffix in suffix_list:
+ if suffix not in self.suffixes:
+ self.suffixes.append(suffix)
def on_new_service_clicked(self, field=None):
"""
@@ -1081,6 +1084,7 @@ class ServiceManager(OpenLPMixin, RegistryMixin, QtGui.QWidget, Ui_ServiceManage
:param field:
:param message: The data passed in from a remove message
"""
+ self.log_debug(message)
self.set_item(int(message))
def set_item(self, index):
@@ -1089,7 +1093,7 @@ class ServiceManager(OpenLPMixin, RegistryMixin, QtGui.QWidget, Ui_ServiceManage
:param index: The index of the service item list to be actioned.
"""
- if 0 >= index < self.service_manager_list.topLevelItemCount():
+ if 0 <= index < self.service_manager_list.topLevelItemCount():
item = self.service_manager_list.topLevelItem(index)
self.service_manager_list.setCurrentItem(item)
self.make_live()
diff --git a/openlp/core/ui/settingsdialog.py b/openlp/core/ui/settingsdialog.py
index f625680d6..fbac6a155 100644
--- a/openlp/core/ui/settingsdialog.py
+++ b/openlp/core/ui/settingsdialog.py
@@ -45,8 +45,8 @@ class Ui_SettingsDialog(object):
Set up the UI
"""
settings_dialog.setObjectName('settings_dialog')
+ settings_dialog.setWindowIcon(build_icon(u':/icon/openlp-logo.svg'))
settings_dialog.resize(800, 500)
- settings_dialog.setWindowIcon(build_icon(':/system/system_settings.png'))
self.dialog_layout = QtGui.QGridLayout(settings_dialog)
self.dialog_layout.setObjectName('dialog_layout')
self.dialog_layout.setMargin(8)
diff --git a/openlp/core/ui/shortcutlistdialog.py b/openlp/core/ui/shortcutlistdialog.py
index 54433da24..ef2dc4056 100644
--- a/openlp/core/ui/shortcutlistdialog.py
+++ b/openlp/core/ui/shortcutlistdialog.py
@@ -66,6 +66,7 @@ class Ui_ShortcutListDialog(object):
Set up the UI
"""
shortcutListDialog.setObjectName('shortcutListDialog')
+ shortcutListDialog.setWindowIcon(build_icon(u':/icon/openlp-logo.svg'))
shortcutListDialog.resize(500, 438)
self.shortcut_list_layout = QtGui.QVBoxLayout(shortcutListDialog)
self.shortcut_list_layout.setObjectName('shortcut_list_layout')
diff --git a/openlp/core/ui/shortcutlistform.py b/openlp/core/ui/shortcutlistform.py
index 4b64c3b54..dbfbbd439 100644
--- a/openlp/core/ui/shortcutlistform.py
+++ b/openlp/core/ui/shortcutlistform.py
@@ -244,10 +244,10 @@ class ShortcutListForm(QtGui.QDialog, Ui_ShortcutListDialog, RegistryProperties)
self.primary_push_button.setChecked(False)
self.alternate_push_button.setChecked(False)
else:
- if action.defaultShortcuts:
- primary_label_text = action.defaultShortcuts[0].toString()
- if len(action.defaultShortcuts) == 2:
- alternate_label_text = action.defaultShortcuts[1].toString()
+ if action.default_shortcuts:
+ primary_label_text = action.default_shortcuts[0].toString()
+ if len(action.default_shortcuts) == 2:
+ alternate_label_text = action.default_shortcuts[1].toString()
shortcuts = self._action_shortcuts(action)
# We do not want to loose pending changes, that is why we have to keep the text when, this function has not
# been triggered by a signal.
@@ -292,7 +292,7 @@ class ShortcutListForm(QtGui.QDialog, Ui_ShortcutListDialog, RegistryProperties)
self._adjust_button(self.alternate_push_button, False, text='')
for category in self.action_list.categories:
for action in category.actions:
- self.changed_actions[action] = action.defaultShortcuts
+ self.changed_actions[action] = action.default_shortcuts
self.refresh_shortcut_list()
def on_default_radio_button_clicked(self, toggled):
@@ -306,7 +306,7 @@ class ShortcutListForm(QtGui.QDialog, Ui_ShortcutListDialog, RegistryProperties)
if action is None:
return
temp_shortcuts = self._action_shortcuts(action)
- self.changed_actions[action] = action.defaultShortcuts
+ self.changed_actions[action] = action.default_shortcuts
self.refresh_shortcut_list()
primary_button_text = ''
alternate_button_text = ''
@@ -357,8 +357,8 @@ class ShortcutListForm(QtGui.QDialog, Ui_ShortcutListDialog, RegistryProperties)
return
shortcuts = self._action_shortcuts(action)
new_shortcuts = []
- if action.defaultShortcuts:
- new_shortcuts.append(action.defaultShortcuts[0])
+ if action.default_shortcuts:
+ new_shortcuts.append(action.default_shortcuts[0])
# We have to check if the primary default shortcut is available. But we only have to check, if the action
# has a default primary shortcut (an "empty" shortcut is always valid and if the action does not have a
# default primary shortcut, then the alternative shortcut (not the default one) will become primary
@@ -383,8 +383,8 @@ class ShortcutListForm(QtGui.QDialog, Ui_ShortcutListDialog, RegistryProperties)
new_shortcuts = []
if shortcuts:
new_shortcuts.append(shortcuts[0])
- if len(action.defaultShortcuts) == 2:
- new_shortcuts.append(action.defaultShortcuts[1])
+ if len(action.default_shortcuts) == 2:
+ new_shortcuts.append(action.default_shortcuts[1])
if len(new_shortcuts) == 2:
if not self._validiate_shortcut(action, new_shortcuts[1]):
return
diff --git a/openlp/core/ui/starttimedialog.py b/openlp/core/ui/starttimedialog.py
index 54e0629a4..cfd507bb2 100644
--- a/openlp/core/ui/starttimedialog.py
+++ b/openlp/core/ui/starttimedialog.py
@@ -32,6 +32,7 @@ The UI widgets for the time dialog
from PyQt4 import QtCore, QtGui
from openlp.core.common import UiStrings, translate
+from openlp.core.lib import build_icon
from openlp.core.lib.ui import create_button_box
@@ -44,6 +45,7 @@ class Ui_StartTimeDialog(object):
Set up the UI
"""
StartTimeDialog.setObjectName('StartTimeDialog')
+ StartTimeDialog.setWindowIcon(build_icon(u':/icon/openlp-logo.svg'))
StartTimeDialog.resize(350, 10)
self.dialog_layout = QtGui.QGridLayout(StartTimeDialog)
self.dialog_layout.setObjectName('dialog_layout')
diff --git a/openlp/core/ui/themeform.py b/openlp/core/ui/themeform.py
index d9b61e117..46fd227dd 100644
--- a/openlp/core/ui/themeform.py
+++ b/openlp/core/ui/themeform.py
@@ -18,11 +18,11 @@
# Software Foundation; version 2 of the License. #
# #
# This program is distributed in the hope that it will be useful, but WITHOUT #
-# AN_y WARRANT_y; without even the implied warranty of MERCHANTABILIT_y or #
+# 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 #
+# 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 #
###############################################################################
@@ -90,7 +90,7 @@ class ThemeForm(QtGui.QWizard, Ui_ThemeWizard, RegistryProperties):
self.footer_font_combo_box.activated.connect(self.update_theme)
self.footer_size_spin_box.valueChanged.connect(self.update_theme)
- def setDefaults(self):
+ def set_defaults(self):
"""
Set up display at start of theme edit.
"""
@@ -179,7 +179,7 @@ class ThemeForm(QtGui.QWizard, Ui_ThemeWizard, RegistryProperties):
if self.page(self.currentId()) == self.background_page and \
self.theme.background_type == background_image and is_not_image_file(self.theme.background_filename):
QtGui.QMessageBox.critical(self, translate('OpenLP.ThemeWizard', 'Background Image Empty'),
- translate('OpenLP.ThemeWizard', '_you have not selected a '
+ translate('OpenLP.ThemeWizard', 'You have not selected a '
'background image. Please select one before continuing.'))
return False
else:
@@ -261,7 +261,7 @@ class ThemeForm(QtGui.QWizard, Ui_ThemeWizard, RegistryProperties):
log.debug('Editing theme %s' % self.theme.theme_name)
self.temp_background_filename = ''
self.update_theme_allowed = False
- self.setDefaults()
+ self.set_defaults()
self.update_theme_allowed = True
self.theme_name_label.setVisible(not edit)
self.theme_name_edit.setVisible(not edit)
diff --git a/openlp/core/ui/themelayoutdialog.py b/openlp/core/ui/themelayoutdialog.py
index 023d6259c..d3fbeed2d 100644
--- a/openlp/core/ui/themelayoutdialog.py
+++ b/openlp/core/ui/themelayoutdialog.py
@@ -32,6 +32,7 @@ The layout of the theme
from PyQt4 import QtGui
from openlp.core.common import translate
+from openlp.core.lib import build_icon
from openlp.core.lib.ui import create_button_box
@@ -44,6 +45,7 @@ class Ui_ThemeLayoutDialog(object):
Set up the UI
"""
themeLayoutDialog.setObjectName('themeLayoutDialogDialog')
+ themeLayoutDialog.setWindowIcon(build_icon(u':/icon/openlp-logo.svg'))
self.preview_layout = QtGui.QVBoxLayout(themeLayoutDialog)
self.preview_layout.setObjectName('preview_layout')
self.preview_area = QtGui.QWidget(themeLayoutDialog)
diff --git a/openlp/core/ui/themestab.py b/openlp/core/ui/themestab.py
index 1f54f984b..0478f0ed0 100644
--- a/openlp/core/ui/themestab.py
+++ b/openlp/core/ui/themestab.py
@@ -190,7 +190,7 @@ class ThemesTab(SettingsTab):
:param theme_list: The list of available themes::
- [u'Bible Theme', u'Song Theme']
+ ['Bible Theme', 'Song Theme']
"""
# Reload as may have been triggered by the ThemeManager.
self.global_theme = Settings().value(self.settings_section + '/global theme')
diff --git a/openlp/core/ui/themewizard.py b/openlp/core/ui/themewizard.py
index 77ccb0663..bda52c807 100644
--- a/openlp/core/ui/themewizard.py
+++ b/openlp/core/ui/themewizard.py
@@ -46,6 +46,7 @@ class Ui_ThemeWizard(object):
Set up the UI
"""
themeWizard.setObjectName('OpenLP.ThemeWizard')
+ themeWizard.setWindowIcon(build_icon(u':/icon/openlp-logo.svg'))
themeWizard.setModal(True)
themeWizard.setWizardStyle(QtGui.QWizard.ModernStyle)
themeWizard.setOptions(QtGui.QWizard.IndependentPages |
diff --git a/openlp/core/ui/wizard.py b/openlp/core/ui/wizard.py
index 05951d14a..23bc0a9e1 100644
--- a/openlp/core/ui/wizard.py
+++ b/openlp/core/ui/wizard.py
@@ -51,6 +51,7 @@ class WizardStrings(object):
CSV = 'CSV'
OS = 'OpenSong'
OSIS = 'OSIS'
+ ZEF = 'Zefania'
# These strings should need a good reason to be retranslated elsewhere.
FinishedImport = translate('OpenLP.Ui', 'Finished import.')
FormatLabel = translate('OpenLP.Ui', 'Format:')
@@ -118,6 +119,7 @@ class OpenLPWizard(QtGui.QWizard, RegistryProperties):
"""
Set up the wizard UI.
"""
+ self.setWindowIcon(build_icon(u':/icon/openlp-logo.svg'))
self.setModal(True)
self.setWizardStyle(QtGui.QWizard.ModernStyle)
self.setOptions(QtGui.QWizard.IndependentPages |
@@ -197,7 +199,7 @@ class OpenLPWizard(QtGui.QWizard, RegistryProperties):
"""
Run the wizard.
"""
- self.setDefaults()
+ self.set_defaults()
return QtGui.QWizard.exec_(self)
def reject(self):
@@ -279,7 +281,7 @@ class OpenLPWizard(QtGui.QWizard, RegistryProperties):
:param filters: The file extension filters. It should contain the file description
as well as the file extension. For example::
- u'OpenLP 2.0 Databases (*.sqlite)'
+ 'OpenLP 2.0 Databases (*.sqlite)'
"""
if filters:
filters += ';;'
diff --git a/openlp/core/utils/__init__.py b/openlp/core/utils/__init__.py
index a5b5f356a..9b024eb84 100644
--- a/openlp/core/utils/__init__.py
+++ b/openlp/core/utils/__init__.py
@@ -113,7 +113,7 @@ def get_application_version():
"""
Returns the application version of the running instance of OpenLP::
- {u'full': u'1.9.4-bzr1249', u'version': u'1.9.4', u'build': u'bzr1249'}
+ {'full': '1.9.4-bzr1249', 'version': '1.9.4', 'build': 'bzr1249'}
"""
global APPLICATION_VERSION
if APPLICATION_VERSION:
@@ -149,9 +149,9 @@ def get_application_version():
# If they are equal, then this tree is tarball with the source for the release. We do not want the revision
# number in the full version.
if tree_revision == tag_revision:
- full_version = tag_version
+ full_version = tag_version.decode('utf-8')
else:
- full_version = '%s-bzr%s' % (tag_version, tree_revision)
+ full_version = '%s-bzr%s' % (tag_version.decode('utf-8'), tree_revision.decode('utf-8'))
else:
# We're not running the development version, let's use the file.
filepath = AppLocation.get_directory(AppLocation.VersionDir)
diff --git a/openlp/core/utils/actions.py b/openlp/core/utils/actions.py
index 29f2d279b..d81e16b2e 100644
--- a/openlp/core/utils/actions.py
+++ b/openlp/core/utils/actions.py
@@ -65,20 +65,14 @@ class CategoryActionList(object):
self.index = 0
self.actions = []
- def __getitem__(self, key):
- """
- Implement the __getitem__() method to make this class a dictionary type
- """
- for weight, action in self.actions:
- if action.text() == key:
- return action
- raise KeyError('Action "%s" does not exist.' % key)
-
- def __contains__(self, item):
+ def __contains__(self, key):
"""
Implement the __contains__() method to make this class a dictionary type
"""
- return item in self
+ for weight, action in self.actions:
+ if action == key:
+ return True
+ return False
def __len__(self):
"""
@@ -103,23 +97,14 @@ class CategoryActionList(object):
self.index += 1
return self.actions[self.index - 1][1]
- def has_key(self, key):
- """
- Implement the has_key() method to make this class a dictionary type
- """
- for weight, action in self.actions:
- if action.text() == key:
- return True
- return False
-
- def append(self, name):
+ def append(self, action):
"""
Append an action
"""
weight = 0
if self.actions:
weight = self.actions[-1][0] + 1
- self.add(name, weight)
+ self.add(action, weight)
def add(self, action, weight=0):
"""
@@ -128,14 +113,15 @@ class CategoryActionList(object):
self.actions.append((weight, action))
self.actions.sort(key=lambda act: act[0])
- def remove(self, remove_action):
+ def remove(self, action):
"""
Remove an action
"""
- for action in self.actions:
- if action[1] == remove_action:
- self.actions.remove(action)
+ for item in self.actions:
+ if item[1] == action:
+ self.actions.remove(item)
return
+ raise ValueError('Action "%s" does not exist.' % action)
class CategoryList(object):
@@ -184,9 +170,9 @@ class CategoryList(object):
self.index += 1
return self.categories[self.index - 1]
- def has_key(self, key):
+ def __contains__(self, key):
"""
- Implement the has_key() method to make this class like a dictionary
+ Implement the __contains__() method to make this class like a dictionary
"""
for category in self.categories:
if category.name == key:
@@ -200,10 +186,7 @@ class CategoryList(object):
weight = 0
if self.categories:
weight = self.categories[-1].weight + 1
- if actions:
- self.add(name, weight, actions)
- else:
- self.add(name, weight)
+ self.add(name, weight, actions)
def add(self, name, weight=0, actions=None):
"""
@@ -226,6 +209,8 @@ class CategoryList(object):
for category in self.categories:
if category.name == name:
self.categories.remove(category)
+ return
+ raise ValueError('Category "%s" does not exist.' % name)
class ActionList(object):
@@ -270,7 +255,7 @@ class ActionList(object):
settings = Settings()
settings.beginGroup('shortcuts')
# Get the default shortcut from the config.
- action.defaultShortcuts = settings.get_default_value(action.objectName())
+ action.default_shortcuts = settings.get_default_value(action.objectName())
if weight is None:
self.categories[category].actions.append(action)
else:
diff --git a/openlp/core/utils/languagemanager.py b/openlp/core/utils/languagemanager.py
index bb584f7bd..dd048e04c 100644
--- a/openlp/core/utils/languagemanager.py
+++ b/openlp/core/utils/languagemanager.py
@@ -71,8 +71,7 @@ class LanguageManager(object):
"""
Find all available language files in this OpenLP install
"""
- log.debug('Translation files: %s', AppLocation.get_directory(
- AppLocation.LanguageDir))
+ log.debug('Translation files: %s', AppLocation.get_directory(AppLocation.LanguageDir))
trans_dir = QtCore.QDir(AppLocation.get_directory(AppLocation.LanguageDir))
file_names = trans_dir.entryList(['*.qm'], QtCore.QDir.Files, QtCore.QDir.Name)
# Remove qm files from the list which start with "qt_".
diff --git a/openlp/plugins/alerts/forms/__init__.py b/openlp/plugins/alerts/forms/__init__.py
index 55d44372e..fbe3c7170 100644
--- a/openlp/plugins/alerts/forms/__init__.py
+++ b/openlp/plugins/alerts/forms/__init__.py
@@ -32,7 +32,7 @@ other class holds all the functional code, like slots and loading and saving.
The first class, commonly known as the **Dialog** class, is typically named ``Ui_Dialog``. It is a slightly
modified version of the class that the ``pyuic4`` command produces from Qt4's .ui file. Typical modifications will be
-converting most strings from "" to u'' and using OpenLP's ``translate()`` function for translating strings.
+converting most strings from "" to '' and using OpenLP's ``translate()`` function for translating strings.
The second class, commonly known as the **Form** class, is typically named ``Form``. This class is the one which
is instantiated and used. It uses dual inheritance to inherit from (usually) QtGui.QDialog and the Ui class mentioned
diff --git a/openlp/plugins/alerts/forms/alertdialog.py b/openlp/plugins/alerts/forms/alertdialog.py
index e4fd29a39..47e61365a 100644
--- a/openlp/plugins/alerts/forms/alertdialog.py
+++ b/openlp/plugins/alerts/forms/alertdialog.py
@@ -46,7 +46,7 @@ class Ui_AlertDialog(object):
"""
alert_dialog.setObjectName('alert_dialog')
alert_dialog.resize(400, 300)
- alert_dialog.setWindowIcon(build_icon(':/icon/openlp-logo-16x16.png'))
+ alert_dialog.setWindowIcon(build_icon(u':/icon/openlp-logo.svg'))
self.alert_dialog_layout = QtGui.QGridLayout(alert_dialog)
self.alert_dialog_layout.setObjectName('alert_dialog_layout')
self.alert_text_layout = QtGui.QFormLayout()
diff --git a/openlp/plugins/bibles/forms/__init__.py b/openlp/plugins/bibles/forms/__init__.py
index 974d6d7a5..d6c77a9a3 100644
--- a/openlp/plugins/bibles/forms/__init__.py
+++ b/openlp/plugins/bibles/forms/__init__.py
@@ -33,7 +33,7 @@ other class holds all the functional code, like slots and loading and saving.
The first class, commonly known as the **Dialog** class, is typically named ``Ui_Dialog``. It is a slightly
modified version of the class that the ``pyuic4`` command produces from Qt4's .ui file. Typical modifications will be
-converting most strings from "" to u'' and using OpenLP's ``translate()`` function for translating strings.
+converting most strings from "" to '' and using OpenLP's ``translate()`` function for translating strings.
The second class, commonly known as the **Form** class, is typically named ``Form``. This class is the one which
is instantiated and used. It uses dual inheritance to inherit from (usually) QtGui.QDialog and the Ui class mentioned
diff --git a/openlp/plugins/bibles/forms/bibleimportform.py b/openlp/plugins/bibles/forms/bibleimportform.py
index ee5bee2d0..171994d18 100644
--- a/openlp/plugins/bibles/forms/bibleimportform.py
+++ b/openlp/plugins/bibles/forms/bibleimportform.py
@@ -110,6 +110,7 @@ class BibleImportForm(OpenLPWizard):
self.csv_books_button.clicked.connect(self.on_csv_books_browse_button_clicked)
self.csv_verses_button.clicked.connect(self.on_csv_verses_browse_button_clicked)
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)
def add_custom_pages(self):
"""
@@ -125,7 +126,7 @@ class BibleImportForm(OpenLPWizard):
self.format_label = QtGui.QLabel(self.select_page)
self.format_label.setObjectName('FormatLabel')
self.format_combo_box = QtGui.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 = QtGui.QSpacerItem(10, 0, QtGui.QSizePolicy.Fixed, QtGui.QSizePolicy.Minimum)
@@ -247,6 +248,25 @@ class BibleImportForm(OpenLPWizard):
self.web_proxy_layout.setWidget(2, QtGui.QFormLayout.FieldRole, self.web_password_edit)
self.web_tab_widget.addTab(self.web_proxy_tab, '')
self.select_stack.addWidget(self.web_tab_widget)
+ self.zefania_widget = QtGui.QWidget(self.select_page)
+ self.zefania_widget.setObjectName('ZefaniaWidget')
+ self.zefania_layout = QtGui.QFormLayout(self.zefania_widget)
+ self.zefania_layout.setMargin(0)
+ self.zefania_layout.setObjectName('ZefaniaLayout')
+ self.zefania_file_label = QtGui.QLabel(self.zefania_widget)
+ self.zefania_file_label.setObjectName('ZefaniaFileLabel')
+ self.zefania_file_layout = QtGui.QHBoxLayout()
+ self.zefania_file_layout.setObjectName('ZefaniaFileLayout')
+ self.zefania_file_edit = QtGui.QLineEdit(self.zefania_widget)
+ self.zefania_file_edit.setObjectName('ZefaniaFileEdit')
+ self.zefania_file_layout.addWidget(self.zefania_file_edit)
+ self.zefania_browse_button = QtGui.QToolButton(self.zefania_widget)
+ self.zefania_browse_button.setIcon(self.open_icon)
+ self.zefania_browse_button.setObjectName('ZefaniaBrowseButton')
+ self.zefania_file_layout.addWidget(self.zefania_browse_button)
+ self.zefania_layout.addRow(self.zefania_file_label, self.zefania_file_layout)
+ self.zefania_layout.setItem(5, QtGui.QFormLayout.LabelRole, self.spacer)
+ self.select_stack.addWidget(self.zefania_widget)
self.select_page_layout.addLayout(self.select_stack)
self.addPage(self.select_page)
# License Page
@@ -294,11 +314,13 @@ class BibleImportForm(OpenLPWizard):
self.format_combo_box.setItemText(BibleFormat.OpenSong, WizardStrings.OS)
self.format_combo_box.setItemText(BibleFormat.WebDownload, translate('BiblesPlugin.ImportWizardForm',
'Web Download'))
+ self.format_combo_box.setItemText(BibleFormat.Zefania, WizardStrings.ZEF)
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:'))
self.open_song_file_label.setText(translate('BiblesPlugin.ImportWizardForm', 'Bible file:'))
self.web_source_label.setText(translate('BiblesPlugin.ImportWizardForm', 'Location:'))
+ self.zefania_file_label.setText(translate('BiblesPlugin.ImportWizardForm', 'Bible file:'))
self.web_source_combo_box.setItemText(WebDownload.Crosswalk, translate('BiblesPlugin.ImportWizardForm',
'Crosswalk'))
self.web_source_combo_box.setItemText(WebDownload.BibleGateway, translate('BiblesPlugin.ImportWizardForm',
@@ -331,7 +353,8 @@ class BibleImportForm(OpenLPWizard):
self.osis_file_label.minimumSizeHint().width(),
self.csv_books_label.minimumSizeHint().width(),
self.csv_verses_label.minimumSizeHint().width(),
- self.open_song_file_label.minimumSizeHint().width())
+ self.open_song_file_label.minimumSizeHint().width(),
+ self.zefania_file_label.minimumSizeHint().width())
self.spacer.changeSize(label_width, 0, QtGui.QSizePolicy.Fixed, QtGui.QSizePolicy.Fixed)
def validateCurrentPage(self):
@@ -366,6 +389,11 @@ class BibleImportForm(OpenLPWizard):
critical_error_message_box(UiStrings().NFSs, WizardStrings.YouSpecifyFile % WizardStrings.OS)
self.open_song_file_edit.setFocus()
return False
+ elif self.field('source_format') == BibleFormat.Zefania:
+ if not self.field('zefania_file'):
+ critical_error_message_box(UiStrings().NFSs, WizardStrings.YouSpecifyFile % WizardStrings.ZEF)
+ self.zefania_file_edit.setFocus()
+ return False
elif self.field('source_format') == BibleFormat.WebDownload:
self.version_name_edit.setText(self.web_translation_combo_box.currentText())
return True
@@ -447,6 +475,13 @@ class BibleImportForm(OpenLPWizard):
self.get_file_name(WizardStrings.OpenTypeFile % WizardStrings.OS, self.open_song_file_edit,
'last directory import')
+ def on_zefania_browse_button_clicked(self):
+ """
+ Show the file open dialog for the Zefania file.
+ """
+ self.get_file_name(WizardStrings.OpenTypeFile % WizardStrings.ZEF, self.zefania_file_edit,
+ 'last directory import')
+
def register_fields(self):
"""
Register the bible import wizard fields.
@@ -456,6 +491,7 @@ class BibleImportForm(OpenLPWizard):
self.select_page.registerField('csv_booksfile', self.csv_books_edit)
self.select_page.registerField('csv_versefile', self.csv_verses_edit)
self.select_page.registerField('opensong_file', self.open_song_file_edit)
+ 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('proxy_server', self.web_server_edit)
@@ -465,7 +501,7 @@ class BibleImportForm(OpenLPWizard):
self.license_details_page.registerField('license_copyright', self.copyright_edit)
self.license_details_page.registerField('license_permissions', self.permissions_edit)
- def setDefaults(self):
+ def set_defaults(self):
"""
Set default values for the wizard pages.
"""
@@ -479,6 +515,7 @@ class BibleImportForm(OpenLPWizard):
self.setField('csv_booksfile', '')
self.setField('csv_versefile', '')
self.setField('opensong_file', '')
+ self.setField('zefania_file', '')
self.setField('web_location', WebDownload.Crosswalk)
self.setField('web_biblename', self.web_translation_combo_box.currentIndex())
self.setField('proxy_server', settings.value('proxy address'))
@@ -562,6 +599,10 @@ class BibleImportForm(OpenLPWizard):
proxy_username=self.field('proxy_username'),
proxy_password=self.field('proxy_password')
)
+ elif bible_type == BibleFormat.Zefania:
+ # Import an Zefania bible.
+ importer = self.manager.import_bible(BibleFormat.Zefania, name=license_version,
+ filename=self.field('zefania_file'))
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/forms/bibleupgradeform.py b/openlp/plugins/bibles/forms/bibleupgradeform.py
index d9936dfe6..09c0942b7 100644
--- a/openlp/plugins/bibles/forms/bibleupgradeform.py
+++ b/openlp/plugins/bibles/forms/bibleupgradeform.py
@@ -307,7 +307,7 @@ class BibleUpgradeForm(OpenLPWizard):
if self.currentPage() == self.progress_page:
return True
- def setDefaults(self):
+ def set_defaults(self):
"""
Set default values for the wizard pages.
"""
diff --git a/openlp/plugins/bibles/forms/booknamedialog.py b/openlp/plugins/bibles/forms/booknamedialog.py
index 5903391c3..120caeff0 100644
--- a/openlp/plugins/bibles/forms/booknamedialog.py
+++ b/openlp/plugins/bibles/forms/booknamedialog.py
@@ -30,12 +30,14 @@
from PyQt4 import QtCore, QtGui
from openlp.core.common import translate
+from openlp.core.lib import build_icon
from openlp.core.lib.ui import create_button_box
class Ui_BookNameDialog(object):
def setupUi(self, book_name_dialog):
book_name_dialog.setObjectName('book_name_dialog')
+ book_name_dialog.setWindowIcon(build_icon(u':/icon/openlp-logo.svg'))
book_name_dialog.resize(400, 271)
self.book_name_layout = QtGui.QVBoxLayout(book_name_dialog)
self.book_name_layout.setSpacing(8)
diff --git a/openlp/plugins/bibles/forms/editbibledialog.py b/openlp/plugins/bibles/forms/editbibledialog.py
index 1fbaa2f1e..e9e39a053 100644
--- a/openlp/plugins/bibles/forms/editbibledialog.py
+++ b/openlp/plugins/bibles/forms/editbibledialog.py
@@ -39,8 +39,8 @@ from openlp.plugins.bibles.lib.db import BiblesResourcesDB
class Ui_EditBibleDialog(object):
def setupUi(self, edit_bible_dialog):
edit_bible_dialog.setObjectName('edit_bible_dialog')
+ edit_bible_dialog.setWindowIcon(build_icon(u':/icon/openlp-logo.svg'))
edit_bible_dialog.resize(520, 400)
- edit_bible_dialog.setWindowIcon(build_icon(':/icon/openlp-logo-16x16.png'))
edit_bible_dialog.setModal(True)
self.dialog_layout = QtGui.QVBoxLayout(edit_bible_dialog)
self.dialog_layout.setSpacing(8)
diff --git a/openlp/plugins/bibles/forms/languagedialog.py b/openlp/plugins/bibles/forms/languagedialog.py
index 10382ea13..ab40503d2 100644
--- a/openlp/plugins/bibles/forms/languagedialog.py
+++ b/openlp/plugins/bibles/forms/languagedialog.py
@@ -30,12 +30,14 @@
from PyQt4 import QtGui
from openlp.core.common import translate
+from openlp.core.lib import build_icon
from openlp.core.lib.ui import create_button_box
class Ui_LanguageDialog(object):
def setupUi(self, language_dialog):
language_dialog.setObjectName('language_dialog')
+ language_dialog.setWindowIcon(build_icon(u':/icon/openlp-logo.svg'))
language_dialog.resize(400, 165)
self.language_layout = QtGui.QVBoxLayout(language_dialog)
self.language_layout.setSpacing(8)
diff --git a/openlp/plugins/bibles/lib/__init__.py b/openlp/plugins/bibles/lib/__init__.py
index 50a0e2a63..d67319797 100644
--- a/openlp/plugins/bibles/lib/__init__.py
+++ b/openlp/plugins/bibles/lib/__init__.py
@@ -262,7 +262,7 @@ def parse_reference(reference, bible, language_selection, book_ref_id=False):
For example::
- [(u'John', 3, 16, 18), (u'John', 4, 1, 1)]
+ [('John', 3, 16, 18), ('John', 4, 1, 1)]
**Reference string details:**
@@ -311,7 +311,7 @@ def parse_reference(reference, bible, language_selection, book_ref_id=False):
``(?P[0-9]+)``
The ``to_verse`` reference is equivalent to group 2.
- The full reference is matched against get_reference_match(u'full'). This regular expression looks like this:
+ The full reference is matched against get_reference_match('full'). This regular expression looks like this:
``^\s*(?!\s)(?P[\d]*[^\d]+)(?...') % book.name)
+ 'Importing verses from %s...' % book.name, 'Importing verses from ...'))
self.session.commit()
try:
verse_text = str(line[3], details['encoding'])
diff --git a/openlp/plugins/bibles/lib/db.py b/openlp/plugins/bibles/lib/db.py
index 203d86406..b0d8d0e7d 100644
--- a/openlp/plugins/bibles/lib/db.py
+++ b/openlp/plugins/bibles/lib/db.py
@@ -370,17 +370,16 @@ class BibleDB(QtCore.QObject, Manager, RegistryProperties):
This is probably the most used function. It retrieves the list of
verses based on the user's query.
- :param reference_list: This is the list of references the media manager item wants. It is
- a list of tuples, with the following format::
+ :param reference_list: This is the list of references the media manager item wants. It is a list of tuples, with
+ the following format::
(book_reference_id, chapter, start_verse, end_verse)
- Therefore, when you are looking for multiple items, simply break
- them up into references like this, bundle them into a list. This
- function then runs through the list, and returns an amalgamated
- list of ``Verse`` objects. For example::
+ Therefore, when you are looking for multiple items, simply break them up into references like this, bundle
+ them into a list. This function then runs through the list, and returns an amalgamated list of ``Verse``
+ objects. For example::
- [(u'35', 1, 1, 1), (u'35', 2, 2, 3)]
+ [('35', 1, 1, 1), ('35', 2, 2, 3)]
:param show_error:
"""
log.debug('BibleDB.get_verses("%s")' % reference_list)
diff --git a/openlp/plugins/bibles/lib/http.py b/openlp/plugins/bibles/lib/http.py
index b15e11738..6b26dfabe 100644
--- a/openlp/plugins/bibles/lib/http.py
+++ b/openlp/plugins/bibles/lib/http.py
@@ -225,7 +225,7 @@ class BGExtract(RegistryProperties):
url_book_name = urllib.parse.quote(book_name.encode("utf-8"))
url_params = 'search=%s+%s&version=%s' % (url_book_name, chapter, version)
soup = get_soup_for_bible_ref(
- 'http://www.biblegateway.com/passage/?%s' % url_params,
+ 'http://legacy.biblegateway.com/passage/?%s' % url_params,
pre_parse_regex=r'', pre_parse_substitute='')
if not soup:
return None
@@ -252,7 +252,7 @@ class BGExtract(RegistryProperties):
"""
log.debug('BGExtract.get_books_from_http("%s")', version)
url_params = urllib.parse.urlencode({'action': 'getVersionInfo', 'vid': '%s' % version})
- reference_url = 'http://www.biblegateway.com/versions/?%s#books' % url_params
+ reference_url = 'http://legacy.biblegateway.com/versions/?%s#books' % url_params
page = get_web_page(reference_url)
if not page:
send_error_message('download')
@@ -534,7 +534,7 @@ class HTTPBible(BibleDB, RegistryProperties):
them into a list. This function then runs through the list, and returns an amalgamated list of ``Verse``
objects. For example::
- [(u'35', 1, 1, 1), (u'35', 2, 2, 3)]
+ [('35', 1, 1, 1), ('35', 2, 2, 3)]
"""
log.debug('HTTPBible.get_verses("%s")', reference_list)
for reference in reference_list:
diff --git a/openlp/plugins/bibles/lib/manager.py b/openlp/plugins/bibles/lib/manager.py
index 8ad446ab4..7dab8b3d7 100644
--- a/openlp/plugins/bibles/lib/manager.py
+++ b/openlp/plugins/bibles/lib/manager.py
@@ -38,6 +38,7 @@ from .csvbible import CSVBible
from .http import HTTPBible
from .opensong import OpenSongBible
from .osis import OSISBible
+from .zefania import ZefaniaBible
log = logging.getLogger(__name__)
@@ -52,22 +53,25 @@ class BibleFormat(object):
CSV = 1
OpenSong = 2
WebDownload = 3
+ Zefania = 4
@staticmethod
- def get_class(format):
+ def get_class(bible_format):
"""
Return the appropriate implementation class.
- :param format: The Bible format.
+ :param bible_format: The Bible format.
"""
- if format == BibleFormat.OSIS:
+ if bible_format == BibleFormat.OSIS:
return OSISBible
- elif format == BibleFormat.CSV:
+ elif bible_format == BibleFormat.CSV:
return CSVBible
- elif format == BibleFormat.OpenSong:
+ elif bible_format == BibleFormat.OpenSong:
return OpenSongBible
- elif format == BibleFormat.WebDownload:
+ elif bible_format == BibleFormat.WebDownload:
return HTTPBible
+ elif bible_format == BibleFormat.Zefania:
+ return ZefaniaBible
else:
return None
@@ -81,6 +85,7 @@ class BibleFormat(object):
BibleFormat.CSV,
BibleFormat.OpenSong,
BibleFormat.WebDownload,
+ BibleFormar.Zefania,
]
diff --git a/openlp/plugins/bibles/lib/mediaitem.py b/openlp/plugins/bibles/lib/mediaitem.py
index a2cb1b594..76f91071a 100644
--- a/openlp/plugins/bibles/lib/mediaitem.py
+++ b/openlp/plugins/bibles/lib/mediaitem.py
@@ -60,7 +60,6 @@ class BibleMediaItem(MediaManagerItem):
log.info('Bible Media Item loaded')
def __init__(self, parent, plugin):
- self.icon_path = 'songs/song'
self.lock_icon = build_icon(':/bibles/bibles_search_lock.png')
self.unlock_icon = build_icon(':/bibles/bibles_search_unlock.png')
MediaManagerItem.__init__(self, parent, plugin)
@@ -172,6 +171,7 @@ class BibleMediaItem(MediaManagerItem):
self.page_layout.addWidget(tab)
tab.setVisible(False)
lock_button.toggled.connect(self.on_lock_button_toggled)
+ second_combo_box.currentIndexChanged.connect(self.on_second_bible_combobox_index_changed)
setattr(self, prefix + 'VersionLabel', version_label)
setattr(self, prefix + 'VersionComboBox', version_combo_box)
setattr(self, prefix + 'SecondLabel', second_label)
@@ -263,11 +263,15 @@ class BibleMediaItem(MediaManagerItem):
def config_update(self):
log.debug('config_update')
if Settings().value(self.settings_section + '/second bibles'):
+ self.quickSecondLabel.setVisible(True)
+ self.quickSecondComboBox.setVisible(True)
self.advancedSecondLabel.setVisible(True)
self.advancedSecondComboBox.setVisible(True)
self.quickSecondLabel.setVisible(True)
self.quickSecondComboBox.setVisible(True)
else:
+ self.quickSecondLabel.setVisible(False)
+ self.quickSecondComboBox.setVisible(False)
self.advancedSecondLabel.setVisible(False)
self.advancedSecondComboBox.setVisible(False)
self.quickSecondLabel.setVisible(False)
@@ -360,8 +364,7 @@ class BibleMediaItem(MediaManagerItem):
combo boxes on the 'Advanced Search' Tab. This is not of any importance of the 'Quick Search' Tab.
:param bible: The bible to initialise (unicode).
- :param last_book_id: The "book reference id" of the book which is chosen at the moment.
- (int)
+ :param last_book_id: The "book reference id" of the book which is chosen at the moment. (int)
"""
log.debug('initialise_advanced_bible %s, %s', bible, last_book_id)
book_data = self.plugin.manager.get_books(bible)
@@ -421,9 +424,8 @@ class BibleMediaItem(MediaManagerItem):
def update_auto_completer(self):
"""
- This updates the bible book completion list for the search field. The
- completion depends on the bible. It is only updated when we are doing a
- reference search, otherwise the auto completion list is removed.
+ This updates the bible book completion list for the search field. The completion depends on the bible. It is
+ only updated when we are doing a reference search, otherwise the auto completion list is removed.
"""
log.debug('update_auto_completer')
# Save the current search type to the configuration.
@@ -461,6 +463,17 @@ class BibleMediaItem(MediaManagerItem):
books.sort(key=get_locale_key)
set_case_insensitive_completer(books, self.quick_search_edit)
+ def on_second_bible_combobox_index_changed(self, selection):
+ """
+ Activate the style combobox only when no second bible is selected
+ """
+ if selection == 0:
+ self.quickStyleComboBox.setEnabled(True)
+ self.advancedStyleComboBox.setEnabled(True)
+ else:
+ self.quickStyleComboBox.setEnabled(False)
+ self.advancedStyleComboBox.setEnabled(False)
+
def on_import_click(self):
if not hasattr(self, 'import_wizard'):
self.import_wizard = BibleImportForm(self, self.plugin.manager, self.plugin)
@@ -593,8 +606,7 @@ class BibleMediaItem(MediaManagerItem):
:param range_from: The first number of the range (int).
:param range_to: The last number of the range (int).
:param combo: The combo box itself (QComboBox).
- :param restore: If True, then the combo's currentText will be restored after
- adjusting (if possible).
+ :param restore: If True, then the combo's currentText will be restored after adjusting (if possible).
"""
log.debug('adjust_combo_box %s, %s, %s', combo, range_from, range_to)
if restore:
@@ -640,8 +652,8 @@ class BibleMediaItem(MediaManagerItem):
def on_quick_search_button(self):
"""
- Does a quick search and saves the search results. Quick search can
- either be "Reference Search" or "Text Search".
+ Does a quick search and saves the search results. Quick search can either be "Reference Search" or
+ "Text Search".
"""
log.debug('Quick Search Button clicked')
self.quickSearchButton.setEnabled(False)
@@ -696,8 +708,7 @@ class BibleMediaItem(MediaManagerItem):
def display_results(self, bible, second_bible=''):
"""
- Displays the search results in the media manager. All data needed for
- further action is saved for/in each row.
+ Displays the search results in the media manager. All data needed for further action is saved for/in each row.
"""
items = self.build_display_results(bible, second_bible, self.search_results)
for bible_verse in items:
@@ -708,8 +719,7 @@ class BibleMediaItem(MediaManagerItem):
def build_display_results(self, bible, second_bible, search_results):
"""
- Displays the search results in the media manager. All data needed for
- further action is saved for/in each row.
+ Displays the search results in the media manager. All data needed for further action is saved for/in each row.
"""
verse_separator = get_reference_separator('sep_v_display')
version = self.plugin.manager.get_meta_data(bible, 'name').value
@@ -837,7 +847,6 @@ class BibleMediaItem(MediaManagerItem):
# If there are no more items we check whether we have to add bible_text.
if bible_text:
raw_slides.append(bible_text.lstrip())
- bible_text = ''
# Service Item: Capabilities
if self.settings.layout_style == LayoutStyle.Continuous and not second_bible:
# Split the line but do not replace line breaks in renderer.
@@ -859,9 +868,8 @@ class BibleMediaItem(MediaManagerItem):
def format_title(self, start_bitem, old_bitem):
"""
- This method is called, when we have to change the title, because
- we are at the end of a verse range. E. g. if we want to add
- Genesis 1:1-6 as well as Daniel 2:14.
+ This method is called, when we have to change the title, because we are at the end of a verse range. E. g. if we
+ want to add Genesis 1:1-6 as well as Daniel 2:14.
:param start_bitem: The first item of a range.
:param old_bitem: The last item of a range.
@@ -891,10 +899,8 @@ class BibleMediaItem(MediaManagerItem):
def check_title(self, bitem, old_bitem):
"""
- This method checks if we are at the end of an verse range. If that is
- the case, we return True, otherwise False. E. g. if we added
-
- Genesis 1:1-6, but the next verse is Daniel 2:14, we return True.
+ This method checks if we are at the end of an verse range. If that is the case, we return True, otherwise False.
+ E. g. if we added Genesis 1:1-6, but the next verse is Daniel 2:14, we return True.
:param bitem: The item we are dealing with at the moment.
:param old_bitem: The item we were previously dealing with.
@@ -918,20 +924,17 @@ class BibleMediaItem(MediaManagerItem):
return True
elif old_chapter + 1 == chapter and (verse != 1 or old_verse !=
self.plugin.manager.get_verse_count(old_bible, old_book, old_chapter)):
- # We are in the following chapter, but the last verse was not the
- # last verse of the chapter or the current verse is not the
- # first one of the chapter.
+ # We are in the following chapter, but the last verse was not the last verse of the chapter or the current
+ # verse is not the first one of the chapter.
return True
return False
def format_verse(self, old_chapter, chapter, verse):
"""
- Formats and returns the text, each verse starts with, for the given
- chapter and verse. The text is either surrounded by round, square,
+ Formats and returns the text, each verse starts with, for the given chapter and verse. The text is either
+ surrounded by round, square, curly brackets or no brackets at all. For example::
- curly brackets or no brackets at all. For example::
-
- u'{su}1:1{/su}'
+ '{su}1:1{/su}'
:param old_chapter: The previous verse's chapter number (int).
:param chapter: The chapter number (int).
diff --git a/openlp/plugins/bibles/lib/opensong.py b/openlp/plugins/bibles/lib/opensong.py
index c7bfa01a2..fa8323d7f 100644
--- a/openlp/plugins/bibles/lib/opensong.py
+++ b/openlp/plugins/bibles/lib/opensong.py
@@ -81,6 +81,13 @@ class OpenSongBible(BibleDB):
import_file = open(self.filename, 'rb')
opensong = objectify.parse(import_file)
bible = opensong.getroot()
+ # Check that we're not trying to import a Zefania XML bible, it is sometimes refered to as 'OpenSong'
+ if bible.tag.upper() == 'XMLBIBLE':
+ critical_error_message_box(
+ message=translate('BiblesPlugin.OpenSongImport',
+ 'Incorrect Bible file type supplied. This looks like a Zefania XML bible, '
+ 'please use the Zefania import option.'))
+ return False
language_id = self.get_language(bible_name)
if not language_id:
log.error('Importing books from "%s" failed' % self.filename)
diff --git a/openlp/plugins/bibles/lib/zefania.py b/openlp/plugins/bibles/lib/zefania.py
new file mode 100644
index 000000000..4e8373a93
--- /dev/null
+++ b/openlp/plugins/bibles/lib/zefania.py
@@ -0,0 +1,113 @@
+# -*- coding: utf-8 -*-
+# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
+
+###############################################################################
+# OpenLP - Open Source Lyrics Projection #
+# --------------------------------------------------------------------------- #
+# Copyright (c) 2008-2014 Raoul Snyman #
+# Portions copyright (c) 2008-2014 Tim Bentley, Gerald Britton, Jonathan #
+# Corwin, Samuel Findlay, Michael Gorven, Scott Guerrieri, Matthias Hub, #
+# Meinert Jordan, Armin Köhler, Erik Lundin, Edwin Lunando, Brian T. Meyer. #
+# Joshua Miller, Stevan Pettit, Andreas Preikschat, Mattias Põldaru, #
+# Christian Richter, Philip Ridout, Simon Scudder, Jeffrey Smith, #
+# Maikel Stuivenberg, Martin Thompson, Jon Tibble, Dave Warnock, #
+# Frode Woldsund, Martin Zibricky, Patrick Zimmermann #
+# --------------------------------------------------------------------------- #
+# 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 lxml import etree, objectify
+
+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 ZefaniaBible(BibleDB):
+ """
+ Zefania Bible format importer class.
+ """
+ def __init__(self, parent, **kwargs):
+ """
+ Constructor to create and set up an instance of the ZefaniaBible class. This class is used to import Bibles
+ from ZefaniaBible's XML format.
+ """
+ log.debug(self.__class__.__name__)
+ BibleDB.__init__(self, parent, **kwargs)
+ self.filename = kwargs['filename']
+
+ def do_import(self, bible_name=None):
+ """
+ Loads a Bible from file.
+ """
+ log.debug('Starting Zefania import from "%s"' % self.filename)
+ if not isinstance(self.filename, str):
+ self.filename = str(self.filename, 'utf8')
+ import_file = None
+ success = True
+ try:
+ # NOTE: We don't need to do any of the normal encoding detection here, because lxml does it's own encoding
+ # detection, and the two mechanisms together interfere with each other.
+ import_file = open(self.filename, 'rb')
+ language_id = self.get_language(bible_name)
+ if not language_id:
+ log.error('Importing books from "%s" failed' % self.filename)
+ return False
+ zefania_bible_tree = etree.parse(import_file)
+ num_books = int(zefania_bible_tree.xpath("count(//BIBLEBOOK)"))
+ # Strip tags we don't use - keep content
+ etree.strip_tags(zefania_bible_tree, ('STYLE', 'GRAM', 'NOTE', 'SUP', 'XREF'))
+ # Strip tags we don't use - remove content
+ etree.strip_elements(zefania_bible_tree, ('PROLOG', 'REMARK', 'CAPTION', 'MEDIA'), with_tail=False)
+ xmlbible = zefania_bible_tree.getroot()
+ for BIBLEBOOK in xmlbible:
+ book_ref_id = self.get_book_ref_id_by_name(str(BIBLEBOOK.get('bname')), num_books)
+ if not book_ref_id:
+ book_ref_id = self.get_book_ref_id_by_localised_name(str(BIBLEBOOK.get('bname')))
+ if not book_ref_id:
+ log.error('Importing books from "%s" failed' % self.filename)
+ return False
+ 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 in BIBLEBOOK:
+ if self.stop_import_flag:
+ break
+ chapter_number = CHAPTER.get("cnumber")
+ for VERS in CHAPTER:
+ verse_number = VERS.get("vnumber")
+ self.create_verse(db_book.id, chapter_number, verse_number, VERS.text.replace(' ', '\n'))
+ self.wizard.increment_progress_bar(
+ translate('BiblesPlugin.Zefnia', 'Importing %(bookname)s %(chapter)s...' %
+ {'bookname': db_book.name, 'chapter': chapter_number}))
+ self.session.commit()
+ self.application.process_events()
+ except Exception as e:
+ print(str(e))
+ critical_error_message_box(
+ message=translate('BiblesPlugin.ZefaniaImport',
+ 'Incorrect Bible file type supplied. Zefania Bibles may be '
+ 'compressed. You must decompress them before import.'))
+ log.exception(str(e))
+ success = False
+ finally:
+ if import_file:
+ import_file.close()
+ if self.stop_import_flag:
+ return False
+ else:
+ return success
diff --git a/openlp/plugins/custom/forms/editcustomdialog.py b/openlp/plugins/custom/forms/editcustomdialog.py
index 22a33d921..5ed92f95e 100644
--- a/openlp/plugins/custom/forms/editcustomdialog.py
+++ b/openlp/plugins/custom/forms/editcustomdialog.py
@@ -41,8 +41,8 @@ class Ui_CustomEditDialog(object):
:param custom_edit_dialog: The Dialog
"""
custom_edit_dialog.setObjectName('custom_edit_dialog')
+ custom_edit_dialog.setWindowIcon(build_icon(u':/icon/openlp-logo.svg'))
custom_edit_dialog.resize(450, 350)
- custom_edit_dialog.setWindowIcon(build_icon(':/icon/openlp-logo-16x16.png'))
self.dialog_layout = QtGui.QVBoxLayout(custom_edit_dialog)
self.dialog_layout.setObjectName('dialog_layout')
self.title_layout = QtGui.QHBoxLayout()
diff --git a/openlp/plugins/custom/forms/editcustomform.py b/openlp/plugins/custom/forms/editcustomform.py
index 010f7d1bc..9c7a080aa 100644
--- a/openlp/plugins/custom/forms/editcustomform.py
+++ b/openlp/plugins/custom/forms/editcustomform.py
@@ -197,7 +197,6 @@ class EditCustomForm(QtGui.QDialog, Ui_CustomEditDialog):
self.slide_list_view.clear()
self.slide_list_view.addItems(slides)
else:
- old_slides = []
old_row = self.slide_list_view.currentRow()
# Create a list with all (old/unedited) slides.
old_slides = [self.slide_list_view.item(row).text() for row in range(self.slide_list_view.count())]
diff --git a/openlp/plugins/custom/forms/editcustomslidedialog.py b/openlp/plugins/custom/forms/editcustomslidedialog.py
index 3b74566fc..c59cc4cd1 100644
--- a/openlp/plugins/custom/forms/editcustomslidedialog.py
+++ b/openlp/plugins/custom/forms/editcustomslidedialog.py
@@ -30,13 +30,14 @@
from PyQt4 import QtGui
from openlp.core.common import UiStrings, translate
-from openlp.core.lib import SpellTextEdit
+from openlp.core.lib import SpellTextEdit, build_icon
from openlp.core.lib.ui import create_button, create_button_box
class Ui_CustomSlideEditDialog(object):
def setupUi(self, custom_slide_edit_dialog):
custom_slide_edit_dialog.setObjectName('custom_slide_edit_dialog')
+ custom_slide_edit_dialog.setWindowIcon(build_icon(u':/icon/openlp-logo.svg'))
custom_slide_edit_dialog.resize(350, 300)
self.dialog_layout = QtGui.QVBoxLayout(custom_slide_edit_dialog)
self.slide_text_edit = SpellTextEdit(self)
diff --git a/openlp/plugins/images/forms/__init__.py b/openlp/plugins/images/forms/__init__.py
index d4468d1bc..6de223d59 100644
--- a/openlp/plugins/images/forms/__init__.py
+++ b/openlp/plugins/images/forms/__init__.py
@@ -32,7 +32,7 @@ other class holds all the functional code, like slots and loading and saving.
The first class, commonly known as the **Dialog** class, is typically named ``Ui_Dialog``. It is a slightly
modified version of the class that the ``pyuic4`` command produces from Qt4's .ui file. Typical modifications will be
-converting most strings from "" to u'' and using OpenLP's ``translate()`` function for translating strings.
+converting most strings from "" to '' and using OpenLP's ``translate()`` function for translating strings.
The second class, commonly known as the **Form** class, is typically named ``Form``. This class is the one which
is instantiated and used. It uses dual inheritance to inherit from (usually) QtGui.QDialog and the Ui class mentioned
diff --git a/openlp/plugins/images/lib/db.py b/openlp/plugins/images/lib/db.py
index 68ca3d11d..896f93b17 100644
--- a/openlp/plugins/images/lib/db.py
+++ b/openlp/plugins/images/lib/db.py
@@ -31,7 +31,7 @@ The :mod:`db` module provides the database and schema that is the backend for th
"""
from sqlalchemy import Column, ForeignKey, Table, types
-from sqlalchemy.orm import mapper, relation, reconstructor
+from sqlalchemy.orm import mapper
from openlp.core.lib.db import BaseModel, init_db
diff --git a/openlp/plugins/images/lib/mediaitem.py b/openlp/plugins/images/lib/mediaitem.py
index c28f1e834..36df55dac 100644
--- a/openlp/plugins/images/lib/mediaitem.py
+++ b/openlp/plugins/images/lib/mediaitem.py
@@ -353,7 +353,7 @@ class ImageMediaItem(MediaManagerItem):
icon = build_icon(thumb)
else:
icon = create_thumb(imageFile.filename, thumb)
- item_name = QtGui.QTreeWidgetItem(filename)
+ item_name = QtGui.QTreeWidgetItem([filename])
item_name.setText(0, filename)
item_name.setIcon(0, icon)
item_name.setToolTip(0, imageFile.filename)
diff --git a/openlp/plugins/media/lib/mediaitem.py b/openlp/plugins/media/lib/mediaitem.py
index 87d8e3311..0780b175d 100644
--- a/openlp/plugins/media/lib/mediaitem.py
+++ b/openlp/plugins/media/lib/mediaitem.py
@@ -229,7 +229,7 @@ class MediaMediaItem(MediaManagerItem, RegistryProperties):
self.service_path = os.path.join(AppLocation.get_section_data_path(self.settings_section), 'thumbnails')
check_directory_exists(self.service_path)
self.load_list(Settings().value(self.settings_section + '/media files'))
- self.populate_display_types()
+ self.rebuild_players()
def rebuild_players(self):
"""
@@ -314,7 +314,6 @@ class MediaMediaItem(MediaManagerItem, RegistryProperties):
def get_list(self, type=MediaType.Audio):
media = Settings().value(self.settings_section + '/media files')
media.sort(key=lambda filename: get_locale_key(os.path.split(str(filename))[1]))
- extension = []
if type == MediaType.Audio:
extension = self.media_controller.audio_extensions_list
else:
diff --git a/openlp/plugins/presentations/lib/pdfcontroller.py b/openlp/plugins/presentations/lib/pdfcontroller.py
index 5ed11d2ab..b98ae131a 100644
--- a/openlp/plugins/presentations/lib/pdfcontroller.py
+++ b/openlp/plugins/presentations/lib/pdfcontroller.py
@@ -126,8 +126,8 @@ class PdfController(PresentationController):
if os.name == 'nt':
# for windows we only accept mudraw.exe in the base folder
application_path = AppLocation.get_directory(AppLocation.AppDir)
- if os.path.isfile(application_path + '/../mudraw.exe'):
- self.mudrawbin = application_path + '/../mudraw.exe'
+ if os.path.isfile(os.path.join(application_path, 'mudraw.exe')):
+ self.mudrawbin = os.path.join(application_path, 'mudraw.exe')
else:
DEVNULL = open(os.devnull, 'wb')
# First try to find mupdf
@@ -145,8 +145,8 @@ class PdfController(PresentationController):
# Last option: check if mudraw is placed in OpenLP base folder
if not self.mudrawbin and not self.gsbin:
application_path = AppLocation.get_directory(AppLocation.AppDir)
- if os.path.isfile(application_path + '/../mudraw'):
- self.mudrawbin = application_path + '/../mudraw'
+ if os.path.isfile(os.path.join(application_path, 'mudraw')):
+ self.mudrawbin = os.path.join(application_path, 'mudraw')
if self.mudrawbin:
self.also_supports = ['xps']
return True
diff --git a/openlp/plugins/presentations/lib/powerpointcontroller.py b/openlp/plugins/presentations/lib/powerpointcontroller.py
index 4dd0f4c28..bfb775a25 100644
--- a/openlp/plugins/presentations/lib/powerpointcontroller.py
+++ b/openlp/plugins/presentations/lib/powerpointcontroller.py
@@ -43,6 +43,8 @@ if os.name == 'nt':
from openlp.core.lib import ScreenList
from openlp.core.common import Registry
+from openlp.core.lib.ui import UiStrings, critical_error_message_box, translate
+from openlp.core.common import trace_error_handler
from .presentationcontroller import PresentationController, PresentationDocument
log = logging.getLogger(__name__)
@@ -103,7 +105,7 @@ class PowerpointController(PresentationController):
if self.process.Presentations.Count > 0:
return
self.process.Quit()
- except pywintypes.com_error:
+ except (AttributeError, pywintypes.com_error):
pass
self.process = None
@@ -130,12 +132,23 @@ class PowerpointDocument(PresentationDocument):
earlier.
"""
log.debug('load_presentation')
- if not self.controller.process or not self.controller.process.Visible:
- self.controller.start_process()
try:
+ if not self.controller.process or not self.controller.process.Visible:
+ self.controller.start_process()
self.controller.process.Presentations.Open(self.file_path, False, False, True)
+ self.presentation = self.controller.process.Presentations(self.controller.process.Presentations.Count)
+ self.create_thumbnails()
+ # Powerpoint 2013 pops up when loading a file, so we minimize it again
+ if self.presentation.Application.Version == u'15.0':
+ try:
+ self.presentation.Application.WindowState = 2
+ except:
+ log.error('Failed to minimize main powerpoint window')
+ trace_error_handler(log)
+ return True
except pywintypes.com_error:
- log.debug('PPT open failed')
+ log.error('PPT open failed')
+ trace_error_handler(log)
return False
self.presentation = self.controller.process.Presentations(self.controller.process.Presentations.Count)
self.create_thumbnails()
@@ -211,23 +224,33 @@ class PowerpointDocument(PresentationDocument):
Unblanks (restores) the presentation.
"""
log.debug('unblank_screen')
- self.presentation.SlideShowSettings.Run()
- self.presentation.SlideShowWindow.View.State = 1
- self.presentation.SlideShowWindow.Activate()
- if self.presentation.Application.Version == '14.0':
- # Unblanking is broken in PowerPoint 2010, need to redisplay
- slide = self.presentation.SlideShowWindow.View.CurrentShowPosition
- click = self.presentation.SlideShowWindow.View.GetClickIndex()
- self.presentation.SlideShowWindow.View.GotoSlide(slide)
- if click:
- self.presentation.SlideShowWindow.View.GotoClick(click)
+ try:
+ self.presentation.SlideShowSettings.Run()
+ self.presentation.SlideShowWindow.View.State = 1
+ self.presentation.SlideShowWindow.Activate()
+ if self.presentation.Application.Version == '14.0':
+ # Unblanking is broken in PowerPoint 2010, need to redisplay
+ slide = self.presentation.SlideShowWindow.View.CurrentShowPosition
+ click = self.presentation.SlideShowWindow.View.GetClickIndex()
+ self.presentation.SlideShowWindow.View.GotoSlide(slide)
+ if click:
+ self.presentation.SlideShowWindow.View.GotoClick(click)
+ except pywintypes.com_error:
+ log.error('COM error while in unblank_screen')
+ trace_error_handler(log)
+ self.show_error_msg()
def blank_screen(self):
"""
Blanks the screen.
"""
log.debug('blank_screen')
- self.presentation.SlideShowWindow.View.State = 3
+ try:
+ self.presentation.SlideShowWindow.View.State = 3
+ except pywintypes.com_error:
+ log.error('COM error while in blank_screen')
+ trace_error_handler(log)
+ self.show_error_msg()
def is_blank(self):
"""
@@ -235,7 +258,12 @@ class PowerpointDocument(PresentationDocument):
"""
log.debug('is_blank')
if self.is_active():
- return self.presentation.SlideShowWindow.View.State == 3
+ try:
+ return self.presentation.SlideShowWindow.View.State == 3
+ except pywintypes.com_error:
+ log.error('COM error while in is_blank')
+ trace_error_handler(log)
+ self.show_error_msg()
else:
return False
@@ -244,7 +272,12 @@ class PowerpointDocument(PresentationDocument):
Stops the current presentation and hides the output.
"""
log.debug('stop_presentation')
- self.presentation.SlideShowWindow.View.Exit()
+ try:
+ self.presentation.SlideShowWindow.View.Exit()
+ except pywintypes.com_error:
+ log.error('COM error while in stop_presentation')
+ trace_error_handler(log)
+ self.show_error_msg()
if os.name == 'nt':
def start_presentation(self):
@@ -264,24 +297,49 @@ class PowerpointDocument(PresentationDocument):
ppt_window = self.presentation.SlideShowSettings.Run()
if not ppt_window:
return
- ppt_window.Top = size.y() * 72 / dpi
- ppt_window.Height = size.height() * 72 / dpi
- ppt_window.Left = size.x() * 72 / dpi
- ppt_window.Width = size.width() * 72 / dpi
+ try:
+ ppt_window.Top = size.y() * 72 / dpi
+ ppt_window.Height = size.height() * 72 / dpi
+ ppt_window.Left = size.x() * 72 / dpi
+ ppt_window.Width = size.width() * 72 / dpi
+ except AttributeError as e:
+ log.error('AttributeError while in start_presentation')
+ log.error(e)
+ # Powerpoint 2013 pops up when starting a file, so we minimize it again
+ if self.presentation.Application.Version == u'15.0':
+ try:
+ self.presentation.Application.WindowState = 2
+ except:
+ log.error('Failed to minimize main powerpoint window')
+ trace_error_handler(log)
def get_slide_number(self):
"""
Returns the current slide number.
"""
log.debug('get_slide_number')
- return self.presentation.SlideShowWindow.View.CurrentShowPosition
+ ret = 0
+ try:
+ ret = self.presentation.SlideShowWindow.View.CurrentShowPosition
+ except pywintypes.com_error:
+ log.error('COM error while in get_slide_number')
+ trace_error_handler(log)
+ self.show_error_msg()
+ return ret
def get_slide_count(self):
"""
Returns total number of slides.
"""
log.debug('get_slide_count')
- return self.presentation.Slides.Count
+ ret = 0
+ try:
+ ret = self.presentation.Slides.Count
+ except pywintypes.com_error:
+ log.error('COM error while in get_slide_count')
+ trace_error_handler(log)
+ self.show_error_msg()
+ return ret
def goto_slide(self, slide_no):
"""
@@ -290,14 +348,25 @@ class PowerpointDocument(PresentationDocument):
:param slide_no: The slide the text is required for, starting at 1
"""
log.debug('goto_slide')
- self.presentation.SlideShowWindow.View.GotoSlide(slide_no)
+ try:
+ self.presentation.SlideShowWindow.View.GotoSlide(slide_no)
+ except pywintypes.com_error:
+ log.error('COM error while in goto_slide')
+ trace_error_handler(log)
+ self.show_error_msg()
def next_step(self):
"""
Triggers the next effect of slide on the running presentation.
"""
log.debug('next_step')
- self.presentation.SlideShowWindow.View.Next()
+ try:
+ self.presentation.SlideShowWindow.View.Next()
+ except pywintypes.com_error:
+ log.error('COM error while in next_step')
+ trace_error_handler(log)
+ self.show_error_msg()
+ return
if self.get_slide_number() > self.get_slide_count():
self.previous_step()
@@ -306,7 +375,12 @@ class PowerpointDocument(PresentationDocument):
Triggers the previous slide on the running presentation.
"""
log.debug('previous_step')
- self.presentation.SlideShowWindow.View.Previous()
+ try:
+ self.presentation.SlideShowWindow.View.Previous()
+ except pywintypes.com_error:
+ log.error('COM error while in previous_step')
+ trace_error_handler(log)
+ self.show_error_msg()
def get_slide_text(self, slide_no):
"""
@@ -347,6 +421,15 @@ class PowerpointDocument(PresentationDocument):
self.save_titles_and_notes(titles, notes)
return
+ def show_error_msg(self):
+ """
+ Stop presentation and display an error message.
+ """
+ self.stop_presentation()
+ critical_error_message_box(UiStrings().Error, translate('PresentationPlugin.PowerpointDocument',
+ 'An error occurred in the Powerpoint integration '
+ 'and the presentation will be stopped. '
+ 'Restart the presentation if you wish to present it.'))
def _get_text_from_shapes(shapes):
"""
@@ -362,26 +445,29 @@ def _get_text_from_shapes(shapes):
return text
if os.name == "nt":
- ppE = win32com.client.getevents("PowerPoint.Application")
+ try:
+ ppE = win32com.client.getevents("PowerPoint.Application")
+ class PowerpointEvents(ppE):
+ def OnSlideShowBegin(self, hwnd):
+ #print("SS Begin")
+ return
- class PowerpointEvents(ppE):
- def OnSlideShowBegin(self, hwnd):
- #print("SS Begin")
- return
+ def OnSlideShowEnd(self, pres):
+ #print("SS End")
+ return
- def OnSlideShowEnd(self, pres):
- #print("SS End")
- return
+ def OnSlideShowNextSlide(self, hwnd):
+ Registry().execute('slidecontroller_live_change', hwnd.View.CurrentShowPosition - 1)
+ #print('Slide change:',hwnd.View.CurrentShowPosition)
+ return
- def OnSlideShowNextSlide(self, hwnd):
- Registry().execute('slidecontroller_live_change', hwnd.View.CurrentShowPosition - 1)
- #print('Slide change:',hwnd.View.CurrentShowPosition)
- return
+ def OnSlideShowOnNext(self, hwnd):
+ #print("SS Advance")
+ return
- def OnSlideShowOnNext(self, hwnd):
- #print("SS Advance")
- return
-
- def OnSlideShowOnPrevious(self, hwnd):
- #print("SS GoBack")
- return
+ def OnSlideShowOnPrevious(self, hwnd):
+ #print("SS GoBack")
+ return
+ except pywintypes.com_error:
+ log.debug('COM error trying to get powerpoint events - powerpoint is probably not installed.')
+
diff --git a/openlp/plugins/presentations/lib/presentationcontroller.py b/openlp/plugins/presentations/lib/presentationcontroller.py
index bc08af8ec..1175679c8 100644
--- a/openlp/plugins/presentations/lib/presentationcontroller.py
+++ b/openlp/plugins/presentations/lib/presentationcontroller.py
@@ -397,7 +397,7 @@ class PresentationController(object):
class MyPresentationController(PresentationController):
def __init__(self, plugin):
PresentationController.__init(
- self, plugin, u'My Presenter App')
+ self, plugin, 'My Presenter App')
:param plugin: Defaults to *None*. The presentationplugin object
:param name: Name of the application, to appear in the application
diff --git a/openlp/plugins/remotes/lib/httprouter.py b/openlp/plugins/remotes/lib/httprouter.py
index 813ab4e20..489d4fc38 100644
--- a/openlp/plugins/remotes/lib/httprouter.py
+++ b/openlp/plugins/remotes/lib/httprouter.py
@@ -149,11 +149,11 @@ class HttpRouter(RegistryProperties):
"""
Initialise the router stack and any other variables.
"""
- authcode = "%s:%s" % (Settings().value('remotes/user id'), Settings().value('remotes/password'))
+ auth_code = "%s:%s" % (Settings().value('remotes/user id'), Settings().value('remotes/password'))
try:
- self.auth = base64.b64encode(authcode)
+ self.auth = base64.b64encode(auth_code)
except TypeError:
- self.auth = base64.b64encode(authcode.encode()).decode()
+ self.auth = base64.b64encode(auth_code.encode()).decode()
self.routes = [
('^/$', {'function': self.serve_file, 'secure': False}),
('^/(stage)$', {'function': self.serve_file, 'secure': False}),
@@ -378,7 +378,6 @@ class HttpRouter(RegistryProperties):
Examines the extension of the file and determines what the content_type should be, defaults to text/plain
Returns the extension and the content_type
"""
- content_type = 'text/plain'
ext = os.path.splitext(file_name)[1]
content_type = FILE_TYPES.get(ext, 'text/plain')
return ext, content_type
@@ -470,7 +469,7 @@ class HttpRouter(RegistryProperties):
if plugin.status == PluginStatus.Active:
try:
text = json.loads(self.request_data)['request']['text']
- except KeyError as ValueError:
+ except KeyError:
return self.do_http_error()
text = urllib.parse.unquote(text)
self.alerts_manager.emit(QtCore.SIGNAL('alerts_text'), [text])
@@ -484,6 +483,7 @@ class HttpRouter(RegistryProperties):
"""
Perform an action on the slide controller.
"""
+ log.debug("controller_text var = %s" % var)
current_item = self.live_controller.service_item
data = []
if current_item:
@@ -531,7 +531,7 @@ class HttpRouter(RegistryProperties):
if self.request_data:
try:
data = json.loads(self.request_data)['request']['id']
- except KeyError as ValueError:
+ except KeyError:
return self.do_http_error()
log.info(data)
# This slot expects an int within a list.
@@ -590,7 +590,7 @@ class HttpRouter(RegistryProperties):
"""
try:
text = json.loads(self.request_data)['request']['text']
- except KeyError as ValueError:
+ except KeyError:
return self.do_http_error()
text = urllib.parse.unquote(text)
plugin = self.plugin_manager.get_plugin_by_name(plugin_name)
@@ -606,12 +606,12 @@ class HttpRouter(RegistryProperties):
Go live on an item of type ``plugin``.
"""
try:
- id = json.loads(self.request_data)['request']['id']
- except KeyError as ValueError:
+ request_id = json.loads(self.request_data)['request']['id']
+ except KeyError:
return self.do_http_error()
plugin = self.plugin_manager.get_plugin_by_name(plugin_name)
if plugin.status == PluginStatus.Active and plugin.media_item:
- plugin.media_item.emit(QtCore.SIGNAL('%s_go_live' % plugin_name), [id, True])
+ plugin.media_item.emit(QtCore.SIGNAL('%s_go_live' % plugin_name), [request_id, True])
return self.do_http_success()
def add_to_service(self, plugin_name):
@@ -619,12 +619,12 @@ class HttpRouter(RegistryProperties):
Add item of type ``plugin_name`` to the end of the service.
"""
try:
- id = json.loads(self.request_data)['request']['id']
- except KeyError as ValueError:
+ request_id = json.loads(self.request_data)['request']['id']
+ except KeyError:
return self.do_http_error()
plugin = self.plugin_manager.get_plugin_by_name(plugin_name)
if plugin.status == PluginStatus.Active and plugin.media_item:
- item_id = plugin.media_item.create_item_from_id(id)
+ item_id = plugin.media_item.create_item_from_id(request_id)
plugin.media_item.emit(QtCore.SIGNAL('%s_add_to_service' % plugin_name), [item_id, True])
self.do_http_success()
diff --git a/openlp/plugins/remotes/lib/httpserver.py b/openlp/plugins/remotes/lib/httpserver.py
index 22d0349f8..9a904090d 100644
--- a/openlp/plugins/remotes/lib/httpserver.py
+++ b/openlp/plugins/remotes/lib/httpserver.py
@@ -40,7 +40,7 @@ import time
from PyQt4 import QtCore
-from openlp.core.common import AppLocation, Settings
+from openlp.core.common import AppLocation, Settings, RegistryProperties
from openlp.plugins.remotes.lib import HttpRouter
@@ -94,13 +94,18 @@ class HttpThread(QtCore.QThread):
"""
self.http_server.start_server()
+ def stop(self):
+ log.debug("stop called")
+ self.http_server.stop = True
-class OpenLPServer():
+
+class OpenLPServer(RegistryProperties):
def __init__(self):
"""
Initialise the http server, and start the server of the correct type http / https
"""
- log.debug('Initialise httpserver')
+ super(OpenLPServer, self).__init__()
+ log.debug('Initialise OpenLP')
self.settings_section = 'remotes'
self.http_thread = HttpThread(self)
self.http_thread.start()
@@ -110,32 +115,49 @@ class OpenLPServer():
Start the correct server and save the handler
"""
address = Settings().value(self.settings_section + '/ip address')
- if Settings().value(self.settings_section + '/https enabled'):
+ self.address = address
+ self.is_secure = Settings().value(self.settings_section + '/https enabled')
+ self.needs_authentication = Settings().value(self.settings_section + '/authentication enabled')
+ if self.is_secure:
port = Settings().value(self.settings_section + '/https port')
- self.httpd = HTTPSServer((address, port), CustomHandler)
- log.debug('Started ssl httpd...')
+ self.port = port
+ self.start_server_instance(address, port, HTTPSServer)
else:
port = Settings().value(self.settings_section + '/port')
- loop = 1
- while loop < 3:
- try:
- self.httpd = ThreadingHTTPServer((address, port), CustomHandler)
- except OSError:
- loop += 1
- time.sleep(0.1)
- except:
- log.error('Failed to start server ')
- log.debug('Started non ssl httpd...')
+ self.port = port
+ self.start_server_instance(address, port, ThreadingHTTPServer)
if hasattr(self, 'httpd') and self.httpd:
self.httpd.serve_forever()
else:
log.debug('Failed to start server')
+ def start_server_instance(self, address, port, server_class):
+ """
+ Start the server
+
+ :param address: The server address
+ :param port: The run port
+ :param server_class: the class to start
+ """
+ loop = 1
+ while loop < 4:
+ try:
+ self.httpd = server_class((address, port), CustomHandler)
+ log.debug("Server started for class %s %s %d" % (server_class, address, port))
+ except OSError:
+ log.debug("failed to start http server thread state %d %s" %
+ (loop, self.http_thread.isRunning()))
+ loop += 1
+ time.sleep(0.1)
+ except:
+ log.error('Failed to start server ')
+
def stop_server(self):
"""
Stop the server
"""
- self.http_thread.exit(0)
+ if self.http_thread.isRunning():
+ self.http_thread.stop()
self.httpd = None
log.debug('Stopped the server.')
diff --git a/openlp/plugins/remotes/lib/remotetab.py b/openlp/plugins/remotes/lib/remotetab.py
index d6b96cc1c..4db25cfc2 100644
--- a/openlp/plugins/remotes/lib/remotetab.py
+++ b/openlp/plugins/remotes/lib/remotetab.py
@@ -32,7 +32,7 @@ import os.path
from PyQt4 import QtCore, QtGui, QtNetwork
from openlp.core.common import AppLocation, Settings, translate
-from openlp.core.lib import SettingsTab
+from openlp.core.lib import SettingsTab, build_icon
ZERO_URL = '0.0.0.0'
@@ -234,6 +234,7 @@ class RemoteTab(SettingsTab):
"""
Load the configuration and update the server configuration if necessary
"""
+ self.is_secure = Settings().value(self.settings_section + '/https enabled')
self.port_spin_box.setValue(Settings().value(self.settings_section + '/port'))
self.https_port_spin_box.setValue(Settings().value(self.settings_section + '/https port'))
self.address_edit.setText(Settings().value(self.settings_section + '/ip address'))
@@ -263,9 +264,7 @@ class RemoteTab(SettingsTab):
Settings().value(self.settings_section + '/port') != self.port_spin_box.value() or \
Settings().value(self.settings_section + '/https port') != self.https_port_spin_box.value() or \
Settings().value(self.settings_section + '/https enabled') != \
- self.https_settings_group_box.isChecked() or \
- Settings().value(self.settings_section + '/authentication enabled') != \
- self.user_login_group_box.isChecked():
+ self.https_settings_group_box.isChecked():
self.settings_form.register_post_process('remotes_config_updated')
Settings().setValue(self.settings_section + '/port', self.port_spin_box.value())
Settings().setValue(self.settings_section + '/https port', self.https_port_spin_box.value())
@@ -275,6 +274,7 @@ class RemoteTab(SettingsTab):
Settings().setValue(self.settings_section + '/authentication enabled', self.user_login_group_box.isChecked())
Settings().setValue(self.settings_section + '/user id', self.user_id.text())
Settings().setValue(self.settings_section + '/password', self.password.text())
+ self.generate_icon()
def on_twelve_hour_check_box_changed(self, check_state):
"""
@@ -290,3 +290,25 @@ class RemoteTab(SettingsTab):
Invert the HTTP group box based on Https group settings
"""
self.http_settings_group_box.setEnabled(not self.https_settings_group_box.isChecked())
+
+ def generate_icon(self):
+ """
+ Generate icon for main window
+ """
+ self.remote_server_icon.hide()
+ icon = QtGui.QImage(':/remote/network_server.png')
+ icon = icon.scaled(80, 80, QtCore.Qt.KeepAspectRatio, QtCore.Qt.SmoothTransformation)
+ if self.is_secure:
+ overlay = QtGui.QImage(':/remote/network_ssl.png')
+ overlay = overlay.scaled(60, 60, QtCore.Qt.KeepAspectRatio, QtCore.Qt.SmoothTransformation)
+ painter = QtGui.QPainter(icon)
+ painter.drawImage(0, 0, overlay)
+ painter.end()
+ if Settings().value(self.settings_section + '/authentication enabled'):
+ overlay = QtGui.QImage(':/remote/network_auth.png')
+ overlay = overlay.scaled(60, 60, QtCore.Qt.KeepAspectRatio, QtCore.Qt.SmoothTransformation)
+ painter = QtGui.QPainter(icon)
+ painter.drawImage(20, 0, overlay)
+ painter.end()
+ self.remote_server_icon.setPixmap(QtGui.QPixmap.fromImage(icon))
+ self.remote_server_icon.show()
diff --git a/openlp/plugins/remotes/remoteplugin.py b/openlp/plugins/remotes/remoteplugin.py
index 913aa113b..038b3d269 100644
--- a/openlp/plugins/remotes/remoteplugin.py
+++ b/openlp/plugins/remotes/remoteplugin.py
@@ -28,7 +28,8 @@
###############################################################################
import logging
-import time
+
+from PyQt4 import QtGui
from openlp.core.lib import Plugin, StringContent, translate, build_icon
from openlp.core.common import Registry
@@ -72,6 +73,21 @@ class RemotesPlugin(Plugin):
self.websocketserver = WebSocketManager()
self.websocketserver.start()
Registry().register_function('websock_send', self.websocketserver.send)
+ if not hasattr(self, 'remote_server_icon'):
+ self.remote_server_icon = QtGui.QLabel(self.main_window.status_bar)
+ size_policy = QtGui.QSizePolicy(QtGui.QSizePolicy.Fixed, QtGui.QSizePolicy.Fixed)
+ size_policy.setHorizontalStretch(0)
+ size_policy.setVerticalStretch(0)
+ size_policy.setHeightForWidth(self.remote_server_icon.sizePolicy().hasHeightForWidth())
+ self.remote_server_icon.setSizePolicy(size_policy)
+ self.remote_server_icon.setFrameShadow(QtGui.QFrame.Plain)
+ self.remote_server_icon.setLineWidth(1)
+ self.remote_server_icon.setScaledContents(True)
+ self.remote_server_icon.setFixedSize(20, 20)
+ self.remote_server_icon.setObjectName('remote_server_icon')
+ self.main_window.status_bar.insertPermanentWidget(2, self.remote_server_icon)
+ self.settings_tab.remote_server_icon = self.remote_server_icon
+ self.settings_tab.generate_icon()
def finalise(self):
"""
@@ -112,9 +128,11 @@ class RemotesPlugin(Plugin):
def config_update(self):
"""
- Called when Config is changed to restart the server on new address or port
+ Called when Config is changed to requests a restart with the server on new address or port
"""
log.debug('remote config changed')
- self.finalise()
- time.sleep(0.5)
- self.initialise()
+ QtGui.QMessageBox.information(self.main_window,
+ translate('RemotePlugin', 'Server Config Change'),
+ translate('RemotePlugin', 'Server configuration changes will require a restart '
+ 'to take effect.'),
+ QtGui.QMessageBox.StandardButtons(QtGui.QMessageBox.Ok))
diff --git a/openlp/plugins/songs/forms/__init__.py b/openlp/plugins/songs/forms/__init__.py
index 3094a0eda..eb29c12bf 100644
--- a/openlp/plugins/songs/forms/__init__.py
+++ b/openlp/plugins/songs/forms/__init__.py
@@ -34,7 +34,7 @@ code, like slots and loading and saving.
The first class, commonly known as the **Dialog** class, is typically named
``Ui_Dialog``. It is a slightly modified version of the class that the
``pyuic4`` command produces from Qt4's .ui file. Typical modifications will be
-converting most strings from "" to u'' and using OpenLP's ``translate()``
+converting most strings from "" to '' and using OpenLP's ``translate()``
function for translating strings.
The second class, commonly known as the **Form** class, is typically named
diff --git a/openlp/plugins/songs/forms/authorsdialog.py b/openlp/plugins/songs/forms/authorsdialog.py
index 65fb169b0..7bca76ca6 100644
--- a/openlp/plugins/songs/forms/authorsdialog.py
+++ b/openlp/plugins/songs/forms/authorsdialog.py
@@ -43,8 +43,8 @@ class Ui_AuthorsDialog(object):
Set up the UI for the dialog.
"""
authors_dialog.setObjectName('authors_dialog')
+ authors_dialog.setWindowIcon(build_icon(u':/icon/openlp-logo.svg'))
authors_dialog.resize(300, 10)
- authors_dialog.setWindowIcon(build_icon(':/icon/openlp-logo-16x16.png'))
authors_dialog.setModal(True)
self.dialog_layout = QtGui.QVBoxLayout(authors_dialog)
self.dialog_layout.setObjectName('dialog_layout')
diff --git a/openlp/plugins/songs/forms/duplicatesongremovalform.py b/openlp/plugins/songs/forms/duplicatesongremovalform.py
index c99dee4a7..c411c8c1c 100644
--- a/openlp/plugins/songs/forms/duplicatesongremovalform.py
+++ b/openlp/plugins/songs/forms/duplicatesongremovalform.py
@@ -264,7 +264,7 @@ class DuplicateSongRemovalForm(OpenLPWizard, RegistryProperties):
self.break_search = True
self.plugin.media_item.on_search_text_button_clicked()
- def setDefaults(self):
+ def set_defaults(self):
"""
Set default form values for the song import wizard.
"""
diff --git a/openlp/plugins/songs/forms/editsongdialog.py b/openlp/plugins/songs/forms/editsongdialog.py
index f2ef5af06..a9ca71946 100644
--- a/openlp/plugins/songs/forms/editsongdialog.py
+++ b/openlp/plugins/songs/forms/editsongdialog.py
@@ -43,8 +43,8 @@ class Ui_EditSongDialog(object):
"""
def setupUi(self, edit_song_dialog):
edit_song_dialog.setObjectName('edit_song_dialog')
+ edit_song_dialog.setWindowIcon(build_icon(u':/icon/openlp-logo.svg'))
edit_song_dialog.resize(650, 400)
- edit_song_dialog.setWindowIcon(build_icon(':/icon/openlp-logo-16x16.png'))
edit_song_dialog.setModal(True)
self.dialog_layout = QtGui.QVBoxLayout(edit_song_dialog)
self.dialog_layout.setSpacing(8)
@@ -118,13 +118,18 @@ class Ui_EditSongDialog(object):
self.authors_group_box.setObjectName('authors_group_box')
self.authors_layout = QtGui.QVBoxLayout(self.authors_group_box)
self.authors_layout.setObjectName('authors_layout')
- self.author_add_layout = QtGui.QHBoxLayout()
+ self.author_add_layout = QtGui.QVBoxLayout()
self.author_add_layout.setObjectName('author_add_layout')
+ self.author_type_layout = QtGui.QHBoxLayout()
+ self.author_type_layout.setObjectName('author_type_layout')
self.authors_combo_box = create_combo_box(self.authors_group_box, 'authors_combo_box')
self.author_add_layout.addWidget(self.authors_combo_box)
+ self.author_types_combo_box = create_combo_box(self.authors_group_box, 'author_types_combo_box', editable=False)
+ self.author_type_layout.addWidget(self.author_types_combo_box)
self.author_add_button = QtGui.QPushButton(self.authors_group_box)
self.author_add_button.setObjectName('author_add_button')
- self.author_add_layout.addWidget(self.author_add_button)
+ self.author_type_layout.addWidget(self.author_add_button)
+ self.author_add_layout.addLayout(self.author_type_layout)
self.authors_layout.addLayout(self.author_add_layout)
self.authors_list_view = QtGui.QListWidget(self.authors_group_box)
self.authors_list_view.setAlternatingRowColors(True)
@@ -330,7 +335,7 @@ class Ui_EditSongDialog(object):
translate('SongsPlugin.EditSongForm', 'Warning: You have not entered a verse order.')
-def create_combo_box(parent, name):
+def create_combo_box(parent, name, editable=True):
"""
Utility method to generate a standard combo box for this dialog.
@@ -340,7 +345,7 @@ def create_combo_box(parent, name):
combo_box = QtGui.QComboBox(parent)
combo_box.setSizeAdjustPolicy(QtGui.QComboBox.AdjustToMinimumContentsLength)
combo_box.setSizePolicy(QtGui.QSizePolicy.Expanding, QtGui.QSizePolicy.Fixed)
- combo_box.setEditable(True)
+ combo_box.setEditable(editable)
combo_box.setInsertPolicy(QtGui.QComboBox.NoInsert)
combo_box.setObjectName(name)
return combo_box
diff --git a/openlp/plugins/songs/forms/editsongform.py b/openlp/plugins/songs/forms/editsongform.py
index 60c6eae78..6b5ccb041 100644
--- a/openlp/plugins/songs/forms/editsongform.py
+++ b/openlp/plugins/songs/forms/editsongform.py
@@ -42,9 +42,9 @@ from openlp.core.common import Registry, RegistryProperties, AppLocation, UiStri
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.plugins.songs.lib import VerseType, clean_song
-from openlp.plugins.songs.lib.db import Book, Song, Author, Topic, MediaFile
+from openlp.plugins.songs.lib.db import Book, Song, Author, AuthorType, Topic, MediaFile
from openlp.plugins.songs.lib.ui import SongStrings
-from openlp.plugins.songs.lib.xml import SongXML
+from openlp.plugins.songs.lib.openlyricsxml import SongXML
from openlp.plugins.songs.forms.editsongdialog import Ui_EditSongDialog
from openlp.plugins.songs.forms.editverseform import EditVerseForm
from openlp.plugins.songs.forms.mediafilesform import MediaFilesForm
@@ -107,6 +107,7 @@ class EditSongForm(QtGui.QDialog, Ui_EditSongDialog, RegistryProperties):
self.audio_list_widget.setAlternatingRowColors(True)
self.find_verse_split = re.compile('---\[\]---\n', re.UNICODE)
self.whitespace = re.compile(r'\W+', re.UNICODE)
+ self.find_tags = re.compile(u'\{/?\w+\}', re.UNICODE)
def _load_objects(self, cls, combo, cache):
"""
@@ -122,12 +123,12 @@ class EditSongForm(QtGui.QDialog, Ui_EditSongDialog, RegistryProperties):
combo.setItemData(row, obj.id)
set_case_insensitive_completer(cache, combo)
- def _add_author_to_list(self, author):
+ def _add_author_to_list(self, author, author_type):
"""
Add an author to the author list.
"""
- author_item = QtGui.QListWidgetItem(str(author.display_name))
- author_item.setData(QtCore.Qt.UserRole, author.id)
+ author_item = QtGui.QListWidgetItem(author.get_display_name(author_type))
+ author_item.setData(QtCore.Qt.UserRole, (author.id, author_type))
self.authors_list_view.addItem(author_item)
def _extract_verse_order(self, verse_order):
@@ -217,8 +218,8 @@ class EditSongForm(QtGui.QDialog, Ui_EditSongDialog, RegistryProperties):
if self.authors_list_view.count() == 0:
self.song_tab_widget.setCurrentIndex(1)
self.authors_list_view.setFocus()
- critical_error_message_box(
- message=translate('SongsPlugin.EditSongForm', 'You need to have an author for this song.'))
+ critical_error_message_box(message=translate('SongsPlugin.EditSongForm',
+ 'You need to have an author for this song.'))
return False
if self.verse_order_edit.text():
result = self._validate_verse_list(self.verse_order_edit.text(), self.verse_list_widget.rowCount())
@@ -234,8 +235,57 @@ class EditSongForm(QtGui.QDialog, Ui_EditSongDialog, RegistryProperties):
self.manager.save_object(book)
else:
return False
+ # Validate tags (lp#1199639)
+ misplaced_tags = []
+ verse_tags = []
+ for i in range(self.verse_list_widget.rowCount()):
+ item = self.verse_list_widget.item(i, 0)
+ tags = self.find_tags.findall(item.text())
+ field = item.data(QtCore.Qt.UserRole)
+ verse_tags.append(field)
+ if not self._validate_tags(tags):
+ misplaced_tags.append('%s %s' % (VerseType.translated_name(field[0]), field[1:]))
+ if misplaced_tags:
+ critical_error_message_box(
+ message=translate('SongsPlugin.EditSongForm',
+ 'There are misplaced formatting tags in the following verses:\n\n%s\n\n'
+ 'Please correct these tags before continuing.' % ', '.join(misplaced_tags)))
+ return False
+ for tag in verse_tags:
+ if verse_tags.count(tag) > 26:
+ # lp#1310523: OpenLyrics allows only a-z variants of one verse:
+ # http://openlyrics.info/dataformat.html#verse-name
+ critical_error_message_box(message=translate(
+ 'SongsPlugin.EditSongForm', 'You have %(count)s verses named %(name)s %(number)s. '
+ 'You can have at most 26 verses with the same name' %
+ {'count': verse_tags.count(tag),
+ 'name': VerseType.translated_name(tag[0]),
+ 'number': tag[1:]}))
+ return False
return True
+ def _validate_tags(self, tags):
+ """
+ Validates a list of tags
+ Deletes the first affiliated tag pair which is located side by side in the list
+ and call itself recursively with the shortened tag list.
+ If there is any misplaced tag in the list, either the length of the tag list is not even,
+ or the function won't find any tag pairs side by side.
+ If there is no misplaced tag, the length of the list will be zero on any recursive run.
+
+ :param tags: A list of tags
+ :return: True if the function can't find any mismatched tags. Else False.
+ """
+ if len(tags) == 0:
+ return True
+ if len(tags) % 2 != 0:
+ return False
+ for i in range(len(tags)-1):
+ if tags[i+1] == "{/" + tags[i][1:]:
+ del tags[i:i+2]
+ return self._validate_tags(tags)
+ return False
+
def _process_lyrics(self):
"""
Process the lyric data entered by the user into the OpenLP XML format.
@@ -302,6 +352,15 @@ class EditSongForm(QtGui.QDialog, Ui_EditSongDialog, RegistryProperties):
self.authors.append(author.display_name)
set_case_insensitive_completer(self.authors, self.authors_combo_box)
+ # Types
+ self.author_types_combo_box.clear()
+ self.author_types_combo_box.addItem('')
+ # Don't iterate over the dictionary to give them this specific order
+ self.author_types_combo_box.addItem(AuthorType.Types[AuthorType.Words], AuthorType.Words)
+ self.author_types_combo_box.addItem(AuthorType.Types[AuthorType.Music], AuthorType.Music)
+ self.author_types_combo_box.addItem(AuthorType.Types[AuthorType.WordsAndMusic], AuthorType.WordsAndMusic)
+ self.author_types_combo_box.addItem(AuthorType.Types[AuthorType.Translation], AuthorType.Translation)
+
def load_topics(self):
"""
Load the topics into the combobox.
@@ -454,10 +513,8 @@ class EditSongForm(QtGui.QDialog, Ui_EditSongDialog, RegistryProperties):
self.tag_rows()
# clear the results
self.authors_list_view.clear()
- for author in self.song.authors:
- author_name = QtGui.QListWidgetItem(str(author.display_name))
- author_name.setData(QtCore.Qt.UserRole, author.id)
- self.authors_list_view.addItem(author_name)
+ for author_song in self.song.authors_songs:
+ self._add_author_to_list(author_song.author, author_song.author_type)
# clear the results
self.topics_list_view.clear()
for topic in self.song.topics:
@@ -496,6 +553,7 @@ class EditSongForm(QtGui.QDialog, Ui_EditSongDialog, RegistryProperties):
"""
item = int(self.authors_combo_box.currentIndex())
text = self.authors_combo_box.currentText().strip(' \r\n\t')
+ author_type = self.author_types_combo_box.itemData(self.author_types_combo_box.currentIndex())
# This if statement is for OS X, which doesn't seem to work well with
# the QCompleter auto-completion class. See bug #812628.
if text in self.authors:
@@ -513,7 +571,7 @@ class EditSongForm(QtGui.QDialog, Ui_EditSongDialog, RegistryProperties):
author = Author.populate(first_name=text.rsplit(' ', 1)[0], last_name=text.rsplit(' ', 1)[1],
display_name=text)
self.manager.save_object(author)
- self._add_author_to_list(author)
+ self._add_author_to_list(author, author_type)
self.load_authors()
self.authors_combo_box.setCurrentIndex(0)
else:
@@ -521,11 +579,11 @@ class EditSongForm(QtGui.QDialog, Ui_EditSongDialog, RegistryProperties):
elif item > 0:
item_id = (self.authors_combo_box.itemData(item))
author = self.manager.get_object(Author, item_id)
- if self.authors_list_view.findItems(str(author.display_name), QtCore.Qt.MatchExactly):
+ if self.authors_list_view.findItems(author.get_display_name(author_type), QtCore.Qt.MatchExactly):
critical_error_message_box(
message=translate('SongsPlugin.EditSongForm', 'This author is already in the list.'))
else:
- self._add_author_to_list(author)
+ self._add_author_to_list(author, author_type)
self.authors_combo_box.setCurrentIndex(0)
else:
QtGui.QMessageBox.warning(
@@ -905,13 +963,11 @@ class EditSongForm(QtGui.QDialog, Ui_EditSongDialog, RegistryProperties):
else:
self.song.theme_name = None
self._process_lyrics()
- self.song.authors = []
+ self.song.authors_songs = []
for row in range(self.authors_list_view.count()):
item = self.authors_list_view.item(row)
- author_id = (item.data(QtCore.Qt.UserRole))
- author = self.manager.get_object(Author, author_id)
- if author is not None:
- self.song.authors.append(author)
+ self.song.add_author(self.manager.get_object(Author, item.data(QtCore.Qt.UserRole)[0]),
+ item.data(QtCore.Qt.UserRole)[1])
self.song.topics = []
for row in range(self.topics_list_view.count()):
item = self.topics_list_view.item(row)
diff --git a/openlp/plugins/songs/forms/editversedialog.py b/openlp/plugins/songs/forms/editversedialog.py
index f1901b203..1dc3d9182 100644
--- a/openlp/plugins/songs/forms/editversedialog.py
+++ b/openlp/plugins/songs/forms/editversedialog.py
@@ -37,6 +37,7 @@ from openlp.plugins.songs.lib import VerseType
class Ui_EditVerseDialog(object):
def setupUi(self, edit_verse_dialog):
edit_verse_dialog.setObjectName('edit_verse_dialog')
+ edit_verse_dialog.setWindowIcon(build_icon(u':/icon/openlp-logo.svg'))
edit_verse_dialog.resize(400, 400)
edit_verse_dialog.setModal(True)
self.dialog_layout = QtGui.QVBoxLayout(edit_verse_dialog)
diff --git a/openlp/plugins/songs/forms/editverseform.py b/openlp/plugins/songs/forms/editverseform.py
index 79a69a015..bc2532b0d 100644
--- a/openlp/plugins/songs/forms/editverseform.py
+++ b/openlp/plugins/songs/forms/editverseform.py
@@ -122,8 +122,6 @@ class EditVerseForm(QtGui.QDialog, Ui_EditVerseDialog):
text = text[:position + 4]
match = VERSE_REGEX.match(text)
if match:
- # TODO: Not used, remove?
- # verse_tag = match.group(1)
try:
verse_num = int(match.group(2)) + 1
except ValueError:
diff --git a/openlp/plugins/songs/forms/mediafilesdialog.py b/openlp/plugins/songs/forms/mediafilesdialog.py
index 3a1db39ed..495e08883 100644
--- a/openlp/plugins/songs/forms/mediafilesdialog.py
+++ b/openlp/plugins/songs/forms/mediafilesdialog.py
@@ -42,10 +42,10 @@ class Ui_MediaFilesDialog(object):
Set up the user interface.
"""
media_files_dialog.setObjectName('media_files_dialog')
+ media_files_dialog.setWindowIcon(build_icon(u':/icon/openlp-logo.svg'))
media_files_dialog.setWindowModality(QtCore.Qt.ApplicationModal)
media_files_dialog.resize(400, 300)
media_files_dialog.setModal(True)
- media_files_dialog.setWindowIcon(build_icon(':/icon/openlp-logo-16x16.png'))
self.files_vertical_layout = QtGui.QVBoxLayout(media_files_dialog)
self.files_vertical_layout.setSpacing(8)
self.files_vertical_layout.setMargin(8)
diff --git a/openlp/plugins/songs/forms/songbookdialog.py b/openlp/plugins/songs/forms/songbookdialog.py
index 8cacef1a2..1ed79a4eb 100644
--- a/openlp/plugins/songs/forms/songbookdialog.py
+++ b/openlp/plugins/songs/forms/songbookdialog.py
@@ -29,7 +29,7 @@
from PyQt4 import QtGui
-from openlp.core.lib import translate
+from openlp.core.lib import translate, build_icon
from openlp.core.lib.ui import create_button_box
@@ -42,6 +42,7 @@ class Ui_SongBookDialog(object):
Set up the user interface.
"""
song_book_dialog.setObjectName('song_book_dialog')
+ song_book_dialog.setWindowIcon(build_icon(u':/icon/openlp-logo.svg'))
song_book_dialog.resize(300, 10)
self.dialog_layout = QtGui.QVBoxLayout(song_book_dialog)
self.dialog_layout.setObjectName('dialog_layout')
diff --git a/openlp/plugins/songs/forms/songimportform.py b/openlp/plugins/songs/forms/songimportform.py
index 27f0d9343..2a05f06cd 100644
--- a/openlp/plugins/songs/forms/songimportform.py
+++ b/openlp/plugins/songs/forms/songimportform.py
@@ -231,11 +231,11 @@ class SongImportForm(OpenLPWizard, RegistryProperties):
"""
Opens a QFileDialog and writes the filenames to the given listbox.
- :param title: The title of the dialog (unicode).
+ :param title: The title of the dialog (str).
:param listbox: A listbox (QListWidget).
- :param filters: The file extension filters. It should contain the file descriptions
- as well as the file extensions. For example::
- u'SongBeamer Files (*.sng)'
+ :param filters: The file extension filters. It should contain the file descriptions as well as the file
+ extensions. For example::
+ 'SongBeamer Files (*.sng)'
"""
if filters:
filters += ';;'
@@ -304,7 +304,7 @@ class SongImportForm(OpenLPWizard, RegistryProperties):
"""
self.source_page.emit(QtCore.SIGNAL('completeChanged()'))
- def setDefaults(self):
+ def set_defaults(self):
"""
Set default form values for the song import wizard.
"""
diff --git a/openlp/plugins/songs/forms/songmaintenancedialog.py b/openlp/plugins/songs/forms/songmaintenancedialog.py
index 84e3535d3..893ae9c1c 100644
--- a/openlp/plugins/songs/forms/songmaintenancedialog.py
+++ b/openlp/plugins/songs/forms/songmaintenancedialog.py
@@ -44,6 +44,7 @@ class Ui_SongMaintenanceDialog(object):
Set up the user interface for the song maintenance dialog
"""
song_maintenance_dialog.setObjectName('song_maintenance_dialog')
+ song_maintenance_dialog.setWindowIcon(build_icon(u':/icon/openlp-logo.svg'))
song_maintenance_dialog.setWindowModality(QtCore.Qt.ApplicationModal)
song_maintenance_dialog.resize(10, 350)
self.dialog_layout = QtGui.QGridLayout(song_maintenance_dialog)
diff --git a/openlp/plugins/songs/forms/songmaintenanceform.py b/openlp/plugins/songs/forms/songmaintenanceform.py
index 4e9bdad93..bdbae41fb 100644
--- a/openlp/plugins/songs/forms/songmaintenanceform.py
+++ b/openlp/plugins/songs/forms/songmaintenanceform.py
@@ -400,7 +400,7 @@ class SongMaintenanceForm(QtGui.QDialog, Ui_SongMaintenanceDialog, RegistryPrope
"""
Merges two authors into one author.
- :param old_author: The object, which was edited, that will be deleted
+ :param old_author: The object, which was edited, that will be deleted
"""
# Find the duplicate.
existing_author = self.manager.get_object_filtered(
@@ -415,11 +415,9 @@ class SongMaintenanceForm(QtGui.QDialog, Ui_SongMaintenanceDialog, RegistryPrope
# Find the songs, which have the old_author as author.
songs = self.manager.get_all_objects(Song, Song.authors.contains(old_author))
for song in songs:
- # We check if the song has already existing_author as author. If
- # that is not the case we add it.
- if existing_author not in song.authors:
- song.authors.append(existing_author)
- song.authors.remove(old_author)
+ for author_song in song.authors_songs:
+ song.add_author(existing_author, author_song.author_type)
+ song.remove_author(old_author, author_song.author_type)
self.manager.save_object(song)
self.manager.delete_object(Author, old_author.id)
diff --git a/openlp/plugins/songs/forms/songreviewwidget.py b/openlp/plugins/songs/forms/songreviewwidget.py
index 02d7b8774..7f5f9c0c6 100644
--- a/openlp/plugins/songs/forms/songreviewwidget.py
+++ b/openlp/plugins/songs/forms/songreviewwidget.py
@@ -33,7 +33,7 @@ from PyQt4 import QtCore, QtGui
from openlp.core.lib import build_icon
from openlp.plugins.songs.lib import VerseType
-from openlp.plugins.songs.lib.xml import SongXML
+from openlp.plugins.songs.lib.openlyricsxml import SongXML
class SongReviewWidget(QtGui.QWidget):
diff --git a/openlp/plugins/songs/forms/songselectform.py b/openlp/plugins/songs/forms/songselectform.py
index d3ff5ab52..f9f658c5b 100755
--- a/openlp/plugins/songs/forms/songselectform.py
+++ b/openlp/plugins/songs/forms/songselectform.py
@@ -319,8 +319,6 @@ class SongSelectForm(QtGui.QDialog, Ui_SongSelectDialog):
def on_search_finished(self):
"""
Slot which is called when the search is completed.
-
- :param songs:
"""
self.application.process_events()
self.search_progress_bar.setVisible(False)
diff --git a/openlp/plugins/songs/forms/topicsdialog.py b/openlp/plugins/songs/forms/topicsdialog.py
index eb6229bf6..ffa7da333 100644
--- a/openlp/plugins/songs/forms/topicsdialog.py
+++ b/openlp/plugins/songs/forms/topicsdialog.py
@@ -29,7 +29,7 @@
from PyQt4 import QtGui
-from openlp.core.lib import translate
+from openlp.core.lib import translate, build_icon
from openlp.core.lib.ui import create_button_box
@@ -42,6 +42,7 @@ class Ui_TopicsDialog(object):
Set up the user interface for the topics dialog.
"""
topics_dialog.setObjectName('topics_dialog')
+ topics_dialog.setWindowIcon(build_icon(u':/icon/openlp-logo.svg'))
topics_dialog.resize(300, 10)
self.dialog_layout = QtGui.QVBoxLayout(topics_dialog)
self.dialog_layout.setObjectName('dialog_layout')
diff --git a/openlp/plugins/songs/lib/__init__.py b/openlp/plugins/songs/lib/__init__.py
index dc198d4b7..d03bdefd6 100644
--- a/openlp/plugins/songs/lib/__init__.py
+++ b/openlp/plugins/songs/lib/__init__.py
@@ -206,14 +206,14 @@ class VerseType(object):
Return the VerseType for a given tag
:param verse_tag: The string to return a VerseType for
- :param default: Default return value if no matching tag is found
+ :param default: Default return value if no matching tag is found (a valid VerseType or None)
:return: A VerseType of the tag
"""
verse_tag = verse_tag[0].lower()
for num, tag in enumerate(VerseType.tags):
if verse_tag == tag:
return num
- if len(VerseType.names) > default:
+ if default in range(0, len(VerseType.names)) or default is None:
return default
else:
return VerseType.Other
@@ -231,7 +231,7 @@ class VerseType(object):
for num, tag in enumerate(VerseType.translated_tags):
if verse_tag == tag:
return num
- if len(VerseType.names) > default:
+ if default in range(0, len(VerseType.names)) or default is None:
return default
else:
return VerseType.Other
@@ -278,7 +278,7 @@ class VerseType(object):
if verse_index is None:
verse_index = VerseType.from_string(verse_name, default)
elif len(verse_name) == 1:
- verse_index = VerseType.from_translated_tag(verse_name, None)
+ verse_index = VerseType.from_translated_tag(verse_name, default)
if verse_index is None:
verse_index = VerseType.from_tag(verse_name, default)
else:
@@ -390,12 +390,12 @@ def clean_song(manager, song):
verses = SongXML().get_verses(song.lyrics)
song.search_lyrics = ' '.join([clean_string(verse[1]) for verse in verses])
# The song does not have any author, add one.
- if not song.authors:
+ if not song.authors_songs:
name = SongStrings.AuthorUnknown
author = manager.get_object_filtered(Author, Author.display_name == name)
if author is None:
author = Author.populate(display_name=name, last_name='', first_name='')
- song.authors.append(author)
+ song.add_author(author)
if song.copyright:
song.copyright = CONTROL_CHARS.sub('', song.copyright).strip()
@@ -434,7 +434,7 @@ def strip_rtf(text, default_encoding=None):
# Current font is the font tag we last met.
font = ''
# Character encoding is defined inside fonttable.
- # font_table could contain eg u'0': u'cp1252'
+ # font_table could contain eg '0': u'cp1252'
font_table = {'': ''}
# Stack of things to keep track of when entering/leaving groups.
stack = []
diff --git a/openlp/plugins/songs/lib/db.py b/openlp/plugins/songs/lib/db.py
index c3965e2ed..16f7ea719 100644
--- a/openlp/plugins/songs/lib/db.py
+++ b/openlp/plugins/songs/lib/db.py
@@ -35,19 +35,53 @@ import re
from sqlalchemy import Column, ForeignKey, Table, types
from sqlalchemy.orm import mapper, relation, reconstructor
-from sqlalchemy.sql.expression import func
+from sqlalchemy.sql.expression import func, text
from openlp.core.lib.db import BaseModel, init_db
from openlp.core.utils import get_natural_key
+from openlp.core.lib import translate
class Author(BaseModel):
"""
Author model
"""
+ def get_display_name(self, author_type=None):
+ if author_type:
+ return "%s (%s)" % (self.display_name, AuthorType.Types[author_type])
+ return self.display_name
+
+
+class AuthorSong(BaseModel):
+ """
+ Relationship between Authors and Songs (many to many).
+ Need to define this relationship table explicit to get access to the
+ Association Object (author_type).
+ http://docs.sqlalchemy.org/en/latest/orm/relationships.html#association-object
+ """
pass
+class AuthorType(object):
+ """
+ Enumeration for Author types.
+ They are defined by OpenLyrics: http://openlyrics.info/dataformat.html#authors
+
+ The 'words+music' type is not an official type, but is provided for convenience.
+ """
+ Words = 'words'
+ Music = 'music'
+ WordsAndMusic = 'words+music'
+ Translation = 'translation'
+ Types = {
+ Words: translate('SongsPlugin.AuthorType', 'Words', 'Author who wrote the lyrics of a song'),
+ Music: translate('SongsPlugin.AuthorType', 'Music', 'Author who wrote the music of a song'),
+ WordsAndMusic: translate('SongsPlugin.AuthorType', 'Words and Music',
+ 'Author who wrote both lyrics and music of a song'),
+ Translation: translate('SongsPlugin.AuthorType', 'Translation', 'Author who translated the song')
+ }
+
+
class Book(BaseModel):
"""
Book model
@@ -67,6 +101,7 @@ class Song(BaseModel):
"""
Song model
"""
+
def __init__(self):
self.sort_key = []
@@ -80,6 +115,33 @@ class Song(BaseModel):
"""
self.sort_key = get_natural_key(self.title)
+ def add_author(self, author, author_type=None):
+ """
+ Add an author to the song if it not yet exists
+
+ :param author: Author object
+ :param author_type: AuthorType constant or None
+ """
+ for author_song in self.authors_songs:
+ if author_song.author == author and author_song.author_type == author_type:
+ return
+ new_author_song = AuthorSong()
+ new_author_song.author = author
+ new_author_song.author_type = author_type
+ self.authors_songs.append(new_author_song)
+
+ def remove_author(self, author, author_type=None):
+ """
+ Remove an existing author from the song
+
+ :param author: Author object
+ :param author_type: AuthorType constant or None
+ """
+ for author_song in self.authors_songs:
+ if author_song.author == author and author_song.author_type == author_type:
+ self.authors_songs.remove(author_song)
+ return
+
class Topic(BaseModel):
"""
@@ -120,6 +182,7 @@ def init_schema(url):
* author_id
* song_id
+ * author_type
**media_files Table**
* id
@@ -230,7 +293,8 @@ def init_schema(url):
authors_songs_table = Table(
'authors_songs', metadata,
Column('author_id', types.Integer(), ForeignKey('authors.id'), primary_key=True),
- Column('song_id', types.Integer(), ForeignKey('songs.id'), primary_key=True)
+ Column('song_id', types.Integer(), ForeignKey('songs.id'), primary_key=True),
+ Column('author_type', types.String(), primary_key=True, nullable=False, server_default=text('""'))
)
# Definition of the "songs_topics" table
@@ -241,10 +305,16 @@ def init_schema(url):
)
mapper(Author, authors_table)
+ mapper(AuthorSong, authors_songs_table, properties={
+ 'author': relation(Author)
+ })
mapper(Book, song_books_table)
mapper(MediaFile, media_files_table)
mapper(Song, songs_table, properties={
- 'authors': relation(Author, backref='songs', secondary=authors_songs_table, lazy=False),
+ # Use the authors_songs relation when you need access to the 'author_type' attribute
+ # or when creating new relations
+ 'authors_songs': relation(AuthorSong, cascade="all, delete-orphan"),
+ 'authors': relation(Author, secondary=authors_songs_table, viewonly=True),
'book': relation(Book, backref='songs'),
'media_files': relation(MediaFile, backref='songs', order_by=media_files_table.c.weight),
'topics': relation(Topic, backref='songs', secondary=songs_topics_table)
diff --git a/openlp/plugins/songs/lib/ewimport.py b/openlp/plugins/songs/lib/ewimport.py
deleted file mode 100644
index ca201279a..000000000
--- a/openlp/plugins/songs/lib/ewimport.py
+++ /dev/null
@@ -1,325 +0,0 @@
-# -*- coding: utf-8 -*-
-# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
-
-###############################################################################
-# OpenLP - Open Source Lyrics Projection #
-# --------------------------------------------------------------------------- #
-# Copyright (c) 2008-2014 Raoul Snyman #
-# Portions copyright (c) 2008-2014 Tim Bentley, Gerald Britton, Jonathan #
-# Corwin, Samuel Findlay, Michael Gorven, Scott Guerrieri, Matthias Hub, #
-# Meinert Jordan, Armin Köhler, Erik Lundin, Edwin Lunando, Brian T. Meyer. #
-# Joshua Miller, Stevan Pettit, Andreas Preikschat, Mattias Põldaru, #
-# Christian Richter, Philip Ridout, Simon Scudder, Jeffrey Smith, #
-# Maikel Stuivenberg, Martin Thompson, Jon Tibble, Dave Warnock, #
-# Frode Woldsund, Martin Zibricky, Patrick Zimmermann #
-# --------------------------------------------------------------------------- #
-# 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 #
-###############################################################################
-"""
-The :mod:`ewimport` module provides the functionality for importing
-EasyWorship song databases into the current installation database.
-"""
-
-import os
-import struct
-import re
-
-from openlp.core.lib import translate
-from openlp.plugins.songs.lib import VerseType
-from openlp.plugins.songs.lib import retrieve_windows_encoding, strip_rtf
-from .songimport import SongImport
-
-RTF_STRIPPING_REGEX = re.compile(r'\{\\tx[^}]*\}')
-# regex: at least two newlines, can have spaces between them
-SLIDE_BREAK_REGEX = re.compile(r'\n *?\n[\n ]*')
-NUMBER_REGEX = re.compile(r'[0-9]+')
-NOTE_REGEX = re.compile(r'\(.*?\)')
-
-
-class FieldDescEntry:
- def __init__(self, name, field_type, size):
- self.name = name
- self.field_type = field_type
- self.size = size
-
-
-class FieldType(object):
- """
- An enumeration class for different field types that can be expected in an EasyWorship song file.
- """
- String = 1
- Int16 = 3
- Int32 = 4
- Logical = 9
- Memo = 0x0c
- Blob = 0x0d
- Timestamp = 0x15
-
-
-class EasyWorshipSongImport(SongImport):
- """
- The :class:`EasyWorshipSongImport` class provides OpenLP with the
- ability to import EasyWorship song files.
- """
- def __init__(self, manager, **kwargs):
- super(EasyWorshipSongImport, self).__init__(manager, **kwargs)
-
- def do_import(self):
- """
- Import the songs
-
- :return:
- """
- # Open the DB and MB files if they exist
- import_source_mb = self.import_source.replace('.DB', '.MB')
- if not os.path.isfile(self.import_source) or not os.path.isfile(import_source_mb):
- return
- db_size = os.path.getsize(self.import_source)
- if db_size < 0x800:
- return
- db_file = open(self.import_source, 'rb')
- self.memo_file = open(import_source_mb, 'rb')
- # Don't accept files that are clearly not paradox files
- record_size, header_size, block_size, first_block, num_fields = struct.unpack(' 4:
- db_file.close()
- self.memo_file.close()
- return
- # Take a stab at how text is encoded
- self.encoding = 'cp1252'
- db_file.seek(106)
- code_page, = struct.unpack(' len(tag):
- match = NUMBER_REGEX.search(ew_tag)
- if match:
- number = match.group()
- verse_type += number
- number_found = True
- match = NOTE_REGEX.search(ew_tag)
- if match:
- self.comments += ew_tag + '\n'
- if not number_found:
- verse_type += '1'
- break
- self.add_verse(verse_split[-1].strip() if first_line_is_tag else verse, verse_type)
- if len(self.comments) > 5:
- self.comments += str(translate('SongsPlugin.EasyWorshipSongImport',
- '\n[above are Song Tags with notes imported from EasyWorship]'))
- if self.stop_import_flag:
- break
- if not self.finish():
- self.log_error(self.import_source)
- db_file.close()
- self.memo_file.close()
-
- def find_field(self, field_name):
- """
- Find a field in the descriptions
-
- :param field_name: field to find
- :return:
- """
- return [i for i, x in enumerate(self.field_descriptions) if x.name == field_name][0]
-
- def set_record_struct(self, field_descriptions):
- """
- Save the record structure
-
- :param field_descriptions: An array of field descriptions
- """
- # Begin with empty field struct list
- fsl = ['>']
- for field_desc in field_descriptions:
- if field_desc.field_type == FieldType.String:
- fsl.append('%ds' % field_desc.size)
- elif field_desc.field_type == FieldType.Int16:
- fsl.append('H')
- elif field_desc.field_type == FieldType.Int32:
- fsl.append('I')
- elif field_desc.field_type == FieldType.Logical:
- fsl.append('B')
- elif field_desc.field_type == FieldType.Memo:
- fsl.append('%ds' % field_desc.size)
- elif field_desc.field_type == FieldType.Blob:
- fsl.append('%ds' % field_desc.size)
- elif field_desc.field_type == FieldType.Timestamp:
- fsl.append('Q')
- else:
- fsl.append('%ds' % field_desc.size)
- self.record_structure = struct.Struct(''.join(fsl))
- self.field_descriptions = field_descriptions
-
- def get_field(self, field_desc_index):
- """
- Extract the field
-
- :param field_desc_index: Field index value
- :return:
- """
- field = self.fields[field_desc_index]
- field_desc = self.field_descriptions[field_desc_index]
- # Return None in case of 'blank' entries
- if isinstance(field, bytes):
- if not field.rstrip(b'\0'):
- return None
- elif field == 0:
- return None
- # Format the field depending on the field type
- if field_desc.field_type == FieldType.String:
- return field.rstrip(b'\0')
- elif field_desc.field_type == FieldType.Int16:
- return field ^ 0x8000
- elif field_desc.field_type == FieldType.Int32:
- return field ^ 0x80000000
- elif field_desc.field_type == FieldType.Logical:
- return field ^ 0x80 == 1
- elif field_desc.field_type == FieldType.Memo or field_desc.field_type == FieldType.Blob:
- block_start, blob_size = struct.unpack_from(' 63:
- return b''
- self.memo_file.seek(11 + (5 * sub_block), os.SEEK_CUR)
- sub_block_start, = struct.unpack('B', self.memo_file.read(1))
- self.memo_file.seek(block_start + (sub_block_start * 16))
- else:
- return b''
- return self.memo_file.read(blob_size)
- else:
- return 0
diff --git a/openlp/plugins/songs/lib/importer.py b/openlp/plugins/songs/lib/importer.py
index 662f73bf8..bb622bcf9 100644
--- a/openlp/plugins/songs/lib/importer.py
+++ b/openlp/plugins/songs/lib/importer.py
@@ -34,21 +34,23 @@ import logging
from openlp.core.common import translate, UiStrings
from openlp.core.ui.wizard import WizardStrings
-from .opensongimport import OpenSongImport
-from .easyslidesimport import EasySlidesImport
-from .olpimport import OpenLPSongImport
-from .openlyricsimport import OpenLyricsImport
-from .wowimport import WowImport
-from .cclifileimport import CCLIFileImport
-from .dreambeamimport import DreamBeamImport
-from .powersongimport import PowerSongImport
-from .ewimport import EasyWorshipSongImport
-from .songbeamerimport import SongBeamerImport
-from .songshowplusimport import SongShowPlusImport
-from .songproimport import SongProImport
-from .sundayplusimport import SundayPlusImport
-from .foilpresenterimport import FoilPresenterImport
-from .zionworximport import ZionWorxImport
+from .importers.opensong import OpenSongImport
+from .importers.easyslides import EasySlidesImport
+from .importers.openlp import OpenLPSongImport
+from .importers.openlyrics import OpenLyricsImport
+from .importers.wordsofworship import WordsOfWorshipImport
+from .importers.cclifile import CCLIFileImport
+from .importers.dreambeam import DreamBeamImport
+from .importers.powersong import PowerSongImport
+from .importers.easyworship import EasyWorshipSongImport
+from .importers.songbeamer import SongBeamerImport
+from .importers.songshowplus import SongShowPlusImport
+from .importers.songpro import SongProImport
+from .importers.sundayplus import SundayPlusImport
+from .importers.foilpresenter import FoilPresenterImport
+from .importers.zionworx import ZionWorxImport
+from .importers.propresenter import ProPresenterImport
+from .importers.worshipassistant import WorshipAssistantImport
# Imports that might fail
@@ -56,13 +58,13 @@ log = logging.getLogger(__name__)
try:
- from .sofimport import SofImport
+ from .importers.songsoffellowship import SongsOfFellowshipImport
HAS_SOF = True
except ImportError:
- log.exception('Error importing %s', 'SofImport')
+ log.exception('Error importing %s', 'SongsOfFellowshipImport')
HAS_SOF = False
try:
- from .oooimport import OooImport
+ from .importers.openoffice import OpenOfficeImport
HAS_OOO = True
except ImportError:
log.exception('Error importing %s', 'OooImport')
@@ -70,14 +72,14 @@ except ImportError:
HAS_MEDIASHOUT = False
if os.name == 'nt':
try:
- from .mediashoutimport import MediaShoutImport
+ from .importers.mediashout import MediaShoutImport
HAS_MEDIASHOUT = True
except ImportError:
log.exception('Error importing %s', 'MediaShoutImport')
HAS_WORSHIPCENTERPRO = False
if os.name == 'nt':
try:
- from .worshipcenterproimport import WorshipCenterProImport
+ from .importers.worshipcenterpro import WorshipCenterProImport
HAS_WORSHIPCENTERPRO = True
except ImportError:
log.exception('Error importing %s', 'WorshipCenterProImport')
@@ -107,7 +109,7 @@ class SongFormat(object):
Name of the format, e.g. ``'OpenLyrics'``
``'prefix'``
- Prefix for Qt objects. Use mixedCase, e.g. ``'open_lyrics'``
+ Prefix for Qt objects. Use mixedCase, e.g. ``'openLyrics'``
See ``SongImportForm.add_file_select_item()``
Optional attributes for each song format:
@@ -153,19 +155,22 @@ class SongFormat(object):
CCLI = 3
DreamBeam = 4
EasySlides = 5
- EasyWorship = 6
- FoilPresenter = 7
- MediaShout = 8
- OpenSong = 9
- PowerSong = 10
- SongBeamer = 11
- SongPro = 12
- SongShowPlus = 13
- SongsOfFellowship = 14
- SundayPlus = 15
- WordsOfWorship = 16
- WorshipCenterPro = 17
- ZionWorx = 18
+ EasyWorshipDB = 6
+ EasyWorshipService = 7
+ FoilPresenter = 8
+ MediaShout = 9
+ OpenSong = 10
+ PowerSong = 11
+ ProPresenter = 12
+ SongBeamer = 13
+ SongPro = 14
+ SongShowPlus = 15
+ SongsOfFellowship = 16
+ SundayPlus = 17
+ WordsOfWorship = 18
+ WorshipAssistant = 19
+ WorshipCenterPro = 20
+ ZionWorx = 21
# Set optional attribute defaults
__defaults__ = {
@@ -185,7 +190,7 @@ class SongFormat(object):
OpenLyrics: {
'class': OpenLyricsImport,
'name': 'OpenLyrics',
- 'prefix': 'open_lyrics',
+ 'prefix': 'openLyrics',
'filter': '%s (*.xml)' % translate('SongsPlugin.ImportWizardForm', 'OpenLyrics Files'),
'comboBoxText': translate('SongsPlugin.ImportWizardForm', 'OpenLyrics or OpenLP 2.0 Exported Song')
},
@@ -224,13 +229,20 @@ class SongFormat(object):
'selectMode': SongFormatSelect.SingleFile,
'filter': '%s (*.xml)' % translate('SongsPlugin.ImportWizardForm', 'EasySlides XML File')
},
- EasyWorship: {
+ EasyWorshipDB: {
'class': EasyWorshipSongImport,
- 'name': 'EasyWorship',
+ 'name': 'EasyWorship Song Database',
'prefix': 'ew',
'selectMode': SongFormatSelect.SingleFile,
'filter': '%s (*.db)' % translate('SongsPlugin.ImportWizardForm', 'EasyWorship Song Database')
},
+ EasyWorshipService: {
+ 'class': EasyWorshipSongImport,
+ 'name': 'EasyWorship Service File',
+ 'prefix': 'ew',
+ 'selectMode': SongFormatSelect.SingleFile,
+ 'filter': '%s (*.ews)' % translate('SongsPlugin.ImportWizardForm', 'EasyWorship Service File')
+ },
FoilPresenter: {
'class': FoilPresenterImport,
'name': 'Foilpresenter',
@@ -262,6 +274,12 @@ class SongFormat(object):
'invalidSourceMsg': translate('SongsPlugin.ImportWizardForm', 'You need to specify a valid PowerSong 1.0 '
'database folder.')
},
+ ProPresenter: {
+ 'class': ProPresenterImport,
+ 'name': 'ProPresenter',
+ 'prefix': 'proPresenter',
+ 'filter': '%s (*.pro4)' % translate('SongsPlugin.ImportWizardForm', 'ProPresenter Song Files')
+ },
SongBeamer: {
'class': SongBeamerImport,
'name': 'SongBeamer',
@@ -300,11 +318,21 @@ class SongFormat(object):
'filter': '%s (*.ptf)' % translate('SongsPlugin.ImportWizardForm', 'SundayPlus Song Files')
},
WordsOfWorship: {
- 'class': WowImport,
+ 'class': WordsOfWorshipImport,
'name': 'Words of Worship',
'prefix': 'wordsOfWorship',
'filter': '%s (*.wsg *.wow-song)' % translate('SongsPlugin.ImportWizardForm', 'Words Of Worship Song Files')
},
+ WorshipAssistant: {
+ 'class': WorshipAssistantImport,
+ 'name': 'Worship Assistant 0',
+ 'prefix': 'worshipAssistant',
+ 'selectMode': SongFormatSelect.SingleFile,
+ 'filter': '%s (*.csv)' % translate('SongsPlugin.ImportWizardForm', 'Worship Assistant Files'),
+ 'comboBoxText': translate('SongsPlugin.ImportWizardForm', 'Worship Assistant (CSV)'),
+ 'descriptionText': translate('SongsPlugin.ImportWizardForm',
+ 'In Worship Assistant, export your Database to a CSV file.')
+ },
WorshipCenterPro: {
'name': 'WorshipCenter Pro',
'prefix': 'worshipCenterPro',
@@ -341,27 +369,30 @@ class SongFormat(object):
SongFormat.CCLI,
SongFormat.DreamBeam,
SongFormat.EasySlides,
- SongFormat.EasyWorship,
+ SongFormat.EasyWorshipDB,
+ SongFormat.EasyWorshipService,
SongFormat.FoilPresenter,
SongFormat.MediaShout,
SongFormat.OpenSong,
SongFormat.PowerSong,
+ SongFormat.ProPresenter,
SongFormat.SongBeamer,
SongFormat.SongPro,
SongFormat.SongShowPlus,
SongFormat.SongsOfFellowship,
SongFormat.SundayPlus,
SongFormat.WordsOfWorship,
+ SongFormat.WorshipAssistant,
SongFormat.WorshipCenterPro,
SongFormat.ZionWorx
]
@staticmethod
- def get(format, *attributes):
+ def get(song_format, *attributes):
"""
Return requested song format attribute(s).
- :param format: A song format from SongFormat.
+ :param song_format: A song format from SongFormat.
:param attributes: Zero or more song format attributes from SongFormat.
Return type depends on number of supplied attributes:
@@ -371,31 +402,31 @@ class SongFormat(object):
:>1: Return tuple of requested attribute values.
"""
if not attributes:
- return SongFormat.__attributes__.get(format)
+ return SongFormat.__attributes__.get(song_format)
elif len(attributes) == 1:
default = SongFormat.__defaults__.get(attributes[0])
- return SongFormat.__attributes__[format].get(attributes[0], default)
+ return SongFormat.__attributes__[song_format].get(attributes[0], default)
else:
values = []
for attr in attributes:
default = SongFormat.__defaults__.get(attr)
- values.append(SongFormat.__attributes__[format].get(attr, default))
+ values.append(SongFormat.__attributes__[song_format].get(attr, default))
return tuple(values)
@staticmethod
- def set(format, attribute, value):
+ def set(song_format, attribute, value):
"""
Set specified song format attribute to the supplied value.
"""
- SongFormat.__attributes__[format][attribute] = value
+ SongFormat.__attributes__[song_format][attribute] = value
SongFormat.set(SongFormat.SongsOfFellowship, 'availability', HAS_SOF)
if HAS_SOF:
- SongFormat.set(SongFormat.SongsOfFellowship, 'class', SofImport)
+ SongFormat.set(SongFormat.SongsOfFellowship, 'class', SongsOfFellowshipImport)
SongFormat.set(SongFormat.Generic, 'availability', HAS_OOO)
if HAS_OOO:
- SongFormat.set(SongFormat.Generic, 'class', OooImport)
+ SongFormat.set(SongFormat.Generic, 'class', OpenOfficeImport)
SongFormat.set(SongFormat.MediaShout, 'availability', HAS_MEDIASHOUT)
if HAS_MEDIASHOUT:
SongFormat.set(SongFormat.MediaShout, 'class', MediaShoutImport)
diff --git a/openlp/plugins/songs/lib/importers/__init__.py b/openlp/plugins/songs/lib/importers/__init__.py
new file mode 100644
index 000000000..da302572e
--- /dev/null
+++ b/openlp/plugins/songs/lib/importers/__init__.py
@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
+
+###############################################################################
+# OpenLP - Open Source Lyrics Projection #
+# --------------------------------------------------------------------------- #
+# Copyright (c) 2008-2014 Raoul Snyman #
+# Portions copyright (c) 2008-2014 Tim Bentley, Gerald Britton, Jonathan #
+# Corwin, Samuel Findlay, Michael Gorven, Scott Guerrieri, Matthias Hub, #
+# Meinert Jordan, Armin Köhler, Erik Lundin, Edwin Lunando, Brian T. Meyer. #
+# Joshua Miller, Stevan Pettit, Andreas Preikschat, Mattias Põldaru, #
+# Christian Richter, Philip Ridout, Simon Scudder, Jeffrey Smith, #
+# Maikel Stuivenberg, Martin Thompson, Jon Tibble, Dave Warnock, #
+# Frode Woldsund, Martin Zibricky, Patrick Zimmermann #
+# --------------------------------------------------------------------------- #
+# 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 #
+###############################################################################
+"""
+The :mod:`~openlp.plugins.songs.lib.import` module contains importers for the Songs plugin.
+"""
diff --git a/openlp/plugins/songs/lib/cclifileimport.py b/openlp/plugins/songs/lib/importers/cclifile.py
similarity index 99%
rename from openlp/plugins/songs/lib/cclifileimport.py
rename to openlp/plugins/songs/lib/importers/cclifile.py
index 5c1fbdcb2..69c20d1cc 100644
--- a/openlp/plugins/songs/lib/cclifileimport.py
+++ b/openlp/plugins/songs/lib/importers/cclifile.py
@@ -63,9 +63,8 @@ class CCLIFileImport(SongImport):
for filename in self.import_source:
filename = str(filename)
log.debug('Importing CCLI File: %s', filename)
- lines = []
if os.path.isfile(filename):
- detect_file = open(filename, 'r')
+ detect_file = open(filename, 'rb')
detect_content = detect_file.read(2048)
try:
str(detect_content, 'utf-8')
@@ -250,7 +249,7 @@ class CCLIFileImport(SongImport):
# e.g. For use solely with the SongSelect Terms of Use.
All rights Reserved. www.ccli.com
CCLI Licence number of user
- # e.g. CCL-Liedlizenznummer: 14 / CCLI License No. 14
+ # e.g. CCLI-Liedlizenznummer: 14 / CCLI License No. 14
"""
log.debug('TXT file text: %s', text_list)
diff --git a/openlp/plugins/songs/lib/dreambeamimport.py b/openlp/plugins/songs/lib/importers/dreambeam.py
similarity index 97%
rename from openlp/plugins/songs/lib/dreambeamimport.py
rename to openlp/plugins/songs/lib/importers/dreambeam.py
index 375867aac..458961df0 100644
--- a/openlp/plugins/songs/lib/dreambeamimport.py
+++ b/openlp/plugins/songs/lib/importers/dreambeam.py
@@ -27,15 +27,14 @@
# Temple Place, Suite 330, Boston, MA 02111-1307 USA #
###############################################################################
"""
-The :mod:`dreambeamimport` module provides the functionality for importing
-DreamBeam songs into the OpenLP database.
+The :mod:`dreambeam` module provides the functionality for importing DreamBeam songs into the OpenLP database.
"""
import logging
from lxml import etree, objectify
from openlp.core.lib import translate
-from openlp.plugins.songs.lib.songimport import SongImport
+from openlp.plugins.songs.lib.importers.songimport import SongImport
from openlp.plugins.songs.lib.ui import SongStrings
log = logging.getLogger(__name__)
diff --git a/openlp/plugins/songs/lib/easyslidesimport.py b/openlp/plugins/songs/lib/importers/easyslides.py
similarity index 99%
rename from openlp/plugins/songs/lib/easyslidesimport.py
rename to openlp/plugins/songs/lib/importers/easyslides.py
index e28e7bf97..93e7fc4db 100644
--- a/openlp/plugins/songs/lib/easyslidesimport.py
+++ b/openlp/plugins/songs/lib/importers/easyslides.py
@@ -33,7 +33,7 @@ import re
from lxml import etree, objectify
from openlp.plugins.songs.lib import VerseType
-from openlp.plugins.songs.lib.songimport import SongImport
+from openlp.plugins.songs.lib.importers.songimport import SongImport
log = logging.getLogger(__name__)
@@ -292,7 +292,7 @@ class EasySlidesImport(SongImport):
return True
def _extract_region(self, line):
- # this was true already: line[0:7] == u'[region':
+ # this was true already: line[0:7] == '[region':
"""
Extract the region from text
diff --git a/openlp/plugins/songs/lib/importers/easyworship.py b/openlp/plugins/songs/lib/importers/easyworship.py
new file mode 100644
index 000000000..761f83f59
--- /dev/null
+++ b/openlp/plugins/songs/lib/importers/easyworship.py
@@ -0,0 +1,532 @@
+# -*- coding: utf-8 -*-
+# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
+
+###############################################################################
+# OpenLP - Open Source Lyrics Projection #
+# --------------------------------------------------------------------------- #
+# Copyright (c) 2008-2014 Raoul Snyman #
+# Portions copyright (c) 2008-2014 Tim Bentley, Gerald Britton, Jonathan #
+# Corwin, Samuel Findlay, Michael Gorven, Scott Guerrieri, Matthias Hub, #
+# Meinert Jordan, Armin Köhler, Erik Lundin, Edwin Lunando, Brian T. Meyer. #
+# Joshua Miller, Stevan Pettit, Andreas Preikschat, Mattias Põldaru, #
+# Christian Richter, Philip Ridout, Simon Scudder, Jeffrey Smith, #
+# Maikel Stuivenberg, Martin Thompson, Jon Tibble, Dave Warnock, #
+# Frode Woldsund, Martin Zibricky, Patrick Zimmermann #
+# --------------------------------------------------------------------------- #
+# 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 #
+###############################################################################
+"""
+The :mod:`easyworship` module provides the functionality for importing EasyWorship song databases into OpenLP.
+"""
+
+import os
+import struct
+import re
+import zlib
+
+from openlp.core.lib import translate
+from openlp.plugins.songs.lib import VerseType
+from openlp.plugins.songs.lib import retrieve_windows_encoding, strip_rtf
+from .songimport import SongImport
+
+# regex: at least two newlines, can have spaces between them
+SLIDE_BREAK_REGEX = re.compile(r'\n *?\n[\n ]*')
+NUMBER_REGEX = re.compile(r'[0-9]+')
+NOTE_REGEX = re.compile(r'\(.*?\)')
+
+
+class FieldDescEntry:
+ def __init__(self, name, field_type, size):
+ self.name = name
+ self.field_type = field_type
+ self.size = size
+
+
+class FieldType(object):
+ """
+ An enumeration class for different field types that can be expected in an EasyWorship song file.
+ """
+ String = 1
+ Int16 = 3
+ Int32 = 4
+ Logical = 9
+ Memo = 0x0c
+ Blob = 0x0d
+ Timestamp = 0x15
+
+
+class EasyWorshipSongImport(SongImport):
+ """
+ The :class:`EasyWorshipSongImport` class provides OpenLP with the
+ ability to import EasyWorship song files.
+ """
+ def __init__(self, manager, **kwargs):
+ super(EasyWorshipSongImport, self).__init__(manager, **kwargs)
+ self.entry_error_log = ''
+
+ def do_import(self):
+ """
+ Determines the type of file to import and calls the appropiate method
+ """
+ if self.import_source.lower().endswith('ews'):
+ self.import_ews()
+ else:
+ self.import_db()
+
+ def import_ews(self):
+ """
+ Import the songs from service file
+ The full spec of the ews files can be found here:
+ https://github.com/meinders/lithium-ews/blob/master/docs/ews%20file%20format.md
+ or here: http://wiki.openlp.org/Development:EasyWorship_EWS_Format
+ """
+ # Open ews file if it exists
+ if not os.path.isfile(self.import_source):
+ log.debug('Given ews file does not exists.')
+ return
+ # Make sure there is room for at least a header and one entry
+ if os.path.getsize(self.import_source) < 892:
+ log.debug('Given ews file is to small to contain valid data.')
+ return
+ # Take a stab at how text is encoded
+ self.encoding = 'cp1252'
+ self.encoding = retrieve_windows_encoding(self.encoding)
+ if not self.encoding:
+ log.debug('No encoding set.')
+ return
+ self.ews_file = open(self.import_source, 'rb')
+ # EWS header, version '1.6'/' 3'/' 5':
+ # Offset Field Data type Length Details
+ # --------------------------------------------------------------------------------------------------
+ # 0 Filetype string 38 Specifies the file type and version.
+ # "EasyWorship Schedule File Version 1.6" or
+ # "EasyWorship Schedule File Version 3" or
+ # "EasyWorship Schedule File Version 5"
+ # 40/48/56 Entry count int32le 4 Number of items in the schedule
+ # 44/52/60 Entry length int16le 2 Length of schedule entries: 0x0718 = 1816
+ # Get file version
+ type, = struct.unpack('<38s', self.ews_file.read(38))
+ version = type.decode()[-3:]
+ # Set fileposition based on filetype/version
+ file_pos = 0
+ if version == ' 5':
+ file_pos = 56
+ elif version == ' 3':
+ file_pos = 48
+ elif version == '1.6':
+ file_pos = 40
+ else:
+ log.debug('Given ews file is of unknown version.')
+ return
+ entry_count = self.get_i32(file_pos)
+ entry_length = self.get_i16(file_pos+4)
+ file_pos += 6
+ self.import_wizard.progress_bar.setMaximum(entry_count)
+ # Loop over songs
+ for i in range(entry_count):
+ # Load EWS entry metadata:
+ # Offset Field Data type Length Details
+ # ------------------------------------------------------------------------------------------------
+ # 0 Title cstring 50
+ # 307 Author cstring 50
+ # 358 Copyright cstring 100
+ # 459 Administrator cstring 50
+ # 800 Content pointer int32le 4 Position of the content for this entry.
+ # 820 Content type int32le 4 0x01 = Song, 0x02 = Scripture, 0x03 = Presentation,
+ # 0x04 = Video, 0x05 = Live video, 0x07 = Image,
+ # 0x08 = Audio, 0x09 = Web
+ # 1410 Song number cstring 10
+ self.set_defaults()
+ self.title = self.get_string(file_pos + 0, 50)
+ authors = self.get_string(file_pos + 307, 50)
+ copyright = self.get_string(file_pos + 358, 100)
+ admin = self.get_string(file_pos + 459, 50)
+ cont_ptr = self.get_i32(file_pos + 800)
+ cont_type = self.get_i32(file_pos + 820)
+ self.ccli_number = self.get_string(file_pos + 1410, 10)
+ # Only handle content type 1 (songs)
+ if cont_type != 1:
+ file_pos += entry_length
+ continue
+ # Load song content
+ # Offset Field Data type Length Details
+ # ------------------------------------------------------------------------------------------------
+ # 0 Length int32le 4 Length (L) of content, including the compressed content
+ # and the following fields (14 bytes total).
+ # 4 Content string L-14 Content compressed with deflate.
+ # Checksum int32be 4 Alder-32 checksum.
+ # (unknown) 4 0x51 0x4b 0x03 0x04
+ # Content length int32le 4 Length of content after decompression
+ content_length = self.get_i32(cont_ptr)
+ deflated_content = self.get_bytes(cont_ptr + 4, content_length - 10)
+ deflated_length = self.get_i32(cont_ptr + 4 + content_length - 6)
+ inflated_content = zlib.decompress(deflated_content, 15, deflated_length)
+ if copyright:
+ self.copyright = copyright
+ if admin:
+ if copyright:
+ self.copyright += ', '
+ self.copyright += translate('SongsPlugin.EasyWorshipSongImport',
+ 'Administered by %s') % admin
+ # Set the SongImport object members.
+ self.set_song_import_object(authors, inflated_content)
+ if self.stop_import_flag:
+ break
+ if self.entry_error_log:
+ self.log_error(self.import_source,
+ translate('SongsPlugin.EasyWorshipSongImport', '"%s" could not be imported. %s')
+ % (self.title, self.entry_error_log))
+ self.entry_error_log = ''
+ elif not self.finish():
+ self.log_error(self.import_source)
+ # Set file_pos for next entry
+ file_pos += entry_length
+ self.ews_file.close()
+
+ def import_db(self):
+ """
+ Import the songs from the database
+ """
+ # Open the DB and MB files if they exist
+ import_source_mb = self.import_source.replace('.DB', '.MB').replace('.db', '.mb')
+ if not os.path.isfile(self.import_source):
+ self.log_error(self.import_source, translate('SongsPlugin.EasyWorshipSongImport',
+ 'This file does not exist.'))
+ return
+ if not os.path.isfile(import_source_mb):
+ self.log_error(self.import_source, translate('SongsPlugin.EasyWorshipSongImport',
+ 'Could not find the "Songs.MB" file. It must be in the same '
+ 'folder as the "Songs.DB" file.'))
+ return
+ db_size = os.path.getsize(self.import_source)
+ if db_size < 0x800:
+ self.log_error(self.import_source, translate('SongsPlugin.EasyWorshipSongImport',
+ 'This file is not a valid EasyWorship database.'))
+ return
+ db_file = open(self.import_source, 'rb')
+ self.memo_file = open(import_source_mb, 'rb')
+ # Don't accept files that are clearly not paradox files
+ record_size, header_size, block_size, first_block, num_fields = struct.unpack(' 4:
+ db_file.close()
+ self.memo_file.close()
+ self.log_error(self.import_source, translate('SongsPlugin.EasyWorshipSongImport',
+ 'This file is not a valid EasyWorship database.'))
+ return
+ # Take a stab at how text is encoded
+ self.encoding = 'cp1252'
+ db_file.seek(106)
+ code_page, = struct.unpack(' len(tag):
+ match = NUMBER_REGEX.search(ew_tag)
+ if match:
+ number = match.group()
+ verse_type += number
+ number_found = True
+ match = NOTE_REGEX.search(ew_tag)
+ if match:
+ self.comments += ew_tag + '\n'
+ if not number_found:
+ verse_type += '1'
+ break
+ self.add_verse(verse_split[-1].strip() if first_line_is_tag else verse, verse_type)
+ if len(self.comments) > 5:
+ self.comments += str(translate('SongsPlugin.EasyWorshipSongImport',
+ '\n[above are Song Tags with notes imported from EasyWorship]'))
+
+ def find_field(self, field_name):
+ """
+ Find a field in the descriptions
+
+ :param field_name: field to find
+ """
+ return [i for i, x in enumerate(self.field_descriptions) if x.name == field_name][0]
+
+ def set_record_struct(self, field_descriptions):
+ """
+ Save the record structure
+
+ :param field_descriptions: An array of field descriptions
+ """
+ # Begin with empty field struct list
+ fsl = ['>']
+ for field_desc in field_descriptions:
+ if field_desc.field_type == FieldType.String:
+ fsl.append('%ds' % field_desc.size)
+ elif field_desc.field_type == FieldType.Int16:
+ fsl.append('H')
+ elif field_desc.field_type == FieldType.Int32:
+ fsl.append('I')
+ elif field_desc.field_type == FieldType.Logical:
+ fsl.append('B')
+ elif field_desc.field_type == FieldType.Memo:
+ fsl.append('%ds' % field_desc.size)
+ elif field_desc.field_type == FieldType.Blob:
+ fsl.append('%ds' % field_desc.size)
+ elif field_desc.field_type == FieldType.Timestamp:
+ fsl.append('Q')
+ else:
+ fsl.append('%ds' % field_desc.size)
+ self.record_structure = struct.Struct(''.join(fsl))
+ self.field_descriptions = field_descriptions
+
+ def get_field(self, field_desc_index):
+ """
+ Extract the field
+
+ :param field_desc_index: Field index value
+ :return: The field value
+ """
+ field = self.fields[field_desc_index]
+ field_desc = self.field_descriptions[field_desc_index]
+ # Return None in case of 'blank' entries
+ if isinstance(field, bytes):
+ if not field.rstrip(b'\0'):
+ return None
+ elif field == 0:
+ return None
+ # Format the field depending on the field type
+ if field_desc.field_type == FieldType.String:
+ return field.rstrip(b'\0')
+ elif field_desc.field_type == FieldType.Int16:
+ return field ^ 0x8000
+ elif field_desc.field_type == FieldType.Int32:
+ return field ^ 0x80000000
+ elif field_desc.field_type == FieldType.Logical:
+ return field ^ 0x80 == 1
+ elif field_desc.field_type == FieldType.Memo or field_desc.field_type == FieldType.Blob:
+ block_start, blob_size = struct.unpack_from(' 63:
+ return b''
+ self.memo_file.seek(11 + (5 * sub_block), os.SEEK_CUR)
+ sub_block_start, = struct.unpack('B', self.memo_file.read(1))
+ self.memo_file.seek(block_start + (sub_block_start * 16))
+ else:
+ return b''
+ return self.memo_file.read(blob_size)
+ else:
+ return 0
+
+ def get_bytes(self, pos, length):
+ """
+ Get bytes from ews_file
+
+ :param pos: Position to read from
+ :param length: Bytes to read
+ :return: Bytes read
+ """
+ self.ews_file.seek(pos)
+ return self.ews_file.read(length)
+
+ def get_string(self, pos, length):
+ """
+ Get string from ews_file
+
+ :param pos: Position to read from
+ :param length: Characters to read
+ :return: String read
+ """
+ bytes = self.get_bytes(pos, length)
+ mask = '<' + str(length) + 's'
+ byte_str, = struct.unpack(mask, bytes)
+ return byte_str.decode('unicode-escape').replace('\0', '').strip()
+
+ def get_i16(self, pos):
+ """
+ Get short int from ews_file
+
+ :param pos: Position to read from
+ :return: Short integer read
+ """
+
+ bytes = self.get_bytes(pos, 2)
+ mask = '`_ page on the OpenSong web site. However, it
doesn't describe the section, so here's an attempt:
- If the first charachter of a line is a space, then the rest of that line is lyrics. If it is not a space the
+ If the first character of a line is a space, then the rest of that line is lyrics. If it is not a space the
following applies.
Verses can be expressed in one of 2 ways, either in complete verses, or by line grouping, i.e. grouping all line 1's
@@ -93,12 +93,19 @@ class OpenSongImport(SongImport):
All verses are imported and tagged appropriately.
- Guitar chords can be provided "above" the lyrics (the line is preceeded by a period "."), and one or more "_" can
+ Guitar chords can be provided "above" the lyrics (the line is preceded by a period "."), and one or more "_" can
be used to signify long-drawn-out words. Chords and "_" are removed by this importer. For example::
. A7 Bm
1 Some____ Words
+ Lines that contain only whitespace are ignored.
+ | indicates a blank line, and || a new slide.
+
+ Slide 1 Line 1|Slide 1 Line 2||Slide 2 Line 1|Slide 2 Line 2
+
+ Lines beginning with ; are comments
+
The tag is used to populate the OpenLP verse display order field. The Author and Copyright tags are
also imported to the appropriate places.
"""
@@ -107,9 +114,14 @@ class OpenSongImport(SongImport):
"""
Initialise the class.
"""
- SongImport.__init__(self, manager, **kwargs)
+ super(OpenSongImport, self).__init__(manager, **kwargs)
def do_import(self):
+ """
+ Receive a single file or a list of files to import.
+ """
+ if not isinstance(self.import_source, list):
+ return
self.import_wizard.progress_bar.setMaximum(len(self.import_source))
for filename in self.import_source:
if self.stop_import_flag:
@@ -141,19 +153,41 @@ class OpenSongImport(SongImport):
'author': self.parse_author,
'title': 'title',
'aka': 'alternate_title',
- 'hymn_number': 'song_number'
+ 'hymn_number': self.parse_song_book_name_and_number,
+ 'user1': self.add_comment,
+ 'user2': self.add_comment,
+ 'user3': self.add_comment
}
for attr, fn_or_string in list(decode.items()):
if attr in fields:
ustring = str(root.__getattr__(attr))
if isinstance(fn_or_string, str):
- setattr(self, fn_or_string, ustring)
+ if attr in ['ccli']:
+ if ustring:
+ setattr(self, fn_or_string, int(ustring))
+ else:
+ setattr(self, fn_or_string, None)
+ else:
+ setattr(self, fn_or_string, ustring)
else:
fn_or_string(ustring)
- if 'theme' in fields and str(root.theme) not in self.topics:
- self.topics.append(str(root.theme))
- if 'alttheme' in fields and str(root.alttheme) not in self.topics:
- self.topics.append(str(root.alttheme))
+ # Themes look like "God: Awe/Wonder", but we just want
+ # "Awe" and "Wonder". We use a set to ensure each topic
+ # is only added once, in case it is already there, which
+ # is actually quite likely if the alttheme is set
+ topics = set(self.topics)
+ if 'theme' in fields:
+ theme = str(root.theme)
+ subthemes = theme[theme.find(':')+1:].split('/')
+ for topic in subthemes:
+ topics.add(topic.strip())
+ if 'alttheme' in fields:
+ theme = str(root.alttheme)
+ subthemes = theme[theme.find(':')+1:].split('/')
+ for topic in subthemes:
+ topics.add(topic.strip())
+ self.topics = list(topics)
+ self.topics.sort()
# data storage while importing
verses = {}
# keep track of verses appearance order
@@ -168,7 +202,7 @@ class OpenSongImport(SongImport):
else:
lyrics = ''
for this_line in lyrics.split('\n'):
- if not this_line:
+ if not this_line.strip():
continue
# skip this line if it is a comment
if this_line.startswith(';'):
@@ -209,8 +243,14 @@ class OpenSongImport(SongImport):
# Tidy text and remove the ____s from extended words
this_line = self.tidy_text(this_line)
this_line = this_line.replace('_', '')
- this_line = this_line.replace('|', '\n')
+ this_line = this_line.replace('||', '\n[---]\n')
this_line = this_line.strip()
+ # If the line consists solely of a '|', then just use the implicit newline
+ # Otherwise, add a newline for each '|'
+ if this_line == '|':
+ this_line = ''
+ else:
+ this_line = this_line.replace('|', '\n')
verses[verse_tag][verse_num][inst].append(this_line)
# done parsing
# add verses in original order
@@ -223,7 +263,14 @@ class OpenSongImport(SongImport):
verse_def = '%s%s' % (verse_tag, verse_num[:length])
verse_joints[verse_def] = '%s\n[---]\n%s' % (verse_joints[verse_def], lines) \
if verse_def in verse_joints else lines
- for verse_def, lines in verse_joints.items():
+ # Parsing the dictionary produces the elements in a non-intuitive order. While it "works", it's not a
+ # natural layout should the user come back to edit the song. Instead we sort by the verse type, so that we
+ # get all the verses in order (v1, v2, ...), then the chorus(es), bridge(s), pre-chorus(es) etc. We use a
+ # tuple for the key, since tuples naturally sort in this manner.
+ verse_defs = sorted(verse_joints.keys(),
+ key=lambda verse_def: (VerseType.from_tag(verse_def[0]), int(verse_def[1:])))
+ for verse_def in verse_defs:
+ lines = verse_joints[verse_def]
self.add_verse(lines, verse_def)
if not self.verses:
self.add_verse('')
@@ -244,6 +291,8 @@ class OpenSongImport(SongImport):
# Assume it's no.1 if there are no digits
verse_tag = verse_def
verse_num = '1'
+ verse_index = VerseType.from_loose_input(verse_tag)
+ verse_tag = VerseType.tags[verse_index]
verse_def = '%s%s' % (verse_tag, verse_num)
if verse_num in verses.get(verse_tag, {}):
self.verse_order_list.append(verse_def)
diff --git a/openlp/plugins/songs/lib/powersongimport.py b/openlp/plugins/songs/lib/importers/powersong.py
similarity index 97%
rename from openlp/plugins/songs/lib/powersongimport.py
rename to openlp/plugins/songs/lib/importers/powersong.py
index cd568bc2c..5aa0038f4 100644
--- a/openlp/plugins/songs/lib/powersongimport.py
+++ b/openlp/plugins/songs/lib/importers/powersong.py
@@ -27,7 +27,7 @@
# Temple Place, Suite 330, Boston, MA 02111-1307 USA #
###############################################################################
"""
-The :mod:`powersongimport` module provides the functionality for importing
+The :mod:`powersong` module provides the functionality for importing
PowerSong songs into the OpenLP database.
"""
import logging
@@ -35,7 +35,7 @@ import fnmatch
import os
from openlp.core.common import translate
-from openlp.plugins.songs.lib.songimport import SongImport
+from openlp.plugins.songs.lib.importers.songimport import SongImport
log = logging.getLogger(__name__)
@@ -90,7 +90,7 @@ class PowerSongImport(SongImport):
"""
Receive either a list of files or a folder (unicode) to import.
"""
- from .importer import SongFormat
+ from openlp.plugins.songs.lib.importer import SongFormat
ps_string = SongFormat.get(SongFormat.PowerSong, 'name')
if isinstance(self.import_source, str):
if os.path.isdir(self.import_source):
diff --git a/openlp/plugins/songs/lib/importers/propresenter.py b/openlp/plugins/songs/lib/importers/propresenter.py
new file mode 100644
index 000000000..3bf7f9cd8
--- /dev/null
+++ b/openlp/plugins/songs/lib/importers/propresenter.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-2013 Raoul Snyman #
+# Portions copyright (c) 2008-2013 Tim Bentley, Gerald Britton, Jonathan #
+# Corwin, Samuel Findlay, Michael Gorven, Scott Guerrieri, Matthias Hub, #
+# Meinert Jordan, Armin Köhler, Erik Lundin, Edwin Lunando, Brian T. Meyer. #
+# Joshua Miller, Stevan Pettit, Andreas Preikschat, Mattias Põldaru, #
+# Christian Richter, Philip Ridout, Simon Scudder, Jeffrey Smith, #
+# Maikel Stuivenberg, Martin Thompson, Jon Tibble, Dave Warnock, #
+# Frode Woldsund, Martin Zibricky, Patrick Zimmermann #
+# --------------------------------------------------------------------------- #
+# 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 #
+###############################################################################
+"""
+The :mod:`propresenter` module provides the functionality for importing
+ProPresenter song files into the current installation database.
+"""
+
+import os
+import base64
+from lxml import objectify
+
+from openlp.core.ui.wizard import WizardStrings
+from openlp.plugins.songs.lib import strip_rtf
+from .songimport import SongImport
+
+
+class ProPresenterImport(SongImport):
+ """
+ The :class:`ProPresenterImport` class provides OpenLP with the
+ ability to import ProPresenter song files.
+ """
+ def do_import(self):
+ self.import_wizard.progress_bar.setMaximum(len(self.import_source))
+ for file_path in self.import_source:
+ if self.stop_import_flag:
+ return
+ self.import_wizard.increment_progress_bar(WizardStrings.ImportingType % os.path.basename(file_path))
+ root = objectify.parse(open(file_path, 'rb')).getroot()
+ self.process_song(root)
+
+ def process_song(self, root):
+ self.set_defaults()
+ self.title = root.get('CCLISongTitle')
+ self.copyright = root.get('CCLICopyrightInfo')
+ self.comments = root.get('notes')
+ self.ccli_number = root.get('CCLILicenseNumber')
+ for author_key in ['author', 'artist', 'CCLIArtistCredits']:
+ author = root.get(author_key)
+ if len(author) > 0:
+ self.parse_author(author)
+ count = 0
+ for slide in root.slides.RVDisplaySlide:
+ count += 1
+ RTFData = slide.displayElements.RVTextElement.get('RTFData')
+ rtf = base64.standard_b64decode(RTFData)
+ words, encoding = strip_rtf(rtf.decode())
+ self.add_verse(words, "v%d" % count)
+ if not self.finish():
+ self.log_error(self.import_source)
diff --git a/openlp/plugins/songs/lib/songbeamerimport.py b/openlp/plugins/songs/lib/importers/songbeamer.py
similarity index 98%
rename from openlp/plugins/songs/lib/songbeamerimport.py
rename to openlp/plugins/songs/lib/importers/songbeamer.py
index a0b166ded..9a7429f02 100644
--- a/openlp/plugins/songs/lib/songbeamerimport.py
+++ b/openlp/plugins/songs/lib/importers/songbeamer.py
@@ -27,7 +27,7 @@
# Temple Place, Suite 330, Boston, MA 02111-1307 USA #
###############################################################################
"""
-The :mod:`songbeamerimport` module provides the functionality for importing SongBeamer songs into the OpenLP database.
+The :mod:`songbeamer` module provides the functionality for importing SongBeamer songs into the OpenLP database.
"""
import chardet
import codecs
@@ -36,7 +36,7 @@ import os
import re
from openlp.plugins.songs.lib import VerseType
-from openlp.plugins.songs.lib.songimport import SongImport
+from openlp.plugins.songs.lib.importers.songimport import SongImport
log = logging.getLogger(__name__)
@@ -171,7 +171,7 @@ class SongBeamerImport(SongImport):
:param line: The line in the file. It should consist of a tag and a value for this tag (unicode)::
- u'#Title=Nearer my God to Thee'
+ '#Title=Nearer my God to Thee'
"""
tag_val = line.split('=', 1)
if len(tag_val) == 1:
diff --git a/openlp/plugins/songs/lib/songimport.py b/openlp/plugins/songs/lib/importers/songimport.py
similarity index 89%
rename from openlp/plugins/songs/lib/songimport.py
rename to openlp/plugins/songs/lib/importers/songimport.py
index a5fbb99e0..5382efbe5 100644
--- a/openlp/plugins/songs/lib/songimport.py
+++ b/openlp/plugins/songs/lib/importers/songimport.py
@@ -39,7 +39,7 @@ from openlp.core.ui.wizard import WizardStrings
from openlp.plugins.songs.lib import clean_song, VerseType
from openlp.plugins.songs.lib.db import Song, Author, Topic, Book, MediaFile
from openlp.plugins.songs.lib.ui import SongStrings
-from openlp.plugins.songs.lib.xml import SongXML
+from openlp.plugins.songs.lib.openlyricsxml import SongXML
log = logging.getLogger(__name__)
@@ -188,13 +188,61 @@ class SongImport(QtCore.QObject):
self.title = lines[0]
self.add_verse(text)
+ def parse_song_book_name_and_number(self, book_and_number):
+ """
+ Build the book name and song number from a single string
+ """
+ # Turn 'Spring Harvest 1997 No. 34' or
+ # 'Spring Harvest 1997 (34)' or
+ # 'Spring Harvest 1997 34' into
+ # Book name:'Spring Harvest 1997' and
+ # Song number: 34
+ #
+ # Also, turn 'NRH231.' into
+ # Book name:'NRH' and
+ # Song number: 231
+ book_and_number = book_and_number.strip()
+ if not book_and_number:
+ return
+ book_and_number = book_and_number.replace('No.', ' ')
+ if ' ' in book_and_number:
+ parts = book_and_number.split(' ')
+ self.song_book_name = ' '.join(parts[:-1])
+ self.song_number = parts[-1].strip('()')
+ else:
+ # Something like 'ABC123.'
+ match = re.match(r'(.*\D)(\d+)', book_and_number)
+ match_num = re.match(r'(\d+)', book_and_number)
+ if match:
+ # Name and number
+ self.song_book_name = match.group(1)
+ self.song_number = match.group(2)
+ # These last two cases aren't tested yet, but
+ # are here in an attempt to do something vaguely
+ # sensible if we get a string in a different format
+ elif match_num:
+ # Number only
+ self.song_number = match_num.group(1)
+ else:
+ # Name only
+ self.song_book_name = book_and_number
+
+ def add_comment(self, comment):
+ """
+ Build the comments field
+ """
+ if self.comments.find(comment) >= 0:
+ return
+ if comment:
+ self.comments += comment.strip() + '\n'
+
def add_copyright(self, copyright):
"""
Build the copyright field
"""
if self.copyright.find(copyright) >= 0:
return
- if self.copyright != '':
+ if self.copyright:
self.copyright += ' '
self.copyright += copyright
@@ -325,7 +373,7 @@ class SongImport(QtCore.QObject):
author = Author.populate(display_name=author_text,
last_name=author_text.split(' ')[-1],
first_name=' '.join(author_text.split(' ')[:-1]))
- song.authors.append(author)
+ song.add_author(author)
if self.song_book_name:
song_book = self.manager.get_object_filtered(Book, Book.name == self.song_book_name)
if song_book is None:
diff --git a/openlp/plugins/songs/lib/songproimport.py b/openlp/plugins/songs/lib/importers/songpro.py
similarity index 97%
rename from openlp/plugins/songs/lib/songproimport.py
rename to openlp/plugins/songs/lib/importers/songpro.py
index 86411a499..efe1a85ea 100644
--- a/openlp/plugins/songs/lib/songproimport.py
+++ b/openlp/plugins/songs/lib/importers/songpro.py
@@ -27,13 +27,13 @@
# Temple Place, Suite 330, Boston, MA 02111-1307 USA #
###############################################################################
"""
-The :mod:`songproimport` module provides the functionality for importing SongPro
+The :mod:`songpro` module provides the functionality for importing SongPro
songs into the OpenLP database.
"""
import re
from openlp.plugins.songs.lib import strip_rtf
-from openlp.plugins.songs.lib.songimport import SongImport
+from openlp.plugins.songs.lib.importers.songimport import SongImport
class SongProImport(SongImport):
diff --git a/openlp/plugins/songs/lib/songshowplusimport.py b/openlp/plugins/songs/lib/importers/songshowplus.py
similarity index 94%
rename from openlp/plugins/songs/lib/songshowplusimport.py
rename to openlp/plugins/songs/lib/importers/songshowplus.py
index 0a8dc4650..6c9feab68 100644
--- a/openlp/plugins/songs/lib/songshowplusimport.py
+++ b/openlp/plugins/songs/lib/importers/songshowplus.py
@@ -27,7 +27,7 @@
# Temple Place, Suite 330, Boston, MA 02111-1307 USA #
###############################################################################
"""
-The :mod:`songshowplusimport` module provides the functionality for importing SongShow Plus songs into the OpenLP
+The :mod:`songshowplus` module provides the functionality for importing SongShow Plus songs into the OpenLP
database.
"""
import chardet
@@ -38,7 +38,7 @@ import struct
from openlp.core.ui.wizard import WizardStrings
from openlp.plugins.songs.lib import VerseType, retrieve_windows_encoding
-from openlp.plugins.songs.lib.songimport import SongImport
+from openlp.plugins.songs.lib.importers.songimport import SongImport
TITLE = 1
AUTHOR = 2
@@ -121,7 +121,7 @@ class SongShowPlusImport(SongImport):
null, verse_no, = struct.unpack("BB", song_data.read(2))
elif block_key == CUSTOM_VERSE:
null, verse_name_length, = struct.unpack("BB", song_data.read(2))
- verse_name = song_data.read(verse_name_length)
+ verse_name = self.decode(song_data.read(verse_name_length))
length_descriptor_size, = struct.unpack("B", song_data.read(1))
log.debug(length_descriptor_size)
# Detect if/how long the length descriptor is
@@ -147,7 +147,12 @@ class SongShowPlusImport(SongImport):
elif block_key == COPYRIGHT:
self.add_copyright(self.decode(data))
elif block_key == CCLI_NO:
- self.ccli_number = int(data)
+ # Try to get the CCLI number even if the field contains additional text
+ match = re.search(r'\d+', self.decode(data))
+ if match:
+ self.ccli_number = int(match.group())
+ else:
+ log.warn("Can't parse CCLI Number from string: %s" % self.decode(data))
elif block_key == VERSE:
self.add_verse(self.decode(data), "%s%s" % (VerseType.tags[VerseType.Verse], verse_no))
elif block_key == CHORUS:
diff --git a/openlp/plugins/songs/lib/sofimport.py b/openlp/plugins/songs/lib/importers/songsoffellowship.py
similarity index 98%
rename from openlp/plugins/songs/lib/sofimport.py
rename to openlp/plugins/songs/lib/importers/songsoffellowship.py
index e44034648..c1ef8666f 100644
--- a/openlp/plugins/songs/lib/sofimport.py
+++ b/openlp/plugins/songs/lib/importers/songsoffellowship.py
@@ -37,13 +37,13 @@ import logging
import os
import re
-from .oooimport import OooImport
+from .openoffice import OpenOfficeImport
log = logging.getLogger(__name__)
if os.name == 'nt':
- from .oooimport import PAGE_BEFORE, PAGE_AFTER, PAGE_BOTH
+ from .openoffice import PAGE_BEFORE, PAGE_AFTER, PAGE_BOTH
RuntimeException = Exception
else:
try:
@@ -62,7 +62,7 @@ except ImportError:
ITALIC = 2
-class SofImport(OooImport):
+class SongsOfFellowshipImport(OpenOfficeImport):
"""
Import songs provided on disks with the Songs of Fellowship music books
VOLS1_2.RTF, sof3words.rtf and sof4words.rtf
@@ -83,7 +83,7 @@ class SofImport(OooImport):
Initialise the class. Requires a songmanager class which is passed
to SongImport for writing song to disk
"""
- OooImport.__init__(self, manager, **kwargs)
+ OpenOfficeImport.__init__(self, manager, **kwargs)
self.song = False
def process_ooo_document(self):
diff --git a/openlp/plugins/songs/lib/sundayplusimport.py b/openlp/plugins/songs/lib/importers/sundayplus.py
similarity index 95%
rename from openlp/plugins/songs/lib/sundayplusimport.py
rename to openlp/plugins/songs/lib/importers/sundayplus.py
index f22f8b058..b664efb54 100644
--- a/openlp/plugins/songs/lib/sundayplusimport.py
+++ b/openlp/plugins/songs/lib/importers/sundayplus.py
@@ -32,7 +32,7 @@ import re
from openlp.plugins.songs.lib import VerseType, retrieve_windows_encoding
from openlp.plugins.songs.lib import strip_rtf
-from openlp.plugins.songs.lib.songimport import SongImport
+from openlp.plugins.songs.lib.importers.songimport import SongImport
HOTKEY_TO_VERSE_TYPE = {
'1': 'v1',
@@ -68,7 +68,7 @@ class SundayPlusImport(SongImport):
for filename in self.import_source:
if self.stop_import_flag:
return
- song_file = open(filename)
+ song_file = open(filename, 'rb')
self.do_import_file(song_file)
song_file.close()
@@ -103,7 +103,7 @@ class SundayPlusImport(SongImport):
# Now we are looking for the name.
if data[i:i + 1] == '#':
name_end = data.find(':', i + 1)
- name = data[i + 1:name_end]
+ name = data[i + 1:name_end].upper()
i = name_end + 1
while data[i:i + 1] == ' ':
i += 1
@@ -129,13 +129,13 @@ class SundayPlusImport(SongImport):
value = data[i:end]
# If we are in the main group.
if not cell:
- if name == 'title':
+ if name == 'TITLE':
self.title = self.decode(self.unescape(value))
- elif name == 'Author':
+ elif name == 'AUTHOR':
author = self.decode(self.unescape(value))
if len(author):
self.add_author(author)
- elif name == 'Copyright':
+ elif name == 'COPYRIGHT':
self.copyright = self.decode(self.unescape(value))
elif name[0:4] == 'CELL':
self.parse(value, cell=name[4:])
@@ -147,12 +147,12 @@ class SundayPlusImport(SongImport):
verse_type = VerseType.tags[VerseType.from_loose_input(value[0])]
if len(value) >= 2 and value[-1] in ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9']:
verse_type = "%s%s" % (verse_type, value[-1])
- elif name == 'Hotkey':
- # Hotkey always appears after MARKER_NAME, so it
+ elif name == 'HOTKEY':
+ # HOTKEY always appears after MARKER_NAME, so it
# effectively overrides MARKER_NAME, if present.
if len(value) and value in list(HOTKEY_TO_VERSE_TYPE.keys()):
verse_type = HOTKEY_TO_VERSE_TYPE[value]
- if name == 'rtf':
+ if name == 'RTF':
value = self.unescape(value)
result = strip_rtf(value, self.encoding)
if result is None:
diff --git a/openlp/plugins/songs/lib/wowimport.py b/openlp/plugins/songs/lib/importers/wordsofworship.py
similarity index 96%
rename from openlp/plugins/songs/lib/wowimport.py
rename to openlp/plugins/songs/lib/importers/wordsofworship.py
index c92b0ee2a..1b398c604 100644
--- a/openlp/plugins/songs/lib/wowimport.py
+++ b/openlp/plugins/songs/lib/importers/wordsofworship.py
@@ -27,24 +27,23 @@
# Temple Place, Suite 330, Boston, MA 02111-1307 USA #
###############################################################################
"""
-The :mod:`wowimport` module provides the functionality for importing Words of
+The :mod:`wordsofworship` module provides the functionality for importing Words of
Worship songs into the OpenLP database.
"""
import os
import logging
from openlp.core.common import translate
-from openlp.plugins.songs.lib.songimport import SongImport
+from openlp.plugins.songs.lib.importers.songimport import SongImport
BLOCK_TYPES = ('V', 'C', 'B')
log = logging.getLogger(__name__)
-class WowImport(SongImport):
+class WordsOfWorshipImport(SongImport):
"""
- The :class:`WowImport` class provides the ability to import song files from
- Words of Worship.
+ The :class:`WordsOfWorshipImport` class provides the ability to import song files from Words of Worship.
**Words Of Worship Song File Format:**
diff --git a/openlp/plugins/songs/lib/importers/worshipassistant.py b/openlp/plugins/songs/lib/importers/worshipassistant.py
new file mode 100644
index 000000000..6ddc71159
--- /dev/null
+++ b/openlp/plugins/songs/lib/importers/worshipassistant.py
@@ -0,0 +1,171 @@
+# -*- coding: utf-8 -*-
+# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
+
+###############################################################################
+# OpenLP - Open Source Lyrics Projection #
+# --------------------------------------------------------------------------- #
+# Copyright (c) 2008-2014 Raoul Snyman #
+# Portions copyright (c) 2008-2014 Tim Bentley, Gerald Britton, Jonathan #
+# Corwin, Samuel Findlay, Michael Gorven, Scott Guerrieri, Matthias Hub, #
+# Meinert Jordan, Armin Köhler, Erik Lundin, Edwin Lunando, Brian T. Meyer. #
+# Joshua Miller, Stevan Pettit, Andreas Preikschat, Mattias Põldaru, #
+# Christian Richter, Philip Ridout, Simon Scudder, Jeffrey Smith, #
+# Maikel Stuivenberg, Martin Thompson, Jon Tibble, Dave Warnock, #
+# Frode Woldsund, Martin Zibricky, Patrick Zimmermann #
+# --------------------------------------------------------------------------- #
+# 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 #
+###############################################################################
+"""
+The :mod:`worshipassistant` module provides the functionality for importing
+Worship Assistant songs into the OpenLP database.
+"""
+import chardet
+import csv
+import logging
+import re
+
+from openlp.core.common import translate
+from openlp.plugins.songs.lib import VerseType
+from openlp.plugins.songs.lib.importers.songimport import SongImport
+
+log = logging.getLogger(__name__)
+
+EMPTY_STR = 'NULL'
+
+
+class WorshipAssistantImport(SongImport):
+ """
+ The :class:`WorshipAssistantImport` class provides the ability to import songs
+ from Worship Assistant, via a dump of the database to a CSV file.
+
+ The following fields are in the exported CSV file:
+
+ * ``SONGNR`` Song ID (Discarded by importer)
+ * ``TITLE`` Song title
+ * ``AUTHOR`` Song author.
+ * ``COPYRIGHT`` Copyright information
+ * ``FIRSTLINE`` Unknown (Discarded by importer)
+ * ``PRIKEY`` Primary chord key (Discarded by importer)
+ * ``ALTKEY`` Alternate chord key (Discarded by importer)
+ * ``TEMPO`` Tempo (Discarded by importer)
+ * ``FOCUS`` Unknown (Discarded by importer)
+ * ``THEME`` Theme (Discarded by importer)
+ * ``SCRIPTURE`` Associated scripture (Discarded by importer)
+ * ``ACTIVE`` Boolean value (Discarded by importer)
+ * ``SONGBOOK`` Boolean value (Discarded by importer)
+ * ``TIMESIG`` Unknown (Discarded by importer)
+ * ``INTRODUCED`` Date the song was created (Discarded by importer)
+ * ``LASTUSED`` Date the song was last used (Discarded by importer)
+ * ``TIMESUSED`` How many times the song was used (Discarded by importer)
+ * ``CCLINR`` CCLI Number
+ * ``USER1`` User Field 1 (Discarded by importer)
+ * ``USER2`` User Field 2 (Discarded by importer)
+ * ``USER3`` User Field 3 (Discarded by importer)
+ * ``USER4`` User Field 4 (Discarded by importer)
+ * ``USER5`` User Field 5 (Discarded by importer)
+ * ``ROADMAP`` Verse order used for the presentation
+ * ``FILELINK1`` Associated file 1 (Discarded by importer)
+ * ``OVERMAP`` Verse order used for printing (Discarded by importer)
+ * ``FILELINK2`` Associated file 2 (Discarded by importer)
+ * ``LYRICS`` The song lyrics used for printing (Discarded by importer, LYRICS2 is used instead)
+ * ``INFO`` Unknown (Discarded by importer)
+ * ``LYRICS2`` The song lyrics used for the presentation
+ * ``BACKGROUND`` Custom background (Discarded by importer)
+ """
+ def do_import(self):
+ """
+ Receive a CSV file to import.
+ """
+ # Get encoding
+ detect_file = open(self.import_source, 'rb')
+ detect_content = detect_file.read()
+ details = chardet.detect(detect_content)
+ detect_file.close()
+ songs_file = open(self.import_source, 'r', encoding=details['encoding'])
+ songs_reader = csv.DictReader(songs_file)
+ try:
+ records = list(songs_reader)
+ except csv.Error as e:
+ self.log_error(translate('SongsPlugin.WorshipAssistantImport', 'Error reading CSV file.'),
+ translate('SongsPlugin.WorshipAssistantImport', 'Line %d: %s') %
+ (songs_reader.line_num, e))
+ return
+ num_records = len(records)
+ log.info('%s records found in CSV file' % num_records)
+ self.import_wizard.progress_bar.setMaximum(num_records)
+ for index, record in enumerate(records, 1):
+ if self.stop_import_flag:
+ return
+ # Ensure that all keys are uppercase
+ record = dict((field.upper(), value) for field, value in record.items())
+ # The CSV file has a line in the middle of the file where the headers are repeated.
+ # We need to skip this line.
+ if record['TITLE'] == "TITLE" and record['AUTHOR'] == 'AUTHOR' and record['LYRICS2'] == 'LYRICS2':
+ continue
+ self.set_defaults()
+ verse_order_list = []
+ try:
+ self.title = record['TITLE']
+ if record['AUTHOR'] != EMPTY_STR:
+ self.parse_author(record['AUTHOR'])
+ print(record['AUTHOR'])
+ if record['COPYRIGHT'] != EMPTY_STR:
+ self.add_copyright(record['COPYRIGHT'])
+ if record['CCLINR'] != EMPTY_STR:
+ self.ccli_number = record['CCLINR']
+ if record['ROADMAP'] != EMPTY_STR:
+ verse_order_list = record['ROADMAP'].split(',')
+ lyrics = record['LYRICS2']
+ except UnicodeDecodeError as e:
+ self.log_error(translate('SongsPlugin.WorshipAssistantImport', 'Record %d' % index),
+ translate('SongsPlugin.WorshipAssistantImport', 'Decoding error: %s') % e)
+ continue
+ except TypeError as e:
+ self.log_error(translate('SongsPlugin.WorshipAssistantImport',
+ 'File not valid WorshipAssistant CSV format.'), 'TypeError: %s' % e)
+ return
+ verse = ''
+ for line in lyrics.splitlines():
+ if line.startswith('['): # verse marker
+ # drop the square brackets
+ right_bracket = line.find(']')
+ content = line[1:right_bracket].lower()
+ match = re.match('(\D*)(\d+)', content)
+ if match is not None:
+ verse_tag = match.group(1)
+ verse_num = match.group(2)
+ else:
+ # otherwise we assume number 1 and take the whole prefix as the verse tag
+ verse_tag = content
+ verse_num = '1'
+ verse_index = VerseType.from_loose_input(verse_tag) if verse_tag else 0
+ verse_tag = VerseType.tags[verse_index]
+ # Update verse order when the verse name has changed
+ if content != verse_tag + verse_num:
+ for i in range(len(verse_order_list)):
+ if verse_order_list[i].lower() == content.lower():
+ verse_order_list[i] = verse_tag + verse_num
+ elif line and not line.isspace():
+ verse += line + '\n'
+ elif verse:
+ self.add_verse(verse, verse_tag+verse_num)
+ verse = ''
+ if verse:
+ self.add_verse(verse, verse_tag+verse_num)
+ if verse_order_list:
+ self.verse_order_list = verse_order_list
+ if not self.finish():
+ self.log_error(translate('SongsPlugin.WorshipAssistantImport', 'Record %d') % index
+ + (': "' + self.title + '"' if self.title else ''))
+ songs_file.close()
diff --git a/openlp/plugins/songs/lib/worshipcenterproimport.py b/openlp/plugins/songs/lib/importers/worshipcenterpro.py
similarity index 98%
rename from openlp/plugins/songs/lib/worshipcenterproimport.py
rename to openlp/plugins/songs/lib/importers/worshipcenterpro.py
index b24d2ae83..817bd8cae 100644
--- a/openlp/plugins/songs/lib/worshipcenterproimport.py
+++ b/openlp/plugins/songs/lib/importers/worshipcenterpro.py
@@ -35,7 +35,7 @@ import logging
import pyodbc
from openlp.core.common import translate
-from openlp.plugins.songs.lib.songimport import SongImport
+from openlp.plugins.songs.lib.importers.songimport import SongImport
log = logging.getLogger(__name__)
diff --git a/openlp/plugins/songs/lib/zionworximport.py b/openlp/plugins/songs/lib/importers/zionworx.py
similarity index 97%
rename from openlp/plugins/songs/lib/zionworximport.py
rename to openlp/plugins/songs/lib/importers/zionworx.py
index dfdc2373d..ed3c41f3a 100644
--- a/openlp/plugins/songs/lib/zionworximport.py
+++ b/openlp/plugins/songs/lib/importers/zionworx.py
@@ -27,14 +27,13 @@
# Temple Place, Suite 330, Boston, MA 02111-1307 USA #
###############################################################################
"""
-The :mod:`zionworximport` module provides the functionality for importing
-ZionWorx songs into the OpenLP database.
+The :mod:`zionworx` module provides the functionality for importing ZionWorx songs into the OpenLP database.
"""
import csv
import logging
from openlp.core.common import translate
-from openlp.plugins.songs.lib.songimport import SongImport
+from openlp.plugins.songs.lib.importers.songimport import SongImport
log = logging.getLogger(__name__)
diff --git a/openlp/plugins/songs/lib/mediaitem.py b/openlp/plugins/songs/lib/mediaitem.py
index 314d1ffe7..fde103c5f 100644
--- a/openlp/plugins/songs/lib/mediaitem.py
+++ b/openlp/plugins/songs/lib/mediaitem.py
@@ -36,17 +36,17 @@ from PyQt4 import QtCore, QtGui
from sqlalchemy.sql import or_
from openlp.core.common import Registry, AppLocation, Settings, check_directory_exists, UiStrings, translate
-from openlp.core.lib import MediaManagerItem, ItemCapabilities, PluginStatus, ServiceItemContext, check_item_selected, \
- create_separated_list
+from openlp.core.lib import MediaManagerItem, ItemCapabilities, PluginStatus, ServiceItem, ServiceItemContext, \
+ check_item_selected, create_separated_list
from openlp.core.lib.ui import create_widget_action
from openlp.plugins.songs.forms.editsongform import EditSongForm
from openlp.plugins.songs.forms.songmaintenanceform import SongMaintenanceForm
from openlp.plugins.songs.forms.songimportform import SongImportForm
from openlp.plugins.songs.forms.songexportform import SongExportForm
from openlp.plugins.songs.lib import VerseType, clean_string, delete_song
-from openlp.plugins.songs.lib.db import Author, Song, Book, MediaFile
+from openlp.plugins.songs.lib.db import Author, AuthorType, Song, Book, MediaFile
from openlp.plugins.songs.lib.ui import SongStrings
-from openlp.plugins.songs.lib.xml import OpenLyrics, SongXML
+from openlp.plugins.songs.lib.openlyricsxml import OpenLyrics, SongXML
log = logging.getLogger(__name__)
@@ -124,7 +124,8 @@ class SongMediaItem(MediaManagerItem):
log.debug('config_updated')
self.search_as_you_type = Settings().value(self.settings_section + '/search as type')
self.update_service_on_edit = Settings().value(self.settings_section + '/update service on edit')
- self.add_song_from_service = Settings().value(self.settings_section + '/add song from service',)
+ self.add_song_from_service = Settings().value(self.settings_section + '/add song from service')
+ self.display_songbook = Settings().value(self.settings_section + '/display songbook')
def retranslateUi(self):
self.search_text_label.setText('%s:' % UiStrings().Search)
@@ -234,8 +235,7 @@ class SongMediaItem(MediaManagerItem):
if song.temporary:
continue
author_list = [author.display_name for author in song.authors]
- song_title = str(song.title)
- song_detail = '%s (%s)' % (song_title, create_separated_list(author_list))
+ song_detail = '%s (%s)' % (song.title, create_separated_list(author_list)) if author_list else song.title
song_name = QtGui.QListWidgetItem(song_detail)
song_name.setData(QtCore.Qt.UserRole, song.id)
self.list_view.addItem(song_name)
@@ -464,23 +464,55 @@ class SongMediaItem(MediaManagerItem):
def generate_footer(self, item, song):
"""
Generates the song footer based on a song and adds details to a service item.
- author_list is only required for initial song generation.
:param item: The service item to be amended
:param song: The song to be used to generate the footer
+ :return: List of all authors (only required for initial song generation)
"""
- author_list = [str(author.display_name) for author in song.authors]
+ authors_words = []
+ authors_music = []
+ authors_words_music = []
+ authors_translation = []
+ authors_none = []
+ for author_song in song.authors_songs:
+ if author_song.author_type == AuthorType.Words:
+ authors_words.append(author_song.author.display_name)
+ elif author_song.author_type == AuthorType.Music:
+ authors_music.append(author_song.author.display_name)
+ elif author_song.author_type == AuthorType.WordsAndMusic:
+ authors_words_music.append(author_song.author.display_name)
+ elif author_song.author_type == AuthorType.Translation:
+ authors_translation.append(author_song.author.display_name)
+ else:
+ authors_none.append(author_song.author.display_name)
+ authors_all = authors_words_music + authors_words + authors_music + authors_translation + authors_none
item.audit = [
- song.title, author_list, song.copyright, str(song.ccli_number)
+ song.title, authors_all, song.copyright, str(song.ccli_number)
]
item.raw_footer = []
item.raw_footer.append(song.title)
- item.raw_footer.append(create_separated_list(author_list))
+ if authors_none:
+ item.raw_footer.append("%s: %s" % (translate('OpenLP.Ui', 'Written by'),
+ create_separated_list(authors_none)))
+ if authors_words_music:
+ item.raw_footer.append("%s: %s" % (AuthorType.Types[AuthorType.WordsAndMusic],
+ create_separated_list(authors_words_music)))
+ if authors_words:
+ item.raw_footer.append("%s: %s" % (AuthorType.Types[AuthorType.Words],
+ create_separated_list(authors_words)))
+ if authors_music:
+ item.raw_footer.append("%s: %s" % (AuthorType.Types[AuthorType.Music],
+ create_separated_list(authors_music)))
+ if authors_translation:
+ item.raw_footer.append("%s: %s" % (AuthorType.Types[AuthorType.Translation],
+ create_separated_list(authors_translation)))
item.raw_footer.append(song.copyright)
+ if self.display_songbook and song.book:
+ item.raw_footer.append("%s #%s" % (song.book.name, song.song_number))
if Settings().value('core/ccli number'):
item.raw_footer.append(translate('SongsPlugin.MediaItem',
'CCLI License: ') + Settings().value('core/ccli number'))
- return author_list
+ return authors_all
def service_load(self, item):
"""
@@ -489,29 +521,13 @@ class SongMediaItem(MediaManagerItem):
log.debug('service_load')
if self.plugin.status != PluginStatus.Active or not item.data_string:
return
- if item.data_string['title'].find('@') == -1:
- # FIXME: This file seems to be an old one (prior to 1.9.5), which means, that the search title
- # (data_string[u'title']) is probably wrong. We add "@" to search title and hope that we do not add any
- # duplicate. This should work for songs without alternate title.
- temp = (re.compile(r'\W+', re.UNICODE).sub(' ', item.data_string['title'].strip()) + '@').strip().lower()
- search_results = \
- self.plugin.manager.get_all_objects(Song, Song.search_title == temp, Song.search_title.asc())
- else:
- search_results = self.plugin.manager.get_all_objects(
- Song, Song.search_title == item.data_string['title'], Song.search_title.asc())
+ search_results = self.plugin.manager.get_all_objects(
+ Song, Song.search_title == item.data_string['title'], Song.search_title.asc())
edit_id = 0
add_song = True
if search_results:
for song in search_results:
- author_list = item.data_string['authors']
- same_authors = True
- for author in song.authors:
- if author.display_name in author_list:
- author_list = author_list.replace(author.display_name, '', 1)
- else:
- same_authors = False
- break
- if same_authors and author_list.strip(', ') == '':
+ if self._authors_match(song, item.data_string['authors']):
add_song = False
edit_id = song.id
break
@@ -537,6 +553,23 @@ class SongMediaItem(MediaManagerItem):
self.generate_footer(item, song)
return item
+ def _authors_match(self, song, authors):
+ """
+ Checks whether authors from a song in the database match the authors of the song to be imported.
+
+ :param song: A list of authors from the song in the database
+ :param authors: A string with authors from the song to be imported
+ :return: True when Authors do match, else False.
+ """
+ author_list = authors.split(', ')
+ for author in song.authors:
+ if author.display_name in author_list:
+ author_list.remove(author.display_name)
+ else:
+ return False
+ # List must be empty at the end
+ return not author_list
+
def search(self, string, show_error):
"""
Search for some songs
diff --git a/openlp/plugins/songs/lib/openlyricsexport.py b/openlp/plugins/songs/lib/openlyricsexport.py
index 72210e89f..0458b893b 100644
--- a/openlp/plugins/songs/lib/openlyricsexport.py
+++ b/openlp/plugins/songs/lib/openlyricsexport.py
@@ -37,7 +37,7 @@ from lxml import etree
from openlp.core.common import RegistryProperties, check_directory_exists, translate
from openlp.core.utils import clean_filename
-from openlp.plugins.songs.lib.xml import OpenLyrics
+from openlp.plugins.songs.lib.openlyricsxml import OpenLyrics
log = logging.getLogger(__name__)
diff --git a/openlp/plugins/songs/lib/xml.py b/openlp/plugins/songs/lib/openlyricsxml.py
similarity index 96%
rename from openlp/plugins/songs/lib/xml.py
rename to openlp/plugins/songs/lib/openlyricsxml.py
index d516b5e02..9458d6180 100644
--- a/openlp/plugins/songs/lib/xml.py
+++ b/openlp/plugins/songs/lib/openlyricsxml.py
@@ -71,7 +71,7 @@ from lxml import etree, objectify
from openlp.core.common import translate
from openlp.core.lib import FormattingTags
from openlp.plugins.songs.lib import VerseType, clean_song
-from openlp.plugins.songs.lib.db import Author, Book, Song, Topic
+from openlp.plugins.songs.lib.db import Author, AuthorType, Book, Song, Topic
from openlp.core.utils import get_application_version
log = logging.getLogger(__name__)
@@ -166,7 +166,7 @@ class OpenLyrics(object):
supported by the :class:`OpenLyrics` class:
````
- OpenLP does not support the attribute *type* and *lang*.
+ OpenLP does not support the attribute *lang*.
````
This property is not supported.
@@ -269,10 +269,18 @@ class OpenLyrics(object):
'verseOrder', properties, song.verse_order.lower())
if song.ccli_number:
self._add_text_to_element('ccliNo', properties, song.ccli_number)
- if song.authors:
+ if song.authors_songs:
authors = etree.SubElement(properties, 'authors')
- for author in song.authors:
- self._add_text_to_element('author', authors, author.display_name)
+ for author_song in song.authors_songs:
+ element = self._add_text_to_element('author', authors, author_song.author.display_name)
+ if author_song.author_type:
+ # Handle the special case 'words+music': Need to create two separate authors for that
+ if author_song.author_type == AuthorType.WordsAndMusic:
+ element.set('type', AuthorType.Words)
+ element = self._add_text_to_element('author', authors, author_song.author.display_name)
+ element.set('type', AuthorType.Music)
+ else:
+ element.set('type', author_song.author_type)
book = self.manager.get_object_filtered(Book, Book.id == song.song_book_id)
if book is not None:
book = book.name
@@ -302,9 +310,9 @@ class OpenLyrics(object):
verse_tag = verse[0]['type'][0].lower()
verse_number = verse[0]['label']
verse_def = verse_tag + verse_number
- verse_tags.append(verse_def)
# Create the letter from the number of duplicates
- verse[0]['suffix'] = chr(96 + verse_tags.count(verse_def))
+ verse[0][u'suffix'] = chr(97 + (verse_tags.count(verse_def) % 26))
+ verse_tags.append(verse_def)
# If the verse tag is a duplicate use the suffix letter
for verse in verse_list:
verse_tag = verse[0]['type'][0].lower()
@@ -336,7 +344,7 @@ class OpenLyrics(object):
"""
Tests the given text for not closed formatting tags and returns a tuple consisting of two unicode strings::
- (u'{st}{r}', u'{/r}{/st}')
+ ('{st}{r}', '{/r}{/st}')
The first unicode string are the start tags (for the next slide). The second unicode string are the end tags.
@@ -501,16 +509,17 @@ class OpenLyrics(object):
if hasattr(properties, 'authors'):
for author in properties.authors.author:
display_name = self._text(author)
+ author_type = author.get('type', '')
if display_name:
- authors.append(display_name)
- for display_name in authors:
+ authors.append((display_name, author_type))
+ for (display_name, author_type) in authors:
author = self.manager.get_object_filtered(Author, Author.display_name == display_name)
if author is None:
# We need to create a new author, as the author does not exist.
author = Author.populate(display_name=display_name,
last_name=display_name.split(' ')[-1],
first_name=' '.join(display_name.split(' ')[:-1]))
- song.authors.append(author)
+ song.add_author(author, author_type)
def _process_cclinumber(self, properties, song):
"""
@@ -652,7 +661,7 @@ class OpenLyrics(object):
# OpenLyrics 0.8 uses for new lines. Append text from "lines" element to verse text.
if version > '0.7':
text = self._process_lines_mixed_content(element)
- # OpenLyrics version <= 0.7 contais elements to represent lines. First child element is tested.
+ # OpenLyrics version <= 0.7 contains elements to represent lines. First child element is tested.
else:
# Loop over the "line" elements removing comments and chords.
for line in element:
diff --git a/openlp/plugins/songs/lib/songselect.py b/openlp/plugins/songs/lib/songselect.py
index a18b08c8a..61b02a66e 100644
--- a/openlp/plugins/songs/lib/songselect.py
+++ b/openlp/plugins/songs/lib/songselect.py
@@ -38,7 +38,7 @@ from html.parser import HTMLParser
from bs4 import BeautifulSoup, NavigableString
from openlp.plugins.songs.lib import Song, VerseType, clean_song, Author
-from openlp.plugins.songs.lib.xml import SongXML
+from openlp.plugins.songs.lib.openlyricsxml import SongXML
USER_AGENT = 'Mozilla/5.0 (Linux; U; Android 4.0.3; en-us; GT-I9000 ' \
'Build/IML74K) AppleWebKit/534.30 (KHTML, like Gecko) Version/4.0 ' \
@@ -146,14 +146,14 @@ class SongSelectImport(object):
try:
song_page = BeautifulSoup(self.opener.open(song['link']).read(), 'lxml')
except (TypeError, HTTPError) as e:
- log.exception(u'Could not get song from SongSelect, %s', e)
+ log.exception('Could not get song from SongSelect, %s', e)
return None
if callback:
callback()
try:
lyrics_page = BeautifulSoup(self.opener.open(song['link'] + '/lyrics').read(), 'lxml')
except (TypeError, HTTPError):
- log.exception(u'Could not get lyrics from SongSelect')
+ log.exception('Could not get lyrics from SongSelect')
return None
if callback:
callback()
@@ -196,13 +196,13 @@ class SongSelectImport(object):
db_song.lyrics = song_xml.extract_xml()
clean_song(self.db_manager, db_song)
self.db_manager.save_object(db_song)
- db_song.authors = []
+ db_song.authors_songs = []
for author_name in song['authors']:
author = self.db_manager.get_object_filtered(Author, Author.display_name == author_name)
if not author:
author = Author.populate(first_name=author_name.rsplit(' ', 1)[0],
last_name=author_name.rsplit(' ', 1)[1],
display_name=author_name)
- db_song.authors.append(author)
+ db_song.add_author(author)
self.db_manager.save_object(db_song)
return db_song
diff --git a/openlp/plugins/songs/lib/songstab.py b/openlp/plugins/songs/lib/songstab.py
index bf74a4e7c..1cf06d047 100644
--- a/openlp/plugins/songs/lib/songstab.py
+++ b/openlp/plugins/songs/lib/songstab.py
@@ -59,6 +59,9 @@ class SongsTab(SettingsTab):
self.add_from_service_check_box = QtGui.QCheckBox(self.mode_group_box)
self.add_from_service_check_box.setObjectName('add_from_service_check_box')
self.mode_layout.addWidget(self.add_from_service_check_box)
+ self.display_songbook_check_box = QtGui.QCheckBox(self.mode_group_box)
+ self.display_songbook_check_box.setObjectName('songbook_check_box')
+ self.mode_layout.addWidget(self.display_songbook_check_box)
self.left_layout.addWidget(self.mode_group_box)
self.left_layout.addStretch()
self.right_layout.addStretch()
@@ -66,6 +69,7 @@ class SongsTab(SettingsTab):
self.tool_bar_active_check_box.stateChanged.connect(self.on_tool_bar_active_check_box_changed)
self.update_on_edit_check_box.stateChanged.connect(self.on_update_on_edit_check_box_changed)
self.add_from_service_check_box.stateChanged.connect(self.on_add_from_service_check_box_changed)
+ self.display_songbook_check_box.stateChanged.connect(self.on_songbook_check_box_changed)
def retranslateUi(self):
self.mode_group_box.setTitle(translate('SongsPlugin.SongsTab', 'Songs Mode'))
@@ -75,6 +79,7 @@ class SongsTab(SettingsTab):
self.update_on_edit_check_box.setText(translate('SongsPlugin.SongsTab', 'Update service from song edit'))
self.add_from_service_check_box.setText(translate('SongsPlugin.SongsTab',
'Import missing songs from service files'))
+ self.display_songbook_check_box.setText(translate('SongsPlugin.SongsTab', 'Display songbook in footer'))
def on_search_as_type_check_box_changed(self, check_state):
self.song_search = (check_state == QtCore.Qt.Checked)
@@ -88,6 +93,9 @@ class SongsTab(SettingsTab):
def on_add_from_service_check_box_changed(self, check_state):
self.update_load = (check_state == QtCore.Qt.Checked)
+ def on_songbook_check_box_changed(self, check_state):
+ self.display_songbook = (check_state == QtCore.Qt.Checked)
+
def load(self):
settings = Settings()
settings.beginGroup(self.settings_section)
@@ -95,10 +103,12 @@ class SongsTab(SettingsTab):
self.tool_bar = settings.value('display songbar')
self.update_edit = settings.value('update service on edit')
self.update_load = settings.value('add song from service')
+ self.display_songbook = settings.value('display songbook')
self.search_as_type_check_box.setChecked(self.song_search)
self.tool_bar_active_check_box.setChecked(self.tool_bar)
self.update_on_edit_check_box.setChecked(self.update_edit)
self.add_from_service_check_box.setChecked(self.update_load)
+ self.display_songbook_check_box.setChecked(self.display_songbook)
settings.endGroup()
def save(self):
@@ -108,6 +118,7 @@ class SongsTab(SettingsTab):
settings.setValue('display songbar', self.tool_bar)
settings.setValue('update service on edit', self.update_edit)
settings.setValue('add song from service', self.update_load)
+ settings.setValue('display songbook', self.display_songbook)
settings.endGroup()
if self.tab_visited:
self.settings_form.register_post_process('songs_config_updated')
diff --git a/openlp/plugins/songs/lib/ui.py b/openlp/plugins/songs/lib/ui.py
index 14f4777c9..151b11b4b 100644
--- a/openlp/plugins/songs/lib/ui.py
+++ b/openlp/plugins/songs/lib/ui.py
@@ -40,7 +40,7 @@ class SongStrings(object):
# These strings should need a good reason to be retranslated elsewhere.
Author = translate('OpenLP.Ui', 'Author', 'Singular')
Authors = translate('OpenLP.Ui', 'Authors', 'Plural')
- AuthorUnknown = 'Author Unknown' # Used to populate the database.
+ AuthorUnknown = translate('OpenLP.Ui', 'Author Unknown') # Used to populate the database.
CopyrightSymbol = translate('OpenLP.Ui', '\xa9', 'Copyright symbol.')
SongBook = translate('OpenLP.Ui', 'Song Book', 'Singular')
SongBooks = translate('OpenLP.Ui', 'Song Books', 'Plural')
diff --git a/openlp/plugins/songs/lib/upgrade.py b/openlp/plugins/songs/lib/upgrade.py
index adb7d8af5..580ae767d 100644
--- a/openlp/plugins/songs/lib/upgrade.py
+++ b/openlp/plugins/songs/lib/upgrade.py
@@ -32,14 +32,14 @@ backend for the Songs plugin
"""
import logging
-from sqlalchemy import Column, types
+from sqlalchemy import Column, ForeignKey, types
from sqlalchemy.exc import OperationalError
from sqlalchemy.sql.expression import func, false, null, text
from openlp.core.lib.db import get_upgrade_op
log = logging.getLogger(__name__)
-__version__ = 3
+__version__ = 4
def upgrade_1(session, metadata):
@@ -97,3 +97,25 @@ def upgrade_3(session, metadata):
op.add_column('songs', Column('temporary', types.Boolean(), server_default=false()))
except OperationalError:
log.info('Upgrade 3 has already been run')
+
+
+def upgrade_4(session, metadata):
+ """
+ Version 4 upgrade.
+
+ This upgrade adds a column for author type to the authors_songs table
+ """
+ try:
+ # Since SQLite doesn't support changing the primary key of a table, we need to recreate the table
+ # and copy the old values
+ op = get_upgrade_op(session)
+ op.create_table('authors_songs_tmp',
+ Column('author_id', types.Integer(), ForeignKey('authors.id'), primary_key=True),
+ Column('song_id', types.Integer(), ForeignKey('songs.id'), primary_key=True),
+ Column('author_type', types.String(), primary_key=True,
+ nullable=False, server_default=text('""')))
+ op.execute('INSERT INTO authors_songs_tmp SELECT author_id, song_id, "" FROM authors_songs')
+ op.drop_table('authors_songs')
+ op.rename_table('authors_songs_tmp', 'authors_songs')
+ except OperationalError:
+ log.info('Upgrade 4 has already been run')
diff --git a/openlp/plugins/songs/songsplugin.py b/openlp/plugins/songs/songsplugin.py
index b1ddaf412..5cbedc994 100644
--- a/openlp/plugins/songs/songsplugin.py
+++ b/openlp/plugins/songs/songsplugin.py
@@ -49,7 +49,7 @@ from openlp.plugins.songs.lib import clean_song, upgrade
from openlp.plugins.songs.lib.db import init_schema, Song
from openlp.plugins.songs.lib.mediaitem import SongSearch
from openlp.plugins.songs.lib.importer import SongFormat
-from openlp.plugins.songs.lib.olpimport import OpenLPSongImport
+from openlp.plugins.songs.lib.importers.openlp import OpenLPSongImport
from openlp.plugins.songs.lib.mediaitem import SongMediaItem
from openlp.plugins.songs.lib.songstab import SongsTab
@@ -63,6 +63,7 @@ __default_settings__ = {
'songs/search as type': False,
'songs/add song from service': True,
'songs/display songbar': True,
+ 'songs/display songbook': False,
'songs/last directory import': '',
'songs/last directory export': '',
'songs/songselect username': '',
diff --git a/openlp/plugins/songusage/forms/songusagedeletedialog.py b/openlp/plugins/songusage/forms/songusagedeletedialog.py
index 01597a790..190292678 100644
--- a/openlp/plugins/songusage/forms/songusagedeletedialog.py
+++ b/openlp/plugins/songusage/forms/songusagedeletedialog.py
@@ -30,6 +30,7 @@
from PyQt4 import QtCore, QtGui
from openlp.core.common import translate
+from openlp.core.lib import build_icon
from openlp.core.lib.ui import create_button_box
@@ -44,6 +45,7 @@ class Ui_SongUsageDeleteDialog(object):
:param song_usage_delete_dialog:
"""
song_usage_delete_dialog.setObjectName('song_usage_delete_dialog')
+ song_usage_delete_dialog.setWindowIcon(build_icon(u':/icon/openlp-logo.svg'))
song_usage_delete_dialog.resize(291, 243)
self.vertical_layout = QtGui.QVBoxLayout(song_usage_delete_dialog)
self.vertical_layout.setSpacing(8)
diff --git a/openlp/plugins/songusage/forms/songusagedetaildialog.py b/openlp/plugins/songusage/forms/songusagedetaildialog.py
index ede5075a0..9431c7894 100644
--- a/openlp/plugins/songusage/forms/songusagedetaildialog.py
+++ b/openlp/plugins/songusage/forms/songusagedetaildialog.py
@@ -45,6 +45,7 @@ class Ui_SongUsageDetailDialog(object):
:param song_usage_detail_dialog:
"""
song_usage_detail_dialog.setObjectName('song_usage_detail_dialog')
+ song_usage_detail_dialog.setWindowIcon(build_icon(u':/icon/openlp-logo.svg'))
song_usage_detail_dialog.resize(609, 413)
self.vertical_layout = QtGui.QVBoxLayout(song_usage_detail_dialog)
self.vertical_layout.setSpacing(8)
diff --git a/resources/images/network_auth.png b/resources/images/network_auth.png
new file mode 100644
index 000000000..45e7a5c17
Binary files /dev/null and b/resources/images/network_auth.png differ
diff --git a/resources/images/network_server.png b/resources/images/network_server.png
new file mode 100644
index 000000000..25b95f3b0
Binary files /dev/null and b/resources/images/network_server.png differ
diff --git a/resources/images/network_ssl.png b/resources/images/network_ssl.png
new file mode 100644
index 000000000..1169de67a
Binary files /dev/null and b/resources/images/network_ssl.png differ
diff --git a/resources/images/openlp-2.qrc b/resources/images/openlp-2.qrc
index 6af0e77a5..79036f08f 100644
--- a/resources/images/openlp-2.qrc
+++ b/resources/images/openlp-2.qrc
@@ -149,6 +149,11 @@
messagebox_info.pngmessagebox_warning.png
+
+ network_server.png
+ network_ssl.png
+ network_auth.png
+ song_usage_active.pngsong_usage_inactive.png
diff --git a/resources/openlp.desktop b/resources/openlp.desktop
index b17cbaf96..9f92f9d87 100755
--- a/resources/openlp.desktop
+++ b/resources/openlp.desktop
@@ -1,19 +1,11 @@
[Desktop Entry]
Categories=AudioVideo;
-Comment[de]=
-Comment=
Exec=openlp %F
-GenericName[de]=Church lyrics projection
GenericName=Church lyrics projection
Icon=openlp
MimeType=application/x-openlp-service;
-Name[de]=OpenLP
Name=OpenLP
-Path=
StartupNotify=true
Terminal=false
Type=Application
-X-DBUS-ServiceName=
-X-DBUS-StartupType=
X-KDE-SubstituteUID=false
-X-KDE-Username=
diff --git a/scripts/jenkins_script.py b/scripts/jenkins_script.py
old mode 100644
new mode 100755
index aaee9a71b..eeafbfe23
--- a/scripts/jenkins_script.py
+++ b/scripts/jenkins_script.py
@@ -148,7 +148,7 @@ class JenkinsTrigger(object):
def get_repo_name():
"""
- This returns the name of branch of the wokring directory. For example it returns *lp:~googol/openlp/render*.
+ This returns the name of branch of the working directory. For example it returns *lp:~googol/openlp/render*.
"""
# Run the bzr command.
bzr = Popen(('bzr', 'info'), stdout=PIPE, stderr=PIPE)
@@ -198,7 +198,7 @@ def main():
jenkins_trigger = JenkinsTrigger(token)
try:
jenkins_trigger.trigger_build()
- except HTTPError as e:
+ except HTTPError:
print('Wrong token.')
return
# Open the browser before printing the output.
diff --git a/scripts/translation_utils.py b/scripts/translation_utils.py
index ad3edcaa3..0074109dd 100755
--- a/scripts/translation_utils.py
+++ b/scripts/translation_utils.py
@@ -63,7 +63,7 @@ import webbrowser
from optparse import OptionParser
from PyQt4 import QtCore
-SERVER_URL = 'http://www.transifex.net/api/2/project/openlp/'
+SERVER_URL = 'http://www.transifex.net/api/2/project/openlp/resource/openlp-22x/'
IGNORED_PATHS = ['scripts']
IGNORED_FILES = ['setup.py']
@@ -175,7 +175,7 @@ def run(command):
process = QtCore.QProcess()
process.start(command)
while process.waitForReadyRead():
- print_verbose('ReadyRead: %s' % QtCore.QString(process.readAll()))
+ print_verbose('ReadyRead: %s' % process.readAll())
print_verbose('Error(s):\n%s' % process.readAllStandardError())
print_verbose('Output:\n%s' % process.readAllStandardOutput())
@@ -193,27 +193,26 @@ def download_translations():
if not password:
password = getpass(' Transifex password: ')
# First get the list of languages
- url = SERVER_URL + 'resource/ents/'
- base64string = base64.encodbytes('%s:%s' % (username, password))[:-1]
- auth_header = 'Basic %s' % base64string
- request = urllib.request.Request(url + '?details')
+ base64string = base64.encodebytes(('%s:%s' % (username, password)).encode())[:-1]
+ auth_header = 'Basic %s' % base64string.decode()
+ request = urllib.request.Request(SERVER_URL + '?details')
request.add_header('Authorization', auth_header)
- print_verbose('Downloading list of languages from: %s' % url)
+ print_verbose('Downloading list of languages from: %s' % SERVER_URL)
try:
json_response = urllib.request.urlopen(request)
except urllib.error.HTTPError:
print_quiet('Username or password incorrect.')
return False
- json_dict = json.loads(json_response.read())
+ json_dict = json.loads(json_response.read().decode())
languages = [lang['code'] for lang in json_dict['available_languages']]
for language in languages:
- lang_url = url + 'translation/%s/?file' % language
+ lang_url = SERVER_URL + 'translation/%s/?file' % language
request = urllib.request.Request(lang_url)
request.add_header('Authorization', auth_header)
filename = os.path.join(os.path.abspath('..'), 'resources', 'i18n', language + '.ts')
print_verbose('Get Translation File: %s' % filename)
response = urllib.request.urlopen(request)
- fd = open(filename, 'w')
+ fd = open(filename, 'wb')
fd.write(response.read())
fd.close()
print_quiet(' Done.')
@@ -261,7 +260,7 @@ def prepare_project():
lines.append('TRANSLATIONS += %s' % line)
lines.sort()
file = open(os.path.join(start_dir, 'openlp.pro'), 'w')
- file.write('\n'.join(lines).encode('utf8'))
+ file.write('\n'.join(lines))
file.close()
print_quiet(' Done.')
diff --git a/setup.cfg b/setup.cfg
new file mode 100644
index 000000000..7b4bf5a3c
--- /dev/null
+++ b/setup.cfg
@@ -0,0 +1,3 @@
+[pep8]
+exclude=resources.py,vlc.py
+max-line-length = 120
diff --git a/setup.py b/setup.py
index fc4a6f89b..28f3658f1 100755
--- a/setup.py
+++ b/setup.py
@@ -105,10 +105,12 @@ try:
tag_version, tag_revision = tags[-1].split()
# If they are equal, then this tree is tarball with the source for the release. We do not want the revision number
# in the version string.
+ tree_revision = tree_revision.strip()
+ tag_revision = tag_revision.strip()
if tree_revision == tag_revision:
- version_string = tag_version
+ version_string = tag_version.decode('utf-8')
else:
- version_string = '%s-bzr%s' % (tag_version, tree_revision)
+ version_string = '%s-bzr%s' % (tag_version.decode('utf-8'), tree_revision.decode('utf-8'))
ver_file = open(VERSION_FILE, 'w')
ver_file.write(version_string)
except:
@@ -152,7 +154,7 @@ using a computer and a data projector.""",
'Operating System :: POSIX :: BSD :: FreeBSD',
'Operating System :: POSIX :: Linux',
'Programming Language :: Python',
- 'Programming Language :: Python :: 2',
+ 'Programming Language :: Python :: 3',
'Topic :: Desktop Environment :: Gnome',
'Topic :: Desktop Environment :: K Desktop Environment (KDE)',
'Topic :: Multimedia',
diff --git a/tests/functional/openlp_core_common/test_common.py b/tests/functional/openlp_core_common/test_common.py
index ab2d11b3a..f52256c5c 100644
--- a/tests/functional/openlp_core_common/test_common.py
+++ b/tests/functional/openlp_core_common/test_common.py
@@ -32,7 +32,7 @@ Functional tests to test the AppLocation class and related methods.
from unittest import TestCase
-from openlp.core.common import de_hump, trace_error_handler
+from openlp.core.common import check_directory_exists, de_hump, trace_error_handler, translate
from tests.functional import MagicMock, patch
@@ -40,6 +40,45 @@ class TestCommonFunctions(TestCase):
"""
A test suite to test out various functions in the openlp.core.common module.
"""
+ def check_directory_exists_test(self):
+ """
+ Test the check_directory_exists() function
+ """
+ with patch('openlp.core.lib.os.path.exists') as mocked_exists, \
+ patch('openlp.core.lib.os.makedirs') as mocked_makedirs:
+ # GIVEN: A directory to check and a mocked out os.makedirs and os.path.exists
+ directory_to_check = 'existing/directory'
+
+ # WHEN: os.path.exists returns True and we check to see if the directory exists
+ mocked_exists.return_value = True
+ check_directory_exists(directory_to_check)
+
+ # THEN: Only os.path.exists should have been called
+ mocked_exists.assert_called_with(directory_to_check)
+ self.assertIsNot(mocked_makedirs.called, 'os.makedirs should not have been called')
+
+ # WHEN: os.path.exists returns False and we check the directory exists
+ mocked_exists.return_value = False
+ check_directory_exists(directory_to_check)
+
+ # THEN: Both the mocked functions should have been called
+ mocked_exists.assert_called_with(directory_to_check)
+ mocked_makedirs.assert_called_with(directory_to_check)
+
+ # WHEN: os.path.exists raises an IOError
+ mocked_exists.side_effect = IOError()
+ check_directory_exists(directory_to_check)
+
+ # THEN: We shouldn't get an exception though the mocked exists has been called
+ mocked_exists.assert_called_with(directory_to_check)
+
+ # WHEN: Some other exception is raised
+ mocked_exists.side_effect = ValueError()
+
+ # THEN: check_directory_exists raises an exception
+ mocked_exists.assert_called_with(directory_to_check)
+ self.assertRaises(ValueError, check_directory_exists, directory_to_check)
+
def de_hump_conversion_test(self):
"""
Test the de_hump function with a class name
@@ -81,3 +120,22 @@ class TestCommonFunctions(TestCase):
# THEN: The mocked_logger.error() method should have been called with the correct parameters
mocked_logger.error.assert_called_with(
'OpenLP Error trace\n File openlp.fake at line 56 \n\t called trace_error_handler_test')
+
+ def translate_test(self):
+ """
+ Test the translate() function
+ """
+ # GIVEN: A string to translate and a mocked Qt translate function
+ context = 'OpenLP.Tests'
+ text = 'Untranslated string'
+ comment = 'A comment'
+ encoding = 1
+ n = 1
+ mocked_translate = MagicMock(return_value='Translated string')
+
+ # WHEN: we call the translate function
+ result = translate(context, text, comment, encoding, n, mocked_translate)
+
+ # THEN: the translated string should be returned, and the mocked function should have been called
+ mocked_translate.assert_called_with(context, text, comment, encoding, n)
+ self.assertEqual('Translated string', result, 'The translated string should have been returned')
diff --git a/tests/functional/openlp_core_common/test_registrymixin.py b/tests/functional/openlp_core_common/test_registrymixin.py
new file mode 100644
index 000000000..d8636ac94
--- /dev/null
+++ b/tests/functional/openlp_core_common/test_registrymixin.py
@@ -0,0 +1,76 @@
+# -*- coding: utf-8 -*-
+# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
+
+###############################################################################
+# OpenLP - Open Source Lyrics Projection #
+# --------------------------------------------------------------------------- #
+# Copyright (c) 2008-2014 Raoul Snyman #
+# Portions copyright (c) 2008-2014 Tim Bentley, Gerald Britton, Jonathan #
+# Corwin, Samuel Findlay, Michael Gorven, Scott Guerrieri, Matthias Hub, #
+# Meinert Jordan, Armin Köhler, Erik Lundin, Edwin Lunando, Brian T. Meyer. #
+# Joshua Miller, Stevan Pettit, Andreas Preikschat, Mattias Põldaru, #
+# Christian Richter, Philip Ridout, Simon Scudder, Jeffrey Smith, #
+# Maikel Stuivenberg, Martin Thompson, Jon Tibble, Dave Warnock, #
+# Frode Woldsund, Martin Zibricky, Patrick Zimmermann #
+# --------------------------------------------------------------------------- #
+# 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 #
+###############################################################################
+"""
+Package to test the openlp.core.common package.
+"""
+import os
+from unittest import TestCase
+
+from openlp.core.common import RegistryMixin, Registry
+
+TEST_PATH = os.path.abspath(os.path.join(os.path.dirname(__file__), '../', '..', 'resources'))
+
+
+class TestRegistryMixin(TestCase):
+
+ def registry_mixin_missing_test(self):
+ """
+ Test the registry creation and its usage
+ """
+ # GIVEN: A new registry
+ Registry.create()
+
+ # WHEN: I create a new class
+ mock_1 = Test1()
+
+ # THEN: The following methods are missing
+ self.assertEqual(len(Registry().functions_list), 0), 'The function should not be in the dict anymore.'
+
+ def registry_mixin_present_test(self):
+ """
+ Test the registry creation and its usage
+ """
+ # GIVEN: A new registry
+ Registry.create()
+
+ # WHEN: I create a new class
+ mock_2 = Test2()
+
+ # THEN: The following bootstrap methods should be present
+ self.assertEqual(len(Registry().functions_list), 2), 'The bootstrap functions should be in the dict.'
+
+
+class Test1(object):
+ def __init__(self):
+ pass
+
+
+class Test2(RegistryMixin):
+ def __init__(self):
+ super(Test2, self).__init__(None)
diff --git a/tests/functional/openlp_core_lib/test_file_dialog.py b/tests/functional/openlp_core_lib/test_file_dialog.py
index 3120f48fa..ab7663a83 100644
--- a/tests/functional/openlp_core_lib/test_file_dialog.py
+++ b/tests/functional/openlp_core_lib/test_file_dialog.py
@@ -53,8 +53,8 @@ class TestFileDialog(TestCase):
self.mocked_os.rest()
self.mocked_qt_gui.reset()
- # GIVEN: A List of known values as a return value from QFileDialog.getOpenFileNames and a list of valid
- # file names.
+ # GIVEN: A List of known values as a return value from QFileDialog.getOpenFileNames and a list of valid file
+ # names.
self.mocked_qt_gui.QFileDialog.getOpenFileNames.return_value = [
'/Valid File', '/url%20encoded%20file%20%231', '/non-existing']
self.mocked_os.path.exists.side_effect = lambda file_name: file_name in [
diff --git a/tests/functional/openlp_core_lib/test_lib.py b/tests/functional/openlp_core_lib/test_lib.py
index b4334a728..fca6f371d 100644
--- a/tests/functional/openlp_core_lib/test_lib.py
+++ b/tests/functional/openlp_core_lib/test_lib.py
@@ -36,9 +36,8 @@ from datetime import datetime, timedelta
from PyQt4 import QtCore, QtGui
-from openlp.core.common import check_directory_exists, translate
-from openlp.core.lib import str_to_bool, create_thumb, get_text_file_string, \
- build_icon, image_to_byte, check_item_selected, validate_thumb, create_separated_list, clean_tags, expand_tags
+from openlp.core.lib import build_icon, check_item_selected, clean_tags, create_thumb, create_separated_list, \
+ expand_tags, get_text_file_string, image_to_byte, resize_image, str_to_bool, validate_thumb
from tests.functional import MagicMock, patch
TEST_PATH = os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..', 'resources'))
@@ -152,64 +151,6 @@ class TestLib(TestCase):
# THEN: we should get back a true
self.assertTrue(str_result, 'The result should be True')
- def translate_test(self):
- """
- Test the translate() function
- """
- # GIVEN: A string to translate and a mocked Qt translate function
- context = 'OpenLP.Tests'
- text = 'Untranslated string'
- comment = 'A comment'
- encoding = 1
- n = 1
- mocked_translate = MagicMock(return_value='Translated string')
-
- # WHEN: we call the translate function
- result = translate(context, text, comment, encoding, n, mocked_translate)
-
- # THEN: the translated string should be returned, and the mocked function should have been called
- mocked_translate.assert_called_with(context, text, comment, encoding, n)
- self.assertEqual('Translated string', result, 'The translated string should have been returned')
-
- def check_directory_exists_test(self):
- """
- Test the check_directory_exists() function
- """
- with patch('openlp.core.lib.os.path.exists') as mocked_exists, \
- patch('openlp.core.lib.os.makedirs') as mocked_makedirs:
- # GIVEN: A directory to check and a mocked out os.makedirs and os.path.exists
- directory_to_check = 'existing/directory'
-
- # WHEN: os.path.exists returns True and we check to see if the directory exists
- mocked_exists.return_value = True
- check_directory_exists(directory_to_check)
-
- # THEN: Only os.path.exists should have been called
- mocked_exists.assert_called_with(directory_to_check)
- self.assertIsNot(mocked_makedirs.called, 'os.makedirs should not have been called')
-
- # WHEN: os.path.exists returns False and we check the directory exists
- mocked_exists.return_value = False
- check_directory_exists(directory_to_check)
-
- # THEN: Both the mocked functions should have been called
- mocked_exists.assert_called_with(directory_to_check)
- mocked_makedirs.assert_called_with(directory_to_check)
-
- # WHEN: os.path.exists raises an IOError
- mocked_exists.side_effect = IOError()
- check_directory_exists(directory_to_check)
-
- # THEN: We shouldn't get an exception though the mocked exists has been called
- mocked_exists.assert_called_with(directory_to_check)
-
- # WHEN: Some other exception is raised
- mocked_exists.side_effect = ValueError()
-
- # THEN: check_directory_exists raises an exception
- mocked_exists.assert_called_with(directory_to_check)
- self.assertRaises(ValueError, check_directory_exists, directory_to_check)
-
def get_text_file_string_no_file_test(self):
"""
Test the get_text_file_string() function when a file does not exist
@@ -305,7 +246,7 @@ class TestLib(TestCase):
# WHEN: We convert an image to a byte array
result = image_to_byte(mocked_image)
- # THEN: We should receive a value of u'base64mock'
+ # THEN: We should receive a value of 'base64mock'
MockedQtCore.QByteArray.assert_called_with()
MockedQtCore.QBuffer.assert_called_with(mocked_byte_array)
mocked_buffer.open.assert_called_with('writeonly')
@@ -353,7 +294,7 @@ class TestLib(TestCase):
Test that the check_item_selected() function returns True when there are selected indexes
"""
# GIVEN: A mocked out QtGui module and a list widget with selected indexes
- MockedQtGui = patch('openlp.core.lib.QtGui')
+ mocked_QtGui = patch('openlp.core.lib.QtGui')
mocked_list_widget = MagicMock()
mocked_list_widget.selectedIndexes.return_value = True
message = 'message'
@@ -508,6 +449,27 @@ class TestLib(TestCase):
mocked_os.stat.assert_any_call(thumb_path)
assert result is False, 'The result should be False'
+ def resize_thumb_test(self):
+ """
+ Test the resize_thumb() function
+ """
+ # GIVEN: A path to an image.
+ image_path = os.path.join(TEST_PATH, 'church.jpg')
+ wanted_width = 777
+ wanted_height = 72
+ # We want the background to be white.
+ wanted_background_hex = '#FFFFFF'
+ wanted_background_rgb = QtGui.QColor(wanted_background_hex).rgb()
+
+ # WHEN: Resize the image and add a background.
+ image = resize_image(image_path, wanted_width, wanted_height, wanted_background_hex)
+
+ # THEN: Check if the size is correct and the background was set.
+ result_size = image.size()
+ self.assertEqual(wanted_height, result_size.height(), 'The image should have the requested height.')
+ self.assertEqual(wanted_width, result_size.width(), 'The image should have the requested width.')
+ self.assertEqual(image.pixel(0, 0), wanted_background_rgb, 'The background should be white.')
+
def create_separated_list_qlocate_test(self):
"""
Test the create_separated_list function using the Qt provided method
diff --git a/tests/functional/openlp_core_lib/test_renderer.py b/tests/functional/openlp_core_lib/test_renderer.py
index 8814a21a0..8df4816bb 100644
--- a/tests/functional/openlp_core_lib/test_renderer.py
+++ b/tests/functional/openlp_core_lib/test_renderer.py
@@ -65,16 +65,6 @@ class TestRenderer(TestCase):
"""
del self.screens
- def initial_renderer_test(self):
- """
- Test the initial renderer state
- """
- # GIVEN: A new renderer instance.
- renderer = Renderer()
- # WHEN: the default renderer is built.
- # THEN: The renderer should be a live controller.
- self.assertEqual(renderer.is_live, True, 'The base renderer should be a live controller')
-
def default_screen_layout_test(self):
"""
Test the default layout calculations
diff --git a/tests/functional/openlp_core_lib/test_ui.py b/tests/functional/openlp_core_lib/test_ui.py
index 025b1a638..591762947 100644
--- a/tests/functional/openlp_core_lib/test_ui.py
+++ b/tests/functional/openlp_core_lib/test_ui.py
@@ -82,6 +82,21 @@ class TestUi(TestCase):
self.assertEqual(1, len(btnbox.buttons()))
self.assertEqual(QtGui.QDialogButtonBox.HelpRole, btnbox.buttonRole(btnbox.buttons()[0]))
+ def test_create_horizontal_adjusting_combo_box(self):
+ """
+ Test creating a horizontal adjusting combo box
+ """
+ # GIVEN: A dialog
+ dialog = QtGui.QDialog()
+
+ # WHEN: We create the combobox
+ combo = create_horizontal_adjusting_combo_box(dialog, 'combo1')
+
+ # THEN: We should get a ComboBox
+ self.assertIsInstance(combo, QtGui.QComboBox)
+ self.assertEqual('combo1', combo.objectName())
+ self.assertEqual(QtGui.QComboBox.AdjustToMinimumContentsLength, combo.sizeAdjustPolicy())
+
def test_create_button(self):
"""
Test creating a button
@@ -114,38 +129,6 @@ class TestUi(TestCase):
self.assertEqual('my_btn', btn.objectName())
self.assertTrue(btn.isEnabled())
- def test_create_valign_selection_widgets(self):
- """
- Test creating a combo box for valign selection
- """
- # GIVEN: A dialog
- dialog = QtGui.QDialog()
-
- # WHEN: We create the widgets
- label, combo = create_valign_selection_widgets(dialog)
-
- # THEN: We should get a label and a combobox.
- self.assertEqual(translate('OpenLP.Ui', '&Vertical Align:'), label.text())
- self.assertIsInstance(combo, QtGui.QComboBox)
- self.assertEqual(combo, label.buddy())
- for text in [UiStrings().Top, UiStrings().Middle, UiStrings().Bottom]:
- self.assertTrue(combo.findText(text) >= 0)
-
- def test_create_horizontal_adjusting_combo_box(self):
- """
- Test creating a horizontal adjusting combo box
- """
- # GIVEN: A dialog
- dialog = QtGui.QDialog()
-
- # WHEN: We create the combobox
- combo = create_horizontal_adjusting_combo_box(dialog, 'combo1')
-
- # THEN: We should get a ComboBox
- self.assertIsInstance(combo, QtGui.QComboBox)
- self.assertEqual('combo1', combo.objectName())
- self.assertEqual(QtGui.QComboBox.AdjustToMinimumContentsLength, combo.sizeAdjustPolicy())
-
def test_create_action(self):
"""
Test creating an action
@@ -170,3 +153,92 @@ class TestUi(TestCase):
self.assertIsInstance(action.icon(), QtGui.QIcon)
self.assertEqual('my tooltip', action.toolTip())
self.assertEqual('my statustip', action.statusTip())
+
+ def test_create_checked_enabled_visible_action(self):
+ """
+ Test creating an action with the 'checked', 'enabled' and 'visible' properties.
+ """
+ # GIVEN: A dialog
+ dialog = QtGui.QDialog()
+
+ # WHEN: We create an action with some properties
+ action = create_action(dialog, 'my_action', checked=True, enabled=False, visible=False)
+
+ # THEN: These properties should be set
+ self.assertEqual(True, action.isChecked())
+ self.assertEqual(False, action.isEnabled())
+ self.assertEqual(False, action.isVisible())
+
+ def test_create_valign_selection_widgets(self):
+ """
+ Test creating a combo box for valign selection
+ """
+ # GIVEN: A dialog
+ dialog = QtGui.QDialog()
+
+ # WHEN: We create the widgets
+ label, combo = create_valign_selection_widgets(dialog)
+
+ # THEN: We should get a label and a combobox.
+ self.assertEqual(translate('OpenLP.Ui', '&Vertical Align:'), label.text())
+ self.assertIsInstance(combo, QtGui.QComboBox)
+ self.assertEqual(combo, label.buddy())
+ for text in [UiStrings().Top, UiStrings().Middle, UiStrings().Bottom]:
+ self.assertTrue(combo.findText(text) >= 0)
+
+ def test_find_and_set_in_combo_box(self):
+ """
+ Test finding a string in a combo box and setting it as the selected item if present
+ """
+ # GIVEN: A ComboBox
+ combo = QtGui.QComboBox()
+ combo.addItems(['One', 'Two', 'Three'])
+ combo.setCurrentIndex(1)
+
+ # WHEN: We call the method with a non-existing value and set_missing=False
+ find_and_set_in_combo_box(combo, 'Four', set_missing=False)
+
+ # THEN: The index should not have changed
+ self.assertEqual(1, combo.currentIndex())
+
+ # WHEN: We call the method with a non-existing value
+ find_and_set_in_combo_box(combo, 'Four')
+
+ # THEN: The index should have been reset
+ self.assertEqual(0, combo.currentIndex())
+
+ # WHEN: We call the method with the default behavior
+ find_and_set_in_combo_box(combo, 'Three')
+
+ # THEN: The index should have changed
+ self.assertEqual(2, combo.currentIndex())
+
+ def test_create_widget_action(self):
+ """
+ Test creating an action for a widget
+ """
+ # GIVEN: A button
+ button = QtGui.QPushButton()
+
+ # WHEN: We call the function
+ action = create_widget_action(button, 'some action')
+
+ # THEN: The action should be returned
+ self.assertIsInstance(action, QtGui.QAction)
+ self.assertEqual(action.objectName(), 'some action')
+
+ def test_set_case_insensitive_completer(self):
+ """
+ Test setting a case insensitive completer on a widget
+ """
+ # GIVEN: A QComboBox and a list of completion items
+ line_edit = QtGui.QLineEdit()
+ suggestions = ['one', 'Two', 'THRee', 'FOUR']
+
+ # WHEN: We call the function
+ set_case_insensitive_completer(suggestions, line_edit)
+
+ # THEN: The Combobox should have a completer which is case insensitive
+ completer = line_edit.completer()
+ self.assertIsInstance(completer, QtGui.QCompleter)
+ self.assertEqual(completer.caseSensitivity(), QtCore.Qt.CaseInsensitive)
diff --git a/tests/functional/openlp_core_ui/test_firsttimeform.py b/tests/functional/openlp_core_ui/test_firsttimeform.py
index 9fc6f5137..2e26c286a 100644
--- a/tests/functional/openlp_core_ui/test_firsttimeform.py
+++ b/tests/functional/openlp_core_ui/test_firsttimeform.py
@@ -31,12 +31,12 @@ Package to test the openlp.core.ui.firsttimeform package.
"""
from unittest import TestCase
-from tests.functional import MagicMock
-
-from tests.helpers.testmixin import TestMixin
from openlp.core.common import Registry
from openlp.core.ui.firsttimeform import FirstTimeForm
+from tests.functional import MagicMock
+from tests.helpers.testmixin import TestMixin
+
class TestFirstTimeForm(TestCase, TestMixin):
diff --git a/tests/functional/openlp_core_ui/test_mainwindow.py b/tests/functional/openlp_core_ui/test_mainwindow.py
index 0b17828b9..b348f8f80 100644
--- a/tests/functional/openlp_core_ui/test_mainwindow.py
+++ b/tests/functional/openlp_core_ui/test_mainwindow.py
@@ -34,6 +34,7 @@ import os
from unittest import TestCase
from openlp.core.ui.mainwindow import MainWindow
+from openlp.core.lib.ui import UiStrings
from openlp.core.common.registry import Registry
from tests.utils.constants import TEST_RESOURCES_PATH
from tests.helpers.testmixin import TestMixin
@@ -95,3 +96,41 @@ class TestMainWindow(TestCase, TestMixin):
# THEN the file should not be opened
assert not mocked_load_path.called, 'load_path should not have been called'
+
+ def main_window_title_test(self):
+ """
+ Test that running a new instance of OpenLP set the window title correctly
+ """
+ # GIVEN a newly opened OpenLP instance
+
+ # WHEN no changes are made to the service
+
+ # THEN the main window's title shoud be the same as the OLPV2x string in the UiStrings class
+ self.assertEqual(self.main_window.windowTitle(), UiStrings().OLPV2x,
+ 'The main window\'s title should be the same as the OLPV2x string in UiStrings class')
+
+ def set_service_modifed_test(self):
+ """
+ Test that when setting the service's title the main window's title is set correctly
+ """
+ # GIVEN a newly opened OpenLP instance
+
+ # WHEN set_service_modified is called with with the modified flag set true and a file name
+ self.main_window.set_service_modified(True, 'test.osz')
+
+ # THEN the main window's title should be set to the
+ self.assertEqual(self.main_window.windowTitle(), '%s - %s*' % (UiStrings().OLPV2x, 'test.osz'),
+ 'The main window\'s title should be set to " - test.osz*"')
+
+ def set_service_unmodified_test(self):
+ """
+ Test that when setting the service's title the main window's title is set correctly
+ """
+ # GIVEN a newly opened OpenLP instance
+
+ # WHEN set_service_modified is called with with the modified flag set False and a file name
+ self.main_window.set_service_modified(False, 'test.osz')
+
+ # THEN the main window's title should be set to the
+ self.assertEqual(self.main_window.windowTitle(), '%s - %s' % (UiStrings().OLPV2x, 'test.osz'),
+ 'The main window\'s title should be set to " - test.osz"')
diff --git a/tests/functional/openlp_core_ui/test_media.py b/tests/functional/openlp_core_ui/test_media.py
index d59690949..4c6fa7f86 100644
--- a/tests/functional/openlp_core_ui/test_media.py
+++ b/tests/functional/openlp_core_ui/test_media.py
@@ -125,4 +125,4 @@ class TestMedia(TestCase, TestMixin):
# THEN: the used_players should be an empty list, and the overridden player should be an empty string
self.assertEqual(['vlc', 'webkit', 'phonon'], used_players, 'Used players should be correct')
- self.assertEqual('vlc,webkit,phonon', overridden_player, 'Overridden player should be a string of players')
\ No newline at end of file
+ self.assertEqual('vlc,webkit,phonon', overridden_player, 'Overridden player should be a string of players')
diff --git a/tests/functional/openlp_core_ui/test_servicemanager.py b/tests/functional/openlp_core_ui/test_servicemanager.py
index 260f88b6b..2c76ed965 100644
--- a/tests/functional/openlp_core_ui/test_servicemanager.py
+++ b/tests/functional/openlp_core_ui/test_servicemanager.py
@@ -71,7 +71,21 @@ class TestServiceManager(TestCase):
service_manager._save_lite = False
service_manager.service_theme = 'test_theme'
service = service_manager.create_basic_service()[0]
- # THEN: The the controller should be registered in the registry.
+ # THEN: The controller should be registered in the registry.
self.assertNotEqual(service, None, 'The base service should be created')
self.assertEqual(service['openlp_core']['service-theme'], 'test_theme', 'The test theme should be saved')
self.assertEqual(service['openlp_core']['lite-service'], False, 'The lite service should be saved')
+
+ def supported_suffixes_test(self):
+ """
+ Test the create basic service array
+ """
+ # GIVEN: A new service manager instance.
+ service_manager = ServiceManager(None)
+ # WHEN: a suffix is added as an individual or a list.
+ service_manager.supported_suffixes('txt')
+ service_manager.supported_suffixes(['pptx', 'ppt'])
+ # THEN: The suffixes should be available to test.
+ self.assertEqual('txt' in service_manager.suffixes, True, 'The suffix txt should be in the list')
+ self.assertEqual('ppt' in service_manager.suffixes, True, 'The suffix ppt should be in the list')
+ self.assertEqual('pptx' in service_manager.suffixes, True, 'The suffix pptx should be in the list')
diff --git a/tests/functional/openlp_core_ui/test_slidecontroller.py b/tests/functional/openlp_core_ui/test_slidecontroller.py
index 56d87c511..104c83750 100644
--- a/tests/functional/openlp_core_ui/test_slidecontroller.py
+++ b/tests/functional/openlp_core_ui/test_slidecontroller.py
@@ -33,7 +33,7 @@ from unittest import TestCase
from openlp.core.ui import SlideController
-from tests.interfaces import MagicMock, patch
+from tests.interfaces import MagicMock
class TestSlideController(TestCase):
diff --git a/tests/functional/openlp_core_utils/test_actions.py b/tests/functional/openlp_core_utils/test_actions.py
index 2868f8555..4958c4677 100644
--- a/tests/functional/openlp_core_utils/test_actions.py
+++ b/tests/functional/openlp_core_utils/test_actions.py
@@ -35,9 +35,107 @@ from PyQt4 import QtGui, QtCore
from openlp.core.common import Settings
from openlp.core.utils import ActionList
+from openlp.core.utils.actions import CategoryActionList
+from tests.functional import MagicMock
from tests.helpers.testmixin import TestMixin
+class TestCategoryActionList(TestCase):
+ def setUp(self):
+ """
+ Create an instance and a few example actions.
+ """
+ self.action1 = MagicMock()
+ self.action1.text.return_value = 'first'
+ self.action2 = MagicMock()
+ self.action2.text.return_value = 'second'
+ self.list = CategoryActionList()
+
+ def tearDown(self):
+ """
+ Clean up
+ """
+ del self.list
+
+ def contains_test(self):
+ """
+ Test the __contains__() method
+ """
+ # GIVEN: The list.
+ # WHEN: Add an action
+ self.list.append(self.action1)
+
+ # THEN: The actions should (not) be in the list.
+ self.assertTrue(self.action1 in self.list)
+ self.assertFalse(self.action2 in self.list)
+
+ def len_test(self):
+ """
+ Test the __len__ method
+ """
+ # GIVEN: The list.
+ # WHEN: Do nothing.
+ # THEN: Check the length.
+ self.assertEqual(len(self.list), 0, "The length should be 0.")
+
+ # GIVEN: The list.
+ # WHEN: Append an action.
+ self.list.append(self.action1)
+
+ # THEN: Check the length.
+ self.assertEqual(len(self.list), 1, "The length should be 1.")
+
+ def append_test(self):
+ """
+ Test the append() method
+ """
+ # GIVEN: The list.
+ # WHEN: Append an action.
+ self.list.append(self.action1)
+ self.list.append(self.action2)
+
+ # THEN: Check if the actions are in the list and check if they have the correct weights.
+ self.assertTrue(self.action1 in self.list)
+ self.assertTrue(self.action2 in self.list)
+ self.assertEqual(self.list.actions[0], (0, self.action1))
+ self.assertEqual(self.list.actions[1], (1, self.action2))
+
+ def add_test(self):
+ """
+ Test the add() method
+ """
+ # GIVEN: The list and weights.
+ action1_weight = 42
+ action2_weight = 41
+
+ # WHEN: Add actions and their weights.
+ self.list.add(self.action1, action1_weight)
+ self.list.add(self.action2, action2_weight)
+
+ # THEN: Check if they were added and have the specified weights.
+ self.assertTrue(self.action1 in self.list)
+ self.assertTrue(self.action2 in self.list)
+ # Now check if action1 is second and action2 is first (due to their weights).
+ self.assertEqual(self.list.actions[0], (41, self.action2))
+ self.assertEqual(self.list.actions[1], (42, self.action1))
+
+ def remove_test(self):
+ """
+ Test the remove() method
+ """
+ # GIVEN: The list
+ self.list.append(self.action1)
+
+ # WHEN: Delete an item from the list.
+ self.list.remove(self.action1)
+
+ # THEN: Now the element should not be in the list anymore.
+ self.assertFalse(self.action1 in self.list)
+
+ # THEN: Check if an exception is raised when trying to remove a not present action.
+ self.assertRaises(ValueError, self.list.remove, self.action2)
+
+
class TestActionList(TestCase, TestMixin):
"""
Test the ActionList class
diff --git a/tests/functional/openlp_core_utils/test_utils.py b/tests/functional/openlp_core_utils/test_utils.py
index a97d757ea..075ecb14f 100644
--- a/tests/functional/openlp_core_utils/test_utils.py
+++ b/tests/functional/openlp_core_utils/test_utils.py
@@ -250,7 +250,7 @@ class TestUtils(TestCase):
# THEN: The user agent is a Linux (or ChromeOS) user agent
result = 'Linux' in user_agent or 'CrOS' in user_agent
- self.assertTrue(result, u'The user agent should be a valid Linux user agent')
+ self.assertTrue(result, 'The user agent should be a valid Linux user agent')
def get_user_agent_windows_test(self):
"""
@@ -265,7 +265,7 @@ class TestUtils(TestCase):
user_agent = _get_user_agent()
# THEN: The user agent is a Linux (or ChromeOS) user agent
- self.assertIn('Windows', user_agent, u'The user agent should be a valid Windows user agent')
+ self.assertIn('Windows', user_agent, 'The user agent should be a valid Windows user agent')
def get_user_agent_macos_test(self):
"""
@@ -280,7 +280,7 @@ class TestUtils(TestCase):
user_agent = _get_user_agent()
# THEN: The user agent is a Linux (or ChromeOS) user agent
- self.assertIn('Mac OS X', user_agent, u'The user agent should be a valid OS X user agent')
+ self.assertIn('Mac OS X', user_agent, 'The user agent should be a valid OS X user agent')
def get_user_agent_default_test(self):
"""
@@ -295,7 +295,7 @@ class TestUtils(TestCase):
user_agent = _get_user_agent()
# THEN: The user agent is a Linux (or ChromeOS) user agent
- self.assertIn('NetBSD', user_agent, u'The user agent should be the default user agent')
+ self.assertIn('NetBSD', user_agent, 'The user agent should be the default user agent')
def get_web_page_no_url_test(self):
"""
diff --git a/tests/functional/openlp_plugins/bibles/test_opensongimport.py b/tests/functional/openlp_plugins/bibles/test_opensongimport.py
new file mode 100644
index 000000000..542cf289d
--- /dev/null
+++ b/tests/functional/openlp_plugins/bibles/test_opensongimport.py
@@ -0,0 +1,140 @@
+# -*- coding: utf-8 -*-
+# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
+
+###############################################################################
+# OpenLP - Open Source Lyrics Projection #
+# --------------------------------------------------------------------------- #
+# Copyright (c) 2008-2014 Raoul Snyman #
+# Portions copyright (c) 2008-2014 Tim Bentley, Gerald Britton, Jonathan #
+# Corwin, Samuel Findlay, Michael Gorven, Scott Guerrieri, Matthias Hub, #
+# Meinert Jordan, Armin Köhler, Erik Lundin, Edwin Lunando, Brian T. Meyer. #
+# Joshua Miller, Stevan Pettit, Andreas Preikschat, Mattias Põldaru, #
+# Christian Richter, Philip Ridout, Simon Scudder, Jeffrey Smith, #
+# Maikel Stuivenberg, Martin Thompson, Jon Tibble, Dave Warnock, #
+# Frode Woldsund, Martin Zibricky, Patrick Zimmermann #
+# --------------------------------------------------------------------------- #
+# 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 OpenSong Bible importer.
+"""
+
+import os
+from unittest import TestCase
+
+from tests.functional import MagicMock, patch
+from openlp.plugins.bibles.lib.opensong import OpenSongBible
+from openlp.plugins.bibles.lib.db import BibleDB
+
+TEST_PATH = os.path.abspath(os.path.join(os.path.dirname(__file__),
+ '..', '..', '..', 'resources', 'bibles'))
+OPENSONG_TEST_DATA = {
+ 'opensong-dk1933.xml': {
+ 'book': 'Genesis',
+ 'chapter': 1,
+ 'verses': [
+ (1, 'I Begyndelsen skabte Gud Himmelen og Jorden.'),
+ (2, 'Og Jorden var øde og tom, og der var Mørke over Verdensdybet. '
+ 'Men Guds Ånd svævede over Vandene.'),
+ (3, 'Og Gud sagde: "Der blive Lys!" Og der blev Lys.'),
+ (4, 'Og Gud så, at Lyset var godt, og Gud satte Skel mellem Lyset og Mørket,'),
+ (5, 'og Gud kaldte Lyset Dag, og Mørket kaldte han Nat. Og det blev Aften, '
+ 'og det blev Morgen, første Dag.'),
+ (6, 'Derpå sagde Gud: "Der blive en Hvælving midt i Vandene til at skille Vandene ad!"'),
+ (7, 'Og således skete det: Gud gjorde Hvælvingen og skilte Vandet under Hvælvingen '
+ 'fra Vandet over Hvælvingen;'),
+ (8, 'og Gud kaldte Hvælvingen Himmel. Og det blev Aften, og det blev Morgen, anden Dag.'),
+ (9, 'Derpå sagde Gud: "Vandet under Himmelen samle sig på eet Sted, så det faste Land kommer til Syne!" '
+ 'Og således skete det;'),
+ (10, 'og Gud kaldte det faste Land Jord, og Stedet, hvor Vandet samlede sig, kaldte han Hav. Og Gud så, '
+ 'at det var godt.')
+ ]
+ }
+}
+
+
+class TestOpenSongImport(TestCase):
+ """
+ Test the functions in the :mod:`opensongimport` 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 OpenSong file importer
+ """
+ # GIVEN: A mocked out "manager"
+ mocked_manager = MagicMock()
+
+ # WHEN: An importer object is created
+ importer = OpenSongBible(mocked_manager, path='.', name='.', filename='')
+
+ # THEN: The importer should be an instance of BibleDB
+ self.assertIsInstance(importer, BibleDB)
+
+ def file_import_test(self):
+ """
+ Test the actual import of real song files
+ """
+ # 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.
+ with patch('openlp.plugins.bibles.lib.opensong.OpenSongBible.application'):
+ for bible_file in OPENSONG_TEST_DATA:
+ mocked_manager = MagicMock()
+ mocked_import_wizard = MagicMock()
+ importer = OpenSongBible(mocked_manager, path='.', name='.', filename='')
+ importer.wizard = mocked_import_wizard
+ importer.get_book_ref_id_by_name = MagicMock()
+ importer.create_verse = MagicMock()
+ importer.create_book = MagicMock()
+ importer.session = MagicMock()
+ importer.get_language = MagicMock()
+ importer.get_language.return_value = 'Danish'
+
+ # WHEN: Importing bible file
+ importer.filename = os.path.join(TEST_PATH, 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 OPENSONG_TEST_DATA[bible_file]['verses']:
+ importer.create_verse.assert_any_call(importer.create_book().id, 1, verse_tag, verse_text)
+
+ def zefania_import_error_test(self):
+ """
+ Test that we give an error message if trying to import a zefania bible
+ """
+ # GIVEN: A mocked out "manager" and mocked out critical_error_message_box and an import
+ with patch('openlp.plugins.bibles.lib.opensong.critical_error_message_box') as \
+ mocked_critical_error_message_box:
+ mocked_manager = MagicMock()
+ importer = OpenSongBible(mocked_manager, path='.', name='.', filename='')
+
+ # WHEN: An trying to import a zefania bible
+ importer.filename = os.path.join(TEST_PATH, 'zefania-dk1933.xml')
+ importer.do_import()
+
+ # THEN: The importer should have "shown" an error message
+ mocked_critical_error_message_box.assert_called_with(message='Incorrect Bible file type supplied. '
+ 'This looks like a Zefania XML bible, '
+ 'please use the Zefania import option.')
diff --git a/tests/functional/openlp_plugins/bibles/test_zefaniaimport.py b/tests/functional/openlp_plugins/bibles/test_zefaniaimport.py
new file mode 100644
index 000000000..50307b401
--- /dev/null
+++ b/tests/functional/openlp_plugins/bibles/test_zefaniaimport.py
@@ -0,0 +1,121 @@
+# -*- coding: utf-8 -*-
+# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
+
+###############################################################################
+# OpenLP - Open Source Lyrics Projection #
+# --------------------------------------------------------------------------- #
+# Copyright (c) 2008-2014 Raoul Snyman #
+# Portions copyright (c) 2008-2014 Tim Bentley, Gerald Britton, Jonathan #
+# Corwin, Samuel Findlay, Michael Gorven, Scott Guerrieri, Matthias Hub, #
+# Meinert Jordan, Armin Köhler, Erik Lundin, Edwin Lunando, Brian T. Meyer. #
+# Joshua Miller, Stevan Pettit, Andreas Preikschat, Mattias Põldaru, #
+# Christian Richter, Philip Ridout, Simon Scudder, Jeffrey Smith, #
+# Maikel Stuivenberg, Martin Thompson, Jon Tibble, Dave Warnock, #
+# Frode Woldsund, Martin Zibricky, Patrick Zimmermann #
+# --------------------------------------------------------------------------- #
+# 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 Zefania Bible importer.
+"""
+
+import os
+from unittest import TestCase
+
+from tests.functional import MagicMock, patch
+from openlp.plugins.bibles.lib.zefania import ZefaniaBible
+from openlp.plugins.bibles.lib.db import BibleDB
+
+TEST_PATH = os.path.abspath(os.path.join(os.path.dirname(__file__),
+ '..', '..', '..', 'resources', 'bibles'))
+ZEFANIA_TEST_DATA = {
+ 'zefania-dk1933.xml': {
+ 'book': 'Genesis',
+ 'chapter': 1,
+ 'verses': [
+ ('1', 'I Begyndelsen skabte Gud Himmelen og Jorden.'),
+ ('2', 'Og Jorden var øde og tom, og der var Mørke over Verdensdybet. '
+ 'Men Guds Ånd svævede over Vandene.'),
+ ('3', 'Og Gud sagde: "Der blive Lys!" Og der blev Lys.'),
+ ('4', 'Og Gud så, at Lyset var godt, og Gud satte Skel mellem Lyset og Mørket,'),
+ ('5', 'og Gud kaldte Lyset Dag, og Mørket kaldte han Nat. Og det blev Aften, '
+ 'og det blev Morgen, første Dag.'),
+ ('6', 'Derpå sagde Gud: "Der blive en Hvælving midt i Vandene til at skille Vandene ad!"'),
+ ('7', 'Og således skete det: Gud gjorde Hvælvingen og skilte Vandet under Hvælvingen '
+ 'fra Vandet over Hvælvingen;'),
+ ('8', 'og Gud kaldte Hvælvingen Himmel. Og det blev Aften, og det blev Morgen, anden Dag.'),
+ ('9', 'Derpå sagde Gud: "Vandet under Himmelen samle sig på eet Sted, så det faste Land kommer til Syne!" '
+ 'Og således skete det;'),
+ ('10', 'og Gud kaldte det faste Land Jord, og Stedet, hvor Vandet samlede sig, kaldte han Hav. Og Gud så, '
+ 'at det var godt.')
+ ]
+ }
+}
+
+
+class TestZefaniaImport(TestCase):
+ """
+ Test the functions in the :mod:`zefaniaimport` 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 Zefania file importer
+ """
+ # GIVEN: A mocked out "manager"
+ mocked_manager = MagicMock()
+
+ # WHEN: An importer object is created
+ importer = ZefaniaBible(mocked_manager, path='.', name='.', filename='')
+
+ # THEN: The importer should be an instance of BibleDB
+ self.assertIsInstance(importer, BibleDB)
+
+ def file_import_test(self):
+ """
+ Test the actual import of real song files
+ """
+ # 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.
+ with patch('openlp.plugins.bibles.lib.zefania.ZefaniaBible.application'):
+ for bible_file in ZEFANIA_TEST_DATA:
+ mocked_manager = MagicMock()
+ mocked_import_wizard = MagicMock()
+ importer = ZefaniaBible(mocked_manager, path='.', name='.', filename='')
+ importer.wizard = mocked_import_wizard
+ importer.get_book_ref_id_by_name = MagicMock()
+ importer.create_verse = MagicMock()
+ importer.create_book = MagicMock()
+ importer.session = MagicMock()
+ importer.get_language = MagicMock()
+ importer.get_language.return_value = 'Danish'
+
+ # WHEN: Importing bible file
+ importer.filename = os.path.join(TEST_PATH, 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 ZEFANIA_TEST_DATA[bible_file]['verses']:
+ importer.create_verse.assert_any_call(importer.create_book().id, '1', verse_tag, verse_text)
diff --git a/tests/functional/openlp_plugins/presentations/test_powerpointcontroller.py b/tests/functional/openlp_plugins/presentations/test_powerpointcontroller.py
index 2ecdd65d7..8326eb7e7 100644
--- a/tests/functional/openlp_plugins/presentations/test_powerpointcontroller.py
+++ b/tests/functional/openlp_plugins/presentations/test_powerpointcontroller.py
@@ -29,89 +29,179 @@
"""
Functional tests to test the PowerPointController class and related methods.
"""
-from unittest import TestCase
import os
-from tests.functional import patch, MagicMock
-from openlp.plugins.presentations.lib.powerpointcontroller import \
- PowerpointController, PowerpointDocument, _get_text_from_shapes
+if os.name == 'nt':
+ import pywintypes
+import shutil
+from unittest import TestCase
+from tempfile import mkdtemp
-TEST_PATH = os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..', '..', 'resources'))
+from tests.functional import patch, MagicMock
+from tests.helpers.testmixin import TestMixin
+from tests.utils.constants import TEST_RESOURCES_PATH
+
+from openlp.plugins.presentations.lib.powerpointcontroller import PowerpointController, PowerpointDocument,\
+ _get_text_from_shapes
-class TestLibModule(TestCase):
+class TestPowerpointController(TestCase, TestMixin):
+ """
+ Test the PowerpointController Class
+ """
def setUp(self):
- mocked_plugin = MagicMock()
- mocked_plugin.settings_section = 'presentations'
- self.ppc = PowerpointController(mocked_plugin)
- self.file_name = os.path.join(TEST_PATH, "test.pptx")
- self.doc = PowerpointDocument(self.ppc, self.file_name)
-
- # add _test to the name to enable
- def verify_installation(self):
"""
- Test the installation of Powerpoint
+ Set up the patches and mocks need for all tests.
"""
- # GIVEN: A boolean value set to true
- # WHEN: We "convert" it to a bool
- is_installed = self.ppc.check_available()
+ self.get_application()
+ self.build_settings()
+ self.mock_plugin = MagicMock()
+ self.temp_folder = mkdtemp()
+ self.mock_plugin.settings_section = self.temp_folder
- # THEN: We should get back a True bool
- self.assertEqual(is_installed, True, 'The result should be True')
+ def tearDown(self):
+ """
+ Stop the patches
+ """
+ self.destroy_settings()
+ shutil.rmtree(self.temp_folder)
+
+ def constructor_test(self):
+ """
+ Test the Constructor from the PowerpointController
+ """
+ # GIVEN: No presentation controller
+ controller = None
+
+ # WHEN: The presentation controller object is created
+ controller = PowerpointController(plugin=self.mock_plugin)
+
+ # THEN: The name of the presentation controller should be correct
+ self.assertEqual('Powerpoint', controller.name,
+ 'The name of the presentation controller should be correct')
+
+
+class TestPowerpointDocument(TestCase, TestMixin):
+ """
+ Test the PowerpointDocument Class
+ """
+
+ def setUp(self):
+ """
+ Set up the patches and mocks need for all tests.
+ """
+ self.get_application()
+ self.build_settings()
+ self.mock_plugin = MagicMock()
+ self.temp_folder = mkdtemp()
+ self.mock_plugin.settings_section = self.temp_folder
+ self.powerpoint_document_stop_presentation_patcher = patch(
+ 'openlp.plugins.presentations.lib.powerpointcontroller.PowerpointDocument.stop_presentation')
+ self.presentation_document_get_temp_folder_patcher = patch(
+ 'openlp.plugins.presentations.lib.powerpointcontroller.PresentationDocument.get_temp_folder')
+ self.presentation_document_setup_patcher = patch(
+ 'openlp.plugins.presentations.lib.powerpointcontroller.PresentationDocument._setup')
+ self.mock_powerpoint_document_stop_presentation = self.powerpoint_document_stop_presentation_patcher.start()
+ self.mock_presentation_document_get_temp_folder = self.presentation_document_get_temp_folder_patcher.start()
+ self.mock_presentation_document_setup = self.presentation_document_setup_patcher.start()
+ self.mock_controller = MagicMock()
+ self.mock_presentation = MagicMock()
+ self.mock_presentation_document_get_temp_folder.return_value = 'temp folder'
+ self.file_name = os.path.join(TEST_RESOURCES_PATH, "test.pptx")
+ self.real_controller = PowerpointController(self.mock_plugin)
+
+ def tearDown(self):
+ """
+ Stop the patches
+ """
+ self.powerpoint_document_stop_presentation_patcher.stop()
+ self.presentation_document_get_temp_folder_patcher.stop()
+ self.presentation_document_setup_patcher.stop()
+ self.destroy_settings()
+ shutil.rmtree(self.temp_folder)
+
+ def show_error_msg_test(self):
+ """
+ Test the PowerpointDocument.show_error_msg() method gets called on com exception
+ """
+ if os.name == 'nt':
+ # GIVEN: A PowerpointDocument with mocked controller and presentation
+ with patch('openlp.plugins.presentations.lib.powerpointcontroller.critical_error_message_box') as \
+ mocked_critical_error_message_box:
+ instance = PowerpointDocument(self.mock_controller, self.mock_presentation)
+ instance.presentation = MagicMock()
+ instance.presentation.SlideShowWindow.View.GotoSlide = MagicMock(side_effect=pywintypes.com_error('1'))
+
+ # WHEN: Calling goto_slide which will throw an exception
+ instance.goto_slide(42)
+
+ # THEN: mocked_critical_error_message_box should have been called
+ mocked_critical_error_message_box.assert_called_with('Error', 'An error occurred in the Powerpoint '
+ 'integration and the presentation will be stopped.'
+ ' Restart the presentation if you wish to '
+ 'present it.')
# add _test to the following if necessary
def verify_loading_document(self):
"""
Test loading a document in PowerPoint
- """
- # GIVEN: the filename
- print(self.file_name)
+ """
+ if os.name == 'nt' and self.real_controller.check_available():
+ # GIVEN: A PowerpointDocument and a presentation
+ doc = PowerpointDocument(self.real_controller, self.file_name)
- # WHEN: loading the filename
- self.doc = PowerpointDocument(self.ppc, self.file_name)
- self.doc.load_presentation()
- result = self.doc.is_loaded()
+ # WHEN: loading the filename
+ doc.load_presentation()
+ result = doc.is_loaded()
- # THEN: result should be true
- self.assertEqual(result, True, 'The result should be True')
+ # THEN: result should be true
+ self.assertEqual(result, True, 'The result should be True')
+ else:
+ self.skipTest('Powerpoint not available, skipping test.')
def create_titles_and_notes_test(self):
"""
Test creating the titles from PowerPoint
"""
- # GIVEN: mocked save_titles_and_notes, _get_text_from_shapes and two mocked slides
- self.doc = PowerpointDocument(self.ppc, self.file_name)
- self.doc.save_titles_and_notes = MagicMock()
- self.doc._PowerpointDocument__get_text_from_shapes = MagicMock()
- slide = MagicMock()
- slide.Shapes.Title.TextFrame.TextRange.Text = 'SlideText'
- pres = MagicMock()
- pres.Slides = [slide, slide]
- self.doc.presentation = pres
+ if os.name == 'nt' and self.real_controller.check_available():
+ # GIVEN: mocked save_titles_and_notes, _get_text_from_shapes and two mocked slides
+ self.doc = PowerpointDocument(self.real_controller, self.file_name)
+ self.doc.save_titles_and_notes = MagicMock()
+ self.doc._PowerpointDocument__get_text_from_shapes = MagicMock()
+ slide = MagicMock()
+ slide.Shapes.Title.TextFrame.TextRange.Text = 'SlideText'
+ pres = MagicMock()
+ pres.Slides = [slide, slide]
+ self.doc.presentation = pres
- # WHEN reading the titles and notes
- self.doc.create_titles_and_notes()
+ # WHEN reading the titles and notes
+ self.doc.create_titles_and_notes()
- # THEN the save should have been called exactly once with 2 titles and 2 notes
- self.doc.save_titles_and_notes.assert_called_once_with(['SlideText\n', 'SlideText\n'], [' ', ' '])
+ # THEN the save should have been called exactly once with 2 titles and 2 notes
+ self.doc.save_titles_and_notes.assert_called_once_with(['SlideText\n', 'SlideText\n'], [' ', ' '])
+ else:
+ self.skipTest('Powerpoint not available, skipping test.')
def create_titles_and_notes_with_no_slides_test(self):
"""
Test creating the titles from PowerPoint when it returns no slides
"""
- # GIVEN: mocked save_titles_and_notes, _get_text_from_shapes and two mocked slides
- self.doc = PowerpointDocument(self.ppc, self.file_name)
- self.doc.save_titles_and_notes = MagicMock()
- self.doc._PowerpointDocument__get_text_from_shapes = MagicMock()
- pres = MagicMock()
- pres.Slides = []
- self.doc.presentation = pres
+ if os.name == 'nt' and self.real_controller.check_available():
+ # GIVEN: mocked save_titles_and_notes, _get_text_from_shapes and two mocked slides
+ doc = PowerpointDocument(self.real_controller, self.file_name)
+ doc.save_titles_and_notes = MagicMock()
+ doc._PowerpointDocument__get_text_from_shapes = MagicMock()
+ pres = MagicMock()
+ pres.Slides = []
+ doc.presentation = pres
- # WHEN reading the titles and notes
- self.doc.create_titles_and_notes()
+ # WHEN reading the titles and notes
+ doc.create_titles_and_notes()
- # THEN the save should have been called exactly once with empty titles and notes
- self.doc.save_titles_and_notes.assert_called_once_with([], [])
+ # THEN the save should have been called exactly once with empty titles and notes
+ doc.save_titles_and_notes.assert_called_once_with([], [])
+ else:
+ self.skipTest('Powerpoint not available, skipping test.')
def get_text_from_shapes_test(self):
"""
diff --git a/tests/functional/openlp_plugins/presentations/test_powerpointcontroller.py.moved b/tests/functional/openlp_plugins/presentations/test_powerpointcontroller.py.moved
new file mode 100644
index 000000000..2ecdd65d7
--- /dev/null
+++ b/tests/functional/openlp_plugins/presentations/test_powerpointcontroller.py.moved
@@ -0,0 +1,144 @@
+# -*- coding: utf-8 -*-
+# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
+
+###############################################################################
+# OpenLP - Open Source Lyrics Projection #
+# --------------------------------------------------------------------------- #
+# Copyright (c) 2008-2014 Raoul Snyman #
+# Portions copyright (c) 2008-2014 Tim Bentley, Gerald Britton, Jonathan #
+# Corwin, Samuel Findlay, Michael Gorven, Scott Guerrieri, Matthias Hub, #
+# Meinert Jordan, Armin Köhler, Erik Lundin, Edwin Lunando, Brian T. Meyer. #
+# Joshua Miller, Stevan Pettit, Andreas Preikschat, Mattias Põldaru, #
+# Christian Richter, Philip Ridout, Simon Scudder, Jeffrey Smith, #
+# Maikel Stuivenberg, Martin Thompson, Jon Tibble, Dave Warnock, #
+# Frode Woldsund, Martin Zibricky, Patrick Zimmermann #
+# --------------------------------------------------------------------------- #
+# 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 #
+###############################################################################
+"""
+Functional tests to test the PowerPointController class and related methods.
+"""
+from unittest import TestCase
+import os
+from tests.functional import patch, MagicMock
+from openlp.plugins.presentations.lib.powerpointcontroller import \
+ PowerpointController, PowerpointDocument, _get_text_from_shapes
+
+TEST_PATH = os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..', '..', 'resources'))
+
+
+class TestLibModule(TestCase):
+
+ def setUp(self):
+ mocked_plugin = MagicMock()
+ mocked_plugin.settings_section = 'presentations'
+ self.ppc = PowerpointController(mocked_plugin)
+ self.file_name = os.path.join(TEST_PATH, "test.pptx")
+ self.doc = PowerpointDocument(self.ppc, self.file_name)
+
+ # add _test to the name to enable
+ def verify_installation(self):
+ """
+ Test the installation of Powerpoint
+ """
+ # GIVEN: A boolean value set to true
+ # WHEN: We "convert" it to a bool
+ is_installed = self.ppc.check_available()
+
+ # THEN: We should get back a True bool
+ self.assertEqual(is_installed, True, 'The result should be True')
+
+ # add _test to the following if necessary
+ def verify_loading_document(self):
+ """
+ Test loading a document in PowerPoint
+ """
+ # GIVEN: the filename
+ print(self.file_name)
+
+ # WHEN: loading the filename
+ self.doc = PowerpointDocument(self.ppc, self.file_name)
+ self.doc.load_presentation()
+ result = self.doc.is_loaded()
+
+ # THEN: result should be true
+ self.assertEqual(result, True, 'The result should be True')
+
+ def create_titles_and_notes_test(self):
+ """
+ Test creating the titles from PowerPoint
+ """
+ # GIVEN: mocked save_titles_and_notes, _get_text_from_shapes and two mocked slides
+ self.doc = PowerpointDocument(self.ppc, self.file_name)
+ self.doc.save_titles_and_notes = MagicMock()
+ self.doc._PowerpointDocument__get_text_from_shapes = MagicMock()
+ slide = MagicMock()
+ slide.Shapes.Title.TextFrame.TextRange.Text = 'SlideText'
+ pres = MagicMock()
+ pres.Slides = [slide, slide]
+ self.doc.presentation = pres
+
+ # WHEN reading the titles and notes
+ self.doc.create_titles_and_notes()
+
+ # THEN the save should have been called exactly once with 2 titles and 2 notes
+ self.doc.save_titles_and_notes.assert_called_once_with(['SlideText\n', 'SlideText\n'], [' ', ' '])
+
+ def create_titles_and_notes_with_no_slides_test(self):
+ """
+ Test creating the titles from PowerPoint when it returns no slides
+ """
+ # GIVEN: mocked save_titles_and_notes, _get_text_from_shapes and two mocked slides
+ self.doc = PowerpointDocument(self.ppc, self.file_name)
+ self.doc.save_titles_and_notes = MagicMock()
+ self.doc._PowerpointDocument__get_text_from_shapes = MagicMock()
+ pres = MagicMock()
+ pres.Slides = []
+ self.doc.presentation = pres
+
+ # WHEN reading the titles and notes
+ self.doc.create_titles_and_notes()
+
+ # THEN the save should have been called exactly once with empty titles and notes
+ self.doc.save_titles_and_notes.assert_called_once_with([], [])
+
+ def get_text_from_shapes_test(self):
+ """
+ Test getting text from powerpoint shapes
+ """
+ # GIVEN: mocked shapes
+ shape = MagicMock()
+ shape.PlaceholderFormat.Type = 2
+ shape.HasTextFrame = shape.TextFrame.HasText = True
+ shape.TextFrame.TextRange.Text = 'slideText'
+ shapes = [shape, shape]
+
+ # WHEN: getting the text
+ result = _get_text_from_shapes(shapes)
+
+ # THEN: it should return the text
+ self.assertEqual(result, 'slideText\nslideText\n', 'result should match \'slideText\nslideText\n\'')
+
+ def get_text_from_shapes_with_no_shapes_test(self):
+ """
+ Test getting text from powerpoint shapes with no shapes
+ """
+ # GIVEN: empty shapes array
+ shapes = []
+
+ # WHEN: getting the text
+ result = _get_text_from_shapes(shapes)
+
+ # THEN: it should not fail but return empty string
+ self.assertEqual(result, '', 'result should be empty')
diff --git a/tests/functional/openlp_plugins/remotes/test_router.py b/tests/functional/openlp_plugins/remotes/test_router.py
index 8dcba2f79..a7e305ab4 100644
--- a/tests/functional/openlp_plugins/remotes/test_router.py
+++ b/tests/functional/openlp_plugins/remotes/test_router.py
@@ -94,15 +94,14 @@ class TestRouter(TestCase, TestMixin):
Test the router control functionality
"""
# GIVEN: A testing set of Routes
- router = HttpRouter()
mocked_function = MagicMock()
test_route = [
(r'^/stage/api/poll$', {'function': mocked_function, 'secure': False}),
]
- router.routes = test_route
+ self.router.routes = test_route
# WHEN: called with a poll route
- function, args = router.process_http_request('/stage/api/poll', None)
+ function, args = self.router.process_http_request('/stage/api/poll', None)
# THEN: the function should have been called only once
self.assertEqual(mocked_function, function['function'], 'The mocked function should match defined value.')
@@ -128,6 +127,25 @@ class TestRouter(TestCase, TestMixin):
# THEN: all types should match
self.assertEqual(content_type, header[1], 'Mismatch of content type')
+ def main_poll_test(self):
+ """
+ Test the main poll logic
+ """
+ # GIVEN: a defined router with two slides
+ Registry().register('live_controller', MagicMock)
+ router = HttpRouter()
+ router.send_response = MagicMock()
+ router.send_header = MagicMock()
+ router.end_headers = MagicMock()
+ router.live_controller.slide_count = 2
+
+ # WHEN: main poll called
+ results = router.main_poll()
+
+ # THEN: the correct response should be returned
+ self.assertEqual(results.decode('utf-8'), '{"results": {"slide_count": 2}}',
+ 'The resulting json strings should match')
+
def serve_file_without_params_test(self):
"""
Test the serve_file method without params
diff --git a/tests/functional/openlp_plugins/songs/test_db.py b/tests/functional/openlp_plugins/songs/test_db.py
new file mode 100644
index 000000000..3080db77e
--- /dev/null
+++ b/tests/functional/openlp_plugins/songs/test_db.py
@@ -0,0 +1,114 @@
+# -*- coding: utf-8 -*-
+# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
+
+###############################################################################
+# OpenLP - Open Source Lyrics Projection #
+# --------------------------------------------------------------------------- #
+# Copyright (c) 2008-2014 Raoul Snyman #
+# Portions copyright (c) 2008-2014 Tim Bentley, Gerald Britton, Jonathan #
+# Corwin, Samuel Findlay, Michael Gorven, Scott Guerrieri, Matthias Hub, #
+# Meinert Jordan, Armin Köhler, Erik Lundin, Edwin Lunando, Brian T. Meyer. #
+# Joshua Miller, Stevan Pettit, Andreas Preikschat, Mattias Põldaru, #
+# Christian Richter, Philip Ridout, Simon Scudder, Jeffrey Smith, #
+# Maikel Stuivenberg, Martin Thompson, Jon Tibble, Dave Warnock, #
+# Frode Woldsund, Martin Zibricky, Patrick Zimmermann #
+# --------------------------------------------------------------------------- #
+# 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 db submodule of the Songs plugin.
+"""
+from unittest import TestCase
+
+from openlp.plugins.songs.lib.db import Song, Author, AuthorType
+
+
+class TestDB(TestCase):
+ """
+ Test the functions in the :mod:`db` module.
+ """
+
+ def test_add_author(self):
+ """
+ Test adding an author to a song
+ """
+ # GIVEN: A song and an author
+ song = Song()
+ song.authors_songs = []
+ author = Author()
+ author.first_name = "Max"
+ author.last_name = "Mustermann"
+
+ # WHEN: We add an author to the song
+ song.add_author(author)
+
+ # THEN: The author should have been added with author_type=None
+ self.assertEqual(1, len(song.authors_songs))
+ self.assertEqual("Max", song.authors_songs[0].author.first_name)
+ self.assertEqual("Mustermann", song.authors_songs[0].author.last_name)
+ self.assertIsNone(song.authors_songs[0].author_type)
+
+ def test_add_author_with_type(self):
+ """
+ Test adding an author with a type specified to a song
+ """
+ # GIVEN: A song and an author
+ song = Song()
+ song.authors_songs = []
+ author = Author()
+ author.first_name = "Max"
+ author.last_name = "Mustermann"
+
+ # WHEN: We add an author to the song
+ song.add_author(author, AuthorType.Words)
+
+ # THEN: The author should have been added with author_type=None
+ self.assertEqual(1, len(song.authors_songs))
+ self.assertEqual("Max", song.authors_songs[0].author.first_name)
+ self.assertEqual("Mustermann", song.authors_songs[0].author.last_name)
+ self.assertEqual(AuthorType.Words, song.authors_songs[0].author_type)
+
+ def test_remove_author(self):
+ """
+ Test removing an author from a song
+ """
+ # GIVEN: A song with an author
+ song = Song()
+ song.authors_songs = []
+ author = Author()
+ song.add_author(author)
+
+ # WHEN: We remove the author
+ song.remove_author(author)
+
+ # THEN: It should have been removed
+ self.assertEqual(0, len(song.authors_songs))
+
+ def test_remove_author_with_type(self):
+ """
+ Test removing an author with a type specified from a song
+ """
+ # GIVEN: A song with two authors
+ song = Song()
+ song.authors_songs = []
+ author = Author()
+ song.add_author(author)
+ song.add_author(author, AuthorType.Translation)
+
+ # WHEN: We remove the author with a certain type
+ song.remove_author(author, AuthorType.Translation)
+
+ # THEN: It should have been removed and the other author should still be there
+ self.assertEqual(1, len(song.authors_songs))
+ self.assertEqual(None, song.authors_songs[0].author_type)
diff --git a/tests/functional/openlp_plugins/songs/test_ewimport.py b/tests/functional/openlp_plugins/songs/test_ewimport.py
index 182a6b04a..f441084e7 100644
--- a/tests/functional/openlp_plugins/songs/test_ewimport.py
+++ b/tests/functional/openlp_plugins/songs/test_ewimport.py
@@ -35,7 +35,7 @@ from unittest import TestCase
from tests.functional import MagicMock, patch
-from openlp.plugins.songs.lib.ewimport import EasyWorshipSongImport, FieldDescEntry, FieldType
+from openlp.plugins.songs.lib.importers.easyworship import EasyWorshipSongImport, FieldDescEntry, FieldType
TEST_PATH = os.path.abspath(
os.path.join(os.path.dirname(__file__), '..', '..', '..', 'resources', 'easyworshipsongs'))
@@ -67,7 +67,35 @@ SONG_TEST_DATA = [
'Just to learn from His lips, words of comfort,\nIn the beautiful garden of prayer.', 'v2'),
('There\'s a garden where Jesus is waiting,\nAnd He bids you to come meet Him there,\n'
'Just to bow and receive a new blessing,\nIn the beautiful garden of prayer.', 'v3')],
- 'verse_order_list': []}]
+ 'verse_order_list': []},
+ {'title': 'Vi pløjed og vi så\'de',
+ 'authors': ['Matthias Claudius'],
+ 'copyright': 'Public Domain',
+ 'ccli_number': 0,
+ 'verses':
+ [('Vi pløjed og vi så\'de\nvor sæd i sorten jord,\nså bad vi ham os hjælpe,\nsom højt i Himlen bor,\n'
+ 'og han lod snefald hegne\nmod frosten barsk og hård,\nhan lod det tø og regne\nog varme mildt i vår.',
+ 'v1'),
+ ('Alle gode gaver\nde kommer ovenned,\nså tak da Gud, ja, pris dog Gud\nfor al hans kærlighed!', 'c1'),
+ ('Han er jo den, hvis vilje\nopholder alle ting,\nhan klæder markens lilje\nog runder himlens ring,\n'
+ 'ham lyder vind og vove,\nham rører ravnes nød,\nhvi skulle ej hans småbørn\nda og få dagligt brød?', 'v2'),
+ ('Ja, tak, du kære Fader,\nså mild, så rig, så rund,\nfor korn i hæs og lader,\nfor godt i allen stund!\n'
+ 'Vi kan jo intet give,\nsom nogen ting er værd,\nmen tag vort stakkels hjerte,\nså ringe som det er!', 'v3')],
+ 'verse_order_list': []}]
+
+EWS_SONG_TEST_DATA =\
+ {'title': 'Vi pløjed og vi så\'de',
+ 'authors': ['Matthias Claudius'],
+ 'verses':
+ [('Vi pløjed og vi så\'de\nvor sæd i sorten jord,\nså bad vi ham os hjælpe,\nsom højt i Himlen bor,\n'
+ 'og han lod snefald hegne\nmod frosten barsk og hård,\nhan lod det tø og regne\nog varme mildt i vår.',
+ 'v1'),
+ ('Alle gode gaver\nde kommer ovenned,\nså tak da Gud, ja, pris dog Gud\nfor al hans kærlighed!', 'c1'),
+ ('Han er jo den, hvis vilje\nopholder alle ting,\nhan klæder markens lilje\nog runder himlens ring,\n'
+ 'ham lyder vind og vove,\nham rører ravnes nød,\nhvi skulle ej hans småbørn\nda og få dagligt brød?', 'v2'),
+ ('Ja, tak, du kære Fader,\nså mild, så rig, så rund,\nfor korn i hæs og lader,\nfor godt i allen stund!\n'
+ 'Vi kan jo intet give,\nsom nogen ting er værd,\nmen tag vort stakkels hjerte,\nså ringe som det er!',
+ 'v3')]}
class EasyWorshipSongImportLogger(EasyWorshipSongImport):
@@ -125,6 +153,7 @@ class TestEasyWorshipSongImport(TestCase):
"""
Test the functions in the :mod:`ewimport` module.
"""
+
def create_field_desc_entry_test(self):
"""
Test creating an instance of the :class`FieldDescEntry` class.
@@ -149,7 +178,7 @@ class TestEasyWorshipSongImport(TestCase):
Test creating an instance of the EasyWorship file importer
"""
# GIVEN: A mocked out SongImport class, and a mocked out "manager"
- with patch('openlp.plugins.songs.lib.ewimport.SongImport'):
+ with patch('openlp.plugins.songs.lib.importers.easyworship.SongImport'):
mocked_manager = MagicMock()
# WHEN: An importer object is created
@@ -163,7 +192,7 @@ class TestEasyWorshipSongImport(TestCase):
Test finding an existing field in a given list using the :mod:`find_field`
"""
# GIVEN: A mocked out SongImport class, a mocked out "manager" and a list of field descriptions.
- with patch('openlp.plugins.songs.lib.ewimport.SongImport'):
+ with patch('openlp.plugins.songs.lib.importers.easyworship.SongImport'):
mocked_manager = MagicMock()
importer = EasyWorshipSongImport(mocked_manager, filenames=[])
importer.field_descriptions = TEST_FIELD_DESCS
@@ -181,7 +210,7 @@ class TestEasyWorshipSongImport(TestCase):
Test finding an non-existing field in a given list using the :mod:`find_field`
"""
# GIVEN: A mocked out SongImport class, a mocked out "manager" and a list of field descriptions
- with patch('openlp.plugins.songs.lib.ewimport.SongImport'):
+ with patch('openlp.plugins.songs.lib.importers.easyworship.SongImport'):
mocked_manager = MagicMock()
importer = EasyWorshipSongImport(mocked_manager, filenames=[])
importer.field_descriptions = TEST_FIELD_DESCS
@@ -199,8 +228,8 @@ class TestEasyWorshipSongImport(TestCase):
"""
# GIVEN: A mocked out SongImport class, a mocked out struct class, and a mocked out "manager" and a list of
# field descriptions
- with patch('openlp.plugins.songs.lib.ewimport.SongImport'), \
- patch('openlp.plugins.songs.lib.ewimport.struct') as mocked_struct:
+ with patch('openlp.plugins.songs.lib.importers.easyworship.SongImport'), \
+ patch('openlp.plugins.songs.lib.importers.easyworship.struct') as mocked_struct:
mocked_manager = MagicMock()
importer = EasyWorshipSongImport(mocked_manager, filenames=[])
@@ -217,7 +246,7 @@ class TestEasyWorshipSongImport(TestCase):
Test the :mod:`get_field` module
"""
# GIVEN: A mocked out SongImport class, a mocked out "manager", an encoding and some test data and known results
- with patch('openlp.plugins.songs.lib.ewimport.SongImport'):
+ with patch('openlp.plugins.songs.lib.importers.easyworship.SongImport'):
mocked_manager = MagicMock()
importer = EasyWorshipSongImport(mocked_manager, filenames=[])
importer.encoding = TEST_DATA_ENCODING
@@ -240,7 +269,7 @@ class TestEasyWorshipSongImport(TestCase):
"""
for test_results in GET_MEMO_FIELD_TEST_RESULTS:
# GIVEN: A mocked out SongImport class, a mocked out "manager", a mocked out memo_file and an encoding
- with patch('openlp.plugins.songs.lib.ewimport.SongImport'):
+ with patch('openlp.plugins.songs.lib.importers.easyworship.SongImport'):
mocked_manager = MagicMock()
mocked_memo_file = MagicMock()
importer = EasyWorshipSongImport(mocked_manager, filenames=[])
@@ -271,8 +300,8 @@ class TestEasyWorshipSongImport(TestCase):
Test the :mod:`do_import` module opens the correct files
"""
# GIVEN: A mocked out SongImport class, a mocked out "manager"
- with patch('openlp.plugins.songs.lib.ewimport.SongImport'), \
- patch('openlp.plugins.songs.lib.ewimport.os.path') as mocked_os_path:
+ with patch('openlp.plugins.songs.lib.importers.easyworship.SongImport'), \
+ patch('openlp.plugins.songs.lib.importers.easyworship.os.path') as mocked_os_path:
mocked_manager = MagicMock()
importer = EasyWorshipSongImport(mocked_manager, filenames=[])
mocked_os_path.isfile.side_effect = [True, False]
@@ -285,13 +314,33 @@ class TestEasyWorshipSongImport(TestCase):
mocked_os_path.isfile.assert_any_call('Songs.DB')
mocked_os_path.isfile.assert_any_call('Songs.MB')
+ def do_import_source_invalid_test(self):
+ """
+ Test the :mod:`do_import` module produces an error when Songs.MB not found.
+ """
+ # GIVEN: A mocked out SongImport class, a mocked out "manager"
+ with patch('openlp.plugins.songs.lib.importers.easyworship.SongImport'), \
+ patch('openlp.plugins.songs.lib.importers.easyworship.os.path') as mocked_os_path:
+ mocked_manager = MagicMock()
+ importer = EasyWorshipSongImport(mocked_manager, filenames=[])
+ importer.log_error = MagicMock()
+ mocked_os_path.isfile.side_effect = [True, False]
+
+ # WHEN: do_import is supplied with an import source (Songs.MB missing)
+ importer.import_source = 'Songs.DB'
+ importer.do_import()
+
+ # THEN: do_import should have logged an error that the Songs.MB file could not be found.
+ importer.log_error.assert_any_call(importer.import_source, 'Could not find the "Songs.MB" file. It must be '
+ 'in the same folder as the "Songs.DB" file.')
+
def do_import_database_validity_test(self):
"""
Test the :mod:`do_import` module handles invalid database files correctly
"""
# GIVEN: A mocked out SongImport class, os.path and a mocked out "manager"
- with patch('openlp.plugins.songs.lib.ewimport.SongImport'), \
- patch('openlp.plugins.songs.lib.ewimport.os.path') as mocked_os_path:
+ with patch('openlp.plugins.songs.lib.importers.easyworship.SongImport'), \
+ patch('openlp.plugins.songs.lib.importers.easyworship.os.path') as mocked_os_path:
mocked_manager = MagicMock()
importer = EasyWorshipSongImport(mocked_manager, filenames=[])
mocked_os_path.isfile.return_value = True
@@ -309,10 +358,10 @@ class TestEasyWorshipSongImport(TestCase):
Test the :mod:`do_import` module handles invalid memo files correctly
"""
# GIVEN: A mocked out SongImport class, a mocked out "manager"
- with patch('openlp.plugins.songs.lib.ewimport.SongImport'), \
- patch('openlp.plugins.songs.lib.ewimport.os.path') as mocked_os_path, \
+ with patch('openlp.plugins.songs.lib.importers.easyworship.SongImport'), \
+ patch('openlp.plugins.songs.lib.importers.easyworship.os.path') as mocked_os_path, \
patch('builtins.open') as mocked_open, \
- patch('openlp.plugins.songs.lib.ewimport.struct') as mocked_struct:
+ patch('openlp.plugins.songs.lib.importers.easyworship.struct') as mocked_struct:
mocked_manager = MagicMock()
importer = EasyWorshipSongImport(mocked_manager, filenames=[])
mocked_os_path.isfile.return_value = True
@@ -336,10 +385,10 @@ class TestEasyWorshipSongImport(TestCase):
Test the :mod:`do_import` converts the code page to the encoding correctly
"""
# GIVEN: A mocked out SongImport class, a mocked out "manager"
- with patch('openlp.plugins.songs.lib.ewimport.SongImport'), \
- patch('openlp.plugins.songs.lib.ewimport.os.path') as mocked_os_path, \
- patch('builtins.open'), patch('openlp.plugins.songs.lib.ewimport.struct') as mocked_struct, \
- patch('openlp.plugins.songs.lib.ewimport.retrieve_windows_encoding') as \
+ with patch('openlp.plugins.songs.lib.importers.easyworship.SongImport'), \
+ patch('openlp.plugins.songs.lib.importers.easyworship.os.path') as mocked_os_path, \
+ patch('builtins.open'), patch('openlp.plugins.songs.lib.importers.easyworship.struct') as mocked_struct, \
+ patch('openlp.plugins.songs.lib.importers.easyworship.retrieve_windows_encoding') as \
mocked_retrieve_windows_encoding:
mocked_manager = MagicMock()
importer = EasyWorshipSongImport(mocked_manager, filenames=[])
@@ -357,15 +406,15 @@ class TestEasyWorshipSongImport(TestCase):
self.assertIsNone(importer.do_import(), 'do_import should return None when db_size is less than 0x800')
mocked_retrieve_windows_encoding.assert_call(encoding)
- def file_import_test(self):
+ def db_file_import_test(self):
"""
- Test the actual import of real song files and check that the imported data is correct.
+ Test the actual import of real song database files and check that the imported data is correct.
"""
# GIVEN: Test files with a mocked out SongImport class, a mocked out "manager", a mocked out "import_wizard",
# and mocked out "author", "add_copyright", "add_verse", "finish" methods.
- with patch('openlp.plugins.songs.lib.ewimport.SongImport'), \
- patch('openlp.plugins.songs.lib.ewimport.retrieve_windows_encoding') as \
+ with patch('openlp.plugins.songs.lib.importers.easyworship.SongImport'), \
+ patch('openlp.plugins.songs.lib.importers.easyworship.retrieve_windows_encoding') as \
mocked_retrieve_windows_encoding:
mocked_retrieve_windows_encoding.return_value = 'cp1252'
mocked_manager = MagicMock()
@@ -386,10 +435,11 @@ class TestEasyWorshipSongImport(TestCase):
# WHEN: Importing each file
importer.import_source = os.path.join(TEST_PATH, 'Songs.DB')
+ import_result = importer.do_import()
# THEN: do_import should return none, the song data should be as expected, and finish should have been
# called.
- self.assertIsNone(importer.do_import(), 'do_import should return None when it has completed')
+ self.assertIsNone(import_result, 'do_import should return None when it has completed')
for song_data in SONG_TEST_DATA:
title = song_data['title']
author_calls = song_data['authors']
@@ -411,3 +461,63 @@ class TestEasyWorshipSongImport(TestCase):
self.assertEqual(importer.verse_order_list, verse_order_list,
'verse_order_list for %s should be %s' % (title, verse_order_list))
mocked_finish.assert_called_with()
+
+ def ews_file_import_test(self):
+ """
+ Test the actual import of song from ews file and check that the imported data is correct.
+ """
+
+ # GIVEN: Test files with a mocked out SongImport class, a mocked out "manager", a mocked out "import_wizard",
+ # and mocked out "author", "add_copyright", "add_verse", "finish" methods.
+ with patch('openlp.plugins.songs.lib.importers.easyworship.SongImport'), \
+ patch('openlp.plugins.songs.lib.importers.easyworship.retrieve_windows_encoding') \
+ as mocked_retrieve_windows_encoding:
+ mocked_retrieve_windows_encoding.return_value = 'cp1252'
+ mocked_manager = MagicMock()
+ mocked_import_wizard = MagicMock()
+ mocked_add_author = MagicMock()
+ mocked_add_verse = MagicMock()
+ mocked_finish = MagicMock()
+ mocked_title = MagicMock()
+ mocked_finish.return_value = True
+ importer = EasyWorshipSongImportLogger(mocked_manager)
+ importer.import_wizard = mocked_import_wizard
+ importer.stop_import_flag = False
+ importer.add_author = mocked_add_author
+ importer.add_verse = mocked_add_verse
+ importer.title = mocked_title
+ importer.finish = mocked_finish
+ importer.topics = []
+
+ # WHEN: Importing ews file
+ importer.import_source = os.path.join(TEST_PATH, 'test1.ews')
+ import_result = importer.do_import()
+
+ # THEN: do_import should return none, the song data should be as expected, and finish should have been
+ # called.
+ title = EWS_SONG_TEST_DATA['title']
+ self.assertIsNone(import_result, 'do_import should return None when it has completed')
+ self.assertIn(title, importer._title_assignment_list, 'title for should be "%s"' % title)
+ mocked_add_author.assert_any_call(EWS_SONG_TEST_DATA['authors'][0])
+ for verse_text, verse_tag in EWS_SONG_TEST_DATA['verses']:
+ mocked_add_verse.assert_any_call(verse_text, verse_tag)
+ mocked_finish.assert_called_with()
+
+ def import_rtf_unescaped_unicode_test(self):
+ """
+ Test import of rtf without the expected escaping of unicode
+ """
+
+ # GIVEN: A mocked out SongImport class, a mocked out "manager" and mocked out "author" method.
+ with patch('openlp.plugins.songs.lib.importers.easyworship.SongImport'):
+ mocked_manager = MagicMock()
+ mocked_add_author = MagicMock()
+ importer = EasyWorshipSongImportLogger(mocked_manager)
+ importer.add_author = mocked_add_author
+ importer.encoding = 'cp1252'
+
+ # WHEN: running set_song_import_object on a verse string without the needed escaping
+ importer.set_song_import_object('Test Author', b'Det som var fr\x86n begynnelsen')
+
+ # THEN: The import should fail
+ self.assertEquals(importer.entry_error_log, 'Unexpected data formatting.', 'Import should fail')
diff --git a/tests/functional/openlp_plugins/songs/test_foilpresenterimport.py b/tests/functional/openlp_plugins/songs/test_foilpresenterimport.py
index 61206b9fa..3886443ca 100644
--- a/tests/functional/openlp_plugins/songs/test_foilpresenterimport.py
+++ b/tests/functional/openlp_plugins/songs/test_foilpresenterimport.py
@@ -34,7 +34,7 @@ import os
from unittest import TestCase
from tests.functional import patch, MagicMock
-from openlp.plugins.songs.lib.foilpresenterimport import FoilPresenter
+from openlp.plugins.songs.lib.importers.foilpresenter import FoilPresenter
TEST_PATH = os.path.abspath(
os.path.join(os.path.dirname(__file__), '..', '..', '..', '/resources/foilpresentersongs'))
@@ -57,27 +57,27 @@ class TestFoilPresenter(TestCase):
# _process_topics
def setUp(self):
- self.child_patcher = patch('openlp.plugins.songs.lib.foilpresenterimport.FoilPresenter._child')
- self.clean_song_patcher = patch('openlp.plugins.songs.lib.foilpresenterimport.clean_song')
- self.objectify_patcher = patch('openlp.plugins.songs.lib.foilpresenterimport.objectify')
+ self.child_patcher = patch('openlp.plugins.songs.lib.importers.foilpresenter.FoilPresenter._child')
+ self.clean_song_patcher = patch('openlp.plugins.songs.lib.importers.foilpresenter.clean_song')
+ self.objectify_patcher = patch('openlp.plugins.songs.lib.importers.foilpresenter.objectify')
self.process_authors_patcher = \
- patch('openlp.plugins.songs.lib.foilpresenterimport.FoilPresenter._process_authors')
+ patch('openlp.plugins.songs.lib.importers.foilpresenter.FoilPresenter._process_authors')
self.process_cclinumber_patcher = \
- patch('openlp.plugins.songs.lib.foilpresenterimport.FoilPresenter._process_cclinumber')
+ patch('openlp.plugins.songs.lib.importers.foilpresenter.FoilPresenter._process_cclinumber')
self.process_comments_patcher = \
- patch('openlp.plugins.songs.lib.foilpresenterimport.FoilPresenter._process_comments')
+ patch('openlp.plugins.songs.lib.importers.foilpresenter.FoilPresenter._process_comments')
self.process_lyrics_patcher = \
- patch('openlp.plugins.songs.lib.foilpresenterimport.FoilPresenter._process_lyrics')
+ patch('openlp.plugins.songs.lib.importers.foilpresenter.FoilPresenter._process_lyrics')
self.process_songbooks_patcher = \
- patch('openlp.plugins.songs.lib.foilpresenterimport.FoilPresenter._process_songbooks')
+ patch('openlp.plugins.songs.lib.importers.foilpresenter.FoilPresenter._process_songbooks')
self.process_titles_patcher = \
- patch('openlp.plugins.songs.lib.foilpresenterimport.FoilPresenter._process_titles')
+ patch('openlp.plugins.songs.lib.importers.foilpresenter.FoilPresenter._process_titles')
self.process_topics_patcher = \
- patch('openlp.plugins.songs.lib.foilpresenterimport.FoilPresenter._process_topics')
- self.re_patcher = patch('openlp.plugins.songs.lib.foilpresenterimport.re')
- self.song_patcher = patch('openlp.plugins.songs.lib.foilpresenterimport.Song')
- self.song_xml_patcher = patch('openlp.plugins.songs.lib.foilpresenterimport.SongXML')
- self.translate_patcher = patch('openlp.plugins.songs.lib.foilpresenterimport.translate')
+ patch('openlp.plugins.songs.lib.importers.foilpresenter.FoilPresenter._process_topics')
+ self.re_patcher = patch('openlp.plugins.songs.lib.importers.foilpresenter.re')
+ self.song_patcher = patch('openlp.plugins.songs.lib.importers.foilpresenter.Song')
+ self.song_xml_patcher = patch('openlp.plugins.songs.lib.importers.foilpresenter.SongXML')
+ self.translate_patcher = patch('openlp.plugins.songs.lib.importers.foilpresenter.translate')
self.mocked_child = self.child_patcher.start()
self.mocked_clean_song = self.clean_song_patcher.start()
diff --git a/tests/functional/openlp_plugins/songs/test_lib.py b/tests/functional/openlp_plugins/songs/test_lib.py
index b67c1a4be..140126f26 100644
--- a/tests/functional/openlp_plugins/songs/test_lib.py
+++ b/tests/functional/openlp_plugins/songs/test_lib.py
@@ -445,9 +445,9 @@ class TestVerseType(TestCase):
# THEN: The result should be VerseType.Chorus
self.assertEqual(result, VerseType.Chorus, 'The result should be VerseType.Chorus, but was "%s"' % result)
- def from_tag_with_invalid_default_test(self):
+ def from_tag_with_invalid_intdefault_test(self):
"""
- Test that the from_tag() method returns a sane default when passed an invalid tag and an invalid default.
+ Test that the from_tag() method returns a sane default when passed an invalid tag and an invalid int default.
"""
# GIVEN: A mocked out translate() function that just returns what it was given
with patch('openlp.plugins.songs.lib.translate') as mocked_translate:
@@ -458,3 +458,31 @@ class TestVerseType(TestCase):
# THEN: The result should be VerseType.Other
self.assertEqual(result, VerseType.Other, 'The result should be VerseType.Other, but was "%s"' % result)
+
+ def from_tag_with_invalid_default_test(self):
+ """
+ Test that the from_tag() method returns a sane default when passed an invalid tag and an invalid default.
+ """
+ # GIVEN: A mocked out translate() function that just returns what it was given
+ with patch('openlp.plugins.songs.lib.translate') as mocked_translate:
+ mocked_translate.side_effect = lambda x, y: y
+
+ # WHEN: We run the from_tag() method with an invalid verse type, we get the specified default back
+ result = VerseType.from_tag('@', 'asdf')
+
+ # THEN: The result should be VerseType.Other
+ self.assertEqual(result, VerseType.Other, 'The result should be VerseType.Other, but was "%s"' % result)
+
+ def from_tag_with_none_default_test(self):
+ """
+ Test that the from_tag() method returns a sane default when passed an invalid tag and None as default.
+ """
+ # GIVEN: A mocked out translate() function that just returns what it was given
+ with patch('openlp.plugins.songs.lib.translate') as mocked_translate:
+ mocked_translate.side_effect = lambda x, y: y
+
+ # WHEN: We run the from_tag() method with an invalid verse type, we get the specified default back
+ result = VerseType.from_tag('m', None)
+
+ # THEN: The result should be None
+ self.assertIsNone(result, 'The result should be None, but was "%s"' % result)
diff --git a/tests/functional/openlp_plugins/songs/test_mediaitem.py b/tests/functional/openlp_plugins/songs/test_mediaitem.py
index 2b5f02483..bc22a4577 100644
--- a/tests/functional/openlp_plugins/songs/test_mediaitem.py
+++ b/tests/functional/openlp_plugins/songs/test_mediaitem.py
@@ -1,8 +1,6 @@
"""
This module contains tests for the lib submodule of the Songs plugin.
"""
-import os
-from tempfile import mkstemp
from unittest import TestCase
from PyQt4 import QtCore, QtGui
@@ -10,6 +8,7 @@ from PyQt4 import QtCore, QtGui
from openlp.core.common import Registry, Settings
from openlp.core.lib import ServiceItem
from openlp.plugins.songs.lib.mediaitem import SongMediaItem
+from openlp.plugins.songs.lib.db import AuthorType
from tests.functional import patch, MagicMock
from tests.helpers.testmixin import TestMixin
@@ -28,6 +27,7 @@ class TestMediaItem(TestCase, TestMixin):
with patch('openlp.core.lib.mediamanageritem.MediaManagerItem._setup'), \
patch('openlp.plugins.songs.forms.editsongform.EditSongForm.__init__'):
self.media_item = SongMediaItem(None, MagicMock())
+ self.media_item.display_songbook = False
self.get_application()
self.build_settings()
QtCore.QLocale.setDefault(QtCore.QLocale('en_GB'))
@@ -45,10 +45,12 @@ class TestMediaItem(TestCase, TestMixin):
# GIVEN: A Song and a Service Item
mock_song = MagicMock()
mock_song.title = 'My Song'
+ mock_song.authors_songs = []
mock_author = MagicMock()
mock_author.display_name = 'my author'
- mock_song.authors = []
- mock_song.authors.append(mock_author)
+ mock_author_song = MagicMock()
+ mock_author_song.author = mock_author
+ mock_song.authors_songs.append(mock_author_song)
mock_song.copyright = 'My copyright'
service_item = ServiceItem(None)
@@ -56,7 +58,7 @@ class TestMediaItem(TestCase, TestMixin):
author_list = self.media_item.generate_footer(service_item, mock_song)
# THEN: I get the following Array returned
- self.assertEqual(service_item.raw_footer, ['My Song', 'my author', 'My copyright'],
+ self.assertEqual(service_item.raw_footer, ['My Song', 'Written by: my author', 'My copyright'],
'The array should be returned correctly with a song, one author and copyright')
self.assertEqual(author_list, ['my author'],
'The author list should be returned correctly with one author')
@@ -68,13 +70,25 @@ class TestMediaItem(TestCase, TestMixin):
# GIVEN: A Song and a Service Item
mock_song = MagicMock()
mock_song.title = 'My Song'
+ mock_song.authors_songs = []
mock_author = MagicMock()
mock_author.display_name = 'my author'
- mock_song.authors = []
- mock_song.authors.append(mock_author)
+ mock_author_song = MagicMock()
+ mock_author_song.author = mock_author
+ mock_author_song.author_type = AuthorType.Music
+ mock_song.authors_songs.append(mock_author_song)
mock_author = MagicMock()
mock_author.display_name = 'another author'
- mock_song.authors.append(mock_author)
+ mock_author_song = MagicMock()
+ mock_author_song.author = mock_author
+ mock_author_song.author_type = AuthorType.Words
+ mock_song.authors_songs.append(mock_author_song)
+ mock_author = MagicMock()
+ mock_author.display_name = 'translator'
+ mock_author_song = MagicMock()
+ mock_author_song.author = mock_author
+ mock_author_song.author_type = AuthorType.Translation
+ mock_song.authors_songs.append(mock_author_song)
mock_song.copyright = 'My copyright'
service_item = ServiceItem(None)
@@ -82,22 +96,19 @@ class TestMediaItem(TestCase, TestMixin):
author_list = self.media_item.generate_footer(service_item, mock_song)
# THEN: I get the following Array returned
- self.assertEqual(service_item.raw_footer, ['My Song', 'my author and another author', 'My copyright'],
+ self.assertEqual(service_item.raw_footer, ['My Song', 'Words: another author', 'Music: my author',
+ 'Translation: translator', 'My copyright'],
'The array should be returned correctly with a song, two authors and copyright')
- self.assertEqual(author_list, ['my author', 'another author'],
+ self.assertEqual(author_list, ['another author', 'my author', 'translator'],
'The author list should be returned correctly with two authors')
def build_song_footer_base_ccli_test(self):
"""
- Test build songs footer with basic song and two authors
+ Test build songs footer with basic song and a CCLI number
"""
# GIVEN: A Song and a Service Item and a configured CCLI license
mock_song = MagicMock()
mock_song.title = 'My Song'
- mock_author = MagicMock()
- mock_author.display_name = 'my author'
- mock_song.authors = []
- mock_song.authors.append(mock_author)
mock_song.copyright = 'My copyright'
service_item = ServiceItem(None)
Settings().setValue('core/ccli number', '1234')
@@ -106,7 +117,7 @@ class TestMediaItem(TestCase, TestMixin):
self.media_item.generate_footer(service_item, mock_song)
# THEN: I get the following Array returned
- self.assertEqual(service_item.raw_footer, ['My Song', 'my author', 'My copyright', 'CCLI License: 1234'],
+ self.assertEqual(service_item.raw_footer, ['My Song', 'My copyright', 'CCLI License: 1234'],
'The array should be returned correctly with a song, an author, copyright and ccli')
# WHEN: I amend the CCLI value
@@ -114,5 +125,80 @@ class TestMediaItem(TestCase, TestMixin):
self.media_item.generate_footer(service_item, mock_song)
# THEN: I would get an amended footer string
- self.assertEqual(service_item.raw_footer, ['My Song', 'my author', 'My copyright', 'CCLI License: 4321'],
+ self.assertEqual(service_item.raw_footer, ['My Song', 'My copyright', 'CCLI License: 4321'],
'The array should be returned correctly with a song, an author, copyright and amended ccli')
+
+ def build_song_footer_base_songbook_test(self):
+ """
+ Test build songs footer with basic song and a songbook
+ """
+ # GIVEN: A Song and a Service Item
+ mock_song = MagicMock()
+ mock_song.title = 'My Song'
+ mock_song.copyright = 'My copyright'
+ mock_song.book = MagicMock()
+ mock_song.book.name = "My songbook"
+ mock_song.song_number = 12
+ service_item = ServiceItem(None)
+
+ # WHEN: I generate the Footer with default settings
+ self.media_item.generate_footer(service_item, mock_song)
+
+ # THEN: The songbook should not be in the footer
+ self.assertEqual(service_item.raw_footer, ['My Song', 'My copyright'])
+
+ # WHEN: I activate the "display songbook" option
+ self.media_item.display_songbook = True
+ self.media_item.generate_footer(service_item, mock_song)
+
+ # THEN: The songbook should be in the footer
+ self.assertEqual(service_item.raw_footer, ['My Song', 'My copyright', 'My songbook #12'])
+
+ def authors_match_test(self):
+ """
+ Test the author matching when importing a song from a service
+ """
+ # GIVEN: A song and a string with authors
+ song = MagicMock()
+ song.authors = []
+ author = MagicMock()
+ author.display_name = "Hans Wurst"
+ song.authors.append(author)
+ author2 = MagicMock()
+ author2.display_name = "Max Mustermann"
+ song.authors.append(author2)
+ # There are occasions where an author appears twice in a song (with different types).
+ # We need to make sure that this case works (lp#1313538)
+ author3 = MagicMock()
+ author3.display_name = "Max Mustermann"
+ song.authors.append(author3)
+ authors_str = "Hans Wurst, Max Mustermann, Max Mustermann"
+
+ # WHEN: Checking for matching
+ result = self.media_item._authors_match(song, authors_str)
+
+ # THEN: They should match
+ self.assertTrue(result, "Authors should match")
+
+ def authors_dont_match_test(self):
+ # GIVEN: A song and a string with authors
+ song = MagicMock()
+ song.authors = []
+ author = MagicMock()
+ author.display_name = "Hans Wurst"
+ song.authors.append(author)
+ author2 = MagicMock()
+ author2.display_name = "Max Mustermann"
+ song.authors.append(author2)
+ # There are occasions where an author appears twice in a song (with different types).
+ # We need to make sure that this case works (lp#1313538)
+ author3 = MagicMock()
+ author3.display_name = "Max Mustermann"
+ song.authors.append(author3)
+
+ # WHEN: An author is missing in the string
+ authors_str = "Hans Wurst, Max Mustermann"
+ result = self.media_item._authors_match(song, authors_str)
+
+ # THEN: They should not match
+ self.assertFalse(result, "Authors should not match")
diff --git a/tests/functional/openlp_plugins/songs/test_openlyricsimport.py b/tests/functional/openlp_plugins/songs/test_openlyricsimport.py
index 93ecafb78..25db3e9e4 100644
--- a/tests/functional/openlp_plugins/songs/test_openlyricsimport.py
+++ b/tests/functional/openlp_plugins/songs/test_openlyricsimport.py
@@ -34,8 +34,8 @@ import os
from unittest import TestCase
from tests.functional import MagicMock, patch
-from openlp.plugins.songs.lib.openlyricsimport import OpenLyricsImport
-from openlp.plugins.songs.lib.songimport import SongImport
+from openlp.plugins.songs.lib.importers.openlyrics import OpenLyricsImport
+from openlp.plugins.songs.lib.importers.songimport import SongImport
TEST_PATH = os.path.abspath(os.path.join(os.path.dirname(__file__),
'..', '..', '..', 'resources', 'openlyricssongs'))
@@ -69,7 +69,7 @@ class TestOpenLyricsImport(TestCase):
Test creating an instance of the OpenLyrics file importer
"""
# GIVEN: A mocked out SongImport class, and a mocked out "manager"
- with patch('openlp.plugins.songs.lib.songbeamerimport.SongImport'):
+ with patch('openlp.plugins.songs.lib.importers.openlyrics.SongImport'):
mocked_manager = MagicMock()
# WHEN: An importer object is created
diff --git a/tests/functional/openlp_plugins/songs/test_opensongimport.py b/tests/functional/openlp_plugins/songs/test_opensongimport.py
new file mode 100644
index 000000000..07b275f98
--- /dev/null
+++ b/tests/functional/openlp_plugins/songs/test_opensongimport.py
@@ -0,0 +1,121 @@
+# -*- coding: utf-8 -*-
+# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
+
+###############################################################################
+# OpenLP - Open Source Lyrics Projection #
+# --------------------------------------------------------------------------- #
+# Copyright (c) 2008-2014 Raoul Snyman #
+# Portions copyright (c) 2008-2014 Tim Bentley, Gerald Britton, Jonathan #
+# Corwin, Samuel Findlay, Michael Gorven, Scott Guerrieri, Matthias Hub, #
+# Meinert Jordan, Armin Köhler, Erik Lundin, Edwin Lunando, Brian T. Meyer. #
+# Joshua Miller, Stevan Pettit, Andreas Preikschat, Mattias Põldaru, #
+# Christian Richter, Philip Ridout, Simon Scudder, Jeffrey Smith, #
+# Maikel Stuivenberg, Martin Thompson, Jon Tibble, Dave Warnock, #
+# Frode Woldsund, Martin Zibricky, Patrick Zimmermann #
+# --------------------------------------------------------------------------- #
+# 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 OpenSong song importer.
+"""
+
+import os
+from unittest import TestCase
+
+from tests.helpers.songfileimport import SongImportTestHelper
+from openlp.plugins.songs.lib.importers.opensong import OpenSongImport
+from tests.functional import patch, MagicMock
+
+TEST_PATH = os.path.abspath(
+ os.path.join(os.path.dirname(__file__), '..', '..', '..', 'resources', 'opensongsongs'))
+
+
+class TestOpenSongFileImport(SongImportTestHelper):
+
+ def __init__(self, *args, **kwargs):
+ self.importer_class_name = 'OpenSongImport'
+ self.importer_module_name = 'opensong'
+ super(TestOpenSongFileImport, self).__init__(*args, **kwargs)
+
+ def test_song_import(self):
+ """
+ Test that loading an OpenSong file works correctly on various files
+ """
+ self.file_import([os.path.join(TEST_PATH, 'Amazing Grace')],
+ self.load_external_result_data(os.path.join(TEST_PATH, 'Amazing Grace.json')))
+ self.file_import([os.path.join(TEST_PATH, 'Beautiful Garden Of Prayer')],
+ self.load_external_result_data(os.path.join(TEST_PATH, 'Beautiful Garden Of Prayer.json')))
+ self.file_import([os.path.join(TEST_PATH, 'One, Two, Three, Four, Five')],
+ self.load_external_result_data(os.path.join(TEST_PATH, 'One, Two, Three, Four, Five.json')))
+
+
+class TestOpenSongImport(TestCase):
+ """
+ Test the functions in the :mod:`opensongimport` module.
+ """
+ def create_importer_test(self):
+ """
+ Test creating an instance of the OpenSong file importer
+ """
+ # GIVEN: A mocked out SongImport class, and a mocked out "manager"
+ with patch('openlp.plugins.songs.lib.importers.opensong.SongImport'):
+ mocked_manager = MagicMock()
+
+ # WHEN: An importer object is created
+ importer = OpenSongImport(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 OpenSongImport.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.opensong.SongImport'):
+ mocked_manager = MagicMock()
+ mocked_import_wizard = MagicMock()
+ importer = OpenSongImport(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')
+
+ def valid_import_source_test(self):
+ """
+ Test OpenSongImport.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.opensong.SongImport'):
+ mocked_manager = MagicMock()
+ mocked_import_wizard = MagicMock()
+ importer = OpenSongImport(mocked_manager, filenames=[])
+ importer.import_wizard = mocked_import_wizard
+ importer.stop_import_flag = True
+
+ # WHEN: Import source is a list
+ importer.import_source = ['List', 'of', 'files']
+
+ # THEN: do_import should return none and the progress bar setMaximum should be called with the length of
+ # import_source.
+ self.assertIsNone(importer.do_import(), 'do_import should return None when import_source is a list '
+ 'and stop_import_flag is True')
+ mocked_import_wizard.progress_bar.setMaximum.assert_called_with(len(importer.import_source))
diff --git a/tests/functional/openlp_plugins/songs/test_propresenterimport.py b/tests/functional/openlp_plugins/songs/test_propresenterimport.py
new file mode 100644
index 000000000..bc313e250
--- /dev/null
+++ b/tests/functional/openlp_plugins/songs/test_propresenterimport.py
@@ -0,0 +1,54 @@
+# -*- coding: utf-8 -*-
+# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
+
+###############################################################################
+# OpenLP - Open Source Lyrics Projection #
+# --------------------------------------------------------------------------- #
+# Copyright (c) 2008-2013 Raoul Snyman #
+# Portions copyright (c) 2008-2013 Tim Bentley, Gerald Britton, Jonathan #
+# Corwin, Samuel Findlay, Michael Gorven, Scott Guerrieri, Matthias Hub, #
+# Meinert Jordan, Armin Köhler, Erik Lundin, Edwin Lunando, Brian T. Meyer. #
+# Joshua Miller, Stevan Pettit, Andreas Preikschat, Mattias Põldaru, #
+# Christian Richter, Philip Ridout, Simon Scudder, Jeffrey Smith, #
+# Maikel Stuivenberg, Martin Thompson, Jon Tibble, Dave Warnock, #
+# Frode Woldsund, Martin Zibricky, Patrick Zimmermann #
+# --------------------------------------------------------------------------- #
+# 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 #
+###############################################################################
+"""
+The :mod:`propresenterimport` module provides the functionality for importing
+ProPresenter song files into the current installation database.
+"""
+
+import os
+
+from tests.helpers.songfileimport import SongImportTestHelper
+
+TEST_PATH = os.path.abspath(
+ os.path.join(os.path.dirname(__file__), '..', '..', '..', 'resources', 'propresentersongs'))
+
+
+class TestProPresenterFileImport(SongImportTestHelper):
+
+ def __init__(self, *args, **kwargs):
+ self.importer_class_name = 'ProPresenterImport'
+ self.importer_module_name = 'propresenter'
+ super(TestProPresenterFileImport, self).__init__(*args, **kwargs)
+
+ def test_song_import(self):
+ """
+ Test that loading an ProPresenter file works correctly
+ """
+ self.file_import([os.path.join(TEST_PATH, 'Amazing Grace.pro4')],
+ self.load_external_result_data(os.path.join(TEST_PATH, 'Amazing Grace.json')))
diff --git a/tests/functional/openlp_plugins/songs/test_songbeamerimport.py b/tests/functional/openlp_plugins/songs/test_songbeamerimport.py
index a69d4a86c..3d872ae65 100644
--- a/tests/functional/openlp_plugins/songs/test_songbeamerimport.py
+++ b/tests/functional/openlp_plugins/songs/test_songbeamerimport.py
@@ -34,7 +34,7 @@ import os
from unittest import TestCase
from tests.functional import MagicMock, patch
-from openlp.plugins.songs.lib.songbeamerimport import SongBeamerImport
+from openlp.plugins.songs.lib.importers.songbeamer import SongBeamerImport
from openlp.plugins.songs.lib import VerseType
TEST_PATH = os.path.abspath(os.path.join(os.path.dirname(__file__),
@@ -64,7 +64,7 @@ class TestSongBeamerImport(TestCase):
Test creating an instance of the SongBeamer file importer
"""
# GIVEN: A mocked out SongImport class, and a mocked out "manager"
- with patch('openlp.plugins.songs.lib.songbeamerimport.SongImport'):
+ with patch('openlp.plugins.songs.lib.importers.songbeamer.SongImport'):
mocked_manager = MagicMock()
# WHEN: An importer object is created
@@ -78,7 +78,7 @@ class TestSongBeamerImport(TestCase):
Test SongBeamerImport.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.songbeamerimport.SongImport'):
+ with patch('openlp.plugins.songs.lib.importers.songbeamer.SongImport'):
mocked_manager = MagicMock()
mocked_import_wizard = MagicMock()
importer = SongBeamerImport(mocked_manager, filenames=[])
@@ -99,7 +99,7 @@ class TestSongBeamerImport(TestCase):
Test SongBeamerImport.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.songbeamerimport.SongImport'):
+ with patch('openlp.plugins.songs.lib.importers.songbeamer.SongImport'):
mocked_manager = MagicMock()
mocked_import_wizard = MagicMock()
importer = SongBeamerImport(mocked_manager, filenames=[])
@@ -122,7 +122,7 @@ class TestSongBeamerImport(TestCase):
# GIVEN: Test files with a mocked out SongImport class, a mocked out "manager", a mocked out "import_wizard",
# and mocked out "author", "add_copyright", "add_verse", "finish" methods.
- with patch('openlp.plugins.songs.lib.songbeamerimport.SongImport'):
+ with patch('openlp.plugins.songs.lib.importers.songbeamer.SongImport'):
for song_file in SONG_TEST_DATA:
mocked_manager = MagicMock()
mocked_import_wizard = MagicMock()
diff --git a/tests/functional/openlp_plugins/songs/test_songselect.py b/tests/functional/openlp_plugins/songs/test_songselect.py
index 8d1237190..0f9001342 100644
--- a/tests/functional/openlp_plugins/songs/test_songselect.py
+++ b/tests/functional/openlp_plugins/songs/test_songselect.py
@@ -344,7 +344,7 @@ class TestSongSelect(TestCase):
mocked_db_manager.get_object_filtered.assert_called_with(MockedAuthor, False)
MockedAuthor.populate.assert_called_with(first_name='Public', last_name='Domain',
display_name='Public Domain')
- self.assertEqual(1, len(result.authors), 'There should only be one author')
+ self.assertEqual(1, len(result.authors_songs), 'There should only be one author')
def save_song_existing_author_test(self):
"""
@@ -379,4 +379,4 @@ class TestSongSelect(TestCase):
'The save_object() method should have been called twice')
mocked_db_manager.get_object_filtered.assert_called_with(MockedAuthor, False)
self.assertEqual(0, MockedAuthor.populate.call_count, 'A new author should not have been instantiated')
- self.assertEqual(1, len(result.authors), 'There should only be one author')
+ self.assertEqual(1, len(result.authors_songs), 'There should only be one author')
diff --git a/tests/functional/openlp_plugins/songs/test_songshowplusimport.py b/tests/functional/openlp_plugins/songs/test_songshowplusimport.py
index 7292bb2b0..77e1196bc 100644
--- a/tests/functional/openlp_plugins/songs/test_songshowplusimport.py
+++ b/tests/functional/openlp_plugins/songs/test_songshowplusimport.py
@@ -35,7 +35,7 @@ from unittest import TestCase
from tests.helpers.songfileimport import SongImportTestHelper
from openlp.plugins.songs.lib import VerseType
-from openlp.plugins.songs.lib.songshowplusimport import SongShowPlusImport
+from openlp.plugins.songs.lib.importers.songshowplus import SongShowPlusImport
from tests.functional import patch, MagicMock
TEST_PATH = os.path.abspath(
@@ -46,17 +46,19 @@ class TestSongShowPlusFileImport(SongImportTestHelper):
def __init__(self, *args, **kwargs):
self.importer_class_name = 'SongShowPlusImport'
- self.importer_module_name = 'songshowplusimport'
+ self.importer_module_name = 'songshowplus'
super(TestSongShowPlusFileImport, self).__init__(*args, **kwargs)
def test_song_import(self):
"""
Test that loading a SongShow Plus file works correctly on various files
"""
- self.file_import(os.path.join(TEST_PATH, 'Amazing Grace.sbsong'),
+ self.file_import([os.path.join(TEST_PATH, 'Amazing Grace.sbsong')],
self.load_external_result_data(os.path.join(TEST_PATH, 'Amazing Grace.json')))
- self.file_import(os.path.join(TEST_PATH, 'Beautiful Garden Of Prayer.sbsong'),
+ self.file_import([os.path.join(TEST_PATH, 'Beautiful Garden Of Prayer.sbsong')],
self.load_external_result_data(os.path.join(TEST_PATH, 'Beautiful Garden Of Prayer.json')))
+ self.file_import([os.path.join(TEST_PATH, 'a mighty fortress is our god.sbsong')],
+ self.load_external_result_data(os.path.join(TEST_PATH, 'a mighty fortress is our god.json')))
class TestSongShowPlusImport(TestCase):
@@ -68,7 +70,7 @@ class TestSongShowPlusImport(TestCase):
Test creating an instance of the SongShow Plus file importer
"""
# GIVEN: A mocked out SongImport class, and a mocked out "manager"
- with patch('openlp.plugins.songs.lib.songshowplusimport.SongImport'):
+ with patch('openlp.plugins.songs.lib.importers.songshowplus.SongImport'):
mocked_manager = MagicMock()
# WHEN: An importer object is created
@@ -82,7 +84,7 @@ class TestSongShowPlusImport(TestCase):
Test SongShowPlusImport.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.songshowplusimport.SongImport'):
+ with patch('openlp.plugins.songs.lib.importers.songshowplus.SongImport'):
mocked_manager = MagicMock()
mocked_import_wizard = MagicMock()
importer = SongShowPlusImport(mocked_manager, filenames=[])
@@ -103,7 +105,7 @@ class TestSongShowPlusImport(TestCase):
Test SongShowPlusImport.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.songshowplusimport.SongImport'):
+ with patch('openlp.plugins.songs.lib.importers.songshowplus.SongImport'):
mocked_manager = MagicMock()
mocked_import_wizard = MagicMock()
importer = SongShowPlusImport(mocked_manager, filenames=[])
@@ -124,7 +126,7 @@ class TestSongShowPlusImport(TestCase):
Test to_openlp_verse_tag method by simulating adding a verse
"""
# GIVEN: A mocked out SongImport class, and a mocked out "manager"
- with patch('openlp.plugins.songs.lib.songshowplusimport.SongImport'):
+ with patch('openlp.plugins.songs.lib.importers.songshowplus.SongImport'):
mocked_manager = MagicMock()
importer = SongShowPlusImport(mocked_manager, filenames=[])
@@ -152,7 +154,7 @@ class TestSongShowPlusImport(TestCase):
Test to_openlp_verse_tag method by simulating adding a verse to the verse order
"""
# GIVEN: A mocked out SongImport class, and a mocked out "manager"
- with patch('openlp.plugins.songs.lib.songshowplusimport.SongImport'):
+ with patch('openlp.plugins.songs.lib.importers.songshowplus.SongImport'):
mocked_manager = MagicMock()
importer = SongShowPlusImport(mocked_manager, filenames=[])
diff --git a/tests/functional/openlp_plugins/songs/test_worshipassistantimport.py b/tests/functional/openlp_plugins/songs/test_worshipassistantimport.py
new file mode 100644
index 000000000..63ead5b30
--- /dev/null
+++ b/tests/functional/openlp_plugins/songs/test_worshipassistantimport.py
@@ -0,0 +1,56 @@
+# -*- coding: utf-8 -*-
+# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
+
+###############################################################################
+# OpenLP - Open Source Lyrics Projection #
+# --------------------------------------------------------------------------- #
+# Copyright (c) 2008-2013 Raoul Snyman #
+# Portions copyright (c) 2008-2013 Tim Bentley, Gerald Britton, Jonathan #
+# Corwin, Samuel Findlay, Michael Gorven, Scott Guerrieri, Matthias Hub, #
+# Meinert Jordan, Armin Köhler, Erik Lundin, Edwin Lunando, Brian T. Meyer. #
+# Joshua Miller, Stevan Pettit, Andreas Preikschat, Mattias Põldaru, #
+# Christian Richter, Philip Ridout, Simon Scudder, Jeffrey Smith, #
+# Maikel Stuivenberg, Martin Thompson, Jon Tibble, Dave Warnock, #
+# Frode Woldsund, Martin Zibricky, Patrick Zimmermann #
+# --------------------------------------------------------------------------- #
+# 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 #
+###############################################################################
+"""
+The :mod:`worshipassistantimport` module provides the functionality for importing
+WorshipAssistant song files into the current installation database.
+"""
+
+import os
+
+from tests.helpers.songfileimport import SongImportTestHelper
+
+TEST_PATH = os.path.abspath(
+ os.path.join(os.path.dirname(__file__), '..', '..', '..', 'resources', 'worshipassistantsongs'))
+
+
+class TestWorshipAssistantFileImport(SongImportTestHelper):
+
+ def __init__(self, *args, **kwargs):
+ self.importer_class_name = 'WorshipAssistantImport'
+ self.importer_module_name = 'worshipassistant'
+ super(TestWorshipAssistantFileImport, self).__init__(*args, **kwargs)
+
+ def test_song_import(self):
+ """
+ Test that loading an Worship Assistant file works correctly
+ """
+ self.file_import(os.path.join(TEST_PATH, 'du_herr.csv'),
+ self.load_external_result_data(os.path.join(TEST_PATH, 'du_herr.json')))
+ self.file_import(os.path.join(TEST_PATH, 'would_you_be_free.csv'),
+ self.load_external_result_data(os.path.join(TEST_PATH, 'would_you_be_free.json')))
diff --git a/tests/functional/openlp_plugins/songs/test_worshipcenterproimport.py b/tests/functional/openlp_plugins/songs/test_worshipcenterproimport.py
index 9a58a6c2b..cd51e3384 100644
--- a/tests/functional/openlp_plugins/songs/test_worshipcenterproimport.py
+++ b/tests/functional/openlp_plugins/songs/test_worshipcenterproimport.py
@@ -37,7 +37,7 @@ if os.name != 'nt':
import pyodbc
-from openlp.plugins.songs.lib.worshipcenterproimport import WorshipCenterProImport
+from openlp.plugins.songs.lib.importers.worshipcenterpro import WorshipCenterProImport
from tests.functional import patch, MagicMock
@@ -141,7 +141,7 @@ class TestWorshipCenterProSongImport(TestCase):
Test creating an instance of the WorshipCenter Pro file importer
"""
# GIVEN: A mocked out SongImport class, and a mocked out "manager"
- with patch('openlp.plugins.songs.lib.worshipcenterproimport.SongImport'):
+ with patch('openlp.plugins.songs.lib.importers.worshipcenterpro.SongImport'):
mocked_manager = MagicMock()
# WHEN: An importer object is created
@@ -156,9 +156,10 @@ class TestWorshipCenterProSongImport(TestCase):
"""
# GIVEN: A mocked out SongImport class, a mocked out pyodbc module, a mocked out translate method,
# a mocked "manager" and a mocked out log_error method.
- with patch('openlp.plugins.songs.lib.worshipcenterproimport.SongImport'), \
- patch('openlp.plugins.songs.lib.worshipcenterproimport.pyodbc.connect') as mocked_pyodbc_connect, \
- patch('openlp.plugins.songs.lib.worshipcenterproimport.translate') as mocked_translate:
+ with patch('openlp.plugins.songs.lib.importers.worshipcenterpro.SongImport'), \
+ patch('openlp.plugins.songs.lib.importers.worshipcenterpro.pyodbc.connect') \
+ as mocked_pyodbc_connect, \
+ patch('openlp.plugins.songs.lib.importers.worshipcenterpro.translate') as mocked_translate:
mocked_manager = MagicMock()
mocked_log_error = MagicMock()
mocked_translate.return_value = 'Translated Text'
@@ -185,9 +186,9 @@ class TestWorshipCenterProSongImport(TestCase):
"""
# GIVEN: A mocked out SongImport class, a mocked out pyodbc module with a simulated recordset, a mocked out
# translate method, a mocked "manager", add_verse method & mocked_finish method.
- with patch('openlp.plugins.songs.lib.worshipcenterproimport.SongImport'), \
- patch('openlp.plugins.songs.lib.worshipcenterproimport.pyodbc') as mocked_pyodbc, \
- patch('openlp.plugins.songs.lib.worshipcenterproimport.translate') as mocked_translate:
+ with patch('openlp.plugins.songs.lib.importers.worshipcenterpro.SongImport'), \
+ patch('openlp.plugins.songs.lib.importers.worshipcenterpro.pyodbc') as mocked_pyodbc, \
+ patch('openlp.plugins.songs.lib.importers.worshipcenterpro.translate') as mocked_translate:
mocked_manager = MagicMock()
mocked_import_wizard = MagicMock()
mocked_add_verse = MagicMock()
diff --git a/tests/functional/openlp_plugins/songs/test_zionworximport.py b/tests/functional/openlp_plugins/songs/test_zionworximport.py
index 2edc071c7..faedc7005 100644
--- a/tests/functional/openlp_plugins/songs/test_zionworximport.py
+++ b/tests/functional/openlp_plugins/songs/test_zionworximport.py
@@ -33,8 +33,8 @@ This module contains tests for the ZionWorx song importer.
from unittest import TestCase
from tests.functional import MagicMock, patch
-from openlp.plugins.songs.lib.zionworximport import ZionWorxImport
-from openlp.plugins.songs.lib.songimport import SongImport
+from openlp.plugins.songs.lib.importers.zionworx import ZionWorxImport
+from openlp.plugins.songs.lib.importers.songimport import SongImport
class TestZionWorxImport(TestCase):
@@ -46,7 +46,7 @@ class TestZionWorxImport(TestCase):
Test creating an instance of the ZionWorx file importer
"""
# GIVEN: A mocked out SongImport class, and a mocked out "manager"
- with patch('openlp.plugins.songs.lib.songbeamerimport.SongImport'):
+ with patch('openlp.plugins.songs.lib.importers.zionworx.SongImport'):
mocked_manager = MagicMock()
# WHEN: An importer object is created
diff --git a/tests/helpers/songfileimport.py b/tests/helpers/songfileimport.py
index 5364c2c3b..18e7914b9 100644
--- a/tests/helpers/songfileimport.py
+++ b/tests/helpers/songfileimport.py
@@ -33,7 +33,7 @@ song files from third party applications.
import json
from unittest import TestCase
-from tests.functional import patch, MagicMock
+from tests.functional import patch, MagicMock, call
class SongImportTestHelper(TestCase):
@@ -42,27 +42,28 @@ class SongImportTestHelper(TestCase):
"""
def __init__(self, *args, **kwargs):
super(SongImportTestHelper, self).__init__(*args, **kwargs)
- self.importer_module = __import__(
- 'openlp.plugins.songs.lib.%s' % self.importer_module_name, fromlist=[self.importer_class_name])
+ self.importer_module = __import__('openlp.plugins.songs.lib.importers.%s' %
+ self.importer_module_name, fromlist=[self.importer_class_name])
self.importer_class = getattr(self.importer_module, self.importer_class_name)
def setUp(self):
"""
Patch and set up the mocks required.
"""
- self.add_copyright_patcher = patch(
- 'openlp.plugins.songs.lib.%s.%s.add_copyright' % (self.importer_module_name, self.importer_class_name))
- self.add_verse_patcher = patch(
- 'openlp.plugins.songs.lib.%s.%s.add_verse' % (self.importer_module_name, self.importer_class_name))
- self.finish_patcher = patch(
- 'openlp.plugins.songs.lib.%s.%s.finish' % (self.importer_module_name, self.importer_class_name))
- self.parse_author_patcher = patch(
- 'openlp.plugins.songs.lib.%s.%s.parse_author' % (self.importer_module_name, self.importer_class_name))
- self.song_import_patcher = patch('openlp.plugins.songs.lib.%s.SongImport' % self.importer_module_name)
+ self.add_copyright_patcher = patch('openlp.plugins.songs.lib.importers.%s.%s.add_copyright' %
+ (self.importer_module_name, self.importer_class_name))
+ self.add_verse_patcher = patch('openlp.plugins.songs.lib.importers.%s.%s.add_verse' %
+ (self.importer_module_name, self.importer_class_name))
+ self.finish_patcher = patch('openlp.plugins.songs.lib.importers.%s.%s.finish' %
+ (self.importer_module_name, self.importer_class_name))
+ self.add_author_patcher = patch('openlp.plugins.songs.lib.importers.%s.%s.add_author' %
+ (self.importer_module_name, self.importer_class_name))
+ self.song_import_patcher = patch('openlp.plugins.songs.lib.importers.%s.SongImport' %
+ self.importer_module_name)
self.mocked_add_copyright = self.add_copyright_patcher.start()
self.mocked_add_verse = self.add_verse_patcher.start()
self.mocked_finish = self.finish_patcher.start()
- self.mocked_parse_author = self.parse_author_patcher.start()
+ self.mocked_add_author = self.add_author_patcher.start()
self.mocked_song_importer = self.song_import_patcher.start()
self.mocked_manager = MagicMock()
self.mocked_import_wizard = MagicMock()
@@ -75,7 +76,7 @@ class SongImportTestHelper(TestCase):
self.add_copyright_patcher.stop()
self.add_verse_patcher.stop()
self.finish_patcher.stop()
- self.parse_author_patcher.stop()
+ self.add_author_patcher.stop()
self.song_import_patcher.stop()
def load_external_result_data(self, file_name):
@@ -95,7 +96,7 @@ class SongImportTestHelper(TestCase):
importer.topics = []
# WHEN: Importing the source file
- importer.import_source = [source_file_name]
+ importer.import_source = source_file_name
add_verse_calls = self._get_data(result_data, 'verses')
author_calls = self._get_data(result_data, 'authors')
ccli_number = self._get_data(result_data, 'ccli_number')
@@ -112,14 +113,17 @@ class SongImportTestHelper(TestCase):
self.assertIsNone(importer.do_import(), 'do_import should return None when it has completed')
self.assertEqual(importer.title, title, 'title for %s should be "%s"' % (source_file_name, title))
for author in author_calls:
- self.mocked_parse_author.assert_any_call(author)
+ self.mocked_add_author.assert_any_call(author)
if song_copyright:
self.mocked_add_copyright.assert_called_with(song_copyright)
if ccli_number:
self.assertEqual(importer.ccli_number, ccli_number,
'ccli_number for %s should be %s' % (source_file_name, ccli_number))
+ expected_calls = []
for verse_text, verse_tag in add_verse_calls:
self.mocked_add_verse.assert_any_call(verse_text, verse_tag)
+ expected_calls.append(call(verse_text, verse_tag))
+ self.mocked_add_verse.assert_has_calls(expected_calls, any_order=False)
if topics:
self.assertEqual(importer.topics, topics, 'topics for %s should be %s' % (source_file_name, topics))
if comments:
@@ -132,7 +136,7 @@ class SongImportTestHelper(TestCase):
self.assertEqual(importer.song_number, song_number,
'song_number for %s should be %s' % (source_file_name, song_number))
if verse_order_list:
- self.assertEqual(importer.verse_order_list, [],
+ self.assertEqual(importer.verse_order_list, verse_order_list,
'verse_order_list for %s should be %s' % (source_file_name, verse_order_list))
self.mocked_finish.assert_called_with()
diff --git a/tests/interfaces/openlp_core_common/__init__.py b/tests/interfaces/openlp_core_common/__init__.py
new file mode 100644
index 000000000..6b241e7fc
--- /dev/null
+++ b/tests/interfaces/openlp_core_common/__init__.py
@@ -0,0 +1,28 @@
+# -*- coding: utf-8 -*-
+# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
+
+###############################################################################
+# OpenLP - Open Source Lyrics Projection #
+# --------------------------------------------------------------------------- #
+# Copyright (c) 2008-2014 Raoul Snyman #
+# Portions copyright (c) 2008-2014 Tim Bentley, Gerald Britton, Jonathan #
+# Corwin, Samuel Findlay, Michael Gorven, Scott Guerrieri, Matthias Hub, #
+# Meinert Jordan, Armin Köhler, Erik Lundin, Edwin Lunando, Brian T. Meyer. #
+# Joshua Miller, Stevan Pettit, Andreas Preikschat, Mattias Põldaru, #
+# Christian Richter, Philip Ridout, Simon Scudder, Jeffrey Smith, #
+# Maikel Stuivenberg, Martin Thompson, Jon Tibble, Dave Warnock, #
+# Frode Woldsund, Martin Zibricky, Patrick Zimmermann #
+# --------------------------------------------------------------------------- #
+# 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 #
+###############################################################################
diff --git a/tests/interfaces/openlp_core_ui/test_splashscreen.py b/tests/interfaces/openlp_core_common/test_historycombobox.py
similarity index 74%
rename from tests/interfaces/openlp_core_ui/test_splashscreen.py
rename to tests/interfaces/openlp_core_common/test_historycombobox.py
index 35c15f9ec..c0131e46c 100644
--- a/tests/interfaces/openlp_core_ui/test_splashscreen.py
+++ b/tests/interfaces/openlp_core_common/test_historycombobox.py
@@ -27,34 +27,39 @@
# Temple Place, Suite 330, Boston, MA 02111-1307 USA #
###############################################################################
"""
-Test the openlp.core.ui.splashscreen class.
+Module to test the :mod:`~openlp.core.common.historycombobox` module.
"""
+
from unittest import TestCase
-from PyQt4 import QtGui
+from PyQt4 import QtCore, QtGui, QtTest
-from openlp.core.ui import SplashScreen
+from openlp.core.common import Registry
+from openlp.core.common import HistoryComboBox
from tests.helpers.testmixin import TestMixin
+from tests.interfaces import MagicMock, patch
-class TestSplashScreen(TestCase, TestMixin):
+class TestHistoryComboBox(TestCase, TestMixin):
def setUp(self):
+ Registry.create()
self.get_application()
self.main_window = QtGui.QMainWindow()
+ Registry().register('main_window', self.main_window)
+ self.combo = HistoryComboBox(self.main_window)
def tearDown(self):
- """
- Delete all the C++ objects at the end so that we don't have a segfault
- """
- del self.app
- del self.main_window
+ del self.combo
- def setupUi_test(self):
+ def getItems_test(self):
"""
- Test if the setupUi method....
+ Test the getItems() method
"""
- # GIVEN: A splash screen instance.
- splash = SplashScreen()
+ # GIVEN: The combo.
- # THEN: Check if the splash has a setupUi method.
- assert hasattr(splash, 'setupUi'), 'The Splash Screen should have a setupUi() method.'
+ # WHEN: Add two items.
+ self.combo.addItem('test1')
+ self.combo.addItem('test2')
+
+ # THEN: The list of items should contain both strings.
+ self.assertEqual(self.combo.getItems(), ['test1', 'test2'])
diff --git a/tests/interfaces/openlp_core_lib/test_pluginmanager.py b/tests/interfaces/openlp_core_lib/test_pluginmanager.py
index 262f9f2f3..ba81d708f 100644
--- a/tests/interfaces/openlp_core_lib/test_pluginmanager.py
+++ b/tests/interfaces/openlp_core_lib/test_pluginmanager.py
@@ -88,7 +88,7 @@ class TestPluginManager(TestCase, TestMixin):
plugin_names = [plugin.name for plugin in plugin_manager.plugins]
assert 'songs' in plugin_names, 'There should be a "songs" plugin.'
assert 'bibles' in plugin_names, 'There should be a "bibles" plugin.'
- assert 'presentations' not in plugin_names, 'There should NOT be a "presentations" plugin.'
+ assert 'presentations' in plugin_names, 'There should be a "presentations" plugin.'
assert 'images' in plugin_names, 'There should be a "images" plugin.'
assert 'media' in plugin_names, 'There should be a "media" plugin.'
assert 'custom' in plugin_names, 'There should be a "custom" plugin.'
diff --git a/tests/interfaces/openlp_core_lib/test_searchedit.py b/tests/interfaces/openlp_core_lib/test_searchedit.py
index 22bf6fae3..f2cf18988 100644
--- a/tests/interfaces/openlp_core_lib/test_searchedit.py
+++ b/tests/interfaces/openlp_core_lib/test_searchedit.py
@@ -30,7 +30,6 @@
Module to test the EditCustomForm.
"""
from unittest import TestCase
-from unittest.mock import MagicMock
from PyQt4 import QtCore, QtGui, QtTest
@@ -127,9 +126,3 @@ class TestSearchEdit(TestCase, TestMixin):
# THEN: The search edit text should be cleared and the button be hidden.
assert not self.search_edit.text(), "The search edit should not have any text."
assert self.search_edit.clear_button.isHidden(), "The clear button should be hidden."
-
- def resize_event_test(self):
- """
- Just check if the resizeEvent() method is re-implemented.
- """
- assert hasattr(self.search_edit, "resizeEvent"), "The search edit should re-implement the resizeEvent method."
diff --git a/tests/interfaces/openlp_core_ui/test_filerenamedialog.py b/tests/interfaces/openlp_core_ui/test_filerenamedialog.py
index 905f167e9..7d14c7d9c 100644
--- a/tests/interfaces/openlp_core_ui/test_filerenamedialog.py
+++ b/tests/interfaces/openlp_core_ui/test_filerenamedialog.py
@@ -89,7 +89,7 @@ class TestStartFileRenameForm(TestCase, TestMixin):
Test that the file_name_edit setFocus has called with True when executed
"""
# GIVEN: A mocked QDialog.exec_() method and mocked file_name_edit.setFocus() method.
- with patch('PyQt4.QtGui.QDialog.exec_') as mocked_exec:
+ with patch('PyQt4.QtGui.QDialog.exec_'):
mocked_set_focus = MagicMock()
self.form.file_name_edit.setFocus = mocked_set_focus
diff --git a/tests/interfaces/openlp_core_ui/test_shortcutlistform.py b/tests/interfaces/openlp_core_ui/test_shortcutlistform.py
new file mode 100644
index 000000000..29c365194
--- /dev/null
+++ b/tests/interfaces/openlp_core_ui/test_shortcutlistform.py
@@ -0,0 +1,78 @@
+# -*- coding: utf-8 -*-
+# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
+
+###############################################################################
+# OpenLP - Open Source Lyrics Projection #
+# --------------------------------------------------------------------------- #
+# Copyright (c) 2008-2014 Raoul Snyman #
+# Portions copyright (c) 2008-2014 Tim Bentley, Gerald Britton, Jonathan #
+# Corwin, Samuel Findlay, Michael Gorven, Scott Guerrieri, Matthias Hub, #
+# Meinert Jordan, Armin Köhler, Erik Lundin, Edwin Lunando, Brian T. Meyer. #
+# Joshua Miller, Stevan Pettit, Andreas Preikschat, Mattias Põldaru, #
+# Christian Richter, Philip Ridout, Simon Scudder, Jeffrey Smith, #
+# Maikel Stuivenberg, Martin Thompson, Jon Tibble, Dave Warnock, #
+# Frode Woldsund, Martin Zibricky, Patrick Zimmermann #
+# --------------------------------------------------------------------------- #
+# 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 #
+###############################################################################
+"""
+Package to test the openlp.core.ui.shortcutform package.
+"""
+from unittest import TestCase
+
+from PyQt4 import QtCore, QtGui, QtTest
+
+from openlp.core.common import Registry
+from openlp.core.ui.shortcutlistform import ShortcutListForm
+from tests.interfaces import patch
+from tests.helpers.testmixin import TestMixin
+
+
+class TestShortcutform(TestCase, TestMixin):
+
+ def setUp(self):
+ """
+ Create the UI
+ """
+ Registry.create()
+ self.get_application()
+ self.main_window = QtGui.QMainWindow()
+ Registry().register('main_window', self.main_window)
+ self.form = ShortcutListForm()
+
+ def tearDown(self):
+ """
+ Delete all the C++ objects at the end so that we don't have a segfault
+ """
+ del self.form
+ del self.main_window
+
+ def adjust_button_test(self):
+ """
+ Test the _adjust_button() method
+ """
+ # GIVEN: A button.
+ button = QtGui.QPushButton()
+ checked = True
+ enabled = True
+ text = "new!"
+
+ # WHEN: Call the method.
+ with patch('PyQt4.QtGui.QPushButton.setChecked') as mocked_check_method:
+ self.form._adjust_button(button, checked, enabled, text)
+
+ # THEN: The button should be changed.
+ self.assertEqual(button.text(), text, "The text should match.")
+ mocked_check_method.assert_called_once_with(True)
+ self.assertEqual(button.isEnabled(), enabled, "The button should be disabled.")
diff --git a/tests/resources/bibles/opensong-dk1933.xml b/tests/resources/bibles/opensong-dk1933.xml
new file mode 100644
index 000000000..1aa1140f7
--- /dev/null
+++ b/tests/resources/bibles/opensong-dk1933.xml
@@ -0,0 +1,46 @@
+
+
+
+
+
+
+
+
+ Danish Version
+
+
+ The Holy Bible
+ The electronic edition of this Bible comes from the Danish 1933 edition. The Old Testament is an update from the 1931 edition, and the New Testament is an update from the 1907 edition.
+ Free Bible Software Group
+
+ The Unbound Bible
+ Biola University: Administrative Computing
+ 13800 Biola Ave.
+ La Mirada, CA 90639
+ United States of America
+ 562-903-4722
+
+ 2009-01-20
+ Zefania XML Bible Markup Language
+ DAN
+ ftp://unboundftp.biola.edu/pub/danish1933_utf8.zip
+ DAN
+ provide the bible to the world
+
+
+
+
+
+ I Begyndelsen skabte Gud Himmelen og Jorden.
+ Og Jorden var øde og tom, og der var Mørke over Verdensdybet. Men Guds Ånd svævede over Vandene.
+ Og Gud sagde: "Der blive Lys!" Og der blev Lys.
+ Og Gud så, at Lyset var godt, og Gud satte Skel mellem Lyset og Mørket,
+ og Gud kaldte Lyset Dag, og Mørket kaldte han Nat. Og det blev Aften, og det blev Morgen, første Dag.
+ Derpå sagde Gud: "Der blive en Hvælving midt i Vandene til at skille Vandene ad!"
+ Og således skete det: Gud gjorde Hvælvingen og skilte Vandet under Hvælvingen fra Vandet over Hvælvingen;
+ og Gud kaldte Hvælvingen Himmel. Og det blev Aften, og det blev Morgen, anden Dag.
+ Derpå sagde Gud: "Vandet under Himmelen samle sig på eet Sted, så det faste Land kommer til Syne!" Og således skete det;
+ og Gud kaldte det faste Land Jord, og Stedet, hvor Vandet samlede sig, kaldte han Hav. Og Gud så, at det var godt.
+
+
+
diff --git a/tests/resources/bibles/zefania-dk1933.xml b/tests/resources/bibles/zefania-dk1933.xml
new file mode 100644
index 000000000..f538edb99
--- /dev/null
+++ b/tests/resources/bibles/zefania-dk1933.xml
@@ -0,0 +1,45 @@
+
+
+
+
+
+
+
+ Danish Version
+
+
+ The Holy Bible
+ The electronic edition of this Bible comes from the Danish 1933 edition. The Old Testament is an update from the 1931 edition, and the New Testament is an update from the 1907 edition.
+ Free Bible Software Group
+
+ The Unbound Bible
+ Biola University: Administrative Computing
+ 13800 Biola Ave.
+ La Mirada, CA 90639
+ United States of America
+ 562-903-4722
+
+ 2009-01-20
+ Zefania XML Bible Markup Language
+ DAN
+ ftp://unboundftp.biola.edu/pub/danish1933_utf8.zip
+ DAN
+ provide the bible to the world
+
+
+
+
+
+ I skabte Gud Himmelen og Jorden.
+ Og Jorden var øde og tom, og der var Mørke over Verdensdybet. Men Guds Ånd svævede over Vandene.
+ Og Gud sagde: "Der blive Lys!" Og der blev Lys.
+ Og Gud så, at Lyset var godt, og Gud satte Skel mellem Lyset og Mørket,
+ og Gud kaldte Lyset Dag, og Mørket kaldte han Nat. Og det blev Aften, og det blev Morgen, første Dag.
+ Derpå sagde Gud: "Der blive en Hvælving midt i Vandene til at skille Vandene ad!"
+ Og således skete det: Gud gjorde Hvælvingen og skilte Vandet under Hvælvingen fra Vandet over Hvælvingen;
+ og Gud kaldte Hvælvingen Himmel. Og det blev Aften, og det blev Morgen, anden Dag.
+ Derpå sagde Gud: "Vandet under Himmelen samle sig på eet Sted, så det faste Land kommer til Syne!" Og således skete det;
+ og Gud kaldte det faste Land Jord, og Stedet, hvor Vandet samlede sig, kaldte han Hav. Og Gud så, at det var godt.
+
+
+
\ No newline at end of file
diff --git a/tests/resources/easyworshipsongs/Songs.DB b/tests/resources/easyworshipsongs/Songs.DB
index 8c9679b86..347695057 100644
Binary files a/tests/resources/easyworshipsongs/Songs.DB and b/tests/resources/easyworshipsongs/Songs.DB differ
diff --git a/tests/resources/easyworshipsongs/Songs.MB b/tests/resources/easyworshipsongs/Songs.MB
index b46323005..949d7755c 100644
Binary files a/tests/resources/easyworshipsongs/Songs.MB and b/tests/resources/easyworshipsongs/Songs.MB differ
diff --git a/tests/resources/easyworshipsongs/test1.ews b/tests/resources/easyworshipsongs/test1.ews
new file mode 100644
index 000000000..2cb9676f1
Binary files /dev/null and b/tests/resources/easyworshipsongs/test1.ews differ
diff --git a/tests/resources/opensongsongs/Amazing Grace b/tests/resources/opensongsongs/Amazing Grace
new file mode 100644
index 000000000..97062dc21
--- /dev/null
+++ b/tests/resources/opensongsongs/Amazing Grace
@@ -0,0 +1,56 @@
+
+
+ Amazing Grace (Demonstration)
+ John Newton, Edwin Excell & John P. Rees
+ Public Domain
+ V1 V2 V3 V4 V5
+
+
+ 22025
+ God: Assurance/Grace/Salvation
+ Worship: Praise
+
+
+
+ [V]
+;Test the chords format
+;Chords beging with .
+;Verses begin with their verse number
+;Link words with _
+;Comments begin with ;
+. D D7 G D
+1A______ma________zing grace! How sweet the sound!
+2'Twas grace that taught my heart to fear,
+3The Lord has pro____mised good to me,
+4Thro' ma________ny dan____gers, toils and snares
+5When we've been there ten thou__sand years,
+
+. Bm E A A7
+1That saved a wretch like me!
+2And grace my fears re___lieved.
+3His Word my hope se___cures.
+4I have al___rea____dy come.
+5Bright shi___ning as the sun,
+
+. D D7 G D
+1I once was lost, but now am found;
+2How pre___cious did that grace ap____pear,
+3He will my shield and por___tion be
+4'Tis grace that brought me safe thus far,
+5We've no less days to sing God's praise,
+
+. Bm A G D
+1Was blind, but now I see.
+2The hour I first be_lieved.
+3As long as life en_dures.
+4And grace will lead me home.
+5Than when we first be_gun.
+
+
+ Demonstration Songs 0
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tests/resources/opensongsongs/Amazing Grace.json b/tests/resources/opensongsongs/Amazing Grace.json
new file mode 100644
index 000000000..97b8c77b7
--- /dev/null
+++ b/tests/resources/opensongsongs/Amazing Grace.json
@@ -0,0 +1,42 @@
+{
+ "authors": [
+ "John Newton",
+ "Edwin Excell",
+ "John P. Rees"
+ ],
+ "ccli_number": 22025,
+ "comments": "\n\n\n",
+ "copyright": "Public Domain ",
+ "song_book_name": "Demonstration Songs",
+ "song_number": 0,
+ "title": "Amazing Grace (Demonstration)",
+ "topics": [
+ "Assurance",
+ "Grace",
+ "Praise",
+ "Salvation"
+ ],
+ "verse_order_list": [],
+ "verses": [
+ [
+ "Amazing grace! How sweet the sound!\nThat saved a wretch like me!\nI once was lost, but now am found;\nWas blind, but now I see.",
+ "v1"
+ ],
+ [
+ "'Twas grace that taught my heart to fear,\nAnd grace my fears relieved.\nHow precious did that grace appear,\nThe hour I first believed.",
+ "v2"
+ ],
+ [
+ "The Lord has promised good to me,\nHis Word my hope secures.\nHe will my shield and portion be\nAs long as life endures.",
+ "v3"
+ ],
+ [
+ "Thro' many dangers, toils and snares\nI have already come.\n'Tis grace that brought me safe thus far,\nAnd grace will lead me home.",
+ "v4"
+ ],
+ [
+ "When we've been there ten thousand years,\nBright shining as the sun,\nWe've no less days to sing God's praise,\nThan when we first begun.",
+ "v5"
+ ]
+ ]
+}
\ No newline at end of file
diff --git a/tests/resources/opensongsongs/Beautiful Garden Of Prayer b/tests/resources/opensongsongs/Beautiful Garden Of Prayer
new file mode 100644
index 000000000..29cd26cc8
--- /dev/null
+++ b/tests/resources/opensongsongs/Beautiful Garden Of Prayer
@@ -0,0 +1,56 @@
+
+
+ Beautiful Garden Of Prayer (Demonstration)
+ Eleanor Allen Schroll & James H. Fillmore
+ Public Domain
+ V1 C V2 C V3 C
+
+
+ 60252
+ God: Prayer/Devotion
+ Prayer: Prayer/Devotion
+
+
+
+
+;Test breaks and newlines
+;A single | on the end of a line adds an extra \n
+;Blank lines are ignored, even with a space prefix
+;We also check that the chorus is added after the verses, despite the order in the file
+[V1]
+ There's a garden where Jesus is waiting,
+
+ There's a place that is wondrously fair.
+ For it glows with the light of His presence,|
+ 'Tis the beautiful garden of prayer.
+
+;A double || on a line adds a new slide
+[C]
+ O the beautiful garden, the garden of prayer,
+ O the beautiful garden of prayer.
+ There my Savior awaits, and He opens the gates
+ ||
+ To the beautiful garden of prayer.
+
+;A double || on the end of a line adds a new slide
+[V2]
+ There's a garden where Jesus is waiting,
+ And I go with my burden and care.
+ Just to learn from His lips, words of comfort,||
+ In the beautiful garden of prayer.
+
+;A single | on a line adds just one line break
+[V3]
+ There's a garden where Jesus is waiting,
+ And He bids you to come meet Him there,
+ Just to bow and receive a new blessing,
+ |
+ In the beautiful garden of prayer.
+
+ DS0
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tests/resources/opensongsongs/Beautiful Garden Of Prayer.json b/tests/resources/opensongsongs/Beautiful Garden Of Prayer.json
new file mode 100644
index 000000000..392bbaa18
--- /dev/null
+++ b/tests/resources/opensongsongs/Beautiful Garden Of Prayer.json
@@ -0,0 +1,35 @@
+{
+ "authors": [
+ "Eleanor Allen Schroll",
+ "James H. Fillmore"
+ ],
+ "ccli_number": 60252,
+ "comments": "",
+ "copyright": "Public Domain ",
+ "song_book_name": "DS",
+ "song_number": 0,
+ "title": "Beautiful Garden Of Prayer (Demonstration)",
+ "topics": [
+ "Devotion",
+ "Prayer"
+ ],
+ "verse_order_list": ["v1", "c1", "v2", "c1", "v3", "c1"],
+ "verses": [
+ [
+ "There's a garden where Jesus is waiting,\nThere's a place that is wondrously fair.\nFor it glows with the light of His presence,\n\n'Tis the beautiful garden of prayer.",
+ "v1"
+ ],
+ [
+ "There's a garden where Jesus is waiting,\nAnd I go with my burden and care.\nJust to learn from His lips, words of comfort,\n[---]\nIn the beautiful garden of prayer.",
+ "v2"
+ ],
+ [
+ "There's a garden where Jesus is waiting,\nAnd He bids you to come meet Him there,\nJust to bow and receive a new blessing,\n\nIn the beautiful garden of prayer.",
+ "v3"
+ ],
+ [
+ "O the beautiful garden, the garden of prayer,\nO the beautiful garden of prayer.\nThere my Savior awaits, and He opens the gates\n[---]\nTo the beautiful garden of prayer.",
+ "c1"
+ ]
+ ]
+}
\ No newline at end of file
diff --git a/tests/resources/opensongsongs/One, Two, Three, Four, Five b/tests/resources/opensongsongs/One, Two, Three, Four, Five
new file mode 100644
index 000000000..cc6bc107f
--- /dev/null
+++ b/tests/resources/opensongsongs/One, Two, Three, Four, Five
@@ -0,0 +1,38 @@
+
+
+ 12345
+ Traditional
+ Public Domain
+ T
+
+
+
+
+
+
+
+
+
+;Test [T]ag element - should be turned into [o]ther
+;And lines beginning with numbers
+;And a title that contains only numeric characters
+;That isdiffernt to the filename
+;And most elements are empty
+[T]
+ 1, 2, 3, 4, 5,
+ Once I caught a fish alive.
+ 6, 7, 8, 9, 10,
+ Then I let it go again.
+
+ Why did you let it go?
+ Because it bit my finger so.
+ Which finger did it bite?
+ This little finger on my right.
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tests/resources/opensongsongs/One, Two, Three, Four, Five.json b/tests/resources/opensongsongs/One, Two, Three, Four, Five.json
new file mode 100644
index 000000000..30fe71c64
--- /dev/null
+++ b/tests/resources/opensongsongs/One, Two, Three, Four, Five.json
@@ -0,0 +1,17 @@
+{
+ "authors": [
+ "Traditional"
+ ],
+ "comments": "",
+ "copyright": "Public Domain ",
+ "title": "12345",
+ "topics": [
+ ],
+ "verse_order_list": ["o1"],
+ "verses": [
+ [
+ "1, 2, 3, 4, 5,\nOnce I caught a fish alive.\n6, 7, 8, 9, 10,\nThen I let it go again.\nWhy did you let it go?\nBecause it bit my finger so.\nWhich finger did it bite?\nThis little finger on my right.",
+ "o1"
+ ]
+ ]
+}
\ No newline at end of file
diff --git a/tests/resources/propresentersongs/Amazing Grace.json b/tests/resources/propresentersongs/Amazing Grace.json
new file mode 100644
index 000000000..1746b7696
--- /dev/null
+++ b/tests/resources/propresentersongs/Amazing Grace.json
@@ -0,0 +1,121 @@
+{
+ "authors": [
+ "John Newton"
+ ],
+ "title": "Amazing Grace",
+ "verse_order_list": [],
+ "verses": [
+ [
+ "Amazing grace! How sweet the sound\n",
+ "v1"
+ ],
+ [
+ "That saved a wretch like me!\n",
+ "v2"
+ ],
+ [
+ "I once was lost, but now am found;\n",
+ "v3"
+ ],
+ [
+ "Was blind, but now I see.\n",
+ "v4"
+ ],
+ [
+ "'Twas grace that taught my heart to fear,\n",
+ "v5"
+ ],
+ [
+ "And grace my fears relieved;\n",
+ "v6"
+ ],
+ [
+ "How precious did that grace appear\n",
+ "v7"
+ ],
+ [
+ "The hour I first believed.\n",
+ "v8"
+ ],
+ [
+ "Through many dangers, toils and snares,\n",
+ "v9"
+ ],
+ [
+ "I have already come;\n",
+ "v10"
+ ],
+ [
+ "'Tis grace hath brought me safe thus far,\n",
+ "v11"
+ ],
+ [
+ "And grace will lead me home.\n",
+ "v12"
+ ],
+ [
+ "The Lord has promised good to me,\n",
+ "v13"
+ ],
+ [
+ "His Word my hope secures;\n",
+ "v14"
+ ],
+ [
+ "He will my Shield and Portion be,\n",
+ "v15"
+ ],
+ [
+ "As long as life endures.\n",
+ "v16"
+ ],
+ [
+ "Yea, when this flesh and heart shall fail,\n",
+ "v17"
+ ],
+ [
+ "And mortal life shall cease,\n",
+ "v18"
+ ],
+ [
+ "I shall possess, within the veil,\n",
+ "v19"
+ ],
+ [
+ "A life of joy and peace.\n",
+ "v20"
+ ],
+ [
+ "The earth shall soon dissolve like snow,\n",
+ "v21"
+ ],
+ [
+ "The sun forbear to shine;\n",
+ "v22"
+ ],
+ [
+ "But God, Who called me here below,\n",
+ "v23"
+ ],
+ [
+ "Shall be forever mine.\n",
+ "v24"
+ ],
+ [
+ "When we've been there ten thousand years,\n",
+ "v25"
+ ],
+ [
+ "Bright shining as the sun,\n",
+ "v26"
+ ],
+ [
+ "We've no less days to sing God's praise\n",
+ "v27"
+ ],
+ [
+ "Than when we'd first begun.\n",
+ "v28"
+ ]
+ ]
+}
\ No newline at end of file
diff --git a/tests/resources/propresentersongs/Amazing Grace.pro4 b/tests/resources/propresentersongs/Amazing Grace.pro4
new file mode 100644
index 000000000..dbe114a88
--- /dev/null
+++ b/tests/resources/propresentersongs/Amazing Grace.pro4
@@ -0,0 +1,486 @@
+
+
+
+
+
+
+
+ <_-RVRect3D-_position x="10" y="10" z="0" width="1004" height="748" />
+ <_-D-_serializedShadow containerClass="NSMutableDictionary">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <_-RVRect3D-_position x="10" y="10" z="0" width="1004" height="748" />
+ <_-D-_serializedShadow containerClass="NSMutableDictionary">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <_-RVRect3D-_position x="10" y="10" z="0" width="1004" height="748" />
+ <_-D-_serializedShadow containerClass="NSMutableDictionary">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <_-RVRect3D-_position x="10" y="10" z="0" width="1004" height="748" />
+ <_-D-_serializedShadow containerClass="NSMutableDictionary">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <_-RVRect3D-_position x="10" y="10" z="0" width="1004" height="748" />
+ <_-D-_serializedShadow containerClass="NSMutableDictionary">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <_-RVRect3D-_position x="10" y="10" z="0" width="1004" height="748" />
+ <_-D-_serializedShadow containerClass="NSMutableDictionary">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <_-RVRect3D-_position x="10" y="10" z="0" width="1004" height="748" />
+ <_-D-_serializedShadow containerClass="NSMutableDictionary">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <_-RVRect3D-_position x="10" y="10" z="0" width="1004" height="748" />
+ <_-D-_serializedShadow containerClass="NSMutableDictionary">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <_-RVRect3D-_position x="10" y="10" z="0" width="1004" height="748" />
+ <_-D-_serializedShadow containerClass="NSMutableDictionary">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <_-RVRect3D-_position x="10" y="10" z="0" width="1004" height="748" />
+ <_-D-_serializedShadow containerClass="NSMutableDictionary">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <_-RVRect3D-_position x="10" y="10" z="0" width="1004" height="748" />
+ <_-D-_serializedShadow containerClass="NSMutableDictionary">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <_-RVRect3D-_position x="10" y="10" z="0" width="1004" height="748" />
+ <_-D-_serializedShadow containerClass="NSMutableDictionary">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <_-RVRect3D-_position x="10" y="10" z="0" width="1004" height="748" />
+ <_-D-_serializedShadow containerClass="NSMutableDictionary">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <_-RVRect3D-_position x="10" y="10" z="0" width="1004" height="748" />
+ <_-D-_serializedShadow containerClass="NSMutableDictionary">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <_-RVRect3D-_position x="10" y="10" z="0" width="1004" height="748" />
+ <_-D-_serializedShadow containerClass="NSMutableDictionary">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <_-RVRect3D-_position x="10" y="10" z="0" width="1004" height="748" />
+ <_-D-_serializedShadow containerClass="NSMutableDictionary">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <_-RVRect3D-_position x="10" y="10" z="0" width="1004" height="748" />
+ <_-D-_serializedShadow containerClass="NSMutableDictionary">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <_-RVRect3D-_position x="10" y="10" z="0" width="1004" height="748" />
+ <_-D-_serializedShadow containerClass="NSMutableDictionary">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <_-RVRect3D-_position x="10" y="10" z="0" width="1004" height="748" />
+ <_-D-_serializedShadow containerClass="NSMutableDictionary">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <_-RVRect3D-_position x="10" y="10" z="0" width="1004" height="748" />
+ <_-D-_serializedShadow containerClass="NSMutableDictionary">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <_-RVRect3D-_position x="10" y="10" z="0" width="1004" height="748" />
+ <_-D-_serializedShadow containerClass="NSMutableDictionary">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <_-RVRect3D-_position x="10" y="10" z="0" width="1004" height="748" />
+ <_-D-_serializedShadow containerClass="NSMutableDictionary">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <_-RVRect3D-_position x="10" y="10" z="0" width="1004" height="748" />
+ <_-D-_serializedShadow containerClass="NSMutableDictionary">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <_-RVRect3D-_position x="10" y="10" z="0" width="1004" height="748" />
+ <_-D-_serializedShadow containerClass="NSMutableDictionary">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <_-RVRect3D-_position x="10" y="10" z="0" width="1004" height="748" />
+ <_-D-_serializedShadow containerClass="NSMutableDictionary">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <_-RVRect3D-_position x="10" y="10" z="0" width="1004" height="748" />
+ <_-D-_serializedShadow containerClass="NSMutableDictionary">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <_-RVRect3D-_position x="10" y="10" z="0" width="1004" height="748" />
+ <_-D-_serializedShadow containerClass="NSMutableDictionary">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <_-RVRect3D-_position x="10" y="10" z="0" width="1004" height="748" />
+ <_-D-_serializedShadow containerClass="NSMutableDictionary">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tests/resources/songshowplussongs/a mighty fortress is our god.json b/tests/resources/songshowplussongs/a mighty fortress is our god.json
new file mode 100644
index 000000000..2788ad05c
--- /dev/null
+++ b/tests/resources/songshowplussongs/a mighty fortress is our god.json
@@ -0,0 +1,31 @@
+{
+ "authors": [
+ "Martin Luther"
+ ],
+ "ccli_number": 12456,
+ "comments": "",
+ "copyright": "Public Domain",
+ "song_number": 0,
+ "title": "A Mighty Fortress is our God",
+ "topics": [],
+ "verse_order_list": [],
+ "verses": [
+ [
+ "A mighty fortress is our God, a bulwark never failing;\r\nOur helper He, amid the flood of mortal ills prevailing:\r\nFor still our ancient foe doth seek to work us woe;\r\nHis craft and power are great, and, armed with cruel hate,\r\nOn earth is not his equal.\r\n",
+ "v1"
+ ],
+ [
+ "Did we in our own strength confide, our striving would be losing;\r\nWere not the right Man on our side, the Man of Godâs own choosing:\r\nDost ask who that may be? Christ Jesus, it is He;\r\nLord Sabaoth, His Name, from age to age the same,\r\nAnd He must win the battle.\r\n",
+ "v2"
+ ],
+ [
+ "And though this world, with devils filled, should threaten to undo us,\r\nWe will not fear, for God hath willed His truth to triumph through us:\r\nThe Prince of Darkness grim, we tremble not for him;\r\nHis rage we can endure, for lo, his doom is sure,\r\nOne little word shall fell him.\r\n",
+ "v3"
+ ],
+ [
+ "That word above all earthly powers, no thanks to them, abideth;\r\nThe Spirit and the gifts are ours through Him Who with us sideth:\r\nLet goods and kindred go, this mortal life also;\r\nThe body they may kill: Godâs truth abideth still,\r\nHis kingdom is forever.\r\n",
+ "v4"
+ ]
+ ]
+}
+
diff --git a/tests/resources/songshowplussongs/a mighty fortress is our god.sbsong b/tests/resources/songshowplussongs/a mighty fortress is our god.sbsong
new file mode 100644
index 000000000..b66d52b2b
Binary files /dev/null and b/tests/resources/songshowplussongs/a mighty fortress is our god.sbsong differ
diff --git a/tests/resources/worshipassistantsongs/du_herr.csv b/tests/resources/worshipassistantsongs/du_herr.csv
new file mode 100644
index 000000000..72c5b4735
--- /dev/null
+++ b/tests/resources/worshipassistantsongs/du_herr.csv
@@ -0,0 +1,30 @@
+"SongID","SongNr","Title","Author","Copyright","FirstLine","PriKey","AltKey","Tempo","Focus","Theme","Scripture","Active","Songbook","TimeSig","Introduced","LastUsed","TimesUsed","CCLINr","User1","User2","User3","User4","User5","Roadmap","Overmap","FileLink1","FileLink2","Updated","Lyrics","Info","Lyrics2","Background"
+"4ee399dc-edda-4aa9-891e-a859ca093c78","NULL","Du, Herr, verläßt mich nicht","Carl Brockhaus / Johann Georg Bäßler 1806","NULL","NULL","NULL","NULL","NULL","NULL","NULL","NULL","1","1","NULL","NULL","NULL","NULL","NULL","NULL","NULL","NULL","NULL","NULL","NULL","NULL","NULL","NULL","2014-06-25 12:15:28.317","","NULL","[1]
+Du, Herr, verläßt mich nicht.
+Auf Dich mein Herz allein vertraut,
+Mein Auge glaubend auf Dich schaut.
+Du bist mein Heil, mein Licht,
+Mein Fels, mein sichrer Hort.
+Bin ich versucht, gibt's Not und Leid,
+Du bleibst mein Trost, mein Arm im Streit,
+Mein Licht am dunklen Ort.
+
+[2]
+Ich weiß, daß Du mich liebst.
+Bist mir in jeder Lage nah',
+Wohin ich gehe – Du bist da,
+Ja, Du mir alles gibst.
+Ich überlaß mich Dir;
+Denn Du, Herr, kennst mich ganz und gar
+Und führst mich sicher, wunderbar,
+Und bist selbst alles mir.
+
+[3]
+In dieser Wüste hier
+Find't nirgend meine Seele Ruh',
+Denn meine Ruh' bist, Jesu, Du.
+Wohl mir, ich geh' zu Dir!
+Bald werd' ich bei Dir sein,
+Bald mit den Deinen ewiglich
+Anbeten, loben, preisen Dich,
+Mich Deiner stets erfreun.","NULL"
diff --git a/tests/resources/worshipassistantsongs/du_herr.json b/tests/resources/worshipassistantsongs/du_herr.json
new file mode 100644
index 000000000..1df700df8
--- /dev/null
+++ b/tests/resources/worshipassistantsongs/du_herr.json
@@ -0,0 +1,21 @@
+{
+ "authors": [
+ "Carl Brockhaus / Johann Georg Bäßler 1806"
+ ],
+ "title": "Du, Herr, verläßt mich nicht",
+ "verse_order_list": [],
+ "verses": [
+ [
+ "Du, Herr, verläßt mich nicht.\nAuf Dich mein Herz allein vertraut,\nMein Auge glaubend auf Dich schaut.\nDu bist mein Heil, mein Licht,\nMein Fels, mein sichrer Hort.\nBin ich versucht, gibt's Not und Leid,\nDu bleibst mein Trost, mein Arm im Streit,\nMein Licht am dunklen Ort.\n",
+ "v1"
+ ],
+ [
+ "Ich weiß, daß Du mich liebst.\nBist mir in jeder Lage nah',\nWohin ich gehe – Du bist da,\nJa, Du mir alles gibst.\nIch überlaß mich Dir;\nDenn Du, Herr, kennst mich ganz und gar\nUnd führst mich sicher, wunderbar,\nUnd bist selbst alles mir.\n",
+ "v2"
+ ],
+ [
+ "In dieser Wüste hier\nFind't nirgend meine Seele Ruh',\nDenn meine Ruh' bist, Jesu, Du.\nWohl mir, ich geh' zu Dir!\nBald werd' ich bei Dir sein,\nBald mit den Deinen ewiglich\nAnbeten, loben, preisen Dich,\nMich Deiner stets erfreun.\n",
+ "v3"
+ ]
+ ]
+}
diff --git a/tests/resources/worshipassistantsongs/would_you_be_free.csv b/tests/resources/worshipassistantsongs/would_you_be_free.csv
new file mode 100644
index 000000000..a454ddbf5
--- /dev/null
+++ b/tests/resources/worshipassistantsongs/would_you_be_free.csv
@@ -0,0 +1,30 @@
+SONGNR,TITLE,AUTHOR,COPYRIGHT,FIRSTLINE,PRIKEY,ALTKEY,TEMPO,FOCUS,THEME,SCRIPTURE,ACTIVE,SONGBOOK,TIMESIG,INTRODUCED,LASTUSED,TIMESUSED,CCLINR,USER1,USER2,USER3,USER4,USER5,ROADMAP,FILELINK1,OVERMAP,FILELINK2,LYRICS,INFO,LYRICS2,Background
+"7","Would You Be Free","Jones, Lewis E.","Public Domain","Would you be free from your burden of sin?","G","","Moderate","Only To Others","","","N","Y","","1899-12-30","1899-12-30","","","","","","","","1,C,1","","","",".G C G
+ Would you be free from your burden of sin?
+. D D7 G
+ There's power in the blood, power in the blood
+. C G
+ Would you o'er evil a victory win?
+. D D7 G
+ There's wonderful power in the blood
+
+.G C G
+ There is power, power, wonder working power
+.D G
+ In the blood of the Lamb
+. C G
+ There is power, power, wonder working power
+. D G
+ In the precious blood of the Lamb
+","","[1]
+Would you be free from your burden of sin?
+There's power in the blood, power in the blood
+Would you o'er evil a victory win?
+There's wonderful power in the blood
+
+[C]
+There is power, power, wonder working power
+In the blood of the Lamb
+There is power, power, wonder working power
+In the precious blood of the Lamb
+",""
diff --git a/tests/resources/worshipassistantsongs/would_you_be_free.json b/tests/resources/worshipassistantsongs/would_you_be_free.json
new file mode 100644
index 000000000..96bc06a59
--- /dev/null
+++ b/tests/resources/worshipassistantsongs/would_you_be_free.json
@@ -0,0 +1,19 @@
+{
+ "authors": [
+ "Jones",
+ "Lewis E"
+ ],
+ "title": "Would You Be Free",
+ "verse_order_list": ["v1", "c1", "v1"],
+ "copyright": "Public Domain",
+ "verses": [
+ [
+ "Would you be free from your burden of sin? \nThere's power in the blood, power in the blood \nWould you o'er evil a victory win? \nThere's wonderful power in the blood \n",
+ "v1"
+ ],
+ [
+ "There is power, power, wonder working power \nIn the blood of the Lamb \nThere is power, power, wonder working power \nIn the precious blood of the Lamb \n",
+ "c1"
+ ]
+ ]
+}
diff --git a/tests/utils/test_bzr_tags.py b/tests/utils/test_bzr_tags.py
index 95017e94f..acadbd8c4 100644
--- a/tests/utils/test_bzr_tags.py
+++ b/tests/utils/test_bzr_tags.py
@@ -50,9 +50,6 @@ TAGS = [
['1.9.11', '2039'],
['1.9.12', '2063'],
['2.0', '2118'],
- ['2.0.1', '?'],
- ['2.0.2', '?'],
- ['2.0.3', '?'],
['2.1.0', '2119']
]