diff --git a/synapse/events/__init__.py b/synapse/events/__init__.py
new file mode 100644
index 0000000000..34b1b944ab
--- /dev/null
+++ b/synapse/events/__init__.py
@@ -0,0 +1,149 @@
+# -*- coding: utf-8 -*-
+# Copyright 2014 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 synapse.util.frozenutils import freeze, unfreeze
+
+import copy
+
+
+class _EventInternalMetadata(object):
+ def __init__(self, internal_metadata_dict):
+ self.__dict__ = copy.deepcopy(internal_metadata_dict)
+
+ def get_dict(self):
+ return dict(self.__dict__)
+
+ def is_outlier(self):
+ return hasattr(self, "outlier") and self.outlier
+
+
+def _event_dict_property(key):
+ def getter(self):
+ return self._event_dict[key]
+
+ def setter(self, v):
+ self._event_dict[key] = v
+
+ def delete(self):
+ del self._event_dict[key]
+
+ return property(
+ getter,
+ setter,
+ delete,
+ )
+
+
+class EventBase(object):
+ def __init__(self, event_dict, signatures={}, unsigned={},
+ internal_metadata_dict={}):
+ self.signatures = copy.deepcopy(signatures)
+ self.unsigned = copy.deepcopy(unsigned)
+
+ self._event_dict = copy.deepcopy(event_dict)
+
+ self.internal_metadata = _EventInternalMetadata(
+ internal_metadata_dict
+ )
+
+ auth_events = _event_dict_property("auth_events")
+ depth = _event_dict_property("depth")
+ content = _event_dict_property("content")
+ event_id = _event_dict_property("event_id")
+ hashes = _event_dict_property("hashes")
+ origin = _event_dict_property("origin")
+ origin_server_ts = _event_dict_property("origin_server_ts")
+ prev_events = _event_dict_property("prev_events")
+ prev_state = _event_dict_property("prev_state")
+ redacts = _event_dict_property("redacts")
+ room_id = _event_dict_property("room_id")
+ sender = _event_dict_property("sender")
+ state_key = _event_dict_property("state_key")
+ type = _event_dict_property("type")
+ user_id = _event_dict_property("sender")
+
+ @property
+ def membership(self):
+ return self.content["membership"]
+
+ def is_state(self):
+ return hasattr(self, "state_key")
+
+ def get_dict(self):
+ d = dict(self._event_dict)
+ d.update({
+ "signatures": self.signatures,
+ "unsigned": self.unsigned,
+ })
+
+ return d
+
+ def get(self, key, default):
+ return self._event_dict.get(key, default)
+
+ def get_internal_metadata_dict(self):
+ return self.internal_metadata.get_dict()
+
+ def get_pdu_json(self, time_now=None):
+ pdu_json = self.get_dict()
+
+ if time_now is not None and "age_ts" in pdu_json["unsigned"]:
+ age = time_now - pdu_json["unsigned"]["age_ts"]
+ pdu_json.setdefault("unsigned", {})["age"] = int(age)
+ del pdu_json["unsigned"]["age_ts"]
+
+ return pdu_json
+
+ def __set__(self, instance, value):
+ raise AttributeError("Unrecognized attribute %s" % (instance,))
+
+
+class FrozenEvent(EventBase):
+ def __init__(self, event_dict, internal_metadata_dict={}):
+ event_dict = copy.deepcopy(event_dict)
+
+ signatures = copy.deepcopy(event_dict.pop("signatures", {}))
+ unsigned = copy.deepcopy(event_dict.pop("unsigned", {}))
+
+ frozen_dict = freeze(event_dict)
+
+ super(FrozenEvent, self).__init__(
+ frozen_dict,
+ signatures=signatures,
+ unsigned=unsigned,
+ internal_metadata_dict=internal_metadata_dict,
+ )
+
+ @staticmethod
+ def from_event(event):
+ e = FrozenEvent(
+ event.get_pdu_json()
+ )
+
+ e.internal_metadata = event.internal_metadata
+
+ return e
+
+ def get_dict(self):
+ # We need to unfreeze what we return
+ return unfreeze(super(FrozenEvent, self).get_dict())
+
+ def __str__(self):
+ return self.__repr__()
+
+ def __repr__(self):
+ return "<FrozenEvent event_id='%s', type='%s', state_key='%s'>" % (
+ self.event_id, self.type, self.get("state_key", None),
+ )
|
