]>
src.bluestatic.org Git - bugdar.git/blob - includes/auth/auth.php
2 /*=====================================================================*\
3 || ###################################################################
5 || # Copyright ©2002-2007 Blue Static
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.
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
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 \*=====================================================================*/
22 require_once('./includes/api_user.php');
25 * Abstract Authentication
27 * This is an abstract class that is used to provide authentication for
31 * @copyright Copyright (c)2002 - 2007, Blue Static
39 * The database connection to AUTHENTICATE against; can be to a separate database
45 * The database connection to the BUGDAR database
57 * Array of user data from the AUTHENTICATION database
63 * Array of user data from the BUGDAR database
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:
73 var $fieldMap = array(
75 'displayname' => null,
79 // ###################################################################
83 function __construct()
87 $this->registry
=& $bugsys;
88 $this->db
=& $bugsys->db
;
90 $this->registry
->debug('authentication system: ' . get_class($this));
92 $this->_setupDatabase();
95 // ###################################################################
99 function Authentication()
101 $this->__construct();
104 // ###################################################################
106 * Returns the information array for the Bugdar user. This must be
107 * called after an authentication method.
109 function fetchBugdarUser()
111 return $this->bugdarUser
;
114 // ###################################################################
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
120 function _setupDatabase() {}
122 // ###################################################################
124 * Returns the sanitized value of the user ID or unique identifier
125 * found in the cookie of an already-authenticated user.
127 function _fetchCookieUniqueId() {}
129 // ###################################################################
131 * Returns the sanitized value of the authentication key or cookie-safe
132 * password found in the cookies of an already-authenticated user.
134 function _fetchCookiePassword() {}
136 // ###################################################################
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.
142 function _fetchUserUsingCookies() {}
144 // ###################################################################
146 * Returns TRUE if the cookie data values are valid in the data array
147 * returned from _fetchUserUsingCookies(), and FALSE if they are not.
149 function _verifyCookieData() {}
151 // ###################################################################
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.
157 function authenticateCookies()
159 if (!$this->_fetchCookieUniqueId() OR !$this->_fetchCookiePassword())
164 $this->authUser
= $this->_fetchUserUsingCookies();
165 if (!$this->authUser
)
167 $this->authUser
= null;
171 if ($this->_verifyCookieData())
173 $this->_setCookies(true);
174 $this->bugdarUser
= $this->_fetchBugdarUserFromAuthUser();
175 if ($this->_syncBugdarUser())
177 $this->bugdarUser
= $this->_fetchBugdarUserFromAuthUser();
183 $this->authUser
= null;
184 $this->clearCookies();
189 // ###################################################################
191 * Returns an array with the authentication user information, found
192 * by the unique login identifier passed to the function.
194 function _fetchUserWithIdentifier($string) {}
196 // ###################################################################
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.
202 function _verifyLoginUser($password) {}
204 // ###################################################################
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)
212 function authenticateLogin($string, $password, $sticky = false)
214 $this->authUser
= $this->_fetchUserWithIdentifier($string);
216 if (!$this->authUser
)
218 $this->authUser
= null;
222 if ($this->_verifyLoginUser($password))
224 $this->_setCookies($sticky);
225 $this->bugdarUser
= $this->_fetchBugdarUserFromAuthUser();
226 $this->_syncBugdarUser();
231 $this->authUser
= null;
236 // ###################################################################
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.
244 function _fetchBugdarUserFromAuthUser()
246 $user = $this->db
->query_first("SELECT * FROM " . TABLE_PREFIX
. "user WHERE authid = '" . $this->authUser
[ $this->fieldMap
['authid'] ] . "'");
249 return $this->_createBugdarUser();
254 // ###################################################################
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.
262 function _createBugdarUser()
264 $user = new UserAPI($this->registry
);
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'] ]) . "'"))
269 $user->set('userid', $check['userid']);
270 $user->set_condition();
271 $user->set('authid', $this->authUser
[ $this->fieldMap
['authid'] ]);
275 return $user->objdata
;
279 $user = new UserAPI($this->registry
);
280 foreach ($this->fieldMap
AS $bugdar => $authdb)
282 $user->set($bugdar, $this->authUser
["$authdb"]);
284 $user->set('usergroupid', 2);
287 return $user->values;
291 // ###################################################################
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.
298 function _syncBugdarUser()
300 $fields = $this->fieldMap;
301 unset($fields['authid']);
302 unset($fields['password']);
306 $user = new UserAPI($this->registry);
307 $user->set('userid', $this->bugdarUser['userid']);
308 $user->set_condition();
309 foreach ($fields AS $bugdar => $auth)
311 if ($this->bugdarUser["$bugdar"] != $this->authUser
["$auth"])
313 $user->set($bugdar, $this->authUser["$auth"]);
325 // ###################################################################
327 * Responsible for unsetting all authentication cookies because they
330 function clearCookies() {}
332 // ###################################################################
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.
338 function _setCookies($permanent = false) {}
341 /*=====================================================================*\
342 || ###################################################################
345 || ###################################################################
346 \*=====================================================================*/