forked from openlp/openlp
221 lines
10 KiB
Python
221 lines
10 KiB
Python
# -*- coding: utf-8 -*-
|
|
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
|
|
|
|
###############################################################################
|
|
# OpenLP - Open Source Lyrics Projection #
|
|
# --------------------------------------------------------------------------- #
|
|
# Copyright (c) 2008-2014 Raoul Snyman #
|
|
# Portions copyright (c) 2008-2014 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, Patrick Zimmermann #
|
|
# --------------------------------------------------------------------------- #
|
|
# 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:`olpimport` module provides the functionality for importing OpenLP
|
|
song databases into the current installation database.
|
|
"""
|
|
import logging
|
|
|
|
from sqlalchemy import create_engine, MetaData, Table
|
|
from sqlalchemy.orm import class_mapper, mapper, relation, scoped_session, sessionmaker
|
|
from sqlalchemy.orm.exc import UnmappedClassError
|
|
|
|
from openlp.core.common import translate
|
|
from openlp.core.lib.db import BaseModel
|
|
from openlp.core.ui.wizard import WizardStrings
|
|
from openlp.plugins.songs.lib import clean_song
|
|
from openlp.plugins.songs.lib.db import Author, Book, Song, Topic, MediaFile
|
|
from .songimport import SongImport
|
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
|
|
class OpenLPSongImport(SongImport):
|
|
"""
|
|
The :class:`OpenLPSongImport` class provides OpenLP with the ability to
|
|
import song databases from other installations of OpenLP.
|
|
"""
|
|
def __init__(self, manager, **kwargs):
|
|
"""
|
|
Initialise the import.
|
|
|
|
:param manager: The song manager for the running OpenLP installation.
|
|
:param kwargs: The database providing the data to import.
|
|
"""
|
|
SongImport.__init__(self, manager, **kwargs)
|
|
self.source_session = None
|
|
|
|
def do_import(self, progress_dialog=None):
|
|
"""
|
|
Run the import for an OpenLP version 2 song database.
|
|
|
|
:param progress_dialog: The QProgressDialog used when importing songs from the FRW.
|
|
"""
|
|
|
|
class OldAuthor(BaseModel):
|
|
"""
|
|
Author model
|
|
"""
|
|
pass
|
|
|
|
class OldBook(BaseModel):
|
|
"""
|
|
Book model
|
|
"""
|
|
pass
|
|
|
|
class OldMediaFile(BaseModel):
|
|
"""
|
|
MediaFile model
|
|
"""
|
|
pass
|
|
|
|
class OldSong(BaseModel):
|
|
"""
|
|
Song model
|
|
"""
|
|
pass
|
|
|
|
class OldTopic(BaseModel):
|
|
"""
|
|
Topic model
|
|
"""
|
|
pass
|
|
|
|
# Check the file type
|
|
if not self.import_source.endswith('.sqlite'):
|
|
self.log_error(self.import_source, translate('SongsPlugin.OpenLPSongImport',
|
|
'Not a valid OpenLP 2.0 song database.'))
|
|
return
|
|
self.import_source = 'sqlite:///%s' % self.import_source
|
|
# Load the db file
|
|
engine = create_engine(self.import_source)
|
|
source_meta = MetaData()
|
|
source_meta.reflect(engine)
|
|
self.source_session = scoped_session(sessionmaker(bind=engine))
|
|
if 'media_files' in list(source_meta.tables.keys()):
|
|
has_media_files = True
|
|
else:
|
|
has_media_files = False
|
|
source_authors_table = source_meta.tables['authors']
|
|
source_song_books_table = source_meta.tables['song_books']
|
|
source_songs_table = source_meta.tables['songs']
|
|
source_topics_table = source_meta.tables['topics']
|
|
source_authors_songs_table = source_meta.tables['authors_songs']
|
|
source_songs_topics_table = source_meta.tables['songs_topics']
|
|
source_media_files_songs_table = None
|
|
if has_media_files:
|
|
source_media_files_table = source_meta.tables['media_files']
|
|
source_media_files_songs_table = source_meta.tables.get('media_files_songs')
|
|
try:
|
|
class_mapper(OldMediaFile)
|
|
except UnmappedClassError:
|
|
mapper(OldMediaFile, source_media_files_table)
|
|
song_props = {
|
|
'authors': relation(OldAuthor, backref='songs', secondary=source_authors_songs_table),
|
|
'book': relation(OldBook, backref='songs'),
|
|
'topics': relation(OldTopic, backref='songs', secondary=source_songs_topics_table)
|
|
}
|
|
if has_media_files:
|
|
if isinstance(source_media_files_songs_table, Table):
|
|
song_props['media_files'] = relation(OldMediaFile, backref='songs',
|
|
secondary=source_media_files_songs_table)
|
|
else:
|
|
song_props['media_files'] = \
|
|
relation(OldMediaFile, backref='songs',
|
|
foreign_keys=[source_media_files_table.c.song_id],
|
|
primaryjoin=source_songs_table.c.id == source_media_files_table.c.song_id)
|
|
try:
|
|
class_mapper(OldAuthor)
|
|
except UnmappedClassError:
|
|
mapper(OldAuthor, source_authors_table)
|
|
try:
|
|
class_mapper(OldBook)
|
|
except UnmappedClassError:
|
|
mapper(OldBook, source_song_books_table)
|
|
try:
|
|
class_mapper(OldSong)
|
|
except UnmappedClassError:
|
|
mapper(OldSong, source_songs_table, properties=song_props)
|
|
try:
|
|
class_mapper(OldTopic)
|
|
except UnmappedClassError:
|
|
mapper(OldTopic, source_topics_table)
|
|
|
|
source_songs = self.source_session.query(OldSong).all()
|
|
if self.import_wizard:
|
|
self.import_wizard.progress_bar.setMaximum(len(source_songs))
|
|
for song in source_songs:
|
|
new_song = Song()
|
|
new_song.title = song.title
|
|
if has_media_files and hasattr(song, 'alternate_title'):
|
|
new_song.alternate_title = song.alternate_title
|
|
else:
|
|
old_titles = song.search_title.split('@')
|
|
if len(old_titles) > 1:
|
|
new_song.alternate_title = old_titles[1]
|
|
# Values will be set when cleaning the song.
|
|
new_song.search_title = ''
|
|
new_song.search_lyrics = ''
|
|
new_song.song_number = song.song_number
|
|
new_song.lyrics = song.lyrics
|
|
new_song.verse_order = song.verse_order
|
|
new_song.copyright = song.copyright
|
|
new_song.comments = song.comments
|
|
new_song.theme_name = song.theme_name
|
|
new_song.ccli_number = song.ccli_number
|
|
for author in song.authors:
|
|
existing_author = self.manager.get_object_filtered(Author, Author.display_name == author.display_name)
|
|
if existing_author is None:
|
|
existing_author = Author.populate(
|
|
first_name=author.first_name,
|
|
last_name=author.last_name,
|
|
display_name=author.display_name)
|
|
new_song.authors.append(existing_author)
|
|
if song.book:
|
|
existing_song_book = self.manager.get_object_filtered(Book, Book.name == song.book.name)
|
|
if existing_song_book is None:
|
|
existing_song_book = Book.populate(name=song.book.name, publisher=song.book.publisher)
|
|
new_song.book = existing_song_book
|
|
if song.topics:
|
|
for topic in song.topics:
|
|
existing_topic = self.manager.get_object_filtered(Topic, Topic.name == topic.name)
|
|
if existing_topic is None:
|
|
existing_topic = Topic.populate(name=topic.name)
|
|
new_song.topics.append(existing_topic)
|
|
if has_media_files:
|
|
if song.media_files:
|
|
for media_file in song.media_files:
|
|
existing_media_file = self.manager.get_object_filtered(
|
|
MediaFile, MediaFile.file_name == media_file.file_name)
|
|
if existing_media_file:
|
|
new_song.media_files.append(existing_media_file)
|
|
else:
|
|
new_song.media_files.append(MediaFile.populate(file_name=media_file.file_name))
|
|
clean_song(self.manager, new_song)
|
|
self.manager.save_object(new_song)
|
|
if progress_dialog:
|
|
progress_dialog.setValue(progress_dialog.value() + 1)
|
|
progress_dialog.setLabelText(WizardStrings.ImportingType % new_song.title)
|
|
else:
|
|
self.import_wizard.increment_progress_bar(WizardStrings.ImportingType % new_song.title)
|
|
if self.stop_import_flag:
|
|
break
|
|
engine.dispose()
|