idlesign/django-sitegate

from typing import Optional

from django.forms import ModelForm
from django.http import HttpRequest, HttpResponse
from django.shortcuts import redirect

from ..flows_base import FlowsBase
from ..settings import SIGNUP_ENABLED, SIGNUP_DISABLED_TEXT
from ..signals import sig_user_signup_success, sig_user_signup_fail

if False:  # pragma: nocover
    from django.contrib.auth.models import User  # noqa


class SignupFlow(FlowsBase):
    """Base class for signup flows."""

    flow_type: str = 'signup'
    auto_signin: bool = True
    activate_user: bool = True
    enabled: bool = SIGNUP_ENABLED
    disabled_text: str = SIGNUP_DISABLED_TEXT

    def handle_form_valid(self, request: HttpRequest, form: ModelForm) -> Optional[HttpResponse]:
        flow_name = self.get_flow_name()

        if not self.get_arg_or_attr('activate_user'):
            form.instance.is_active = False

        signup_result = self.add_user(request, form)

        if signup_result:
            sig_user_signup_success.send(self, signup_result=signup_result, flow=flow_name, request=request)

            if self.get_arg_or_attr('auto_signin'):
                self.sign_in(request, form, signup_result)

            redirect_to = self.flow_args.get('redirect_to', self.default_redirect_to)

            if redirect_to:  # TODO Handle lambda variant with user as arg.
                return redirect(redirect_to)

        else:
            sig_user_signup_fail.send(self, signup_result=signup_result, flow=flow_name, request=request)

    def add_user(self, request: HttpRequest, form: ModelForm) -> 'User':
        """Adds (creates) user using form data."""
        raise NotImplementedError  # pragma: nocover

    def sign_in(self, request: HttpRequest, form: ModelForm, signup_result: 'User') -> bool:
        """Signs in a user."""
        raise NotImplementedError  # pragma: nocover