[WIP] Add Presence module

build/gobind-pinecone/monolith.go

@@ -309,7 +309,7 @@ func (m *DendriteMonolith) Start() {
 	rsAPI := roomserver.NewInternalAPI(base)
 
 	fsAPI := federationapi.NewInternalAPI(
-		base, federation, rsAPI, base.Caches, keyRing, true,
+		base, federation, rsAPI, m.userAPI, base.Caches, keyRing, true,
 	)
 
 	keyAPI := keyserver.NewInternalAPI(base, &base.Cfg.KeyServer, fsAPI)

build/gobind-yggdrasil/monolith.go

@@ -112,14 +112,14 @@ func (m *DendriteMonolith) Start() {
 
 	rsAPI := roomserver.NewInternalAPI(base)
 
-	fsAPI := federationapi.NewInternalAPI(
-		base, federation, rsAPI, base.Caches, keyRing, true,
-	)
-
 	keyAPI := keyserver.NewInternalAPI(base, &base.Cfg.KeyServer, federation)
 	userAPI := userapi.NewInternalAPI(accountDB, &cfg.UserAPI, cfg.Derived.ApplicationServices, keyAPI)
 	keyAPI.SetUserAPI(userAPI)
 
+	fsAPI := federationapi.NewInternalAPI(
+		base, federation, rsAPI, userAPI, base.Caches, keyRing, true,
+	)
+
 	eduInputAPI := eduserver.NewInternalAPI(
 		base, cache.New(), userAPI,
 	)

clientapi/routing/presence.go

@@ -0,0 +1,160 @@
+// Copyright 2021 The Matrix.org Foundation C.I.C.
+//
+// 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 routing
+
+import (
+	"encoding/json"
+	"fmt"
+	"io/ioutil"
+	"net/http"
+	"strings"
+	"time"
+
+	"github.com/matrix-org/dendrite/clientapi/jsonerror"
+	"github.com/matrix-org/dendrite/eduserver/api"
+	roomserverAPI "github.com/matrix-org/dendrite/roomserver/api"
+	userapi "github.com/matrix-org/dendrite/userapi/api"
+	"github.com/matrix-org/dendrite/userapi/types"
+	"github.com/matrix-org/gomatrixserverlib"
+	"github.com/matrix-org/util"
+	"github.com/sirupsen/logrus"
+)
+
+type presenceRequest struct {
+	Presence  string  `json:"presence"`
+	StatusMsg *string `json:"status_msg"`
+}
+
+// SetPresence updates the users presence status
+func SetPresence(req *http.Request,
+	eduAPI api.EDUServerInputAPI,
+	userAPI userapi.UserInternalAPI,
+	userID string,
+	device *userapi.Device,
+) util.JSONResponse {
+	if userID != device.UserID {
+		return util.JSONResponse{
+			Code: http.StatusForbidden,
+			JSON: jsonerror.Forbidden("You cannot set the presence state of another user."),
+		}
+	}
+	data, err := ioutil.ReadAll(req.Body)
+	if err != nil {
+		logrus.WithError(err).Error("unable to read request body")
+		return util.JSONResponse{
+			Code: http.StatusBadRequest,
+			JSON: jsonerror.BadJSON("The request body could not be read: " + err.Error()),
+		}
+	}
+	defer req.Body.Close() // nolint:errcheck
+
+	// parse the request
+	var r presenceRequest
+	err = json.Unmarshal(data, &r)
+	if err != nil {
+		logrus.WithError(err).Error("unable to unmarshal request body")
+		return util.JSONResponse{
+			Code: http.StatusBadRequest,
+			JSON: jsonerror.BadJSON("The request body could not be read: " + err.Error()),
+		}
+	}
+
+	p := strings.TrimSpace(strings.ToLower(r.Presence))
+	// requested new presence is not allowed by the spec
+	presence, ok := types.KnownPresence[p]
+	if !ok {
+		return util.JSONResponse{
+			Code: http.StatusBadRequest,
+			JSON: jsonerror.BadJSON(
+				fmt.Sprintf("The sent presence value '%s' is not allowed.", p),
+			),
+		}
+	}
+
+	lastActive := gomatrixserverlib.AsTimestamp(time.Now())
+	if err := api.SetPresence(req.Context(), eduAPI, userAPI, userID, r.StatusMsg, presence, lastActive); err != nil {
+		logrus.WithError(err).Error("failed to send presence to eduserver")
+		return util.ErrorResponse(err)
+	}
+
+	return util.JSONResponse{
+		Code: http.StatusOK,
+		JSON: struct{}{},
+	}
+}
+
+type presenceResponse struct {
+	Presence        string  `json:"presence"`
+	StatusMsg       *string `json:"status_msg,omitempty"`
+	LastActiveAgo   int64   `json:"last_active_ago,omitempty"`
+	CurrentlyActive bool    `json:"currently_active,omitempty"`
+}
+
+// GetPresence returns the presence status of a given user.
+// If the requesting user doesn't share a room with this user, the request is denied.
+func GetPresence(req *http.Request,
+	userAPI userapi.UserInternalAPI,
+	userID string,
+	rsAPI roomserverAPI.RoomserverInternalAPI,
+	device *userapi.Device,
+) util.JSONResponse {
+	// Only check allowance to see presence, if it's not our own user. (Otherwise sytest fails..)
+	if device.UserID != userID {
+		rsResp := roomserverAPI.QueryKnownUsersResponse{}
+		rsQry := roomserverAPI.QueryKnownUsersRequest{UserID: device.UserID, SearchString: userID, Limit: 2}
+		if err := rsAPI.QueryKnownUsers(req.Context(), &rsQry, &rsResp); err != nil {
+			return util.JSONResponse{
+				Code: http.StatusInternalServerError,
+				JSON: jsonerror.InternalServerError(),
+			}
+		}
+
+		// Users don't share a room, not allowed to see presence.
+		if len(rsResp.Users) == 0 {
+			return util.JSONResponse{
+				Code: http.StatusForbidden,
+				JSON: jsonerror.Forbidden("You cannot view the presence for this user."),
+			}
+		}
+	}
+
+	presence := userapi.QueryPresenceForUserResponse{}
+	qry := userapi.QueryPresenceForUserRequest{UserID: userID}
+	err := userAPI.QueryPresenceForUser(req.Context(), &qry, &presence)
+	if err != nil {
+		logrus.WithFields(logrus.Fields{
+			"userID": userID,
+		}).WithError(err).Error("unable to query presence")
+		// return an empty presence, to make sytest happy
+		return util.JSONResponse{
+			Code: http.StatusOK,
+			JSON: presence,
+		}
+	}
+
+	resp := presenceResponse{}
+	lastActive := time.Since(presence.LastActiveTS.Time())
+	resp.LastActiveAgo = lastActive.Milliseconds()
+	resp.StatusMsg = presence.StatusMsg
+	resp.CurrentlyActive = lastActive <= time.Minute*5
+	if !resp.CurrentlyActive {
+		presence.Presence = types.Unavailable
+	}
+	resp.Presence = presence.Presence.String()
+	return util.JSONResponse{
+		Code: http.StatusOK,
+		JSON: resp,
+	}
+}

clientapi/routing/routing.go

@@ -614,20 +614,6 @@ func Setup(
 		}),
 	).Methods(http.MethodPost, http.MethodOptions)
 
