Source

joomla-platform / libraries / joomla / user / user.php

Full commit
  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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
<?php
/**
 * @package     Joomla.Platform
 * @subpackage  User
 *
 * @copyright   Copyright (C) 2005 - 2011 Open Source Matters, Inc. All rights reserved.
 * @license     GNU General Public License version 2 or later; see LICENSE
 */

defined('JPATH_PLATFORM') or die;

jimport('joomla.access.access');
jimport('joomla.registry.registry');

/**
 * User class.  Handles all application interaction with a user
 *
 * @package		Joomla.Platform
 * @subpackage	User
 * @since		11.1
 */
class JUser extends JObject
{
	/**
	 * A cached switch for if this user has root access rights.
	 * @var	boolean
	 */
	protected $isRoot = null;

	/**
	 * Unique id
	 * @var int
	 */
	public $id = null;

	/**
	 * The users real name (or nickname)
	 * @var string
	 */
	public $name = null;

	/**
	 * The login name
	 * @var string
	 */
	public $username = null;

	/**
	 * The email
	 * @var string
	 */
	public $email = null;

	/**
	 * MD5 encrypted password
	 * @var string
	 */
	public $password = null;

	/**
	 * Clear password, only available when a new password is set for a user
	 * @var string
	 */
	public $password_clear = '';

	/**
	 * Description
	 * @var string
	 */
	public $usertype = null;

	/**
	 * Description
	 * @var int
	 */
	public $block = null;

	/**
	 * Description
	 * @var int
	 */
	public $sendEmail = null;

	/**
	 * Description
	 * @var datetime
	 */
	public $registerDate = null;

	/**
	 * Description
	 * @var datetime
	 */
	public $lastvisitDate = null;

	/**
	 * Description
	 * @var string activation hash
	 */
	public $activation = null;

	/**
	 * Description
	 * @var string
	 */
	public $params = null;

	/**
	 * Associative array of user names => group ids
	 *
	 * @since	11.1
	 * @var		array
	 */
	public $groups = array();

	/**
	 * Description
	 * @var boolean
	 */
	public $guest = null;

	/**
	 * User parameters
	 * @var object
	 */
	protected $_params	= null;

	/**
	 * Authorised access groups
	 * @var array
	 */
	protected $_authGroups	= null;

	/**
	 * Authorised access levels
	 * @var array
	 */
	protected $_authLevels	= null;

	/**
	 * Authorised access actions
	 * @var array
	 */
	protected $_authActions	= null;

	/**
	 * Error message
	 * @var string
	 */
	protected $_errorMsg	= null;

	/**
	 * Constructor activating the default information of the language
	 *
	 * @param	int		$identifier	The primary key of the user to load (optional).
	 *
	 * @return	JUser
	 * @since	11.1
	 */
	public function __construct($identifier = 0)
	{
		// Create the user parameters object
		$this->_params = new JRegistry;

		// Load the user if it exists
		if (!empty($identifier)) {
			$this->load($identifier);
		}
		else {
			//initialise
			$this->id		= 0;
			$this->sendEmail = 0;
			$this->aid		= 0;
			$this->guest	= 1;
		}
	}

	/**
	 * Returns the global User object, only creating it if it
	 * doesn't already exist.
	 *
	 * @param	int		$identifier	The user to load - Can be an integer or string - If string, it is converted to ID automatically.
	 *
	 * @return	JUser	The User object.
	 * @since	11.1
	 */
	public static function getInstance($identifier = 0)
	{
		static $instances;

		if (!isset ($instances)) {
			$instances = array ();
		}

		// Find the user id
		if (!is_numeric($identifier)) {
			jimport('joomla.user.helper');
			if (!$id = JUserHelper::getUserId($identifier)) {
				JError::raiseWarning('SOME_ERROR_CODE', JText::sprintf('JLIB_USER_ERROR_ID_NOT_EXISTS', $identifier));
				$retval = false;
				return $retval;
			}
		}
		else {
			$id = $identifier;
		}

		if (empty($instances[$id])) {
			$user = new JUser($id);
			$instances[$id] = $user;
		}

		return $instances[$id];
	}

