# -*- 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:`songshowplusimport` module provides the functionality for importing 
SongShow Plus songs into the OpenLP database.
"""
import os
import logging
import struct

from openlp.core.ui.wizard import WizardStrings
from openlp.plugins.songs.lib import VerseType
from openlp.plugins.songs.lib.songimport import SongImport

TITLE = 1
AUTHOR = 2
COPYRIGHT = 3
CCLI_NO = 5
VERSE = 12
CHORUS = 20
TOPIC = 29
COMMENTS = 30
VERSE_ORDER = 31
SONG_BOOK = 35
SONG_NUMBER = 36
CUSTOM_VERSE = 37
BRIDGE = 24

log = logging.getLogger(__name__)

class SongShowPlusImport(SongImport):
    """
    The :class:`SongShowPlusImport` class provides the ability to import song
    files from SongShow Plus.

    **SongShow Plus Song File Format:**

    The SongShow Plus song file format is as follows:

    * Each piece of data in the song file has some information that precedes
    it.
    * The general format of this data is as follows:
    4 Bytes, forming a 32 bit number, a key if you will, this describes what
    the data is (see blockKey below)
    4 Bytes, forming a 32 bit number, which is the number of bytes until the
    next block starts
    1 Byte, which tells how namy bytes follows
    1 or 4 Bytes, describes how long the string is, if its 1 byte, the string
    is less than 255
    The next bytes are the actuall data.
    The next block of data follows on.

    This description does differ for verses. Which includes extra bytes
    stating the verse type or number. In some cases a "custom" verse is used,
    in that case, this block will in include 2 strings, with the associated
    string length descriptors. The first string is the name of the verse, the
    second is the verse content.

    The file is ended with four null bytes.

    Valid extensions for a SongShow Plus song file are:

    * .sbsong
    """
    otherList = {}
    otherCount = 0

    def __init__(self, manager, **kwargs):
        """
        Initialise the SongShow Plus importer.
        """
        SongImport.__init__(self, manager, **kwargs)

    def doImport(self):
        """
        Receive a single file or a list of files to import.
        """
        if not isinstance(self.importSource, list):
            return
        self.importWizard.progressBar.setMaximum(len(self.importSource))
        for file in self.importSource:
            if self.stopImportFlag:
                return
            self.sspVerseOrderList = []
            other_count = 0
            other_list = {}
            file_name = os.path.split(file)[1]
            self.importWizard.incrementProgressBar(
                WizardStrings.ImportingType % file_name, 0)
            song_data = open(file, 'rb')
            while True:
                block_key, = struct.unpack("I", song_data.read(4))
                # The file ends with 4 NUL's
                if block_key == 0:
                    break
                next_block_starts, = struct.unpack("I", song_data.read(4))
                next_block_starts += song_data.tell()
                if block_key in (VERSE, CHORUS, BRIDGE):
                    null, verse_no, = struct.unpack("BB", song_data.read(2))
                elif block_key == CUSTOM_VERSE:
                    null, verse_name_length, = struct.unpack("BB",
                        song_data.read(2))
                    verse_name = song_data.read(verse_name_length)
                length_descriptor_size, = struct.unpack("B", song_data.read(1))
                log.debug(length_descriptor_size)
                # Detect if/how long the length descriptor is
                if length_descriptor_size == 12 or length_descriptor_size == 20:
                    length_descriptor, = struct.unpack("I", song_data.read(4))
                elif length_descriptor_size == 2:
                    length_descriptor = 1
                elif length_descriptor_size == 9:
                    length_descriptor = 0
                else:
                    length_descriptor, = struct.unpack("B", song_data.read(1))
                log.debug(length_descriptor_size)
                data = song_data.read(length_descriptor)
                if block_key == TITLE:
                    self.title = unicode(data, u'cp1252')
                elif block_key == AUTHOR:
                    authors = data.split(" / ")
                    for author in authors:
                        if author.find(",") !=-1:
                            authorParts = author.split(", ")
                            author = authorParts[1] + " " + authorParts[0]
                        self.parseAuthor(unicode(author, u'cp1252'))
                elif block_key == COPYRIGHT:
                    self.addCopyright(unicode(data, u'cp1252'))
                elif block_key == CCLI_NO:
                    self.ccliNumber = int(data)
                elif block_key == VERSE:
                    self.addVerse(unicode(data, u'cp1252'),
                        "%s%s" % (VerseType.Tags[VerseType.Verse], verse_no))
                elif block_key == CHORUS:
                    self.addVerse(unicode(data, u'cp1252'),
                        "%s%s" % (VerseType.Tags[VerseType.Chorus], verse_no))
                elif block_key == BRIDGE:
                    self.addVerse(unicode(data, u'cp1252'),
                        "%s%s" % (VerseType.Tags[VerseType.Bridge], verse_no))
                elif block_key == TOPIC:
                    self.topics.append(unicode(data, u'cp1252'))
                elif block_key == COMMENTS:
                    self.comments = unicode(data, u'cp1252')
                elif block_key == VERSE_ORDER:
                    verse_tag = self.toOpenLPVerseTag(data, True)
                    if verse_tag:
                        if not isinstance(verse_tag, unicode):
                            verse_tag = unicode(verse_tag, u'cp1252')
                        self.sspVerseOrderList.append(verse_tag)
                elif block_key == SONG_BOOK:
                    self.songBookName = unicode(data, u'cp1252')
                elif block_key == SONG_NUMBER:
                    self.songNumber = ord(data)
                elif block_key == CUSTOM_VERSE:
                    verse_tag = self.toOpenLPVerseTag(verse_name)
                    self.addVerse(unicode(data, u'cp1252'), verse_tag)
                else:
                    log.debug("Unrecognised blockKey: %s, data: %s"
                        % (block_key, data))
                    song_data.seek(next_block_starts)
            self.verseOrderList = self.sspVerseOrderList
            song_data.close()
            if not self.finish():
                self.logError(file)

    def toOpenLPVerseTag(self, verse_name, ignore_unique=False):
        if verse_name.find(" ") != -1:
            verse_parts = verse_name.split(" ")
            verse_type = verse_parts[0]
            verse_number = verse_parts[1]
        else:
            verse_type = verse_name
            verse_number = "1"
        verse_type = verse_type.lower()
        if verse_type == "verse":
            verse_tag = VerseType.Tags[VerseType.Verse]
        elif verse_type == "chorus":
            verse_tag = VerseType.Tags[VerseType.Chorus]
        elif verse_type == "bridge":
            verse_tag = VerseType.Tags[VerseType.Bridge]
        elif verse_type == "pre-chorus":
            verse_tag = VerseType.Tags[VerseType.PreChorus]
        else:
            if verse_name not in self.otherList:
                if ignore_unique:
                    return None
                self.otherCount = self.otherCount + 1
                self.otherList[verse_name] = str(self.otherCount)
            verse_tag = VerseType.Tags[VerseType.Other]
            verse_number = self.otherList[verse_name]
        return verse_tag + verse_number
