Simplify getting the required events

This commit is contained in:
Till Faelligen 2022-02-21 09:39:41 +01:00
parent 2a215e3fec
commit 2c80586360
2 changed files with 66 additions and 157 deletions

View file

@ -15,7 +15,6 @@
package routing package routing
import ( import (
"context"
"database/sql" "database/sql"
"encoding/json" "encoding/json"
"net/http" "net/http"
@ -45,7 +44,7 @@ func Context(
syncDB storage.Database, syncDB storage.Database,
roomID, eventID string, roomID, eventID string,
) util.JSONResponse { ) util.JSONResponse {
limit, filter, err := parseContextParams(req) filter, err := parseContextParams(req)
if err != nil { if err != nil {
errMsg := "" errMsg := ""
switch err.(type) { switch err.(type) {
@ -60,6 +59,8 @@ func Context(
Headers: nil, Headers: nil,
} }
} }
filter.Rooms = append(filter.Rooms, roomID)
ctx := req.Context() ctx := req.Context()
membershipRes := roomserver.QueryMembershipForUserResponse{} membershipRes := roomserver.QueryMembershipForUserResponse{}
membershipReq := roomserver.QueryMembershipForUserRequest{UserID: device.UserID, RoomID: roomID} membershipReq := roomserver.QueryMembershipForUserRequest{UserID: device.UserID, RoomID: roomID}
@ -68,43 +69,7 @@ func Context(
return jsonerror.InternalServerError() return jsonerror.InternalServerError()
} }
state, userAllowed, err := getCurrentState(ctx, rsAPI, roomID, device.UserID) stateFilter := gomatrixserverlib.StateFilter{
if err != nil {
return jsonerror.InternalServerError()
}
if !userAllowed {
return util.JSONResponse{
Code: http.StatusForbidden,
JSON: jsonerror.Forbidden("User is not allowed to query contenxt"),
}
}
id, requestedEvent, err := syncDB.SelectContextEvent(ctx, roomID, eventID)
if err != nil {
logrus.WithError(err).WithField("eventID", eventID).Error("unable to find requested event")
return jsonerror.InternalServerError()
}
eventsBefore, err := syncDB.SelectContextBeforeEvent(ctx, id, roomID, limit/2)
if err != nil && err != sql.ErrNoRows {
logrus.WithError(err).Error("unable to fetch before events")
return jsonerror.InternalServerError()
}
_, eventsAfter, err := syncDB.SelectContextAfterEvent(ctx, id, roomID, limit/2)
if err != nil && err != sql.ErrNoRows {
logrus.WithError(err).Error("unable to fetch after events")
return jsonerror.InternalServerError()
}
/*excludeEventIDs, err := syncDB.SelectEventIDsAfter(ctx, roomID, lastID)
if err != nil {
logrus.WithError(err).Error("unable to fetch excludeEventIDs")
return jsonerror.InternalServerError()
}
stateFilter := gomatrixserverlib.StateFilter{Limit: 100, Rooms: []string{roomID}}
if filter != nil {
stateFilter = gomatrixserverlib.StateFilter{
Limit: filter.Limit, Limit: filter.Limit,
NotSenders: filter.NotSenders, NotSenders: filter.NotSenders,
NotTypes: filter.NotTypes, NotTypes: filter.NotTypes,
@ -116,18 +81,15 @@ func Context(
Rooms: filter.Rooms, Rooms: filter.Rooms,
ContainsURL: filter.ContainsURL, ContainsURL: filter.ContainsURL,
} }
}
_ = stateFilter
_ = excludeEventIDs
sstate, _ := syncDB.CurrentState(ctx, roomID, &stateFilter, nil) state, _ := syncDB.CurrentState(ctx, roomID, &stateFilter, nil)
for _, x := range sstate { // verify the user is allowed to see the context for this room/event
for _, x := range state {
hisVis, err := x.HistoryVisibility() hisVis, err := x.HistoryVisibility()
if err != nil { if err != nil {
continue continue
} }
allowed := hisVis != "world_readable" && membershipRes.Membership == "join" allowed := hisVis != "world_readable" && membershipRes.Membership == "join"
logrus.Debugf("State: %+v %+v %+v", x.Type(), hisVis, allowed)
if !allowed { if !allowed {
return util.JSONResponse{ return util.JSONResponse{
Code: http.StatusForbidden, Code: http.StatusForbidden,
@ -135,7 +97,24 @@ func Context(
} }
} }
} }
*/
id, requestedEvent, err := syncDB.SelectContextEvent(ctx, roomID, eventID)
if err != nil {
logrus.WithError(err).WithField("eventID", eventID).Error("unable to find requested event")
return jsonerror.InternalServerError()
}
eventsBefore, err := syncDB.SelectContextBeforeEvent(ctx, id, roomID, filter.Limit/2)
if err != nil && err != sql.ErrNoRows {
logrus.WithError(err).Error("unable to fetch before events")
return jsonerror.InternalServerError()
}
_, eventsAfter, err := syncDB.SelectContextAfterEvent(ctx, id, roomID, filter.Limit/2)
if err != nil && err != sql.ErrNoRows {
logrus.WithError(err).Error("unable to fetch after events")
return jsonerror.InternalServerError()
}
eventsBeforeClient := gomatrixserverlib.HeaderedToClientEvents(eventsBefore, gomatrixserverlib.FormatAll) eventsBeforeClient := gomatrixserverlib.HeaderedToClientEvents(eventsBefore, gomatrixserverlib.FormatAll)
eventsAfterClient := gomatrixserverlib.HeaderedToClientEvents(eventsAfter, gomatrixserverlib.FormatAll) eventsAfterClient := gomatrixserverlib.HeaderedToClientEvents(eventsAfter, gomatrixserverlib.FormatAll)
@ -147,7 +126,7 @@ func Context(
EventsAfter: eventsAfterClient, EventsAfter: eventsAfterClient,
EventsBefore: eventsBeforeClient, EventsBefore: eventsBeforeClient,
Start: "start", Start: "start",
State: newState, State: gomatrixserverlib.HeaderedToClientEvents(newState, gomatrixserverlib.FormatAll),
} }
return util.JSONResponse{ return util.JSONResponse{
@ -156,118 +135,53 @@ func Context(
} }
} }
func applyLazyLoadMembers(filter *gomatrixserverlib.RoomEventFilter, eventsAfter, eventsBefore []gomatrixserverlib.ClientEvent, state []gomatrixserverlib.ClientEvent) []gomatrixserverlib.ClientEvent { func applyLazyLoadMembers(filter *gomatrixserverlib.RoomEventFilter, eventsAfter, eventsBefore []gomatrixserverlib.ClientEvent, state []*gomatrixserverlib.HeaderedEvent) []*gomatrixserverlib.HeaderedEvent {
if filter == nil || !filter.LazyLoadMembers { if filter == nil || !filter.LazyLoadMembers {
logrus.Debugf("filter is nil or lazyloadmembers is false")
return state return state
} }
allEvents := append(eventsAfter, eventsBefore...) allEvents := append(eventsAfter, eventsBefore...)
x := make(map[string]bool) x := make(map[string]bool)
// get members who actually send an event // get members who actually send an event
for _, e := range allEvents { for _, e := range allEvents {
if filter.LazyLoadMembers {
x[e.Sender] = true x[e.Sender] = true
} }
}
// apply lazy_load_members
if filter.LazyLoadMembers {
newState := []gomatrixserverlib.ClientEvent{}
newState := []*gomatrixserverlib.HeaderedEvent{}
for _, event := range state { for _, event := range state {
if event.Type != gomatrixserverlib.MRoomMember { if event.Type() != gomatrixserverlib.MRoomMember {
newState = append(newState, event) newState = append(newState, event)
} else { } else {
// did the user send an event? // did the user send an event?
if x[event.Sender] { if x[event.Sender()] {
newState = append(newState, event) newState = append(newState, event)
} }
} }
} }
return newState return newState
}
return state
} }
// getCurrentState returns the current state of the requested room func parseContextParams(req *http.Request) (*gomatrixserverlib.RoomEventFilter, error) {
func getCurrentState(ctx context.Context, rsAPI roomserver.RoomserverInternalAPI, roomID, userID string) (events []gomatrixserverlib.ClientEvent, userAllowed bool, err error) { // Default room filter
filter := &gomatrixserverlib.RoomEventFilter{Limit: 10}
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: ""}
// get the current state
currentState := &roomserver.QueryCurrentStateResponse{}
if err := rsAPI.QueryCurrentState(ctx, &roomserver.QueryCurrentStateRequest{
RoomID: roomID,
StateTuples: []gomatrixserverlib.StateKeyTuple{
avatarTuple, nameTuple, canonicalTuple, topicTuple, guestTuple, visibilityTuple, joinRuleTuple,
},
}, currentState); err != nil {
logrus.WithField("roomID", roomID).WithError(err).Error("unable to fetch current state")
return nil, true, err
}
// get all room members
roomMembers := roomserver.QueryMembershipsForRoomResponse{}
if err := rsAPI.QueryMembershipsForRoom(ctx, &roomserver.QueryMembershipsForRoomRequest{
RoomID: roomID,
Sender: userID,
}, &roomMembers); err != nil {
logrus.WithField("roomID", roomID).WithError(err).Error("unable to fetch room members")
return nil, true, err
}
state := []gomatrixserverlib.ClientEvent{}
for _, ev := range roomMembers.JoinEvents {
state = append(state, ev)
}
membershipRes := roomserver.QueryMembershipForUserResponse{}
membershipReq := roomserver.QueryMembershipForUserRequest{UserID: userID, RoomID: roomID}
if err := rsAPI.QueryMembershipForUser(ctx, &membershipReq, &membershipRes); err != nil {
return nil, true, err
}
for tuple, event := range currentState.StateEvents {
// check that the user is allowed to view the context
if tuple == visibilityTuple {
hisVis, err := event.HistoryVisibility()
if err != nil {
return nil, true, err
}
allowed := hisVis != "world_readable" && membershipRes.Membership == "join"
if !allowed {
return nil, false, nil
}
}
state = append(state, gomatrixserverlib.HeaderedToClientEvent(event, gomatrixserverlib.FormatAll))
}
return state, true, nil
}
func parseContextParams(req *http.Request) (limit int, filter *gomatrixserverlib.RoomEventFilter, err error) {
l := req.URL.Query().Get("limit") l := req.URL.Query().Get("limit")
f := req.URL.Query().Get("filter") f := req.URL.Query().Get("filter")
limit = 10
if l != "" { if l != "" {
limit, err = strconv.Atoi(l) limit, err := strconv.Atoi(l)
if err != nil { if err != nil {
return 0, filter, err return nil, err
} }
// not in the spec, but feels like a good idea to have an upper bound limit // not in the spec, but feels like a good idea to have an upper bound limit
if limit > 100 { if limit > 100 {
limit = 100 limit = 100
} }
filter.Limit = limit
} }
if f != "" { if f != "" {
if err := json.Unmarshal([]byte(f), &filter); err != nil { if err := json.Unmarshal([]byte(f), &filter); err != nil {
return 0, filter, err return nil, err
} }
} }
return limit, filter, nil
return filter, nil
} }

