openlp/openlp/core/ui/printserviceform.py

# -*- coding: utf-8 -*-
# vim: autoindent shiftwidth=4 expandtab textwidth=80 tabstop=4 softtabstop=4

###############################################################################
# OpenLP - Open Source Lyrics Projection                                      #
# --------------------------------------------------------------------------- #
# Copyright (c) 2008-2011 Raoul Snyman                                        #
# Portions copyright (c) 2008-2011 Tim Bentley, Jonathan Corwin, Michael      #
# Gorven, Scott Guerrieri, Matthias Hub, Meinert Jordan, Armin Köhler,        #
# Andreas Preikschat, Mattias Põldaru, Christian Richter, Philip Ridout,      #
# Maikel Stuivenberg, Martin Thompson, Jon Tibble, Frode Woldsund             #
# --------------------------------------------------------------------------- #
# 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 datetime
import os

from PyQt4 import QtCore, QtGui
from lxml import html

from openlp.core.lib import translate, get_text_file_string
from openlp.core.lib.ui import UiStrings
from openlp.core.ui.printservicedialog import Ui_PrintServiceDialog, ZoomSize
from openlp.core.utils import AppLocation

DEFAULT_CSS = """/*
Edit this file to customize the service order print. Note, that not all CSS
properties are supported. See:
http://doc.trolltech.com/4.7/richtext-html-subset.html#css-properties
*/

.serviceTitle {
   font-weight:600;
   font-size:x-large;
   color:black;
}

.itemTitle {
   font-weight:600;
   font-size:large;
   color:black;
}

.itemText {
   color:black;
}

.itemFooter {
   font-size:8px;
   color:black;
}

.itemNotesTitle {
   font-weight:bold;
   font-size:12px;
   color:black;
}

.itemNotesText {
   font-size:11px;
   color:black;
}

.customNotesTitle {
   font-weight:bold;
   font-size:11px;
   color:black;
}

.customNotesText {
   font-size:11px;
   color:black;
}
"""

