openlp-core team mailing list archive

[phill <phill.ridout@xxxxxxxxxxxxxx>]

phill has proposed merging lp:~phill-ridout/openlp/wow_import into lp:openlp.

Requested reviews:
  Jon Tibble (meths)


Some how, I managed to screw launch pad up. Hope this merge works!

Phill
-- 
https://code.launchpad.net/~phill-ridout/openlp/wow_import/+merge/32709
Your team OpenLP Core is subscribed to branch lp:openlp.

=== modified file 'openlp/plugins/songs/lib/__init__.py'
--- openlp/plugins/songs/lib/__init__.py	2010-07-28 13:32:12 +0000
+++ openlp/plugins/songs/lib/__init__.py	2010-08-15 15:42:43 +0000
@@ -147,5 +147,6 @@
 try:
     from sofimport import SofImport
     from oooimport import OooImport
+    from wowimport import WowImport
 except ImportError:
     pass

=== added file 'openlp/plugins/songs/lib/wowimport.py'
--- openlp/plugins/songs/lib/wowimport.py	1970-01-01 00:00:00 +0000
+++ openlp/plugins/songs/lib/wowimport.py	2010-08-15 15:42:43 +0000
@@ -0,0 +1,173 @@
+# -*- coding: utf-8 -*-
+# vim: autoindent shiftwidth=4 expandtab textwidth=80 tabstop=4 softtabstop=4
+
+###############################################################################
+# OpenLP - Open Source Lyrics Projection                                      #
+# --------------------------------------------------------------------------- #
+# Copyright (c) 2008-2010 Raoul Snyman                                        #
+# Portions copyright (c) 2008-2010 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                          #
+###############################################################################
+"""
+The :mod:`wowimport` module provides the functionality for importing Words of 
+Worship songs into the OpenLP database.
+"""
+import os
+import logging
+
+from openlp.plugins.songs.lib.songimport import SongImport
+
+BLOCK_TYPES = (u'V',  u'C',  u'B')
+
+log = logging.getLogger(__name__)
+
+class WowImport(SongImport):
+    """
+    The :class:`WowImport` class provides the ability to import song files from 
+    Words of Worship.
+
+    Words Of Worship Song File Format
+    `````````````````````````````````
+    
+    The Words Of Worship song file format is as follows:
+
+    * The song title is the file name minus the extension.
+    * The song has a header, a number of blocks, followed by footer containing 
+    the author and the copyright.
+    * A block can be a verse, chorus or bridge.
+    
+    File Header:
+        Bytes are counted from one, i.e. the first byte is byte 1. These bytes,
+        up to the 56 byte, can change but no real meaning has been found. The
+        56th byte specifies how many blocks there are. The first block starts
+        with byte 83 after the "CSongDoc::CBlock" declaration.
+
+    Blocks:
+        Each block has a starting header, some lines of text, and an ending
+        footer. Each block starts with 4 bytes, the first byte specifies how
+        many lines are in that block, the next three bytes are null bytes.
+
+        Each block ends with 4 bytes, the first of which defines what type of
+        block it is, and the rest which are null bytes:
+
+        * ``NUL`` (\x00) - Verse
+        * ``SOH`` (\x01) - Chorus
+        * ``STX`` (\x02) - Bridge
+
+        Blocks are seperated by two bytes. The first byte is ``SOH`` (\x01),
+        and the second byte is ``€`` (\x80).
+
+    Lines:
+        Each line starts with a byte which specifies how long that line is,
+        the line text, and ends with a null byte.
+
+  
+    Footer:
+        The footer follows on after the last block, the first byte specifies 
+        the length of the author text, followed by the author text, if 
+        this byte is null, then there is no author text. The byte after the 
+        author text specifies the length of the copyright text, followed 
+        by the copyright text. 
+        
+        The file is ended with four null bytes.
+    
+    Valid extensions for a Words of Worship song file are:
+    
+    * .wsg
+    * .wow-song
+    """
+
+    def do_import(self, files):
+        """
+        Recieve a single file, or a list of files to import.
+        
+        ``files``
+            Either a single file or a list of files passed from the import 
+            wizard.
+        """
+        
+        if isinstance(files,  list):
+            for file in files:
+                self.do_import_file(file)
+                self.finish()
+        else:
+            self.do_import_file(files)
+            self.finish()
+
+    def do_import_file(self,  filepath):
+        """
+        Process a single Words of Worship file
+        
+        ``filepath``
+            The path for the Words of Worship Song to import.
+
+        ``master_manager``
+            The song manager for the running OpenLP installation.
+
+        ``source_db``
+            The database providing the data to import.
+        """
+        
+        log.info('Direct import %s', filepath)
+        # TODO: check that it is a valid words of worship file (could check 
+        # header for WoW File Song Word)
+        self.author = u''
+        self.copyright= u''
+        # Get the song title
+        self.file_name = os.path.split(filepath)[1]
+        self.title = unicode(self.file_name.rpartition(u'.')[0], u'cp1252')
+        self.songData = open(filepath, 'rb')
+        # Seek to byte which stores number of blocks in the song
+        self.songData.seek(56) 
+        self.no_of_blocks = ord(self.songData.read(1))
+        # Seek to the beging of the first block
+        self.songData.seek(82) 
+        for block in range(self.no_of_blocks):
+            self.lines_to_read = ord(self.songData.read(1))
+            # Skip 3 nulls to the beginnig of the 1st line
+            self.songData.seek(3, os.SEEK_CUR) 
+            self.block_text = u''
+            for line in range(self.lines_to_read):
+                self.length_of_line = ord(self.songData.read(1))
+                self.line_text = unicode(
+                    self.songData.read(self.length_of_line), u'cp1252')
+                self.songData.seek(1, os.SEEK_CUR)
+                if self.block_text != u'':
+                    self.block_text += u'\n'
+                self.block_text += self.line_text
+            self.block_type = BLOCK_TYPES[ord(self.songData.read(1))]
+            # Skip 3 nulls at the end of the block
+            self.songData.seek(3, os.SEEK_CUR)
+            # Blocks are seperated by 2 bytes, skip them, but not if 
+            # this is the last block!
+            if (block + 1) < self.no_of_blocks:
+                self.songData.seek(2, os.SEEK_CUR)
+            self.add_verse(self.block_text, self.block_type)
+        # Now to extact the author
+        self.author_length = ord(self.songData.read(1))
+        if self.author_length != 0:
+            self.author = unicode(self.songData.read(self.author_length),
+                u'cp1252')
+        # Finally the copyright
+        self.copyright_length = ord(self.songData.read(1))
+        if self.copyright_length != 0:
+            self.copyright = unicode(self.songData.read(self.copyright_length),
+                u'cp1252')
+        self.parse_author(self.author)
+        self.add_copyright(self.copyright)
+        self.songData.close()