	/**
	 * Method to get a parameter value
	 *
	 * @param	string	$key		Parameter key
	 * @param	mixed	$default	Parameter default value
	 *
	 * @return	mixed	The value or the default if it did not exist
	 * @since	11.1
	 */
	public function getParam($key, $default = null)
	{
		return $this->_params->get($key, $default);
	}

	/**
	 * Method to set a parameter
	 *
	 * @param	string	$key	Parameter key
	 * @param	mixed	$value	Parameter value
	 *
	 * @return	mixed	Set parameter value
	 * @since	11.1
	 */
	public function setParam($key, $value)
	{
		return $this->_params->set($key, $value);
	}

	/**
	 * Method to set a default parameter if it does not exist
	 *
	 * @param	string	$key	Parameter key
	 * @param	mixed	$value	Parameter value
	 *
	 * @return	mixed	Set parameter value
	 * @since	11.1
	 */
	public function defParam($key, $value)
	{
		return $this->_params->def($key, $value);
	}

	/**
	 * @deprecated 1.6	Use the authorise method instead.
	 */
	public function authorize($action, $assetname = null)
	{
		return $this->authorise($action, $assetname);
	}

	/**
	 * Method to check JUser object authorisation against an access control
	 * object and optionally an access extension object
	 *
	 * @param	string	$action		The name of the action to check for permission.
	 * @param	string	$assetname	The name of the asset on which to perform the action.
	 *
	 * @return	boolean	True if authorised
	 * @since	11.1
	 */
	public function authorise($action, $assetname = null)
	{
		// Make sure we only check for core.admin once during the run.
		if ($this->isRoot === null) {
			$this->isRoot = false;

			// Check for the configuration file failsafe.
			$config		= JFactory::getConfig();
			$rootUser	= $config->get('root_user');

			// The root_user variable can be a numeric user ID or a username.
			if (is_numeric($rootUser) && $this->id > 0 && $this->id == $rootUser) {
				$this->isRoot = true;
			}
			else if ($this->username && $this->username == $rootUser) {
				$this->isRoot = true;
			}
			else {
				// Get all groups against which the user is mapped.
				$identities = $this->getAuthorisedGroups();
				array_unshift($identities, $this->id * -1);

				if (JAccess::getAssetRules(1)->allow('core.admin', $identities)) {
					$this->isRoot = true;
					return true;
				}
			}
		}

		return $this->isRoot ? true : JAccess::check($this->id, $action, $assetname);
	}

	/**
	 * @deprecated 1.6	Use the getAuthorisedViewLevels method instead.
	 */
	public function authorisedLevels()
	{
		return $this->getAuthorisedViewLevels();
	}

	/**
	 * Method to return a list of all categories that a user has permission for a given action
	 *
	 * @param	string	$component	The component from which to retrieve the categories
	 * @param	string	$action		The name of the section within the component from which to retrieve the actions.
	 *
	 * @return	array	List of categories that this group can do this action to (empty array if none). Categories must be published.
	 * @since	11.1
	 */
	public function getAuthorisedCategories($component, $action) {
		// Brute force method: get all published category rows for the component and check each one
		// TODO: Modify the way permissions are stored in the db to allow for faster implementation and better scaling
		$db = JFactory::getDbo();
		$query	= $db->getQuery(true)
			->select('c.id AS id, a.name as asset_name')
			->from('#__categories c')
			->innerJoin('#__assets a ON c.asset_id = a.id')
			->where('c.extension = ' . $db->quote($component))
			->where('c.published = 1');
		$db->setQuery($query);
		$allCategories = $db->loadObjectList('id');
		$allowedCategories = array();
		foreach ($allCategories as $category) {
			if ($this->authorise($action, $category->asset_name)) {
				$allowedCategories[] = (int) $category->id;
			}
		}
		return $allowedCategories;
	}

