summary refs log tree commit diff
path: root/synapse
diff options
context:
space:
mode:
Diffstat (limited to 'synapse')
-rw-r--r--synapse/config/emailconfig.py9
-rw-r--r--synapse/config/server.py8
-rw-r--r--synapse/push/mailer.py166
-rw-r--r--synapse/python_dependencies.py1
4 files changed, 161 insertions, 23 deletions
diff --git a/synapse/config/emailconfig.py b/synapse/config/emailconfig.py
index 68fb4d8060..893034e2ef 100644
--- a/synapse/config/emailconfig.py
+++ b/synapse/config/emailconfig.py
@@ -25,17 +25,19 @@ class EmailConfig(Config):
     """
 
     def read_config(self, config):
+        self.email_enable_notifs = False
+
         email_config = config.get("email", None)
         if email_config:
             self.email_enable_notifs = email_config.get("enable_notifs", True)
 
+        if self.email_enable_notifs:
             required = [
                 "smtp_host",
                 "smtp_port",
                 "notif_from",
                 "template_dir",
                 "notif_template_html",
-
             ]
 
             missing = []
@@ -49,6 +51,11 @@ class EmailConfig(Config):
                     (", ".join(["email."+k for k in missing]),)
                 )
 
+            if config.get("public_baseurl") is None:
+                raise RuntimeError(
+                    "email.enable_notifs is True but no public_baseurl is set"
+                )
+
             self.email_smtp_host = email_config["smtp_host"]
             self.email_smtp_port = email_config["smtp_port"]
             self.email_notif_from = email_config["notif_from"]
diff --git a/synapse/config/server.py b/synapse/config/server.py
index df4707e1d1..19af39da70 100644
--- a/synapse/config/server.py
+++ b/synapse/config/server.py
@@ -28,6 +28,11 @@ class ServerConfig(Config):
         self.print_pidfile = config.get("print_pidfile")
         self.user_agent_suffix = config.get("user_agent_suffix")
         self.use_frozen_dicts = config.get("use_frozen_dicts", True)
+        self.public_baseurl = config.get("public_baseurl")
+
+        if self.public_baseurl is not None:
+            if self.public_baseurl[-1] != '/':
+                self.public_baseurl += '/'
 
         self.listeners = config.get("listeners", [])
 
@@ -142,6 +147,9 @@ class ServerConfig(Config):
         # Whether to serve a web client from the HTTP/HTTPS root resource.
         web_client: True
 
+        # The server's public-facing base URL
+        # https://example.com:8448/
+
         # Set the soft limit on the number of file descriptors synapse can use
         # Zero is used to indicate synapse should set the soft limit to the
         # hard limit.
diff --git a/synapse/push/mailer.py b/synapse/push/mailer.py
index 9e2297a03b..e78c26edea 100644
--- a/synapse/push/mailer.py
+++ b/synapse/push/mailer.py
@@ -26,6 +26,10 @@ from synapse.types import UserID
 from synapse.api.errors import StoreError
 
 import jinja2
+import bleach
+
+import time
+import urllib
 
 
 MESSAGE_FROM_PERSON_IN_ROOM = "You have a message from %s in the %s room"
@@ -33,6 +37,27 @@ MESSAGE_FROM_PERSON = "You have a message from %s"
 MESSAGES_IN_ROOM = "There are some messages for you in the %s room"
 MESSAGES_IN_ROOMS = "Here are some messages you may have missed"
 
+CONTEXT_BEFORE = 1
+
+# From https://github.com/matrix-org/matrix-react-sdk/blob/master/src/HtmlUtils.js
+ALLOWED_TAGS = [
+    'font',  # custom to matrix for IRC-style font coloring
+    'del',  # for markdown
+    # deliberately no h1/h2 to stop people shouting.
+    'h3', 'h4', 'h5', 'h6', 'blockquote', 'p', 'a', 'ul', 'ol',
+    'nl', 'li', 'b', 'i', 'u', 'strong', 'em', 'strike', 'code', 'hr', 'br', 'div',
+    'table', 'thead', 'caption', 'tbody', 'tr', 'th', 'td', 'pre'
+]
+ALLOWED_ATTRS = {
+    # custom ones first:
+    "font": ["color"],  # custom to matrix
+    "a": ["href", "name", "target"],  # remote target: custom to matrix
+    # We don't currently allow img itself by default, but this
+    # would make sense if we did
+    "img": ["src"],
+}
+ALLOWED_SCHEMES = ["http", "https", "ftp", "mailto"]
+
 
 class Mailer(object):
     def __init__(self, hs):
@@ -41,6 +66,8 @@ class Mailer(object):
         self.state_handler = self.hs.get_state_handler()
         loader = jinja2.FileSystemLoader(self.hs.config.email_template_dir)
         env = jinja2.Environment(loader=loader)
+        env.filters["format_ts"] = format_ts_filter
+        env.filters["mxc_to_http"] = self.mxc_to_http_filter
         self.notif_template = env.get_template(self.hs.config.email_notif_template_html)
 
     @defer.inlineCallbacks
@@ -55,6 +82,10 @@ class Mailer(object):
             [pa['room_id'] for pa in push_actions]
         )
 
+        notif_events = yield self.store.get_events(
+            [pa['event_id'] for pa in push_actions]
+        )
+
         notifs_by_room = {}
         for pa in push_actions:
             notifs_by_room.setdefault(pa["room_id"], []).append(pa)
@@ -79,14 +110,16 @@ class Mailer(object):
         # notifs are much realtime than sync so we can afford to wait a bit.
         yield concurrently_execute(_fetch_room_state, rooms_in_order, 3)
 
-        rooms = [
-            self.get_room_vars(
-                r, user_id, notifs_by_room[r], state_by_room[r]
-            ) for r in rooms_in_order
-        ]
+        rooms = []
 
-        summary_text = yield self.make_summary_text(
-            notifs_by_room, state_by_room, user_id
+        for r in rooms_in_order:
+            vars = yield self.get_room_vars(
+                r, user_id, notifs_by_room[r], notif_events, state_by_room[r]
+            )
+            rooms.append(vars)
+
+        summary_text = self.make_summary_text(
+            notifs_by_room, state_by_room, notif_events, user_id
         )
 
         template_vars = {
@@ -109,13 +142,72 @@ class Mailer(object):
             port=self.hs.config.email_smtp_port
         )
 
-    def get_room_vars(self, room_id, user_id, notifs, room_state):
-        room_vars = {}
-        room_vars['title'] = calculate_room_name(room_state, user_id)
-        return room_vars
+    @defer.inlineCallbacks
+    def get_room_vars(self, room_id, user_id, notifs, notif_events, room_state):
+        room_vars = {
+            "title": calculate_room_name(room_state, user_id),
+            "hash": string_ordinal_total(room_id),  # See sender avatar hash
+            "notifs": [],
+        }
+
+        for n in notifs:
+            vars = yield self.get_notif_vars(n, notif_events[n['event_id']], room_state)
+            room_vars['notifs'].append(vars)
+
+        defer.returnValue(room_vars)
 
     @defer.inlineCallbacks
-    def make_summary_text(self, notifs_by_room, state_by_room, user_id):
+    def get_notif_vars(self, notif, notif_event, room_state):
+        results = yield self.store.get_events_around(
+            notif['room_id'], notif['event_id'],
+            before_limit=CONTEXT_BEFORE, after_limit=0
+        )
+
+        ret = {
+            "link": self.make_notif_link(notif),
+            "ts": notif['received_ts'],
+            "messages": [],
+        }
+
+        for event in results['events_before']:
+            vars = self.get_message_vars(notif, event, room_state)
+            if vars is not None:
+                ret['messages'].append(vars)
+
+        vars = self.get_message_vars(notif, notif_event, room_state)
+        if vars is not None:
+            ret['messages'].append(vars)
+
+        defer.returnValue(ret)
+
+    def get_message_vars(self, notif, event, room_state):
+        msgtype = event.content["msgtype"]
+
+        sender_state_event = room_state[("m.room.member", event.sender)]
+        sender_name = name_from_member_event(sender_state_event)
+        sender_avatar_url = sender_state_event.content["avatar_url"]
+
+        # 'hash' for deterministically picking default images: use
+        # sender_hash % the number of default images to choose from
+        sender_hash = string_ordinal_total(event.sender)
+
+        ret = {
+            "msgtype": msgtype,
+            "is_historical": event.event_id != notif['event_id'],
+            "ts": event.origin_server_ts,
+            "sender_name": sender_name,
+            "sender_avatar_url": sender_avatar_url,
+            "sender_hash": sender_hash,
+        }
+
+        if msgtype == "m.text":
+            ret["body_text_plain"] = event.content["body"]
+        elif msgtype == "org.matrix.custom.html":
+            ret["body_text_html"] = safe_markup(event.content["formatted_body"])
+
+        return ret
+
+    def make_summary_text(self, notifs_by_room, state_by_room, notif_events, user_id):
         if len(notifs_by_room) == 1:
             room_id = notifs_by_room.keys()[0]
             sender_name = None
@@ -126,29 +218,50 @@ class Mailer(object):
                 room_name = calculate_room_name(
                     state_by_room[room_id], user_id, fallback_to_members=False
                 )
-                event = yield self.store.get_event(
-                    notifs_by_room[room_id][0]["event_id"]
-                )
+                event = notif_events[notifs_by_room[room_id][0]["event_id"]]
                 if ("m.room.member", event.sender) in state_by_room[room_id]:
                     state_event = state_by_room[room_id][("m.room.member", event.sender)]
                     sender_name = name_from_member_event(state_event)
                 if sender_name is not None and room_name is not None:
-                    defer.returnValue(
-                        MESSAGE_FROM_PERSON_IN_ROOM % (sender_name, room_name)
-                    )
+                    return MESSAGE_FROM_PERSON_IN_ROOM % (sender_name, room_name)
                 elif sender_name is not None:
-                    defer.returnValue(MESSAGE_FROM_PERSON % (sender_name,))
+                    return MESSAGE_FROM_PERSON % (sender_name,)
             else:
                 room_name = calculate_room_name(state_by_room[room_id], user_id)
-                defer.returnValue(MESSAGES_IN_ROOM % (room_name,))
+                return MESSAGES_IN_ROOM % (room_name,)
         else:
-            defer.returnValue(MESSAGES_IN_ROOMS)
+            return MESSAGES_IN_ROOMS
 
-        defer.returnValue("Some thing have occurred in some rooms")
+    def make_notif_link(self, notif):
+        return "https://matrix.to/%s/%s" % (
+            notif['room_id'], notif['event_id']
+        )
 
     def make_unsubscribe_link(self):
         return "https://vector.im/#/settings"  # XXX: matrix.to
 
+    def mxc_to_http_filter(self, value, width, height, resizeMethod="crop"):
+        if value[0:6] != "mxc://":
+            return ""
+        serverAndMediaId = value[6:]
+        params = {
+            "width": width,
+            "height": height,
+            "method": resizeMethod,
+        }
+        return "%s_matrix/media/v1/thumbnail/%s?%s" % (
+            self.hs.config.public_baseurl,
+            serverAndMediaId,
+            urllib.urlencode(params)
+        )
+
+
+def safe_markup(self, raw_html):
+    return jinja2.Markup(bleach.linkify(bleach.clean(
+        raw_html, tags=ALLOWED_TAGS, attributes=ALLOWED_ATTRS,
+        protocols=ALLOWED_SCHEMES, strip=True
+    )))
+
 
 def deduped_ordered_list(l):
     seen = set()
@@ -158,3 +271,12 @@ def deduped_ordered_list(l):
             seen.add(item)
             ret.append(item)
     return ret
+
+def string_ordinal_total(s):
+    tot = 0
+    for c in s:
+        tot += ord(c)
+    return tot
+
+def format_ts_filter(value, format):
+    return time.strftime(format, time.localtime(value / 1000))
diff --git a/synapse/python_dependencies.py b/synapse/python_dependencies.py
index 16524dbdcd..618f3c43ab 100644
--- a/synapse/python_dependencies.py
+++ b/synapse/python_dependencies.py
@@ -47,6 +47,7 @@ CONDITIONAL_REQUIREMENTS = {
     },
     "email.enable_notifs": {
         "Jinja2>=2.8": ["Jinja2>=2.8"],
+        "bleach>=1.4.2": ["bleach>=1.4.2"],
     },
 }