mirror of
https://git.anonymousland.org/anonymousland/synapse.git
synced 2024-12-20 23:34:18 -05:00
51e2db3598
See https://github.com/matrix-org/matrix-doc/pull/2716#discussion_r684574497 Dropping support for older MSC2716 room versions so we don't have to worry about supporting both chunk and batch events.
316 lines
10 KiB
Python
316 lines
10 KiB
Python
# Copyright 2019 New Vector 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.
|
|
|
|
from typing import Callable, Dict, Optional
|
|
|
|
import attr
|
|
|
|
|
|
class EventFormatVersions:
|
|
"""This is an internal enum for tracking the version of the event format,
|
|
independently from the room version.
|
|
"""
|
|
|
|
V1 = 1 # $id:server event id format
|
|
V2 = 2 # MSC1659-style $hash event id format: introduced for room v3
|
|
V3 = 3 # MSC1884-style $hash format: introduced for room v4
|
|
|
|
|
|
KNOWN_EVENT_FORMAT_VERSIONS = {
|
|
EventFormatVersions.V1,
|
|
EventFormatVersions.V2,
|
|
EventFormatVersions.V3,
|
|
}
|
|
|
|
|
|
class StateResolutionVersions:
|
|
"""Enum to identify the state resolution algorithms"""
|
|
|
|
V1 = 1 # room v1 state res
|
|
V2 = 2 # MSC1442 state res: room v2 and later
|
|
|
|
|
|
class RoomDisposition:
|
|
STABLE = "stable"
|
|
UNSTABLE = "unstable"
|
|
|
|
|
|
@attr.s(slots=True, frozen=True)
|
|
class RoomVersion:
|
|
"""An object which describes the unique attributes of a room version."""
|
|
|
|
identifier = attr.ib(type=str) # the identifier for this version
|
|
disposition = attr.ib(type=str) # one of the RoomDispositions
|
|
event_format = attr.ib(type=int) # one of the EventFormatVersions
|
|
state_res = attr.ib(type=int) # one of the StateResolutionVersions
|
|
enforce_key_validity = attr.ib(type=bool)
|
|
|
|
# Before MSC2432, m.room.aliases had special auth rules and redaction rules
|
|
special_case_aliases_auth = attr.ib(type=bool)
|
|
# Strictly enforce canonicaljson, do not allow:
|
|
# * Integers outside the range of [-2 ^ 53 + 1, 2 ^ 53 - 1]
|
|
# * Floats
|
|
# * NaN, Infinity, -Infinity
|
|
strict_canonicaljson = attr.ib(type=bool)
|
|
# MSC2209: Check 'notifications' key while verifying
|
|
# m.room.power_levels auth rules.
|
|
limit_notifications_power_levels = attr.ib(type=bool)
|
|
# MSC2174/MSC2176: Apply updated redaction rules algorithm.
|
|
msc2176_redaction_rules = attr.ib(type=bool)
|
|
# MSC3083: Support the 'restricted' join_rule.
|
|
msc3083_join_rules = attr.ib(type=bool)
|
|
# MSC3375: Support for the proper redaction rules for MSC3083. This mustn't
|
|
# be enabled if MSC3083 is not.
|
|
msc3375_redaction_rules = attr.ib(type=bool)
|
|
# MSC2403: Allows join_rules to be set to 'knock', changes auth rules to allow sending
|
|
# m.room.membership event with membership 'knock'.
|
|
msc2403_knocking = attr.ib(type=bool)
|
|
# MSC2716: Adds m.room.power_levels -> content.historical field to control
|
|
# whether "insertion", "chunk", "marker" events can be sent
|
|
msc2716_historical = attr.ib(type=bool)
|
|
# MSC2716: Adds support for redacting "insertion", "chunk", and "marker" events
|
|
msc2716_redactions = attr.ib(type=bool)
|
|
|
|
|
|
class RoomVersions:
|
|
V1 = RoomVersion(
|
|
"1",
|
|
RoomDisposition.STABLE,
|
|
EventFormatVersions.V1,
|
|
StateResolutionVersions.V1,
|
|
enforce_key_validity=False,
|
|
special_case_aliases_auth=True,
|
|
strict_canonicaljson=False,
|
|
limit_notifications_power_levels=False,
|
|
msc2176_redaction_rules=False,
|
|
msc3083_join_rules=False,
|
|
msc3375_redaction_rules=False,
|
|
msc2403_knocking=False,
|
|
msc2716_historical=False,
|
|
msc2716_redactions=False,
|
|
)
|
|
V2 = RoomVersion(
|
|
"2",
|
|
RoomDisposition.STABLE,
|
|
EventFormatVersions.V1,
|
|
StateResolutionVersions.V2,
|
|
enforce_key_validity=False,
|
|
special_case_aliases_auth=True,
|
|
strict_canonicaljson=False,
|
|
limit_notifications_power_levels=False,
|
|
msc2176_redaction_rules=False,
|
|
msc3083_join_rules=False,
|
|
msc3375_redaction_rules=False,
|
|
msc2403_knocking=False,
|
|
msc2716_historical=False,
|
|
msc2716_redactions=False,
|
|
)
|
|
V3 = RoomVersion(
|
|
"3",
|
|
RoomDisposition.STABLE,
|
|
EventFormatVersions.V2,
|
|
StateResolutionVersions.V2,
|
|
enforce_key_validity=False,
|
|
special_case_aliases_auth=True,
|
|
strict_canonicaljson=False,
|
|
limit_notifications_power_levels=False,
|
|
msc2176_redaction_rules=False,
|
|
msc3083_join_rules=False,
|
|
msc3375_redaction_rules=False,
|
|
msc2403_knocking=False,
|
|
msc2716_historical=False,
|
|
msc2716_redactions=False,
|
|
)
|
|
V4 = RoomVersion(
|
|
"4",
|
|
RoomDisposition.STABLE,
|
|
EventFormatVersions.V3,
|
|
StateResolutionVersions.V2,
|
|
enforce_key_validity=False,
|
|
special_case_aliases_auth=True,
|
|
strict_canonicaljson=False,
|
|
limit_notifications_power_levels=False,
|
|
msc2176_redaction_rules=False,
|
|
msc3083_join_rules=False,
|
|
msc3375_redaction_rules=False,
|
|
msc2403_knocking=False,
|
|
msc2716_historical=False,
|
|
msc2716_redactions=False,
|
|
)
|
|
V5 = RoomVersion(
|
|
"5",
|
|
RoomDisposition.STABLE,
|
|
EventFormatVersions.V3,
|
|
StateResolutionVersions.V2,
|
|
enforce_key_validity=True,
|
|
special_case_aliases_auth=True,
|
|
strict_canonicaljson=False,
|
|
limit_notifications_power_levels=False,
|
|
msc2176_redaction_rules=False,
|
|
msc3083_join_rules=False,
|
|
msc3375_redaction_rules=False,
|
|
msc2403_knocking=False,
|
|
msc2716_historical=False,
|
|
msc2716_redactions=False,
|
|
)
|
|
V6 = RoomVersion(
|
|
"6",
|
|
RoomDisposition.STABLE,
|
|
EventFormatVersions.V3,
|
|
StateResolutionVersions.V2,
|
|
enforce_key_validity=True,
|
|
special_case_aliases_auth=False,
|
|
strict_canonicaljson=True,
|
|
limit_notifications_power_levels=True,
|
|
msc2176_redaction_rules=False,
|
|
msc3083_join_rules=False,
|
|
msc3375_redaction_rules=False,
|
|
msc2403_knocking=False,
|
|
msc2716_historical=False,
|
|
msc2716_redactions=False,
|
|
)
|
|
MSC2176 = RoomVersion(
|
|
"org.matrix.msc2176",
|
|
RoomDisposition.UNSTABLE,
|
|
EventFormatVersions.V3,
|
|
StateResolutionVersions.V2,
|
|
enforce_key_validity=True,
|
|
special_case_aliases_auth=False,
|
|
strict_canonicaljson=True,
|
|
limit_notifications_power_levels=True,
|
|
msc2176_redaction_rules=True,
|
|
msc3083_join_rules=False,
|
|
msc3375_redaction_rules=False,
|
|
msc2403_knocking=False,
|
|
msc2716_historical=False,
|
|
msc2716_redactions=False,
|
|
)
|
|
V7 = RoomVersion(
|
|
"7",
|
|
RoomDisposition.STABLE,
|
|
EventFormatVersions.V3,
|
|
StateResolutionVersions.V2,
|
|
enforce_key_validity=True,
|
|
special_case_aliases_auth=False,
|
|
strict_canonicaljson=True,
|
|
limit_notifications_power_levels=True,
|
|
msc2176_redaction_rules=False,
|
|
msc3083_join_rules=False,
|
|
msc3375_redaction_rules=False,
|
|
msc2403_knocking=True,
|
|
msc2716_historical=False,
|
|
msc2716_redactions=False,
|
|
)
|
|
V8 = RoomVersion(
|
|
"8",
|
|
RoomDisposition.STABLE,
|
|
EventFormatVersions.V3,
|
|
StateResolutionVersions.V2,
|
|
enforce_key_validity=True,
|
|
special_case_aliases_auth=False,
|
|
strict_canonicaljson=True,
|
|
limit_notifications_power_levels=True,
|
|
msc2176_redaction_rules=False,
|
|
msc3083_join_rules=True,
|
|
msc3375_redaction_rules=False,
|
|
msc2403_knocking=True,
|
|
msc2716_historical=False,
|
|
msc2716_redactions=False,
|
|
)
|
|
V9 = RoomVersion(
|
|
"9",
|
|
RoomDisposition.STABLE,
|
|
EventFormatVersions.V3,
|
|
StateResolutionVersions.V2,
|
|
enforce_key_validity=True,
|
|
special_case_aliases_auth=False,
|
|
strict_canonicaljson=True,
|
|
limit_notifications_power_levels=True,
|
|
msc2176_redaction_rules=False,
|
|
msc3083_join_rules=True,
|
|
msc3375_redaction_rules=True,
|
|
msc2403_knocking=True,
|
|
msc2716_historical=False,
|
|
msc2716_redactions=False,
|
|
)
|
|
MSC2716v3 = RoomVersion(
|
|
"org.matrix.msc2716v3",
|
|
RoomDisposition.UNSTABLE,
|
|
EventFormatVersions.V3,
|
|
StateResolutionVersions.V2,
|
|
enforce_key_validity=True,
|
|
special_case_aliases_auth=False,
|
|
strict_canonicaljson=True,
|
|
limit_notifications_power_levels=True,
|
|
msc2176_redaction_rules=False,
|
|
msc3083_join_rules=False,
|
|
msc3375_redaction_rules=False,
|
|
msc2403_knocking=True,
|
|
msc2716_historical=True,
|
|
msc2716_redactions=True,
|
|
)
|
|
|
|
|
|
KNOWN_ROOM_VERSIONS: Dict[str, RoomVersion] = {
|
|
v.identifier: v
|
|
for v in (
|
|
RoomVersions.V1,
|
|
RoomVersions.V2,
|
|
RoomVersions.V3,
|
|
RoomVersions.V4,
|
|
RoomVersions.V5,
|
|
RoomVersions.V6,
|
|
RoomVersions.MSC2176,
|
|
RoomVersions.V7,
|
|
RoomVersions.V8,
|
|
RoomVersions.V9,
|
|
RoomVersions.MSC2716v3,
|
|
)
|
|
}
|
|
|
|
|
|
@attr.s(slots=True, frozen=True, auto_attribs=True)
|
|
class RoomVersionCapability:
|
|
"""An object which describes the unique attributes of a room version."""
|
|
|
|
identifier: str # the identifier for this capability
|
|
preferred_version: Optional[RoomVersion]
|
|
support_check_lambda: Callable[[RoomVersion], bool]
|
|
|
|
|
|
MSC3244_CAPABILITIES = {
|
|
cap.identifier: {
|
|
"preferred": cap.preferred_version.identifier
|
|
if cap.preferred_version is not None
|
|
else None,
|
|
"support": [
|
|
v.identifier
|
|
for v in KNOWN_ROOM_VERSIONS.values()
|
|
if cap.support_check_lambda(v)
|
|
],
|
|
}
|
|
for cap in (
|
|
RoomVersionCapability(
|
|
"knock",
|
|
RoomVersions.V7,
|
|
lambda room_version: room_version.msc2403_knocking,
|
|
),
|
|
RoomVersionCapability(
|
|
"restricted",
|
|
RoomVersions.V9,
|
|
lambda room_version: room_version.msc3083_join_rules,
|
|
),
|
|
)
|
|
}
|