Update songs for multi-language lyrics

bzr-revno: 1231

openlp/plugins/songs/forms/songimportform.py

@@ -654,7 +654,7 @@ class SongImportForm(OpenLPWizard):
             'Select EasiSlides songfile'),
             self.easiSlidesFilenameEdit
         )
-  
+
     def onEWBrowseButtonClicked(self):
         """
         Get EasyWorship song database files

openlp/plugins/songs/lib/easislidesimport.py

@@ -313,7 +313,6 @@ class EasiSlidesImport(SongImport):
                     tag = SeqTypes[tag.lower()]
                 else:
                     continue
- 
                 if tag in versetags:
                     self.verse_order_list.append(tag)
                 else:

openlp/plugins/songs/lib/openlyricsimport.py

@@ -61,17 +61,18 @@ class OpenLyricsImport(SongImport):
         Imports the songs.
         """
         self.import_wizard.progressBar.setMaximum(len(self.import_source))
+        parser = etree.XMLParser(remove_blank_text=True)
         for file_path in self.import_source:
             if self.stop_import_flag:
                 return False
             self.import_wizard.incrementProgressBar(unicode(translate(
                 'SongsPlugin.OpenLyricsImport', 'Importing %s...')) %
                 os.path.basename(file_path))
-            parser = etree.XMLParser(remove_blank_text=True)
+            try:
-            parsed_file = etree.parse(file_path, parser)
+                parsed_file = etree.parse(file_path, parser)
-            xml = unicode(etree.tostring(parsed_file))
+                xml = unicode(etree.tostring(parsed_file))
-            if self.openLyrics.xml_to_song(xml) is None:
+                if self.openLyrics.xml_to_song(xml) is None:
-                log.debug(u'File could not be imported: %s' % file_path)
+                    log.debug(u'File could not be imported: %s' % file_path)
-                # Importing this song failed! For now we stop import.
+            except etree.XMLSyntaxError:
-                return False
+                log.exception(u'XML syntax error in file %s' % file_path)
         return True

openlp/plugins/songs/lib/songimport.py

@@ -197,16 +197,24 @@ class SongImport(QtCore.QObject):
             return
         self.media_files.append(filename)
 
-    def add_verse(self, verse, versetag=u'V'):
+    def add_verse(self, versetext, versetag=u'V', lang=None):
         """
-        Add a verse. This is the whole verse, lines split by \n
+        Add a verse. This is the whole verse, lines split by \n. It will also
-        Verse tag can be V1/C1/B etc, or 'V' and 'C' (will count the verses/
+        attempt to detect duplicates. In this case it will just add to the verse
-        choruses itself) or None, where it will assume verse
+        order.
-        It will also attempt to detect duplicates. In this case it will just
+
-        add to the verse order
+        ``versetext``
+            The text of the verse.
+
+        ``versetag``
+            The verse tag can be V1/C1/B etc, or 'V' and 'C' (will count the
+            verses/choruses itself) or None, where it will assume verse.
+
+        ``lang``
+            The language code (ISO-639) of the verse, for example *en* or *de*.
         """
-        for (oldversetag, oldverse) in self.verses:
+        for (oldversetag, oldverse, oldlang) in self.verses:
-            if oldverse.strip() == verse.strip():
+            if oldverse.strip() == versetext.strip():
                 self.verse_order_list.append(oldversetag)
                 return
         if versetag[0] in self.versecounts:
@@ -217,7 +225,7 @@ class SongImport(QtCore.QObject):
             versetag += unicode(self.versecounts[versetag[0]])
         elif int(versetag[1:]) > self.versecounts[versetag[0]]:
             self.versecounts[versetag[0]] = int(versetag[1:])
-        self.verses.append([versetag, verse.rstrip()])
+        self.verses.append([versetag, versetext.rstrip(), lang])
         self.verse_order_list.append(versetag)
         if versetag.startswith(u'V') and self.contains_verse(u'C1'):
             self.verse_order_list.append(u'C1')
@@ -266,7 +274,7 @@ class SongImport(QtCore.QObject):
         verses_changed_to_other = {}
         sxml = SongXML()
         other_count = 1
-        for (versetag, versetext) in self.verses:
+        for (versetag, versetext, lang) in self.verses:
             if versetag[0] == u'C':
                 versetype = VerseType.to_string(VerseType.Chorus)
             elif versetag[0] == u'V':
@@ -286,7 +294,7 @@ class SongImport(QtCore.QObject):
                 versetype = VerseType.to_string(VerseType.Other)
                 log.info(u'Versetype %s changing to %s' , versetag, newversetag)
                 versetag = newversetag
