Merge pull request #644 from vufind-org/pre-login-hook

Added preLoginCheck() method to determine ChoiceAuth strategy before …

module/VuFind/src/VuFind/Auth/AbstractBase.php

@@ -78,6 +78,23 @@ abstract class AbstractBase implements \VuFind\Db\Table\DbTableAwareInterface,
         return $this->config;
     }
 
+    /**
+     * Inspect the user's request prior to processing a login request; this is
+     * essentially an event hook which most auth modules can ignore. See
+     * ChoiceAuth for a use case example.
+     *
+     * @param \Zend\Http\PhpEnvironment\Request $request Request object.
+     *
+     * @throws AuthException
+     * @return void
+     *
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function preLoginCheck($request)
+    {
+        // By default, do no checking.
+    }
+
     /**
      * Set configuration.
      *

module/VuFind/src/VuFind/Auth/ChoiceAuth.php

@@ -123,6 +123,21 @@ class ChoiceAuth extends AbstractBase
         );
     }
 
+    /**
+     * Inspect the user's request prior to processing a login request; this is
+     * essentially an event hook which most auth modules can ignore. See
+     * ChoiceAuth for a use case example.
+     *
+     * @param \Zend\Http\PhpEnvironment\Request $request Request object.
+     *
+     * @throws AuthException
+     * @return void
+     */
+    public function preLoginCheck($request)
+    {
+        $this->setStrategyFromRequest($request);
+    }
+
     /**
      * Attempt to authenticate the current user.  Throws exception if login fails.
      *

module/VuFind/src/VuFind/Auth/Manager.php

@@ -549,6 +549,10 @@ class Manager implements \ZfcRbac\Identity\IdentityProviderInterface
      */
     public function login($request)
     {
+        // Allow the auth module to inspect the request (used by ChoiceAuth,
+        // for example):
+        $this->getAuth()->preLoginCheck($request);
+
         // Validate CSRF for form-based authentication methods:
         if (!$this->getAuth()->getSessionInitiator(null)
             && !$this->csrf->isValid($request->getPost()->get('csrf'))