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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
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);
}
|
