2018-05-24 12:54:42 +00:00
|
|
|
// Copyright 2018 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 consumers
|
|
|
|
|
|
|
|
import (
|
|
|
|
"context"
|
|
|
|
"encoding/json"
|
2018-05-30 12:43:13 +00:00
|
|
|
"fmt"
|
2018-05-24 12:54:42 +00:00
|
|
|
|
|
|
|
"github.com/matrix-org/dendrite/clientapi/auth/storage/accounts"
|
|
|
|
"github.com/matrix-org/dendrite/common"
|
|
|
|
"github.com/matrix-org/dendrite/common/config"
|
|
|
|
"github.com/matrix-org/dendrite/roomserver/api"
|
|
|
|
"github.com/matrix-org/gomatrixserverlib"
|
|
|
|
|
|
|
|
log "github.com/sirupsen/logrus"
|
|
|
|
sarama "gopkg.in/Shopify/sarama.v1"
|
|
|
|
)
|
|
|
|
|
2018-05-30 12:43:13 +00:00
|
|
|
var (
|
|
|
|
appServices []config.ApplicationService
|
|
|
|
)
|
|
|
|
|
2018-05-24 12:54:42 +00:00
|
|
|
// OutputRoomEventConsumer consumes events that originated in the room server.
|
|
|
|
type OutputRoomEventConsumer struct {
|
|
|
|
roomServerConsumer *common.ContinualConsumer
|
|
|
|
db *accounts.Database
|
|
|
|
query api.RoomserverQueryAPI
|
2018-05-30 12:43:13 +00:00
|
|
|
alias api.RoomserverAliasAPI
|
2018-05-24 12:54:42 +00:00
|
|
|
serverName string
|
|
|
|
}
|
|
|
|
|
|
|
|
// NewOutputRoomEventConsumer creates a new OutputRoomEventConsumer. Call Start() to begin consuming from room servers.
|
|
|
|
func NewOutputRoomEventConsumer(
|
|
|
|
cfg *config.Dendrite,
|
|
|
|
kafkaConsumer sarama.Consumer,
|
|
|
|
store *accounts.Database,
|
|
|
|
queryAPI api.RoomserverQueryAPI,
|
2018-05-30 12:43:13 +00:00
|
|
|
aliasAPI api.RoomserverAliasAPI,
|
2018-05-24 12:54:42 +00:00
|
|
|
) *OutputRoomEventConsumer {
|
2018-05-30 12:43:13 +00:00
|
|
|
appServices = cfg.Derived.ApplicationServices
|
2018-05-24 12:54:42 +00:00
|
|
|
|
|
|
|
consumer := common.ContinualConsumer{
|
|
|
|
Topic: string(cfg.Kafka.Topics.OutputRoomEvent),
|
|
|
|
Consumer: kafkaConsumer,
|
|
|
|
PartitionStore: store,
|
|
|
|
}
|
|
|
|
s := &OutputRoomEventConsumer{
|
|
|
|
roomServerConsumer: &consumer,
|
|
|
|
db: store,
|
|
|
|
query: queryAPI,
|
2018-05-30 12:43:13 +00:00
|
|
|
alias: aliasAPI,
|
2018-05-24 12:54:42 +00:00
|
|
|
serverName: string(cfg.Matrix.ServerName),
|
|
|
|
}
|
|
|
|
consumer.ProcessMessage = s.onMessage
|
|
|
|
|
|
|
|
return s
|
|
|
|
}
|
|
|
|
|
|
|
|
// Start consuming from room servers
|
|
|
|
func (s *OutputRoomEventConsumer) Start() error {
|
|
|
|
return s.roomServerConsumer.Start()
|
|
|
|
}
|
|
|
|
|
|
|
|
// onMessage is called when the sync server receives a new event from the room server output log.
|
|
|
|
// It is not safe for this function to be called from multiple goroutines, or else the
|
|
|
|
// sync stream position may race and be incorrectly calculated.
|
|
|
|
func (s *OutputRoomEventConsumer) onMessage(msg *sarama.ConsumerMessage) error {
|
|
|
|
// Parse out the event JSON
|
|
|
|
var output api.OutputEvent
|
|
|
|
if err := json.Unmarshal(msg.Value, &output); err != nil {
|
|
|
|
// If the message was invalid, log it and move on to the next message in the stream
|
|
|
|
log.WithError(err).Errorf("roomserver output log: message parse failure")
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
if output.Type != api.OutputTypeNewRoomEvent {
|
|
|
|
log.WithField("type", output.Type).Debug(
|
|
|
|
"roomserver output log: ignoring unknown output type",
|
|
|
|
)
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
ev := output.NewRoomEvent.Event
|
|
|
|
log.WithFields(log.Fields{
|
|
|
|
"event_id": ev.EventID(),
|
|
|
|
"room_id": ev.RoomID(),
|
|
|
|
"type": ev.Type(),
|
|
|
|
}).Info("appservice received event from roomserver")
|
|
|
|
|
|
|
|
events, err := s.lookupStateEvents(output.NewRoomEvent.AddsStateEventIDs, ev)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2018-05-30 12:43:13 +00:00
|
|
|
// Create a context to thread through the whole filtering process
|
|
|
|
ctx := context.TODO()
|
|
|
|
|
|
|
|
if err = s.db.UpdateMemberships(ctx, events, output.NewRoomEvent.RemovesStateEventIDs); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
// Check if any events need to passed on to external application services
|
|
|
|
return s.filterRoomserverEvents(ctx, append(events, ev))
|
2018-05-24 12:54:42 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// lookupStateEvents looks up the state events that are added by a new event.
|
|
|
|
func (s *OutputRoomEventConsumer) lookupStateEvents(
|
|
|
|
addsStateEventIDs []string, event gomatrixserverlib.Event,
|
|
|
|
) ([]gomatrixserverlib.Event, error) {
|
|
|
|
// Fast path if there aren't any new state events.
|
|
|
|
if len(addsStateEventIDs) == 0 {
|
|
|
|
// If the event is a membership update (e.g. for a profile update), it won't
|
|
|
|
// show up in AddsStateEventIDs, so we need to add it manually
|
|
|
|
if event.Type() == "m.room.member" {
|
|
|
|
return []gomatrixserverlib.Event{event}, nil
|
|
|
|
}
|
|
|
|
return nil, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// Fast path if the only state event added is the event itself.
|
|
|
|
if len(addsStateEventIDs) == 1 && addsStateEventIDs[0] == event.EventID() {
|
|
|
|
return []gomatrixserverlib.Event{event}, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
result := []gomatrixserverlib.Event{}
|
|
|
|
missing := []string{}
|
|
|
|
for _, id := range addsStateEventIDs {
|
|
|
|
// Append the current event in the results if its ID is in the events list
|
|
|
|
if id == event.EventID() {
|
|
|
|
result = append(result, event)
|
|
|
|
} else {
|
|
|
|
// If the event isn't the current one, add it to the list of events
|
|
|
|
// to retrieve from the roomserver
|
|
|
|
missing = append(missing, id)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// Request the missing events from the roomserver
|
|
|
|
eventReq := api.QueryEventsByIDRequest{EventIDs: missing}
|
|
|
|
var eventResp api.QueryEventsByIDResponse
|
|
|
|
if err := s.query.QueryEventsByID(context.TODO(), &eventReq, &eventResp); err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
result = append(result, eventResp.Events...)
|
|
|
|
|
|
|
|
return result, nil
|
|
|
|
}
|
2018-05-30 12:43:13 +00:00
|
|
|
|
|
|
|
// filterRoomserverEvents takes in events and decides whether any of them need
|
|
|
|
// to be passed on to an external application service. It does this by checking
|
|
|
|
// each namespace of each registered application service, and if there is a
|
|
|
|
// match, adds the event to the queue for events to be sent to a particular
|
|
|
|
// application service.
|
|
|
|
func (s *OutputRoomEventConsumer) filterRoomserverEvents(ctx context.Context, events []gomatrixserverlib.Event) error {
|
|
|
|
for _, event := range events {
|
|
|
|
for _, appservice := range appServices {
|
|
|
|
// Check if this event is interesting to this application service
|
|
|
|
if s.appserviceIsInterestedInEvent(ctx, event, appservice) {
|
|
|
|
// TODO: Queue this event to be sent off to the application service
|
|
|
|
fmt.Println(appservice.ID, "was interested in", event.Sender(), event.Type(), event.RoomID())
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// appserviceIsInterestedInEvent returns a boolean depending on whether a given
|
|
|
|
// event falls within one of a given application service's namespaces.
|
|
|
|
func (s *OutputRoomEventConsumer) appserviceIsInterestedInEvent(ctx context.Context, event gomatrixserverlib.Event, appservice config.ApplicationService) bool {
|
|
|
|
// Check sender of the event
|
|
|
|
for _, userNamespace := range appservice.NamespaceMap["users"] {
|
|
|
|
if userNamespace.RegexpObject.MatchString(event.Sender()) {
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// Check room id of the event
|
|
|
|
for _, roomNamespace := range appservice.NamespaceMap["rooms"] {
|
|
|
|
if roomNamespace.RegexpObject.MatchString(event.RoomID()) {
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// Check all known room aliases of the room the event came from
|
|
|
|
queryReq := api.GetAliasesForRoomIDRequest{RoomID: event.RoomID()}
|
|
|
|
var queryRes api.GetAliasesForRoomIDResponse
|
|
|
|
if err := s.alias.GetAliasesForRoomID(ctx, &queryReq, &queryRes); err == nil {
|
|
|
|
for _, alias := range queryRes.Aliases {
|
|
|
|
for _, aliasNamespace := range appservice.NamespaceMap["aliases"] {
|
|
|
|
if aliasNamespace.RegexpObject.MatchString(alias) {
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
log.WithFields(log.Fields{
|
|
|
|
"room_id": event.RoomID(),
|
|
|
|
}).WithError(err).Errorf("Unable to get aliases for room")
|
|
|
|
}
|
|
|
|
|
|
|
|
return false
|
|
|
|
}
|