mirror of
https://git.anonymousland.org/anonymousland/synapse-product.git
synced 2024-10-01 08:25:44 -04:00
217 lines
7.4 KiB
Python
217 lines
7.4 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright 2014-2016 OpenMarket Ltd
|
|
#
|
|
# 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.
|
|
|
|
from ._base import SQLBaseStore
|
|
from synapse.util.caches.descriptors import cached
|
|
from twisted.internet import defer
|
|
from .util.id_generators import StreamIdGenerator
|
|
|
|
import ujson as json
|
|
import logging
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class TagsStore(SQLBaseStore):
|
|
def __init__(self, hs):
|
|
super(TagsStore, self).__init__(hs)
|
|
|
|
self._account_data_id_gen = StreamIdGenerator(
|
|
"account_data_max_stream_id", "stream_id"
|
|
)
|
|
|
|
def get_max_account_data_stream_id(self):
|
|
"""Get the current max stream id for the private user data stream
|
|
|
|
Returns:
|
|
A deferred int.
|
|
"""
|
|
return self._account_data_id_gen.get_max_token(self)
|
|
|
|
@cached()
|
|
def get_tags_for_user(self, user_id):
|
|
"""Get all the tags for a user.
|
|
|
|
|
|
Args:
|
|
user_id(str): The user to get the tags for.
|
|
Returns:
|
|
A deferred dict mapping from room_id strings to dicts mapping from
|
|
tag strings to tag content.
|
|
"""
|
|
|
|
deferred = self._simple_select_list(
|
|
"room_tags", {"user_id": user_id}, ["room_id", "tag", "content"]
|
|
)
|
|
|
|
@deferred.addCallback
|
|
def tags_by_room(rows):
|
|
tags_by_room = {}
|
|
for row in rows:
|
|
room_tags = tags_by_room.setdefault(row["room_id"], {})
|
|
room_tags[row["tag"]] = json.loads(row["content"])
|
|
return tags_by_room
|
|
|
|
return deferred
|
|
|
|
@defer.inlineCallbacks
|
|
def get_updated_tags(self, user_id, stream_id):
|
|
"""Get all the tags for the rooms where the tags have changed since the
|
|
given version
|
|
|
|
Args:
|
|
user_id(str): The user to get the tags for.
|
|
stream_id(int): The earliest update to get for the user.
|
|
Returns:
|
|
A deferred dict mapping from room_id strings to lists of tag
|
|
strings for all the rooms that changed since the stream_id token.
|
|
"""
|
|
def get_updated_tags_txn(txn):
|
|
sql = (
|
|
"SELECT room_id from room_tags_revisions"
|
|
" WHERE user_id = ? AND stream_id > ?"
|
|
)
|
|
txn.execute(sql, (user_id, stream_id))
|
|
room_ids = [row[0] for row in txn.fetchall()]
|
|
return room_ids
|
|
|
|
room_ids = yield self.runInteraction(
|
|
"get_updated_tags", get_updated_tags_txn
|
|
)
|
|
|
|
results = {}
|
|
if room_ids:
|
|
tags_by_room = yield self.get_tags_for_user(user_id)
|
|
for room_id in room_ids:
|
|
results[room_id] = tags_by_room.get(room_id, {})
|
|
|
|
defer.returnValue(results)
|
|
|
|
def get_tags_for_room(self, user_id, room_id):
|
|
"""Get all the tags for the given room
|
|
Args:
|
|
user_id(str): The user to get tags for
|
|
room_id(str): The room to get tags for
|
|
Returns:
|
|
A deferred list of string tags.
|
|
"""
|
|
return self._simple_select_list(
|
|
table="room_tags",
|
|
keyvalues={"user_id": user_id, "room_id": room_id},
|
|
retcols=("tag", "content"),
|
|
desc="get_tags_for_room",
|
|
).addCallback(lambda rows: {
|
|
row["tag"]: json.loads(row["content"]) for row in rows
|
|
})
|
|
|
|
@defer.inlineCallbacks
|
|
def add_tag_to_room(self, user_id, room_id, tag, content):
|
|
"""Add a tag to a room for a user.
|
|
Args:
|
|
user_id(str): The user to add a tag for.
|
|
room_id(str): The room to add a tag for.
|
|
tag(str): The tag name to add.
|
|
content(dict): A json object to associate with the tag.
|
|
Returns:
|
|
A deferred that completes once the tag has been added.
|
|
"""
|
|
content_json = json.dumps(content)
|
|
|
|
def add_tag_txn(txn, next_id):
|
|
self._simple_upsert_txn(
|
|
txn,
|
|
table="room_tags",
|
|
keyvalues={
|
|
"user_id": user_id,
|
|
"room_id": room_id,
|
|
"tag": tag,
|
|
},
|
|
values={
|
|
"content": content_json,
|
|
}
|
|
)
|
|
self._update_revision_txn(txn, user_id, room_id, next_id)
|
|
|
|
with (yield self._account_data_id_gen.get_next(self)) as next_id:
|
|
yield self.runInteraction("add_tag", add_tag_txn, next_id)
|
|
|
|
self.get_tags_for_user.invalidate((user_id,))
|
|
|
|
result = yield self._account_data_id_gen.get_max_token(self)
|
|
defer.returnValue(result)
|
|
|
|
@defer.inlineCallbacks
|
|
def remove_tag_from_room(self, user_id, room_id, tag):
|
|
"""Remove a tag from a room for a user.
|
|
Returns:
|
|
A deferred that completes once the tag has been removed
|
|
"""
|
|
def remove_tag_txn(txn, next_id):
|
|
sql = (
|
|
"DELETE FROM room_tags "
|
|
" WHERE user_id = ? AND room_id = ? AND tag = ?"
|
|
)
|
|
txn.execute(sql, (user_id, room_id, tag))
|
|
self._update_revision_txn(txn, user_id, room_id, next_id)
|
|
|
|
with (yield self._account_data_id_gen.get_next(self)) as next_id:
|
|
yield self.runInteraction("remove_tag", remove_tag_txn, next_id)
|
|
|
|
self.get_tags_for_user.invalidate((user_id,))
|
|
|
|
result = yield self._account_data_id_gen.get_max_token(self)
|
|
defer.returnValue(result)
|
|
|
|
def _update_revision_txn(self, txn, user_id, room_id, next_id):
|
|
"""Update the latest revision of the tags for the given user and room.
|
|
|
|
Args:
|
|
txn: The database cursor
|
|
user_id(str): The ID of the user.
|
|
room_id(str): The ID of the room.
|
|
next_id(int): The the revision to advance to.
|
|
"""
|
|
|
|
update_max_id_sql = (
|
|
"UPDATE account_data_max_stream_id"
|
|
" SET stream_id = ?"
|
|
" WHERE stream_id < ?"
|
|
)
|
|
txn.execute(update_max_id_sql, (next_id, next_id))
|
|
|
|
update_sql = (
|
|
"UPDATE room_tags_revisions"
|
|
" SET stream_id = ?"
|
|
" WHERE user_id = ?"
|
|
" AND room_id = ?"
|
|
)
|
|
txn.execute(update_sql, (next_id, user_id, room_id))
|
|
|
|
if txn.rowcount == 0:
|
|
insert_sql = (
|
|
"INSERT INTO room_tags_revisions (user_id, room_id, stream_id)"
|
|
" VALUES (?, ?, ?)"
|
|
)
|
|
try:
|
|
txn.execute(insert_sql, (user_id, room_id, next_id))
|
|
except self.database_engine.module.IntegrityError:
|
|
# Ignore insertion errors. It doesn't matter if the row wasn't
|
|
# inserted because if two updates happend concurrently the one
|
|
# with the higher stream_id will not be reported to a client
|
|
# unless the previous update has completed. It doesn't matter
|
|
# which stream_id ends up in the table, as long as it is higher
|
|
# than the id that the client has.
|
|
pass
|