diff --git a/openlp/.version b/openlp/.version index d41002840..3245d0c77 100644 --- a/openlp/.version +++ b/openlp/.version @@ -1 +1 @@ -2.1.0-bzr2141 +2.1.0-bzr2234 diff --git a/openlp/core/lib/__init__.py b/openlp/core/lib/__init__.py index 9a367c9b5..d6c338271 100644 --- a/openlp/core/lib/__init__.py +++ b/openlp/core/lib/__init__.py @@ -30,6 +30,7 @@ The :mod:`lib` module contains most of the components and libraries that make OpenLP work. """ +from __future__ import division from distutils.version import LooseVersion import logging import os @@ -202,12 +203,13 @@ def create_thumb(image_path, thumb_path, return_icon=True, size=None): States if an icon should be build and returned from the thumb. Defaults to ``True``. ``size`` - Allows to state a own size to use. Defaults to ``None``, which means that a default height of 88 is used. + Allows to state a own size (QtCore.QSize) to use. Defaults to ``None``, which means that a default height of 88 + is used. """ ext = os.path.splitext(thumb_path)[1].lower() reader = QtGui.QImageReader(image_path) if size is None: - ratio = float(reader.size().width()) / float(reader.size().height()) + ratio = reader.size().width() / reader.size().height() reader.setScaledSize(QtCore.QSize(int(ratio * 88), 88)) else: reader.setScaledSize(size) @@ -260,8 +262,8 @@ def resize_image(image_path, width, height, background=u'#000000'): log.debug(u'resize_image - start') reader = QtGui.QImageReader(image_path) # The image's ratio. - image_ratio = float(reader.size().width()) / float(reader.size().height()) - resize_ratio = float(width) / float(height) + image_ratio = reader.size().width() / reader.size().height() + resize_ratio = width / height # Figure out the size we want to resize the image to (keep aspect ratio). if image_ratio == resize_ratio: size = QtCore.QSize(width, height) @@ -282,7 +284,7 @@ def resize_image(image_path, width, height, background=u'#000000'): new_image = QtGui.QImage(width, height, QtGui.QImage.Format_ARGB32_Premultiplied) painter = QtGui.QPainter(new_image) painter.fillRect(new_image.rect(), QtGui.QColor(background)) - painter.drawImage((width - real_width) / 2, (height - real_height) / 2, preview) + painter.drawImage((width - real_width) // 2, (height - real_height) // 2, preview) return new_image diff --git a/openlp/core/lib/dockwidget.py b/openlp/core/lib/dockwidget.py index 30182c901..15c116e0f 100644 --- a/openlp/core/lib/dockwidget.py +++ b/openlp/core/lib/dockwidget.py @@ -30,6 +30,7 @@ """ Provide additional functionality required by OpenLP from the inherited QDockWidget. """ +from __future__ import division import logging from PyQt4 import QtGui @@ -55,7 +56,7 @@ class OpenLPDockWidget(QtGui.QDockWidget): self.setWindowIcon(build_icon(icon)) # Sort out the minimum width. screens = ScreenList() - main_window_docbars = screens.current[u'size'].width() / 5 + main_window_docbars = screens.current[u'size'].width() // 5 if main_window_docbars > 300: self.setMinimumWidth(300) else: diff --git a/openlp/core/lib/htmlbuilder.py b/openlp/core/lib/htmlbuilder.py index 9c8b04076..d4e22b0dd 100644 --- a/openlp/core/lib/htmlbuilder.py +++ b/openlp/core/lib/htmlbuilder.py @@ -26,7 +26,7 @@ # with this program; if not, write to the Free Software Foundation, Inc., 59 # # Temple Place, Suite 330, Boston, MA 02111-1307 USA # ############################################################################### - +from __future__ import division import logging from PyQt4 import QtWebKit @@ -276,7 +276,7 @@ def build_background_css(item, width): ``item`` Service Item containing theme and location information """ - width = int(width) / 2 + width = int(width) // 2 theme = item.themedata background = u'background-color: black' if theme: diff --git a/openlp/core/lib/mediamanageritem.py b/openlp/core/lib/mediamanageritem.py index cd2dcc67e..c3e1fa366 100644 --- a/openlp/core/lib/mediamanageritem.py +++ b/openlp/core/lib/mediamanageritem.py @@ -102,7 +102,6 @@ class MediaManagerItem(QtGui.QWidget): self.setupUi() self.retranslateUi() self.auto_select_id = -1 - Registry().register_function(u'%s_service_load' % self.plugin.name, self.service_load) # Need to use event as called across threads and UI is updated QtCore.QObject.connect(self, QtCore.SIGNAL(u'%s_go_live' % self.plugin.name), self.go_live_remote) QtCore.QObject.connect(self, QtCore.SIGNAL(u'%s_add_to_service' % self.plugin.name), self.add_to_service_remote) @@ -585,12 +584,15 @@ class MediaManagerItem(QtGui.QWidget): else: return None - def service_load(self, message): + def service_load(self, item): """ Method to add processing when a service has been loaded and individual service items need to be processed by the plugins. + + ``item`` + The item to be processed and returned. """ - pass + return item def check_search_result(self): """ diff --git a/openlp/core/lib/renderer.py b/openlp/core/lib/renderer.py index c426e8871..5161246c0 100644 --- a/openlp/core/lib/renderer.py +++ b/openlp/core/lib/renderer.py @@ -26,7 +26,7 @@ # with this program; if not, write to the Free Software Foundation, Inc., 59 # # Temple Place, Suite 330, Boston, MA 02111-1307 USA # ############################################################################### - +from __future__ import division import logging from PyQt4 import QtGui, QtCore, QtWebKit @@ -327,7 +327,7 @@ class Renderer(object): screen_size = self.screens.current[u'size'] self.width = screen_size.width() self.height = screen_size.height() - self.screen_ratio = float(self.height) / float(self.width) + self.screen_ratio = self.height / self.width log.debug(u'_calculate default %s, %f' % (screen_size, self.screen_ratio)) # 90% is start of footer self.footer_start = int(self.height * 0.90) @@ -546,15 +546,15 @@ class Renderer(object): """ smallest_index = 0 highest_index = len(html_list) - 1 - index = int(highest_index / 2) + index = highest_index // 2 while True: if not self._text_fits_on_slide(previous_html + separator.join(html_list[:index + 1]).strip()): # We know that it does not fit, so change/calculate the new index and highest_index accordingly. highest_index = index - index = int(index - (index - smallest_index) / 2) + index = index - (index - smallest_index) // 2 else: smallest_index = index - index = int(index + (highest_index - index) / 2) + index = index + (highest_index - index) // 2 # We found the number of words which will fit. if smallest_index == index or highest_index == index: index = smallest_index @@ -582,7 +582,7 @@ class Renderer(object): html_list[0] = html_tags + html_list[0] smallest_index = 0 highest_index = len(html_list) - 1 - index = int(highest_index / 2) + index = highest_index // 2 return previous_html, previous_raw def _text_fits_on_slide(self, text): diff --git a/openlp/core/lib/screen.py b/openlp/core/lib/screen.py index 84e7e4258..146b492db 100644 --- a/openlp/core/lib/screen.py +++ b/openlp/core/lib/screen.py @@ -30,6 +30,7 @@ The :mod:`screen` module provides management functionality for a machines' displays. """ +from __future__ import division import logging import copy @@ -232,8 +233,8 @@ class ScreenList(object): ``window`` A QWidget we are finding the location of. """ - x = window.x() + (window.width() / 2) - y = window.y() + (window.height() / 2) + x = window.x() + (window.width() // 2) + y = window.y() + (window.height() // 2) for screen in self.screen_list: size = screen[u'size'] if x >= size.x() and x <= (size.x() + size.width()) and y >= size.y() and y <= (size.y() + size.height()): diff --git a/openlp/core/lib/searchedit.py b/openlp/core/lib/searchedit.py index 9623b0f53..a0c51cb74 100644 --- a/openlp/core/lib/searchedit.py +++ b/openlp/core/lib/searchedit.py @@ -26,7 +26,7 @@ # with this program; if not, write to the Free Software Foundation, Inc., 59 # # Temple Place, Suite 330, Boston, MA 02111-1307 USA # ############################################################################### - +from __future__ import division import logging from PyQt4 import QtCore, QtGui @@ -85,10 +85,10 @@ class SearchEdit(QtGui.QLineEdit): size = self.clear_button.size() frame_width = self.style().pixelMetric(QtGui.QStyle.PM_DefaultFrameWidth) self.clear_button.move(self.rect().right() - frame_width - size.width(), - (self.rect().bottom() + 1 - size.height()) / 2) + (self.rect().bottom() + 1 - size.height()) // 2) if hasattr(self, u'menu_button'): size = self.menu_button.size() - self.menu_button.move(self.rect().left() + frame_width + 2, (self.rect().bottom() + 1 - size.height()) / 2) + self.menu_button.move(self.rect().left() + frame_width + 2, (self.rect().bottom() + 1 - size.height()) // 2) def current_search_type(self): """ diff --git a/openlp/core/lib/serviceitem.py b/openlp/core/lib/serviceitem.py index c4ac846c9..b32e1aaf0 100644 --- a/openlp/core/lib/serviceitem.py +++ b/openlp/core/lib/serviceitem.py @@ -58,8 +58,7 @@ class ItemCapabilities(object): Provides an enumeration of a service item's capabilities ``CanPreview`` - The capability to allow the ServiceManager to add to the preview - tab when making the previous item live. + The capability to allow the ServiceManager to add to the preview tab when making the previous item live. ``CanEdit`` The capability to allow the ServiceManager to allow the item to be edited @@ -71,8 +70,7 @@ class ItemCapabilities(object): Determines is the service_item needs a Media Player ``CanLoop`` - The capability to allow the SlideController to allow the loop - processing. + The capability to allow the SlideController to allow the loop processing. ``CanAppend`` The capability to allow the ServiceManager to add leaves to the @@ -82,22 +80,19 @@ class ItemCapabilities(object): The capability to remove lines breaks in the renderer ``OnLoadUpdate`` - The capability to update MediaManager when a service Item is - loaded. + The capability to update MediaManager when a service Item is loaded. ``AddIfNewItem`` Not Used ``ProvidesOwnDisplay`` - The capability to tell the SlideController the service Item has a - different display. + The capability to tell the SlideController the service Item has a different display. ``HasDetailedTitleDisplay`` - ServiceItem provides a title + Being Removed and decommissioned. ``HasVariableStartTime`` - The capability to tell the ServiceManager that a change to start - time is possible. + The capability to tell the ServiceManager that a change to start time is possible. ``CanSoftBreak`` The capability to tell the renderer that Soft Break is allowed @@ -149,7 +144,7 @@ class ServiceItem(object): if plugin: self.name = plugin.name self.title = u'' - self.shortname = u'' + self.processor = None self.audit = u'' self.items = [] self.iconic_representation = None @@ -353,7 +348,8 @@ class ServiceItem(object): u'media_length': self.media_length, u'background_audio': self.background_audio, u'theme_overwritten': self.theme_overwritten, - u'will_auto_start': self.will_auto_start + u'will_auto_start': self.will_auto_start, + u'processor': self.processor } service_data = [] if self.service_item_type == ServiceItemType.Text: @@ -387,7 +383,6 @@ class ServiceItem(object): self.title = header[u'title'] self.name = header[u'name'] self.service_item_type = header[u'type'] - self.shortname = header[u'plugin'] self.theme = header[u'theme'] self.add_icon(header[u'icon']) self.raw_footer = header[u'footer'] @@ -406,7 +401,13 @@ class ServiceItem(object): self.auto_play_slides_loop = header.get(u'auto_play_slides_loop', False) self.timed_slide_interval = header.get(u'timed_slide_interval', 0) self.will_auto_start = header.get(u'will_auto_start', False) + self.processor = header.get(u'processor', None) self.has_original_files = True + #TODO Remove me in 2,3 build phase + if self.is_capable(ItemCapabilities.HasDetailedTitleDisplay): + self.capabilities.remove(ItemCapabilities.HasDetailedTitleDisplay) + self.processor = self.title + self.title = None if u'background_audio' in header: self.background_audio = [] for filename in header[u'background_audio']: @@ -429,6 +430,8 @@ class ServiceItem(object): self.add_from_image(text_image[u'path'], text_image[u'title'], background) elif self.service_item_type == ServiceItemType.Command: for text_image in serviceitem[u'serviceitem'][u'data']: + if not self.title: + self.title = text_image[u'title'] if path: self.has_original_files = False self.add_from_command(path, text_image[u'title'], text_image[u'image']) @@ -443,9 +446,7 @@ class ServiceItem(object): if self.is_text(): return self.title else: - if ItemCapabilities.HasDetailedTitleDisplay in self.capabilities: - return self._raw_frames[0][u'title'] - elif len(self._raw_frames) > 1: + if len(self._raw_frames) > 1: return self.title else: return self._raw_frames[0][u'title'] diff --git a/openlp/core/lib/settings.py b/openlp/core/lib/settings.py index 49cd8f6d5..5e73ffc1d 100644 --- a/openlp/core/lib/settings.py +++ b/openlp/core/lib/settings.py @@ -271,6 +271,7 @@ class Settings(QtCore.QSettings): u'shortcuts/songImportItem': [], u'shortcuts/themeScreen': [QtGui.QKeySequence(u'T')], u'shortcuts/toolsReindexItem': [], + u'shortcuts/toolsFindDuplicates': [], u'shortcuts/toolsAlertItem': [QtGui.QKeySequence(u'F7')], u'shortcuts/toolsFirstTimeWizard': [], u'shortcuts/toolsOpenDataFolder': [], diff --git a/openlp/core/lib/settingstab.py b/openlp/core/lib/settingstab.py index d63f9c678..ab775599a 100644 --- a/openlp/core/lib/settingstab.py +++ b/openlp/core/lib/settingstab.py @@ -30,6 +30,7 @@ The :mod:`~openlp.core.lib.settingstab` module contains the base SettingsTab class which plugins use for adding their own tab to the settings dialog. """ +from __future__ import division from PyQt4 import QtGui @@ -90,7 +91,7 @@ class SettingsTab(QtGui.QWidget): QtGui.QWidget.resizeEvent(self, event) width = self.width() - self.tab_layout.spacing() - \ self.tab_layout.contentsMargins().left() - self.tab_layout.contentsMargins().right() - left_width = min(width - self.right_column.minimumSizeHint().width(), width / 2) + left_width = min(width - self.right_column.minimumSizeHint().width(), width // 2) left_width = max(left_width, self.left_column.minimumSizeHint().width()) self.left_column.setFixedWidth(left_width) diff --git a/openlp/core/ui/listpreviewwidget.py b/openlp/core/ui/listpreviewwidget.py new file mode 100644 index 000000000..ae6d0bed8 --- /dev/null +++ b/openlp/core/ui/listpreviewwidget.py @@ -0,0 +1,173 @@ +# -*- 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:`listpreviewwidget` is a widget that lists the slides in the slide controller. +It is based on a QTableWidget but represents its contents in list form. +""" +from __future__ import division +from PyQt4 import QtCore, QtGui + +from openlp.core.lib import ImageSource, Registry, ServiceItem + + +class ListPreviewWidget(QtGui.QTableWidget): + def __init__(self, parent, screen_ratio): + """ + Initializes the widget to default state. + An empty ServiceItem is used per default. + One needs to call replace_service_manager_item() to make this widget display something. + """ + super(QtGui.QTableWidget, self).__init__(parent) + # Set up the widget. + self.setColumnCount(1) + self.horizontalHeader().setVisible(False) + self.setColumnWidth(0, parent.width()) + self.setSelectionBehavior(QtGui.QAbstractItemView.SelectRows) + self.setSelectionMode(QtGui.QAbstractItemView.SingleSelection) + self.setEditTriggers(QtGui.QAbstractItemView.NoEditTriggers) + self.setHorizontalScrollBarPolicy(QtCore.Qt.ScrollBarAlwaysOff) + self.setAlternatingRowColors(True) + # Initialize variables. + self.service_item = ServiceItem() + self.screen_ratio = screen_ratio + + def resizeEvent(self, QResizeEvent): + """ + Overloaded method from QTableWidget. Will recalculate the layout. + """ + self.__recalculate_layout() + + def __recalculate_layout(self): + """ + Recalculates the layout of the table widget. It will set height and width + of the table cells. QTableWidget does not adapt the cells to the widget size on its own. + """ + self.setColumnWidth(0, self.viewport().width()) + if self.service_item: + # Sort out songs, bibles, etc. + if self.service_item.is_text(): + self.resizeRowsToContents() + else: + # Sort out image heights. + for framenumber in range(len(self.service_item.get_frames())): + height = self.viewport().width() // self.screen_ratio + self.setRowHeight(framenumber, height) + + def screen_size_changed(self, screen_ratio): + """ + To be called whenever the live screen size changes. + Because this makes a layout recalculation necessary. + """ + self.screen_ratio = screen_ratio + self.__recalculate_layout() + + def replace_service_item(self, service_item, width, slideNumber): + """ + Replaces the current preview items with the ones in service_item. + Displays the given slide. + """ + self.service_item = service_item + self.clear() + self.setRowCount(0) + self.setColumnWidth(0, width) + row = 0 + text = [] + for framenumber, frame in enumerate(self.service_item.get_frames()): + self.setRowCount(self.slide_count() + 1) + item = QtGui.QTableWidgetItem() + slide_height = 0 + if self.service_item.is_text(): + if frame[u'verseTag']: + # These tags are already translated. + verse_def = frame[u'verseTag'] + verse_def = u'%s%s' % (verse_def[0], verse_def[1:]) + two_line_def = u'%s\n%s' % (verse_def[0], verse_def[1:]) + row = two_line_def + else: + row += 1 + item.setText(frame[u'text']) + else: + label = QtGui.QLabel() + label.setMargin(4) + if self.service_item.is_media(): + label.setAlignment(QtCore.Qt.AlignHCenter | QtCore.Qt.AlignVCenter) + else: + label.setScaledContents(True) + if self.service_item.is_command(): + label.setPixmap(QtGui.QPixmap(frame[u'image'])) + else: + image = self.image_manager.get_image(frame[u'path'], ImageSource.ImagePlugin) + label.setPixmap(QtGui.QPixmap.fromImage(image)) + self.setCellWidget(framenumber, 0, label) + slide_height = width // self.screen_ratio + row += 1 + text.append(unicode(row)) + self.setItem(framenumber, 0, item) + if slide_height: + self.setRowHeight(framenumber, slide_height) + self.setVerticalHeaderLabels(text) + if self.service_item.is_text(): + self.resizeRowsToContents() + self.setColumnWidth(0, self.viewport().width()) + self.setFocus() + self.change_slide(slideNumber) + + def change_slide(self, slide): + """ + Switches to the given row. + """ + if slide >= self.slide_count(): + slide = self.slide_count() - 1 + # Scroll to next item if possible. + if slide + 1 < self.slide_count(): + self.scrollToItem(self.item(slide + 1, 0)) + self.selectRow(slide) + + def current_slide_number(self): + """ + Returns the position of the currently active item. Will return -1 if the widget is empty. + """ + return super(ListPreviewWidget, self).currentRow() + + def slide_count(self): + """ + Returns the number of slides this widget holds. + """ + return super(ListPreviewWidget, self).rowCount() + + def _get_image_manager(self): + """ + Adds the image manager to the class dynamically. + """ + if not hasattr(self, u'_image_manager'): + self._image_manager = Registry().get(u'image_manager') + return self._image_manager + + image_manager = property(_get_image_manager) + diff --git a/openlp/core/ui/maindisplay.py b/openlp/core/ui/maindisplay.py index 2504520c0..7069cb9b7 100644 --- a/openlp/core/ui/maindisplay.py +++ b/openlp/core/ui/maindisplay.py @@ -35,6 +35,7 @@ Some of the code for this form is based on the examples at: * `http://html5demos.com/two-videos`_ """ +from __future__ import division import cgi import logging import sys @@ -207,8 +208,8 @@ class MainDisplay(Display): painter_image.begin(self.initial_fame) painter_image.fillRect(self.initial_fame.rect(), background_color) painter_image.drawImage( - (self.screen[u'size'].width() - splash_image.width()) / 2, - (self.screen[u'size'].height() - splash_image.height()) / 2, + (self.screen[u'size'].width() - splash_image.width()) // 2, + (self.screen[u'size'].height() - splash_image.height()) // 2, splash_image) service_item = ServiceItem() service_item.bg_image_bytes = image_to_byte(self.initial_fame) @@ -268,7 +269,7 @@ class MainDisplay(Display): self.resize(self.width(), alert_height) self.setVisible(True) if location == AlertLocation.Middle: - self.move(self.screen[u'size'].left(), (self.screen[u'size'].height() - alert_height) / 2) + self.move(self.screen[u'size'].left(), (self.screen[u'size'].height() - alert_height) // 2) elif location == AlertLocation.Bottom: self.move(self.screen[u'size'].left(), self.screen[u'size'].height() - alert_height) else: @@ -287,7 +288,7 @@ class MainDisplay(Display): self.image(path) # Update the preview frame. if self.is_live: - self.live_controller.updatePreview() + self.live_controller.update_preview() return True def image(self, path): diff --git a/openlp/core/ui/mainwindow.py b/openlp/core/ui/mainwindow.py index 2afbb4eb0..4607c441f 100644 --- a/openlp/core/ui/mainwindow.py +++ b/openlp/core/ui/mainwindow.py @@ -669,7 +669,7 @@ class MainWindow(QtGui.QMainWindow, Ui_MainWindow): Check and display message if screen blank on setup. """ settings = Settings() - self.live_controller.mainDisplaySetBackground() + self.live_controller.main_display_set_background() if settings.value(u'%s/screen blank' % self.general_settings_section): if settings.value(u'%s/blank warning' % self.general_settings_section): QtGui.QMessageBox.question(self, translate('OpenLP.MainWindow', 'OpenLP Main Display Blanked'), @@ -779,8 +779,8 @@ class MainWindow(QtGui.QMainWindow, Ui_MainWindow): """ We need to make sure, that the SlidePreview's size is correct. """ - self.preview_controller.previewSizeChanged() - self.live_controller.previewSizeChanged() + self.preview_controller.preview_size_changed() + self.live_controller.preview_size_changed() def on_settings_shortcuts_item_clicked(self): """ @@ -989,8 +989,8 @@ class MainWindow(QtGui.QMainWindow, Ui_MainWindow): self.application.set_busy_cursor() self.image_manager.update_display() self.renderer.update_display() - self.preview_controller.screenSizeChanged() - self.live_controller.screenSizeChanged() + self.preview_controller.screen_size_changed() + self.live_controller.screen_size_changed() self.setFocus() self.activateWindow() self.application.set_normal_cursor() diff --git a/openlp/core/ui/media/mediacontroller.py b/openlp/core/ui/media/mediacontroller.py index 1e011a84d..71f2b4b10 100644 --- a/openlp/core/ui/media/mediacontroller.py +++ b/openlp/core/ui/media/mediacontroller.py @@ -466,8 +466,8 @@ class MediaController(object): The ServiceItem containing the details to be played. """ used_players = get_media_players()[0] - if service_item.title != UiStrings().Automatic: - used_players = [service_item.title.lower()] + if service_item.processor != UiStrings().Automatic: + used_players = [service_item.processor.lower()] if controller.media_info.file_info.isFile(): suffix = u'*.%s' % controller.media_info.file_info.suffix().lower() for title in used_players: diff --git a/openlp/core/ui/pluginform.py b/openlp/core/ui/pluginform.py index 954203d26..dd497bd68 100644 --- a/openlp/core/ui/pluginform.py +++ b/openlp/core/ui/pluginform.py @@ -31,7 +31,7 @@ The actual plugin view form """ import logging -from PyQt4 import QtCore, QtGui +from PyQt4 import QtGui from openlp.core.lib import PluginStatus, Registry, translate from plugindialog import Ui_PluginViewDialog diff --git a/openlp/core/ui/servicemanager.py b/openlp/core/ui/servicemanager.py index 1929f444c..444edc814 100644 --- a/openlp/core/ui/servicemanager.py +++ b/openlp/core/ui/servicemanager.py @@ -715,13 +715,10 @@ class ServiceManager(QtGui.QWidget, ServiceManagerDialog): else: service_item.set_from_service(item, self.servicePath) service_item.validate_item(self.suffixes) - self.load_item_unique_identifier = 0 if service_item.is_capable(ItemCapabilities.OnLoadUpdate): - Registry().execute(u'%s_service_load' % service_item.name.lower(), service_item) - # if the item has been processed - if service_item.unique_identifier == self.load_item_unique_identifier: - service_item.edit_id = int(self.load_item_edit_id) - service_item.temporary_edit = self.load_item_temporary + new_item = Registry().get(service_item.name).service_load(service_item) + if new_item: + service_item = new_item self.add_service_item(service_item, repaint=False) delete_file(p_file) self.main_window.add_recent_file(file_name) @@ -1260,14 +1257,6 @@ class ServiceManager(QtGui.QWidget, ServiceManagerDialog): self.repaint_service_list(-1, -1) self.application.set_normal_cursor() - def service_item_update(self, edit_id, unique_identifier, temporary=False): - """ - Triggered from plugins to update service items. Save the values as they will be used as part of the service load - """ - self.load_item_unique_identifier = unique_identifier - self.load_item_edit_id = int(edit_id) - self.load_item_temporary = str_to_bool(temporary) - def replace_service_item(self, newItem): """ Using the service item passed replace the one with the same edit id if found. @@ -1278,7 +1267,7 @@ class ServiceManager(QtGui.QWidget, ServiceManagerDialog): newItem.merge(item[u'service_item']) item[u'service_item'] = newItem self.repaint_service_list(item_count + 1, 0) - self.live_controller.replaceServiceManagerItem(newItem) + self.live_controller.replace_service_manager_item(newItem) self.set_modified() def add_service_item(self, item, rebuild=False, expand=None, replace=False, repaint=True, selected=False): @@ -1300,7 +1289,7 @@ class ServiceManager(QtGui.QWidget, ServiceManagerDialog): item.merge(self.service_items[sitem][u'service_item']) self.service_items[sitem][u'service_item'] = item self.repaint_service_list(sitem, child) - self.live_controller.replaceServiceManagerItem(item) + self.live_controller.replace_service_manager_item(item) else: item.render() # nothing selected for dnd @@ -1323,7 +1312,7 @@ class ServiceManager(QtGui.QWidget, ServiceManagerDialog): self.repaint_service_list(self.drop_position, -1) # if rebuilding list make sure live is fixed. if rebuild: - self.live_controller.replaceServiceManagerItem(item) + self.live_controller.replace_service_manager_item(item) self.drop_position = 0 self.set_modified() @@ -1334,7 +1323,7 @@ class ServiceManager(QtGui.QWidget, ServiceManagerDialog): self.application.set_busy_cursor() item, child = self.find_service_item() if self.service_items[item][u'service_item'].is_valid: - self.preview_controller.addServiceManagerItem(self.service_items[item][u'service_item'], child) + self.preview_controller.add_service_manager_item(self.service_items[item][u'service_item'], child) else: critical_error_message_box(translate('OpenLP.ServiceManager', 'Missing Display Handler'), translate('OpenLP.ServiceManager', @@ -1372,15 +1361,15 @@ class ServiceManager(QtGui.QWidget, ServiceManagerDialog): child = row self.application.set_busy_cursor() if self.service_items[item][u'service_item'].is_valid: - self.live_controller.addServiceManagerItem(self.service_items[item][u'service_item'], child) + self.live_controller.add_service_manager_item(self.service_items[item][u'service_item'], child) if Settings().value(self.main_window.general_settings_section + u'/auto preview'): item += 1 if self.service_items and item < len(self.service_items) and \ self.service_items[item][u'service_item'].is_capable(ItemCapabilities.CanPreview): - self.preview_controller.addServiceManagerItem(self.service_items[item][u'service_item'], 0) + self.preview_controller.add_service_manager_item(self.service_items[item][u'service_item'], 0) next_item = self.service_manager_list.topLevelItem(item) self.service_manager_list.setCurrentItem(next_item) - self.live_controller.preview_list_widget.setFocus() + self.live_controller.preview_widget.setFocus() else: critical_error_message_box(translate('OpenLP.ServiceManager', 'Missing Display Handler'), translate('OpenLP.ServiceManager', diff --git a/openlp/core/ui/slidecontroller.py b/openlp/core/ui/slidecontroller.py index 86b114e1e..427bb5cf1 100644 --- a/openlp/core/ui/slidecontroller.py +++ b/openlp/core/ui/slidecontroller.py @@ -29,6 +29,7 @@ """ The :mod:`slidecontroller` module contains the most important part of OpenLP - the slide controller """ +from __future__ import division import os import logging import copy @@ -41,6 +42,7 @@ from openlp.core.lib import OpenLPToolbar, ItemCapabilities, ServiceItem, ImageS from openlp.core.ui import HideMode, MainDisplay, Display, DisplayControllerType from openlp.core.lib.ui import create_action from openlp.core.utils.actions import ActionList, CategoryOrder +from openlp.core.ui.listpreviewwidget import ListPreviewWidget log = logging.getLogger(__name__) @@ -89,10 +91,10 @@ class SlideController(DisplayController): Set up the Slide Controller. """ DisplayController.__init__(self, parent, is_live) - Registry().register_function(u'bootstrap_post_set_up', self.screenSizeChanged) + Registry().register_function(u'bootstrap_post_set_up', self.screen_size_changed) self.screens = ScreenList() try: - self.ratio = float(self.screens.current[u'size'].width()) / float(self.screens.current[u'size'].height()) + self.ratio = self.screens.current[u'size'].width() / self.screens.current[u'size'].height() except ZeroDivisionError: self.ratio = 1 self.loop_list = [ @@ -121,6 +123,8 @@ class SlideController(DisplayController): self.update_slide_limits() self.panel = QtGui.QWidget(parent.controlSplitter) self.slideList = {} + self.slide_count = 0 + self.slide_image = None # Layout for holding panel self.panel_layout = QtGui.QVBoxLayout(self.panel) self.panel_layout.setSpacing(0) @@ -157,18 +161,8 @@ class SlideController(DisplayController): self.controller_layout.setSpacing(0) self.controller_layout.setMargin(0) # Controller list view - self.preview_list_widget = QtGui.QTableWidget(self.controller) - self.preview_list_widget.setColumnCount(1) - self.preview_list_widget.horizontalHeader().setVisible(False) - self.preview_list_widget.setColumnWidth(0, self.controller.width()) - self.preview_list_widget.is_live = self.is_live - self.preview_list_widget.setObjectName(u'preview_list_widget') - self.preview_list_widget.setSelectionBehavior(QtGui.QAbstractItemView.SelectRows) - self.preview_list_widget.setSelectionMode(QtGui.QAbstractItemView.SingleSelection) - self.preview_list_widget.setEditTriggers(QtGui.QAbstractItemView.NoEditTriggers) - self.preview_list_widget.setHorizontalScrollBarPolicy(QtCore.Qt.ScrollBarAlwaysOff) - self.preview_list_widget.setAlternatingRowColors(True) - self.controller_layout.addWidget(self.preview_list_widget) + self.preview_widget = ListPreviewWidget(self, self.ratio) + self.controller_layout.addWidget(self.preview_widget) # Build the full toolbar self.toolbar = OpenLPToolbar(self) size_toolbar_policy = QtGui.QSizePolicy(QtGui.QSizePolicy.Fixed, QtGui.QSizePolicy.Fixed) @@ -201,15 +195,15 @@ class SlideController(DisplayController): self.toolbar.add_toolbar_widget(self.hide_menu) self.blank_screen = create_action(self, u'blankScreen', text=translate('OpenLP.SlideController', 'Blank Screen'), icon=u':/slides/slide_blank.png', - checked=False, can_shortcuts=True, category=self.category, triggers=self.onBlankDisplay) + checked=False, can_shortcuts=True, category=self.category, triggers=self.on_blank_display) self.theme_screen = create_action(self, u'themeScreen', text=translate('OpenLP.SlideController', 'Blank to Theme'), icon=u':/slides/slide_theme.png', checked=False, can_shortcuts=True, category=self.category, - triggers=self.onThemeDisplay) + triggers=self.on_theme_display) self.desktop_screen = create_action(self, u'desktopScreen', text=translate('OpenLP.SlideController', 'Show Desktop'), icon=u':/slides/slide_desktop.png', checked=False, can_shortcuts=True, category=self.category, - triggers=self.onHideDisplay) + triggers=self.on_hide_display) self.hide_menu.setDefaultAction(self.blank_screen) self.hide_menu.menu().addAction(self.blank_screen) self.hide_menu.menu().addAction(self.theme_screen) @@ -237,10 +231,10 @@ class SlideController(DisplayController): self.toolbar.add_toolbar_widget(self.play_slides_menu) self.play_slides_loop = create_action(self, u'playSlidesLoop', text=UiStrings().PlaySlidesInLoop, icon=u':/media/media_time.png', checked=False, can_shortcuts=True, - category=self.category, triggers=self.onPlaySlidesLoop) + category=self.category, triggers=self.on_play_slides_loop) self.play_slides_once = create_action(self, u'playSlidesOnce', text=UiStrings().PlaySlidesToEnd, icon=u':/media/media_time.png', checked=False, can_shortcuts=True, - category=self.category, triggers=self.onPlaySlidesOnce) + category=self.category, triggers=self.on_play_slides_once) if Settings().value(self.main_window.advanced_settings_section + u'/slide limits') == SlideLimits.Wrap: self.play_slides_menu.setDefaultAction(self.play_slides_loop) else: @@ -256,12 +250,12 @@ class SlideController(DisplayController): self.toolbar.add_toolbar_widget(self.delay_spin_box) else: self.toolbar.add_toolbar_action(u'goLive', icon=u':/general/general_live.png', - tooltip=translate('OpenLP.SlideController', 'Move to live.'), triggers=self.onGoLive) + tooltip=translate('OpenLP.SlideController', 'Move to live.'), triggers=self.on_go_live) self.toolbar.add_toolbar_action(u'addToService', icon=u':/general/general_add.png', - tooltip=translate('OpenLP.SlideController', 'Add to Service.'), triggers=self.onPreviewAddToService) + tooltip=translate('OpenLP.SlideController', 'Add to Service.'), triggers=self.on_preview_add_to_service) self.toolbar.addSeparator() self.toolbar.add_toolbar_action(u'editSong', icon=u':/general/general_edit.png', - tooltip=translate('OpenLP.SlideController', 'Edit and reload song preview.'), triggers=self.onEditSong) + tooltip=translate('OpenLP.SlideController', 'Edit and reload song preview.'), triggers=self.on_edit_song) self.controller_layout.addWidget(self.toolbar) # Build the Media Toolbar self.media_controller.register_controller(self) @@ -279,7 +273,7 @@ class SlideController(DisplayController): icon=u':/slides/media_playback_pause.png', text=translate('OpenLP.SlideController', 'Pause Audio'), tooltip=translate('OpenLP.SlideController', 'Pause audio.'), checked=False, visible=False, category=self.category, context=QtCore.Qt.WindowShortcut, - can_shortcuts=True, triggers=self.onAudioPauseClicked) + can_shortcuts=True, triggers=self.set_audio_pause_clicked) self.audio_menu = QtGui.QMenu(translate('OpenLP.SlideController', 'Background Audio'), self.toolbar) self.audio_pause_item.setMenu(self.audio_menu) self.audio_pause_item.setParent(self.toolbar) @@ -288,7 +282,7 @@ class SlideController(DisplayController): self.nextTrackItem = create_action(self, u'nextTrackItem', text=UiStrings().NextTrack, icon=u':/slides/media_playback_next.png', tooltip=translate('OpenLP.SlideController', 'Go to next audio track.'), - category=self.category, can_shortcuts=True, triggers=self.onNextTrackClicked) + category=self.category, can_shortcuts=True, triggers=self.on_next_track_clicked) self.audio_menu.addAction(self.nextTrackItem) self.trackMenu = self.audio_menu.addMenu(translate('OpenLP.SlideController', 'Tracks')) self.audio_time_label = QtGui.QLabel(u' 00:00 ', self.toolbar) @@ -321,18 +315,18 @@ class SlideController(DisplayController): self.slide_layout.insertWidget(0, self.preview_display) self.preview_display.hide() # Actual preview screen - self.slidePreview = QtGui.QLabel(self) - sizePolicy = QtGui.QSizePolicy(QtGui.QSizePolicy.Fixed, QtGui.QSizePolicy.Fixed) - sizePolicy.setHorizontalStretch(0) - sizePolicy.setVerticalStretch(0) - sizePolicy.setHeightForWidth(self.slidePreview.sizePolicy().hasHeightForWidth()) - self.slidePreview.setSizePolicy(sizePolicy) - self.slidePreview.setFrameShape(QtGui.QFrame.Box) - self.slidePreview.setFrameShadow(QtGui.QFrame.Plain) - self.slidePreview.setLineWidth(1) - self.slidePreview.setScaledContents(True) - self.slidePreview.setObjectName(u'slidePreview') - self.slide_layout.insertWidget(0, self.slidePreview) + self.slide_preview = QtGui.QLabel(self) + size_policy = QtGui.QSizePolicy(QtGui.QSizePolicy.Fixed, QtGui.QSizePolicy.Fixed) + size_policy.setHorizontalStretch(0) + size_policy.setVerticalStretch(0) + size_policy.setHeightForWidth(self.slide_preview.sizePolicy().hasHeightForWidth()) + self.slide_preview.setSizePolicy(size_policy) + self.slide_preview.setFrameShape(QtGui.QFrame.Box) + self.slide_preview.setFrameShadow(QtGui.QFrame.Plain) + self.slide_preview.setLineWidth(1) + self.slide_preview.setScaledContents(True) + self.slide_preview.setObjectName(u'slide_preview') + self.slide_layout.insertWidget(0, self.slide_preview) self.grid.addLayout(self.slide_layout, 0, 0, 1, 1) if self.is_live: self.current_shortcut = u'' @@ -350,15 +344,15 @@ class SlideController(DisplayController): {u'key': u'O', u'configurable': True, u'text': translate('OpenLP.SlideController', 'Go to "Other"')} ] shortcuts.extend([{u'key': unicode(number)} for number in range(10)]) - self.preview_list_widget.addActions([create_action(self, + self.controller.addActions([create_action(self, u'shortcutAction_%s' % s[u'key'], text=s.get(u'text'), can_shortcuts=True, context=QtCore.Qt.WidgetWithChildrenShortcut, category=self.category if s.get(u'configurable') else None, - triggers=self._slideShortcutActivated) for s in shortcuts]) - self.shortcutTimer.timeout.connect(self._slideShortcutActivated) + triggers=self._slide_shortcut_activated) for s in shortcuts]) + self.shortcutTimer.timeout.connect(self._slide_shortcut_activated) # Signals - self.preview_list_widget.clicked.connect(self.onSlideSelected) + self.preview_widget.clicked.connect(self.on_slide_selected) if self.is_live: # Need to use event as called across threads and UI is updated QtCore.QObject.connect(self, QtCore.SIGNAL(u'slidecontroller_toggle_display'), self.toggle_display) @@ -366,13 +360,13 @@ class SlideController(DisplayController): self.toolbar.set_widget_visible(self.loop_list, False) self.toolbar.set_widget_visible(self.wide_menu, False) else: - self.preview_list_widget.doubleClicked.connect(self.onGoLiveClick) + self.preview_widget.doubleClicked.connect(self.on_preview_add_to_service) self.toolbar.set_widget_visible([u'editSong'], False) if self.is_live: - self.setLiveHotkeys(self) - self.__addActionsToWidget(self.preview_list_widget) + self.set_live_hotkeys(self) + self.__add_actions_to_widget(self.controller) else: - self.preview_list_widget.addActions([self.nextItem, self.previous_item]) + self.controller.addActions([self.nextItem, self.previous_item]) Registry().register_function(u'slidecontroller_%s_stop_loop' % self.type_prefix, self.on_stop_loop) Registry().register_function(u'slidecontroller_%s_change' % self.type_prefix, self.on_slide_change) Registry().register_function(u'slidecontroller_%s_blank' % self.type_prefix, self.on_slide_blank) @@ -385,7 +379,7 @@ class SlideController(DisplayController): QtCore.QObject.connect(self, QtCore.SIGNAL(u'slidecontroller_%s_previous' % self.type_prefix), self.on_slide_selected_previous) - def _slideShortcutActivated(self): + def _slide_shortcut_activated(self): """ Called, when a shortcut has been activated to jump to a chorus, verse, etc. @@ -431,8 +425,8 @@ class SlideController(DisplayController): if len(matches) == 1: self.shortcutTimer.stop() self.current_shortcut = u'' - self.__checkUpdateSelectedSlide(self.slideList[matches[0]]) - self.slideSelected() + self.preview_widget.change_slide(self.slideList[matches[0]]) + self.slide_selected() elif sender_name != u'shortcutTimer': # Start the time as we did not have any match. self.shortcutTimer.start(350) @@ -441,29 +435,29 @@ class SlideController(DisplayController): if self.current_shortcut in keys: # We had more than one match for example "V1" and "V10", but # "V1" was the slide we wanted to go. - self.__checkUpdateSelectedSlide(self.slideList[self.current_shortcut]) - self.slideSelected() + self.preview_widget.change_slide(self.slideList[self.current_shortcut]) + self.slide_selected() # Reset the shortcut. self.current_shortcut = u'' - def setLiveHotkeys(self, parent=None): + def set_live_hotkeys(self, parent=None): """ Set the live hotkeys """ self.previousService = create_action(parent, u'previousService', text=translate('OpenLP.SlideController', 'Previous Service'), can_shortcuts=True, context=QtCore.Qt.WidgetWithChildrenShortcut, category=self.category, - triggers=self.servicePrevious) + triggers=self.service_previous) self.nextService = create_action(parent, 'nextService', text=translate('OpenLP.SlideController', 'Next Service'), can_shortcuts=True, context=QtCore.Qt.WidgetWithChildrenShortcut, category=self.category, - triggers=self.serviceNext) + triggers=self.service_next) self.escapeItem = create_action(parent, 'escapeItem', text=translate('OpenLP.SlideController', 'Escape Item'), can_shortcuts=True, context=QtCore.Qt.WidgetWithChildrenShortcut, category=self.category, - triggers=self.liveEscape) + triggers=self.live_escape) - def liveEscape(self): + def live_escape(self): """ If you press ESC on the live screen it should close the display temporarily. """ @@ -475,24 +469,24 @@ class SlideController(DisplayController): Toggle the display settings triggered from remote messages. """ if action == u'blank' or action == u'hide': - self.onBlankDisplay(True) + self.on_blank_display(True) elif action == u'theme': - self.onThemeDisplay(True) + self.on_theme_display(True) elif action == u'desktop': - self.onHideDisplay(True) + self.on_hide_display(True) elif action == u'show': - self.onBlankDisplay(False) - self.onThemeDisplay(False) - self.onHideDisplay(False) + self.on_blank_display(False) + self.on_theme_display(False) + self.on_hide_display(False) - def servicePrevious(self): + def service_previous(self): """ Live event to select the previous service item from the service manager. """ self.keypress_queue.append(ServiceItemAction.Previous) self._process_queue() - def serviceNext(self): + def service_next(self): """ Live event to select the next service item from the service manager. """ @@ -517,10 +511,9 @@ class SlideController(DisplayController): self.service_manager.next_item() self.keypress_loop = False - def screenSizeChanged(self): + def screen_size_changed(self): """ - Settings dialog has changed the screen size of adjust output and - screen previews. + Settings dialog has changed the screen size of adjust output and screen previews. """ # rebuild display as screen size changed if self.display: @@ -528,24 +521,25 @@ class SlideController(DisplayController): self.display = MainDisplay(self, self.is_live, self) self.display.setup() if self.is_live: - self.__addActionsToWidget(self.display) + self.__add_actions_to_widget(self.display) self.display.audio_player.connectSlot(QtCore.SIGNAL(u'tick(qint64)'), self.on_audio_time_remaining) # The SlidePreview's ratio. try: - self.ratio = float(self.screens.current[u'size'].width()) / float(self.screens.current[u'size'].height()) + self.ratio = self.screens.current[u'size'].width() / self.screens.current[u'size'].height() except ZeroDivisionError: self.ratio = 1 self.media_controller.setup_display(self.display, False) - self.previewSizeChanged() + self.preview_size_changed() + self.preview_widget.screen_size_changed(self.ratio) self.preview_display.setup() service_item = ServiceItem() self.preview_display.web_view.setHtml(build_html(service_item, self.preview_display.screen, None, self.is_live, plugins=self.plugin_manager.plugins)) self.media_controller.setup_display(self.preview_display, True) if self.service_item: - self.refreshServiceItem() + self.refresh_service_item() - def __addActionsToWidget(self, widget): + def __add_actions_to_widget(self, widget): """ Add actions to the widget specified by `widget` """ @@ -554,40 +548,29 @@ class SlideController(DisplayController): self.previousService, self.nextService, self.escapeItem]) - def previewSizeChanged(self): + def preview_size_changed(self): """ Takes care of the SlidePreview's size. Is called when one of the the splitters is moved or when the screen size is changed. Note, that this method is (also) called frequently from the mainwindow *paintEvent*. """ - if self.ratio < float(self.preview_frame.width()) / float(self.preview_frame.height()): + if self.ratio < self.preview_frame.width() / self.preview_frame.height(): # We have to take the height as limit. max_height = self.preview_frame.height() - self.grid.margin() * 2 - self.slidePreview.setFixedSize(QtCore.QSize(max_height * self.ratio, max_height)) + self.slide_preview.setFixedSize(QtCore.QSize(max_height * self.ratio, max_height)) self.preview_display.setFixedSize(QtCore.QSize(max_height * self.ratio, max_height)) self.preview_display.screen = { u'size': self.preview_display.geometry()} else: # We have to take the width as limit. max_width = self.preview_frame.width() - self.grid.margin() * 2 - self.slidePreview.setFixedSize(QtCore.QSize(max_width, max_width / self.ratio)) + self.slide_preview.setFixedSize(QtCore.QSize(max_width, max_width / self.ratio)) self.preview_display.setFixedSize(QtCore.QSize(max_width, max_width / self.ratio)) self.preview_display.screen = { u'size': self.preview_display.geometry()} - # Make sure that the frames have the correct size. - self.preview_list_widget.setColumnWidth(0, self.preview_list_widget.viewport().size().width()) - if self.service_item: - # Sort out songs, bibles, etc. - if self.service_item.is_text(): - self.preview_list_widget.resizeRowsToContents() - else: - # Sort out image heights. - width = self.main_window.controlSplitter.sizes()[self.split] - for framenumber in range(len(self.service_item.get_frames())): - self.preview_list_widget.setRowHeight(framenumber, width / self.ratio) - self.onControllerSizeChanged(self.controller.width()) + self.on_controller_size_changed(self.controller.width()) - def onControllerSizeChanged(self, width): + def on_controller_size_changed(self, width): """ Change layout of display control buttons on controller size change """ @@ -603,14 +586,15 @@ class SlideController(DisplayController): self.toolbar.set_widget_visible(self.wide_menu, False) self.toolbar.set_widget_visible(self.narrow_menu) - def onSongBarHandler(self): + def on_song_bar_handler(self): """ Some song handler """ request = self.sender().text() slide_no = self.slideList[request] - self.__updatePreviewSelection(slide_no) - self.slideSelected() + width = self.main_window.controlSplitter.sizes()[self.split] + self.preview_widget.replace_service_item(self.service_item, width, slide_no) + self.slide_selected() def receive_spin_delay(self): """ @@ -624,17 +608,16 @@ class SlideController(DisplayController): """ self.slide_limits = Settings().value(self.main_window.advanced_settings_section + u'/slide limits') - def enableToolBar(self, item): + def enable_tool_bar(self, item): """ - Allows the toolbars to be reconfigured based on Controller Type - and ServiceItem Type + Allows the toolbars to be reconfigured based on Controller Type and ServiceItem Type """ if self.is_live: - self.enableLiveToolBar(item) + self.enable_live_tool_bar(item) else: - self.enablePreviewToolBar(item) + self.enable_preview_tool_bar(item) - def enableLiveToolBar(self, item): + def enable_live_tool_bar(self, item): """ Allows the live toolbar to be customised """ @@ -663,7 +646,7 @@ class SlideController(DisplayController): # See bug #791050 self.toolbar.show() - def enablePreviewToolBar(self, item): + def enable_preview_tool_bar(self, item): """ Allows the Preview toolbar to be customised """ @@ -682,15 +665,15 @@ class SlideController(DisplayController): # See bug #791050 self.toolbar.show() - def refreshServiceItem(self): + def refresh_service_item(self): """ Method to update the service item if the screen has changed """ - log.debug(u'refreshServiceItem live = %s' % self.is_live) + log.debug(u'refresh_service_item live = %s' % self.is_live) if self.service_item.is_text() or self.service_item.is_image(): item = self.service_item item.render() - self._processItem(item, self.selected_row) + self._process_item(item, self.selected_row) def add_service_item(self, item): """ @@ -699,47 +682,47 @@ class SlideController(DisplayController): """ log.debug(u'add_service_item live = %s' % self.is_live) item.render() - slideno = 0 + slide_no = 0 if self.song_edit: - slideno = self.selected_row + slide_no = self.selected_row self.song_edit = False - self._processItem(item, slideno) + self._process_item(item, slide_no) - def replaceServiceManagerItem(self, item): + def replace_service_manager_item(self, item): """ Replacement item following a remote edit """ if item == self.service_item: - self._processItem(item, self.preview_list_widget.currentRow()) + self._process_item(item, self.preview_widget.current_slide_number()) - def addServiceManagerItem(self, item, slideno): + def add_service_manager_item(self, item, slide_no): """ Method to install the service item into the controller and request the correct toolbar for the plugin. Called by ServiceManager """ - log.debug(u'addServiceManagerItem live = %s' % self.is_live) - # If no valid slide number is specified we take the first one, but we - # remember the initial value to see if we should reload the song or not - slidenum = slideno - if slideno == -1: + log.debug(u'add_service_manager_item live = %s' % self.is_live) + # If no valid slide number is specified we take the first one, but we remember the initial value to see if we + # should reload the song or not + slidenum = slide_no + if slide_no == -1: slidenum = 0 # If service item is the same as the current one, only change slide - if slideno >= 0 and item == self.service_item: - self.__checkUpdateSelectedSlide(slidenum) - self.slideSelected() + if slide_no >= 0 and item == self.service_item: + self.preview_widget.change_slide(slidenum) + self.slide_selected() else: - self._processItem(item, slidenum) + self._process_item(item, slidenum) if self.is_live and item.auto_play_slides_loop and item.timed_slide_interval > 0: self.play_slides_loop.setChecked(item.auto_play_slides_loop) self.delay_spin_box.setValue(int(item.timed_slide_interval)) - self.onPlaySlidesLoop() + self.on_play_slides_loop() elif self.is_live and item.auto_play_slides_once and item.timed_slide_interval > 0: self.play_slides_once.setChecked(item.auto_play_slides_once) self.delay_spin_box.setValue(int(item.timed_slide_interval)) - self.onPlaySlidesOnce() + self.on_play_slides_once() - def _processItem(self, service_item, slideno): + def _process_item(self, service_item, slideno): """ Loads a ServiceItem into the system from ServiceManager Display the slide number passed @@ -750,17 +733,13 @@ class SlideController(DisplayController): # take a copy not a link to the servicemanager copy. self.service_item = copy.copy(service_item) if old_item and self.is_live and old_item.is_capable(ItemCapabilities.ProvidesOwnDisplay): - self._resetBlank() + self._reset_blank() Registry().execute(u'%s_start' % service_item.name.lower(), [service_item, self.is_live, self.hide_mode(), slideno]) self.slideList = {} - width = self.main_window.controlSplitter.sizes()[self.split] - self.preview_list_widget.clear() - self.preview_list_widget.setRowCount(0) - self.preview_list_widget.setColumnWidth(0, width) if self.is_live: self.song_menu.menu().clear() self.display.audio_player.reset() - self.setAudioItemsVisibility(False) + self.set_audio_items_visibility(False) self.audio_pause_item.setChecked(False) # If the current item has background audio if self.service_item.is_capable(ItemCapabilities.HasBackgroundAudio): @@ -770,7 +749,7 @@ class SlideController(DisplayController): for counter in range(len(self.service_item.background_audio)): action = self.trackMenu.addAction(os.path.basename(self.service_item.background_audio[counter])) action.setData(counter) - action.triggered.connect(self.onTrackTriggered) + action.triggered.connect(self.on_track_triggered) self.display.audio_player.repeat = Settings().value( self.main_window.general_settings_section + u'/audio repeat list') if Settings().value(self.main_window.general_settings_section + u'/audio start paused'): @@ -778,13 +757,10 @@ class SlideController(DisplayController): self.display.audio_player.pause() else: self.display.audio_player.play() - self.setAudioItemsVisibility(True) + self.set_audio_items_visibility(True) row = 0 - text = [] + width = self.main_window.controlSplitter.sizes()[self.split] for framenumber, frame in enumerate(self.service_item.get_frames()): - self.preview_list_widget.setRowCount(self.preview_list_widget.rowCount() + 1) - item = QtGui.QTableWidgetItem() - slideHeight = 0 if self.service_item.is_text(): if frame[u'verseTag']: # These tags are already translated. @@ -795,51 +771,27 @@ class SlideController(DisplayController): if verse_def not in self.slideList: self.slideList[verse_def] = framenumber if self.is_live: - self.song_menu.menu().addAction(verse_def, self.onSongBarHandler) + self.song_menu.menu().addAction(verse_def, self.on_song_bar_handler) else: row += 1 self.slideList[unicode(row)] = row - 1 - item.setText(frame[u'text']) else: - label = QtGui.QLabel() - label.setMargin(4) - if service_item.is_media(): - label.setAlignment(QtCore.Qt.AlignHCenter | QtCore.Qt.AlignVCenter) - else: - label.setScaledContents(True) - if self.service_item.is_command(): - label.setPixmap(QtGui.QPixmap(frame[u'image'])) - else: - # If current slide set background to image - if framenumber == slideno: - self.service_item.bg_image_bytes = self.image_manager.get_image_bytes(frame[u'path'], - ImageSource.ImagePlugin) - image = self.image_manager.get_image(frame[u'path'], ImageSource.ImagePlugin) - label.setPixmap(QtGui.QPixmap.fromImage(image)) - self.preview_list_widget.setCellWidget(framenumber, 0, label) - slideHeight = width * (1 / self.ratio) row += 1 self.slideList[unicode(row)] = row - 1 - text.append(unicode(row)) - self.preview_list_widget.setItem(framenumber, 0, item) - if slideHeight: - self.preview_list_widget.setRowHeight(framenumber, slideHeight) - self.preview_list_widget.setVerticalHeaderLabels(text) - if self.service_item.is_text(): - self.preview_list_widget.resizeRowsToContents() - self.preview_list_widget.setColumnWidth(0, - self.preview_list_widget.viewport().size().width()) - self.__updatePreviewSelection(slideno) - self.enableToolBar(service_item) + # If current slide set background to image + if not self.service_item.is_command() and framenumber == slideno: + self.service_item.bg_image_bytes = self.image_manager.get_image_bytes(frame[u'path'], + ImageSource.ImagePlugin) + self.preview_widget.replace_service_item(self.service_item, width, slideno) + self.enable_tool_bar(service_item) # Pass to display for viewing. # Postpone image build, we need to do this later to avoid the theme # flashing on the screen if not self.service_item.is_image(): self.display.build_html(self.service_item) if service_item.is_media(): - self.onMediaStart(service_item) - self.slideSelected(True) - self.preview_list_widget.setFocus() + self.on_media_start(service_item) + self.slide_selected(True) if old_item: # Close the old item after the new one is opened # This avoids the service theme/desktop flashing on screen @@ -848,19 +800,9 @@ class SlideController(DisplayController): if old_item.is_command() and not service_item.is_command(): Registry().execute(u'%s_stop' % old_item.name.lower(), [old_item, self.is_live]) if old_item.is_media() and not service_item.is_media(): - self.onMediaClose() + self.on_media_close() Registry().execute(u'slidecontroller_%s_started' % self.type_prefix, [service_item]) - def __updatePreviewSelection(self, slideno): - """ - Utility method to update the selected slide in the list. - """ - if slideno > self.preview_list_widget.rowCount(): - self.preview_list_widget.selectRow( - self.preview_list_widget.rowCount() - 1) - else: - self.__checkUpdateSelectedSlide(slideno) - # Screen event methods def on_slide_selected_index(self, message): """ @@ -871,49 +813,49 @@ class SlideController(DisplayController): return if self.service_item.is_command(): Registry().execute(u'%s_slide' % self.service_item.name.lower(), [self.service_item, self.is_live, index]) - self.updatePreview() + self.update_preview() else: - self.__checkUpdateSelectedSlide(index) - self.slideSelected() + self.preview_widget.change_slide(index) + self.slide_selected() - def mainDisplaySetBackground(self): + def main_display_set_background(self): """ Allow the main display to blank the main display at startup time """ - log.debug(u'mainDisplaySetBackground live = %s' % self.is_live) + log.debug(u'main_display_set_background live = %s' % self.is_live) display_type = Settings().value(self.main_window.general_settings_section + u'/screen blank') if self.screens.which_screen(self.window()) != self.screens.which_screen(self.display): # Order done to handle initial conversion if display_type == u'themed': - self.onThemeDisplay(True) + self.on_theme_display(True) elif display_type == u'hidden': - self.onHideDisplay(True) + self.on_hide_display(True) elif display_type == u'blanked': - self.onBlankDisplay(True) + self.on_blank_display(True) else: Registry().execute(u'live_display_show') else: - self.liveEscape() + self.live_escape() def on_slide_blank(self): """ Handle the slidecontroller blank event """ - self.onBlankDisplay(True) + self.on_blank_display(True) def on_slide_unblank(self): """ Handle the slidecontroller unblank event """ - self.onBlankDisplay(False) + self.on_blank_display(False) - def onBlankDisplay(self, checked=None): + def on_blank_display(self, checked=None): """ Handle the blank screen button actions """ if checked is None: checked = self.blank_screen.isChecked() - log.debug(u'onBlankDisplay %s' % checked) + log.debug(u'on_blank_display %s' % checked) self.hide_menu.setDefaultAction(self.blank_screen) self.blank_screen.setChecked(checked) self.theme_screen.setChecked(False) @@ -922,17 +864,17 @@ class SlideController(DisplayController): Settings().setValue(self.main_window.general_settings_section + u'/screen blank', u'blanked') else: Settings().remove(self.main_window.general_settings_section + u'/screen blank') - self.blankPlugin() - self.updatePreview() - self.onToggleLoop() + self.blank_plugin() + self.update_preview() + self.on_toggle_loop() - def onThemeDisplay(self, checked=None): + def on_theme_display(self, checked=None): """ Handle the Theme screen button """ if checked is None: checked = self.theme_screen.isChecked() - log.debug(u'onThemeDisplay %s' % checked) + log.debug(u'on_theme_display %s' % checked) self.hide_menu.setDefaultAction(self.theme_screen) self.blank_screen.setChecked(False) self.theme_screen.setChecked(checked) @@ -941,17 +883,17 @@ class SlideController(DisplayController): Settings().setValue(self.main_window.general_settings_section + u'/screen blank', u'themed') else: Settings().remove(self.main_window.general_settings_section + u'/screen blank') - self.blankPlugin() - self.updatePreview() - self.onToggleLoop() + self.blank_plugin() + self.update_preview() + self.on_toggle_loop() - def onHideDisplay(self, checked=None): + def on_hide_display(self, checked=None): """ Handle the Hide screen button """ if checked is None: checked = self.desktop_screen.isChecked() - log.debug(u'onHideDisplay %s' % checked) + log.debug(u'on_hide_display %s' % checked) self.hide_menu.setDefaultAction(self.desktop_screen) self.blank_screen.setChecked(False) self.theme_screen.setChecked(False) @@ -960,16 +902,16 @@ class SlideController(DisplayController): Settings().setValue(self.main_window.general_settings_section + u'/screen blank', u'hidden') else: Settings().remove(self.main_window.general_settings_section + u'/screen blank') - self.hidePlugin(checked) - self.updatePreview() - self.onToggleLoop() + self.hide_plugin(checked) + self.update_preview() + self.on_toggle_loop() - def blankPlugin(self): + def blank_plugin(self): """ Blank/Hide the display screen within a plugin if required. """ hide_mode = self.hide_mode() - log.debug(u'blankPlugin %s ', hide_mode) + log.debug(u'blank_plugin %s ', hide_mode) if self.service_item is not None: if hide_mode: if not self.service_item.is_command(): @@ -986,11 +928,11 @@ class SlideController(DisplayController): else: Registry().execute(u'live_display_show') - def hidePlugin(self, hide): + def hide_plugin(self, hide): """ Tell the plugin to hide the display screen. """ - log.debug(u'hidePlugin %s ', hide) + log.debug(u'hide_plugin %s ', hide) if self.service_item is not None: if hide: Registry().execute(u'live_display_hide', HideMode.Screen) @@ -1005,20 +947,20 @@ class SlideController(DisplayController): else: Registry().execute(u'live_display_show') - def onSlideSelected(self): + def on_slide_selected(self): """ Slide selected in controller """ - self.slideSelected() + self.slide_selected() - def slideSelected(self, start=False): + def slide_selected(self, start=False): """ Generate the preview when you click on a slide. if this is the Live Controller also display on the screen """ - row = self.preview_list_widget.currentRow() + row = self.preview_widget.current_slide_number() self.selected_row = 0 - if -1 < row < self.preview_list_widget.rowCount(): + if -1 < row < self.preview_widget.slide_count(): if self.service_item.is_command(): if self.is_live and not start: Registry().execute(u'%s_slide' % self.service_item.name.lower(), @@ -1034,9 +976,9 @@ class SlideController(DisplayController): self.display.image(to_display) # reset the store used to display first image self.service_item.bg_image_bytes = None - self.updatePreview() + self.update_preview() self.selected_row = row - self.__checkUpdateSelectedSlide(row) + self.preview_widget.change_slide(row) Registry().execute(u'slidecontroller_%s_changed' % self.type_prefix, row) self.display.setFocus() @@ -1044,33 +986,34 @@ class SlideController(DisplayController): """ The slide has been changed. Update the slidecontroller accordingly """ - self.__checkUpdateSelectedSlide(row) - self.updatePreview() + self.preview_widget.change_slide(row) + self.update_preview() Registry().execute(u'slidecontroller_%s_changed' % self.type_prefix, row) - def updatePreview(self): + def update_preview(self): """ - This updates the preview frame, for example after changing a slide or - using *Blank to Theme*. + This updates the preview frame, for example after changing a slide or using *Blank to Theme*. """ - log.debug(u'updatePreview %s ' % self.screens.current[u'primary']) + log.debug(u'update_preview %s ' % self.screens.current[u'primary']) if not self.screens.current[u'primary'] and self.service_item and \ self.service_item.is_capable(ItemCapabilities.ProvidesOwnDisplay): - # Grab now, but try again in a couple of seconds if slide change - # is slow - QtCore.QTimer.singleShot(0.5, self.grabMainDisplay) - QtCore.QTimer.singleShot(2.5, self.grabMainDisplay) + # Grab now, but try again in a couple of seconds if slide change is slow + QtCore.QTimer.singleShot(0.5, self.grab_maindisplay) + QtCore.QTimer.singleShot(2.5, self.grab_maindisplay) else: - self.slidePreview.setPixmap(self.display.preview()) + self.slide_image = self.display.preview() + self.slide_preview.setPixmap(self.slide_image) + self.slide_count += 1 - def grabMainDisplay(self): + def grab_maindisplay(self): """ Creates an image of the current screen and updates the preview frame. """ - winid = QtGui.QApplication.desktop().winId() + win_id = QtGui.QApplication.desktop().winId() rect = self.screens.current[u'size'] - winimg = QtGui.QPixmap.grabWindow(winid, rect.x(), rect.y(), rect.width(), rect.height()) - self.slidePreview.setPixmap(winimg) + win_image = QtGui.QPixmap.grabWindow(win_id, rect.x(), rect.y(), rect.width(), rect.height()) + self.slide_preview.setPixmap(win_image) + self.slide_image = win_image def on_slide_selected_next_action(self, checked): """ @@ -1087,24 +1030,24 @@ class SlideController(DisplayController): return Registry().execute(u'%s_next' % self.service_item.name.lower(), [self.service_item, self.is_live]) if self.service_item.is_command() and self.is_live: - self.updatePreview() + self.update_preview() else: - row = self.preview_list_widget.currentRow() + 1 - if row == self.preview_list_widget.rowCount(): + row = self.preview_widget.current_slide_number() + 1 + if row == self.preview_widget.slide_count(): if wrap is None: if self.slide_limits == SlideLimits.Wrap: row = 0 elif self.is_live and self.slide_limits == SlideLimits.Next: - self.serviceNext() + self.service_next() return else: - row = self.preview_list_widget.rowCount() - 1 + row = self.preview_widget.slide_count() - 1 elif wrap: row = 0 else: - row = self.preview_list_widget.rowCount() - 1 - self.__checkUpdateSelectedSlide(row) - self.slideSelected() + row = self.preview_widget.slide_count() - 1 + self.preview_widget.change_slide(row) + self.slide_selected() def on_slide_selected_previous(self): """ @@ -1114,44 +1057,36 @@ class SlideController(DisplayController): return Registry().execute(u'%s_previous' % self.service_item.name.lower(), [self.service_item, self.is_live]) if self.service_item.is_command() and self.is_live: - self.updatePreview() + self.update_preview() else: - row = self.preview_list_widget.currentRow() - 1 + row = self.preview_widget.current_slide_number() - 1 if row == -1: if self.slide_limits == SlideLimits.Wrap: - row = self.preview_list_widget.rowCount() - 1 + row = self.preview_widget.slide_count() - 1 elif self.is_live and self.slide_limits == SlideLimits.Next: self.keypress_queue.append(ServiceItemAction.PreviousLastSlide) self._process_queue() return else: row = 0 - self.__checkUpdateSelectedSlide(row) - self.slideSelected() + self.preview_widget.change_slide(row) + self.slide_selected() - def __checkUpdateSelectedSlide(self, row): - """ - Check if this slide has been updated - """ - if row + 1 < self.preview_list_widget.rowCount(): - self.preview_list_widget.scrollToItem(self.preview_list_widget.item(row + 1, 0)) - self.preview_list_widget.selectRow(row) - - def onToggleLoop(self): + def on_toggle_loop(self): """ Toggles the loop state. """ hide_mode = self.hide_mode() if hide_mode is None and (self.play_slides_loop.isChecked() or self.play_slides_once.isChecked()): - self.onStartLoop() + self.on_start_loop() else: self.on_stop_loop() - def onStartLoop(self): + def on_start_loop(self): """ Start the timer loop running and store the timer id """ - if self.preview_list_widget.rowCount() > 1: + if self.preview_widget.slide_count() > 1: self.timer_id = self.startTimer(int(self.delay_spin_box.value()) * 1000) def on_stop_loop(self): @@ -1162,7 +1097,7 @@ class SlideController(DisplayController): self.killTimer(self.timer_id) self.timer_id = 0 - def onPlaySlidesLoop(self, checked=None): + def on_play_slides_loop(self, checked=None): """ Start or stop 'Play Slides in Loop' """ @@ -1170,7 +1105,7 @@ class SlideController(DisplayController): checked = self.play_slides_loop.isChecked() else: self.play_slides_loop.setChecked(checked) - log.debug(u'onPlaySlidesLoop %s' % checked) + log.debug(u'on_play_slides_loop %s' % checked) if checked: self.play_slides_loop.setIcon(build_icon(u':/media/media_stop.png')) self.play_slides_loop.setText(UiStrings().StopPlaySlidesInLoop) @@ -1181,9 +1116,9 @@ class SlideController(DisplayController): else: self.play_slides_loop.setIcon(build_icon(u':/media/media_time.png')) self.play_slides_loop.setText(UiStrings().PlaySlidesInLoop) - self.onToggleLoop() + self.on_toggle_loop() - def onPlaySlidesOnce(self, checked=None): + def on_play_slides_once(self, checked=None): """ Start or stop 'Play Slides to End' """ @@ -1191,7 +1126,7 @@ class SlideController(DisplayController): checked = self.play_slides_once.isChecked() else: self.play_slides_once.setChecked(checked) - log.debug(u'onPlaySlidesOnce %s' % checked) + log.debug(u'on_play_slides_once %s' % checked) if checked: self.play_slides_once.setIcon(build_icon(u':/media/media_stop.png')) self.play_slides_once.setText(UiStrings().StopPlaySlidesToEnd) @@ -1202,15 +1137,15 @@ class SlideController(DisplayController): else: self.play_slides_once.setIcon(build_icon(u':/media/media_time')) self.play_slides_once.setText(UiStrings().PlaySlidesToEnd) - self.onToggleLoop() + self.on_toggle_loop() - def setAudioItemsVisibility(self, visible): + def set_audio_items_visibility(self, visible): """ Set the visibility of the audio stuff """ self.toolbar.set_widget_visible(self.audio_list, visible) - def onAudioPauseClicked(self, checked): + def set_audio_pause_clicked(self, checked): """ Pause the audio player """ @@ -1228,7 +1163,7 @@ class SlideController(DisplayController): if event.timerId() == self.timer_id: self.on_slide_selected_next(self.play_slides_loop.isChecked()) - def onEditSong(self): + def on_edit_song(self): """ From the preview display requires the service Item to be editied """ @@ -1237,14 +1172,14 @@ class SlideController(DisplayController): if new_item: self.add_service_item(new_item) - def onPreviewAddToService(self): + def on_preview_add_to_service(self): """ From the preview display request the Item to be added to service """ if self.service_item: self.service_manager.add_service_item(self.service_item) - def onGoLiveClick(self): + def on_go_live_click(self): """ triggered by clicking the Preview slide items """ @@ -1254,53 +1189,53 @@ class SlideController(DisplayController): if self.service_item.is_command(): Registry().execute(u'%s_stop' % self.service_item.name.lower(), [self.service_item, self.is_live]) if self.service_item.is_media(): - self.onMediaClose() - self.onGoLive() + self.on_media_close() + self.on_go_live() - def onGoLive(self): + def on_go_live(self): """ If preview copy slide item to live controller from Preview Controller """ - row = self.preview_list_widget.currentRow() - if -1 < row < self.preview_list_widget.rowCount(): + row = self.preview_widget.current_slide_number() + if -1 < row < self.preview_widget.slide_count(): if self.service_item.from_service: self.service_manager.preview_live(self.service_item.unique_identifier, row) else: - self.live_controller.addServiceManagerItem(self.service_item, row) + self.live_controller.add_service_manager_item(self.service_item, row) - def onMediaStart(self, item): + def on_media_start(self, item): """ Respond to the arrival of a media service item """ - log.debug(u'SlideController onMediaStart') + log.debug(u'SlideController on_media_start') self.media_controller.video(self.controller_type, item, self.hide_mode()) if not self.is_live: self.preview_display.show() - self.slidePreview.hide() + self.slide_preview.hide() - def onMediaClose(self): + def on_media_close(self): """ Respond to a request to close the Video """ - log.debug(u'SlideController onMediaClose') + log.debug(u'SlideController on_media_close') self.media_controller.media_reset(self) self.preview_display.hide() - self.slidePreview.show() + self.slide_preview.show() - def _resetBlank(self): + def _reset_blank(self): """ Used by command items which provide their own displays to reset the screen hide attributes """ hide_mode = self.hide_mode() if hide_mode == HideMode.Blank: - self.onBlankDisplay(True) + self.on_blank_display(True) elif hide_mode == HideMode.Theme: - self.onThemeDisplay(True) + self.on_theme_display(True) elif hide_mode == HideMode.Screen: - self.onHideDisplay(True) + self.on_hide_display(True) else: - self.hidePlugin(False) + self.hide_plugin(False) def hide_mode(self): """ @@ -1317,7 +1252,7 @@ class SlideController(DisplayController): else: return None - def onNextTrackClicked(self): + def on_next_track_clicked(self): """ Go to the next track when next is clicked """ @@ -1332,7 +1267,7 @@ class SlideController(DisplayController): seconds %= 60 self.audio_time_label.setText(u' %02d:%02d ' % (minutes, seconds)) - def onTrackTriggered(self): + def on_track_triggered(self): """ Start playing a track """ diff --git a/openlp/core/ui/themestab.py b/openlp/core/ui/themestab.py index f0f821494..d6dba2880 100644 --- a/openlp/core/ui/themestab.py +++ b/openlp/core/ui/themestab.py @@ -29,6 +29,8 @@ """ The Themes configuration tab """ +from __future__ import division + from PyQt4 import QtCore, QtGui from openlp.core.lib import Registry, Settings, SettingsTab, UiStrings, translate @@ -90,7 +92,7 @@ class ThemesTab(SettingsTab): self.global_level_label.setObjectName(u'global_level_label') self.level_layout.addRow(self.global_level_radio_button, self.global_level_label) label_top_margin = (self.song_level_radio_button.sizeHint().height() - - self.song_level_label.sizeHint().height()) / 2 + self.song_level_label.sizeHint().height()) // 2 for label in [self.song_level_label, self.service_level_label, self.global_level_label]: rect = label.rect() rect.setTop(rect.top() + label_top_margin) diff --git a/openlp/core/ui/themewizard.py b/openlp/core/ui/themewizard.py index 7fc78a59e..7c9f7df15 100644 --- a/openlp/core/ui/themewizard.py +++ b/openlp/core/ui/themewizard.py @@ -178,8 +178,8 @@ class Ui_ThemeWizard(object): self.lineSpacingLabel = QtGui.QLabel(self.mainAreaPage) self.lineSpacingLabel.setObjectName(u'LineSpacingLabel') self.lineSpacingSpinBox = QtGui.QSpinBox(self.mainAreaPage) - self.lineSpacingSpinBox.setMinimum(-50) - self.lineSpacingSpinBox.setMaximum(50) + self.lineSpacingSpinBox.setMinimum(-250) + self.lineSpacingSpinBox.setMaximum(250) self.lineSpacingSpinBox.setObjectName(u'LineSpacingSpinBox') self.mainAreaLayout.addRow(self.lineSpacingLabel, self.lineSpacingSpinBox) self.outlineCheckBox = QtGui.QCheckBox(self.mainAreaPage) diff --git a/openlp/core/ui/wizard.py b/openlp/core/ui/wizard.py index 783b310b3..0b142b459 100644 --- a/openlp/core/ui/wizard.py +++ b/openlp/core/ui/wizard.py @@ -75,13 +75,30 @@ class OpenLPWizard(QtGui.QWizard): """ Generic OpenLP wizard to provide generic functionality and a unified look and feel. + + ``parent`` + The QWidget-derived parent of the wizard. + + ``plugin`` + Plugin this wizard is part of. The plugin will be saved in the "plugin" variable. + The plugin will also be used as basis for the file dialog methods this class provides. + + ``name`` + The object name this wizard should have. + + ``image`` + The image to display on the "welcome" page of the wizard. Should be 163x350. + + ``add_progress_page`` + Whether to add a progress page with a progressbar at the end of the wizard. """ - def __init__(self, parent, plugin, name, image): + def __init__(self, parent, plugin, name, image, add_progress_page=True): """ Constructor """ QtGui.QWizard.__init__(self, parent) self.plugin = plugin + self.with_progress_page = add_progress_page self.setObjectName(name) self.open_icon = build_icon(u':/general/general_open.png') self.delete_icon = build_icon(u':/general/general_delete.png') @@ -92,8 +109,9 @@ class OpenLPWizard(QtGui.QWizard): self.custom_init() self.custom_signals() self.currentIdChanged.connect(self.on_current_id_changed) - self.error_copy_to_button.clicked.connect(self.on_error_copy_to_button_clicked) - self.error_save_to_button.clicked.connect(self.on_error_save_to_button_clicked) + if self.with_progress_page: + self.error_copy_to_button.clicked.connect(self.on_error_copy_to_button_clicked) + self.error_save_to_button.clicked.connect(self.on_error_save_to_button_clicked) def setupUi(self, image): """ @@ -105,7 +123,8 @@ class OpenLPWizard(QtGui.QWizard): QtGui.QWizard.NoBackButtonOnStartPage | QtGui.QWizard.NoBackButtonOnLastPage) add_welcome_page(self, image) self.add_custom_pages() - self.add_progress_page() + if self.with_progress_page: + self.add_progress_page() self.retranslateUi() def register_fields(self): @@ -185,7 +204,7 @@ class OpenLPWizard(QtGui.QWizard): Stop the wizard on cancel button, close button or ESC key. """ log.debug(u'Wizard cancelled by user.') - if self.currentPage() == self.progress_page: + if self.with_progress_page and self.currentPage() == self.progress_page: Registry().execute(u'openlp_stop_wizard') self.done(QtGui.QDialog.Rejected) @@ -193,14 +212,14 @@ class OpenLPWizard(QtGui.QWizard): """ Perform necessary functions depending on which wizard page is active. """ - if self.page(pageId) == self.progress_page: + if self.with_progress_page and self.page(pageId) == self.progress_page: self.pre_wizard() self.performWizard() self.post_wizard() else: - self.custom_cage_changed(pageId) + self.custom_page_changed(pageId) - def custom_cage_changed(self, pageId): + def custom_page_changed(self, pageId): """ Called when changing to a page other than the progress page """ diff --git a/openlp/core/utils/__init__.py b/openlp/core/utils/__init__.py index 60393dfbb..0a594b5cf 100644 --- a/openlp/core/utils/__init__.py +++ b/openlp/core/utils/__init__.py @@ -101,46 +101,38 @@ def get_application_version(): if APPLICATION_VERSION: return APPLICATION_VERSION if u'--dev-version' in sys.argv or u'-d' in sys.argv: - # If we're running the dev version, let's use bzr to get the version. - try: - # If bzrlib is available, use it. - from bzrlib.branch import Branch - b = Branch.open_containing('.')[0] - b.lock_read() - try: - # Get the branch's latest revision number. - revno = b.revno() - # Convert said revision number into a bzr revision id. - revision_id = b.dotted_revno_to_revision_id((revno,)) - # Get a dict of tags, with the revision id as the key. - tags = b.tags.get_reverse_tag_dict() - # Check if the latest - if revision_id in tags: - full_version = u'%s' % tags[revision_id][0] - else: - full_version = '%s-bzr%s' % (sorted(b.tags.get_tag_dict().keys())[-1], revno) - finally: - b.unlock() - except: - # Otherwise run the command line bzr client. - bzr = Popen((u'bzr', u'tags', u'--sort', u'time'), stdout=PIPE) - output, error = bzr.communicate() - code = bzr.wait() - if code != 0: - raise Exception(u'Error running bzr tags') - lines = output.splitlines() - if not lines: - tag = u'0.0.0' - revision = u'0' - else: - tag, revision = lines[-1].split() - bzr = Popen((u'bzr', u'log', u'--line', u'-r', u'-1'), stdout=PIPE) - output, error = bzr.communicate() - code = bzr.wait() - if code != 0: - raise Exception(u'Error running bzr log') - latest = output.split(u':')[0] - full_version = latest == revision and tag or u'%s-bzr%s' % (tag, latest) + # NOTE: The following code is a duplicate of the code in setup.py. Any fix applied here should also be applied + # there. + + # Get the revision of this tree. + bzr = Popen((u'bzr', u'revno'), stdout=PIPE) + tree_revision, error = bzr.communicate() + code = bzr.wait() + if code != 0: + raise Exception(u'Error running bzr log') + + # Get all tags. + bzr = Popen((u'bzr', u'tags'), stdout=PIPE) + output, error = bzr.communicate() + code = bzr.wait() + if code != 0: + raise Exception(u'Error running bzr tags') + tags = output.splitlines() + if not tags: + tag_version = u'0.0.0' + tag_revision = u'0' + else: + # Remove any tag that has "?" as revision number. A "?" as revision number indicates, that this tag is from + # another series. + tags = [tag for tag in tags if tag.split()[-1].strip() != u'?'] + # Get the last tag and split it in a revision and tag name. + 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 full version. + if tree_revision == tag_revision: + full_version = tag_version + else: + full_version = u'%s-bzr%s' % (tag_version, tree_revision) else: # We're not running the development version, let's use the file. filepath = AppLocation.get_directory(AppLocation.VersionDir) diff --git a/openlp/plugins/bibles/forms/bibleimportform.py b/openlp/plugins/bibles/forms/bibleimportform.py index 6920be61c..0662f78db 100644 --- a/openlp/plugins/bibles/forms/bibleimportform.py +++ b/openlp/plugins/bibles/forms/bibleimportform.py @@ -511,7 +511,7 @@ class BibleImportForm(OpenLPWizard): name = bible[u'abbreviation'] self.web_bible_list[download_type][version] = name.strip() - def preWizard(self): + def pre_wizard(self): """ Prepare the UI for the import. """ diff --git a/openlp/plugins/bibles/forms/bibleupgradeform.py b/openlp/plugins/bibles/forms/bibleupgradeform.py index d8f329ee7..caba4b30f 100644 --- a/openlp/plugins/bibles/forms/bibleupgradeform.py +++ b/openlp/plugins/bibles/forms/bibleupgradeform.py @@ -105,7 +105,7 @@ class BibleUpgradeForm(OpenLPWizard): Perform necessary functions depending on which wizard page is active. """ if self.page(pageId) == self.progress_page: - self.preWizard() + self.pre_wizard() self.performWizard() self.post_wizard() elif self.page(pageId) == self.selectPage and not self.files: @@ -329,7 +329,7 @@ class BibleUpgradeForm(OpenLPWizard): self.cancel_button.setVisible(True) settings.endGroup() - def preWizard(self): + def pre_wizard(self): """ Prepare the UI for the upgrade. """ diff --git a/openlp/plugins/custom/lib/mediaitem.py b/openlp/plugins/custom/lib/mediaitem.py index f51db8e6b..c2c67c304 100644 --- a/openlp/plugins/custom/lib/mediaitem.py +++ b/openlp/plugins/custom/lib/mediaitem.py @@ -40,6 +40,7 @@ from openlp.plugins.custom.lib.db import CustomSlide log = logging.getLogger(__name__) + class CustomSearch(object): """ An enumeration for custom search methods. @@ -214,7 +215,6 @@ class CustomMediaItem(MediaManagerItem): Settings().setValue(u'%s/last search type' % self.settings_section, self.search_text_edit.current_search_type()) # Reload the list considering the new search type. search_keywords = self.search_text_edit.displayText() - search_results = [] search_type = self.search_text_edit.current_search_type() if search_type == CustomSearch.Titles: log.debug(u'Titles Search') @@ -252,7 +252,8 @@ class CustomMediaItem(MediaManagerItem): and_(CustomSlide.title == item.title, CustomSlide.theme_name == item.theme, CustomSlide.credits == item.raw_footer[0][len(item.title) + 1:])) if custom: - self.service_manager.service_item_update(custom.id, item.unique_identifier) + item.edit_id = custom.id + return item else: if self.add_custom_from_service: self.create_from_service_item(item) @@ -281,8 +282,6 @@ class CustomMediaItem(MediaManagerItem): custom.text = unicode(custom_xml.extract_xml(), u'utf-8') self.plugin.manager.save_object(custom) self.on_search_text_button_clicked() - if item.name.lower() == u'custom': - Registry().execute(u'service_item_update', u'%s:%s:%s' % (custom.id, item.unique_identifier, False)) def on_clear_text_button_click(self): """ diff --git a/openlp/plugins/images/forms/choosegroupform.py b/openlp/plugins/images/forms/choosegroupform.py index f11c8324c..02f79e63b 100644 --- a/openlp/plugins/images/forms/choosegroupform.py +++ b/openlp/plugins/images/forms/choosegroupform.py @@ -50,6 +50,7 @@ class ChooseGroupForm(QtGui.QDialog, Ui_ChooseGroupDialog): ``selected_group`` The ID of the group that should be selected by default when showing the dialog. """ + self.new_group_edit.clear() if selected_group is not None: for index in range(self.group_combobox.count()): if self.group_combobox.itemData(index) == selected_group: diff --git a/openlp/plugins/images/lib/imagetab.py b/openlp/plugins/images/lib/imagetab.py index 83d015cb8..b43b19097 100644 --- a/openlp/plugins/images/lib/imagetab.py +++ b/openlp/plugins/images/lib/imagetab.py @@ -32,7 +32,6 @@ from PyQt4 import QtGui from openlp.core.lib import Registry, SettingsTab, Settings, UiStrings, translate - class ImageTab(SettingsTab): """ ImageTab is the images settings tab in the settings dialog. diff --git a/openlp/plugins/images/lib/mediaitem.py b/openlp/plugins/images/lib/mediaitem.py index 95f0971fd..3475570fc 100644 --- a/openlp/plugins/images/lib/mediaitem.py +++ b/openlp/plugins/images/lib/mediaitem.py @@ -391,6 +391,7 @@ class ImageMediaItem(MediaManagerItem): ``initial_load`` When set to False, the busy cursor and progressbar will be shown while loading images """ + parent_group = None if target_group is None: # Find out if a group must be pre-selected preselect_group = None @@ -436,6 +437,8 @@ class ImageMediaItem(MediaManagerItem): parent_group.parent_id = 0 parent_group.group_name = self.choose_group_form.new_group_edit.text() self.manager.save_object(parent_group) + self.fill_groups_combobox(self.choose_group_form.group_combobox) + self.fill_groups_combobox(self.add_group_form.parent_group_combobox) else: parent_group = target_group.data(0, QtCore.Qt.UserRole) if isinstance(parent_group, ImageFilenames): @@ -470,7 +473,7 @@ class ImageMediaItem(MediaManagerItem): This boolean is set to True when the list in the interface should be reloaded after saving the new images """ for filename in images_list: - if type(filename) is not str and type(filename) is not unicode: + if not isinstance(filename, basestring): continue log.debug(u'Adding new image: %s', filename) imageFile = ImageFilenames() @@ -550,28 +553,25 @@ class ImageMediaItem(MediaManagerItem): service_item.add_capability(ItemCapabilities.CanAppend) # force a nonexistent theme service_item.theme = -1 - missing_items = [] missing_items_filenames = [] + images_filenames = [] # Expand groups to images for bitem in items: if isinstance(bitem.data(0, QtCore.Qt.UserRole), ImageGroups) or bitem.data(0, QtCore.Qt.UserRole) is None: for index in range(0, bitem.childCount()): if isinstance(bitem.child(index).data(0, QtCore.Qt.UserRole), ImageFilenames): - items.append(bitem.child(index)) - items.remove(bitem) + images_filenames.append(bitem.child(index).data(0, QtCore.Qt.UserRole).filename) + elif isinstance(bitem.data(0, QtCore.Qt.UserRole), ImageFilenames): + images_filenames.append(bitem.data(0, QtCore.Qt.UserRole).filename) # Don't try to display empty groups - if not items: + if not images_filenames: return False # Find missing files - for bitem in items: - filename = bitem.data(0, QtCore.Qt.UserRole).filename + for filename in images_filenames: if not os.path.exists(filename): - missing_items.append(bitem) missing_items_filenames.append(filename) - for item in missing_items: - items.remove(item) # We cannot continue, as all images do not exist. - if not items: + if not images_filenames: if not remote: critical_error_message_box( translate('ImagePlugin.MediaItem', 'Missing Image(s)'), @@ -579,15 +579,14 @@ class ImageMediaItem(MediaManagerItem): u'\n'.join(missing_items_filenames)) return False # We have missing as well as existing images. We ask what to do. - elif missing_items and QtGui.QMessageBox.question(self, + elif missing_items_filenames and QtGui.QMessageBox.question(self, translate('ImagePlugin.MediaItem', 'Missing Image(s)'), translate('ImagePlugin.MediaItem', 'The following image(s) no longer exist: %s\n' 'Do you want to add the other images anyway?') % u'\n'.join(missing_items_filenames), QtGui.QMessageBox.StandardButtons(QtGui.QMessageBox.No | QtGui.QMessageBox.Yes)) == QtGui.QMessageBox.No: return False # Continue with the existing images. - for bitem in items: - filename = bitem.data(0, QtCore.Qt.UserRole).filename + for filename in images_filenames: name = os.path.split(filename)[1] service_item.add_from_image(filename, name, background) return True diff --git a/openlp/plugins/media/lib/mediaitem.py b/openlp/plugins/media/lib/mediaitem.py index 243fcd158..30748a225 100644 --- a/openlp/plugins/media/lib/mediaitem.py +++ b/openlp/plugins/media/lib/mediaitem.py @@ -155,7 +155,7 @@ class MediaMediaItem(MediaManagerItem): if os.path.exists(filename): service_item = ServiceItem() service_item.title = u'webkit' - service_item.shortname = service_item.title + service_item.processor = u'webkit' (path, name) = os.path.split(filename) service_item.add_from_command(path, name,CLAPPERBOARD) if self.media_controller.video(DisplayControllerType.Live, service_item, video_behind_text=True): @@ -185,9 +185,9 @@ class MediaMediaItem(MediaManagerItem): translate('MediaPlugin.MediaItem', 'Missing Media File'), translate('MediaPlugin.MediaItem', 'The file %s no longer exists.') % filename) return False - service_item.title = self.display_type_combo_box.currentText() - service_item.shortname = service_item.title (path, name) = os.path.split(filename) + service_item.title = name + service_item.processor = self.display_type_combo_box.currentText() service_item.add_from_command(path, name, CLAPPERBOARD) # Only get start and end times if going to a service if context == ServiceItemContext.Service: @@ -196,7 +196,6 @@ class MediaMediaItem(MediaManagerItem): return False service_item.add_capability(ItemCapabilities.CanAutoStartForLive) service_item.add_capability(ItemCapabilities.RequiresMedia) - service_item.add_capability(ItemCapabilities.HasDetailedTitleDisplay) if Settings().value(self.settings_section + u'/media auto start') == QtCore.Qt.Checked: service_item.will_auto_start = True # force a non-existent theme @@ -260,8 +259,7 @@ class MediaMediaItem(MediaManagerItem): Settings().setValue(self.settings_section + u'/media files', self.get_file_list()) def load_list(self, media, target_group=None): - # Sort the media by its filename considering language specific - # characters. + # Sort the media by its filename considering language specific characters. media.sort(key=lambda filename: get_locale_key(os.path.split(unicode(filename))[1])) for track in media: track_info = QtCore.QFileInfo(track) diff --git a/openlp/plugins/presentations/lib/mediaitem.py b/openlp/plugins/presentations/lib/mediaitem.py index 2f48b99c1..fcfc495ed 100644 --- a/openlp/plugins/presentations/lib/mediaitem.py +++ b/openlp/plugins/presentations/lib/mediaitem.py @@ -244,22 +244,20 @@ class PresentationMediaItem(MediaManagerItem): items = self.list_view.selectedItems() if len(items) > 1: return False - service_item.title = self.display_type_combo_box.currentText() - service_item.shortname = self.display_type_combo_box.currentText() + service_item.processor = self.display_type_combo_box.currentText() service_item.add_capability(ItemCapabilities.ProvidesOwnDisplay) - service_item.add_capability(ItemCapabilities.HasDetailedTitleDisplay) - shortname = service_item.shortname - if not shortname: + if not self.display_type_combo_box.currentText(): return False for bitem in items: filename = bitem.data(QtCore.Qt.UserRole) + (path, name) = os.path.split(filename) + service_item.title = name if os.path.exists(filename): - if shortname == self.Automatic: - service_item.shortname = self.findControllerByType(filename) - if not service_item.shortname: + if service_item.processor == self.Automatic: + service_item.processor = self.findControllerByType(filename) + if not service_item.processor: return False - controller = self.controllers[service_item.shortname] - (path, name) = os.path.split(filename) + controller = self.controllers[service_item.processor] doc = controller.add_document(filename) if doc.get_thumbnail_path(1, True) is None: doc.load_presentation() diff --git a/openlp/plugins/presentations/lib/messagelistener.py b/openlp/plugins/presentations/lib/messagelistener.py index 330c36f5c..cd7c654a2 100644 --- a/openlp/plugins/presentations/lib/messagelistener.py +++ b/openlp/plugins/presentations/lib/messagelistener.py @@ -36,6 +36,7 @@ from openlp.core.ui import HideMode log = logging.getLogger(__name__) + class Controller(object): """ This is the Presentation listener who acts on events from the slide controller and passes the messages on the the @@ -314,7 +315,7 @@ class MessageListener(object): item = message[0] hide_mode = message[2] file = item.get_frame_path() - self.handler = item.title + self.handler = item.processor if self.handler == self.media_item.Automatic: self.handler = self.media_item.findControllerByType(file) if not self.handler: diff --git a/openlp/plugins/presentations/lib/presentationcontroller.py b/openlp/plugins/presentations/lib/presentationcontroller.py index 7501fd6df..85ebc42ad 100644 --- a/openlp/plugins/presentations/lib/presentationcontroller.py +++ b/openlp/plugins/presentations/lib/presentationcontroller.py @@ -38,6 +38,7 @@ from openlp.core.utils import AppLocation log = logging.getLogger(__name__) + class PresentationDocument(object): """ Base class for presentation documents to inherit from. Loads and closes the presentation as well as triggering the @@ -322,7 +323,7 @@ class PresentationController(object): ``supports`` The primary native file types this application supports. - ``alsosupports`` + ``also_supports`` Other file types the application can import, although not necessarily the first choice due to potential incompatibilities. @@ -358,7 +359,7 @@ class PresentationController(object): Name of the application, to appear in the application """ self.supports = [] - self.alsosupports = [] + self.also_supports = [] self.docs = [] self.plugin = plugin self.name = name diff --git a/openlp/plugins/presentations/presentationplugin.py b/openlp/plugins/presentations/presentationplugin.py index 1cb966aa5..cc1516b69 100644 --- a/openlp/plugins/presentations/presentationplugin.py +++ b/openlp/plugins/presentations/presentationplugin.py @@ -49,7 +49,7 @@ __default_settings__ = { u'presentations/Powerpoint': QtCore.Qt.Checked, u'presentations/Powerpoint Viewer': QtCore.Qt.Checked, u'presentations/presentations files': [] - } +} class PresentationPlugin(Plugin): diff --git a/openlp/plugins/remotes/html/live.css b/openlp/plugins/remotes/html/live.css new file mode 100644 index 000000000..7181129d9 --- /dev/null +++ b/openlp/plugins/remotes/html/live.css @@ -0,0 +1,39 @@ +/****************************************************************************** +* 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 * +* --------------------------------------------------------------------------- * +* 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 * +******************************************************************************/ +body { + background-color: black; + font-family: sans-serif; + overflow: hidden; +} + +.size { + position: absolute; + top: 0px; + vertical-align: middle; + height: 100%; + background-size: cover; + background-repeat: no-repeat; +} \ No newline at end of file diff --git a/openlp/plugins/remotes/html/live.html b/openlp/plugins/remotes/html/live.html new file mode 100644 index 000000000..f9a2c874c --- /dev/null +++ b/openlp/plugins/remotes/html/live.html @@ -0,0 +1,41 @@ + + + + + + ${live_title} + + + + + + + + + \ No newline at end of file diff --git a/openlp/plugins/remotes/html/live.js b/openlp/plugins/remotes/html/live.js new file mode 100644 index 000000000..d55072c16 --- /dev/null +++ b/openlp/plugins/remotes/html/live.js @@ -0,0 +1,52 @@ +/****************************************************************************** + * 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 * + * --------------------------------------------------------------------------- * + * 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 * + ******************************************************************************/ +window.OpenLP = { + loadSlide: function (event) { + $.getJSON( + "/live/image", + function (data, status) { + var img = document.getElementById('image'); + img.src = data.results.slide_image; + img.style.display = 'block'; + } + ); + }, + pollServer: function () { + $.getJSON( + "/live/poll", + function (data, status) { + if (OpenLP.slideCount != data.results.slide_count) { + OpenLP.slideCount = data.results.slide_count; + OpenLP.loadSlide(); + } + } + ); + } +} +$.ajaxSetup({ cache: false }); +setInterval("OpenLP.pollServer();", 500); +OpenLP.pollServer(); + diff --git a/openlp/plugins/remotes/html/openlp.js b/openlp/plugins/remotes/html/openlp.js index 3cbe65366..10bc9e328 100644 --- a/openlp/plugins/remotes/html/openlp.js +++ b/openlp/plugins/remotes/html/openlp.js @@ -147,7 +147,7 @@ window.OpenLP = { }, pollServer: function () { $.getJSON( - "/stage/api/poll", + "/stage/poll", function (data, status) { var prevItem = OpenLP.currentItem; OpenLP.currentSlide = data.results.slide; diff --git a/openlp/plugins/remotes/html/stage.js b/openlp/plugins/remotes/html/stage.js index dff51537c..42b7712f9 100644 --- a/openlp/plugins/remotes/html/stage.js +++ b/openlp/plugins/remotes/html/stage.js @@ -26,7 +26,7 @@ window.OpenLP = { loadService: function (event) { $.getJSON( - "/stage/api/service/list", + "/stage/service/list", function (data, status) { OpenLP.nextSong = ""; $("#notes").html(""); @@ -46,7 +46,7 @@ window.OpenLP = { }, loadSlides: function (event) { $.getJSON( - "/stage/api/controller/live/text", + "/stage/controller/live/text", function (data, status) { OpenLP.currentSlides = data.results.slides; OpenLP.currentSlide = 0; @@ -137,7 +137,7 @@ window.OpenLP = { }, pollServer: function () { $.getJSON( - "/stage/api/poll", + "/stage/poll", function (data, status) { OpenLP.updateClock(data); if (OpenLP.currentItem != data.results.item || diff --git a/openlp/plugins/remotes/lib/httpserver.py b/openlp/plugins/remotes/lib/httpserver.py index 878b197b3..a2abbb41e 100644 --- a/openlp/plugins/remotes/lib/httpserver.py +++ b/openlp/plugins/remotes/lib/httpserver.py @@ -124,7 +124,7 @@ import cherrypy from mako.template import Template from PyQt4 import QtCore -from openlp.core.lib import Registry, Settings, PluginStatus, StringContent +from openlp.core.lib import Registry, Settings, PluginStatus, StringContent, image_to_byte from openlp.core.utils import AppLocation, translate from cherrypy._cpcompat import sha, ntob @@ -136,6 +136,7 @@ def make_sha_hash(password): """ Create an encrypted password for the given password. """ + log.debug("make_sha_hash") return sha(ntob(password)).hexdigest() @@ -143,6 +144,7 @@ def fetch_password(username): """ Fetch the password for a provided user. """ + log.debug("Fetch Password") if username != Settings().value(u'remotes/user id'): return None return make_sha_hash(Settings().value(u'remotes/password')) @@ -175,9 +177,11 @@ class HttpServer(object): self.root = self.Public() self.root.files = self.Files() self.root.stage = self.Stage() + self.root.live = self.Live() self.root.router = self.router self.root.files.router = self.router self.root.stage.router = self.router + self.root.live.router = self.router cherrypy.tree.mount(self.root, '/', config=self.define_config()) # Turn off the flood of access messages cause by poll cherrypy.log.access_log.propagate = False @@ -212,6 +216,9 @@ class HttpServer(object): u'tools.staticdir.dir': self.router.html_dir, u'tools.basic_auth.on': False}, u'/stage': {u'tools.staticdir.on': True, + u'tools.staticdir.dir': self.router.html_dir, + u'tools.basic_auth.on': False}, + u'/live': {u'tools.staticdir.on': True, u'tools.staticdir.dir': self.router.html_dir, u'tools.basic_auth.on': False}} return directory_config @@ -239,7 +246,16 @@ class HttpServer(object): class Stage(object): """ - Stageview is read only so security is not relevant and would reduce it's usability + Stage view is read only so security is not relevant and would reduce it's usability + """ + @cherrypy.expose + def default(self, *args, **kwargs): + url = urlparse.urlparse(cherrypy.url()) + return self.router.process_http_request(url.path, *args) + + class Live(object): + """ + Live view is read only so security is not relevant and would reduce it's usability """ @cherrypy.expose def default(self, *args, **kwargs): @@ -265,13 +281,16 @@ class HttpRouter(object): self.routes = [ (u'^/$', self.serve_file), (u'^/(stage)$', self.serve_file), + (u'^/(live)$', self.serve_file), (r'^/files/(.*)$', self.serve_file), (r'^/api/poll$', self.poll), - (r'^/stage/api/poll$', self.poll), + (r'^/stage/poll$', self.poll), + (r'^/live/poll$', self.live_poll), + (r'^/live/image$', self.live_image), (r'^/api/controller/(live|preview)/(.*)$', self.controller), - (r'^/stage/api/controller/(live|preview)/(.*)$', self.controller), + (r'^/stage/controller/(live|preview)/(.*)$', self.controller), (r'^/api/service/(.*)$', self.service), - (r'^/stage/api/service/(.*)$', self.service), + (r'^/stage/service/(.*)$', self.service), (r'^/api/display/(hide|show|blank|theme|desktop)$', self.display), (r'^/api/alert$', self.alert), (r'^/api/plugin/(search)$', self.plugin_info), @@ -305,6 +324,7 @@ class HttpRouter(object): if response: return response else: + log.debug('Path not found %s', url_path) return self._http_not_found() def _get_service_items(self): @@ -334,6 +354,7 @@ class HttpRouter(object): self.template_vars = { 'app_title': translate('RemotePlugin.Mobile', 'OpenLP 2.1 Remote'), 'stage_title': translate('RemotePlugin.Mobile', 'OpenLP 2.1 Stage View'), + 'live_title': translate('RemotePlugin.Mobile', 'OpenLP 2.1 Live View'), 'service_manager': translate('RemotePlugin.Mobile', 'Service Manager'), 'slide_controller': translate('RemotePlugin.Mobile', 'Slide Controller'), 'alerts': translate('RemotePlugin.Mobile', 'Alerts'), @@ -359,18 +380,19 @@ class HttpRouter(object): def serve_file(self, filename=None): """ - Send a file to the socket. For now, just a subset of file types - and must be top level inside the html folder. + Send a file to the socket. For now, just a subset of file types and must be top level inside the html folder. If subfolders requested return 404, easier for security for the present. - Ultimately for i18n, this could first look for xx/file.html before - falling back to file.html... where xx is the language, e.g. 'en' + Ultimately for i18n, this could first look for xx/file.html before falling back to file.html. + where xx is the language, e.g. 'en' """ log.debug(u'serve file request %s' % filename) if not filename: filename = u'index.html' elif filename == u'stage': filename = u'stage.html' + elif filename == u'live': + filename = u'live.html' path = os.path.normpath(os.path.join(self.html_dir, filename)) if not path.startswith(self.html_dir): return self._http_not_found() @@ -425,6 +447,26 @@ class HttpRouter(object): cherrypy.response.headers['Content-Type'] = u'application/json' return json.dumps({u'results': result}) + def live_poll(self): + """ + Poll OpenLP to determine the current slide count. + """ + result = { + u'slide_count': self.live_controller.slide_count + } + cherrypy.response.headers['Content-Type'] = u'application/json' + return json.dumps({u'results': result}) + + def live_image(self): + """ + Return the latest display image as a byte stream. + """ + result = { + u'slide_image': u'data:image/png;base64,' + str(image_to_byte(self.live_controller.slide_image)) + } + cherrypy.response.headers['Content-Type'] = u'application/json' + return json.dumps({u'results': result}) + def display(self, action): """ Hide or show the display screen. diff --git a/openlp/plugins/remotes/lib/remotetab.py b/openlp/plugins/remotes/lib/remotetab.py index 09934b58c..c8ed9303e 100644 --- a/openlp/plugins/remotes/lib/remotetab.py +++ b/openlp/plugins/remotes/lib/remotetab.py @@ -86,6 +86,12 @@ class RemoteTab(SettingsTab): self.stage_url.setObjectName(u'stage_url') self.stage_url.setOpenExternalLinks(True) self.http_setting_layout.addRow(self.stage_url_label, self.stage_url) + self.live_url_label = QtGui.QLabel(self.http_settings_group_box) + self.live_url_label.setObjectName(u'live_url_label') + self.live_url = QtGui.QLabel(self.http_settings_group_box) + self.live_url.setObjectName(u'live_url') + self.live_url.setOpenExternalLinks(True) + self.http_setting_layout.addRow(self.live_url_label, self.live_url) self.left_layout.addWidget(self.http_settings_group_box) self.https_settings_group_box = QtGui.QGroupBox(self.left_column) self.https_settings_group_box.setCheckable(True) @@ -116,6 +122,12 @@ class RemoteTab(SettingsTab): self.stage_https_url.setObjectName(u'stage_https_url') self.stage_https_url.setOpenExternalLinks(True) self.https_settings_layout.addRow(self.stage_https_url_label, self.stage_https_url) + self.live_https_url_label = QtGui.QLabel(self.https_settings_group_box) + self.live_https_url_label.setObjectName(u'live_url_label') + self.live_https_url = QtGui.QLabel(self.https_settings_group_box) + self.live_https_url.setObjectName(u'live_https_url') + self.live_https_url.setOpenExternalLinks(True) + self.https_settings_layout.addRow(self.live_https_url_label, self.live_https_url) self.left_layout.addWidget(self.https_settings_group_box) self.user_login_group_box = QtGui.QGroupBox(self.left_column) self.user_login_group_box.setCheckable(True) @@ -163,6 +175,7 @@ class RemoteTab(SettingsTab): self.port_label.setText(translate('RemotePlugin.RemoteTab', 'Port number:')) self.remote_url_label.setText(translate('RemotePlugin.RemoteTab', 'Remote URL:')) self.stage_url_label.setText(translate('RemotePlugin.RemoteTab', 'Stage view URL:')) + self.live_url_label.setText(translate('RemotePlugin.RemoteTab', 'Live view URL:')) self.twelve_hour_check_box.setText(translate('RemotePlugin.RemoteTab', 'Display stage time in 12h format')) self.android_app_group_box.setTitle(translate('RemotePlugin.RemoteTab', 'Android App')) self.qr_description_label.setText(translate('RemotePlugin.RemoteTab', @@ -176,6 +189,7 @@ class RemoteTab(SettingsTab): self.https_port_label.setText(self.port_label.text()) self.remote_https_url_label.setText(self.remote_url_label.text()) self.stage_https_url_label.setText(self.stage_url_label.text()) + self.live_https_url_label.setText(self.live_url_label.text()) self.user_login_group_box.setTitle(translate('RemotePlugin.RemoteTab', 'User Authentication')) self.user_id_label.setText(translate('RemotePlugin.RemoteTab', 'User id:')) self.password_label.setText(translate('RemotePlugin.RemoteTab', 'Password:')) @@ -203,10 +217,14 @@ class RemoteTab(SettingsTab): https_url = u'https://%s:%s/' % (ip_address, self.https_port_spin_box.value()) self.remote_url.setText(u'%s' % (http_url, http_url)) self.remote_https_url.setText(u'%s' % (https_url, https_url)) - http_url += u'stage' - https_url += u'stage' - self.stage_url.setText(u'%s' % (http_url, http_url)) - self.stage_https_url.setText(u'%s' % (https_url, https_url)) + http_url_temp = http_url + u'stage' + https_url_temp = https_url + u'stage' + self.stage_url.setText(u'%s' % (http_url_temp, http_url_temp)) + self.stage_https_url.setText(u'%s' % (https_url_temp, https_url_temp)) + http_url_temp = http_url + u'live' + https_url_temp = https_url + u'live' + self.live_url.setText(u'%s' % (http_url_temp, http_url_temp)) + self.live_https_url.setText(u'%s' % (https_url_temp, https_url_temp)) def load(self): """ diff --git a/openlp/plugins/songs/forms/__init__.py b/openlp/plugins/songs/forms/__init__.py index a1c177a9d..588f359f6 100644 --- a/openlp/plugins/songs/forms/__init__.py +++ b/openlp/plugins/songs/forms/__init__.py @@ -52,3 +52,4 @@ This allows OpenLP to use ``self.object`` for all the GUI elements while keeping them separate from the functionality, so that it is easier to recreate the GUI from the .ui files later if necessary. """ +from editsongform import EditSongForm diff --git a/openlp/plugins/songs/forms/duplicatesongremovalform.py b/openlp/plugins/songs/forms/duplicatesongremovalform.py new file mode 100644 index 000000000..d612a5627 --- /dev/null +++ b/openlp/plugins/songs/forms/duplicatesongremovalform.py @@ -0,0 +1,358 @@ +# -*- 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 duplicate song removal logic for OpenLP. +""" +from __future__ import division +import logging +import os + +from PyQt4 import QtCore, QtGui + +from openlp.core.lib import Registry, translate +from openlp.core.ui.wizard import OpenLPWizard, WizardStrings +from openlp.core.utils import AppLocation +from openlp.plugins.songs.lib import delete_song +from openlp.plugins.songs.lib.db import Song, MediaFile +from openlp.plugins.songs.forms.songreviewwidget import SongReviewWidget +from openlp.plugins.songs.lib.songcompare import songs_probably_equal + +log = logging.getLogger(__name__) + +class DuplicateSongRemovalForm(OpenLPWizard): + """ + This is the Duplicate Song Removal Wizard. It provides functionality to + search for and remove duplicate songs in the database. + """ + log.info(u'DuplicateSongRemovalForm loaded') + + def __init__(self, plugin): + """ + Instantiate the wizard, and run any extra setup we need to. + + ``parent`` + The QWidget-derived parent of the wizard. + + ``plugin`` + The songs plugin. + """ + self.duplicate_song_list = [] + self.review_current_count = 0 + self.review_total_count = 0 + # Used to interrupt ongoing searches when cancel is clicked. + self.break_search = False + OpenLPWizard.__init__(self, self.main_window, plugin, u'duplicateSongRemovalWizard', + u':/wizards/wizard_duplicateremoval.bmp', False) + self.setMinimumWidth(730) + + def custom_signals(self): + """ + Song wizard specific signals. + """ + self.finish_button.clicked.connect(self.on_wizard_exit) + self.cancel_button.clicked.connect(self.on_wizard_exit) + + def add_custom_pages(self): + """ + Add song wizard specific pages. + """ + # Add custom pages. + self.searching_page = QtGui.QWizardPage() + self.searching_page.setObjectName(u'searching_page') + self.searching_vertical_layout = QtGui.QVBoxLayout(self.searching_page) + self.searching_vertical_layout.setObjectName(u'searching_vertical_layout') + self.duplicate_search_progress_bar = QtGui.QProgressBar(self.searching_page) + self.duplicate_search_progress_bar.setObjectName(u'duplicate_search_progress_bar') + self.duplicate_search_progress_bar.setFormat(WizardStrings.PercentSymbolFormat) + self.searching_vertical_layout.addWidget(self.duplicate_search_progress_bar) + self.found_duplicates_edit = QtGui.QPlainTextEdit(self.searching_page) + self.found_duplicates_edit.setUndoRedoEnabled(False) + self.found_duplicates_edit.setReadOnly(True) + self.found_duplicates_edit.setObjectName(u'found_duplicates_edit') + self.searching_vertical_layout.addWidget(self.found_duplicates_edit) + self.searching_page_id = self.addPage(self.searching_page) + self.review_page = QtGui.QWizardPage() + self.review_page.setObjectName(u'review_page') + self.review_layout = QtGui.QVBoxLayout(self.review_page) + self.review_layout.setObjectName(u'review_layout') + self.review_scroll_area = QtGui.QScrollArea(self.review_page) + self.review_scroll_area.setObjectName(u'review_scroll_area') + self.review_scroll_area.setHorizontalScrollBarPolicy(QtCore.Qt.ScrollBarAsNeeded) + self.review_scroll_area.setVerticalScrollBarPolicy(QtCore.Qt.ScrollBarAsNeeded) + self.review_scroll_area.setWidgetResizable(True) + self.review_scroll_area_widget = QtGui.QWidget(self.review_scroll_area) + self.review_scroll_area_widget.setObjectName(u'review_scroll_area_widget') + self.review_scroll_area_layout = QtGui.QHBoxLayout(self.review_scroll_area_widget) + self.review_scroll_area_layout.setObjectName(u'review_scroll_area_layout') + self.review_scroll_area_layout.setSizeConstraint(QtGui.QLayout.SetMinAndMaxSize) + self.review_scroll_area_layout.setMargin(0) + self.review_scroll_area_layout.setSpacing(0) + self.review_scroll_area.setWidget(self.review_scroll_area_widget) + self.review_layout.addWidget(self.review_scroll_area) + self.review_page_id = self.addPage(self.review_page) + # Add a dummy page to the end, to prevent the finish button to appear and the next button do disappear on the + #review page. + self.dummy_page = QtGui.QWizardPage() + self.dummy_page_id = self.addPage(self.dummy_page) + + def retranslateUi(self): + """ + Song wizard localisation. + """ + self.setWindowTitle(translate(u'Wizard', u'Wizard')) + self.title_label.setText(WizardStrings.HeaderStyle % translate(u'OpenLP.Ui', + u'Welcome to the Duplicate Song Removal Wizard')) + self.information_label.setText(translate("Wizard", + u'This wizard will help you to remove duplicate songs from the song database. You will have a chance to ' + u'review every potential duplicate song before it is deleted. So no songs will be deleted without your ' + u'explicit approval.')) + self.searching_page.setTitle(translate(u'Wizard', u'Searching for duplicate songs.')) + self.searching_page.setSubTitle(translate(u'Wizard', u'Please wait while your songs database is analyzed.')) + self.update_review_counter_text() + self.review_page.setSubTitle(translate(u'Wizard', + u'Here you can decide which songs to remove and which ones to keep.')) + + def update_review_counter_text(self): + """ + Set the wizard review page header text. + """ + self.review_page.setTitle(translate(u'Wizard', u'Review duplicate songs (%s/%s)') % \ + (self.review_current_count, self.review_total_count)) + + def custom_page_changed(self, page_id): + """ + Called when changing the wizard page. + + ``page_id`` + ID of the page the wizard changed to. + """ + # Hide back button. + self.button(QtGui.QWizard.BackButton).hide() + if page_id == self.searching_page_id: + self.application.set_busy_cursor() + try: + self.button(QtGui.QWizard.NextButton).hide() + # Search duplicate songs. + max_songs = self.plugin.manager.get_object_count(Song) + if max_songs == 0 or max_songs == 1: + self.duplicate_search_progress_bar.setMaximum(1) + self.duplicate_search_progress_bar.setValue(1) + self.notify_no_duplicates() + return + # With x songs we have x*(x - 1) / 2 comparisons. + max_progress_count = max_songs * (max_songs - 1) // 2 + self.duplicate_search_progress_bar.setMaximum(max_progress_count) + songs = self.plugin.manager.get_all_objects(Song) + for outer_song_counter in range(max_songs - 1): + for inner_song_counter in range(outer_song_counter + 1, max_songs): + if songs_probably_equal(songs[outer_song_counter], songs[inner_song_counter]): + duplicate_added = self.add_duplicates_to_song_list(songs[outer_song_counter], + songs[inner_song_counter]) + if duplicate_added: + self.found_duplicates_edit.appendPlainText(songs[outer_song_counter].title + " = " + + songs[inner_song_counter].title) + self.duplicate_search_progress_bar.setValue(self.duplicate_search_progress_bar.value() + 1) + # The call to process_events() will keep the GUI responsive. + self.application.process_events() + if self.break_search: + return + self.review_total_count = len(self.duplicate_song_list) + if self.review_total_count == 0: + self.notify_no_duplicates() + else: + self.button(QtGui.QWizard.NextButton).show() + finally: + self.application.set_normal_cursor() + elif page_id == self.review_page_id: + self.process_current_duplicate_entry() + + def notify_no_duplicates(self): + """ + Notifies the user, that there were no duplicates found in the database. + """ + self.button(QtGui.QWizard.FinishButton).show() + self.button(QtGui.QWizard.FinishButton).setEnabled(True) + self.button(QtGui.QWizard.NextButton).hide() + self.button(QtGui.QWizard.CancelButton).hide() + QtGui.QMessageBox.information(self, translate(u'Wizard', u'Information'), + translate(u'Wizard', u'No duplicate songs have been found in the database.'), + QtGui.QMessageBox.StandardButtons(QtGui.QMessageBox.Ok)) + + def add_duplicates_to_song_list(self, search_song, duplicate_song): + """ + Inserts a song duplicate (two similar songs) to the duplicate song list. + If one of the two songs is already part of the duplicate song list, + don't add another duplicate group but add the other song to that group. + Returns True if at least one of the songs was added, False if both were already + member of a group. + + ``search_song`` + The song we searched the duplicate for. + + ``duplicate_song`` + The duplicate song. + """ + duplicate_group_found = False + duplicate_added = False + for duplicate_group in self.duplicate_song_list: + # Skip the first song in the duplicate lists, since the first one has to be an earlier song. + if search_song in duplicate_group and not duplicate_song in duplicate_group: + duplicate_group.append(duplicate_song) + duplicate_group_found = True + duplicate_added = True + break + elif not search_song in duplicate_group and duplicate_song in duplicate_group: + duplicate_group.append(search_song) + duplicate_group_found = True + duplicate_added = True + break + elif search_song in duplicate_group and duplicate_song in duplicate_group: + duplicate_group_found = True + duplicate_added = False + break + if not duplicate_group_found: + self.duplicate_song_list.append([search_song, duplicate_song]) + duplicate_added = True + return duplicate_added + + def on_wizard_exit(self): + """ + Once the wizard is finished, refresh the song list, + since we potentially removed songs from it. + """ + self.break_search = True + self.plugin.media_item.on_search_text_button_clicked() + + def setDefaults(self): + """ + Set default form values for the song import wizard. + """ + self.restart() + self.duplicate_search_progress_bar.setValue(0) + self.found_duplicates_edit.clear() + + def validateCurrentPage(self): + """ + Controls whether we should switch to the next wizard page. This method loops + on the review page as long as there are more song duplicates to review. + """ + if self.currentId() == self.review_page_id: + # As long as it's not the last duplicate list entry we revisit the review page. + if len(self.duplicate_song_list) == 1: + return True + else: + self.proceed_to_next_review() + return False + return OpenLPWizard.validateCurrentPage(self) + + def remove_button_clicked(self, song_review_widget): + """ + Removes a song from the database, removes the GUI element representing the + song on the review page, and disable the remove button if only one duplicate + is left. + + ``song_review_widget`` + The SongReviewWidget whose song we should delete. + """ + # Remove song from duplicate song list. + self.duplicate_song_list[-1].remove(song_review_widget.song) + # Remove song from the database. + delete_song(song_review_widget.song.id, self.plugin) + # Remove GUI elements for the song. + self.review_scroll_area_layout.removeWidget(song_review_widget) + song_review_widget.setParent(None) + # Check if we only have one duplicate left: + # 2 stretches + 1 SongReviewWidget = 3 + # The SongReviewWidget is then at position 1. + if len(self.duplicate_song_list[-1]) == 1: + self.review_scroll_area_layout.itemAt(1).widget().song_remove_button.setEnabled(False) + + def proceed_to_next_review(self): + """ + Removes the previous review UI elements and calls process_current_duplicate_entry. + """ + # Remove last duplicate group. + self.duplicate_song_list.pop() + # Remove all previous elements. + for i in reversed(range(self.review_scroll_area_layout.count())): + item = self.review_scroll_area_layout.itemAt(i) + if isinstance(item, QtGui.QWidgetItem): + # The order is important here, if the .setParent(None) call is done + # before the .removeItem() call, a segfault occurs. + widget = item.widget() + self.review_scroll_area_layout.removeItem(item) + widget.setParent(None) + else: + self.review_scroll_area_layout.removeItem(item) + # Process next set of duplicates. + self.process_current_duplicate_entry() + + def process_current_duplicate_entry(self): + """ + Update the review counter in the wizard header, add song widgets for + the current duplicate group to review, if it's the last + duplicate song group, hide the "next" button and show the "finish" button. + """ + # Update the counter. + self.review_current_count = self.review_total_count - (len(self.duplicate_song_list) - 1) + self.update_review_counter_text() + # Add song elements to the UI. + if len(self.duplicate_song_list) > 0: + self.review_scroll_area_layout.addStretch(1) + for duplicate in self.duplicate_song_list[-1]: + song_review_widget = SongReviewWidget(self.review_page, duplicate) + song_review_widget.song_remove_button_clicked.connect(self.remove_button_clicked) + self.review_scroll_area_layout.addWidget(song_review_widget) + self.review_scroll_area_layout.addStretch(1) + # Change next button to finish button on last review. + if len(self.duplicate_song_list) == 1: + self.button(QtGui.QWizard.FinishButton).show() + self.button(QtGui.QWizard.FinishButton).setEnabled(True) + self.button(QtGui.QWizard.NextButton).hide() + self.button(QtGui.QWizard.CancelButton).hide() + + def _get_main_window(self): + """ + Adds the main window to the class dynamically. + """ + if not hasattr(self, u'_main_window'): + self._main_window = Registry().get(u'main_window') + return self._main_window + + main_window = property(_get_main_window) + + def _get_application(self): + """ + Adds the openlp to the class dynamically + """ + if not hasattr(self, u'_application'): + self._application = Registry().get(u'application') + return self._application + + application = property(_get_application) \ No newline at end of file diff --git a/openlp/plugins/songs/forms/songexportform.py b/openlp/plugins/songs/forms/songexportform.py index f0554f588..36ed50cee 100644 --- a/openlp/plugins/songs/forms/songexportform.py +++ b/openlp/plugins/songs/forms/songexportform.py @@ -235,7 +235,7 @@ class SongExportForm(OpenLPWizard): self.availableListWidget.addItem(item) self.application.set_normal_cursor() - def preWizard(self): + def pre_wizard(self): """ Perform pre export tasks. """ diff --git a/openlp/plugins/songs/forms/songimportform.py b/openlp/plugins/songs/forms/songimportform.py index 4c749f4d0..add306505 100644 --- a/openlp/plugins/songs/forms/songimportform.py +++ b/openlp/plugins/songs/forms/songimportform.py @@ -325,7 +325,7 @@ class SongImportForm(OpenLPWizard): self.error_copy_to_button.setHidden(True) self.error_save_to_button.setHidden(True) - def preWizard(self): + def pre_wizard(self): """ Perform pre import tasks """ diff --git a/openlp/plugins/songs/forms/songreviewwidget.py b/openlp/plugins/songs/forms/songreviewwidget.py new file mode 100644 index 000000000..7b24563f9 --- /dev/null +++ b/openlp/plugins/songs/forms/songreviewwidget.py @@ -0,0 +1,213 @@ +# -*- 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 # +############################################################################### +""" +A widget representing a song in the duplicate song removal wizard review page. +""" +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 + + +class SongReviewWidget(QtGui.QWidget): + """ + A widget representing a song on the duplicate song review page. + It displays most of the information a song contains and + provides a "remove" button to remove the song from the database. + The remove logic is not implemented here, but a signal is provided + when the remove button is clicked. + """ + + # Signals have to be class variables and not instance variables. Otherwise + # they are not registered by Qt (missing emit and connect methods are artifacts of this). + # To use SongReviewWidget as a signal parameter one would have to assigning the class + # variable after the class is declared. While this is possible, it also messes Qts meta + # object system up. The result is an + # "Object::connect: Use the SIGNAL macro to bind SongReviewWidget::(QWidget*)" error on + # connect calls. + # That's why we cheat a little and use QWidget instead of SongReviewWidget as parameter. + # While not being entirely correct, it does work. + song_remove_button_clicked = QtCore.pyqtSignal(QtGui.QWidget) + + def __init__(self, parent, song): + """ + ``parent`` + The QWidget-derived parent of the wizard. + + ``song`` + The Song which this SongReviewWidget should represent. + """ + QtGui.QWidget.__init__(self, parent) + self.song = song + self.setupUi() + self.retranslateUi() + self.song_remove_button.clicked.connect(self.on_remove_button_clicked) + + def setupUi(self): + self.song_vertical_layout = QtGui.QVBoxLayout(self) + self.song_vertical_layout.setObjectName(u'song_vertical_layout') + self.song_group_box = QtGui.QGroupBox(self) + self.song_group_box.setObjectName(u'song_group_box') + self.song_group_box.setFixedWidth(300) + self.song_group_box_layout = QtGui.QVBoxLayout(self.song_group_box) + self.song_group_box_layout.setObjectName(u'song_group_box_layout') + self.song_info_form_layout = QtGui.QFormLayout() + self.song_info_form_layout.setObjectName(u'song_info_form_layout') + # Add title widget. + self.song_title_label = QtGui.QLabel(self) + self.song_title_label.setObjectName(u'song_title_label') + self.song_info_form_layout.setWidget(0, QtGui.QFormLayout.LabelRole, self.song_title_label) + self.song_title_content = QtGui.QLabel(self) + self.song_title_content.setObjectName(u'song_title_content') + self.song_title_content.setText(self.song.title) + self.song_title_content.setWordWrap(True) + self.song_info_form_layout.setWidget(0, QtGui.QFormLayout.FieldRole, self.song_title_content) + # Add alternate title widget. + self.song_alternate_title_label = QtGui.QLabel(self) + self.song_alternate_title_label.setObjectName(u'song_alternate_title_label') + self.song_info_form_layout.setWidget(1, QtGui.QFormLayout.LabelRole, self.song_alternate_title_label) + self.song_alternate_title_content = QtGui.QLabel(self) + self.song_alternate_title_content.setObjectName(u'song_alternate_title_content') + self.song_alternate_title_content.setText(self.song.alternate_title) + self.song_alternate_title_content.setWordWrap(True) + self.song_info_form_layout.setWidget(1, QtGui.QFormLayout.FieldRole, self.song_alternate_title_content) + # Add CCLI number widget. + self.song_ccli_number_label = QtGui.QLabel(self) + self.song_ccli_number_label.setObjectName(u'song_ccli_number_label') + self.song_info_form_layout.setWidget(2, QtGui.QFormLayout.LabelRole, self.song_ccli_number_label) + self.song_ccli_number_content = QtGui.QLabel(self) + self.song_ccli_number_content.setObjectName(u'song_ccli_number_content') + self.song_ccli_number_content.setText(self.song.ccli_number) + self.song_ccli_number_content.setWordWrap(True) + self.song_info_form_layout.setWidget(2, QtGui.QFormLayout.FieldRole, self.song_ccli_number_content) + # Add copyright widget. + self.song_copyright_label = QtGui.QLabel(self) + self.song_copyright_label.setObjectName(u'song_copyright_label') + self.song_info_form_layout.setWidget(3, QtGui.QFormLayout.LabelRole, self.song_copyright_label) + self.song_copyright_content = QtGui.QLabel(self) + self.song_copyright_content.setObjectName(u'song_copyright_content') + self.song_copyright_content.setWordWrap(True) + self.song_copyright_content.setText(self.song.copyright) + self.song_info_form_layout.setWidget(3, QtGui.QFormLayout.FieldRole, self.song_copyright_content) + # Add comments widget. + self.song_comments_label = QtGui.QLabel(self) + self.song_comments_label.setObjectName(u'song_comments_label') + self.song_info_form_layout.setWidget(4, QtGui.QFormLayout.LabelRole, self.song_comments_label) + self.song_comments_content = QtGui.QLabel(self) + self.song_comments_content.setObjectName(u'song_comments_content') + self.song_comments_content.setText(self.song.comments) + self.song_comments_content.setWordWrap(True) + self.song_info_form_layout.setWidget(4, QtGui.QFormLayout.FieldRole, self.song_comments_content) + # Add authors widget. + self.song_authors_label = QtGui.QLabel(self) + self.song_authors_label.setObjectName(u'song_authors_label') + self.song_info_form_layout.setWidget(5, QtGui.QFormLayout.LabelRole, self.song_authors_label) + self.song_authors_content = QtGui.QLabel(self) + self.song_authors_content.setObjectName(u'song_authors_content') + self.song_authors_content.setWordWrap(True) + authors_text = u', '.join([author.display_name for author in self.song.authors]) + self.song_authors_content.setText(authors_text) + self.song_info_form_layout.setWidget(5, QtGui.QFormLayout.FieldRole, self.song_authors_content) + # Add verse order widget. + self.song_verse_order_label = QtGui.QLabel(self) + self.song_verse_order_label.setObjectName(u'song_verse_order_label') + self.song_info_form_layout.setWidget(6, QtGui.QFormLayout.LabelRole, self.song_verse_order_label) + self.song_verse_order_content = QtGui.QLabel(self) + self.song_verse_order_content.setObjectName(u'song_verse_order_content') + self.song_verse_order_content.setText(self.song.verse_order) + self.song_verse_order_content.setWordWrap(True) + self.song_info_form_layout.setWidget(6, QtGui.QFormLayout.FieldRole, self.song_verse_order_content) + self.song_group_box_layout.addLayout(self.song_info_form_layout) + # Add verses widget. + self.song_info_verse_list_widget = QtGui.QTableWidget(self.song_group_box) + self.song_info_verse_list_widget.setColumnCount(1) + self.song_info_verse_list_widget.horizontalHeader().setVisible(False) + self.song_info_verse_list_widget.setObjectName(u'song_info_verse_list_widget') + self.song_info_verse_list_widget.setSelectionMode(QtGui.QAbstractItemView.NoSelection) + self.song_info_verse_list_widget.setEditTriggers(QtGui.QAbstractItemView.NoEditTriggers) + self.song_info_verse_list_widget.setHorizontalScrollBarPolicy(QtCore.Qt.ScrollBarAlwaysOff) + self.song_info_verse_list_widget.setVerticalScrollBarPolicy(QtCore.Qt.ScrollBarAlwaysOff) + self.song_info_verse_list_widget.setAlternatingRowColors(True) + song_xml = SongXML() + verses = song_xml.get_verses(self.song.lyrics) + self.song_info_verse_list_widget.setRowCount(len(verses)) + song_tags = [] + for verse_number, verse in enumerate(verses): + item = QtGui.QTableWidgetItem() + item.setText(verse[1]) + self.song_info_verse_list_widget.setItem(verse_number, 0, item) + + # We cannot use from_loose_input() here, because database + # is supposed to contain English lowercase singlechar tags. + verse_tag = verse[0][u'type'] + verse_index = None + if len(verse_tag) > 1: + verse_index = VerseType.from_translated_string(verse_tag) + if verse_index is None: + verse_index = VerseType.from_string(verse_tag, None) + if verse_index is None: + verse_index = VerseType.from_tag(verse_tag) + verse_tag = VerseType.translated_tags[verse_index].upper() + song_tags.append(unicode(verse_tag + verse[0]['label'])) + self.song_info_verse_list_widget.setVerticalHeaderLabels(song_tags) + # Resize table fields to content and table to columns + self.song_info_verse_list_widget.setColumnWidth(0, self.song_group_box.width()) + self.song_info_verse_list_widget.resizeRowsToContents() + # The 6 is a trial and error value since verticalHeader().length() + offset() is a little bit to small. + # It seems there is no clean way to determine the real height of the table contents. + # The "correct" value slightly fluctuates depending on the theme used, in the worst case + # Some pixels are missing at the bottom of the table, but all themes I tried still allowed + # to read the last verse line, so I'll just leave it at that. + self.song_info_verse_list_widget.setFixedHeight(self.song_info_verse_list_widget.verticalHeader().length() + + self.song_info_verse_list_widget.verticalHeader().offset() + 6) + self.song_group_box_layout.addWidget(self.song_info_verse_list_widget) + self.song_group_box_layout.addStretch() + self.song_vertical_layout.addWidget(self.song_group_box) + self.song_remove_button = QtGui.QPushButton(self) + self.song_remove_button.setObjectName(u'song_remove_button') + self.song_remove_button.setIcon(build_icon(u':/songs/song_delete.png')) + self.song_remove_button.setSizePolicy(QtGui.QSizePolicy.Fixed, QtGui.QSizePolicy.Fixed) + self.song_vertical_layout.addWidget(self.song_remove_button, alignment = QtCore.Qt.AlignHCenter) + + def retranslateUi(self): + self.song_remove_button.setText(u'Remove') + self.song_title_label.setText(u'Title:') + self.song_alternate_title_label.setText(u'Alternate Title:') + self.song_ccli_number_label.setText(u'CCLI Number:') + self.song_verse_order_label.setText(u'Verse Order:') + self.song_copyright_label.setText(u'Copyright:') + self.song_comments_label.setText(u'Comments:') + self.song_authors_label.setText(u'Authors:') + + def on_remove_button_clicked(self): + """ + Signal emitted when the "remove" button is clicked. + """ + self.song_remove_button_clicked.emit(self) diff --git a/openlp/plugins/songs/lib/__init__.py b/openlp/plugins/songs/lib/__init__.py index d3005c9b2..407fede8d 100644 --- a/openlp/plugins/songs/lib/__init__.py +++ b/openlp/plugins/songs/lib/__init__.py @@ -29,15 +29,21 @@ """ The :mod:`~openlp.plugins.songs.lib` module contains a number of library functions and classes used in the Songs plugin. """ + +import logging +import os import re from PyQt4 import QtGui from openlp.core.lib import translate -from openlp.core.utils import CONTROL_CHARS +from openlp.core.utils import AppLocation, CONTROL_CHARS +from openlp.plugins.songs.lib.db import MediaFile, Song from db import Author from ui import SongStrings +log = logging.getLogger(__name__) + WHITESPACE = re.compile(r'[\W_]+', re.UNICODE) APOSTROPHE = re.compile(u'[\'`’ʻ′]', re.UNICODE) PATTERN = re.compile(r"\\([a-z]{1,32})(-?\d{1,10})?[ ]?|\\'([0-9a-f]{2})|\\([^a-z])|([{}])|[\r\n]+|(.)", re.I) @@ -593,3 +599,29 @@ def strip_rtf(text, default_encoding=None): text = u''.join(out) return text, default_encoding + +def delete_song(song_id, song_plugin): + """ + Deletes a song from the database. Media files associated to the song + are removed prior to the deletion of the song. + + ``song_id`` + The ID of the song to delete. + + ``song_plugin`` + The song plugin instance. + """ + media_files = song_plugin.manager.get_all_objects(MediaFile, MediaFile.song_id == song_id) + for media_file in media_files: + try: + os.remove(media_file.file_name) + except: + log.exception('Could not remove file: %s', media_file.file_name) + try: + save_path = os.path.join(AppLocation.get_section_data_path(song_plugin.name), 'audio', str(song_id)) + if os.path.exists(save_path): + os.rmdir(save_path) + except OSError: + log.exception(u'Could not remove directory: %s', save_path) + song_plugin.manager.delete_object(Song, song_id) + diff --git a/openlp/plugins/songs/lib/mediaitem.py b/openlp/plugins/songs/lib/mediaitem.py index e8e6901ea..7c50eb6b8 100644 --- a/openlp/plugins/songs/lib/mediaitem.py +++ b/openlp/plugins/songs/lib/mediaitem.py @@ -43,7 +43,7 @@ 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 +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.ui import SongStrings from openlp.plugins.songs.lib.xml import OpenLyrics, SongXML @@ -72,10 +72,7 @@ class SongMediaItem(MediaManagerItem): def __init__(self, parent, plugin): self.icon_path = u'songs/song' MediaManagerItem.__init__(self, parent, plugin) - self.edit_song_form = EditSongForm(self, self.main_window, self.plugin.manager) - self.openLyrics = OpenLyrics(self.plugin.manager) self.single_service_item = False - self.song_maintenance_form = SongMaintenanceForm(self.plugin.manager, self) # Holds information about whether the edit is remotely triggered and which Song is required. self.remote_song = -1 self.edit_item = None @@ -132,6 +129,12 @@ class SongMediaItem(MediaManagerItem): 'Maintain the lists of authors, topics and books.')) def initialise(self): + """ + Initialise variables when they cannot be initialised in the constructor. + """ + self.song_maintenance_form = SongMaintenanceForm(self.plugin.manager, self) + self.edit_song_form = EditSongForm(self, self.main_window, self.plugin.manager) + self.openLyrics = OpenLyrics(self.plugin.manager) self.search_text_edit.set_search_types([ (SongSearch.Entire, u':/songs/song_search_all.png', translate('SongsPlugin.MediaItem', 'Entire Song'), @@ -157,7 +160,6 @@ class SongMediaItem(MediaManagerItem): Settings().setValue(u'%s/last search type' % self.settings_section, self.search_text_edit.current_search_type()) # Reload the list considering the new search type. search_keywords = unicode(self.search_text_edit.displayText()) - search_results = [] search_type = self.search_text_edit.current_search_type() if search_type == SongSearch.Entire: log.debug(u'Entire Song Search') @@ -366,19 +368,7 @@ class SongMediaItem(MediaManagerItem): self.main_window.display_progress_bar(len(items)) for item in items: item_id = item.data(QtCore.Qt.UserRole) - media_files = self.plugin.manager.get_all_objects(MediaFile, MediaFile.song_id == item_id) - for media_file in media_files: - try: - os.remove(media_file.file_name) - except: - log.exception('Could not remove file: %s', media_file.file_name) - try: - save_path = os.path.join(AppLocation.get_section_data_path(self.plugin.name), 'audio', str(item_id)) - if os.path.exists(save_path): - os.rmdir(save_path) - except OSError: - log.exception(u'Could not remove directory: %s', save_path) - self.plugin.manager.delete_object(Song, item_id) + delete_song(item_id, self.plugin) self.main_window.increment_progress_bar() self.main_window.finished_progress_bar() self.application.set_normal_cursor() @@ -457,14 +447,7 @@ class SongMediaItem(MediaManagerItem): for slide in verses: service_item.add_from_text(unicode(slide)) service_item.title = song.title - author_list = [unicode(author.display_name) for author in song.authors] - service_item.raw_footer.append(song.title) - service_item.raw_footer.append(create_separated_list(author_list)) - service_item.raw_footer.append(song.copyright) - if Settings().value(u'core/ccli number'): - service_item.raw_footer.append(translate('SongsPlugin.MediaItem', 'CCLI License: ') + - Settings().value(u'core/ccli number')) - service_item.audit = [song.title, author_list, song.copyright, unicode(song.ccli_number)] + author_list = self.generate_footer(service_item, song) service_item.data_string = {u'title': song.search_title, u'authors': u', '.join(author_list)} service_item.xml_version = self.openLyrics.song_to_xml(song) # Add the audio file to the service item. @@ -473,6 +456,30 @@ class SongMediaItem(MediaManagerItem): service_item.background_audio = [m.file_name for m in song.media_files] return True + 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. + + ``item`` + The service item to be amended + + ``song`` + The song to be used to generate the footer + """ + author_list = [unicode(author.display_name) for author in song.authors] + item.audit = [ + song.title, author_list, song.copyright, unicode(song.ccli_number) + ] + item.raw_footer = [] + item.raw_footer.append(song.title) + item.raw_footer.append(create_separated_list(author_list)) + item.raw_footer.append(song.copyright) + if Settings().value(u'core/ccli number'): + item.raw_footer.append(translate('SongsPlugin.MediaItem', 'CCLI License: ') + + Settings().value(u'core/ccli number')) + return author_list + def service_load(self, item): """ Triggered by a song being loaded by the service manager. @@ -490,9 +497,8 @@ class SongMediaItem(MediaManagerItem): else: search_results = self.plugin.manager.get_all_objects(Song, Song.search_title == item.data_string[u'title'], Song.search_title.asc()) - editId = 0 + edit_id = 0 add_song = True - temporary = False if search_results: for song in search_results: author_list = item.data_string[u'authors'] @@ -505,7 +511,7 @@ class SongMediaItem(MediaManagerItem): break if same_authors and author_list.strip(u', ') == u'': add_song = False - editId = song.id + edit_id = song.id break # If there's any backing tracks, copy them over. if item.background_audio: @@ -523,11 +529,11 @@ class SongMediaItem(MediaManagerItem): # If there's any backing tracks, copy them over. if item.background_audio: self._update_background_audio(song, item) - editId = song.id - temporary = True - # Update service with correct song id. - if editId: - self.service_manager.service_item_update(editId, item.unique_identifier, temporary) + edit_id = song.id + # Update service with correct song id and return it to caller. + item.edit_id = edit_id + self.generate_footer(item, song) + return item def search(self, string, showError): """ diff --git a/openlp/plugins/songs/lib/songcompare.py b/openlp/plugins/songs/lib/songcompare.py new file mode 100644 index 000000000..f69c5c827 --- /dev/null +++ b/openlp/plugins/songs/lib/songcompare.py @@ -0,0 +1,139 @@ +# -*- 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:`songcompare` module provides functionality to search for +duplicate songs. It has one single :function:`songs_probably_equal`. + +The algorithm is based on the diff algorithm. +First a diffset is calculated for two songs. +To compensate for typos all differences that are smaller than a +limit (min_fragment_size) are removed and the surrounding equal parts are merged. +Finally two conditions can qualify a song tuple to be a duplicate: +1. There is a block of equal content that is at least min_block_size large. + This condition should hit for all larger songs that have a long enough + equal part. Even if only one verse is equal this condition should still hit. +2. Two thirds of the smaller song is contained in the larger song. + This condition should hit if one of the two songs (or both) is small (smaller + than the min_block_size), but most of the song is contained in the other song. +""" +from __future__ import division +import difflib + + +MIN_FRAGMENT_SIZE = 5 +MIN_BLOCK_SIZE = 70 +MAX_TYPO_SIZE = 3 + + +def songs_probably_equal(song1, song2): + """ + Calculate and return whether two songs are probably equal. + + ``song1`` + The first song to compare. + + ``song2`` + The second song to compare. + """ + if len(song1.search_lyrics) < len(song2.search_lyrics): + small = song1.search_lyrics + large = song2.search_lyrics + else: + small = song2.search_lyrics + large = song1.search_lyrics + differ = difflib.SequenceMatcher(a=large, b=small) + diff_tuples = differ.get_opcodes() + diff_no_typos = _remove_typos(diff_tuples) + # Check 1: Similarity based on the absolute length of equal parts. + # Calculate the total length of all equal blocks of the set. + # Blocks smaller than min_block_size are not counted. + length_of_equal_blocks = 0 + for element in diff_no_typos: + if element[0] == "equal" and _op_length(element) >= MIN_BLOCK_SIZE: + length_of_equal_blocks += _op_length(element) + if length_of_equal_blocks >= MIN_BLOCK_SIZE: + return True + # Check 2: Similarity based on the relative length of the longest equal block. + # Calculate the length of the largest equal block of the diff set. + length_of_longest_equal_block = 0 + for element in diff_no_typos: + if element[0] == "equal" and _op_length(element) > length_of_longest_equal_block: + length_of_longest_equal_block = _op_length(element) + if length_of_equal_blocks >= MIN_BLOCK_SIZE or length_of_longest_equal_block > len(small) * 2 // 3: + return True + # Both checks failed. We assume the songs are not equal. + return False + + +def _op_length(opcode): + """ + Return the length of a given difference. + + ``opcode`` + The difference. + """ + return max(opcode[2] - opcode[1], opcode[4] - opcode[3]) + + +def _remove_typos(diff): + """ + Remove typos from a diff set. A typo is a small difference (min_fragment_size). + + ``diff`` + The diff set to remove the typos from. + """ + # Remove typo at beginning of the string. + if len(diff) >= 2: + if diff[0][0] != "equal" and _op_length(diff[0]) <= MAX_TYPO_SIZE and \ + _op_length(diff[1]) >= MIN_FRAGMENT_SIZE: + del diff[0] + # Remove typos in the middle of the string. + if len(diff) >= 3: + for index in range(len(diff) - 3, -1, -1): + if _op_length(diff[index]) >= MIN_FRAGMENT_SIZE and \ + diff[index + 1][0] != "equal" and _op_length(diff[index + 1]) <= MAX_TYPO_SIZE and \ + _op_length(diff[index + 2]) >= MIN_FRAGMENT_SIZE: + del diff[index + 1] + # Remove typo at the end of the string. + if len(diff) >= 2: + if _op_length(diff[-2]) >= MIN_FRAGMENT_SIZE and \ + diff[-1][0] != "equal" and _op_length(diff[-1]) <= MAX_TYPO_SIZE: + del diff[-1] + + # Merge the bordering equal passages that occured by removing differences. + for index in range(len(diff) - 2, -1, -1): + if diff[index][0] == "equal" and _op_length(diff[index]) >= MIN_FRAGMENT_SIZE and \ + diff[index + 1][0] == "equal" and _op_length(diff[index + 1]) >= MIN_FRAGMENT_SIZE: + diff[index] = ("equal", diff[index][1], diff[index + 1][2], diff[index][3], + diff[index + 1][4]) + del diff[index + 1] + + return diff diff --git a/openlp/plugins/songs/songsplugin.py b/openlp/plugins/songs/songsplugin.py index 65056ee5b..1c895d327 100644 --- a/openlp/plugins/songs/songsplugin.py +++ b/openlp/plugins/songs/songsplugin.py @@ -50,6 +50,8 @@ from openlp.plugins.songs.lib.importer import SongFormat from openlp.plugins.songs.lib.olpimport import OpenLPSongImport from openlp.plugins.songs.lib.mediaitem import SongMediaItem from openlp.plugins.songs.lib.songstab import SongsTab +from openlp.plugins.songs.forms.duplicatesongremovalform import DuplicateSongRemovalForm + log = logging.getLogger(__name__) __default_settings__ = { @@ -97,10 +99,12 @@ class SongsPlugin(Plugin): self.song_import_item.setVisible(True) self.song_export_item.setVisible(True) self.tools_reindex_item.setVisible(True) + self.tools_find_duplicates.setVisible(True) action_list = ActionList.get_instance() action_list.add_action(self.song_import_item, UiStrings().Import) action_list.add_action(self.song_export_item, UiStrings().Export) action_list.add_action(self.tools_reindex_item, UiStrings().Tools) + action_list.add_action(self.tools_find_duplicates, UiStrings().Tools) def add_import_menu_item(self, import_menu): """ @@ -136,7 +140,7 @@ class SongsPlugin(Plugin): def add_tools_menu_item(self, tools_menu): """ - Give the alerts plugin the opportunity to add items to the + Give the Songs plugin the opportunity to add items to the **Tools** menu. ``tools_menu`` @@ -150,6 +154,12 @@ class SongsPlugin(Plugin): statustip=translate('SongsPlugin', 'Re-index the songs database to improve searching and ordering.'), visible=False, triggers=self.on_tools_reindex_item_triggered) tools_menu.addAction(self.tools_reindex_item) + self.tools_find_duplicates = create_action(tools_menu, u'toolsFindDuplicates', + text=translate('SongsPlugin', 'Find &Duplicate Songs'), + statustip=translate('SongsPlugin', + 'Find and remove duplicate songs in the song database.'), + visible=False, triggers=self.on_tools_find_duplicates_triggered, can_shortcuts=True) + tools_menu.addAction(self.tools_find_duplicates) def on_tools_reindex_item_triggered(self): """ @@ -169,6 +179,12 @@ class SongsPlugin(Plugin): self.manager.save_objects(songs) self.media_item.on_search_text_button_clicked() + def on_tools_find_duplicates_triggered(self): + """ + Search for duplicates in the song database. + """ + DuplicateSongRemovalForm(self).exec_() + def on_song_import_item_clicked(self): if self.media_item: self.media_item.on_import_click() @@ -235,8 +251,7 @@ class SongsPlugin(Plugin): u'delete': translate('SongsPlugin', 'Delete the selected song.'), u'preview': translate('SongsPlugin', 'Preview the selected song.'), u'live': translate('SongsPlugin', 'Send the selected song live.'), - u'service': translate('SongsPlugin', - 'Add the selected song to the service.') + u'service': translate('SongsPlugin', 'Add the selected song to the service.') } self.set_plugin_ui_text_strings(tooltips) @@ -288,10 +303,12 @@ class SongsPlugin(Plugin): self.song_import_item.setVisible(False) self.song_export_item.setVisible(False) self.tools_reindex_item.setVisible(False) + self.tools_find_duplicates.setVisible(False) action_list = ActionList.get_instance() action_list.remove_action(self.song_import_item, UiStrings().Import) action_list.remove_action(self.song_export_item, UiStrings().Export) action_list.remove_action(self.tools_reindex_item, UiStrings().Tools) + action_list.remove_action(self.tools_find_duplicates, UiStrings().Tools) Plugin.finalise(self) def new_service_created(self): diff --git a/resources/images/openlp-2.qrc b/resources/images/openlp-2.qrc index 82c763c6f..42af83f79 100644 --- a/resources/images/openlp-2.qrc +++ b/resources/images/openlp-2.qrc @@ -19,6 +19,7 @@ topic_maintenance.png song_author_edit.png song_book_edit.png + song_delete.png image_group.png @@ -101,6 +102,7 @@ wizard_importbible.bmp wizard_firsttime.bmp wizard_createtheme.bmp + wizard_duplicateremoval.bmp service_collapse_all.png diff --git a/resources/images/wizard_duplicateremoval.bmp b/resources/images/wizard_duplicateremoval.bmp new file mode 100644 index 000000000..ac937714f Binary files /dev/null and b/resources/images/wizard_duplicateremoval.bmp differ diff --git a/scripts/check_dependencies.py b/scripts/check_dependencies.py index 16a2c10e7..6c1d528ac 100755 --- a/scripts/check_dependencies.py +++ b/scripts/check_dependencies.py @@ -98,9 +98,9 @@ OPTIONAL_MODULES = [ w = sys.stdout.write def check_vers(version, required, text): - if type(version) is not str: + if not isinstance(version, str): version = '.'.join(map(str, version)) - if type(required) is not str: + if not isinstance(required, str): required = '.'.join(map(str, required)) w(' %s >= %s ... ' % (text, required)) if LooseVersion(version) >= LooseVersion(required): diff --git a/setup.py b/setup.py index a96259380..c9a192591 100755 --- a/setup.py +++ b/setup.py @@ -27,12 +27,15 @@ # Temple Place, Suite 330, Boston, MA 02111-1307 USA # ############################################################################### -from setuptools import setup, find_packages import re +from setuptools import setup, find_packages +from subprocess import Popen, PIPE + VERSION_FILE = 'openlp/.version' SPLIT_ALPHA_DIGITS = re.compile(r'(\d+|\D+)') + def try_int(s): """ Convert string s to an integer if possible. Fail silently and return @@ -46,6 +49,7 @@ def try_int(s): except Exception: return s + def natural_sort_key(s): """ Return a tuple by which s is sorted. @@ -55,6 +59,7 @@ def natural_sort_key(s): """ return map(try_int, SPLIT_ALPHA_DIGITS.findall(s)) + def natural_compare(a, b): """ Compare two strings naturally and return the result. @@ -67,6 +72,7 @@ def natural_compare(a, b): """ return cmp(natural_sort_key(a), natural_sort_key(b)) + def natural_sort(seq, compare=natural_compare): """ Returns a copy of seq, sorted by natural string sort. @@ -76,38 +82,50 @@ def natural_sort(seq, compare=natural_compare): temp.sort(compare) return temp +# NOTE: The following code is a duplicate of the code in openlp/core/utils/__init__.py. Any fix applied here should also +# be applied there. try: - # Try to import Bazaar - from bzrlib.branch import Branch - b = Branch.open_containing('.')[0] - b.lock_read() - try: - # Get the branch's latest revision number. - revno = b.revno() - # Convert said revision number into a bzr revision id. - revision_id = b.dotted_revno_to_revision_id((revno,)) - # Get a dict of tags, with the revision id as the key. - tags = b.tags.get_reverse_tag_dict() - # Check if the latest - if revision_id in tags: - version = u'%s' % tags[revision_id][0] - else: - version = '%s-bzr%s' % \ - (natural_sort(b.tags.get_tag_dict().keys())[-1], revno) - ver_file = open(VERSION_FILE, u'w') - ver_file.write(version) - ver_file.close() - finally: - b.unlock() + # Get the revision of this tree. + bzr = Popen((u'bzr', u'revno'), stdout=PIPE) + tree_revision, error = bzr.communicate() + code = bzr.wait() + if code != 0: + raise Exception(u'Error running bzr log') + + # Get all tags. + bzr = Popen((u'bzr', u'tags'), stdout=PIPE) + output, error = bzr.communicate() + code = bzr.wait() + if code != 0: + raise Exception(u'Error running bzr tags') + tags = output.splitlines() + if not tags: + tag_version = u'0.0.0' + tag_revision = u'0' + else: + # Remove any tag that has "?" as revision number. A "?" as revision number indicates, that this tag is from + # another series. + tags = [tag for tag in tags if tag.split()[-1].strip() != u'?'] + # Get the last tag and split it in a revision and tag name. + 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. + if tree_revision == tag_revision: + version_string = tag_version + else: + version_string = u'%s-bzr%s' % (tag_version, tree_revision) + ver_file = open(VERSION_FILE, u'w') + ver_file.write(version_string) except: ver_file = open(VERSION_FILE, u'r') - version = ver_file.read().strip() + version_string = ver_file.read().strip() +finally: ver_file.close() setup( name='OpenLP', - version=version, + version=version_string, description="Open source Church presentation and lyrics projection application.", long_description="""\ OpenLP (previously openlp.org) is free church presentation software, or lyrics projection software, used to display slides of songs, Bible verses, videos, images, and even presentations (if PowerPoint is installed) for church worship using a computer and a data projector.""", diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/tests/functional/openlp_core_lib/test_lib.py b/tests/functional/openlp_core_lib/test_lib.py index c03a11265..b0d1a4bed 100644 --- a/tests/functional/openlp_core_lib/test_lib.py +++ b/tests/functional/openlp_core_lib/test_lib.py @@ -1,13 +1,20 @@ """ Package to test the openlp.core.lib package. """ +import os + from unittest import TestCase from datetime import datetime, timedelta from mock import MagicMock, patch +from PyQt4 import QtCore, QtGui + +from openlp.core.lib import str_to_bool, create_thumb, translate, check_directory_exists, get_text_file_string, \ + build_icon, image_to_byte, check_item_selected, validate_thumb, create_separated_list, clean_tags, expand_tags + + +TEST_PATH = os.path.abspath(os.path.join(os.path.dirname(__file__), u'..', u'..', u'resources')) -from openlp.core.lib import str_to_bool, translate, check_directory_exists, get_text_file_string, build_icon, \ - image_to_byte, check_item_selected, validate_thumb, create_separated_list, clean_tags, expand_tags class TestLib(TestCase): @@ -125,7 +132,7 @@ class TestLib(TestCase): Test the check_directory_exists() function """ with patch(u'openlp.core.lib.os.path.exists') as mocked_exists, \ - patch(u'openlp.core.lib.os.makedirs') as mocked_makedirs: + patch(u'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 = u'existing/directory' @@ -219,7 +226,7 @@ class TestLib(TestCase): Test the build_icon() function with a resource URI """ with patch(u'openlp.core.lib.QtGui') as MockedQtGui, \ - patch(u'openlp.core.lib.QtGui.QPixmap') as MockedQPixmap: + patch(u'openlp.core.lib.QtGui.QPixmap') as MockedQPixmap: # GIVEN: A mocked QIcon and a mocked QPixmap MockedQtGui.QIcon = MagicMock MockedQtGui.QIcon.Normal = 1 @@ -261,9 +268,43 @@ class TestLib(TestCase): mocked_byte_array.toBase64.assert_called_with() assert result == u'base64mock', u'The result should be the return value of the mocked out base64 method' + def create_thumb_with_size_test(self): + """ + Test the create_thumb() function + """ + # GIVEN: An image to create a thumb of. + image_path = os.path.join(TEST_PATH, u'church.jpg') + thumb_path = os.path.join(TEST_PATH, u'church_thumb.jpg') + thumb_size = QtCore.QSize(10, 20) + + # Remove the thumb so that the test actually tests if the thumb will be created. Maybe it was not deleted in the + # last test. + try: + os.remove(thumb_path) + except: + pass + + # Only continue when the thumb does not exist. + assert not os.path.exists(thumb_path), u'Test was not ran, because the thumb already exists.' + + # WHEN: Create the thumb. + icon = create_thumb(image_path, thumb_path, size=thumb_size) + + # THEN: Check if the thumb was created. + assert os.path.exists(thumb_path), u'Test was not ran, because the thumb already exists.' + assert isinstance(icon, QtGui.QIcon), u'The icon should be a QIcon.' + assert not icon.isNull(), u'The icon should not be null.' + assert QtGui.QImageReader(thumb_path).size() == thumb_size, u'The thumb should have the given size.' + + # Remove the thumb so that the test actually tests if the thumb will be created. + try: + os.remove(thumb_path) + except: + pass + def check_item_selected_true_test(self): """ - Test that the check_item_selected() function returns True when there are selected indexes. + 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(u'openlp.core.lib.QtGui') @@ -423,7 +464,7 @@ class TestLib(TestCase): def create_separated_list_qlocate_test(self): """ - Test the create_separated_list function using the Qt provided method. + Test the create_separated_list function using the Qt provided method """ with patch(u'openlp.core.lib.Qt') as mocked_qt, \ patch(u'openlp.core.lib.QtCore.QLocale.createSeparatedList') as mocked_createSeparatedList: @@ -442,7 +483,7 @@ class TestLib(TestCase): def create_separated_list_empty_list_test(self): """ - Test the create_separated_list function with an empty list. + Test the create_separated_list function with an empty list """ with patch(u'openlp.core.lib.Qt') as mocked_qt: # GIVEN: An empty list and the mocked Qt module. @@ -458,7 +499,7 @@ class TestLib(TestCase): def create_separated_list_with_one_item_test(self): """ - Test the create_separated_list function with a list consisting of only one entry. + Test the create_separated_list function with a list consisting of only one entry """ with patch(u'openlp.core.lib.Qt') as mocked_qt: # GIVEN: A list with a string and the mocked Qt module. @@ -474,7 +515,7 @@ class TestLib(TestCase): def create_separated_list_with_two_items_test(self): """ - Test the create_separated_list function with a list of two entries. + Test the create_separated_list function with a list of two entries """ with patch(u'openlp.core.lib.Qt') as mocked_qt, patch(u'openlp.core.lib.translate') as mocked_translate: # GIVEN: A list of strings and the mocked Qt module. @@ -491,7 +532,7 @@ class TestLib(TestCase): def create_separated_list_with_three_items_test(self): """ - Test the create_separated_list function with a list of three items. + Test the create_separated_list function with a list of three items """ with patch(u'openlp.core.lib.Qt') as mocked_qt, patch(u'openlp.core.lib.translate') as mocked_translate: # GIVEN: A list with a string and the mocked Qt module. diff --git a/tests/functional/openlp_core_lib/test_screen.py b/tests/functional/openlp_core_lib/test_screen.py index 007889a12..7c1bcaf24 100644 --- a/tests/functional/openlp_core_lib/test_screen.py +++ b/tests/functional/openlp_core_lib/test_screen.py @@ -1,7 +1,7 @@ """ Package to test the openlp.core.lib.screenlist package. """ -import copy + from unittest import TestCase from mock import MagicMock diff --git a/tests/functional/openlp_core_lib/test_serviceitem.py b/tests/functional/openlp_core_lib/test_serviceitem.py index 26e9e7d44..4e777b953 100644 --- a/tests/functional/openlp_core_lib/test_serviceitem.py +++ b/tests/functional/openlp_core_lib/test_serviceitem.py @@ -2,11 +2,12 @@ Package to test the openlp.core.lib package. """ import os -import cPickle from unittest import TestCase from mock import MagicMock, patch from openlp.core.lib import ItemCapabilities, ServiceItem, Registry +from tests.utils.osdinteraction import read_service_from_file +from tests.utils.constants import TEST_RESOURCES_PATH VERSE = u'The Lord said to {r}Noah{/r}: \n'\ @@ -18,8 +19,6 @@ VERSE = u'The Lord said to {r}Noah{/r}: \n'\ 'r{/pk}{o}e{/o}{pp}n{/pp} of the Lord\n' FOOTER = [u'Arky Arky (Unknown)', u'Public Domain', u'CCLI 123456'] -TEST_PATH = os.path.abspath(os.path.join(os.path.dirname(__file__), u'..', u'..', u'resources')) - class TestServiceItem(TestCase): @@ -78,7 +77,7 @@ class TestServiceItem(TestCase): service_item.name = u'test' # WHEN: adding image to a service item - test_image = os.path.join(TEST_PATH, u'church.jpg') + test_image = os.path.join(TEST_RESOURCES_PATH, u'church.jpg') service_item.add_from_image(test_image, u'Image Title') # THEN: We should get back a valid service item @@ -133,8 +132,8 @@ class TestServiceItem(TestCase): service_item.name = u'test' # WHEN: adding image to a service item - test_file = os.path.join(TEST_PATH, u'church.jpg') - service_item.add_from_command(TEST_PATH, u'church.jpg', test_file) + test_file = os.path.join(TEST_RESOURCES_PATH, u'church.jpg') + service_item.add_from_command(TEST_RESOURCES_PATH, u'church.jpg', test_file) # THEN: We should get back a valid service item assert service_item.is_valid is True, u'The new service item should be valid' @@ -151,7 +150,7 @@ class TestServiceItem(TestCase): assert len(service) == 2, u'The saved service should have two parts' assert service[u'header'][u'name'] == u'test', u'A test plugin should be returned' assert service[u'data'][0][u'title'] == u'church.jpg', u'The first title name should be "church,jpg"' - assert service[u'data'][0][u'path'] == TEST_PATH, u'The path should match the input path' + assert service[u'data'][0][u'path'] == TEST_RESOURCES_PATH, u'The path should match the input path' assert service[u'data'][0][u'image'] == test_file, u'The image should match the full path to image' # WHEN validating a service item @@ -170,13 +169,12 @@ class TestServiceItem(TestCase): """ Test the Service Item - adding a custom slide from a saved service """ - # GIVEN: A new service item and a mocked add icon function + # GIVEN: A new service item service_item = ServiceItem(None) - service_item.add_icon = MagicMock() # WHEN: adding a custom from a saved Service - line = self.convert_file_service_item(u'serviceitem_custom_1.osd') - service_item.set_from_service(line) + service = read_service_from_file(u'serviceitem_custom_1.osd') + service_item.set_from_service(service[0]) # THEN: We should get back a valid service item assert service_item.is_valid is True, u'The new service item should be valid' @@ -195,22 +193,20 @@ class TestServiceItem(TestCase): """ Test the Service Item - adding an image from a saved service """ - # GIVEN: A new service item and a mocked add icon function + # GIVEN: A new service item image_name = u'image_1.jpg' - test_file = os.path.join(TEST_PATH, image_name) + test_file = os.path.join(TEST_RESOURCES_PATH, image_name) frame_array = {u'path': test_file, u'title': image_name} service_item = ServiceItem(None) - service_item.add_icon = MagicMock() # WHEN: adding an image from a saved Service and mocked exists - line = self.convert_file_service_item(u'serviceitem_image_1.osd') + service = read_service_from_file(u'serviceitem_image_1.osd') with patch('os.path.exists'): - service_item.set_from_service(line, TEST_PATH) + service_item.set_from_service(service[0], TEST_RESOURCES_PATH) # THEN: We should get back a valid service item assert service_item.is_valid is True, u'The new service item should be valid' - print service_item.get_rendered_frame(0) assert service_item.get_rendered_frame(0) == test_file, u'The first frame should match the path to the image' assert service_item.get_frames()[0] == frame_array, u'The return should match frame array1' assert service_item.get_frame_path(0) == test_file, u'The frame path should match the full path to the image' @@ -230,7 +226,7 @@ class TestServiceItem(TestCase): """ Test the Service Item - adding an image from a saved local service """ - # GIVEN: A new service item and a mocked add icon function + # GIVEN: A new service item image_name1 = u'image_1.jpg' image_name2 = u'image_2.jpg' test_file1 = os.path.join(u'/home/openlp', image_name1) @@ -239,12 +235,11 @@ class TestServiceItem(TestCase): frame_array2 = {u'path': test_file2, u'title': image_name2} service_item = ServiceItem(None) - service_item.add_icon = MagicMock() # WHEN: adding an image from a saved Service and mocked exists - line = self.convert_file_service_item(u'serviceitem_image_2.osd') + service = read_service_from_file(u'serviceitem_image_2.osd') with patch('os.path.exists'): - service_item.set_from_service(line) + service_item.set_from_service(service[0]) # THEN: We should get back a valid service item assert service_item.is_valid is True, u'The new service item should be valid' @@ -268,15 +263,22 @@ class TestServiceItem(TestCase): assert service_item.is_capable(ItemCapabilities.CanAppend) is True, \ u'This service item should be able to have new items added to it' - def convert_file_service_item(self, name): - service_file = os.path.join(TEST_PATH, name) - try: - open_file = open(service_file, u'r') - items = cPickle.load(open_file) - first_line = items[0] - except IOError: - first_line = u'' - finally: - open_file.close() - return first_line + def serviceitem_migrate_test_20_22(self): + """ + Test the Service Item - migrating a media only service item from 2.0 to 2.2 format + """ + # GIVEN: A new service item and a mocked add icon function + service_item = ServiceItem(None) + service_item.add_icon = MagicMock() + # WHEN: adding an media from a saved Service and mocked exists + line = self.convert_file_service_item(u'migrate_video_20_22.osd') + with patch('os.path.exists'): + service_item.set_from_service(line, TEST_PATH) + + # THEN: We should get back a converted service item + assert service_item.is_valid is True, u'The new service item should be valid' + assert service_item.processor is None, u'The Processor should have been set' + assert service_item.title is None, u'The title should be set to a value' + assert service_item.is_capable(ItemCapabilities.HasDetailedTitleDisplay) is False, \ + u'The Capability should have been removed' diff --git a/tests/functional/openlp_plugins/images/test_lib.py b/tests/functional/openlp_plugins/images/test_lib.py index 5033f0645..0aecc0a7f 100644 --- a/tests/functional/openlp_plugins/images/test_lib.py +++ b/tests/functional/openlp_plugins/images/test_lib.py @@ -9,7 +9,7 @@ from unittest import TestCase from mock import MagicMock, patch from openlp.core.lib import Registry -from openlp.plugins.images.lib.db import ImageFilenames +from openlp.plugins.images.lib.db import ImageFilenames, ImageGroups from openlp.plugins.images.lib.mediaitem import ImageMediaItem @@ -23,6 +23,7 @@ class TestImageMediaItem(TestCase): Registry.create() Registry().register(u'service_list', MagicMock()) Registry().register(u'main_window', self.mocked_main_window) + Registry().register(u'live_controller', MagicMock()) mocked_parent = MagicMock() mocked_plugin = MagicMock() with patch(u'openlp.plugins.images.lib.mediaitem.ImageMediaItem.__init__') as mocked_init: @@ -35,7 +36,7 @@ class TestImageMediaItem(TestCase): """ # GIVEN: An empty image_list image_list = [] - with patch(u'openlp.plugins.images.lib.mediaitem.ImageMediaItem.load_full_list') as mocked_loadFullList: + with patch(u'openlp.plugins.images.lib.mediaitem.ImageMediaItem.load_full_list') as mocked_load_full_list: self.media_item.manager = MagicMock() # WHEN: We run save_new_images_list with the empty list @@ -51,7 +52,7 @@ class TestImageMediaItem(TestCase): """ # GIVEN: A list with 1 image image_list = [ u'test_image.jpg' ] - with patch(u'openlp.plugins.images.lib.mediaitem.ImageMediaItem.load_full_list') as mocked_loadFullList: + with patch(u'openlp.plugins.images.lib.mediaitem.ImageMediaItem.load_full_list') as mocked_load_full_list: ImageFilenames.filename = '' self.media_item.manager = MagicMock() @@ -59,7 +60,7 @@ class TestImageMediaItem(TestCase): self.media_item.save_new_images_list(image_list, reload_list=True) # THEN: load_full_list() should have been called - assert mocked_loadFullList.call_count == 1, u'load_full_list() should have been called' + assert mocked_load_full_list.call_count == 1, u'load_full_list() should have been called' # CLEANUP: Remove added attribute from ImageFilenames delattr(ImageFilenames, 'filename') @@ -70,14 +71,14 @@ class TestImageMediaItem(TestCase): """ # GIVEN: A list with 1 image image_list = [ u'test_image.jpg' ] - with patch(u'openlp.plugins.images.lib.mediaitem.ImageMediaItem.load_full_list') as mocked_loadFullList: + with patch(u'openlp.plugins.images.lib.mediaitem.ImageMediaItem.load_full_list') as mocked_load_full_list: self.media_item.manager = MagicMock() # WHEN: We run save_new_images_list with reload_list=False self.media_item.save_new_images_list(image_list, reload_list=False) # THEN: load_full_list() should not have been called - assert mocked_loadFullList.call_count == 0, u'load_full_list() should not have been called' + assert mocked_load_full_list.call_count == 0, u'load_full_list() should not have been called' def save_new_images_list_multiple_images_test(self): """ @@ -85,7 +86,7 @@ class TestImageMediaItem(TestCase): """ # GIVEN: A list with 3 images image_list = [ u'test_image_1.jpg', u'test_image_2.jpg', u'test_image_3.jpg' ] - with patch(u'openlp.plugins.images.lib.mediaitem.ImageMediaItem.load_full_list') as mocked_loadFullList: + with patch(u'openlp.plugins.images.lib.mediaitem.ImageMediaItem.load_full_list') as mocked_load_full_list: self.media_item.manager = MagicMock() # WHEN: We run save_new_images_list with the list of 3 images @@ -101,7 +102,7 @@ class TestImageMediaItem(TestCase): """ # GIVEN: A list with images and objects image_list = [ u'test_image_1.jpg', None, True, ImageFilenames(), 'test_image_2.jpg' ] - with patch(u'openlp.plugins.images.lib.mediaitem.ImageMediaItem.load_full_list') as mocked_loadFullList: + with patch(u'openlp.plugins.images.lib.mediaitem.ImageMediaItem.load_full_list') as mocked_load_full_list: self.media_item.manager = MagicMock() # WHEN: We run save_new_images_list with the list of images and objects @@ -110,3 +111,68 @@ class TestImageMediaItem(TestCase): # THEN: load_full_list() should not have been called assert self.media_item.manager.save_object.call_count == 2, \ u'load_full_list() should have been called only once' + + def on_reset_click_test(self): + """ + Test that on_reset_click() actually resets the background + """ + # GIVEN: A mocked version of reset_action + self.media_item.reset_action = MagicMock() + + # WHEN: on_reset_click is called + self.media_item.on_reset_click() + + # THEN: the reset_action should be set visible, and the image should be reset + self.media_item.reset_action.setVisible.assert_called_with(False) + self.media_item.live_controller.display.reset_image.assert_called_with() + + def _recursively_delete_group_side_effect(*args, **kwargs): + """ + Side effect method that creates custom retun values for the recursively_delete_group method + """ + if args[1] == ImageFilenames and args[2]: + # Create some fake objects that should be removed + returned_object1 = ImageFilenames() + returned_object1.id = 1 + returned_object1.filename = u'/tmp/test_file_1.jpg' + returned_object2 = ImageFilenames() + returned_object2.id = 2 + returned_object2.filename = u'/tmp/test_file_2.jpg' + returned_object3 = ImageFilenames() + returned_object3.id = 3 + returned_object3.filename = u'/tmp/test_file_3.jpg' + return [returned_object1, returned_object2, returned_object3] + if args[1] == ImageGroups and args[2]: + # Change the parent_id that is matched so we don't get into an endless loop + ImageGroups.parent_id = 0 + # Create a fake group that will be used in the next run + returned_object1 = ImageGroups() + returned_object1.id = 1 + return [returned_object1] + return [] + + def recursively_delete_group_test(self): + """ + Test that recursively_delete_group() works + """ + # GIVEN: An ImageGroups object and mocked functions + with patch(u'openlp.core.utils.delete_file') as mocked_delete_file: + ImageFilenames.group_id = 1 + ImageGroups.parent_id = 1 + self.media_item.manager = MagicMock() + self.media_item.manager.get_all_objects.side_effect = self._recursively_delete_group_side_effect + self.media_item.servicePath = "" + test_group = ImageGroups() + test_group.id = 1 + + # WHEN: recursively_delete_group() is called + self.media_item.recursively_delete_group(test_group) + + # THEN: + assert mocked_delete_file.call_count == 0, u'delete_file() should not be called' + assert self.media_item.manager.delete_object.call_count == 7, \ + u'manager.delete_object() should be called exactly 7 times' + + # CLEANUP: Remove added attribute from ImageFilenames and ImageGroups + delattr(ImageFilenames, 'group_id') + delattr(ImageGroups, 'parent_id') diff --git a/tests/functional/openlp_plugins/songs/test_lib.py b/tests/functional/openlp_plugins/songs/test_lib.py index 221b54ec2..c5232e348 100644 --- a/tests/functional/openlp_plugins/songs/test_lib.py +++ b/tests/functional/openlp_plugins/songs/test_lib.py @@ -4,15 +4,37 @@ This module contains tests for the lib submodule of the Songs plugin. from unittest import TestCase -from mock import patch +from mock import patch, MagicMock from openlp.plugins.songs.lib import VerseType, clean_string, clean_title +from openlp.plugins.songs.lib.songcompare import songs_probably_equal, _remove_typos, _op_length class TestLib(TestCase): """ Test the functions in the :mod:`lib` module. """ + def setUp(self): + """ + Mock up two songs and provide a set of lyrics for the songs_probably_equal tests. + """ + self.full_lyrics =u'''amazing grace how sweet the sound that saved a wretch like me i once was lost but now am + found was blind but now i see twas grace that taught my heart to fear and grace my fears relieved how + precious did that grace appear the hour i first believed through many dangers toils and snares i have already + come tis grace that brought me safe thus far and grace will lead me home''' + self.short_lyrics =u'''twas grace that taught my heart to fear and grace my fears relieved how precious did that + grace appear the hour i first believed''' + self.error_lyrics =u'''amazing how sweet the trumpet that saved a wrench like me i once was losst but now am + found waf blind but now i see it was grace that taught my heart to fear and grace my fears relieved how + precious did that grace appppppppear the hour i first believedxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx snares i have + already come to this grace that brought me safe so far and grace will lead me home''' + self.different_lyrics=u'''on a hill far away stood an old rugged cross the emblem of suffering and shame and i love + that old cross where the dearest and best for a world of lost sinners was slain so ill cherish the old rugged + cross till my trophies at last i lay down i will cling to the old rugged cross and exchange it some day for a + crown''' + self.song1 = MagicMock() + self.song2 = MagicMock() + def clean_string_test(self): """ Test the clean_string() function @@ -39,6 +61,160 @@ class TestLib(TestCase): # THEN: The string should be cleaned up self.assertEqual(result, u'This is a dirty string', u'The title should be cleaned up properly: "%s"' % result) + def songs_probably_equal_same_song_test(self): + """ + Test the songs_probably_equal function with twice the same song. + """ + # GIVEN: Two equal songs. + self.song1.search_lyrics = self.full_lyrics + self.song2.search_lyrics = self.full_lyrics + + # WHEN: We compare those songs for equality. + result = songs_probably_equal(self.song1, self.song2) + + # THEN: The result should be True. + assert result == True, u'The result should be True' + + def songs_probably_equal_short_song_test(self): + """ + Test the songs_probably_equal function with a song and a shorter version of the same song. + """ + # GIVEN: A song and a short version of the same song. + self.song1.search_lyrics = self.full_lyrics + self.song2.search_lyrics = self.short_lyrics + + # WHEN: We compare those songs for equality. + result = songs_probably_equal(self.song1, self.song2) + + # THEN: The result should be True. + assert result == True, u'The result should be True' + + def songs_probably_equal_error_song_test(self): + """ + Test the songs_probably_equal function with a song and a very erroneous version of the same song. + """ + # GIVEN: A song and the same song with lots of errors. + self.song1.search_lyrics = self.full_lyrics + self.song2.search_lyrics = self.error_lyrics + + # WHEN: We compare those songs for equality. + result = songs_probably_equal(self.song1, self.song2) + + # THEN: The result should be True. + assert result == True, u'The result should be True' + + def songs_probably_equal_different_song_test(self): + """ + Test the songs_probably_equal function with two different songs. + """ + # GIVEN: Two different songs. + self.song1.search_lyrics = self.full_lyrics + self.song2.search_lyrics = self.different_lyrics + + # WHEN: We compare those songs for equality. + result = songs_probably_equal(self.song1, self.song2) + + # THEN: The result should be False. + assert result == False, u'The result should be False' + + def remove_typos_beginning_test(self): + """ + Test the _remove_typos function with a typo at the beginning. + """ + # GIVEN: A diffset with a difference at the beginning. + diff = [('replace', 0, 2, 0, 1), ('equal', 2, 11, 1, 10)] + + # WHEN: We remove the typos in there. + result = _remove_typos(diff) + + # THEN: There should be no typos at the beginning anymore. + assert len(result) == 1, u'The result should contain only one element.' + assert result[0][0] == 'equal', u'The result should contain an equal element.' + + def remove_typos_beginning_negated_test(self): + """ + Test the _remove_typos function with a large difference at the beginning. + """ + # GIVEN: A diffset with a large difference at the beginning. + diff = [('replace', 0, 20, 0, 1), ('equal', 20, 29, 1, 10)] + + # WHEN: We remove the typos in there. + result = _remove_typos(list(diff)) + + # THEN: There diff should not have changed. + assert result == diff + + def remove_typos_end_test(self): + """ + Test the _remove_typos function with a typo at the end. + """ + # GIVEN: A diffset with a difference at the end. + diff = [('equal', 0, 10, 0, 10), ('replace', 10, 12, 10, 11)] + + # WHEN: We remove the typos in there. + result = _remove_typos(diff) + + # THEN: There should be no typos at the end anymore. + assert len(result) == 1, u'The result should contain only one element.' + assert result[0][0] == 'equal', u'The result should contain an equal element.' + + def remove_typos_end_negated_test(self): + """ + Test the _remove_typos function with a large difference at the end. + """ + # GIVEN: A diffset with a large difference at the end. + diff = [('equal', 0, 10, 0, 10), ('replace', 10, 20, 10, 1)] + + # WHEN: We remove the typos in there. + result = _remove_typos(list(diff)) + + # THEN: There diff should not have changed. + assert result == diff + + def remove_typos_middle_test(self): + """ + Test the _remove_typos function with a typo in the middle. + """ + # GIVEN: A diffset with a difference in the middle. + diff = [('equal', 0, 10, 0, 10), ('replace', 10, 12, 10, 11), ('equal', 12, 22, 11, 21)] + + # WHEN: We remove the typos in there. + result = _remove_typos(diff) + + # THEN: There should be no typos in the middle anymore. The remaining equals should have been merged. + assert len(result) is 1, u'The result should contain only one element.' + assert result[0][0] == 'equal', u'The result should contain an equal element.' + assert result[0][1] == 0, u'The start indices should be kept.' + assert result[0][2] == 22, u'The stop indices should be kept.' + assert result[0][3] == 0, u'The start indices should be kept.' + assert result[0][4] == 21, u'The stop indices should be kept.' + + def remove_typos_beginning_negated_test(self): + """ + Test the _remove_typos function with a large difference in the middle. + """ + # GIVEN: A diffset with a large difference in the middle. + diff = [('equal', 0, 10, 0, 10), ('replace', 10, 20, 10, 11), ('equal', 20, 30, 11, 21)] + + # WHEN: We remove the typos in there. + result = _remove_typos(list(diff)) + + # THEN: There diff should not have changed. + assert result == diff + + def op_length_test(self): + """ + Test the _op_length function. + """ + # GIVEN: A diff entry. + diff_entry = ('replace', 0, 2, 4, 14) + + # WHEN: We calculate the length of that diff. + result = _op_length(diff_entry) + + # THEN: The maximum length should be returned. + assert result == 10, u'The length should be 10.' + class TestVerseType(TestCase): """ diff --git a/tests/functional/openlp_plugins/songs/test_mediaitem.py b/tests/functional/openlp_plugins/songs/test_mediaitem.py new file mode 100644 index 000000000..37f1c76e4 --- /dev/null +++ b/tests/functional/openlp_plugins/songs/test_mediaitem.py @@ -0,0 +1,125 @@ +""" +This module contains tests for the lib submodule of the Songs plugin. +""" +import os +from tempfile import mkstemp +from unittest import TestCase + +from mock import patch, MagicMock + +from PyQt4 import QtGui + +from openlp.core.lib import Registry, ServiceItem, Settings + +from openlp.plugins.songs.lib.mediaitem import SongMediaItem + + +class TestMediaItem(TestCase): + """ + Test the functions in the :mod:`lib` module. + """ + def setUp(self): + """ + Set up the components need for all tests. + """ + Registry.create() + Registry().register(u'service_list', MagicMock()) + Registry().register(u'main_window', MagicMock()) + with patch('openlp.core.lib.mediamanageritem.MediaManagerItem.__init__'), \ + patch('openlp.plugins.songs.forms.editsongform.EditSongForm.__init__'): + self.media_item = SongMediaItem(MagicMock(), MagicMock()) + + fd, self.ini_file = mkstemp(u'.ini') + Settings().set_filename(self.ini_file) + self.application = QtGui.QApplication.instance() + + def tearDown(self): + """ + Delete all the C++ objects at the end so that we don't have a segfault + """ + del self.application + # Not all tests use settings! + try: + os.unlink(self.ini_file) + os.unlink(Settings().fileName()) + except Exception: + pass + + def build_song_footer_one_author_test(self): + """ + Test build songs footer with basic song and one author + """ + # GIVEN: A Song and a Service Item + mock_song = MagicMock() + mock_song.title = u'My Song' + mock_author = MagicMock() + mock_author.display_name = u'my author' + mock_song.authors = [] + mock_song.authors.append(mock_author) + mock_song.copyright = u'My copyright' + service_item = ServiceItem(None) + + # WHEN: I generate the Footer with default settings + author_list = self.media_item.generate_footer(service_item, mock_song) + + # THEN: I get the following Array returned + self.assertEqual(service_item.raw_footer, [u'My Song', u'my author', u'My copyright'], + u'The array should be returned correctly with a song, one author and copyright') + self.assertEqual(author_list, [u'my author'], + u'The author list should be returned correctly with one author') + + def build_song_footer_two_authors_test(self): + """ + Test build songs footer with basic song and two authors + """ + # GIVEN: A Song and a Service Item + mock_song = MagicMock() + mock_song.title = u'My Song' + mock_author = MagicMock() + mock_author.display_name = u'my author' + mock_song.authors = [] + mock_song.authors.append(mock_author) + mock_author = MagicMock() + mock_author.display_name = u'another author' + mock_song.authors.append(mock_author) + mock_song.copyright = u'My copyright' + service_item = ServiceItem(None) + + # WHEN: I generate the Footer with default settings + author_list = self.media_item.generate_footer(service_item, mock_song) + + # THEN: I get the following Array returned + self.assertEqual(service_item.raw_footer, [u'My Song', u'my author and another author', u'My copyright'], + u'The array should be returned correctly with a song, two authors and copyright') + self.assertEqual(author_list, [u'my author', u'another author'], + u'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 + """ + # GIVEN: A Song and a Service Item and a configured CCLI license + mock_song = MagicMock() + mock_song.title = u'My Song' + mock_author = MagicMock() + mock_author.display_name = u'my author' + mock_song.authors = [] + mock_song.authors.append(mock_author) + mock_song.copyright = u'My copyright' + service_item = ServiceItem(None) + Settings().setValue(u'core/ccli number', u'1234') + + # WHEN: I generate the Footer with default settings + self.media_item.generate_footer(service_item, mock_song) + + # THEN: I get the following Array returned + self.assertEqual(service_item.raw_footer, [u'My Song', u'my author', u'My copyright', u'CCLI License: 1234'], + u'The array should be returned correctly with a song, an author, copyright and ccli') + + # WHEN: I amend the CCLI value + Settings().setValue(u'core/ccli number', u'4321') + self.media_item.generate_footer(service_item, mock_song) + + # THEN: I would get an amended footer string + self.assertEqual(service_item.raw_footer, [u'My Song', u'my author', u'My copyright', u'CCLI License: 4321'], + u'The array should be returned correctly with a song, an author, copyright and amended ccli') diff --git a/tests/interfaces/openlp_core_ui/test_listpreviewwidget.py b/tests/interfaces/openlp_core_ui/test_listpreviewwidget.py new file mode 100644 index 000000000..8a25c0b4f --- /dev/null +++ b/tests/interfaces/openlp_core_ui/test_listpreviewwidget.py @@ -0,0 +1,88 @@ +""" + Package to test the openlp.core.ui.listpreviewwidget. +""" + +from unittest import TestCase +from mock import MagicMock, patch + +from PyQt4 import QtGui + +from openlp.core.lib import Registry, ServiceItem +from openlp.core.ui import listpreviewwidget +from tests.utils.osdinteraction import read_service_from_file + +class TestListPreviewWidget(TestCase): + + def setUp(self): + """ + Create the UI. + """ + Registry.create() + self.app = QtGui.QApplication([]) + self.main_window = QtGui.QMainWindow() + self.image = QtGui.QImage(1, 1, QtGui.QImage.Format_RGB32) + self.image_manager = MagicMock() + self.image_manager.get_image.return_value = self.image + Registry().register(u'image_manager', self.image_manager) + self.preview_widget = listpreviewwidget.ListPreviewWidget(self.main_window, 2) + + def tearDown(self): + """ + Delete all the C++ objects at the end so that we don't have a segfault. + """ + del self.preview_widget + del self.main_window + del self.app + + def initial_slide_count_test(self): + """ + Test the inital slide count. + """ + # GIVEN: A new ListPreviewWidget instance. + # WHEN: No SlideItem has been added yet. + # THEN: The count of items should be zero. + self.assertEqual(self.preview_widget.slide_count(), 0, + u'The slide list should be empty.') + + def initial_slide_number_test(self): + """ + Test the inital slide number. + """ + # GIVEN: A new ListPreviewWidget instance. + # WHEN: No SlideItem has been added yet. + # THEN: The number of the current item should be -1. + self.assertEqual(self.preview_widget.current_slide_number(), -1, + u'The slide number should be -1.') + + def replace_service_item_test(self): + """ + Test item counts and current number with a service item. + """ + # GIVEN: A ServiceItem with two frames. + service_item = ServiceItem(None) + service = read_service_from_file(u'serviceitem_image_2.osd') + with patch('os.path.exists'): + service_item.set_from_service(service[0]) + # WHEN: Added to the preview widget. + self.preview_widget.replace_service_item(service_item, 1, 1) + # THEN: The slide count and number should fit. + self.assertEqual(self.preview_widget.slide_count(), 2, + u'The slide count should be 2.') + self.assertEqual(self.preview_widget.current_slide_number(), 1, + u'The current slide number should be 1.') + + def change_slide_test(self): + """ + Test the change_slide method. + """ + # GIVEN: A ServiceItem with two frames content. + service_item = ServiceItem(None) + service = read_service_from_file(u'serviceitem_image_2.osd') + with patch('os.path.exists'): + service_item.set_from_service(service[0]) + # WHEN: Added to the preview widget and switched to the second frame. + self.preview_widget.replace_service_item(service_item, 1, 0) + self.preview_widget.change_slide(1) + # THEN: The current_slide_number should reflect the change. + self.assertEqual(self.preview_widget.current_slide_number(), 1, + u'The current slide number should be 1.') diff --git a/tests/interfaces/openlp_plugins/bibles/__init__.py b/tests/interfaces/openlp_plugins/bibles/__init__.py new file mode 100644 index 000000000..f87606f07 --- /dev/null +++ b/tests/interfaces/openlp_plugins/bibles/__init__.py @@ -0,0 +1 @@ +__author__ = 'tim' diff --git a/tests/interfaces/openlp_plugins/bibles/test_lib_http.py b/tests/interfaces/openlp_plugins/bibles/test_lib_http.py new file mode 100644 index 000000000..c19f267ed --- /dev/null +++ b/tests/interfaces/openlp_plugins/bibles/test_lib_http.py @@ -0,0 +1,73 @@ +""" + Package to test the openlp.plugin.bible.lib.https package. +""" + +from unittest import TestCase +from mock import MagicMock + +from openlp.core.lib import Registry +from openlp.plugins.bibles.lib.http import BGExtract, CWExtract + + +class TestBibleHTTP(TestCase): + + def setUp(self): + """ + Set up the Registry + """ + Registry.create() + Registry().register(u'service_list', MagicMock()) + Registry().register(u'application', MagicMock()) + + def bible_gateway_extract_books_test(self): + """ + Test the Bible Gateway retrieval of book list for NIV bible + """ + # GIVEN: A new Bible Gateway extraction class + handler = BGExtract() + + # WHEN: The Books list is called + books = handler.get_books_from_http(u'NIV') + + # THEN: We should get back a valid service item + assert len(books) == 66, u'The bible should not have had any books added or removed' + + def bible_gateway_extract_verse_test(self): + """ + Test the Bible Gateway retrieval of verse list for NIV bible John 3 + """ + # GIVEN: A new Bible Gateway extraction class + handler = BGExtract() + + # WHEN: The Books list is called + results = handler.get_bible_chapter(u'NIV', u'John', 3) + + # THEN: We should get back a valid service item + assert len(results.verselist) == 36, u'The book of John should not have had any verses added or removed' + + def crosswalk_extract_books_test(self): + """ + Test Crosswalk retrieval of book list for NIV bible + """ + # GIVEN: A new Bible Gateway extraction class + handler = CWExtract() + + # WHEN: The Books list is called + books = handler.get_books_from_http(u'niv') + + # THEN: We should get back a valid service item + assert len(books) == 66, u'The bible should not have had any books added or removed' + + def crosswalk_extract_verse_test(self): + """ + Test Crosswalk retrieval of verse list for NIV bible John 3 + """ + # GIVEN: A new Bible Gateway extraction class + handler = CWExtract() + + # WHEN: The Books list is called + results = handler.get_bible_chapter(u'niv', u'john', 3) + + # THEN: We should get back a valid service item + assert len(results.verselist) == 36, u'The book of John should not have had any verses added or removed' + diff --git a/tests/resources/migrate_video_20_22.osd b/tests/resources/migrate_video_20_22.osd new file mode 100644 index 000000000..ee4b2c0c4 --- /dev/null +++ b/tests/resources/migrate_video_20_22.osd @@ -0,0 +1,98 @@ +(lp1 +(dp2 +Vserviceitem +p3 +(dp4 +Vheader +p5 +(dp6 +Vxml_version +p7 +NsVauto_play_slides_loop +p8 +I00 +sVauto_play_slides_once +p9 +I00 +sVwill_auto_start +p10 +I01 +sVtitle +p11 +VVLC +p12 +sVcapabilities +p13 +(lp14 +I12 +aI16 +aI4 +aI11 +asVtheme +p15 +I-1 +sVbackground_audio +p16 +(lp17 +sVicon +p18 +V:/plugins/plugin_media.png +p19 +sVtype +p20 +I3 +sVstart_time +p21 +I0 +sVfrom_plugin +p22 +I00 +sVmedia_length +p23 +I144 +sVdata +p24 +V +sVtimed_slide_interval +p25 +I0 +sVaudit +p26 +V +sVsearch +p27 +V +sVname +p28 +Vmedia +p29 +sVfooter +p30 +(lp31 +sVnotes +p32 +V +sVplugin +p33 +g29 +sVtheme_overwritten +p34 +I00 +sVend_time +p35 +I0 +ssg24 +(lp36 +(dp37 +Vpath +p38 +V/home/tim/Videos/puppets +p39 +sVimage +p40 +V:/media/slidecontroller_multimedia.png +p41 +sg11 +VMVI_3405.MOV +p42 +sassa. \ No newline at end of file diff --git a/tests/utils/__init__.py b/tests/utils/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/tests/utils/constants.py b/tests/utils/constants.py new file mode 100644 index 000000000..4b28fcc83 --- /dev/null +++ b/tests/utils/constants.py @@ -0,0 +1,5 @@ + +import os + +OPENLP_PATH = os.path.abspath(os.path.join(os.path.dirname(__file__), u'..', u'..')) +TEST_RESOURCES_PATH = os.path.join(OPENLP_PATH, u'tests', u'resources') diff --git a/tests/utils/osdinteraction.py b/tests/utils/osdinteraction.py new file mode 100644 index 000000000..f275d18c2 --- /dev/null +++ b/tests/utils/osdinteraction.py @@ -0,0 +1,49 @@ +# -*- 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:`osdinteraction` provides miscellaneous functions for interacting with +OSD files. +""" + +import os +import cPickle + +from tests.utils.constants import TEST_RESOURCES_PATH + + +def read_service_from_file(file_name): + """ + Reads an OSD file and returns the first service item found therein. + @param file_name: File name of an OSD file residing in the tests/resources folder. + @return: The service contained in the file. + """ + service_file = os.path.join(TEST_RESOURCES_PATH, file_name) + with open(service_file, u'r') as open_file: + service = cPickle.load(open_file) + return service