2014-08-12 14:10:52 +00:00
|
|
|
# -*- coding: utf-8 -*-
|
2016-01-07 04:26:29 +00:00
|
|
|
# Copyright 2014-2016 OpenMarket Ltd
|
2017-03-13 17:27:51 +00:00
|
|
|
# Copyright 2017 Vector Creations Ltd
|
2018-07-25 21:10:39 +00:00
|
|
|
# Copyright 2018 New Vector Ltd.
|
2014-08-12 14:10:52 +00: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-13 02:14:34 +00:00
|
|
|
|
2014-08-12 14:10:52 +00:00
|
|
|
"""Contains constants from the specification."""
|
|
|
|
|
2018-05-01 15:19:39 +00:00
|
|
|
# the "depth" field on events is limited to 2**63 - 1
|
|
|
|
MAX_DEPTH = 2**63 - 1
|
|
|
|
|
2014-08-12 14:10:52 +00:00
|
|
|
|
|
|
|
class Membership(object):
|
|
|
|
|
|
|
|
"""Represents the membership states of a user in a room."""
|
|
|
|
INVITE = u"invite"
|
|
|
|
JOIN = u"join"
|
|
|
|
KNOCK = u"knock"
|
|
|
|
LEAVE = u"leave"
|
2014-09-01 15:15:34 +00:00
|
|
|
BAN = u"ban"
|
|
|
|
LIST = (INVITE, JOIN, KNOCK, LEAVE, BAN)
|
2014-08-12 14:10:52 +00:00
|
|
|
|
|
|
|
|
|
|
|
class PresenceState(object):
|
|
|
|
"""Represents the presence state of a user."""
|
2014-08-13 13:31:48 +00:00
|
|
|
OFFLINE = u"offline"
|
|
|
|
UNAVAILABLE = u"unavailable"
|
|
|
|
ONLINE = u"online"
|
2014-08-28 09:59:15 +00:00
|
|
|
|
|
|
|
|
|
|
|
class JoinRules(object):
|
|
|
|
PUBLIC = u"public"
|
|
|
|
KNOCK = u"knock"
|
|
|
|
INVITE = u"invite"
|
|
|
|
PRIVATE = u"private"
|
2014-09-15 09:23:20 +00:00
|
|
|
|
|
|
|
|
|
|
|
class LoginType(object):
|
|
|
|
PASSWORD = u"m.login.password"
|
|
|
|
EMAIL_IDENTITY = u"m.login.email.identity"
|
2017-03-13 17:27:51 +00:00
|
|
|
MSISDN = u"m.login.msisdn"
|
2014-10-30 11:10:17 +00:00
|
|
|
RECAPTCHA = u"m.login.recaptcha"
|
2018-09-27 20:53:58 +00:00
|
|
|
TERMS = u"m.login.terms"
|
2015-04-15 16:14:25 +00:00
|
|
|
DUMMY = u"m.login.dummy"
|
2015-04-02 16:01:29 +00:00
|
|
|
|
|
|
|
# Only for C/S API v1
|
2015-04-02 16:51:19 +00:00
|
|
|
APPLICATION_SERVICE = u"m.login.application_service"
|
2015-03-13 15:23:37 +00:00
|
|
|
SHARED_SECRET = u"org.matrix.login.shared_secret"
|
2014-12-03 16:07:21 +00:00
|
|
|
|
|
|
|
|
|
|
|
class EventTypes(object):
|
|
|
|
Member = "m.room.member"
|
|
|
|
Create = "m.room.create"
|
2018-08-22 09:57:54 +00:00
|
|
|
Tombstone = "m.room.tombstone"
|
2014-12-03 16:07:21 +00:00
|
|
|
JoinRules = "m.room.join_rules"
|
|
|
|
PowerLevels = "m.room.power_levels"
|
|
|
|
Aliases = "m.room.aliases"
|
2014-12-09 14:49:11 +00:00
|
|
|
Redaction = "m.room.redaction"
|
2015-10-01 16:49:52 +00:00
|
|
|
ThirdPartyInvite = "m.room.third_party_invite"
|
2014-12-12 10:56:14 +00:00
|
|
|
|
2015-07-02 15:20:10 +00:00
|
|
|
RoomHistoryVisibility = "m.room.history_visibility"
|
2015-08-19 11:03:09 +00:00
|
|
|
CanonicalAlias = "m.room.canonical_alias"
|
2015-08-20 13:35:40 +00:00
|
|
|
RoomAvatar = "m.room.avatar"
|
2015-11-10 16:57:13 +00:00
|
|
|
GuestAccess = "m.room.guest_access"
|
2015-07-02 15:20:10 +00:00
|
|
|
|
2014-12-12 10:56:14 +00:00
|
|
|
# These are used for validation
|
|
|
|
Message = "m.room.message"
|
|
|
|
Topic = "m.room.topic"
|
|
|
|
Name = "m.room.name"
|
2015-01-28 16:16:53 +00:00
|
|
|
|
2018-07-04 14:31:00 +00:00
|
|
|
ServerACL = "m.room.server_acl"
|
2018-08-15 14:04:30 +00:00
|
|
|
Pinned = "m.room.pinned_events"
|
2018-07-04 14:31:00 +00:00
|
|
|
|
2015-01-28 16:16:53 +00:00
|
|
|
|
|
|
|
class RejectedReason(object):
|
|
|
|
AUTH_ERROR = "auth_error"
|
|
|
|
REPLACED = "replaced"
|
|
|
|
NOT_ANCESTOR = "not_ancestor"
|
2015-07-13 15:48:06 +00:00
|
|
|
|
|
|
|
|
|
|
|
class RoomCreationPreset(object):
|
2015-07-14 09:20:31 +00:00
|
|
|
PRIVATE_CHAT = "private_chat"
|
|
|
|
PUBLIC_CHAT = "public_chat"
|
2015-10-02 10:22:56 +00:00
|
|
|
TRUSTED_PRIVATE_CHAT = "trusted_private_chat"
|
2016-08-25 17:34:47 +00:00
|
|
|
|
|
|
|
|
|
|
|
class ThirdPartyEntityKind(object):
|
|
|
|
USER = "user"
|
|
|
|
LOCATION = "location"
|
2018-07-25 21:10:39 +00:00
|
|
|
|
|
|
|
|
2018-08-07 14:27:19 +00:00
|
|
|
class RoomVersions(object):
|
|
|
|
V1 = "1"
|
|
|
|
VDH_TEST = "vdh-test-version"
|
2018-11-01 11:43:46 +00:00
|
|
|
STATE_V2_TEST = "state-v2-test"
|
2018-08-07 14:27:19 +00:00
|
|
|
|
|
|
|
|
2018-08-07 11:51:57 +00:00
|
|
|
# the version we will give rooms which are created on this server
|
2018-08-07 14:27:19 +00:00
|
|
|
DEFAULT_ROOM_VERSION = RoomVersions.V1
|
2018-08-07 11:51:57 +00:00
|
|
|
|
2018-07-25 21:10:39 +00:00
|
|
|
# vdh-test-version is a placeholder to get room versioning support working and tested
|
|
|
|
# until we have a working v2.
|
2018-11-01 11:43:46 +00:00
|
|
|
KNOWN_ROOM_VERSIONS = {
|
|
|
|
RoomVersions.V1,
|
|
|
|
RoomVersions.VDH_TEST,
|
|
|
|
RoomVersions.STATE_V2_TEST,
|
|
|
|
}
|
2018-08-22 16:00:29 +00:00
|
|
|
|
|
|
|
ServerNoticeMsgType = "m.server_notice"
|
|
|
|
ServerNoticeLimitReached = "m.server_notice.usage_limit_reached"
|
2018-12-14 18:20:59 +00:00
|
|
|
|
|
|
|
|
|
|
|
class UserTypes(object):
|
|
|
|
"""Allows for user type specific behaviour. With the benefit of hindsight
|
|
|
|
'admin' and 'guest' users should also be UserTypes. Normal users are type None
|
|
|
|
"""
|
|
|
|
SUPPORT = "support"
|
|
|
|
ALL_USER_TYPES = (SUPPORT)
|