	/**
	 * Gets an array of the authorised access levels for the user
	 *
	 * @return	array
	 * @since	11.1
	 */
	public function getAuthorisedViewLevels()
	{
		if ($this->_authLevels === null) {
			$this->_authLevels = array();
		}

		if (empty($this->_authLevels)) {
			$this->_authLevels = JAccess::getAuthorisedViewLevels($this->id);
		}

		return $this->_authLevels;
	}
	/**
	 * Gets an array of the authorised user groups
	 *
	 * @return	array
	 * @since	11.1
	 */
	public function getAuthorisedGroups()
	{
		if ($this->_authGroups === null) {
			$this->_authGroups = array();
		}

		if (empty($this->_authGroups)) {
			$this->_authGroups = JAccess::getGroupsByUser($this->id);
		}

		return $this->_authGroups;
	}
	/**
	 * Pass through method to the table for setting the last visit date
	 *
	 * @param	int		$timestamp	The timestamp, defaults to 'now'.
	 *
	 * @return	boolean	True on success.
	 * @since	11.1
	 */
	public function setLastVisit($timestamp = null)
	{
		// Create the user table object
		$table	= $this->getTable();
		$table->load($this->id);

		return $table->setLastVisit($timestamp);
	}

	/**
	 * Method to get the user parameters
	 *
	 * This function tries to load an xml file based on the users usertype. The filename of the xml
	 * file is the same as the usertype. The functionals has a static variable to store the parameters
	 * setup file base path. You can call this function statically to set the base path if needed.
	 *
	 * @param	boolean	$loadsetupfile	If true, loads the parameters setup file. Default is false.
	 * @param	path	$path			Set the parameters setup file base path to be used to load the user parameters.
	 *
	 * @return	object	The user parameters object.
	 * @since	11.1
	 */
	public function getParameters($loadsetupfile = false, $path = null)
	{
		static $parampath;

		// Set a custom parampath if defined
		if (isset($path)) {
			$parampath = $path;
		}

		// Set the default parampath if not set already
		if (!isset($parampath)) {
			$parampath = JPATH_ADMINISTRATOR.'components/com_users/models';
		}

		if ($loadsetupfile) {
			$type = str_replace(' ', '_', strtolower($this->usertype));

			$file = $parampath.'/'.$type.'.xml';
			if (!file_exists($file)) {
				$file = $parampath.'/'.'user.xml';
			}

			$this->_params->loadSetupFile($file);
		}

		return $this->_params;
	}

	/**
	 * Method to get the user parameters
	 *
	 * @param	object	$params	The user parameters object
	 *
	 * @return	void
	 * @since	11.1
	 */
	public function setParameters($params)
	{
		$this->_params = $params;
	}

	/**
	 * Method to get the user table object
	 *
	 * This function uses a static variable to store the table name of the user table to
	 * it instantiates. You can call this function statically to set the table name if
	 * needed.
	 *
	 * @param	string	$type	The user table name to be used
	 * @param	string	$prefix	The user table prefix to be used
	 *
	 * @return	object	The user table object
	 * @since	11.1
	 */
	public static function getTable($type = null, $prefix = 'JTable')
	{
		static $tabletype;

		// Set the default tabletype;
		if (!isset($tabletype)) {
			$tabletype['name']		= 'user';
			$tabletype['prefix']	= 'JTable';
		}

		// Set a custom table type is defined
		if (isset($type)) {
			$tabletype['name']		= $type;
			$tabletype['prefix']	= $prefix;
		}

		// Create the user table object
		return JTable::getInstance($tabletype['name'], $tabletype['prefix']);
	}

