From d24993756c3cc44ec605adb79cca737537b2fe15 Mon Sep 17 00:00:00 2001
From: Michael M Slusarz <slusarz@curecanti.org>
Date: Wed, 22 Jul 2009 11:41:45 -0600
Subject: [PATCH] Add Horde_Auth_Application callback feature.

Using application auth, especially if using application auth as horde
auth, there was previously a severe limitation in that the application
only had a limited environment when doing the auth.  This makes sense
because, since no user was yet logged in, there was no way to init
things such as prefs.  Best (only?) solution is to understand that
application auth only has limited environment and should be used to do
the minimum necessary to verify authentication only.  Login tasks and
the like need a full environment, so add a authentication callback hook
that will re-call the application after a full environment can be setup.
---
 framework/Auth/lib/Horde/Auth/Application.php | 55 +++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)

diff --git a/framework/Auth/lib/Horde/Auth/Application.php b/framework/Auth/lib/Horde/Auth/Application.php
index d15550327..6df6e1981 100644
--- a/framework/Auth/lib/Horde/Auth/Application.php
+++ b/framework/Auth/lib/Horde/Auth/Application.php
@@ -34,6 +34,7 @@ class Horde_Auth_Application extends Horde_Auth_Base
     protected $_apiMethods = array(
         'add' => 'authAddUser',
         'authenticate' => 'authAuthenticate',
+        'authenticatecallback' => 'authAuthenticateCallback',
         'exists' => 'authUserExists',
         'list' => 'authUserList',
         'loginparams' => 'authLoginParams',
@@ -77,6 +78,29 @@ class Horde_Auth_Application extends Horde_Auth_Base
     }
 
     /**
+     * Finds out if a set of login credentials are valid, and if requested,
+     * mark the user as logged in in the current session.
+     *
+     * @param string $userId      The userId to check.
+     * @param array $credentials  The credentials to check.
+     * @param boolean $login      Whether to log the user in. If false, we'll
+     *                            only test the credentials and won't modify
+     *                            the current session. Defaults to true.
+     *
+     * @return boolean  Whether or not the credentials are valid.
+     */
+    public function authenticate($userId, $credentials, $login = true)
+    {
+        if (!parent::authenticate($userId, $credentials, $login)) {
+            return false;
+        }
+
+        $this->_authCallback();
+
+        return true;
+    }
+
+    /**
      * Find out if a set of login credentials are valid.
      *
      * @param string $userId      The userId to check.
@@ -192,6 +216,23 @@ class Horde_Auth_Application extends Horde_Auth_Base
     }
 
     /**
+     * Automatic authentication.
+     *
+     * @return boolean  Whether or not the client is allowed.
+     * @throws Horde_Auth_Exception
+     */
+    public function transparent()
+    {
+        if (!parent::transparent()) {
+            return false;
+        }
+
+        $this->_authCallback();
+
+        return true;
+    }
+
+    /**
      * Attempt transparent authentication.
      *
      * @return boolean  Whether transparent login is supported.
@@ -256,4 +297,18 @@ class Horde_Auth_Application extends Horde_Auth_Base
         }
     }
 
+    /**
+     * Provide way to finish authentication tasks in an application and ensure
+     * that the full application environment is loaded.
+     *
+     * @throws Horde_Auth_Exception
+     */
+    protected function _authCallback()
+    {
+        if ($this->hasCapability('authenticatecallback')) {
+            $registry = Horde_Registry::singleton();
+            $registry->callByPackage($this->_params['app'], $this->_apiMethods['authenticatecallback']);
+        }
+    }
+
 }
-- 
2.11.0