Files
notifications-api/app/service_invite/rest.py

224 lines
7.6 KiB
Python
Raw Normal View History

2024-01-24 07:55:14 -08:00
import json
2024-03-19 13:23:22 -07:00
import os
from datetime import datetime
2024-04-19 09:14:36 -07:00
from app.utils import hilite
2021-03-10 13:55:06 +00:00
from flask import Blueprint, current_app, jsonify, request
from itsdangerous import BadData, SignatureExpired
from notifications_utils.url_safe_token import check_token, generate_token
2024-01-24 07:55:14 -08:00
from app import redis_store
from app.config import QueueNames
from app.dao.invited_user_dao import (
get_expired_invite_by_service_and_id,
get_expired_invited_users_for_service,
get_invited_user_by_id,
get_invited_user_by_service_and_id,
2021-03-10 13:55:06 +00:00
get_invited_users_for_service,
save_invited_user,
)
from app.dao.templates_dao import dao_get_template_by_id
from app.enums import InvitedUserStatus, KeyType, NotificationType
from app.errors import InvalidRequest, register_errors
from app.models import Service
2021-03-10 13:55:06 +00:00
from app.notifications.process_notifications import (
persist_notification,
send_notification_to_queue,
)
from app.schemas import invited_user_schema
2023-08-29 14:54:30 -07:00
service_invite = Blueprint("service_invite", __name__)
register_errors(service_invite)
def _create_service_invite(invited_user, invite_link_host):
2024-04-19 09:14:36 -07:00
# TODO REMOVE DEBUG
print(hilite("ENTER _create_service_invite"))
# END DEBUG
2023-08-29 14:54:30 -07:00
template_id = current_app.config["INVITATION_EMAIL_TEMPLATE_ID"]
template = dao_get_template_by_id(template_id)
2023-08-29 14:54:30 -07:00
service = Service.query.get(current_app.config["NOTIFY_SERVICE_ID"])
2024-04-02 13:18:21 -07:00
token = generate_token(
str(invited_user.email_address),
current_app.config["SECRET_KEY"],
current_app.config["DANGEROUS_SALT"],
)
url = os.environ["LOGIN_DOT_GOV_REGISTRATION_URL"]
url = url.replace("NONCE", token)
url = url.replace("STATE", token)
2024-01-22 10:55:09 -08:00
personalisation = {
"user_name": invited_user.from_user.name,
"service_name": invited_user.service.name,
2024-04-02 13:18:21 -07:00
"url": url,
2024-01-22 10:55:09 -08:00
}
2024-01-24 07:55:14 -08:00
saved_notification = persist_notification(
template_id=template.id,
template_version=template.version,
recipient=invited_user.email_address,
service=service,
2024-03-22 11:18:47 -07:00
personalisation={},
notification_type=NotificationType.EMAIL,
api_key_id=None,
key_type=KeyType.NORMAL,
2023-08-29 14:54:30 -07:00
reply_to_text=invited_user.from_user.email_address,
)
2024-01-22 10:55:09 -08:00
saved_notification.personalisation = personalisation
2024-01-24 07:55:14 -08:00
redis_store.set(
f"email-personalisation-{saved_notification.id}",
json.dumps(personalisation),
ex=1800,
)
2024-03-22 11:18:47 -07:00
# The raw permissions are in the form "a,b,c,d"
# but need to be in the form ["a", "b", "c", "d"]
data = {}
permissions = invited_user.permissions
permissions = permissions.split(",")
permission_list = []
for permission in permissions:
permission_list.append(f"{permission}")
data["from_user_id"] = (str(invited_user.from_user.id),)
data["service_id"] = str(invited_user.service.id)
data["permissions"] = permission_list
data["folder_permissions"] = invited_user.folder_permissions
# This is for the login.gov service invite on the
# "Set Up Your Profile" path.
2024-04-19 09:14:36 -07:00
redis_key = f"service-invite-{invited_user.email_address}"
2024-03-22 11:18:47 -07:00
redis_store.set(
2024-04-19 09:14:36 -07:00
redis_key,
2024-03-22 11:18:47 -07:00
json.dumps(data),
ex=3600 * 24,
)
2024-04-19 09:14:36 -07:00
# TODO REMOVE DEBUG
print(hilite(f"Save this data {data} with this redis_key {redis_key}"))
# END DEBUG
2023-08-25 12:09:00 -07:00
send_notification_to_queue(saved_notification, queue=QueueNames.NOTIFY)
@service_invite.route("/service/<service_id>/invite", methods=["POST"])
def create_invited_user(service_id):
request_json = request.get_json()
invited_user = invited_user_schema.load(request_json)
save_invited_user(invited_user)
_create_service_invite(invited_user, request_json.get("invite_link_host"))
return jsonify(data=invited_user_schema.dump(invited_user)), 201
@service_invite.route("/service/<service_id>/invite/expired", methods=["GET"])
def get_expired_invited_users_by_service(service_id):
expired_invited_users = get_expired_invited_users_for_service(service_id)
return jsonify(data=invited_user_schema.dump(expired_invited_users, many=True)), 200
2023-08-29 14:54:30 -07:00
@service_invite.route("/service/<service_id>/invite", methods=["GET"])
def get_invited_users_by_service(service_id):
invited_users = get_invited_users_for_service(service_id)
return jsonify(data=invited_user_schema.dump(invited_users, many=True)), 200
2023-08-29 14:54:30 -07:00
@service_invite.route("/service/<service_id>/invite/<invited_user_id>", methods=["GET"])
def get_invited_user_by_service(service_id, invited_user_id):
invited_user = get_invited_user_by_service_and_id(service_id, invited_user_id)
return jsonify(data=invited_user_schema.dump(invited_user)), 200
2023-08-29 14:54:30 -07:00
@service_invite.route(
"/service/<service_id>/invite/<invited_user_id>", methods=["POST"]
)
def update_invited_user(service_id, invited_user_id):
2023-08-29 14:54:30 -07:00
fetched = get_invited_user_by_service_and_id(
service_id=service_id, invited_user_id=invited_user_id
)
current_data = dict(invited_user_schema.dump(fetched).items())
current_data.update(request.get_json())
update_dict = invited_user_schema.load(current_data)
save_invited_user(update_dict)
return jsonify(data=invited_user_schema.dump(fetched)), 200
@service_invite.route(
"/service/<service_id>/invite/<invited_user_id>/resend", methods=["POST"]
)
def resend_service_invite(service_id, invited_user_id):
"""Resend an expired invite.
This resets the invited user's created date and status to make it a new invite, and
sends the new invite out to the user.
Note:
This ignores the POST data entirely.
"""
fetched = get_expired_invite_by_service_and_id(
service_id=service_id,
invited_user_id=invited_user_id,
)
fetched.created_at = datetime.utcnow()
fetched.status = InvitedUserStatus.PENDING
current_data = {k: v for k, v in invited_user_schema.dump(fetched).items()}
update_dict = invited_user_schema.load(current_data)
save_invited_user(update_dict)
_create_service_invite(fetched, current_app.config["ADMIN_BASE_URL"])
return jsonify(data=invited_user_schema.dump(fetched)), 200
def invited_user_url(invited_user_id, invite_link_host=None):
2023-08-29 14:54:30 -07:00
token = generate_token(
str(invited_user_id),
current_app.config["SECRET_KEY"],
current_app.config["DANGEROUS_SALT"],
)
if invite_link_host is None:
2023-08-29 14:54:30 -07:00
invite_link_host = current_app.config["ADMIN_BASE_URL"]
2023-08-29 14:54:30 -07:00
return "{0}/invitation/{1}".format(invite_link_host, token)
2023-08-29 14:54:30 -07:00
@service_invite.route("/invite/service/<uuid:invited_user_id>", methods=["GET"])
def get_invited_user(invited_user_id):
invited_user = get_invited_user_by_id(invited_user_id)
return jsonify(data=invited_user_schema.dump(invited_user)), 200
2023-08-29 14:54:30 -07:00
@service_invite.route("/invite/service/<token>", methods=["GET"])
@service_invite.route("/invite/service/check/<token>", methods=["GET"])
def validate_service_invitation_token(token):
2023-08-29 14:54:30 -07:00
max_age_seconds = 60 * 60 * 24 * current_app.config["INVITATION_EXPIRATION_DAYS"]
try:
2023-08-29 14:54:30 -07:00
invited_user_id = check_token(
token,
current_app.config["SECRET_KEY"],
current_app.config["DANGEROUS_SALT"],
max_age_seconds,
)
except SignatureExpired:
2023-08-29 14:54:30 -07:00
errors = {
"invitation": "Your invitation to GOV.UK Notify has expired. "
"Please ask the person that invited you to send you another one"
}
raise InvalidRequest(errors, status_code=400)
except BadData:
2023-08-29 14:54:30 -07:00
errors = {
"invitation": "Somethings wrong with this link. Make sure youve copied the whole thing."
}
raise InvalidRequest(errors, status_code=400)
invited_user = get_invited_user_by_id(invited_user_id)
return jsonify(data=invited_user_schema.dump(invited_user)), 200