From 50a77adcffa6a587b7565ee5c457ba24beffb33e Mon Sep 17 00:00:00 2001
From: Chuck Hagenbuch <chuck@horde.org>
Date: Tue, 14 Jul 2009 00:36:49 -0400
Subject: [PATCH] rename Horde_Auth_Driver to Horde_Auth_Base to match the
 convention of other H4 libraries

---
 framework/Auth/lib/Horde/Auth.php                      | 17 +++++------------
 framework/Auth/lib/Horde/Auth/Application.php          |  2 +-
 framework/Auth/lib/Horde/Auth/Auto.php                 |  2 +-
 framework/Auth/lib/Horde/Auth/{Driver.php => Base.php} |  8 +++-----
 framework/Auth/lib/Horde/Auth/Composite.php            |  2 +-
 framework/Auth/lib/Horde/Auth/Cyrus.php                |  4 ++--
 framework/Auth/lib/Horde/Auth/Ftp.php                  |  2 +-
 framework/Auth/lib/Horde/Auth/Http.php                 |  2 +-
 framework/Auth/lib/Horde/Auth/HttpRemote.php           |  2 +-
 framework/Auth/lib/Horde/Auth/Imap.php                 |  2 +-
 framework/Auth/lib/Horde/Auth/Imsp.php                 |  2 +-
 framework/Auth/lib/Horde/Auth/Ipbasic.php              |  2 +-
 framework/Auth/lib/Horde/Auth/Kolab.php                |  4 ++--
 framework/Auth/lib/Horde/Auth/Krb5.php                 |  2 +-
 framework/Auth/lib/Horde/Auth/Ldap.php                 |  2 +-
 framework/Auth/lib/Horde/Auth/Login.php                |  2 +-
 framework/Auth/lib/Horde/Auth/Pam.php                  |  2 +-
 framework/Auth/lib/Horde/Auth/Passwd.php               |  2 +-
 framework/Auth/lib/Horde/Auth/Peclsasl.php             |  2 +-
 framework/Auth/lib/Horde/Auth/Radius.php               |  2 +-
 framework/Auth/lib/Horde/Auth/Shibboleth.php           |  2 +-
 framework/Auth/lib/Horde/Auth/Smb.php                  |  2 +-
 framework/Auth/lib/Horde/Auth/Smbclient.php            |  2 +-
 framework/Auth/lib/Horde/Auth/Sql.php                  |  2 +-
 framework/Auth/package.xml                             |  6 +++---
 25 files changed, 35 insertions(+), 44 deletions(-)
 rename framework/Auth/lib/Horde/Auth/{Driver.php => Base.php} (98%)

diff --git a/framework/Auth/lib/Horde/Auth.php b/framework/Auth/lib/Horde/Auth.php
index 91bb640b4..7402c0579 100644
--- a/framework/Auth/lib/Horde/Auth.php
+++ b/framework/Auth/lib/Horde/Auth.php
@@ -68,17 +68,17 @@ class Horde_Auth
     static protected $_instances = array();
 
     /**
-     * Attempts to return a concrete Horde_Auth_Driver instance based on
+     * Attempts to return a concrete Horde_Auth_Base instance based on
      * $driver.
      *
-     * @param mixed $driver  The type of concrete Horde_Auth_Driver subclass
+     * @param mixed $driver  The type of concrete Horde_Auth_Base subclass
      *                       to return. If $driver is an array, then look
      *                       in $driver[0]/lib/Auth/ for the subclass
      *                       implementation named $driver[1].php.
      * @param array $params  A hash containing any additional configuration or
      *                       parameters a subclass might need.
      *
-     * @return Horde_Auth_Driver  The newly created concrete instance.
+     * @return Horde_Auth_Base  The newly created concrete instance.
      * @throws Horde_Exception
      */
     static public function factory($driver, $params = null)
@@ -90,18 +90,11 @@ class Horde_Auth
             $driver = basename($driver);
         }
 
