forked from openlp/openlp
391 lines
12 KiB
Python
391 lines
12 KiB
Python
# -*- 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 #
|
|
###############################################################################
|
|
|
|
import logging
|
|
import os
|
|
import shutil
|
|
|
|
from PyQt4 import QtCore
|
|
|
|
from openlp.core.lib import Receiver
|
|
from openlp.core.utils import AppLocation
|
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
class PresentationController(object):
|
|
"""
|
|
Base class for presentation controllers to inherit from
|
|
Class to control interactions with presentations.
|
|
It creates the runtime environment
|
|
To create a new controller, take a copy of this file and name it
|
|
so it ends in controller.py, i.e. foobarcontroller.py
|
|
Make sure it inherits PresentationController
|
|
Then fill in the blanks. If possible try and make sure it loads
|
|
on all platforms, using for example os.name checks, although
|
|
__init__, check_available and presentation_deleted should always work.
|
|
See impresscontroller, powerpointcontroller or pptviewcontroller
|
|
for examples.
|
|
|
|
**Basic Attributes**
|
|
|
|
``name``
|
|
The name that appears in the options and the media manager
|
|
|
|
``enabled``
|
|
The controller is enabled
|
|
|
|
``available``
|
|
The controller is available on this machine. Set by init via
|
|
call to check_available
|
|
|
|
``plugin``
|
|
The presentationplugin object
|
|
|
|
**Hook Functions**
|
|
|
|
``kill()``
|
|
Called at system exit to clean up any running presentations
|
|
|
|
``check_available()``
|
|
Returns True if presentation application is installed/can run on this
|
|
machine
|
|
|
|
``presentation_deleted()``
|
|
Deletes presentation specific files, e.g. thumbnails
|
|
|
|
"""
|
|
log.info(u'PresentationController loaded')
|
|
|
|
def __init__(self, plugin=None, name=u'PresentationController'):
|
|
"""
|
|
This is the constructor for the presentationcontroller object. This
|
|
provides an easy way for descendent plugins to populate common data.
|
|
This method *must* be overridden, like so::
|
|
|
|
class MyPresentationController(PresentationController):
|
|
def __init__(self, plugin):
|
|
PresentationController.__init(
|
|
self, plugin, u'My Presenter App')
|
|
|
|
``plugin``
|
|
Defaults to *None*. The presentationplugin object
|
|
|
|
``name``
|
|
Name of the application, to appear in the application
|
|
"""
|
|
self.supports = []
|
|
self.alsosupports = []
|
|
self.docs = []
|
|
self.plugin = plugin
|
|
self.name = name
|
|
self.settings_section = self.plugin.settings_section
|
|
self.available = self.check_available()
|
|
if self.available:
|
|
self.enabled = QtCore.QSettings().value(
|
|
self.settings_section + u'/' + name,
|
|
QtCore.Qt.Unchecked).toInt()[0] == QtCore.Qt.Checked
|
|
else:
|
|
self.enabled = False
|
|
self.thumbnailroot = 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)
|
|
|
|
def check_available(self):
|
|
"""
|
|
Presentation app is able to run on this machine
|
|
"""
|
|
return False
|
|
|
|
def start_process(self):
|
|
"""
|
|
Loads a running version of the presentation application in the background.
|
|
"""
|
|
pass
|
|
|
|
def kill(self):
|
|
"""
|
|
Called at system exit to clean up any running presentations and
|
|
close the application
|
|
"""
|
|
log.debug(u'Kill')
|
|
self.close_presentation()
|
|
|
|
def add_doc(self, name):
|
|
"""
|
|
Called when a new presentation document is opened
|
|
"""
|
|
doc = PresentationDocument(self, name)
|
|
self.docs.append(doc)
|
|
return doc
|
|
|
|
def remove_doc(self, doc=None):
|
|
"""
|
|
Called to remove an open document from the collection
|
|
"""
|
|
log.debug(u'remove_doc Presentation')
|
|
if doc is None:
|
|
return
|
|
if doc in self.docs:
|
|
self.docs.remove(doc)
|
|
|
|
def close_presentation(self):
|
|
pass
|
|
|
|
class PresentationDocument(object):
|
|
"""
|
|
Base class for presentation documents to inherit from.
|
|
Loads and closes the presentation as well as triggering the correct
|
|
activities based on the users input
|
|
|
|
**Hook Functions**
|
|
|
|
``load_presentation(presentation)``
|
|
Load a presentation file
|
|
|
|
``close_presentation()``
|
|
Close presentation and clean up objects
|
|
|
|
``presentation_loaded()``
|
|
Returns True if presentation is currently loaded
|
|
|
|
``is_active()``
|
|
Returns True if a presentation is currently running
|
|
|
|
``blank_screen()``
|
|
Blanks the screen, making it black.
|
|
|
|
``unblank_screen()``
|
|
Unblanks the screen, restoring the output
|
|
|
|
``is_blank``
|
|
Returns true if screen is blank
|
|
|
|
``stop_presentation()``
|
|
Stops the presentation, removing it from the output display
|
|
|
|
``start_presentation()``
|
|
Starts the presentation from the beginning
|
|
|
|
``get_slide_number()``
|
|
Returns the current slide number, from 1
|
|
|
|
``get_slide_count()``
|
|
Returns total number of slides
|
|
|
|
``goto_slide(slide_no)``
|
|
Jumps directly to the requested slide.
|
|
|
|
``next_step()``
|
|
Triggers the next effect of slide on the running presentation
|
|
|
|
``previous_step()``
|
|
Triggers the previous slide on the running presentation
|
|
|
|
``get_slide_preview_file(slide_no)``
|
|
Returns a path to an image containing a preview for the requested slide
|
|
|
|
"""
|
|
def __init__(self, controller, name):
|
|
self.slidenumber = 0
|
|
self.controller = controller
|
|
self.store_filename(name)
|
|
|
|
def load_presentation(self):
|
|
"""
|
|
Called when a presentation is added to the SlideController.
|
|
Loads the presentation and starts it
|
|
|
|
``presentation``
|
|
The file name of the presentations to the run.
|
|
|
|
"""
|
|
pass
|
|
|
|
def presentation_deleted(self):
|
|
"""
|
|
Cleans up/deletes any controller specific files created for
|
|
a file, e.g. thumbnails
|
|
"""
|
|
shutil.rmtree(self.thumbnailpath)
|
|
|
|
def store_filename(self, presentation):
|
|
"""
|
|
Set properties for the filename and thumbnail paths
|
|
"""
|
|
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)
|
|
|
|
def get_file_name(self, presentation):
|
|
return os.path.split(presentation)[1]
|
|
|
|
def get_thumbnail_path(self, presentation):
|
|
return os.path.join(
|
|
self.controller.thumbnailroot, self.get_file_name(presentation))
|
|
|
|
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())
|
|
if not (lastimage and os.path.isfile(lastimage)):
|
|
return False
|
|
imgdate = os.stat(lastimage).st_mtime
|
|
pptdate = os.stat(self.filepath).st_mtime
|
|
return imgdate >= pptdate
|
|
|
|
def close_presentation(self):
|
|
"""
|
|
Close presentation and clean up objects
|
|
Triggered by new object being added to SlideController
|
|
"""
|
|
self.controller.close_presentation()
|
|
|
|
def is_active(self):
|
|
"""
|
|
Returns True if a presentation is currently running
|
|
"""
|
|
return False
|
|
|
|
def is_loaded(self):
|
|
"""
|
|
Returns true if a presentation is loaded
|
|
"""
|
|
return False
|
|
|
|
def blank_screen(self):
|
|
"""
|
|
Blanks the screen, making it black.
|
|
"""
|
|
pass
|
|
|
|
def unblank_screen(self):
|
|
"""
|
|
Unblanks (restores) the presentationn
|
|
"""
|
|
pass
|
|
|
|
def is_blank(self):
|
|
"""
|
|
Returns true if screen is blank
|
|
"""
|
|
return False
|
|
|
|
def stop_presentation(self):
|
|
"""
|
|
Stops the presentation, removing it from the output display
|
|
"""
|
|
pass
|
|
|
|
def start_presentation(self):
|
|
"""
|
|
Starts the presentation from the beginning
|
|
"""
|
|
pass
|
|
|
|
def get_slide_number(self):
|
|
"""
|
|
Returns the current slide number, from 1
|
|
"""
|
|
return 0
|
|
|
|
def get_slide_count(self):
|
|
"""
|
|
Returns total number of slides
|
|
"""
|
|
return 0
|
|
|
|
def goto_slide(self, slide_no):
|
|
"""
|
|
Jumps directly to the requested slide.
|
|
|
|
``slide_no``
|
|
The slide to jump to, starting at 1
|
|
"""
|
|
pass
|
|
|
|
def next_step(self):
|
|
"""
|
|
Triggers the next effect of slide on the running presentation
|
|
This might be the next animation on the current slide, or the next slide
|
|
"""
|
|
pass
|
|
|
|
def previous_step(self):
|
|
"""
|
|
Triggers the previous slide on the running presentation
|
|
"""
|
|
pass
|
|
|
|
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
|
|
"""
|
|
return None
|
|
|
|
def poll_slidenumber(self, is_live):
|
|
"""
|
|
Check the current slide number
|
|
"""
|
|
if not self.is_active():
|
|
return
|
|
current = self.get_slide_number()
|
|
if current == self.slidenumber:
|
|
return
|
|
self.slidenumber = current
|
|
if is_live:
|
|
prefix = u'live'
|
|
else:
|
|
prefix = u'preview'
|
|
Receiver.send_message(u'slidecontroller_%s_change' % prefix,
|
|
self.slidenumber - 1)
|
|
|
|
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
|
|
"""
|
|
return ''
|
|
|
|
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
|
|
"""
|
|
return ''
|