From 40de8647cf36dab6c14c8201777cc3a9df44d9b7 Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Thu, 28 Feb 2013 21:47:59 +0100 Subject: [PATCH 01/97] renamed general settings to core Fixes: https://launchpad.net/bugs/1133237 --- openlp/core/__init__.py | 10 +-- openlp/core/lib/screen.py | 12 +-- openlp/core/lib/settings.py | 73 +++++++++++++------ openlp/core/ui/firsttimeform.py | 6 +- openlp/core/ui/generaltab.py | 2 +- openlp/core/ui/maindisplay.py | 8 +- openlp/core/ui/mainwindow.py | 2 +- openlp/core/ui/media/mediacontroller.py | 2 +- openlp/core/utils/languagemanager.py | 4 +- openlp/plugins/songs/lib/mediaitem.py | 4 +- .../openlp_core_lib/test_settings.py | 6 +- 11 files changed, 78 insertions(+), 51 deletions(-) diff --git a/openlp/core/__init__.py b/openlp/core/__init__.py index 3ad0e1348..176fa059a 100644 --- a/openlp/core/__init__.py +++ b/openlp/core/__init__.py @@ -113,10 +113,10 @@ class OpenLP(QtGui.QApplication): # Decide how many screens we have and their size screens = ScreenList.create(self.desktop()) # First time checks in settings - has_run_wizard = Settings().value(u'general/has run wizard') + has_run_wizard = Settings().value(u'core/has run wizard') if not has_run_wizard: if FirstTimeForm(screens).exec_() == QtGui.QDialog.Accepted: - Settings().setValue(u'general/has run wizard', True) + Settings().setValue(u'core/has run wizard', True) # Correct stylesheet bugs application_stylesheet = u'' if not Settings().value(u'advanced/alternate rows'): @@ -128,7 +128,7 @@ class OpenLP(QtGui.QApplication): application_stylesheet += nt_repair_stylesheet if application_stylesheet: self.setStyleSheet(application_stylesheet) - show_splash = Settings().value(u'general/show splash') + show_splash = Settings().value(u'core/show splash') if show_splash: self.splash = SplashScreen() self.splash.show() @@ -147,7 +147,7 @@ class OpenLP(QtGui.QApplication): self.processEvents() if not has_run_wizard: self.main_window.first_time() - update_check = Settings().value(u'general/update check') + update_check = Settings().value(u'core/update check') if update_check: VersionThread(self.main_window).start() self.main_window.is_display_blank() @@ -309,7 +309,7 @@ def main(args=None): if application.is_already_running(): sys.exit() # First time checks in settings - if not Settings().value(u'general/has run wizard'): + if not Settings().value(u'core/has run wizard'): if not FirstTimeLanguageForm().exec_(): # if cancel then stop processing sys.exit() diff --git a/openlp/core/lib/screen.py b/openlp/core/lib/screen.py index 913ad539c..149f07ce1 100644 --- a/openlp/core/lib/screen.py +++ b/openlp/core/lib/screen.py @@ -247,15 +247,15 @@ class ScreenList(object): # Add the screen settings to the settings dict. This has to be done here due to cyclic dependency. # Do not do this anywhere else. screen_settings = { - u'general/x position': self.current[u'size'].x(), - u'general/y position': self.current[u'size'].y(), - u'general/monitor': self.display_count - 1, - u'general/height': self.current[u'size'].height(), - u'general/width': self.current[u'size'].width() + u'core/x position': self.current[u'size'].x(), + u'core/y position': self.current[u'size'].y(), + u'core/monitor': self.display_count - 1, + u'core/height': self.current[u'size'].height(), + u'core/width': self.current[u'size'].width() } Settings.extend_default_settings(screen_settings) settings = Settings() - settings.beginGroup(u'general') + settings.beginGroup(u'core') monitor = settings.value(u'monitor') self.set_current_display(monitor) self.display = settings.value(u'display on monitor') diff --git a/openlp/core/lib/settings.py b/openlp/core/lib/settings.py index be869ade6..e067242dc 100644 --- a/openlp/core/lib/settings.py +++ b/openlp/core/lib/settings.py @@ -116,30 +116,30 @@ class Settings(QtCore.QSettings): u'advanced/x11 bypass wm': X11_BYPASS_DEFAULT, u'crashreport/last directory': u'', u'displayTags/html_tags': u'', - u'general/audio repeat list': False, - u'general/auto open': False, - u'general/auto preview': False, - u'general/audio start paused': True, - u'general/auto unblank': False, - u'general/blank warning': False, - u'general/ccli number': u'', - u'general/has run wizard': False, - u'general/language': u'[en]', + u'core/audio repeat list': False, + u'core/auto open': False, + u'core/auto preview': False, + u'core/audio start paused': True, + u'core/auto unblank': False, + u'core/blank warning': False, + u'core/ccli number': u'', + u'core/has run wizard': False, + u'core/language': u'[en]', # This defaults to yesterday in order to force the update check to run when you've never run it before. - u'general/last version test': datetime.datetime.now().date() - datetime.timedelta(days=1), - u'general/loop delay': 5, - u'general/recent files': [], - u'general/save prompt': False, - u'general/screen blank': False, - u'general/show splash': True, - u'general/songselect password': u'', - u'general/songselect username': u'', - u'general/update check': True, - u'general/view mode': u'default', + u'core/last version test': datetime.datetime.now().date() - datetime.timedelta(days=1), + u'core/loop delay': 5, + u'core/recent files': [], + u'core/save prompt': False, + u'core/screen blank': False, + u'core/show splash': True, + u'core/songselect password': u'', + u'core/songselect username': u'', + u'core/update check': True, + u'core/view mode': u'default', # The other display settings (display position and dimensions) are defined in the ScreenList class due to a # circular dependency. - u'general/display on monitor': True, - u'general/override position': False, + u'core/display on monitor': True, + u'core/override position': False, u'images/background color': u'#000000', u'media/players': u'webkit', u'media/override player': QtCore.Qt.Unchecked, @@ -304,7 +304,7 @@ class Settings(QtCore.QSettings): # Changed during 1.9.x development. (u'bibles/bookname language', u'bibles/book name language', []), (u'general/enable slide loop', u'advanced/slide limits', [(SlideLimits.Wrap, True), (SlideLimits.End, False)]), - (u'songs/ccli number', u'general/ccli number', []), + (u'songs/ccli number', u'core/ccli number', []), # Changed during 2.1.x development. (u'advanced/stylesheet fix', u'', []), (u'bibles/last directory 1', u'bibles/last directory import', []), @@ -314,7 +314,34 @@ class Settings(QtCore.QSettings): (u'songs/last directory 1', u'songs/last directory import', []), (u'songusage/last directory 1', u'songusage/last directory export', []), (u'user interface/mainwindow splitter geometry', u'user interface/main window splitter geometry', []), - (u'shortcuts/makeLive', u'shortcuts/make_live', []) + (u'shortcuts/makeLive', u'shortcuts/make_live', []), + (u'general/audio repeat list', u'core/audio repeat list', []), + (u'general/auto open', u'core/auto open', []), + (u'general/auto preview', u'core/auto preview', []), + (u'general/audio start paused', u'core/audio start paused', []), + (u'general/auto unblank', u'core/auto unblank', []), + (u'general/blank warning', u'core/blank warning', []), + (u'general/ccli number', u'core/ccli number', []), + (u'general/has run wizard', u'core/has run wizard', []), + (u'general/language', u'core/language', []), + (u'general/last version test', u'core/last version test', []), + (u'general/loop delay', u'core/loop delay', []), + (u'general/recent files', u'core/recent files', []), + (u'general/save prompt', u'core/save prompt', []), + (u'general/screen blank', u'core/screen blank', []), + (u'general/show splash', u'core/show splash', []), + (u'general/songselect password', u'core/songselect password', []), + (u'general/songselect username', u'core/songselect username', []), + (u'general/update check', u'core/update check', []), + (u'general/view mode', u'core/view mode', []), + (u'general/display on monitor', u'core/display on monitor', []), + (u'general/override position', u'core/override position', []), + (u'general/x position', u'core/x position', []), + (u'general/y position', u'core/y position', []), + (u'general/monitor', u'core/monitor', []), + (u'general/height', u'core/height', []), + (u'general/monitor', u'core/monitor', []), + (u'general/width', u'core/width', []) ] @staticmethod diff --git a/openlp/core/ui/firsttimeform.py b/openlp/core/ui/firsttimeform.py index 188bc3c02..0d749176b 100644 --- a/openlp/core/ui/firsttimeform.py +++ b/openlp/core/ui/firsttimeform.py @@ -120,7 +120,7 @@ class FirstTimeForm(QtGui.QWizard, Ui_FirstTimeWizard): check_directory_exists(os.path.join(unicode(gettempdir(), get_filesystem_encoding()), u'openlp')) self.noInternetFinishButton.setVisible(False) # Check if this is a re-run of the wizard. - self.hasRunWizard = Settings().value(u'general/has run wizard') + self.hasRunWizard = Settings().value(u'core/has run wizard') # Sort out internet access for downloads if self.web_access: songs = self.config.get(u'songs', u'languages') @@ -254,7 +254,7 @@ class FirstTimeForm(QtGui.QWizard, Ui_FirstTimeWizard): self.application.set_busy_cursor() self._performWizard() self.application.set_normal_cursor() - Settings().setValue(u'general/has run wizard', True) + Settings().setValue(u'core/has run wizard', True) self.close() def urlGetFile(self, url, fpath): @@ -461,7 +461,7 @@ class FirstTimeForm(QtGui.QWizard, Ui_FirstTimeWizard): self.urlGetFile(u'%s%s' % (self.web, theme), os.path.join(themes_destination, theme)) # Set Default Display if self.displayComboBox.currentIndex() != -1: - Settings().setValue(u'General/monitor', self.displayComboBox.currentIndex()) + Settings().setValue(u'core/monitor', self.displayComboBox.currentIndex()) self.screens.set_current_display(self.displayComboBox.currentIndex()) # Set Global Theme if self.themeComboBox.currentIndex() != -1: diff --git a/openlp/core/ui/generaltab.py b/openlp/core/ui/generaltab.py index a20206f9b..af99c3271 100644 --- a/openlp/core/ui/generaltab.py +++ b/openlp/core/ui/generaltab.py @@ -49,7 +49,7 @@ class GeneralTab(SettingsTab): self.screens = ScreenList() self.iconPath = u':/icon/openlp-logo-16x16.png' generalTranslated = translate('OpenLP.GeneralTab', 'General') - SettingsTab.__init__(self, parent, u'General', generalTranslated) + SettingsTab.__init__(self, parent, u'Core', generalTranslated) def setupUi(self): """ diff --git a/openlp/core/ui/maindisplay.py b/openlp/core/ui/maindisplay.py index 58d832101..41413b503 100644 --- a/openlp/core/ui/maindisplay.py +++ b/openlp/core/ui/maindisplay.py @@ -367,7 +367,7 @@ class MainDisplay(Display): # Single screen active if self.screens.display_count == 1: # Only make visible if setting enabled. - if Settings().value(u'general/display on monitor'): + if Settings().value(u'core/display on monitor'): self.setVisible(True) else: self.setVisible(True) @@ -416,7 +416,7 @@ class MainDisplay(Display): self.footer(serviceItem.foot_text) # if was hidden keep it hidden if self.hideMode and self.isLive and not serviceItem.is_media(): - if Settings().value(u'general/auto unblank'): + if Settings().value(u'core/auto unblank'): Registry().execute(u'slidecontroller_live_unblank') else: self.hide_display(self.hideMode) @@ -438,7 +438,7 @@ class MainDisplay(Display): log.debug(u'hide_display mode = %d', mode) if self.screens.display_count == 1: # Only make visible if setting enabled. - if not Settings().value(u'general/display on monitor'): + if not Settings().value(u'core/display on monitor'): return if mode == HideMode.Screen: self.frame.evaluateJavaScript(u'show_blank("desktop");') @@ -462,7 +462,7 @@ class MainDisplay(Display): log.debug(u'show_display') if self.screens.display_count == 1: # Only make visible if setting enabled. - if not Settings().value(u'general/display on monitor'): + if not Settings().value(u'core/display on monitor'): return self.frame.evaluateJavaScript('show_blank("show");') if self.isHidden(): diff --git a/openlp/core/ui/mainwindow.py b/openlp/core/ui/mainwindow.py index 14186cf78..0d77da403 100644 --- a/openlp/core/ui/mainwindow.py +++ b/openlp/core/ui/mainwindow.py @@ -469,7 +469,7 @@ class MainWindow(QtGui.QMainWindow, Ui_MainWindow): self.arguments = self.application.args # Set up settings sections for the main application (not for use by plugins). self.uiSettingsSection = u'user interface' - self.generalSettingsSection = u'general' + self.generalSettingsSection = u'core' self.advancedSettingsSection = u'advanced' self.shortcutsSettingsSection = u'shortcuts' self.serviceManagerSettingsSection = u'servicemanager' diff --git a/openlp/core/ui/media/mediacontroller.py b/openlp/core/ui/media/mediacontroller.py index 048fb5f4d..60c09ca21 100644 --- a/openlp/core/ui/media/mediacontroller.py +++ b/openlp/core/ui/media/mediacontroller.py @@ -417,7 +417,7 @@ class MediaController(object): elif not hidden or controller.media_info.is_background or serviceItem.will_auto_start: autoplay = True # Unblank on load set - elif Settings().value(u'general/auto unblank'): + elif Settings().value(u'core/auto unblank'): autoplay = True if autoplay: if not self.media_play(controller): diff --git a/openlp/core/utils/languagemanager.py b/openlp/core/utils/languagemanager.py index 00a0d0079..6dc18c1ad 100644 --- a/openlp/core/utils/languagemanager.py +++ b/openlp/core/utils/languagemanager.py @@ -98,7 +98,7 @@ class LanguageManager(object): """ Retrieve a saved language to use from settings """ - language = Settings().value(u'general/language') + language = Settings().value(u'core/language') language = str(language) log.info(u'Language file: \'%s\' Loaded from conf file' % language) if re.match(r'[[].*[]]', language): @@ -128,7 +128,7 @@ class LanguageManager(object): language = unicode(qm_list[action_name]) if LanguageManager.auto_language: language = u'[%s]' % language - Settings().setValue(u'general/language', language) + Settings().setValue(u'core/language', language) log.info(u'Language file: \'%s\' written to conf file' % language) if message: QtGui.QMessageBox.information(None, diff --git a/openlp/plugins/songs/lib/mediaitem.py b/openlp/plugins/songs/lib/mediaitem.py index da706bdcb..e3860aeda 100644 --- a/openlp/plugins/songs/lib/mediaitem.py +++ b/openlp/plugins/songs/lib/mediaitem.py @@ -457,9 +457,9 @@ class SongMediaItem(MediaManagerItem): 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'general/ccli number'): + if Settings().value(u'core/ccli number'): service_item.raw_footer.append(translate('SongsPlugin.MediaItem', 'CCLI License: ') + - Settings().value(u'general/ccli number')) + Settings().value(u'core/ccli number')) service_item.audit = [ song.title, author_list, song.copyright, unicode(song.ccli_number) ] diff --git a/tests/functional/openlp_core_lib/test_settings.py b/tests/functional/openlp_core_lib/test_settings.py index 827bfa156..2cd15a16f 100644 --- a/tests/functional/openlp_core_lib/test_settings.py +++ b/tests/functional/openlp_core_lib/test_settings.py @@ -35,16 +35,16 @@ class TestSettings(TestCase): # GIVEN: A new Settings setup # WHEN reading a setting for the first time - default_value = Settings().value(u'general/has run wizard') + default_value = Settings().value(u'core/has run wizard') # THEN the default value is returned assert default_value is False, u'The default value should be False' # WHEN a new value is saved into config - Settings().setValue(u'general/has run wizard', True) + Settings().setValue(u'core/has run wizard', True) # THEN the new value is returned when re-read - assert Settings().value(u'general/has run wizard') is True, u'The saved value should have been returned' + assert Settings().value(u'core/has run wizard') is True, u'The saved value should have been returned' def settings_override_test(self): """ From f1aadde13cd30ecf89afb8d8bd07ad9f4e0b5210 Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Wed, 6 Mar 2013 21:53:29 +0000 Subject: [PATCH 02/97] Initial Cherrypy implementation --- openlp/core/ui/exceptionform.py | 6 + openlp/core/ui/slidecontroller.py | 7 +- openlp/core/utils/__init__.py | 7 +- openlp/plugins/remotes/html/stage.js | 6 +- openlp/plugins/remotes/lib/httpauth.py | 192 ++++++++++++++++ openlp/plugins/remotes/lib/httpserver.py | 281 +++++++++++------------ openlp/plugins/remotes/lib/remotetab.py | 271 ++++++++++++++-------- openlp/plugins/remotes/remoteplugin.py | 5 + scripts/check_dependencies.py | 1 + 9 files changed, 534 insertions(+), 242 deletions(-) create mode 100644 openlp/plugins/remotes/lib/httpauth.py diff --git a/openlp/core/ui/exceptionform.py b/openlp/core/ui/exceptionform.py index 50885b15b..c10f98d9b 100644 --- a/openlp/core/ui/exceptionform.py +++ b/openlp/core/ui/exceptionform.py @@ -69,6 +69,11 @@ try: MAKO_VERSION = mako.__version__ except ImportError: MAKO_VERSION = u'-' +try: + import cherrypy + CHERRYPY_VERSION = cherrypy.__version__ +except ImportError: + CHERRYPY_VERSION = u'-' try: import uno arg = uno.createUnoStruct(u'com.sun.star.beans.PropertyValue') @@ -138,6 +143,7 @@ class ExceptionForm(QtGui.QDialog, Ui_ExceptionDialog): u'PyEnchant: %s\n' % ENCHANT_VERSION + \ u'PySQLite: %s\n' % SQLITE_VERSION + \ u'Mako: %s\n' % MAKO_VERSION + \ + u'CherryPy: %s\n' % CHERRYPY_VERSION + \ u'pyUNO bridge: %s\n' % UNO_VERSION if platform.system() == u'Linux': if os.environ.get(u'KDE_FULL_SESSION') == u'true': diff --git a/openlp/core/ui/slidecontroller.py b/openlp/core/ui/slidecontroller.py index 84ea296d2..3a2c0b582 100644 --- a/openlp/core/ui/slidecontroller.py +++ b/openlp/core/ui/slidecontroller.py @@ -362,8 +362,9 @@ class SlideController(DisplayController): # Signals QtCore.QObject.connect(self.previewListWidget, QtCore.SIGNAL(u'clicked(QModelIndex)'), self.onSlideSelected) if self.isLive: + # 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) Registry().register_function(u'slidecontroller_live_spin_delay', self.receive_spin_delay) - Registry().register_function(u'slidecontroller_toggle_display', self.toggle_display) self.toolbar.setWidgetVisible(self.loopList, False) self.toolbar.setWidgetVisible(self.wideMenu, False) else: @@ -867,9 +868,9 @@ class SlideController(DisplayController): """ Go to the requested slide """ - index = int(message[0]) - if not self.serviceItem: + if not self.serviceItem or not message[0]: return + index = int(message[0]) if self.serviceItem.is_command(): Registry().execute(u'%s_slide' % self.serviceItem.name.lower(), [self.serviceItem, self.isLive, index]) self.updatePreview() diff --git a/openlp/core/utils/__init__.py b/openlp/core/utils/__init__.py index 104567039..dd611d303 100644 --- a/openlp/core/utils/__init__.py +++ b/openlp/core/utils/__init__.py @@ -90,6 +90,7 @@ class AppLocation(object): VersionDir = 5 CacheDir = 6 LanguageDir = 7 + SharedData = 8 # Base path where data/config/cache dir is located BaseDir = None @@ -150,18 +151,18 @@ def _get_os_dir_path(dir_type): if sys.platform == u'win32': if dir_type == AppLocation.DataDir: return os.path.join(unicode(os.getenv(u'APPDATA'), encoding), u'openlp', u'data') - elif dir_type == AppLocation.LanguageDir: + elif dir_type == AppLocation.LanguageDir or dir_type == AppLocation.SharedData: return os.path.split(openlp.__file__)[0] return os.path.join(unicode(os.getenv(u'APPDATA'), encoding), u'openlp') elif sys.platform == u'darwin': if dir_type == AppLocation.DataDir: return os.path.join(unicode(os.getenv(u'HOME'), encoding), u'Library', u'Application Support', u'openlp', u'Data') - elif dir_type == AppLocation.LanguageDir: + elif dir_type == AppLocation.LanguageDir or dir_type == AppLocation.SharedData: return os.path.split(openlp.__file__)[0] return os.path.join(unicode(os.getenv(u'HOME'), encoding), u'Library', u'Application Support', u'openlp') else: - if dir_type == AppLocation.LanguageDir: + if dir_type == AppLocation.LanguageDir or dir_type == AppLocation.SharedData: prefixes = [u'/usr/local', u'/usr'] for prefix in prefixes: directory = os.path.join(prefix, u'share', u'openlp') diff --git a/openlp/plugins/remotes/html/stage.js b/openlp/plugins/remotes/html/stage.js index dcc2e4b70..dff51537c 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( - "/api/service/list", + "/stage/api/service/list", function (data, status) { OpenLP.nextSong = ""; $("#notes").html(""); @@ -46,7 +46,7 @@ window.OpenLP = { }, loadSlides: function (event) { $.getJSON( - "/api/controller/live/text", + "/stage/api/controller/live/text", function (data, status) { OpenLP.currentSlides = data.results.slides; OpenLP.currentSlide = 0; @@ -137,7 +137,7 @@ window.OpenLP = { }, pollServer: function () { $.getJSON( - "/api/poll", + "/stage/api/poll", function (data, status) { OpenLP.updateClock(data); if (OpenLP.currentItem != data.results.item || diff --git a/openlp/plugins/remotes/lib/httpauth.py b/openlp/plugins/remotes/lib/httpauth.py new file mode 100644 index 000000000..ce3ea091e --- /dev/null +++ b/openlp/plugins/remotes/lib/httpauth.py @@ -0,0 +1,192 @@ +# -*- 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:`http` module manages the HTTP authorisation logic. This code originates from +http://tools.cherrypy.org/wiki/AuthenticationAndAccessRestrictions + +""" + +import cherrypy +import urlparse + +SESSION_KEY = '_cp_openlp' + + +def check_credentials(user_name, password): + """ + Verifies credentials for username and password. + Returns None on success or a string describing the error on failure + """ + # @todo make from config + if user_name == 'openlp' and password == 'openlp': + return None + else: + return u"Incorrect username or password." + # if u.password != md5.new(password).hexdigest(): + # return u"Incorrect password" + + +def check_auth(*args, **kwargs): + """ + A tool that looks in config for 'auth.require'. If found and it + is not None, a login is required and the entry is evaluated as a list of + conditions that the user must fulfill + """ + print "check" + conditions = cherrypy.request.config.get('auth.require', None) + print conditions + print args, kwargs + print urlparse.urlparse(cherrypy.url()) + url = urlparse.urlparse(cherrypy.url()) + print urlparse.parse_qs(url.query) + if conditions is not None: + username = cherrypy.session.get(SESSION_KEY) + if username: + cherrypy.request.login = username + for condition in conditions: + # A condition is just a callable that returns true or false + if not condition(): + raise cherrypy.HTTPRedirect("/auth/login") + else: + raise cherrypy.HTTPRedirect("/auth/login") + +cherrypy.tools.auth = cherrypy.Tool('before_handler', check_auth) + + +def require_auth(*conditions): + """ + A decorator that appends conditions to the auth.require config variable. + """ + print conditions + def decorate(f): + if not hasattr(f, '_cp_config'): + f._cp_config = dict() + if 'auth.require' not in f._cp_config: + f._cp_config['auth.require'] = [] + f._cp_config['auth.require'].extend(conditions) + print "a ", [f] + return f + return decorate + + +# Conditions are callables that return True +# if the user fulfills the conditions they define, False otherwise +# +# They can access the current username as cherrypy.request.login +# +# Define those at will however suits the application. + +#def member_of(groupname): +# def check(): +# # replace with actual check if is in +# return cherrypy.request.login == 'joe' and groupname == 'admin' +# return check + + +#def name_is(reqd_username): +# return lambda: reqd_username == cherrypy.request.login + +#def any_of(*conditions): +# """ +# Returns True if any of the conditions match +# """ +# def check(): +# for c in conditions: +# if c(): +# return True +# return False +# return check + +# By default all conditions are required, but this might still be +# needed if you want to use it inside of an any_of(...) condition +#def all_of(*conditions): +# """ +# Returns True if all of the conditions match +# """ +# def check(): +# for c in conditions: +# if not c(): +# return False +# return True +# return check +# Controller to provide login and logout actions + + +class AuthController(object): + + def on_login(self, username): + """ + Called on successful login + """ + + def on_logout(self, username): + """ + Called on logout + """ + + def get_loginform(self, username, msg="Enter login information", from_page="/"): + """ + Provides a login form + """ + return """ +
+ + %(msg)s
+ Username:
+ Password:
+ + """ % locals() + + @cherrypy.expose + def login(self, username=None, password=None, from_page="/"): + """ + Provides the actual login control + """ + if username is None or password is None: + return self.get_loginform("", from_page=from_page) + + error_msg = check_credentials(username, password) + if error_msg: + return self.get_loginform(username, error_msg, from_page) + else: + cherrypy.session[SESSION_KEY] = cherrypy.request.login = username + self.on_login(username) + raise cherrypy.HTTPRedirect(from_page or "/") + + @cherrypy.expose + def logout(self, from_page="/"): + sess = cherrypy.session + username = sess.get(SESSION_KEY, None) + sess[SESSION_KEY] = None + if username: + cherrypy.request.login = None + self.on_logout(username) + raise cherrypy.HTTPRedirect(from_page or "/") + diff --git a/openlp/plugins/remotes/lib/httpserver.py b/openlp/plugins/remotes/lib/httpserver.py index 3b2c7439a..f4dd633e8 100644 --- a/openlp/plugins/remotes/lib/httpserver.py +++ b/openlp/plugins/remotes/lib/httpserver.py @@ -119,40 +119,23 @@ import os import re import urllib import urlparse +import cherrypy -from PyQt4 import QtCore, QtNetwork from mako.template import Template +from PyQt4 import QtCore from openlp.core.lib import Registry, Settings, PluginStatus, StringContent - from openlp.core.utils import AppLocation, translate +from openlp.plugins.remotes.lib.httpauth import AuthController, require_auth log = logging.getLogger(__name__) -class HttpResponse(object): - """ - A simple object to encapsulate a pseudo-http response. - """ - code = '200 OK' - content = '' - headers = { - 'Content-Type': 'text/html; charset="utf-8"\r\n' - } - - def __init__(self, content='', headers=None, code=None): - if headers is None: - headers = {} - self.content = content - for key, value in headers.iteritems(): - self.headers[key] = value - if code: - self.code = code - class HttpServer(object): """ Ability to control OpenLP via a web browser. """ + def __init__(self, plugin): """ Initialise the httpserver, and start the server. @@ -163,22 +146,28 @@ class HttpServer(object): self.connections = [] self.current_item = None self.current_slide = None - self.start_tcp() + self.conf = {'/files': {u'tools.staticdir.on': True, + u'tools.staticdir.dir': self.html_dir}} + self.start_server() - def start_tcp(self): + def start_server(self): """ Start the http server, use the port in the settings default to 4316. Listen out for slide and song changes so they can be broadcast to clients. Listen out for socket connections. """ - log.debug(u'Start TCP server') + log.debug(u'Start CherryPy server') port = Settings().value(self.plugin.settingsSection + u'/port') address = Settings().value(self.plugin.settingsSection + u'/ip address') - self.server = QtNetwork.QTcpServer() - self.server.listen(QtNetwork.QHostAddress(address), port) + server_config = {u'server.socket_host': str(address), + u'server.socket_port': port} + cherrypy.config.update(server_config) + cherrypy.config.update({'environment': 'embedded'}) + cherrypy.config.update({'engine.autoreload_on': False}) + cherrypy.tree.mount(HttpConnection(self), '/', config=self.conf) + cherrypy.engine.start() Registry().register_function(u'slidecontroller_live_changed', self.slide_change) Registry().register_function(u'slidecontroller_live_started', self.item_change) - QtCore.QObject.connect(self.server, QtCore.SIGNAL(u'newConnection()'), self.new_connection) log.debug(u'TCP listening on port %d' % port) def slide_change(self, row): @@ -193,50 +182,41 @@ class HttpServer(object): """ self.current_item = items[0] - def new_connection(self): - """ - A new http connection has been made. Create a client object to handle - communication. - """ - log.debug(u'new http connection') - socket = self.server.nextPendingConnection() - if socket: - self.connections.append(HttpConnection(self, socket)) - - def close_connection(self, connection): - """ - The connection has been closed. Clean up - """ - log.debug(u'close http connection') - if connection in self.connections: - self.connections.remove(connection) - def close(self): """ Close down the http server. """ log.debug(u'close http server') - self.server.close() + cherrypy.engine.exit() + cherrypy.engine.stop() class HttpConnection(object): """ - A single connection, this handles communication between the server - and the client. + A single connection, this handles communication between the server and the client. """ - def __init__(self, parent, socket): + _cp_config = { + 'tools.sessions.on': True, + 'tools.auth.on': True + } + + auth = AuthController() + + def __init__(self, parent): """ Initialise the http connection. Listen out for socket signals. """ - log.debug(u'Initialise HttpConnection: %s' % socket.peerAddress()) - self.socket = socket + #log.debug(u'Initialise HttpConnection: %s' % socket.peerAddress()) + #self.socket = socket self.parent = parent self.routes = [ (u'^/$', self.serve_file), (u'^/(stage)$', self.serve_file), (r'^/files/(.*)$', self.serve_file), (r'^/api/poll$', self.poll), + (r'^/stage/api/poll$', self.poll), (r'^/api/controller/(live|preview)/(.*)$', self.controller), + (r'^/stage/api/controller/live/(.*)$', self.controller), (r'^/api/service/(.*)$', self.service), (r'^/api/display/(hide|show|blank|theme|desktop)$', self.display), (r'^/api/alert$', self.alert), @@ -245,17 +225,79 @@ class HttpConnection(object): (r'^/api/(.*)/live$', self.go_live), (r'^/api/(.*)/add$', self.add_to_service) ] - QtCore.QObject.connect(self.socket, QtCore.SIGNAL(u'readyRead()'), self.ready_read) - QtCore.QObject.connect(self.socket, QtCore.SIGNAL(u'disconnected()'), self.disconnected) self.translate() + @cherrypy.expose + #@require_auth(auth) + def default(self, *args, **kwargs): + """ + Handles the requests for the main url. This is secure depending on settings. + """ + # Loop through the routes we set up earlier and execute them + return self._process_http_request(args, kwargs) + + @cherrypy.expose + def stage(self, *args, **kwargs): + """ + Handles the requests for the stage url. This is not secure. + """ + print "Stage" + url = urlparse.urlparse(cherrypy.url()) + self.url_params = urlparse.parse_qs(url.query) + print url + print [self.url_params] + #return self.serve_file(u'stage') + return self._process_http_request(args, kwargs) + + @cherrypy.expose + def files(self, *args, **kwargs): + """ + Handles the requests for the stage url. This is not secure. + """ + print "files" + url = urlparse.urlparse(cherrypy.url()) + self.url_params = urlparse.parse_qs(url.query) + print url + print [self.url_params] + print args + #return self.serve_file(args) + return self._process_http_request(args, kwargs) + + def _process_http_request(self, args, kwargs): + """ + Common function to process HTTP requests where secure or insecure + """ + print "common handler" + url = urlparse.urlparse(cherrypy.url()) + self.url_params = urlparse.parse_qs(url.query) + print url + print [self.url_params] + response = None + for route, func in self.routes: + match = re.match(route, url.path) + if match: + print 'Route "%s" matched "%s"', route, url.path + log.debug('Route "%s" matched "%s"', route, url.path) + args = [] + for param in match.groups(): + args.append(param) + response = func(*args) + break + if response: + return response + else: + return self._http_not_found() + def _get_service_items(self): + """ + Read the service item in use and return the data as a json object + """ service_items = [] if self.parent.current_item: current_unique_identifier = self.parent.current_item.unique_identifier else: current_unique_identifier = None - for item in self.service_manager.serviceItems: + for item in self.service_manager.service_items: service_item = item[u'service_item'] service_items.append({ u'id': unicode(service_item.unique_identifier), @@ -296,40 +338,6 @@ class HttpConnection(object): 'slides': translate('RemotePlugin.Mobile', 'Slides') } - def ready_read(self): - """ - Data has been sent from the client. Respond to it - """ - log.debug(u'ready to read socket') - if self.socket.canReadLine(): - data = str(self.socket.readLine()) - try: - log.debug(u'received: ' + data) - except UnicodeDecodeError: - # Malicious request containing non-ASCII characters. - self.close() - return - words = data.split(' ') - response = None - if words[0] == u'GET': - url = urlparse.urlparse(words[1]) - self.url_params = urlparse.parse_qs(url.query) - # Loop through the routes we set up earlier and execute them - for route, func in self.routes: - match = re.match(route, url.path) - if match: - log.debug('Route "%s" matched "%s"', route, url.path) - args = [] - for param in match.groups(): - args.append(param) - response = func(*args) - break - if response: - self.send_response(response) - else: - self.send_response(HttpResponse(code='404 Not Found')) - self.close() - def serve_file(self, filename=None): """ Send a file to the socket. For now, just a subset of file types @@ -339,6 +347,7 @@ class HttpConnection(object): 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' """ + print "serve_file", filename log.debug(u'serve file request %s' % filename) if not filename: filename = u'index.html' @@ -346,7 +355,7 @@ class HttpConnection(object): filename = u'stage.html' path = os.path.normpath(os.path.join(self.parent.html_dir, filename)) if not path.startswith(self.parent.html_dir): - return HttpResponse(code=u'404 Not Found') + return self._http_not_found() ext = os.path.splitext(filename)[1] html = None if ext == u'.html': @@ -375,11 +384,12 @@ class HttpConnection(object): content = file_handle.read() except IOError: log.exception(u'Failed to open %s' % path) - return HttpResponse(code=u'404 Not Found') + return self._http_not_found() finally: if file_handle: file_handle.close() - return HttpResponse(content, {u'Content-Type': mimetype}) + cherrypy.response.headers['Content-Type'] = mimetype + return content def poll(self): """ @@ -389,24 +399,25 @@ class HttpConnection(object): u'service': self.service_manager.service_id, u'slide': self.parent.current_slide or 0, u'item': self.parent.current_item.unique_identifier if self.parent.current_item else u'', - u'twelve':Settings().value(u'remotes/twelve hour'), + u'twelve': Settings().value(u'remotes/twelve hour'), u'blank': self.live_controller.blankScreen.isChecked(), u'theme': self.live_controller.themeScreen.isChecked(), u'display': self.live_controller.desktopScreen.isChecked() } - return HttpResponse(json.dumps({u'results': result}), - {u'Content-Type': u'application/json'}) + cherrypy.response.headers['Content-Type'] = u'application/json' + return json.dumps({u'results': result}) def display(self, action): """ Hide or show the display screen. + This is a cross Thread call and UI is updated so Events need to be used. ``action`` This is the action, either ``hide`` or ``show``. """ - Registry().execute(u'slidecontroller_toggle_display', action) - return HttpResponse(json.dumps({u'results': {u'success': True}}), - {u'Content-Type': u'application/json'}) + self.live_controller.emit(QtCore.SIGNAL(u'slidecontroller_toggle_display'), action) + cherrypy.response.headers['Content-Type'] = u'application/json' + return json.dumps({u'results': {u'success': True}}) def alert(self): """ @@ -417,14 +428,14 @@ class HttpConnection(object): try: text = json.loads(self.url_params[u'data'][0])[u'request'][u'text'] except KeyError, ValueError: - return HttpResponse(code=u'400 Bad Request') + return self._http_bad_request() text = urllib.unquote(text) Registry().execute(u'alerts_text', [text]) success = True else: success = False - return HttpResponse(json.dumps({u'results': {u'success': success}}), - {u'Content-Type': u'application/json'}) + cherrypy.response.headers['Content-Type'] = u'application/json' + return json.dumps({u'results': {u'success': success}}) def controller(self, type, action): """ @@ -465,34 +476,37 @@ class HttpConnection(object): try: data = json.loads(self.url_params[u'data'][0]) except KeyError, ValueError: - return HttpResponse(code=u'400 Bad Request') + return self._http_bad_request() log.info(data) # This slot expects an int within a list. id = data[u'request'][u'id'] Registry().execute(event, [id]) else: - Registry().execute(event) + Registry().execute(event, [0]) json_data = {u'results': {u'success': True}} - return HttpResponse(json.dumps(json_data), - {u'Content-Type': u'application/json'}) + cherrypy.response.headers['Content-Type'] = u'application/json' + return json.dumps(json_data) def service(self, action): + """ + List details of the Service and update the UI + """ event = u'servicemanager_%s' % action if action == u'list': - return HttpResponse(json.dumps({u'results': {u'items': self._get_service_items()}}), - {u'Content-Type': u'application/json'}) + cherrypy.response.headers['Content-Type'] = u'application/json' + return json.dumps({u'results': {u'items': self._get_service_items()}}) else: event += u'_item' if self.url_params and self.url_params.get(u'data'): try: data = json.loads(self.url_params[u'data'][0]) except KeyError, ValueError: - return HttpResponse(code=u'400 Bad Request') + return self._http_bad_request() Registry().execute(event, data[u'request'][u'id']) else: Registry().execute(event) - return HttpResponse(json.dumps({u'results': {u'success': True}}), - {u'Content-Type': u'application/json'}) + cherrypy.response.headers['Content-Type'] = u'application/json' + return json.dumps({u'results': {u'success': True}}) def pluginInfo(self, action): """ @@ -507,9 +521,8 @@ class HttpConnection(object): for plugin in self.plugin_manager.plugins: if plugin.status == PluginStatus.Active and plugin.mediaItem and plugin.mediaItem.hasSearch: searches.append([plugin.name, unicode(plugin.textStrings[StringContent.Name][u'plural'])]) - return HttpResponse( - json.dumps({u'results': {u'items': searches}}), - {u'Content-Type': u'application/json'}) + cherrypy.response.headers['Content-Type'] = u'application/json' + return json.dumps({u'results': {u'items': searches}}) def search(self, type): """ @@ -521,15 +534,15 @@ class HttpConnection(object): try: text = json.loads(self.url_params[u'data'][0])[u'request'][u'text'] except KeyError, ValueError: - return HttpResponse(code=u'400 Bad Request') + return self._http_bad_request() text = urllib.unquote(text) plugin = self.plugin_manager.get_plugin_by_name(type) if plugin.status == PluginStatus.Active and plugin.mediaItem and plugin.mediaItem.hasSearch: results = plugin.mediaItem.search(text, False) else: results = [] - return HttpResponse(json.dumps({u'results': {u'items': results}}), - {u'Content-Type': u'application/json'}) + cherrypy.response.headers['Content-Type'] = u'application/json' + return json.dumps({u'results': {u'items': results}}) def go_live(self, type): """ @@ -538,11 +551,11 @@ class HttpConnection(object): try: id = json.loads(self.url_params[u'data'][0])[u'request'][u'id'] except KeyError, ValueError: - return HttpResponse(code=u'400 Bad Request') + return self._http_bad_request() plugin = self.plugin_manager.get_plugin_by_name(type) if plugin.status == PluginStatus.Active and plugin.mediaItem: plugin.mediaItem.goLive(id, remote=True) - return HttpResponse(code=u'200 OK') + return self._http_success() def add_to_service(self, type): """ @@ -551,38 +564,22 @@ class HttpConnection(object): try: id = json.loads(self.url_params[u'data'][0])[u'request'][u'id'] except KeyError, ValueError: - return HttpResponse(code=u'400 Bad Request') + return self._http_bad_request() plugin = self.plugin_manager.get_plugin_by_name(type) if plugin.status == PluginStatus.Active and plugin.mediaItem: item_id = plugin.mediaItem.createItemFromId(id) plugin.mediaItem.addToService(item_id, remote=True) - return HttpResponse(code=u'200 OK') + self._http_success() - def send_response(self, response): - http = u'HTTP/1.1 %s\r\n' % response.code - for header, value in response.headers.iteritems(): - http += '%s: %s\r\n' % (header, value) - http += '\r\n' - self.socket.write(http) - self.socket.write(response.content) + def _http_success(self): + cherrypy.response.status = 200 - def disconnected(self): - """ - The client has disconnected. Tidy up - """ - log.debug(u'socket disconnected') - self.close() + def _http_bad_request(self): + cherrypy.response.status = 400 - def close(self): - """ - The server has closed the connection. Tidy up - """ - if not self.socket: - return - log.debug(u'close socket') - self.socket.close() - self.socket = None - self.parent.close_connection(self) + def _http_not_found(self): + cherrypy.response.status = 404 + cherrypy.response.body = ["Sorry, an error occured"] def _get_service_manager(self): """ diff --git a/openlp/plugins/remotes/lib/remotetab.py b/openlp/plugins/remotes/lib/remotetab.py index 38b8753ab..7d23f500f 100644 --- a/openlp/plugins/remotes/lib/remotetab.py +++ b/openlp/plugins/remotes/lib/remotetab.py @@ -27,9 +27,12 @@ # Temple Place, Suite 330, Boston, MA 02111-1307 USA # ############################################################################### +import os.path + from PyQt4 import QtCore, QtGui, QtNetwork from openlp.core.lib import Registry, Settings, SettingsTab, translate +from openlp.core.utils import AppLocation ZERO_URL = u'0.0.0.0' @@ -45,117 +48,203 @@ class RemoteTab(SettingsTab): def setupUi(self): self.setObjectName(u'RemoteTab') SettingsTab.setupUi(self) - self.serverSettingsGroupBox = QtGui.QGroupBox(self.leftColumn) - self.serverSettingsGroupBox.setObjectName(u'serverSettingsGroupBox') - self.serverSettingsLayout = QtGui.QFormLayout(self.serverSettingsGroupBox) - self.serverSettingsLayout.setObjectName(u'serverSettingsLayout') - self.addressLabel = QtGui.QLabel(self.serverSettingsGroupBox) - self.addressLabel.setObjectName(u'addressLabel') - self.addressEdit = QtGui.QLineEdit(self.serverSettingsGroupBox) - self.addressEdit.setSizePolicy(QtGui.QSizePolicy.Preferred, QtGui.QSizePolicy.Fixed) - self.addressEdit.setValidator(QtGui.QRegExpValidator(QtCore.QRegExp( - u'\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}'), self)) - self.addressEdit.setObjectName(u'addressEdit') - QtCore.QObject.connect(self.addressEdit, QtCore.SIGNAL(u'textChanged(const QString&)'), self.setUrls) - self.serverSettingsLayout.addRow(self.addressLabel, self.addressEdit) - self.twelveHourCheckBox = QtGui.QCheckBox(self.serverSettingsGroupBox) - self.twelveHourCheckBox.setObjectName(u'twelveHourCheckBox') - self.serverSettingsLayout.addRow(self.twelveHourCheckBox) - self.portLabel = QtGui.QLabel(self.serverSettingsGroupBox) - self.portLabel.setObjectName(u'portLabel') - self.portSpinBox = QtGui.QSpinBox(self.serverSettingsGroupBox) - self.portSpinBox.setMaximum(32767) - self.portSpinBox.setObjectName(u'portSpinBox') - QtCore.QObject.connect(self.portSpinBox, QtCore.SIGNAL(u'valueChanged(int)'), self.setUrls) - self.serverSettingsLayout.addRow(self.portLabel, self.portSpinBox) - self.remoteUrlLabel = QtGui.QLabel(self.serverSettingsGroupBox) - self.remoteUrlLabel.setObjectName(u'remoteUrlLabel') - self.remoteUrl = QtGui.QLabel(self.serverSettingsGroupBox) - self.remoteUrl.setObjectName(u'remoteUrl') - self.remoteUrl.setOpenExternalLinks(True) - self.serverSettingsLayout.addRow(self.remoteUrlLabel, self.remoteUrl) - self.stageUrlLabel = QtGui.QLabel(self.serverSettingsGroupBox) - self.stageUrlLabel.setObjectName(u'stageUrlLabel') - self.stageUrl = QtGui.QLabel(self.serverSettingsGroupBox) - self.stageUrl.setObjectName(u'stageUrl') - self.stageUrl.setOpenExternalLinks(True) - self.serverSettingsLayout.addRow(self.stageUrlLabel, self.stageUrl) - self.leftLayout.addWidget(self.serverSettingsGroupBox) - self.androidAppGroupBox = QtGui.QGroupBox(self.rightColumn) - self.androidAppGroupBox.setObjectName(u'androidAppGroupBox') - self.rightLayout.addWidget(self.androidAppGroupBox) - self.qrLayout = QtGui.QVBoxLayout(self.androidAppGroupBox) - self.qrLayout.setObjectName(u'qrLayout') - self.qrCodeLabel = QtGui.QLabel(self.androidAppGroupBox) - self.qrCodeLabel.setPixmap(QtGui.QPixmap(u':/remotes/android_app_qr.png')) - self.qrCodeLabel.setAlignment(QtCore.Qt.AlignCenter) - self.qrCodeLabel.setObjectName(u'qrCodeLabel') - self.qrLayout.addWidget(self.qrCodeLabel) - self.qrDescriptionLabel = QtGui.QLabel(self.androidAppGroupBox) - self.qrDescriptionLabel.setObjectName(u'qrDescriptionLabel') - self.qrDescriptionLabel.setOpenExternalLinks(True) - self.qrDescriptionLabel.setWordWrap(True) - self.qrLayout.addWidget(self.qrDescriptionLabel) + self.server_settings_group_box = QtGui.QGroupBox(self.leftColumn) + self.server_settings_group_box.setObjectName(u'server_settings_group_box') + self.server_settings_layout = QtGui.QFormLayout(self.server_settings_group_box) + self.server_settings_layout.setObjectName(u'server_settings_layout') + self.address_label = QtGui.QLabel(self.server_settings_group_box) + self.address_label.setObjectName(u'address_label') + self.address_edit = QtGui.QLineEdit(self.server_settings_group_box) + self.address_edit.setSizePolicy(QtGui.QSizePolicy.Preferred, QtGui.QSizePolicy.Fixed) + self.address_edit.setValidator(QtGui.QRegExpValidator(QtCore.QRegExp(u'\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}'), + self)) + self.address_edit.setObjectName(u'address_edit') + self.server_settings_layout.addRow(self.address_label, self.address_edit) + self.twelve_hour_check_box = QtGui.QCheckBox(self.server_settings_group_box) + self.twelve_hour_check_box.setObjectName(u'twelve_hour_check_box') + self.server_settings_layout.addRow(self.twelve_hour_check_box) + self.leftLayout.addWidget(self.server_settings_group_box) + self.http_settings_group_box = QtGui.QGroupBox(self.leftColumn) + self.http_settings_group_box.setObjectName(u'http_settings_group_box') + self.http_setting_layout = QtGui.QFormLayout(self.http_settings_group_box) + self.http_setting_layout.setObjectName(u'http_setting_layout') + self.port_label = QtGui.QLabel(self.http_settings_group_box) + self.port_label.setObjectName(u'port_label') + self.port_spin_box = QtGui.QSpinBox(self.http_settings_group_box) + self.port_spin_box.setMaximum(32767) + self.port_spin_box.setObjectName(u'port_spin_box') + self.http_setting_layout.addRow(self.port_label, self.port_spin_box) + self.remote_url_label = QtGui.QLabel(self.http_settings_group_box) + self.remote_url_label.setObjectName(u'remote_url_label') + self.remote_url = QtGui.QLabel(self.http_settings_group_box) + self.remote_url.setObjectName(u'remote_url') + self.remote_url.setOpenExternalLinks(True) + self.http_setting_layout.addRow(self.remote_url_label, self.remote_url) + self.stage_url_label = QtGui.QLabel(self.http_settings_group_box) + self.stage_url_label.setObjectName(u'stage_url_label') + self.stage_url = QtGui.QLabel(self.http_settings_group_box) + 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.leftLayout.addWidget(self.http_settings_group_box) + self.https_settings_group_box = QtGui.QGroupBox(self.leftColumn) + self.https_settings_group_box.setCheckable(True) + self.https_settings_group_box.setChecked(False) + self.https_settings_group_box.setObjectName(u'https_settings_group_box') + self.https_settings_layout = QtGui.QFormLayout(self.https_settings_group_box) + self.https_settings_layout.setObjectName(u'https_settings_layout') + self.https_error_label = QtGui.QLabel(self.https_settings_group_box) + self.https_error_label.setVisible(False) + self.https_error_label.setWordWrap(True) + self.https_error_label.setObjectName(u'https_error_label') + self.https_settings_layout.addRow(self.https_error_label) + self.https_port_label = QtGui.QLabel(self.https_settings_group_box) + self.https_port_label.setObjectName(u'https_port_label') + self.https_port_spin_box = QtGui.QSpinBox(self.https_settings_group_box) + self.https_port_spin_box.setMaximum(32767) + self.https_port_spin_box.setObjectName(u'https_port_spin_box') + self.https_settings_layout.addRow(self.https_port_label, self.https_port_spin_box) + self.remote_https_url = QtGui.QLabel(self.https_settings_group_box) + self.remote_https_url.setObjectName(u'remote_http_url') + self.remote_https_url.setOpenExternalLinks(True) + self.remote_https_url_label = QtGui.QLabel(self.https_settings_group_box) + self.remote_https_url_label.setObjectName(u'remote_http_url_label') + self.https_settings_layout.addRow(self.remote_https_url_label, self.remote_https_url) + self.stage_https_url_label = QtGui.QLabel(self.http_settings_group_box) + self.stage_https_url_label.setObjectName(u'stage_https_url_label') + self.stage_https_url = QtGui.QLabel(self.https_settings_group_box) + 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.leftLayout.addWidget(self.https_settings_group_box) + self.user_login_group_box = QtGui.QGroupBox(self.leftColumn) + self.user_login_group_box.setCheckable(True) + self.user_login_group_box.setChecked(False) + self.user_login_group_box.setObjectName(u'user_login_group_box') + self.user_login_layout = QtGui.QFormLayout(self.user_login_group_box) + self.user_login_layout.setObjectName(u'user_login_layout') + self.user_id_label = QtGui.QLabel(self.user_login_group_box) + self.user_id_label.setObjectName(u'user_id_label') + self.user_id = QtGui.QLineEdit(self.user_login_group_box) + self.user_id.setObjectName(u'user_id') + self.user_login_layout.addRow(self.user_id_label, self.user_id) + self.password_label = QtGui.QLabel(self.user_login_group_box) + self.password_label.setObjectName(u'password_label') + self.password = QtGui.QLineEdit(self.user_login_group_box) + self.password.setObjectName(u'password') + self.user_login_layout.addRow(self.password_label, self.password) + self.leftLayout.addWidget(self.user_login_group_box) + self.android_app_group_box = QtGui.QGroupBox(self.rightColumn) + self.android_app_group_box.setObjectName(u'android_app_group_box') + self.rightLayout.addWidget(self.android_app_group_box) + self.qr_layout = QtGui.QVBoxLayout(self.android_app_group_box) + self.qr_layout.setObjectName(u'qr_layout') + self.qr_code_label = QtGui.QLabel(self.android_app_group_box) + self.qr_code_label.setPixmap(QtGui.QPixmap(u':/remotes/android_app_qr.png')) + self.qr_code_label.setAlignment(QtCore.Qt.AlignCenter) + self.qr_code_label.setObjectName(u'qr_code_label') + self.qr_layout.addWidget(self.qr_code_label) + self.qr_description_label = QtGui.QLabel(self.android_app_group_box) + self.qr_description_label.setObjectName(u'qr_description_label') + self.qr_description_label.setOpenExternalLinks(True) + self.qr_description_label.setWordWrap(True) + self.qr_layout.addWidget(self.qr_description_label) self.leftLayout.addStretch() self.rightLayout.addStretch() - QtCore.QObject.connect(self.twelveHourCheckBox, QtCore.SIGNAL(u'stateChanged(int)'), - self.onTwelveHourCheckBoxChanged) + self.twelve_hour_check_box.stateChanged.connect(self.on_twelve_hour_check_box_changed) + self.address_edit.textChanged.connect(self.set_urls) + self.port_spin_box.valueChanged.connect(self.set_urls) + self.https_port_spin_box.valueChanged.connect(self.set_urls) def retranslateUi(self): - self.serverSettingsGroupBox.setTitle( - translate('RemotePlugin.RemoteTab', 'Server Settings')) - self.addressLabel.setText(translate('RemotePlugin.RemoteTab', 'Serve on IP address:')) - self.portLabel.setText(translate('RemotePlugin.RemoteTab', 'Port number:')) - self.remoteUrlLabel.setText(translate('RemotePlugin.RemoteTab', 'Remote URL:')) - self.stageUrlLabel.setText(translate('RemotePlugin.RemoteTab', 'Stage view URL:')) - self.twelveHourCheckBox.setText(translate('RemotePlugin.RemoteTab', 'Display stage time in 12h format')) - self.androidAppGroupBox.setTitle(translate('RemotePlugin.RemoteTab', 'Android App')) - self.qrDescriptionLabel.setText(translate('RemotePlugin.RemoteTab', - 'Scan the QR code or click download to install the ' - 'Android app from Google Play.')) + self.server_settings_group_box.setTitle(translate('RemotePlugin.RemoteTab', 'Server Settings')) + self.address_label.setText(translate('RemotePlugin.RemoteTab', 'Serve on IP address:')) + 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.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', + 'Scan the QR code or click download to install the ' + 'Android app from Google Play.')) + self.https_settings_group_box.setTitle(translate('RemotePlugin.RemoteTab', 'HTTPS Server')) + self.https_error_label.setText(translate('RemotePlugin.RemoteTab', + 'Could not find an SSL certificate. The HTTPS server will not be available unless an SSL certificate ' + 'is found. Please see the manual for more information.')) + 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.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:')) - def setUrls(self): + def set_urls(self): ipAddress = u'localhost' - if self.addressEdit.text() == ZERO_URL: - ifaces = QtNetwork.QNetworkInterface.allInterfaces() - for iface in ifaces: - if not iface.isValid(): + if self.address_edit.text() == ZERO_URL: + interfaces = QtNetwork.QNetworkInterface.allInterfaces() + for interface in interfaces: + if not interface.isValid(): continue - if not (iface.flags() & (QtNetwork.QNetworkInterface.IsUp | QtNetwork.QNetworkInterface.IsRunning)): + if not (interface.flags() & (QtNetwork.QNetworkInterface.IsUp | QtNetwork.QNetworkInterface.IsRunning)): continue - for addr in iface.addressEntries(): - ip = addr.ip() + for address in interface.addressEntries(): + ip = address.ip() if ip.protocol() == 0 and ip != QtNetwork.QHostAddress.LocalHost: ipAddress = ip break else: - ipAddress = self.addressEdit.text() - url = u'http://%s:%s/' % (ipAddress, self.portSpinBox.value()) - self.remoteUrl.setText(u'%s' % (url, url)) - url += u'stage' - self.stageUrl.setText(u'%s' % (url, url)) + ipAddress = self.address_edit.text() + http_url = u'http://%s:%s/' % (ipAddress, self.port_spin_box.value()) + https_url = u'https://%s:%s/' % (ipAddress, 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)) def load(self): - self.portSpinBox.setValue(Settings().value(self.settingsSection + u'/port')) - self.addressEdit.setText(Settings().value(self.settingsSection + u'/ip address')) - self.twelveHour = Settings().value(self.settingsSection + u'/twelve hour') - self.twelveHourCheckBox.setChecked(self.twelveHour) - self.setUrls() + self.port_spin_box.setValue(Settings().value(self.settingsSection + u'/port')) + self.https_port_spin_box.setValue(Settings().value(self.settingsSection + u'/https port')) + self.address_edit.setText(Settings().value(self.settingsSection + u'/ip address')) + self.twelve_hour = Settings().value(self.settingsSection + u'/twelve hour') + self.twelve_hour_check_box.setChecked(self.twelve_hour) + shared_data = AppLocation.get_directory(AppLocation.SharedData) + if not os.path.exists(os.path.join(shared_data, u'openlp.crt')) or \ + not os.path.exists(os.path.join(shared_data, u'openlp.key')): + self.https_settings_group_box.setChecked(False) + self.https_settings_group_box.setEnabled(False) + self.https_error_label.setVisible(True) + else: + self.https_settings_group_box.setChecked(Settings().value(self.settingsSection + u'/https enabled')) + self.https_settings_group_box.setEnabled(True) + self.https_error_label.setVisible(False) + self.user_login_group_box.setChecked(Settings().value(self.settingsSection + u'/authentication enabled')) + self.user_id.setText(Settings().value(self.settingsSection + u'/user id')) + self.password.setText(Settings().value(self.settingsSection + u'/password')) + self.set_urls() def save(self): changed = False - if Settings().value(self.settingsSection + u'/ip address') != self.addressEdit.text() or \ - Settings().value(self.settingsSection + u'/port') != self.portSpinBox.value(): + if Settings().value(self.settingsSection + u'/ip address') != self.address_edit.text() or \ + Settings().value(self.settingsSection + u'/port') != self.port_spin_box.value() or \ + Settings().value(self.settingsSection + u'/https port') != self.https_port_spin_box.value() or \ + Settings().value(self.settingsSection + u'/https enabled') != self.https_settings_group_box.isChecked(): changed = True - Settings().setValue(self.settingsSection + u'/port', self.portSpinBox.value()) - Settings().setValue(self.settingsSection + u'/ip address', self.addressEdit.text()) - Settings().setValue(self.settingsSection + u'/twelve hour', self.twelveHour) + Settings().setValue(self.settingsSection + u'/port', self.port_spin_box.value()) + Settings().setValue(self.settingsSection + u'/https port', self.https_port_spin_box.value()) + Settings().setValue(self.settingsSection + u'/https enabled', self.https_settings_group_box.isChecked()) + Settings().setValue(self.settingsSection + u'/ip address', self.address_edit.text()) + Settings().setValue(self.settingsSection + u'/twelve hour', self.twelve_hour) + Settings().setValue(self.settingsSection + u'/authentication enabled', self.user_login_group_box.isChecked()) + Settings().setValue(self.settingsSection + u'/user id', self.user_id.text()) + Settings().setValue(self.settingsSection + u'/password', self.password.text()) if changed: Registry().register_function(u'remotes_config_updated') - def onTwelveHourCheckBoxChanged(self, check_state): - self.twelveHour = False + def on_twelve_hour_check_box_changed(self, check_state): + self.twelve_hour = False # we have a set value convert to True/False if check_state == QtCore.Qt.Checked: - self.twelveHour = True + self.twelve_hour = True diff --git a/openlp/plugins/remotes/remoteplugin.py b/openlp/plugins/remotes/remoteplugin.py index e028dfcbb..7c1541ea6 100644 --- a/openlp/plugins/remotes/remoteplugin.py +++ b/openlp/plugins/remotes/remoteplugin.py @@ -37,6 +37,11 @@ log = logging.getLogger(__name__) __default_settings__ = { u'remotes/twelve hour': True, u'remotes/port': 4316, + u'remotes/https port': 4317, + u'remotes/https enabled': False, + u'remotes/user id': u'openlp', + u'remotes/password': u'password', + u'remotes/authentication enabled': False, u'remotes/ip address': u'0.0.0.0' } diff --git a/scripts/check_dependencies.py b/scripts/check_dependencies.py index 3485b8505..2ff62cf65 100755 --- a/scripts/check_dependencies.py +++ b/scripts/check_dependencies.py @@ -81,6 +81,7 @@ MODULES = [ 'enchant', 'BeautifulSoup', 'mako', + 'cherrypy', 'migrate', 'uno', ] From c62dab074ecaa31790089d809eb76a4530de53b3 Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Fri, 8 Mar 2013 19:15:49 +0000 Subject: [PATCH 03/97] Basic Authentication now working --- openlp/core/ui/slidecontroller.py | 2 +- openlp/plugins/remotes/lib/httpauth.py | 18 ++++++++++------ openlp/plugins/remotes/lib/httpserver.py | 27 +++++++++++------------- 3 files changed, 24 insertions(+), 23 deletions(-) diff --git a/openlp/core/ui/slidecontroller.py b/openlp/core/ui/slidecontroller.py index 98868bbcb..5fdd58aae 100644 --- a/openlp/core/ui/slidecontroller.py +++ b/openlp/core/ui/slidecontroller.py @@ -860,7 +860,7 @@ class SlideController(DisplayController): """ Go to the requested slide """ - if not self.serviceItem or not message[0]: + if not self.service_item or not message[0]: return index = int(message[0]) if not self.service_item: diff --git a/openlp/plugins/remotes/lib/httpauth.py b/openlp/plugins/remotes/lib/httpauth.py index ce3ea091e..6ed42cebd 100644 --- a/openlp/plugins/remotes/lib/httpauth.py +++ b/openlp/plugins/remotes/lib/httpauth.py @@ -45,6 +45,7 @@ def check_credentials(user_name, password): Returns None on success or a string describing the error on failure """ # @todo make from config + print "check_credentials" if user_name == 'openlp' and password == 'openlp': return None else: @@ -59,18 +60,17 @@ def check_auth(*args, **kwargs): is not None, a login is required and the entry is evaluated as a list of conditions that the user must fulfill """ - print "check" + print "check_auth" conditions = cherrypy.request.config.get('auth.require', None) + print urlparse.urlparse(cherrypy.url()), conditions print conditions - print args, kwargs - print urlparse.urlparse(cherrypy.url()) - url = urlparse.urlparse(cherrypy.url()) - print urlparse.parse_qs(url.query) if conditions is not None: username = cherrypy.session.get(SESSION_KEY) + print username if username: cherrypy.request.login = username for condition in conditions: + print "c ", condition # A condition is just a callable that returns true or false if not condition(): raise cherrypy.HTTPRedirect("/auth/login") @@ -84,14 +84,15 @@ def require_auth(*conditions): """ A decorator that appends conditions to the auth.require config variable. """ - print conditions def decorate(f): + """ + Lets process a decoration. + """ if not hasattr(f, '_cp_config'): f._cp_config = dict() if 'auth.require' not in f._cp_config: f._cp_config['auth.require'] = [] f._cp_config['auth.require'].extend(conditions) - print "a ", [f] return f return decorate @@ -182,6 +183,9 @@ class AuthController(object): @cherrypy.expose def logout(self, from_page="/"): + """ + Provides the actual logout functions + """ sess = cherrypy.session username = sess.get(SESSION_KEY, None) sess[SESSION_KEY] = None diff --git a/openlp/plugins/remotes/lib/httpserver.py b/openlp/plugins/remotes/lib/httpserver.py index dc9422932..345c0b1b7 100644 --- a/openlp/plugins/remotes/lib/httpserver.py +++ b/openlp/plugins/remotes/lib/httpserver.py @@ -205,8 +205,6 @@ class HttpConnection(object): """ Initialise the http connection. Listen out for socket signals. """ - #log.debug(u'Initialise HttpConnection: %s' % socket.peerAddress()) - #self.socket = socket self.parent = parent self.routes = [ (u'^/$', self.serve_file), @@ -215,8 +213,9 @@ class HttpConnection(object): (r'^/api/poll$', self.poll), (r'^/stage/api/poll$', self.poll), (r'^/api/controller/(live|preview)/(.*)$', self.controller), - (r'^/stage/api/controller/live/(.*)$', self.controller), + (r'^/stage/api/controller/(live|preview)/(.*)$', self.controller), (r'^/api/service/(.*)$', self.service), + (r'^/stage/api/service/(.*)$', self.service), (r'^/api/display/(hide|show|blank|theme|desktop)$', self.display), (r'^/api/alert$', self.alert), (r'^/api/plugin/(search)$', self.pluginInfo), @@ -227,11 +226,15 @@ class HttpConnection(object): self.translate() @cherrypy.expose - #@require_auth(auth) + @require_auth() def default(self, *args, **kwargs): """ - Handles the requests for the main url. This is secure depending on settings. + Handles the requests for the main url. This is secure depending on settings in config. """ + print "default" + url = urlparse.urlparse(cherrypy.url()) + self.url_params = urlparse.parse_qs(url.query) + print url # Loop through the routes we set up earlier and execute them return self._process_http_request(args, kwargs) @@ -244,22 +247,17 @@ class HttpConnection(object): url = urlparse.urlparse(cherrypy.url()) self.url_params = urlparse.parse_qs(url.query) print url - print [self.url_params] - #return self.serve_file(u'stage') return self._process_http_request(args, kwargs) @cherrypy.expose def files(self, *args, **kwargs): """ - Handles the requests for the stage url. This is not secure. + Handles the requests for the files url. This is not secure. """ print "files" url = urlparse.urlparse(cherrypy.url()) self.url_params = urlparse.parse_qs(url.query) print url - print [self.url_params] - print args - #return self.serve_file(args) return self._process_http_request(args, kwargs) def _process_http_request(self, args, kwargs): @@ -269,13 +267,11 @@ class HttpConnection(object): print "common handler" url = urlparse.urlparse(cherrypy.url()) self.url_params = urlparse.parse_qs(url.query) - print url - print [self.url_params] response = None for route, func in self.routes: match = re.match(route, url.path) if match: - print 'Route "%s" matched "%s"', route, url.path + print 'Route "%s" matched "%s"', route, url.path, func log.debug('Route "%s" matched "%s"', route, url.path) args = [] for param in match.groups(): @@ -346,7 +342,6 @@ class HttpConnection(object): 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' """ - print "serve_file", filename log.debug(u'serve file request %s' % filename) if not filename: filename = u'index.html' @@ -483,6 +478,7 @@ class HttpConnection(object): Registry().execute(event, [0]) json_data = {u'results': {u'success': True}} cherrypy.response.headers['Content-Type'] = u'application/json' + print json.dumps(json_data) return json.dumps(json_data) def service(self, action): @@ -549,6 +545,7 @@ class HttpConnection(object): """ Go live on an item of type ``plugin``. """ + print "go_live" try: id = json.loads(self.url_params[u'data'][0])[u'request'][u'id'] except KeyError, ValueError: From 5c79832bcc8f1448292c7ec5c1bfe5775ea75fd9 Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Mon, 11 Mar 2013 21:00:00 +0000 Subject: [PATCH 04/97] More updates to authentication --- openlp/core/lib/settingstab.py | 1 + openlp/core/ui/slidecontroller.py | 2 - openlp/plugins/remotes/lib/httpauth.py | 90 ++++++++---------------- openlp/plugins/remotes/lib/httpserver.py | 32 ++++----- openlp/plugins/remotes/lib/remotetab.py | 7 +- 5 files changed, 46 insertions(+), 86 deletions(-) diff --git a/openlp/core/lib/settingstab.py b/openlp/core/lib/settingstab.py index 5b8a01fc6..51abfbe03 100644 --- a/openlp/core/lib/settingstab.py +++ b/openlp/core/lib/settingstab.py @@ -36,6 +36,7 @@ from PyQt4 import QtGui from openlp.core.lib import Registry + class SettingsTab(QtGui.QWidget): """ SettingsTab is a helper widget for plugins to define Tabs for the settings diff --git a/openlp/core/ui/slidecontroller.py b/openlp/core/ui/slidecontroller.py index 5fdd58aae..44ae023b6 100644 --- a/openlp/core/ui/slidecontroller.py +++ b/openlp/core/ui/slidecontroller.py @@ -860,8 +860,6 @@ class SlideController(DisplayController): """ Go to the requested slide """ - if not self.service_item or not message[0]: - return index = int(message[0]) if not self.service_item: return diff --git a/openlp/plugins/remotes/lib/httpauth.py b/openlp/plugins/remotes/lib/httpauth.py index 6ed42cebd..7e0e2ebe5 100644 --- a/openlp/plugins/remotes/lib/httpauth.py +++ b/openlp/plugins/remotes/lib/httpauth.py @@ -34,24 +34,24 @@ http://tools.cherrypy.org/wiki/AuthenticationAndAccessRestrictions """ import cherrypy -import urlparse +import logging + +from openlp.core.lib import Settings SESSION_KEY = '_cp_openlp' +log = logging.getLogger(__name__) + def check_credentials(user_name, password): """ Verifies credentials for username and password. Returns None on success or a string describing the error on failure """ - # @todo make from config - print "check_credentials" - if user_name == 'openlp' and password == 'openlp': + if user_name == Settings().value(u'remotes/user id') and password == Settings().value(u'remotes/password'): return None else: return u"Incorrect username or password." - # if u.password != md5.new(password).hexdigest(): - # return u"Incorrect password" def check_auth(*args, **kwargs): @@ -60,17 +60,14 @@ def check_auth(*args, **kwargs): is not None, a login is required and the entry is evaluated as a list of conditions that the user must fulfill """ - print "check_auth" conditions = cherrypy.request.config.get('auth.require', None) - print urlparse.urlparse(cherrypy.url()), conditions - print conditions + if not Settings().value(u'remotes/authentication enabled'): + return None if conditions is not None: username = cherrypy.session.get(SESSION_KEY) - print username if username: cherrypy.request.login = username for condition in conditions: - print "c ", condition # A condition is just a callable that returns true or false if not condition(): raise cherrypy.HTTPRedirect("/auth/login") @@ -97,49 +94,6 @@ def require_auth(*conditions): return decorate -# Conditions are callables that return True -# if the user fulfills the conditions they define, False otherwise -# -# They can access the current username as cherrypy.request.login -# -# Define those at will however suits the application. - -#def member_of(groupname): -# def check(): -# # replace with actual check if is in -# return cherrypy.request.login == 'joe' and groupname == 'admin' -# return check - - -#def name_is(reqd_username): -# return lambda: reqd_username == cherrypy.request.login - -#def any_of(*conditions): -# """ -# Returns True if any of the conditions match -# """ -# def check(): -# for c in conditions: -# if c(): -# return True -# return False -# return check - -# By default all conditions are required, but this might still be -# needed if you want to use it inside of an any_of(...) condition -#def all_of(*conditions): -# """ -# Returns True if all of the conditions match -# """ -# def check(): -# for c in conditions: -# if not c(): -# return False -# return True -# return check -# Controller to provide login and logout actions - - class AuthController(object): def on_login(self, username): @@ -156,14 +110,26 @@ class AuthController(object): """ Provides a login form """ - return """ - - - %(msg)s
- Username:
- Password:
- - """ % locals() + return """ + + + + User Login + + + + + + + + + + + %(msg)s
+ Username:
+ Password:
+ + """ % locals() @cherrypy.expose def login(self, username=None, password=None, from_page="/"): diff --git a/openlp/plugins/remotes/lib/httpserver.py b/openlp/plugins/remotes/lib/httpserver.py index 345c0b1b7..211608858 100644 --- a/openlp/plugins/remotes/lib/httpserver.py +++ b/openlp/plugins/remotes/lib/httpserver.py @@ -130,6 +130,7 @@ from openlp.plugins.remotes.lib.httpauth import AuthController, require_auth log = logging.getLogger(__name__) + class HttpServer(object): """ Ability to control OpenLP via a web browser. @@ -156,10 +157,19 @@ class HttpServer(object): clients. Listen out for socket connections. """ log.debug(u'Start CherryPy server') - port = Settings().value(self.plugin.settingsSection + u'/port') - address = Settings().value(self.plugin.settingsSection + u'/ip address') - server_config = {u'server.socket_host': str(address), - u'server.socket_port': port} + if Settings().value(self.plugin.settingsSection + u'/https enabled'): + port = Settings().value(self.plugin.settingsSection + u'/https port') + address = Settings().value(self.plugin.settingsSection + u'/ip address') + shared_data = AppLocation.get_directory(AppLocation.SharedData) + server_config = {u'server.socket_host': str(address), + u'server.socket_port': port, + u'server.ssl_certificate': os.path.join(shared_data, u'openlp.crt'), + u'server.ssl_private_key': os.path.join(shared_data, u'openlp.key')} + else: + port = Settings().value(self.plugin.settingsSection + u'/port') + address = Settings().value(self.plugin.settingsSection + u'/ip address') + server_config = {u'server.socket_host': str(address), + u'server.socket_port': port} cherrypy.config.update(server_config) cherrypy.config.update({'environment': 'embedded'}) cherrypy.config.update({'engine.autoreload_on': False}) @@ -231,10 +241,8 @@ class HttpConnection(object): """ Handles the requests for the main url. This is secure depending on settings in config. """ - print "default" url = urlparse.urlparse(cherrypy.url()) self.url_params = urlparse.parse_qs(url.query) - print url # Loop through the routes we set up earlier and execute them return self._process_http_request(args, kwargs) @@ -243,10 +251,8 @@ class HttpConnection(object): """ Handles the requests for the stage url. This is not secure. """ - print "Stage" url = urlparse.urlparse(cherrypy.url()) self.url_params = urlparse.parse_qs(url.query) - print url return self._process_http_request(args, kwargs) @cherrypy.expose @@ -254,24 +260,20 @@ class HttpConnection(object): """ Handles the requests for the files url. This is not secure. """ - print "files" url = urlparse.urlparse(cherrypy.url()) self.url_params = urlparse.parse_qs(url.query) - print url return self._process_http_request(args, kwargs) def _process_http_request(self, args, kwargs): """ Common function to process HTTP requests where secure or insecure """ - print "common handler" url = urlparse.urlparse(cherrypy.url()) self.url_params = urlparse.parse_qs(url.query) response = None for route, func in self.routes: match = re.match(route, url.path) if match: - print 'Route "%s" matched "%s"', route, url.path, func log.debug('Route "%s" matched "%s"', route, url.path) args = [] for param in match.groups(): @@ -474,11 +476,8 @@ class HttpConnection(object): # This slot expects an int within a list. id = data[u'request'][u'id'] Registry().execute(event, [id]) - else: - Registry().execute(event, [0]) json_data = {u'results': {u'success': True}} cherrypy.response.headers['Content-Type'] = u'application/json' - print json.dumps(json_data) return json.dumps(json_data) def service(self, action): @@ -545,7 +544,6 @@ class HttpConnection(object): """ Go live on an item of type ``plugin``. """ - print "go_live" try: id = json.loads(self.url_params[u'data'][0])[u'request'][u'id'] except KeyError, ValueError: @@ -577,7 +575,7 @@ class HttpConnection(object): def _http_not_found(self): cherrypy.response.status = 404 - cherrypy.response.body = ["Sorry, an error occured"] + cherrypy.response.body = ["Sorry, an error occurred "] def _get_service_manager(self): """ diff --git a/openlp/plugins/remotes/lib/remotetab.py b/openlp/plugins/remotes/lib/remotetab.py index b5c911257..7d47988fc 100644 --- a/openlp/plugins/remotes/lib/remotetab.py +++ b/openlp/plugins/remotes/lib/remotetab.py @@ -56,15 +56,13 @@ class RemoteTab(SettingsTab): self.address_label.setObjectName(u'address_label') self.address_edit = QtGui.QLineEdit(self.server_settings_group_box) self.address_edit.setSizePolicy(QtGui.QSizePolicy.Preferred, QtGui.QSizePolicy.Fixed) - - self.address_edit.setValidator(QtGui.QRegExpValidator(QtCore.QRegExp(u'\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}'), + self.address_edit.setValidator(QtGui.QRegExpValidator(QtCore.QRegExp(u'\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}'), self)) self.address_edit.setObjectName(u'address_edit') self.server_settings_layout.addRow(self.address_label, self.address_edit) self.twelve_hour_check_box = QtGui.QCheckBox(self.server_settings_group_box) self.twelve_hour_check_box.setObjectName(u'twelve_hour_check_box') self.server_settings_layout.addRow(self.twelve_hour_check_box) - self.leftLayout.addWidget(self.server_settings_group_box) self.http_settings_group_box = QtGui.QGroupBox(self.leftColumn) self.http_settings_group_box.setObjectName(u'http_settings_group_box') @@ -75,7 +73,6 @@ class RemoteTab(SettingsTab): self.port_spin_box = QtGui.QSpinBox(self.http_settings_group_box) self.port_spin_box.setMaximum(32767) self.port_spin_box.setObjectName(u'port_spin_box') - self.http_setting_layout.addRow(self.port_label, self.port_spin_box) self.remote_url_label = QtGui.QLabel(self.http_settings_group_box) self.remote_url_label.setObjectName(u'remote_url_label') @@ -244,7 +241,7 @@ class RemoteTab(SettingsTab): Settings().setValue(self.settingsSection + u'/user id', self.user_id.text()) Settings().setValue(self.settingsSection + u'/password', self.password.text()) if changed: - Registry().register_function(u'remotes_config_updated') + Registry().execute(u'remotes_config_updated') def on_twelve_hour_check_box_changed(self, check_state): From c580aac61be53f0de54667d1daa06b9ebacabd55 Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Wed, 13 Mar 2013 19:09:26 +0000 Subject: [PATCH 05/97] custom login page --- openlp/plugins/remotes/html/login.html | 51 ++++++++++++++++++++++++ openlp/plugins/remotes/html/openlp.css | 8 ++++ openlp/plugins/remotes/lib/httpauth.py | 51 +++++++++++++----------- openlp/plugins/remotes/lib/httpserver.py | 2 + 4 files changed, 88 insertions(+), 24 deletions(-) create mode 100644 openlp/plugins/remotes/html/login.html diff --git a/openlp/plugins/remotes/html/login.html b/openlp/plugins/remotes/html/login.html new file mode 100644 index 000000000..4441958de --- /dev/null +++ b/openlp/plugins/remotes/html/login.html @@ -0,0 +1,51 @@ + + + + + + + + ${title} + + + + + + + + + + +

${message}

+

+ User name:
+ Password:
+ + + \ No newline at end of file diff --git a/openlp/plugins/remotes/html/openlp.css b/openlp/plugins/remotes/html/openlp.css index 4bc1bf907..60a8fe625 100644 --- a/openlp/plugins/remotes/html/openlp.css +++ b/openlp/plugins/remotes/html/openlp.css @@ -36,3 +36,11 @@ .ui-li .ui-btn-text a.ui-link-inherit{ white-space: normal; } + +.ui-page{ + padding: 100px 100px 100px 100px; + width: 300px; +} +.ui-input-text{ + width: 30px; +} \ No newline at end of file diff --git a/openlp/plugins/remotes/lib/httpauth.py b/openlp/plugins/remotes/lib/httpauth.py index 7e0e2ebe5..d46620855 100644 --- a/openlp/plugins/remotes/lib/httpauth.py +++ b/openlp/plugins/remotes/lib/httpauth.py @@ -35,8 +35,12 @@ http://tools.cherrypy.org/wiki/AuthenticationAndAccessRestrictions import cherrypy import logging +import os + +from mako.template import Template from openlp.core.lib import Settings +from openlp.core.utils import AppLocation, translate SESSION_KEY = '_cp_openlp' @@ -48,6 +52,7 @@ def check_credentials(user_name, password): Verifies credentials for username and password. Returns None on success or a string describing the error on failure """ + print "check" if user_name == Settings().value(u'remotes/user id') and password == Settings().value(u'remotes/password'): return None else: @@ -70,9 +75,12 @@ def check_auth(*args, **kwargs): for condition in conditions: # A condition is just a callable that returns true or false if not condition(): + print "r1" raise cherrypy.HTTPRedirect("/auth/login") else: + print "r2" raise cherrypy.HTTPRedirect("/auth/login") + print "r3" cherrypy.tools.auth = cherrypy.Tool('before_handler', check_auth) @@ -100,36 +108,31 @@ class AuthController(object): """ Called on successful login """ + pass def on_logout(self, username): """ Called on logout """ + pass - def get_loginform(self, username, msg="Enter login information", from_page="/"): + def get_login_form(self, username, message=None, from_page="/"): """ Provides a login form """ - return """ - - - - User Login - - - - - - - - -
- - %(msg)s
- Username:
- Password:
- - """ % locals() + if not message: + message = translate('RemotePlugin.Mobile', 'Enter login information') + variables = { + 'title': translate('RemotePlugin.Mobile', 'OpenLP 2.1 User Login'), + 'from_page': from_page, + 'message': message, + 'username': username + } + directory = os.path.join(AppLocation.get_directory(AppLocation.PluginsDir), u'remotes', u'html') + login_html = os.path.normpath(os.path.join(directory, u'login.html')) + html = Template(filename=login_html, input_encoding=u'utf-8', output_encoding=u'utf-8').render(**variables) + cherrypy.response.headers['Content-Type'] = u'text/html' + return html @cherrypy.expose def login(self, username=None, password=None, from_page="/"): @@ -137,14 +140,14 @@ class AuthController(object): Provides the actual login control """ if username is None or password is None: - return self.get_loginform("", from_page=from_page) - + return self.get_login_form("", from_page=from_page) error_msg = check_credentials(username, password) if error_msg: - return self.get_loginform(username, error_msg, from_page) + return self.get_login_form(username, from_page, error_msg,) else: cherrypy.session[SESSION_KEY] = cherrypy.request.login = username self.on_login(username) + print from_page raise cherrypy.HTTPRedirect(from_page or "/") @cherrypy.expose diff --git a/openlp/plugins/remotes/lib/httpserver.py b/openlp/plugins/remotes/lib/httpserver.py index 211608858..db6143eb0 100644 --- a/openlp/plugins/remotes/lib/httpserver.py +++ b/openlp/plugins/remotes/lib/httpserver.py @@ -174,6 +174,8 @@ class HttpServer(object): cherrypy.config.update({'environment': 'embedded'}) cherrypy.config.update({'engine.autoreload_on': False}) cherrypy.tree.mount(HttpConnection(self), '/', config=self.conf) + # Turn off the flood of access messages cause by poll + cherrypy.log.access_log.propagate = False cherrypy.engine.start() Registry().register_function(u'slidecontroller_live_changed', self.slide_change) Registry().register_function(u'slidecontroller_live_started', self.item_change) From 3c32bc75011eac3b7ed3d07d90c8f818a6dab80d Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Wed, 13 Mar 2013 19:51:56 +0000 Subject: [PATCH 06/97] Added tests --- openlp/plugins/remotes/lib/httpauth.py | 2 +- .../openlp_core_lib/test_settings.py | 4 +- .../openlp_plugins/remotes/__init__.py | 1 + .../openlp_plugins/remotes/test_auth.py | 65 +++++++++++++++++++ 4 files changed, 70 insertions(+), 2 deletions(-) create mode 100644 tests/functional/openlp_plugins/remotes/__init__.py create mode 100644 tests/functional/openlp_plugins/remotes/test_auth.py diff --git a/openlp/plugins/remotes/lib/httpauth.py b/openlp/plugins/remotes/lib/httpauth.py index d46620855..6fe4197e2 100644 --- a/openlp/plugins/remotes/lib/httpauth.py +++ b/openlp/plugins/remotes/lib/httpauth.py @@ -56,7 +56,7 @@ def check_credentials(user_name, password): if user_name == Settings().value(u'remotes/user id') and password == Settings().value(u'remotes/password'): return None else: - return u"Incorrect username or password." + return translate('RemotePlugin.Mobile', 'Incorrect username or password.') def check_auth(*args, **kwargs): diff --git a/tests/functional/openlp_core_lib/test_settings.py b/tests/functional/openlp_core_lib/test_settings.py index 827bfa156..b06bb4eac 100644 --- a/tests/functional/openlp_core_lib/test_settings.py +++ b/tests/functional/openlp_core_lib/test_settings.py @@ -11,7 +11,9 @@ from PyQt4 import QtGui class TestSettings(TestCase): - + """ + Test the functions in the Settings module + """ def setUp(self): """ Create the UI diff --git a/tests/functional/openlp_plugins/remotes/__init__.py b/tests/functional/openlp_plugins/remotes/__init__.py new file mode 100644 index 000000000..f87606f07 --- /dev/null +++ b/tests/functional/openlp_plugins/remotes/__init__.py @@ -0,0 +1 @@ +__author__ = 'tim' diff --git a/tests/functional/openlp_plugins/remotes/test_auth.py b/tests/functional/openlp_plugins/remotes/test_auth.py new file mode 100644 index 000000000..a300c0127 --- /dev/null +++ b/tests/functional/openlp_plugins/remotes/test_auth.py @@ -0,0 +1,65 @@ +""" +This module contains tests for the lib submodule of the Remotes plugin. +""" +import os +from unittest import TestCase +from tempfile import mkstemp +from mock import patch + +from openlp.core.lib import Settings +from openlp.plugins.remotes.lib.httpauth import check_credentials +from PyQt4 import QtGui + +__default_settings__ = { + u'remotes/twelve hour': True, + u'remotes/port': 4316, + u'remotes/https port': 4317, + u'remotes/https enabled': False, + u'remotes/user id': u'openlp', + u'remotes/password': u'password', + u'remotes/authentication enabled': False, + u'remotes/ip address': u'0.0.0.0' +} + + +class TestLib(TestCase): + """ + Test the functions in the :mod:`lib` module. + """ + def setUp(self): + """ + Create the UI + """ + fd, self.ini_file = mkstemp(u'.ini') + Settings().set_filename(self.ini_file) + self.application = QtGui.QApplication.instance() + Settings().extend_default_settings(__default_settings__) + + def tearDown(self): + """ + Delete all the C++ objects at the end so that we don't have a segfault + """ + del self.application + os.unlink(self.ini_file) + os.unlink(Settings().fileName()) + + def check_credentials_test(self): + """ + Test the clean_string() function + """ + # GIVEN: A user and password + Settings().setValue(u'remotes/user id', u'twinkle') + Settings().setValue(u'remotes/password', u'mongoose') + + # WHEN: We run the string through the function + authenticated = check_credentials(u'', u'') + + # THEN: The string should be cleaned up and lower-cased + self.assertEqual(authenticated, u'Incorrect username or password.', + u'The return should be a error message string') + + # WHEN: We run the string through the function + authenticated = check_credentials(u'twinkle', u'mongoose') + + # THEN: The string should be cleaned up and lower-cased + self.assertEqual(authenticated, None, u'The return should be a None string') From d04dbd791f9ef141f947ca555fbc014cf84fd614 Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Fri, 15 Mar 2013 08:40:00 +0000 Subject: [PATCH 07/97] more changes --- openlp/plugins/remotes/html/login.html | 2 +- openlp/plugins/remotes/html/openlp.css | 8 -------- openlp/plugins/remotes/html/openlp.js | 2 +- openlp/plugins/remotes/lib/httpauth.py | 3 --- openlp/plugins/remotes/lib/httpserver.py | 7 +------ 5 files changed, 3 insertions(+), 19 deletions(-) diff --git a/openlp/plugins/remotes/html/login.html b/openlp/plugins/remotes/html/login.html index 4441958de..736d3f0ab 100644 --- a/openlp/plugins/remotes/html/login.html +++ b/openlp/plugins/remotes/html/login.html @@ -33,7 +33,7 @@ ${title} - + diff --git a/openlp/plugins/remotes/html/openlp.css b/openlp/plugins/remotes/html/openlp.css index 60a8fe625..4bc1bf907 100644 --- a/openlp/plugins/remotes/html/openlp.css +++ b/openlp/plugins/remotes/html/openlp.css @@ -36,11 +36,3 @@ .ui-li .ui-btn-text a.ui-link-inherit{ white-space: normal; } - -.ui-page{ - padding: 100px 100px 100px 100px; - width: 300px; -} -.ui-input-text{ - width: 30px; -} \ No newline at end of file diff --git a/openlp/plugins/remotes/html/openlp.js b/openlp/plugins/remotes/html/openlp.js index 00877e332..7c5c19e32 100644 --- a/openlp/plugins/remotes/html/openlp.js +++ b/openlp/plugins/remotes/html/openlp.js @@ -359,5 +359,5 @@ $.ajaxSetup({cache: false}); $("#search").live("pageinit", function (event) { OpenLP.getSearchablePlugins(); }); -setInterval("OpenLP.pollServer();", 500); +setInterval("OpenLP.pollServer();", 5000); OpenLP.pollServer(); diff --git a/openlp/plugins/remotes/lib/httpauth.py b/openlp/plugins/remotes/lib/httpauth.py index 6fe4197e2..bd3c1f911 100644 --- a/openlp/plugins/remotes/lib/httpauth.py +++ b/openlp/plugins/remotes/lib/httpauth.py @@ -75,12 +75,9 @@ def check_auth(*args, **kwargs): for condition in conditions: # A condition is just a callable that returns true or false if not condition(): - print "r1" raise cherrypy.HTTPRedirect("/auth/login") else: - print "r2" raise cherrypy.HTTPRedirect("/auth/login") - print "r3" cherrypy.tools.auth = cherrypy.Tool('before_handler', check_auth) diff --git a/openlp/plugins/remotes/lib/httpserver.py b/openlp/plugins/remotes/lib/httpserver.py index b8acc574f..308533b9d 100644 --- a/openlp/plugins/remotes/lib/httpserver.py +++ b/openlp/plugins/remotes/lib/httpserver.py @@ -144,8 +144,6 @@ class HttpServer(object): self.plugin = plugin self.html_dir = os.path.join(AppLocation.get_directory(AppLocation.PluginsDir), u'remotes', u'html') self.connections = [] - self.current_item = None - self.current_slide = None self.conf = {'/files': {u'tools.staticdir.on': True, u'tools.staticdir.dir': self.html_dir}} self.start_server() @@ -177,8 +175,6 @@ class HttpServer(object): # Turn off the flood of access messages cause by poll cherrypy.log.access_log.propagate = False cherrypy.engine.start() - Registry().register_function(u'slidecontroller_live_changed', self.slide_change) - Registry().register_function(u'slidecontroller_live_started', self.item_change) log.debug(u'TCP listening on port %d' % port) def close(self): @@ -481,8 +477,7 @@ class HttpConnection(object): if action == u'list': cherrypy.response.headers['Content-Type'] = u'application/json' return json.dumps({u'results': {u'items': self._get_service_items()}}) - else: - event += u'_item' + event += u'_item' if self.url_params and self.url_params.get(u'data'): try: data = json.loads(self.url_params[u'data'][0]) From 0f6216d653f1df071556e6e57867d8c2c477ff84 Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Sun, 17 Mar 2013 21:20:40 +0000 Subject: [PATCH 08/97] More changes --- openlp/core/ui/servicemanager.py | 5 ++++- openlp/core/ui/slidecontroller.py | 2 +- openlp/plugins/remotes/html/openlp.js | 4 ++-- openlp/plugins/remotes/lib/httpserver.py | 17 +++++++++++------ 4 files changed, 18 insertions(+), 10 deletions(-) diff --git a/openlp/core/ui/servicemanager.py b/openlp/core/ui/servicemanager.py index 9e99e2303..c7ab8dd77 100644 --- a/openlp/core/ui/servicemanager.py +++ b/openlp/core/ui/servicemanager.py @@ -270,7 +270,6 @@ class ServiceManagerDialog(object): Registry().register_function(u'config_screen_changed', self.regenerate_service_Items) Registry().register_function(u'theme_update_global', self.theme_change) Registry().register_function(u'mediaitem_suffix_reset', self.reset_supported_suffixes) - Registry().register_function(u'servicemanager_set_item', self.on_set_item) def drag_enter_event(self, event): """ @@ -313,6 +312,9 @@ class ServiceManager(QtGui.QWidget, ServiceManagerDialog): self.layout.setSpacing(0) self.layout.setMargin(0) self.setup_ui(self) + # Need to use event as called across threads and UI is updated + print self + QtCore.QObject.connect(self, QtCore.SIGNAL(u'servicemanager_set_item'), self.on_set_item) def set_modified(self, modified=True): """ @@ -1008,6 +1010,7 @@ class ServiceManager(QtGui.QWidget, ServiceManagerDialog): """ Called by a signal to select a specific item. """ + print "hello", message self.set_item(int(message)) def set_item(self, index): diff --git a/openlp/core/ui/slidecontroller.py b/openlp/core/ui/slidecontroller.py index 0c22a6353..3b2824fda 100644 --- a/openlp/core/ui/slidecontroller.py +++ b/openlp/core/ui/slidecontroller.py @@ -99,7 +99,7 @@ class SlideController(DisplayController): u'delay_spin_box' ] self.audio_list = [ - u'audio_pause_item', + u'audioPauseItem', u'audio_time_label' ] self.wide_menu = [ diff --git a/openlp/plugins/remotes/html/openlp.js b/openlp/plugins/remotes/html/openlp.js index 7c5c19e32..3cbe65366 100644 --- a/openlp/plugins/remotes/html/openlp.js +++ b/openlp/plugins/remotes/html/openlp.js @@ -147,7 +147,7 @@ window.OpenLP = { }, pollServer: function () { $.getJSON( - "/api/poll", + "/stage/api/poll", function (data, status) { var prevItem = OpenLP.currentItem; OpenLP.currentSlide = data.results.slide; @@ -359,5 +359,5 @@ $.ajaxSetup({cache: false}); $("#search").live("pageinit", function (event) { OpenLP.getSearchablePlugins(); }); -setInterval("OpenLP.pollServer();", 5000); +setInterval("OpenLP.pollServer();", 500); OpenLP.pollServer(); diff --git a/openlp/plugins/remotes/lib/httpserver.py b/openlp/plugins/remotes/lib/httpserver.py index 308533b9d..a594c1bca 100644 --- a/openlp/plugins/remotes/lib/httpserver.py +++ b/openlp/plugins/remotes/lib/httpserver.py @@ -199,7 +199,7 @@ class HttpConnection(object): def __init__(self, parent): """ - Initialise the http connection. Listen out for socket signals. + Initialise the CherryPy Server """ self.parent = parent self.routes = [ @@ -229,6 +229,9 @@ class HttpConnection(object): """ url = urlparse.urlparse(cherrypy.url()) self.url_params = urlparse.parse_qs(url.query) + self.request_data = None + if isinstance(kwargs, dict): + self.request_data = kwargs.get(u'data', None) # Loop through the routes we set up earlier and execute them return self._process_http_request(args, kwargs) @@ -255,7 +258,7 @@ class HttpConnection(object): Common function to process HTTP requests where secure or insecure """ url = urlparse.urlparse(cherrypy.url()) - self.url_params = urlparse.parse_qs(url.query) + self.url_params = kwargs response = None for route, func in self.routes: match = re.match(route, url.path) @@ -478,13 +481,15 @@ class HttpConnection(object): cherrypy.response.headers['Content-Type'] = u'application/json' return json.dumps({u'results': {u'items': self._get_service_items()}}) event += u'_item' - if self.url_params and self.url_params.get(u'data'): + if self.request_data: try: - data = json.loads(self.url_params[u'data'][0]) - except KeyError, ValueError: + data = json.loads(self.request_data)[u'request'][u'id'] + except KeyError: return self._http_bad_request() - Registry().execute(event, data[u'request'][u'id']) + print "A", event , data + self.service_manager.emit(QtCore.SIGNAL(event, data)) else: + print "B", event Registry().execute(event) cherrypy.response.headers['Content-Type'] = u'application/json' return json.dumps({u'results': {u'success': True}}) From 729c93b70b6a154dfc723405dd40c75410a57c8b Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Wed, 20 Mar 2013 20:17:00 +0000 Subject: [PATCH 09/97] More changes --- openlp/core/ui/servicemanager.py | 2 +- openlp/plugins/remotes/lib/httpserver.py | 40 +++++++++++------------- 2 files changed, 20 insertions(+), 22 deletions(-) diff --git a/openlp/core/ui/servicemanager.py b/openlp/core/ui/servicemanager.py index 97c6ca2db..7c3745299 100644 --- a/openlp/core/ui/servicemanager.py +++ b/openlp/core/ui/servicemanager.py @@ -1008,7 +1008,7 @@ class ServiceManager(QtGui.QWidget, ServiceManagerDialog): def on_set_item(self, message): """ - Called by a signal to select a specific item. + Called by a signal to select a specific item and make it live usually from remote. """ print "hello", message self.set_item(int(message)) diff --git a/openlp/plugins/remotes/lib/httpserver.py b/openlp/plugins/remotes/lib/httpserver.py index a594c1bca..368bf0192 100644 --- a/openlp/plugins/remotes/lib/httpserver.py +++ b/openlp/plugins/remotes/lib/httpserver.py @@ -155,17 +155,17 @@ class HttpServer(object): clients. Listen out for socket connections. """ log.debug(u'Start CherryPy server') - if Settings().value(self.plugin.settingsSection + u'/https enabled'): - port = Settings().value(self.plugin.settingsSection + u'/https port') - address = Settings().value(self.plugin.settingsSection + u'/ip address') + if Settings().value(self.plugin.settings_section + u'/https enabled'): + port = Settings().value(self.plugin.settings_section + u'/https port') + address = Settings().value(self.plugin.settings_section + u'/ip address') shared_data = AppLocation.get_directory(AppLocation.SharedData) server_config = {u'server.socket_host': str(address), u'server.socket_port': port, u'server.ssl_certificate': os.path.join(shared_data, u'openlp.crt'), u'server.ssl_private_key': os.path.join(shared_data, u'openlp.key')} else: - port = Settings().value(self.plugin.settingsSection + u'/port') - address = Settings().value(self.plugin.settingsSection + u'/ip address') + port = Settings().value(self.plugin.settings_section + u'/port') + address = Settings().value(self.plugin.settings_section + u'/ip address') server_config = {u'server.socket_host': str(address), u'server.socket_port': port} cherrypy.config.update(server_config) @@ -214,7 +214,7 @@ class HttpConnection(object): (r'^/stage/api/service/(.*)$', self.service), (r'^/api/display/(hide|show|blank|theme|desktop)$', self.display), (r'^/api/alert$', self.alert), - (r'^/api/plugin/(search)$', self.pluginInfo), + (r'^/api/plugin/(search)$', self.plugin_info), (r'^/api/(.*)/search$', self.search), (r'^/api/(.*)/live$', self.go_live), (r'^/api/(.*)/add$', self.add_to_service) @@ -456,9 +456,9 @@ class HttpConnection(object): if current_item: json_data[u'results'][u'item'] = self.live_controller.service_item.unique_identifier else: - if self.url_params and self.url_params.get(u'data'): + if self.request_data: try: - data = json.loads(self.url_params[u'data'][0]) + data = json.loads(self.request_data)[u'request'][u'id'] except KeyError, ValueError: return self._http_bad_request() log.info(data) @@ -486,15 +486,13 @@ class HttpConnection(object): data = json.loads(self.request_data)[u'request'][u'id'] except KeyError: return self._http_bad_request() - print "A", event , data - self.service_manager.emit(QtCore.SIGNAL(event, data)) + self.service_manager.emit(QtCore.SIGNAL(event), data) else: - print "B", event Registry().execute(event) cherrypy.response.headers['Content-Type'] = u'application/json' return json.dumps({u'results': {u'success': True}}) - def pluginInfo(self, action): + def plugin_info(self, action): """ Return plugin related information, based on the action. @@ -505,8 +503,8 @@ class HttpConnection(object): if action == u'search': searches = [] for plugin in self.plugin_manager.plugins: - if plugin.status == PluginStatus.Active and plugin.mediaItem and plugin.mediaItem.hasSearch: - searches.append([plugin.name, unicode(plugin.textStrings[StringContent.Name][u'plural'])]) + if plugin.status == PluginStatus.Active and plugin.media_item and plugin.media_item.hasSearch: + searches.append([plugin.name, unicode(plugin.text_strings[StringContent.Name][u'plural'])]) cherrypy.response.headers['Content-Type'] = u'application/json' return json.dumps({u'results': {u'items': searches}}) @@ -523,8 +521,8 @@ class HttpConnection(object): return self._http_bad_request() text = urllib.unquote(text) plugin = self.plugin_manager.get_plugin_by_name(plugin_name) - if plugin.status == PluginStatus.Active and plugin.mediaItem and plugin.mediaItem.hasSearch: - results = plugin.mediaItem.search(text, False) + if plugin.status == PluginStatus.Active and plugin.media_item and plugin.media_item.has_search: + results = plugin.media_item.search(text, False) else: results = [] cherrypy.response.headers['Content-Type'] = u'application/json' @@ -539,8 +537,8 @@ class HttpConnection(object): except KeyError, ValueError: return self._http_bad_request() plugin = self.plugin_manager.get_plugin_by_name(type) - if plugin.status == PluginStatus.Active and plugin.mediaItem: - plugin.mediaItem.goLive(id, remote=True) + if plugin.status == PluginStatus.Active and plugin.media_item: + plugin.media_item.go_live(id, remote=True) return self._http_success() def add_to_service(self, plugin_name): @@ -552,9 +550,9 @@ class HttpConnection(object): except KeyError, ValueError: return self._http_bad_request() plugin = self.plugin_manager.get_plugin_by_name(type) - if plugin.status == PluginStatus.Active and plugin.mediaItem: - item_id = plugin.mediaItem.createItemFromId(id) - plugin.mediaItem.addToService(item_id, remote=True) + if plugin.status == PluginStatus.Active and plugin.media_item: + item_id = plugin.media_item.create_item_from_id(id) + plugin.media_item.add_to_service(item_id, remote=True) self._http_success() def _http_success(self): From df1faa2a8dfc71f5c7dac57aa0b197c4c80e1343 Mon Sep 17 00:00:00 2001 From: Arjan Schrijver Date: Mon, 25 Mar 2013 21:17:46 +0100 Subject: [PATCH 10/97] - Fixed traceback on canceling the 'choose group' dialog - Clear the 'new group' lineedit in the 'choose group' dialog --- openlp/plugins/images/forms/choosegroupform.py | 1 + openlp/plugins/images/lib/mediaitem.py | 1 + 2 files changed, 2 insertions(+) diff --git a/openlp/plugins/images/forms/choosegroupform.py b/openlp/plugins/images/forms/choosegroupform.py index bbb57255c..f5478d014 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 i in range(self.group_combobox.count()): if self.group_combobox.itemData(i) == selected_group: diff --git a/openlp/plugins/images/lib/mediaitem.py b/openlp/plugins/images/lib/mediaitem.py index 1b2fe512e..ceb67f74b 100644 --- a/openlp/plugins/images/lib/mediaitem.py +++ b/openlp/plugins/images/lib/mediaitem.py @@ -394,6 +394,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 From 401f5ac2be3b087abfecf4bf6fbbcbca06289d7e Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Tue, 26 Mar 2013 08:55:05 +0000 Subject: [PATCH 11/97] More updates --- openlp/core/ui/slidecontroller.py | 2 - openlp/plugins/remotes/html/login.html | 3 +- openlp/plugins/remotes/lib/httpauth.py | 10 ++--- openlp/plugins/remotes/lib/httpserver.py | 14 ++----- .../openlp_plugins/remotes/test_auth.py | 38 +++++++++++++++---- 5 files changed, 40 insertions(+), 27 deletions(-) diff --git a/openlp/core/ui/slidecontroller.py b/openlp/core/ui/slidecontroller.py index 518e2a715..a66d0057b 100644 --- a/openlp/core/ui/slidecontroller.py +++ b/openlp/core/ui/slidecontroller.py @@ -1080,7 +1080,6 @@ class SlideController(DisplayController): """ Go to the next slide. """ - print "next" if not self.service_item: return Registry().execute(u'%s_next' % self.service_item.name.lower(), [self.service_item, self.is_live]) @@ -1108,7 +1107,6 @@ class SlideController(DisplayController): """ Go to the previous slide. """ - print "prev" if not self.service_item: return Registry().execute(u'%s_previous' % self.service_item.name.lower(), [self.service_item, self.is_live]) diff --git a/openlp/plugins/remotes/html/login.html b/openlp/plugins/remotes/html/login.html index 736d3f0ab..5d649629b 100644 --- a/openlp/plugins/remotes/html/login.html +++ b/openlp/plugins/remotes/html/login.html @@ -36,7 +36,6 @@ - @@ -48,4 +47,4 @@ Password:
- \ No newline at end of file + diff --git a/openlp/plugins/remotes/lib/httpauth.py b/openlp/plugins/remotes/lib/httpauth.py index bd3c1f911..e74dc9c04 100644 --- a/openlp/plugins/remotes/lib/httpauth.py +++ b/openlp/plugins/remotes/lib/httpauth.py @@ -59,11 +59,10 @@ def check_credentials(user_name, password): return translate('RemotePlugin.Mobile', 'Incorrect username or password.') -def check_auth(*args, **kwargs): +def check_authentication(*args, **kwargs): """ - A tool that looks in config for 'auth.require'. If found and it - is not None, a login is required and the entry is evaluated as a list of - conditions that the user must fulfill + A tool that looks in config for 'auth.require'. If found and it is not None, a login is required and the entry is + evaluated as a list of conditions that the user must fulfill """ conditions = cherrypy.request.config.get('auth.require', None) if not Settings().value(u'remotes/authentication enabled'): @@ -79,7 +78,7 @@ def check_auth(*args, **kwargs): else: raise cherrypy.HTTPRedirect("/auth/login") -cherrypy.tools.auth = cherrypy.Tool('before_handler', check_auth) +cherrypy.tools.auth = cherrypy.Tool('before_handler', check_authentication) def require_auth(*conditions): @@ -136,6 +135,7 @@ class AuthController(object): """ Provides the actual login control """ + print "login", from_page if username is None or password is None: return self.get_login_form("", from_page=from_page) error_msg = check_credentials(username, password) diff --git a/openlp/plugins/remotes/lib/httpserver.py b/openlp/plugins/remotes/lib/httpserver.py index 485a28240..e397d821f 100644 --- a/openlp/plugins/remotes/lib/httpserver.py +++ b/openlp/plugins/remotes/lib/httpserver.py @@ -43,7 +43,7 @@ the remotes. ``/files/{filename}`` Serve a static file. -``/api/poll`` +``/stage/api/poll`` Poll to see if there are any changes. Returns a JSON-encoded dict of any changes that occurred:: @@ -227,30 +227,24 @@ class HttpConnection(object): """ Handles the requests for the main url. This is secure depending on settings in config. """ - #url = urlparse.urlparse(cherrypy.url()) - #self.url_params = urlparse.parse_qs(url.query) + print "default" self.request_data = None if isinstance(kwargs, dict): self.request_data = kwargs.get(u'data', None) - # Loop through the routes we set up earlier and execute them return self._process_http_request(args, kwargs) @cherrypy.expose def stage(self, *args, **kwargs): """ - Handles the requests for the stage url. This is not secure. + Handles the requests for the /stage url. This is not secure. """ - #url = urlparse.urlparse(cherrypy.url()) - #self.url_params = urlparse.parse_qs(url.query) return self._process_http_request(args, kwargs) @cherrypy.expose def files(self, *args, **kwargs): """ - Handles the requests for the files url. This is not secure. + Handles the requests for the /files url. This is not secure. """ - #url = urlparse.urlparse(cherrypy.url()) - #self.url_params = urlparse.parse_qs(url.query) return self._process_http_request(args, kwargs) def _process_http_request(self, args, kwargs): diff --git a/tests/functional/openlp_plugins/remotes/test_auth.py b/tests/functional/openlp_plugins/remotes/test_auth.py index a300c0127..8afabd0c9 100644 --- a/tests/functional/openlp_plugins/remotes/test_auth.py +++ b/tests/functional/openlp_plugins/remotes/test_auth.py @@ -4,10 +4,11 @@ This module contains tests for the lib submodule of the Remotes plugin. import os from unittest import TestCase from tempfile import mkstemp -from mock import patch +from mock import patch, MagicMock +import cherrypy from openlp.core.lib import Settings -from openlp.plugins.remotes.lib.httpauth import check_credentials +from openlp.plugins.remotes.lib.httpauth import check_credentials, check_authentication from PyQt4 import QtGui __default_settings__ = { @@ -21,6 +22,8 @@ __default_settings__ = { u'remotes/ip address': u'0.0.0.0' } +SESSION_KEY = '_cp_openlp' + class TestLib(TestCase): """ @@ -34,6 +37,10 @@ class TestLib(TestCase): Settings().set_filename(self.ini_file) self.application = QtGui.QApplication.instance() Settings().extend_default_settings(__default_settings__) + cherrypy.config.update({'environment': "test_suite"}) + # prevent the HTTP server from ever starting + cherrypy.server.unsubscribe() + cherrypy.engine.start() def tearDown(self): """ @@ -42,24 +49,39 @@ class TestLib(TestCase): del self.application os.unlink(self.ini_file) os.unlink(Settings().fileName()) + cherrypy.engine.exit() def check_credentials_test(self): """ - Test the clean_string() function + Test the Authentication check routine. """ - # GIVEN: A user and password + # GIVEN: A user and password in settings Settings().setValue(u'remotes/user id', u'twinkle') Settings().setValue(u'remotes/password', u'mongoose') - # WHEN: We run the string through the function + # WHEN: We run the function with no input authenticated = check_credentials(u'', u'') - # THEN: The string should be cleaned up and lower-cased + # THEN: The authentication will fail with an error message self.assertEqual(authenticated, u'Incorrect username or password.', u'The return should be a error message string') - # WHEN: We run the string through the function + # WHEN: We run the function with the correct input authenticated = check_credentials(u'twinkle', u'mongoose') - # THEN: The string should be cleaned up and lower-cased + # THEN: The authentication will pass. self.assertEqual(authenticated, None, u'The return should be a None string') + + def check_auth_inactive_test(self): + """ + Test the Authentication check routine. + """ + # GIVEN: A access which is secure + Settings().setValue(u'remotes/authentication enabled', False) + + # WHEN: We run the function with no input + with patch(u'cherrypy.request.config'): + authenticated = check_authentication(None, None) + + # THEN: The authentication will fail with an error message + self.assertEqual(authenticated, None, u'The authentication should return None as not required') From 44547769c637a46210f488ce751b1968a84d5bd4 Mon Sep 17 00:00:00 2001 From: Arjan Schrijver Date: Tue, 26 Mar 2013 10:47:05 +0100 Subject: [PATCH 12/97] - Fixed traceback on adding multiple image groups to the service in one go - Cleaned up obsolete line in imagetab --- openlp/core/lib/mediamanageritem.py | 2 +- openlp/plugins/images/lib/imagetab.py | 1 - openlp/plugins/images/lib/mediaitem.py | 117 ++++++++++++++----------- 3 files changed, 65 insertions(+), 55 deletions(-) diff --git a/openlp/core/lib/mediamanageritem.py b/openlp/core/lib/mediamanageritem.py index e261bfe59..960708620 100644 --- a/openlp/core/lib/mediamanageritem.py +++ b/openlp/core/lib/mediamanageritem.py @@ -464,7 +464,7 @@ class MediaManagerItem(QtGui.QWidget): translate('OpenLP.MediaManagerItem', 'You must select one or more items to preview.')) else: log.debug(u'%s Preview requested', self.plugin.name) - service_item = self.build_service_item() + service_item = self.build_service_item(context=ServiceItemContext.Preview) if service_item: service_item.from_plugin = True self.preview_controller.add_service_item(service_item) 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 ceb67f74b..9bdd1dd11 100644 --- a/openlp/plugins/images/lib/mediaitem.py +++ b/openlp/plugins/images/lib/mediaitem.py @@ -32,7 +32,7 @@ import os from PyQt4 import QtCore, QtGui -from openlp.core.lib import ItemCapabilities, MediaManagerItem, Registry, ServiceItemContext, Settings, \ +from openlp.core.lib import ItemCapabilities, MediaManagerItem, Registry, ServiceItem, ServiceItemContext, Settings, \ StringContent, TreeWidgetWithDnD, UiStrings, build_icon, check_directory_exists, check_item_selected, \ create_thumb, translate, validate_thumb from openlp.core.lib.ui import create_widget_action, critical_error_message_box @@ -538,63 +538,74 @@ class ImageMediaItem(MediaManagerItem): """ background = QtGui.QColor(Settings().value(self.settings_section + u'/background color')) if item: - items = [item] + new_items = [item] else: - items = self.list_view.selectedItems() - if not items: + new_items = self.list_view.selectedItems() + if not new_items: return False - # Determine service item title - if isinstance(items[0].data(0, QtCore.Qt.UserRole), ImageGroups): - service_item.title = items[0].text(0) - else: - service_item.title = unicode(self.plugin.name_strings[u'plural']) - service_item.add_capability(ItemCapabilities.CanMaintain) - service_item.add_capability(ItemCapabilities.CanPreview) - service_item.add_capability(ItemCapabilities.CanLoop) - service_item.add_capability(ItemCapabilities.CanAppend) - # force a nonexistent theme - service_item.theme = -1 - missing_items = [] - missing_items_filenames = [] - # Expand groups to images - for bitem in items: + for bitem in new_items: + new_service_item = ServiceItem(self.plugin) + new_service_item.add_icon(self.plugin.icon_path) + # Determine service item title + if isinstance(bitem.data(0, QtCore.Qt.UserRole), ImageGroups): + new_service_item.title = bitem.text(0) + else: + new_service_item.title = unicode(self.plugin.name_strings[u'plural']) + new_service_item.add_capability(ItemCapabilities.CanMaintain) + new_service_item.add_capability(ItemCapabilities.CanPreview) + new_service_item.add_capability(ItemCapabilities.CanLoop) + new_service_item.add_capability(ItemCapabilities.CanAppend) + # force a nonexistent theme + new_service_item.theme = -1 + sub_images = [] + missing_items = [] + missing_items_filenames = [] + # Expand groups to images 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) - # Don't try to display empty groups - if not items: - return False - # Find missing files - for bitem in items: - filename = bitem.data(0, QtCore.Qt.UserRole).filename - 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 remote: - critical_error_message_box( - translate('ImagePlugin.MediaItem', 'Missing Image(s)'), - translate('ImagePlugin.MediaItem', 'The following image(s) no longer exist: %s') % - 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, - 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 - name = os.path.split(filename)[1] - service_item.add_from_image(filename, name, background) - return True + sub_images.append(bitem.child(index)) + # Don't try to display empty groups + if not sub_images: + return False + # Find missing files + for bitem in sub_images: + filename = bitem.data(0, QtCore.Qt.UserRole).filename + if not os.path.exists(filename): + missing_items.append(bitem) + missing_items_filenames.append(filename) + for item in missing_items: + sub_images.remove(item) + # We cannot continue, as all images do not exist. + if not sub_images: + if not remote: + critical_error_message_box( + translate('ImagePlugin.MediaItem', 'Missing Image(s)'), + translate('ImagePlugin.MediaItem', 'The following image(s) no longer exist: %s') % + 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, + 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 sub_image in sub_images: + filename = sub_image.data(0, QtCore.Qt.UserRole).filename + name = os.path.split(filename)[1] + new_service_item.add_from_image(filename, name, background) + # Add the service item to the correct controller + if context == ServiceItemContext.Service: + self.service_manager.add_service_item(new_service_item) + elif context == ServiceItemContext.Preview: + self.preview_controller.add_service_item(new_service_item) + elif context == ServiceItemContext.Live: + self.live_controller.add_service_item(new_service_item) + # Return False because we added the service item ourselves + return False def check_group_exists(self, new_group): """ From 6b032d52e554a2080ef9fb3127df1d2c0ccd5bf8 Mon Sep 17 00:00:00 2001 From: Arjan Schrijver Date: Tue, 26 Mar 2013 11:32:22 +0100 Subject: [PATCH 13/97] - Fixed adding single images --- openlp/plugins/images/lib/mediaitem.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/openlp/plugins/images/lib/mediaitem.py b/openlp/plugins/images/lib/mediaitem.py index 163d7094e..75c6a1216 100644 --- a/openlp/plugins/images/lib/mediaitem.py +++ b/openlp/plugins/images/lib/mediaitem.py @@ -565,6 +565,8 @@ class ImageMediaItem(MediaManagerItem): for index in range(0, bitem.childCount()): if isinstance(bitem.child(index).data(0, QtCore.Qt.UserRole), ImageFilenames): sub_images.append(bitem.child(index)) + if isinstance(bitem.data(0, QtCore.Qt.UserRole), ImageFilenames): + sub_images.append(bitem) # Don't try to display empty groups if not sub_images: return False From 451189b22202a5075dcadcf714e4d3c6b9067630 Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Tue, 26 Mar 2013 11:39:32 +0000 Subject: [PATCH 14/97] Fix up login page to handle redirection correctly --- openlp/plugins/remotes/html/login.html | 2 -- openlp/plugins/remotes/lib/httpauth.py | 4 +--- openlp/plugins/remotes/lib/httpserver.py | 8 +++++--- 3 files changed, 6 insertions(+), 8 deletions(-) diff --git a/openlp/plugins/remotes/html/login.html b/openlp/plugins/remotes/html/login.html index 5d649629b..60c71166c 100644 --- a/openlp/plugins/remotes/html/login.html +++ b/openlp/plugins/remotes/html/login.html @@ -35,8 +35,6 @@ - -
diff --git a/openlp/plugins/remotes/lib/httpauth.py b/openlp/plugins/remotes/lib/httpauth.py index e74dc9c04..cfa14a4a1 100644 --- a/openlp/plugins/remotes/lib/httpauth.py +++ b/openlp/plugins/remotes/lib/httpauth.py @@ -52,7 +52,6 @@ def check_credentials(user_name, password): Verifies credentials for username and password. Returns None on success or a string describing the error on failure """ - print "check" if user_name == Settings().value(u'remotes/user id') and password == Settings().value(u'remotes/password'): return None else: @@ -128,6 +127,7 @@ class AuthController(object): login_html = os.path.normpath(os.path.join(directory, u'login.html')) html = Template(filename=login_html, input_encoding=u'utf-8', output_encoding=u'utf-8').render(**variables) cherrypy.response.headers['Content-Type'] = u'text/html' + cherrypy.response.status = 200 return html @cherrypy.expose @@ -135,7 +135,6 @@ class AuthController(object): """ Provides the actual login control """ - print "login", from_page if username is None or password is None: return self.get_login_form("", from_page=from_page) error_msg = check_credentials(username, password) @@ -144,7 +143,6 @@ class AuthController(object): else: cherrypy.session[SESSION_KEY] = cherrypy.request.login = username self.on_login(username) - print from_page raise cherrypy.HTTPRedirect(from_page or "/") @cherrypy.expose diff --git a/openlp/plugins/remotes/lib/httpserver.py b/openlp/plugins/remotes/lib/httpserver.py index e397d821f..6759d10f3 100644 --- a/openlp/plugins/remotes/lib/httpserver.py +++ b/openlp/plugins/remotes/lib/httpserver.py @@ -227,7 +227,6 @@ class HttpConnection(object): """ Handles the requests for the main url. This is secure depending on settings in config. """ - print "default" self.request_data = None if isinstance(kwargs, dict): self.request_data = kwargs.get(u'data', None) @@ -252,7 +251,6 @@ class HttpConnection(object): Common function to process HTTP requests where secure or insecure """ url = urlparse.urlparse(cherrypy.url()) - #self.url_params = kwargs response = None for route, func in self.routes: match = re.match(route, url.path) @@ -315,7 +313,11 @@ class HttpConnection(object): 'no_results': translate('RemotePlugin.Mobile', 'No Results'), 'options': translate('RemotePlugin.Mobile', 'Options'), 'service': translate('RemotePlugin.Mobile', 'Service'), - 'slides': translate('RemotePlugin.Mobile', 'Slides') + 'slides': translate('RemotePlugin.Mobile', 'Slides'), + 'title': translate('RemotePlugin.Mobile', 'OpenLP 2.1 User Login'), + 'from_page': "", + 'message': "", + 'username': "username" } def serve_file(self, filename=None): From 3fef841bb27afcd3e7c4c4dfb2015be9fa3e0324 Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Tue, 26 Mar 2013 12:45:18 +0100 Subject: [PATCH 15/97] fixed FTW shown again --- openlp/core/__init__.py | 2 ++ openlp/core/ui/mainwindow.py | 1 - 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/openlp/core/__init__.py b/openlp/core/__init__.py index dd2a3d18c..23986ffc4 100644 --- a/openlp/core/__init__.py +++ b/openlp/core/__init__.py @@ -305,6 +305,8 @@ def main(args=None): # Instance check if application.is_already_running(): sys.exit() + # Remove/convert obsolete settings. + Settings().remove_obsolete_settings() # First time checks in settings if not Settings().value(u'core/has run wizard'): if not FirstTimeLanguageForm().exec_(): diff --git a/openlp/core/ui/mainwindow.py b/openlp/core/ui/mainwindow.py index 8f61d595c..6bcad24c9 100644 --- a/openlp/core/ui/mainwindow.py +++ b/openlp/core/ui/mainwindow.py @@ -491,7 +491,6 @@ class MainWindow(QtGui.QMainWindow, Ui_MainWindow): self.new_data_path = None self.copy_data = False Settings().set_up_default_values() - Settings().remove_obsolete_settings() self.service_not_saved = False self.about_form = AboutForm(self) self.media_controller = MediaController() From ab011a22c195ec0781e57b38f97de3ab3538d3e1 Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Thu, 28 Mar 2013 14:45:47 +0000 Subject: [PATCH 16/97] last version before big refactor --- openlp/plugins/remotes/lib/httpauth.py | 2 ++ openlp/plugins/remotes/lib/httpserver.py | 6 ++---- openlp/plugins/remotes/remoteplugin.py | 1 + tests/functional/openlp_plugins/remotes/test_auth.py | 12 +++--------- 4 files changed, 8 insertions(+), 13 deletions(-) diff --git a/openlp/plugins/remotes/lib/httpauth.py b/openlp/plugins/remotes/lib/httpauth.py index cfa14a4a1..f760bfc8c 100644 --- a/openlp/plugins/remotes/lib/httpauth.py +++ b/openlp/plugins/remotes/lib/httpauth.py @@ -64,6 +64,8 @@ def check_authentication(*args, **kwargs): evaluated as a list of conditions that the user must fulfill """ conditions = cherrypy.request.config.get('auth.require', None) + a = cherrypy.request + print a if not Settings().value(u'remotes/authentication enabled'): return None if conditions is not None: diff --git a/openlp/plugins/remotes/lib/httpserver.py b/openlp/plugins/remotes/lib/httpserver.py index 6759d10f3..22a75e49e 100644 --- a/openlp/plugins/remotes/lib/httpserver.py +++ b/openlp/plugins/remotes/lib/httpserver.py @@ -138,7 +138,7 @@ class HttpServer(object): def __init__(self, plugin): """ - Initialise the httpserver, and start the server. + Initialise the http server, and start the server. """ log.debug(u'Initialise httpserver') self.plugin = plugin @@ -146,13 +146,11 @@ class HttpServer(object): self.connections = [] self.conf = {'/files': {u'tools.staticdir.on': True, u'tools.staticdir.dir': self.html_dir}} - self.start_server() def start_server(self): """ Start the http server, use the port in the settings default to 4316. - Listen out for slide and song changes so they can be broadcast to - clients. Listen out for socket connections. + Listen out for slide and song changes so they can be broadcast to clients. Listen out for socket connections. """ log.debug(u'Start CherryPy server') if Settings().value(self.plugin.settings_section + u'/https enabled'): diff --git a/openlp/plugins/remotes/remoteplugin.py b/openlp/plugins/remotes/remoteplugin.py index 4e37f9853..5be537b60 100644 --- a/openlp/plugins/remotes/remoteplugin.py +++ b/openlp/plugins/remotes/remoteplugin.py @@ -66,6 +66,7 @@ class RemotesPlugin(Plugin): log.debug(u'initialise') Plugin.initialise(self) self.server = HttpServer(self) + self.server.start_server() def finalise(self): """ diff --git a/tests/functional/openlp_plugins/remotes/test_auth.py b/tests/functional/openlp_plugins/remotes/test_auth.py index 8afabd0c9..32622af9c 100644 --- a/tests/functional/openlp_plugins/remotes/test_auth.py +++ b/tests/functional/openlp_plugins/remotes/test_auth.py @@ -5,7 +5,6 @@ import os from unittest import TestCase from tempfile import mkstemp from mock import patch, MagicMock -import cherrypy from openlp.core.lib import Settings from openlp.plugins.remotes.lib.httpauth import check_credentials, check_authentication @@ -25,7 +24,7 @@ __default_settings__ = { SESSION_KEY = '_cp_openlp' -class TestLib(TestCase): +class TestAuth(TestCase): """ Test the functions in the :mod:`lib` module. """ @@ -37,10 +36,6 @@ class TestLib(TestCase): Settings().set_filename(self.ini_file) self.application = QtGui.QApplication.instance() Settings().extend_default_settings(__default_settings__) - cherrypy.config.update({'environment': "test_suite"}) - # prevent the HTTP server from ever starting - cherrypy.server.unsubscribe() - cherrypy.engine.start() def tearDown(self): """ @@ -49,11 +44,10 @@ class TestLib(TestCase): del self.application os.unlink(self.ini_file) os.unlink(Settings().fileName()) - cherrypy.engine.exit() def check_credentials_test(self): """ - Test the Authentication check routine. + Test the Authentication check routine with credentials. """ # GIVEN: A user and password in settings Settings().setValue(u'remotes/user id', u'twinkle') @@ -74,7 +68,7 @@ class TestLib(TestCase): def check_auth_inactive_test(self): """ - Test the Authentication check routine. + Test the Authentication check routine when inactive. """ # GIVEN: A access which is secure Settings().setValue(u'remotes/authentication enabled', False) From 8cf886971c1b5f1c9007a5e92d0cdd44c4897878 Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Fri, 29 Mar 2013 07:48:55 +0000 Subject: [PATCH 17/97] Refactor http server --- openlp/core/ui/settingsform.py | 1 + openlp/plugins/remotes/lib/httpserver.py | 150 ++++++++++++++--------- openlp/plugins/remotes/lib/remotetab.py | 24 +++- openlp/plugins/remotes/remoteplugin.py | 8 +- 4 files changed, 114 insertions(+), 69 deletions(-) diff --git a/openlp/core/ui/settingsform.py b/openlp/core/ui/settingsform.py index eeb85fa66..bc40539cf 100644 --- a/openlp/core/ui/settingsform.py +++ b/openlp/core/ui/settingsform.py @@ -96,6 +96,7 @@ class SettingsForm(QtGui.QDialog, Ui_SettingsDialog): """ Process the form saving the settings """ + log.debug(u'Processing settings exit') for tabIndex in range(self.stacked_layout.count()): self.stacked_layout.widget(tabIndex).save() # if the display of image background are changing we need to regenerate the image cache diff --git a/openlp/plugins/remotes/lib/httpserver.py b/openlp/plugins/remotes/lib/httpserver.py index 22a75e49e..b660ec094 100644 --- a/openlp/plugins/remotes/lib/httpserver.py +++ b/openlp/plugins/remotes/lib/httpserver.py @@ -126,54 +126,115 @@ from PyQt4 import QtCore from openlp.core.lib import Registry, Settings, PluginStatus, StringContent from openlp.core.utils import AppLocation, translate -from openlp.plugins.remotes.lib.httpauth import AuthController, require_auth + +from cherrypy._cpcompat import md5, sha, ntob log = logging.getLogger(__name__) +def sha_password_encrypter(password): + + return sha(ntob(password)).hexdigest() + + +def fetch_password(username): + if username != Settings().value(u'remotes/user id'): + return None + print "fetch password", username + return sha(ntob(Settings().value(u'remotes/password'))).hexdigest() + + class HttpServer(object): """ Ability to control OpenLP via a web browser. """ + _cp_config = { + 'tools.sessions.on': True, + 'tools.auth.on': True + } + def __init__(self, plugin): """ Initialise the http server, and start the server. """ log.debug(u'Initialise httpserver') self.plugin = plugin - self.html_dir = os.path.join(AppLocation.get_directory(AppLocation.PluginsDir), u'remotes', u'html') - self.connections = [] - self.conf = {'/files': {u'tools.staticdir.on': True, - u'tools.staticdir.dir': self.html_dir}} + self.router = HttpRouter() def start_server(self): """ - Start the http server, use the port in the settings default to 4316. - Listen out for slide and song changes so they can be broadcast to clients. Listen out for socket connections. + Start the http server based on configuration. """ log.debug(u'Start CherryPy server') + # Define to security levels and add the router code + self.root = self.Public() + self.root.files = self.Files() + self.root.stage = self.Stage() + self.root.router = self.router + self.root.files.router = self.router + self.root.stage.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 + cherrypy.engine.start() + + def define_config(self): if Settings().value(self.plugin.settings_section + u'/https enabled'): port = Settings().value(self.plugin.settings_section + u'/https port') address = Settings().value(self.plugin.settings_section + u'/ip address') shared_data = AppLocation.get_directory(AppLocation.SharedData) - server_config = {u'server.socket_host': str(address), - u'server.socket_port': port, - u'server.ssl_certificate': os.path.join(shared_data, u'openlp.crt'), - u'server.ssl_private_key': os.path.join(shared_data, u'openlp.key')} + cherrypy.config.update({u'server.socket_host': str(address), + u'server.socket_port': port, + u'server.ssl_certificate': os.path.join(shared_data, u'openlp.crt'), + u'server.ssl_private_key': os.path.join(shared_data, u'openlp.key')}) else: port = Settings().value(self.plugin.settings_section + u'/port') address = Settings().value(self.plugin.settings_section + u'/ip address') - server_config = {u'server.socket_host': str(address), - u'server.socket_port': port} - cherrypy.config.update(server_config) - cherrypy.config.update({'environment': 'embedded'}) - cherrypy.config.update({'engine.autoreload_on': False}) - cherrypy.tree.mount(HttpConnection(self), '/', config=self.conf) - # Turn off the flood of access messages cause by poll - cherrypy.log.access_log.propagate = False - cherrypy.engine.start() - log.debug(u'TCP listening on port %d' % port) + cherrypy.config.update({u'server.socket_host': str(address)}) + cherrypy.config.update({u'server.socket_port': port}) + cherrypy.config.update({u'environment': u'embedded'}) + cherrypy.config.update({u'engine.autoreload_on': False}) + directory_config = {u'/': {u'tools.staticdir.on': True, + u'tools.staticdir.dir': self.router.html_dir, + u'tools.basic_auth.on': Settings().value(u'remotes/authentication enabled'), + u'tools.basic_auth.realm': u'OpenLP Remote Login', + u'tools.basic_auth.users': fetch_password, + u'tools.basic_auth.encrypt': sha_password_encrypter}, + u'/files': {u'tools.staticdir.on': True, + 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}} + return directory_config + + def reload_config(self): + cherrypy.tree.mount(self.root, '/', config=self.define_config()) + cherrypy.config.reset() + + class Public: + @cherrypy.expose + def default(self, *args, **kwargs): + print "public" + self.router.request_data = None + if isinstance(kwargs, dict): + self.router.request_data = kwargs.get(u'data', None) + url = urlparse.urlparse(cherrypy.url()) + return self.router.process_http_request(url.path, *args) + + class Files: + @cherrypy.expose + def default(self, *args, **kwargs): + print "files" + url = urlparse.urlparse(cherrypy.url()) + return self.router.process_http_request(url.path, *args) + + class Stage: + @cherrypy.expose + def default(self, *args, **kwargs): + url = urlparse.urlparse(cherrypy.url()) + return self.router.process_http_request(url.path, *args) def close(self): """ @@ -181,25 +242,17 @@ class HttpServer(object): """ log.debug(u'close http server') cherrypy.engine.exit() - cherrypy.engine.stop() -class HttpConnection(object): +class HttpRouter(object): """ A single connection, this handles communication between the server and the client. """ - _cp_config = { - 'tools.sessions.on': True, - 'tools.auth.on': True - } - auth = AuthController() - - def __init__(self, parent): + def __init__(self): """ Initialise the CherryPy Server """ - self.parent = parent self.routes = [ (u'^/$', self.serve_file), (u'^/(stage)$', self.serve_file), @@ -218,33 +271,9 @@ class HttpConnection(object): (r'^/api/(.*)/add$', self.add_to_service) ] self.translate() + self.html_dir = os.path.join(AppLocation.get_directory(AppLocation.PluginsDir), u'remotes', u'html') - @cherrypy.expose - @require_auth() - def default(self, *args, **kwargs): - """ - Handles the requests for the main url. This is secure depending on settings in config. - """ - self.request_data = None - if isinstance(kwargs, dict): - self.request_data = kwargs.get(u'data', None) - return self._process_http_request(args, kwargs) - - @cherrypy.expose - def stage(self, *args, **kwargs): - """ - Handles the requests for the /stage url. This is not secure. - """ - return self._process_http_request(args, kwargs) - - @cherrypy.expose - def files(self, *args, **kwargs): - """ - Handles the requests for the /files url. This is not secure. - """ - return self._process_http_request(args, kwargs) - - def _process_http_request(self, args, kwargs): + def process_http_request(self, url_path, *args): """ Common function to process HTTP requests where secure or insecure """ @@ -253,7 +282,7 @@ class HttpConnection(object): for route, func in self.routes: match = re.match(route, url.path) if match: - log.debug('Route "%s" matched "%s"', route, url.path) + log.debug('Route "%s" matched "%s"', route, url_path) args = [] for param in match.groups(): args.append(param) @@ -332,8 +361,8 @@ class HttpConnection(object): filename = u'index.html' elif filename == u'stage': filename = u'stage.html' - path = os.path.normpath(os.path.join(self.parent.html_dir, filename)) - if not path.startswith(self.parent.html_dir): + path = os.path.normpath(os.path.join(self.html_dir, filename)) + if not path.startswith(self.html_dir): return self._http_not_found() ext = os.path.splitext(filename)[1] html = None @@ -450,7 +479,6 @@ class HttpConnection(object): if current_item: json_data[u'results'][u'item'] = self.live_controller.service_item.unique_identifier else: - print event if self.request_data: try: data = json.loads(self.request_data)[u'request'][u'id'] diff --git a/openlp/plugins/remotes/lib/remotetab.py b/openlp/plugins/remotes/lib/remotetab.py index 7c76516dc..77baf9116 100644 --- a/openlp/plugins/remotes/lib/remotetab.py +++ b/openlp/plugins/remotes/lib/remotetab.py @@ -155,6 +155,7 @@ class RemoteTab(SettingsTab): self.address_edit.textChanged.connect(self.set_urls) self.port_spin_box.valueChanged.connect(self.set_urls) self.https_port_spin_box.valueChanged.connect(self.set_urls) + self.https_settings_group_box.clicked.connect(self.https_changed) def retranslateUi(self): self.server_settings_group_box.setTitle(translate('RemotePlugin.RemoteTab', 'Server Settings')) @@ -224,15 +225,22 @@ class RemoteTab(SettingsTab): self.user_id.setText(Settings().value(self.settings_section + u'/user id')) self.password.setText(Settings().value(self.settings_section + u'/password')) self.set_urls() + self.https_changed() def save(self): - changed = False + """ + Save the configuration and update the server configuration if necessary + """ if Settings().value(self.settings_section + u'/ip address') != self.address_edit.text() or \ Settings().value(self.settings_section + u'/port') != self.port_spin_box.value() or \ Settings().value(self.settings_section + u'/https port') != self.https_port_spin_box.value() or \ Settings().value(self.settings_section + u'/https enabled') != \ - self.https_settings_group_box.isChecked(): - changed = True + self.https_settings_group_box.isChecked() or \ + Settings().value(self.settings_section + u'/authentication enabled') != \ + self.user_login_group_box.isChecked() or \ + Settings().value(self.settings_section + u'/user id') != self.user_id.text() or \ + Settings().value(self.settings_section + u'/password') != self.password.text(): + self.settings_form.register_post_process(u'remotes_config_updated') Settings().setValue(self.settings_section + u'/port', self.port_spin_box.value()) Settings().setValue(self.settings_section + u'/https port', self.https_port_spin_box.value()) Settings().setValue(self.settings_section + u'/https enabled', self.https_settings_group_box.isChecked()) @@ -241,12 +249,16 @@ class RemoteTab(SettingsTab): Settings().setValue(self.settings_section + u'/authentication enabled', self.user_login_group_box.isChecked()) Settings().setValue(self.settings_section + u'/user id', self.user_id.text()) Settings().setValue(self.settings_section + u'/password', self.password.text()) - if changed: - Registry().execute(u'remotes_config_updated') - def on_twelve_hour_check_box_changed(self, check_state): self.twelve_hour = False # we have a set value convert to True/False if check_state == QtCore.Qt.Checked: self.twelve_hour = True + + def https_changed(self): + """ + Invert the HTTP group box based on Https group settings + """ + self.http_settings_group_box.setEnabled(not self.https_settings_group_box.isChecked()) + diff --git a/openlp/plugins/remotes/remoteplugin.py b/openlp/plugins/remotes/remoteplugin.py index 5be537b60..fd2906feb 100644 --- a/openlp/plugins/remotes/remoteplugin.py +++ b/openlp/plugins/remotes/remoteplugin.py @@ -29,6 +29,8 @@ import logging +from PyQt4 import QtGui + from openlp.core.lib import Plugin, StringContent, translate, build_icon from openlp.plugins.remotes.lib import RemoteTab, HttpServer @@ -76,6 +78,7 @@ class RemotesPlugin(Plugin): Plugin.finalise(self) if self.server: self.server.close() + self.server = None def about(self): """ @@ -105,5 +108,6 @@ class RemotesPlugin(Plugin): """ Called when Config is changed to restart the server on new address or port """ - self.finalise() - self.initialise() + log.debug(u'remote config changed') + self.main_window.information_message(translate('RemotePlugin', 'Configuration Change'), + translate('RemotePlugin', 'OpenLP will need to be restarted for the Remote changes to become active.')) From 347636d0787240d54a72705a6cdbcabdcc0fd434 Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Fri, 29 Mar 2013 08:33:10 +0000 Subject: [PATCH 18/97] Move userid and password change out of restart scope --- openlp/plugins/remotes/lib/remotetab.py | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/openlp/plugins/remotes/lib/remotetab.py b/openlp/plugins/remotes/lib/remotetab.py index 77baf9116..658f5cfcf 100644 --- a/openlp/plugins/remotes/lib/remotetab.py +++ b/openlp/plugins/remotes/lib/remotetab.py @@ -31,7 +31,7 @@ import os.path from PyQt4 import QtCore, QtGui, QtNetwork -from openlp.core.lib import Registry, Settings, SettingsTab, translate +from openlp.core.lib import Settings, SettingsTab, translate from openlp.core.utils import AppLocation @@ -237,9 +237,7 @@ class RemoteTab(SettingsTab): Settings().value(self.settings_section + u'/https enabled') != \ self.https_settings_group_box.isChecked() or \ Settings().value(self.settings_section + u'/authentication enabled') != \ - self.user_login_group_box.isChecked() or \ - Settings().value(self.settings_section + u'/user id') != self.user_id.text() or \ - Settings().value(self.settings_section + u'/password') != self.password.text(): + self.user_login_group_box.isChecked(): self.settings_form.register_post_process(u'remotes_config_updated') Settings().setValue(self.settings_section + u'/port', self.port_spin_box.value()) Settings().setValue(self.settings_section + u'/https port', self.https_port_spin_box.value()) From ced77e4ec3f236779fe0b9cd17e79700a0cafae2 Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Fri, 29 Mar 2013 09:06:43 +0000 Subject: [PATCH 19/97] Add some proper tests --- openlp/plugins/remotes/lib/httpauth.py | 162 ------------------ openlp/plugins/remotes/lib/httpserver.py | 3 +- .../openlp_plugins/remotes/test_auth.py | 81 --------- .../{test_server.py => test_router.py} | 32 ++-- 4 files changed, 18 insertions(+), 260 deletions(-) delete mode 100644 openlp/plugins/remotes/lib/httpauth.py delete mode 100644 tests/functional/openlp_plugins/remotes/test_auth.py rename tests/functional/openlp_plugins/remotes/{test_server.py => test_router.py} (71%) diff --git a/openlp/plugins/remotes/lib/httpauth.py b/openlp/plugins/remotes/lib/httpauth.py deleted file mode 100644 index f760bfc8c..000000000 --- a/openlp/plugins/remotes/lib/httpauth.py +++ /dev/null @@ -1,162 +0,0 @@ -# -*- 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:`http` module manages the HTTP authorisation logic. This code originates from -http://tools.cherrypy.org/wiki/AuthenticationAndAccessRestrictions - -""" - -import cherrypy -import logging -import os - -from mako.template import Template - -from openlp.core.lib import Settings -from openlp.core.utils import AppLocation, translate - -SESSION_KEY = '_cp_openlp' - -log = logging.getLogger(__name__) - - -def check_credentials(user_name, password): - """ - Verifies credentials for username and password. - Returns None on success or a string describing the error on failure - """ - if user_name == Settings().value(u'remotes/user id') and password == Settings().value(u'remotes/password'): - return None - else: - return translate('RemotePlugin.Mobile', 'Incorrect username or password.') - - -def check_authentication(*args, **kwargs): - """ - A tool that looks in config for 'auth.require'. If found and it is not None, a login is required and the entry is - evaluated as a list of conditions that the user must fulfill - """ - conditions = cherrypy.request.config.get('auth.require', None) - a = cherrypy.request - print a - if not Settings().value(u'remotes/authentication enabled'): - return None - if conditions is not None: - username = cherrypy.session.get(SESSION_KEY) - if username: - cherrypy.request.login = username - for condition in conditions: - # A condition is just a callable that returns true or false - if not condition(): - raise cherrypy.HTTPRedirect("/auth/login") - else: - raise cherrypy.HTTPRedirect("/auth/login") - -cherrypy.tools.auth = cherrypy.Tool('before_handler', check_authentication) - - -def require_auth(*conditions): - """ - A decorator that appends conditions to the auth.require config variable. - """ - def decorate(f): - """ - Lets process a decoration. - """ - if not hasattr(f, '_cp_config'): - f._cp_config = dict() - if 'auth.require' not in f._cp_config: - f._cp_config['auth.require'] = [] - f._cp_config['auth.require'].extend(conditions) - return f - return decorate - - -class AuthController(object): - - def on_login(self, username): - """ - Called on successful login - """ - pass - - def on_logout(self, username): - """ - Called on logout - """ - pass - - def get_login_form(self, username, message=None, from_page="/"): - """ - Provides a login form - """ - if not message: - message = translate('RemotePlugin.Mobile', 'Enter login information') - variables = { - 'title': translate('RemotePlugin.Mobile', 'OpenLP 2.1 User Login'), - 'from_page': from_page, - 'message': message, - 'username': username - } - directory = os.path.join(AppLocation.get_directory(AppLocation.PluginsDir), u'remotes', u'html') - login_html = os.path.normpath(os.path.join(directory, u'login.html')) - html = Template(filename=login_html, input_encoding=u'utf-8', output_encoding=u'utf-8').render(**variables) - cherrypy.response.headers['Content-Type'] = u'text/html' - cherrypy.response.status = 200 - return html - - @cherrypy.expose - def login(self, username=None, password=None, from_page="/"): - """ - Provides the actual login control - """ - if username is None or password is None: - return self.get_login_form("", from_page=from_page) - error_msg = check_credentials(username, password) - if error_msg: - return self.get_login_form(username, from_page, error_msg,) - else: - cherrypy.session[SESSION_KEY] = cherrypy.request.login = username - self.on_login(username) - raise cherrypy.HTTPRedirect(from_page or "/") - - @cherrypy.expose - def logout(self, from_page="/"): - """ - Provides the actual logout functions - """ - sess = cherrypy.session - username = sess.get(SESSION_KEY, None) - sess[SESSION_KEY] = None - if username: - cherrypy.request.login = None - self.on_logout(username) - raise cherrypy.HTTPRedirect(from_page or "/") - diff --git a/openlp/plugins/remotes/lib/httpserver.py b/openlp/plugins/remotes/lib/httpserver.py index b660ec094..f8a79899e 100644 --- a/openlp/plugins/remotes/lib/httpserver.py +++ b/openlp/plugins/remotes/lib/httpserver.py @@ -277,10 +277,9 @@ class HttpRouter(object): """ Common function to process HTTP requests where secure or insecure """ - url = urlparse.urlparse(cherrypy.url()) response = None for route, func in self.routes: - match = re.match(route, url.path) + match = re.match(route, url_path) if match: log.debug('Route "%s" matched "%s"', route, url_path) args = [] diff --git a/tests/functional/openlp_plugins/remotes/test_auth.py b/tests/functional/openlp_plugins/remotes/test_auth.py deleted file mode 100644 index 32622af9c..000000000 --- a/tests/functional/openlp_plugins/remotes/test_auth.py +++ /dev/null @@ -1,81 +0,0 @@ -""" -This module contains tests for the lib submodule of the Remotes plugin. -""" -import os -from unittest import TestCase -from tempfile import mkstemp -from mock import patch, MagicMock - -from openlp.core.lib import Settings -from openlp.plugins.remotes.lib.httpauth import check_credentials, check_authentication -from PyQt4 import QtGui - -__default_settings__ = { - u'remotes/twelve hour': True, - u'remotes/port': 4316, - u'remotes/https port': 4317, - u'remotes/https enabled': False, - u'remotes/user id': u'openlp', - u'remotes/password': u'password', - u'remotes/authentication enabled': False, - u'remotes/ip address': u'0.0.0.0' -} - -SESSION_KEY = '_cp_openlp' - - -class TestAuth(TestCase): - """ - Test the functions in the :mod:`lib` module. - """ - def setUp(self): - """ - Create the UI - """ - fd, self.ini_file = mkstemp(u'.ini') - Settings().set_filename(self.ini_file) - self.application = QtGui.QApplication.instance() - Settings().extend_default_settings(__default_settings__) - - def tearDown(self): - """ - Delete all the C++ objects at the end so that we don't have a segfault - """ - del self.application - os.unlink(self.ini_file) - os.unlink(Settings().fileName()) - - def check_credentials_test(self): - """ - Test the Authentication check routine with credentials. - """ - # GIVEN: A user and password in settings - Settings().setValue(u'remotes/user id', u'twinkle') - Settings().setValue(u'remotes/password', u'mongoose') - - # WHEN: We run the function with no input - authenticated = check_credentials(u'', u'') - - # THEN: The authentication will fail with an error message - self.assertEqual(authenticated, u'Incorrect username or password.', - u'The return should be a error message string') - - # WHEN: We run the function with the correct input - authenticated = check_credentials(u'twinkle', u'mongoose') - - # THEN: The authentication will pass. - self.assertEqual(authenticated, None, u'The return should be a None string') - - def check_auth_inactive_test(self): - """ - Test the Authentication check routine when inactive. - """ - # GIVEN: A access which is secure - Settings().setValue(u'remotes/authentication enabled', False) - - # WHEN: We run the function with no input - with patch(u'cherrypy.request.config'): - authenticated = check_authentication(None, None) - - # THEN: The authentication will fail with an error message - self.assertEqual(authenticated, None, u'The authentication should return None as not required') diff --git a/tests/functional/openlp_plugins/remotes/test_server.py b/tests/functional/openlp_plugins/remotes/test_router.py similarity index 71% rename from tests/functional/openlp_plugins/remotes/test_server.py rename to tests/functional/openlp_plugins/remotes/test_router.py index d574a8542..9604bc747 100644 --- a/tests/functional/openlp_plugins/remotes/test_server.py +++ b/tests/functional/openlp_plugins/remotes/test_router.py @@ -6,10 +6,9 @@ import os from unittest import TestCase from tempfile import mkstemp from mock import patch, MagicMock -import cherrypy from openlp.core.lib import Settings -from openlp.plugins.remotes.lib.httpserver import HttpConnection +from openlp.plugins.remotes.lib.httpserver import HttpRouter from PyQt4 import QtGui __default_settings__ = { @@ -23,10 +22,8 @@ __default_settings__ = { u'remotes/ip address': u'0.0.0.0' } -SESSION_KEY = '_cp_openlp' - -class TestAuth(TestCase): +class TestRouter(TestCase): """ Test the functions in the :mod:`lib` module. """ @@ -38,7 +35,7 @@ class TestAuth(TestCase): Settings().set_filename(self.ini_file) self.application = QtGui.QApplication.instance() Settings().extend_default_settings(__default_settings__) - self.server = HttpConnection(None) + self.router = HttpRouter() def tearDown(self): """ @@ -49,19 +46,24 @@ class TestAuth(TestCase): def process_http_request_test(self): """ - Test the Authentication check routine with credentials. + Test the router control functionality """ - # GIVEN: A user and password in settings - cherrypy = MagicMock() - cherrypy.url.return_value = "nosetest/apl/poll" + # GIVEN: A testing set of Routes + mocked_function = MagicMock() + test_route = [ + (r'^/stage/api/poll$', mocked_function), + ] + self.router.routes = test_route - print cherrypy.url() + # WHEN: called with a poll route + self.router.process_http_request(u'/stage/api/poll', None) - with patch(u'url.path') as mocked_url: - mocked_url.return_value = "nosetest/apl/poll" - self.server._process_http_request(None, None) + # THEN: the function should have been called only once + assert mocked_function.call_count == 1, \ + u'The mocked function should have been matched and called once.' - self.assertFalse() + + #self.assertFalse() # WHEN: We run the function with no input #authenticated = check_credentials(u'', u'') From 6cd384e02824111db4a72a4fe7275193c52beec6 Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Fri, 29 Mar 2013 09:32:46 +0000 Subject: [PATCH 20/97] Fix up tests --- openlp/plugins/remotes/lib/httpserver.py | 41 +++++---- .../openlp_plugins/remotes/test_router.py | 58 ++++++++----- .../remotes/test_remoteserver.py | 85 ------------------- 3 files changed, 63 insertions(+), 121 deletions(-) delete mode 100644 tests/interfaces/openlp_plugins/remotes/test_remoteserver.py diff --git a/openlp/plugins/remotes/lib/httpserver.py b/openlp/plugins/remotes/lib/httpserver.py index f8a79899e..5a9e05042 100644 --- a/openlp/plugins/remotes/lib/httpserver.py +++ b/openlp/plugins/remotes/lib/httpserver.py @@ -127,28 +127,32 @@ from PyQt4 import QtCore from openlp.core.lib import Registry, Settings, PluginStatus, StringContent from openlp.core.utils import AppLocation, translate -from cherrypy._cpcompat import md5, sha, ntob +from cherrypy._cpcompat import sha, ntob log = logging.getLogger(__name__) def sha_password_encrypter(password): - + """ + Create an encrypted password for the given password. + """ return sha(ntob(password)).hexdigest() def fetch_password(username): + """ + Fetch the password for a provided user. + """ if username != Settings().value(u'remotes/user id'): return None - print "fetch password", username - return sha(ntob(Settings().value(u'remotes/password'))).hexdigest() + return sha_password_encrypter(Settings().value(u'remotes/password')) class HttpServer(object): """ Ability to control OpenLP via a web browser. + This class controls the Cherrypy server and configuration. """ - _cp_config = { 'tools.sessions.on': True, 'tools.auth.on': True @@ -167,7 +171,7 @@ class HttpServer(object): Start the http server based on configuration. """ log.debug(u'Start CherryPy server') - # Define to security levels and add the router code + # Define to security levels and inject the router code self.root = self.Public() self.root.files = self.Files() self.root.stage = self.Stage() @@ -180,6 +184,9 @@ class HttpServer(object): cherrypy.engine.start() def define_config(self): + """ + Define the configuration of the server. + """ if Settings().value(self.plugin.settings_section + u'/https enabled'): port = Settings().value(self.plugin.settings_section + u'/https port') address = Settings().value(self.plugin.settings_section + u'/ip address') @@ -209,14 +216,12 @@ class HttpServer(object): u'tools.basic_auth.on': False}} return directory_config - def reload_config(self): - cherrypy.tree.mount(self.root, '/', config=self.define_config()) - cherrypy.config.reset() - class Public: + """ + Main access class with may have security enabled on it. + """ @cherrypy.expose def default(self, *args, **kwargs): - print "public" self.router.request_data = None if isinstance(kwargs, dict): self.router.request_data = kwargs.get(u'data', None) @@ -224,13 +229,18 @@ class HttpServer(object): return self.router.process_http_request(url.path, *args) class Files: + """ + Provides access to files and has no security available. These are read only accesses + """ @cherrypy.expose def default(self, *args, **kwargs): - print "files" url = urlparse.urlparse(cherrypy.url()) return self.router.process_http_request(url.path, *args) class Stage: + """ + Stageview 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()) @@ -246,12 +256,11 @@ class HttpServer(object): class HttpRouter(object): """ - A single connection, this handles communication between the server and the client. + This code is called by the HttpServer upon a request and it processes it based on the routing table. """ - def __init__(self): """ - Initialise the CherryPy Server + Initialise the router """ self.routes = [ (u'^/$', self.serve_file), @@ -275,7 +284,7 @@ class HttpRouter(object): def process_http_request(self, url_path, *args): """ - Common function to process HTTP requests where secure or insecure + Common function to process HTTP requests """ response = None for route, func in self.routes: diff --git a/tests/functional/openlp_plugins/remotes/test_router.py b/tests/functional/openlp_plugins/remotes/test_router.py index 9604bc747..f86b69612 100644 --- a/tests/functional/openlp_plugins/remotes/test_router.py +++ b/tests/functional/openlp_plugins/remotes/test_router.py @@ -8,7 +8,7 @@ from tempfile import mkstemp from mock import patch, MagicMock from openlp.core.lib import Settings -from openlp.plugins.remotes.lib.httpserver import HttpRouter +from openlp.plugins.remotes.lib.httpserver import HttpRouter, fetch_password, sha_password_encrypter from PyQt4 import QtGui __default_settings__ = { @@ -44,6 +44,43 @@ class TestRouter(TestCase): del self.application os.unlink(self.ini_file) + def fetch_password_unknown_test(self): + """ + Test the fetch password code with an unknown userid + """ + # GIVEN: A default configuration + # WHEN: called with the defined userid + password = fetch_password(u'itwinkle') + print password + + # THEN: the function should return None + self.assertEqual(password, None, u'The result for fetch_password should be None') + + def fetch_password_known_test(self): + """ + Test the fetch password code with the defined userid + """ + # GIVEN: A default configuration + # WHEN: called with the defined userid + password = fetch_password(u'openlp') + required_password = sha_password_encrypter(u'password') + + # THEN: the function should return the correct password + self.assertEqual(password, required_password, u'The result for fetch_password should be the defined password') + + def sha_password_encrypter_test(self): + """ + Test hash password function + """ + # GIVEN: A default configuration + # WHEN: called with the defined userid + required_password = sha_password_encrypter(u'password') + test_value = '5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8' + + # THEN: the function should return the correct password + self.assertEqual(required_password, test_value, + u'The result for sha_password_encrypter should return the correct encrypted password') + def process_http_request_test(self): """ Test the router control functionality @@ -61,22 +98,3 @@ class TestRouter(TestCase): # THEN: the function should have been called only once assert mocked_function.call_count == 1, \ u'The mocked function should have been matched and called once.' - - - #self.assertFalse() - - # WHEN: We run the function with no input - #authenticated = check_credentials(u'', u'') - - # THEN: The authentication will fail with an error message - #self.assertEqual(authenticated, u'Incorrect username or password.', - # u'The return should be a error message string') - - # WHEN: We run the function with the correct input - #authenticated = check_credentials(u'twinkle', u'mongoose') - - # THEN: The authentication will pass. - #self.assertEqual(authenticated, None, u'The return should be a None string') - - - diff --git a/tests/interfaces/openlp_plugins/remotes/test_remoteserver.py b/tests/interfaces/openlp_plugins/remotes/test_remoteserver.py deleted file mode 100644 index ded7ca4c9..000000000 --- a/tests/interfaces/openlp_plugins/remotes/test_remoteserver.py +++ /dev/null @@ -1,85 +0,0 @@ -""" -This module contains tests for the lib submodule of the Remotes plugin. -""" -import os -from unittest import TestCase -from tempfile import mkstemp -from mock import patch, MagicMock - - -import urllib -from BeautifulSoup import BeautifulSoup, NavigableString, Tag - -from openlp.core.lib import Settings -from openlp.plugins.remotes.lib import HttpServer -from PyQt4 import QtGui - -__default_settings__ = { - u'remotes/twelve hour': True, - u'remotes/port': 4316, - u'remotes/https port': 4317, - u'remotes/https enabled': False, - u'remotes/user id': u'openlp', - u'remotes/password': u'password', - u'remotes/authentication enabled': False, - u'remotes/ip address': u'0.0.0.0' -} - -SESSION_KEY = '_cp_openlp' - - -class TestRemoteServer(TestCase): - """ - Test the functions in the :mod:`lib` module. - """ - def setUp(self): - """ - Create the UI - """ - fd, self.ini_file = mkstemp(u'.ini') - Settings().set_filename(self.ini_file) - self.application = QtGui.QApplication.instance() - Settings().extend_default_settings(__default_settings__) - self.server = HttpServer(self) - - def tearDown(self): - """ - Delete all the C++ objects at the end so that we don't have a segfault - """ - del self.application - os.unlink(self.ini_file) - os.unlink(Settings().fileName()) - self.server.close() - - def check_access_test(self): - """ - Test the Authentication check routine. - """ - # GIVEN: A user and password in settings - Settings().setValue(u'remotes/user id', u'twinkle') - Settings().setValue(u'remotes/password', u'mongoose') - - # WHEN: We run the function with no input - authenticated = check_credentials(u'', u'') - - # THEN: The authentication will fail with an error message - self.assertEqual(authenticated, u'Incorrect username or password.', - u'The return should be a error message string') - - # WHEN: We run the function with the correct input - authenticated = check_credentials(u'twinkle', u'mongoose') - - # THEN: The authentication will pass. - self.assertEqual(authenticated, None, u'The return should be a None string') - - def check_auth_inactive_test(self): - """ - Test the Authentication check routine. - """ - # GIVEN: A access which is secure - Settings().setValue(u'remotes/authentication enabled', True) - - # WHEN: We run the function with no input - f = urllib.urlopen("http://localhost:4316") - soup = BeautifulSoup(f.read()) - print soup.title.string From eb51590becf22cb7930fb6ebef049bcaa817697a Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Fri, 29 Mar 2013 09:39:41 +0000 Subject: [PATCH 21/97] Code cleanup ready for reviews --- openlp/plugins/remotes/html/login.css | 46 ----------------------- openlp/plugins/remotes/html/login.html | 48 ------------------------ openlp/plugins/remotes/lib/httpserver.py | 15 +++++--- openlp/plugins/remotes/lib/remotetab.py | 9 +++++ 4 files changed, 19 insertions(+), 99 deletions(-) delete mode 100644 openlp/plugins/remotes/html/login.css delete mode 100644 openlp/plugins/remotes/html/login.html diff --git a/openlp/plugins/remotes/html/login.css b/openlp/plugins/remotes/html/login.css deleted file mode 100644 index 3881b55ee..000000000 --- a/openlp/plugins/remotes/html/login.css +++ /dev/null @@ -1,46 +0,0 @@ -/****************************************************************************** -* 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 * -******************************************************************************/ - -.ui-icon-blank { - background-image: url(images/ui-icon-blank.png); -} - -.ui-icon-unblank { - background-image: url(images/ui-icon-unblank.png); -} - -/* Overwrite style from jquery-mobile.css */ -.ui-li .ui-btn-text a.ui-link-inherit{ - white-space: normal; -} - -.ui-page{ - padding: 100px 100px 100px 100px; - width: 300px; -} -.ui-input-text{ - width: 30px; -} \ No newline at end of file diff --git a/openlp/plugins/remotes/html/login.html b/openlp/plugins/remotes/html/login.html deleted file mode 100644 index 60c71166c..000000000 --- a/openlp/plugins/remotes/html/login.html +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - - ${title} - - - - - - - -

${message}

-

- User name:
- Password:
- - - diff --git a/openlp/plugins/remotes/lib/httpserver.py b/openlp/plugins/remotes/lib/httpserver.py index 5a9e05042..677ea3146 100644 --- a/openlp/plugins/remotes/lib/httpserver.py +++ b/openlp/plugins/remotes/lib/httpserver.py @@ -348,11 +348,7 @@ class HttpRouter(object): 'no_results': translate('RemotePlugin.Mobile', 'No Results'), 'options': translate('RemotePlugin.Mobile', 'Options'), 'service': translate('RemotePlugin.Mobile', 'Service'), - 'slides': translate('RemotePlugin.Mobile', 'Slides'), - 'title': translate('RemotePlugin.Mobile', 'OpenLP 2.1 User Login'), - 'from_page': "", - 'message': "", - 'username': "username" + 'slides': translate('RemotePlugin.Mobile', 'Slides') } def serve_file(self, filename=None): @@ -588,12 +584,21 @@ class HttpRouter(object): self._http_success() def _http_success(self): + """ + Set the HTTP success return code. + """ cherrypy.response.status = 200 def _http_bad_request(self): + """ + Set the HTTP bad response return code. + """ cherrypy.response.status = 400 def _http_not_found(self): + """ + Set the HTTP not found return code. + """ cherrypy.response.status = 404 cherrypy.response.body = ["Sorry, an error occurred "] diff --git a/openlp/plugins/remotes/lib/remotetab.py b/openlp/plugins/remotes/lib/remotetab.py index 658f5cfcf..685cd5882 100644 --- a/openlp/plugins/remotes/lib/remotetab.py +++ b/openlp/plugins/remotes/lib/remotetab.py @@ -181,6 +181,9 @@ class RemoteTab(SettingsTab): self.password_label.setText(translate('RemotePlugin.RemoteTab', 'Password:')) def set_urls(self): + """ + Update the display based on the data input on the screen + """ ip_address = u'localhost' if self.address_edit.text() == ZERO_URL: interfaces = QtNetwork.QNetworkInterface.allInterfaces() @@ -206,6 +209,9 @@ class RemoteTab(SettingsTab): self.stage_https_url.setText(u'%s' % (https_url, https_url)) def load(self): + """ + Load the configuration and update the server configuration if necessary + """ self.port_spin_box.setValue(Settings().value(self.settings_section + u'/port')) self.https_port_spin_box.setValue(Settings().value(self.settings_section + u'/https port')) self.address_edit.setText(Settings().value(self.settings_section + u'/ip address')) @@ -249,6 +255,9 @@ class RemoteTab(SettingsTab): Settings().setValue(self.settings_section + u'/password', self.password.text()) def on_twelve_hour_check_box_changed(self, check_state): + """ + Toggle the 12 hour check box. + """ self.twelve_hour = False # we have a set value convert to True/False if check_state == QtCore.Qt.Checked: From 28f8e31bf0223b206e94f622e791f0069a28275e Mon Sep 17 00:00:00 2001 From: Arjan Schrijver Date: Fri, 29 Mar 2013 13:00:06 +0100 Subject: [PATCH 22/97] Added a simple test for onResetClick() --- .../functional/openlp_plugins/images/test_lib.py | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/tests/functional/openlp_plugins/images/test_lib.py b/tests/functional/openlp_plugins/images/test_lib.py index a355e956b..6349745c2 100644 --- a/tests/functional/openlp_plugins/images/test_lib.py +++ b/tests/functional/openlp_plugins/images/test_lib.py @@ -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: @@ -110,3 +111,17 @@ class TestImageMediaItem(TestCase): # THEN: loadFullList() should not have been called assert self.media_item.manager.save_object.call_count == 2, \ u'loadFullList() should have been called only once' + + def on_reset_click_test(self): + """ + Test that onResetClick() actually resets the background + """ + # GIVEN: + self.media_item.resetAction = MagicMock() + + # WHEN: + self.media_item.onResetClick() + + # THEN: + self.media_item.resetAction.setVisible.assert_called_with(False) + self.media_item.live_controller.display.reset_image.assert_called_with() From e8dbbdfc896a68e9c353ef707254b8019e0c0ba2 Mon Sep 17 00:00:00 2001 From: Arjan Schrijver Date: Fri, 29 Mar 2013 15:15:16 +0100 Subject: [PATCH 23/97] Added a test for recursively_delete_group() --- .../openlp_plugins/images/test_lib.py | 59 ++++++++++++++++-- tests/interfaces/openlp_plugins/__init__.pyc | Bin 184 -> 0 bytes 2 files changed, 55 insertions(+), 4 deletions(-) delete mode 100644 tests/interfaces/openlp_plugins/__init__.pyc diff --git a/tests/functional/openlp_plugins/images/test_lib.py b/tests/functional/openlp_plugins/images/test_lib.py index 6349745c2..bdfe29373 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 @@ -116,12 +116,63 @@ class TestImageMediaItem(TestCase): """ Test that onResetClick() actually resets the background """ - # GIVEN: + # GIVEN: A mocked version of resetAction self.media_item.resetAction = MagicMock() - # WHEN: + # WHEN: onResetClick is called self.media_item.onResetClick() - # THEN: + # THEN: the resetAction should be set visible, and the image should be reset self.media_item.resetAction.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/interfaces/openlp_plugins/__init__.pyc b/tests/interfaces/openlp_plugins/__init__.pyc deleted file mode 100644 index 0d24c9eff54ac7d86f14523ef46194c4bbc24cad..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 184 zcmZ9GO$q`r423JY5W#!QX3Pa-@BpGC9-x#qGe-JH(*ZrLhY(zw0apgz3w(L-vV3nh zpI3LW>NgA72NAEtoKn|jCZ|SB{TUl!a7zKfL|4!-^d;TVR)%xNc Date: Fri, 29 Mar 2013 20:58:06 +0000 Subject: [PATCH 24/97] minor fixes and move certificate location --- openlp/core/utils/applocation.py | 7 +++---- openlp/plugins/remotes/lib/httpserver.py | 6 +++--- openlp/plugins/remotes/lib/remotetab.py | 6 +++--- tests/functional/openlp_plugins/remotes/__init__.py | 1 - tests/functional/openlp_plugins/remotes/test_router.py | 5 ++--- 5 files changed, 11 insertions(+), 14 deletions(-) diff --git a/openlp/core/utils/applocation.py b/openlp/core/utils/applocation.py index 4215cad22..2f1cb45ba 100644 --- a/openlp/core/utils/applocation.py +++ b/openlp/core/utils/applocation.py @@ -63,7 +63,6 @@ class AppLocation(object): VersionDir = 5 CacheDir = 6 LanguageDir = 7 - SharedData = 8 # Base path where data/config/cache dir is located BaseDir = None @@ -150,18 +149,18 @@ def _get_os_dir_path(dir_type): if sys.platform == u'win32': if dir_type == AppLocation.DataDir: return os.path.join(unicode(os.getenv(u'APPDATA'), encoding), u'openlp', u'data') - elif dir_type == AppLocation.LanguageDir or dir_type == AppLocation.SharedData: + elif dir_type == AppLocation.LanguageDir: return os.path.split(openlp.__file__)[0] return os.path.join(unicode(os.getenv(u'APPDATA'), encoding), u'openlp') elif sys.platform == u'darwin': if dir_type == AppLocation.DataDir: return os.path.join(unicode(os.getenv(u'HOME'), encoding), u'Library', u'Application Support', u'openlp', u'Data') - elif dir_type == AppLocation.LanguageDir or dir_type == AppLocation.SharedData: + elif dir_type == AppLocation.LanguageDir: return os.path.split(openlp.__file__)[0] return os.path.join(unicode(os.getenv(u'HOME'), encoding), u'Library', u'Application Support', u'openlp') else: - if dir_type == AppLocation.LanguageDir or dir_type == AppLocation.SharedData: + if dir_type == AppLocation.LanguageDir: prefixes = [u'/usr/local', u'/usr'] for prefix in prefixes: directory = os.path.join(prefix, u'share', u'openlp') diff --git a/openlp/plugins/remotes/lib/httpserver.py b/openlp/plugins/remotes/lib/httpserver.py index 677ea3146..51490bb38 100644 --- a/openlp/plugins/remotes/lib/httpserver.py +++ b/openlp/plugins/remotes/lib/httpserver.py @@ -190,11 +190,11 @@ class HttpServer(object): if Settings().value(self.plugin.settings_section + u'/https enabled'): port = Settings().value(self.plugin.settings_section + u'/https port') address = Settings().value(self.plugin.settings_section + u'/ip address') - shared_data = AppLocation.get_directory(AppLocation.SharedData) + local_data = AppLocation.get_directory(AppLocation.DataDir) cherrypy.config.update({u'server.socket_host': str(address), u'server.socket_port': port, - u'server.ssl_certificate': os.path.join(shared_data, u'openlp.crt'), - u'server.ssl_private_key': os.path.join(shared_data, u'openlp.key')}) + u'server.ssl_certificate': os.path.join(local_data, u'remotes', u'openlp.crt'), + u'server.ssl_private_key': os.path.join(local_data, u'remotes', u'openlp.key')}) else: port = Settings().value(self.plugin.settings_section + u'/port') address = Settings().value(self.plugin.settings_section + u'/ip address') diff --git a/openlp/plugins/remotes/lib/remotetab.py b/openlp/plugins/remotes/lib/remotetab.py index 685cd5882..09934b58c 100644 --- a/openlp/plugins/remotes/lib/remotetab.py +++ b/openlp/plugins/remotes/lib/remotetab.py @@ -217,9 +217,9 @@ class RemoteTab(SettingsTab): self.address_edit.setText(Settings().value(self.settings_section + u'/ip address')) self.twelve_hour = Settings().value(self.settings_section + u'/twelve hour') self.twelve_hour_check_box.setChecked(self.twelve_hour) - shared_data = AppLocation.get_directory(AppLocation.SharedData) - if not os.path.exists(os.path.join(shared_data, u'openlp.crt')) or \ - not os.path.exists(os.path.join(shared_data, u'openlp.key')): + local_data = AppLocation.get_directory(AppLocation.DataDir) + if not os.path.exists(os.path.join(local_data, u'remotes', u'openlp.crt')) or \ + not os.path.exists(os.path.join(local_data, u'remotes', u'openlp.key')): self.https_settings_group_box.setChecked(False) self.https_settings_group_box.setEnabled(False) self.https_error_label.setVisible(True) diff --git a/tests/functional/openlp_plugins/remotes/__init__.py b/tests/functional/openlp_plugins/remotes/__init__.py index f87606f07..e69de29bb 100644 --- a/tests/functional/openlp_plugins/remotes/__init__.py +++ b/tests/functional/openlp_plugins/remotes/__init__.py @@ -1 +0,0 @@ -__author__ = 'tim' diff --git a/tests/functional/openlp_plugins/remotes/test_router.py b/tests/functional/openlp_plugins/remotes/test_router.py index f86b69612..3b344c3b2 100644 --- a/tests/functional/openlp_plugins/remotes/test_router.py +++ b/tests/functional/openlp_plugins/remotes/test_router.py @@ -5,7 +5,7 @@ import os from unittest import TestCase from tempfile import mkstemp -from mock import patch, MagicMock +from mock import MagicMock from openlp.core.lib import Settings from openlp.plugins.remotes.lib.httpserver import HttpRouter, fetch_password, sha_password_encrypter @@ -51,7 +51,6 @@ class TestRouter(TestCase): # GIVEN: A default configuration # WHEN: called with the defined userid password = fetch_password(u'itwinkle') - print password # THEN: the function should return None self.assertEqual(password, None, u'The result for fetch_password should be None') @@ -75,7 +74,7 @@ class TestRouter(TestCase): # GIVEN: A default configuration # WHEN: called with the defined userid required_password = sha_password_encrypter(u'password') - test_value = '5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8' + test_value = u'5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8' # THEN: the function should return the correct password self.assertEqual(required_password, test_value, From 25d74260ce72f659edb5a6504d29b684f793e79b Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Sat, 30 Mar 2013 06:56:28 +0000 Subject: [PATCH 25/97] Add tests for the server --- openlp/plugins/bibles/lib/http.py | 3 + openlp/plugins/remotes/lib/httpserver.py | 14 +- openlp/plugins/remotes/remoteplugin.py | 2 +- .../openlp_core_lib/test_uistrings.py | 1 + tests/interfaces/openlp_plugins/__init__.pyc | Bin 184 -> 0 bytes .../openlp_plugins/remotes/test_server.py | 120 ++++++++++++++++++ 6 files changed, 132 insertions(+), 8 deletions(-) delete mode 100644 tests/interfaces/openlp_plugins/__init__.pyc create mode 100644 tests/interfaces/openlp_plugins/remotes/test_server.py diff --git a/openlp/plugins/bibles/lib/http.py b/openlp/plugins/bibles/lib/http.py index b01377a05..736727e20 100644 --- a/openlp/plugins/bibles/lib/http.py +++ b/openlp/plugins/bibles/lib/http.py @@ -55,6 +55,7 @@ UGLY_CHARS = { log = logging.getLogger(__name__) + class BGExtract(object): """ Extract verses from BibleGateway @@ -671,6 +672,7 @@ class HTTPBible(BibleDB): application = property(_get_application) + def get_soup_for_bible_ref(reference_url, header=None, pre_parse_regex=None, pre_parse_substitute=None, cleaner=None): """ @@ -715,6 +717,7 @@ def get_soup_for_bible_ref(reference_url, header=None, pre_parse_regex=None, Registry().get(u'application').process_events() return soup + def send_error_message(error_type): """ Send a standard error message informing the user of an issue. diff --git a/openlp/plugins/remotes/lib/httpserver.py b/openlp/plugins/remotes/lib/httpserver.py index 51490bb38..0489428ac 100644 --- a/openlp/plugins/remotes/lib/httpserver.py +++ b/openlp/plugins/remotes/lib/httpserver.py @@ -158,12 +158,12 @@ class HttpServer(object): 'tools.auth.on': True } - def __init__(self, plugin): + def __init__(self): """ Initialise the http server, and start the server. """ log.debug(u'Initialise httpserver') - self.plugin = plugin + self.settings_section = u'remotes' self.router = HttpRouter() def start_server(self): @@ -187,17 +187,17 @@ class HttpServer(object): """ Define the configuration of the server. """ - if Settings().value(self.plugin.settings_section + u'/https enabled'): - port = Settings().value(self.plugin.settings_section + u'/https port') - address = Settings().value(self.plugin.settings_section + u'/ip address') + if Settings().value(self.settings_section + u'/https enabled'): + port = Settings().value(self.settings_section + u'/https port') + address = Settings().value(self.settings_section + u'/ip address') local_data = AppLocation.get_directory(AppLocation.DataDir) cherrypy.config.update({u'server.socket_host': str(address), u'server.socket_port': port, u'server.ssl_certificate': os.path.join(local_data, u'remotes', u'openlp.crt'), u'server.ssl_private_key': os.path.join(local_data, u'remotes', u'openlp.key')}) else: - port = Settings().value(self.plugin.settings_section + u'/port') - address = Settings().value(self.plugin.settings_section + u'/ip address') + port = Settings().value(self.settings_section + u'/port') + address = Settings().value(self.settings_section + u'/ip address') cherrypy.config.update({u'server.socket_host': str(address)}) cherrypy.config.update({u'server.socket_port': port}) cherrypy.config.update({u'environment': u'embedded'}) diff --git a/openlp/plugins/remotes/remoteplugin.py b/openlp/plugins/remotes/remoteplugin.py index fd2906feb..f443fbda4 100644 --- a/openlp/plugins/remotes/remoteplugin.py +++ b/openlp/plugins/remotes/remoteplugin.py @@ -67,7 +67,7 @@ class RemotesPlugin(Plugin): """ log.debug(u'initialise') Plugin.initialise(self) - self.server = HttpServer(self) + self.server = HttpServer() self.server.start_server() def finalise(self): diff --git a/tests/functional/openlp_core_lib/test_uistrings.py b/tests/functional/openlp_core_lib/test_uistrings.py index 3351657d1..0070533db 100644 --- a/tests/functional/openlp_core_lib/test_uistrings.py +++ b/tests/functional/openlp_core_lib/test_uistrings.py @@ -6,6 +6,7 @@ from unittest import TestCase from openlp.core.lib import UiStrings + class TestUiStrings(TestCase): def check_same_instance_test(self): diff --git a/tests/interfaces/openlp_plugins/__init__.pyc b/tests/interfaces/openlp_plugins/__init__.pyc deleted file mode 100644 index 0d24c9eff54ac7d86f14523ef46194c4bbc24cad..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 184 zcmZ9GO$q`r423JY5W#!QX3Pa-@BpGC9-x#qGe-JH(*ZrLhY(zw0apgz3w(L-vV3nh zpI3LW>NgA72NAEtoKn|jCZ|SB{TUl!a7zKfL|4!-^d;TVR)%xNc Date: Sat, 30 Mar 2013 09:46:34 +0100 Subject: [PATCH 26/97] added test --- tests/functional/openlp_core_lib/test_lib.py | 4 ++-- tests/interfaces/openlp_plugins/__init__.pyc | Bin 184 -> 172 bytes .../custom/forms/test_customform.py | 18 ++++++++++++++++-- 3 files changed, 18 insertions(+), 4 deletions(-) diff --git a/tests/functional/openlp_core_lib/test_lib.py b/tests/functional/openlp_core_lib/test_lib.py index 66cb834f1..c03a11265 100644 --- a/tests/functional/openlp_core_lib/test_lib.py +++ b/tests/functional/openlp_core_lib/test_lib.py @@ -15,7 +15,7 @@ class TestLib(TestCase): """ Test the str_to_bool function with boolean input """ - #GIVEN: A boolean value set to true + # GIVEN: A boolean value set to true true_boolean = True # WHEN: We "convert" it to a bool @@ -25,7 +25,7 @@ class TestLib(TestCase): assert isinstance(true_result, bool), u'The result should be a boolean' assert true_result is True, u'The result should be True' - #GIVEN: A boolean value set to false + # GIVEN: A boolean value set to false false_boolean = False # WHEN: We "convert" it to a bool diff --git a/tests/interfaces/openlp_plugins/__init__.pyc b/tests/interfaces/openlp_plugins/__init__.pyc index 0d24c9eff54ac7d86f14523ef46194c4bbc24cad..c96ac5c5cba376cfa02ce1fb8f8faeb228d39122 100644 GIT binary patch delta 35 rcmdnNxQ3CP`7}HIi6YUhalS Date: Sat, 30 Mar 2013 10:46:32 +0100 Subject: [PATCH 27/97] fixed test order --- .../custom/forms/test_customform.py | 27 ++++++++++--------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/tests/interfaces/openlp_plugins/custom/forms/test_customform.py b/tests/interfaces/openlp_plugins/custom/forms/test_customform.py index d5de9bff9..417e52875 100644 --- a/tests/interfaces/openlp_plugins/custom/forms/test_customform.py +++ b/tests/interfaces/openlp_plugins/custom/forms/test_customform.py @@ -36,6 +36,20 @@ class TestCustomFrom(TestCase): del self.main_window del self.app + def load_themes_test(self): + """ + Test the load_themes() method. + """ + # GIVEN: A mocked QDialog.exec_() method + with patch(u'PyQt4.QtGui.QDialog.exec_') as mocked_exec: + theme_list = [u'First Theme', u'Second Theme'] + # WHEN: Show the dialog and add pass a theme list. + self.form.exec_() + self.form.load_themes(theme_list) + + # THEN: There should be three items in the combo box. + assert self.form.theme_combo_box.count() == 3, u'There should be three items (themes) in the combo box.' + def load_custom_test(self): """ Test the load_custom() method. @@ -63,16 +77,3 @@ class TestCustomFrom(TestCase): # THEN: One slide should be added. assert self.form.slide_list_view.count() == 1, u'There should be one slide added.' - def load_themes_test(self): - """ - Test the load_themes() method. - """ - # GIVEN: A mocked QDialog.exec_() method - with patch(u'PyQt4.QtGui.QDialog.exec_') as mocked_exec: - theme_list = [u'First Theme', u'Second Theme'] - # WHEN: Show the dialog and add pass a theme list. - self.form.exec_() - self.form.load_themes(theme_list) - - # THEN: There should be three items in the combo box. - assert self.form.theme_combo_box.count() == 3, u'There should be three items (themes) in the combo box.' From c732a70fb23ae83ae1a02dee8acb3141a5b31dff Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Sat, 30 Mar 2013 10:50:04 +0100 Subject: [PATCH 28/97] removed extra line --- tests/interfaces/openlp_plugins/custom/forms/test_customform.py | 1 - 1 file changed, 1 deletion(-) diff --git a/tests/interfaces/openlp_plugins/custom/forms/test_customform.py b/tests/interfaces/openlp_plugins/custom/forms/test_customform.py index 417e52875..5b15688ac 100644 --- a/tests/interfaces/openlp_plugins/custom/forms/test_customform.py +++ b/tests/interfaces/openlp_plugins/custom/forms/test_customform.py @@ -76,4 +76,3 @@ class TestCustomFrom(TestCase): QtTest.QTest.mouseClick(self.form.add_button, QtCore.Qt.LeftButton) # THEN: One slide should be added. assert self.form.slide_list_view.count() == 1, u'There should be one slide added.' - From a0eed25c6450b314a295bb4b7f167121610c9bd7 Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Sun, 31 Mar 2013 19:20:53 +0200 Subject: [PATCH 29/97] remove pyc --- tests/interfaces/openlp_plugins/__init__.pyc | Bin 172 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 tests/interfaces/openlp_plugins/__init__.pyc diff --git a/tests/interfaces/openlp_plugins/__init__.pyc b/tests/interfaces/openlp_plugins/__init__.pyc deleted file mode 100644 index c96ac5c5cba376cfa02ce1fb8f8faeb228d39122..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 172 zcmZSn%*(~JG%PTg0SXv_v;zAHr7#>Pg*=K3Y6#XyP7ypq(Sw8Z4pV*Pxenw*08 pf}GOy%)Da#`1s7c%#!$cy@JXT4xq_4x%nxjIjMFa`-_2?0RVP?DE|Ne From e3afbefd27de25b73ef411e5b8ec2471d0f55116 Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Tue, 2 Apr 2013 16:42:33 +0200 Subject: [PATCH 30/97] use QDate instead of python datetime object --- openlp/core/lib/settings.py | 2 +- openlp/core/utils/__init__.py | 3 +-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/openlp/core/lib/settings.py b/openlp/core/lib/settings.py index 30a8b25d8..d55e386d6 100644 --- a/openlp/core/lib/settings.py +++ b/openlp/core/lib/settings.py @@ -126,7 +126,7 @@ class Settings(QtCore.QSettings): u'general/has run wizard': False, u'general/language': u'[en]', # This defaults to yesterday in order to force the update check to run when you've never run it before. - u'general/last version test': datetime.datetime.now().date() - datetime.timedelta(days=1), + u'general/last version test': QtCore.QDate.currentDate().addDays(-1), u'general/loop delay': 5, u'general/recent files': [], u'general/save prompt': False, diff --git a/openlp/core/utils/__init__.py b/openlp/core/utils/__init__.py index d32729699..efe623405 100644 --- a/openlp/core/utils/__init__.py +++ b/openlp/core/utils/__init__.py @@ -29,7 +29,6 @@ """ The :mod:`openlp.core.utils` module provides the utility libraries for OpenLP. """ -from datetime import datetime from distutils.version import LooseVersion import logging import locale @@ -184,7 +183,7 @@ def check_latest_version(current_version): settings = Settings() settings.beginGroup(u'general') last_test = settings.value(u'last version test') - this_test = datetime.now().date() + this_test = QtCore.QDate.currentDate() settings.setValue(u'last version test', this_test) settings.endGroup() # Tell the main window whether there will ever be data to display From 5e3563ceda08f60380b68019d566bbe883ddc2e7 Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Tue, 2 Apr 2013 17:08:46 +0200 Subject: [PATCH 31/97] added two tests --- openlp/core/utils/__init__.py | 3 +- .../openlp_core_utils/test_utils.py | 49 ++++++++++++++++++- 2 files changed, 49 insertions(+), 3 deletions(-) diff --git a/openlp/core/utils/__init__.py b/openlp/core/utils/__init__.py index efe623405..81716a9c9 100644 --- a/openlp/core/utils/__init__.py +++ b/openlp/core/utils/__init__.py @@ -243,8 +243,7 @@ def get_images_filter(): global IMAGES_FILTER if not IMAGES_FILTER: log.debug(u'Generating images filter.') - formats = [unicode(fmt) - for fmt in QtGui.QImageReader.supportedImageFormats()] + formats == QtGui.QImageReader.supportedImageFormats() visible_formats = u'(*.%s)' % u'; *.'.join(formats) actual_formats = u'(*.%s)' % u' *.'.join(formats) IMAGES_FILTER = u'%s %s %s' % (translate('OpenLP', 'Image Files'), visible_formats, actual_formats) diff --git a/tests/functional/openlp_core_utils/test_utils.py b/tests/functional/openlp_core_utils/test_utils.py index 2e826bc61..71922beec 100644 --- a/tests/functional/openlp_core_utils/test_utils.py +++ b/tests/functional/openlp_core_utils/test_utils.py @@ -5,7 +5,7 @@ from unittest import TestCase from mock import patch -from openlp.core.utils import get_filesystem_encoding, _get_frozen_path +from openlp.core.utils import get_filesystem_encoding, _get_frozen_path, clean_filename, split_filename class TestUtils(TestCase): """ @@ -56,3 +56,50 @@ class TestUtils(TestCase): # THEN: The frozen parameter is returned assert _get_frozen_path(u'frozen', u'not frozen') == u'frozen', u'Should return "frozen"' + def split_filename_with_file_path_test(self): + """ + Test the split_filename() function with a path to a file + """ + # GIVEN: A path to a file. + file_path = u'/home/user/myfile.txt' + wanted_result = (u'/home/user', u'myfile.txt') + with patch(u'openlp.core.utils.os.path.isfile') as mocked_is_file: + mocked_is_file.return_value = True + + # WHEN: Split the file name. + result = split_filename(file_path) + + # THEN: A tuple should be returned. + assert result == wanted_result, u'A tuple with the directory and file should have been returned.' + + def split_filename_with_dir_path_test(self): + """ + Test the split_filename() function with a path to a directory. + """ + # GIVEN: A path to a dir. + file_path = u'/home/user/mydir' + wanted_result = (u'/home/user/mydir', u'') + with patch(u'openlp.core.utils.os.path.isfile') as mocked_is_file: + mocked_is_file.return_value = False + + # WHEN: Split the file name. + result = split_filename(file_path) + + # THEN: A tuple should be returned. + assert result == wanted_result, \ + u'A two-entry tuple with the directory and file (empty) should have been returned.' + + + def clean_filename_test(self): + """ + Test the clean_filename() function + """ + # GIVEN: A invalid file name and the valid file name. + invalid_name = u'A_file_with_invalid_characters_[\\/:\*\?"<>\|\+\[\]%].py' + wanted_name = u'A_file_with_invalid_characters______________________.py' + + # WHEN: Clean the name. + result = clean_filename(invalid_name) + + # THEN: The file name should be cleaned. + assert result == wanted_name, u'The file name should be valid.' From 0d621f86991f42df0474d4e39fdf5708a8bcb803 Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Tue, 2 Apr 2013 17:14:27 +0200 Subject: [PATCH 32/97] changed assertion message --- tests/functional/openlp_core_utils/test_utils.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/functional/openlp_core_utils/test_utils.py b/tests/functional/openlp_core_utils/test_utils.py index 71922beec..fd1aaa84e 100644 --- a/tests/functional/openlp_core_utils/test_utils.py +++ b/tests/functional/openlp_core_utils/test_utils.py @@ -102,4 +102,4 @@ class TestUtils(TestCase): result = clean_filename(invalid_name) # THEN: The file name should be cleaned. - assert result == wanted_name, u'The file name should be valid.' + assert result == wanted_name, u'The file name should not contain any special characters.' From 7f111b31a7058f13afe9ddaba826397fbab4072d Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Tue, 2 Apr 2013 17:24:27 +0200 Subject: [PATCH 33/97] use unicode instead of QDateTime --- openlp/core/lib/settings.py | 3 +-- openlp/core/utils/__init__.py | 3 ++- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/openlp/core/lib/settings.py b/openlp/core/lib/settings.py index d55e386d6..50b1318b6 100644 --- a/openlp/core/lib/settings.py +++ b/openlp/core/lib/settings.py @@ -125,8 +125,7 @@ class Settings(QtCore.QSettings): u'general/ccli number': u'', u'general/has run wizard': False, u'general/language': u'[en]', - # This defaults to yesterday in order to force the update check to run when you've never run it before. - u'general/last version test': QtCore.QDate.currentDate().addDays(-1), + u'general/last version test': u'', u'general/loop delay': 5, u'general/recent files': [], u'general/save prompt': False, diff --git a/openlp/core/utils/__init__.py b/openlp/core/utils/__init__.py index 81716a9c9..ba3e06e58 100644 --- a/openlp/core/utils/__init__.py +++ b/openlp/core/utils/__init__.py @@ -29,6 +29,7 @@ """ The :mod:`openlp.core.utils` module provides the utility libraries for OpenLP. """ +from datetime import datetime from distutils.version import LooseVersion import logging import locale @@ -183,7 +184,7 @@ def check_latest_version(current_version): settings = Settings() settings.beginGroup(u'general') last_test = settings.value(u'last version test') - this_test = QtCore.QDate.currentDate() + this_test = unicode(datetime.now().date()) settings.setValue(u'last version test', this_test) settings.endGroup() # Tell the main window whether there will ever be data to display From ffb2350f62f4c9ce33973b202101ab75588b3b4f Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Tue, 2 Apr 2013 19:42:01 +0200 Subject: [PATCH 34/97] fix *cough* --- openlp/core/utils/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openlp/core/utils/__init__.py b/openlp/core/utils/__init__.py index ba3e06e58..9cd8f8c81 100644 --- a/openlp/core/utils/__init__.py +++ b/openlp/core/utils/__init__.py @@ -244,7 +244,7 @@ def get_images_filter(): global IMAGES_FILTER if not IMAGES_FILTER: log.debug(u'Generating images filter.') - formats == QtGui.QImageReader.supportedImageFormats() + formats = QtGui.QImageReader.supportedImageFormats() visible_formats = u'(*.%s)' % u'; *.'.join(formats) actual_formats = u'(*.%s)' % u' *.'.join(formats) IMAGES_FILTER = u'%s %s %s' % (translate('OpenLP', 'Image Files'), visible_formats, actual_formats) From 03eaa91a08776671ea4358524ade159fd761c79f Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Tue, 2 Apr 2013 23:03:07 +0200 Subject: [PATCH 35/97] fixed assertion message and method doc string --- tests/functional/openlp_core_utils/test_utils.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tests/functional/openlp_core_utils/test_utils.py b/tests/functional/openlp_core_utils/test_utils.py index fd1aaa84e..6d95c6583 100644 --- a/tests/functional/openlp_core_utils/test_utils.py +++ b/tests/functional/openlp_core_utils/test_utils.py @@ -70,11 +70,11 @@ class TestUtils(TestCase): result = split_filename(file_path) # THEN: A tuple should be returned. - assert result == wanted_result, u'A tuple with the directory and file should have been returned.' + assert result == wanted_result, u'A tuple with the directory and file name should have been returned.' def split_filename_with_dir_path_test(self): """ - Test the split_filename() function with a path to a directory. + Test the split_filename() function with a path to a directory """ # GIVEN: A path to a dir. file_path = u'/home/user/mydir' @@ -87,7 +87,7 @@ class TestUtils(TestCase): # THEN: A tuple should be returned. assert result == wanted_result, \ - u'A two-entry tuple with the directory and file (empty) should have been returned.' + u'A two-entry tuple with the directory and file name (empty) should have been returned.' def clean_filename_test(self): From fc80e3d106dacb89621e323e00cb1f9f976266df Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Fri, 5 Apr 2013 20:37:15 +0100 Subject: [PATCH 36/97] Cleanups and more tests --- openlp/core/lib/plugin.py | 4 +- openlp/core/lib/pluginmanager.py | 2 +- openlp/plugins/media/mediaplugin.py | 2 +- .../presentations/presentationplugin.py | 2 +- .../openlp_core_lib/test_pluginmanager.py | 12 +- .../openlp_core_utils/test_applocation.py | 10 ++ .../openlp_plugins/remotes/test_remotetab.py | 108 ++++++++++++++++++ tests/resources/remotes/openlp.crt | 0 tests/resources/remotes/openlp.key | 0 9 files changed, 129 insertions(+), 11 deletions(-) create mode 100644 tests/functional/openlp_plugins/remotes/test_remotetab.py create mode 100644 tests/resources/remotes/openlp.crt create mode 100644 tests/resources/remotes/openlp.key diff --git a/openlp/core/lib/plugin.py b/openlp/core/lib/plugin.py index dd9843930..b4f851b24 100644 --- a/openlp/core/lib/plugin.py +++ b/openlp/core/lib/plugin.py @@ -103,7 +103,7 @@ class Plugin(QtCore.QObject): ``add_export_menu_Item(export_menu)`` Add an item to the Export menu. - ``create_settings_Tab()`` + ``create_settings_tab()`` Creates a new instance of SettingsTabItem to be used in the Settings dialog. @@ -252,7 +252,7 @@ class Plugin(QtCore.QObject): """ pass - def create_settings_Tab(self, parent): + def create_settings_tab(self, parent): """ Create a tab for the settings window to display the configurable options for this plugin to the user. diff --git a/openlp/core/lib/pluginmanager.py b/openlp/core/lib/pluginmanager.py index 8fc294ea6..db96e3fa7 100644 --- a/openlp/core/lib/pluginmanager.py +++ b/openlp/core/lib/pluginmanager.py @@ -153,7 +153,7 @@ class PluginManager(object): """ for plugin in self.plugins: if plugin.status is not PluginStatus.Disabled: - plugin.create_settings_Tab(self.settings_form) + plugin.create_settings_tab(self.settings_form) def hook_import_menu(self): """ diff --git a/openlp/plugins/media/mediaplugin.py b/openlp/plugins/media/mediaplugin.py index 3e685f4c6..4bc5314ff 100644 --- a/openlp/plugins/media/mediaplugin.py +++ b/openlp/plugins/media/mediaplugin.py @@ -54,7 +54,7 @@ class MediaPlugin(Plugin): # passed with drag and drop messages self.dnd_id = u'Media' - def create_settings_Tab(self, parent): + def create_settings_tab(self, parent): """ Create the settings Tab """ diff --git a/openlp/plugins/presentations/presentationplugin.py b/openlp/plugins/presentations/presentationplugin.py index 7872c25b7..5bc95e388 100644 --- a/openlp/plugins/presentations/presentationplugin.py +++ b/openlp/plugins/presentations/presentationplugin.py @@ -69,7 +69,7 @@ class PresentationPlugin(Plugin): self.icon_path = u':/plugins/plugin_presentations.png' self.icon = build_icon(self.icon_path) - def create_settings_Tab(self, parent): + def create_settings_tab(self, parent): """ Create the settings Tab """ diff --git a/tests/functional/openlp_core_lib/test_pluginmanager.py b/tests/functional/openlp_core_lib/test_pluginmanager.py index 9d6c30f8e..8317e78dc 100644 --- a/tests/functional/openlp_core_lib/test_pluginmanager.py +++ b/tests/functional/openlp_core_lib/test_pluginmanager.py @@ -74,7 +74,7 @@ class TestPluginManager(TestCase): # WHEN: We run hook_settings_tabs() plugin_manager.hook_settings_tabs() - # THEN: The create_settings_Tab() method should have been called + # THEN: The hook_settings_tabs() method should have been called assert mocked_plugin.create_media_manager_item.call_count == 0, \ u'The create_media_manager_item() method should not have been called.' @@ -94,8 +94,8 @@ class TestPluginManager(TestCase): # WHEN: We run hook_settings_tabs() plugin_manager.hook_settings_tabs() - # THEN: The create_settings_Tab() method should not have been called, but the plugins lists should be the same - assert mocked_plugin.create_settings_Tab.call_count == 0, \ + # THEN: The create_settings_tab() method should not have been called, but the plugins lists should be the same + assert mocked_plugin.create_settings_tab.call_count == 0, \ u'The create_media_manager_item() method should not have been called.' self.assertEqual(mocked_settings_form.plugin_manager.plugins, plugin_manager.plugins, u'The plugins on the settings form should be the same as the plugins in the plugin manager') @@ -117,7 +117,7 @@ class TestPluginManager(TestCase): plugin_manager.hook_settings_tabs() # THEN: The create_media_manager_item() method should have been called with the mocked settings form - assert mocked_plugin.create_settings_Tab.call_count == 1, \ + assert mocked_plugin.create_settings_tab.call_count == 1, \ u'The create_media_manager_item() method should have been called once.' self.assertEqual(mocked_settings_form.plugin_manager.plugins, plugin_manager.plugins, u'The plugins on the settings form should be the same as the plugins in the plugin manager') @@ -135,8 +135,8 @@ class TestPluginManager(TestCase): # WHEN: We run hook_settings_tabs() plugin_manager.hook_settings_tabs() - # THEN: The create_settings_Tab() method should have been called - mocked_plugin.create_settings_Tab.assert_called_with(self.mocked_settings_form) + # THEN: The create_settings_tab() method should have been called + mocked_plugin.create_settings_tab.assert_called_with(self.mocked_settings_form) def hook_import_menu_with_disabled_plugin_test(self): """ diff --git a/tests/functional/openlp_core_utils/test_applocation.py b/tests/functional/openlp_core_utils/test_applocation.py index 5473da8c0..b59f41f37 100644 --- a/tests/functional/openlp_core_utils/test_applocation.py +++ b/tests/functional/openlp_core_utils/test_applocation.py @@ -30,8 +30,10 @@ class TestAppLocation(TestCase): mocked_get_directory.return_value = u'test/dir' mocked_check_directory_exists.return_value = True mocked_os.path.normpath.return_value = u'test/dir' + # WHEN: we call AppLocation.get_data_path() data_path = AppLocation.get_data_path() + # THEN: check that all the correct methods were called, and the result is correct mocked_settings.contains.assert_called_with(u'advanced/data path') mocked_get_directory.assert_called_with(AppLocation.DataDir) @@ -49,8 +51,10 @@ class TestAppLocation(TestCase): mocked_settings.contains.return_value = True mocked_settings.value.return_value.toString.return_value = u'custom/dir' mocked_os.path.normpath.return_value = u'custom/dir' + # WHEN: we call AppLocation.get_data_path() data_path = AppLocation.get_data_path() + # THEN: the mocked Settings methods were called and the value returned was our set up value mocked_settings.contains.assert_called_with(u'advanced/data path') mocked_settings.value.assert_called_with(u'advanced/data path') @@ -100,8 +104,10 @@ class TestAppLocation(TestCase): # GIVEN: A mocked out AppLocation.get_data_path() mocked_get_data_path.return_value = u'test/dir' mocked_check_directory_exists.return_value = True + # WHEN: we call AppLocation.get_data_path() data_path = AppLocation.get_section_data_path(u'section') + # THEN: check that all the correct methods were called, and the result is correct mocked_check_directory_exists.assert_called_with(u'test/dir/section') assert data_path == u'test/dir/section', u'Result should be "test/dir/section"' @@ -112,8 +118,10 @@ class TestAppLocation(TestCase): """ with patch(u'openlp.core.utils.applocation._get_frozen_path') as mocked_get_frozen_path: mocked_get_frozen_path.return_value = u'app/dir' + # WHEN: We call AppLocation.get_directory directory = AppLocation.get_directory(AppLocation.AppDir) + # THEN: assert directory == u'app/dir', u'Directory should be "app/dir"' @@ -130,8 +138,10 @@ class TestAppLocation(TestCase): mocked_get_frozen_path.return_value = u'plugins/dir' mocked_sys.frozen = 1 mocked_sys.argv = ['openlp'] + # WHEN: We call AppLocation.get_directory directory = AppLocation.get_directory(AppLocation.PluginsDir) + # THEN: assert directory == u'plugins/dir', u'Directory should be "plugins/dir"' diff --git a/tests/functional/openlp_plugins/remotes/test_remotetab.py b/tests/functional/openlp_plugins/remotes/test_remotetab.py new file mode 100644 index 000000000..22bee8139 --- /dev/null +++ b/tests/functional/openlp_plugins/remotes/test_remotetab.py @@ -0,0 +1,108 @@ +""" +This module contains tests for the lib submodule of the Remotes plugin. +""" +import os + +from unittest import TestCase +from tempfile import mkstemp +from mock import patch + +from openlp.core.lib import Settings +from openlp.plugins.remotes.lib.remotetab import RemoteTab + +from PyQt4 import QtGui + +__default_settings__ = { + u'remotes/twelve hour': True, + u'remotes/port': 4316, + u'remotes/https port': 4317, + u'remotes/https enabled': False, + u'remotes/user id': u'openlp', + u'remotes/password': u'password', + u'remotes/authentication enabled': False, + u'remotes/ip address': u'0.0.0.0' +} + +ZERO_URL = u'0.0.0.0' + +TEST_PATH = os.path.abspath(os.path.join(os.path.dirname(__file__), u'..', u'..', u'..', u'resources')) + + +class TestRemoteTab(TestCase): + """ + Test the functions in the :mod:`lib` module. + """ + def setUp(self): + """ + Create the UI + """ + fd, self.ini_file = mkstemp(u'.ini') + Settings().set_filename(self.ini_file) + self.application = QtGui.QApplication.instance() + Settings().extend_default_settings(__default_settings__) + self.parent = QtGui.QMainWindow() + self.form = RemoteTab(self.parent, u'Remotes', None, None) + + def tearDown(self): + """ + Delete all the C++ objects at the end so that we don't have a segfault + """ + del self.application + del self.parent + del self.form + os.unlink(self.ini_file) + + def set_basic_urls_test(self): + """ + Test the set_urls function with standard defaults + """ + # GIVEN: A mocked location + with patch(u'openlp.core.utils.applocation.Settings') as mocked_class, \ + patch(u'openlp.core.utils.AppLocation.get_directory') as mocked_get_directory, \ + patch(u'openlp.core.utils.applocation.check_directory_exists') as mocked_check_directory_exists, \ + patch(u'openlp.core.utils.applocation.os') as mocked_os: + # GIVEN: A mocked out Settings class and a mocked out AppLocation.get_directory() + mocked_settings = mocked_class.return_value + mocked_settings.contains.return_value = False + mocked_get_directory.return_value = u'test/dir' + mocked_check_directory_exists.return_value = True + mocked_os.path.normpath.return_value = u'test/dir' + + # WHEN: when the set_urls is called having reloaded the form. + self.form.load() + self.form.set_urls() + # THEN: the following screen values should be set + self.assertEqual(self.form.address_edit.text(), ZERO_URL, u'The default URL should be set on the screen') + self.assertEqual(self.form.https_settings_group_box.isEnabled(), False, + u'The Https box should not be enabled') + self.assertEqual(self.form.https_settings_group_box.isChecked(), False, + u'The Https checked box should note be Checked') + self.assertEqual(self.form.user_login_group_box.isChecked(), False, + u'The authentication box should not be enabled') + + def set_certificate_urls_test(self): + """ + Test the set_urls function with certificate available + """ + # GIVEN: A mocked location + with patch(u'openlp.core.utils.applocation.Settings') as mocked_class, \ + patch(u'openlp.core.utils.AppLocation.get_directory') as mocked_get_directory, \ + patch(u'openlp.core.utils.applocation.check_directory_exists') as mocked_check_directory_exists, \ + patch(u'openlp.core.utils.applocation.os') as mocked_os: + # GIVEN: A mocked out Settings class and a mocked out AppLocation.get_directory() + mocked_settings = mocked_class.return_value + mocked_settings.contains.return_value = False + mocked_get_directory.return_value = TEST_PATH + mocked_check_directory_exists.return_value = True + mocked_os.path.normpath.return_value = TEST_PATH + + # WHEN: when the set_urls is called having reloaded the form. + self.form.load() + self.form.set_urls() + # THEN: the following screen values should be set + self.assertEqual(self.form.http_settings_group_box.isEnabled(), True, + u'The Http group box should be enabled') + self.assertEqual(self.form.https_settings_group_box.isChecked(), False, + u'The Https checked box should be Checked') + self.assertEqual(self.form.https_settings_group_box.isEnabled(), True, + u'The Https box should be enabled') diff --git a/tests/resources/remotes/openlp.crt b/tests/resources/remotes/openlp.crt new file mode 100644 index 000000000..e69de29bb diff --git a/tests/resources/remotes/openlp.key b/tests/resources/remotes/openlp.key new file mode 100644 index 000000000..e69de29bb From 69009970c07641217ea2c1a8eee8810152b01812 Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Fri, 5 Apr 2013 21:58:13 +0200 Subject: [PATCH 37/97] replaced BeautifulSoup3 by BeautifulSoup4 --- openlp/core/ui/exceptionform.py | 2 +- openlp/plugins/bibles/lib/http.py | 106 ++++++++++++++---------------- scripts/check_dependencies.py | 2 +- 3 files changed, 52 insertions(+), 58 deletions(-) diff --git a/openlp/core/ui/exceptionform.py b/openlp/core/ui/exceptionform.py index 25f8201b1..f7dc83d29 100644 --- a/openlp/core/ui/exceptionform.py +++ b/openlp/core/ui/exceptionform.py @@ -35,7 +35,7 @@ import os import platform import sqlalchemy -import BeautifulSoup +from bs4 import BeautifulSoup from lxml import etree from PyQt4 import Qt, QtCore, QtGui, QtWebKit diff --git a/openlp/plugins/bibles/lib/http.py b/openlp/plugins/bibles/lib/http.py index b01377a05..390ac1cd9 100644 --- a/openlp/plugins/bibles/lib/http.py +++ b/openlp/plugins/bibles/lib/http.py @@ -36,7 +36,7 @@ import socket import urllib from HTMLParser import HTMLParseError -from BeautifulSoup import BeautifulSoup, NavigableString, Tag +from bs4 import BeautifulSoup, NavigableString, Tag from openlp.core.lib import Registry, translate from openlp.core.lib.ui import critical_error_message_box @@ -44,6 +44,9 @@ from openlp.core.utils import get_web_page from openlp.plugins.bibles.lib import SearchResults from openlp.plugins.bibles.lib.db import BibleDB, BiblesResourcesDB, Book +CLEANER_REGEX = re.compile(' |
|\'\+\'') +FIX_PUNKCTUATION_REGEX = re.compile(r'[ ]+([.,;])') +REDUCE_SPACES_REGEX = re.compile(r'[ ]{2,}') UGLY_CHARS = { u'\u2014': u' - ', u'\u2018': u'\'', @@ -52,9 +55,12 @@ UGLY_CHARS = { u'\u201d': u'"', u' ': u' ' } +VERSE_NUMBER_REGEX = re.compile(r'v(\d{1,2})(\d{3})(\d{3}) verse.*') + log = logging.getLogger(__name__) + class BGExtract(object): """ Extract verses from BibleGateway @@ -78,9 +84,9 @@ class BGExtract(object): An HTML class attribute for further qualification. """ if class_: - all_tags = parent.findAll(tag, class_) + all_tags = parent.find_all(tag, class_) else: - all_tags = parent.findAll(tag) + all_tags = parent.find_all(tag) for element in all_tags: element.extract() @@ -173,8 +179,8 @@ class BGExtract(object): def _extract_verses_old(self, div): """ - Use the old style of parsing for those Bibles on BG who mysteriously - have not been migrated to the new (still broken) HTML. + Use the old style of parsing for those Bibles on BG who mysteriously have not been migrated to the new (still + broken) HTML. ``div`` The parent div. @@ -185,13 +191,12 @@ class BGExtract(object): if first_verse and first_verse.contents: verse_list[1] = unicode(first_verse.contents[0]) for verse in div(u'sup', u'versenum'): - raw_verse_num = verse.next + raw_verse_num = verse.next_element clean_verse_num = 0 - # Not all verses exist in all translations and may or may not be - # represented by a verse number. If they are not fine, if they are - # it will probably be in a format that breaks int(). We will then - # have no idea what garbage may be sucked in to the verse text so - # if we do not get a clean int() then ignore the verse completely. + # Not all verses exist in all translations and may or may not be represented by a verse number. If they are + # not fine, if they are it will probably be in a format that breaks int(). We will then have no idea what + # garbage may be sucked in to the verse text so if we do not get a clean int() then ignore the verse + # completely. try: clean_verse_num = int(str(raw_verse_num)) except ValueError: @@ -201,16 +206,16 @@ class BGExtract(object): except TypeError: log.warn(u'Illegal verse number: %s', unicode(raw_verse_num)) if clean_verse_num: - verse_text = raw_verse_num.next - part = raw_verse_num.next.next + verse_text = raw_verse_num.next_element + part = raw_verse_num.next_element.next_element while not (isinstance(part, Tag) and part.get(u'class') == u'versenum'): # While we are still in the same verse grab all the text. if isinstance(part, NavigableString): verse_text += part - if isinstance(part.next, Tag) and part.next.name == u'div': + if isinstance(part.next_element, Tag) and part.next_element.name == u'div': # Run out of verses so stop. break - part = part.next + part = part.next_element verse_list[clean_verse_num] = unicode(verse_text) return verse_list @@ -230,7 +235,7 @@ class BGExtract(object): log.debug(u'BGExtract.get_bible_chapter("%s", "%s", "%s")', version, book_name, chapter) url_book_name = urllib.quote(book_name.encode("utf-8")) url_params = u'search=%s+%s&version=%s' % (url_book_name, chapter, version) - cleaner = [(re.compile(' |
|\'\+\''), lambda match: '')] + cleaner = [(CLEANER_REGEX, lambda match: '')] soup = get_soup_for_bible_ref( u'http://www.biblegateway.com/passage/?%s' % url_params, pre_parse_regex=r'', pre_parse_substitute='', cleaner=cleaner) @@ -238,7 +243,7 @@ class BGExtract(object): return None div = soup.find('div', 'result-text-style-normal') self._clean_soup(div) - span_list = div.findAll('span', 'text') + span_list = div.find_all('span', 'text') log.debug('Span list: %s', span_list) if not span_list: # If we don't get any spans then we must have the old HTML format @@ -282,7 +287,7 @@ class BGExtract(object): self.application.process_events() content = soup.find(u'table', u'infotable') if content: - content = content.findAll(u'tr') + content = content.find_all(u'tr') if not content: log.error(u'No books found in the Biblegateway response.') send_error_message(u'parse') @@ -341,19 +346,17 @@ class BSExtract(object): log.error(u'No verses found in the Bibleserver response.') send_error_message(u'parse') return None - content = content.find(u'div').findAll(u'div') - verse_number = re.compile(r'v(\d{1,2})(\d{3})(\d{3}) verse.*') + content = content.find(u'div').find_all(u'div') verses = {} for verse in content: self.application.process_events() - versenumber = int(verse_number.sub(r'\3', verse[u'class'])) + versenumber = int(VERSE_NUMBER_REGEX.sub(r'\3', verse[u'class'])) verses[versenumber] = verse.contents[1].rstrip(u'\n') return SearchResults(book_name, chapter, verses) def get_books_from_http(self, version): """ - Load a list of all books a Bible contains from Bibleserver mobile - website. + Load a list of all books a Bible contains from Bibleserver mobile website. ``version`` The version of the Bible like NIV for New International Version @@ -369,7 +372,7 @@ class BSExtract(object): log.error(u'No books found in the Bibleserver response.') send_error_message(u'parse') return None - content = content.findAll(u'li') + content = content.find_all(u'li') return [book.contents[0].contents[0] for book in content] @@ -404,14 +407,12 @@ class CWExtract(object): if not soup: return None self.application.process_events() - html_verses = soup.findAll(u'span', u'versetext') + html_verses = soup.find_all(u'span', u'versetext') if not html_verses: log.error(u'No verses found in the CrossWalk response.') send_error_message(u'parse') return None verses = {} - reduce_spaces = re.compile(r'[ ]{2,}') - fix_punctuation = re.compile(r'[ ]+([.,;])') for verse in html_verses: self.application.process_events() verse_number = int(verse.contents[0].contents[0]) @@ -432,11 +433,10 @@ class CWExtract(object): if isinstance(subsub, NavigableString): verse_text += subsub self.application.process_events() - # Fix up leading and trailing spaces, multiple spaces, and spaces - # between text and , and . + # Fix up leading and trailing spaces, multiple spaces, and spaces between text and , and . verse_text = verse_text.strip(u'\n\r\t ') - verse_text = reduce_spaces.sub(u' ', verse_text) - verse_text = fix_punctuation.sub(r'\1', verse_text) + verse_text = REDUCE_SPACES_REGEX.sub(u' ', verse_text) + verse_text = FIX_PUNKCTUATION_REGEX.sub(r'\1', verse_text) verses[verse_number] = verse_text return SearchResults(book_name, chapter, verses) @@ -458,7 +458,7 @@ class CWExtract(object): log.error(u'No books found in the Crosswalk response.') send_error_message(u'parse') return None - content = content.findAll(u'li') + content = content.find_all(u'li') books = [] for book in content: book = book.find(u'a') @@ -481,9 +481,8 @@ class HTTPBible(BibleDB): def __init__(self, parent, **kwargs): """ - Finds all the bibles defined for the system - Creates an Interface Object for each bible containing connection - information + Finds all the bibles defined for the system. Creates an Interface Object for each bible containing connection + information. Throws Exception if no Bibles are found. @@ -492,8 +491,7 @@ class HTTPBible(BibleDB): BibleDB.__init__(self, parent, **kwargs) self.download_source = kwargs[u'download_source'] self.download_name = kwargs[u'download_name'] - # TODO: Clean up proxy stuff. We probably want one global proxy per - # connection type (HTTP and HTTPS) at most. + # TODO: Clean up proxy stuff. We probably want one global proxy per connection type (HTTP and HTTPS) at most. self.proxy_server = None self.proxy_username = None self.proxy_password = None @@ -508,8 +506,8 @@ class HTTPBible(BibleDB): def do_import(self, bible_name=None): """ - Run the import. This method overrides the parent class method. Returns - ``True`` on success, ``False`` on failure. + Run the import. This method overrides the parent class method. Returns ``True`` on success, ``False`` on + failure. """ self.wizard.progress_bar.setMaximum(68) self.wizard.increment_progress_bar(translate('BiblesPlugin.HTTPBible', 'Registering Bible and loading books...')) @@ -549,8 +547,7 @@ class HTTPBible(BibleDB): if self.stop_import_flag: break self.wizard.increment_progress_bar(translate( - 'BiblesPlugin.HTTPBible', 'Importing %s...', - 'Importing ...') % book) + 'BiblesPlugin.HTTPBible', 'Importing %s...', 'Importing ...') % book) book_ref_id = self.get_book_ref_id_by_name(book, len(books), language_id) if not book_ref_id: log.exception(u'Importing books from %s - download name: "%s" '\ @@ -567,22 +564,19 @@ class HTTPBible(BibleDB): def get_verses(self, reference_list, show_error=True): """ - A reimplementation of the ``BibleDB.get_verses`` method, this one is - specifically for web Bibles. It first checks to see if the particular - chapter exists in the DB, and if not it pulls it from the web. If the - chapter DOES exist, it simply pulls the verses from the DB using the - ancestor method. + A reimplementation of the ``BibleDB.get_verses`` method, this one is specifically for web Bibles. It first + checks to see if the particular chapter exists in the DB, and if not it pulls it from the web. If the chapter + DOES exist, it simply pulls the verses from the DB using the ancestor method. ``reference_list`` - This is the list of references the media manager item wants. It is - a list of tuples, with the following format:: + This is the list of references the media manager item wants. It is a list of tuples, with the following + format:: (book_reference_id, chapter, start_verse, end_verse) - Therefore, when you are looking for multiple items, simply break - them up into references like this, bundle them into a list. This - function then runs through the list, and returns an amalgamated - list of ``Verse`` objects. For example:: + Therefore, when you are looking for multiple items, simply break them up into references like this, bundle + them into a list. This function then runs through the list, and returns an amalgamated list of ``Verse`` + objects. For example:: [(u'35', 1, 1, 1), (u'35', 2, 2, 3)] """ @@ -643,7 +637,7 @@ class HTTPBible(BibleDB): Return the number of chapters in a particular book. ``book`` - The book object to get the chapter count for. + The book object to get the chapter count for. """ log.debug(u'HTTPBible.get_chapter_count("%s")', book.name) return BiblesResourcesDB.get_chapter_count(book.book_reference_id) @@ -683,8 +677,8 @@ def get_soup_for_bible_ref(reference_url, header=None, pre_parse_regex=None, An optional HTTP header to pass to the bible web server. ``pre_parse_regex`` - A regular expression to run on the webpage. Allows manipulation of the - webpage before passing to BeautifulSoup for parsing. + A regular expression to run on the webpage. Allows manipulation of the webpage before passing to BeautifulSoup + for parsing. ``pre_parse_substitute`` The text to replace any matches to the regular expression with. @@ -704,7 +698,7 @@ def get_soup_for_bible_ref(reference_url, header=None, pre_parse_regex=None, soup = None try: if cleaner: - soup = BeautifulSoup(page_source, markupMassage=cleaner) + soup = BeautifulSoup(page_source, markup=cleaner) else: soup = BeautifulSoup(page_source) except HTMLParseError: diff --git a/scripts/check_dependencies.py b/scripts/check_dependencies.py index 4c0f69b91..86a029b71 100755 --- a/scripts/check_dependencies.py +++ b/scripts/check_dependencies.py @@ -79,7 +79,7 @@ MODULES = [ 'lxml', 'chardet', 'enchant', - 'BeautifulSoup', + 'bs4', 'mako', 'migrate', 'uno', From 19f9718aec7c83659eb7a8c993234207a9101816 Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Fri, 5 Apr 2013 22:06:00 +0200 Subject: [PATCH 38/97] added FIXME --- openlp/plugins/bibles/lib/http.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/openlp/plugins/bibles/lib/http.py b/openlp/plugins/bibles/lib/http.py index 390ac1cd9..78ed40525 100644 --- a/openlp/plugins/bibles/lib/http.py +++ b/openlp/plugins/bibles/lib/http.py @@ -698,7 +698,8 @@ def get_soup_for_bible_ref(reference_url, header=None, pre_parse_regex=None, soup = None try: if cleaner: - soup = BeautifulSoup(page_source, markup=cleaner) + # FIXME: markupMassage not supported. + soup = BeautifulSoup(page_source, markupMassage=cleaner) else: soup = BeautifulSoup(page_source) except HTMLParseError: From ac32b6ca653c9723eaae6e3aef8bf971cdddc710 Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Fri, 5 Apr 2013 22:20:51 +0200 Subject: [PATCH 39/97] fixed missing r'' and removed argument --- openlp/plugins/bibles/lib/http.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/openlp/plugins/bibles/lib/http.py b/openlp/plugins/bibles/lib/http.py index 78ed40525..370216059 100644 --- a/openlp/plugins/bibles/lib/http.py +++ b/openlp/plugins/bibles/lib/http.py @@ -44,7 +44,7 @@ from openlp.core.utils import get_web_page from openlp.plugins.bibles.lib import SearchResults from openlp.plugins.bibles.lib.db import BibleDB, BiblesResourcesDB, Book -CLEANER_REGEX = re.compile(' |
|\'\+\'') +CLEANER_REGEX = re.compile(r' |
|\'\+\'') FIX_PUNKCTUATION_REGEX = re.compile(r'[ ]+([.,;])') REDUCE_SPACES_REGEX = re.compile(r'[ ]{2,}') UGLY_CHARS = { @@ -699,7 +699,7 @@ def get_soup_for_bible_ref(reference_url, header=None, pre_parse_regex=None, try: if cleaner: # FIXME: markupMassage not supported. - soup = BeautifulSoup(page_source, markupMassage=cleaner) + soup = BeautifulSoup(page_source)#, markupMassage=cleaner) else: soup = BeautifulSoup(page_source) except HTMLParseError: From 78ed2f655cdeaa2a5864e204970d4f946317b17d Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Sat, 6 Apr 2013 19:59:07 +0200 Subject: [PATCH 40/97] remove markupMassage --- openlp/plugins/bibles/lib/http.py | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-) diff --git a/openlp/plugins/bibles/lib/http.py b/openlp/plugins/bibles/lib/http.py index 370216059..2eec3cbcd 100644 --- a/openlp/plugins/bibles/lib/http.py +++ b/openlp/plugins/bibles/lib/http.py @@ -235,10 +235,9 @@ class BGExtract(object): log.debug(u'BGExtract.get_bible_chapter("%s", "%s", "%s")', version, book_name, chapter) url_book_name = urllib.quote(book_name.encode("utf-8")) url_params = u'search=%s+%s&version=%s' % (url_book_name, chapter, version) - cleaner = [(CLEANER_REGEX, lambda match: '')] soup = get_soup_for_bible_ref( u'http://www.biblegateway.com/passage/?%s' % url_params, - pre_parse_regex=r'', pre_parse_substitute='', cleaner=cleaner) + pre_parse_regex=r'', pre_parse_substitute='') if not soup: return None div = soup.find('div', 'result-text-style-normal') @@ -665,8 +664,7 @@ class HTTPBible(BibleDB): application = property(_get_application) -def get_soup_for_bible_ref(reference_url, header=None, pre_parse_regex=None, - pre_parse_substitute=None, cleaner=None): +def get_soup_for_bible_ref(reference_url, header=None, pre_parse_regex=None, pre_parse_substitute=None): """ Gets a webpage and returns a parsed and optionally cleaned soup or None. @@ -682,9 +680,6 @@ def get_soup_for_bible_ref(reference_url, header=None, pre_parse_regex=None, ``pre_parse_substitute`` The text to replace any matches to the regular expression with. - - ``cleaner`` - An optional regex to use during webpage parsing. """ if not reference_url: return None @@ -697,11 +692,8 @@ def get_soup_for_bible_ref(reference_url, header=None, pre_parse_regex=None, page_source = re.sub(pre_parse_regex, pre_parse_substitute, page_source) soup = None try: - if cleaner: - # FIXME: markupMassage not supported. - soup = BeautifulSoup(page_source)#, markupMassage=cleaner) - else: - soup = BeautifulSoup(page_source) + soup = BeautifulSoup(page_source) + CLEANER_REGEX.sub(u'', soup) except HTMLParseError: log.exception(u'BeautifulSoup could not parse the bible page.') if not soup: From 31b4e561b4ef54e40b795ce0e4274f22994eb11e Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Mon, 8 Apr 2013 17:53:11 +0100 Subject: [PATCH 41/97] Fix up code review change --- openlp/core/lib/serviceitem.py | 6 ++---- openlp/plugins/remotes/lib/httpserver.py | 6 +++--- tests/functional/openlp_plugins/remotes/test_router.py | 8 ++++---- tests/interfaces/openlp_plugins/remotes/test_server.py | 4 ++-- 4 files changed, 11 insertions(+), 13 deletions(-) diff --git a/openlp/core/lib/serviceitem.py b/openlp/core/lib/serviceitem.py index f57243818..c4ac846c9 100644 --- a/openlp/core/lib/serviceitem.py +++ b/openlp/core/lib/serviceitem.py @@ -62,12 +62,10 @@ class ItemCapabilities(object): tab when making the previous item live. ``CanEdit`` - The capability to allow the ServiceManager to allow the item to be - edited + The capability to allow the ServiceManager to allow the item to be edited ``CanMaintain`` - The capability to allow the ServiceManager to allow the item to be - reordered. + The capability to allow the ServiceManager to allow the item to be reordered. ``RequiresMedia`` Determines is the service_item needs a Media Player diff --git a/openlp/plugins/remotes/lib/httpserver.py b/openlp/plugins/remotes/lib/httpserver.py index 0489428ac..083f36db0 100644 --- a/openlp/plugins/remotes/lib/httpserver.py +++ b/openlp/plugins/remotes/lib/httpserver.py @@ -132,7 +132,7 @@ from cherrypy._cpcompat import sha, ntob log = logging.getLogger(__name__) -def sha_password_encrypter(password): +def make_sha_hash(password): """ Create an encrypted password for the given password. """ @@ -145,7 +145,7 @@ def fetch_password(username): """ if username != Settings().value(u'remotes/user id'): return None - return sha_password_encrypter(Settings().value(u'remotes/password')) + return make_sha_hash(Settings().value(u'remotes/password')) class HttpServer(object): @@ -207,7 +207,7 @@ class HttpServer(object): u'tools.basic_auth.on': Settings().value(u'remotes/authentication enabled'), u'tools.basic_auth.realm': u'OpenLP Remote Login', u'tools.basic_auth.users': fetch_password, - u'tools.basic_auth.encrypt': sha_password_encrypter}, + u'tools.basic_auth.encrypt': make_sha_hash}, u'/files': {u'tools.staticdir.on': True, u'tools.staticdir.dir': self.router.html_dir, u'tools.basic_auth.on': False}, diff --git a/tests/functional/openlp_plugins/remotes/test_router.py b/tests/functional/openlp_plugins/remotes/test_router.py index 3b344c3b2..2980a339b 100644 --- a/tests/functional/openlp_plugins/remotes/test_router.py +++ b/tests/functional/openlp_plugins/remotes/test_router.py @@ -8,7 +8,7 @@ from tempfile import mkstemp from mock import MagicMock from openlp.core.lib import Settings -from openlp.plugins.remotes.lib.httpserver import HttpRouter, fetch_password, sha_password_encrypter +from openlp.plugins.remotes.lib.httpserver import HttpRouter, fetch_password, make_sha_hash from PyQt4 import QtGui __default_settings__ = { @@ -62,7 +62,7 @@ class TestRouter(TestCase): # GIVEN: A default configuration # WHEN: called with the defined userid password = fetch_password(u'openlp') - required_password = sha_password_encrypter(u'password') + required_password = make_sha_hash(u'password') # THEN: the function should return the correct password self.assertEqual(password, required_password, u'The result for fetch_password should be the defined password') @@ -73,12 +73,12 @@ class TestRouter(TestCase): """ # GIVEN: A default configuration # WHEN: called with the defined userid - required_password = sha_password_encrypter(u'password') + required_password = make_sha_hash(u'password') test_value = u'5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8' # THEN: the function should return the correct password self.assertEqual(required_password, test_value, - u'The result for sha_password_encrypter should return the correct encrypted password') + u'The result for make_sha_hash should return the correct encrypted password') def process_http_request_test(self): """ diff --git a/tests/interfaces/openlp_plugins/remotes/test_server.py b/tests/interfaces/openlp_plugins/remotes/test_server.py index d7ce88010..9ae544d21 100644 --- a/tests/interfaces/openlp_plugins/remotes/test_server.py +++ b/tests/interfaces/openlp_plugins/remotes/test_server.py @@ -9,10 +9,10 @@ from mock import MagicMock import urllib2 import cherrypy -from BeautifulSoup import BeautifulSoup, NavigableString, Tag +from BeautifulSoup import BeautifulSoup from openlp.core.lib import Settings -from openlp.plugins.remotes.lib.httpserver import HttpServer, fetch_password, sha_password_encrypter +from openlp.plugins.remotes.lib.httpserver import HttpServer from PyQt4 import QtGui __default_settings__ = { From d504b314ef4f316d510cf162ffacd2d3af68d16d Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Mon, 8 Apr 2013 20:30:11 +0200 Subject: [PATCH 42/97] removed not needed mocks and calls --- .../custom/forms/test_customform.py | 32 ++++++++----------- 1 file changed, 14 insertions(+), 18 deletions(-) diff --git a/tests/interfaces/openlp_plugins/custom/forms/test_customform.py b/tests/interfaces/openlp_plugins/custom/forms/test_customform.py index d6e69946f..95b7d7ffa 100644 --- a/tests/interfaces/openlp_plugins/custom/forms/test_customform.py +++ b/tests/interfaces/openlp_plugins/custom/forms/test_customform.py @@ -40,29 +40,25 @@ class TestEditCustomForm(TestCase): """ Test the load_themes() method. """ - # GIVEN: A mocked QDialog.exec_() method - with patch(u'PyQt4.QtGui.QDialog.exec_') as mocked_exec: - theme_list = [u'First Theme', u'Second Theme'] - # WHEN: Show the dialog and add pass a theme list. - self.form.exec_() - self.form.load_themes(theme_list) + # GIVEN: A theme list. + theme_list = [u'First Theme', u'Second Theme'] - # THEN: There should be three items in the combo box. - assert self.form.theme_combo_box.count() == 3, u'There should be three items (themes) in the combo box.' + # WHEN: Show the dialog and add pass a theme list. + self.form.load_themes(theme_list) + + # THEN: There should be three items in the combo box. + assert self.form.theme_combo_box.count() == 3, u'There should be three items (themes) in the combo box.' def load_custom_test(self): """ Test the load_custom() method. """ - # GIVEN: A mocked QDialog.exec_() method - with patch(u'PyQt4.QtGui.QDialog.exec_') as mocked_exec: - # WHEN: Show the dialog and create a new custom item. - self.form.exec_() - self.form.load_custom(0) + # WHEN: Create a new custom item. + self.form.load_custom(0) - # THEN: The line edits should not contain any text. - self.assertEqual(self.form.title_edit.text(), u'', u'The title edit should be empty') - self.assertEqual(self.form.credit_edit.text(), u'', u'The credit edit should be empty') + # THEN: The line edits should not contain any text. + self.assertEqual(self.form.title_edit.text(), u'', u'The title edit should be empty') + self.assertEqual(self.form.credit_edit.text(), u'', u'The credit edit should be empty') def on_add_button_clicked_test(self): @@ -71,8 +67,8 @@ class TestEditCustomForm(TestCase): """ # GIVEN: A mocked QDialog.exec_() method with patch(u'PyQt4.QtGui.QDialog.exec_') as mocked_exec: - # WHEN: Show the dialog and add a new slide. - self.form.exec_() + # WHEN: Add a new slide. QtTest.QTest.mouseClick(self.form.add_button, QtCore.Qt.LeftButton) + # THEN: One slide should be added. assert self.form.slide_list_view.count() == 1, u'There should be one slide added.' From 220681c900981c0aad6c7b42e476aba227ea38e4 Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Sun, 14 Apr 2013 16:59:57 +0100 Subject: [PATCH 43/97] Comment fixes --- openlp/core/lib/mediamanageritem.py | 6 ++++++ openlp/plugins/remotes/lib/httpserver.py | 6 ++++++ .../openlp_plugins/remotes/test_server.py | 18 ++++++++++++++++++ 3 files changed, 30 insertions(+) diff --git a/openlp/core/lib/mediamanageritem.py b/openlp/core/lib/mediamanageritem.py index d27ef4041..01329b842 100644 --- a/openlp/core/lib/mediamanageritem.py +++ b/openlp/core/lib/mediamanageritem.py @@ -487,6 +487,9 @@ class MediaManagerItem(QtGui.QWidget): def go_live_remote(self, message): """ Remote Call wrapper + + ``message`` + The passed data item_id:Remote. """ self.go_live(message[0], remote=message[1]) @@ -535,6 +538,9 @@ class MediaManagerItem(QtGui.QWidget): def add_to_service_remote(self, message): """ Remote Call wrapper + + ``message`` + The passed data item:Remote. """ self.add_to_service(message[0], remote=message[1]) diff --git a/openlp/plugins/remotes/lib/httpserver.py b/openlp/plugins/remotes/lib/httpserver.py index 083f36db0..203b67205 100644 --- a/openlp/plugins/remotes/lib/httpserver.py +++ b/openlp/plugins/remotes/lib/httpserver.py @@ -285,6 +285,12 @@ class HttpRouter(object): def process_http_request(self, url_path, *args): """ Common function to process HTTP requests + + ``url_path`` + The requested URL. + + ``*args`` + Any passed data. """ response = None for route, func in self.routes: diff --git a/tests/interfaces/openlp_plugins/remotes/test_server.py b/tests/interfaces/openlp_plugins/remotes/test_server.py index 9ae544d21..8795eeaf3 100644 --- a/tests/interfaces/openlp_plugins/remotes/test_server.py +++ b/tests/interfaces/openlp_plugins/remotes/test_server.py @@ -101,6 +101,15 @@ class TestRouter(TestCase): def call_remote_server(url, username=None, password=None): + """ + Helper function + + ``username`` + The username. + + ``password`` + The password. + """ if username: passman = urllib2.HTTPPasswordMgrWithDefaultRealm() passman.add_password(None, url, username, password) @@ -115,6 +124,15 @@ def call_remote_server(url, username=None, password=None): def process_http_request(url_path, *args): + """ + Override function to make the Mock work but does nothing. + + ``Url_path`` + The url_path. + + ``*args`` + Some args. + """ cherrypy.response.status = 200 return None From db00c5049a012912e47fd1457009fcd1403311f3 Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Mon, 15 Apr 2013 17:50:59 +0200 Subject: [PATCH 44/97] fixed missing unicode --- openlp/core/utils/__init__.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/openlp/core/utils/__init__.py b/openlp/core/utils/__init__.py index 9a03c2b0e..d4ee8039c 100644 --- a/openlp/core/utils/__init__.py +++ b/openlp/core/utils/__init__.py @@ -247,7 +247,7 @@ def get_images_filter(): global IMAGES_FILTER if not IMAGES_FILTER: log.debug(u'Generating images filter.') - formats = QtGui.QImageReader.supportedImageFormats() + formats = map(unicode, QtGui.QImageReader.supportedImageFormats()) visible_formats = u'(*.%s)' % u'; *.'.join(formats) actual_formats = u'(*.%s)' % u' *.'.join(formats) IMAGES_FILTER = u'%s %s %s' % (translate('OpenLP', 'Image Files'), visible_formats, actual_formats) @@ -405,7 +405,7 @@ def get_natural_key(string): key = [int(part) if part.isdigit() else get_locale_key(part) for part in key] # Python 3 does not support comparision of different types anymore. So make sure, that we do not compare str and int. #if string[0].isdigit(): - # return [''] + key + # return [''] + key return key From 7f78250bb2798cea89349febf332c5fcf1c1edfb Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Mon, 15 Apr 2013 18:55:50 +0100 Subject: [PATCH 45/97] Make object --- openlp/plugins/remotes/lib/httpserver.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/openlp/plugins/remotes/lib/httpserver.py b/openlp/plugins/remotes/lib/httpserver.py index 203b67205..878b197b3 100644 --- a/openlp/plugins/remotes/lib/httpserver.py +++ b/openlp/plugins/remotes/lib/httpserver.py @@ -216,7 +216,7 @@ class HttpServer(object): u'tools.basic_auth.on': False}} return directory_config - class Public: + class Public(object): """ Main access class with may have security enabled on it. """ @@ -228,7 +228,7 @@ class HttpServer(object): url = urlparse.urlparse(cherrypy.url()) return self.router.process_http_request(url.path, *args) - class Files: + class Files(object): """ Provides access to files and has no security available. These are read only accesses """ @@ -237,7 +237,7 @@ class HttpServer(object): url = urlparse.urlparse(cherrypy.url()) return self.router.process_http_request(url.path, *args) - class Stage: + class Stage(object): """ Stageview is read only so security is not relevant and would reduce it's usability """ From e2b8dc54f38fe3ad9f0cd448a1d03a4bddcfd507 Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Mon, 15 Apr 2013 21:54:27 +0200 Subject: [PATCH 46/97] fixed bs4 code; fixed regression --- openlp/plugins/bibles/lib/http.py | 26 +++++++++++++++++++------- 1 file changed, 19 insertions(+), 7 deletions(-) diff --git a/openlp/plugins/bibles/lib/http.py b/openlp/plugins/bibles/lib/http.py index 2eec3cbcd..44b19f857 100644 --- a/openlp/plugins/bibles/lib/http.py +++ b/openlp/plugins/bibles/lib/http.py @@ -99,14 +99,15 @@ class BGExtract(object): """ if isinstance(tag, NavigableString): return None, unicode(tag) - elif tag.get('class') == 'versenum' or tag.get('class') == 'versenum mid-line': + elif tag.get('class')[0] == "versenum" or tag.get('class')[0] == 'versenum mid-line': verse = unicode(tag.string).replace('[', '').replace(']', '').strip() return verse, None - elif tag.get('class') == 'chapternum': + elif tag.get('class')[0] == 'chapternum': verse = '1' return verse, None else: - verse, text = None, '' + verse = None + text = '' for child in tag.contents: c_verse, c_text = self._extract_verse(child) if c_verse: @@ -143,7 +144,8 @@ class BGExtract(object): tags = tags[::-1] current_text = '' for tag in tags: - verse, text = None, '' + verse = None + text = '' for child in tag.contents: c_verse, c_text = self._extract_verse(child) if c_verse: @@ -208,7 +210,7 @@ class BGExtract(object): if clean_verse_num: verse_text = raw_verse_num.next_element part = raw_verse_num.next_element.next_element - while not (isinstance(part, Tag) and part.get(u'class') == u'versenum'): + while not (isinstance(part, Tag) and part.get(u'class')[0] == u'versenum'): # While we are still in the same verse grab all the text. if isinstance(part, NavigableString): verse_text += part @@ -349,7 +351,7 @@ class BSExtract(object): verses = {} for verse in content: self.application.process_events() - versenumber = int(VERSE_NUMBER_REGEX.sub(r'\3', verse[u'class'])) + versenumber = int(VERSE_NUMBER_REGEX.sub(r'\3', u' '.join(verse[u'class']))) verses[versenumber] = verse.contents[1].rstrip(u'\n') return SearchResults(book_name, chapter, verses) @@ -374,6 +376,16 @@ class BSExtract(object): content = content.find_all(u'li') return [book.contents[0].contents[0] for book in content] + 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) + class CWExtract(object): """ @@ -693,7 +705,7 @@ def get_soup_for_bible_ref(reference_url, header=None, pre_parse_regex=None, pre soup = None try: soup = BeautifulSoup(page_source) - CLEANER_REGEX.sub(u'', soup) + CLEANER_REGEX.sub(u'', unicode(soup)) except HTMLParseError: log.exception(u'BeautifulSoup could not parse the bible page.') if not soup: From f0334457d0139a05b117b32707616fee40cc1e09 Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Mon, 15 Apr 2013 23:07:45 +0200 Subject: [PATCH 47/97] removed sqlite2 code --- openlp/plugins/bibles/lib/openlp1.py | 113 ------------ openlp/plugins/songs/lib/olp1import.py | 227 ------------------------- 2 files changed, 340 deletions(-) delete mode 100644 openlp/plugins/bibles/lib/openlp1.py delete mode 100644 openlp/plugins/songs/lib/olp1import.py diff --git a/openlp/plugins/bibles/lib/openlp1.py b/openlp/plugins/bibles/lib/openlp1.py deleted file mode 100644 index 5d96e6c26..000000000 --- a/openlp/plugins/bibles/lib/openlp1.py +++ /dev/null @@ -1,113 +0,0 @@ -# -*- 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 # -############################################################################### - -import logging -import sqlite -import sys - -from openlp.core.ui.wizard import WizardStrings -from openlp.plugins.bibles.lib.db import BibleDB, BiblesResourcesDB - -log = logging.getLogger(__name__) - -class OpenLP1Bible(BibleDB): - """ - This class provides the OpenLPv1 bible importer. - """ - def __init__(self, parent, **kwargs): - """ - Constructor. - """ - log.debug(self.__class__.__name__) - BibleDB.__init__(self, parent, **kwargs) - self.filename = kwargs[u'filename'] - - def do_import(self, bible_name=None): - """ - Imports an openlp.org v1 bible. - """ - connection = None - cursor = None - try: - connection = sqlite.connect(self.filename.encode(sys.getfilesystemencoding())) - cursor = connection.cursor() - except sqlite.DatabaseError: - log.exception(u'File "%s" is encrypted or not a sqlite database, ' - 'therefore not an openlp.org 1.x database either' % self.filename) - # Please add an user error here! - # This file is not an openlp.org 1.x bible database. - return False - #Create the bible language - language_id = self.get_language(bible_name) - if not language_id: - log.exception(u'Importing books from "%s" failed' % self.filename) - return False - # Create all books. - try: - cursor.execute(u'SELECT id, testament_id, name, abbreviation FROM book') - except sqlite.DatabaseError as error: - log.exception(u'DatabaseError: %s' % error) - # Please add an user error here! - # This file is not an openlp.org 1.x bible database. - return False - books = cursor.fetchall() - self.wizard.progress_bar.setMaximum(len(books) + 1) - for book in books: - if self.stop_import_flag: - connection.close() - return False - book_id = int(book[0]) - testament_id = int(book[1]) - name = unicode(book[2], u'cp1252') - abbreviation = unicode(book[3], u'cp1252') - book_ref_id = self.get_book_ref_id_by_name(name, len(books), - language_id) - if not book_ref_id: - log.exception(u'Importing books from "%s" failed' % self.filename) - return False - book_details = BiblesResourcesDB.get_book_by_id(book_ref_id) - db_book = self.create_book(name, book_ref_id, book_details[u'testament_id']) - # Update the progess bar. - self.wizard.increment_progress_bar(WizardStrings.ImportingType % name) - # Import the verses for this book. - cursor.execute(u'SELECT chapter, verse, text || \'\' AS text FROM ' - 'verse WHERE book_id=%s' % book_id) - verses = cursor.fetchall() - for verse in verses: - if self.stop_import_flag: - connection.close() - return False - chapter = int(verse[0]) - verse_number = int(verse[1]) - text = unicode(verse[2], u'cp1252') - self.create_verse(db_book.id, chapter, verse_number, text) - self.application.process_events() - self.session.commit() - connection.close() - return True diff --git a/openlp/plugins/songs/lib/olp1import.py b/openlp/plugins/songs/lib/olp1import.py deleted file mode 100644 index 649b8af1f..000000000 --- a/openlp/plugins/songs/lib/olp1import.py +++ /dev/null @@ -1,227 +0,0 @@ -# -*- 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:`olp1import` module provides the functionality for importing -openlp.org 1.x song databases into the current installation database. -""" - -import logging -from chardet.universaldetector import UniversalDetector -import sqlite -import sys -import os - -from openlp.core.lib import Registry, translate -from openlp.plugins.songs.lib import retrieve_windows_encoding -from songimport import SongImport - -log = logging.getLogger(__name__) - -class OpenLP1SongImport(SongImport): - """ - The :class:`OpenLP1SongImport` class provides OpenLP with the ability to - import song databases from installations of openlp.org 1.x. - """ - lastEncoding = u'windows-1252' - - def __init__(self, manager, **kwargs): - """ - Initialise the import. - - ``manager`` - The song manager for the running OpenLP installation. - - ``filename`` - The database providing the data to import. - """ - SongImport.__init__(self, manager, **kwargs) - - def doImport(self): - """ - Run the import for an openlp.org 1.x song database. - """ - if not self.import_source.endswith(u'.olp'): - self.logError(self.import_source, - translate('SongsPlugin.OpenLP1SongImport', 'Not a valid openlp.org 1.x song database.')) - return - encoding = self.getEncoding() - if not encoding: - return - # Connect to the database. - connection = sqlite.connect(self.import_source, mode=0444, encoding=(encoding, 'replace')) - cursor = connection.cursor() - # Determine if the db supports linking audio to songs. - cursor.execute(u'SELECT name FROM sqlite_master ' - u'WHERE type = \'table\' AND name = \'tracks\'') - db_has_tracks = len(cursor.fetchall()) > 0 - # Determine if the db contains theme information. - cursor.execute(u'SELECT name FROM sqlite_master ' - u'WHERE type = \'table\' AND name = \'settings\'') - db_has_themes = len(cursor.fetchall()) > 0 - # "cache" our list of authors. - cursor.execute(u'-- types int, unicode') - cursor.execute(u'SELECT authorid, authorname FROM authors') - authors = cursor.fetchall() - if db_has_tracks: - # "cache" our list of tracks. - cursor.execute(u'-- types int, unicode') - cursor.execute(u'SELECT trackid, fulltrackname FROM tracks') - tracks = cursor.fetchall() - if db_has_themes: - # "cache" our list of themes. - themes = {} - cursor.execute(u'-- types int, unicode') - cursor.execute(u'SELECT settingsid, settingsname FROM settings') - for theme_id, theme_name in cursor.fetchall(): - if theme_name in self.theme_manager.get_themes(): - themes[theme_id] = theme_name - # Import the songs. - cursor.execute(u'-- types int, unicode, unicode, unicode') - cursor.execute(u'SELECT songid, songtitle, lyrics || \'\' AS ' \ - u'lyrics, copyrightinfo FROM songs') - songs = cursor.fetchall() - self.import_wizard.progress_bar.setMaximum(len(songs)) - for song in songs: - self.setDefaults() - if self.stop_import_flag: - break - song_id = song[0] - self.title = song[1] - lyrics = song[2].replace(u'\r\n', u'\n') - self.addCopyright(song[3]) - if db_has_themes: - cursor.execute(u'-- types int') - cursor.execute( - u'SELECT settingsid FROM songs WHERE songid = %s' % song_id) - theme_id = cursor.fetchone()[0] - self.themeName = themes.get(theme_id, u'') - verses = lyrics.split(u'\n\n') - for verse in verses: - if verse.strip(): - self.addVerse(verse.strip()) - cursor.execute(u'-- types int') - cursor.execute(u'SELECT authorid FROM songauthors ' - u'WHERE songid = %s' % song_id) - author_ids = cursor.fetchall() - for author_id in author_ids: - if self.stop_import_flag: - break - for author in authors: - if author[0] == author_id[0]: - self.parse_author(author[1]) - break - if self.stop_import_flag: - break - if db_has_tracks: - cursor.execute(u'-- types int, int') - cursor.execute(u'SELECT trackid, listindex ' - u'FROM songtracks ' - u'WHERE songid = %s ORDER BY listindex' % song_id) - track_ids = cursor.fetchall() - for track_id, listindex in track_ids: - if self.stop_import_flag: - break - for track in tracks: - if track[0] == track_id: - media_file = self.expandMediaFile(track[1]) - self.addMediaFile(media_file, listindex) - break - if self.stop_import_flag: - break - if not self.finish(): - self.logError(self.import_source) - - def getEncoding(self): - """ - Detect character encoding of an openlp.org 1.x song database. - """ - # Connect to the database. - connection = sqlite.connect(self.import_source.encode( - sys.getfilesystemencoding()), mode=0444) - cursor = connection.cursor() - - detector = UniversalDetector() - # Detect charset by authors. - cursor.execute(u'SELECT authorname FROM authors') - authors = cursor.fetchall() - for author in authors: - detector.feed(author[0]) - if detector.done: - detector.close() - return detector.result[u'encoding'] - # Detect charset by songs. - cursor.execute(u'SELECT songtitle, copyrightinfo, ' - u'lyrics || \'\' AS lyrics FROM songs') - songs = cursor.fetchall() - for index in [0, 1, 2]: - for song in songs: - detector.feed(song[index]) - if detector.done: - detector.close() - return detector.result[u'encoding'] - # Detect charset by songs. - cursor.execute(u'SELECT name FROM sqlite_master ' - u'WHERE type = \'table\' AND name = \'tracks\'') - if cursor.fetchall(): - cursor.execute(u'SELECT fulltrackname FROM tracks') - tracks = cursor.fetchall() - for track in tracks: - detector.feed(track[0]) - if detector.done: - detector.close() - return detector.result[u'encoding'] - detector.close() - return retrieve_windows_encoding(detector.result[u'encoding']) - - def expandMediaFile(self, filename): - """ - When you're on Windows, this function expands the file name to include - the path to OpenLP's application data directory. If you are not on - Windows, it returns the original file name. - - ``filename`` - The filename to expand. - """ - if sys.platform != u'win32' and not os.environ.get(u'ALLUSERSPROFILE') and not os.environ.get(u'APPDATA'): - return filename - common_app_data = os.path.join(os.environ[u'ALLUSERSPROFILE'], - os.path.split(os.environ[u'APPDATA'])[1]) - if not common_app_data: - return filename - return os.path.join(common_app_data, u'openlp.org', 'Audio', filename) - - def _get_theme_manager(self): - """ - Adds the theme manager to the class dynamically - """ - if not hasattr(self, u'_theme_manager'): - self._theme_manager = Registry().get(u'theme_manager') - return self._theme_manager - - theme_manager = property(_get_theme_manager) From b3d4be1a44b39cdc27114e179d549baaeef90b30 Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Mon, 15 Apr 2013 23:15:29 +0200 Subject: [PATCH 48/97] removed sqlite from exception form --- openlp/core/ui/exceptionform.py | 6 ------ 1 file changed, 6 deletions(-) diff --git a/openlp/core/ui/exceptionform.py b/openlp/core/ui/exceptionform.py index 6b77a8c6f..d6c8ad575 100644 --- a/openlp/core/ui/exceptionform.py +++ b/openlp/core/ui/exceptionform.py @@ -59,11 +59,6 @@ try: ENCHANT_VERSION = enchant.__version__ except ImportError: ENCHANT_VERSION = u'-' -try: - import sqlite - SQLITE_VERSION = sqlite.version -except ImportError: - SQLITE_VERSION = u'-' try: import mako MAKO_VERSION = mako.__version__ @@ -149,7 +144,6 @@ class ExceptionForm(QtGui.QDialog, Ui_ExceptionDialog): u'lxml: %s\n' % etree.__version__ + \ u'Chardet: %s\n' % CHARDET_VERSION + \ u'PyEnchant: %s\n' % ENCHANT_VERSION + \ - u'PySQLite: %s\n' % SQLITE_VERSION + \ u'Mako: %s\n' % MAKO_VERSION + \ u'pyICU: %s\n' % ICU_VERSION + \ u'pyUNO bridge: %s\n' % UNO_VERSION + \ From 7cae10917d07d5364398f4ac3aba96f76a708f1d Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Mon, 15 Apr 2013 23:15:56 +0200 Subject: [PATCH 49/97] removed sqlite from check_dependencies --- scripts/check_dependencies.py | 1 - 1 file changed, 1 deletion(-) diff --git a/scripts/check_dependencies.py b/scripts/check_dependencies.py index a6e075db4..941f6bdc9 100755 --- a/scripts/check_dependencies.py +++ b/scripts/check_dependencies.py @@ -88,7 +88,6 @@ MODULES = [ OPTIONAL_MODULES = [ - ('sqlite', ' (SQLite 2 support)'), ('MySQLdb', ' (MySQL support)'), ('psycopg2', ' (PostgreSQL support)'), ('nose', ' (testing framework)'), From 8d5aaa927daa61e9fba67edac9afcf3a88deb1d0 Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Mon, 15 Apr 2013 23:31:04 +0200 Subject: [PATCH 50/97] removed import from gui --- openlp/core/lib/uistrings.py | 1 - openlp/core/ui/wizard.py | 2 - .../plugins/bibles/forms/bibleimportform.py | 55 +----------------- openlp/plugins/bibles/lib/manager.py | 13 +---- openlp/plugins/songs/lib/importer.py | 56 +++++++------------ 5 files changed, 24 insertions(+), 103 deletions(-) diff --git a/openlp/core/lib/uistrings.py b/openlp/core/lib/uistrings.py index a5a45961a..6d4b4d250 100644 --- a/openlp/core/lib/uistrings.py +++ b/openlp/core/lib/uistrings.py @@ -107,7 +107,6 @@ class UiStrings(object): self.NFSp = translate('OpenLP.Ui', 'No Files Selected', 'Plural') self.NISs = translate('OpenLP.Ui', 'No Item Selected', 'Singular') self.NISp = translate('OpenLP.Ui', 'No Items Selected', 'Plural') - self.OLPV1 = translate('OpenLP.Ui', 'openlp.org 1.x') self.OLPV2 = translate('OpenLP.Ui', 'OpenLP 2') self.OLPV2x = translate('OpenLP.Ui', 'OpenLP 2.1') self.OpenLPStart = translate('OpenLP.Ui', 'OpenLP is already running. Do you wish to continue?') diff --git a/openlp/core/ui/wizard.py b/openlp/core/ui/wizard.py index f8b32a9c0..783b310b3 100644 --- a/openlp/core/ui/wizard.py +++ b/openlp/core/ui/wizard.py @@ -58,8 +58,6 @@ class WizardStrings(object): ImportingType = translate('OpenLP.Ui', 'Importing "%s"...') ImportSelect = translate('OpenLP.Ui', 'Select Import Source') ImportSelectLong = translate('OpenLP.Ui', 'Select the import format and the location to import from.') - NoSqlite = translate('OpenLP.Ui', 'The openlp.org 1.x importer has been disabled due to a missing Python module. ' - 'If you want to use this importer, you will need to install the "python-sqlite" module.') OpenTypeFile = translate('OpenLP.Ui', 'Open %s File') OpenTypeFolder = translate('OpenLP.Ui', 'Open %s Folder') PercentSymbolFormat = translate('OpenLP.Ui', '%p%') diff --git a/openlp/plugins/bibles/forms/bibleimportform.py b/openlp/plugins/bibles/forms/bibleimportform.py index f8d771e77..847b2b7a2 100644 --- a/openlp/plugins/bibles/forms/bibleimportform.py +++ b/openlp/plugins/bibles/forms/bibleimportform.py @@ -101,12 +101,6 @@ class BibleImportForm(OpenLPWizard): """ Perform any custom initialisation for bible importing. """ - if BibleFormat.get_availability(BibleFormat.OpenLP1): - self.openlp1DisabledLabel.hide() - else: - self.openlp1FileLabel.hide() - self.openlp1FileEdit.hide() - self.openlp1BrowseButton.hide() self.manager.set_process_dialog(self) self.loadWebBibles() self.restart() @@ -121,7 +115,6 @@ class BibleImportForm(OpenLPWizard): self.csvBooksButton.clicked.connect(self.onCsvBooksBrowseButtonClicked) self.csvVersesButton.clicked.connect(self.onCsvVersesBrowseButtonClicked) self.openSongBrowseButton.clicked.connect(self.onOpenSongBrowseButtonClicked) - self.openlp1BrowseButton.clicked.connect(self.onOpenlp1BrowseButtonClicked) def add_custom_pages(self): """ @@ -259,29 +252,6 @@ class BibleImportForm(OpenLPWizard): self.webProxyLayout.setWidget(2, QtGui.QFormLayout.FieldRole, self.webPasswordEdit) self.webTabWidget.addTab(self.webProxyTab, u'') self.selectStack.addWidget(self.webTabWidget) - self.openlp1Widget = QtGui.QWidget(self.selectPage) - self.openlp1Widget.setObjectName(u'Openlp1Widget') - self.openlp1Layout = QtGui.QFormLayout(self.openlp1Widget) - self.openlp1Layout.setMargin(0) - self.openlp1Layout.setObjectName(u'Openlp1Layout') - self.openlp1FileLabel = QtGui.QLabel(self.openlp1Widget) - self.openlp1FileLabel.setObjectName(u'Openlp1FileLabel') - self.openlp1FileLayout = QtGui.QHBoxLayout() - self.openlp1FileLayout.setObjectName(u'Openlp1FileLayout') - self.openlp1FileEdit = QtGui.QLineEdit(self.openlp1Widget) - self.openlp1FileEdit.setObjectName(u'Openlp1FileEdit') - self.openlp1FileLayout.addWidget(self.openlp1FileEdit) - self.openlp1BrowseButton = QtGui.QToolButton(self.openlp1Widget) - self.openlp1BrowseButton.setIcon(self.open_icon) - self.openlp1BrowseButton.setObjectName(u'Openlp1BrowseButton') - self.openlp1FileLayout.addWidget(self.openlp1BrowseButton) - self.openlp1Layout.addRow(self.openlp1FileLabel, self.openlp1FileLayout) - self.openlp1DisabledLabel = QtGui.QLabel(self.openlp1Widget) - self.openlp1DisabledLabel.setWordWrap(True) - self.openlp1DisabledLabel.setObjectName(u'Openlp1DisabledLabel') - self.openlp1Layout.addRow(self.openlp1DisabledLabel) - self.openlp1Layout.setItem(1, QtGui.QFormLayout.LabelRole, self.spacer) - self.selectStack.addWidget(self.openlp1Widget) self.selectPageLayout.addLayout(self.selectStack) self.addPage(self.selectPage) # License Page @@ -330,8 +300,6 @@ class BibleImportForm(OpenLPWizard): self.formatComboBox.setItemText(BibleFormat.OpenSong, WizardStrings.OS) self.formatComboBox.setItemText(BibleFormat.WebDownload, translate('BiblesPlugin.ImportWizardForm', 'Web Download')) - self.formatComboBox.setItemText(BibleFormat.OpenLP1, UiStrings().OLPV1) - self.openlp1FileLabel.setText(translate('BiblesPlugin.ImportWizardForm', 'Bible file:')) self.osisFileLabel.setText(translate('BiblesPlugin.ImportWizardForm', 'Bible file:')) self.csvBooksLabel.setText(translate('BiblesPlugin.ImportWizardForm', 'Books file:')) self.csvVersesLabel.setText(translate('BiblesPlugin.ImportWizardForm', 'Verses file:')) @@ -364,14 +332,12 @@ class BibleImportForm(OpenLPWizard): 'Please wait while your Bible is imported.')) self.progress_label.setText(WizardStrings.Ready) self.progress_bar.setFormat(u'%p%') - self.openlp1DisabledLabel.setText(WizardStrings.NoSqlite) # Align all QFormLayouts towards each other. labelWidth = max(self.formatLabel.minimumSizeHint().width(), self.osisFileLabel.minimumSizeHint().width(), self.csvBooksLabel.minimumSizeHint().width(), self.csvVersesLabel.minimumSizeHint().width(), - self.openSongFileLabel.minimumSizeHint().width(), - self.openlp1FileLabel.minimumSizeHint().width()) + self.openSongFileLabel.minimumSizeHint().width()) self.spacer.changeSize(labelWidth, 0, QtGui.QSizePolicy.Fixed, QtGui.QSizePolicy.Fixed) def validateCurrentPage(self): @@ -406,11 +372,6 @@ class BibleImportForm(OpenLPWizard): elif self.field(u'source_format') == BibleFormat.WebDownload: self.versionNameEdit.setText(self.webTranslationComboBox.currentText()) return True - elif self.field(u'source_format') == BibleFormat.OpenLP1: - if not self.field(u'openlp1_location'): - critical_error_message_box(UiStrings().NFSs, WizardStrings.YouSpecifyFile % UiStrings().OLPV1) - self.openlp1FileEdit.setFocus() - return False return True elif self.currentPage() == self.licenseDetailsPage: license_version = self.field(u'license_version') @@ -484,13 +445,6 @@ class BibleImportForm(OpenLPWizard): """ self.get_file_name(WizardStrings.OpenTypeFile % WizardStrings.OS, self.openSongFileEdit, u'last directory import') - def onOpenlp1BrowseButtonClicked(self): - """ - Show the file open dialog for the openlp.org 1.x file. - """ - self.get_file_name(WizardStrings.OpenTypeFile % UiStrings().OLPV1, self.openlp1FileEdit, u'last directory import', - u'%s (*.bible)' % translate('BiblesPlugin.ImportWizardForm', 'openlp.org 1.x Bible Files')) - def register_fields(self): """ Register the bible import wizard fields. @@ -505,7 +459,6 @@ class BibleImportForm(OpenLPWizard): self.selectPage.registerField(u'proxy_server', self.webServerEdit) self.selectPage.registerField(u'proxy_username', self.webUserEdit) self.selectPage.registerField(u'proxy_password', self.webPasswordEdit) - self.selectPage.registerField(u'openlp1_location', self.openlp1FileEdit) self.licenseDetailsPage.registerField(u'license_version', self.versionNameEdit) self.licenseDetailsPage.registerField(u'license_copyright', self.copyrightEdit) self.licenseDetailsPage.registerField(u'license_permissions', self.permissionsEdit) @@ -615,12 +568,6 @@ class BibleImportForm(OpenLPWizard): proxy_username=self.field(u'proxy_username'), proxy_password=self.field(u'proxy_password') ) - elif bible_type == BibleFormat.OpenLP1: - # Import an openlp.org 1.x bible. - importer = self.manager.import_bible(BibleFormat.OpenLP1, - name=license_version, - filename=self.field(u'openlp1_location') - ) if importer.do_import(license_version): self.manager.save_meta_data(license_version, license_version, license_copyright, license_permissions) diff --git a/openlp/plugins/bibles/lib/manager.py b/openlp/plugins/bibles/lib/manager.py index 15c2e5d80..abcfa7ddc 100644 --- a/openlp/plugins/bibles/lib/manager.py +++ b/openlp/plugins/bibles/lib/manager.py @@ -38,12 +38,8 @@ from csvbible import CSVBible from http import HTTPBible from opensong import OpenSongBible from osis import OSISBible -# Imports that might fail. -try: - from openlp1 import OpenLP1Bible - HAS_OPENLP1 = True -except ImportError: - HAS_OPENLP1 = False + + log = logging.getLogger(__name__) @@ -59,7 +55,6 @@ class BibleFormat(object): CSV = 1 OpenSong = 2 WebDownload = 3 - OpenLP1 = 4 @staticmethod def get_class(format): @@ -77,8 +72,6 @@ class BibleFormat(object): return OpenSongBible elif format == BibleFormat.WebDownload: return HTTPBible - elif format == BibleFormat.OpenLP1: - return OpenLP1Bible else: return None @@ -92,7 +85,6 @@ class BibleFormat(object): BibleFormat.CSV, BibleFormat.OpenSong, BibleFormat.WebDownload, - BibleFormat.OpenLP1 ] @staticmethod @@ -463,6 +455,5 @@ class BibleManager(object): main_window = property(_get_main_window) -BibleFormat.set_availability(BibleFormat.OpenLP1, HAS_OPENLP1) __all__ = [u'BibleFormat'] diff --git a/openlp/plugins/songs/lib/importer.py b/openlp/plugins/songs/lib/importer.py index ff018abf3..76b3e0a70 100644 --- a/openlp/plugins/songs/lib/importer.py +++ b/openlp/plugins/songs/lib/importer.py @@ -50,13 +50,11 @@ from sundayplusimport import SundayPlusImport from foilpresenterimport import FoilPresenterImport from zionworximport import ZionWorxImport # Imports that might fail + + log = logging.getLogger(__name__) -try: - from olp1import import OpenLP1SongImport - HAS_OPENLP1 = True -except ImportError: - log.exception('Error importing %s', 'OpenLP1SongImport') - HAS_OPENLP1 = False + + try: from sofimport import SofImport HAS_SOF = True @@ -144,23 +142,22 @@ class SongFormat(object): Unknown = -1 OpenLyrics = 0 OpenLP2 = 1 - OpenLP1 = 2 - Generic = 3 - CCLI = 4 - DreamBeam = 5 - EasySlides = 6 - EasyWorship = 7 - FoilPresenter = 8 - MediaShout = 9 - OpenSong = 10 - PowerSong = 11 - SongBeamer = 12 - SongPro = 13 - SongShowPlus = 14 - SongsOfFellowship = 15 - SundayPlus = 16 - WordsOfWorship = 17 - ZionWorx = 18 + Generic = 2 + CCLI = 3 + DreamBeam = 4 + EasySlides = 5 + EasyWorship = 6 + FoilPresenter = 7 + MediaShout = 8 + OpenSong = 9 + PowerSong = 10 + SongBeamer = 11 + SongPro = 12 + SongShowPlus = 13 + SongsOfFellowship = 14 + SundayPlus = 15 + WordsOfWorship = 16 + ZionWorx = 17 # Set optional attribute defaults __defaults__ = { @@ -191,14 +188,6 @@ class SongFormat(object): u'selectMode': SongFormatSelect.SingleFile, u'filter': u'%s (*.sqlite)' % (translate('SongsPlugin.ImportWizardForm', 'OpenLP 2.0 Databases')) }, - OpenLP1: { - u'name': UiStrings().OLPV1, - u'prefix': u'openLP1', - u'canDisable': True, - u'selectMode': SongFormatSelect.SingleFile, - u'filter': u'%s (*.olp)' % translate('SongsPlugin.ImportWizardForm', 'openlp.org v1.x Databases'), - u'disabledLabelText': WizardStrings.NoSqlite - }, Generic: { u'name': translate('SongsPlugin.ImportWizardForm', 'Generic Document/Presentation'), u'prefix': u'generic', @@ -332,7 +321,6 @@ class SongFormat(object): return [ SongFormat.OpenLyrics, SongFormat.OpenLP2, - SongFormat.OpenLP1, SongFormat.Generic, SongFormat.CCLI, SongFormat.DreamBeam, @@ -387,9 +375,7 @@ class SongFormat(object): """ SongFormat.__attributes__[format][attribute] = value -SongFormat.set(SongFormat.OpenLP1, u'availability', HAS_OPENLP1) -if HAS_OPENLP1: - SongFormat.set(SongFormat.OpenLP1, u'class', OpenLP1SongImport) + SongFormat.set(SongFormat.SongsOfFellowship, u'availability', HAS_SOF) if HAS_SOF: SongFormat.set(SongFormat.SongsOfFellowship, u'class', SofImport) From 140178a67404db4f9b065bcc603d13f898da4146 Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Tue, 16 Apr 2013 17:55:23 +0200 Subject: [PATCH 51/97] added code back which should not be removed in this proposal --- openlp/core/utils/__init__.py | 59 ++++++++++++++++++++++++----------- 1 file changed, 40 insertions(+), 19 deletions(-) diff --git a/openlp/core/utils/__init__.py b/openlp/core/utils/__init__.py index f1c150989..0e48f2fa5 100644 --- a/openlp/core/utils/__init__.py +++ b/openlp/core/utils/__init__.py @@ -102,24 +102,45 @@ def get_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. - 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) + 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) else: # We're not running the development version, let's use the file. filepath = AppLocation.get_directory(AppLocation.VersionDir) @@ -385,7 +406,7 @@ def get_natural_key(string): key = [int(part) if part.isdigit() else get_locale_key(part) for part in key] # Python 3 does not support comparision of different types anymore. So make sure, that we do not compare str and int. #if string[0].isdigit(): - # return [''] + key + # return [''] + key return key From 0fb24d2233f623031f195865db98d87771cf3d62 Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Wed, 17 Apr 2013 20:33:44 +0200 Subject: [PATCH 52/97] added tests --- openlp/plugins/custom/forms/editcustomform.py | 2 +- .../custom/forms/test_customform.py | 42 +++++++++++++++++++ 2 files changed, 43 insertions(+), 1 deletion(-) diff --git a/openlp/plugins/custom/forms/editcustomform.py b/openlp/plugins/custom/forms/editcustomform.py index c78baa974..580fbde07 100644 --- a/openlp/plugins/custom/forms/editcustomform.py +++ b/openlp/plugins/custom/forms/editcustomform.py @@ -257,6 +257,6 @@ class EditCustomForm(QtGui.QDialog, Ui_CustomEditDialog): # We must have at least one slide. if self.slide_list_view.count() == 0: critical_error_message_box(message=translate('CustomPlugin.EditCustomForm', - 'You need to add at least one slide')) + 'You need to add at least one slide.')) return False return True diff --git a/tests/interfaces/openlp_plugins/custom/forms/test_customform.py b/tests/interfaces/openlp_plugins/custom/forms/test_customform.py index 6e6318ca6..dbed244e3 100644 --- a/tests/interfaces/openlp_plugins/custom/forms/test_customform.py +++ b/tests/interfaces/openlp_plugins/custom/forms/test_customform.py @@ -62,3 +62,45 @@ class TestEditCustomForm(TestCase): QtTest.QTest.mouseClick(self.form.add_button, QtCore.Qt.LeftButton) #THEN: One slide should be added. assert self.form.slide_list_view.count() == 1, u'There should be one slide added.' + + def validate_not_valid_part1_test(self): + """ + Test the _validate() method. + """ + # GIVEN: Mocked methods. + with patch(u'openlp.plugins.custom.forms.editcustomform.critical_error_message_box') as \ + mocked_critical_error_message_box: + mocked_displayText = MagicMock() + mocked_displayText.return_value = u'' + self.form.title_edit.displayText = mocked_displayText + mocked_setFocus = MagicMock() + self.form.title_edit.setFocus = mocked_setFocus + + # WHEN: Call the method. + result = self.form._validate() + + # THEN: The validate method should have returned False. + assert not result, u'The _validate() method should have retured False' + mocked_setFocus.assert_called_with() + mocked_critical_error_message_box.assert_called_with(message=u'You need to type in a title.') + + def validate_not_valid_part2_test(self): + """ + Test the _validate() method. + """ + # GIVEN: Mocked methods. + with patch(u'openlp.plugins.custom.forms.editcustomform.critical_error_message_box') as \ + mocked_critical_error_message_box: + mocked_displayText = MagicMock() + mocked_displayText.return_value = u'something' + self.form.title_edit.displayText = mocked_displayText + mocked_count = MagicMock() + mocked_count.return_value = 0 + self.form.slide_list_view.count = mocked_count + + # WHEN: Call the method. + result = self.form._validate() + + # THEN: The validate method should have returned False. + assert not result, u'The _validate() method should have retured False' + mocked_critical_error_message_box.assert_called_with(message=u'You need to add at least one slide.') From f3b49c4dd50aef21251c7a89efd10f29b7c3041f Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Wed, 17 Apr 2013 22:12:53 +0200 Subject: [PATCH 53/97] removed dead code --- openlp/plugins/bibles/forms/bibleimportform.py | 3 --- openlp/plugins/bibles/lib/manager.py | 14 ++------------ 2 files changed, 2 insertions(+), 15 deletions(-) diff --git a/openlp/plugins/bibles/forms/bibleimportform.py b/openlp/plugins/bibles/forms/bibleimportform.py index 847b2b7a2..242dff707 100644 --- a/openlp/plugins/bibles/forms/bibleimportform.py +++ b/openlp/plugins/bibles/forms/bibleimportform.py @@ -94,8 +94,6 @@ class BibleImportForm(OpenLPWizard): button. """ self.selectStack.setCurrentIndex(index) - next_button = self.button(QtGui.QWizard.NextButton) - next_button.setEnabled(BibleFormat.get_availability(index)) def custom_init(self): """ @@ -482,7 +480,6 @@ class BibleImportForm(OpenLPWizard): self.setField(u'proxy_server', settings.value(u'proxy address')) self.setField(u'proxy_username', settings.value(u'proxy username')) self.setField(u'proxy_password', settings.value(u'proxy password')) - self.setField(u'openlp1_location', '') self.setField(u'license_version', self.versionNameEdit.text()) self.setField(u'license_copyright', self.copyrightEdit.text()) self.setField(u'license_permissions', self.permissionsEdit.text()) diff --git a/openlp/plugins/bibles/lib/manager.py b/openlp/plugins/bibles/lib/manager.py index abcfa7ddc..f701de0aa 100644 --- a/openlp/plugins/bibles/lib/manager.py +++ b/openlp/plugins/bibles/lib/manager.py @@ -43,13 +43,11 @@ from osis import OSISBible log = logging.getLogger(__name__) + class BibleFormat(object): """ - This is a special enumeration class that holds the various types of Bibles, - plus a few helper functions to facilitate generic handling of Bible types - for importing. + This is a special enumeration class that holds the various types of Bibles. """ - _format_availability = {} Unknown = -1 OSIS = 0 CSV = 1 @@ -87,14 +85,6 @@ class BibleFormat(object): BibleFormat.WebDownload, ] - @staticmethod - def set_availability(format, available): - BibleFormat._format_availability[format] = available - - @staticmethod - def get_availability(format): - return BibleFormat._format_availability.get(format, True) - class BibleManager(object): """ From 5547035550eebb2e227bdf55e69917be2e5fb7d8 Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Thu, 18 Apr 2013 11:17:00 +0200 Subject: [PATCH 54/97] fixed short lines --- openlp/plugins/songs/lib/mediaitem.py | 51 +++++++++++---------------- 1 file changed, 21 insertions(+), 30 deletions(-) diff --git a/openlp/plugins/songs/lib/mediaitem.py b/openlp/plugins/songs/lib/mediaitem.py index d75124d84..cd1cd72ae 100644 --- a/openlp/plugins/songs/lib/mediaitem.py +++ b/openlp/plugins/songs/lib/mediaitem.py @@ -76,8 +76,7 @@ class SongMediaItem(MediaManagerItem): self.openLyrics = OpenLyrics(self.plugin.manager) self.single_service_item = False self.songMaintenanceForm = SongMaintenanceForm(self.plugin.manager, self) - # Holds information about whether the edit is remotely triggered and - # which Song is required. + # Holds information about whether the edit is remotely triggered and which Song is required. self.remoteSong = -1 self.editItem = None self.quick_preview_allowed = True @@ -89,10 +88,8 @@ class SongMediaItem(MediaManagerItem): dest_file = os.path.join( AppLocation.get_section_data_path(self.plugin.name), u'audio', str(song.id), os.path.split(bga)[1]) check_directory_exists(os.path.split(dest_file)[0]) - shutil.copyfile(os.path.join(AppLocation.get_section_data_path(u'servicemanager'), bga), - dest_file) - song.media_files.append(MediaFile.populate( - weight=i, file_name=dest_file)) + shutil.copyfile(os.path.join(AppLocation.get_section_data_path(u'servicemanager'), bga), dest_file) + song.media_files.append(MediaFile.populate(weight=i, file_name=dest_file)) self.plugin.manager.save_object(song, True) def add_end_header_bar(self): @@ -120,7 +117,7 @@ class SongMediaItem(MediaManagerItem): def config_update(self): """ - IS triggered when the songs config is updated + Is triggered when the songs config is updated """ log.debug(u'config_updated') self.searchAsYouType = Settings().value(self.settings_section + u'/search as type') @@ -211,10 +208,9 @@ class SongMediaItem(MediaManagerItem): of songs """ log.debug(u'on_song_list_load - start') - # Called to redisplay the song list screen edit from a search - # or from the exit of the Song edit dialog. If remote editing is active - # Trigger it and clean up so it will not update again. - # Push edits to the service manager to update items + # Called to redisplay the song list screen edit from a search or from the exit of the Song edit dialog. If + # remote editing is active Trigger it and clean up so it will not update again. Push edits to the service + # manager to update items if self.editItem and self.updateServiceOnEdit and not self.remote_triggered: item = self.build_service_item(self.editItem) self.service_manager.replace_service_item(item) @@ -280,9 +276,8 @@ class SongMediaItem(MediaManagerItem): def on_search_text_edit_changed(self, text): """ - If search as type enabled invoke the search on each key press. - If the Lyrics are being searched do not start till 7 characters - have been entered. + If search as type enabled invoke the search on each key press. If the Lyrics are being searched do not start + till 7 characters have been entered. """ if self.searchAsYouType: search_length = 1 @@ -320,9 +315,8 @@ class SongMediaItem(MediaManagerItem): def onRemoteEdit(self, song_id, preview=False): """ - Called by ServiceManager or SlideController by event passing - the Song Id in the payload along with an indicator to say which - type of display is required. + Called by ServiceManager or SlideController by event passing the Song Id in the payload along with an indicator + to say which type of display is required. """ log.debug(u'onRemoteEdit for song %s' % song_id) song_id = int(song_id) @@ -362,11 +356,11 @@ class SongMediaItem(MediaManagerItem): if check_item_selected(self.list_view, UiStrings().SelectDelete): items = self.list_view.selectedIndexes() if QtGui.QMessageBox.question(self, - UiStrings().ConfirmDelete, - translate('SongsPlugin.MediaItem', 'Are you sure you want to delete the %n selected song(s)?', '', - QtCore.QCoreApplication.CodecForTr, len(items)), - QtGui.QMessageBox.StandardButtons(QtGui.QMessageBox.Yes | QtGui.QMessageBox.No), - QtGui.QMessageBox.Yes) == QtGui.QMessageBox.No: + UiStrings().ConfirmDelete, + translate('SongsPlugin.MediaItem', 'Are you sure you want to delete the %n selected song(s)?', '', + QtCore.QCoreApplication.CodecForTr, len(items)), + QtGui.QMessageBox.StandardButtons(QtGui.QMessageBox.Yes | QtGui.QMessageBox.No), + QtGui.QMessageBox.Yes) == QtGui.QMessageBox.No: return self.application.set_busy_cursor() self.main_window.display_progress_bar(len(items)) @@ -430,8 +424,8 @@ class SongMediaItem(MediaManagerItem): verse_tags_translated = True if not song.verse_order.strip(): for verse in verse_list: - # We cannot use from_loose_input() here, because database - # is supposed to contain English lowercase singlechar tags. + # 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: @@ -470,9 +464,7 @@ class SongMediaItem(MediaManagerItem): if Settings().value(u'general/ccli number'): service_item.raw_footer.append(translate('SongsPlugin.MediaItem', 'CCLI License: ') + Settings().value(u'general/ccli number')) - service_item.audit = [ - song.title, author_list, song.copyright, unicode(song.ccli_number) - ] + service_item.audit = [song.title, author_list, song.copyright, unicode(song.ccli_number)] 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. @@ -489,9 +481,8 @@ class SongMediaItem(MediaManagerItem): if self.plugin.status != PluginStatus.Active or not item.data_string: return if item.data_string[u'title'].find(u'@') == -1: - # This file seems to be an old one (prior to 1.9.5), which means, - # that the search title (data_string[u'title']) is probably wrong. - # We add "@" to search title and hope that we do not add any + # FIXME: This file seems to be an old one (prior to 1.9.5), which means, that the search title + # (data_string[u'title']) is probably wrong. We add "@" to search title and hope that we do not add any # duplicate. This should work for songs without alternate title. search_results = self.plugin.manager.get_all_objects(Song, Song.search_title == (re.compile(r'\W+', re.UNICODE).sub(u' ', From cf209fef6f1eac8f4fda593e13dc8f0fcc2d5edb Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Thu, 18 Apr 2013 11:20:56 +0200 Subject: [PATCH 55/97] renaming --- openlp/plugins/songs/lib/mediaitem.py | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/openlp/plugins/songs/lib/mediaitem.py b/openlp/plugins/songs/lib/mediaitem.py index cd1cd72ae..86b27240b 100644 --- a/openlp/plugins/songs/lib/mediaitem.py +++ b/openlp/plugins/songs/lib/mediaitem.py @@ -72,7 +72,7 @@ class SongMediaItem(MediaManagerItem): def __init__(self, parent, plugin): self.icon_path = u'songs/song' MediaManagerItem.__init__(self, parent, plugin) - self.editSongForm = EditSongForm(self, self.main_window, self.plugin.manager) + self.edit_song_form = EditSongForm(self, self.main_window, self.plugin.manager) self.openLyrics = OpenLyrics(self.plugin.manager) self.single_service_item = False self.songMaintenanceForm = SongMaintenanceForm(self.plugin.manager, self) @@ -82,7 +82,7 @@ class SongMediaItem(MediaManagerItem): self.quick_preview_allowed = True self.has_search = True - def _updateBackgroundAudio(self, song, item): + def _update_background_audio(self, song, item): song.media_files = [] for i, bga in enumerate(item.background_audio): dest_file = os.path.join( @@ -304,8 +304,8 @@ class SongMediaItem(MediaManagerItem): def on_new_click(self): log.debug(u'on_new_click') - self.editSongForm.new_song() - self.editSongForm.exec_() + self.edit_song_form.new_song() + self.edit_song_form.exec_() self.onClearTextButtonClick() self.on_selection_change() self.auto_select_id = -1 @@ -322,8 +322,8 @@ class SongMediaItem(MediaManagerItem): song_id = int(song_id) valid = self.plugin.manager.get_object(Song, song_id) if valid: - self.editSongForm.load_song(song_id, preview) - if self.editSongForm.exec_() == QtGui.QDialog.Accepted: + self.edit_song_form.load_song(song_id, preview) + if self.edit_song_form.exec_() == QtGui.QDialog.Accepted: self.auto_select_id = -1 self.on_song_list_load() self.remoteSong = song_id @@ -343,8 +343,8 @@ class SongMediaItem(MediaManagerItem): if check_item_selected(self.list_view, UiStrings().SelectEdit): self.editItem = self.list_view.currentItem() item_id = self.editItem.data(QtCore.Qt.UserRole) - self.editSongForm.load_song(item_id, False) - self.editSongForm.exec_() + self.edit_song_form.load_song(item_id, False) + self.edit_song_form.exec_() self.auto_select_id = -1 self.on_song_list_load() self.editItem = None @@ -509,12 +509,12 @@ class SongMediaItem(MediaManagerItem): break # If there's any backing tracks, copy them over. if item.background_audio: - self._updateBackgroundAudio(song, item) + self._update_background_audio(song, item) if add_song and self.addSongFromService: song = self.openLyrics.xml_to_song(item.xml_version) # If there's any backing tracks, copy them over. if item.background_audio: - self._updateBackgroundAudio(song, item) + self._update_background_audio(song, item) editId = song.id self.on_search_text_button_clicked() elif add_song and not self.addSongFromService: @@ -522,7 +522,7 @@ class SongMediaItem(MediaManagerItem): song = self.openLyrics.xml_to_song(item.xml_version, True) # If there's any backing tracks, copy them over. if item.background_audio: - self._updateBackgroundAudio(song, item) + self._update_background_audio(song, item) editId = song.id temporary = True # Update service with correct song id. From c13c0a047495e4d1c61c162353834c2100d094a0 Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Thu, 18 Apr 2013 11:22:20 +0200 Subject: [PATCH 56/97] renaming --- openlp/plugins/songs/forms/editsongform.py | 2 +- openlp/plugins/songs/lib/mediaitem.py | 30 +++++++++++----------- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/openlp/plugins/songs/forms/editsongform.py b/openlp/plugins/songs/forms/editsongform.py index 49a20762a..8baadbcc8 100644 --- a/openlp/plugins/songs/forms/editsongform.py +++ b/openlp/plugins/songs/forms/editsongform.py @@ -714,7 +714,7 @@ class EditSongForm(QtGui.QDialog, Ui_EditSongDialog): text = self.song_book_combo_box.currentText() if item == 0 and text: temp_song_book = text - self.media_item.songMaintenanceForm.exec_(True) + self.media_item.song_maintenance_form.exec_(True) self.load_authors() self.load_books() self.load_topics() diff --git a/openlp/plugins/songs/lib/mediaitem.py b/openlp/plugins/songs/lib/mediaitem.py index 86b27240b..7900389e2 100644 --- a/openlp/plugins/songs/lib/mediaitem.py +++ b/openlp/plugins/songs/lib/mediaitem.py @@ -75,10 +75,10 @@ class SongMediaItem(MediaManagerItem): self.edit_song_form = EditSongForm(self, self.main_window, self.plugin.manager) self.openLyrics = OpenLyrics(self.plugin.manager) self.single_service_item = False - self.songMaintenanceForm = SongMaintenanceForm(self.plugin.manager, self) + self.song_maintenance_form = SongMaintenanceForm(self.plugin.manager, self) # Holds information about whether the edit is remotely triggered and which Song is required. - self.remoteSong = -1 - self.editItem = None + self.remote_song = -1 + self.edit_item = None self.quick_preview_allowed = True self.has_search = True @@ -211,8 +211,8 @@ class SongMediaItem(MediaManagerItem): # Called to redisplay the song list screen edit from a search or from the exit of the Song edit dialog. If # remote editing is active Trigger it and clean up so it will not update again. Push edits to the service # manager to update items - if self.editItem and self.updateServiceOnEdit and not self.remote_triggered: - item = self.build_service_item(self.editItem) + if self.edit_item and self.updateServiceOnEdit and not self.remote_triggered: + item = self.build_service_item(self.edit_item) self.service_manager.replace_service_item(item) self.on_search_text_button_clicked() log.debug(u'on_song_list_load - finished') @@ -311,7 +311,7 @@ class SongMediaItem(MediaManagerItem): self.auto_select_id = -1 def onSongMaintenanceClick(self): - self.songMaintenanceForm.exec_() + self.song_maintenance_form.exec_() def onRemoteEdit(self, song_id, preview=False): """ @@ -326,10 +326,10 @@ class SongMediaItem(MediaManagerItem): if self.edit_song_form.exec_() == QtGui.QDialog.Accepted: self.auto_select_id = -1 self.on_song_list_load() - self.remoteSong = song_id + self.remote_song = song_id self.remote_triggered = True item = self.build_service_item(remote=True) - self.remoteSong = -1 + self.remote_song = -1 self.remote_triggered = None if item: return item @@ -341,13 +341,13 @@ class SongMediaItem(MediaManagerItem): """ log.debug(u'on_edit_click') if check_item_selected(self.list_view, UiStrings().SelectEdit): - self.editItem = self.list_view.currentItem() - item_id = self.editItem.data(QtCore.Qt.UserRole) + self.edit_item = self.list_view.currentItem() + item_id = self.edit_item.data(QtCore.Qt.UserRole) self.edit_song_form.load_song(item_id, False) self.edit_song_form.exec_() self.auto_select_id = -1 self.on_song_list_load() - self.editItem = None + self.edit_item = None def on_delete_click(self): """ @@ -390,8 +390,8 @@ class SongMediaItem(MediaManagerItem): """ log.debug(u'onCloneClick') if check_item_selected(self.list_view, UiStrings().SelectEdit): - self.editItem = self.list_view.currentItem() - item_id = self.editItem.data(QtCore.Qt.UserRole) + self.edit_item = self.list_view.currentItem() + item_id = self.edit_item.data(QtCore.Qt.UserRole) old_song = self.plugin.manager.get_object(Song, item_id) song_xml = self.openLyrics.song_to_xml(old_song) new_song = self.openLyrics.xml_to_song(song_xml) @@ -405,8 +405,8 @@ class SongMediaItem(MediaManagerItem): """ Generate the slide data. Needs to be implemented by the plugin. """ - log.debug(u'generate_slide_data: %s, %s, %s' % (service_item, item, self.remoteSong)) - item_id = self._get_id_of_item_to_generate(item, self.remoteSong) + log.debug(u'generate_slide_data: %s, %s, %s' % (service_item, item, self.remote_song)) + item_id = self._get_id_of_item_to_generate(item, self.remote_song) service_item.add_capability(ItemCapabilities.CanEdit) service_item.add_capability(ItemCapabilities.CanPreview) service_item.add_capability(ItemCapabilities.CanLoop) From d002cb383ef33c9ef91674ad2ffc68a245d6a3e9 Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Thu, 18 Apr 2013 11:27:11 +0200 Subject: [PATCH 57/97] renaming --- openlp/core/lib/mediamanageritem.py | 2 +- openlp/core/ui/mainwindow.py | 2 +- openlp/plugins/bibles/lib/mediaitem.py | 2 +- openlp/plugins/custom/lib/mediaitem.py | 2 +- openlp/plugins/songs/lib/mediaitem.py | 6 +++--- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/openlp/core/lib/mediamanageritem.py b/openlp/core/lib/mediamanageritem.py index f6c95aa9e..0bf34e9c5 100644 --- a/openlp/core/lib/mediamanageritem.py +++ b/openlp/core/lib/mediamanageritem.py @@ -424,7 +424,7 @@ class MediaManagerItem(QtGui.QWidget): """ raise NotImplementedError(u'MediaManagerItem.on_delete_click needs to be defined by the plugin') - def onFocus(self): + def on_focus(self): """ Run when a tab in the media manager gains focus. This gives the media item a chance to focus any elements it wants to. diff --git a/openlp/core/ui/mainwindow.py b/openlp/core/ui/mainwindow.py index 69439c1b1..91142f0cc 100644 --- a/openlp/core/ui/mainwindow.py +++ b/openlp/core/ui/mainwindow.py @@ -560,7 +560,7 @@ class MainWindow(QtGui.QMainWindow, Ui_MainWindow): """ widget = self.media_tool_box.widget(index) if widget: - widget.onFocus() + widget.on_focus() def version_notice(self, version): """ diff --git a/openlp/plugins/bibles/lib/mediaitem.py b/openlp/plugins/bibles/lib/mediaitem.py index 86a507612..b5352db9f 100644 --- a/openlp/plugins/bibles/lib/mediaitem.py +++ b/openlp/plugins/bibles/lib/mediaitem.py @@ -250,7 +250,7 @@ class BibleMediaItem(MediaManagerItem): self.quickSearchEdit.returnPressed.connect(self.onQuickSearchButton) self.searchTabBar.currentChanged.connect(self.onSearchTabBarCurrentChanged) - def onFocus(self): + def on_focus(self): if self.quickTab.isVisible(): self.quickSearchEdit.setFocus() else: diff --git a/openlp/plugins/custom/lib/mediaitem.py b/openlp/plugins/custom/lib/mediaitem.py index 071f68839..37d17bd4a 100644 --- a/openlp/plugins/custom/lib/mediaitem.py +++ b/openlp/plugins/custom/lib/mediaitem.py @@ -178,7 +178,7 @@ class CustomMediaItem(MediaManagerItem): self.plugin.manager.delete_object(CustomSlide, id) self.on_search_text_button_clicked() - def onFocus(self): + def on_focus(self): self.search_text_edit.setFocus() def generate_slide_data(self, service_item, item=None, xmlVersion=False, diff --git a/openlp/plugins/songs/lib/mediaitem.py b/openlp/plugins/songs/lib/mediaitem.py index 7900389e2..6e835a025 100644 --- a/openlp/plugins/songs/lib/mediaitem.py +++ b/openlp/plugins/songs/lib/mediaitem.py @@ -112,7 +112,7 @@ class SongMediaItem(MediaManagerItem): text=translate('OpenLP.MediaManagerItem', '&Clone'), icon=u':/general/general_clone.png', triggers=self.onCloneClick) - def onFocus(self): + def on_focus(self): self.search_text_edit.setFocus() def config_update(self): @@ -120,7 +120,7 @@ class SongMediaItem(MediaManagerItem): Is triggered when the songs config is updated """ log.debug(u'config_updated') - self.searchAsYouType = Settings().value(self.settings_section + u'/search as type') + self.search_as_you_type = Settings().value(self.settings_section + u'/search as type') self.updateServiceOnEdit = Settings().value(self.settings_section + u'/update service on edit') self.addSongFromService = Settings().value(self.settings_section + u'/add song from service',) @@ -279,7 +279,7 @@ class SongMediaItem(MediaManagerItem): If search as type enabled invoke the search on each key press. If the Lyrics are being searched do not start till 7 characters have been entered. """ - if self.searchAsYouType: + if self.search_as_you_type: search_length = 1 if self.search_text_edit.current_search_type() == SongSearch.Entire: search_length = 4 From 2d518febf028c8c05170eafed1898703496deb25 Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Thu, 18 Apr 2013 11:28:21 +0200 Subject: [PATCH 58/97] renaming --- openlp/plugins/songs/lib/mediaitem.py | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/openlp/plugins/songs/lib/mediaitem.py b/openlp/plugins/songs/lib/mediaitem.py index 6e835a025..416ae6530 100644 --- a/openlp/plugins/songs/lib/mediaitem.py +++ b/openlp/plugins/songs/lib/mediaitem.py @@ -161,23 +161,23 @@ class SongMediaItem(MediaManagerItem): search_type = self.search_text_edit.current_search_type() if search_type == SongSearch.Entire: log.debug(u'Entire Song Search') - search_results = self.searchEntire(search_keywords) - self.displayResultsSong(search_results) + search_results = self.search_entire(search_keywords) + self.display_results_song(search_results) elif search_type == SongSearch.Titles: log.debug(u'Titles Search') search_results = self.plugin.manager.get_all_objects(Song, Song.search_title.like(u'%' + clean_string(search_keywords) + u'%')) - self.displayResultsSong(search_results) + self.display_results_song(search_results) elif search_type == SongSearch.Lyrics: log.debug(u'Lyrics Search') search_results = self.plugin.manager.get_all_objects(Song, Song.search_lyrics.like(u'%' + clean_string(search_keywords) + u'%')) - self.displayResultsSong(search_results) + self.display_results_song(search_results) elif search_type == SongSearch.Authors: log.debug(u'Authors Search') search_results = self.plugin.manager.get_all_objects(Author, Author.display_name.like(u'%' + search_keywords + u'%'), Author.display_name.asc()) - self.displayResultsAuthor(search_results) + self.display_results_author(search_results) elif search_type == SongSearch.Books: log.debug(u'Books Search') search_results = self.plugin.manager.get_all_objects(Book, @@ -188,15 +188,15 @@ class SongMediaItem(MediaManagerItem): search_results = self.plugin.manager.get_all_objects(Book, Book.name.like(u'%' + search_keywords[0] + u'%'), Book.name.asc()) song_number = re.sub(r'[^0-9]', u'', search_keywords[2]) - self.displayResultsBook(search_results, song_number) + self.display_results_book(search_results, song_number) elif search_type == SongSearch.Themes: log.debug(u'Theme Search') search_results = self.plugin.manager.get_all_objects(Song, Song.theme_name.like(u'%' + search_keywords + u'%')) - self.displayResultsSong(search_results) + self.display_results_song(search_results) self.check_search_result() - def searchEntire(self, search_keywords): + def search_entire(self, search_keywords): return self.plugin.manager.get_all_objects(Song, or_(Song.search_title.like(u'%' + clean_string(search_keywords) + u'%'), Song.search_lyrics.like(u'%' + clean_string(search_keywords) + u'%'), @@ -217,7 +217,7 @@ class SongMediaItem(MediaManagerItem): self.on_search_text_button_clicked() log.debug(u'on_song_list_load - finished') - def displayResultsSong(self, searchresults): + def display_results_song(self, searchresults): log.debug(u'display results Song') self.save_auto_select_id() self.list_view.clear() @@ -237,7 +237,7 @@ class SongMediaItem(MediaManagerItem): self.list_view.setCurrentItem(song_name) self.auto_select_id = -1 - def displayResultsAuthor(self, searchresults): + def display_results_author(self, searchresults): log.debug(u'display results Author') self.list_view.clear() for author in searchresults: @@ -250,7 +250,7 @@ class SongMediaItem(MediaManagerItem): song_name.setData(QtCore.Qt.UserRole, song.id) self.list_view.addItem(song_name) - def displayResultsBook(self, searchresults, song_number=False): + def display_results_book(self, searchresults, song_number=False): log.debug(u'display results Book') self.list_view.clear() for book in searchresults: @@ -533,5 +533,5 @@ class SongMediaItem(MediaManagerItem): """ Search for some songs """ - search_results = self.searchEntire(string) + search_results = self.search_entire(string) return [[song.id, song.title] for song in search_results] From 06b8707434b38798c0e0341509fa96b65da75b72 Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Thu, 18 Apr 2013 11:30:55 +0200 Subject: [PATCH 59/97] renaming --- openlp/plugins/songs/lib/mediaitem.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/openlp/plugins/songs/lib/mediaitem.py b/openlp/plugins/songs/lib/mediaitem.py index 416ae6530..d35096210 100644 --- a/openlp/plugins/songs/lib/mediaitem.py +++ b/openlp/plugins/songs/lib/mediaitem.py @@ -97,7 +97,7 @@ class SongMediaItem(MediaManagerItem): ## Song Maintenance Button ## self.maintenanceAction = self.toolbar.add_toolbar_action('maintenanceAction', icon=':/songs/song_maintenance.png', - triggers=self.onSongMaintenanceClick) + triggers=self.on_song_maintenance_click) self.add_search_to_toolbar() # Signals and slots Registry().register_function(u'songs_load_list', self.on_song_list_load) @@ -110,7 +110,7 @@ class SongMediaItem(MediaManagerItem): create_widget_action(self.list_view, separator=True) create_widget_action(self.list_view, text=translate('OpenLP.MediaManagerItem', '&Clone'), icon=u':/general/general_clone.png', - triggers=self.onCloneClick) + triggers=self.on_clone_click) def on_focus(self): self.search_text_edit.setFocus() @@ -310,7 +310,7 @@ class SongMediaItem(MediaManagerItem): self.on_selection_change() self.auto_select_id = -1 - def onSongMaintenanceClick(self): + def on_song_maintenance_click(self): self.song_maintenance_form.exec_() def onRemoteEdit(self, song_id, preview=False): @@ -384,11 +384,11 @@ class SongMediaItem(MediaManagerItem): self.application.set_normal_cursor() self.on_search_text_button_clicked() - def onCloneClick(self): + def on_clone_click(self): """ Clone a Song """ - log.debug(u'onCloneClick') + log.debug(u'on_clone_click') if check_item_selected(self.list_view, UiStrings().SelectEdit): self.edit_item = self.list_view.currentItem() item_id = self.edit_item.data(QtCore.Qt.UserRole) From 2ad78e4cb9c75e3243d5352a7ed40cf1d9e93c19 Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Thu, 18 Apr 2013 11:32:48 +0200 Subject: [PATCH 60/97] renaming --- openlp/core/ui/servicemanager.py | 2 +- openlp/core/ui/slidecontroller.py | 2 +- openlp/plugins/songs/lib/mediaitem.py | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/openlp/core/ui/servicemanager.py b/openlp/core/ui/servicemanager.py index 6e0f4ad95..39e335de6 100644 --- a/openlp/core/ui/servicemanager.py +++ b/openlp/core/ui/servicemanager.py @@ -1393,7 +1393,7 @@ class ServiceManager(QtGui.QWidget, ServiceManagerDialog): item = self.find_service_item()[0] if self.service_items[item][u'service_item'].is_capable(ItemCapabilities.CanEdit): new_item = Registry().get(self.service_items[item][u'service_item'].name). \ - onRemoteEdit(self.service_items[item][u'service_item'].edit_id) + on_remote_edit(self.service_items[item][u'service_item'].edit_id) if new_item: self.add_service_item(new_item, replace=True) diff --git a/openlp/core/ui/slidecontroller.py b/openlp/core/ui/slidecontroller.py index eaeebfba8..811405c40 100644 --- a/openlp/core/ui/slidecontroller.py +++ b/openlp/core/ui/slidecontroller.py @@ -1229,7 +1229,7 @@ class SlideController(DisplayController): From the preview display requires the service Item to be editied """ self.song_edit = True - new_item = Registry().get(self.service_item.name).onRemoteEdit(self.service_item.edit_id, True) + new_item = Registry().get(self.service_item.name).on_remote_edit(self.service_item.edit_id, True) if new_item: self.add_service_item(new_item) diff --git a/openlp/plugins/songs/lib/mediaitem.py b/openlp/plugins/songs/lib/mediaitem.py index d35096210..1f0b10958 100644 --- a/openlp/plugins/songs/lib/mediaitem.py +++ b/openlp/plugins/songs/lib/mediaitem.py @@ -313,12 +313,12 @@ class SongMediaItem(MediaManagerItem): def on_song_maintenance_click(self): self.song_maintenance_form.exec_() - def onRemoteEdit(self, song_id, preview=False): + def on_remote_edit(self, song_id, preview=False): """ Called by ServiceManager or SlideController by event passing the Song Id in the payload along with an indicator to say which type of display is required. """ - log.debug(u'onRemoteEdit for song %s' % song_id) + log.debug(u'on_remote_edit for song %s' % song_id) song_id = int(song_id) valid = self.plugin.manager.get_object(Song, song_id) if valid: From 14db927af70a23aa5f8f6564887ae17770354f08 Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Thu, 18 Apr 2013 19:10:26 +0200 Subject: [PATCH 61/97] more renaming --- openlp/plugins/custom/lib/mediaitem.py | 53 ++++++++++++-------------- openlp/plugins/songs/lib/mediaitem.py | 8 ++-- 2 files changed, 29 insertions(+), 32 deletions(-) diff --git a/openlp/plugins/custom/lib/mediaitem.py b/openlp/plugins/custom/lib/mediaitem.py index 37d17bd4a..f51db8e6b 100644 --- a/openlp/plugins/custom/lib/mediaitem.py +++ b/openlp/plugins/custom/lib/mediaitem.py @@ -63,14 +63,14 @@ class CustomMediaItem(MediaManagerItem): self.has_search = True # Holds information about whether the edit is remotely triggered and # which Custom is required. - self.remoteCustom = -1 + self.remote_custom = -1 self.manager = plugin.manager def add_end_header_bar(self): self.toolbar.addSeparator() self.add_search_to_toolbar() # Signals and slots - QtCore.QObject.connect(self.search_text_edit, QtCore.SIGNAL(u'cleared()'), self.onClearTextButtonClick) + QtCore.QObject.connect(self.search_text_edit, QtCore.SIGNAL(u'cleared()'), self.on_clear_text_button_click) QtCore.QObject.connect(self.search_text_edit, QtCore.SIGNAL(u'searchTypeChanged(int)'), self.on_search_text_button_clicked) Registry().register_function(u'custom_load_list', self.load_list) @@ -119,14 +119,13 @@ class CustomMediaItem(MediaManagerItem): def on_new_click(self): self.edit_custom_form.load_custom(0) self.edit_custom_form.exec_() - self.onClearTextButtonClick() + self.on_clear_text_button_click() self.on_selection_change() - def onRemoteEdit(self, custom_id, preview=False): + def on_remote_edit(self, custom_id, preview=False): """ - Called by ServiceManager or SlideController by event passing - the custom Id in the payload along with an indicator to say which - type of display is required. + Called by ServiceManager or SlideController by event passing the custom Id in the payload along with an + indicator to say which type of display is required. """ custom_id = int(custom_id) valid = self.manager.get_object(CustomSlide, custom_id) @@ -134,12 +133,12 @@ class CustomMediaItem(MediaManagerItem): self.edit_custom_form.load_custom(custom_id, preview) if self.edit_custom_form.exec_() == QtGui.QDialog.Accepted: self.remote_triggered = True - self.remoteCustom = custom_id + self.remote_custom = custom_id self.auto_select_id = -1 self.on_search_text_button_clicked() item = self.build_service_item(remote=True) self.remote_triggered = None - self.remoteCustom = 1 + self.remote_custom = 1 if item: return item return None @@ -163,17 +162,16 @@ class CustomMediaItem(MediaManagerItem): if check_item_selected(self.list_view, UiStrings().SelectDelete): items = self.list_view.selectedIndexes() if QtGui.QMessageBox.question(self, - UiStrings().ConfirmDelete, - translate('CustomPlugin.MediaItem', - 'Are you sure you want to delete the %n selected custom slide(s)?', '', - QtCore.QCoreApplication.CodecForTr, len(items)), - QtGui.QMessageBox.StandardButtons(QtGui.QMessageBox.Yes | QtGui.QMessageBox.No), - QtGui.QMessageBox.Yes) == QtGui.QMessageBox.No: + UiStrings().ConfirmDelete, + translate('CustomPlugin.MediaItem', + 'Are you sure you want to delete the %n selected custom slide(s)?', '', + QtCore.QCoreApplication.CodecForTr, len(items)), + QtGui.QMessageBox.StandardButtons(QtGui.QMessageBox.Yes | QtGui.QMessageBox.No), + QtGui.QMessageBox.Yes) == QtGui.QMessageBox.No: return row_list = [item.row() for item in self.list_view.selectedIndexes()] row_list.sort(reverse=True) - id_list = [(item.data(QtCore.Qt.UserRole)) - for item in self.list_view.selectedIndexes()] + id_list = [(item.data(QtCore.Qt.UserRole)) for item in self.list_view.selectedIndexes()] for id in id_list: self.plugin.manager.delete_object(CustomSlide, id) self.on_search_text_button_clicked() @@ -186,20 +184,20 @@ class CustomMediaItem(MediaManagerItem): """ Generate the slide data. Needs to be implemented by the plugin. """ - item_id = self._get_id_of_item_to_generate(item, self.remoteCustom) + item_id = self._get_id_of_item_to_generate(item, self.remote_custom) service_item.add_capability(ItemCapabilities.CanEdit) service_item.add_capability(ItemCapabilities.CanPreview) service_item.add_capability(ItemCapabilities.CanLoop) service_item.add_capability(ItemCapabilities.CanSoftBreak) service_item.add_capability(ItemCapabilities.OnLoadUpdate) - customSlide = self.plugin.manager.get_object(CustomSlide, item_id) - title = customSlide.title - credit = customSlide.credits + custom_slide = self.plugin.manager.get_object(CustomSlide, item_id) + title = custom_slide.title + credit = custom_slide.credits service_item.edit_id = item_id - theme = customSlide.theme_name + theme = custom_slide.theme_name if theme: service_item.theme = theme - custom_xml = CustomXMLParser(customSlide.text) + custom_xml = CustomXMLParser(custom_slide.text) verse_list = custom_xml.get_verses() raw_slides = [verse[1] for verse in verse_list] service_item.title = title @@ -234,15 +232,14 @@ class CustomMediaItem(MediaManagerItem): def on_search_text_edit_changed(self, text): """ - If search as type enabled invoke the search on each key press. - If the Title is being searched do not start until 2 characters - have been entered. + If search as type enabled invoke the search on each key press. If the Title is being searched do not start until + 2 characters have been entered. """ search_length = 2 if len(text) > search_length: self.on_search_text_button_clicked() elif not text: - self.onClearTextButtonClick() + self.on_clear_text_button_click() def service_load(self, item): """ @@ -287,7 +284,7 @@ class CustomMediaItem(MediaManagerItem): if item.name.lower() == u'custom': Registry().execute(u'service_item_update', u'%s:%s:%s' % (custom.id, item.unique_identifier, False)) - def onClearTextButtonClick(self): + def on_clear_text_button_click(self): """ Clear the search text. """ diff --git a/openlp/plugins/songs/lib/mediaitem.py b/openlp/plugins/songs/lib/mediaitem.py index 1f0b10958..c0626ebba 100644 --- a/openlp/plugins/songs/lib/mediaitem.py +++ b/openlp/plugins/songs/lib/mediaitem.py @@ -102,7 +102,7 @@ class SongMediaItem(MediaManagerItem): # Signals and slots Registry().register_function(u'songs_load_list', self.on_song_list_load) Registry().register_function(u'songs_preview', self.on_preview_click) - QtCore.QObject.connect(self.search_text_edit, QtCore.SIGNAL(u'cleared()'), self.onClearTextButtonClick) + QtCore.QObject.connect(self.search_text_edit, QtCore.SIGNAL(u'cleared()'), self.on_clear_text_button_click) QtCore.QObject.connect(self.search_text_edit, QtCore.SIGNAL(u'searchTypeChanged(int)'), self.on_search_text_button_clicked) @@ -267,7 +267,7 @@ class SongMediaItem(MediaManagerItem): song_name.setData(QtCore.Qt.UserRole, song.id) self.list_view.addItem(song_name) - def onClearTextButtonClick(self): + def on_clear_text_button_click(self): """ Clear the search text. """ @@ -288,7 +288,7 @@ class SongMediaItem(MediaManagerItem): if len(text) > search_length: self.on_search_text_button_clicked() elif not text: - self.onClearTextButtonClick() + self.on_clear_text_button_click() def on_import_click(self): if not hasattr(self, u'import_wizard'): @@ -306,7 +306,7 @@ class SongMediaItem(MediaManagerItem): log.debug(u'on_new_click') self.edit_song_form.new_song() self.edit_song_form.exec_() - self.onClearTextButtonClick() + self.on_clear_text_button_click() self.on_selection_change() self.auto_select_id = -1 From 85ab27ab0c3bbc6484c8862f74cbc9a3c779f698 Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Thu, 18 Apr 2013 19:17:00 +0200 Subject: [PATCH 62/97] alters plugin renaming --- openlp/plugins/alerts/__init__.py | 3 +-- openlp/plugins/alerts/alertsplugin.py | 20 ++++++++--------- openlp/plugins/alerts/forms/__init__.py | 25 +++++++++------------- openlp/plugins/alerts/forms/alertdialog.py | 2 +- openlp/plugins/alerts/forms/alertform.py | 13 ++++++----- openlp/plugins/alerts/lib/alertsmanager.py | 14 ++++++------ openlp/plugins/alerts/lib/db.py | 5 +++-- 7 files changed, 36 insertions(+), 46 deletions(-) diff --git a/openlp/plugins/alerts/__init__.py b/openlp/plugins/alerts/__init__.py index 3e4a63444..bb4c2835d 100644 --- a/openlp/plugins/alerts/__init__.py +++ b/openlp/plugins/alerts/__init__.py @@ -27,6 +27,5 @@ # Temple Place, Suite 330, Boston, MA 02111-1307 USA # ############################################################################### """ -The :mod:`alerts` module provides the Alerts plugin for producing impromptu -on-screen announcements during a service. +The :mod:`alerts` module provides the Alerts plugin for producing impromptu on-screen announcements during a service. """ diff --git a/openlp/plugins/alerts/alertsplugin.py b/openlp/plugins/alerts/alertsplugin.py index 8d8530918..a2d77c42b 100644 --- a/openlp/plugins/alerts/alertsplugin.py +++ b/openlp/plugins/alerts/alertsplugin.py @@ -115,13 +115,13 @@ HTML = """ """ __default_settings__ = { - u'alerts/font face': QtGui.QFont().family(), - u'alerts/font size': 40, - u'alerts/db type': u'sqlite', - u'alerts/location': AlertLocation.Bottom, - u'alerts/background color': u'#660000', - u'alerts/font color': u'#ffffff', - u'alerts/timeout': 5 + u'alerts/font face': QtGui.QFont().family(), + u'alerts/font size': 40, + u'alerts/db type': u'sqlite', + u'alerts/location': AlertLocation.Bottom, + u'alerts/background color': u'#660000', + u'alerts/font color': u'#ffffff', + u'alerts/timeout': 5 } @@ -139,12 +139,10 @@ class AlertsPlugin(Plugin): def add_tools_menu_item(self, tools_menu): """ - Give the alerts plugin the opportunity to add items to the - **Tools** menu. + Give the alerts plugin the opportunity to add items to the **Tools** menu. ``tools_menu`` - The actual **Tools** menu item, so that your actions can - use it as their parent. + The actual **Tools** menu item, so that your actions can use it as their parent. """ log.info(u'add tools menu') self.tools_alert_item = create_action(tools_menu, u'toolsAlertItem', diff --git a/openlp/plugins/alerts/forms/__init__.py b/openlp/plugins/alerts/forms/__init__.py index e97fdfed3..2a3037f97 100644 --- a/openlp/plugins/alerts/forms/__init__.py +++ b/openlp/plugins/alerts/forms/__init__.py @@ -27,20 +27,16 @@ # Temple Place, Suite 330, Boston, MA 02111-1307 USA # ############################################################################### """ -Forms in OpenLP are made up of two classes. One class holds all the graphical -elements, like buttons and lists, and the other class holds all the functional -code, like slots and loading and saving. +Forms in OpenLP are made up of two classes. One class holds all the graphical elements, like buttons and lists, and the +other class holds all the functional code, like slots and loading and saving. -The first class, commonly known as the **Dialog** class, is typically named -``Ui_Dialog``. It is a slightly modified version of the class that the -``pyuic4`` command produces from Qt4's .ui file. Typical modifications will be -converting most strings from "" to u'' and using OpenLP's ``translate()`` -function for translating strings. +The first class, commonly known as the **Dialog** class, is typically named ``Ui_Dialog``. It is a slightly +modified version of the class that the ``pyuic4`` command produces from Qt4's .ui file. Typical modifications will be +converting most strings from "" to u'' and using OpenLP's ``translate()`` function for translating strings. -The second class, commonly known as the **Form** class, is typically named -``Form``. This class is the one which is instantiated and used. It uses -dual inheritance to inherit from (usually) QtGui.QDialog and the Ui class -mentioned above, like so:: +The second class, commonly known as the **Form** class, is typically named ``Form``. This class is the one which +is instantiated and used. It uses dual inheritance to inherit from (usually) QtGui.QDialog and the Ui class mentioned +above, like so:: class AuthorsForm(QtGui.QDialog, Ui_AuthorsDialog): @@ -48,9 +44,8 @@ mentioned above, like so:: QtGui.QDialog.__init__(self, parent) self.setupUi(self) -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. +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 alertform import AlertForm diff --git a/openlp/plugins/alerts/forms/alertdialog.py b/openlp/plugins/alerts/forms/alertdialog.py index 1985fdcd1..e8a50d183 100644 --- a/openlp/plugins/alerts/forms/alertdialog.py +++ b/openlp/plugins/alerts/forms/alertdialog.py @@ -71,7 +71,7 @@ class Ui_AlertDialog(object): self.save_button.setObjectName(u'save_button') self.manage_button_layout.addWidget(self.save_button) self.delete_button = create_button(alert_dialog, u'delete_button', role=u'delete', enabled=False, - click=alert_dialog.onDeleteButtonClicked) + click=alert_dialog.on_delete_button_clicked) self.manage_button_layout.addWidget(self.delete_button) self.manage_button_layout.addStretch() self.alert_dialog_layout.addLayout(self.manage_button_layout, 1, 1) diff --git a/openlp/plugins/alerts/forms/alertform.py b/openlp/plugins/alerts/forms/alertform.py index 64aca1e26..d1f5361d0 100644 --- a/openlp/plugins/alerts/forms/alertform.py +++ b/openlp/plugins/alerts/forms/alertform.py @@ -93,7 +93,7 @@ class AlertForm(QtGui.QDialog, Ui_AlertDialog): if self.trigger_alert(self.alert_text_edit.text()): self.close() - def onDeleteButtonClicked(self): + def on_delete_button_clicked(self): """ Deletes the selected item. """ @@ -160,8 +160,7 @@ class AlertForm(QtGui.QDialog, Ui_AlertDialog): def on_single_click(self): """ - List item has been single clicked to add it to the edit field so it can - be changed. + List item has been single clicked to add it to the edit field so it can be changed. """ item = self.alert_list_widget.selectedIndexes()[0] bitem = self.alert_list_widget.item(item.row()) @@ -186,7 +185,7 @@ class AlertForm(QtGui.QDialog, Ui_AlertDialog): translate('AlertsPlugin.AlertForm', 'No Parameter Found'), translate('AlertsPlugin.AlertForm', 'You have not entered a parameter to be replaced.\n' 'Do you want to continue anyway?'), - QtGui.QMessageBox.StandardButtons(QtGui.QMessageBox.No | QtGui.QMessageBox.Yes)) == QtGui.QMessageBox.No: + QtGui.QMessageBox.StandardButtons(QtGui.QMessageBox.No | QtGui.QMessageBox.Yes)) == QtGui.QMessageBox.No: self.parameter_edit.setFocus() return False # The ParameterEdit field is not empty, but we have not found '<>' @@ -195,7 +194,7 @@ class AlertForm(QtGui.QDialog, Ui_AlertDialog): translate('AlertsPlugin.AlertForm', 'No Placeholder Found'), translate('AlertsPlugin.AlertForm', 'The alert text does not contain \'<>\'.\n' 'Do you want to continue anyway?'), - QtGui.QMessageBox.StandardButtons(QtGui.QMessageBox.No | QtGui.QMessageBox.Yes)) == QtGui.QMessageBox.No: + QtGui.QMessageBox.StandardButtons(QtGui.QMessageBox.No | QtGui.QMessageBox.Yes)) == QtGui.QMessageBox.No: self.parameter_edit.setFocus() return False text = text.replace(u'<>', self.parameter_edit.text()) @@ -204,8 +203,8 @@ class AlertForm(QtGui.QDialog, Ui_AlertDialog): def on_current_row_changed(self, row): """ - Called when the *alert_list_widget*'s current row has been changed. This - enables or disables buttons which require an item to act on. + Called when the *alert_list_widget*'s current row has been changed. This enables or disables buttons which + require an item to act on. ``row`` The row (int). If there is no current row, the value is -1. diff --git a/openlp/plugins/alerts/lib/alertsmanager.py b/openlp/plugins/alerts/lib/alertsmanager.py index 042999a11..607706a13 100644 --- a/openlp/plugins/alerts/lib/alertsmanager.py +++ b/openlp/plugins/alerts/lib/alertsmanager.py @@ -27,8 +27,8 @@ # Temple Place, Suite 330, Boston, MA 02111-1307 USA # ############################################################################### """ -The :mod:`~openlp.plugins.alerts.lib.alertsmanager` module contains the part of -the plugin which manages storing and displaying of alerts. +The :mod:`~openlp.plugins.alerts.lib.alertsmanager` module contains the part of the plugin which manages storing and +displaying of alerts. """ import logging @@ -56,15 +56,14 @@ class AlertsManager(QtCore.QObject): def alert_text(self, message): """ - Called via a alerts_text event. Message is single element array - containing text + Called via a alerts_text event. Message is single element array containing text. """ if message: self.display_alert(message[0]) def display_alert(self, text=u''): """ - Called from the Alert Tab to display an alert + Called from the Alert Tab to display an alert. ``text`` display text @@ -81,7 +80,7 @@ class AlertsManager(QtCore.QObject): def generate_alert(self): """ - Format and request the Alert and start the timer + Format and request the Alert and start the timer. """ log.debug(u'Generate Alert called') if not self.alert_list: @@ -95,8 +94,7 @@ class AlertsManager(QtCore.QObject): def timerEvent(self, event): """ - Time has finished so if our time then request the next Alert - if there is one and reset the timer. + Time has finished so if our time then request the next Alert if there is one and reset the timer. ``event`` the QT event that has been triggered. diff --git a/openlp/plugins/alerts/lib/db.py b/openlp/plugins/alerts/lib/db.py index 58ee47076..499e63906 100644 --- a/openlp/plugins/alerts/lib/db.py +++ b/openlp/plugins/alerts/lib/db.py @@ -27,8 +27,7 @@ # Temple Place, Suite 330, Boston, MA 02111-1307 USA # ############################################################################### """ -The :mod:`db` module provides the database and schema that is the backend for -the Alerts plugin +The :mod:`db` module provides the database and schema that is the backend for the Alerts plugin. """ from sqlalchemy import Column, Table, types @@ -36,12 +35,14 @@ from sqlalchemy.orm import mapper from openlp.core.lib.db import BaseModel, init_db + class AlertItem(BaseModel): """ AlertItem model """ pass + def init_schema(url): """ Setup the alerts database connection and initialise the database schema From 098d733ad1ace0fd10ba97d51894f0b45d9aa95f Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Thu, 18 Apr 2013 19:45:14 +0200 Subject: [PATCH 63/97] bible renamings --- openlp/core/ui/firsttimelanguagedialog.py | 52 ++--- openlp/core/ui/firsttimelanguageform.py | 8 +- openlp/plugins/bibles/__init__.py | 3 +- openlp/plugins/bibles/bibleplugin.py | 63 +++--- openlp/plugins/bibles/forms/__init__.py | 30 ++- .../plugins/bibles/forms/bibleimportform.py | 10 +- .../plugins/bibles/forms/bibleupgradeform.py | 94 ++++---- openlp/plugins/bibles/forms/booknamedialog.py | 110 +++++----- openlp/plugins/bibles/forms/booknameform.py | 62 +++--- .../plugins/bibles/forms/editbibledialog.py | 200 +++++++++--------- openlp/plugins/bibles/forms/editbibleform.py | 48 ++--- openlp/plugins/bibles/forms/languagedialog.py | 68 +++--- openlp/plugins/bibles/forms/languageform.py | 16 +- openlp/plugins/bibles/lib/__init__.py | 61 +++--- openlp/plugins/bibles/lib/csvbible.py | 13 +- openlp/plugins/bibles/lib/db.py | 2 +- openlp/plugins/bibles/lib/http.py | 3 +- openlp/plugins/bibles/lib/mediaitem.py | 80 +++---- openlp/plugins/bibles/lib/opensong.py | 20 +- openlp/plugins/bibles/lib/osis.py | 14 +- openlp/plugins/bibles/lib/upgrade.py | 3 +- .../plugins/bibles/lib/versereferencelist.py | 4 +- 22 files changed, 465 insertions(+), 499 deletions(-) diff --git a/openlp/core/ui/firsttimelanguagedialog.py b/openlp/core/ui/firsttimelanguagedialog.py index 21f4dabcd..55fce4399 100644 --- a/openlp/core/ui/firsttimelanguagedialog.py +++ b/openlp/core/ui/firsttimelanguagedialog.py @@ -39,39 +39,39 @@ class Ui_FirstTimeLanguageDialog(object): """ The UI widgets of the language selection dialog. """ - def setupUi(self, languageDialog): + def setupUi(self, language_dialog): """ Set up the UI. """ - languageDialog.setObjectName(u'languageDialog') - languageDialog.resize(300, 50) - self.dialogLayout = QtGui.QVBoxLayout(languageDialog) - self.dialogLayout.setContentsMargins(8, 8, 8, 8) - self.dialogLayout.setSpacing(8) - self.dialogLayout.setObjectName(u'dialog_layout') - self.infoLabel = QtGui.QLabel(languageDialog) - self.infoLabel.setObjectName(u'infoLabel') - self.dialogLayout.addWidget(self.infoLabel) - self.languageLayout = QtGui.QHBoxLayout() - self.languageLayout.setObjectName(u'languageLayout') - self.languageLabel = QtGui.QLabel(languageDialog) - self.languageLabel.setObjectName(u'languageLabel') - self.languageLayout.addWidget(self.languageLabel) - self.languageComboBox = QtGui.QComboBox(languageDialog) - self.languageComboBox.setSizeAdjustPolicy(QtGui.QComboBox.AdjustToContents) - self.languageComboBox.setObjectName("languageComboBox") - self.languageLayout.addWidget(self.languageComboBox) - self.dialogLayout.addLayout(self.languageLayout) - self.button_box = create_button_box(languageDialog, u'button_box', [u'cancel', u'ok']) - self.dialogLayout.addWidget(self.button_box) - self.retranslateUi(languageDialog) + language_dialog.setObjectName(u'language_dialog') + language_dialog.resize(300, 50) + self.dialog_layout = QtGui.QVBoxLayout(language_dialog) + self.dialog_layout.setContentsMargins(8, 8, 8, 8) + self.dialog_layout.setSpacing(8) + self.dialog_layout.setObjectName(u'dialog_layout') + self.info_label = QtGui.QLabel(language_dialog) + self.info_label.setObjectName(u'info_label') + self.dialog_layout.addWidget(self.info_label) + self.language_layout = QtGui.QHBoxLayout() + self.language_layout.setObjectName(u'language_layout') + self.language_label = QtGui.QLabel(language_dialog) + self.language_label.setObjectName(u'language_label') + self.language_layout.addWidget(self.language_label) + self.language_combo_box = QtGui.QComboBox(language_dialog) + self.language_combo_box.setSizeAdjustPolicy(QtGui.QComboBox.AdjustToContents) + self.language_combo_box.setObjectName("language_combo_box") + self.language_layout.addWidget(self.language_combo_box) + self.dialog_layout.addLayout(self.language_layout) + self.button_box = create_button_box(language_dialog, u'button_box', [u'cancel', u'ok']) + self.dialog_layout.addWidget(self.button_box) + self.retranslateUi(language_dialog) self.setMaximumHeight(self.sizeHint().height()) - def retranslateUi(self, languageDialog): + def retranslateUi(self, language_dialog): """ Translate the UI on the fly. """ self.setWindowTitle(translate('OpenLP.FirstTimeLanguageForm', 'Select Translation')) - self.infoLabel.setText( + self.info_label.setText( translate('OpenLP.FirstTimeLanguageForm', 'Choose the translation you\'d like to use in OpenLP.')) - self.languageLabel.setText(translate('OpenLP.FirstTimeLanguageForm', 'Translation:')) + self.language_label.setText(translate('OpenLP.FirstTimeLanguageForm', 'Translation:')) diff --git a/openlp/core/ui/firsttimelanguageform.py b/openlp/core/ui/firsttimelanguageform.py index 85e98e114..14b9dadc3 100644 --- a/openlp/core/ui/firsttimelanguageform.py +++ b/openlp/core/ui/firsttimelanguageform.py @@ -47,8 +47,8 @@ class FirstTimeLanguageForm(QtGui.QDialog, Ui_FirstTimeLanguageDialog): QtGui.QDialog.__init__(self, parent) self.setupUi(self) self.qmList = LanguageManager.get_qm_list() - self.languageComboBox.addItem(u'Autodetect') - self.languageComboBox.addItems(sorted(self.qmList.keys())) + self.language_combo_box.addItem(u'Autodetect') + self.language_combo_box.addItems(sorted(self.qmList.keys())) def exec_(self): """ @@ -61,12 +61,12 @@ class FirstTimeLanguageForm(QtGui.QDialog, Ui_FirstTimeLanguageDialog): Run when the dialog is OKed. """ # It's the first row so must be Automatic - if self.languageComboBox.currentIndex() == 0: + if self.language_combo_box.currentIndex() == 0: LanguageManager.auto_language = True LanguageManager.set_language(False, False) else: LanguageManager.auto_language = False - action = create_action(None, self.languageComboBox.currentText()) + action = create_action(None, self.language_combo_box.currentText()) LanguageManager.set_language(action, False) return QtGui.QDialog.accept(self) diff --git a/openlp/plugins/bibles/__init__.py b/openlp/plugins/bibles/__init__.py index 1c1510e97..62e6c5f90 100644 --- a/openlp/plugins/bibles/__init__.py +++ b/openlp/plugins/bibles/__init__.py @@ -27,6 +27,5 @@ # Temple Place, Suite 330, Boston, MA 02111-1307 USA # ############################################################################### """ -The :mod:`bibles` module provides the Bible plugin to enable OpenLP to display -scripture. +The :mod:`bibles` module provides the Bible plugin to enable OpenLP to display scripture. """ diff --git a/openlp/plugins/bibles/bibleplugin.py b/openlp/plugins/bibles/bibleplugin.py index 1f17ae39a..e2888d67a 100644 --- a/openlp/plugins/bibles/bibleplugin.py +++ b/openlp/plugins/bibles/bibleplugin.py @@ -43,25 +43,25 @@ log = logging.getLogger(__name__) __default_settings__ = { - u'bibles/db type': u'sqlite', - u'bibles/last search type': BibleSearch.Reference, - u'bibles/verse layout style': LayoutStyle.VersePerSlide, - u'bibles/book name language': LanguageSelection.Bible, - u'bibles/display brackets': DisplayStyle.NoBrackets, - u'bibles/display new chapter': False, - u'bibles/second bibles': True, - u'bibles/advanced bible': u'', - u'bibles/quick bible': u'', - u'bibles/proxy name': u'', - u'bibles/proxy address': u'', - u'bibles/proxy username': u'', - u'bibles/proxy password': u'', - u'bibles/bible theme': u'', - u'bibles/verse separator': u'', - u'bibles/range separator': u'', - u'bibles/list separator': u'', - u'bibles/end separator': u'', - u'bibles/last directory import': u'' + u'bibles/db type': u'sqlite', + u'bibles/last search type': BibleSearch.Reference, + u'bibles/verse layout style': LayoutStyle.VersePerSlide, + u'bibles/book name language': LanguageSelection.Bible, + u'bibles/display brackets': DisplayStyle.NoBrackets, + u'bibles/display new chapter': False, + u'bibles/second bibles': True, + u'bibles/advanced bible': u'', + u'bibles/quick bible': u'', + u'bibles/proxy name': u'', + u'bibles/proxy address': u'', + u'bibles/proxy username': u'', + u'bibles/proxy password': u'', + u'bibles/bible theme': u'', + u'bibles/verse separator': u'', + u'bibles/range separator': u'', + u'bibles/list separator': u'', + u'bibles/end separator': u'', + u'bibles/last directory import': u'' } @@ -124,18 +124,15 @@ class BiblePlugin(Plugin): def add_export_menu_Item(self, export_menu): self.export_bible_item = create_action(export_menu, u'exportBibleItem', - text=translate('BiblesPlugin', '&Bible'), - visible=False) + text=translate('BiblesPlugin', '&Bible'), visible=False) export_menu.addAction(self.export_bible_item) def add_tools_menu_item(self, tools_menu): """ - Give the bible plugin the opportunity to add items to the - **Tools** menu. + Give the bible plugin the opportunity to add items to the **Tools** menu. ``tools_menu`` - The actual **Tools** menu item, so that your actions can - use it as their parent. + The actual **Tools** menu item, so that your actions can use it as their parent. """ log.debug(u'add tools menu') self.tools_upgrade_item = create_action(tools_menu, u'toolsUpgradeItem', @@ -166,25 +163,23 @@ class BiblePlugin(Plugin): def uses_theme(self, theme): """ - Called to find out if the bible plugin is currently using a theme. - Returns ``True`` if the theme is being used, otherwise returns - ``False``. + Called to find out if the bible plugin is currently using a theme. Returns ``True`` if the theme is being used, + otherwise returns ``False``. """ return unicode(self.settings_tab.bible_theme) == theme - def rename_theme(self, oldTheme, newTheme): + def rename_theme(self, old_theme, new_theme): """ Rename the theme the bible plugin is using making the plugin use the new name. - ``oldTheme`` - The name of the theme the plugin should stop using. Unused for - this particular plugin. + ``old_theme`` + The name of the theme the plugin should stop using. Unused for this particular plugin. - ``newTheme`` + ``new_theme`` The new name the plugin should now use. """ - self.settings_tab.bible_theme = newTheme + self.settings_tab.bible_theme = new_theme self.settings_tab.save() def set_plugin_text_strings(self): diff --git a/openlp/plugins/bibles/forms/__init__.py b/openlp/plugins/bibles/forms/__init__.py index ee0922695..abef5c85c 100644 --- a/openlp/plugins/bibles/forms/__init__.py +++ b/openlp/plugins/bibles/forms/__init__.py @@ -28,30 +28,25 @@ ############################################################################### """ -Forms in OpenLP are made up of two classes. One class holds all the graphical -elements, like buttons and lists, and the other class holds all the functional -code, like slots and loading and saving. +Forms in OpenLP are made up of two classes. One class holds all the graphical elements, like buttons and lists, and the +other class holds all the functional code, like slots and loading and saving. -The first class, commonly known as the **Dialog** class, is typically named -``Ui_Dialog``. It is a slightly modified version of the class that the -``pyuic4`` command produces from Qt4's .ui file. Typical modifications will be -converting most strings from "" to u'' and using OpenLP's ``translate()`` -function for translating strings. +The first class, commonly known as the **Dialog** class, is typically named ``Ui_Dialog``. It is a slightly +modified version of the class that the ``pyuic4`` command produces from Qt4's .ui file. Typical modifications will be +converting most strings from "" to u'' and using OpenLP's ``translate()`` function for translating strings. -The second class, commonly known as the **Form** class, is typically named -``Form``. This class is the one which is instantiated and used. It uses -dual inheritance to inherit from (usually) QtGui.QDialog and the Ui class -mentioned above, like so:: +The second class, commonly known as the **Form** class, is typically named ``Form``. This class is the one which +is instantiated and used. It uses dual inheritance to inherit from (usually) QtGui.QDialog and the Ui class mentioned +above, like so:: class BibleImportForm(QtGui.QWizard, Ui_BibleImportWizard): - def __init__(self, parent, manager, bibleplugin): + def __init__(self, parent, manager, bible_plugin): QtGui.QWizard.__init__(self, parent) self.setupUi(self) -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. +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 booknameform import BookNameForm from languageform import LanguageForm @@ -59,5 +54,4 @@ from bibleimportform import BibleImportForm from bibleupgradeform import BibleUpgradeForm from editbibleform import EditBibleForm -__all__ = [u'BookNameForm', u'LanguageForm', u'BibleImportForm', - u'BibleUpgradeForm', u'EditBibleForm'] +__all__ = [u'BookNameForm', u'LanguageForm', u'BibleImportForm', u'BibleUpgradeForm', u'EditBibleForm'] diff --git a/openlp/plugins/bibles/forms/bibleimportform.py b/openlp/plugins/bibles/forms/bibleimportform.py index f8d771e77..7cdd81229 100644 --- a/openlp/plugins/bibles/forms/bibleimportform.py +++ b/openlp/plugins/bibles/forms/bibleimportform.py @@ -58,12 +58,12 @@ class WebDownload(object): class BibleImportForm(OpenLPWizard): """ - This is the Bible Import Wizard, which allows easy importing of Bibles - into OpenLP from other formats like OSIS, CSV and OpenSong. + This is the Bible Import Wizard, which allows easy importing of Bibles into OpenLP from other formats like OSIS, + CSV and OpenSong. """ log.info(u'BibleImportForm loaded') - def __init__(self, parent, manager, bibleplugin): + def __init__(self, parent, manager, bible_plugin): """ Instantiate the wizard, and run any extra setup we need to. @@ -73,12 +73,12 @@ class BibleImportForm(OpenLPWizard): ``manager`` The Bible manager. - ``bibleplugin`` + ``bible_plugin`` The Bible plugin. """ self.manager = manager self.web_bible_list = {} - OpenLPWizard.__init__(self, parent, bibleplugin, u'bibleImportWizard', u':/wizards/wizard_importbible.bmp') + OpenLPWizard.__init__(self, parent, bible_plugin, u'bibleImportWizard', u':/wizards/wizard_importbible.bmp') def setupUi(self, image): """ diff --git a/openlp/plugins/bibles/forms/bibleupgradeform.py b/openlp/plugins/bibles/forms/bibleupgradeform.py index 0127d19be..d8f329ee7 100644 --- a/openlp/plugins/bibles/forms/bibleupgradeform.py +++ b/openlp/plugins/bibles/forms/bibleupgradeform.py @@ -48,8 +48,8 @@ log = logging.getLogger(__name__) class BibleUpgradeForm(OpenLPWizard): """ - This is the Bible Upgrade Wizard, which allows easy importing of Bibles - into OpenLP from older OpenLP2 database versions. + This is the Bible Upgrade Wizard, which allows easy importing of Bibles into OpenLP from older OpenLP2 database + versions. """ log.info(u'BibleUpgradeForm loaded') @@ -63,7 +63,7 @@ class BibleUpgradeForm(OpenLPWizard): ``manager`` The Bible manager. - ``bibleplugin`` + ``bible_plugin`` The Bible plugin. """ self.manager = manager @@ -74,7 +74,7 @@ class BibleUpgradeForm(OpenLPWizard): self.temp_dir = os.path.join(unicode(gettempdir(), get_filesystem_encoding()), u'openlp') self.files = self.manager.old_bible_databases self.success = {} - self.newbibles = {} + self.new_bibles = {} OpenLPWizard.__init__(self, parent, bible_plugin, u'bibleUpgradeWizard', u':/wizards/wizard_importbible.bmp') def setupUi(self, image): @@ -159,41 +159,41 @@ class BibleUpgradeForm(OpenLPWizard): Add the bible import specific wizard pages. """ # Backup Page - self.backupPage = QtGui.QWizardPage() - self.backupPage.setObjectName(u'BackupPage') - self.backupLayout = QtGui.QVBoxLayout(self.backupPage) + self.backup_page = QtGui.QWizardPage() + self.backup_page.setObjectName(u'BackupPage') + self.backupLayout = QtGui.QVBoxLayout(self.backup_page) self.backupLayout.setObjectName(u'BackupLayout') - self.backupInfoLabel = QtGui.QLabel(self.backupPage) + self.backupInfoLabel = QtGui.QLabel(self.backup_page) self.backupInfoLabel.setOpenExternalLinks(True) self.backupInfoLabel.setTextFormat(QtCore.Qt.RichText) self.backupInfoLabel.setWordWrap(True) self.backupInfoLabel.setObjectName(u'backupInfoLabel') self.backupLayout.addWidget(self.backupInfoLabel) - self.selectLabel = QtGui.QLabel(self.backupPage) + self.selectLabel = QtGui.QLabel(self.backup_page) self.selectLabel.setObjectName(u'select_label') self.backupLayout.addWidget(self.selectLabel) self.formLayout = QtGui.QFormLayout() self.formLayout.setMargin(0) self.formLayout.setObjectName(u'FormLayout') - self.backupDirectoryLabel = QtGui.QLabel(self.backupPage) + self.backupDirectoryLabel = QtGui.QLabel(self.backup_page) self.backupDirectoryLabel.setObjectName(u'backupDirectoryLabel') self.backupDirectoryLayout = QtGui.QHBoxLayout() self.backupDirectoryLayout.setObjectName(u'BackupDirectoryLayout') - self.backupDirectoryEdit = QtGui.QLineEdit(self.backupPage) + self.backupDirectoryEdit = QtGui.QLineEdit(self.backup_page) self.backupDirectoryEdit.setObjectName(u'BackupFolderEdit') self.backupDirectoryLayout.addWidget(self.backupDirectoryEdit) - self.backupBrowseButton = QtGui.QToolButton(self.backupPage) + self.backupBrowseButton = QtGui.QToolButton(self.backup_page) self.backupBrowseButton.setIcon(self.open_icon) self.backupBrowseButton.setObjectName(u'BackupBrowseButton') self.backupDirectoryLayout.addWidget(self.backupBrowseButton) self.formLayout.addRow(self.backupDirectoryLabel, self.backupDirectoryLayout) self.backupLayout.addLayout(self.formLayout) - self.noBackupCheckBox = QtGui.QCheckBox(self.backupPage) + self.noBackupCheckBox = QtGui.QCheckBox(self.backup_page) self.noBackupCheckBox.setObjectName('NoBackupCheckBox') self.backupLayout.addWidget(self.noBackupCheckBox) self.spacer = QtGui.QSpacerItem(10, 0, QtGui.QSizePolicy.Fixed, QtGui.QSizePolicy.Minimum) self.backupLayout.addItem(self.spacer) - self.addPage(self.backupPage) + self.addPage(self.backup_page) # Select Page self.selectPage = QtGui.QWizardPage() self.selectPage.setObjectName(u'SelectPage') @@ -247,8 +247,8 @@ class BibleUpgradeForm(OpenLPWizard): self.information_label.setText(translate('BiblesPlugin.UpgradeWizardForm', 'This wizard will help you to upgrade your existing Bibles from a prior version of OpenLP 2. ' 'Click the next button below to start the upgrade process.')) - self.backupPage.setTitle(translate('BiblesPlugin.UpgradeWizardForm', 'Select Backup Directory')) - self.backupPage.setSubTitle(translate('BiblesPlugin.UpgradeWizardForm', + self.backup_page.setTitle(translate('BiblesPlugin.UpgradeWizardForm', 'Select Backup Directory')) + self.backup_page.setSubTitle(translate('BiblesPlugin.UpgradeWizardForm', 'Please select a backup directory for your Bibles')) self.backupInfoLabel.setText(translate('BiblesPlugin.UpgradeWizardForm', 'Previous releases of OpenLP 2.0 are unable to use upgraded Bibles.' @@ -277,7 +277,7 @@ class BibleUpgradeForm(OpenLPWizard): """ if self.currentPage() == self.welcome_page: return True - elif self.currentPage() == self.backupPage: + elif self.currentPage() == self.backup_page: if not self.noBackupCheckBox.checkState() == QtCore.Qt.Checked: backup_path = self.backupDirectoryEdit.text() if not backup_path: @@ -316,7 +316,7 @@ class BibleUpgradeForm(OpenLPWizard): settings.beginGroup(self.plugin.settings_section) self.stop_import_flag = False self.success.clear() - self.newbibles.clear() + self.new_bibles.clear() self.clearScrollArea() self.files = self.manager.old_bible_databases self.addScrollArea() @@ -372,8 +372,8 @@ class BibleUpgradeForm(OpenLPWizard): name = filename[1] self.progress_label.setText(translate('BiblesPlugin.UpgradeWizardForm', 'Upgrading Bible %s of %s: "%s"\nUpgrading ...') % (number + 1, max_bibles, name)) - self.newbibles[number] = BibleDB(self.media_item, path=self.path, name=name, file=filename[0]) - self.newbibles[number].register(self.plugin.upgrade_wizard) + self.new_bibles[number] = BibleDB(self.media_item, path=self.path, name=name, file=filename[0]) + self.new_bibles[number].register(self.plugin.upgrade_wizard) metadata = old_bible.get_metadata() web_bible = False meta_data = {} @@ -387,7 +387,7 @@ class BibleUpgradeForm(OpenLPWizard): # Copy the metadata meta_data[meta[u'key']] = meta[u'value'] if meta[u'key'] != u'name' and meta[u'key'] != u'dbversion': - self.newbibles[number].save_meta(meta[u'key'], meta[u'value']) + self.new_bibles[number].save_meta(meta[u'key'], meta[u'value']) if meta[u'key'] == u'download_source': web_bible = True self.includeWebBible = True @@ -403,8 +403,8 @@ class BibleUpgradeForm(OpenLPWizard): if not books: log.error(u'Upgrading books from %s - download name: "%s" failed' % ( meta_data[u'download_source'], meta_data[u'download_name'])) - self.newbibles[number].session.close() - del self.newbibles[number] + self.new_bibles[number].session.close() + del self.new_bibles[number] critical_error_message_box( translate('BiblesPlugin.UpgradeWizardForm', 'Download Error'), translate('BiblesPlugin.UpgradeWizardForm', @@ -419,14 +419,14 @@ class BibleUpgradeForm(OpenLPWizard): meta_data[u'download_source'].lower()) if bible and bible[u'language_id']: language_id = bible[u'language_id'] - self.newbibles[number].save_meta(u'language_id', + self.new_bibles[number].save_meta(u'language_id', language_id) else: - language_id = self.newbibles[number].get_language(name) + language_id = self.new_bibles[number].get_language(name) if not language_id: log.warn(u'Upgrading from "%s" failed' % filename[0]) - self.newbibles[number].session.close() - del self.newbibles[number] + self.new_bibles[number].session.close() + del self.new_bibles[number] self.increment_progress_bar(translate('BiblesPlugin.UpgradeWizardForm', 'Upgrading Bible %s of %s: "%s"\nFailed') % (number + 1, max_bibles, name), self.progress_bar.maximum() - self.progress_bar.value()) @@ -439,17 +439,17 @@ class BibleUpgradeForm(OpenLPWizard): break self.increment_progress_bar(translate('BiblesPlugin.UpgradeWizardForm', 'Upgrading Bible %s of %s: "%s"\nUpgrading %s ...') % (number + 1, max_bibles, name, book)) - book_ref_id = self.newbibles[number].\ + book_ref_id = self.new_bibles[number].\ get_book_ref_id_by_name(book, len(books), language_id) if not book_ref_id: log.warn(u'Upgrading books from %s - download name: "%s" aborted by user' % ( meta_data[u'download_source'], meta_data[u'download_name'])) - self.newbibles[number].session.close() - del self.newbibles[number] + self.new_bibles[number].session.close() + del self.new_bibles[number] self.success[number] = False break book_details = BiblesResourcesDB.get_book_by_id(book_ref_id) - db_book = self.newbibles[number].create_book(book, + db_book = self.new_bibles[number].create_book(book, book_ref_id, book_details[u'testament_id']) # Try to import already downloaded verses. oldbook = old_bible.get_book(book) @@ -462,19 +462,19 @@ class BibleUpgradeForm(OpenLPWizard): if self.stop_import_flag: self.success[number] = False break - self.newbibles[number].create_verse(db_book.id, + self.new_bibles[number].create_verse(db_book.id, int(verse[u'chapter']), int(verse[u'verse']), unicode(verse[u'text'])) self.application.process_events() - self.newbibles[number].session.commit() + self.new_bibles[number].session.commit() else: - language_id = self.newbibles[number].get_object(BibleMeta, u'language_id') + language_id = self.new_bibles[number].get_object(BibleMeta, u'language_id') if not language_id: - language_id = self.newbibles[number].get_language(name) + language_id = self.new_bibles[number].get_language(name) if not language_id: log.warn(u'Upgrading books from "%s" failed' % name) - self.newbibles[number].session.close() - del self.newbibles[number] + self.new_bibles[number].session.close() + del self.new_bibles[number] self.increment_progress_bar(translate('BiblesPlugin.UpgradeWizardForm', 'Upgrading Bible %s of %s: "%s"\nFailed') % (number + 1, max_bibles, name), self.progress_bar.maximum() - self.progress_bar.value()) @@ -489,41 +489,41 @@ class BibleUpgradeForm(OpenLPWizard): self.increment_progress_bar(translate('BiblesPlugin.UpgradeWizardForm', 'Upgrading Bible %s of %s: "%s"\nUpgrading %s ...') % (number + 1, max_bibles, name, book[u'name'])) - book_ref_id = self.newbibles[number].get_book_ref_id_by_name(book[u'name'], len(books), language_id) + book_ref_id = self.new_bibles[number].get_book_ref_id_by_name(book[u'name'], len(books), language_id) if not book_ref_id: log.warn(u'Upgrading books from %s " failed - aborted by user' % name) - self.newbibles[number].session.close() - del self.newbibles[number] + self.new_bibles[number].session.close() + del self.new_bibles[number] self.success[number] = False break book_details = BiblesResourcesDB.get_book_by_id(book_ref_id) - db_book = self.newbibles[number].create_book(book[u'name'], + db_book = self.new_bibles[number].create_book(book[u'name'], book_ref_id, book_details[u'testament_id']) verses = old_bible.get_verses(book[u'id']) if not verses: log.warn(u'No verses found to import for book "%s"', book[u'name']) - self.newbibles[number].delete_book(db_book) + self.new_bibles[number].delete_book(db_book) continue for verse in verses: if self.stop_import_flag: self.success[number] = False break - self.newbibles[number].create_verse(db_book.id, + self.new_bibles[number].create_verse(db_book.id, int(verse[u'chapter']), int(verse[u'verse']), unicode(verse[u'text'])) self.application.process_events() - self.newbibles[number].session.commit() + self.new_bibles[number].session.commit() if not self.success.get(number, True): self.increment_progress_bar(translate('BiblesPlugin.UpgradeWizardForm', 'Upgrading Bible %s of %s: "%s"\nFailed') % (number + 1, max_bibles, name), self.progress_bar.maximum() - self.progress_bar.value()) else: self.success[number] = True - self.newbibles[number].save_meta(u'name', name) + self.new_bibles[number].save_meta(u'name', name) self.increment_progress_bar(translate('BiblesPlugin.UpgradeWizardForm', 'Upgrading Bible %s of %s: "%s"\nComplete') % (number + 1, max_bibles, name)) - if number in self.newbibles: - self.newbibles[number].session.close() + if number in self.new_bibles: + self.new_bibles[number].session.close() # Close the last bible's connection if possible. if old_bible is not None: old_bible.close_connection() diff --git a/openlp/plugins/bibles/forms/booknamedialog.py b/openlp/plugins/bibles/forms/booknamedialog.py index df86b4380..285e9cdcc 100644 --- a/openlp/plugins/bibles/forms/booknamedialog.py +++ b/openlp/plugins/bibles/forms/booknamedialog.py @@ -33,66 +33,66 @@ from openlp.core.lib import translate from openlp.core.lib.ui import create_button_box class Ui_BookNameDialog(object): - def setupUi(self, bookNameDialog): - bookNameDialog.setObjectName(u'bookNameDialog') - bookNameDialog.resize(400, 271) - self.bookNameLayout = QtGui.QVBoxLayout(bookNameDialog) - self.bookNameLayout.setSpacing(8) - self.bookNameLayout.setMargin(8) - self.bookNameLayout.setObjectName(u'bookNameLayout') - self.infoLabel = QtGui.QLabel(bookNameDialog) - self.infoLabel.setWordWrap(True) - self.infoLabel.setObjectName(u'infoLabel') - self.bookNameLayout.addWidget(self.infoLabel) - self.correspondingLayout = QtGui.QGridLayout() - self.correspondingLayout.setColumnStretch(1, 1) - self.correspondingLayout.setSpacing(8) - self.correspondingLayout.setObjectName(u'correspondingLayout') - self.currentLabel = QtGui.QLabel(bookNameDialog) + def setupUi(self, book_name_dialog): + book_name_dialog.setObjectName(u'book_name_dialog') + book_name_dialog.resize(400, 271) + self.book_name_layout = QtGui.QVBoxLayout(book_name_dialog) + self.book_name_layout.setSpacing(8) + self.book_name_layout.setMargin(8) + self.book_name_layout.setObjectName(u'book_name_layout') + self.info_label = QtGui.QLabel(book_name_dialog) + self.info_label.setWordWrap(True) + self.info_label.setObjectName(u'info_label') + self.book_name_layout.addWidget(self.info_label) + self.corresponding_layout = QtGui.QGridLayout() + self.corresponding_layout.setColumnStretch(1, 1) + self.corresponding_layout.setSpacing(8) + self.corresponding_layout.setObjectName(u'corresponding_layout') + self.currentLabel = QtGui.QLabel(book_name_dialog) self.currentLabel.setObjectName(u'currentLabel') - self.correspondingLayout.addWidget(self.currentLabel, 0, 0, 1, 1) - self.currentBookLabel = QtGui.QLabel(bookNameDialog) - self.currentBookLabel.setObjectName(u'currentBookLabel') - self.correspondingLayout.addWidget(self.currentBookLabel, 0, 1, 1, 1) - self.correspondingLabel = QtGui.QLabel(bookNameDialog) + self.corresponding_layout.addWidget(self.currentLabel, 0, 0, 1, 1) + self.current_book_label = QtGui.QLabel(book_name_dialog) + self.current_book_label.setObjectName(u'current_book_label') + self.corresponding_layout.addWidget(self.current_book_label, 0, 1, 1, 1) + self.correspondingLabel = QtGui.QLabel(book_name_dialog) self.correspondingLabel.setObjectName(u'correspondingLabel') - self.correspondingLayout.addWidget(self.correspondingLabel, 1, 0, 1, 1) - self.correspondingComboBox = QtGui.QComboBox(bookNameDialog) - self.correspondingComboBox.setObjectName(u'correspondingComboBox') - self.correspondingLayout.addWidget(self.correspondingComboBox, 1, 1, 1, 1) - self.bookNameLayout.addLayout(self.correspondingLayout) - self.optionsGroupBox = QtGui.QGroupBox(bookNameDialog) - self.optionsGroupBox.setObjectName(u'optionsGroupBox') - self.optionsLayout = QtGui.QVBoxLayout(self.optionsGroupBox) - self.optionsLayout.setSpacing(8) - self.optionsLayout.setMargin(8) - self.optionsLayout.setObjectName(u'optionsLayout') - self.oldTestamentCheckBox = QtGui.QCheckBox(self.optionsGroupBox) - self.oldTestamentCheckBox.setObjectName(u'oldTestamentCheckBox') - self.oldTestamentCheckBox.setCheckState(QtCore.Qt.Checked) - self.optionsLayout.addWidget(self.oldTestamentCheckBox) - self.newTestamentCheckBox = QtGui.QCheckBox(self.optionsGroupBox) - self.newTestamentCheckBox.setObjectName(u'newTestamentCheckBox') - self.newTestamentCheckBox.setCheckState(QtCore.Qt.Checked) - self.optionsLayout.addWidget(self.newTestamentCheckBox) - self.apocryphaCheckBox = QtGui.QCheckBox(self.optionsGroupBox) - self.apocryphaCheckBox.setObjectName(u'apocryphaCheckBox') - self.apocryphaCheckBox.setCheckState(QtCore.Qt.Checked) - self.optionsLayout.addWidget(self.apocryphaCheckBox) - self.bookNameLayout.addWidget(self.optionsGroupBox) - self.button_box = create_button_box(bookNameDialog, u'button_box', [u'cancel', u'ok']) - self.bookNameLayout.addWidget(self.button_box) + self.corresponding_layout.addWidget(self.correspondingLabel, 1, 0, 1, 1) + self.corresponding_combo_box = QtGui.QComboBox(book_name_dialog) + self.corresponding_combo_box.setObjectName(u'corresponding_combo_box') + self.corresponding_layout.addWidget(self.corresponding_combo_box, 1, 1, 1, 1) + self.book_name_layout.addLayout(self.corresponding_layout) + self.options_group_box = QtGui.QGroupBox(book_name_dialog) + self.options_group_box.setObjectName(u'options_group_box') + self.options_layout = QtGui.QVBoxLayout(self.options_group_box) + self.options_layout.setSpacing(8) + self.options_layout.setMargin(8) + self.options_layout.setObjectName(u'options_layout') + self.old_testament_check_box = QtGui.QCheckBox(self.options_group_box) + self.old_testament_check_box.setObjectName(u'old_testament_check_box') + self.old_testament_check_box.setCheckState(QtCore.Qt.Checked) + self.options_layout.addWidget(self.old_testament_check_box) + self.new_testament_check_box = QtGui.QCheckBox(self.options_group_box) + self.new_testament_check_box.setObjectName(u'new_testament_check_box') + self.new_testament_check_box.setCheckState(QtCore.Qt.Checked) + self.options_layout.addWidget(self.new_testament_check_box) + self.apocrypha_check_box = QtGui.QCheckBox(self.options_group_box) + self.apocrypha_check_box.setObjectName(u'apocrypha_check_box') + self.apocrypha_check_box.setCheckState(QtCore.Qt.Checked) + self.options_layout.addWidget(self.apocrypha_check_box) + self.book_name_layout.addWidget(self.options_group_box) + self.button_box = create_button_box(book_name_dialog, u'button_box', [u'cancel', u'ok']) + self.book_name_layout.addWidget(self.button_box) - self.retranslateUi(bookNameDialog) + self.retranslateUi(book_name_dialog) - def retranslateUi(self, bookNameDialog): - bookNameDialog.setWindowTitle(translate('BiblesPlugin.BookNameDialog', 'Select Book Name')) - self.infoLabel.setText(translate('BiblesPlugin.BookNameDialog', + def retranslateUi(self, book_name_dialog): + book_name_dialog.setWindowTitle(translate('BiblesPlugin.BookNameDialog', 'Select Book Name')) + self.info_label.setText(translate('BiblesPlugin.BookNameDialog', 'The following book name cannot be matched up internally. ' 'Please select the corresponding name from the list.')) self.currentLabel.setText(translate('BiblesPlugin.BookNameDialog', 'Current name:')) self.correspondingLabel.setText(translate('BiblesPlugin.BookNameDialog', 'Corresponding name:')) - self.optionsGroupBox.setTitle(translate('BiblesPlugin.BookNameDialog', 'Show Books From')) - self.oldTestamentCheckBox.setText(translate('BiblesPlugin.BookNameDialog', 'Old Testament')) - self.newTestamentCheckBox.setText(translate('BiblesPlugin.BookNameDialog', 'New Testament')) - self.apocryphaCheckBox.setText(translate('BiblesPlugin.BookNameDialog', 'Apocrypha')) + self.options_group_box.setTitle(translate('BiblesPlugin.BookNameDialog', 'Show Books From')) + self.old_testament_check_box.setText(translate('BiblesPlugin.BookNameDialog', 'Old Testament')) + self.new_testament_check_box.setText(translate('BiblesPlugin.BookNameDialog', 'New Testament')) + self.apocrypha_check_box.setText(translate('BiblesPlugin.BookNameDialog', 'Apocrypha')) diff --git a/openlp/plugins/bibles/forms/booknameform.py b/openlp/plugins/bibles/forms/booknameform.py index c8abaa227..cc213cf96 100644 --- a/openlp/plugins/bibles/forms/booknameform.py +++ b/openlp/plugins/bibles/forms/booknameform.py @@ -66,61 +66,61 @@ class BookNameForm(QDialog, Ui_BookNameDialog): """ Set up the signals used in the booknameform. """ - self.oldTestamentCheckBox.stateChanged.connect(self.onCheckBoxIndexChanged) - self.newTestamentCheckBox.stateChanged.connect(self.onCheckBoxIndexChanged) - self.apocryphaCheckBox.stateChanged.connect(self.onCheckBoxIndexChanged) + self.old_testament_check_box.stateChanged.connect(self.onCheckBoxIndexChanged) + self.new_testament_check_box.stateChanged.connect(self.onCheckBoxIndexChanged) + self.apocrypha_check_box.stateChanged.connect(self.onCheckBoxIndexChanged) def onCheckBoxIndexChanged(self, index): """ Reload Combobox if CheckBox state has changed """ - self.reloadComboBox() + self.reload_combo_box() - def reloadComboBox(self): + def reload_combo_box(self): """ Reload the Combobox items """ - self.correspondingComboBox.clear() + self.corresponding_combo_box.clear() items = BiblesResourcesDB.get_books() for item in items: - addBook = True + add_book = True for book in self.books: if book.book_reference_id == item[u'id']: - addBook = False + add_book = False break - if self.oldTestamentCheckBox.checkState() == QtCore.Qt.Unchecked and item[u'testament_id'] == 1: - addBook = False - elif self.newTestamentCheckBox.checkState() == QtCore.Qt.Unchecked and item[u'testament_id'] == 2: - addBook = False - elif self.apocryphaCheckBox.checkState() == QtCore.Qt.Unchecked and item[u'testament_id'] == 3: - addBook = False - if addBook: - self.correspondingComboBox.addItem(self.book_names[item[u'abbreviation']]) + if self.old_testament_check_box.checkState() == QtCore.Qt.Unchecked and item[u'testament_id'] == 1: + add_book = False + elif self.new_testament_check_box.checkState() == QtCore.Qt.Unchecked and item[u'testament_id'] == 2: + add_book = False + elif self.apocrypha_check_box.checkState() == QtCore.Qt.Unchecked and item[u'testament_id'] == 3: + add_book = False + if add_book: + self.corresponding_combo_box.addItem(self.book_names[item[u'abbreviation']]) - def exec_(self, name, books, maxbooks): + def exec_(self, name, books, max_books): self.books = books - log.debug(maxbooks) - if maxbooks <= 27: - self.oldTestamentCheckBox.setCheckState(QtCore.Qt.Unchecked) - self.apocryphaCheckBox.setCheckState(QtCore.Qt.Unchecked) - elif maxbooks <= 66: - self.apocryphaCheckBox.setCheckState(QtCore.Qt.Unchecked) - self.reloadComboBox() - self.currentBookLabel.setText(unicode(name)) - self.correspondingComboBox.setFocus() + log.debug(max_books) + if max_books <= 27: + self.old_testament_check_box.setCheckState(QtCore.Qt.Unchecked) + self.apocrypha_check_box.setCheckState(QtCore.Qt.Unchecked) + elif max_books <= 66: + self.apocrypha_check_box.setCheckState(QtCore.Qt.Unchecked) + self.reload_combo_box() + self.current_book_label.setText(unicode(name)) + self.corresponding_combo_box.setFocus() return QDialog.exec_(self) def accept(self): - if self.correspondingComboBox.currentText() == u'': + if not self.corresponding_combo_box.currentText(): critical_error_message_box(message=translate('BiblesPlugin.BookNameForm', 'You need to select a book.')) - self.correspondingComboBox.setFocus() + self.corresponding_combo_box.setFocus() return False else: - cor_book = self.correspondingComboBox.currentText() + cor_book = self.corresponding_combo_box.currentText() for character in u'\\.^$*+?{}[]()': cor_book = cor_book.replace(character, u'\\' + character) - books = filter(lambda key: - re.match(cor_book, unicode(self.book_names[key]), re.UNICODE), self.book_names.keys()) + books = filter( + lambda key: re.match(cor_book, unicode(self.book_names[key]), re.UNICODE), self.book_names.keys()) books = filter(None, map(BiblesResourcesDB.get_book, books)) if books: self.book_id = books[0][u'id'] diff --git a/openlp/plugins/bibles/forms/editbibledialog.py b/openlp/plugins/bibles/forms/editbibledialog.py index b45bb2751..79cef2575 100644 --- a/openlp/plugins/bibles/forms/editbibledialog.py +++ b/openlp/plugins/bibles/forms/editbibledialog.py @@ -36,118 +36,118 @@ from openlp.plugins.bibles.lib.db import BiblesResourcesDB class Ui_EditBibleDialog(object): - def setupUi(self, editBibleDialog): - editBibleDialog.setObjectName(u'editBibleDialog') - editBibleDialog.resize(520, 400) - editBibleDialog.setWindowIcon(build_icon(u':/icon/openlp-logo-16x16.png')) - editBibleDialog.setModal(True) - self.dialogLayout = QtGui.QVBoxLayout(editBibleDialog) - self.dialogLayout.setSpacing(8) - self.dialogLayout.setContentsMargins(8, 8, 8, 8) - self.dialogLayout.setObjectName(u'dialog_layout') - self.bibleTabWidget = QtGui.QTabWidget(editBibleDialog) - self.bibleTabWidget.setObjectName(u'BibleTabWidget') + def setupUi(self, edit_bible_dialog): + edit_bible_dialog.setObjectName(u'edit_bible_dialog') + edit_bible_dialog.resize(520, 400) + edit_bible_dialog.setWindowIcon(build_icon(u':/icon/openlp-logo-16x16.png')) + edit_bible_dialog.setModal(True) + self.dialog_layout = QtGui.QVBoxLayout(edit_bible_dialog) + self.dialog_layout.setSpacing(8) + self.dialog_layout.setContentsMargins(8, 8, 8, 8) + self.dialog_layout.setObjectName(u'dialog_layout') + self.bible_tab_widget = QtGui.QTabWidget(edit_bible_dialog) + self.bible_tab_widget.setObjectName(u'BibleTabWidget') # Meta tab - self.metaTab = QtGui.QWidget() - self.metaTab.setObjectName(u'metaTab') - self.metaTabLayout = QtGui.QVBoxLayout(self.metaTab) - self.metaTabLayout.setObjectName(u'metaTabLayout') - self.licenseDetailsGroupBox = QtGui.QGroupBox(self.metaTab) - self.licenseDetailsGroupBox.setObjectName(u'licenseDetailsGroupBox') - self.licenseDetailsLayout = QtGui.QFormLayout(self.licenseDetailsGroupBox) - self.licenseDetailsLayout.setObjectName(u'licenseDetailsLayout') - self.versionNameLabel = QtGui.QLabel(self.licenseDetailsGroupBox) - self.versionNameLabel.setObjectName(u'versionNameLabel') - self.versionNameEdit = QtGui.QLineEdit(self.licenseDetailsGroupBox) - self.versionNameEdit.setObjectName(u'versionNameEdit') - self.versionNameLabel.setBuddy(self.versionNameEdit) - self.licenseDetailsLayout.addRow(self.versionNameLabel, self.versionNameEdit) - self.copyrightLabel = QtGui.QLabel(self.licenseDetailsGroupBox) - self.copyrightLabel.setObjectName(u'copyrightLabel') - self.copyrightEdit = QtGui.QLineEdit(self.licenseDetailsGroupBox) - self.copyrightEdit.setObjectName(u'copyright_edit') - self.copyrightLabel.setBuddy(self.copyrightEdit) - self.licenseDetailsLayout.addRow(self.copyrightLabel, self.copyrightEdit) - self.permissionsLabel = QtGui.QLabel(self.licenseDetailsGroupBox) - self.permissionsLabel.setObjectName(u'permissionsLabel') - self.permissionsEdit = QtGui.QLineEdit(self.licenseDetailsGroupBox) - self.permissionsEdit.setObjectName(u'permissionsEdit') - self.permissionsLabel.setBuddy(self.permissionsEdit) - self.licenseDetailsLayout.addRow(self.permissionsLabel, self.permissionsEdit) - self.metaTabLayout.addWidget(self.licenseDetailsGroupBox) - self.languageSelectionGroupBox = QtGui.QGroupBox(self.metaTab) - self.languageSelectionGroupBox.setObjectName(u'languageSelectionGroupBox') - self.languageSelectionLayout = QtGui.QVBoxLayout(self.languageSelectionGroupBox) - self.languageSelectionLabel = QtGui.QLabel(self.languageSelectionGroupBox) - self.languageSelectionLabel.setObjectName(u'languageSelectionLabel') - self.languageSelectionComboBox = QtGui.QComboBox(self.languageSelectionGroupBox) - self.languageSelectionComboBox.setObjectName(u'languageSelectionComboBox') - self.languageSelectionComboBox.addItems([u'', u'', u'', u'']) - self.languageSelectionLayout.addWidget(self.languageSelectionLabel) - self.languageSelectionLayout.addWidget(self.languageSelectionComboBox) - self.metaTabLayout.addWidget(self.languageSelectionGroupBox) - self.metaTabLayout.addStretch() - self.bibleTabWidget.addTab(self.metaTab, u'') + self.meta_tab = QtGui.QWidget() + self.meta_tab.setObjectName(u'meta_tab') + self.meta_tab_layout = QtGui.QVBoxLayout(self.meta_tab) + self.meta_tab_layout.setObjectName(u'meta_tab_layout') + self.license_details_group_box = QtGui.QGroupBox(self.meta_tab) + self.license_details_group_box.setObjectName(u'license_details_group_box') + self.license_details_layout = QtGui.QFormLayout(self.license_details_group_box) + self.license_details_layout.setObjectName(u'license_details_layout') + self.version_name_label = QtGui.QLabel(self.license_details_group_box) + self.version_name_label.setObjectName(u'version_name_label') + self.version_name_edit = QtGui.QLineEdit(self.license_details_group_box) + self.version_name_edit.setObjectName(u'version_name_edit') + self.version_name_label.setBuddy(self.version_name_edit) + self.license_details_layout.addRow(self.version_name_label, self.version_name_edit) + self.copyright_label = QtGui.QLabel(self.license_details_group_box) + self.copyright_label.setObjectName(u'copyright_label') + self.copyright_edit = QtGui.QLineEdit(self.license_details_group_box) + self.copyright_edit.setObjectName(u'copyright_edit') + self.copyright_label.setBuddy(self.copyright_edit) + self.license_details_layout.addRow(self.copyright_label, self.copyright_edit) + self.permissions_label = QtGui.QLabel(self.license_details_group_box) + self.permissions_label.setObjectName(u'permissions_label') + self.permissions_edit = QtGui.QLineEdit(self.license_details_group_box) + self.permissions_edit.setObjectName(u'permissions_edit') + self.permissions_label.setBuddy(self.permissions_edit) + self.license_details_layout.addRow(self.permissions_label, self.permissions_edit) + self.meta_tab_layout.addWidget(self.license_details_group_box) + self.language_selection_group_box = QtGui.QGroupBox(self.meta_tab) + self.language_selection_group_box.setObjectName(u'language_selection_group_box') + self.language_selection_layout = QtGui.QVBoxLayout(self.language_selection_group_box) + self.language_selection_label = QtGui.QLabel(self.language_selection_group_box) + self.language_selection_label.setObjectName(u'language_selection_label') + self.language_selection_combo_box = QtGui.QComboBox(self.language_selection_group_box) + self.language_selection_combo_box.setObjectName(u'language_selection_combo_box') + self.language_selection_combo_box.addItems([u'', u'', u'', u'']) + self.language_selection_layout.addWidget(self.language_selection_label) + self.language_selection_layout.addWidget(self.language_selection_combo_box) + self.meta_tab_layout.addWidget(self.language_selection_group_box) + self.meta_tab_layout.addStretch() + self.bible_tab_widget.addTab(self.meta_tab, u'') # Book name tab - self.bookNameTab = QtGui.QWidget() - self.bookNameTab.setObjectName(u'bookNameTab') - self.bookNameTabLayout = QtGui.QVBoxLayout(self.bookNameTab) - self.bookNameTabLayout.setObjectName(u'bookNameTabLayout') - self.bookNameNotice = QtGui.QLabel(self.bookNameTab) - self.bookNameNotice.setObjectName(u'bookNameNotice') - self.bookNameNotice.setWordWrap(True) - self.bookNameTabLayout.addWidget(self.bookNameNotice) - self.scrollArea = QtGui.QScrollArea(self.bookNameTab) - self.scrollArea.setWidgetResizable(True) - self.scrollArea.setObjectName(u'scrollArea') - self.scrollArea.setHorizontalScrollBarPolicy(QtCore.Qt.ScrollBarAlwaysOff) - self.bookNameWidget = QtGui.QWidget(self.scrollArea) - self.bookNameWidget.setObjectName(u'bookNameWidget') - self.bookNameWidgetLayout = QtGui.QFormLayout(self.bookNameWidget) - self.bookNameWidgetLayout.setObjectName(u'bookNameWidgetLayout') - self.bookNameLabel = {} - self.bookNameEdit= {} + self.book_name_tab = QtGui.QWidget() + self.book_name_tab.setObjectName(u'book_name_tab') + self.book_name_tab_layout = QtGui.QVBoxLayout(self.book_name_tab) + self.book_name_tab_layout.setObjectName(u'book_name_tab_layout') + self.book_name_notice = QtGui.QLabel(self.book_name_tab) + self.book_name_notice.setObjectName(u'book_name_notice') + self.book_name_notice.setWordWrap(True) + self.book_name_tab_layout.addWidget(self.book_name_notice) + self.scroll_area = QtGui.QScrollArea(self.book_name_tab) + self.scroll_area.setWidgetResizable(True) + self.scroll_area.setObjectName(u'scroll_area') + self.scroll_area.setHorizontalScrollBarPolicy(QtCore.Qt.ScrollBarAlwaysOff) + self.book_name_widget = QtGui.QWidget(self.scroll_area) + self.book_name_widget.setObjectName(u'book_name_widget') + self.book_name_widget_layout = QtGui.QFormLayout(self.book_name_widget) + self.book_name_widget_layout.setObjectName(u'book_name_widget_layout') + self.book_name_label = {} + self.book_name_edit= {} for book in BiblesResourcesDB.get_books(): - self.bookNameLabel[book[u'abbreviation']] = QtGui.QLabel(self.bookNameWidget) - self.bookNameLabel[book[u'abbreviation']].setObjectName(u'bookNameLabel[%s]' % book[u'abbreviation']) - self.bookNameEdit[book[u'abbreviation']] = QtGui.QLineEdit(self.bookNameWidget) - self.bookNameEdit[book[u'abbreviation']].setObjectName(u'bookNameEdit[%s]' % book[u'abbreviation']) - self.bookNameWidgetLayout.addRow( - self.bookNameLabel[book[u'abbreviation']], - self.bookNameEdit[book[u'abbreviation']]) - self.scrollArea.setWidget(self.bookNameWidget) - self.bookNameTabLayout.addWidget(self.scrollArea) - self.bookNameTabLayout.addStretch() - self.bibleTabWidget.addTab(self.bookNameTab, u'') + self.book_name_label[book[u'abbreviation']] = QtGui.QLabel(self.book_name_widget) + self.book_name_label[book[u'abbreviation']].setObjectName(u'book_name_label[%s]' % book[u'abbreviation']) + self.book_name_edit[book[u'abbreviation']] = QtGui.QLineEdit(self.book_name_widget) + self.book_name_edit[book[u'abbreviation']].setObjectName(u'book_name_edit[%s]' % book[u'abbreviation']) + self.book_name_widget_layout.addRow( + self.book_name_label[book[u'abbreviation']], + self.book_name_edit[book[u'abbreviation']]) + self.scroll_area.setWidget(self.book_name_widget) + self.book_name_tab_layout.addWidget(self.scroll_area) + self.book_name_tab_layout.addStretch() + self.bible_tab_widget.addTab(self.book_name_tab, u'') # Last few bits - self.dialogLayout.addWidget(self.bibleTabWidget) - self.button_box = create_button_box(editBibleDialog, u'button_box', [u'cancel', u'save']) - self.dialogLayout.addWidget(self.button_box) - self.retranslateUi(editBibleDialog) - QtCore.QMetaObject.connectSlotsByName(editBibleDialog) + self.dialog_layout.addWidget(self.bible_tab_widget) + self.button_box = create_button_box(edit_bible_dialog, u'button_box', [u'cancel', u'save']) + self.dialog_layout.addWidget(self.button_box) + self.retranslateUi(edit_bible_dialog) + QtCore.QMetaObject.connectSlotsByName(edit_bible_dialog) - def retranslateUi(self, editBibleDialog): + def retranslateUi(self, edit_bible_dialog): self.book_names = BibleStrings().BookNames - editBibleDialog.setWindowTitle(translate('BiblesPlugin.EditBibleForm', 'Bible Editor')) + edit_bible_dialog.setWindowTitle(translate('BiblesPlugin.EditBibleForm', 'Bible Editor')) # Meta tab - self.bibleTabWidget.setTabText( self.bibleTabWidget.indexOf(self.metaTab), + self.bible_tab_widget.setTabText( self.bible_tab_widget.indexOf(self.meta_tab), translate('SongsPlugin.EditBibleForm', 'Meta Data')) - self.licenseDetailsGroupBox.setTitle(translate('BiblesPlugin.EditBibleForm', 'License Details')) - self.versionNameLabel.setText(translate('BiblesPlugin.EditBibleForm', 'Version name:')) - self.copyrightLabel.setText(translate('BiblesPlugin.EditBibleForm', 'Copyright:')) - self.permissionsLabel.setText(translate('BiblesPlugin.EditBibleForm', 'Permissions:')) - self.languageSelectionGroupBox.setTitle(translate('BiblesPlugin.EditBibleForm', 'Default Bible Language')) - self.languageSelectionLabel.setText(translate('BiblesPlugin.EditBibleForm', + self.license_details_group_box.setTitle(translate('BiblesPlugin.EditBibleForm', 'License Details')) + self.version_name_label.setText(translate('BiblesPlugin.EditBibleForm', 'Version name:')) + self.copyright_label.setText(translate('BiblesPlugin.EditBibleForm', 'Copyright:')) + self.permissions_label.setText(translate('BiblesPlugin.EditBibleForm', 'Permissions:')) + self.language_selection_group_box.setTitle(translate('BiblesPlugin.EditBibleForm', 'Default Bible Language')) + self.language_selection_label.setText(translate('BiblesPlugin.EditBibleForm', 'Book name language in search field, search results and on display:')) - self.languageSelectionComboBox.setItemText(0, translate('BiblesPlugin.EditBibleForm', 'Global Settings')) - self.languageSelectionComboBox.setItemText(LanguageSelection.Bible + 1, + self.language_selection_combo_box.setItemText(0, translate('BiblesPlugin.EditBibleForm', 'Global Settings')) + self.language_selection_combo_box.setItemText(LanguageSelection.Bible + 1, translate('BiblesPlugin.EditBibleForm', 'Bible Language')) - self.languageSelectionComboBox.setItemText(LanguageSelection.Application + 1, + self.language_selection_combo_box.setItemText(LanguageSelection.Application + 1, translate('BiblesPlugin.EditBibleForm', 'Application Language')) - self.languageSelectionComboBox.setItemText(LanguageSelection.English + 1, + self.language_selection_combo_box.setItemText(LanguageSelection.English + 1, translate('BiblesPlugin.EditBibleForm', 'English')) # Book name tab - self.bibleTabWidget.setTabText(self.bibleTabWidget.indexOf(self.bookNameTab), + self.bible_tab_widget.setTabText(self.bible_tab_widget.indexOf(self.book_name_tab), translate('SongsPlugin.EditBibleForm', 'Custom Book Names')) for book in BiblesResourcesDB.get_books(): - self.bookNameLabel[book[u'abbreviation']].setText(u'%s:' % unicode(self.book_names[book[u'abbreviation']])) + self.book_name_label[book[u'abbreviation']].setText(u'%s:' % unicode(self.book_names[book[u'abbreviation']])) diff --git a/openlp/plugins/bibles/forms/editbibleform.py b/openlp/plugins/bibles/forms/editbibleform.py index cbb02109a..b05fb68fb 100644 --- a/openlp/plugins/bibles/forms/editbibleform.py +++ b/openlp/plugins/bibles/forms/editbibleform.py @@ -65,33 +65,33 @@ class EditBibleForm(QtGui.QDialog, Ui_EditBibleDialog): """ log.debug(u'Load Bible') self.bible = bible - self.versionNameEdit.setText(self.manager.get_meta_data(self.bible, u'name').value) - self.copyrightEdit.setText(self.manager.get_meta_data(self.bible, u'copyright').value) - self.permissionsEdit.setText(self.manager.get_meta_data(self.bible, u'permissions').value) + self.version_name_edit.setText(self.manager.get_meta_data(self.bible, u'name').value) + self.copyright_edit.setText(self.manager.get_meta_data(self.bible, u'copyright').value) + self.permissions_edit.setText(self.manager.get_meta_data(self.bible, u'permissions').value) book_name_language = self.manager.get_meta_data(self.bible, u'book_name_language') if book_name_language and book_name_language.value != u'None': - self.languageSelectionComboBox.setCurrentIndex(int(book_name_language.value) + 1) + self.language_selection_combo_box.setCurrentIndex(int(book_name_language.value) + 1) self.books = {} self.webbible = self.manager.get_meta_data(self.bible, u'download_source') if self.webbible: - self.bookNameNotice.setText(translate('BiblesPlugin.EditBibleForm', + self.book_name_notice.setText(translate('BiblesPlugin.EditBibleForm', 'This is a Web Download Bible.\nIt is not possible to customize the Book Names.')) - self.scrollArea.hide() + self.scroll_area.hide() else: - self.bookNameNotice.setText(translate('BiblesPlugin.EditBibleForm', + self.book_name_notice.setText(translate('BiblesPlugin.EditBibleForm', 'To use the customized book names, "Bible language" must be selected on the Meta Data tab or, ' 'if "Global settings" is selected, on the Bible page in Configure OpenLP.')) for book in BiblesResourcesDB.get_books(): self.books[book[u'abbreviation']] = self.manager.get_book_by_id(self.bible, book[u'id']) if self.books[book[u'abbreviation']] and not self.webbible: - self.bookNameEdit[book[u'abbreviation']].setText(self.books[book[u'abbreviation']].name) + self.book_name_edit[book[u'abbreviation']].setText(self.books[book[u'abbreviation']].name) else: # It is necessary to remove the Widget otherwise there still # exists the vertical spacing in QFormLayout - self.bookNameWidgetLayout.removeWidget(self.bookNameLabel[book[u'abbreviation']]) - self.bookNameLabel[book[u'abbreviation']].hide() - self.bookNameWidgetLayout.removeWidget(self.bookNameEdit[book[u'abbreviation']]) - self.bookNameEdit[book[u'abbreviation']].hide() + self.book_name_widget_layout.removeWidget(self.book_name_label[book[u'abbreviation']]) + self.book_name_label[book[u'abbreviation']].hide() + self.book_name_widget_layout.removeWidget(self.book_name_edit[book[u'abbreviation']]) + self.book_name_edit[book[u'abbreviation']].hide() def reject(self): """ @@ -106,10 +106,10 @@ class EditBibleForm(QtGui.QDialog, Ui_EditBibleDialog): Exit Dialog and save data """ log.debug(u'BibleEditForm.accept') - version = self.versionNameEdit.text() - copyright = self.copyrightEdit.text() - permissions = self.permissionsEdit.text() - book_name_language = self.languageSelectionComboBox.currentIndex() - 1 + version = self.version_name_edit.text() + copyright = self.copyright_edit.text() + permissions = self.permissions_edit.text() + book_name_language = self.language_selection_combo_box.currentIndex() - 1 if book_name_language == -1: book_name_language = None if not self.validateMeta(version, copyright): @@ -118,7 +118,7 @@ class EditBibleForm(QtGui.QDialog, Ui_EditBibleDialog): custom_names = {} for abbr, book in self.books.iteritems(): if book: - custom_names[abbr] = self.bookNameEdit[abbr].text() + custom_names[abbr] = self.book_name_edit[abbr].text() if book.name != custom_names[abbr]: if not self.validateBook(custom_names[abbr], abbr): return @@ -139,19 +139,19 @@ class EditBibleForm(QtGui.QDialog, Ui_EditBibleDialog): Validate the Meta before saving. """ if not name: - self.versionNameEdit.setFocus() + self.version_name_edit.setFocus() critical_error_message_box(UiStrings().EmptyField, translate('BiblesPlugin.BibleEditForm', 'You need to specify a version name for your Bible.')) return False elif not copyright: - self.copyrightEdit.setFocus() + self.copyright_edit.setFocus() critical_error_message_box(UiStrings().EmptyField, translate('BiblesPlugin.BibleEditForm', 'You need to set a copyright for your Bible. Bibles in the Public Domain need to be marked as such.')) return False elif self.manager.exists(name) and self.manager.get_meta_data(self.bible, u'name').value != \ name: - self.versionNameEdit.setFocus() + self.version_name_edit.setFocus() critical_error_message_box(translate('BiblesPlugin.BibleEditForm', 'Bible Exists'), translate('BiblesPlugin.BibleEditForm', 'This Bible already exists. Please import ' 'a different Bible or first delete the existing one.')) @@ -164,13 +164,13 @@ class EditBibleForm(QtGui.QDialog, Ui_EditBibleDialog): """ book_regex = re.compile(u'[\d]*[^\d]+$') if not new_book_name: - self.bookNameEdit[abbreviation].setFocus() + self.book_name_edit[abbreviation].setFocus() critical_error_message_box(UiStrings().EmptyField, translate('BiblesPlugin.BibleEditForm', 'You need to specify a book name for "%s".') % self.book_names[abbreviation]) return False elif not book_regex.match(new_book_name): - self.bookNameEdit[abbreviation].setFocus() + self.book_name_edit[abbreviation].setFocus() critical_error_message_box(UiStrings().EmptyField, translate('BiblesPlugin.BibleEditForm', 'The book name "%s" is not correct.\nNumbers can only be used at the beginning and must\nbe ' @@ -180,8 +180,8 @@ class EditBibleForm(QtGui.QDialog, Ui_EditBibleDialog): if book: if abbr == abbreviation: continue - if self.bookNameEdit[abbr].text() == new_book_name: - self.bookNameEdit[abbreviation].setFocus() + if self.book_name_edit[abbr].text() == new_book_name: + self.book_name_edit[abbreviation].setFocus() critical_error_message_box( translate('BiblesPlugin.BibleEditForm', 'Duplicate Book Name'), translate('BiblesPlugin.BibleEditForm', 'The Book Name "%s" has been entered more than once.') diff --git a/openlp/plugins/bibles/forms/languagedialog.py b/openlp/plugins/bibles/forms/languagedialog.py index 9ad16bb30..870957c3c 100644 --- a/openlp/plugins/bibles/forms/languagedialog.py +++ b/openlp/plugins/bibles/forms/languagedialog.py @@ -33,44 +33,44 @@ from openlp.core.lib import translate from openlp.core.lib.ui import create_button_box class Ui_LanguageDialog(object): - def setupUi(self, languageDialog): - languageDialog.setObjectName(u'languageDialog') - languageDialog.resize(400, 165) - self.languageLayout = QtGui.QVBoxLayout(languageDialog) - self.languageLayout.setSpacing(8) - self.languageLayout.setMargin(8) - self.languageLayout.setObjectName(u'languageLayout') - self.bibleLabel = QtGui.QLabel(languageDialog) - self.bibleLabel.setObjectName(u'bibleLabel') - self.languageLayout.addWidget(self.bibleLabel) - self.infoLabel = QtGui.QLabel(languageDialog) - self.infoLabel.setWordWrap(True) - self.infoLabel.setObjectName(u'infoLabel') - self.languageLayout.addWidget(self.infoLabel) - self.languageHBoxLayout = QtGui.QHBoxLayout() - self.languageHBoxLayout.setSpacing(8) - self.languageHBoxLayout.setObjectName(u'languageHBoxLayout') - self.languageLabel = QtGui.QLabel(languageDialog) - self.languageLabel.setObjectName(u'languageLabel') - self.languageHBoxLayout.addWidget(self.languageLabel) - self.languageComboBox = QtGui.QComboBox(languageDialog) + def setupUi(self, language_dialog): + language_dialog.setObjectName(u'language_dialog') + language_dialog.resize(400, 165) + self.language_layout = QtGui.QVBoxLayout(language_dialog) + self.language_layout.setSpacing(8) + self.language_layout.setMargin(8) + self.language_layout.setObjectName(u'language_layout') + self.bible_label = QtGui.QLabel(language_dialog) + self.bible_label.setObjectName(u'bible_label') + self.language_layout.addWidget(self.bible_label) + self.info_label = QtGui.QLabel(language_dialog) + self.info_label.setWordWrap(True) + self.info_label.setObjectName(u'info_label') + self.language_layout.addWidget(self.info_label) + self.language_h_box_layout = QtGui.QHBoxLayout() + self.language_h_box_layout.setSpacing(8) + self.language_h_box_layout.setObjectName(u'language_h_box_layout') + self.language_label = QtGui.QLabel(language_dialog) + self.language_label.setObjectName(u'language_label') + self.language_h_box_layout.addWidget(self.language_label) + self.language_combo_box = QtGui.QComboBox(language_dialog) sizePolicy = QtGui.QSizePolicy(QtGui.QSizePolicy.MinimumExpanding, QtGui.QSizePolicy.Fixed) sizePolicy.setHorizontalStretch(0) sizePolicy.setVerticalStretch(0) - sizePolicy.setHeightForWidth(self.languageComboBox.sizePolicy().hasHeightForWidth()) - self.languageComboBox.setSizePolicy(sizePolicy) - self.languageComboBox.setObjectName(u'languageComboBox') - self.languageHBoxLayout.addWidget(self.languageComboBox) - self.languageLayout.addLayout(self.languageHBoxLayout) - self.button_box = create_button_box(languageDialog, u'button_box', [u'cancel', u'ok']) - self.languageLayout.addWidget(self.button_box) + sizePolicy.setHeightForWidth(self.language_combo_box.sizePolicy().hasHeightForWidth()) + self.language_combo_box.setSizePolicy(sizePolicy) + self.language_combo_box.setObjectName(u'language_combo_box') + self.language_h_box_layout.addWidget(self.language_combo_box) + self.language_layout.addLayout(self.language_h_box_layout) + self.button_box = create_button_box(language_dialog, u'button_box', [u'cancel', u'ok']) + self.language_layout.addWidget(self.button_box) - self.retranslateUi(languageDialog) + self.retranslateUi(language_dialog) - def retranslateUi(self, languageDialog): - languageDialog.setWindowTitle(translate('BiblesPlugin.LanguageDialog', 'Select Language')) - self.bibleLabel.setText(translate('BiblesPlugin.LanguageDialog', '')) - self.infoLabel.setText(translate('BiblesPlugin.LanguageDialog', + def retranslateUi(self, language_dialog): + language_dialog.setWindowTitle(translate('BiblesPlugin.LanguageDialog', 'Select Language')) + self.bible_label.setText(translate('BiblesPlugin.LanguageDialog', '')) + self.info_label.setText(translate('BiblesPlugin.LanguageDialog', 'OpenLP is unable to determine the language of this translation of the Bible. Please select the language ' 'from the list below.')) - self.languageLabel.setText(translate('BiblesPlugin.LanguageDialog', 'Language:')) + self.language_label.setText(translate('BiblesPlugin.LanguageDialog', 'Language:')) diff --git a/openlp/plugins/bibles/forms/languageform.py b/openlp/plugins/bibles/forms/languageform.py index cdac6dec9..2bba3d7a4 100644 --- a/openlp/plugins/bibles/forms/languageform.py +++ b/openlp/plugins/bibles/forms/languageform.py @@ -40,8 +40,10 @@ from openlp.plugins.bibles.forms.languagedialog import \ Ui_LanguageDialog from openlp.plugins.bibles.lib.db import BiblesResourcesDB + log = logging.getLogger(__name__) + class LanguageForm(QDialog, Ui_LanguageDialog): """ Class to manage a dialog which ask the user for a language. @@ -56,19 +58,17 @@ class LanguageForm(QDialog, Ui_LanguageDialog): self.setupUi(self) def exec_(self, bible_name): - self.languageComboBox.addItem(u'') + self.language_combo_box.addItem(u'') if bible_name: - self.bibleLabel.setText(unicode(bible_name)) + self.bible_label.setText(unicode(bible_name)) items = BiblesResourcesDB.get_languages() - self.languageComboBox.addItems([item[u'name'] for item in items]) + self.language_combo_box.addItems([item[u'name'] for item in items]) return QDialog.exec_(self) def accept(self): - if not self.languageComboBox.currentText(): - critical_error_message_box( - message=translate('BiblesPlugin.LanguageForm', - 'You need to choose a language.')) - self.languageComboBox.setFocus() + if not self.language_combo_box.currentText(): + critical_error_message_box(message=translate('BiblesPlugin.LanguageForm', 'You need to choose a language.')) + self.language_combo_box.setFocus() return False else: return QDialog.accept(self) diff --git a/openlp/plugins/bibles/lib/__init__.py b/openlp/plugins/bibles/lib/__init__.py index 219b91f90..371632d41 100644 --- a/openlp/plugins/bibles/lib/__init__.py +++ b/openlp/plugins/bibles/lib/__init__.py @@ -38,9 +38,11 @@ from openlp.core.lib import Settings, translate log = logging.getLogger(__name__) + REFERENCE_MATCHES = {} REFERENCE_SEPARATORS = {} + class LayoutStyle(object): """ An enumeration for bible screen layout styles. @@ -62,8 +64,7 @@ class DisplayStyle(object): class LanguageSelection(object): """ - An enumeration for bible bookname language. - And standard strings for use throughout the bibles plugin. + An enumeration for bible bookname language. And standard strings for use throughout the bibles plugin. """ Bible = 0 Application = 1 @@ -178,8 +179,7 @@ class BibleStrings(object): def update_reference_separators(): """ - Updates separators and matches for parsing and formating scripture - references. + Updates separators and matches for parsing and formating scripture references. """ default_separators = translate('BiblesPlugin', ':|v|V|verse|verses;;-|to;;,|and;;end Double-semicolon delimited separators for parsing references. ' @@ -245,9 +245,8 @@ def get_reference_match(match_type): def parse_reference(reference, bible, language_selection, book_ref_id=False): """ - This is the next generation über-awesome function that takes a person's - typed in string and converts it to a list of references to be queried from - the Bible database files. + This is the next generation über-awesome function that takes a person's typed in string and converts it to a list + of references to be queried from the Bible database files. ``reference`` A string. The Bible reference to parse. @@ -256,16 +255,14 @@ def parse_reference(reference, bible, language_selection, book_ref_id=False): A object. The Bible database object. ``language_selection`` - An int. The language selection the user has choosen in settings - section. + An int. The language selection the user has choosen in settings section. ``book_ref_id`` A string. The book reference id. Returns ``None`` or a reference list. - The reference list is a list of tuples, with each tuple structured like - this:: + The reference list is a list of tuples, with each tuple structured like this:: (book, chapter, from_verse, to_verse) @@ -275,8 +272,7 @@ def parse_reference(reference, bible, language_selection, book_ref_id=False): **Reference string details:** - Each reference starts with the book name and a chapter number. These are - both mandatory. + Each reference starts with the book name and a chapter number. These are both mandatory. * ``John 3`` refers to Gospel of John chapter 3 @@ -289,38 +285,31 @@ def parse_reference(reference, bible, language_selection, book_ref_id=False): * ``John 3:16`` refers to John chapter 3 verse 16 * ``John 3:16-4:3`` refers to John chapter 3 verse 16 to chapter 4 verse 3 - After a verse reference all further single values are treat as verse in - the last selected chapter. + After a verse reference all further single values are treat as verse in the last selected chapter. * ``John 3:16-18`` refers to John chapter 3 verses 16 to 18 - After a list separator it is possible to refer to additional verses. They - are build analog to the first ones. This way it is possible to define each - number of verse references. It is not possible to refer to verses in - additional books. + After a list separator it is possible to refer to additional verses. They are build analog to the first ones. This + way it is possible to define each number of verse references. It is not possible to refer to verses in additional + books. * ``John 3:16,18`` refers to John chapter 3 verses 16 and 18 * ``John 3:16-18,20`` refers to John chapter 3 verses 16 to 18 and 20 - * ``John 3:16-18,4:1`` refers to John chapter 3 verses 16 to 18 and - chapter 4 verse 1 + * ``John 3:16-18,4:1`` refers to John chapter 3 verses 16 to 18 and chapter 4 verse 1 - If there is a range separator without further verse declaration the last - refered chapter is addressed until the end. + If there is a range separator without further verse declaration the last refered chapter is addressed until the end. - ``range_regex`` is a regular expression which matches for verse range - declarations: + ``range_regex`` is a regular expression which matches for verse range declarations: ``(?:(?P[0-9]+)%(sep_v)s)?`` - It starts with a optional chapter reference ``from_chapter`` followed by - a verse separator. + It starts with a optional chapter reference ``from_chapter`` followed by a verse separator. ``(?P[0-9]+)`` The verse reference ``from_verse`` is manditory ``(?P%(sep_r)s(?:`` ... ``|%(sep_e)s)?)?`` - A ``range_to`` declaration is optional. It starts with a range separator - and contains optional a chapter and verse declaration or a end - separator. + A ``range_to`` declaration is optional. It starts with a range separator and contains optional a chapter and + verse declaration or a end separator. ``(?:(?P[0-9]+)%(sep_v)s)?`` The ``to_chapter`` reference with separator is equivalent to group 1. @@ -328,17 +317,15 @@ def parse_reference(reference, bible, language_selection, book_ref_id=False): ``(?P[0-9]+)`` The ``to_verse`` reference is equivalent to group 2. - The full reference is matched against get_reference_match(u'full'). This - regular expression looks like this: + The full reference is matched against get_reference_match(u'full'). This regular expression looks like this: ``^\s*(?!\s)(?P[\d]*[^\d]+)(?(?:%(range_regex)s(?:%(sep_l)s(?!\s*$)|(?=\s*$)))+)\s*$`` - The second group contains all ``ranges``. This can be multiple - declarations of range_regex separated by a list separator. + The second group contains all ``ranges``. This can be multiple declarations of range_regex separated by a list + separator. """ log.debug(u'parse_reference("%s")', reference) diff --git a/openlp/plugins/bibles/lib/csvbible.py b/openlp/plugins/bibles/lib/csvbible.py index f57da2ba0..7cf004cfc 100644 --- a/openlp/plugins/bibles/lib/csvbible.py +++ b/openlp/plugins/bibles/lib/csvbible.py @@ -27,8 +27,7 @@ # Temple Place, Suite 330, Boston, MA 02111-1307 USA # ############################################################################### """ -The :mod:`cvsbible` modules provides a facility to import bibles from a set of -CSV files. +The :mod:`cvsbible` modules provides a facility to import bibles from a set of CSV files. The module expects two mandatory files containing the books and the verses. @@ -55,8 +54,7 @@ There are two acceptable formats of the verses file. They are: or "Genesis",1,2,"And the earth was without form, and void; and...." -All CSV files are expected to use a comma (',') as the delimiter and double -quotes ('"') as the quote symbol. +All CSV files are expected to use a comma (',') as the delimiter and double quotes ('"') as the quote symbol. """ import logging import chardet @@ -65,8 +63,10 @@ import csv from openlp.core.lib import translate from openlp.plugins.bibles.lib.db import BibleDB, BiblesResourcesDB + log = logging.getLogger(__name__) + class CSVBible(BibleDB): """ This class provides a specialisation for importing of CSV Bibles. @@ -75,9 +75,8 @@ class CSVBible(BibleDB): def __init__(self, parent, **kwargs): """ - Loads a Bible from a set of CSV files. - This class assumes the files contain all the information and - a clean bible is being loaded. + Loads a Bible from a set of CSV files. This class assumes the files contain all the information and a clean + bible is being loaded. """ log.info(self.__class__.__name__) BibleDB.__init__(self, parent, **kwargs) diff --git a/openlp/plugins/bibles/lib/db.py b/openlp/plugins/bibles/lib/db.py index 4193668e2..837dbec38 100644 --- a/openlp/plugins/bibles/lib/db.py +++ b/openlp/plugins/bibles/lib/db.py @@ -511,7 +511,7 @@ class BibleDB(QtCore.QObject, Manager): language = None language_form = LanguageForm(self.wizard) if language_form.exec_(bible_name): - language = unicode(language_form.languageComboBox.currentText()) + language = unicode(language_form.language_combo_box.currentText()) if not language: return False language = BiblesResourcesDB.get_language(language) diff --git a/openlp/plugins/bibles/lib/http.py b/openlp/plugins/bibles/lib/http.py index b01377a05..14c502265 100644 --- a/openlp/plugins/bibles/lib/http.py +++ b/openlp/plugins/bibles/lib/http.py @@ -27,8 +27,7 @@ # Temple Place, Suite 330, Boston, MA 02111-1307 USA # ############################################################################### """ -The :mod:`http` module enables OpenLP to retrieve scripture from bible -websites. +The :mod:`http` module enables OpenLP to retrieve scripture from bible websites. """ import logging import re diff --git a/openlp/plugins/bibles/lib/mediaitem.py b/openlp/plugins/bibles/lib/mediaitem.py index b5352db9f..b67bb99b2 100644 --- a/openlp/plugins/bibles/lib/mediaitem.py +++ b/openlp/plugins/bibles/lib/mediaitem.py @@ -61,8 +61,8 @@ class BibleMediaItem(MediaManagerItem): def __init__(self, parent, plugin): self.icon_path = u'songs/song' - self.lockIcon = build_icon(u':/bibles/bibles_search_lock.png') - self.unlockIcon = build_icon(u':/bibles/bibles_search_unlock.png') + self.lock_icon = build_icon(u':/bibles/bibles_search_lock.png') + self.unlock_icon = build_icon(u':/bibles/bibles_search_unlock.png') MediaManagerItem.__init__(self, parent, plugin) # Place to store the search results for both bibles. self.settings = self.plugin.settings_tab @@ -73,7 +73,7 @@ class BibleMediaItem(MediaManagerItem): self.check_search_result() Registry().register_function(u'bibles_load_list', self.reload_bibles) - def __checkSecondBible(self, bible, second_bible): + def __check_second_bible(self, bible, second_bible): """ Check if the first item is a second bible item or not. """ @@ -84,7 +84,7 @@ class BibleMediaItem(MediaManagerItem): self.displayResults(bible, second_bible) return else: - item_second_bible = self._decodeQtObject(bitem, 'second_bible') + item_second_bible = self._decode_qt_object(bitem, 'second_bible') if item_second_bible and second_bible or not item_second_bible and not second_bible: self.displayResults(bible, second_bible) elif critical_error_message_box( @@ -95,7 +95,7 @@ class BibleMediaItem(MediaManagerItem): self.list_view.clear() self.displayResults(bible, second_bible) - def _decodeQtObject(self, bitem, key): + def _decode_qt_object(self, bitem, key): reference = bitem.data(QtCore.Qt.UserRole) obj = reference[unicode(key)] return unicode(obj).strip() @@ -159,7 +159,7 @@ class BibleMediaItem(MediaManagerItem): search_button_layout.setObjectName(prefix + u'search_button_layout') search_button_layout.addStretch() lockButton = QtGui.QToolButton(tab) - lockButton.setIcon(self.unlockIcon) + lockButton.setIcon(self.unlock_icon) lockButton.setCheckable(True) lockButton.setObjectName(prefix + u'LockButton') search_button_layout.addWidget(lockButton) @@ -509,9 +509,9 @@ class BibleMediaItem(MediaManagerItem): def onLockButtonToggled(self, checked): if checked: - self.sender().setIcon(self.lockIcon) + self.sender().setIcon(self.lock_icon) else: - self.sender().setIcon(self.unlockIcon) + self.sender().setIcon(self.unlock_icon) def onQuickStyleComboBoxChanged(self): self.settings.layout_style = self.quickStyleComboBox.currentIndex() @@ -633,7 +633,7 @@ class BibleMediaItem(MediaManagerItem): if not self.advancedLockButton.isChecked(): self.list_view.clear() if self.list_view.count() != 0: - self.__checkSecondBible(bible, second_bible) + self.__check_second_bible(bible, second_bible) elif self.search_results: self.displayResults(bible, second_bible) self.advancedSearchButton.setEnabled(True) @@ -689,7 +689,7 @@ class BibleMediaItem(MediaManagerItem): if not self.quickLockButton.isChecked(): self.list_view.clear() if self.list_view.count() != 0 and self.search_results: - self.__checkSecondBible(bible, second_bible) + self.__check_second_bible(bible, second_bible) elif self.search_results: self.displayResults(bible, second_bible) self.quickSearchButton.setEnabled(True) @@ -787,19 +787,19 @@ class BibleMediaItem(MediaManagerItem): raw_title = [] verses = VerseReferenceList() for bitem in items: - book = self._decodeQtObject(bitem, 'book') - chapter = int(self._decodeQtObject(bitem, 'chapter')) - verse = int(self._decodeQtObject(bitem, 'verse')) - bible = self._decodeQtObject(bitem, 'bible') - version = self._decodeQtObject(bitem, 'version') - copyright = self._decodeQtObject(bitem, 'copyright') - permissions = self._decodeQtObject(bitem, 'permissions') - text = self._decodeQtObject(bitem, 'text') - second_bible = self._decodeQtObject(bitem, 'second_bible') - second_version = self._decodeQtObject(bitem, 'second_version') - second_copyright = self._decodeQtObject(bitem, 'second_copyright') - second_permissions = self._decodeQtObject(bitem, 'second_permissions') - second_text = self._decodeQtObject(bitem, 'second_text') + book = self._decode_qt_object(bitem, 'book') + chapter = int(self._decode_qt_object(bitem, 'chapter')) + verse = int(self._decode_qt_object(bitem, 'verse')) + bible = self._decode_qt_object(bitem, 'bible') + version = self._decode_qt_object(bitem, 'version') + copyright = self._decode_qt_object(bitem, 'copyright') + permissions = self._decode_qt_object(bitem, 'permissions') + text = self._decode_qt_object(bitem, 'text') + second_bible = self._decode_qt_object(bitem, 'second_bible') + second_version = self._decode_qt_object(bitem, 'second_version') + second_copyright = self._decode_qt_object(bitem, 'second_copyright') + second_permissions = self._decode_qt_object(bitem, 'second_permissions') + second_text = self._decode_qt_object(bitem, 'second_text') verses.add(book, chapter, verse, version, copyright, permissions) verse_text = self.formatVerse(old_chapter, chapter, verse) if second_bible: @@ -867,13 +867,13 @@ class BibleMediaItem(MediaManagerItem): """ verse_separator = get_reference_separator(u'sep_v_display') range_separator = get_reference_separator(u'sep_r_display') - old_chapter = self._decodeQtObject(old_bitem, 'chapter') - old_verse = self._decodeQtObject(old_bitem, 'verse') - start_book = self._decodeQtObject(start_bitem, 'book') - start_chapter = self._decodeQtObject(start_bitem, 'chapter') - start_verse = self._decodeQtObject(start_bitem, 'verse') - start_bible = self._decodeQtObject(start_bitem, 'bible') - start_second_bible = self._decodeQtObject(start_bitem, 'second_bible') + old_chapter = self._decode_qt_object(old_bitem, 'chapter') + old_verse = self._decode_qt_object(old_bitem, 'verse') + start_book = self._decode_qt_object(start_bitem, 'book') + start_chapter = self._decode_qt_object(start_bitem, 'chapter') + start_verse = self._decode_qt_object(start_bitem, 'verse') + start_bible = self._decode_qt_object(start_bitem, 'bible') + start_second_bible = self._decode_qt_object(start_bitem, 'second_bible') if start_second_bible: bibles = u'%s, %s' % (start_bible, start_second_bible) else: @@ -901,16 +901,16 @@ class BibleMediaItem(MediaManagerItem): The item we were previously dealing with. """ # Get all the necessary meta data. - book = self._decodeQtObject(bitem, 'book') - chapter = int(self._decodeQtObject(bitem, 'chapter')) - verse = int(self._decodeQtObject(bitem, 'verse')) - bible = self._decodeQtObject(bitem, 'bible') - second_bible = self._decodeQtObject(bitem, 'second_bible') - old_book = self._decodeQtObject(old_bitem, 'book') - old_chapter = int(self._decodeQtObject(old_bitem, 'chapter')) - old_verse = int(self._decodeQtObject(old_bitem, 'verse')) - old_bible = self._decodeQtObject(old_bitem, 'bible') - old_second_bible = self._decodeQtObject(old_bitem, 'second_bible') + book = self._decode_qt_object(bitem, 'book') + chapter = int(self._decode_qt_object(bitem, 'chapter')) + verse = int(self._decode_qt_object(bitem, 'verse')) + bible = self._decode_qt_object(bitem, 'bible') + second_bible = self._decode_qt_object(bitem, 'second_bible') + old_book = self._decode_qt_object(old_bitem, 'book') + old_chapter = int(self._decode_qt_object(old_bitem, 'chapter')) + old_verse = int(self._decode_qt_object(old_bitem, 'verse')) + old_bible = self._decode_qt_object(old_bitem, 'bible') + old_second_bible = self._decode_qt_object(old_bitem, 'second_bible') if old_bible != bible or old_second_bible != second_bible or old_book != book: # The bible, second bible or book has changed. return True diff --git a/openlp/plugins/bibles/lib/opensong.py b/openlp/plugins/bibles/lib/opensong.py index 9b4b216d7..9a6c62aad 100644 --- a/openlp/plugins/bibles/lib/opensong.py +++ b/openlp/plugins/bibles/lib/opensong.py @@ -34,16 +34,18 @@ from openlp.core.lib import translate from openlp.core.lib.ui import critical_error_message_box from openlp.plugins.bibles.lib.db import BibleDB, BiblesResourcesDB + log = logging.getLogger(__name__) + class OpenSongBible(BibleDB): """ OpenSong Bible format importer class. """ def __init__(self, parent, **kwargs): """ - Constructor to create and set up an instance of the OpenSongBible - class. This class is used to import Bibles from OpenSong's XML format. + Constructor to create and set up an instance of the OpenSongBible class. This class is used to import Bibles + from OpenSong's XML format. """ log.debug(self.__class__.__name__) BibleDB.__init__(self, parent, **kwargs) @@ -75,9 +77,8 @@ class OpenSongBible(BibleDB): file = None success = True try: - # NOTE: We don't need to do any of the normal encoding detection - # here, because lxml does it's own encoding detection, and the two - # mechanisms together interfere with each other. + # NOTE: We don't need to do any of the normal encoding detection here, because lxml does it's own encoding + # detection, and the two mechanisms together interfere with each other. file = open(self.filename, u'r') opensong = objectify.parse(file) bible = opensong.getroot() @@ -116,16 +117,11 @@ class OpenSongBible(BibleDB): if len(verse_parts) > 1: number = int(verse_parts[0]) except TypeError: - log.warn(u'Illegal verse number: %s', - unicode(verse.attrib[u'n'])) + log.warn(u'Illegal verse number: %s', unicode(verse.attrib[u'n'])) verse_number = number else: verse_number += 1 - self.create_verse( - db_book.id, - chapter_number, - verse_number, - self.get_text(verse)) + self.create_verse(db_book.id, chapter_number, verse_number, self.get_text(verse)) self.wizard.increment_progress_bar(translate('BiblesPlugin.Opensong', 'Importing %s %s...', 'Importing ...')) % (db_book.name, chapter_number) self.session.commit() diff --git a/openlp/plugins/bibles/lib/osis.py b/openlp/plugins/bibles/lib/osis.py index 981d10949..b91cd8319 100644 --- a/openlp/plugins/bibles/lib/osis.py +++ b/openlp/plugins/bibles/lib/osis.py @@ -39,9 +39,11 @@ from openlp.plugins.bibles.lib.db import BibleDB, BiblesResourcesDB log = logging.getLogger(__name__) + def replacement(match): return match.group(2).upper() + class OSISBible(BibleDB): """ `OSIS `_ Bible format importer class. @@ -53,8 +55,7 @@ class OSISBible(BibleDB): BibleDB.__init__(self, parent, **kwargs) self.filename = kwargs[u'filename'] self.language_regex = re.compile(r'(.*?)') - self.verse_regex = re.compile( - r'(.*?)') + self.verse_regex = re.compile(r'(.*?)') self.note_regex = re.compile(r'(.*?)') self.title_regex = re.compile(r'(.*?)') self.milestone_regex = re.compile(r'') @@ -68,8 +69,7 @@ class OSISBible(BibleDB): self.q1_regex = re.compile(r'') self.q2_regex = re.compile(r'') self.trans_regex = re.compile(r'(.*?)') - self.divine_name_regex = re.compile( - r'(.*?)') + self.divine_name_regex = re.compile(r'(.*?)') self.spaces_regex = re.compile(r'([ ]{2,})') filepath = os.path.join( AppLocation.get_directory(AppLocation.PluginsDir), u'bibles', u'resources', u'osisbooks.csv') @@ -158,10 +158,8 @@ class OSISBible(BibleDB): self.wizard.increment_progress_bar(translate('BiblesPlugin.OsisImport', 'Importing %s %s...', 'Importing ...') % (book_details[u'name'], chapter)) last_chapter = chapter - # All of this rigmarol below is because the mod2osis - # tool from the Sword library embeds XML in the OSIS - # but neglects to enclose the verse text (with XML) in - # <[CDATA[ ]]> tags. + # All of this rigmarol below is because the mod2osis tool from the Sword library embeds XML in the + # OSIS but neglects to enclose the verse text (with XML) in <[CDATA[ ]]> tags. verse_text = self.note_regex.sub(u'', verse_text) verse_text = self.title_regex.sub(u'', verse_text) verse_text = self.milestone_regex.sub(u'', verse_text) diff --git a/openlp/plugins/bibles/lib/upgrade.py b/openlp/plugins/bibles/lib/upgrade.py index b4a358c45..0c1a089b2 100644 --- a/openlp/plugins/bibles/lib/upgrade.py +++ b/openlp/plugins/bibles/lib/upgrade.py @@ -27,8 +27,7 @@ # Temple Place, Suite 330, Boston, MA 02111-1307 USA # ############################################################################### """ -The :mod:`upgrade` module provides a way for the database and schema that is the -backend for the Bibles plugin +The :mod:`upgrade` module provides a way for the database and schema that is the backend for the Bibles plugin. """ import logging diff --git a/openlp/plugins/bibles/lib/versereferencelist.py b/openlp/plugins/bibles/lib/versereferencelist.py index 1cb76ffff..069b86d5e 100644 --- a/openlp/plugins/bibles/lib/versereferencelist.py +++ b/openlp/plugins/bibles/lib/versereferencelist.py @@ -29,8 +29,8 @@ class VerseReferenceList(object): """ - The VerseReferenceList class encapsulates a list of verse references, but - maintains the order in which they were added. + The VerseReferenceList class encapsulates a list of verse references, but maintains the order in which they were + added. """ def __init__(self): From dad243dd743835acb79c80e2f5a753406b916a2e Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Fri, 19 Apr 2013 20:52:39 +0200 Subject: [PATCH 64/97] songusage and presentation code standards --- openlp/plugins/presentations/__init__.py | 4 +- .../presentations/lib/impresscontroller.py | 127 ++++++++---------- openlp/plugins/presentations/lib/mediaitem.py | 117 ++++++++-------- .../presentations/lib/messagelistener.py | 67 +++++---- .../presentations/lib/powerpointcontroller.py | 55 ++++---- .../presentations/lib/pptviewcontroller.py | 96 +++++++------ .../lib/presentationcontroller.py | 84 +++++------- .../presentations/lib/presentationtab.py | 7 +- .../presentations/presentationplugin.py | 50 ++++--- openlp/plugins/songusage/__init__.py | 5 +- .../songusage/forms/songusagedeletedialog.py | 3 +- .../songusage/forms/songusagedetaildialog.py | 3 +- openlp/plugins/songusage/lib/db.py | 2 + openlp/plugins/songusage/songusageplugin.py | 20 ++- 14 files changed, 301 insertions(+), 339 deletions(-) diff --git a/openlp/plugins/presentations/__init__.py b/openlp/plugins/presentations/__init__.py index f147ea524..d600d3793 100644 --- a/openlp/plugins/presentations/__init__.py +++ b/openlp/plugins/presentations/__init__.py @@ -27,6 +27,6 @@ # Temple Place, Suite 330, Boston, MA 02111-1307 USA # ############################################################################### """ -The :mod:`presentations` module provides the Presentations plugin which allows -OpenLP to show presentations from most popular presentation packages. +The :mod:`presentations` module provides the Presentations plugin which allows OpenLP to show presentations from most +popular presentation packages. """ diff --git a/openlp/plugins/presentations/lib/impresscontroller.py b/openlp/plugins/presentations/lib/impresscontroller.py index d4c933d33..e5df6685e 100644 --- a/openlp/plugins/presentations/lib/impresscontroller.py +++ b/openlp/plugins/presentations/lib/impresscontroller.py @@ -62,13 +62,14 @@ from openlp.core.lib import ScreenList from openlp.core.utils import delete_file, get_uno_command, get_uno_instance from presentationcontroller import PresentationController, PresentationDocument + log = logging.getLogger(__name__) + class ImpressController(PresentationController): """ - Class to control interactions with Impress presentations. - It creates the runtime environment, loads and closes the presentation as - well as triggering the correct activities based on the users input + Class to control interactions with Impress presentations. It creates the runtime environment, loads and closes the + presentation as well as triggering the correct activities based on the users input. """ log.info(u'ImpressController loaded') @@ -79,14 +80,14 @@ class ImpressController(PresentationController): log.debug(u'Initialising') PresentationController.__init__(self, plugin, u'Impress', ImpressDocument) self.supports = [u'odp'] - self.alsosupports = [u'ppt', u'pps', u'pptx', u'ppsx'] + self.also_supports = [u'ppt', u'pps', u'pptx', u'ppsx'] self.process = None self.desktop = None self.manager = None def check_available(self): """ - Impress is able to run on this machine + Impress is able to run on this machine. """ log.debug(u'check_available') if os.name == u'nt': @@ -96,9 +97,8 @@ class ImpressController(PresentationController): def start_process(self): """ - Loads a running version of OpenOffice in the background. - It is not displayed to the user but is available to the UNO interface - when required. + Loads a running version of OpenOffice in the background. It is not displayed to the user but is available to the + UNO interface when required. """ log.debug(u'start process Openoffice') if os.name == u'nt': @@ -113,8 +113,7 @@ class ImpressController(PresentationController): def get_uno_desktop(self): """ - On non-Windows platforms, use Uno. Get the OpenOffice desktop - which will be used to manage impress + On non-Windows platforms, use Uno. Get the OpenOffice desktop which will be used to manage impress. """ log.debug(u'get UNO Desktop Openoffice') uno_instance = None @@ -132,8 +131,7 @@ class ImpressController(PresentationController): loop += 1 try: self.manager = uno_instance.ServiceManager - log.debug(u'get UNO Desktop Openoffice - createInstanceWithContext' - u' - Desktop') + log.debug(u'get UNO Desktop Openoffice - createInstanceWithContext - Desktop') desktop = self.manager.createInstanceWithContext("com.sun.star.frame.Desktop", uno_instance) return desktop except: @@ -142,8 +140,7 @@ class ImpressController(PresentationController): def get_com_desktop(self): """ - On Windows platforms, use COM. Return the desktop object which - will be used to manage Impress + On Windows platforms, use COM. Return the desktop object which will be used to manage Impress. """ log.debug(u'get COM Desktop OpenOffice') if not self.manager: @@ -157,7 +154,7 @@ class ImpressController(PresentationController): def get_com_servicemanager(self): """ - Return the OOo service manager for windows + Return the OOo service manager for windows. """ log.debug(u'get_com_servicemanager openoffice') try: @@ -168,7 +165,7 @@ class ImpressController(PresentationController): def kill(self): """ - Called at system exit to clean up any running presentations + Called at system exit to clean up any running presentations. """ log.debug(u'Kill OpenOffice') while self.docs: @@ -203,12 +200,12 @@ class ImpressController(PresentationController): class ImpressDocument(PresentationDocument): """ - Class which holds information and controls a single presentation + Class which holds information and controls a single presentation. """ def __init__(self, controller, presentation): """ - Constructor, store information about the file and initialise + Constructor, store information about the file and initialise. """ log.debug(u'Init Presentation OpenOffice') PresentationDocument.__init__(self, controller, presentation) @@ -218,11 +215,9 @@ class ImpressDocument(PresentationDocument): def load_presentation(self): """ - Called when a presentation is added to the SlideController. - It builds the environment, starts communcations with the background - OpenOffice task started earlier. If OpenOffice is not present is is - started. Once the environment is available the presentation is loaded - and started. + Called when a presentation is added to the SlideController. It builds the environment, starts communcations with + the background OpenOffice task started earlier. If OpenOffice is not present is is started. Once the environment + is available the presentation is loaded and started. """ log.debug(u'Load Presentation OpenOffice') if os.name == u'nt': @@ -239,13 +234,12 @@ class ImpressDocument(PresentationDocument): self.desktop = desktop properties = [] if os.name != u'nt': - # Recent versions of Impress on Windows won't start the presentation - # if it starts as minimized. It seems OK on Linux though. + # Recent versions of Impress on Windows won't start the presentation if it starts as minimized. It seems OK + # on Linux though. properties.append(self.create_property(u'Minimized', True)) properties = tuple(properties) try: - self.document = desktop.loadComponentFromURL(url, u'_blank', - 0, properties) + self.document = desktop.loadComponentFromURL(url, u'_blank', 0, properties) except: log.warn(u'Failed to load presentation %s' % url) return False @@ -262,33 +256,33 @@ class ImpressDocument(PresentationDocument): def create_thumbnails(self): """ - Create thumbnail images for presentation + Create thumbnail images for presentation. """ log.debug(u'create thumbnails OpenOffice') if self.check_thumbnails(): return if os.name == u'nt': - thumbdirurl = u'file:///' + self.get_temp_folder().replace(u'\\', u'/') \ + thumb_dir_url = u'file:///' + self.get_temp_folder().replace(u'\\', u'/') \ .replace(u':', u'|').replace(u' ', u'%20') else: - thumbdirurl = uno.systemPathToFileUrl(self.get_temp_folder()) - props = [] - props.append(self.create_property(u'FilterName', u'impress_png_Export')) - props = tuple(props) + thumb_dir_url = uno.systemPathToFileUrl(self.get_temp_folder()) + properties = [] + properties.append(self.create_property(u'FilterName', u'impress_png_Export')) + properties = tuple(properties) doc = self.document pages = doc.getDrawPages() if not pages: return if not os.path.isdir(self.get_temp_folder()): os.makedirs(self.get_temp_folder()) - for idx in range(pages.getCount()): - page = pages.getByIndex(idx) + for index in range(pages.getCount()): + page = pages.getByIndex(index) doc.getCurrentController().setCurrentPage(page) - urlpath = u'%s/%s.png' % (thumbdirurl, unicode(idx + 1)) - path = os.path.join(self.get_temp_folder(), unicode(idx + 1) + u'.png') + url_path = u'%s/%s.png' % (thumb_dir_url, unicode(index + 1)) + path = os.path.join(self.get_temp_folder(), unicode(index + 1) + u'.png') try: - doc.storeToURL(urlpath, props) - self.convert_thumbnail(path, idx + 1) + doc.storeToURL(url_path, properties) + self.convert_thumbnail(path, index + 1) delete_file(path) except ErrorCodeIOException, exception: log.exception(u'ERROR! ErrorCodeIOException %d' % exception.ErrCode) @@ -297,23 +291,21 @@ class ImpressDocument(PresentationDocument): def create_property(self, name, value): """ - Create an OOo style property object which are passed into some - Uno methods + Create an OOo style property object which are passed into some Uno methods. """ log.debug(u'create property OpenOffice') if os.name == u'nt': - prop = self.controller.manager.Bridge_GetStruct(u'com.sun.star.beans.PropertyValue') + property = self.controller.manager.Bridge_GetStruct(u'com.sun.star.beans.PropertyValue') else: - prop = PropertyValue() - prop.Name = name - prop.Value = value - return prop + property = PropertyValue() + property.Name = name + property.Value = value + return property def close_presentation(self): """ - Close presentation and clean up objects - Triggered by new object being added to SlideController or OpenLP - being shutdown + Close presentation and clean up objects. Triggered by new object being added to SlideController or OpenLP being + shutdown. """ log.debug(u'close Presentation OpenOffice') if self.document: @@ -329,7 +321,7 @@ class ImpressDocument(PresentationDocument): def is_loaded(self): """ - Returns true if a presentation is loaded + Returns true if a presentation is loaded. """ log.debug(u'is loaded OpenOffice') if self.presentation is None or self.document is None: @@ -346,7 +338,7 @@ class ImpressDocument(PresentationDocument): def is_active(self): """ - Returns true if a presentation is active and running + Returns true if a presentation is active and running. """ log.debug(u'is active OpenOffice') if not self.is_loaded(): @@ -355,21 +347,21 @@ class ImpressDocument(PresentationDocument): def unblank_screen(self): """ - Unblanks the screen + Unblanks the screen. """ log.debug(u'unblank screen OpenOffice') return self.control.resume() def blank_screen(self): """ - Blanks the screen + Blanks the screen. """ log.debug(u'blank screen OpenOffice') self.control.blankScreen(0) def is_blank(self): """ - Returns true if screen is blank + Returns true if screen is blank. """ log.debug(u'is blank OpenOffice') if self.control and self.control.isRunning(): @@ -379,7 +371,7 @@ class ImpressDocument(PresentationDocument): def stop_presentation(self): """ - Stop the presentation, remove from screen + Stop the presentation, remove from screen. """ log.debug(u'stop presentation OpenOffice') # deactivate should hide the screen according to docs, but doesn't @@ -389,18 +381,17 @@ class ImpressDocument(PresentationDocument): def start_presentation(self): """ - Start the presentation from the beginning + Start the presentation from the beginning. """ log.debug(u'start presentation OpenOffice') if self.control is None or not self.control.isRunning(): self.presentation.start() self.control = self.presentation.getController() - # start() returns before the Component is ready. - # Try for 15 seconds - i = 1 - while not self.control and i < 150: + # start() returns before the Component is ready. Try for 15 seconds. + sleep_count = 1 + while not self.control and sleep_count < 150: time.sleep(0.1) - i += 1 + sleep_count += 1 self.control = self.presentation.getController() else: self.control.activate() @@ -408,25 +399,25 @@ class ImpressDocument(PresentationDocument): def get_slide_number(self): """ - Return the current slide number on the screen, from 1 + Return the current slide number on the screen, from 1. """ return self.control.getCurrentSlideIndex() + 1 def get_slide_count(self): """ - Return the total number of slides + Return the total number of slides. """ return self.document.getDrawPages().getCount() def goto_slide(self, slideno): """ - Go to a specific slide (from 1) + Go to a specific slide (from 1). """ self.control.gotoSlideIndex(slideno-1) def next_step(self): """ - Triggers the next effect of slide on the running presentation + Triggers the next effect of slide on the running presentation. """ is_paused = self.control.isPaused() self.control.gotoNextEffect() @@ -436,7 +427,7 @@ class ImpressDocument(PresentationDocument): def previous_step(self): """ - Triggers the previous slide on the running presentation + Triggers the previous slide on the running presentation. """ self.control.gotoPreviousSlide() @@ -470,8 +461,8 @@ class ImpressDocument(PresentationDocument): page = pages.getByIndex(slide_no - 1) if notes: page = page.getNotesPage() - for idx in range(page.getCount()): - shape = page.getByIndex(idx) + for index in range(page.getCount()): + shape = page.getByIndex(index) if shape.supportsService("com.sun.star.drawing.Text"): text += shape.getString() + '\n' return text diff --git a/openlp/plugins/presentations/lib/mediaitem.py b/openlp/plugins/presentations/lib/mediaitem.py index 52dcd891f..9664fcf2f 100644 --- a/openlp/plugins/presentations/lib/mediaitem.py +++ b/openlp/plugins/presentations/lib/mediaitem.py @@ -38,14 +38,17 @@ from openlp.core.lib.ui import critical_error_message_box, create_horizontal_adj from openlp.core.utils import get_locale_key from openlp.plugins.presentations.lib import MessageListener + log = logging.getLogger(__name__) -ERROR = QtGui.QImage(u':/general/general_delete.png') + +ERROR_IMAGE = QtGui.QImage(u':/general/general_delete.png') + class PresentationMediaItem(MediaManagerItem): """ - This is the Presentation media manager item for Presentation Items. - It can present files using Openoffice and Powerpoint + This is the Presentation media manager item for Presentation Items. It can present files using Openoffice and + Powerpoint """ log.info(u'Presentations Media Item loaded') @@ -71,25 +74,25 @@ class PresentationMediaItem(MediaManagerItem): """ self.on_new_prompt = translate('PresentationPlugin.MediaItem', 'Select Presentation(s)') self.Automatic = translate('PresentationPlugin.MediaItem', 'Automatic') - self.displayTypeLabel.setText(translate('PresentationPlugin.MediaItem', 'Present using:')) + self.display_type_label.setText(translate('PresentationPlugin.MediaItem', 'Present using:')) def build_file_mask_string(self): """ - Build the list of file extensions to be used in the Open file dialog + Build the list of file extensions to be used in the Open file dialog. """ - fileType = u'' + file_type = u'' for controller in self.controllers: if self.controllers[controller].enabled(): - types = self.controllers[controller].supports + self.controllers[controller].alsosupports - for type in types: - if fileType.find(type) == -1: - fileType += u'*.%s ' % type - self.service_manager.supported_suffixes(type) - self.on_new_file_masks = translate('PresentationPlugin.MediaItem', 'Presentations (%s)') % fileType + file_types = self.controllers[controller].supports + self.controllers[controller].also_supports + for file_type in file_types: + if file_type.find(file_type) == -1: + file_type += u'*.%s ' % file_type + self.service_manager.supported_suffixes(file_type) + self.on_new_file_masks = translate('PresentationPlugin.MediaItem', 'Presentations (%s)') % file_type def required_icons(self): """ - Set which icons the media manager tab should show + Set which icons the media manager tab should show. """ MediaManagerItem.required_icons(self) self.has_file_icon = True @@ -98,21 +101,21 @@ class PresentationMediaItem(MediaManagerItem): def add_end_header_bar(self): """ - Display custom media manager items for presentations + Display custom media manager items for presentations. """ - self.presentationWidget = QtGui.QWidget(self) - self.presentationWidget.setObjectName(u'presentationWidget') - self.displayLayout = QtGui.QFormLayout(self.presentationWidget) - self.displayLayout.setMargin(self.displayLayout.spacing()) - self.displayLayout.setObjectName(u'displayLayout') - self.displayTypeLabel = QtGui.QLabel(self.presentationWidget) - self.displayTypeLabel.setObjectName(u'displayTypeLabel') - self.displayTypeComboBox = create_horizontal_adjusting_combo_box(self.presentationWidget, + self.presentation_widget = QtGui.QWidget(self) + self.presentation_widget.setObjectName(u'presentation_widget') + self.display_layout = QtGui.QFormLayout(self.presentation_widget) + self.display_layout.setMargin(self.display_layout.spacing()) + self.display_layout.setObjectName(u'display_layout') + self.display_type_label = QtGui.QLabel(self.presentation_widget) + self.display_type_label.setObjectName(u'display_type_label') + self.displayTypeComboBox = create_horizontal_adjusting_combo_box(self.presentation_widget, u'displayTypeComboBox') - self.displayTypeLabel.setBuddy(self.displayTypeComboBox) - self.displayLayout.addRow(self.displayTypeLabel, self.displayTypeComboBox) + self.display_type_label.setBuddy(self.displayTypeComboBox) + self.display_layout.addRow(self.display_type_label, self.displayTypeComboBox) # Add the Presentation widget to the page layout - self.page_layout.addWidget(self.presentationWidget) + self.page_layout.addWidget(self.presentation_widget) def initialise(self): """ @@ -120,13 +123,13 @@ class PresentationMediaItem(MediaManagerItem): """ self.list_view.setIconSize(QtCore.QSize(88, 50)) files = Settings().value(self.settings_section + u'/presentations files') - self.load_list(files, initialLoad=True) + self.load_list(files, initial_load=True) self.populate_display_types() def populate_display_types(self): """ - Load the combobox with the enabled presentation controllers, - allowing user to select a specific app if settings allow + Load the combobox with the enabled presentation controllers, allowing user to select a specific app if settings + allow. """ self.displayTypeComboBox.clear() for item in self.controllers: @@ -137,38 +140,37 @@ class PresentationMediaItem(MediaManagerItem): self.displayTypeComboBox.insertItem(0, self.Automatic) self.displayTypeComboBox.setCurrentIndex(0) if Settings().value(self.settings_section + u'/override app') == QtCore.Qt.Checked: - self.presentationWidget.show() + self.presentation_widget.show() else: - self.presentationWidget.hide() + self.presentation_widget.hide() - def load_list(self, files, target_group=None, initialLoad=False): + def load_list(self, files, target_group=None, initial_load=False): """ - Add presentations into the media manager - This is called both on initial load of the plugin to populate with - existing files, and when the user adds new files via the media manager + Add presentations into the media manager. This is called both on initial load of the plugin to populate with + existing files, and when the user adds new files via the media manager. """ - currlist = self.get_file_list() - titles = [os.path.split(file)[1] for file in currlist] + current_list = self.get_file_list() + titles = [os.path.split(file)[1] for file in current_list] self.application.set_busy_cursor() - if not initialLoad: + if not initial_load: self.main_window.display_progress_bar(len(files)) # Sort the presentations by its filename considering language specific characters. files.sort(key=lambda filename: get_locale_key(os.path.split(unicode(filename))[1])) for file in files: - if not initialLoad: + if not initial_load: self.main_window.increment_progress_bar() - if currlist.count(file) > 0: + if current_list.count(file) > 0: continue filename = os.path.split(unicode(file))[1] if not os.path.exists(file): item_name = QtGui.QListWidgetItem(filename) - item_name.setIcon(build_icon(ERROR)) + item_name.setIcon(build_icon(ERROR_IMAGE)) item_name.setData(QtCore.Qt.UserRole, file) item_name.setToolTip(file) self.list_view.addItem(item_name) else: if titles.count(filename) > 0: - if not initialLoad: + if not initial_load: critical_error_message_box(translate('PresentationPlugin.MediaItem', 'File Exists'), translate('PresentationPlugin.MediaItem', 'A presentation with that filename already exists.') @@ -180,7 +182,7 @@ class PresentationMediaItem(MediaManagerItem): doc = controller.add_document(unicode(file)) thumb = os.path.join(doc.get_thumbnail_folder(), u'icon.png') preview = doc.get_thumbnail_path(1, True) - if not preview and not initialLoad: + if not preview and not initial_load: doc.load_presentation() preview = doc.get_thumbnail_path(1, True) doc.close_presentation() @@ -192,7 +194,7 @@ class PresentationMediaItem(MediaManagerItem): else: icon = create_thumb(preview, thumb) else: - if initialLoad: + if initial_load: icon = build_icon(u':/general/general_delete.png') else: critical_error_message_box(UiStrings().UnsupportedFile, @@ -203,13 +205,13 @@ class PresentationMediaItem(MediaManagerItem): item_name.setIcon(icon) item_name.setToolTip(file) self.list_view.addItem(item_name) - if not initialLoad: + if not initial_load: self.main_window.finished_progress_bar() self.application.set_normal_cursor() def on_delete_click(self): """ - Remove a presentation item from the list + Remove a presentation item from the list. """ if check_item_selected(self.list_view, UiStrings().SelectDelete): items = self.list_view.selectedIndexes() @@ -230,12 +232,11 @@ class PresentationMediaItem(MediaManagerItem): self.list_view.takeItem(row) Settings().setValue(self.settings_section + u'/presentations files', self.get_file_list()) - def generate_slide_data(self, service_item, item=None, xmlVersion=False, + def generate_slide_data(self, service_item, item=None, xml_version=False, remote=False, context=ServiceItemContext.Service): """ - Load the relevant information for displaying the presentation - in the slidecontroller. In the case of powerpoints, an image - for each slide + Load the relevant information for displaying the presentation in the slidecontroller. In the case of + powerpoints, an image for each slide. """ if item: items = [item] @@ -287,26 +288,24 @@ class PresentationMediaItem(MediaManagerItem): def findControllerByType(self, filename): """ - Determine the default application controller to use for the selected - file type. This is used if "Automatic" is set as the preferred - controller. Find the first (alphabetic) enabled controller which - "supports" the extension. If none found, then look for a controller - which "also supports" it instead. + Determine the default application controller to use for the selected file type. This is used if "Automatic" is + set as the preferred controller. Find the first (alphabetic) enabled controller which "supports" the extension. + If none found, then look for a controller which "also supports" it instead. """ - filetype = os.path.splitext(filename)[1][1:] - if not filetype: + file_type = os.path.splitext(filename)[1][1:] + if not file_type: return None for controller in self.controllers: if self.controllers[controller].enabled(): - if filetype in self.controllers[controller].supports: + if file_type in self.controllers[controller].supports: return controller for controller in self.controllers: if self.controllers[controller].enabled(): - if filetype in self.controllers[controller].alsosupports: + if file_type in self.controllers[controller].also_supports: return controller return None - def search(self, string, showError): + def search(self, string, show_error): files = Settings().value(self.settings_section + u'/presentations files') results = [] string = string.lower() diff --git a/openlp/plugins/presentations/lib/messagelistener.py b/openlp/plugins/presentations/lib/messagelistener.py index d87e7e5dc..330c36f5c 100644 --- a/openlp/plugins/presentations/lib/messagelistener.py +++ b/openlp/plugins/presentations/lib/messagelistener.py @@ -38,8 +38,8 @@ 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 correct presentation handlers + This is the Presentation listener who acts on events from the slide controller and passes the messages on the the + correct presentation handlers. """ log.info(u'Controller loaded') @@ -54,9 +54,8 @@ class Controller(object): def add_handler(self, controller, file, hide_mode, slide_no): """ - Add a handler, which is an instance of a presentation and - slidecontroller combination. If the slidecontroller has a display - then load the presentation. + Add a handler, which is an instance of a presentation and slidecontroller combination. If the slidecontroller + has a display then load the presentation. """ log.debug(u'Live = %s, add_handler %s' % (self.is_live, file)) self.controller = controller @@ -86,8 +85,7 @@ class Controller(object): def activate(self): """ - Active the presentation, and show it on the screen. - Use the last slide number. + Active the presentation, and show it on the screen. Use the last slide number. """ log.debug(u'Live = %s, activate' % self.is_live) if not self.doc: @@ -130,7 +128,7 @@ class Controller(object): def first(self): """ - Based on the handler passed at startup triggers the first slide + Based on the handler passed at startup triggers the first slide. """ log.debug(u'Live = %s, first' % self.is_live) if not self.doc: @@ -148,7 +146,7 @@ class Controller(object): def last(self): """ - Based on the handler passed at startup triggers the last slide + Based on the handler passed at startup triggers the last slide. """ log.debug(u'Live = %s, last' % self.is_live) if not self.doc: @@ -166,7 +164,7 @@ class Controller(object): def next(self): """ - Based on the handler passed at startup triggers the next slide event + Based on the handler passed at startup triggers the next slide event. """ log.debug(u'Live = %s, next' % self.is_live) if not self.doc: @@ -182,9 +180,8 @@ class Controller(object): return if not self.activate(): return - # The "End of slideshow" screen is after the last slide - # Note, we can't just stop on the last slide, since it may - # contain animations that need to be stepped through. + # The "End of slideshow" screen is after the last slide. Note, we can't just stop on the last slide, since it + # may contain animations that need to be stepped through. if self.doc.slidenumber > self.doc.get_slide_count(): return self.doc.next_step() @@ -192,7 +189,7 @@ class Controller(object): def previous(self): """ - Based on the handler passed at startup triggers the previous slide event + Based on the handler passed at startup triggers the previous slide event. """ log.debug(u'Live = %s, previous' % self.is_live) if not self.doc: @@ -213,7 +210,7 @@ class Controller(object): def shutdown(self): """ - Based on the handler passed at startup triggers slide show to shut down + Based on the handler passed at startup triggers slide show to shut down. """ log.debug(u'Live = %s, shutdown' % self.is_live) if not self.doc: @@ -223,7 +220,7 @@ class Controller(object): def blank(self, hide_mode): """ - Instruct the controller to blank the presentation + Instruct the controller to blank the presentation. """ log.debug(u'Live = %s, blank' % self.is_live) self.hide_mode = hide_mode @@ -244,7 +241,7 @@ class Controller(object): def stop(self): """ - Instruct the controller to stop and hide the presentation + Instruct the controller to stop and hide the presentation. """ log.debug(u'Live = %s, stop' % self.is_live) self.hide_mode = HideMode.Screen @@ -260,7 +257,7 @@ class Controller(object): def unblank(self): """ - Instruct the controller to unblank the presentation + Instruct the controller to unblank the presentation. """ log.debug(u'Live = %s, unblank' % self.is_live) self.hide_mode = None @@ -283,8 +280,8 @@ class Controller(object): class MessageListener(object): """ - This is the Presentation listener who acts on events from the slide - controller and passes the messages on the the correct presentation handlers + This is the Presentation listener who acts on events from the slide controller and passes the messages on the the + correct presentation handlers """ log.info(u'Message Listener loaded') @@ -310,12 +307,11 @@ class MessageListener(object): def startup(self, message): """ - Start of new presentation - Save the handler as any new presentations start here + Start of new presentation. Save the handler as any new presentations start here """ + log.debug(u'Startup called with message %s' % message) is_live = message[1] item = message[0] - log.debug(u'Startup called with message %s' % message) hide_mode = message[2] file = item.get_frame_path() self.handler = item.title @@ -331,7 +327,7 @@ class MessageListener(object): def slide(self, message): """ - React to the message to move to a specific slide + React to the message to move to a specific slide. """ is_live = message[1] slide = message[2] @@ -342,7 +338,7 @@ class MessageListener(object): def first(self, message): """ - React to the message to move to the first slide + React to the message to move to the first slide. """ is_live = message[1] if is_live: @@ -352,7 +348,7 @@ class MessageListener(object): def last(self, message): """ - React to the message to move to the last slide + React to the message to move to the last slide. """ is_live = message[1] if is_live: @@ -362,7 +358,7 @@ class MessageListener(object): def next(self, message): """ - React to the message to move to the next animation/slide + React to the message to move to the next animation/slide. """ is_live = message[1] if is_live: @@ -372,7 +368,7 @@ class MessageListener(object): def previous(self, message): """ - React to the message to move to the previous animation/slide + React to the message to move to the previous animation/slide. """ is_live = message[1] if is_live: @@ -382,8 +378,7 @@ class MessageListener(object): def shutdown(self, message): """ - React to message to shutdown the presentation. I.e. end the show - and close the file + React to message to shutdown the presentation. I.e. end the show and close the file. """ is_live = message[1] if is_live: @@ -393,7 +388,7 @@ class MessageListener(object): def hide(self, message): """ - React to the message to show the desktop + React to the message to show the desktop. """ is_live = message[1] if is_live: @@ -401,7 +396,7 @@ class MessageListener(object): def blank(self, message): """ - React to the message to blank the display + React to the message to blank the display. """ is_live = message[1] hide_mode = message[2] @@ -410,7 +405,7 @@ class MessageListener(object): def unblank(self, message): """ - React to the message to unblank the display + React to the message to unblank the display. """ is_live = message[1] if is_live: @@ -418,9 +413,7 @@ class MessageListener(object): def timeout(self): """ - The presentation may be timed or might be controlled by the - application directly, rather than through OpenLP. Poll occasionally - to check which slide is currently displayed so the slidecontroller - view can be updated + The presentation may be timed or might be controlled by the application directly, rather than through OpenLP. + Poll occasionally to check which slide is currently displayed so the slidecontroller view can be updated. """ self.live_handler.poll() diff --git a/openlp/plugins/presentations/lib/powerpointcontroller.py b/openlp/plugins/presentations/lib/powerpointcontroller.py index 7a9f548ee..6895fda19 100644 --- a/openlp/plugins/presentations/lib/powerpointcontroller.py +++ b/openlp/plugins/presentations/lib/powerpointcontroller.py @@ -26,7 +26,10 @@ # with this program; if not, write to the Free Software Foundation, Inc., 59 # # Temple Place, Suite 330, Boston, MA 02111-1307 USA # ############################################################################### - +""" +This modul is for controlling powerpiont. PPT API documentation: +`http://msdn.microsoft.com/en-us/library/aa269321(office.10).aspx`_ +""" import os import logging @@ -39,16 +42,14 @@ if os.name == u'nt': from openlp.core.lib import ScreenList from presentationcontroller import PresentationController, PresentationDocument + log = logging.getLogger(__name__) -# PPT API documentation: -# http://msdn.microsoft.com/en-us/library/aa269321(office.10).aspx class PowerpointController(PresentationController): """ - Class to control interactions with PowerPoint Presentations - It creates the runtime Environment , Loads the and Closes the Presentation - As well as triggering the correct activities based on the users input + Class to control interactions with PowerPoint Presentations. It creates the runtime Environment , Loads the and + Closes the Presentation. As well as triggering the correct activities based on the users input. """ log.info(u'PowerpointController loaded') @@ -63,7 +64,7 @@ class PowerpointController(PresentationController): def check_available(self): """ - PowerPoint is able to run on this machine + PowerPoint is able to run on this machine. """ log.debug(u'check_available') if os.name == u'nt': @@ -77,7 +78,7 @@ class PowerpointController(PresentationController): if os.name == u'nt': def start_process(self): """ - Loads PowerPoint process + Loads PowerPoint process. """ log.debug(u'start_process') if not self.process: @@ -87,7 +88,7 @@ class PowerpointController(PresentationController): def kill(self): """ - Called at system exit to clean up any running presentations + Called at system exit to clean up any running presentations. """ log.debug(u'Kill powerpoint') while self.docs: @@ -105,12 +106,12 @@ class PowerpointController(PresentationController): class PowerpointDocument(PresentationDocument): """ - Class which holds information and controls a single presentation + Class which holds information and controls a single presentation. """ def __init__(self, controller, presentation): """ - Constructor, store information about the file and initialise + Constructor, store information about the file and initialise. """ log.debug(u'Init Presentation Powerpoint') PresentationDocument.__init__(self, controller, presentation) @@ -118,8 +119,8 @@ class PowerpointDocument(PresentationDocument): def load_presentation(self): """ - Called when a presentation is added to the SlideController. - Opens the PowerPoint file using the process created earlier. + Called when a presentation is added to the SlideController. Opens the PowerPoint file using the process created + earlier. """ log.debug(u'load_presentation') if not self.controller.process or not self.controller.process.Visible: @@ -142,20 +143,19 @@ class PowerpointDocument(PresentationDocument): self.presentation.Slides[n].Copy() thumbnail = QApplication.clipboard.image() - However, for the moment, we want a physical file since it makes life - easier elsewhere. + However, for the moment, we want a physical file since it makes life easier elsewhere. """ log.debug(u'create_thumbnails') if self.check_thumbnails(): return for num in range(self.presentation.Slides.Count): - self.presentation.Slides(num + 1).Export(os.path.join( - self.get_thumbnail_folder(), 'slide%d.png' % (num + 1)), 'png', 320, 240) + self.presentation.Slides(num + 1).Export( + os.path.join(self.get_thumbnail_folder(), 'slide%d.png' % (num + 1)), 'png', 320, 240) def close_presentation(self): """ - Close presentation and clean up objects. This is triggered by a new - object being added to SlideController or OpenLP being shut down. + Close presentation and clean up objects. This is triggered by a new object being added to SlideController or + OpenLP being shut down. """ log.debug(u'ClosePresentation') if self.presentation: @@ -182,7 +182,6 @@ class PowerpointDocument(PresentationDocument): return False return True - def is_active(self): """ Returns ``True`` if a presentation is currently active. @@ -253,15 +252,14 @@ class PowerpointDocument(PresentationDocument): dpi = win32ui.GetForegroundWindow().GetDC().GetDeviceCaps(88) except win32ui.error: dpi = 96 - rect = ScreenList().current[u'size'] + size = ScreenList().current[u'size'] ppt_window = self.presentation.SlideShowSettings.Run() if not ppt_window: return - ppt_window.Top = rect.y() * 72 / dpi - ppt_window.Height = rect.height() * 72 / dpi - ppt_window.Left = rect.x() * 72 / dpi - ppt_window.Width = rect.width() * 72 / dpi - + ppt_window.Top = size.y() * 72 / dpi + ppt_window.Height = size.height() * 72 / dpi + ppt_window.Left = size.x() * 72 / dpi + ppt_window.Width = size.width() * 72 / dpi def get_slide_number(self): """ @@ -318,6 +316,7 @@ class PowerpointDocument(PresentationDocument): """ return _get_text_from_shapes(self.presentation.Slides(slide_no).NotesPage.Shapes) + def _get_text_from_shapes(shapes): """ Returns any text extracted from the shapes on a presentation slide. @@ -326,8 +325,8 @@ def _get_text_from_shapes(shapes): A set of shapes to search for text. """ text = '' - for idx in range(shapes.Count): - shape = shapes(idx + 1) + for index in range(shapes.Count): + shape = shapes(index + 1) if shape.HasTextFrame: text += shape.TextFrame.TextRange.Text + '\n' return text diff --git a/openlp/plugins/presentations/lib/pptviewcontroller.py b/openlp/plugins/presentations/lib/pptviewcontroller.py index a2dc56f52..abb9fd11e 100644 --- a/openlp/plugins/presentations/lib/pptviewcontroller.py +++ b/openlp/plugins/presentations/lib/pptviewcontroller.py @@ -37,13 +37,14 @@ if os.name == u'nt': from openlp.core.lib import ScreenList from presentationcontroller import PresentationController, PresentationDocument + log = logging.getLogger(__name__) + class PptviewController(PresentationController): """ - Class to control interactions with PowerPoint Viewer Presentations - It creates the runtime Environment , Loads the and Closes the Presentation - As well as triggering the correct activities based on the users input + Class to control interactions with PowerPoint Viewer Presentations. It creates the runtime Environment , Loads the + and Closes the Presentation. As well as triggering the correct activities based on the users input """ log.info(u'PPTViewController loaded') @@ -58,7 +59,7 @@ class PptviewController(PresentationController): def check_available(self): """ - PPT Viewer is able to run on this machine + PPT Viewer is able to run on this machine. """ log.debug(u'check_available') if os.name != u'nt': @@ -68,7 +69,7 @@ class PptviewController(PresentationController): if os.name == u'nt': def check_installed(self): """ - Check the viewer is installed + Check the viewer is installed. """ log.debug(u'Check installed') try: @@ -79,14 +80,14 @@ class PptviewController(PresentationController): def start_process(self): """ - Loads the PPTVIEWLIB library + Loads the PPTVIEWLIB library. """ if self.process: return log.debug(u'start PPTView') - dllpath = os.path.join(self.plugin_manager.base_path, u'presentations', u'lib', u'pptviewlib', - u'pptviewlib.dll') - self.process = cdll.LoadLibrary(dllpath) + dll_path = os.path.join( + self.plugin_manager.base_path, u'presentations', u'lib', u'pptviewlib', u'pptviewlib.dll') + self.process = cdll.LoadLibrary(dll_path) if log.isEnabledFor(logging.DEBUG): self.process.SetDebug(1) @@ -101,33 +102,32 @@ class PptviewController(PresentationController): class PptviewDocument(PresentationDocument): """ - Class which holds information and controls a single presentation + Class which holds information and controls a single presentation. """ def __init__(self, controller, presentation): """ - Constructor, store information about the file and initialise + Constructor, store information about the file and initialise. """ log.debug(u'Init Presentation PowerPoint') PresentationDocument.__init__(self, controller, presentation) self.presentation = None - self.pptid = None + self.ppt_id = None self.blanked = False self.hidden = False def load_presentation(self): """ - Called when a presentation is added to the SlideController. - It builds the environment, starts communication with the background - PptView task started earlier. + Called when a presentation is added to the SlideController. It builds the environment, starts communication with + the background PptView task started earlier. """ log.debug(u'LoadPresentation') - rect = ScreenList().current[u'size'] - rect = RECT(rect.x(), rect.y(), rect.right(), rect.bottom()) + size = ScreenList().current[u'size'] + rect = RECT(size.x(), size.y(), size.right(), size.bottom()) filepath = str(self.filepath.replace(u'/', u'\\')) if not os.path.isdir(self.get_temp_folder()): os.makedirs(self.get_temp_folder()) - self.pptid = self.controller.process.OpenPPT(filepath, None, rect, str(self.get_temp_folder()) + '\\slide') - if self.pptid >= 0: + self.ppt_id = self.controller.process.OpenPPT(filepath, None, rect, str(self.get_temp_folder()) + '\\slide') + if self.ppt_id >= 0: self.create_thumbnails() self.stop_presentation() return True @@ -136,8 +136,7 @@ class PptviewDocument(PresentationDocument): def create_thumbnails(self): """ - PPTviewLib creates large BMP's, but we want small PNG's for consistency. - Convert them here. + PPTviewLib creates large BMP's, but we want small PNG's for consistency. Convert them here. """ log.debug(u'create_thumbnails') if self.check_thumbnails(): @@ -149,21 +148,20 @@ class PptviewDocument(PresentationDocument): def close_presentation(self): """ - Close presentation and clean up objects - Triggered by new object being added to SlideController orOpenLP - being shut down + Close presentation and clean up objects. Triggered by new object being added to SlideController or OpenLP being + shut down. """ log.debug(u'ClosePresentation') if self.controller.process: - self.controller.process.ClosePPT(self.pptid) - self.pptid = -1 + self.controller.process.ClosePPT(self.ppt_id) + self.ppt_id = -1 self.controller.remove_doc(self) def is_loaded(self): """ - Returns true if a presentation is loaded + Returns true if a presentation is loaded. """ - if self.pptid < 0: + if self.ppt_id < 0: return False if self.get_slide_count() < 0: return False @@ -171,74 +169,74 @@ class PptviewDocument(PresentationDocument): def is_active(self): """ - Returns true if a presentation is currently active + Returns true if a presentation is currently active. """ return self.is_loaded() and not self.hidden def blank_screen(self): """ - Blanks the screen + Blanks the screen. """ - self.controller.process.Blank(self.pptid) + self.controller.process.Blank(self.ppt_id) self.blanked = True def unblank_screen(self): """ - Unblanks (restores) the presentation + Unblanks (restores) the presentation. """ - self.controller.process.Unblank(self.pptid) + self.controller.process.Unblank(self.ppt_id) self.blanked = False def is_blank(self): """ - Returns true if screen is blank + Returns true if screen is blank. """ log.debug(u'is blank OpenOffice') return self.blanked def stop_presentation(self): """ - Stops the current presentation and hides the output + Stops the current presentation and hides the output. """ self.hidden = True - self.controller.process.Stop(self.pptid) + self.controller.process.Stop(self.ppt_id) def start_presentation(self): """ - Starts a presentation from the beginning + Starts a presentation from the beginning. """ if self.hidden: self.hidden = False - self.controller.process.Resume(self.pptid) + self.controller.process.Resume(self.ppt_id) else: - self.controller.process.RestartShow(self.pptid) + self.controller.process.RestartShow(self.ppt_id) def get_slide_number(self): """ - Returns the current slide number + Returns the current slide number. """ - return self.controller.process.GetCurrentSlide(self.pptid) + return self.controller.process.GetCurrentSlide(self.ppt_id) def get_slide_count(self): """ - Returns total number of slides + Returns total number of slides. """ - return self.controller.process.GetSlideCount(self.pptid) + return self.controller.process.GetSlideCount(self.ppt_id) def goto_slide(self, slideno): """ - Moves to a specific slide in the presentation + Moves to a specific slide in the presentation. """ - self.controller.process.GotoSlide(self.pptid, slideno) + self.controller.process.GotoSlide(self.ppt_id, slideno) def next_step(self): """ - Triggers the next effect of slide on the running presentation + Triggers the next effect of slide on the running presentation. """ - self.controller.process.NextStep(self.pptid) + self.controller.process.NextStep(self.ppt_id) def previous_step(self): """ - Triggers the previous slide on the running presentation + Triggers the previous slide on the running presentation. """ - self.controller.process.PrevStep(self.pptid) + self.controller.process.PrevStep(self.ppt_id) diff --git a/openlp/plugins/presentations/lib/presentationcontroller.py b/openlp/plugins/presentations/lib/presentationcontroller.py index 48955ebb2..7501fd6df 100644 --- a/openlp/plugins/presentations/lib/presentationcontroller.py +++ b/openlp/plugins/presentations/lib/presentationcontroller.py @@ -40,9 +40,8 @@ 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 correct - activities based on the users input + Base class for presentation documents to inherit from. Loads and closes the presentation as well as triggering the + correct activities based on the users input **Hook Functions** @@ -131,20 +130,17 @@ class PresentationDocument(object): """ The location where thumbnail images will be stored """ - return os.path.join( - self.controller.thumbnail_folder, self.get_file_name()) + return os.path.join(self.controller.thumbnail_folder, self.get_file_name()) def get_temp_folder(self): """ The location where thumbnail images will be stored """ - return os.path.join( - self.controller.temp_folder, self.get_file_name()) + return os.path.join(self.controller.temp_folder, self.get_file_name()) def check_thumbnails(self): """ - Returns ``True`` if the thumbnail images exist and are more recent than - the powerpoint file. + Returns ``True`` if the thumbnail images exist and are more recent than the powerpoint file. """ lastimage = self.get_thumbnail_path(self.get_slide_count(), True) if not (lastimage and os.path.isfile(lastimage)): @@ -153,8 +149,7 @@ class PresentationDocument(object): def close_presentation(self): """ - Close presentation and clean up objects - Triggered by new object being added to SlideController + Close presentation and clean up objects. Triggered by new object being added to SlideController """ self.controller.close_presentation() @@ -223,8 +218,8 @@ class PresentationDocument(object): def next_step(self): """ - Triggers the next effect of slide on the running presentation - This might be the next animation on the current slide, or the next slide + Triggers the next effect of slide on the running presentation. This might be the next animation on the current + slide, or the next slide """ pass @@ -236,8 +231,7 @@ class PresentationDocument(object): def convert_thumbnail(self, file, idx): """ - Convert the slide image the application made to a standard 320x240 - .png image. + Convert the slide image the application made to a standard 320x240 .png image. """ if self.check_thumbnails(): return @@ -281,7 +275,7 @@ class PresentationDocument(object): Returns the text on the slide ``slide_no`` - The slide the text is required for, starting at 1 + The slide the text is required for, starting at 1 """ return '' @@ -290,24 +284,21 @@ class PresentationDocument(object): Returns the text on the slide ``slide_no`` - The slide the notes are required for, starting at 1 + The slide the notes are required for, starting at 1 """ return '' class PresentationController(object): """ - This class is used to control interactions with presentation applications - by creating a runtime environment. This is a base class for presentation - controllers to inherit from. + This class is used to control interactions with presentation applications by creating a runtime environment. This is + a base class for presentation controllers to inherit from. - To create a new controller, take a copy of this file and name it so it ends - with ``controller.py``, i.e. ``foobarcontroller.py``. Make sure it inherits - :class:`~openlp.plugins.presentations.lib.presentationcontroller.PresentationController`, - and then fill in the blanks. If possible try to make sure it loads on all - platforms, usually by using :mod:``os.name`` checks, although - ``__init__``, ``check_available`` and ``presentation_deleted`` should - always be implemented. + To create a new controller, take a copy of this file and name it so it ends with ``controller.py``, i.e. + ``foobarcontroller.py``. Make sure it inherits + :class:`~openlp.plugins.presentations.lib.presentationcontroller.PresentationController`, and then fill in the + blanks. If possible try to make sure it loads on all platforms, usually by using :mod:``os.name`` checks, although + ``__init__``, ``check_available`` and ``presentation_deleted`` should always be implemented. See :class:`~openlp.plugins.presentations.lib.impresscontroller.ImpressController`, :class:`~openlp.plugins.presentations.lib.powerpointcontroller.PowerpointController` or @@ -317,36 +308,34 @@ class PresentationController(object): **Basic Attributes** ``name`` - The name that appears in the options and the media manager + The name that appears in the options and the media manager. ``enabled`` - The controller is enabled + The controller is enabled. ``available`` - The controller is available on this machine. Set by init via - call to check_available + The controller is available on this machine. Set by init via call to check_available. ``plugin`` - The presentationplugin object + The presentationplugin object. ``supports`` - The primary native file types this application supports + The primary native file types this application supports. ``alsosupports`` - Other file types the application can import, although not necessarily - the first choice due to potential incompatibilities + Other file types the application can import, although not necessarily the first choice due to potential + incompatibilities. **Hook Functions** ``kill()`` - Called at system exit to clean up any running presentations + Called at system exit to clean up any running presentations. ``check_available()`` - Returns True if presentation application is installed/can run on this - machine + Returns True if presentation application is installed/can run on this machine. ``presentation_deleted()`` - Deletes presentation specific files, e.g. thumbnails + Deletes presentation specific files, e.g. thumbnails. """ log.info(u'PresentationController loaded') @@ -354,9 +343,8 @@ class PresentationController(object): def __init__(self, plugin=None, name=u'PresentationController', document_class=PresentationDocument): """ - This is the constructor for the presentationcontroller object. This - provides an easy way for descendent plugins to populate common data. - This method *must* be overridden, like so:: + This is the constructor for the presentationcontroller object. This provides an easy way for descendent plugins + to populate common data. This method *must* be overridden, like so:: class MyPresentationController(PresentationController): def __init__(self, plugin): @@ -399,28 +387,26 @@ class PresentationController(object): def check_available(self): """ - Presentation app is able to run on this machine + Presentation app is able to run on this machine. """ return False def start_process(self): """ - Loads a running version of the presentation application in the - background. + Loads a running version of the presentation application in the background. """ pass def kill(self): """ - Called at system exit to clean up any running presentations and - close the application + Called at system exit to clean up any running presentations and close the application. """ log.debug(u'Kill') self.close_presentation() def add_document(self, name): """ - Called when a new presentation document is opened + Called when a new presentation document is opened. """ document = self.document_class(self, name) self.docs.append(document) @@ -428,7 +414,7 @@ class PresentationController(object): def remove_doc(self, doc=None): """ - Called to remove an open document from the collection + Called to remove an open document from the collection. """ log.debug(u'remove_doc Presentation') if doc is None: diff --git a/openlp/plugins/presentations/lib/presentationtab.py b/openlp/plugins/presentations/lib/presentationtab.py index cecec53b5..e46467403 100644 --- a/openlp/plugins/presentations/lib/presentationtab.py +++ b/openlp/plugins/presentations/lib/presentationtab.py @@ -91,8 +91,7 @@ class PresentationTab(SettingsTab): if checkbox.isEnabled(): checkbox.setText(controller.name) else: - checkbox.setText( - translate('PresentationPlugin.PresentationTab', '%s (unavailable)') % controller.name) + checkbox.setText(translate('PresentationPlugin.PresentationTab', '%s (unavailable)') % controller.name) def load(self): """ @@ -106,8 +105,8 @@ class PresentationTab(SettingsTab): def save(self): """ - Save the settings. If the tab hasn't been made visible to the user then there is nothing to do, - so exit. This removes the need to start presentation applications unnecessarily. + Save the settings. If the tab hasn't been made visible to the user then there is nothing to do, so exit. This + removes the need to start presentation applications unnecessarily. """ if not self.activated: return diff --git a/openlp/plugins/presentations/presentationplugin.py b/openlp/plugins/presentations/presentationplugin.py index 5bc95e388..08f16fa12 100644 --- a/openlp/plugins/presentations/presentationplugin.py +++ b/openlp/plugins/presentations/presentationplugin.py @@ -27,8 +27,8 @@ # Temple Place, Suite 330, Boston, MA 02111-1307 USA # ############################################################################### """ -The :mod:`presentationplugin` module provides the ability for OpenLP to display -presentations from a variety of document formats. +The :mod:`presentationplugin` module provides the ability for OpenLP to display presentations from a variety of document +formats. """ import os import logging @@ -39,22 +39,23 @@ from openlp.core.lib import Plugin, StringContent, build_icon, translate from openlp.core.utils import AppLocation from openlp.plugins.presentations.lib import PresentationController, PresentationMediaItem, PresentationTab + log = logging.getLogger(__name__) + __default_settings__ = { - u'presentations/override app': QtCore.Qt.Unchecked, - u'presentations/Impress': QtCore.Qt.Checked, - u'presentations/Powerpoint': QtCore.Qt.Checked, - u'presentations/Powerpoint Viewer': QtCore.Qt.Checked, - u'presentations/presentations files': [] - } + u'presentations/override app': QtCore.Qt.Unchecked, + u'presentations/Impress': QtCore.Qt.Checked, + u'presentations/Powerpoint': QtCore.Qt.Checked, + u'presentations/Powerpoint Viewer': QtCore.Qt.Checked, + u'presentations/presentations files': [] +} class PresentationPlugin(Plugin): """ - This plugin allowed a Presentation to be opened, controlled and displayed - on the output display. The plugin controls third party applications such - as OpenOffice.org Impress, Microsoft PowerPoint and the PowerPoint viewer + This plugin allowed a Presentation to be opened, controlled and displayed on the output display. The plugin controls + third party applications such as OpenOffice.org Impress, Microsoft PowerPoint and the PowerPoint viewer. """ log = logging.getLogger(u'PresentationPlugin') @@ -71,16 +72,14 @@ class PresentationPlugin(Plugin): def create_settings_tab(self, parent): """ - Create the settings Tab + Create the settings Tab. """ visible_name = self.get_string(StringContent.VisibleName) - self.settings_tab = PresentationTab(parent, self.name, visible_name[u'title'], self.controllers, - self.icon_path) + self.settings_tab = PresentationTab(parent, self.name, visible_name[u'title'], self.controllers, self.icon_path) def initialise(self): """ - Initialise the plugin. Determine which controllers are enabled - are start their processes. + Initialise the plugin. Determine which controllers are enabled are start their processes. """ log.info(u'Presentations Initialising') Plugin.initialise(self) @@ -95,8 +94,8 @@ class PresentationPlugin(Plugin): def finalise(self): """ - Finalise the plugin. Ask all the enabled presentation applications - to close down their applications and release resources. + Finalise the plugin. Ask all the enabled presentation applications to close down their applications and release + resources. """ log.info(u'Plugin Finalise') # Ask each controller to tidy up. @@ -108,26 +107,23 @@ class PresentationPlugin(Plugin): def create_media_manager_item(self): """ - Create the Media Manager List + Create the Media Manager List. """ self.media_item = PresentationMediaItem( self.main_window.media_dock_manager.media_dock, self, self.icon, self.controllers) def register_controllers(self, controller): """ - Register each presentation controller (Impress, PPT etc) and store for later use + Register each presentation controller (Impress, PPT etc) and store for later use. """ self.controllers[controller.name] = controller def check_pre_conditions(self): """ - Check to see if we have any presentation software available - If Not do not install the plugin. + Check to see if we have any presentation software available. If not do not install the plugin. """ log.debug(u'check_pre_conditions') - controller_dir = os.path.join( - AppLocation.get_directory(AppLocation.PluginsDir), - u'presentations', u'lib') + controller_dir = os.path.join(AppLocation.get_directory(AppLocation.PluginsDir), u'presentations', u'lib') for filename in os.listdir(controller_dir): if filename.endswith(u'controller.py') and not filename == 'presentationcontroller.py': path = os.path.join(controller_dir, filename) @@ -146,7 +142,7 @@ class PresentationPlugin(Plugin): def about(self): """ - Return information about this plugin + Return information about this plugin. """ about_text = translate('PresentationPlugin', 'Presentation ' 'Plugin
The presentation plugin provides the ' @@ -157,7 +153,7 @@ class PresentationPlugin(Plugin): def set_plugin_text_strings(self): """ - Called to define all translatable texts of the plugin + Called to define all translatable texts of the plugin. """ ## Name PluginList ## self.text_strings[StringContent.Name] = { diff --git a/openlp/plugins/songusage/__init__.py b/openlp/plugins/songusage/__init__.py index d18c787f0..b0d3ecc12 100644 --- a/openlp/plugins/songusage/__init__.py +++ b/openlp/plugins/songusage/__init__.py @@ -27,7 +27,6 @@ # Temple Place, Suite 330, Boston, MA 02111-1307 USA # ############################################################################### """ -The :mod:`songusage` module contains the Song Usage plugin. The Song Usage -plugin provides auditing capabilities for reporting the songs you are using to -copyright license organisations. +The :mod:`songusage` module contains the Song Usage plugin. The Song Usage plugin provides auditing capabilities for +reporting the songs you are using to copyright license organisations. """ diff --git a/openlp/plugins/songusage/forms/songusagedeletedialog.py b/openlp/plugins/songusage/forms/songusagedeletedialog.py index a1ad701b2..cffbdf733 100644 --- a/openlp/plugins/songusage/forms/songusagedeletedialog.py +++ b/openlp/plugins/songusage/forms/songusagedeletedialog.py @@ -55,7 +55,8 @@ class Ui_SongUsageDeleteDialog(object): self.retranslateUi(song_usage_delete_dialog) def retranslateUi(self, song_usage_delete_dialog): - song_usage_delete_dialog.setWindowTitle(translate('SongUsagePlugin.SongUsageDeleteForm', 'Delete Song Usage Data')) + song_usage_delete_dialog.setWindowTitle( + translate('SongUsagePlugin.SongUsageDeleteForm', 'Delete Song Usage Data')) self.delete_label.setText( translate('SongUsagePlugin.SongUsageDeleteForm', 'Select the date up to which the song usage data ' 'should be deleted. All data recorded before this date will be permanently deleted.')) diff --git a/openlp/plugins/songusage/forms/songusagedetaildialog.py b/openlp/plugins/songusage/forms/songusagedetaildialog.py index 47fc9bf27..1922d261a 100644 --- a/openlp/plugins/songusage/forms/songusagedetaildialog.py +++ b/openlp/plugins/songusage/forms/songusagedetaildialog.py @@ -81,7 +81,8 @@ class Ui_SongUsageDetailDialog(object): self.save_file_push_button.clicked.connect(song_usage_detail_dialog.define_output_location) def retranslateUi(self, song_usage_detail_dialog): - song_usage_detail_dialog.setWindowTitle(translate('SongUsagePlugin.SongUsageDetailForm', 'Song Usage Extraction')) + song_usage_detail_dialog.setWindowTitle( + translate('SongUsagePlugin.SongUsageDetailForm', 'Song Usage Extraction')) self.date_range_group_box.setTitle(translate('SongUsagePlugin.SongUsageDetailForm', 'Select Date Range')) self.to_label.setText(translate('SongUsagePlugin.SongUsageDetailForm', 'to')) self.file_group_box.setTitle(translate('SongUsagePlugin.SongUsageDetailForm', 'Report Location')) diff --git a/openlp/plugins/songusage/lib/db.py b/openlp/plugins/songusage/lib/db.py index 048b75542..5d3da7559 100644 --- a/openlp/plugins/songusage/lib/db.py +++ b/openlp/plugins/songusage/lib/db.py @@ -36,12 +36,14 @@ from sqlalchemy.orm import mapper from openlp.core.lib.db import BaseModel, init_db + class SongUsageItem(BaseModel): """ SongUsageItem model """ pass + def init_schema(url): """ Setup the songusage database connection and initialise the database schema diff --git a/openlp/plugins/songusage/songusageplugin.py b/openlp/plugins/songusage/songusageplugin.py index 7ca056184..7a730c992 100644 --- a/openlp/plugins/songusage/songusageplugin.py +++ b/openlp/plugins/songusage/songusageplugin.py @@ -48,11 +48,11 @@ if QtCore.QDate().currentDate().month() < 9: __default_settings__ = { - u'songusage/db type': u'sqlite', - u'songusage/active': False, - u'songusage/to date': QtCore.QDate(YEAR, 8, 31), - u'songusage/from date': QtCore.QDate(YEAR - 1, 9, 1), - u'songusage/last directory export': u'' + u'songusage/db type': u'sqlite', + u'songusage/active': False, + u'songusage/to date': QtCore.QDate(YEAR, 8, 31), + u'songusage/from date': QtCore.QDate(YEAR - 1, 9, 1), + u'songusage/last directory export': u'' } @@ -76,12 +76,10 @@ class SongUsagePlugin(Plugin): def add_tools_menu_item(self, tools_menu): """ - Give the SongUsage plugin the opportunity to add items to the - **Tools** menu. + Give the SongUsage plugin the opportunity to add items to the **Tools** menu. ``tools_menu`` - The actual **Tools** menu item, so that your actions can - use it as their parent. + The actual **Tools** menu item, so that your actions can use it as their parent. """ log.info(u'add tools menu') self.toolsMenu = tools_menu @@ -218,8 +216,8 @@ class SongUsagePlugin(Plugin): self.song_usage_detail_form.exec_() def about(self): - about_text = translate('SongUsagePlugin', 'SongUsage Plugin' - '
This plugin tracks the usage of songs in services.') + about_text = translate('SongUsagePlugin', + 'SongUsage Plugin
This plugin tracks the usage of songs in services.') return about_text def set_plugin_text_strings(self): From b03c3c6f4fc4701dc693147947f2cf6492b9bcff Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Fri, 19 Apr 2013 21:03:16 +0200 Subject: [PATCH 65/97] code standards --- openlp/plugins/images/__init__.py | 4 +- openlp/plugins/images/forms/__init__.py | 25 ++++---- openlp/plugins/images/forms/addgroupform.py | 10 ++-- .../plugins/images/forms/choosegroupform.py | 8 +-- openlp/plugins/images/imageplugin.py | 10 ++-- openlp/plugins/images/lib/db.py | 6 +- openlp/plugins/images/lib/mediaitem.py | 59 +++++++++---------- openlp/plugins/media/lib/mediaitem.py | 3 + 8 files changed, 60 insertions(+), 65 deletions(-) diff --git a/openlp/plugins/images/__init__.py b/openlp/plugins/images/__init__.py index 12e0cc9e4..9830af231 100644 --- a/openlp/plugins/images/__init__.py +++ b/openlp/plugins/images/__init__.py @@ -27,6 +27,6 @@ # Temple Place, Suite 330, Boston, MA 02111-1307 USA # ############################################################################### """ -The :mod:`images` module provides the Images plugin. The Images plugin -provides the facility to display images from OpenLP. +The :mod:`images` module provides the Images plugin. The Images plugin provides the facility to display images from +OpenLP. """ diff --git a/openlp/plugins/images/forms/__init__.py b/openlp/plugins/images/forms/__init__.py index d308a1471..8bb8e966f 100644 --- a/openlp/plugins/images/forms/__init__.py +++ b/openlp/plugins/images/forms/__init__.py @@ -27,20 +27,16 @@ # Temple Place, Suite 330, Boston, MA 02111-1307 USA # ############################################################################### """ -Forms in OpenLP are made up of two classes. One class holds all the graphical -elements, like buttons and lists, and the other class holds all the functional -code, like slots and loading and saving. +Forms in OpenLP are made up of two classes. One class holds all the graphical elements, like buttons and lists, and the +other class holds all the functional code, like slots and loading and saving. -The first class, commonly known as the **Dialog** class, is typically named -``Ui_Dialog``. It is a slightly modified version of the class that the -``pyuic4`` command produces from Qt4's .ui file. Typical modifications will be -converting most strings from "" to u'' and using OpenLP's ``translate()`` -function for translating strings. +The first class, commonly known as the **Dialog** class, is typically named ``Ui_Dialog``. It is a slightly +modified version of the class that the ``pyuic4`` command produces from Qt4's .ui file. Typical modifications will be +converting most strings from "" to u'' and using OpenLP's ``translate()`` function for translating strings. -The second class, commonly known as the **Form** class, is typically named -``Form``. This class is the one which is instantiated and used. It uses -dual inheritance to inherit from (usually) QtGui.QDialog and the Ui class -mentioned above, like so:: +The second class, commonly known as the **Form** class, is typically named ``Form``. This class is the one which +is instantiated and used. It uses dual inheritance to inherit from (usually) QtGui.QDialog and the Ui class mentioned +above, like so:: class AuthorsForm(QtGui.QDialog, Ui_AuthorsDialog): @@ -48,9 +44,8 @@ mentioned above, like so:: QtGui.QDialog.__init__(self, parent) self.setupUi(self) -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. +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 addgroupform import AddGroupForm diff --git a/openlp/plugins/images/forms/addgroupform.py b/openlp/plugins/images/forms/addgroupform.py index 7f7986499..f891969c6 100644 --- a/openlp/plugins/images/forms/addgroupform.py +++ b/openlp/plugins/images/forms/addgroupform.py @@ -47,16 +47,16 @@ class AddGroupForm(QtGui.QDialog, Ui_AddGroupDialog): def exec_(self, clear=True, show_top_level_group=False, selected_group=None): """ - Show the form + Show the form, ``clear`` - Set to False if the text input box should not be cleared when showing the dialog (default: True) + Set to False if the text input box should not be cleared when showing the dialog (default: True), ``show_top_level_group`` - Set to True when "-- Top level group --" should be showed as first item (default: False) + Set to True when "-- Top level group --" should be showed as first item (default: False), ``selected_group`` - The ID of the group that should be selected by default when showing the dialog + The ID of the group that should be selected by default when showing the dialog, """ if clear: self.name_edit.clear() @@ -72,7 +72,7 @@ class AddGroupForm(QtGui.QDialog, Ui_AddGroupDialog): def accept(self): """ - Override the accept() method from QDialog to make sure something is entered in the text input box + Override the accept() method from QDialog to make sure something is entered in the text input box. """ if not self.name_edit.text(): critical_error_message_box(message=translate('ImagePlugin.AddGroupForm', diff --git a/openlp/plugins/images/forms/choosegroupform.py b/openlp/plugins/images/forms/choosegroupform.py index bbb57255c..f11c8324c 100644 --- a/openlp/plugins/images/forms/choosegroupform.py +++ b/openlp/plugins/images/forms/choosegroupform.py @@ -48,10 +48,10 @@ class ChooseGroupForm(QtGui.QDialog, Ui_ChooseGroupDialog): Show the form ``selected_group`` - The ID of the group that should be selected by default when showing the dialog + The ID of the group that should be selected by default when showing the dialog. """ if selected_group is not None: - for i in range(self.group_combobox.count()): - if self.group_combobox.itemData(i) == selected_group: - self.group_combobox.setCurrentIndex(i) + for index in range(self.group_combobox.count()): + if self.group_combobox.itemData(index) == selected_group: + self.group_combobox.setCurrentIndex(index) return QtGui.QDialog.exec_(self) diff --git a/openlp/plugins/images/imageplugin.py b/openlp/plugins/images/imageplugin.py index cb25dc375..dfe927a7b 100644 --- a/openlp/plugins/images/imageplugin.py +++ b/openlp/plugins/images/imageplugin.py @@ -70,10 +70,10 @@ class ImagePlugin(Plugin): def app_startup(self): """ - Perform tasks on application startup + Perform tasks on application startup. """ Plugin.app_startup(self) - # Convert old settings-based image list to the database + # Convert old settings-based image list to the database. files_from_config = Settings().get_files_from_config(self) if files_from_config: log.debug(u'Importing images list from old config: %s' % files_from_config) @@ -93,7 +93,7 @@ class ImagePlugin(Plugin): def set_plugin_text_strings(self): """ - Called to define all translatable texts of the plugin + Called to define all translatable texts of the plugin. """ ## Name PluginList ## self.text_strings[StringContent.Name] = { @@ -117,8 +117,8 @@ class ImagePlugin(Plugin): def config_update(self): """ - Triggered by saving and changing the image border. Sets the images in image manager to require updates. - Actual update is triggered by the last part of saving the config. + Triggered by saving and changing the image border. Sets the images in image manager to require updates. Actual + update is triggered by the last part of saving the config. """ log.info(u'Images config_update') background = QtGui.QColor(Settings().value(self.settings_section + u'/background color')) diff --git a/openlp/plugins/images/lib/db.py b/openlp/plugins/images/lib/db.py index bc4a94f15..1d8f473d8 100644 --- a/openlp/plugins/images/lib/db.py +++ b/openlp/plugins/images/lib/db.py @@ -27,7 +27,7 @@ # Temple Place, Suite 330, Boston, MA 02111-1307 USA # ############################################################################### """ -The :mod:`db` module provides the database and schema that is the backend for the Images plugin +The :mod:`db` module provides the database and schema that is the backend for the Images plugin. """ from sqlalchemy import Column, ForeignKey, Table, types @@ -38,14 +38,14 @@ from openlp.core.lib.db import BaseModel, init_db class ImageGroups(BaseModel): """ - ImageGroups model + ImageGroups model. """ pass class ImageFilenames(BaseModel): """ - ImageFilenames model + ImageFilenames model. """ pass diff --git a/openlp/plugins/images/lib/mediaitem.py b/openlp/plugins/images/lib/mediaitem.py index fc575ec0a..5281070fb 100644 --- a/openlp/plugins/images/lib/mediaitem.py +++ b/openlp/plugins/images/lib/mediaitem.py @@ -40,6 +40,7 @@ from openlp.core.utils import AppLocation, delete_file, get_locale_key, get_imag from openlp.plugins.images.forms import AddGroupForm, ChooseGroupForm from openlp.plugins.images.lib.db import ImageFilenames, ImageGroups + log = logging.getLogger(__name__) @@ -60,12 +61,11 @@ class ImageMediaItem(MediaManagerItem): self.fill_groups_combobox(self.choose_group_form.group_combobox) self.fill_groups_combobox(self.add_group_form.parent_group_combobox) Registry().register_function(u'live_theme_changed', self.live_theme_changed) - # Allow DnD from the desktop + # Allow DnD from the desktop. self.list_view.activateDnD() def retranslateUi(self): - self.on_new_prompt = translate('ImagePlugin.MediaItem', - 'Select Image(s)') + self.on_new_prompt = translate('ImagePlugin.MediaItem', 'Select Image(s)') file_formats = get_images_filter() self.on_new_file_masks = u'%s;;%s (*.*) (*)' % (file_formats, UiStrings().AllFiles) self.addGroupAction.setText(UiStrings().AddGroup) @@ -77,7 +77,7 @@ class ImageMediaItem(MediaManagerItem): def required_icons(self): """ - Set which icons the media manager tab should show + Set which icons the media manager tab should show. """ MediaManagerItem.required_icons(self) self.has_file_icon = True @@ -99,8 +99,8 @@ class ImageMediaItem(MediaManagerItem): def add_list_view_to_toolbar(self): """ - Creates the main widget for listing items the media item is tracking. - This method overloads MediaManagerItem.add_list_view_to_toolbar + Creates the main widget for listing items the media item is tracking. This method overloads + MediaManagerItem.add_list_view_to_toolbar. """ # Add the List widget self.list_view = TreeWidgetWithDnD(self, self.plugin.name) @@ -159,21 +159,18 @@ class ImageMediaItem(MediaManagerItem): def add_custom_context_actions(self): """ - Add custom actions to the context menu + Add custom actions to the context menu. """ create_widget_action(self.list_view, separator=True) create_widget_action(self.list_view, - text=UiStrings().AddGroup, - icon=u':/images/image_new_group.png', - triggers=self.onAddGroupClick) + text=UiStrings().AddGroup, icon=u':/images/image_new_group.png', triggers=self.onAddGroupClick) create_widget_action(self.list_view, text=self.plugin.get_string(StringContent.Load)[u'tooltip'], - icon=u':/general/general_open.png', - triggers=self.on_file_click) + icon=u':/general/general_open.png', triggers=self.on_file_click) def add_start_header_bar(self): """ - Add custom buttons to the start of the toolbar + Add custom buttons to the start of the toolbar. """ self.addGroupAction = self.toolbar.add_toolbar_action(u'addGroupAction', icon=u':/images/image_new_group.png', triggers=self.onAddGroupClick) @@ -189,10 +186,10 @@ class ImageMediaItem(MediaManagerItem): def recursively_delete_group(self, image_group): """ - Recursively deletes a group and all groups and images in it + Recursively deletes a group and all groups and images in it. ``image_group`` - The ImageGroups instance of the group that will be deleted + The ImageGroups instance of the group that will be deleted. """ images = self.manager.get_all_objects(ImageFilenames, ImageFilenames.group_id == image_group.id) for image in images: @@ -205,7 +202,7 @@ class ImageMediaItem(MediaManagerItem): def on_delete_click(self): """ - Remove an image item from the list + Remove an image item from the list. """ # Turn off auto preview triggers. self.list_view.blockSignals(True) @@ -226,11 +223,11 @@ class ImageMediaItem(MediaManagerItem): self.manager.delete_object(ImageFilenames, row_item.data(0, QtCore.Qt.UserRole).id) elif isinstance(item_data, ImageGroups): if QtGui.QMessageBox.question(self.list_view.parent(), - translate('ImagePlugin.MediaItem', 'Remove group'), - translate('ImagePlugin.MediaItem', - 'Are you sure you want to remove "%s" and everything in it?') % item_data.group_name, - QtGui.QMessageBox.StandardButtons(QtGui.QMessageBox.Yes | - QtGui.QMessageBox.No)) == QtGui.QMessageBox.Yes: + translate('ImagePlugin.MediaItem', 'Remove group'), + translate('ImagePlugin.MediaItem', + 'Are you sure you want to remove "%s" and everything in it?') % item_data.group_name, + QtGui.QMessageBox.StandardButtons(QtGui.QMessageBox.Yes | + QtGui.QMessageBox.No)) == QtGui.QMessageBox.Yes: self.recursively_delete_group(item_data) self.manager.delete_object(ImageGroups, row_item.data(0, QtCore.Qt.UserRole).id) if item_data.parent_id == 0: @@ -246,13 +243,13 @@ class ImageMediaItem(MediaManagerItem): def add_sub_groups(self, group_list, parent_group_id): """ - Recursively add subgroups to the given parent group in a QTreeWidget + Recursively add subgroups to the given parent group in a QTreeWidget. ``group_list`` - The List object that contains all QTreeWidgetItems + The List object that contains all QTreeWidgetItems. ``parent_group_id`` - The ID of the group that will be added recursively + The ID of the group that will be added recursively. """ image_groups = self.manager.get_all_objects(ImageGroups, ImageGroups.parent_id == parent_group_id) image_groups.sort(key=lambda group_object: get_locale_key(group_object.group_name)) @@ -271,16 +268,16 @@ class ImageMediaItem(MediaManagerItem): def fill_groups_combobox(self, combobox, parent_group_id=0, prefix=''): """ - Recursively add groups to the combobox in the 'Add group' dialog + Recursively add groups to the combobox in the 'Add group' dialog. ``combobox`` - The QComboBox to add the options to + The QComboBox to add the options to. ``parent_group_id`` - The ID of the group that will be added + The ID of the group that will be added. ``prefix`` - A string containing the prefix that will be added in front of the groupname for each level of the tree + A string containing the prefix that will be added in front of the groupname for each level of the tree. """ if parent_group_id == 0: combobox.clear() @@ -293,13 +290,13 @@ class ImageMediaItem(MediaManagerItem): def expand_group(self, group_id, root_item=None): """ - Expand groups in the widget recursively + Expand groups in the widget recursively. ``group_id`` - The ID of the group that will be expanded + The ID of the group that will be expanded. ``root_item`` - This option is only used for recursion purposes + This option is only used for recursion purposes. """ return_value = False if root_item is None: diff --git a/openlp/plugins/media/lib/mediaitem.py b/openlp/plugins/media/lib/mediaitem.py index 7d492bc69..751d7a202 100644 --- a/openlp/plugins/media/lib/mediaitem.py +++ b/openlp/plugins/media/lib/mediaitem.py @@ -39,14 +39,17 @@ from openlp.core.ui import DisplayController, Display, DisplayControllerType from openlp.core.ui.media import get_media_players, set_media_players from openlp.core.utils import AppLocation, get_locale_key + log = logging.getLogger(__name__) + CLAPPERBOARD = u':/media/slidecontroller_multimedia.png' VIDEO = build_icon(QtGui.QImage(u':/media/media_video.png')) AUDIO = build_icon(QtGui.QImage(u':/media/media_audio.png')) DVDICON = build_icon(QtGui.QImage(u':/media/media_video.png')) ERROR = build_icon(QtGui.QImage(u':/general/general_delete.png')) + class MediaMediaItem(MediaManagerItem): """ This is the custom media manager item for Media Slides. From 582f1aa003b4c1efde5732d3c72bd10ef1ceb8eb Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Fri, 19 Apr 2013 21:07:25 +0200 Subject: [PATCH 66/97] code standards --- openlp/plugins/images/lib/mediaitem.py | 45 +++++++++---------- .../openlp_plugins/images/test_lib.py | 30 ++++++------- 2 files changed, 37 insertions(+), 38 deletions(-) diff --git a/openlp/plugins/images/lib/mediaitem.py b/openlp/plugins/images/lib/mediaitem.py index 5281070fb..716db6c8a 100644 --- a/openlp/plugins/images/lib/mediaitem.py +++ b/openlp/plugins/images/lib/mediaitem.py @@ -94,7 +94,7 @@ class ImageMediaItem(MediaManagerItem): self.servicePath = os.path.join(AppLocation.get_section_data_path(self.settings_section), u'thumbnails') check_directory_exists(self.servicePath) # Load images from the database - self.loadFullList( + self.load_full_list( self.manager.get_all_objects(ImageFilenames, order_by_ref=ImageFilenames.filename), initial_load=True) def add_list_view_to_toolbar(self): @@ -163,7 +163,7 @@ class ImageMediaItem(MediaManagerItem): """ create_widget_action(self.list_view, separator=True) create_widget_action(self.list_view, - text=UiStrings().AddGroup, icon=u':/images/image_new_group.png', triggers=self.onAddGroupClick) + text=UiStrings().AddGroup, icon=u':/images/image_new_group.png', triggers=self.on_add_group_click) create_widget_action(self.list_view, text=self.plugin.get_string(StringContent.Load)[u'tooltip'], icon=u':/general/general_open.png', triggers=self.on_file_click) @@ -173,16 +173,16 @@ class ImageMediaItem(MediaManagerItem): Add custom buttons to the start of the toolbar. """ self.addGroupAction = self.toolbar.add_toolbar_action(u'addGroupAction', - icon=u':/images/image_new_group.png', triggers=self.onAddGroupClick) + icon=u':/images/image_new_group.png', triggers=self.on_add_group_click) def add_end_header_bar(self): """ Add custom buttons to the end of the toolbar """ self.replaceAction = self.toolbar.add_toolbar_action(u'replaceAction', - icon=u':/slides/slide_blank.png', triggers=self.onReplaceClick) + icon=u':/slides/slide_blank.png', triggers=self.on_replace_click) self.resetAction = self.toolbar.add_toolbar_action(u'resetAction', - icon=u':/system/system_close.png', visible=False, triggers=self.onResetClick) + icon=u':/system/system_close.png', visible=False, triggers=self.on_reset_click) def recursively_delete_group(self, image_group): """ @@ -311,29 +311,29 @@ class ImageMediaItem(MediaManagerItem): return True return return_value - def loadFullList(self, images, initial_load=False, open_group=None): + def load_full_list(self, images, initial_load=False, open_group=None): """ Replace the list of images and groups in the interface. ``images`` - A List of ImageFilenames objects that will be used to reload the mediamanager list + A List of ImageFilenames objects that will be used to reload the mediamanager list. ``initial_load`` - When set to False, the busy cursor and progressbar will be shown while loading images + When set to False, the busy cursor and progressbar will be shown while loading images. ``open_group`` - ImageGroups object of the group that must be expanded after reloading the list in the interface + ImageGroups object of the group that must be expanded after reloading the list in the interface. """ if not initial_load: self.application.set_busy_cursor() self.main_window.display_progress_bar(len(images)) self.list_view.clear() - # Load the list of groups and add them to the treeView + # Load the list of groups and add them to the treeView. group_items = {} self.add_sub_groups(group_items, parent_group_id=0) if open_group is not None: self.expand_group(open_group.id) - # Sort the images by its filename considering language specific + # Sort the images by its filename considering language specific. # characters. images.sort(key=lambda image_object: get_locale_key(os.path.split(unicode(image_object.filename))[1])) for imageFile in images: @@ -452,7 +452,7 @@ class ImageMediaItem(MediaManagerItem): self.main_window.display_progress_bar(len(images)) # Save the new images in the database self.save_new_images_list(images, group_id=parent_group.id, reload_list=False) - self.loadFullList(self.manager.get_all_objects(ImageFilenames, order_by_ref=ImageFilenames.filename), + self.load_full_list(self.manager.get_all_objects(ImageFilenames, order_by_ref=ImageFilenames.filename), initial_load=initial_load, open_group=parent_group) self.application.set_normal_cursor() @@ -479,7 +479,7 @@ class ImageMediaItem(MediaManagerItem): self.manager.save_object(imageFile) self.main_window.increment_progress_bar() if reload_list and images_list: - self.loadFullList(self.manager.get_all_objects(ImageFilenames, order_by_ref=ImageFilenames.filename)) + self.load_full_list(self.manager.get_all_objects(ImageFilenames, order_by_ref=ImageFilenames.filename)) def dnd_move_internal(self, target): """ @@ -527,7 +527,7 @@ class ImageMediaItem(MediaManagerItem): image_items.sort(key=lambda item: get_locale_key(item.text(0))) target_group.addChildren(image_items) - def generate_slide_data(self, service_item, item=None, xmlVersion=False, + def generate_slide_data(self, service_item, item=None, xml_version=False, remote=False, context=ServiceItemContext.Service): """ Generate the slide data. Needs to be implemented by the plugin. @@ -605,7 +605,7 @@ class ImageMediaItem(MediaManagerItem): else: return False - def onAddGroupClick(self): + def on_add_group_click(self): """ Called to add a new group """ @@ -626,7 +626,7 @@ class ImageMediaItem(MediaManagerItem): group_name=self.add_group_form.name_edit.text()) if not self.check_group_exists(new_group): if self.manager.save_object(new_group): - self.loadFullList(self.manager.get_all_objects(ImageFilenames, + self.load_full_list(self.manager.get_all_objects(ImageFilenames, order_by_ref=ImageFilenames.filename)) self.expand_group(new_group.id) self.fill_groups_combobox(self.choose_group_form.group_combobox) @@ -635,23 +635,22 @@ class ImageMediaItem(MediaManagerItem): critical_error_message_box( message=translate('ImagePlugin.AddGroupForm', 'Could not add the new group.')) else: - critical_error_message_box( - message=translate('ImagePlugin.AddGroupForm', 'This group already exists.')) + critical_error_message_box(message=translate('ImagePlugin.AddGroupForm', 'This group already exists.')) - def onResetClick(self): + def on_reset_click(self): """ - Called to reset the Live background with the image selected, + Called to reset the Live background with the image selected. """ self.resetAction.setVisible(False) self.live_controller.display.reset_image() def live_theme_changed(self): """ - Triggered by the change of theme in the slide controller + Triggered by the change of theme in the slide controller. """ self.resetAction.setVisible(False) - def onReplaceClick(self): + def on_replace_click(self): """ Called to replace Live backgound with the image selected. """ @@ -660,7 +659,7 @@ class ImageMediaItem(MediaManagerItem): background = QtGui.QColor(Settings().value(self.settings_section + u'/background color')) bitem = self.list_view.selectedItems()[0] if not isinstance(bitem.data(0, QtCore.Qt.UserRole), ImageFilenames): - # Only continue when an image is selected + # Only continue when an image is selected. return filename = bitem.data(0, QtCore.Qt.UserRole).filename if os.path.exists(filename): diff --git a/tests/functional/openlp_plugins/images/test_lib.py b/tests/functional/openlp_plugins/images/test_lib.py index a355e956b..5033f0645 100644 --- a/tests/functional/openlp_plugins/images/test_lib.py +++ b/tests/functional/openlp_plugins/images/test_lib.py @@ -35,7 +35,7 @@ class TestImageMediaItem(TestCase): """ # GIVEN: An empty image_list image_list = [] - with patch(u'openlp.plugins.images.lib.mediaitem.ImageMediaItem.loadFullList') as mocked_loadFullList: + with patch(u'openlp.plugins.images.lib.mediaitem.ImageMediaItem.load_full_list') as mocked_loadFullList: self.media_item.manager = MagicMock() # WHEN: We run save_new_images_list with the empty list @@ -47,37 +47,37 @@ class TestImageMediaItem(TestCase): def save_new_images_list_single_image_with_reload_test(self): """ - Test that the save_new_images_list() calls loadFullList() when reload_list is set to True + Test that the save_new_images_list() calls load_full_list() when reload_list is set to True """ # GIVEN: A list with 1 image image_list = [ u'test_image.jpg' ] - with patch(u'openlp.plugins.images.lib.mediaitem.ImageMediaItem.loadFullList') as mocked_loadFullList: + with patch(u'openlp.plugins.images.lib.mediaitem.ImageMediaItem.load_full_list') as mocked_loadFullList: ImageFilenames.filename = '' self.media_item.manager = MagicMock() # WHEN: We run save_new_images_list with reload_list=True self.media_item.save_new_images_list(image_list, reload_list=True) - # THEN: loadFullList() should have been called - assert mocked_loadFullList.call_count == 1, u'loadFullList() should have been called' + # THEN: load_full_list() should have been called + assert mocked_loadFullList.call_count == 1, u'load_full_list() should have been called' # CLEANUP: Remove added attribute from ImageFilenames delattr(ImageFilenames, 'filename') def save_new_images_list_single_image_without_reload_test(self): """ - Test that the save_new_images_list() doesn't call loadFullList() when reload_list is set to False + Test that the save_new_images_list() doesn't call load_full_list() when reload_list is set to False """ # GIVEN: A list with 1 image image_list = [ u'test_image.jpg' ] - with patch(u'openlp.plugins.images.lib.mediaitem.ImageMediaItem.loadFullList') as mocked_loadFullList: + with patch(u'openlp.plugins.images.lib.mediaitem.ImageMediaItem.load_full_list') as mocked_loadFullList: 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: loadFullList() should not have been called - assert mocked_loadFullList.call_count == 0, u'loadFullList() should not have been called' + # THEN: load_full_list() should not have been called + assert mocked_loadFullList.call_count == 0, u'load_full_list() should not have been called' def save_new_images_list_multiple_images_test(self): """ @@ -85,15 +85,15 @@ 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.loadFullList') as mocked_loadFullList: + with patch(u'openlp.plugins.images.lib.mediaitem.ImageMediaItem.load_full_list') as mocked_loadFullList: self.media_item.manager = MagicMock() # WHEN: We run save_new_images_list with the list of 3 images self.media_item.save_new_images_list(image_list, reload_list=False) - # THEN: loadFullList() should not have been called + # THEN: load_full_list() should not have been called assert self.media_item.manager.save_object.call_count == 3, \ - u'loadFullList() should have been called three times' + u'load_full_list() should have been called three times' def save_new_images_list_other_objects_in_list_test(self): """ @@ -101,12 +101,12 @@ 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.loadFullList') as mocked_loadFullList: + with patch(u'openlp.plugins.images.lib.mediaitem.ImageMediaItem.load_full_list') as mocked_loadFullList: self.media_item.manager = MagicMock() # WHEN: We run save_new_images_list with the list of images and objects self.media_item.save_new_images_list(image_list, reload_list=False) - # THEN: loadFullList() should not have been called + # THEN: load_full_list() should not have been called assert self.media_item.manager.save_object.call_count == 2, \ - u'loadFullList() should have been called only once' + u'load_full_list() should have been called only once' From 7682698cf1b6742e29137903466a407eabe47f9b Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Fri, 19 Apr 2013 21:15:12 +0200 Subject: [PATCH 67/97] media code standards --- openlp/plugins/images/lib/mediaitem.py | 20 ++-- openlp/plugins/media/__init__.py | 7 +- openlp/plugins/media/lib/mediaitem.py | 110 +++++++++--------- openlp/plugins/media/mediaplugin.py | 14 ++- openlp/plugins/presentations/lib/mediaitem.py | 24 ++-- openlp/plugins/songs/forms/editsongform.py | 2 +- 6 files changed, 88 insertions(+), 89 deletions(-) diff --git a/openlp/plugins/images/lib/mediaitem.py b/openlp/plugins/images/lib/mediaitem.py index 716db6c8a..95f0971fd 100644 --- a/openlp/plugins/images/lib/mediaitem.py +++ b/openlp/plugins/images/lib/mediaitem.py @@ -70,10 +70,10 @@ class ImageMediaItem(MediaManagerItem): self.on_new_file_masks = u'%s;;%s (*.*) (*)' % (file_formats, UiStrings().AllFiles) self.addGroupAction.setText(UiStrings().AddGroup) self.addGroupAction.setToolTip(UiStrings().AddGroup) - self.replaceAction.setText(UiStrings().ReplaceBG) - self.replaceAction.setToolTip(UiStrings().ReplaceLiveBG) - self.resetAction.setText(UiStrings().ResetBG) - self.resetAction.setToolTip(UiStrings().ResetLiveBG) + self.replace_action.setText(UiStrings().ReplaceBG) + self.replace_action.setToolTip(UiStrings().ReplaceLiveBG) + self.reset_action.setText(UiStrings().ResetBG) + self.reset_action.setToolTip(UiStrings().ResetLiveBG) def required_icons(self): """ @@ -155,7 +155,7 @@ class ImageMediaItem(MediaManagerItem): self.list_view.doubleClicked.connect(self.on_double_clicked) self.list_view.itemSelectionChanged.connect(self.on_selection_change) self.list_view.customContextMenuRequested.connect(self.context_menu) - self.list_view.addAction(self.replaceAction) + self.list_view.addAction(self.replace_action) def add_custom_context_actions(self): """ @@ -179,9 +179,9 @@ class ImageMediaItem(MediaManagerItem): """ Add custom buttons to the end of the toolbar """ - self.replaceAction = self.toolbar.add_toolbar_action(u'replaceAction', + self.replace_action = self.toolbar.add_toolbar_action(u'replace_action', icon=u':/slides/slide_blank.png', triggers=self.on_replace_click) - self.resetAction = self.toolbar.add_toolbar_action(u'resetAction', + self.reset_action = self.toolbar.add_toolbar_action(u'reset_action', icon=u':/system/system_close.png', visible=False, triggers=self.on_reset_click) def recursively_delete_group(self, image_group): @@ -641,14 +641,14 @@ class ImageMediaItem(MediaManagerItem): """ Called to reset the Live background with the image selected. """ - self.resetAction.setVisible(False) + self.reset_action.setVisible(False) self.live_controller.display.reset_image() def live_theme_changed(self): """ Triggered by the change of theme in the slide controller. """ - self.resetAction.setVisible(False) + self.reset_action.setVisible(False) def on_replace_click(self): """ @@ -664,7 +664,7 @@ class ImageMediaItem(MediaManagerItem): filename = bitem.data(0, QtCore.Qt.UserRole).filename if os.path.exists(filename): if self.live_controller.display.direct_image(filename, background): - self.resetAction.setVisible(True) + self.reset_action.setVisible(True) else: critical_error_message_box(UiStrings().LiveBGError, translate('ImagePlugin.MediaItem', 'There was no display item to amend.')) diff --git a/openlp/plugins/media/__init__.py b/openlp/plugins/media/__init__.py index deb4cbeac..2a2e9f5aa 100644 --- a/openlp/plugins/media/__init__.py +++ b/openlp/plugins/media/__init__.py @@ -27,8 +27,7 @@ # Temple Place, Suite 330, Boston, MA 02111-1307 USA # ############################################################################### """ -The :mod:`media` module provides the Media plugin which allows OpenLP to -display videos. The media supported depends not only on the Python support -but also extensively on the codecs installed on the underlying operating system -being picked up and usable by Python. +The :mod:`media` module provides the Media plugin which allows OpenLP to display videos. The media supported depends not +only on the Python support but also extensively on the codecs installed on the underlying operating system being picked +up and usable by Python. """ diff --git a/openlp/plugins/media/lib/mediaitem.py b/openlp/plugins/media/lib/mediaitem.py index 751d7a202..2037346ad 100644 --- a/openlp/plugins/media/lib/mediaitem.py +++ b/openlp/plugins/media/lib/mediaitem.py @@ -44,10 +44,10 @@ log = logging.getLogger(__name__) CLAPPERBOARD = u':/media/slidecontroller_multimedia.png' -VIDEO = build_icon(QtGui.QImage(u':/media/media_video.png')) -AUDIO = build_icon(QtGui.QImage(u':/media/media_audio.png')) -DVDICON = build_icon(QtGui.QImage(u':/media/media_video.png')) -ERROR = build_icon(QtGui.QImage(u':/general/general_delete.png')) +VIDEO_ICON = build_icon(QtGui.QImage(u':/media/media_video.png')) +AUDIO_ICON = build_icon(QtGui.QImage(u':/media/media_audio.png')) +DVD_ICON = build_icon(QtGui.QImage(u':/media/media_video.png')) +ERROR_ICON = build_icon(QtGui.QImage(u':/general/general_delete.png')) class MediaMediaItem(MediaManagerItem): @@ -82,12 +82,12 @@ class MediaMediaItem(MediaManagerItem): def retranslateUi(self): self.on_new_prompt = translate('MediaPlugin.MediaItem', 'Select Media') - self.replaceAction.setText(UiStrings().ReplaceBG) - self.replaceAction.setToolTip(UiStrings().ReplaceLiveBG) - self.resetAction.setText(UiStrings().ResetBG) - self.resetAction.setToolTip(UiStrings().ResetLiveBG) + self.replace_action.setText(UiStrings().ReplaceBG) + self.replace_action.setToolTip(UiStrings().ReplaceLiveBG) + self.reset_action.setText(UiStrings().ResetBG) + self.reset_action.setToolTip(UiStrings().ResetLiveBG) self.automatic = UiStrings().Automatic - self.displayTypeLabel.setText(translate('MediaPlugin.MediaItem', 'Use Player:')) + self.display_type_label.setText(translate('MediaPlugin.MediaItem', 'Use Player:')) self.rebuild_players() def required_icons(self): @@ -101,27 +101,28 @@ class MediaMediaItem(MediaManagerItem): def add_list_view_to_toolbar(self): MediaManagerItem.add_list_view_to_toolbar(self) - self.list_view.addAction(self.replaceAction) + self.list_view.addAction(self.replace_action) def add_end_header_bar(self): # Replace backgrounds do not work at present so remove functionality. - self.replaceAction = self.toolbar.add_toolbar_action(u'replaceAction', icon=u':/slides/slide_blank.png', + self.replace_action = self.toolbar.add_toolbar_action(u'replace_action', icon=u':/slides/slide_blank.png', triggers=self.onReplaceClick) - self.resetAction = self.toolbar.add_toolbar_action(u'resetAction', icon=u':/system/system_close.png', + self.reset_action = self.toolbar.add_toolbar_action(u'reset_action', icon=u':/system/system_close.png', visible=False, triggers=self.onResetClick) - self.mediaWidget = QtGui.QWidget(self) - self.mediaWidget.setObjectName(u'mediaWidget') - self.displayLayout = QtGui.QFormLayout(self.mediaWidget) - self.displayLayout.setMargin(self.displayLayout.spacing()) - self.displayLayout.setObjectName(u'displayLayout') - self.displayTypeLabel = QtGui.QLabel(self.mediaWidget) - self.displayTypeLabel.setObjectName(u'displayTypeLabel') - self.displayTypeComboBox = create_horizontal_adjusting_combo_box(self.mediaWidget, u'displayTypeComboBox') - self.displayTypeLabel.setBuddy(self.displayTypeComboBox) - self.displayLayout.addRow(self.displayTypeLabel, self.displayTypeComboBox) - # Add the Media widget to the page layout - self.page_layout.addWidget(self.mediaWidget) - self.displayTypeComboBox.currentIndexChanged.connect(self.overridePlayerChanged) + self.media_widget = QtGui.QWidget(self) + self.media_widget.setObjectName(u'media_widget') + self.display_layout = QtGui.QFormLayout(self.media_widget) + self.display_layout.setMargin(self.display_layout.spacing()) + self.display_layout.setObjectName(u'display_layout') + self.display_type_label = QtGui.QLabel(self.media_widget) + self.display_type_label.setObjectName(u'display_type_label') + self.display_type_combo_box = create_horizontal_adjusting_combo_box( + self.media_widget, u'display_type_combo_box') + self.display_type_label.setBuddy(self.display_type_combo_box) + self.display_layout.addRow(self.display_type_label, self.display_type_combo_box) + # Add the Media widget to the page layout. + self.page_layout.addWidget(self.media_widget) + self.display_type_combo_box.currentIndexChanged.connect(self.overridePlayerChanged) def overridePlayerChanged(self, index): player = get_media_players()[0] @@ -135,13 +136,13 @@ class MediaMediaItem(MediaManagerItem): Called to reset the Live background with the media selected, """ self.media_controller.media_reset(self.live_controller) - self.resetAction.setVisible(False) + self.reset_action.setVisible(False) def video_background_replaced(self): """ Triggered by main display on change of serviceitem. """ - self.resetAction.setVisible(False) + self.reset_action.setVisible(False) def onReplaceClick(self): """ @@ -158,7 +159,7 @@ class MediaMediaItem(MediaManagerItem): (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): - self.resetAction.setVisible(True) + self.reset_action.setVisible(True) else: critical_error_message_box(UiStrings().LiveBGError, translate('MediaPlugin.MediaItem', 'There was no display item to amend.')) @@ -167,7 +168,7 @@ class MediaMediaItem(MediaManagerItem): translate('MediaPlugin.MediaItem', 'There was a problem replacing your background, the media file "%s" no longer exists.') % filename) - def generate_slide_data(self, service_item, item=None, xmlVersion=False, remote=False, + def generate_slide_data(self, service_item, item=None, xml_version=False, remote=False, context=ServiceItemContext.Live): """ Generate the slide data. Needs to be implemented by the plugin. @@ -184,7 +185,7 @@ 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.displayTypeComboBox.currentText() + service_item.title = self.display_type_combo_box.currentText() service_item.shortname = service_item.title (path, name) = os.path.split(filename) service_item.add_from_command(path, name, CLAPPERBOARD) @@ -212,8 +213,7 @@ class MediaMediaItem(MediaManagerItem): def rebuild_players(self): """ - Rebuild the tab in the media manager when changes are made in - the settings + Rebuild the tab in the media manager when changes are made in the settings. """ self.populateDisplayTypes() self.on_new_file_masks = translate('MediaPlugin.MediaItem', 'Videos (%s);;Audio (%s);;%s (*)') % ( @@ -225,29 +225,27 @@ class MediaMediaItem(MediaManagerItem): def populateDisplayTypes(self): """ - Load the combobox with the enabled media players, - allowing user to select a specific player if settings allow + Load the combobox with the enabled media players, allowing user to select a specific player if settings allow. """ - # block signals to avoid unnecessary overridePlayerChanged Signals - # while combo box creation - self.displayTypeComboBox.blockSignals(True) - self.displayTypeComboBox.clear() + # block signals to avoid unnecessary overridePlayerChanged Signals while combo box creation + self.display_type_combo_box.blockSignals(True) + self.display_type_combo_box.clear() usedPlayers, overridePlayer = get_media_players() media_players = self.media_controller.media_players currentIndex = 0 for player in usedPlayers: # load the drop down selection - self.displayTypeComboBox.addItem(media_players[player].original_name) + self.display_type_combo_box.addItem(media_players[player].original_name) if overridePlayer == player: - currentIndex = len(self.displayTypeComboBox) - if self.displayTypeComboBox.count() > 1: - self.displayTypeComboBox.insertItem(0, self.automatic) - self.displayTypeComboBox.setCurrentIndex(currentIndex) + currentIndex = len(self.display_type_combo_box) + if self.display_type_combo_box.count() > 1: + self.display_type_combo_box.insertItem(0, self.automatic) + self.display_type_combo_box.setCurrentIndex(currentIndex) if overridePlayer: - self.mediaWidget.show() + self.media_widget.show() else: - self.mediaWidget.hide() - self.displayTypeComboBox.blockSignals(False) + self.media_widget.hide() + self.display_type_combo_box.blockSignals(False) def on_delete_click(self): """ @@ -270,34 +268,34 @@ class MediaMediaItem(MediaManagerItem): if not os.path.exists(track): filename = os.path.split(unicode(track))[1] item_name = QtGui.QListWidgetItem(filename) - item_name.setIcon(ERROR) + item_name.setIcon(ERROR_ICON) item_name.setData(QtCore.Qt.UserRole, track) elif track_info.isFile(): filename = os.path.split(unicode(track))[1] item_name = QtGui.QListWidgetItem(filename) if u'*.%s' % (filename.split(u'.')[-1].lower()) in self.media_controller.audio_extensions_list: - item_name.setIcon(AUDIO) + item_name.setIcon(AUDIO_ICON) else: - item_name.setIcon(VIDEO) + item_name.setIcon(VIDEO_ICON) item_name.setData(QtCore.Qt.UserRole, track) else: filename = os.path.split(unicode(track))[1] item_name = QtGui.QListWidgetItem(filename) - item_name.setIcon(build_icon(DVDICON)) + item_name.setIcon(build_icon(DVD_ICON)) item_name.setData(QtCore.Qt.UserRole, track) item_name.setToolTip(track) self.list_view.addItem(item_name) - def getList(self, type=MediaType.Audio): + def get_list(self, type=MediaType.Audio): media = Settings().value(self.settings_section + u'/media files') media.sort(key=lambda filename: get_locale_key(os.path.split(unicode(filename))[1])) - ext = [] + extension = [] if type == MediaType.Audio: - ext = self.media_controller.audio_extensions_list + extension = self.media_controller.audio_extensions_list else: - ext = self.media_controller.video_extensions_list - ext = map(lambda x: x[1:], ext) - media = filter(lambda x: os.path.splitext(x)[1] in ext, media) + extension = self.media_controller.video_extensions_list + extension = map(lambda x: x[1:], extension) + media = filter(lambda x: os.path.splitext(x)[1] in extension, media) return media def search(self, string, showError): diff --git a/openlp/plugins/media/mediaplugin.py b/openlp/plugins/media/mediaplugin.py index 0bd95a26b..38cd9bb69 100644 --- a/openlp/plugins/media/mediaplugin.py +++ b/openlp/plugins/media/mediaplugin.py @@ -34,12 +34,14 @@ from PyQt4 import QtCore from openlp.core.lib import Plugin, Registry, StringContent, Settings, build_icon, translate from openlp.plugins.media.lib import MediaMediaItem, MediaTab + log = logging.getLogger(__name__) + # Some settings starting with "media" are in core, because they are needed for core functionality. __default_settings__ = { - u'media/media auto start': QtCore.Qt.Unchecked, - u'media/media files': [] + u'media/media auto start': QtCore.Qt.Unchecked, + u'media/media files': [] } @@ -94,7 +96,7 @@ class MediaPlugin(Plugin): def finalise(self): """ - Time to tidy up on exit + Time to tidy up on exit. """ log.info(u'Media Finalising') self.media_controller.finalise() @@ -102,19 +104,19 @@ class MediaPlugin(Plugin): def get_display_css(self): """ - Add css style sheets to htmlbuilder + Add css style sheets to htmlbuilder. """ return self.media_controller.get_media_display_css() def get_display_javascript(self): """ - Add javascript functions to htmlbuilder + Add javascript functions to htmlbuilder. """ return self.media_controller.get_media_display_javascript() def get_display_html(self): """ - Add html code to htmlbuilder + Add html code to htmlbuilder. """ return self.media_controller.get_media_display_html() diff --git a/openlp/plugins/presentations/lib/mediaitem.py b/openlp/plugins/presentations/lib/mediaitem.py index 9664fcf2f..2f48b99c1 100644 --- a/openlp/plugins/presentations/lib/mediaitem.py +++ b/openlp/plugins/presentations/lib/mediaitem.py @@ -110,11 +110,11 @@ class PresentationMediaItem(MediaManagerItem): self.display_layout.setObjectName(u'display_layout') self.display_type_label = QtGui.QLabel(self.presentation_widget) self.display_type_label.setObjectName(u'display_type_label') - self.displayTypeComboBox = create_horizontal_adjusting_combo_box(self.presentation_widget, - u'displayTypeComboBox') - self.display_type_label.setBuddy(self.displayTypeComboBox) - self.display_layout.addRow(self.display_type_label, self.displayTypeComboBox) - # Add the Presentation widget to the page layout + self.display_type_combo_box = create_horizontal_adjusting_combo_box(self.presentation_widget, + u'display_type_combo_box') + self.display_type_label.setBuddy(self.display_type_combo_box) + self.display_layout.addRow(self.display_type_label, self.display_type_combo_box) + # Add the Presentation widget to the page layout. self.page_layout.addWidget(self.presentation_widget) def initialise(self): @@ -131,14 +131,14 @@ class PresentationMediaItem(MediaManagerItem): Load the combobox with the enabled presentation controllers, allowing user to select a specific app if settings allow. """ - self.displayTypeComboBox.clear() + self.display_type_combo_box.clear() for item in self.controllers: # load the drop down selection if self.controllers[item].enabled(): - self.displayTypeComboBox.addItem(item) - if self.displayTypeComboBox.count() > 1: - self.displayTypeComboBox.insertItem(0, self.Automatic) - self.displayTypeComboBox.setCurrentIndex(0) + self.display_type_combo_box.addItem(item) + if self.display_type_combo_box.count() > 1: + self.display_type_combo_box.insertItem(0, self.Automatic) + self.display_type_combo_box.setCurrentIndex(0) if Settings().value(self.settings_section + u'/override app') == QtCore.Qt.Checked: self.presentation_widget.show() else: @@ -244,8 +244,8 @@ class PresentationMediaItem(MediaManagerItem): items = self.list_view.selectedItems() if len(items) > 1: return False - service_item.title = self.displayTypeComboBox.currentText() - service_item.shortname = self.displayTypeComboBox.currentText() + service_item.title = self.display_type_combo_box.currentText() + service_item.shortname = self.display_type_combo_box.currentText() service_item.add_capability(ItemCapabilities.ProvidesOwnDisplay) service_item.add_capability(ItemCapabilities.HasDetailedTitleDisplay) shortname = service_item.shortname diff --git a/openlp/plugins/songs/forms/editsongform.py b/openlp/plugins/songs/forms/editsongform.py index 49a20762a..fcc7f4f21 100644 --- a/openlp/plugins/songs/forms/editsongform.py +++ b/openlp/plugins/songs/forms/editsongform.py @@ -320,7 +320,7 @@ class EditSongForm(QtGui.QDialog, Ui_EditSongDialog): for plugin in self.plugin_manager.plugins: if plugin.name == u'media' and plugin.status == PluginStatus.Active: self.from_media_button.setVisible(True) - self.media_form.populateFiles(plugin.media_item.getList(MediaType.Audio)) + self.media_form.populateFiles(plugin.media_item.get_list(MediaType.Audio)) break def new_song(self): From a2fddbb57c65c42280bd67d9fa3c4947da287536 Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Fri, 19 Apr 2013 21:43:17 +0200 Subject: [PATCH 68/97] fixed fullstop --- openlp/plugins/images/forms/addgroupform.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/openlp/plugins/images/forms/addgroupform.py b/openlp/plugins/images/forms/addgroupform.py index f891969c6..4cdc6a73b 100644 --- a/openlp/plugins/images/forms/addgroupform.py +++ b/openlp/plugins/images/forms/addgroupform.py @@ -47,16 +47,16 @@ class AddGroupForm(QtGui.QDialog, Ui_AddGroupDialog): def exec_(self, clear=True, show_top_level_group=False, selected_group=None): """ - Show the form, + Show the form. ``clear`` - Set to False if the text input box should not be cleared when showing the dialog (default: True), + Set to False if the text input box should not be cleared when showing the dialog (default: True). ``show_top_level_group`` - Set to True when "-- Top level group --" should be showed as first item (default: False), + Set to True when "-- Top level group --" should be showed as first item (default: False). ``selected_group`` - The ID of the group that should be selected by default when showing the dialog, + The ID of the group that should be selected by default when showing the dialog. """ if clear: self.name_edit.clear() From 465fc7bff17f6f4cd1dcaa5d853f0588f6c71c27 Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Sat, 20 Apr 2013 11:02:45 +0200 Subject: [PATCH 69/97] do not overrie build-ins --- openlp/plugins/presentations/lib/impresscontroller.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/openlp/plugins/presentations/lib/impresscontroller.py b/openlp/plugins/presentations/lib/impresscontroller.py index e5df6685e..d30c71078 100644 --- a/openlp/plugins/presentations/lib/impresscontroller.py +++ b/openlp/plugins/presentations/lib/impresscontroller.py @@ -295,12 +295,12 @@ class ImpressDocument(PresentationDocument): """ log.debug(u'create property OpenOffice') if os.name == u'nt': - property = self.controller.manager.Bridge_GetStruct(u'com.sun.star.beans.PropertyValue') + property_object = self.controller.manager.Bridge_GetStruct(u'com.sun.star.beans.PropertyValue') else: - property = PropertyValue() - property.Name = name - property.Value = value - return property + property_object = PropertyValue() + property_object.Name = name + property_object.Value = value + return property_object def close_presentation(self): """ From f82000eaa25580b13181ded45170e90ea487f28b Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Sat, 20 Apr 2013 11:06:26 +0200 Subject: [PATCH 70/97] reverted change to avoid conflict --- openlp/plugins/presentations/presentationplugin.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/openlp/plugins/presentations/presentationplugin.py b/openlp/plugins/presentations/presentationplugin.py index 08f16fa12..1cb966aa5 100644 --- a/openlp/plugins/presentations/presentationplugin.py +++ b/openlp/plugins/presentations/presentationplugin.py @@ -44,12 +44,12 @@ log = logging.getLogger(__name__) __default_settings__ = { - u'presentations/override app': QtCore.Qt.Unchecked, - u'presentations/Impress': QtCore.Qt.Checked, - u'presentations/Powerpoint': QtCore.Qt.Checked, - u'presentations/Powerpoint Viewer': QtCore.Qt.Checked, - u'presentations/presentations files': [] -} + u'presentations/override app': QtCore.Qt.Unchecked, + u'presentations/Impress': QtCore.Qt.Checked, + u'presentations/Powerpoint': QtCore.Qt.Checked, + u'presentations/Powerpoint Viewer': QtCore.Qt.Checked, + u'presentations/presentations files': [] + } class PresentationPlugin(Plugin): From e486bac91c0082385e5466ae4b65168566fb045b Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Sat, 20 Apr 2013 19:36:18 +0200 Subject: [PATCH 71/97] removed entry from combo box --- openlp/plugins/bibles/forms/bibleimportform.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openlp/plugins/bibles/forms/bibleimportform.py b/openlp/plugins/bibles/forms/bibleimportform.py index 242dff707..f617ffecd 100644 --- a/openlp/plugins/bibles/forms/bibleimportform.py +++ b/openlp/plugins/bibles/forms/bibleimportform.py @@ -128,7 +128,7 @@ class BibleImportForm(OpenLPWizard): self.formatLabel = QtGui.QLabel(self.selectPage) self.formatLabel.setObjectName(u'FormatLabel') self.formatComboBox = QtGui.QComboBox(self.selectPage) - self.formatComboBox.addItems([u'', u'', u'', u'', u'']) + self.formatComboBox.addItems([u'', u'', u'', u'']) self.formatComboBox.setObjectName(u'FormatComboBox') self.formatLayout.addRow(self.formatLabel, self.formatComboBox) self.spacer = QtGui.QSpacerItem(10, 0, QtGui.QSizePolicy.Fixed, QtGui.QSizePolicy.Minimum) From 401d4d268875b78858114e2c9165149ad15a29f4 Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Sat, 20 Apr 2013 20:39:10 +0200 Subject: [PATCH 72/97] close file --- tests/functional/openlp_core_lib/test_serviceitem.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/tests/functional/openlp_core_lib/test_serviceitem.py b/tests/functional/openlp_core_lib/test_serviceitem.py index d50ddc978..26e9e7d44 100644 --- a/tests/functional/openlp_core_lib/test_serviceitem.py +++ b/tests/functional/openlp_core_lib/test_serviceitem.py @@ -276,5 +276,7 @@ class TestServiceItem(TestCase): first_line = items[0] except IOError: first_line = u'' + finally: + open_file.close() return first_line From 34180112be19d5fd4202a5558a6a0d79e8584617 Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Sun, 21 Apr 2013 08:06:25 +0100 Subject: [PATCH 73/97] Fix Core from abend --- openlp/core/utils/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openlp/core/utils/__init__.py b/openlp/core/utils/__init__.py index d4ee8039c..60393dfbb 100644 --- a/openlp/core/utils/__init__.py +++ b/openlp/core/utils/__init__.py @@ -185,7 +185,7 @@ def check_latest_version(current_version): version_string = current_version[u'full'] # set to prod in the distribution config file. settings = Settings() - settings.beginGroup(u'general') + settings.beginGroup(u'core') last_test = settings.value(u'last version test') this_test = unicode(datetime.now().date()) settings.setValue(u'last version test', this_test) From 02b1f7b78b72b333a665095e835fa82f920d6c4d Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Sun, 21 Apr 2013 08:21:29 +0100 Subject: [PATCH 74/97] and more --- openlp/core/ui/slidecontroller.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/openlp/core/ui/slidecontroller.py b/openlp/core/ui/slidecontroller.py index 35527e1e4..f219cea45 100644 --- a/openlp/core/ui/slidecontroller.py +++ b/openlp/core/ui/slidecontroller.py @@ -255,12 +255,12 @@ class SlideController(DisplayController): self.delay_spin_box.setToolTip(translate('OpenLP.SlideController', 'Delay between slides in seconds.')) self.toolbar.add_toolbar_widget(self.delay_spin_box) else: - self.toolbar.add_toolbar_action(u'goLive', icon=u':/general/general_live.png', + self.toolbar.add_toolbar_action(u'goLive', icon=u':/core/general_live.png', tooltip=translate('OpenLP.SlideController', 'Move to live.'), triggers=self.onGoLive) - self.toolbar.add_toolbar_action(u'addToService', icon=u':/general/general_add.png', + self.toolbar.add_toolbar_action(u'addToService', icon=u':/core/general_add.png', tooltip=translate('OpenLP.SlideController', 'Add to Service.'), triggers=self.onPreviewAddToService) self.toolbar.addSeparator() - self.toolbar.add_toolbar_action(u'editSong', icon=u':/general/general_edit.png', + self.toolbar.add_toolbar_action(u'editSong', icon=u':/core/general_edit.png', tooltip=translate('OpenLP.SlideController', 'Edit and reload song preview.'), triggers=self.onEditSong) self.controller_layout.addWidget(self.toolbar) # Build the Media Toolbar @@ -616,7 +616,7 @@ class SlideController(DisplayController): """ Adjusts the value of the ``delay_spin_box`` to the given one. """ - self.delay_spin_box.setValue(Settings().value(u'general/loop delay')) + self.delay_spin_box.setValue(Settings().value(u'core/loop delay')) def update_slide_limits(self): """ From 2965271adad4106e0c8ada632c77d4b3d8e5bc13 Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Sun, 21 Apr 2013 08:26:45 +0100 Subject: [PATCH 75/97] and more --- openlp/core/ui/slidecontroller.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/openlp/core/ui/slidecontroller.py b/openlp/core/ui/slidecontroller.py index f219cea45..349ad96df 100644 --- a/openlp/core/ui/slidecontroller.py +++ b/openlp/core/ui/slidecontroller.py @@ -255,12 +255,12 @@ class SlideController(DisplayController): self.delay_spin_box.setToolTip(translate('OpenLP.SlideController', 'Delay between slides in seconds.')) self.toolbar.add_toolbar_widget(self.delay_spin_box) else: - self.toolbar.add_toolbar_action(u'goLive', icon=u':/core/general_live.png', + self.toolbar.add_toolbar_action(u'goLive', icon=u':/general/general_live.png', tooltip=translate('OpenLP.SlideController', 'Move to live.'), triggers=self.onGoLive) - self.toolbar.add_toolbar_action(u'addToService', icon=u':/core/general_add.png', + self.toolbar.add_toolbar_action(u'addToService', icon=u':/general/general_add.png', tooltip=translate('OpenLP.SlideController', 'Add to Service.'), triggers=self.onPreviewAddToService) self.toolbar.addSeparator() - self.toolbar.add_toolbar_action(u'editSong', icon=u':/core/general_edit.png', + 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) self.controller_layout.addWidget(self.toolbar) # Build the Media Toolbar From 581c83e70ddb9c7e4531cc2442cc9d134fec18e4 Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Sun, 21 Apr 2013 16:53:51 +0100 Subject: [PATCH 76/97] Final tidyups --- openlp/core/lib/mediamanageritem.py | 8 ++-- openlp/core/ui/servicemanager.py | 17 ++------- openlp/plugins/custom/lib/mediaitem.py | 7 ++-- openlp/plugins/songs/lib/mediaitem.py | 53 ++++++++++++++++---------- 4 files changed, 44 insertions(+), 41 deletions(-) diff --git a/openlp/core/lib/mediamanageritem.py b/openlp/core/lib/mediamanageritem.py index 01329b842..331a9033a 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/ui/servicemanager.py b/openlp/core/ui/servicemanager.py index f12d55207..5674554e2 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. diff --git a/openlp/plugins/custom/lib/mediaitem.py b/openlp/plugins/custom/lib/mediaitem.py index 071f68839..657e138df 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. @@ -216,7 +217,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') @@ -255,7 +255,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) @@ -284,8 +285,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 onClearTextButtonClick(self): """ diff --git a/openlp/plugins/songs/lib/mediaitem.py b/openlp/plugins/songs/lib/mediaitem.py index 1565169e2..82ec1086c 100644 --- a/openlp/plugins/songs/lib/mediaitem.py +++ b/openlp/plugins/songs/lib/mediaitem.py @@ -160,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') @@ -463,16 +462,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. @@ -481,6 +471,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. @@ -499,9 +513,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'] @@ -514,7 +527,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: @@ -524,7 +537,7 @@ class SongMediaItem(MediaManagerItem): # If there's any backing tracks, copy them over. if item.background_audio: self._updateBackgroundAudio(song, item) - editId = song.id + edit_id = song.id self.on_search_text_button_clicked() elif add_song and not self.addSongFromService: # Make sure we temporary import formatting tags. @@ -532,11 +545,11 @@ class SongMediaItem(MediaManagerItem): # If there's any backing tracks, copy them over. if item.background_audio: self._updateBackgroundAudio(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): """ From fba86c5552749c09f3b483f6011908ed946db597 Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Tue, 23 Apr 2013 20:08:07 +0100 Subject: [PATCH 77/97] Add tests --- openlp/plugins/songs/forms/__init__.py | 1 + openlp/plugins/songs/lib/mediaitem.py | 9 +- openlp/plugins/songs/songsplugin.py | 3 +- .../functional/openlp_core_lib/test_screen.py | 2 +- .../openlp_plugins/songs/test_mediaitem.py | 125 ++++++++++++++++++ 5 files changed, 134 insertions(+), 6 deletions(-) create mode 100644 tests/functional/openlp_plugins/songs/test_mediaitem.py diff --git a/openlp/plugins/songs/forms/__init__.py b/openlp/plugins/songs/forms/__init__.py index a1c177a9d..d6aef47dc 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 \ No newline at end of file diff --git a/openlp/plugins/songs/lib/mediaitem.py b/openlp/plugins/songs/lib/mediaitem.py index 82ec1086c..f1ae52d07 100644 --- a/openlp/plugins/songs/lib/mediaitem.py +++ b/openlp/plugins/songs/lib/mediaitem.py @@ -72,10 +72,7 @@ class SongMediaItem(MediaManagerItem): def __init__(self, parent, plugin): self.icon_path = u'songs/song' MediaManagerItem.__init__(self, parent, plugin) - self.editSongForm = EditSongForm(self, self.main_window, self.plugin.manager) - self.openLyrics = OpenLyrics(self.plugin.manager) self.single_service_item = False - self.songMaintenanceForm = SongMaintenanceForm(self.plugin.manager, self) # Holds information about whether the edit is remotely triggered and # which Song is required. self.remoteSong = -1 @@ -135,6 +132,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.songMaintenanceForm = SongMaintenanceForm(self.plugin.manager, self) + self.editSongForm = 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'), diff --git a/openlp/plugins/songs/songsplugin.py b/openlp/plugins/songs/songsplugin.py index 65056ee5b..4355bc7e5 100644 --- a/openlp/plugins/songs/songsplugin.py +++ b/openlp/plugins/songs/songsplugin.py @@ -235,8 +235,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) 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_plugins/songs/test_mediaitem.py b/tests/functional/openlp_plugins/songs/test_mediaitem.py new file mode 100644 index 000000000..5f5c161eb --- /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()) + + 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: + 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') \ No newline at end of file From 0ef65fb8d2f9e2a758de47574b7b47f14d10a080 Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Tue, 23 Apr 2013 20:17:25 +0100 Subject: [PATCH 78/97] minor fixes --- openlp/plugins/songs/forms/__init__.py | 2 +- tests/functional/openlp_plugins/songs/test_mediaitem.py | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/openlp/plugins/songs/forms/__init__.py b/openlp/plugins/songs/forms/__init__.py index d6aef47dc..588f359f6 100644 --- a/openlp/plugins/songs/forms/__init__.py +++ b/openlp/plugins/songs/forms/__init__.py @@ -52,4 +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 \ No newline at end of file +from editsongform import EditSongForm diff --git a/tests/functional/openlp_plugins/songs/test_mediaitem.py b/tests/functional/openlp_plugins/songs/test_mediaitem.py index 5f5c161eb..a0f81bde8 100644 --- a/tests/functional/openlp_plugins/songs/test_mediaitem.py +++ b/tests/functional/openlp_plugins/songs/test_mediaitem.py @@ -26,7 +26,7 @@ class TestMediaItem(TestCase): Registry().register(u'service_list', MagicMock()) with patch('openlp.core.lib.mediamanageritem.MediaManagerItem.__init__'), \ - patch('openlp.plugins.songs.forms.editsongform.EditSongForm.__init__') : + patch('openlp.plugins.songs.forms.editsongform.EditSongForm.__init__'): self.media_item = SongMediaItem(MagicMock(), MagicMock()) fd, self.ini_file = mkstemp(u'.ini') @@ -42,7 +42,7 @@ class TestMediaItem(TestCase): try: os.unlink(self.ini_file) os.unlink(Settings().fileName()) - except: + except Exception: pass def build_song_footer_one_author_test(self): @@ -122,4 +122,4 @@ class TestMediaItem(TestCase): # 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') \ No newline at end of file + u'The array should be returned correctly with a song, an author, copyright and amended ccli') From d3195dccf7294eda0808ddbcc05f5ce8a5c82e85 Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Tue, 23 Apr 2013 21:31:19 +0100 Subject: [PATCH 79/97] Swap round urls --- openlp/plugins/remotes/html/openlp.js | 2 +- openlp/plugins/remotes/html/stage.js | 6 +++--- openlp/plugins/remotes/lib/httpserver.py | 6 +++--- 3 files changed, 7 insertions(+), 7 deletions(-) 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..eedc30102 100644 --- a/openlp/plugins/remotes/lib/httpserver.py +++ b/openlp/plugins/remotes/lib/httpserver.py @@ -267,11 +267,11 @@ class HttpRouter(object): (u'^/(stage)$', 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'^/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), From 22541e729785ed93d15115404ae6b0c194d5edcf Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Wed, 24 Apr 2013 21:05:34 +0200 Subject: [PATCH 80/97] use true division (py3) --- openlp/core/lib/__init__.py | 9 +++++---- openlp/core/lib/dockwidget.py | 3 ++- openlp/core/lib/htmlbuilder.py | 4 ++-- openlp/core/lib/renderer.py | 12 ++++++------ openlp/core/lib/screen.py | 5 +++-- openlp/core/lib/searchedit.py | 6 +++--- openlp/core/ui/maindisplay.py | 7 ++++--- openlp/core/ui/themestab.py | 4 +++- 8 files changed, 28 insertions(+), 22 deletions(-) diff --git a/openlp/core/lib/__init__.py b/openlp/core/lib/__init__.py index 155c10141..14d67e914 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 @@ -207,7 +208,7 @@ def create_thumb(image_path, thumb_path, return_icon=True, size=None): 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 +261,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 +283,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/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/ui/maindisplay.py b/openlp/core/ui/maindisplay.py index 2504520c0..02ae469d6 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: 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) From 9d54944ad43643e6826e2712ead113a2fccef864 Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Wed, 24 Apr 2013 22:47:30 +0200 Subject: [PATCH 81/97] use true division (py3) --- openlp/core/lib/settingstab.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) 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) From d7eb6b20c3452ebe0d041639d2d602632f770467 Mon Sep 17 00:00:00 2001 From: Patrick Zimmermann Date: Thu, 25 Apr 2013 19:58:37 +0200 Subject: [PATCH 82/97] Correct the naming of the preWizard -> pre_wizard. --- openlp/plugins/bibles/forms/bibleimportform.py | 2 +- openlp/plugins/bibles/forms/bibleupgradeform.py | 4 ++-- openlp/plugins/songs/forms/songexportform.py | 2 +- openlp/plugins/songs/forms/songimportform.py | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) 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/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 """ From 2d22e8420a4f08f21de84d9884f066c274a182a1 Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Sun, 28 Apr 2013 19:17:45 +0200 Subject: [PATCH 83/97] do not pass QImages to build_icon (if not needed) --- openlp/core/lib/__init__.py | 2 +- openlp/core/ui/servicemanager.py | 4 ++-- openlp/plugins/alerts/forms/alertdialog.py | 6 +++--- openlp/plugins/media/lib/mediaitem.py | 8 ++++---- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/openlp/core/lib/__init__.py b/openlp/core/lib/__init__.py index 155c10141..9a367c9b5 100644 --- a/openlp/core/lib/__init__.py +++ b/openlp/core/lib/__init__.py @@ -155,7 +155,7 @@ def build_icon(icon): ``icon`` The icon to build. This can be a QIcon, a resource string in the form ``:/resource/file.png``, or a file - location like ``/path/to/file.png``. + location like ``/path/to/file.png``. However, the **recommended** way is to specify a resource string. """ button_icon = QtGui.QIcon() if isinstance(icon, QtGui.QIcon): diff --git a/openlp/core/ui/servicemanager.py b/openlp/core/ui/servicemanager.py index 43280aef8..1929f444c 100644 --- a/openlp/core/ui/servicemanager.py +++ b/openlp/core/ui/servicemanager.py @@ -295,8 +295,8 @@ class ServiceManager(QtGui.QWidget, ServiceManagerDialog): Sets up the service manager, toolbars, list view, et al. """ QtGui.QWidget.__init__(self, parent) - self.active = build_icon(QtGui.QImage(u':/media/auto-start_active.png')) - self.inactive = build_icon(QtGui.QImage(u':/media/auto-start_inactive.png')) + self.active = build_icon(u':/media/auto-start_active.png') + self.inactive = build_icon(u':/media/auto-start_inactive.png') Registry().register(u'service_manager', self) self.service_items = [] self.suffixes = [] diff --git a/openlp/plugins/alerts/forms/alertdialog.py b/openlp/plugins/alerts/forms/alertdialog.py index e8a50d183..db2579298 100644 --- a/openlp/plugins/alerts/forms/alertdialog.py +++ b/openlp/plugins/alerts/forms/alertdialog.py @@ -75,9 +75,9 @@ class Ui_AlertDialog(object): self.manage_button_layout.addWidget(self.delete_button) self.manage_button_layout.addStretch() self.alert_dialog_layout.addLayout(self.manage_button_layout, 1, 1) - displayIcon = build_icon(u':/general/general_live.png') - self.display_button = create_button(alert_dialog, u'display_button', icon=displayIcon, enabled=False) - self.display_close_button = create_button(alert_dialog, u'display_close_button', icon=displayIcon, + display_icon = build_icon(u':/general/general_live.png') + self.display_button = create_button(alert_dialog, u'display_button', icon=display_icon, enabled=False) + self.display_close_button = create_button(alert_dialog, u'display_close_button', icon=display_icon, enabled=False) self.button_box = create_button_box(alert_dialog, u'button_box', [u'close'], [self.display_button, self.display_close_button]) diff --git a/openlp/plugins/media/lib/mediaitem.py b/openlp/plugins/media/lib/mediaitem.py index 2037346ad..243fcd158 100644 --- a/openlp/plugins/media/lib/mediaitem.py +++ b/openlp/plugins/media/lib/mediaitem.py @@ -44,10 +44,10 @@ log = logging.getLogger(__name__) CLAPPERBOARD = u':/media/slidecontroller_multimedia.png' -VIDEO_ICON = build_icon(QtGui.QImage(u':/media/media_video.png')) -AUDIO_ICON = build_icon(QtGui.QImage(u':/media/media_audio.png')) -DVD_ICON = build_icon(QtGui.QImage(u':/media/media_video.png')) -ERROR_ICON = build_icon(QtGui.QImage(u':/general/general_delete.png')) +VIDEO_ICON = build_icon(u':/media/media_video.png') +AUDIO_ICON = build_icon(u':/media/media_audio.png') +DVD_ICON = build_icon(u':/media/media_video.png') +ERROR_ICON = build_icon(u':/general/general_delete.png') class MediaMediaItem(MediaManagerItem): From 75c8382188a0ff39d1ac516d4d14b0df256ec3c6 Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Sun, 12 May 2013 14:02:48 +0200 Subject: [PATCH 84/97] added test --- tests/functional/openlp_core_lib/test_settings.py | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/tests/functional/openlp_core_lib/test_settings.py b/tests/functional/openlp_core_lib/test_settings.py index 786a884a0..754d82256 100644 --- a/tests/functional/openlp_core_lib/test_settings.py +++ b/tests/functional/openlp_core_lib/test_settings.py @@ -30,6 +30,19 @@ class TestSettings(TestCase): os.unlink(self.ini_file) os.unlink(Settings().fileName()) + def extend_default_settings_test(self): + """ + Test the static extend_default_settings() method. + """ + with self.assertRaises(KeyError) as context: + Settings().value(u'core/does not exist') + self.assertEqual(context.exception[0], u'core/does not exist') + + Settings.extend_default_settings({u'core/does exist': True}) + value = Settings().value(u'core/does exist') + assert value and isinstance(value, bool) + + def settings_basic_test(self): """ Test the Settings creation and its default usage From d03a9a8eeca21eae468a177b6c5339bf9f780c56 Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Sun, 12 May 2013 14:04:15 +0200 Subject: [PATCH 85/97] added comments --- tests/functional/openlp_core_lib/test_settings.py | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/tests/functional/openlp_core_lib/test_settings.py b/tests/functional/openlp_core_lib/test_settings.py index 754d82256..714ee6fb5 100644 --- a/tests/functional/openlp_core_lib/test_settings.py +++ b/tests/functional/openlp_core_lib/test_settings.py @@ -32,14 +32,24 @@ class TestSettings(TestCase): def extend_default_settings_test(self): """ - Test the static extend_default_settings() method. + Test the static extend_default_settings() method """ + # GIVEN: + + # WHEN: Try to access not existing setting. with self.assertRaises(KeyError) as context: Settings().value(u'core/does not exist') + + # THEN: An exception should be raised. self.assertEqual(context.exception[0], u'core/does not exist') + # GIVEN: Extended setting. Settings.extend_default_settings({u'core/does exist': True}) + + # WHEN: Try to access it. value = Settings().value(u'core/does exist') + + # THEN: The correct value should be returned. assert value and isinstance(value, bool) From d323f9d746adb00b179092b65d2f3bd886cd2477 Mon Sep 17 00:00:00 2001 From: Arjan Schrijver Date: Tue, 14 May 2013 15:58:07 +0200 Subject: [PATCH 86/97] Reverted 'adding multiple service items' functionality --- openlp/plugins/images/lib/mediaitem.py | 119 +++++++++++-------------- 1 file changed, 53 insertions(+), 66 deletions(-) diff --git a/openlp/plugins/images/lib/mediaitem.py b/openlp/plugins/images/lib/mediaitem.py index e8a81d886..dc2aa3660 100644 --- a/openlp/plugins/images/lib/mediaitem.py +++ b/openlp/plugins/images/lib/mediaitem.py @@ -32,7 +32,7 @@ import os from PyQt4 import QtCore, QtGui -from openlp.core.lib import ItemCapabilities, MediaManagerItem, Registry, ServiceItem, ServiceItemContext, Settings, \ +from openlp.core.lib import ItemCapabilities, MediaManagerItem, Registry, ServiceItemContext, Settings, \ StringContent, TreeWidgetWithDnD, UiStrings, build_icon, check_directory_exists, check_item_selected, \ create_thumb, translate, validate_thumb from openlp.core.lib.ui import create_widget_action, critical_error_message_box @@ -538,76 +538,63 @@ class ImageMediaItem(MediaManagerItem): """ background = QtGui.QColor(Settings().value(self.settings_section + u'/background color')) if item: - new_items = [item] + items = [item] else: - new_items = self.list_view.selectedItems() - if not new_items: + items = self.list_view.selectedItems() + if not items: return False - for bitem in new_items: - new_service_item = ServiceItem(self.plugin) - new_service_item.add_icon(self.plugin.icon_path) - # Determine service item title - if isinstance(bitem.data(0, QtCore.Qt.UserRole), ImageGroups): - new_service_item.title = bitem.text(0) - else: - new_service_item.title = unicode(self.plugin.name_strings[u'plural']) - new_service_item.add_capability(ItemCapabilities.CanMaintain) - new_service_item.add_capability(ItemCapabilities.CanPreview) - new_service_item.add_capability(ItemCapabilities.CanLoop) - new_service_item.add_capability(ItemCapabilities.CanAppend) - # force a nonexistent theme - new_service_item.theme = -1 - sub_images = [] - missing_items = [] - missing_items_filenames = [] - # Expand groups to images + # Determine service item title + if isinstance(items[0].data(0, QtCore.Qt.UserRole), ImageGroups): + service_item.title = items[0].text(0) + else: + service_item.title = unicode(self.plugin.name_strings[u'plural']) + service_item.add_capability(ItemCapabilities.CanMaintain) + service_item.add_capability(ItemCapabilities.CanPreview) + service_item.add_capability(ItemCapabilities.CanLoop) + service_item.add_capability(ItemCapabilities.CanAppend) + # force a nonexistent theme + service_item.theme = -1 + missing_items = [] + missing_items_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): - sub_images.append(bitem.child(index)) - if isinstance(bitem.data(0, QtCore.Qt.UserRole), ImageFilenames): - sub_images.append(bitem) - # Don't try to display empty groups - if not sub_images: - return False - # Find missing files - for bitem in sub_images: - filename = bitem.data(0, QtCore.Qt.UserRole).filename - if not os.path.exists(filename): - missing_items.append(bitem) - missing_items_filenames.append(filename) - for item in missing_items: - sub_images.remove(item) - # We cannot continue, as all images do not exist. - if not sub_images: - if not remote: - critical_error_message_box( - translate('ImagePlugin.MediaItem', 'Missing Image(s)'), - translate('ImagePlugin.MediaItem', 'The following image(s) no longer exist: %s') % - 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, - 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 sub_image in sub_images: - filename = sub_image.data(0, QtCore.Qt.UserRole).filename - name = os.path.split(filename)[1] - new_service_item.add_from_image(filename, name, background) - # Add the service item to the correct controller - if context == ServiceItemContext.Service: - self.service_manager.add_service_item(new_service_item) - elif context == ServiceItemContext.Preview: - self.preview_controller.add_service_item(new_service_item) - elif context == ServiceItemContext.Live: - self.live_controller.add_service_item(new_service_item) - # Return False because we added the service item ourselves - return False + items.append(bitem.child(index)) + items.remove(bitem) + # Don't try to display empty groups + if not items: + return False + # Find missing files + for bitem in items: + filename = bitem.data(0, QtCore.Qt.UserRole).filename + 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 remote: + critical_error_message_box( + translate('ImagePlugin.MediaItem', 'Missing Image(s)'), + translate('ImagePlugin.MediaItem', 'The following image(s) no longer exist: %s') % + 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, + 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 + name = os.path.split(filename)[1] + service_item.add_from_image(filename, name, background) + return True def check_group_exists(self, new_group): """ From 71335357dd8a3178b1873af4a7a5064171dc9fbc Mon Sep 17 00:00:00 2001 From: Arjan Schrijver Date: Tue, 14 May 2013 16:17:56 +0200 Subject: [PATCH 87/97] - Fixed traceback on adding multiple image groups to the service in one go --- openlp/plugins/images/lib/mediaitem.py | 20 +++++++------------- 1 file changed, 7 insertions(+), 13 deletions(-) diff --git a/openlp/plugins/images/lib/mediaitem.py b/openlp/plugins/images/lib/mediaitem.py index dc2aa3660..cb4656539 100644 --- a/openlp/plugins/images/lib/mediaitem.py +++ b/openlp/plugins/images/lib/mediaitem.py @@ -554,28 +554,23 @@ 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) # 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)'), @@ -583,15 +578,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 From 673a87a65d14042632d5c7f6ea8802a4f8a0ff24 Mon Sep 17 00:00:00 2001 From: Arjan Schrijver Date: Tue, 14 May 2013 16:48:49 +0200 Subject: [PATCH 88/97] - Fixed a bug where new image groups added from the 'choose group' popup weren't added to the 'add group' and 'choose group' popup selectboxes --- openlp/plugins/images/lib/mediaitem.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/openlp/plugins/images/lib/mediaitem.py b/openlp/plugins/images/lib/mediaitem.py index cb4656539..8a564fa2c 100644 --- a/openlp/plugins/images/lib/mediaitem.py +++ b/openlp/plugins/images/lib/mediaitem.py @@ -440,6 +440,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): From 6572ab31e818e254843c68b11baf866c97e833c2 Mon Sep 17 00:00:00 2001 From: Arjan Schrijver Date: Tue, 14 May 2013 17:05:41 +0200 Subject: [PATCH 89/97] - Fixed adding single images again --- openlp/plugins/images/lib/mediaitem.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/openlp/plugins/images/lib/mediaitem.py b/openlp/plugins/images/lib/mediaitem.py index 328ba462a..deed14594 100644 --- a/openlp/plugins/images/lib/mediaitem.py +++ b/openlp/plugins/images/lib/mediaitem.py @@ -561,6 +561,8 @@ class ImageMediaItem(MediaManagerItem): for index in range(0, bitem.childCount()): if isinstance(bitem.child(index).data(0, QtCore.Qt.UserRole), ImageFilenames): 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 images_filenames: return False From 7a42cd3769ac06eb55cf956ccb34cb795f84b703 Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Sat, 18 May 2013 10:44:03 +0200 Subject: [PATCH 90/97] added test --- openlp/core/lib/__init__.py | 3 +- tests/functional/openlp_core_lib/test_lib.py | 61 ++++++++++++++++---- 2 files changed, 53 insertions(+), 11 deletions(-) diff --git a/openlp/core/lib/__init__.py b/openlp/core/lib/__init__.py index 911ba4703..d6c338271 100644 --- a/openlp/core/lib/__init__.py +++ b/openlp/core/lib/__init__.py @@ -203,7 +203,8 @@ 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) 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. From 6e66edce03060b6c2f5823c7fdea3577b5c78229 Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Sat, 18 May 2013 10:49:21 +0200 Subject: [PATCH 91/97] removed test --- .../openlp_core_lib/test_settings.py | 23 ------------------- 1 file changed, 23 deletions(-) diff --git a/tests/functional/openlp_core_lib/test_settings.py b/tests/functional/openlp_core_lib/test_settings.py index 714ee6fb5..786a884a0 100644 --- a/tests/functional/openlp_core_lib/test_settings.py +++ b/tests/functional/openlp_core_lib/test_settings.py @@ -30,29 +30,6 @@ class TestSettings(TestCase): os.unlink(self.ini_file) os.unlink(Settings().fileName()) - def extend_default_settings_test(self): - """ - Test the static extend_default_settings() method - """ - # GIVEN: - - # WHEN: Try to access not existing setting. - with self.assertRaises(KeyError) as context: - Settings().value(u'core/does not exist') - - # THEN: An exception should be raised. - self.assertEqual(context.exception[0], u'core/does not exist') - - # GIVEN: Extended setting. - Settings.extend_default_settings({u'core/does exist': True}) - - # WHEN: Try to access it. - value = Settings().value(u'core/does exist') - - # THEN: The correct value should be returned. - assert value and isinstance(value, bool) - - def settings_basic_test(self): """ Test the Settings creation and its default usage From 255ed90d972d2565abe929be8f9913c2a1d34f0c Mon Sep 17 00:00:00 2001 From: Arjan Schrijver Date: Sun, 19 May 2013 13:31:02 +0200 Subject: [PATCH 92/97] Change helper method to private --- tests/functional/openlp_plugins/images/test_lib.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tests/functional/openlp_plugins/images/test_lib.py b/tests/functional/openlp_plugins/images/test_lib.py index 2e9432eaf..0aecc0a7f 100644 --- a/tests/functional/openlp_plugins/images/test_lib.py +++ b/tests/functional/openlp_plugins/images/test_lib.py @@ -126,7 +126,7 @@ class TestImageMediaItem(TestCase): 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): + def _recursively_delete_group_side_effect(*args, **kwargs): """ Side effect method that creates custom retun values for the recursively_delete_group method """ @@ -160,7 +160,7 @@ class TestImageMediaItem(TestCase): 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.manager.get_all_objects.side_effect = self._recursively_delete_group_side_effect self.media_item.servicePath = "" test_group = ImageGroups() test_group.id = 1 From f22254501aa0f975cdf65530614e57e247ecc529 Mon Sep 17 00:00:00 2001 From: Arjan Schrijver Date: Thu, 23 May 2013 09:31:12 +0200 Subject: [PATCH 93/97] Reverted another change from the 'adding multiple service items' functionality --- openlp/core/lib/mediamanageritem.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openlp/core/lib/mediamanageritem.py b/openlp/core/lib/mediamanageritem.py index 2fde4a821..c3e1fa366 100644 --- a/openlp/core/lib/mediamanageritem.py +++ b/openlp/core/lib/mediamanageritem.py @@ -466,7 +466,7 @@ class MediaManagerItem(QtGui.QWidget): translate('OpenLP.MediaManagerItem', 'You must select one or more items to preview.')) else: log.debug(u'%s Preview requested', self.plugin.name) - service_item = self.build_service_item(context=ServiceItemContext.Preview) + service_item = self.build_service_item() if service_item: service_item.from_plugin = True self.preview_controller.add_service_item(service_item) From 3961db8b67822df688dd8732b08e6f2221b9afc6 Mon Sep 17 00:00:00 2001 From: "Peter S. Bentley" Date: Thu, 23 May 2013 17:15:15 +0100 Subject: [PATCH 94/97] Fix invalid object names --- openlp/plugins/songs/lib/mediaitem.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/openlp/plugins/songs/lib/mediaitem.py b/openlp/plugins/songs/lib/mediaitem.py index 5d0bc086c..b60c0b162 100644 --- a/openlp/plugins/songs/lib/mediaitem.py +++ b/openlp/plugins/songs/lib/mediaitem.py @@ -132,8 +132,8 @@ class SongMediaItem(MediaManagerItem): """ Initialise variables when they cannot be initialised in the constructor. """ - self.songMaintenanceForm = SongMaintenanceForm(self.plugin.manager, self) - self.editSongForm = EditSongForm(self, self.main_window, self.plugin.manager) + 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', From 4b2868b27173df83c9a0edc48f3070714e09598e Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Fri, 24 May 2013 21:17:47 +0100 Subject: [PATCH 95/97] Fox presentations and refactor service item --- openlp/core/lib/serviceitem.py | 35 ++++++++++--------- openlp/core/ui/media/mediacontroller.py | 4 +-- openlp/plugins/media/lib/mediaitem.py | 11 +++--- openlp/plugins/presentations/lib/mediaitem.py | 18 +++++----- .../presentations/lib/messagelistener.py | 3 +- .../lib/presentationcontroller.py | 5 +-- .../presentations/presentationplugin.py | 2 +- 7 files changed, 39 insertions(+), 39 deletions(-) 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/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/plugins/media/lib/mediaitem.py b/openlp/plugins/media/lib/mediaitem.py index 243fcd158..2f07110fe 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 @@ -208,6 +207,7 @@ class MediaMediaItem(MediaManagerItem): self.list_view.setIconSize(QtCore.QSize(88, 50)) self.servicePath = os.path.join(AppLocation.get_section_data_path(self.settings_section), u'thumbnails') check_directory_exists(self.servicePath) + print self.settings_section + u'/media files' self.load_list(Settings().value(self.settings_section + u'/media files')) self.populateDisplayTypes() @@ -260,8 +260,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): From 6dd070f60ecca6356593a4412463535fdb18e1a3 Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Sat, 25 May 2013 06:48:08 +0100 Subject: [PATCH 96/97] Add migration test --- .../openlp_core_lib/test_serviceitem.py | 21 +++- tests/resources/migrate_video_20_22.osd | 98 +++++++++++++++++++ 2 files changed, 118 insertions(+), 1 deletion(-) create mode 100644 tests/resources/migrate_video_20_22.osd diff --git a/tests/functional/openlp_core_lib/test_serviceitem.py b/tests/functional/openlp_core_lib/test_serviceitem.py index 26e9e7d44..e051f8c76 100644 --- a/tests/functional/openlp_core_lib/test_serviceitem.py +++ b/tests/functional/openlp_core_lib/test_serviceitem.py @@ -210,7 +210,6 @@ class TestServiceItem(TestCase): # 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' @@ -268,6 +267,26 @@ 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 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' + def convert_file_service_item(self, name): service_file = os.path.join(TEST_PATH, name) try: 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 From 0a8db629d9ecb7f50ca7df07af4694817354ae74 Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Sat, 25 May 2013 06:54:25 +0100 Subject: [PATCH 97/97] Remove Print --- openlp/plugins/media/lib/mediaitem.py | 1 - 1 file changed, 1 deletion(-) diff --git a/openlp/plugins/media/lib/mediaitem.py b/openlp/plugins/media/lib/mediaitem.py index 2f07110fe..30748a225 100644 --- a/openlp/plugins/media/lib/mediaitem.py +++ b/openlp/plugins/media/lib/mediaitem.py @@ -207,7 +207,6 @@ class MediaMediaItem(MediaManagerItem): self.list_view.setIconSize(QtCore.QSize(88, 50)) self.servicePath = os.path.join(AppLocation.get_section_data_path(self.settings_section), u'thumbnails') check_directory_exists(self.servicePath) - print self.settings_section + u'/media files' self.load_list(Settings().value(self.settings_section + u'/media files')) self.populateDisplayTypes()