-        /* Return a base Horde_Auth_Driver object if no driver is
-         * specified. */
-        if (empty($driver) || (strcasecmp($driver, 'none') == 0)) {
-            return new Horde_Auth_Driver();
-        }
-
         if (empty($params)) {
             $params = Horde::getDriverConfig('auth', $driver);
         }
 
         $class = (empty($app) ? 'Horde' : $app) . '_Auth_' . ucfirst($driver);
-
         if (class_exists($class)) {
             return new $class($params);
         }
@@ -116,14 +109,14 @@ class Horde_Auth
      *
      * This method must be invoked as: $var = Horde_Auth::singleton()
      *
-     * @param mixed $driver  The type of concrete Horde_Auth_Driver subclass
+     * @param mixed $driver  The type of concrete Horde_Auth_Base subclass
      *                       to return. If $driver is an array, then look
      *                       in $driver[0]/lib/Auth/ for the subclass
      *                       implementation named $driver[1].php.
      * @param array $params  A hash containing any additional configuration or
      *                       connection parameters a subclass might need.
      *
-     * @return Horde_Auth_Driver  The concrete reference.
+     * @return Horde_Auth_Base  The concrete reference.
      * @throws Horde_Exception
      */
     static public function singleton($driver, $params = array())
diff --git a/framework/Auth/lib/Horde/Auth/Application.php b/framework/Auth/lib/Horde/Auth/Application.php
index c3d161871..fa486946f 100644
--- a/framework/Auth/lib/Horde/Auth/Application.php
+++ b/framework/Auth/lib/Horde/Auth/Application.php
@@ -17,7 +17,7 @@
  * @author  Chuck Hagenbuch <chuck@horde.org>
  * @package Horde_Auth
  */
