synapse/tests/storage/test_redaction.py

# -*- 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 tests import unittest
from twisted.internet import defer

from synapse.server import HomeServer
from synapse.api.constants import Membership
from synapse.api.events.room import (
    RoomMemberEvent, MessageEvent, RoomRedactionEvent,
)

from tests.utils import SQLiteMemoryDbPool


class RedactionTestCase(unittest.TestCase):

    @defer.inlineCallbacks
    def setUp(self):
        db_pool = SQLiteMemoryDbPool()
        yield db_pool.prepare()

        hs = HomeServer(
            "test",
            db_pool=db_pool,
        )

        self.store = hs.get_datastore()
        self.event_factory = hs.get_event_factory()

        self.u_alice = hs.parse_userid("@alice:test")
        self.u_bob = hs.parse_userid("@bob:test")

        self.room1 = hs.parse_roomid("!abc123:test")

        self.depth = 1

    @defer.inlineCallbacks
    def inject_room_member(self, room, user, membership, prev_state=None,
                           extra_content={}):
        self.depth += 1

        event = self.event_factory.create_event(
            etype=RoomMemberEvent.TYPE,
            user_id=user.to_string(),
            state_key=user.to_string(),
            room_id=room.to_string(),
            membership=membership,
            content={"membership": membership},
            depth=self.depth,
            prev_events=[],
        )

        event.content.update(extra_content)

        if prev_state:
            event.prev_state = prev_state

        event.state_events = None
        event.hashes = {}
        event.prev_state = []
        event.auth_events = []

        # Have to create a join event using the eventfactory
        yield self.store.persist_event(
            event
        )

        defer.returnValue(event)

    @defer.inlineCallbacks
    def inject_message(self, room, user, body):
        self.depth += 1

        event = self.event_factory.create_event(
            etype=MessageEvent.TYPE,
            user_id=user.to_string(),
            room_id=room.to_string(),
            content={"body": body, "msgtype": u"message"},
            depth=self.depth,
            prev_events=[],
        )

        event.state_events = None
        event.hashes = {}
        event.auth_events = []

        yield self.store.persist_event(
            event
        )

        defer.returnValue(event)

    @defer.inlineCallbacks
    def inject_redaction(self, room, event_id, user, reason):
        event = self.event_factory.create_event(
            etype=RoomRedactionEvent.TYPE,
            user_id=user.to_string(),
            room_id=room.to_string(),
            content={"reason": reason},
            depth=self.depth,
            redacts=event_id,
            prev_events=[],
        )

        event.state_events = None
        event.hashes = {}
        event.auth_events = []

        yield self.store.persist_event(
            event
        )

        defer.returnValue(event)

    @defer.inlineCallbacks
    def test_redact(self):
        yield self.inject_room_member(
            self.room1, self.u_alice, Membership.JOIN
        )

        start = yield self.store.get_room_events_max_id()

        msg_event = yield self.inject_message(self.room1, self.u_alice, u"t")

        end = yield self.store.get_room_events_max_id()

        results, _ = yield self.store.get_room_events_stream(
            self.u_alice.to_string(),
            start,
            end,
            None,  # Is currently ignored
        )

        self.assertEqual(1, len(results))

        # Check event has not been redacted:
        event = results[0]

        self.assertObjectHasAttributes(
            {
                "type": MessageEvent.TYPE,
                "user_id": self.u_alice.to_string(),
                "content": {"body": "t", "msgtype": "message"},
            },
            event,
        )

        self.assertFalse(hasattr(event, "redacted_because"))

        # Redact event
        reason = "Because I said so"
        yield self.inject_redaction(
            self.room1, msg_event.event_id, self.u_alice, reason
        )

        results, _ = yield self.store.get_room_events_stream(
            self.u_alice.to_string(),
            start,
            end,
            None,  # Is currently ignored
        )

        self.assertEqual(1, len(results))

        # Check redaction

        event = results[0]

        self.assertObjectHasAttributes(
            {
                "type": MessageEvent.TYPE,
                "user_id": self.u_alice.to_string(),
                "content": {},
            },
            event,
        )

        self.assertTrue(hasattr(event, "redacted_because"))

        self.assertObjectHasAttributes(
            {
                "type": RoomRedactionEvent.TYPE,
                "user_id": self.u_alice.to_string(),
                "content": {"reason": reason},
            },
            event.redacted_because,
        )

    @defer.inlineCallbacks
    def test_redact_join(self):
        yield self.inject_room_member(
            self.room1, self.u_alice, Membership.JOIN
        )

        start = yield self.store.get_room_events_max_id()

        msg_event = yield self.inject_room_member(
            self.room1, self.u_bob, Membership.JOIN,
            extra_content={"blue": "red"},
        )

        end = yield self.store.get_room_events_max_id()

        results, _ = yield self.store.get_room_events_stream(
            self.u_alice.to_string(),
            start,
            end,
            None,  # Is currently ignored
        )

        self.assertEqual(1, len(results))

        # Check event has not been redacted:
        event = results[0]

        self.assertObjectHasAttributes(
            {
                "type": RoomMemberEvent.TYPE,
                "user_id": self.u_bob.to_string(),
                "content": {"membership": Membership.JOIN, "blue": "red"},
            },
            event,
        )

        self.assertFalse(hasattr(event, "redacted_because"))

        # Redact event
        reason = "Because I said so"
        yield self.inject_redaction(
            self.room1, msg_event.event_id, self.u_alice, reason
        )

        results, _ = yield self.store.get_room_events_stream(
            self.u_alice.to_string(),
            start,
            end,
            None,  # Is currently ignored
        )

        self.assertEqual(1, len(results))

        # Check redaction

        event = results[0]

        self.assertObjectHasAttributes(
            {
                "type": RoomMemberEvent.TYPE,
                "user_id": self.u_bob.to_string(),
                "content": {"membership": Membership.JOIN},
            },
            event,
        )

        self.assertTrue(hasattr(event, "redacted_because"))

        self.assertObjectHasAttributes(
            {
                "type": RoomRedactionEvent.TYPE,
                "user_id": self.u_alice.to_string(),
                "content": {"reason": reason},
            },
            event.redacted_because,
        )