Hitting save help

changelog.d/5666.feature

@@ -0,0 +1 @@
+Support m.presence in the capabilities API for MSC1862.

synapse/rest/client/v1/presence.py

@@ -45,6 +45,9 @@ class PresenceStatusRestServlet(RestServlet):
         requester = yield self.auth.get_user_by_req(request)
         user = UserID.from_string(user_id)
 
+        if not self.hs.config.use_presence:
+            raise AuthError(403, "Presence is disabled on this homeserver")
+
         if requester.user != user:
             allowed = yield self.presence_handler.is_visible(
                 observed_user=user, observer_user=requester.user
@@ -63,6 +66,9 @@ class PresenceStatusRestServlet(RestServlet):
         requester = yield self.auth.get_user_by_req(request)
         user = UserID.from_string(user_id)
 
+        if not self.hs.config.use_presence:
+            raise AuthError(403, "Presence is disabled on this homeserver")
+
         if requester.user != user:
             raise AuthError(403, "Can only set your own presence state")
 
@@ -85,8 +91,7 @@ class PresenceStatusRestServlet(RestServlet):
         except Exception:
             raise SynapseError(400, "Unable to parse state")
 
-        if self.hs.config.use_presence:
-            yield self.presence_handler.set_state(user, state)
+        yield self.presence_handler.set_state(user, state)
 
         defer.returnValue((200, {}))
 

synapse/rest/client/v2_alpha/capabilities.py

@@ -56,6 +56,10 @@ class CapabilitiesRestServlet(RestServlet):
                     },
                 },
                 "m.change_password": {"enabled": change_password},
+                "m.presence": {
+                    "send_enabled": self.config.use_presence,
+                    "receive_enabled": self.config.use_presence,
+                },
             }
         }
         defer.returnValue((200, response))

tests/rest/client/v1/test_presence.py

@@ -68,5 +68,33 @@ class PresenceTestCase(unittest.HomeserverTestCase):
         )
         self.render(request)
 
-        self.assertEqual(channel.code, 200)
+        self.assertEqual(channel.code, 403)
+        self.assertEqual(
+            {
+                "errcode": "M_FORBIDDEN",
+                "error": "Presence is disabled on this homeserver",
+            },
+            channel.json_body,
+        )
         self.assertEqual(self.hs.presence_handler.set_state.call_count, 0)
+
+    def test_get_presence_disabled(self):
+        """
+        GET to the status endpoint with use_presence disbled will respond
+        with M_FORBIDDEN
+        """
+        self.hs.config.use_presence = False
+
+        request, channel = self.make_request(
+            "GET", "/presence/%s/status" % (self.user_id,)
+        )
+        self.render(request)
+
+        self.assertEqual(channel.code, 403)
+        self.assertEqual(
+            {
+                "errcode": "M_FORBIDDEN",
+                "error": "Presence is disabled on this homeserver",
+            },
+            channel.json_body,
+        )

tests/rest/client/v2_alpha/test_capabilities.py

@@ -79,3 +79,25 @@ class CapabilitiesTestCase(unittest.HomeserverTestCase):
 
         self.assertEqual(channel.code, 200)
         self.assertFalse(capabilities["m.change_password"]["enabled"])
+
+    def test_get_presence(self):
+        self.register_user("user", "pass")
+        access_token = self.login("user", "pass")
+
+        self.hs.get_config().use_presence = True
+        request, channel = self.make_request("GET", self.url, access_token=access_token)
+        self.render(request)
+        capabilities = channel.json_body["capabilities"]
+        self.assertEqual(channel.code, 200)
+
+        self.assertEqual(True, capabilities["m.presence"]["send_enabled"])
+        self.assertEqual(True, capabilities["m.presence"]["receive_enabled"])
+
+        self.hs.get_config().use_presence = False
+        request, channel = self.make_request("GET", self.url, access_token=access_token)
+        self.render(request)
+        capabilities = channel.json_body["capabilities"]
+        self.assertEqual(channel.code, 200)
+
+        self.assertEqual(False, capabilities["m.presence"]["send_enabled"])
+        self.assertEqual(False, capabilities["m.presence"]["receive_enabled"])