-	// Element logs get flooded unless this is handled
-	r0mux.Handle("/presence/{userID}/status",
-		httputil.MakeExternalAPI("presence", func(req *http.Request) util.JSONResponse {
-			if r := rateLimits.Limit(req); r != nil {
-				return *r
-			}
-			// TODO: Set presence (probably the responsibility of a presence server not clientapi)
-			return util.JSONResponse{
-				Code: http.StatusOK,
-				JSON: struct{}{},
-			}
-		}),
-	).Methods(http.MethodPut, http.MethodOptions)
-
 	r0mux.Handle("/voip/turnServer",
 		httputil.MakeAuthAPI("turn_server", userAPI, func(req *http.Request, device *userapi.Device) util.JSONResponse {
 			if r := rateLimits.Limit(req); r != nil {
@@ -1111,4 +1097,37 @@ func Setup(
 			return SetReceipt(req, eduAPI, device, vars["roomId"], vars["receiptType"], vars["eventId"])
 		}),
 	).Methods(http.MethodPost, http.MethodOptions)
+	r0mux.Handle("/presence/{userId}/status",
+		httputil.MakeAuthAPI("set_presence", userAPI, func(req *http.Request, device *userapi.Device) util.JSONResponse {
+			if r := rateLimits.Limit(req); r != nil {
+				return *r
+			}
+			if !cfg.Matrix.PresenceEnabled {
+				return util.JSONResponse{
+					Code: http.StatusOK,
+					JSON: struct{}{},
+				}
+			}
+			vars, err := httputil.URLDecodeMapValues(mux.Vars(req))
+			if err != nil {
+				return util.ErrorResponse(err)
+			}
+			return SetPresence(req, eduAPI, userAPI, vars["userId"], device)
+		}),
+	).Methods(http.MethodPut, http.MethodOptions)
+	r0mux.Handle("/presence/{userId}/status",
+		httputil.MakeAuthAPI("get_presence", userAPI, func(req *http.Request, device *userapi.Device) util.JSONResponse {
+			vars, err := httputil.URLDecodeMapValues(mux.Vars(req))
+			if err != nil {
+				return util.ErrorResponse(err)
+			}
+			if !cfg.Matrix.PresenceEnabled {
+				return util.JSONResponse{
+					Code: http.StatusOK,
+					JSON: struct{}{},
+				}
+			}
+			return GetPresence(req, userAPI, vars["userId"], rsAPI, device)
+		}),
+	).Methods(http.MethodGet, http.MethodOptions)
 }

cmd/dendrite-demo-libp2p/main.go

@@ -157,7 +157,7 @@ func main() {
 	asAPI := appservice.NewInternalAPI(&base.Base, userAPI, rsAPI)
 	rsAPI.SetAppserviceAPI(asAPI)
 	fsAPI := federationapi.NewInternalAPI(
-		&base.Base, federation, rsAPI, base.Base.Caches, nil, true,
+		&base.Base, federation, rsAPI, userAPI, base.Base.Caches, nil, true,
 	)
 	keyRing := fsAPI.KeyRing()
 	rsAPI.SetFederationAPI(fsAPI, keyRing)

cmd/dendrite-demo-pinecone/main.go

@@ -184,12 +184,13 @@ func main() {
 	rsComponent := roomserver.NewInternalAPI(base)
 	rsAPI := rsComponent
 	fsAPI := federationapi.NewInternalAPI(
-		base, federation, rsAPI, base.Caches, keyRing, true,
+		base, federation, rsAPI, nil, base.Caches, keyRing, true,
 	)
 
 	keyAPI := keyserver.NewInternalAPI(base, &base.Cfg.KeyServer, fsAPI)
 	userAPI := userapi.NewInternalAPI(accountDB, &cfg.UserAPI, nil, keyAPI)
 	keyAPI.SetUserAPI(userAPI)
+	fsAPI.SetUserAPI(userAPI)
 
 	eduInputAPI := eduserver.NewInternalAPI(
 		base, cache.New(), userAPI,

cmd/dendrite-demo-yggdrasil/main.go

@@ -117,7 +117,7 @@ func main() {
 	asAPI := appservice.NewInternalAPI(base, userAPI, rsAPI)
 	rsAPI.SetAppserviceAPI(asAPI)
 	fsAPI := federationapi.NewInternalAPI(
-		base, federation, rsAPI, base.Caches, keyRing, true,
+		base, federation, rsAPI, userAPI, base.Caches, keyRing, true,
 	)
 
 	rsComponent.SetFederationAPI(fsAPI, keyRing)

cmd/dendrite-monolith-server/main.go

@@ -91,7 +91,7 @@ func main() {
 	}
 
 	fsAPI := federationapi.NewInternalAPI(
-		base, federation, rsAPI, base.Caches, nil, false,
+		base, federation, rsAPI, nil, base.Caches, nil, false,
 	)
 	if base.UseHTTPAPIs {
 		federationapi.AddInternalRoutes(base.InternalAPIMux, fsAPI)
@@ -133,6 +133,7 @@ func main() {
 	rsImpl.SetFederationAPI(fsAPI, keyRing)
 	rsImpl.SetAppserviceAPI(asAPI)
 	keyImpl.SetUserAPI(userAPI)
+	fsAPI.SetUserAPI(userAPI)
 
 	eduInputAPI := eduserver.NewInternalAPI(
 		base, cache.New(), userAPI,

cmd/dendrite-polylith-multi/personalities/federationapi.go

@@ -25,7 +25,7 @@ func FederationAPI(base *basepkg.BaseDendrite, cfg *config.Dendrite) {
 	federation := base.CreateFederationClient()
 	rsAPI := base.RoomserverHTTPClient()
 	keyAPI := base.KeyServerHTTPClient()
-	fsAPI := federationapi.NewInternalAPI(base, federation, rsAPI, base.Caches, nil, true)
+	fsAPI := federationapi.NewInternalAPI(base, federation, rsAPI, userAPI, base.Caches, nil, true)
 	keyRing := fsAPI.KeyRing()
 
 	federationapi.AddPublicRoutes(

cmd/dendritejs-pinecone/main.go

@@ -197,7 +197,8 @@ func startup() {
 		base, userAPI, rsAPI,
 	)
 	rsAPI.SetAppserviceAPI(asQuery)
-	fedSenderAPI := federationapi.NewInternalAPI(base, federation, rsAPI, base.Caches, keyRing, true)
+
+	fedSenderAPI := federationapi.NewInternalAPI(base, federation, rsAPI, userAPI, base.Caches, keyRing, true)
 	rsAPI.SetFederationAPI(fedSenderAPI, keyRing)
 
 	monolith := setup.Monolith{

dendrite-config.yaml

@@ -48,6 +48,9 @@ global:
   # - private_key: old_matrix_key.pem
   #   expired_at: 1601024554498
 
+  # Enable/Disable presence. Enabling presence might cause a high load on your server.
+  presence_enabled: false
+
   # How long a remote server can cache our server signing key before requesting it
   # again. Increasing this number will reduce the number of requests made by other
   # servers for our key but increases the period that a compromised key will be
@@ -341,6 +344,11 @@ user_api:
     max_open_conns: 10
     max_idle_conns: 2
     conn_max_lifetime: -1
+  presence_database:
+    connection_string: file:userapi_presence.db
+    max_open_conns: 10
+    max_idle_conns: 2
+    conn_max_lifetime: -1
   # The length of time that a token issued for a relying party from 
   # /_matrix/client/r0/user/{userId}/openid/request_token endpoint
   # is considered to be valid in milliseconds. 

eduserver/api/input.go

@@ -20,6 +20,8 @@ package api
 import (
 	"context"
 
+	types2 "github.com/matrix-org/dendrite/syncapi/types"
+	"github.com/matrix-org/dendrite/userapi/types"
 	"github.com/matrix-org/gomatrixserverlib"
 )
 
@@ -75,6 +77,18 @@ type InputReceiptEventRequest struct {
 // InputReceiptEventResponse is a response to InputReceiptEventRequest
 type InputReceiptEventResponse struct{}
 
+// InputPresenceRequest is a request to EDUServerInputAPI
+type InputPresenceRequest struct {
+	UserID       string                      `json:"user_id"`
+	Presence     types.PresenceStatus        `json:"status"`
+	StatusMsg    *string                     `json:"status_msg"`
+	LastActiveTS gomatrixserverlib.Timestamp `json:"last_active_ts"`
+	StreamPos    types2.StreamPosition       `json:"stream_pos"`
+}
+
+// InputPresenceResponse is a response to InputPresenceRequest
+type InputPresenceResponse struct{}
+
 type InputCrossSigningKeyUpdateRequest struct {
 	CrossSigningKeyUpdate `json:"signing_keys"`
 }
@@ -101,6 +115,12 @@ type EDUServerInputAPI interface {
 		response *InputReceiptEventResponse,
 	) error
 
+	InputPresence(
+		ctx context.Context,
+		request *InputPresenceRequest,
+		response *InputPresenceResponse,
+	) error
+
 	InputCrossSigningKeyUpdate(
 		ctx context.Context,
 		request *InputCrossSigningKeyUpdateRequest,