-class Horde_Auth_Application extends Horde_Auth_Driver
+class Horde_Auth_Application extends Horde_Auth_Base
 {
     /**
      * Cache for hasCapability().
diff --git a/framework/Auth/lib/Horde/Auth/Auto.php b/framework/Auth/lib/Horde/Auth/Auto.php
index 3fac9b3fb..be5976090 100644
--- a/framework/Auth/lib/Horde/Auth/Auto.php
+++ b/framework/Auth/lib/Horde/Auth/Auto.php
@@ -24,7 +24,7 @@
  * @author  Chuck Hagenbuch <chuck@horde.org>
  * @package Horde_Auth
  */
-class Horde_Auth_Auto extends Horde_Auth_Driver
+class Horde_Auth_Auto extends Horde_Auth_Base
 {
     /**
      * An array of capabilities, so that the driver can report which
diff --git a/framework/Auth/lib/Horde/Auth/Driver.php b/framework/Auth/lib/Horde/Auth/Base.php
similarity index 98%
rename from framework/Auth/lib/Horde/Auth/Driver.php
rename to framework/Auth/lib/Horde/Auth/Base.php
index 7583bcb43..7a7999426 100644
--- a/framework/Auth/lib/Horde/Auth/Driver.php
+++ b/framework/Auth/lib/Horde/Auth/Base.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * The Horde_Auth_Driver:: class provides a common abstracted interface to
+ * The Horde_Auth_Base:: class provides a common abstracted interface to
  * creating various authentication backends.
  *
  * Copyright 1999-2009 The Horde Project (http://www.horde.org/)
@@ -12,7 +12,7 @@
  * @author  Michael Slusarz <slusarz@curecanti.org>
  * @package Horde_Auth
  */
-class Horde_Auth_Driver
+abstract class Horde_Auth_Base
 {
     /**
      * An array of capabilities, so that the driver can report which
@@ -127,9 +127,7 @@ class Horde_Auth_Driver
      *
      * @throws Horde_Exception
      */
-    protected function _authenticate()
-    {
-    }
+    abstract protected function _authenticate();
 
     /**
      * Adds a set of authentication credentials.
diff --git a/framework/Auth/lib/Horde/Auth/Composite.php b/framework/Auth/lib/Horde/Auth/Composite.php
index 5dd17ab65..5d6255639 100644
--- a/framework/Auth/lib/Horde/Auth/Composite.php
+++ b/framework/Auth/lib/Horde/Auth/Composite.php
@@ -12,7 +12,7 @@
  * @author  Chuck Hagenbuch <chuck@horde.org>
  * @package Horde_Auth
  */
-class Horde_Auth_Composite extends Horde_Auth_Driver
+class Horde_Auth_Composite extends Horde_Auth_Base
 {
     /**
      * Hash containing any instantiated drivers.
diff --git a/framework/Auth/lib/Horde/Auth/Cyrus.php b/framework/Auth/lib/Horde/Auth/Cyrus.php
index ec34da4db..3ce2227ad 100644
--- a/framework/Auth/lib/Horde/Auth/Cyrus.php
+++ b/framework/Auth/lib/Horde/Auth/Cyrus.php
@@ -83,7 +83,7 @@
  * @author  Mike Cochrane <mike@graftonhall.co.nz>
  * @package Horde_Auth
  */
-class Horde_Auth_Cyrus extends Horde_Auth_Driver
+class Horde_Auth_Cyrus extends Horde_Auth_Base
 {
     /**
      * Horde_Imap_Client object.
@@ -95,7 +95,7 @@ class Horde_Auth_Cyrus extends Horde_Auth_Driver
     /**
      * Pointer to another backend that Cyrus authenticates against.
      *
-     * @var Horde_Auth_Driver
+     * @var Horde_Auth_Base
      */
      protected $_backend;
 
diff --git a/framework/Auth/lib/Horde/Auth/Ftp.php b/framework/Auth/lib/Horde/Auth/Ftp.php
index 3003c0c47..531e77e7b 100644
--- a/framework/Auth/lib/Horde/Auth/Ftp.php
+++ b/framework/Auth/lib/Horde/Auth/Ftp.php
@@ -20,7 +20,7 @@
  * @author  Max Kalika <max@horde.org>
  * @package Horde_Auth
  */
-class Horde_Auth_Ftp extends Horde_Auth_Driver
+class Horde_Auth_Ftp extends Horde_Auth_Base
 {
     /**
      * Constructor.
diff --git a/framework/Auth/lib/Horde/Auth/Http.php b/framework/Auth/lib/Horde/Auth/Http.php
index 99693c5bf..f5a8508b7 100644
--- a/framework/Auth/lib/Horde/Auth/Http.php
+++ b/framework/Auth/lib/Horde/Auth/Http.php
@@ -17,7 +17,7 @@
  * @author  Chuck Hagenbuch <chuck@horde.org>
  * @package Horde_Auth
  */
-class Horde_Auth_Http extends Horde_Auth_Driver
+class Horde_Auth_Http extends Horde_Auth_Base
 {
     /**
      * An array of capabilities, so that the driver can report which
diff --git a/framework/Auth/lib/Horde/Auth/HttpRemote.php b/framework/Auth/lib/Horde/Auth/HttpRemote.php
index 7b8aa31ad..79bd206c7 100644
--- a/framework/Auth/lib/Horde/Auth/HttpRemote.php
+++ b/framework/Auth/lib/Horde/Auth/HttpRemote.php
@@ -11,7 +11,7 @@
  * @author  Duck <duck@obala.net>
  * @package Horde_Auth
  */
-class Horde_Auth_HttpRemote extends Horde_Auth_Driver
+class Horde_Auth_HttpRemote extends Horde_Auth_Base
 {
     /**
      * Find out if a set of login credentials are valid.
diff --git a/framework/Auth/lib/Horde/Auth/Imap.php b/framework/Auth/lib/Horde/Auth/Imap.php
index b20db106f..6571e1315 100644
--- a/framework/Auth/lib/Horde/Auth/Imap.php
+++ b/framework/Auth/lib/Horde/Auth/Imap.php
@@ -37,7 +37,7 @@
  * @author  Jan Schneider <jan@horde.org>
  * @package Horde_Auth
  */
-class Horde_Auth_Imap extends Horde_Auth_Driver
+class Horde_Auth_Imap extends Horde_Auth_Base
 {
     /**
      * Constructor.
diff --git a/framework/Auth/lib/Horde/Auth/Imsp.php b/framework/Auth/lib/Horde/Auth/Imsp.php
index 6004ac46d..ee0d058bf 100644
--- a/framework/Auth/lib/Horde/Auth/Imsp.php
+++ b/framework/Auth/lib/Horde/Auth/Imsp.php
@@ -13,7 +13,7 @@
  * @author  Michael Rubinsky <mrubinsk@horde.org>
  * @package Horde_Auth
  */
-class Horde_Auth_imsp extends Horde_Auth_Driver
+class Horde_Auth_imsp extends Horde_Auth_Base
 {
     /**
      * Private authentication function.
diff --git a/framework/Auth/lib/Horde/Auth/Ipbasic.php b/framework/Auth/lib/Horde/Auth/Ipbasic.php
index 066adfb96..1e89f22b8 100644
--- a/framework/Auth/lib/Horde/Auth/Ipbasic.php
+++ b/framework/Auth/lib/Horde/Auth/Ipbasic.php
@@ -18,7 +18,7 @@
  * @author  Chuck Hagenbuch <chuck@horde.org>
  * @package Horde_Auth
  */
-class Horde_Auth_Ipbasic extends Horde_Auth_Driver
+class Horde_Auth_Ipbasic extends Horde_Auth_Base
 {
     /**
      * An array of capabilities, so that the driver can report which
diff --git a/framework/Auth/lib/Horde/Auth/Kolab.php b/framework/Auth/lib/Horde/Auth/Kolab.php
index d511467dd..f96c92539 100644
--- a/framework/Auth/lib/Horde/Auth/Kolab.php
+++ b/framework/Auth/lib/Horde/Auth/Kolab.php
@@ -14,7 +14,7 @@
  * @author  Gunnar Wrobel <wrobel@pardus.de>
  * @package Horde_Auth
  */
-class Horde_Auth_Kolab extends Horde_Auth_Driver
+class Horde_Auth_Kolab extends Horde_Auth_Base
 {
     /**
      * An array of capabilities, so that the driver can report which
@@ -138,7 +138,7 @@ class Horde_Auth_Kolab extends Horde_Auth_Driver
      */
     function setAuth($userId, $credentials, $realm = null, $changeRequested = false)
     {
-        // TODO - setAuth doesn't exist in Horde_Auth_Driver
+        // TODO - setAuth doesn't exist in Horde_Auth_Base
         //        This should probably use _username_hook_frombackend.
 
         if (class_exists('Horde_Kolab_Session')) {
diff --git a/framework/Auth/lib/Horde/Auth/Krb5.php b/framework/Auth/lib/Horde/Auth/Krb5.php
index 8a248448a..ebf7f72a4 100644
--- a/framework/Auth/lib/Horde/Auth/Krb5.php
+++ b/framework/Auth/lib/Horde/Auth/Krb5.php
@@ -18,7 +18,7 @@
  * @author  Michael Slusarz <slusarz@horde.org>
  * @package Horde_Auth
  */
-class Horde_Auth_Krb5 extends Horde_Auth_Driver
+class Horde_Auth_Krb5 extends Horde_Auth_Base
 {
     /**
      * Constructor.
diff --git a/framework/Auth/lib/Horde/Auth/Ldap.php b/framework/Auth/lib/Horde/Auth/Ldap.php
index 22b0e021c..c5dd4fb99 100644
--- a/framework/Auth/lib/Horde/Auth/Ldap.php
+++ b/framework/Auth/lib/Horde/Auth/Ldap.php
@@ -30,7 +30,7 @@
  * @author  Jon Parise <jon@horde.org>
  * @package Horde_Auth
  */
-class Horde_Auth_Ldap extends Horde_Auth_Driver
+class Horde_Auth_Ldap extends Horde_Auth_Base
 {
     /**
      * An array of capabilities, so that the driver can report which
diff --git a/framework/Auth/lib/Horde/Auth/Login.php b/framework/Auth/lib/Horde/Auth/Login.php
index 9f229be71..2549cc58e 100644
--- a/framework/Auth/lib/Horde/Auth/Login.php
+++ b/framework/Auth/lib/Horde/Auth/Login.php
@@ -19,7 +19,7 @@
  * @author  Jan Schneider <jan@horde.org>
  * @package Horde_Auth
  */
-class Horde_Auth_Login extends Horde_Auth_Driver
+class Horde_Auth_Login extends Horde_Auth_Base
 {
     /**
      * List of users that should be excluded from being listed/handled
diff --git a/framework/Auth/lib/Horde/Auth/Pam.php b/framework/Auth/lib/Horde/Auth/Pam.php
index 282a0755d..7dba7fd5b 100644
--- a/framework/Auth/lib/Horde/Auth/Pam.php
+++ b/framework/Auth/lib/Horde/Auth/Pam.php
@@ -26,7 +26,7 @@
  * @author  Jon Parise <jon@horde.org>
  * @package Horde_Auth
  */
-class Horde_Auth_Pam extends Horde_Auth_Driver
+class Horde_Auth_Pam extends Horde_Auth_Base
 {
     /**
      * Constructor.
diff --git a/framework/Auth/lib/Horde/Auth/Passwd.php b/framework/Auth/lib/Horde/Auth/Passwd.php
index e1a6040ec..34971a6de 100644
--- a/framework/Auth/lib/Horde/Auth/Passwd.php
+++ b/framework/Auth/lib/Horde/Auth/Passwd.php
@@ -33,7 +33,7 @@
  * @author  Chuck Hagenbuch <chuck@horde.org>
  * @package Horde_Auth
  */
-class Horde_Auth_Passwd extends Horde_Auth_Driver
+class Horde_Auth_Passwd extends Horde_Auth_Base
 {
     /**
      * An array of capabilities, so that the driver can report which
diff --git a/framework/Auth/lib/Horde/Auth/Peclsasl.php b/framework/Auth/lib/Horde/Auth/Peclsasl.php
index 600756e7e..6b3dd9a9d 100644
--- a/framework/Auth/lib/Horde/Auth/Peclsasl.php
+++ b/framework/Auth/lib/Horde/Auth/Peclsasl.php
@@ -27,7 +27,7 @@
  * @author  Jon Parise <jon@horde.org>
  * @package Horde_Auth
  */
-class Horde_Auth_Peclsasl extends Horde_Auth_Driver
+class Horde_Auth_Peclsasl extends Horde_Auth_Base
 {
     /**
      * Constructor.
diff --git a/framework/Auth/lib/Horde/Auth/Radius.php b/framework/Auth/lib/Horde/Auth/Radius.php
index 804c391b5..05b42fe23 100644
--- a/framework/Auth/lib/Horde/Auth/Radius.php
+++ b/framework/Auth/lib/Horde/Auth/Radius.php
@@ -55,7 +55,7 @@
  * @author  Michael Slusarz <slusarz@horde.org>
  * @package Horde_Auth
  */
-class Horde_Auth_Radius extends Horde_Auth_Driver
+class Horde_Auth_Radius extends Horde_Auth_Base
 {
     /**
      * Constructor.
diff --git a/framework/Auth/lib/Horde/Auth/Shibboleth.php b/framework/Auth/lib/Horde/Auth/Shibboleth.php
index 810147e5a..cd7ee2197 100644
--- a/framework/Auth/lib/Horde/Auth/Shibboleth.php
+++ b/framework/Auth/lib/Horde/Auth/Shibboleth.php
@@ -28,7 +28,7 @@
  * @author  Cassio Nishiguchi <cassio@protectnetwork.org>
  * @package Horde_Auth
  */
-class Horde_Auth_Shibboleth extends Horde_Auth_Driver
+class Horde_Auth_Shibboleth extends Horde_Auth_Base
 {
     /**
      * An array of capabilities, so that the driver can report which
diff --git a/framework/Auth/lib/Horde/Auth/Smb.php b/framework/Auth/lib/Horde/Auth/Smb.php
index 0a02c9a05..48fec9cd4 100644
--- a/framework/Auth/lib/Horde/Auth/Smb.php
+++ b/framework/Auth/lib/Horde/Auth/Smb.php
@@ -33,7 +33,7 @@
  * @author  Marcus I. Ryan <marcus@riboflavin.net>
  * @package Horde_Auth
  */
-class Horde_Auth_Smb extends Horde_Auth_Driver
+class Horde_Auth_Smb extends Horde_Auth_Base
 {
     /**
      * Constructor.
diff --git a/framework/Auth/lib/Horde/Auth/Smbclient.php b/framework/Auth/lib/Horde/Auth/Smbclient.php
index 121745e26..c2e7201c1 100644
--- a/framework/Auth/lib/Horde/Auth/Smbclient.php
+++ b/framework/Auth/lib/Horde/Auth/Smbclient.php
@@ -26,7 +26,7 @@
  * @author  Marcus I. Ryan <marcus@riboflavin.net>
  * @package Horde_Auth
  */
-class Horde_Auth_Smbclient extends Horde_Auth_Driver
+class Horde_Auth_Smbclient extends Horde_Auth_Base
 {
     /**
      * Constructor.
diff --git a/framework/Auth/lib/Horde/Auth/Sql.php b/framework/Auth/lib/Horde/Auth/Sql.php
index 8200d42d4..dda5f5599 100644
--- a/framework/Auth/lib/Horde/Auth/Sql.php
+++ b/framework/Auth/lib/Horde/Auth/Sql.php
@@ -67,7 +67,7 @@
  * @author  Chuck Hagenbuch <chuck@horde.org>
  * @package Horde_Auth
  */
-class Horde_Auth_Sql extends Horde_Auth_Driver
+class Horde_Auth_Sql extends Horde_Auth_Base
 {
     /**
      * An array of capabilities, so that the driver can report which
diff --git a/framework/Auth/package.xml b/framework/Auth/package.xml
index 22a9bfa8c..78e56b64a 100644
--- a/framework/Auth/package.xml
+++ b/framework/Auth/package.xml
@@ -30,7 +30,7 @@ http://pear.php.net/dtd/package-2.0.xsd">
   <api>beta</api>
  </stability>
  <license uri="http://opensource.org/licenses/lgpl-2.1.php">LGPL</license>
- <notes>* Split Horde_Auth:: into Horde_Auth:: and Horde_Auth_Driver:: components.
+ <notes>* Split Horde_Auth:: into Horde_Auth:: and Horde_Auth_Base:: components.
  * Initial Horde 4 package.
  </notes>
  <contents>
@@ -43,11 +43,11 @@ http://pear.php.net/dtd/package-2.0.xsd">
       </dir> <!-- /lib/Horde/Auth/Signup -->
       <file name="Application.php" role="php" />
       <file name="Auto.php" role="php" />
+      <file name="Base.php" role="php" />
       <file name="Composite.php" role="php" />
       <file name="Customsql.php" role="php" />
       <file name="Cyrsql.php" role="php" />
       <file name="Cyrus.php" role="php" />
-      <file name="Driver.php" role="php" />
       <file name="Ftp.php" role="php" />
       <file name="Http.php" role="php" />
       <file name="HttpRemote.php" role="php" />
@@ -143,11 +143,11 @@ http://pear.php.net/dtd/package-2.0.xsd">
    <install name="lib/Horde/Auth/Signup/Sql.php" as="Horde/Auth/Signup/Sql.php" />
    <install name="lib/Horde/Auth/Application.php" as="Horde/Auth/Application.php" />
    <install name="lib/Horde/Auth/Auto.php" as="Horde/Auth/Auto.php" />
+   <install name="lib/Horde/Auth/Base.php" as="Horde/Auth/Base.php" />
    <install name="lib/Horde/Auth/Composite.php" as="Horde/Auth/Composite.php" />
    <install name="lib/Horde/Auth/Customsql.php" as="Horde/Auth/Customsql.php" />
    <install name="lib/Horde/Auth/Cyrsql.php" as="Horde/Auth/Cyrsql.php" />
    <install name="lib/Horde/Auth/Cyrus.php" as="Horde/Auth/Cyrus.php" />
-   <install name="lib/Horde/Auth/Driver.php" as="Horde/Auth/Driver.php" />
    <install name="lib/Horde/Auth/Ftp.php" as="Horde/Auth/Ftp.php" />
    <install name="lib/Horde/Auth/Http.php" as="Horde/Auth/Http.php" />
    <install name="lib/Horde/Auth/HttpRemote.php" as="Horde/Auth/HttpRemote.php" />
-- 
2.11.0