2023-11-07 23:12:39 +01:00
|
|
|
import re
|
2023-10-05 13:53:09 +02:00
|
|
|
from typing import Optional
|
|
|
|
|
2016-07-26 23:43:38 +02:00
|
|
|
from django.http import HttpRequest, HttpResponse
|
2021-04-16 00:57:30 +02:00
|
|
|
from django.utils.translation import gettext as _
|
2016-07-26 23:43:38 +02:00
|
|
|
|
2017-06-19 22:09:35 +02:00
|
|
|
from zerver.decorator import human_users_only
|
2021-07-16 22:11:10 +02:00
|
|
|
from zerver.lib.exceptions import JsonableError
|
2020-06-11 00:54:34 +02:00
|
|
|
from zerver.lib.push_notifications import (
|
2023-10-08 00:43:41 +02:00
|
|
|
InvalidPushDeviceTokenError,
|
2020-06-11 00:54:34 +02:00
|
|
|
add_push_device_token,
|
|
|
|
b64_to_hex,
|
|
|
|
remove_push_device_token,
|
2023-10-05 13:53:09 +02:00
|
|
|
send_test_push_notification,
|
2020-06-11 00:54:34 +02:00
|
|
|
)
|
2021-07-16 22:11:10 +02:00
|
|
|
from zerver.lib.request import REQ, has_request_variables
|
2019-02-02 23:53:22 +01:00
|
|
|
from zerver.lib.response import json_success
|
2023-11-07 23:12:39 +01:00
|
|
|
from zerver.lib.validator import check_string
|
2016-07-26 23:43:38 +02:00
|
|
|
from zerver.models import PushDeviceToken, UserProfile
|
|
|
|
|
2020-06-11 00:54:34 +02:00
|
|
|
|
2023-11-07 23:12:39 +01:00
|
|
|
def check_app_id(var_name: str, val: object) -> str:
|
|
|
|
# Garbage values should be harmless, but we can be picky
|
|
|
|
# as insurance against bugs somewhere.
|
|
|
|
s = check_string(var_name, val)
|
|
|
|
if not re.fullmatch("[.a-zA-Z0-9-]+", s):
|
|
|
|
raise JsonableError(_("Invalid app ID"))
|
|
|
|
return s
|
|
|
|
|
|
|
|
|
2019-11-13 06:54:30 +01:00
|
|
|
def validate_token(token_str: str, kind: int) -> None:
|
2021-02-12 08:20:45 +01:00
|
|
|
if token_str == "" or len(token_str) > 4096:
|
|
|
|
raise JsonableError(_("Empty or invalid length token"))
|
2017-07-07 18:18:37 +02:00
|
|
|
if kind == PushDeviceToken.APNS:
|
|
|
|
# Validate that we can actually decode the token.
|
|
|
|
try:
|
|
|
|
b64_to_hex(token_str)
|
|
|
|
except Exception:
|
2021-02-12 08:20:45 +01:00
|
|
|
raise JsonableError(_("Invalid APNS token"))
|
2017-03-06 04:04:23 +01:00
|
|
|
|
2021-02-12 08:19:30 +01:00
|
|
|
|
2017-06-19 22:09:35 +02:00
|
|
|
@human_users_only
|
2016-07-26 23:43:38 +02:00
|
|
|
@has_request_variables
|
2021-02-12 08:19:30 +01:00
|
|
|
def add_apns_device_token(
|
|
|
|
request: HttpRequest,
|
|
|
|
user_profile: UserProfile,
|
|
|
|
token: str = REQ(),
|
2023-11-07 23:12:39 +01:00
|
|
|
appid: str = REQ(str_validator=check_app_id),
|
2021-02-12 08:19:30 +01:00
|
|
|
) -> HttpResponse:
|
2017-07-07 18:18:37 +02:00
|
|
|
validate_token(token, PushDeviceToken.APNS)
|
2017-03-06 03:57:31 +01:00
|
|
|
add_push_device_token(user_profile, token, PushDeviceToken.APNS, ios_app_id=appid)
|
2022-01-31 13:44:02 +01:00
|
|
|
return json_success(request)
|
2016-07-26 23:43:38 +02:00
|
|
|
|
2021-02-12 08:19:30 +01:00
|
|
|
|
2017-06-19 22:09:35 +02:00
|
|
|
@human_users_only
|
2016-07-26 23:43:38 +02:00
|
|
|
@has_request_variables
|
2021-02-12 08:19:30 +01:00
|
|
|
def add_android_reg_id(
|
|
|
|
request: HttpRequest, user_profile: UserProfile, token: str = REQ()
|
|
|
|
) -> HttpResponse:
|
2017-07-07 18:18:37 +02:00
|
|
|
validate_token(token, PushDeviceToken.GCM)
|
2017-03-06 04:04:23 +01:00
|
|
|
add_push_device_token(user_profile, token, PushDeviceToken.GCM)
|
2022-01-31 13:44:02 +01:00
|
|
|
return json_success(request)
|
2016-07-26 23:43:38 +02:00
|
|
|
|
2021-02-12 08:19:30 +01:00
|
|
|
|
2017-06-19 22:09:35 +02:00
|
|
|
@human_users_only
|
2016-07-26 23:43:38 +02:00
|
|
|
@has_request_variables
|
2021-02-12 08:19:30 +01:00
|
|
|
def remove_apns_device_token(
|
|
|
|
request: HttpRequest, user_profile: UserProfile, token: str = REQ()
|
|
|
|
) -> HttpResponse:
|
2017-07-07 18:18:37 +02:00
|
|
|
validate_token(token, PushDeviceToken.APNS)
|
2017-03-06 07:01:28 +01:00
|
|
|
remove_push_device_token(user_profile, token, PushDeviceToken.APNS)
|
2022-01-31 13:44:02 +01:00
|
|
|
return json_success(request)
|
2016-07-26 23:43:38 +02:00
|
|
|
|
2021-02-12 08:19:30 +01:00
|
|
|
|
2017-06-19 22:09:35 +02:00
|
|
|
@human_users_only
|
2016-07-26 23:43:38 +02:00
|
|
|
@has_request_variables
|
2021-02-12 08:19:30 +01:00
|
|
|
def remove_android_reg_id(
|
|
|
|
request: HttpRequest, user_profile: UserProfile, token: str = REQ()
|
|
|
|
) -> HttpResponse:
|
2017-07-07 18:18:37 +02:00
|
|
|
validate_token(token, PushDeviceToken.GCM)
|
2017-03-06 07:01:28 +01:00
|
|
|
remove_push_device_token(user_profile, token, PushDeviceToken.GCM)
|
2022-01-31 13:44:02 +01:00
|
|
|
return json_success(request)
|
2023-10-05 13:53:09 +02:00
|
|
|
|
|
|
|
|
|
|
|
@human_users_only
|
|
|
|
@has_request_variables
|
|
|
|
def send_test_push_notification_api(
|
|
|
|
request: HttpRequest, user_profile: UserProfile, token: Optional[str] = REQ(default=None)
|
|
|
|
) -> HttpResponse:
|
|
|
|
# If a token is specified in the request, the test notification is supposed to be sent
|
|
|
|
# to that device. If no token is provided, the test notification should be sent to
|
|
|
|
# all devices registered for the user.
|
|
|
|
if token is not None:
|
|
|
|
try:
|
|
|
|
devices = [PushDeviceToken.objects.get(token=token, user=user_profile)]
|
|
|
|
except PushDeviceToken.DoesNotExist:
|
2023-10-08 00:43:41 +02:00
|
|
|
raise InvalidPushDeviceTokenError
|
2023-10-05 13:53:09 +02:00
|
|
|
else:
|
|
|
|
devices = list(PushDeviceToken.objects.filter(user=user_profile))
|
|
|
|
|
|
|
|
send_test_push_notification(user_profile, devices)
|
|
|
|
|
|
|
|
return json_success(request)
|