Move outbound invite logic over to gmsl

go.mod

@@ -22,7 +22,7 @@ require (
 	github.com/matrix-org/dugong v0.0.0-20210921133753-66e6b1c67e2e
 	github.com/matrix-org/go-sqlite3-js v0.0.0-20220419092513-28aa791a1c91
 	github.com/matrix-org/gomatrix v0.0.0-20220926102614-ceba4d9f7530
-	github.com/matrix-org/gomatrixserverlib v0.0.0-20230523192120-6625ef2138d9
+	github.com/matrix-org/gomatrixserverlib v0.0.0-20230524040519-2b64a2fae808
 	github.com/matrix-org/pinecone v0.11.1-0.20230210171230-8c3b24f2649a
 	github.com/matrix-org/util v0.0.0-20221111132719-399730281e66
 	github.com/mattn/go-sqlite3 v1.14.16

go.sum

@@ -323,8 +323,8 @@ github.com/matrix-org/go-sqlite3-js v0.0.0-20220419092513-28aa791a1c91 h1:s7fexw
 github.com/matrix-org/go-sqlite3-js v0.0.0-20220419092513-28aa791a1c91/go.mod h1:e+cg2q7C7yE5QnAXgzo512tgFh1RbQLC0+jozuegKgo=
 github.com/matrix-org/gomatrix v0.0.0-20220926102614-ceba4d9f7530 h1:kHKxCOLcHH8r4Fzarl4+Y3K5hjothkVW5z7T1dUM11U=
 github.com/matrix-org/gomatrix v0.0.0-20220926102614-ceba4d9f7530/go.mod h1:/gBX06Kw0exX1HrwmoBibFA98yBk/jxKpGVeyQbff+s=
-github.com/matrix-org/gomatrixserverlib v0.0.0-20230523192120-6625ef2138d9 h1:A4hxCtYGBa9RKYlGejnYMhrBltISkc/AsdO2qRgf0O8=
+github.com/matrix-org/gomatrixserverlib v0.0.0-20230524040519-2b64a2fae808 h1:71+KiT2O0AVk+Gb/SeFhs/gN9VHexGkEgYPR3soSDvo=
-github.com/matrix-org/gomatrixserverlib v0.0.0-20230523192120-6625ef2138d9/go.mod h1:H9V9N3Uqn1bBJqYJNGK1noqtgJTaCEhtTdcH/mp50uU=
+github.com/matrix-org/gomatrixserverlib v0.0.0-20230524040519-2b64a2fae808/go.mod h1:H9V9N3Uqn1bBJqYJNGK1noqtgJTaCEhtTdcH/mp50uU=
 github.com/matrix-org/pinecone v0.11.1-0.20230210171230-8c3b24f2649a h1:awrPDf9LEFySxTLKYBMCiObelNx/cBuv/wzllvCCH3A=
 github.com/matrix-org/pinecone v0.11.1-0.20230210171230-8c3b24f2649a/go.mod h1:HchJX9oKMXaT2xYFs0Ha/6Zs06mxLU8k6F1ODnrGkeQ=
 github.com/matrix-org/util v0.0.0-20221111132719-399730281e66 h1:6z4KxomXSIGWqhHcfzExgkH3Z3UkIXry4ibJS4Aqz2Y=

roomserver/internal/perform/perform_invite.go

@@ -30,7 +30,6 @@ import (
 	"github.com/matrix-org/gomatrixserverlib"
 	"github.com/matrix-org/gomatrixserverlib/spec"
 	"github.com/matrix-org/util"
-	log "github.com/sirupsen/logrus"
 )
 
 type Inviter struct {
@@ -147,7 +146,7 @@ func (r *Inviter) PerformInvite(
 		return err
 	}
 
-	input := PerformInviteInput{
+	input := gomatrixserverlib.PerformInviteInput{
 		Context:               ctx,
 		RoomID:                *validRoomID,
 		Event:                 event.PDU,
@@ -158,8 +157,14 @@ func (r *Inviter) PerformInvite(
 		StateQuerier:          &QueryState{r.DB},
 		GenerateStrippedState: r.GenerateInviteStrippedState,
 	}
-	inviteEvent, err := PerformInvite(input, r.FSAPI)
+	inviteEvent, err := gomatrixserverlib.PerformInvite(input, r.FSAPI)
 	if err != nil {
+		switch e := err.(type) {
+		case spec.MatrixError:
+			if e.ErrCode == spec.ErrorForbidden {
+				return api.ErrNotAllowed{Err: fmt.Errorf("%s", e.Err)}
+			}
+		}
 		return err
 	}
 
@@ -193,147 +198,3 @@ func (r *Inviter) PerformInvite(
 
 	return nil
 }
-
-// TODO: Move to gmsl
-
-type StateQuerier interface {
-	GetAuthEvents(ctx context.Context, event gomatrixserverlib.PDU) (gomatrixserverlib.AuthEventProvider, error)
-}
-
-type PerformInviteInput struct {
-	Context               context.Context
-	RoomID                spec.RoomID
-	Event                 gomatrixserverlib.PDU
-	InvitedUser           spec.UserID
-	IsTargetLocal         bool
-	StrippedState         []gomatrixserverlib.InviteStrippedState
-	MembershipQuerier     gomatrixserverlib.MembershipQuerier
-	StateQuerier          StateQuerier
-	GenerateStrippedState func(ctx context.Context, roomID spec.RoomID, stateWanted []gomatrixserverlib.StateKeyTuple, inviteEvent gomatrixserverlib.PDU) ([]gomatrixserverlib.InviteStrippedState, error)
-}
-
-type FederatedInviteClient interface {
-	SendInvite(ctx context.Context, event gomatrixserverlib.PDU, strippedState []gomatrixserverlib.InviteStrippedState) (gomatrixserverlib.PDU, error)
-}
-
-func PerformInvite(input PerformInviteInput, fedClient FederatedInviteClient) (gomatrixserverlib.PDU, error) {
-	inviteState := input.StrippedState
-	if len(inviteState) == 0 {
-		// "If they are set on the room, at least the state for m.room.avatar, m.room.canonical_alias, m.room.join_rules, and m.room.name SHOULD be included."
-		// https://matrix.org/docs/spec/client_server/r0.6.0#m-room-member
-		stateWanted := []gomatrixserverlib.StateKeyTuple{}
-		for _, t := range []string{
-			spec.MRoomName, spec.MRoomCanonicalAlias,
-			spec.MRoomJoinRules, spec.MRoomAvatar,
-			spec.MRoomEncryption, spec.MRoomCreate,
-		} {
-			stateWanted = append(stateWanted, gomatrixserverlib.StateKeyTuple{
-				EventType: t,
-				StateKey:  "",
-			})
-		}
-		if is, generateErr := input.GenerateStrippedState(input.Context, input.RoomID, stateWanted, input.Event); generateErr == nil {
-			inviteState = is
-		} else {
-			util.GetLogger(input.Context).WithError(generateErr).Error("failed querying known room")
-			return nil, spec.InternalServerError{}
-		}
-	}
-
-	logger := util.GetLogger(input.Context).WithFields(map[string]interface{}{
-		"inviter":  input.Event.Sender(),
-		"invitee":  *input.Event.StateKey(),
-		"room_id":  input.RoomID.String(),
-		"event_id": input.Event.EventID(),
-	})
-	logger.WithFields(log.Fields{
-		"room_version": input.Event.Version(),
-		"target_local": input.IsTargetLocal,
-		"origin_local": true,
-	}).Debug("processing invite event")
-
-	if len(inviteState) == 0 {
-		if err := input.Event.SetUnsignedField("invite_room_state", struct{}{}); err != nil {
-			return nil, fmt.Errorf("event.SetUnsignedField: %w", err)
-		}
-	} else {
-		if err := input.Event.SetUnsignedField("invite_room_state", inviteState); err != nil {
-			return nil, fmt.Errorf("event.SetUnsignedField: %w", err)
-		}
-	}
-
-	membership, err := input.MembershipQuerier.CurrentMembership(input.Context, input.RoomID, input.InvitedUser)
-	if err != nil {
-		util.GetLogger(input.Context).WithError(err).Error("failed getting user membership")
-		return nil, spec.InternalServerError{}
-
-	}
-	isAlreadyJoined := (membership == spec.Join)
-
-	if isAlreadyJoined {
-		// If the user is joined to the room then that takes precedence over this
-		// invite event. It makes little sense to move a user that is already
-		// joined to the room into the invite state.
-		// This could plausibly happen if an invite request raced with a join
-		// request for a user. For example if a user was invited to a public
-		// room and they joined the room at the same time as the invite was sent.
-		// The other way this could plausibly happen is if an invite raced with
-		// a kick. For example if a user was kicked from a room in error and in
-		// response someone else in the room re-invited them then it is possible
-		// for the invite request to race with the leave event so that the
-		// target receives invite before it learns that it has been kicked.
-		// There are a few ways this could be plausibly handled in the roomserver.
-		// 1) Store the invite, but mark it as retired. That will result in the
-		//    permanent rejection of that invite event. So even if the target
-		//    user leaves the room and the invite is retransmitted it will be
-		//    ignored. However a new invite with a new event ID would still be
-		//    accepted.
-		// 2) Silently discard the invite event. This means that if the event
-		//    was retransmitted at a later date after the target user had left
-		//    the room we would accept the invite. However since we hadn't told
-		//    the sending server that the invite had been discarded it would
-		//    have no reason to attempt to retry.
-		// 3) Signal the sending server that the user is already joined to the
-		//    room.
-		// For now we will implement option 2. Since in the abesence of a retry
-		// mechanism it will be equivalent to option 1, and we don't have a
-		// signalling mechanism to implement option 3.
-		logger.Debugf("user already joined")
-		return nil, api.ErrNotAllowed{Err: fmt.Errorf("user is already joined to room")}
-	}
-
-	// The invite originated locally. Therefore we have a responsibility to
-	// try and see if the user is allowed to make this invite. We can't do
-	// this for invites coming in over federation - we have to take those on
-	// trust.
-	authEventProvider, err := input.StateQuerier.GetAuthEvents(input.Context, input.Event)
-	if err != nil {
-		logger.WithError(err).WithField("event_id", input.Event.EventID()).WithField("auth_event_ids", input.Event.AuthEventIDs()).Error(
-			"ProcessInvite.getAuthEvents failed for event",
-		)
-		return nil, api.ErrNotAllowed{Err: err}
-	}
-
-	// Check if the event is allowed.
-	if err = gomatrixserverlib.Allowed(input.Event, authEventProvider); err != nil {
-		logger.WithError(err).WithField("event_id", input.Event.EventID()).WithField("auth_event_ids", input.Event.AuthEventIDs()).Error(
-			"ProcessInvite: event not allowed",
-		)
-		return nil, api.ErrNotAllowed{Err: err}
-	}
-
-	// If the target isn't local then we should try and send the invite
-	// over federation first. It might be that the remote user doesn't exist,
-	// in which case we can give up processing here.
-	var inviteEvent gomatrixserverlib.PDU
-	if !input.IsTargetLocal {
-		inviteEvent, err = fedClient.SendInvite(input.Context, input.Event, inviteState)
-		if err != nil {
-			logger.WithError(err).WithField("event_id", input.Event.EventID()).Error("fedClient.SendInvite failed")
-			return nil, api.ErrNotAllowed{Err: err}
-		}
-		logger.Debugf("Federated SendInvite success with event ID %s", input.Event.EventID())
-	}
-
-	return inviteEvent, nil
-}