mirror of https://gitlab.com/openlp/openlp.git
155 lines
7.0 KiB
Python
155 lines
7.0 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
##########################################################################
|
|
# OpenLP - Open Source Lyrics Projection #
|
|
# ---------------------------------------------------------------------- #
|
|
# Copyright (c) 2008-2024 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 <https://www.gnu.org/licenses/>. #
|
|
##########################################################################
|
|
"""
|
|
The :mod:`propresenter` module provides the functionality for importing
|
|
ProPresenter song files into the current installation database.
|
|
"""
|
|
import base64
|
|
import logging
|
|
|
|
from lxml import objectify, etree
|
|
|
|
from openlp.core.common.i18n import translate
|
|
from openlp.core.widgets.wizard import WizardStrings
|
|
from openlp.plugins.songs.lib import strip_rtf
|
|
from openlp.plugins.songs.lib.importers.songimport import SongImport
|
|
from openlp.plugins.songs.lib.ui import SongStrings
|
|
|
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
|
|
class ProPresenterImport(SongImport):
|
|
"""
|
|
The :class:`ProPresenterImport` class provides OpenLP with the
|
|
ability to import ProPresenter 4-6 song files.
|
|
"""
|
|
def do_import(self):
|
|
self.import_wizard.progress_bar.setMaximum(len(self.import_source))
|
|
for file_path in self.import_source:
|
|
if self.stop_import_flag:
|
|
return
|
|
self.import_wizard.increment_progress_bar(
|
|
WizardStrings.ImportingType.format(source=file_path.name))
|
|
with file_path.open('rb') as xml_file:
|
|
try:
|
|
root = objectify.parse(xml_file).getroot()
|
|
except etree.XMLSyntaxError:
|
|
log.exception('XML syntax error in file {name}'.format(name=file_path))
|
|
self.log_error(file_path, SongStrings().XMLSyntaxError)
|
|
continue
|
|
except UnicodeDecodeError:
|
|
log.exception('Unreadable characters in {name}'.format(name=file_path))
|
|
self.log_error(file_path, SongStrings().XMLSyntaxError)
|
|
continue
|
|
try:
|
|
self.process_song(root, file_path)
|
|
except AttributeError:
|
|
log.exception('XML syntax error in file {name}'.format(name=file_path))
|
|
self.log_error(file_path, translate('SongsPlugin.ProPresenterImport',
|
|
'File is not a valid ProPresenter XMl file.'))
|
|
continue
|
|
|
|
def process_song(self, root, file_path):
|
|
"""
|
|
:param root:
|
|
:param pathlib.Path file_path: Path to the file thats being imported
|
|
:rtype: None
|
|
"""
|
|
self.set_defaults()
|
|
|
|
# Extract ProPresenter versionNumber
|
|
try:
|
|
self.version = int(root.get('versionNumber'))
|
|
except (ValueError, TypeError):
|
|
log.debug('ProPresenter versionNumber invalid or missing')
|
|
return
|
|
|
|
# Title
|
|
self.title = root.get('CCLISongTitle')
|
|
if not self.title or self.title == '':
|
|
self.title = file_path.stem
|
|
# Notes
|
|
self.comments = root.get('notes')
|
|
# Author
|
|
for author_key in ['author', 'CCLIAuthor', 'artist', 'CCLIArtistCredits']:
|
|
author = root.get(author_key)
|
|
if author and len(author) > 0:
|
|
self.parse_author(author)
|
|
|
|
# ProPresenter 4
|
|
if 400 <= self.version < 500:
|
|
self.copyright = root.get('CCLICopyrightInfo')
|
|
self.ccli_number = root.get('CCLILicenseNumber')
|
|
count = 0
|
|
for slide in root.slides.RVDisplaySlide:
|
|
count += 1
|
|
if not hasattr(slide.displayElements, 'RVTextElement'):
|
|
log.debug('No text found, may be an image slide')
|
|
continue
|
|
RTFData = slide.displayElements.RVTextElement.get('RTFData')
|
|
rtf = base64.standard_b64decode(RTFData)
|
|
words, encoding = strip_rtf(rtf.decode())
|
|
self.add_verse(words, "v{count}".format(count=count))
|
|
|
|
# ProPresenter 5
|
|
elif 500 <= self.version < 600:
|
|
self.copyright = root.get('CCLICopyrightInfo')
|
|
self.ccli_number = root.get('CCLILicenseNumber')
|
|
count = 0
|
|
for group in root.groups.RVSlideGrouping:
|
|
for slide in group.slides.RVDisplaySlide:
|
|
count += 1
|
|
if not hasattr(slide.displayElements, 'RVTextElement'):
|
|
log.debug('No text found, may be an image slide')
|
|
continue
|
|
RTFData = slide.displayElements.RVTextElement.get('RTFData')
|
|
rtf = base64.standard_b64decode(RTFData)
|
|
words, encoding = strip_rtf(rtf.decode())
|
|
self.add_verse(words, "v{count:d}".format(count=count))
|
|
|
|
# ProPresenter 6
|
|
elif 600 <= self.version < 700:
|
|
self.copyright = root.get('CCLICopyrightYear')
|
|
self.ccli_number = root.get('CCLISongNumber')
|
|
count = 0
|
|
for group in root.array.RVSlideGrouping:
|
|
for slide in group.array.RVDisplaySlide:
|
|
count += 1
|
|
for item in slide.array:
|
|
if not (item.get('rvXMLIvarName') == "displayElements"):
|
|
continue
|
|
if not hasattr(item, 'RVTextElement'):
|
|
log.debug('No text found, may be an image slide')
|
|
continue
|
|
for contents in item.RVTextElement.NSString:
|
|
b64Data = contents.text
|
|
data = base64.standard_b64decode(b64Data)
|
|
words = None
|
|
if contents.get('rvXMLIvarName') == "RTFData":
|
|
words, encoding = strip_rtf(data.decode())
|
|
break
|
|
if words:
|
|
self.add_verse(words, "v{count:d}".format(count=count))
|
|
|
|
if not self.finish():
|
|
self.log_error(self.import_source)
|