The initial commit of refactoring the user/group adminsitration into a driver.

Create an Identity library that defines the interface the Gallery3 expects
Move the user and group helpers into the gallery module to provide the familiar
interface into the Identity library.
Create a Gallery Identity back-end that is supplied by the user module.

The vision here is that all user and group code that is gallery or ui specific
is contained within the core product.  Anything that relates to manipulating a
user or group is contained in the back end code that can be replaced.

6 files changed, 751 insertions, 190 deletions

diff --git a/modules/gallery/config/identity.php b/modules/gallery/config/identity.php
new file mode 100644
index 00000000..f2064127
--- /dev/null
+++ b/modules/gallery/config/identity.php
@@ -0,0 +1,36 @@
+<?php defined("SYSPATH") or die("No direct script access.");
+/**
+ * Gallery - a web based photo album viewer and editor
+ * Copyright (C) 2000-2009 Bharat Mediratta
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or (at
+ * your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+/*
+ * @package  User
+ *
+ * User settings, defined as arrays, or "groups". If no group name is
+ * used when loading the cache library, the group named "default" will be used.
+ *
+ * Each group can be used independently, and multiple groups can be used at once.
+ *
+ * Group Options:
+ *  driver   - User backend driver. Gallery comes with Gallery user driver.
+ *
+ *  params   - Driver parameters, specific to each driver.
+ */
+$config["default"] = array (
+  "driver"   => "gallery",
+  "params"   => array(),
+);
diff --git a/modules/user/helpers/group.php b/modules/gallery/helpers/group.php
index b13895bc..e0182f9f 100644
--- a/modules/user/helpers/group.php
+++ b/modules/gallery/helpers/group.php
@@ -24,55 +24,6 @@
  * Note: by design, this class does not do any permission checking.
  */
 class group_Core {
-  /**
-   * Create a new group.
-   *
-   * @param string  $name
-   * @return Group_Model
-   */
-  static function create($name) {
-    $group = ORM::factory("group")->where("name", $name)->find();
-    if ($group->loaded) {
-      throw new Exception("@todo GROUP_ALREADY_EXISTS $name");
-    }
-
-    $group->name = $name;
-    $group->save();
-
-    return $group;
-  }
-
-  /**
-   * The group of all possible visitors.  This includes the guest user.
-   *
-   * @return Group_Model
-   */
-  static function everybody() {
-    return model_cache::get("group", 1);
-  }
-
-  /**
-   * The group of all logged-in visitors.  This does not include guest users.
-   *
-   * @return Group_Model
-   */
-  static function registered_users() {
-    return model_cache::get("group", 2);
-  }
-
-  /**
-   * Look up a group by name.
-   * @param integer      $id the group name
-   * @return Group_Model  the group object, or null if the name was invalid.
-   */
-  static function lookup_by_name($name) {
-    $group = model_cache::get("group", $name, "name");
-    if ($group->loaded) {
-      return $group;
-    }
-    return null;
-  }
-
   static function get_edit_form_admin($group) {
     $form = new Forge("admin/users/edit_group/$group->id", "", "post", array("id" => "g-edit-group-form"));
     $form_group = $form->group("edit_group")->label(t("Edit Group"));
@@ -105,4 +56,59 @@ class group_Core {
     $form_group->submit("")->value(t("Delete"));
     return $form;
   }
+
+  /**
+   * Create a new group.
+   *
+   * @param string  $name
+   * @return Group_Core
+   */
+  static function create($name) {
+    return Identity::instance()->create_group($name);
+  }
+
+  /**
+   * The group of all possible visitors.  This includes the guest user.
+   *
+   * @return Group_Core
+   */
+  static function everybody() {
+    return Identity::instance()->everybody();
+  }
+
+  /**
+   * The group of all logged-in visitors.  This does not include guest users.
+   *
+   * @return Group_Core
+   */
+  static function registered_users() {
+    return Identity::instance()->everybody();
+  }
+
+  /**
+   * Look up a group by id.
+   * @param integer      $id the user id
+   * @return Group_Model  the group object, or null if the id was invalid.
+   */
+  static function lookup($id) {
+    return Identity::instance()->lookup_group($id);
+  }
+
+  /**
+   * Look up a group by name.
+   * @param integer      $id the group name
+   * @return Group_Core  the group object, or null if the name was invalid.
+   */
+  static function lookup_by_name($name) {
+    return Identity::instance()->lookup_group_by_name($name);
+  }
+
+  /**
+   * List the groups
+   * @param mixed      options to apply to the selection of the user
+   * @return array     the group list.
+   */
+  static function groups($filter=array()) {
+    return Identity::instance()->list_groups($filter);
+  }
 }
diff --git a/modules/user/helpers/user.php b/modules/gallery/helpers/user.php
index 6ae9203d..d859d9bd 100644
--- a/modules/user/helpers/user.php
+++ b/modules/gallery/helpers/user.php
@@ -124,19 +124,73 @@ class user_Core {
   }
 
   /**
+   * Return the active user.  If there's no active user, return the guest user.
+   *
+   * @return User_Model
+   */
+  static function active() {
+    // @todo (maybe) cache this object so we're not always doing session lookups.
+    $user = Session::instance()->get("user", null);
+    if (!isset($user)) {
+      // Don't do this as a fallback in the Session::get() call because it can trigger unnecessary
+      // work.
+      $user = self::guest();
+    }
+    return $user;
+  }
+
+  /**
+   * Change the active user.
+   *
+   * @return User_Model
+   */
+  static function set_active($user) {
+    $session = Session::instance();
+    $session->set("user", $user);
+    $session->delete("group_ids");
+    self::load_user();
+  }
+
+  /**
+   * Return the array of group ids this user belongs to
+   *
+   * @return array
+   */
+  static function group_ids() {
+    return Session::instance()->get("group_ids", array(1));
+  }
+
+
+  static function cookie_locale() {
+    $cookie_data = Input::instance()->cookie("g_locale");
+    $locale = null;
+    if ($cookie_data) {
+      if (preg_match("/^([a-z]{2,3}(?:_[A-Z]{2})?)$/", trim($cookie_data), $matches)) {
+        $requested_locale = $matches[1];
+        $installed_locales = locales::installed();
+        if (isset($installed_locales[$requested_locale])) {
+          $locale = $requested_locale;
+        }
+      }
+    }
+    return $locale;
+  }
+
+    /**
    * Make sure that we have a session and group_ids cached in the session.
    */
   static function load_user() {
     $session = Session::instance();
     if (!($user = $session->get("user"))) {
-      $session->set("user", $user = user::guest());
+      $session->set("user", $user = self::guest());
     }
 
     // The installer cannot set a user into the session, so it just sets an id which we should
     // upconvert into a user.
+    // @todo what is user id===2
     if ($user === 2) {
       $user = model_cache::get("user", 2);
-      user::login($user);
+      self::login($user);
       $session->set("user", $user);
     }
 
@@ -150,28 +204,33 @@ class user_Core {
   }
 
   /**
-   * Return the array of group ids this user belongs to
-   *
-   * @return array
+   * Log in as a given user.
+   * @param object $user the user object.
    */
-  static function group_ids() {
-    return Session::instance()->get("group_ids", array(1));
+  static function login($user) {
+    // @todo make this an interface call
+    $user->login_count += 1;
+    $user->last_login = time();
+    $user->save();
+
+    self::set_active($user);
+    module::event("user_login", $user);
   }
 
   /**
-   * Return the active user.  If there's no active user, return the guest user.
-   *
-   * @return User_Model
+   * Log out the active user and destroy the session.
+   * @param object $user the user object.
    */
-  static function active() {
-    // @todo (maybe) cache this object so we're not always doing session lookups.
-    $user = Session::instance()->get("user", null);
-    if (!isset($user)) {
-      // Don't do this as a fallback in the Session::get() call because it can trigger unnecessary
-      // work.
-      $user = user::guest();
+  static function logout() {
+    $user = self::active();
+    if (!$user->guest) {
+      try {
+        Session::instance()->destroy();
+      } catch (Exception $e) {
+        Kohana::log("error", $e);
+      }
+      module::event("user_logout", $user);
     }
-    return $user;
   }
 
   /**
@@ -182,19 +241,7 @@ class user_Core {
    * @return User_Model
    */
   static function guest() {
-    return model_cache::get("user", 1);
-  }
-
-  /**
-   * Change the active user.
-   *
-   * @return User_Model
-   */
-  static function set_active($user) {
-    $session = Session::instance();
-    $session->set("user", $user);
-    $session->delete("group_ids");
-    self::load_user();
+    return Identity::instance()->guest();
   }
 
   /**
@@ -206,21 +253,7 @@ class user_Core {
    * @return User_Model
    */
   static function create($name, $full_name, $password) {
-    $user = ORM::factory("user")->where("name", $name)->find();
-    if ($user->loaded) {
-      throw new Exception("@todo USER_ALREADY_EXISTS $name");
-    }
-
-    $user->name = $name;
-    $user->full_name = $full_name;
-    $user->password = $password;
-
-    // Required groups
-    $user->add(group::everybody());
-    $user->add(group::registered_users());
-
-    $user->save();
-    return $user;
+    return Identity::instance()->create_user($name, $full_name, $password);
   }
 
   /**
@@ -231,31 +264,7 @@ class user_Core {
    * @return boolean true if the password is correct
    */
   static function is_correct_password($user, $password) {
-    $valid = $user->password;
-
-    // Try phpass first, since that's what we generate.
-    if (strlen($valid) == 34) {
-      require_once(MODPATH . "user/lib/PasswordHash.php");
-      $hashGenerator = new PasswordHash(10, true);
-      return $hashGenerator->CheckPassword($password, $valid);
-    }
-
-    $salt = substr($valid, 0, 4);
-    // Support both old (G1 thru 1.4.0; G2 thru alpha-4) and new password schemes:
-    $guess = (strlen($valid) == 32) ? md5($password) : ($salt . md5($salt . $password));
-    if (!strcmp($guess, $valid)) {
-      return true;
-    }
-
-    // Passwords with <&"> created by G2 prior to 2.1 were hashed with entities
-    $sanitizedPassword = html::specialchars($password, false);
-    $guess = (strlen($valid) == 32) ? md5($sanitizedPassword)
-          : ($salt . md5($salt . $sanitizedPassword));
-    if (!strcmp($guess, $valid)) {
-      return true;
-    }
-
-    return false;
+    return Identity::instance()->is_correct_password($user, $password);
   }
 
   /**
@@ -264,38 +273,7 @@ class user_Core {
    * @return string hashed password
    */
   static function hash_password($password) {
-    require_once(MODPATH . "user/lib/PasswordHash.php");
-    $hashGenerator = new PasswordHash(10, true);
-    return $hashGenerator->HashPassword($password);
-  }
-
-  /**
-   * Log in as a given user.
-   * @param object $user the user object.
-   */
-  static function login($user) {
-    $user->login_count += 1;
-    $user->last_login = time();
-    $user->save();
-
-    user::set_active($user);
-    module::event("user_login", $user);
-  }
-
-  /**
-   * Log out the active user and destroy the session.
-   * @param object $user the user object.
-   */
-  static function logout() {
-    $user = user::active();
-    if (!$user->guest) {
-      try {
-        Session::instance()->destroy();
-      } catch (Exception $e) {
-        Kohana::log("error", $e);
-      }
-      module::event("user_logout", $user);
-    }
+    return Identity::instance()->hash_password($password);
   }
 
   /**
@@ -304,11 +282,7 @@ class user_Core {
    * @return User_Model  the user object, or null if the id was invalid.
    */
   static function lookup($id) {
-    $user = model_cache::get("user", $id);
-    if ($user->loaded) {
-      return $user;
-    }
-    return null;
+    return Identity::instance()->lookup_user($id);
   }
 
   /**
@@ -317,44 +291,24 @@ class user_Core {
    * @return User_Model  the user object, or null if the name was invalid.
    */
   static function lookup_by_name($name) {
-    $user = model_cache::get("user", $name, "name");
-    if ($user->loaded) {
-      return $user;
-    }
-    return null;
+    return Identity::instance()->lookup_user_by_field("name", $name);
   }
 
   /**
-   * Create a hashed password using md5 plus salt.
-   * @param string $password plaintext password
-   * @param string $salt (optional) salt or hash containing salt (randomly generated if omitted)
-   * @return string hashed password
+   * Look up a user by hash.
+   * @param string       $name the user name
+   * @return User_Model  the user object, or null if the name was invalid.
    */
-  private static function _md5Salt($password, $salt="") {
-    if (empty($salt)) {
-      for ($i = 0; $i < 4; $i++) {
-        $char = mt_rand(48, 109);
-        $char += ($char > 90) ? 13 : ($char > 57) ? 7 : 0;
-        $salt .= chr($char);
-      }
-    } else {
-      $salt = substr($salt, 0, 4);
-    }
-    return $salt . md5($salt . $password);
+  static function lookup_by_hash($hash) {
+    return Identity::instance()->lookup_user_by_field("hash", $hash);
   }
 
-  static function cookie_locale() {
-    $cookie_data = Input::instance()->cookie("g_locale");
-    $locale = null;
-    if ($cookie_data) {
-      if (preg_match("/^([a-z]{2,3}(?:_[A-Z]{2})?)$/", trim($cookie_data), $matches)) {
-        $requested_locale = $matches[1];
-        $installed_locales = locales::installed();
-        if (isset($installed_locales[$requested_locale])) {
-          $locale = $requested_locale;
-        }
-      }
-    }
-    return $locale;
+  /**
+   * List the users
+   * @param mixed      options to apply to the selection of the user(optional)
+   * @return array     the group list.
+   */
+  static function users($filter=array()) {
+    return Identity::instance()->list_users($filter);
   }
 }
\ No newline at end of file
diff --git a/modules/gallery/libraries/Identity.php b/modules/gallery/libraries/Identity.php
new file mode 100644
index 00000000..41c25b39
--- /dev/null
+++ b/modules/gallery/libraries/Identity.php
@@ -0,0 +1,220 @@
+<?php defined("SYSPATH") or die("No direct script access.");
+/**
+ * Gallery - a web based photo album viewer and editor
+ * Copyright (C) 2000-2009 Bharat Mediratta
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or (at
+ * your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+
+/**
+ * Provides a driver-based interface for managing users and groups.
+ */
+class Identity_Core {
+  protected static $instances = array();
+
+  // Configuration
+  protected $config;
+
+  // Driver object
+  protected $driver;
+
+  /**
+   * Returns a singleton instance of Identity.
+   *
+   * @param   string  configuration
+   * @return  Identity_Core
+   */
+  static function & instance($config="default") {
+   if (!isset(Identity::$instances[$config])) {
+      // Create a new instance
+      Identity::$instances[$config] = new Identity($config);
+    }
+
+    return Identity::$instances[$config];
+  }
+
+  /**
+   * Loads the configured driver and validates it.
+   *
+   * @param   array|string  custom configuration or config group name
+   * @return  void
+   */
+  public function __construct($config="default") {
+    if (is_string($config)) {
+      $name = $config;
+
+      // Test the config group name
+      if (($config = Kohana::config('identity.'.$config)) === NULL) {
+        throw new Exception("@todo NO USER LIBRARY CONFIGURATION FOR: $name");
+      }
+
+      if (is_array($config)) {
+        // Append the default configuration options
+        $config += Kohana::config('identity.default');
+      } else {
+        // Load the default group
+        $config = Kohana::config('identity.default');
+      }
+
+      // Cache the config in the object
+      $this->config = $config;
+
+      // Set driver name
+      $driver = 'Identity_'.ucfirst($this->config['driver']).'_Driver';
+
+      // Load the driver
+      if ( ! Kohana::auto_load($driver)) {
+        throw new Kohana_Exception('core.driver_not_found', $this->config['driver'],
+                                   get_class($this));
+      }
+
+      // Initialize the driver
+      $this->driver = new $driver($this->config['params']);
+
+      // Validate the driver
+      if ( !($this->driver instanceof Identity_Driver))
+        throw new Kohana_Exception('core.driver_implements', $this->config['driver'],
+                                   get_class($this), 'Identity_Driver');
+
+      Kohana::log('debug', 'Identity Library initialized');
+    }
+  }
+
+  /**
+   * Return the guest user.
+   *
+   * @todo consider caching
+   *
+   * @return Identity_Model
+   */
+  public function guest() {
+    return $this->driver->guest();
+  }
+
+  /**
+   * Create a new user.
+   *
+   * @param string  $name
+   * @param string  $full_name
+   * @param string  $password
+   * @return Identity_Model
+   */
+  public function create_user($name, $full_name, $password) {
+    return $this->driver->create_user($name, $full_name, $password);
+  }
+
+  /**
+   * Is the password provided correct?
+   *
+   * @param user Identity Model
+   * @param string $password a plaintext password
+   * @return boolean true if the password is correct
+   */
+  public function is_correct_password($user, $password) {
+    return $this->driver->is_correct_password($user, $password);
+  }
+
+  /**
+   * Create the hashed passwords.
+   * @param string $password a plaintext password
+   * @return string hashed password
+   */
+  public function hash_password($password) {
+    return $this->driver->hash_password($password);
+  }
+
+  /**
+   * Look up a user by id.
+   * @param integer      $id the user id
+   * @return Identity_Model  the user object, or null if the id was invalid.
+   */
+  public function lookup_user($id) {
+    return $this->driver->lookup_user($id);
+  }
+
+  /**
+   * Look up a user by field value.
+   * @param string      search field
+   * @param string      search value
+   * @return Identity_Model  the user object, or null if the name was invalid.
+   */
+  public function lookup_user_by_field($field_name, $value) {
+    return $this->driver->lookup_user_by_field($field_name, $value);
+  }
+
+  /**
+   * Create a new group.
+   *
+   * @param string  $name
+   * @return Group_Model
+   */
+  public function create_group($name) {
+    return $this->driver->create_group($name);
+  }
+
+  /**
+   * The group of all possible visitors.  This includes the guest user.
+   *
+   * @return Group_Model
+   */
+  public function everybody() {
+    return $this->driver->everybody();
+  }
+
+  /**
+   * The group of all logged-in visitors.  This does not include guest users.
+   *
+   * @return Group_Model
+   */
+  public function registered_users() {
+    return $this->driver->everybody();
+  }
+
+  /**
+   * Look up a group by id.
+   * @param integer      $id the user id
+   * @return Group_Model  the group object, or null if the id was invalid.
+   */
+  public function lookup_group($id) {
+    return $this->driver->lookup_group($id);
+  }
+
+  /**
+   * Look up a group by name.
+   * @param integer      $id the group name
+   * @return Group_Model  the group object, or null if the name was invalid.
+   */
+  public function lookup_group_by_name($name) {
+    return $this->driver->lookup_group_by_name($name);
+  }
+
+  /**
+   * List the users
+   * @param mixed      options to apply to the selection of the user
+   * @return array     the group list.
+   */
+  public function list_users($filter=array()) {
+    return $this->driver->list_users($filter);
+  }
+
+  /**
+   * List the groups
+   * @param mixed      options to apply to the selection of the user
+   * @return array     the group list.
+   */
+  public function list_groups($filter=array()) {
+    return $this->driver->list_groups($filter);
+  }
+} // End Identity
diff --git a/modules/gallery/libraries/drivers/Identity.php b/modules/gallery/libraries/drivers/Identity.php
new file mode 100644
index 00000000..13af4583
--- /dev/null
+++ b/modules/gallery/libraries/drivers/Identity.php
@@ -0,0 +1,119 @@
+<?php defined("SYSPATH") or die("No direct script access.");
+/**
+ * Gallery - a web based photo album viewer and editor
+ * Copyright (C) 2000-2009 Bharat Mediratta
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or (at
+ * your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+interface Identity_Driver {
+  /**
+   * Return the guest user.
+   *
+   * @todo consider caching
+   *
+   * @return User_Model
+   */
+  public function guest();
+
+  /**
+   * Create a new user.
+   *
+   * @param string  $name
+   * @param string  $full_name
+   * @param string  $password
+   * @return User_Core
+   */
+  public function create_user($name, $full_name, $password);
+
+  /**
+   * Is the password provided correct?
+   *
+   * @param user User Model
+   * @param string $password a plaintext password
+   * @return boolean true if the password is correct
+   */
+  public function is_correct_password($user, $password);
+
+  /**
+   * Create the hashed passwords.
+   * @param string $password a plaintext password
+   * @return string hashed password
+   */
+  public function hash_password($password);
+  /**
+   * Look up a user by id.
+   * @param integer      $id the user id
+   * @return User_Core  the user object, or null if the id was invalid.
+   */
+  public function lookup_user($id);
+
+  /**
+   * Look up a user by name.
+   * @param string      search field
+   * @param string      search value
+   * @return User_Core  the user object, or null if the name was invalid.
+   */
+  public function lookup_user_by_field($field, $value);
+
+  /**
+   * Create a new group.
+   *
+   * @param string  $name
+   * @return Group_Model
+   */
+  public function create_group($name);
+
+  /**
+   * The group of all possible visitors.  This includes the guest user.
+   *
+   * @return Group_Model
+   */
+  public function everybody();
+
+  /**
+   * The group of all logged-in visitors.  This does not include guest users.
+   *
+   * @return Group_Model
+   */
+  public function registered_users();
+
+  /**
+   * Look up a group by id.
+   * @param integer      $id the user id
+   * @return Group_Model  the group object, or null if the id was invalid.
+   */
+  public function lookup_group($id);
+
+  /**
+   * Look up a group by name.
+   * @param integer      $id the group name
+   * @return Group_Model  the group object, or null if the name was invalid.
+   */
+  public function lookup_group_by_name($name);
+
+  /**
+   * List the users
+   * @param mixed      options to apply to the selection of the user
+   * @return array     the group list.
+   */
+  public function list_users($filter=array());
+
+  /**
+   * List the groups
+   * @param mixed      options to apply to the selection of the user
+   * @return array     the group list.
+   */
+  public function list_groups($filter=array());
+} // End User Driver
\ No newline at end of file
diff --git a/modules/user/libraries/drivers/Identity/Gallery.php b/modules/user/libraries/drivers/Identity/Gallery.php
new file mode 100644
index 00000000..83f553c1
--- /dev/null
+++ b/modules/user/libraries/drivers/Identity/Gallery.php
@@ -0,0 +1,226 @@
+<?php defined("SYSPATH") or die("No direct script access.");
+/**
+ * Gallery - a web based photo album viewer and editor
+ * Copyright (C) 2000-2009 Bharat Mediratta
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or (at
+ * your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+/*
+ * Based on the Cache_Sqlite_Driver developed by the Kohana Team
+ */
+class Identity_Gallery_Driver implements Identity_Driver {
+  /**
+   * Return the guest user.
+   *
+   * @todo consider caching
+   *
+   * @return User_Model
+   */
+  public function guest() {
+    return model_cache::get("user", 1);
+  }
+
+  /**
+   * Create a new user.
+   *
+   * @param string  $name
+   * @param string  $full_name
+   * @param string  $password
+   * @return User_Model
+   */
+  public function create_user($name, $full_name, $password) {
+    $user = ORM::factory("user")->where("name", $name)->find();
+    if ($user->loaded) {
+      throw new Exception("@todo USER_ALREADY_EXISTS $name");
+    }
+
+    $user->name = $name;
+    $user->full_name = $full_name;
+    $user->password = $password;
+
+    // Required groups
+    $user->add(group::everybody());
+    $user->add(group::registered_users());
+
+    $user->save();
+    return $user;
+  }
+
+  /**
+   * Is the password provided correct?
+   *
+   * @param user User Model
+   * @param string $password a plaintext password
+   * @return boolean true if the password is correct
+   */
+  public function is_correct_password($user, $password) {
+    $valid = $user->password;
+
+    // Try phpass first, since that's what we generate.
+    if (strlen($valid) == 34) {
+      require_once(MODPATH . "user/lib/PasswordHash.php");
+      $hashGenerator = new PasswordHash(10, true);
+      return $hashGenerator->CheckPassword($password, $valid);
+    }
+
+    $salt = substr($valid, 0, 4);
+    // Support both old (G1 thru 1.4.0; G2 thru alpha-4) and new password schemes:
+    $guess = (strlen($valid) == 32) ? md5($password) : ($salt . md5($salt . $password));
+    if (!strcmp($guess, $valid)) {
+      return true;
+    }
+
+    // Passwords with <&"> created by G2 prior to 2.1 were hashed with entities
+    $sanitizedPassword = html::specialchars($password, false);
+    $guess = (strlen($valid) == 32) ? md5($sanitizedPassword)
+          : ($salt . md5($salt . $sanitizedPassword));
+    if (!strcmp($guess, $valid)) {
+      return true;
+    }
+
+    return false;
+  }
+
+  /**
+   * Create the hashed passwords.
+   * @param string $password a plaintext password
+   * @return string hashed password
+   */
+  public function hash_password($password) {
+    require_once(MODPATH . "user/lib/PasswordHash.php");
+    $hashGenerator = new PasswordHash(10, true);
+    return $hashGenerator->HashPassword($password);
+  }
+
+  /**
+   * Look up a user by id.
+   * @param integer      $id the user id
+   * @return User_Model  the user object, or null if the id was invalid.
+   */
+  public function lookup_user($id) {
+    $user = model_cache::get("user", $id);
+    if ($user->loaded) {
+      return $user;
+    }
+    return null;
+  }
+
+  /**
+   * Look up a user by field value.
+   * @param string      search field
+   * @param string      search value
+   * @return User_Core  the user object, or null if the name was invalid.
+   */
+  public function lookup_user_by_field($field_name, $value) {
+    try {
+      $user = model_cache::get("user", $value, $field_name);
+      if ($user->loaded) {
+        return $user;
+      }
+    } catch (Exception $e) {
+      if (strpos($e->getMessage(), "MISSING_MODEL") === false) {
+       throw $e;
+      }
+    }
+    return null;
+  }
+
+  /**
+   * Create a new group.
+   *
+   * @param string  $name
+   * @return Group_Model
+   */
+  public function create_group($name) {
+    $group = ORM::factory("group")->where("name", $name)->find();
+    if ($group->loaded) {
+      throw new Exception("@todo GROUP_ALREADY_EXISTS $name");
+    }
+
+    $group->name = $name;
+    $group->save();
+
+    return $group;
+  }
+
+  /**
+   * The group of all possible visitors.  This includes the guest user.
+   *
+   * @return Group_Model
+   */
+  public function everybody() {
+    return model_cache::get("group", 1);
+  }
+
+  /**
+   * The group of all logged-in visitors.  This does not include guest users.
+   *
+   * @return Group_Model
+   */
+  public function registered_users() {
+    return model_cache::get("group", 2);
+  }
+
+  /**
+   * Look up a user by id.
+   * @param integer      $id the user id
+   * @return User_Model  the user object, or null if the id was invalid.
+   */
+  public function lookup_group($id) {
+    $group = model_cache::get("group", $id);
+    if ($group->loaded) {
+      return $group;
+    }
+    return null;
+  }
+
+  /**
+   * Look up a group by name.
+   * @param integer      $id the group name
+   * @return Group_Model  the group object, or null if the name was invalid.
+   */
+  public function lookup_group_by_name($name) {
+    try {
+      $group = model_cache::get("group", $name, "name");
+      if ($group->loaded) {
+        return $group;
+      }
+    } catch (Exception $e) {
+      if (strpos($e->getMessage(), "MISSING_MODEL") === false) {
+       throw $e;
+      }
+    }
+    return null;
+  }
+
+  /**
+   * List the users
+   * @param mixed      options to apply to the selection of the user
+   * @return array     the group list.
+   */
+  public function list_users($filter=array()) {
+    return ORM::factory("user")->orderby("name")->find_all();
+  }
+
+
+  /**
+   * List the groups
+   * @param mixed      options to apply to the selection of the user
+   * @return array     the group list.
+   */
+  public function list_groups($filter=array()) {
+    return ORM::factory("group")->orderby("name")->find_all();
+  }
+} // End Identity Gallery Driver
\ No newline at end of file