forked from openlp/openlp
241 lines
9.9 KiB
Python
241 lines
9.9 KiB
Python
# -*- 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, Meinert Jordan, Andreas Preikschat, Christian #
|
|
# Richter, Philip Ridout, Maikel Stuivenberg, Martin Thompson, Jon Tibble, #
|
|
# Carsten Tinggaard, 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 logging
|
|
import re
|
|
|
|
from PyQt4 import QtCore, QtGui
|
|
|
|
from openlp.core.lib import Plugin, StringContent, build_icon, translate
|
|
from openlp.core.lib.db import Manager
|
|
from openlp.plugins.songs.lib import SongMediaItem, SongsTab, SongXML
|
|
from openlp.plugins.songs.lib.db import init_schema, Song
|
|
from openlp.plugins.songs.lib.importer import SongFormat
|
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
class SongsPlugin(Plugin):
|
|
"""
|
|
This is the number 1 plugin, if importance were placed on any
|
|
plugins. This plugin enables the user to create, edit and display
|
|
songs. Songs are divided into verses, and the verse order can be
|
|
specified. Authors, topics and song books can be assigned to songs
|
|
as well.
|
|
"""
|
|
log.info(u'Song Plugin loaded')
|
|
|
|
def __init__(self, plugin_helpers):
|
|
"""
|
|
Create and set up the Songs plugin.
|
|
"""
|
|
Plugin.__init__(self, u'Songs', u'1.9.4', plugin_helpers,
|
|
SongMediaItem, SongsTab)
|
|
self.weight = -10
|
|
self.manager = Manager(u'songs', init_schema)
|
|
self.icon_path = u':/plugins/plugin_songs.png'
|
|
self.icon = build_icon(self.icon_path)
|
|
self.whitespace = re.compile(r'\W+', re.UNICODE)
|
|
|
|
def initialise(self):
|
|
log.info(u'Songs Initialising')
|
|
Plugin.initialise(self)
|
|
self.toolsReindexItem.setVisible(True)
|
|
self.mediaItem.displayResultsSong(
|
|
self.manager.get_all_objects(Song, order_by_ref=Song.search_title))
|
|
|
|
def addImportMenuItem(self, import_menu):
|
|
"""
|
|
Give the Songs plugin the opportunity to add items to the
|
|
**Import** menu.
|
|
|
|
``import_menu``
|
|
The actual **Import** menu item, so that your actions can
|
|
use it as their parent.
|
|
"""
|
|
# Main song import menu item - will eventually be the only one
|
|
self.SongImportItem = QtGui.QAction(import_menu)
|
|
self.SongImportItem.setObjectName(u'SongImportItem')
|
|
self.SongImportItem.setText(translate(
|
|
'SongsPlugin', '&Song'))
|
|
self.SongImportItem.setToolTip(translate('SongsPlugin',
|
|
'Import songs using the import wizard.'))
|
|
import_menu.addAction(self.SongImportItem)
|
|
# Signals and slots
|
|
QtCore.QObject.connect(self.SongImportItem,
|
|
QtCore.SIGNAL(u'triggered()'), self.onSongImportItemClicked)
|
|
|
|
def addExportMenuItem(self, export_menu):
|
|
"""
|
|
Give the Songs plugin the opportunity to add items to the
|
|
**Export** menu.
|
|
|
|
``export_menu``
|
|
The actual **Export** menu item, so that your actions can
|
|
use it as their parent.
|
|
"""
|
|
# Main song import menu item - will eventually be the only one
|
|
self.SongExportItem = QtGui.QAction(export_menu)
|
|
self.SongExportItem.setObjectName(u'SongExportItem')
|
|
self.SongExportItem.setText(translate(
|
|
'SongsPlugin', '&Song'))
|
|
self.SongExportItem.setToolTip(translate('SongsPlugin',
|
|
'Exports songs using the export wizard.'))
|
|
export_menu.addAction(self.SongExportItem)
|
|
# Signals and slots
|
|
QtCore.QObject.connect(self.SongExportItem,
|
|
QtCore.SIGNAL(u'triggered()'), self.onSongExportItemClicked)
|
|
|
|
def addToolsMenuItem(self, tools_menu):
|
|
"""
|
|
Give the alerts plugin the opportunity to add items to the
|
|
**Tools** menu.
|
|
|
|
``tools_menu``
|
|
The actual **Tools** menu item, so that your actions can
|
|
use it as their parent.
|
|
"""
|
|
log.info(u'add tools menu')
|
|
self.toolsReindexItem = QtGui.QAction(tools_menu)
|
|
self.toolsReindexItem.setIcon(build_icon(u':/plugins/plugin_songs.png'))
|
|
self.toolsReindexItem.setObjectName(u'toolsReindexItem')
|
|
self.toolsReindexItem.setText(
|
|
translate('SongsPlugin', '&Re-index Songs'))
|
|
self.toolsReindexItem.setStatusTip(
|
|
translate('SongsPlugin', 'Re-index the songs database to improve '
|
|
'searching and ordering.'))
|
|
tools_menu.addAction(self.toolsReindexItem)
|
|
QtCore.QObject.connect(self.toolsReindexItem,
|
|
QtCore.SIGNAL(u'triggered()'), self.onToolsReindexItemTriggered)
|
|
self.toolsReindexItem.setVisible(False)
|
|
|
|
def onToolsReindexItemTriggered(self):
|
|
"""
|
|
Rebuild each song.
|
|
"""
|
|
maxSongs = self.manager.get_object_count(Song)
|
|
progressDialog = QtGui.QProgressDialog(
|
|
translate('SongsPlugin', 'Reindexing songs...'),
|
|
translate('SongsPlugin', 'Cancel'),
|
|
0, maxSongs + 1, self.formparent)
|
|
progressDialog.setWindowModality(QtCore.Qt.WindowModal)
|
|
songs = self.manager.get_all_objects(Song)
|
|
counter = 0
|
|
for song in songs:
|
|
counter += 1
|
|
if song.title is None:
|
|
song.title = u''
|
|
if song.alternate_title is None:
|
|
song.alternate_title = u''
|
|
song.search_title = self.whitespace.sub(u' ', song.title.lower() +
|
|
u' ' + song.alternate_title.lower())
|
|
# Remove the "language" attribute from lyrics tag. This is not very
|
|
# important, but this keeps the database clean. This can be removed
|
|
# when everybody has run the reindex tool once.
|
|
song.lyrics = song.lyrics.replace(
|
|
u'<lyrics language="en">', u'<lyrics>')
|
|
lyrics = u''
|
|
verses = SongXML().get_verses(song.lyrics)
|
|
for verse in verses:
|
|
lyrics = lyrics + self.whitespace.sub(u' ', verse[1]) + u' '
|
|
song.search_lyrics = lyrics.lower()
|
|
progressDialog.setValue(counter)
|
|
self.manager.save_objects(songs)
|
|
progressDialog.setValue(counter + 1)
|
|
self.mediaItem.displayResultsSong(
|
|
self.manager.get_all_objects(Song, order_by_ref=Song.search_title))
|
|
|
|
def onSongImportItemClicked(self):
|
|
if self.mediaItem:
|
|
self.mediaItem.onImportClick()
|
|
|
|
def onSongExportItemClicked(self):
|
|
if self.mediaItem:
|
|
self.mediaItem.onExportClick()
|
|
|
|
def about(self):
|
|
about_text = translate('SongsPlugin', '<strong>Songs Plugin</strong>'
|
|
'<br />The songs plugin provides the ability to display and '
|
|
'manage songs.')
|
|
return about_text
|
|
|
|
def usesTheme(self, theme):
|
|
"""
|
|
Called to find out if the song plugin is currently using a theme.
|
|
|
|
Returns True if the theme is being used, otherwise returns False.
|
|
"""
|
|
if self.manager.get_all_objects(Song, Song.theme_name == theme):
|
|
return True
|
|
return False
|
|
|
|
def renameTheme(self, oldTheme, newTheme):
|
|
"""
|
|
Renames a theme the song plugin is using making the plugin use the new
|
|
name.
|
|
|
|
``oldTheme``
|
|
The name of the theme the plugin should stop using.
|
|
|
|
``newTheme``
|
|
The new name the plugin should now use.
|
|
"""
|
|
songsUsingTheme = self.manager.get_all_objects(Song,
|
|
Song.theme_name == oldTheme)
|
|
for song in songsUsingTheme:
|
|
song.theme_name = newTheme
|
|
self.manager.save_object(song)
|
|
|
|
def importSongs(self, format, **kwargs):
|
|
class_ = SongFormat.get_class(format)
|
|
importer = class_(self.manager, **kwargs)
|
|
importer.register(self.mediaItem.import_wizard)
|
|
return importer
|
|
|
|
def setPluginTextStrings(self):
|
|
"""
|
|
Called to define all translatable texts of the plugin
|
|
"""
|
|
## Name PluginList ##
|
|
self.textStrings[StringContent.Name] = {
|
|
u'singular': translate('SongsPlugin', 'Song', 'name singular'),
|
|
u'plural': translate('SongsPlugin', 'Songs', 'name plural')
|
|
}
|
|
## Name for MediaDockManager, SettingsManager ##
|
|
self.textStrings[StringContent.VisibleName] = {
|
|
u'title': translate('SongsPlugin', 'Songs', 'container title')
|
|
}
|
|
# Middle Header Bar
|
|
Plugin.setPluginTextStrings(self)
|
|
|
|
def finalise(self):
|
|
"""
|
|
Time to tidy up on exit
|
|
"""
|
|
log.info(u'Songs Finalising')
|
|
self.manager.finalise()
|
|
self.toolsReindexItem.setVisible(False)
|
|
Plugin.finalise(self)
|