From 6c82de51002575e974907ab0a7d4fc6b0123bc8f Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Wed, 15 Mar 2017 14:27:34 +0000
Subject: Format presence events on the edges instead of reformatting them
 multiple times

---
 synapse/api/filtering.py | 32 ++++++++++++++++++++++----------
 1 file changed, 22 insertions(+), 10 deletions(-)

(limited to 'synapse/api')

diff --git a/synapse/api/filtering.py b/synapse/api/filtering.py
index fb291d7fb9..63d5c75f43 100644
--- a/synapse/api/filtering.py
+++ b/synapse/api/filtering.py
@@ -13,6 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 from synapse.api.errors import SynapseError
+from synapse.storage.presence import UserPresenceState
 from synapse.types import UserID, RoomID
 
 from twisted.internet import defer
@@ -253,19 +254,30 @@ class Filter(object):
         Returns:
             bool: True if the event matches
         """
-        sender = event.get("sender", None)
-        if not sender:
-            # Presence events have their 'sender' in content.user_id
-            content = event.get("content")
-            # account_data has been allowed to have non-dict content, so check type first
-            if isinstance(content, dict):
-                sender = content.get("user_id")
+        if isinstance(event, UserPresenceState):
+            sender = event.user_id
+            room_id = None
+            ev_type = "m.presence"
+            is_url = False
+        else:
+            sender = event.get("sender", None)
+            if not sender:
+                # Presence events have their 'sender' in content.user_id
+                content = event.get("content")
+                # account_data has been allowed to have non-dict content, so
+                # check type first
+                if isinstance(content, dict):
+                    sender = content.get("user_id")
+
+            room_id = event.get("room_id", None)
+            ev_type = event.get("type", None)
+            is_url = "url" in event.get("content", {})
 
         return self.check_fields(
-            event.get("room_id", None),
+            room_id,
             sender,
-            event.get("type", None),
-            "url" in event.get("content", {})
+            ev_type,
+            is_url,
         )
 
     def check_fields(self, room_id, sender, event_type, contains_url):
-- 
cgit 1.5.1


From e892457a03787e844ba291acc9bfa9455e854145 Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Wed, 15 Mar 2017 14:50:33 +0000
Subject: Comment

---
 synapse/api/filtering.py     | 3 +++
 synapse/handlers/presence.py | 3 +++
 2 files changed, 6 insertions(+)

(limited to 'synapse/api')

diff --git a/synapse/api/filtering.py b/synapse/api/filtering.py
index 63d5c75f43..6cadb5645d 100644
--- a/synapse/api/filtering.py
+++ b/synapse/api/filtering.py
@@ -254,6 +254,9 @@ class Filter(object):
         Returns:
             bool: True if the event matches
         """
+        # We usually get the full "events" as dictionaries coming through,
+        # except for presence which actually gets passed around as its own
+        # namedtuple type.
         if isinstance(event, UserPresenceState):
             sender = event.user_id
             room_id = None
diff --git a/synapse/handlers/presence.py b/synapse/handlers/presence.py
index 46704c62a0..f714bcb53d 100644
--- a/synapse/handlers/presence.py
+++ b/synapse/handlers/presence.py
@@ -984,6 +984,9 @@ def should_notify(old_state, new_state):
 def format_user_presence_state(state, now, include_user_id=True):
     """Convert UserPresenceState to a format that can be sent down to clients
     and to other servers.
+
+    The "user_id" is optional so that this function can be used to format presence
+    updates for client /sync responses and for federation /send requests.
     """
     content = {
         "presence": state.state,
-- 
cgit 1.5.1


From a8f96c63aa7949b5410f1d77facb93169172cb12 Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Wed, 15 Mar 2017 16:01:01 +0000
Subject: Comment

---
 synapse/api/filtering.py | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

(limited to 'synapse/api')

diff --git a/synapse/api/filtering.py b/synapse/api/filtering.py
index 6cadb5645d..47f0cf0fa9 100644
--- a/synapse/api/filtering.py
+++ b/synapse/api/filtering.py
@@ -265,7 +265,9 @@ class Filter(object):
         else:
             sender = event.get("sender", None)
             if not sender:
-                # Presence events have their 'sender' in content.user_id
+                # Presence events had their 'sender' in content.user_id, but are
+                # now handled above. We don't know if anything else uses this
+                # form. TODO: Check this and probably remove it.
                 content = event.get("content")
                 # account_data has been allowed to have non-dict content, so
                 # check type first
-- 
cgit 1.5.1