Project

General

Profile

1
<?php
2

    
3
// $Id: class.login.php 1066 2009-07-15 19:27:14Z Ruebenwurzel $
4

    
5
/*
6

    
7
 Website Baker Project <http://www.websitebaker.org/>
8
 Copyright (C) 2004-2009, Ryan Djurovich
9

    
10
 Website Baker is free software; you can redistribute it and/or modify
11
 it under the terms of the GNU General Public License as published by
12
 the Free Software Foundation; either version 2 of the License, or
13
 (at your option) any later version.
14

    
15
 Website Baker is distributed in the hope that it will be useful,
16
 but WITHOUT ANY WARRANTY; without even the implied warranty of
17
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18
 GNU General Public License for more details.
19

    
20
 You should have received a copy of the GNU General Public License
21
 along with Website Baker; if not, write to the Free Software
22
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
23

    
24
*/
25

    
26
/*
27

    
28
Login class
29

    
30
This class will be used to with the login application
31

    
32
*/
33

    
34
// Stop this file from being accessed directly
35
if(!defined('WB_URL')) {
36
	header('Location: ../index.php');
37
	exit(0);
38
}
39

    
40
define('LOGIN_CLASS_LOADED', true);
41

    
42
// Load the other required class files if they are not already loaded
43
require_once(WB_PATH."/framework/class.admin.php");
44

    
45
class login extends admin {
46
	function login($config_array) {
47
		// Get language vars
48
		global $MESSAGE;
49
		$this->wb();
50
		// Get configuration values
51
		$this->USERS_TABLE = $config_array['USERS_TABLE'];
52
		$this->GROUPS_TABLE = $config_array['GROUPS_TABLE'];
53
		$this->username_fieldname = $config_array['USERNAME_FIELDNAME'];
54
		$this->password_fieldname = $config_array['PASSWORD_FIELDNAME'];
55
		$this->remember_me_option = $config_array['REMEMBER_ME_OPTION'];
56
		$this->max_attemps = $config_array['MAX_ATTEMPS'];
57
		$this->warning_url = $config_array['WARNING_URL'];
58
		$this->login_url = $config_array['LOGIN_URL'];
59
		$this->template_dir = $config_array['TEMPLATE_DIR'];
60
		$this->template_file = $config_array['TEMPLATE_FILE'];
61
		$this->frontend = $config_array['FRONTEND'];
62
		$this->forgotten_details_app = $config_array['FORGOTTEN_DETAILS_APP'];
63
		$this->max_username_len = $config_array['MAX_USERNAME_LEN'];
64
		$this->max_password_len = $config_array['MAX_PASSWORD_LEN'];
65
		if (array_key_exists('REDIRECT_URL',$config_array))
66
			$this->redirect_url = $config_array['REDIRECT_URL'];
67
		else
68
			$this->redirect_url = '';
69
		// Get the supplied username and password
70
		if ($this->get_post('username_fieldname') != ''){
71
			$username_fieldname = $this->get_post('username_fieldname');
72
			$password_fieldname = $this->get_post('password_fieldname');
73
		} else {
74
			$username_fieldname = 'username';
75
			$password_fieldname = 'password';
76
		}
77
		$this->username = $this->add_slashes(strtolower($this->get_post($username_fieldname)));
78
		$this->password = $this->get_post($password_fieldname);
79
		// Figure out if the "remember me" option has been checked
80
		if($this->get_post('remember') == 'true') {
81
			$this->remember = $this->get_post('remember');
82
		} else {
83
			$this->remember = false;
84
		}
85
		// Get the length of the supplied username and password
86
		if($this->get_post($username_fieldname) != '') {
87
			$this->username_len = strlen($this->username);
88
			$this->password_len = strlen($this->password);
89
		}
90
		// If the url is blank, set it to the default url
91
		$this->url = $this->get_post('url');
92
		if ($this->redirect_url!='') {
93
			$this->url = $this->redirect_url;
94
		}		
95
		if(strlen($this->url) < 2) {
96
			$this->url = $config_array['DEFAULT_URL'];
97
		}
98
		if($this->is_authenticated() == true) {
99
			// User already logged-in, so redirect to default url
100
			header('Location: '.$this->url);
101
			exit();
102
		} elseif($this->is_remembered() == true) {
103
			// User has been "remembered"
104
			// Get the users password
105
			$database = new database();
106
			$query_details = $database->query("SELECT * FROM ".$this->USERS_TABLE." WHERE user_id = '".$this->get_safe_remember_key()."' LIMIT 1");
107
			$fetch_details = $query_details->fetchRow();
108
			$this->username = $fetch_details['username'];
109
			$this->password = $fetch_details['password'];
110
			// Check if the user exists (authenticate them)
111
			if($this->authenticate()) {
112
				// Authentication successful
113
				header("Location: ".$this->url);
114
				exit(0);
115
			} else {
116
				$this->message = $MESSAGE['LOGIN']['AUTHENTICATION_FAILED'];
117
				$this->increase_attemps();
118
			}
119
		} elseif($this->username == '' AND $this->password == '') {
120
			$this->message = $MESSAGE['LOGIN']['BOTH_BLANK'];
121
			$this->increase_attemps();
122
		} elseif($this->username == '') {
123
			$this->message = $MESSAGE['LOGIN']['USERNAME_BLANK'];
124
			$this->increase_attemps();
125
		} elseif($this->password == '') {
126
			$this->message = $MESSAGE['LOGIN']['PASSWORD_BLANK'];
127
			$this->increase_attemps();
128
		} elseif($this->username_len < $config_array['MIN_USERNAME_LEN']) {
129
			$this->message = $MESSAGE['LOGIN']['USERNAME_TOO_SHORT'];
130
			$this->increase_attemps();
131
		} elseif($this->password_len < $config_array['MIN_PASSWORD_LEN']) {
132
			$this->message = $MESSAGE['LOGIN']['PASSWORD_TOO_SHORT'];
133
			$this->increase_attemps();
134
		} elseif($this->username_len > $config_array['MAX_USERNAME_LEN']) {
135
			$this->message = $MESSAGE['LOGIN']['USERNAME_TOO_LONG'];
136
			$this->increase_attemps();
137
		} elseif($this->password_len > $config_array['MAX_PASSWORD_LEN']) {
138
			$this->message = $MESSAGE['LOGIN']['PASSWORD_TOO_LONG'];
139
			$this->increase_attemps();
140
		} else {
141
			// Check if the user exists (authenticate them)
142
			$this->password = md5($this->password);
143
			if($this->authenticate()) {
144
				// Authentication successful
145
				//echo $this->url;exit();
146
				header("Location: ".$this->url);
147
				exit(0);
148
			} else {
149
				$this->message = $MESSAGE['LOGIN']['AUTHENTICATION_FAILED'];
150
				$this->increase_attemps();
151
			}
152
		}
153
	}
154
	
155
	// Authenticate the user (check if they exist in the database)
156
	function authenticate() {
157
		// Get user information
158
		$database = new database();
159
		$query = "SELECT * FROM ".$this->USERS_TABLE." WHERE username = '".$this->username."' AND password = '".$this->password."' AND active = '1'";
160
		$results = $database->query($query);
161
		$results_array = $results->fetchRow();
162
		$num_rows = $results->numRows();
163
		if($num_rows) {
164
			$user_id = $results_array['user_id'];
165
			$this->user_id = $user_id;
166
			$_SESSION['USER_ID'] = $user_id;
167
			$_SESSION['GROUP_ID'] = $results_array['group_id'];
168
			$_SESSION['GROUPS_ID'] = $results_array['groups_id'];
169
			$_SESSION['USERNAME'] = $results_array['username'];
170
			$_SESSION['DISPLAY_NAME'] = $results_array['display_name'];
171
			$_SESSION['EMAIL'] = $results_array['email'];
172
			$_SESSION['HOME_FOLDER'] = $results_array['home_folder'];
173
			// Run remember function if needed
174
			if($this->remember == true) {
175
				$this->remember($this->user_id);
176
			}
177
			// Set language
178
			if($results_array['language'] != '') {
179
				$_SESSION['LANGUAGE'] = $results_array['language'];
180
			}
181
			// Set timezone
182
			if($results_array['timezone'] != '-72000') {
183
				$_SESSION['TIMEZONE'] = $results_array['timezone'];
184
			} else {
185
				// Set a session var so apps can tell user is using default tz
186
				$_SESSION['USE_DEFAULT_TIMEZONE'] = true;
187
			}
188
			// Set date format
189
			if($results_array['date_format'] != '') {
190
				$_SESSION['DATE_FORMAT'] = $results_array['date_format'];
191
			} else {
192
				// Set a session var so apps can tell user is using default date format
193
				$_SESSION['USE_DEFAULT_DATE_FORMAT'] = true;
194
			}
195
			// Set time format
196
			if($results_array['time_format'] != '') {
197
				$_SESSION['TIME_FORMAT'] = $results_array['time_format'];
198
			} else {
199
				// Set a session var so apps can tell user is using default time format
200
				$_SESSION['USE_DEFAULT_TIME_FORMAT'] = true;
201
			}
202
			// Get group information
203
//			$query = "SELECT * FROM ".$this->GROUPS_TABLE." WHERE group_id = '".$this->get_session('GROUP_ID')."'";
204
//			$results = $database->query($query);
205
//			$results_array = $results->fetchRow();
206
//			$_SESSION['GROUP_NAME'] = $results_array['name'];
207
//			// Set system permissions
208
//			if($results_array['system_permissions'] != '') {
209
//				$_SESSION['SYSTEM_PERMISSIONS'] = explode(',', $results_array['system_permissions']);
210
//			} else {
211
//				$_SESSION['SYSTEM_PERMISSIONS'] = array();
212
//			}
213
//			// Set module permissions
214
//			if($results_array['module_permissions'] != '') {
215
//				$_SESSION['MODULE_PERMISSIONS'] = explode(',', $results_array['module_permissions']);
216
//			} else {
217
//				$_SESSION['MODULE_PERMISSIONS'] = array();
218
//			}
219
//			// Set template permissions
220
//			if($results_array['template_permissions'] != '') {
221
//				$_SESSION['TEMPLATE_PERMISSIONS'] = explode(',', $results_array['template_permissions']);
222
//			} else {
223
//				$_SESSION['TEMPLATE_PERMISSIONS'] = array();
224
//			}
225

    
226
			$_SESSION['SYSTEM_PERMISSIONS'] = array();
227
			$_SESSION['MODULE_PERMISSIONS'] = array();
228
			$_SESSION['TEMPLATE_PERMISSIONS'] = array();
229
			$_SESSION['GROUP_NAME'] = array();
230

    
231
			$first_group = true;
232
			foreach (split(",", $this->get_session('GROUPS_ID')) as $cur_group_id) {
233
				$query = "SELECT * FROM ".$this->GROUPS_TABLE." WHERE group_id = '".$cur_group_id."'";
234
				$results = $database->query($query);
235
				$results_array = $results->fetchRow();
236
				$_SESSION['GROUP_NAME'][$cur_group_id] = $results_array['name'];
237
				// Set system permissions
238
				if($results_array['system_permissions'] != '') {
239
					$_SESSION['SYSTEM_PERMISSIONS'] = array_merge($_SESSION['SYSTEM_PERMISSIONS'], explode(',', $results_array['system_permissions']));
240
				}
241
				// Set module permissions
242
				if($results_array['module_permissions'] != '') {
243
					if ($first_group) {
244
          	$_SESSION['MODULE_PERMISSIONS'] = explode(',', $results_array['module_permissions']);
245
          } else {
246
          	$_SESSION['MODULE_PERMISSIONS'] = array_intersect($_SESSION['MODULE_PERMISSIONS'], explode(',', $results_array['module_permissions']));
247
					}
248
				}
249
				// Set template permissions
250
				if($results_array['template_permissions'] != '') {
251
					if ($first_group) {
252
          	$_SESSION['TEMPLATE_PERMISSIONS'] = explode(',', $results_array['template_permissions']);
253
          } else {
254
          	$_SESSION['TEMPLATE_PERMISSIONS'] = array_intersect($_SESSION['TEMPLATE_PERMISSIONS'], explode(',', $results_array['template_permissions']));
255
					}
256
				}
257
				$first_group = false;
258
			}	
259

    
260
			// Update the users table with current ip and timestamp
261
			$get_ts = time();
262
			$get_ip = $_SERVER['REMOTE_ADDR'];
263
			$query = "UPDATE ".$this->USERS_TABLE." SET login_when = '$get_ts', login_ip = '$get_ip' WHERE user_id = '$user_id'";
264
			$database->query($query);
265
		}
266
		// Return if the user exists or not
267
		return $num_rows;
268
	}
269
	
270
	// Increase the count for login attemps
271
	function increase_attemps() {
272
		if(!isset($_SESSION['ATTEMPS'])) {
273
			$_SESSION['ATTEMPS'] = 0;
274
		} else {
275
			$_SESSION['ATTEMPS'] = $this->get_session('ATTEMPS')+1;
276
		}
277
		$this->display_login();
278
	}
279
	
280
	// Function to set a "remembering" cookie for the user
281
	function remember($user_id) {
282
		$remember_key = '';
283
		// Generate user id to append to the remember key
284
		$length = 11-strlen($user_id);
285
		if($length > 0) {
286
			for($i = 1; $i <= $length; $i++) {
287
				$remember_key .= '0';
288
			}
289
		}
290
		// Generate remember key
291
		$remember_key .= $user_id.'_';
292
		$salt = "abchefghjkmnpqrstuvwxyz0123456789";
293
		srand((double)microtime()*1000000);
294
		$i = 0;
295
		while ($i <= 10) {
296
			$num = rand() % 33;
297
			$tmp = substr($salt, $num, 1);
298
			$remember_key = $remember_key . $tmp;
299
			$i++;
300
		}
301
		$remember_key = $remember_key;
302
		// Update the remember key in the db
303
		$database = new database();
304
		$database->query("UPDATE ".$this->USERS_TABLE." SET remember_key = '$remember_key' WHERE user_id = '$user_id' LIMIT 1");
305
		if($database->is_error()) {
306
			return false;
307
		} else {
308
			// Workout options for the cookie
309
			$cookie_name = 'REMEMBER_KEY';
310
			$cookie_value = $remember_key;
311
			$cookie_expire = time()+60*60*24*30;
312
			// Set the cookie
313
			if(setcookie($cookie_name, $cookie_value, $cookie_expire, '/')) {
314
				return true;
315
			} else {
316
				return false;
317
			}
318
		}
319
	}
320
	
321
	// Function to check if a user has been remembered
322
	function is_remembered() {
323
		if(isset($_COOKIE['REMEMBER_KEY']) AND $_COOKIE['REMEMBER_KEY'] != '') {
324
			// Check if the remember key is correct
325
			$database = new database();
326
			$sql = "SELECT `user_id` FROM `" . $this->USERS_TABLE . "` WHERE `remember_key` = '";
327
			$sql .= $this->get_safe_remember_key() . "' LIMIT 1";
328
			$check_query = $database->query($sql);
329

    
330
			if($check_query->numRows() > 0) {
331
				$check_fetch = $check_query->fetchRow();
332
				$user_id = $check_fetch['user_id'];
333
				// Check the remember key prefix
334
				$remember_key_prefix = '';
335
				$length = 11-strlen($user_id);
336
				if($length > 0) {
337
					for($i = 1; $i <= $length; $i++) {
338
						$remember_key_prefix .= '0';
339
					}
340
				}
341
				$remember_key_prefix .= $user_id.'_';
342
				$length = strlen($remember_key_prefix);
343
				if(substr($_COOKIE['REMEMBER_KEY'], 0, $length) == $remember_key_prefix) {
344
					return true;
345
				} else {
346
					return false;
347
				}
348
			} else {
349
				return false;
350
			}
351
		} else {
352
			return false;
353
		}
354
	}
355
	
356
	// Display the login screen
357
	function display_login() {
358
		// Get language vars
359
		global $MESSAGE;
360
		global $MENU;
361
		global $TEXT;
362
		// If attemps more than allowed, warn the user
363
		if($this->get_session('ATTEMPS') > $this->max_attemps) {
364
			$this->warn();
365
		}
366
		// Show the login form
367
		if($this->frontend != true) {
368
			require_once(WB_PATH.'/include/phplib/template.inc');
369
			$template = new Template($this->template_dir);
370
			$template->set_file('page', $this->template_file);
371
			$template->set_block('page', 'mainBlock', 'main');
372
			if($this->remember_me_option != true) {
373
				$template->set_var('DISPLAY_REMEMBER_ME', 'none');
374
			} else {
375
				$template->set_var('DISPLAY_REMEMBER_ME', '');
376
			}
377
			$template->set_var(array(
378
											'ACTION_URL' => $this->login_url,
379
											'ATTEMPS' => $this->get_session('ATTEMPS'),
380
											'USERNAME' => $this->username,
381
											'USERNAME_FIELDNAME' => $this->username_fieldname,
382
											'PASSWORD_FIELDNAME' => $this->password_fieldname,
383
											'MESSAGE' => $this->message,
384
											'INTERFACE_DIR_URL' =>  ADMIN_URL.'/interface',
385
											'MAX_USERNAME_LEN' => $this->max_username_len,
386
											'MAX_PASSWORD_LEN' => $this->max_password_len,
387
											'WB_URL' => WB_URL,
388
											'THEME_URL' => THEME_URL,
389
											'FORGOTTEN_DETAILS_APP' => $this->forgotten_details_app,
390
											'TEXT_FORGOTTEN_DETAILS' => $TEXT['FORGOTTEN_DETAILS'],
391
											'TEXT_USERNAME' => $TEXT['USERNAME'],
392
											'TEXT_PASSWORD' => $TEXT['PASSWORD'],
393
											'TEXT_REMEMBER_ME' => $TEXT['REMEMBER_ME'],
394
											'TEXT_LOGIN' => $TEXT['LOGIN'],
395
											'TEXT_HOME' => $TEXT['HOME'],
396
											'PAGES_DIRECTORY' => PAGES_DIRECTORY,
397
											'SECTION_LOGIN' => $MENU['LOGIN']
398
											)
399
									);
400
			if(defined('DEFAULT_CHARSET')) {
401
				$charset=DEFAULT_CHARSET;
402
			} else {
403
				$charset='utf-8';
404
			}
405
			
406
			$template->set_var('CHARSET', $charset);	
407
									
408
									
409
			$template->parse('main', 'mainBlock', false);
410
			$template->pparse('output', 'page');
411
		}
412
	}
413

    
414
	// sanities the REMEMBER_KEY cookie to avoid SQL injection
415
	function get_safe_remember_key() {
416
		if (!((strlen($_COOKIE['REMEMBER_KEY']) == 23) && (substr($_COOKIE['REMEMBER_KEY'], 11, 1) == '_'))) return '';
417
		// create a clean cookie (XXXXXXXXXXX_YYYYYYYYYYY) where X:= numeric, Y:= hash
418
		$clean_cookie = sprintf('%011d', (int) substr($_COOKIE['REMEMBER_KEY'], 0, 11)) . substr($_COOKIE['REMEMBER_KEY'], 11);
419
		return ($clean_cookie == $_COOKIE['REMEMBER_KEY']) ? $this->add_slashes($clean_cookie) : '';
420
	}
421
	
422
	// Warn user that they have had to many login attemps
423
	function warn() {
424
		header('Location: '.$this->warning_url);
425
		exit(0);
426
	}
427
	
428
}
429

    
430
?>
(6-6/15)