summaryrefslogtreecommitdiff
path: root/modules/gallery/libraries
diff options
context:
space:
mode:
Diffstat (limited to 'modules/gallery/libraries')
-rw-r--r--modules/gallery/libraries/Admin_View.php4
-rw-r--r--modules/gallery/libraries/Identity.php205
-rw-r--r--modules/gallery/libraries/MY_Session.php84
-rw-r--r--modules/gallery/libraries/Theme_View.php6
-rw-r--r--modules/gallery/libraries/drivers/Identity.php270
5 files changed, 564 insertions, 5 deletions
diff --git a/modules/gallery/libraries/Admin_View.php b/modules/gallery/libraries/Admin_View.php
index fa6d1dd3..74a08c77 100644
--- a/modules/gallery/libraries/Admin_View.php
+++ b/modules/gallery/libraries/Admin_View.php
@@ -36,12 +36,12 @@ class Admin_View_Core extends Gallery_View {
parent::__construct($name);
$this->theme_name = module::get_var("gallery", "active_admin_theme");
- if (user::active()->admin) {
+ if (Session::active_user()->admin) {
$this->theme_name = Input::instance()->get("theme", $this->theme_name);
}
$this->sidebar = "";
$this->set_global("theme", $this);
- $this->set_global("user", user::active());
+ $this->set_global("user", Session::active_user());
}
public function admin_menu() {
diff --git a/modules/gallery/libraries/Identity.php b/modules/gallery/libraries/Identity.php
new file mode 100644
index 00000000..9e5f0bb5
--- /dev/null
+++ b/modules/gallery/libraries/Identity.php
@@ -0,0 +1,205 @@
+<?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 $instance;
+
+ protected static $active;
+
+ // Configuration
+ protected $config;
+
+ // Driver object
+ protected $driver;
+
+ /**
+ * Returns a singleton instance of Identity.
+ * There can only be one Identity driver configured at a given point
+ *
+ * @param string configuration
+ * @return Identity_Core
+ */
+ static function & instance($config="default") {
+ if (!isset(Identity::$instance)) {
+ // Create a new instance
+ Identity::$instance = new Identity($config);
+ }
+
+ return Identity::$instance;
+ }
+
+ /**
+ * Loads the configured driver and validates it.
+ *
+ * @return void
+ */
+ public function __construct() {
+ $name = $config = module::get_var("gallery", "identity_provider", "user");
+
+ // Test the config group name
+ if (($this->config = Kohana::config("identity.".$config)) === NULL) {
+ throw new Exception("@todo NO USER LIBRARY CONFIGURATION FOR: $name");
+ }
+
+ // 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 a list of installed and activated Identity Drivers.
+ *
+ * @return boolean true if the driver supports updates; false if read only
+ */
+ static function active() {
+ if (empty(self::$active)) {
+ $drivers = new ArrayObject(array(), ArrayObject::ARRAY_AS_PROPS);
+ foreach (module::active() as $module) {
+ $module_name = $module->name;
+ if (file_exists(MODPATH . "{$module->name}/config/identity.php") &&
+ ($info = module::info($module_name))) {
+ $drivers->$module_name = $info->description;
+ }
+ }
+ self::$active = $drivers;
+ }
+ return self::$active;
+ }
+
+ /**
+ * Determine if if the current driver supports updates.
+ *
+ * @return boolean true if the driver supports updates; false if read only
+ */
+ static function is_writable() {
+ return !empty(self::instance()->config["allow_updates"]);
+ }
+
+ /**
+ * @see Identity_Driver::guest.
+ */
+ static function guest() {
+ return self::instance()->driver->guest();
+ }
+
+ /**
+ * @see Identity_Driver::create_user.
+ */
+ static function create_user($name, $full_name, $password) {
+ return self::instance()->driver->create_user($name, $full_name, $password);
+ }
+
+ /**
+ * @see Identity_Driver::is_correct_password.
+ */
+ static function is_correct_password($user, $password) {
+ return self::instance()->driver->is_correct_password($user, $password);
+ }
+
+ /**
+ * @see Identity_Driver::hash_password.
+ */
+ static function hash_password($password) {
+ return self::instance()->driver->hash_password($password);
+ }
+
+ /**
+ * Look up a user by id.
+ * @param integer $id the user id
+ * @return User_Definition the user object, or null if the id was invalid.
+ */
+ static function lookup_user($id) {
+ return self::instance()->driver->lookup_user_by_field("id", $id);
+ }
+
+ /**
+ * Look up a user by name.
+ * @param integer $name the user name
+ * @return User_Definition the user object, or null if the name was invalid.
+ */
+ static function lookup_user_by_name($name) {
+ return self::instance()->driver->lookup_user_by_field("name", $name);
+ }
+
+ /**
+ * Look up a user by hash.
+ * @param string $name the user name
+ * @return User_Definition the user object, or null if the name was invalid.
+ */
+ static function lookup_user_by_hash($hash) {
+ return self::instance()->driver->lookup_user_by_field("hash", $hash);
+ }
+
+ /**
+ * @see Identity_Driver::create_group.
+ */
+ static function create_group($name) {
+ return self::instance()->driver->create_group($name);
+ }
+
+ /**
+ * @see Identity_Driver::everybody.
+ */
+ static function everybody() {
+ return self::instance()->driver->everybody();
+ }
+
+ /**
+ * @see Identity_Driver::registered_users.
+ */
+ static function registered_users() {
+ return self::instance()->driver->everybody();
+ }
+
+ /**
+ * Look up a group by name.
+ * @param integer $id the group name
+ * @return Group_Definition the group object, or null if the name was invalid.
+ */
+ static function lookup_group_by_name($name) {
+ return self::instance()->driver->lookup_group_by_field("name", $name);
+ }
+
+ /**
+ * @see Identity_Driver::get_user_list.
+ */
+ static function get_user_list($ids) {
+ return self::instance()->driver->get_user_list($ids);
+ }
+} // End Identity
diff --git a/modules/gallery/libraries/MY_Session.php b/modules/gallery/libraries/MY_Session.php
new file mode 100644
index 00000000..6394c0fb
--- /dev/null
+++ b/modules/gallery/libraries/MY_Session.php
@@ -0,0 +1,84 @@
+<?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.
+ */
+
+class Session extends Session_Core {
+ /**
+ * 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 = Identity::guest());
+ }
+
+ // The installer cannot set a user into the session, so it just sets an id which we should
+ // upconvert into a user.
+ // @todo set the user name into the session instead of 2 and then use it to get the user object
+ if ($user === 2) {
+ $user = Instance::lookup_user_by_name("admin");
+ self::set_active_user($user);
+ $session->set("user", $user);
+ }
+
+ if (!$session->get("group_ids")) {
+ $ids = array();
+ foreach ($user->groups as $group) {
+ $ids[] = $group->id;
+ }
+ $session->set("group_ids", $ids);
+ }
+ }
+
+ /**
+ * Return the array of group ids this user belongs to
+ *
+ * @return array
+ */
+ static function group_ids_for_active_user() {
+ return self::instance()->get("group_ids", array(1));
+ }
+
+ /**
+ * Return the active user. If there's no active user, return the guest user.
+ *
+ * @return User_Definition
+ */
+ static function active_user() {
+ // @todo (maybe) cache this object so we're not always doing session lookups.
+ $user = self::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 = Identity::guest();
+ }
+ return $user;
+ }
+
+ /**
+ * Change the active user.
+ * @param User_Definition $user
+ */
+ static function set_active_user($user) {
+ $session = Session::instance();
+ $session->set("user", $user);
+ $session->delete("group_ids");
+ self::load_user();
+ }
+} \ No newline at end of file
diff --git a/modules/gallery/libraries/Theme_View.php b/modules/gallery/libraries/Theme_View.php
index cba436e8..2fdc7531 100644
--- a/modules/gallery/libraries/Theme_View.php
+++ b/modules/gallery/libraries/Theme_View.php
@@ -37,13 +37,13 @@ class Theme_View_Core extends Gallery_View {
parent::__construct($name);
$this->theme_name = module::get_var("gallery", "active_site_theme");
- if (user::active()->admin) {
+ if (Session::active_user()->admin) {
$this->theme_name = Input::instance()->get("theme", $this->theme_name);
}
$this->item = null;
$this->tag = null;
$this->set_global("theme", $this);
- $this->set_global("user", user::active());
+ $this->set_global("user", Session::active_user());
$this->set_global("page_type", $page_type);
$this->set_global("page_title", null);
if ($page_type == "album") {
@@ -158,7 +158,7 @@ class Theme_View_Core extends Gallery_View {
*/
public function sidebar_blocks() {
$sidebar = block_manager::get_html("site.sidebar", $this);
- if (empty($sidebar) && user::active()->admin) {
+ if (empty($sidebar) && Session::active_user()->admin) {
$sidebar = new View("no_sidebar.html");
}
return $sidebar;
diff --git a/modules/gallery/libraries/drivers/Identity.php b/modules/gallery/libraries/drivers/Identity.php
new file mode 100644
index 00000000..a9e1a75b
--- /dev/null
+++ b/modules/gallery/libraries/drivers/Identity.php
@@ -0,0 +1,270 @@
+<?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.
+ *
+ * @return User_Definition the user object
+ */
+ public function guest();
+
+ /**
+ * Create a new user.
+ *
+ * @param string $name
+ * @param string $full_name
+ * @param string $password
+ * @return User_Definition the user object
+ */
+ public function create_user($name, $full_name, $password);
+
+ /**
+ * Is the password provided correct?
+ *
+ * @param user User_Definition the user object
+ * @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 by search the specified field.
+ * @param string search field
+ * @param string search value
+ * @return User_Definition 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_Definition the group object
+ */
+ public function create_group($name);
+
+ /**
+ * The group of all possible visitors. This includes the guest user.
+ *
+ * @return Group_Definition the group object
+ */
+ public function everybody();
+
+ /**
+ * The group of all logged-in visitors. This does not include guest users.
+ *
+ * @return Group_Definition the group object
+ */
+ public function registered_users();
+
+ /**
+ * List the users
+ * @param array array of ids to return the user objects for
+ * @return array the user list.
+ */
+ public function get_user_list($ids);
+
+} // End Identity Driver Definition
+
+/**
+ * User Data wrapper
+ */
+abstract class User_Definition {
+ protected $user;
+ public function __get($column) {
+ switch ($column) {
+ case "id":
+ case "name":
+ case "full_name":
+ case "password":
+ case "login_count":
+ case "last_login":
+ case "email":
+ case "admin":
+ case "guest":
+ case "hash":
+ case "url":
+ case "locale":
+ case "groups":
+ case "hashed_password":
+ return $this->user->$column;
+ default:
+ throw new Exception("@todo UNSUPPORTED FIELD: $column");
+ break;
+ }
+ }
+
+ public function __set($column, $value) {
+ switch ($column) {
+ case "id":
+ case "groups":
+ throw new Exception("@todo READ ONLY FIELD: $column");
+ break;
+ case "name":
+ case "full_name":
+ case "hashed_password":
+ case "password":
+ case "login_count":
+ case "last_login":
+ case "email":
+ case "admin":
+ case "guest":
+ case "hash":
+ case "url":
+ case "locale":
+ $this->user->$column = $value;
+ break;
+ default:
+ throw new Exception("@todo UNSUPPORTED FIELD: $column");
+ break;
+ }
+ }
+
+ public function __isset($column) {
+ return isset($this->user->$column);
+ }
+
+ public function __unset($column) {
+ switch ($column) {
+ case "id":
+ case "groups":
+ throw new Exception("@todo READ ONLY FIELD: $column");
+ break;
+ case "name":
+ case "full_name":
+ case "password":
+ case "login_count":
+ case "last_login":
+ case "email":
+ case "admin":
+ case "guest":
+ case "hash":
+ case "url":
+ case "locale":
+ case "hashed_password":
+ unset($this->user->$column);
+ break;
+ default:
+ throw new Exception("@todo UNSUPPORTED FIELD: $column");
+ break;
+ }
+ }
+
+ /**
+ * Return a url to the user's avatar image.
+ * @param integer $size the target size of the image (default 80px)
+ * @return string a url
+ */
+ abstract public function avatar_url($size=80, $default=null);
+
+ /**
+ * Return the best version of the user's name. Either their specified full name, or fall back
+ * to the user name.
+ * @return string
+ */
+ abstract public function display_name();
+
+ /**
+ * Return the internal user object without the wrapper.
+ * This method is used by implementing classes to access the internal user object.
+ * Consider it pseudo private and only declared public as PHP as not internal or friend modifier
+ */
+ public function _uncloaked() {
+ return $this->user;
+ }
+
+ abstract public function save();
+ abstract public function delete();
+}
+
+/**
+ * Group Data wrapper
+ */
+abstract class Group_Definition {
+ protected $group;
+
+ public function __get($column) {
+ switch ($column) {
+ case "id":
+ case "name":
+ case "special":
+ case "users":
+ return $this->group->$column;
+ default:
+ throw new Exception("@todo UNSUPPORTED FIELD: $column");
+ break;
+ }
+ }
+
+ public function __set($column, $value) {
+ switch ($column) {
+ case "id":
+ case "users":
+ throw new Exception("@todo READ ONLY FIELD: $column");
+ break;
+ case "name":
+ case "special":
+ $this->group->$column = $value;
+ default:
+ throw new Exception("@todo UNSUPPORTED FIELD: $column");
+ break;
+ }
+ }
+
+ public function __isset($column) {
+ return isset($this->group->$column);
+ }
+
+ public function __unset($column) {
+ switch ($column) {
+ case "id":
+ case "users":
+ throw new Exception("@todo READ ONLY FIELD: $column");
+ break;
+ case "name":
+ case "special":
+ unset($this->group->$column);
+ default:
+ throw new Exception("@todo UNSUPPORTED FIELD: $column");
+ break;
+ }
+ }
+
+ /**
+ * Return the internal group object without the wrapper.
+ * This method is used by implementing classes to access the internal group object.
+ * Consider it pseudo private and only declared public as PHP as not internal or friend modifier
+ */
+ public function _uncloaked() {
+ return $this->group;
+ }
+
+ abstract public function save();
+ abstract public function delete();
+ abstract public function add($user);
+ abstract public function remove($user);
+}
generated by cgit v1.2.3 (git 2.46.0) at 2025-10-15 19:00:28 +0000