mirror of
https://mau.dev/maunium/synapse.git
synced 2024-09-06 01:22:16 +00:00
![Erik Johnston](/assets/img/avatar_default.png)
During the migration the automated script to update the copyright headers accidentally got rid of some of the existing copyright lines. Reinstate them.
410 lines
14 KiB
Python
410 lines
14 KiB
Python
#
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
#
|
|
# Copyright 2019-2021 The Matrix.org Foundation C.I.C.
|
|
# Copyright 2014-2016 OpenMarket Ltd
|
|
# 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]
|
|
#
|
|
#
|
|
|
|
import logging
|
|
from typing import TYPE_CHECKING, List, Optional, Tuple, Union, cast
|
|
|
|
import attr
|
|
|
|
from synapse.api.constants import Direction
|
|
from synapse.config.homeserver import HomeServerConfig
|
|
from synapse.storage._base import make_in_list_sql_clause
|
|
from synapse.storage.database import (
|
|
DatabasePool,
|
|
LoggingDatabaseConnection,
|
|
LoggingTransaction,
|
|
)
|
|
from synapse.storage.databases.main.stats import UserSortOrder
|
|
from synapse.storage.engines import BaseDatabaseEngine
|
|
from synapse.storage.types import Cursor
|
|
from synapse.types import get_domain_from_id
|
|
|
|
from .account_data import AccountDataStore
|
|
from .appservice import ApplicationServiceStore, ApplicationServiceTransactionStore
|
|
from .cache import CacheInvalidationWorkerStore
|
|
from .censor_events import CensorEventsStore
|
|
from .client_ips import ClientIpWorkerStore
|
|
from .deviceinbox import DeviceInboxStore
|
|
from .devices import DeviceStore
|
|
from .directory import DirectoryStore
|
|
from .e2e_room_keys import EndToEndRoomKeyStore
|
|
from .end_to_end_keys import EndToEndKeyStore
|
|
from .event_federation import EventFederationStore
|
|
from .event_push_actions import EventPushActionsStore
|
|
from .events_bg_updates import EventsBackgroundUpdatesStore
|
|
from .events_forward_extremities import EventForwardExtremitiesStore
|
|
from .experimental_features import ExperimentalFeaturesStore
|
|
from .filtering import FilteringWorkerStore
|
|
from .keys import KeyStore
|
|
from .lock import LockStore
|
|
from .media_repository import MediaRepositoryStore
|
|
from .metrics import ServerMetricsStore
|
|
from .monthly_active_users import MonthlyActiveUsersWorkerStore
|
|
from .openid import OpenIdStore
|
|
from .presence import PresenceStore
|
|
from .profile import ProfileStore
|
|
from .purge_events import PurgeEventsStore
|
|
from .push_rule import PushRuleStore
|
|
from .pusher import PusherStore
|
|
from .receipts import ReceiptsStore
|
|
from .registration import RegistrationStore
|
|
from .rejections import RejectionsStore
|
|
from .relations import RelationsStore
|
|
from .room import RoomStore
|
|
from .roommember import RoomMemberStore
|
|
from .search import SearchStore
|
|
from .session import SessionStore
|
|
from .signatures import SignatureStore
|
|
from .state import StateStore
|
|
from .stats import StatsStore
|
|
from .stream import StreamWorkerStore
|
|
from .tags import TagsStore
|
|
from .task_scheduler import TaskSchedulerWorkerStore
|
|
from .transactions import TransactionWorkerStore
|
|
from .ui_auth import UIAuthStore
|
|
from .user_directory import UserDirectoryStore
|
|
from .user_erasure_store import UserErasureStore
|
|
|
|
if TYPE_CHECKING:
|
|
from synapse.server import HomeServer
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
@attr.s(slots=True, frozen=True, auto_attribs=True)
|
|
class UserPaginateResponse:
|
|
"""This is very similar to UserInfo, but not quite the same."""
|
|
|
|
name: str
|
|
user_type: Optional[str]
|
|
is_guest: bool
|
|
admin: bool
|
|
deactivated: bool
|
|
shadow_banned: bool
|
|
displayname: Optional[str]
|
|
avatar_url: Optional[str]
|
|
creation_ts: Optional[int]
|
|
approved: bool
|
|
erased: bool
|
|
last_seen_ts: int
|
|
locked: bool
|
|
|
|
|
|
class DataStore(
|
|
EventsBackgroundUpdatesStore,
|
|
ExperimentalFeaturesStore,
|
|
DeviceStore,
|
|
RoomMemberStore,
|
|
RoomStore,
|
|
RegistrationStore,
|
|
ProfileStore,
|
|
PresenceStore,
|
|
TransactionWorkerStore,
|
|
DirectoryStore,
|
|
KeyStore,
|
|
StateStore,
|
|
SignatureStore,
|
|
ApplicationServiceStore,
|
|
PurgeEventsStore,
|
|
EventFederationStore,
|
|
MediaRepositoryStore,
|
|
RejectionsStore,
|
|
FilteringWorkerStore,
|
|
PusherStore,
|
|
PushRuleStore,
|
|
ApplicationServiceTransactionStore,
|
|
EventPushActionsStore,
|
|
ServerMetricsStore,
|
|
ReceiptsStore,
|
|
EndToEndKeyStore,
|
|
EndToEndRoomKeyStore,
|
|
SearchStore,
|
|
TagsStore,
|
|
AccountDataStore,
|
|
StreamWorkerStore,
|
|
OpenIdStore,
|
|
ClientIpWorkerStore,
|
|
DeviceInboxStore,
|
|
UserDirectoryStore,
|
|
UserErasureStore,
|
|
MonthlyActiveUsersWorkerStore,
|
|
StatsStore,
|
|
RelationsStore,
|
|
CensorEventsStore,
|
|
UIAuthStore,
|
|
EventForwardExtremitiesStore,
|
|
CacheInvalidationWorkerStore,
|
|
LockStore,
|
|
SessionStore,
|
|
TaskSchedulerWorkerStore,
|
|
):
|
|
def __init__(
|
|
self,
|
|
database: DatabasePool,
|
|
db_conn: LoggingDatabaseConnection,
|
|
hs: "HomeServer",
|
|
):
|
|
self.hs = hs
|
|
self._clock = hs.get_clock()
|
|
self.database_engine = database.engine
|
|
|
|
super().__init__(database, db_conn, hs)
|
|
|
|
async def get_users_paginate(
|
|
self,
|
|
start: int,
|
|
limit: int,
|
|
user_id: Optional[str] = None,
|
|
name: Optional[str] = None,
|
|
guests: bool = True,
|
|
deactivated: bool = False,
|
|
admins: Optional[bool] = None,
|
|
order_by: str = UserSortOrder.NAME.value,
|
|
direction: Direction = Direction.FORWARDS,
|
|
approved: bool = True,
|
|
not_user_types: Optional[List[str]] = None,
|
|
locked: bool = False,
|
|
) -> Tuple[List[UserPaginateResponse], int]:
|
|
"""Function to retrieve a paginated list of users from
|
|
users list. This will return a json list of users and the
|
|
total number of users matching the filter criteria.
|
|
|
|
Args:
|
|
start: start number to begin the query from
|
|
limit: number of rows to retrieve
|
|
user_id: search for user_id. ignored if name is not None
|
|
name: search for local part of user_id or display name
|
|
guests: whether to in include guest users
|
|
deactivated: whether to include deactivated users
|
|
admins: Optional flag to filter admins. If true, only admins are queried.
|
|
if false, admins are excluded from the query. When it is
|
|
none (the default), both admins and none-admins are queried.
|
|
order_by: the sort order of the returned list
|
|
direction: sort ascending or descending
|
|
approved: whether to include approved users
|
|
not_user_types: list of user types to exclude
|
|
locked: whether to include locked users
|
|
Returns:
|
|
A tuple of a list of mappings from user to information and a count of total users.
|
|
"""
|
|
|
|
def get_users_paginate_txn(
|
|
txn: LoggingTransaction,
|
|
) -> Tuple[List[UserPaginateResponse], int]:
|
|
filters = []
|
|
args: list = []
|
|
|
|
# Set ordering
|
|
order_by_column = UserSortOrder(order_by).value
|
|
|
|
if direction == Direction.BACKWARDS:
|
|
order = "DESC"
|
|
else:
|
|
order = "ASC"
|
|
|
|
# `name` is in database already in lower case
|
|
if name:
|
|
filters.append("(name LIKE ? OR LOWER(displayname) LIKE ?)")
|
|
args.extend(["@%" + name.lower() + "%:%", "%" + name.lower() + "%"])
|
|
elif user_id:
|
|
filters.append("name LIKE ?")
|
|
args.extend(["%" + user_id.lower() + "%"])
|
|
|
|
if not guests:
|
|
filters.append("is_guest = 0")
|
|
|
|
if not deactivated:
|
|
filters.append("deactivated = 0")
|
|
|
|
if not locked:
|
|
filters.append("locked IS FALSE")
|
|
|
|
if admins is not None:
|
|
if admins:
|
|
filters.append("admin = 1")
|
|
else:
|
|
filters.append("admin = 0")
|
|
|
|
if not approved:
|
|
# We ignore NULL values for the approved flag because these should only
|
|
# be already existing users that we consider as already approved.
|
|
filters.append("approved IS FALSE")
|
|
|
|
if not_user_types:
|
|
if len(not_user_types) == 1 and not_user_types[0] == "":
|
|
# Only exclude NULL type users
|
|
filters.append("user_type IS NOT NULL")
|
|
else:
|
|
not_user_types_has_empty = False
|
|
not_user_types_without_empty = []
|
|
|
|
for not_user_type in not_user_types:
|
|
if not_user_type == "":
|
|
not_user_types_has_empty = True
|
|
else:
|
|
not_user_types_without_empty.append(not_user_type)
|
|
|
|
not_user_type_clause, not_user_type_args = make_in_list_sql_clause(
|
|
self.database_engine,
|
|
"u.user_type",
|
|
not_user_types_without_empty,
|
|
)
|
|
|
|
if not_user_types_has_empty:
|
|
# NULL values should be excluded.
|
|
# They evaluate to false > nothing to do here.
|
|
filters.append("NOT %s" % (not_user_type_clause))
|
|
else:
|
|
# NULL values should *not* be excluded.
|
|
# Add a special predicate to the query.
|
|
filters.append(
|
|
"(NOT %s OR %s IS NULL)"
|
|
% (not_user_type_clause, "u.user_type")
|
|
)
|
|
|
|
args.extend(not_user_type_args)
|
|
|
|
where_clause = "WHERE " + " AND ".join(filters) if len(filters) > 0 else ""
|
|
|
|
sql_base = f"""
|
|
FROM users as u
|
|
LEFT JOIN profiles AS p ON u.name = p.full_user_id
|
|
LEFT JOIN erased_users AS eu ON u.name = eu.user_id
|
|
LEFT JOIN (
|
|
SELECT user_id, MAX(last_seen) AS last_seen_ts
|
|
FROM user_ips GROUP BY user_id
|
|
) ls ON u.name = ls.user_id
|
|
{where_clause}
|
|
"""
|
|
sql = "SELECT COUNT(*) as total_users " + sql_base
|
|
txn.execute(sql, args)
|
|
count = cast(Tuple[int], txn.fetchone())[0]
|
|
|
|
sql = f"""
|
|
SELECT name, user_type, is_guest, admin, deactivated, shadow_banned,
|
|
displayname, avatar_url, creation_ts * 1000 as creation_ts, approved,
|
|
eu.user_id is not null as erased, last_seen_ts, locked
|
|
{sql_base}
|
|
ORDER BY {order_by_column} {order}, u.name ASC
|
|
LIMIT ? OFFSET ?
|
|
"""
|
|
args += [limit, start]
|
|
txn.execute(sql, args)
|
|
users = [
|
|
UserPaginateResponse(
|
|
name=row[0],
|
|
user_type=row[1],
|
|
is_guest=bool(row[2]),
|
|
admin=bool(row[3]),
|
|
deactivated=bool(row[4]),
|
|
shadow_banned=bool(row[5]),
|
|
displayname=row[6],
|
|
avatar_url=row[7],
|
|
creation_ts=row[8],
|
|
approved=bool(row[9]),
|
|
erased=bool(row[10]),
|
|
last_seen_ts=row[11],
|
|
locked=bool(row[12]),
|
|
)
|
|
for row in txn
|
|
]
|
|
|
|
return users, count
|
|
|
|
return await self.db_pool.runInteraction(
|
|
"get_users_paginate_txn", get_users_paginate_txn
|
|
)
|
|
|
|
async def search_users(
|
|
self, term: str
|
|
) -> List[
|
|
Tuple[str, Optional[str], Union[int, bool], Union[int, bool], Optional[str]]
|
|
]:
|
|
"""Function to search users list for one or more users with
|
|
the matched term.
|
|
|
|
Args:
|
|
term: search term
|
|
|
|
Returns:
|
|
A list of tuples of name, password_hash, is_guest, admin, user_type or None.
|
|
"""
|
|
|
|
def search_users(
|
|
txn: LoggingTransaction,
|
|
) -> List[
|
|
Tuple[str, Optional[str], Union[int, bool], Union[int, bool], Optional[str]]
|
|
]:
|
|
search_term = "%%" + term + "%%"
|
|
|
|
sql = """
|
|
SELECT name, password_hash, is_guest, admin, user_type
|
|
FROM users
|
|
WHERE name LIKE ?
|
|
"""
|
|
txn.execute(sql, (search_term,))
|
|
|
|
return cast(
|
|
List[
|
|
Tuple[
|
|
str,
|
|
Optional[str],
|
|
Union[int, bool],
|
|
Union[int, bool],
|
|
Optional[str],
|
|
]
|
|
],
|
|
txn.fetchall(),
|
|
)
|
|
|
|
return await self.db_pool.runInteraction("search_users", search_users)
|
|
|
|
|
|
def check_database_before_upgrade(
|
|
cur: Cursor, database_engine: BaseDatabaseEngine, config: HomeServerConfig
|
|
) -> None:
|
|
"""Called before upgrading an existing database to check that it is broadly sane
|
|
compared with the configuration.
|
|
"""
|
|
logger.info("Checking database for consistency with configuration...")
|
|
|
|
# if there are any users in the database, check that the username matches our
|
|
# configured server name.
|
|
|
|
cur.execute("SELECT name FROM users LIMIT 1")
|
|
rows = cur.fetchall()
|
|
if not rows:
|
|
return
|
|
|
|
user_domain = get_domain_from_id(rows[0][0])
|
|
if user_domain == config.server.server_name:
|
|
return
|
|
|
|
raise Exception(
|
|
"Found users in database not native to %s!\n"
|
|
"You cannot change a synapse server_name after it's been configured"
|
|
% (config.server.server_name,)
|
|
)
|
|
|
|
|
|
__all__ = ["DataStore", "check_database_before_upgrade"]
|