	/**
	 * Method to bind an associative array of data to a user object
	 *
	 * @param	array	$array	The associative array to bind to the object
	 *
	 * @return	boolean	True on success
	 * @since	11.1
	 */
	public function bind(& $array)
	{
		jimport('joomla.user.helper');

		// Let's check to see if the user is new or not
		if (empty($this->id)) {
			// Check the password and create the crypted password
			if (empty($array['password'])) {
				$array['password']  = JUserHelper::genRandomPassword();
				$array['password2'] = $array['password'];
			}

			// TODO: Backend controller checks the password, frontend doesn't but should.
			// Hence this code is required:
			if (isset($array['password2']) && $array['password'] != $array['password2']) {
				$this->setError(JText::_('JLIB_USER_ERROR_PASSWORD_NOT_MATCH'));
				return false;
			}

			$this->password_clear = JArrayHelper::getValue($array, 'password', '', 'string');

			$salt  = JUserHelper::genRandomPassword(32);
			$crypt = JUserHelper::getCryptedPassword($array['password'], $salt);
			$array['password'] = $crypt.':'.$salt;

			// Set the registration timestamp

			$this->set('registerDate', JFactory::getDate()->toMySQL());

			// Check that username is not greater than 150 characters
			$username = $this->get('username');
			if (strlen($username) > 150) {
				$username = substr($username, 0, 150);
				$this->set('username', $username);
			}

			// Check that password is not greater than 100 characters
			$password = $this->get('password');
			if (strlen($password) > 100) {
				$password = substr($password, 0, 100);
				$this->set('password', $password);
			}
		}
		else {
			// Updating an existing user
			if (!empty($array['password'])) {
				if ($array['password'] != $array['password2']) {
					$this->setError(JText::_('JLIB_USER_ERROR_PASSWORD_NOT_MATCH'));
					return false;
				}

				$this->password_clear = JArrayHelper::getValue($array, 'password', '', 'string');

				$salt = JUserHelper::genRandomPassword(32);
				$crypt = JUserHelper::getCryptedPassword($array['password'], $salt);
				$array['password'] = $crypt.':'.$salt;
			}
			else {
				$array['password'] = $this->password;
			}
		}

		// TODO: this will be deprecated as of the ACL implementation
//		$db = JFactory::getDbo();

		if (array_key_exists('params', $array)) {
			$params	= '';

			$this->_params->loadArray($array['params']);

			if (is_array($array['params'])) {
				$params	= (string)$this->_params;
			}
			else {
				$params = $array['params'];
			}

			$this->params = $params;
		}

		// Bind the array
		if (!$this->setProperties($array)) {
			$this->setError(JText::_('JLIB_USER_ERROR_BIND_ARRAY'));
			return false;
		}

		// Make sure its an integer
		$this->id = (int) $this->id;

		return true;
	}

