1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
# Copyright (C) 2006-2014 by the Free Software Foundation, Inc.
#
# This file is part of GNU Mailman.
#
# GNU Mailman 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.
#
# GNU Mailman 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
# GNU Mailman. If not, see <http://www.gnu.org/licenses/>.
from __future__ import absolute_import, print_function, unicode_literals
__metaclass__ = type
__all__ = [
'SABaseDatabase',
]
import logging
from alembic import command
from alembic.config import Config
from sqlalchemy import create_engine
from sqlalchemy.orm import sessionmaker
from zope.interface import implementer
from mailman.config import config
from mailman.interfaces.database import IDatabase
from mailman.utilities.string import expand
from mailman.utilities.modules import expand_path
log = logging.getLogger('mailman.config')
NL = '\n'
@implementer(IDatabase)
class SABaseDatabase:
"""The database base class for use with SQLAlchemy.
Use this as a base class for your DB-Specific derived classes.
"""
def __init__(self):
self.url = None
self.store = None
def begin(self):
"""See `IDatabase`."""
# SQLAlchemy does this for us.
pass
def commit(self):
"""See `IDatabase`."""
self.store.commit()
def abort(self):
"""See `IDatabase`."""
self.store.rollback()
def _pre_reset(self, store):
"""Clean up method for testing.
This method is called during the test suite just before all the model
tables are removed. Override this to perform any database-specific
pre-removal cleanup.
"""
pass
def _post_reset(self, store):
"""Clean up method for testing.
This method is called during the test suite just after all the model
tables have been removed. Override this to perform any
database-specific post-removal cleanup.
"""
pass
def _prepare(self, url):
"""Prepare the database for creation.
Some database backends need to do so me prep work before letting Storm
create the database. For example, we have to touch the SQLite .db
file first so that it has the proper file modes.
"""
pass
def stamp(self, debug=False):
"""Stamp the database with the latest Alembic version."""
# Newly created databases don't need migrations from Alembic, since
# create_all() ceates the latest schema. This patches the database
# with the latest Alembic version to add an entry in the
# alembic_version table.
alembic_cfg = Config()
alembic_cfg.set_main_option(
'script_location', expand_path(config.database['alembic_scripts']))
command.stamp(alembic_cfg, 'head')
def initialize(self, debug=None):
"""See `IDatabase`."""
# Calculate the engine url.
url = expand(config.database.url, config.paths)
self._prepare(url)
log.debug('Database url: %s', url)
# XXX By design of SQLite, database file creation does not honor
# umask. See their ticket #1193:
# http://www.sqlite.org/cvstrac/tktview?tn=1193,31
#
# This sucks for us because the mailman.db file /must/ be group
# writable, however even though we guarantee our umask is 002 here, it
# still gets created without the necessary g+w permission, due to
# SQLite's policy. This should only affect SQLite engines because its
# the only one that creates a little file on the local file system.
# This kludges around their bug by "touch"ing the database file before
# SQLite has any chance to create it, thus honoring the umask and
# ensuring the right permissions. We only try to do this for SQLite
# engines, and yes, we could have chmod'd the file after the fact, but
# half dozen and all...
self.url = url
self.engine = create_engine(url)
session = sessionmaker(bind=self.engine)
self.store = session()
self.store.commit()
|
