2014-08-12 10:10:52 -04:00
|
|
|
# -*- coding: utf-8 -*-
|
2016-01-06 23:26:29 -05:00
|
|
|
# Copyright 2014-2016 OpenMarket Ltd
|
2014-08-12 10:10:52 -04:00
|
|
|
#
|
|
|
|
# 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.
|
2020-08-26 07:19:32 -04:00
|
|
|
from typing import Any, Dict, Optional
|
2014-08-12 22:14:34 -04:00
|
|
|
|
2017-11-29 20:17:15 -05:00
|
|
|
from synapse.api.errors import StoreError
|
2019-10-21 07:56:42 -04:00
|
|
|
from synapse.storage._base import SQLBaseStore
|
2020-08-05 16:38:57 -04:00
|
|
|
from synapse.storage.databases.main.roommember import ProfileInfo
|
2014-08-12 10:10:52 -04:00
|
|
|
|
|
|
|
|
2018-03-13 13:36:50 -04:00
|
|
|
class ProfileWorkerStore(SQLBaseStore):
|
2020-08-26 07:19:32 -04:00
|
|
|
async def get_profileinfo(self, user_localpart: str) -> ProfileInfo:
|
2017-11-29 20:17:15 -05:00
|
|
|
try:
|
2020-08-12 09:28:48 -04:00
|
|
|
profile = await self.db_pool.simple_select_one(
|
2017-11-29 20:17:15 -05:00
|
|
|
table="profiles",
|
|
|
|
keyvalues={"user_id": user_localpart},
|
|
|
|
retcols=("displayname", "avatar_url"),
|
|
|
|
desc="get_profileinfo",
|
|
|
|
)
|
2017-12-05 06:09:31 -05:00
|
|
|
except StoreError as e:
|
2017-11-29 20:17:15 -05:00
|
|
|
if e.code == 404:
|
|
|
|
# no match
|
2019-07-23 09:00:55 -04:00
|
|
|
return ProfileInfo(None, None)
|
2017-11-29 20:17:15 -05:00
|
|
|
else:
|
|
|
|
raise
|
|
|
|
|
2019-07-23 09:00:55 -04:00
|
|
|
return ProfileInfo(
|
|
|
|
avatar_url=profile["avatar_url"], display_name=profile["displayname"]
|
2017-11-29 13:27:05 -05:00
|
|
|
)
|
|
|
|
|
2020-08-26 07:19:32 -04:00
|
|
|
async def get_profile_displayname(self, user_localpart: str) -> str:
|
|
|
|
return await self.db_pool.simple_select_one_onecol(
|
2014-08-12 10:10:52 -04:00
|
|
|
table="profiles",
|
|
|
|
keyvalues={"user_id": user_localpart},
|
|
|
|
retcol="displayname",
|
2015-03-20 11:59:18 -04:00
|
|
|
desc="get_profile_displayname",
|
2014-08-12 10:10:52 -04:00
|
|
|
)
|
|
|
|
|
2020-08-26 07:19:32 -04:00
|
|
|
async def get_profile_avatar_url(self, user_localpart: str) -> str:
|
|
|
|
return await self.db_pool.simple_select_one_onecol(
|
2014-08-12 10:10:52 -04:00
|
|
|
table="profiles",
|
|
|
|
keyvalues={"user_id": user_localpart},
|
|
|
|
retcol="avatar_url",
|
2015-03-20 11:59:18 -04:00
|
|
|
desc="get_profile_avatar_url",
|
2014-08-12 10:10:52 -04:00
|
|
|
)
|
|
|
|
|
2020-08-26 07:19:32 -04:00
|
|
|
async def get_from_remote_profile_cache(
|
|
|
|
self, user_id: str
|
|
|
|
) -> Optional[Dict[str, Any]]:
|
|
|
|
return await self.db_pool.simple_select_one(
|
2017-08-25 06:21:34 -04:00
|
|
|
table="remote_profile_cache",
|
|
|
|
keyvalues={"user_id": user_id},
|
2019-04-03 05:07:29 -04:00
|
|
|
retcols=("displayname", "avatar_url"),
|
2017-08-25 06:21:34 -04:00
|
|
|
allow_none=True,
|
|
|
|
desc="get_from_remote_profile_cache",
|
2018-03-13 13:36:50 -04:00
|
|
|
)
|
|
|
|
|
|
|
|
def create_profile(self, user_localpart):
|
2020-08-05 16:38:57 -04:00
|
|
|
return self.db_pool.simple_insert(
|
2019-04-03 05:07:29 -04:00
|
|
|
table="profiles", values={"user_id": user_localpart}, desc="create_profile"
|
2018-03-13 13:36:50 -04:00
|
|
|
)
|
|
|
|
|
2020-08-27 07:08:38 -04:00
|
|
|
async def set_profile_displayname(
|
|
|
|
self, user_localpart: str, new_displayname: str
|
|
|
|
) -> None:
|
|
|
|
await self.db_pool.simple_update_one(
|
2018-03-13 13:36:50 -04:00
|
|
|
table="profiles",
|
|
|
|
keyvalues={"user_id": user_localpart},
|
|
|
|
updatevalues={"displayname": new_displayname},
|
|
|
|
desc="set_profile_displayname",
|
|
|
|
)
|
|
|
|
|
2020-08-27 07:08:38 -04:00
|
|
|
async def set_profile_avatar_url(
|
|
|
|
self, user_localpart: str, new_avatar_url: str
|
|
|
|
) -> None:
|
|
|
|
await self.db_pool.simple_update_one(
|
2018-03-13 13:36:50 -04:00
|
|
|
table="profiles",
|
|
|
|
keyvalues={"user_id": user_localpart},
|
|
|
|
updatevalues={"avatar_url": new_avatar_url},
|
|
|
|
desc="set_profile_avatar_url",
|
2017-08-25 06:21:34 -04:00
|
|
|
)
|
|
|
|
|
2018-08-17 06:37:42 -04:00
|
|
|
|
|
|
|
class ProfileStore(ProfileWorkerStore):
|
2017-08-25 06:21:34 -04:00
|
|
|
def add_remote_profile_cache(self, user_id, displayname, avatar_url):
|
|
|
|
"""Ensure we are caching the remote user's profiles.
|
|
|
|
|
|
|
|
This should only be called when `is_subscribed_remote_profile_for_user`
|
|
|
|
would return true for the user.
|
|
|
|
"""
|
2020-08-05 16:38:57 -04:00
|
|
|
return self.db_pool.simple_upsert(
|
2017-08-25 06:21:34 -04:00
|
|
|
table="remote_profile_cache",
|
|
|
|
keyvalues={"user_id": user_id},
|
|
|
|
values={
|
|
|
|
"displayname": displayname,
|
|
|
|
"avatar_url": avatar_url,
|
|
|
|
"last_check": self._clock.time_msec(),
|
|
|
|
},
|
|
|
|
desc="add_remote_profile_cache",
|
|
|
|
)
|
|
|
|
|
2020-08-27 07:08:38 -04:00
|
|
|
async def update_remote_profile_cache(
|
|
|
|
self, user_id: str, displayname: str, avatar_url: str
|
|
|
|
) -> int:
|
|
|
|
return await self.db_pool.simple_update(
|
2017-08-25 06:21:34 -04:00
|
|
|
table="remote_profile_cache",
|
|
|
|
keyvalues={"user_id": user_id},
|
2020-05-15 11:17:12 -04:00
|
|
|
updatevalues={
|
2017-08-25 06:21:34 -04:00
|
|
|
"displayname": displayname,
|
|
|
|
"avatar_url": avatar_url,
|
|
|
|
"last_check": self._clock.time_msec(),
|
|
|
|
},
|
|
|
|
desc="update_remote_profile_cache",
|
|
|
|
)
|
|
|
|
|
2020-08-12 09:28:48 -04:00
|
|
|
async def maybe_delete_remote_profile_cache(self, user_id):
|
2017-08-25 06:21:34 -04:00
|
|
|
"""Check if we still care about the remote user's profile, and if we
|
|
|
|
don't then remove their profile from the cache
|
|
|
|
"""
|
2020-08-12 09:28:48 -04:00
|
|
|
subscribed = await self.is_subscribed_remote_profile_for_user(user_id)
|
2017-08-25 06:21:34 -04:00
|
|
|
if not subscribed:
|
2020-08-12 09:28:48 -04:00
|
|
|
await self.db_pool.simple_delete(
|
2017-08-25 06:21:34 -04:00
|
|
|
table="remote_profile_cache",
|
|
|
|
keyvalues={"user_id": user_id},
|
|
|
|
desc="delete_remote_profile_cache",
|
|
|
|
)
|
|
|
|
|
|
|
|
def get_remote_profile_cache_entries_that_expire(self, last_checked):
|
|
|
|
"""Get all users who haven't been checked since `last_checked`
|
|
|
|
"""
|
2019-04-03 05:07:29 -04:00
|
|
|
|
2017-08-25 06:21:34 -04:00
|
|
|
def _get_remote_profile_cache_entries_that_expire_txn(txn):
|
|
|
|
sql = """
|
|
|
|
SELECT user_id, displayname, avatar_url
|
|
|
|
FROM remote_profile_cache
|
|
|
|
WHERE last_check < ?
|
|
|
|
"""
|
|
|
|
|
|
|
|
txn.execute(sql, (last_checked,))
|
|
|
|
|
2020-08-05 16:38:57 -04:00
|
|
|
return self.db_pool.cursor_to_dict(txn)
|
2017-08-25 06:21:34 -04:00
|
|
|
|
2020-08-05 16:38:57 -04:00
|
|
|
return self.db_pool.runInteraction(
|
2017-08-25 06:21:34 -04:00
|
|
|
"get_remote_profile_cache_entries_that_expire",
|
|
|
|
_get_remote_profile_cache_entries_that_expire_txn,
|
|
|
|
)
|
|
|
|
|
2020-08-12 09:28:48 -04:00
|
|
|
async def is_subscribed_remote_profile_for_user(self, user_id):
|
2017-08-25 06:21:34 -04:00
|
|
|
"""Check whether we are interested in a remote user's profile.
|
|
|
|
"""
|
2020-08-12 09:28:48 -04:00
|
|
|
res = await self.db_pool.simple_select_one_onecol(
|
2017-08-25 06:21:34 -04:00
|
|
|
table="group_users",
|
|
|
|
keyvalues={"user_id": user_id},
|
|
|
|
retcol="user_id",
|
|
|
|
allow_none=True,
|
|
|
|
desc="should_update_remote_profile_cache_for_user",
|
|
|
|
)
|
|
|
|
|
|
|
|
if res:
|
2019-07-23 09:00:55 -04:00
|
|
|
return True
|
2017-08-25 06:21:34 -04:00
|
|
|
|
2020-08-12 09:28:48 -04:00
|
|
|
res = await self.db_pool.simple_select_one_onecol(
|
2017-08-25 06:21:34 -04:00
|
|
|
table="group_invites",
|
|
|
|
keyvalues={"user_id": user_id},
|
|
|
|
retcol="user_id",
|
|
|
|
allow_none=True,
|
|
|
|
desc="should_update_remote_profile_cache_for_user",
|
|
|
|
)
|
|
|
|
|
|
|
|
if res:
|
2019-07-23 09:00:55 -04:00
|
|
|
return True
|