class PrintServiceForm(QtGui.QDialog, Ui_PrintServiceDialog):

    def __init__(self, mainWindow, serviceManager):
        """
        Constructor
        """
        QtGui.QDialog.__init__(self, mainWindow)
        self.mainWindow = mainWindow
        self.serviceManager = serviceManager
        self.printer = QtGui.QPrinter()
        self.printDialog = QtGui.QPrintDialog(self.printer, self)
        self.document = QtGui.QTextDocument()
        self.zoom = 0
        self.setupUi(self)
        # Load the settings for the dialog.
        settings = QtCore.QSettings()
        settings.beginGroup(u'advanced')
        self.slideTextCheckBox.setChecked(settings.value(
            u'print slide text', QtCore.QVariant(False)).toBool())
        self.pageBreakAfterText.setChecked(settings.value(
            u'enable page break', QtCore.QVariant(False)).toBool())
        if not self.slideTextCheckBox.isChecked():
            self.pageBreakAfterText.setDisabled(True)
        self.metaDataCheckBox.setChecked(settings.value(
            u'print file meta data', QtCore.QVariant(False)).toBool())
        self.notesCheckBox.setChecked(settings.value(
            u'print notes', QtCore.QVariant(False)).toBool())
        self.zoomComboBox.setCurrentIndex(settings.value(
            u'display size', QtCore.QVariant(0)).toInt()[0])
        settings.endGroup()
        # Signals
        QtCore.QObject.connect(self.printButton,
            QtCore.SIGNAL(u'triggered()'), self.printServiceOrder)
        QtCore.QObject.connect(self.closeButton,
            QtCore.SIGNAL(u'triggered()'), self.accept)
        QtCore.QObject.connect(self.zoomOutButton,
            QtCore.SIGNAL(u'clicked()'), self.zoomOut)
        QtCore.QObject.connect(self.zoomInButton,
            QtCore.SIGNAL(u'clicked()'), self.zoomIn)
        QtCore.QObject.connect(self.zoomOriginalButton,
            QtCore.SIGNAL(u'clicked()'), self.zoomOriginal)
        QtCore.QObject.connect(self.previewWidget,
            QtCore.SIGNAL(u'paintRequested(QPrinter *)'), self.paintRequested)
        QtCore.QObject.connect(self.zoomComboBox,
            QtCore.SIGNAL(u'currentIndexChanged(int)'), self.displaySizeChanged)
        QtCore.QObject.connect(self.plainCopy,
            QtCore.SIGNAL(u'triggered()'), self.copyText)
        QtCore.QObject.connect(self.htmlCopy,
            QtCore.SIGNAL(u'triggered()'), self.copyHtmlText)
        QtCore.QObject.connect(self.slideTextCheckBox,
            QtCore.SIGNAL(u'stateChanged(int)'),
            self.onSlideTextCheckBoxChanged)
        self.updatePreviewText()

    def toggleOptions(self, checked):
        self.optionsWidget.setVisible(checked)
        if checked:
            left = self.optionsButton.pos().x()
            top = self.toolbar.height()
            self.optionsWidget.move(left, top)
            self.titleLineEdit.setFocus()
        else:
            self.saveOptions()
        self.updatePreviewText()

    def updatePreviewText(self):
        """
        Creates the html text and updates the html of *self.document*.
        """
        html_data = html.fromstring(
            u'<title>%s</title>' % unicode(self.titleLineEdit.text()))
        css_path = os.path.join(
            AppLocation.get_data_path(), u'servicePrint.css')
        if not os.path.isfile(css_path):
            # Create default css file.
            css_file = open(css_path, u'w')
            css_file.write(DEFAULT_CSS)
            css_file.close()
        custom_css = get_text_file_string(css_path)
        style = self._addChildToParent(u'style', custom_css, html_data.head)
        style.set(u'type', u'text/css')
        self._addChildToParent(u'body', parent=html_data)
        service_title = self._addChildToParent(
            u'span', unicode(self.titleLineEdit.text()), html_data.body)
        service_title.set(u'class', u'serviceTitle')
        for index, item in enumerate(self.serviceManager.serviceItems):
            item = item[u'service_item']
            div = self._addChildToParent(u'div', parent=html_data.body)
            # Add the title of the service item.
            item_title = self._addChildToParent(u'h2', parent=div)
            item_title.set(u'class', u'itemTitle')
            icon = self._addChildToParent(u'img', parent=item_title)
            icon.set(u'src', item.icon)
            self._fromstring(
                u'<span> %s</span>' % item.get_display_title(), item_title)
            if self.slideTextCheckBox.isChecked():
                # Add the text of the service item.
                if item.is_text():
                    verse_def = None
                    for slide in item.get_frames():
                        if not verse_def or verse_def != slide[u'verseTag']:
                            p = self._addChildToParent(u'p', parent=div)
                            p.set(u'class', u'itemText')
                        else:
                            self._addChildToParent(u'br', parent=p)
                        self._fromstring(u'<span>%s</span>' % slide[u'html'], p)
                        verse_def = slide[u'verseTag']
                    # Break the page before the div element.
                    if index != 0 and self.pageBreakAfterText.isChecked():
                        div.set(u'style', u'page-break-before:always')
                # Add the image names of the service item.
                elif item.is_image():
                    ol = self._addChildToParent(u'ol', parent=div)
                    for slide in range(len(item.get_frames())):
                        self._addChildToParent(u'li', item.get_frame_title(slide), ol)
                # add footer
                if item.foot_text:
                    p = self._fromstring(item.foot_text, div)
                    p.set(u'class', u'itemFooter')
            # Add service items' notes.
            if self.notesCheckBox.isChecked():
                if item.notes:
                    p = self._addChildToParent(u'p', parent=div)
                    title = self._addChildToParent(u'span', unicode(
                        translate('OpenLP.ServiceManager', 'Notes:')), p)
                    title.set(u'class', u'itemNotesTitle')
                    text = self._fromstring(u'<span> %s</span>' %
                        item.notes.replace(u'\n', u'<br />'), p)
                    text.set(u'class', u'itemNotesText')
            # Add play length of media files.
            if item.is_media() and self.metaDataCheckBox.isChecked():
                tme = item.media_length
                if item.end_time > 0:
                    tme = item.end_time - item.start_time
                title = self._fromstring(u'<p><strong>%s</strong> </p>' %
                    translate('OpenLP.ServiceManager', 'Playing time:'), div)
                self._fromstring(u'<span>%s</span>' %
                    unicode(datetime.timedelta(seconds=tme)), title)
        # Add the custom service notes:
        if self.footerTextEdit.toPlainText():
            footer_title = self._addChildToParent(u'span', translate(
                'OpenLP.ServiceManager', u'Custom Service Notes:'), div)
            footer_title.set(u'class', u'customNotesTitle')
            footer_text = self._addChildToParent(u'span',
                u' %s' % self.footerTextEdit.toPlainText(), div)
            footer_text.set(u'class', u'customNotesText')
        self.document.setHtml(html.tostring(html_data))
        self.previewWidget.updatePreview()

    def _addChildToParent(self, tag, text=None, parent=None):
        """
        Creates a html element. If ``text`` is given, the element's text will
        set and if a ``parent`` is given, the element is appended.
        """
        element = html.Element(tag)
        if text is not None:
            element.text = text
        if parent is not None:
            parent.append(element)
        return element

    def _fromstring(self, string, parent):
        """
        This is used to create a child html element from a string.
        """
        element = html.fromstring(string)
        parent.append(element)
        return element

    def paintRequested(self, printer):
        """
        Paint the preview of the *self.document*.

        ``printer``
            A *QPrinter* object.
        """
        self.document.print_(printer)

    def displaySizeChanged(self, display):
        """
        The Zoom Combo box has changed so set up the size.
        """
        if display == ZoomSize.Page:
            self.previewWidget.fitInView()
        elif display == ZoomSize.Width:
            self.previewWidget.fitToWidth()
        elif display == ZoomSize.OneHundred:
            self.previewWidget.fitToWidth()
            self.previewWidget.zoomIn(1)
        elif display == ZoomSize.SeventyFive:
            self.previewWidget.fitToWidth()
            self.previewWidget.zoomIn(0.75)
        elif display == ZoomSize.Fifty:
            self.previewWidget.fitToWidth()
            self.previewWidget.zoomIn(0.5)
        elif display == ZoomSize.TwentyFive:
            self.previewWidget.fitToWidth()
            self.previewWidget.zoomIn(0.25)
        settings = QtCore.QSettings()
        settings.beginGroup(u'advanced')
        settings.setValue(u'display size', QtCore.QVariant(display))
        settings.endGroup()

    def copyText(self):
        """
        Copies the display text to the clipboard as plain text
        """
        self.mainWindow.clipboard.setText(
            self.document.toPlainText())

    def copyHtmlText(self):
        """
        Copies the display text to the clipboard as Html
        """
        self.mainWindow.clipboard.setText(self.document.toHtml())

    def printServiceOrder(self):
        """
        Called, when the *printButton* is clicked. Opens the *printDialog*.
        """
        if not self.printDialog.exec_():
            return
        # Print the document.
        self.document.print_(self.printer)

    def zoomIn(self):
        """
        Called when *zoomInButton* is clicked.
        """
        self.previewWidget.zoomIn()
        self.zoom -= 0.1

    def zoomOut(self):
        """
        Called when *zoomOutButton* is clicked.
        """
        self.previewWidget.zoomOut()
        self.zoom += 0.1

    def zoomOriginal(self):
        """
        Called when *zoomOutButton* is clicked.
        """
        self.previewWidget.zoomIn(1 + self.zoom)
        self.zoom = 0

    def updateTextFormat(self, value):
        """
        Called when html copy check box is selected.
        """
        if value == QtCore.Qt.Checked:
            self.copyTextButton.setText(UiStrings.CopyToHtml)
        else:
            self.copyTextButton.setText(UiStrings.CopyToText)

    def onSlideTextCheckBoxChanged(self, state):
        """
        Disable or enable the ``pageBreakAfterText`` checkbox  as it should only
        be enabled, when the ``slideTextCheckBox`` is enabled.
        """
        self.pageBreakAfterText.setDisabled(state == QtCore.Qt.Unchecked)

    def saveOptions(self):
        """
        Save the settings and close the dialog.
        """
        # Save the settings for this dialog.
        settings = QtCore.QSettings()
        settings.beginGroup(u'advanced')
        settings.setValue(u'print slide text',
            QtCore.QVariant(self.slideTextCheckBox.isChecked()))
        settings.setValue(u'enable page break',
            QtCore.QVariant(self.pageBreakAfterText.isChecked()))
        settings.setValue(u'print file meta data',
            QtCore.QVariant(self.metaDataCheckBox.isChecked()))
        settings.setValue(u'print notes',
            QtCore.QVariant(self.notesCheckBox.isChecked()))
        settings.endGroup()