2017-04-20 23:40:52 +01: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-03-06 14:29:39 +00:00
|
|
|
package api
|
|
|
|
|
|
|
|
import (
|
|
|
|
"bytes"
|
|
|
|
"encoding/json"
|
|
|
|
"fmt"
|
|
|
|
"net/http"
|
2017-07-12 14:13:10 +01:00
|
|
|
|
|
|
|
"github.com/matrix-org/gomatrixserverlib"
|
2017-03-06 14:29:39 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
// QueryLatestEventsAndStateRequest is a request to QueryLatestEventsAndState
|
|
|
|
type QueryLatestEventsAndStateRequest struct {
|
2017-05-30 17:44:31 +01:00
|
|
|
// The room ID to query the latest events for.
|
2017-07-12 14:13:10 +01:00
|
|
|
RoomID string `json:"room_id"`
|
2017-03-06 14:29:39 +00:00
|
|
|
// The state key tuples to fetch from the room current state.
|
|
|
|
// If this list is empty or nil then no state events are returned.
|
2017-07-12 14:13:10 +01:00
|
|
|
StateToFetch []gomatrixserverlib.StateKeyTuple `json:"state_to_fetch"`
|
2017-03-06 14:29:39 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// QueryLatestEventsAndStateResponse is a response to QueryLatestEventsAndState
|
2017-06-27 15:28:44 +01:00
|
|
|
// This is used when sending events to set the prev_events, auth_events and depth.
|
|
|
|
// It is also used to tell whether the event is allowed by the event auth rules.
|
2017-03-06 14:29:39 +00:00
|
|
|
type QueryLatestEventsAndStateResponse struct {
|
|
|
|
// Copy of the request for debugging.
|
|
|
|
QueryLatestEventsAndStateRequest
|
|
|
|
// Does the room exist?
|
|
|
|
// If the room doesn't exist this will be false and LatestEvents will be empty.
|
2017-07-12 14:13:10 +01:00
|
|
|
RoomExists bool `json:"room_exists"`
|
2017-03-06 14:29:39 +00:00
|
|
|
// The latest events in the room.
|
2017-06-27 15:28:44 +01:00
|
|
|
// These are used to set the prev_events when sending an event.
|
2017-07-12 14:13:10 +01:00
|
|
|
LatestEvents []gomatrixserverlib.EventReference `json:"latest_events"`
|
2017-03-06 14:29:39 +00:00
|
|
|
// The state events requested.
|
2017-06-02 14:32:36 +01:00
|
|
|
// This list will be in an arbitrary order.
|
2017-06-27 15:28:44 +01:00
|
|
|
// These are used to set the auth_events when sending an event.
|
|
|
|
// These are used to check whether the event is allowed.
|
2017-07-12 14:13:10 +01:00
|
|
|
StateEvents []gomatrixserverlib.Event `json:"state_events"`
|
2017-06-27 15:28:44 +01:00
|
|
|
// The depth of the latest events.
|
|
|
|
// This is one greater than the maximum depth of the latest events.
|
|
|
|
// This is used to set the depth when sending an event.
|
2017-07-12 14:13:10 +01:00
|
|
|
Depth int64 `json:"depth"`
|
2017-03-06 14:29:39 +00:00
|
|
|
}
|
|
|
|
|
2017-05-30 17:44:31 +01:00
|
|
|
// QueryStateAfterEventsRequest is a request to QueryStateAfterEvents
|
|
|
|
type QueryStateAfterEventsRequest struct {
|
|
|
|
// The room ID to query the state in.
|
2017-07-12 14:13:10 +01:00
|
|
|
RoomID string `json:"room_id"`
|
2017-05-30 17:44:31 +01:00
|
|
|
// The list of previous events to return the events after.
|
2017-07-12 14:13:10 +01:00
|
|
|
PrevEventIDs []string `json:"prev_event_ids"`
|
2017-05-30 17:44:31 +01:00
|
|
|
// The state key tuples to fetch from the state
|
2017-07-12 14:13:10 +01:00
|
|
|
StateToFetch []gomatrixserverlib.StateKeyTuple `json:"state_to_fetch"`
|
2017-05-30 17:44:31 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// QueryStateAfterEventsResponse is a response to QueryStateAfterEvents
|
|
|
|
type QueryStateAfterEventsResponse struct {
|
|
|
|
// Copy of the request for debugging.
|
|
|
|
QueryStateAfterEventsRequest
|
|
|
|
// Does the room exist on this roomserver?
|
|
|
|
// If the room doesn't exist this will be false and StateEvents will be empty.
|
2017-07-12 14:13:10 +01:00
|
|
|
RoomExists bool `json:"room_exists"`
|
2017-05-30 17:44:31 +01:00
|
|
|
// Do all the previous events exist on this roomserver?
|
|
|
|
// If some of previous events do not exist this will be false and StateEvents will be empty.
|
2017-07-12 14:13:10 +01:00
|
|
|
PrevEventsExist bool `json:"prev_events_exist"`
|
2017-05-30 17:44:31 +01:00
|
|
|
// The state events requested.
|
2017-06-02 14:32:36 +01:00
|
|
|
// This list will be in an arbitrary order.
|
2017-07-12 14:13:10 +01:00
|
|
|
StateEvents []gomatrixserverlib.Event `json:"state_events"`
|
2017-05-30 17:44:31 +01:00
|
|
|
}
|
|
|
|
|
2017-06-02 14:32:36 +01:00
|
|
|
// QueryEventsByIDRequest is a request to QueryEventsByID
|
|
|
|
type QueryEventsByIDRequest struct {
|
|
|
|
// The event IDs to look up.
|
2017-07-12 14:13:10 +01:00
|
|
|
EventIDs []string `json:"event_ids"`
|
2017-06-02 14:32:36 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// QueryEventsByIDResponse is a response to QueryEventsByID
|
|
|
|
type QueryEventsByIDResponse struct {
|
|
|
|
// Copy of the request for debugging.
|
|
|
|
QueryEventsByIDRequest
|
|
|
|
// A list of events with the requested IDs.
|
|
|
|
// If the roomserver does not have a copy of a requested event
|
|
|
|
// then it will omit that event from the list.
|
|
|
|
// If the roomserver thinks it has a copy of the event, but
|
|
|
|
// fails to read it from the database then it will fail
|
|
|
|
// the entire request.
|
|
|
|
// This list will be in an arbitrary order.
|
2017-07-12 14:13:10 +01:00
|
|
|
Events []gomatrixserverlib.Event `json:"events"`
|
2017-06-02 14:32:36 +01:00
|
|
|
}
|
|
|
|
|
2017-03-06 14:29:39 +00:00
|
|
|
// RoomserverQueryAPI is used to query information from the room server.
|
|
|
|
type RoomserverQueryAPI interface {
|
|
|
|
// Query the latest events and state for a room from the room server.
|
|
|
|
QueryLatestEventsAndState(
|
|
|
|
request *QueryLatestEventsAndStateRequest,
|
|
|
|
response *QueryLatestEventsAndStateResponse,
|
|
|
|
) error
|
2017-05-30 17:44:31 +01:00
|
|
|
|
|
|
|
// Query the state after a list of events in a room from the room server.
|
|
|
|
QueryStateAfterEvents(
|
|
|
|
request *QueryStateAfterEventsRequest,
|
|
|
|
response *QueryStateAfterEventsResponse,
|
|
|
|
) error
|
2017-06-02 14:32:36 +01:00
|
|
|
|
|
|
|
// Query a list of events by event ID.
|
|
|
|
QueryEventsByID(
|
|
|
|
request *QueryEventsByIDRequest,
|
|
|
|
response *QueryEventsByIDResponse,
|
|
|
|
) error
|
2017-03-06 14:29:39 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// RoomserverQueryLatestEventsAndStatePath is the HTTP path for the QueryLatestEventsAndState API.
|
2017-07-12 14:13:10 +01:00
|
|
|
const RoomserverQueryLatestEventsAndStatePath = "/api/roomserver/queryLatestEventsAndState"
|
2017-03-06 14:29:39 +00:00
|
|
|
|
2017-05-30 17:44:31 +01:00
|
|
|
// RoomserverQueryStateAfterEventsPath is the HTTP path for the QueryStateAfterEvents API.
|
2017-07-12 14:13:10 +01:00
|
|
|
const RoomserverQueryStateAfterEventsPath = "/api/roomserver/queryStateAfterEvents"
|
2017-05-30 17:44:31 +01:00
|
|
|
|
2017-06-02 14:32:36 +01:00
|
|
|
// RoomserverQueryEventsByIDPath is the HTTP path for the QueryEventsByID API.
|
2017-07-12 14:13:10 +01:00
|
|
|
const RoomserverQueryEventsByIDPath = "/api/roomserver/queryEventsByID"
|
2017-06-02 14:32:36 +01:00
|
|
|
|
2017-03-06 14:29:39 +00:00
|
|
|
// NewRoomserverQueryAPIHTTP creates a RoomserverQueryAPI implemented by talking to a HTTP POST API.
|
|
|
|
// If httpClient is nil then it uses the http.DefaultClient
|
|
|
|
func NewRoomserverQueryAPIHTTP(roomserverURL string, httpClient *http.Client) RoomserverQueryAPI {
|
|
|
|
if httpClient == nil {
|
|
|
|
httpClient = http.DefaultClient
|
|
|
|
}
|
|
|
|
return &httpRoomserverQueryAPI{roomserverURL, *httpClient}
|
|
|
|
}
|
|
|
|
|
|
|
|
type httpRoomserverQueryAPI struct {
|
|
|
|
roomserverURL string
|
|
|
|
httpClient http.Client
|
|
|
|
}
|
|
|
|
|
|
|
|
// QueryLatestEventsAndState implements RoomserverQueryAPI
|
|
|
|
func (h *httpRoomserverQueryAPI) QueryLatestEventsAndState(
|
|
|
|
request *QueryLatestEventsAndStateRequest,
|
|
|
|
response *QueryLatestEventsAndStateResponse,
|
|
|
|
) error {
|
|
|
|
apiURL := h.roomserverURL + RoomserverQueryLatestEventsAndStatePath
|
|
|
|
return postJSON(h.httpClient, apiURL, request, response)
|
|
|
|
}
|
|
|
|
|
2017-05-30 17:44:31 +01:00
|
|
|
// QueryStateAfterEvents implements RoomserverQueryAPI
|
|
|
|
func (h *httpRoomserverQueryAPI) QueryStateAfterEvents(
|
|
|
|
request *QueryStateAfterEventsRequest,
|
|
|
|
response *QueryStateAfterEventsResponse,
|
|
|
|
) error {
|
|
|
|
apiURL := h.roomserverURL + RoomserverQueryStateAfterEventsPath
|
|
|
|
return postJSON(h.httpClient, apiURL, request, response)
|
|
|
|
}
|
|
|
|
|
2017-06-02 14:32:36 +01:00
|
|
|
// QueryEventsByID implements RoomserverQueryAPI
|
|
|
|
func (h *httpRoomserverQueryAPI) QueryEventsByID(
|
|
|
|
request *QueryEventsByIDRequest,
|
|
|
|
response *QueryEventsByIDResponse,
|
|
|
|
) error {
|
|
|
|
apiURL := h.roomserverURL + RoomserverQueryEventsByIDPath
|
|
|
|
return postJSON(h.httpClient, apiURL, request, response)
|
|
|
|
}
|
|
|
|
|
2017-03-06 14:29:39 +00:00
|
|
|
func postJSON(httpClient http.Client, apiURL string, request, response interface{}) error {
|
|
|
|
jsonBytes, err := json.Marshal(request)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
res, err := httpClient.Post(apiURL, "application/json", bytes.NewReader(jsonBytes))
|
|
|
|
if res != nil {
|
|
|
|
defer res.Body.Close()
|
|
|
|
}
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if res.StatusCode != 200 {
|
|
|
|
var errorBody struct {
|
|
|
|
Message string `json:"message"`
|
|
|
|
}
|
|
|
|
if err = json.NewDecoder(res.Body).Decode(&errorBody); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
return fmt.Errorf("api: %d: %s", res.StatusCode, errorBody.Message)
|
|
|
|
}
|
|
|
|
return json.NewDecoder(res.Body).Decode(response)
|
|
|
|
}
|