forked from openlp/openlp
902 lines
34 KiB
Python
902 lines
34 KiB
Python
# -*- coding: utf-8 -*-
|
|
# vim: autoindent shiftwidth=4 expandtab textwidth=80 tabstop=4 softtabstop=4
|
|
|
|
###############################################################################
|
|
# OpenLP - Open Source Lyrics Projection #
|
|
# --------------------------------------------------------------------------- #
|
|
# Copyright (c) 2008-2013 Raoul Snyman #
|
|
# Portions copyright (c) 2008-2013 Tim Bentley, Gerald Britton, Jonathan #
|
|
# Corwin, Samuel Findlay, Michael Gorven, Scott Guerrieri, Matthias Hub, #
|
|
# Meinert Jordan, Armin Köhler, Erik Lundin, Edwin Lunando, Brian T. Meyer. #
|
|
# Joshua Miller, Stevan Pettit, Andreas Preikschat, Mattias Põldaru, #
|
|
# Christian Richter, Philip Ridout, Simon Scudder, Jeffrey Smith, #
|
|
# Maikel Stuivenberg, Martin Thompson, Jon Tibble, Dave Warnock, #
|
|
# Frode Woldsund, Martin Zibricky #
|
|
# --------------------------------------------------------------------------- #
|
|
# 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 #
|
|
###############################################################################
|
|
"""
|
|
The :mod:`xml` module provides the XML functionality.
|
|
|
|
The basic XML for storing the lyrics in the song database looks like this::
|
|
|
|
<?xml version="1.0" encoding="UTF-8"?>
|
|
<song version="1.0">
|
|
<lyrics>
|
|
<verse type="c" label="1" lang="en">
|
|
<![CDATA[Chorus optional split 1[---]Chorus optional split 2]]>
|
|
</verse>
|
|
</lyrics>
|
|
</song>
|
|
|
|
|
|
The XML of an `OpenLyrics <http://openlyrics.info/>`_ song looks like this::
|
|
|
|
<song xmlns="http://openlyrics.info/namespace/2009/song"
|
|
version="0.7"
|
|
createdIn="OpenLP 1.9.0"
|
|
modifiedIn="ChangingSong 0.0.1"
|
|
modifiedDate="2010-01-28T13:15:30+01:00">
|
|
<properties>
|
|
<titles>
|
|
<title>Amazing Grace</title>
|
|
</titles>
|
|
</properties>
|
|
<lyrics>
|
|
<verse name="v1">
|
|
<lines>
|
|
<line>Amazing grace how sweet the sound</line>
|
|
</lines>
|
|
</verse>
|
|
</lyrics>
|
|
</song>
|
|
"""
|
|
import cgi
|
|
import logging
|
|
import re
|
|
|
|
from lxml import etree, objectify
|
|
|
|
from openlp.core.lib import FormattingTags, translate
|
|
from openlp.plugins.songs.lib import clean_song, VerseType
|
|
from openlp.plugins.songs.lib.db import Author, Book, Song, Topic
|
|
from openlp.core.utils import get_application_version
|
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
NAMESPACE = u'http://openlyrics.info/namespace/2009/song'
|
|
NSMAP = '{' + NAMESPACE + '}' + '%s'
|
|
|
|
|
|
def valid_XML_char_ordinal(char):
|
|
"""
|
|
Undertake the filter test.
|
|
|
|
``char``
|
|
The individual character to be checked.
|
|
"""
|
|
return (
|
|
0x20 <= char <= 0xD7FF
|
|
or char in (0x9, 0xA, 0xD)
|
|
or 0xE000 <= char <= 0xFFFD
|
|
or 0x10000 <= char <= 0x10FFFF
|
|
)
|
|
|
|
|
|
def clean_xml_string(xml):
|
|
"""
|
|
Filter out invalid characters in xml
|
|
Source <http://stackoverflow.com/questions/8733233/filtering-out-certain-bytes-in-python>
|
|
|
|
``xml``
|
|
The actual text to be checked.
|
|
|
|
"""
|
|
return ''.join(char for char in xml if valid_XML_char_ordinal(ord(char)))
|
|
|
|
|
|
class SongXML(object):
|
|
"""
|
|
This class builds and parses the XML used to describe songs.
|
|
"""
|
|
log.info(u'SongXML Loaded')
|
|
|
|
def __init__(self):
|
|
"""
|
|
Set up the default variables.
|
|
"""
|
|
self.song_xml = objectify.fromstring(u'<song version="1.0" />')
|
|
self.lyrics = etree.SubElement(self.song_xml, u'lyrics')
|
|
|
|
def add_verse_to_lyrics(self, type, number, content, lang=None):
|
|
"""
|
|
Add a verse to the ``<lyrics>`` tag.
|
|
|
|
``type``
|
|
A string denoting the type of verse. Possible values are *v*,
|
|
*c*, *b*, *p*, *i*, *e* and *o*.
|
|
Any other type is **not** allowed, this also includes translated
|
|
types.
|
|
|
|
``number``
|
|
An integer denoting the number of the item, for example: verse 1.
|
|
|
|
``content``
|
|
The actual text of the verse to be stored.
|
|
|
|
``lang``
|
|
The verse's language code (ISO-639). This is not required, but
|
|
should be added if available.
|
|
"""
|
|
content = clean_xml_string(content)
|
|
verse = etree.Element(u'verse', type=unicode(type),
|
|
label=unicode(number))
|
|
if lang:
|
|
verse.set(u'lang', lang)
|
|
verse.text = etree.CDATA(content)
|
|
self.lyrics.append(verse)
|
|
|
|
def extract_xml(self):
|
|
"""
|
|
Extract our newly created XML song.
|
|
"""
|
|
return etree.tostring(self.song_xml, encoding=u'UTF-8',
|
|
xml_declaration=True)
|
|
|
|
def get_verses(self, xml):
|
|
"""
|
|
Iterates through the verses in the XML and returns a list of verses
|
|
and their attributes.
|
|
|
|
``xml``
|
|
The XML of the song to be parsed.
|
|
|
|
The returned list has the following format::
|
|
|
|
[[{'type': 'v', 'label': '1'},
|
|
u"optional slide split 1[---]optional slide split 2"],
|
|
[{'lang': 'en', 'type': 'c', 'label': '1'}, u"English chorus"]]
|
|
"""
|
|
self.song_xml = None
|
|
verse_list = []
|
|
if not xml.startswith(u'<?xml') and not xml.startswith(u'<song'):
|
|
# This is an old style song, without XML. Let's handle it correctly
|
|
# by iterating through the verses, and then recreating the internal
|
|
# xml object as well.
|
|
self.song_xml = objectify.fromstring(u'<song version="1.0" />')
|
|
self.lyrics = etree.SubElement(self.song_xml, u'lyrics')
|
|
verses = xml.split(u'\n\n')
|
|
for count, verse in enumerate(verses):
|
|
verse_list.append([{u'type': u'v', u'label': unicode(count)},
|
|
unicode(verse)])
|
|
self.add_verse_to_lyrics(u'v', unicode(count), verse)
|
|
return verse_list
|
|
elif xml.startswith(u'<?xml'):
|
|
xml = xml[38:]
|
|
try:
|
|
self.song_xml = objectify.fromstring(xml)
|
|
except etree.XMLSyntaxError:
|
|
log.exception(u'Invalid xml %s', xml)
|
|
xml_iter = self.song_xml.getiterator()
|
|
for element in xml_iter:
|
|
if element.tag == u'verse':
|
|
if element.text is None:
|
|
element.text = u''
|
|
verse_list.append([element.attrib, unicode(element.text)])
|
|
return verse_list
|
|
|
|
def dump_xml(self):
|
|
"""
|
|
Debugging aid to dump XML so that we can see what we have.
|
|
"""
|
|
return etree.dump(self.song_xml)
|
|
|
|
|
|
class OpenLyrics(object):
|
|
"""
|
|
This class represents the converter for OpenLyrics XML (version 0.8)
|
|
to/from a song.
|
|
|
|
As OpenLyrics has a rich set of different features, we cannot support them
|
|
all. The following features are supported by the :class:`OpenLyrics` class:
|
|
|
|
``<authors>``
|
|
OpenLP does not support the attribute *type* and *lang*.
|
|
|
|
``<chord>``
|
|
This property is not supported.
|
|
|
|
``<comments>``
|
|
The ``<comments>`` property is fully supported. But comments in lyrics
|
|
are not supported.
|
|
|
|
``<copyright>``
|
|
This property is fully supported.
|
|
|
|
``<customVersion>``
|
|
This property is not supported.
|
|
|
|
``<key>``
|
|
This property is not supported.
|
|
|
|
``<format>``
|
|
The custom formatting tags are fully supported.
|
|
|
|
``<keywords>``
|
|
This property is not supported.
|
|
|
|
``<lines>``
|
|
The attribute *part* is not supported. The *break* attribute is
|
|
supported.
|
|
|
|
``<publisher>``
|
|
This property is not supported.
|
|
|
|
``<songbooks>``
|
|
As OpenLP does only support one songbook, we cannot consider more than
|
|
one songbook.
|
|
|
|
``<tempo>``
|
|
This property is not supported.
|
|
|
|
``<themes>``
|
|
Topics, as they are called in OpenLP, are fully supported, whereby only
|
|
the topic text (e. g. Grace) is considered, but neither the *id* nor
|
|
*lang*.
|
|
|
|
``<transposition>``
|
|
This property is not supported.
|
|
|
|
``<variant>``
|
|
This property is not supported.
|
|
|
|
``<verse name="v1a" lang="he" translit="en">``
|
|
The attribute *translit* is not supported. Note, the attribute *lang* is
|
|
considered, but there is not further functionality implemented yet. The
|
|
following verse "types" are supported by OpenLP:
|
|
|
|
* v
|
|
* c
|
|
* b
|
|
* p
|
|
* i
|
|
* e
|
|
* o
|
|
|
|
The verse "types" stand for *Verse*, *Chorus*, *Bridge*, *Pre-Chorus*,
|
|
*Intro*, *Ending* and *Other*. Any numeric value is allowed after the
|
|
verse type. The complete verse name in OpenLP always consists of the
|
|
verse type and the verse number. If not number is present *1* is
|
|
assumed.
|
|
OpenLP will merge verses which are split up by appending a letter to the
|
|
verse name, such as *v1a*.
|
|
|
|
``<verseOrder>``
|
|
OpenLP supports this property.
|
|
|
|
"""
|
|
IMPLEMENTED_VERSION = u'0.8'
|
|
START_TAGS_REGEX = re.compile(r'\{(\w+)\}')
|
|
END_TAGS_REGEX = re.compile(r'\{\/(\w+)\}')
|
|
VERSE_TAG_SPLITTER = re.compile(u'([a-zA-Z]+)([0-9]*)([a-zA-Z]?)')
|
|
|
|
def __init__(self, manager):
|
|
self.manager = manager
|
|
|
|
def song_to_xml(self, song):
|
|
"""
|
|
Convert the song to OpenLyrics Format.
|
|
"""
|
|
sxml = SongXML()
|
|
song_xml = objectify.fromstring(u'<song/>')
|
|
# Append the necessary meta data to the song.
|
|
song_xml.set(u'xmlns', NAMESPACE)
|
|
song_xml.set(u'version', OpenLyrics.IMPLEMENTED_VERSION)
|
|
application_name = u'OpenLP ' + get_application_version()[u'version']
|
|
song_xml.set(u'createdIn', application_name)
|
|
song_xml.set(u'modifiedIn', application_name)
|
|
# "Convert" 2012-08-27 11:49:15 to 2012-08-27T11:49:15.
|
|
song_xml.set(u'modifiedDate',
|
|
unicode(song.last_modified).replace(u' ', u'T'))
|
|
properties = etree.SubElement(song_xml, u'properties')
|
|
titles = etree.SubElement(properties, u'titles')
|
|
self._add_text_to_element(u'title', titles, song.title)
|
|
if song.alternate_title:
|
|
self._add_text_to_element(u'title', titles, song.alternate_title)
|
|
if song.comments:
|
|
comments = etree.SubElement(properties, u'comments')
|
|
self._add_text_to_element(u'comment', comments, song.comments)
|
|
if song.copyright:
|
|
self._add_text_to_element(u'copyright', properties, song.copyright)
|
|
if song.verse_order:
|
|
self._add_text_to_element(
|
|
u'verseOrder', properties, song.verse_order.lower())
|
|
if song.ccli_number:
|
|
self._add_text_to_element(u'ccliNo', properties, song.ccli_number)
|
|
if song.authors:
|
|
authors = etree.SubElement(properties, u'authors')
|
|
for author in song.authors:
|
|
self._add_text_to_element(
|
|
u'author', authors, author.display_name)
|
|
book = self.manager.get_object_filtered(
|
|
Book, Book.id == song.song_book_id)
|
|
if book is not None:
|
|
book = book.name
|
|
songbooks = etree.SubElement(properties, u'songbooks')
|
|
element = self._add_text_to_element(
|
|
u'songbook', songbooks, None, book)
|
|
if song.song_number:
|
|
element.set(u'entry', song.song_number)
|
|
if song.topics:
|
|
themes = etree.SubElement(properties, u'themes')
|
|
for topic in song.topics:
|
|
self._add_text_to_element(u'theme', themes, topic.name)
|
|
# Process the formatting tags.
|
|
# Have we any tags in song lyrics?
|
|
tags_element = None
|
|
match = re.search(u'\{/?\w+\}', song.lyrics, re.UNICODE)
|
|
if match:
|
|
# Named 'format_' - 'format' is built-in fuction in Python.
|
|
format_ = etree.SubElement(song_xml, u'format')
|
|
tags_element = etree.SubElement(format_, u'tags')
|
|
tags_element.set(u'application', u'OpenLP')
|
|
# Process the song's lyrics.
|
|
lyrics = etree.SubElement(song_xml, u'lyrics')
|
|
verse_list = sxml.get_verses(song.lyrics)
|
|
# Add a suffix letter to each verse
|
|
verse_tags = []
|
|
for verse in verse_list:
|
|
verse_tag = verse[0][u'type'][0].lower()
|
|
verse_number = verse[0][u'label']
|
|
verse_def = verse_tag + verse_number
|
|
verse_tags.append(verse_def)
|
|
# Create the letter from the number of duplicates
|
|
verse[0][u'suffix'] = chr(96 + verse_tags.count(verse_def))
|
|
# If the verse tag is a duplicate use the suffix letter
|
|
for verse in verse_list:
|
|
verse_tag = verse[0][u'type'][0].lower()
|
|
verse_number = verse[0][u'label']
|
|
verse_def = verse_tag + verse_number
|
|
if verse_tags.count(verse_def) > 1:
|
|
verse_def += verse[0][u'suffix']
|
|
verse_element = \
|
|
self._add_text_to_element(u'verse', lyrics, None, verse_def)
|
|
if u'lang' in verse[0]:
|
|
verse_element.set(u'lang', verse[0][u'lang'])
|
|
# Create a list with all "optional" verses.
|
|
optional_verses = cgi.escape(verse[1])
|
|
optional_verses = optional_verses.split(u'\n[---]\n')
|
|
start_tags = u''
|
|
end_tags = u''
|
|
for index, optional_verse in enumerate(optional_verses):
|
|
# Fix up missing end and start tags such as {r} or {/r}.
|
|
optional_verse = start_tags + optional_verse
|
|
start_tags, end_tags = self._get_missing_tags(optional_verse)
|
|
optional_verse += end_tags
|
|
# Add formatting tags to text
|
|
lines_element = self._add_text_with_tags_to_lines(verse_element,
|
|
optional_verse, tags_element)
|
|
# Do not add the break attribute to the last lines element.
|
|
if index < len(optional_verses) - 1:
|
|
lines_element.set(u'break', u'optional')
|
|
return self._extract_xml(song_xml)
|
|
|
|
def _get_missing_tags(self, text):
|
|
"""
|
|
Tests the given text for not closed formatting tags and returns a tuple
|
|
consisting of two unicode strings::
|
|
|
|
(u'{st}{r}', u'{/r}{/st}')
|
|
|
|
The first unicode string are the start tags (for the next slide). The
|
|
second unicode string are the end tags.
|
|
|
|
``text``
|
|
The text to test. The text must **not** contain html tags, only
|
|
OpenLP formatting tags are allowed::
|
|
|
|
{st}{r}Text text text
|
|
"""
|
|
tags = []
|
|
for tag in FormattingTags.get_html_tags():
|
|
if tag[u'start tag'] == u'{br}':
|
|
continue
|
|
if text.count(tag[u'start tag']) != text.count(tag[u'end tag']):
|
|
tags.append((text.find(tag[u'start tag']),
|
|
tag[u'start tag'], tag[u'end tag']))
|
|
# Sort the lists, so that the tags which were opened first on the first
|
|
# slide (the text we are checking) will be opened first on the next
|
|
# slide as well.
|
|
tags.sort(key=lambda tag: tag[0])
|
|
end_tags = []
|
|
start_tags = []
|
|
for tag in tags:
|
|
start_tags.append(tag[1])
|
|
end_tags.append(tag[2])
|
|
end_tags.reverse()
|
|
return u''.join(start_tags), u''.join(end_tags)
|
|
|
|
def xml_to_song(self, xml, parse_and_temporary_save=False):
|
|
"""
|
|
Create and save a song from OpenLyrics format xml to the database. Since
|
|
we also export XML from external sources (e. g. OpenLyrics import), we
|
|
cannot ensure, that it completely conforms to the OpenLyrics standard.
|
|
|
|
``xml``
|
|
The XML to parse (unicode).
|
|
|
|
``parse_and_temporary_save``
|
|
Switch to skip processing the whole song and storing the songs in
|
|
the database with a temporary flag. Defaults to ``False``.
|
|
"""
|
|
# No xml get out of here.
|
|
if not xml:
|
|
return None
|
|
if xml[:5] == u'<?xml':
|
|
xml = xml[38:]
|
|
song_xml = objectify.fromstring(xml)
|
|
if hasattr(song_xml, u'properties'):
|
|
properties = song_xml.properties
|
|
else:
|
|
return None
|
|
# Formatting tags are new in OpenLyrics 0.8
|
|
if float(song_xml.get(u'version')) > 0.7:
|
|
self._process_formatting_tags(song_xml, parse_and_temporary_save)
|
|
song = Song()
|
|
# Values will be set when cleaning the song.
|
|
song.search_lyrics = u''
|
|
song.verse_order = u''
|
|
song.search_title = u''
|
|
song.temporary = parse_and_temporary_save
|
|
self._process_copyright(properties, song)
|
|
self._process_cclinumber(properties, song)
|
|
self._process_titles(properties, song)
|
|
# The verse order is processed with the lyrics!
|
|
self._process_lyrics(properties, song_xml, song)
|
|
self._process_comments(properties, song)
|
|
self._process_authors(properties, song)
|
|
self._process_songbooks(properties, song)
|
|
self._process_topics(properties, song)
|
|
clean_song(self.manager, song)
|
|
self.manager.save_object(song)
|
|
return song
|
|
|
|
def _add_text_to_element(self, tag, parent, text=None, label=None):
|
|
if label:
|
|
element = etree.Element(tag, name=unicode(label))
|
|
else:
|
|
element = etree.Element(tag)
|
|
if text:
|
|
element.text = unicode(text)
|
|
parent.append(element)
|
|
return element
|
|
|
|
def _add_tag_to_formatting(self, tag_name, tags_element):
|
|
"""
|
|
Add new formatting tag to the element ``<format>`` if the tag is not
|
|
present yet.
|
|
"""
|
|
available_tags = FormattingTags.get_html_tags()
|
|
start_tag = '{%s}' % tag_name
|
|
for tag in available_tags:
|
|
if tag[u'start tag'] == start_tag:
|
|
# Create new formatting tag in openlyrics xml.
|
|
element = self._add_text_to_element(u'tag', tags_element)
|
|
element.set(u'name', tag_name)
|
|
element_open = self._add_text_to_element(u'open', element)
|
|
element_open.text = etree.CDATA(tag[u'start html'])
|
|
# Check if formatting tag contains end tag. Some formatting
|
|
# tags e.g. {br} has only start tag. If no end tag is present
|
|
# <close> element has not to be in OpenLyrics xml.
|
|
if tag['end tag']:
|
|
element_close = self._add_text_to_element(u'close', element)
|
|
element_close.text = etree.CDATA(tag[u'end html'])
|
|
|
|
def _add_text_with_tags_to_lines(self, verse_element, text, tags_element):
|
|
"""
|
|
Convert text with formatting tags from OpenLP format to OpenLyrics
|
|
format and append it to element ``<lines>``.
|
|
"""
|
|
start_tags = OpenLyrics.START_TAGS_REGEX.findall(text)
|
|
end_tags = OpenLyrics.END_TAGS_REGEX.findall(text)
|
|
# Replace start tags with xml syntax.
|
|
for tag in start_tags:
|
|
# Tags already converted to xml structure.
|
|
xml_tags = tags_element.xpath(u'tag/attribute::name')
|
|
# Some formatting tag has only starting part e.g. <br>.
|
|
# Handle this case.
|
|
if tag in end_tags:
|
|
text = text.replace(u'{%s}' % tag, u'<tag name="%s">' % tag)
|
|
else:
|
|
text = text.replace(u'{%s}' % tag, u'<tag name="%s"/>' % tag)
|
|
# Add tag to <format> element if tag not present.
|
|
if tag not in xml_tags:
|
|
self._add_tag_to_formatting(tag, tags_element)
|
|
# Replace end tags.
|
|
for tag in end_tags:
|
|
text = text.replace(u'{/%s}' % tag, u'</tag>')
|
|
# Replace \n with <br/>.
|
|
text = text.replace(u'\n', u'<br/>')
|
|
element = etree.XML(u'<lines>%s</lines>' % text)
|
|
verse_element.append(element)
|
|
return element
|
|
|
|
def _extract_xml(self, xml):
|
|
"""
|
|
Extract our newly created XML song.
|
|
"""
|
|
return etree.tostring(xml, encoding=u'UTF-8',
|
|
xml_declaration=True)
|
|
|
|
def _text(self, element):
|
|
"""
|
|
This returns the text of an element as unicode string.
|
|
|
|
``element``
|
|
The element.
|
|
"""
|
|
if element.text is not None:
|
|
return unicode(element.text)
|
|
return u''
|
|
|
|
def _process_authors(self, properties, song):
|
|
"""
|
|
Adds the authors specified in the XML to the song.
|
|
|
|
``properties``
|
|
The property object (lxml.objectify.ObjectifiedElement).
|
|
|
|
``song``
|
|
The song object.
|
|
"""
|
|
authors = []
|
|
if hasattr(properties, u'authors'):
|
|
for author in properties.authors.author:
|
|
display_name = self._text(author)
|
|
if display_name:
|
|
authors.append(display_name)
|
|
for display_name in authors:
|
|
author = self.manager.get_object_filtered(Author,
|
|
Author.display_name == display_name)
|
|
if author is None:
|
|
# We need to create a new author, as the author does not exist.
|
|
author = Author.populate(display_name=display_name,
|
|
last_name=display_name.split(u' ')[-1],
|
|
first_name=u' '.join(display_name.split(u' ')[:-1]))
|
|
song.authors.append(author)
|
|
|
|
def _process_cclinumber(self, properties, song):
|
|
"""
|
|
Adds the CCLI number to the song.
|
|
|
|
``properties``
|
|
The property object (lxml.objectify.ObjectifiedElement).
|
|
|
|
``song``
|
|
The song object.
|
|
"""
|
|
if hasattr(properties, u'ccliNo'):
|
|
song.ccli_number = self._text(properties.ccliNo)
|
|
|
|
def _process_comments(self, properties, song):
|
|
"""
|
|
Joins the comments specified in the XML and add it to the song.
|
|
|
|
``properties``
|
|
The property object (lxml.objectify.ObjectifiedElement).
|
|
|
|
``song``
|
|
The song object.
|
|
"""
|
|
if hasattr(properties, u'comments'):
|
|
comments_list = []
|
|
for comment in properties.comments.comment:
|
|
comment_text = self._text(comment)
|
|
if comment_text:
|
|
comments_list.append(comment_text)
|
|
song.comments = u'\n'.join(comments_list)
|
|
|
|
def _process_copyright(self, properties, song):
|
|
"""
|
|
Adds the copyright to the song.
|
|
|
|
``properties``
|
|
The property object (lxml.objectify.ObjectifiedElement).
|
|
|
|
``song``
|
|
The song object.
|
|
"""
|
|
if hasattr(properties, u'copyright'):
|
|
song.copyright = self._text(properties.copyright)
|
|
|
|
def _process_formatting_tags(self, song_xml, temporary):
|
|
"""
|
|
Process the formatting tags from the song and either add missing tags
|
|
temporary or permanently to the formatting tag list.
|
|
"""
|
|
if not hasattr(song_xml, u'format'):
|
|
return
|
|
found_tags = []
|
|
for tag in song_xml.format.tags.getchildren():
|
|
name = tag.get(u'name')
|
|
if name is None:
|
|
continue
|
|
start_tag = u'{%s}' % name[:5]
|
|
# Some tags have only start tag e.g. {br}
|
|
end_tag = u'{/' + name[:5] + u'}' if hasattr(tag, 'close') else u''
|
|
openlp_tag = {
|
|
u'desc': name,
|
|
u'start tag': start_tag,
|
|
u'end tag': end_tag,
|
|
u'start html': tag.open.text,
|
|
# Some tags have only start html e.g. {br}
|
|
u'end html': tag.close.text if hasattr(tag, 'close') else u'',
|
|
u'protected': False,
|
|
}
|
|
# Add 'temporary' key in case the formatting tag should not be
|
|
# saved otherwise it is supposed that formatting tag is permanent.
|
|
if temporary:
|
|
openlp_tag[u'temporary'] = temporary
|
|
found_tags.append(openlp_tag)
|
|
existing_tag_ids = [tag[u'start tag']
|
|
for tag in FormattingTags.get_html_tags()]
|
|
new_tags = [tag for tag in found_tags
|
|
if tag[u'start tag'] not in existing_tag_ids]
|
|
FormattingTags.add_html_tags(new_tags)
|
|
FormattingTags.save_html_tags()
|
|
|
|
def _process_lines_mixed_content(self, element, newlines=True):
|
|
"""
|
|
Converts the xml text with mixed content to OpenLP representation.
|
|
Chords are skipped and formatting tags are converted.
|
|
|
|
``element``
|
|
The property object (lxml.etree.Element).
|
|
|
|
``newlines``
|
|
The switch to enable/disable processing of line breaks <br/>.
|
|
The <br/> is used since OpenLyrics 0.8.
|
|
"""
|
|
text = u''
|
|
use_endtag = True
|
|
# Skip <comment> elements - not yet supported.
|
|
if element.tag == NSMAP % u'comment':
|
|
if element.tail:
|
|
# Append tail text at chord element.
|
|
text += element.tail
|
|
return text
|
|
# Skip <chord> element - not yet supported.
|
|
elif element.tag == NSMAP % u'chord':
|
|
if element.tail:
|
|
# Append tail text at chord element.
|
|
text += element.tail
|
|
return text
|
|
# Convert line breaks <br/> to \n.
|
|
elif newlines and element.tag == NSMAP % u'br':
|
|
text += u'\n'
|
|
if element.tail:
|
|
text += element.tail
|
|
return text
|
|
# Start formatting tag.
|
|
if element.tag == NSMAP % u'tag':
|
|
text += u'{%s}' % element.get(u'name')
|
|
# Some formattings may have only start tag.
|
|
# Handle this case if element has no children and contains no text.
|
|
if not element and not element.text:
|
|
use_endtag = False
|
|
# Append text from element.
|
|
if element.text:
|
|
text += element.text
|
|
# Process nested formatting tags.
|
|
for child in element:
|
|
# Use recursion since nested formatting tags are allowed.
|
|
text += self._process_lines_mixed_content(child, newlines)
|
|
# Append text from tail and add formatting end tag.
|
|
if element.tag == NSMAP % 'tag' and use_endtag:
|
|
text += u'{/%s}' % element.get(u'name')
|
|
# Append text from tail.
|
|
if element.tail:
|
|
text += element.tail
|
|
return text
|
|
|
|
def _process_verse_lines(self, lines, version):
|
|
"""
|
|
Converts lyrics lines to OpenLP representation.
|
|
|
|
``lines``
|
|
The lines object (lxml.objectify.ObjectifiedElement).
|
|
"""
|
|
text = u''
|
|
# Convert lxml.objectify to lxml.etree representation.
|
|
lines = etree.tostring(lines)
|
|
element = etree.XML(lines)
|
|
|
|
# OpenLyrics 0.8 uses <br/> for new lines.
|
|
# Append text from "lines" element to verse text.
|
|
if version > '0.7':
|
|
text = self._process_lines_mixed_content(element)
|
|
# OpenLyrics version <= 0.7 contais <line> elements to represent lines.
|
|
# First child element is tested.
|
|
else:
|
|
# Loop over the "line" elements removing comments and chords.
|
|
for line in element:
|
|
# Skip comment lines.
|
|
if line.tag == NSMAP % u'comment':
|
|
continue
|
|
if text:
|
|
text += u'\n'
|
|
text += self._process_lines_mixed_content(line, newlines=False)
|
|
return text
|
|
|
|
def _process_lyrics(self, properties, song_xml, song_obj):
|
|
"""
|
|
Processes the verses and search_lyrics for the song.
|
|
|
|
``properties``
|
|
The properties object (lxml.objectify.ObjectifiedElement).
|
|
|
|
``song_xml``
|
|
The objectified song (lxml.objectify.ObjectifiedElement).
|
|
|
|
``song_obj``
|
|
The song object.
|
|
"""
|
|
sxml = SongXML()
|
|
verses = {}
|
|
verse_def_list = []
|
|
try:
|
|
lyrics = song_xml.lyrics
|
|
except AttributeError:
|
|
raise OpenLyricsError(OpenLyricsError.LyricsError,
|
|
'<lyrics> tag is missing.',
|
|
unicode(translate('OpenLP.OpenLyricsImportError',
|
|
'<lyrics> tag is missing.')))
|
|
try:
|
|
verse_list = lyrics.verse
|
|
except AttributeError:
|
|
raise OpenLyricsError(OpenLyricsError.VerseError,
|
|
'<verse> tag is missing.',
|
|
unicode(translate('OpenLP.OpenLyricsImportError',
|
|
'<verse> tag is missing.')))
|
|
# Loop over the "verse" elements.
|
|
for verse in verse_list:
|
|
text = u''
|
|
# Loop over the "lines" elements.
|
|
for lines in verse.lines:
|
|
if text:
|
|
text += u'\n'
|
|
# Append text from "lines" element to verse text.
|
|
text += self._process_verse_lines(lines,
|
|
version=song_xml.get(u'version'))
|
|
# Add an optional split to the verse text.
|
|
if lines.get(u'break') is not None:
|
|
text += u'\n[---]'
|
|
verse_def = verse.get(u'name', u' ').lower()
|
|
verse_tag, verse_number, verse_part = \
|
|
OpenLyrics.VERSE_TAG_SPLITTER.search(verse_def).groups()
|
|
if verse_tag not in VerseType.Tags:
|
|
verse_tag = VerseType.Tags[VerseType.Other]
|
|
# OpenLyrics allows e. g. "c", but we need "c1". However, this does
|
|
# not correct the verse order.
|
|
if not verse_number:
|
|
verse_number = u'1'
|
|
lang = verse.get(u'lang')
|
|
translit = verse.get(u'translit')
|
|
# In OpenLP 1.9.6 we used v1a, v1b ... to represent visual slide
|
|
# breaks. In OpenLyrics 0.7 an attribute has been added.
|
|
if song_xml.get(u'modifiedIn') in (u'1.9.6', u'OpenLP 1.9.6') and \
|
|
song_xml.get(u'version') == u'0.7' and \
|
|
(verse_tag, verse_number, lang, translit) in verses:
|
|
verses[(verse_tag, verse_number, lang, translit, None)] += u'\n[---]\n' + text
|
|
# Merge v1a, v1b, .... to v1.
|
|
elif (verse_tag, verse_number, lang, translit, verse_part) in verses:
|
|
verses[(verse_tag, verse_number, lang, translit, verse_part)] += u'\n' + text
|
|
else:
|
|
verses[(verse_tag, verse_number, lang, translit, verse_part)] = text
|
|
verse_def_list.append((verse_tag, verse_number, lang, translit, verse_part))
|
|
# We have to use a list to keep the order, as dicts are not sorted.
|
|
for verse in verse_def_list:
|
|
sxml.add_verse_to_lyrics(
|
|
verse[0], verse[1], verses[verse], verse[2])
|
|
song_obj.lyrics = unicode(sxml.extract_xml(), u'utf-8')
|
|
# Process verse order
|
|
if hasattr(properties, u'verseOrder'):
|
|
song_obj.verse_order = self._text(properties.verseOrder)
|
|
|
|
def _process_songbooks(self, properties, song):
|
|
"""
|
|
Adds the song book and song number specified in the XML to the song.
|
|
|
|
``properties``
|
|
The property object (lxml.objectify.ObjectifiedElement).
|
|
|
|
``song``
|
|
The song object.
|
|
"""
|
|
song.song_book_id = None
|
|
song.song_number = u''
|
|
if hasattr(properties, u'songbooks'):
|
|
for songbook in properties.songbooks.songbook:
|
|
book_name = songbook.get(u'name', u'')
|
|
if book_name:
|
|
book = self.manager.get_object_filtered(Book,
|
|
Book.name == book_name)
|
|
if book is None:
|
|
# We need to create a book, because it does not exist.
|
|
book = Book.populate(name=book_name, publisher=u'')
|
|
self.manager.save_object(book)
|
|
song.song_book_id = book.id
|
|
song.song_number = songbook.get(u'entry', u'')
|
|
# We only support one song book, so take the first one.
|
|
break
|
|
|
|
def _process_titles(self, properties, song):
|
|
"""
|
|
Processes the titles specified in the song's XML.
|
|
|
|
``properties``
|
|
The property object (lxml.objectify.ObjectifiedElement).
|
|
|
|
``song``
|
|
The song object.
|
|
"""
|
|
for title in properties.titles.title:
|
|
if not song.title:
|
|
song.title = self._text(title)
|
|
song.alternate_title = u''
|
|
else:
|
|
song.alternate_title = self._text(title)
|
|
|
|
def _process_topics(self, properties, song):
|
|
"""
|
|
Adds the topics to the song.
|
|
|
|
``properties``
|
|
The property object (lxml.objectify.ObjectifiedElement).
|
|
|
|
``song``
|
|
The song object.
|
|
"""
|
|
if hasattr(properties, u'themes'):
|
|
for topic_text in properties.themes.theme:
|
|
topic_text = self._text(topic_text)
|
|
if topic_text:
|
|
topic = self.manager.get_object_filtered(Topic,
|
|
Topic.name == topic_text)
|
|
if topic is None:
|
|
# We need to create a topic, because it does not exist.
|
|
topic = Topic.populate(name=topic_text)
|
|
self.manager.save_object(topic)
|
|
song.topics.append(topic)
|
|
|
|
def _dump_xml(self, xml):
|
|
"""
|
|
Debugging aid to dump XML so that we can see what we have.
|
|
"""
|
|
return etree.tostring(xml, encoding=u'UTF-8',
|
|
xml_declaration=True, pretty_print=True)
|
|
|
|
|
|
class OpenLyricsError(Exception):
|
|
# XML tree is missing the lyrics tag
|
|
LyricsError = 1
|
|
# XML tree has no verse tags
|
|
VerseError = 2
|
|
|
|
def __init__(self, type, log_message, display_message):
|
|
Exception.__init__(self)
|
|
self.type = type
|
|
self.log_message = log_message
|
|
self.display_message = display_message
|