# -*- coding: utf-8 -*- ########################################################################## # OpenLP - Open Source Lyrics Projection # # ---------------------------------------------------------------------- # # Copyright (c) 2008-2022 OpenLP Developers # # ---------------------------------------------------------------------- # # 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, either version 3 of the License, or # # (at your option) any later version. # # # # 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, see . # ########################################################################## """ The :mod:`powersong` module provides the functionality for importing PowerSong songs into the OpenLP database. """ import logging from pathlib import Path from openlp.core.common.i18n import translate from openlp.plugins.songs.lib.importers.songimport import SongImport log = logging.getLogger(__name__) class PowerSongImport(SongImport): """ The :class:`PowerSongImport` class provides the ability to import song files from PowerSong. **PowerSong 1.0 Song File Format:** The file has a number of label-field (think key-value) pairs. Label and Field strings: * Every label and field is a variable length string preceded by an integer specifying it's byte length. * Integer is 32-bit but is encoded in 7-bit format to save space. Thus if length will fit in 7 bits (ie <= 127) it takes up only one byte. Metadata fields: * Every PowerSong file has a TITLE field. * There is zero or more AUTHOR fields. * There is always a COPYRIGHTLINE label, but its field may be empty. This field may also contain a CCLI number: e.g. "CCLI 176263". Lyrics fields: * Each verse is contained in a PART field. * Lines have Windows line endings ``CRLF`` (0x0d, 0x0a). * There is no concept of verse types. Valid extensions for a PowerSong song file are: * .song """ @staticmethod def is_valid_source(import_source): """ Checks if source is a PowerSong 1.0 folder: * is a directory * contains at least one * .song file :param Path import_source: Should be a Path object that fulfills the above criteria :return: If the source is valid :rtype: bool """ if import_source.is_dir(): for file_path in import_source.iterdir(): if file_path.suffix == '.song': return True return False def do_import(self): """ Receive either a list of files or a folder (unicode) to import. """ from openlp.plugins.songs.lib.importer import SongFormat ps_string = SongFormat.get(SongFormat.PowerSong, 'name') if isinstance(self.import_source, Path): if self.import_source.is_dir(): dir = self.import_source self.import_source = [] for path in dir.glob('*.song'): self.import_source.append(path) else: self.import_source = None if not self.import_source or not isinstance(self.import_source, list): self.log_error(translate('SongsPlugin.PowerSongImport', 'No songs to import.'), translate('SongsPlugin.PowerSongImport', 'No {text} files found.').format(text=ps_string)) return self.import_wizard.progress_bar.setMaximum(len(self.import_source)) for file_path in self.import_source: if self.stop_import_flag: return self.set_defaults() parse_error = False with file_path.open('rb') as song_data: while True: try: label = self._read_string(song_data) if not label: break field = self._read_string(song_data) except ValueError: parse_error = True self.log_error(file_path.name, translate('SongsPlugin.PowerSongImport', 'Invalid {text} file. Unexpected byte value.').format(text=ps_string)) break else: if label == 'TITLE': self.title = field.replace('\n', ' ') elif label == 'AUTHOR': self.parse_author(field) elif label == 'COPYRIGHTLINE': found_copyright = True self._parse_copyright_cCCLI(field) elif label == 'PART': self.add_verse(field) if parse_error: continue # Check that file had TITLE field if not self.title: self.log_error(file_path.name, translate('SongsPlugin.PowerSongImport', 'Invalid {text} file. Missing "TITLE" header.').format(text=ps_string)) continue # Check that file had COPYRIGHTLINE label if not found_copyright: self.log_error(self.title, translate('SongsPlugin.PowerSongImport', 'Invalid {text} file. Missing "COPYRIGHTLINE" header.').format(text=ps_string)) continue # Check that file had at least one verse if not self.verses: self.log_error(self.title, translate('SongsPlugin.PowerSongImport', 'Verses not found. Missing "PART" header.')) continue if not self.finish(): self.log_error(self.title) def _read_string(self, file_object): """ Reads in next variable-length string. """ string_len = self._read_7_bit_encoded_integer(file_object) return str(file_object.read(string_len), 'utf-8', 'ignore') def _read_7_bit_encoded_integer(self, file_object): """ Reads in a 32-bit integer in compressed 7-bit format. Accomplished by reading the integer 7 bits at a time. The high bit of the byte when set means to continue reading more bytes. If the integer will fit in 7 bits (ie <= 127), it only takes up one byte. Otherwise, it may take up to 5 bytes. Reference: .NET method System.IO.BinaryReader.Read7BitEncodedInt """ val = 0 shift = 0 i = 0 while True: # Check for corrupted stream (since max 5 bytes per 32-bit integer) if i == 5: raise ValueError byte = self._read_byte(file_object) # Strip high bit and shift left val += (byte & 0x7f) << shift shift += 7 high_bit_set = byte & 0x80 if not high_bit_set: break i += 1 return val def _read_byte(self, file_object): """ Reads in next byte as an unsigned integer Note: returns 0 at end of file. """ byte_str = file_object.read(1) # If read result is empty, then reached end of file if not byte_str: return 0 else: return ord(byte_str) def _parse_copyright_cCCLI(self, field): """ Look for CCLI song number, and get copyright """ copyright, sep, ccli_no = field.rpartition('CCLI') if not sep: copyright = ccli_no ccli_no = '' if copyright: self.add_copyright(copyright.rstrip('\n').replace('\n', ' ')) if ccli_no: ccli_no = ccli_no.strip(' :') if ccli_no.isdigit(): self.ccli_number = ccli_no