mirror of
				https://github.com/zulip/zulip.git
				synced 2025-11-04 05:53:43 +00:00 
			
		
		
		
	We've had this sort of logic for GCM for a long time; it's worth adding for APNS as well. Writing this is a bit of a reminder that I'm not a fan of how our unit tests for push notifications work.
		
			
				
	
	
		
			180 lines
		
	
	
		
			7.4 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
			
		
		
	
	
			180 lines
		
	
	
		
			7.4 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
 | 
						|
from typing import Any, Dict, Optional, Union, cast
 | 
						|
 | 
						|
from django.core.exceptions import ValidationError
 | 
						|
from django.core.validators import validate_email, URLValidator
 | 
						|
from django.db import IntegrityError
 | 
						|
from django.http import HttpRequest, HttpResponse
 | 
						|
from django.utils import timezone
 | 
						|
from django.utils.translation import ugettext as _, ugettext as err_
 | 
						|
from django.shortcuts import render
 | 
						|
from django.conf import settings
 | 
						|
from django.views.decorators.http import require_GET
 | 
						|
from django.views.decorators.csrf import csrf_exempt
 | 
						|
 | 
						|
from zerver.decorator import require_post, zulip_login_required, InvalidZulipServerKeyError
 | 
						|
from zerver.lib.exceptions import JsonableError
 | 
						|
from zerver.lib.push_notifications import send_android_push_notification, \
 | 
						|
    send_apple_push_notification
 | 
						|
from zerver.lib.request import REQ, has_request_variables
 | 
						|
from zerver.lib.response import json_error, json_success
 | 
						|
from zerver.lib.validator import check_int, check_string, check_url, \
 | 
						|
    validate_login_email, check_capped_string, check_string_fixed_length
 | 
						|
from zerver.models import UserProfile, Realm
 | 
						|
from zerver.views.push_notifications import validate_token
 | 
						|
from zilencer.lib.stripe import STRIPE_PUBLISHABLE_KEY, count_stripe_cards, \
 | 
						|
    save_stripe_token, StripeError
 | 
						|
from zilencer.models import RemotePushDeviceToken, RemoteZulipServer
 | 
						|
 | 
						|
def validate_entity(entity: Union[UserProfile, RemoteZulipServer]) -> None:
 | 
						|
    if not isinstance(entity, RemoteZulipServer):
 | 
						|
        raise JsonableError(err_("Must validate with valid Zulip server API key"))
 | 
						|
 | 
						|
def validate_bouncer_token_request(entity: Union[UserProfile, RemoteZulipServer],
 | 
						|
                                   token: bytes, kind: int) -> None:
 | 
						|
    if kind not in [RemotePushDeviceToken.APNS, RemotePushDeviceToken.GCM]:
 | 
						|
        raise JsonableError(err_("Invalid token type"))
 | 
						|
    validate_entity(entity)
 | 
						|
    validate_token(token, kind)
 | 
						|
 | 
						|
@csrf_exempt
 | 
						|
@require_post
 | 
						|
@has_request_variables
 | 
						|
def register_remote_server(
 | 
						|
        request: HttpRequest,
 | 
						|
        zulip_org_id: str=REQ(str_validator=check_string_fixed_length(RemoteZulipServer.UUID_LENGTH)),
 | 
						|
        zulip_org_key: str=REQ(str_validator=check_string_fixed_length(RemoteZulipServer.API_KEY_LENGTH)),
 | 
						|
        hostname: str=REQ(str_validator=check_capped_string(RemoteZulipServer.HOSTNAME_MAX_LENGTH)),
 | 
						|
        contact_email: str=REQ(str_validator=check_string),
 | 
						|
        new_org_key: Optional[str]=REQ(str_validator=check_string_fixed_length(
 | 
						|
            RemoteZulipServer.API_KEY_LENGTH), default=None),
 | 
						|
) -> HttpResponse:
 | 
						|
    # REQ validated the the field lengths, but we still need to
 | 
						|
    # validate the format of these fields.
 | 
						|
    try:
 | 
						|
        # TODO: Ideally we'd not abuse the URL validator this way
 | 
						|
        url_validator = URLValidator()
 | 
						|
        url_validator('http://' + hostname)
 | 
						|
    except ValidationError:
 | 
						|
        raise JsonableError(_('%s is not a valid hostname') % (hostname,))
 | 
						|
 | 
						|
    try:
 | 
						|
        validate_email(contact_email)
 | 
						|
    except ValidationError as e:
 | 
						|
        raise JsonableError(e.message)
 | 
						|
 | 
						|
    remote_server, created = RemoteZulipServer.objects.get_or_create(
 | 
						|
        uuid=zulip_org_id,
 | 
						|
        defaults={'hostname': hostname, 'contact_email': contact_email,
 | 
						|
                  'api_key': zulip_org_key})
 | 
						|
 | 
						|
    if not created:
 | 
						|
        if remote_server.api_key != zulip_org_key:
 | 
						|
            raise InvalidZulipServerKeyError(zulip_org_id)
 | 
						|
        else:
 | 
						|
            remote_server.hostname = hostname
 | 
						|
            remote_server.contact_email = contact_email
 | 
						|
            if new_org_key is not None:
 | 
						|
                remote_server.api_key = new_org_key
 | 
						|
            remote_server.save()
 | 
						|
 | 
						|
    return json_success({'created': created})
 | 
						|
 | 
						|
