Enforce history visibility etc for /rooms/{roomID}/state (#1340)

* Enforce history visibility etc for /rooms/{roomID}/state

* Deduplicate OnIncomingStateRequest and OnIncomingStateTypeRequest

* Revert "Deduplicate OnIncomingStateRequest and OnIncomingStateTypeRequest"

This reverts commit 335035d66e629022232abc682d6631e3cf669e23.

clientapi/routing/routing.go

@@ -201,7 +201,7 @@ func Setup(
 		if err != nil {
 			return util.ErrorResponse(err)
 		}
-		return OnIncomingStateRequest(req.Context(), rsAPI, vars["roomID"])
+		return OnIncomingStateRequest(req.Context(), device, rsAPI, vars["roomID"])
 	})).Methods(http.MethodGet, http.MethodOptions)
 
 	r0mux.Handle("/rooms/{roomID}/state/{type:[^/]+/?}", httputil.MakeAuthAPI("room_state", userAPI, func(req *http.Request, device *userapi.Device) util.JSONResponse {

clientapi/routing/state.go

@@ -22,7 +22,6 @@ import (
 
 	"github.com/matrix-org/dendrite/clientapi/jsonerror"
 	"github.com/matrix-org/dendrite/roomserver/api"
-	"github.com/matrix-org/dendrite/syncapi/types"
 	userapi "github.com/matrix-org/dendrite/userapi/api"
 	"github.com/matrix-org/gomatrixserverlib"
 	"github.com/matrix-org/util"
@@ -42,57 +41,118 @@ type stateEventInStateResp struct {
 // TODO: Check if the user is in the room. If not, check if the room's history
 // is publicly visible. Current behaviour is returning an empty array if the
 // user cannot see the room's history.
-func OnIncomingStateRequest(ctx context.Context, rsAPI api.RoomserverInternalAPI, roomID string) util.JSONResponse {
+func OnIncomingStateRequest(ctx context.Context, device *userapi.Device, rsAPI api.RoomserverInternalAPI, roomID string) util.JSONResponse {
-	// TODO(#287): Auth request and handle the case where the user has left (where
+	var worldReadable bool
-	// we should return the state at the poin they left)
+	var wantLatestState bool
-	stateReq := api.QueryLatestEventsAndStateRequest{
-		RoomID: roomID,
-	}
-	stateRes := api.QueryLatestEventsAndStateResponse{}
 
-	if err := rsAPI.QueryLatestEventsAndState(ctx, &stateReq, &stateRes); err != nil {
+	// First of all, get the latest state of the room. We need to do this
+	// so that we can look at the history visibility of the room. If the
+	// room is world-readable then we will always return the latest state.
+	stateRes := api.QueryLatestEventsAndStateResponse{}
+	if err := rsAPI.QueryLatestEventsAndState(ctx, &api.QueryLatestEventsAndStateRequest{
+		RoomID:       roomID,
+		StateToFetch: []gomatrixserverlib.StateKeyTuple{},
+	}, &stateRes); err != nil {
 		util.GetLogger(ctx).WithError(err).Error("queryAPI.QueryLatestEventsAndState failed")
 		return jsonerror.InternalServerError()
 	}
 
-	if len(stateRes.StateEvents) == 0 {
+	// Look at the room state and see if we have a history visibility event
-		return util.JSONResponse{
+	// that marks the room as world-readable. If we don't then we assume that
-			Code: http.StatusNotFound,
+	// the room is not world-readable.
-			JSON: jsonerror.NotFound("cannot find state"),
+	for _, ev := range stateRes.StateEvents {
-		}
+		if ev.Type() == gomatrixserverlib.MRoomHistoryVisibility {
-	}
+			content := map[string]string{}
-
+			if err := json.Unmarshal(ev.Content(), &content); err != nil {
-	resp := []stateEventInStateResp{}
+				util.GetLogger(ctx).WithError(err).Error("json.Unmarshal for history visibility failed")
-	// Fill the prev_content and replaces_state keys if necessary
-	for _, event := range stateRes.StateEvents {
-		stateEvent := stateEventInStateResp{
-			ClientEvent: gomatrixserverlib.HeaderedToClientEvents(
-				[]gomatrixserverlib.HeaderedEvent{event}, gomatrixserverlib.FormatAll,
-			)[0],
-		}
-		var prevEventRef types.PrevEventRef
-		if len(event.Unsigned()) > 0 {
-			if err := json.Unmarshal(event.Unsigned(), &prevEventRef); err != nil {
-				util.GetLogger(ctx).WithError(err).Error("json.Unmarshal failed")
 				return jsonerror.InternalServerError()
 			}
-			// Fills the previous state event ID if the state event replaces another
+			if visibility, ok := content["history_visibility"]; ok {
-			// state event
+				worldReadable = visibility == "world_readable"
-			if len(prevEventRef.ReplacesState) > 0 {
+				break
-				stateEvent.ReplacesState = prevEventRef.ReplacesState
 			}
-			// Fill the previous event if the state event references a previous event
-			if prevEventRef.PrevContent != nil {
-				stateEvent.PrevContent = prevEventRef.PrevContent
 		}
 	}
 
-		resp = append(resp, stateEvent)
+	// If the room isn't world-readable then we will instead try to find out
+	// the state of the room based on the user's membership. If the user is
+	// in the room then we'll want the latest state. If the user has never
+	// been in the room and the room isn't world-readable, then we won't
+	// return any state. If the user was in the room previously but is no
+	// longer then we will return the state at the time that the user left.
+	// membershipRes will only be populated if the room is not world-readable.
+	var membershipRes api.QueryMembershipForUserResponse
+	if !worldReadable {
+		// The room isn't world-readable so try to work out based on the
+		// user's membership if we want the latest state or not.
+		err := rsAPI.QueryMembershipForUser(ctx, &api.QueryMembershipForUserRequest{
+			RoomID: roomID,
+			UserID: device.UserID,
+		}, &membershipRes)
+		if err != nil {
+			util.GetLogger(ctx).WithError(err).Error("Failed to QueryMembershipForUser")
+			return jsonerror.InternalServerError()
+		}
+		// If the user has never been in the room then stop at this point.
+		// We won't tell the user about a room they have never joined.
+		if !membershipRes.HasBeenInRoom {
+			return util.JSONResponse{
+				Code: http.StatusForbidden,
+				JSON: jsonerror.Forbidden(fmt.Sprintf("Unknown room %q or user %q has never joined this room", roomID, device.UserID)),
+			}
+		}
+		// Otherwise, if the user has been in the room, whether or not we
+		// give them the latest state will depend on if they are *still* in
+		// the room.
+		wantLatestState = membershipRes.IsInRoom
+	} else {
+		// The room is world-readable so the user join state is irrelevant,
+		// just get the latest room state instead.
+		wantLatestState = true
 	}
 
+	util.GetLogger(ctx).WithFields(log.Fields{
+		"roomID":         roomID,
+		"state_at_event": !wantLatestState,
+	}).Info("Fetching all state")
+
+	stateEvents := []gomatrixserverlib.ClientEvent{}
+	if wantLatestState {
+		// If we are happy to use the latest state, either because the user is
+		// still in the room, or because the room is world-readable, then just
+		// use the result of the previous QueryLatestEventsAndState response
+		// to find the state event, if provided.
+		for _, ev := range stateRes.StateEvents {
+			stateEvents = append(
+				stateEvents,
+				gomatrixserverlib.HeaderedToClientEvent(ev, gomatrixserverlib.FormatAll),
+			)
+		}
+	} else {
+		// Otherwise, take the event ID of their leave event and work out what
+		// the state of the room was before that event.
+		var stateAfterRes api.QueryStateAfterEventsResponse
+		err := rsAPI.QueryStateAfterEvents(ctx, &api.QueryStateAfterEventsRequest{
+			RoomID:       roomID,
+			PrevEventIDs: []string{membershipRes.EventID},
+			StateToFetch: []gomatrixserverlib.StateKeyTuple{},
+		}, &stateAfterRes)
+		if err != nil {
+			util.GetLogger(ctx).WithError(err).Error("Failed to QueryMembershipForUser")
+			return jsonerror.InternalServerError()
+		}
+		for _, ev := range stateRes.StateEvents {
+			stateEvents = append(
+				stateEvents,
+				gomatrixserverlib.HeaderedToClientEvent(ev, gomatrixserverlib.FormatAll),
+			)
+		}
+	}
+
+	// Return the results to the requestor.
 	return util.JSONResponse{
 		Code: http.StatusOK,
-		JSON: resp,
+		JSON: stateEvents,
 	}
 }