-
Notifications
You must be signed in to change notification settings - Fork 2
/
matrixerror.go
285 lines (242 loc) · 9.65 KB
/
matrixerror.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
// Copyright 2017 Vector Creations 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.
package spec
import (
"fmt"
)
type MatrixErrorCode string
const (
ErrorUnknown MatrixErrorCode = "M_UNKNOWN"
ErrorUnrecognized MatrixErrorCode = "M_UNRECOGNIZED" // nolint:misspell
ErrorForbidden MatrixErrorCode = "M_FORBIDDEN"
ErrorBadJSON MatrixErrorCode = "M_BAD_JSON"
ErrorBadAlias MatrixErrorCode = "M_BAD_ALIAS"
ErrorNotJSON MatrixErrorCode = "M_NOT_JSON"
ErrorNotFound MatrixErrorCode = "M_NOT_FOUND"
ErrorMissingToken MatrixErrorCode = "M_MISSING_TOKEN"
ErrorUnknownToken MatrixErrorCode = "M_UNKNOWN_TOKEN"
ErrorWeakPassword MatrixErrorCode = "M_WEAK_PASSWORD"
ErrorInvalidUsername MatrixErrorCode = "M_INVALID_USERNAME"
ErrorUserInUse MatrixErrorCode = "M_USER_IN_USE"
ErrorRoomInUse MatrixErrorCode = "M_ROOM_IN_USE"
ErrorExclusive MatrixErrorCode = "M_EXCLUSIVE"
ErrorGuestAccessForbidden MatrixErrorCode = "M_GUEST_ACCESS_FORBIDDEN"
ErrorInvalidSignature MatrixErrorCode = "M_INVALID_SIGNATURE"
ErrorInvalidParam MatrixErrorCode = "M_INVALID_PARAM"
ErrorMissingParam MatrixErrorCode = "M_MISSING_PARAM"
ErrorUnableToAuthoriseJoin MatrixErrorCode = "M_UNABLE_TO_AUTHORISE_JOIN"
ErrorCannotLeaveServerNoticeRoom MatrixErrorCode = "M_CANNOT_LEAVE_SERVER_NOTICE_ROOM"
ErrorWrongRoomKeysVersion MatrixErrorCode = "M_WRONG_ROOM_KEYS_VERSION"
ErrorIncompatibleRoomVersion MatrixErrorCode = "M_INCOMPATIBLE_ROOM_VERSION"
ErrorUnsupportedRoomVersion MatrixErrorCode = "M_UNSUPPORTED_ROOM_VERSION"
ErrorLimitExceeded MatrixErrorCode = "M_LIMIT_EXCEEDED"
ErrorServerNotTrusted MatrixErrorCode = "M_SERVER_NOT_TRUSTED"
ErrorSessionNotValidated MatrixErrorCode = "M_SESSION_NOT_VALIDATED"
ErrorThreePIDInUse MatrixErrorCode = "M_THREEPID_IN_USE"
ErrorThreePIDAuthFailed MatrixErrorCode = "M_THREEPID_AUTH_FAILED"
)
// MatrixError represents the "standard error response" in Matrix.
// http://matrix.org/docs/spec/client_server/r0.2.0.html#api-standards
type MatrixError struct {
ErrCode MatrixErrorCode `json:"errcode"`
Err string `json:"error"`
}
func (e MatrixError) Error() string {
return fmt.Sprintf("%s: %s", e.ErrCode, e.Err)
}
func (e MatrixError) Unwrap() error {
return fmt.Errorf(e.Err)
}
// InternalServerError
type InternalServerError struct {
Err string
}
func (e InternalServerError) Error() string {
return fmt.Sprintf("Internal server error: %s", e.Err)
}
// Unknown is an unexpected error
func Unknown(msg string) MatrixError {
return MatrixError{ErrorUnknown, msg}
}
// Unrecognized is an error when the server received a request at
// an unexpected endpoint.
// nolint:misspell
func Unrecognized(msg string) MatrixError {
return MatrixError{ErrorUnrecognized, msg}
}
// Forbidden is an error when the client tries to access a resource
// they are not allowed to access.
func Forbidden(msg string) MatrixError {
return MatrixError{ErrorForbidden, msg}
}
// BadJSON is an error when the client supplies malformed JSON.
func BadJSON(msg string) MatrixError {
return MatrixError{ErrorBadJSON, msg}
}
// BadAlias is an error when the client supplies a bad alias.
func BadAlias(msg string) MatrixError {
return MatrixError{ErrorBadAlias, msg}
}
// NotJSON is an error when the client supplies something that is not JSON
// to a JSON endpoint.
func NotJSON(msg string) MatrixError {
return MatrixError{ErrorNotJSON, msg}
}
// NotFound is an error when the client tries to access an unknown resource.
func NotFound(msg string) MatrixError {
return MatrixError{ErrorNotFound, msg}
}
// MissingToken is an error when the client tries to access a resource which
// requires authentication without supplying credentials.
func MissingToken(msg string) MatrixError {
return MatrixError{ErrorMissingToken, msg}
}
// UnknownToken is an error when the client tries to access a resource which
// requires authentication and supplies an unrecognised token
func UnknownToken(msg string) MatrixError {
return MatrixError{ErrorUnknownToken, msg}
}
// WeakPassword is an error which is returned when the client tries to register
// using a weak password. http://matrix.org/docs/spec/client_server/r0.2.0.html#password-based
func WeakPassword(msg string) MatrixError {
return MatrixError{ErrorWeakPassword, msg}
}
// InvalidUsername is an error returned when the client tries to register an
// invalid username
func InvalidUsername(msg string) MatrixError {
return MatrixError{ErrorInvalidUsername, msg}
}
// UserInUse is an error returned when the client tries to register an
// username that already exists
func UserInUse(msg string) MatrixError {
return MatrixError{ErrorUserInUse, msg}
}
// RoomInUse is an error returned when the client tries to make a room
// that already exists
func RoomInUse(msg string) MatrixError {
return MatrixError{ErrorRoomInUse, msg}
}
// ASExclusive is an error returned when an application service tries to
// register an username that is outside of its registered namespace, or if a
// user attempts to register a username or room alias within an exclusive
// namespace.
func ASExclusive(msg string) MatrixError {
return MatrixError{ErrorExclusive, msg}
}
// GuestAccessForbidden is an error which is returned when the client is
// forbidden from accessing a resource as a guest.
func GuestAccessForbidden(msg string) MatrixError {
return MatrixError{ErrorGuestAccessForbidden, msg}
}
// InvalidSignature is an error which is returned when the client tries
// to upload invalid signatures.
func InvalidSignature(msg string) MatrixError {
return MatrixError{ErrorInvalidSignature, msg}
}
// InvalidParam is an error that is returned when a parameter has the wrong
// value or type.
func InvalidParam(msg string) MatrixError {
return MatrixError{ErrorInvalidParam, msg}
}
// MissingParam is an error that is returned when a parameter is missing from
// a request.
func MissingParam(msg string) MatrixError {
return MatrixError{ErrorMissingParam, msg}
}
// UnableToAuthoriseJoin is an error that is returned when a server can't
// determine whether to allow a restricted join or not.
func UnableToAuthoriseJoin(msg string) MatrixError {
return MatrixError{ErrorUnableToAuthoriseJoin, msg}
}
// LeaveServerNoticeError is an error returned when trying to reject an invite
// for a server notice room.
func LeaveServerNoticeError() MatrixError {
return MatrixError{
ErrCode: ErrorCannotLeaveServerNoticeRoom,
Err: "You cannot reject this invite",
}
}
// ErrRoomKeysVersion is an error returned by `PUT /room_keys/keys`
type ErrRoomKeysVersion struct {
MatrixError
CurrentVersion string `json:"current_version"`
}
func (e ErrRoomKeysVersion) Error() string {
return fmt.Sprintf("%s: %s", e.ErrCode, e.Err)
}
func (e ErrRoomKeysVersion) Unwrap() error {
return e.MatrixError
}
// WrongBackupVersionError is an error returned by `PUT /room_keys/keys`
func WrongBackupVersionError(currentVersion string) ErrRoomKeysVersion {
return ErrRoomKeysVersion{
MatrixError: MatrixError{
ErrCode: ErrorWrongRoomKeysVersion,
Err: "Wrong backup version.",
},
CurrentVersion: currentVersion,
}
}
type IncompatibleRoomVersionError struct {
MatrixError
RoomVersion string `json:"room_version"`
}
func (e IncompatibleRoomVersionError) Error() string {
return fmt.Sprintf("%s: %s", e.ErrCode, e.Err)
}
func (e IncompatibleRoomVersionError) Unwrap() error {
return fmt.Errorf(e.Err)
}
// IncompatibleRoomVersion is an error which is returned when the client
// requests a room with a version that is unsupported.
func IncompatibleRoomVersion(roomVersion string) IncompatibleRoomVersionError {
return IncompatibleRoomVersionError{
RoomVersion: roomVersion,
MatrixError: MatrixError{
ErrCode: ErrorIncompatibleRoomVersion,
Err: "Your homeserver does not support the features required to join this room",
},
}
}
// UnsupportedRoomVersion is an error which is returned when the client
// requests a room with a version that is unsupported.
func UnsupportedRoomVersion(msg string) MatrixError {
return MatrixError{ErrorUnsupportedRoomVersion, msg}
}
// LimitExceededError is a rate-limiting error.
type LimitExceededError struct {
MatrixError
RetryAfterMS int64 `json:"retry_after_ms,omitempty"`
}
func (e LimitExceededError) Error() string {
return fmt.Sprintf("%s: %s", e.ErrCode, e.Err)
}
func (e LimitExceededError) Unwrap() error {
return e.MatrixError
}
// LimitExceeded is an error when the client tries to send events too quickly.
func LimitExceeded(msg string, retryAfterMS int64) LimitExceededError {
return LimitExceededError{
MatrixError: MatrixError{ErrorLimitExceeded, msg},
RetryAfterMS: retryAfterMS,
}
}
// NotTrusted is an error which is returned when the client asks the server to
// proxy a request (e.g. 3PID association) to a server that isn't trusted
func NotTrusted(serverName string) MatrixError {
return MatrixError{
ErrCode: ErrorServerNotTrusted,
Err: fmt.Sprintf("Untrusted server '%s'", serverName),
}
}