byceps.services.user.email_address_verification_service

Complexity

Total Complexity

15

Size/Duplication

Total Lines	239
Duplicated Lines	0 %

Test Coverage

Coverage

82.5%

Importance

Changes

0

7 Functions

Rating	Name	Duplication	Size	Complexity
B	invalidate_email_address()	0	38	5
A	send_email_address_confirmation_email()	0	25	1
A	send_email_address_confirmation_email_for_site()	0	17	1
A	confirm_email_address()	0	38	4
A	send_email_address_change_email_for_site()	0	17	1
A	send_email_address_change_email()	0	27	1
A	change_email_address()	0	19	2

"""
byceps.services.user.email_address_verification_service
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:Copyright: 2006-2021 Jochen Kupperschmidt
:License: Revised BSD (see `LICENSE` file for details)
"""

from typing import Optional

from ...database import db
from ...events.user import (
    UserEmailAddressChanged,
    UserEmailAddressConfirmed,
    UserEmailAddressInvalidated,
)
from ...typing import UserID

from ..email import service as email_service
from ..email.transfer.models import NameAndAddress
from ..site import service as site_service
from ..site.transfer.models import SiteID
from ..user import (
    command_service as user_command_service,
    service as user_service,
)
from ..verification_token import service as verification_token_service
from ..verification_token.transfer.models import Token

from . import event_service as user_event_service
from .transfer.models import User


def send_email_address_confirmation_email_for_site(
    recipient_email_address: str,
    recipient_screen_name: str,
    user_id: UserID,
    site_id: SiteID,
) -> None:
    site = site_service.get_site(site_id)

    email_config = email_service.get_config(site.brand_id)
    sender = email_config.sender

    send_email_address_confirmation_email(
        recipient_email_address,
        recipient_screen_name,
        user_id,
        site.server_name,
        sender,
    )


def send_email_address_confirmation_email(
    recipient_email_address: str,
    recipient_screen_name: str,
    user_id: UserID,
    server_name: str,
    sender: NameAndAddress,
) -> None:
    verification_token = (
        verification_token_service.create_for_email_address_confirmation(
            user_id, recipient_email_address
        )
    )
    confirmation_url = (
        f'https://{server_name}/users/email_address/'
        f'confirmation/{verification_token.token}'
    )

    subject = f'{recipient_screen_name}, bitte bestätige deine E-Mail-Adresse'
    body = (
        f'Hallo {recipient_screen_name},\n\n'
        f'bitte bestätige deine E-Mail-Adresse, indem du diese URL abrufst: {confirmation_url}'
    )
    recipients = [recipient_email_address]

    email_service.enqueue_email(sender, recipients, subject, body)


class EmailAddressConfirmationFailed(Exception):
    pass


def confirm_email_address(
    verification_token: Token,
) -> UserEmailAddressConfirmed:
    """Confirm the email address of the user account assigned with that
    verification token.
    """
    user = user_service.get_db_user(verification_token.user_id)

    if user.email_address is None:
        raise EmailAddressConfirmationFailed(
            'Account has no email address assigned.'
        )

    token_email_address = verification_token.data.get('email_address')
    if not token_email_address:
        raise EmailAddressConfirmationFailed('Token contains no email address.')

    if user.email_address != token_email_address:
        raise EmailAddressConfirmationFailed('Email addresses do not match.')

    user.email_address_verified = True

    event_data = {'email_address': token_email_address}
    event = user_event_service.build_event(
        'user-email-address-confirmed', user.id, event_data
    )
    db.session.add(event)

    db.session.commit()

    verification_token_service.delete_token(verification_token.token)

    return UserEmailAddressConfirmed(
        occurred_at=event.occurred_at,
        initiator_id=user.id,
        initiator_screen_name=user.screen_name,
        user_id=user.id,
        user_screen_name=user.screen_name,
    )


def invalidate_email_address(
    user_id: UserID, reason: str, *, initiator_id: Optional[UserID] = None
) -> UserEmailAddressInvalidated:
    """Invalidate the user's email address by marking it as unverified.

    This might be appropriate if an email to the user's address bounced
    because of a permanent issue (unknown mailbox, unknown domain, etc.)
    but not a temporary one (for example: mailbox full).
    """
    user = user_service.get_db_user(user_id)

    initiator: Optional[User]
    if initiator_id is not None:
        initiator = user_service.get_user(initiator_id)
    else:
        initiator = None

    user.email_address_verified = False

    event_data = {
        'email_address': user.email_address,
        'reason': reason,
    }
    if initiator:
        event_data['initiator_id'] = str(initiator.id)
    event = user_event_service.build_event(
        'user-email-address-invalidated', user.id, event_data
    )
    db.session.add(event)

    db.session.commit()

    return UserEmailAddressInvalidated(
        occurred_at=event.occurred_at,
        initiator_id=initiator.id if initiator else None,
        initiator_screen_name=initiator.screen_name if initiator else None,
        user_id=user.id,
        user_screen_name=user.screen_name,
    )


def send_email_address_change_email_for_site(
    new_email_address: str,
    recipient_screen_name: str,
    user_id: UserID,
    site_id: SiteID,
) -> None:
    site = site_service.get_site(site_id)

    email_config = email_service.get_config(site.brand_id)
    sender = email_config.sender

    send_email_address_change_email(
        new_email_address,
        recipient_screen_name,
        user_id,
        site.server_name,
        sender,
    )


def send_email_address_change_email(
    new_email_address: str,
    recipient_screen_name: str,
    user_id: UserID,
    server_name: str,
    sender: NameAndAddress,
) -> None:
    verification_token = (
        verification_token_service.create_for_email_address_change(
            user_id, new_email_address
        )
    )
    confirmation_url = (
        f'https://{server_name}/users/email_address/'
        f'change/{verification_token.token}'
    )

    subject = (
        f'{recipient_screen_name}, bitte bestätige deine neue E-Mail-Adresse'
    )
    body = (
        f'Hallo {recipient_screen_name},\n\n'
        f'bitte bestätige deine neue E-Mail-Adresse, indem du diese URL abrufst: {confirmation_url}'
    )
    recipients = [new_email_address]

    email_service.enqueue_email(sender, recipients, subject, body)


class EmailAddressChangeFailed(Exception):
    pass


def change_email_address(verification_token: Token) -> UserEmailAddressChanged:
    """Change the email address of the user account assigned with that
    verification token.
    """
    new_email_address = verification_token.data.get('new_email_address')
    if not new_email_address:
        raise EmailAddressChangeFailed('Token contains no email address.')

    user = user_service.get_db_user(verification_token.user_id)
    verified = True
    initiator = user

    event = user_command_service.change_email_address(
        user.id, new_email_address, verified, initiator.id
    )

    verification_token_service.delete_token(verification_token.token)

    return event