mirror of
https://mau.dev/maunium/synapse.git
synced 2024-10-01 01:36:05 -04:00
105 lines
3.2 KiB
Python
105 lines
3.2 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright 2014, 2015 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.
|
|
|
|
""" This module contains all the persistence actions done by the federation
|
|
package.
|
|
|
|
These actions are mostly only used by the :py:mod:`.replication` module.
|
|
"""
|
|
|
|
from twisted.internet import defer
|
|
|
|
from synapse.util.logutils import log_function
|
|
|
|
import json
|
|
import logging
|
|
|
|
|
|
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, transaction):
|
|
""" 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:
|
|
raise RuntimeError("Cannot persist a transaction with no "
|
|
"transaction_id")
|
|
|
|
return self.store.get_received_txn_response(
|
|
transaction.transaction_id, transaction.origin
|
|
)
|
|
|
|
@log_function
|
|
def set_response(self, transaction, code, response):
|
|
""" Persist how we responded to a transaction.
|
|
|
|
Returns:
|
|
Deferred
|
|
"""
|
|
if not transaction.transaction_id:
|
|
raise RuntimeError("Cannot persist a transaction with no "
|
|
"transaction_id")
|
|
|
|
return self.store.set_received_txn_response(
|
|
transaction.transaction_id,
|
|
transaction.origin,
|
|
code,
|
|
json.dumps(response)
|
|
)
|
|
|
|
@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,
|
|
)
|
|
|
|
@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,
|
|
json.dumps(response_dict)
|
|
)
|