123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126 |
- # -*- 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.
- """ Defines the JSON structure of the protocol units used by the server to
- server protocol.
- """
- import logging
- from synapse.util.jsonobject import JsonEncodedObject
- logger = logging.getLogger(__name__)
- class Edu(JsonEncodedObject):
- """ An Edu represents a piece of data sent from one homeserver to another.
- In comparison to Pdus, Edus are not persisted for a long time on disk, are
- not meaningful beyond a given pair of homeservers, and don't have an
- internal ID or previous references graph.
- """
- valid_keys = [
- "origin",
- "destination",
- "edu_type",
- "content",
- ]
- required_keys = [
- "edu_type",
- ]
- internal_keys = [
- "origin",
- "destination",
- ]
- class Transaction(JsonEncodedObject):
- """ A transaction is a list of Pdus and Edus to be sent to a remote home
- server with some extra metadata.
- Example transaction::
- {
- "origin": "foo",
- "prev_ids": ["abc", "def"],
- "pdus": [
- ...
- ],
- }
- """
- valid_keys = [
- "transaction_id",
- "origin",
- "destination",
- "origin_server_ts",
- "previous_ids",
- "pdus",
- "edus",
- "pdu_failures",
- ]
- internal_keys = [
- "transaction_id",
- "destination",
- ]
- required_keys = [
- "transaction_id",
- "origin",
- "destination",
- "origin_server_ts",
- "pdus",
- ]
- def __init__(self, transaction_id=None, pdus=[], **kwargs):
- """ If we include a list of pdus then we decode then as PDU's
- automatically.
- """
- # If there's no EDUs then remove the arg
- if "edus" in kwargs and not kwargs["edus"]:
- del kwargs["edus"]
- super(Transaction, self).__init__(
- transaction_id=transaction_id,
- pdus=pdus,
- **kwargs
- )
- @staticmethod
- def create_new(pdus, **kwargs):
- """ Used to create a new transaction. Will auto fill out
- transaction_id and origin_server_ts keys.
- """
- if "origin_server_ts" not in kwargs:
- raise KeyError(
- "Require 'origin_server_ts' to construct a Transaction"
- )
- if "transaction_id" not in kwargs:
- raise KeyError(
- "Require 'transaction_id' to construct a Transaction"
- )
- for p in pdus:
- p.transaction_id = kwargs["transaction_id"]
- kwargs["pdus"] = [p.get_pdu_json() for p in pdus]
- return Transaction(**kwargs)
|