MatrixSynapse/synapse/federation/persistence.py

96 lines
3.0 KiB
Python
Raw Normal View History

2014-08-12 16:10:52 +02:00
# -*- coding: utf-8 -*-
2016-01-07 05:26:29 +01:00
# Copyright 2014-2016 OpenMarket Ltd
2014-08-12 16:10:52 +02: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.
2014-08-12 16:10:52 +02:00
""" This module contains all the persistence actions done by the federation
package.
These actions are mostly only used by the :py:mod:`.replication` module.
"""
2018-07-09 08:09:20 +02:00
import logging
2014-08-12 16:10:52 +02:00
from twisted.internet import defer
from synapse.util.logutils import log_function
logger = logging.getLogger(__name__)
class TransactionActions(object):
""" Defines persistence actions that relate to handling Transactions.
"""
def __init__(self, datastore):
self.store = datastore
@log_function
def have_responded(self, origin, transaction):
2014-08-12 16:10:52 +02:00
""" Have we already responded to a transaction with the same id and
origin?
Returns:
Deferred: Results in `None` if we have not previously responded to
this transaction or a 2-tuple of `(int, dict)` representing the
response code and response body.
"""
if not transaction.transaction_id:
2019-06-20 11:32:02 +02:00
raise RuntimeError("Cannot persist a transaction with no " "transaction_id")
2014-08-12 16:10:52 +02:00
2019-06-20 11:32:02 +02:00
return self.store.get_received_txn_response(transaction.transaction_id, origin)
2014-08-12 16:10:52 +02:00
@log_function
def set_response(self, origin, transaction, code, response):
2014-08-12 16:10:52 +02:00
""" Persist how we responded to a transaction.
Returns:
Deferred
"""
if not transaction.transaction_id:
2019-06-20 11:32:02 +02:00
raise RuntimeError("Cannot persist a transaction with no " "transaction_id")
2014-08-12 16:10:52 +02:00
return self.store.set_received_txn_response(
2019-06-20 11:32:02 +02:00
transaction.transaction_id, origin, code, response
2014-08-12 16:10:52 +02:00
)
@defer.inlineCallbacks
@log_function
def prepare_to_send(self, transaction):
""" Persists the `Transaction` we are about to send and works out the
correct value for the `prev_ids` key.
Returns:
Deferred
"""
transaction.prev_ids = yield self.store.prep_send_transaction(
transaction.transaction_id,
transaction.destination,
transaction.origin_server_ts,
2014-08-12 16:10:52 +02:00
)
@log_function
def delivered(self, transaction, response_code, response_dict):
""" Marks the given `Transaction` as having been successfully
delivered to the remote homeserver, and what the response was.
Returns:
Deferred
"""
return self.store.delivered_txn(
transaction.transaction_id,
transaction.destination,
response_code,
2015-05-05 19:20:01 +02:00
response_dict,
2014-08-12 16:10:52 +02:00
)