feat: add ActionInterface::getType()

Author: kenjis

src/Authentication/Actions/ActionInterface.php

@@ -39,4 +39,10 @@ public function handle(IncomingRequest $request);
      * @return Response|string
      */
     public function verify(IncomingRequest $request);
+
+    /**
+     * Returns the string type of the action class.
+     * E.g., 'email_2fa', 'email_activate'.
+     */
+    public function getType(): string;
 }

src/Authentication/Actions/Email2FA.php

@@ -16,6 +16,8 @@
  */
 class Email2FA implements ActionInterface
 {
+    private string $type = 'email_2fa';
+
     /**
      * Displays the "Hey we're going to send you an number to your email"
      * message to the user with a prompt to continue.
@@ -61,7 +63,7 @@ public function handle(IncomingRequest $request)
         /** @var UserIdentityModel $identityModel */
         $identityModel = model(UserIdentityModel::class);
 
-        $identity = $identityModel->getIdentityByType($user->getAuthId(), 'email_2fa');
+        $identity = $identityModel->getIdentityByType($user->getAuthId(), $this->type);
 
         if (empty($identity)) {
             return redirect()->route('auth-action-show')->with('error', lang('Auth.need2FA'));
@@ -95,7 +97,7 @@ public function verify(IncomingRequest $request)
         $authenticator = auth('session')->getAuthenticator();
 
         // Token mismatch? Let them try again...
-        if (! $authenticator->checkAction('email_2fa', $token)) {
+        if (! $authenticator->checkAction($this->type, $token)) {
             session()->setFlashdata('error', lang('Auth.invalid2FAToken'));
 
             return view(setting('Auth.views')['action_email_2fa_verify']);
@@ -124,17 +126,22 @@ private function createIdentity(User $user): void
         $userIdentityModel = model(UserIdentityModel::class);
 
         // Delete any previous activation identities
-        $userIdentityModel->deleteIdentitiesByType($user->getAuthId(), 'email_2fa');
+        $userIdentityModel->deleteIdentitiesByType($user->getAuthId(), $this->type);
 
         // Create an identity for our 2fa hash
         $code = random_string('nozero', 6);
 
         $userIdentityModel->insert([
             'user_id' => $user->getAuthId(),
-            'type'    => 'email_2fa',
+            'type'    => $this->type,
             'secret'  => $code,
             'name'    => 'login',
             'extra'   => lang('Auth.need2FA'),
         ]);
     }
+
+    public function getType(): string
+    {
+        return $this->type;
+    }
 }

src/Authentication/Actions/EmailActivator.php

@@ -13,6 +13,8 @@
 
 class EmailActivator implements ActionInterface
 {
+    private string $type = 'email_activate';
+
     /**
      * Shows the initial screen to the user telling them
      * that an email was just sent to them with a link
@@ -75,7 +77,7 @@ public function verify(IncomingRequest $request)
         $authenticator = auth('session')->getAuthenticator();
 
         // No match - let them try again.
-        if (! $authenticator->checkAction('email_activate', $token)) {
+        if (! $authenticator->checkAction($this->type, $token)) {
             session()->setFlashdata('error', lang('Auth.invalidActivateToken'));
 
             return view(setting('Auth.views')['action_email_activate_show']);
@@ -110,19 +112,24 @@ private function createIdentity(User $user): string
         /** @var UserIdentityModel $userIdentityModel */
         $userIdentityModel = model(UserIdentityModel::class);
 
-        $userIdentityModel->deleteIdentitiesByType($user->getAuthId(), 'email_activate');
+        $userIdentityModel->deleteIdentitiesByType($user->getAuthId(), $this->type);
 
         //  Create an identity for our activation hash
         $code = random_string('nozero', 6);
 
         $userIdentityModel->insert([
             'user_id' => $user->getAuthId(),
-            'type'    => 'email_activate',
+            'type'    => $this->type,
             'secret'  => $code,
             'name'    => 'register',
             'extra'   => lang('Auth.needVerification'),
         ]);
 
         return $code;
     }
+
+    public function getType(): string
+    {
+        return $this->type;
+    }
 }