[備忘] メールアドレス変更時にも認証URLによるアドレス確認を行う

[MITSUHIRO-KURIKI]

• Userモデルの email とは別に変更申請されたアドレスを格納するフォールドを用意する
  • email フォールドと違い検索することはないので暗号化には EncryptedEmailField をそのまま用いる
• 初期値はダミーアドレスをセットしておく

class CustomUser(AbstractBaseUser, PermissionsMixin):

    change_email = EncryptedEmailField(
                    verbose_name = '変更したいメールアドレス(Encrypted:Form使用不可)',
                    blank        = False,
                    null         = False,
                    unique       = False,
                    max_length   = 255,
                    default      = '[email protected]',)
    is_change_email_request = models.BooleanField(
                    verbose_name = 'メール再設定のリクエスト中',
                    default      = False,)

^{https://github.com/MITSUHIRO-KURIKI/DjangoTemplate/blob/main/accounts/models/CustomUser_models.py#L86}

• メールアドレス変更を受付た際に、変更申請されたアドレスを change_email に一時格納
• メールを送信する関数 ( send_token_for_change_email ) にユーザObjectを渡す

class EmailChangeView(LoginRequiredMixin, FormView):

    def form_valid(self, form):
        user         = self.request.user
        change_email = self.request.POST['change_email']
        # メール認証を行う場合と行わない場合
        if settings.IS_USE_EMAIL_CERTIFICATION:
            user.is_change_email_request = True
            user.change_email            = change_email
            user.save()
            send_token_for_change_email(user)
        else:
            # メール認証を行わない場合には初期値に戻してすぐ変更を受付
            user.is_change_email_request = False
            user.email                   = change_email     # emailを変更
            user.change_email            = '[email protected]' # ダミーデータの設定
            user.save()
        return super().form_valid(form)

^{https://github.com/MITSUHIRO-KURIKI/DjangoTemplate/blob/main/accounts/views/AccountChange_views.py#L220}

• EmailChangeView から受け渡されたUserへ認証URLを送信
  • is_send_change_email_address = True で変更申請のあったアドレスへメールを送信

def send_token_for_change_email(instance) -> None:
    # メールアドレス変更時のメールアドレスの認証
    if instance.is_change_email_request:
        activate_token = ActivateToken.objects.create(
            user       = instance,
            token      = str(uuid4().hex),
            expired_at = datetime.now() + timedelta(seconds=settings.EMAIL_CERTIFICATION_TOKEN_AGE),
        )
        subject_template_name    = 'accounts/EmailChange/mail_template/subject.html'
        email_template_name      = 'accounts/EmailChange/mail_template/text_message.html'
        html_email_template_name = 'accounts/EmailChange/mail_template/html_message.html'
        ACTIVATE_URL             = f'{settings.FRONTEND_URL}/accounts/activate_email/{activate_token.token}'
        context                  = {
            'ACTIVATE_URL':  ACTIVATE_URL,
            'TOKEN_EXPIRED': int(settings.EMAIL_CERTIFICATION_TOKEN_AGE / (60*60)),
        }
        instance.send_mail_user(
            subject_template_name        = subject_template_name,
            email_template_name          = email_template_name,
            html_email_template_name     = html_email_template_name,
            context                      = context,
            is_send_change_email_address = True,
        )

^{https://github.com/MITSUHIRO-KURIKI/DjangoTemplate/blob/main/accounts/views/send_mail/send_mail.py#L6}

• 認証が成功したら user.email = user.change_email を実行
• その後、change_email はデフォルトのダミーに戻す

class ActivateTokenManager(models.Manager):

    # メールアドレス変更時のメールアドレスの認証
    def activate_change_email_by_token(self, token):
        user_email_activate_token = self.filter(
                                        token           = token,
                                        expired_at__gte = datetime.now(),
                                    ).first()
        # 認証URLの有効期限判定
        if user_email_activate_token is None:
            res = False
            msg = '仮登録URLの有効期限が切れています'
            return res, msg
        else:
            user = user_email_activate_token.user
            if user.is_change_email_request is True:
                user.is_change_email_request = False
                user.save() # 同じアドレスによって弾かれた場合に備えて一旦モデル保存
                user.email        = user.change_email  # email の変更
                user.change_email = '[email protected]' # 変更後の email を認証したら change_email フィールドをリセット
                user.save()  # SUCCESS
                res = True
                msg = 'メールアドレスの変更が完了しました\n\
                       変更したメールアドレスでログインしてください。'
                # 使用した Token の破棄
                user_email_activate_token.delete()
                return res, msg
            else:
                res = False
                msg = '再度メールアドレスの変更を行ってください'
                return res, msg

^{https://github.com/MITSUHIRO-KURIKI/DjangoTemplate/blob/main/accounts/models/ActivateToken_models.py#L42}