349 lines
12 KiB
Go
349 lines
12 KiB
Go
// Copyright 2017 Vector Creations Ltd
|
|
//
|
|
// 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.
|
|
|
|
package routing
|
|
|
|
import (
|
|
"fmt"
|
|
"net/http"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/matrix-org/dendrite/clientapi/auth/authtypes"
|
|
"github.com/matrix-org/dendrite/clientapi/auth/storage/accounts"
|
|
"github.com/matrix-org/dendrite/clientapi/httputil"
|
|
"github.com/matrix-org/dendrite/clientapi/jsonerror"
|
|
"github.com/matrix-org/dendrite/clientapi/producers"
|
|
"github.com/matrix-org/dendrite/common"
|
|
"github.com/matrix-org/dendrite/common/config"
|
|
federationSenderAPI "github.com/matrix-org/dendrite/federationsender/api"
|
|
roomserverAPI "github.com/matrix-org/dendrite/roomserver/api"
|
|
"github.com/matrix-org/gomatrix"
|
|
"github.com/matrix-org/gomatrixserverlib"
|
|
"github.com/matrix-org/util"
|
|
)
|
|
|
|
// JoinRoomByIDOrAlias implements the "/join/{roomIDOrAlias}" API.
|
|
// https://matrix.org/docs/spec/client_server/r0.2.0.html#post-matrix-client-r0-join-roomidoralias
|
|
func JoinRoomByIDOrAlias(
|
|
req *http.Request,
|
|
device *authtypes.Device,
|
|
roomIDOrAlias string,
|
|
cfg *config.Dendrite,
|
|
federation *gomatrixserverlib.FederationClient,
|
|
producer *producers.RoomserverProducer,
|
|
queryAPI roomserverAPI.RoomserverQueryAPI,
|
|
aliasAPI roomserverAPI.RoomserverAliasAPI,
|
|
fsAPI federationSenderAPI.FederationSenderInternalAPI,
|
|
keyRing gomatrixserverlib.KeyRing,
|
|
accountDB accounts.Database,
|
|
) util.JSONResponse {
|
|
var content map[string]interface{} // must be a JSON object
|
|
if resErr := httputil.UnmarshalJSONRequest(req, &content); resErr != nil {
|
|
return *resErr
|
|
}
|
|
|
|
evTime, err := httputil.ParseTSParam(req)
|
|
if err != nil {
|
|
return util.JSONResponse{
|
|
Code: http.StatusBadRequest,
|
|
JSON: jsonerror.InvalidArgumentValue(err.Error()),
|
|
}
|
|
}
|
|
|
|
localpart, _, err := gomatrixserverlib.SplitID('@', device.UserID)
|
|
if err != nil {
|
|
util.GetLogger(req.Context()).WithError(err).Error("gomatrixserverlib.SplitID failed")
|
|
return jsonerror.InternalServerError()
|
|
}
|
|
|
|
profile, err := accountDB.GetProfileByLocalpart(req.Context(), localpart)
|
|
if err != nil {
|
|
util.GetLogger(req.Context()).WithError(err).Error("accountDB.GetProfileByLocalpart failed")
|
|
return jsonerror.InternalServerError()
|
|
}
|
|
|
|
content["membership"] = gomatrixserverlib.Join
|
|
content["displayname"] = profile.DisplayName
|
|
content["avatar_url"] = profile.AvatarURL
|
|
|
|
r := joinRoomReq{
|
|
req, evTime, content, device.UserID, cfg, federation, producer,
|
|
queryAPI, aliasAPI, fsAPI, keyRing,
|
|
}
|
|
|
|
if strings.HasPrefix(roomIDOrAlias, "!") {
|
|
return r.joinRoomByID(roomIDOrAlias)
|
|
}
|
|
if strings.HasPrefix(roomIDOrAlias, "#") {
|
|
return r.joinRoomByAlias(roomIDOrAlias)
|
|
}
|
|
return util.JSONResponse{
|
|
Code: http.StatusBadRequest,
|
|
JSON: jsonerror.BadJSON(
|
|
fmt.Sprintf("Invalid first character '%s' for room ID or alias",
|
|
string([]rune(roomIDOrAlias)[0])), // Wrapping with []rune makes this call UTF-8 safe
|
|
),
|
|
}
|
|
}
|
|
|
|
type joinRoomReq struct {
|
|
req *http.Request
|
|
evTime time.Time
|
|
content map[string]interface{}
|
|
userID string
|
|
cfg *config.Dendrite
|
|
federation *gomatrixserverlib.FederationClient
|
|
producer *producers.RoomserverProducer
|
|
queryAPI roomserverAPI.RoomserverQueryAPI
|
|
aliasAPI roomserverAPI.RoomserverAliasAPI
|
|
fsAPI federationSenderAPI.FederationSenderInternalAPI
|
|
keyRing gomatrixserverlib.KeyRing
|
|
}
|
|
|
|
// joinRoomByID joins a room by room ID
|
|
func (r joinRoomReq) joinRoomByID(roomID string) util.JSONResponse {
|
|
// A client should only join a room by room ID when it has an invite
|
|
// to the room. If the server is already in the room then we can
|
|
// lookup the invite and process the request as a normal state event.
|
|
// If the server is not in the room the we will need to look up the
|
|
// remote server the invite came from in order to request a join event
|
|
// from that server.
|
|
queryReq := roomserverAPI.QueryInvitesForUserRequest{
|
|
RoomID: roomID, TargetUserID: r.userID,
|
|
}
|
|
var queryRes roomserverAPI.QueryInvitesForUserResponse
|
|
if err := r.queryAPI.QueryInvitesForUser(r.req.Context(), &queryReq, &queryRes); err != nil {
|
|
util.GetLogger(r.req.Context()).WithError(err).Error("r.queryAPI.QueryInvitesForUser failed")
|
|
return jsonerror.InternalServerError()
|
|
}
|
|
|
|
servers := []gomatrixserverlib.ServerName{}
|
|
seenInInviterIDs := map[gomatrixserverlib.ServerName]bool{}
|
|
for _, userID := range queryRes.InviteSenderUserIDs {
|
|
_, domain, err := gomatrixserverlib.SplitID('@', userID)
|
|
if err != nil {
|
|
util.GetLogger(r.req.Context()).WithError(err).Error("gomatrixserverlib.SplitID failed")
|
|
return jsonerror.InternalServerError()
|
|
}
|
|
if !seenInInviterIDs[domain] {
|
|
servers = append(servers, domain)
|
|
seenInInviterIDs[domain] = true
|
|
}
|
|
}
|
|
|
|
// Also add the domain extracted from the roomID as a last resort to join
|
|
// in case the client is erroneously trying to join by ID without an invite
|
|
// or all previous attempts at domains extracted from the inviter IDs fail
|
|
// Note: It's no guarantee we'll succeed because a room isn't bound to the domain in its ID
|
|
_, domain, err := gomatrixserverlib.SplitID('!', roomID)
|
|
if err != nil {
|
|
util.GetLogger(r.req.Context()).WithError(err).Error("gomatrixserverlib.SplitID failed")
|
|
return jsonerror.InternalServerError()
|
|
}
|
|
if domain != r.cfg.Matrix.ServerName && !seenInInviterIDs[domain] {
|
|
servers = append(servers, domain)
|
|
}
|
|
|
|
return r.joinRoomUsingServers(roomID, servers)
|
|
|
|
}
|
|
|
|
// joinRoomByAlias joins a room using a room alias.
|
|
func (r joinRoomReq) joinRoomByAlias(roomAlias string) util.JSONResponse {
|
|
_, domain, err := gomatrixserverlib.SplitID('#', roomAlias)
|
|
if err != nil {
|
|
return util.JSONResponse{
|
|
Code: http.StatusBadRequest,
|
|
JSON: jsonerror.BadJSON("Room alias must be in the form '#localpart:domain'"),
|
|
}
|
|
}
|
|
if domain == r.cfg.Matrix.ServerName {
|
|
queryReq := roomserverAPI.GetRoomIDForAliasRequest{Alias: roomAlias}
|
|
var queryRes roomserverAPI.GetRoomIDForAliasResponse
|
|
if err = r.aliasAPI.GetRoomIDForAlias(r.req.Context(), &queryReq, &queryRes); err != nil {
|
|
util.GetLogger(r.req.Context()).WithError(err).Error("r.aliasAPI.GetRoomIDForAlias failed")
|
|
return jsonerror.InternalServerError()
|
|
}
|
|
|
|
if len(queryRes.RoomID) > 0 {
|
|
return r.joinRoomUsingServers(queryRes.RoomID, []gomatrixserverlib.ServerName{r.cfg.Matrix.ServerName})
|
|
}
|
|
// If the response doesn't contain a non-empty string, return an error
|
|
return util.JSONResponse{
|
|
Code: http.StatusNotFound,
|
|
JSON: jsonerror.NotFound("Room alias " + roomAlias + " not found."),
|
|
}
|
|
}
|
|
// If the room isn't local, use federation to join
|
|
return r.joinRoomByRemoteAlias(domain, roomAlias)
|
|
}
|
|
|
|
func (r joinRoomReq) joinRoomByRemoteAlias(
|
|
domain gomatrixserverlib.ServerName, roomAlias string,
|
|
) util.JSONResponse {
|
|
resp, err := r.federation.LookupRoomAlias(r.req.Context(), domain, roomAlias)
|
|
if err != nil {
|
|
switch x := err.(type) {
|
|
case gomatrix.HTTPError:
|
|
if x.Code == http.StatusNotFound {
|
|
return util.JSONResponse{
|
|
Code: http.StatusNotFound,
|
|
JSON: jsonerror.NotFound("Room alias not found"),
|
|
}
|
|
}
|
|
}
|
|
util.GetLogger(r.req.Context()).WithError(err).Error("r.federation.LookupRoomAlias failed")
|
|
return jsonerror.InternalServerError()
|
|
}
|
|
|
|
return r.joinRoomUsingServers(resp.RoomID, resp.Servers)
|
|
}
|
|
|
|
func (r joinRoomReq) writeToBuilder(eb *gomatrixserverlib.EventBuilder, roomID string) error {
|
|
eb.Type = "m.room.member"
|
|
|
|
err := eb.SetContent(r.content)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
err = eb.SetUnsigned(struct{}{})
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
eb.Sender = r.userID
|
|
eb.StateKey = &r.userID
|
|
eb.RoomID = roomID
|
|
eb.Redacts = ""
|
|
|
|
return nil
|
|
}
|
|
|
|
func (r joinRoomReq) joinRoomUsingServers(
|
|
roomID string, servers []gomatrixserverlib.ServerName,
|
|
) util.JSONResponse {
|
|
var eb gomatrixserverlib.EventBuilder
|
|
err := r.writeToBuilder(&eb, roomID)
|
|
if err != nil {
|
|
util.GetLogger(r.req.Context()).WithError(err).Error("r.writeToBuilder failed")
|
|
return jsonerror.InternalServerError()
|
|
}
|
|
|
|
queryRes := roomserverAPI.QueryLatestEventsAndStateResponse{}
|
|
event, err := common.BuildEvent(r.req.Context(), &eb, r.cfg, r.evTime, r.queryAPI, &queryRes)
|
|
if err == nil {
|
|
// If we have successfully built an event at this point then we can
|
|
// assert that the room is a local room, as BuildEvent was able to
|
|
// add prev_events etc successfully.
|
|
if _, err = r.producer.SendEvents(
|
|
r.req.Context(),
|
|
[]gomatrixserverlib.HeaderedEvent{
|
|
(*event).Headered(queryRes.RoomVersion),
|
|
},
|
|
r.cfg.Matrix.ServerName,
|
|
nil,
|
|
); err != nil {
|
|
util.GetLogger(r.req.Context()).WithError(err).Error("r.producer.SendEvents failed")
|
|
return jsonerror.InternalServerError()
|
|
}
|
|
return util.JSONResponse{
|
|
Code: http.StatusOK,
|
|
JSON: struct {
|
|
RoomID string `json:"room_id"`
|
|
}{roomID},
|
|
}
|
|
}
|
|
|
|
// Otherwise, if we've reached here, then we haven't been able to populate
|
|
// prev_events etc for the room, therefore the room is probably federated.
|
|
|
|
// TODO: This needs to be re-thought, as in the case of an invite, the room
|
|
// will exist in the database in roomserver_rooms but won't have any state
|
|
// events, therefore this below check fails.
|
|
if err != common.ErrRoomNoExists {
|
|
util.GetLogger(r.req.Context()).WithError(err).Error("common.BuildEvent failed")
|
|
return jsonerror.InternalServerError()
|
|
}
|
|
|
|
if len(servers) == 0 {
|
|
return util.JSONResponse{
|
|
Code: http.StatusNotFound,
|
|
JSON: jsonerror.NotFound("No candidate servers found for room"),
|
|
}
|
|
}
|
|
|
|
var lastErr error
|
|
for _, server := range servers {
|
|
var response *util.JSONResponse
|
|
response, lastErr = r.joinRoomUsingServer(roomID, server)
|
|
if lastErr != nil {
|
|
// There was a problem talking to one of the servers.
|
|
util.GetLogger(r.req.Context()).WithError(lastErr).WithField("server", server).Warn("Failed to join room using server")
|
|
// Try the next server.
|
|
if r.req.Context().Err() != nil {
|
|
// The request context has expired so don't bother trying any
|
|
// more servers - they will immediately fail due to the expired
|
|
// context.
|
|
break
|
|
} else {
|
|
// The request context hasn't expired yet so try the next server.
|
|
continue
|
|
}
|
|
}
|
|
return *response
|
|
}
|
|
|
|
// Every server we tried to join through resulted in an error.
|
|
// We return the error from the last server.
|
|
|
|
// TODO: Generate the correct HTTP status code for all different
|
|
// kinds of errors that could have happened.
|
|
// The possible errors include:
|
|
// 1) We can't connect to the remote servers.
|
|
// 2) None of the servers we could connect to think we are allowed
|
|
// to join the room.
|
|
// 3) The remote server returned something invalid.
|
|
// 4) We couldn't fetch the public keys needed to verify the
|
|
// signatures on the state events.
|
|
// 5) ...
|
|
util.GetLogger(r.req.Context()).WithError(lastErr).Error("failed to join through any server")
|
|
return jsonerror.InternalServerError()
|
|
}
|
|
|
|
// joinRoomUsingServer tries to join a remote room using a given matrix server.
|
|
// If there was a failure communicating with the server or the response from the
|
|
// server was invalid this returns an error.
|
|
// Otherwise this returns a JSONResponse.
|
|
func (r joinRoomReq) joinRoomUsingServer(roomID string, server gomatrixserverlib.ServerName) (*util.JSONResponse, error) {
|
|
fedJoinReq := federationSenderAPI.PerformJoinRequest{
|
|
RoomID: roomID,
|
|
UserID: r.userID,
|
|
ServerName: server,
|
|
}
|
|
fedJoinRes := federationSenderAPI.PerformJoinResponse{}
|
|
if err := r.fsAPI.PerformJoin(r.req.Context(), &fedJoinReq, &fedJoinRes); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return &util.JSONResponse{
|
|
Code: http.StatusOK,
|
|
// TODO: Put the response struct somewhere common.
|
|
JSON: struct {
|
|
RoomID string `json:"room_id"`
|
|
}{roomID},
|
|
}, nil
|
|
}
|