2017-04-21 00:40:52 +02:00
|
|
|
// 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.
|
|
|
|
|
2017-02-03 14:52:32 +01:00
|
|
|
// Package api provides the types that are used to communicate with the roomserver.
|
|
|
|
package api
|
|
|
|
|
2017-02-22 17:05:18 +01:00
|
|
|
import (
|
2017-09-13 14:37:50 +02:00
|
|
|
"context"
|
2020-04-03 12:40:50 +02:00
|
|
|
"errors"
|
2017-07-13 12:41:30 +02:00
|
|
|
"net/http"
|
|
|
|
|
2018-07-17 16:36:04 +02:00
|
|
|
commonHTTP "github.com/matrix-org/dendrite/common/http"
|
2017-07-13 12:41:30 +02:00
|
|
|
"github.com/matrix-org/gomatrixserverlib"
|
2017-09-28 15:50:40 +02:00
|
|
|
opentracing "github.com/opentracing/opentracing-go"
|
2017-02-22 17:05:18 +01:00
|
|
|
)
|
|
|
|
|
2017-02-03 14:52:32 +01:00
|
|
|
const (
|
|
|
|
// KindOutlier event fall outside the contiguous event graph.
|
|
|
|
// We do not have the state for these events.
|
|
|
|
// These events are state events used to authenticate other events.
|
|
|
|
// They can become part of the contiguous event graph via backfill.
|
|
|
|
KindOutlier = 1
|
|
|
|
// KindNew event extend the contiguous graph going forwards.
|
|
|
|
// They usually don't need state, but may include state if the
|
|
|
|
// there was a new event that references an event that we don't
|
|
|
|
// have a copy of.
|
2017-07-13 12:41:30 +02:00
|
|
|
KindNew = 2
|
2017-02-03 14:52:32 +01:00
|
|
|
// KindBackfill event extend the contiguous graph going backwards.
|
|
|
|
// They always have state.
|
2017-07-13 12:41:30 +02:00
|
|
|
KindBackfill = 3
|
2017-02-03 14:52:32 +01:00
|
|
|
)
|
|
|
|
|
2017-06-27 16:28:44 +02:00
|
|
|
// DoNotSendToOtherServers tells us not to send the event to other matrix
|
|
|
|
// servers.
|
|
|
|
const DoNotSendToOtherServers = ""
|
|
|
|
|
2017-02-03 14:52:32 +01:00
|
|
|
// InputRoomEvent is a matrix room event to add to the room server database.
|
2017-02-07 18:20:05 +01:00
|
|
|
// TODO: Implement UnmarshalJSON/MarshalJSON in a way that does something sensible with the event JSON.
|
2017-02-03 14:52:32 +01:00
|
|
|
type InputRoomEvent struct {
|
|
|
|
// Whether this event is new, backfilled or an outlier.
|
|
|
|
// This controls how the event is processed.
|
2017-07-13 12:41:30 +02:00
|
|
|
Kind int `json:"kind"`
|
2017-02-03 14:52:32 +01:00
|
|
|
// The event JSON for the event to add.
|
2020-03-17 12:01:25 +01:00
|
|
|
Event gomatrixserverlib.HeaderedEvent `json:"event"`
|
2017-02-09 17:48:14 +01:00
|
|
|
// List of state event IDs that authenticate this event.
|
|
|
|
// These are likely derived from the "auth_events" JSON key of the event.
|
|
|
|
// But can be different because the "auth_events" key can be incomplete or wrong.
|
|
|
|
// For example many matrix events forget to reference the m.room.create event even though it is needed for auth.
|
|
|
|
// (since synapse allows this to happen we have to allow it as well.)
|
2017-07-13 12:41:30 +02:00
|
|
|
AuthEventIDs []string `json:"auth_event_ids"`
|
2017-02-22 17:05:18 +01:00
|
|
|
// Whether the state is supplied as a list of event IDs or whether it
|
|
|
|
// should be derived from the state at the previous events.
|
2017-07-13 12:41:30 +02:00
|
|
|
HasState bool `json:"has_state"`
|
2017-02-03 14:52:32 +01:00
|
|
|
// Optional list of state event IDs forming the state before this event.
|
|
|
|
// These state events must have already been persisted.
|
2017-02-22 17:05:18 +01:00
|
|
|
// These are only used if HasState is true.
|
|
|
|
// The list can be empty, for example when storing the first event in a room.
|
2017-07-13 12:41:30 +02:00
|
|
|
StateEventIDs []string `json:"state_event_ids"`
|
2017-06-27 16:28:44 +02:00
|
|
|
// The server name to use to push this event to other servers.
|
|
|
|
// Or empty if this event shouldn't be pushed to other servers.
|
2017-07-13 12:41:30 +02:00
|
|
|
SendAsServer string `json:"send_as_server"`
|
2017-12-04 19:07:52 +01:00
|
|
|
// The transaction ID of the send request if sent by a local user and one
|
|
|
|
// was specified
|
|
|
|
TransactionID *TransactionID `json:"transaction_id"`
|
|
|
|
}
|
|
|
|
|
|
|
|
// TransactionID contains the transaction ID sent by a client when sending an
|
2019-08-23 18:55:40 +02:00
|
|
|
// event, along with the ID of the client session.
|
2017-12-04 19:07:52 +01:00
|
|
|
type TransactionID struct {
|
2019-08-23 18:55:40 +02:00
|
|
|
SessionID int64 `json:"session_id"`
|
2017-12-04 19:07:52 +01:00
|
|
|
TransactionID string `json:"id"`
|
2017-02-03 14:52:32 +01:00
|
|
|
}
|
2017-02-22 17:05:18 +01:00
|
|
|
|
2017-08-21 17:37:11 +02:00
|
|
|
// InputInviteEvent is a matrix invite event received over federation without
|
|
|
|
// the usual context a matrix room event would have. We usually do not have
|
|
|
|
// access to the events needed to check the event auth rules for the invite.
|
|
|
|
type InputInviteEvent struct {
|
2020-03-17 12:01:25 +01:00
|
|
|
Event gomatrixserverlib.HeaderedEvent `json:"event"`
|
2017-08-21 17:37:11 +02:00
|
|
|
}
|
|
|
|
|
2017-07-13 12:41:30 +02:00
|
|
|
// InputRoomEventsRequest is a request to InputRoomEvents
|
|
|
|
type InputRoomEventsRequest struct {
|
2017-08-21 17:37:11 +02:00
|
|
|
InputRoomEvents []InputRoomEvent `json:"input_room_events"`
|
|
|
|
InputInviteEvents []InputInviteEvent `json:"input_invite_events"`
|
2017-07-13 12:41:30 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
// InputRoomEventsResponse is a response to InputRoomEvents
|
2018-05-26 13:03:35 +02:00
|
|
|
type InputRoomEventsResponse struct {
|
|
|
|
EventID string `json:"event_id"`
|
|
|
|
}
|
2017-07-13 12:41:30 +02:00
|
|
|
|
|
|
|
// RoomserverInputAPI is used to write events to the room server.
|
|
|
|
type RoomserverInputAPI interface {
|
|
|
|
InputRoomEvents(
|
2017-09-13 14:37:50 +02:00
|
|
|
ctx context.Context,
|
2017-07-13 12:41:30 +02:00
|
|
|
request *InputRoomEventsRequest,
|
|
|
|
response *InputRoomEventsResponse,
|
|
|
|
) error
|
2017-02-22 17:05:18 +01:00
|
|
|
}
|
|
|
|
|
2017-07-13 12:41:30 +02:00
|
|
|
// RoomserverInputRoomEventsPath is the HTTP path for the InputRoomEvents API.
|
|
|
|
const RoomserverInputRoomEventsPath = "/api/roomserver/inputRoomEvents"
|
|
|
|
|
|
|
|
// NewRoomserverInputAPIHTTP creates a RoomserverInputAPI implemented by talking to a HTTP POST API.
|
2020-04-03 12:40:50 +02:00
|
|
|
// If httpClient is nil an error is returned
|
|
|
|
func NewRoomserverInputAPIHTTP(roomserverURL string, httpClient *http.Client) (RoomserverInputAPI, error) {
|
2017-07-13 12:41:30 +02:00
|
|
|
if httpClient == nil {
|
2020-04-03 12:40:50 +02:00
|
|
|
return nil, errors.New("NewRoomserverInputAPIHTTP: httpClient is <nil>")
|
2017-02-22 17:05:18 +01:00
|
|
|
}
|
2020-04-03 12:40:50 +02:00
|
|
|
return &httpRoomserverInputAPI{roomserverURL, httpClient}, nil
|
2017-07-13 12:41:30 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
type httpRoomserverInputAPI struct {
|
|
|
|
roomserverURL string
|
|
|
|
httpClient *http.Client
|
|
|
|
}
|
|
|
|
|
|
|
|
// InputRoomEvents implements RoomserverInputAPI
|
|
|
|
func (h *httpRoomserverInputAPI) InputRoomEvents(
|
2017-09-13 14:37:50 +02:00
|
|
|
ctx context.Context,
|
2017-07-13 12:41:30 +02:00
|
|
|
request *InputRoomEventsRequest,
|
|
|
|
response *InputRoomEventsResponse,
|
|
|
|
) error {
|
2017-09-28 15:50:40 +02:00
|
|
|
span, ctx := opentracing.StartSpanFromContext(ctx, "InputRoomEvents")
|
|
|
|
defer span.Finish()
|
|
|
|
|
2017-07-13 12:41:30 +02:00
|
|
|
apiURL := h.roomserverURL + RoomserverInputRoomEventsPath
|
2018-07-17 16:36:04 +02:00
|
|
|
return commonHTTP.PostJSON(ctx, span, h.httpClient, apiURL, request, response)
|
2017-02-22 17:05:18 +01:00
|
|
|
}
|