From 52ca8025d45143bdfed5224057ae2aaebbf20319 Mon Sep 17 00:00:00 2001
From: shamoon <4887959+shamoon@users.noreply.github.com>
Date: Sat, 19 Oct 2024 20:00:28 -0700
Subject: [PATCH] Refactoring

---
 src-ui/src/app/services/profile.service.ts |  6 +++---
 src/paperless/urls.py                      |  8 ++++----
 src/paperless/views.py                     | 19 ++++++++++---------
 3 files changed, 17 insertions(+), 16 deletions(-)

diff --git a/src-ui/src/app/services/profile.service.ts b/src-ui/src/app/services/profile.service.ts
index 1a799e617..09839d012 100644
--- a/src-ui/src/app/services/profile.service.ts
+++ b/src-ui/src/app/services/profile.service.ts
@@ -51,7 +51,7 @@ export class ProfileService {
 
   getTotpSettings(): Observable<TotpSettings> {
     return this.http.get<TotpSettings>(
-      `${environment.apiBaseUrl}${this.endpoint}/totp_activate/`
+      `${environment.apiBaseUrl}${this.endpoint}/totp/`
     )
   }
 
@@ -60,7 +60,7 @@ export class ProfileService {
     totpCode: string
   ): Observable<{ success: boolean; recovery_codes: string[] }> {
     return this.http.post<{ success: boolean; recovery_codes: string[] }>(
-      `${environment.apiBaseUrl}${this.endpoint}/totp_activate/`,
+      `${environment.apiBaseUrl}${this.endpoint}/totp/`,
       {
         secret: totpSecret,
         code: totpCode,
@@ -70,7 +70,7 @@ export class ProfileService {
 
   deactivateTotp(): Observable<boolean> {
     return this.http.delete<boolean>(
-      `${environment.apiBaseUrl}${this.endpoint}/totp_activate/`,
+      `${environment.apiBaseUrl}${this.endpoint}/totp/`,
       {}
     )
   }
diff --git a/src/paperless/urls.py b/src/paperless/urls.py
index 23f91b5cd..6ca02f7a7 100644
--- a/src/paperless/urls.py
+++ b/src/paperless/urls.py
@@ -54,7 +54,7 @@ from paperless.views import GenerateAuthTokenView
 from paperless.views import GroupViewSet
 from paperless.views import ProfileView
 from paperless.views import SocialAccountProvidersView
-from paperless.views import TOTPActivateView
+from paperless.views import TOTPView
 from paperless.views import UserViewSet
 from paperless_mail.views import MailAccountTestView
 from paperless_mail.views import MailAccountViewSet
@@ -166,9 +166,9 @@ urlpatterns = [
                                 name="profile_view",
                             ),
                             path(
-                                "totp_activate/",
-                                TOTPActivateView.as_view(),
-                                name="activate",
+                                "totp/",
+                                TOTPView.as_view(),
+                                name="totp_view",
                             ),
                             # TODO: remove allauth urls?
                         ],
diff --git a/src/paperless/views.py b/src/paperless/views.py
index 6cf3ec979..0157b885e 100644
--- a/src/paperless/views.py
+++ b/src/paperless/views.py
@@ -151,7 +151,7 @@ class ProfileView(GenericAPIView):
         return Response(serializer.to_representation(user))
 
 
-class TOTPActivateView(GenericAPIView):
+class TOTPView(GenericAPIView):
     """
     TOTP views
     """
@@ -159,6 +159,9 @@ class TOTPActivateView(GenericAPIView):
     permission_classes = [IsAuthenticated]
 
     def get(self, request, *args, **kwargs):
+        """
+        Generates a new TOTP secret and returns the URL and SVG
+        """
         user = self.request.user
         mfa_adapter = get_mfa_adapter()
         secret = totp_auth.get_totp_secret(regenerate=True)
@@ -173,13 +176,15 @@ class TOTPActivateView(GenericAPIView):
         )
 
     def post(self, request, *args, **kwargs):
+        """
+        Validates a TOTP code and activates the TOTP authenticator
+        """
         valid = totp_auth.validate_totp_code(
             request.data["secret"],
             request.data["code"],
         )
         recovery_codes = None
         if valid:
-            # from allauth.mfa.totp.internal.flows activate_totp
             auth = totp_auth.TOTP.activate(
                 request.user,
                 request.data["secret"],
@@ -190,9 +195,6 @@ class TOTPActivateView(GenericAPIView):
                 user=request.user,
                 authenticator=auth,
             )
-            # adapter = get_adapter()
-            # adapter.add_message(request, messages.SUCCESS, "mfa/messages/totp_activated.txt")
-            # adapter.send_notification_mail("mfa/email/totp_activated", request.user)
             rc_auth: Authenticator = auto_generate_recovery_codes(request)
             if rc_auth:
                 recovery_codes = rc_auth.wrap().get_unused_codes()
@@ -204,17 +206,16 @@ class TOTPActivateView(GenericAPIView):
         )
 
     def delete(self, request, *args, **kwargs):
+        """
+        Deactivates the TOTP authenticator
+        """
         user = self.request.user
         try:
-            # from allauth.mfa.totp.internal.flows deactivate_totp
             authenticator = Authenticator.objects.filter(
                 user=user,
                 type=Authenticator.Type.TOTP,
             ).first()
             delete_and_cleanup(request, authenticator)
-            # adapter = get_account_adapter(request)
-            # adapter.add_message(request, messages.SUCCESS, "mfa/messages/totp_deactivated.txt")
-            # adapter.send_notification_mail("mfa/email/totp_deactivated", request.user)
             return Response(True)
         except Authenticator.DoesNotExist:
             return HttpResponseBadRequest("TOTP not found")