mirror of
https://github.com/matrix-org/dendrite
synced 2024-12-17 22:43:43 +01:00
18231f25b4
* WIP Event rejection * Still send back errors for rejected events Instead, discard them at the federationapi /send layer rather than re-implementing checks at the clientapi/PerformJoin layer. * Implement rejected events Critically, rejected events CAN cause state resolution to happen as it can merge forks in the DAG. This is fine, _provided_ we do not add the rejected event when performing state resolution, which is what this PR does. It also fixes the error handling when NotAllowed happens, as we were checking too early and needlessly handling NotAllowed in more than one place. * Update test to match reality * Modify InputRoomEvents to no longer return an error Errors do not serialise across HTTP boundaries in polylith mode, so instead set fields on the InputRoomEventsResponse. Add `Err()` function to make the API shape basically the same. * Remove redundant returns; linting * Update blacklist
106 lines
4.1 KiB
Go
106 lines
4.1 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 api provides the types that are used to communicate with the roomserver.
|
|
package api
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/matrix-org/gomatrixserverlib"
|
|
)
|
|
|
|
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.
|
|
KindNew = 2
|
|
// KindBackfill event extend the contiguous graph going backwards.
|
|
// They always have state.
|
|
KindBackfill = 3
|
|
// KindRewrite events are used when rewriting the head of the room
|
|
// graph with entirely new state. The output events generated will
|
|
// be state events rather than timeline events.
|
|
KindRewrite = 4
|
|
)
|
|
|
|
// DoNotSendToOtherServers tells us not to send the event to other matrix
|
|
// servers.
|
|
const DoNotSendToOtherServers = ""
|
|
|
|
// InputRoomEvent is a matrix room event to add to the room server database.
|
|
// TODO: Implement UnmarshalJSON/MarshalJSON in a way that does something sensible with the event JSON.
|
|
type InputRoomEvent struct {
|
|
// Whether this event is new, backfilled or an outlier.
|
|
// This controls how the event is processed.
|
|
Kind int `json:"kind"`
|
|
// The event JSON for the event to add.
|
|
Event gomatrixserverlib.HeaderedEvent `json:"event"`
|
|
// 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.)
|
|
AuthEventIDs []string `json:"auth_event_ids"`
|
|
// Whether the state is supplied as a list of event IDs or whether it
|
|
// should be derived from the state at the previous events.
|
|
HasState bool `json:"has_state"`
|
|
// Optional list of state event IDs forming the state before this event.
|
|
// These state events must have already been persisted.
|
|
// These are only used if HasState is true.
|
|
// The list can be empty, for example when storing the first event in a room.
|
|
StateEventIDs []string `json:"state_event_ids"`
|
|
// The server name to use to push this event to other servers.
|
|
// Or empty if this event shouldn't be pushed to other servers.
|
|
SendAsServer string `json:"send_as_server"`
|
|
// 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
|
|
// event, along with the ID of the client session.
|
|
type TransactionID struct {
|
|
SessionID int64 `json:"session_id"`
|
|
TransactionID string `json:"id"`
|
|
}
|
|
|
|
// InputRoomEventsRequest is a request to InputRoomEvents
|
|
type InputRoomEventsRequest struct {
|
|
InputRoomEvents []InputRoomEvent `json:"input_room_events"`
|
|
}
|
|
|
|
// InputRoomEventsResponse is a response to InputRoomEvents
|
|
type InputRoomEventsResponse struct {
|
|
ErrMsg string // set if there was any error
|
|
NotAllowed bool // true if an event in the input was not allowed.
|
|
}
|
|
|
|
func (r *InputRoomEventsResponse) Err() error {
|
|
if r.ErrMsg == "" {
|
|
return nil
|
|
}
|
|
if r.NotAllowed {
|
|
return &gomatrixserverlib.NotAllowed{
|
|
Message: r.ErrMsg,
|
|
}
|
|
}
|
|
return fmt.Errorf("InputRoomEventsResponse: %s", r.ErrMsg)
|
|
}
|