View file

@ -19,30 +19,28 @@ func Test_parseContextParams(t *testing.T) {
tests := []struct { tests := []struct {
name string name string
req *http.Request req *http.Request
wantLimit int
wantFilter *gomatrixserverlib.RoomEventFilter wantFilter *gomatrixserverlib.RoomEventFilter
wantErr bool wantErr bool
}{ }{
{ {
name: "no params set", name: "no params set",
req: noParamsReq, req: noParamsReq,
wantLimit: 10, wantFilter: &gomatrixserverlib.RoomEventFilter{Limit: 10},
}, },
{ {
name: "limit 2 param set", name: "limit 2 param set",
req: limit2Req, req: limit2Req,
wantLimit: 2, wantFilter: &gomatrixserverlib.RoomEventFilter{Limit: 2},
}, },
{ {
name: "limit 10000 param set", name: "limit 10000 param set",
req: limit10000Req, req: limit10000Req,
wantLimit: 100, wantFilter: &gomatrixserverlib.RoomEventFilter{Limit: 100},
}, },
{ {
name: "filter lazy_load_members param set", name: "filter lazy_load_members param set",
req: lazyLoadReq, req: lazyLoadReq,
wantLimit: 2, wantFilter: &gomatrixserverlib.RoomEventFilter{Limit: 2, LazyLoadMembers: true},
wantFilter: &gomatrixserverlib.RoomEventFilter{LazyLoadMembers: true},
}, },
{ {
name: "invalid limit req", name: "invalid limit req",
@ -57,14 +55,11 @@ func Test_parseContextParams(t *testing.T) {
} }
for _, tt := range tests { for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) { t.Run(tt.name, func(t *testing.T) {
gotLimit, gotFilter, err := parseContextParams(tt.req) gotFilter, err := parseContextParams(tt.req)
if (err != nil) != tt.wantErr { if (err != nil) != tt.wantErr {
t.Errorf("parseContextParams() error = %v, wantErr %v", err, tt.wantErr) t.Errorf("parseContextParams() error = %v, wantErr %v", err, tt.wantErr)
return return
} }
if gotLimit != tt.wantLimit {
t.Errorf("parseContextParams() gotLimit = %v, want %v", gotLimit, tt.wantLimit)
}
if !reflect.DeepEqual(gotFilter, tt.wantFilter) { if !reflect.DeepEqual(gotFilter, tt.wantFilter) {
t.Errorf("parseContextParams() gotFilter = %v, want %v", gotFilter, tt.wantFilter) t.Errorf("parseContextParams() gotFilter = %v, want %v", gotFilter, tt.wantFilter)
} }