mirror of
https://mau.dev/maunium/synapse.git
synced 2024-12-15 10:03:54 +01:00
Merge branch 'erikj/store_engine' into erikj/search
This commit is contained in:
Erik Johnston
commit
f9340ea0d5
9 changed files with 464 additions and 409 deletions
|
|
@ -35,9 +35,8 @@ if __name__ == '__main__':
|
||||||
|
|
||||||
|
|
||||||
from synapse.storage.engines import create_engine, IncorrectDatabaseSetup
|
from synapse.storage.engines import create_engine, IncorrectDatabaseSetup
|
||||||
from synapse.storage import (
|
from synapse.storage import are_all_users_on_domain
|
||||||
are_all_users_on_domain, UpgradeDatabaseException,
|
from synapse.storage.schema_prepare import UpgradeDatabaseException
|
||||||
)
|
|
||||||
|
|
||||||
from synapse.server import HomeServer
|
from synapse.server import HomeServer
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -27,13 +27,17 @@ class CasConfig(Config):
|
||||||
if cas_config:
|
if cas_config:
|
||||||
self.cas_enabled = True
|
self.cas_enabled = True
|
||||||
self.cas_server_url = cas_config["server_url"]
|
self.cas_server_url = cas_config["server_url"]
|
||||||
|
self.cas_required_attributes = cas_config.get("required_attributes", {})
|
||||||
else:
|
else:
|
||||||
self.cas_enabled = False
|
self.cas_enabled = False
|
||||||
self.cas_server_url = None
|
self.cas_server_url = None
|
||||||
|
self.cas_required_attributes = {}
|
||||||
|
|
||||||
def default_config(self, config_dir_path, server_name, **kwargs):
|
def default_config(self, config_dir_path, server_name, **kwargs):
|
||||||
return """
|
return """
|
||||||
# Enable CAS for registration and login.
|
# Enable CAS for registration and login.
|
||||||
#cas_config:
|
#cas_config:
|
||||||
# server_url: "https://cas-server.com"
|
# server_url: "https://cas-server.com"
|
||||||
|
# #required_attributes:
|
||||||
|
# # name: value
|
||||||
"""
|
"""
|
||||||
|
|
|
||||||
|
|
@ -45,8 +45,8 @@ class LoginRestServlet(ClientV1RestServlet):
|
||||||
self.idp_redirect_url = hs.config.saml2_idp_redirect_url
|
self.idp_redirect_url = hs.config.saml2_idp_redirect_url
|
||||||
self.saml2_enabled = hs.config.saml2_enabled
|
self.saml2_enabled = hs.config.saml2_enabled
|
||||||
self.cas_enabled = hs.config.cas_enabled
|
self.cas_enabled = hs.config.cas_enabled
|
||||||
|
|
||||||
self.cas_server_url = hs.config.cas_server_url
|
self.cas_server_url = hs.config.cas_server_url
|
||||||
|
self.cas_required_attributes = hs.config.cas_required_attributes
|
||||||
self.servername = hs.config.server_name
|
self.servername = hs.config.server_name
|
||||||
|
|
||||||
def on_GET(self, request):
|
def on_GET(self, request):
|
||||||
|
|
@ -125,6 +125,47 @@ class LoginRestServlet(ClientV1RestServlet):
|
||||||
|
|
||||||
@defer.inlineCallbacks
|
@defer.inlineCallbacks
|
||||||
def do_cas_login(self, cas_response_body):
|
def do_cas_login(self, cas_response_body):
|
||||||
|
user, attributes = self.parse_cas_response(cas_response_body)
|
||||||
|
|
||||||
|
for required_attribute, required_value in self.cas_required_attributes.items():
|
||||||
|
# If required attribute was not in CAS Response - Forbidden
|
||||||
|
if required_attribute not in attributes:
|
||||||
|
raise LoginError(401, "Unauthorized", errcode=Codes.UNAUTHORIZED)
|
||||||
|
|
||||||
|
# Also need to check value
|
||||||
|
if required_value is not None:
|
||||||
|
actual_value = attributes[required_attribute]
|
||||||
|
# If required attribute value does not match expected - Forbidden
|
||||||
|
if required_value != actual_value:
|
||||||
|
raise LoginError(401, "Unauthorized", errcode=Codes.UNAUTHORIZED)
|
||||||
|
|
||||||
|
user_id = UserID.create(user, self.hs.hostname).to_string()
|
||||||
|
auth_handler = self.handlers.auth_handler
|
||||||
|
user_exists = yield auth_handler.does_user_exist(user_id)
|
||||||
|
if user_exists:
|
||||||
|
user_id, access_token, refresh_token = (
|
||||||
|
yield auth_handler.login_with_cas_user_id(user_id)
|
||||||
|
)
|
||||||
|
result = {
|
||||||
|
"user_id": user_id, # may have changed
|
||||||
|
"access_token": access_token,
|
||||||
|
"refresh_token": refresh_token,
|
||||||
|
"home_server": self.hs.hostname,
|
||||||
|
}
|
||||||
|
|
||||||
|
else:
|
||||||
|
user_id, access_token = (
|
||||||
|
yield self.handlers.registration_handler.register(localpart=user)
|
||||||
|
)
|
||||||
|
result = {
|
||||||
|
"user_id": user_id, # may have changed
|
||||||
|
"access_token": access_token,
|
||||||
|
"home_server": self.hs.hostname,
|
||||||
|
}
|
||||||
|
|
||||||
|
defer.returnValue((200, result))
|
||||||
|
|
||||||
|
def parse_cas_response(self, cas_response_body):
|
||||||
root = ET.fromstring(cas_response_body)
|
root = ET.fromstring(cas_response_body)
|
||||||
if not root.tag.endswith("serviceResponse"):
|
if not root.tag.endswith("serviceResponse"):
|
||||||
raise LoginError(401, "Invalid CAS response", errcode=Codes.UNAUTHORIZED)
|
raise LoginError(401, "Invalid CAS response", errcode=Codes.UNAUTHORIZED)
|
||||||
|
|
@ -133,33 +174,22 @@ class LoginRestServlet(ClientV1RestServlet):
|
||||||
for child in root[0]:
|
for child in root[0]:
|
||||||
if child.tag.endswith("user"):
|
if child.tag.endswith("user"):
|
||||||
user = child.text
|
user = child.text
|
||||||
user_id = UserID.create(user, self.hs.hostname).to_string()
|
if child.tag.endswith("attributes"):
|
||||||
auth_handler = self.handlers.auth_handler
|
attributes = {}
|
||||||
user_exists = yield auth_handler.does_user_exist(user_id)
|
for attribute in child:
|
||||||
if user_exists:
|
# ElementTree library expands the namespace in attribute tags
|
||||||
user_id, access_token, refresh_token = (
|
# to the full URL of the namespace.
|
||||||
yield auth_handler.login_with_cas_user_id(user_id)
|
# See (https://docs.python.org/2/library/xml.etree.elementtree.html)
|
||||||
)
|
# We don't care about namespace here and it will always be encased in
|
||||||
result = {
|
# curly braces, so we remove them.
|
||||||
"user_id": user_id, # may have changed
|
if "}" in attribute.tag:
|
||||||
"access_token": access_token,
|
attributes[attribute.tag.split("}")[1]] = attribute.text
|
||||||
"refresh_token": refresh_token,
|
else:
|
||||||
"home_server": self.hs.hostname,
|
attributes[attribute.tag] = attribute.text
|
||||||
}
|
if user is None or attributes is None:
|
||||||
|
raise LoginError(401, "Invalid CAS response", errcode=Codes.UNAUTHORIZED)
|
||||||
|
|
||||||
else:
|
return (user, attributes)
|
||||||
user_id, access_token = (
|
|
||||||
yield self.handlers.registration_handler.register(localpart=user)
|
|
||||||
)
|
|
||||||
result = {
|
|
||||||
"user_id": user_id, # may have changed
|
|
||||||
"access_token": access_token,
|
|
||||||
"home_server": self.hs.hostname,
|
|
||||||
}
|
|
||||||
|
|
||||||
defer.returnValue((200, result))
|
|
||||||
|
|
||||||
raise LoginError(401, "Invalid CAS response", errcode=Codes.UNAUTHORIZED)
|
|
||||||
|
|
||||||
|
|
||||||
class LoginFallbackRestServlet(ClientV1RestServlet):
|
class LoginFallbackRestServlet(ClientV1RestServlet):
|
||||||
|
|
|
||||||
|
|
@ -43,22 +43,12 @@ from .receipts import ReceiptsStore
|
||||||
from .search import SearchStore
|
from .search import SearchStore
|
||||||
|
|
||||||
|
|
||||||
import fnmatch
|
|
||||||
import imp
|
|
||||||
import logging
|
import logging
|
||||||
import os
|
|
||||||
import re
|
|
||||||
|
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
# Remember to update this number every time a change is made to database
|
|
||||||
# schema files, so the users will be informed on server restarts.
|
|
||||||
SCHEMA_VERSION = 24
|
|
||||||
|
|
||||||
dir_path = os.path.abspath(os.path.dirname(__file__))
|
|
||||||
|
|
||||||
# Number of msec of granularity to store the user IP 'last seen' time. Smaller
|
# Number of msec of granularity to store the user IP 'last seen' time. Smaller
|
||||||
# times give more inserts into the database even for readonly API hits
|
# times give more inserts into the database even for readonly API hits
|
||||||
# 120 seconds == 2 minutes
|
# 120 seconds == 2 minutes
|
||||||
|
|
@ -160,371 +150,6 @@ class DataStore(RoomMemberStore, RoomStore,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def read_schema(path):
|
|
||||||
""" Read the named database schema.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
path: Path of the database schema.
|
|
||||||
Returns:
|
|
||||||
A string containing the database schema.
|
|
||||||
"""
|
|
||||||
with open(path) as schema_file:
|
|
||||||
return schema_file.read()
|
|
||||||
|
|
||||||
|
|
||||||
class PrepareDatabaseException(Exception):
|
|
||||||
pass
|
|
||||||
|
|
||||||
|
|
||||||
class UpgradeDatabaseException(PrepareDatabaseException):
|
|
||||||
pass
|
|
||||||
|
|
||||||
|
|
||||||
def prepare_database(db_conn, database_engine):
|
|
||||||
"""Prepares a database for usage. Will either create all necessary tables
|
|
||||||
or upgrade from an older schema version.
|
|
||||||
"""
|
|
||||||
try:
|
|
||||||
cur = db_conn.cursor()
|
|
||||||
version_info = _get_or_create_schema_state(cur, database_engine)
|
|
||||||
|
|
||||||
if version_info:
|
|
||||||
user_version, delta_files, upgraded = version_info
|
|
||||||
_upgrade_existing_database(
|
|
||||||
cur, user_version, delta_files, upgraded, database_engine
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
_setup_new_database(cur, database_engine)
|
|
||||||
|
|
||||||
# cur.execute("PRAGMA user_version = %d" % (SCHEMA_VERSION,))
|
|
||||||
|
|
||||||
cur.close()
|
|
||||||
db_conn.commit()
|
|
||||||
except:
|
|
||||||
db_conn.rollback()
|
|
||||||
raise
|
|
||||||
|
|
||||||
|
|
||||||
def _setup_new_database(cur, database_engine):
|
|
||||||
"""Sets up the database by finding a base set of "full schemas" and then
|
|
||||||
applying any necessary deltas.
|
|
||||||
|
|
||||||
The "full_schemas" directory has subdirectories named after versions. This
|
|
||||||
function searches for the highest version less than or equal to
|
|
||||||
`SCHEMA_VERSION` and executes all .sql files in that directory.
|
|
||||||
|
|
||||||
The function will then apply all deltas for all versions after the base
|
|
||||||
version.
|
|
||||||
|
|
||||||
Example directory structure:
|
|
||||||
|
|
||||||
schema/
|
|
||||||
delta/
|
|
||||||
...
|
|
||||||
full_schemas/
|
|
||||||
3/
|
|
||||||
test.sql
|
|
||||||
...
|
|
||||||
11/
|
|
||||||
foo.sql
|
|
||||||
bar.sql
|
|
||||||
...
|
|
||||||
|
|
||||||
In the example foo.sql and bar.sql would be run, and then any delta files
|
|
||||||
for versions strictly greater than 11.
|
|
||||||
"""
|
|
||||||
current_dir = os.path.join(dir_path, "schema", "full_schemas")
|
|
||||||
directory_entries = os.listdir(current_dir)
|
|
||||||
|
|
||||||
valid_dirs = []
|
|
||||||
pattern = re.compile(r"^\d+(\.sql)?$")
|
|
||||||
for filename in directory_entries:
|
|
||||||
match = pattern.match(filename)
|
|
||||||
abs_path = os.path.join(current_dir, filename)
|
|
||||||
if match and os.path.isdir(abs_path):
|
|
||||||
ver = int(match.group(0))
|
|
||||||
if ver <= SCHEMA_VERSION:
|
|
||||||
valid_dirs.append((ver, abs_path))
|
|
||||||
else:
|
|
||||||
logger.warn("Unexpected entry in 'full_schemas': %s", filename)
|
|
||||||
|
|
||||||
if not valid_dirs:
|
|
||||||
raise PrepareDatabaseException(
|
|
||||||
"Could not find a suitable base set of full schemas"
|
|
||||||
)
|
|
||||||
|
|
||||||
max_current_ver, sql_dir = max(valid_dirs, key=lambda x: x[0])
|
|
||||||
|
|
||||||
logger.debug("Initialising schema v%d", max_current_ver)
|
|
||||||
|
|
||||||
directory_entries = os.listdir(sql_dir)
|
|
||||||
|
|
||||||
for filename in fnmatch.filter(directory_entries, "*.sql"):
|
|
||||||
sql_loc = os.path.join(sql_dir, filename)
|
|
||||||
logger.debug("Applying schema %s", sql_loc)
|
|
||||||
executescript(cur, sql_loc)
|
|
||||||
|
|
||||||
cur.execute(
|
|
||||||
database_engine.convert_param_style(
|
|
||||||
"INSERT INTO schema_version (version, upgraded)"
|
|
||||||
" VALUES (?,?)"
|
|
||||||
),
|
|
||||||
(max_current_ver, False,)
|
|
||||||
)
|
|
||||||
|
|
||||||
_upgrade_existing_database(
|
|
||||||
cur,
|
|
||||||
current_version=max_current_ver,
|
|
||||||
applied_delta_files=[],
|
|
||||||
upgraded=False,
|
|
||||||
database_engine=database_engine,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def _upgrade_existing_database(cur, current_version, applied_delta_files,
|
|
||||||
upgraded, database_engine):
|
|
||||||
"""Upgrades an existing database.
|
|
||||||
|
|
||||||
Delta files can either be SQL stored in *.sql files, or python modules
|
|
||||||
in *.py.
|
|
||||||
|
|
||||||
There can be multiple delta files per version. Synapse will keep track of
|
|
||||||
which delta files have been applied, and will apply any that haven't been
|
|
||||||
even if there has been no version bump. This is useful for development
|
|
||||||
where orthogonal schema changes may happen on separate branches.
|
|
||||||
|
|
||||||
Different delta files for the same version *must* be orthogonal and give
|
|
||||||
the same result when applied in any order. No guarantees are made on the
|
|
||||||
order of execution of these scripts.
|
|
||||||
|
|
||||||
This is a no-op of current_version == SCHEMA_VERSION.
|
|
||||||
|
|
||||||
Example directory structure:
|
|
||||||
|
|
||||||
schema/
|
|
||||||
delta/
|
|
||||||
11/
|
|
||||||
foo.sql
|
|
||||||
...
|
|
||||||
12/
|
|
||||||
foo.sql
|
|
||||||
bar.py
|
|
||||||
...
|
|
||||||
full_schemas/
|
|
||||||
...
|
|
||||||
|
|
||||||
In the example, if current_version is 11, then foo.sql will be run if and
|
|
||||||
only if `upgraded` is True. Then `foo.sql` and `bar.py` would be run in
|
|
||||||
some arbitrary order.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
cur (Cursor)
|
|
||||||
current_version (int): The current version of the schema.
|
|
||||||
applied_delta_files (list): A list of deltas that have already been
|
|
||||||
applied.
|
|
||||||
upgraded (bool): Whether the current version was generated by having
|
|
||||||
applied deltas or from full schema file. If `True` the function
|
|
||||||
will never apply delta files for the given `current_version`, since
|
|
||||||
the current_version wasn't generated by applying those delta files.
|
|
||||||
"""
|
|
||||||
|
|
||||||
if current_version > SCHEMA_VERSION:
|
|
||||||
raise ValueError(
|
|
||||||
"Cannot use this database as it is too " +
|
|
||||||
"new for the server to understand"
|
|
||||||
)
|
|
||||||
|
|
||||||
start_ver = current_version
|
|
||||||
if not upgraded:
|
|
||||||
start_ver += 1
|
|
||||||
|
|
||||||
logger.debug("applied_delta_files: %s", applied_delta_files)
|
|
||||||
|
|
||||||
for v in range(start_ver, SCHEMA_VERSION + 1):
|
|
||||||
logger.debug("Upgrading schema to v%d", v)
|
|
||||||
|
|
||||||
delta_dir = os.path.join(dir_path, "schema", "delta", str(v))
|
|
||||||
|
|
||||||
try:
|
|
||||||
directory_entries = os.listdir(delta_dir)
|
|
||||||
except OSError:
|
|
||||||
logger.exception("Could not open delta dir for version %d", v)
|
|
||||||
raise UpgradeDatabaseException(
|
|
||||||
"Could not open delta dir for version %d" % (v,)
|
|
||||||
)
|
|
||||||
|
|
||||||
directory_entries.sort()
|
|
||||||
for file_name in directory_entries:
|
|
||||||
relative_path = os.path.join(str(v), file_name)
|
|
||||||
logger.debug("Found file: %s", relative_path)
|
|
||||||
if relative_path in applied_delta_files:
|
|
||||||
continue
|
|
||||||
|
|
||||||
absolute_path = os.path.join(
|
|
||||||
dir_path, "schema", "delta", relative_path,
|
|
||||||
)
|
|
||||||
root_name, ext = os.path.splitext(file_name)
|
|
||||||
if ext == ".py":
|
|
||||||
# This is a python upgrade module. We need to import into some
|
|
||||||
# package and then execute its `run_upgrade` function.
|
|
||||||
module_name = "synapse.storage.v%d_%s" % (
|
|
||||||
v, root_name
|
|
||||||
)
|
|
||||||
with open(absolute_path) as python_file:
|
|
||||||
module = imp.load_source(
|
|
||||||
module_name, absolute_path, python_file
|
|
||||||
)
|
|
||||||
logger.debug("Running script %s", relative_path)
|
|
||||||
module.run_upgrade(cur, database_engine)
|
|
||||||
elif ext == ".pyc":
|
|
||||||
# Sometimes .pyc files turn up anyway even though we've
|
|
||||||
# disabled their generation; e.g. from distribution package
|
|
||||||
# installers. Silently skip it
|
|
||||||
pass
|
|
||||||
elif ext == ".sql":
|
|
||||||
# A plain old .sql file, just read and execute it
|
|
||||||
logger.debug("Applying schema %s", relative_path)
|
|
||||||
executescript(cur, absolute_path)
|
|
||||||
else:
|
|
||||||
# Not a valid delta file.
|
|
||||||
logger.warn(
|
|
||||||
"Found directory entry that did not end in .py or"
|
|
||||||
" .sql: %s",
|
|
||||||
relative_path,
|
|
||||||
)
|
|
||||||
continue
|
|
||||||
|
|
||||||
# Mark as done.
|
|
||||||
cur.execute(
|
|
||||||
database_engine.convert_param_style(
|
|
||||||
"INSERT INTO applied_schema_deltas (version, file)"
|
|
||||||
" VALUES (?,?)",
|
|
||||||
),
|
|
||||||
(v, relative_path)
|
|
||||||
)
|
|
||||||
|
|
||||||
cur.execute("DELETE FROM schema_version")
|
|
||||||
cur.execute(
|
|
||||||
database_engine.convert_param_style(
|
|
||||||
"INSERT INTO schema_version (version, upgraded)"
|
|
||||||
" VALUES (?,?)",
|
|
||||||
),
|
|
||||||
(v, True)
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def get_statements(f):
|
|
||||||
statement_buffer = ""
|
|
||||||
in_comment = False # If we're in a /* ... */ style comment
|
|
||||||
|
|
||||||
for line in f:
|
|
||||||
line = line.strip()
|
|
||||||
|
|
||||||
if in_comment:
|
|
||||||
# Check if this line contains an end to the comment
|
|
||||||
comments = line.split("*/", 1)
|
|
||||||
if len(comments) == 1:
|
|
||||||
continue
|
|
||||||
line = comments[1]
|
|
||||||
in_comment = False
|
|
||||||
|
|
||||||
# Remove inline block comments
|
|
||||||
line = re.sub(r"/\*.*\*/", " ", line)
|
|
||||||
|
|
||||||
# Does this line start a comment?
|
|
||||||
comments = line.split("/*", 1)
|
|
||||||
if len(comments) > 1:
|
|
||||||
line = comments[0]
|
|
||||||
in_comment = True
|
|
||||||
|
|
||||||
# Deal with line comments
|
|
||||||
line = line.split("--", 1)[0]
|
|
||||||
line = line.split("//", 1)[0]
|
|
||||||
|
|
||||||
# Find *all* semicolons. We need to treat first and last entry
|
|
||||||
# specially.
|
|
||||||
statements = line.split(";")
|
|
||||||
|
|
||||||
# We must prepend statement_buffer to the first statement
|
|
||||||
first_statement = "%s %s" % (
|
|
||||||
statement_buffer.strip(),
|
|
||||||
statements[0].strip()
|
|
||||||
)
|
|
||||||
statements[0] = first_statement
|
|
||||||
|
|
||||||
# Every entry, except the last, is a full statement
|
|
||||||
for statement in statements[:-1]:
|
|
||||||
yield statement.strip()
|
|
||||||
|
|
||||||
# The last entry did *not* end in a semicolon, so we store it for the
|
|
||||||
# next semicolon we find
|
|
||||||
statement_buffer = statements[-1].strip()
|
|
||||||
|
|
||||||
|
|
||||||
def executescript(txn, schema_path):
|
|
||||||
with open(schema_path, 'r') as f:
|
|
||||||
for statement in get_statements(f):
|
|
||||||
txn.execute(statement)
|
|
||||||
|
|
||||||
|
|
||||||
def _get_or_create_schema_state(txn, database_engine):
|
|
||||||
# Bluntly try creating the schema_version tables.
|
|
||||||
schema_path = os.path.join(
|
|
||||||
dir_path, "schema", "schema_version.sql",
|
|
||||||
)
|
|
||||||
executescript(txn, schema_path)
|
|
||||||
|
|
||||||
txn.execute("SELECT version, upgraded FROM schema_version")
|
|
||||||
row = txn.fetchone()
|
|
||||||
current_version = int(row[0]) if row else None
|
|
||||||
upgraded = bool(row[1]) if row else None
|
|
||||||
|
|
||||||
if current_version:
|
|
||||||
txn.execute(
|
|
||||||
database_engine.convert_param_style(
|
|
||||||
"SELECT file FROM applied_schema_deltas WHERE version >= ?"
|
|
||||||
),
|
|
||||||
(current_version,)
|
|
||||||
)
|
|
||||||
applied_deltas = [d for d, in txn.fetchall()]
|
|
||||||
return current_version, applied_deltas, upgraded
|
|
||||||
|
|
||||||
return None
|
|
||||||
|
|
||||||
|
|
||||||
def prepare_sqlite3_database(db_conn):
|
|
||||||
"""This function should be called before `prepare_database` on sqlite3
|
|
||||||
databases.
|
|
||||||
|
|
||||||
Since we changed the way we store the current schema version and handle
|
|
||||||
updates to schemas, we need a way to upgrade from the old method to the
|
|
||||||
new. This only affects sqlite databases since they were the only ones
|
|
||||||
supported at the time.
|
|
||||||
"""
|
|
||||||
with db_conn:
|
|
||||||
schema_path = os.path.join(
|
|
||||||
dir_path, "schema", "schema_version.sql",
|
|
||||||
)
|
|
||||||
create_schema = read_schema(schema_path)
|
|
||||||
db_conn.executescript(create_schema)
|
|
||||||
|
|
||||||
c = db_conn.execute("SELECT * FROM schema_version")
|
|
||||||
rows = c.fetchall()
|
|
||||||
c.close()
|
|
||||||
|
|
||||||
if not rows:
|
|
||||||
c = db_conn.execute("PRAGMA user_version")
|
|
||||||
row = c.fetchone()
|
|
||||||
c.close()
|
|
||||||
|
|
||||||
if row and row[0]:
|
|
||||||
db_conn.execute(
|
|
||||||
"REPLACE INTO schema_version (version, upgraded)"
|
|
||||||
" VALUES (?,?)",
|
|
||||||
(row[0], False)
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def are_all_users_on_domain(txn, database_engine, domain):
|
def are_all_users_on_domain(txn, database_engine, domain):
|
||||||
sql = database_engine.convert_param_style(
|
sql = database_engine.convert_param_style(
|
||||||
"SELECT COUNT(*) FROM users WHERE name NOT LIKE ?"
|
"SELECT COUNT(*) FROM users WHERE name NOT LIKE ?"
|
||||||
|
|
|
||||||
|
|
@ -13,7 +13,7 @@
|
||||||
# See the License for the specific language governing permissions and
|
# See the License for the specific language governing permissions and
|
||||||
# limitations under the License.
|
# limitations under the License.
|
||||||
|
|
||||||
from synapse.storage import prepare_database
|
from synapse.storage.schema_prepare import prepare_database
|
||||||
|
|
||||||
from ._base import IncorrectDatabaseSetup
|
from ._base import IncorrectDatabaseSetup
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -13,7 +13,9 @@
|
||||||
# See the License for the specific language governing permissions and
|
# See the License for the specific language governing permissions and
|
||||||
# limitations under the License.
|
# limitations under the License.
|
||||||
|
|
||||||
from synapse.storage import prepare_database, prepare_sqlite3_database
|
from synapse.storage.schema_prepare import (
|
||||||
|
prepare_database, prepare_sqlite3_database
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
class Sqlite3Engine(object):
|
class Sqlite3Engine(object):
|
||||||
|
|
|
||||||
|
|
@ -14,7 +14,7 @@
|
||||||
|
|
||||||
import logging
|
import logging
|
||||||
|
|
||||||
from synapse.storage import get_statements
|
from synapse.storage.schema_prepare import get_statements
|
||||||
from synapse.storage.engines import PostgresEngine, Sqlite3Engine
|
from synapse.storage.engines import PostgresEngine, Sqlite3Engine
|
||||||
|
|
||||||
import ujson
|
import ujson
|
||||||
|
|
|
||||||
395
synapse/storage/schema_prepare.py
Normal file
395
synapse/storage/schema_prepare.py
Normal file
|
|
@ -0,0 +1,395 @@
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
# Copyright 2014, 2015 OpenMarket Ltd
|
||||||
|
#
|
||||||
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
# you may not use this file except in compliance with the License.
|
||||||
|
# You may obtain a copy of the License at
|
||||||
|
#
|
||||||
|
# http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
#
|
||||||
|
# Unless required by applicable law or agreed to in writing, software
|
||||||
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
# See the License for the specific language governing permissions and
|
||||||
|
# limitations under the License.
|
||||||
|
|
||||||
|
import fnmatch
|
||||||
|
import imp
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
import re
|
||||||
|
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
# Remember to update this number every time a change is made to database
|
||||||
|
# schema files, so the users will be informed on server restarts.
|
||||||
|
SCHEMA_VERSION = 24
|
||||||
|
|
||||||
|
dir_path = os.path.abspath(os.path.dirname(__file__))
|
||||||
|
|
||||||
|
|
||||||
|
def read_schema(path):
|
||||||
|
""" Read the named database schema.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
path: Path of the database schema.
|
||||||
|
Returns:
|
||||||
|
A string containing the database schema.
|
||||||
|
"""
|
||||||
|
with open(path) as schema_file:
|
||||||
|
return schema_file.read()
|
||||||
|
|
||||||
|
|
||||||
|
class PrepareDatabaseException(Exception):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
class UpgradeDatabaseException(PrepareDatabaseException):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
def prepare_database(db_conn, database_engine):
|
||||||
|
"""Prepares a database for usage. Will either create all necessary tables
|
||||||
|
or upgrade from an older schema version.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
cur = db_conn.cursor()
|
||||||
|
version_info = _get_or_create_schema_state(cur, database_engine)
|
||||||
|
|
||||||
|
if version_info:
|
||||||
|
user_version, delta_files, upgraded = version_info
|
||||||
|
_upgrade_existing_database(
|
||||||
|
cur, user_version, delta_files, upgraded, database_engine
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
_setup_new_database(cur, database_engine)
|
||||||
|
|
||||||
|
# cur.execute("PRAGMA user_version = %d" % (SCHEMA_VERSION,))
|
||||||
|
|
||||||
|
cur.close()
|
||||||
|
db_conn.commit()
|
||||||
|
except:
|
||||||
|
db_conn.rollback()
|
||||||
|
raise
|
||||||
|
|
||||||
|
|
||||||
|
def _setup_new_database(cur, database_engine):
|
||||||
|
"""Sets up the database by finding a base set of "full schemas" and then
|
||||||
|
applying any necessary deltas.
|
||||||
|
|
||||||
|
The "full_schemas" directory has subdirectories named after versions. This
|
||||||
|
function searches for the highest version less than or equal to
|
||||||
|
`SCHEMA_VERSION` and executes all .sql files in that directory.
|
||||||
|
|
||||||
|
The function will then apply all deltas for all versions after the base
|
||||||
|
version.
|
||||||
|
|
||||||
|
Example directory structure:
|
||||||
|
|
||||||
|
schema/
|
||||||
|
delta/
|
||||||
|
...
|
||||||
|
full_schemas/
|
||||||
|
3/
|
||||||
|
test.sql
|
||||||
|
...
|
||||||
|
11/
|
||||||
|
foo.sql
|
||||||
|
bar.sql
|
||||||
|
...
|
||||||
|
|
||||||
|
In the example foo.sql and bar.sql would be run, and then any delta files
|
||||||
|
for versions strictly greater than 11.
|
||||||
|
"""
|
||||||
|
current_dir = os.path.join(dir_path, "schema", "full_schemas")
|
||||||
|
directory_entries = os.listdir(current_dir)
|
||||||
|
|
||||||
|
valid_dirs = []
|
||||||
|
pattern = re.compile(r"^\d+(\.sql)?$")
|
||||||
|
for filename in directory_entries:
|
||||||
|
match = pattern.match(filename)
|
||||||
|
abs_path = os.path.join(current_dir, filename)
|
||||||
|
if match and os.path.isdir(abs_path):
|
||||||
|
ver = int(match.group(0))
|
||||||
|
if ver <= SCHEMA_VERSION:
|
||||||
|
valid_dirs.append((ver, abs_path))
|
||||||
|
else:
|
||||||
|
logger.warn("Unexpected entry in 'full_schemas': %s", filename)
|
||||||
|
|
||||||
|
if not valid_dirs:
|
||||||
|
raise PrepareDatabaseException(
|
||||||
|
"Could not find a suitable base set of full schemas"
|
||||||
|
)
|
||||||
|
|
||||||
|
max_current_ver, sql_dir = max(valid_dirs, key=lambda x: x[0])
|
||||||
|
|
||||||
|
logger.debug("Initialising schema v%d", max_current_ver)
|
||||||
|
|
||||||
|
directory_entries = os.listdir(sql_dir)
|
||||||
|
|
||||||
|
for filename in fnmatch.filter(directory_entries, "*.sql"):
|
||||||
|
sql_loc = os.path.join(sql_dir, filename)
|
||||||
|
logger.debug("Applying schema %s", sql_loc)
|
||||||
|
executescript(cur, sql_loc)
|
||||||
|
|
||||||
|
cur.execute(
|
||||||
|
database_engine.convert_param_style(
|
||||||
|
"INSERT INTO schema_version (version, upgraded)"
|
||||||
|
" VALUES (?,?)"
|
||||||
|
),
|
||||||
|
(max_current_ver, False,)
|
||||||
|
)
|
||||||
|
|
||||||
|
_upgrade_existing_database(
|
||||||
|
cur,
|
||||||
|
current_version=max_current_ver,
|
||||||
|
applied_delta_files=[],
|
||||||
|
upgraded=False,
|
||||||
|
database_engine=database_engine,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _upgrade_existing_database(cur, current_version, applied_delta_files,
|
||||||
|
upgraded, database_engine):
|
||||||
|
"""Upgrades an existing database.
|
||||||
|
|
||||||
|
Delta files can either be SQL stored in *.sql files, or python modules
|
||||||
|
in *.py.
|
||||||
|
|
||||||
|
There can be multiple delta files per version. Synapse will keep track of
|
||||||
|
which delta files have been applied, and will apply any that haven't been
|
||||||
|
even if there has been no version bump. This is useful for development
|
||||||
|
where orthogonal schema changes may happen on separate branches.
|
||||||
|
|
||||||
|
Different delta files for the same version *must* be orthogonal and give
|
||||||
|
the same result when applied in any order. No guarantees are made on the
|
||||||
|
order of execution of these scripts.
|
||||||
|
|
||||||
|
This is a no-op of current_version == SCHEMA_VERSION.
|
||||||
|
|
||||||
|
Example directory structure:
|
||||||
|
|
||||||
|
schema/
|
||||||
|
delta/
|
||||||
|
11/
|
||||||
|
foo.sql
|
||||||
|
...
|
||||||
|
12/
|
||||||
|
foo.sql
|
||||||
|
bar.py
|
||||||
|
...
|
||||||
|
full_schemas/
|
||||||
|
...
|
||||||
|
|
||||||
|
In the example, if current_version is 11, then foo.sql will be run if and
|
||||||
|
only if `upgraded` is True. Then `foo.sql` and `bar.py` would be run in
|
||||||
|
some arbitrary order.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
cur (Cursor)
|
||||||
|
current_version (int): The current version of the schema.
|
||||||
|
applied_delta_files (list): A list of deltas that have already been
|
||||||
|
applied.
|
||||||
|
upgraded (bool): Whether the current version was generated by having
|
||||||
|
applied deltas or from full schema file. If `True` the function
|
||||||
|
will never apply delta files for the given `current_version`, since
|
||||||
|
the current_version wasn't generated by applying those delta files.
|
||||||
|
"""
|
||||||
|
|
||||||
|
if current_version > SCHEMA_VERSION:
|
||||||
|
raise ValueError(
|
||||||
|
"Cannot use this database as it is too " +
|
||||||
|
"new for the server to understand"
|
||||||
|
)
|
||||||
|
|
||||||
|
start_ver = current_version
|
||||||
|
if not upgraded:
|
||||||
|
start_ver += 1
|
||||||
|
|
||||||
|
logger.debug("applied_delta_files: %s", applied_delta_files)
|
||||||
|
|
||||||
|
for v in range(start_ver, SCHEMA_VERSION + 1):
|
||||||
|
logger.debug("Upgrading schema to v%d", v)
|
||||||
|
|
||||||
|
delta_dir = os.path.join(dir_path, "schema", "delta", str(v))
|
||||||
|
|
||||||
|
try:
|
||||||
|
directory_entries = os.listdir(delta_dir)
|
||||||
|
except OSError:
|
||||||
|
logger.exception("Could not open delta dir for version %d", v)
|
||||||
|
raise UpgradeDatabaseException(
|
||||||
|
"Could not open delta dir for version %d" % (v,)
|
||||||
|
)
|
||||||
|
|
||||||
|
directory_entries.sort()
|
||||||
|
for file_name in directory_entries:
|
||||||
|
relative_path = os.path.join(str(v), file_name)
|
||||||
|
logger.debug("Found file: %s", relative_path)
|
||||||
|
if relative_path in applied_delta_files:
|
||||||
|
continue
|
||||||
|
|
||||||
|
absolute_path = os.path.join(
|
||||||
|
dir_path, "schema", "delta", relative_path,
|
||||||
|
)
|
||||||
|
root_name, ext = os.path.splitext(file_name)
|
||||||
|
if ext == ".py":
|
||||||
|
# This is a python upgrade module. We need to import into some
|
||||||
|
# package and then execute its `run_upgrade` function.
|
||||||
|
module_name = "synapse.storage.v%d_%s" % (
|
||||||
|
v, root_name
|
||||||
|
)
|
||||||
|
with open(absolute_path) as python_file:
|
||||||
|
module = imp.load_source(
|
||||||
|
module_name, absolute_path, python_file
|
||||||
|
)
|
||||||
|
logger.debug("Running script %s", relative_path)
|
||||||
|
module.run_upgrade(cur, database_engine)
|
||||||
|
elif ext == ".pyc":
|
||||||
|
# Sometimes .pyc files turn up anyway even though we've
|
||||||
|
# disabled their generation; e.g. from distribution package
|
||||||
|
# installers. Silently skip it
|
||||||
|
pass
|
||||||
|
elif ext == ".sql":
|
||||||
|
# A plain old .sql file, just read and execute it
|
||||||
|
logger.debug("Applying schema %s", relative_path)
|
||||||
|
executescript(cur, absolute_path)
|
||||||
|
else:
|
||||||
|
# Not a valid delta file.
|
||||||
|
logger.warn(
|
||||||
|
"Found directory entry that did not end in .py or"
|
||||||
|
" .sql: %s",
|
||||||
|
relative_path,
|
||||||
|
)
|
||||||
|
continue
|
||||||
|
|
||||||
|
# Mark as done.
|
||||||
|
cur.execute(
|
||||||
|
database_engine.convert_param_style(
|
||||||
|
"INSERT INTO applied_schema_deltas (version, file)"
|
||||||
|
" VALUES (?,?)",
|
||||||
|
),
|
||||||
|
(v, relative_path)
|
||||||
|
)
|
||||||
|
|
||||||
|
cur.execute("DELETE FROM schema_version")
|
||||||
|
cur.execute(
|
||||||
|
database_engine.convert_param_style(
|
||||||
|
"INSERT INTO schema_version (version, upgraded)"
|
||||||
|
" VALUES (?,?)",
|
||||||
|
),
|
||||||
|
(v, True)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def get_statements(f):
|
||||||
|
statement_buffer = ""
|
||||||
|
in_comment = False # If we're in a /* ... */ style comment
|
||||||
|
|
||||||
|
for line in f:
|
||||||
|
line = line.strip()
|
||||||
|
|
||||||
|
if in_comment:
|
||||||
|
# Check if this line contains an end to the comment
|
||||||
|
comments = line.split("*/", 1)
|
||||||
|
if len(comments) == 1:
|
||||||
|
continue
|
||||||
|
line = comments[1]
|
||||||
|
in_comment = False
|
||||||
|
|
||||||
|
# Remove inline block comments
|
||||||
|
line = re.sub(r"/\*.*\*/", " ", line)
|
||||||
|
|
||||||
|
# Does this line start a comment?
|
||||||
|
comments = line.split("/*", 1)
|
||||||
|
if len(comments) > 1:
|
||||||
|
line = comments[0]
|
||||||
|
in_comment = True
|
||||||
|
|
||||||
|
# Deal with line comments
|
||||||
|
line = line.split("--", 1)[0]
|
||||||
|
line = line.split("//", 1)[0]
|
||||||
|
|
||||||
|
# Find *all* semicolons. We need to treat first and last entry
|
||||||
|
# specially.
|
||||||
|
statements = line.split(";")
|
||||||
|
|
||||||
|
# We must prepend statement_buffer to the first statement
|
||||||
|
first_statement = "%s %s" % (
|
||||||
|
statement_buffer.strip(),
|
||||||
|
statements[0].strip()
|
||||||
|
)
|
||||||
|
statements[0] = first_statement
|
||||||
|
|
||||||
|
# Every entry, except the last, is a full statement
|
||||||
|
for statement in statements[:-1]:
|
||||||
|
yield statement.strip()
|
||||||
|
|
||||||
|
# The last entry did *not* end in a semicolon, so we store it for the
|
||||||
|
# next semicolon we find
|
||||||
|
statement_buffer = statements[-1].strip()
|
||||||
|
|
||||||
|
|
||||||
|
def executescript(txn, schema_path):
|
||||||
|
with open(schema_path, 'r') as f:
|
||||||
|
for statement in get_statements(f):
|
||||||
|
txn.execute(statement)
|
||||||
|
|
||||||
|
|
||||||
|
def _get_or_create_schema_state(txn, database_engine):
|
||||||
|
# Bluntly try creating the schema_version tables.
|
||||||
|
schema_path = os.path.join(
|
||||||
|
dir_path, "schema", "schema_version.sql",
|
||||||
|
)
|
||||||
|
executescript(txn, schema_path)
|
||||||
|
|
||||||
|
txn.execute("SELECT version, upgraded FROM schema_version")
|
||||||
|
row = txn.fetchone()
|
||||||
|
current_version = int(row[0]) if row else None
|
||||||
|
upgraded = bool(row[1]) if row else None
|
||||||
|
|
||||||
|
if current_version:
|
||||||
|
txn.execute(
|
||||||
|
database_engine.convert_param_style(
|
||||||
|
"SELECT file FROM applied_schema_deltas WHERE version >= ?"
|
||||||
|
),
|
||||||
|
(current_version,)
|
||||||
|
)
|
||||||
|
applied_deltas = [d for d, in txn.fetchall()]
|
||||||
|
return current_version, applied_deltas, upgraded
|
||||||
|
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def prepare_sqlite3_database(db_conn):
|
||||||
|
"""This function should be called before `prepare_database` on sqlite3
|
||||||
|
databases.
|
||||||
|
|
||||||
|
Since we changed the way we store the current schema version and handle
|
||||||
|
updates to schemas, we need a way to upgrade from the old method to the
|
||||||
|
new. This only affects sqlite databases since they were the only ones
|
||||||
|
supported at the time.
|
||||||
|
"""
|
||||||
|
with db_conn:
|
||||||
|
schema_path = os.path.join(
|
||||||
|
dir_path, "schema", "schema_version.sql",
|
||||||
|
)
|
||||||
|
create_schema = read_schema(schema_path)
|
||||||
|
db_conn.executescript(create_schema)
|
||||||
|
|
||||||
|
c = db_conn.execute("SELECT * FROM schema_version")
|
||||||
|
rows = c.fetchall()
|
||||||
|
c.close()
|
||||||
|
|
||||||
|
if not rows:
|
||||||
|
c = db_conn.execute("PRAGMA user_version")
|
||||||
|
row = c.fetchone()
|
||||||
|
c.close()
|
||||||
|
|
||||||
|
if row and row[0]:
|
||||||
|
db_conn.execute(
|
||||||
|
"REPLACE INTO schema_version (version, upgraded)"
|
||||||
|
" VALUES (?,?)",
|
||||||
|
(row[0], False)
|
||||||
|
)
|
||||||
|
|
@ -16,7 +16,7 @@
|
||||||
from synapse.http.server import HttpServer
|
from synapse.http.server import HttpServer
|
||||||
from synapse.api.errors import cs_error, CodeMessageException, StoreError
|
from synapse.api.errors import cs_error, CodeMessageException, StoreError
|
||||||
from synapse.api.constants import EventTypes
|
from synapse.api.constants import EventTypes
|
||||||
from synapse.storage import prepare_database
|
from synapse.storage.schema_prepare import prepare_database
|
||||||
from synapse.storage.engines import create_engine
|
from synapse.storage.engines import create_engine
|
||||||
from synapse.server import HomeServer
|
from synapse.server import HomeServer
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue