2014-11-19 19:20:59 +01:00
|
|
|
# -*- coding: utf-8 -*-
|
2016-01-07 05:26:29 +01:00
|
|
|
# Copyright 2014-2016 OpenMarket Ltd
|
2014-11-19 19:20:59 +01:00
|
|
|
#
|
|
|
|
# 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.
|
|
|
|
|
2018-07-09 08:09:20 +02:00
|
|
|
import logging
|
|
|
|
|
|
|
|
from synapse.api.errors import Codes, StoreError, SynapseError
|
|
|
|
from synapse.http.server import finish_request
|
2016-06-01 18:40:52 +02:00
|
|
|
from synapse.http.servlet import (
|
2018-07-09 08:09:20 +02:00
|
|
|
RestServlet,
|
2018-07-13 21:53:01 +02:00
|
|
|
assert_params_in_dict,
|
2018-07-09 08:09:20 +02:00
|
|
|
parse_json_object_from_request,
|
|
|
|
parse_string,
|
2016-06-01 18:40:52 +02:00
|
|
|
)
|
2018-07-09 08:09:20 +02:00
|
|
|
from synapse.push import PusherConfigException
|
2019-06-03 13:28:59 +02:00
|
|
|
from synapse.rest.client.v2_alpha._base import client_patterns
|
2014-11-19 19:20:59 +01:00
|
|
|
|
2015-12-07 12:52:20 +01:00
|
|
|
logger = logging.getLogger(__name__)
|
2014-11-19 19:20:59 +01:00
|
|
|
|
2019-12-18 15:26:58 +01:00
|
|
|
ALLOWED_KEYS = {
|
|
|
|
"app_display_name",
|
|
|
|
"app_id",
|
|
|
|
"data",
|
|
|
|
"device_display_name",
|
|
|
|
"kind",
|
|
|
|
"lang",
|
|
|
|
"profile_tag",
|
|
|
|
"pushkey",
|
|
|
|
}
|
|
|
|
|
2015-12-07 12:57:48 +01:00
|
|
|
|
2019-06-03 13:28:59 +02:00
|
|
|
class PushersRestServlet(RestServlet):
|
|
|
|
PATTERNS = client_patterns("/pushers$", v1=True)
|
2014-11-19 19:20:59 +01:00
|
|
|
|
2016-03-15 18:41:06 +01:00
|
|
|
def __init__(self, hs):
|
2019-06-03 13:28:59 +02:00
|
|
|
super(PushersRestServlet, self).__init__()
|
|
|
|
self.hs = hs
|
|
|
|
self.auth = hs.get_auth()
|
2016-03-15 18:41:06 +01:00
|
|
|
|
2019-12-05 16:53:06 +01:00
|
|
|
async def on_GET(self, request):
|
|
|
|
requester = await self.auth.get_user_by_req(request)
|
2016-04-11 19:00:03 +02:00
|
|
|
user = requester.user
|
|
|
|
|
2019-12-05 16:53:06 +01:00
|
|
|
pushers = await self.hs.get_datastore().get_pushers_by_user_id(user.to_string())
|
2016-04-11 19:00:03 +02:00
|
|
|
|
2020-02-21 13:15:07 +01:00
|
|
|
filtered_pushers = [
|
2019-12-18 15:26:58 +01:00
|
|
|
{k: v for k, v in p.items() if k in ALLOWED_KEYS} for p in pushers
|
2020-02-21 13:15:07 +01:00
|
|
|
]
|
2016-04-11 19:00:03 +02:00
|
|
|
|
2019-12-18 15:26:58 +01:00
|
|
|
return 200, {"pushers": filtered_pushers}
|
2016-04-11 19:00:03 +02:00
|
|
|
|
2016-04-12 14:33:30 +02:00
|
|
|
def on_OPTIONS(self, _):
|
|
|
|
return 200, {}
|
|
|
|
|
|
|
|
|
2019-06-03 13:28:59 +02:00
|
|
|
class PushersSetRestServlet(RestServlet):
|
|
|
|
PATTERNS = client_patterns("/pushers/set$", v1=True)
|
2016-04-12 14:33:30 +02:00
|
|
|
|
|
|
|
def __init__(self, hs):
|
2019-06-03 13:28:59 +02:00
|
|
|
super(PushersSetRestServlet, self).__init__()
|
|
|
|
self.hs = hs
|
|
|
|
self.auth = hs.get_auth()
|
2016-04-12 14:33:30 +02:00
|
|
|
self.notifier = hs.get_notifier()
|
2017-07-06 18:55:51 +02:00
|
|
|
self.pusher_pool = self.hs.get_pusherpool()
|
2016-04-12 14:33:30 +02:00
|
|
|
|
2019-12-05 16:53:06 +01:00
|
|
|
async def on_POST(self, request):
|
|
|
|
requester = await self.auth.get_user_by_req(request)
|
2016-01-11 16:29:57 +01:00
|
|
|
user = requester.user
|
2014-11-19 19:20:59 +01:00
|
|
|
|
2016-03-09 12:26:26 +01:00
|
|
|
content = parse_json_object_from_request(request)
|
2014-11-19 19:20:59 +01:00
|
|
|
|
2019-06-20 11:32:02 +02:00
|
|
|
if (
|
|
|
|
"pushkey" in content
|
|
|
|
and "app_id" in content
|
|
|
|
and "kind" in content
|
|
|
|
and content["kind"] is None
|
|
|
|
):
|
2019-12-05 16:53:06 +01:00
|
|
|
await self.pusher_pool.remove_pusher(
|
2019-06-20 11:32:02 +02:00
|
|
|
content["app_id"], content["pushkey"], user_id=user.to_string()
|
2015-01-29 18:04:31 +01:00
|
|
|
)
|
2019-08-30 17:28:26 +02:00
|
|
|
return 200, {}
|
2015-01-29 18:04:31 +01:00
|
|
|
|
2018-07-13 21:53:01 +02:00
|
|
|
assert_params_in_dict(
|
2018-07-13 21:40:14 +02:00
|
|
|
content,
|
2019-06-20 11:32:02 +02:00
|
|
|
[
|
|
|
|
"kind",
|
|
|
|
"app_id",
|
|
|
|
"app_display_name",
|
|
|
|
"device_display_name",
|
|
|
|
"pushkey",
|
|
|
|
"lang",
|
|
|
|
"data",
|
|
|
|
],
|
2018-07-13 21:40:14 +02:00
|
|
|
)
|
2014-11-19 19:20:59 +01:00
|
|
|
|
2019-06-20 11:32:02 +02:00
|
|
|
logger.debug("set pushkey %s to kind %s", content["pushkey"], content["kind"])
|
2015-12-07 12:52:20 +01:00
|
|
|
logger.debug("Got pushers request with body: %r", content)
|
|
|
|
|
2015-03-25 20:06:22 +01:00
|
|
|
append = False
|
2019-06-20 11:32:02 +02:00
|
|
|
if "append" in content:
|
|
|
|
append = content["append"]
|
2015-03-25 20:06:22 +01:00
|
|
|
|
|
|
|
if not append:
|
2019-12-05 16:53:06 +01:00
|
|
|
await self.pusher_pool.remove_pushers_by_app_id_and_pushkey_not_user(
|
2019-06-20 11:32:02 +02:00
|
|
|
app_id=content["app_id"],
|
|
|
|
pushkey=content["pushkey"],
|
|
|
|
not_user_id=user.to_string(),
|
2015-03-25 20:06:22 +01:00
|
|
|
)
|
|
|
|
|
2014-11-19 19:20:59 +01:00
|
|
|
try:
|
2019-12-05 16:53:06 +01:00
|
|
|
await self.pusher_pool.add_pusher(
|
2016-01-13 14:08:59 +01:00
|
|
|
user_id=user.to_string(),
|
2016-01-11 16:29:57 +01:00
|
|
|
access_token=requester.access_token_id,
|
2019-06-20 11:32:02 +02:00
|
|
|
kind=content["kind"],
|
|
|
|
app_id=content["app_id"],
|
|
|
|
app_display_name=content["app_display_name"],
|
|
|
|
device_display_name=content["device_display_name"],
|
|
|
|
pushkey=content["pushkey"],
|
|
|
|
lang=content["lang"],
|
|
|
|
data=content["data"],
|
|
|
|
profile_tag=content.get("profile_tag", ""),
|
2014-12-03 14:37:02 +01:00
|
|
|
)
|
2014-11-19 19:20:59 +01:00
|
|
|
except PusherConfigException as pce:
|
2019-06-20 11:32:02 +02:00
|
|
|
raise SynapseError(
|
|
|
|
400, "Config Error: " + str(pce), errcode=Codes.MISSING_PARAM
|
|
|
|
)
|
2014-11-19 19:20:59 +01:00
|
|
|
|
2016-03-15 18:41:06 +01:00
|
|
|
self.notifier.on_new_replication_data()
|
|
|
|
|
2019-08-30 17:28:26 +02:00
|
|
|
return 200, {}
|
2014-11-19 19:20:59 +01:00
|
|
|
|
2014-12-03 14:37:02 +01:00
|
|
|
def on_OPTIONS(self, _):
|
|
|
|
return 200, {}
|
|
|
|
|
2014-11-19 19:20:59 +01:00
|
|
|
|
2016-06-01 18:40:52 +02:00
|
|
|
class PushersRemoveRestServlet(RestServlet):
|
|
|
|
"""
|
|
|
|
To allow pusher to be delete by clicking a link (ie. GET request)
|
|
|
|
"""
|
2019-06-20 11:32:02 +02:00
|
|
|
|
2019-06-03 13:28:59 +02:00
|
|
|
PATTERNS = client_patterns("/pushers/remove$", v1=True)
|
2018-12-03 12:27:41 +01:00
|
|
|
SUCCESS_HTML = b"<html><body>You have been unsubscribed</body><html>"
|
2016-06-01 18:40:52 +02:00
|
|
|
|
|
|
|
def __init__(self, hs):
|
2018-07-13 21:40:14 +02:00
|
|
|
super(PushersRemoveRestServlet, self).__init__()
|
2016-06-02 18:21:31 +02:00
|
|
|
self.hs = hs
|
2016-06-01 18:40:52 +02:00
|
|
|
self.notifier = hs.get_notifier()
|
2018-04-30 21:58:30 +02:00
|
|
|
self.auth = hs.get_auth()
|
2017-07-06 18:55:51 +02:00
|
|
|
self.pusher_pool = self.hs.get_pusherpool()
|
2016-06-01 18:40:52 +02:00
|
|
|
|
2019-12-05 16:53:06 +01:00
|
|
|
async def on_GET(self, request):
|
|
|
|
requester = await self.auth.get_user_by_req(request, rights="delete_pusher")
|
2016-06-01 18:40:52 +02:00
|
|
|
user = requester.user
|
|
|
|
|
|
|
|
app_id = parse_string(request, "app_id", required=True)
|
|
|
|
pushkey = parse_string(request, "pushkey", required=True)
|
|
|
|
|
|
|
|
try:
|
2019-12-05 16:53:06 +01:00
|
|
|
await self.pusher_pool.remove_pusher(
|
2019-06-20 11:32:02 +02:00
|
|
|
app_id=app_id, pushkey=pushkey, user_id=user.to_string()
|
2016-06-01 18:40:52 +02:00
|
|
|
)
|
|
|
|
except StoreError as se:
|
|
|
|
if se.code != 404:
|
|
|
|
# This is fine: they're already unsubscribed
|
|
|
|
raise
|
|
|
|
|
|
|
|
self.notifier.on_new_replication_data()
|
|
|
|
|
|
|
|
request.setResponseCode(200)
|
|
|
|
request.setHeader(b"Content-Type", b"text/html; charset=utf-8")
|
2019-06-20 11:32:02 +02:00
|
|
|
request.setHeader(
|
|
|
|
b"Content-Length", b"%d" % (len(PushersRemoveRestServlet.SUCCESS_HTML),)
|
|
|
|
)
|
2016-06-01 18:40:52 +02:00
|
|
|
request.write(PushersRemoveRestServlet.SUCCESS_HTML)
|
|
|
|
finish_request(request)
|
2019-07-23 15:00:55 +02:00
|
|
|
return None
|
2016-06-01 18:40:52 +02:00
|
|
|
|
|
|
|
def on_OPTIONS(self, _):
|
|
|
|
return 200, {}
|
|
|
|
|
|
|
|
|
2014-11-19 19:20:59 +01:00
|
|
|
def register_servlets(hs, http_server):
|
2016-04-12 14:33:30 +02:00
|
|
|
PushersRestServlet(hs).register(http_server)
|
|
|
|
PushersSetRestServlet(hs).register(http_server)
|
2016-06-01 18:40:52 +02:00
|
|
|
PushersRemoveRestServlet(hs).register(http_server)
|