openlp/openlp/plugins/songs/lib/mediaitem.py

# -*- coding: utf-8 -*-
# vim: autoindent shiftwidth=4 expandtab textwidth=80 tabstop=4 softtabstop=4
"""
OpenLP - Open Source Lyrics Projection
Copyright (c) 2008 Raoul Snyman
Portions copyright (c) 2008-2009 Martin Thompson, Tim Bentley

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

from PyQt4 import QtCore, QtGui
from openlp.core.lib import MediaManagerItem,  translate,  ServiceItem,  SongXMLParser , contextMenuAction, contextMenuSeparator

from openlp.plugins.songs.forms import EditSongForm

class SongList(QtGui.QListWidget):

    def __init__(self,parent=None,name=None):
        QtGui.QListWidget.__init__(self,parent)

    def mouseMoveEvent(self, event):
        """
        Drag and drop event does not care what data is selected
        as the recepient will use events to request the data move
        just tell it what plugin to call
        """
        if event.buttons() != QtCore.Qt.LeftButton:
            return
        drag = QtGui.QDrag(self)
        mimeData = QtCore.QMimeData()
        drag.setMimeData(mimeData)
        mimeData.setText(u'Song')
        dropAction = drag.start(QtCore.Qt.CopyAction)
        if dropAction == QtCore.Qt.CopyAction:
            self.close()

class SongMediaItem(MediaManagerItem):
    """
    This is the custom media manager item for Songs.
    """
    global log
    log = logging.getLogger(u'SongMediaItem')
    log.info(u'Song Media Item loaded')

    def __init__(self, parent, icon, title):
        self.TranslationContext = u'SongPlugin'
        self.PluginTextShort = u'Song'
        self.ConfigSection = u'song'
        MediaManagerItem.__init__(self, parent, icon, title)
        self.edit_song_form = EditSongForm(self.parent.songmanager, self.parent.event_manager)

    def setupUi(self):
        # Add a toolbar
        self.addToolbar()
        # Create buttons for the toolbar
        ## New Song Button ##
        self.addToolbarButton(translate(u'SongMediaItem', u'New Song'),
            translate(u'SongMediaItem', u'Add a new song'),
            ':/songs/song_new.png', self.onSongNewClick, 'SongNewItem')
        ## Edit Song Button ##
        self.addToolbarButton(translate(u'SongMediaItem', u'Edit Song'),
            translate(u'SongMediaItem', u'Edit the selected song'),
            ':/songs/song_edit.png', self.onSongEditClick, 'SongEditItem')
        ## Delete Song Button ##
        self.addToolbarButton(translate(u'SongMediaItem', u'Delete Song'),
            translate(u'SongMediaItem', u'Delete the selected song'),
            ':/songs/song_delete.png', self.onSongDeleteClick, 'SongDeleteItem')
        ## Separator Line ##
        self.addToolbarSeparator()
        ## Preview Song Button ##
        self.addToolbarButton(translate(u'SongMediaItem', u'Preview Song'),
            translate(u'SongMediaItem', u'Preview the selected song'),
            ':/system/system_preview.png', self.onSongPreviewClick, 'SongPreviewItem')
        ## Live Song Button ##
        self.addToolbarButton(translate(u'SongMediaItem', u'Go Live'),
            translate(u'SongMediaItem', u'Send the selected song live'),
            ':/system/system_live.png', self.onSongLiveClick, 'SongLiveItem')
        ## Add Song Button ##
        self.addToolbarButton(translate(u'SongMediaItem', u'Add Song To Service'),
            translate(u'SongMediaItem', u'Add the selected song(s) to the service'),
            ':/system/system_add.png', self.onSongAddClick, 'SongAddItem')
        ## Add the songlist widget ##
        # Create the tab widget
        self.SongWidget = QtGui.QWidget(self)
        sizePolicy = QtGui.QSizePolicy(QtGui.QSizePolicy.Expanding, QtGui.QSizePolicy.Minimum)
        sizePolicy.setHorizontalStretch(0)
        sizePolicy.setVerticalStretch(0)
        sizePolicy.setHeightForWidth(self.SongWidget.sizePolicy().hasHeightForWidth())
        self.SongWidget.setSizePolicy(sizePolicy)
        self.SongWidget.setObjectName(u'SongWidget')
        self.SearchLayout = QtGui.QGridLayout(self.SongWidget)
        self.SearchLayout.setObjectName(u'SearchLayout')
        self.SearchTypeComboBox = QtGui.QComboBox(self.SongWidget)
        self.SearchTypeComboBox.setObjectName(u'SearchTypeComboBox')
        self.SearchLayout.addWidget(self.SearchTypeComboBox, 0, 1, 1, 2)
        self.SearchTypeLabel = QtGui.QLabel(self.SongWidget)
        self.SearchTypeLabel.setObjectName(u'SearchTypeLabel')
        self.SearchLayout.addWidget(self.SearchTypeLabel, 0, 0, 1, 1)
        self.SearchTextLabel = QtGui.QLabel(self.SongWidget)
        self.SearchTextLabel.setObjectName(u'SearchTextLabel')
        self.SearchLayout.addWidget(self.SearchTextLabel, 2, 0, 1, 1)
        self.SearchTextEdit = QtGui.QLineEdit(self.SongWidget)
        self.SearchTextEdit.setObjectName(u'SearchTextEdit')
        self.SearchLayout.addWidget(self.SearchTextEdit, 2, 1, 1, 2)
        self.ClearTextButton = QtGui.QPushButton(self.SongWidget)
        self.ClearTextButton.setObjectName(u'ClearTextButton')
        self.SearchLayout.addWidget(self.ClearTextButton, 3, 1, 1, 1)
        self.SearchTextButton = QtGui.QPushButton(self.SongWidget)
        self.SearchTextButton.setObjectName(u'SearchTextButton')
        self.SearchLayout.addWidget(self.SearchTextButton, 3, 2, 1, 1)
        # Add the song widget to the page layout
        self.PageLayout.addWidget(self.SongWidget)
        self.ListView = SongList()
        self.ListView.setAlternatingRowColors(True)
        self.ListView.setDragEnabled(True)
        self.ListView.setObjectName(u'ListView')
        self.PageLayout.addWidget(self.ListView)
        self.ListView.setDragEnabled(True)
        # Signals and slots
        QtCore.QObject.connect(self.SearchTextButton,
            QtCore.SIGNAL(u'pressed()'), self.onSearchTextButtonClick)
        QtCore.QObject.connect(self.ClearTextButton,
            QtCore.SIGNAL(u'pressed()'), self.onClearTextButtonClick)
        QtCore.QObject.connect(self.SearchTextEdit,
            QtCore.SIGNAL(u'textChanged(const QString&)'), self.onSearchTextEditChanged)
        QtCore.QObject.connect(self.ListView,
           QtCore.SIGNAL(u'doubleClicked(QModelIndex)'), self.onSongPreviewClick)
        #define and add the context menu
        self.ListView.setContextMenuPolicy(QtCore.Qt.ActionsContextMenu)
        self.ListView.addAction(contextMenuAction(self.ListView,
            ':/songs/song_new.png', translate(u'SongMediaItem', u'&Edit Song'),
            self.onSongEditClick))
        self.ListView.addAction(contextMenuSeparator(self.ListView))
        self.ListView.addAction(contextMenuAction(self.ListView,
            ':/system/system_preview.png', translate(u'SongMediaItem', u'&Preview Song'),
            self.onSongPreviewClick))
        self.ListView.addAction(contextMenuAction(self.ListView,
            ':/system/system_live.png', translate(u'SongMediaItem', u'&Show Live'),
            self.onSongLiveClick))
        self.ListView.addAction(contextMenuAction(self.ListView,
            ':/system/system_add.png', translate(u'SongMediaItem', u'&Add to Service'),
            self.onSongAddClick))

    def retranslateUi(self):
        self.SearchTypeLabel.setText(translate(u'SongMediaItem', u'Search Type:'))
        self.SearchTextLabel.setText(translate(u'SongMediaItem', u'Search Text:'))
        self.ClearTextButton.setText(translate(u'SongMediaItem', u'Clear'))
        self.SearchTextButton.setText(translate(u'SongMediaItem', u'Search'))

    def initialise(self):
        self.SearchTypeComboBox.addItem(translate(u'SongMediaItem', u'Titles'))
        self.SearchTypeComboBox.addItem(translate(u'SongMediaItem', u'Lyrics'))
        self.SearchTypeComboBox.addItem(translate(u'SongMediaItem', u'Authors'))

    def onSearchTextButtonClick(self):
        search_keywords = unicode(self.SearchTextEdit.displayText())
        search_results  = []
        search_type = self.SearchTypeComboBox.currentIndex()
        if search_type == 0:
            log.debug(u'Titles Search')
            search_results = self.parent.songmanager.search_song_title(search_keywords)
            self.displayResultsSong(search_results)
        elif search_type == 1:
            log.debug(u'Lyrics Search')
            search_results = self.parent.songmanager.search_song_lyrics(search_keywords)
            self.displayResultsSong(search_results)
        elif search_type == 2:
            log.debug(u'Authors Search')
            search_results = self.parent.songmanager.get_song_from_author(search_keywords)
            self.displayResultsAuthor(search_results)

    def displayResultsSong(self, searchresults):
        log.debug(u'display results Song')
        self.ListView.clear()
        #log.debug(u'Records returned from search %s", len(searchresults))
        for song in searchresults:
            author_list = u''
            for author in song.authors:
                if author_list != u'':
                    author_list = author_list + u', '
                author_list = author_list + author.display_name
            song_detail = unicode(u'%s (%s)' % (unicode(song.title), unicode(author_list)))
            song_name = QtGui.QListWidgetItem(song_detail)
            song_name.setData(QtCore.Qt.UserRole, QtCore.QVariant(song.id))
            self.ListView.addItem(song_name)

    def displayResultsAuthor(self, searchresults):
        log.debug(u'display results Author')
        self.ListView.clear()
        for author in searchresults:
            for song in author.songs:
                song_detail = unicode(u'%s (%s)' % (unicode(author.display_name), unicode(song.title)))
                song_name = QtGui.QListWidgetItem(song_detail)
                song_name.setData(QtCore.Qt.UserRole, QtCore.QVariant(song.id))
                self.ListView.addItem(song_name)

    def onClearTextButtonClick(self):
        """
        Clear the search text.
        """
        self.SearchTextEdit.clear()

    def onSearchTextEditChanged(self, text):
        search_length = 1
        if self.SearchTypeComboBox.currentIndex() == 1:
            search_length = 7
        if len(text) > search_length:
            self.onSearchTextButtonClick()

    def onSongNewClick(self):
        self.edit_song_form.newSong()
        self.edit_song_form.exec_()

    def onSongEditClick(self):
        item = self.ListView.currentItem()
        if item is not None:
            item_id = (item.data(QtCore.Qt.UserRole)).toInt()[0]
            self.edit_song_form.loadSong(item_id)
            self.edit_song_form.exec_()

    def onSongDeleteClick(self):
        item = self.ListView.currentItem()
        if item is not None:
            item_id = (item.data(QtCore.Qt.UserRole)).toInt()[0]
            self.parent.songmanager.delete_song(item_id)
            row = self.ListView.row(item)
            self.ListView.takeItem(row)

    def onSongPreviewClick(self):
        service_item = ServiceItem(self.parent)
        service_item.addIcon(u':/media/media_song.png')
        self.generateSlideData(service_item)
        self.parent.preview_controller.addServiceItem(service_item)

    def generateSlideData(self, service_item):
        raw_slides =[]
        raw_footer = []
        author_list = u''
        ccl = u''
        item = self.ListView.currentItem()
        item_id = (item.data(QtCore.Qt.UserRole)).toInt()[0]
        song = self.parent.songmanager.get_song(item_id)
        service_item.theme = song.theme_name
        if song.lyrics.startswith(u'<?xml version='):
            songXML=SongXMLParser(song.lyrics)
            verseList = songXML.get_verses()
            for verse in verseList:
                if verse[1] is not None:
                    service_item.add_from_text(verse[1][:30], verse[1])
        else:
            verses = song.lyrics.split(u'\n\n')
            for slide in verses:
                service_item.add_from_text(slide[:30], slide)
        service_item.title = song.title
        for author in song.authors:
            if len(author_list) > 1:
                author_list = author_list + u', '
            author_list = author_list + unicode(author.display_name)
        if song.ccli_number == None or len(song.ccli_number) == 0:
            ccl = self.parent.settings.GeneralTab.CCLNumber
        else:
            ccl = unicode(song.ccli_number)
        raw_footer.append(song.title)
        raw_footer.append(author_list)
        raw_footer.append(song.copyright )
        raw_footer.append(unicode(translate(u'SongMediaItem', u'CCL Licence: ') + ccl ))
        service_item.raw_footer = raw_footer

    def onSongLiveClick(self):
        service_item = ServiceItem(self.parent)
        service_item.addIcon(u':/media/media_song.png')
        self.generateSlideData(service_item)
        self.parent.live_controller.addServiceItem(service_item)

    def onSongAddClick(self):
        service_item = ServiceItem(self.parent)
        service_item.addIcon( u':/media/media_song.png')
        self.generateSlideData(service_item)
        self.parent.service_manager.addServiceItem(service_item)