2015-01-26 15:27:40 +00:00
|
|
|
#
|
2023-11-21 20:29:58 +00:00
|
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
|
|
#
|
2024-01-23 11:26:48 +00:00
|
|
|
# Copyright 2015, 2016 OpenMarket Ltd
|
2023-11-21 20:29:58 +00:00
|
|
|
# Copyright (C) 2023 New Vector, Ltd
|
|
|
|
#
|
|
|
|
# This program is free software: you can redistribute it and/or modify
|
|
|
|
# it under the terms of the GNU Affero General Public License as
|
|
|
|
# published by the Free Software Foundation, either version 3 of the
|
|
|
|
# License, or (at your option) any later version.
|
|
|
|
#
|
|
|
|
# See the GNU Affero General Public License for more details:
|
|
|
|
# <https://www.gnu.org/licenses/agpl-3.0.html>.
|
|
|
|
#
|
|
|
|
# Originally licensed under the Apache License, Version 2.0:
|
|
|
|
# <http://www.apache.org/licenses/LICENSE-2.0>.
|
|
|
|
#
|
|
|
|
# [This file includes modifications made by New Vector Limited]
|
2015-01-26 15:27:40 +00:00
|
|
|
#
|
|
|
|
#
|
|
|
|
|
2022-03-02 16:34:14 +00:00
|
|
|
from twisted.test.proto_helpers import MemoryReactor
|
2020-08-27 21:24:46 +00:00
|
|
|
|
2018-07-09 06:09:20 +00:00
|
|
|
from synapse.api.errors import Codes
|
2021-08-17 11:57:58 +00:00
|
|
|
from synapse.rest.client import filter
|
2022-03-02 16:34:14 +00:00
|
|
|
from synapse.server import HomeServer
|
2023-04-26 23:03:26 +00:00
|
|
|
from synapse.types import UserID
|
2022-03-02 16:34:14 +00:00
|
|
|
from synapse.util import Clock
|
2016-10-18 17:17:38 +00:00
|
|
|
|
2018-07-09 06:09:20 +00:00
|
|
|
from tests import unittest
|
2016-10-18 17:17:38 +00:00
|
|
|
|
|
|
|
PATH_PREFIX = "/_matrix/client/v2_alpha"
|
|
|
|
|
|
|
|
|
2018-11-06 16:00:00 +00:00
|
|
|
class FilterTestCase(unittest.HomeserverTestCase):
|
|
|
|
user_id = "@apple:test"
|
|
|
|
hijack_auth = True
|
2017-03-23 14:42:41 +00:00
|
|
|
EXAMPLE_FILTER = {"room": {"timeline": {"types": ["m.room.message"]}}}
|
2018-07-17 10:43:18 +00:00
|
|
|
EXAMPLE_FILTER_JSON = b'{"room": {"timeline": {"types": ["m.room.message"]}}}'
|
2018-11-06 16:00:00 +00:00
|
|
|
servlets = [filter.register_servlets]
|
2015-01-26 15:27:40 +00:00
|
|
|
|
2022-03-02 16:34:14 +00:00
|
|
|
def prepare(self, reactor: MemoryReactor, clock: Clock, hs: HomeServer) -> None:
|
2018-11-06 16:00:00 +00:00
|
|
|
self.filtering = hs.get_filtering()
|
2022-02-23 11:04:02 +00:00
|
|
|
self.store = hs.get_datastores().main
|
2015-01-27 17:48:13 +00:00
|
|
|
|
2022-03-02 16:34:14 +00:00
|
|
|
def test_add_filter(self) -> None:
|
2020-12-15 14:44:04 +00:00
|
|
|
channel = self.make_request(
|
2018-08-09 02:22:01 +00:00
|
|
|
"POST",
|
2018-11-06 16:00:00 +00:00
|
|
|
"/_matrix/client/r0/user/%s/filter" % (self.user_id),
|
2018-07-17 10:43:18 +00:00
|
|
|
self.EXAMPLE_FILTER_JSON,
|
2016-10-18 17:17:38 +00:00
|
|
|
)
|
2018-07-17 10:43:18 +00:00
|
|
|
|
2022-08-05 14:59:09 +00:00
|
|
|
self.assertEqual(channel.code, 200)
|
2018-07-17 10:43:18 +00:00
|
|
|
self.assertEqual(channel.json_body, {"filter_id": "0"})
|
2022-03-02 16:34:14 +00:00
|
|
|
filter = self.get_success(
|
2023-06-03 00:24:13 +00:00
|
|
|
self.store.get_user_filter(
|
|
|
|
user_id=UserID.from_string(FilterTestCase.user_id), filter_id=0
|
|
|
|
)
|
2022-03-02 16:34:14 +00:00
|
|
|
)
|
2018-11-06 16:00:00 +00:00
|
|
|
self.pump()
|
2022-03-02 16:34:14 +00:00
|
|
|
self.assertEqual(filter, self.EXAMPLE_FILTER)
|
2016-10-18 17:17:38 +00:00
|
|
|
|
2022-03-02 16:34:14 +00:00
|
|
|
def test_add_filter_for_other_user(self) -> None:
|
2020-12-15 14:44:04 +00:00
|
|
|
channel = self.make_request(
|
2018-08-09 02:22:01 +00:00
|
|
|
"POST",
|
|
|
|
"/_matrix/client/r0/user/%s/filter" % ("@watermelon:test"),
|
2018-07-17 10:43:18 +00:00
|
|
|
self.EXAMPLE_FILTER_JSON,
|
2016-10-18 17:17:38 +00:00
|
|
|
)
|
2018-07-17 10:43:18 +00:00
|
|
|
|
2022-08-05 14:59:09 +00:00
|
|
|
self.assertEqual(channel.code, 403)
|
2022-02-28 12:12:29 +00:00
|
|
|
self.assertEqual(channel.json_body["errcode"], Codes.FORBIDDEN)
|
2015-01-26 15:27:40 +00:00
|
|
|
|
2022-03-02 16:34:14 +00:00
|
|
|
def test_add_filter_non_local_user(self) -> None:
|
2016-10-18 17:17:38 +00:00
|
|
|
_is_mine = self.hs.is_mine
|
2024-03-13 17:05:57 +00:00
|
|
|
self.hs.is_mine = lambda target_user: False # type: ignore[assignment]
|
2020-12-15 14:44:04 +00:00
|
|
|
channel = self.make_request(
|
2018-08-09 02:22:01 +00:00
|
|
|
"POST",
|
2018-11-06 16:00:00 +00:00
|
|
|
"/_matrix/client/r0/user/%s/filter" % (self.user_id),
|
2018-07-17 10:43:18 +00:00
|
|
|
self.EXAMPLE_FILTER_JSON,
|
2016-10-18 17:17:38 +00:00
|
|
|
)
|
2018-07-17 10:43:18 +00:00
|
|
|
|
2023-08-29 14:38:56 +00:00
|
|
|
self.hs.is_mine = _is_mine # type: ignore[method-assign]
|
2022-08-05 14:59:09 +00:00
|
|
|
self.assertEqual(channel.code, 403)
|
2022-02-28 12:12:29 +00:00
|
|
|
self.assertEqual(channel.json_body["errcode"], Codes.FORBIDDEN)
|
2015-01-27 18:07:21 +00:00
|
|
|
|
2022-03-02 16:34:14 +00:00
|
|
|
def test_get_filter(self) -> None:
|
|
|
|
filter_id = self.get_success(
|
2020-08-27 21:24:46 +00:00
|
|
|
self.filtering.add_user_filter(
|
2023-04-26 23:03:26 +00:00
|
|
|
user_id=UserID.from_string("@apple:test"),
|
|
|
|
user_filter=self.EXAMPLE_FILTER,
|
2020-08-27 21:24:46 +00:00
|
|
|
)
|
2016-10-18 17:17:38 +00:00
|
|
|
)
|
2018-11-06 16:00:00 +00:00
|
|
|
self.reactor.advance(1)
|
2020-12-15 14:44:04 +00:00
|
|
|
channel = self.make_request(
|
2018-11-06 16:00:00 +00:00
|
|
|
"GET", "/_matrix/client/r0/user/%s/filter/%s" % (self.user_id, filter_id)
|
2015-01-26 15:27:40 +00:00
|
|
|
)
|
2018-07-17 10:43:18 +00:00
|
|
|
|
2022-08-05 14:59:09 +00:00
|
|
|
self.assertEqual(channel.code, 200)
|
2022-02-28 12:12:29 +00:00
|
|
|
self.assertEqual(channel.json_body, self.EXAMPLE_FILTER)
|
2015-01-27 18:07:21 +00:00
|
|
|
|
2022-03-02 16:34:14 +00:00
|
|
|
def test_get_filter_non_existant(self) -> None:
|
2020-12-15 14:44:04 +00:00
|
|
|
channel = self.make_request(
|
2018-11-06 16:00:00 +00:00
|
|
|
"GET", "/_matrix/client/r0/user/%s/filter/12382148321" % (self.user_id)
|
2015-01-27 18:07:21 +00:00
|
|
|
)
|
2018-07-17 10:43:18 +00:00
|
|
|
|
2022-08-05 14:59:09 +00:00
|
|
|
self.assertEqual(channel.code, 404)
|
2022-02-28 12:12:29 +00:00
|
|
|
self.assertEqual(channel.json_body["errcode"], Codes.NOT_FOUND)
|
2015-01-27 18:07:21 +00:00
|
|
|
|
2016-10-18 17:17:38 +00:00
|
|
|
# Currently invalid params do not have an appropriate errcode
|
|
|
|
# in errors.py
|
2022-03-02 16:34:14 +00:00
|
|
|
def test_get_filter_invalid_id(self) -> None:
|
2020-12-15 14:44:04 +00:00
|
|
|
channel = self.make_request(
|
2018-11-06 16:00:00 +00:00
|
|
|
"GET", "/_matrix/client/r0/user/%s/filter/foobar" % (self.user_id)
|
2015-01-27 18:07:21 +00:00
|
|
|
)
|
2018-07-17 10:43:18 +00:00
|
|
|
|
2022-08-05 14:59:09 +00:00
|
|
|
self.assertEqual(channel.code, 400)
|
2016-10-10 12:25:26 +00:00
|
|
|
|
2016-10-18 17:17:38 +00:00
|
|
|
# No ID also returns an invalid_id error
|
2022-03-02 16:34:14 +00:00
|
|
|
def test_get_filter_no_id(self) -> None:
|
2020-12-15 14:44:04 +00:00
|
|
|
channel = self.make_request(
|
2018-11-06 16:00:00 +00:00
|
|
|
"GET", "/_matrix/client/r0/user/%s/filter/" % (self.user_id)
|
2016-10-10 12:25:26 +00:00
|
|
|
)
|
2018-07-17 10:43:18 +00:00
|
|
|
|
2022-08-05 14:59:09 +00:00
|
|
|
self.assertEqual(channel.code, 400)
|