mirror of
https://github.com/1f349/dendrite.git
synced 2024-11-13 23:31:34 +00:00
b189edf4f4
Replaced with types.HeaderedEvent _for now_. In reality we want to move them all to gmsl.Event and only use HeaderedEvent when we _need_ to bundle the version/event ID with the event (seriailsation boundaries, and even then only when we don't have the room version). Requires https://github.com/matrix-org/gomatrixserverlib/pull/373
93 lines
3.3 KiB
Go
93 lines
3.3 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 synctypes
|
|
|
|
import (
|
|
"github.com/matrix-org/dendrite/roomserver/types"
|
|
"github.com/matrix-org/gomatrixserverlib"
|
|
"github.com/matrix-org/gomatrixserverlib/spec"
|
|
)
|
|
|
|
type ClientEventFormat int
|
|
|
|
const (
|
|
// FormatAll will include all client event keys
|
|
FormatAll ClientEventFormat = iota
|
|
// FormatSync will include only the event keys required by the /sync API. Notably, this
|
|
// means the 'room_id' will be missing from the events.
|
|
FormatSync
|
|
)
|
|
|
|
// ClientEvent is an event which is fit for consumption by clients, in accordance with the specification.
|
|
type ClientEvent struct {
|
|
Content spec.RawJSON `json:"content"`
|
|
EventID string `json:"event_id,omitempty"` // EventID is omitted on receipt events
|
|
OriginServerTS spec.Timestamp `json:"origin_server_ts,omitempty"` // OriginServerTS is omitted on receipt events
|
|
RoomID string `json:"room_id,omitempty"` // RoomID is omitted on /sync responses
|
|
Sender string `json:"sender,omitempty"` // Sender is omitted on receipt events
|
|
StateKey *string `json:"state_key,omitempty"`
|
|
Type string `json:"type"`
|
|
Unsigned spec.RawJSON `json:"unsigned,omitempty"`
|
|
Redacts string `json:"redacts,omitempty"`
|
|
}
|
|
|
|
// ToClientEvents converts server events to client events.
|
|
func ToClientEvents(serverEvs []*gomatrixserverlib.Event, format ClientEventFormat) []ClientEvent {
|
|
evs := make([]ClientEvent, 0, len(serverEvs))
|
|
for _, se := range serverEvs {
|
|
if se == nil {
|
|
continue // TODO: shouldn't happen?
|
|
}
|
|
evs = append(evs, ToClientEvent(se, format))
|
|
}
|
|
return evs
|
|
}
|
|
|
|
// HeaderedToClientEvents converts headered server events to client events.
|
|
func HeaderedToClientEvents(serverEvs []*types.HeaderedEvent, format ClientEventFormat) []ClientEvent {
|
|
evs := make([]ClientEvent, 0, len(serverEvs))
|
|
for _, se := range serverEvs {
|
|
if se == nil {
|
|
continue // TODO: shouldn't happen?
|
|
}
|
|
evs = append(evs, HeaderedToClientEvent(se, format))
|
|
}
|
|
return evs
|
|
}
|
|
|
|
// ToClientEvent converts a single server event to a client event.
|
|
func ToClientEvent(se *gomatrixserverlib.Event, format ClientEventFormat) ClientEvent {
|
|
ce := ClientEvent{
|
|
Content: spec.RawJSON(se.Content()),
|
|
Sender: se.Sender(),
|
|
Type: se.Type(),
|
|
StateKey: se.StateKey(),
|
|
Unsigned: spec.RawJSON(se.Unsigned()),
|
|
OriginServerTS: se.OriginServerTS(),
|
|
EventID: se.EventID(),
|
|
Redacts: se.Redacts(),
|
|
}
|
|
if format == FormatAll {
|
|
ce.RoomID = se.RoomID()
|
|
}
|
|
return ce
|
|
}
|
|
|
|
// HeaderedToClientEvent converts a single headered server event to a client event.
|
|
func HeaderedToClientEvent(se *types.HeaderedEvent, format ClientEventFormat) ClientEvent {
|
|
return ToClientEvent(se.Event, format)
|
|
}
|