=== modified file 'openlp/plugins/songs/songsplugin.py'
--- openlp/plugins/songs/songsplugin.py	2010-07-31 02:06:44 +0000
+++ openlp/plugins/songs/songsplugin.py	2010-08-15 15:42:43 +0000
@@ -39,7 +39,7 @@
 except ImportError:
     OOo_available = False
 
-from openlp.plugins.songs.lib import OpenSongImport
+from openlp.plugins.songs.lib import OpenSongImport, WowImport
 
 log = logging.getLogger(__name__)
 
@@ -169,6 +169,24 @@
         import_menu.addAction(self.ImportOpenLPSongItem)
         QtCore.QObject.connect(self.ImportOpenLPSongItem,
             QtCore.SIGNAL(u'triggered()'), self.onImportOpenLPSongItemClick)
+        # Words of Worship import menu item - will be removed and the
+        # functionality will be contained within the import wizard
+        self.ImportWowItem = QtGui.QAction(import_menu)
+        self.ImportWowItem.setObjectName(u'ImportWowItem')
+        self.ImportWowItem.setText(
+            translate('SongsPlugin',
+                'Words of Worship (temp menu item)'))
+        self.ImportWowItem.setToolTip(
+            translate('SongsPlugin',
+                'Import songs from Words of Worship files' +
+                '(either raw text or ZIPfiles)'))
+        self.ImportWowItem.setStatusTip(
+            translate('SongsPlugin',
+                'Import songs from Words of Worship files' +
+                '(either raw text or ZIPfiles)'))
+        import_menu.addAction(self.ImportWowItem)
+        QtCore.QObject.connect(self.ImportWowItem,
+                QtCore.SIGNAL(u'triggered()'), self.onImportWowItemClick)
 
     def addExportMenuItem(self, export_menu):
         """
@@ -240,6 +258,23 @@
                 'Error importing OpenLP v2 database(s)'))
         Receiver.send_message(u'songs_load_list')
 
+    def onImportWowItemClick(self):
+        filenames = QtGui.QFileDialog.getOpenFileNames(
+            None, translate('SongsPlugin',
+                'Open Words of Worship file'),
+            u'', u'Words of Worship file (*.wsg *.wow-song)')
+        try:
+            for filename in filenames:
+                wowimport = WowImport(self.manager)
+                wowimport.do_import(unicode(filename))
+        except:
+            log.exception('Could not import WoW file')
+            QtGui.QMessageBox.critical(None,
+                translate('SongsPlugin', 'Import Error'),
+                translate('SongsPlugin', 'Error importing Words of '
+                    'Worship file.'))
+        Receiver.send_message(u'songs_load_list')
+
     def onImportOooItemClick(self):
         filenames = QtGui.QFileDialog.getOpenFileNames(
             None, translate('SongsPlugin', 'Open documents or presentations'),