Add possibility to ignore users (#2329)

* Add ignore users

* Ignore users in pushrules
Add passing tests

* Update sytest lists

* Store ignore knowledge in the sync API

* Fix copyrights

Co-authored-by: Neil Alexander <neilalexander@users.noreply.github.com>

syncapi/streams/stream_invite.go

@@ -54,6 +54,10 @@ func (p *InviteStreamProvider) IncrementalSync(
 	}
 
 	for roomID, inviteEvent := range invites {
+		// skip ignored user events
+		if _, ok := req.IgnoredUsers.List[inviteEvent.Sender()]; ok {
+			continue
+		}
 		ir := types.NewInviteResponse(inviteEvent)
 		req.Response.Rooms.Invite[roomID] = *ir
 	}

syncapi/streams/stream_pdu.go

@@ -2,6 +2,7 @@ package streams
 
 import (
 	"context"
+	"database/sql"
 	"sync"
 	"time"
 
@@ -25,6 +26,7 @@ type PDUStreamProvider struct {
 
 	tasks   chan func()
 	workers atomic.Int32
+	userAPI userapi.UserInternalAPI
 }
 
 func (p *PDUStreamProvider) worker() {
@@ -87,6 +89,10 @@ func (p *PDUStreamProvider) CompleteSync(
 	stateFilter := req.Filter.Room.State
 	eventFilter := req.Filter.Room.Timeline
 
+	if err = p.addIgnoredUsersToFilter(ctx, req, &eventFilter); err != nil {
+		req.Log.WithError(err).Error("unable to update event filter with ignored users")
+	}
+
 	// Build up a /sync response. Add joined rooms.
 	var reqMutex sync.Mutex
 	var reqWaitGroup sync.WaitGroup
@@ -175,6 +181,10 @@ func (p *PDUStreamProvider) IncrementalSync(
 		return to
 	}
 
+	if err = p.addIgnoredUsersToFilter(ctx, req, &eventFilter); err != nil {
+		req.Log.WithError(err).Error("unable to update event filter with ignored users")
+	}
+
 	newPos = from
 	for _, delta := range stateDeltas {
 		var pos types.StreamPosition
@@ -402,6 +412,23 @@ func (p *PDUStreamProvider) getJoinResponseForCompleteSync(
 	return jr, nil
 }
 
+// addIgnoredUsersToFilter adds ignored users to the eventfilter and
+// the syncreq itself for further use in streams.
+func (p *PDUStreamProvider) addIgnoredUsersToFilter(ctx context.Context, req *types.SyncRequest, eventFilter *gomatrixserverlib.RoomEventFilter) error {
+	ignores, err := p.DB.IgnoresForUser(ctx, req.Device.UserID)
+	if err != nil {
+		if err == sql.ErrNoRows {
+			return nil
+		}
+		return err
+	}
+	req.IgnoredUsers = *ignores
+	for userID := range ignores.List {
+		eventFilter.NotSenders = append(eventFilter.NotSenders, userID)
+	}
+	return nil
+}
+
 func removeDuplicates(stateEvents, recentEvents []*gomatrixserverlib.HeaderedEvent) []*gomatrixserverlib.HeaderedEvent {
 	for _, recentEv := range recentEvents {
 		if recentEv.StateKey() == nil {

syncapi/streams/stream_receipt.go

@@ -54,6 +54,10 @@ func (p *ReceiptStreamProvider) IncrementalSync(
 	// Group receipts by room, so we can create one ClientEvent for every room
 	receiptsByRoom := make(map[string][]types.OutputReceiptEvent)
 	for _, receipt := range receipts {
+		// skip ignored user events
+		if _, ok := req.IgnoredUsers.List[receipt.UserID]; ok {
+			continue
+		}
 		receiptsByRoom[receipt.RoomID] = append(receiptsByRoom[receipt.RoomID], receipt)
 	}
 

syncapi/streams/stream_sendtodevice.go

@@ -48,6 +48,10 @@ func (p *SendToDeviceStreamProvider) IncrementalSync(
 
 		// Add the updates into the sync response.
 		for _, event := range events {
+			// skip ignored user events
+			if _, ok := req.IgnoredUsers.List[event.Sender]; ok {
+				continue
+			}
 			req.Response.ToDevice.Events = append(req.Response.ToDevice.Events, event.SendToDeviceEvent)
 		}
 	}

syncapi/streams/stream_typing.go

@@ -40,11 +40,18 @@ func (p *TypingStreamProvider) IncrementalSync(
 		if users, updated := p.EDUCache.GetTypingUsersIfUpdatedAfter(
 			roomID, int64(from),
 		); updated {
+			typingUsers := make([]string, 0, len(users))
+			for i := range users {
+				// skip ignored user events
+				if _, ok := req.IgnoredUsers.List[users[i]]; !ok {
+					typingUsers = append(typingUsers, users[i])
+				}
+			}
 			ev := gomatrixserverlib.ClientEvent{
 				Type: gomatrixserverlib.MTyping,
 			}
 			ev.Content, err = json.Marshal(map[string]interface{}{
-				"user_ids": users,
+				"user_ids": typingUsers,
 			})
 			if err != nil {
 				req.Log.WithError(err).Error("json.Marshal failed")

syncapi/streams/streams.go

@@ -32,6 +32,7 @@ func NewSyncStreamProviders(
 	streams := &Streams{
 		PDUStreamProvider: &PDUStreamProvider{
 			StreamProvider: StreamProvider{DB: d},
+			userAPI:        userAPI,
 		},
 		TypingStreamProvider: &TypingStreamProvider{
 			StreamProvider: StreamProvider{DB: d},