mirror of
https://mau.dev/maunium/synapse.git
synced 2024-09-06 01:22:16 +00:00
23740eaa3d
During the migration the automated script to update the copyright headers accidentally got rid of some of the existing copyright lines. Reinstate them.
86 lines
3.3 KiB
Python
86 lines
3.3 KiB
Python
#
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
#
|
|
# Copyright 2021 The Matrix.org Foundation C.I.C.
|
|
# Copyright (C) 2023 New Vector, Ltd
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Affero General Public License as
|
|
# published by the Free Software Foundation, either version 3 of the
|
|
# License, or (at your option) any later version.
|
|
#
|
|
# See the GNU Affero General Public License for more details:
|
|
# <https://www.gnu.org/licenses/agpl-3.0.html>.
|
|
#
|
|
# Originally licensed under the Apache License, Version 2.0:
|
|
# <http://www.apache.org/licenses/LICENSE-2.0>.
|
|
#
|
|
# [This file includes modifications made by New Vector Limited]
|
|
#
|
|
#
|
|
|
|
"""
|
|
This migration denormalises the account_data table into an ignored users table.
|
|
"""
|
|
|
|
import logging
|
|
from io import StringIO
|
|
|
|
from synapse.storage._base import db_to_json
|
|
from synapse.storage.database import LoggingTransaction
|
|
from synapse.storage.engines import BaseDatabaseEngine
|
|
from synapse.storage.prepare_database import execute_statements_from_stream
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
def run_create(cur: LoggingTransaction, database_engine: BaseDatabaseEngine) -> None:
|
|
logger.info("Creating ignored_users table")
|
|
execute_statements_from_stream(cur, StringIO(_create_commands))
|
|
|
|
# We now upgrade existing data, if any. We don't do this in `run_upgrade` as
|
|
# we a) want to run these before adding constraints and b) `run_upgrade` is
|
|
# not run on empty databases.
|
|
insert_sql = """
|
|
INSERT INTO ignored_users (ignorer_user_id, ignored_user_id) VALUES (?, ?)
|
|
"""
|
|
|
|
logger.info("Converting existing ignore lists")
|
|
cur.execute(
|
|
"SELECT user_id, content FROM account_data WHERE account_data_type = 'm.ignored_user_list'"
|
|
)
|
|
for user_id, content_json in cur.fetchall():
|
|
content = db_to_json(content_json)
|
|
|
|
# The content should be the form of a dictionary with a key
|
|
# "ignored_users" pointing to a dictionary with keys of ignored users.
|
|
#
|
|
# { "ignored_users": "@someone:example.org": {} }
|
|
ignored_users = content.get("ignored_users", {})
|
|
if isinstance(ignored_users, dict) and ignored_users:
|
|
cur.execute_batch(insert_sql, [(user_id, u) for u in ignored_users])
|
|
|
|
# Add indexes after inserting data for efficiency.
|
|
logger.info("Adding constraints to ignored_users table")
|
|
execute_statements_from_stream(cur, StringIO(_constraints_commands))
|
|
|
|
|
|
# there might be duplicates, so the easiest way to achieve this is to create a new
|
|
# table with the right data, and renaming it into place
|
|
|
|
_create_commands = """
|
|
-- Users which are ignored when calculating push notifications. This data is
|
|
-- denormalized from account data.
|
|
CREATE TABLE IF NOT EXISTS ignored_users(
|
|
ignorer_user_id TEXT NOT NULL, -- The user ID of the user who is ignoring another user. (This is a local user.)
|
|
ignored_user_id TEXT NOT NULL -- The user ID of the user who is being ignored. (This is a local or remote user.)
|
|
);
|
|
"""
|
|
|
|
_constraints_commands = """
|
|
CREATE UNIQUE INDEX ignored_users_uniqueness ON ignored_users (ignorer_user_id, ignored_user_id);
|
|
|
|
-- Add an index on ignored_users since look-ups are done to get all ignorers of an ignored user.
|
|
CREATE INDEX ignored_users_ignored_user_id ON ignored_users (ignored_user_id);
|
|
"""
|