2020-06-10 11:17:54 +00:00
|
|
|
// Copyright 2020 The Matrix.org Foundation C.I.C.
|
2017-04-20 22:40: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.
|
|
|
|
|
2020-06-10 11:17:54 +00:00
|
|
|
package api
|
2017-03-15 13:36:26 +00:00
|
|
|
|
|
|
|
import (
|
2017-09-13 12:37:50 +00:00
|
|
|
"context"
|
|
|
|
|
2017-03-15 13:36:26 +00:00
|
|
|
"github.com/matrix-org/gomatrixserverlib"
|
2020-07-03 16:24:51 +00:00
|
|
|
"github.com/matrix-org/util"
|
2017-03-15 13:36:26 +00:00
|
|
|
)
|
|
|
|
|
2020-06-10 11:17:54 +00:00
|
|
|
// SendEvents to the roomserver The events are written with KindNew.
|
|
|
|
func SendEvents(
|
2022-05-05 12:17:38 +00:00
|
|
|
ctx context.Context, rsAPI InputRoomEventsAPI,
|
2020-11-16 15:44:53 +00:00
|
|
|
kind Kind, events []*gomatrixserverlib.HeaderedEvent,
|
2022-01-27 14:29:14 +00:00
|
|
|
origin gomatrixserverlib.ServerName,
|
2020-06-10 11:17:54 +00:00
|
|
|
sendAsServer gomatrixserverlib.ServerName, txnID *TransactionID,
|
2022-01-05 17:44:49 +00:00
|
|
|
async bool,
|
2020-09-03 14:22:16 +00:00
|
|
|
) error {
|
2020-06-10 11:17:54 +00:00
|
|
|
ires := make([]InputRoomEvent, len(events))
|
2017-05-25 15:08:28 +00:00
|
|
|
for i, event := range events {
|
2020-06-10 11:17:54 +00:00
|
|
|
ires[i] = InputRoomEvent{
|
2020-10-19 13:59:13 +00:00
|
|
|
Kind: kind,
|
2020-03-27 16:28:22 +00:00
|
|
|
Event: event,
|
2022-01-27 14:29:14 +00:00
|
|
|
Origin: origin,
|
2017-12-04 18:07:52 +00:00
|
|
|
SendAsServer: string(sendAsServer),
|
|
|
|
TransactionID: txnID,
|
2017-03-15 13:36:26 +00:00
|
|
|
}
|
|
|
|
}
|
2022-01-05 17:44:49 +00:00
|
|
|
return SendInputRoomEvents(ctx, rsAPI, ires, async)
|
2017-03-15 13:36:26 +00:00
|
|
|
}
|
|
|
|
|
2020-10-19 13:59:13 +00:00
|
|
|
// SendEventWithState writes an event with the specified kind to the roomserver
|
2020-05-06 17:03:25 +00:00
|
|
|
// with the state at the event as KindOutlier before it. Will not send any event that is
|
2021-01-22 14:55:08 +00:00
|
|
|
// marked as `true` in haveEventIDs.
|
2020-06-10 11:17:54 +00:00
|
|
|
func SendEventWithState(
|
2022-05-05 12:17:38 +00:00
|
|
|
ctx context.Context, rsAPI InputRoomEventsAPI, kind Kind,
|
2020-11-16 15:44:53 +00:00
|
|
|
state *gomatrixserverlib.RespState, event *gomatrixserverlib.HeaderedEvent,
|
2022-01-27 14:29:14 +00:00
|
|
|
origin gomatrixserverlib.ServerName, haveEventIDs map[string]bool, async bool,
|
2017-09-13 12:37:50 +00:00
|
|
|
) error {
|
2022-02-28 14:51:40 +00:00
|
|
|
outliers := state.Events(event.RoomVersion)
|
|
|
|
ires := make([]InputRoomEvent, 0, len(outliers))
|
2020-03-27 16:28:22 +00:00
|
|
|
for _, outlier := range outliers {
|
2020-05-06 17:03:25 +00:00
|
|
|
if haveEventIDs[outlier.EventID()] {
|
|
|
|
continue
|
|
|
|
}
|
2020-06-10 11:17:54 +00:00
|
|
|
ires = append(ires, InputRoomEvent{
|
2022-01-27 14:29:14 +00:00
|
|
|
Kind: KindOutlier,
|
|
|
|
Event: outlier.Headered(event.RoomVersion),
|
|
|
|
Origin: origin,
|
2020-03-27 16:28:22 +00:00
|
|
|
})
|
2017-05-25 15:08:28 +00:00
|
|
|
}
|
|
|
|
|
2022-02-09 20:31:24 +00:00
|
|
|
stateEvents := state.StateEvents.UntrustedEvents(event.RoomVersion)
|
|
|
|
stateEventIDs := make([]string, len(stateEvents))
|
|
|
|
for i := range stateEvents {
|
|
|
|
stateEventIDs[i] = stateEvents[i].EventID()
|
2017-05-25 15:08:28 +00:00
|
|
|
}
|
|
|
|
|
2020-06-10 11:17:54 +00:00
|
|
|
ires = append(ires, InputRoomEvent{
|
2020-10-19 13:59:13 +00:00
|
|
|
Kind: kind,
|
2020-03-27 16:28:22 +00:00
|
|
|
Event: event,
|
2022-01-27 14:29:14 +00:00
|
|
|
Origin: origin,
|
2017-05-25 15:08:28 +00:00
|
|
|
HasState: true,
|
|
|
|
StateEventIDs: stateEventIDs,
|
2020-03-27 16:28:22 +00:00
|
|
|
})
|
2017-05-25 15:08:28 +00:00
|
|
|
|
2022-01-05 17:44:49 +00:00
|
|
|
return SendInputRoomEvents(ctx, rsAPI, ires, async)
|
2017-05-25 15:08:28 +00:00
|
|
|
}
|
|
|
|
|
2020-06-10 11:17:54 +00:00
|
|
|
// SendInputRoomEvents to the roomserver.
|
|
|
|
func SendInputRoomEvents(
|
2022-05-05 12:17:38 +00:00
|
|
|
ctx context.Context, rsAPI InputRoomEventsAPI,
|
2022-01-05 17:44:49 +00:00
|
|
|
ires []InputRoomEvent, async bool,
|
2020-09-03 14:22:16 +00:00
|
|
|
) error {
|
2022-01-05 17:44:49 +00:00
|
|
|
request := InputRoomEventsRequest{
|
|
|
|
InputRoomEvents: ires,
|
|
|
|
Asynchronous: async,
|
|
|
|
}
|
2020-06-10 11:17:54 +00:00
|
|
|
var response InputRoomEventsResponse
|
2020-09-16 12:00:52 +00:00
|
|
|
rsAPI.InputRoomEvents(ctx, &request, &response)
|
|
|
|
return response.Err()
|
2017-03-15 13:36:26 +00:00
|
|
|
}
|
2017-08-23 14:13:47 +00:00
|
|
|
|
2020-07-03 16:24:51 +00:00
|
|
|
// GetEvent returns the event or nil, even on errors.
|
2022-05-05 12:17:38 +00:00
|
|
|
func GetEvent(ctx context.Context, rsAPI QueryEventsAPI, eventID string) *gomatrixserverlib.HeaderedEvent {
|
2020-07-03 16:24:51 +00:00
|
|
|
var res QueryEventsByIDResponse
|
|
|
|
err := rsAPI.QueryEventsByID(ctx, &QueryEventsByIDRequest{
|
|
|
|
EventIDs: []string{eventID},
|
|
|
|
}, &res)
|
|
|
|
if err != nil {
|
|
|
|
util.GetLogger(ctx).WithError(err).Error("Failed to QueryEventsByID")
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
if len(res.Events) != 1 {
|
|
|
|
return nil
|
|
|
|
}
|
2020-11-16 15:44:53 +00:00
|
|
|
return res.Events[0]
|
2020-07-03 16:24:51 +00:00
|
|
|
}
|
2020-09-03 16:20:54 +00:00
|
|
|
|
|
|
|
// GetStateEvent returns the current state event in the room or nil.
|
2022-05-05 12:17:38 +00:00
|
|
|
func GetStateEvent(ctx context.Context, rsAPI QueryEventsAPI, roomID string, tuple gomatrixserverlib.StateKeyTuple) *gomatrixserverlib.HeaderedEvent {
|
2020-09-03 16:20:54 +00:00
|
|
|
var res QueryCurrentStateResponse
|
|
|
|
err := rsAPI.QueryCurrentState(ctx, &QueryCurrentStateRequest{
|
|
|
|
RoomID: roomID,
|
|
|
|
StateTuples: []gomatrixserverlib.StateKeyTuple{tuple},
|
|
|
|
}, &res)
|
|
|
|
if err != nil {
|
|
|
|
util.GetLogger(ctx).WithError(err).Error("Failed to QueryCurrentState")
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
ev, ok := res.StateEvents[tuple]
|
|
|
|
if ok {
|
|
|
|
return ev
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// IsServerBannedFromRoom returns whether the server is banned from a room by server ACLs.
|
2022-05-05 18:30:38 +00:00
|
|
|
func IsServerBannedFromRoom(ctx context.Context, rsAPI FederationRoomserverAPI, roomID string, serverName gomatrixserverlib.ServerName) bool {
|
2020-09-03 16:20:54 +00:00
|
|
|
req := &QueryServerBannedFromRoomRequest{
|
|
|
|
ServerName: serverName,
|
|
|
|
RoomID: roomID,
|
|
|
|
}
|
|
|
|
res := &QueryServerBannedFromRoomResponse{}
|
|
|
|
if err := rsAPI.QueryServerBannedFromRoom(ctx, req, res); err != nil {
|
|
|
|
util.GetLogger(ctx).WithError(err).Error("Failed to QueryServerBannedFromRoom")
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
return res.Banned
|
|
|
|
}
|
|
|
|
|
|
|
|
// PopulatePublicRooms extracts PublicRoom information for all the provided room IDs. The IDs are not checked to see if they are visible in the
|
|
|
|
// published room directory.
|
|
|
|
// due to lots of switches
|
2022-05-05 12:17:38 +00:00
|
|
|
func PopulatePublicRooms(ctx context.Context, roomIDs []string, rsAPI QueryBulkStateContentAPI) ([]gomatrixserverlib.PublicRoom, error) {
|
2020-09-03 16:20:54 +00:00
|
|
|
avatarTuple := gomatrixserverlib.StateKeyTuple{EventType: "m.room.avatar", StateKey: ""}
|
|
|
|
nameTuple := gomatrixserverlib.StateKeyTuple{EventType: "m.room.name", StateKey: ""}
|
|
|
|
canonicalTuple := gomatrixserverlib.StateKeyTuple{EventType: gomatrixserverlib.MRoomCanonicalAlias, StateKey: ""}
|
|
|
|
topicTuple := gomatrixserverlib.StateKeyTuple{EventType: "m.room.topic", StateKey: ""}
|
|
|
|
guestTuple := gomatrixserverlib.StateKeyTuple{EventType: "m.room.guest_access", StateKey: ""}
|
|
|
|
visibilityTuple := gomatrixserverlib.StateKeyTuple{EventType: gomatrixserverlib.MRoomHistoryVisibility, StateKey: ""}
|
|
|
|
joinRuleTuple := gomatrixserverlib.StateKeyTuple{EventType: gomatrixserverlib.MRoomJoinRules, StateKey: ""}
|
|
|
|
|
|
|
|
var stateRes QueryBulkStateContentResponse
|
|
|
|
err := rsAPI.QueryBulkStateContent(ctx, &QueryBulkStateContentRequest{
|
|
|
|
RoomIDs: roomIDs,
|
|
|
|
AllowWildcards: true,
|
|
|
|
StateTuples: []gomatrixserverlib.StateKeyTuple{
|
|
|
|
nameTuple, canonicalTuple, topicTuple, guestTuple, visibilityTuple, joinRuleTuple, avatarTuple,
|
|
|
|
{EventType: gomatrixserverlib.MRoomMember, StateKey: "*"},
|
|
|
|
},
|
|
|
|
}, &stateRes)
|
|
|
|
if err != nil {
|
|
|
|
util.GetLogger(ctx).WithError(err).Error("QueryBulkStateContent failed")
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
chunk := make([]gomatrixserverlib.PublicRoom, len(roomIDs))
|
|
|
|
i := 0
|
|
|
|
for roomID, data := range stateRes.Rooms {
|
|
|
|
pub := gomatrixserverlib.PublicRoom{
|
|
|
|
RoomID: roomID,
|
|
|
|
}
|
|
|
|
joinCount := 0
|
|
|
|
var joinRule, guestAccess string
|
|
|
|
for tuple, contentVal := range data {
|
|
|
|
if tuple.EventType == gomatrixserverlib.MRoomMember && contentVal == "join" {
|
|
|
|
joinCount++
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
switch tuple {
|
|
|
|
case avatarTuple:
|
|
|
|
pub.AvatarURL = contentVal
|
|
|
|
case nameTuple:
|
|
|
|
pub.Name = contentVal
|
|
|
|
case topicTuple:
|
|
|
|
pub.Topic = contentVal
|
|
|
|
case canonicalTuple:
|
2021-08-27 15:50:30 +00:00
|
|
|
if _, _, err := gomatrixserverlib.SplitID('#', contentVal); err == nil {
|
|
|
|
pub.CanonicalAlias = contentVal
|
|
|
|
}
|
2020-09-03 16:20:54 +00:00
|
|
|
case visibilityTuple:
|
|
|
|
pub.WorldReadable = contentVal == "world_readable"
|
|
|
|
// need both of these to determine whether guests can join
|
|
|
|
case joinRuleTuple:
|
|
|
|
joinRule = contentVal
|
|
|
|
case guestTuple:
|
|
|
|
guestAccess = contentVal
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if joinRule == gomatrixserverlib.Public && guestAccess == "can_join" {
|
|
|
|
pub.GuestCanJoin = true
|
|
|
|
}
|
|
|
|
pub.JoinedMembersCount = joinCount
|
|
|
|
chunk[i] = pub
|
|
|
|
i++
|
|
|
|
}
|
|
|
|
return chunk, nil
|
|
|
|
}
|