forked from openlp/openlp
70 lines
2.9 KiB
Python
70 lines
2.9 KiB
Python
# -*- 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 <https://www.gnu.org/licenses/>. #
|
|
##########################################################################
|
|
"""
|
|
The :mod:`db` module provides the database and schema that is the backend for
|
|
the Custom plugin
|
|
"""
|
|
from sqlalchemy import Column, Table, types
|
|
from sqlalchemy.orm import mapper
|
|
|
|
from openlp.core.common.i18n import get_natural_key
|
|
from openlp.core.lib.db import BaseModel, init_db
|
|
|
|
|
|
class CustomSlide(BaseModel):
|
|
"""
|
|
CustomSlide model
|
|
"""
|
|
# By default sort the customs by its title considering language specific characters.
|
|
def __lt__(self, other):
|
|
return get_natural_key(self.title) < get_natural_key(other.title)
|
|
|
|
def __eq__(self, other):
|
|
return get_natural_key(self.title) == get_natural_key(other.title)
|
|
|
|
def __hash__(self):
|
|
"""
|
|
Return the hash for a custom slide.
|
|
"""
|
|
return self.id
|
|
|
|
|
|
def init_schema(url):
|
|
"""
|
|
Setup the custom database connection and initialise the database schema
|
|
|
|
:param url: The database to setup
|
|
"""
|
|
session, metadata = init_db(url)
|
|
|
|
custom_slide_table = Table('custom_slide', metadata,
|
|
Column('id', types.Integer(), primary_key=True),
|
|
Column('title', types.Unicode(255), nullable=False),
|
|
Column('text', types.UnicodeText, nullable=False),
|
|
Column('credits', types.UnicodeText),
|
|
Column('theme_name', types.Unicode(128))
|
|
)
|
|
|
|
mapper(CustomSlide, custom_slide_table)
|
|
|
|
metadata.create_all(checkfirst=True)
|
|
return session
|