@has_request_variables
 | 
						|
def register_remote_push_device(request: HttpRequest, entity: Union[UserProfile, RemoteZulipServer],
 | 
						|
                                user_id: int=REQ(), token: bytes=REQ(),
 | 
						|
                                token_kind: int=REQ(validator=check_int),
 | 
						|
                                ios_app_id: Optional[str]=None) -> HttpResponse:
 | 
						|
    validate_bouncer_token_request(entity, token, token_kind)
 | 
						|
    server = cast(RemoteZulipServer, entity)
 | 
						|
 | 
						|
    # If a user logged out on a device and failed to unregister,
 | 
						|
    # we should delete any other user associations for this token
 | 
						|
    # & RemoteServer pair
 | 
						|
    RemotePushDeviceToken.objects.filter(
 | 
						|
        token=token, kind=token_kind, server=server).exclude(user_id=user_id).delete()
 | 
						|
 | 
						|
    # Save or update
 | 
						|
    remote_token, created = RemotePushDeviceToken.objects.update_or_create(
 | 
						|
        user_id=user_id,
 | 
						|
        server=server,
 | 
						|
        kind=token_kind,
 | 
						|
        token=token,
 | 
						|
        defaults=dict(
 | 
						|
            ios_app_id=ios_app_id,
 | 
						|
            last_updated=timezone.now()))
 | 
						|
 | 
						|
    return json_success()
 | 
						|
 | 
						|
@has_request_variables
 | 
						|
def unregister_remote_push_device(request: HttpRequest, entity: Union[UserProfile, RemoteZulipServer],
 | 
						|
                                  token: bytes=REQ(),
 | 
						|
                                  token_kind: int=REQ(validator=check_int),
 | 
						|
                                  ios_app_id: Optional[str]=None) -> HttpResponse:
 | 
						|
    validate_bouncer_token_request(entity, token, token_kind)
 | 
						|
    server = cast(RemoteZulipServer, entity)
 | 
						|
    deleted = RemotePushDeviceToken.objects.filter(token=token,
 | 
						|
                                                   kind=token_kind,
 | 
						|
                                                   server=server).delete()
 | 
						|
    if deleted[0] == 0:
 | 
						|
        return json_error(err_("Token does not exist"))
 | 
						|
 | 
						|
    return json_success()
 | 
						|
 | 
						|
@has_request_variables
 | 
						|
def remote_server_notify_push(request: HttpRequest, entity: Union[UserProfile, RemoteZulipServer],
 | 
						|
                              payload: Dict[str, Any]=REQ(argument_type='body')) -> HttpResponse:
 | 
						|
    validate_entity(entity)
 | 
						|
    server = cast(RemoteZulipServer, entity)
 | 
						|
 | 
						|
    user_id = payload['user_id']
 | 
						|
    gcm_payload = payload['gcm_payload']
 | 
						|
    apns_payload = payload['apns_payload']
 | 
						|
 | 
						|
    android_devices = list(RemotePushDeviceToken.objects.filter(
 | 
						|
        user_id=user_id,
 | 
						|
        kind=RemotePushDeviceToken.GCM,
 | 
						|
        server=server
 | 
						|
    ))
 | 
						|
 | 
						|
    apple_devices = list(RemotePushDeviceToken.objects.filter(
 | 
						|
        user_id=user_id,
 | 
						|
        kind=RemotePushDeviceToken.APNS,
 | 
						|
        server=server
 | 
						|
    ))
 | 
						|
 | 
						|
    if android_devices:
 | 
						|
        send_android_push_notification(android_devices, gcm_payload, remote=True)
 | 
						|
 | 
						|
    if apple_devices:
 | 
						|
        send_apple_push_notification(user_id, apple_devices, apns_payload, remote=True)
 | 
						|
 | 
						|
    return json_success()
 | 
						|
 | 
						|
@zulip_login_required
 | 
						|
def add_payment_method(request: HttpRequest) -> HttpResponse:
 | 
						|
    user = request.user
 | 
						|
    ctx = {
 | 
						|
        "publishable_key": STRIPE_PUBLISHABLE_KEY,
 | 
						|
        "email": user.email,
 | 
						|
    }  # type: Dict[str, Any]
 | 
						|
 | 
						|
    if not user.is_realm_admin:
 | 
						|
        ctx["error_message"] = (
 | 
						|
            _("You should be an administrator of the organization %s to view this page.")
 | 
						|
            % (user.realm.name,))
 | 
						|
        return render(request, 'zilencer/billing.html', context=ctx)
 | 
						|
 | 
						|
    try:
 | 
						|
        if request.method == "GET":
 | 
						|
            ctx["num_cards"] = count_stripe_cards(user.realm)
 | 
						|
            return render(request, 'zilencer/billing.html', context=ctx)
 | 
						|
        if request.method == "POST":
 | 
						|
            token = request.POST.get("stripeToken", "")
 | 
						|
            ctx["num_cards"] = save_stripe_token(user, token)
 | 
						|
            ctx["payment_method_added"] = True
 | 
						|
            return render(request, 'zilencer/billing.html', context=ctx)
 | 
						|
    except StripeError as e:
 | 
						|
        ctx["error_message"] = e.msg
 | 
						|
        return render(request, 'zilencer/billing.html', context=ctx)
 |