-            sxml.add_verse_to_lyrics(versetype, versetag[1:], versetext)
+            sxml.add_verse_to_lyrics(versetype, versetag[1:], versetext, lang)
             song.search_lyrics += u' ' + self.remove_punctuation(versetext)
         song.search_lyrics = song.search_lyrics.lower()
         song.lyrics = unicode(sxml.extract_xml(), u'utf-8')
@@ -338,7 +346,7 @@ class SongImport(QtCore.QObject):
             + u'========================================'
         print u'TITLE: ' + self.title
         print u'ALT TITLE: ' + self.alternate_title
-        for (versetag, versetext) in self.verses:
+        for (versetag, versetext, lang) in self.verses:
             print u'VERSE ' + versetag + u': ' + versetext
         print u'ORDER: ' + u' '.join(self.verse_order_list)
         for author in self.authors:

openlp/plugins/songs/lib/xml.py

@@ -31,7 +31,7 @@ The basic XML for storing the lyrics in the song database is of the format::
     <?xml version="1.0" encoding="UTF-8"?>
     <song version="1.0">
         <lyrics>
-            <verse type="chorus" label="1">
+            <verse type="Chorus" label="1" lang="en">
                 <![CDATA[ ... ]]>
             </verse>
         </lyrics>
@@ -84,7 +84,7 @@ class SongXML(object):
         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):
+    def add_verse_to_lyrics(self, type, number, content, lang=None):
         """
         Add a verse to the *<lyrics>* tag.
 
@@ -97,9 +97,15 @@ class SongXML(object):
 
         ``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.
         """
         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)
 
@@ -117,6 +123,11 @@ class SongXML(object):
 
         ``xml``
             The XML of the song to be parsed.
+
+        The returned list has the following format::
+
+            [[{'lang': 'en', 'type': 'V', 'label': '1'}, u"The English verse."],
+            [{'lang': 'en', 'type': 'C', 'label': '1'}, u"The English chorus."]]
         """
         self.song_xml = None
         if xml[:5] == u'<?xml':
@@ -196,7 +207,7 @@ class OpenLyrics(object):
         This property is not supported.
 
     *<verse name="v1a" lang="he" translit="en">*
-        The attribute *translit* and *lang* are not supported.
+        The attribute *translit* is not supported.
 
     *<verseOrder>*
         OpenLP supports this property.
@@ -268,13 +279,16 @@ class OpenLyrics(object):
         # No xml get out of here.
         if not xml:
             return None
-        song = Song()
         if xml[:5] == u'<?xml':
             xml = xml[38:]
         # Remove chords from xml.
         xml = re.compile(u'<chord name=".*?"/>').sub(u'', xml)
         song_xml = objectify.fromstring(xml)
-        properties = song_xml.properties
+        try:
+            properties = song_xml.properties
+        except AttributeError:
+            return None
+        song = Song()
         self._process_copyright(properties, song)
         self._process_cclinumber(properties, song)
         self._process_titles(properties, song)
@@ -442,7 +456,10 @@ class OpenLyrics(object):
             if not verse_number:
                 verse_number = u'1'
             temp_verse_order.append((verse_type, verse_number, verse_part))
-            sxml.add_verse_to_lyrics(verse_type, verse_number, text)
+            lang = None
+            if self._get(verse, u'lang'):
+                lang = self._get(verse, u'lang')
+            sxml.add_verse_to_lyrics(verse_type, verse_number, text, lang)
             search_text = search_text + text
         song.search_lyrics = search_text.lower()
         song.lyrics = unicode(sxml.extract_xml(), u'utf-8')

openlp/plugins/songs/songsplugin.py

@@ -134,7 +134,7 @@ class SongsPlugin(Plugin):
 
     def onToolsReindexItemTriggered(self):
         """
-        Rebuild the search title of each song.
+        Rebuild each song.
         """
         maxSongs = self.manager.get_object_count(Song)
         progressDialog = QtGui.QProgressDialog(
@@ -150,8 +150,13 @@ class SongsPlugin(Plugin):
                 song.title = u''
             if song.alternate_title is None:
                 song.alternate_title = u''
-            song.search_title = self.whitespace.sub(u' ', song.title.lower() + \
+            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:
@@ -159,8 +164,7 @@ class SongsPlugin(Plugin):
             song.search_lyrics = lyrics.lower()
             progressDialog.setValue(counter)
         self.manager.save_objects(songs)
-        counter += 1
+        progressDialog.setValue(counter + 1)
-        progressDialog.setValue(counter)
         self.mediaItem.displayResultsSong(
             self.manager.get_all_objects(Song, order_by_ref=Song.search_title))