]> src.bluestatic.org Git - bugdar.git/blob - includes/auth/auth.php
init.php is now largely upgraded
[bugdar.git] / includes / auth / auth.php
1 <?php
2 /*=====================================================================*\
3 || ###################################################################
4 || # Bugdar
5 || # Copyright ©2002-2007 Blue Static
6 || #
7 || # This program is free software; you can redistribute it and/or modify
8 || # it under the terms of the GNU General Public License as published by
9 || # the Free Software Foundation; version 2 of the License.
10 || #
11 || # This program is distributed in the hope that it will be useful, but
12 || # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 || # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 || # more details.
15 || #
16 || # You should have received a copy of the GNU General Public License along
17 || # with this program; if not, write to the Free Software Foundation, Inc.,
18 || # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
19 || ###################################################################
20 \*=====================================================================*/
21
22 require_once('./includes/api_user.php');
23
24 /**
25 * Abstract Authentication
26 *
27 * This is an abstract class that is used to provide authentication for
28 * Bugdar.
29 *
30 * @author Blue Static
31 * @copyright Copyright (c)2002 - 2007, Blue Static
32 * @version $Revision$
33 * @package Bugdar
34 *
35 */
36 class Authentication
37 {
38 /**
39 * The database connection to AUTHENTICATE against; can be to a separate database
40 * @var object
41 */
42 var $authDb;
43
44 /**
45 * The database connection to the BUGDAR database
46 * @var object
47 */
48 var $db;
49
50 /**
51 * The Bugdar registry
52 * @var object
53 */
54 var $registry;
55
56 /**
57 * Array of user data from the AUTHENTICATION database
58 * @var array
59 */
60 var $authUser;
61
62 /**
63 * Array of user data from the BUGDAR database
64 * @var array
65 */
66 var $bugdarUser;
67
68 /**
69 * Mapping of Bugdar fields to authentication database fields; these will be synced between databases upon login.
70 * AT THE VERY MINIMUM, YOU MUST MAP THESE FIELDS:
71 * @var array
72 */
73 var $fieldMap = array(
74 'authid' => null,
75 'displayname' => null,
76 'email' => null,
77 );
78
79 // ###################################################################
80 /**
81 * Constructor
82 */
83 function __construct()
84 {
85 global $bugsys;
86
87 $this->registry =& $bugsys;
88 $this->db =& $bugsys->db;
89
90 $this->registry->debug('authentication system: ' . get_class($this));
91
92 $this->_setupDatabase();
93 }
94
95 // ###################################################################
96 /**
97 * (PHP 4) Constructor
98 */
99 function Authentication()
100 {
101 $this->__construct();
102 }
103
104 // ###################################################################
105 /**
106 * Returns the information array for the Bugdar user. This must be
107 * called after an authentication method.
108 */
109 function fetchBugdarUser()
110 {
111 return $this->bugdarUser;
112 }
113
114 // ###################################################################
115 /**
116 * Sets up the database to authenticate against. You can create a new
117 * database object here. Whatever you choose, you need to reference
118 * Authentication->authDb to the object
119 */
120 function _setupDatabase() {}
121
122 // ###################################################################
123 /**
124 * Returns the sanitized value of the user ID or unique identifier
125 * found in the cookie of an already-authenticated user.
126 */
127 function _fetchCookieUniqueId() {}
128
129 // ###################################################################
130 /**
131 * Returns the sanitized value of the authentication key or cookie-safe
132 * password found in the cookies of an already-authenticated user.
133 */
134 function _fetchCookiePassword() {}
135
136 // ###################################################################
137 /**
138 * Returns an array of user data fetched using the user information
139 * values found in cookies. It should NOT be responsible for verifying
140 * the authentication information, but only fetching it.
141 */
142 function _fetchUserUsingCookies() {}
143
144 // ###################################################################
145 /**
146 * Returns TRUE if the cookie data values are valid in the data array
147 * returned from _fetchUserUsingCookies(), and FALSE if they are not.
148 */
149 function _verifyCookieData() {}
150
151 // ###################################################################
152 /**
153 * Authenticates the user using cookie data. You shouldn't need to
154 * customize this method if you implement all the helpers correctly.
155 * Returns TRUE if the cookies are valid and the user is logged in.
156 */
157 function authenticateCookies()
158 {
159 if (!$this->_fetchCookieUniqueId() OR !$this->_fetchCookiePassword())
160 {
161 return false;
162 }
163
164 $this->authUser = $this->_fetchUserUsingCookies();
165 if (!$this->authUser)
166 {
167 $this->authUser = null;
168 return false;
169 }
170
171 if ($this->_verifyCookieData())
172 {
173 $this->_setCookies(true);
174 $this->bugdarUser = $this->_fetchBugdarUserFromAuthUser();
175 if ($this->_syncBugdarUser())
176 {
177 $this->bugdarUser = $this->_fetchBugdarUserFromAuthUser();
178 }
179 return true;
180 }
181 else
182 {
183 $this->authUser = null;
184 $this->clearCookies();
185 return false;
186 }
187 }
188
189 // ###################################################################
190 /**
191 * Returns an array with the authentication user information, found
192 * by the unique login identifier passed to the function.
193 */
194 function _fetchUserWithIdentifier($string) {}
195
196 // ###################################################################
197 /**
198 * Verifies that the authUser's password matches the plain-text password
199 * passed to this function. This is basically the transformation of
200 * the plaintext to the hashed password and the result of the comparison.
201 */
202 function _verifyLoginUser($password) {}
203
204 // ###################################################################
205 /**
206 * Authenticates a user at login from two keys: an identifier and
207 * a password. In Bugdar, the identifier is an email, but it can be
208 * any unique string found in the authentication database. Returns
209 * TRUE if the authentication is successful, and FALSE if not. Also
210 * determines if the cookies are sticky ("rememember me" login)
211 */
212 function authenticateLogin($string, $password, $sticky = false)
213 {
214 $this->authUser = $this->_fetchUserWithIdentifier($string);
215
216 if (!$this->authUser)
217 {
218 $this->authUser = null;
219 return false;
220 }
221
222 if ($this->_verifyLoginUser($password))
223 {
224 $this->_setCookies($sticky);
225 $this->bugdarUser = $this->_fetchBugdarUserFromAuthUser();
226 $this->_syncBugdarUser();
227 return true;
228 }
229 else
230 {
231 $this->authUser = null;
232 return false;
233 }
234 }
235
236 // ###################################################################
237 /**
238 * Returns the BUGDAR user array from the data in the AUTHENTICATION user
239 * array. If the Bugdar user does not exist, call _createBugdarUser()
240 * to add the user into the Bugdar database. This is necessary so Bugdar options
241 * can be saved in the Bugdar database (and not in the auth one), however
242 * authentication details will NOT be stored in the Bugdar database.
243 */
244 function _fetchBugdarUserFromAuthUser()
245 {
246 $user = $this->db->query_first("SELECT * FROM " . TABLE_PREFIX . "user WHERE authid = '" . $this->authUser[ $this->fieldMap['authid'] ] . "'");
247 if (!$user)
248 {
249 return $this->_createBugdarUser();
250 }
251 return $user;
252 }
253
254 // ###################################################################
255 /**
256 * Creates a Bugdar user with the authentication details specified in
257 * the auth array and returns it. You need to call this in
258 * _fetchBugdarUserFromAuthUser() and use the UserAPI to create the user.
259 * This will create a new user in Bugdar with the data from the authentication DB
260 * with the fields specified in fieldMap.
261 */
262 function _createBugdarUser()
263 {
264 $user = new UserAPI($this->registry);
265
266 // if the email already exists in the DB, it must be the same person so just hook up the authid
267 if ($check = $this->db->query_first("SELECT * FROM " . TABLE_PREFIX . "user WHERE email = '" . $this->db->escape_string($this->authUser[ $this->fieldMap['email'] ]) . "'"))
268 {
269 $user->set('userid', $check['userid']);
270 $user->set_condition();
271 $user->set('authid', $this->authUser[ $this->fieldMap['authid'] ]);
272 $user->update();
273 $user->fetch();
274
275 return $user->objdata;
276 }
277 else
278 {
279 $user = new UserAPI($this->registry);
280 foreach ($this->fieldMap AS $bugdar => $authdb)
281 {
282 $user->set($bugdar, $this->authUser["$authdb"]);
283 }
284 $user->set('usergroupid', 2);
285 $user->insert();
286
287 return $user->values;
288 }
289 }
290
291 // ###################################################################
292 /**
293 * Syncs a Bugdar user's fieldMap'ed values to the authentication DB's
294 * values. This allows the users to stay mostly-in-sync for the most
295 * basic of information (like email, timezone, etc.). Passwords are
296 * NOT synced. Returns TRUE if the user data was changed.
297 */
298 function _syncBugdarUser()
299 {
300 $fields = $this->fieldMap;
301 unset($fields['authid']);
302 unset($fields['password']);
303
304 $change = false;
305
306 $user = new UserAPI($this->registry);
307 $user->set('userid', $this->bugdarUser['userid']);
308 $user->set_condition();
309 foreach ($fields AS $bugdar => $auth)
310 {
311 if ($this->bugdarUser["$bugdar"] != $this->authUser["$auth"])
312 {
313 $user->set($bugdar, $this->authUser["$auth"]);
314 $change = true;
315 }
316 }
317 if ($change)
318 {
319 $user->update();
320 }
321
322 return $change;
323 }
324
325 // ###################################################################
326 /**
327 * Responsible for unsetting all authentication cookies because they
328 * are invalid
329 */
330 function clearCookies() {}
331
332 // ###################################################################
333 /**
334 * Sets the authentication cookies; this is done both at login and
335 * for renewing the cookies upon successful cookie validation. The
336 * option it takes determines whether the cookies are sticky or not.
337 */
338 function _setCookies($permanent = false) {}
339 }
340
341 /*=====================================================================*\
342 || ###################################################################
343 || # $HeadURL$
344 || # $Id$
345 || ###################################################################
346 \*=====================================================================*/
347 ?>