2020-02-05 19:06:39 +01:00
|
|
|
// Copyright 2020 The Matrix.org Foundation C.I.C.
|
|
|
|
//
|
|
|
|
// 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.
|
|
|
|
|
2020-02-05 17:25:58 +01:00
|
|
|
package version
|
|
|
|
|
|
|
|
import (
|
2020-03-16 17:05:29 +01:00
|
|
|
"fmt"
|
2020-02-05 17:25:58 +01:00
|
|
|
|
2020-03-16 17:05:29 +01:00
|
|
|
"github.com/matrix-org/gomatrixserverlib"
|
2020-02-05 17:25:58 +01:00
|
|
|
)
|
|
|
|
|
2020-03-16 17:05:29 +01:00
|
|
|
// RoomVersions returns a map of all known room versions to this
|
|
|
|
// server.
|
2023-04-24 12:50:37 +02:00
|
|
|
func RoomVersions() map[gomatrixserverlib.RoomVersion]gomatrixserverlib.IRoomVersion {
|
2020-06-02 17:20:50 +02:00
|
|
|
return gomatrixserverlib.RoomVersions()
|
2020-02-05 17:25:58 +01:00
|
|
|
}
|
|
|
|
|
2020-03-16 17:05:29 +01:00
|
|
|
// SupportedRoomVersions returns a map of descriptions for room
|
|
|
|
// versions that are supported by this homeserver.
|
2023-04-24 12:50:37 +02:00
|
|
|
func SupportedRoomVersions() map[gomatrixserverlib.RoomVersion]gomatrixserverlib.IRoomVersion {
|
2023-04-21 18:06:29 +02:00
|
|
|
return gomatrixserverlib.RoomVersions()
|
2020-02-05 17:25:58 +01:00
|
|
|
}
|
|
|
|
|
2020-03-16 17:05:29 +01:00
|
|
|
// RoomVersion returns information about a specific room version.
|
|
|
|
// An UnknownVersionError is returned if the version is not known
|
|
|
|
// to the server.
|
2023-04-24 12:50:37 +02:00
|
|
|
func RoomVersion(version gomatrixserverlib.RoomVersion) (gomatrixserverlib.IRoomVersion, error) {
|
2020-06-02 17:20:50 +02:00
|
|
|
if version, ok := gomatrixserverlib.RoomVersions()[version]; ok {
|
2020-03-16 17:05:29 +01:00
|
|
|
return version, nil
|
|
|
|
}
|
2023-04-24 12:50:37 +02:00
|
|
|
return nil, UnknownVersionError{version}
|
2020-03-16 17:05:29 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// SupportedRoomVersion returns information about a specific room
|
|
|
|
// version. An UnknownVersionError is returned if the version is not
|
|
|
|
// known to the server, or an UnsupportedVersionError is returned if
|
|
|
|
// the version is known but specifically marked as unsupported.
|
2023-04-24 12:50:37 +02:00
|
|
|
func SupportedRoomVersion(version gomatrixserverlib.RoomVersion) (gomatrixserverlib.IRoomVersion, error) {
|
2023-04-21 18:06:29 +02:00
|
|
|
return RoomVersion(version)
|
2020-03-16 17:05:29 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// UnknownVersionError is caused when the room version is not known.
|
|
|
|
type UnknownVersionError struct {
|
|
|
|
Version gomatrixserverlib.RoomVersion
|
|
|
|
}
|
|
|
|
|
|
|
|
func (e UnknownVersionError) Error() string {
|
|
|
|
return fmt.Sprintf("room version '%s' is not known", e.Version)
|
|
|
|
}
|
|
|
|
|
|
|
|
// UnsupportedVersionError is caused when the room version is specifically
|
|
|
|
// marked as unsupported.
|
|
|
|
type UnsupportedVersionError struct {
|
|
|
|
Version gomatrixserverlib.RoomVersion
|
|
|
|
}
|
|
|
|
|
|
|
|
func (e UnsupportedVersionError) Error() string {
|
|
|
|
return fmt.Sprintf("room version '%s' is marked as unsupported", e.Version)
|
2020-02-05 17:25:58 +01:00
|
|
|
}
|