summaryrefslogtreecommitdiff
path: root/modules/gallery/libraries/Identity.php
blob: 488cc5350172509f9c2775cedf21dc496868cad4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
<?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");
    }
  }

  /**
   * Determine if a feature is supported by the driver.
   *
   * @param  string  $feature the name of the feature to check
   * @return boolean true if supported
   */
  public function is_writable() {
    return !empty($this->config["allow_updates"]);
  }


  /**
   * 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 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 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_field($field_name, $value) {
    return $this->driver->lookup_group_by_field($field_name, $value);
  }

  /**
   * List the users
   * @param mixed      options to apply to the selection of the user
   * @return array     the group list.
   */
  public function get_user_list($filter=array()) {
    return $this->driver->get_user_list($filter);
  }

  /**
   * List the groups
   * @param mixed      options to apply to the selection of the user
   * @return array     the group list.
   */
  public function get_group_list($filter=array()) {
    return $this->driver->get_group_list($filter);
  }

  /**
   * Return the edit rules associated with an group.
   *
   * @param  string   $object_type to return rules for ("user"|"group")
   * @return stdClass containing the rules
   */
  public function get_edit_rules($object_type) {
    return $this->driver->get_edit_rules($object_type);
  }
} // End Identity