	/**
	 * Method to save the JUser object to the database
	 *
	 * @param	boolean	$updateOnly	Save the object only if not a new user
	 *
	 * @return	boolean	True on success
	 * @since	11.1
	 */
	public function save($updateOnly = false)
	{
		// NOTE: $updateOnly is currently only used in the user reset password method.
		// Create the user table object
		$table			= $this->getTable();
		$this->params	= (string) $this->_params;
		$table->bind($this->getProperties());

		// Allow an exception to be thrown.
		try
		{
			// Check and store the object.
			if (!$table->check()) {
				$this->setError($table->getError());
				return false;
			}

			// If user is made a Super Admin group and user is NOT a Super Admin
			//
			// @todo ACL - this needs to be acl checked
			//
			$my = JFactory::getUser();

			//are we creating a new user
			$isNew = empty($this->id);

			// If we aren't allowed to create new users return
			if ($isNew && $updateOnly) {
				return true;
			}

			// Get the old user
			$oldUser = new JUser($this->id);

			//
			// Access Checks
			//

			// The only mandatory check is that only Super Admins can operate on other Super Admin accounts.
			// To add additional business rules, use a user plugin and throw an Exception with onUserBeforeSave.

			// Check if I am a Super Admin
			$iAmSuperAdmin	= $my->authorise('core.admin');

			// We are only worried about edits to this account if I am not a Super Admin.
			if ($iAmSuperAdmin != true) {
				if ($isNew) {
					// Check if the new user is being put into a Super Admin group.
					foreach ($this->groups as $key => $groupId)
					{
						if (JAccess::checkGroup($groupId, 'core.admin')) {
							throw new Exception(JText::_('JLIB_USER_ERROR_NOT_SUPERADMIN'));
						}
					}
				}
				else {
					// I am not a Super Admin, and this one is, so fail.
					if (JAccess::check($this->id, 'core.admin')) {
						throw new Exception(JText::_('JLIB_USER_ERROR_NOT_SUPERADMIN'));
					}

					if ($this->groups != null) {
					// I am not a Super Admin and I'm trying to make one.
						foreach ($this->groups as $groupId)
						{
							if (JAccess::checkGroup($groupId, 'core.admin')) {
								throw new Exception(JText::_('JLIB_USER_ERROR_NOT_SUPERADMIN'));
							}
						}
					}
				}
			}

			// Fire the onUserBeforeSave event.
			JPluginHelper::importPlugin('user');
			$dispatcher = JDispatcher::getInstance();

			$result = $dispatcher->trigger('onUserBeforeSave', array($oldUser->getProperties(), $isNew, $this->getProperties()));
			if (in_array(false, $result, true)) {
				// Plugin will have to raise it's own error or throw an exception.
				return false;
			}

			// Store the user data in the database
			if (!($result = $table->store())) {
				throw new Exception($table->getError());
			}

			// Set the id for the JUser object in case we created a new user.
			if (empty($this->id)) {
				$this->id = $table->get('id');
			}

			if ($my->id == $table->id) {
				$registry = new JRegistry;
				$registry->loadJSON($table->params);
				$my->setParameters($registry);
			}

			// Fire the onAftereStoreUser event
			$dispatcher->trigger('onUserAfterSave', array($this->getProperties(), $isNew, $result, $this->getError()));
		}
		catch (Exception $e)
		{
			$this->setError($e->getMessage());

			return false;
		}

		return $result;
	}

	/**
	 * Method to delete the JUser object from the database
	 *
	 * @return	boolean	True on success
	 * @since	11.1
	 */
	public function delete()
	{
		JPluginHelper::importPlugin('user');

		// Trigger the onUserBeforeDelete event
		$dispatcher = JDispatcher::getInstance();
		$dispatcher->trigger('onUserBeforeDelete', array($this->getProperties()));

		// Create the user table object
		$table = $this->getTable();

		$result = false;
		if (!$result = $table->delete($this->id)) {
			$this->setError($table->getError());
		}

		// Trigger the onUserAfterDelete event
		$dispatcher->trigger('onUserAfterDelete', array($this->getProperties(), $result, $this->getError()));

		return $result;
	}

	/**
	 * Method to load a JUser object by user id number
	 *
	 * @param	mixed	$id	The user id of the user to load
	 *
	 * @return	boolean	True on success
	 * @since	11.1
	 */
	public function load($id)
	{
		// Create the user table object
		$table	= $this->getTable();

		// Load the JUserModel object based on the user id or throw a warning.
		if (!$table->load($id)) {
			JError::raiseWarning('SOME_ERROR_CODE', JText::sprintf('JLIB_USER_ERROR_UNABLE_TO_LOAD_USER', $id));
			return false;
		}
		
		// Set the user parameters using the default xml file.  We might want to
		// extend this in the future to allow for the ability to have custom
		// user parameters, but for right now we'll leave it how it is.
		 
		$this->_params->loadJSON($table->params);

		// Assuming all is well at this point lets bind the data
		$this->setProperties($table->getProperties());

		return true;
	}
}
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.