mirror of
https://git.anonymousland.org/anonymousland/synapse.git
synced 2024-09-07 11:02:20 +00:00
Implement trail users
This commit is contained in:
parent
242a0483eb
commit
cd77270a66
@ -797,11 +797,15 @@ class Auth(object):
|
|||||||
limit_type=self.hs.config.hs_disabled_limit_type
|
limit_type=self.hs.config.hs_disabled_limit_type
|
||||||
)
|
)
|
||||||
if self.hs.config.limit_usage_by_mau is True:
|
if self.hs.config.limit_usage_by_mau is True:
|
||||||
# If the user is already part of the MAU cohort
|
# If the user is already part of the MAU cohort or a trial user
|
||||||
if user_id:
|
if user_id:
|
||||||
timestamp = yield self.store.user_last_seen_monthly_active(user_id)
|
timestamp = yield self.store.user_last_seen_monthly_active(user_id)
|
||||||
if timestamp:
|
if timestamp:
|
||||||
return
|
return
|
||||||
|
|
||||||
|
is_trial = yield self.store.is_trial_user(user_id)
|
||||||
|
if is_trial:
|
||||||
|
return
|
||||||
# Else if there is no room in the MAU bucket, bail
|
# Else if there is no room in the MAU bucket, bail
|
||||||
current_mau = yield self.store.get_monthly_active_count()
|
current_mau = yield self.store.get_monthly_active_count()
|
||||||
if current_mau >= self.hs.config.max_mau_value:
|
if current_mau >= self.hs.config.max_mau_value:
|
||||||
|
@ -77,10 +77,15 @@ class ServerConfig(Config):
|
|||||||
self.max_mau_value = config.get(
|
self.max_mau_value = config.get(
|
||||||
"max_mau_value", 0,
|
"max_mau_value", 0,
|
||||||
)
|
)
|
||||||
|
|
||||||
self.mau_limits_reserved_threepids = config.get(
|
self.mau_limits_reserved_threepids = config.get(
|
||||||
"mau_limit_reserved_threepids", []
|
"mau_limit_reserved_threepids", []
|
||||||
)
|
)
|
||||||
|
|
||||||
|
self.mau_trial_days = config.get(
|
||||||
|
"mau_trial_days", 0,
|
||||||
|
)
|
||||||
|
|
||||||
# Options to disable HS
|
# Options to disable HS
|
||||||
self.hs_disabled = config.get("hs_disabled", False)
|
self.hs_disabled = config.get("hs_disabled", False)
|
||||||
self.hs_disabled_message = config.get("hs_disabled_message", "")
|
self.hs_disabled_message = config.get("hs_disabled_message", "")
|
||||||
@ -365,6 +370,7 @@ class ServerConfig(Config):
|
|||||||
# Enables monthly active user checking
|
# Enables monthly active user checking
|
||||||
# limit_usage_by_mau: False
|
# limit_usage_by_mau: False
|
||||||
# max_mau_value: 50
|
# max_mau_value: 50
|
||||||
|
# mau_trial_days: 2
|
||||||
#
|
#
|
||||||
# Sometimes the server admin will want to ensure certain accounts are
|
# Sometimes the server admin will want to ensure certain accounts are
|
||||||
# never blocked by mau checking. These accounts are specified here.
|
# never blocked by mau checking. These accounts are specified here.
|
||||||
|
@ -201,6 +201,11 @@ class MonthlyActiveUsersStore(SQLBaseStore):
|
|||||||
user_id(str): the user_id to query
|
user_id(str): the user_id to query
|
||||||
"""
|
"""
|
||||||
if self.hs.config.limit_usage_by_mau:
|
if self.hs.config.limit_usage_by_mau:
|
||||||
|
is_trial = yield self.is_trial_user(user_id)
|
||||||
|
if is_trial:
|
||||||
|
# we don't track trial users in the MAU table.
|
||||||
|
return
|
||||||
|
|
||||||
last_seen_timestamp = yield self.user_last_seen_monthly_active(user_id)
|
last_seen_timestamp = yield self.user_last_seen_monthly_active(user_id)
|
||||||
now = self.hs.get_clock().time_msec()
|
now = self.hs.get_clock().time_msec()
|
||||||
|
|
||||||
|
@ -26,6 +26,11 @@ from synapse.util.caches.descriptors import cached, cachedInlineCallbacks
|
|||||||
|
|
||||||
|
|
||||||
class RegistrationWorkerStore(SQLBaseStore):
|
class RegistrationWorkerStore(SQLBaseStore):
|
||||||
|
def __init__(self, db_conn, hs):
|
||||||
|
super(RegistrationWorkerStore, self).__init__(db_conn, hs)
|
||||||
|
|
||||||
|
self.config = hs.config
|
||||||
|
|
||||||
@cached()
|
@cached()
|
||||||
def get_user_by_id(self, user_id):
|
def get_user_by_id(self, user_id):
|
||||||
return self._simple_select_one(
|
return self._simple_select_one(
|
||||||
@ -36,12 +41,33 @@ class RegistrationWorkerStore(SQLBaseStore):
|
|||||||
retcols=[
|
retcols=[
|
||||||
"name", "password_hash", "is_guest",
|
"name", "password_hash", "is_guest",
|
||||||
"consent_version", "consent_server_notice_sent",
|
"consent_version", "consent_server_notice_sent",
|
||||||
"appservice_id",
|
"appservice_id", "creation_ts",
|
||||||
],
|
],
|
||||||
allow_none=True,
|
allow_none=True,
|
||||||
desc="get_user_by_id",
|
desc="get_user_by_id",
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@defer.inlineCallbacks
|
||||||
|
def is_trial_user(self, user_id):
|
||||||
|
"""Checks if user is in the "trial" period, i.e. within the first
|
||||||
|
N days of registration defined by `mau_trial_days` config
|
||||||
|
|
||||||
|
Args:
|
||||||
|
user_id (str)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Deferred[bool]
|
||||||
|
"""
|
||||||
|
|
||||||
|
info = yield self.get_user_by_id(user_id)
|
||||||
|
if not info:
|
||||||
|
defer.returnValue(False)
|
||||||
|
|
||||||
|
now = self.clock.time_msec()
|
||||||
|
trial_duration_ms = self.config.mau_trial_days * 24 * 60 * 60 * 1000
|
||||||
|
is_trial = (now - info["creation_ts"] * 1000) < trial_duration_ms
|
||||||
|
defer.returnValue(is_trial)
|
||||||
|
|
||||||
@cached()
|
@cached()
|
||||||
def get_user_by_access_token(self, token):
|
def get_user_by_access_token(self, token):
|
||||||
"""Get a user from the given access token.
|
"""Get a user from the given access token.
|
||||||
|
@ -46,6 +46,7 @@ class RegistrationStoreTestCase(unittest.TestCase):
|
|||||||
"consent_version": None,
|
"consent_version": None,
|
||||||
"consent_server_notice_sent": None,
|
"consent_server_notice_sent": None,
|
||||||
"appservice_id": None,
|
"appservice_id": None,
|
||||||
|
"creation_ts": 1000,
|
||||||
},
|
},
|
||||||
(yield self.store.get_user_by_id(self.user_id)),
|
(yield self.store.get_user_by_id(self.user_id)),
|
||||||
)
|
)
|
||||||
|
Loading…
Reference in New Issue
Block a user