MatrixSynapse/synapse/api/constants.py

256 lines
6.7 KiB
Python
Raw Normal View History

2016-01-07 05:26:29 +01:00
# Copyright 2014-2016 OpenMarket Ltd
# Copyright 2017 Vector Creations Ltd
2019-11-05 11:56:39 +01:00
# Copyright 2018-2019 New Vector Ltd
# Copyright 2019 The Matrix.org Foundation C.I.C.
2014-08-12 16:10:52 +02:00
#
# 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.
2014-08-12 16:10:52 +02:00
"""Contains constants from the specification."""
# the max size of a (canonical-json-encoded) event
MAX_PDU_SIZE = 65536
# the "depth" field on events is limited to 2**63 - 1
2019-06-20 11:32:02 +02:00
MAX_DEPTH = 2 ** 63 - 1
# the maximum length for a room alias is 255 characters
MAX_ALIAS_LENGTH = 255
# the maximum length for a user id is 255 characters
MAX_USERID_LENGTH = 255
2021-02-17 14:41:47 +01:00
# The maximum length for a group id is 255 characters
MAX_GROUPID_LENGTH = 255
MAX_GROUP_CATEGORYID_LENGTH = 255
MAX_GROUP_ROLEID_LENGTH = 255
2014-08-12 16:10:52 +02:00
2020-09-04 12:54:56 +02:00
class Membership:
2014-08-12 16:10:52 +02:00
"""Represents the membership states of a user in a room."""
2019-06-20 11:32:02 +02:00
INVITE = "invite"
JOIN = "join"
KNOCK = "knock"
2019-06-20 11:32:02 +02:00
LEAVE = "leave"
BAN = "ban"
2014-09-01 17:15:34 +02:00
LIST = (INVITE, JOIN, KNOCK, LEAVE, BAN)
2014-08-12 16:10:52 +02:00
2020-09-04 12:54:56 +02:00
class PresenceState:
2014-08-12 16:10:52 +02:00
"""Represents the presence state of a user."""
2019-06-20 11:32:02 +02:00
OFFLINE = "offline"
UNAVAILABLE = "unavailable"
ONLINE = "online"
2021-03-18 16:34:47 +01:00
BUSY = "org.matrix.msc3026.busy"
2020-09-04 12:54:56 +02:00
class JoinRules:
2019-06-20 11:32:02 +02:00
PUBLIC = "public"
KNOCK = "knock"
2019-06-20 11:32:02 +02:00
INVITE = "invite"
PRIVATE = "private"
# As defined for MSC3083.
RESTRICTED = "restricted"
class RestrictedJoinRuleTypes:
"""Understood types for the allow rules in restricted join rules."""
ROOM_MEMBERSHIP = "m.room_membership"
2020-09-04 12:54:56 +02:00
class LoginType:
2019-06-20 11:32:02 +02:00
PASSWORD = "m.login.password"
EMAIL_IDENTITY = "m.login.email.identity"
MSISDN = "m.login.msisdn"
RECAPTCHA = "m.login.recaptcha"
TERMS = "m.login.terms"
SSO = "m.login.sso"
2019-06-20 11:32:02 +02:00
DUMMY = "m.login.dummy"
REGISTRATION_TOKEN = "org.matrix.msc3231.login.registration_token"
2014-12-03 17:07:21 +01:00
# This is used in the `type` parameter for /register when called by
# an appservice to register a new user.
APP_SERVICE_REGISTRATION_TYPE = "m.login.application_service"
2020-09-04 12:54:56 +02:00
class EventTypes:
2014-12-03 17:07:21 +01:00
Member = "m.room.member"
Create = "m.room.create"
Tombstone = "m.room.tombstone"
2014-12-03 17:07:21 +01:00
JoinRules = "m.room.join_rules"
PowerLevels = "m.room.power_levels"
Aliases = "m.room.aliases"
2014-12-09 15:49:11 +01:00
Redaction = "m.room.redaction"
ThirdPartyInvite = "m.room.third_party_invite"
RelatedGroups = "m.room.related_groups"
RoomHistoryVisibility = "m.room.history_visibility"
CanonicalAlias = "m.room.canonical_alias"
Encrypted = "m.room.encrypted"
RoomAvatar = "m.room.avatar"
RoomEncryption = "m.room.encryption"
GuestAccess = "m.room.guest_access"
# These are used for validation
Message = "m.room.message"
Topic = "m.room.topic"
Name = "m.room.name"
2015-01-28 17:16:53 +01:00
ServerACL = "m.room.server_acl"
2018-08-15 16:04:30 +02:00
Pinned = "m.room.pinned_events"
Retention = "m.room.retention"
Dummy = "org.matrix.dummy_event"
SpaceChild = "m.space.child"
SpaceParent = "m.space.parent"
MSC2716_INSERTION = "org.matrix.msc2716.insertion"
MSC2716_BATCH = "org.matrix.msc2716.batch"
MSC2716_MARKER = "org.matrix.msc2716.marker"
2015-01-28 17:16:53 +01:00
class ToDeviceEventTypes:
RoomKeyRequest = "m.room_key_request"
class DeviceKeyAlgorithms:
"""Spec'd algorithms for the generation of per-device keys"""
ED25519 = "ed25519"
CURVE25519 = "curve25519"
SIGNED_CURVE25519 = "signed_curve25519"
class EduTypes:
Presence = "m.presence"
2020-09-04 12:54:56 +02:00
class RejectedReason:
2015-01-28 17:16:53 +01:00
AUTH_ERROR = "auth_error"
2015-07-13 17:48:06 +02:00
2020-09-04 12:54:56 +02:00
class RoomCreationPreset:
2015-07-14 11:20:31 +02:00
PRIVATE_CHAT = "private_chat"
PUBLIC_CHAT = "public_chat"
TRUSTED_PRIVATE_CHAT = "trusted_private_chat"
2020-09-04 12:54:56 +02:00
class ThirdPartyEntityKind:
USER = "user"
LOCATION = "location"
2018-08-22 18:00:29 +02:00
ServerNoticeMsgType = "m.server_notice"
ServerNoticeLimitReached = "m.server_notice.usage_limit_reached"
2020-09-04 12:54:56 +02:00
class UserTypes:
"""Allows for user type specific behaviour. With the benefit of hindsight
'admin' and 'guest' users should also be UserTypes. Normal users are type None
"""
2019-06-20 11:32:02 +02:00
SUPPORT = "support"
2019-08-23 10:52:09 +02:00
BOT = "bot"
ALL_USER_TYPES = (SUPPORT, BOT)
2020-09-04 12:54:56 +02:00
class RelationTypes:
"""The types of relations known to this server."""
2019-06-20 11:32:02 +02:00
ANNOTATION = "m.annotation"
2019-05-20 15:31:19 +02:00
REPLACE = "m.replace"
REFERENCE = "m.reference"
THREAD = "io.element.thread"
2020-09-04 12:54:56 +02:00
class LimitBlockingTypes:
"""Reasons that a server may be blocked"""
MONTHLY_ACTIVE_USER = "monthly_active_user"
HS_DISABLED = "hs_disabled"
2019-10-29 19:35:49 +01:00
2020-09-04 12:54:56 +02:00
class EventContentFields:
2019-11-01 11:30:51 +01:00
"""Fields found in events' content, regardless of type."""
2019-11-01 11:39:14 +01:00
2019-11-01 11:30:51 +01:00
# Labels for the event, cf https://github.com/matrix-org/matrix-doc/pull/2326
2019-11-01 17:22:44 +01:00
LABELS = "org.matrix.labels"
# Timestamp to delete the event after
# cf https://github.com/matrix-org/matrix-doc/pull/2228
SELF_DESTRUCT_AFTER = "org.matrix.self_destruct_after"
# cf https://github.com/matrix-org/matrix-doc/pull/1772
ROOM_TYPE = "type"
# Whether a room can federate.
FEDERATE = "m.federate"
# The creator of the room, as used in `m.room.create` events.
ROOM_CREATOR = "creator"
# Used in m.room.guest_access events.
GUEST_ACCESS = "guest_access"
# Used on normal messages to indicate they were historically imported after the fact
MSC2716_HISTORICAL = "org.matrix.msc2716.historical"
# For "insertion" events to indicate what the next batch ID should be in
# order to connect to it
MSC2716_NEXT_BATCH_ID = "org.matrix.msc2716.next_batch_id"
# Used on "batch" events to indicate which insertion event it connects to
MSC2716_BATCH_ID = "org.matrix.msc2716.batch_id"
# For "marker" events
MSC2716_MARKER_INSERTION = "org.matrix.msc2716.marker.insertion"
# The authorising user for joining a restricted room.
AUTHORISING_USER = "join_authorised_via_users_server"
class RoomTypes:
"""Understood values of the room_type field of m.room.create events."""
SPACE = "m.space"
2020-09-04 12:54:56 +02:00
class RoomEncryptionAlgorithms:
MEGOLM_V1_AES_SHA2 = "m.megolm.v1.aes-sha2"
DEFAULT = MEGOLM_V1_AES_SHA2
class AccountDataTypes:
DIRECT = "m.direct"
IGNORED_USER_LIST = "m.ignored_user_list"
class HistoryVisibility:
INVITED = "invited"
JOINED = "joined"
SHARED = "shared"
WORLD_READABLE = "world_readable"
class GuestAccess:
CAN_JOIN = "can_join"
# anything that is not "can_join" is considered "forbidden", but for completeness:
FORBIDDEN = "forbidden"
class ReadReceiptEventFields:
MSC2285_HIDDEN = "org.matrix.msc2285.hidden"