123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369 |
- # -*- coding: utf-8 -*-
- # Copyright 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.
- import logging
- import ujson
- from twisted.internet import defer
- from ._base import SQLBaseStore
- logger = logging.getLogger(__name__)
- class DeviceInboxStore(SQLBaseStore):
- @defer.inlineCallbacks
- def add_messages_to_device_inbox(self, local_messages_by_user_then_device,
- remote_messages_by_destination):
- """Used to send messages from this server.
- Args:
- sender_user_id(str): The ID of the user sending these messages.
- local_messages_by_user_and_device(dict):
- Dictionary of user_id to device_id to message.
- remote_messages_by_destination(dict):
- Dictionary of destination server_name to the EDU JSON to send.
- Returns:
- A deferred stream_id that resolves when the messages have been
- inserted.
- """
- def add_messages_txn(txn, now_ms, stream_id):
- # Add the local messages directly to the local inbox.
- self._add_messages_to_local_device_inbox_txn(
- txn, stream_id, local_messages_by_user_then_device
- )
- # Add the remote messages to the federation outbox.
- # We'll send them to a remote server when we next send a
- # federation transaction to that destination.
- sql = (
- "INSERT INTO device_federation_outbox"
- " (destination, stream_id, queued_ts, messages_json)"
- " VALUES (?,?,?,?)"
- )
- rows = []
- for destination, edu in remote_messages_by_destination.items():
- edu_json = ujson.dumps(edu)
- rows.append((destination, stream_id, now_ms, edu_json))
- txn.executemany(sql, rows)
- with self._device_inbox_id_gen.get_next() as stream_id:
- now_ms = self.clock.time_msec()
- yield self.runInteraction(
- "add_messages_to_device_inbox",
- add_messages_txn,
- now_ms,
- stream_id,
- )
- for user_id in local_messages_by_user_then_device.keys():
- self._device_inbox_stream_cache.entity_has_changed(
- user_id, stream_id
- )
- for destination in remote_messages_by_destination.keys():
- self._device_federation_outbox_stream_cache.entity_has_changed(
- destination, stream_id
- )
- defer.returnValue(self._device_inbox_id_gen.get_current_token())
- @defer.inlineCallbacks
- def add_messages_from_remote_to_device_inbox(
- self, origin, message_id, local_messages_by_user_then_device
- ):
- def add_messages_txn(txn, now_ms, stream_id):
- # Check if we've already inserted a matching message_id for that
- # origin. This can happen if the origin doesn't receive our
- # acknowledgement from the first time we received the message.
- already_inserted = self._simple_select_one_txn(
- txn, table="device_federation_inbox",
- keyvalues={"origin": origin, "message_id": message_id},
- retcols=("message_id",),
- allow_none=True,
- )
- if already_inserted is not None:
- return
- # Add an entry for this message_id so that we know we've processed
- # it.
- self._simple_insert_txn(
- txn, table="device_federation_inbox",
- values={
- "origin": origin,
- "message_id": message_id,
- "received_ts": now_ms,
- },
- )
- # Add the messages to the approriate local device inboxes so that
- # they'll be sent to the devices when they next sync.
- self._add_messages_to_local_device_inbox_txn(
- txn, stream_id, local_messages_by_user_then_device
- )
- with self._device_inbox_id_gen.get_next() as stream_id:
- now_ms = self.clock.time_msec()
- yield self.runInteraction(
- "add_messages_from_remote_to_device_inbox",
- add_messages_txn,
- now_ms,
- stream_id,
- )
- for user_id in local_messages_by_user_then_device.keys():
- self._device_inbox_stream_cache.entity_has_changed(
- user_id, stream_id
- )
- defer.returnValue(stream_id)
- def _add_messages_to_local_device_inbox_txn(self, txn, stream_id,
- messages_by_user_then_device):
- sql = (
- "UPDATE device_max_stream_id"
- " SET stream_id = ?"
- " WHERE stream_id < ?"
- )
- txn.execute(sql, (stream_id, stream_id))
- local_by_user_then_device = {}
- for user_id, messages_by_device in messages_by_user_then_device.items():
- messages_json_for_user = {}
- devices = messages_by_device.keys()
- if len(devices) == 1 and devices[0] == "*":
- # Handle wildcard device_ids.
- sql = (
- "SELECT device_id FROM devices"
- " WHERE user_id = ?"
- )
- txn.execute(sql, (user_id,))
- message_json = ujson.dumps(messages_by_device["*"])
- for row in txn.fetchall():
- # Add the message for all devices for this user on this
- # server.
- device = row[0]
- messages_json_for_user[device] = message_json
- else:
- if not devices:
- continue
- sql = (
- "SELECT device_id FROM devices"
- " WHERE user_id = ? AND device_id IN ("
- + ",".join("?" * len(devices))
- + ")"
- )
- # TODO: Maybe this needs to be done in batches if there are
- # too many local devices for a given user.
- txn.execute(sql, [user_id] + devices)
- for row in txn.fetchall():
- # Only insert into the local inbox if the device exists on
- # this server
- device = row[0]
- message_json = ujson.dumps(messages_by_device[device])
- messages_json_for_user[device] = message_json
- if messages_json_for_user:
- local_by_user_then_device[user_id] = messages_json_for_user
- if not local_by_user_then_device:
- return
- sql = (
- "INSERT INTO device_inbox"
- " (user_id, device_id, stream_id, message_json)"
- " VALUES (?,?,?,?)"
- )
- rows = []
- for user_id, messages_by_device in local_by_user_then_device.items():
- for device_id, message_json in messages_by_device.items():
- rows.append((user_id, device_id, stream_id, message_json))
- txn.executemany(sql, rows)
- def get_new_messages_for_device(
- self, user_id, device_id, last_stream_id, current_stream_id, limit=100
- ):
- """
- Args:
- user_id(str): The recipient user_id.
- device_id(str): The recipient device_id.
- current_stream_id(int): The current position of the to device
- message stream.
- Returns:
- Deferred ([dict], int): List of messages for the device and where
- in the stream the messages got to.
- """
- has_changed = self._device_inbox_stream_cache.has_entity_changed(
- user_id, last_stream_id
- )
- if not has_changed:
- return defer.succeed(([], current_stream_id))
- def get_new_messages_for_device_txn(txn):
- sql = (
- "SELECT stream_id, message_json FROM device_inbox"
- " WHERE user_id = ? AND device_id = ?"
- " AND ? < stream_id AND stream_id <= ?"
- " ORDER BY stream_id ASC"
- " LIMIT ?"
- )
- txn.execute(sql, (
- user_id, device_id, last_stream_id, current_stream_id, limit
- ))
- messages = []
- for row in txn.fetchall():
- stream_pos = row[0]
- messages.append(ujson.loads(row[1]))
- if len(messages) < limit:
- stream_pos = current_stream_id
- return (messages, stream_pos)
- return self.runInteraction(
- "get_new_messages_for_device", get_new_messages_for_device_txn,
- )
- def delete_messages_for_device(self, user_id, device_id, up_to_stream_id):
- """
- Args:
- user_id(str): The recipient user_id.
- device_id(str): The recipient device_id.
- up_to_stream_id(int): Where to delete messages up to.
- Returns:
- A deferred that resolves when the messages have been deleted.
- """
- def delete_messages_for_device_txn(txn):
- sql = (
- "DELETE FROM device_inbox"
- " WHERE user_id = ? AND device_id = ?"
- " AND stream_id <= ?"
- )
- txn.execute(sql, (user_id, device_id, up_to_stream_id))
- return self.runInteraction(
- "delete_messages_for_device", delete_messages_for_device_txn
- )
- def get_all_new_device_messages(self, last_pos, current_pos, limit):
- """
- Args:
- last_pos(int):
- current_pos(int):
- limit(int):
- Returns:
- A deferred list of rows from the device inbox
- """
- if last_pos == current_pos:
- return defer.succeed([])
- def get_all_new_device_messages_txn(txn):
- # We limit like this as we might have multiple rows per stream_id, and
- # we want to make sure we always get all entries for any stream_id
- # we return.
- upper_pos = min(current_pos, last_pos + limit)
- sql = (
- "SELECT stream_id, user_id"
- " FROM device_inbox"
- " WHERE ? < stream_id AND stream_id <= ?"
- " ORDER BY stream_id ASC"
- )
- txn.execute(sql, (last_pos, upper_pos))
- rows = txn.fetchall()
- sql = (
- "SELECT stream_id, destination"
- " FROM device_federation_outbox"
- " WHERE ? < stream_id AND stream_id <= ?"
- " ORDER BY stream_id ASC"
- )
- txn.execute(sql, (last_pos, upper_pos))
- rows.extend(txn.fetchall())
- return rows
- return self.runInteraction(
- "get_all_new_device_messages", get_all_new_device_messages_txn
- )
- def get_to_device_stream_token(self):
- return self._device_inbox_id_gen.get_current_token()
- def get_new_device_msgs_for_remote(
- self, destination, last_stream_id, current_stream_id, limit=100
- ):
- """
- Args:
- destination(str): The name of the remote server.
- last_stream_id(int): The last position of the device message stream
- that the server sent up to.
- current_stream_id(int): The current position of the device
- message stream.
- Returns:
- Deferred ([dict], int): List of messages for the device and where
- in the stream the messages got to.
- """
- has_changed = self._device_federation_outbox_stream_cache.has_entity_changed(
- destination, last_stream_id
- )
- if not has_changed or last_stream_id == current_stream_id:
- return defer.succeed(([], current_stream_id))
- def get_new_messages_for_remote_destination_txn(txn):
- sql = (
- "SELECT stream_id, messages_json FROM device_federation_outbox"
- " WHERE destination = ?"
- " AND ? < stream_id AND stream_id <= ?"
- " ORDER BY stream_id ASC"
- " LIMIT ?"
- )
- txn.execute(sql, (
- destination, last_stream_id, current_stream_id, limit
- ))
- messages = []
- for row in txn.fetchall():
- stream_pos = row[0]
- messages.append(ujson.loads(row[1]))
- if len(messages) < limit:
- stream_pos = current_stream_id
- return (messages, stream_pos)
- return self.runInteraction(
- "get_new_device_msgs_for_remote",
- get_new_messages_for_remote_destination_txn,
- )
- def delete_device_msgs_for_remote(self, destination, up_to_stream_id):
- """Used to delete messages when the remote destination acknowledges
- their receipt.
- Args:
- destination(str): The destination server_name
- up_to_stream_id(int): Where to delete messages up to.
- Returns:
- A deferred that resolves when the messages have been deleted.
- """
- def delete_messages_for_remote_destination_txn(txn):
- sql = (
- "DELETE FROM device_federation_outbox"
- " WHERE destination = ?"
- " AND stream_id <= ?"
- )
- txn.execute(sql, (destination, up_to_stream_id))
- return self.runInteraction(
- "delete_device_msgs_for_remote",
- delete_messages_for_remote_destination_txn
- )
|