From cf6e5f1dbf3cecf693e45f293535e71ee31801ed Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Mon, 15 Dec 2014 17:01:12 +0000
Subject: Rename MessageHandler.handle_event. Add a few comments.

---
 synapse/handlers/_base.py     |  5 +++++
 synapse/handlers/directory.py |  2 +-
 synapse/handlers/message.py   | 14 +++++++++++++-
 synapse/handlers/profile.py   |  2 +-
 synapse/handlers/room.py      |  8 ++++----
 5 files changed, 24 insertions(+), 7 deletions(-)

(limited to 'synapse/handlers')

diff --git a/synapse/handlers/_base.py b/synapse/handlers/_base.py
index 14f75ecbc2..af8eb5f0f5 100644
--- a/synapse/handlers/_base.py
+++ b/synapse/handlers/_base.py
@@ -122,10 +122,15 @@ class BaseHandler(object):
             if event.content["membership"] == Membership.INVITE:
                 invitee = self.hs.parse_userid(event.state_key)
                 if not self.hs.is_mine(invitee):
+                    # TODO: Can we add signature from remote server in a nicer
+                    # way? If we have been invited by a remote server, we need
+                    # to get them to sign the event.
                     returned_invite = yield federation_handler.send_invite(
                         invitee.domain,
                         event,
                     )
+
+                    # TODO: Make sure the signatures actually are correct.
                     event.signatures.update(
                         returned_invite.signatures
                     )
diff --git a/synapse/handlers/directory.py b/synapse/handlers/directory.py
index 76fb897f20..4b0869cd9f 100644
--- a/synapse/handlers/directory.py
+++ b/synapse/handlers/directory.py
@@ -149,7 +149,7 @@ class DirectoryHandler(BaseHandler):
         aliases = yield self.store.get_aliases_for_room(room_id)
 
         msg_handler = self.hs.get_handlers().message_handler
-        yield msg_handler.handle_event({
+        yield msg_handler.create_and_send_event({
             "type": RoomAliasesEvent.TYPE,
             "state_key": self.hs.hostname,
             "room_id": room_id,
diff --git a/synapse/handlers/message.py b/synapse/handlers/message.py
index 4fa4ffea25..1eed38c6d1 100644
--- a/synapse/handlers/message.py
+++ b/synapse/handlers/message.py
@@ -138,7 +138,19 @@ class MessageHandler(BaseHandler):
         defer.returnValue(chunk)
 
     @defer.inlineCallbacks
-    def handle_event(self, event_dict):
+    def create_and_send_event(self, event_dict):
+        """ Given a dict from a client, create and handle a new event.
+
+        Creates an FrozenEvent object, filling out auth_events, prev_events,
+        etc.
+
+        Adds display names to Join membership events.
+
+        Persists and notifies local clients and federation.
+
+        Args:
+            event_dict (dict): An entire event
+        """
         builder = self.event_builder_factory.new(event_dict)
 
         self.validator.validate_new(builder)
diff --git a/synapse/handlers/profile.py b/synapse/handlers/profile.py
index 18fd0914e2..33a2c167ec 100644
--- a/synapse/handlers/profile.py
+++ b/synapse/handlers/profile.py
@@ -209,7 +209,7 @@ class ProfileHandler(BaseHandler):
             )
 
             msg_handler = self.hs.get_handlers().message_handler
-            yield msg_handler.handle_event({
+            yield msg_handler.create_and_send_event({
                 "type": j.type,
                 "room_id": j.room_id,
                 "state_key": j.state_key,
diff --git a/synapse/handlers/room.py b/synapse/handlers/room.py
index d317f2b30e..f7cc869225 100644
--- a/synapse/handlers/room.py
+++ b/synapse/handlers/room.py
@@ -126,11 +126,11 @@ class RoomCreationHandler(BaseHandler):
         msg_handler = self.hs.get_handlers().message_handler
 
         for event in creation_events:
-            yield msg_handler.handle_event(event)
+            yield msg_handler.create_and_send_event(event)
 
         if "name" in config:
             name = config["name"]
-            yield msg_handler.handle_event({
+            yield msg_handler.create_and_send_event({
                 "type": RoomNameEvent.TYPE,
                 "room_id": room_id,
                 "sender": user_id,
@@ -139,7 +139,7 @@ class RoomCreationHandler(BaseHandler):
 
         if "topic" in config:
             topic = config["topic"]
-            yield msg_handler.handle_event({
+            yield msg_handler.create_and_send_event({
                 "type": RoomTopicEvent.TYPE,
                 "room_id": room_id,
                 "sender": user_id,
@@ -147,7 +147,7 @@ class RoomCreationHandler(BaseHandler):
             })
 
         for invitee in invite_list:
-            yield msg_handler.handle_event({
+            yield msg_handler.create_and_send_event({
                 "type": RoomMemberEvent.TYPE,
                 "state_key": invitee,
                 "room_id": room_id,
-- 
cgit 1.4.1