From 27bccda0b61adfb4d3c83e97831dc391dca20b07 Mon Sep 17 00:00:00 2001 From: Jonathan Corwin Date: Sat, 10 Jul 2010 23:21:14 +0100 Subject: [PATCH 1/6] Presentation thumbnail changes --- openlp/core/lib/__init__.py | 2 + openlp/core/lib/mediamanageritem.py | 9 +- .../presentations/lib/impresscontroller.py | 72 +++++++++-- openlp/plugins/presentations/lib/mediaitem.py | 114 +++++++++++------- .../presentations/lib/messagelistener.py | 63 +++++++++- .../presentations/lib/powerpointcontroller.py | 31 +++-- .../presentations/lib/pptviewcontroller.py | 44 ++++--- .../lib/presentationcontroller.py | 88 +++++++++----- .../presentations/lib/presentationtab.py | 15 +++ .../presentations/presentationplugin.py | 25 +++- 10 files changed, 350 insertions(+), 113 deletions(-) diff --git a/openlp/core/lib/__init__.py b/openlp/core/lib/__init__.py index 4718e289e..7659a2889 100644 --- a/openlp/core/lib/__init__.py +++ b/openlp/core/lib/__init__.py @@ -174,6 +174,8 @@ def resize_image(image, width, height): """ preview = QtGui.QImage(image) if not preview.isNull(): + if(preview.width() == width and preview.height == height): + return preview preview = preview.scaled(width, height, QtCore.Qt.KeepAspectRatio, QtCore.Qt.SmoothTransformation) realw = preview.width() diff --git a/openlp/core/lib/mediamanageritem.py b/openlp/core/lib/mediamanageritem.py index 8ebfe88ae..9fc2c91f6 100644 --- a/openlp/core/lib/mediamanageritem.py +++ b/openlp/core/lib/mediamanageritem.py @@ -383,14 +383,17 @@ class MediaManagerItem(QtGui.QWidget): """ Validates to see if the file still exists or thumbnail is up to date """ - if os.path.exists(file): + if not os.path.exists(file): + return False + if os.path.exists(thumb): filedate = os.stat(file).st_mtime thumbdate = os.stat(thumb).st_mtime #if file updated rebuild icon if filedate > thumbdate: self.IconFromFile(file, thumb) - return True - return False + else: + self.IconFromFile(file, thumb) + return True def IconFromFile(self, file, thumb): """ diff --git a/openlp/plugins/presentations/lib/impresscontroller.py b/openlp/plugins/presentations/lib/impresscontroller.py index 8dc4861aa..79c724f6a 100644 --- a/openlp/plugins/presentations/lib/impresscontroller.py +++ b/openlp/plugins/presentations/lib/impresscontroller.py @@ -104,6 +104,10 @@ class ImpressController(PresentationController): self.process.waitForStarted() def get_uno_desktop(self): + """ + On non-Windows platforms, use Uno. Get the OpenOffice desktop + which will be used to manage impress + """ log.debug(u'get UNO Desktop Openoffice') ctx = None loop = 0 @@ -134,10 +138,17 @@ class ImpressController(PresentationController): return None def get_com_desktop(self): + """ + On Windows platforms, use COM. Return the desktop object which + will be used to manage Impress + """ log.debug(u'get COM Desktop OpenOffice') return self.manager.createInstance(u'com.sun.star.frame.Desktop') def get_com_servicemanager(self): + """ + Return the OOo service manager for windows + """ log.debug(u'get_com_servicemanager openoffice') try: return Dispatch(u'com.sun.star.ServiceManager') @@ -171,13 +182,23 @@ class ImpressController(PresentationController): log.exception(u'Failed to terminate OpenOffice') def add_doc(self, name): + """ + Called when a new Impress document is opened + """ log.debug(u'Add Doc OpenOffice') doc = ImpressDocument(self, name) self.docs.append(doc) return doc class ImpressDocument(PresentationDocument): + """ + Class which holds information and controls a single presentation + """ + def __init__(self, controller, presentation): + """ + Constructor, store information about the file and initialise + """ log.debug(u'Init Presentation OpenOffice') PresentationDocument.__init__(self, controller, presentation) self.document = None @@ -208,9 +229,8 @@ class ImpressDocument(PresentationDocument): desktop = self.controller.get_uno_desktop() url = uno.systemPathToFileUrl(self.filepath) if desktop is None: - return + return False self.desktop = desktop - #print "s.dsk2 ", self.desktop properties = [] properties.append(self.create_property(u'Minimized', True)) properties = tuple(properties) @@ -219,12 +239,13 @@ class ImpressDocument(PresentationDocument): 0, properties) except: log.exception(u'Failed to load presentation') - return + return False self.presentation = self.document.getPresentation() self.presentation.Display = \ self.controller.plugin.renderManager.screens.current_display + 1 self.control = None self.create_thumbnails() + return True def create_thumbnails(self): """ @@ -234,10 +255,10 @@ class ImpressDocument(PresentationDocument): if self.check_thumbnails(): return if os.name == u'nt': - thumbdir = u'file:///' + self.thumbnailpath.replace( + thumbdirurl = u'file:///' + self.get_temp_folder().replace( u'\\', u'/').replace(u':', u'|').replace(u' ', u'%20') else: - thumbdir = uno.systemPathToFileUrl(self.thumbnailpath) + thumbdirurl = uno.systemPathToFileUrl(self.get_temp_folder()) props = [] props.append(self.create_property(u'FilterName', u'impress_png_Export')) props = tuple(props) @@ -246,18 +267,22 @@ class ImpressDocument(PresentationDocument): for idx in range(pages.getCount()): page = pages.getByIndex(idx) doc.getCurrentController().setCurrentPage(page) - path = u'%s/%s%s.png' % (thumbdir, self.controller.thumbnailprefix, - unicode(idx + 1)) + urlpath = u'%s/%s.png' % (thumbdirurl, unicode(idx + 1)) + path = os.path.join(self.get_temp_folder(), + unicode(idx + 1) + u'.png') try: - doc.storeToURL(path , props) - preview = resize_image(path, 640, 480) + doc.storeToURL(urlpath, props) + self.convert_thumbnail(path, idx) if os.path.exists(path): os.remove(path) - preview.save(path, u'png') except: log.exception(u'%s - Unable to store openoffice preview' % path) def create_property(self, name, value): + """ + 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.\ @@ -288,6 +313,9 @@ class ImpressDocument(PresentationDocument): self.controller.remove_doc(self) def is_loaded(self): + """ + Returns true if a presentation is loaded + """ log.debug(u'is loaded OpenOffice') #print "is_loaded " if self.presentation is None or self.document is None: @@ -302,6 +330,9 @@ class ImpressDocument(PresentationDocument): return True def is_active(self): + """ + Returns true if a presentation is active and running + """ log.debug(u'is active OpenOffice') #print "is_active " if not self.is_loaded(): @@ -313,10 +344,16 @@ class ImpressDocument(PresentationDocument): return True def unblank_screen(self): + """ + Unblanks the screen + """ log.debug(u'unblank screen OpenOffice') return self.control.resume() def blank_screen(self): + """ + Blanks the screen + """ log.debug(u'blank screen OpenOffice') self.control.blankScreen(0) @@ -331,6 +368,9 @@ class ImpressDocument(PresentationDocument): return False def stop_presentation(self): + """ + Stop the presentation, remove from screen + """ log.debug(u'stop presentation OpenOffice') # deactivate should hide the screen according to docs, but doesn't #self.control.deactivate() @@ -338,6 +378,9 @@ class ImpressDocument(PresentationDocument): self.control = None def start_presentation(self): + """ + 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() @@ -354,12 +397,21 @@ class ImpressDocument(PresentationDocument): self.goto_slide(1) def get_slide_number(self): + """ + 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 self.document.getDrawPages().getCount() def goto_slide(self, slideno): + """ + Go to a specific slide (from 1) + """ self.control.gotoSlideIndex(slideno-1) def next_step(self): diff --git a/openlp/plugins/presentations/lib/mediaitem.py b/openlp/plugins/presentations/lib/mediaitem.py index 6f6d6fdb1..6f6fa285f 100644 --- a/openlp/plugins/presentations/lib/mediaitem.py +++ b/openlp/plugins/presentations/lib/mediaitem.py @@ -35,9 +35,13 @@ from openlp.plugins.presentations.lib import MessageListener log = logging.getLogger(__name__) -# We have to explicitly create separate classes for each plugin -# in order for DnD to the Service manager to work correctly. class PresentationListView(BaseListWithDnD): + """ + Class for the list of Presentations + + We have to explicitly create separate classes for each plugin + in order for DnD to the Service manager to work correctly. + """ def __init__(self, parent=None): self.PluginName = u'Presentations' BaseListWithDnD.__init__(self, parent) @@ -45,11 +49,14 @@ class PresentationListView(BaseListWithDnD): class PresentationMediaItem(MediaManagerItem): """ This is the Presentation media manager item for Presentation Items. - It can present files using Openoffice + It can present files using Openoffice and Powerpoint """ log.info(u'Presentations Media Item loaded') def __init__(self, parent, icon, title, controllers): + """ + Constructor. Setup defaults + """ self.controllers = controllers self.PluginNameShort = u'Presentation' self.IconPath = u'presentations/presentation' @@ -61,10 +68,16 @@ class PresentationMediaItem(MediaManagerItem): self.message_listener = MessageListener(self) def initPluginNameVisible(self): + """ + The name of the plugin media displayed in UI + """ self.PluginNameVisible = translate('PresentationPlugin.MediaItem', 'Presentation') def retranslateUi(self): + """ + The name of the plugin media displayed in UI + """ self.OnNewPrompt = translate('PresentationPlugin.MediaItem', 'Select Presentation(s)') self.Automatic = translate('PresentationPlugin.MediaItem', @@ -82,12 +95,18 @@ class PresentationMediaItem(MediaManagerItem): 'Presentations (%s)' % fileType) def requiredIcons(self): + """ + Set which icons the media manager tab should show + """ MediaManagerItem.requiredIcons(self) self.hasFileIcon = True self.hasNewIcon = False self.hasEditIcon = False def addEndHeaderBar(self): + """ + Display custom media manager items for presentations + """ self.PresentationWidget = QtGui.QWidget(self) sizePolicy = QtGui.QSizePolicy( QtGui.QSizePolicy.Expanding, QtGui.QSizePolicy.Minimum) @@ -111,12 +130,10 @@ class PresentationMediaItem(MediaManagerItem): self.PageLayout.addWidget(self.PresentationWidget) def initialise(self): - self.servicePath = os.path.join( - AppLocation.get_section_data_path(self.settingsSection), - u'thumbnails') + """ + Populate the media manager tab + """ self.ListView.setIconSize(QtCore.QSize(88, 50)) - if not os.path.exists(self.servicePath): - os.mkdir(self.servicePath) list = SettingsManager.load_list( self.settingsSection, u'presentations') self.loadList(list) @@ -129,6 +146,11 @@ class PresentationMediaItem(MediaManagerItem): self.DisplayTypeComboBox.setCurrentIndex(0) def loadList(self, list): + """ + 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.getFileList() titles = [] for file in currlist: @@ -141,37 +163,35 @@ class PresentationMediaItem(MediaManagerItem): QtGui.QMessageBox.critical( self, translate('PresentationPlugin.MediaItem', 'File exists'), - translate('PresentationPlugin.MediaItem', - 'A presentation with that filename already exists.'), + translate('PresentationPlugin.MediaItem', + 'A presentation with that filename already exists.'), QtGui.QMessageBox.Ok) + continue + controller_name = self.findControllerByType(filename) + if not controller_name: + QtGui.QMessageBox.critical( + self, translate('PresentationPlugin.MediaItem', + 'Unsupported file'), + translate('PresentationPlugin.MediaItem', + 'This type of presentation is not supported'), + QtGui.QMessageBox.Ok) + continue + controller = self.controllers[controller_name] + doc = controller.add_doc(unicode(file)) + thumb = os.path.join(doc.get_thumbnail_folder(), u'icon.png') + preview = doc.get_thumbnail_path(1, True) + if not preview: + doc.load_presentation() + preview = doc.get_thumbnail_path(1, True) + doc.close_presentation() + if preview and self.validate(preview, thumb): + icon = build_icon(thumb) else: - icon = None - for controller in self.controllers: - thumbPath = os.path.join( - AppLocation.get_section_data_path( - self.settingsSection), - u'thumbnails', controller, filename) - thumb = os.path.join(thumbPath, u'slide1.png') - preview = os.path.join( - AppLocation.get_section_data_path( - self.settingsSection), - controller, u'thumbnails', filename, u'slide1.png') - if os.path.exists(preview): - if os.path.exists(thumb): - if self.validate(preview, thumb): - icon = build_icon(thumb) - else: - icon = build_icon( - u':/general/general_delete.png') - else: - os.makedirs(thumbPath) - icon = self.IconFromFile(preview, thumb) - if not icon: - icon = build_icon(u':/general/general_delete.png') - item_name = QtGui.QListWidgetItem(filename) - item_name.setData(QtCore.Qt.UserRole, QtCore.QVariant(file)) - item_name.setIcon(icon) - self.ListView.addItem(item_name) + icon = build_icon(u':/general/general_delete.png') + item_name = QtGui.QListWidgetItem(filename) + item_name.setData(QtCore.Qt.UserRole, QtCore.QVariant(file)) + item_name.setIcon(icon) + self.ListView.addItem(item_name) def onDeleteClick(self): """ @@ -186,8 +206,6 @@ class PresentationMediaItem(MediaManagerItem): for item in items: filepath = unicode(item.data( QtCore.Qt.UserRole).toString()) - #not sure of this has errors - #John please can you look at . for cidx in self.controllers: doc = self.controllers[cidx].add_doc(filepath) doc.presentation_deleted() @@ -198,6 +216,11 @@ class PresentationMediaItem(MediaManagerItem): self.settingsSection, self.getFileList()) def generateSlideData(self, service_item, item=None): + """ + Load the relevant information for displaying the presentation + in the slidecontroller. In the case of powerpoints, an image + for each slide + """ items = self.ListView.selectedIndexes() if len(items) > 1: return False @@ -215,20 +238,27 @@ class PresentationMediaItem(MediaManagerItem): controller = self.controllers[service_item.shortname] (path, name) = os.path.split(filename) doc = controller.add_doc(filename) - if doc.get_slide_preview_file(1) is None: + if doc.get_thumbnail_path(1, True) is None: doc.load_presentation() i = 1 - img = doc.get_slide_preview_file(i) + img = doc.get_thumbnail_path(i, True) while img: service_item.add_from_command(path, name, img) i = i + 1 - img = doc.get_slide_preview_file(i) + img = doc.get_thumbnail_path(i, True) doc.close_presentation() return True else: return False 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 "alsosupports" it instead. + """ filetype = os.path.splitext(filename)[1] if not filetype: return None diff --git a/openlp/plugins/presentations/lib/messagelistener.py b/openlp/plugins/presentations/lib/messagelistener.py index 2f8a1aec7..a7e6f10ce 100644 --- a/openlp/plugins/presentations/lib/messagelistener.py +++ b/openlp/plugins/presentations/lib/messagelistener.py @@ -41,17 +41,28 @@ class Controller(object): log.info(u'Controller loaded') def __init__(self, live): + """ + Constructor + """ self.is_live = live self.doc = None log.info(u'%s controller loaded' % live) def add_handler(self, controller, file, is_blank): + """ + 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 if self.doc is not None: self.shutdown() self.doc = self.controller.add_doc(file) - self.doc.load_presentation() + if not self.doc.load_presentation(): + # Display error message to user + # Inform slidecontroller that the action failed? + return if self.is_live: self.doc.start_presentation() if is_blank: @@ -60,6 +71,10 @@ class Controller(object): self.doc.slidenumber = 0 def activate(self): + """ + Active the presentation, and show it on the screen. + Use the last slide number. + """ log.debug(u'Live = %s, activate' % self.is_live) if self.doc.is_active(): return @@ -71,6 +86,9 @@ class Controller(object): self.doc.goto_slide(self.doc.slidenumber) def slide(self, slide): + """ + Go to a specific slide + """ log.debug(u'Live = %s, slide' % self.is_live) if not self.is_live: return @@ -152,6 +170,9 @@ class Controller(object): #self.timer.stop() def blank(self): + """ + Instruct the controller to blank the presentation + """ log.debug(u'Live = %s, blank' % self.is_live) if not self.is_live: return @@ -162,6 +183,9 @@ class Controller(object): self.doc.blank_screen() def stop(self): + """ + Instruct the controller to stop and hide the presentation + """ log.debug(u'Live = %s, stop' % self.is_live) if not self.is_live: return @@ -172,6 +196,9 @@ class Controller(object): self.doc.stop_presentation() def unblank(self): + """ + Instruct the controller to unblank the presentation + """ log.debug(u'Live = %s, unblank' % self.is_live) if not self.is_live: return @@ -246,6 +273,9 @@ class MessageListener(object): controller.add_handler(self.controllers[self.handler], file, is_blank) def slide(self, message): + """ + React to the message to move to a specific slide + """ is_live = message[1] slide = message[2] if is_live: @@ -254,6 +284,9 @@ class MessageListener(object): self.preview_handler.slide(slide) def first(self, message): + """ + React to the message to move to the first slide + """ is_live = message[1] if is_live: self.live_handler.first() @@ -261,6 +294,9 @@ class MessageListener(object): self.preview_handler.first() def last(self, message): + """ + React to the message to move to the last slide + """ is_live = message[1] if is_live: self.live_handler.last() @@ -268,6 +304,9 @@ class MessageListener(object): self.preview_handler.last() def next(self, message): + """ + React to the message to move to the next animation/slide + """ is_live = message[1] if is_live: self.live_handler.next() @@ -275,6 +314,9 @@ class MessageListener(object): self.preview_handler.next() def previous(self, message): + """ + React to the message to move to the previous animation/slide + """ is_live = message[1] if is_live: self.live_handler.previous() @@ -282,6 +324,10 @@ class MessageListener(object): self.preview_handler.previous() def shutdown(self, message): + """ + React to message to shutdown the presentation. I.e. end the show + and close the file + """ is_live = message[1] if is_live: Receiver.send_message(u'maindisplay_show') @@ -290,19 +336,34 @@ class MessageListener(object): self.preview_handler.shutdown() def hide(self, message): + """ + React to the message to show the desktop + """ is_live = message[1] if is_live: self.live_handler.stop() def blank(self, message): + """ + React to the message to blank the display + """ is_live = message[1] if is_live: self.live_handler.blank() def unblank(self, message): + """ + React to the message to unblank the display + """ is_live = message[1] if is_live: self.live_handler.unblank() def timeout(self): + """ + The presentation may be timed or might be controlled by the + application directly, rather than through OpenLP. Poll occassionally + 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 00ded85f6..ea757a07d 100644 --- a/openlp/plugins/presentations/lib/powerpointcontroller.py +++ b/openlp/plugins/presentations/lib/powerpointcontroller.py @@ -24,7 +24,7 @@ ############################################################################### import os -import logging +import loggin if os.name == u'nt': from win32com.client import Dispatch @@ -97,13 +97,23 @@ class PowerpointController(PresentationController): self.process = None def add_doc(self, name): + """ + Called when a new powerpoint document is opened + """ log.debug(u'Add Doc PowerPoint') doc = PowerpointDocument(self, name) self.docs.append(doc) return doc class PowerpointDocument(PresentationDocument): + """ + Class which holds information and controls a single presentation + """ + def __init__(self, controller, presentation): + """ + Constructor, store information about the file and initialise + """ log.debug(u'Init Presentation Powerpoint') PresentationDocument.__init__(self, controller, presentation) self.presentation = None @@ -111,10 +121,7 @@ class PowerpointDocument(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. + Opens the PowerPoint file using the process created earlier ``presentation`` The file name of the presentations to run. @@ -122,11 +129,15 @@ class PowerpointDocument(PresentationDocument): log.debug(u'LoadPresentation') if not self.controller.process.Visible: self.controller.start_process() - self.controller.process.Presentations.Open(self.filepath, False, False, - True) + try: + self.controller.process.Presentations.Open(self.filepath, False, + False, True) + except pywintypes.com_error: + return False self.presentation = self.controller.process.Presentations( self.controller.process.Presentations.Count) self.create_thumbnails() + return True def create_thumbnails(self): """ @@ -139,8 +150,8 @@ class PowerpointDocument(PresentationDocument): """ if self.check_thumbnails(): return - self.presentation.Export(os.path.join(self.thumbnailpath, ''), 'png', - 320, 240) + self.presentation.Export(os.path.join(self.get_thumbnail_folder(), ''), + 'png', 320, 240) def close_presentation(self): """ @@ -298,4 +309,4 @@ class PowerpointDocument(PresentationDocument): shape = shapes(idx + 1) if shape.HasTextFrame: text += shape.TextFrame.TextRange.Text + '\n' - return text \ No newline at end of file + return text diff --git a/openlp/plugins/presentations/lib/pptviewcontroller.py b/openlp/plugins/presentations/lib/pptviewcontroller.py index 2c108333c..e92cf1054 100644 --- a/openlp/plugins/presentations/lib/pptviewcontroller.py +++ b/openlp/plugins/presentations/lib/pptviewcontroller.py @@ -31,6 +31,7 @@ if os.name == u'nt': from ctypes.wintypes import RECT from presentationcontroller import PresentationController, PresentationDocument +from openlp.core.lib import resize_image log = logging.getLogger(__name__) @@ -93,13 +94,22 @@ class PptviewController(PresentationController): self.docs[0].close_presentation() def add_doc(self, name): + """ + Called when a new powerpoint document is opened + """ log.debug(u'Add Doc PPTView') doc = PptviewDocument(self, name) self.docs.append(doc) return doc class PptviewDocument(PresentationDocument): + """ + Class which holds information and controls a single presentation + """ def __init__(self, controller, presentation): + """ + Constructor, store information about the file and initialise + """ log.debug(u'Init Presentation PowerPoint') PresentationDocument.__init__(self, controller, presentation) self.presentation = None @@ -117,17 +127,29 @@ class PptviewDocument(PresentationDocument): The file name of the presentations to run. """ log.debug(u'LoadPresentation') - #if self.pptid >= 0: - # self.close_presentation() rendermanager = self.controller.plugin.renderManager rect = rendermanager.screens.current[u'size'] rect = RECT(rect.x(), rect.y(), rect.right(), rect.bottom()) filepath = str(self.filepath.replace(u'/', u'\\')) self.pptid = self.controller.process.OpenPPT(filepath, None, rect, - str(os.path.join(self.thumbnailpath, - self.controller.thumbnailprefix))) + str(self.get_temp_folder()) + '\\') if self.pptid: + self.create_thumbnails() self.stop_presentation() + return True + else: + return False + + def create_thumbnails(self): + """ + PPTviewLib creates large BMP's, but we want small PNG's for consistency. + Convert them here. + """ + if self.check_thumbnails(): + return + for idx in range(self.get_slide_count()): + path = u'%s\\%s.bmp' % (self.get_temp_folder(), unicode(idx + 1)) + self.convert_image(path, idx) def close_presentation(self): """ @@ -224,17 +246,3 @@ class PptviewDocument(PresentationDocument): """ self.controller.process.PrevStep(self.pptid) - def get_slide_preview_file(self, slide_no): - """ - Returns an image path containing a preview for the requested slide - - ``slide_no`` - The slide an image is required for, starting at 1 - """ - path = os.path.join(self.thumbnailpath, - self.controller.thumbnailprefix + unicode(slide_no) + u'.bmp') - if os.path.isfile(path): - return path - else: - return None - diff --git a/openlp/plugins/presentations/lib/presentationcontroller.py b/openlp/plugins/presentations/lib/presentationcontroller.py index 501776a19..ed4081ed6 100644 --- a/openlp/plugins/presentations/lib/presentationcontroller.py +++ b/openlp/plugins/presentations/lib/presentationcontroller.py @@ -29,7 +29,7 @@ import shutil from PyQt4 import QtCore -from openlp.core.lib import Receiver +from openlp.core.lib import Receiver, resize_image from openlp.core.utils import AppLocation log = logging.getLogger(__name__) @@ -63,6 +63,13 @@ class PresentationController(object): ``plugin`` The presentationplugin object + ``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 + **Hook Functions** ``kill()`` @@ -109,12 +116,16 @@ class PresentationController(object): QtCore.Qt.Checked else: self.enabled = False - self.thumbnailroot = os.path.join( + self.temp_folder = os.path.join( + AppLocation.get_section_data_path(self.settings_section), name) + self.thumbnail_folder = os.path.join( AppLocation.get_section_data_path(self.settings_section), - name, u'thumbnails') - self.thumbnailprefix = u'slide' - if not os.path.isdir(self.thumbnailroot): - os.makedirs(self.thumbnailroot) + u'thumbnails') + self.thumbnail_prefix = u'slide' + if not os.path.isdir(self.thumbnail_folder): + os.makedirs(self.thumbnail_folder) + if not os.path.isdir(self.temp_folder): + os.makedirs(self.temp_folder) def check_available(self): """ @@ -208,14 +219,19 @@ class PresentationDocument(object): ``previous_step()`` Triggers the previous slide on the running presentation - ``get_slide_preview_file(slide_no)`` + ``get_thumbnail_path(slide_no, check_exists)`` Returns a path to an image containing a preview for the requested slide """ def __init__(self, controller, name): + """ + Constructor for the PresentationController class + """ self.slidenumber = 0 self.controller = controller - self.store_filename(name) + self.filepath = name + if not os.path.isdir(self.get_thumbnail_folder()): + os.mkdir(self.get_thumbnail_folder()) def load_presentation(self): """ @@ -224,9 +240,10 @@ class PresentationDocument(object): ``presentation`` The file name of the presentations to the run. - + + Returns False if the file could not be opened """ - pass + return False def presentation_deleted(self): """ @@ -234,33 +251,37 @@ class PresentationDocument(object): a file, e.g. thumbnails """ try: - shutil.rmtree(self.thumbnailpath) + shutil.rmtree(self.get_thumbnail_folder()) + shutil.rmtree(self.get_temp_folder()) except OSError: log.exception(u'Failed to delete presentation controller files') - def store_filename(self, presentation): + def get_file_name(self): """ - Set properties for the filename and thumbnail paths + Return just the filename of the presention, without the directory """ - self.filepath = presentation - self.filename = self.get_file_name(presentation) - self.thumbnailpath = self.get_thumbnail_path(presentation) - if not os.path.isdir(self.thumbnailpath): - os.mkdir(self.thumbnailpath) + return os.path.split(self.filepath)[1] - def get_file_name(self, presentation): - return os.path.split(presentation)[1] - - def get_thumbnail_path(self, presentation): + def get_thumbnail_folder(self): + """ + The location where thumbnail images will be stored + """ return os.path.join( - self.controller.thumbnailroot, self.get_file_name(presentation)) + 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()) def check_thumbnails(self): """ Returns true if the thumbnail images look to exist and are more recent than the powerpoint """ - lastimage = self.get_slide_preview_file(self.get_slide_count()) + lastimage = self.get_thumbnail_path(self.get_slide_count(), True) if not (lastimage and os.path.isfile(lastimage)): return False imgdate = os.stat(lastimage).st_mtime @@ -350,16 +371,27 @@ class PresentationDocument(object): """ pass - def get_slide_preview_file(self, slide_no): + def convert_thumbnail(self, file, idx): + """ + Convert the slide image the application made to a standard 320x240 + .png image. + """ + if self.check_thumbnails(): + return + if os.path.isfile(file): + img = resize_image(file, 320, 240) + img.save(self.get_thumbnail_path(idx, False)) + + def get_thumbnail_path(self, slide_no, check_exists): """ Returns an image path containing a preview for the requested slide ``slide_no`` The slide an image is required for, starting at 1 """ - path = os.path.join(self.thumbnailpath, - self.controller.thumbnailprefix + unicode(slide_no) + u'.png') - if os.path.isfile(path): + path = os.path.join(self.get_thumbnail_folder(), + self.controller.thumbnail_prefix + unicode(slide_no) + u'.png') + if os.path.isfile(path) or not check_exists: return path else: return None diff --git a/openlp/plugins/presentations/lib/presentationtab.py b/openlp/plugins/presentations/lib/presentationtab.py index 099376ce9..980c62f47 100644 --- a/openlp/plugins/presentations/lib/presentationtab.py +++ b/openlp/plugins/presentations/lib/presentationtab.py @@ -32,10 +32,16 @@ class PresentationTab(SettingsTab): PresentationsTab is the Presentations settings tab in the settings dialog. """ def __init__(self, title, controllers): + """ + Constructor + """ self.controllers = controllers SettingsTab.__init__(self, title) def setupUi(self): + """ + Create the controls for the settings tab + """ self.setObjectName(u'PresentationTab') self.tabTitleVisible = translate('PresentationPlugin.PresentationTab', 'Presentations') @@ -89,6 +95,9 @@ class PresentationTab(SettingsTab): self.PresentationLayout.addWidget(self.PresentationRightWidget) def retranslateUi(self): + """ + Make any translation changes + """ self.VerseDisplayGroupBox.setTitle( translate('PresentationPlugin.PresentationTab', 'Available Controllers')) @@ -100,6 +109,9 @@ class PresentationTab(SettingsTab): translate('PresentationPlugin.PresentationTab', 'available'))) def load(self): + """ + Load the settings. + """ for key in self.controllers: controller = self.controllers[key] if controller.available: @@ -109,6 +121,9 @@ class PresentationTab(SettingsTab): QtCore.QVariant(0)).toInt()[0]) def save(self): + """ + Save the settings. + """ for key in self.controllers: controller = self.controllers[key] checkbox = self.PresenterCheckboxes[controller.name] diff --git a/openlp/plugins/presentations/presentationplugin.py b/openlp/plugins/presentations/presentationplugin.py index a905a3312..89139cca3 100644 --- a/openlp/plugins/presentations/presentationplugin.py +++ b/openlp/plugins/presentations/presentationplugin.py @@ -33,9 +33,17 @@ from openlp.plugins.presentations.lib import * log = logging.getLogger(__name__) 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 + """ log = logging.getLogger(u'PresentationPlugin') def __init__(self, plugin_helpers): + """ + PluginPresentation constructor. + """ log.debug(u'Initialised') self.controllers = {} Plugin.__init__(self, u'Presentations', u'1.9.2', plugin_helpers) @@ -50,6 +58,10 @@ class PresentationPlugin(Plugin): return PresentationTab(self.name, self.controllers) def initialise(self): + """ + Initialise the plugin. Determine which controllers are enabled + are start their processes. + """ log.info(u'Presentations Initialising') Plugin.initialise(self) self.insertToolboxItem() @@ -58,6 +70,10 @@ class PresentationPlugin(Plugin): self.controllers[controller].start_process() def finalise(self): + """ + 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 for key in self.controllers: @@ -74,6 +90,10 @@ class PresentationPlugin(Plugin): self, self.icon, self.name, self.controllers) def registerControllers(self, controller): + """ + Register each presentation controller (Impress, PPT etc) and + store for later use + """ self.controllers[controller.name] = controller def checkPreConditions(self): @@ -108,9 +128,12 @@ class PresentationPlugin(Plugin): return False def about(self): + """ + Return information about this plugin + """ about_text = translate('PresentationPlugin', 'Presentation Plugin
Delivers ' 'the ability to show presentations using a number of different ' 'programs. The choice of available presentation programs is ' 'available to the user in a drop down box.') - return about_text \ No newline at end of file + return about_text From 91b3c06849276fb4f31d6e97f84d5e41a7681087 Mon Sep 17 00:00:00 2001 From: Jonathan Corwin Date: Sat, 10 Jul 2010 23:21:50 +0100 Subject: [PATCH 2/6] Missed one --- openlp/plugins/presentations/lib/pptviewcontroller.py | 1 - 1 file changed, 1 deletion(-) diff --git a/openlp/plugins/presentations/lib/pptviewcontroller.py b/openlp/plugins/presentations/lib/pptviewcontroller.py index e92cf1054..e3f945d45 100644 --- a/openlp/plugins/presentations/lib/pptviewcontroller.py +++ b/openlp/plugins/presentations/lib/pptviewcontroller.py @@ -31,7 +31,6 @@ if os.name == u'nt': from ctypes.wintypes import RECT from presentationcontroller import PresentationController, PresentationDocument -from openlp.core.lib import resize_image log = logging.getLogger(__name__) From 08c36f7e1c3052ddf8a8d591c4fc7c6ec6068eed Mon Sep 17 00:00:00 2001 From: Jonathan Corwin Date: Sat, 10 Jul 2010 23:33:09 +0100 Subject: [PATCH 3/6] Got a conflict fix wrong --- openlp/plugins/presentations/lib/mediaitem.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openlp/plugins/presentations/lib/mediaitem.py b/openlp/plugins/presentations/lib/mediaitem.py index 237645d35..25e02dfc9 100644 --- a/openlp/plugins/presentations/lib/mediaitem.py +++ b/openlp/plugins/presentations/lib/mediaitem.py @@ -186,7 +186,7 @@ class PresentationMediaItem(MediaManagerItem): item_name = QtGui.QListWidgetItem(filename) item_name.setData(QtCore.Qt.UserRole, QtCore.QVariant(file)) item_name.setIcon(icon) - self.ListView.addItem(item_name) + self.listView.addItem(item_name) def onDeleteClick(self): """ From fb4faf0dbba2cb65976a39073f481178840e329c Mon Sep 17 00:00:00 2001 From: Jonathan Corwin Date: Sat, 10 Jul 2010 23:41:36 +0100 Subject: [PATCH 4/6] Powerpoint fix --- openlp/plugins/presentations/lib/powerpointcontroller.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/openlp/plugins/presentations/lib/powerpointcontroller.py b/openlp/plugins/presentations/lib/powerpointcontroller.py index ea757a07d..6c725e583 100644 --- a/openlp/plugins/presentations/lib/powerpointcontroller.py +++ b/openlp/plugins/presentations/lib/powerpointcontroller.py @@ -24,7 +24,7 @@ ############################################################################### import os -import loggin +import logging if os.name == u'nt': from win32com.client import Dispatch @@ -127,7 +127,7 @@ class PowerpointDocument(PresentationDocument): The file name of the presentations to run. """ log.debug(u'LoadPresentation') - if not self.controller.process.Visible: + if not self.controller.process or not self.controller.process.Visible: self.controller.start_process() try: self.controller.process.Presentations.Open(self.filepath, False, From fe5b3e6771e4ba6440ca2bb442905483b6f18731 Mon Sep 17 00:00:00 2001 From: Jonathan Corwin Date: Sun, 11 Jul 2010 21:22:53 +0100 Subject: [PATCH 5/6] pptview/impress fixes to thumbnails on Windows --- .../presentations/lib/impresscontroller.py | 931 +++++++++--------- openlp/plugins/presentations/lib/mediaitem.py | 57 +- .../presentations/lib/pptviewcontroller.py | 10 +- 3 files changed, 505 insertions(+), 493 deletions(-) diff --git a/openlp/plugins/presentations/lib/impresscontroller.py b/openlp/plugins/presentations/lib/impresscontroller.py index 79c724f6a..f3c4cb68c 100644 --- a/openlp/plugins/presentations/lib/impresscontroller.py +++ b/openlp/plugins/presentations/lib/impresscontroller.py @@ -1,463 +1,468 @@ -# -*- coding: utf-8 -*- -# vim: autoindent shiftwidth=4 expandtab textwidth=80 tabstop=4 softtabstop=4 - -############################################################################### -# OpenLP - Open Source Lyrics Projection # -# --------------------------------------------------------------------------- # -# Copyright (c) 2008-2010 Raoul Snyman # -# Portions copyright (c) 2008-2010 Tim Bentley, Jonathan Corwin, Michael # -# Gorven, Scott Guerrieri, Christian Richter, Maikel Stuivenberg, Martin # -# Thompson, Jon Tibble, Carsten Tinggaard # -# --------------------------------------------------------------------------- # -# 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 # -############################################################################### - -# OOo API documentation: -# http://api.openoffice.org/docs/common/ref/com/sun/star/presentation/XSlideShowController.html -# http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/ProUNO/Basic/Getting_Information_about_UNO_Objects#Inspecting_interfaces_during_debugging -# http://docs.go-oo.org/sd/html/classsd_1_1SlideShow.html -# http://www.oooforum.org/forum/viewtopic.phtml?t=5252 -# http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Working_with_Presentations -# http://mail.python.org/pipermail/python-win32/2008-January/006676.html -# http://www.linuxjournal.com/content/starting-stopping-and-connecting-openoffice-python -# http://nxsy.org/comparing-documents-with-openoffice-and-python - -import logging -import os -import time - -from openlp.core.lib import resize_image - -if os.name == u'nt': - from win32com.client import Dispatch - import pywintypes -else: - try: - import uno - from com.sun.star.beans import PropertyValue - uno_available = True - except ImportError: - uno_available = False - -from PyQt4 import QtCore - -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 - """ - log.info(u'ImpressController loaded') - - def __init__(self, plugin): - """ - Initialise the class - """ - log.debug(u'Initialising') - PresentationController.__init__(self, plugin, u'Impress') - self.supports = [u'.odp'] - self.alsosupports = [u'.ppt', u'.pps', u'.pptx', u'.ppsx'] - self.process = None - self.desktop = None - - def check_available(self): - """ - Impress is able to run on this machine - """ - log.debug(u'check_available') - if os.name == u'nt': - return self.get_com_servicemanager() is not None - else: - return uno_available - - 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. - """ - log.debug(u'start process Openoffice') - if os.name == u'nt': - self.manager = self.get_com_servicemanager() - self.manager._FlagAsMethod(u'Bridge_GetStruct') - self.manager._FlagAsMethod(u'Bridge_GetValueObject') - else: - # -headless - cmd = u'openoffice.org -nologo -norestore -minimized -invisible -nofirststartwizard -accept="socket,host=localhost,port=2002;urp;"' - self.process = QtCore.QProcess() - self.process.startDetached(cmd) - self.process.waitForStarted() - - def get_uno_desktop(self): - """ - On non-Windows platforms, use Uno. Get the OpenOffice desktop - which will be used to manage impress - """ - log.debug(u'get UNO Desktop Openoffice') - ctx = None - loop = 0 - log.debug(u'get UNO Desktop Openoffice - getComponentContext') - context = uno.getComponentContext() - log.debug(u'get UNO Desktop Openoffice - createInstaneWithContext - ' - u'UnoUrlResolver') - resolver = context.ServiceManager.createInstanceWithContext( - u'com.sun.star.bridge.UnoUrlResolver', context) - while ctx is None and loop < 3: - try: - log.debug(u'get UNO Desktop Openoffice - resolve') - ctx = resolver.resolve(u'uno:socket,host=localhost,port=2002;' - u'urp;StarOffice.ComponentContext') - except: - log.exception(u'Unable to find running instance ') - self.start_process() - loop += 1 - try: - self.manager = ctx.ServiceManager - log.debug(u'get UNO Desktop Openoffice - createInstanceWithContext' - u' - Desktop') - desktop = self.manager.createInstanceWithContext( - "com.sun.star.frame.Desktop", ctx ) - return desktop - except: - log.exception(u'Failed to get UNO desktop') - return None - - def get_com_desktop(self): - """ - On Windows platforms, use COM. Return the desktop object which - will be used to manage Impress - """ - log.debug(u'get COM Desktop OpenOffice') - return self.manager.createInstance(u'com.sun.star.frame.Desktop') - - def get_com_servicemanager(self): - """ - Return the OOo service manager for windows - """ - log.debug(u'get_com_servicemanager openoffice') - try: - return Dispatch(u'com.sun.star.ServiceManager') - except pywintypes.com_error: - log.exception(u'Failed to get COM service manager') - return None - - def kill(self): - """ - Called at system exit to clean up any running presentations - """ - log.debug(u'Kill OpenOffice') - while self.docs: - self.docs[0].close_presentation() - if os.name != u'nt': - desktop = self.get_uno_desktop() - else: - desktop = self.get_com_desktop() - #Sometimes we get a failure and desktop is None - if not desktop: - log.exception(u'Failed to terminate OpenOffice') - return - docs = desktop.getComponents() - if docs.hasElements(): - log.debug(u'OpenOffice not terminated') - else: - try: - desktop.terminate() - log.debug(u'OpenOffice killed') - except: - log.exception(u'Failed to terminate OpenOffice') - - def add_doc(self, name): - """ - Called when a new Impress document is opened - """ - log.debug(u'Add Doc OpenOffice') - doc = ImpressDocument(self, name) - self.docs.append(doc) - return doc - -class ImpressDocument(PresentationDocument): - """ - Class which holds information and controls a single presentation - """ - - def __init__(self, controller, presentation): - """ - Constructor, store information about the file and initialise - """ - log.debug(u'Init Presentation OpenOffice') - PresentationDocument.__init__(self, controller, presentation) - self.document = None - self.presentation = None - self.control = None - - 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. - - ``presentation`` - The file name of the presentatios to the run. - """ - log.debug(u'Load Presentation OpenOffice') - #print "s.dsk1 ", self.desktop - if os.name == u'nt': - desktop = self.controller.get_com_desktop() - if desktop is None: - self.controller.start_process() - desktop = self.controller.get_com_desktop() - url = u'file:///' + self.filepath.replace(u'\\', u'/').replace( - u':', u'|').replace(u' ', u'%20') - else: - desktop = self.controller.get_uno_desktop() - url = uno.systemPathToFileUrl(self.filepath) - if desktop is None: - return False - self.desktop = desktop - properties = [] - properties.append(self.create_property(u'Minimized', True)) - properties = tuple(properties) - try: - self.document = desktop.loadComponentFromURL(url, u'_blank', - 0, properties) - except: - log.exception(u'Failed to load presentation') - return False - self.presentation = self.document.getPresentation() - self.presentation.Display = \ - self.controller.plugin.renderManager.screens.current_display + 1 - self.control = None - self.create_thumbnails() - return True - - def create_thumbnails(self): - """ - 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'/').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) - doc = self.document - pages = doc.getDrawPages() - for idx in range(pages.getCount()): - page = pages.getByIndex(idx) - 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') - try: - doc.storeToURL(urlpath, props) - self.convert_thumbnail(path, idx) - if os.path.exists(path): - os.remove(path) - except: - log.exception(u'%s - Unable to store openoffice preview' % path) - - def create_property(self, name, value): - """ - 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') - else: - prop = PropertyValue() - prop.Name = name - prop.Value = value - return prop - - def close_presentation(self): - """ - 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: - if self.presentation: - try: - self.presentation.end() - self.presentation = None - self.document.dispose() - except: - #We tried! - pass - self.document = None - self.controller.remove_doc(self) - - def is_loaded(self): - """ - Returns true if a presentation is loaded - """ - log.debug(u'is loaded OpenOffice') - #print "is_loaded " - if self.presentation is None or self.document is None: - #print "no present or document" - return False - try: - if self.document.getPresentation() is None: - #print "no getPresentation" - return False - except: - return False - return True - - def is_active(self): - """ - Returns true if a presentation is active and running - """ - log.debug(u'is active OpenOffice') - #print "is_active " - if not self.is_loaded(): - #print "False " - return False - #print "self.con ", self.control - if self.control is None: - return False - return True - - def unblank_screen(self): - """ - Unblanks the screen - """ - log.debug(u'unblank screen OpenOffice') - return self.control.resume() - - def blank_screen(self): - """ - Blanks the screen - """ - log.debug(u'blank screen OpenOffice') - self.control.blankScreen(0) - - def is_blank(self): - """ - Returns true if screen is blank - """ - log.debug(u'is blank OpenOffice') - if self.control: - return self.control.isPaused() - else: - return False - - def stop_presentation(self): - """ - Stop the presentation, remove from screen - """ - log.debug(u'stop presentation OpenOffice') - # deactivate should hide the screen according to docs, but doesn't - #self.control.deactivate() - self.presentation.end() - self.control = None - - def start_presentation(self): - """ - 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() - # start() returns before the getCurrentComponent is ready. - # Try for 5 seconds - i = 1 - while self.desktop.getCurrentComponent() is None and i < 50: - time.sleep(0.1) - i = i + 1 - self.control = \ - self.desktop.getCurrentComponent().Presentation.getController() - else: - self.control.activate() - self.goto_slide(1) - - def get_slide_number(self): - """ - 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 self.document.getDrawPages().getCount() - - def goto_slide(self, slideno): - """ - 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 - """ - self.control.gotoNextEffect() - - def previous_step(self): - """ - Triggers the previous slide on the running presentation - """ - self.control.gotoPreviousSlide() - - def get_slide_text(self, slide_no): - """ - Returns the text on the slide - - ``slide_no`` - The slide the text is required for, starting at 1 - """ - doc = self.document - pages = doc.getDrawPages() - text = '' - page = pages.getByIndex(slide_no - 1) - for idx in range(page.getCount()): - shape = page.getByIndex(idx) - if shape.supportsService("com.sun.star.drawing.Text"): - text += shape.getString() + '\n' - return text - - def get_slide_notes(self, slide_no): - """ - Returns the text on the slide - - ``slide_no`` - The slide the notes are required for, starting at 1 - """ - doc = self.document - pages = doc.getDrawPages() - text = '' - page = pages.getByIndex(slide_no - 1) - notes = page.getNotesPage() - for idx in range(notes.getCount()): - shape = notes.getByIndex(idx) - if shape.supportsService("com.sun.star.drawing.Text"): - text += shape.getString() + '\n' - return text - +# -*- coding: utf-8 -*- +# vim: autoindent shiftwidth=4 expandtab textwidth=80 tabstop=4 softtabstop=4 + +############################################################################### +# OpenLP - Open Source Lyrics Projection # +# --------------------------------------------------------------------------- # +# Copyright (c) 2008-2010 Raoul Snyman # +# Portions copyright (c) 2008-2010 Tim Bentley, Jonathan Corwin, Michael # +# Gorven, Scott Guerrieri, Christian Richter, Maikel Stuivenberg, Martin # +# Thompson, Jon Tibble, Carsten Tinggaard # +# --------------------------------------------------------------------------- # +# 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 # +############################################################################### + +# OOo API documentation: +# http://api.openoffice.org/docs/common/ref/com/sun/star/presentation/XSlideShowController.html +# http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/ProUNO/Basic/Getting_Information_about_UNO_Objects#Inspecting_interfaces_during_debugging +# http://docs.go-oo.org/sd/html/classsd_1_1SlideShow.html +# http://www.oooforum.org/forum/viewtopic.phtml?t=5252 +# http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Working_with_Presentations +# http://mail.python.org/pipermail/python-win32/2008-January/006676.html +# http://www.linuxjournal.com/content/starting-stopping-and-connecting-openoffice-python +# http://nxsy.org/comparing-documents-with-openoffice-and-python + +import logging +import os +import time + +from openlp.core.lib import resize_image + +if os.name == u'nt': + from win32com.client import Dispatch + import pywintypes +else: + try: + import uno + from com.sun.star.beans import PropertyValue + uno_available = True + except ImportError: + uno_available = False + +from PyQt4 import QtCore + +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 + """ + log.info(u'ImpressController loaded') + + def __init__(self, plugin): + """ + Initialise the class + """ + log.debug(u'Initialising') + PresentationController.__init__(self, plugin, u'Impress') + self.supports = [u'.odp'] + self.alsosupports = [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 + """ + log.debug(u'check_available') + if os.name == u'nt': + return self.get_com_servicemanager() is not None + else: + return uno_available + + 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. + """ + log.debug(u'start process Openoffice') + if os.name == u'nt': + self.manager = self.get_com_servicemanager() + self.manager._FlagAsMethod(u'Bridge_GetStruct') + self.manager._FlagAsMethod(u'Bridge_GetValueObject') + else: + # -headless + cmd = u'openoffice.org -nologo -norestore -minimized -invisible -nofirststartwizard -accept="socket,host=localhost,port=2002;urp;"' + self.process = QtCore.QProcess() + self.process.startDetached(cmd) + self.process.waitForStarted() + + def get_uno_desktop(self): + """ + On non-Windows platforms, use Uno. Get the OpenOffice desktop + which will be used to manage impress + """ + log.debug(u'get UNO Desktop Openoffice') + ctx = None + loop = 0 + log.debug(u'get UNO Desktop Openoffice - getComponentContext') + context = uno.getComponentContext() + log.debug(u'get UNO Desktop Openoffice - createInstaneWithContext - ' + u'UnoUrlResolver') + resolver = context.ServiceManager.createInstanceWithContext( + u'com.sun.star.bridge.UnoUrlResolver', context) + while ctx is None and loop < 3: + try: + log.debug(u'get UNO Desktop Openoffice - resolve') + ctx = resolver.resolve(u'uno:socket,host=localhost,port=2002;' + u'urp;StarOffice.ComponentContext') + except: + log.exception(u'Unable to find running instance ') + self.start_process() + loop += 1 + try: + self.manager = ctx.ServiceManager + log.debug(u'get UNO Desktop Openoffice - createInstanceWithContext' + u' - Desktop') + desktop = self.manager.createInstanceWithContext( + "com.sun.star.frame.Desktop", ctx ) + return desktop + except: + log.exception(u'Failed to get UNO desktop') + return None + + def get_com_desktop(self): + """ + 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: + return None + return self.manager.createInstance(u'com.sun.star.frame.Desktop') + + def get_com_servicemanager(self): + """ + Return the OOo service manager for windows + """ + log.debug(u'get_com_servicemanager openoffice') + try: + return Dispatch(u'com.sun.star.ServiceManager') + except pywintypes.com_error: + log.exception(u'Failed to get COM service manager') + return None + + def kill(self): + """ + Called at system exit to clean up any running presentations + """ + log.debug(u'Kill OpenOffice') + while self.docs: + self.docs[0].close_presentation() + if os.name != u'nt': + desktop = self.get_uno_desktop() + else: + desktop = self.get_com_desktop() + #Sometimes we get a failure and desktop is None + if not desktop: + log.exception(u'Failed to terminate OpenOffice') + return + docs = desktop.getComponents() + if docs.hasElements(): + log.debug(u'OpenOffice not terminated') + else: + try: + desktop.terminate() + log.debug(u'OpenOffice killed') + except: + log.exception(u'Failed to terminate OpenOffice') + + def add_doc(self, name): + """ + Called when a new Impress document is opened + """ + log.debug(u'Add Doc OpenOffice') + doc = ImpressDocument(self, name) + self.docs.append(doc) + return doc + +class ImpressDocument(PresentationDocument): + """ + Class which holds information and controls a single presentation + """ + + def __init__(self, controller, presentation): + """ + Constructor, store information about the file and initialise + """ + log.debug(u'Init Presentation OpenOffice') + PresentationDocument.__init__(self, controller, presentation) + self.document = None + self.presentation = None + self.control = None + + 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. + + ``presentation`` + The file name of the presentatios to the run. + """ + log.debug(u'Load Presentation OpenOffice') + #print "s.dsk1 ", self.desktop + if os.name == u'nt': + desktop = self.controller.get_com_desktop() + if desktop is None: + self.controller.start_process() + desktop = self.controller.get_com_desktop() + url = u'file:///' + self.filepath.replace(u'\\', u'/').replace( + u':', u'|').replace(u' ', u'%20') + else: + desktop = self.controller.get_uno_desktop() + url = uno.systemPathToFileUrl(self.filepath) + if desktop is None: + return False + self.desktop = desktop + properties = [] + properties.append(self.create_property(u'Minimized', True)) + properties = tuple(properties) + try: + self.document = desktop.loadComponentFromURL(url, u'_blank', + 0, properties) + except: + log.exception(u'Failed to load presentation') + return False + self.presentation = self.document.getPresentation() + self.presentation.Display = \ + self.controller.plugin.renderManager.screens.current_display + 1 + self.control = None + self.create_thumbnails() + return True + + def create_thumbnails(self): + """ + 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'/').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) + doc = self.document + pages = doc.getDrawPages() + 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) + 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') + try: + doc.storeToURL(urlpath, props) + self.convert_thumbnail(path, idx + 1) + if os.path.exists(path): + os.remove(path) + except: + log.exception(u'%s - Unable to store openoffice preview' % path) + + def create_property(self, name, value): + """ + 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') + else: + prop = PropertyValue() + prop.Name = name + prop.Value = value + return prop + + def close_presentation(self): + """ + 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: + if self.presentation: + try: + self.presentation.end() + self.presentation = None + self.document.dispose() + except: + #We tried! + pass + self.document = None + self.controller.remove_doc(self) + + def is_loaded(self): + """ + Returns true if a presentation is loaded + """ + log.debug(u'is loaded OpenOffice') + #print "is_loaded " + if self.presentation is None or self.document is None: + #print "no present or document" + return False + try: + if self.document.getPresentation() is None: + #print "no getPresentation" + return False + except: + return False + return True + + def is_active(self): + """ + Returns true if a presentation is active and running + """ + log.debug(u'is active OpenOffice') + #print "is_active " + if not self.is_loaded(): + #print "False " + return False + #print "self.con ", self.control + if self.control is None: + return False + return True + + def unblank_screen(self): + """ + Unblanks the screen + """ + log.debug(u'unblank screen OpenOffice') + return self.control.resume() + + def blank_screen(self): + """ + Blanks the screen + """ + log.debug(u'blank screen OpenOffice') + self.control.blankScreen(0) + + def is_blank(self): + """ + Returns true if screen is blank + """ + log.debug(u'is blank OpenOffice') + if self.control: + return self.control.isPaused() + else: + return False + + def stop_presentation(self): + """ + Stop the presentation, remove from screen + """ + log.debug(u'stop presentation OpenOffice') + # deactivate should hide the screen according to docs, but doesn't + #self.control.deactivate() + self.presentation.end() + self.control = None + + def start_presentation(self): + """ + 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() + # start() returns before the getCurrentComponent is ready. + # Try for 5 seconds + i = 1 + while self.desktop.getCurrentComponent() is None and i < 50: + time.sleep(0.1) + i = i + 1 + self.control = \ + self.desktop.getCurrentComponent().Presentation.getController() + else: + self.control.activate() + self.goto_slide(1) + + def get_slide_number(self): + """ + 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 self.document.getDrawPages().getCount() + + def goto_slide(self, slideno): + """ + 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 + """ + self.control.gotoNextEffect() + + def previous_step(self): + """ + Triggers the previous slide on the running presentation + """ + self.control.gotoPreviousSlide() + + def get_slide_text(self, slide_no): + """ + Returns the text on the slide + + ``slide_no`` + The slide the text is required for, starting at 1 + """ + doc = self.document + pages = doc.getDrawPages() + text = '' + page = pages.getByIndex(slide_no - 1) + for idx in range(page.getCount()): + shape = page.getByIndex(idx) + if shape.supportsService("com.sun.star.drawing.Text"): + text += shape.getString() + '\n' + return text + + def get_slide_notes(self, slide_no): + """ + Returns the text on the slide + + ``slide_no`` + The slide the notes are required for, starting at 1 + """ + doc = self.document + pages = doc.getDrawPages() + text = '' + page = pages.getByIndex(slide_no - 1) + notes = page.getNotesPage() + for idx in range(notes.getCount()): + shape = notes.getByIndex(idx) + 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 25e02dfc9..3587cc0c4 100644 --- a/openlp/plugins/presentations/lib/mediaitem.py +++ b/openlp/plugins/presentations/lib/mediaitem.py @@ -131,7 +131,7 @@ class PresentationMediaItem(MediaManagerItem): self.listView.setIconSize(QtCore.QSize(88, 50)) list = SettingsManager.load_list( self.settingsSection, u'presentations') - self.loadList(list) + self.loadList(list, True) for item in self.controllers: #load the drop down selection if self.controllers[item].enabled: @@ -140,7 +140,7 @@ class PresentationMediaItem(MediaManagerItem): self.DisplayTypeComboBox.insertItem(0, self.Automatic) self.DisplayTypeComboBox.setCurrentIndex(0) - def loadList(self, list): + def loadList(self, list, initialLoad=False): """ Add presentations into the media manager This is called both on initial load of the plugin to populate with @@ -155,34 +155,39 @@ class PresentationMediaItem(MediaManagerItem): continue filename = os.path.split(unicode(file))[1] if titles.count(filename) > 0: - QtGui.QMessageBox.critical( - self, translate('PresentationPlugin.MediaItem', - 'File exists'), - translate('PresentationPlugin.MediaItem', - 'A presentation with that filename already exists.'), - QtGui.QMessageBox.Ok) + if not initialLoad: + QtGui.QMessageBox.critical( + self, translate('PresentationPlugin.MediaItem', + 'File exists'), + translate('PresentationPlugin.MediaItem', + 'A presentation with that filename already exists.'), + QtGui.QMessageBox.Ok) continue controller_name = self.findControllerByType(filename) - if not controller_name: - QtGui.QMessageBox.critical( - self, translate('PresentationPlugin.MediaItem', - 'Unsupported file'), - translate('PresentationPlugin.MediaItem', - 'This type of presentation is not supported'), - QtGui.QMessageBox.Ok) - continue - controller = self.controllers[controller_name] - doc = controller.add_doc(unicode(file)) - thumb = os.path.join(doc.get_thumbnail_folder(), u'icon.png') - preview = doc.get_thumbnail_path(1, True) - if not preview: - doc.load_presentation() + if controller_name: + controller = self.controllers[controller_name] + doc = controller.add_doc(unicode(file)) + thumb = os.path.join(doc.get_thumbnail_folder(), u'icon.png') preview = doc.get_thumbnail_path(1, True) - doc.close_presentation() - if preview and self.validate(preview, thumb): - icon = build_icon(thumb) + if not preview and not initialLoad: + doc.load_presentation() + preview = doc.get_thumbnail_path(1, True) + doc.close_presentation() + if preview and self.validate(preview, thumb): + icon = build_icon(thumb) + else: + icon = build_icon(u':/general/general_delete.png') else: - icon = build_icon(u':/general/general_delete.png') + if initialLoad: + icon = build_icon(u':/general/general_delete.png') + else: + QtGui.QMessageBox.critical( + self, translate('PresentationPlugin.MediaItem', + 'Unsupported file'), + translate('PresentationPlugin.MediaItem', + 'This type of presentation is not supported'), + QtGui.QMessageBox.Ok) + continue item_name = QtGui.QListWidgetItem(filename) item_name.setData(QtCore.Qt.UserRole, QtCore.QVariant(file)) item_name.setIcon(icon) diff --git a/openlp/plugins/presentations/lib/pptviewcontroller.py b/openlp/plugins/presentations/lib/pptviewcontroller.py index e3f945d45..2810c88d2 100644 --- a/openlp/plugins/presentations/lib/pptviewcontroller.py +++ b/openlp/plugins/presentations/lib/pptviewcontroller.py @@ -130,9 +130,11 @@ class PptviewDocument(PresentationDocument): rect = rendermanager.screens.current[u'size'] rect = RECT(rect.x(), rect.y(), rect.right(), rect.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()) + '\\') - if self.pptid: + str(self.get_temp_folder()) + '\\slide') + if self.pptid >= 0: self.create_thumbnails() self.stop_presentation() return True @@ -147,8 +149,8 @@ class PptviewDocument(PresentationDocument): if self.check_thumbnails(): return for idx in range(self.get_slide_count()): - path = u'%s\\%s.bmp' % (self.get_temp_folder(), unicode(idx + 1)) - self.convert_image(path, idx) + path = u'%s\\slide%s.bmp' % (self.get_temp_folder(), unicode(idx + 1)) + self.convert_thumbnail(path, idx + 1) def close_presentation(self): """ From bff74507d7f36e72eff9b580abe0f69240cc0b5b Mon Sep 17 00:00:00 2001 From: Jonathan Corwin Date: Sun, 11 Jul 2010 21:53:53 +0100 Subject: [PATCH 6/6] Coding standards --- openlp/core/lib/__init__.py | 2 +- .../presentations/lib/impresscontroller.py | 936 +++++++++--------- .../presentations/presentationplugin.py | 1 + 3 files changed, 470 insertions(+), 469 deletions(-) diff --git a/openlp/core/lib/__init__.py b/openlp/core/lib/__init__.py index 7659a2889..f62778820 100644 --- a/openlp/core/lib/__init__.py +++ b/openlp/core/lib/__init__.py @@ -174,7 +174,7 @@ def resize_image(image, width, height): """ preview = QtGui.QImage(image) if not preview.isNull(): - if(preview.width() == width and preview.height == height): + if preview.width() == width and preview.height == height: return preview preview = preview.scaled(width, height, QtCore.Qt.KeepAspectRatio, QtCore.Qt.SmoothTransformation) diff --git a/openlp/plugins/presentations/lib/impresscontroller.py b/openlp/plugins/presentations/lib/impresscontroller.py index f3c4cb68c..30a95e3b8 100644 --- a/openlp/plugins/presentations/lib/impresscontroller.py +++ b/openlp/plugins/presentations/lib/impresscontroller.py @@ -1,468 +1,468 @@ -# -*- coding: utf-8 -*- -# vim: autoindent shiftwidth=4 expandtab textwidth=80 tabstop=4 softtabstop=4 - -############################################################################### -# OpenLP - Open Source Lyrics Projection # -# --------------------------------------------------------------------------- # -# Copyright (c) 2008-2010 Raoul Snyman # -# Portions copyright (c) 2008-2010 Tim Bentley, Jonathan Corwin, Michael # -# Gorven, Scott Guerrieri, Christian Richter, Maikel Stuivenberg, Martin # -# Thompson, Jon Tibble, Carsten Tinggaard # -# --------------------------------------------------------------------------- # -# 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 # -############################################################################### - -# OOo API documentation: -# http://api.openoffice.org/docs/common/ref/com/sun/star/presentation/XSlideShowController.html -# http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/ProUNO/Basic/Getting_Information_about_UNO_Objects#Inspecting_interfaces_during_debugging -# http://docs.go-oo.org/sd/html/classsd_1_1SlideShow.html -# http://www.oooforum.org/forum/viewtopic.phtml?t=5252 -# http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Working_with_Presentations -# http://mail.python.org/pipermail/python-win32/2008-January/006676.html -# http://www.linuxjournal.com/content/starting-stopping-and-connecting-openoffice-python -# http://nxsy.org/comparing-documents-with-openoffice-and-python - -import logging -import os -import time - -from openlp.core.lib import resize_image - -if os.name == u'nt': - from win32com.client import Dispatch - import pywintypes -else: - try: - import uno - from com.sun.star.beans import PropertyValue - uno_available = True - except ImportError: - uno_available = False - -from PyQt4 import QtCore - -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 - """ - log.info(u'ImpressController loaded') - - def __init__(self, plugin): - """ - Initialise the class - """ - log.debug(u'Initialising') - PresentationController.__init__(self, plugin, u'Impress') - self.supports = [u'.odp'] - self.alsosupports = [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 - """ - log.debug(u'check_available') - if os.name == u'nt': - return self.get_com_servicemanager() is not None - else: - return uno_available - - 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. - """ - log.debug(u'start process Openoffice') - if os.name == u'nt': - self.manager = self.get_com_servicemanager() - self.manager._FlagAsMethod(u'Bridge_GetStruct') - self.manager._FlagAsMethod(u'Bridge_GetValueObject') - else: - # -headless - cmd = u'openoffice.org -nologo -norestore -minimized -invisible -nofirststartwizard -accept="socket,host=localhost,port=2002;urp;"' - self.process = QtCore.QProcess() - self.process.startDetached(cmd) - self.process.waitForStarted() - - def get_uno_desktop(self): - """ - On non-Windows platforms, use Uno. Get the OpenOffice desktop - which will be used to manage impress - """ - log.debug(u'get UNO Desktop Openoffice') - ctx = None - loop = 0 - log.debug(u'get UNO Desktop Openoffice - getComponentContext') - context = uno.getComponentContext() - log.debug(u'get UNO Desktop Openoffice - createInstaneWithContext - ' - u'UnoUrlResolver') - resolver = context.ServiceManager.createInstanceWithContext( - u'com.sun.star.bridge.UnoUrlResolver', context) - while ctx is None and loop < 3: - try: - log.debug(u'get UNO Desktop Openoffice - resolve') - ctx = resolver.resolve(u'uno:socket,host=localhost,port=2002;' - u'urp;StarOffice.ComponentContext') - except: - log.exception(u'Unable to find running instance ') - self.start_process() - loop += 1 - try: - self.manager = ctx.ServiceManager - log.debug(u'get UNO Desktop Openoffice - createInstanceWithContext' - u' - Desktop') - desktop = self.manager.createInstanceWithContext( - "com.sun.star.frame.Desktop", ctx ) - return desktop - except: - log.exception(u'Failed to get UNO desktop') - return None - - def get_com_desktop(self): - """ - 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: - return None - return self.manager.createInstance(u'com.sun.star.frame.Desktop') - - def get_com_servicemanager(self): - """ - Return the OOo service manager for windows - """ - log.debug(u'get_com_servicemanager openoffice') - try: - return Dispatch(u'com.sun.star.ServiceManager') - except pywintypes.com_error: - log.exception(u'Failed to get COM service manager') - return None - - def kill(self): - """ - Called at system exit to clean up any running presentations - """ - log.debug(u'Kill OpenOffice') - while self.docs: - self.docs[0].close_presentation() - if os.name != u'nt': - desktop = self.get_uno_desktop() - else: - desktop = self.get_com_desktop() - #Sometimes we get a failure and desktop is None - if not desktop: - log.exception(u'Failed to terminate OpenOffice') - return - docs = desktop.getComponents() - if docs.hasElements(): - log.debug(u'OpenOffice not terminated') - else: - try: - desktop.terminate() - log.debug(u'OpenOffice killed') - except: - log.exception(u'Failed to terminate OpenOffice') - - def add_doc(self, name): - """ - Called when a new Impress document is opened - """ - log.debug(u'Add Doc OpenOffice') - doc = ImpressDocument(self, name) - self.docs.append(doc) - return doc - -class ImpressDocument(PresentationDocument): - """ - Class which holds information and controls a single presentation - """ - - def __init__(self, controller, presentation): - """ - Constructor, store information about the file and initialise - """ - log.debug(u'Init Presentation OpenOffice') - PresentationDocument.__init__(self, controller, presentation) - self.document = None - self.presentation = None - self.control = None - - 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. - - ``presentation`` - The file name of the presentatios to the run. - """ - log.debug(u'Load Presentation OpenOffice') - #print "s.dsk1 ", self.desktop - if os.name == u'nt': - desktop = self.controller.get_com_desktop() - if desktop is None: - self.controller.start_process() - desktop = self.controller.get_com_desktop() - url = u'file:///' + self.filepath.replace(u'\\', u'/').replace( - u':', u'|').replace(u' ', u'%20') - else: - desktop = self.controller.get_uno_desktop() - url = uno.systemPathToFileUrl(self.filepath) - if desktop is None: - return False - self.desktop = desktop - properties = [] - properties.append(self.create_property(u'Minimized', True)) - properties = tuple(properties) - try: - self.document = desktop.loadComponentFromURL(url, u'_blank', - 0, properties) - except: - log.exception(u'Failed to load presentation') - return False - self.presentation = self.document.getPresentation() - self.presentation.Display = \ - self.controller.plugin.renderManager.screens.current_display + 1 - self.control = None - self.create_thumbnails() - return True - - def create_thumbnails(self): - """ - 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'/').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) - doc = self.document - pages = doc.getDrawPages() - 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) - 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') - try: - doc.storeToURL(urlpath, props) - self.convert_thumbnail(path, idx + 1) - if os.path.exists(path): - os.remove(path) - except: - log.exception(u'%s - Unable to store openoffice preview' % path) - - def create_property(self, name, value): - """ - 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') - else: - prop = PropertyValue() - prop.Name = name - prop.Value = value - return prop - - def close_presentation(self): - """ - 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: - if self.presentation: - try: - self.presentation.end() - self.presentation = None - self.document.dispose() - except: - #We tried! - pass - self.document = None - self.controller.remove_doc(self) - - def is_loaded(self): - """ - Returns true if a presentation is loaded - """ - log.debug(u'is loaded OpenOffice') - #print "is_loaded " - if self.presentation is None or self.document is None: - #print "no present or document" - return False - try: - if self.document.getPresentation() is None: - #print "no getPresentation" - return False - except: - return False - return True - - def is_active(self): - """ - Returns true if a presentation is active and running - """ - log.debug(u'is active OpenOffice') - #print "is_active " - if not self.is_loaded(): - #print "False " - return False - #print "self.con ", self.control - if self.control is None: - return False - return True - - def unblank_screen(self): - """ - Unblanks the screen - """ - log.debug(u'unblank screen OpenOffice') - return self.control.resume() - - def blank_screen(self): - """ - Blanks the screen - """ - log.debug(u'blank screen OpenOffice') - self.control.blankScreen(0) - - def is_blank(self): - """ - Returns true if screen is blank - """ - log.debug(u'is blank OpenOffice') - if self.control: - return self.control.isPaused() - else: - return False - - def stop_presentation(self): - """ - Stop the presentation, remove from screen - """ - log.debug(u'stop presentation OpenOffice') - # deactivate should hide the screen according to docs, but doesn't - #self.control.deactivate() - self.presentation.end() - self.control = None - - def start_presentation(self): - """ - 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() - # start() returns before the getCurrentComponent is ready. - # Try for 5 seconds - i = 1 - while self.desktop.getCurrentComponent() is None and i < 50: - time.sleep(0.1) - i = i + 1 - self.control = \ - self.desktop.getCurrentComponent().Presentation.getController() - else: - self.control.activate() - self.goto_slide(1) - - def get_slide_number(self): - """ - 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 self.document.getDrawPages().getCount() - - def goto_slide(self, slideno): - """ - 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 - """ - self.control.gotoNextEffect() - - def previous_step(self): - """ - Triggers the previous slide on the running presentation - """ - self.control.gotoPreviousSlide() - - def get_slide_text(self, slide_no): - """ - Returns the text on the slide - - ``slide_no`` - The slide the text is required for, starting at 1 - """ - doc = self.document - pages = doc.getDrawPages() - text = '' - page = pages.getByIndex(slide_no - 1) - for idx in range(page.getCount()): - shape = page.getByIndex(idx) - if shape.supportsService("com.sun.star.drawing.Text"): - text += shape.getString() + '\n' - return text - - def get_slide_notes(self, slide_no): - """ - Returns the text on the slide - - ``slide_no`` - The slide the notes are required for, starting at 1 - """ - doc = self.document - pages = doc.getDrawPages() - text = '' - page = pages.getByIndex(slide_no - 1) - notes = page.getNotesPage() - for idx in range(notes.getCount()): - shape = notes.getByIndex(idx) - if shape.supportsService("com.sun.star.drawing.Text"): - text += shape.getString() + '\n' - return text - +# -*- coding: utf-8 -*- +# vim: autoindent shiftwidth=4 expandtab textwidth=80 tabstop=4 softtabstop=4 + +############################################################################### +# OpenLP - Open Source Lyrics Projection # +# --------------------------------------------------------------------------- # +# Copyright (c) 2008-2010 Raoul Snyman # +# Portions copyright (c) 2008-2010 Tim Bentley, Jonathan Corwin, Michael # +# Gorven, Scott Guerrieri, Christian Richter, Maikel Stuivenberg, Martin # +# Thompson, Jon Tibble, Carsten Tinggaard # +# --------------------------------------------------------------------------- # +# 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 # +############################################################################### + +# OOo API documentation: +# http://api.openoffice.org/docs/common/ref/com/sun/star/presentation/XSlideShowController.html +# http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/ProUNO/Basic/Getting_Information_about_UNO_Objects#Inspecting_interfaces_during_debugging +# http://docs.go-oo.org/sd/html/classsd_1_1SlideShow.html +# http://www.oooforum.org/forum/viewtopic.phtml?t=5252 +# http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Working_with_Presentations +# http://mail.python.org/pipermail/python-win32/2008-January/006676.html +# http://www.linuxjournal.com/content/starting-stopping-and-connecting-openoffice-python +# http://nxsy.org/comparing-documents-with-openoffice-and-python + +import logging +import os +import time + +from openlp.core.lib import resize_image + +if os.name == u'nt': + from win32com.client import Dispatch + import pywintypes +else: + try: + import uno + from com.sun.star.beans import PropertyValue + uno_available = True + except ImportError: + uno_available = False + +from PyQt4 import QtCore + +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 + """ + log.info(u'ImpressController loaded') + + def __init__(self, plugin): + """ + Initialise the class + """ + log.debug(u'Initialising') + PresentationController.__init__(self, plugin, u'Impress') + self.supports = [u'.odp'] + self.alsosupports = [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 + """ + log.debug(u'check_available') + if os.name == u'nt': + return self.get_com_servicemanager() is not None + else: + return uno_available + + 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. + """ + log.debug(u'start process Openoffice') + if os.name == u'nt': + self.manager = self.get_com_servicemanager() + self.manager._FlagAsMethod(u'Bridge_GetStruct') + self.manager._FlagAsMethod(u'Bridge_GetValueObject') + else: + # -headless + cmd = u'openoffice.org -nologo -norestore -minimized -invisible -nofirststartwizard -accept="socket,host=localhost,port=2002;urp;"' + self.process = QtCore.QProcess() + self.process.startDetached(cmd) + self.process.waitForStarted() + + def get_uno_desktop(self): + """ + On non-Windows platforms, use Uno. Get the OpenOffice desktop + which will be used to manage impress + """ + log.debug(u'get UNO Desktop Openoffice') + ctx = None + loop = 0 + log.debug(u'get UNO Desktop Openoffice - getComponentContext') + context = uno.getComponentContext() + log.debug(u'get UNO Desktop Openoffice - createInstaneWithContext - ' + u'UnoUrlResolver') + resolver = context.ServiceManager.createInstanceWithContext( + u'com.sun.star.bridge.UnoUrlResolver', context) + while ctx is None and loop < 3: + try: + log.debug(u'get UNO Desktop Openoffice - resolve') + ctx = resolver.resolve(u'uno:socket,host=localhost,port=2002;' + u'urp;StarOffice.ComponentContext') + except: + log.exception(u'Unable to find running instance ') + self.start_process() + loop += 1 + try: + self.manager = ctx.ServiceManager + log.debug(u'get UNO Desktop Openoffice - createInstanceWithContext' + u' - Desktop') + desktop = self.manager.createInstanceWithContext( + "com.sun.star.frame.Desktop", ctx ) + return desktop + except: + log.exception(u'Failed to get UNO desktop') + return None + + def get_com_desktop(self): + """ + 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: + return None + return self.manager.createInstance(u'com.sun.star.frame.Desktop') + + def get_com_servicemanager(self): + """ + Return the OOo service manager for windows + """ + log.debug(u'get_com_servicemanager openoffice') + try: + return Dispatch(u'com.sun.star.ServiceManager') + except pywintypes.com_error: + log.exception(u'Failed to get COM service manager') + return None + + def kill(self): + """ + Called at system exit to clean up any running presentations + """ + log.debug(u'Kill OpenOffice') + while self.docs: + self.docs[0].close_presentation() + if os.name != u'nt': + desktop = self.get_uno_desktop() + else: + desktop = self.get_com_desktop() + #Sometimes we get a failure and desktop is None + if not desktop: + log.exception(u'Failed to terminate OpenOffice') + return + docs = desktop.getComponents() + if docs.hasElements(): + log.debug(u'OpenOffice not terminated') + else: + try: + desktop.terminate() + log.debug(u'OpenOffice killed') + except: + log.exception(u'Failed to terminate OpenOffice') + + def add_doc(self, name): + """ + Called when a new Impress document is opened + """ + log.debug(u'Add Doc OpenOffice') + doc = ImpressDocument(self, name) + self.docs.append(doc) + return doc + +class ImpressDocument(PresentationDocument): + """ + Class which holds information and controls a single presentation + """ + + def __init__(self, controller, presentation): + """ + Constructor, store information about the file and initialise + """ + log.debug(u'Init Presentation OpenOffice') + PresentationDocument.__init__(self, controller, presentation) + self.document = None + self.presentation = None + self.control = None + + 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. + + ``presentation`` + The file name of the presentatios to the run. + """ + log.debug(u'Load Presentation OpenOffice') + #print "s.dsk1 ", self.desktop + if os.name == u'nt': + desktop = self.controller.get_com_desktop() + if desktop is None: + self.controller.start_process() + desktop = self.controller.get_com_desktop() + url = u'file:///' + self.filepath.replace(u'\\', u'/').replace( + u':', u'|').replace(u' ', u'%20') + else: + desktop = self.controller.get_uno_desktop() + url = uno.systemPathToFileUrl(self.filepath) + if desktop is None: + return False + self.desktop = desktop + properties = [] + properties.append(self.create_property(u'Minimized', True)) + properties = tuple(properties) + try: + self.document = desktop.loadComponentFromURL(url, u'_blank', + 0, properties) + except: + log.exception(u'Failed to load presentation') + return False + self.presentation = self.document.getPresentation() + self.presentation.Display = \ + self.controller.plugin.renderManager.screens.current_display + 1 + self.control = None + self.create_thumbnails() + return True + + def create_thumbnails(self): + """ + 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'/').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) + doc = self.document + pages = doc.getDrawPages() + 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) + 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') + try: + doc.storeToURL(urlpath, props) + self.convert_thumbnail(path, idx + 1) + if os.path.exists(path): + os.remove(path) + except: + log.exception(u'%s - Unable to store openoffice preview' % path) + + def create_property(self, name, value): + """ + 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') + else: + prop = PropertyValue() + prop.Name = name + prop.Value = value + return prop + + def close_presentation(self): + """ + 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: + if self.presentation: + try: + self.presentation.end() + self.presentation = None + self.document.dispose() + except: + #We tried! + pass + self.document = None + self.controller.remove_doc(self) + + def is_loaded(self): + """ + Returns true if a presentation is loaded + """ + log.debug(u'is loaded OpenOffice') + #print "is_loaded " + if self.presentation is None or self.document is None: + #print "no present or document" + return False + try: + if self.document.getPresentation() is None: + #print "no getPresentation" + return False + except: + return False + return True + + def is_active(self): + """ + Returns true if a presentation is active and running + """ + log.debug(u'is active OpenOffice') + #print "is_active " + if not self.is_loaded(): + #print "False " + return False + #print "self.con ", self.control + if self.control is None: + return False + return True + + def unblank_screen(self): + """ + Unblanks the screen + """ + log.debug(u'unblank screen OpenOffice') + return self.control.resume() + + def blank_screen(self): + """ + Blanks the screen + """ + log.debug(u'blank screen OpenOffice') + self.control.blankScreen(0) + + def is_blank(self): + """ + Returns true if screen is blank + """ + log.debug(u'is blank OpenOffice') + if self.control: + return self.control.isPaused() + else: + return False + + def stop_presentation(self): + """ + Stop the presentation, remove from screen + """ + log.debug(u'stop presentation OpenOffice') + # deactivate should hide the screen according to docs, but doesn't + #self.control.deactivate() + self.presentation.end() + self.control = None + + def start_presentation(self): + """ + 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() + # start() returns before the getCurrentComponent is ready. + # Try for 5 seconds + i = 1 + while self.desktop.getCurrentComponent() is None and i < 50: + time.sleep(0.1) + i = i + 1 + self.control = \ + self.desktop.getCurrentComponent().Presentation.getController() + else: + self.control.activate() + self.goto_slide(1) + + def get_slide_number(self): + """ + 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 self.document.getDrawPages().getCount() + + def goto_slide(self, slideno): + """ + 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 + """ + self.control.gotoNextEffect() + + def previous_step(self): + """ + Triggers the previous slide on the running presentation + """ + self.control.gotoPreviousSlide() + + def get_slide_text(self, slide_no): + """ + Returns the text on the slide + + ``slide_no`` + The slide the text is required for, starting at 1 + """ + doc = self.document + pages = doc.getDrawPages() + text = '' + page = pages.getByIndex(slide_no - 1) + for idx in range(page.getCount()): + shape = page.getByIndex(idx) + if shape.supportsService("com.sun.star.drawing.Text"): + text += shape.getString() + '\n' + return text + + def get_slide_notes(self, slide_no): + """ + Returns the text on the slide + + ``slide_no`` + The slide the notes are required for, starting at 1 + """ + doc = self.document + pages = doc.getDrawPages() + text = '' + page = pages.getByIndex(slide_no - 1) + notes = page.getNotesPage() + for idx in range(notes.getCount()): + shape = notes.getByIndex(idx) + if shape.supportsService("com.sun.star.drawing.Text"): + text += shape.getString() + '\n' + return text + diff --git a/openlp/plugins/presentations/presentationplugin.py b/openlp/plugins/presentations/presentationplugin.py index 5369515b3..50784ed51 100644 --- a/openlp/plugins/presentations/presentationplugin.py +++ b/openlp/plugins/presentations/presentationplugin.py @@ -138,3 +138,4 @@ class PresentationPlugin(Plugin): 'programs. The choice of available presentation programs is ' 'available to the user in a drop down box.') return about_text +