replace admin_email with admin_uri for greater flexibility

synapse/api/auth.py

@@ -786,8 +786,8 @@ class Auth(object):
         if self.hs.config.hs_disabled:
             raise AuthError(
                 403, self.hs.config.hs_disabled_message,
-                errcode=Codes.HS_DISABLED,
-                admin_email=self.hs.config.admin_email,
+                errcode=Codes.RESOURCE_LIMIT_EXCEED,
+                admin_uri=self.hs.config.admin_uri,
             )
         if self.hs.config.limit_usage_by_mau is True:
             # If the user is already part of the MAU cohort
@@ -799,7 +799,7 @@ class Auth(object):
             current_mau = yield self.store.get_monthly_active_count()
             if current_mau >= self.hs.config.max_mau_value:
                 raise AuthError(
-                    403, "MAU Limit Exceeded",
-                    admin_email=self.hs.config.admin_email,
-                    errcode=Codes.MAU_LIMIT_EXCEEDED
+                    403, "Monthly Active User Limits AU Limit Exceeded",
+                    admin_uri=self.hs.config.admin_uri,
+                    errcode=Codes.RESOURCE_LIMIT_EXCEED
                 )

synapse/api/errors.py

@@ -228,7 +228,7 @@ class AuthError(SynapseError):
     def __init__(self, *args, **kwargs):
         if "errcode" not in kwargs:
             kwargs["errcode"] = Codes.FORBIDDEN
-        self.admin_email = kwargs.get('admin_email')
+        self.admin_uri = kwargs.get('admin_uri')
         self.msg = kwargs.get('msg')
         self.errcode = kwargs.get('errcode')
         super(AuthError, self).__init__(*args, errcode=kwargs["errcode"])
@@ -237,7 +237,7 @@ class AuthError(SynapseError):
         return cs_error(
             self.msg,
             self.errcode,
-            admin_email=self.admin_email,
+            admin_uri=self.admin_uri,
         )
 
 

synapse/config/server.py

@@ -84,7 +84,7 @@ class ServerConfig(Config):
 
         # Admin email to direct users at should their instance become blocked
         # due to resource constraints
-        self.admin_email = config.get("admin_email", None)
+        self.admin_uri = config.get("admin_uri", None)
 
         # FIXME: federation_domain_whitelist needs sytests
         self.federation_domain_whitelist = None

tests/api/test_auth.py

@@ -457,7 +457,7 @@ class AuthTestCase(unittest.TestCase):
 
         with self.assertRaises(AuthError) as e:
             yield self.auth.check_auth_blocking()
-        self.assertEquals(e.exception.admin_email, self.hs.config.admin_email)
+        self.assertEquals(e.exception.admin_uri, self.hs.config.admin_uri)
         self.assertEquals(e.exception.errcode, Codes.MAU_LIMIT_EXCEEDED)
         self.assertEquals(e.exception.code, 403)
 
@@ -473,6 +473,6 @@ class AuthTestCase(unittest.TestCase):
         self.hs.config.hs_disabled_message = "Reason for being disabled"
         with self.assertRaises(AuthError) as e:
             yield self.auth.check_auth_blocking()
-        self.assertEquals(e.exception.admin_email, self.hs.config.admin_email)
+        self.assertEquals(e.exception.admin_uri, self.hs.config.admin_uri)
         self.assertEquals(e.exception.errcode, Codes.HS_DISABLED)
         self.assertEquals(e.exception.code, 403)

tests/utils.py

@@ -139,7 +139,7 @@ def setup_test_homeserver(
         config.hs_disabled_message = ""
         config.max_mau_value = 50
         config.mau_limits_reserved_threepids = []
-        config.admin_email = None
+        config.admin_uri = None
 
         # we need a sane default_room_version, otherwise attempts to create rooms will
         # fail.